blob: d9b09eb767bba38bff0bc5a2242e0d303c6bd0dd [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
Florian Vaussard7dd05b32014-04-03 14:49:26 -07002077 if (defined $root &&
2078 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) ||
2079 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) {
2080
Rob Herringbff5da42014-01-23 15:54:51 -08002081 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2082
Florian Vaussardcc933192014-04-03 14:49:27 -07002083 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2084 my $vp_file = $dt_path . "vendor-prefixes.txt";
2085
Rob Herringbff5da42014-01-23 15:54:51 -08002086 foreach my $compat (@compats) {
2087 my $compat2 = $compat;
Rob Herringbff5da42014-01-23 15:54:51 -08002088 $compat2 =~ s/\,[a-z]*\-/\,<\.\*>\-/;
2089 `grep -Erq "$compat|$compat2" $dt_path`;
2090 if ( $? >> 8 ) {
2091 WARN("UNDOCUMENTED_DT_STRING",
2092 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2093 }
2094
Florian Vaussard4fbf32a2014-04-03 14:49:25 -07002095 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/;
2096 my $vendor = $1;
Florian Vaussardcc933192014-04-03 14:49:27 -07002097 `grep -Eq "^$vendor\\b" $vp_file`;
Rob Herringbff5da42014-01-23 15:54:51 -08002098 if ( $? >> 8 ) {
2099 WARN("UNDOCUMENTED_DT_STRING",
Florian Vaussardcc933192014-04-03 14:49:27 -07002100 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
Rob Herringbff5da42014-01-23 15:54:51 -08002101 }
2102 }
2103 }
2104
Andy Whitcroft5368df22008-10-15 22:02:27 -07002105# check we are in a valid source file if not then ignore this hunk
2106 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2107
Joe Perches6cd7f382012-12-17 16:01:54 -08002108#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002109 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002110 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002111 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002112 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002113 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002114 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002115 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002116 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002117 }
2118
Josh Triplettca56dc02012-03-23 15:02:21 -07002119# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002120# to grep for the string. Make exceptions when the previous string ends in a
2121# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2122# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002123 if ($line =~ /^\+\s*"/ &&
2124 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002125 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002126 WARN("SPLIT_STRING",
2127 "quoted string split across lines\n" . $hereprev);
2128 }
2129
Joe Perches5e79d962010-03-05 13:43:55 -08002130# check for spaces before a quoted newline
2131 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002132 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2133 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2134 $fix) {
2135 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2136 }
2137
Joe Perches5e79d962010-03-05 13:43:55 -08002138 }
2139
Andy Whitcroft8905a672007-11-28 16:21:06 -08002140# check for adding lines without a newline.
2141 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002142 WARN("MISSING_EOF_NEWLINE",
2143 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002144 }
2145
Mike Frysinger42e41c52009-09-21 17:04:40 -07002146# Blackfin: use hi/lo macros
2147 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2148 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2149 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002150 ERROR("LO_MACRO",
2151 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002152 }
2153 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2154 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002155 ERROR("HI_MACRO",
2156 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002157 }
2158 }
2159
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002160# check we are in a valid source file C or perl if not then ignore this hunk
2161 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002162
2163# at the beginning of a line any tabs must come first and anything
2164# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002165 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2166 $rawline =~ /^\+\s* \s*/) {
2167 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002168 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002169 if (ERROR("CODE_INDENT",
2170 "code indent should use tabs where possible\n" . $herevet) &&
2171 $fix) {
2172 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2173 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002174 }
2175
Alberto Panizzo08e44362010-03-05 13:43:54 -08002176# check for space before tabs.
2177 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2178 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002179 if (WARN("SPACE_BEFORE_TAB",
2180 "please, no space before tabs\n" . $herevet) &&
2181 $fix) {
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002182 while ($fixed[$linenr - 1] =~
2183 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2184 while ($fixed[$linenr - 1] =~
2185 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002186 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002187 }
2188
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002189# check for && or || at the start of a line
2190 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2191 CHK("LOGICAL_CONTINUATIONS",
2192 "Logical continuations should be on the previous line\n" . $hereprev);
2193 }
2194
2195# check multi-line statement indentation matches previous line
2196 if ($^V && $^V ge 5.10.0 &&
2197 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
2198 $prevline =~ /^\+(\t*)(.*)$/;
2199 my $oldindent = $1;
2200 my $rest = $2;
2201
2202 my $pos = pos_last_openparen($rest);
2203 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002204 $line =~ /^(\+| )([ \t]*)/;
2205 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002206
2207 my $goodtabindent = $oldindent .
2208 "\t" x ($pos / 8) .
2209 " " x ($pos % 8);
2210 my $goodspaceindent = $oldindent . " " x $pos;
2211
2212 if ($newindent ne $goodtabindent &&
2213 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002214
2215 if (CHK("PARENTHESIS_ALIGNMENT",
2216 "Alignment should match open parenthesis\n" . $hereprev) &&
2217 $fix && $line =~ /^\+/) {
2218 $fixed[$linenr - 1] =~
2219 s/^\+[ \t]*/\+$goodtabindent/;
2220 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002221 }
2222 }
2223 }
2224
Joe Perches23f780c2013-07-03 15:05:31 -07002225 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002226 if (CHK("SPACING",
2227 "No space is necessary after a cast\n" . $hereprev) &&
2228 $fix) {
2229 $fixed[$linenr - 1] =~
2230 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2231 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002232 }
2233
Joe Perches05880602012-10-04 17:13:35 -07002234 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002235 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002236 $rawline =~ /^\+[ \t]*\*/ &&
2237 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002238 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2239 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2240 }
2241
2242 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002243 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2244 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002245 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002246 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2247 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2248 "networking block comments start with * on subsequent lines\n" . $hereprev);
2249 }
2250
2251 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002252 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2253 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2254 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2255 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002256 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2257 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2258 }
2259
Joe Perches3b617e3b2014-04-03 14:49:28 -07002260# check for missing blank lines after declarations
2261 if ($realfile =~ m@^(drivers/net/|net/)@ &&
2262 $prevline =~ /^\+\s+$Declare\s+$Ident/ &&
2263 !($prevline =~ /(?:$Compare|$Assignment|$Operators)\s*$/ ||
2264 $prevline =~ /(?:\{\s*|\\)$/) && #extended lines
2265 $sline =~ /^\+\s+/ && #Not at char 1
2266 !($sline =~ /^\+\s+$Declare/ ||
2267 $sline =~ /^\+\s+$Ident\s+$Ident/ || #eg: typedef foo
2268 $sline =~ /^\+\s+(?:union|struct|enum|typedef)\b/ ||
2269 $sline =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(])/ ||
2270 $sline =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) {
2271 WARN("SPACING",
2272 "networking uses a blank line after declarations\n" . $hereprev);
2273 }
2274
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002275# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002276# Exceptions:
2277# 1) within comments
2278# 2) indented preprocessor commands
2279# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002280 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002281 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002282 if (WARN("LEADING_SPACE",
2283 "please, no spaces at the start of a line\n" . $herevet) &&
2284 $fix) {
2285 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2286 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002287 }
2288
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002289# check we are in a valid C source file if not then ignore this hunk
2290 next if ($realfile !~ /\.(h|c)$/);
2291
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002292# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2293 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2294 WARN("CONFIG_EXPERIMENTAL",
2295 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2296 }
2297
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002298# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002299 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002300 WARN("CVS_KEYWORD",
2301 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002302 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002303
Mike Frysinger42e41c52009-09-21 17:04:40 -07002304# Blackfin: don't use __builtin_bfin_[cs]sync
2305 if ($line =~ /__builtin_bfin_csync/) {
2306 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002307 ERROR("CSYNC",
2308 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002309 }
2310 if ($line =~ /__builtin_bfin_ssync/) {
2311 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002312 ERROR("SSYNC",
2313 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002314 }
2315
Joe Perches56e77d72013-02-21 16:44:14 -08002316# check for old HOTPLUG __dev<foo> section markings
2317 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2318 WARN("HOTPLUG_SECTION",
2319 "Using $1 is unnecessary\n" . $herecurr);
2320 }
2321
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002322# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002323 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2324 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002325#print "LINE<$line>\n";
2326 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002327 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002328 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002329 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002330 $stat =~ s/\n./\n /g;
2331 $cond =~ s/\n./\n /g;
2332
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002333#print "linenr<$linenr> <$stat>\n";
2334 # If this statement has no statement boundaries within
2335 # it there is no point in retrying a statement scan
2336 # until we hit end of it.
2337 my $frag = $stat; $frag =~ s/;+\s*$//;
2338 if ($frag !~ /(?:{|;)/) {
2339#print "skip<$line_nr_next>\n";
2340 $suppress_statement = $line_nr_next;
2341 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002342
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002343 # Find the real next line.
2344 $realline_next = $line_nr_next;
2345 if (defined $realline_next &&
2346 (!defined $lines[$realline_next - 1] ||
2347 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2348 $realline_next++;
2349 }
2350
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002351 my $s = $stat;
2352 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002353
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002354 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002355 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002356
2357 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002358 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002359
Andy Whitcroft463f2862009-09-21 17:04:34 -07002360 } elsif ($s =~ /^.\s*else\b/s) {
2361
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002362 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002363 } 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 -07002364 my $type = $1;
2365 $type =~ s/\s+/ /g;
2366 possible($type, "A:" . $s);
2367
Andy Whitcroft8905a672007-11-28 16:21:06 -08002368 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002369 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002370 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002371 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002372
2373 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002374 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002375 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002376 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002377
2378 # Check for any sort of function declaration.
2379 # int foo(something bar, other baz);
2380 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002381 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 -08002382 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002383
Andy Whitcroftcf655042008-03-04 14:28:20 -08002384 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002385 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002386 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002387
Andy Whitcroft8905a672007-11-28 16:21:06 -08002388 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002389 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002390
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002391 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002392 }
2393 }
2394 }
2395
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002396 }
2397
Andy Whitcroft653d4872007-06-23 17:16:34 -07002398#
2399# Checks which may be anchored in the context.
2400#
2401
2402# Check for switch () and associated case and default
2403# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002404 if ($line=~/\bswitch\s*\(.*\)/) {
2405 my $err = '';
2406 my $sep = '';
2407 my @ctx = ctx_block_outer($linenr, $realcnt);
2408 shift(@ctx);
2409 for my $ctx (@ctx) {
2410 my ($clen, $cindent) = line_stats($ctx);
2411 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2412 $indent != $cindent) {
2413 $err .= "$sep$ctx\n";
2414 $sep = '';
2415 } else {
2416 $sep = "[...]\n";
2417 }
2418 }
2419 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002420 ERROR("SWITCH_CASE_INDENT_LEVEL",
2421 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002422 }
2423 }
2424
2425# if/while/etc brace do not go on next line, unless defining a do while loop,
2426# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002427 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002428 my $pre_ctx = "$1$2";
2429
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002430 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002431
2432 if ($line =~ /^\+\t{6,}/) {
2433 WARN("DEEP_INDENTATION",
2434 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2435 }
2436
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002437 my $ctx_cnt = $realcnt - $#ctx - 1;
2438 my $ctx = join("\n", @ctx);
2439
Andy Whitcroft548596d2008-07-23 21:29:01 -07002440 my $ctx_ln = $linenr;
2441 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002442
Andy Whitcroft548596d2008-07-23 21:29:01 -07002443 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2444 defined $lines[$ctx_ln - 1] &&
2445 $lines[$ctx_ln - 1] =~ /^-/)) {
2446 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2447 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002448 $ctx_ln++;
2449 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002450
Andy Whitcroft53210162008-07-23 21:29:03 -07002451 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2452 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002453
2454 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002455 ERROR("OPEN_BRACE",
2456 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002457 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002458 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002459 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2460 $ctx =~ /\)\s*\;\s*$/ &&
2461 defined $lines[$ctx_ln - 1])
2462 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002463 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2464 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002465 WARN("TRAILING_SEMICOLON",
2466 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002467 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002468 }
2469 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002470 }
2471
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002472# Check relative indent for conditionals and blocks.
2473 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002474 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2475 ctx_statement_block($linenr, $realcnt, 0)
2476 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002477 my ($s, $c) = ($stat, $cond);
2478
2479 substr($s, 0, length($c), '');
2480
2481 # Make sure we remove the line prefixes as we have
2482 # none on the first line, and are going to readd them
2483 # where necessary.
2484 $s =~ s/\n./\n/gs;
2485
2486 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002487 my @newlines = ($c =~ /\n/gs);
2488 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002489
2490 # We want to check the first line inside the block
2491 # starting at the end of the conditional, so remove:
2492 # 1) any blank line termination
2493 # 2) any opening brace { on end of the line
2494 # 3) any do (...) {
2495 my $continuation = 0;
2496 my $check = 0;
2497 $s =~ s/^.*\bdo\b//;
2498 $s =~ s/^\s*{//;
2499 if ($s =~ s/^\s*\\//) {
2500 $continuation = 1;
2501 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002502 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002503 $check = 1;
2504 $cond_lines++;
2505 }
2506
2507 # Also ignore a loop construct at the end of a
2508 # preprocessor statement.
2509 if (($prevline =~ /^.\s*#\s*define\s/ ||
2510 $prevline =~ /\\\s*$/) && $continuation == 0) {
2511 $check = 0;
2512 }
2513
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002514 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002515 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002516 while ($cond_ptr != $cond_lines) {
2517 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002518
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002519 # If we see an #else/#elif then the code
2520 # is not linear.
2521 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2522 $check = 0;
2523 }
2524
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002525 # Ignore:
2526 # 1) blank lines, they should be at 0,
2527 # 2) preprocessor lines, and
2528 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002529 if ($continuation ||
2530 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002531 $s =~ /^\s*#\s*?/ ||
2532 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002533 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002534 if ($s =~ s/^.*?\n//) {
2535 $cond_lines++;
2536 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002537 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002538 }
2539
2540 my (undef, $sindent) = line_stats("+" . $s);
2541 my $stat_real = raw_line($linenr, $cond_lines);
2542
2543 # Check if either of these lines are modified, else
2544 # this is not this patch's fault.
2545 if (!defined($stat_real) ||
2546 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2547 $check = 0;
2548 }
2549 if (defined($stat_real) && $cond_lines > 1) {
2550 $stat_real = "[...]\n$stat_real";
2551 }
2552
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002553 #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 -07002554
2555 if ($check && (($sindent % 8) != 0 ||
2556 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002557 WARN("SUSPECT_CODE_INDENT",
2558 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002559 }
2560 }
2561
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002562 # Track the 'values' across context and added lines.
2563 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002564 my ($curr_values, $curr_vars) =
2565 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002566 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002567 if ($dbg_values) {
2568 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002569 print "$linenr > .$outline\n";
2570 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002571 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002572 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002573 $prev_values = substr($curr_values, -1);
2574
Andy Whitcroft00df3442007-06-08 13:47:06 -07002575#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002576 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002577
Andy Whitcroft653d4872007-06-23 17:16:34 -07002578# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002579 if ($dbg_type) {
2580 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002581 ERROR("TEST_TYPE",
2582 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002583 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002584 ERROR("TEST_NOT_TYPE",
2585 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002586 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002587 next;
2588 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002589# TEST: allow direct testing of the attribute matcher.
2590 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002591 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002592 ERROR("TEST_ATTR",
2593 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002594 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002595 ERROR("TEST_NOT_ATTR",
2596 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002597 }
2598 next;
2599 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002600
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002601# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002602 if ($line =~ /^.\s*{/ &&
2603 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002604 ERROR("OPEN_BRACE",
2605 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002606 }
2607
Andy Whitcroft653d4872007-06-23 17:16:34 -07002608#
2609# Checks which are anchored on the added line.
2610#
2611
2612# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002613 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002614 my $path = $1;
2615 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002616 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002617 "malformed #include filename\n" . $herecurr);
2618 }
2619 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2620 ERROR("UAPI_INCLUDE",
2621 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002622 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002623 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002624
2625# no C99 // comments
2626 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002627 if (ERROR("C99_COMMENTS",
2628 "do not use C99 // comments\n" . $herecurr) &&
2629 $fix) {
2630 my $line = $fixed[$linenr - 1];
2631 if ($line =~ /\/\/(.*)$/) {
2632 my $comment = trim($1);
2633 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2634 }
2635 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002636 }
2637 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002638 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002639 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002640
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002641# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2642# the whole statement.
2643#print "APW <$lines[$realline_next - 1]>\n";
2644 if (defined $realline_next &&
2645 exists $lines[$realline_next - 1] &&
2646 !defined $suppress_export{$realline_next} &&
2647 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2648 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002649 # Handle definitions which produce identifiers with
2650 # a prefix:
2651 # XXX(foo);
2652 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002653 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002654 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002655 $name =~ /^${Ident}_$2/) {
2656#print "FOO C name<$name>\n";
2657 $suppress_export{$realline_next} = 1;
2658
2659 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002660 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002661 ^.DEFINE_$Ident\(\Q$name\E\)|
2662 ^.DECLARE_$Ident\(\Q$name\E\)|
2663 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002664 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2665 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002666 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002667#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2668 $suppress_export{$realline_next} = 2;
2669 } else {
2670 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002671 }
2672 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002673 if (!defined $suppress_export{$linenr} &&
2674 $prevline =~ /^.\s*$/ &&
2675 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2676 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2677#print "FOO B <$lines[$linenr - 1]>\n";
2678 $suppress_export{$linenr} = 2;
2679 }
2680 if (defined $suppress_export{$linenr} &&
2681 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002682 WARN("EXPORT_SYMBOL",
2683 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002684 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002685
Joe Eloff5150bda2010-08-09 17:21:00 -07002686# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002687 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2688 if (ERROR("GLOBAL_INITIALISERS",
2689 "do not initialise globals to 0 or NULL\n" .
2690 $herecurr) &&
2691 $fix) {
2692 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2693 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002694 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002695# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002696 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2697 if (ERROR("INITIALISED_STATIC",
2698 "do not initialise statics to 0 or NULL\n" .
2699 $herecurr) &&
2700 $fix) {
2701 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2702 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002703 }
2704
Joe Perchescb710ec2010-10-26 14:23:20 -07002705# check for static const char * arrays.
2706 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002707 WARN("STATIC_CONST_CHAR_ARRAY",
2708 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002709 $herecurr);
2710 }
2711
2712# check for static char foo[] = "bar" declarations.
2713 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002714 WARN("STATIC_CONST_CHAR_ARRAY",
2715 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002716 $herecurr);
2717 }
2718
Joe Perches9b0fa602014-04-03 14:49:18 -07002719# check for non-global char *foo[] = {"bar", ...} declarations.
2720 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
2721 WARN("STATIC_CONST_CHAR_ARRAY",
2722 "char * array declaration might be better as static const\n" .
2723 $herecurr);
2724 }
2725
Joe Perchesb36190c2014-01-27 17:07:18 -08002726# check for function declarations without arguments like "int foo()"
2727 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2728 if (ERROR("FUNCTION_WITHOUT_ARGS",
2729 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2730 $fix) {
2731 $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2732 }
2733 }
2734
Joe Perches92e112f2013-12-13 11:36:22 -07002735# check for uses of DEFINE_PCI_DEVICE_TABLE
2736 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2737 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2738 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2739 $fix) {
2740 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2741 }
Joe Perches93ed0e22010-10-26 14:23:21 -07002742 }
2743
Andy Whitcroft653d4872007-06-23 17:16:34 -07002744# check for new typedefs, only function parameters and sparse annotations
2745# make sense.
2746 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002747 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002748 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002749 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002750 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002751 WARN("NEW_TYPEDEFS",
2752 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002753 }
2754
2755# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002756 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002757 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2758 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002759 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002760
Andy Whitcroft65863862009-01-06 14:41:21 -08002761 # Should start with a space.
2762 $to =~ s/^(\S)/ $1/;
2763 # Should not end with a space.
2764 $to =~ s/\s+$//;
2765 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002766 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002767 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002768
Joe Perches3705ce52013-07-03 15:05:31 -07002769## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08002770 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07002771 if (ERROR("POINTER_LOCATION",
2772 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2773 $fix) {
2774 my $sub_from = $ident;
2775 my $sub_to = $ident;
2776 $sub_to =~ s/\Q$from\E/$to/;
2777 $fixed[$linenr - 1] =~
2778 s@\Q$sub_from\E@$sub_to@;
2779 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002780 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002781 }
2782 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2783 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002784 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002785
Andy Whitcroft65863862009-01-06 14:41:21 -08002786 # Should start with a space.
2787 $to =~ s/^(\S)/ $1/;
2788 # Should not end with a space.
2789 $to =~ s/\s+$//;
2790 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002791 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002792 }
2793 # Modifiers should have spaces.
2794 $to =~ s/(\b$Modifier$)/$1 /;
2795
Joe Perches3705ce52013-07-03 15:05:31 -07002796## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08002797 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002798 if (ERROR("POINTER_LOCATION",
2799 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2800 $fix) {
2801
2802 my $sub_from = $match;
2803 my $sub_to = $match;
2804 $sub_to =~ s/\Q$from\E/$to/;
2805 $fixed[$linenr - 1] =~
2806 s@\Q$sub_from\E@$sub_to@;
2807 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002808 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002809 }
2810
2811# # no BUG() or BUG_ON()
2812# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2813# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2814# print "$herecurr";
2815# $clean = 0;
2816# }
2817
Andy Whitcroft8905a672007-11-28 16:21:06 -08002818 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002819 WARN("LINUX_VERSION_CODE",
2820 "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 -08002821 }
2822
Joe Perches17441222011-06-15 15:08:17 -07002823# check for uses of printk_ratelimit
2824 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002825 WARN("PRINTK_RATELIMITED",
2826"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002827 }
2828
Andy Whitcroft00df3442007-06-08 13:47:06 -07002829# printk should use KERN_* levels. Note that follow on printk's on the
2830# same line do not need a level, so we use the current block context
2831# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002832# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002833# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002834 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002835 my $ok = 0;
2836 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2837 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002838 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07002839 # with "\n" ignore it, else it is to blame
2840 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2841 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2842 $ok = 1;
2843 }
2844 last;
2845 }
2846 }
2847 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002848 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2849 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002850 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002851 }
2852
Joe Perches243f3802012-05-31 16:26:09 -07002853 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2854 my $orig = $1;
2855 my $level = lc($orig);
2856 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002857 my $level2 = $level;
2858 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002859 WARN("PREFER_PR_LEVEL",
Yogesh Chaudharidaa8b052014-04-03 14:49:23 -07002860 "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 -07002861 }
2862
2863 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002864 if (WARN("PREFER_PR_LEVEL",
2865 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2866 $fix) {
2867 $fixed[$linenr - 1] =~
2868 s/\bpr_warning\b/pr_warn/;
2869 }
Joe Perches243f3802012-05-31 16:26:09 -07002870 }
2871
Joe Perchesdc139312013-02-21 16:44:13 -08002872 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2873 my $orig = $1;
2874 my $level = lc($orig);
2875 $level = "warn" if ($level eq "warning");
2876 $level = "dbg" if ($level eq "debug");
2877 WARN("PREFER_DEV_LEVEL",
2878 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2879 }
2880
Andy Whitcroft653d4872007-06-23 17:16:34 -07002881# function brace can't be on same line, except for #defines of do while,
2882# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002883 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2884 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002885 ERROR("OPEN_BRACE",
2886 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002887 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002888
Andy Whitcroft8905a672007-11-28 16:21:06 -08002889# open braces for enum, union and struct go on the same line.
2890 if ($line =~ /^.\s*{/ &&
2891 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002892 ERROR("OPEN_BRACE",
2893 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002894 }
2895
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002896# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07002897 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2898 if (WARN("SPACING",
2899 "missing space after $1 definition\n" . $herecurr) &&
2900 $fix) {
2901 $fixed[$linenr - 1] =~
2902 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2903 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002904 }
2905
Joe Perches31070b52014-01-23 15:54:49 -08002906# Function pointer declarations
2907# check spacing between type, funcptr, and args
2908# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002909 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08002910 my $declare = $1;
2911 my $pre_pointer_space = $2;
2912 my $post_pointer_space = $3;
2913 my $funcname = $4;
2914 my $post_funcname_space = $5;
2915 my $pre_args_space = $6;
2916
Joe Perches91f72e92014-04-03 14:49:12 -07002917# the $Declare variable will capture all spaces after the type
2918# so check it for a missing trailing missing space but pointer return types
2919# don't need a space so don't warn for those.
2920 my $post_declare_space = "";
2921 if ($declare =~ /(\s+)$/) {
2922 $post_declare_space = $1;
2923 $declare = rtrim($declare);
2924 }
2925 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08002926 WARN("SPACING",
2927 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07002928 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08002929 }
2930
2931# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002932# This test is not currently implemented because these declarations are
2933# equivalent to
2934# int foo(int bar, ...)
2935# and this is form shouldn't/doesn't generate a checkpatch warning.
2936#
2937# elsif ($declare =~ /\s{2,}$/) {
2938# WARN("SPACING",
2939# "Multiple spaces after return type\n" . $herecurr);
2940# }
Joe Perches31070b52014-01-23 15:54:49 -08002941
2942# unnecessary space "type ( *funcptr)(args...)"
2943 if (defined $pre_pointer_space &&
2944 $pre_pointer_space =~ /^\s/) {
2945 WARN("SPACING",
2946 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
2947 }
2948
2949# unnecessary space "type (* funcptr)(args...)"
2950 if (defined $post_pointer_space &&
2951 $post_pointer_space =~ /^\s/) {
2952 WARN("SPACING",
2953 "Unnecessary space before function pointer name\n" . $herecurr);
2954 }
2955
2956# unnecessary space "type (*funcptr )(args...)"
2957 if (defined $post_funcname_space &&
2958 $post_funcname_space =~ /^\s/) {
2959 WARN("SPACING",
2960 "Unnecessary space after function pointer name\n" . $herecurr);
2961 }
2962
2963# unnecessary space "type (*funcptr) (args...)"
2964 if (defined $pre_args_space &&
2965 $pre_args_space =~ /^\s/) {
2966 WARN("SPACING",
2967 "Unnecessary space before function pointer arguments\n" . $herecurr);
2968 }
2969
2970 if (show_type("SPACING") && $fix) {
2971 $fixed[$linenr - 1] =~
Joe Perches91f72e92014-04-03 14:49:12 -07002972 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08002973 }
2974 }
2975
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002976# check for spacing round square brackets; allowed:
2977# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002978# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2979# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002980 while ($line =~ /(.*?\s)\[/g) {
2981 my ($where, $prefix) = ($-[1], $1);
2982 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002983 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002984 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002985 if (ERROR("BRACKET_SPACE",
2986 "space prohibited before open square bracket '['\n" . $herecurr) &&
2987 $fix) {
2988 $fixed[$linenr - 1] =~
2989 s/^(\+.*?)\s+\[/$1\[/;
2990 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002991 }
2992 }
2993
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002994# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002995 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002996 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002997 my $ctx_before = substr($line, 0, $-[1]);
2998 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002999
3000 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003001 if ($name =~ /^(?:
3002 if|for|while|switch|return|case|
3003 volatile|__volatile__|
3004 __attribute__|format|__extension__|
3005 asm|__asm__)$/x)
3006 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003007 # cpp #define statements have non-optional spaces, ie
3008 # if there is a space between the name and the open
3009 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003010 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003011
3012 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003013 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003014
3015 # If this whole things ends with a type its most
3016 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003017 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003018
3019 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07003020 if (WARN("SPACING",
3021 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
3022 $fix) {
3023 $fixed[$linenr - 1] =~
3024 s/\b$name\s+\(/$name\(/;
3025 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003026 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003027 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003028
Andy Whitcroft653d4872007-06-23 17:16:34 -07003029# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003030 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003031 my $fixed_line = "";
3032 my $line_fixed = 0;
3033
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003034 my $ops = qr{
3035 <<=|>>=|<=|>=|==|!=|
3036 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3037 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003038 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003039 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003040 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003041 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003042
3043## print("element count: <" . $#elements . ">\n");
3044## foreach my $el (@elements) {
3045## print("el: <$el>\n");
3046## }
3047
3048 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07003049 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003050
Joe Perches3705ce52013-07-03 15:05:31 -07003051 foreach my $el (@elements) {
3052 push(@fix_elements, substr($rawline, $off, length($el)));
3053 $off += length($el);
3054 }
3055
3056 $off = 0;
3057
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003058 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003059 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003060
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003061 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003062
3063 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3064
3065## print("n: <$n> good: <$good>\n");
3066
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003067 $off += length($elements[$n]);
3068
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003069 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003070 my $ca = substr($opline, 0, $off);
3071 my $cc = '';
3072 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3073 $cc = substr($opline, $off + length($elements[$n + 1]));
3074 }
3075 my $cb = "$ca$;$cc";
3076
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003077 my $a = '';
3078 $a = 'V' if ($elements[$n] ne '');
3079 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003080 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003081 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3082 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003083 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003084
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003085 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003086
3087 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003088 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003089 $c = 'V' if ($elements[$n + 2] ne '');
3090 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003091 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003092 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3093 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003094 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003095 } else {
3096 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003097 }
3098
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003099 my $ctx = "${a}x${c}";
3100
3101 my $at = "(ctx:$ctx)";
3102
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003103 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003104 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003105
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003106 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003107 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003108
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003109 # Get the full operator variant.
3110 my $opv = $op . substr($curr_vars, $off, 1);
3111
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003112 # Ignore operators passed as parameters.
3113 if ($op_type ne 'V' &&
3114 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3115
Andy Whitcroftcf655042008-03-04 14:28:20 -08003116# # Ignore comments
3117# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003118
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003119 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003120 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003121 if ($ctx !~ /.x[WEBC]/ &&
3122 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003123 if (ERROR("SPACING",
3124 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003125 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003126 $line_fixed = 1;
3127 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003128 }
3129
3130 # // is a comment
3131 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003132
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003133 # No spaces for:
3134 # ->
3135 # : when part of a bitfield
3136 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003137 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003138 if (ERROR("SPACING",
3139 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003140 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003141 if (defined $fix_elements[$n + 2]) {
3142 $fix_elements[$n + 2] =~ s/^\s+//;
3143 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003144 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003145 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003146 }
3147
3148 # , must have a space on the right.
3149 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003150 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003151 if (ERROR("SPACING",
3152 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003153 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003154 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003155 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07003156 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003157 }
3158
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003159 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003160 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003161 #warn "'*' is part of type\n";
3162
3163 # unary operators should have a space before and
3164 # none after. May be left adjacent to another
3165 # unary operator, or a cast
3166 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003167 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003168 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003169 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003170 if (ERROR("SPACING",
3171 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003172 if ($n != $last_after + 2) {
3173 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3174 $line_fixed = 1;
3175 }
Joe Perches3705ce52013-07-03 15:05:31 -07003176 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003177 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003178 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003179 # A unary '*' may be const
3180
3181 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003182 if (ERROR("SPACING",
3183 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003184 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003185 if (defined $fix_elements[$n + 2]) {
3186 $fix_elements[$n + 2] =~ s/^\s+//;
3187 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003188 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003189 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003190 }
3191
3192 # unary ++ and unary -- are allowed no space on one side.
3193 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003194 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003195 if (ERROR("SPACING",
3196 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003197 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003198 $line_fixed = 1;
3199 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003200 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003201 if ($ctx =~ /Wx[BE]/ ||
3202 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003203 if (ERROR("SPACING",
3204 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003205 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003206 $line_fixed = 1;
3207 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003208 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003209 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003210 if (ERROR("SPACING",
3211 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003212 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003213 if (defined $fix_elements[$n + 2]) {
3214 $fix_elements[$n + 2] =~ s/^\s+//;
3215 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003216 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003217 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003218 }
3219
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003220 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003221 } elsif ($op eq '<<' or $op eq '>>' or
3222 $op eq '&' or $op eq '^' or $op eq '|' or
3223 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003224 $op eq '*' or $op eq '/' or
3225 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003226 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003227 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003228 if (ERROR("SPACING",
3229 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003230 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3231 if (defined $fix_elements[$n + 2]) {
3232 $fix_elements[$n + 2] =~ s/^\s+//;
3233 }
Joe Perches3705ce52013-07-03 15:05:31 -07003234 $line_fixed = 1;
3235 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003236 }
3237
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003238 # A colon needs no spaces before when it is
3239 # terminating a case value or a label.
3240 } elsif ($opv eq ':C' || $opv eq ':L') {
3241 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003242 if (ERROR("SPACING",
3243 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003244 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003245 $line_fixed = 1;
3246 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003247 }
3248
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003249 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003250 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003251 my $ok = 0;
3252
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003253 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003254 if (($op eq '<' &&
3255 $cc =~ /^\S+\@\S+>/) ||
3256 ($op eq '>' &&
3257 $ca =~ /<\S+\@\S+$/))
3258 {
3259 $ok = 1;
3260 }
3261
Joe Perches84731622013-11-12 15:10:05 -08003262 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003263 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003264 my $msg_type = \&ERROR;
3265 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3266
3267 if (&{$msg_type}("SPACING",
3268 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003269 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3270 if (defined $fix_elements[$n + 2]) {
3271 $fix_elements[$n + 2] =~ s/^\s+//;
3272 }
Joe Perches3705ce52013-07-03 15:05:31 -07003273 $line_fixed = 1;
3274 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003275 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003276 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003277 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003278
3279## print("n: <$n> GOOD: <$good>\n");
3280
3281 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003282 }
Joe Perches3705ce52013-07-03 15:05:31 -07003283
3284 if (($#elements % 2) == 0) {
3285 $fixed_line = $fixed_line . $fix_elements[$#elements];
3286 }
3287
3288 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3289 $fixed[$linenr - 1] = $fixed_line;
3290 }
3291
3292
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003293 }
3294
Joe Perches786b6322013-07-03 15:05:32 -07003295# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003296 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003297 if (WARN("SPACING",
3298 "space prohibited before semicolon\n" . $herecurr) &&
3299 $fix) {
3300 1 while $fixed[$linenr - 1] =~
3301 s/^(\+.*\S)\s+;/$1;/;
3302 }
3303 }
3304
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003305# check for multiple assignments
3306 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003307 CHK("MULTIPLE_ASSIGNMENTS",
3308 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003309 }
3310
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003311## # check for multiple declarations, allowing for a function declaration
3312## # continuation.
3313## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3314## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3315##
3316## # Remove any bracketed sections to ensure we do not
3317## # falsly report the parameters of functions.
3318## my $ln = $line;
3319## while ($ln =~ s/\([^\(\)]*\)//g) {
3320## }
3321## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003322## WARN("MULTIPLE_DECLARATION",
3323## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003324## }
3325## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003326
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003327#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003328 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3329 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003330 if (ERROR("SPACING",
3331 "space required before the open brace '{'\n" . $herecurr) &&
3332 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003333 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003334 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003335 }
3336
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003337## # check for blank lines before declarations
3338## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3339## $prevrawline =~ /^.\s*$/) {
3340## WARN("SPACING",
3341## "No blank lines before declarations\n" . $hereprev);
3342## }
3343##
3344
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003345# closing brace should have a space following it when it has anything
3346# on the line
3347 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003348 if (ERROR("SPACING",
3349 "space required after that close brace '}'\n" . $herecurr) &&
3350 $fix) {
3351 $fixed[$linenr - 1] =~
3352 s/}((?!(?:,|;|\)))\S)/} $1/;
3353 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003354 }
3355
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003356# check spacing on square brackets
3357 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003358 if (ERROR("SPACING",
3359 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3360 $fix) {
3361 $fixed[$linenr - 1] =~
3362 s/\[\s+/\[/;
3363 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003364 }
3365 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003366 if (ERROR("SPACING",
3367 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3368 $fix) {
3369 $fixed[$linenr - 1] =~
3370 s/\s+\]/\]/;
3371 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003372 }
3373
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003374# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003375 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3376 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003377 if (ERROR("SPACING",
3378 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3379 $fix) {
3380 $fixed[$linenr - 1] =~
3381 s/\(\s+/\(/;
3382 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003383 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003384 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003385 $line !~ /for\s*\(.*;\s+\)/ &&
3386 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003387 if (ERROR("SPACING",
3388 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3389 $fix) {
3390 $fixed[$linenr - 1] =~
3391 s/\s+\)/\)/;
3392 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003393 }
3394
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003395#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003396 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003397 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003398 if (WARN("INDENTED_LABEL",
3399 "labels should not be indented\n" . $herecurr) &&
3400 $fix) {
3401 $fixed[$linenr - 1] =~
3402 s/^(.)\s+/$1/;
3403 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003404 }
3405
Joe Perches5b9553a2014-04-03 14:49:21 -07003406# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003407 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003408 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003409 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003410 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3411 my $value = $1;
3412 $value = deparenthesize($value);
3413 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3414 ERROR("RETURN_PARENTHESES",
3415 "return is not a function, parentheses are not required\n" . $herecurr);
3416 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003417 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003418 ERROR("SPACING",
3419 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003420 }
3421 }
Joe Perches507e5142013-11-12 15:10:13 -08003422
Joe Perches189248d2014-01-23 15:54:47 -08003423# if statements using unnecessary parentheses - ie: if ((foo == bar))
3424 if ($^V && $^V ge 5.10.0 &&
3425 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3426 my $openparens = $1;
3427 my $count = $openparens =~ tr@\(@\(@;
3428 my $msg = "";
3429 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3430 my $comp = $4; #Not $1 because of $LvalOrFunc
3431 $msg = " - maybe == should be = ?" if ($comp eq "==");
3432 WARN("UNNECESSARY_PARENTHESES",
3433 "Unnecessary parentheses$msg\n" . $herecurr);
3434 }
3435 }
3436
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003437# Return of what appears to be an errno should normally be -'ve
3438 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3439 my $name = $1;
3440 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003441 WARN("USE_NEGATIVE_ERRNO",
3442 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003443 }
3444 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003445
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003446# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003447 if ($line =~ /\b(if|while|for|switch)\(/) {
3448 if (ERROR("SPACING",
3449 "space required before the open parenthesis '('\n" . $herecurr) &&
3450 $fix) {
3451 $fixed[$linenr - 1] =~
3452 s/\b(if|while|for|switch)\(/$1 \(/;
3453 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003454 }
3455
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003456# Check for illegal assignment in if conditional -- and check for trailing
3457# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003458 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003459 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3460 ctx_statement_block($linenr, $realcnt, 0)
3461 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003462 my ($stat_next) = ctx_statement_block($line_nr_next,
3463 $remain_next, $off_next);
3464 $stat_next =~ s/\n./\n /g;
3465 ##print "stat<$stat> stat_next<$stat_next>\n";
3466
3467 if ($stat_next =~ /^\s*while\b/) {
3468 # If the statement carries leading newlines,
3469 # then count those as offsets.
3470 my ($whitespace) =
3471 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3472 my $offset =
3473 statement_rawlines($whitespace) - 1;
3474
3475 $suppress_whiletrailers{$line_nr_next +
3476 $offset} = 1;
3477 }
3478 }
3479 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003480 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003481 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003482 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003483
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003484 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003485 ERROR("ASSIGN_IN_IF",
3486 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003487 }
3488
3489 # Find out what is on the end of the line after the
3490 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003491 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003492 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003493 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003494 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3495 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003496 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003497 # Find out how long the conditional actually is.
3498 my @newlines = ($c =~ /\n/gs);
3499 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003500 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003501
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003502 $stat_real = raw_line($linenr, $cond_lines)
3503 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003504 if (defined($stat_real) && $cond_lines > 1) {
3505 $stat_real = "[...]\n$stat_real";
3506 }
3507
Joe Perches000d1cc12011-07-25 17:13:25 -07003508 ERROR("TRAILING_STATEMENTS",
3509 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003510 }
3511 }
3512
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003513# Check for bitwise tests written as boolean
3514 if ($line =~ /
3515 (?:
3516 (?:\[|\(|\&\&|\|\|)
3517 \s*0[xX][0-9]+\s*
3518 (?:\&\&|\|\|)
3519 |
3520 (?:\&\&|\|\|)
3521 \s*0[xX][0-9]+\s*
3522 (?:\&\&|\|\||\)|\])
3523 )/x)
3524 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003525 WARN("HEXADECIMAL_BOOLEAN_TEST",
3526 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003527 }
3528
Andy Whitcroft8905a672007-11-28 16:21:06 -08003529# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003530 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3531 my $s = $1;
3532 $s =~ s/$;//g; # Remove any comments
3533 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003534 ERROR("TRAILING_STATEMENTS",
3535 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003536 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003537 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003538# if should not continue a brace
3539 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003540 ERROR("TRAILING_STATEMENTS",
3541 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003542 $herecurr);
3543 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003544# case and default should not have general statements after them
3545 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3546 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003547 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003548 \s*return\s+
3549 )/xg)
3550 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003551 ERROR("TRAILING_STATEMENTS",
3552 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003553 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003554
3555 # Check for }<nl>else {, these must be at the same
3556 # indent level to be relevant to each other.
3557 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3558 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003559 ERROR("ELSE_AFTER_BRACE",
3560 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003561 }
3562
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003563 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3564 $previndent == $indent) {
3565 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3566
3567 # Find out what is on the end of the line after the
3568 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003569 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003570 $s =~ s/\n.*//g;
3571
3572 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003573 ERROR("WHILE_AFTER_BRACE",
3574 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003575 }
3576 }
3577
Joe Perches95e2c602013-07-03 15:05:20 -07003578#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003579 while ($line =~ m{($Constant|$Lval)}g) {
3580 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003581
3582#gcc binary extension
3583 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003584 if (WARN("GCC_BINARY_CONSTANT",
3585 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3586 $fix) {
3587 my $hexval = sprintf("0x%x", oct($var));
3588 $fixed[$linenr - 1] =~
3589 s/\b$var\b/$hexval/;
3590 }
Joe Perches95e2c602013-07-03 15:05:20 -07003591 }
3592
3593#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003594 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003595 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003596#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003597 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003598#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003599 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003600 while ($var =~ m{($Ident)}g) {
3601 my $word = $1;
3602 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08003603 if ($check) {
3604 seed_camelcase_includes();
3605 if (!$file && !$camelcase_file_seeded) {
3606 seed_camelcase_file($realfile);
3607 $camelcase_file_seeded = 1;
3608 }
3609 }
Joe Perches7e781f62013-09-11 14:23:55 -07003610 if (!defined $camelcase{$word}) {
3611 $camelcase{$word} = 1;
3612 CHK("CAMELCASE",
3613 "Avoid CamelCase: <$word>\n" . $herecurr);
3614 }
Joe Perches34456862013-07-03 15:05:34 -07003615 }
Joe Perches323c1262012-12-17 16:02:07 -08003616 }
3617 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003618
3619#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003620 if ($line =~ /\#\s*define.*\\\s+$/) {
3621 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3622 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3623 $fix) {
3624 $fixed[$linenr - 1] =~ s/\s+$//;
3625 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003626 }
3627
Andy Whitcroft653d4872007-06-23 17:16:34 -07003628#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003629 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003630 my $file = "$1.h";
3631 my $checkfile = "include/linux/$file";
3632 if (-f "$root/$checkfile" &&
3633 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003634 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003635 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003636 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003637 CHK("ARCH_INCLUDE_LINUX",
3638 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003639 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003640 WARN("INCLUDE_LINUX",
3641 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003642 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003643 }
3644 }
3645
Andy Whitcroft653d4872007-06-23 17:16:34 -07003646# multi-statement macros should be enclosed in a do while loop, grab the
3647# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003648# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07003649 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3650 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003651 my $ln = $linenr;
3652 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003653 my ($off, $dstat, $dcond, $rest);
3654 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003655 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003656 ctx_statement_block($linenr, $realcnt, 0);
3657 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003658 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003659 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003660
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003661 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003662 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003663 $dstat =~ s/\\\n.//g;
3664 $dstat =~ s/^\s*//s;
3665 $dstat =~ s/\s*$//s;
3666
3667 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003668 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3669 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003670 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003671 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003672 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003673
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003674 # Flatten any obvious string concatentation.
3675 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3676 $dstat =~ s/$Ident\s*("X*")/$1/)
3677 {
3678 }
3679
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003680 my $exceptions = qr{
3681 $Declare|
3682 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003683 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003684 DECLARE_PER_CPU|
3685 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003686 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003687 union|
3688 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003689 \.$Ident\s*=\s*|
3690 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003691 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003692 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003693 if ($dstat ne '' &&
3694 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3695 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07003696 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003697 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003698 $dstat !~ /$exceptions/ &&
3699 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003700 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003701 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003702 $dstat !~ /^for\s*$Constant$/ && # for (...)
3703 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3704 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07003705 $dstat !~ /^\({/ && # ({...
3706 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003707 {
3708 $ctx =~ s/\n*$//;
3709 my $herectx = $here . "\n";
3710 my $cnt = statement_rawlines($ctx);
3711
3712 for (my $n = 0; $n < $cnt; $n++) {
3713 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003714 }
3715
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003716 if ($dstat =~ /;/) {
3717 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3718 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3719 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003720 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003721 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003722 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003723 }
Joe Perches5023d342012-12-17 16:01:47 -08003724
Joe Perches481eb482012-12-17 16:01:56 -08003725# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003726
3727 } else {
3728 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003729 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3730 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003731 $line =~ /^\+.*\\$/) {
3732 WARN("LINE_CONTINUATIONS",
3733 "Avoid unnecessary line continuations\n" . $herecurr);
3734 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003735 }
3736
Joe Perchesb13edf72012-07-30 14:41:24 -07003737# do {} while (0) macro tests:
3738# single-statement macros do not need to be enclosed in do while (0) loop,
3739# macro should not end with a semicolon
3740 if ($^V && $^V ge 5.10.0 &&
3741 $realfile !~ m@/vmlinux.lds.h$@ &&
3742 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3743 my $ln = $linenr;
3744 my $cnt = $realcnt;
3745 my ($off, $dstat, $dcond, $rest);
3746 my $ctx = '';
3747 ($dstat, $dcond, $ln, $cnt, $off) =
3748 ctx_statement_block($linenr, $realcnt, 0);
3749 $ctx = $dstat;
3750
3751 $dstat =~ s/\\\n.//g;
3752
3753 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3754 my $stmts = $2;
3755 my $semis = $3;
3756
3757 $ctx =~ s/\n*$//;
3758 my $cnt = statement_rawlines($ctx);
3759 my $herectx = $here . "\n";
3760
3761 for (my $n = 0; $n < $cnt; $n++) {
3762 $herectx .= raw_line($linenr, $n) . "\n";
3763 }
3764
Joe Perchesac8e97f2012-08-21 16:15:53 -07003765 if (($stmts =~ tr/;/;/) == 1 &&
3766 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003767 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3768 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3769 }
3770 if (defined $semis && $semis ne "") {
3771 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3772 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3773 }
3774 }
3775 }
3776
Mike Frysinger080ba922009-01-06 14:41:25 -08003777# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3778# all assignments may have only one of the following with an assignment:
3779# .
3780# ALIGN(...)
3781# VMLINUX_SYMBOL(...)
3782 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003783 WARN("MISSING_VMLINUX_SYMBOL",
3784 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003785 }
3786
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003787# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003788 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3789 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003790 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003791 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003792 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3793 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003794 my @allowed = ();
3795 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003796 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003797 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003798 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003799 for my $chunk (@chunks) {
3800 my ($cond, $block) = @{$chunk};
3801
Andy Whitcroft773647a2008-03-28 14:15:58 -07003802 # If the condition carries leading newlines, then count those as offsets.
3803 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3804 my $offset = statement_rawlines($whitespace) - 1;
3805
Joe Perchesaad4f612012-03-23 15:02:19 -07003806 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003807 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3808
3809 # We have looked at and allowed this specific line.
3810 $suppress_ifbraces{$ln + $offset} = 1;
3811
3812 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003813 $ln += statement_rawlines($block) - 1;
3814
Andy Whitcroft773647a2008-03-28 14:15:58 -07003815 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003816
3817 $seen++ if ($block =~ /^\s*{/);
3818
Joe Perchesaad4f612012-03-23 15:02:19 -07003819 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003820 if (statement_lines($cond) > 1) {
3821 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003822 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003823 }
3824 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003825 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003826 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003827 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003828 if (statement_block_size($block) > 1) {
3829 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003830 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003831 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003832 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003833 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003834 if ($seen) {
3835 my $sum_allowed = 0;
3836 foreach (@allowed) {
3837 $sum_allowed += $_;
3838 }
3839 if ($sum_allowed == 0) {
3840 WARN("BRACES",
3841 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3842 } elsif ($sum_allowed != $allow &&
3843 $seen != $allow) {
3844 CHK("BRACES",
3845 "braces {} should be used on all arms of this statement\n" . $herectx);
3846 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003847 }
3848 }
3849 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003850 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003851 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003852 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003853
Andy Whitcroftcf655042008-03-04 14:28:20 -08003854 # Check the pre-context.
3855 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3856 #print "APW: ALLOWED: pre<$1>\n";
3857 $allowed = 1;
3858 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003859
3860 my ($level, $endln, @chunks) =
3861 ctx_statement_full($linenr, $realcnt, $-[0]);
3862
Andy Whitcroftcf655042008-03-04 14:28:20 -08003863 # Check the condition.
3864 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003865 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003866 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003867 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003868 }
3869 if (statement_lines($cond) > 1) {
3870 #print "APW: ALLOWED: cond<$cond>\n";
3871 $allowed = 1;
3872 }
3873 if ($block =~/\b(?:if|for|while)\b/) {
3874 #print "APW: ALLOWED: block<$block>\n";
3875 $allowed = 1;
3876 }
3877 if (statement_block_size($block) > 1) {
3878 #print "APW: ALLOWED: lines block<$block>\n";
3879 $allowed = 1;
3880 }
3881 # Check the post-context.
3882 if (defined $chunks[1]) {
3883 my ($cond, $block) = @{$chunks[1]};
3884 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003885 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003886 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003887 if ($block =~ /^\s*\{/) {
3888 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3889 $allowed = 1;
3890 }
3891 }
3892 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003893 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003894 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003895
Andy Whitcroftf0556632008-10-15 22:02:23 -07003896 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003897 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003898 }
3899
Joe Perches000d1cc12011-07-25 17:13:25 -07003900 WARN("BRACES",
3901 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003902 }
3903 }
3904
Joe Perches0979ae62012-12-17 16:01:59 -08003905# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07003906 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003907 CHK("BRACES",
3908 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3909 }
Joe Perches77b9a532013-07-03 15:05:29 -07003910 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003911 CHK("BRACES",
3912 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3913 }
3914
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003915# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003916 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3917 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003918 WARN("VOLATILE",
3919 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003920 }
3921
Andy Whitcroft00df3442007-06-08 13:47:06 -07003922# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003923 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003924 CHK("REDUNDANT_CODE",
3925 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003926 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003927 }
3928
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003929# check for needless "if (<foo>) fn(<foo>)" uses
3930 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3931 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3932 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3933 WARN('NEEDLESS_IF',
3934 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003935 }
3936 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003937
Joe Perches8716de32013-09-11 14:24:05 -07003938# check for bad placement of section $InitAttribute (e.g.: __initdata)
3939 if ($line =~ /(\b$InitAttribute\b)/) {
3940 my $attr = $1;
3941 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
3942 my $ptr = $1;
3943 my $var = $2;
3944 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
3945 ERROR("MISPLACED_INIT",
3946 "$attr should be placed after $var\n" . $herecurr)) ||
3947 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
3948 WARN("MISPLACED_INIT",
3949 "$attr should be placed after $var\n" . $herecurr))) &&
3950 $fix) {
3951 $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;
3952 }
3953 }
3954 }
3955
Joe Perchese970b882013-11-12 15:10:10 -08003956# check for $InitAttributeData (ie: __initdata) with const
3957 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
3958 my $attr = $1;
3959 $attr =~ /($InitAttributePrefix)(.*)/;
3960 my $attr_prefix = $1;
3961 my $attr_type = $2;
3962 if (ERROR("INIT_ATTRIBUTE",
3963 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
3964 $fix) {
3965 $fixed[$linenr - 1] =~
3966 s/$InitAttributeData/${attr_prefix}initconst/;
3967 }
3968 }
3969
3970# check for $InitAttributeConst (ie: __initconst) without const
3971 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
3972 my $attr = $1;
3973 if (ERROR("INIT_ATTRIBUTE",
3974 "Use of $attr requires a separate use of const\n" . $herecurr) &&
3975 $fix) {
3976 my $lead = $fixed[$linenr - 1] =~
3977 /(^\+\s*(?:static\s+))/;
3978 $lead = rtrim($1);
3979 $lead = "$lead " if ($lead !~ /^\+$/);
3980 $lead = "${lead}const ";
3981 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
3982 }
3983 }
3984
Joe Perchesfbdb8132014-04-03 14:49:14 -07003985# don't use __constant_<foo> functions outside of include/uapi/
3986 if ($realfile !~ m@^include/uapi/@ &&
3987 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
3988 my $constant_func = $1;
3989 my $func = $constant_func;
3990 $func =~ s/^__constant_//;
3991 if (WARN("CONSTANT_CONVERSION",
3992 "$constant_func should be $func\n" . $herecurr) &&
3993 $fix) {
3994 $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
3995 }
3996 }
3997
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003998# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08003999 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07004000 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004001 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07004002 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004003 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07004004 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4005 }
4006 if ($delay > 2000) {
4007 WARN("LONG_UDELAY",
4008 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07004009 }
4010 }
4011
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004012# warn about unexpectedly long msleep's
4013 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
4014 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004015 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07004016 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07004017 }
4018 }
4019
Joe Perches36ec1932013-07-03 15:05:25 -07004020# check for comparisons of jiffies
4021 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
4022 WARN("JIFFIES_COMPARISON",
4023 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4024 }
4025
Joe Perches9d7a34a2013-07-03 15:05:26 -07004026# check for comparisons of get_jiffies_64()
4027 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4028 WARN("JIFFIES_COMPARISON",
4029 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4030 }
4031
Andy Whitcroft00df3442007-06-08 13:47:06 -07004032# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004033# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07004034# print "#ifdef in C files should be avoided\n";
4035# print "$herecurr";
4036# $clean = 0;
4037# }
4038
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004039# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004040 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004041 if (ERROR("SPACING",
4042 "exactly one space required after that #$1\n" . $herecurr) &&
4043 $fix) {
4044 $fixed[$linenr - 1] =~
4045 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4046 }
4047
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004048 }
4049
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004050# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004051 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4052 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004053 my $which = $1;
4054 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004055 CHK("UNCOMMENTED_DEFINITION",
4056 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004057 }
4058 }
4059# check for memory barriers without a comment.
4060 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4061 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004062 WARN("MEMORY_BARRIER",
4063 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004064 }
4065 }
4066# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004067 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004068 CHK("ARCH_DEFINES",
4069 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004070 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004071
Tobias Klauserd4977c72010-05-24 14:33:30 -07004072# Check that the storage class is at the beginning of a declaration
4073 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004074 WARN("STORAGE_CLASS",
4075 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004076 }
4077
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004078# check the location of the inline attribute, that it is between
4079# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004080 if ($line =~ /\b$Type\s+$Inline\b/ ||
4081 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004082 ERROR("INLINE_LOCATION",
4083 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004084 }
4085
Andy Whitcroft8905a672007-11-28 16:21:06 -08004086# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004087 if ($realfile !~ m@\binclude/uapi/@ &&
4088 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004089 if (WARN("INLINE",
4090 "plain inline is preferred over $1\n" . $herecurr) &&
4091 $fix) {
4092 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4093
4094 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004095 }
4096
Joe Perches3d130fd2011-01-12 17:00:00 -08004097# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004098 if ($realfile !~ m@\binclude/uapi/@ &&
4099 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004100 WARN("PREFER_PACKED",
4101 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004102 }
4103
Joe Perches39b7e282011-07-25 17:13:24 -07004104# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004105 if ($realfile !~ m@\binclude/uapi/@ &&
4106 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004107 WARN("PREFER_ALIGNED",
4108 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004109 }
4110
Joe Perches5f14d3b2012-01-10 15:09:52 -08004111# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004112 if ($realfile !~ m@\binclude/uapi/@ &&
4113 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004114 if (WARN("PREFER_PRINTF",
4115 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4116 $fix) {
4117 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4118
4119 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004120 }
4121
Joe Perches6061d942012-03-23 15:02:16 -07004122# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004123 if ($realfile !~ m@\binclude/uapi/@ &&
4124 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004125 if (WARN("PREFER_SCANF",
4126 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4127 $fix) {
4128 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4129 }
Joe Perches6061d942012-03-23 15:02:16 -07004130 }
4131
Joe Perches8f53a9b2010-03-05 13:43:48 -08004132# check for sizeof(&)
4133 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004134 WARN("SIZEOF_ADDRESS",
4135 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004136 }
4137
Joe Perches66c80b62012-07-30 14:41:22 -07004138# check for sizeof without parenthesis
4139 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004140 if (WARN("SIZEOF_PARENTHESIS",
4141 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4142 $fix) {
4143 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4144 }
Joe Perches66c80b62012-07-30 14:41:22 -07004145 }
4146
Joe Perches428e2fd2011-05-24 17:13:39 -07004147# check for line continuations in quoted strings with odd counts of "
4148 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004149 WARN("LINE_CONTINUATIONS",
4150 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004151 }
4152
Joe Perches88982fe2012-12-17 16:02:00 -08004153# check for struct spinlock declarations
4154 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4155 WARN("USE_SPINLOCK_T",
4156 "struct spinlock should be spinlock_t\n" . $herecurr);
4157 }
4158
Joe Perchesa6962d72013-04-29 16:18:13 -07004159# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004160 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004161 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004162 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004163 if (WARN("PREFER_SEQ_PUTS",
4164 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4165 $fix) {
4166 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4167 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004168 }
4169 }
4170
Andy Whitcroft554e1652012-01-10 15:09:57 -08004171# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004172 if ($^V && $^V ge 5.10.0 &&
4173 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004174 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004175
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004176 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004177 my $ms_val = $7;
4178 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004179
Andy Whitcroft554e1652012-01-10 15:09:57 -08004180 if ($ms_size =~ /^(0x|)0$/i) {
4181 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004182 "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 -08004183 } elsif ($ms_size =~ /^(0x|)1$/i) {
4184 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004185 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4186 }
4187 }
4188
Joe Perches98a9bba2014-01-23 15:54:52 -08004189# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4190 if ($^V && $^V ge 5.10.0 &&
4191 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4192 if (WARN("PREFER_ETHER_ADDR_COPY",
4193 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4194 $fix) {
4195 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4196 }
4197 }
4198
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004199# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004200 if ($^V && $^V ge 5.10.0 &&
4201 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004202 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004203 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004204 my $call = $1;
4205 my $cast1 = deparenthesize($2);
4206 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004207 my $cast2 = deparenthesize($7);
4208 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004209 my $cast;
4210
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004211 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004212 $cast = "$cast1 or $cast2";
4213 } elsif ($cast1 ne "") {
4214 $cast = $cast1;
4215 } else {
4216 $cast = $cast2;
4217 }
4218 WARN("MINMAX",
4219 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004220 }
4221 }
4222
Joe Perches4a273192012-07-30 14:41:20 -07004223# check usleep_range arguments
4224 if ($^V && $^V ge 5.10.0 &&
4225 defined $stat &&
4226 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4227 my $min = $1;
4228 my $max = $7;
4229 if ($min eq $max) {
4230 WARN("USLEEP_RANGE",
4231 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4232 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4233 $min > $max) {
4234 WARN("USLEEP_RANGE",
4235 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4236 }
4237 }
4238
Joe Perches823b7942013-11-12 15:10:15 -08004239# check for naked sscanf
4240 if ($^V && $^V ge 5.10.0 &&
4241 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004242 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004243 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4244 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4245 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4246 my $lc = $stat =~ tr@\n@@;
4247 $lc = $lc + $linenr;
4248 my $stat_real = raw_line($linenr, 0);
4249 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4250 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4251 }
4252 WARN("NAKED_SSCANF",
4253 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4254 }
4255
Joe Perches70dc8a42013-09-11 14:23:58 -07004256# check for new externs in .h files.
4257 if ($realfile =~ /\.h$/ &&
4258 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004259 if (CHK("AVOID_EXTERNS",
4260 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004261 $fix) {
4262 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4263 }
4264 }
4265
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004266# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004267 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004268 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004269 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004270 my $function_name = $1;
4271 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004272
4273 my $s = $stat;
4274 if (defined $cond) {
4275 substr($s, 0, length($cond), '');
4276 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004277 if ($s =~ /^\s*;/ &&
4278 $function_name ne 'uninitialized_var')
4279 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004280 WARN("AVOID_EXTERNS",
4281 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004282 }
4283
4284 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004285 WARN("FUNCTION_ARGUMENTS",
4286 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004287 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004288
4289 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4290 $stat =~ /^.\s*extern\s+/)
4291 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004292 WARN("AVOID_EXTERNS",
4293 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004294 }
4295
4296# checks for new __setup's
4297 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4298 my $name = $1;
4299
4300 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004301 CHK("UNDOCUMENTED_SETUP",
4302 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004303 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004304 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004305
4306# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004307 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004308 WARN("UNNECESSARY_CASTS",
4309 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004310 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004311
Joe Perchesa640d252013-07-03 15:05:21 -07004312# alloc style
4313# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4314 if ($^V && $^V ge 5.10.0 &&
4315 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4316 CHK("ALLOC_SIZEOF_STRUCT",
4317 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4318 }
4319
Joe Perches972fdea2013-04-29 16:18:12 -07004320# check for krealloc arg reuse
4321 if ($^V && $^V ge 5.10.0 &&
4322 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4323 WARN("KREALLOC_ARG_REUSE",
4324 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4325 }
4326
Joe Perches5ce59ae2013-02-21 16:44:18 -08004327# check for alloc argument mismatch
4328 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4329 WARN("ALLOC_ARRAY_ARGS",
4330 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4331 }
4332
Joe Perchescaf2a542011-01-12 16:59:56 -08004333# check for multiple semicolons
4334 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004335 if (WARN("ONE_SEMICOLON",
4336 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4337 $fix) {
4338 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4339 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004340 }
4341
Joe Perchesc34c09a2014-01-23 15:54:43 -08004342# check for case / default statements not preceeded by break/fallthrough/switch
4343 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4344 my $has_break = 0;
4345 my $has_statement = 0;
4346 my $count = 0;
4347 my $prevline = $linenr;
4348 while ($prevline > 1 && $count < 3 && !$has_break) {
4349 $prevline--;
4350 my $rline = $rawlines[$prevline - 1];
4351 my $fline = $lines[$prevline - 1];
4352 last if ($fline =~ /^\@\@/);
4353 next if ($fline =~ /^\-/);
4354 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4355 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4356 next if ($fline =~ /^.[\s$;]*$/);
4357 $has_statement = 1;
4358 $count++;
4359 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4360 }
4361 if (!$has_break && $has_statement) {
4362 WARN("MISSING_BREAK",
4363 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4364 }
4365 }
4366
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004367# check for switch/default statements without a break;
4368 if ($^V && $^V ge 5.10.0 &&
4369 defined $stat &&
4370 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4371 my $ctx = '';
4372 my $herectx = $here . "\n";
4373 my $cnt = statement_rawlines($stat);
4374 for (my $n = 0; $n < $cnt; $n++) {
4375 $herectx .= raw_line($linenr, $n) . "\n";
4376 }
4377 WARN("DEFAULT_NO_BREAK",
4378 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004379 }
4380
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004381# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004382 if ($line =~ /\b__FUNCTION__\b/) {
4383 if (WARN("USE_FUNC",
4384 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4385 $fix) {
4386 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4387 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004388 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004389
Joe Perches2c924882012-03-23 15:02:20 -07004390# check for use of yield()
4391 if ($line =~ /\byield\s*\(\s*\)/) {
4392 WARN("YIELD",
4393 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4394 }
4395
Joe Perches179f8f42013-07-03 15:05:30 -07004396# check for comparisons against true and false
4397 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4398 my $lead = $1;
4399 my $arg = $2;
4400 my $test = $3;
4401 my $otype = $4;
4402 my $trail = $5;
4403 my $op = "!";
4404
4405 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4406
4407 my $type = lc($otype);
4408 if ($type =~ /^(?:true|false)$/) {
4409 if (("$test" eq "==" && "$type" eq "true") ||
4410 ("$test" eq "!=" && "$type" eq "false")) {
4411 $op = "";
4412 }
4413
4414 CHK("BOOL_COMPARISON",
4415 "Using comparison to $otype is error prone\n" . $herecurr);
4416
4417## maybe suggesting a correct construct would better
4418## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4419
4420 }
4421 }
4422
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004423# check for semaphores initialized locked
4424 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004425 WARN("CONSIDER_COMPLETION",
4426 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004427 }
Joe Perches6712d852012-03-23 15:02:20 -07004428
Joe Perches67d0a072011-10-31 17:13:10 -07004429# recommend kstrto* over simple_strto* and strict_strto*
4430 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004431 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004432 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004433 }
Joe Perches6712d852012-03-23 15:02:20 -07004434
Michael Ellermanf3db6632008-07-23 21:28:57 -07004435# check for __initcall(), use device_initcall() explicitly please
4436 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004437 WARN("USE_DEVICE_INITCALL",
4438 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07004439 }
Joe Perches6712d852012-03-23 15:02:20 -07004440
Emese Revfy79404842010-03-05 13:43:53 -08004441# check for various ops structs, ensure they are const.
4442 my $struct_ops = qr{acpi_dock_ops|
4443 address_space_operations|
4444 backlight_ops|
4445 block_device_operations|
4446 dentry_operations|
4447 dev_pm_ops|
4448 dma_map_ops|
4449 extent_io_ops|
4450 file_lock_operations|
4451 file_operations|
4452 hv_ops|
4453 ide_dma_ops|
4454 intel_dvo_dev_ops|
4455 item_operations|
4456 iwl_ops|
4457 kgdb_arch|
4458 kgdb_io|
4459 kset_uevent_ops|
4460 lock_manager_operations|
4461 microcode_ops|
4462 mtrr_ops|
4463 neigh_ops|
4464 nlmsvc_binding|
4465 pci_raw_ops|
4466 pipe_buf_operations|
4467 platform_hibernation_ops|
4468 platform_suspend_ops|
4469 proto_ops|
4470 rpc_pipe_ops|
4471 seq_operations|
4472 snd_ac97_build_ops|
4473 soc_pcmcia_socket_ops|
4474 stacktrace_ops|
4475 sysfs_ops|
4476 tty_operations|
4477 usb_mon_operations|
4478 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004479 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004480 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004481 WARN("CONST_STRUCT",
4482 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004483 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004484 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004485
4486# use of NR_CPUS is usually wrong
4487# ignore definitions of NR_CPUS and usage to define arrays as likely right
4488 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004489 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4490 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004491 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4492 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4493 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004494 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004495 WARN("NR_CPUS",
4496 "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 -07004497 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004498
Joe Perches52ea8502013-11-12 15:10:09 -08004499# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4500 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4501 ERROR("DEFINE_ARCH_HAS",
4502 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4503 }
4504
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004505# check for %L{u,d,i} in strings
4506 my $string;
4507 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4508 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004509 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004510 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004511 WARN("PRINTF_L",
4512 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004513 last;
4514 }
4515 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004516
4517# whine mightly about in_atomic
4518 if ($line =~ /\bin_atomic\s*\(/) {
4519 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004520 ERROR("IN_ATOMIC",
4521 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004522 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004523 WARN("IN_ATOMIC",
4524 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004525 }
4526 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004527
4528# check for lockdep_set_novalidate_class
4529 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4530 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4531 if ($realfile !~ m@^kernel/lockdep@ &&
4532 $realfile !~ m@^include/linux/lockdep@ &&
4533 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004534 ERROR("LOCKDEP",
4535 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004536 }
4537 }
Dave Jones88f88312011-01-12 16:59:59 -08004538
4539 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4540 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004541 WARN("EXPORTED_WORLD_WRITABLE",
4542 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004543 }
Joe Perches24358802014-04-03 14:49:13 -07004544
Joe Perches515a2352014-04-03 14:49:24 -07004545# Mode permission misuses where it seems decimal should be octal
4546# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4547 if ($^V && $^V ge 5.10.0 &&
4548 $line =~ /$mode_perms_search/) {
4549 foreach my $entry (@mode_permission_funcs) {
4550 my $func = $entry->[0];
4551 my $arg_pos = $entry->[1];
Joe Perches24358802014-04-03 14:49:13 -07004552
Joe Perches515a2352014-04-03 14:49:24 -07004553 my $skip_args = "";
4554 if ($arg_pos > 1) {
4555 $arg_pos--;
4556 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4557 }
4558 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4559 if ($line =~ /$test/) {
4560 my $val = $1;
4561 $val = $6 if ($skip_args ne "");
Joe Perches24358802014-04-03 14:49:13 -07004562
Joe Perches515a2352014-04-03 14:49:24 -07004563 if ($val !~ /^0$/ &&
4564 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4565 length($val) ne 4)) {
4566 ERROR("NON_OCTAL_PERMISSIONS",
4567 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
4568 }
Joe Perches24358802014-04-03 14:49:13 -07004569 }
4570 }
4571 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004572 }
4573
4574 # If we have no input at all, then there is nothing to report on
4575 # so just keep quiet.
4576 if ($#rawlines == -1) {
4577 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004578 }
4579
Andy Whitcroft8905a672007-11-28 16:21:06 -08004580 # In mailback mode only produce a report in the negative, for
4581 # things that appear to be patches.
4582 if ($mailback && ($clean == 1 || !$is_patch)) {
4583 exit(0);
4584 }
4585
4586 # This is not a patch, and we are are in 'no-patch' mode so
4587 # just keep quiet.
4588 if (!$chk_patch && !$is_patch) {
4589 exit(0);
4590 }
4591
4592 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004593 ERROR("NOT_UNIFIED_DIFF",
4594 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004595 }
4596 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004597 ERROR("MISSING_SIGN_OFF",
4598 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004599 }
4600
Andy Whitcroft8905a672007-11-28 16:21:06 -08004601 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004602 if ($summary && !($clean == 1 && $quiet == 1)) {
4603 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004604 print "total: $cnt_error errors, $cnt_warn warnings, " .
4605 (($check)? "$cnt_chk checks, " : "") .
4606 "$cnt_lines lines checked\n";
4607 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004608 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004609
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004610 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004611
4612 if ($^V lt 5.10.0) {
4613 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4614 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4615 }
4616
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004617 # If there were whitespace errors which cleanpatch can fix
4618 # then suggest that.
4619 if ($rpt_cleaners) {
4620 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4621 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07004622 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004623 }
4624 }
4625
Joe Perches91bfe482013-09-11 14:23:59 -07004626 hash_show_words(\%use_type, "Used");
4627 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07004628
Joe Perches3705ce52013-07-03 15:05:31 -07004629 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
Joe Perches9624b8d2014-01-23 15:54:44 -08004630 my $newfile = $filename;
4631 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07004632 my $linecount = 0;
4633 my $f;
4634
4635 open($f, '>', $newfile)
4636 or die "$P: Can't open $newfile for write\n";
4637 foreach my $fixed_line (@fixed) {
4638 $linecount++;
4639 if ($file) {
4640 if ($linecount > 3) {
4641 $fixed_line =~ s/^\+//;
4642 print $f $fixed_line. "\n";
4643 }
4644 } else {
4645 print $f $fixed_line . "\n";
4646 }
4647 }
4648 close($f);
4649
4650 if (!$quiet) {
4651 print << "EOM";
4652Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4653
4654Do _NOT_ trust the results written to this file.
4655Do _NOT_ submit these changes without inspecting them for correctness.
4656
4657This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4658No warranties, expressed or implied...
4659
4660EOM
4661 }
4662 }
4663
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004664 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004665 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004666 }
4667 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004668 print << "EOM";
4669$vname has style problems, please review.
4670
4671If any of these errors are false positives, please report
4672them to the maintainer, see CHECKPATCH in MAINTAINERS.
4673EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004674 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004675
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004676 return $clean;
4677}