blob: 75b587e8ddfdcaa53ad7697359564cab617eb102 [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;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700284our $Inline = qr{inline|__always_inline|noinline};
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
Andy Whitcroft8905a672007-11-28 16:21:06 -0800307our $NonptrType;
Joe Perches8716de32013-09-11 14:24:05 -0700308our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800309our $Type;
310our $Declare;
311
Joe Perches15662b32011-10-31 17:13:12 -0700312our $NON_ASCII_UTF8 = qr{
313 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700314 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
315 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
316 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
317 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
318 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
319 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
320}x;
321
Joe Perches15662b32011-10-31 17:13:12 -0700322our $UTF8 = qr{
323 [\x09\x0A\x0D\x20-\x7E] # ASCII
324 | $NON_ASCII_UTF8
325}x;
326
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700327our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700328 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700329 atomic_t
330)};
331
Joe Perches691e6692010-03-05 13:43:51 -0800332our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700333 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700334 (?:[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 -0700335 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700336 panic|
Joe Perches06668722013-11-12 15:10:07 -0800337 MODULE_[A-Z_]+|
338 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800339)};
340
Joe Perches20112472011-07-25 17:13:23 -0700341our $signature_tags = qr{(?xi:
342 Signed-off-by:|
343 Acked-by:|
344 Tested-by:|
345 Reviewed-by:|
346 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700347 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700348 To:|
349 Cc:
350)};
351
Andy Whitcroft8905a672007-11-28 16:21:06 -0800352our @typeList = (
353 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700354 qr{(?:unsigned\s+)?char},
355 qr{(?:unsigned\s+)?short},
356 qr{(?:unsigned\s+)?int},
357 qr{(?:unsigned\s+)?long},
358 qr{(?:unsigned\s+)?long\s+int},
359 qr{(?:unsigned\s+)?long\s+long},
360 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800361 qr{unsigned},
362 qr{float},
363 qr{double},
364 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800365 qr{struct\s+$Ident},
366 qr{union\s+$Ident},
367 qr{enum\s+$Ident},
368 qr{${Ident}_t},
369 qr{${Ident}_handler},
370 qr{${Ident}_handler_fn},
371);
Joe Perches8716de32013-09-11 14:24:05 -0700372our @typeListWithAttr = (
373 @typeList,
374 qr{struct\s+$InitAttribute\s+$Ident},
375 qr{union\s+$InitAttribute\s+$Ident},
376);
377
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700378our @modifierList = (
379 qr{fastcall},
380);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800381
Joe Perches24358802014-04-03 14:49:13 -0700382our @mode_permission_funcs = (
383 ["module_param", 3],
384 ["module_param_(?:array|named|string)", 4],
385 ["module_param_array_named", 5],
386 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
387 ["proc_create(?:_data|)", 2],
388 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
389);
390
Joe Perches515a2352014-04-03 14:49:24 -0700391#Create a search pattern for all these functions to speed up a loop below
392our $mode_perms_search = "";
393foreach my $entry (@mode_permission_funcs) {
394 $mode_perms_search .= '|' if ($mode_perms_search ne "");
395 $mode_perms_search .= $entry->[0];
396}
397
Wolfram Sang7840a942010-08-09 17:20:57 -0700398our $allowed_asm_includes = qr{(?x:
399 irq|
400 memory
401)};
402# memory.h: ARM has a custom one
403
Andy Whitcroft8905a672007-11-28 16:21:06 -0800404sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700405 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
406 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700407 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700408 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800409 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700410 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800411 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800412 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700413 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700414 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800415 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700416 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800417 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700418 $NonptrTypeWithAttr = qr{
419 (?:$Modifier\s+|const\s+)*
420 (?:
421 (?:typeof|__typeof__)\s*\([^\)]*\)|
422 (?:$typeTypedefs\b)|
423 (?:${allWithAttr}\b)
424 )
425 (?:\s+$Modifier|\s+const)*
426 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800427 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700428 $NonptrType
Andy Whitcroftb337d8b2012-03-23 15:02:18 -0700429 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700430 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800431 }x;
432 $Declare = qr{(?:$Storage\s+)?$Type};
433}
434build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700435
Joe Perches7d2367a2011-07-25 17:13:22 -0700436our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700437
438# Using $balanced_parens, $LvalOrFunc, or $FuncArg
439# requires at least perl version v5.10.0
440# Any use must be runtime checked with $^V
441
442our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700443our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800444our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700445
446sub deparenthesize {
447 my ($string) = @_;
448 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700449
450 while ($string =~ /^\s*\(.*\)\s*$/) {
451 $string =~ s@^\s*\(\s*@@;
452 $string =~ s@\s*\)\s*$@@;
453 }
454
Joe Perches7d2367a2011-07-25 17:13:22 -0700455 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700456
Joe Perches7d2367a2011-07-25 17:13:22 -0700457 return $string;
458}
459
Joe Perches34456862013-07-03 15:05:34 -0700460sub seed_camelcase_file {
461 my ($file) = @_;
462
463 return if (!(-f $file));
464
465 local $/;
466
467 open(my $include_file, '<', "$file")
468 or warn "$P: Can't read '$file' $!\n";
469 my $text = <$include_file>;
470 close($include_file);
471
472 my @lines = split('\n', $text);
473
474 foreach my $line (@lines) {
475 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
476 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
477 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800478 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
479 $camelcase{$1} = 1;
480 } 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 -0700481 $camelcase{$1} = 1;
482 }
483 }
484}
485
486my $camelcase_seeded = 0;
487sub seed_camelcase_includes {
488 return if ($camelcase_seeded);
489
490 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700491 my $camelcase_cache = "";
492 my @include_files = ();
493
494 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700495
Richard Genoud3645e322014-02-10 14:25:32 -0800496 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700497 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
498 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700499 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700500 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700501 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700502 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700503 @include_files = split('\n', $files);
504 foreach my $file (@include_files) {
505 my $date = POSIX::strftime("%Y%m%d%H%M",
506 localtime((stat $file)[9]));
507 $last_mod_date = $date if ($last_mod_date < $date);
508 }
509 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700510 }
Joe Perchesc707a812013-07-08 16:00:43 -0700511
512 if ($camelcase_cache ne "" && -f $camelcase_cache) {
513 open(my $camelcase_file, '<', "$camelcase_cache")
514 or warn "$P: Can't read '$camelcase_cache' $!\n";
515 while (<$camelcase_file>) {
516 chomp;
517 $camelcase{$_} = 1;
518 }
519 close($camelcase_file);
520
521 return;
522 }
523
Richard Genoud3645e322014-02-10 14:25:32 -0800524 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700525 $files = `git ls-files "include/*.h"`;
526 @include_files = split('\n', $files);
527 }
528
Joe Perches34456862013-07-03 15:05:34 -0700529 foreach my $file (@include_files) {
530 seed_camelcase_file($file);
531 }
Joe Perches351b2a12013-07-03 15:05:36 -0700532
Joe Perchesc707a812013-07-08 16:00:43 -0700533 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700534 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700535 open(my $camelcase_file, '>', "$camelcase_cache")
536 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700537 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
538 print $camelcase_file ("$_\n");
539 }
540 close($camelcase_file);
541 }
Joe Perches34456862013-07-03 15:05:34 -0700542}
543
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700544$chk_signoff = 0 if ($file);
545
Andy Whitcroft00df3442007-06-08 13:47:06 -0700546my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800547my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700548my @fixed = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800549my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700550for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800551 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700552 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800553 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700554 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800555 } elsif ($filename eq '-') {
556 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700557 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800558 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700559 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700560 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800561 if ($filename eq '-') {
562 $vname = 'Your patch';
563 } else {
564 $vname = $filename;
565 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800566 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700567 chomp;
568 push(@rawlines, $_);
569 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800570 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800571 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700572 $exit = 1;
573 }
574 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800575 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700576 @fixed = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700577}
578
579exit($exit);
580
581sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700582 my ($root) = @_;
583
584 my @tree_check = (
585 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
586 "README", "Documentation", "arch", "include", "drivers",
587 "fs", "init", "ipc", "kernel", "lib", "scripts",
588 );
589
590 foreach my $check (@tree_check) {
591 if (! -e $root . '/' . $check) {
592 return 0;
593 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700594 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700595 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700596}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700597
Joe Perches20112472011-07-25 17:13:23 -0700598sub parse_email {
599 my ($formatted_email) = @_;
600
601 my $name = "";
602 my $address = "";
603 my $comment = "";
604
605 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
606 $name = $1;
607 $address = $2;
608 $comment = $3 if defined $3;
609 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
610 $address = $1;
611 $comment = $2 if defined $2;
612 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
613 $address = $1;
614 $comment = $2 if defined $2;
615 $formatted_email =~ s/$address.*$//;
616 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700617 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700618 $name =~ s/^\"|\"$//g;
619 # If there's a name left after stripping spaces and
620 # leading quotes, and the address doesn't have both
621 # leading and trailing angle brackets, the address
622 # is invalid. ie:
623 # "joe smith joe@smith.com" bad
624 # "joe smith <joe@smith.com" bad
625 if ($name ne "" && $address !~ /^<[^>]+>$/) {
626 $name = "";
627 $address = "";
628 $comment = "";
629 }
630 }
631
Joe Perches3705ce52013-07-03 15:05:31 -0700632 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700633 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700634 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700635 $address =~ s/^\<|\>$//g;
636
637 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
638 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
639 $name = "\"$name\"";
640 }
641
642 return ($name, $address, $comment);
643}
644
645sub format_email {
646 my ($name, $address) = @_;
647
648 my $formatted_email;
649
Joe Perches3705ce52013-07-03 15:05:31 -0700650 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700651 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700652 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700653
654 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
655 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
656 $name = "\"$name\"";
657 }
658
659 if ("$name" eq "") {
660 $formatted_email = "$address";
661 } else {
662 $formatted_email = "$name <$address>";
663 }
664
665 return $formatted_email;
666}
667
Joe Perches000d1cc12011-07-25 17:13:25 -0700668sub which_conf {
669 my ($conf) = @_;
670
671 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
672 if (-e "$path/$conf") {
673 return "$path/$conf";
674 }
675 }
676
677 return "";
678}
679
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700680sub expand_tabs {
681 my ($str) = @_;
682
683 my $res = '';
684 my $n = 0;
685 for my $c (split(//, $str)) {
686 if ($c eq "\t") {
687 $res .= ' ';
688 $n++;
689 for (; ($n % 8) != 0; $n++) {
690 $res .= ' ';
691 }
692 next;
693 }
694 $res .= $c;
695 $n++;
696 }
697
698 return $res;
699}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700700sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700701 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700702 return $res;
703}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700704
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700705sub line_stats {
706 my ($line) = @_;
707
708 # Drop the diff line leader and expand tabs
709 $line =~ s/^.//;
710 $line = expand_tabs($line);
711
712 # Pick the indent from the front of the line.
713 my ($white) = ($line =~ /^(\s*)/);
714
715 return (length($line), length($white));
716}
717
Andy Whitcroft773647a2008-03-28 14:15:58 -0700718my $sanitise_quote = '';
719
720sub sanitise_line_reset {
721 my ($in_comment) = @_;
722
723 if ($in_comment) {
724 $sanitise_quote = '*/';
725 } else {
726 $sanitise_quote = '';
727 }
728}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700729sub sanitise_line {
730 my ($line) = @_;
731
732 my $res = '';
733 my $l = '';
734
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800735 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700736 my $off = 0;
737 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700738
Andy Whitcroft773647a2008-03-28 14:15:58 -0700739 # Always copy over the diff marker.
740 $res = substr($line, 0, 1);
741
742 for ($off = 1; $off < length($line); $off++) {
743 $c = substr($line, $off, 1);
744
745 # Comments we are wacking completly including the begin
746 # and end, all to $;.
747 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
748 $sanitise_quote = '*/';
749
750 substr($res, $off, 2, "$;$;");
751 $off++;
752 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800753 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700754 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700755 $sanitise_quote = '';
756 substr($res, $off, 2, "$;$;");
757 $off++;
758 next;
759 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700760 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
761 $sanitise_quote = '//';
762
763 substr($res, $off, 2, $sanitise_quote);
764 $off++;
765 next;
766 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700767
768 # A \ in a string means ignore the next character.
769 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
770 $c eq "\\") {
771 substr($res, $off, 2, 'XX');
772 $off++;
773 next;
774 }
775 # Regular quotes.
776 if ($c eq "'" || $c eq '"') {
777 if ($sanitise_quote eq '') {
778 $sanitise_quote = $c;
779
780 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700781 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700782 } elsif ($sanitise_quote eq $c) {
783 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700784 }
785 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700786
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800787 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700788 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
789 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700790 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
791 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700792 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
793 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700794 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700795 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700796 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800797 }
798
Daniel Walker113f04a2009-09-21 17:04:35 -0700799 if ($sanitise_quote eq '//') {
800 $sanitise_quote = '';
801 }
802
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800803 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700804 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800805 my $clean = 'X' x length($1);
806 $res =~ s@\<.*\>@<$clean>@;
807
808 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700809 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800810 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700811 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800812 }
813
Andy Whitcroft00df3442007-06-08 13:47:06 -0700814 return $res;
815}
816
Joe Perchesa6962d72013-04-29 16:18:13 -0700817sub get_quoted_string {
818 my ($line, $rawline) = @_;
819
820 return "" if ($line !~ m/(\"[X]+\")/g);
821 return substr($rawline, $-[0], $+[0] - $-[0]);
822}
823
Andy Whitcroft8905a672007-11-28 16:21:06 -0800824sub ctx_statement_block {
825 my ($linenr, $remain, $off) = @_;
826 my $line = $linenr - 1;
827 my $blk = '';
828 my $soff = $off;
829 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700830 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800831
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800832 my $loff = 0;
833
Andy Whitcroft8905a672007-11-28 16:21:06 -0800834 my $type = '';
835 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800836 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800837 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800838 my $c;
839 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800840
841 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800842 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800843 @stack = (['', 0]) if ($#stack == -1);
844
Andy Whitcroft773647a2008-03-28 14:15:58 -0700845 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800846 # If we are about to drop off the end, pull in more
847 # context.
848 if ($off >= $len) {
849 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700850 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800851 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800852 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800853 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800854 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800855 $len = length($blk);
856 $line++;
857 last;
858 }
859 # Bail if there is no further context.
860 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800861 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800862 last;
863 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800864 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
865 $level++;
866 $type = '#';
867 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800868 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800869 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800870 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800871 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800872
Andy Whitcroft773647a2008-03-28 14:15:58 -0700873 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800874
875 # Handle nested #if/#else.
876 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
877 push(@stack, [ $type, $level ]);
878 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
879 ($type, $level) = @{$stack[$#stack - 1]};
880 } elsif ($remainder =~ /^#\s*endif\b/) {
881 ($type, $level) = @{pop(@stack)};
882 }
883
Andy Whitcroft8905a672007-11-28 16:21:06 -0800884 # Statement ends at the ';' or a close '}' at the
885 # outermost level.
886 if ($level == 0 && $c eq ';') {
887 last;
888 }
889
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800890 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700891 if ($level == 0 && $coff_set == 0 &&
892 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
893 $remainder =~ /^(else)(?:\s|{)/ &&
894 $remainder !~ /^else\s+if\b/) {
895 $coff = $off + length($1) - 1;
896 $coff_set = 1;
897 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
898 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800899 }
900
Andy Whitcroft8905a672007-11-28 16:21:06 -0800901 if (($type eq '' || $type eq '(') && $c eq '(') {
902 $level++;
903 $type = '(';
904 }
905 if ($type eq '(' && $c eq ')') {
906 $level--;
907 $type = ($level != 0)? '(' : '';
908
909 if ($level == 0 && $coff < $soff) {
910 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700911 $coff_set = 1;
912 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800913 }
914 }
915 if (($type eq '' || $type eq '{') && $c eq '{') {
916 $level++;
917 $type = '{';
918 }
919 if ($type eq '{' && $c eq '}') {
920 $level--;
921 $type = ($level != 0)? '{' : '';
922
923 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700924 if (substr($blk, $off + 1, 1) eq ';') {
925 $off++;
926 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800927 last;
928 }
929 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800930 # Preprocessor commands end at the newline unless escaped.
931 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
932 $level--;
933 $type = '';
934 $off++;
935 last;
936 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800937 $off++;
938 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700939 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800940 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700941 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800942 $line++;
943 $remain--;
944 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800945
946 my $statement = substr($blk, $soff, $off - $soff + 1);
947 my $condition = substr($blk, $soff, $coff - $soff + 1);
948
949 #warn "STATEMENT<$statement>\n";
950 #warn "CONDITION<$condition>\n";
951
Andy Whitcroft773647a2008-03-28 14:15:58 -0700952 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800953
954 return ($statement, $condition,
955 $line, $remain + 1, $off - $loff + 1, $level);
956}
957
Andy Whitcroftcf655042008-03-04 14:28:20 -0800958sub statement_lines {
959 my ($stmt) = @_;
960
961 # Strip the diff line prefixes and rip blank lines at start and end.
962 $stmt =~ s/(^|\n)./$1/g;
963 $stmt =~ s/^\s*//;
964 $stmt =~ s/\s*$//;
965
966 my @stmt_lines = ($stmt =~ /\n/g);
967
968 return $#stmt_lines + 2;
969}
970
971sub statement_rawlines {
972 my ($stmt) = @_;
973
974 my @stmt_lines = ($stmt =~ /\n/g);
975
976 return $#stmt_lines + 2;
977}
978
979sub statement_block_size {
980 my ($stmt) = @_;
981
982 $stmt =~ s/(^|\n)./$1/g;
983 $stmt =~ s/^\s*{//;
984 $stmt =~ s/}\s*$//;
985 $stmt =~ s/^\s*//;
986 $stmt =~ s/\s*$//;
987
988 my @stmt_lines = ($stmt =~ /\n/g);
989 my @stmt_statements = ($stmt =~ /;/g);
990
991 my $stmt_lines = $#stmt_lines + 2;
992 my $stmt_statements = $#stmt_statements + 1;
993
994 if ($stmt_lines > $stmt_statements) {
995 return $stmt_lines;
996 } else {
997 return $stmt_statements;
998 }
999}
1000
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001001sub ctx_statement_full {
1002 my ($linenr, $remain, $off) = @_;
1003 my ($statement, $condition, $level);
1004
1005 my (@chunks);
1006
Andy Whitcroftcf655042008-03-04 14:28:20 -08001007 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001008 ($statement, $condition, $linenr, $remain, $off, $level) =
1009 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001010 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001011 push(@chunks, [ $condition, $statement ]);
1012 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1013 return ($level, $linenr, @chunks);
1014 }
1015
1016 # Pull in the following conditional/block pairs and see if they
1017 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001018 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001019 ($statement, $condition, $linenr, $remain, $off, $level) =
1020 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001021 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001022 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001023 #print "C: push\n";
1024 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001025 }
1026
1027 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001028}
1029
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001030sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001031 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001032 my $line;
1033 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001034 my $blk = '';
1035 my @o;
1036 my @c;
1037 my @res = ();
1038
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001039 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001040 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001041 for ($line = $start; $remain > 0; $line++) {
1042 next if ($rawlines[$line] =~ /^-/);
1043 $remain--;
1044
1045 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001046
1047 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001048 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001049 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001050 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001051 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001052 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001053 $level = pop(@stack);
1054 }
1055
Andy Whitcroft01464f32010-10-26 14:23:19 -07001056 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001057 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1058 if ($off > 0) {
1059 $off--;
1060 next;
1061 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001062
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001063 if ($c eq $close && $level > 0) {
1064 $level--;
1065 last if ($level == 0);
1066 } elsif ($c eq $open) {
1067 $level++;
1068 }
1069 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001070
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001071 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001072 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001073 }
1074
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001075 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001076 }
1077
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001078 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001079}
1080sub ctx_block_outer {
1081 my ($linenr, $remain) = @_;
1082
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001083 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1084 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001085}
1086sub ctx_block {
1087 my ($linenr, $remain) = @_;
1088
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001089 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1090 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001091}
1092sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001093 my ($linenr, $remain, $off) = @_;
1094
1095 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1096 return @r;
1097}
1098sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001099 my ($linenr, $remain) = @_;
1100
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001101 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001102}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001103sub ctx_statement_level {
1104 my ($linenr, $remain, $off) = @_;
1105
1106 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1107}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001108
1109sub ctx_locate_comment {
1110 my ($first_line, $end_line) = @_;
1111
1112 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001113 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001114 return $current_comment if (defined $current_comment);
1115
1116 # Look through the context and try and figure out if there is a
1117 # comment.
1118 my $in_comment = 0;
1119 $current_comment = '';
1120 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001121 my $line = $rawlines[$linenr - 1];
1122 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001123 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1124 $in_comment = 1;
1125 }
1126 if ($line =~ m@/\*@) {
1127 $in_comment = 1;
1128 }
1129 if (!$in_comment && $current_comment ne '') {
1130 $current_comment = '';
1131 }
1132 $current_comment .= $line . "\n" if ($in_comment);
1133 if ($line =~ m@\*/@) {
1134 $in_comment = 0;
1135 }
1136 }
1137
1138 chomp($current_comment);
1139 return($current_comment);
1140}
1141sub ctx_has_comment {
1142 my ($first_line, $end_line) = @_;
1143 my $cmt = ctx_locate_comment($first_line, $end_line);
1144
Andy Whitcroft00df3442007-06-08 13:47:06 -07001145 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001146 ##print "CMMT: $cmt\n";
1147
1148 return ($cmt ne '');
1149}
1150
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001151sub raw_line {
1152 my ($linenr, $cnt) = @_;
1153
1154 my $offset = $linenr - 1;
1155 $cnt++;
1156
1157 my $line;
1158 while ($cnt) {
1159 $line = $rawlines[$offset++];
1160 next if (defined($line) && $line =~ /^-/);
1161 $cnt--;
1162 }
1163
1164 return $line;
1165}
1166
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001167sub cat_vet {
1168 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001169 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001170
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001171 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001172 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1173 $res .= $1;
1174 if ($2 ne '') {
1175 $coded = sprintf("^%c", unpack('C', $2) + 64);
1176 $res .= $coded;
1177 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001178 }
1179 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001180
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001181 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001182}
1183
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001184my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001185my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001186my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001187my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001188
1189sub annotate_reset {
1190 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001191 $av_pending = '_';
1192 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001193 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001194}
1195
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001196sub annotate_values {
1197 my ($stream, $type) = @_;
1198
1199 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001200 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001201 my $cur = $stream;
1202
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001203 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001204
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001205 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001206 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001207 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001208 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001209 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001210 print "WS($1)\n" if ($dbg_values > 1);
1211 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001212 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001213 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001214 }
1215
Florian Micklerc023e4732011-01-12 16:59:58 -08001216 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001217 print "CAST($1)\n" if ($dbg_values > 1);
1218 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001219 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001220
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001221 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001222 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001223 $type = 'T';
1224
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001225 } elsif ($cur =~ /^($Modifier)\s*/) {
1226 print "MODIFIER($1)\n" if ($dbg_values > 1);
1227 $type = 'T';
1228
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001229 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001230 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001231 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001232 push(@av_paren_type, $type);
1233 if ($2 ne '') {
1234 $av_pending = 'N';
1235 }
1236 $type = 'E';
1237
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001238 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001239 print "UNDEF($1)\n" if ($dbg_values > 1);
1240 $av_preprocessor = 1;
1241 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001242
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001243 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001244 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001245 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001246
1247 push(@av_paren_type, $type);
1248 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001249 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001250
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001251 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001252 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1253 $av_preprocessor = 1;
1254
1255 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1256
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001257 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001258
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001259 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001260 print "PRE_END($1)\n" if ($dbg_values > 1);
1261
1262 $av_preprocessor = 1;
1263
1264 # Assume all arms of the conditional end as this
1265 # one does, and continue as if the #endif was not here.
1266 pop(@av_paren_type);
1267 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001268 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001269
1270 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001271 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001272
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001273 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1274 print "ATTR($1)\n" if ($dbg_values > 1);
1275 $av_pending = $type;
1276 $type = 'N';
1277
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001278 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001279 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001280 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001281 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001282 }
1283 $type = 'N';
1284
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001285 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001286 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001287 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001288 $type = 'N';
1289
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001290 } elsif ($cur =~/^(case)/o) {
1291 print "CASE($1)\n" if ($dbg_values > 1);
1292 $av_pend_colon = 'C';
1293 $type = 'N';
1294
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001295 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001296 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001297 $type = 'N';
1298
1299 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001300 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001301 push(@av_paren_type, $av_pending);
1302 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001303 $type = 'N';
1304
1305 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001306 my $new_type = pop(@av_paren_type);
1307 if ($new_type ne '_') {
1308 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001309 print "PAREN('$1') -> $type\n"
1310 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001311 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001312 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001313 }
1314
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001315 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001316 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001317 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001318 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001319
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001320 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1321 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001322 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001323 } elsif ($type eq 'E') {
1324 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001325 }
1326 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1327 $type = 'V';
1328
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001329 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001330 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001331 $type = 'V';
1332
1333 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001334 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001335 $type = 'N';
1336
Andy Whitcroftcf655042008-03-04 14:28:20 -08001337 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001338 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001339 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001340 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001341
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001342 } elsif ($cur =~/^(,)/) {
1343 print "COMMA($1)\n" if ($dbg_values > 1);
1344 $type = 'C';
1345
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001346 } elsif ($cur =~ /^(\?)/o) {
1347 print "QUESTION($1)\n" if ($dbg_values > 1);
1348 $type = 'N';
1349
1350 } elsif ($cur =~ /^(:)/o) {
1351 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1352
1353 substr($var, length($res), 1, $av_pend_colon);
1354 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1355 $type = 'E';
1356 } else {
1357 $type = 'N';
1358 }
1359 $av_pend_colon = 'O';
1360
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001361 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001362 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001363 $type = 'N';
1364
Andy Whitcroft0d413862008-10-15 22:02:16 -07001365 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001366 my $variant;
1367
1368 print "OPV($1)\n" if ($dbg_values > 1);
1369 if ($type eq 'V') {
1370 $variant = 'B';
1371 } else {
1372 $variant = 'U';
1373 }
1374
1375 substr($var, length($res), 1, $variant);
1376 $type = 'N';
1377
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001378 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001379 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001380 if ($1 ne '++' && $1 ne '--') {
1381 $type = 'N';
1382 }
1383
1384 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001385 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001386 }
1387 if (defined $1) {
1388 $cur = substr($cur, length($1));
1389 $res .= $type x length($1);
1390 }
1391 }
1392
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001393 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001394}
1395
Andy Whitcroft8905a672007-11-28 16:21:06 -08001396sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001397 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001398 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001399 ^(?:
1400 $Modifier|
1401 $Storage|
1402 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001403 DEFINE_\S+
1404 )$|
1405 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001406 goto|
1407 return|
1408 case|
1409 else|
1410 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001411 do|
1412 \#|
1413 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001414 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001415 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001416 )}x;
1417 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1418 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001419 # Check for modifiers.
1420 $possible =~ s/\s*$Storage\s*//g;
1421 $possible =~ s/\s*$Sparse\s*//g;
1422 if ($possible =~ /^\s*$/) {
1423
1424 } elsif ($possible =~ /\s/) {
1425 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001426 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001427 if ($modifier !~ $notPermitted) {
1428 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1429 push(@modifierList, $modifier);
1430 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001431 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001432
1433 } else {
1434 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1435 push(@typeList, $possible);
1436 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001437 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001438 } else {
1439 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001440 }
1441}
1442
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001443my $prefix = '';
1444
Joe Perches000d1cc12011-07-25 17:13:25 -07001445sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001446 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001447
Joe Perchescbec18a2014-04-03 14:49:19 -07001448 return defined $use_type{$type} if (scalar keys %use_type > 0);
1449
1450 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001451}
1452
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001453sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001454 my ($level, $type, $msg) = @_;
1455
1456 if (!show_type($type) ||
1457 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001458 return 0;
1459 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001460 my $line;
1461 if ($show_types) {
Joe Perchescbec18a2014-04-03 14:49:19 -07001462 $line = "$prefix$level:$type: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001463 } else {
Joe Perchescbec18a2014-04-03 14:49:19 -07001464 $line = "$prefix$level: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001465 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001466 $line = (split('\n', $line))[0] . "\n" if ($terse);
1467
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001468 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001469
1470 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001471}
Joe Perchescbec18a2014-04-03 14:49:19 -07001472
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001473sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001474 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001475}
Joe Perches000d1cc12011-07-25 17:13:25 -07001476
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001477sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001478 my ($type, $msg) = @_;
1479
1480 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001481 our $clean = 0;
1482 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001483 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001484 }
Joe Perches3705ce52013-07-03 15:05:31 -07001485 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001486}
1487sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001488 my ($type, $msg) = @_;
1489
1490 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001491 our $clean = 0;
1492 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001493 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001494 }
Joe Perches3705ce52013-07-03 15:05:31 -07001495 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001496}
1497sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001498 my ($type, $msg) = @_;
1499
1500 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001501 our $clean = 0;
1502 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001503 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001504 }
Joe Perches3705ce52013-07-03 15:05:31 -07001505 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001506}
1507
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001508sub check_absolute_file {
1509 my ($absolute, $herecurr) = @_;
1510 my $file = $absolute;
1511
1512 ##print "absolute<$absolute>\n";
1513
1514 # See if any suffix of this path is a path within the tree.
1515 while ($file =~ s@^[^/]*/@@) {
1516 if (-f "$root/$file") {
1517 ##print "file<$file>\n";
1518 last;
1519 }
1520 }
1521 if (! -f _) {
1522 return 0;
1523 }
1524
1525 # It is, so see if the prefix is acceptable.
1526 my $prefix = $absolute;
1527 substr($prefix, -length($file)) = '';
1528
1529 ##print "prefix<$prefix>\n";
1530 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001531 WARN("USE_RELATIVE_PATH",
1532 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001533 }
1534}
1535
Joe Perches3705ce52013-07-03 15:05:31 -07001536sub trim {
1537 my ($string) = @_;
1538
Joe Perchesb34c6482013-09-11 14:24:01 -07001539 $string =~ s/^\s+|\s+$//g;
1540
1541 return $string;
1542}
1543
1544sub ltrim {
1545 my ($string) = @_;
1546
1547 $string =~ s/^\s+//;
1548
1549 return $string;
1550}
1551
1552sub rtrim {
1553 my ($string) = @_;
1554
1555 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001556
1557 return $string;
1558}
1559
Joe Perches52ea8502013-11-12 15:10:09 -08001560sub string_find_replace {
1561 my ($string, $find, $replace) = @_;
1562
1563 $string =~ s/$find/$replace/g;
1564
1565 return $string;
1566}
1567
Joe Perches3705ce52013-07-03 15:05:31 -07001568sub tabify {
1569 my ($leading) = @_;
1570
1571 my $source_indent = 8;
1572 my $max_spaces_before_tab = $source_indent - 1;
1573 my $spaces_to_tab = " " x $source_indent;
1574
1575 #convert leading spaces to tabs
1576 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1577 #Remove spaces before a tab
1578 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1579
1580 return "$leading";
1581}
1582
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001583sub pos_last_openparen {
1584 my ($line) = @_;
1585
1586 my $pos = 0;
1587
1588 my $opens = $line =~ tr/\(/\(/;
1589 my $closes = $line =~ tr/\)/\)/;
1590
1591 my $last_openparen = 0;
1592
1593 if (($opens == 0) || ($closes >= $opens)) {
1594 return -1;
1595 }
1596
1597 my $len = length($line);
1598
1599 for ($pos = 0; $pos < $len; $pos++) {
1600 my $string = substr($line, $pos);
1601 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1602 $pos += length($1) - 1;
1603 } elsif (substr($line, $pos, 1) eq '(') {
1604 $last_openparen = $pos;
1605 } elsif (index($string, '(') == -1) {
1606 last;
1607 }
1608 }
1609
1610 return $last_openparen + 1;
1611}
1612
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001613sub process {
1614 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001615
1616 my $linenr=0;
1617 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001618 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001619 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001620 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001621
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001622 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001623 my $indent;
1624 my $previndent=0;
1625 my $stashindent=0;
1626
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001627 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001628 my $signoff = 0;
1629 my $is_patch = 0;
1630
Joe Perches15662b32011-10-31 17:13:12 -07001631 my $in_header_lines = 1;
1632 my $in_commit_log = 0; #Scanning lines before patch
1633
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001634 my $non_utf8_charset = 0;
1635
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001636 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001637 our $cnt_lines = 0;
1638 our $cnt_error = 0;
1639 our $cnt_warn = 0;
1640 our $cnt_chk = 0;
1641
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001642 # Trace the real file/line as we go.
1643 my $realfile = '';
1644 my $realline = 0;
1645 my $realcnt = 0;
1646 my $here = '';
1647 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001648 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001649 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001650 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001651
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001652 my $prev_values = 'E';
1653
1654 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001655 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001656 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001657 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001658 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001659
Joe Perches7e51f192013-09-11 14:23:57 -07001660 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001661
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001662 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001663 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001664 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001665 my @setup_docs = ();
1666 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001667
Joe Perchesd8b07712013-11-12 15:10:06 -08001668 my $camelcase_file_seeded = 0;
1669
Andy Whitcroft773647a2008-03-28 14:15:58 -07001670 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001671 my $line;
1672 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001673 $linenr++;
1674 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001675
Joe Perches3705ce52013-07-03 15:05:31 -07001676 push(@fixed, $rawline) if ($fix);
1677
Andy Whitcroft773647a2008-03-28 14:15:58 -07001678 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001679 $setup_docs = 0;
1680 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1681 $setup_docs = 1;
1682 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001683 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001684 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001685 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1686 $realline=$1-1;
1687 if (defined $2) {
1688 $realcnt=$3+1;
1689 } else {
1690 $realcnt=1+1;
1691 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001692 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001693
1694 # Guestimate if this is a continuing comment. Run
1695 # the context looking for a comment "edge". If this
1696 # edge is a close comment then we must be in a comment
1697 # at context start.
1698 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001699 my $cnt = $realcnt;
1700 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1701 next if (defined $rawlines[$ln - 1] &&
1702 $rawlines[$ln - 1] =~ /^-/);
1703 $cnt--;
1704 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001705 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001706 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1707 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1708 ($edge) = $1;
1709 last;
1710 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001711 }
1712 if (defined $edge && $edge eq '*/') {
1713 $in_comment = 1;
1714 }
1715
1716 # Guestimate if this is a continuing comment. If this
1717 # is the start of a diff block and this line starts
1718 # ' *' then it is very likely a comment.
1719 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001720 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001721 {
1722 $in_comment = 1;
1723 }
1724
1725 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1726 sanitise_line_reset($in_comment);
1727
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001728 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001729 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001730 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001731 $line = sanitise_line($rawline);
1732 }
1733 push(@lines, $line);
1734
1735 if ($realcnt > 1) {
1736 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1737 } else {
1738 $realcnt = 0;
1739 }
1740
1741 #print "==>$rawline\n";
1742 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001743
1744 if ($setup_docs && $line =~ /^\+/) {
1745 push(@setup_docs, $line);
1746 }
1747 }
1748
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001749 $prefix = '';
1750
Andy Whitcroft773647a2008-03-28 14:15:58 -07001751 $realcnt = 0;
1752 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001753 foreach my $line (@lines) {
1754 $linenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001755 my $sline = $line; #copy of $line
1756 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001757
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001758 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001759
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001760#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001761 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001762 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001763 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001764 $realline=$1-1;
1765 if (defined $2) {
1766 $realcnt=$3+1;
1767 } else {
1768 $realcnt=1+1;
1769 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001770 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001771 $prev_values = 'E';
1772
Andy Whitcroft773647a2008-03-28 14:15:58 -07001773 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001774 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001775 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001776 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001777 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001778
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001779# track the line number as we move through the hunk, note that
1780# new versions of GNU diff omit the leading space on completely
1781# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001782 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001783 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001784 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001785
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001786 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001787 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001788
1789 # Track the previous line.
1790 ($prevline, $stashline) = ($stashline, $line);
1791 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001792 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1793
Andy Whitcroft773647a2008-03-28 14:15:58 -07001794 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001795
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001796 } elsif ($realcnt == 1) {
1797 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001798 }
1799
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001800 my $hunk_line = ($realcnt != 0);
1801
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001802#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001803 $prefix = "$filename:$realline: " if ($emacs && $file);
1804 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1805
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001806 $here = "#$linenr: " if (!$file);
1807 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001808
1809 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001810 if ($line =~ /^diff --git.*?(\S+)$/) {
1811 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001812 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001813 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001814 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001815 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001816 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001817 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001818
1819 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001820 if (!$file && $tree && $p1_prefix ne '' &&
1821 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001822 WARN("PATCH_PREFIX",
1823 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001824 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001825
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001826 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001827 ERROR("MODIFIED_INCLUDE_ASM",
1828 "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 -07001829 }
1830 next;
1831 }
1832
Randy Dunlap389834b2007-06-08 13:47:03 -07001833 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001834
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001835 my $hereline = "$here\n$rawline\n";
1836 my $herecurr = "$here\n$rawline\n";
1837 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001838
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001839 $cnt_lines++ if ($realcnt != 0);
1840
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001841# Check for incorrect file permissions
1842 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1843 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001844 if ($realfile !~ m@scripts/@ &&
1845 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001846 ERROR("EXECUTE_PERMISSIONS",
1847 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001848 }
1849 }
1850
Joe Perches20112472011-07-25 17:13:23 -07001851# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001852 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001853 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001854 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001855 }
1856
1857# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001858 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001859 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001860 my $space_before = $1;
1861 my $sign_off = $2;
1862 my $space_after = $3;
1863 my $email = $4;
1864 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1865
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001866 if ($sign_off !~ /$signature_tags/) {
1867 WARN("BAD_SIGN_OFF",
1868 "Non-standard signature: $sign_off\n" . $herecurr);
1869 }
Joe Perches20112472011-07-25 17:13:23 -07001870 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07001871 if (WARN("BAD_SIGN_OFF",
1872 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1873 $fix) {
1874 $fixed[$linenr - 1] =
1875 "$ucfirst_sign_off $email";
1876 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001877 }
Joe Perches20112472011-07-25 17:13:23 -07001878 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07001879 if (WARN("BAD_SIGN_OFF",
1880 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1881 $fix) {
1882 $fixed[$linenr - 1] =
1883 "$ucfirst_sign_off $email";
1884 }
1885
Joe Perches20112472011-07-25 17:13:23 -07001886 }
1887 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07001888 if (WARN("BAD_SIGN_OFF",
1889 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1890 $fix) {
1891 $fixed[$linenr - 1] =
1892 "$ucfirst_sign_off $email";
1893 }
Joe Perches20112472011-07-25 17:13:23 -07001894 }
1895
1896 my ($email_name, $email_address, $comment) = parse_email($email);
1897 my $suggested_email = format_email(($email_name, $email_address));
1898 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001899 ERROR("BAD_SIGN_OFF",
1900 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001901 } else {
1902 my $dequoted = $suggested_email;
1903 $dequoted =~ s/^"//;
1904 $dequoted =~ s/" </ </;
1905 # Don't force email to have quotes
1906 # Allow just an angle bracketed address
1907 if ("$dequoted$comment" ne $email &&
1908 "<$email_address>$comment" ne $email &&
1909 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001910 WARN("BAD_SIGN_OFF",
1911 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001912 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001913 }
Joe Perches7e51f192013-09-11 14:23:57 -07001914
1915# Check for duplicate signatures
1916 my $sig_nospace = $line;
1917 $sig_nospace =~ s/\s//g;
1918 $sig_nospace = lc($sig_nospace);
1919 if (defined $signatures{$sig_nospace}) {
1920 WARN("BAD_SIGN_OFF",
1921 "Duplicate signature\n" . $herecurr);
1922 } else {
1923 $signatures{$sig_nospace} = 1;
1924 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001925 }
1926
Andy Whitcroft00df3442007-06-08 13:47:06 -07001927# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001928 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001929 ERROR("CORRUPTED_PATCH",
1930 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001931 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001932 }
1933
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001934# Check for absolute kernel paths.
1935 if ($tree) {
1936 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1937 my $file = $1;
1938
1939 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1940 check_absolute_file($1, $herecurr)) {
1941 #
1942 } else {
1943 check_absolute_file($file, $herecurr);
1944 }
1945 }
1946 }
1947
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001948# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1949 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001950 $rawline !~ m/^$UTF8*$/) {
1951 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1952
1953 my $blank = copy_spacing($rawline);
1954 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1955 my $hereptr = "$hereline$ptr\n";
1956
Joe Perches34d99212011-07-25 17:13:26 -07001957 CHK("INVALID_UTF8",
1958 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001959 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001960
Joe Perches15662b32011-10-31 17:13:12 -07001961# Check if it's the start of a commit log
1962# (not a header line and we haven't seen the patch filename)
1963 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001964 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001965 $in_header_lines = 0;
1966 $in_commit_log = 1;
1967 }
1968
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001969# Check if there is UTF-8 in a commit log when a mail header has explicitly
1970# declined it, i.e defined some charset where it is missing.
1971 if ($in_header_lines &&
1972 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1973 $1 !~ /utf-8/i) {
1974 $non_utf8_charset = 1;
1975 }
1976
1977 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001978 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001979 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001980 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1981 }
1982
Andy Whitcroft306708542008-10-15 22:02:28 -07001983# ignore non-hunk lines and lines being removed
1984 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001985
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001986#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001987 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001988 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07001989 if (ERROR("DOS_LINE_ENDINGS",
1990 "DOS line endings\n" . $herevet) &&
1991 $fix) {
1992 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
1993 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001994 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1995 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07001996 if (ERROR("TRAILING_WHITESPACE",
1997 "trailing whitespace\n" . $herevet) &&
1998 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07001999 $fixed[$linenr - 1] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07002000 }
2001
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002002 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002003 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07002004
Josh Triplett4783f892013-11-12 15:10:12 -08002005# Check for FSF mailing addresses.
Alexander Duyck109d8cb2014-01-23 15:54:50 -08002006 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002007 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2008 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002009 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2010 my $msg_type = \&ERROR;
2011 $msg_type = \&CHK if ($file);
2012 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002013 "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 -08002014 }
2015
Andi Kleen33549572010-05-24 14:33:29 -07002016# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002017# Only applies when adding the entry originally, after that we do not have
2018# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002019 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08002020 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002021 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002022 my $cnt = $realcnt;
2023 my $ln = $linenr + 1;
2024 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002025 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002026 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002027 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002028 $f = $lines[$ln - 1];
2029 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2030 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002031
2032 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002033
2034 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
2035 $is_start = 1;
2036 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
2037 $length = -1;
2038 }
2039
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002040 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002041 $f =~ s/#.*//;
2042 $f =~ s/^\s+//;
2043 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002044 if ($f =~ /^\s*config\s/) {
2045 $is_end = 1;
2046 last;
2047 }
Andi Kleen33549572010-05-24 14:33:29 -07002048 $length++;
2049 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002050 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08002051 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2052 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002053 }
2054
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002055# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2056 if ($realfile =~ /Kconfig/ &&
2057 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2058 WARN("CONFIG_EXPERIMENTAL",
2059 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2060 }
2061
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002062 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2063 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2064 my $flag = $1;
2065 my $replacement = {
2066 'EXTRA_AFLAGS' => 'asflags-y',
2067 'EXTRA_CFLAGS' => 'ccflags-y',
2068 'EXTRA_CPPFLAGS' => 'cppflags-y',
2069 'EXTRA_LDFLAGS' => 'ldflags-y',
2070 };
2071
2072 WARN("DEPRECATED_VARIABLE",
2073 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2074 }
2075
Rob Herringbff5da42014-01-23 15:54:51 -08002076# check for DT compatible documentation
2077 if (defined $root && $realfile =~ /\.dts/ &&
2078 $rawline =~ /^\+\s*compatible\s*=/) {
2079 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2080
2081 foreach my $compat (@compats) {
2082 my $compat2 = $compat;
2083 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2084 $compat2 =~ s/\,[a-z]*\-/\,<\.\*>\-/;
2085 `grep -Erq "$compat|$compat2" $dt_path`;
2086 if ( $? >> 8 ) {
2087 WARN("UNDOCUMENTED_DT_STRING",
2088 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2089 }
2090
Rob Herringbff5da42014-01-23 15:54:51 -08002091 my $vendor_path = $dt_path . "vendor-prefixes.txt";
2092 next if (! -f $vendor_path);
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002093 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2094 my $vendor = $1;
Rob Herringbff5da42014-01-23 15:54:51 -08002095 `grep -Eq "$vendor" $vendor_path`;
2096 if ( $? >> 8 ) {
2097 WARN("UNDOCUMENTED_DT_STRING",
2098 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vendor_path\n" . $herecurr);
2099 }
2100 }
2101 }
2102
Andy Whitcroft5368df22008-10-15 22:02:27 -07002103# check we are in a valid source file if not then ignore this hunk
2104 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2105
Joe Perches6cd7f382012-12-17 16:01:54 -08002106#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002107 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002108 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002109 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002110 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002111 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002112 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002113 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002114 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002115 }
2116
Josh Triplettca56dc02012-03-23 15:02:21 -07002117# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002118# to grep for the string. Make exceptions when the previous string ends in a
2119# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2120# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002121 if ($line =~ /^\+\s*"/ &&
2122 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002123 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002124 WARN("SPLIT_STRING",
2125 "quoted string split across lines\n" . $hereprev);
2126 }
2127
Joe Perches5e79d962010-03-05 13:43:55 -08002128# check for spaces before a quoted newline
2129 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002130 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2131 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2132 $fix) {
2133 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2134 }
2135
Joe Perches5e79d962010-03-05 13:43:55 -08002136 }
2137
Andy Whitcroft8905a672007-11-28 16:21:06 -08002138# check for adding lines without a newline.
2139 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002140 WARN("MISSING_EOF_NEWLINE",
2141 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002142 }
2143
Mike Frysinger42e41c52009-09-21 17:04:40 -07002144# Blackfin: use hi/lo macros
2145 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2146 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2147 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002148 ERROR("LO_MACRO",
2149 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002150 }
2151 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2152 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002153 ERROR("HI_MACRO",
2154 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002155 }
2156 }
2157
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002158# check we are in a valid source file C or perl if not then ignore this hunk
2159 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002160
2161# at the beginning of a line any tabs must come first and anything
2162# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002163 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2164 $rawline =~ /^\+\s* \s*/) {
2165 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002166 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002167 if (ERROR("CODE_INDENT",
2168 "code indent should use tabs where possible\n" . $herevet) &&
2169 $fix) {
2170 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2171 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002172 }
2173
Alberto Panizzo08e44362010-03-05 13:43:54 -08002174# check for space before tabs.
2175 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2176 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002177 if (WARN("SPACE_BEFORE_TAB",
2178 "please, no space before tabs\n" . $herevet) &&
2179 $fix) {
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002180 while ($fixed[$linenr - 1] =~
2181 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2182 while ($fixed[$linenr - 1] =~
2183 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002184 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002185 }
2186
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002187# check for && or || at the start of a line
2188 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2189 CHK("LOGICAL_CONTINUATIONS",
2190 "Logical continuations should be on the previous line\n" . $hereprev);
2191 }
2192
2193# check multi-line statement indentation matches previous line
2194 if ($^V && $^V ge 5.10.0 &&
2195 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
2196 $prevline =~ /^\+(\t*)(.*)$/;
2197 my $oldindent = $1;
2198 my $rest = $2;
2199
2200 my $pos = pos_last_openparen($rest);
2201 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002202 $line =~ /^(\+| )([ \t]*)/;
2203 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002204
2205 my $goodtabindent = $oldindent .
2206 "\t" x ($pos / 8) .
2207 " " x ($pos % 8);
2208 my $goodspaceindent = $oldindent . " " x $pos;
2209
2210 if ($newindent ne $goodtabindent &&
2211 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002212
2213 if (CHK("PARENTHESIS_ALIGNMENT",
2214 "Alignment should match open parenthesis\n" . $hereprev) &&
2215 $fix && $line =~ /^\+/) {
2216 $fixed[$linenr - 1] =~
2217 s/^\+[ \t]*/\+$goodtabindent/;
2218 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002219 }
2220 }
2221 }
2222
Joe Perches23f780c2013-07-03 15:05:31 -07002223 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002224 if (CHK("SPACING",
2225 "No space is necessary after a cast\n" . $hereprev) &&
2226 $fix) {
2227 $fixed[$linenr - 1] =~
2228 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2229 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002230 }
2231
Joe Perches05880602012-10-04 17:13:35 -07002232 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002233 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002234 $rawline =~ /^\+[ \t]*\*/ &&
2235 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002236 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2237 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2238 }
2239
2240 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002241 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2242 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002243 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002244 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2245 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2246 "networking block comments start with * on subsequent lines\n" . $hereprev);
2247 }
2248
2249 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002250 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2251 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2252 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2253 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002254 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2255 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2256 }
2257
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002258# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002259# Exceptions:
2260# 1) within comments
2261# 2) indented preprocessor commands
2262# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002263 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002264 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002265 if (WARN("LEADING_SPACE",
2266 "please, no spaces at the start of a line\n" . $herevet) &&
2267 $fix) {
2268 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2269 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002270 }
2271
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002272# check we are in a valid C source file if not then ignore this hunk
2273 next if ($realfile !~ /\.(h|c)$/);
2274
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002275# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2276 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2277 WARN("CONFIG_EXPERIMENTAL",
2278 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2279 }
2280
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002281# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002282 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002283 WARN("CVS_KEYWORD",
2284 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002285 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002286
Mike Frysinger42e41c52009-09-21 17:04:40 -07002287# Blackfin: don't use __builtin_bfin_[cs]sync
2288 if ($line =~ /__builtin_bfin_csync/) {
2289 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002290 ERROR("CSYNC",
2291 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002292 }
2293 if ($line =~ /__builtin_bfin_ssync/) {
2294 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002295 ERROR("SSYNC",
2296 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002297 }
2298
Joe Perches56e77d72013-02-21 16:44:14 -08002299# check for old HOTPLUG __dev<foo> section markings
2300 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2301 WARN("HOTPLUG_SECTION",
2302 "Using $1 is unnecessary\n" . $herecurr);
2303 }
2304
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002305# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002306 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2307 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002308#print "LINE<$line>\n";
2309 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002310 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002311 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002312 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002313 $stat =~ s/\n./\n /g;
2314 $cond =~ s/\n./\n /g;
2315
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002316#print "linenr<$linenr> <$stat>\n";
2317 # If this statement has no statement boundaries within
2318 # it there is no point in retrying a statement scan
2319 # until we hit end of it.
2320 my $frag = $stat; $frag =~ s/;+\s*$//;
2321 if ($frag !~ /(?:{|;)/) {
2322#print "skip<$line_nr_next>\n";
2323 $suppress_statement = $line_nr_next;
2324 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002325
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002326 # Find the real next line.
2327 $realline_next = $line_nr_next;
2328 if (defined $realline_next &&
2329 (!defined $lines[$realline_next - 1] ||
2330 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2331 $realline_next++;
2332 }
2333
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002334 my $s = $stat;
2335 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002336
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002337 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002338 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002339
2340 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002341 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002342
Andy Whitcroft463f2862009-09-21 17:04:34 -07002343 } elsif ($s =~ /^.\s*else\b/s) {
2344
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002345 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002346 } 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 -07002347 my $type = $1;
2348 $type =~ s/\s+/ /g;
2349 possible($type, "A:" . $s);
2350
Andy Whitcroft8905a672007-11-28 16:21:06 -08002351 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002352 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002353 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002354 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002355
2356 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002357 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002358 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002359 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002360
2361 # Check for any sort of function declaration.
2362 # int foo(something bar, other baz);
2363 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002364 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 -08002365 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002366
Andy Whitcroftcf655042008-03-04 14:28:20 -08002367 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002368 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002369 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002370
Andy Whitcroft8905a672007-11-28 16:21:06 -08002371 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002372 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002373
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002374 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002375 }
2376 }
2377 }
2378
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002379 }
2380
Andy Whitcroft653d4872007-06-23 17:16:34 -07002381#
2382# Checks which may be anchored in the context.
2383#
2384
2385# Check for switch () and associated case and default
2386# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002387 if ($line=~/\bswitch\s*\(.*\)/) {
2388 my $err = '';
2389 my $sep = '';
2390 my @ctx = ctx_block_outer($linenr, $realcnt);
2391 shift(@ctx);
2392 for my $ctx (@ctx) {
2393 my ($clen, $cindent) = line_stats($ctx);
2394 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2395 $indent != $cindent) {
2396 $err .= "$sep$ctx\n";
2397 $sep = '';
2398 } else {
2399 $sep = "[...]\n";
2400 }
2401 }
2402 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002403 ERROR("SWITCH_CASE_INDENT_LEVEL",
2404 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002405 }
2406 }
2407
2408# if/while/etc brace do not go on next line, unless defining a do while loop,
2409# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002410 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002411 my $pre_ctx = "$1$2";
2412
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002413 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002414
2415 if ($line =~ /^\+\t{6,}/) {
2416 WARN("DEEP_INDENTATION",
2417 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2418 }
2419
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002420 my $ctx_cnt = $realcnt - $#ctx - 1;
2421 my $ctx = join("\n", @ctx);
2422
Andy Whitcroft548596d2008-07-23 21:29:01 -07002423 my $ctx_ln = $linenr;
2424 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002425
Andy Whitcroft548596d2008-07-23 21:29:01 -07002426 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2427 defined $lines[$ctx_ln - 1] &&
2428 $lines[$ctx_ln - 1] =~ /^-/)) {
2429 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2430 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002431 $ctx_ln++;
2432 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002433
Andy Whitcroft53210162008-07-23 21:29:03 -07002434 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2435 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002436
2437 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002438 ERROR("OPEN_BRACE",
2439 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002440 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002441 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002442 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2443 $ctx =~ /\)\s*\;\s*$/ &&
2444 defined $lines[$ctx_ln - 1])
2445 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002446 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2447 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002448 WARN("TRAILING_SEMICOLON",
2449 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002450 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002451 }
2452 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002453 }
2454
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002455# Check relative indent for conditionals and blocks.
2456 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002457 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2458 ctx_statement_block($linenr, $realcnt, 0)
2459 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002460 my ($s, $c) = ($stat, $cond);
2461
2462 substr($s, 0, length($c), '');
2463
2464 # Make sure we remove the line prefixes as we have
2465 # none on the first line, and are going to readd them
2466 # where necessary.
2467 $s =~ s/\n./\n/gs;
2468
2469 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002470 my @newlines = ($c =~ /\n/gs);
2471 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002472
2473 # We want to check the first line inside the block
2474 # starting at the end of the conditional, so remove:
2475 # 1) any blank line termination
2476 # 2) any opening brace { on end of the line
2477 # 3) any do (...) {
2478 my $continuation = 0;
2479 my $check = 0;
2480 $s =~ s/^.*\bdo\b//;
2481 $s =~ s/^\s*{//;
2482 if ($s =~ s/^\s*\\//) {
2483 $continuation = 1;
2484 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002485 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002486 $check = 1;
2487 $cond_lines++;
2488 }
2489
2490 # Also ignore a loop construct at the end of a
2491 # preprocessor statement.
2492 if (($prevline =~ /^.\s*#\s*define\s/ ||
2493 $prevline =~ /\\\s*$/) && $continuation == 0) {
2494 $check = 0;
2495 }
2496
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002497 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002498 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002499 while ($cond_ptr != $cond_lines) {
2500 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002501
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002502 # If we see an #else/#elif then the code
2503 # is not linear.
2504 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2505 $check = 0;
2506 }
2507
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002508 # Ignore:
2509 # 1) blank lines, they should be at 0,
2510 # 2) preprocessor lines, and
2511 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002512 if ($continuation ||
2513 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002514 $s =~ /^\s*#\s*?/ ||
2515 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002516 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002517 if ($s =~ s/^.*?\n//) {
2518 $cond_lines++;
2519 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002520 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002521 }
2522
2523 my (undef, $sindent) = line_stats("+" . $s);
2524 my $stat_real = raw_line($linenr, $cond_lines);
2525
2526 # Check if either of these lines are modified, else
2527 # this is not this patch's fault.
2528 if (!defined($stat_real) ||
2529 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2530 $check = 0;
2531 }
2532 if (defined($stat_real) && $cond_lines > 1) {
2533 $stat_real = "[...]\n$stat_real";
2534 }
2535
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002536 #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 -07002537
2538 if ($check && (($sindent % 8) != 0 ||
2539 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002540 WARN("SUSPECT_CODE_INDENT",
2541 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002542 }
2543 }
2544
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002545 # Track the 'values' across context and added lines.
2546 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002547 my ($curr_values, $curr_vars) =
2548 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002549 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002550 if ($dbg_values) {
2551 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002552 print "$linenr > .$outline\n";
2553 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002554 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002555 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002556 $prev_values = substr($curr_values, -1);
2557
Andy Whitcroft00df3442007-06-08 13:47:06 -07002558#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002559 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002560
Andy Whitcroft653d4872007-06-23 17:16:34 -07002561# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002562 if ($dbg_type) {
2563 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002564 ERROR("TEST_TYPE",
2565 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002566 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002567 ERROR("TEST_NOT_TYPE",
2568 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002569 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002570 next;
2571 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002572# TEST: allow direct testing of the attribute matcher.
2573 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002574 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002575 ERROR("TEST_ATTR",
2576 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002577 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002578 ERROR("TEST_NOT_ATTR",
2579 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002580 }
2581 next;
2582 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002583
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002584# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002585 if ($line =~ /^.\s*{/ &&
2586 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002587 ERROR("OPEN_BRACE",
2588 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002589 }
2590
Andy Whitcroft653d4872007-06-23 17:16:34 -07002591#
2592# Checks which are anchored on the added line.
2593#
2594
2595# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002596 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002597 my $path = $1;
2598 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002599 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002600 "malformed #include filename\n" . $herecurr);
2601 }
2602 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2603 ERROR("UAPI_INCLUDE",
2604 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002605 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002606 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002607
2608# no C99 // comments
2609 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002610 if (ERROR("C99_COMMENTS",
2611 "do not use C99 // comments\n" . $herecurr) &&
2612 $fix) {
2613 my $line = $fixed[$linenr - 1];
2614 if ($line =~ /\/\/(.*)$/) {
2615 my $comment = trim($1);
2616 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2617 }
2618 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002619 }
2620 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002621 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002622 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002623
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002624# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2625# the whole statement.
2626#print "APW <$lines[$realline_next - 1]>\n";
2627 if (defined $realline_next &&
2628 exists $lines[$realline_next - 1] &&
2629 !defined $suppress_export{$realline_next} &&
2630 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2631 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002632 # Handle definitions which produce identifiers with
2633 # a prefix:
2634 # XXX(foo);
2635 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002636 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002637 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002638 $name =~ /^${Ident}_$2/) {
2639#print "FOO C name<$name>\n";
2640 $suppress_export{$realline_next} = 1;
2641
2642 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002643 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002644 ^.DEFINE_$Ident\(\Q$name\E\)|
2645 ^.DECLARE_$Ident\(\Q$name\E\)|
2646 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002647 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2648 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002649 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002650#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2651 $suppress_export{$realline_next} = 2;
2652 } else {
2653 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002654 }
2655 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002656 if (!defined $suppress_export{$linenr} &&
2657 $prevline =~ /^.\s*$/ &&
2658 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2659 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2660#print "FOO B <$lines[$linenr - 1]>\n";
2661 $suppress_export{$linenr} = 2;
2662 }
2663 if (defined $suppress_export{$linenr} &&
2664 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002665 WARN("EXPORT_SYMBOL",
2666 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002667 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002668
Joe Eloff5150bda2010-08-09 17:21:00 -07002669# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002670 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2671 if (ERROR("GLOBAL_INITIALISERS",
2672 "do not initialise globals to 0 or NULL\n" .
2673 $herecurr) &&
2674 $fix) {
2675 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2676 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002677 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002678# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002679 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2680 if (ERROR("INITIALISED_STATIC",
2681 "do not initialise statics to 0 or NULL\n" .
2682 $herecurr) &&
2683 $fix) {
2684 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2685 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002686 }
2687
Joe Perchescb710ec2010-10-26 14:23:20 -07002688# check for static const char * arrays.
2689 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002690 WARN("STATIC_CONST_CHAR_ARRAY",
2691 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002692 $herecurr);
2693 }
2694
2695# check for static char foo[] = "bar" declarations.
2696 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002697 WARN("STATIC_CONST_CHAR_ARRAY",
2698 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002699 $herecurr);
2700 }
2701
Joe Perches9b0fa602014-04-03 14:49:18 -07002702# check for non-global char *foo[] = {"bar", ...} declarations.
2703 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
2704 WARN("STATIC_CONST_CHAR_ARRAY",
2705 "char * array declaration might be better as static const\n" .
2706 $herecurr);
2707 }
2708
Joe Perchesb36190c2014-01-27 17:07:18 -08002709# check for function declarations without arguments like "int foo()"
2710 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2711 if (ERROR("FUNCTION_WITHOUT_ARGS",
2712 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2713 $fix) {
2714 $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2715 }
2716 }
2717
Joe Perches92e112f2013-12-13 11:36:22 -07002718# check for uses of DEFINE_PCI_DEVICE_TABLE
2719 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2720 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2721 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2722 $fix) {
2723 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2724 }
Joe Perches93ed0e22010-10-26 14:23:21 -07002725 }
2726
Andy Whitcroft653d4872007-06-23 17:16:34 -07002727# check for new typedefs, only function parameters and sparse annotations
2728# make sense.
2729 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002730 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002731 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002732 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002733 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002734 WARN("NEW_TYPEDEFS",
2735 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002736 }
2737
2738# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002739 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002740 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2741 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002742 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002743
Andy Whitcroft65863862009-01-06 14:41:21 -08002744 # Should start with a space.
2745 $to =~ s/^(\S)/ $1/;
2746 # Should not end with a space.
2747 $to =~ s/\s+$//;
2748 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002749 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002750 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002751
Joe Perches3705ce52013-07-03 15:05:31 -07002752## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08002753 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07002754 if (ERROR("POINTER_LOCATION",
2755 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2756 $fix) {
2757 my $sub_from = $ident;
2758 my $sub_to = $ident;
2759 $sub_to =~ s/\Q$from\E/$to/;
2760 $fixed[$linenr - 1] =~
2761 s@\Q$sub_from\E@$sub_to@;
2762 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002763 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002764 }
2765 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2766 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002767 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002768
Andy Whitcroft65863862009-01-06 14:41:21 -08002769 # Should start with a space.
2770 $to =~ s/^(\S)/ $1/;
2771 # Should not end with a space.
2772 $to =~ s/\s+$//;
2773 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002774 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002775 }
2776 # Modifiers should have spaces.
2777 $to =~ s/(\b$Modifier$)/$1 /;
2778
Joe Perches3705ce52013-07-03 15:05:31 -07002779## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08002780 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002781 if (ERROR("POINTER_LOCATION",
2782 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2783 $fix) {
2784
2785 my $sub_from = $match;
2786 my $sub_to = $match;
2787 $sub_to =~ s/\Q$from\E/$to/;
2788 $fixed[$linenr - 1] =~
2789 s@\Q$sub_from\E@$sub_to@;
2790 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002791 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002792 }
2793
2794# # no BUG() or BUG_ON()
2795# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2796# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2797# print "$herecurr";
2798# $clean = 0;
2799# }
2800
Andy Whitcroft8905a672007-11-28 16:21:06 -08002801 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002802 WARN("LINUX_VERSION_CODE",
2803 "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 -08002804 }
2805
Joe Perches17441222011-06-15 15:08:17 -07002806# check for uses of printk_ratelimit
2807 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002808 WARN("PRINTK_RATELIMITED",
2809"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002810 }
2811
Andy Whitcroft00df3442007-06-08 13:47:06 -07002812# printk should use KERN_* levels. Note that follow on printk's on the
2813# same line do not need a level, so we use the current block context
2814# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002815# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002816# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002817 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002818 my $ok = 0;
2819 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2820 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002821 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07002822 # with "\n" ignore it, else it is to blame
2823 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2824 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2825 $ok = 1;
2826 }
2827 last;
2828 }
2829 }
2830 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002831 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2832 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002833 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002834 }
2835
Joe Perches243f3802012-05-31 16:26:09 -07002836 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2837 my $orig = $1;
2838 my $level = lc($orig);
2839 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002840 my $level2 = $level;
2841 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002842 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07002843 "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 -07002844 }
2845
2846 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002847 if (WARN("PREFER_PR_LEVEL",
2848 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2849 $fix) {
2850 $fixed[$linenr - 1] =~
2851 s/\bpr_warning\b/pr_warn/;
2852 }
Joe Perches243f3802012-05-31 16:26:09 -07002853 }
2854
Joe Perchesdc139312013-02-21 16:44:13 -08002855 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2856 my $orig = $1;
2857 my $level = lc($orig);
2858 $level = "warn" if ($level eq "warning");
2859 $level = "dbg" if ($level eq "debug");
2860 WARN("PREFER_DEV_LEVEL",
2861 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2862 }
2863
Andy Whitcroft653d4872007-06-23 17:16:34 -07002864# function brace can't be on same line, except for #defines of do while,
2865# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002866 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2867 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002868 ERROR("OPEN_BRACE",
2869 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002870 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002871
Andy Whitcroft8905a672007-11-28 16:21:06 -08002872# open braces for enum, union and struct go on the same line.
2873 if ($line =~ /^.\s*{/ &&
2874 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002875 ERROR("OPEN_BRACE",
2876 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002877 }
2878
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002879# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07002880 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2881 if (WARN("SPACING",
2882 "missing space after $1 definition\n" . $herecurr) &&
2883 $fix) {
2884 $fixed[$linenr - 1] =~
2885 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2886 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002887 }
2888
Joe Perches31070b52014-01-23 15:54:49 -08002889# Function pointer declarations
2890# check spacing between type, funcptr, and args
2891# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002892 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08002893 my $declare = $1;
2894 my $pre_pointer_space = $2;
2895 my $post_pointer_space = $3;
2896 my $funcname = $4;
2897 my $post_funcname_space = $5;
2898 my $pre_args_space = $6;
2899
Joe Perches91f72e92014-04-03 14:49:12 -07002900# the $Declare variable will capture all spaces after the type
2901# so check it for a missing trailing missing space but pointer return types
2902# don't need a space so don't warn for those.
2903 my $post_declare_space = "";
2904 if ($declare =~ /(\s+)$/) {
2905 $post_declare_space = $1;
2906 $declare = rtrim($declare);
2907 }
2908 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08002909 WARN("SPACING",
2910 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07002911 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08002912 }
2913
2914# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002915# This test is not currently implemented because these declarations are
2916# equivalent to
2917# int foo(int bar, ...)
2918# and this is form shouldn't/doesn't generate a checkpatch warning.
2919#
2920# elsif ($declare =~ /\s{2,}$/) {
2921# WARN("SPACING",
2922# "Multiple spaces after return type\n" . $herecurr);
2923# }
Joe Perches31070b52014-01-23 15:54:49 -08002924
2925# unnecessary space "type ( *funcptr)(args...)"
2926 if (defined $pre_pointer_space &&
2927 $pre_pointer_space =~ /^\s/) {
2928 WARN("SPACING",
2929 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
2930 }
2931
2932# unnecessary space "type (* funcptr)(args...)"
2933 if (defined $post_pointer_space &&
2934 $post_pointer_space =~ /^\s/) {
2935 WARN("SPACING",
2936 "Unnecessary space before function pointer name\n" . $herecurr);
2937 }
2938
2939# unnecessary space "type (*funcptr )(args...)"
2940 if (defined $post_funcname_space &&
2941 $post_funcname_space =~ /^\s/) {
2942 WARN("SPACING",
2943 "Unnecessary space after function pointer name\n" . $herecurr);
2944 }
2945
2946# unnecessary space "type (*funcptr) (args...)"
2947 if (defined $pre_args_space &&
2948 $pre_args_space =~ /^\s/) {
2949 WARN("SPACING",
2950 "Unnecessary space before function pointer arguments\n" . $herecurr);
2951 }
2952
2953 if (show_type("SPACING") && $fix) {
2954 $fixed[$linenr - 1] =~
Joe Perches91f72e92014-04-03 14:49:12 -07002955 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08002956 }
2957 }
2958
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002959# check for spacing round square brackets; allowed:
2960# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002961# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2962# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002963 while ($line =~ /(.*?\s)\[/g) {
2964 my ($where, $prefix) = ($-[1], $1);
2965 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002966 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002967 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002968 if (ERROR("BRACKET_SPACE",
2969 "space prohibited before open square bracket '['\n" . $herecurr) &&
2970 $fix) {
2971 $fixed[$linenr - 1] =~
2972 s/^(\+.*?)\s+\[/$1\[/;
2973 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002974 }
2975 }
2976
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002977# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002978 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002979 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002980 my $ctx_before = substr($line, 0, $-[1]);
2981 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002982
2983 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002984 if ($name =~ /^(?:
2985 if|for|while|switch|return|case|
2986 volatile|__volatile__|
2987 __attribute__|format|__extension__|
2988 asm|__asm__)$/x)
2989 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002990 # cpp #define statements have non-optional spaces, ie
2991 # if there is a space between the name and the open
2992 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002993 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002994
2995 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002996 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002997
2998 # If this whole things ends with a type its most
2999 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003000 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003001
3002 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003003 if (WARN("SPACING",
3004 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3005 $fix) {
3006 $fixed[$linenr - 1] =~
3007 s/\b$name\s+\(/$name\(/;
3008 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003009 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003010 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003011
Andy Whitcroft653d4872007-06-23 17:16:34 -07003012# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003013 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003014 my $fixed_line = "";
3015 my $line_fixed = 0;
3016
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003017 my $ops = qr{
3018 <<=|>>=|<=|>=|==|!=|
3019 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3020 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003021 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003022 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003023 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003024 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003025
3026## print("element count: <" . $#elements . ">\n");
3027## foreach my $el (@elements) {
3028## print("el: <$el>\n");
3029## }
3030
3031 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003032 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003033
Joe Perches3705ce52013-07-03 15:05:31 -07003034 foreach my $el (@elements) {
3035 push(@fix_elements, substr($rawline, $off, length($el)));
3036 $off += length($el);
3037 }
3038
3039 $off = 0;
3040
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003041 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003042 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003043
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003044 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003045
3046 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3047
3048## print("n: <$n> good: <$good>\n");
3049
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003050 $off += length($elements[$n]);
3051
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003052 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003053 my $ca = substr($opline, 0, $off);
3054 my $cc = '';
3055 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3056 $cc = substr($opline, $off + length($elements[$n + 1]));
3057 }
3058 my $cb = "$ca$;$cc";
3059
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003060 my $a = '';
3061 $a = 'V' if ($elements[$n] ne '');
3062 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003063 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003064 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3065 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003066 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003067
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003068 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003069
3070 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003071 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003072 $c = 'V' if ($elements[$n + 2] ne '');
3073 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003074 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003075 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3076 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003077 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003078 } else {
3079 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003080 }
3081
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003082 my $ctx = "${a}x${c}";
3083
3084 my $at = "(ctx:$ctx)";
3085
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003086 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003087 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003088
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003089 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003090 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003091
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003092 # Get the full operator variant.
3093 my $opv = $op . substr($curr_vars, $off, 1);
3094
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003095 # Ignore operators passed as parameters.
3096 if ($op_type ne 'V' &&
3097 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3098
Andy Whitcroftcf655042008-03-04 14:28:20 -08003099# # Ignore comments
3100# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003101
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003102 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003103 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003104 if ($ctx !~ /.x[WEBC]/ &&
3105 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003106 if (ERROR("SPACING",
3107 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003108 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003109 $line_fixed = 1;
3110 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003111 }
3112
3113 # // is a comment
3114 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003115
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003116 # No spaces for:
3117 # ->
3118 # : when part of a bitfield
3119 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003120 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003121 if (ERROR("SPACING",
3122 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003123 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003124 if (defined $fix_elements[$n + 2]) {
3125 $fix_elements[$n + 2] =~ s/^\s+//;
3126 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003127 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003128 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003129 }
3130
3131 # , must have a space on the right.
3132 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003133 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003134 if (ERROR("SPACING",
3135 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003136 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003137 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003138 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07003139 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003140 }
3141
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003142 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003143 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003144 #warn "'*' is part of type\n";
3145
3146 # unary operators should have a space before and
3147 # none after. May be left adjacent to another
3148 # unary operator, or a cast
3149 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003150 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003151 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003152 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003153 if (ERROR("SPACING",
3154 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003155 if ($n != $last_after + 2) {
3156 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3157 $line_fixed = 1;
3158 }
Joe Perches3705ce52013-07-03 15:05:31 -07003159 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003160 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003161 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003162 # A unary '*' may be const
3163
3164 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003165 if (ERROR("SPACING",
3166 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003167 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003168 if (defined $fix_elements[$n + 2]) {
3169 $fix_elements[$n + 2] =~ s/^\s+//;
3170 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003171 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003172 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003173 }
3174
3175 # unary ++ and unary -- are allowed no space on one side.
3176 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003177 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003178 if (ERROR("SPACING",
3179 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003180 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003181 $line_fixed = 1;
3182 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003183 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003184 if ($ctx =~ /Wx[BE]/ ||
3185 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003186 if (ERROR("SPACING",
3187 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003188 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003189 $line_fixed = 1;
3190 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003191 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003192 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003193 if (ERROR("SPACING",
3194 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003195 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003196 if (defined $fix_elements[$n + 2]) {
3197 $fix_elements[$n + 2] =~ s/^\s+//;
3198 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003199 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003200 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003201 }
3202
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003203 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003204 } elsif ($op eq '<<' or $op eq '>>' or
3205 $op eq '&' or $op eq '^' or $op eq '|' or
3206 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003207 $op eq '*' or $op eq '/' or
3208 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003209 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003210 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003211 if (ERROR("SPACING",
3212 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003213 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3214 if (defined $fix_elements[$n + 2]) {
3215 $fix_elements[$n + 2] =~ s/^\s+//;
3216 }
Joe Perches3705ce52013-07-03 15:05:31 -07003217 $line_fixed = 1;
3218 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003219 }
3220
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003221 # A colon needs no spaces before when it is
3222 # terminating a case value or a label.
3223 } elsif ($opv eq ':C' || $opv eq ':L') {
3224 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003225 if (ERROR("SPACING",
3226 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003227 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003228 $line_fixed = 1;
3229 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003230 }
3231
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003232 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003233 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003234 my $ok = 0;
3235
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003236 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003237 if (($op eq '<' &&
3238 $cc =~ /^\S+\@\S+>/) ||
3239 ($op eq '>' &&
3240 $ca =~ /<\S+\@\S+$/))
3241 {
3242 $ok = 1;
3243 }
3244
Joe Perches84731622013-11-12 15:10:05 -08003245 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003246 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003247 my $msg_type = \&ERROR;
3248 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3249
3250 if (&{$msg_type}("SPACING",
3251 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003252 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3253 if (defined $fix_elements[$n + 2]) {
3254 $fix_elements[$n + 2] =~ s/^\s+//;
3255 }
Joe Perches3705ce52013-07-03 15:05:31 -07003256 $line_fixed = 1;
3257 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003258 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003259 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003260 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003261
3262## print("n: <$n> GOOD: <$good>\n");
3263
3264 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003265 }
Joe Perches3705ce52013-07-03 15:05:31 -07003266
3267 if (($#elements % 2) == 0) {
3268 $fixed_line = $fixed_line . $fix_elements[$#elements];
3269 }
3270
3271 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3272 $fixed[$linenr - 1] = $fixed_line;
3273 }
3274
3275
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003276 }
3277
Joe Perches786b6322013-07-03 15:05:32 -07003278# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003279 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003280 if (WARN("SPACING",
3281 "space prohibited before semicolon\n" . $herecurr) &&
3282 $fix) {
3283 1 while $fixed[$linenr - 1] =~
3284 s/^(\+.*\S)\s+;/$1;/;
3285 }
3286 }
3287
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003288# check for multiple assignments
3289 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003290 CHK("MULTIPLE_ASSIGNMENTS",
3291 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003292 }
3293
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003294## # check for multiple declarations, allowing for a function declaration
3295## # continuation.
3296## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3297## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3298##
3299## # Remove any bracketed sections to ensure we do not
3300## # falsly report the parameters of functions.
3301## my $ln = $line;
3302## while ($ln =~ s/\([^\(\)]*\)//g) {
3303## }
3304## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003305## WARN("MULTIPLE_DECLARATION",
3306## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003307## }
3308## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003309
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003310#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003311 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3312 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003313 if (ERROR("SPACING",
3314 "space required before the open brace '{'\n" . $herecurr) &&
3315 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003316 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003317 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003318 }
3319
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003320## # check for blank lines before declarations
3321## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3322## $prevrawline =~ /^.\s*$/) {
3323## WARN("SPACING",
3324## "No blank lines before declarations\n" . $hereprev);
3325## }
3326##
3327
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003328# closing brace should have a space following it when it has anything
3329# on the line
3330 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003331 if (ERROR("SPACING",
3332 "space required after that close brace '}'\n" . $herecurr) &&
3333 $fix) {
3334 $fixed[$linenr - 1] =~
3335 s/}((?!(?:,|;|\)))\S)/} $1/;
3336 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003337 }
3338
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003339# check spacing on square brackets
3340 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003341 if (ERROR("SPACING",
3342 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3343 $fix) {
3344 $fixed[$linenr - 1] =~
3345 s/\[\s+/\[/;
3346 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003347 }
3348 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003349 if (ERROR("SPACING",
3350 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3351 $fix) {
3352 $fixed[$linenr - 1] =~
3353 s/\s+\]/\]/;
3354 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003355 }
3356
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003357# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003358 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3359 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003360 if (ERROR("SPACING",
3361 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3362 $fix) {
3363 $fixed[$linenr - 1] =~
3364 s/\(\s+/\(/;
3365 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003366 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003367 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003368 $line !~ /for\s*\(.*;\s+\)/ &&
3369 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003370 if (ERROR("SPACING",
3371 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3372 $fix) {
3373 $fixed[$linenr - 1] =~
3374 s/\s+\)/\)/;
3375 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003376 }
3377
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003378#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003379 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003380 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003381 if (WARN("INDENTED_LABEL",
3382 "labels should not be indented\n" . $herecurr) &&
3383 $fix) {
3384 $fixed[$linenr - 1] =~
3385 s/^(.)\s+/$1/;
3386 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003387 }
3388
Joe Perches5b9553a2014-04-03 14:49:21 -07003389# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003390 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003391 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003392 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003393 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3394 my $value = $1;
3395 $value = deparenthesize($value);
3396 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3397 ERROR("RETURN_PARENTHESES",
3398 "return is not a function, parentheses are not required\n" . $herecurr);
3399 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003400 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003401 ERROR("SPACING",
3402 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003403 }
3404 }
Joe Perches507e5142013-11-12 15:10:13 -08003405
Joe Perches189248d2014-01-23 15:54:47 -08003406# if statements using unnecessary parentheses - ie: if ((foo == bar))
3407 if ($^V && $^V ge 5.10.0 &&
3408 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3409 my $openparens = $1;
3410 my $count = $openparens =~ tr@\(@\(@;
3411 my $msg = "";
3412 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3413 my $comp = $4; #Not $1 because of $LvalOrFunc
3414 $msg = " - maybe == should be = ?" if ($comp eq "==");
3415 WARN("UNNECESSARY_PARENTHESES",
3416 "Unnecessary parentheses$msg\n" . $herecurr);
3417 }
3418 }
3419
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003420# Return of what appears to be an errno should normally be -'ve
3421 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3422 my $name = $1;
3423 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003424 WARN("USE_NEGATIVE_ERRNO",
3425 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003426 }
3427 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003428
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003429# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003430 if ($line =~ /\b(if|while|for|switch)\(/) {
3431 if (ERROR("SPACING",
3432 "space required before the open parenthesis '('\n" . $herecurr) &&
3433 $fix) {
3434 $fixed[$linenr - 1] =~
3435 s/\b(if|while|for|switch)\(/$1 \(/;
3436 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003437 }
3438
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003439# Check for illegal assignment in if conditional -- and check for trailing
3440# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003441 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003442 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3443 ctx_statement_block($linenr, $realcnt, 0)
3444 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003445 my ($stat_next) = ctx_statement_block($line_nr_next,
3446 $remain_next, $off_next);
3447 $stat_next =~ s/\n./\n /g;
3448 ##print "stat<$stat> stat_next<$stat_next>\n";
3449
3450 if ($stat_next =~ /^\s*while\b/) {
3451 # If the statement carries leading newlines,
3452 # then count those as offsets.
3453 my ($whitespace) =
3454 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3455 my $offset =
3456 statement_rawlines($whitespace) - 1;
3457
3458 $suppress_whiletrailers{$line_nr_next +
3459 $offset} = 1;
3460 }
3461 }
3462 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003463 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003464 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003465 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003466
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003467 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003468 ERROR("ASSIGN_IN_IF",
3469 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003470 }
3471
3472 # Find out what is on the end of the line after the
3473 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003474 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003475 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003476 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003477 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3478 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003479 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003480 # Find out how long the conditional actually is.
3481 my @newlines = ($c =~ /\n/gs);
3482 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003483 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003484
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003485 $stat_real = raw_line($linenr, $cond_lines)
3486 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003487 if (defined($stat_real) && $cond_lines > 1) {
3488 $stat_real = "[...]\n$stat_real";
3489 }
3490
Joe Perches000d1cc12011-07-25 17:13:25 -07003491 ERROR("TRAILING_STATEMENTS",
3492 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003493 }
3494 }
3495
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003496# Check for bitwise tests written as boolean
3497 if ($line =~ /
3498 (?:
3499 (?:\[|\(|\&\&|\|\|)
3500 \s*0[xX][0-9]+\s*
3501 (?:\&\&|\|\|)
3502 |
3503 (?:\&\&|\|\|)
3504 \s*0[xX][0-9]+\s*
3505 (?:\&\&|\|\||\)|\])
3506 )/x)
3507 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003508 WARN("HEXADECIMAL_BOOLEAN_TEST",
3509 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003510 }
3511
Andy Whitcroft8905a672007-11-28 16:21:06 -08003512# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003513 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3514 my $s = $1;
3515 $s =~ s/$;//g; # Remove any comments
3516 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003517 ERROR("TRAILING_STATEMENTS",
3518 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003519 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003520 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003521# if should not continue a brace
3522 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003523 ERROR("TRAILING_STATEMENTS",
3524 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003525 $herecurr);
3526 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003527# case and default should not have general statements after them
3528 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3529 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003530 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003531 \s*return\s+
3532 )/xg)
3533 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003534 ERROR("TRAILING_STATEMENTS",
3535 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003536 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003537
3538 # Check for }<nl>else {, these must be at the same
3539 # indent level to be relevant to each other.
3540 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3541 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003542 ERROR("ELSE_AFTER_BRACE",
3543 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003544 }
3545
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003546 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3547 $previndent == $indent) {
3548 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3549
3550 # Find out what is on the end of the line after the
3551 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003552 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003553 $s =~ s/\n.*//g;
3554
3555 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003556 ERROR("WHILE_AFTER_BRACE",
3557 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003558 }
3559 }
3560
Joe Perches95e2c602013-07-03 15:05:20 -07003561#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003562 while ($line =~ m{($Constant|$Lval)}g) {
3563 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003564
3565#gcc binary extension
3566 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003567 if (WARN("GCC_BINARY_CONSTANT",
3568 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3569 $fix) {
3570 my $hexval = sprintf("0x%x", oct($var));
3571 $fixed[$linenr - 1] =~
3572 s/\b$var\b/$hexval/;
3573 }
Joe Perches95e2c602013-07-03 15:05:20 -07003574 }
3575
3576#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003577 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003578 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003579#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003580 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003581#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003582 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003583 while ($var =~ m{($Ident)}g) {
3584 my $word = $1;
3585 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08003586 if ($check) {
3587 seed_camelcase_includes();
3588 if (!$file && !$camelcase_file_seeded) {
3589 seed_camelcase_file($realfile);
3590 $camelcase_file_seeded = 1;
3591 }
3592 }
Joe Perches7e781f62013-09-11 14:23:55 -07003593 if (!defined $camelcase{$word}) {
3594 $camelcase{$word} = 1;
3595 CHK("CAMELCASE",
3596 "Avoid CamelCase: <$word>\n" . $herecurr);
3597 }
Joe Perches34456862013-07-03 15:05:34 -07003598 }
Joe Perches323c1262012-12-17 16:02:07 -08003599 }
3600 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003601
3602#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003603 if ($line =~ /\#\s*define.*\\\s+$/) {
3604 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3605 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3606 $fix) {
3607 $fixed[$linenr - 1] =~ s/\s+$//;
3608 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003609 }
3610
Andy Whitcroft653d4872007-06-23 17:16:34 -07003611#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003612 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003613 my $file = "$1.h";
3614 my $checkfile = "include/linux/$file";
3615 if (-f "$root/$checkfile" &&
3616 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003617 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003618 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003619 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003620 CHK("ARCH_INCLUDE_LINUX",
3621 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003622 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003623 WARN("INCLUDE_LINUX",
3624 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003625 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003626 }
3627 }
3628
Andy Whitcroft653d4872007-06-23 17:16:34 -07003629# multi-statement macros should be enclosed in a do while loop, grab the
3630# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003631# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07003632 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3633 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003634 my $ln = $linenr;
3635 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003636 my ($off, $dstat, $dcond, $rest);
3637 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003638 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003639 ctx_statement_block($linenr, $realcnt, 0);
3640 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003641 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003642 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003643
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003644 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003645 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003646 $dstat =~ s/\\\n.//g;
3647 $dstat =~ s/^\s*//s;
3648 $dstat =~ s/\s*$//s;
3649
3650 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003651 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3652 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003653 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003654 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003655 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003656
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003657 # Flatten any obvious string concatentation.
3658 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3659 $dstat =~ s/$Ident\s*("X*")/$1/)
3660 {
3661 }
3662
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003663 my $exceptions = qr{
3664 $Declare|
3665 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003666 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003667 DECLARE_PER_CPU|
3668 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003669 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003670 union|
3671 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003672 \.$Ident\s*=\s*|
3673 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003674 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003675 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003676 if ($dstat ne '' &&
3677 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3678 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07003679 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003680 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003681 $dstat !~ /$exceptions/ &&
3682 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003683 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003684 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003685 $dstat !~ /^for\s*$Constant$/ && # for (...)
3686 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3687 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07003688 $dstat !~ /^\({/ && # ({...
3689 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003690 {
3691 $ctx =~ s/\n*$//;
3692 my $herectx = $here . "\n";
3693 my $cnt = statement_rawlines($ctx);
3694
3695 for (my $n = 0; $n < $cnt; $n++) {
3696 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003697 }
3698
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003699 if ($dstat =~ /;/) {
3700 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3701 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3702 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003703 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003704 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003705 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003706 }
Joe Perches5023d342012-12-17 16:01:47 -08003707
Joe Perches481eb482012-12-17 16:01:56 -08003708# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003709
3710 } else {
3711 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003712 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3713 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003714 $line =~ /^\+.*\\$/) {
3715 WARN("LINE_CONTINUATIONS",
3716 "Avoid unnecessary line continuations\n" . $herecurr);
3717 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003718 }
3719
Joe Perchesb13edf72012-07-30 14:41:24 -07003720# do {} while (0) macro tests:
3721# single-statement macros do not need to be enclosed in do while (0) loop,
3722# macro should not end with a semicolon
3723 if ($^V && $^V ge 5.10.0 &&
3724 $realfile !~ m@/vmlinux.lds.h$@ &&
3725 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3726 my $ln = $linenr;
3727 my $cnt = $realcnt;
3728 my ($off, $dstat, $dcond, $rest);
3729 my $ctx = '';
3730 ($dstat, $dcond, $ln, $cnt, $off) =
3731 ctx_statement_block($linenr, $realcnt, 0);
3732 $ctx = $dstat;
3733
3734 $dstat =~ s/\\\n.//g;
3735
3736 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3737 my $stmts = $2;
3738 my $semis = $3;
3739
3740 $ctx =~ s/\n*$//;
3741 my $cnt = statement_rawlines($ctx);
3742 my $herectx = $here . "\n";
3743
3744 for (my $n = 0; $n < $cnt; $n++) {
3745 $herectx .= raw_line($linenr, $n) . "\n";
3746 }
3747
Joe Perchesac8e97f2012-08-21 16:15:53 -07003748 if (($stmts =~ tr/;/;/) == 1 &&
3749 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003750 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3751 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3752 }
3753 if (defined $semis && $semis ne "") {
3754 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3755 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3756 }
3757 }
3758 }
3759
Mike Frysinger080ba922009-01-06 14:41:25 -08003760# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3761# all assignments may have only one of the following with an assignment:
3762# .
3763# ALIGN(...)
3764# VMLINUX_SYMBOL(...)
3765 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003766 WARN("MISSING_VMLINUX_SYMBOL",
3767 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003768 }
3769
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003770# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003771 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3772 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003773 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003774 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003775 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3776 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003777 my @allowed = ();
3778 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003779 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003780 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003781 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003782 for my $chunk (@chunks) {
3783 my ($cond, $block) = @{$chunk};
3784
Andy Whitcroft773647a2008-03-28 14:15:58 -07003785 # If the condition carries leading newlines, then count those as offsets.
3786 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3787 my $offset = statement_rawlines($whitespace) - 1;
3788
Joe Perchesaad4f612012-03-23 15:02:19 -07003789 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003790 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3791
3792 # We have looked at and allowed this specific line.
3793 $suppress_ifbraces{$ln + $offset} = 1;
3794
3795 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003796 $ln += statement_rawlines($block) - 1;
3797
Andy Whitcroft773647a2008-03-28 14:15:58 -07003798 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003799
3800 $seen++ if ($block =~ /^\s*{/);
3801
Joe Perchesaad4f612012-03-23 15:02:19 -07003802 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003803 if (statement_lines($cond) > 1) {
3804 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003805 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003806 }
3807 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003808 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003809 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003810 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003811 if (statement_block_size($block) > 1) {
3812 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003813 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003814 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003815 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003816 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003817 if ($seen) {
3818 my $sum_allowed = 0;
3819 foreach (@allowed) {
3820 $sum_allowed += $_;
3821 }
3822 if ($sum_allowed == 0) {
3823 WARN("BRACES",
3824 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3825 } elsif ($sum_allowed != $allow &&
3826 $seen != $allow) {
3827 CHK("BRACES",
3828 "braces {} should be used on all arms of this statement\n" . $herectx);
3829 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003830 }
3831 }
3832 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003833 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003834 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003835 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003836
Andy Whitcroftcf655042008-03-04 14:28:20 -08003837 # Check the pre-context.
3838 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3839 #print "APW: ALLOWED: pre<$1>\n";
3840 $allowed = 1;
3841 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003842
3843 my ($level, $endln, @chunks) =
3844 ctx_statement_full($linenr, $realcnt, $-[0]);
3845
Andy Whitcroftcf655042008-03-04 14:28:20 -08003846 # Check the condition.
3847 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003848 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003849 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003850 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003851 }
3852 if (statement_lines($cond) > 1) {
3853 #print "APW: ALLOWED: cond<$cond>\n";
3854 $allowed = 1;
3855 }
3856 if ($block =~/\b(?:if|for|while)\b/) {
3857 #print "APW: ALLOWED: block<$block>\n";
3858 $allowed = 1;
3859 }
3860 if (statement_block_size($block) > 1) {
3861 #print "APW: ALLOWED: lines block<$block>\n";
3862 $allowed = 1;
3863 }
3864 # Check the post-context.
3865 if (defined $chunks[1]) {
3866 my ($cond, $block) = @{$chunks[1]};
3867 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003868 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003869 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003870 if ($block =~ /^\s*\{/) {
3871 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3872 $allowed = 1;
3873 }
3874 }
3875 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003876 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003877 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003878
Andy Whitcroftf0556632008-10-15 22:02:23 -07003879 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003880 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003881 }
3882
Joe Perches000d1cc12011-07-25 17:13:25 -07003883 WARN("BRACES",
3884 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003885 }
3886 }
3887
Joe Perches0979ae62012-12-17 16:01:59 -08003888# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07003889 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003890 CHK("BRACES",
3891 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3892 }
Joe Perches77b9a532013-07-03 15:05:29 -07003893 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003894 CHK("BRACES",
3895 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3896 }
3897
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003898# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003899 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3900 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003901 WARN("VOLATILE",
3902 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003903 }
3904
Andy Whitcroft00df3442007-06-08 13:47:06 -07003905# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003906 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003907 CHK("REDUNDANT_CODE",
3908 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003909 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003910 }
3911
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003912# check for needless "if (<foo>) fn(<foo>)" uses
3913 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3914 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3915 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3916 WARN('NEEDLESS_IF',
3917 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003918 }
3919 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003920
Joe Perches8716de32013-09-11 14:24:05 -07003921# check for bad placement of section $InitAttribute (e.g.: __initdata)
3922 if ($line =~ /(\b$InitAttribute\b)/) {
3923 my $attr = $1;
3924 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
3925 my $ptr = $1;
3926 my $var = $2;
3927 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
3928 ERROR("MISPLACED_INIT",
3929 "$attr should be placed after $var\n" . $herecurr)) ||
3930 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
3931 WARN("MISPLACED_INIT",
3932 "$attr should be placed after $var\n" . $herecurr))) &&
3933 $fix) {
3934 $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;
3935 }
3936 }
3937 }
3938
Joe Perchese970b882013-11-12 15:10:10 -08003939# check for $InitAttributeData (ie: __initdata) with const
3940 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
3941 my $attr = $1;
3942 $attr =~ /($InitAttributePrefix)(.*)/;
3943 my $attr_prefix = $1;
3944 my $attr_type = $2;
3945 if (ERROR("INIT_ATTRIBUTE",
3946 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
3947 $fix) {
3948 $fixed[$linenr - 1] =~
3949 s/$InitAttributeData/${attr_prefix}initconst/;
3950 }
3951 }
3952
3953# check for $InitAttributeConst (ie: __initconst) without const
3954 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
3955 my $attr = $1;
3956 if (ERROR("INIT_ATTRIBUTE",
3957 "Use of $attr requires a separate use of const\n" . $herecurr) &&
3958 $fix) {
3959 my $lead = $fixed[$linenr - 1] =~
3960 /(^\+\s*(?:static\s+))/;
3961 $lead = rtrim($1);
3962 $lead = "$lead " if ($lead !~ /^\+$/);
3963 $lead = "${lead}const ";
3964 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
3965 }
3966 }
3967
Joe Perchesfbdb8132014-04-03 14:49:14 -07003968# don't use __constant_<foo> functions outside of include/uapi/
3969 if ($realfile !~ m@^include/uapi/@ &&
3970 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
3971 my $constant_func = $1;
3972 my $func = $constant_func;
3973 $func =~ s/^__constant_//;
3974 if (WARN("CONSTANT_CONVERSION",
3975 "$constant_func should be $func\n" . $herecurr) &&
3976 $fix) {
3977 $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
3978 }
3979 }
3980
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003981# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08003982 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07003983 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003984 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07003985 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003986 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07003987 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
3988 }
3989 if ($delay > 2000) {
3990 WARN("LONG_UDELAY",
3991 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003992 }
3993 }
3994
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003995# warn about unexpectedly long msleep's
3996 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3997 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003998 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07003999 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004000 }
4001 }
4002
Joe Perches36ec1932013-07-03 15:05:25 -07004003# check for comparisons of jiffies
4004 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4005 WARN("JIFFIES_COMPARISON",
4006 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4007 }
4008
Joe Perches9d7a34a2013-07-03 15:05:26 -07004009# check for comparisons of get_jiffies_64()
4010 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4011 WARN("JIFFIES_COMPARISON",
4012 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4013 }
4014
Andy Whitcroft00df3442007-06-08 13:47:06 -07004015# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004016# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07004017# print "#ifdef in C files should be avoided\n";
4018# print "$herecurr";
4019# $clean = 0;
4020# }
4021
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004022# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004023 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004024 if (ERROR("SPACING",
4025 "exactly one space required after that #$1\n" . $herecurr) &&
4026 $fix) {
4027 $fixed[$linenr - 1] =~
4028 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4029 }
4030
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004031 }
4032
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004033# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004034 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4035 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004036 my $which = $1;
4037 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004038 CHK("UNCOMMENTED_DEFINITION",
4039 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004040 }
4041 }
4042# check for memory barriers without a comment.
4043 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4044 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004045 WARN("MEMORY_BARRIER",
4046 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004047 }
4048 }
4049# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004050 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004051 CHK("ARCH_DEFINES",
4052 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004053 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004054
Tobias Klauserd4977c72010-05-24 14:33:30 -07004055# Check that the storage class is at the beginning of a declaration
4056 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004057 WARN("STORAGE_CLASS",
4058 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004059 }
4060
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004061# check the location of the inline attribute, that it is between
4062# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004063 if ($line =~ /\b$Type\s+$Inline\b/ ||
4064 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004065 ERROR("INLINE_LOCATION",
4066 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004067 }
4068
Andy Whitcroft8905a672007-11-28 16:21:06 -08004069# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004070 if ($realfile !~ m@\binclude/uapi/@ &&
4071 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004072 if (WARN("INLINE",
4073 "plain inline is preferred over $1\n" . $herecurr) &&
4074 $fix) {
4075 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4076
4077 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004078 }
4079
Joe Perches3d130fd2011-01-12 17:00:00 -08004080# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004081 if ($realfile !~ m@\binclude/uapi/@ &&
4082 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004083 WARN("PREFER_PACKED",
4084 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004085 }
4086
Joe Perches39b7e282011-07-25 17:13:24 -07004087# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004088 if ($realfile !~ m@\binclude/uapi/@ &&
4089 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004090 WARN("PREFER_ALIGNED",
4091 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004092 }
4093
Joe Perches5f14d3b2012-01-10 15:09:52 -08004094# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004095 if ($realfile !~ m@\binclude/uapi/@ &&
4096 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004097 if (WARN("PREFER_PRINTF",
4098 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4099 $fix) {
4100 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4101
4102 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004103 }
4104
Joe Perches6061d942012-03-23 15:02:16 -07004105# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004106 if ($realfile !~ m@\binclude/uapi/@ &&
4107 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004108 if (WARN("PREFER_SCANF",
4109 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4110 $fix) {
4111 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4112 }
Joe Perches6061d942012-03-23 15:02:16 -07004113 }
4114
Joe Perches8f53a9b2010-03-05 13:43:48 -08004115# check for sizeof(&)
4116 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004117 WARN("SIZEOF_ADDRESS",
4118 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004119 }
4120
Joe Perches66c80b62012-07-30 14:41:22 -07004121# check for sizeof without parenthesis
4122 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004123 if (WARN("SIZEOF_PARENTHESIS",
4124 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4125 $fix) {
4126 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4127 }
Joe Perches66c80b62012-07-30 14:41:22 -07004128 }
4129
Joe Perches428e2fd2011-05-24 17:13:39 -07004130# check for line continuations in quoted strings with odd counts of "
4131 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004132 WARN("LINE_CONTINUATIONS",
4133 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004134 }
4135
Joe Perches88982fe2012-12-17 16:02:00 -08004136# check for struct spinlock declarations
4137 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4138 WARN("USE_SPINLOCK_T",
4139 "struct spinlock should be spinlock_t\n" . $herecurr);
4140 }
4141
Joe Perchesa6962d72013-04-29 16:18:13 -07004142# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004143 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004144 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004145 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004146 if (WARN("PREFER_SEQ_PUTS",
4147 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4148 $fix) {
4149 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4150 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004151 }
4152 }
4153
Andy Whitcroft554e1652012-01-10 15:09:57 -08004154# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004155 if ($^V && $^V ge 5.10.0 &&
4156 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004157 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004158
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004159 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004160 my $ms_val = $7;
4161 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004162
Andy Whitcroft554e1652012-01-10 15:09:57 -08004163 if ($ms_size =~ /^(0x|)0$/i) {
4164 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004165 "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 -08004166 } elsif ($ms_size =~ /^(0x|)1$/i) {
4167 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004168 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4169 }
4170 }
4171
Joe Perches98a9bba2014-01-23 15:54:52 -08004172# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4173 if ($^V && $^V ge 5.10.0 &&
4174 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4175 if (WARN("PREFER_ETHER_ADDR_COPY",
4176 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4177 $fix) {
4178 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4179 }
4180 }
4181
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004182# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004183 if ($^V && $^V ge 5.10.0 &&
4184 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004185 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004186 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004187 my $call = $1;
4188 my $cast1 = deparenthesize($2);
4189 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004190 my $cast2 = deparenthesize($7);
4191 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004192 my $cast;
4193
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004194 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004195 $cast = "$cast1 or $cast2";
4196 } elsif ($cast1 ne "") {
4197 $cast = $cast1;
4198 } else {
4199 $cast = $cast2;
4200 }
4201 WARN("MINMAX",
4202 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004203 }
4204 }
4205
Joe Perches4a273192012-07-30 14:41:20 -07004206# check usleep_range arguments
4207 if ($^V && $^V ge 5.10.0 &&
4208 defined $stat &&
4209 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4210 my $min = $1;
4211 my $max = $7;
4212 if ($min eq $max) {
4213 WARN("USLEEP_RANGE",
4214 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4215 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4216 $min > $max) {
4217 WARN("USLEEP_RANGE",
4218 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4219 }
4220 }
4221
Joe Perches823b7942013-11-12 15:10:15 -08004222# check for naked sscanf
4223 if ($^V && $^V ge 5.10.0 &&
4224 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004225 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004226 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4227 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4228 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4229 my $lc = $stat =~ tr@\n@@;
4230 $lc = $lc + $linenr;
4231 my $stat_real = raw_line($linenr, 0);
4232 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4233 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4234 }
4235 WARN("NAKED_SSCANF",
4236 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4237 }
4238
Joe Perches70dc8a42013-09-11 14:23:58 -07004239# check for new externs in .h files.
4240 if ($realfile =~ /\.h$/ &&
4241 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004242 if (CHK("AVOID_EXTERNS",
4243 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004244 $fix) {
4245 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4246 }
4247 }
4248
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004249# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004250 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004251 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004252 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004253 my $function_name = $1;
4254 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004255
4256 my $s = $stat;
4257 if (defined $cond) {
4258 substr($s, 0, length($cond), '');
4259 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004260 if ($s =~ /^\s*;/ &&
4261 $function_name ne 'uninitialized_var')
4262 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004263 WARN("AVOID_EXTERNS",
4264 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004265 }
4266
4267 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004268 WARN("FUNCTION_ARGUMENTS",
4269 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004270 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004271
4272 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4273 $stat =~ /^.\s*extern\s+/)
4274 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004275 WARN("AVOID_EXTERNS",
4276 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004277 }
4278
4279# checks for new __setup's
4280 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4281 my $name = $1;
4282
4283 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004284 CHK("UNDOCUMENTED_SETUP",
4285 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004286 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004287 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004288
4289# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004290 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004291 WARN("UNNECESSARY_CASTS",
4292 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004293 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004294
Joe Perchesa640d252013-07-03 15:05:21 -07004295# alloc style
4296# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4297 if ($^V && $^V ge 5.10.0 &&
4298 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4299 CHK("ALLOC_SIZEOF_STRUCT",
4300 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4301 }
4302
Joe Perches972fdea2013-04-29 16:18:12 -07004303# check for krealloc arg reuse
4304 if ($^V && $^V ge 5.10.0 &&
4305 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4306 WARN("KREALLOC_ARG_REUSE",
4307 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4308 }
4309
Joe Perches5ce59ae2013-02-21 16:44:18 -08004310# check for alloc argument mismatch
4311 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4312 WARN("ALLOC_ARRAY_ARGS",
4313 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4314 }
4315
David Rientjes7e4915e2014-01-23 15:54:42 -08004316# check for GFP_NOWAIT use
4317 if ($line =~ /\b__GFP_NOFAIL\b/) {
4318 WARN("__GFP_NOFAIL",
4319 "Use of __GFP_NOFAIL is deprecated, no new users should be added\n" . $herecurr);
4320 }
4321
Joe Perchescaf2a542011-01-12 16:59:56 -08004322# check for multiple semicolons
4323 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004324 if (WARN("ONE_SEMICOLON",
4325 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4326 $fix) {
4327 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4328 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004329 }
4330
Joe Perchesc34c09a2014-01-23 15:54:43 -08004331# check for case / default statements not preceeded by break/fallthrough/switch
4332 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4333 my $has_break = 0;
4334 my $has_statement = 0;
4335 my $count = 0;
4336 my $prevline = $linenr;
4337 while ($prevline > 1 && $count < 3 && !$has_break) {
4338 $prevline--;
4339 my $rline = $rawlines[$prevline - 1];
4340 my $fline = $lines[$prevline - 1];
4341 last if ($fline =~ /^\@\@/);
4342 next if ($fline =~ /^\-/);
4343 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4344 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4345 next if ($fline =~ /^.[\s$;]*$/);
4346 $has_statement = 1;
4347 $count++;
4348 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4349 }
4350 if (!$has_break && $has_statement) {
4351 WARN("MISSING_BREAK",
4352 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4353 }
4354 }
4355
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004356# check for switch/default statements without a break;
4357 if ($^V && $^V ge 5.10.0 &&
4358 defined $stat &&
4359 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4360 my $ctx = '';
4361 my $herectx = $here . "\n";
4362 my $cnt = statement_rawlines($stat);
4363 for (my $n = 0; $n < $cnt; $n++) {
4364 $herectx .= raw_line($linenr, $n) . "\n";
4365 }
4366 WARN("DEFAULT_NO_BREAK",
4367 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004368 }
4369
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004370# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004371 if ($line =~ /\b__FUNCTION__\b/) {
4372 if (WARN("USE_FUNC",
4373 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4374 $fix) {
4375 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4376 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004377 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004378
Joe Perches2c924882012-03-23 15:02:20 -07004379# check for use of yield()
4380 if ($line =~ /\byield\s*\(\s*\)/) {
4381 WARN("YIELD",
4382 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4383 }
4384
Joe Perches179f8f42013-07-03 15:05:30 -07004385# check for comparisons against true and false
4386 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4387 my $lead = $1;
4388 my $arg = $2;
4389 my $test = $3;
4390 my $otype = $4;
4391 my $trail = $5;
4392 my $op = "!";
4393
4394 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4395
4396 my $type = lc($otype);
4397 if ($type =~ /^(?:true|false)$/) {
4398 if (("$test" eq "==" && "$type" eq "true") ||
4399 ("$test" eq "!=" && "$type" eq "false")) {
4400 $op = "";
4401 }
4402
4403 CHK("BOOL_COMPARISON",
4404 "Using comparison to $otype is error prone\n" . $herecurr);
4405
4406## maybe suggesting a correct construct would better
4407## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4408
4409 }
4410 }
4411
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004412# check for semaphores initialized locked
4413 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004414 WARN("CONSIDER_COMPLETION",
4415 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004416 }
Joe Perches6712d852012-03-23 15:02:20 -07004417
Joe Perches67d0a072011-10-31 17:13:10 -07004418# recommend kstrto* over simple_strto* and strict_strto*
4419 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004420 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004421 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004422 }
Joe Perches6712d852012-03-23 15:02:20 -07004423
Michael Ellermanf3db6632008-07-23 21:28:57 -07004424# check for __initcall(), use device_initcall() explicitly please
4425 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004426 WARN("USE_DEVICE_INITCALL",
4427 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07004428 }
Joe Perches6712d852012-03-23 15:02:20 -07004429
Emese Revfy79404842010-03-05 13:43:53 -08004430# check for various ops structs, ensure they are const.
4431 my $struct_ops = qr{acpi_dock_ops|
4432 address_space_operations|
4433 backlight_ops|
4434 block_device_operations|
4435 dentry_operations|
4436 dev_pm_ops|
4437 dma_map_ops|
4438 extent_io_ops|
4439 file_lock_operations|
4440 file_operations|
4441 hv_ops|
4442 ide_dma_ops|
4443 intel_dvo_dev_ops|
4444 item_operations|
4445 iwl_ops|
4446 kgdb_arch|
4447 kgdb_io|
4448 kset_uevent_ops|
4449 lock_manager_operations|
4450 microcode_ops|
4451 mtrr_ops|
4452 neigh_ops|
4453 nlmsvc_binding|
4454 pci_raw_ops|
4455 pipe_buf_operations|
4456 platform_hibernation_ops|
4457 platform_suspend_ops|
4458 proto_ops|
4459 rpc_pipe_ops|
4460 seq_operations|
4461 snd_ac97_build_ops|
4462 soc_pcmcia_socket_ops|
4463 stacktrace_ops|
4464 sysfs_ops|
4465 tty_operations|
4466 usb_mon_operations|
4467 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004468 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004469 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004470 WARN("CONST_STRUCT",
4471 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004472 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004473 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004474
4475# use of NR_CPUS is usually wrong
4476# ignore definitions of NR_CPUS and usage to define arrays as likely right
4477 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004478 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4479 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004480 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4481 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4482 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004483 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004484 WARN("NR_CPUS",
4485 "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 -07004486 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004487
Joe Perches52ea8502013-11-12 15:10:09 -08004488# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4489 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4490 ERROR("DEFINE_ARCH_HAS",
4491 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4492 }
4493
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004494# check for %L{u,d,i} in strings
4495 my $string;
4496 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4497 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004498 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004499 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004500 WARN("PRINTF_L",
4501 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004502 last;
4503 }
4504 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004505
4506# whine mightly about in_atomic
4507 if ($line =~ /\bin_atomic\s*\(/) {
4508 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004509 ERROR("IN_ATOMIC",
4510 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004511 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004512 WARN("IN_ATOMIC",
4513 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004514 }
4515 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004516
4517# check for lockdep_set_novalidate_class
4518 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4519 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4520 if ($realfile !~ m@^kernel/lockdep@ &&
4521 $realfile !~ m@^include/linux/lockdep@ &&
4522 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004523 ERROR("LOCKDEP",
4524 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004525 }
4526 }
Dave Jones88f88312011-01-12 16:59:59 -08004527
4528 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4529 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004530 WARN("EXPORTED_WORLD_WRITABLE",
4531 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004532 }
Joe Perches24358802014-04-03 14:49:13 -07004533
Joe Perches515a2352014-04-03 14:49:24 -07004534# Mode permission misuses where it seems decimal should be octal
4535# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4536 if ($^V && $^V ge 5.10.0 &&
4537 $line =~ /$mode_perms_search/) {
4538 foreach my $entry (@mode_permission_funcs) {
4539 my $func = $entry->[0];
4540 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07004541
Joe Perches515a2352014-04-03 14:49:24 -07004542 my $skip_args = "";
4543 if ($arg_pos > 1) {
4544 $arg_pos--;
4545 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4546 }
4547 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4548 if ($line =~ /$test/) {
4549 my $val = $1;
4550 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07004551
Joe Perches515a2352014-04-03 14:49:24 -07004552 if ($val !~ /^0$/ &&
4553 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4554 length($val) ne 4)) {
4555 ERROR("NON_OCTAL_PERMISSIONS",
4556 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4557 }
Joe Perches24358802014-04-03 14:49:13 -07004558 }
4559 }
4560 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004561 }
4562
4563 # If we have no input at all, then there is nothing to report on
4564 # so just keep quiet.
4565 if ($#rawlines == -1) {
4566 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004567 }
4568
Andy Whitcroft8905a672007-11-28 16:21:06 -08004569 # In mailback mode only produce a report in the negative, for
4570 # things that appear to be patches.
4571 if ($mailback && ($clean == 1 || !$is_patch)) {
4572 exit(0);
4573 }
4574
4575 # This is not a patch, and we are are in 'no-patch' mode so
4576 # just keep quiet.
4577 if (!$chk_patch && !$is_patch) {
4578 exit(0);
4579 }
4580
4581 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004582 ERROR("NOT_UNIFIED_DIFF",
4583 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004584 }
4585 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004586 ERROR("MISSING_SIGN_OFF",
4587 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004588 }
4589
Andy Whitcroft8905a672007-11-28 16:21:06 -08004590 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004591 if ($summary && !($clean == 1 && $quiet == 1)) {
4592 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004593 print "total: $cnt_error errors, $cnt_warn warnings, " .
4594 (($check)? "$cnt_chk checks, " : "") .
4595 "$cnt_lines lines checked\n";
4596 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004597 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004598
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004599 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004600
4601 if ($^V lt 5.10.0) {
4602 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4603 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4604 }
4605
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004606 # If there were whitespace errors which cleanpatch can fix
4607 # then suggest that.
4608 if ($rpt_cleaners) {
4609 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4610 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07004611 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004612 }
4613 }
4614
Joe Perches91bfe482013-09-11 14:23:59 -07004615 hash_show_words(\%use_type, "Used");
4616 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07004617
Joe Perches3705ce52013-07-03 15:05:31 -07004618 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
Joe Perches9624b8d2014-01-23 15:54:44 -08004619 my $newfile = $filename;
4620 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07004621 my $linecount = 0;
4622 my $f;
4623
4624 open($f, '>', $newfile)
4625 or die "$P: Can't open $newfile for write\n";
4626 foreach my $fixed_line (@fixed) {
4627 $linecount++;
4628 if ($file) {
4629 if ($linecount > 3) {
4630 $fixed_line =~ s/^\+//;
4631 print $f $fixed_line. "\n";
4632 }
4633 } else {
4634 print $f $fixed_line . "\n";
4635 }
4636 }
4637 close($f);
4638
4639 if (!$quiet) {
4640 print << "EOM";
4641Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4642
4643Do _NOT_ trust the results written to this file.
4644Do _NOT_ submit these changes without inspecting them for correctness.
4645
4646This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4647No warranties, expressed or implied...
4648
4649EOM
4650 }
4651 }
4652
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004653 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004654 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004655 }
4656 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004657 print << "EOM";
4658$vname has style problems, please review.
4659
4660If any of these errors are false positives, please report
4661them to the maintainer, see CHECKPATCH in MAINTAINERS.
4662EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004663 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004664
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004665 return $clean;
4666}