blob: 34eb2160489d5cccda8e6d3d17596ff0a236bc6a [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070010
11my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070012$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
Joe Perches000d1cc12011-07-25 17:13:25 -070014my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070015
16use Getopt::Long qw(:config no_auto_abbrev);
17
18my $quiet = 0;
19my $tree = 1;
20my $chk_signoff = 1;
21my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070022my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080024my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070025my $file = 0;
26my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080027my $summary = 1;
28my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080029my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070030my $show_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070031my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080032my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070033my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080034my %debug;
Joe Perches34456862013-07-03 15:05:34 -070035my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070036my %use_type = ();
37my @use = ();
38my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070039my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070040my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070041my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080042my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070043my $ignore_perl_version = 0;
44my $minimum_perl_version = 5.10.0;
Hannes Eder77f5b102009-09-21 17:04:37 -070045
46sub help {
47 my ($exitcode) = @_;
48
49 print << "EOM";
50Usage: $P [OPTION]... [FILE]...
51Version: $V
52
53Options:
54 -q, --quiet quiet
55 --no-tree run without a kernel tree
56 --no-signoff do not check for 'Signed-off-by' line
57 --patch treat FILE as patchfile (default)
58 --emacs emacs compile window format
59 --terse one line per report
60 -f, --file treat FILE as regular source file
61 --subjective, --strict enable more subjective tests
Joe Perches91bfe482013-09-11 14:23:59 -070062 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070063 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080064 --max-line-length=n set the maximum line length, if exceeded, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070065 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070066 --root=PATH PATH to the kernel tree root
67 --no-summary suppress the per-file summary
68 --mailback only produce a report in case of warnings/errors
69 --summary-file include the filename in summary
70 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
71 'values', 'possible', 'type', and 'attr' (default
72 is all off)
73 --test-only=WORD report only warnings/errors containing WORD
74 literally
Joe Perches3705ce52013-07-03 15:05:31 -070075 --fix EXPERIMENTAL - may create horrible results
76 If correctable single-line errors exist, create
77 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
78 with potential errors corrected to the preferred
79 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -080080 --fix-inplace EXPERIMENTAL - may create horrible results
81 Is the same as --fix, but overwrites the input
82 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -070083 --ignore-perl-version override checking of perl version. expect
84 runtime errors.
Hannes Eder77f5b102009-09-21 17:04:37 -070085 -h, --help, --version display this help and exit
86
87When FILE is - read standard input.
88EOM
89
90 exit($exitcode);
91}
92
Joe Perches000d1cc12011-07-25 17:13:25 -070093my $conf = which_conf($configuration_file);
94if (-f $conf) {
95 my @conf_args;
96 open(my $conffile, '<', "$conf")
97 or warn "$P: Can't find a readable $configuration_file file $!\n";
98
99 while (<$conffile>) {
100 my $line = $_;
101
102 $line =~ s/\s*\n?$//g;
103 $line =~ s/^\s*//g;
104 $line =~ s/\s+/ /g;
105
106 next if ($line =~ m/^\s*#/);
107 next if ($line =~ m/^\s*$/);
108
109 my @words = split(" ", $line);
110 foreach my $word (@words) {
111 last if ($word =~ m/^#/);
112 push (@conf_args, $word);
113 }
114 }
115 close($conffile);
116 unshift(@ARGV, @conf_args) if @conf_args;
117}
118
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700119GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700120 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700121 'tree!' => \$tree,
122 'signoff!' => \$chk_signoff,
123 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700124 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800125 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700126 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700127 'subjective!' => \$check,
128 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700129 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700130 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700131 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800132 'max-line-length=i' => \$max_line_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700133 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800134 'summary!' => \$summary,
135 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800136 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700137 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800138 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700139 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800140 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700141 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700142 'h|help' => \$help,
143 'version' => \$help
144) or help(1);
145
146help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700147
Joe Perches9624b8d2014-01-23 15:54:44 -0800148$fix = 1 if ($fix_inplace);
149
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700150my $exit = 0;
151
Dave Hansend62a2012013-09-11 14:23:56 -0700152if ($^V && $^V lt $minimum_perl_version) {
153 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
154 if (!$ignore_perl_version) {
155 exit(1);
156 }
157}
158
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700159if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700160 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700161 exit(1);
162}
163
Joe Perches91bfe482013-09-11 14:23:59 -0700164sub hash_save_array_words {
165 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700166
Joe Perches91bfe482013-09-11 14:23:59 -0700167 my @array = split(/,/, join(',', @$arrayRef));
168 foreach my $word (@array) {
169 $word =~ s/\s*\n?$//g;
170 $word =~ s/^\s*//g;
171 $word =~ s/\s+/ /g;
172 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700173
Joe Perches91bfe482013-09-11 14:23:59 -0700174 next if ($word =~ m/^\s*#/);
175 next if ($word =~ m/^\s*$/);
176
177 $hashRef->{$word}++;
178 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700179}
180
Joe Perches91bfe482013-09-11 14:23:59 -0700181sub hash_show_words {
182 my ($hashRef, $prefix) = @_;
183
Joe Perches58cb3cf2013-09-11 14:24:04 -0700184 if ($quiet == 0 && keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700185 print "NOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700186 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700187 print " $word";
188 }
189 print "\n\n";
190 }
191}
192
193hash_save_array_words(\%ignore_type, \@ignore);
194hash_save_array_words(\%use_type, \@use);
195
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800196my $dbg_values = 0;
197my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700198my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700199my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800200for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800201 ## no critic
202 eval "\${dbg_$key} = '$debug{$key}';";
203 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800204}
205
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700206my $rpt_cleaners = 0;
207
Andy Whitcroft8905a672007-11-28 16:21:06 -0800208if ($terse) {
209 $emacs = 1;
210 $quiet++;
211}
212
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700213if ($tree) {
214 if (defined $root) {
215 if (!top_of_kernel_tree($root)) {
216 die "$P: $root: --root does not point at a valid tree\n";
217 }
218 } else {
219 if (top_of_kernel_tree('.')) {
220 $root = '.';
221 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
222 top_of_kernel_tree($1)) {
223 $root = $1;
224 }
225 }
226
227 if (!defined $root) {
228 print "Must be run from the top-level dir. of a kernel tree\n";
229 exit(2);
230 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700231}
232
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700233my $emitted_corrupt = 0;
234
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700235our $Ident = qr{
236 [A-Za-z_][A-Za-z\d_]*
237 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
238 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700239our $Storage = qr{extern|static|asmlinkage};
240our $Sparse = qr{
241 __user|
242 __kernel|
243 __force|
244 __iomem|
245 __must_check|
246 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800247 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700248 __ref|
249 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700250 }x;
Joe Perchese970b882013-11-12 15:10:10 -0800251our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
252our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
253our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
254our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
255our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700256
Wolfram Sang52131292010-03-05 13:43:51 -0800257# Notes to $Attribute:
258# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700259our $Attribute = qr{
260 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700261 __percpu|
262 __nocast|
263 __safe|
264 __bitwise__|
265 __packed__|
266 __packed2__|
267 __naked|
268 __maybe_unused|
269 __always_unused|
270 __noreturn|
271 __used|
272 __cold|
273 __noclone|
274 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700275 __read_mostly|
276 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700277 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700278 ____cacheline_aligned|
279 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800280 ____cacheline_internodealigned_in_smp|
281 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700282 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700283our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700284our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700285our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
286our $Lval = qr{$Ident(?:$Member)*};
287
Joe Perches95e2c602013-07-03 15:05:20 -0700288our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
289our $Binary = qr{(?i)0b[01]+$Int_type?};
290our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
291our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700292our $Octal = qr{0[0-7]+$Int_type?};
Joe Perches326b1ff2013-02-04 14:28:51 -0800293our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
294our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
295our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800296our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700297our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800298our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700299our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700300our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700301our $Operators = qr{
302 <=|>=|==|!=|
303 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700304 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700305 }x;
306
Joe Perches91cb5192014-04-03 14:49:32 -0700307our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
308
Andy Whitcroft8905a672007-11-28 16:21:06 -0800309our $NonptrType;
Joe Perches8716de32013-09-11 14:24:05 -0700310our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800311our $Type;
312our $Declare;
313
Joe Perches15662b32011-10-31 17:13:12 -0700314our $NON_ASCII_UTF8 = qr{
315 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700316 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
317 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
318 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
319 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
320 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
321 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
322}x;
323
Joe Perches15662b32011-10-31 17:13:12 -0700324our $UTF8 = qr{
325 [\x09\x0A\x0D\x20-\x7E] # ASCII
326 | $NON_ASCII_UTF8
327}x;
328
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700329our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700330 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700331 atomic_t
332)};
333
Joe Perches691e6692010-03-05 13:43:51 -0800334our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700335 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700336 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches6e60c022011-07-25 17:13:27 -0700337 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700338 panic|
Joe Perches06668722013-11-12 15:10:07 -0800339 MODULE_[A-Z_]+|
340 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800341)};
342
Joe Perches20112472011-07-25 17:13:23 -0700343our $signature_tags = qr{(?xi:
344 Signed-off-by:|
345 Acked-by:|
346 Tested-by:|
347 Reviewed-by:|
348 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700349 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700350 To:|
351 Cc:
352)};
353
Andy Whitcroft8905a672007-11-28 16:21:06 -0800354our @typeList = (
355 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700356 qr{(?:unsigned\s+)?char},
357 qr{(?:unsigned\s+)?short},
358 qr{(?:unsigned\s+)?int},
359 qr{(?:unsigned\s+)?long},
360 qr{(?:unsigned\s+)?long\s+int},
361 qr{(?:unsigned\s+)?long\s+long},
362 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800363 qr{unsigned},
364 qr{float},
365 qr{double},
366 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800367 qr{struct\s+$Ident},
368 qr{union\s+$Ident},
369 qr{enum\s+$Ident},
370 qr{${Ident}_t},
371 qr{${Ident}_handler},
372 qr{${Ident}_handler_fn},
373);
Joe Perches8716de32013-09-11 14:24:05 -0700374our @typeListWithAttr = (
375 @typeList,
376 qr{struct\s+$InitAttribute\s+$Ident},
377 qr{union\s+$InitAttribute\s+$Ident},
378);
379
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700380our @modifierList = (
381 qr{fastcall},
382);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800383
Joe Perches24358802014-04-03 14:49:13 -0700384our @mode_permission_funcs = (
385 ["module_param", 3],
386 ["module_param_(?:array|named|string)", 4],
387 ["module_param_array_named", 5],
388 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
389 ["proc_create(?:_data|)", 2],
390 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
391);
392
Joe Perches515a2352014-04-03 14:49:24 -0700393#Create a search pattern for all these functions to speed up a loop below
394our $mode_perms_search = "";
395foreach my $entry (@mode_permission_funcs) {
396 $mode_perms_search .= '|' if ($mode_perms_search ne "");
397 $mode_perms_search .= $entry->[0];
398}
399
Wolfram Sang7840a942010-08-09 17:20:57 -0700400our $allowed_asm_includes = qr{(?x:
401 irq|
402 memory
403)};
404# memory.h: ARM has a custom one
405
Andy Whitcroft8905a672007-11-28 16:21:06 -0800406sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700407 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
408 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700409 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700410 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800411 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700412 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800413 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800414 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700415 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700416 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800417 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700418 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800419 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700420 $NonptrTypeWithAttr = qr{
421 (?:$Modifier\s+|const\s+)*
422 (?:
423 (?:typeof|__typeof__)\s*\([^\)]*\)|
424 (?:$typeTypedefs\b)|
425 (?:${allWithAttr}\b)
426 )
427 (?:\s+$Modifier|\s+const)*
428 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800429 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700430 $NonptrType
Andy Whitcroftb337d8b2012-03-23 15:02:18 -0700431 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700432 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800433 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700434 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800435}
436build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700437
Joe Perches7d2367a2011-07-25 17:13:22 -0700438our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700439
440# Using $balanced_parens, $LvalOrFunc, or $FuncArg
441# requires at least perl version v5.10.0
442# Any use must be runtime checked with $^V
443
444our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700445our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800446our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700447
448sub deparenthesize {
449 my ($string) = @_;
450 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700451
452 while ($string =~ /^\s*\(.*\)\s*$/) {
453 $string =~ s@^\s*\(\s*@@;
454 $string =~ s@\s*\)\s*$@@;
455 }
456
Joe Perches7d2367a2011-07-25 17:13:22 -0700457 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700458
Joe Perches7d2367a2011-07-25 17:13:22 -0700459 return $string;
460}
461
Joe Perches34456862013-07-03 15:05:34 -0700462sub seed_camelcase_file {
463 my ($file) = @_;
464
465 return if (!(-f $file));
466
467 local $/;
468
469 open(my $include_file, '<', "$file")
470 or warn "$P: Can't read '$file' $!\n";
471 my $text = <$include_file>;
472 close($include_file);
473
474 my @lines = split('\n', $text);
475
476 foreach my $line (@lines) {
477 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
478 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
479 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800480 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
481 $camelcase{$1} = 1;
482 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
Joe Perches34456862013-07-03 15:05:34 -0700483 $camelcase{$1} = 1;
484 }
485 }
486}
487
488my $camelcase_seeded = 0;
489sub seed_camelcase_includes {
490 return if ($camelcase_seeded);
491
492 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700493 my $camelcase_cache = "";
494 my @include_files = ();
495
496 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700497
Richard Genoud3645e322014-02-10 14:25:32 -0800498 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700499 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
500 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700501 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700502 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700503 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700504 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700505 @include_files = split('\n', $files);
506 foreach my $file (@include_files) {
507 my $date = POSIX::strftime("%Y%m%d%H%M",
508 localtime((stat $file)[9]));
509 $last_mod_date = $date if ($last_mod_date < $date);
510 }
511 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700512 }
Joe Perchesc707a812013-07-08 16:00:43 -0700513
514 if ($camelcase_cache ne "" && -f $camelcase_cache) {
515 open(my $camelcase_file, '<', "$camelcase_cache")
516 or warn "$P: Can't read '$camelcase_cache' $!\n";
517 while (<$camelcase_file>) {
518 chomp;
519 $camelcase{$_} = 1;
520 }
521 close($camelcase_file);
522
523 return;
524 }
525
Richard Genoud3645e322014-02-10 14:25:32 -0800526 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700527 $files = `git ls-files "include/*.h"`;
528 @include_files = split('\n', $files);
529 }
530
Joe Perches34456862013-07-03 15:05:34 -0700531 foreach my $file (@include_files) {
532 seed_camelcase_file($file);
533 }
Joe Perches351b2a12013-07-03 15:05:36 -0700534
Joe Perchesc707a812013-07-08 16:00:43 -0700535 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700536 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700537 open(my $camelcase_file, '>', "$camelcase_cache")
538 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700539 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
540 print $camelcase_file ("$_\n");
541 }
542 close($camelcase_file);
543 }
Joe Perches34456862013-07-03 15:05:34 -0700544}
545
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700546$chk_signoff = 0 if ($file);
547
Andy Whitcroft00df3442007-06-08 13:47:06 -0700548my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800549my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700550my @fixed = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800551my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700552for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800553 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700554 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800555 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700556 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800557 } elsif ($filename eq '-') {
558 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700559 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800560 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700561 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700562 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800563 if ($filename eq '-') {
564 $vname = 'Your patch';
565 } else {
566 $vname = $filename;
567 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800568 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700569 chomp;
570 push(@rawlines, $_);
571 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800572 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800573 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700574 $exit = 1;
575 }
576 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800577 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700578 @fixed = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700579}
580
581exit($exit);
582
583sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700584 my ($root) = @_;
585
586 my @tree_check = (
587 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
588 "README", "Documentation", "arch", "include", "drivers",
589 "fs", "init", "ipc", "kernel", "lib", "scripts",
590 );
591
592 foreach my $check (@tree_check) {
593 if (! -e $root . '/' . $check) {
594 return 0;
595 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700596 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700597 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700598}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700599
Joe Perches20112472011-07-25 17:13:23 -0700600sub parse_email {
601 my ($formatted_email) = @_;
602
603 my $name = "";
604 my $address = "";
605 my $comment = "";
606
607 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
608 $name = $1;
609 $address = $2;
610 $comment = $3 if defined $3;
611 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
612 $address = $1;
613 $comment = $2 if defined $2;
614 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
615 $address = $1;
616 $comment = $2 if defined $2;
617 $formatted_email =~ s/$address.*$//;
618 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700619 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700620 $name =~ s/^\"|\"$//g;
621 # If there's a name left after stripping spaces and
622 # leading quotes, and the address doesn't have both
623 # leading and trailing angle brackets, the address
624 # is invalid. ie:
625 # "joe smith joe@smith.com" bad
626 # "joe smith <joe@smith.com" bad
627 if ($name ne "" && $address !~ /^<[^>]+>$/) {
628 $name = "";
629 $address = "";
630 $comment = "";
631 }
632 }
633
Joe Perches3705ce52013-07-03 15:05:31 -0700634 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700635 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700636 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700637 $address =~ s/^\<|\>$//g;
638
639 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
640 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
641 $name = "\"$name\"";
642 }
643
644 return ($name, $address, $comment);
645}
646
647sub format_email {
648 my ($name, $address) = @_;
649
650 my $formatted_email;
651
Joe Perches3705ce52013-07-03 15:05:31 -0700652 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700653 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700654 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700655
656 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
657 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
658 $name = "\"$name\"";
659 }
660
661 if ("$name" eq "") {
662 $formatted_email = "$address";
663 } else {
664 $formatted_email = "$name <$address>";
665 }
666
667 return $formatted_email;
668}
669
Joe Perches000d1cc12011-07-25 17:13:25 -0700670sub which_conf {
671 my ($conf) = @_;
672
673 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
674 if (-e "$path/$conf") {
675 return "$path/$conf";
676 }
677 }
678
679 return "";
680}
681
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700682sub expand_tabs {
683 my ($str) = @_;
684
685 my $res = '';
686 my $n = 0;
687 for my $c (split(//, $str)) {
688 if ($c eq "\t") {
689 $res .= ' ';
690 $n++;
691 for (; ($n % 8) != 0; $n++) {
692 $res .= ' ';
693 }
694 next;
695 }
696 $res .= $c;
697 $n++;
698 }
699
700 return $res;
701}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700702sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700703 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700704 return $res;
705}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700706
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700707sub line_stats {
708 my ($line) = @_;
709
710 # Drop the diff line leader and expand tabs
711 $line =~ s/^.//;
712 $line = expand_tabs($line);
713
714 # Pick the indent from the front of the line.
715 my ($white) = ($line =~ /^(\s*)/);
716
717 return (length($line), length($white));
718}
719
Andy Whitcroft773647a2008-03-28 14:15:58 -0700720my $sanitise_quote = '';
721
722sub sanitise_line_reset {
723 my ($in_comment) = @_;
724
725 if ($in_comment) {
726 $sanitise_quote = '*/';
727 } else {
728 $sanitise_quote = '';
729 }
730}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700731sub sanitise_line {
732 my ($line) = @_;
733
734 my $res = '';
735 my $l = '';
736
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800737 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700738 my $off = 0;
739 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700740
Andy Whitcroft773647a2008-03-28 14:15:58 -0700741 # Always copy over the diff marker.
742 $res = substr($line, 0, 1);
743
744 for ($off = 1; $off < length($line); $off++) {
745 $c = substr($line, $off, 1);
746
747 # Comments we are wacking completly including the begin
748 # and end, all to $;.
749 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
750 $sanitise_quote = '*/';
751
752 substr($res, $off, 2, "$;$;");
753 $off++;
754 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800755 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700756 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700757 $sanitise_quote = '';
758 substr($res, $off, 2, "$;$;");
759 $off++;
760 next;
761 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700762 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
763 $sanitise_quote = '//';
764
765 substr($res, $off, 2, $sanitise_quote);
766 $off++;
767 next;
768 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700769
770 # A \ in a string means ignore the next character.
771 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
772 $c eq "\\") {
773 substr($res, $off, 2, 'XX');
774 $off++;
775 next;
776 }
777 # Regular quotes.
778 if ($c eq "'" || $c eq '"') {
779 if ($sanitise_quote eq '') {
780 $sanitise_quote = $c;
781
782 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700783 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700784 } elsif ($sanitise_quote eq $c) {
785 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700786 }
787 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700788
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800789 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700790 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
791 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700792 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
793 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700794 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
795 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700796 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700797 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700798 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800799 }
800
Daniel Walker113f04a2009-09-21 17:04:35 -0700801 if ($sanitise_quote eq '//') {
802 $sanitise_quote = '';
803 }
804
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800805 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700806 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800807 my $clean = 'X' x length($1);
808 $res =~ s@\<.*\>@<$clean>@;
809
810 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700811 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800812 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700813 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800814 }
815
Andy Whitcroft00df3442007-06-08 13:47:06 -0700816 return $res;
817}
818
Joe Perchesa6962d72013-04-29 16:18:13 -0700819sub get_quoted_string {
820 my ($line, $rawline) = @_;
821
822 return "" if ($line !~ m/(\"[X]+\")/g);
823 return substr($rawline, $-[0], $+[0] - $-[0]);
824}
825
Andy Whitcroft8905a672007-11-28 16:21:06 -0800826sub ctx_statement_block {
827 my ($linenr, $remain, $off) = @_;
828 my $line = $linenr - 1;
829 my $blk = '';
830 my $soff = $off;
831 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700832 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800833
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800834 my $loff = 0;
835
Andy Whitcroft8905a672007-11-28 16:21:06 -0800836 my $type = '';
837 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800838 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800839 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800840 my $c;
841 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800842
843 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800844 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800845 @stack = (['', 0]) if ($#stack == -1);
846
Andy Whitcroft773647a2008-03-28 14:15:58 -0700847 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800848 # If we are about to drop off the end, pull in more
849 # context.
850 if ($off >= $len) {
851 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700852 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800853 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800854 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800855 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800856 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800857 $len = length($blk);
858 $line++;
859 last;
860 }
861 # Bail if there is no further context.
862 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800863 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800864 last;
865 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800866 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
867 $level++;
868 $type = '#';
869 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800870 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800871 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800872 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800873 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800874
Andy Whitcroft773647a2008-03-28 14:15:58 -0700875 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800876
877 # Handle nested #if/#else.
878 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
879 push(@stack, [ $type, $level ]);
880 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
881 ($type, $level) = @{$stack[$#stack - 1]};
882 } elsif ($remainder =~ /^#\s*endif\b/) {
883 ($type, $level) = @{pop(@stack)};
884 }
885
Andy Whitcroft8905a672007-11-28 16:21:06 -0800886 # Statement ends at the ';' or a close '}' at the
887 # outermost level.
888 if ($level == 0 && $c eq ';') {
889 last;
890 }
891
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800892 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700893 if ($level == 0 && $coff_set == 0 &&
894 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
895 $remainder =~ /^(else)(?:\s|{)/ &&
896 $remainder !~ /^else\s+if\b/) {
897 $coff = $off + length($1) - 1;
898 $coff_set = 1;
899 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
900 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800901 }
902
Andy Whitcroft8905a672007-11-28 16:21:06 -0800903 if (($type eq '' || $type eq '(') && $c eq '(') {
904 $level++;
905 $type = '(';
906 }
907 if ($type eq '(' && $c eq ')') {
908 $level--;
909 $type = ($level != 0)? '(' : '';
910
911 if ($level == 0 && $coff < $soff) {
912 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700913 $coff_set = 1;
914 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800915 }
916 }
917 if (($type eq '' || $type eq '{') && $c eq '{') {
918 $level++;
919 $type = '{';
920 }
921 if ($type eq '{' && $c eq '}') {
922 $level--;
923 $type = ($level != 0)? '{' : '';
924
925 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700926 if (substr($blk, $off + 1, 1) eq ';') {
927 $off++;
928 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800929 last;
930 }
931 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800932 # Preprocessor commands end at the newline unless escaped.
933 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
934 $level--;
935 $type = '';
936 $off++;
937 last;
938 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800939 $off++;
940 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700941 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800942 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700943 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800944 $line++;
945 $remain--;
946 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800947
948 my $statement = substr($blk, $soff, $off - $soff + 1);
949 my $condition = substr($blk, $soff, $coff - $soff + 1);
950
951 #warn "STATEMENT<$statement>\n";
952 #warn "CONDITION<$condition>\n";
953
Andy Whitcroft773647a2008-03-28 14:15:58 -0700954 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800955
956 return ($statement, $condition,
957 $line, $remain + 1, $off - $loff + 1, $level);
958}
959
Andy Whitcroftcf655042008-03-04 14:28:20 -0800960sub statement_lines {
961 my ($stmt) = @_;
962
963 # Strip the diff line prefixes and rip blank lines at start and end.
964 $stmt =~ s/(^|\n)./$1/g;
965 $stmt =~ s/^\s*//;
966 $stmt =~ s/\s*$//;
967
968 my @stmt_lines = ($stmt =~ /\n/g);
969
970 return $#stmt_lines + 2;
971}
972
973sub statement_rawlines {
974 my ($stmt) = @_;
975
976 my @stmt_lines = ($stmt =~ /\n/g);
977
978 return $#stmt_lines + 2;
979}
980
981sub statement_block_size {
982 my ($stmt) = @_;
983
984 $stmt =~ s/(^|\n)./$1/g;
985 $stmt =~ s/^\s*{//;
986 $stmt =~ s/}\s*$//;
987 $stmt =~ s/^\s*//;
988 $stmt =~ s/\s*$//;
989
990 my @stmt_lines = ($stmt =~ /\n/g);
991 my @stmt_statements = ($stmt =~ /;/g);
992
993 my $stmt_lines = $#stmt_lines + 2;
994 my $stmt_statements = $#stmt_statements + 1;
995
996 if ($stmt_lines > $stmt_statements) {
997 return $stmt_lines;
998 } else {
999 return $stmt_statements;
1000 }
1001}
1002
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001003sub ctx_statement_full {
1004 my ($linenr, $remain, $off) = @_;
1005 my ($statement, $condition, $level);
1006
1007 my (@chunks);
1008
Andy Whitcroftcf655042008-03-04 14:28:20 -08001009 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001010 ($statement, $condition, $linenr, $remain, $off, $level) =
1011 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001012 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001013 push(@chunks, [ $condition, $statement ]);
1014 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1015 return ($level, $linenr, @chunks);
1016 }
1017
1018 # Pull in the following conditional/block pairs and see if they
1019 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001020 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001021 ($statement, $condition, $linenr, $remain, $off, $level) =
1022 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001023 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001024 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001025 #print "C: push\n";
1026 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001027 }
1028
1029 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001030}
1031
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001032sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001033 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001034 my $line;
1035 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001036 my $blk = '';
1037 my @o;
1038 my @c;
1039 my @res = ();
1040
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001041 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001042 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001043 for ($line = $start; $remain > 0; $line++) {
1044 next if ($rawlines[$line] =~ /^-/);
1045 $remain--;
1046
1047 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001048
1049 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001050 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001051 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001052 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001053 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001054 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001055 $level = pop(@stack);
1056 }
1057
Andy Whitcroft01464f32010-10-26 14:23:19 -07001058 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001059 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1060 if ($off > 0) {
1061 $off--;
1062 next;
1063 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001064
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001065 if ($c eq $close && $level > 0) {
1066 $level--;
1067 last if ($level == 0);
1068 } elsif ($c eq $open) {
1069 $level++;
1070 }
1071 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001072
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001073 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001074 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001075 }
1076
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001077 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001078 }
1079
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001080 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001081}
1082sub ctx_block_outer {
1083 my ($linenr, $remain) = @_;
1084
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001085 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1086 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001087}
1088sub ctx_block {
1089 my ($linenr, $remain) = @_;
1090
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001091 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1092 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001093}
1094sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001095 my ($linenr, $remain, $off) = @_;
1096
1097 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1098 return @r;
1099}
1100sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001101 my ($linenr, $remain) = @_;
1102
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001103 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001104}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001105sub ctx_statement_level {
1106 my ($linenr, $remain, $off) = @_;
1107
1108 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1109}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001110
1111sub ctx_locate_comment {
1112 my ($first_line, $end_line) = @_;
1113
1114 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001115 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001116 return $current_comment if (defined $current_comment);
1117
1118 # Look through the context and try and figure out if there is a
1119 # comment.
1120 my $in_comment = 0;
1121 $current_comment = '';
1122 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001123 my $line = $rawlines[$linenr - 1];
1124 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001125 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1126 $in_comment = 1;
1127 }
1128 if ($line =~ m@/\*@) {
1129 $in_comment = 1;
1130 }
1131 if (!$in_comment && $current_comment ne '') {
1132 $current_comment = '';
1133 }
1134 $current_comment .= $line . "\n" if ($in_comment);
1135 if ($line =~ m@\*/@) {
1136 $in_comment = 0;
1137 }
1138 }
1139
1140 chomp($current_comment);
1141 return($current_comment);
1142}
1143sub ctx_has_comment {
1144 my ($first_line, $end_line) = @_;
1145 my $cmt = ctx_locate_comment($first_line, $end_line);
1146
Andy Whitcroft00df3442007-06-08 13:47:06 -07001147 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001148 ##print "CMMT: $cmt\n";
1149
1150 return ($cmt ne '');
1151}
1152
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001153sub raw_line {
1154 my ($linenr, $cnt) = @_;
1155
1156 my $offset = $linenr - 1;
1157 $cnt++;
1158
1159 my $line;
1160 while ($cnt) {
1161 $line = $rawlines[$offset++];
1162 next if (defined($line) && $line =~ /^-/);
1163 $cnt--;
1164 }
1165
1166 return $line;
1167}
1168
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001169sub cat_vet {
1170 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001171 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001172
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001173 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001174 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1175 $res .= $1;
1176 if ($2 ne '') {
1177 $coded = sprintf("^%c", unpack('C', $2) + 64);
1178 $res .= $coded;
1179 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001180 }
1181 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001182
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001183 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001184}
1185
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001186my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001187my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001188my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001189my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001190
1191sub annotate_reset {
1192 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001193 $av_pending = '_';
1194 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001195 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001196}
1197
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001198sub annotate_values {
1199 my ($stream, $type) = @_;
1200
1201 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001202 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001203 my $cur = $stream;
1204
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001205 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001206
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001207 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001208 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001209 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001210 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001211 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001212 print "WS($1)\n" if ($dbg_values > 1);
1213 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001214 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001215 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001216 }
1217
Florian Micklerc023e4732011-01-12 16:59:58 -08001218 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001219 print "CAST($1)\n" if ($dbg_values > 1);
1220 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001221 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001222
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001223 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001224 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001225 $type = 'T';
1226
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001227 } elsif ($cur =~ /^($Modifier)\s*/) {
1228 print "MODIFIER($1)\n" if ($dbg_values > 1);
1229 $type = 'T';
1230
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001231 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001232 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001233 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001234 push(@av_paren_type, $type);
1235 if ($2 ne '') {
1236 $av_pending = 'N';
1237 }
1238 $type = 'E';
1239
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001240 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001241 print "UNDEF($1)\n" if ($dbg_values > 1);
1242 $av_preprocessor = 1;
1243 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001244
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001245 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001246 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001247 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001248
1249 push(@av_paren_type, $type);
1250 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001251 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001252
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001253 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001254 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1255 $av_preprocessor = 1;
1256
1257 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1258
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001259 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001260
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001261 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001262 print "PRE_END($1)\n" if ($dbg_values > 1);
1263
1264 $av_preprocessor = 1;
1265
1266 # Assume all arms of the conditional end as this
1267 # one does, and continue as if the #endif was not here.
1268 pop(@av_paren_type);
1269 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001270 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001271
1272 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001273 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001274
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001275 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1276 print "ATTR($1)\n" if ($dbg_values > 1);
1277 $av_pending = $type;
1278 $type = 'N';
1279
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001280 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001281 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001282 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001283 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001284 }
1285 $type = 'N';
1286
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001287 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001288 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001289 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001290 $type = 'N';
1291
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001292 } elsif ($cur =~/^(case)/o) {
1293 print "CASE($1)\n" if ($dbg_values > 1);
1294 $av_pend_colon = 'C';
1295 $type = 'N';
1296
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001297 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001298 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001299 $type = 'N';
1300
1301 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001302 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001303 push(@av_paren_type, $av_pending);
1304 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001305 $type = 'N';
1306
1307 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001308 my $new_type = pop(@av_paren_type);
1309 if ($new_type ne '_') {
1310 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001311 print "PAREN('$1') -> $type\n"
1312 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001313 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001314 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001315 }
1316
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001317 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001318 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001319 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001320 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001321
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001322 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1323 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001324 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001325 } elsif ($type eq 'E') {
1326 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001327 }
1328 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1329 $type = 'V';
1330
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001331 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001332 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001333 $type = 'V';
1334
1335 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001336 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001337 $type = 'N';
1338
Andy Whitcroftcf655042008-03-04 14:28:20 -08001339 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001340 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001341 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001342 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001343
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001344 } elsif ($cur =~/^(,)/) {
1345 print "COMMA($1)\n" if ($dbg_values > 1);
1346 $type = 'C';
1347
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001348 } elsif ($cur =~ /^(\?)/o) {
1349 print "QUESTION($1)\n" if ($dbg_values > 1);
1350 $type = 'N';
1351
1352 } elsif ($cur =~ /^(:)/o) {
1353 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1354
1355 substr($var, length($res), 1, $av_pend_colon);
1356 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1357 $type = 'E';
1358 } else {
1359 $type = 'N';
1360 }
1361 $av_pend_colon = 'O';
1362
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001363 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001364 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001365 $type = 'N';
1366
Andy Whitcroft0d413862008-10-15 22:02:16 -07001367 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001368 my $variant;
1369
1370 print "OPV($1)\n" if ($dbg_values > 1);
1371 if ($type eq 'V') {
1372 $variant = 'B';
1373 } else {
1374 $variant = 'U';
1375 }
1376
1377 substr($var, length($res), 1, $variant);
1378 $type = 'N';
1379
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001380 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001381 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001382 if ($1 ne '++' && $1 ne '--') {
1383 $type = 'N';
1384 }
1385
1386 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001387 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001388 }
1389 if (defined $1) {
1390 $cur = substr($cur, length($1));
1391 $res .= $type x length($1);
1392 }
1393 }
1394
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001395 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001396}
1397
Andy Whitcroft8905a672007-11-28 16:21:06 -08001398sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001399 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001400 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001401 ^(?:
1402 $Modifier|
1403 $Storage|
1404 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001405 DEFINE_\S+
1406 )$|
1407 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001408 goto|
1409 return|
1410 case|
1411 else|
1412 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001413 do|
1414 \#|
1415 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001416 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001417 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001418 )}x;
1419 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1420 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001421 # Check for modifiers.
1422 $possible =~ s/\s*$Storage\s*//g;
1423 $possible =~ s/\s*$Sparse\s*//g;
1424 if ($possible =~ /^\s*$/) {
1425
1426 } elsif ($possible =~ /\s/) {
1427 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001428 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001429 if ($modifier !~ $notPermitted) {
1430 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1431 push(@modifierList, $modifier);
1432 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001433 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001434
1435 } else {
1436 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1437 push(@typeList, $possible);
1438 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001439 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001440 } else {
1441 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001442 }
1443}
1444
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001445my $prefix = '';
1446
Joe Perches000d1cc12011-07-25 17:13:25 -07001447sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001448 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001449
Joe Perchescbec18a2014-04-03 14:49:19 -07001450 return defined $use_type{$type} if (scalar keys %use_type > 0);
1451
1452 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001453}
1454
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001455sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001456 my ($level, $type, $msg) = @_;
1457
1458 if (!show_type($type) ||
1459 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001460 return 0;
1461 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001462 my $line;
1463 if ($show_types) {
Joe Perchescbec18a2014-04-03 14:49:19 -07001464 $line = "$prefix$level:$type: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001465 } else {
Joe Perchescbec18a2014-04-03 14:49:19 -07001466 $line = "$prefix$level: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001467 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001468 $line = (split('\n', $line))[0] . "\n" if ($terse);
1469
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001470 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001471
1472 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001473}
Joe Perchescbec18a2014-04-03 14:49:19 -07001474
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001475sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001476 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001477}
Joe Perches000d1cc12011-07-25 17:13:25 -07001478
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001479sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001480 my ($type, $msg) = @_;
1481
1482 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001483 our $clean = 0;
1484 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001485 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001486 }
Joe Perches3705ce52013-07-03 15:05:31 -07001487 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001488}
1489sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001490 my ($type, $msg) = @_;
1491
1492 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001493 our $clean = 0;
1494 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001495 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001496 }
Joe Perches3705ce52013-07-03 15:05:31 -07001497 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001498}
1499sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001500 my ($type, $msg) = @_;
1501
1502 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001503 our $clean = 0;
1504 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001505 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001506 }
Joe Perches3705ce52013-07-03 15:05:31 -07001507 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001508}
1509
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001510sub check_absolute_file {
1511 my ($absolute, $herecurr) = @_;
1512 my $file = $absolute;
1513
1514 ##print "absolute<$absolute>\n";
1515
1516 # See if any suffix of this path is a path within the tree.
1517 while ($file =~ s@^[^/]*/@@) {
1518 if (-f "$root/$file") {
1519 ##print "file<$file>\n";
1520 last;
1521 }
1522 }
1523 if (! -f _) {
1524 return 0;
1525 }
1526
1527 # It is, so see if the prefix is acceptable.
1528 my $prefix = $absolute;
1529 substr($prefix, -length($file)) = '';
1530
1531 ##print "prefix<$prefix>\n";
1532 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001533 WARN("USE_RELATIVE_PATH",
1534 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001535 }
1536}
1537
Joe Perches3705ce52013-07-03 15:05:31 -07001538sub trim {
1539 my ($string) = @_;
1540
Joe Perchesb34c6482013-09-11 14:24:01 -07001541 $string =~ s/^\s+|\s+$//g;
1542
1543 return $string;
1544}
1545
1546sub ltrim {
1547 my ($string) = @_;
1548
1549 $string =~ s/^\s+//;
1550
1551 return $string;
1552}
1553
1554sub rtrim {
1555 my ($string) = @_;
1556
1557 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001558
1559 return $string;
1560}
1561
Joe Perches52ea8502013-11-12 15:10:09 -08001562sub string_find_replace {
1563 my ($string, $find, $replace) = @_;
1564
1565 $string =~ s/$find/$replace/g;
1566
1567 return $string;
1568}
1569
Joe Perches3705ce52013-07-03 15:05:31 -07001570sub tabify {
1571 my ($leading) = @_;
1572
1573 my $source_indent = 8;
1574 my $max_spaces_before_tab = $source_indent - 1;
1575 my $spaces_to_tab = " " x $source_indent;
1576
1577 #convert leading spaces to tabs
1578 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1579 #Remove spaces before a tab
1580 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1581
1582 return "$leading";
1583}
1584
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001585sub pos_last_openparen {
1586 my ($line) = @_;
1587
1588 my $pos = 0;
1589
1590 my $opens = $line =~ tr/\(/\(/;
1591 my $closes = $line =~ tr/\)/\)/;
1592
1593 my $last_openparen = 0;
1594
1595 if (($opens == 0) || ($closes >= $opens)) {
1596 return -1;
1597 }
1598
1599 my $len = length($line);
1600
1601 for ($pos = 0; $pos < $len; $pos++) {
1602 my $string = substr($line, $pos);
1603 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1604 $pos += length($1) - 1;
1605 } elsif (substr($line, $pos, 1) eq '(') {
1606 $last_openparen = $pos;
1607 } elsif (index($string, '(') == -1) {
1608 last;
1609 }
1610 }
1611
Joe Perches91cb5192014-04-03 14:49:32 -07001612 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001613}
1614
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001615sub process {
1616 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001617
1618 my $linenr=0;
1619 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001620 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001621 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001622 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001623
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001624 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001625 my $indent;
1626 my $previndent=0;
1627 my $stashindent=0;
1628
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001629 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001630 my $signoff = 0;
1631 my $is_patch = 0;
1632
Joe Perches15662b32011-10-31 17:13:12 -07001633 my $in_header_lines = 1;
1634 my $in_commit_log = 0; #Scanning lines before patch
1635
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001636 my $non_utf8_charset = 0;
1637
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001638 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001639 our $cnt_lines = 0;
1640 our $cnt_error = 0;
1641 our $cnt_warn = 0;
1642 our $cnt_chk = 0;
1643
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001644 # Trace the real file/line as we go.
1645 my $realfile = '';
1646 my $realline = 0;
1647 my $realcnt = 0;
1648 my $here = '';
1649 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001650 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001651 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001652 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001653
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001654 my $prev_values = 'E';
1655
1656 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001657 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001658 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001659 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001660 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001661
Joe Perches7e51f192013-09-11 14:23:57 -07001662 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001663
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001664 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001665 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001666 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001667 my @setup_docs = ();
1668 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001669
Joe Perchesd8b07712013-11-12 15:10:06 -08001670 my $camelcase_file_seeded = 0;
1671
Andy Whitcroft773647a2008-03-28 14:15:58 -07001672 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001673 my $line;
1674 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001675 $linenr++;
1676 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001677
Joe Perches3705ce52013-07-03 15:05:31 -07001678 push(@fixed, $rawline) if ($fix);
1679
Andy Whitcroft773647a2008-03-28 14:15:58 -07001680 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001681 $setup_docs = 0;
1682 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1683 $setup_docs = 1;
1684 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001685 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001686 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001687 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1688 $realline=$1-1;
1689 if (defined $2) {
1690 $realcnt=$3+1;
1691 } else {
1692 $realcnt=1+1;
1693 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001694 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001695
1696 # Guestimate if this is a continuing comment. Run
1697 # the context looking for a comment "edge". If this
1698 # edge is a close comment then we must be in a comment
1699 # at context start.
1700 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001701 my $cnt = $realcnt;
1702 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1703 next if (defined $rawlines[$ln - 1] &&
1704 $rawlines[$ln - 1] =~ /^-/);
1705 $cnt--;
1706 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001707 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001708 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1709 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1710 ($edge) = $1;
1711 last;
1712 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001713 }
1714 if (defined $edge && $edge eq '*/') {
1715 $in_comment = 1;
1716 }
1717
1718 # Guestimate if this is a continuing comment. If this
1719 # is the start of a diff block and this line starts
1720 # ' *' then it is very likely a comment.
1721 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001722 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001723 {
1724 $in_comment = 1;
1725 }
1726
1727 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1728 sanitise_line_reset($in_comment);
1729
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001730 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001731 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001732 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001733 $line = sanitise_line($rawline);
1734 }
1735 push(@lines, $line);
1736
1737 if ($realcnt > 1) {
1738 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1739 } else {
1740 $realcnt = 0;
1741 }
1742
1743 #print "==>$rawline\n";
1744 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001745
1746 if ($setup_docs && $line =~ /^\+/) {
1747 push(@setup_docs, $line);
1748 }
1749 }
1750
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001751 $prefix = '';
1752
Andy Whitcroft773647a2008-03-28 14:15:58 -07001753 $realcnt = 0;
1754 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001755 foreach my $line (@lines) {
1756 $linenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001757 my $sline = $line; #copy of $line
1758 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001759
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001760 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001761
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001762#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001763 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001764 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001765 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001766 $realline=$1-1;
1767 if (defined $2) {
1768 $realcnt=$3+1;
1769 } else {
1770 $realcnt=1+1;
1771 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001772 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001773 $prev_values = 'E';
1774
Andy Whitcroft773647a2008-03-28 14:15:58 -07001775 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001776 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001777 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001778 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001779 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001780
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001781# track the line number as we move through the hunk, note that
1782# new versions of GNU diff omit the leading space on completely
1783# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001784 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001785 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001786 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001787
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001788 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001789 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001790
1791 # Track the previous line.
1792 ($prevline, $stashline) = ($stashline, $line);
1793 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001794 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1795
Andy Whitcroft773647a2008-03-28 14:15:58 -07001796 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001797
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001798 } elsif ($realcnt == 1) {
1799 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001800 }
1801
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001802 my $hunk_line = ($realcnt != 0);
1803
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001804#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001805 $prefix = "$filename:$realline: " if ($emacs && $file);
1806 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1807
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001808 $here = "#$linenr: " if (!$file);
1809 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001810
1811 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001812 if ($line =~ /^diff --git.*?(\S+)$/) {
1813 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001814 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001815 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001816 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001817 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001818 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001819 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001820
1821 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001822 if (!$file && $tree && $p1_prefix ne '' &&
1823 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001824 WARN("PATCH_PREFIX",
1825 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001826 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001827
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001828 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001829 ERROR("MODIFIED_INCLUDE_ASM",
1830 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
Andy Whitcroft773647a2008-03-28 14:15:58 -07001831 }
1832 next;
1833 }
1834
Randy Dunlap389834b2007-06-08 13:47:03 -07001835 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001836
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001837 my $hereline = "$here\n$rawline\n";
1838 my $herecurr = "$here\n$rawline\n";
1839 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001840
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001841 $cnt_lines++ if ($realcnt != 0);
1842
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001843# Check for incorrect file permissions
1844 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1845 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001846 if ($realfile !~ m@scripts/@ &&
1847 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001848 ERROR("EXECUTE_PERMISSIONS",
1849 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001850 }
1851 }
1852
Joe Perches20112472011-07-25 17:13:23 -07001853# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001854 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001855 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001856 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001857 }
1858
1859# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001860 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001861 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001862 my $space_before = $1;
1863 my $sign_off = $2;
1864 my $space_after = $3;
1865 my $email = $4;
1866 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1867
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001868 if ($sign_off !~ /$signature_tags/) {
1869 WARN("BAD_SIGN_OFF",
1870 "Non-standard signature: $sign_off\n" . $herecurr);
1871 }
Joe Perches20112472011-07-25 17:13:23 -07001872 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07001873 if (WARN("BAD_SIGN_OFF",
1874 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1875 $fix) {
1876 $fixed[$linenr - 1] =
1877 "$ucfirst_sign_off $email";
1878 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001879 }
Joe Perches20112472011-07-25 17:13:23 -07001880 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07001881 if (WARN("BAD_SIGN_OFF",
1882 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1883 $fix) {
1884 $fixed[$linenr - 1] =
1885 "$ucfirst_sign_off $email";
1886 }
1887
Joe Perches20112472011-07-25 17:13:23 -07001888 }
1889 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07001890 if (WARN("BAD_SIGN_OFF",
1891 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1892 $fix) {
1893 $fixed[$linenr - 1] =
1894 "$ucfirst_sign_off $email";
1895 }
Joe Perches20112472011-07-25 17:13:23 -07001896 }
1897
1898 my ($email_name, $email_address, $comment) = parse_email($email);
1899 my $suggested_email = format_email(($email_name, $email_address));
1900 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001901 ERROR("BAD_SIGN_OFF",
1902 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001903 } else {
1904 my $dequoted = $suggested_email;
1905 $dequoted =~ s/^"//;
1906 $dequoted =~ s/" </ </;
1907 # Don't force email to have quotes
1908 # Allow just an angle bracketed address
1909 if ("$dequoted$comment" ne $email &&
1910 "<$email_address>$comment" ne $email &&
1911 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001912 WARN("BAD_SIGN_OFF",
1913 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001914 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001915 }
Joe Perches7e51f192013-09-11 14:23:57 -07001916
1917# Check for duplicate signatures
1918 my $sig_nospace = $line;
1919 $sig_nospace =~ s/\s//g;
1920 $sig_nospace = lc($sig_nospace);
1921 if (defined $signatures{$sig_nospace}) {
1922 WARN("BAD_SIGN_OFF",
1923 "Duplicate signature\n" . $herecurr);
1924 } else {
1925 $signatures{$sig_nospace} = 1;
1926 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001927 }
1928
Christopher Covington7ebd05e2014-04-03 14:49:31 -07001929# Check for unwanted Gerrit info
1930 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
1931 ERROR("GERRIT_CHANGE_ID",
1932 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
1933 }
1934
Andy Whitcroft00df3442007-06-08 13:47:06 -07001935# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001936 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001937 ERROR("CORRUPTED_PATCH",
1938 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001939 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001940 }
1941
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001942# Check for absolute kernel paths.
1943 if ($tree) {
1944 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1945 my $file = $1;
1946
1947 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1948 check_absolute_file($1, $herecurr)) {
1949 #
1950 } else {
1951 check_absolute_file($file, $herecurr);
1952 }
1953 }
1954 }
1955
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001956# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1957 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001958 $rawline !~ m/^$UTF8*$/) {
1959 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1960
1961 my $blank = copy_spacing($rawline);
1962 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1963 my $hereptr = "$hereline$ptr\n";
1964
Joe Perches34d99212011-07-25 17:13:26 -07001965 CHK("INVALID_UTF8",
1966 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001967 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001968
Joe Perches15662b32011-10-31 17:13:12 -07001969# Check if it's the start of a commit log
1970# (not a header line and we haven't seen the patch filename)
1971 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001972 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001973 $in_header_lines = 0;
1974 $in_commit_log = 1;
1975 }
1976
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001977# Check if there is UTF-8 in a commit log when a mail header has explicitly
1978# declined it, i.e defined some charset where it is missing.
1979 if ($in_header_lines &&
1980 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1981 $1 !~ /utf-8/i) {
1982 $non_utf8_charset = 1;
1983 }
1984
1985 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001986 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001987 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001988 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1989 }
1990
Andy Whitcroft306708542008-10-15 22:02:28 -07001991# ignore non-hunk lines and lines being removed
1992 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001993
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001994#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001995 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001996 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07001997 if (ERROR("DOS_LINE_ENDINGS",
1998 "DOS line endings\n" . $herevet) &&
1999 $fix) {
2000 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
2001 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002002 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2003 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002004 if (ERROR("TRAILING_WHITESPACE",
2005 "trailing whitespace\n" . $herevet) &&
2006 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002007 $fixed[$linenr - 1] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002008 }
2009
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002010 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002011 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002012
Josh Triplett4783f892013-11-12 15:10:12 -08002013# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002014 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002015 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2016 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002017 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2018 my $msg_type = \&ERROR;
2019 $msg_type = \&CHK if ($file);
2020 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002021 "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)
Josh Triplett4783f892013-11-12 15:10:12 -08002022 }
2023
Andi Kleen33549572010-05-24 14:33:29 -07002024# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002025# Only applies when adding the entry originally, after that we do not have
2026# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002027 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08002028 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002029 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002030 my $cnt = $realcnt;
2031 my $ln = $linenr + 1;
2032 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002033 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002034 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002035 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002036 $f = $lines[$ln - 1];
2037 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2038 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002039
2040 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002041
2042 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
2043 $is_start = 1;
2044 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
2045 $length = -1;
2046 }
2047
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002048 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002049 $f =~ s/#.*//;
2050 $f =~ s/^\s+//;
2051 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002052 if ($f =~ /^\s*config\s/) {
2053 $is_end = 1;
2054 last;
2055 }
Andi Kleen33549572010-05-24 14:33:29 -07002056 $length++;
2057 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002058 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08002059 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2060 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002061 }
2062
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002063# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2064 if ($realfile =~ /Kconfig/ &&
2065 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2066 WARN("CONFIG_EXPERIMENTAL",
2067 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2068 }
2069
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002070 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2071 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2072 my $flag = $1;
2073 my $replacement = {
2074 'EXTRA_AFLAGS' => 'asflags-y',
2075 'EXTRA_CFLAGS' => 'ccflags-y',
2076 'EXTRA_CPPFLAGS' => 'cppflags-y',
2077 'EXTRA_LDFLAGS' => 'ldflags-y',
2078 };
2079
2080 WARN("DEPRECATED_VARIABLE",
2081 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2082 }
2083
Rob Herringbff5da42014-01-23 15:54:51 -08002084# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002085 if (defined $root &&
2086 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2087 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2088
Rob Herringbff5da42014-01-23 15:54:51 -08002089 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2090
Florian Vaussardcc933192014-04-03 14:49:27 -07002091 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2092 my $vp_file = $dt_path . "vendor-prefixes.txt";
2093
Rob Herringbff5da42014-01-23 15:54:51 -08002094 foreach my $compat (@compats) {
2095 my $compat2 = $compat;
Rob Herringbff5da42014-01-23 15:54:51 -08002096 $compat2 =~ s/\,[a-z]*\-/\,<\.\*>\-/;
2097 `grep -Erq "$compat|$compat2" $dt_path`;
2098 if ( $? >> 8 ) {
2099 WARN("UNDOCUMENTED_DT_STRING",
2100 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2101 }
2102
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002103 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2104 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002105 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002106 if ( $? >> 8 ) {
2107 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002108 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002109 }
2110 }
2111 }
2112
Andy Whitcroft5368df22008-10-15 22:02:27 -07002113# check we are in a valid source file if not then ignore this hunk
2114 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2115
Joe Perches6cd7f382012-12-17 16:01:54 -08002116#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002117 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002118 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002119 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002120 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002121 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002122 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002123 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002124 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002125 }
2126
Josh Triplettca56dc02012-03-23 15:02:21 -07002127# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002128# to grep for the string. Make exceptions when the previous string ends in a
2129# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2130# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002131 if ($line =~ /^\+\s*"/ &&
2132 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002133 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002134 WARN("SPLIT_STRING",
2135 "quoted string split across lines\n" . $hereprev);
2136 }
2137
Joe Perches5e79d962010-03-05 13:43:55 -08002138# check for spaces before a quoted newline
2139 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002140 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2141 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2142 $fix) {
2143 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2144 }
2145
Joe Perches5e79d962010-03-05 13:43:55 -08002146 }
2147
Andy Whitcroft8905a672007-11-28 16:21:06 -08002148# check for adding lines without a newline.
2149 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002150 WARN("MISSING_EOF_NEWLINE",
2151 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002152 }
2153
Mike Frysinger42e41c52009-09-21 17:04:40 -07002154# Blackfin: use hi/lo macros
2155 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2156 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2157 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002158 ERROR("LO_MACRO",
2159 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002160 }
2161 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2162 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002163 ERROR("HI_MACRO",
2164 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002165 }
2166 }
2167
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002168# check we are in a valid source file C or perl if not then ignore this hunk
2169 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002170
2171# at the beginning of a line any tabs must come first and anything
2172# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002173 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2174 $rawline =~ /^\+\s* \s*/) {
2175 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002176 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002177 if (ERROR("CODE_INDENT",
2178 "code indent should use tabs where possible\n" . $herevet) &&
2179 $fix) {
2180 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2181 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002182 }
2183
Alberto Panizzo08e44362010-03-05 13:43:54 -08002184# check for space before tabs.
2185 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2186 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002187 if (WARN("SPACE_BEFORE_TAB",
2188 "please, no space before tabs\n" . $herevet) &&
2189 $fix) {
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002190 while ($fixed[$linenr - 1] =~
2191 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2192 while ($fixed[$linenr - 1] =~
2193 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002194 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002195 }
2196
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002197# check for && or || at the start of a line
2198 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2199 CHK("LOGICAL_CONTINUATIONS",
2200 "Logical continuations should be on the previous line\n" . $hereprev);
2201 }
2202
2203# check multi-line statement indentation matches previous line
2204 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002205 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002206 $prevline =~ /^\+(\t*)(.*)$/;
2207 my $oldindent = $1;
2208 my $rest = $2;
2209
2210 my $pos = pos_last_openparen($rest);
2211 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002212 $line =~ /^(\+| )([ \t]*)/;
2213 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002214
2215 my $goodtabindent = $oldindent .
2216 "\t" x ($pos / 8) .
2217 " " x ($pos % 8);
2218 my $goodspaceindent = $oldindent . " " x $pos;
2219
2220 if ($newindent ne $goodtabindent &&
2221 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002222
2223 if (CHK("PARENTHESIS_ALIGNMENT",
2224 "Alignment should match open parenthesis\n" . $hereprev) &&
2225 $fix && $line =~ /^\+/) {
2226 $fixed[$linenr - 1] =~
2227 s/^\+[ \t]*/\+$goodtabindent/;
2228 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002229 }
2230 }
2231 }
2232
Joe Perches23f780c2013-07-03 15:05:31 -07002233 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002234 if (CHK("SPACING",
2235 "No space is necessary after a cast\n" . $hereprev) &&
2236 $fix) {
2237 $fixed[$linenr - 1] =~
2238 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2239 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002240 }
2241
Joe Perches05880602012-10-04 17:13:35 -07002242 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002243 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002244 $rawline =~ /^\+[ \t]*\*/ &&
2245 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002246 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2247 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2248 }
2249
2250 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002251 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2252 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002253 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002254 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2255 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2256 "networking block comments start with * on subsequent lines\n" . $hereprev);
2257 }
2258
2259 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002260 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2261 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2262 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2263 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002264 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2265 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2266 }
2267
Joe Perches3b617e32014-04-03 14:49:28 -07002268# check for missing blank lines after declarations
2269 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2270 $prevline =~ /^\+\s+$Declare\s+$Ident/ &&
2271 !($prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2272 $prevline =~ /(?:\{\s*|\\)$/) && #extended lines
2273 $sline =~ /^\+\s+/ && #Not at char 1
2274 !($sline =~ /^\+\s+$Declare/ ||
2275 $sline =~ /^\+\s+$Ident\s+$Ident/ || #eg: typedef foo
2276 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2277 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(])/ ||
2278 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) {
2279 WARN("SPACING",
2280 "networking uses a blank line after declarations\n" . $hereprev);
2281 }
2282
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002283# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002284# Exceptions:
2285# 1) within comments
2286# 2) indented preprocessor commands
2287# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002288 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002289 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002290 if (WARN("LEADING_SPACE",
2291 "please, no spaces at the start of a line\n" . $herevet) &&
2292 $fix) {
2293 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2294 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002295 }
2296
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002297# check we are in a valid C source file if not then ignore this hunk
2298 next if ($realfile !~ /\.(h|c)$/);
2299
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002300# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2301 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2302 WARN("CONFIG_EXPERIMENTAL",
2303 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2304 }
2305
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002306# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002307 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002308 WARN("CVS_KEYWORD",
2309 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002310 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002311
Mike Frysinger42e41c52009-09-21 17:04:40 -07002312# Blackfin: don't use __builtin_bfin_[cs]sync
2313 if ($line =~ /__builtin_bfin_csync/) {
2314 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002315 ERROR("CSYNC",
2316 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002317 }
2318 if ($line =~ /__builtin_bfin_ssync/) {
2319 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002320 ERROR("SSYNC",
2321 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002322 }
2323
Joe Perches56e77d72013-02-21 16:44:14 -08002324# check for old HOTPLUG __dev<foo> section markings
2325 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2326 WARN("HOTPLUG_SECTION",
2327 "Using $1 is unnecessary\n" . $herecurr);
2328 }
2329
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002330# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002331 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2332 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002333#print "LINE<$line>\n";
2334 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002335 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002336 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002337 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002338 $stat =~ s/\n./\n /g;
2339 $cond =~ s/\n./\n /g;
2340
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002341#print "linenr<$linenr> <$stat>\n";
2342 # If this statement has no statement boundaries within
2343 # it there is no point in retrying a statement scan
2344 # until we hit end of it.
2345 my $frag = $stat; $frag =~ s/;+\s*$//;
2346 if ($frag !~ /(?:{|;)/) {
2347#print "skip<$line_nr_next>\n";
2348 $suppress_statement = $line_nr_next;
2349 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002350
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002351 # Find the real next line.
2352 $realline_next = $line_nr_next;
2353 if (defined $realline_next &&
2354 (!defined $lines[$realline_next - 1] ||
2355 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2356 $realline_next++;
2357 }
2358
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002359 my $s = $stat;
2360 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002361
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002362 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002363 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002364
2365 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002366 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002367
Andy Whitcroft463f2862009-09-21 17:04:34 -07002368 } elsif ($s =~ /^.\s*else\b/s) {
2369
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002370 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002371 } 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) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002372 my $type = $1;
2373 $type =~ s/\s+/ /g;
2374 possible($type, "A:" . $s);
2375
Andy Whitcroft8905a672007-11-28 16:21:06 -08002376 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002377 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002378 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002379 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002380
2381 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002382 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002383 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002384 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002385
2386 # Check for any sort of function declaration.
2387 # int foo(something bar, other baz);
2388 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002389 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002390 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002391
Andy Whitcroftcf655042008-03-04 14:28:20 -08002392 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002393 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002394 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002395
Andy Whitcroft8905a672007-11-28 16:21:06 -08002396 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002397 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002398
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002399 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002400 }
2401 }
2402 }
2403
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002404 }
2405
Andy Whitcroft653d4872007-06-23 17:16:34 -07002406#
2407# Checks which may be anchored in the context.
2408#
2409
2410# Check for switch () and associated case and default
2411# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002412 if ($line=~/\bswitch\s*\(.*\)/) {
2413 my $err = '';
2414 my $sep = '';
2415 my @ctx = ctx_block_outer($linenr, $realcnt);
2416 shift(@ctx);
2417 for my $ctx (@ctx) {
2418 my ($clen, $cindent) = line_stats($ctx);
2419 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2420 $indent != $cindent) {
2421 $err .= "$sep$ctx\n";
2422 $sep = '';
2423 } else {
2424 $sep = "[...]\n";
2425 }
2426 }
2427 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002428 ERROR("SWITCH_CASE_INDENT_LEVEL",
2429 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002430 }
2431 }
2432
2433# if/while/etc brace do not go on next line, unless defining a do while loop,
2434# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002435 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002436 my $pre_ctx = "$1$2";
2437
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002438 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002439
2440 if ($line =~ /^\+\t{6,}/) {
2441 WARN("DEEP_INDENTATION",
2442 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2443 }
2444
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002445 my $ctx_cnt = $realcnt - $#ctx - 1;
2446 my $ctx = join("\n", @ctx);
2447
Andy Whitcroft548596d2008-07-23 21:29:01 -07002448 my $ctx_ln = $linenr;
2449 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002450
Andy Whitcroft548596d2008-07-23 21:29:01 -07002451 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2452 defined $lines[$ctx_ln - 1] &&
2453 $lines[$ctx_ln - 1] =~ /^-/)) {
2454 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2455 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002456 $ctx_ln++;
2457 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002458
Andy Whitcroft53210162008-07-23 21:29:03 -07002459 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2460 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002461
2462 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002463 ERROR("OPEN_BRACE",
2464 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002465 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002466 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002467 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2468 $ctx =~ /\)\s*\;\s*$/ &&
2469 defined $lines[$ctx_ln - 1])
2470 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002471 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2472 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002473 WARN("TRAILING_SEMICOLON",
2474 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002475 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002476 }
2477 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002478 }
2479
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002480# Check relative indent for conditionals and blocks.
2481 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002482 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2483 ctx_statement_block($linenr, $realcnt, 0)
2484 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002485 my ($s, $c) = ($stat, $cond);
2486
2487 substr($s, 0, length($c), '');
2488
2489 # Make sure we remove the line prefixes as we have
2490 # none on the first line, and are going to readd them
2491 # where necessary.
2492 $s =~ s/\n./\n/gs;
2493
2494 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002495 my @newlines = ($c =~ /\n/gs);
2496 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002497
2498 # We want to check the first line inside the block
2499 # starting at the end of the conditional, so remove:
2500 # 1) any blank line termination
2501 # 2) any opening brace { on end of the line
2502 # 3) any do (...) {
2503 my $continuation = 0;
2504 my $check = 0;
2505 $s =~ s/^.*\bdo\b//;
2506 $s =~ s/^\s*{//;
2507 if ($s =~ s/^\s*\\//) {
2508 $continuation = 1;
2509 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002510 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002511 $check = 1;
2512 $cond_lines++;
2513 }
2514
2515 # Also ignore a loop construct at the end of a
2516 # preprocessor statement.
2517 if (($prevline =~ /^.\s*#\s*define\s/ ||
2518 $prevline =~ /\\\s*$/) && $continuation == 0) {
2519 $check = 0;
2520 }
2521
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002522 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002523 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002524 while ($cond_ptr != $cond_lines) {
2525 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002526
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002527 # If we see an #else/#elif then the code
2528 # is not linear.
2529 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2530 $check = 0;
2531 }
2532
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002533 # Ignore:
2534 # 1) blank lines, they should be at 0,
2535 # 2) preprocessor lines, and
2536 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002537 if ($continuation ||
2538 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002539 $s =~ /^\s*#\s*?/ ||
2540 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002541 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002542 if ($s =~ s/^.*?\n//) {
2543 $cond_lines++;
2544 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002545 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002546 }
2547
2548 my (undef, $sindent) = line_stats("+" . $s);
2549 my $stat_real = raw_line($linenr, $cond_lines);
2550
2551 # Check if either of these lines are modified, else
2552 # this is not this patch's fault.
2553 if (!defined($stat_real) ||
2554 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2555 $check = 0;
2556 }
2557 if (defined($stat_real) && $cond_lines > 1) {
2558 $stat_real = "[...]\n$stat_real";
2559 }
2560
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002561 #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";
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002562
2563 if ($check && (($sindent % 8) != 0 ||
2564 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002565 WARN("SUSPECT_CODE_INDENT",
2566 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002567 }
2568 }
2569
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002570 # Track the 'values' across context and added lines.
2571 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002572 my ($curr_values, $curr_vars) =
2573 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002574 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002575 if ($dbg_values) {
2576 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002577 print "$linenr > .$outline\n";
2578 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002579 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002580 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002581 $prev_values = substr($curr_values, -1);
2582
Andy Whitcroft00df3442007-06-08 13:47:06 -07002583#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002584 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002585
Andy Whitcroft653d4872007-06-23 17:16:34 -07002586# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002587 if ($dbg_type) {
2588 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002589 ERROR("TEST_TYPE",
2590 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002591 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002592 ERROR("TEST_NOT_TYPE",
2593 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002594 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002595 next;
2596 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002597# TEST: allow direct testing of the attribute matcher.
2598 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002599 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002600 ERROR("TEST_ATTR",
2601 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002602 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002603 ERROR("TEST_NOT_ATTR",
2604 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002605 }
2606 next;
2607 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002608
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002609# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002610 if ($line =~ /^.\s*{/ &&
2611 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002612 ERROR("OPEN_BRACE",
2613 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002614 }
2615
Andy Whitcroft653d4872007-06-23 17:16:34 -07002616#
2617# Checks which are anchored on the added line.
2618#
2619
2620# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002621 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002622 my $path = $1;
2623 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002624 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002625 "malformed #include filename\n" . $herecurr);
2626 }
2627 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2628 ERROR("UAPI_INCLUDE",
2629 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002630 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002631 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002632
2633# no C99 // comments
2634 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002635 if (ERROR("C99_COMMENTS",
2636 "do not use C99 // comments\n" . $herecurr) &&
2637 $fix) {
2638 my $line = $fixed[$linenr - 1];
2639 if ($line =~ /\/\/(.*)$/) {
2640 my $comment = trim($1);
2641 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2642 }
2643 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002644 }
2645 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002646 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002647 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002648
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002649# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2650# the whole statement.
2651#print "APW <$lines[$realline_next - 1]>\n";
2652 if (defined $realline_next &&
2653 exists $lines[$realline_next - 1] &&
2654 !defined $suppress_export{$realline_next} &&
2655 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2656 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002657 # Handle definitions which produce identifiers with
2658 # a prefix:
2659 # XXX(foo);
2660 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002661 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002662 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002663 $name =~ /^${Ident}_$2/) {
2664#print "FOO C name<$name>\n";
2665 $suppress_export{$realline_next} = 1;
2666
2667 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002668 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002669 ^.DEFINE_$Ident\(\Q$name\E\)|
2670 ^.DECLARE_$Ident\(\Q$name\E\)|
2671 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002672 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2673 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002674 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002675#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2676 $suppress_export{$realline_next} = 2;
2677 } else {
2678 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002679 }
2680 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002681 if (!defined $suppress_export{$linenr} &&
2682 $prevline =~ /^.\s*$/ &&
2683 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2684 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2685#print "FOO B <$lines[$linenr - 1]>\n";
2686 $suppress_export{$linenr} = 2;
2687 }
2688 if (defined $suppress_export{$linenr} &&
2689 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002690 WARN("EXPORT_SYMBOL",
2691 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002692 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002693
Joe Eloff5150bda2010-08-09 17:21:00 -07002694# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002695 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2696 if (ERROR("GLOBAL_INITIALISERS",
2697 "do not initialise globals to 0 or NULL\n" .
2698 $herecurr) &&
2699 $fix) {
2700 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2701 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002702 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002703# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002704 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2705 if (ERROR("INITIALISED_STATIC",
2706 "do not initialise statics to 0 or NULL\n" .
2707 $herecurr) &&
2708 $fix) {
2709 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2710 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002711 }
2712
Joe Perchescb710ec2010-10-26 14:23:20 -07002713# check for static const char * arrays.
2714 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002715 WARN("STATIC_CONST_CHAR_ARRAY",
2716 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002717 $herecurr);
2718 }
2719
2720# check for static char foo[] = "bar" declarations.
2721 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002722 WARN("STATIC_CONST_CHAR_ARRAY",
2723 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002724 $herecurr);
2725 }
2726
Joe Perches9b0fa602014-04-03 14:49:18 -07002727# check for non-global char *foo[] = {"bar", ...} declarations.
2728 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
2729 WARN("STATIC_CONST_CHAR_ARRAY",
2730 "char * array declaration might be better as static const\n" .
2731 $herecurr);
2732 }
2733
Joe Perchesb36190c2014-01-27 17:07:18 -08002734# check for function declarations without arguments like "int foo()"
2735 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2736 if (ERROR("FUNCTION_WITHOUT_ARGS",
2737 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2738 $fix) {
2739 $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2740 }
2741 }
2742
Joe Perches92e112f2013-12-13 11:36:22 -07002743# check for uses of DEFINE_PCI_DEVICE_TABLE
2744 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2745 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2746 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2747 $fix) {
2748 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2749 }
Joe Perches93ed0e22010-10-26 14:23:21 -07002750 }
2751
Andy Whitcroft653d4872007-06-23 17:16:34 -07002752# check for new typedefs, only function parameters and sparse annotations
2753# make sense.
2754 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002755 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002756 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002757 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002758 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002759 WARN("NEW_TYPEDEFS",
2760 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002761 }
2762
2763# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002764 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002765 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2766 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002767 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002768
Andy Whitcroft65863862009-01-06 14:41:21 -08002769 # Should start with a space.
2770 $to =~ s/^(\S)/ $1/;
2771 # Should not end with a space.
2772 $to =~ s/\s+$//;
2773 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002774 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002775 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002776
Joe Perches3705ce52013-07-03 15:05:31 -07002777## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08002778 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07002779 if (ERROR("POINTER_LOCATION",
2780 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2781 $fix) {
2782 my $sub_from = $ident;
2783 my $sub_to = $ident;
2784 $sub_to =~ s/\Q$from\E/$to/;
2785 $fixed[$linenr - 1] =~
2786 s@\Q$sub_from\E@$sub_to@;
2787 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002788 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002789 }
2790 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2791 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002792 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002793
Andy Whitcroft65863862009-01-06 14:41:21 -08002794 # Should start with a space.
2795 $to =~ s/^(\S)/ $1/;
2796 # Should not end with a space.
2797 $to =~ s/\s+$//;
2798 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002799 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002800 }
2801 # Modifiers should have spaces.
2802 $to =~ s/(\b$Modifier$)/$1 /;
2803
Joe Perches3705ce52013-07-03 15:05:31 -07002804## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08002805 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002806 if (ERROR("POINTER_LOCATION",
2807 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2808 $fix) {
2809
2810 my $sub_from = $match;
2811 my $sub_to = $match;
2812 $sub_to =~ s/\Q$from\E/$to/;
2813 $fixed[$linenr - 1] =~
2814 s@\Q$sub_from\E@$sub_to@;
2815 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002816 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002817 }
2818
2819# # no BUG() or BUG_ON()
2820# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2821# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2822# print "$herecurr";
2823# $clean = 0;
2824# }
2825
Andy Whitcroft8905a672007-11-28 16:21:06 -08002826 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002827 WARN("LINUX_VERSION_CODE",
2828 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002829 }
2830
Joe Perches17441222011-06-15 15:08:17 -07002831# check for uses of printk_ratelimit
2832 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002833 WARN("PRINTK_RATELIMITED",
2834"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002835 }
2836
Andy Whitcroft00df3442007-06-08 13:47:06 -07002837# printk should use KERN_* levels. Note that follow on printk's on the
2838# same line do not need a level, so we use the current block context
2839# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002840# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002841# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002842 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002843 my $ok = 0;
2844 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2845 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002846 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07002847 # with "\n" ignore it, else it is to blame
2848 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2849 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2850 $ok = 1;
2851 }
2852 last;
2853 }
2854 }
2855 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002856 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2857 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002858 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002859 }
2860
Joe Perches243f3802012-05-31 16:26:09 -07002861 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2862 my $orig = $1;
2863 my $level = lc($orig);
2864 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002865 my $level2 = $level;
2866 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002867 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07002868 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Joe Perches243f3802012-05-31 16:26:09 -07002869 }
2870
2871 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002872 if (WARN("PREFER_PR_LEVEL",
2873 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2874 $fix) {
2875 $fixed[$linenr - 1] =~
2876 s/\bpr_warning\b/pr_warn/;
2877 }
Joe Perches243f3802012-05-31 16:26:09 -07002878 }
2879
Joe Perchesdc139312013-02-21 16:44:13 -08002880 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2881 my $orig = $1;
2882 my $level = lc($orig);
2883 $level = "warn" if ($level eq "warning");
2884 $level = "dbg" if ($level eq "debug");
2885 WARN("PREFER_DEV_LEVEL",
2886 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2887 }
2888
Andy Whitcroft653d4872007-06-23 17:16:34 -07002889# function brace can't be on same line, except for #defines of do while,
2890# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002891 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2892 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002893 ERROR("OPEN_BRACE",
2894 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002895 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002896
Andy Whitcroft8905a672007-11-28 16:21:06 -08002897# open braces for enum, union and struct go on the same line.
2898 if ($line =~ /^.\s*{/ &&
2899 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002900 ERROR("OPEN_BRACE",
2901 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002902 }
2903
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002904# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07002905 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2906 if (WARN("SPACING",
2907 "missing space after $1 definition\n" . $herecurr) &&
2908 $fix) {
2909 $fixed[$linenr - 1] =~
2910 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2911 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002912 }
2913
Joe Perches31070b52014-01-23 15:54:49 -08002914# Function pointer declarations
2915# check spacing between type, funcptr, and args
2916# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002917 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08002918 my $declare = $1;
2919 my $pre_pointer_space = $2;
2920 my $post_pointer_space = $3;
2921 my $funcname = $4;
2922 my $post_funcname_space = $5;
2923 my $pre_args_space = $6;
2924
Joe Perches91f72e92014-04-03 14:49:12 -07002925# the $Declare variable will capture all spaces after the type
2926# so check it for a missing trailing missing space but pointer return types
2927# don't need a space so don't warn for those.
2928 my $post_declare_space = "";
2929 if ($declare =~ /(\s+)$/) {
2930 $post_declare_space = $1;
2931 $declare = rtrim($declare);
2932 }
2933 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08002934 WARN("SPACING",
2935 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07002936 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08002937 }
2938
2939# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002940# This test is not currently implemented because these declarations are
2941# equivalent to
2942# int foo(int bar, ...)
2943# and this is form shouldn't/doesn't generate a checkpatch warning.
2944#
2945# elsif ($declare =~ /\s{2,}$/) {
2946# WARN("SPACING",
2947# "Multiple spaces after return type\n" . $herecurr);
2948# }
Joe Perches31070b52014-01-23 15:54:49 -08002949
2950# unnecessary space "type ( *funcptr)(args...)"
2951 if (defined $pre_pointer_space &&
2952 $pre_pointer_space =~ /^\s/) {
2953 WARN("SPACING",
2954 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
2955 }
2956
2957# unnecessary space "type (* funcptr)(args...)"
2958 if (defined $post_pointer_space &&
2959 $post_pointer_space =~ /^\s/) {
2960 WARN("SPACING",
2961 "Unnecessary space before function pointer name\n" . $herecurr);
2962 }
2963
2964# unnecessary space "type (*funcptr )(args...)"
2965 if (defined $post_funcname_space &&
2966 $post_funcname_space =~ /^\s/) {
2967 WARN("SPACING",
2968 "Unnecessary space after function pointer name\n" . $herecurr);
2969 }
2970
2971# unnecessary space "type (*funcptr) (args...)"
2972 if (defined $pre_args_space &&
2973 $pre_args_space =~ /^\s/) {
2974 WARN("SPACING",
2975 "Unnecessary space before function pointer arguments\n" . $herecurr);
2976 }
2977
2978 if (show_type("SPACING") && $fix) {
2979 $fixed[$linenr - 1] =~
Joe Perches91f72e92014-04-03 14:49:12 -07002980 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08002981 }
2982 }
2983
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002984# check for spacing round square brackets; allowed:
2985# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002986# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2987# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002988 while ($line =~ /(.*?\s)\[/g) {
2989 my ($where, $prefix) = ($-[1], $1);
2990 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002991 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002992 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002993 if (ERROR("BRACKET_SPACE",
2994 "space prohibited before open square bracket '['\n" . $herecurr) &&
2995 $fix) {
2996 $fixed[$linenr - 1] =~
2997 s/^(\+.*?)\s+\[/$1\[/;
2998 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002999 }
3000 }
3001
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003002# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003003 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003004 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003005 my $ctx_before = substr($line, 0, $-[1]);
3006 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003007
3008 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003009 if ($name =~ /^(?:
3010 if|for|while|switch|return|case|
3011 volatile|__volatile__|
3012 __attribute__|format|__extension__|
3013 asm|__asm__)$/x)
3014 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003015 # cpp #define statements have non-optional spaces, ie
3016 # if there is a space between the name and the open
3017 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003018 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003019
3020 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003021 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003022
3023 # If this whole things ends with a type its most
3024 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003025 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003026
3027 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003028 if (WARN("SPACING",
3029 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3030 $fix) {
3031 $fixed[$linenr - 1] =~
3032 s/\b$name\s+\(/$name\(/;
3033 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003034 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003035 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003036
Andy Whitcroft653d4872007-06-23 17:16:34 -07003037# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003038 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003039 my $fixed_line = "";
3040 my $line_fixed = 0;
3041
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003042 my $ops = qr{
3043 <<=|>>=|<=|>=|==|!=|
3044 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3045 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003046 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003047 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003048 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003049 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003050
3051## print("element count: <" . $#elements . ">\n");
3052## foreach my $el (@elements) {
3053## print("el: <$el>\n");
3054## }
3055
3056 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003057 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003058
Joe Perches3705ce52013-07-03 15:05:31 -07003059 foreach my $el (@elements) {
3060 push(@fix_elements, substr($rawline, $off, length($el)));
3061 $off += length($el);
3062 }
3063
3064 $off = 0;
3065
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003066 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003067 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003068
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003069 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003070
3071 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3072
3073## print("n: <$n> good: <$good>\n");
3074
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003075 $off += length($elements[$n]);
3076
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003077 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003078 my $ca = substr($opline, 0, $off);
3079 my $cc = '';
3080 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3081 $cc = substr($opline, $off + length($elements[$n + 1]));
3082 }
3083 my $cb = "$ca$;$cc";
3084
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003085 my $a = '';
3086 $a = 'V' if ($elements[$n] ne '');
3087 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003088 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003089 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3090 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003091 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003092
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003093 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003094
3095 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003096 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003097 $c = 'V' if ($elements[$n + 2] ne '');
3098 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003099 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003100 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3101 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003102 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003103 } else {
3104 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003105 }
3106
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003107 my $ctx = "${a}x${c}";
3108
3109 my $at = "(ctx:$ctx)";
3110
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003111 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003112 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003113
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003114 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003115 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003116
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003117 # Get the full operator variant.
3118 my $opv = $op . substr($curr_vars, $off, 1);
3119
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003120 # Ignore operators passed as parameters.
3121 if ($op_type ne 'V' &&
3122 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3123
Andy Whitcroftcf655042008-03-04 14:28:20 -08003124# # Ignore comments
3125# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003126
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003127 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003128 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003129 if ($ctx !~ /.x[WEBC]/ &&
3130 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003131 if (ERROR("SPACING",
3132 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003133 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003134 $line_fixed = 1;
3135 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003136 }
3137
3138 # // is a comment
3139 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003140
Joe Perchesb00e4812014-04-03 14:49:33 -07003141 # : when part of a bitfield
3142 } elsif ($opv eq ':B') {
3143 # skip the bitfield test for now
3144
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003145 # No spaces for:
3146 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003147 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003148 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003149 if (ERROR("SPACING",
3150 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003151 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003152 if (defined $fix_elements[$n + 2]) {
3153 $fix_elements[$n + 2] =~ s/^\s+//;
3154 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003155 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003156 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003157 }
3158
3159 # , must have a space on the right.
3160 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003161 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003162 if (ERROR("SPACING",
3163 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003164 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003165 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003166 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07003167 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003168 }
3169
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003170 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003171 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003172 #warn "'*' is part of type\n";
3173
3174 # unary operators should have a space before and
3175 # none after. May be left adjacent to another
3176 # unary operator, or a cast
3177 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003178 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003179 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003180 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003181 if (ERROR("SPACING",
3182 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003183 if ($n != $last_after + 2) {
3184 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3185 $line_fixed = 1;
3186 }
Joe Perches3705ce52013-07-03 15:05:31 -07003187 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003188 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003189 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003190 # A unary '*' may be const
3191
3192 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003193 if (ERROR("SPACING",
3194 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003195 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003196 if (defined $fix_elements[$n + 2]) {
3197 $fix_elements[$n + 2] =~ s/^\s+//;
3198 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003199 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003200 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003201 }
3202
3203 # unary ++ and unary -- are allowed no space on one side.
3204 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003205 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003206 if (ERROR("SPACING",
3207 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003208 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003209 $line_fixed = 1;
3210 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003211 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003212 if ($ctx =~ /Wx[BE]/ ||
3213 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003214 if (ERROR("SPACING",
3215 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003216 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003217 $line_fixed = 1;
3218 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003219 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003220 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003221 if (ERROR("SPACING",
3222 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003223 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003224 if (defined $fix_elements[$n + 2]) {
3225 $fix_elements[$n + 2] =~ s/^\s+//;
3226 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003227 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003228 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003229 }
3230
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003231 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003232 } elsif ($op eq '<<' or $op eq '>>' or
3233 $op eq '&' or $op eq '^' or $op eq '|' or
3234 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003235 $op eq '*' or $op eq '/' or
3236 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003237 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003238 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003239 if (ERROR("SPACING",
3240 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003241 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3242 if (defined $fix_elements[$n + 2]) {
3243 $fix_elements[$n + 2] =~ s/^\s+//;
3244 }
Joe Perches3705ce52013-07-03 15:05:31 -07003245 $line_fixed = 1;
3246 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003247 }
3248
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003249 # A colon needs no spaces before when it is
3250 # terminating a case value or a label.
3251 } elsif ($opv eq ':C' || $opv eq ':L') {
3252 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003253 if (ERROR("SPACING",
3254 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003255 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003256 $line_fixed = 1;
3257 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003258 }
3259
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003260 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003261 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003262 my $ok = 0;
3263
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003264 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003265 if (($op eq '<' &&
3266 $cc =~ /^\S+\@\S+>/) ||
3267 ($op eq '>' &&
3268 $ca =~ /<\S+\@\S+$/))
3269 {
3270 $ok = 1;
3271 }
3272
Joe Perches84731622013-11-12 15:10:05 -08003273 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003274 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003275 my $msg_type = \&ERROR;
3276 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3277
3278 if (&{$msg_type}("SPACING",
3279 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003280 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3281 if (defined $fix_elements[$n + 2]) {
3282 $fix_elements[$n + 2] =~ s/^\s+//;
3283 }
Joe Perches3705ce52013-07-03 15:05:31 -07003284 $line_fixed = 1;
3285 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003286 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003287 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003288 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003289
3290## print("n: <$n> GOOD: <$good>\n");
3291
3292 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003293 }
Joe Perches3705ce52013-07-03 15:05:31 -07003294
3295 if (($#elements % 2) == 0) {
3296 $fixed_line = $fixed_line . $fix_elements[$#elements];
3297 }
3298
3299 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3300 $fixed[$linenr - 1] = $fixed_line;
3301 }
3302
3303
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003304 }
3305
Joe Perches786b6322013-07-03 15:05:32 -07003306# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003307 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003308 if (WARN("SPACING",
3309 "space prohibited before semicolon\n" . $herecurr) &&
3310 $fix) {
3311 1 while $fixed[$linenr - 1] =~
3312 s/^(\+.*\S)\s+;/$1;/;
3313 }
3314 }
3315
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003316# check for multiple assignments
3317 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003318 CHK("MULTIPLE_ASSIGNMENTS",
3319 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003320 }
3321
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003322## # check for multiple declarations, allowing for a function declaration
3323## # continuation.
3324## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3325## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3326##
3327## # Remove any bracketed sections to ensure we do not
3328## # falsly report the parameters of functions.
3329## my $ln = $line;
3330## while ($ln =~ s/\([^\(\)]*\)//g) {
3331## }
3332## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003333## WARN("MULTIPLE_DECLARATION",
3334## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003335## }
3336## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003337
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003338#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003339 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3340 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003341 if (ERROR("SPACING",
3342 "space required before the open brace '{'\n" . $herecurr) &&
3343 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003344 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003345 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003346 }
3347
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003348## # check for blank lines before declarations
3349## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3350## $prevrawline =~ /^.\s*$/) {
3351## WARN("SPACING",
3352## "No blank lines before declarations\n" . $hereprev);
3353## }
3354##
3355
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003356# closing brace should have a space following it when it has anything
3357# on the line
3358 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003359 if (ERROR("SPACING",
3360 "space required after that close brace '}'\n" . $herecurr) &&
3361 $fix) {
3362 $fixed[$linenr - 1] =~
3363 s/}((?!(?:,|;|\)))\S)/} $1/;
3364 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003365 }
3366
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003367# check spacing on square brackets
3368 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003369 if (ERROR("SPACING",
3370 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3371 $fix) {
3372 $fixed[$linenr - 1] =~
3373 s/\[\s+/\[/;
3374 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003375 }
3376 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003377 if (ERROR("SPACING",
3378 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3379 $fix) {
3380 $fixed[$linenr - 1] =~
3381 s/\s+\]/\]/;
3382 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003383 }
3384
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003385# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003386 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3387 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003388 if (ERROR("SPACING",
3389 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3390 $fix) {
3391 $fixed[$linenr - 1] =~
3392 s/\(\s+/\(/;
3393 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003394 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003395 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003396 $line !~ /for\s*\(.*;\s+\)/ &&
3397 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003398 if (ERROR("SPACING",
3399 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3400 $fix) {
3401 $fixed[$linenr - 1] =~
3402 s/\s+\)/\)/;
3403 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003404 }
3405
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003406#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003407 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003408 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003409 if (WARN("INDENTED_LABEL",
3410 "labels should not be indented\n" . $herecurr) &&
3411 $fix) {
3412 $fixed[$linenr - 1] =~
3413 s/^(.)\s+/$1/;
3414 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003415 }
3416
Joe Perches5b9553a2014-04-03 14:49:21 -07003417# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003418 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003419 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003420 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003421 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3422 my $value = $1;
3423 $value = deparenthesize($value);
3424 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3425 ERROR("RETURN_PARENTHESES",
3426 "return is not a function, parentheses are not required\n" . $herecurr);
3427 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003428 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003429 ERROR("SPACING",
3430 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003431 }
3432 }
Joe Perches507e5142013-11-12 15:10:13 -08003433
Joe Perches189248d2014-01-23 15:54:47 -08003434# if statements using unnecessary parentheses - ie: if ((foo == bar))
3435 if ($^V && $^V ge 5.10.0 &&
3436 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3437 my $openparens = $1;
3438 my $count = $openparens =~ tr@\(@\(@;
3439 my $msg = "";
3440 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3441 my $comp = $4; #Not $1 because of $LvalOrFunc
3442 $msg = " - maybe == should be = ?" if ($comp eq "==");
3443 WARN("UNNECESSARY_PARENTHESES",
3444 "Unnecessary parentheses$msg\n" . $herecurr);
3445 }
3446 }
3447
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003448# Return of what appears to be an errno should normally be -'ve
3449 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3450 my $name = $1;
3451 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003452 WARN("USE_NEGATIVE_ERRNO",
3453 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003454 }
3455 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003456
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003457# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003458 if ($line =~ /\b(if|while|for|switch)\(/) {
3459 if (ERROR("SPACING",
3460 "space required before the open parenthesis '('\n" . $herecurr) &&
3461 $fix) {
3462 $fixed[$linenr - 1] =~
3463 s/\b(if|while|for|switch)\(/$1 \(/;
3464 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003465 }
3466
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003467# Check for illegal assignment in if conditional -- and check for trailing
3468# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003469 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003470 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3471 ctx_statement_block($linenr, $realcnt, 0)
3472 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003473 my ($stat_next) = ctx_statement_block($line_nr_next,
3474 $remain_next, $off_next);
3475 $stat_next =~ s/\n./\n /g;
3476 ##print "stat<$stat> stat_next<$stat_next>\n";
3477
3478 if ($stat_next =~ /^\s*while\b/) {
3479 # If the statement carries leading newlines,
3480 # then count those as offsets.
3481 my ($whitespace) =
3482 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3483 my $offset =
3484 statement_rawlines($whitespace) - 1;
3485
3486 $suppress_whiletrailers{$line_nr_next +
3487 $offset} = 1;
3488 }
3489 }
3490 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003491 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003492 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003493 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003494
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003495 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003496 ERROR("ASSIGN_IN_IF",
3497 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003498 }
3499
3500 # Find out what is on the end of the line after the
3501 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003502 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003503 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003504 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003505 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3506 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003507 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003508 # Find out how long the conditional actually is.
3509 my @newlines = ($c =~ /\n/gs);
3510 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003511 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003512
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003513 $stat_real = raw_line($linenr, $cond_lines)
3514 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003515 if (defined($stat_real) && $cond_lines > 1) {
3516 $stat_real = "[...]\n$stat_real";
3517 }
3518
Joe Perches000d1cc12011-07-25 17:13:25 -07003519 ERROR("TRAILING_STATEMENTS",
3520 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003521 }
3522 }
3523
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003524# Check for bitwise tests written as boolean
3525 if ($line =~ /
3526 (?:
3527 (?:\[|\(|\&\&|\|\|)
3528 \s*0[xX][0-9]+\s*
3529 (?:\&\&|\|\|)
3530 |
3531 (?:\&\&|\|\|)
3532 \s*0[xX][0-9]+\s*
3533 (?:\&\&|\|\||\)|\])
3534 )/x)
3535 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003536 WARN("HEXADECIMAL_BOOLEAN_TEST",
3537 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003538 }
3539
Andy Whitcroft8905a672007-11-28 16:21:06 -08003540# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003541 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3542 my $s = $1;
3543 $s =~ s/$;//g; # Remove any comments
3544 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003545 ERROR("TRAILING_STATEMENTS",
3546 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003547 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003548 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003549# if should not continue a brace
3550 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003551 ERROR("TRAILING_STATEMENTS",
3552 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003553 $herecurr);
3554 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003555# case and default should not have general statements after them
3556 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3557 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003558 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003559 \s*return\s+
3560 )/xg)
3561 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003562 ERROR("TRAILING_STATEMENTS",
3563 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003564 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003565
3566 # Check for }<nl>else {, these must be at the same
3567 # indent level to be relevant to each other.
3568 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3569 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003570 ERROR("ELSE_AFTER_BRACE",
3571 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003572 }
3573
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003574 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3575 $previndent == $indent) {
3576 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3577
3578 # Find out what is on the end of the line after the
3579 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003580 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003581 $s =~ s/\n.*//g;
3582
3583 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003584 ERROR("WHILE_AFTER_BRACE",
3585 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003586 }
3587 }
3588
Joe Perches95e2c602013-07-03 15:05:20 -07003589#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003590 while ($line =~ m{($Constant|$Lval)}g) {
3591 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003592
3593#gcc binary extension
3594 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003595 if (WARN("GCC_BINARY_CONSTANT",
3596 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3597 $fix) {
3598 my $hexval = sprintf("0x%x", oct($var));
3599 $fixed[$linenr - 1] =~
3600 s/\b$var\b/$hexval/;
3601 }
Joe Perches95e2c602013-07-03 15:05:20 -07003602 }
3603
3604#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003605 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003606 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003607#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003608 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003609#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003610 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003611 while ($var =~ m{($Ident)}g) {
3612 my $word = $1;
3613 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08003614 if ($check) {
3615 seed_camelcase_includes();
3616 if (!$file && !$camelcase_file_seeded) {
3617 seed_camelcase_file($realfile);
3618 $camelcase_file_seeded = 1;
3619 }
3620 }
Joe Perches7e781f62013-09-11 14:23:55 -07003621 if (!defined $camelcase{$word}) {
3622 $camelcase{$word} = 1;
3623 CHK("CAMELCASE",
3624 "Avoid CamelCase: <$word>\n" . $herecurr);
3625 }
Joe Perches34456862013-07-03 15:05:34 -07003626 }
Joe Perches323c1262012-12-17 16:02:07 -08003627 }
3628 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003629
3630#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003631 if ($line =~ /\#\s*define.*\\\s+$/) {
3632 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3633 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3634 $fix) {
3635 $fixed[$linenr - 1] =~ s/\s+$//;
3636 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003637 }
3638
Andy Whitcroft653d4872007-06-23 17:16:34 -07003639#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003640 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003641 my $file = "$1.h";
3642 my $checkfile = "include/linux/$file";
3643 if (-f "$root/$checkfile" &&
3644 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003645 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003646 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003647 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003648 CHK("ARCH_INCLUDE_LINUX",
3649 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003650 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003651 WARN("INCLUDE_LINUX",
3652 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003653 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003654 }
3655 }
3656
Andy Whitcroft653d4872007-06-23 17:16:34 -07003657# multi-statement macros should be enclosed in a do while loop, grab the
3658# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003659# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07003660 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3661 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003662 my $ln = $linenr;
3663 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003664 my ($off, $dstat, $dcond, $rest);
3665 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003666 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003667 ctx_statement_block($linenr, $realcnt, 0);
3668 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003669 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003670 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003671
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003672 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003673 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003674 $dstat =~ s/\\\n.//g;
3675 $dstat =~ s/^\s*//s;
3676 $dstat =~ s/\s*$//s;
3677
3678 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003679 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3680 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003681 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003682 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003683 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003684
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003685 # Flatten any obvious string concatentation.
3686 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3687 $dstat =~ s/$Ident\s*("X*")/$1/)
3688 {
3689 }
3690
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003691 my $exceptions = qr{
3692 $Declare|
3693 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003694 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003695 DECLARE_PER_CPU|
3696 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003697 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003698 union|
3699 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003700 \.$Ident\s*=\s*|
3701 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003702 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003703 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003704 if ($dstat ne '' &&
3705 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3706 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07003707 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003708 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003709 $dstat !~ /$exceptions/ &&
3710 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003711 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003712 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003713 $dstat !~ /^for\s*$Constant$/ && # for (...)
3714 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3715 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07003716 $dstat !~ /^\({/ && # ({...
3717 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003718 {
3719 $ctx =~ s/\n*$//;
3720 my $herectx = $here . "\n";
3721 my $cnt = statement_rawlines($ctx);
3722
3723 for (my $n = 0; $n < $cnt; $n++) {
3724 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003725 }
3726
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003727 if ($dstat =~ /;/) {
3728 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3729 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3730 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003731 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003732 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003733 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003734 }
Joe Perches5023d342012-12-17 16:01:47 -08003735
Joe Perches481eb482012-12-17 16:01:56 -08003736# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003737
3738 } else {
3739 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003740 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3741 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003742 $line =~ /^\+.*\\$/) {
3743 WARN("LINE_CONTINUATIONS",
3744 "Avoid unnecessary line continuations\n" . $herecurr);
3745 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003746 }
3747
Joe Perchesb13edf72012-07-30 14:41:24 -07003748# do {} while (0) macro tests:
3749# single-statement macros do not need to be enclosed in do while (0) loop,
3750# macro should not end with a semicolon
3751 if ($^V && $^V ge 5.10.0 &&
3752 $realfile !~ m@/vmlinux.lds.h$@ &&
3753 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3754 my $ln = $linenr;
3755 my $cnt = $realcnt;
3756 my ($off, $dstat, $dcond, $rest);
3757 my $ctx = '';
3758 ($dstat, $dcond, $ln, $cnt, $off) =
3759 ctx_statement_block($linenr, $realcnt, 0);
3760 $ctx = $dstat;
3761
3762 $dstat =~ s/\\\n.//g;
3763
3764 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3765 my $stmts = $2;
3766 my $semis = $3;
3767
3768 $ctx =~ s/\n*$//;
3769 my $cnt = statement_rawlines($ctx);
3770 my $herectx = $here . "\n";
3771
3772 for (my $n = 0; $n < $cnt; $n++) {
3773 $herectx .= raw_line($linenr, $n) . "\n";
3774 }
3775
Joe Perchesac8e97f2012-08-21 16:15:53 -07003776 if (($stmts =~ tr/;/;/) == 1 &&
3777 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003778 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3779 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3780 }
3781 if (defined $semis && $semis ne "") {
3782 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3783 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3784 }
3785 }
3786 }
3787
Mike Frysinger080ba922009-01-06 14:41:25 -08003788# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3789# all assignments may have only one of the following with an assignment:
3790# .
3791# ALIGN(...)
3792# VMLINUX_SYMBOL(...)
3793 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003794 WARN("MISSING_VMLINUX_SYMBOL",
3795 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003796 }
3797
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003798# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003799 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3800 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003801 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003802 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003803 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3804 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003805 my @allowed = ();
3806 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003807 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003808 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003809 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003810 for my $chunk (@chunks) {
3811 my ($cond, $block) = @{$chunk};
3812
Andy Whitcroft773647a2008-03-28 14:15:58 -07003813 # If the condition carries leading newlines, then count those as offsets.
3814 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3815 my $offset = statement_rawlines($whitespace) - 1;
3816
Joe Perchesaad4f612012-03-23 15:02:19 -07003817 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003818 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3819
3820 # We have looked at and allowed this specific line.
3821 $suppress_ifbraces{$ln + $offset} = 1;
3822
3823 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003824 $ln += statement_rawlines($block) - 1;
3825
Andy Whitcroft773647a2008-03-28 14:15:58 -07003826 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003827
3828 $seen++ if ($block =~ /^\s*{/);
3829
Joe Perchesaad4f612012-03-23 15:02:19 -07003830 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003831 if (statement_lines($cond) > 1) {
3832 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003833 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003834 }
3835 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003836 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003837 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003838 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003839 if (statement_block_size($block) > 1) {
3840 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003841 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003842 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003843 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003844 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003845 if ($seen) {
3846 my $sum_allowed = 0;
3847 foreach (@allowed) {
3848 $sum_allowed += $_;
3849 }
3850 if ($sum_allowed == 0) {
3851 WARN("BRACES",
3852 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3853 } elsif ($sum_allowed != $allow &&
3854 $seen != $allow) {
3855 CHK("BRACES",
3856 "braces {} should be used on all arms of this statement\n" . $herectx);
3857 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003858 }
3859 }
3860 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003861 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003862 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003863 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003864
Andy Whitcroftcf655042008-03-04 14:28:20 -08003865 # Check the pre-context.
3866 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3867 #print "APW: ALLOWED: pre<$1>\n";
3868 $allowed = 1;
3869 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003870
3871 my ($level, $endln, @chunks) =
3872 ctx_statement_full($linenr, $realcnt, $-[0]);
3873
Andy Whitcroftcf655042008-03-04 14:28:20 -08003874 # Check the condition.
3875 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003876 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003877 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003878 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003879 }
3880 if (statement_lines($cond) > 1) {
3881 #print "APW: ALLOWED: cond<$cond>\n";
3882 $allowed = 1;
3883 }
3884 if ($block =~/\b(?:if|for|while)\b/) {
3885 #print "APW: ALLOWED: block<$block>\n";
3886 $allowed = 1;
3887 }
3888 if (statement_block_size($block) > 1) {
3889 #print "APW: ALLOWED: lines block<$block>\n";
3890 $allowed = 1;
3891 }
3892 # Check the post-context.
3893 if (defined $chunks[1]) {
3894 my ($cond, $block) = @{$chunks[1]};
3895 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003896 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003897 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003898 if ($block =~ /^\s*\{/) {
3899 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3900 $allowed = 1;
3901 }
3902 }
3903 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003904 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003905 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003906
Andy Whitcroftf0556632008-10-15 22:02:23 -07003907 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003908 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003909 }
3910
Joe Perches000d1cc12011-07-25 17:13:25 -07003911 WARN("BRACES",
3912 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003913 }
3914 }
3915
Joe Perches0979ae62012-12-17 16:01:59 -08003916# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07003917 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003918 CHK("BRACES",
3919 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3920 }
Joe Perches77b9a532013-07-03 15:05:29 -07003921 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003922 CHK("BRACES",
3923 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3924 }
3925
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003926# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003927 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3928 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003929 WARN("VOLATILE",
3930 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003931 }
3932
Andy Whitcroft00df3442007-06-08 13:47:06 -07003933# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003934 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003935 CHK("REDUNDANT_CODE",
3936 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003937 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003938 }
3939
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003940# check for needless "if (<foo>) fn(<foo>)" uses
3941 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3942 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3943 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3944 WARN('NEEDLESS_IF',
3945 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003946 }
3947 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003948
Joe Perches8716de32013-09-11 14:24:05 -07003949# check for bad placement of section $InitAttribute (e.g.: __initdata)
3950 if ($line =~ /(\b$InitAttribute\b)/) {
3951 my $attr = $1;
3952 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
3953 my $ptr = $1;
3954 my $var = $2;
3955 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
3956 ERROR("MISPLACED_INIT",
3957 "$attr should be placed after $var\n" . $herecurr)) ||
3958 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
3959 WARN("MISPLACED_INIT",
3960 "$attr should be placed after $var\n" . $herecurr))) &&
3961 $fix) {
3962 $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;
3963 }
3964 }
3965 }
3966
Joe Perchese970b882013-11-12 15:10:10 -08003967# check for $InitAttributeData (ie: __initdata) with const
3968 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
3969 my $attr = $1;
3970 $attr =~ /($InitAttributePrefix)(.*)/;
3971 my $attr_prefix = $1;
3972 my $attr_type = $2;
3973 if (ERROR("INIT_ATTRIBUTE",
3974 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
3975 $fix) {
3976 $fixed[$linenr - 1] =~
3977 s/$InitAttributeData/${attr_prefix}initconst/;
3978 }
3979 }
3980
3981# check for $InitAttributeConst (ie: __initconst) without const
3982 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
3983 my $attr = $1;
3984 if (ERROR("INIT_ATTRIBUTE",
3985 "Use of $attr requires a separate use of const\n" . $herecurr) &&
3986 $fix) {
3987 my $lead = $fixed[$linenr - 1] =~
3988 /(^\+\s*(?:static\s+))/;
3989 $lead = rtrim($1);
3990 $lead = "$lead " if ($lead !~ /^\+$/);
3991 $lead = "${lead}const ";
3992 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
3993 }
3994 }
3995
Joe Perchesfbdb8132014-04-03 14:49:14 -07003996# don't use __constant_<foo> functions outside of include/uapi/
3997 if ($realfile !~ m@^include/uapi/@ &&
3998 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
3999 my $constant_func = $1;
4000 my $func = $constant_func;
4001 $func =~ s/^__constant_//;
4002 if (WARN("CONSTANT_CONVERSION",
4003 "$constant_func should be $func\n" . $herecurr) &&
4004 $fix) {
4005 $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
4006 }
4007 }
4008
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004009# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004010 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004011 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004012 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004013 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004014 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004015 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4016 }
4017 if ($delay > 2000) {
4018 WARN("LONG_UDELAY",
4019 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004020 }
4021 }
4022
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004023# warn about unexpectedly long msleep's
4024 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4025 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004026 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004027 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004028 }
4029 }
4030
Joe Perches36ec1932013-07-03 15:05:25 -07004031# check for comparisons of jiffies
4032 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4033 WARN("JIFFIES_COMPARISON",
4034 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4035 }
4036
Joe Perches9d7a34a2013-07-03 15:05:26 -07004037# check for comparisons of get_jiffies_64()
4038 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4039 WARN("JIFFIES_COMPARISON",
4040 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4041 }
4042
Andy Whitcroft00df3442007-06-08 13:47:06 -07004043# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004044# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07004045# print "#ifdef in C files should be avoided\n";
4046# print "$herecurr";
4047# $clean = 0;
4048# }
4049
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004050# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004051 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004052 if (ERROR("SPACING",
4053 "exactly one space required after that #$1\n" . $herecurr) &&
4054 $fix) {
4055 $fixed[$linenr - 1] =~
4056 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4057 }
4058
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004059 }
4060
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004061# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004062 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4063 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004064 my $which = $1;
4065 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004066 CHK("UNCOMMENTED_DEFINITION",
4067 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004068 }
4069 }
4070# check for memory barriers without a comment.
4071 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4072 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004073 WARN("MEMORY_BARRIER",
4074 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004075 }
4076 }
4077# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004078 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004079 CHK("ARCH_DEFINES",
4080 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004081 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004082
Tobias Klauserd4977c72010-05-24 14:33:30 -07004083# Check that the storage class is at the beginning of a declaration
4084 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004085 WARN("STORAGE_CLASS",
4086 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004087 }
4088
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004089# check the location of the inline attribute, that it is between
4090# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004091 if ($line =~ /\b$Type\s+$Inline\b/ ||
4092 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004093 ERROR("INLINE_LOCATION",
4094 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004095 }
4096
Andy Whitcroft8905a672007-11-28 16:21:06 -08004097# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004098 if ($realfile !~ m@\binclude/uapi/@ &&
4099 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004100 if (WARN("INLINE",
4101 "plain inline is preferred over $1\n" . $herecurr) &&
4102 $fix) {
4103 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4104
4105 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004106 }
4107
Joe Perches3d130fd2011-01-12 17:00:00 -08004108# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004109 if ($realfile !~ m@\binclude/uapi/@ &&
4110 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004111 WARN("PREFER_PACKED",
4112 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004113 }
4114
Joe Perches39b7e282011-07-25 17:13:24 -07004115# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004116 if ($realfile !~ m@\binclude/uapi/@ &&
4117 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004118 WARN("PREFER_ALIGNED",
4119 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004120 }
4121
Joe Perches5f14d3b2012-01-10 15:09:52 -08004122# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004123 if ($realfile !~ m@\binclude/uapi/@ &&
4124 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004125 if (WARN("PREFER_PRINTF",
4126 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4127 $fix) {
4128 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4129
4130 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004131 }
4132
Joe Perches6061d942012-03-23 15:02:16 -07004133# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004134 if ($realfile !~ m@\binclude/uapi/@ &&
4135 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004136 if (WARN("PREFER_SCANF",
4137 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4138 $fix) {
4139 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4140 }
Joe Perches6061d942012-03-23 15:02:16 -07004141 }
4142
Joe Perches8f53a9b2010-03-05 13:43:48 -08004143# check for sizeof(&)
4144 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004145 WARN("SIZEOF_ADDRESS",
4146 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004147 }
4148
Joe Perches66c80b62012-07-30 14:41:22 -07004149# check for sizeof without parenthesis
4150 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004151 if (WARN("SIZEOF_PARENTHESIS",
4152 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4153 $fix) {
4154 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4155 }
Joe Perches66c80b62012-07-30 14:41:22 -07004156 }
4157
Joe Perches428e2fd2011-05-24 17:13:39 -07004158# check for line continuations in quoted strings with odd counts of "
4159 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004160 WARN("LINE_CONTINUATIONS",
4161 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004162 }
4163
Joe Perches88982fe2012-12-17 16:02:00 -08004164# check for struct spinlock declarations
4165 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4166 WARN("USE_SPINLOCK_T",
4167 "struct spinlock should be spinlock_t\n" . $herecurr);
4168 }
4169
Joe Perchesa6962d72013-04-29 16:18:13 -07004170# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004171 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004172 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004173 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004174 if (WARN("PREFER_SEQ_PUTS",
4175 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4176 $fix) {
4177 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4178 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004179 }
4180 }
4181
Andy Whitcroft554e1652012-01-10 15:09:57 -08004182# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004183 if ($^V && $^V ge 5.10.0 &&
4184 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004185 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004186
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004187 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004188 my $ms_val = $7;
4189 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004190
Andy Whitcroft554e1652012-01-10 15:09:57 -08004191 if ($ms_size =~ /^(0x|)0$/i) {
4192 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004193 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004194 } elsif ($ms_size =~ /^(0x|)1$/i) {
4195 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004196 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4197 }
4198 }
4199
Joe Perches98a9bba2014-01-23 15:54:52 -08004200# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4201 if ($^V && $^V ge 5.10.0 &&
4202 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4203 if (WARN("PREFER_ETHER_ADDR_COPY",
4204 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4205 $fix) {
4206 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4207 }
4208 }
4209
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004210# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004211 if ($^V && $^V ge 5.10.0 &&
4212 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004213 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004214 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004215 my $call = $1;
4216 my $cast1 = deparenthesize($2);
4217 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004218 my $cast2 = deparenthesize($7);
4219 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004220 my $cast;
4221
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004222 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004223 $cast = "$cast1 or $cast2";
4224 } elsif ($cast1 ne "") {
4225 $cast = $cast1;
4226 } else {
4227 $cast = $cast2;
4228 }
4229 WARN("MINMAX",
4230 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004231 }
4232 }
4233
Joe Perches4a273192012-07-30 14:41:20 -07004234# check usleep_range arguments
4235 if ($^V && $^V ge 5.10.0 &&
4236 defined $stat &&
4237 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4238 my $min = $1;
4239 my $max = $7;
4240 if ($min eq $max) {
4241 WARN("USLEEP_RANGE",
4242 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4243 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4244 $min > $max) {
4245 WARN("USLEEP_RANGE",
4246 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4247 }
4248 }
4249
Joe Perches823b7942013-11-12 15:10:15 -08004250# check for naked sscanf
4251 if ($^V && $^V ge 5.10.0 &&
4252 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004253 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004254 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4255 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4256 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4257 my $lc = $stat =~ tr@\n@@;
4258 $lc = $lc + $linenr;
4259 my $stat_real = raw_line($linenr, 0);
4260 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4261 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4262 }
4263 WARN("NAKED_SSCANF",
4264 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4265 }
4266
Joe Perches70dc8a42013-09-11 14:23:58 -07004267# check for new externs in .h files.
4268 if ($realfile =~ /\.h$/ &&
4269 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004270 if (CHK("AVOID_EXTERNS",
4271 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004272 $fix) {
4273 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4274 }
4275 }
4276
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004277# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004278 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004279 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004280 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004281 my $function_name = $1;
4282 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004283
4284 my $s = $stat;
4285 if (defined $cond) {
4286 substr($s, 0, length($cond), '');
4287 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004288 if ($s =~ /^\s*;/ &&
4289 $function_name ne 'uninitialized_var')
4290 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004291 WARN("AVOID_EXTERNS",
4292 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004293 }
4294
4295 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004296 WARN("FUNCTION_ARGUMENTS",
4297 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004298 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004299
4300 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4301 $stat =~ /^.\s*extern\s+/)
4302 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004303 WARN("AVOID_EXTERNS",
4304 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004305 }
4306
4307# checks for new __setup's
4308 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4309 my $name = $1;
4310
4311 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004312 CHK("UNDOCUMENTED_SETUP",
4313 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004314 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004315 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004316
4317# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004318 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004319 WARN("UNNECESSARY_CASTS",
4320 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004321 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004322
Joe Perchesa640d252013-07-03 15:05:21 -07004323# alloc style
4324# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4325 if ($^V && $^V ge 5.10.0 &&
4326 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4327 CHK("ALLOC_SIZEOF_STRUCT",
4328 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4329 }
4330
Joe Perches972fdea2013-04-29 16:18:12 -07004331# check for krealloc arg reuse
4332 if ($^V && $^V ge 5.10.0 &&
4333 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4334 WARN("KREALLOC_ARG_REUSE",
4335 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4336 }
4337
Joe Perches5ce59ae2013-02-21 16:44:18 -08004338# check for alloc argument mismatch
4339 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4340 WARN("ALLOC_ARRAY_ARGS",
4341 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4342 }
4343
Joe Perchescaf2a542011-01-12 16:59:56 -08004344# check for multiple semicolons
4345 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004346 if (WARN("ONE_SEMICOLON",
4347 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4348 $fix) {
4349 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4350 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004351 }
4352
Joe Perchesc34c09a2014-01-23 15:54:43 -08004353# check for case / default statements not preceeded by break/fallthrough/switch
4354 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4355 my $has_break = 0;
4356 my $has_statement = 0;
4357 my $count = 0;
4358 my $prevline = $linenr;
4359 while ($prevline > 1 && $count < 3 && !$has_break) {
4360 $prevline--;
4361 my $rline = $rawlines[$prevline - 1];
4362 my $fline = $lines[$prevline - 1];
4363 last if ($fline =~ /^\@\@/);
4364 next if ($fline =~ /^\-/);
4365 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4366 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4367 next if ($fline =~ /^.[\s$;]*$/);
4368 $has_statement = 1;
4369 $count++;
4370 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4371 }
4372 if (!$has_break && $has_statement) {
4373 WARN("MISSING_BREAK",
4374 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4375 }
4376 }
4377
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004378# check for switch/default statements without a break;
4379 if ($^V && $^V ge 5.10.0 &&
4380 defined $stat &&
4381 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4382 my $ctx = '';
4383 my $herectx = $here . "\n";
4384 my $cnt = statement_rawlines($stat);
4385 for (my $n = 0; $n < $cnt; $n++) {
4386 $herectx .= raw_line($linenr, $n) . "\n";
4387 }
4388 WARN("DEFAULT_NO_BREAK",
4389 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004390 }
4391
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004392# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004393 if ($line =~ /\b__FUNCTION__\b/) {
4394 if (WARN("USE_FUNC",
4395 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4396 $fix) {
4397 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4398 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004399 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004400
Joe Perches2c924882012-03-23 15:02:20 -07004401# check for use of yield()
4402 if ($line =~ /\byield\s*\(\s*\)/) {
4403 WARN("YIELD",
4404 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4405 }
4406
Joe Perches179f8f42013-07-03 15:05:30 -07004407# check for comparisons against true and false
4408 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4409 my $lead = $1;
4410 my $arg = $2;
4411 my $test = $3;
4412 my $otype = $4;
4413 my $trail = $5;
4414 my $op = "!";
4415
4416 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4417
4418 my $type = lc($otype);
4419 if ($type =~ /^(?:true|false)$/) {
4420 if (("$test" eq "==" && "$type" eq "true") ||
4421 ("$test" eq "!=" && "$type" eq "false")) {
4422 $op = "";
4423 }
4424
4425 CHK("BOOL_COMPARISON",
4426 "Using comparison to $otype is error prone\n" . $herecurr);
4427
4428## maybe suggesting a correct construct would better
4429## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4430
4431 }
4432 }
4433
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004434# check for semaphores initialized locked
4435 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004436 WARN("CONSIDER_COMPLETION",
4437 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004438 }
Joe Perches6712d852012-03-23 15:02:20 -07004439
Joe Perches67d0a072011-10-31 17:13:10 -07004440# recommend kstrto* over simple_strto* and strict_strto*
4441 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004442 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004443 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004444 }
Joe Perches6712d852012-03-23 15:02:20 -07004445
Michael Ellermanf3db6632008-07-23 21:28:57 -07004446# check for __initcall(), use device_initcall() explicitly please
4447 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004448 WARN("USE_DEVICE_INITCALL",
4449 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07004450 }
Joe Perches6712d852012-03-23 15:02:20 -07004451
Emese Revfy79404842010-03-05 13:43:53 -08004452# check for various ops structs, ensure they are const.
4453 my $struct_ops = qr{acpi_dock_ops|
4454 address_space_operations|
4455 backlight_ops|
4456 block_device_operations|
4457 dentry_operations|
4458 dev_pm_ops|
4459 dma_map_ops|
4460 extent_io_ops|
4461 file_lock_operations|
4462 file_operations|
4463 hv_ops|
4464 ide_dma_ops|
4465 intel_dvo_dev_ops|
4466 item_operations|
4467 iwl_ops|
4468 kgdb_arch|
4469 kgdb_io|
4470 kset_uevent_ops|
4471 lock_manager_operations|
4472 microcode_ops|
4473 mtrr_ops|
4474 neigh_ops|
4475 nlmsvc_binding|
4476 pci_raw_ops|
4477 pipe_buf_operations|
4478 platform_hibernation_ops|
4479 platform_suspend_ops|
4480 proto_ops|
4481 rpc_pipe_ops|
4482 seq_operations|
4483 snd_ac97_build_ops|
4484 soc_pcmcia_socket_ops|
4485 stacktrace_ops|
4486 sysfs_ops|
4487 tty_operations|
4488 usb_mon_operations|
4489 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004490 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004491 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004492 WARN("CONST_STRUCT",
4493 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004494 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004495 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004496
4497# use of NR_CPUS is usually wrong
4498# ignore definitions of NR_CPUS and usage to define arrays as likely right
4499 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004500 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4501 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004502 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4503 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4504 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004505 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004506 WARN("NR_CPUS",
4507 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004508 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004509
Joe Perches52ea8502013-11-12 15:10:09 -08004510# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4511 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4512 ERROR("DEFINE_ARCH_HAS",
4513 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4514 }
4515
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004516# check for %L{u,d,i} in strings
4517 my $string;
4518 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4519 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004520 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004521 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004522 WARN("PRINTF_L",
4523 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004524 last;
4525 }
4526 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004527
4528# whine mightly about in_atomic
4529 if ($line =~ /\bin_atomic\s*\(/) {
4530 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004531 ERROR("IN_ATOMIC",
4532 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004533 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004534 WARN("IN_ATOMIC",
4535 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004536 }
4537 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004538
4539# check for lockdep_set_novalidate_class
4540 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4541 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4542 if ($realfile !~ m@^kernel/lockdep@ &&
4543 $realfile !~ m@^include/linux/lockdep@ &&
4544 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004545 ERROR("LOCKDEP",
4546 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004547 }
4548 }
Dave Jones88f88312011-01-12 16:59:59 -08004549
4550 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4551 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004552 WARN("EXPORTED_WORLD_WRITABLE",
4553 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004554 }
Joe Perches24358802014-04-03 14:49:13 -07004555
Joe Perches515a2352014-04-03 14:49:24 -07004556# Mode permission misuses where it seems decimal should be octal
4557# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4558 if ($^V && $^V ge 5.10.0 &&
4559 $line =~ /$mode_perms_search/) {
4560 foreach my $entry (@mode_permission_funcs) {
4561 my $func = $entry->[0];
4562 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07004563
Joe Perches515a2352014-04-03 14:49:24 -07004564 my $skip_args = "";
4565 if ($arg_pos > 1) {
4566 $arg_pos--;
4567 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4568 }
4569 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4570 if ($line =~ /$test/) {
4571 my $val = $1;
4572 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07004573
Joe Perches515a2352014-04-03 14:49:24 -07004574 if ($val !~ /^0$/ &&
4575 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4576 length($val) ne 4)) {
4577 ERROR("NON_OCTAL_PERMISSIONS",
4578 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4579 }
Joe Perches24358802014-04-03 14:49:13 -07004580 }
4581 }
4582 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004583 }
4584
4585 # If we have no input at all, then there is nothing to report on
4586 # so just keep quiet.
4587 if ($#rawlines == -1) {
4588 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004589 }
4590
Andy Whitcroft8905a672007-11-28 16:21:06 -08004591 # In mailback mode only produce a report in the negative, for
4592 # things that appear to be patches.
4593 if ($mailback && ($clean == 1 || !$is_patch)) {
4594 exit(0);
4595 }
4596
4597 # This is not a patch, and we are are in 'no-patch' mode so
4598 # just keep quiet.
4599 if (!$chk_patch && !$is_patch) {
4600 exit(0);
4601 }
4602
4603 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004604 ERROR("NOT_UNIFIED_DIFF",
4605 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004606 }
4607 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004608 ERROR("MISSING_SIGN_OFF",
4609 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004610 }
4611
Andy Whitcroft8905a672007-11-28 16:21:06 -08004612 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004613 if ($summary && !($clean == 1 && $quiet == 1)) {
4614 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004615 print "total: $cnt_error errors, $cnt_warn warnings, " .
4616 (($check)? "$cnt_chk checks, " : "") .
4617 "$cnt_lines lines checked\n";
4618 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004619 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004620
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004621 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004622
4623 if ($^V lt 5.10.0) {
4624 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4625 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4626 }
4627
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004628 # If there were whitespace errors which cleanpatch can fix
4629 # then suggest that.
4630 if ($rpt_cleaners) {
4631 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4632 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07004633 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004634 }
4635 }
4636
Joe Perches91bfe482013-09-11 14:23:59 -07004637 hash_show_words(\%use_type, "Used");
4638 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07004639
Joe Perches3705ce52013-07-03 15:05:31 -07004640 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
Joe Perches9624b8d2014-01-23 15:54:44 -08004641 my $newfile = $filename;
4642 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07004643 my $linecount = 0;
4644 my $f;
4645
4646 open($f, '>', $newfile)
4647 or die "$P: Can't open $newfile for write\n";
4648 foreach my $fixed_line (@fixed) {
4649 $linecount++;
4650 if ($file) {
4651 if ($linecount > 3) {
4652 $fixed_line =~ s/^\+//;
4653 print $f $fixed_line. "\n";
4654 }
4655 } else {
4656 print $f $fixed_line . "\n";
4657 }
4658 }
4659 close($f);
4660
4661 if (!$quiet) {
4662 print << "EOM";
4663Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4664
4665Do _NOT_ trust the results written to this file.
4666Do _NOT_ submit these changes without inspecting them for correctness.
4667
4668This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4669No warranties, expressed or implied...
4670
4671EOM
4672 }
4673 }
4674
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004675 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004676 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004677 }
4678 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004679 print << "EOM";
4680$vname has style problems, please review.
4681
4682If any of these errors are false positives, please report
4683them to the maintainer, see CHECKPATCH in MAINTAINERS.
4684EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004685 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004686
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004687 return $clean;
4688}