blob: 62d005e06031f2c78558857f0418e520a97e6552 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070010
11my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070012$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
Joe Perches000d1cc12011-07-25 17:13:25 -070014my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070015
16use Getopt::Long qw(:config no_auto_abbrev);
17
18my $quiet = 0;
19my $tree = 1;
20my $chk_signoff = 1;
21my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070022my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080024my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070025my $file = 0;
26my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080027my $summary = 1;
28my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080029my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070030my $show_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070031my $fix = 0;
Joe Perches9624b8d2014-01-23 15:54:44 -080032my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070033my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080034my %debug;
Joe Perches34456862013-07-03 15:05:34 -070035my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070036my %use_type = ();
37my @use = ();
38my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070039my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070040my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070041my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080042my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070043my $ignore_perl_version = 0;
44my $minimum_perl_version = 5.10.0;
Hannes Eder77f5b102009-09-21 17:04:37 -070045
46sub help {
47 my ($exitcode) = @_;
48
49 print << "EOM";
50Usage: $P [OPTION]... [FILE]...
51Version: $V
52
53Options:
54 -q, --quiet quiet
55 --no-tree run without a kernel tree
56 --no-signoff do not check for 'Signed-off-by' line
57 --patch treat FILE as patchfile (default)
58 --emacs emacs compile window format
59 --terse one line per report
60 -f, --file treat FILE as regular source file
61 --subjective, --strict enable more subjective tests
Joe Perches91bfe482013-09-11 14:23:59 -070062 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070063 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080064 --max-line-length=n set the maximum line length, if exceeded, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070065 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070066 --root=PATH PATH to the kernel tree root
67 --no-summary suppress the per-file summary
68 --mailback only produce a report in case of warnings/errors
69 --summary-file include the filename in summary
70 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
71 'values', 'possible', 'type', and 'attr' (default
72 is all off)
73 --test-only=WORD report only warnings/errors containing WORD
74 literally
Joe Perches3705ce52013-07-03 15:05:31 -070075 --fix EXPERIMENTAL - may create horrible results
76 If correctable single-line errors exist, create
77 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
78 with potential errors corrected to the preferred
79 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -080080 --fix-inplace EXPERIMENTAL - may create horrible results
81 Is the same as --fix, but overwrites the input
82 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -070083 --ignore-perl-version override checking of perl version. expect
84 runtime errors.
Hannes Eder77f5b102009-09-21 17:04:37 -070085 -h, --help, --version display this help and exit
86
87When FILE is - read standard input.
88EOM
89
90 exit($exitcode);
91}
92
Joe Perches000d1cc12011-07-25 17:13:25 -070093my $conf = which_conf($configuration_file);
94if (-f $conf) {
95 my @conf_args;
96 open(my $conffile, '<', "$conf")
97 or warn "$P: Can't find a readable $configuration_file file $!\n";
98
99 while (<$conffile>) {
100 my $line = $_;
101
102 $line =~ s/\s*\n?$//g;
103 $line =~ s/^\s*//g;
104 $line =~ s/\s+/ /g;
105
106 next if ($line =~ m/^\s*#/);
107 next if ($line =~ m/^\s*$/);
108
109 my @words = split(" ", $line);
110 foreach my $word (@words) {
111 last if ($word =~ m/^#/);
112 push (@conf_args, $word);
113 }
114 }
115 close($conffile);
116 unshift(@ARGV, @conf_args) if @conf_args;
117}
118
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700119GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700120 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700121 'tree!' => \$tree,
122 'signoff!' => \$chk_signoff,
123 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700124 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800125 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700126 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700127 'subjective!' => \$check,
128 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700129 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700130 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700131 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800132 'max-line-length=i' => \$max_line_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700133 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800134 'summary!' => \$summary,
135 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800136 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700137 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800138 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700139 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800140 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700141 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700142 'h|help' => \$help,
143 'version' => \$help
144) or help(1);
145
146help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700147
Joe Perches9624b8d2014-01-23 15:54:44 -0800148$fix = 1 if ($fix_inplace);
149
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700150my $exit = 0;
151
Dave Hansend62a2012013-09-11 14:23:56 -0700152if ($^V && $^V lt $minimum_perl_version) {
153 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
154 if (!$ignore_perl_version) {
155 exit(1);
156 }
157}
158
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700159if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700160 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700161 exit(1);
162}
163
Joe Perches91bfe482013-09-11 14:23:59 -0700164sub hash_save_array_words {
165 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700166
Joe Perches91bfe482013-09-11 14:23:59 -0700167 my @array = split(/,/, join(',', @$arrayRef));
168 foreach my $word (@array) {
169 $word =~ s/\s*\n?$//g;
170 $word =~ s/^\s*//g;
171 $word =~ s/\s+/ /g;
172 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700173
Joe Perches91bfe482013-09-11 14:23:59 -0700174 next if ($word =~ m/^\s*#/);
175 next if ($word =~ m/^\s*$/);
176
177 $hashRef->{$word}++;
178 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700179}
180
Joe Perches91bfe482013-09-11 14:23:59 -0700181sub hash_show_words {
182 my ($hashRef, $prefix) = @_;
183
Joe Perches58cb3cf2013-09-11 14:24:04 -0700184 if ($quiet == 0 && keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700185 print "NOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700186 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700187 print " $word";
188 }
189 print "\n\n";
190 }
191}
192
193hash_save_array_words(\%ignore_type, \@ignore);
194hash_save_array_words(\%use_type, \@use);
195
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800196my $dbg_values = 0;
197my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700198my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700199my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800200for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800201 ## no critic
202 eval "\${dbg_$key} = '$debug{$key}';";
203 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800204}
205
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700206my $rpt_cleaners = 0;
207
Andy Whitcroft8905a672007-11-28 16:21:06 -0800208if ($terse) {
209 $emacs = 1;
210 $quiet++;
211}
212
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700213if ($tree) {
214 if (defined $root) {
215 if (!top_of_kernel_tree($root)) {
216 die "$P: $root: --root does not point at a valid tree\n";
217 }
218 } else {
219 if (top_of_kernel_tree('.')) {
220 $root = '.';
221 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
222 top_of_kernel_tree($1)) {
223 $root = $1;
224 }
225 }
226
227 if (!defined $root) {
228 print "Must be run from the top-level dir. of a kernel tree\n";
229 exit(2);
230 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700231}
232
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700233my $emitted_corrupt = 0;
234
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700235our $Ident = qr{
236 [A-Za-z_][A-Za-z\d_]*
237 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
238 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700239our $Storage = qr{extern|static|asmlinkage};
240our $Sparse = qr{
241 __user|
242 __kernel|
243 __force|
244 __iomem|
245 __must_check|
246 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800247 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700248 __ref|
249 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700250 }x;
Joe Perchese970b882013-11-12 15:10:10 -0800251our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
252our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
253our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
254our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
255our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700256
Wolfram Sang52131292010-03-05 13:43:51 -0800257# Notes to $Attribute:
258# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700259our $Attribute = qr{
260 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700261 __percpu|
262 __nocast|
263 __safe|
264 __bitwise__|
265 __packed__|
266 __packed2__|
267 __naked|
268 __maybe_unused|
269 __always_unused|
270 __noreturn|
271 __used|
272 __cold|
273 __noclone|
274 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700275 __read_mostly|
276 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700277 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700278 ____cacheline_aligned|
279 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800280 ____cacheline_internodealigned_in_smp|
281 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700282 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700283our $Modifier;
Joe Perches91cb5192014-04-03 14:49:32 -0700284our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700285our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
286our $Lval = qr{$Ident(?:$Member)*};
287
Joe Perches95e2c602013-07-03 15:05:20 -0700288our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
289our $Binary = qr{(?i)0b[01]+$Int_type?};
290our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
291our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700292our $Octal = qr{0[0-7]+$Int_type?};
Joe Perches326b1ff2013-02-04 14:28:51 -0800293our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
294our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
295our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800296our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700297our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800298our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700299our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700300our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700301our $Operators = qr{
302 <=|>=|==|!=|
303 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700304 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700305 }x;
306
Joe Perches91cb5192014-04-03 14:49:32 -0700307our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x;
308
Andy Whitcroft8905a672007-11-28 16:21:06 -0800309our $NonptrType;
Joe Perches8716de32013-09-11 14:24:05 -0700310our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800311our $Type;
312our $Declare;
313
Joe Perches15662b32011-10-31 17:13:12 -0700314our $NON_ASCII_UTF8 = qr{
315 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700316 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
317 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
318 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
319 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
320 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
321 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
322}x;
323
Joe Perches15662b32011-10-31 17:13:12 -0700324our $UTF8 = qr{
325 [\x09\x0A\x0D\x20-\x7E] # ASCII
326 | $NON_ASCII_UTF8
327}x;
328
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700329our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700330 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700331 atomic_t
332)};
333
Joe Perches691e6692010-03-05 13:43:51 -0800334our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700335 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700336 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches6e60c022011-07-25 17:13:27 -0700337 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700338 panic|
Joe Perches06668722013-11-12 15:10:07 -0800339 MODULE_[A-Z_]+|
340 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800341)};
342
Joe Perches20112472011-07-25 17:13:23 -0700343our $signature_tags = qr{(?xi:
344 Signed-off-by:|
345 Acked-by:|
346 Tested-by:|
347 Reviewed-by:|
348 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700349 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700350 To:|
351 Cc:
352)};
353
Andy Whitcroft8905a672007-11-28 16:21:06 -0800354our @typeList = (
355 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700356 qr{(?:unsigned\s+)?char},
357 qr{(?:unsigned\s+)?short},
358 qr{(?:unsigned\s+)?int},
359 qr{(?:unsigned\s+)?long},
360 qr{(?:unsigned\s+)?long\s+int},
361 qr{(?:unsigned\s+)?long\s+long},
362 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800363 qr{unsigned},
364 qr{float},
365 qr{double},
366 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800367 qr{struct\s+$Ident},
368 qr{union\s+$Ident},
369 qr{enum\s+$Ident},
370 qr{${Ident}_t},
371 qr{${Ident}_handler},
372 qr{${Ident}_handler_fn},
373);
Joe Perches8716de32013-09-11 14:24:05 -0700374our @typeListWithAttr = (
375 @typeList,
376 qr{struct\s+$InitAttribute\s+$Ident},
377 qr{union\s+$InitAttribute\s+$Ident},
378);
379
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700380our @modifierList = (
381 qr{fastcall},
382);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800383
Joe Perches24358802014-04-03 14:49:13 -0700384our @mode_permission_funcs = (
385 ["module_param", 3],
386 ["module_param_(?:array|named|string)", 4],
387 ["module_param_array_named", 5],
388 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
389 ["proc_create(?:_data|)", 2],
390 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
391);
392
Joe Perches515a2352014-04-03 14:49:24 -0700393#Create a search pattern for all these functions to speed up a loop below
394our $mode_perms_search = "";
395foreach my $entry (@mode_permission_funcs) {
396 $mode_perms_search .= '|' if ($mode_perms_search ne "");
397 $mode_perms_search .= $entry->[0];
398}
399
Wolfram Sang7840a942010-08-09 17:20:57 -0700400our $allowed_asm_includes = qr{(?x:
401 irq|
402 memory
403)};
404# memory.h: ARM has a custom one
405
Andy Whitcroft8905a672007-11-28 16:21:06 -0800406sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700407 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
408 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700409 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700410 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800411 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700412 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800413 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800414 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700415 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700416 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800417 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700418 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800419 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700420 $NonptrTypeWithAttr = qr{
421 (?:$Modifier\s+|const\s+)*
422 (?:
423 (?:typeof|__typeof__)\s*\([^\)]*\)|
424 (?:$typeTypedefs\b)|
425 (?:${allWithAttr}\b)
426 )
427 (?:\s+$Modifier|\s+const)*
428 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800429 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700430 $NonptrType
Andy Whitcroftb337d8b2012-03-23 15:02:18 -0700431 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700432 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800433 }x;
Joe Perches91cb5192014-04-03 14:49:32 -0700434 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800435}
436build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700437
Joe Perches7d2367a2011-07-25 17:13:22 -0700438our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700439
440# Using $balanced_parens, $LvalOrFunc, or $FuncArg
441# requires at least perl version v5.10.0
442# Any use must be runtime checked with $^V
443
444our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700445our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800446our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700447
448sub deparenthesize {
449 my ($string) = @_;
450 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700451
452 while ($string =~ /^\s*\(.*\)\s*$/) {
453 $string =~ s@^\s*\(\s*@@;
454 $string =~ s@\s*\)\s*$@@;
455 }
456
Joe Perches7d2367a2011-07-25 17:13:22 -0700457 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700458
Joe Perches7d2367a2011-07-25 17:13:22 -0700459 return $string;
460}
461
Joe Perches34456862013-07-03 15:05:34 -0700462sub seed_camelcase_file {
463 my ($file) = @_;
464
465 return if (!(-f $file));
466
467 local $/;
468
469 open(my $include_file, '<', "$file")
470 or warn "$P: Can't read '$file' $!\n";
471 my $text = <$include_file>;
472 close($include_file);
473
474 my @lines = split('\n', $text);
475
476 foreach my $line (@lines) {
477 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
478 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
479 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800480 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
481 $camelcase{$1} = 1;
482 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) {
Joe Perches34456862013-07-03 15:05:34 -0700483 $camelcase{$1} = 1;
484 }
485 }
486}
487
488my $camelcase_seeded = 0;
489sub seed_camelcase_includes {
490 return if ($camelcase_seeded);
491
492 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700493 my $camelcase_cache = "";
494 my @include_files = ();
495
496 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700497
Richard Genoud3645e322014-02-10 14:25:32 -0800498 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700499 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
500 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700501 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700502 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700503 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700504 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700505 @include_files = split('\n', $files);
506 foreach my $file (@include_files) {
507 my $date = POSIX::strftime("%Y%m%d%H%M",
508 localtime((stat $file)[9]));
509 $last_mod_date = $date if ($last_mod_date < $date);
510 }
511 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700512 }
Joe Perchesc707a812013-07-08 16:00:43 -0700513
514 if ($camelcase_cache ne "" && -f $camelcase_cache) {
515 open(my $camelcase_file, '<', "$camelcase_cache")
516 or warn "$P: Can't read '$camelcase_cache' $!\n";
517 while (<$camelcase_file>) {
518 chomp;
519 $camelcase{$_} = 1;
520 }
521 close($camelcase_file);
522
523 return;
524 }
525
Richard Genoud3645e322014-02-10 14:25:32 -0800526 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700527 $files = `git ls-files "include/*.h"`;
528 @include_files = split('\n', $files);
529 }
530
Joe Perches34456862013-07-03 15:05:34 -0700531 foreach my $file (@include_files) {
532 seed_camelcase_file($file);
533 }
Joe Perches351b2a12013-07-03 15:05:36 -0700534
Joe Perchesc707a812013-07-08 16:00:43 -0700535 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700536 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700537 open(my $camelcase_file, '>', "$camelcase_cache")
538 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700539 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
540 print $camelcase_file ("$_\n");
541 }
542 close($camelcase_file);
543 }
Joe Perches34456862013-07-03 15:05:34 -0700544}
545
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700546$chk_signoff = 0 if ($file);
547
Andy Whitcroft00df3442007-06-08 13:47:06 -0700548my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800549my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700550my @fixed = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800551my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700552for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800553 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700554 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800555 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700556 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800557 } elsif ($filename eq '-') {
558 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700559 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800560 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700561 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700562 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800563 if ($filename eq '-') {
564 $vname = 'Your patch';
565 } else {
566 $vname = $filename;
567 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800568 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700569 chomp;
570 push(@rawlines, $_);
571 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800572 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800573 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700574 $exit = 1;
575 }
576 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800577 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700578 @fixed = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700579}
580
581exit($exit);
582
583sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700584 my ($root) = @_;
585
586 my @tree_check = (
587 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
588 "README", "Documentation", "arch", "include", "drivers",
589 "fs", "init", "ipc", "kernel", "lib", "scripts",
590 );
591
592 foreach my $check (@tree_check) {
593 if (! -e $root . '/' . $check) {
594 return 0;
595 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700596 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700597 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700598}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700599
Joe Perches20112472011-07-25 17:13:23 -0700600sub parse_email {
601 my ($formatted_email) = @_;
602
603 my $name = "";
604 my $address = "";
605 my $comment = "";
606
607 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
608 $name = $1;
609 $address = $2;
610 $comment = $3 if defined $3;
611 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
612 $address = $1;
613 $comment = $2 if defined $2;
614 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
615 $address = $1;
616 $comment = $2 if defined $2;
617 $formatted_email =~ s/$address.*$//;
618 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700619 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700620 $name =~ s/^\"|\"$//g;
621 # If there's a name left after stripping spaces and
622 # leading quotes, and the address doesn't have both
623 # leading and trailing angle brackets, the address
624 # is invalid. ie:
625 # "joe smith joe@smith.com" bad
626 # "joe smith <joe@smith.com" bad
627 if ($name ne "" && $address !~ /^<[^>]+>$/) {
628 $name = "";
629 $address = "";
630 $comment = "";
631 }
632 }
633
Joe Perches3705ce52013-07-03 15:05:31 -0700634 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700635 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700636 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700637 $address =~ s/^\<|\>$//g;
638
639 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
640 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
641 $name = "\"$name\"";
642 }
643
644 return ($name, $address, $comment);
645}
646
647sub format_email {
648 my ($name, $address) = @_;
649
650 my $formatted_email;
651
Joe Perches3705ce52013-07-03 15:05:31 -0700652 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700653 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700654 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700655
656 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
657 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
658 $name = "\"$name\"";
659 }
660
661 if ("$name" eq "") {
662 $formatted_email = "$address";
663 } else {
664 $formatted_email = "$name <$address>";
665 }
666
667 return $formatted_email;
668}
669
Joe Perches000d1cc12011-07-25 17:13:25 -0700670sub which_conf {
671 my ($conf) = @_;
672
673 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
674 if (-e "$path/$conf") {
675 return "$path/$conf";
676 }
677 }
678
679 return "";
680}
681
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700682sub expand_tabs {
683 my ($str) = @_;
684
685 my $res = '';
686 my $n = 0;
687 for my $c (split(//, $str)) {
688 if ($c eq "\t") {
689 $res .= ' ';
690 $n++;
691 for (; ($n % 8) != 0; $n++) {
692 $res .= ' ';
693 }
694 next;
695 }
696 $res .= $c;
697 $n++;
698 }
699
700 return $res;
701}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700702sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700703 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700704 return $res;
705}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700706
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700707sub line_stats {
708 my ($line) = @_;
709
710 # Drop the diff line leader and expand tabs
711 $line =~ s/^.//;
712 $line = expand_tabs($line);
713
714 # Pick the indent from the front of the line.
715 my ($white) = ($line =~ /^(\s*)/);
716
717 return (length($line), length($white));
718}
719
Andy Whitcroft773647a2008-03-28 14:15:58 -0700720my $sanitise_quote = '';
721
722sub sanitise_line_reset {
723 my ($in_comment) = @_;
724
725 if ($in_comment) {
726 $sanitise_quote = '*/';
727 } else {
728 $sanitise_quote = '';
729 }
730}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700731sub sanitise_line {
732 my ($line) = @_;
733
734 my $res = '';
735 my $l = '';
736
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800737 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700738 my $off = 0;
739 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700740
Andy Whitcroft773647a2008-03-28 14:15:58 -0700741 # Always copy over the diff marker.
742 $res = substr($line, 0, 1);
743
744 for ($off = 1; $off < length($line); $off++) {
745 $c = substr($line, $off, 1);
746
747 # Comments we are wacking completly including the begin
748 # and end, all to $;.
749 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
750 $sanitise_quote = '*/';
751
752 substr($res, $off, 2, "$;$;");
753 $off++;
754 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800755 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700756 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700757 $sanitise_quote = '';
758 substr($res, $off, 2, "$;$;");
759 $off++;
760 next;
761 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700762 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
763 $sanitise_quote = '//';
764
765 substr($res, $off, 2, $sanitise_quote);
766 $off++;
767 next;
768 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700769
770 # A \ in a string means ignore the next character.
771 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
772 $c eq "\\") {
773 substr($res, $off, 2, 'XX');
774 $off++;
775 next;
776 }
777 # Regular quotes.
778 if ($c eq "'" || $c eq '"') {
779 if ($sanitise_quote eq '') {
780 $sanitise_quote = $c;
781
782 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700783 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700784 } elsif ($sanitise_quote eq $c) {
785 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700786 }
787 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700788
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800789 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700790 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
791 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700792 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
793 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700794 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
795 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700796 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700797 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700798 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800799 }
800
Daniel Walker113f04a2009-09-21 17:04:35 -0700801 if ($sanitise_quote eq '//') {
802 $sanitise_quote = '';
803 }
804
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800805 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700806 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800807 my $clean = 'X' x length($1);
808 $res =~ s@\<.*\>@<$clean>@;
809
810 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700811 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800812 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700813 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800814 }
815
Andy Whitcroft00df3442007-06-08 13:47:06 -0700816 return $res;
817}
818
Joe Perchesa6962d72013-04-29 16:18:13 -0700819sub get_quoted_string {
820 my ($line, $rawline) = @_;
821
822 return "" if ($line !~ m/(\"[X]+\")/g);
823 return substr($rawline, $-[0], $+[0] - $-[0]);
824}
825
Andy Whitcroft8905a672007-11-28 16:21:06 -0800826sub ctx_statement_block {
827 my ($linenr, $remain, $off) = @_;
828 my $line = $linenr - 1;
829 my $blk = '';
830 my $soff = $off;
831 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700832 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800833
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800834 my $loff = 0;
835
Andy Whitcroft8905a672007-11-28 16:21:06 -0800836 my $type = '';
837 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800838 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800839 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800840 my $c;
841 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800842
843 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800844 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800845 @stack = (['', 0]) if ($#stack == -1);
846
Andy Whitcroft773647a2008-03-28 14:15:58 -0700847 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800848 # If we are about to drop off the end, pull in more
849 # context.
850 if ($off >= $len) {
851 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700852 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800853 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800854 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800855 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800856 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800857 $len = length($blk);
858 $line++;
859 last;
860 }
861 # Bail if there is no further context.
862 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800863 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800864 last;
865 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800866 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
867 $level++;
868 $type = '#';
869 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800870 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800871 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800872 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800873 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800874
Andy Whitcroft773647a2008-03-28 14:15:58 -0700875 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800876
877 # Handle nested #if/#else.
878 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
879 push(@stack, [ $type, $level ]);
880 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
881 ($type, $level) = @{$stack[$#stack - 1]};
882 } elsif ($remainder =~ /^#\s*endif\b/) {
883 ($type, $level) = @{pop(@stack)};
884 }
885
Andy Whitcroft8905a672007-11-28 16:21:06 -0800886 # Statement ends at the ';' or a close '}' at the
887 # outermost level.
888 if ($level == 0 && $c eq ';') {
889 last;
890 }
891
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800892 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700893 if ($level == 0 && $coff_set == 0 &&
894 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
895 $remainder =~ /^(else)(?:\s|{)/ &&
896 $remainder !~ /^else\s+if\b/) {
897 $coff = $off + length($1) - 1;
898 $coff_set = 1;
899 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
900 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800901 }
902
Andy Whitcroft8905a672007-11-28 16:21:06 -0800903 if (($type eq '' || $type eq '(') && $c eq '(') {
904 $level++;
905 $type = '(';
906 }
907 if ($type eq '(' && $c eq ')') {
908 $level--;
909 $type = ($level != 0)? '(' : '';
910
911 if ($level == 0 && $coff < $soff) {
912 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700913 $coff_set = 1;
914 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800915 }
916 }
917 if (($type eq '' || $type eq '{') && $c eq '{') {
918 $level++;
919 $type = '{';
920 }
921 if ($type eq '{' && $c eq '}') {
922 $level--;
923 $type = ($level != 0)? '{' : '';
924
925 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700926 if (substr($blk, $off + 1, 1) eq ';') {
927 $off++;
928 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800929 last;
930 }
931 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800932 # Preprocessor commands end at the newline unless escaped.
933 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
934 $level--;
935 $type = '';
936 $off++;
937 last;
938 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800939 $off++;
940 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700941 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800942 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700943 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800944 $line++;
945 $remain--;
946 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800947
948 my $statement = substr($blk, $soff, $off - $soff + 1);
949 my $condition = substr($blk, $soff, $coff - $soff + 1);
950
951 #warn "STATEMENT<$statement>\n";
952 #warn "CONDITION<$condition>\n";
953
Andy Whitcroft773647a2008-03-28 14:15:58 -0700954 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800955
956 return ($statement, $condition,
957 $line, $remain + 1, $off - $loff + 1, $level);
958}
959
Andy Whitcroftcf655042008-03-04 14:28:20 -0800960sub statement_lines {
961 my ($stmt) = @_;
962
963 # Strip the diff line prefixes and rip blank lines at start and end.
964 $stmt =~ s/(^|\n)./$1/g;
965 $stmt =~ s/^\s*//;
966 $stmt =~ s/\s*$//;
967
968 my @stmt_lines = ($stmt =~ /\n/g);
969
970 return $#stmt_lines + 2;
971}
972
973sub statement_rawlines {
974 my ($stmt) = @_;
975
976 my @stmt_lines = ($stmt =~ /\n/g);
977
978 return $#stmt_lines + 2;
979}
980
981sub statement_block_size {
982 my ($stmt) = @_;
983
984 $stmt =~ s/(^|\n)./$1/g;
985 $stmt =~ s/^\s*{//;
986 $stmt =~ s/}\s*$//;
987 $stmt =~ s/^\s*//;
988 $stmt =~ s/\s*$//;
989
990 my @stmt_lines = ($stmt =~ /\n/g);
991 my @stmt_statements = ($stmt =~ /;/g);
992
993 my $stmt_lines = $#stmt_lines + 2;
994 my $stmt_statements = $#stmt_statements + 1;
995
996 if ($stmt_lines > $stmt_statements) {
997 return $stmt_lines;
998 } else {
999 return $stmt_statements;
1000 }
1001}
1002
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001003sub ctx_statement_full {
1004 my ($linenr, $remain, $off) = @_;
1005 my ($statement, $condition, $level);
1006
1007 my (@chunks);
1008
Andy Whitcroftcf655042008-03-04 14:28:20 -08001009 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001010 ($statement, $condition, $linenr, $remain, $off, $level) =
1011 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001012 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001013 push(@chunks, [ $condition, $statement ]);
1014 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1015 return ($level, $linenr, @chunks);
1016 }
1017
1018 # Pull in the following conditional/block pairs and see if they
1019 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001020 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001021 ($statement, $condition, $linenr, $remain, $off, $level) =
1022 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001023 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001024 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001025 #print "C: push\n";
1026 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001027 }
1028
1029 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001030}
1031
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001032sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001033 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001034 my $line;
1035 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001036 my $blk = '';
1037 my @o;
1038 my @c;
1039 my @res = ();
1040
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001041 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001042 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001043 for ($line = $start; $remain > 0; $line++) {
1044 next if ($rawlines[$line] =~ /^-/);
1045 $remain--;
1046
1047 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001048
1049 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001050 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001051 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001052 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001053 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001054 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001055 $level = pop(@stack);
1056 }
1057
Andy Whitcroft01464f32010-10-26 14:23:19 -07001058 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001059 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1060 if ($off > 0) {
1061 $off--;
1062 next;
1063 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001064
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001065 if ($c eq $close && $level > 0) {
1066 $level--;
1067 last if ($level == 0);
1068 } elsif ($c eq $open) {
1069 $level++;
1070 }
1071 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001072
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001073 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001074 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001075 }
1076
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001077 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001078 }
1079
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001080 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001081}
1082sub ctx_block_outer {
1083 my ($linenr, $remain) = @_;
1084
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001085 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1086 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001087}
1088sub ctx_block {
1089 my ($linenr, $remain) = @_;
1090
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001091 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1092 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001093}
1094sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001095 my ($linenr, $remain, $off) = @_;
1096
1097 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1098 return @r;
1099}
1100sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001101 my ($linenr, $remain) = @_;
1102
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001103 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001104}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001105sub ctx_statement_level {
1106 my ($linenr, $remain, $off) = @_;
1107
1108 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1109}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001110
1111sub ctx_locate_comment {
1112 my ($first_line, $end_line) = @_;
1113
1114 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001115 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001116 return $current_comment if (defined $current_comment);
1117
1118 # Look through the context and try and figure out if there is a
1119 # comment.
1120 my $in_comment = 0;
1121 $current_comment = '';
1122 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001123 my $line = $rawlines[$linenr - 1];
1124 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001125 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1126 $in_comment = 1;
1127 }
1128 if ($line =~ m@/\*@) {
1129 $in_comment = 1;
1130 }
1131 if (!$in_comment && $current_comment ne '') {
1132 $current_comment = '';
1133 }
1134 $current_comment .= $line . "\n" if ($in_comment);
1135 if ($line =~ m@\*/@) {
1136 $in_comment = 0;
1137 }
1138 }
1139
1140 chomp($current_comment);
1141 return($current_comment);
1142}
1143sub ctx_has_comment {
1144 my ($first_line, $end_line) = @_;
1145 my $cmt = ctx_locate_comment($first_line, $end_line);
1146
Andy Whitcroft00df3442007-06-08 13:47:06 -07001147 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001148 ##print "CMMT: $cmt\n";
1149
1150 return ($cmt ne '');
1151}
1152
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001153sub raw_line {
1154 my ($linenr, $cnt) = @_;
1155
1156 my $offset = $linenr - 1;
1157 $cnt++;
1158
1159 my $line;
1160 while ($cnt) {
1161 $line = $rawlines[$offset++];
1162 next if (defined($line) && $line =~ /^-/);
1163 $cnt--;
1164 }
1165
1166 return $line;
1167}
1168
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001169sub cat_vet {
1170 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001171 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001172
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001173 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001174 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1175 $res .= $1;
1176 if ($2 ne '') {
1177 $coded = sprintf("^%c", unpack('C', $2) + 64);
1178 $res .= $coded;
1179 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001180 }
1181 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001182
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001183 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001184}
1185
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001186my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001187my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001188my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001189my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001190
1191sub annotate_reset {
1192 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001193 $av_pending = '_';
1194 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001195 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001196}
1197
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001198sub annotate_values {
1199 my ($stream, $type) = @_;
1200
1201 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001202 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001203 my $cur = $stream;
1204
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001205 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001206
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001207 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001208 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001209 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001210 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001211 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001212 print "WS($1)\n" if ($dbg_values > 1);
1213 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001214 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001215 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001216 }
1217
Florian Micklerc023e4732011-01-12 16:59:58 -08001218 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001219 print "CAST($1)\n" if ($dbg_values > 1);
1220 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001221 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001222
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001223 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001224 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001225 $type = 'T';
1226
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001227 } elsif ($cur =~ /^($Modifier)\s*/) {
1228 print "MODIFIER($1)\n" if ($dbg_values > 1);
1229 $type = 'T';
1230
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001231 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001232 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001233 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001234 push(@av_paren_type, $type);
1235 if ($2 ne '') {
1236 $av_pending = 'N';
1237 }
1238 $type = 'E';
1239
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001240 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001241 print "UNDEF($1)\n" if ($dbg_values > 1);
1242 $av_preprocessor = 1;
1243 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001244
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001245 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001246 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001247 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001248
1249 push(@av_paren_type, $type);
1250 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001251 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001252
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001253 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001254 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1255 $av_preprocessor = 1;
1256
1257 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1258
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001259 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001260
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001261 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001262 print "PRE_END($1)\n" if ($dbg_values > 1);
1263
1264 $av_preprocessor = 1;
1265
1266 # Assume all arms of the conditional end as this
1267 # one does, and continue as if the #endif was not here.
1268 pop(@av_paren_type);
1269 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001270 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001271
1272 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001273 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001274
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001275 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1276 print "ATTR($1)\n" if ($dbg_values > 1);
1277 $av_pending = $type;
1278 $type = 'N';
1279
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001280 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001281 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001282 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001283 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001284 }
1285 $type = 'N';
1286
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001287 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001288 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001289 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001290 $type = 'N';
1291
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001292 } elsif ($cur =~/^(case)/o) {
1293 print "CASE($1)\n" if ($dbg_values > 1);
1294 $av_pend_colon = 'C';
1295 $type = 'N';
1296
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001297 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001298 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001299 $type = 'N';
1300
1301 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001302 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001303 push(@av_paren_type, $av_pending);
1304 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001305 $type = 'N';
1306
1307 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001308 my $new_type = pop(@av_paren_type);
1309 if ($new_type ne '_') {
1310 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001311 print "PAREN('$1') -> $type\n"
1312 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001313 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001314 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001315 }
1316
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001317 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001318 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001319 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001320 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001321
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001322 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1323 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001324 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001325 } elsif ($type eq 'E') {
1326 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001327 }
1328 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1329 $type = 'V';
1330
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001331 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001332 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001333 $type = 'V';
1334
1335 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001336 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001337 $type = 'N';
1338
Andy Whitcroftcf655042008-03-04 14:28:20 -08001339 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001340 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001341 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001342 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001343
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001344 } elsif ($cur =~/^(,)/) {
1345 print "COMMA($1)\n" if ($dbg_values > 1);
1346 $type = 'C';
1347
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001348 } elsif ($cur =~ /^(\?)/o) {
1349 print "QUESTION($1)\n" if ($dbg_values > 1);
1350 $type = 'N';
1351
1352 } elsif ($cur =~ /^(:)/o) {
1353 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1354
1355 substr($var, length($res), 1, $av_pend_colon);
1356 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1357 $type = 'E';
1358 } else {
1359 $type = 'N';
1360 }
1361 $av_pend_colon = 'O';
1362
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001363 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001364 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001365 $type = 'N';
1366
Andy Whitcroft0d413862008-10-15 22:02:16 -07001367 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001368 my $variant;
1369
1370 print "OPV($1)\n" if ($dbg_values > 1);
1371 if ($type eq 'V') {
1372 $variant = 'B';
1373 } else {
1374 $variant = 'U';
1375 }
1376
1377 substr($var, length($res), 1, $variant);
1378 $type = 'N';
1379
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001380 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001381 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001382 if ($1 ne '++' && $1 ne '--') {
1383 $type = 'N';
1384 }
1385
1386 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001387 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001388 }
1389 if (defined $1) {
1390 $cur = substr($cur, length($1));
1391 $res .= $type x length($1);
1392 }
1393 }
1394
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001395 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001396}
1397
Andy Whitcroft8905a672007-11-28 16:21:06 -08001398sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001399 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001400 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001401 ^(?:
1402 $Modifier|
1403 $Storage|
1404 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001405 DEFINE_\S+
1406 )$|
1407 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001408 goto|
1409 return|
1410 case|
1411 else|
1412 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001413 do|
1414 \#|
1415 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001416 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001417 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001418 )}x;
1419 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1420 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001421 # Check for modifiers.
1422 $possible =~ s/\s*$Storage\s*//g;
1423 $possible =~ s/\s*$Sparse\s*//g;
1424 if ($possible =~ /^\s*$/) {
1425
1426 } elsif ($possible =~ /\s/) {
1427 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001428 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001429 if ($modifier !~ $notPermitted) {
1430 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1431 push(@modifierList, $modifier);
1432 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001433 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001434
1435 } else {
1436 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1437 push(@typeList, $possible);
1438 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001439 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001440 } else {
1441 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001442 }
1443}
1444
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001445my $prefix = '';
1446
Joe Perches000d1cc12011-07-25 17:13:25 -07001447sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001448 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001449
Joe Perchescbec18a2014-04-03 14:49:19 -07001450 return defined $use_type{$type} if (scalar keys %use_type > 0);
1451
1452 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001453}
1454
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001455sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001456 my ($level, $type, $msg) = @_;
1457
1458 if (!show_type($type) ||
1459 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001460 return 0;
1461 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001462 my $line;
1463 if ($show_types) {
Joe Perchescbec18a2014-04-03 14:49:19 -07001464 $line = "$prefix$level:$type: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001465 } else {
Joe Perchescbec18a2014-04-03 14:49:19 -07001466 $line = "$prefix$level: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001467 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001468 $line = (split('\n', $line))[0] . "\n" if ($terse);
1469
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001470 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001471
1472 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001473}
Joe Perchescbec18a2014-04-03 14:49:19 -07001474
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001475sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001476 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001477}
Joe Perches000d1cc12011-07-25 17:13:25 -07001478
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001479sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001480 my ($type, $msg) = @_;
1481
1482 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001483 our $clean = 0;
1484 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001485 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001486 }
Joe Perches3705ce52013-07-03 15:05:31 -07001487 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001488}
1489sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001490 my ($type, $msg) = @_;
1491
1492 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001493 our $clean = 0;
1494 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001495 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001496 }
Joe Perches3705ce52013-07-03 15:05:31 -07001497 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001498}
1499sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001500 my ($type, $msg) = @_;
1501
1502 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001503 our $clean = 0;
1504 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001505 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001506 }
Joe Perches3705ce52013-07-03 15:05:31 -07001507 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001508}
1509
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001510sub check_absolute_file {
1511 my ($absolute, $herecurr) = @_;
1512 my $file = $absolute;
1513
1514 ##print "absolute<$absolute>\n";
1515
1516 # See if any suffix of this path is a path within the tree.
1517 while ($file =~ s@^[^/]*/@@) {
1518 if (-f "$root/$file") {
1519 ##print "file<$file>\n";
1520 last;
1521 }
1522 }
1523 if (! -f _) {
1524 return 0;
1525 }
1526
1527 # It is, so see if the prefix is acceptable.
1528 my $prefix = $absolute;
1529 substr($prefix, -length($file)) = '';
1530
1531 ##print "prefix<$prefix>\n";
1532 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001533 WARN("USE_RELATIVE_PATH",
1534 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001535 }
1536}
1537
Joe Perches3705ce52013-07-03 15:05:31 -07001538sub trim {
1539 my ($string) = @_;
1540
Joe Perchesb34c6482013-09-11 14:24:01 -07001541 $string =~ s/^\s+|\s+$//g;
1542
1543 return $string;
1544}
1545
1546sub ltrim {
1547 my ($string) = @_;
1548
1549 $string =~ s/^\s+//;
1550
1551 return $string;
1552}
1553
1554sub rtrim {
1555 my ($string) = @_;
1556
1557 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001558
1559 return $string;
1560}
1561
Joe Perches52ea8502013-11-12 15:10:09 -08001562sub string_find_replace {
1563 my ($string, $find, $replace) = @_;
1564
1565 $string =~ s/$find/$replace/g;
1566
1567 return $string;
1568}
1569
Joe Perches3705ce52013-07-03 15:05:31 -07001570sub tabify {
1571 my ($leading) = @_;
1572
1573 my $source_indent = 8;
1574 my $max_spaces_before_tab = $source_indent - 1;
1575 my $spaces_to_tab = " " x $source_indent;
1576
1577 #convert leading spaces to tabs
1578 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1579 #Remove spaces before a tab
1580 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1581
1582 return "$leading";
1583}
1584
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001585sub pos_last_openparen {
1586 my ($line) = @_;
1587
1588 my $pos = 0;
1589
1590 my $opens = $line =~ tr/\(/\(/;
1591 my $closes = $line =~ tr/\)/\)/;
1592
1593 my $last_openparen = 0;
1594
1595 if (($opens == 0) || ($closes >= $opens)) {
1596 return -1;
1597 }
1598
1599 my $len = length($line);
1600
1601 for ($pos = 0; $pos < $len; $pos++) {
1602 my $string = substr($line, $pos);
1603 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1604 $pos += length($1) - 1;
1605 } elsif (substr($line, $pos, 1) eq '(') {
1606 $last_openparen = $pos;
1607 } elsif (index($string, '(') == -1) {
1608 last;
1609 }
1610 }
1611
Joe Perches91cb5192014-04-03 14:49:32 -07001612 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001613}
1614
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001615sub process {
1616 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001617
1618 my $linenr=0;
1619 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001620 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001621 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001622 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001623
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001624 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001625 my $indent;
1626 my $previndent=0;
1627 my $stashindent=0;
1628
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001629 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001630 my $signoff = 0;
1631 my $is_patch = 0;
1632
Joe Perches15662b32011-10-31 17:13:12 -07001633 my $in_header_lines = 1;
1634 my $in_commit_log = 0; #Scanning lines before patch
1635
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001636 my $non_utf8_charset = 0;
1637
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001638 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001639 our $cnt_lines = 0;
1640 our $cnt_error = 0;
1641 our $cnt_warn = 0;
1642 our $cnt_chk = 0;
1643
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001644 # Trace the real file/line as we go.
1645 my $realfile = '';
1646 my $realline = 0;
1647 my $realcnt = 0;
1648 my $here = '';
1649 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001650 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001651 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001652 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001653
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001654 my $prev_values = 'E';
1655
1656 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001657 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001658 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001659 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001660 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001661
Joe Perches7e51f192013-09-11 14:23:57 -07001662 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001663
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001664 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001665 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001666 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001667 my @setup_docs = ();
1668 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001669
Joe Perchesd8b07712013-11-12 15:10:06 -08001670 my $camelcase_file_seeded = 0;
1671
Andy Whitcroft773647a2008-03-28 14:15:58 -07001672 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001673 my $line;
1674 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001675 $linenr++;
1676 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001677
Joe Perches3705ce52013-07-03 15:05:31 -07001678 push(@fixed, $rawline) if ($fix);
1679
Andy Whitcroft773647a2008-03-28 14:15:58 -07001680 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001681 $setup_docs = 0;
1682 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1683 $setup_docs = 1;
1684 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001685 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001686 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001687 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1688 $realline=$1-1;
1689 if (defined $2) {
1690 $realcnt=$3+1;
1691 } else {
1692 $realcnt=1+1;
1693 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001694 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001695
1696 # Guestimate if this is a continuing comment. Run
1697 # the context looking for a comment "edge". If this
1698 # edge is a close comment then we must be in a comment
1699 # at context start.
1700 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001701 my $cnt = $realcnt;
1702 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1703 next if (defined $rawlines[$ln - 1] &&
1704 $rawlines[$ln - 1] =~ /^-/);
1705 $cnt--;
1706 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001707 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001708 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1709 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1710 ($edge) = $1;
1711 last;
1712 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001713 }
1714 if (defined $edge && $edge eq '*/') {
1715 $in_comment = 1;
1716 }
1717
1718 # Guestimate if this is a continuing comment. If this
1719 # is the start of a diff block and this line starts
1720 # ' *' then it is very likely a comment.
1721 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001722 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001723 {
1724 $in_comment = 1;
1725 }
1726
1727 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1728 sanitise_line_reset($in_comment);
1729
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001730 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001731 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001732 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001733 $line = sanitise_line($rawline);
1734 }
1735 push(@lines, $line);
1736
1737 if ($realcnt > 1) {
1738 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1739 } else {
1740 $realcnt = 0;
1741 }
1742
1743 #print "==>$rawline\n";
1744 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001745
1746 if ($setup_docs && $line =~ /^\+/) {
1747 push(@setup_docs, $line);
1748 }
1749 }
1750
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001751 $prefix = '';
1752
Andy Whitcroft773647a2008-03-28 14:15:58 -07001753 $realcnt = 0;
1754 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001755 foreach my $line (@lines) {
1756 $linenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001757 my $sline = $line; #copy of $line
1758 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001759
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001760 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001761
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001762#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001763 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001764 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001765 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001766 $realline=$1-1;
1767 if (defined $2) {
1768 $realcnt=$3+1;
1769 } else {
1770 $realcnt=1+1;
1771 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001772 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001773 $prev_values = 'E';
1774
Andy Whitcroft773647a2008-03-28 14:15:58 -07001775 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001776 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001777 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001778 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001779 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001780
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001781# track the line number as we move through the hunk, note that
1782# new versions of GNU diff omit the leading space on completely
1783# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001784 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001785 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001786 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001787
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001788 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001789 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001790
1791 # Track the previous line.
1792 ($prevline, $stashline) = ($stashline, $line);
1793 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001794 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1795
Andy Whitcroft773647a2008-03-28 14:15:58 -07001796 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001797
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001798 } elsif ($realcnt == 1) {
1799 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001800 }
1801
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001802 my $hunk_line = ($realcnt != 0);
1803
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001804#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001805 $prefix = "$filename:$realline: " if ($emacs && $file);
1806 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1807
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001808 $here = "#$linenr: " if (!$file);
1809 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001810
1811 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001812 if ($line =~ /^diff --git.*?(\S+)$/) {
1813 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001814 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001815 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001816 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001817 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001818 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001819 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001820
1821 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001822 if (!$file && $tree && $p1_prefix ne '' &&
1823 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001824 WARN("PATCH_PREFIX",
1825 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001826 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001827
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001828 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001829 ERROR("MODIFIED_INCLUDE_ASM",
1830 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
Andy Whitcroft773647a2008-03-28 14:15:58 -07001831 }
1832 next;
1833 }
1834
Randy Dunlap389834b2007-06-08 13:47:03 -07001835 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001836
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001837 my $hereline = "$here\n$rawline\n";
1838 my $herecurr = "$here\n$rawline\n";
1839 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001840
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001841 $cnt_lines++ if ($realcnt != 0);
1842
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001843# Check for incorrect file permissions
1844 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1845 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001846 if ($realfile !~ m@scripts/@ &&
1847 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001848 ERROR("EXECUTE_PERMISSIONS",
1849 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001850 }
1851 }
1852
Joe Perches20112472011-07-25 17:13:23 -07001853# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001854 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001855 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001856 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001857 }
1858
1859# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001860 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001861 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001862 my $space_before = $1;
1863 my $sign_off = $2;
1864 my $space_after = $3;
1865 my $email = $4;
1866 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1867
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001868 if ($sign_off !~ /$signature_tags/) {
1869 WARN("BAD_SIGN_OFF",
1870 "Non-standard signature: $sign_off\n" . $herecurr);
1871 }
Joe Perches20112472011-07-25 17:13:23 -07001872 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07001873 if (WARN("BAD_SIGN_OFF",
1874 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1875 $fix) {
1876 $fixed[$linenr - 1] =
1877 "$ucfirst_sign_off $email";
1878 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001879 }
Joe Perches20112472011-07-25 17:13:23 -07001880 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07001881 if (WARN("BAD_SIGN_OFF",
1882 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1883 $fix) {
1884 $fixed[$linenr - 1] =
1885 "$ucfirst_sign_off $email";
1886 }
1887
Joe Perches20112472011-07-25 17:13:23 -07001888 }
1889 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07001890 if (WARN("BAD_SIGN_OFF",
1891 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1892 $fix) {
1893 $fixed[$linenr - 1] =
1894 "$ucfirst_sign_off $email";
1895 }
Joe Perches20112472011-07-25 17:13:23 -07001896 }
1897
1898 my ($email_name, $email_address, $comment) = parse_email($email);
1899 my $suggested_email = format_email(($email_name, $email_address));
1900 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001901 ERROR("BAD_SIGN_OFF",
1902 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001903 } else {
1904 my $dequoted = $suggested_email;
1905 $dequoted =~ s/^"//;
1906 $dequoted =~ s/" </ </;
1907 # Don't force email to have quotes
1908 # Allow just an angle bracketed address
1909 if ("$dequoted$comment" ne $email &&
1910 "<$email_address>$comment" ne $email &&
1911 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001912 WARN("BAD_SIGN_OFF",
1913 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001914 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001915 }
Joe Perches7e51f192013-09-11 14:23:57 -07001916
1917# Check for duplicate signatures
1918 my $sig_nospace = $line;
1919 $sig_nospace =~ s/\s//g;
1920 $sig_nospace = lc($sig_nospace);
1921 if (defined $signatures{$sig_nospace}) {
1922 WARN("BAD_SIGN_OFF",
1923 "Duplicate signature\n" . $herecurr);
1924 } else {
1925 $signatures{$sig_nospace} = 1;
1926 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001927 }
1928
Christopher Covington7ebd05e2014-04-03 14:49:31 -07001929# Check for unwanted Gerrit info
1930 if ($in_commit_log && $line =~ /^\s*change-id:/i) {
1931 ERROR("GERRIT_CHANGE_ID",
1932 "Remove Gerrit Change-Id's before submitting upstream.\n" . $herecurr);
1933 }
1934
Andy Whitcroft00df3442007-06-08 13:47:06 -07001935# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001936 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001937 ERROR("CORRUPTED_PATCH",
1938 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001939 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001940 }
1941
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001942# Check for absolute kernel paths.
1943 if ($tree) {
1944 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1945 my $file = $1;
1946
1947 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1948 check_absolute_file($1, $herecurr)) {
1949 #
1950 } else {
1951 check_absolute_file($file, $herecurr);
1952 }
1953 }
1954 }
1955
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001956# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1957 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001958 $rawline !~ m/^$UTF8*$/) {
1959 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1960
1961 my $blank = copy_spacing($rawline);
1962 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1963 my $hereptr = "$hereline$ptr\n";
1964
Joe Perches34d99212011-07-25 17:13:26 -07001965 CHK("INVALID_UTF8",
1966 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001967 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001968
Joe Perches15662b32011-10-31 17:13:12 -07001969# Check if it's the start of a commit log
1970# (not a header line and we haven't seen the patch filename)
1971 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001972 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001973 $in_header_lines = 0;
1974 $in_commit_log = 1;
1975 }
1976
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001977# Check if there is UTF-8 in a commit log when a mail header has explicitly
1978# declined it, i.e defined some charset where it is missing.
1979 if ($in_header_lines &&
1980 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1981 $1 !~ /utf-8/i) {
1982 $non_utf8_charset = 1;
1983 }
1984
1985 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001986 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001987 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001988 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1989 }
1990
Andy Whitcroft306708542008-10-15 22:02:28 -07001991# ignore non-hunk lines and lines being removed
1992 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001993
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001994#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001995 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001996 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07001997 if (ERROR("DOS_LINE_ENDINGS",
1998 "DOS line endings\n" . $herevet) &&
1999 $fix) {
2000 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
2001 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002002 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
2003 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002004 if (ERROR("TRAILING_WHITESPACE",
2005 "trailing whitespace\n" . $herevet) &&
2006 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002007 $fixed[$linenr - 1] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002008 }
2009
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002010 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002011 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002012
Josh Triplett4783f892013-11-12 15:10:12 -08002013# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002014 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002015 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2016 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002017 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2018 my $msg_type = \&ERROR;
2019 $msg_type = \&CHK if ($file);
2020 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002021 "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet)
Josh Triplett4783f892013-11-12 15:10:12 -08002022 }
2023
Andi Kleen33549572010-05-24 14:33:29 -07002024# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002025# Only applies when adding the entry originally, after that we do not have
2026# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002027 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08002028 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002029 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002030 my $cnt = $realcnt;
2031 my $ln = $linenr + 1;
2032 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002033 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002034 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002035 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002036 $f = $lines[$ln - 1];
2037 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2038 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002039
2040 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002041
2042 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
2043 $is_start = 1;
2044 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
2045 $length = -1;
2046 }
2047
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002048 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002049 $f =~ s/#.*//;
2050 $f =~ s/^\s+//;
2051 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002052 if ($f =~ /^\s*config\s/) {
2053 $is_end = 1;
2054 last;
2055 }
Andi Kleen33549572010-05-24 14:33:29 -07002056 $length++;
2057 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002058 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08002059 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2060 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002061 }
2062
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002063# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2064 if ($realfile =~ /Kconfig/ &&
2065 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2066 WARN("CONFIG_EXPERIMENTAL",
2067 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2068 }
2069
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002070 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2071 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2072 my $flag = $1;
2073 my $replacement = {
2074 'EXTRA_AFLAGS' => 'asflags-y',
2075 'EXTRA_CFLAGS' => 'ccflags-y',
2076 'EXTRA_CPPFLAGS' => 'cppflags-y',
2077 'EXTRA_LDFLAGS' => 'ldflags-y',
2078 };
2079
2080 WARN("DEPRECATED_VARIABLE",
2081 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2082 }
2083
Rob Herringbff5da42014-01-23 15:54:51 -08002084# check for DT compatible documentation
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002085 if (defined $root &&
2086 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2087 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2088
Rob Herringbff5da42014-01-23 15:54:51 -08002089 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2090
Florian Vaussardcc933192014-04-03 14:49:27 -07002091 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2092 my $vp_file = $dt_path . "vendor-prefixes.txt";
2093
Rob Herringbff5da42014-01-23 15:54:51 -08002094 foreach my $compat (@compats) {
2095 my $compat2 = $compat;
Rob Herring185d5662014-06-04 16:12:03 -07002096 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/;
2097 my $compat3 = $compat;
2098 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/;
2099 `grep -Erq "$compat|$compat2|$compat3" $dt_path`;
Rob Herringbff5da42014-01-23 15:54:51 -08002100 if ( $? >> 8 ) {
2101 WARN("UNDOCUMENTED_DT_STRING",
2102 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2103 }
2104
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002105 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2106 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002107 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002108 if ( $? >> 8 ) {
2109 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002110 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002111 }
2112 }
2113 }
2114
Andy Whitcroft5368df22008-10-15 22:02:27 -07002115# check we are in a valid source file if not then ignore this hunk
2116 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2117
Joe Perches6cd7f382012-12-17 16:01:54 -08002118#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002119 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002120 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002121 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002122 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002123 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002124 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002125 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002126 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002127 }
2128
Josh Triplettca56dc02012-03-23 15:02:21 -07002129# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002130# to grep for the string. Make exceptions when the previous string ends in a
2131# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2132# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002133 if ($line =~ /^\+\s*"/ &&
2134 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002135 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002136 WARN("SPLIT_STRING",
2137 "quoted string split across lines\n" . $hereprev);
2138 }
2139
Joe Perches5e79d962010-03-05 13:43:55 -08002140# check for spaces before a quoted newline
2141 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002142 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2143 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2144 $fix) {
2145 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2146 }
2147
Joe Perches5e79d962010-03-05 13:43:55 -08002148 }
2149
Andy Whitcroft8905a672007-11-28 16:21:06 -08002150# check for adding lines without a newline.
2151 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002152 WARN("MISSING_EOF_NEWLINE",
2153 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002154 }
2155
Mike Frysinger42e41c52009-09-21 17:04:40 -07002156# Blackfin: use hi/lo macros
2157 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2158 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2159 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002160 ERROR("LO_MACRO",
2161 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002162 }
2163 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2164 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002165 ERROR("HI_MACRO",
2166 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002167 }
2168 }
2169
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002170# check we are in a valid source file C or perl if not then ignore this hunk
2171 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002172
2173# at the beginning of a line any tabs must come first and anything
2174# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002175 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2176 $rawline =~ /^\+\s* \s*/) {
2177 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002178 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002179 if (ERROR("CODE_INDENT",
2180 "code indent should use tabs where possible\n" . $herevet) &&
2181 $fix) {
2182 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2183 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002184 }
2185
Alberto Panizzo08e44362010-03-05 13:43:54 -08002186# check for space before tabs.
2187 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2188 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002189 if (WARN("SPACE_BEFORE_TAB",
2190 "please, no space before tabs\n" . $herevet) &&
2191 $fix) {
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002192 while ($fixed[$linenr - 1] =~
2193 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2194 while ($fixed[$linenr - 1] =~
2195 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002196 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002197 }
2198
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002199# check for && or || at the start of a line
2200 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2201 CHK("LOGICAL_CONTINUATIONS",
2202 "Logical continuations should be on the previous line\n" . $hereprev);
2203 }
2204
2205# check multi-line statement indentation matches previous line
2206 if ($^V && $^V ge 5.10.0 &&
Joe Perches91cb5192014-04-03 14:49:32 -07002207 $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 -07002208 $prevline =~ /^\+(\t*)(.*)$/;
2209 my $oldindent = $1;
2210 my $rest = $2;
2211
2212 my $pos = pos_last_openparen($rest);
2213 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002214 $line =~ /^(\+| )([ \t]*)/;
2215 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002216
2217 my $goodtabindent = $oldindent .
2218 "\t" x ($pos / 8) .
2219 " " x ($pos % 8);
2220 my $goodspaceindent = $oldindent . " " x $pos;
2221
2222 if ($newindent ne $goodtabindent &&
2223 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002224
2225 if (CHK("PARENTHESIS_ALIGNMENT",
2226 "Alignment should match open parenthesis\n" . $hereprev) &&
2227 $fix && $line =~ /^\+/) {
2228 $fixed[$linenr - 1] =~
2229 s/^\+[ \t]*/\+$goodtabindent/;
2230 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002231 }
2232 }
2233 }
2234
Joe Perches23f780c2013-07-03 15:05:31 -07002235 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002236 if (CHK("SPACING",
2237 "No space is necessary after a cast\n" . $hereprev) &&
2238 $fix) {
2239 $fixed[$linenr - 1] =~
2240 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2241 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002242 }
2243
Joe Perches05880602012-10-04 17:13:35 -07002244 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002245 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002246 $rawline =~ /^\+[ \t]*\*/ &&
2247 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002248 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2249 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2250 }
2251
2252 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002253 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2254 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002255 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002256 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2257 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2258 "networking block comments start with * on subsequent lines\n" . $hereprev);
2259 }
2260
2261 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002262 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2263 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2264 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2265 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002266 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2267 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2268 }
2269
Joe Perches3b617e32014-04-03 14:49:28 -07002270# check for missing blank lines after declarations
2271 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2272 $prevline =~ /^\+\s+$Declare\s+$Ident/ &&
2273 !($prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2274 $prevline =~ /(?:\{\s*|\\)$/) && #extended lines
2275 $sline =~ /^\+\s+/ && #Not at char 1
2276 !($sline =~ /^\+\s+$Declare/ ||
2277 $sline =~ /^\+\s+$Ident\s+$Ident/ || #eg: typedef foo
2278 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2279 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(])/ ||
2280 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) {
2281 WARN("SPACING",
2282 "networking uses a blank line after declarations\n" . $hereprev);
2283 }
2284
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002285# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002286# Exceptions:
2287# 1) within comments
2288# 2) indented preprocessor commands
2289# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002290 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002291 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002292 if (WARN("LEADING_SPACE",
2293 "please, no spaces at the start of a line\n" . $herevet) &&
2294 $fix) {
2295 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2296 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002297 }
2298
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002299# check we are in a valid C source file if not then ignore this hunk
2300 next if ($realfile !~ /\.(h|c)$/);
2301
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002302# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2303 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2304 WARN("CONFIG_EXPERIMENTAL",
2305 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2306 }
2307
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002308# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002309 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002310 WARN("CVS_KEYWORD",
2311 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002312 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002313
Mike Frysinger42e41c52009-09-21 17:04:40 -07002314# Blackfin: don't use __builtin_bfin_[cs]sync
2315 if ($line =~ /__builtin_bfin_csync/) {
2316 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002317 ERROR("CSYNC",
2318 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002319 }
2320 if ($line =~ /__builtin_bfin_ssync/) {
2321 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002322 ERROR("SSYNC",
2323 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002324 }
2325
Joe Perches56e77d72013-02-21 16:44:14 -08002326# check for old HOTPLUG __dev<foo> section markings
2327 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2328 WARN("HOTPLUG_SECTION",
2329 "Using $1 is unnecessary\n" . $herecurr);
2330 }
2331
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002332# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002333 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2334 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002335#print "LINE<$line>\n";
2336 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002337 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002338 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002339 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002340 $stat =~ s/\n./\n /g;
2341 $cond =~ s/\n./\n /g;
2342
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002343#print "linenr<$linenr> <$stat>\n";
2344 # If this statement has no statement boundaries within
2345 # it there is no point in retrying a statement scan
2346 # until we hit end of it.
2347 my $frag = $stat; $frag =~ s/;+\s*$//;
2348 if ($frag !~ /(?:{|;)/) {
2349#print "skip<$line_nr_next>\n";
2350 $suppress_statement = $line_nr_next;
2351 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002352
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002353 # Find the real next line.
2354 $realline_next = $line_nr_next;
2355 if (defined $realline_next &&
2356 (!defined $lines[$realline_next - 1] ||
2357 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2358 $realline_next++;
2359 }
2360
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002361 my $s = $stat;
2362 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002363
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002364 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002365 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002366
2367 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002368 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002369
Andy Whitcroft463f2862009-09-21 17:04:34 -07002370 } elsif ($s =~ /^.\s*else\b/s) {
2371
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002372 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002373 } 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 -07002374 my $type = $1;
2375 $type =~ s/\s+/ /g;
2376 possible($type, "A:" . $s);
2377
Andy Whitcroft8905a672007-11-28 16:21:06 -08002378 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002379 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002380 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002381 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002382
2383 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002384 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002385 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002386 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002387
2388 # Check for any sort of function declaration.
2389 # int foo(something bar, other baz);
2390 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002391 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 -08002392 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002393
Andy Whitcroftcf655042008-03-04 14:28:20 -08002394 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002395 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002396 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002397
Andy Whitcroft8905a672007-11-28 16:21:06 -08002398 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002399 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002400
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002401 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002402 }
2403 }
2404 }
2405
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002406 }
2407
Andy Whitcroft653d4872007-06-23 17:16:34 -07002408#
2409# Checks which may be anchored in the context.
2410#
2411
2412# Check for switch () and associated case and default
2413# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002414 if ($line=~/\bswitch\s*\(.*\)/) {
2415 my $err = '';
2416 my $sep = '';
2417 my @ctx = ctx_block_outer($linenr, $realcnt);
2418 shift(@ctx);
2419 for my $ctx (@ctx) {
2420 my ($clen, $cindent) = line_stats($ctx);
2421 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2422 $indent != $cindent) {
2423 $err .= "$sep$ctx\n";
2424 $sep = '';
2425 } else {
2426 $sep = "[...]\n";
2427 }
2428 }
2429 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002430 ERROR("SWITCH_CASE_INDENT_LEVEL",
2431 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002432 }
2433 }
2434
2435# if/while/etc brace do not go on next line, unless defining a do while loop,
2436# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002437 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002438 my $pre_ctx = "$1$2";
2439
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002440 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002441
2442 if ($line =~ /^\+\t{6,}/) {
2443 WARN("DEEP_INDENTATION",
2444 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2445 }
2446
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002447 my $ctx_cnt = $realcnt - $#ctx - 1;
2448 my $ctx = join("\n", @ctx);
2449
Andy Whitcroft548596d2008-07-23 21:29:01 -07002450 my $ctx_ln = $linenr;
2451 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002452
Andy Whitcroft548596d2008-07-23 21:29:01 -07002453 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2454 defined $lines[$ctx_ln - 1] &&
2455 $lines[$ctx_ln - 1] =~ /^-/)) {
2456 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2457 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002458 $ctx_ln++;
2459 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002460
Andy Whitcroft53210162008-07-23 21:29:03 -07002461 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2462 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002463
2464 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002465 ERROR("OPEN_BRACE",
2466 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002467 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002468 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002469 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2470 $ctx =~ /\)\s*\;\s*$/ &&
2471 defined $lines[$ctx_ln - 1])
2472 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002473 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2474 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002475 WARN("TRAILING_SEMICOLON",
2476 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002477 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002478 }
2479 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002480 }
2481
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002482# Check relative indent for conditionals and blocks.
2483 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002484 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2485 ctx_statement_block($linenr, $realcnt, 0)
2486 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002487 my ($s, $c) = ($stat, $cond);
2488
2489 substr($s, 0, length($c), '');
2490
2491 # Make sure we remove the line prefixes as we have
2492 # none on the first line, and are going to readd them
2493 # where necessary.
2494 $s =~ s/\n./\n/gs;
2495
2496 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002497 my @newlines = ($c =~ /\n/gs);
2498 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002499
2500 # We want to check the first line inside the block
2501 # starting at the end of the conditional, so remove:
2502 # 1) any blank line termination
2503 # 2) any opening brace { on end of the line
2504 # 3) any do (...) {
2505 my $continuation = 0;
2506 my $check = 0;
2507 $s =~ s/^.*\bdo\b//;
2508 $s =~ s/^\s*{//;
2509 if ($s =~ s/^\s*\\//) {
2510 $continuation = 1;
2511 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002512 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002513 $check = 1;
2514 $cond_lines++;
2515 }
2516
2517 # Also ignore a loop construct at the end of a
2518 # preprocessor statement.
2519 if (($prevline =~ /^.\s*#\s*define\s/ ||
2520 $prevline =~ /\\\s*$/) && $continuation == 0) {
2521 $check = 0;
2522 }
2523
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002524 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002525 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002526 while ($cond_ptr != $cond_lines) {
2527 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002528
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002529 # If we see an #else/#elif then the code
2530 # is not linear.
2531 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2532 $check = 0;
2533 }
2534
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002535 # Ignore:
2536 # 1) blank lines, they should be at 0,
2537 # 2) preprocessor lines, and
2538 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002539 if ($continuation ||
2540 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002541 $s =~ /^\s*#\s*?/ ||
2542 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002543 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002544 if ($s =~ s/^.*?\n//) {
2545 $cond_lines++;
2546 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002547 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002548 }
2549
2550 my (undef, $sindent) = line_stats("+" . $s);
2551 my $stat_real = raw_line($linenr, $cond_lines);
2552
2553 # Check if either of these lines are modified, else
2554 # this is not this patch's fault.
2555 if (!defined($stat_real) ||
2556 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2557 $check = 0;
2558 }
2559 if (defined($stat_real) && $cond_lines > 1) {
2560 $stat_real = "[...]\n$stat_real";
2561 }
2562
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002563 #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 -07002564
2565 if ($check && (($sindent % 8) != 0 ||
2566 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002567 WARN("SUSPECT_CODE_INDENT",
2568 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002569 }
2570 }
2571
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002572 # Track the 'values' across context and added lines.
2573 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002574 my ($curr_values, $curr_vars) =
2575 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002576 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002577 if ($dbg_values) {
2578 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002579 print "$linenr > .$outline\n";
2580 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002581 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002582 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002583 $prev_values = substr($curr_values, -1);
2584
Andy Whitcroft00df3442007-06-08 13:47:06 -07002585#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002586 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002587
Andy Whitcroft653d4872007-06-23 17:16:34 -07002588# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002589 if ($dbg_type) {
2590 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002591 ERROR("TEST_TYPE",
2592 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002593 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002594 ERROR("TEST_NOT_TYPE",
2595 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002596 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002597 next;
2598 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002599# TEST: allow direct testing of the attribute matcher.
2600 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002601 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002602 ERROR("TEST_ATTR",
2603 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002604 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002605 ERROR("TEST_NOT_ATTR",
2606 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002607 }
2608 next;
2609 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002610
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002611# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002612 if ($line =~ /^.\s*{/ &&
2613 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002614 ERROR("OPEN_BRACE",
2615 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002616 }
2617
Andy Whitcroft653d4872007-06-23 17:16:34 -07002618#
2619# Checks which are anchored on the added line.
2620#
2621
2622# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002623 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002624 my $path = $1;
2625 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002626 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002627 "malformed #include filename\n" . $herecurr);
2628 }
2629 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2630 ERROR("UAPI_INCLUDE",
2631 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002632 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002633 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002634
2635# no C99 // comments
2636 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002637 if (ERROR("C99_COMMENTS",
2638 "do not use C99 // comments\n" . $herecurr) &&
2639 $fix) {
2640 my $line = $fixed[$linenr - 1];
2641 if ($line =~ /\/\/(.*)$/) {
2642 my $comment = trim($1);
2643 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2644 }
2645 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002646 }
2647 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002648 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002649 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002650
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002651# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2652# the whole statement.
2653#print "APW <$lines[$realline_next - 1]>\n";
2654 if (defined $realline_next &&
2655 exists $lines[$realline_next - 1] &&
2656 !defined $suppress_export{$realline_next} &&
2657 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2658 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002659 # Handle definitions which produce identifiers with
2660 # a prefix:
2661 # XXX(foo);
2662 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002663 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002664 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002665 $name =~ /^${Ident}_$2/) {
2666#print "FOO C name<$name>\n";
2667 $suppress_export{$realline_next} = 1;
2668
2669 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002670 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002671 ^.DEFINE_$Ident\(\Q$name\E\)|
2672 ^.DECLARE_$Ident\(\Q$name\E\)|
2673 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002674 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2675 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002676 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002677#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2678 $suppress_export{$realline_next} = 2;
2679 } else {
2680 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002681 }
2682 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002683 if (!defined $suppress_export{$linenr} &&
2684 $prevline =~ /^.\s*$/ &&
2685 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2686 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2687#print "FOO B <$lines[$linenr - 1]>\n";
2688 $suppress_export{$linenr} = 2;
2689 }
2690 if (defined $suppress_export{$linenr} &&
2691 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002692 WARN("EXPORT_SYMBOL",
2693 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002694 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002695
Joe Eloff5150bda2010-08-09 17:21:00 -07002696# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002697 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2698 if (ERROR("GLOBAL_INITIALISERS",
2699 "do not initialise globals to 0 or NULL\n" .
2700 $herecurr) &&
2701 $fix) {
2702 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2703 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002704 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002705# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002706 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2707 if (ERROR("INITIALISED_STATIC",
2708 "do not initialise statics to 0 or NULL\n" .
2709 $herecurr) &&
2710 $fix) {
2711 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2712 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002713 }
2714
Joe Perchescb710ec2010-10-26 14:23:20 -07002715# check for static const char * arrays.
2716 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002717 WARN("STATIC_CONST_CHAR_ARRAY",
2718 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002719 $herecurr);
2720 }
2721
2722# check for static char foo[] = "bar" declarations.
2723 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002724 WARN("STATIC_CONST_CHAR_ARRAY",
2725 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002726 $herecurr);
2727 }
2728
Joe Perches9b0fa602014-04-03 14:49:18 -07002729# check for non-global char *foo[] = {"bar", ...} declarations.
2730 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
2731 WARN("STATIC_CONST_CHAR_ARRAY",
2732 "char * array declaration might be better as static const\n" .
2733 $herecurr);
2734 }
2735
Joe Perchesb36190c2014-01-27 17:07:18 -08002736# check for function declarations without arguments like "int foo()"
2737 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2738 if (ERROR("FUNCTION_WITHOUT_ARGS",
2739 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2740 $fix) {
2741 $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2742 }
2743 }
2744
Joe Perches92e112f2013-12-13 11:36:22 -07002745# check for uses of DEFINE_PCI_DEVICE_TABLE
2746 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2747 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2748 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2749 $fix) {
2750 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2751 }
Joe Perches93ed0e22010-10-26 14:23:21 -07002752 }
2753
Andy Whitcroft653d4872007-06-23 17:16:34 -07002754# check for new typedefs, only function parameters and sparse annotations
2755# make sense.
2756 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002757 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002758 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002759 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002760 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002761 WARN("NEW_TYPEDEFS",
2762 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002763 }
2764
2765# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002766 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002767 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2768 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002769 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002770
Andy Whitcroft65863862009-01-06 14:41:21 -08002771 # Should start with a space.
2772 $to =~ s/^(\S)/ $1/;
2773 # Should not end with a space.
2774 $to =~ s/\s+$//;
2775 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002776 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002777 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002778
Joe Perches3705ce52013-07-03 15:05:31 -07002779## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08002780 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07002781 if (ERROR("POINTER_LOCATION",
2782 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2783 $fix) {
2784 my $sub_from = $ident;
2785 my $sub_to = $ident;
2786 $sub_to =~ s/\Q$from\E/$to/;
2787 $fixed[$linenr - 1] =~
2788 s@\Q$sub_from\E@$sub_to@;
2789 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002790 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002791 }
2792 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2793 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002794 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002795
Andy Whitcroft65863862009-01-06 14:41:21 -08002796 # Should start with a space.
2797 $to =~ s/^(\S)/ $1/;
2798 # Should not end with a space.
2799 $to =~ s/\s+$//;
2800 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002801 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002802 }
2803 # Modifiers should have spaces.
2804 $to =~ s/(\b$Modifier$)/$1 /;
2805
Joe Perches3705ce52013-07-03 15:05:31 -07002806## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08002807 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002808 if (ERROR("POINTER_LOCATION",
2809 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2810 $fix) {
2811
2812 my $sub_from = $match;
2813 my $sub_to = $match;
2814 $sub_to =~ s/\Q$from\E/$to/;
2815 $fixed[$linenr - 1] =~
2816 s@\Q$sub_from\E@$sub_to@;
2817 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002818 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002819 }
2820
2821# # no BUG() or BUG_ON()
2822# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2823# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2824# print "$herecurr";
2825# $clean = 0;
2826# }
2827
Andy Whitcroft8905a672007-11-28 16:21:06 -08002828 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002829 WARN("LINUX_VERSION_CODE",
2830 "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 -08002831 }
2832
Joe Perches17441222011-06-15 15:08:17 -07002833# check for uses of printk_ratelimit
2834 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002835 WARN("PRINTK_RATELIMITED",
2836"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002837 }
2838
Andy Whitcroft00df3442007-06-08 13:47:06 -07002839# printk should use KERN_* levels. Note that follow on printk's on the
2840# same line do not need a level, so we use the current block context
2841# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002842# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002843# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002844 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002845 my $ok = 0;
2846 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2847 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002848 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07002849 # with "\n" ignore it, else it is to blame
2850 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2851 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2852 $ok = 1;
2853 }
2854 last;
2855 }
2856 }
2857 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002858 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2859 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002860 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002861 }
2862
Joe Perches243f3802012-05-31 16:26:09 -07002863 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2864 my $orig = $1;
2865 my $level = lc($orig);
2866 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002867 my $level2 = $level;
2868 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002869 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07002870 "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 -07002871 }
2872
2873 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002874 if (WARN("PREFER_PR_LEVEL",
2875 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2876 $fix) {
2877 $fixed[$linenr - 1] =~
2878 s/\bpr_warning\b/pr_warn/;
2879 }
Joe Perches243f3802012-05-31 16:26:09 -07002880 }
2881
Joe Perchesdc139312013-02-21 16:44:13 -08002882 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2883 my $orig = $1;
2884 my $level = lc($orig);
2885 $level = "warn" if ($level eq "warning");
2886 $level = "dbg" if ($level eq "debug");
2887 WARN("PREFER_DEV_LEVEL",
2888 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2889 }
2890
Andy Whitcroft653d4872007-06-23 17:16:34 -07002891# function brace can't be on same line, except for #defines of do while,
2892# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002893 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2894 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002895 ERROR("OPEN_BRACE",
2896 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002897 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002898
Andy Whitcroft8905a672007-11-28 16:21:06 -08002899# open braces for enum, union and struct go on the same line.
2900 if ($line =~ /^.\s*{/ &&
2901 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002902 ERROR("OPEN_BRACE",
2903 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002904 }
2905
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002906# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07002907 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2908 if (WARN("SPACING",
2909 "missing space after $1 definition\n" . $herecurr) &&
2910 $fix) {
2911 $fixed[$linenr - 1] =~
2912 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2913 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002914 }
2915
Joe Perches31070b52014-01-23 15:54:49 -08002916# Function pointer declarations
2917# check spacing between type, funcptr, and args
2918# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002919 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08002920 my $declare = $1;
2921 my $pre_pointer_space = $2;
2922 my $post_pointer_space = $3;
2923 my $funcname = $4;
2924 my $post_funcname_space = $5;
2925 my $pre_args_space = $6;
2926
Joe Perches91f72e92014-04-03 14:49:12 -07002927# the $Declare variable will capture all spaces after the type
2928# so check it for a missing trailing missing space but pointer return types
2929# don't need a space so don't warn for those.
2930 my $post_declare_space = "";
2931 if ($declare =~ /(\s+)$/) {
2932 $post_declare_space = $1;
2933 $declare = rtrim($declare);
2934 }
2935 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08002936 WARN("SPACING",
2937 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07002938 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08002939 }
2940
2941# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002942# This test is not currently implemented because these declarations are
2943# equivalent to
2944# int foo(int bar, ...)
2945# and this is form shouldn't/doesn't generate a checkpatch warning.
2946#
2947# elsif ($declare =~ /\s{2,}$/) {
2948# WARN("SPACING",
2949# "Multiple spaces after return type\n" . $herecurr);
2950# }
Joe Perches31070b52014-01-23 15:54:49 -08002951
2952# unnecessary space "type ( *funcptr)(args...)"
2953 if (defined $pre_pointer_space &&
2954 $pre_pointer_space =~ /^\s/) {
2955 WARN("SPACING",
2956 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
2957 }
2958
2959# unnecessary space "type (* funcptr)(args...)"
2960 if (defined $post_pointer_space &&
2961 $post_pointer_space =~ /^\s/) {
2962 WARN("SPACING",
2963 "Unnecessary space before function pointer name\n" . $herecurr);
2964 }
2965
2966# unnecessary space "type (*funcptr )(args...)"
2967 if (defined $post_funcname_space &&
2968 $post_funcname_space =~ /^\s/) {
2969 WARN("SPACING",
2970 "Unnecessary space after function pointer name\n" . $herecurr);
2971 }
2972
2973# unnecessary space "type (*funcptr) (args...)"
2974 if (defined $pre_args_space &&
2975 $pre_args_space =~ /^\s/) {
2976 WARN("SPACING",
2977 "Unnecessary space before function pointer arguments\n" . $herecurr);
2978 }
2979
2980 if (show_type("SPACING") && $fix) {
2981 $fixed[$linenr - 1] =~
Joe Perches91f72e92014-04-03 14:49:12 -07002982 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08002983 }
2984 }
2985
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002986# check for spacing round square brackets; allowed:
2987# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002988# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2989# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002990 while ($line =~ /(.*?\s)\[/g) {
2991 my ($where, $prefix) = ($-[1], $1);
2992 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002993 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002994 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002995 if (ERROR("BRACKET_SPACE",
2996 "space prohibited before open square bracket '['\n" . $herecurr) &&
2997 $fix) {
2998 $fixed[$linenr - 1] =~
2999 s/^(\+.*?)\s+\[/$1\[/;
3000 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07003001 }
3002 }
3003
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003004# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003005 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003006 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003007 my $ctx_before = substr($line, 0, $-[1]);
3008 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003009
3010 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003011 if ($name =~ /^(?:
3012 if|for|while|switch|return|case|
3013 volatile|__volatile__|
3014 __attribute__|format|__extension__|
3015 asm|__asm__)$/x)
3016 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003017 # cpp #define statements have non-optional spaces, ie
3018 # if there is a space between the name and the open
3019 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003020 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003021
3022 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003023 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003024
3025 # If this whole things ends with a type its most
3026 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003027 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003028
3029 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003030 if (WARN("SPACING",
3031 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3032 $fix) {
3033 $fixed[$linenr - 1] =~
3034 s/\b$name\s+\(/$name\(/;
3035 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003036 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003037 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003038
Andy Whitcroft653d4872007-06-23 17:16:34 -07003039# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003040 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003041 my $fixed_line = "";
3042 my $line_fixed = 0;
3043
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003044 my $ops = qr{
3045 <<=|>>=|<=|>=|==|!=|
3046 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3047 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003048 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003049 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003050 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003051 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003052
3053## print("element count: <" . $#elements . ">\n");
3054## foreach my $el (@elements) {
3055## print("el: <$el>\n");
3056## }
3057
3058 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003059 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003060
Joe Perches3705ce52013-07-03 15:05:31 -07003061 foreach my $el (@elements) {
3062 push(@fix_elements, substr($rawline, $off, length($el)));
3063 $off += length($el);
3064 }
3065
3066 $off = 0;
3067
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003068 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003069 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003070
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003071 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003072
3073 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3074
3075## print("n: <$n> good: <$good>\n");
3076
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003077 $off += length($elements[$n]);
3078
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003079 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003080 my $ca = substr($opline, 0, $off);
3081 my $cc = '';
3082 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3083 $cc = substr($opline, $off + length($elements[$n + 1]));
3084 }
3085 my $cb = "$ca$;$cc";
3086
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003087 my $a = '';
3088 $a = 'V' if ($elements[$n] ne '');
3089 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003090 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003091 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3092 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003093 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003094
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003095 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003096
3097 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003098 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003099 $c = 'V' if ($elements[$n + 2] ne '');
3100 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003101 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003102 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3103 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003104 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003105 } else {
3106 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003107 }
3108
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003109 my $ctx = "${a}x${c}";
3110
3111 my $at = "(ctx:$ctx)";
3112
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003113 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003114 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003115
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003116 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003117 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003118
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003119 # Get the full operator variant.
3120 my $opv = $op . substr($curr_vars, $off, 1);
3121
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003122 # Ignore operators passed as parameters.
3123 if ($op_type ne 'V' &&
3124 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3125
Andy Whitcroftcf655042008-03-04 14:28:20 -08003126# # Ignore comments
3127# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003128
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003129 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003130 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003131 if ($ctx !~ /.x[WEBC]/ &&
3132 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003133 if (ERROR("SPACING",
3134 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003135 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003136 $line_fixed = 1;
3137 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003138 }
3139
3140 # // is a comment
3141 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003142
Joe Perchesb00e4812014-04-03 14:49:33 -07003143 # : when part of a bitfield
3144 } elsif ($opv eq ':B') {
3145 # skip the bitfield test for now
3146
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003147 # No spaces for:
3148 # ->
Joe Perchesb00e4812014-04-03 14:49:33 -07003149 } elsif ($op eq '->') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003150 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003151 if (ERROR("SPACING",
3152 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003153 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003154 if (defined $fix_elements[$n + 2]) {
3155 $fix_elements[$n + 2] =~ s/^\s+//;
3156 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003157 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003158 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003159 }
3160
3161 # , must have a space on the right.
3162 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003163 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003164 if (ERROR("SPACING",
3165 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003166 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003167 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003168 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07003169 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003170 }
3171
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003172 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003173 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003174 #warn "'*' is part of type\n";
3175
3176 # unary operators should have a space before and
3177 # none after. May be left adjacent to another
3178 # unary operator, or a cast
3179 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003180 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003181 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003182 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003183 if (ERROR("SPACING",
3184 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003185 if ($n != $last_after + 2) {
3186 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3187 $line_fixed = 1;
3188 }
Joe Perches3705ce52013-07-03 15:05:31 -07003189 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003190 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003191 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003192 # A unary '*' may be const
3193
3194 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003195 if (ERROR("SPACING",
3196 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003197 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003198 if (defined $fix_elements[$n + 2]) {
3199 $fix_elements[$n + 2] =~ s/^\s+//;
3200 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003201 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003202 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003203 }
3204
3205 # unary ++ and unary -- are allowed no space on one side.
3206 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003207 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003208 if (ERROR("SPACING",
3209 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003210 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003211 $line_fixed = 1;
3212 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003213 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003214 if ($ctx =~ /Wx[BE]/ ||
3215 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003216 if (ERROR("SPACING",
3217 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003218 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003219 $line_fixed = 1;
3220 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003221 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003222 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003223 if (ERROR("SPACING",
3224 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003225 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003226 if (defined $fix_elements[$n + 2]) {
3227 $fix_elements[$n + 2] =~ s/^\s+//;
3228 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003229 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003230 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003231 }
3232
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003233 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003234 } elsif ($op eq '<<' or $op eq '>>' or
3235 $op eq '&' or $op eq '^' or $op eq '|' or
3236 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003237 $op eq '*' or $op eq '/' or
3238 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003239 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003240 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003241 if (ERROR("SPACING",
3242 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003243 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3244 if (defined $fix_elements[$n + 2]) {
3245 $fix_elements[$n + 2] =~ s/^\s+//;
3246 }
Joe Perches3705ce52013-07-03 15:05:31 -07003247 $line_fixed = 1;
3248 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003249 }
3250
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003251 # A colon needs no spaces before when it is
3252 # terminating a case value or a label.
3253 } elsif ($opv eq ':C' || $opv eq ':L') {
3254 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003255 if (ERROR("SPACING",
3256 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003257 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003258 $line_fixed = 1;
3259 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003260 }
3261
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003262 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003263 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003264 my $ok = 0;
3265
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003266 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003267 if (($op eq '<' &&
3268 $cc =~ /^\S+\@\S+>/) ||
3269 ($op eq '>' &&
3270 $ca =~ /<\S+\@\S+$/))
3271 {
3272 $ok = 1;
3273 }
3274
Joe Perches84731622013-11-12 15:10:05 -08003275 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003276 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003277 my $msg_type = \&ERROR;
3278 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3279
3280 if (&{$msg_type}("SPACING",
3281 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003282 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3283 if (defined $fix_elements[$n + 2]) {
3284 $fix_elements[$n + 2] =~ s/^\s+//;
3285 }
Joe Perches3705ce52013-07-03 15:05:31 -07003286 $line_fixed = 1;
3287 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003288 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003289 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003290 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003291
3292## print("n: <$n> GOOD: <$good>\n");
3293
3294 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003295 }
Joe Perches3705ce52013-07-03 15:05:31 -07003296
3297 if (($#elements % 2) == 0) {
3298 $fixed_line = $fixed_line . $fix_elements[$#elements];
3299 }
3300
3301 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3302 $fixed[$linenr - 1] = $fixed_line;
3303 }
3304
3305
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003306 }
3307
Joe Perches786b6322013-07-03 15:05:32 -07003308# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003309 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003310 if (WARN("SPACING",
3311 "space prohibited before semicolon\n" . $herecurr) &&
3312 $fix) {
3313 1 while $fixed[$linenr - 1] =~
3314 s/^(\+.*\S)\s+;/$1;/;
3315 }
3316 }
3317
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003318# check for multiple assignments
3319 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003320 CHK("MULTIPLE_ASSIGNMENTS",
3321 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003322 }
3323
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003324## # check for multiple declarations, allowing for a function declaration
3325## # continuation.
3326## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3327## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3328##
3329## # Remove any bracketed sections to ensure we do not
3330## # falsly report the parameters of functions.
3331## my $ln = $line;
3332## while ($ln =~ s/\([^\(\)]*\)//g) {
3333## }
3334## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003335## WARN("MULTIPLE_DECLARATION",
3336## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003337## }
3338## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003339
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003340#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003341 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3342 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003343 if (ERROR("SPACING",
3344 "space required before the open brace '{'\n" . $herecurr) &&
3345 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003346 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003347 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003348 }
3349
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003350## # check for blank lines before declarations
3351## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3352## $prevrawline =~ /^.\s*$/) {
3353## WARN("SPACING",
3354## "No blank lines before declarations\n" . $hereprev);
3355## }
3356##
3357
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003358# closing brace should have a space following it when it has anything
3359# on the line
3360 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003361 if (ERROR("SPACING",
3362 "space required after that close brace '}'\n" . $herecurr) &&
3363 $fix) {
3364 $fixed[$linenr - 1] =~
3365 s/}((?!(?:,|;|\)))\S)/} $1/;
3366 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003367 }
3368
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003369# check spacing on square brackets
3370 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003371 if (ERROR("SPACING",
3372 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3373 $fix) {
3374 $fixed[$linenr - 1] =~
3375 s/\[\s+/\[/;
3376 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003377 }
3378 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003379 if (ERROR("SPACING",
3380 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3381 $fix) {
3382 $fixed[$linenr - 1] =~
3383 s/\s+\]/\]/;
3384 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003385 }
3386
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003387# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003388 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3389 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003390 if (ERROR("SPACING",
3391 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3392 $fix) {
3393 $fixed[$linenr - 1] =~
3394 s/\(\s+/\(/;
3395 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003396 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003397 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003398 $line !~ /for\s*\(.*;\s+\)/ &&
3399 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003400 if (ERROR("SPACING",
3401 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3402 $fix) {
3403 $fixed[$linenr - 1] =~
3404 s/\s+\)/\)/;
3405 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003406 }
3407
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003408#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003409 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003410 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003411 if (WARN("INDENTED_LABEL",
3412 "labels should not be indented\n" . $herecurr) &&
3413 $fix) {
3414 $fixed[$linenr - 1] =~
3415 s/^(.)\s+/$1/;
3416 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003417 }
3418
Joe Perches5b9553a2014-04-03 14:49:21 -07003419# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003420 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003421 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003422 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003423 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3424 my $value = $1;
3425 $value = deparenthesize($value);
3426 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3427 ERROR("RETURN_PARENTHESES",
3428 "return is not a function, parentheses are not required\n" . $herecurr);
3429 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003430 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003431 ERROR("SPACING",
3432 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003433 }
3434 }
Joe Perches507e5142013-11-12 15:10:13 -08003435
Joe Perches189248d2014-01-23 15:54:47 -08003436# if statements using unnecessary parentheses - ie: if ((foo == bar))
3437 if ($^V && $^V ge 5.10.0 &&
3438 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3439 my $openparens = $1;
3440 my $count = $openparens =~ tr@\(@\(@;
3441 my $msg = "";
3442 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3443 my $comp = $4; #Not $1 because of $LvalOrFunc
3444 $msg = " - maybe == should be = ?" if ($comp eq "==");
3445 WARN("UNNECESSARY_PARENTHESES",
3446 "Unnecessary parentheses$msg\n" . $herecurr);
3447 }
3448 }
3449
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003450# Return of what appears to be an errno should normally be -'ve
3451 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3452 my $name = $1;
3453 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003454 WARN("USE_NEGATIVE_ERRNO",
3455 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003456 }
3457 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003458
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003459# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003460 if ($line =~ /\b(if|while|for|switch)\(/) {
3461 if (ERROR("SPACING",
3462 "space required before the open parenthesis '('\n" . $herecurr) &&
3463 $fix) {
3464 $fixed[$linenr - 1] =~
3465 s/\b(if|while|for|switch)\(/$1 \(/;
3466 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003467 }
3468
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003469# Check for illegal assignment in if conditional -- and check for trailing
3470# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003471 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003472 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3473 ctx_statement_block($linenr, $realcnt, 0)
3474 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003475 my ($stat_next) = ctx_statement_block($line_nr_next,
3476 $remain_next, $off_next);
3477 $stat_next =~ s/\n./\n /g;
3478 ##print "stat<$stat> stat_next<$stat_next>\n";
3479
3480 if ($stat_next =~ /^\s*while\b/) {
3481 # If the statement carries leading newlines,
3482 # then count those as offsets.
3483 my ($whitespace) =
3484 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3485 my $offset =
3486 statement_rawlines($whitespace) - 1;
3487
3488 $suppress_whiletrailers{$line_nr_next +
3489 $offset} = 1;
3490 }
3491 }
3492 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003493 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003494 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003495 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003496
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003497 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003498 ERROR("ASSIGN_IN_IF",
3499 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003500 }
3501
3502 # Find out what is on the end of the line after the
3503 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003504 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003505 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003506 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003507 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3508 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003509 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003510 # Find out how long the conditional actually is.
3511 my @newlines = ($c =~ /\n/gs);
3512 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003513 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003514
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003515 $stat_real = raw_line($linenr, $cond_lines)
3516 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003517 if (defined($stat_real) && $cond_lines > 1) {
3518 $stat_real = "[...]\n$stat_real";
3519 }
3520
Joe Perches000d1cc12011-07-25 17:13:25 -07003521 ERROR("TRAILING_STATEMENTS",
3522 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003523 }
3524 }
3525
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003526# Check for bitwise tests written as boolean
3527 if ($line =~ /
3528 (?:
3529 (?:\[|\(|\&\&|\|\|)
3530 \s*0[xX][0-9]+\s*
3531 (?:\&\&|\|\|)
3532 |
3533 (?:\&\&|\|\|)
3534 \s*0[xX][0-9]+\s*
3535 (?:\&\&|\|\||\)|\])
3536 )/x)
3537 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003538 WARN("HEXADECIMAL_BOOLEAN_TEST",
3539 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003540 }
3541
Andy Whitcroft8905a672007-11-28 16:21:06 -08003542# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003543 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3544 my $s = $1;
3545 $s =~ s/$;//g; # Remove any comments
3546 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003547 ERROR("TRAILING_STATEMENTS",
3548 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003549 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003550 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003551# if should not continue a brace
3552 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003553 ERROR("TRAILING_STATEMENTS",
3554 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003555 $herecurr);
3556 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003557# case and default should not have general statements after them
3558 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3559 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003560 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003561 \s*return\s+
3562 )/xg)
3563 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003564 ERROR("TRAILING_STATEMENTS",
3565 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003566 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003567
3568 # Check for }<nl>else {, these must be at the same
3569 # indent level to be relevant to each other.
3570 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3571 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003572 ERROR("ELSE_AFTER_BRACE",
3573 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003574 }
3575
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003576 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3577 $previndent == $indent) {
3578 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3579
3580 # Find out what is on the end of the line after the
3581 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003582 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003583 $s =~ s/\n.*//g;
3584
3585 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003586 ERROR("WHILE_AFTER_BRACE",
3587 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003588 }
3589 }
3590
Joe Perches95e2c602013-07-03 15:05:20 -07003591#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003592 while ($line =~ m{($Constant|$Lval)}g) {
3593 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003594
3595#gcc binary extension
3596 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003597 if (WARN("GCC_BINARY_CONSTANT",
3598 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3599 $fix) {
3600 my $hexval = sprintf("0x%x", oct($var));
3601 $fixed[$linenr - 1] =~
3602 s/\b$var\b/$hexval/;
3603 }
Joe Perches95e2c602013-07-03 15:05:20 -07003604 }
3605
3606#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003607 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003608 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003609#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003610 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003611#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003612 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003613 while ($var =~ m{($Ident)}g) {
3614 my $word = $1;
3615 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08003616 if ($check) {
3617 seed_camelcase_includes();
3618 if (!$file && !$camelcase_file_seeded) {
3619 seed_camelcase_file($realfile);
3620 $camelcase_file_seeded = 1;
3621 }
3622 }
Joe Perches7e781f62013-09-11 14:23:55 -07003623 if (!defined $camelcase{$word}) {
3624 $camelcase{$word} = 1;
3625 CHK("CAMELCASE",
3626 "Avoid CamelCase: <$word>\n" . $herecurr);
3627 }
Joe Perches34456862013-07-03 15:05:34 -07003628 }
Joe Perches323c1262012-12-17 16:02:07 -08003629 }
3630 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003631
3632#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003633 if ($line =~ /\#\s*define.*\\\s+$/) {
3634 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3635 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3636 $fix) {
3637 $fixed[$linenr - 1] =~ s/\s+$//;
3638 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003639 }
3640
Andy Whitcroft653d4872007-06-23 17:16:34 -07003641#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003642 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003643 my $file = "$1.h";
3644 my $checkfile = "include/linux/$file";
3645 if (-f "$root/$checkfile" &&
3646 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003647 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003648 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003649 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003650 CHK("ARCH_INCLUDE_LINUX",
3651 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003652 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003653 WARN("INCLUDE_LINUX",
3654 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003655 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003656 }
3657 }
3658
Andy Whitcroft653d4872007-06-23 17:16:34 -07003659# multi-statement macros should be enclosed in a do while loop, grab the
3660# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003661# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07003662 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3663 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003664 my $ln = $linenr;
3665 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003666 my ($off, $dstat, $dcond, $rest);
3667 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003668 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003669 ctx_statement_block($linenr, $realcnt, 0);
3670 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003671 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003672 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003673
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003674 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003675 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003676 $dstat =~ s/\\\n.//g;
3677 $dstat =~ s/^\s*//s;
3678 $dstat =~ s/\s*$//s;
3679
3680 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003681 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3682 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003683 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003684 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003685 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003686
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003687 # Flatten any obvious string concatentation.
3688 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3689 $dstat =~ s/$Ident\s*("X*")/$1/)
3690 {
3691 }
3692
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003693 my $exceptions = qr{
3694 $Declare|
3695 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003696 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003697 DECLARE_PER_CPU|
3698 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003699 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003700 union|
3701 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003702 \.$Ident\s*=\s*|
3703 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003704 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003705 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003706 if ($dstat ne '' &&
3707 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3708 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07003709 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003710 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003711 $dstat !~ /$exceptions/ &&
3712 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003713 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003714 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003715 $dstat !~ /^for\s*$Constant$/ && # for (...)
3716 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3717 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07003718 $dstat !~ /^\({/ && # ({...
3719 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003720 {
3721 $ctx =~ s/\n*$//;
3722 my $herectx = $here . "\n";
3723 my $cnt = statement_rawlines($ctx);
3724
3725 for (my $n = 0; $n < $cnt; $n++) {
3726 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003727 }
3728
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003729 if ($dstat =~ /;/) {
3730 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3731 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3732 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003733 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003734 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003735 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003736 }
Joe Perches5023d342012-12-17 16:01:47 -08003737
Joe Perches481eb482012-12-17 16:01:56 -08003738# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003739
3740 } else {
3741 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003742 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3743 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003744 $line =~ /^\+.*\\$/) {
3745 WARN("LINE_CONTINUATIONS",
3746 "Avoid unnecessary line continuations\n" . $herecurr);
3747 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003748 }
3749
Joe Perchesb13edf72012-07-30 14:41:24 -07003750# do {} while (0) macro tests:
3751# single-statement macros do not need to be enclosed in do while (0) loop,
3752# macro should not end with a semicolon
3753 if ($^V && $^V ge 5.10.0 &&
3754 $realfile !~ m@/vmlinux.lds.h$@ &&
3755 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3756 my $ln = $linenr;
3757 my $cnt = $realcnt;
3758 my ($off, $dstat, $dcond, $rest);
3759 my $ctx = '';
3760 ($dstat, $dcond, $ln, $cnt, $off) =
3761 ctx_statement_block($linenr, $realcnt, 0);
3762 $ctx = $dstat;
3763
3764 $dstat =~ s/\\\n.//g;
3765
3766 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3767 my $stmts = $2;
3768 my $semis = $3;
3769
3770 $ctx =~ s/\n*$//;
3771 my $cnt = statement_rawlines($ctx);
3772 my $herectx = $here . "\n";
3773
3774 for (my $n = 0; $n < $cnt; $n++) {
3775 $herectx .= raw_line($linenr, $n) . "\n";
3776 }
3777
Joe Perchesac8e97f2012-08-21 16:15:53 -07003778 if (($stmts =~ tr/;/;/) == 1 &&
3779 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003780 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3781 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3782 }
3783 if (defined $semis && $semis ne "") {
3784 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3785 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3786 }
3787 }
3788 }
3789
Mike Frysinger080ba922009-01-06 14:41:25 -08003790# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3791# all assignments may have only one of the following with an assignment:
3792# .
3793# ALIGN(...)
3794# VMLINUX_SYMBOL(...)
3795 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003796 WARN("MISSING_VMLINUX_SYMBOL",
3797 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003798 }
3799
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003800# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003801 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3802 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003803 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003804 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003805 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3806 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003807 my @allowed = ();
3808 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003809 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003810 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003811 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003812 for my $chunk (@chunks) {
3813 my ($cond, $block) = @{$chunk};
3814
Andy Whitcroft773647a2008-03-28 14:15:58 -07003815 # If the condition carries leading newlines, then count those as offsets.
3816 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3817 my $offset = statement_rawlines($whitespace) - 1;
3818
Joe Perchesaad4f612012-03-23 15:02:19 -07003819 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003820 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3821
3822 # We have looked at and allowed this specific line.
3823 $suppress_ifbraces{$ln + $offset} = 1;
3824
3825 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003826 $ln += statement_rawlines($block) - 1;
3827
Andy Whitcroft773647a2008-03-28 14:15:58 -07003828 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003829
3830 $seen++ if ($block =~ /^\s*{/);
3831
Joe Perchesaad4f612012-03-23 15:02:19 -07003832 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003833 if (statement_lines($cond) > 1) {
3834 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003835 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003836 }
3837 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003838 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003839 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003840 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003841 if (statement_block_size($block) > 1) {
3842 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003843 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003844 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003845 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003846 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003847 if ($seen) {
3848 my $sum_allowed = 0;
3849 foreach (@allowed) {
3850 $sum_allowed += $_;
3851 }
3852 if ($sum_allowed == 0) {
3853 WARN("BRACES",
3854 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3855 } elsif ($sum_allowed != $allow &&
3856 $seen != $allow) {
3857 CHK("BRACES",
3858 "braces {} should be used on all arms of this statement\n" . $herectx);
3859 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003860 }
3861 }
3862 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003863 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003864 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003865 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003866
Andy Whitcroftcf655042008-03-04 14:28:20 -08003867 # Check the pre-context.
3868 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3869 #print "APW: ALLOWED: pre<$1>\n";
3870 $allowed = 1;
3871 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003872
3873 my ($level, $endln, @chunks) =
3874 ctx_statement_full($linenr, $realcnt, $-[0]);
3875
Andy Whitcroftcf655042008-03-04 14:28:20 -08003876 # Check the condition.
3877 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003878 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003879 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003880 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003881 }
3882 if (statement_lines($cond) > 1) {
3883 #print "APW: ALLOWED: cond<$cond>\n";
3884 $allowed = 1;
3885 }
3886 if ($block =~/\b(?:if|for|while)\b/) {
3887 #print "APW: ALLOWED: block<$block>\n";
3888 $allowed = 1;
3889 }
3890 if (statement_block_size($block) > 1) {
3891 #print "APW: ALLOWED: lines block<$block>\n";
3892 $allowed = 1;
3893 }
3894 # Check the post-context.
3895 if (defined $chunks[1]) {
3896 my ($cond, $block) = @{$chunks[1]};
3897 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003898 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003899 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003900 if ($block =~ /^\s*\{/) {
3901 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3902 $allowed = 1;
3903 }
3904 }
3905 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003906 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003907 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003908
Andy Whitcroftf0556632008-10-15 22:02:23 -07003909 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003910 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003911 }
3912
Joe Perches000d1cc12011-07-25 17:13:25 -07003913 WARN("BRACES",
3914 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003915 }
3916 }
3917
Joe Perches0979ae62012-12-17 16:01:59 -08003918# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07003919 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003920 CHK("BRACES",
3921 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3922 }
Joe Perches77b9a532013-07-03 15:05:29 -07003923 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003924 CHK("BRACES",
3925 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3926 }
3927
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003928# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003929 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3930 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003931 WARN("VOLATILE",
3932 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003933 }
3934
Andy Whitcroft00df3442007-06-08 13:47:06 -07003935# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003936 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003937 CHK("REDUNDANT_CODE",
3938 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003939 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003940 }
3941
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003942# check for needless "if (<foo>) fn(<foo>)" uses
3943 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3944 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3945 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3946 WARN('NEEDLESS_IF',
3947 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003948 }
3949 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003950
Joe Perches8716de32013-09-11 14:24:05 -07003951# check for bad placement of section $InitAttribute (e.g.: __initdata)
3952 if ($line =~ /(\b$InitAttribute\b)/) {
3953 my $attr = $1;
3954 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
3955 my $ptr = $1;
3956 my $var = $2;
3957 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
3958 ERROR("MISPLACED_INIT",
3959 "$attr should be placed after $var\n" . $herecurr)) ||
3960 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
3961 WARN("MISPLACED_INIT",
3962 "$attr should be placed after $var\n" . $herecurr))) &&
3963 $fix) {
3964 $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;
3965 }
3966 }
3967 }
3968
Joe Perchese970b882013-11-12 15:10:10 -08003969# check for $InitAttributeData (ie: __initdata) with const
3970 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
3971 my $attr = $1;
3972 $attr =~ /($InitAttributePrefix)(.*)/;
3973 my $attr_prefix = $1;
3974 my $attr_type = $2;
3975 if (ERROR("INIT_ATTRIBUTE",
3976 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
3977 $fix) {
3978 $fixed[$linenr - 1] =~
3979 s/$InitAttributeData/${attr_prefix}initconst/;
3980 }
3981 }
3982
3983# check for $InitAttributeConst (ie: __initconst) without const
3984 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
3985 my $attr = $1;
3986 if (ERROR("INIT_ATTRIBUTE",
3987 "Use of $attr requires a separate use of const\n" . $herecurr) &&
3988 $fix) {
3989 my $lead = $fixed[$linenr - 1] =~
3990 /(^\+\s*(?:static\s+))/;
3991 $lead = rtrim($1);
3992 $lead = "$lead " if ($lead !~ /^\+$/);
3993 $lead = "${lead}const ";
3994 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
3995 }
3996 }
3997
Joe Perchesfbdb8132014-04-03 14:49:14 -07003998# don't use __constant_<foo> functions outside of include/uapi/
3999 if ($realfile !~ m@^include/uapi/@ &&
4000 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4001 my $constant_func = $1;
4002 my $func = $constant_func;
4003 $func =~ s/^__constant_//;
4004 if (WARN("CONSTANT_CONVERSION",
4005 "$constant_func should be $func\n" . $herecurr) &&
4006 $fix) {
4007 $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
4008 }
4009 }
4010
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004011# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08004012 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004013 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004014 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004015 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004016 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004017 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4018 }
4019 if ($delay > 2000) {
4020 WARN("LONG_UDELAY",
4021 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004022 }
4023 }
4024
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004025# warn about unexpectedly long msleep's
4026 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4027 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004028 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004029 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004030 }
4031 }
4032
Joe Perches36ec1932013-07-03 15:05:25 -07004033# check for comparisons of jiffies
4034 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4035 WARN("JIFFIES_COMPARISON",
4036 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4037 }
4038
Joe Perches9d7a34a2013-07-03 15:05:26 -07004039# check for comparisons of get_jiffies_64()
4040 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4041 WARN("JIFFIES_COMPARISON",
4042 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4043 }
4044
Andy Whitcroft00df3442007-06-08 13:47:06 -07004045# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004046# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07004047# print "#ifdef in C files should be avoided\n";
4048# print "$herecurr";
4049# $clean = 0;
4050# }
4051
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004052# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004053 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004054 if (ERROR("SPACING",
4055 "exactly one space required after that #$1\n" . $herecurr) &&
4056 $fix) {
4057 $fixed[$linenr - 1] =~
4058 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4059 }
4060
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004061 }
4062
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004063# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004064 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4065 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004066 my $which = $1;
4067 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004068 CHK("UNCOMMENTED_DEFINITION",
4069 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004070 }
4071 }
4072# check for memory barriers without a comment.
4073 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4074 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004075 WARN("MEMORY_BARRIER",
4076 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004077 }
4078 }
4079# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004080 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004081 CHK("ARCH_DEFINES",
4082 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004083 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004084
Tobias Klauserd4977c72010-05-24 14:33:30 -07004085# Check that the storage class is at the beginning of a declaration
4086 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004087 WARN("STORAGE_CLASS",
4088 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004089 }
4090
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004091# check the location of the inline attribute, that it is between
4092# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004093 if ($line =~ /\b$Type\s+$Inline\b/ ||
4094 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004095 ERROR("INLINE_LOCATION",
4096 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004097 }
4098
Andy Whitcroft8905a672007-11-28 16:21:06 -08004099# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004100 if ($realfile !~ m@\binclude/uapi/@ &&
4101 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004102 if (WARN("INLINE",
4103 "plain inline is preferred over $1\n" . $herecurr) &&
4104 $fix) {
4105 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4106
4107 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004108 }
4109
Joe Perches3d130fd2011-01-12 17:00:00 -08004110# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004111 if ($realfile !~ m@\binclude/uapi/@ &&
4112 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004113 WARN("PREFER_PACKED",
4114 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004115 }
4116
Joe Perches39b7e282011-07-25 17:13:24 -07004117# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004118 if ($realfile !~ m@\binclude/uapi/@ &&
4119 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004120 WARN("PREFER_ALIGNED",
4121 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004122 }
4123
Joe Perches5f14d3b2012-01-10 15:09:52 -08004124# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004125 if ($realfile !~ m@\binclude/uapi/@ &&
4126 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004127 if (WARN("PREFER_PRINTF",
4128 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4129 $fix) {
4130 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4131
4132 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004133 }
4134
Joe Perches6061d942012-03-23 15:02:16 -07004135# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004136 if ($realfile !~ m@\binclude/uapi/@ &&
4137 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004138 if (WARN("PREFER_SCANF",
4139 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4140 $fix) {
4141 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4142 }
Joe Perches6061d942012-03-23 15:02:16 -07004143 }
4144
Joe Perches8f53a9b2010-03-05 13:43:48 -08004145# check for sizeof(&)
4146 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004147 WARN("SIZEOF_ADDRESS",
4148 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004149 }
4150
Joe Perches66c80b62012-07-30 14:41:22 -07004151# check for sizeof without parenthesis
4152 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004153 if (WARN("SIZEOF_PARENTHESIS",
4154 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4155 $fix) {
4156 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4157 }
Joe Perches66c80b62012-07-30 14:41:22 -07004158 }
4159
Joe Perches428e2fd2011-05-24 17:13:39 -07004160# check for line continuations in quoted strings with odd counts of "
4161 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004162 WARN("LINE_CONTINUATIONS",
4163 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004164 }
4165
Joe Perches88982fe2012-12-17 16:02:00 -08004166# check for struct spinlock declarations
4167 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4168 WARN("USE_SPINLOCK_T",
4169 "struct spinlock should be spinlock_t\n" . $herecurr);
4170 }
4171
Joe Perchesa6962d72013-04-29 16:18:13 -07004172# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004173 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004174 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004175 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004176 if (WARN("PREFER_SEQ_PUTS",
4177 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4178 $fix) {
4179 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4180 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004181 }
4182 }
4183
Andy Whitcroft554e1652012-01-10 15:09:57 -08004184# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004185 if ($^V && $^V ge 5.10.0 &&
4186 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004187 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004188
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004189 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004190 my $ms_val = $7;
4191 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004192
Andy Whitcroft554e1652012-01-10 15:09:57 -08004193 if ($ms_size =~ /^(0x|)0$/i) {
4194 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004195 "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 -08004196 } elsif ($ms_size =~ /^(0x|)1$/i) {
4197 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004198 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4199 }
4200 }
4201
Joe Perches98a9bba2014-01-23 15:54:52 -08004202# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4203 if ($^V && $^V ge 5.10.0 &&
4204 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4205 if (WARN("PREFER_ETHER_ADDR_COPY",
4206 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4207 $fix) {
4208 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4209 }
4210 }
4211
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004212# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004213 if ($^V && $^V ge 5.10.0 &&
4214 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004215 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004216 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004217 my $call = $1;
4218 my $cast1 = deparenthesize($2);
4219 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004220 my $cast2 = deparenthesize($7);
4221 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004222 my $cast;
4223
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004224 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004225 $cast = "$cast1 or $cast2";
4226 } elsif ($cast1 ne "") {
4227 $cast = $cast1;
4228 } else {
4229 $cast = $cast2;
4230 }
4231 WARN("MINMAX",
4232 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004233 }
4234 }
4235
Joe Perches4a273192012-07-30 14:41:20 -07004236# check usleep_range arguments
4237 if ($^V && $^V ge 5.10.0 &&
4238 defined $stat &&
4239 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4240 my $min = $1;
4241 my $max = $7;
4242 if ($min eq $max) {
4243 WARN("USLEEP_RANGE",
4244 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4245 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4246 $min > $max) {
4247 WARN("USLEEP_RANGE",
4248 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4249 }
4250 }
4251
Joe Perches823b7942013-11-12 15:10:15 -08004252# check for naked sscanf
4253 if ($^V && $^V ge 5.10.0 &&
4254 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004255 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004256 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4257 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4258 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4259 my $lc = $stat =~ tr@\n@@;
4260 $lc = $lc + $linenr;
4261 my $stat_real = raw_line($linenr, 0);
4262 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4263 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4264 }
4265 WARN("NAKED_SSCANF",
4266 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4267 }
4268
Joe Perches70dc8a42013-09-11 14:23:58 -07004269# check for new externs in .h files.
4270 if ($realfile =~ /\.h$/ &&
4271 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004272 if (CHK("AVOID_EXTERNS",
4273 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004274 $fix) {
4275 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4276 }
4277 }
4278
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004279# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004280 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004281 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004282 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004283 my $function_name = $1;
4284 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004285
4286 my $s = $stat;
4287 if (defined $cond) {
4288 substr($s, 0, length($cond), '');
4289 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004290 if ($s =~ /^\s*;/ &&
4291 $function_name ne 'uninitialized_var')
4292 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004293 WARN("AVOID_EXTERNS",
4294 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004295 }
4296
4297 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004298 WARN("FUNCTION_ARGUMENTS",
4299 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004300 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004301
4302 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4303 $stat =~ /^.\s*extern\s+/)
4304 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004305 WARN("AVOID_EXTERNS",
4306 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004307 }
4308
4309# checks for new __setup's
4310 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4311 my $name = $1;
4312
4313 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004314 CHK("UNDOCUMENTED_SETUP",
4315 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004316 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004317 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004318
4319# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004320 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004321 WARN("UNNECESSARY_CASTS",
4322 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004323 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004324
Joe Perchesa640d252013-07-03 15:05:21 -07004325# alloc style
4326# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4327 if ($^V && $^V ge 5.10.0 &&
4328 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4329 CHK("ALLOC_SIZEOF_STRUCT",
4330 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4331 }
4332
Joe Perches972fdea2013-04-29 16:18:12 -07004333# check for krealloc arg reuse
4334 if ($^V && $^V ge 5.10.0 &&
4335 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4336 WARN("KREALLOC_ARG_REUSE",
4337 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4338 }
4339
Joe Perches5ce59ae2013-02-21 16:44:18 -08004340# check for alloc argument mismatch
4341 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4342 WARN("ALLOC_ARRAY_ARGS",
4343 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4344 }
4345
Joe Perchescaf2a542011-01-12 16:59:56 -08004346# check for multiple semicolons
4347 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004348 if (WARN("ONE_SEMICOLON",
4349 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4350 $fix) {
4351 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4352 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004353 }
4354
Joe Perchesc34c09a2014-01-23 15:54:43 -08004355# check for case / default statements not preceeded by break/fallthrough/switch
4356 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4357 my $has_break = 0;
4358 my $has_statement = 0;
4359 my $count = 0;
4360 my $prevline = $linenr;
4361 while ($prevline > 1 && $count < 3 && !$has_break) {
4362 $prevline--;
4363 my $rline = $rawlines[$prevline - 1];
4364 my $fline = $lines[$prevline - 1];
4365 last if ($fline =~ /^\@\@/);
4366 next if ($fline =~ /^\-/);
4367 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4368 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4369 next if ($fline =~ /^.[\s$;]*$/);
4370 $has_statement = 1;
4371 $count++;
4372 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4373 }
4374 if (!$has_break && $has_statement) {
4375 WARN("MISSING_BREAK",
4376 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4377 }
4378 }
4379
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004380# check for switch/default statements without a break;
4381 if ($^V && $^V ge 5.10.0 &&
4382 defined $stat &&
4383 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4384 my $ctx = '';
4385 my $herectx = $here . "\n";
4386 my $cnt = statement_rawlines($stat);
4387 for (my $n = 0; $n < $cnt; $n++) {
4388 $herectx .= raw_line($linenr, $n) . "\n";
4389 }
4390 WARN("DEFAULT_NO_BREAK",
4391 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004392 }
4393
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004394# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004395 if ($line =~ /\b__FUNCTION__\b/) {
4396 if (WARN("USE_FUNC",
4397 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4398 $fix) {
4399 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4400 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004401 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004402
Joe Perches2c924882012-03-23 15:02:20 -07004403# check for use of yield()
4404 if ($line =~ /\byield\s*\(\s*\)/) {
4405 WARN("YIELD",
4406 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4407 }
4408
Joe Perches179f8f42013-07-03 15:05:30 -07004409# check for comparisons against true and false
4410 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4411 my $lead = $1;
4412 my $arg = $2;
4413 my $test = $3;
4414 my $otype = $4;
4415 my $trail = $5;
4416 my $op = "!";
4417
4418 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4419
4420 my $type = lc($otype);
4421 if ($type =~ /^(?:true|false)$/) {
4422 if (("$test" eq "==" && "$type" eq "true") ||
4423 ("$test" eq "!=" && "$type" eq "false")) {
4424 $op = "";
4425 }
4426
4427 CHK("BOOL_COMPARISON",
4428 "Using comparison to $otype is error prone\n" . $herecurr);
4429
4430## maybe suggesting a correct construct would better
4431## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4432
4433 }
4434 }
4435
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004436# check for semaphores initialized locked
4437 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004438 WARN("CONSIDER_COMPLETION",
4439 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004440 }
Joe Perches6712d852012-03-23 15:02:20 -07004441
Joe Perches67d0a072011-10-31 17:13:10 -07004442# recommend kstrto* over simple_strto* and strict_strto*
4443 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004444 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004445 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004446 }
Joe Perches6712d852012-03-23 15:02:20 -07004447
Michael Ellermanf3db6632008-07-23 21:28:57 -07004448# check for __initcall(), use device_initcall() explicitly please
4449 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004450 WARN("USE_DEVICE_INITCALL",
4451 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07004452 }
Joe Perches6712d852012-03-23 15:02:20 -07004453
Emese Revfy79404842010-03-05 13:43:53 -08004454# check for various ops structs, ensure they are const.
4455 my $struct_ops = qr{acpi_dock_ops|
4456 address_space_operations|
4457 backlight_ops|
4458 block_device_operations|
4459 dentry_operations|
4460 dev_pm_ops|
4461 dma_map_ops|
4462 extent_io_ops|
4463 file_lock_operations|
4464 file_operations|
4465 hv_ops|
4466 ide_dma_ops|
4467 intel_dvo_dev_ops|
4468 item_operations|
4469 iwl_ops|
4470 kgdb_arch|
4471 kgdb_io|
4472 kset_uevent_ops|
4473 lock_manager_operations|
4474 microcode_ops|
4475 mtrr_ops|
4476 neigh_ops|
4477 nlmsvc_binding|
4478 pci_raw_ops|
4479 pipe_buf_operations|
4480 platform_hibernation_ops|
4481 platform_suspend_ops|
4482 proto_ops|
4483 rpc_pipe_ops|
4484 seq_operations|
4485 snd_ac97_build_ops|
4486 soc_pcmcia_socket_ops|
4487 stacktrace_ops|
4488 sysfs_ops|
4489 tty_operations|
4490 usb_mon_operations|
4491 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004492 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004493 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004494 WARN("CONST_STRUCT",
4495 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004496 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004497 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004498
4499# use of NR_CPUS is usually wrong
4500# ignore definitions of NR_CPUS and usage to define arrays as likely right
4501 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004502 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4503 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004504 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4505 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4506 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004507 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004508 WARN("NR_CPUS",
4509 "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 -07004510 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004511
Joe Perches52ea8502013-11-12 15:10:09 -08004512# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4513 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4514 ERROR("DEFINE_ARCH_HAS",
4515 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4516 }
4517
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004518# check for %L{u,d,i} in strings
4519 my $string;
4520 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4521 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004522 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004523 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004524 WARN("PRINTF_L",
4525 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004526 last;
4527 }
4528 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004529
4530# whine mightly about in_atomic
4531 if ($line =~ /\bin_atomic\s*\(/) {
4532 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004533 ERROR("IN_ATOMIC",
4534 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004535 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004536 WARN("IN_ATOMIC",
4537 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004538 }
4539 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004540
4541# check for lockdep_set_novalidate_class
4542 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4543 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4544 if ($realfile !~ m@^kernel/lockdep@ &&
4545 $realfile !~ m@^include/linux/lockdep@ &&
4546 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004547 ERROR("LOCKDEP",
4548 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004549 }
4550 }
Dave Jones88f88312011-01-12 16:59:59 -08004551
4552 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4553 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004554 WARN("EXPORTED_WORLD_WRITABLE",
4555 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004556 }
Joe Perches24358802014-04-03 14:49:13 -07004557
Joe Perches515a2352014-04-03 14:49:24 -07004558# Mode permission misuses where it seems decimal should be octal
4559# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4560 if ($^V && $^V ge 5.10.0 &&
4561 $line =~ /$mode_perms_search/) {
4562 foreach my $entry (@mode_permission_funcs) {
4563 my $func = $entry->[0];
4564 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07004565
Joe Perches515a2352014-04-03 14:49:24 -07004566 my $skip_args = "";
4567 if ($arg_pos > 1) {
4568 $arg_pos--;
4569 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4570 }
4571 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4572 if ($line =~ /$test/) {
4573 my $val = $1;
4574 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07004575
Joe Perches515a2352014-04-03 14:49:24 -07004576 if ($val !~ /^0$/ &&
4577 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4578 length($val) ne 4)) {
4579 ERROR("NON_OCTAL_PERMISSIONS",
4580 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4581 }
Joe Perches24358802014-04-03 14:49:13 -07004582 }
4583 }
4584 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004585 }
4586
4587 # If we have no input at all, then there is nothing to report on
4588 # so just keep quiet.
4589 if ($#rawlines == -1) {
4590 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004591 }
4592
Andy Whitcroft8905a672007-11-28 16:21:06 -08004593 # In mailback mode only produce a report in the negative, for
4594 # things that appear to be patches.
4595 if ($mailback && ($clean == 1 || !$is_patch)) {
4596 exit(0);
4597 }
4598
4599 # This is not a patch, and we are are in 'no-patch' mode so
4600 # just keep quiet.
4601 if (!$chk_patch && !$is_patch) {
4602 exit(0);
4603 }
4604
4605 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004606 ERROR("NOT_UNIFIED_DIFF",
4607 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004608 }
4609 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004610 ERROR("MISSING_SIGN_OFF",
4611 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004612 }
4613
Andy Whitcroft8905a672007-11-28 16:21:06 -08004614 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004615 if ($summary && !($clean == 1 && $quiet == 1)) {
4616 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004617 print "total: $cnt_error errors, $cnt_warn warnings, " .
4618 (($check)? "$cnt_chk checks, " : "") .
4619 "$cnt_lines lines checked\n";
4620 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004621 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004622
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004623 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004624
4625 if ($^V lt 5.10.0) {
4626 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4627 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4628 }
4629
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004630 # If there were whitespace errors which cleanpatch can fix
4631 # then suggest that.
4632 if ($rpt_cleaners) {
4633 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4634 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07004635 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004636 }
4637 }
4638
Joe Perches91bfe482013-09-11 14:23:59 -07004639 hash_show_words(\%use_type, "Used");
4640 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07004641
Joe Perches3705ce52013-07-03 15:05:31 -07004642 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
Joe Perches9624b8d2014-01-23 15:54:44 -08004643 my $newfile = $filename;
4644 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07004645 my $linecount = 0;
4646 my $f;
4647
4648 open($f, '>', $newfile)
4649 or die "$P: Can't open $newfile for write\n";
4650 foreach my $fixed_line (@fixed) {
4651 $linecount++;
4652 if ($file) {
4653 if ($linecount > 3) {
4654 $fixed_line =~ s/^\+//;
4655 print $f $fixed_line. "\n";
4656 }
4657 } else {
4658 print $f $fixed_line . "\n";
4659 }
4660 }
4661 close($f);
4662
4663 if (!$quiet) {
4664 print << "EOM";
4665Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4666
4667Do _NOT_ trust the results written to this file.
4668Do _NOT_ submit these changes without inspecting them for correctness.
4669
4670This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4671No warranties, expressed or implied...
4672
4673EOM
4674 }
4675 }
4676
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004677 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004678 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004679 }
4680 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004681 print << "EOM";
4682$vname has style problems, please review.
4683
4684If any of these errors are false positives, please report
4685them to the maintainer, see CHECKPATCH in MAINTAINERS.
4686EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004687 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004688
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004689 return $clean;
4690}