blob: 23d55bfcb5af68b4731274f4d4b974e9ff7802c4 [file] [log] [blame]
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830be2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070010
11my $P = $0;
Andy Whitcroft00df344f2007-06-08 13:47:06 -070012$P =~ s@.*/@@g;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070013
Joe Perches000d1cc12011-07-25 17:13:25 -070014my $V = '0.32';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -070015
16use Getopt::Long qw(:config no_auto_abbrev);
17
18my $quiet = 0;
19my $tree = 1;
20my $chk_signoff = 1;
21my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070022my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080024my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070025my $file = 0;
26my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080027my $summary = 1;
28my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080029my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070030my $show_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070031my $fix = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070032my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080033my %debug;
Joe Perches34456862013-07-03 15:05:34 -070034my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070035my %use_type = ();
36my @use = ();
37my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070038my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070039my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070040my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080041my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070042my $ignore_perl_version = 0;
43my $minimum_perl_version = 5.10.0;
Hannes Eder77f5b102009-09-21 17:04:37 -070044
45sub help {
46 my ($exitcode) = @_;
47
48 print << "EOM";
49Usage: $P [OPTION]... [FILE]...
50Version: $V
51
52Options:
53 -q, --quiet quiet
54 --no-tree run without a kernel tree
55 --no-signoff do not check for 'Signed-off-by' line
56 --patch treat FILE as patchfile (default)
57 --emacs emacs compile window format
58 --terse one line per report
59 -f, --file treat FILE as regular source file
60 --subjective, --strict enable more subjective tests
Joe Perches91bfe482013-09-11 14:23:59 -070061 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070062 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080063 --max-line-length=n set the maximum line length, if exceeded, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070064 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070065 --root=PATH PATH to the kernel tree root
66 --no-summary suppress the per-file summary
67 --mailback only produce a report in case of warnings/errors
68 --summary-file include the filename in summary
69 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
70 'values', 'possible', 'type', and 'attr' (default
71 is all off)
72 --test-only=WORD report only warnings/errors containing WORD
73 literally
Joe Perches3705ce52013-07-03 15:05:31 -070074 --fix EXPERIMENTAL - may create horrible results
75 If correctable single-line errors exist, create
76 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
77 with potential errors corrected to the preferred
78 checkpatch style
Dave Hansend62a2012013-09-11 14:23:56 -070079 --ignore-perl-version override checking of perl version. expect
80 runtime errors.
Hannes Eder77f5b102009-09-21 17:04:37 -070081 -h, --help, --version display this help and exit
82
83When FILE is - read standard input.
84EOM
85
86 exit($exitcode);
87}
88
Joe Perches000d1cc12011-07-25 17:13:25 -070089my $conf = which_conf($configuration_file);
90if (-f $conf) {
91 my @conf_args;
92 open(my $conffile, '<', "$conf")
93 or warn "$P: Can't find a readable $configuration_file file $!\n";
94
95 while (<$conffile>) {
96 my $line = $_;
97
98 $line =~ s/\s*\n?$//g;
99 $line =~ s/^\s*//g;
100 $line =~ s/\s+/ /g;
101
102 next if ($line =~ m/^\s*#/);
103 next if ($line =~ m/^\s*$/);
104
105 my @words = split(" ", $line);
106 foreach my $word (@words) {
107 last if ($word =~ m/^#/);
108 push (@conf_args, $word);
109 }
110 }
111 close($conffile);
112 unshift(@ARGV, @conf_args) if @conf_args;
113}
114
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700115GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700116 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700117 'tree!' => \$tree,
118 'signoff!' => \$chk_signoff,
119 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700120 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800121 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700122 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700123 'subjective!' => \$check,
124 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700125 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700126 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700127 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800128 'max-line-length=i' => \$max_line_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700129 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800130 'summary!' => \$summary,
131 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800132 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700133 'fix!' => \$fix,
Dave Hansend62a2012013-09-11 14:23:56 -0700134 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800135 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700136 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700137 'h|help' => \$help,
138 'version' => \$help
139) or help(1);
140
141help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700142
143my $exit = 0;
144
Dave Hansend62a2012013-09-11 14:23:56 -0700145if ($^V && $^V lt $minimum_perl_version) {
146 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
147 if (!$ignore_perl_version) {
148 exit(1);
149 }
150}
151
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700152if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700153 print "$P: no input files\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700154 exit(1);
155}
156
Joe Perches91bfe482013-09-11 14:23:59 -0700157sub hash_save_array_words {
158 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700159
Joe Perches91bfe482013-09-11 14:23:59 -0700160 my @array = split(/,/, join(',', @$arrayRef));
161 foreach my $word (@array) {
162 $word =~ s/\s*\n?$//g;
163 $word =~ s/^\s*//g;
164 $word =~ s/\s+/ /g;
165 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700166
Joe Perches91bfe482013-09-11 14:23:59 -0700167 next if ($word =~ m/^\s*#/);
168 next if ($word =~ m/^\s*$/);
169
170 $hashRef->{$word}++;
171 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700172}
173
Joe Perches91bfe482013-09-11 14:23:59 -0700174sub hash_show_words {
175 my ($hashRef, $prefix) = @_;
176
Joe Perches58cb3cf2013-09-11 14:24:04 -0700177 if ($quiet == 0 && keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700178 print "NOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700179 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700180 print " $word";
181 }
182 print "\n\n";
183 }
184}
185
186hash_save_array_words(\%ignore_type, \@ignore);
187hash_save_array_words(\%use_type, \@use);
188
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800189my $dbg_values = 0;
190my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700191my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700192my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800193for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800194 ## no critic
195 eval "\${dbg_$key} = '$debug{$key}';";
196 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800197}
198
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700199my $rpt_cleaners = 0;
200
Andy Whitcroft8905a672007-11-28 16:21:06 -0800201if ($terse) {
202 $emacs = 1;
203 $quiet++;
204}
205
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700206if ($tree) {
207 if (defined $root) {
208 if (!top_of_kernel_tree($root)) {
209 die "$P: $root: --root does not point at a valid tree\n";
210 }
211 } else {
212 if (top_of_kernel_tree('.')) {
213 $root = '.';
214 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
215 top_of_kernel_tree($1)) {
216 $root = $1;
217 }
218 }
219
220 if (!defined $root) {
221 print "Must be run from the top-level dir. of a kernel tree\n";
222 exit(2);
223 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700224}
225
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700226my $emitted_corrupt = 0;
227
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700228our $Ident = qr{
229 [A-Za-z_][A-Za-z\d_]*
230 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
231 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700232our $Storage = qr{extern|static|asmlinkage};
233our $Sparse = qr{
234 __user|
235 __kernel|
236 __force|
237 __iomem|
238 __must_check|
239 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800240 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700241 __ref|
242 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700243 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800244our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
245our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
246our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
247our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
248our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700249
Wolfram Sang52131292010-03-05 13:43:51 -0800250# Notes to $Attribute:
251# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700252our $Attribute = qr{
253 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700254 __percpu|
255 __nocast|
256 __safe|
257 __bitwise__|
258 __packed__|
259 __packed2__|
260 __naked|
261 __maybe_unused|
262 __always_unused|
263 __noreturn|
264 __used|
265 __cold|
266 __noclone|
267 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700268 __read_mostly|
269 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700270 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700271 ____cacheline_aligned|
272 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800273 ____cacheline_internodealigned_in_smp|
274 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700275 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700276our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700277our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700278our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
279our $Lval = qr{$Ident(?:$Member)*};
280
Joe Perches95e2c602013-07-03 15:05:20 -0700281our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
282our $Binary = qr{(?i)0b[01]+$Int_type?};
283our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
284our $Int = qr{[0-9]+$Int_type?};
Joe Perches326b1ff2013-02-04 14:28:51 -0800285our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
286our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
287our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800288our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches95e2c602013-07-03 15:05:20 -0700289our $Constant = qr{$Float|$Binary|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800290our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800291our $Compare = qr{<=|>=|==|!=|<|>};
Joe Perches23f780c2013-07-03 15:05:31 -0700292our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700293our $Operators = qr{
294 <=|>=|==|!=|
295 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700296 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700297 }x;
298
Andy Whitcroft8905a672007-11-28 16:21:06 -0800299our $NonptrType;
Joe Perches8716de32013-09-11 14:24:05 -0700300our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800301our $Type;
302our $Declare;
303
Joe Perches15662b32011-10-31 17:13:12 -0700304our $NON_ASCII_UTF8 = qr{
305 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700306 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
307 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
308 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
309 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
310 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
311 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
312}x;
313
Joe Perches15662b32011-10-31 17:13:12 -0700314our $UTF8 = qr{
315 [\x09\x0A\x0D\x20-\x7E] # ASCII
316 | $NON_ASCII_UTF8
317}x;
318
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700319our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700320 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700321 atomic_t
322)};
323
Joe Perches691e6692010-03-05 13:43:51 -0800324our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700325 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700326 (?:[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 -0700327 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700328 panic|
Joe Perches06668722013-11-12 15:10:07 -0800329 MODULE_[A-Z_]+|
330 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800331)};
332
Joe Perches20112472011-07-25 17:13:23 -0700333our $signature_tags = qr{(?xi:
334 Signed-off-by:|
335 Acked-by:|
336 Tested-by:|
337 Reviewed-by:|
338 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700339 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700340 To:|
341 Cc:
342)};
343
Andy Whitcroft8905a672007-11-28 16:21:06 -0800344our @typeList = (
345 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700346 qr{(?:unsigned\s+)?char},
347 qr{(?:unsigned\s+)?short},
348 qr{(?:unsigned\s+)?int},
349 qr{(?:unsigned\s+)?long},
350 qr{(?:unsigned\s+)?long\s+int},
351 qr{(?:unsigned\s+)?long\s+long},
352 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800353 qr{unsigned},
354 qr{float},
355 qr{double},
356 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800357 qr{struct\s+$Ident},
358 qr{union\s+$Ident},
359 qr{enum\s+$Ident},
360 qr{${Ident}_t},
361 qr{${Ident}_handler},
362 qr{${Ident}_handler_fn},
363);
Joe Perches8716de32013-09-11 14:24:05 -0700364our @typeListWithAttr = (
365 @typeList,
366 qr{struct\s+$InitAttribute\s+$Ident},
367 qr{union\s+$InitAttribute\s+$Ident},
368);
369
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700370our @modifierList = (
371 qr{fastcall},
372);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800373
Wolfram Sang7840a942010-08-09 17:20:57 -0700374our $allowed_asm_includes = qr{(?x:
375 irq|
376 memory
377)};
378# memory.h: ARM has a custom one
379
Andy Whitcroft8905a672007-11-28 16:21:06 -0800380sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700381 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
382 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700383 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700384 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800385 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700386 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800387 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800388 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700389 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700390 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800391 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700392 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800393 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700394 $NonptrTypeWithAttr = qr{
395 (?:$Modifier\s+|const\s+)*
396 (?:
397 (?:typeof|__typeof__)\s*\([^\)]*\)|
398 (?:$typeTypedefs\b)|
399 (?:${allWithAttr}\b)
400 )
401 (?:\s+$Modifier|\s+const)*
402 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800403 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700404 $NonptrType
Andy Whitcroftb337d8b2012-03-23 15:02:18 -0700405 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700406 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800407 }x;
408 $Declare = qr{(?:$Storage\s+)?$Type};
409}
410build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700411
Joe Perches7d2367a2011-07-25 17:13:22 -0700412our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700413
414# Using $balanced_parens, $LvalOrFunc, or $FuncArg
415# requires at least perl version v5.10.0
416# Any use must be runtime checked with $^V
417
418our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
419our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800420our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700421
422sub deparenthesize {
423 my ($string) = @_;
424 return "" if (!defined($string));
425 $string =~ s@^\s*\(\s*@@g;
426 $string =~ s@\s*\)\s*$@@g;
427 $string =~ s@\s+@ @g;
428 return $string;
429}
430
Joe Perches34456862013-07-03 15:05:34 -0700431sub seed_camelcase_file {
432 my ($file) = @_;
433
434 return if (!(-f $file));
435
436 local $/;
437
438 open(my $include_file, '<', "$file")
439 or warn "$P: Can't read '$file' $!\n";
440 my $text = <$include_file>;
441 close($include_file);
442
443 my @lines = split('\n', $text);
444
445 foreach my $line (@lines) {
446 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
447 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
448 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800449 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
450 $camelcase{$1} = 1;
451 } 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 -0700452 $camelcase{$1} = 1;
453 }
454 }
455}
456
457my $camelcase_seeded = 0;
458sub seed_camelcase_includes {
459 return if ($camelcase_seeded);
460
461 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700462 my $camelcase_cache = "";
463 my @include_files = ();
464
465 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700466
Joe Perches34456862013-07-03 15:05:34 -0700467 if (-d ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700468 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
469 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700470 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700471 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700472 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700473 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700474 @include_files = split('\n', $files);
475 foreach my $file (@include_files) {
476 my $date = POSIX::strftime("%Y%m%d%H%M",
477 localtime((stat $file)[9]));
478 $last_mod_date = $date if ($last_mod_date < $date);
479 }
480 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700481 }
Joe Perchesc707a812013-07-08 16:00:43 -0700482
483 if ($camelcase_cache ne "" && -f $camelcase_cache) {
484 open(my $camelcase_file, '<', "$camelcase_cache")
485 or warn "$P: Can't read '$camelcase_cache' $!\n";
486 while (<$camelcase_file>) {
487 chomp;
488 $camelcase{$_} = 1;
489 }
490 close($camelcase_file);
491
492 return;
493 }
494
495 if (-d ".git") {
496 $files = `git ls-files "include/*.h"`;
497 @include_files = split('\n', $files);
498 }
499
Joe Perches34456862013-07-03 15:05:34 -0700500 foreach my $file (@include_files) {
501 seed_camelcase_file($file);
502 }
Joe Perches351b2a12013-07-03 15:05:36 -0700503
Joe Perchesc707a812013-07-08 16:00:43 -0700504 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700505 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700506 open(my $camelcase_file, '>', "$camelcase_cache")
507 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700508 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
509 print $camelcase_file ("$_\n");
510 }
511 close($camelcase_file);
512 }
Joe Perches34456862013-07-03 15:05:34 -0700513}
514
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700515$chk_signoff = 0 if ($file);
516
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700517my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800518my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700519my @fixed = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800520my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700521for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800522 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700523 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800524 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700525 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800526 } elsif ($filename eq '-') {
527 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700528 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800529 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700530 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700531 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800532 if ($filename eq '-') {
533 $vname = 'Your patch';
534 } else {
535 $vname = $filename;
536 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800537 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700538 chomp;
539 push(@rawlines, $_);
540 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800541 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800542 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700543 $exit = 1;
544 }
545 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800546 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700547 @fixed = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700548}
549
550exit($exit);
551
552sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700553 my ($root) = @_;
554
555 my @tree_check = (
556 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
557 "README", "Documentation", "arch", "include", "drivers",
558 "fs", "init", "ipc", "kernel", "lib", "scripts",
559 );
560
561 foreach my $check (@tree_check) {
562 if (! -e $root . '/' . $check) {
563 return 0;
564 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700565 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700566 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700567}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700568
Joe Perches20112472011-07-25 17:13:23 -0700569sub parse_email {
570 my ($formatted_email) = @_;
571
572 my $name = "";
573 my $address = "";
574 my $comment = "";
575
576 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
577 $name = $1;
578 $address = $2;
579 $comment = $3 if defined $3;
580 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
581 $address = $1;
582 $comment = $2 if defined $2;
583 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
584 $address = $1;
585 $comment = $2 if defined $2;
586 $formatted_email =~ s/$address.*$//;
587 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700588 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700589 $name =~ s/^\"|\"$//g;
590 # If there's a name left after stripping spaces and
591 # leading quotes, and the address doesn't have both
592 # leading and trailing angle brackets, the address
593 # is invalid. ie:
594 # "joe smith joe@smith.com" bad
595 # "joe smith <joe@smith.com" bad
596 if ($name ne "" && $address !~ /^<[^>]+>$/) {
597 $name = "";
598 $address = "";
599 $comment = "";
600 }
601 }
602
Joe Perches3705ce52013-07-03 15:05:31 -0700603 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700604 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700605 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700606 $address =~ s/^\<|\>$//g;
607
608 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
609 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
610 $name = "\"$name\"";
611 }
612
613 return ($name, $address, $comment);
614}
615
616sub format_email {
617 my ($name, $address) = @_;
618
619 my $formatted_email;
620
Joe Perches3705ce52013-07-03 15:05:31 -0700621 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700622 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700623 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700624
625 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
626 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
627 $name = "\"$name\"";
628 }
629
630 if ("$name" eq "") {
631 $formatted_email = "$address";
632 } else {
633 $formatted_email = "$name <$address>";
634 }
635
636 return $formatted_email;
637}
638
Joe Perches000d1cc12011-07-25 17:13:25 -0700639sub which_conf {
640 my ($conf) = @_;
641
642 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
643 if (-e "$path/$conf") {
644 return "$path/$conf";
645 }
646 }
647
648 return "";
649}
650
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700651sub expand_tabs {
652 my ($str) = @_;
653
654 my $res = '';
655 my $n = 0;
656 for my $c (split(//, $str)) {
657 if ($c eq "\t") {
658 $res .= ' ';
659 $n++;
660 for (; ($n % 8) != 0; $n++) {
661 $res .= ' ';
662 }
663 next;
664 }
665 $res .= $c;
666 $n++;
667 }
668
669 return $res;
670}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700671sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700672 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700673 return $res;
674}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700675
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700676sub line_stats {
677 my ($line) = @_;
678
679 # Drop the diff line leader and expand tabs
680 $line =~ s/^.//;
681 $line = expand_tabs($line);
682
683 # Pick the indent from the front of the line.
684 my ($white) = ($line =~ /^(\s*)/);
685
686 return (length($line), length($white));
687}
688
Andy Whitcroft773647a2008-03-28 14:15:58 -0700689my $sanitise_quote = '';
690
691sub sanitise_line_reset {
692 my ($in_comment) = @_;
693
694 if ($in_comment) {
695 $sanitise_quote = '*/';
696 } else {
697 $sanitise_quote = '';
698 }
699}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700700sub sanitise_line {
701 my ($line) = @_;
702
703 my $res = '';
704 my $l = '';
705
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800706 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700707 my $off = 0;
708 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700709
Andy Whitcroft773647a2008-03-28 14:15:58 -0700710 # Always copy over the diff marker.
711 $res = substr($line, 0, 1);
712
713 for ($off = 1; $off < length($line); $off++) {
714 $c = substr($line, $off, 1);
715
716 # Comments we are wacking completly including the begin
717 # and end, all to $;.
718 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
719 $sanitise_quote = '*/';
720
721 substr($res, $off, 2, "$;$;");
722 $off++;
723 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800724 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700725 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700726 $sanitise_quote = '';
727 substr($res, $off, 2, "$;$;");
728 $off++;
729 next;
730 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700731 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
732 $sanitise_quote = '//';
733
734 substr($res, $off, 2, $sanitise_quote);
735 $off++;
736 next;
737 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700738
739 # A \ in a string means ignore the next character.
740 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
741 $c eq "\\") {
742 substr($res, $off, 2, 'XX');
743 $off++;
744 next;
745 }
746 # Regular quotes.
747 if ($c eq "'" || $c eq '"') {
748 if ($sanitise_quote eq '') {
749 $sanitise_quote = $c;
750
751 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700752 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700753 } elsif ($sanitise_quote eq $c) {
754 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700755 }
756 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700757
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800758 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700759 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
760 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700761 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
762 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700763 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
764 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700765 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700766 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700767 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800768 }
769
Daniel Walker113f04a2009-09-21 17:04:35 -0700770 if ($sanitise_quote eq '//') {
771 $sanitise_quote = '';
772 }
773
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800774 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700775 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800776 my $clean = 'X' x length($1);
777 $res =~ s@\<.*\>@<$clean>@;
778
779 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700780 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800781 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700782 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800783 }
784
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700785 return $res;
786}
787
Joe Perchesa6962d72013-04-29 16:18:13 -0700788sub get_quoted_string {
789 my ($line, $rawline) = @_;
790
791 return "" if ($line !~ m/(\"[X]+\")/g);
792 return substr($rawline, $-[0], $+[0] - $-[0]);
793}
794
Andy Whitcroft8905a672007-11-28 16:21:06 -0800795sub ctx_statement_block {
796 my ($linenr, $remain, $off) = @_;
797 my $line = $linenr - 1;
798 my $blk = '';
799 my $soff = $off;
800 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700801 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800802
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800803 my $loff = 0;
804
Andy Whitcroft8905a672007-11-28 16:21:06 -0800805 my $type = '';
806 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800807 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800808 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800809 my $c;
810 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800811
812 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800813 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800814 @stack = (['', 0]) if ($#stack == -1);
815
Andy Whitcroft773647a2008-03-28 14:15:58 -0700816 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800817 # If we are about to drop off the end, pull in more
818 # context.
819 if ($off >= $len) {
820 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700821 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800822 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800823 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800824 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800825 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800826 $len = length($blk);
827 $line++;
828 last;
829 }
830 # Bail if there is no further context.
831 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800832 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800833 last;
834 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800835 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
836 $level++;
837 $type = '#';
838 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800839 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800840 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800841 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800842 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800843
Andy Whitcroft773647a2008-03-28 14:15:58 -0700844 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800845
846 # Handle nested #if/#else.
847 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
848 push(@stack, [ $type, $level ]);
849 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
850 ($type, $level) = @{$stack[$#stack - 1]};
851 } elsif ($remainder =~ /^#\s*endif\b/) {
852 ($type, $level) = @{pop(@stack)};
853 }
854
Andy Whitcroft8905a672007-11-28 16:21:06 -0800855 # Statement ends at the ';' or a close '}' at the
856 # outermost level.
857 if ($level == 0 && $c eq ';') {
858 last;
859 }
860
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800861 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700862 if ($level == 0 && $coff_set == 0 &&
863 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
864 $remainder =~ /^(else)(?:\s|{)/ &&
865 $remainder !~ /^else\s+if\b/) {
866 $coff = $off + length($1) - 1;
867 $coff_set = 1;
868 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
869 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800870 }
871
Andy Whitcroft8905a672007-11-28 16:21:06 -0800872 if (($type eq '' || $type eq '(') && $c eq '(') {
873 $level++;
874 $type = '(';
875 }
876 if ($type eq '(' && $c eq ')') {
877 $level--;
878 $type = ($level != 0)? '(' : '';
879
880 if ($level == 0 && $coff < $soff) {
881 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700882 $coff_set = 1;
883 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800884 }
885 }
886 if (($type eq '' || $type eq '{') && $c eq '{') {
887 $level++;
888 $type = '{';
889 }
890 if ($type eq '{' && $c eq '}') {
891 $level--;
892 $type = ($level != 0)? '{' : '';
893
894 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700895 if (substr($blk, $off + 1, 1) eq ';') {
896 $off++;
897 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800898 last;
899 }
900 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800901 # Preprocessor commands end at the newline unless escaped.
902 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
903 $level--;
904 $type = '';
905 $off++;
906 last;
907 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800908 $off++;
909 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700910 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800911 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700912 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800913 $line++;
914 $remain--;
915 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800916
917 my $statement = substr($blk, $soff, $off - $soff + 1);
918 my $condition = substr($blk, $soff, $coff - $soff + 1);
919
920 #warn "STATEMENT<$statement>\n";
921 #warn "CONDITION<$condition>\n";
922
Andy Whitcroft773647a2008-03-28 14:15:58 -0700923 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800924
925 return ($statement, $condition,
926 $line, $remain + 1, $off - $loff + 1, $level);
927}
928
Andy Whitcroftcf655042008-03-04 14:28:20 -0800929sub statement_lines {
930 my ($stmt) = @_;
931
932 # Strip the diff line prefixes and rip blank lines at start and end.
933 $stmt =~ s/(^|\n)./$1/g;
934 $stmt =~ s/^\s*//;
935 $stmt =~ s/\s*$//;
936
937 my @stmt_lines = ($stmt =~ /\n/g);
938
939 return $#stmt_lines + 2;
940}
941
942sub statement_rawlines {
943 my ($stmt) = @_;
944
945 my @stmt_lines = ($stmt =~ /\n/g);
946
947 return $#stmt_lines + 2;
948}
949
950sub statement_block_size {
951 my ($stmt) = @_;
952
953 $stmt =~ s/(^|\n)./$1/g;
954 $stmt =~ s/^\s*{//;
955 $stmt =~ s/}\s*$//;
956 $stmt =~ s/^\s*//;
957 $stmt =~ s/\s*$//;
958
959 my @stmt_lines = ($stmt =~ /\n/g);
960 my @stmt_statements = ($stmt =~ /;/g);
961
962 my $stmt_lines = $#stmt_lines + 2;
963 my $stmt_statements = $#stmt_statements + 1;
964
965 if ($stmt_lines > $stmt_statements) {
966 return $stmt_lines;
967 } else {
968 return $stmt_statements;
969 }
970}
971
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800972sub ctx_statement_full {
973 my ($linenr, $remain, $off) = @_;
974 my ($statement, $condition, $level);
975
976 my (@chunks);
977
Andy Whitcroftcf655042008-03-04 14:28:20 -0800978 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800979 ($statement, $condition, $linenr, $remain, $off, $level) =
980 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700981 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800982 push(@chunks, [ $condition, $statement ]);
983 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
984 return ($level, $linenr, @chunks);
985 }
986
987 # Pull in the following conditional/block pairs and see if they
988 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800989 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800990 ($statement, $condition, $linenr, $remain, $off, $level) =
991 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800992 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700993 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800994 #print "C: push\n";
995 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800996 }
997
998 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800999}
1000
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001001sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001002 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001003 my $line;
1004 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001005 my $blk = '';
1006 my @o;
1007 my @c;
1008 my @res = ();
1009
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001010 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001011 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001012 for ($line = $start; $remain > 0; $line++) {
1013 next if ($rawlines[$line] =~ /^-/);
1014 $remain--;
1015
1016 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001017
1018 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001019 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001020 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001021 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001022 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001023 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001024 $level = pop(@stack);
1025 }
1026
Andy Whitcroft01464f32010-10-26 14:23:19 -07001027 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001028 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1029 if ($off > 0) {
1030 $off--;
1031 next;
1032 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001033
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001034 if ($c eq $close && $level > 0) {
1035 $level--;
1036 last if ($level == 0);
1037 } elsif ($c eq $open) {
1038 $level++;
1039 }
1040 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001041
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001042 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001043 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001044 }
1045
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001046 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001047 }
1048
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001049 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001050}
1051sub ctx_block_outer {
1052 my ($linenr, $remain) = @_;
1053
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001054 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1055 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001056}
1057sub ctx_block {
1058 my ($linenr, $remain) = @_;
1059
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001060 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1061 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001062}
1063sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001064 my ($linenr, $remain, $off) = @_;
1065
1066 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1067 return @r;
1068}
1069sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001070 my ($linenr, $remain) = @_;
1071
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001072 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001073}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001074sub ctx_statement_level {
1075 my ($linenr, $remain, $off) = @_;
1076
1077 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1078}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001079
1080sub ctx_locate_comment {
1081 my ($first_line, $end_line) = @_;
1082
1083 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001084 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001085 return $current_comment if (defined $current_comment);
1086
1087 # Look through the context and try and figure out if there is a
1088 # comment.
1089 my $in_comment = 0;
1090 $current_comment = '';
1091 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001092 my $line = $rawlines[$linenr - 1];
1093 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001094 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1095 $in_comment = 1;
1096 }
1097 if ($line =~ m@/\*@) {
1098 $in_comment = 1;
1099 }
1100 if (!$in_comment && $current_comment ne '') {
1101 $current_comment = '';
1102 }
1103 $current_comment .= $line . "\n" if ($in_comment);
1104 if ($line =~ m@\*/@) {
1105 $in_comment = 0;
1106 }
1107 }
1108
1109 chomp($current_comment);
1110 return($current_comment);
1111}
1112sub ctx_has_comment {
1113 my ($first_line, $end_line) = @_;
1114 my $cmt = ctx_locate_comment($first_line, $end_line);
1115
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001116 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001117 ##print "CMMT: $cmt\n";
1118
1119 return ($cmt ne '');
1120}
1121
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001122sub raw_line {
1123 my ($linenr, $cnt) = @_;
1124
1125 my $offset = $linenr - 1;
1126 $cnt++;
1127
1128 my $line;
1129 while ($cnt) {
1130 $line = $rawlines[$offset++];
1131 next if (defined($line) && $line =~ /^-/);
1132 $cnt--;
1133 }
1134
1135 return $line;
1136}
1137
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001138sub cat_vet {
1139 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001140 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001141
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001142 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001143 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1144 $res .= $1;
1145 if ($2 ne '') {
1146 $coded = sprintf("^%c", unpack('C', $2) + 64);
1147 $res .= $coded;
1148 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001149 }
1150 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001151
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001152 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001153}
1154
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001155my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001156my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001157my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001158my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001159
1160sub annotate_reset {
1161 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001162 $av_pending = '_';
1163 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001164 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001165}
1166
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001167sub annotate_values {
1168 my ($stream, $type) = @_;
1169
1170 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001171 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001172 my $cur = $stream;
1173
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001174 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001175
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001176 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001177 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001178 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001179 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001180 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001181 print "WS($1)\n" if ($dbg_values > 1);
1182 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001183 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001184 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001185 }
1186
Florian Micklerc023e4732011-01-12 16:59:58 -08001187 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001188 print "CAST($1)\n" if ($dbg_values > 1);
1189 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001190 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001191
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001192 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001193 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001194 $type = 'T';
1195
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001196 } elsif ($cur =~ /^($Modifier)\s*/) {
1197 print "MODIFIER($1)\n" if ($dbg_values > 1);
1198 $type = 'T';
1199
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001200 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001201 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001202 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001203 push(@av_paren_type, $type);
1204 if ($2 ne '') {
1205 $av_pending = 'N';
1206 }
1207 $type = 'E';
1208
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001209 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001210 print "UNDEF($1)\n" if ($dbg_values > 1);
1211 $av_preprocessor = 1;
1212 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001213
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001214 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001215 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001216 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001217
1218 push(@av_paren_type, $type);
1219 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001220 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001221
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001222 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001223 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1224 $av_preprocessor = 1;
1225
1226 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1227
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001228 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001229
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001230 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001231 print "PRE_END($1)\n" if ($dbg_values > 1);
1232
1233 $av_preprocessor = 1;
1234
1235 # Assume all arms of the conditional end as this
1236 # one does, and continue as if the #endif was not here.
1237 pop(@av_paren_type);
1238 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001239 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001240
1241 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001242 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001243
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001244 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1245 print "ATTR($1)\n" if ($dbg_values > 1);
1246 $av_pending = $type;
1247 $type = 'N';
1248
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001249 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001250 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001251 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001252 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001253 }
1254 $type = 'N';
1255
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001256 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001257 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001258 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001259 $type = 'N';
1260
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001261 } elsif ($cur =~/^(case)/o) {
1262 print "CASE($1)\n" if ($dbg_values > 1);
1263 $av_pend_colon = 'C';
1264 $type = 'N';
1265
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001266 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001267 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001268 $type = 'N';
1269
1270 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001271 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001272 push(@av_paren_type, $av_pending);
1273 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001274 $type = 'N';
1275
1276 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001277 my $new_type = pop(@av_paren_type);
1278 if ($new_type ne '_') {
1279 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001280 print "PAREN('$1') -> $type\n"
1281 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001282 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001283 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001284 }
1285
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001286 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001287 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001288 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001289 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001290
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001291 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1292 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001293 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001294 } elsif ($type eq 'E') {
1295 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001296 }
1297 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1298 $type = 'V';
1299
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001300 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001301 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001302 $type = 'V';
1303
1304 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001305 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001306 $type = 'N';
1307
Andy Whitcroftcf655042008-03-04 14:28:20 -08001308 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001309 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001310 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001311 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001312
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001313 } elsif ($cur =~/^(,)/) {
1314 print "COMMA($1)\n" if ($dbg_values > 1);
1315 $type = 'C';
1316
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001317 } elsif ($cur =~ /^(\?)/o) {
1318 print "QUESTION($1)\n" if ($dbg_values > 1);
1319 $type = 'N';
1320
1321 } elsif ($cur =~ /^(:)/o) {
1322 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1323
1324 substr($var, length($res), 1, $av_pend_colon);
1325 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1326 $type = 'E';
1327 } else {
1328 $type = 'N';
1329 }
1330 $av_pend_colon = 'O';
1331
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001332 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001333 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001334 $type = 'N';
1335
Andy Whitcroft0d413862008-10-15 22:02:16 -07001336 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001337 my $variant;
1338
1339 print "OPV($1)\n" if ($dbg_values > 1);
1340 if ($type eq 'V') {
1341 $variant = 'B';
1342 } else {
1343 $variant = 'U';
1344 }
1345
1346 substr($var, length($res), 1, $variant);
1347 $type = 'N';
1348
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001349 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001350 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001351 if ($1 ne '++' && $1 ne '--') {
1352 $type = 'N';
1353 }
1354
1355 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001356 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001357 }
1358 if (defined $1) {
1359 $cur = substr($cur, length($1));
1360 $res .= $type x length($1);
1361 }
1362 }
1363
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001364 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001365}
1366
Andy Whitcroft8905a672007-11-28 16:21:06 -08001367sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001368 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001369 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001370 ^(?:
1371 $Modifier|
1372 $Storage|
1373 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001374 DEFINE_\S+
1375 )$|
1376 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001377 goto|
1378 return|
1379 case|
1380 else|
1381 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001382 do|
1383 \#|
1384 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001385 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001386 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001387 )}x;
1388 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1389 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001390 # Check for modifiers.
1391 $possible =~ s/\s*$Storage\s*//g;
1392 $possible =~ s/\s*$Sparse\s*//g;
1393 if ($possible =~ /^\s*$/) {
1394
1395 } elsif ($possible =~ /\s/) {
1396 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001397 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001398 if ($modifier !~ $notPermitted) {
1399 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1400 push(@modifierList, $modifier);
1401 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001402 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001403
1404 } else {
1405 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1406 push(@typeList, $possible);
1407 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001408 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001409 } else {
1410 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001411 }
1412}
1413
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001414my $prefix = '';
1415
Joe Perches000d1cc12011-07-25 17:13:25 -07001416sub show_type {
Joe Perches91bfe482013-09-11 14:23:59 -07001417 return defined $use_type{$_[0]} if (scalar keys %use_type > 0);
1418
1419 return !defined $ignore_type{$_[0]};
Joe Perches000d1cc12011-07-25 17:13:25 -07001420}
1421
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001422sub report {
Joe Perches000d1cc12011-07-25 17:13:25 -07001423 if (!show_type($_[1]) ||
1424 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001425 return 0;
1426 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001427 my $line;
1428 if ($show_types) {
1429 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1430 } else {
1431 $line = "$prefix$_[0]: $_[2]\n";
1432 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001433 $line = (split('\n', $line))[0] . "\n" if ($terse);
1434
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001435 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001436
1437 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001438}
1439sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001440 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001441}
Joe Perches000d1cc12011-07-25 17:13:25 -07001442
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001443sub ERROR {
Joe Perches000d1cc12011-07-25 17:13:25 -07001444 if (report("ERROR", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001445 our $clean = 0;
1446 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001447 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001448 }
Joe Perches3705ce52013-07-03 15:05:31 -07001449 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001450}
1451sub WARN {
Joe Perches000d1cc12011-07-25 17:13:25 -07001452 if (report("WARNING", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001453 our $clean = 0;
1454 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001455 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001456 }
Joe Perches3705ce52013-07-03 15:05:31 -07001457 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001458}
1459sub CHK {
Joe Perches000d1cc12011-07-25 17:13:25 -07001460 if ($check && report("CHECK", $_[0], $_[1])) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001461 our $clean = 0;
1462 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001463 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001464 }
Joe Perches3705ce52013-07-03 15:05:31 -07001465 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001466}
1467
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001468sub check_absolute_file {
1469 my ($absolute, $herecurr) = @_;
1470 my $file = $absolute;
1471
1472 ##print "absolute<$absolute>\n";
1473
1474 # See if any suffix of this path is a path within the tree.
1475 while ($file =~ s@^[^/]*/@@) {
1476 if (-f "$root/$file") {
1477 ##print "file<$file>\n";
1478 last;
1479 }
1480 }
1481 if (! -f _) {
1482 return 0;
1483 }
1484
1485 # It is, so see if the prefix is acceptable.
1486 my $prefix = $absolute;
1487 substr($prefix, -length($file)) = '';
1488
1489 ##print "prefix<$prefix>\n";
1490 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001491 WARN("USE_RELATIVE_PATH",
1492 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001493 }
1494}
1495
Joe Perches3705ce52013-07-03 15:05:31 -07001496sub trim {
1497 my ($string) = @_;
1498
Joe Perchesb34c6482013-09-11 14:24:01 -07001499 $string =~ s/^\s+|\s+$//g;
1500
1501 return $string;
1502}
1503
1504sub ltrim {
1505 my ($string) = @_;
1506
1507 $string =~ s/^\s+//;
1508
1509 return $string;
1510}
1511
1512sub rtrim {
1513 my ($string) = @_;
1514
1515 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001516
1517 return $string;
1518}
1519
Joe Perches52ea8502013-11-12 15:10:09 -08001520sub string_find_replace {
1521 my ($string, $find, $replace) = @_;
1522
1523 $string =~ s/$find/$replace/g;
1524
1525 return $string;
1526}
1527
Joe Perches3705ce52013-07-03 15:05:31 -07001528sub tabify {
1529 my ($leading) = @_;
1530
1531 my $source_indent = 8;
1532 my $max_spaces_before_tab = $source_indent - 1;
1533 my $spaces_to_tab = " " x $source_indent;
1534
1535 #convert leading spaces to tabs
1536 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1537 #Remove spaces before a tab
1538 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1539
1540 return "$leading";
1541}
1542
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001543sub pos_last_openparen {
1544 my ($line) = @_;
1545
1546 my $pos = 0;
1547
1548 my $opens = $line =~ tr/\(/\(/;
1549 my $closes = $line =~ tr/\)/\)/;
1550
1551 my $last_openparen = 0;
1552
1553 if (($opens == 0) || ($closes >= $opens)) {
1554 return -1;
1555 }
1556
1557 my $len = length($line);
1558
1559 for ($pos = 0; $pos < $len; $pos++) {
1560 my $string = substr($line, $pos);
1561 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1562 $pos += length($1) - 1;
1563 } elsif (substr($line, $pos, 1) eq '(') {
1564 $last_openparen = $pos;
1565 } elsif (index($string, '(') == -1) {
1566 last;
1567 }
1568 }
1569
1570 return $last_openparen + 1;
1571}
1572
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001573sub process {
1574 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001575
1576 my $linenr=0;
1577 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001578 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001579 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001580 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001581
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001582 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001583 my $indent;
1584 my $previndent=0;
1585 my $stashindent=0;
1586
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001587 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001588 my $signoff = 0;
1589 my $is_patch = 0;
1590
Joe Perches15662b32011-10-31 17:13:12 -07001591 my $in_header_lines = 1;
1592 my $in_commit_log = 0; #Scanning lines before patch
1593
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001594 my $non_utf8_charset = 0;
1595
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001596 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001597 our $cnt_lines = 0;
1598 our $cnt_error = 0;
1599 our $cnt_warn = 0;
1600 our $cnt_chk = 0;
1601
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001602 # Trace the real file/line as we go.
1603 my $realfile = '';
1604 my $realline = 0;
1605 my $realcnt = 0;
1606 my $here = '';
1607 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001608 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001609 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001610 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001611
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001612 my $prev_values = 'E';
1613
1614 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001615 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001616 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001617 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001618 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001619
Joe Perches7e51f192013-09-11 14:23:57 -07001620 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001621
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001622 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001623 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001624 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001625 my @setup_docs = ();
1626 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001627
Joe Perchesd8b07712013-11-12 15:10:06 -08001628 my $camelcase_file_seeded = 0;
1629
Andy Whitcroft773647a2008-03-28 14:15:58 -07001630 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001631 my $line;
1632 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001633 $linenr++;
1634 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001635
Joe Perches3705ce52013-07-03 15:05:31 -07001636 push(@fixed, $rawline) if ($fix);
1637
Andy Whitcroft773647a2008-03-28 14:15:58 -07001638 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001639 $setup_docs = 0;
1640 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1641 $setup_docs = 1;
1642 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001643 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001644 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001645 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1646 $realline=$1-1;
1647 if (defined $2) {
1648 $realcnt=$3+1;
1649 } else {
1650 $realcnt=1+1;
1651 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001652 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001653
1654 # Guestimate if this is a continuing comment. Run
1655 # the context looking for a comment "edge". If this
1656 # edge is a close comment then we must be in a comment
1657 # at context start.
1658 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001659 my $cnt = $realcnt;
1660 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1661 next if (defined $rawlines[$ln - 1] &&
1662 $rawlines[$ln - 1] =~ /^-/);
1663 $cnt--;
1664 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001665 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001666 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1667 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1668 ($edge) = $1;
1669 last;
1670 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001671 }
1672 if (defined $edge && $edge eq '*/') {
1673 $in_comment = 1;
1674 }
1675
1676 # Guestimate if this is a continuing comment. If this
1677 # is the start of a diff block and this line starts
1678 # ' *' then it is very likely a comment.
1679 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001680 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001681 {
1682 $in_comment = 1;
1683 }
1684
1685 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1686 sanitise_line_reset($in_comment);
1687
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001688 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001689 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001690 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001691 $line = sanitise_line($rawline);
1692 }
1693 push(@lines, $line);
1694
1695 if ($realcnt > 1) {
1696 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1697 } else {
1698 $realcnt = 0;
1699 }
1700
1701 #print "==>$rawline\n";
1702 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001703
1704 if ($setup_docs && $line =~ /^\+/) {
1705 push(@setup_docs, $line);
1706 }
1707 }
1708
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001709 $prefix = '';
1710
Andy Whitcroft773647a2008-03-28 14:15:58 -07001711 $realcnt = 0;
1712 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001713 foreach my $line (@lines) {
1714 $linenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001715 my $sline = $line; #copy of $line
1716 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001717
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001718 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001719
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001720#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001721 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001722 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001723 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001724 $realline=$1-1;
1725 if (defined $2) {
1726 $realcnt=$3+1;
1727 } else {
1728 $realcnt=1+1;
1729 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001730 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001731 $prev_values = 'E';
1732
Andy Whitcroft773647a2008-03-28 14:15:58 -07001733 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001734 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001735 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001736 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001737 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001738
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001739# track the line number as we move through the hunk, note that
1740# new versions of GNU diff omit the leading space on completely
1741# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001742 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001743 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001744 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001745
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001746 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001747 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001748
1749 # Track the previous line.
1750 ($prevline, $stashline) = ($stashline, $line);
1751 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001752 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1753
Andy Whitcroft773647a2008-03-28 14:15:58 -07001754 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001755
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001756 } elsif ($realcnt == 1) {
1757 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001758 }
1759
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001760 my $hunk_line = ($realcnt != 0);
1761
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001762#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001763 $prefix = "$filename:$realline: " if ($emacs && $file);
1764 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1765
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001766 $here = "#$linenr: " if (!$file);
1767 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001768
1769 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001770 if ($line =~ /^diff --git.*?(\S+)$/) {
1771 $realfile = $1;
1772 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001773 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001774 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001775 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001776 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001777 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001778
1779 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001780 if (!$file && $tree && $p1_prefix ne '' &&
1781 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001782 WARN("PATCH_PREFIX",
1783 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001784 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001785
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001786 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001787 ERROR("MODIFIED_INCLUDE_ASM",
1788 "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 -07001789 }
1790 next;
1791 }
1792
Randy Dunlap389834b2007-06-08 13:47:03 -07001793 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001794
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001795 my $hereline = "$here\n$rawline\n";
1796 my $herecurr = "$here\n$rawline\n";
1797 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001798
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001799 $cnt_lines++ if ($realcnt != 0);
1800
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001801# Check for incorrect file permissions
1802 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1803 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001804 if ($realfile !~ m@scripts/@ &&
1805 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001806 ERROR("EXECUTE_PERMISSIONS",
1807 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001808 }
1809 }
1810
Joe Perches20112472011-07-25 17:13:23 -07001811# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001812 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001813 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001814 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001815 }
1816
1817# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001818 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001819 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001820 my $space_before = $1;
1821 my $sign_off = $2;
1822 my $space_after = $3;
1823 my $email = $4;
1824 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1825
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001826 if ($sign_off !~ /$signature_tags/) {
1827 WARN("BAD_SIGN_OFF",
1828 "Non-standard signature: $sign_off\n" . $herecurr);
1829 }
Joe Perches20112472011-07-25 17:13:23 -07001830 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07001831 if (WARN("BAD_SIGN_OFF",
1832 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1833 $fix) {
1834 $fixed[$linenr - 1] =
1835 "$ucfirst_sign_off $email";
1836 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001837 }
Joe Perches20112472011-07-25 17:13:23 -07001838 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07001839 if (WARN("BAD_SIGN_OFF",
1840 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1841 $fix) {
1842 $fixed[$linenr - 1] =
1843 "$ucfirst_sign_off $email";
1844 }
1845
Joe Perches20112472011-07-25 17:13:23 -07001846 }
1847 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07001848 if (WARN("BAD_SIGN_OFF",
1849 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1850 $fix) {
1851 $fixed[$linenr - 1] =
1852 "$ucfirst_sign_off $email";
1853 }
Joe Perches20112472011-07-25 17:13:23 -07001854 }
1855
1856 my ($email_name, $email_address, $comment) = parse_email($email);
1857 my $suggested_email = format_email(($email_name, $email_address));
1858 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001859 ERROR("BAD_SIGN_OFF",
1860 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001861 } else {
1862 my $dequoted = $suggested_email;
1863 $dequoted =~ s/^"//;
1864 $dequoted =~ s/" </ </;
1865 # Don't force email to have quotes
1866 # Allow just an angle bracketed address
1867 if ("$dequoted$comment" ne $email &&
1868 "<$email_address>$comment" ne $email &&
1869 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001870 WARN("BAD_SIGN_OFF",
1871 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001872 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001873 }
Joe Perches7e51f192013-09-11 14:23:57 -07001874
1875# Check for duplicate signatures
1876 my $sig_nospace = $line;
1877 $sig_nospace =~ s/\s//g;
1878 $sig_nospace = lc($sig_nospace);
1879 if (defined $signatures{$sig_nospace}) {
1880 WARN("BAD_SIGN_OFF",
1881 "Duplicate signature\n" . $herecurr);
1882 } else {
1883 $signatures{$sig_nospace} = 1;
1884 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001885 }
1886
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001887# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001888 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001889 ERROR("CORRUPTED_PATCH",
1890 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001891 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001892 }
1893
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001894# Check for absolute kernel paths.
1895 if ($tree) {
1896 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1897 my $file = $1;
1898
1899 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1900 check_absolute_file($1, $herecurr)) {
1901 #
1902 } else {
1903 check_absolute_file($file, $herecurr);
1904 }
1905 }
1906 }
1907
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001908# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1909 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001910 $rawline !~ m/^$UTF8*$/) {
1911 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1912
1913 my $blank = copy_spacing($rawline);
1914 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1915 my $hereptr = "$hereline$ptr\n";
1916
Joe Perches34d99212011-07-25 17:13:26 -07001917 CHK("INVALID_UTF8",
1918 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001919 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001920
Joe Perches15662b32011-10-31 17:13:12 -07001921# Check if it's the start of a commit log
1922# (not a header line and we haven't seen the patch filename)
1923 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001924 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001925 $in_header_lines = 0;
1926 $in_commit_log = 1;
1927 }
1928
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001929# Check if there is UTF-8 in a commit log when a mail header has explicitly
1930# declined it, i.e defined some charset where it is missing.
1931 if ($in_header_lines &&
1932 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1933 $1 !~ /utf-8/i) {
1934 $non_utf8_charset = 1;
1935 }
1936
1937 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001938 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001939 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001940 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1941 }
1942
Andy Whitcroft306708542008-10-15 22:02:28 -07001943# ignore non-hunk lines and lines being removed
1944 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001945
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001946#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001947 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001948 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07001949 if (ERROR("DOS_LINE_ENDINGS",
1950 "DOS line endings\n" . $herevet) &&
1951 $fix) {
1952 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
1953 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001954 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1955 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07001956 if (ERROR("TRAILING_WHITESPACE",
1957 "trailing whitespace\n" . $herevet) &&
1958 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07001959 $fixed[$linenr - 1] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001960 }
1961
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001962 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001963 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07001964
Andi Kleen33549572010-05-24 14:33:29 -07001965# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001966# Only applies when adding the entry originally, after that we do not have
1967# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07001968 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08001969 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07001970 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001971 my $cnt = $realcnt;
1972 my $ln = $linenr + 1;
1973 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001974 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001975 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001976 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001977 $f = $lines[$ln - 1];
1978 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1979 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001980
1981 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08001982
1983 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1984 $is_start = 1;
1985 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1986 $length = -1;
1987 }
1988
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001989 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07001990 $f =~ s/#.*//;
1991 $f =~ s/^\s+//;
1992 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001993 if ($f =~ /^\s*config\s/) {
1994 $is_end = 1;
1995 last;
1996 }
Andi Kleen33549572010-05-24 14:33:29 -07001997 $length++;
1998 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001999 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08002000 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2001 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002002 }
2003
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002004# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2005 if ($realfile =~ /Kconfig/ &&
2006 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2007 WARN("CONFIG_EXPERIMENTAL",
2008 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2009 }
2010
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002011 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2012 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2013 my $flag = $1;
2014 my $replacement = {
2015 'EXTRA_AFLAGS' => 'asflags-y',
2016 'EXTRA_CFLAGS' => 'ccflags-y',
2017 'EXTRA_CPPFLAGS' => 'cppflags-y',
2018 'EXTRA_LDFLAGS' => 'ldflags-y',
2019 };
2020
2021 WARN("DEPRECATED_VARIABLE",
2022 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2023 }
2024
Andy Whitcroft5368df202008-10-15 22:02:27 -07002025# check we are in a valid source file if not then ignore this hunk
2026 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2027
Joe Perches6cd7f382012-12-17 16:01:54 -08002028#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002029 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002030 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002031 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002032 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002033 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002034 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002035 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002036 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002037 }
2038
Josh Triplettca56dc02012-03-23 15:02:21 -07002039# Check for user-visible strings broken across lines, which breaks the ability
2040# to grep for the string. Limited to strings used as parameters (those
2041# following an open parenthesis), which almost completely eliminates false
2042# positives, as well as warning only once per parameter rather than once per
2043# line of the string. Make an exception when the previous string ends in a
2044# newline (multiple lines in one string constant) or \n\t (common in inline
2045# assembly to indent the instruction on the following line).
2046 if ($line =~ /^\+\s*"/ &&
2047 $prevline =~ /"\s*$/ &&
2048 $prevline =~ /\(/ &&
2049 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
2050 WARN("SPLIT_STRING",
2051 "quoted string split across lines\n" . $hereprev);
2052 }
2053
Joe Perches5e79d962010-03-05 13:43:55 -08002054# check for spaces before a quoted newline
2055 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002056 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2057 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2058 $fix) {
2059 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2060 }
2061
Joe Perches5e79d962010-03-05 13:43:55 -08002062 }
2063
Andy Whitcroft8905a672007-11-28 16:21:06 -08002064# check for adding lines without a newline.
2065 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002066 WARN("MISSING_EOF_NEWLINE",
2067 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002068 }
2069
Mike Frysinger42e41c52009-09-21 17:04:40 -07002070# Blackfin: use hi/lo macros
2071 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2072 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2073 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002074 ERROR("LO_MACRO",
2075 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002076 }
2077 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2078 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002079 ERROR("HI_MACRO",
2080 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002081 }
2082 }
2083
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002084# check we are in a valid source file C or perl if not then ignore this hunk
2085 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002086
2087# at the beginning of a line any tabs must come first and anything
2088# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002089 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2090 $rawline =~ /^\+\s* \s*/) {
2091 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002092 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002093 if (ERROR("CODE_INDENT",
2094 "code indent should use tabs where possible\n" . $herevet) &&
2095 $fix) {
2096 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2097 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002098 }
2099
Alberto Panizzo08e44362010-03-05 13:43:54 -08002100# check for space before tabs.
2101 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2102 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002103 if (WARN("SPACE_BEFORE_TAB",
2104 "please, no space before tabs\n" . $herevet) &&
2105 $fix) {
2106 $fixed[$linenr - 1] =~
2107 s/(^\+.*) +\t/$1\t/;
2108 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002109 }
2110
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002111# check for && or || at the start of a line
2112 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2113 CHK("LOGICAL_CONTINUATIONS",
2114 "Logical continuations should be on the previous line\n" . $hereprev);
2115 }
2116
2117# check multi-line statement indentation matches previous line
2118 if ($^V && $^V ge 5.10.0 &&
2119 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
2120 $prevline =~ /^\+(\t*)(.*)$/;
2121 my $oldindent = $1;
2122 my $rest = $2;
2123
2124 my $pos = pos_last_openparen($rest);
2125 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002126 $line =~ /^(\+| )([ \t]*)/;
2127 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002128
2129 my $goodtabindent = $oldindent .
2130 "\t" x ($pos / 8) .
2131 " " x ($pos % 8);
2132 my $goodspaceindent = $oldindent . " " x $pos;
2133
2134 if ($newindent ne $goodtabindent &&
2135 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002136
2137 if (CHK("PARENTHESIS_ALIGNMENT",
2138 "Alignment should match open parenthesis\n" . $hereprev) &&
2139 $fix && $line =~ /^\+/) {
2140 $fixed[$linenr - 1] =~
2141 s/^\+[ \t]*/\+$goodtabindent/;
2142 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002143 }
2144 }
2145 }
2146
Joe Perches23f780c2013-07-03 15:05:31 -07002147 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002148 if (CHK("SPACING",
2149 "No space is necessary after a cast\n" . $hereprev) &&
2150 $fix) {
2151 $fixed[$linenr - 1] =~
2152 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2153 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002154 }
2155
Joe Perches05880602012-10-04 17:13:35 -07002156 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002157 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2158 $rawline =~ /^\+[ \t]*\*/) {
Joe Perches05880602012-10-04 17:13:35 -07002159 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2160 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2161 }
2162
2163 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002164 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2165 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002166 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002167 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2168 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2169 "networking block comments start with * on subsequent lines\n" . $hereprev);
2170 }
2171
2172 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002173 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2174 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2175 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2176 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002177 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2178 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2179 }
2180
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002181# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002182# Exceptions:
2183# 1) within comments
2184# 2) indented preprocessor commands
2185# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002186 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002187 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002188 if (WARN("LEADING_SPACE",
2189 "please, no spaces at the start of a line\n" . $herevet) &&
2190 $fix) {
2191 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2192 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002193 }
2194
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002195# check we are in a valid C source file if not then ignore this hunk
2196 next if ($realfile !~ /\.(h|c)$/);
2197
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002198# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2199 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2200 WARN("CONFIG_EXPERIMENTAL",
2201 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2202 }
2203
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002204# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002205 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002206 WARN("CVS_KEYWORD",
2207 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002208 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002209
Mike Frysinger42e41c52009-09-21 17:04:40 -07002210# Blackfin: don't use __builtin_bfin_[cs]sync
2211 if ($line =~ /__builtin_bfin_csync/) {
2212 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002213 ERROR("CSYNC",
2214 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002215 }
2216 if ($line =~ /__builtin_bfin_ssync/) {
2217 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002218 ERROR("SSYNC",
2219 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002220 }
2221
Joe Perches56e77d72013-02-21 16:44:14 -08002222# check for old HOTPLUG __dev<foo> section markings
2223 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2224 WARN("HOTPLUG_SECTION",
2225 "Using $1 is unnecessary\n" . $herecurr);
2226 }
2227
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002228# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002229 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2230 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002231#print "LINE<$line>\n";
2232 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002233 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002234 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002235 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002236 $stat =~ s/\n./\n /g;
2237 $cond =~ s/\n./\n /g;
2238
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002239#print "linenr<$linenr> <$stat>\n";
2240 # If this statement has no statement boundaries within
2241 # it there is no point in retrying a statement scan
2242 # until we hit end of it.
2243 my $frag = $stat; $frag =~ s/;+\s*$//;
2244 if ($frag !~ /(?:{|;)/) {
2245#print "skip<$line_nr_next>\n";
2246 $suppress_statement = $line_nr_next;
2247 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002248
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002249 # Find the real next line.
2250 $realline_next = $line_nr_next;
2251 if (defined $realline_next &&
2252 (!defined $lines[$realline_next - 1] ||
2253 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2254 $realline_next++;
2255 }
2256
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002257 my $s = $stat;
2258 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002259
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002260 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002261 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002262
2263 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002264 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002265
Andy Whitcroft463f2862009-09-21 17:04:34 -07002266 } elsif ($s =~ /^.\s*else\b/s) {
2267
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002268 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002269 } 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 -07002270 my $type = $1;
2271 $type =~ s/\s+/ /g;
2272 possible($type, "A:" . $s);
2273
Andy Whitcroft8905a672007-11-28 16:21:06 -08002274 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002275 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002276 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002277 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002278
2279 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002280 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002281 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002282 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002283
2284 # Check for any sort of function declaration.
2285 # int foo(something bar, other baz);
2286 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002287 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 -08002288 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002289
Andy Whitcroftcf655042008-03-04 14:28:20 -08002290 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002291 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002292 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002293
Andy Whitcroft8905a672007-11-28 16:21:06 -08002294 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002295 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002296
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002297 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002298 }
2299 }
2300 }
2301
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002302 }
2303
Andy Whitcroft653d4872007-06-23 17:16:34 -07002304#
2305# Checks which may be anchored in the context.
2306#
2307
2308# Check for switch () and associated case and default
2309# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002310 if ($line=~/\bswitch\s*\(.*\)/) {
2311 my $err = '';
2312 my $sep = '';
2313 my @ctx = ctx_block_outer($linenr, $realcnt);
2314 shift(@ctx);
2315 for my $ctx (@ctx) {
2316 my ($clen, $cindent) = line_stats($ctx);
2317 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2318 $indent != $cindent) {
2319 $err .= "$sep$ctx\n";
2320 $sep = '';
2321 } else {
2322 $sep = "[...]\n";
2323 }
2324 }
2325 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002326 ERROR("SWITCH_CASE_INDENT_LEVEL",
2327 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002328 }
2329 }
2330
2331# if/while/etc brace do not go on next line, unless defining a do while loop,
2332# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002333 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002334 my $pre_ctx = "$1$2";
2335
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002336 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002337
2338 if ($line =~ /^\+\t{6,}/) {
2339 WARN("DEEP_INDENTATION",
2340 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2341 }
2342
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002343 my $ctx_cnt = $realcnt - $#ctx - 1;
2344 my $ctx = join("\n", @ctx);
2345
Andy Whitcroft548596d2008-07-23 21:29:01 -07002346 my $ctx_ln = $linenr;
2347 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002348
Andy Whitcroft548596d2008-07-23 21:29:01 -07002349 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2350 defined $lines[$ctx_ln - 1] &&
2351 $lines[$ctx_ln - 1] =~ /^-/)) {
2352 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2353 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002354 $ctx_ln++;
2355 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002356
Andy Whitcroft53210162008-07-23 21:29:03 -07002357 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2358 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002359
2360 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002361 ERROR("OPEN_BRACE",
2362 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002363 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002364 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002365 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2366 $ctx =~ /\)\s*\;\s*$/ &&
2367 defined $lines[$ctx_ln - 1])
2368 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002369 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2370 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002371 WARN("TRAILING_SEMICOLON",
2372 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002373 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002374 }
2375 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002376 }
2377
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002378# Check relative indent for conditionals and blocks.
2379 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002380 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2381 ctx_statement_block($linenr, $realcnt, 0)
2382 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002383 my ($s, $c) = ($stat, $cond);
2384
2385 substr($s, 0, length($c), '');
2386
2387 # Make sure we remove the line prefixes as we have
2388 # none on the first line, and are going to readd them
2389 # where necessary.
2390 $s =~ s/\n./\n/gs;
2391
2392 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002393 my @newlines = ($c =~ /\n/gs);
2394 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002395
2396 # We want to check the first line inside the block
2397 # starting at the end of the conditional, so remove:
2398 # 1) any blank line termination
2399 # 2) any opening brace { on end of the line
2400 # 3) any do (...) {
2401 my $continuation = 0;
2402 my $check = 0;
2403 $s =~ s/^.*\bdo\b//;
2404 $s =~ s/^\s*{//;
2405 if ($s =~ s/^\s*\\//) {
2406 $continuation = 1;
2407 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002408 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002409 $check = 1;
2410 $cond_lines++;
2411 }
2412
2413 # Also ignore a loop construct at the end of a
2414 # preprocessor statement.
2415 if (($prevline =~ /^.\s*#\s*define\s/ ||
2416 $prevline =~ /\\\s*$/) && $continuation == 0) {
2417 $check = 0;
2418 }
2419
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002420 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002421 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002422 while ($cond_ptr != $cond_lines) {
2423 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002424
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002425 # If we see an #else/#elif then the code
2426 # is not linear.
2427 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2428 $check = 0;
2429 }
2430
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002431 # Ignore:
2432 # 1) blank lines, they should be at 0,
2433 # 2) preprocessor lines, and
2434 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002435 if ($continuation ||
2436 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002437 $s =~ /^\s*#\s*?/ ||
2438 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002439 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002440 if ($s =~ s/^.*?\n//) {
2441 $cond_lines++;
2442 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002443 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002444 }
2445
2446 my (undef, $sindent) = line_stats("+" . $s);
2447 my $stat_real = raw_line($linenr, $cond_lines);
2448
2449 # Check if either of these lines are modified, else
2450 # this is not this patch's fault.
2451 if (!defined($stat_real) ||
2452 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2453 $check = 0;
2454 }
2455 if (defined($stat_real) && $cond_lines > 1) {
2456 $stat_real = "[...]\n$stat_real";
2457 }
2458
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002459 #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 -07002460
2461 if ($check && (($sindent % 8) != 0 ||
2462 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002463 WARN("SUSPECT_CODE_INDENT",
2464 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002465 }
2466 }
2467
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002468 # Track the 'values' across context and added lines.
2469 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002470 my ($curr_values, $curr_vars) =
2471 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002472 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002473 if ($dbg_values) {
2474 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002475 print "$linenr > .$outline\n";
2476 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002477 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002478 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002479 $prev_values = substr($curr_values, -1);
2480
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002481#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002482 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002483
Andy Whitcroft653d4872007-06-23 17:16:34 -07002484# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002485 if ($dbg_type) {
2486 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002487 ERROR("TEST_TYPE",
2488 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002489 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002490 ERROR("TEST_NOT_TYPE",
2491 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002492 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002493 next;
2494 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002495# TEST: allow direct testing of the attribute matcher.
2496 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002497 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002498 ERROR("TEST_ATTR",
2499 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002500 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002501 ERROR("TEST_NOT_ATTR",
2502 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002503 }
2504 next;
2505 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002506
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002507# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002508 if ($line =~ /^.\s*{/ &&
2509 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002510 ERROR("OPEN_BRACE",
2511 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002512 }
2513
Andy Whitcroft653d4872007-06-23 17:16:34 -07002514#
2515# Checks which are anchored on the added line.
2516#
2517
2518# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002519 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002520 my $path = $1;
2521 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002522 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002523 "malformed #include filename\n" . $herecurr);
2524 }
2525 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2526 ERROR("UAPI_INCLUDE",
2527 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002528 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002529 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002530
2531# no C99 // comments
2532 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002533 if (ERROR("C99_COMMENTS",
2534 "do not use C99 // comments\n" . $herecurr) &&
2535 $fix) {
2536 my $line = $fixed[$linenr - 1];
2537 if ($line =~ /\/\/(.*)$/) {
2538 my $comment = trim($1);
2539 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2540 }
2541 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002542 }
2543 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002544 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002545 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002546
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002547# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2548# the whole statement.
2549#print "APW <$lines[$realline_next - 1]>\n";
2550 if (defined $realline_next &&
2551 exists $lines[$realline_next - 1] &&
2552 !defined $suppress_export{$realline_next} &&
2553 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2554 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002555 # Handle definitions which produce identifiers with
2556 # a prefix:
2557 # XXX(foo);
2558 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002559 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002560 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002561 $name =~ /^${Ident}_$2/) {
2562#print "FOO C name<$name>\n";
2563 $suppress_export{$realline_next} = 1;
2564
2565 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002566 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002567 ^.DEFINE_$Ident\(\Q$name\E\)|
2568 ^.DECLARE_$Ident\(\Q$name\E\)|
2569 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002570 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2571 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002572 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002573#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2574 $suppress_export{$realline_next} = 2;
2575 } else {
2576 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002577 }
2578 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002579 if (!defined $suppress_export{$linenr} &&
2580 $prevline =~ /^.\s*$/ &&
2581 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2582 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2583#print "FOO B <$lines[$linenr - 1]>\n";
2584 $suppress_export{$linenr} = 2;
2585 }
2586 if (defined $suppress_export{$linenr} &&
2587 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002588 WARN("EXPORT_SYMBOL",
2589 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002590 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002591
Joe Eloff5150bda2010-08-09 17:21:00 -07002592# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002593 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2594 if (ERROR("GLOBAL_INITIALISERS",
2595 "do not initialise globals to 0 or NULL\n" .
2596 $herecurr) &&
2597 $fix) {
2598 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2599 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002600 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002601# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002602 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2603 if (ERROR("INITIALISED_STATIC",
2604 "do not initialise statics to 0 or NULL\n" .
2605 $herecurr) &&
2606 $fix) {
2607 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2608 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002609 }
2610
Joe Perchescb710ec2010-10-26 14:23:20 -07002611# check for static const char * arrays.
2612 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002613 WARN("STATIC_CONST_CHAR_ARRAY",
2614 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002615 $herecurr);
2616 }
2617
2618# check for static char foo[] = "bar" declarations.
2619 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002620 WARN("STATIC_CONST_CHAR_ARRAY",
2621 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002622 $herecurr);
2623 }
2624
Joe Perches93ed0e22010-10-26 14:23:21 -07002625# check for declarations of struct pci_device_id
2626 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002627 WARN("DEFINE_PCI_DEVICE_TABLE",
2628 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
Joe Perches93ed0e22010-10-26 14:23:21 -07002629 }
2630
Andy Whitcroft653d4872007-06-23 17:16:34 -07002631# check for new typedefs, only function parameters and sparse annotations
2632# make sense.
2633 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002634 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002635 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002636 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002637 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002638 WARN("NEW_TYPEDEFS",
2639 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002640 }
2641
2642# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002643 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002644 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2645 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002646 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002647
Andy Whitcroft65863862009-01-06 14:41:21 -08002648 # Should start with a space.
2649 $to =~ s/^(\S)/ $1/;
2650 # Should not end with a space.
2651 $to =~ s/\s+$//;
2652 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002653 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002654 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002655
Joe Perches3705ce52013-07-03 15:05:31 -07002656## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08002657 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07002658 if (ERROR("POINTER_LOCATION",
2659 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2660 $fix) {
2661 my $sub_from = $ident;
2662 my $sub_to = $ident;
2663 $sub_to =~ s/\Q$from\E/$to/;
2664 $fixed[$linenr - 1] =~
2665 s@\Q$sub_from\E@$sub_to@;
2666 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002667 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002668 }
2669 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2670 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002671 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002672
Andy Whitcroft65863862009-01-06 14:41:21 -08002673 # Should start with a space.
2674 $to =~ s/^(\S)/ $1/;
2675 # Should not end with a space.
2676 $to =~ s/\s+$//;
2677 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002678 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002679 }
2680 # Modifiers should have spaces.
2681 $to =~ s/(\b$Modifier$)/$1 /;
2682
Joe Perches3705ce52013-07-03 15:05:31 -07002683## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08002684 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002685 if (ERROR("POINTER_LOCATION",
2686 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2687 $fix) {
2688
2689 my $sub_from = $match;
2690 my $sub_to = $match;
2691 $sub_to =~ s/\Q$from\E/$to/;
2692 $fixed[$linenr - 1] =~
2693 s@\Q$sub_from\E@$sub_to@;
2694 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002695 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002696 }
2697
2698# # no BUG() or BUG_ON()
2699# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2700# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2701# print "$herecurr";
2702# $clean = 0;
2703# }
2704
Andy Whitcroft8905a672007-11-28 16:21:06 -08002705 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002706 WARN("LINUX_VERSION_CODE",
2707 "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 -08002708 }
2709
Joe Perches17441222011-06-15 15:08:17 -07002710# check for uses of printk_ratelimit
2711 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002712 WARN("PRINTK_RATELIMITED",
2713"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002714 }
2715
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002716# printk should use KERN_* levels. Note that follow on printk's on the
2717# same line do not need a level, so we use the current block context
2718# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002719# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002720# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002721 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002722 my $ok = 0;
2723 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2724 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002725 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002726 # with "\n" ignore it, else it is to blame
2727 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2728 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2729 $ok = 1;
2730 }
2731 last;
2732 }
2733 }
2734 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002735 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2736 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002737 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002738 }
2739
Joe Perches243f3802012-05-31 16:26:09 -07002740 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2741 my $orig = $1;
2742 my $level = lc($orig);
2743 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002744 my $level2 = $level;
2745 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002746 WARN("PREFER_PR_LEVEL",
Joe Perches8f26b832012-10-04 17:13:32 -07002747 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Joe Perches243f3802012-05-31 16:26:09 -07002748 }
2749
2750 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002751 if (WARN("PREFER_PR_LEVEL",
2752 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2753 $fix) {
2754 $fixed[$linenr - 1] =~
2755 s/\bpr_warning\b/pr_warn/;
2756 }
Joe Perches243f3802012-05-31 16:26:09 -07002757 }
2758
Joe Perchesdc139312013-02-21 16:44:13 -08002759 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2760 my $orig = $1;
2761 my $level = lc($orig);
2762 $level = "warn" if ($level eq "warning");
2763 $level = "dbg" if ($level eq "debug");
2764 WARN("PREFER_DEV_LEVEL",
2765 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2766 }
2767
Andy Whitcroft653d4872007-06-23 17:16:34 -07002768# function brace can't be on same line, except for #defines of do while,
2769# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002770 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2771 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002772 ERROR("OPEN_BRACE",
2773 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002774 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002775
Andy Whitcroft8905a672007-11-28 16:21:06 -08002776# open braces for enum, union and struct go on the same line.
2777 if ($line =~ /^.\s*{/ &&
2778 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002779 ERROR("OPEN_BRACE",
2780 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002781 }
2782
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002783# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07002784 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2785 if (WARN("SPACING",
2786 "missing space after $1 definition\n" . $herecurr) &&
2787 $fix) {
2788 $fixed[$linenr - 1] =~
2789 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2790 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002791 }
2792
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002793# check for spacing round square brackets; allowed:
2794# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002795# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2796# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002797 while ($line =~ /(.*?\s)\[/g) {
2798 my ($where, $prefix) = ($-[1], $1);
2799 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002800 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002801 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002802 if (ERROR("BRACKET_SPACE",
2803 "space prohibited before open square bracket '['\n" . $herecurr) &&
2804 $fix) {
2805 $fixed[$linenr - 1] =~
2806 s/^(\+.*?)\s+\[/$1\[/;
2807 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002808 }
2809 }
2810
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002811# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002812 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002813 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002814 my $ctx_before = substr($line, 0, $-[1]);
2815 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002816
2817 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002818 if ($name =~ /^(?:
2819 if|for|while|switch|return|case|
2820 volatile|__volatile__|
2821 __attribute__|format|__extension__|
2822 asm|__asm__)$/x)
2823 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002824 # cpp #define statements have non-optional spaces, ie
2825 # if there is a space between the name and the open
2826 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002827 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002828
2829 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002830 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002831
2832 # If this whole things ends with a type its most
2833 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002834 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002835
2836 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07002837 if (WARN("SPACING",
2838 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
2839 $fix) {
2840 $fixed[$linenr - 1] =~
2841 s/\b$name\s+\(/$name\(/;
2842 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002843 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002844 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07002845
Andy Whitcroft653d4872007-06-23 17:16:34 -07002846# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002847 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002848 my $fixed_line = "";
2849 my $line_fixed = 0;
2850
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002851 my $ops = qr{
2852 <<=|>>=|<=|>=|==|!=|
2853 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2854 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002855 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08002856 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002857 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002858 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07002859
2860## print("element count: <" . $#elements . ">\n");
2861## foreach my $el (@elements) {
2862## print("el: <$el>\n");
2863## }
2864
2865 my @fix_elements = ();
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002866 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002867
Joe Perches3705ce52013-07-03 15:05:31 -07002868 foreach my $el (@elements) {
2869 push(@fix_elements, substr($rawline, $off, length($el)));
2870 $off += length($el);
2871 }
2872
2873 $off = 0;
2874
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002875 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07002876 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002877
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002878 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07002879
2880 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
2881
2882## print("n: <$n> good: <$good>\n");
2883
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002884 $off += length($elements[$n]);
2885
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002886 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002887 my $ca = substr($opline, 0, $off);
2888 my $cc = '';
2889 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2890 $cc = substr($opline, $off + length($elements[$n + 1]));
2891 }
2892 my $cb = "$ca$;$cc";
2893
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002894 my $a = '';
2895 $a = 'V' if ($elements[$n] ne '');
2896 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002897 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002898 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2899 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07002900 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002901
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002902 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002903
2904 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002905 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002906 $c = 'V' if ($elements[$n + 2] ne '');
2907 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002908 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002909 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2910 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08002911 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002912 } else {
2913 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002914 }
2915
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002916 my $ctx = "${a}x${c}";
2917
2918 my $at = "(ctx:$ctx)";
2919
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002920 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002921 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002922
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002923 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002924 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002925
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002926 # Get the full operator variant.
2927 my $opv = $op . substr($curr_vars, $off, 1);
2928
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002929 # Ignore operators passed as parameters.
2930 if ($op_type ne 'V' &&
2931 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2932
Andy Whitcroftcf655042008-03-04 14:28:20 -08002933# # Ignore comments
2934# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002935
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002936 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002937 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002938 if ($ctx !~ /.x[WEBC]/ &&
2939 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002940 if (ERROR("SPACING",
2941 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07002942 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07002943 $line_fixed = 1;
2944 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002945 }
2946
2947 # // is a comment
2948 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002949
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002950 # No spaces for:
2951 # ->
2952 # : when part of a bitfield
2953 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002954 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002955 if (ERROR("SPACING",
2956 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07002957 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07002958 if (defined $fix_elements[$n + 2]) {
2959 $fix_elements[$n + 2] =~ s/^\s+//;
2960 }
Joe Perchesb34c6482013-09-11 14:24:01 -07002961 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002962 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002963 }
2964
2965 # , must have a space on the right.
2966 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002967 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002968 if (ERROR("SPACING",
2969 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07002970 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07002971 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07002972 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07002973 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002974 }
2975
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002976 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002977 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002978 #warn "'*' is part of type\n";
2979
2980 # unary operators should have a space before and
2981 # none after. May be left adjacent to another
2982 # unary operator, or a cast
2983 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002984 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002985 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002986 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002987 if (ERROR("SPACING",
2988 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07002989 if ($n != $last_after + 2) {
2990 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
2991 $line_fixed = 1;
2992 }
Joe Perches3705ce52013-07-03 15:05:31 -07002993 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002994 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002995 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002996 # A unary '*' may be const
2997
2998 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002999 if (ERROR("SPACING",
3000 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003001 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003002 if (defined $fix_elements[$n + 2]) {
3003 $fix_elements[$n + 2] =~ s/^\s+//;
3004 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003005 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003006 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003007 }
3008
3009 # unary ++ and unary -- are allowed no space on one side.
3010 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003011 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003012 if (ERROR("SPACING",
3013 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003014 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003015 $line_fixed = 1;
3016 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003017 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003018 if ($ctx =~ /Wx[BE]/ ||
3019 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003020 if (ERROR("SPACING",
3021 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003022 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003023 $line_fixed = 1;
3024 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003025 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003026 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003027 if (ERROR("SPACING",
3028 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003029 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003030 if (defined $fix_elements[$n + 2]) {
3031 $fix_elements[$n + 2] =~ s/^\s+//;
3032 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003033 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003034 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003035 }
3036
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003037 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003038 } elsif ($op eq '<<' or $op eq '>>' or
3039 $op eq '&' or $op eq '^' or $op eq '|' or
3040 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003041 $op eq '*' or $op eq '/' or
3042 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003043 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003044 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003045 if (ERROR("SPACING",
3046 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003047 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3048 if (defined $fix_elements[$n + 2]) {
3049 $fix_elements[$n + 2] =~ s/^\s+//;
3050 }
Joe Perches3705ce52013-07-03 15:05:31 -07003051 $line_fixed = 1;
3052 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003053 }
3054
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003055 # A colon needs no spaces before when it is
3056 # terminating a case value or a label.
3057 } elsif ($opv eq ':C' || $opv eq ':L') {
3058 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003059 if (ERROR("SPACING",
3060 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003061 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003062 $line_fixed = 1;
3063 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003064 }
3065
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003066 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003067 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003068 my $ok = 0;
3069
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003070 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003071 if (($op eq '<' &&
3072 $cc =~ /^\S+\@\S+>/) ||
3073 ($op eq '>' &&
3074 $ca =~ /<\S+\@\S+$/))
3075 {
3076 $ok = 1;
3077 }
3078
Joe Perches84731622013-11-12 15:10:05 -08003079 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003080 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003081 my $msg_type = \&ERROR;
3082 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3083
3084 if (&{$msg_type}("SPACING",
3085 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003086 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3087 if (defined $fix_elements[$n + 2]) {
3088 $fix_elements[$n + 2] =~ s/^\s+//;
3089 }
Joe Perches3705ce52013-07-03 15:05:31 -07003090 $line_fixed = 1;
3091 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003092 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003093 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003094 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003095
3096## print("n: <$n> GOOD: <$good>\n");
3097
3098 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003099 }
Joe Perches3705ce52013-07-03 15:05:31 -07003100
3101 if (($#elements % 2) == 0) {
3102 $fixed_line = $fixed_line . $fix_elements[$#elements];
3103 }
3104
3105 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3106 $fixed[$linenr - 1] = $fixed_line;
3107 }
3108
3109
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003110 }
3111
Joe Perches786b6322013-07-03 15:05:32 -07003112# check for whitespace before a non-naked semicolon
3113 if ($line =~ /^\+.*\S\s+;/) {
3114 if (WARN("SPACING",
3115 "space prohibited before semicolon\n" . $herecurr) &&
3116 $fix) {
3117 1 while $fixed[$linenr - 1] =~
3118 s/^(\+.*\S)\s+;/$1;/;
3119 }
3120 }
3121
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003122# check for multiple assignments
3123 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003124 CHK("MULTIPLE_ASSIGNMENTS",
3125 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003126 }
3127
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003128## # check for multiple declarations, allowing for a function declaration
3129## # continuation.
3130## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3131## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3132##
3133## # Remove any bracketed sections to ensure we do not
3134## # falsly report the parameters of functions.
3135## my $ln = $line;
3136## while ($ln =~ s/\([^\(\)]*\)//g) {
3137## }
3138## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003139## WARN("MULTIPLE_DECLARATION",
3140## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003141## }
3142## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003143
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003144#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003145 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3146 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003147 if (ERROR("SPACING",
3148 "space required before the open brace '{'\n" . $herecurr) &&
3149 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003150 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003151 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003152 }
3153
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003154## # check for blank lines before declarations
3155## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3156## $prevrawline =~ /^.\s*$/) {
3157## WARN("SPACING",
3158## "No blank lines before declarations\n" . $hereprev);
3159## }
3160##
3161
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003162# closing brace should have a space following it when it has anything
3163# on the line
3164 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003165 if (ERROR("SPACING",
3166 "space required after that close brace '}'\n" . $herecurr) &&
3167 $fix) {
3168 $fixed[$linenr - 1] =~
3169 s/}((?!(?:,|;|\)))\S)/} $1/;
3170 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003171 }
3172
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003173# check spacing on square brackets
3174 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003175 if (ERROR("SPACING",
3176 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3177 $fix) {
3178 $fixed[$linenr - 1] =~
3179 s/\[\s+/\[/;
3180 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003181 }
3182 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003183 if (ERROR("SPACING",
3184 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3185 $fix) {
3186 $fixed[$linenr - 1] =~
3187 s/\s+\]/\]/;
3188 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003189 }
3190
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003191# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003192 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3193 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003194 if (ERROR("SPACING",
3195 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3196 $fix) {
3197 $fixed[$linenr - 1] =~
3198 s/\(\s+/\(/;
3199 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003200 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003201 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003202 $line !~ /for\s*\(.*;\s+\)/ &&
3203 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003204 if (ERROR("SPACING",
3205 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3206 $fix) {
3207 $fixed[$linenr - 1] =~
3208 s/\s+\)/\)/;
3209 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003210 }
3211
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003212#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003213 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003214 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003215 if (WARN("INDENTED_LABEL",
3216 "labels should not be indented\n" . $herecurr) &&
3217 $fix) {
3218 $fixed[$linenr - 1] =~
3219 s/^(.)\s+/$1/;
3220 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003221 }
3222
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003223# Return is not a function.
3224 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
3225 my $spacing = $1;
3226 my $value = $2;
3227
Andy Whitcroft86f9d052009-01-06 14:41:24 -08003228 # Flatten any parentheses
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07003229 $value =~ s/\(/ \(/g;
3230 $value =~ s/\)/\) /g;
Andy Whitcrofte01886a2012-01-10 15:10:08 -08003231 while ($value =~ s/\[[^\[\]]*\]/1/ ||
Andy Whitcroft63f17f82009-01-15 13:51:06 -08003232 $value !~ /(?:$Ident|-?$Constant)\s*
3233 $Compare\s*
3234 (?:$Ident|-?$Constant)/x &&
3235 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003236 }
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07003237#print "value<$value>\n";
3238 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003239 ERROR("RETURN_PARENTHESES",
3240 "return is not a function, parentheses are not required\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003241
3242 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003243 ERROR("SPACING",
3244 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003245 }
3246 }
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003247# Return of what appears to be an errno should normally be -'ve
3248 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3249 my $name = $1;
3250 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003251 WARN("USE_NEGATIVE_ERRNO",
3252 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003253 }
3254 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003255
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003256# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003257 if ($line =~ /\b(if|while|for|switch)\(/) {
3258 if (ERROR("SPACING",
3259 "space required before the open parenthesis '('\n" . $herecurr) &&
3260 $fix) {
3261 $fixed[$linenr - 1] =~
3262 s/\b(if|while|for|switch)\(/$1 \(/;
3263 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003264 }
3265
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003266# Check for illegal assignment in if conditional -- and check for trailing
3267# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003268 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003269 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3270 ctx_statement_block($linenr, $realcnt, 0)
3271 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003272 my ($stat_next) = ctx_statement_block($line_nr_next,
3273 $remain_next, $off_next);
3274 $stat_next =~ s/\n./\n /g;
3275 ##print "stat<$stat> stat_next<$stat_next>\n";
3276
3277 if ($stat_next =~ /^\s*while\b/) {
3278 # If the statement carries leading newlines,
3279 # then count those as offsets.
3280 my ($whitespace) =
3281 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3282 my $offset =
3283 statement_rawlines($whitespace) - 1;
3284
3285 $suppress_whiletrailers{$line_nr_next +
3286 $offset} = 1;
3287 }
3288 }
3289 if (!defined $suppress_whiletrailers{$linenr} &&
3290 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003291 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003292
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003293 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003294 ERROR("ASSIGN_IN_IF",
3295 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003296 }
3297
3298 # Find out what is on the end of the line after the
3299 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003300 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003301 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003302 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003303 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3304 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003305 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003306 # Find out how long the conditional actually is.
3307 my @newlines = ($c =~ /\n/gs);
3308 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003309 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003310
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003311 $stat_real = raw_line($linenr, $cond_lines)
3312 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003313 if (defined($stat_real) && $cond_lines > 1) {
3314 $stat_real = "[...]\n$stat_real";
3315 }
3316
Joe Perches000d1cc12011-07-25 17:13:25 -07003317 ERROR("TRAILING_STATEMENTS",
3318 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003319 }
3320 }
3321
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003322# Check for bitwise tests written as boolean
3323 if ($line =~ /
3324 (?:
3325 (?:\[|\(|\&\&|\|\|)
3326 \s*0[xX][0-9]+\s*
3327 (?:\&\&|\|\|)
3328 |
3329 (?:\&\&|\|\|)
3330 \s*0[xX][0-9]+\s*
3331 (?:\&\&|\|\||\)|\])
3332 )/x)
3333 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003334 WARN("HEXADECIMAL_BOOLEAN_TEST",
3335 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003336 }
3337
Andy Whitcroft8905a672007-11-28 16:21:06 -08003338# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003339 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3340 my $s = $1;
3341 $s =~ s/$;//g; # Remove any comments
3342 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003343 ERROR("TRAILING_STATEMENTS",
3344 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003345 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003346 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003347# if should not continue a brace
3348 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003349 ERROR("TRAILING_STATEMENTS",
3350 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003351 $herecurr);
3352 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003353# case and default should not have general statements after them
3354 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3355 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003356 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003357 \s*return\s+
3358 )/xg)
3359 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003360 ERROR("TRAILING_STATEMENTS",
3361 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003362 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003363
3364 # Check for }<nl>else {, these must be at the same
3365 # indent level to be relevant to each other.
3366 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3367 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003368 ERROR("ELSE_AFTER_BRACE",
3369 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003370 }
3371
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003372 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3373 $previndent == $indent) {
3374 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3375
3376 # Find out what is on the end of the line after the
3377 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003378 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003379 $s =~ s/\n.*//g;
3380
3381 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003382 ERROR("WHILE_AFTER_BRACE",
3383 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003384 }
3385 }
3386
Joe Perches95e2c602013-07-03 15:05:20 -07003387#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003388 while ($line =~ m{($Constant|$Lval)}g) {
3389 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003390
3391#gcc binary extension
3392 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003393 if (WARN("GCC_BINARY_CONSTANT",
3394 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3395 $fix) {
3396 my $hexval = sprintf("0x%x", oct($var));
3397 $fixed[$linenr - 1] =~
3398 s/\b$var\b/$hexval/;
3399 }
Joe Perches95e2c602013-07-03 15:05:20 -07003400 }
3401
3402#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003403 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003404 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003405#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003406 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003407#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003408 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003409 while ($var =~ m{($Ident)}g) {
3410 my $word = $1;
3411 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08003412 if ($check) {
3413 seed_camelcase_includes();
3414 if (!$file && !$camelcase_file_seeded) {
3415 seed_camelcase_file($realfile);
3416 $camelcase_file_seeded = 1;
3417 }
3418 }
Joe Perches7e781f62013-09-11 14:23:55 -07003419 if (!defined $camelcase{$word}) {
3420 $camelcase{$word} = 1;
3421 CHK("CAMELCASE",
3422 "Avoid CamelCase: <$word>\n" . $herecurr);
3423 }
Joe Perches34456862013-07-03 15:05:34 -07003424 }
Joe Perches323c1262012-12-17 16:02:07 -08003425 }
3426 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003427
3428#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003429 if ($line =~ /\#\s*define.*\\\s+$/) {
3430 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3431 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3432 $fix) {
3433 $fixed[$linenr - 1] =~ s/\s+$//;
3434 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003435 }
3436
Andy Whitcroft653d4872007-06-23 17:16:34 -07003437#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003438 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003439 my $file = "$1.h";
3440 my $checkfile = "include/linux/$file";
3441 if (-f "$root/$checkfile" &&
3442 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003443 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003444 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003445 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003446 CHK("ARCH_INCLUDE_LINUX",
3447 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003448 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003449 WARN("INCLUDE_LINUX",
3450 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003451 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003452 }
3453 }
3454
Andy Whitcroft653d4872007-06-23 17:16:34 -07003455# multi-statement macros should be enclosed in a do while loop, grab the
3456# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003457# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07003458 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3459 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003460 my $ln = $linenr;
3461 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003462 my ($off, $dstat, $dcond, $rest);
3463 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003464 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003465 ctx_statement_block($linenr, $realcnt, 0);
3466 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003467 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003468 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003469
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003470 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003471 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003472 $dstat =~ s/\\\n.//g;
3473 $dstat =~ s/^\s*//s;
3474 $dstat =~ s/\s*$//s;
3475
3476 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003477 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3478 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003479 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003480 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003481 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003482
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003483 # Flatten any obvious string concatentation.
3484 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3485 $dstat =~ s/$Ident\s*("X*")/$1/)
3486 {
3487 }
3488
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003489 my $exceptions = qr{
3490 $Declare|
3491 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003492 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003493 DECLARE_PER_CPU|
3494 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003495 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003496 union|
3497 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003498 \.$Ident\s*=\s*|
3499 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003500 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003501 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003502 if ($dstat ne '' &&
3503 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3504 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07003505 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003506 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003507 $dstat !~ /$exceptions/ &&
3508 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003509 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003510 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003511 $dstat !~ /^for\s*$Constant$/ && # for (...)
3512 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3513 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07003514 $dstat !~ /^\({/ && # ({...
3515 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003516 {
3517 $ctx =~ s/\n*$//;
3518 my $herectx = $here . "\n";
3519 my $cnt = statement_rawlines($ctx);
3520
3521 for (my $n = 0; $n < $cnt; $n++) {
3522 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003523 }
3524
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003525 if ($dstat =~ /;/) {
3526 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3527 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3528 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003529 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003530 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003531 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003532 }
Joe Perches5023d342012-12-17 16:01:47 -08003533
Joe Perches481eb482012-12-17 16:01:56 -08003534# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003535
3536 } else {
3537 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003538 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3539 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003540 $line =~ /^\+.*\\$/) {
3541 WARN("LINE_CONTINUATIONS",
3542 "Avoid unnecessary line continuations\n" . $herecurr);
3543 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003544 }
3545
Joe Perchesb13edf72012-07-30 14:41:24 -07003546# do {} while (0) macro tests:
3547# single-statement macros do not need to be enclosed in do while (0) loop,
3548# macro should not end with a semicolon
3549 if ($^V && $^V ge 5.10.0 &&
3550 $realfile !~ m@/vmlinux.lds.h$@ &&
3551 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3552 my $ln = $linenr;
3553 my $cnt = $realcnt;
3554 my ($off, $dstat, $dcond, $rest);
3555 my $ctx = '';
3556 ($dstat, $dcond, $ln, $cnt, $off) =
3557 ctx_statement_block($linenr, $realcnt, 0);
3558 $ctx = $dstat;
3559
3560 $dstat =~ s/\\\n.//g;
3561
3562 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3563 my $stmts = $2;
3564 my $semis = $3;
3565
3566 $ctx =~ s/\n*$//;
3567 my $cnt = statement_rawlines($ctx);
3568 my $herectx = $here . "\n";
3569
3570 for (my $n = 0; $n < $cnt; $n++) {
3571 $herectx .= raw_line($linenr, $n) . "\n";
3572 }
3573
Joe Perchesac8e97f2012-08-21 16:15:53 -07003574 if (($stmts =~ tr/;/;/) == 1 &&
3575 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003576 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3577 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3578 }
3579 if (defined $semis && $semis ne "") {
3580 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3581 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3582 }
3583 }
3584 }
3585
Mike Frysinger080ba922009-01-06 14:41:25 -08003586# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3587# all assignments may have only one of the following with an assignment:
3588# .
3589# ALIGN(...)
3590# VMLINUX_SYMBOL(...)
3591 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003592 WARN("MISSING_VMLINUX_SYMBOL",
3593 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003594 }
3595
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003596# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003597 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3598 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003599 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003600 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003601 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3602 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003603 my @allowed = ();
3604 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003605 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003606 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003607 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003608 for my $chunk (@chunks) {
3609 my ($cond, $block) = @{$chunk};
3610
Andy Whitcroft773647a2008-03-28 14:15:58 -07003611 # If the condition carries leading newlines, then count those as offsets.
3612 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3613 my $offset = statement_rawlines($whitespace) - 1;
3614
Joe Perchesaad4f612012-03-23 15:02:19 -07003615 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003616 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3617
3618 # We have looked at and allowed this specific line.
3619 $suppress_ifbraces{$ln + $offset} = 1;
3620
3621 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003622 $ln += statement_rawlines($block) - 1;
3623
Andy Whitcroft773647a2008-03-28 14:15:58 -07003624 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003625
3626 $seen++ if ($block =~ /^\s*{/);
3627
Joe Perchesaad4f612012-03-23 15:02:19 -07003628 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003629 if (statement_lines($cond) > 1) {
3630 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003631 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003632 }
3633 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003634 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003635 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003636 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003637 if (statement_block_size($block) > 1) {
3638 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003639 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003640 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003641 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003642 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003643 if ($seen) {
3644 my $sum_allowed = 0;
3645 foreach (@allowed) {
3646 $sum_allowed += $_;
3647 }
3648 if ($sum_allowed == 0) {
3649 WARN("BRACES",
3650 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3651 } elsif ($sum_allowed != $allow &&
3652 $seen != $allow) {
3653 CHK("BRACES",
3654 "braces {} should be used on all arms of this statement\n" . $herectx);
3655 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003656 }
3657 }
3658 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003659 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003660 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003661 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003662
Andy Whitcroftcf655042008-03-04 14:28:20 -08003663 # Check the pre-context.
3664 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3665 #print "APW: ALLOWED: pre<$1>\n";
3666 $allowed = 1;
3667 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003668
3669 my ($level, $endln, @chunks) =
3670 ctx_statement_full($linenr, $realcnt, $-[0]);
3671
Andy Whitcroftcf655042008-03-04 14:28:20 -08003672 # Check the condition.
3673 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003674 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003675 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003676 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003677 }
3678 if (statement_lines($cond) > 1) {
3679 #print "APW: ALLOWED: cond<$cond>\n";
3680 $allowed = 1;
3681 }
3682 if ($block =~/\b(?:if|for|while)\b/) {
3683 #print "APW: ALLOWED: block<$block>\n";
3684 $allowed = 1;
3685 }
3686 if (statement_block_size($block) > 1) {
3687 #print "APW: ALLOWED: lines block<$block>\n";
3688 $allowed = 1;
3689 }
3690 # Check the post-context.
3691 if (defined $chunks[1]) {
3692 my ($cond, $block) = @{$chunks[1]};
3693 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003694 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003695 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003696 if ($block =~ /^\s*\{/) {
3697 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3698 $allowed = 1;
3699 }
3700 }
3701 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003702 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003703 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003704
Andy Whitcroftf0556632008-10-15 22:02:23 -07003705 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003706 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003707 }
3708
Joe Perches000d1cc12011-07-25 17:13:25 -07003709 WARN("BRACES",
3710 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003711 }
3712 }
3713
Joe Perches0979ae62012-12-17 16:01:59 -08003714# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07003715 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003716 CHK("BRACES",
3717 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3718 }
Joe Perches77b9a532013-07-03 15:05:29 -07003719 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003720 CHK("BRACES",
3721 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3722 }
3723
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003724# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003725 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3726 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003727 WARN("VOLATILE",
3728 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003729 }
3730
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003731# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003732 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003733 CHK("REDUNDANT_CODE",
3734 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003735 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003736 }
3737
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003738# check for needless "if (<foo>) fn(<foo>)" uses
3739 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3740 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3741 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3742 WARN('NEEDLESS_IF',
3743 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003744 }
3745 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003746
Joe Perches8716de32013-09-11 14:24:05 -07003747# check for bad placement of section $InitAttribute (e.g.: __initdata)
3748 if ($line =~ /(\b$InitAttribute\b)/) {
3749 my $attr = $1;
3750 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
3751 my $ptr = $1;
3752 my $var = $2;
3753 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
3754 ERROR("MISPLACED_INIT",
3755 "$attr should be placed after $var\n" . $herecurr)) ||
3756 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
3757 WARN("MISPLACED_INIT",
3758 "$attr should be placed after $var\n" . $herecurr))) &&
3759 $fix) {
3760 $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;
3761 }
3762 }
3763 }
3764
Joe Perchese970b8842013-11-12 15:10:10 -08003765# check for $InitAttributeData (ie: __initdata) with const
3766 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
3767 my $attr = $1;
3768 $attr =~ /($InitAttributePrefix)(.*)/;
3769 my $attr_prefix = $1;
3770 my $attr_type = $2;
3771 if (ERROR("INIT_ATTRIBUTE",
3772 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
3773 $fix) {
3774 $fixed[$linenr - 1] =~
3775 s/$InitAttributeData/${attr_prefix}initconst/;
3776 }
3777 }
3778
3779# check for $InitAttributeConst (ie: __initconst) without const
3780 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
3781 my $attr = $1;
3782 if (ERROR("INIT_ATTRIBUTE",
3783 "Use of $attr requires a separate use of const\n" . $herecurr) &&
3784 $fix) {
3785 my $lead = $fixed[$linenr - 1] =~
3786 /(^\+\s*(?:static\s+))/;
3787 $lead = rtrim($1);
3788 $lead = "$lead " if ($lead !~ /^\+$/);
3789 $lead = "${lead}const ";
3790 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
3791 }
3792 }
3793
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003794# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08003795 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003796 # ignore udelay's < 10, however
Bruce Allan37581c22013-02-21 16:44:19 -08003797 if (! ($1 < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003798 CHK("USLEEP_RANGE",
3799 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003800 }
3801 }
3802
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003803# warn about unexpectedly long msleep's
3804 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3805 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003806 WARN("MSLEEP",
3807 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003808 }
3809 }
3810
Joe Perches36ec1932013-07-03 15:05:25 -07003811# check for comparisons of jiffies
3812 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
3813 WARN("JIFFIES_COMPARISON",
3814 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
3815 }
3816
Joe Perches9d7a34a2013-07-03 15:05:26 -07003817# check for comparisons of get_jiffies_64()
3818 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
3819 WARN("JIFFIES_COMPARISON",
3820 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
3821 }
3822
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003823# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003824# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003825# print "#ifdef in C files should be avoided\n";
3826# print "$herecurr";
3827# $clean = 0;
3828# }
3829
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003830# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003831 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003832 if (ERROR("SPACING",
3833 "exactly one space required after that #$1\n" . $herecurr) &&
3834 $fix) {
3835 $fixed[$linenr - 1] =~
3836 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
3837 }
3838
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003839 }
3840
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003841# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003842 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3843 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003844 my $which = $1;
3845 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003846 CHK("UNCOMMENTED_DEFINITION",
3847 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003848 }
3849 }
3850# check for memory barriers without a comment.
3851 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3852 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003853 CHK("MEMORY_BARRIER",
3854 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003855 }
3856 }
3857# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003858 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003859 CHK("ARCH_DEFINES",
3860 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003861 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003862
Tobias Klauserd4977c72010-05-24 14:33:30 -07003863# Check that the storage class is at the beginning of a declaration
3864 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003865 WARN("STORAGE_CLASS",
3866 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07003867 }
3868
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003869# check the location of the inline attribute, that it is between
3870# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003871 if ($line =~ /\b$Type\s+$Inline\b/ ||
3872 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003873 ERROR("INLINE_LOCATION",
3874 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003875 }
3876
Andy Whitcroft8905a672007-11-28 16:21:06 -08003877# Check for __inline__ and __inline, prefer inline
3878 if ($line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003879 if (WARN("INLINE",
3880 "plain inline is preferred over $1\n" . $herecurr) &&
3881 $fix) {
3882 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
3883
3884 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003885 }
3886
Joe Perches3d130fd2011-01-12 17:00:00 -08003887# Check for __attribute__ packed, prefer __packed
3888 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003889 WARN("PREFER_PACKED",
3890 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08003891 }
3892
Joe Perches39b7e282011-07-25 17:13:24 -07003893# Check for __attribute__ aligned, prefer __aligned
3894 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003895 WARN("PREFER_ALIGNED",
3896 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07003897 }
3898
Joe Perches5f14d3b2012-01-10 15:09:52 -08003899# Check for __attribute__ format(printf, prefer __printf
3900 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003901 if (WARN("PREFER_PRINTF",
3902 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
3903 $fix) {
3904 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
3905
3906 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08003907 }
3908
Joe Perches6061d942012-03-23 15:02:16 -07003909# Check for __attribute__ format(scanf, prefer __scanf
3910 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003911 if (WARN("PREFER_SCANF",
3912 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
3913 $fix) {
3914 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
3915 }
Joe Perches6061d942012-03-23 15:02:16 -07003916 }
3917
Joe Perches8f53a9b2010-03-05 13:43:48 -08003918# check for sizeof(&)
3919 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003920 WARN("SIZEOF_ADDRESS",
3921 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08003922 }
3923
Joe Perches66c80b62012-07-30 14:41:22 -07003924# check for sizeof without parenthesis
3925 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003926 if (WARN("SIZEOF_PARENTHESIS",
3927 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
3928 $fix) {
3929 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
3930 }
Joe Perches66c80b62012-07-30 14:41:22 -07003931 }
3932
Joe Perches428e2fd2011-05-24 17:13:39 -07003933# check for line continuations in quoted strings with odd counts of "
3934 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003935 WARN("LINE_CONTINUATIONS",
3936 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07003937 }
3938
Joe Perches88982fe2012-12-17 16:02:00 -08003939# check for struct spinlock declarations
3940 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
3941 WARN("USE_SPINLOCK_T",
3942 "struct spinlock should be spinlock_t\n" . $herecurr);
3943 }
3944
Joe Perchesa6962d72013-04-29 16:18:13 -07003945# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08003946 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07003947 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08003948 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003949 if (WARN("PREFER_SEQ_PUTS",
3950 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
3951 $fix) {
3952 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
3953 }
Joe Perchesa6962d72013-04-29 16:18:13 -07003954 }
3955 }
3956
Andy Whitcroft554e1652012-01-10 15:09:57 -08003957# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003958 if ($^V && $^V ge 5.10.0 &&
3959 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003960 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08003961
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003962 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003963 my $ms_val = $7;
3964 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003965
Andy Whitcroft554e1652012-01-10 15:09:57 -08003966 if ($ms_size =~ /^(0x|)0$/i) {
3967 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003968 "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 -08003969 } elsif ($ms_size =~ /^(0x|)1$/i) {
3970 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003971 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3972 }
3973 }
3974
3975# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003976 if ($^V && $^V ge 5.10.0 &&
3977 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003978 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003979 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003980 my $call = $1;
3981 my $cast1 = deparenthesize($2);
3982 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003983 my $cast2 = deparenthesize($7);
3984 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003985 my $cast;
3986
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003987 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003988 $cast = "$cast1 or $cast2";
3989 } elsif ($cast1 ne "") {
3990 $cast = $cast1;
3991 } else {
3992 $cast = $cast2;
3993 }
3994 WARN("MINMAX",
3995 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08003996 }
3997 }
3998
Joe Perches4a273192012-07-30 14:41:20 -07003999# check usleep_range arguments
4000 if ($^V && $^V ge 5.10.0 &&
4001 defined $stat &&
4002 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4003 my $min = $1;
4004 my $max = $7;
4005 if ($min eq $max) {
4006 WARN("USLEEP_RANGE",
4007 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4008 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4009 $min > $max) {
4010 WARN("USLEEP_RANGE",
4011 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4012 }
4013 }
4014
Joe Perches70dc8a42013-09-11 14:23:58 -07004015# check for new externs in .h files.
4016 if ($realfile =~ /\.h$/ &&
4017 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004018 if (CHK("AVOID_EXTERNS",
4019 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004020 $fix) {
4021 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4022 }
4023 }
4024
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004025# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004026 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004027 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004028 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004029 my $function_name = $1;
4030 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004031
4032 my $s = $stat;
4033 if (defined $cond) {
4034 substr($s, 0, length($cond), '');
4035 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004036 if ($s =~ /^\s*;/ &&
4037 $function_name ne 'uninitialized_var')
4038 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004039 WARN("AVOID_EXTERNS",
4040 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004041 }
4042
4043 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004044 WARN("FUNCTION_ARGUMENTS",
4045 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004046 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004047
4048 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4049 $stat =~ /^.\s*extern\s+/)
4050 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004051 WARN("AVOID_EXTERNS",
4052 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004053 }
4054
4055# checks for new __setup's
4056 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4057 my $name = $1;
4058
4059 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004060 CHK("UNDOCUMENTED_SETUP",
4061 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004062 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004063 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004064
4065# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004066 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004067 WARN("UNNECESSARY_CASTS",
4068 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004069 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004070
Joe Perchesa640d252013-07-03 15:05:21 -07004071# alloc style
4072# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4073 if ($^V && $^V ge 5.10.0 &&
4074 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4075 CHK("ALLOC_SIZEOF_STRUCT",
4076 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4077 }
4078
Joe Perches972fdea2013-04-29 16:18:12 -07004079# check for krealloc arg reuse
4080 if ($^V && $^V ge 5.10.0 &&
4081 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4082 WARN("KREALLOC_ARG_REUSE",
4083 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4084 }
4085
Joe Perches5ce59ae2013-02-21 16:44:18 -08004086# check for alloc argument mismatch
4087 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4088 WARN("ALLOC_ARRAY_ARGS",
4089 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4090 }
4091
Joe Perchescaf2a542011-01-12 16:59:56 -08004092# check for multiple semicolons
4093 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004094 if (WARN("ONE_SEMICOLON",
4095 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4096 $fix) {
4097 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4098 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004099 }
4100
4101# check for switch/default statements without a break;
4102 if ($^V && $^V ge 5.10.0 &&
4103 defined $stat &&
4104 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4105 my $ctx = '';
4106 my $herectx = $here . "\n";
4107 my $cnt = statement_rawlines($stat);
4108 for (my $n = 0; $n < $cnt; $n++) {
4109 $herectx .= raw_line($linenr, $n) . "\n";
4110 }
4111 WARN("DEFAULT_NO_BREAK",
4112 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004113 }
4114
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004115# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004116 if ($line =~ /\b__FUNCTION__\b/) {
4117 if (WARN("USE_FUNC",
4118 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4119 $fix) {
4120 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4121 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004122 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004123
Joe Perches2c924882012-03-23 15:02:20 -07004124# check for use of yield()
4125 if ($line =~ /\byield\s*\(\s*\)/) {
4126 WARN("YIELD",
4127 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4128 }
4129
Joe Perches179f8f42013-07-03 15:05:30 -07004130# check for comparisons against true and false
4131 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4132 my $lead = $1;
4133 my $arg = $2;
4134 my $test = $3;
4135 my $otype = $4;
4136 my $trail = $5;
4137 my $op = "!";
4138
4139 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4140
4141 my $type = lc($otype);
4142 if ($type =~ /^(?:true|false)$/) {
4143 if (("$test" eq "==" && "$type" eq "true") ||
4144 ("$test" eq "!=" && "$type" eq "false")) {
4145 $op = "";
4146 }
4147
4148 CHK("BOOL_COMPARISON",
4149 "Using comparison to $otype is error prone\n" . $herecurr);
4150
4151## maybe suggesting a correct construct would better
4152## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4153
4154 }
4155 }
4156
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004157# check for semaphores initialized locked
4158 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004159 WARN("CONSIDER_COMPLETION",
4160 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004161 }
Joe Perches6712d852012-03-23 15:02:20 -07004162
Joe Perches67d0a072011-10-31 17:13:10 -07004163# recommend kstrto* over simple_strto* and strict_strto*
4164 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004165 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004166 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004167 }
Joe Perches6712d852012-03-23 15:02:20 -07004168
Michael Ellermanf3db6632008-07-23 21:28:57 -07004169# check for __initcall(), use device_initcall() explicitly please
4170 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004171 WARN("USE_DEVICE_INITCALL",
4172 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07004173 }
Joe Perches6712d852012-03-23 15:02:20 -07004174
Emese Revfy79404842010-03-05 13:43:53 -08004175# check for various ops structs, ensure they are const.
4176 my $struct_ops = qr{acpi_dock_ops|
4177 address_space_operations|
4178 backlight_ops|
4179 block_device_operations|
4180 dentry_operations|
4181 dev_pm_ops|
4182 dma_map_ops|
4183 extent_io_ops|
4184 file_lock_operations|
4185 file_operations|
4186 hv_ops|
4187 ide_dma_ops|
4188 intel_dvo_dev_ops|
4189 item_operations|
4190 iwl_ops|
4191 kgdb_arch|
4192 kgdb_io|
4193 kset_uevent_ops|
4194 lock_manager_operations|
4195 microcode_ops|
4196 mtrr_ops|
4197 neigh_ops|
4198 nlmsvc_binding|
4199 pci_raw_ops|
4200 pipe_buf_operations|
4201 platform_hibernation_ops|
4202 platform_suspend_ops|
4203 proto_ops|
4204 rpc_pipe_ops|
4205 seq_operations|
4206 snd_ac97_build_ops|
4207 soc_pcmcia_socket_ops|
4208 stacktrace_ops|
4209 sysfs_ops|
4210 tty_operations|
4211 usb_mon_operations|
4212 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004213 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004214 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004215 WARN("CONST_STRUCT",
4216 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004217 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004218 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004219
4220# use of NR_CPUS is usually wrong
4221# ignore definitions of NR_CPUS and usage to define arrays as likely right
4222 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004223 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4224 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004225 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4226 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4227 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004228 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004229 WARN("NR_CPUS",
4230 "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 -07004231 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004232
Joe Perches52ea8502013-11-12 15:10:09 -08004233# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4234 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4235 ERROR("DEFINE_ARCH_HAS",
4236 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4237 }
4238
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004239# check for %L{u,d,i} in strings
4240 my $string;
4241 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4242 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004243 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004244 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004245 WARN("PRINTF_L",
4246 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004247 last;
4248 }
4249 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004250
4251# whine mightly about in_atomic
4252 if ($line =~ /\bin_atomic\s*\(/) {
4253 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004254 ERROR("IN_ATOMIC",
4255 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004256 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004257 WARN("IN_ATOMIC",
4258 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004259 }
4260 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004261
4262# check for lockdep_set_novalidate_class
4263 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4264 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4265 if ($realfile !~ m@^kernel/lockdep@ &&
4266 $realfile !~ m@^include/linux/lockdep@ &&
4267 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004268 ERROR("LOCKDEP",
4269 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004270 }
4271 }
Dave Jones88f88312011-01-12 16:59:59 -08004272
4273 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4274 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004275 WARN("EXPORTED_WORLD_WRITABLE",
4276 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004277 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004278 }
4279
4280 # If we have no input at all, then there is nothing to report on
4281 # so just keep quiet.
4282 if ($#rawlines == -1) {
4283 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004284 }
4285
Andy Whitcroft8905a672007-11-28 16:21:06 -08004286 # In mailback mode only produce a report in the negative, for
4287 # things that appear to be patches.
4288 if ($mailback && ($clean == 1 || !$is_patch)) {
4289 exit(0);
4290 }
4291
4292 # This is not a patch, and we are are in 'no-patch' mode so
4293 # just keep quiet.
4294 if (!$chk_patch && !$is_patch) {
4295 exit(0);
4296 }
4297
4298 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004299 ERROR("NOT_UNIFIED_DIFF",
4300 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004301 }
4302 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004303 ERROR("MISSING_SIGN_OFF",
4304 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004305 }
4306
Andy Whitcroft8905a672007-11-28 16:21:06 -08004307 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004308 if ($summary && !($clean == 1 && $quiet == 1)) {
4309 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004310 print "total: $cnt_error errors, $cnt_warn warnings, " .
4311 (($check)? "$cnt_chk checks, " : "") .
4312 "$cnt_lines lines checked\n";
4313 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004314 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004315
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004316 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004317
4318 if ($^V lt 5.10.0) {
4319 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4320 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4321 }
4322
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004323 # If there were whitespace errors which cleanpatch can fix
4324 # then suggest that.
4325 if ($rpt_cleaners) {
4326 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4327 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07004328 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004329 }
4330 }
4331
Joe Perches91bfe482013-09-11 14:23:59 -07004332 hash_show_words(\%use_type, "Used");
4333 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07004334
Joe Perches3705ce52013-07-03 15:05:31 -07004335 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
4336 my $newfile = $filename . ".EXPERIMENTAL-checkpatch-fixes";
4337 my $linecount = 0;
4338 my $f;
4339
4340 open($f, '>', $newfile)
4341 or die "$P: Can't open $newfile for write\n";
4342 foreach my $fixed_line (@fixed) {
4343 $linecount++;
4344 if ($file) {
4345 if ($linecount > 3) {
4346 $fixed_line =~ s/^\+//;
4347 print $f $fixed_line. "\n";
4348 }
4349 } else {
4350 print $f $fixed_line . "\n";
4351 }
4352 }
4353 close($f);
4354
4355 if (!$quiet) {
4356 print << "EOM";
4357Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4358
4359Do _NOT_ trust the results written to this file.
4360Do _NOT_ submit these changes without inspecting them for correctness.
4361
4362This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4363No warranties, expressed or implied...
4364
4365EOM
4366 }
4367 }
4368
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004369 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004370 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004371 }
4372 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004373 print << "EOM";
4374$vname has style problems, please review.
4375
4376If any of these errors are false positives, please report
4377them to the maintainer, see CHECKPATCH in MAINTAINERS.
4378EOM
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004379 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004380
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004381 return $clean;
4382}