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; 100a920b5bSAndy Whitcroft 110a920b5bSAndy Whitcroftmy $P = $0; 1200df344fSAndy Whitcroft$P =~ s@.*/@@g; 130a920b5bSAndy Whitcroft 14000d1cc1SJoe Perchesmy $V = '0.32'; 150a920b5bSAndy Whitcroft 160a920b5bSAndy Whitcroftuse Getopt::Long qw(:config no_auto_abbrev); 170a920b5bSAndy Whitcroft 180a920b5bSAndy Whitcroftmy $quiet = 0; 190a920b5bSAndy Whitcroftmy $tree = 1; 200a920b5bSAndy Whitcroftmy $chk_signoff = 1; 210a920b5bSAndy Whitcroftmy $chk_patch = 1; 22773647a0SAndy Whitcroftmy $tst_only; 236c72ffaaSAndy Whitcroftmy $emacs = 0; 248905a67cSAndy Whitcroftmy $terse = 0; 256c72ffaaSAndy Whitcroftmy $file = 0; 266c72ffaaSAndy Whitcroftmy $check = 0; 278905a67cSAndy Whitcroftmy $summary = 1; 288905a67cSAndy Whitcroftmy $mailback = 0; 2913214adfSAndy Whitcroftmy $summary_file = 0; 30000d1cc1SJoe Perchesmy $show_types = 0; 313705ce5bSJoe Perchesmy $fix = 0; 32*9624b8d6SJoe Perchesmy $fix_inplace = 0; 336c72ffaaSAndy Whitcroftmy $root; 34c2fdda0dSAndy Whitcroftmy %debug; 353445686aSJoe Perchesmy %camelcase = (); 3691bfe484SJoe Perchesmy %use_type = (); 3791bfe484SJoe Perchesmy @use = (); 3891bfe484SJoe Perchesmy %ignore_type = (); 39000d1cc1SJoe Perchesmy @ignore = (); 4077f5b10aSHannes Edermy $help = 0; 41000d1cc1SJoe Perchesmy $configuration_file = ".checkpatch.conf"; 426cd7f386SJoe Perchesmy $max_line_length = 80; 43d62a201fSDave Hansenmy $ignore_perl_version = 0; 44d62a201fSDave Hansenmy $minimum_perl_version = 5.10.0; 4577f5b10aSHannes Eder 4677f5b10aSHannes Edersub help { 4777f5b10aSHannes Eder my ($exitcode) = @_; 4877f5b10aSHannes Eder 4977f5b10aSHannes Eder print << "EOM"; 5077f5b10aSHannes EderUsage: $P [OPTION]... [FILE]... 5177f5b10aSHannes EderVersion: $V 5277f5b10aSHannes Eder 5377f5b10aSHannes EderOptions: 5477f5b10aSHannes Eder -q, --quiet quiet 5577f5b10aSHannes Eder --no-tree run without a kernel tree 5677f5b10aSHannes Eder --no-signoff do not check for 'Signed-off-by' line 5777f5b10aSHannes Eder --patch treat FILE as patchfile (default) 5877f5b10aSHannes Eder --emacs emacs compile window format 5977f5b10aSHannes Eder --terse one line per report 6077f5b10aSHannes Eder -f, --file treat FILE as regular source file 6177f5b10aSHannes Eder --subjective, --strict enable more subjective tests 6291bfe484SJoe Perches --types TYPE(,TYPE2...) show only these comma separated message types 63000d1cc1SJoe Perches --ignore TYPE(,TYPE2...) ignore various comma separated message types 646cd7f386SJoe Perches --max-line-length=n set the maximum line length, if exceeded, warn 65000d1cc1SJoe Perches --show-types show the message "types" in the output 6677f5b10aSHannes Eder --root=PATH PATH to the kernel tree root 6777f5b10aSHannes Eder --no-summary suppress the per-file summary 6877f5b10aSHannes Eder --mailback only produce a report in case of warnings/errors 6977f5b10aSHannes Eder --summary-file include the filename in summary 7077f5b10aSHannes Eder --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 7177f5b10aSHannes Eder 'values', 'possible', 'type', and 'attr' (default 7277f5b10aSHannes Eder is all off) 7377f5b10aSHannes Eder --test-only=WORD report only warnings/errors containing WORD 7477f5b10aSHannes Eder literally 753705ce5bSJoe Perches --fix EXPERIMENTAL - may create horrible results 763705ce5bSJoe Perches If correctable single-line errors exist, create 773705ce5bSJoe Perches "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 783705ce5bSJoe Perches with potential errors corrected to the preferred 793705ce5bSJoe Perches checkpatch style 80*9624b8d6SJoe Perches --fix-inplace EXPERIMENTAL - may create horrible results 81*9624b8d6SJoe Perches Is the same as --fix, but overwrites the input 82*9624b8d6SJoe Perches file. It's your fault if there's no backup or git 83d62a201fSDave Hansen --ignore-perl-version override checking of perl version. expect 84d62a201fSDave Hansen runtime errors. 8577f5b10aSHannes Eder -h, --help, --version display this help and exit 8677f5b10aSHannes Eder 8777f5b10aSHannes EderWhen FILE is - read standard input. 8877f5b10aSHannes EderEOM 8977f5b10aSHannes Eder 9077f5b10aSHannes Eder exit($exitcode); 9177f5b10aSHannes Eder} 9277f5b10aSHannes Eder 93000d1cc1SJoe Perchesmy $conf = which_conf($configuration_file); 94000d1cc1SJoe Perchesif (-f $conf) { 95000d1cc1SJoe Perches my @conf_args; 96000d1cc1SJoe Perches open(my $conffile, '<', "$conf") 97000d1cc1SJoe Perches or warn "$P: Can't find a readable $configuration_file file $!\n"; 98000d1cc1SJoe Perches 99000d1cc1SJoe Perches while (<$conffile>) { 100000d1cc1SJoe Perches my $line = $_; 101000d1cc1SJoe Perches 102000d1cc1SJoe Perches $line =~ s/\s*\n?$//g; 103000d1cc1SJoe Perches $line =~ s/^\s*//g; 104000d1cc1SJoe Perches $line =~ s/\s+/ /g; 105000d1cc1SJoe Perches 106000d1cc1SJoe Perches next if ($line =~ m/^\s*#/); 107000d1cc1SJoe Perches next if ($line =~ m/^\s*$/); 108000d1cc1SJoe Perches 109000d1cc1SJoe Perches my @words = split(" ", $line); 110000d1cc1SJoe Perches foreach my $word (@words) { 111000d1cc1SJoe Perches last if ($word =~ m/^#/); 112000d1cc1SJoe Perches push (@conf_args, $word); 113000d1cc1SJoe Perches } 114000d1cc1SJoe Perches } 115000d1cc1SJoe Perches close($conffile); 116000d1cc1SJoe Perches unshift(@ARGV, @conf_args) if @conf_args; 117000d1cc1SJoe Perches} 118000d1cc1SJoe Perches 1190a920b5bSAndy WhitcroftGetOptions( 1206c72ffaaSAndy Whitcroft 'q|quiet+' => \$quiet, 1210a920b5bSAndy Whitcroft 'tree!' => \$tree, 1220a920b5bSAndy Whitcroft 'signoff!' => \$chk_signoff, 1230a920b5bSAndy Whitcroft 'patch!' => \$chk_patch, 1246c72ffaaSAndy Whitcroft 'emacs!' => \$emacs, 1258905a67cSAndy Whitcroft 'terse!' => \$terse, 12677f5b10aSHannes Eder 'f|file!' => \$file, 1276c72ffaaSAndy Whitcroft 'subjective!' => \$check, 1286c72ffaaSAndy Whitcroft 'strict!' => \$check, 129000d1cc1SJoe Perches 'ignore=s' => \@ignore, 13091bfe484SJoe Perches 'types=s' => \@use, 131000d1cc1SJoe Perches 'show-types!' => \$show_types, 1326cd7f386SJoe Perches 'max-line-length=i' => \$max_line_length, 1336c72ffaaSAndy Whitcroft 'root=s' => \$root, 1348905a67cSAndy Whitcroft 'summary!' => \$summary, 1358905a67cSAndy Whitcroft 'mailback!' => \$mailback, 13613214adfSAndy Whitcroft 'summary-file!' => \$summary_file, 1373705ce5bSJoe Perches 'fix!' => \$fix, 138*9624b8d6SJoe Perches 'fix-inplace!' => \$fix_inplace, 139d62a201fSDave Hansen 'ignore-perl-version!' => \$ignore_perl_version, 140c2fdda0dSAndy Whitcroft 'debug=s' => \%debug, 141773647a0SAndy Whitcroft 'test-only=s' => \$tst_only, 14277f5b10aSHannes Eder 'h|help' => \$help, 14377f5b10aSHannes Eder 'version' => \$help 14477f5b10aSHannes Eder) or help(1); 14577f5b10aSHannes Eder 14677f5b10aSHannes Ederhelp(0) if ($help); 1470a920b5bSAndy Whitcroft 148*9624b8d6SJoe Perches$fix = 1 if ($fix_inplace); 149*9624b8d6SJoe Perches 1500a920b5bSAndy Whitcroftmy $exit = 0; 1510a920b5bSAndy Whitcroft 152d62a201fSDave Hansenif ($^V && $^V lt $minimum_perl_version) { 153d62a201fSDave Hansen printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 154d62a201fSDave Hansen if (!$ignore_perl_version) { 155d62a201fSDave Hansen exit(1); 156d62a201fSDave Hansen } 157d62a201fSDave Hansen} 158d62a201fSDave Hansen 1590a920b5bSAndy Whitcroftif ($#ARGV < 0) { 16077f5b10aSHannes Eder print "$P: no input files\n"; 1610a920b5bSAndy Whitcroft exit(1); 1620a920b5bSAndy Whitcroft} 1630a920b5bSAndy Whitcroft 16491bfe484SJoe Perchessub hash_save_array_words { 16591bfe484SJoe Perches my ($hashRef, $arrayRef) = @_; 16691bfe484SJoe Perches 16791bfe484SJoe Perches my @array = split(/,/, join(',', @$arrayRef)); 16891bfe484SJoe Perches foreach my $word (@array) { 169000d1cc1SJoe Perches $word =~ s/\s*\n?$//g; 170000d1cc1SJoe Perches $word =~ s/^\s*//g; 171000d1cc1SJoe Perches $word =~ s/\s+/ /g; 172000d1cc1SJoe Perches $word =~ tr/[a-z]/[A-Z]/; 173000d1cc1SJoe Perches 174000d1cc1SJoe Perches next if ($word =~ m/^\s*#/); 175000d1cc1SJoe Perches next if ($word =~ m/^\s*$/); 176000d1cc1SJoe Perches 17791bfe484SJoe Perches $hashRef->{$word}++; 178000d1cc1SJoe Perches } 17991bfe484SJoe Perches} 18091bfe484SJoe Perches 18191bfe484SJoe Perchessub hash_show_words { 18291bfe484SJoe Perches my ($hashRef, $prefix) = @_; 18391bfe484SJoe Perches 18458cb3cf6SJoe Perches if ($quiet == 0 && keys %$hashRef) { 18591bfe484SJoe Perches print "NOTE: $prefix message types:"; 18658cb3cf6SJoe Perches foreach my $word (sort keys %$hashRef) { 18791bfe484SJoe Perches print " $word"; 18891bfe484SJoe Perches } 18991bfe484SJoe Perches print "\n\n"; 19091bfe484SJoe Perches } 19191bfe484SJoe Perches} 19291bfe484SJoe Perches 19391bfe484SJoe Percheshash_save_array_words(\%ignore_type, \@ignore); 19491bfe484SJoe Percheshash_save_array_words(\%use_type, \@use); 195000d1cc1SJoe Perches 196c2fdda0dSAndy Whitcroftmy $dbg_values = 0; 197c2fdda0dSAndy Whitcroftmy $dbg_possible = 0; 1987429c690SAndy Whitcroftmy $dbg_type = 0; 199a1ef277eSAndy Whitcroftmy $dbg_attr = 0; 200c2fdda0dSAndy Whitcroftfor my $key (keys %debug) { 20121caa13cSAndy Whitcroft ## no critic 20221caa13cSAndy Whitcroft eval "\${dbg_$key} = '$debug{$key}';"; 20321caa13cSAndy Whitcroft die "$@" if ($@); 204c2fdda0dSAndy Whitcroft} 205c2fdda0dSAndy Whitcroft 206d2c0a235SAndy Whitcroftmy $rpt_cleaners = 0; 207d2c0a235SAndy Whitcroft 2088905a67cSAndy Whitcroftif ($terse) { 2098905a67cSAndy Whitcroft $emacs = 1; 2108905a67cSAndy Whitcroft $quiet++; 2118905a67cSAndy Whitcroft} 2128905a67cSAndy Whitcroft 2136c72ffaaSAndy Whitcroftif ($tree) { 2146c72ffaaSAndy Whitcroft if (defined $root) { 2156c72ffaaSAndy Whitcroft if (!top_of_kernel_tree($root)) { 2166c72ffaaSAndy Whitcroft die "$P: $root: --root does not point at a valid tree\n"; 2176c72ffaaSAndy Whitcroft } 2186c72ffaaSAndy Whitcroft } else { 2196c72ffaaSAndy Whitcroft if (top_of_kernel_tree('.')) { 2206c72ffaaSAndy Whitcroft $root = '.'; 2216c72ffaaSAndy Whitcroft } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 2226c72ffaaSAndy Whitcroft top_of_kernel_tree($1)) { 2236c72ffaaSAndy Whitcroft $root = $1; 2246c72ffaaSAndy Whitcroft } 2256c72ffaaSAndy Whitcroft } 2266c72ffaaSAndy Whitcroft 2276c72ffaaSAndy Whitcroft if (!defined $root) { 2280a920b5bSAndy Whitcroft print "Must be run from the top-level dir. of a kernel tree\n"; 2290a920b5bSAndy Whitcroft exit(2); 2300a920b5bSAndy Whitcroft } 2316c72ffaaSAndy Whitcroft} 2326c72ffaaSAndy Whitcroft 2336c72ffaaSAndy Whitcroftmy $emitted_corrupt = 0; 2346c72ffaaSAndy Whitcroft 2352ceb532bSAndy Whitcroftour $Ident = qr{ 2362ceb532bSAndy Whitcroft [A-Za-z_][A-Za-z\d_]* 2372ceb532bSAndy Whitcroft (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 2382ceb532bSAndy Whitcroft }x; 2396c72ffaaSAndy Whitcroftour $Storage = qr{extern|static|asmlinkage}; 2406c72ffaaSAndy Whitcroftour $Sparse = qr{ 2416c72ffaaSAndy Whitcroft __user| 2426c72ffaaSAndy Whitcroft __kernel| 2436c72ffaaSAndy Whitcroft __force| 2446c72ffaaSAndy Whitcroft __iomem| 2456c72ffaaSAndy Whitcroft __must_check| 2466c72ffaaSAndy Whitcroft __init_refok| 247417495edSAndy Whitcroft __kprobes| 248165e72a6SSven Eckelmann __ref| 249165e72a6SSven Eckelmann __rcu 2506c72ffaaSAndy Whitcroft }x; 251e970b884SJoe Perchesour $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 252e970b884SJoe Perchesour $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 253e970b884SJoe Perchesour $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 254e970b884SJoe Perchesour $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 255e970b884SJoe Perchesour $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 2568716de38SJoe Perches 25752131292SWolfram Sang# Notes to $Attribute: 25852131292SWolfram Sang# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 2596c72ffaaSAndy Whitcroftour $Attribute = qr{ 2606c72ffaaSAndy Whitcroft const| 26103f1df7dSJoe Perches __percpu| 26203f1df7dSJoe Perches __nocast| 26303f1df7dSJoe Perches __safe| 26403f1df7dSJoe Perches __bitwise__| 26503f1df7dSJoe Perches __packed__| 26603f1df7dSJoe Perches __packed2__| 26703f1df7dSJoe Perches __naked| 26803f1df7dSJoe Perches __maybe_unused| 26903f1df7dSJoe Perches __always_unused| 27003f1df7dSJoe Perches __noreturn| 27103f1df7dSJoe Perches __used| 27203f1df7dSJoe Perches __cold| 27303f1df7dSJoe Perches __noclone| 27403f1df7dSJoe Perches __deprecated| 2756c72ffaaSAndy Whitcroft __read_mostly| 2766c72ffaaSAndy Whitcroft __kprobes| 2778716de38SJoe Perches $InitAttribute| 27824e1d81aSAndy Whitcroft ____cacheline_aligned| 27924e1d81aSAndy Whitcroft ____cacheline_aligned_in_smp| 2805fe3af11SAndy Whitcroft ____cacheline_internodealigned_in_smp| 2815fe3af11SAndy Whitcroft __weak 2826c72ffaaSAndy Whitcroft }x; 283c45dcabdSAndy Whitcroftour $Modifier; 2846c72ffaaSAndy Whitcroftour $Inline = qr{inline|__always_inline|noinline}; 2856c72ffaaSAndy Whitcroftour $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 2866c72ffaaSAndy Whitcroftour $Lval = qr{$Ident(?:$Member)*}; 2876c72ffaaSAndy Whitcroft 28895e2c602SJoe Perchesour $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 28995e2c602SJoe Perchesour $Binary = qr{(?i)0b[01]+$Int_type?}; 29095e2c602SJoe Perchesour $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 29195e2c602SJoe Perchesour $Int = qr{[0-9]+$Int_type?}; 292326b1ffcSJoe Perchesour $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 293326b1ffcSJoe Perchesour $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 294326b1ffcSJoe Perchesour $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 29574349bccSJoe Perchesour $Float = qr{$Float_hex|$Float_dec|$Float_int}; 29695e2c602SJoe Perchesour $Constant = qr{$Float|$Binary|$Hex|$Int}; 297326b1ffcSJoe Perchesour $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 29886f9d059SAndy Whitcroftour $Compare = qr{<=|>=|==|!=|<|>}; 29923f780c9SJoe Perchesour $Arithmetic = qr{\+|-|\*|\/|%}; 3006c72ffaaSAndy Whitcroftour $Operators = qr{ 3016c72ffaaSAndy Whitcroft <=|>=|==|!=| 3026c72ffaaSAndy Whitcroft =>|->|<<|>>|<|>|!|~| 30323f780c9SJoe Perches &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 3046c72ffaaSAndy Whitcroft }x; 3056c72ffaaSAndy Whitcroft 3068905a67cSAndy Whitcroftour $NonptrType; 3078716de38SJoe Perchesour $NonptrTypeWithAttr; 3088905a67cSAndy Whitcroftour $Type; 3098905a67cSAndy Whitcroftour $Declare; 3108905a67cSAndy Whitcroft 31115662b3eSJoe Perchesour $NON_ASCII_UTF8 = qr{ 31215662b3eSJoe Perches [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 313171ae1a4SAndy Whitcroft | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 314171ae1a4SAndy Whitcroft | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 315171ae1a4SAndy Whitcroft | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 316171ae1a4SAndy Whitcroft | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 317171ae1a4SAndy Whitcroft | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 318171ae1a4SAndy Whitcroft | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 319171ae1a4SAndy Whitcroft}x; 320171ae1a4SAndy Whitcroft 32115662b3eSJoe Perchesour $UTF8 = qr{ 32215662b3eSJoe Perches [\x09\x0A\x0D\x20-\x7E] # ASCII 32315662b3eSJoe Perches | $NON_ASCII_UTF8 32415662b3eSJoe Perches}x; 32515662b3eSJoe Perches 3268ed22cadSAndy Whitcroftour $typeTypedefs = qr{(?x: 327fb9e9096SAndy Whitcroft (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 3288ed22cadSAndy Whitcroft atomic_t 3298ed22cadSAndy Whitcroft)}; 3308ed22cadSAndy Whitcroft 331691e669bSJoe Perchesour $logFunctions = qr{(?x: 3326e60c02eSJoe Perches printk(?:_ratelimited|_once|)| 3337d0b6594SJacob Keller (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 3346e60c02eSJoe Perches WARN(?:_RATELIMIT|_ONCE|)| 335b0531722SJoe Perches panic| 33606668727SJoe Perches MODULE_[A-Z_]+| 33706668727SJoe Perches seq_vprintf|seq_printf|seq_puts 338691e669bSJoe Perches)}; 339691e669bSJoe Perches 34020112475SJoe Perchesour $signature_tags = qr{(?xi: 34120112475SJoe Perches Signed-off-by:| 34220112475SJoe Perches Acked-by:| 34320112475SJoe Perches Tested-by:| 34420112475SJoe Perches Reviewed-by:| 34520112475SJoe Perches Reported-by:| 3468543ae12SMugunthan V N Suggested-by:| 34720112475SJoe Perches To:| 34820112475SJoe Perches Cc: 34920112475SJoe Perches)}; 35020112475SJoe Perches 3518905a67cSAndy Whitcroftour @typeList = ( 3528905a67cSAndy Whitcroft qr{void}, 353c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?char}, 354c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?short}, 355c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?int}, 356c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long}, 357c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+int}, 358c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long}, 359c45dcabdSAndy Whitcroft qr{(?:unsigned\s+)?long\s+long\s+int}, 3608905a67cSAndy Whitcroft qr{unsigned}, 3618905a67cSAndy Whitcroft qr{float}, 3628905a67cSAndy Whitcroft qr{double}, 3638905a67cSAndy Whitcroft qr{bool}, 3648905a67cSAndy Whitcroft qr{struct\s+$Ident}, 3658905a67cSAndy Whitcroft qr{union\s+$Ident}, 3668905a67cSAndy Whitcroft qr{enum\s+$Ident}, 3678905a67cSAndy Whitcroft qr{${Ident}_t}, 3688905a67cSAndy Whitcroft qr{${Ident}_handler}, 3698905a67cSAndy Whitcroft qr{${Ident}_handler_fn}, 3708905a67cSAndy Whitcroft); 3718716de38SJoe Perchesour @typeListWithAttr = ( 3728716de38SJoe Perches @typeList, 3738716de38SJoe Perches qr{struct\s+$InitAttribute\s+$Ident}, 3748716de38SJoe Perches qr{union\s+$InitAttribute\s+$Ident}, 3758716de38SJoe Perches); 3768716de38SJoe Perches 377c45dcabdSAndy Whitcroftour @modifierList = ( 378c45dcabdSAndy Whitcroft qr{fastcall}, 379c45dcabdSAndy Whitcroft); 3808905a67cSAndy Whitcroft 3817840a94cSWolfram Sangour $allowed_asm_includes = qr{(?x: 3827840a94cSWolfram Sang irq| 3837840a94cSWolfram Sang memory 3847840a94cSWolfram Sang)}; 3857840a94cSWolfram Sang# memory.h: ARM has a custom one 3867840a94cSWolfram Sang 3878905a67cSAndy Whitcroftsub build_types { 388d2172eb5SAndy Whitcroft my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 389d2172eb5SAndy Whitcroft my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 3908716de38SJoe Perches my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 391c8cb2ca3SAndy Whitcroft $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 3928905a67cSAndy Whitcroft $NonptrType = qr{ 393d2172eb5SAndy Whitcroft (?:$Modifier\s+|const\s+)* 394cf655043SAndy Whitcroft (?: 3956b48db24SAndy Whitcroft (?:typeof|__typeof__)\s*\([^\)]*\)| 3968ed22cadSAndy Whitcroft (?:$typeTypedefs\b)| 397c45dcabdSAndy Whitcroft (?:${all}\b) 398cf655043SAndy Whitcroft ) 399c8cb2ca3SAndy Whitcroft (?:\s+$Modifier|\s+const)* 4008905a67cSAndy Whitcroft }x; 4018716de38SJoe Perches $NonptrTypeWithAttr = qr{ 4028716de38SJoe Perches (?:$Modifier\s+|const\s+)* 4038716de38SJoe Perches (?: 4048716de38SJoe Perches (?:typeof|__typeof__)\s*\([^\)]*\)| 4058716de38SJoe Perches (?:$typeTypedefs\b)| 4068716de38SJoe Perches (?:${allWithAttr}\b) 4078716de38SJoe Perches ) 4088716de38SJoe Perches (?:\s+$Modifier|\s+const)* 4098716de38SJoe Perches }x; 4108905a67cSAndy Whitcroft $Type = qr{ 411c45dcabdSAndy Whitcroft $NonptrType 412b337d8b8SAndy Whitcroft (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)? 413c8cb2ca3SAndy Whitcroft (?:\s+$Inline|\s+$Modifier)* 4148905a67cSAndy Whitcroft }x; 4158905a67cSAndy Whitcroft $Declare = qr{(?:$Storage\s+)?$Type}; 4168905a67cSAndy Whitcroft} 4178905a67cSAndy Whitcroftbuild_types(); 4186c72ffaaSAndy Whitcroft 4197d2367afSJoe Perchesour $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 420d1fe9c09SJoe Perches 421d1fe9c09SJoe Perches# Using $balanced_parens, $LvalOrFunc, or $FuncArg 422d1fe9c09SJoe Perches# requires at least perl version v5.10.0 423d1fe9c09SJoe Perches# Any use must be runtime checked with $^V 424d1fe9c09SJoe Perches 425d1fe9c09SJoe Perchesour $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 426d1fe9c09SJoe Perchesour $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*}; 427d7c76ba7SJoe Perchesour $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)}; 4287d2367afSJoe Perches 4297d2367afSJoe Perchessub deparenthesize { 4307d2367afSJoe Perches my ($string) = @_; 4317d2367afSJoe Perches return "" if (!defined($string)); 4327d2367afSJoe Perches $string =~ s@^\s*\(\s*@@g; 4337d2367afSJoe Perches $string =~ s@\s*\)\s*$@@g; 4347d2367afSJoe Perches $string =~ s@\s+@ @g; 4357d2367afSJoe Perches return $string; 4367d2367afSJoe Perches} 4377d2367afSJoe Perches 4383445686aSJoe Perchessub seed_camelcase_file { 4393445686aSJoe Perches my ($file) = @_; 4403445686aSJoe Perches 4413445686aSJoe Perches return if (!(-f $file)); 4423445686aSJoe Perches 4433445686aSJoe Perches local $/; 4443445686aSJoe Perches 4453445686aSJoe Perches open(my $include_file, '<', "$file") 4463445686aSJoe Perches or warn "$P: Can't read '$file' $!\n"; 4473445686aSJoe Perches my $text = <$include_file>; 4483445686aSJoe Perches close($include_file); 4493445686aSJoe Perches 4503445686aSJoe Perches my @lines = split('\n', $text); 4513445686aSJoe Perches 4523445686aSJoe Perches foreach my $line (@lines) { 4533445686aSJoe Perches next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 4543445686aSJoe Perches if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 4553445686aSJoe Perches $camelcase{$1} = 1; 45611ea516aSJoe Perches } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 45711ea516aSJoe Perches $camelcase{$1} = 1; 45811ea516aSJoe Perches } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 4593445686aSJoe Perches $camelcase{$1} = 1; 4603445686aSJoe Perches } 4613445686aSJoe Perches } 4623445686aSJoe Perches} 4633445686aSJoe Perches 4643445686aSJoe Perchesmy $camelcase_seeded = 0; 4653445686aSJoe Perchessub seed_camelcase_includes { 4663445686aSJoe Perches return if ($camelcase_seeded); 4673445686aSJoe Perches 4683445686aSJoe Perches my $files; 469c707a81dSJoe Perches my $camelcase_cache = ""; 470c707a81dSJoe Perches my @include_files = (); 471c707a81dSJoe Perches 472c707a81dSJoe Perches $camelcase_seeded = 1; 473351b2a1fSJoe Perches 4743445686aSJoe Perches if (-d ".git") { 475351b2a1fSJoe Perches my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`; 476351b2a1fSJoe Perches chomp $git_last_include_commit; 477c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 478c707a81dSJoe Perches } else { 479c707a81dSJoe Perches my $last_mod_date = 0; 480c707a81dSJoe Perches $files = `find $root/include -name "*.h"`; 481c707a81dSJoe Perches @include_files = split('\n', $files); 482c707a81dSJoe Perches foreach my $file (@include_files) { 483c707a81dSJoe Perches my $date = POSIX::strftime("%Y%m%d%H%M", 484c707a81dSJoe Perches localtime((stat $file)[9])); 485c707a81dSJoe Perches $last_mod_date = $date if ($last_mod_date < $date); 486c707a81dSJoe Perches } 487c707a81dSJoe Perches $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 488c707a81dSJoe Perches } 489c707a81dSJoe Perches 490c707a81dSJoe Perches if ($camelcase_cache ne "" && -f $camelcase_cache) { 491c707a81dSJoe Perches open(my $camelcase_file, '<', "$camelcase_cache") 492c707a81dSJoe Perches or warn "$P: Can't read '$camelcase_cache' $!\n"; 493351b2a1fSJoe Perches while (<$camelcase_file>) { 494351b2a1fSJoe Perches chomp; 495351b2a1fSJoe Perches $camelcase{$_} = 1; 496351b2a1fSJoe Perches } 497351b2a1fSJoe Perches close($camelcase_file); 498351b2a1fSJoe Perches 499351b2a1fSJoe Perches return; 500351b2a1fSJoe Perches } 501c707a81dSJoe Perches 502c707a81dSJoe Perches if (-d ".git") { 503c707a81dSJoe Perches $files = `git ls-files "include/*.h"`; 504c707a81dSJoe Perches @include_files = split('\n', $files); 5053445686aSJoe Perches } 506c707a81dSJoe Perches 5073445686aSJoe Perches foreach my $file (@include_files) { 5083445686aSJoe Perches seed_camelcase_file($file); 5093445686aSJoe Perches } 510351b2a1fSJoe Perches 511c707a81dSJoe Perches if ($camelcase_cache ne "") { 512351b2a1fSJoe Perches unlink glob ".checkpatch-camelcase.*"; 513c707a81dSJoe Perches open(my $camelcase_file, '>', "$camelcase_cache") 514c707a81dSJoe Perches or warn "$P: Can't write '$camelcase_cache' $!\n"; 515351b2a1fSJoe Perches foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 516351b2a1fSJoe Perches print $camelcase_file ("$_\n"); 517351b2a1fSJoe Perches } 518351b2a1fSJoe Perches close($camelcase_file); 519351b2a1fSJoe Perches } 5203445686aSJoe Perches} 5213445686aSJoe Perches 5226c72ffaaSAndy Whitcroft$chk_signoff = 0 if ($file); 5230a920b5bSAndy Whitcroft 52400df344fSAndy Whitcroftmy @rawlines = (); 525c2fdda0dSAndy Whitcroftmy @lines = (); 5263705ce5bSJoe Perchesmy @fixed = (); 527c2fdda0dSAndy Whitcroftmy $vname; 5286c72ffaaSAndy Whitcroftfor my $filename (@ARGV) { 52921caa13cSAndy Whitcroft my $FILE; 5306c72ffaaSAndy Whitcroft if ($file) { 53121caa13cSAndy Whitcroft open($FILE, '-|', "diff -u /dev/null $filename") || 5326c72ffaaSAndy Whitcroft die "$P: $filename: diff failed - $!\n"; 53321caa13cSAndy Whitcroft } elsif ($filename eq '-') { 53421caa13cSAndy Whitcroft open($FILE, '<&STDIN'); 5356c72ffaaSAndy Whitcroft } else { 53621caa13cSAndy Whitcroft open($FILE, '<', "$filename") || 5376c72ffaaSAndy Whitcroft die "$P: $filename: open failed - $!\n"; 5386c72ffaaSAndy Whitcroft } 539c2fdda0dSAndy Whitcroft if ($filename eq '-') { 540c2fdda0dSAndy Whitcroft $vname = 'Your patch'; 541c2fdda0dSAndy Whitcroft } else { 542c2fdda0dSAndy Whitcroft $vname = $filename; 543c2fdda0dSAndy Whitcroft } 54421caa13cSAndy Whitcroft while (<$FILE>) { 5450a920b5bSAndy Whitcroft chomp; 54600df344fSAndy Whitcroft push(@rawlines, $_); 5476c72ffaaSAndy Whitcroft } 54821caa13cSAndy Whitcroft close($FILE); 549c2fdda0dSAndy Whitcroft if (!process($filename)) { 5500a920b5bSAndy Whitcroft $exit = 1; 5510a920b5bSAndy Whitcroft } 55200df344fSAndy Whitcroft @rawlines = (); 55313214adfSAndy Whitcroft @lines = (); 5543705ce5bSJoe Perches @fixed = (); 5550a920b5bSAndy Whitcroft} 5560a920b5bSAndy Whitcroft 5570a920b5bSAndy Whitcroftexit($exit); 5580a920b5bSAndy Whitcroft 5590a920b5bSAndy Whitcroftsub top_of_kernel_tree { 5606c72ffaaSAndy Whitcroft my ($root) = @_; 5616c72ffaaSAndy Whitcroft 5626c72ffaaSAndy Whitcroft my @tree_check = ( 5636c72ffaaSAndy Whitcroft "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 5646c72ffaaSAndy Whitcroft "README", "Documentation", "arch", "include", "drivers", 5656c72ffaaSAndy Whitcroft "fs", "init", "ipc", "kernel", "lib", "scripts", 5666c72ffaaSAndy Whitcroft ); 5676c72ffaaSAndy Whitcroft 5686c72ffaaSAndy Whitcroft foreach my $check (@tree_check) { 5696c72ffaaSAndy Whitcroft if (! -e $root . '/' . $check) { 5700a920b5bSAndy Whitcroft return 0; 5710a920b5bSAndy Whitcroft } 5726c72ffaaSAndy Whitcroft } 5736c72ffaaSAndy Whitcroft return 1; 5746c72ffaaSAndy Whitcroft} 5750a920b5bSAndy Whitcroft 57620112475SJoe Perchessub parse_email { 57720112475SJoe Perches my ($formatted_email) = @_; 57820112475SJoe Perches 57920112475SJoe Perches my $name = ""; 58020112475SJoe Perches my $address = ""; 58120112475SJoe Perches my $comment = ""; 58220112475SJoe Perches 58320112475SJoe Perches if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 58420112475SJoe Perches $name = $1; 58520112475SJoe Perches $address = $2; 58620112475SJoe Perches $comment = $3 if defined $3; 58720112475SJoe Perches } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 58820112475SJoe Perches $address = $1; 58920112475SJoe Perches $comment = $2 if defined $2; 59020112475SJoe Perches } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 59120112475SJoe Perches $address = $1; 59220112475SJoe Perches $comment = $2 if defined $2; 59320112475SJoe Perches $formatted_email =~ s/$address.*$//; 59420112475SJoe Perches $name = $formatted_email; 5953705ce5bSJoe Perches $name = trim($name); 59620112475SJoe Perches $name =~ s/^\"|\"$//g; 59720112475SJoe Perches # If there's a name left after stripping spaces and 59820112475SJoe Perches # leading quotes, and the address doesn't have both 59920112475SJoe Perches # leading and trailing angle brackets, the address 60020112475SJoe Perches # is invalid. ie: 60120112475SJoe Perches # "joe smith [email protected]" bad 60220112475SJoe Perches # "joe smith <[email protected]" bad 60320112475SJoe Perches if ($name ne "" && $address !~ /^<[^>]+>$/) { 60420112475SJoe Perches $name = ""; 60520112475SJoe Perches $address = ""; 60620112475SJoe Perches $comment = ""; 60720112475SJoe Perches } 60820112475SJoe Perches } 60920112475SJoe Perches 6103705ce5bSJoe Perches $name = trim($name); 61120112475SJoe Perches $name =~ s/^\"|\"$//g; 6123705ce5bSJoe Perches $address = trim($address); 61320112475SJoe Perches $address =~ s/^\<|\>$//g; 61420112475SJoe Perches 61520112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 61620112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 61720112475SJoe Perches $name = "\"$name\""; 61820112475SJoe Perches } 61920112475SJoe Perches 62020112475SJoe Perches return ($name, $address, $comment); 62120112475SJoe Perches} 62220112475SJoe Perches 62320112475SJoe Perchessub format_email { 62420112475SJoe Perches my ($name, $address) = @_; 62520112475SJoe Perches 62620112475SJoe Perches my $formatted_email; 62720112475SJoe Perches 6283705ce5bSJoe Perches $name = trim($name); 62920112475SJoe Perches $name =~ s/^\"|\"$//g; 6303705ce5bSJoe Perches $address = trim($address); 63120112475SJoe Perches 63220112475SJoe Perches if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 63320112475SJoe Perches $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 63420112475SJoe Perches $name = "\"$name\""; 63520112475SJoe Perches } 63620112475SJoe Perches 63720112475SJoe Perches if ("$name" eq "") { 63820112475SJoe Perches $formatted_email = "$address"; 63920112475SJoe Perches } else { 64020112475SJoe Perches $formatted_email = "$name <$address>"; 64120112475SJoe Perches } 64220112475SJoe Perches 64320112475SJoe Perches return $formatted_email; 64420112475SJoe Perches} 64520112475SJoe Perches 646000d1cc1SJoe Perchessub which_conf { 647000d1cc1SJoe Perches my ($conf) = @_; 648000d1cc1SJoe Perches 649000d1cc1SJoe Perches foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 650000d1cc1SJoe Perches if (-e "$path/$conf") { 651000d1cc1SJoe Perches return "$path/$conf"; 652000d1cc1SJoe Perches } 653000d1cc1SJoe Perches } 654000d1cc1SJoe Perches 655000d1cc1SJoe Perches return ""; 656000d1cc1SJoe Perches} 657000d1cc1SJoe Perches 6580a920b5bSAndy Whitcroftsub expand_tabs { 6590a920b5bSAndy Whitcroft my ($str) = @_; 6600a920b5bSAndy Whitcroft 6610a920b5bSAndy Whitcroft my $res = ''; 6620a920b5bSAndy Whitcroft my $n = 0; 6630a920b5bSAndy Whitcroft for my $c (split(//, $str)) { 6640a920b5bSAndy Whitcroft if ($c eq "\t") { 6650a920b5bSAndy Whitcroft $res .= ' '; 6660a920b5bSAndy Whitcroft $n++; 6670a920b5bSAndy Whitcroft for (; ($n % 8) != 0; $n++) { 6680a920b5bSAndy Whitcroft $res .= ' '; 6690a920b5bSAndy Whitcroft } 6700a920b5bSAndy Whitcroft next; 6710a920b5bSAndy Whitcroft } 6720a920b5bSAndy Whitcroft $res .= $c; 6730a920b5bSAndy Whitcroft $n++; 6740a920b5bSAndy Whitcroft } 6750a920b5bSAndy Whitcroft 6760a920b5bSAndy Whitcroft return $res; 6770a920b5bSAndy Whitcroft} 6786c72ffaaSAndy Whitcroftsub copy_spacing { 679773647a0SAndy Whitcroft (my $res = shift) =~ tr/\t/ /c; 6806c72ffaaSAndy Whitcroft return $res; 6816c72ffaaSAndy Whitcroft} 6820a920b5bSAndy Whitcroft 6834a0df2efSAndy Whitcroftsub line_stats { 6844a0df2efSAndy Whitcroft my ($line) = @_; 6854a0df2efSAndy Whitcroft 6864a0df2efSAndy Whitcroft # Drop the diff line leader and expand tabs 6874a0df2efSAndy Whitcroft $line =~ s/^.//; 6884a0df2efSAndy Whitcroft $line = expand_tabs($line); 6894a0df2efSAndy Whitcroft 6904a0df2efSAndy Whitcroft # Pick the indent from the front of the line. 6914a0df2efSAndy Whitcroft my ($white) = ($line =~ /^(\s*)/); 6924a0df2efSAndy Whitcroft 6934a0df2efSAndy Whitcroft return (length($line), length($white)); 6944a0df2efSAndy Whitcroft} 6954a0df2efSAndy Whitcroft 696773647a0SAndy Whitcroftmy $sanitise_quote = ''; 697773647a0SAndy Whitcroft 698773647a0SAndy Whitcroftsub sanitise_line_reset { 699773647a0SAndy Whitcroft my ($in_comment) = @_; 700773647a0SAndy Whitcroft 701773647a0SAndy Whitcroft if ($in_comment) { 702773647a0SAndy Whitcroft $sanitise_quote = '*/'; 703773647a0SAndy Whitcroft } else { 704773647a0SAndy Whitcroft $sanitise_quote = ''; 705773647a0SAndy Whitcroft } 706773647a0SAndy Whitcroft} 70700df344fSAndy Whitcroftsub sanitise_line { 70800df344fSAndy Whitcroft my ($line) = @_; 70900df344fSAndy Whitcroft 71000df344fSAndy Whitcroft my $res = ''; 71100df344fSAndy Whitcroft my $l = ''; 71200df344fSAndy Whitcroft 713c2fdda0dSAndy Whitcroft my $qlen = 0; 714773647a0SAndy Whitcroft my $off = 0; 715773647a0SAndy Whitcroft my $c; 71600df344fSAndy Whitcroft 717773647a0SAndy Whitcroft # Always copy over the diff marker. 718773647a0SAndy Whitcroft $res = substr($line, 0, 1); 719773647a0SAndy Whitcroft 720773647a0SAndy Whitcroft for ($off = 1; $off < length($line); $off++) { 721773647a0SAndy Whitcroft $c = substr($line, $off, 1); 722773647a0SAndy Whitcroft 723773647a0SAndy Whitcroft # Comments we are wacking completly including the begin 724773647a0SAndy Whitcroft # and end, all to $;. 725773647a0SAndy Whitcroft if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 726773647a0SAndy Whitcroft $sanitise_quote = '*/'; 727773647a0SAndy Whitcroft 728773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 729773647a0SAndy Whitcroft $off++; 73000df344fSAndy Whitcroft next; 731773647a0SAndy Whitcroft } 73281bc0e02SAndy Whitcroft if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 733773647a0SAndy Whitcroft $sanitise_quote = ''; 734773647a0SAndy Whitcroft substr($res, $off, 2, "$;$;"); 735773647a0SAndy Whitcroft $off++; 736773647a0SAndy Whitcroft next; 737773647a0SAndy Whitcroft } 738113f04a8SDaniel Walker if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 739113f04a8SDaniel Walker $sanitise_quote = '//'; 740113f04a8SDaniel Walker 741113f04a8SDaniel Walker substr($res, $off, 2, $sanitise_quote); 742113f04a8SDaniel Walker $off++; 743113f04a8SDaniel Walker next; 744113f04a8SDaniel Walker } 745773647a0SAndy Whitcroft 746773647a0SAndy Whitcroft # A \ in a string means ignore the next character. 747773647a0SAndy Whitcroft if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 748773647a0SAndy Whitcroft $c eq "\\") { 749773647a0SAndy Whitcroft substr($res, $off, 2, 'XX'); 750773647a0SAndy Whitcroft $off++; 751773647a0SAndy Whitcroft next; 752773647a0SAndy Whitcroft } 753773647a0SAndy Whitcroft # Regular quotes. 754773647a0SAndy Whitcroft if ($c eq "'" || $c eq '"') { 755773647a0SAndy Whitcroft if ($sanitise_quote eq '') { 756773647a0SAndy Whitcroft $sanitise_quote = $c; 757773647a0SAndy Whitcroft 758773647a0SAndy Whitcroft substr($res, $off, 1, $c); 759773647a0SAndy Whitcroft next; 760773647a0SAndy Whitcroft } elsif ($sanitise_quote eq $c) { 761773647a0SAndy Whitcroft $sanitise_quote = ''; 76200df344fSAndy Whitcroft } 76300df344fSAndy Whitcroft } 764773647a0SAndy Whitcroft 765fae17daeSAndy Whitcroft #print "c<$c> SQ<$sanitise_quote>\n"; 766773647a0SAndy Whitcroft if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 767773647a0SAndy Whitcroft substr($res, $off, 1, $;); 768113f04a8SDaniel Walker } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 769113f04a8SDaniel Walker substr($res, $off, 1, $;); 770773647a0SAndy Whitcroft } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 771773647a0SAndy Whitcroft substr($res, $off, 1, 'X'); 77200df344fSAndy Whitcroft } else { 773773647a0SAndy Whitcroft substr($res, $off, 1, $c); 77400df344fSAndy Whitcroft } 775c2fdda0dSAndy Whitcroft } 776c2fdda0dSAndy Whitcroft 777113f04a8SDaniel Walker if ($sanitise_quote eq '//') { 778113f04a8SDaniel Walker $sanitise_quote = ''; 779113f04a8SDaniel Walker } 780113f04a8SDaniel Walker 781c2fdda0dSAndy Whitcroft # The pathname on a #include may be surrounded by '<' and '>'. 782c45dcabdSAndy Whitcroft if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 783c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 784c2fdda0dSAndy Whitcroft $res =~ s@\<.*\>@<$clean>@; 785c2fdda0dSAndy Whitcroft 786c2fdda0dSAndy Whitcroft # The whole of a #error is a string. 787c45dcabdSAndy Whitcroft } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 788c2fdda0dSAndy Whitcroft my $clean = 'X' x length($1); 789c45dcabdSAndy Whitcroft $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 790c2fdda0dSAndy Whitcroft } 791c2fdda0dSAndy Whitcroft 79200df344fSAndy Whitcroft return $res; 79300df344fSAndy Whitcroft} 79400df344fSAndy Whitcroft 795a6962d72SJoe Perchessub get_quoted_string { 796a6962d72SJoe Perches my ($line, $rawline) = @_; 797a6962d72SJoe Perches 798a6962d72SJoe Perches return "" if ($line !~ m/(\"[X]+\")/g); 799a6962d72SJoe Perches return substr($rawline, $-[0], $+[0] - $-[0]); 800a6962d72SJoe Perches} 801a6962d72SJoe Perches 8028905a67cSAndy Whitcroftsub ctx_statement_block { 8038905a67cSAndy Whitcroft my ($linenr, $remain, $off) = @_; 8048905a67cSAndy Whitcroft my $line = $linenr - 1; 8058905a67cSAndy Whitcroft my $blk = ''; 8068905a67cSAndy Whitcroft my $soff = $off; 8078905a67cSAndy Whitcroft my $coff = $off - 1; 808773647a0SAndy Whitcroft my $coff_set = 0; 8098905a67cSAndy Whitcroft 81013214adfSAndy Whitcroft my $loff = 0; 81113214adfSAndy Whitcroft 8128905a67cSAndy Whitcroft my $type = ''; 8138905a67cSAndy Whitcroft my $level = 0; 814a2750645SAndy Whitcroft my @stack = (); 815cf655043SAndy Whitcroft my $p; 8168905a67cSAndy Whitcroft my $c; 8178905a67cSAndy Whitcroft my $len = 0; 81813214adfSAndy Whitcroft 81913214adfSAndy Whitcroft my $remainder; 8208905a67cSAndy Whitcroft while (1) { 821a2750645SAndy Whitcroft @stack = (['', 0]) if ($#stack == -1); 822a2750645SAndy Whitcroft 823773647a0SAndy Whitcroft #warn "CSB: blk<$blk> remain<$remain>\n"; 8248905a67cSAndy Whitcroft # If we are about to drop off the end, pull in more 8258905a67cSAndy Whitcroft # context. 8268905a67cSAndy Whitcroft if ($off >= $len) { 8278905a67cSAndy Whitcroft for (; $remain > 0; $line++) { 828dea33496SAndy Whitcroft last if (!defined $lines[$line]); 829c2fdda0dSAndy Whitcroft next if ($lines[$line] =~ /^-/); 8308905a67cSAndy Whitcroft $remain--; 83113214adfSAndy Whitcroft $loff = $len; 832c2fdda0dSAndy Whitcroft $blk .= $lines[$line] . "\n"; 8338905a67cSAndy Whitcroft $len = length($blk); 8348905a67cSAndy Whitcroft $line++; 8358905a67cSAndy Whitcroft last; 8368905a67cSAndy Whitcroft } 8378905a67cSAndy Whitcroft # Bail if there is no further context. 8388905a67cSAndy Whitcroft #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 83913214adfSAndy Whitcroft if ($off >= $len) { 8408905a67cSAndy Whitcroft last; 8418905a67cSAndy Whitcroft } 842f74bd194SAndy Whitcroft if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 843f74bd194SAndy Whitcroft $level++; 844f74bd194SAndy Whitcroft $type = '#'; 845f74bd194SAndy Whitcroft } 8468905a67cSAndy Whitcroft } 847cf655043SAndy Whitcroft $p = $c; 8488905a67cSAndy Whitcroft $c = substr($blk, $off, 1); 84913214adfSAndy Whitcroft $remainder = substr($blk, $off); 8508905a67cSAndy Whitcroft 851773647a0SAndy Whitcroft #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 8524635f4fbSAndy Whitcroft 8534635f4fbSAndy Whitcroft # Handle nested #if/#else. 8544635f4fbSAndy Whitcroft if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 8554635f4fbSAndy Whitcroft push(@stack, [ $type, $level ]); 8564635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 8574635f4fbSAndy Whitcroft ($type, $level) = @{$stack[$#stack - 1]}; 8584635f4fbSAndy Whitcroft } elsif ($remainder =~ /^#\s*endif\b/) { 8594635f4fbSAndy Whitcroft ($type, $level) = @{pop(@stack)}; 8604635f4fbSAndy Whitcroft } 8614635f4fbSAndy Whitcroft 8628905a67cSAndy Whitcroft # Statement ends at the ';' or a close '}' at the 8638905a67cSAndy Whitcroft # outermost level. 8648905a67cSAndy Whitcroft if ($level == 0 && $c eq ';') { 8658905a67cSAndy Whitcroft last; 8668905a67cSAndy Whitcroft } 8678905a67cSAndy Whitcroft 86813214adfSAndy Whitcroft # An else is really a conditional as long as its not else if 869773647a0SAndy Whitcroft if ($level == 0 && $coff_set == 0 && 870773647a0SAndy Whitcroft (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 871773647a0SAndy Whitcroft $remainder =~ /^(else)(?:\s|{)/ && 872773647a0SAndy Whitcroft $remainder !~ /^else\s+if\b/) { 873773647a0SAndy Whitcroft $coff = $off + length($1) - 1; 874773647a0SAndy Whitcroft $coff_set = 1; 875773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 876773647a0SAndy Whitcroft #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 87713214adfSAndy Whitcroft } 87813214adfSAndy Whitcroft 8798905a67cSAndy Whitcroft if (($type eq '' || $type eq '(') && $c eq '(') { 8808905a67cSAndy Whitcroft $level++; 8818905a67cSAndy Whitcroft $type = '('; 8828905a67cSAndy Whitcroft } 8838905a67cSAndy Whitcroft if ($type eq '(' && $c eq ')') { 8848905a67cSAndy Whitcroft $level--; 8858905a67cSAndy Whitcroft $type = ($level != 0)? '(' : ''; 8868905a67cSAndy Whitcroft 8878905a67cSAndy Whitcroft if ($level == 0 && $coff < $soff) { 8888905a67cSAndy Whitcroft $coff = $off; 889773647a0SAndy Whitcroft $coff_set = 1; 890773647a0SAndy Whitcroft #warn "CSB: mark coff<$coff>\n"; 8918905a67cSAndy Whitcroft } 8928905a67cSAndy Whitcroft } 8938905a67cSAndy Whitcroft if (($type eq '' || $type eq '{') && $c eq '{') { 8948905a67cSAndy Whitcroft $level++; 8958905a67cSAndy Whitcroft $type = '{'; 8968905a67cSAndy Whitcroft } 8978905a67cSAndy Whitcroft if ($type eq '{' && $c eq '}') { 8988905a67cSAndy Whitcroft $level--; 8998905a67cSAndy Whitcroft $type = ($level != 0)? '{' : ''; 9008905a67cSAndy Whitcroft 9018905a67cSAndy Whitcroft if ($level == 0) { 902b998e001SPatrick Pannuto if (substr($blk, $off + 1, 1) eq ';') { 903b998e001SPatrick Pannuto $off++; 904b998e001SPatrick Pannuto } 9058905a67cSAndy Whitcroft last; 9068905a67cSAndy Whitcroft } 9078905a67cSAndy Whitcroft } 908f74bd194SAndy Whitcroft # Preprocessor commands end at the newline unless escaped. 909f74bd194SAndy Whitcroft if ($type eq '#' && $c eq "\n" && $p ne "\\") { 910f74bd194SAndy Whitcroft $level--; 911f74bd194SAndy Whitcroft $type = ''; 912f74bd194SAndy Whitcroft $off++; 913f74bd194SAndy Whitcroft last; 914f74bd194SAndy Whitcroft } 9158905a67cSAndy Whitcroft $off++; 9168905a67cSAndy Whitcroft } 917a3bb97a7SAndy Whitcroft # We are truly at the end, so shuffle to the next line. 91813214adfSAndy Whitcroft if ($off == $len) { 919a3bb97a7SAndy Whitcroft $loff = $len + 1; 92013214adfSAndy Whitcroft $line++; 92113214adfSAndy Whitcroft $remain--; 92213214adfSAndy Whitcroft } 9238905a67cSAndy Whitcroft 9248905a67cSAndy Whitcroft my $statement = substr($blk, $soff, $off - $soff + 1); 9258905a67cSAndy Whitcroft my $condition = substr($blk, $soff, $coff - $soff + 1); 9268905a67cSAndy Whitcroft 9278905a67cSAndy Whitcroft #warn "STATEMENT<$statement>\n"; 9288905a67cSAndy Whitcroft #warn "CONDITION<$condition>\n"; 9298905a67cSAndy Whitcroft 930773647a0SAndy Whitcroft #print "coff<$coff> soff<$off> loff<$loff>\n"; 93113214adfSAndy Whitcroft 93213214adfSAndy Whitcroft return ($statement, $condition, 93313214adfSAndy Whitcroft $line, $remain + 1, $off - $loff + 1, $level); 93413214adfSAndy Whitcroft} 93513214adfSAndy Whitcroft 936cf655043SAndy Whitcroftsub statement_lines { 937cf655043SAndy Whitcroft my ($stmt) = @_; 938cf655043SAndy Whitcroft 939cf655043SAndy Whitcroft # Strip the diff line prefixes and rip blank lines at start and end. 940cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 941cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 942cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 943cf655043SAndy Whitcroft 944cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 945cf655043SAndy Whitcroft 946cf655043SAndy Whitcroft return $#stmt_lines + 2; 947cf655043SAndy Whitcroft} 948cf655043SAndy Whitcroft 949cf655043SAndy Whitcroftsub statement_rawlines { 950cf655043SAndy Whitcroft my ($stmt) = @_; 951cf655043SAndy Whitcroft 952cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 953cf655043SAndy Whitcroft 954cf655043SAndy Whitcroft return $#stmt_lines + 2; 955cf655043SAndy Whitcroft} 956cf655043SAndy Whitcroft 957cf655043SAndy Whitcroftsub statement_block_size { 958cf655043SAndy Whitcroft my ($stmt) = @_; 959cf655043SAndy Whitcroft 960cf655043SAndy Whitcroft $stmt =~ s/(^|\n)./$1/g; 961cf655043SAndy Whitcroft $stmt =~ s/^\s*{//; 962cf655043SAndy Whitcroft $stmt =~ s/}\s*$//; 963cf655043SAndy Whitcroft $stmt =~ s/^\s*//; 964cf655043SAndy Whitcroft $stmt =~ s/\s*$//; 965cf655043SAndy Whitcroft 966cf655043SAndy Whitcroft my @stmt_lines = ($stmt =~ /\n/g); 967cf655043SAndy Whitcroft my @stmt_statements = ($stmt =~ /;/g); 968cf655043SAndy Whitcroft 969cf655043SAndy Whitcroft my $stmt_lines = $#stmt_lines + 2; 970cf655043SAndy Whitcroft my $stmt_statements = $#stmt_statements + 1; 971cf655043SAndy Whitcroft 972cf655043SAndy Whitcroft if ($stmt_lines > $stmt_statements) { 973cf655043SAndy Whitcroft return $stmt_lines; 974cf655043SAndy Whitcroft } else { 975cf655043SAndy Whitcroft return $stmt_statements; 976cf655043SAndy Whitcroft } 977cf655043SAndy Whitcroft} 978cf655043SAndy Whitcroft 97913214adfSAndy Whitcroftsub ctx_statement_full { 98013214adfSAndy Whitcroft my ($linenr, $remain, $off) = @_; 98113214adfSAndy Whitcroft my ($statement, $condition, $level); 98213214adfSAndy Whitcroft 98313214adfSAndy Whitcroft my (@chunks); 98413214adfSAndy Whitcroft 985cf655043SAndy Whitcroft # Grab the first conditional/block pair. 98613214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 98713214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 988773647a0SAndy Whitcroft #print "F: c<$condition> s<$statement> remain<$remain>\n"; 98913214adfSAndy Whitcroft push(@chunks, [ $condition, $statement ]); 990cf655043SAndy Whitcroft if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 991cf655043SAndy Whitcroft return ($level, $linenr, @chunks); 992cf655043SAndy Whitcroft } 993cf655043SAndy Whitcroft 994cf655043SAndy Whitcroft # Pull in the following conditional/block pairs and see if they 995cf655043SAndy Whitcroft # could continue the statement. 996cf655043SAndy Whitcroft for (;;) { 99713214adfSAndy Whitcroft ($statement, $condition, $linenr, $remain, $off, $level) = 99813214adfSAndy Whitcroft ctx_statement_block($linenr, $remain, $off); 999cf655043SAndy Whitcroft #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1000773647a0SAndy Whitcroft last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1001cf655043SAndy Whitcroft #print "C: push\n"; 1002cf655043SAndy Whitcroft push(@chunks, [ $condition, $statement ]); 100313214adfSAndy Whitcroft } 100413214adfSAndy Whitcroft 100513214adfSAndy Whitcroft return ($level, $linenr, @chunks); 10068905a67cSAndy Whitcroft} 10078905a67cSAndy Whitcroft 10084a0df2efSAndy Whitcroftsub ctx_block_get { 1009f0a594c1SAndy Whitcroft my ($linenr, $remain, $outer, $open, $close, $off) = @_; 10104a0df2efSAndy Whitcroft my $line; 10114a0df2efSAndy Whitcroft my $start = $linenr - 1; 10124a0df2efSAndy Whitcroft my $blk = ''; 10134a0df2efSAndy Whitcroft my @o; 10144a0df2efSAndy Whitcroft my @c; 10154a0df2efSAndy Whitcroft my @res = (); 10164a0df2efSAndy Whitcroft 1017f0a594c1SAndy Whitcroft my $level = 0; 10184635f4fbSAndy Whitcroft my @stack = ($level); 101900df344fSAndy Whitcroft for ($line = $start; $remain > 0; $line++) { 102000df344fSAndy Whitcroft next if ($rawlines[$line] =~ /^-/); 102100df344fSAndy Whitcroft $remain--; 102200df344fSAndy Whitcroft 102300df344fSAndy Whitcroft $blk .= $rawlines[$line]; 10244635f4fbSAndy Whitcroft 10254635f4fbSAndy Whitcroft # Handle nested #if/#else. 102601464f30SAndy Whitcroft if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 10274635f4fbSAndy Whitcroft push(@stack, $level); 102801464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 10294635f4fbSAndy Whitcroft $level = $stack[$#stack - 1]; 103001464f30SAndy Whitcroft } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 10314635f4fbSAndy Whitcroft $level = pop(@stack); 10324635f4fbSAndy Whitcroft } 10334635f4fbSAndy Whitcroft 103401464f30SAndy Whitcroft foreach my $c (split(//, $lines[$line])) { 1035f0a594c1SAndy Whitcroft ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1036f0a594c1SAndy Whitcroft if ($off > 0) { 1037f0a594c1SAndy Whitcroft $off--; 1038f0a594c1SAndy Whitcroft next; 1039f0a594c1SAndy Whitcroft } 10404a0df2efSAndy Whitcroft 1041f0a594c1SAndy Whitcroft if ($c eq $close && $level > 0) { 1042f0a594c1SAndy Whitcroft $level--; 1043f0a594c1SAndy Whitcroft last if ($level == 0); 1044f0a594c1SAndy Whitcroft } elsif ($c eq $open) { 1045f0a594c1SAndy Whitcroft $level++; 1046f0a594c1SAndy Whitcroft } 1047f0a594c1SAndy Whitcroft } 10484a0df2efSAndy Whitcroft 1049f0a594c1SAndy Whitcroft if (!$outer || $level <= 1) { 105000df344fSAndy Whitcroft push(@res, $rawlines[$line]); 10514a0df2efSAndy Whitcroft } 10524a0df2efSAndy Whitcroft 1053f0a594c1SAndy Whitcroft last if ($level == 0); 10544a0df2efSAndy Whitcroft } 10554a0df2efSAndy Whitcroft 1056f0a594c1SAndy Whitcroft return ($level, @res); 10574a0df2efSAndy Whitcroft} 10584a0df2efSAndy Whitcroftsub ctx_block_outer { 10594a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 10604a0df2efSAndy Whitcroft 1061f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1062f0a594c1SAndy Whitcroft return @r; 10634a0df2efSAndy Whitcroft} 10644a0df2efSAndy Whitcroftsub ctx_block { 10654a0df2efSAndy Whitcroft my ($linenr, $remain) = @_; 10664a0df2efSAndy Whitcroft 1067f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1068f0a594c1SAndy Whitcroft return @r; 1069653d4876SAndy Whitcroft} 1070653d4876SAndy Whitcroftsub ctx_statement { 1071f0a594c1SAndy Whitcroft my ($linenr, $remain, $off) = @_; 1072f0a594c1SAndy Whitcroft 1073f0a594c1SAndy Whitcroft my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1074f0a594c1SAndy Whitcroft return @r; 1075f0a594c1SAndy Whitcroft} 1076f0a594c1SAndy Whitcroftsub ctx_block_level { 1077653d4876SAndy Whitcroft my ($linenr, $remain) = @_; 1078653d4876SAndy Whitcroft 1079f0a594c1SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 10804a0df2efSAndy Whitcroft} 10819c0ca6f9SAndy Whitcroftsub ctx_statement_level { 10829c0ca6f9SAndy Whitcroft my ($linenr, $remain, $off) = @_; 10839c0ca6f9SAndy Whitcroft 10849c0ca6f9SAndy Whitcroft return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 10859c0ca6f9SAndy Whitcroft} 10864a0df2efSAndy Whitcroft 10874a0df2efSAndy Whitcroftsub ctx_locate_comment { 10884a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 10894a0df2efSAndy Whitcroft 10904a0df2efSAndy Whitcroft # Catch a comment on the end of the line itself. 1091beae6332SAndy Whitcroft my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 10924a0df2efSAndy Whitcroft return $current_comment if (defined $current_comment); 10934a0df2efSAndy Whitcroft 10944a0df2efSAndy Whitcroft # Look through the context and try and figure out if there is a 10954a0df2efSAndy Whitcroft # comment. 10964a0df2efSAndy Whitcroft my $in_comment = 0; 10974a0df2efSAndy Whitcroft $current_comment = ''; 10984a0df2efSAndy Whitcroft for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 109900df344fSAndy Whitcroft my $line = $rawlines[$linenr - 1]; 110000df344fSAndy Whitcroft #warn " $line\n"; 11014a0df2efSAndy Whitcroft if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 11024a0df2efSAndy Whitcroft $in_comment = 1; 11034a0df2efSAndy Whitcroft } 11044a0df2efSAndy Whitcroft if ($line =~ m@/\*@) { 11054a0df2efSAndy Whitcroft $in_comment = 1; 11064a0df2efSAndy Whitcroft } 11074a0df2efSAndy Whitcroft if (!$in_comment && $current_comment ne '') { 11084a0df2efSAndy Whitcroft $current_comment = ''; 11094a0df2efSAndy Whitcroft } 11104a0df2efSAndy Whitcroft $current_comment .= $line . "\n" if ($in_comment); 11114a0df2efSAndy Whitcroft if ($line =~ m@\*/@) { 11124a0df2efSAndy Whitcroft $in_comment = 0; 11134a0df2efSAndy Whitcroft } 11144a0df2efSAndy Whitcroft } 11154a0df2efSAndy Whitcroft 11164a0df2efSAndy Whitcroft chomp($current_comment); 11174a0df2efSAndy Whitcroft return($current_comment); 11184a0df2efSAndy Whitcroft} 11194a0df2efSAndy Whitcroftsub ctx_has_comment { 11204a0df2efSAndy Whitcroft my ($first_line, $end_line) = @_; 11214a0df2efSAndy Whitcroft my $cmt = ctx_locate_comment($first_line, $end_line); 11224a0df2efSAndy Whitcroft 112300df344fSAndy Whitcroft ##print "LINE: $rawlines[$end_line - 1 ]\n"; 11244a0df2efSAndy Whitcroft ##print "CMMT: $cmt\n"; 11254a0df2efSAndy Whitcroft 11264a0df2efSAndy Whitcroft return ($cmt ne ''); 11274a0df2efSAndy Whitcroft} 11284a0df2efSAndy Whitcroft 11294d001e4dSAndy Whitcroftsub raw_line { 11304d001e4dSAndy Whitcroft my ($linenr, $cnt) = @_; 11314d001e4dSAndy Whitcroft 11324d001e4dSAndy Whitcroft my $offset = $linenr - 1; 11334d001e4dSAndy Whitcroft $cnt++; 11344d001e4dSAndy Whitcroft 11354d001e4dSAndy Whitcroft my $line; 11364d001e4dSAndy Whitcroft while ($cnt) { 11374d001e4dSAndy Whitcroft $line = $rawlines[$offset++]; 11384d001e4dSAndy Whitcroft next if (defined($line) && $line =~ /^-/); 11394d001e4dSAndy Whitcroft $cnt--; 11404d001e4dSAndy Whitcroft } 11414d001e4dSAndy Whitcroft 11424d001e4dSAndy Whitcroft return $line; 11434d001e4dSAndy Whitcroft} 11444d001e4dSAndy Whitcroft 11450a920b5bSAndy Whitcroftsub cat_vet { 11460a920b5bSAndy Whitcroft my ($vet) = @_; 11479c0ca6f9SAndy Whitcroft my ($res, $coded); 11480a920b5bSAndy Whitcroft 11499c0ca6f9SAndy Whitcroft $res = ''; 11506c72ffaaSAndy Whitcroft while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 11516c72ffaaSAndy Whitcroft $res .= $1; 11526c72ffaaSAndy Whitcroft if ($2 ne '') { 11539c0ca6f9SAndy Whitcroft $coded = sprintf("^%c", unpack('C', $2) + 64); 11546c72ffaaSAndy Whitcroft $res .= $coded; 11556c72ffaaSAndy Whitcroft } 11569c0ca6f9SAndy Whitcroft } 11579c0ca6f9SAndy Whitcroft $res =~ s/$/\$/; 11580a920b5bSAndy Whitcroft 11599c0ca6f9SAndy Whitcroft return $res; 11600a920b5bSAndy Whitcroft} 11610a920b5bSAndy Whitcroft 1162c2fdda0dSAndy Whitcroftmy $av_preprocessor = 0; 1163cf655043SAndy Whitcroftmy $av_pending; 1164c2fdda0dSAndy Whitcroftmy @av_paren_type; 11651f65f947SAndy Whitcroftmy $av_pend_colon; 1166c2fdda0dSAndy Whitcroft 1167c2fdda0dSAndy Whitcroftsub annotate_reset { 1168c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 1169cf655043SAndy Whitcroft $av_pending = '_'; 1170cf655043SAndy Whitcroft @av_paren_type = ('E'); 11711f65f947SAndy Whitcroft $av_pend_colon = 'O'; 1172c2fdda0dSAndy Whitcroft} 1173c2fdda0dSAndy Whitcroft 11746c72ffaaSAndy Whitcroftsub annotate_values { 11756c72ffaaSAndy Whitcroft my ($stream, $type) = @_; 11766c72ffaaSAndy Whitcroft 11776c72ffaaSAndy Whitcroft my $res; 11781f65f947SAndy Whitcroft my $var = '_' x length($stream); 11796c72ffaaSAndy Whitcroft my $cur = $stream; 11806c72ffaaSAndy Whitcroft 1181c2fdda0dSAndy Whitcroft print "$stream\n" if ($dbg_values > 1); 11826c72ffaaSAndy Whitcroft 11836c72ffaaSAndy Whitcroft while (length($cur)) { 1184773647a0SAndy Whitcroft @av_paren_type = ('E') if ($#av_paren_type < 0); 1185cf655043SAndy Whitcroft print " <" . join('', @av_paren_type) . 1186171ae1a4SAndy Whitcroft "> <$type> <$av_pending>" if ($dbg_values > 1); 11876c72ffaaSAndy Whitcroft if ($cur =~ /^(\s+)/o) { 1188c2fdda0dSAndy Whitcroft print "WS($1)\n" if ($dbg_values > 1); 1189c2fdda0dSAndy Whitcroft if ($1 =~ /\n/ && $av_preprocessor) { 1190cf655043SAndy Whitcroft $type = pop(@av_paren_type); 1191c2fdda0dSAndy Whitcroft $av_preprocessor = 0; 11926c72ffaaSAndy Whitcroft } 11936c72ffaaSAndy Whitcroft 1194c023e473SFlorian Mickler } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 11959446ef56SAndy Whitcroft print "CAST($1)\n" if ($dbg_values > 1); 11969446ef56SAndy Whitcroft push(@av_paren_type, $type); 1197addcdceaSAndy Whitcroft $type = 'c'; 11989446ef56SAndy Whitcroft 1199e91b6e26SAndy Whitcroft } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1200c2fdda0dSAndy Whitcroft print "DECLARE($1)\n" if ($dbg_values > 1); 12016c72ffaaSAndy Whitcroft $type = 'T'; 12026c72ffaaSAndy Whitcroft 1203389a2fe5SAndy Whitcroft } elsif ($cur =~ /^($Modifier)\s*/) { 1204389a2fe5SAndy Whitcroft print "MODIFIER($1)\n" if ($dbg_values > 1); 1205389a2fe5SAndy Whitcroft $type = 'T'; 1206389a2fe5SAndy Whitcroft 1207c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1208171ae1a4SAndy Whitcroft print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1209c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1210171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 1211171ae1a4SAndy Whitcroft if ($2 ne '') { 1212cf655043SAndy Whitcroft $av_pending = 'N'; 1213171ae1a4SAndy Whitcroft } 1214171ae1a4SAndy Whitcroft $type = 'E'; 1215171ae1a4SAndy Whitcroft 1216c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1217171ae1a4SAndy Whitcroft print "UNDEF($1)\n" if ($dbg_values > 1); 1218171ae1a4SAndy Whitcroft $av_preprocessor = 1; 1219171ae1a4SAndy Whitcroft push(@av_paren_type, $type); 12206c72ffaaSAndy Whitcroft 1221c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1222cf655043SAndy Whitcroft print "PRE_START($1)\n" if ($dbg_values > 1); 1223c2fdda0dSAndy Whitcroft $av_preprocessor = 1; 1224cf655043SAndy Whitcroft 1225cf655043SAndy Whitcroft push(@av_paren_type, $type); 1226cf655043SAndy Whitcroft push(@av_paren_type, $type); 1227171ae1a4SAndy Whitcroft $type = 'E'; 1228cf655043SAndy Whitcroft 1229c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1230cf655043SAndy Whitcroft print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1231cf655043SAndy Whitcroft $av_preprocessor = 1; 1232cf655043SAndy Whitcroft 1233cf655043SAndy Whitcroft push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1234cf655043SAndy Whitcroft 1235171ae1a4SAndy Whitcroft $type = 'E'; 1236cf655043SAndy Whitcroft 1237c45dcabdSAndy Whitcroft } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1238cf655043SAndy Whitcroft print "PRE_END($1)\n" if ($dbg_values > 1); 1239cf655043SAndy Whitcroft 1240cf655043SAndy Whitcroft $av_preprocessor = 1; 1241cf655043SAndy Whitcroft 1242cf655043SAndy Whitcroft # Assume all arms of the conditional end as this 1243cf655043SAndy Whitcroft # one does, and continue as if the #endif was not here. 1244cf655043SAndy Whitcroft pop(@av_paren_type); 1245cf655043SAndy Whitcroft push(@av_paren_type, $type); 1246171ae1a4SAndy Whitcroft $type = 'E'; 12476c72ffaaSAndy Whitcroft 12486c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\\\n)/o) { 1249c2fdda0dSAndy Whitcroft print "PRECONT($1)\n" if ($dbg_values > 1); 12506c72ffaaSAndy Whitcroft 1251171ae1a4SAndy Whitcroft } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1252171ae1a4SAndy Whitcroft print "ATTR($1)\n" if ($dbg_values > 1); 1253171ae1a4SAndy Whitcroft $av_pending = $type; 1254171ae1a4SAndy Whitcroft $type = 'N'; 1255171ae1a4SAndy Whitcroft 12566c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1257c2fdda0dSAndy Whitcroft print "SIZEOF($1)\n" if ($dbg_values > 1); 12586c72ffaaSAndy Whitcroft if (defined $2) { 1259cf655043SAndy Whitcroft $av_pending = 'V'; 12606c72ffaaSAndy Whitcroft } 12616c72ffaaSAndy Whitcroft $type = 'N'; 12626c72ffaaSAndy Whitcroft 126314b111c1SAndy Whitcroft } elsif ($cur =~ /^(if|while|for)\b/o) { 1264c2fdda0dSAndy Whitcroft print "COND($1)\n" if ($dbg_values > 1); 126514b111c1SAndy Whitcroft $av_pending = 'E'; 12666c72ffaaSAndy Whitcroft $type = 'N'; 12676c72ffaaSAndy Whitcroft 12681f65f947SAndy Whitcroft } elsif ($cur =~/^(case)/o) { 12691f65f947SAndy Whitcroft print "CASE($1)\n" if ($dbg_values > 1); 12701f65f947SAndy Whitcroft $av_pend_colon = 'C'; 12711f65f947SAndy Whitcroft $type = 'N'; 12721f65f947SAndy Whitcroft 127314b111c1SAndy Whitcroft } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1274c2fdda0dSAndy Whitcroft print "KEYWORD($1)\n" if ($dbg_values > 1); 12756c72ffaaSAndy Whitcroft $type = 'N'; 12766c72ffaaSAndy Whitcroft 12776c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\()/o) { 1278c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 1279cf655043SAndy Whitcroft push(@av_paren_type, $av_pending); 1280cf655043SAndy Whitcroft $av_pending = '_'; 12816c72ffaaSAndy Whitcroft $type = 'N'; 12826c72ffaaSAndy Whitcroft 12836c72ffaaSAndy Whitcroft } elsif ($cur =~ /^(\))/o) { 1284cf655043SAndy Whitcroft my $new_type = pop(@av_paren_type); 1285cf655043SAndy Whitcroft if ($new_type ne '_') { 1286cf655043SAndy Whitcroft $type = $new_type; 1287c2fdda0dSAndy Whitcroft print "PAREN('$1') -> $type\n" 1288c2fdda0dSAndy Whitcroft if ($dbg_values > 1); 12896c72ffaaSAndy Whitcroft } else { 1290c2fdda0dSAndy Whitcroft print "PAREN('$1')\n" if ($dbg_values > 1); 12916c72ffaaSAndy Whitcroft } 12926c72ffaaSAndy Whitcroft 1293c8cb2ca3SAndy Whitcroft } elsif ($cur =~ /^($Ident)\s*\(/o) { 1294c2fdda0dSAndy Whitcroft print "FUNC($1)\n" if ($dbg_values > 1); 1295c8cb2ca3SAndy Whitcroft $type = 'V'; 1296cf655043SAndy Whitcroft $av_pending = 'V'; 12976c72ffaaSAndy Whitcroft 12988e761b04SAndy Whitcroft } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 12998e761b04SAndy Whitcroft if (defined $2 && $type eq 'C' || $type eq 'T') { 13001f65f947SAndy Whitcroft $av_pend_colon = 'B'; 13018e761b04SAndy Whitcroft } elsif ($type eq 'E') { 13028e761b04SAndy Whitcroft $av_pend_colon = 'L'; 13031f65f947SAndy Whitcroft } 13041f65f947SAndy Whitcroft print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 13051f65f947SAndy Whitcroft $type = 'V'; 13061f65f947SAndy Whitcroft 13076c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Ident|$Constant)/o) { 1308c2fdda0dSAndy Whitcroft print "IDENT($1)\n" if ($dbg_values > 1); 13096c72ffaaSAndy Whitcroft $type = 'V'; 13106c72ffaaSAndy Whitcroft 13116c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Assignment)/o) { 1312c2fdda0dSAndy Whitcroft print "ASSIGN($1)\n" if ($dbg_values > 1); 13136c72ffaaSAndy Whitcroft $type = 'N'; 13146c72ffaaSAndy Whitcroft 1315cf655043SAndy Whitcroft } elsif ($cur =~/^(;|{|})/) { 1316c2fdda0dSAndy Whitcroft print "END($1)\n" if ($dbg_values > 1); 131713214adfSAndy Whitcroft $type = 'E'; 13181f65f947SAndy Whitcroft $av_pend_colon = 'O'; 131913214adfSAndy Whitcroft 13208e761b04SAndy Whitcroft } elsif ($cur =~/^(,)/) { 13218e761b04SAndy Whitcroft print "COMMA($1)\n" if ($dbg_values > 1); 13228e761b04SAndy Whitcroft $type = 'C'; 13238e761b04SAndy Whitcroft 13241f65f947SAndy Whitcroft } elsif ($cur =~ /^(\?)/o) { 13251f65f947SAndy Whitcroft print "QUESTION($1)\n" if ($dbg_values > 1); 13261f65f947SAndy Whitcroft $type = 'N'; 13271f65f947SAndy Whitcroft 13281f65f947SAndy Whitcroft } elsif ($cur =~ /^(:)/o) { 13291f65f947SAndy Whitcroft print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 13301f65f947SAndy Whitcroft 13311f65f947SAndy Whitcroft substr($var, length($res), 1, $av_pend_colon); 13321f65f947SAndy Whitcroft if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 13331f65f947SAndy Whitcroft $type = 'E'; 13341f65f947SAndy Whitcroft } else { 13351f65f947SAndy Whitcroft $type = 'N'; 13361f65f947SAndy Whitcroft } 13371f65f947SAndy Whitcroft $av_pend_colon = 'O'; 13381f65f947SAndy Whitcroft 13398e761b04SAndy Whitcroft } elsif ($cur =~ /^(\[)/o) { 134013214adfSAndy Whitcroft print "CLOSE($1)\n" if ($dbg_values > 1); 13416c72ffaaSAndy Whitcroft $type = 'N'; 13426c72ffaaSAndy Whitcroft 13430d413866SAndy Whitcroft } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 134474048ed8SAndy Whitcroft my $variant; 134574048ed8SAndy Whitcroft 134674048ed8SAndy Whitcroft print "OPV($1)\n" if ($dbg_values > 1); 134774048ed8SAndy Whitcroft if ($type eq 'V') { 134874048ed8SAndy Whitcroft $variant = 'B'; 134974048ed8SAndy Whitcroft } else { 135074048ed8SAndy Whitcroft $variant = 'U'; 135174048ed8SAndy Whitcroft } 135274048ed8SAndy Whitcroft 135374048ed8SAndy Whitcroft substr($var, length($res), 1, $variant); 135474048ed8SAndy Whitcroft $type = 'N'; 135574048ed8SAndy Whitcroft 13566c72ffaaSAndy Whitcroft } elsif ($cur =~ /^($Operators)/o) { 1357c2fdda0dSAndy Whitcroft print "OP($1)\n" if ($dbg_values > 1); 13586c72ffaaSAndy Whitcroft if ($1 ne '++' && $1 ne '--') { 13596c72ffaaSAndy Whitcroft $type = 'N'; 13606c72ffaaSAndy Whitcroft } 13616c72ffaaSAndy Whitcroft 13626c72ffaaSAndy Whitcroft } elsif ($cur =~ /(^.)/o) { 1363c2fdda0dSAndy Whitcroft print "C($1)\n" if ($dbg_values > 1); 13646c72ffaaSAndy Whitcroft } 13656c72ffaaSAndy Whitcroft if (defined $1) { 13666c72ffaaSAndy Whitcroft $cur = substr($cur, length($1)); 13676c72ffaaSAndy Whitcroft $res .= $type x length($1); 13686c72ffaaSAndy Whitcroft } 13696c72ffaaSAndy Whitcroft } 13706c72ffaaSAndy Whitcroft 13711f65f947SAndy Whitcroft return ($res, $var); 13726c72ffaaSAndy Whitcroft} 13736c72ffaaSAndy Whitcroft 13748905a67cSAndy Whitcroftsub possible { 137513214adfSAndy Whitcroft my ($possible, $line) = @_; 13769a974fdbSAndy Whitcroft my $notPermitted = qr{(?: 13770776e594SAndy Whitcroft ^(?: 13780776e594SAndy Whitcroft $Modifier| 13790776e594SAndy Whitcroft $Storage| 13800776e594SAndy Whitcroft $Type| 13819a974fdbSAndy Whitcroft DEFINE_\S+ 13829a974fdbSAndy Whitcroft )$| 13839a974fdbSAndy Whitcroft ^(?: 13840776e594SAndy Whitcroft goto| 13850776e594SAndy Whitcroft return| 13860776e594SAndy Whitcroft case| 13870776e594SAndy Whitcroft else| 13880776e594SAndy Whitcroft asm|__asm__| 138989a88353SAndy Whitcroft do| 139089a88353SAndy Whitcroft \#| 139189a88353SAndy Whitcroft \#\#| 13929a974fdbSAndy Whitcroft )(?:\s|$)| 13930776e594SAndy Whitcroft ^(?:typedef|struct|enum)\b 13949a974fdbSAndy Whitcroft )}x; 13959a974fdbSAndy Whitcroft warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 13969a974fdbSAndy Whitcroft if ($possible !~ $notPermitted) { 1397c45dcabdSAndy Whitcroft # Check for modifiers. 1398c45dcabdSAndy Whitcroft $possible =~ s/\s*$Storage\s*//g; 1399c45dcabdSAndy Whitcroft $possible =~ s/\s*$Sparse\s*//g; 1400c45dcabdSAndy Whitcroft if ($possible =~ /^\s*$/) { 1401c45dcabdSAndy Whitcroft 1402c45dcabdSAndy Whitcroft } elsif ($possible =~ /\s/) { 1403c45dcabdSAndy Whitcroft $possible =~ s/\s*$Type\s*//g; 1404d2506586SAndy Whitcroft for my $modifier (split(' ', $possible)) { 14059a974fdbSAndy Whitcroft if ($modifier !~ $notPermitted) { 1406d2506586SAndy Whitcroft warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1407d2506586SAndy Whitcroft push(@modifierList, $modifier); 1408d2506586SAndy Whitcroft } 14099a974fdbSAndy Whitcroft } 1410c45dcabdSAndy Whitcroft 1411c45dcabdSAndy Whitcroft } else { 141213214adfSAndy Whitcroft warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 14138905a67cSAndy Whitcroft push(@typeList, $possible); 1414c45dcabdSAndy Whitcroft } 14158905a67cSAndy Whitcroft build_types(); 14160776e594SAndy Whitcroft } else { 14170776e594SAndy Whitcroft warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 14188905a67cSAndy Whitcroft } 14198905a67cSAndy Whitcroft} 14208905a67cSAndy Whitcroft 14216c72ffaaSAndy Whitcroftmy $prefix = ''; 14226c72ffaaSAndy Whitcroft 1423000d1cc1SJoe Perchessub show_type { 142491bfe484SJoe Perches return defined $use_type{$_[0]} if (scalar keys %use_type > 0); 142591bfe484SJoe Perches 1426000d1cc1SJoe Perches return !defined $ignore_type{$_[0]}; 1427000d1cc1SJoe Perches} 1428000d1cc1SJoe Perches 1429f0a594c1SAndy Whitcroftsub report { 1430000d1cc1SJoe Perches if (!show_type($_[1]) || 1431000d1cc1SJoe Perches (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) { 1432773647a0SAndy Whitcroft return 0; 1433773647a0SAndy Whitcroft } 1434000d1cc1SJoe Perches my $line; 1435000d1cc1SJoe Perches if ($show_types) { 1436000d1cc1SJoe Perches $line = "$prefix$_[0]:$_[1]: $_[2]\n"; 1437000d1cc1SJoe Perches } else { 1438000d1cc1SJoe Perches $line = "$prefix$_[0]: $_[2]\n"; 1439000d1cc1SJoe Perches } 14408905a67cSAndy Whitcroft $line = (split('\n', $line))[0] . "\n" if ($terse); 14418905a67cSAndy Whitcroft 144213214adfSAndy Whitcroft push(our @report, $line); 1443773647a0SAndy Whitcroft 1444773647a0SAndy Whitcroft return 1; 1445f0a594c1SAndy Whitcroft} 1446f0a594c1SAndy Whitcroftsub report_dump { 144713214adfSAndy Whitcroft our @report; 1448f0a594c1SAndy Whitcroft} 1449000d1cc1SJoe Perches 1450de7d4f0eSAndy Whitcroftsub ERROR { 1451000d1cc1SJoe Perches if (report("ERROR", $_[0], $_[1])) { 1452de7d4f0eSAndy Whitcroft our $clean = 0; 14536c72ffaaSAndy Whitcroft our $cnt_error++; 14543705ce5bSJoe Perches return 1; 1455de7d4f0eSAndy Whitcroft } 14563705ce5bSJoe Perches return 0; 1457773647a0SAndy Whitcroft} 1458de7d4f0eSAndy Whitcroftsub WARN { 1459000d1cc1SJoe Perches if (report("WARNING", $_[0], $_[1])) { 1460de7d4f0eSAndy Whitcroft our $clean = 0; 14616c72ffaaSAndy Whitcroft our $cnt_warn++; 14623705ce5bSJoe Perches return 1; 1463de7d4f0eSAndy Whitcroft } 14643705ce5bSJoe Perches return 0; 1465773647a0SAndy Whitcroft} 1466de7d4f0eSAndy Whitcroftsub CHK { 1467000d1cc1SJoe Perches if ($check && report("CHECK", $_[0], $_[1])) { 1468de7d4f0eSAndy Whitcroft our $clean = 0; 14696c72ffaaSAndy Whitcroft our $cnt_chk++; 14703705ce5bSJoe Perches return 1; 14716c72ffaaSAndy Whitcroft } 14723705ce5bSJoe Perches return 0; 1473de7d4f0eSAndy Whitcroft} 1474de7d4f0eSAndy Whitcroft 14756ecd9674SAndy Whitcroftsub check_absolute_file { 14766ecd9674SAndy Whitcroft my ($absolute, $herecurr) = @_; 14776ecd9674SAndy Whitcroft my $file = $absolute; 14786ecd9674SAndy Whitcroft 14796ecd9674SAndy Whitcroft ##print "absolute<$absolute>\n"; 14806ecd9674SAndy Whitcroft 14816ecd9674SAndy Whitcroft # See if any suffix of this path is a path within the tree. 14826ecd9674SAndy Whitcroft while ($file =~ s@^[^/]*/@@) { 14836ecd9674SAndy Whitcroft if (-f "$root/$file") { 14846ecd9674SAndy Whitcroft ##print "file<$file>\n"; 14856ecd9674SAndy Whitcroft last; 14866ecd9674SAndy Whitcroft } 14876ecd9674SAndy Whitcroft } 14886ecd9674SAndy Whitcroft if (! -f _) { 14896ecd9674SAndy Whitcroft return 0; 14906ecd9674SAndy Whitcroft } 14916ecd9674SAndy Whitcroft 14926ecd9674SAndy Whitcroft # It is, so see if the prefix is acceptable. 14936ecd9674SAndy Whitcroft my $prefix = $absolute; 14946ecd9674SAndy Whitcroft substr($prefix, -length($file)) = ''; 14956ecd9674SAndy Whitcroft 14966ecd9674SAndy Whitcroft ##print "prefix<$prefix>\n"; 14976ecd9674SAndy Whitcroft if ($prefix ne ".../") { 1498000d1cc1SJoe Perches WARN("USE_RELATIVE_PATH", 1499000d1cc1SJoe Perches "use relative pathname instead of absolute in changelog text\n" . $herecurr); 15006ecd9674SAndy Whitcroft } 15016ecd9674SAndy Whitcroft} 15026ecd9674SAndy Whitcroft 15033705ce5bSJoe Perchessub trim { 15043705ce5bSJoe Perches my ($string) = @_; 15053705ce5bSJoe Perches 1506b34c648bSJoe Perches $string =~ s/^\s+|\s+$//g; 1507b34c648bSJoe Perches 1508b34c648bSJoe Perches return $string; 1509b34c648bSJoe Perches} 1510b34c648bSJoe Perches 1511b34c648bSJoe Perchessub ltrim { 1512b34c648bSJoe Perches my ($string) = @_; 1513b34c648bSJoe Perches 1514b34c648bSJoe Perches $string =~ s/^\s+//; 1515b34c648bSJoe Perches 1516b34c648bSJoe Perches return $string; 1517b34c648bSJoe Perches} 1518b34c648bSJoe Perches 1519b34c648bSJoe Perchessub rtrim { 1520b34c648bSJoe Perches my ($string) = @_; 1521b34c648bSJoe Perches 1522b34c648bSJoe Perches $string =~ s/\s+$//; 15233705ce5bSJoe Perches 15243705ce5bSJoe Perches return $string; 15253705ce5bSJoe Perches} 15263705ce5bSJoe Perches 152752ea8506SJoe Perchessub string_find_replace { 152852ea8506SJoe Perches my ($string, $find, $replace) = @_; 152952ea8506SJoe Perches 153052ea8506SJoe Perches $string =~ s/$find/$replace/g; 153152ea8506SJoe Perches 153252ea8506SJoe Perches return $string; 153352ea8506SJoe Perches} 153452ea8506SJoe Perches 15353705ce5bSJoe Perchessub tabify { 15363705ce5bSJoe Perches my ($leading) = @_; 15373705ce5bSJoe Perches 15383705ce5bSJoe Perches my $source_indent = 8; 15393705ce5bSJoe Perches my $max_spaces_before_tab = $source_indent - 1; 15403705ce5bSJoe Perches my $spaces_to_tab = " " x $source_indent; 15413705ce5bSJoe Perches 15423705ce5bSJoe Perches #convert leading spaces to tabs 15433705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 15443705ce5bSJoe Perches #Remove spaces before a tab 15453705ce5bSJoe Perches 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 15463705ce5bSJoe Perches 15473705ce5bSJoe Perches return "$leading"; 15483705ce5bSJoe Perches} 15493705ce5bSJoe Perches 1550d1fe9c09SJoe Perchessub pos_last_openparen { 1551d1fe9c09SJoe Perches my ($line) = @_; 1552d1fe9c09SJoe Perches 1553d1fe9c09SJoe Perches my $pos = 0; 1554d1fe9c09SJoe Perches 1555d1fe9c09SJoe Perches my $opens = $line =~ tr/\(/\(/; 1556d1fe9c09SJoe Perches my $closes = $line =~ tr/\)/\)/; 1557d1fe9c09SJoe Perches 1558d1fe9c09SJoe Perches my $last_openparen = 0; 1559d1fe9c09SJoe Perches 1560d1fe9c09SJoe Perches if (($opens == 0) || ($closes >= $opens)) { 1561d1fe9c09SJoe Perches return -1; 1562d1fe9c09SJoe Perches } 1563d1fe9c09SJoe Perches 1564d1fe9c09SJoe Perches my $len = length($line); 1565d1fe9c09SJoe Perches 1566d1fe9c09SJoe Perches for ($pos = 0; $pos < $len; $pos++) { 1567d1fe9c09SJoe Perches my $string = substr($line, $pos); 1568d1fe9c09SJoe Perches if ($string =~ /^($FuncArg|$balanced_parens)/) { 1569d1fe9c09SJoe Perches $pos += length($1) - 1; 1570d1fe9c09SJoe Perches } elsif (substr($line, $pos, 1) eq '(') { 1571d1fe9c09SJoe Perches $last_openparen = $pos; 1572d1fe9c09SJoe Perches } elsif (index($string, '(') == -1) { 1573d1fe9c09SJoe Perches last; 1574d1fe9c09SJoe Perches } 1575d1fe9c09SJoe Perches } 1576d1fe9c09SJoe Perches 1577d1fe9c09SJoe Perches return $last_openparen + 1; 1578d1fe9c09SJoe Perches} 1579d1fe9c09SJoe Perches 15800a920b5bSAndy Whitcroftsub process { 15810a920b5bSAndy Whitcroft my $filename = shift; 15820a920b5bSAndy Whitcroft 15830a920b5bSAndy Whitcroft my $linenr=0; 15840a920b5bSAndy Whitcroft my $prevline=""; 1585c2fdda0dSAndy Whitcroft my $prevrawline=""; 15860a920b5bSAndy Whitcroft my $stashline=""; 1587c2fdda0dSAndy Whitcroft my $stashrawline=""; 15880a920b5bSAndy Whitcroft 15894a0df2efSAndy Whitcroft my $length; 15900a920b5bSAndy Whitcroft my $indent; 15910a920b5bSAndy Whitcroft my $previndent=0; 15920a920b5bSAndy Whitcroft my $stashindent=0; 15930a920b5bSAndy Whitcroft 1594de7d4f0eSAndy Whitcroft our $clean = 1; 15950a920b5bSAndy Whitcroft my $signoff = 0; 15960a920b5bSAndy Whitcroft my $is_patch = 0; 15970a920b5bSAndy Whitcroft 159815662b3eSJoe Perches my $in_header_lines = 1; 159915662b3eSJoe Perches my $in_commit_log = 0; #Scanning lines before patch 160015662b3eSJoe Perches 1601fa64205dSPasi Savanainen my $non_utf8_charset = 0; 1602fa64205dSPasi Savanainen 160313214adfSAndy Whitcroft our @report = (); 16046c72ffaaSAndy Whitcroft our $cnt_lines = 0; 16056c72ffaaSAndy Whitcroft our $cnt_error = 0; 16066c72ffaaSAndy Whitcroft our $cnt_warn = 0; 16076c72ffaaSAndy Whitcroft our $cnt_chk = 0; 16086c72ffaaSAndy Whitcroft 16090a920b5bSAndy Whitcroft # Trace the real file/line as we go. 16100a920b5bSAndy Whitcroft my $realfile = ''; 16110a920b5bSAndy Whitcroft my $realline = 0; 16120a920b5bSAndy Whitcroft my $realcnt = 0; 16130a920b5bSAndy Whitcroft my $here = ''; 16140a920b5bSAndy Whitcroft my $in_comment = 0; 1615c2fdda0dSAndy Whitcroft my $comment_edge = 0; 16160a920b5bSAndy Whitcroft my $first_line = 0; 16171e855726SWolfram Sang my $p1_prefix = ''; 16180a920b5bSAndy Whitcroft 161913214adfSAndy Whitcroft my $prev_values = 'E'; 162013214adfSAndy Whitcroft 162113214adfSAndy Whitcroft # suppression flags 1622773647a0SAndy Whitcroft my %suppress_ifbraces; 1623170d3a22SAndy Whitcroft my %suppress_whiletrailers; 16242b474a1aSAndy Whitcroft my %suppress_export; 16253e469cdcSAndy Whitcroft my $suppress_statement = 0; 1626653d4876SAndy Whitcroft 16277e51f197SJoe Perches my %signatures = (); 1628323c1260SJoe Perches 1629c2fdda0dSAndy Whitcroft # Pre-scan the patch sanitizing the lines. 1630de7d4f0eSAndy Whitcroft # Pre-scan the patch looking for any __setup documentation. 1631c2fdda0dSAndy Whitcroft # 1632de7d4f0eSAndy Whitcroft my @setup_docs = (); 1633de7d4f0eSAndy Whitcroft my $setup_docs = 0; 1634773647a0SAndy Whitcroft 1635d8b07710SJoe Perches my $camelcase_file_seeded = 0; 1636d8b07710SJoe Perches 1637773647a0SAndy Whitcroft sanitise_line_reset(); 1638c2fdda0dSAndy Whitcroft my $line; 1639c2fdda0dSAndy Whitcroft foreach my $rawline (@rawlines) { 1640773647a0SAndy Whitcroft $linenr++; 1641773647a0SAndy Whitcroft $line = $rawline; 1642c2fdda0dSAndy Whitcroft 16433705ce5bSJoe Perches push(@fixed, $rawline) if ($fix); 16443705ce5bSJoe Perches 1645773647a0SAndy Whitcroft if ($rawline=~/^\+\+\+\s+(\S+)/) { 1646de7d4f0eSAndy Whitcroft $setup_docs = 0; 1647de7d4f0eSAndy Whitcroft if ($1 =~ m@Documentation/kernel-parameters.txt$@) { 1648de7d4f0eSAndy Whitcroft $setup_docs = 1; 1649de7d4f0eSAndy Whitcroft } 1650773647a0SAndy Whitcroft #next; 1651de7d4f0eSAndy Whitcroft } 1652773647a0SAndy Whitcroft if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1653773647a0SAndy Whitcroft $realline=$1-1; 1654773647a0SAndy Whitcroft if (defined $2) { 1655773647a0SAndy Whitcroft $realcnt=$3+1; 1656773647a0SAndy Whitcroft } else { 1657773647a0SAndy Whitcroft $realcnt=1+1; 1658773647a0SAndy Whitcroft } 1659c45dcabdSAndy Whitcroft $in_comment = 0; 1660773647a0SAndy Whitcroft 1661773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. Run 1662773647a0SAndy Whitcroft # the context looking for a comment "edge". If this 1663773647a0SAndy Whitcroft # edge is a close comment then we must be in a comment 1664773647a0SAndy Whitcroft # at context start. 1665773647a0SAndy Whitcroft my $edge; 166601fa9147SAndy Whitcroft my $cnt = $realcnt; 166701fa9147SAndy Whitcroft for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 166801fa9147SAndy Whitcroft next if (defined $rawlines[$ln - 1] && 166901fa9147SAndy Whitcroft $rawlines[$ln - 1] =~ /^-/); 167001fa9147SAndy Whitcroft $cnt--; 167101fa9147SAndy Whitcroft #print "RAW<$rawlines[$ln - 1]>\n"; 1672721c1cb6SAndy Whitcroft last if (!defined $rawlines[$ln - 1]); 1673fae17daeSAndy Whitcroft if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1674fae17daeSAndy Whitcroft $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1675fae17daeSAndy Whitcroft ($edge) = $1; 1676fae17daeSAndy Whitcroft last; 1677fae17daeSAndy Whitcroft } 1678773647a0SAndy Whitcroft } 1679773647a0SAndy Whitcroft if (defined $edge && $edge eq '*/') { 1680773647a0SAndy Whitcroft $in_comment = 1; 1681773647a0SAndy Whitcroft } 1682773647a0SAndy Whitcroft 1683773647a0SAndy Whitcroft # Guestimate if this is a continuing comment. If this 1684773647a0SAndy Whitcroft # is the start of a diff block and this line starts 1685773647a0SAndy Whitcroft # ' *' then it is very likely a comment. 1686773647a0SAndy Whitcroft if (!defined $edge && 168783242e0cSAndy Whitcroft $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1688773647a0SAndy Whitcroft { 1689773647a0SAndy Whitcroft $in_comment = 1; 1690773647a0SAndy Whitcroft } 1691773647a0SAndy Whitcroft 1692773647a0SAndy Whitcroft ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1693773647a0SAndy Whitcroft sanitise_line_reset($in_comment); 1694773647a0SAndy Whitcroft 1695171ae1a4SAndy Whitcroft } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1696773647a0SAndy Whitcroft # Standardise the strings and chars within the input to 1697171ae1a4SAndy Whitcroft # simplify matching -- only bother with positive lines. 1698773647a0SAndy Whitcroft $line = sanitise_line($rawline); 1699773647a0SAndy Whitcroft } 1700773647a0SAndy Whitcroft push(@lines, $line); 1701773647a0SAndy Whitcroft 1702773647a0SAndy Whitcroft if ($realcnt > 1) { 1703773647a0SAndy Whitcroft $realcnt-- if ($line =~ /^(?:\+| |$)/); 1704773647a0SAndy Whitcroft } else { 1705773647a0SAndy Whitcroft $realcnt = 0; 1706773647a0SAndy Whitcroft } 1707773647a0SAndy Whitcroft 1708773647a0SAndy Whitcroft #print "==>$rawline\n"; 1709773647a0SAndy Whitcroft #print "-->$line\n"; 1710de7d4f0eSAndy Whitcroft 1711de7d4f0eSAndy Whitcroft if ($setup_docs && $line =~ /^\+/) { 1712de7d4f0eSAndy Whitcroft push(@setup_docs, $line); 1713de7d4f0eSAndy Whitcroft } 1714de7d4f0eSAndy Whitcroft } 1715de7d4f0eSAndy Whitcroft 17166c72ffaaSAndy Whitcroft $prefix = ''; 17176c72ffaaSAndy Whitcroft 1718773647a0SAndy Whitcroft $realcnt = 0; 1719773647a0SAndy Whitcroft $linenr = 0; 17200a920b5bSAndy Whitcroft foreach my $line (@lines) { 17210a920b5bSAndy Whitcroft $linenr++; 17221b5539b1SJoe Perches my $sline = $line; #copy of $line 17231b5539b1SJoe Perches $sline =~ s/$;/ /g; #with comments as spaces 17240a920b5bSAndy Whitcroft 1725c2fdda0dSAndy Whitcroft my $rawline = $rawlines[$linenr - 1]; 17266c72ffaaSAndy Whitcroft 17270a920b5bSAndy Whitcroft#extract the line range in the file after the patch is applied 17286c72ffaaSAndy Whitcroft if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 17290a920b5bSAndy Whitcroft $is_patch = 1; 17304a0df2efSAndy Whitcroft $first_line = $linenr + 1; 17310a920b5bSAndy Whitcroft $realline=$1-1; 17320a920b5bSAndy Whitcroft if (defined $2) { 17330a920b5bSAndy Whitcroft $realcnt=$3+1; 17340a920b5bSAndy Whitcroft } else { 17350a920b5bSAndy Whitcroft $realcnt=1+1; 17360a920b5bSAndy Whitcroft } 1737c2fdda0dSAndy Whitcroft annotate_reset(); 173813214adfSAndy Whitcroft $prev_values = 'E'; 173913214adfSAndy Whitcroft 1740773647a0SAndy Whitcroft %suppress_ifbraces = (); 1741170d3a22SAndy Whitcroft %suppress_whiletrailers = (); 17422b474a1aSAndy Whitcroft %suppress_export = (); 17433e469cdcSAndy Whitcroft $suppress_statement = 0; 17440a920b5bSAndy Whitcroft next; 17450a920b5bSAndy Whitcroft 17464a0df2efSAndy Whitcroft# track the line number as we move through the hunk, note that 17474a0df2efSAndy Whitcroft# new versions of GNU diff omit the leading space on completely 17484a0df2efSAndy Whitcroft# blank context lines so we need to count that too. 1749773647a0SAndy Whitcroft } elsif ($line =~ /^( |\+|$)/) { 17500a920b5bSAndy Whitcroft $realline++; 1751d8aaf121SAndy Whitcroft $realcnt-- if ($realcnt != 0); 17520a920b5bSAndy Whitcroft 17534a0df2efSAndy Whitcroft # Measure the line length and indent. 1754c2fdda0dSAndy Whitcroft ($length, $indent) = line_stats($rawline); 17550a920b5bSAndy Whitcroft 17560a920b5bSAndy Whitcroft # Track the previous line. 17570a920b5bSAndy Whitcroft ($prevline, $stashline) = ($stashline, $line); 17580a920b5bSAndy Whitcroft ($previndent, $stashindent) = ($stashindent, $indent); 1759c2fdda0dSAndy Whitcroft ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1760c2fdda0dSAndy Whitcroft 1761773647a0SAndy Whitcroft #warn "line<$line>\n"; 17626c72ffaaSAndy Whitcroft 1763d8aaf121SAndy Whitcroft } elsif ($realcnt == 1) { 1764d8aaf121SAndy Whitcroft $realcnt--; 17650a920b5bSAndy Whitcroft } 17660a920b5bSAndy Whitcroft 1767cc77cdcaSAndy Whitcroft my $hunk_line = ($realcnt != 0); 1768cc77cdcaSAndy Whitcroft 17690a920b5bSAndy Whitcroft#make up the handle for any error we report on this line 1770773647a0SAndy Whitcroft $prefix = "$filename:$realline: " if ($emacs && $file); 1771773647a0SAndy Whitcroft $prefix = "$filename:$linenr: " if ($emacs && !$file); 1772773647a0SAndy Whitcroft 17736c72ffaaSAndy Whitcroft $here = "#$linenr: " if (!$file); 17746c72ffaaSAndy Whitcroft $here = "#$realline: " if ($file); 1775773647a0SAndy Whitcroft 1776773647a0SAndy Whitcroft # extract the filename as it passes 17773bf9a009SRabin Vincent if ($line =~ /^diff --git.*?(\S+)$/) { 17783bf9a009SRabin Vincent $realfile = $1; 17792b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1780270c49a0SJoe Perches $in_commit_log = 0; 17813bf9a009SRabin Vincent } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1782773647a0SAndy Whitcroft $realfile = $1; 17832b7ab453SJoe Perches $realfile =~ s@^([^/]*)/@@ if (!$file); 1784270c49a0SJoe Perches $in_commit_log = 0; 17851e855726SWolfram Sang 17861e855726SWolfram Sang $p1_prefix = $1; 1787e2f7aa4bSAndy Whitcroft if (!$file && $tree && $p1_prefix ne '' && 1788e2f7aa4bSAndy Whitcroft -e "$root/$p1_prefix") { 1789000d1cc1SJoe Perches WARN("PATCH_PREFIX", 1790000d1cc1SJoe Perches "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 17911e855726SWolfram Sang } 1792773647a0SAndy Whitcroft 1793c1ab3326SAndy Whitcroft if ($realfile =~ m@^include/asm/@) { 1794000d1cc1SJoe Perches ERROR("MODIFIED_INCLUDE_ASM", 1795000d1cc1SJoe Perches "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 1796773647a0SAndy Whitcroft } 1797773647a0SAndy Whitcroft next; 1798773647a0SAndy Whitcroft } 1799773647a0SAndy Whitcroft 1800389834b6SRandy Dunlap $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 18010a920b5bSAndy Whitcroft 1802c2fdda0dSAndy Whitcroft my $hereline = "$here\n$rawline\n"; 1803c2fdda0dSAndy Whitcroft my $herecurr = "$here\n$rawline\n"; 1804c2fdda0dSAndy Whitcroft my $hereprev = "$here\n$prevrawline\n$rawline\n"; 18050a920b5bSAndy Whitcroft 18066c72ffaaSAndy Whitcroft $cnt_lines++ if ($realcnt != 0); 18076c72ffaaSAndy Whitcroft 18083bf9a009SRabin Vincent# Check for incorrect file permissions 18093bf9a009SRabin Vincent if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 18103bf9a009SRabin Vincent my $permhere = $here . "FILE: $realfile\n"; 181104db4d25SJoe Perches if ($realfile !~ m@scripts/@ && 181204db4d25SJoe Perches $realfile !~ /\.(py|pl|awk|sh)$/) { 1813000d1cc1SJoe Perches ERROR("EXECUTE_PERMISSIONS", 1814000d1cc1SJoe Perches "do not set execute permissions for source files\n" . $permhere); 18153bf9a009SRabin Vincent } 18163bf9a009SRabin Vincent } 18173bf9a009SRabin Vincent 181820112475SJoe Perches# Check the patch for a signoff: 1819d8aaf121SAndy Whitcroft if ($line =~ /^\s*signed-off-by:/i) { 18204a0df2efSAndy Whitcroft $signoff++; 182115662b3eSJoe Perches $in_commit_log = 0; 18220a920b5bSAndy Whitcroft } 182320112475SJoe Perches 182420112475SJoe Perches# Check signature styles 1825270c49a0SJoe Perches if (!$in_header_lines && 1826ce0338dfSJoe Perches $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 182720112475SJoe Perches my $space_before = $1; 182820112475SJoe Perches my $sign_off = $2; 182920112475SJoe Perches my $space_after = $3; 183020112475SJoe Perches my $email = $4; 183120112475SJoe Perches my $ucfirst_sign_off = ucfirst(lc($sign_off)); 183220112475SJoe Perches 1833ce0338dfSJoe Perches if ($sign_off !~ /$signature_tags/) { 1834ce0338dfSJoe Perches WARN("BAD_SIGN_OFF", 1835ce0338dfSJoe Perches "Non-standard signature: $sign_off\n" . $herecurr); 1836ce0338dfSJoe Perches } 183720112475SJoe Perches if (defined $space_before && $space_before ne "") { 18383705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18393705ce5bSJoe Perches "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 18403705ce5bSJoe Perches $fix) { 18413705ce5bSJoe Perches $fixed[$linenr - 1] = 18423705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18433705ce5bSJoe Perches } 184420112475SJoe Perches } 184520112475SJoe Perches if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 18463705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18473705ce5bSJoe Perches "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 18483705ce5bSJoe Perches $fix) { 18493705ce5bSJoe Perches $fixed[$linenr - 1] = 18503705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18513705ce5bSJoe Perches } 18523705ce5bSJoe Perches 185320112475SJoe Perches } 185420112475SJoe Perches if (!defined $space_after || $space_after ne " ") { 18553705ce5bSJoe Perches if (WARN("BAD_SIGN_OFF", 18563705ce5bSJoe Perches "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 18573705ce5bSJoe Perches $fix) { 18583705ce5bSJoe Perches $fixed[$linenr - 1] = 18593705ce5bSJoe Perches "$ucfirst_sign_off $email"; 18603705ce5bSJoe Perches } 186120112475SJoe Perches } 186220112475SJoe Perches 186320112475SJoe Perches my ($email_name, $email_address, $comment) = parse_email($email); 186420112475SJoe Perches my $suggested_email = format_email(($email_name, $email_address)); 186520112475SJoe Perches if ($suggested_email eq "") { 1866000d1cc1SJoe Perches ERROR("BAD_SIGN_OFF", 1867000d1cc1SJoe Perches "Unrecognized email address: '$email'\n" . $herecurr); 186820112475SJoe Perches } else { 186920112475SJoe Perches my $dequoted = $suggested_email; 187020112475SJoe Perches $dequoted =~ s/^"//; 187120112475SJoe Perches $dequoted =~ s/" </ </; 187220112475SJoe Perches # Don't force email to have quotes 187320112475SJoe Perches # Allow just an angle bracketed address 187420112475SJoe Perches if ("$dequoted$comment" ne $email && 187520112475SJoe Perches "<$email_address>$comment" ne $email && 187620112475SJoe Perches "$suggested_email$comment" ne $email) { 1877000d1cc1SJoe Perches WARN("BAD_SIGN_OFF", 1878000d1cc1SJoe Perches "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); 187920112475SJoe Perches } 18800a920b5bSAndy Whitcroft } 18817e51f197SJoe Perches 18827e51f197SJoe Perches# Check for duplicate signatures 18837e51f197SJoe Perches my $sig_nospace = $line; 18847e51f197SJoe Perches $sig_nospace =~ s/\s//g; 18857e51f197SJoe Perches $sig_nospace = lc($sig_nospace); 18867e51f197SJoe Perches if (defined $signatures{$sig_nospace}) { 18877e51f197SJoe Perches WARN("BAD_SIGN_OFF", 18887e51f197SJoe Perches "Duplicate signature\n" . $herecurr); 18897e51f197SJoe Perches } else { 18907e51f197SJoe Perches $signatures{$sig_nospace} = 1; 18917e51f197SJoe Perches } 18920a920b5bSAndy Whitcroft } 18930a920b5bSAndy Whitcroft 189400df344fSAndy Whitcroft# Check for wrappage within a valid hunk of the file 18958905a67cSAndy Whitcroft if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1896000d1cc1SJoe Perches ERROR("CORRUPTED_PATCH", 1897000d1cc1SJoe Perches "patch seems to be corrupt (line wrapped?)\n" . 18986c72ffaaSAndy Whitcroft $herecurr) if (!$emitted_corrupt++); 1899de7d4f0eSAndy Whitcroft } 1900de7d4f0eSAndy Whitcroft 19016ecd9674SAndy Whitcroft# Check for absolute kernel paths. 19026ecd9674SAndy Whitcroft if ($tree) { 19036ecd9674SAndy Whitcroft while ($line =~ m{(?:^|\s)(/\S*)}g) { 19046ecd9674SAndy Whitcroft my $file = $1; 19056ecd9674SAndy Whitcroft 19066ecd9674SAndy Whitcroft if ($file =~ m{^(.*?)(?::\d+)+:?$} && 19076ecd9674SAndy Whitcroft check_absolute_file($1, $herecurr)) { 19086ecd9674SAndy Whitcroft # 19096ecd9674SAndy Whitcroft } else { 19106ecd9674SAndy Whitcroft check_absolute_file($file, $herecurr); 19116ecd9674SAndy Whitcroft } 19126ecd9674SAndy Whitcroft } 19136ecd9674SAndy Whitcroft } 19146ecd9674SAndy Whitcroft 1915de7d4f0eSAndy Whitcroft# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1916de7d4f0eSAndy Whitcroft if (($realfile =~ /^$/ || $line =~ /^\+/) && 1917171ae1a4SAndy Whitcroft $rawline !~ m/^$UTF8*$/) { 1918171ae1a4SAndy Whitcroft my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1919171ae1a4SAndy Whitcroft 1920171ae1a4SAndy Whitcroft my $blank = copy_spacing($rawline); 1921171ae1a4SAndy Whitcroft my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1922171ae1a4SAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 1923171ae1a4SAndy Whitcroft 192434d99219SJoe Perches CHK("INVALID_UTF8", 1925000d1cc1SJoe Perches "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 192600df344fSAndy Whitcroft } 19270a920b5bSAndy Whitcroft 192815662b3eSJoe Perches# Check if it's the start of a commit log 192915662b3eSJoe Perches# (not a header line and we haven't seen the patch filename) 193015662b3eSJoe Perches if ($in_header_lines && $realfile =~ /^$/ && 1931270c49a0SJoe Perches $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { 193215662b3eSJoe Perches $in_header_lines = 0; 193315662b3eSJoe Perches $in_commit_log = 1; 193415662b3eSJoe Perches } 193515662b3eSJoe Perches 1936fa64205dSPasi Savanainen# Check if there is UTF-8 in a commit log when a mail header has explicitly 1937fa64205dSPasi Savanainen# declined it, i.e defined some charset where it is missing. 1938fa64205dSPasi Savanainen if ($in_header_lines && 1939fa64205dSPasi Savanainen $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1940fa64205dSPasi Savanainen $1 !~ /utf-8/i) { 1941fa64205dSPasi Savanainen $non_utf8_charset = 1; 1942fa64205dSPasi Savanainen } 1943fa64205dSPasi Savanainen 1944fa64205dSPasi Savanainen if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 194515662b3eSJoe Perches $rawline =~ /$NON_ASCII_UTF8/) { 1946fa64205dSPasi Savanainen WARN("UTF8_BEFORE_PATCH", 194715662b3eSJoe Perches "8-bit UTF-8 used in possible commit log\n" . $herecurr); 194815662b3eSJoe Perches } 194915662b3eSJoe Perches 195030670854SAndy Whitcroft# ignore non-hunk lines and lines being removed 195130670854SAndy Whitcroft next if (!$hunk_line || $line =~ /^-/); 195200df344fSAndy Whitcroft 19530a920b5bSAndy Whitcroft#trailing whitespace 19549c0ca6f9SAndy Whitcroft if ($line =~ /^\+.*\015/) { 1955c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1956d5e616fcSJoe Perches if (ERROR("DOS_LINE_ENDINGS", 1957d5e616fcSJoe Perches "DOS line endings\n" . $herevet) && 1958d5e616fcSJoe Perches $fix) { 1959d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/[\s\015]+$//; 1960d5e616fcSJoe Perches } 1961c2fdda0dSAndy Whitcroft } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1962c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 19633705ce5bSJoe Perches if (ERROR("TRAILING_WHITESPACE", 19643705ce5bSJoe Perches "trailing whitespace\n" . $herevet) && 19653705ce5bSJoe Perches $fix) { 1966d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 19673705ce5bSJoe Perches } 19683705ce5bSJoe Perches 1969d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 19700a920b5bSAndy Whitcroft } 19715368df20SAndy Whitcroft 19724783f894SJosh Triplett# Check for FSF mailing addresses. 19734783f894SJosh Triplett if ($rawline =~ /You should have received a copy/ || 19744783f894SJosh Triplett $rawline =~ /write to the Free Software/ || 19754783f894SJosh Triplett $rawline =~ /59 Temple Place/ || 19764783f894SJosh Triplett $rawline =~ /51 Franklin Street/) { 19774783f894SJosh Triplett my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 19784783f894SJosh Triplett my $msg_type = \&ERROR; 19794783f894SJosh Triplett $msg_type = \&CHK if ($file); 19804783f894SJosh Triplett &{$msg_type}("FSF_MAILING_ADDRESS", 19814783f894SJosh 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) 19824783f894SJosh Triplett } 19834783f894SJosh Triplett 19843354957aSAndi Kleen# check for Kconfig help text having a real description 19859fe287d7SAndy Whitcroft# Only applies when adding the entry originally, after that we do not have 19869fe287d7SAndy Whitcroft# sufficient context to determine whether it is indeed long enough. 19873354957aSAndi Kleen if ($realfile =~ /Kconfig/ && 1988a1385803SAndy Whitcroft $line =~ /.\s*config\s+/) { 19893354957aSAndi Kleen my $length = 0; 19909fe287d7SAndy Whitcroft my $cnt = $realcnt; 19919fe287d7SAndy Whitcroft my $ln = $linenr + 1; 19929fe287d7SAndy Whitcroft my $f; 1993a1385803SAndy Whitcroft my $is_start = 0; 19949fe287d7SAndy Whitcroft my $is_end = 0; 1995a1385803SAndy Whitcroft for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 19969fe287d7SAndy Whitcroft $f = $lines[$ln - 1]; 19979fe287d7SAndy Whitcroft $cnt-- if ($lines[$ln - 1] !~ /^-/); 19989fe287d7SAndy Whitcroft $is_end = $lines[$ln - 1] =~ /^\+/; 19999fe287d7SAndy Whitcroft 20009fe287d7SAndy Whitcroft next if ($f =~ /^-/); 2001a1385803SAndy Whitcroft 2002a1385803SAndy Whitcroft if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { 2003a1385803SAndy Whitcroft $is_start = 1; 2004a1385803SAndy Whitcroft } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { 2005a1385803SAndy Whitcroft $length = -1; 2006a1385803SAndy Whitcroft } 2007a1385803SAndy Whitcroft 20089fe287d7SAndy Whitcroft $f =~ s/^.//; 20093354957aSAndi Kleen $f =~ s/#.*//; 20103354957aSAndi Kleen $f =~ s/^\s+//; 20113354957aSAndi Kleen next if ($f =~ /^$/); 20129fe287d7SAndy Whitcroft if ($f =~ /^\s*config\s/) { 20139fe287d7SAndy Whitcroft $is_end = 1; 20149fe287d7SAndy Whitcroft last; 20159fe287d7SAndy Whitcroft } 20163354957aSAndi Kleen $length++; 20173354957aSAndi Kleen } 2018000d1cc1SJoe Perches WARN("CONFIG_DESCRIPTION", 2019a1385803SAndy Whitcroft "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); 2020a1385803SAndy Whitcroft #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 20213354957aSAndi Kleen } 20223354957aSAndi Kleen 20231ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig. 20241ba8dfd1SKees Cook if ($realfile =~ /Kconfig/ && 20251ba8dfd1SKees Cook $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) { 20261ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 20271ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 20281ba8dfd1SKees Cook } 20291ba8dfd1SKees Cook 2030c68e5878SArnaud Lacombe if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 2031c68e5878SArnaud Lacombe ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 2032c68e5878SArnaud Lacombe my $flag = $1; 2033c68e5878SArnaud Lacombe my $replacement = { 2034c68e5878SArnaud Lacombe 'EXTRA_AFLAGS' => 'asflags-y', 2035c68e5878SArnaud Lacombe 'EXTRA_CFLAGS' => 'ccflags-y', 2036c68e5878SArnaud Lacombe 'EXTRA_CPPFLAGS' => 'cppflags-y', 2037c68e5878SArnaud Lacombe 'EXTRA_LDFLAGS' => 'ldflags-y', 2038c68e5878SArnaud Lacombe }; 2039c68e5878SArnaud Lacombe 2040c68e5878SArnaud Lacombe WARN("DEPRECATED_VARIABLE", 2041c68e5878SArnaud Lacombe "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 2042c68e5878SArnaud Lacombe } 2043c68e5878SArnaud Lacombe 20445368df20SAndy Whitcroft# check we are in a valid source file if not then ignore this hunk 20455368df20SAndy Whitcroft next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); 20465368df20SAndy Whitcroft 20476cd7f386SJoe Perches#line length limit 2048c45dcabdSAndy Whitcroft if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && 2049f4c014c0SAndy Whitcroft $rawline !~ /^.\s*\*\s*\@$Ident\s/ && 20500fccc622SJoe Perches !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || 20518bbea968SJoe Perches $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 20526cd7f386SJoe Perches $length > $max_line_length) 2053c45dcabdSAndy Whitcroft { 2054000d1cc1SJoe Perches WARN("LONG_LINE", 20556cd7f386SJoe Perches "line over $max_line_length characters\n" . $herecurr); 20560a920b5bSAndy Whitcroft } 20570a920b5bSAndy Whitcroft 2058ca56dc09SJosh Triplett# Check for user-visible strings broken across lines, which breaks the ability 20598c5fcd24SJoe Perches# to grep for the string. Make exceptions when the previous string ends in a 20608c5fcd24SJoe Perches# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 20618c5fcd24SJoe Perches# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 2062ca56dc09SJosh Triplett if ($line =~ /^\+\s*"/ && 2063ca56dc09SJosh Triplett $prevline =~ /"\s*$/ && 20648c5fcd24SJoe Perches $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 2065ca56dc09SJosh Triplett WARN("SPLIT_STRING", 2066ca56dc09SJosh Triplett "quoted string split across lines\n" . $hereprev); 2067ca56dc09SJosh Triplett } 2068ca56dc09SJosh Triplett 20695e79d96eSJoe Perches# check for spaces before a quoted newline 20705e79d96eSJoe Perches if ($rawline =~ /^.*\".*\s\\n/) { 20713705ce5bSJoe Perches if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 20723705ce5bSJoe Perches "unnecessary whitespace before a quoted newline\n" . $herecurr) && 20733705ce5bSJoe Perches $fix) { 20743705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 20753705ce5bSJoe Perches } 20763705ce5bSJoe Perches 20775e79d96eSJoe Perches } 20785e79d96eSJoe Perches 20798905a67cSAndy Whitcroft# check for adding lines without a newline. 20808905a67cSAndy Whitcroft if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 2081000d1cc1SJoe Perches WARN("MISSING_EOF_NEWLINE", 2082000d1cc1SJoe Perches "adding a line without newline at end of file\n" . $herecurr); 20838905a67cSAndy Whitcroft } 20848905a67cSAndy Whitcroft 208542e41c54SMike Frysinger# Blackfin: use hi/lo macros 208642e41c54SMike Frysinger if ($realfile =~ m@arch/blackfin/.*\.S$@) { 208742e41c54SMike Frysinger if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { 208842e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2089000d1cc1SJoe Perches ERROR("LO_MACRO", 2090000d1cc1SJoe Perches "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); 209142e41c54SMike Frysinger } 209242e41c54SMike Frysinger if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { 209342e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2094000d1cc1SJoe Perches ERROR("HI_MACRO", 2095000d1cc1SJoe Perches "use the HI() macro, not (... >> 16)\n" . $herevet); 209642e41c54SMike Frysinger } 209742e41c54SMike Frysinger } 209842e41c54SMike Frysinger 2099b9ea10d6SAndy Whitcroft# check we are in a valid source file C or perl if not then ignore this hunk 2100b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c|pl)$/); 21010a920b5bSAndy Whitcroft 21020a920b5bSAndy Whitcroft# at the beginning of a line any tabs must come first and anything 21030a920b5bSAndy Whitcroft# more than 8 must use tabs. 2104c2fdda0dSAndy Whitcroft if ($rawline =~ /^\+\s* \t\s*\S/ || 2105c2fdda0dSAndy Whitcroft $rawline =~ /^\+\s* \s*/) { 2106c2fdda0dSAndy Whitcroft my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 2107d2c0a235SAndy Whitcroft $rpt_cleaners = 1; 21083705ce5bSJoe Perches if (ERROR("CODE_INDENT", 21093705ce5bSJoe Perches "code indent should use tabs where possible\n" . $herevet) && 21103705ce5bSJoe Perches $fix) { 21113705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 21123705ce5bSJoe Perches } 21130a920b5bSAndy Whitcroft } 21140a920b5bSAndy Whitcroft 211508e44365SAlberto Panizzo# check for space before tabs. 211608e44365SAlberto Panizzo if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 211708e44365SAlberto Panizzo my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 21183705ce5bSJoe Perches if (WARN("SPACE_BEFORE_TAB", 21193705ce5bSJoe Perches "please, no space before tabs\n" . $herevet) && 21203705ce5bSJoe Perches $fix) { 21213705ce5bSJoe Perches $fixed[$linenr - 1] =~ 21223705ce5bSJoe Perches s/(^\+.*) +\t/$1\t/; 21233705ce5bSJoe Perches } 212408e44365SAlberto Panizzo } 212508e44365SAlberto Panizzo 2126d1fe9c09SJoe Perches# check for && or || at the start of a line 2127d1fe9c09SJoe Perches if ($rawline =~ /^\+\s*(&&|\|\|)/) { 2128d1fe9c09SJoe Perches CHK("LOGICAL_CONTINUATIONS", 2129d1fe9c09SJoe Perches "Logical continuations should be on the previous line\n" . $hereprev); 2130d1fe9c09SJoe Perches } 2131d1fe9c09SJoe Perches 2132d1fe9c09SJoe Perches# check multi-line statement indentation matches previous line 2133d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 2134d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) { 2135d1fe9c09SJoe Perches $prevline =~ /^\+(\t*)(.*)$/; 2136d1fe9c09SJoe Perches my $oldindent = $1; 2137d1fe9c09SJoe Perches my $rest = $2; 2138d1fe9c09SJoe Perches 2139d1fe9c09SJoe Perches my $pos = pos_last_openparen($rest); 2140d1fe9c09SJoe Perches if ($pos >= 0) { 2141b34a26f3SJoe Perches $line =~ /^(\+| )([ \t]*)/; 2142b34a26f3SJoe Perches my $newindent = $2; 2143d1fe9c09SJoe Perches 2144d1fe9c09SJoe Perches my $goodtabindent = $oldindent . 2145d1fe9c09SJoe Perches "\t" x ($pos / 8) . 2146d1fe9c09SJoe Perches " " x ($pos % 8); 2147d1fe9c09SJoe Perches my $goodspaceindent = $oldindent . " " x $pos; 2148d1fe9c09SJoe Perches 2149d1fe9c09SJoe Perches if ($newindent ne $goodtabindent && 2150d1fe9c09SJoe Perches $newindent ne $goodspaceindent) { 21513705ce5bSJoe Perches 21523705ce5bSJoe Perches if (CHK("PARENTHESIS_ALIGNMENT", 21533705ce5bSJoe Perches "Alignment should match open parenthesis\n" . $hereprev) && 21543705ce5bSJoe Perches $fix && $line =~ /^\+/) { 21553705ce5bSJoe Perches $fixed[$linenr - 1] =~ 21563705ce5bSJoe Perches s/^\+[ \t]*/\+$goodtabindent/; 21573705ce5bSJoe Perches } 2158d1fe9c09SJoe Perches } 2159d1fe9c09SJoe Perches } 2160d1fe9c09SJoe Perches } 2161d1fe9c09SJoe Perches 216223f780c9SJoe Perches if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) { 21633705ce5bSJoe Perches if (CHK("SPACING", 21643705ce5bSJoe Perches "No space is necessary after a cast\n" . $hereprev) && 21653705ce5bSJoe Perches $fix) { 21663705ce5bSJoe Perches $fixed[$linenr - 1] =~ 21673705ce5bSJoe Perches s/^(\+.*\*[ \t]*\))[ \t]+/$1/; 21683705ce5bSJoe Perches } 2169aad4f614SJoe Perches } 2170aad4f614SJoe Perches 217105880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2172fdb4bcd6SJoe Perches $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 2173fdb4bcd6SJoe Perches $rawline =~ /^\+[ \t]*\*/) { 217405880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 217505880600SJoe Perches "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 217605880600SJoe Perches } 217705880600SJoe Perches 217805880600SJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2179a605e32eSJoe Perches $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /* 2180a605e32eSJoe Perches $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 218161135e96SJoe Perches $rawline =~ /^\+/ && #line is new 2182a605e32eSJoe Perches $rawline !~ /^\+[ \t]*\*/) { #no leading * 2183a605e32eSJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 2184a605e32eSJoe Perches "networking block comments start with * on subsequent lines\n" . $hereprev); 2185a605e32eSJoe Perches } 2186a605e32eSJoe Perches 2187a605e32eSJoe Perches if ($realfile =~ m@^(drivers/net/|net/)@ && 2188c24f9f19SJoe Perches $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 2189c24f9f19SJoe Perches $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 2190c24f9f19SJoe Perches $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 2191c24f9f19SJoe Perches $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 219205880600SJoe Perches WARN("NETWORKING_BLOCK_COMMENT_STYLE", 219305880600SJoe Perches "networking block comments put the trailing */ on a separate line\n" . $herecurr); 219405880600SJoe Perches } 219505880600SJoe Perches 21965f7ddae6SRaffaele Recalcati# check for spaces at the beginning of a line. 21976b4c5bebSAndy Whitcroft# Exceptions: 21986b4c5bebSAndy Whitcroft# 1) within comments 21996b4c5bebSAndy Whitcroft# 2) indented preprocessor commands 22006b4c5bebSAndy Whitcroft# 3) hanging labels 22013705ce5bSJoe Perches if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 22025f7ddae6SRaffaele Recalcati my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 22033705ce5bSJoe Perches if (WARN("LEADING_SPACE", 22043705ce5bSJoe Perches "please, no spaces at the start of a line\n" . $herevet) && 22053705ce5bSJoe Perches $fix) { 22063705ce5bSJoe Perches $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 22073705ce5bSJoe Perches } 22085f7ddae6SRaffaele Recalcati } 22095f7ddae6SRaffaele Recalcati 2210b9ea10d6SAndy Whitcroft# check we are in a valid C source file if not then ignore this hunk 2211b9ea10d6SAndy Whitcroft next if ($realfile !~ /\.(h|c)$/); 2212b9ea10d6SAndy Whitcroft 22131ba8dfd1SKees Cook# discourage the addition of CONFIG_EXPERIMENTAL in #if(def). 22141ba8dfd1SKees Cook if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) { 22151ba8dfd1SKees Cook WARN("CONFIG_EXPERIMENTAL", 22161ba8dfd1SKees Cook "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n"); 22171ba8dfd1SKees Cook } 22181ba8dfd1SKees Cook 2219c2fdda0dSAndy Whitcroft# check for RCS/CVS revision markers 2220cf655043SAndy Whitcroft if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 2221000d1cc1SJoe Perches WARN("CVS_KEYWORD", 2222000d1cc1SJoe Perches "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 2223c2fdda0dSAndy Whitcroft } 222422f2a2efSAndy Whitcroft 222542e41c54SMike Frysinger# Blackfin: don't use __builtin_bfin_[cs]sync 222642e41c54SMike Frysinger if ($line =~ /__builtin_bfin_csync/) { 222742e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2228000d1cc1SJoe Perches ERROR("CSYNC", 2229000d1cc1SJoe Perches "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); 223042e41c54SMike Frysinger } 223142e41c54SMike Frysinger if ($line =~ /__builtin_bfin_ssync/) { 223242e41c54SMike Frysinger my $herevet = "$here\n" . cat_vet($line) . "\n"; 2233000d1cc1SJoe Perches ERROR("SSYNC", 2234000d1cc1SJoe Perches "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); 223542e41c54SMike Frysinger } 223642e41c54SMike Frysinger 223756e77d70SJoe Perches# check for old HOTPLUG __dev<foo> section markings 223856e77d70SJoe Perches if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 223956e77d70SJoe Perches WARN("HOTPLUG_SECTION", 224056e77d70SJoe Perches "Using $1 is unnecessary\n" . $herecurr); 224156e77d70SJoe Perches } 224256e77d70SJoe Perches 22439c0ca6f9SAndy Whitcroft# Check for potential 'bare' types 22442b474a1aSAndy Whitcroft my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 22452b474a1aSAndy Whitcroft $realline_next); 22463e469cdcSAndy Whitcroft#print "LINE<$line>\n"; 22473e469cdcSAndy Whitcroft if ($linenr >= $suppress_statement && 22481b5539b1SJoe Perches $realcnt && $sline =~ /.\s*\S/) { 2249170d3a22SAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 2250f5fe35ddSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 2251171ae1a4SAndy Whitcroft $stat =~ s/\n./\n /g; 2252171ae1a4SAndy Whitcroft $cond =~ s/\n./\n /g; 2253171ae1a4SAndy Whitcroft 22543e469cdcSAndy Whitcroft#print "linenr<$linenr> <$stat>\n"; 22553e469cdcSAndy Whitcroft # If this statement has no statement boundaries within 22563e469cdcSAndy Whitcroft # it there is no point in retrying a statement scan 22573e469cdcSAndy Whitcroft # until we hit end of it. 22583e469cdcSAndy Whitcroft my $frag = $stat; $frag =~ s/;+\s*$//; 22593e469cdcSAndy Whitcroft if ($frag !~ /(?:{|;)/) { 22603e469cdcSAndy Whitcroft#print "skip<$line_nr_next>\n"; 22613e469cdcSAndy Whitcroft $suppress_statement = $line_nr_next; 22623e469cdcSAndy Whitcroft } 2263f74bd194SAndy Whitcroft 22642b474a1aSAndy Whitcroft # Find the real next line. 22652b474a1aSAndy Whitcroft $realline_next = $line_nr_next; 22662b474a1aSAndy Whitcroft if (defined $realline_next && 22672b474a1aSAndy Whitcroft (!defined $lines[$realline_next - 1] || 22682b474a1aSAndy Whitcroft substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 22692b474a1aSAndy Whitcroft $realline_next++; 22702b474a1aSAndy Whitcroft } 22712b474a1aSAndy Whitcroft 2272171ae1a4SAndy Whitcroft my $s = $stat; 2273171ae1a4SAndy Whitcroft $s =~ s/{.*$//s; 2274cf655043SAndy Whitcroft 2275c2fdda0dSAndy Whitcroft # Ignore goto labels. 2276171ae1a4SAndy Whitcroft if ($s =~ /$Ident:\*$/s) { 2277c2fdda0dSAndy Whitcroft 2278c2fdda0dSAndy Whitcroft # Ignore functions being called 2279171ae1a4SAndy Whitcroft } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 2280c2fdda0dSAndy Whitcroft 2281463f2864SAndy Whitcroft } elsif ($s =~ /^.\s*else\b/s) { 2282463f2864SAndy Whitcroft 2283c45dcabdSAndy Whitcroft # declarations always start with types 2284d2506586SAndy 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) { 2285c45dcabdSAndy Whitcroft my $type = $1; 2286c45dcabdSAndy Whitcroft $type =~ s/\s+/ /g; 2287c45dcabdSAndy Whitcroft possible($type, "A:" . $s); 2288c45dcabdSAndy Whitcroft 22896c72ffaaSAndy Whitcroft # definitions in global scope can only start with types 2290a6a84062SAndy Whitcroft } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 2291c45dcabdSAndy Whitcroft possible($1, "B:" . $s); 2292c2fdda0dSAndy Whitcroft } 22938905a67cSAndy Whitcroft 22946c72ffaaSAndy Whitcroft # any (foo ... *) is a pointer cast, and foo is a type 229565863862SAndy Whitcroft while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 2296c45dcabdSAndy Whitcroft possible($1, "C:" . $s); 22979c0ca6f9SAndy Whitcroft } 22988905a67cSAndy Whitcroft 22998905a67cSAndy Whitcroft # Check for any sort of function declaration. 23008905a67cSAndy Whitcroft # int foo(something bar, other baz); 23018905a67cSAndy Whitcroft # void (*store_gdt)(x86_descr_ptr *); 2302171ae1a4SAndy Whitcroft if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 23038905a67cSAndy Whitcroft my ($name_len) = length($1); 23048905a67cSAndy Whitcroft 2305cf655043SAndy Whitcroft my $ctx = $s; 2306773647a0SAndy Whitcroft substr($ctx, 0, $name_len + 1, ''); 23078905a67cSAndy Whitcroft $ctx =~ s/\)[^\)]*$//; 2308cf655043SAndy Whitcroft 23098905a67cSAndy Whitcroft for my $arg (split(/\s*,\s*/, $ctx)) { 2310c45dcabdSAndy Whitcroft if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 23118905a67cSAndy Whitcroft 2312c45dcabdSAndy Whitcroft possible($1, "D:" . $s); 23138905a67cSAndy Whitcroft } 23148905a67cSAndy Whitcroft } 23158905a67cSAndy Whitcroft } 23168905a67cSAndy Whitcroft 23179c0ca6f9SAndy Whitcroft } 23189c0ca6f9SAndy Whitcroft 231900df344fSAndy Whitcroft# 232000df344fSAndy Whitcroft# Checks which may be anchored in the context. 232100df344fSAndy Whitcroft# 232200df344fSAndy Whitcroft 232300df344fSAndy Whitcroft# Check for switch () and associated case and default 232400df344fSAndy Whitcroft# statements should be at the same indent. 232500df344fSAndy Whitcroft if ($line=~/\bswitch\s*\(.*\)/) { 232600df344fSAndy Whitcroft my $err = ''; 232700df344fSAndy Whitcroft my $sep = ''; 232800df344fSAndy Whitcroft my @ctx = ctx_block_outer($linenr, $realcnt); 232900df344fSAndy Whitcroft shift(@ctx); 233000df344fSAndy Whitcroft for my $ctx (@ctx) { 233100df344fSAndy Whitcroft my ($clen, $cindent) = line_stats($ctx); 233200df344fSAndy Whitcroft if ($ctx =~ /^\+\s*(case\s+|default:)/ && 233300df344fSAndy Whitcroft $indent != $cindent) { 233400df344fSAndy Whitcroft $err .= "$sep$ctx\n"; 233500df344fSAndy Whitcroft $sep = ''; 233600df344fSAndy Whitcroft } else { 233700df344fSAndy Whitcroft $sep = "[...]\n"; 233800df344fSAndy Whitcroft } 233900df344fSAndy Whitcroft } 234000df344fSAndy Whitcroft if ($err ne '') { 2341000d1cc1SJoe Perches ERROR("SWITCH_CASE_INDENT_LEVEL", 2342000d1cc1SJoe Perches "switch and case should be at the same indent\n$hereline$err"); 2343de7d4f0eSAndy Whitcroft } 2344de7d4f0eSAndy Whitcroft } 2345de7d4f0eSAndy Whitcroft 2346de7d4f0eSAndy Whitcroft# if/while/etc brace do not go on next line, unless defining a do while loop, 2347de7d4f0eSAndy Whitcroft# or if that brace on the next line is for something else 2348c45dcabdSAndy Whitcroft if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 2349773647a0SAndy Whitcroft my $pre_ctx = "$1$2"; 2350773647a0SAndy Whitcroft 23519c0ca6f9SAndy Whitcroft my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 23528eef05ddSJoe Perches 23538eef05ddSJoe Perches if ($line =~ /^\+\t{6,}/) { 23548eef05ddSJoe Perches WARN("DEEP_INDENTATION", 23558eef05ddSJoe Perches "Too many leading tabs - consider code refactoring\n" . $herecurr); 23568eef05ddSJoe Perches } 23578eef05ddSJoe Perches 2358de7d4f0eSAndy Whitcroft my $ctx_cnt = $realcnt - $#ctx - 1; 2359de7d4f0eSAndy Whitcroft my $ctx = join("\n", @ctx); 2360de7d4f0eSAndy Whitcroft 2361548596d5SAndy Whitcroft my $ctx_ln = $linenr; 2362548596d5SAndy Whitcroft my $ctx_skip = $realcnt; 2363de7d4f0eSAndy Whitcroft 2364548596d5SAndy Whitcroft while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 2365548596d5SAndy Whitcroft defined $lines[$ctx_ln - 1] && 2366548596d5SAndy Whitcroft $lines[$ctx_ln - 1] =~ /^-/)) { 2367548596d5SAndy Whitcroft ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 2368548596d5SAndy Whitcroft $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 2369773647a0SAndy Whitcroft $ctx_ln++; 2370773647a0SAndy Whitcroft } 2371548596d5SAndy Whitcroft 237253210168SAndy Whitcroft #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 237353210168SAndy Whitcroft #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 2374773647a0SAndy Whitcroft 2375773647a0SAndy Whitcroft if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 2376000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2377000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . 237801464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 237900df344fSAndy Whitcroft } 2380773647a0SAndy Whitcroft if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 2381773647a0SAndy Whitcroft $ctx =~ /\)\s*\;\s*$/ && 2382773647a0SAndy Whitcroft defined $lines[$ctx_ln - 1]) 2383773647a0SAndy Whitcroft { 23849c0ca6f9SAndy Whitcroft my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 23859c0ca6f9SAndy Whitcroft if ($nindent > $indent) { 2386000d1cc1SJoe Perches WARN("TRAILING_SEMICOLON", 2387000d1cc1SJoe Perches "trailing semicolon indicates no statements, indent implies otherwise\n" . 238801464f30SAndy Whitcroft "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 23899c0ca6f9SAndy Whitcroft } 23909c0ca6f9SAndy Whitcroft } 239100df344fSAndy Whitcroft } 239200df344fSAndy Whitcroft 23934d001e4dSAndy Whitcroft# Check relative indent for conditionals and blocks. 23944d001e4dSAndy Whitcroft if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 23953e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 23963e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 23973e469cdcSAndy Whitcroft if (!defined $stat); 23984d001e4dSAndy Whitcroft my ($s, $c) = ($stat, $cond); 23994d001e4dSAndy Whitcroft 24004d001e4dSAndy Whitcroft substr($s, 0, length($c), ''); 24014d001e4dSAndy Whitcroft 24024d001e4dSAndy Whitcroft # Make sure we remove the line prefixes as we have 24034d001e4dSAndy Whitcroft # none on the first line, and are going to readd them 24044d001e4dSAndy Whitcroft # where necessary. 24054d001e4dSAndy Whitcroft $s =~ s/\n./\n/gs; 24064d001e4dSAndy Whitcroft 24074d001e4dSAndy Whitcroft # Find out how long the conditional actually is. 24086f779c18SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 24096f779c18SAndy Whitcroft my $cond_lines = 1 + $#newlines; 24104d001e4dSAndy Whitcroft 24114d001e4dSAndy Whitcroft # We want to check the first line inside the block 24124d001e4dSAndy Whitcroft # starting at the end of the conditional, so remove: 24134d001e4dSAndy Whitcroft # 1) any blank line termination 24144d001e4dSAndy Whitcroft # 2) any opening brace { on end of the line 24154d001e4dSAndy Whitcroft # 3) any do (...) { 24164d001e4dSAndy Whitcroft my $continuation = 0; 24174d001e4dSAndy Whitcroft my $check = 0; 24184d001e4dSAndy Whitcroft $s =~ s/^.*\bdo\b//; 24194d001e4dSAndy Whitcroft $s =~ s/^\s*{//; 24204d001e4dSAndy Whitcroft if ($s =~ s/^\s*\\//) { 24214d001e4dSAndy Whitcroft $continuation = 1; 24224d001e4dSAndy Whitcroft } 24239bd49efeSAndy Whitcroft if ($s =~ s/^\s*?\n//) { 24244d001e4dSAndy Whitcroft $check = 1; 24254d001e4dSAndy Whitcroft $cond_lines++; 24264d001e4dSAndy Whitcroft } 24274d001e4dSAndy Whitcroft 24284d001e4dSAndy Whitcroft # Also ignore a loop construct at the end of a 24294d001e4dSAndy Whitcroft # preprocessor statement. 24304d001e4dSAndy Whitcroft if (($prevline =~ /^.\s*#\s*define\s/ || 24314d001e4dSAndy Whitcroft $prevline =~ /\\\s*$/) && $continuation == 0) { 24324d001e4dSAndy Whitcroft $check = 0; 24334d001e4dSAndy Whitcroft } 24344d001e4dSAndy Whitcroft 24359bd49efeSAndy Whitcroft my $cond_ptr = -1; 2436740504c6SAndy Whitcroft $continuation = 0; 24379bd49efeSAndy Whitcroft while ($cond_ptr != $cond_lines) { 24389bd49efeSAndy Whitcroft $cond_ptr = $cond_lines; 24394d001e4dSAndy Whitcroft 2440f16fa28fSAndy Whitcroft # If we see an #else/#elif then the code 2441f16fa28fSAndy Whitcroft # is not linear. 2442f16fa28fSAndy Whitcroft if ($s =~ /^\s*\#\s*(?:else|elif)/) { 2443f16fa28fSAndy Whitcroft $check = 0; 2444f16fa28fSAndy Whitcroft } 2445f16fa28fSAndy Whitcroft 24469bd49efeSAndy Whitcroft # Ignore: 24479bd49efeSAndy Whitcroft # 1) blank lines, they should be at 0, 24489bd49efeSAndy Whitcroft # 2) preprocessor lines, and 24499bd49efeSAndy Whitcroft # 3) labels. 2450740504c6SAndy Whitcroft if ($continuation || 2451740504c6SAndy Whitcroft $s =~ /^\s*?\n/ || 24529bd49efeSAndy Whitcroft $s =~ /^\s*#\s*?/ || 24539bd49efeSAndy Whitcroft $s =~ /^\s*$Ident\s*:/) { 2454740504c6SAndy Whitcroft $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 245530dad6ebSAndy Whitcroft if ($s =~ s/^.*?\n//) { 24569bd49efeSAndy Whitcroft $cond_lines++; 24579bd49efeSAndy Whitcroft } 24584d001e4dSAndy Whitcroft } 245930dad6ebSAndy Whitcroft } 24604d001e4dSAndy Whitcroft 24614d001e4dSAndy Whitcroft my (undef, $sindent) = line_stats("+" . $s); 24624d001e4dSAndy Whitcroft my $stat_real = raw_line($linenr, $cond_lines); 24634d001e4dSAndy Whitcroft 24644d001e4dSAndy Whitcroft # Check if either of these lines are modified, else 24654d001e4dSAndy Whitcroft # this is not this patch's fault. 24664d001e4dSAndy Whitcroft if (!defined($stat_real) || 24674d001e4dSAndy Whitcroft $stat !~ /^\+/ && $stat_real !~ /^\+/) { 24684d001e4dSAndy Whitcroft $check = 0; 24694d001e4dSAndy Whitcroft } 24704d001e4dSAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 24714d001e4dSAndy Whitcroft $stat_real = "[...]\n$stat_real"; 24724d001e4dSAndy Whitcroft } 24734d001e4dSAndy Whitcroft 24749bd49efeSAndy 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"; 24754d001e4dSAndy Whitcroft 24764d001e4dSAndy Whitcroft if ($check && (($sindent % 8) != 0 || 24774d001e4dSAndy Whitcroft ($sindent <= $indent && $s ne ''))) { 2478000d1cc1SJoe Perches WARN("SUSPECT_CODE_INDENT", 2479000d1cc1SJoe Perches "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 24804d001e4dSAndy Whitcroft } 24814d001e4dSAndy Whitcroft } 24824d001e4dSAndy Whitcroft 24836c72ffaaSAndy Whitcroft # Track the 'values' across context and added lines. 24846c72ffaaSAndy Whitcroft my $opline = $line; $opline =~ s/^./ /; 24851f65f947SAndy Whitcroft my ($curr_values, $curr_vars) = 24861f65f947SAndy Whitcroft annotate_values($opline . "\n", $prev_values); 24876c72ffaaSAndy Whitcroft $curr_values = $prev_values . $curr_values; 2488c2fdda0dSAndy Whitcroft if ($dbg_values) { 2489c2fdda0dSAndy Whitcroft my $outline = $opline; $outline =~ s/\t/ /g; 2490cf655043SAndy Whitcroft print "$linenr > .$outline\n"; 2491cf655043SAndy Whitcroft print "$linenr > $curr_values\n"; 24921f65f947SAndy Whitcroft print "$linenr > $curr_vars\n"; 2493c2fdda0dSAndy Whitcroft } 24946c72ffaaSAndy Whitcroft $prev_values = substr($curr_values, -1); 24956c72ffaaSAndy Whitcroft 249600df344fSAndy Whitcroft#ignore lines not being added 24973705ce5bSJoe Perches next if ($line =~ /^[^\+]/); 249800df344fSAndy Whitcroft 2499653d4876SAndy Whitcroft# TEST: allow direct testing of the type matcher. 25007429c690SAndy Whitcroft if ($dbg_type) { 25017429c690SAndy Whitcroft if ($line =~ /^.\s*$Declare\s*$/) { 2502000d1cc1SJoe Perches ERROR("TEST_TYPE", 2503000d1cc1SJoe Perches "TEST: is type\n" . $herecurr); 25047429c690SAndy Whitcroft } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 2505000d1cc1SJoe Perches ERROR("TEST_NOT_TYPE", 2506000d1cc1SJoe Perches "TEST: is not type ($1 is)\n". $herecurr); 25077429c690SAndy Whitcroft } 2508653d4876SAndy Whitcroft next; 2509653d4876SAndy Whitcroft } 2510a1ef277eSAndy Whitcroft# TEST: allow direct testing of the attribute matcher. 2511a1ef277eSAndy Whitcroft if ($dbg_attr) { 25129360b0e5SAndy Whitcroft if ($line =~ /^.\s*$Modifier\s*$/) { 2513000d1cc1SJoe Perches ERROR("TEST_ATTR", 2514000d1cc1SJoe Perches "TEST: is attr\n" . $herecurr); 25159360b0e5SAndy Whitcroft } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 2516000d1cc1SJoe Perches ERROR("TEST_NOT_ATTR", 2517000d1cc1SJoe Perches "TEST: is not attr ($1 is)\n". $herecurr); 2518a1ef277eSAndy Whitcroft } 2519a1ef277eSAndy Whitcroft next; 2520a1ef277eSAndy Whitcroft } 2521653d4876SAndy Whitcroft 2522f0a594c1SAndy Whitcroft# check for initialisation to aggregates open brace on the next line 252399423c20SAndy Whitcroft if ($line =~ /^.\s*{/ && 252499423c20SAndy Whitcroft $prevline =~ /(?:^|[^=])=\s*$/) { 2525000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2526000d1cc1SJoe Perches "that open brace { should be on the previous line\n" . $hereprev); 2527f0a594c1SAndy Whitcroft } 2528f0a594c1SAndy Whitcroft 252900df344fSAndy Whitcroft# 253000df344fSAndy Whitcroft# Checks which are anchored on the added line. 253100df344fSAndy Whitcroft# 253200df344fSAndy Whitcroft 2533653d4876SAndy Whitcroft# check for malformed paths in #include statements (uses RAW line) 2534c45dcabdSAndy Whitcroft if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2535653d4876SAndy Whitcroft my $path = $1; 2536653d4876SAndy Whitcroft if ($path =~ m{//}) { 2537000d1cc1SJoe Perches ERROR("MALFORMED_INCLUDE", 2538495e9d84SJoe Perches "malformed #include filename\n" . $herecurr); 2539495e9d84SJoe Perches } 2540495e9d84SJoe Perches if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 2541495e9d84SJoe Perches ERROR("UAPI_INCLUDE", 2542495e9d84SJoe Perches "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 2543653d4876SAndy Whitcroft } 2544653d4876SAndy Whitcroft } 2545653d4876SAndy Whitcroft 254600df344fSAndy Whitcroft# no C99 // comments 254700df344fSAndy Whitcroft if ($line =~ m{//}) { 25483705ce5bSJoe Perches if (ERROR("C99_COMMENTS", 25493705ce5bSJoe Perches "do not use C99 // comments\n" . $herecurr) && 25503705ce5bSJoe Perches $fix) { 25513705ce5bSJoe Perches my $line = $fixed[$linenr - 1]; 25523705ce5bSJoe Perches if ($line =~ /\/\/(.*)$/) { 25533705ce5bSJoe Perches my $comment = trim($1); 25543705ce5bSJoe Perches $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@; 25553705ce5bSJoe Perches } 25563705ce5bSJoe Perches } 255700df344fSAndy Whitcroft } 255800df344fSAndy Whitcroft # Remove C99 comments. 25590a920b5bSAndy Whitcroft $line =~ s@//.*@@; 25606c72ffaaSAndy Whitcroft $opline =~ s@//.*@@; 25610a920b5bSAndy Whitcroft 25622b474a1aSAndy Whitcroft# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 25632b474a1aSAndy Whitcroft# the whole statement. 25642b474a1aSAndy Whitcroft#print "APW <$lines[$realline_next - 1]>\n"; 25652b474a1aSAndy Whitcroft if (defined $realline_next && 25662b474a1aSAndy Whitcroft exists $lines[$realline_next - 1] && 25672b474a1aSAndy Whitcroft !defined $suppress_export{$realline_next} && 25682b474a1aSAndy Whitcroft ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || 25692b474a1aSAndy Whitcroft $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 25703cbf62dfSAndy Whitcroft # Handle definitions which produce identifiers with 25713cbf62dfSAndy Whitcroft # a prefix: 25723cbf62dfSAndy Whitcroft # XXX(foo); 25733cbf62dfSAndy Whitcroft # EXPORT_SYMBOL(something_foo); 2574653d4876SAndy Whitcroft my $name = $1; 257587a53877SAndy Whitcroft if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 25763cbf62dfSAndy Whitcroft $name =~ /^${Ident}_$2/) { 25773cbf62dfSAndy Whitcroft#print "FOO C name<$name>\n"; 25783cbf62dfSAndy Whitcroft $suppress_export{$realline_next} = 1; 25793cbf62dfSAndy Whitcroft 25803cbf62dfSAndy Whitcroft } elsif ($stat !~ /(?: 25812b474a1aSAndy Whitcroft \n.}\s*$| 258248012058SAndy Whitcroft ^.DEFINE_$Ident\(\Q$name\E\)| 258348012058SAndy Whitcroft ^.DECLARE_$Ident\(\Q$name\E\)| 258448012058SAndy Whitcroft ^.LIST_HEAD\(\Q$name\E\)| 25852b474a1aSAndy Whitcroft ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 25862b474a1aSAndy Whitcroft \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 258748012058SAndy Whitcroft )/x) { 25882b474a1aSAndy Whitcroft#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 25892b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 2; 25902b474a1aSAndy Whitcroft } else { 25912b474a1aSAndy Whitcroft $suppress_export{$realline_next} = 1; 25920a920b5bSAndy Whitcroft } 25930a920b5bSAndy Whitcroft } 25942b474a1aSAndy Whitcroft if (!defined $suppress_export{$linenr} && 25952b474a1aSAndy Whitcroft $prevline =~ /^.\s*$/ && 25962b474a1aSAndy Whitcroft ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || 25972b474a1aSAndy Whitcroft $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { 25982b474a1aSAndy Whitcroft#print "FOO B <$lines[$linenr - 1]>\n"; 25992b474a1aSAndy Whitcroft $suppress_export{$linenr} = 2; 26002b474a1aSAndy Whitcroft } 26012b474a1aSAndy Whitcroft if (defined $suppress_export{$linenr} && 26022b474a1aSAndy Whitcroft $suppress_export{$linenr} == 2) { 2603000d1cc1SJoe Perches WARN("EXPORT_SYMBOL", 2604000d1cc1SJoe Perches "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 26052b474a1aSAndy Whitcroft } 26060a920b5bSAndy Whitcroft 26075150bda4SJoe Eloff# check for global initialisers. 2608d5e616fcSJoe Perches if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) { 2609d5e616fcSJoe Perches if (ERROR("GLOBAL_INITIALISERS", 2610000d1cc1SJoe Perches "do not initialise globals to 0 or NULL\n" . 2611d5e616fcSJoe Perches $herecurr) && 2612d5e616fcSJoe Perches $fix) { 2613d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/; 2614d5e616fcSJoe Perches } 2615f0a594c1SAndy Whitcroft } 26160a920b5bSAndy Whitcroft# check for static initialisers. 2617d5e616fcSJoe Perches if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2618d5e616fcSJoe Perches if (ERROR("INITIALISED_STATIC", 2619000d1cc1SJoe Perches "do not initialise statics to 0 or NULL\n" . 2620d5e616fcSJoe Perches $herecurr) && 2621d5e616fcSJoe Perches $fix) { 2622d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/; 2623d5e616fcSJoe Perches } 26240a920b5bSAndy Whitcroft } 26250a920b5bSAndy Whitcroft 2626cb710ecaSJoe Perches# check for static const char * arrays. 2627cb710ecaSJoe Perches if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 2628000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2629000d1cc1SJoe Perches "static const char * array should probably be static const char * const\n" . 2630cb710ecaSJoe Perches $herecurr); 2631cb710ecaSJoe Perches } 2632cb710ecaSJoe Perches 2633cb710ecaSJoe Perches# check for static char foo[] = "bar" declarations. 2634cb710ecaSJoe Perches if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 2635000d1cc1SJoe Perches WARN("STATIC_CONST_CHAR_ARRAY", 2636000d1cc1SJoe Perches "static char array declaration should probably be static const char\n" . 2637cb710ecaSJoe Perches $herecurr); 2638cb710ecaSJoe Perches } 2639cb710ecaSJoe Perches 264092e112fdSJoe Perches# check for uses of DEFINE_PCI_DEVICE_TABLE 264192e112fdSJoe Perches if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) { 264292e112fdSJoe Perches if (WARN("DEFINE_PCI_DEVICE_TABLE", 264392e112fdSJoe Perches "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) && 264492e112fdSJoe Perches $fix) { 264592e112fdSJoe Perches $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /; 264692e112fdSJoe Perches } 264793ed0e2dSJoe Perches } 264893ed0e2dSJoe Perches 2649653d4876SAndy Whitcroft# check for new typedefs, only function parameters and sparse annotations 2650653d4876SAndy Whitcroft# make sense. 2651653d4876SAndy Whitcroft if ($line =~ /\btypedef\s/ && 26528054576dSAndy Whitcroft $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 2653c45dcabdSAndy Whitcroft $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 26548ed22cadSAndy Whitcroft $line !~ /\b$typeTypedefs\b/ && 2655653d4876SAndy Whitcroft $line !~ /\b__bitwise(?:__|)\b/) { 2656000d1cc1SJoe Perches WARN("NEW_TYPEDEFS", 2657000d1cc1SJoe Perches "do not add new typedefs\n" . $herecurr); 26580a920b5bSAndy Whitcroft } 26590a920b5bSAndy Whitcroft 26600a920b5bSAndy Whitcroft# * goes on variable not on type 266165863862SAndy Whitcroft # (char*[ const]) 2662bfcb2cc7SAndy Whitcroft while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 2663bfcb2cc7SAndy Whitcroft #print "AA<$1>\n"; 26643705ce5bSJoe Perches my ($ident, $from, $to) = ($1, $2, $2); 2665d8aaf121SAndy Whitcroft 266665863862SAndy Whitcroft # Should start with a space. 266765863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 266865863862SAndy Whitcroft # Should not end with a space. 266965863862SAndy Whitcroft $to =~ s/\s+$//; 267065863862SAndy Whitcroft # '*'s should not have spaces between. 2671f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 267265863862SAndy Whitcroft } 2673d8aaf121SAndy Whitcroft 26743705ce5bSJoe Perches## print "1: from<$from> to<$to> ident<$ident>\n"; 267565863862SAndy Whitcroft if ($from ne $to) { 26763705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 26773705ce5bSJoe Perches "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 26783705ce5bSJoe Perches $fix) { 26793705ce5bSJoe Perches my $sub_from = $ident; 26803705ce5bSJoe Perches my $sub_to = $ident; 26813705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 26823705ce5bSJoe Perches $fixed[$linenr - 1] =~ 26833705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 26843705ce5bSJoe Perches } 268565863862SAndy Whitcroft } 2686bfcb2cc7SAndy Whitcroft } 2687bfcb2cc7SAndy Whitcroft while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 2688bfcb2cc7SAndy Whitcroft #print "BB<$1>\n"; 26893705ce5bSJoe Perches my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 2690d8aaf121SAndy Whitcroft 269165863862SAndy Whitcroft # Should start with a space. 269265863862SAndy Whitcroft $to =~ s/^(\S)/ $1/; 269365863862SAndy Whitcroft # Should not end with a space. 269465863862SAndy Whitcroft $to =~ s/\s+$//; 269565863862SAndy Whitcroft # '*'s should not have spaces between. 2696f9a0b3d1SAndy Whitcroft while ($to =~ s/\*\s+\*/\*\*/) { 269765863862SAndy Whitcroft } 269865863862SAndy Whitcroft # Modifiers should have spaces. 269965863862SAndy Whitcroft $to =~ s/(\b$Modifier$)/$1 /; 270065863862SAndy Whitcroft 27013705ce5bSJoe Perches## print "2: from<$from> to<$to> ident<$ident>\n"; 2702667026e7SAndy Whitcroft if ($from ne $to && $ident !~ /^$Modifier$/) { 27033705ce5bSJoe Perches if (ERROR("POINTER_LOCATION", 27043705ce5bSJoe Perches "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 27053705ce5bSJoe Perches $fix) { 27063705ce5bSJoe Perches 27073705ce5bSJoe Perches my $sub_from = $match; 27083705ce5bSJoe Perches my $sub_to = $match; 27093705ce5bSJoe Perches $sub_to =~ s/\Q$from\E/$to/; 27103705ce5bSJoe Perches $fixed[$linenr - 1] =~ 27113705ce5bSJoe Perches s@\Q$sub_from\E@$sub_to@; 27123705ce5bSJoe Perches } 271365863862SAndy Whitcroft } 27140a920b5bSAndy Whitcroft } 27150a920b5bSAndy Whitcroft 27160a920b5bSAndy Whitcroft# # no BUG() or BUG_ON() 27170a920b5bSAndy Whitcroft# if ($line =~ /\b(BUG|BUG_ON)\b/) { 27180a920b5bSAndy Whitcroft# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; 27190a920b5bSAndy Whitcroft# print "$herecurr"; 27200a920b5bSAndy Whitcroft# $clean = 0; 27210a920b5bSAndy Whitcroft# } 27220a920b5bSAndy Whitcroft 27238905a67cSAndy Whitcroft if ($line =~ /\bLINUX_VERSION_CODE\b/) { 2724000d1cc1SJoe Perches WARN("LINUX_VERSION_CODE", 2725000d1cc1SJoe Perches "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 27268905a67cSAndy Whitcroft } 27278905a67cSAndy Whitcroft 272817441227SJoe Perches# check for uses of printk_ratelimit 272917441227SJoe Perches if ($line =~ /\bprintk_ratelimit\s*\(/) { 2730000d1cc1SJoe Perches WARN("PRINTK_RATELIMITED", 2731000d1cc1SJoe Perches"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 273217441227SJoe Perches } 273317441227SJoe Perches 273400df344fSAndy Whitcroft# printk should use KERN_* levels. Note that follow on printk's on the 273500df344fSAndy Whitcroft# same line do not need a level, so we use the current block context 273600df344fSAndy Whitcroft# to try and find and validate the current printk. In summary the current 273725985edcSLucas De Marchi# printk includes all preceding printk's which have no newline on the end. 273800df344fSAndy Whitcroft# we assume the first bad printk is the one to report. 2739f0a594c1SAndy Whitcroft if ($line =~ /\bprintk\((?!KERN_)\s*"/) { 274000df344fSAndy Whitcroft my $ok = 0; 274100df344fSAndy Whitcroft for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { 274200df344fSAndy Whitcroft #print "CHECK<$lines[$ln - 1]\n"; 274325985edcSLucas De Marchi # we have a preceding printk if it ends 274400df344fSAndy Whitcroft # with "\n" ignore it, else it is to blame 274500df344fSAndy Whitcroft if ($lines[$ln - 1] =~ m{\bprintk\(}) { 274600df344fSAndy Whitcroft if ($rawlines[$ln - 1] !~ m{\\n"}) { 274700df344fSAndy Whitcroft $ok = 1; 274800df344fSAndy Whitcroft } 274900df344fSAndy Whitcroft last; 275000df344fSAndy Whitcroft } 275100df344fSAndy Whitcroft } 275200df344fSAndy Whitcroft if ($ok == 0) { 2753000d1cc1SJoe Perches WARN("PRINTK_WITHOUT_KERN_LEVEL", 2754000d1cc1SJoe Perches "printk() should include KERN_ facility level\n" . $herecurr); 27550a920b5bSAndy Whitcroft } 275600df344fSAndy Whitcroft } 27570a920b5bSAndy Whitcroft 2758243f3803SJoe Perches if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) { 2759243f3803SJoe Perches my $orig = $1; 2760243f3803SJoe Perches my $level = lc($orig); 2761243f3803SJoe Perches $level = "warn" if ($level eq "warning"); 27628f26b837SJoe Perches my $level2 = $level; 27638f26b837SJoe Perches $level2 = "dbg" if ($level eq "debug"); 2764243f3803SJoe Perches WARN("PREFER_PR_LEVEL", 27658f26b837SJoe Perches "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr); 2766243f3803SJoe Perches } 2767243f3803SJoe Perches 2768243f3803SJoe Perches if ($line =~ /\bpr_warning\s*\(/) { 2769d5e616fcSJoe Perches if (WARN("PREFER_PR_LEVEL", 2770d5e616fcSJoe Perches "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) && 2771d5e616fcSJoe Perches $fix) { 2772d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 2773d5e616fcSJoe Perches s/\bpr_warning\b/pr_warn/; 2774d5e616fcSJoe Perches } 2775243f3803SJoe Perches } 2776243f3803SJoe Perches 2777dc139313SJoe Perches if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 2778dc139313SJoe Perches my $orig = $1; 2779dc139313SJoe Perches my $level = lc($orig); 2780dc139313SJoe Perches $level = "warn" if ($level eq "warning"); 2781dc139313SJoe Perches $level = "dbg" if ($level eq "debug"); 2782dc139313SJoe Perches WARN("PREFER_DEV_LEVEL", 2783dc139313SJoe Perches "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 2784dc139313SJoe Perches } 2785dc139313SJoe Perches 2786653d4876SAndy Whitcroft# function brace can't be on same line, except for #defines of do while, 2787653d4876SAndy Whitcroft# or if closed on same line 2788c45dcabdSAndy Whitcroft if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and 2789c45dcabdSAndy Whitcroft !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { 2790000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2791000d1cc1SJoe Perches "open brace '{' following function declarations go on the next line\n" . $herecurr); 27920a920b5bSAndy Whitcroft } 2793653d4876SAndy Whitcroft 27948905a67cSAndy Whitcroft# open braces for enum, union and struct go on the same line. 27958905a67cSAndy Whitcroft if ($line =~ /^.\s*{/ && 27968905a67cSAndy Whitcroft $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2797000d1cc1SJoe Perches ERROR("OPEN_BRACE", 2798000d1cc1SJoe Perches "open brace '{' following $1 go on the same line\n" . $hereprev); 27998905a67cSAndy Whitcroft } 28008905a67cSAndy Whitcroft 28010c73b4ebSAndy Whitcroft# missing space after union, struct or enum definition 28023705ce5bSJoe Perches if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 28033705ce5bSJoe Perches if (WARN("SPACING", 28043705ce5bSJoe Perches "missing space after $1 definition\n" . $herecurr) && 28053705ce5bSJoe Perches $fix) { 28063705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28073705ce5bSJoe Perches s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 28083705ce5bSJoe Perches } 28090c73b4ebSAndy Whitcroft } 28100c73b4ebSAndy Whitcroft 28118d31cfceSAndy Whitcroft# check for spacing round square brackets; allowed: 28128d31cfceSAndy Whitcroft# 1. with a type on the left -- int [] a; 2813fe2a7dbcSAndy Whitcroft# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2814fe2a7dbcSAndy Whitcroft# 3. inside a curly brace -- = { [0...10] = 5 } 28158d31cfceSAndy Whitcroft while ($line =~ /(.*?\s)\[/g) { 28168d31cfceSAndy Whitcroft my ($where, $prefix) = ($-[1], $1); 28178d31cfceSAndy Whitcroft if ($prefix !~ /$Type\s+$/ && 2818fe2a7dbcSAndy Whitcroft ($where != 0 || $prefix !~ /^.\s+$/) && 2819daebc534SAndy Whitcroft $prefix !~ /[{,]\s+$/) { 28203705ce5bSJoe Perches if (ERROR("BRACKET_SPACE", 28213705ce5bSJoe Perches "space prohibited before open square bracket '['\n" . $herecurr) && 28223705ce5bSJoe Perches $fix) { 28233705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28243705ce5bSJoe Perches s/^(\+.*?)\s+\[/$1\[/; 28253705ce5bSJoe Perches } 28268d31cfceSAndy Whitcroft } 28278d31cfceSAndy Whitcroft } 28288d31cfceSAndy Whitcroft 2829f0a594c1SAndy Whitcroft# check for spaces between functions and their parentheses. 28306c72ffaaSAndy Whitcroft while ($line =~ /($Ident)\s+\(/g) { 2831c2fdda0dSAndy Whitcroft my $name = $1; 2832773647a0SAndy Whitcroft my $ctx_before = substr($line, 0, $-[1]); 2833773647a0SAndy Whitcroft my $ctx = "$ctx_before$name"; 2834c2fdda0dSAndy Whitcroft 2835c2fdda0dSAndy Whitcroft # Ignore those directives where spaces _are_ permitted. 2836773647a0SAndy Whitcroft if ($name =~ /^(?: 2837773647a0SAndy Whitcroft if|for|while|switch|return|case| 2838773647a0SAndy Whitcroft volatile|__volatile__| 2839773647a0SAndy Whitcroft __attribute__|format|__extension__| 2840773647a0SAndy Whitcroft asm|__asm__)$/x) 2841773647a0SAndy Whitcroft { 2842c2fdda0dSAndy Whitcroft # cpp #define statements have non-optional spaces, ie 2843c2fdda0dSAndy Whitcroft # if there is a space between the name and the open 2844c2fdda0dSAndy Whitcroft # parenthesis it is simply not a parameter group. 2845c45dcabdSAndy Whitcroft } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2846773647a0SAndy Whitcroft 2847773647a0SAndy Whitcroft # cpp #elif statement condition may start with a ( 2848c45dcabdSAndy Whitcroft } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2849c2fdda0dSAndy Whitcroft 2850c2fdda0dSAndy Whitcroft # If this whole things ends with a type its most 2851c2fdda0dSAndy Whitcroft # likely a typedef for a function. 2852773647a0SAndy Whitcroft } elsif ($ctx =~ /$Type$/) { 2853c2fdda0dSAndy Whitcroft 2854c2fdda0dSAndy Whitcroft } else { 28553705ce5bSJoe Perches if (WARN("SPACING", 28563705ce5bSJoe Perches "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 28573705ce5bSJoe Perches $fix) { 28583705ce5bSJoe Perches $fixed[$linenr - 1] =~ 28593705ce5bSJoe Perches s/\b$name\s+\(/$name\(/; 28603705ce5bSJoe Perches } 2861f0a594c1SAndy Whitcroft } 28626c72ffaaSAndy Whitcroft } 28639a4cad4eSEric Nelson 2864653d4876SAndy Whitcroft# Check operator spacing. 28650a920b5bSAndy Whitcroft if (!($line=~/\#\s*include/)) { 28663705ce5bSJoe Perches my $fixed_line = ""; 28673705ce5bSJoe Perches my $line_fixed = 0; 28683705ce5bSJoe Perches 28699c0ca6f9SAndy Whitcroft my $ops = qr{ 28709c0ca6f9SAndy Whitcroft <<=|>>=|<=|>=|==|!=| 28719c0ca6f9SAndy Whitcroft \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 28729c0ca6f9SAndy Whitcroft =>|->|<<|>>|<|>|=|!|~| 28731f65f947SAndy Whitcroft &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 287484731623SJoe Perches \?:|\?|: 28759c0ca6f9SAndy Whitcroft }x; 2876cf655043SAndy Whitcroft my @elements = split(/($ops|;)/, $opline); 28773705ce5bSJoe Perches 28783705ce5bSJoe Perches## print("element count: <" . $#elements . ">\n"); 28793705ce5bSJoe Perches## foreach my $el (@elements) { 28803705ce5bSJoe Perches## print("el: <$el>\n"); 28813705ce5bSJoe Perches## } 28823705ce5bSJoe Perches 28833705ce5bSJoe Perches my @fix_elements = (); 288400df344fSAndy Whitcroft my $off = 0; 28856c72ffaaSAndy Whitcroft 28863705ce5bSJoe Perches foreach my $el (@elements) { 28873705ce5bSJoe Perches push(@fix_elements, substr($rawline, $off, length($el))); 28883705ce5bSJoe Perches $off += length($el); 28893705ce5bSJoe Perches } 28903705ce5bSJoe Perches 28913705ce5bSJoe Perches $off = 0; 28923705ce5bSJoe Perches 28936c72ffaaSAndy Whitcroft my $blank = copy_spacing($opline); 2894b34c648bSJoe Perches my $last_after = -1; 28956c72ffaaSAndy Whitcroft 28960a920b5bSAndy Whitcroft for (my $n = 0; $n < $#elements; $n += 2) { 28973705ce5bSJoe Perches 28983705ce5bSJoe Perches my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 28993705ce5bSJoe Perches 29003705ce5bSJoe Perches## print("n: <$n> good: <$good>\n"); 29013705ce5bSJoe Perches 29024a0df2efSAndy Whitcroft $off += length($elements[$n]); 29034a0df2efSAndy Whitcroft 290425985edcSLucas De Marchi # Pick up the preceding and succeeding characters. 2905773647a0SAndy Whitcroft my $ca = substr($opline, 0, $off); 2906773647a0SAndy Whitcroft my $cc = ''; 2907773647a0SAndy Whitcroft if (length($opline) >= ($off + length($elements[$n + 1]))) { 2908773647a0SAndy Whitcroft $cc = substr($opline, $off + length($elements[$n + 1])); 2909773647a0SAndy Whitcroft } 2910773647a0SAndy Whitcroft my $cb = "$ca$;$cc"; 2911773647a0SAndy Whitcroft 29124a0df2efSAndy Whitcroft my $a = ''; 29134a0df2efSAndy Whitcroft $a = 'V' if ($elements[$n] ne ''); 29144a0df2efSAndy Whitcroft $a = 'W' if ($elements[$n] =~ /\s$/); 2915cf655043SAndy Whitcroft $a = 'C' if ($elements[$n] =~ /$;$/); 29164a0df2efSAndy Whitcroft $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 29174a0df2efSAndy Whitcroft $a = 'O' if ($elements[$n] eq ''); 2918773647a0SAndy Whitcroft $a = 'E' if ($ca =~ /^\s*$/); 29194a0df2efSAndy Whitcroft 29200a920b5bSAndy Whitcroft my $op = $elements[$n + 1]; 29214a0df2efSAndy Whitcroft 29224a0df2efSAndy Whitcroft my $c = ''; 29230a920b5bSAndy Whitcroft if (defined $elements[$n + 2]) { 29244a0df2efSAndy Whitcroft $c = 'V' if ($elements[$n + 2] ne ''); 29254a0df2efSAndy Whitcroft $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2926cf655043SAndy Whitcroft $c = 'C' if ($elements[$n + 2] =~ /^$;/); 29274a0df2efSAndy Whitcroft $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 29284a0df2efSAndy Whitcroft $c = 'O' if ($elements[$n + 2] eq ''); 29298b1b3378SAndy Whitcroft $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 29304a0df2efSAndy Whitcroft } else { 29314a0df2efSAndy Whitcroft $c = 'E'; 29320a920b5bSAndy Whitcroft } 29330a920b5bSAndy Whitcroft 29344a0df2efSAndy Whitcroft my $ctx = "${a}x${c}"; 29354a0df2efSAndy Whitcroft 29364a0df2efSAndy Whitcroft my $at = "(ctx:$ctx)"; 29374a0df2efSAndy Whitcroft 29386c72ffaaSAndy Whitcroft my $ptr = substr($blank, 0, $off) . "^"; 2939de7d4f0eSAndy Whitcroft my $hereptr = "$hereline$ptr\n"; 29400a920b5bSAndy Whitcroft 294174048ed8SAndy Whitcroft # Pull out the value of this operator. 29426c72ffaaSAndy Whitcroft my $op_type = substr($curr_values, $off + 1, 1); 29430a920b5bSAndy Whitcroft 29441f65f947SAndy Whitcroft # Get the full operator variant. 29451f65f947SAndy Whitcroft my $opv = $op . substr($curr_vars, $off, 1); 29461f65f947SAndy Whitcroft 294713214adfSAndy Whitcroft # Ignore operators passed as parameters. 294813214adfSAndy Whitcroft if ($op_type ne 'V' && 294913214adfSAndy Whitcroft $ca =~ /\s$/ && $cc =~ /^\s*,/) { 295013214adfSAndy Whitcroft 2951cf655043SAndy Whitcroft# # Ignore comments 2952cf655043SAndy Whitcroft# } elsif ($op =~ /^$;+$/) { 295313214adfSAndy Whitcroft 2954d8aaf121SAndy Whitcroft # ; should have either the end of line or a space or \ after it 295513214adfSAndy Whitcroft } elsif ($op eq ';') { 2956cf655043SAndy Whitcroft if ($ctx !~ /.x[WEBC]/ && 2957cf655043SAndy Whitcroft $cc !~ /^\\/ && $cc !~ /^;/) { 29583705ce5bSJoe Perches if (ERROR("SPACING", 29593705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 2960b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 29613705ce5bSJoe Perches $line_fixed = 1; 29623705ce5bSJoe Perches } 2963d8aaf121SAndy Whitcroft } 2964d8aaf121SAndy Whitcroft 2965d8aaf121SAndy Whitcroft # // is a comment 2966d8aaf121SAndy Whitcroft } elsif ($op eq '//') { 29670a920b5bSAndy Whitcroft 29681f65f947SAndy Whitcroft # No spaces for: 29691f65f947SAndy Whitcroft # -> 29701f65f947SAndy Whitcroft # : when part of a bitfield 29711f65f947SAndy Whitcroft } elsif ($op eq '->' || $opv eq ':B') { 29724a0df2efSAndy Whitcroft if ($ctx =~ /Wx.|.xW/) { 29733705ce5bSJoe Perches if (ERROR("SPACING", 29743705ce5bSJoe Perches "spaces prohibited around that '$op' $at\n" . $hereptr)) { 2975b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 29763705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 29773705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 29783705ce5bSJoe Perches } 2979b34c648bSJoe Perches $line_fixed = 1; 29803705ce5bSJoe Perches } 29810a920b5bSAndy Whitcroft } 29820a920b5bSAndy Whitcroft 29830a920b5bSAndy Whitcroft # , must have a space on the right. 29840a920b5bSAndy Whitcroft } elsif ($op eq ',') { 2985cf655043SAndy Whitcroft if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 29863705ce5bSJoe Perches if (ERROR("SPACING", 29873705ce5bSJoe Perches "space required after that '$op' $at\n" . $hereptr)) { 2988b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 29893705ce5bSJoe Perches $line_fixed = 1; 2990b34c648bSJoe Perches $last_after = $n; 29913705ce5bSJoe Perches } 29920a920b5bSAndy Whitcroft } 29930a920b5bSAndy Whitcroft 29949c0ca6f9SAndy Whitcroft # '*' as part of a type definition -- reported already. 299574048ed8SAndy Whitcroft } elsif ($opv eq '*_') { 29969c0ca6f9SAndy Whitcroft #warn "'*' is part of type\n"; 29979c0ca6f9SAndy Whitcroft 29989c0ca6f9SAndy Whitcroft # unary operators should have a space before and 29999c0ca6f9SAndy Whitcroft # none after. May be left adjacent to another 30009c0ca6f9SAndy Whitcroft # unary operator, or a cast 30019c0ca6f9SAndy Whitcroft } elsif ($op eq '!' || $op eq '~' || 300274048ed8SAndy Whitcroft $opv eq '*U' || $opv eq '-U' || 30030d413866SAndy Whitcroft $opv eq '&U' || $opv eq '&&U') { 3004cf655043SAndy Whitcroft if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 30053705ce5bSJoe Perches if (ERROR("SPACING", 30063705ce5bSJoe Perches "space required before that '$op' $at\n" . $hereptr)) { 3007b34c648bSJoe Perches if ($n != $last_after + 2) { 3008b34c648bSJoe Perches $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 30093705ce5bSJoe Perches $line_fixed = 1; 30103705ce5bSJoe Perches } 30110a920b5bSAndy Whitcroft } 3012b34c648bSJoe Perches } 3013a3340b35SAndy Whitcroft if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 3014171ae1a4SAndy Whitcroft # A unary '*' may be const 3015171ae1a4SAndy Whitcroft 3016171ae1a4SAndy Whitcroft } elsif ($ctx =~ /.xW/) { 30173705ce5bSJoe Perches if (ERROR("SPACING", 30183705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3019b34c648bSJoe Perches $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 30203705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 30213705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 30223705ce5bSJoe Perches } 3023b34c648bSJoe Perches $line_fixed = 1; 30243705ce5bSJoe Perches } 30250a920b5bSAndy Whitcroft } 30260a920b5bSAndy Whitcroft 30270a920b5bSAndy Whitcroft # unary ++ and unary -- are allowed no space on one side. 30280a920b5bSAndy Whitcroft } elsif ($op eq '++' or $op eq '--') { 3029773647a0SAndy Whitcroft if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 30303705ce5bSJoe Perches if (ERROR("SPACING", 30313705ce5bSJoe Perches "space required one side of that '$op' $at\n" . $hereptr)) { 3032b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 30333705ce5bSJoe Perches $line_fixed = 1; 30343705ce5bSJoe Perches } 30350a920b5bSAndy Whitcroft } 3036773647a0SAndy Whitcroft if ($ctx =~ /Wx[BE]/ || 3037773647a0SAndy Whitcroft ($ctx =~ /Wx./ && $cc =~ /^;/)) { 30383705ce5bSJoe Perches if (ERROR("SPACING", 30393705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3040b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 30413705ce5bSJoe Perches $line_fixed = 1; 30423705ce5bSJoe Perches } 3043653d4876SAndy Whitcroft } 3044773647a0SAndy Whitcroft if ($ctx =~ /ExW/) { 30453705ce5bSJoe Perches if (ERROR("SPACING", 30463705ce5bSJoe Perches "space prohibited after that '$op' $at\n" . $hereptr)) { 3047b34c648bSJoe Perches $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 30483705ce5bSJoe Perches if (defined $fix_elements[$n + 2]) { 30493705ce5bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3050773647a0SAndy Whitcroft } 3051b34c648bSJoe Perches $line_fixed = 1; 30523705ce5bSJoe Perches } 30533705ce5bSJoe Perches } 30540a920b5bSAndy Whitcroft 30550a920b5bSAndy Whitcroft # << and >> may either have or not have spaces both sides 30569c0ca6f9SAndy Whitcroft } elsif ($op eq '<<' or $op eq '>>' or 30579c0ca6f9SAndy Whitcroft $op eq '&' or $op eq '^' or $op eq '|' or 30589c0ca6f9SAndy Whitcroft $op eq '+' or $op eq '-' or 3059c2fdda0dSAndy Whitcroft $op eq '*' or $op eq '/' or 3060c2fdda0dSAndy Whitcroft $op eq '%') 30610a920b5bSAndy Whitcroft { 3062773647a0SAndy Whitcroft if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 30633705ce5bSJoe Perches if (ERROR("SPACING", 30643705ce5bSJoe Perches "need consistent spacing around '$op' $at\n" . $hereptr)) { 3065b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3066b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3067b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3068b34c648bSJoe Perches } 30693705ce5bSJoe Perches $line_fixed = 1; 30703705ce5bSJoe Perches } 30710a920b5bSAndy Whitcroft } 30720a920b5bSAndy Whitcroft 30731f65f947SAndy Whitcroft # A colon needs no spaces before when it is 30741f65f947SAndy Whitcroft # terminating a case value or a label. 30751f65f947SAndy Whitcroft } elsif ($opv eq ':C' || $opv eq ':L') { 30761f65f947SAndy Whitcroft if ($ctx =~ /Wx./) { 30773705ce5bSJoe Perches if (ERROR("SPACING", 30783705ce5bSJoe Perches "space prohibited before that '$op' $at\n" . $hereptr)) { 3079b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 30803705ce5bSJoe Perches $line_fixed = 1; 30813705ce5bSJoe Perches } 30821f65f947SAndy Whitcroft } 30831f65f947SAndy Whitcroft 30840a920b5bSAndy Whitcroft # All the others need spaces both sides. 3085cf655043SAndy Whitcroft } elsif ($ctx !~ /[EWC]x[CWE]/) { 30861f65f947SAndy Whitcroft my $ok = 0; 30871f65f947SAndy Whitcroft 308822f2a2efSAndy Whitcroft # Ignore email addresses <foo@bar> 30891f65f947SAndy Whitcroft if (($op eq '<' && 30901f65f947SAndy Whitcroft $cc =~ /^\S+\@\S+>/) || 30911f65f947SAndy Whitcroft ($op eq '>' && 30921f65f947SAndy Whitcroft $ca =~ /<\S+\@\S+$/)) 30931f65f947SAndy Whitcroft { 30941f65f947SAndy Whitcroft $ok = 1; 30951f65f947SAndy Whitcroft } 30961f65f947SAndy Whitcroft 309784731623SJoe Perches # messages are ERROR, but ?: are CHK 30981f65f947SAndy Whitcroft if ($ok == 0) { 309984731623SJoe Perches my $msg_type = \&ERROR; 310084731623SJoe Perches $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 310184731623SJoe Perches 310284731623SJoe Perches if (&{$msg_type}("SPACING", 31033705ce5bSJoe Perches "spaces required around that '$op' $at\n" . $hereptr)) { 3104b34c648bSJoe Perches $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 3105b34c648bSJoe Perches if (defined $fix_elements[$n + 2]) { 3106b34c648bSJoe Perches $fix_elements[$n + 2] =~ s/^\s+//; 3107b34c648bSJoe Perches } 31083705ce5bSJoe Perches $line_fixed = 1; 31093705ce5bSJoe Perches } 31100a920b5bSAndy Whitcroft } 311122f2a2efSAndy Whitcroft } 31124a0df2efSAndy Whitcroft $off += length($elements[$n + 1]); 31133705ce5bSJoe Perches 31143705ce5bSJoe Perches## print("n: <$n> GOOD: <$good>\n"); 31153705ce5bSJoe Perches 31163705ce5bSJoe Perches $fixed_line = $fixed_line . $good; 31170a920b5bSAndy Whitcroft } 31183705ce5bSJoe Perches 31193705ce5bSJoe Perches if (($#elements % 2) == 0) { 31203705ce5bSJoe Perches $fixed_line = $fixed_line . $fix_elements[$#elements]; 31213705ce5bSJoe Perches } 31223705ce5bSJoe Perches 31233705ce5bSJoe Perches if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) { 31243705ce5bSJoe Perches $fixed[$linenr - 1] = $fixed_line; 31253705ce5bSJoe Perches } 31263705ce5bSJoe Perches 31273705ce5bSJoe Perches 31280a920b5bSAndy Whitcroft } 31290a920b5bSAndy Whitcroft 3130786b6326SJoe Perches# check for whitespace before a non-naked semicolon 3131d2e248e7SJoe Perches if ($line =~ /^\+.*\S\s+;\s*$/) { 3132786b6326SJoe Perches if (WARN("SPACING", 3133786b6326SJoe Perches "space prohibited before semicolon\n" . $herecurr) && 3134786b6326SJoe Perches $fix) { 3135786b6326SJoe Perches 1 while $fixed[$linenr - 1] =~ 3136786b6326SJoe Perches s/^(\+.*\S)\s+;/$1;/; 3137786b6326SJoe Perches } 3138786b6326SJoe Perches } 3139786b6326SJoe Perches 3140f0a594c1SAndy Whitcroft# check for multiple assignments 3141f0a594c1SAndy Whitcroft if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 3142000d1cc1SJoe Perches CHK("MULTIPLE_ASSIGNMENTS", 3143000d1cc1SJoe Perches "multiple assignments should be avoided\n" . $herecurr); 3144f0a594c1SAndy Whitcroft } 3145f0a594c1SAndy Whitcroft 314622f2a2efSAndy Whitcroft## # check for multiple declarations, allowing for a function declaration 314722f2a2efSAndy Whitcroft## # continuation. 314822f2a2efSAndy Whitcroft## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 314922f2a2efSAndy Whitcroft## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 315022f2a2efSAndy Whitcroft## 315122f2a2efSAndy Whitcroft## # Remove any bracketed sections to ensure we do not 315222f2a2efSAndy Whitcroft## # falsly report the parameters of functions. 315322f2a2efSAndy Whitcroft## my $ln = $line; 315422f2a2efSAndy Whitcroft## while ($ln =~ s/\([^\(\)]*\)//g) { 315522f2a2efSAndy Whitcroft## } 315622f2a2efSAndy Whitcroft## if ($ln =~ /,/) { 3157000d1cc1SJoe Perches## WARN("MULTIPLE_DECLARATION", 3158000d1cc1SJoe Perches## "declaring multiple variables together should be avoided\n" . $herecurr); 315922f2a2efSAndy Whitcroft## } 316022f2a2efSAndy Whitcroft## } 3161f0a594c1SAndy Whitcroft 31620a920b5bSAndy Whitcroft#need space before brace following if, while, etc 316322f2a2efSAndy Whitcroft if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || 316422f2a2efSAndy Whitcroft $line =~ /do{/) { 31653705ce5bSJoe Perches if (ERROR("SPACING", 31663705ce5bSJoe Perches "space required before the open brace '{'\n" . $herecurr) && 31673705ce5bSJoe Perches $fix) { 3168d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/; 31693705ce5bSJoe Perches } 3170de7d4f0eSAndy Whitcroft } 3171de7d4f0eSAndy Whitcroft 3172c4a62ef9SJoe Perches## # check for blank lines before declarations 3173c4a62ef9SJoe Perches## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 3174c4a62ef9SJoe Perches## $prevrawline =~ /^.\s*$/) { 3175c4a62ef9SJoe Perches## WARN("SPACING", 3176c4a62ef9SJoe Perches## "No blank lines before declarations\n" . $hereprev); 3177c4a62ef9SJoe Perches## } 3178c4a62ef9SJoe Perches## 3179c4a62ef9SJoe Perches 3180de7d4f0eSAndy Whitcroft# closing brace should have a space following it when it has anything 3181de7d4f0eSAndy Whitcroft# on the line 3182de7d4f0eSAndy Whitcroft if ($line =~ /}(?!(?:,|;|\)))\S/) { 3183d5e616fcSJoe Perches if (ERROR("SPACING", 3184d5e616fcSJoe Perches "space required after that close brace '}'\n" . $herecurr) && 3185d5e616fcSJoe Perches $fix) { 3186d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3187d5e616fcSJoe Perches s/}((?!(?:,|;|\)))\S)/} $1/; 3188d5e616fcSJoe Perches } 31890a920b5bSAndy Whitcroft } 31900a920b5bSAndy Whitcroft 319122f2a2efSAndy Whitcroft# check spacing on square brackets 319222f2a2efSAndy Whitcroft if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 31933705ce5bSJoe Perches if (ERROR("SPACING", 31943705ce5bSJoe Perches "space prohibited after that open square bracket '['\n" . $herecurr) && 31953705ce5bSJoe Perches $fix) { 31963705ce5bSJoe Perches $fixed[$linenr - 1] =~ 31973705ce5bSJoe Perches s/\[\s+/\[/; 31983705ce5bSJoe Perches } 319922f2a2efSAndy Whitcroft } 320022f2a2efSAndy Whitcroft if ($line =~ /\s\]/) { 32013705ce5bSJoe Perches if (ERROR("SPACING", 32023705ce5bSJoe Perches "space prohibited before that close square bracket ']'\n" . $herecurr) && 32033705ce5bSJoe Perches $fix) { 32043705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32053705ce5bSJoe Perches s/\s+\]/\]/; 32063705ce5bSJoe Perches } 320722f2a2efSAndy Whitcroft } 320822f2a2efSAndy Whitcroft 3209c45dcabdSAndy Whitcroft# check spacing on parentheses 32109c0ca6f9SAndy Whitcroft if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 32119c0ca6f9SAndy Whitcroft $line !~ /for\s*\(\s+;/) { 32123705ce5bSJoe Perches if (ERROR("SPACING", 32133705ce5bSJoe Perches "space prohibited after that open parenthesis '('\n" . $herecurr) && 32143705ce5bSJoe Perches $fix) { 32153705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32163705ce5bSJoe Perches s/\(\s+/\(/; 32173705ce5bSJoe Perches } 321822f2a2efSAndy Whitcroft } 321913214adfSAndy Whitcroft if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 3220c45dcabdSAndy Whitcroft $line !~ /for\s*\(.*;\s+\)/ && 3221c45dcabdSAndy Whitcroft $line !~ /:\s+\)/) { 32223705ce5bSJoe Perches if (ERROR("SPACING", 32233705ce5bSJoe Perches "space prohibited before that close parenthesis ')'\n" . $herecurr) && 32243705ce5bSJoe Perches $fix) { 32253705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32263705ce5bSJoe Perches s/\s+\)/\)/; 32273705ce5bSJoe Perches } 322822f2a2efSAndy Whitcroft } 322922f2a2efSAndy Whitcroft 32300a920b5bSAndy Whitcroft#goto labels aren't indented, allow a single space however 32314a0df2efSAndy Whitcroft if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 32320a920b5bSAndy Whitcroft !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 32333705ce5bSJoe Perches if (WARN("INDENTED_LABEL", 32343705ce5bSJoe Perches "labels should not be indented\n" . $herecurr) && 32353705ce5bSJoe Perches $fix) { 32363705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32373705ce5bSJoe Perches s/^(.)\s+/$1/; 32383705ce5bSJoe Perches } 32390a920b5bSAndy Whitcroft } 32400a920b5bSAndy Whitcroft 3241c45dcabdSAndy Whitcroft# Return is not a function. 3242507e5141SJoe Perches if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 3243c45dcabdSAndy Whitcroft my $spacing = $1; 3244507e5141SJoe Perches if ($^V && $^V ge 5.10.0 && 3245507e5141SJoe Perches $stat =~ /^.\s*return\s*$balanced_parens\s*;\s*$/) { 3246000d1cc1SJoe Perches ERROR("RETURN_PARENTHESES", 3247000d1cc1SJoe Perches "return is not a function, parentheses are not required\n" . $herecurr); 3248c45dcabdSAndy Whitcroft 3249c45dcabdSAndy Whitcroft } elsif ($spacing !~ /\s+/) { 3250000d1cc1SJoe Perches ERROR("SPACING", 3251000d1cc1SJoe Perches "space required before the open parenthesis '('\n" . $herecurr); 3252c45dcabdSAndy Whitcroft } 3253c45dcabdSAndy Whitcroft } 3254507e5141SJoe Perches 325553a3c448SAndy Whitcroft# Return of what appears to be an errno should normally be -'ve 325653a3c448SAndy Whitcroft if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 325753a3c448SAndy Whitcroft my $name = $1; 325853a3c448SAndy Whitcroft if ($name ne 'EOF' && $name ne 'ERROR') { 3259000d1cc1SJoe Perches WARN("USE_NEGATIVE_ERRNO", 3260000d1cc1SJoe Perches "return of an errno should typically be -ve (return -$1)\n" . $herecurr); 326153a3c448SAndy Whitcroft } 326253a3c448SAndy Whitcroft } 3263c45dcabdSAndy Whitcroft 32640a920b5bSAndy Whitcroft# Need a space before open parenthesis after if, while etc 32654a0df2efSAndy Whitcroft if ($line =~ /\b(if|while|for|switch)\(/) { 32663705ce5bSJoe Perches if (ERROR("SPACING", 32673705ce5bSJoe Perches "space required before the open parenthesis '('\n" . $herecurr) && 32683705ce5bSJoe Perches $fix) { 32693705ce5bSJoe Perches $fixed[$linenr - 1] =~ 32703705ce5bSJoe Perches s/\b(if|while|for|switch)\(/$1 \(/; 32713705ce5bSJoe Perches } 32720a920b5bSAndy Whitcroft } 32730a920b5bSAndy Whitcroft 3274f5fe35ddSAndy Whitcroft# Check for illegal assignment in if conditional -- and check for trailing 3275f5fe35ddSAndy Whitcroft# statements after the conditional. 3276170d3a22SAndy Whitcroft if ($line =~ /do\s*(?!{)/) { 32773e469cdcSAndy Whitcroft ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 32783e469cdcSAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0) 32793e469cdcSAndy Whitcroft if (!defined $stat); 3280170d3a22SAndy Whitcroft my ($stat_next) = ctx_statement_block($line_nr_next, 3281170d3a22SAndy Whitcroft $remain_next, $off_next); 3282170d3a22SAndy Whitcroft $stat_next =~ s/\n./\n /g; 3283170d3a22SAndy Whitcroft ##print "stat<$stat> stat_next<$stat_next>\n"; 3284170d3a22SAndy Whitcroft 3285170d3a22SAndy Whitcroft if ($stat_next =~ /^\s*while\b/) { 3286170d3a22SAndy Whitcroft # If the statement carries leading newlines, 3287170d3a22SAndy Whitcroft # then count those as offsets. 3288170d3a22SAndy Whitcroft my ($whitespace) = 3289170d3a22SAndy Whitcroft ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 3290170d3a22SAndy Whitcroft my $offset = 3291170d3a22SAndy Whitcroft statement_rawlines($whitespace) - 1; 3292170d3a22SAndy Whitcroft 3293170d3a22SAndy Whitcroft $suppress_whiletrailers{$line_nr_next + 3294170d3a22SAndy Whitcroft $offset} = 1; 3295170d3a22SAndy Whitcroft } 3296170d3a22SAndy Whitcroft } 3297170d3a22SAndy Whitcroft if (!defined $suppress_whiletrailers{$linenr} && 3298c11230f4SJoe Perches defined($stat) && defined($cond) && 3299170d3a22SAndy Whitcroft $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 3300171ae1a4SAndy Whitcroft my ($s, $c) = ($stat, $cond); 33018905a67cSAndy Whitcroft 3302b53c8e10SAndy Whitcroft if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 3303000d1cc1SJoe Perches ERROR("ASSIGN_IN_IF", 3304000d1cc1SJoe Perches "do not use assignment in if condition\n" . $herecurr); 33058905a67cSAndy Whitcroft } 33068905a67cSAndy Whitcroft 33078905a67cSAndy Whitcroft # Find out what is on the end of the line after the 33088905a67cSAndy Whitcroft # conditional. 3309773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 33108905a67cSAndy Whitcroft $s =~ s/\n.*//g; 331113214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 331253210168SAndy Whitcroft if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 331353210168SAndy Whitcroft $c !~ /}\s*while\s*/) 3314773647a0SAndy Whitcroft { 3315bb44ad39SAndy Whitcroft # Find out how long the conditional actually is. 3316bb44ad39SAndy Whitcroft my @newlines = ($c =~ /\n/gs); 3317bb44ad39SAndy Whitcroft my $cond_lines = 1 + $#newlines; 331842bdf74cSHidetoshi Seto my $stat_real = ''; 3319bb44ad39SAndy Whitcroft 332042bdf74cSHidetoshi Seto $stat_real = raw_line($linenr, $cond_lines) 332142bdf74cSHidetoshi Seto . "\n" if ($cond_lines); 3322bb44ad39SAndy Whitcroft if (defined($stat_real) && $cond_lines > 1) { 3323bb44ad39SAndy Whitcroft $stat_real = "[...]\n$stat_real"; 3324bb44ad39SAndy Whitcroft } 3325bb44ad39SAndy Whitcroft 3326000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3327000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr . $stat_real); 33288905a67cSAndy Whitcroft } 33298905a67cSAndy Whitcroft } 33308905a67cSAndy Whitcroft 333113214adfSAndy Whitcroft# Check for bitwise tests written as boolean 333213214adfSAndy Whitcroft if ($line =~ / 333313214adfSAndy Whitcroft (?: 333413214adfSAndy Whitcroft (?:\[|\(|\&\&|\|\|) 333513214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 333613214adfSAndy Whitcroft (?:\&\&|\|\|) 333713214adfSAndy Whitcroft | 333813214adfSAndy Whitcroft (?:\&\&|\|\|) 333913214adfSAndy Whitcroft \s*0[xX][0-9]+\s* 334013214adfSAndy Whitcroft (?:\&\&|\|\||\)|\]) 334113214adfSAndy Whitcroft )/x) 334213214adfSAndy Whitcroft { 3343000d1cc1SJoe Perches WARN("HEXADECIMAL_BOOLEAN_TEST", 3344000d1cc1SJoe Perches "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 334513214adfSAndy Whitcroft } 334613214adfSAndy Whitcroft 33478905a67cSAndy Whitcroft# if and else should not have general statements after it 334813214adfSAndy Whitcroft if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 334913214adfSAndy Whitcroft my $s = $1; 335013214adfSAndy Whitcroft $s =~ s/$;//g; # Remove any comments 335113214adfSAndy Whitcroft if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 3352000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3353000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 33540a920b5bSAndy Whitcroft } 335513214adfSAndy Whitcroft } 335639667782SAndy Whitcroft# if should not continue a brace 335739667782SAndy Whitcroft if ($line =~ /}\s*if\b/) { 3358000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3359000d1cc1SJoe Perches "trailing statements should be on next line\n" . 336039667782SAndy Whitcroft $herecurr); 336139667782SAndy Whitcroft } 3362a1080bf8SAndy Whitcroft# case and default should not have general statements after them 3363a1080bf8SAndy Whitcroft if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 3364a1080bf8SAndy Whitcroft $line !~ /\G(?: 33653fef12d6SAndy Whitcroft (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 3366a1080bf8SAndy Whitcroft \s*return\s+ 3367a1080bf8SAndy Whitcroft )/xg) 3368a1080bf8SAndy Whitcroft { 3369000d1cc1SJoe Perches ERROR("TRAILING_STATEMENTS", 3370000d1cc1SJoe Perches "trailing statements should be on next line\n" . $herecurr); 3371a1080bf8SAndy Whitcroft } 33720a920b5bSAndy Whitcroft 33730a920b5bSAndy Whitcroft # Check for }<nl>else {, these must be at the same 33740a920b5bSAndy Whitcroft # indent level to be relevant to each other. 33750a920b5bSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 33760a920b5bSAndy Whitcroft $previndent == $indent) { 3377000d1cc1SJoe Perches ERROR("ELSE_AFTER_BRACE", 3378000d1cc1SJoe Perches "else should follow close brace '}'\n" . $hereprev); 33790a920b5bSAndy Whitcroft } 33800a920b5bSAndy Whitcroft 3381c2fdda0dSAndy Whitcroft if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 3382c2fdda0dSAndy Whitcroft $previndent == $indent) { 3383c2fdda0dSAndy Whitcroft my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 3384c2fdda0dSAndy Whitcroft 3385c2fdda0dSAndy Whitcroft # Find out what is on the end of the line after the 3386c2fdda0dSAndy Whitcroft # conditional. 3387773647a0SAndy Whitcroft substr($s, 0, length($c), ''); 3388c2fdda0dSAndy Whitcroft $s =~ s/\n.*//g; 3389c2fdda0dSAndy Whitcroft 3390c2fdda0dSAndy Whitcroft if ($s =~ /^\s*;/) { 3391000d1cc1SJoe Perches ERROR("WHILE_AFTER_BRACE", 3392000d1cc1SJoe Perches "while should follow close brace '}'\n" . $hereprev); 3393c2fdda0dSAndy Whitcroft } 3394c2fdda0dSAndy Whitcroft } 3395c2fdda0dSAndy Whitcroft 339695e2c602SJoe Perches#Specific variable tests 3397323c1260SJoe Perches while ($line =~ m{($Constant|$Lval)}g) { 3398323c1260SJoe Perches my $var = $1; 339995e2c602SJoe Perches 340095e2c602SJoe Perches#gcc binary extension 340195e2c602SJoe Perches if ($var =~ /^$Binary$/) { 3402d5e616fcSJoe Perches if (WARN("GCC_BINARY_CONSTANT", 3403d5e616fcSJoe Perches "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) && 3404d5e616fcSJoe Perches $fix) { 3405d5e616fcSJoe Perches my $hexval = sprintf("0x%x", oct($var)); 3406d5e616fcSJoe Perches $fixed[$linenr - 1] =~ 3407d5e616fcSJoe Perches s/\b$var\b/$hexval/; 3408d5e616fcSJoe Perches } 340995e2c602SJoe Perches } 341095e2c602SJoe Perches 341195e2c602SJoe Perches#CamelCase 3412807bd26cSJoe Perches if ($var !~ /^$Constant$/ && 3413be79794bSJoe Perches $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 341422735ce8SJoe Perches#Ignore Page<foo> variants 3415807bd26cSJoe Perches $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 341622735ce8SJoe Perches#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show) 34173445686aSJoe Perches $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) { 34187e781f67SJoe Perches while ($var =~ m{($Ident)}g) { 34197e781f67SJoe Perches my $word = $1; 34207e781f67SJoe Perches next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 3421d8b07710SJoe Perches if ($check) { 3422d8b07710SJoe Perches seed_camelcase_includes(); 3423d8b07710SJoe Perches if (!$file && !$camelcase_file_seeded) { 3424d8b07710SJoe Perches seed_camelcase_file($realfile); 3425d8b07710SJoe Perches $camelcase_file_seeded = 1; 3426d8b07710SJoe Perches } 3427d8b07710SJoe Perches } 34287e781f67SJoe Perches if (!defined $camelcase{$word}) { 34297e781f67SJoe Perches $camelcase{$word} = 1; 3430be79794bSJoe Perches CHK("CAMELCASE", 34317e781f67SJoe Perches "Avoid CamelCase: <$word>\n" . $herecurr); 34327e781f67SJoe Perches } 3433323c1260SJoe Perches } 3434323c1260SJoe Perches } 34353445686aSJoe Perches } 34360a920b5bSAndy Whitcroft 34370a920b5bSAndy Whitcroft#no spaces allowed after \ in define 3438d5e616fcSJoe Perches if ($line =~ /\#\s*define.*\\\s+$/) { 3439d5e616fcSJoe Perches if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 3440d5e616fcSJoe Perches "Whitespace after \\ makes next lines useless\n" . $herecurr) && 3441d5e616fcSJoe Perches $fix) { 3442d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\s+$//; 3443d5e616fcSJoe Perches } 34440a920b5bSAndy Whitcroft } 34450a920b5bSAndy Whitcroft 3446653d4876SAndy Whitcroft#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) 3447c45dcabdSAndy Whitcroft if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 3448e09dec48SAndy Whitcroft my $file = "$1.h"; 3449e09dec48SAndy Whitcroft my $checkfile = "include/linux/$file"; 3450e09dec48SAndy Whitcroft if (-f "$root/$checkfile" && 3451e09dec48SAndy Whitcroft $realfile ne $checkfile && 34527840a94cSWolfram Sang $1 !~ /$allowed_asm_includes/) 3453c45dcabdSAndy Whitcroft { 3454e09dec48SAndy Whitcroft if ($realfile =~ m{^arch/}) { 3455000d1cc1SJoe Perches CHK("ARCH_INCLUDE_LINUX", 3456000d1cc1SJoe Perches "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3457e09dec48SAndy Whitcroft } else { 3458000d1cc1SJoe Perches WARN("INCLUDE_LINUX", 3459000d1cc1SJoe Perches "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 3460e09dec48SAndy Whitcroft } 34610a920b5bSAndy Whitcroft } 34620a920b5bSAndy Whitcroft } 34630a920b5bSAndy Whitcroft 3464653d4876SAndy Whitcroft# multi-statement macros should be enclosed in a do while loop, grab the 3465653d4876SAndy Whitcroft# first statement and ensure its the whole macro if its not enclosed 3466cf655043SAndy Whitcroft# in a known good container 3467b8f96a31SAndy Whitcroft if ($realfile !~ m@/vmlinux.lds.h$@ && 3468b8f96a31SAndy Whitcroft $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 3469d8aaf121SAndy Whitcroft my $ln = $linenr; 3470d8aaf121SAndy Whitcroft my $cnt = $realcnt; 3471c45dcabdSAndy Whitcroft my ($off, $dstat, $dcond, $rest); 3472c45dcabdSAndy Whitcroft my $ctx = ''; 3473c45dcabdSAndy Whitcroft ($dstat, $dcond, $ln, $cnt, $off) = 3474f74bd194SAndy Whitcroft ctx_statement_block($linenr, $realcnt, 0); 3475f74bd194SAndy Whitcroft $ctx = $dstat; 3476c45dcabdSAndy Whitcroft #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 3477a3bb97a7SAndy Whitcroft #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 3478c45dcabdSAndy Whitcroft 3479f74bd194SAndy Whitcroft $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; 3480292f1a9bSAndy Whitcroft $dstat =~ s/$;//g; 3481c45dcabdSAndy Whitcroft $dstat =~ s/\\\n.//g; 3482c45dcabdSAndy Whitcroft $dstat =~ s/^\s*//s; 3483c45dcabdSAndy Whitcroft $dstat =~ s/\s*$//s; 3484c45dcabdSAndy Whitcroft 3485c45dcabdSAndy Whitcroft # Flatten any parentheses and braces 3486bf30d6edSAndy Whitcroft while ($dstat =~ s/\([^\(\)]*\)/1/ || 3487bf30d6edSAndy Whitcroft $dstat =~ s/\{[^\{\}]*\}/1/ || 3488c81769fdSAndy Whitcroft $dstat =~ s/\[[^\[\]]*\]/1/) 3489bf30d6edSAndy Whitcroft { 3490c45dcabdSAndy Whitcroft } 3491c45dcabdSAndy Whitcroft 3492e45bab8eSAndy Whitcroft # Flatten any obvious string concatentation. 3493e45bab8eSAndy Whitcroft while ($dstat =~ s/("X*")\s*$Ident/$1/ || 3494e45bab8eSAndy Whitcroft $dstat =~ s/$Ident\s*("X*")/$1/) 3495e45bab8eSAndy Whitcroft { 3496e45bab8eSAndy Whitcroft } 3497e45bab8eSAndy Whitcroft 3498c45dcabdSAndy Whitcroft my $exceptions = qr{ 3499c45dcabdSAndy Whitcroft $Declare| 3500c45dcabdSAndy Whitcroft module_param_named| 3501a0a0a7a9SKees Cook MODULE_PARM_DESC| 3502c45dcabdSAndy Whitcroft DECLARE_PER_CPU| 3503c45dcabdSAndy Whitcroft DEFINE_PER_CPU| 3504383099fdSAndy Whitcroft __typeof__\(| 350522fd2d3eSStefani Seibold union| 350622fd2d3eSStefani Seibold struct| 3507ea71a0a0SAndy Whitcroft \.$Ident\s*=\s*| 3508ea71a0a0SAndy Whitcroft ^\"|\"$ 3509c45dcabdSAndy Whitcroft }x; 35105eaa20b9SAndy Whitcroft #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 3511f74bd194SAndy Whitcroft if ($dstat ne '' && 3512f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 3513f74bd194SAndy Whitcroft $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 35143cc4b1c3SJoe Perches $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 3515b9df76acSAndy Whitcroft $dstat !~ /^'X'$/ && # character constants 3516f74bd194SAndy Whitcroft $dstat !~ /$exceptions/ && 3517f74bd194SAndy Whitcroft $dstat !~ /^\.$Ident\s*=/ && # .foo = 3518e942e2c3SJoe Perches $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 351972f115f9SAndy Whitcroft $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 3520f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant$/ && # for (...) 3521f74bd194SAndy Whitcroft $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 3522f74bd194SAndy Whitcroft $dstat !~ /^do\s*{/ && # do {... 3523f95a7e6aSJoe Perches $dstat !~ /^\({/ && # ({... 3524f95a7e6aSJoe Perches $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 3525c45dcabdSAndy Whitcroft { 3526f74bd194SAndy Whitcroft $ctx =~ s/\n*$//; 3527f74bd194SAndy Whitcroft my $herectx = $here . "\n"; 3528f74bd194SAndy Whitcroft my $cnt = statement_rawlines($ctx); 3529f74bd194SAndy Whitcroft 3530f74bd194SAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 3531f74bd194SAndy Whitcroft $herectx .= raw_line($linenr, $n) . "\n"; 3532c45dcabdSAndy Whitcroft } 3533c45dcabdSAndy Whitcroft 3534f74bd194SAndy Whitcroft if ($dstat =~ /;/) { 3535f74bd194SAndy Whitcroft ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 3536f74bd194SAndy Whitcroft "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 3537f74bd194SAndy Whitcroft } else { 3538000d1cc1SJoe Perches ERROR("COMPLEX_MACRO", 3539f74bd194SAndy Whitcroft "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); 3540d8aaf121SAndy Whitcroft } 35410a920b5bSAndy Whitcroft } 35425023d347SJoe Perches 3543481eb486SJoe Perches# check for line continuations outside of #defines, preprocessor #, and asm 35445023d347SJoe Perches 35455023d347SJoe Perches } else { 35465023d347SJoe Perches if ($prevline !~ /^..*\\$/ && 3547481eb486SJoe Perches $line !~ /^\+\s*\#.*\\$/ && # preprocessor 3548481eb486SJoe Perches $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 35495023d347SJoe Perches $line =~ /^\+.*\\$/) { 35505023d347SJoe Perches WARN("LINE_CONTINUATIONS", 35515023d347SJoe Perches "Avoid unnecessary line continuations\n" . $herecurr); 35525023d347SJoe Perches } 3553653d4876SAndy Whitcroft } 35540a920b5bSAndy Whitcroft 3555b13edf7fSJoe Perches# do {} while (0) macro tests: 3556b13edf7fSJoe Perches# single-statement macros do not need to be enclosed in do while (0) loop, 3557b13edf7fSJoe Perches# macro should not end with a semicolon 3558b13edf7fSJoe Perches if ($^V && $^V ge 5.10.0 && 3559b13edf7fSJoe Perches $realfile !~ m@/vmlinux.lds.h$@ && 3560b13edf7fSJoe Perches $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 3561b13edf7fSJoe Perches my $ln = $linenr; 3562b13edf7fSJoe Perches my $cnt = $realcnt; 3563b13edf7fSJoe Perches my ($off, $dstat, $dcond, $rest); 3564b13edf7fSJoe Perches my $ctx = ''; 3565b13edf7fSJoe Perches ($dstat, $dcond, $ln, $cnt, $off) = 3566b13edf7fSJoe Perches ctx_statement_block($linenr, $realcnt, 0); 3567b13edf7fSJoe Perches $ctx = $dstat; 3568b13edf7fSJoe Perches 3569b13edf7fSJoe Perches $dstat =~ s/\\\n.//g; 3570b13edf7fSJoe Perches 3571b13edf7fSJoe Perches if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 3572b13edf7fSJoe Perches my $stmts = $2; 3573b13edf7fSJoe Perches my $semis = $3; 3574b13edf7fSJoe Perches 3575b13edf7fSJoe Perches $ctx =~ s/\n*$//; 3576b13edf7fSJoe Perches my $cnt = statement_rawlines($ctx); 3577b13edf7fSJoe Perches my $herectx = $here . "\n"; 3578b13edf7fSJoe Perches 3579b13edf7fSJoe Perches for (my $n = 0; $n < $cnt; $n++) { 3580b13edf7fSJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 3581b13edf7fSJoe Perches } 3582b13edf7fSJoe Perches 3583ac8e97f8SJoe Perches if (($stmts =~ tr/;/;/) == 1 && 3584ac8e97f8SJoe Perches $stmts !~ /^\s*(if|while|for|switch)\b/) { 3585b13edf7fSJoe Perches WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 3586b13edf7fSJoe Perches "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 3587b13edf7fSJoe Perches } 3588b13edf7fSJoe Perches if (defined $semis && $semis ne "") { 3589b13edf7fSJoe Perches WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 3590b13edf7fSJoe Perches "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 3591b13edf7fSJoe Perches } 3592b13edf7fSJoe Perches } 3593b13edf7fSJoe Perches } 3594b13edf7fSJoe Perches 3595080ba929SMike Frysinger# make sure symbols are always wrapped with VMLINUX_SYMBOL() ... 3596080ba929SMike Frysinger# all assignments may have only one of the following with an assignment: 3597080ba929SMike Frysinger# . 3598080ba929SMike Frysinger# ALIGN(...) 3599080ba929SMike Frysinger# VMLINUX_SYMBOL(...) 3600080ba929SMike Frysinger if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { 3601000d1cc1SJoe Perches WARN("MISSING_VMLINUX_SYMBOL", 3602000d1cc1SJoe Perches "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); 3603080ba929SMike Frysinger } 3604080ba929SMike Frysinger 3605f0a594c1SAndy Whitcroft# check for redundant bracing round if etc 360613214adfSAndy Whitcroft if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 360713214adfSAndy Whitcroft my ($level, $endln, @chunks) = 3608cf655043SAndy Whitcroft ctx_statement_full($linenr, $realcnt, 1); 360913214adfSAndy Whitcroft #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 3610cf655043SAndy Whitcroft #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 3611cf655043SAndy Whitcroft if ($#chunks > 0 && $level == 0) { 3612aad4f614SJoe Perches my @allowed = (); 3613aad4f614SJoe Perches my $allow = 0; 361413214adfSAndy Whitcroft my $seen = 0; 3615773647a0SAndy Whitcroft my $herectx = $here . "\n"; 3616cf655043SAndy Whitcroft my $ln = $linenr - 1; 361713214adfSAndy Whitcroft for my $chunk (@chunks) { 361813214adfSAndy Whitcroft my ($cond, $block) = @{$chunk}; 361913214adfSAndy Whitcroft 3620773647a0SAndy Whitcroft # If the condition carries leading newlines, then count those as offsets. 3621773647a0SAndy Whitcroft my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 3622773647a0SAndy Whitcroft my $offset = statement_rawlines($whitespace) - 1; 3623773647a0SAndy Whitcroft 3624aad4f614SJoe Perches $allowed[$allow] = 0; 3625773647a0SAndy Whitcroft #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 3626773647a0SAndy Whitcroft 3627773647a0SAndy Whitcroft # We have looked at and allowed this specific line. 3628773647a0SAndy Whitcroft $suppress_ifbraces{$ln + $offset} = 1; 3629773647a0SAndy Whitcroft 3630773647a0SAndy Whitcroft $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 3631cf655043SAndy Whitcroft $ln += statement_rawlines($block) - 1; 3632cf655043SAndy Whitcroft 3633773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 363413214adfSAndy Whitcroft 363513214adfSAndy Whitcroft $seen++ if ($block =~ /^\s*{/); 363613214adfSAndy Whitcroft 3637aad4f614SJoe Perches #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 3638cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3639cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3640aad4f614SJoe Perches $allowed[$allow] = 1; 364113214adfSAndy Whitcroft } 364213214adfSAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3643cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3644aad4f614SJoe Perches $allowed[$allow] = 1; 364513214adfSAndy Whitcroft } 3646cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3647cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3648aad4f614SJoe Perches $allowed[$allow] = 1; 364913214adfSAndy Whitcroft } 3650aad4f614SJoe Perches $allow++; 365113214adfSAndy Whitcroft } 3652aad4f614SJoe Perches if ($seen) { 3653aad4f614SJoe Perches my $sum_allowed = 0; 3654aad4f614SJoe Perches foreach (@allowed) { 3655aad4f614SJoe Perches $sum_allowed += $_; 3656aad4f614SJoe Perches } 3657aad4f614SJoe Perches if ($sum_allowed == 0) { 3658000d1cc1SJoe Perches WARN("BRACES", 3659000d1cc1SJoe Perches "braces {} are not necessary for any arm of this statement\n" . $herectx); 3660aad4f614SJoe Perches } elsif ($sum_allowed != $allow && 3661aad4f614SJoe Perches $seen != $allow) { 3662aad4f614SJoe Perches CHK("BRACES", 3663aad4f614SJoe Perches "braces {} should be used on all arms of this statement\n" . $herectx); 3664aad4f614SJoe Perches } 366513214adfSAndy Whitcroft } 366613214adfSAndy Whitcroft } 366713214adfSAndy Whitcroft } 3668773647a0SAndy Whitcroft if (!defined $suppress_ifbraces{$linenr - 1} && 366913214adfSAndy Whitcroft $line =~ /\b(if|while|for|else)\b/) { 3670cf655043SAndy Whitcroft my $allowed = 0; 3671f0a594c1SAndy Whitcroft 3672cf655043SAndy Whitcroft # Check the pre-context. 3673cf655043SAndy Whitcroft if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 3674cf655043SAndy Whitcroft #print "APW: ALLOWED: pre<$1>\n"; 3675cf655043SAndy Whitcroft $allowed = 1; 3676f0a594c1SAndy Whitcroft } 3677773647a0SAndy Whitcroft 3678773647a0SAndy Whitcroft my ($level, $endln, @chunks) = 3679773647a0SAndy Whitcroft ctx_statement_full($linenr, $realcnt, $-[0]); 3680773647a0SAndy Whitcroft 3681cf655043SAndy Whitcroft # Check the condition. 3682cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[0]}; 3683773647a0SAndy Whitcroft #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 3684cf655043SAndy Whitcroft if (defined $cond) { 3685773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3686cf655043SAndy Whitcroft } 3687cf655043SAndy Whitcroft if (statement_lines($cond) > 1) { 3688cf655043SAndy Whitcroft #print "APW: ALLOWED: cond<$cond>\n"; 3689cf655043SAndy Whitcroft $allowed = 1; 3690cf655043SAndy Whitcroft } 3691cf655043SAndy Whitcroft if ($block =~/\b(?:if|for|while)\b/) { 3692cf655043SAndy Whitcroft #print "APW: ALLOWED: block<$block>\n"; 3693cf655043SAndy Whitcroft $allowed = 1; 3694cf655043SAndy Whitcroft } 3695cf655043SAndy Whitcroft if (statement_block_size($block) > 1) { 3696cf655043SAndy Whitcroft #print "APW: ALLOWED: lines block<$block>\n"; 3697cf655043SAndy Whitcroft $allowed = 1; 3698cf655043SAndy Whitcroft } 3699cf655043SAndy Whitcroft # Check the post-context. 3700cf655043SAndy Whitcroft if (defined $chunks[1]) { 3701cf655043SAndy Whitcroft my ($cond, $block) = @{$chunks[1]}; 3702cf655043SAndy Whitcroft if (defined $cond) { 3703773647a0SAndy Whitcroft substr($block, 0, length($cond), ''); 3704cf655043SAndy Whitcroft } 3705cf655043SAndy Whitcroft if ($block =~ /^\s*\{/) { 3706cf655043SAndy Whitcroft #print "APW: ALLOWED: chunk-1 block<$block>\n"; 3707cf655043SAndy Whitcroft $allowed = 1; 3708cf655043SAndy Whitcroft } 3709cf655043SAndy Whitcroft } 3710cf655043SAndy Whitcroft if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 371169932487SJustin P. Mattock my $herectx = $here . "\n"; 3712f055663cSAndy Whitcroft my $cnt = statement_rawlines($block); 3713cf655043SAndy Whitcroft 3714f055663cSAndy Whitcroft for (my $n = 0; $n < $cnt; $n++) { 371569932487SJustin P. Mattock $herectx .= raw_line($linenr, $n) . "\n"; 3716cf655043SAndy Whitcroft } 3717cf655043SAndy Whitcroft 3718000d1cc1SJoe Perches WARN("BRACES", 3719000d1cc1SJoe Perches "braces {} are not necessary for single statement blocks\n" . $herectx); 3720f0a594c1SAndy Whitcroft } 3721f0a594c1SAndy Whitcroft } 3722f0a594c1SAndy Whitcroft 37230979ae66SJoe Perches# check for unnecessary blank lines around braces 372477b9a53aSJoe Perches if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 37250979ae66SJoe Perches CHK("BRACES", 37260979ae66SJoe Perches "Blank lines aren't necessary before a close brace '}'\n" . $hereprev); 37270979ae66SJoe Perches } 372877b9a53aSJoe Perches if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 37290979ae66SJoe Perches CHK("BRACES", 37300979ae66SJoe Perches "Blank lines aren't necessary after an open brace '{'\n" . $hereprev); 37310979ae66SJoe Perches } 37320979ae66SJoe Perches 37334a0df2efSAndy Whitcroft# no volatiles please 37346c72ffaaSAndy Whitcroft my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 37356c72ffaaSAndy Whitcroft if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 3736000d1cc1SJoe Perches WARN("VOLATILE", 3737000d1cc1SJoe Perches "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); 37384a0df2efSAndy Whitcroft } 37394a0df2efSAndy Whitcroft 374000df344fSAndy Whitcroft# warn about #if 0 3741c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*if\s+0\b/) { 3742000d1cc1SJoe Perches CHK("REDUNDANT_CODE", 3743000d1cc1SJoe Perches "if this code is redundant consider removing it\n" . 3744de7d4f0eSAndy Whitcroft $herecurr); 37454a0df2efSAndy Whitcroft } 37464a0df2efSAndy Whitcroft 374703df4b51SAndy Whitcroft# check for needless "if (<foo>) fn(<foo>)" uses 374803df4b51SAndy Whitcroft if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 374903df4b51SAndy Whitcroft my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;'; 375003df4b51SAndy Whitcroft if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) { 375103df4b51SAndy Whitcroft WARN('NEEDLESS_IF', 375203df4b51SAndy Whitcroft "$1(NULL) is safe this check is probably not required\n" . $hereprev); 37534c432a8fSGreg Kroah-Hartman } 37544c432a8fSGreg Kroah-Hartman } 3755f0a594c1SAndy Whitcroft 37568716de38SJoe Perches# check for bad placement of section $InitAttribute (e.g.: __initdata) 37578716de38SJoe Perches if ($line =~ /(\b$InitAttribute\b)/) { 37588716de38SJoe Perches my $attr = $1; 37598716de38SJoe Perches if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 37608716de38SJoe Perches my $ptr = $1; 37618716de38SJoe Perches my $var = $2; 37628716de38SJoe Perches if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 37638716de38SJoe Perches ERROR("MISPLACED_INIT", 37648716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr)) || 37658716de38SJoe Perches ($ptr !~ /\b(union|struct)\s+$attr\b/ && 37668716de38SJoe Perches WARN("MISPLACED_INIT", 37678716de38SJoe Perches "$attr should be placed after $var\n" . $herecurr))) && 37688716de38SJoe Perches $fix) { 37698716de38SJoe Perches $fixed[$linenr - 1] =~ 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; 37708716de38SJoe Perches } 37718716de38SJoe Perches } 37728716de38SJoe Perches } 37738716de38SJoe Perches 3774e970b884SJoe Perches# check for $InitAttributeData (ie: __initdata) with const 3775e970b884SJoe Perches if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 3776e970b884SJoe Perches my $attr = $1; 3777e970b884SJoe Perches $attr =~ /($InitAttributePrefix)(.*)/; 3778e970b884SJoe Perches my $attr_prefix = $1; 3779e970b884SJoe Perches my $attr_type = $2; 3780e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 3781e970b884SJoe Perches "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 3782e970b884SJoe Perches $fix) { 3783e970b884SJoe Perches $fixed[$linenr - 1] =~ 3784e970b884SJoe Perches s/$InitAttributeData/${attr_prefix}initconst/; 3785e970b884SJoe Perches } 3786e970b884SJoe Perches } 3787e970b884SJoe Perches 3788e970b884SJoe Perches# check for $InitAttributeConst (ie: __initconst) without const 3789e970b884SJoe Perches if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 3790e970b884SJoe Perches my $attr = $1; 3791e970b884SJoe Perches if (ERROR("INIT_ATTRIBUTE", 3792e970b884SJoe Perches "Use of $attr requires a separate use of const\n" . $herecurr) && 3793e970b884SJoe Perches $fix) { 3794e970b884SJoe Perches my $lead = $fixed[$linenr - 1] =~ 3795e970b884SJoe Perches /(^\+\s*(?:static\s+))/; 3796e970b884SJoe Perches $lead = rtrim($1); 3797e970b884SJoe Perches $lead = "$lead " if ($lead !~ /^\+$/); 3798e970b884SJoe Perches $lead = "${lead}const "; 3799e970b884SJoe Perches $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/; 3800e970b884SJoe Perches } 3801e970b884SJoe Perches } 3802e970b884SJoe Perches 38031a15a250SPatrick Pannuto# prefer usleep_range over udelay 380437581c28SBruce Allan if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 38051a15a250SPatrick Pannuto # ignore udelay's < 10, however 380637581c28SBruce Allan if (! ($1 < 10) ) { 3807000d1cc1SJoe Perches CHK("USLEEP_RANGE", 3808000d1cc1SJoe Perches "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); 38091a15a250SPatrick Pannuto } 38101a15a250SPatrick Pannuto } 38111a15a250SPatrick Pannuto 381209ef8725SPatrick Pannuto# warn about unexpectedly long msleep's 381309ef8725SPatrick Pannuto if ($line =~ /\bmsleep\s*\((\d+)\);/) { 381409ef8725SPatrick Pannuto if ($1 < 20) { 3815000d1cc1SJoe Perches WARN("MSLEEP", 3816000d1cc1SJoe Perches "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); 381709ef8725SPatrick Pannuto } 381809ef8725SPatrick Pannuto } 381909ef8725SPatrick Pannuto 382036ec1939SJoe Perches# check for comparisons of jiffies 382136ec1939SJoe Perches if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 382236ec1939SJoe Perches WARN("JIFFIES_COMPARISON", 382336ec1939SJoe Perches "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 382436ec1939SJoe Perches } 382536ec1939SJoe Perches 38269d7a34a5SJoe Perches# check for comparisons of get_jiffies_64() 38279d7a34a5SJoe Perches if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 38289d7a34a5SJoe Perches WARN("JIFFIES_COMPARISON", 38299d7a34a5SJoe Perches "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 38309d7a34a5SJoe Perches } 38319d7a34a5SJoe Perches 383200df344fSAndy Whitcroft# warn about #ifdefs in C files 3833c45dcabdSAndy Whitcroft# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 383400df344fSAndy Whitcroft# print "#ifdef in C files should be avoided\n"; 383500df344fSAndy Whitcroft# print "$herecurr"; 383600df344fSAndy Whitcroft# $clean = 0; 383700df344fSAndy Whitcroft# } 383800df344fSAndy Whitcroft 383922f2a2efSAndy Whitcroft# warn about spacing in #ifdefs 3840c45dcabdSAndy Whitcroft if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 38413705ce5bSJoe Perches if (ERROR("SPACING", 38423705ce5bSJoe Perches "exactly one space required after that #$1\n" . $herecurr) && 38433705ce5bSJoe Perches $fix) { 38443705ce5bSJoe Perches $fixed[$linenr - 1] =~ 38453705ce5bSJoe Perches s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 38463705ce5bSJoe Perches } 38473705ce5bSJoe Perches 384822f2a2efSAndy Whitcroft } 384922f2a2efSAndy Whitcroft 38504a0df2efSAndy Whitcroft# check for spinlock_t definitions without a comment. 3851171ae1a4SAndy Whitcroft if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 3852171ae1a4SAndy Whitcroft $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 38534a0df2efSAndy Whitcroft my $which = $1; 38544a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3855000d1cc1SJoe Perches CHK("UNCOMMENTED_DEFINITION", 3856000d1cc1SJoe Perches "$1 definition without comment\n" . $herecurr); 38574a0df2efSAndy Whitcroft } 38584a0df2efSAndy Whitcroft } 38594a0df2efSAndy Whitcroft# check for memory barriers without a comment. 38604a0df2efSAndy Whitcroft if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 38614a0df2efSAndy Whitcroft if (!ctx_has_comment($first_line, $linenr)) { 3862c1fd7bb9SJoe Perches WARN("MEMORY_BARRIER", 3863000d1cc1SJoe Perches "memory barrier without comment\n" . $herecurr); 38644a0df2efSAndy Whitcroft } 38654a0df2efSAndy Whitcroft } 38664a0df2efSAndy Whitcroft# check of hardware specific defines 3867c45dcabdSAndy Whitcroft if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 3868000d1cc1SJoe Perches CHK("ARCH_DEFINES", 3869000d1cc1SJoe Perches "architecture specific defines should be avoided\n" . $herecurr); 38700a920b5bSAndy Whitcroft } 3871653d4876SAndy Whitcroft 3872d4977c78STobias Klauser# Check that the storage class is at the beginning of a declaration 3873d4977c78STobias Klauser if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 3874000d1cc1SJoe Perches WARN("STORAGE_CLASS", 3875000d1cc1SJoe Perches "storage class should be at the beginning of the declaration\n" . $herecurr) 3876d4977c78STobias Klauser } 3877d4977c78STobias Klauser 3878de7d4f0eSAndy Whitcroft# check the location of the inline attribute, that it is between 3879de7d4f0eSAndy Whitcroft# storage class and type. 38809c0ca6f9SAndy Whitcroft if ($line =~ /\b$Type\s+$Inline\b/ || 38819c0ca6f9SAndy Whitcroft $line =~ /\b$Inline\s+$Storage\b/) { 3882000d1cc1SJoe Perches ERROR("INLINE_LOCATION", 3883000d1cc1SJoe Perches "inline keyword should sit between storage class and type\n" . $herecurr); 3884de7d4f0eSAndy Whitcroft } 3885de7d4f0eSAndy Whitcroft 38868905a67cSAndy Whitcroft# Check for __inline__ and __inline, prefer inline 38872b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 38882b7ab453SJoe Perches $line =~ /\b(__inline__|__inline)\b/) { 3889d5e616fcSJoe Perches if (WARN("INLINE", 3890d5e616fcSJoe Perches "plain inline is preferred over $1\n" . $herecurr) && 3891d5e616fcSJoe Perches $fix) { 3892d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/; 3893d5e616fcSJoe Perches 3894d5e616fcSJoe Perches } 38958905a67cSAndy Whitcroft } 38968905a67cSAndy Whitcroft 38973d130fd0SJoe Perches# Check for __attribute__ packed, prefer __packed 38982b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 38992b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { 3900000d1cc1SJoe Perches WARN("PREFER_PACKED", 3901000d1cc1SJoe Perches "__packed is preferred over __attribute__((packed))\n" . $herecurr); 39023d130fd0SJoe Perches } 39033d130fd0SJoe Perches 390439b7e287SJoe Perches# Check for __attribute__ aligned, prefer __aligned 39052b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 39062b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { 3907000d1cc1SJoe Perches WARN("PREFER_ALIGNED", 3908000d1cc1SJoe Perches "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); 390939b7e287SJoe Perches } 391039b7e287SJoe Perches 39115f14d3bdSJoe Perches# Check for __attribute__ format(printf, prefer __printf 39122b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 39132b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { 3914d5e616fcSJoe Perches if (WARN("PREFER_PRINTF", 3915d5e616fcSJoe Perches "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) && 3916d5e616fcSJoe Perches $fix) { 3917d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex; 3918d5e616fcSJoe Perches 3919d5e616fcSJoe Perches } 39205f14d3bdSJoe Perches } 39215f14d3bdSJoe Perches 39226061d949SJoe Perches# Check for __attribute__ format(scanf, prefer __scanf 39232b7ab453SJoe Perches if ($realfile !~ m@\binclude/uapi/@ && 39242b7ab453SJoe Perches $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) { 3925d5e616fcSJoe Perches if (WARN("PREFER_SCANF", 3926d5e616fcSJoe Perches "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) && 3927d5e616fcSJoe Perches $fix) { 3928d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex; 3929d5e616fcSJoe Perches } 39306061d949SJoe Perches } 39316061d949SJoe Perches 39328f53a9b8SJoe Perches# check for sizeof(&) 39338f53a9b8SJoe Perches if ($line =~ /\bsizeof\s*\(\s*\&/) { 3934000d1cc1SJoe Perches WARN("SIZEOF_ADDRESS", 3935000d1cc1SJoe Perches "sizeof(& should be avoided\n" . $herecurr); 39368f53a9b8SJoe Perches } 39378f53a9b8SJoe Perches 393866c80b60SJoe Perches# check for sizeof without parenthesis 393966c80b60SJoe Perches if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 3940d5e616fcSJoe Perches if (WARN("SIZEOF_PARENTHESIS", 3941d5e616fcSJoe Perches "sizeof $1 should be sizeof($1)\n" . $herecurr) && 3942d5e616fcSJoe Perches $fix) { 3943d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 3944d5e616fcSJoe Perches } 394566c80b60SJoe Perches } 394666c80b60SJoe Perches 3947428e2fdcSJoe Perches# check for line continuations in quoted strings with odd counts of " 3948428e2fdcSJoe Perches if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { 3949000d1cc1SJoe Perches WARN("LINE_CONTINUATIONS", 3950000d1cc1SJoe Perches "Avoid line continuations in quoted strings\n" . $herecurr); 3951428e2fdcSJoe Perches } 3952428e2fdcSJoe Perches 395388982feaSJoe Perches# check for struct spinlock declarations 395488982feaSJoe Perches if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 395588982feaSJoe Perches WARN("USE_SPINLOCK_T", 395688982feaSJoe Perches "struct spinlock should be spinlock_t\n" . $herecurr); 395788982feaSJoe Perches } 395888982feaSJoe Perches 3959a6962d72SJoe Perches# check for seq_printf uses that could be seq_puts 396006668727SJoe Perches if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 3961a6962d72SJoe Perches my $fmt = get_quoted_string($line, $rawline); 396206668727SJoe Perches if ($fmt ne "" && $fmt !~ /[^\\]\%/) { 3963d5e616fcSJoe Perches if (WARN("PREFER_SEQ_PUTS", 3964d5e616fcSJoe Perches "Prefer seq_puts to seq_printf\n" . $herecurr) && 3965d5e616fcSJoe Perches $fix) { 3966d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/; 3967d5e616fcSJoe Perches } 3968a6962d72SJoe Perches } 3969a6962d72SJoe Perches } 3970a6962d72SJoe Perches 3971554e165cSAndy Whitcroft# Check for misused memsets 3972d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3973d1fe9c09SJoe Perches defined $stat && 3974d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { 3975554e165cSAndy Whitcroft 3976d7c76ba7SJoe Perches my $ms_addr = $2; 3977d1fe9c09SJoe Perches my $ms_val = $7; 3978d1fe9c09SJoe Perches my $ms_size = $12; 3979d7c76ba7SJoe Perches 3980554e165cSAndy Whitcroft if ($ms_size =~ /^(0x|)0$/i) { 3981554e165cSAndy Whitcroft ERROR("MEMSET", 3982d7c76ba7SJoe Perches "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 3983554e165cSAndy Whitcroft } elsif ($ms_size =~ /^(0x|)1$/i) { 3984554e165cSAndy Whitcroft WARN("MEMSET", 3985d7c76ba7SJoe Perches "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 3986d7c76ba7SJoe Perches } 3987d7c76ba7SJoe Perches } 3988d7c76ba7SJoe Perches 3989d7c76ba7SJoe Perches# typecasts on min/max could be min_t/max_t 3990d1fe9c09SJoe Perches if ($^V && $^V ge 5.10.0 && 3991d1fe9c09SJoe Perches defined $stat && 3992d7c76ba7SJoe Perches $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 3993d1fe9c09SJoe Perches if (defined $2 || defined $7) { 3994d7c76ba7SJoe Perches my $call = $1; 3995d7c76ba7SJoe Perches my $cast1 = deparenthesize($2); 3996d7c76ba7SJoe Perches my $arg1 = $3; 3997d1fe9c09SJoe Perches my $cast2 = deparenthesize($7); 3998d1fe9c09SJoe Perches my $arg2 = $8; 3999d7c76ba7SJoe Perches my $cast; 4000d7c76ba7SJoe Perches 4001d1fe9c09SJoe Perches if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 4002d7c76ba7SJoe Perches $cast = "$cast1 or $cast2"; 4003d7c76ba7SJoe Perches } elsif ($cast1 ne "") { 4004d7c76ba7SJoe Perches $cast = $cast1; 4005d7c76ba7SJoe Perches } else { 4006d7c76ba7SJoe Perches $cast = $cast2; 4007d7c76ba7SJoe Perches } 4008d7c76ba7SJoe Perches WARN("MINMAX", 4009d7c76ba7SJoe Perches "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 4010554e165cSAndy Whitcroft } 4011554e165cSAndy Whitcroft } 4012554e165cSAndy Whitcroft 40134a273195SJoe Perches# check usleep_range arguments 40144a273195SJoe Perches if ($^V && $^V ge 5.10.0 && 40154a273195SJoe Perches defined $stat && 40164a273195SJoe Perches $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 40174a273195SJoe Perches my $min = $1; 40184a273195SJoe Perches my $max = $7; 40194a273195SJoe Perches if ($min eq $max) { 40204a273195SJoe Perches WARN("USLEEP_RANGE", 40214a273195SJoe Perches "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 40224a273195SJoe Perches } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 40234a273195SJoe Perches $min > $max) { 40244a273195SJoe Perches WARN("USLEEP_RANGE", 40254a273195SJoe Perches "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n"); 40264a273195SJoe Perches } 40274a273195SJoe Perches } 40284a273195SJoe Perches 4029823b794cSJoe Perches# check for naked sscanf 4030823b794cSJoe Perches if ($^V && $^V ge 5.10.0 && 4031823b794cSJoe Perches defined $stat && 4032823b794cSJoe Perches $stat =~ /\bsscanf\b/ && 4033823b794cSJoe Perches ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 4034823b794cSJoe Perches $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 4035823b794cSJoe Perches $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 4036823b794cSJoe Perches my $lc = $stat =~ tr@\n@@; 4037823b794cSJoe Perches $lc = $lc + $linenr; 4038823b794cSJoe Perches my $stat_real = raw_line($linenr, 0); 4039823b794cSJoe Perches for (my $count = $linenr + 1; $count <= $lc; $count++) { 4040823b794cSJoe Perches $stat_real = $stat_real . "\n" . raw_line($count, 0); 4041823b794cSJoe Perches } 4042823b794cSJoe Perches WARN("NAKED_SSCANF", 4043823b794cSJoe Perches "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 4044823b794cSJoe Perches } 4045823b794cSJoe Perches 404670dc8a48SJoe Perches# check for new externs in .h files. 404770dc8a48SJoe Perches if ($realfile =~ /\.h$/ && 404870dc8a48SJoe Perches $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 4049d1d85780SJoe Perches if (CHK("AVOID_EXTERNS", 405070dc8a48SJoe Perches "extern prototypes should be avoided in .h files\n" . $herecurr) && 405170dc8a48SJoe Perches $fix) { 405270dc8a48SJoe Perches $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 405370dc8a48SJoe Perches } 405470dc8a48SJoe Perches } 405570dc8a48SJoe Perches 4056de7d4f0eSAndy Whitcroft# check for new externs in .c files. 4057171ae1a4SAndy Whitcroft if ($realfile =~ /\.c$/ && defined $stat && 4058c45dcabdSAndy Whitcroft $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 4059171ae1a4SAndy Whitcroft { 4060c45dcabdSAndy Whitcroft my $function_name = $1; 4061c45dcabdSAndy Whitcroft my $paren_space = $2; 4062171ae1a4SAndy Whitcroft 4063171ae1a4SAndy Whitcroft my $s = $stat; 4064171ae1a4SAndy Whitcroft if (defined $cond) { 4065171ae1a4SAndy Whitcroft substr($s, 0, length($cond), ''); 4066171ae1a4SAndy Whitcroft } 4067c45dcabdSAndy Whitcroft if ($s =~ /^\s*;/ && 4068c45dcabdSAndy Whitcroft $function_name ne 'uninitialized_var') 4069c45dcabdSAndy Whitcroft { 4070000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4071000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4072de7d4f0eSAndy Whitcroft } 4073de7d4f0eSAndy Whitcroft 4074171ae1a4SAndy Whitcroft if ($paren_space =~ /\n/) { 4075000d1cc1SJoe Perches WARN("FUNCTION_ARGUMENTS", 4076000d1cc1SJoe Perches "arguments for function declarations should follow identifier\n" . $herecurr); 4077171ae1a4SAndy Whitcroft } 40789c9ba34eSAndy Whitcroft 40799c9ba34eSAndy Whitcroft } elsif ($realfile =~ /\.c$/ && defined $stat && 40809c9ba34eSAndy Whitcroft $stat =~ /^.\s*extern\s+/) 40819c9ba34eSAndy Whitcroft { 4082000d1cc1SJoe Perches WARN("AVOID_EXTERNS", 4083000d1cc1SJoe Perches "externs should be avoided in .c files\n" . $herecurr); 4084171ae1a4SAndy Whitcroft } 4085171ae1a4SAndy Whitcroft 4086de7d4f0eSAndy Whitcroft# checks for new __setup's 4087de7d4f0eSAndy Whitcroft if ($rawline =~ /\b__setup\("([^"]*)"/) { 4088de7d4f0eSAndy Whitcroft my $name = $1; 4089de7d4f0eSAndy Whitcroft 4090de7d4f0eSAndy Whitcroft if (!grep(/$name/, @setup_docs)) { 4091000d1cc1SJoe Perches CHK("UNDOCUMENTED_SETUP", 4092000d1cc1SJoe Perches "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); 4093de7d4f0eSAndy Whitcroft } 4094653d4876SAndy Whitcroft } 40959c0ca6f9SAndy Whitcroft 40969c0ca6f9SAndy Whitcroft# check for pointless casting of kmalloc return 4097caf2a54fSJoe Perches if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { 4098000d1cc1SJoe Perches WARN("UNNECESSARY_CASTS", 4099000d1cc1SJoe Perches "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 41009c0ca6f9SAndy Whitcroft } 410113214adfSAndy Whitcroft 4102a640d25cSJoe Perches# alloc style 4103a640d25cSJoe Perches# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 4104a640d25cSJoe Perches if ($^V && $^V ge 5.10.0 && 4105a640d25cSJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 4106a640d25cSJoe Perches CHK("ALLOC_SIZEOF_STRUCT", 4107a640d25cSJoe Perches "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 4108a640d25cSJoe Perches } 4109a640d25cSJoe Perches 4110972fdea2SJoe Perches# check for krealloc arg reuse 4111972fdea2SJoe Perches if ($^V && $^V ge 5.10.0 && 4112972fdea2SJoe Perches $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) { 4113972fdea2SJoe Perches WARN("KREALLOC_ARG_REUSE", 4114972fdea2SJoe Perches "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 4115972fdea2SJoe Perches } 4116972fdea2SJoe Perches 41175ce59ae0SJoe Perches# check for alloc argument mismatch 41185ce59ae0SJoe Perches if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 41195ce59ae0SJoe Perches WARN("ALLOC_ARRAY_ARGS", 41205ce59ae0SJoe Perches "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 41215ce59ae0SJoe Perches } 41225ce59ae0SJoe Perches 41237e4915e7SDavid Rientjes# check for GFP_NOWAIT use 41247e4915e7SDavid Rientjes if ($line =~ /\b__GFP_NOFAIL\b/) { 41257e4915e7SDavid Rientjes WARN("__GFP_NOFAIL", 41267e4915e7SDavid Rientjes "Use of __GFP_NOFAIL is deprecated, no new users should be added\n" . $herecurr); 41277e4915e7SDavid Rientjes } 41287e4915e7SDavid Rientjes 4129caf2a54fSJoe Perches# check for multiple semicolons 4130caf2a54fSJoe Perches if ($line =~ /;\s*;\s*$/) { 4131d5e616fcSJoe Perches if (WARN("ONE_SEMICOLON", 4132d5e616fcSJoe Perches "Statements terminations use 1 semicolon\n" . $herecurr) && 4133d5e616fcSJoe Perches $fix) { 4134d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g; 4135d5e616fcSJoe Perches } 4136d1e2ad07SJoe Perches } 4137d1e2ad07SJoe Perches 4138c34c09a8SJoe Perches# check for case / default statements not preceeded by break/fallthrough/switch 4139c34c09a8SJoe Perches if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) { 4140c34c09a8SJoe Perches my $has_break = 0; 4141c34c09a8SJoe Perches my $has_statement = 0; 4142c34c09a8SJoe Perches my $count = 0; 4143c34c09a8SJoe Perches my $prevline = $linenr; 4144c34c09a8SJoe Perches while ($prevline > 1 && $count < 3 && !$has_break) { 4145c34c09a8SJoe Perches $prevline--; 4146c34c09a8SJoe Perches my $rline = $rawlines[$prevline - 1]; 4147c34c09a8SJoe Perches my $fline = $lines[$prevline - 1]; 4148c34c09a8SJoe Perches last if ($fline =~ /^\@\@/); 4149c34c09a8SJoe Perches next if ($fline =~ /^\-/); 4150c34c09a8SJoe Perches next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/); 4151c34c09a8SJoe Perches $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i); 4152c34c09a8SJoe Perches next if ($fline =~ /^.[\s$;]*$/); 4153c34c09a8SJoe Perches $has_statement = 1; 4154c34c09a8SJoe Perches $count++; 4155c34c09a8SJoe Perches $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/); 4156c34c09a8SJoe Perches } 4157c34c09a8SJoe Perches if (!$has_break && $has_statement) { 4158c34c09a8SJoe Perches WARN("MISSING_BREAK", 4159c34c09a8SJoe Perches "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr); 4160c34c09a8SJoe Perches } 4161c34c09a8SJoe Perches } 4162c34c09a8SJoe Perches 4163d1e2ad07SJoe Perches# check for switch/default statements without a break; 4164d1e2ad07SJoe Perches if ($^V && $^V ge 5.10.0 && 4165d1e2ad07SJoe Perches defined $stat && 4166d1e2ad07SJoe Perches $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 4167d1e2ad07SJoe Perches my $ctx = ''; 4168d1e2ad07SJoe Perches my $herectx = $here . "\n"; 4169d1e2ad07SJoe Perches my $cnt = statement_rawlines($stat); 4170d1e2ad07SJoe Perches for (my $n = 0; $n < $cnt; $n++) { 4171d1e2ad07SJoe Perches $herectx .= raw_line($linenr, $n) . "\n"; 4172d1e2ad07SJoe Perches } 4173d1e2ad07SJoe Perches WARN("DEFAULT_NO_BREAK", 4174d1e2ad07SJoe Perches "switch default: should use break\n" . $herectx); 4175caf2a54fSJoe Perches } 4176caf2a54fSJoe Perches 417713214adfSAndy Whitcroft# check for gcc specific __FUNCTION__ 4178d5e616fcSJoe Perches if ($line =~ /\b__FUNCTION__\b/) { 4179d5e616fcSJoe Perches if (WARN("USE_FUNC", 4180d5e616fcSJoe Perches "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 4181d5e616fcSJoe Perches $fix) { 4182d5e616fcSJoe Perches $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g; 4183d5e616fcSJoe Perches } 418413214adfSAndy Whitcroft } 4185773647a0SAndy Whitcroft 41862c92488aSJoe Perches# check for use of yield() 41872c92488aSJoe Perches if ($line =~ /\byield\s*\(\s*\)/) { 41882c92488aSJoe Perches WARN("YIELD", 41892c92488aSJoe Perches "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 41902c92488aSJoe Perches } 41912c92488aSJoe Perches 4192179f8f40SJoe Perches# check for comparisons against true and false 4193179f8f40SJoe Perches if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 4194179f8f40SJoe Perches my $lead = $1; 4195179f8f40SJoe Perches my $arg = $2; 4196179f8f40SJoe Perches my $test = $3; 4197179f8f40SJoe Perches my $otype = $4; 4198179f8f40SJoe Perches my $trail = $5; 4199179f8f40SJoe Perches my $op = "!"; 4200179f8f40SJoe Perches 4201179f8f40SJoe Perches ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 4202179f8f40SJoe Perches 4203179f8f40SJoe Perches my $type = lc($otype); 4204179f8f40SJoe Perches if ($type =~ /^(?:true|false)$/) { 4205179f8f40SJoe Perches if (("$test" eq "==" && "$type" eq "true") || 4206179f8f40SJoe Perches ("$test" eq "!=" && "$type" eq "false")) { 4207179f8f40SJoe Perches $op = ""; 4208179f8f40SJoe Perches } 4209179f8f40SJoe Perches 4210179f8f40SJoe Perches CHK("BOOL_COMPARISON", 4211179f8f40SJoe Perches "Using comparison to $otype is error prone\n" . $herecurr); 4212179f8f40SJoe Perches 4213179f8f40SJoe Perches## maybe suggesting a correct construct would better 4214179f8f40SJoe Perches## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 4215179f8f40SJoe Perches 4216179f8f40SJoe Perches } 4217179f8f40SJoe Perches } 4218179f8f40SJoe Perches 42194882720bSThomas Gleixner# check for semaphores initialized locked 42204882720bSThomas Gleixner if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 4221000d1cc1SJoe Perches WARN("CONSIDER_COMPLETION", 4222000d1cc1SJoe Perches "consider using a completion\n" . $herecurr); 4223773647a0SAndy Whitcroft } 42246712d858SJoe Perches 422567d0a075SJoe Perches# recommend kstrto* over simple_strto* and strict_strto* 422667d0a075SJoe Perches if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 4227000d1cc1SJoe Perches WARN("CONSIDER_KSTRTO", 422867d0a075SJoe Perches "$1 is obsolete, use k$3 instead\n" . $herecurr); 4229773647a0SAndy Whitcroft } 42306712d858SJoe Perches 4231f3db6639SMichael Ellerman# check for __initcall(), use device_initcall() explicitly please 4232f3db6639SMichael Ellerman if ($line =~ /^.\s*__initcall\s*\(/) { 4233000d1cc1SJoe Perches WARN("USE_DEVICE_INITCALL", 4234000d1cc1SJoe Perches "please use device_initcall() instead of __initcall()\n" . $herecurr); 4235f3db6639SMichael Ellerman } 42366712d858SJoe Perches 423779404849SEmese Revfy# check for various ops structs, ensure they are const. 423879404849SEmese Revfy my $struct_ops = qr{acpi_dock_ops| 423979404849SEmese Revfy address_space_operations| 424079404849SEmese Revfy backlight_ops| 424179404849SEmese Revfy block_device_operations| 424279404849SEmese Revfy dentry_operations| 424379404849SEmese Revfy dev_pm_ops| 424479404849SEmese Revfy dma_map_ops| 424579404849SEmese Revfy extent_io_ops| 424679404849SEmese Revfy file_lock_operations| 424779404849SEmese Revfy file_operations| 424879404849SEmese Revfy hv_ops| 424979404849SEmese Revfy ide_dma_ops| 425079404849SEmese Revfy intel_dvo_dev_ops| 425179404849SEmese Revfy item_operations| 425279404849SEmese Revfy iwl_ops| 425379404849SEmese Revfy kgdb_arch| 425479404849SEmese Revfy kgdb_io| 425579404849SEmese Revfy kset_uevent_ops| 425679404849SEmese Revfy lock_manager_operations| 425779404849SEmese Revfy microcode_ops| 425879404849SEmese Revfy mtrr_ops| 425979404849SEmese Revfy neigh_ops| 426079404849SEmese Revfy nlmsvc_binding| 426179404849SEmese Revfy pci_raw_ops| 426279404849SEmese Revfy pipe_buf_operations| 426379404849SEmese Revfy platform_hibernation_ops| 426479404849SEmese Revfy platform_suspend_ops| 426579404849SEmese Revfy proto_ops| 426679404849SEmese Revfy rpc_pipe_ops| 426779404849SEmese Revfy seq_operations| 426879404849SEmese Revfy snd_ac97_build_ops| 426979404849SEmese Revfy soc_pcmcia_socket_ops| 427079404849SEmese Revfy stacktrace_ops| 427179404849SEmese Revfy sysfs_ops| 427279404849SEmese Revfy tty_operations| 427379404849SEmese Revfy usb_mon_operations| 427479404849SEmese Revfy wd_ops}x; 42756903ffb2SAndy Whitcroft if ($line !~ /\bconst\b/ && 427679404849SEmese Revfy $line =~ /\bstruct\s+($struct_ops)\b/) { 4277000d1cc1SJoe Perches WARN("CONST_STRUCT", 4278000d1cc1SJoe Perches "struct $1 should normally be const\n" . 42796903ffb2SAndy Whitcroft $herecurr); 42802b6db5cbSAndy Whitcroft } 4281773647a0SAndy Whitcroft 4282773647a0SAndy Whitcroft# use of NR_CPUS is usually wrong 4283773647a0SAndy Whitcroft# ignore definitions of NR_CPUS and usage to define arrays as likely right 4284773647a0SAndy Whitcroft if ($line =~ /\bNR_CPUS\b/ && 4285c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 4286c45dcabdSAndy Whitcroft $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 4287171ae1a4SAndy Whitcroft $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 4288171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 4289171ae1a4SAndy Whitcroft $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) 4290773647a0SAndy Whitcroft { 4291000d1cc1SJoe Perches WARN("NR_CPUS", 4292000d1cc1SJoe Perches "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 4293773647a0SAndy Whitcroft } 42949c9ba34eSAndy Whitcroft 429552ea8506SJoe Perches# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 429652ea8506SJoe Perches if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 429752ea8506SJoe Perches ERROR("DEFINE_ARCH_HAS", 429852ea8506SJoe Perches "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 429952ea8506SJoe Perches } 430052ea8506SJoe Perches 43019c9ba34eSAndy Whitcroft# check for %L{u,d,i} in strings 43029c9ba34eSAndy Whitcroft my $string; 43039c9ba34eSAndy Whitcroft while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 43049c9ba34eSAndy Whitcroft $string = substr($rawline, $-[1], $+[1] - $-[1]); 43052a1bc5d5SAndy Whitcroft $string =~ s/%%/__/g; 43069c9ba34eSAndy Whitcroft if ($string =~ /(?<!%)%L[udi]/) { 4307000d1cc1SJoe Perches WARN("PRINTF_L", 4308000d1cc1SJoe Perches "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 43099c9ba34eSAndy Whitcroft last; 43109c9ba34eSAndy Whitcroft } 43119c9ba34eSAndy Whitcroft } 4312691d77b6SAndy Whitcroft 4313691d77b6SAndy Whitcroft# whine mightly about in_atomic 4314691d77b6SAndy Whitcroft if ($line =~ /\bin_atomic\s*\(/) { 4315691d77b6SAndy Whitcroft if ($realfile =~ m@^drivers/@) { 4316000d1cc1SJoe Perches ERROR("IN_ATOMIC", 4317000d1cc1SJoe Perches "do not use in_atomic in drivers\n" . $herecurr); 4318f4a87736SAndy Whitcroft } elsif ($realfile !~ m@^kernel/@) { 4319000d1cc1SJoe Perches WARN("IN_ATOMIC", 4320000d1cc1SJoe Perches "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 4321691d77b6SAndy Whitcroft } 4322691d77b6SAndy Whitcroft } 43231704f47bSPeter Zijlstra 43241704f47bSPeter Zijlstra# check for lockdep_set_novalidate_class 43251704f47bSPeter Zijlstra if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 43261704f47bSPeter Zijlstra $line =~ /__lockdep_no_validate__\s*\)/ ) { 43271704f47bSPeter Zijlstra if ($realfile !~ m@^kernel/lockdep@ && 43281704f47bSPeter Zijlstra $realfile !~ m@^include/linux/lockdep@ && 43291704f47bSPeter Zijlstra $realfile !~ m@^drivers/base/core@) { 4330000d1cc1SJoe Perches ERROR("LOCKDEP", 4331000d1cc1SJoe Perches "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 43321704f47bSPeter Zijlstra } 43331704f47bSPeter Zijlstra } 433488f8831cSDave Jones 433588f8831cSDave Jones if ($line =~ /debugfs_create_file.*S_IWUGO/ || 433688f8831cSDave Jones $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { 4337000d1cc1SJoe Perches WARN("EXPORTED_WORLD_WRITABLE", 4338000d1cc1SJoe Perches "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 433988f8831cSDave Jones } 434013214adfSAndy Whitcroft } 434113214adfSAndy Whitcroft 434213214adfSAndy Whitcroft # If we have no input at all, then there is nothing to report on 434313214adfSAndy Whitcroft # so just keep quiet. 434413214adfSAndy Whitcroft if ($#rawlines == -1) { 434513214adfSAndy Whitcroft exit(0); 43460a920b5bSAndy Whitcroft } 43470a920b5bSAndy Whitcroft 43488905a67cSAndy Whitcroft # In mailback mode only produce a report in the negative, for 43498905a67cSAndy Whitcroft # things that appear to be patches. 43508905a67cSAndy Whitcroft if ($mailback && ($clean == 1 || !$is_patch)) { 43518905a67cSAndy Whitcroft exit(0); 43528905a67cSAndy Whitcroft } 43538905a67cSAndy Whitcroft 43548905a67cSAndy Whitcroft # This is not a patch, and we are are in 'no-patch' mode so 43558905a67cSAndy Whitcroft # just keep quiet. 43568905a67cSAndy Whitcroft if (!$chk_patch && !$is_patch) { 43578905a67cSAndy Whitcroft exit(0); 43588905a67cSAndy Whitcroft } 43598905a67cSAndy Whitcroft 43608905a67cSAndy Whitcroft if (!$is_patch) { 4361000d1cc1SJoe Perches ERROR("NOT_UNIFIED_DIFF", 4362000d1cc1SJoe Perches "Does not appear to be a unified-diff format patch\n"); 43630a920b5bSAndy Whitcroft } 43640a920b5bSAndy Whitcroft if ($is_patch && $chk_signoff && $signoff == 0) { 4365000d1cc1SJoe Perches ERROR("MISSING_SIGN_OFF", 4366000d1cc1SJoe Perches "Missing Signed-off-by: line(s)\n"); 43670a920b5bSAndy Whitcroft } 43680a920b5bSAndy Whitcroft 4369f0a594c1SAndy Whitcroft print report_dump(); 437013214adfSAndy Whitcroft if ($summary && !($clean == 1 && $quiet == 1)) { 437113214adfSAndy Whitcroft print "$filename " if ($summary_file); 43726c72ffaaSAndy Whitcroft print "total: $cnt_error errors, $cnt_warn warnings, " . 43736c72ffaaSAndy Whitcroft (($check)? "$cnt_chk checks, " : "") . 43746c72ffaaSAndy Whitcroft "$cnt_lines lines checked\n"; 43758905a67cSAndy Whitcroft print "\n" if ($quiet == 0); 43766c72ffaaSAndy Whitcroft } 43778905a67cSAndy Whitcroft 4378d2c0a235SAndy Whitcroft if ($quiet == 0) { 4379d1fe9c09SJoe Perches 4380d1fe9c09SJoe Perches if ($^V lt 5.10.0) { 4381d1fe9c09SJoe Perches print("NOTE: perl $^V is not modern enough to detect all possible issues.\n"); 4382d1fe9c09SJoe Perches print("An upgrade to at least perl v5.10.0 is suggested.\n\n"); 4383d1fe9c09SJoe Perches } 4384d1fe9c09SJoe Perches 4385d2c0a235SAndy Whitcroft # If there were whitespace errors which cleanpatch can fix 4386d2c0a235SAndy Whitcroft # then suggest that. 4387d2c0a235SAndy Whitcroft if ($rpt_cleaners) { 4388d2c0a235SAndy Whitcroft print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 4389d2c0a235SAndy Whitcroft print " scripts/cleanfile\n\n"; 4390b0781216SMike Frysinger $rpt_cleaners = 0; 4391d2c0a235SAndy Whitcroft } 4392d2c0a235SAndy Whitcroft } 4393d2c0a235SAndy Whitcroft 439491bfe484SJoe Perches hash_show_words(\%use_type, "Used"); 439591bfe484SJoe Perches hash_show_words(\%ignore_type, "Ignored"); 4396000d1cc1SJoe Perches 43973705ce5bSJoe Perches if ($clean == 0 && $fix && "@rawlines" ne "@fixed") { 4398*9624b8d6SJoe Perches my $newfile = $filename; 4399*9624b8d6SJoe Perches $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 44003705ce5bSJoe Perches my $linecount = 0; 44013705ce5bSJoe Perches my $f; 44023705ce5bSJoe Perches 44033705ce5bSJoe Perches open($f, '>', $newfile) 44043705ce5bSJoe Perches or die "$P: Can't open $newfile for write\n"; 44053705ce5bSJoe Perches foreach my $fixed_line (@fixed) { 44063705ce5bSJoe Perches $linecount++; 44073705ce5bSJoe Perches if ($file) { 44083705ce5bSJoe Perches if ($linecount > 3) { 44093705ce5bSJoe Perches $fixed_line =~ s/^\+//; 44103705ce5bSJoe Perches print $f $fixed_line. "\n"; 44113705ce5bSJoe Perches } 44123705ce5bSJoe Perches } else { 44133705ce5bSJoe Perches print $f $fixed_line . "\n"; 44143705ce5bSJoe Perches } 44153705ce5bSJoe Perches } 44163705ce5bSJoe Perches close($f); 44173705ce5bSJoe Perches 44183705ce5bSJoe Perches if (!$quiet) { 44193705ce5bSJoe Perches print << "EOM"; 44203705ce5bSJoe PerchesWrote EXPERIMENTAL --fix correction(s) to '$newfile' 44213705ce5bSJoe Perches 44223705ce5bSJoe PerchesDo _NOT_ trust the results written to this file. 44233705ce5bSJoe PerchesDo _NOT_ submit these changes without inspecting them for correctness. 44243705ce5bSJoe Perches 44253705ce5bSJoe PerchesThis EXPERIMENTAL file is simply a convenience to help rewrite patches. 44263705ce5bSJoe PerchesNo warranties, expressed or implied... 44273705ce5bSJoe Perches 44283705ce5bSJoe PerchesEOM 44293705ce5bSJoe Perches } 44303705ce5bSJoe Perches } 44313705ce5bSJoe Perches 44320a920b5bSAndy Whitcroft if ($clean == 1 && $quiet == 0) { 4433c2fdda0dSAndy Whitcroft print "$vname has no obvious style problems and is ready for submission.\n" 44340a920b5bSAndy Whitcroft } 44350a920b5bSAndy Whitcroft if ($clean == 0 && $quiet == 0) { 4436000d1cc1SJoe Perches print << "EOM"; 4437000d1cc1SJoe Perches$vname has style problems, please review. 4438000d1cc1SJoe Perches 4439000d1cc1SJoe PerchesIf any of these errors are false positives, please report 4440000d1cc1SJoe Perchesthem to the maintainer, see CHECKPATCH in MAINTAINERS. 4441000d1cc1SJoe PerchesEOM 44420a920b5bSAndy Whitcroft } 444313214adfSAndy Whitcroft 44440a920b5bSAndy Whitcroft return $clean; 44450a920b5bSAndy Whitcroft} 4446