blob: f2ef63a2e8d43620e5f489cd5821d619e56cd173 [file] [log] [blame]
Andy Whitcroft0a920b5b2007-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 Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -070010
11my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070012$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070013
Joe Perches000d1cc12011-07-25 17:13:25 -070014my $V = '0.32';
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700119GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700120 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700147
Joe Perches9624b8d2014-01-23 15:54:44 -0800148$fix = 1 if ($fix_inplace);
149
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-06-01 00:46:48 -0700159if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700160 print "$P: no input files\n";
Andy Whitcroft0a920b5b2007-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 Whitcroft0a920b5b2007-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 Perchese970b8842013-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
Joe Perches3f7bac02014-06-04 16:12:04 -0700400our $declaration_macros = qr{(?x:
401 (?:$Storage\s+)?(?:DECLARE|DEFINE)_[A-Z]+\s*\(|
402 (?:$Storage\s+)?LIST_HEAD\s*\(
403)};
404
Wolfram Sang7840a942010-08-09 17:20:57 -0700405our $allowed_asm_includes = qr{(?x:
406 irq|
407 memory
408)};
409# memory.h: ARM has a custom one
410
Andy Whitcroft8905a672007-11-28 16:21:06 -0800411sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700412 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
413 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700414 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700415 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800416 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700417 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800418 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800419 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700420 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700421 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800422 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700423 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800424 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700425 $NonptrTypeWithAttr = qr{
426 (?:$Modifier\s+|const\s+)*
427 (?:
428 (?:typeof|__typeof__)\s*\([^\)]*\)|
429 (?:$typeTypedefs\b)|
430 (?:${allWithAttr}\b)
431 )
432 (?:\s+$Modifier|\s+const)*
433 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800434 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700435 $NonptrType
Andy Whitcroftb337d8b2012-03-23 15:02:18 -0700436 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700437 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800438 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700439 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800440}
441build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700442
Joe Perches7d2367a2011-07-25 17:13:22 -0700443our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700444
445# Using $balanced_parens, $LvalOrFunc, or $FuncArg
446# requires at least perl version v5.10.0
447# Any use must be runtime checked with $^V
448
449our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700450our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800451our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700452
453sub deparenthesize {
454 my ($string) = @_;
455 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700456
457 while ($string =~ /^\s*\(.*\)\s*$/) {
458 $string =~ s@^\s*\(\s*@@;
459 $string =~ s@\s*\)\s*$@@;
460 }
461
Joe Perches7d2367a2011-07-25 17:13:22 -0700462 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700463
Joe Perches7d2367a2011-07-25 17:13:22 -0700464 return $string;
465}
466
Joe Perches34456862013-07-03 15:05:34 -0700467sub seed_camelcase_file {
468 my ($file) = @_;
469
470 return if (!(-f $file));
471
472 local $/;
473
474 open(my $include_file, '<', "$file")
475 or warn "$P: Can't read '$file' $!\n";
476 my $text = <$include_file>;
477 close($include_file);
478
479 my @lines = split('\n', $text);
480
481 foreach my $line (@lines) {
482 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
483 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
484 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800485 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
486 $camelcase{$1} = 1;
487 } 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 -0700488 $camelcase{$1} = 1;
489 }
490 }
491}
492
493my $camelcase_seeded = 0;
494sub seed_camelcase_includes {
495 return if ($camelcase_seeded);
496
497 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700498 my $camelcase_cache = "";
499 my @include_files = ();
500
501 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700502
Richard Genoud3645e322014-02-10 14:25:32 -0800503 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700504 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
505 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700506 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700507 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700508 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700509 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700510 @include_files = split('\n', $files);
511 foreach my $file (@include_files) {
512 my $date = POSIX::strftime("%Y%m%d%H%M",
513 localtime((stat $file)[9]));
514 $last_mod_date = $date if ($last_mod_date < $date);
515 }
516 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700517 }
Joe Perchesc707a812013-07-08 16:00:43 -0700518
519 if ($camelcase_cache ne "" && -f $camelcase_cache) {
520 open(my $camelcase_file, '<', "$camelcase_cache")
521 or warn "$P: Can't read '$camelcase_cache' $!\n";
522 while (<$camelcase_file>) {
523 chomp;
524 $camelcase{$_} = 1;
525 }
526 close($camelcase_file);
527
528 return;
529 }
530
Richard Genoud3645e322014-02-10 14:25:32 -0800531 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700532 $files = `git ls-files "include/*.h"`;
533 @include_files = split('\n', $files);
534 }
535
Joe Perches34456862013-07-03 15:05:34 -0700536 foreach my $file (@include_files) {
537 seed_camelcase_file($file);
538 }
Joe Perches351b2a12013-07-03 15:05:36 -0700539
Joe Perchesc707a812013-07-08 16:00:43 -0700540 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700541 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700542 open(my $camelcase_file, '>', "$camelcase_cache")
543 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700544 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
545 print $camelcase_file ("$_\n");
546 }
547 close($camelcase_file);
548 }
Joe Perches34456862013-07-03 15:05:34 -0700549}
550
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700551$chk_signoff = 0 if ($file);
552
Andy Whitcroft00df3442007-06-08 13:47:06 -0700553my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800554my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700555my @fixed = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800556my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700557for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800558 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700559 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800560 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700561 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800562 } elsif ($filename eq '-') {
563 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700564 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800565 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700566 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700567 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800568 if ($filename eq '-') {
569 $vname = 'Your patch';
570 } else {
571 $vname = $filename;
572 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800573 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700574 chomp;
575 push(@rawlines, $_);
576 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800577 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800578 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700579 $exit = 1;
580 }
581 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800582 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700583 @fixed = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700584}
585
586exit($exit);
587
588sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700589 my ($root) = @_;
590
591 my @tree_check = (
592 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
593 "README", "Documentation", "arch", "include", "drivers",
594 "fs", "init", "ipc", "kernel", "lib", "scripts",
595 );
596
597 foreach my $check (@tree_check) {
598 if (! -e $root . '/' . $check) {
599 return 0;
600 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700601 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700602 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700603}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700604
Joe Perches20112472011-07-25 17:13:23 -0700605sub parse_email {
606 my ($formatted_email) = @_;
607
608 my $name = "";
609 my $address = "";
610 my $comment = "";
611
612 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
613 $name = $1;
614 $address = $2;
615 $comment = $3 if defined $3;
616 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
617 $address = $1;
618 $comment = $2 if defined $2;
619 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
620 $address = $1;
621 $comment = $2 if defined $2;
622 $formatted_email =~ s/$address.*$//;
623 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700624 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700625 $name =~ s/^\"|\"$//g;
626 # If there's a name left after stripping spaces and
627 # leading quotes, and the address doesn't have both
628 # leading and trailing angle brackets, the address
629 # is invalid. ie:
630 # "joe smith joe@smith.com" bad
631 # "joe smith <joe@smith.com" bad
632 if ($name ne "" && $address !~ /^<[^>]+>$/) {
633 $name = "";
634 $address = "";
635 $comment = "";
636 }
637 }
638
Joe Perches3705ce52013-07-03 15:05:31 -0700639 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700640 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700641 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700642 $address =~ s/^\<|\>$//g;
643
644 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
645 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
646 $name = "\"$name\"";
647 }
648
649 return ($name, $address, $comment);
650}
651
652sub format_email {
653 my ($name, $address) = @_;
654
655 my $formatted_email;
656
Joe Perches3705ce52013-07-03 15:05:31 -0700657 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700658 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700659 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700660
661 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
662 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
663 $name = "\"$name\"";
664 }
665
666 if ("$name" eq "") {
667 $formatted_email = "$address";
668 } else {
669 $formatted_email = "$name <$address>";
670 }
671
672 return $formatted_email;
673}
674
Joe Perches000d1cc12011-07-25 17:13:25 -0700675sub which_conf {
676 my ($conf) = @_;
677
678 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
679 if (-e "$path/$conf") {
680 return "$path/$conf";
681 }
682 }
683
684 return "";
685}
686
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700687sub expand_tabs {
688 my ($str) = @_;
689
690 my $res = '';
691 my $n = 0;
692 for my $c (split(//, $str)) {
693 if ($c eq "\t") {
694 $res .= ' ';
695 $n++;
696 for (; ($n % 8) != 0; $n++) {
697 $res .= ' ';
698 }
699 next;
700 }
701 $res .= $c;
702 $n++;
703 }
704
705 return $res;
706}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700707sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700708 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700709 return $res;
710}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700711
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700712sub line_stats {
713 my ($line) = @_;
714
715 # Drop the diff line leader and expand tabs
716 $line =~ s/^.//;
717 $line = expand_tabs($line);
718
719 # Pick the indent from the front of the line.
720 my ($white) = ($line =~ /^(\s*)/);
721
722 return (length($line), length($white));
723}
724
Andy Whitcroft773647a2008-03-28 14:15:58 -0700725my $sanitise_quote = '';
726
727sub sanitise_line_reset {
728 my ($in_comment) = @_;
729
730 if ($in_comment) {
731 $sanitise_quote = '*/';
732 } else {
733 $sanitise_quote = '';
734 }
735}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700736sub sanitise_line {
737 my ($line) = @_;
738
739 my $res = '';
740 my $l = '';
741
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800742 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700743 my $off = 0;
744 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700745
Andy Whitcroft773647a2008-03-28 14:15:58 -0700746 # Always copy over the diff marker.
747 $res = substr($line, 0, 1);
748
749 for ($off = 1; $off < length($line); $off++) {
750 $c = substr($line, $off, 1);
751
752 # Comments we are wacking completly including the begin
753 # and end, all to $;.
754 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
755 $sanitise_quote = '*/';
756
757 substr($res, $off, 2, "$;$;");
758 $off++;
759 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800760 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700761 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700762 $sanitise_quote = '';
763 substr($res, $off, 2, "$;$;");
764 $off++;
765 next;
766 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700767 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
768 $sanitise_quote = '//';
769
770 substr($res, $off, 2, $sanitise_quote);
771 $off++;
772 next;
773 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700774
775 # A \ in a string means ignore the next character.
776 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
777 $c eq "\\") {
778 substr($res, $off, 2, 'XX');
779 $off++;
780 next;
781 }
782 # Regular quotes.
783 if ($c eq "'" || $c eq '"') {
784 if ($sanitise_quote eq '') {
785 $sanitise_quote = $c;
786
787 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700788 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700789 } elsif ($sanitise_quote eq $c) {
790 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700791 }
792 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700793
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800794 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700795 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
796 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700797 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
798 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700799 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
800 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700801 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700802 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700803 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800804 }
805
Daniel Walker113f04a2009-09-21 17:04:35 -0700806 if ($sanitise_quote eq '//') {
807 $sanitise_quote = '';
808 }
809
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800810 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700811 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800812 my $clean = 'X' x length($1);
813 $res =~ s@\<.*\>@<$clean>@;
814
815 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700816 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800817 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700818 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800819 }
820
Andy Whitcroft00df3442007-06-08 13:47:06 -0700821 return $res;
822}
823
Joe Perchesa6962d72013-04-29 16:18:13 -0700824sub get_quoted_string {
825 my ($line, $rawline) = @_;
826
827 return "" if ($line !~ m/(\"[X]+\")/g);
828 return substr($rawline, $-[0], $+[0] - $-[0]);
829}
830
Andy Whitcroft8905a672007-11-28 16:21:06 -0800831sub ctx_statement_block {
832 my ($linenr, $remain, $off) = @_;
833 my $line = $linenr - 1;
834 my $blk = '';
835 my $soff = $off;
836 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700837 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800838
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800839 my $loff = 0;
840
Andy Whitcroft8905a672007-11-28 16:21:06 -0800841 my $type = '';
842 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800843 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800844 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800845 my $c;
846 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800847
848 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800849 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800850 @stack = (['', 0]) if ($#stack == -1);
851
Andy Whitcroft773647a2008-03-28 14:15:58 -0700852 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800853 # If we are about to drop off the end, pull in more
854 # context.
855 if ($off >= $len) {
856 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700857 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800858 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800859 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800860 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800861 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800862 $len = length($blk);
863 $line++;
864 last;
865 }
866 # Bail if there is no further context.
867 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800868 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800869 last;
870 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800871 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
872 $level++;
873 $type = '#';
874 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800875 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800876 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800877 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800878 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800879
Andy Whitcroft773647a2008-03-28 14:15:58 -0700880 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800881
882 # Handle nested #if/#else.
883 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
884 push(@stack, [ $type, $level ]);
885 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
886 ($type, $level) = @{$stack[$#stack - 1]};
887 } elsif ($remainder =~ /^#\s*endif\b/) {
888 ($type, $level) = @{pop(@stack)};
889 }
890
Andy Whitcroft8905a672007-11-28 16:21:06 -0800891 # Statement ends at the ';' or a close '}' at the
892 # outermost level.
893 if ($level == 0 && $c eq ';') {
894 last;
895 }
896
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800897 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700898 if ($level == 0 && $coff_set == 0 &&
899 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
900 $remainder =~ /^(else)(?:\s|{)/ &&
901 $remainder !~ /^else\s+if\b/) {
902 $coff = $off + length($1) - 1;
903 $coff_set = 1;
904 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
905 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800906 }
907
Andy Whitcroft8905a672007-11-28 16:21:06 -0800908 if (($type eq '' || $type eq '(') && $c eq '(') {
909 $level++;
910 $type = '(';
911 }
912 if ($type eq '(' && $c eq ')') {
913 $level--;
914 $type = ($level != 0)? '(' : '';
915
916 if ($level == 0 && $coff < $soff) {
917 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700918 $coff_set = 1;
919 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800920 }
921 }
922 if (($type eq '' || $type eq '{') && $c eq '{') {
923 $level++;
924 $type = '{';
925 }
926 if ($type eq '{' && $c eq '}') {
927 $level--;
928 $type = ($level != 0)? '{' : '';
929
930 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700931 if (substr($blk, $off + 1, 1) eq ';') {
932 $off++;
933 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800934 last;
935 }
936 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800937 # Preprocessor commands end at the newline unless escaped.
938 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
939 $level--;
940 $type = '';
941 $off++;
942 last;
943 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800944 $off++;
945 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700946 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800947 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700948 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800949 $line++;
950 $remain--;
951 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800952
953 my $statement = substr($blk, $soff, $off - $soff + 1);
954 my $condition = substr($blk, $soff, $coff - $soff + 1);
955
956 #warn "STATEMENT<$statement>\n";
957 #warn "CONDITION<$condition>\n";
958
Andy Whitcroft773647a2008-03-28 14:15:58 -0700959 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800960
961 return ($statement, $condition,
962 $line, $remain + 1, $off - $loff + 1, $level);
963}
964
Andy Whitcroftcf655042008-03-04 14:28:20 -0800965sub statement_lines {
966 my ($stmt) = @_;
967
968 # Strip the diff line prefixes and rip blank lines at start and end.
969 $stmt =~ s/(^|\n)./$1/g;
970 $stmt =~ s/^\s*//;
971 $stmt =~ s/\s*$//;
972
973 my @stmt_lines = ($stmt =~ /\n/g);
974
975 return $#stmt_lines + 2;
976}
977
978sub statement_rawlines {
979 my ($stmt) = @_;
980
981 my @stmt_lines = ($stmt =~ /\n/g);
982
983 return $#stmt_lines + 2;
984}
985
986sub statement_block_size {
987 my ($stmt) = @_;
988
989 $stmt =~ s/(^|\n)./$1/g;
990 $stmt =~ s/^\s*{//;
991 $stmt =~ s/}\s*$//;
992 $stmt =~ s/^\s*//;
993 $stmt =~ s/\s*$//;
994
995 my @stmt_lines = ($stmt =~ /\n/g);
996 my @stmt_statements = ($stmt =~ /;/g);
997
998 my $stmt_lines = $#stmt_lines + 2;
999 my $stmt_statements = $#stmt_statements + 1;
1000
1001 if ($stmt_lines > $stmt_statements) {
1002 return $stmt_lines;
1003 } else {
1004 return $stmt_statements;
1005 }
1006}
1007
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001008sub ctx_statement_full {
1009 my ($linenr, $remain, $off) = @_;
1010 my ($statement, $condition, $level);
1011
1012 my (@chunks);
1013
Andy Whitcroftcf655042008-03-04 14:28:20 -08001014 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001015 ($statement, $condition, $linenr, $remain, $off, $level) =
1016 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001017 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001018 push(@chunks, [ $condition, $statement ]);
1019 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1020 return ($level, $linenr, @chunks);
1021 }
1022
1023 # Pull in the following conditional/block pairs and see if they
1024 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001025 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001026 ($statement, $condition, $linenr, $remain, $off, $level) =
1027 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001028 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001029 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001030 #print "C: push\n";
1031 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001032 }
1033
1034 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001035}
1036
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001037sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001038 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001039 my $line;
1040 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001041 my $blk = '';
1042 my @o;
1043 my @c;
1044 my @res = ();
1045
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001046 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001047 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001048 for ($line = $start; $remain > 0; $line++) {
1049 next if ($rawlines[$line] =~ /^-/);
1050 $remain--;
1051
1052 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001053
1054 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001055 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001056 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001057 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001058 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001059 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001060 $level = pop(@stack);
1061 }
1062
Andy Whitcroft01464f32010-10-26 14:23:19 -07001063 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001064 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1065 if ($off > 0) {
1066 $off--;
1067 next;
1068 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001069
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001070 if ($c eq $close && $level > 0) {
1071 $level--;
1072 last if ($level == 0);
1073 } elsif ($c eq $open) {
1074 $level++;
1075 }
1076 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001077
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001078 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001079 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001080 }
1081
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001082 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001083 }
1084
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001085 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001086}
1087sub ctx_block_outer {
1088 my ($linenr, $remain) = @_;
1089
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001090 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1091 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001092}
1093sub ctx_block {
1094 my ($linenr, $remain) = @_;
1095
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001096 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1097 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001098}
1099sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001100 my ($linenr, $remain, $off) = @_;
1101
1102 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1103 return @r;
1104}
1105sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001106 my ($linenr, $remain) = @_;
1107
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001108 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001109}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001110sub ctx_statement_level {
1111 my ($linenr, $remain, $off) = @_;
1112
1113 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1114}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001115
1116sub ctx_locate_comment {
1117 my ($first_line, $end_line) = @_;
1118
1119 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001120 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001121 return $current_comment if (defined $current_comment);
1122
1123 # Look through the context and try and figure out if there is a
1124 # comment.
1125 my $in_comment = 0;
1126 $current_comment = '';
1127 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001128 my $line = $rawlines[$linenr - 1];
1129 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001130 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1131 $in_comment = 1;
1132 }
1133 if ($line =~ m@/\*@) {
1134 $in_comment = 1;
1135 }
1136 if (!$in_comment && $current_comment ne '') {
1137 $current_comment = '';
1138 }
1139 $current_comment .= $line . "\n" if ($in_comment);
1140 if ($line =~ m@\*/@) {
1141 $in_comment = 0;
1142 }
1143 }
1144
1145 chomp($current_comment);
1146 return($current_comment);
1147}
1148sub ctx_has_comment {
1149 my ($first_line, $end_line) = @_;
1150 my $cmt = ctx_locate_comment($first_line, $end_line);
1151
Andy Whitcroft00df3442007-06-08 13:47:06 -07001152 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001153 ##print "CMMT: $cmt\n";
1154
1155 return ($cmt ne '');
1156}
1157
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001158sub raw_line {
1159 my ($linenr, $cnt) = @_;
1160
1161 my $offset = $linenr - 1;
1162 $cnt++;
1163
1164 my $line;
1165 while ($cnt) {
1166 $line = $rawlines[$offset++];
1167 next if (defined($line) && $line =~ /^-/);
1168 $cnt--;
1169 }
1170
1171 return $line;
1172}
1173
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001174sub cat_vet {
1175 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001176 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001177
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001178 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001179 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1180 $res .= $1;
1181 if ($2 ne '') {
1182 $coded = sprintf("^%c", unpack('C', $2) + 64);
1183 $res .= $coded;
1184 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001185 }
1186 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001187
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001188 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001189}
1190
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001191my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001192my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001193my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001194my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001195
1196sub annotate_reset {
1197 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001198 $av_pending = '_';
1199 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001200 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001201}
1202
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001203sub annotate_values {
1204 my ($stream, $type) = @_;
1205
1206 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001207 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001208 my $cur = $stream;
1209
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001210 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001211
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001212 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001213 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001214 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001215 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001216 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001217 print "WS($1)\n" if ($dbg_values > 1);
1218 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001219 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001220 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001221 }
1222
Florian Micklerc023e4732011-01-12 16:59:58 -08001223 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001224 print "CAST($1)\n" if ($dbg_values > 1);
1225 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001226 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001227
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001228 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001229 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001230 $type = 'T';
1231
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001232 } elsif ($cur =~ /^($Modifier)\s*/) {
1233 print "MODIFIER($1)\n" if ($dbg_values > 1);
1234 $type = 'T';
1235
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001236 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001237 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001238 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001239 push(@av_paren_type, $type);
1240 if ($2 ne '') {
1241 $av_pending = 'N';
1242 }
1243 $type = 'E';
1244
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001245 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001246 print "UNDEF($1)\n" if ($dbg_values > 1);
1247 $av_preprocessor = 1;
1248 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001249
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001250 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001251 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001252 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001253
1254 push(@av_paren_type, $type);
1255 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001256 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001257
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001258 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001259 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1260 $av_preprocessor = 1;
1261
1262 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1263
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001264 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001265
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001266 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001267 print "PRE_END($1)\n" if ($dbg_values > 1);
1268
1269 $av_preprocessor = 1;
1270
1271 # Assume all arms of the conditional end as this
1272 # one does, and continue as if the #endif was not here.
1273 pop(@av_paren_type);
1274 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001275 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001276
1277 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001278 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001279
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001280 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1281 print "ATTR($1)\n" if ($dbg_values > 1);
1282 $av_pending = $type;
1283 $type = 'N';
1284
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001285 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001286 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001287 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001288 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001289 }
1290 $type = 'N';
1291
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001292 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001293 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001294 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001295 $type = 'N';
1296
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001297 } elsif ($cur =~/^(case)/o) {
1298 print "CASE($1)\n" if ($dbg_values > 1);
1299 $av_pend_colon = 'C';
1300 $type = 'N';
1301
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001302 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001303 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001304 $type = 'N';
1305
1306 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001307 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001308 push(@av_paren_type, $av_pending);
1309 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001310 $type = 'N';
1311
1312 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001313 my $new_type = pop(@av_paren_type);
1314 if ($new_type ne '_') {
1315 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001316 print "PAREN('$1') -> $type\n"
1317 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001318 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001319 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001320 }
1321
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001322 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001323 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001324 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001325 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001326
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001327 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1328 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001329 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001330 } elsif ($type eq 'E') {
1331 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001332 }
1333 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1334 $type = 'V';
1335
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001336 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001337 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001338 $type = 'V';
1339
1340 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001341 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001342 $type = 'N';
1343
Andy Whitcroftcf655042008-03-04 14:28:20 -08001344 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001345 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001346 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001347 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001348
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001349 } elsif ($cur =~/^(,)/) {
1350 print "COMMA($1)\n" if ($dbg_values > 1);
1351 $type = 'C';
1352
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001353 } elsif ($cur =~ /^(\?)/o) {
1354 print "QUESTION($1)\n" if ($dbg_values > 1);
1355 $type = 'N';
1356
1357 } elsif ($cur =~ /^(:)/o) {
1358 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1359
1360 substr($var, length($res), 1, $av_pend_colon);
1361 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1362 $type = 'E';
1363 } else {
1364 $type = 'N';
1365 }
1366 $av_pend_colon = 'O';
1367
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001368 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001369 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001370 $type = 'N';
1371
Andy Whitcroft0d413862008-10-15 22:02:16 -07001372 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001373 my $variant;
1374
1375 print "OPV($1)\n" if ($dbg_values > 1);
1376 if ($type eq 'V') {
1377 $variant = 'B';
1378 } else {
1379 $variant = 'U';
1380 }
1381
1382 substr($var, length($res), 1, $variant);
1383 $type = 'N';
1384
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001385 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001386 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001387 if ($1 ne '++' && $1 ne '--') {
1388 $type = 'N';
1389 }
1390
1391 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001392 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001393 }
1394 if (defined $1) {
1395 $cur = substr($cur, length($1));
1396 $res .= $type x length($1);
1397 }
1398 }
1399
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001400 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001401}
1402
Andy Whitcroft8905a672007-11-28 16:21:06 -08001403sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001404 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001405 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001406 ^(?:
1407 $Modifier|
1408 $Storage|
1409 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001410 DEFINE_\S+
1411 )$|
1412 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001413 goto|
1414 return|
1415 case|
1416 else|
1417 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001418 do|
1419 \#|
1420 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001421 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001422 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001423 )}x;
1424 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1425 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001426 # Check for modifiers.
1427 $possible =~ s/\s*$Storage\s*//g;
1428 $possible =~ s/\s*$Sparse\s*//g;
1429 if ($possible =~ /^\s*$/) {
1430
1431 } elsif ($possible =~ /\s/) {
1432 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001433 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001434 if ($modifier !~ $notPermitted) {
1435 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1436 push(@modifierList, $modifier);
1437 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001438 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001439
1440 } else {
1441 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1442 push(@typeList, $possible);
1443 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001444 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001445 } else {
1446 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001447 }
1448}
1449
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001450my $prefix = '';
1451
Joe Perches000d1cc12011-07-25 17:13:25 -07001452sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001453 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001454
Joe Perchescbec18a2014-04-03 14:49:19 -07001455 return defined $use_type{$type} if (scalar keys %use_type > 0);
1456
1457 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001458}
1459
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001460sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001461 my ($level, $type, $msg) = @_;
1462
1463 if (!show_type($type) ||
1464 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001465 return 0;
1466 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001467 my $line;
1468 if ($show_types) {
Joe Perchescbec18a2014-04-03 14:49:19 -07001469 $line = "$prefix$level:$type: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001470 } else {
Joe Perchescbec18a2014-04-03 14:49:19 -07001471 $line = "$prefix$level: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001472 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001473 $line = (split('\n', $line))[0] . "\n" if ($terse);
1474
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001475 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001476
1477 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001478}
Joe Perchescbec18a2014-04-03 14:49:19 -07001479
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001480sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001481 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001482}
Joe Perches000d1cc12011-07-25 17:13:25 -07001483
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001484sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001485 my ($type, $msg) = @_;
1486
1487 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001488 our $clean = 0;
1489 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001490 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001491 }
Joe Perches3705ce52013-07-03 15:05:31 -07001492 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001493}
1494sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001495 my ($type, $msg) = @_;
1496
1497 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001498 our $clean = 0;
1499 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001500 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001501 }
Joe Perches3705ce52013-07-03 15:05:31 -07001502 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001503}
1504sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001505 my ($type, $msg) = @_;
1506
1507 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001508 our $clean = 0;
1509 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001510 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001511 }
Joe Perches3705ce52013-07-03 15:05:31 -07001512 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001513}
1514
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001515sub check_absolute_file {
1516 my ($absolute, $herecurr) = @_;
1517 my $file = $absolute;
1518
1519 ##print "absolute<$absolute>\n";
1520
1521 # See if any suffix of this path is a path within the tree.
1522 while ($file =~ s@^[^/]*/@@) {
1523 if (-f "$root/$file") {
1524 ##print "file<$file>\n";
1525 last;
1526 }
1527 }
1528 if (! -f _) {
1529 return 0;
1530 }
1531
1532 # It is, so see if the prefix is acceptable.
1533 my $prefix = $absolute;
1534 substr($prefix, -length($file)) = '';
1535
1536 ##print "prefix<$prefix>\n";
1537 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001538 WARN("USE_RELATIVE_PATH",
1539 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001540 }
1541}
1542
Joe Perches3705ce52013-07-03 15:05:31 -07001543sub trim {
1544 my ($string) = @_;
1545
Joe Perchesb34c6482013-09-11 14:24:01 -07001546 $string =~ s/^\s+|\s+$//g;
1547
1548 return $string;
1549}
1550
1551sub ltrim {
1552 my ($string) = @_;
1553
1554 $string =~ s/^\s+//;
1555
1556 return $string;
1557}
1558
1559sub rtrim {
1560 my ($string) = @_;
1561
1562 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001563
1564 return $string;
1565}
1566
Joe Perches52ea8502013-11-12 15:10:09 -08001567sub string_find_replace {
1568 my ($string, $find, $replace) = @_;
1569
1570 $string =~ s/$find/$replace/g;
1571
1572 return $string;
1573}
1574
Joe Perches3705ce52013-07-03 15:05:31 -07001575sub tabify {
1576 my ($leading) = @_;
1577
1578 my $source_indent = 8;
1579 my $max_spaces_before_tab = $source_indent - 1;
1580 my $spaces_to_tab = " " x $source_indent;
1581
1582 #convert leading spaces to tabs
1583 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1584 #Remove spaces before a tab
1585 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1586
1587 return "$leading";
1588}
1589
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001590sub pos_last_openparen {
1591 my ($line) = @_;
1592
1593 my $pos = 0;
1594
1595 my $opens = $line =~ tr/\(/\(/;
1596 my $closes = $line =~ tr/\)/\)/;
1597
1598 my $last_openparen = 0;
1599
1600 if (($opens == 0) || ($closes >= $opens)) {
1601 return -1;
1602 }
1603
1604 my $len = length($line);
1605
1606 for ($pos = 0; $pos < $len; $pos++) {
1607 my $string = substr($line, $pos);
1608 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1609 $pos += length($1) - 1;
1610 } elsif (substr($line, $pos, 1) eq '(') {
1611 $last_openparen = $pos;
1612 } elsif (index($string, '(') == -1) {
1613 last;
1614 }
1615 }
1616
Joe Perches91cb5192014-04-03 14:49:32 -07001617 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001618}
1619
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001620sub process {
1621 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001622
1623 my $linenr=0;
1624 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001625 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001626 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001627 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001628
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001629 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001630 my $indent;
1631 my $previndent=0;
1632 my $stashindent=0;
1633
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001634 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001635 my $signoff = 0;
1636 my $is_patch = 0;
1637
Joe Perches15662b32011-10-31 17:13:12 -07001638 my $in_header_lines = 1;
1639 my $in_commit_log = 0; #Scanning lines before patch
1640
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001641 my $non_utf8_charset = 0;
1642
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001643 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001644 our $cnt_lines = 0;
1645 our $cnt_error = 0;
1646 our $cnt_warn = 0;
1647 our $cnt_chk = 0;
1648
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001649 # Trace the real file/line as we go.
1650 my $realfile = '';
1651 my $realline = 0;
1652 my $realcnt = 0;
1653 my $here = '';
1654 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001655 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001656 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001657 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001658
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001659 my $prev_values = 'E';
1660
1661 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001662 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001663 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001664 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001665 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001666
Joe Perches7e51f192013-09-11 14:23:57 -07001667 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001668
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001669 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001670 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001671 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001672 my @setup_docs = ();
1673 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001674
Joe Perchesd8b07712013-11-12 15:10:06 -08001675 my $camelcase_file_seeded = 0;
1676
Andy Whitcroft773647a2008-03-28 14:15:58 -07001677 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001678 my $line;
1679 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001680 $linenr++;
1681 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001682
Joe Perches3705ce52013-07-03 15:05:31 -07001683 push(@fixed, $rawline) if ($fix);
1684
Andy Whitcroft773647a2008-03-28 14:15:58 -07001685 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001686 $setup_docs = 0;
1687 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1688 $setup_docs = 1;
1689 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001690 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001691 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001692 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1693 $realline=$1-1;
1694 if (defined $2) {
1695 $realcnt=$3+1;
1696 } else {
1697 $realcnt=1+1;
1698 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001699 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001700
1701 # Guestimate if this is a continuing comment. Run
1702 # the context looking for a comment "edge". If this
1703 # edge is a close comment then we must be in a comment
1704 # at context start.
1705 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001706 my $cnt = $realcnt;
1707 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1708 next if (defined $rawlines[$ln - 1] &&
1709 $rawlines[$ln - 1] =~ /^-/);
1710 $cnt--;
1711 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001712 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001713 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1714 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1715 ($edge) = $1;
1716 last;
1717 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001718 }
1719 if (defined $edge && $edge eq '*/') {
1720 $in_comment = 1;
1721 }
1722
1723 # Guestimate if this is a continuing comment. If this
1724 # is the start of a diff block and this line starts
1725 # ' *' then it is very likely a comment.
1726 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001727 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001728 {
1729 $in_comment = 1;
1730 }
1731
1732 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1733 sanitise_line_reset($in_comment);
1734
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001735 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001736 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001737 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001738 $line = sanitise_line($rawline);
1739 }
1740 push(@lines, $line);
1741
1742 if ($realcnt > 1) {
1743 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1744 } else {
1745 $realcnt = 0;
1746 }
1747
1748 #print "==>$rawline\n";
1749 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001750
1751 if ($setup_docs && $line =~ /^\+/) {
1752 push(@setup_docs, $line);
1753 }
1754 }
1755
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001756 $prefix = '';
1757
Andy Whitcroft773647a2008-03-28 14:15:58 -07001758 $realcnt = 0;
1759 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001760 foreach my $line (@lines) {
1761 $linenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001762 my $sline = $line; #copy of $line
1763 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001764
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001765 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001766
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001767#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001768 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001769 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001770 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001771 $realline=$1-1;
1772 if (defined $2) {
1773 $realcnt=$3+1;
1774 } else {
1775 $realcnt=1+1;
1776 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001777 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001778 $prev_values = 'E';
1779
Andy Whitcroft773647a2008-03-28 14:15:58 -07001780 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001781 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001782 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001783 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001784 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001785
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001786# track the line number as we move through the hunk, note that
1787# new versions of GNU diff omit the leading space on completely
1788# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001789 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001790 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001791 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001792
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001793 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001794 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001795
1796 # Track the previous line.
1797 ($prevline, $stashline) = ($stashline, $line);
1798 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001799 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1800
Andy Whitcroft773647a2008-03-28 14:15:58 -07001801 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001802
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001803 } elsif ($realcnt == 1) {
1804 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001805 }
1806
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001807 my $hunk_line = ($realcnt != 0);
1808
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001809#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001810 $prefix = "$filename:$realline: " if ($emacs && $file);
1811 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1812
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001813 $here = "#$linenr: " if (!$file);
1814 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001815
1816 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001817 if ($line =~ /^diff --git.*?(\S+)$/) {
1818 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001819 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001820 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001821 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001822 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001823 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001824 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001825
1826 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001827 if (!$file && $tree && $p1_prefix ne '' &&
1828 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001829 WARN("PATCH_PREFIX",
1830 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001831 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001832
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001833 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001834 ERROR("MODIFIED_INCLUDE_ASM",
1835 "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 -07001836 }
1837 next;
1838 }
1839
Randy Dunlap389834b2007-06-08 13:47:03 -07001840 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001841
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001842 my $hereline = "$here\n$rawline\n";
1843 my $herecurr = "$here\n$rawline\n";
1844 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001845
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001846 $cnt_lines++ if ($realcnt != 0);
1847
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001848# Check for incorrect file permissions
1849 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1850 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001851 if ($realfile !~ m@scripts/@ &&
1852 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001853 ERROR("EXECUTE_PERMISSIONS",
1854 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001855 }
1856 }
1857
Joe Perches20112472011-07-25 17:13:23 -07001858# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001859 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001860 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001861 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001862 }
1863
1864# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001865 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001866 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001867 my $space_before = $1;
1868 my $sign_off = $2;
1869 my $space_after = $3;
1870 my $email = $4;
1871 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1872
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001873 if ($sign_off !~ /$signature_tags/) {
1874 WARN("BAD_SIGN_OFF",
1875 "Non-standard signature: $sign_off\n" . $herecurr);
1876 }
Joe Perches20112472011-07-25 17:13:23 -07001877 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07001878 if (WARN("BAD_SIGN_OFF",
1879 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1880 $fix) {
1881 $fixed[$linenr - 1] =
1882 "$ucfirst_sign_off $email";
1883 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001884 }
Joe Perches20112472011-07-25 17:13:23 -07001885 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07001886 if (WARN("BAD_SIGN_OFF",
1887 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1888 $fix) {
1889 $fixed[$linenr - 1] =
1890 "$ucfirst_sign_off $email";
1891 }
1892
Joe Perches20112472011-07-25 17:13:23 -07001893 }
1894 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07001895 if (WARN("BAD_SIGN_OFF",
1896 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1897 $fix) {
1898 $fixed[$linenr - 1] =
1899 "$ucfirst_sign_off $email";
1900 }
Joe Perches20112472011-07-25 17:13:23 -07001901 }
1902
1903 my ($email_name, $email_address, $comment) = parse_email($email);
1904 my $suggested_email = format_email(($email_name, $email_address));
1905 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001906 ERROR("BAD_SIGN_OFF",
1907 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001908 } else {
1909 my $dequoted = $suggested_email;
1910 $dequoted =~ s/^"//;
1911 $dequoted =~ s/" </ </;
1912 # Don't force email to have quotes
1913 # Allow just an angle bracketed address
1914 if ("$dequoted$comment" ne $email &&
1915 "<$email_address>$comment" ne $email &&
1916 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001917 WARN("BAD_SIGN_OFF",
1918 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001919 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001920 }
Joe Perches7e51f192013-09-11 14:23:57 -07001921
1922# Check for duplicate signatures
1923 my $sig_nospace = $line;
1924 $sig_nospace =~ s/\s//g;
1925 $sig_nospace = lc($sig_nospace);
1926 if (defined $signatures{$sig_nospace}) {
1927 WARN("BAD_SIGN_OFF",
1928 "Duplicate signature\n" . $herecurr);
1929 } else {
1930 $signatures{$sig_nospace} = 1;
1931 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001932 }
1933
Christopher Covington7ebd05e2014-04-03 14:49:31 -07001934# Check for unwanted Gerrit info
1935 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
1936 ERROR("GERRIT_CHANGE_ID",
1937 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
1938 }
1939
Andy Whitcroft00df3442007-06-08 13:47:06 -07001940# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001941 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001942 ERROR("CORRUPTED_PATCH",
1943 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001944 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001945 }
1946
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001947# Check for absolute kernel paths.
1948 if ($tree) {
1949 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1950 my $file = $1;
1951
1952 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1953 check_absolute_file($1, $herecurr)) {
1954 #
1955 } else {
1956 check_absolute_file($file, $herecurr);
1957 }
1958 }
1959 }
1960
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001961# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1962 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001963 $rawline !~ m/^$UTF8*$/) {
1964 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1965
1966 my $blank = copy_spacing($rawline);
1967 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1968 my $hereptr = "$hereline$ptr\n";
1969
Joe Perches34d99212011-07-25 17:13:26 -07001970 CHK("INVALID_UTF8",
1971 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001972 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001973
Joe Perches15662b32011-10-31 17:13:12 -07001974# Check if it's the start of a commit log
1975# (not a header line and we haven't seen the patch filename)
1976 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001977 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001978 $in_header_lines = 0;
1979 $in_commit_log = 1;
1980 }
1981
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001982# Check if there is UTF-8 in a commit log when a mail header has explicitly
1983# declined it, i.e defined some charset where it is missing.
1984 if ($in_header_lines &&
1985 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1986 $1 !~ /utf-8/i) {
1987 $non_utf8_charset = 1;
1988 }
1989
1990 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001991 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001992 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001993 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1994 }
1995
Andy Whitcroft306708542008-10-15 22:02:28 -07001996# ignore non-hunk lines and lines being removed
1997 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001998
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001999#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002000 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002001 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07002002 if (ERROR("DOS_LINE_ENDINGS",
2003 "DOS line endings\n" . $herevet) &&
2004 $fix) {
2005 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
2006 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002007 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2008 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002009 if (ERROR("TRAILING_WHITESPACE",
2010 "trailing whitespace\n" . $herevet) &&
2011 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002012 $fixed[$linenr - 1] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002013 }
2014
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002015 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002016 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07002017
Josh Triplett4783f892013-11-12 15:10:12 -08002018# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002019 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002020 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2021 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002022 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2023 my $msg_type = \&ERROR;
2024 $msg_type = \&CHK if ($file);
2025 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002026 "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 -08002027 }
2028
Andi Kleen33549572010-05-24 14:33:29 -07002029# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002030# Only applies when adding the entry originally, after that we do not have
2031# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002032 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08002033 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002034 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002035 my $cnt = $realcnt;
2036 my $ln = $linenr + 1;
2037 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002038 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002039 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002040 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002041 $f = $lines[$ln - 1];
2042 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2043 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002044
2045 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002046
2047 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
2048 $is_start = 1;
2049 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
2050 $length = -1;
2051 }
2052
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002053 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002054 $f =~ s/#.*//;
2055 $f =~ s/^\s+//;
2056 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002057 if ($f =~ /^\s*config\s/) {
2058 $is_end = 1;
2059 last;
2060 }
Andi Kleen33549572010-05-24 14:33:29 -07002061 $length++;
2062 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002063 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08002064 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2065 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002066 }
2067
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002068# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2069 if ($realfile =~ /Kconfig/ &&
2070 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2071 WARN("CONFIG_EXPERIMENTAL",
2072 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2073 }
2074
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002075 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2076 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2077 my $flag = $1;
2078 my $replacement = {
2079 'EXTRA_AFLAGS' => 'asflags-y',
2080 'EXTRA_CFLAGS' => 'ccflags-y',
2081 'EXTRA_CPPFLAGS' => 'cppflags-y',
2082 'EXTRA_LDFLAGS' => 'ldflags-y',
2083 };
2084
2085 WARN("DEPRECATED_VARIABLE",
2086 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2087 }
2088
Rob Herringbff5da42014-01-23 15:54:51 -08002089# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002090 if (defined $root &&
2091 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2092 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2093
Rob Herringbff5da42014-01-23 15:54:51 -08002094 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2095
Florian Vaussardcc933192014-04-03 14:49:27 -07002096 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2097 my $vp_file = $dt_path . "vendor-prefixes.txt";
2098
Rob Herringbff5da42014-01-23 15:54:51 -08002099 foreach my $compat (@compats) {
2100 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002101 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2102 my $compat3 = $compat;
2103 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2104 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002105 if ( $? >> 8 ) {
2106 WARN("UNDOCUMENTED_DT_STRING",
2107 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2108 }
2109
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002110 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2111 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002112 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002113 if ( $? >> 8 ) {
2114 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002115 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002116 }
2117 }
2118 }
2119
Andy Whitcroft5368df202008-10-15 22:02:27 -07002120# check we are in a valid source file if not then ignore this hunk
2121 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2122
Joe Perches6cd7f382012-12-17 16:01:54 -08002123#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002124 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002125 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002126 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002127 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002128 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002129 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002130 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002131 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002132 }
2133
Josh Triplettca56dc02012-03-23 15:02:21 -07002134# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002135# to grep for the string. Make exceptions when the previous string ends in a
2136# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2137# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002138 if ($line =~ /^\+\s*"/ &&
2139 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002140 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002141 WARN("SPLIT_STRING",
2142 "quoted string split across lines\n" . $hereprev);
2143 }
2144
Joe Perches5e79d962010-03-05 13:43:55 -08002145# check for spaces before a quoted newline
2146 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002147 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2148 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2149 $fix) {
2150 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2151 }
2152
Joe Perches5e79d962010-03-05 13:43:55 -08002153 }
2154
Andy Whitcroft8905a672007-11-28 16:21:06 -08002155# check for adding lines without a newline.
2156 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002157 WARN("MISSING_EOF_NEWLINE",
2158 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002159 }
2160
Mike Frysinger42e41c52009-09-21 17:04:40 -07002161# Blackfin: use hi/lo macros
2162 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2163 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2164 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002165 ERROR("LO_MACRO",
2166 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002167 }
2168 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2169 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002170 ERROR("HI_MACRO",
2171 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002172 }
2173 }
2174
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002175# check we are in a valid source file C or perl if not then ignore this hunk
2176 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002177
2178# at the beginning of a line any tabs must come first and anything
2179# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002180 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2181 $rawline =~ /^\+\s* \s*/) {
2182 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002183 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002184 if (ERROR("CODE_INDENT",
2185 "code indent should use tabs where possible\n" . $herevet) &&
2186 $fix) {
2187 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2188 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002189 }
2190
Alberto Panizzo08e44362010-03-05 13:43:54 -08002191# check for space before tabs.
2192 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2193 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002194 if (WARN("SPACE_BEFORE_TAB",
2195 "please, no space before tabs\n" . $herevet) &&
2196 $fix) {
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002197 while ($fixed[$linenr - 1] =~
2198 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2199 while ($fixed[$linenr - 1] =~
2200 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002201 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002202 }
2203
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002204# check for && or || at the start of a line
2205 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2206 CHK("LOGICAL_CONTINUATIONS",
2207 "Logical continuations should be on the previous line\n" . $hereprev);
2208 }
2209
2210# check multi-line statement indentation matches previous line
2211 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002212 $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 -07002213 $prevline =~ /^\+(\t*)(.*)$/;
2214 my $oldindent = $1;
2215 my $rest = $2;
2216
2217 my $pos = pos_last_openparen($rest);
2218 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002219 $line =~ /^(\+| )([ \t]*)/;
2220 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002221
2222 my $goodtabindent = $oldindent .
2223 "\t" x ($pos / 8) .
2224 " " x ($pos % 8);
2225 my $goodspaceindent = $oldindent . " " x $pos;
2226
2227 if ($newindent ne $goodtabindent &&
2228 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002229
2230 if (CHK("PARENTHESIS_ALIGNMENT",
2231 "Alignment should match open parenthesis\n" . $hereprev) &&
2232 $fix && $line =~ /^\+/) {
2233 $fixed[$linenr - 1] =~
2234 s/^\+[ \t]*/\+$goodtabindent/;
2235 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002236 }
2237 }
2238 }
2239
Joe Perches23f780c2013-07-03 15:05:31 -07002240 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002241 if (CHK("SPACING",
2242 "No space is necessary after a cast\n" . $hereprev) &&
2243 $fix) {
2244 $fixed[$linenr - 1] =~
2245 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2246 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002247 }
2248
Joe Perches05880602012-10-04 17:13:35 -07002249 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002250 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002251 $rawline =~ /^\+[ \t]*\*/ &&
2252 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002253 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2254 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2255 }
2256
2257 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002258 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2259 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002260 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002261 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2262 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2263 "networking block comments start with * on subsequent lines\n" . $hereprev);
2264 }
2265
2266 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002267 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2268 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2269 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2270 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002271 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2272 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2273 }
2274
Joe Perches3b617e32014-04-03 14:49:28 -07002275# check for missing blank lines after declarations
Joe Perches3f7bac02014-06-04 16:12:04 -07002276 if ($sline =~ /^\+\s+\S/ && #Not at char 1
2277 # actual declarations
2278 ($prevline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2279 # foo bar; where foo is some local typedef or #define
2280 $prevline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2281 # known declaration macros
2282 $prevline =~ /^\+\s+$declaration_macros/) &&
2283 # for "else if" which can look like "$Ident $Ident"
2284 !($prevline =~ /^\+\s+$c90_Keywords\b/ ||
2285 # other possible extensions of declaration lines
2286 $prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2287 # not starting a section or a macro "\" extended line
2288 $prevline =~ /(?:\{\s*|\\)$/) &&
2289 # looks like a declaration
2290 !($sline =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ ||
2291 # foo bar; where foo is some local typedef or #define
2292 $sline =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ ||
2293 # known declaration macros
2294 $sline =~ /^\+\s+$declaration_macros/ ||
2295 # start of struct or union or enum
Joe Perches3b617e32014-04-03 14:49:28 -07002296 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
Joe Perches3f7bac02014-06-04 16:12:04 -07002297 # start or end of block or continuation of declaration
2298 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ ||
2299 # bitfield continuation
2300 $sline =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ ||
2301 # other possible extensions of declaration lines
2302 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/) &&
2303 # indentation of previous and current line are the same
2304 (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/)) {
Joe Perches3b617e32014-04-03 14:49:28 -07002305 WARN("SPACING",
Joe Perches3f7bac02014-06-04 16:12:04 -07002306 "Missing a blank line after declarations\n" . $hereprev);
Joe Perches3b617e32014-04-03 14:49:28 -07002307 }
2308
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002309# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002310# Exceptions:
2311# 1) within comments
2312# 2) indented preprocessor commands
2313# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002314 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002315 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002316 if (WARN("LEADING_SPACE",
2317 "please, no spaces at the start of a line\n" . $herevet) &&
2318 $fix) {
2319 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2320 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002321 }
2322
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002323# check we are in a valid C source file if not then ignore this hunk
2324 next if ($realfile !~ /\.(h|c)$/);
2325
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002326# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2327 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2328 WARN("CONFIG_EXPERIMENTAL",
2329 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2330 }
2331
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002332# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002333 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002334 WARN("CVS_KEYWORD",
2335 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002336 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002337
Mike Frysinger42e41c52009-09-21 17:04:40 -07002338# Blackfin: don't use __builtin_bfin_[cs]sync
2339 if ($line =~ /__builtin_bfin_csync/) {
2340 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002341 ERROR("CSYNC",
2342 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002343 }
2344 if ($line =~ /__builtin_bfin_ssync/) {
2345 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002346 ERROR("SSYNC",
2347 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002348 }
2349
Joe Perches56e77d72013-02-21 16:44:14 -08002350# check for old HOTPLUG __dev<foo> section markings
2351 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2352 WARN("HOTPLUG_SECTION",
2353 "Using $1 is unnecessary\n" . $herecurr);
2354 }
2355
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002356# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002357 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2358 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002359#print "LINE<$line>\n";
2360 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002361 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002362 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002363 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002364 $stat =~ s/\n./\n /g;
2365 $cond =~ s/\n./\n /g;
2366
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002367#print "linenr<$linenr> <$stat>\n";
2368 # If this statement has no statement boundaries within
2369 # it there is no point in retrying a statement scan
2370 # until we hit end of it.
2371 my $frag = $stat; $frag =~ s/;+\s*$//;
2372 if ($frag !~ /(?:{|;)/) {
2373#print "skip<$line_nr_next>\n";
2374 $suppress_statement = $line_nr_next;
2375 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002376
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002377 # Find the real next line.
2378 $realline_next = $line_nr_next;
2379 if (defined $realline_next &&
2380 (!defined $lines[$realline_next - 1] ||
2381 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2382 $realline_next++;
2383 }
2384
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002385 my $s = $stat;
2386 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002387
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002388 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002389 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002390
2391 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002392 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002393
Andy Whitcroft463f2862009-09-21 17:04:34 -07002394 } elsif ($s =~ /^.\s*else\b/s) {
2395
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002396 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002397 } 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 -07002398 my $type = $1;
2399 $type =~ s/\s+/ /g;
2400 possible($type, "A:" . $s);
2401
Andy Whitcroft8905a672007-11-28 16:21:06 -08002402 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002403 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002404 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002405 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002406
2407 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002408 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002409 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002410 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002411
2412 # Check for any sort of function declaration.
2413 # int foo(something bar, other baz);
2414 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002415 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 -08002416 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002417
Andy Whitcroftcf655042008-03-04 14:28:20 -08002418 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002419 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002420 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002421
Andy Whitcroft8905a672007-11-28 16:21:06 -08002422 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002423 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002424
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002425 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002426 }
2427 }
2428 }
2429
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002430 }
2431
Andy Whitcroft653d4872007-06-23 17:16:34 -07002432#
2433# Checks which may be anchored in the context.
2434#
2435
2436# Check for switch () and associated case and default
2437# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002438 if ($line=~/\bswitch\s*\(.*\)/) {
2439 my $err = '';
2440 my $sep = '';
2441 my @ctx = ctx_block_outer($linenr, $realcnt);
2442 shift(@ctx);
2443 for my $ctx (@ctx) {
2444 my ($clen, $cindent) = line_stats($ctx);
2445 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2446 $indent != $cindent) {
2447 $err .= "$sep$ctx\n";
2448 $sep = '';
2449 } else {
2450 $sep = "[...]\n";
2451 }
2452 }
2453 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002454 ERROR("SWITCH_CASE_INDENT_LEVEL",
2455 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002456 }
2457 }
2458
2459# if/while/etc brace do not go on next line, unless defining a do while loop,
2460# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002461 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002462 my $pre_ctx = "$1$2";
2463
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002464 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002465
2466 if ($line =~ /^\+\t{6,}/) {
2467 WARN("DEEP_INDENTATION",
2468 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2469 }
2470
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002471 my $ctx_cnt = $realcnt - $#ctx - 1;
2472 my $ctx = join("\n", @ctx);
2473
Andy Whitcroft548596d2008-07-23 21:29:01 -07002474 my $ctx_ln = $linenr;
2475 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002476
Andy Whitcroft548596d2008-07-23 21:29:01 -07002477 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2478 defined $lines[$ctx_ln - 1] &&
2479 $lines[$ctx_ln - 1] =~ /^-/)) {
2480 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2481 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002482 $ctx_ln++;
2483 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002484
Andy Whitcroft53210162008-07-23 21:29:03 -07002485 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2486 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002487
2488 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002489 ERROR("OPEN_BRACE",
2490 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002491 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002492 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002493 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2494 $ctx =~ /\)\s*\;\s*$/ &&
2495 defined $lines[$ctx_ln - 1])
2496 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002497 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2498 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002499 WARN("TRAILING_SEMICOLON",
2500 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002501 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002502 }
2503 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002504 }
2505
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002506# Check relative indent for conditionals and blocks.
2507 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002508 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2509 ctx_statement_block($linenr, $realcnt, 0)
2510 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002511 my ($s, $c) = ($stat, $cond);
2512
2513 substr($s, 0, length($c), '');
2514
2515 # Make sure we remove the line prefixes as we have
2516 # none on the first line, and are going to readd them
2517 # where necessary.
2518 $s =~ s/\n./\n/gs;
2519
2520 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002521 my @newlines = ($c =~ /\n/gs);
2522 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002523
2524 # We want to check the first line inside the block
2525 # starting at the end of the conditional, so remove:
2526 # 1) any blank line termination
2527 # 2) any opening brace { on end of the line
2528 # 3) any do (...) {
2529 my $continuation = 0;
2530 my $check = 0;
2531 $s =~ s/^.*\bdo\b//;
2532 $s =~ s/^\s*{//;
2533 if ($s =~ s/^\s*\\//) {
2534 $continuation = 1;
2535 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002536 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002537 $check = 1;
2538 $cond_lines++;
2539 }
2540
2541 # Also ignore a loop construct at the end of a
2542 # preprocessor statement.
2543 if (($prevline =~ /^.\s*#\s*define\s/ ||
2544 $prevline =~ /\\\s*$/) && $continuation == 0) {
2545 $check = 0;
2546 }
2547
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002548 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002549 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002550 while ($cond_ptr != $cond_lines) {
2551 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002552
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002553 # If we see an #else/#elif then the code
2554 # is not linear.
2555 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2556 $check = 0;
2557 }
2558
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002559 # Ignore:
2560 # 1) blank lines, they should be at 0,
2561 # 2) preprocessor lines, and
2562 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002563 if ($continuation ||
2564 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002565 $s =~ /^\s*#\s*?/ ||
2566 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002567 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002568 if ($s =~ s/^.*?\n//) {
2569 $cond_lines++;
2570 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002571 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002572 }
2573
2574 my (undef, $sindent) = line_stats("+" . $s);
2575 my $stat_real = raw_line($linenr, $cond_lines);
2576
2577 # Check if either of these lines are modified, else
2578 # this is not this patch's fault.
2579 if (!defined($stat_real) ||
2580 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2581 $check = 0;
2582 }
2583 if (defined($stat_real) && $cond_lines > 1) {
2584 $stat_real = "[...]\n$stat_real";
2585 }
2586
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002587 #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 -07002588
2589 if ($check && (($sindent % 8) != 0 ||
2590 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002591 WARN("SUSPECT_CODE_INDENT",
2592 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002593 }
2594 }
2595
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002596 # Track the 'values' across context and added lines.
2597 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002598 my ($curr_values, $curr_vars) =
2599 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002600 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002601 if ($dbg_values) {
2602 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002603 print "$linenr > .$outline\n";
2604 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002605 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002606 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002607 $prev_values = substr($curr_values, -1);
2608
Andy Whitcroft00df3442007-06-08 13:47:06 -07002609#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002610 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002611
Andy Whitcroft653d4872007-06-23 17:16:34 -07002612# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002613 if ($dbg_type) {
2614 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002615 ERROR("TEST_TYPE",
2616 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002617 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002618 ERROR("TEST_NOT_TYPE",
2619 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002620 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002621 next;
2622 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002623# TEST: allow direct testing of the attribute matcher.
2624 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002625 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002626 ERROR("TEST_ATTR",
2627 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002628 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002629 ERROR("TEST_NOT_ATTR",
2630 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002631 }
2632 next;
2633 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002634
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002635# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002636 if ($line =~ /^.\s*{/ &&
2637 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002638 ERROR("OPEN_BRACE",
2639 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002640 }
2641
Andy Whitcroft653d4872007-06-23 17:16:34 -07002642#
2643# Checks which are anchored on the added line.
2644#
2645
2646# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002647 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002648 my $path = $1;
2649 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002650 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002651 "malformed #include filename\n" . $herecurr);
2652 }
2653 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2654 ERROR("UAPI_INCLUDE",
2655 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002656 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002657 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002658
2659# no C99 // comments
2660 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002661 if (ERROR("C99_COMMENTS",
2662 "do not use C99 // comments\n" . $herecurr) &&
2663 $fix) {
2664 my $line = $fixed[$linenr - 1];
2665 if ($line =~ /\/\/(.*)$/) {
2666 my $comment = trim($1);
2667 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2668 }
2669 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002670 }
2671 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002672 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002673 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002674
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002675# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2676# the whole statement.
2677#print "APW <$lines[$realline_next - 1]>\n";
2678 if (defined $realline_next &&
2679 exists $lines[$realline_next - 1] &&
2680 !defined $suppress_export{$realline_next} &&
2681 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2682 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002683 # Handle definitions which produce identifiers with
2684 # a prefix:
2685 # XXX(foo);
2686 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002687 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002688 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002689 $name =~ /^${Ident}_$2/) {
2690#print "FOO C name<$name>\n";
2691 $suppress_export{$realline_next} = 1;
2692
2693 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002694 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002695 ^.DEFINE_$Ident\(\Q$name\E\)|
2696 ^.DECLARE_$Ident\(\Q$name\E\)|
2697 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002698 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2699 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002700 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002701#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2702 $suppress_export{$realline_next} = 2;
2703 } else {
2704 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002705 }
2706 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002707 if (!defined $suppress_export{$linenr} &&
2708 $prevline =~ /^.\s*$/ &&
2709 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2710 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2711#print "FOO B <$lines[$linenr - 1]>\n";
2712 $suppress_export{$linenr} = 2;
2713 }
2714 if (defined $suppress_export{$linenr} &&
2715 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002716 WARN("EXPORT_SYMBOL",
2717 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002718 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002719
Joe Eloff5150bda2010-08-09 17:21:00 -07002720# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002721 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2722 if (ERROR("GLOBAL_INITIALISERS",
2723 "do not initialise globals to 0 or NULL\n" .
2724 $herecurr) &&
2725 $fix) {
2726 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2727 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002728 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002729# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002730 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2731 if (ERROR("INITIALISED_STATIC",
2732 "do not initialise statics to 0 or NULL\n" .
2733 $herecurr) &&
2734 $fix) {
2735 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2736 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002737 }
2738
Joe Perchescb710ec2010-10-26 14:23:20 -07002739# check for static const char * arrays.
2740 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002741 WARN("STATIC_CONST_CHAR_ARRAY",
2742 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002743 $herecurr);
2744 }
2745
2746# check for static char foo[] = "bar" declarations.
2747 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002748 WARN("STATIC_CONST_CHAR_ARRAY",
2749 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002750 $herecurr);
2751 }
2752
Joe Perches9b0fa602014-04-03 14:49:18 -07002753# check for non-global char *foo[] = {"bar", ...} declarations.
2754 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
2755 WARN("STATIC_CONST_CHAR_ARRAY",
2756 "char * array declaration might be better as static const\n" .
2757 $herecurr);
2758 }
2759
Joe Perchesb36190c2014-01-27 17:07:18 -08002760# check for function declarations without arguments like "int foo()"
2761 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2762 if (ERROR("FUNCTION_WITHOUT_ARGS",
2763 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2764 $fix) {
2765 $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2766 }
2767 }
2768
Joe Perches92e112f2013-12-13 11:36:22 -07002769# check for uses of DEFINE_PCI_DEVICE_TABLE
2770 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2771 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2772 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2773 $fix) {
2774 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2775 }
Joe Perches93ed0e22010-10-26 14:23:21 -07002776 }
2777
Andy Whitcroft653d4872007-06-23 17:16:34 -07002778# check for new typedefs, only function parameters and sparse annotations
2779# make sense.
2780 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002781 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002782 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002783 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002784 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002785 WARN("NEW_TYPEDEFS",
2786 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002787 }
2788
2789# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002790 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002791 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2792 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002793 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002794
Andy Whitcroft65863862009-01-06 14:41:21 -08002795 # Should start with a space.
2796 $to =~ s/^(\S)/ $1/;
2797 # Should not end with a space.
2798 $to =~ s/\s+$//;
2799 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002800 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002801 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002802
Joe Perches3705ce52013-07-03 15:05:31 -07002803## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08002804 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07002805 if (ERROR("POINTER_LOCATION",
2806 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2807 $fix) {
2808 my $sub_from = $ident;
2809 my $sub_to = $ident;
2810 $sub_to =~ s/\Q$from\E/$to/;
2811 $fixed[$linenr - 1] =~
2812 s@\Q$sub_from\E@$sub_to@;
2813 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002814 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002815 }
2816 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2817 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002818 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002819
Andy Whitcroft65863862009-01-06 14:41:21 -08002820 # Should start with a space.
2821 $to =~ s/^(\S)/ $1/;
2822 # Should not end with a space.
2823 $to =~ s/\s+$//;
2824 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002825 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002826 }
2827 # Modifiers should have spaces.
2828 $to =~ s/(\b$Modifier$)/$1 /;
2829
Joe Perches3705ce52013-07-03 15:05:31 -07002830## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08002831 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002832 if (ERROR("POINTER_LOCATION",
2833 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2834 $fix) {
2835
2836 my $sub_from = $match;
2837 my $sub_to = $match;
2838 $sub_to =~ s/\Q$from\E/$to/;
2839 $fixed[$linenr - 1] =~
2840 s@\Q$sub_from\E@$sub_to@;
2841 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002842 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002843 }
2844
2845# # no BUG() or BUG_ON()
2846# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2847# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2848# print "$herecurr";
2849# $clean = 0;
2850# }
2851
Andy Whitcroft8905a672007-11-28 16:21:06 -08002852 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002853 WARN("LINUX_VERSION_CODE",
2854 "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 -08002855 }
2856
Joe Perches17441222011-06-15 15:08:17 -07002857# check for uses of printk_ratelimit
2858 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002859 WARN("PRINTK_RATELIMITED",
2860"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002861 }
2862
Andy Whitcroft00df3442007-06-08 13:47:06 -07002863# printk should use KERN_* levels. Note that follow on printk's on the
2864# same line do not need a level, so we use the current block context
2865# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002866# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002867# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002868 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002869 my $ok = 0;
2870 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2871 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002872 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07002873 # with "\n" ignore it, else it is to blame
2874 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2875 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2876 $ok = 1;
2877 }
2878 last;
2879 }
2880 }
2881 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002882 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2883 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002884 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002885 }
2886
Joe Perches243f3802012-05-31 16:26:09 -07002887 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2888 my $orig = $1;
2889 my $level = lc($orig);
2890 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002891 my $level2 = $level;
2892 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002893 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07002894 "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 -07002895 }
2896
2897 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002898 if (WARN("PREFER_PR_LEVEL",
2899 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2900 $fix) {
2901 $fixed[$linenr - 1] =~
2902 s/\bpr_warning\b/pr_warn/;
2903 }
Joe Perches243f3802012-05-31 16:26:09 -07002904 }
2905
Joe Perchesdc139312013-02-21 16:44:13 -08002906 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2907 my $orig = $1;
2908 my $level = lc($orig);
2909 $level = "warn" if ($level eq "warning");
2910 $level = "dbg" if ($level eq "debug");
2911 WARN("PREFER_DEV_LEVEL",
2912 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2913 }
2914
Andy Whitcroft653d4872007-06-23 17:16:34 -07002915# function brace can't be on same line, except for #defines of do while,
2916# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002917 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2918 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002919 ERROR("OPEN_BRACE",
2920 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002921 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002922
Andy Whitcroft8905a672007-11-28 16:21:06 -08002923# open braces for enum, union and struct go on the same line.
2924 if ($line =~ /^.\s*{/ &&
2925 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002926 ERROR("OPEN_BRACE",
2927 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002928 }
2929
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002930# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07002931 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2932 if (WARN("SPACING",
2933 "missing space after $1 definition\n" . $herecurr) &&
2934 $fix) {
2935 $fixed[$linenr - 1] =~
2936 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2937 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002938 }
2939
Joe Perches31070b52014-01-23 15:54:49 -08002940# Function pointer declarations
2941# check spacing between type, funcptr, and args
2942# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002943 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08002944 my $declare = $1;
2945 my $pre_pointer_space = $2;
2946 my $post_pointer_space = $3;
2947 my $funcname = $4;
2948 my $post_funcname_space = $5;
2949 my $pre_args_space = $6;
2950
Joe Perches91f72e92014-04-03 14:49:12 -07002951# the $Declare variable will capture all spaces after the type
2952# so check it for a missing trailing missing space but pointer return types
2953# don't need a space so don't warn for those.
2954 my $post_declare_space = "";
2955 if ($declare =~ /(\s+)$/) {
2956 $post_declare_space = $1;
2957 $declare = rtrim($declare);
2958 }
2959 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08002960 WARN("SPACING",
2961 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07002962 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08002963 }
2964
2965# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002966# This test is not currently implemented because these declarations are
2967# equivalent to
2968# int foo(int bar, ...)
2969# and this is form shouldn't/doesn't generate a checkpatch warning.
2970#
2971# elsif ($declare =~ /\s{2,}$/) {
2972# WARN("SPACING",
2973# "Multiple spaces after return type\n" . $herecurr);
2974# }
Joe Perches31070b52014-01-23 15:54:49 -08002975
2976# unnecessary space "type ( *funcptr)(args...)"
2977 if (defined $pre_pointer_space &&
2978 $pre_pointer_space =~ /^\s/) {
2979 WARN("SPACING",
2980 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
2981 }
2982
2983# unnecessary space "type (* funcptr)(args...)"
2984 if (defined $post_pointer_space &&
2985 $post_pointer_space =~ /^\s/) {
2986 WARN("SPACING",
2987 "Unnecessary space before function pointer name\n" . $herecurr);
2988 }
2989
2990# unnecessary space "type (*funcptr )(args...)"
2991 if (defined $post_funcname_space &&
2992 $post_funcname_space =~ /^\s/) {
2993 WARN("SPACING",
2994 "Unnecessary space after function pointer name\n" . $herecurr);
2995 }
2996
2997# unnecessary space "type (*funcptr) (args...)"
2998 if (defined $pre_args_space &&
2999 $pre_args_space =~ /^\s/) {
3000 WARN("SPACING",
3001 "Unnecessary space before function pointer arguments\n" . $herecurr);
3002 }
3003
3004 if (show_type("SPACING") && $fix) {
3005 $fixed[$linenr - 1] =~
Joe Perches91f72e92014-04-03 14:49:12 -07003006 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08003007 }
3008 }
3009
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003010# check for spacing round square brackets; allowed:
3011# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003012# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3013# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003014 while ($line =~ /(.*?\s)\[/g) {
3015 my ($where, $prefix) = ($-[1], $1);
3016 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07003017 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07003018 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003019 if (ERROR("BRACKET_SPACE",
3020 "space prohibited before open square bracket '['\n" . $herecurr) &&
3021 $fix) {
3022 $fixed[$linenr - 1] =~
3023 s/^(\+.*?)\s+\[/$1\[/;
3024 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003025 }
3026 }
3027
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003028# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003029 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003030 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003031 my $ctx_before = substr($line, 0, $-[1]);
3032 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003033
3034 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003035 if ($name =~ /^(?:
3036 if|for|while|switch|return|case|
3037 volatile|__volatile__|
3038 __attribute__|format|__extension__|
3039 asm|__asm__)$/x)
3040 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003041 # cpp #define statements have non-optional spaces, ie
3042 # if there is a space between the name and the open
3043 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003044 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003045
3046 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003047 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003048
3049 # If this whole things ends with a type its most
3050 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003051 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003052
3053 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003054 if (WARN("SPACING",
3055 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3056 $fix) {
3057 $fixed[$linenr - 1] =~
3058 s/\b$name\s+\(/$name\(/;
3059 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003060 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003061 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003062
Andy Whitcroft653d4872007-06-23 17:16:34 -07003063# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003064 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003065 my $fixed_line = "";
3066 my $line_fixed = 0;
3067
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003068 my $ops = qr{
3069 <<=|>>=|<=|>=|==|!=|
3070 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3071 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003072 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003073 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003074 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003075 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003076
3077## print("element count: <" . $#elements . ">\n");
3078## foreach my $el (@elements) {
3079## print("el: <$el>\n");
3080## }
3081
3082 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003083 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003084
Joe Perches3705ce52013-07-03 15:05:31 -07003085 foreach my $el (@elements) {
3086 push(@fix_elements, substr($rawline, $off, length($el)));
3087 $off += length($el);
3088 }
3089
3090 $off = 0;
3091
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003092 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003093 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003094
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003095 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003096
3097 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3098
3099## print("n: <$n> good: <$good>\n");
3100
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003101 $off += length($elements[$n]);
3102
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003103 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003104 my $ca = substr($opline, 0, $off);
3105 my $cc = '';
3106 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3107 $cc = substr($opline, $off + length($elements[$n + 1]));
3108 }
3109 my $cb = "$ca$;$cc";
3110
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003111 my $a = '';
3112 $a = 'V' if ($elements[$n] ne '');
3113 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003114 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003115 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3116 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003117 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003118
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003119 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003120
3121 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003122 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003123 $c = 'V' if ($elements[$n + 2] ne '');
3124 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003125 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003126 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3127 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003128 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003129 } else {
3130 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003131 }
3132
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003133 my $ctx = "${a}x${c}";
3134
3135 my $at = "(ctx:$ctx)";
3136
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003137 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003138 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003139
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003140 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003141 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003142
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003143 # Get the full operator variant.
3144 my $opv = $op . substr($curr_vars, $off, 1);
3145
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003146 # Ignore operators passed as parameters.
3147 if ($op_type ne 'V' &&
3148 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3149
Andy Whitcroftcf655042008-03-04 14:28:20 -08003150# # Ignore comments
3151# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003152
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003153 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003154 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003155 if ($ctx !~ /.x[WEBC]/ &&
3156 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003157 if (ERROR("SPACING",
3158 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003159 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003160 $line_fixed = 1;
3161 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003162 }
3163
3164 # // is a comment
3165 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003166
Joe Perchesb00e4812014-04-03 14:49:33 -07003167 # : when part of a bitfield
3168 } elsif ($opv eq ':B') {
3169 # skip the bitfield test for now
3170
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003171 # No spaces for:
3172 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003173 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003174 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003175 if (ERROR("SPACING",
3176 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003177 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003178 if (defined $fix_elements[$n + 2]) {
3179 $fix_elements[$n + 2] =~ s/^\s+//;
3180 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003181 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003182 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003183 }
3184
3185 # , must have a space on the right.
3186 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003187 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003188 if (ERROR("SPACING",
3189 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003190 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003191 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003192 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07003193 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003194 }
3195
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003196 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003197 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003198 #warn "'*' is part of type\n";
3199
3200 # unary operators should have a space before and
3201 # none after. May be left adjacent to another
3202 # unary operator, or a cast
3203 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003204 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003205 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003206 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003207 if (ERROR("SPACING",
3208 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003209 if ($n != $last_after + 2) {
3210 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3211 $line_fixed = 1;
3212 }
Joe Perches3705ce52013-07-03 15:05:31 -07003213 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003214 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003215 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003216 # A unary '*' may be const
3217
3218 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003219 if (ERROR("SPACING",
3220 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003221 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003222 if (defined $fix_elements[$n + 2]) {
3223 $fix_elements[$n + 2] =~ s/^\s+//;
3224 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003225 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003226 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003227 }
3228
3229 # unary ++ and unary -- are allowed no space on one side.
3230 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003231 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003232 if (ERROR("SPACING",
3233 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003234 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003235 $line_fixed = 1;
3236 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003237 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003238 if ($ctx =~ /Wx[BE]/ ||
3239 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003240 if (ERROR("SPACING",
3241 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003242 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003243 $line_fixed = 1;
3244 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003245 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003246 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003247 if (ERROR("SPACING",
3248 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003249 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003250 if (defined $fix_elements[$n + 2]) {
3251 $fix_elements[$n + 2] =~ s/^\s+//;
3252 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003253 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003254 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003255 }
3256
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003257 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003258 } elsif ($op eq '<<' or $op eq '>>' or
3259 $op eq '&' or $op eq '^' or $op eq '|' or
3260 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003261 $op eq '*' or $op eq '/' or
3262 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003263 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003264 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003265 if (ERROR("SPACING",
3266 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003267 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3268 if (defined $fix_elements[$n + 2]) {
3269 $fix_elements[$n + 2] =~ s/^\s+//;
3270 }
Joe Perches3705ce52013-07-03 15:05:31 -07003271 $line_fixed = 1;
3272 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003273 }
3274
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003275 # A colon needs no spaces before when it is
3276 # terminating a case value or a label.
3277 } elsif ($opv eq ':C' || $opv eq ':L') {
3278 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003279 if (ERROR("SPACING",
3280 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003281 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003282 $line_fixed = 1;
3283 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003284 }
3285
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003286 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003287 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003288 my $ok = 0;
3289
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003290 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003291 if (($op eq '<' &&
3292 $cc =~ /^\S+\@\S+>/) ||
3293 ($op eq '>' &&
3294 $ca =~ /<\S+\@\S+$/))
3295 {
3296 $ok = 1;
3297 }
3298
Joe Perches84731622013-11-12 15:10:05 -08003299 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003300 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003301 my $msg_type = \&ERROR;
3302 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3303
3304 if (&{$msg_type}("SPACING",
3305 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003306 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3307 if (defined $fix_elements[$n + 2]) {
3308 $fix_elements[$n + 2] =~ s/^\s+//;
3309 }
Joe Perches3705ce52013-07-03 15:05:31 -07003310 $line_fixed = 1;
3311 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003312 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003313 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003314 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003315
3316## print("n: <$n> GOOD: <$good>\n");
3317
3318 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003319 }
Joe Perches3705ce52013-07-03 15:05:31 -07003320
3321 if (($#elements % 2) == 0) {
3322 $fixed_line = $fixed_line . $fix_elements[$#elements];
3323 }
3324
3325 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3326 $fixed[$linenr - 1] = $fixed_line;
3327 }
3328
3329
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003330 }
3331
Joe Perches786b6322013-07-03 15:05:32 -07003332# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003333 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003334 if (WARN("SPACING",
3335 "space prohibited before semicolon\n" . $herecurr) &&
3336 $fix) {
3337 1 while $fixed[$linenr - 1] =~
3338 s/^(\+.*\S)\s+;/$1;/;
3339 }
3340 }
3341
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003342# check for multiple assignments
3343 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003344 CHK("MULTIPLE_ASSIGNMENTS",
3345 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003346 }
3347
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003348## # check for multiple declarations, allowing for a function declaration
3349## # continuation.
3350## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3351## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3352##
3353## # Remove any bracketed sections to ensure we do not
3354## # falsly report the parameters of functions.
3355## my $ln = $line;
3356## while ($ln =~ s/\([^\(\)]*\)//g) {
3357## }
3358## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003359## WARN("MULTIPLE_DECLARATION",
3360## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003361## }
3362## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003363
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003364#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003365 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3366 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003367 if (ERROR("SPACING",
3368 "space required before the open brace '{'\n" . $herecurr) &&
3369 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003370 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003371 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003372 }
3373
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003374## # check for blank lines before declarations
3375## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3376## $prevrawline =~ /^.\s*$/) {
3377## WARN("SPACING",
3378## "No blank lines before declarations\n" . $hereprev);
3379## }
3380##
3381
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003382# closing brace should have a space following it when it has anything
3383# on the line
3384 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003385 if (ERROR("SPACING",
3386 "space required after that close brace '}'\n" . $herecurr) &&
3387 $fix) {
3388 $fixed[$linenr - 1] =~
3389 s/}((?!(?:,|;|\)))\S)/} $1/;
3390 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003391 }
3392
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003393# check spacing on square brackets
3394 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003395 if (ERROR("SPACING",
3396 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3397 $fix) {
3398 $fixed[$linenr - 1] =~
3399 s/\[\s+/\[/;
3400 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003401 }
3402 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003403 if (ERROR("SPACING",
3404 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3405 $fix) {
3406 $fixed[$linenr - 1] =~
3407 s/\s+\]/\]/;
3408 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003409 }
3410
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003411# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003412 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3413 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003414 if (ERROR("SPACING",
3415 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3416 $fix) {
3417 $fixed[$linenr - 1] =~
3418 s/\(\s+/\(/;
3419 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003420 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003421 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003422 $line !~ /for\s*\(.*;\s+\)/ &&
3423 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003424 if (ERROR("SPACING",
3425 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3426 $fix) {
3427 $fixed[$linenr - 1] =~
3428 s/\s+\)/\)/;
3429 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003430 }
3431
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003432#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003433 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003434 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003435 if (WARN("INDENTED_LABEL",
3436 "labels should not be indented\n" . $herecurr) &&
3437 $fix) {
3438 $fixed[$linenr - 1] =~
3439 s/^(.)\s+/$1/;
3440 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003441 }
3442
Joe Perches5b9553a2014-04-03 14:49:21 -07003443# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003444 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003445 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003446 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003447 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3448 my $value = $1;
3449 $value = deparenthesize($value);
3450 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3451 ERROR("RETURN_PARENTHESES",
3452 "return is not a function, parentheses are not required\n" . $herecurr);
3453 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003454 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003455 ERROR("SPACING",
3456 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003457 }
3458 }
Joe Perches507e5142013-11-12 15:10:13 -08003459
Joe Perches189248d2014-01-23 15:54:47 -08003460# if statements using unnecessary parentheses - ie: if ((foo == bar))
3461 if ($^V && $^V ge 5.10.0 &&
3462 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3463 my $openparens = $1;
3464 my $count = $openparens =~ tr@\(@\(@;
3465 my $msg = "";
3466 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3467 my $comp = $4; #Not $1 because of $LvalOrFunc
3468 $msg = " - maybe == should be = ?" if ($comp eq "==");
3469 WARN("UNNECESSARY_PARENTHESES",
3470 "Unnecessary parentheses$msg\n" . $herecurr);
3471 }
3472 }
3473
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003474# Return of what appears to be an errno should normally be -'ve
3475 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3476 my $name = $1;
3477 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003478 WARN("USE_NEGATIVE_ERRNO",
3479 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003480 }
3481 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003482
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003483# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003484 if ($line =~ /\b(if|while|for|switch)\(/) {
3485 if (ERROR("SPACING",
3486 "space required before the open parenthesis '('\n" . $herecurr) &&
3487 $fix) {
3488 $fixed[$linenr - 1] =~
3489 s/\b(if|while|for|switch)\(/$1 \(/;
3490 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003491 }
3492
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003493# Check for illegal assignment in if conditional -- and check for trailing
3494# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003495 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003496 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3497 ctx_statement_block($linenr, $realcnt, 0)
3498 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003499 my ($stat_next) = ctx_statement_block($line_nr_next,
3500 $remain_next, $off_next);
3501 $stat_next =~ s/\n./\n /g;
3502 ##print "stat<$stat> stat_next<$stat_next>\n";
3503
3504 if ($stat_next =~ /^\s*while\b/) {
3505 # If the statement carries leading newlines,
3506 # then count those as offsets.
3507 my ($whitespace) =
3508 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3509 my $offset =
3510 statement_rawlines($whitespace) - 1;
3511
3512 $suppress_whiletrailers{$line_nr_next +
3513 $offset} = 1;
3514 }
3515 }
3516 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003517 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003518 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003519 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003520
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003521 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003522 ERROR("ASSIGN_IN_IF",
3523 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003524 }
3525
3526 # Find out what is on the end of the line after the
3527 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003528 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003529 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003530 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003531 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3532 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003533 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003534 # Find out how long the conditional actually is.
3535 my @newlines = ($c =~ /\n/gs);
3536 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003537 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003538
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003539 $stat_real = raw_line($linenr, $cond_lines)
3540 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003541 if (defined($stat_real) && $cond_lines > 1) {
3542 $stat_real = "[...]\n$stat_real";
3543 }
3544
Joe Perches000d1cc12011-07-25 17:13:25 -07003545 ERROR("TRAILING_STATEMENTS",
3546 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003547 }
3548 }
3549
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003550# Check for bitwise tests written as boolean
3551 if ($line =~ /
3552 (?:
3553 (?:\[|\(|\&\&|\|\|)
3554 \s*0[xX][0-9]+\s*
3555 (?:\&\&|\|\|)
3556 |
3557 (?:\&\&|\|\|)
3558 \s*0[xX][0-9]+\s*
3559 (?:\&\&|\|\||\)|\])
3560 )/x)
3561 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003562 WARN("HEXADECIMAL_BOOLEAN_TEST",
3563 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003564 }
3565
Andy Whitcroft8905a672007-11-28 16:21:06 -08003566# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003567 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3568 my $s = $1;
3569 $s =~ s/$;//g; # Remove any comments
3570 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003571 ERROR("TRAILING_STATEMENTS",
3572 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003573 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003574 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003575# if should not continue a brace
3576 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003577 ERROR("TRAILING_STATEMENTS",
3578 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003579 $herecurr);
3580 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003581# case and default should not have general statements after them
3582 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3583 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003584 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003585 \s*return\s+
3586 )/xg)
3587 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003588 ERROR("TRAILING_STATEMENTS",
3589 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003590 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003591
3592 # Check for }<nl>else {, these must be at the same
3593 # indent level to be relevant to each other.
3594 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3595 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003596 ERROR("ELSE_AFTER_BRACE",
3597 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003598 }
3599
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003600 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3601 $previndent == $indent) {
3602 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3603
3604 # Find out what is on the end of the line after the
3605 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003606 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003607 $s =~ s/\n.*//g;
3608
3609 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003610 ERROR("WHILE_AFTER_BRACE",
3611 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003612 }
3613 }
3614
Joe Perches95e2c602013-07-03 15:05:20 -07003615#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003616 while ($line =~ m{($Constant|$Lval)}g) {
3617 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003618
3619#gcc binary extension
3620 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003621 if (WARN("GCC_BINARY_CONSTANT",
3622 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3623 $fix) {
3624 my $hexval = sprintf("0x%x", oct($var));
3625 $fixed[$linenr - 1] =~
3626 s/\b$var\b/$hexval/;
3627 }
Joe Perches95e2c602013-07-03 15:05:20 -07003628 }
3629
3630#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003631 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003632 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003633#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003634 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003635#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003636 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003637 while ($var =~ m{($Ident)}g) {
3638 my $word = $1;
3639 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08003640 if ($check) {
3641 seed_camelcase_includes();
3642 if (!$file && !$camelcase_file_seeded) {
3643 seed_camelcase_file($realfile);
3644 $camelcase_file_seeded = 1;
3645 }
3646 }
Joe Perches7e781f62013-09-11 14:23:55 -07003647 if (!defined $camelcase{$word}) {
3648 $camelcase{$word} = 1;
3649 CHK("CAMELCASE",
3650 "Avoid CamelCase: <$word>\n" . $herecurr);
3651 }
Joe Perches34456862013-07-03 15:05:34 -07003652 }
Joe Perches323c1262012-12-17 16:02:07 -08003653 }
3654 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003655
3656#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003657 if ($line =~ /\#\s*define.*\\\s+$/) {
3658 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3659 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3660 $fix) {
3661 $fixed[$linenr - 1] =~ s/\s+$//;
3662 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003663 }
3664
Andy Whitcroft653d4872007-06-23 17:16:34 -07003665#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003666 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003667 my $file = "$1.h";
3668 my $checkfile = "include/linux/$file";
3669 if (-f "$root/$checkfile" &&
3670 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003671 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003672 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003673 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003674 CHK("ARCH_INCLUDE_LINUX",
3675 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003676 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003677 WARN("INCLUDE_LINUX",
3678 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003679 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003680 }
3681 }
3682
Andy Whitcroft653d4872007-06-23 17:16:34 -07003683# multi-statement macros should be enclosed in a do while loop, grab the
3684# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003685# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07003686 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3687 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003688 my $ln = $linenr;
3689 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003690 my ($off, $dstat, $dcond, $rest);
3691 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003692 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003693 ctx_statement_block($linenr, $realcnt, 0);
3694 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003695 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003696 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003697
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003698 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003699 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003700 $dstat =~ s/\\\n.//g;
3701 $dstat =~ s/^\s*//s;
3702 $dstat =~ s/\s*$//s;
3703
3704 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003705 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3706 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003707 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003708 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003709 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003710
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003711 # Flatten any obvious string concatentation.
3712 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3713 $dstat =~ s/$Ident\s*("X*")/$1/)
3714 {
3715 }
3716
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003717 my $exceptions = qr{
3718 $Declare|
3719 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003720 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003721 DECLARE_PER_CPU|
3722 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003723 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003724 union|
3725 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003726 \.$Ident\s*=\s*|
3727 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003728 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003729 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003730 if ($dstat ne '' &&
3731 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3732 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07003733 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003734 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003735 $dstat !~ /$exceptions/ &&
3736 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003737 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003738 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003739 $dstat !~ /^for\s*$Constant$/ && # for (...)
3740 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3741 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07003742 $dstat !~ /^\({/ && # ({...
3743 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003744 {
3745 $ctx =~ s/\n*$//;
3746 my $herectx = $here . "\n";
3747 my $cnt = statement_rawlines($ctx);
3748
3749 for (my $n = 0; $n < $cnt; $n++) {
3750 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003751 }
3752
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003753 if ($dstat =~ /;/) {
3754 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3755 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3756 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003757 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003758 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003759 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003760 }
Joe Perches5023d342012-12-17 16:01:47 -08003761
Joe Perches481eb482012-12-17 16:01:56 -08003762# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003763
3764 } else {
3765 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003766 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3767 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003768 $line =~ /^\+.*\\$/) {
3769 WARN("LINE_CONTINUATIONS",
3770 "Avoid unnecessary line continuations\n" . $herecurr);
3771 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003772 }
3773
Joe Perchesb13edf72012-07-30 14:41:24 -07003774# do {} while (0) macro tests:
3775# single-statement macros do not need to be enclosed in do while (0) loop,
3776# macro should not end with a semicolon
3777 if ($^V && $^V ge 5.10.0 &&
3778 $realfile !~ m@/vmlinux.lds.h$@ &&
3779 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3780 my $ln = $linenr;
3781 my $cnt = $realcnt;
3782 my ($off, $dstat, $dcond, $rest);
3783 my $ctx = '';
3784 ($dstat, $dcond, $ln, $cnt, $off) =
3785 ctx_statement_block($linenr, $realcnt, 0);
3786 $ctx = $dstat;
3787
3788 $dstat =~ s/\\\n.//g;
3789
3790 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3791 my $stmts = $2;
3792 my $semis = $3;
3793
3794 $ctx =~ s/\n*$//;
3795 my $cnt = statement_rawlines($ctx);
3796 my $herectx = $here . "\n";
3797
3798 for (my $n = 0; $n < $cnt; $n++) {
3799 $herectx .= raw_line($linenr, $n) . "\n";
3800 }
3801
Joe Perchesac8e97f2012-08-21 16:15:53 -07003802 if (($stmts =~ tr/;/;/) == 1 &&
3803 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003804 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3805 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3806 }
3807 if (defined $semis && $semis ne "") {
3808 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3809 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3810 }
3811 }
3812 }
3813
Mike Frysinger080ba922009-01-06 14:41:25 -08003814# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3815# all assignments may have only one of the following with an assignment:
3816# .
3817# ALIGN(...)
3818# VMLINUX_SYMBOL(...)
3819 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003820 WARN("MISSING_VMLINUX_SYMBOL",
3821 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003822 }
3823
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003824# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003825 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3826 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003827 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003828 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003829 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3830 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003831 my @allowed = ();
3832 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003833 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003834 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003835 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003836 for my $chunk (@chunks) {
3837 my ($cond, $block) = @{$chunk};
3838
Andy Whitcroft773647a2008-03-28 14:15:58 -07003839 # If the condition carries leading newlines, then count those as offsets.
3840 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3841 my $offset = statement_rawlines($whitespace) - 1;
3842
Joe Perchesaad4f612012-03-23 15:02:19 -07003843 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003844 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3845
3846 # We have looked at and allowed this specific line.
3847 $suppress_ifbraces{$ln + $offset} = 1;
3848
3849 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003850 $ln += statement_rawlines($block) - 1;
3851
Andy Whitcroft773647a2008-03-28 14:15:58 -07003852 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003853
3854 $seen++ if ($block =~ /^\s*{/);
3855
Joe Perchesaad4f612012-03-23 15:02:19 -07003856 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003857 if (statement_lines($cond) > 1) {
3858 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003859 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003860 }
3861 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003862 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003863 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003864 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003865 if (statement_block_size($block) > 1) {
3866 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003867 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003868 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003869 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003870 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003871 if ($seen) {
3872 my $sum_allowed = 0;
3873 foreach (@allowed) {
3874 $sum_allowed += $_;
3875 }
3876 if ($sum_allowed == 0) {
3877 WARN("BRACES",
3878 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3879 } elsif ($sum_allowed != $allow &&
3880 $seen != $allow) {
3881 CHK("BRACES",
3882 "braces {} should be used on all arms of this statement\n" . $herectx);
3883 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003884 }
3885 }
3886 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003887 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003888 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003889 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003890
Andy Whitcroftcf655042008-03-04 14:28:20 -08003891 # Check the pre-context.
3892 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3893 #print "APW: ALLOWED: pre<$1>\n";
3894 $allowed = 1;
3895 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003896
3897 my ($level, $endln, @chunks) =
3898 ctx_statement_full($linenr, $realcnt, $-[0]);
3899
Andy Whitcroftcf655042008-03-04 14:28:20 -08003900 # Check the condition.
3901 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003902 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003903 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003904 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003905 }
3906 if (statement_lines($cond) > 1) {
3907 #print "APW: ALLOWED: cond<$cond>\n";
3908 $allowed = 1;
3909 }
3910 if ($block =~/\b(?:if|for|while)\b/) {
3911 #print "APW: ALLOWED: block<$block>\n";
3912 $allowed = 1;
3913 }
3914 if (statement_block_size($block) > 1) {
3915 #print "APW: ALLOWED: lines block<$block>\n";
3916 $allowed = 1;
3917 }
3918 # Check the post-context.
3919 if (defined $chunks[1]) {
3920 my ($cond, $block) = @{$chunks[1]};
3921 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003922 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003923 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003924 if ($block =~ /^\s*\{/) {
3925 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3926 $allowed = 1;
3927 }
3928 }
3929 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003930 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003931 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003932
Andy Whitcroftf0556632008-10-15 22:02:23 -07003933 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003934 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003935 }
3936
Joe Perches000d1cc12011-07-25 17:13:25 -07003937 WARN("BRACES",
3938 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003939 }
3940 }
3941
Joe Perches0979ae62012-12-17 16:01:59 -08003942# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07003943 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003944 CHK("BRACES",
3945 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3946 }
Joe Perches77b9a532013-07-03 15:05:29 -07003947 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003948 CHK("BRACES",
3949 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3950 }
3951
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003952# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003953 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3954 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003955 WARN("VOLATILE",
3956 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003957 }
3958
Andy Whitcroft00df3442007-06-08 13:47:06 -07003959# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003960 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003961 CHK("REDUNDANT_CODE",
3962 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003963 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003964 }
3965
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003966# check for needless "if (<foo>) fn(<foo>)" uses
3967 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3968 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3969 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3970 WARN('NEEDLESS_IF',
3971 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003972 }
3973 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003974
Joe Perches8716de32013-09-11 14:24:05 -07003975# check for bad placement of section $InitAttribute (e.g.: __initdata)
3976 if ($line =~ /(\b$InitAttribute\b)/) {
3977 my $attr = $1;
3978 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
3979 my $ptr = $1;
3980 my $var = $2;
3981 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
3982 ERROR("MISPLACED_INIT",
3983 "$attr should be placed after $var\n" . $herecurr)) ||
3984 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
3985 WARN("MISPLACED_INIT",
3986 "$attr should be placed after $var\n" . $herecurr))) &&
3987 $fix) {
3988 $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;
3989 }
3990 }
3991 }
3992
Joe Perchese970b8842013-11-12 15:10:10 -08003993# check for $InitAttributeData (ie: __initdata) with const
3994 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
3995 my $attr = $1;
3996 $attr =~ /($InitAttributePrefix)(.*)/;
3997 my $attr_prefix = $1;
3998 my $attr_type = $2;
3999 if (ERROR("INIT_ATTRIBUTE",
4000 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
4001 $fix) {
4002 $fixed[$linenr - 1] =~
4003 s/$InitAttributeData/${attr_prefix}initconst/;
4004 }
4005 }
4006
4007# check for $InitAttributeConst (ie: __initconst) without const
4008 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
4009 my $attr = $1;
4010 if (ERROR("INIT_ATTRIBUTE",
4011 "Use of $attr requires a separate use of const\n" . $herecurr) &&
4012 $fix) {
4013 my $lead = $fixed[$linenr - 1] =~
4014 /(^\+\s*(?:static\s+))/;
4015 $lead = rtrim($1);
4016 $lead = "$lead " if ($lead !~ /^\+$/);
4017 $lead = "${lead}const ";
4018 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
4019 }
4020 }
4021
Joe Perchesfbdb8132014-04-03 14:49:14 -07004022# don't use __constant_<foo> functions outside of include/uapi/
4023 if ($realfile !~ m@^include/uapi/@ &&
4024 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4025 my $constant_func = $1;
4026 my $func = $constant_func;
4027 $func =~ s/^__constant_//;
4028 if (WARN("CONSTANT_CONVERSION",
4029 "$constant_func should be $func\n" . $herecurr) &&
4030 $fix) {
4031 $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
4032 }
4033 }
4034
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004035# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004036 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004037 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004038 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004039 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004040 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004041 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4042 }
4043 if ($delay > 2000) {
4044 WARN("LONG_UDELAY",
4045 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004046 }
4047 }
4048
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004049# warn about unexpectedly long msleep's
4050 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4051 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004052 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004053 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004054 }
4055 }
4056
Joe Perches36ec1932013-07-03 15:05:25 -07004057# check for comparisons of jiffies
4058 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4059 WARN("JIFFIES_COMPARISON",
4060 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4061 }
4062
Joe Perches9d7a34a2013-07-03 15:05:26 -07004063# check for comparisons of get_jiffies_64()
4064 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4065 WARN("JIFFIES_COMPARISON",
4066 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4067 }
4068
Andy Whitcroft00df3442007-06-08 13:47:06 -07004069# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004070# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07004071# print "#ifdef in C files should be avoided\n";
4072# print "$herecurr";
4073# $clean = 0;
4074# }
4075
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004076# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004077 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004078 if (ERROR("SPACING",
4079 "exactly one space required after that #$1\n" . $herecurr) &&
4080 $fix) {
4081 $fixed[$linenr - 1] =~
4082 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4083 }
4084
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004085 }
4086
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004087# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004088 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4089 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004090 my $which = $1;
4091 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004092 CHK("UNCOMMENTED_DEFINITION",
4093 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004094 }
4095 }
4096# check for memory barriers without a comment.
4097 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4098 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004099 WARN("MEMORY_BARRIER",
4100 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004101 }
4102 }
4103# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004104 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004105 CHK("ARCH_DEFINES",
4106 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004107 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004108
Tobias Klauserd4977c72010-05-24 14:33:30 -07004109# Check that the storage class is at the beginning of a declaration
4110 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004111 WARN("STORAGE_CLASS",
4112 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004113 }
4114
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004115# check the location of the inline attribute, that it is between
4116# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004117 if ($line =~ /\b$Type\s+$Inline\b/ ||
4118 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004119 ERROR("INLINE_LOCATION",
4120 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004121 }
4122
Andy Whitcroft8905a672007-11-28 16:21:06 -08004123# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004124 if ($realfile !~ m@\binclude/uapi/@ &&
4125 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004126 if (WARN("INLINE",
4127 "plain inline is preferred over $1\n" . $herecurr) &&
4128 $fix) {
4129 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4130
4131 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004132 }
4133
Joe Perches3d130fd2011-01-12 17:00:00 -08004134# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004135 if ($realfile !~ m@\binclude/uapi/@ &&
4136 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004137 WARN("PREFER_PACKED",
4138 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004139 }
4140
Joe Perches39b7e282011-07-25 17:13:24 -07004141# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004142 if ($realfile !~ m@\binclude/uapi/@ &&
4143 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004144 WARN("PREFER_ALIGNED",
4145 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004146 }
4147
Joe Perches5f14d3b2012-01-10 15:09:52 -08004148# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004149 if ($realfile !~ m@\binclude/uapi/@ &&
4150 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004151 if (WARN("PREFER_PRINTF",
4152 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4153 $fix) {
4154 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4155
4156 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004157 }
4158
Joe Perches6061d942012-03-23 15:02:16 -07004159# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004160 if ($realfile !~ m@\binclude/uapi/@ &&
4161 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004162 if (WARN("PREFER_SCANF",
4163 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4164 $fix) {
4165 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4166 }
Joe Perches6061d942012-03-23 15:02:16 -07004167 }
4168
Joe Perches8f53a9b2010-03-05 13:43:48 -08004169# check for sizeof(&)
4170 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004171 WARN("SIZEOF_ADDRESS",
4172 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004173 }
4174
Joe Perches66c80b62012-07-30 14:41:22 -07004175# check for sizeof without parenthesis
4176 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004177 if (WARN("SIZEOF_PARENTHESIS",
4178 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4179 $fix) {
4180 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4181 }
Joe Perches66c80b62012-07-30 14:41:22 -07004182 }
4183
Joe Perches428e2fd2011-05-24 17:13:39 -07004184# check for line continuations in quoted strings with odd counts of "
4185 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004186 WARN("LINE_CONTINUATIONS",
4187 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004188 }
4189
Joe Perches88982fe2012-12-17 16:02:00 -08004190# check for struct spinlock declarations
4191 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4192 WARN("USE_SPINLOCK_T",
4193 "struct spinlock should be spinlock_t\n" . $herecurr);
4194 }
4195
Joe Perchesa6962d72013-04-29 16:18:13 -07004196# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004197 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004198 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004199 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004200 if (WARN("PREFER_SEQ_PUTS",
4201 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4202 $fix) {
4203 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4204 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004205 }
4206 }
4207
Andy Whitcroft554e1652012-01-10 15:09:57 -08004208# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004209 if ($^V && $^V ge 5.10.0 &&
4210 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004211 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004212
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004213 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004214 my $ms_val = $7;
4215 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004216
Andy Whitcroft554e1652012-01-10 15:09:57 -08004217 if ($ms_size =~ /^(0x|)0$/i) {
4218 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004219 "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 -08004220 } elsif ($ms_size =~ /^(0x|)1$/i) {
4221 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004222 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4223 }
4224 }
4225
Joe Perches98a9bba2014-01-23 15:54:52 -08004226# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4227 if ($^V && $^V ge 5.10.0 &&
4228 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4229 if (WARN("PREFER_ETHER_ADDR_COPY",
4230 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4231 $fix) {
4232 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4233 }
4234 }
4235
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004236# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004237 if ($^V && $^V ge 5.10.0 &&
4238 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004239 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004240 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004241 my $call = $1;
4242 my $cast1 = deparenthesize($2);
4243 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004244 my $cast2 = deparenthesize($7);
4245 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004246 my $cast;
4247
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004248 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004249 $cast = "$cast1 or $cast2";
4250 } elsif ($cast1 ne "") {
4251 $cast = $cast1;
4252 } else {
4253 $cast = $cast2;
4254 }
4255 WARN("MINMAX",
4256 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004257 }
4258 }
4259
Joe Perches4a273192012-07-30 14:41:20 -07004260# check usleep_range arguments
4261 if ($^V && $^V ge 5.10.0 &&
4262 defined $stat &&
4263 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4264 my $min = $1;
4265 my $max = $7;
4266 if ($min eq $max) {
4267 WARN("USLEEP_RANGE",
4268 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4269 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4270 $min > $max) {
4271 WARN("USLEEP_RANGE",
4272 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4273 }
4274 }
4275
Joe Perches823b7942013-11-12 15:10:15 -08004276# check for naked sscanf
4277 if ($^V && $^V ge 5.10.0 &&
4278 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004279 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004280 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4281 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4282 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4283 my $lc = $stat =~ tr@\n@@;
4284 $lc = $lc + $linenr;
4285 my $stat_real = raw_line($linenr, 0);
4286 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4287 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4288 }
4289 WARN("NAKED_SSCANF",
4290 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4291 }
4292
Joe Perches70dc8a42013-09-11 14:23:58 -07004293# check for new externs in .h files.
4294 if ($realfile =~ /\.h$/ &&
4295 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004296 if (CHK("AVOID_EXTERNS",
4297 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004298 $fix) {
4299 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4300 }
4301 }
4302
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004303# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004304 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004305 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004306 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004307 my $function_name = $1;
4308 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004309
4310 my $s = $stat;
4311 if (defined $cond) {
4312 substr($s, 0, length($cond), '');
4313 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004314 if ($s =~ /^\s*;/ &&
4315 $function_name ne 'uninitialized_var')
4316 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004317 WARN("AVOID_EXTERNS",
4318 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004319 }
4320
4321 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004322 WARN("FUNCTION_ARGUMENTS",
4323 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004324 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004325
4326 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4327 $stat =~ /^.\s*extern\s+/)
4328 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004329 WARN("AVOID_EXTERNS",
4330 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004331 }
4332
4333# checks for new __setup's
4334 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4335 my $name = $1;
4336
4337 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004338 CHK("UNDOCUMENTED_SETUP",
4339 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004340 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004341 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004342
4343# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004344 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004345 WARN("UNNECESSARY_CASTS",
4346 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004347 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004348
Joe Perchesa640d252013-07-03 15:05:21 -07004349# alloc style
4350# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4351 if ($^V && $^V ge 5.10.0 &&
4352 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4353 CHK("ALLOC_SIZEOF_STRUCT",
4354 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4355 }
4356
Joe Perches972fdea2013-04-29 16:18:12 -07004357# check for krealloc arg reuse
4358 if ($^V && $^V ge 5.10.0 &&
4359 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4360 WARN("KREALLOC_ARG_REUSE",
4361 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4362 }
4363
Joe Perches5ce59ae2013-02-21 16:44:18 -08004364# check for alloc argument mismatch
4365 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4366 WARN("ALLOC_ARRAY_ARGS",
4367 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4368 }
4369
Joe Perchescaf2a542011-01-12 16:59:56 -08004370# check for multiple semicolons
4371 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004372 if (WARN("ONE_SEMICOLON",
4373 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4374 $fix) {
4375 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4376 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004377 }
4378
Joe Perchesc34c09a2014-01-23 15:54:43 -08004379# check for case / default statements not preceeded by break/fallthrough/switch
4380 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4381 my $has_break = 0;
4382 my $has_statement = 0;
4383 my $count = 0;
4384 my $prevline = $linenr;
4385 while ($prevline > 1 && $count < 3 && !$has_break) {
4386 $prevline--;
4387 my $rline = $rawlines[$prevline - 1];
4388 my $fline = $lines[$prevline - 1];
4389 last if ($fline =~ /^\@\@/);
4390 next if ($fline =~ /^\-/);
4391 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4392 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4393 next if ($fline =~ /^.[\s$;]*$/);
4394 $has_statement = 1;
4395 $count++;
4396 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4397 }
4398 if (!$has_break && $has_statement) {
4399 WARN("MISSING_BREAK",
4400 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4401 }
4402 }
4403
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004404# check for switch/default statements without a break;
4405 if ($^V && $^V ge 5.10.0 &&
4406 defined $stat &&
4407 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4408 my $ctx = '';
4409 my $herectx = $here . "\n";
4410 my $cnt = statement_rawlines($stat);
4411 for (my $n = 0; $n < $cnt; $n++) {
4412 $herectx .= raw_line($linenr, $n) . "\n";
4413 }
4414 WARN("DEFAULT_NO_BREAK",
4415 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004416 }
4417
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004418# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004419 if ($line =~ /\b__FUNCTION__\b/) {
4420 if (WARN("USE_FUNC",
4421 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4422 $fix) {
4423 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4424 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004425 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004426
Joe Perches2c924882012-03-23 15:02:20 -07004427# check for use of yield()
4428 if ($line =~ /\byield\s*\(\s*\)/) {
4429 WARN("YIELD",
4430 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4431 }
4432
Joe Perches179f8f42013-07-03 15:05:30 -07004433# check for comparisons against true and false
4434 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4435 my $lead = $1;
4436 my $arg = $2;
4437 my $test = $3;
4438 my $otype = $4;
4439 my $trail = $5;
4440 my $op = "!";
4441
4442 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4443
4444 my $type = lc($otype);
4445 if ($type =~ /^(?:true|false)$/) {
4446 if (("$test" eq "==" && "$type" eq "true") ||
4447 ("$test" eq "!=" && "$type" eq "false")) {
4448 $op = "";
4449 }
4450
4451 CHK("BOOL_COMPARISON",
4452 "Using comparison to $otype is error prone\n" . $herecurr);
4453
4454## maybe suggesting a correct construct would better
4455## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4456
4457 }
4458 }
4459
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004460# check for semaphores initialized locked
4461 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004462 WARN("CONSIDER_COMPLETION",
4463 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004464 }
Joe Perches6712d852012-03-23 15:02:20 -07004465
Joe Perches67d0a072011-10-31 17:13:10 -07004466# recommend kstrto* over simple_strto* and strict_strto*
4467 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004468 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004469 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004470 }
Joe Perches6712d852012-03-23 15:02:20 -07004471
Michael Ellermanf3db6632008-07-23 21:28:57 -07004472# check for __initcall(), use device_initcall() explicitly please
4473 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004474 WARN("USE_DEVICE_INITCALL",
4475 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07004476 }
Joe Perches6712d852012-03-23 15:02:20 -07004477
Emese Revfy79404842010-03-05 13:43:53 -08004478# check for various ops structs, ensure they are const.
4479 my $struct_ops = qr{acpi_dock_ops|
4480 address_space_operations|
4481 backlight_ops|
4482 block_device_operations|
4483 dentry_operations|
4484 dev_pm_ops|
4485 dma_map_ops|
4486 extent_io_ops|
4487 file_lock_operations|
4488 file_operations|
4489 hv_ops|
4490 ide_dma_ops|
4491 intel_dvo_dev_ops|
4492 item_operations|
4493 iwl_ops|
4494 kgdb_arch|
4495 kgdb_io|
4496 kset_uevent_ops|
4497 lock_manager_operations|
4498 microcode_ops|
4499 mtrr_ops|
4500 neigh_ops|
4501 nlmsvc_binding|
4502 pci_raw_ops|
4503 pipe_buf_operations|
4504 platform_hibernation_ops|
4505 platform_suspend_ops|
4506 proto_ops|
4507 rpc_pipe_ops|
4508 seq_operations|
4509 snd_ac97_build_ops|
4510 soc_pcmcia_socket_ops|
4511 stacktrace_ops|
4512 sysfs_ops|
4513 tty_operations|
4514 usb_mon_operations|
4515 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004516 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004517 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004518 WARN("CONST_STRUCT",
4519 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004520 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004521 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004522
4523# use of NR_CPUS is usually wrong
4524# ignore definitions of NR_CPUS and usage to define arrays as likely right
4525 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004526 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4527 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004528 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4529 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4530 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004531 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004532 WARN("NR_CPUS",
4533 "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 -07004534 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004535
Joe Perches52ea8502013-11-12 15:10:09 -08004536# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4537 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4538 ERROR("DEFINE_ARCH_HAS",
4539 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4540 }
4541
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004542# check for %L{u,d,i} in strings
4543 my $string;
4544 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4545 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004546 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004547 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004548 WARN("PRINTF_L",
4549 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004550 last;
4551 }
4552 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004553
4554# whine mightly about in_atomic
4555 if ($line =~ /\bin_atomic\s*\(/) {
4556 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004557 ERROR("IN_ATOMIC",
4558 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004559 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004560 WARN("IN_ATOMIC",
4561 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004562 }
4563 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004564
4565# check for lockdep_set_novalidate_class
4566 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4567 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4568 if ($realfile !~ m@^kernel/lockdep@ &&
4569 $realfile !~ m@^include/linux/lockdep@ &&
4570 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004571 ERROR("LOCKDEP",
4572 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004573 }
4574 }
Dave Jones88f88312011-01-12 16:59:59 -08004575
4576 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4577 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004578 WARN("EXPORTED_WORLD_WRITABLE",
4579 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004580 }
Joe Perches24358802014-04-03 14:49:13 -07004581
Joe Perches515a2352014-04-03 14:49:24 -07004582# Mode permission misuses where it seems decimal should be octal
4583# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4584 if ($^V && $^V ge 5.10.0 &&
4585 $line =~ /$mode_perms_search/) {
4586 foreach my $entry (@mode_permission_funcs) {
4587 my $func = $entry->[0];
4588 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07004589
Joe Perches515a2352014-04-03 14:49:24 -07004590 my $skip_args = "";
4591 if ($arg_pos > 1) {
4592 $arg_pos--;
4593 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4594 }
4595 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4596 if ($line =~ /$test/) {
4597 my $val = $1;
4598 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07004599
Joe Perches515a2352014-04-03 14:49:24 -07004600 if ($val !~ /^0$/ &&
4601 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4602 length($val) ne 4)) {
4603 ERROR("NON_OCTAL_PERMISSIONS",
4604 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4605 }
Joe Perches24358802014-04-03 14:49:13 -07004606 }
4607 }
4608 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004609 }
4610
4611 # If we have no input at all, then there is nothing to report on
4612 # so just keep quiet.
4613 if ($#rawlines == -1) {
4614 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004615 }
4616
Andy Whitcroft8905a672007-11-28 16:21:06 -08004617 # In mailback mode only produce a report in the negative, for
4618 # things that appear to be patches.
4619 if ($mailback && ($clean == 1 || !$is_patch)) {
4620 exit(0);
4621 }
4622
4623 # This is not a patch, and we are are in 'no-patch' mode so
4624 # just keep quiet.
4625 if (!$chk_patch && !$is_patch) {
4626 exit(0);
4627 }
4628
4629 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004630 ERROR("NOT_UNIFIED_DIFF",
4631 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004632 }
4633 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004634 ERROR("MISSING_SIGN_OFF",
4635 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004636 }
4637
Andy Whitcroft8905a672007-11-28 16:21:06 -08004638 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004639 if ($summary && !($clean == 1 && $quiet == 1)) {
4640 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004641 print "total: $cnt_error errors, $cnt_warn warnings, " .
4642 (($check)? "$cnt_chk checks, " : "") .
4643 "$cnt_lines lines checked\n";
4644 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004645 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004646
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004647 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004648
4649 if ($^V lt 5.10.0) {
4650 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4651 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4652 }
4653
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004654 # If there were whitespace errors which cleanpatch can fix
4655 # then suggest that.
4656 if ($rpt_cleaners) {
4657 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4658 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07004659 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004660 }
4661 }
4662
Joe Perches91bfe482013-09-11 14:23:59 -07004663 hash_show_words(\%use_type, "Used");
4664 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07004665
Joe Perches3705ce52013-07-03 15:05:31 -07004666 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
Joe Perches9624b8d2014-01-23 15:54:44 -08004667 my $newfile = $filename;
4668 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07004669 my $linecount = 0;
4670 my $f;
4671
4672 open($f, '>', $newfile)
4673 or die "$P: Can't open $newfile for write\n";
4674 foreach my $fixed_line (@fixed) {
4675 $linecount++;
4676 if ($file) {
4677 if ($linecount > 3) {
4678 $fixed_line =~ s/^\+//;
4679 print $f $fixed_line. "\n";
4680 }
4681 } else {
4682 print $f $fixed_line . "\n";
4683 }
4684 }
4685 close($f);
4686
4687 if (!$quiet) {
4688 print << "EOM";
4689Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4690
4691Do _NOT_ trust the results written to this file.
4692Do _NOT_ submit these changes without inspecting them for correctness.
4693
4694This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4695No warranties, expressed or implied...
4696
4697EOM
4698 }
4699 }
4700
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004701 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004702 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004703 }
4704 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004705 print << "EOM";
4706$vname has style problems, please review.
4707
4708If any of these errors are false positives, please report
4709them to the maintainer, see CHECKPATCH in MAINTAINERS.
4710EOM
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004711 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004712
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004713 return $clean;
4714}