blob: f0ea8a037a6dc0f61230587a50abaadcd95662aa [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;
Joe Perches9624b8d2014-01-23 15:54:44 -080032my $fix_inplace = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070033my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080034my %debug;
Joe Perches34456862013-07-03 15:05:34 -070035my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070036my %use_type = ();
37my @use = ();
38my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070039my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070040my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070041my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080042my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070043my $ignore_perl_version = 0;
44my $minimum_perl_version = 5.10.0;
Hannes Eder77f5b102009-09-21 17:04:37 -070045
46sub help {
47 my ($exitcode) = @_;
48
49 print << "EOM";
50Usage: $P [OPTION]... [FILE]...
51Version: $V
52
53Options:
54 -q, --quiet quiet
55 --no-tree run without a kernel tree
56 --no-signoff do not check for 'Signed-off-by' line
57 --patch treat FILE as patchfile (default)
58 --emacs emacs compile window format
59 --terse one line per report
60 -f, --file treat FILE as regular source file
61 --subjective, --strict enable more subjective tests
Joe Perches91bfe482013-09-11 14:23:59 -070062 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070063 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080064 --max-line-length=n set the maximum line length, if exceeded, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070065 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070066 --root=PATH PATH to the kernel tree root
67 --no-summary suppress the per-file summary
68 --mailback only produce a report in case of warnings/errors
69 --summary-file include the filename in summary
70 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
71 'values', 'possible', 'type', and 'attr' (default
72 is all off)
73 --test-only=WORD report only warnings/errors containing WORD
74 literally
Joe Perches3705ce52013-07-03 15:05:31 -070075 --fix EXPERIMENTAL - may create horrible results
76 If correctable single-line errors exist, create
77 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
78 with potential errors corrected to the preferred
79 checkpatch style
Joe Perches9624b8d2014-01-23 15:54:44 -080080 --fix-inplace EXPERIMENTAL - may create horrible results
81 Is the same as --fix, but overwrites the input
82 file. It's your fault if there's no backup or git
Dave Hansend62a2012013-09-11 14:23:56 -070083 --ignore-perl-version override checking of perl version. expect
84 runtime errors.
Hannes Eder77f5b102009-09-21 17:04:37 -070085 -h, --help, --version display this help and exit
86
87When FILE is - read standard input.
88EOM
89
90 exit($exitcode);
91}
92
Joe Perches000d1cc12011-07-25 17:13:25 -070093my $conf = which_conf($configuration_file);
94if (-f $conf) {
95 my @conf_args;
96 open(my $conffile, '<', "$conf")
97 or warn "$P: Can't find a readable $configuration_file file $!\n";
98
99 while (<$conffile>) {
100 my $line = $_;
101
102 $line =~ s/\s*\n?$//g;
103 $line =~ s/^\s*//g;
104 $line =~ s/\s+/ /g;
105
106 next if ($line =~ m/^\s*#/);
107 next if ($line =~ m/^\s*$/);
108
109 my @words = split(" ", $line);
110 foreach my $word (@words) {
111 last if ($word =~ m/^#/);
112 push (@conf_args, $word);
113 }
114 }
115 close($conffile);
116 unshift(@ARGV, @conf_args) if @conf_args;
117}
118
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700119GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700120 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700121 'tree!' => \$tree,
122 'signoff!' => \$chk_signoff,
123 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700124 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800125 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700126 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700127 'subjective!' => \$check,
128 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700129 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700130 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700131 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800132 'max-line-length=i' => \$max_line_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700133 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800134 'summary!' => \$summary,
135 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800136 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700137 'fix!' => \$fix,
Joe Perches9624b8d2014-01-23 15:54:44 -0800138 'fix-inplace!' => \$fix_inplace,
Dave Hansend62a2012013-09-11 14:23:56 -0700139 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800140 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700141 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700142 'h|help' => \$help,
143 'version' => \$help
144) or help(1);
145
146help(0) if ($help);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700147
Joe Perches9624b8d2014-01-23 15:54:44 -0800148$fix = 1 if ($fix_inplace);
149
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700150my $exit = 0;
151
Dave Hansend62a2012013-09-11 14:23:56 -0700152if ($^V && $^V lt $minimum_perl_version) {
153 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
154 if (!$ignore_perl_version) {
155 exit(1);
156 }
157}
158
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700159if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700160 print "$P: no input files\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700161 exit(1);
162}
163
Joe Perches91bfe482013-09-11 14:23:59 -0700164sub hash_save_array_words {
165 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700166
Joe Perches91bfe482013-09-11 14:23:59 -0700167 my @array = split(/,/, join(',', @$arrayRef));
168 foreach my $word (@array) {
169 $word =~ s/\s*\n?$//g;
170 $word =~ s/^\s*//g;
171 $word =~ s/\s+/ /g;
172 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700173
Joe Perches91bfe482013-09-11 14:23:59 -0700174 next if ($word =~ m/^\s*#/);
175 next if ($word =~ m/^\s*$/);
176
177 $hashRef->{$word}++;
178 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700179}
180
Joe Perches91bfe482013-09-11 14:23:59 -0700181sub hash_show_words {
182 my ($hashRef, $prefix) = @_;
183
Joe Perches58cb3cf2013-09-11 14:24:04 -0700184 if ($quiet == 0 && keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700185 print "NOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700186 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700187 print " $word";
188 }
189 print "\n\n";
190 }
191}
192
193hash_save_array_words(\%ignore_type, \@ignore);
194hash_save_array_words(\%use_type, \@use);
195
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800196my $dbg_values = 0;
197my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700198my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700199my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800200for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800201 ## no critic
202 eval "\${dbg_$key} = '$debug{$key}';";
203 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800204}
205
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700206my $rpt_cleaners = 0;
207
Andy Whitcroft8905a672007-11-28 16:21:06 -0800208if ($terse) {
209 $emacs = 1;
210 $quiet++;
211}
212
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700213if ($tree) {
214 if (defined $root) {
215 if (!top_of_kernel_tree($root)) {
216 die "$P: $root: --root does not point at a valid tree\n";
217 }
218 } else {
219 if (top_of_kernel_tree('.')) {
220 $root = '.';
221 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
222 top_of_kernel_tree($1)) {
223 $root = $1;
224 }
225 }
226
227 if (!defined $root) {
228 print "Must be run from the top-level dir. of a kernel tree\n";
229 exit(2);
230 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700231}
232
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700233my $emitted_corrupt = 0;
234
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700235our $Ident = qr{
236 [A-Za-z_][A-Za-z\d_]*
237 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
238 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700239our $Storage = qr{extern|static|asmlinkage};
240our $Sparse = qr{
241 __user|
242 __kernel|
243 __force|
244 __iomem|
245 __must_check|
246 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800247 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700248 __ref|
249 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700250 }x;
Joe Perchese970b8842013-11-12 15:10:10 -0800251our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)};
252our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)};
253our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)};
254our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)};
255our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit};
Joe Perches8716de32013-09-11 14:24:05 -0700256
Wolfram Sang52131292010-03-05 13:43:51 -0800257# Notes to $Attribute:
258# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700259our $Attribute = qr{
260 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700261 __percpu|
262 __nocast|
263 __safe|
264 __bitwise__|
265 __packed__|
266 __packed2__|
267 __naked|
268 __maybe_unused|
269 __always_unused|
270 __noreturn|
271 __used|
272 __cold|
273 __noclone|
274 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700275 __read_mostly|
276 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700277 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700278 ____cacheline_aligned|
279 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800280 ____cacheline_internodealigned_in_smp|
281 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700282 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700283our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700284our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700285our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
286our $Lval = qr{$Ident(?:$Member)*};
287
Joe Perches95e2c602013-07-03 15:05:20 -0700288our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
289our $Binary = qr{(?i)0b[01]+$Int_type?};
290our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
291our $Int = qr{[0-9]+$Int_type?};
Joe Perches24358802014-04-03 14:49:13 -0700292our $Octal = qr{0[0-7]+$Int_type?};
Joe Perches326b1ff2013-02-04 14:28:51 -0800293our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
294our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
295our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800296our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches24358802014-04-03 14:49:13 -0700297our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800298our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Joe Perches447432f2014-04-03 14:49:17 -0700299our $Compare = qr{<=|>=|==|!=|<|(?<!-)>};
Joe Perches23f780c2013-07-03 15:05:31 -0700300our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700301our $Operators = qr{
302 <=|>=|==|!=|
303 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700304 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700305 }x;
306
Andy Whitcroft8905a672007-11-28 16:21:06 -0800307our $NonptrType;
Joe Perches8716de32013-09-11 14:24:05 -0700308our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800309our $Type;
310our $Declare;
311
Joe Perches15662b32011-10-31 17:13:12 -0700312our $NON_ASCII_UTF8 = qr{
313 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700314 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
315 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
316 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
317 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
318 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
319 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
320}x;
321
Joe Perches15662b32011-10-31 17:13:12 -0700322our $UTF8 = qr{
323 [\x09\x0A\x0D\x20-\x7E] # ASCII
324 | $NON_ASCII_UTF8
325}x;
326
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700327our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700328 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700329 atomic_t
330)};
331
Joe Perches691e6692010-03-05 13:43:51 -0800332our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700333 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700334 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
Joe Perches6e60c022011-07-25 17:13:27 -0700335 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700336 panic|
Joe Perches06668722013-11-12 15:10:07 -0800337 MODULE_[A-Z_]+|
338 seq_vprintf|seq_printf|seq_puts
Joe Perches691e6692010-03-05 13:43:51 -0800339)};
340
Joe Perches20112472011-07-25 17:13:23 -0700341our $signature_tags = qr{(?xi:
342 Signed-off-by:|
343 Acked-by:|
344 Tested-by:|
345 Reviewed-by:|
346 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700347 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700348 To:|
349 Cc:
350)};
351
Andy Whitcroft8905a672007-11-28 16:21:06 -0800352our @typeList = (
353 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700354 qr{(?:unsigned\s+)?char},
355 qr{(?:unsigned\s+)?short},
356 qr{(?:unsigned\s+)?int},
357 qr{(?:unsigned\s+)?long},
358 qr{(?:unsigned\s+)?long\s+int},
359 qr{(?:unsigned\s+)?long\s+long},
360 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800361 qr{unsigned},
362 qr{float},
363 qr{double},
364 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800365 qr{struct\s+$Ident},
366 qr{union\s+$Ident},
367 qr{enum\s+$Ident},
368 qr{${Ident}_t},
369 qr{${Ident}_handler},
370 qr{${Ident}_handler_fn},
371);
Joe Perches8716de32013-09-11 14:24:05 -0700372our @typeListWithAttr = (
373 @typeList,
374 qr{struct\s+$InitAttribute\s+$Ident},
375 qr{union\s+$InitAttribute\s+$Ident},
376);
377
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700378our @modifierList = (
379 qr{fastcall},
380);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800381
Joe Perches24358802014-04-03 14:49:13 -0700382our @mode_permission_funcs = (
383 ["module_param", 3],
384 ["module_param_(?:array|named|string)", 4],
385 ["module_param_array_named", 5],
386 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
387 ["proc_create(?:_data|)", 2],
388 ["(?:CLASS|DEVICE|SENSOR)_ATTR", 2],
389);
390
Wolfram Sang7840a942010-08-09 17:20:57 -0700391our $allowed_asm_includes = qr{(?x:
392 irq|
393 memory
394)};
395# memory.h: ARM has a custom one
396
Andy Whitcroft8905a672007-11-28 16:21:06 -0800397sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700398 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
399 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700400 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700401 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800402 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700403 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800404 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800405 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700406 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700407 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800408 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700409 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800410 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700411 $NonptrTypeWithAttr = qr{
412 (?:$Modifier\s+|const\s+)*
413 (?:
414 (?:typeof|__typeof__)\s*\([^\)]*\)|
415 (?:$typeTypedefs\b)|
416 (?:${allWithAttr}\b)
417 )
418 (?:\s+$Modifier|\s+const)*
419 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800420 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700421 $NonptrType
Andy Whitcroftb337d8b2012-03-23 15:02:18 -0700422 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700423 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800424 }x;
425 $Declare = qr{(?:$Storage\s+)?$Type};
426}
427build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700428
Joe Perches7d2367a2011-07-25 17:13:22 -0700429our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700430
431# Using $balanced_parens, $LvalOrFunc, or $FuncArg
432# requires at least perl version v5.10.0
433# Any use must be runtime checked with $^V
434
435our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
Joe Perches24358802014-04-03 14:49:13 -0700436our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800437our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700438
439sub deparenthesize {
440 my ($string) = @_;
441 return "" if (!defined($string));
Joe Perches5b9553a2014-04-03 14:49:21 -0700442
443 while ($string =~ /^\s*\(.*\)\s*$/) {
444 $string =~ s@^\s*\(\s*@@;
445 $string =~ s@\s*\)\s*$@@;
446 }
447
Joe Perches7d2367a2011-07-25 17:13:22 -0700448 $string =~ s@\s+@ @g;
Joe Perches5b9553a2014-04-03 14:49:21 -0700449
Joe Perches7d2367a2011-07-25 17:13:22 -0700450 return $string;
451}
452
Joe Perches34456862013-07-03 15:05:34 -0700453sub seed_camelcase_file {
454 my ($file) = @_;
455
456 return if (!(-f $file));
457
458 local $/;
459
460 open(my $include_file, '<', "$file")
461 or warn "$P: Can't read '$file' $!\n";
462 my $text = <$include_file>;
463 close($include_file);
464
465 my @lines = split('\n', $text);
466
467 foreach my $line (@lines) {
468 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
469 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
470 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800471 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
472 $camelcase{$1} = 1;
473 } 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 -0700474 $camelcase{$1} = 1;
475 }
476 }
477}
478
479my $camelcase_seeded = 0;
480sub seed_camelcase_includes {
481 return if ($camelcase_seeded);
482
483 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700484 my $camelcase_cache = "";
485 my @include_files = ();
486
487 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700488
Richard Genoud3645e322014-02-10 14:25:32 -0800489 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700490 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
491 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700492 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700493 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700494 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700495 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700496 @include_files = split('\n', $files);
497 foreach my $file (@include_files) {
498 my $date = POSIX::strftime("%Y%m%d%H%M",
499 localtime((stat $file)[9]));
500 $last_mod_date = $date if ($last_mod_date < $date);
501 }
502 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700503 }
Joe Perchesc707a812013-07-08 16:00:43 -0700504
505 if ($camelcase_cache ne "" && -f $camelcase_cache) {
506 open(my $camelcase_file, '<', "$camelcase_cache")
507 or warn "$P: Can't read '$camelcase_cache' $!\n";
508 while (<$camelcase_file>) {
509 chomp;
510 $camelcase{$_} = 1;
511 }
512 close($camelcase_file);
513
514 return;
515 }
516
Richard Genoud3645e322014-02-10 14:25:32 -0800517 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700518 $files = `git ls-files "include/*.h"`;
519 @include_files = split('\n', $files);
520 }
521
Joe Perches34456862013-07-03 15:05:34 -0700522 foreach my $file (@include_files) {
523 seed_camelcase_file($file);
524 }
Joe Perches351b2a12013-07-03 15:05:36 -0700525
Joe Perchesc707a812013-07-08 16:00:43 -0700526 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700527 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700528 open(my $camelcase_file, '>', "$camelcase_cache")
529 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700530 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
531 print $camelcase_file ("$_\n");
532 }
533 close($camelcase_file);
534 }
Joe Perches34456862013-07-03 15:05:34 -0700535}
536
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700537$chk_signoff = 0 if ($file);
538
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700539my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800540my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700541my @fixed = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800542my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700543for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800544 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700545 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800546 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700547 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800548 } elsif ($filename eq '-') {
549 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700550 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800551 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700552 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700553 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800554 if ($filename eq '-') {
555 $vname = 'Your patch';
556 } else {
557 $vname = $filename;
558 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800559 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700560 chomp;
561 push(@rawlines, $_);
562 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800563 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800564 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700565 $exit = 1;
566 }
567 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800568 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700569 @fixed = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700570}
571
572exit($exit);
573
574sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700575 my ($root) = @_;
576
577 my @tree_check = (
578 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
579 "README", "Documentation", "arch", "include", "drivers",
580 "fs", "init", "ipc", "kernel", "lib", "scripts",
581 );
582
583 foreach my $check (@tree_check) {
584 if (! -e $root . '/' . $check) {
585 return 0;
586 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700587 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700588 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700589}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700590
Joe Perches20112472011-07-25 17:13:23 -0700591sub parse_email {
592 my ($formatted_email) = @_;
593
594 my $name = "";
595 my $address = "";
596 my $comment = "";
597
598 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
599 $name = $1;
600 $address = $2;
601 $comment = $3 if defined $3;
602 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
603 $address = $1;
604 $comment = $2 if defined $2;
605 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
606 $address = $1;
607 $comment = $2 if defined $2;
608 $formatted_email =~ s/$address.*$//;
609 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700610 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700611 $name =~ s/^\"|\"$//g;
612 # If there's a name left after stripping spaces and
613 # leading quotes, and the address doesn't have both
614 # leading and trailing angle brackets, the address
615 # is invalid. ie:
616 # "joe smith joe@smith.com" bad
617 # "joe smith <joe@smith.com" bad
618 if ($name ne "" && $address !~ /^<[^>]+>$/) {
619 $name = "";
620 $address = "";
621 $comment = "";
622 }
623 }
624
Joe Perches3705ce52013-07-03 15:05:31 -0700625 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700626 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700627 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700628 $address =~ s/^\<|\>$//g;
629
630 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
631 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
632 $name = "\"$name\"";
633 }
634
635 return ($name, $address, $comment);
636}
637
638sub format_email {
639 my ($name, $address) = @_;
640
641 my $formatted_email;
642
Joe Perches3705ce52013-07-03 15:05:31 -0700643 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700644 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700645 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700646
647 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
648 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
649 $name = "\"$name\"";
650 }
651
652 if ("$name" eq "") {
653 $formatted_email = "$address";
654 } else {
655 $formatted_email = "$name <$address>";
656 }
657
658 return $formatted_email;
659}
660
Joe Perches000d1cc12011-07-25 17:13:25 -0700661sub which_conf {
662 my ($conf) = @_;
663
664 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
665 if (-e "$path/$conf") {
666 return "$path/$conf";
667 }
668 }
669
670 return "";
671}
672
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700673sub expand_tabs {
674 my ($str) = @_;
675
676 my $res = '';
677 my $n = 0;
678 for my $c (split(//, $str)) {
679 if ($c eq "\t") {
680 $res .= ' ';
681 $n++;
682 for (; ($n % 8) != 0; $n++) {
683 $res .= ' ';
684 }
685 next;
686 }
687 $res .= $c;
688 $n++;
689 }
690
691 return $res;
692}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700693sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700694 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700695 return $res;
696}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700697
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700698sub line_stats {
699 my ($line) = @_;
700
701 # Drop the diff line leader and expand tabs
702 $line =~ s/^.//;
703 $line = expand_tabs($line);
704
705 # Pick the indent from the front of the line.
706 my ($white) = ($line =~ /^(\s*)/);
707
708 return (length($line), length($white));
709}
710
Andy Whitcroft773647a2008-03-28 14:15:58 -0700711my $sanitise_quote = '';
712
713sub sanitise_line_reset {
714 my ($in_comment) = @_;
715
716 if ($in_comment) {
717 $sanitise_quote = '*/';
718 } else {
719 $sanitise_quote = '';
720 }
721}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700722sub sanitise_line {
723 my ($line) = @_;
724
725 my $res = '';
726 my $l = '';
727
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800728 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700729 my $off = 0;
730 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700731
Andy Whitcroft773647a2008-03-28 14:15:58 -0700732 # Always copy over the diff marker.
733 $res = substr($line, 0, 1);
734
735 for ($off = 1; $off < length($line); $off++) {
736 $c = substr($line, $off, 1);
737
738 # Comments we are wacking completly including the begin
739 # and end, all to $;.
740 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
741 $sanitise_quote = '*/';
742
743 substr($res, $off, 2, "$;$;");
744 $off++;
745 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800746 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700747 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700748 $sanitise_quote = '';
749 substr($res, $off, 2, "$;$;");
750 $off++;
751 next;
752 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700753 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
754 $sanitise_quote = '//';
755
756 substr($res, $off, 2, $sanitise_quote);
757 $off++;
758 next;
759 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700760
761 # A \ in a string means ignore the next character.
762 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
763 $c eq "\\") {
764 substr($res, $off, 2, 'XX');
765 $off++;
766 next;
767 }
768 # Regular quotes.
769 if ($c eq "'" || $c eq '"') {
770 if ($sanitise_quote eq '') {
771 $sanitise_quote = $c;
772
773 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700774 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700775 } elsif ($sanitise_quote eq $c) {
776 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700777 }
778 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700779
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800780 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700781 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
782 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700783 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
784 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700785 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
786 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700787 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700788 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700789 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800790 }
791
Daniel Walker113f04a2009-09-21 17:04:35 -0700792 if ($sanitise_quote eq '//') {
793 $sanitise_quote = '';
794 }
795
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800796 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700797 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800798 my $clean = 'X' x length($1);
799 $res =~ s@\<.*\>@<$clean>@;
800
801 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700802 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800803 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700804 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800805 }
806
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700807 return $res;
808}
809
Joe Perchesa6962d72013-04-29 16:18:13 -0700810sub get_quoted_string {
811 my ($line, $rawline) = @_;
812
813 return "" if ($line !~ m/(\"[X]+\")/g);
814 return substr($rawline, $-[0], $+[0] - $-[0]);
815}
816
Andy Whitcroft8905a672007-11-28 16:21:06 -0800817sub ctx_statement_block {
818 my ($linenr, $remain, $off) = @_;
819 my $line = $linenr - 1;
820 my $blk = '';
821 my $soff = $off;
822 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700823 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800824
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800825 my $loff = 0;
826
Andy Whitcroft8905a672007-11-28 16:21:06 -0800827 my $type = '';
828 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800829 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800830 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800831 my $c;
832 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800833
834 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800835 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800836 @stack = (['', 0]) if ($#stack == -1);
837
Andy Whitcroft773647a2008-03-28 14:15:58 -0700838 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800839 # If we are about to drop off the end, pull in more
840 # context.
841 if ($off >= $len) {
842 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700843 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800844 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800845 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800846 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800847 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800848 $len = length($blk);
849 $line++;
850 last;
851 }
852 # Bail if there is no further context.
853 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800854 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800855 last;
856 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800857 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
858 $level++;
859 $type = '#';
860 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800861 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800862 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800863 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800864 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800865
Andy Whitcroft773647a2008-03-28 14:15:58 -0700866 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800867
868 # Handle nested #if/#else.
869 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
870 push(@stack, [ $type, $level ]);
871 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
872 ($type, $level) = @{$stack[$#stack - 1]};
873 } elsif ($remainder =~ /^#\s*endif\b/) {
874 ($type, $level) = @{pop(@stack)};
875 }
876
Andy Whitcroft8905a672007-11-28 16:21:06 -0800877 # Statement ends at the ';' or a close '}' at the
878 # outermost level.
879 if ($level == 0 && $c eq ';') {
880 last;
881 }
882
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800883 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700884 if ($level == 0 && $coff_set == 0 &&
885 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
886 $remainder =~ /^(else)(?:\s|{)/ &&
887 $remainder !~ /^else\s+if\b/) {
888 $coff = $off + length($1) - 1;
889 $coff_set = 1;
890 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
891 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800892 }
893
Andy Whitcroft8905a672007-11-28 16:21:06 -0800894 if (($type eq '' || $type eq '(') && $c eq '(') {
895 $level++;
896 $type = '(';
897 }
898 if ($type eq '(' && $c eq ')') {
899 $level--;
900 $type = ($level != 0)? '(' : '';
901
902 if ($level == 0 && $coff < $soff) {
903 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700904 $coff_set = 1;
905 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800906 }
907 }
908 if (($type eq '' || $type eq '{') && $c eq '{') {
909 $level++;
910 $type = '{';
911 }
912 if ($type eq '{' && $c eq '}') {
913 $level--;
914 $type = ($level != 0)? '{' : '';
915
916 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700917 if (substr($blk, $off + 1, 1) eq ';') {
918 $off++;
919 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800920 last;
921 }
922 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800923 # Preprocessor commands end at the newline unless escaped.
924 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
925 $level--;
926 $type = '';
927 $off++;
928 last;
929 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800930 $off++;
931 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700932 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800933 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700934 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800935 $line++;
936 $remain--;
937 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800938
939 my $statement = substr($blk, $soff, $off - $soff + 1);
940 my $condition = substr($blk, $soff, $coff - $soff + 1);
941
942 #warn "STATEMENT<$statement>\n";
943 #warn "CONDITION<$condition>\n";
944
Andy Whitcroft773647a2008-03-28 14:15:58 -0700945 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800946
947 return ($statement, $condition,
948 $line, $remain + 1, $off - $loff + 1, $level);
949}
950
Andy Whitcroftcf655042008-03-04 14:28:20 -0800951sub statement_lines {
952 my ($stmt) = @_;
953
954 # Strip the diff line prefixes and rip blank lines at start and end.
955 $stmt =~ s/(^|\n)./$1/g;
956 $stmt =~ s/^\s*//;
957 $stmt =~ s/\s*$//;
958
959 my @stmt_lines = ($stmt =~ /\n/g);
960
961 return $#stmt_lines + 2;
962}
963
964sub statement_rawlines {
965 my ($stmt) = @_;
966
967 my @stmt_lines = ($stmt =~ /\n/g);
968
969 return $#stmt_lines + 2;
970}
971
972sub statement_block_size {
973 my ($stmt) = @_;
974
975 $stmt =~ s/(^|\n)./$1/g;
976 $stmt =~ s/^\s*{//;
977 $stmt =~ s/}\s*$//;
978 $stmt =~ s/^\s*//;
979 $stmt =~ s/\s*$//;
980
981 my @stmt_lines = ($stmt =~ /\n/g);
982 my @stmt_statements = ($stmt =~ /;/g);
983
984 my $stmt_lines = $#stmt_lines + 2;
985 my $stmt_statements = $#stmt_statements + 1;
986
987 if ($stmt_lines > $stmt_statements) {
988 return $stmt_lines;
989 } else {
990 return $stmt_statements;
991 }
992}
993
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800994sub ctx_statement_full {
995 my ($linenr, $remain, $off) = @_;
996 my ($statement, $condition, $level);
997
998 my (@chunks);
999
Andy Whitcroftcf655042008-03-04 14:28:20 -08001000 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001001 ($statement, $condition, $linenr, $remain, $off, $level) =
1002 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001003 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08001004 push(@chunks, [ $condition, $statement ]);
1005 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1006 return ($level, $linenr, @chunks);
1007 }
1008
1009 # Pull in the following conditional/block pairs and see if they
1010 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001011 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001012 ($statement, $condition, $linenr, $remain, $off, $level) =
1013 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001014 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001015 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001016 #print "C: push\n";
1017 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001018 }
1019
1020 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001021}
1022
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001023sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001024 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001025 my $line;
1026 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001027 my $blk = '';
1028 my @o;
1029 my @c;
1030 my @res = ();
1031
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001032 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001033 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001034 for ($line = $start; $remain > 0; $line++) {
1035 next if ($rawlines[$line] =~ /^-/);
1036 $remain--;
1037
1038 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001039
1040 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001041 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001042 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001043 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001044 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001045 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001046 $level = pop(@stack);
1047 }
1048
Andy Whitcroft01464f32010-10-26 14:23:19 -07001049 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001050 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1051 if ($off > 0) {
1052 $off--;
1053 next;
1054 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001055
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001056 if ($c eq $close && $level > 0) {
1057 $level--;
1058 last if ($level == 0);
1059 } elsif ($c eq $open) {
1060 $level++;
1061 }
1062 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001063
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001064 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001065 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001066 }
1067
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001068 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001069 }
1070
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001071 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001072}
1073sub ctx_block_outer {
1074 my ($linenr, $remain) = @_;
1075
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001076 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1077 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001078}
1079sub ctx_block {
1080 my ($linenr, $remain) = @_;
1081
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001082 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1083 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001084}
1085sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001086 my ($linenr, $remain, $off) = @_;
1087
1088 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1089 return @r;
1090}
1091sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001092 my ($linenr, $remain) = @_;
1093
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001094 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001095}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001096sub ctx_statement_level {
1097 my ($linenr, $remain, $off) = @_;
1098
1099 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1100}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001101
1102sub ctx_locate_comment {
1103 my ($first_line, $end_line) = @_;
1104
1105 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001106 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001107 return $current_comment if (defined $current_comment);
1108
1109 # Look through the context and try and figure out if there is a
1110 # comment.
1111 my $in_comment = 0;
1112 $current_comment = '';
1113 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001114 my $line = $rawlines[$linenr - 1];
1115 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001116 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1117 $in_comment = 1;
1118 }
1119 if ($line =~ m@/\*@) {
1120 $in_comment = 1;
1121 }
1122 if (!$in_comment && $current_comment ne '') {
1123 $current_comment = '';
1124 }
1125 $current_comment .= $line . "\n" if ($in_comment);
1126 if ($line =~ m@\*/@) {
1127 $in_comment = 0;
1128 }
1129 }
1130
1131 chomp($current_comment);
1132 return($current_comment);
1133}
1134sub ctx_has_comment {
1135 my ($first_line, $end_line) = @_;
1136 my $cmt = ctx_locate_comment($first_line, $end_line);
1137
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001138 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001139 ##print "CMMT: $cmt\n";
1140
1141 return ($cmt ne '');
1142}
1143
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001144sub raw_line {
1145 my ($linenr, $cnt) = @_;
1146
1147 my $offset = $linenr - 1;
1148 $cnt++;
1149
1150 my $line;
1151 while ($cnt) {
1152 $line = $rawlines[$offset++];
1153 next if (defined($line) && $line =~ /^-/);
1154 $cnt--;
1155 }
1156
1157 return $line;
1158}
1159
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001160sub cat_vet {
1161 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001162 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001163
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001164 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001165 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1166 $res .= $1;
1167 if ($2 ne '') {
1168 $coded = sprintf("^%c", unpack('C', $2) + 64);
1169 $res .= $coded;
1170 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001171 }
1172 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001173
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001174 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001175}
1176
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001177my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001178my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001179my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001180my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001181
1182sub annotate_reset {
1183 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001184 $av_pending = '_';
1185 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001186 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001187}
1188
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001189sub annotate_values {
1190 my ($stream, $type) = @_;
1191
1192 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001193 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001194 my $cur = $stream;
1195
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001196 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001197
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001198 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001199 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001200 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001201 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001202 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001203 print "WS($1)\n" if ($dbg_values > 1);
1204 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001205 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001206 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001207 }
1208
Florian Micklerc023e4732011-01-12 16:59:58 -08001209 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001210 print "CAST($1)\n" if ($dbg_values > 1);
1211 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001212 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001213
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001214 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001215 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001216 $type = 'T';
1217
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001218 } elsif ($cur =~ /^($Modifier)\s*/) {
1219 print "MODIFIER($1)\n" if ($dbg_values > 1);
1220 $type = 'T';
1221
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001222 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001223 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001224 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001225 push(@av_paren_type, $type);
1226 if ($2 ne '') {
1227 $av_pending = 'N';
1228 }
1229 $type = 'E';
1230
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001231 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001232 print "UNDEF($1)\n" if ($dbg_values > 1);
1233 $av_preprocessor = 1;
1234 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001235
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001236 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001237 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001238 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001239
1240 push(@av_paren_type, $type);
1241 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001242 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001243
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001244 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001245 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1246 $av_preprocessor = 1;
1247
1248 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1249
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001250 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001251
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001252 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001253 print "PRE_END($1)\n" if ($dbg_values > 1);
1254
1255 $av_preprocessor = 1;
1256
1257 # Assume all arms of the conditional end as this
1258 # one does, and continue as if the #endif was not here.
1259 pop(@av_paren_type);
1260 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001261 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001262
1263 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001264 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001265
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001266 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1267 print "ATTR($1)\n" if ($dbg_values > 1);
1268 $av_pending = $type;
1269 $type = 'N';
1270
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001271 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001272 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001273 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001274 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001275 }
1276 $type = 'N';
1277
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001278 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001279 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001280 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001281 $type = 'N';
1282
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001283 } elsif ($cur =~/^(case)/o) {
1284 print "CASE($1)\n" if ($dbg_values > 1);
1285 $av_pend_colon = 'C';
1286 $type = 'N';
1287
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001288 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001289 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001290 $type = 'N';
1291
1292 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001293 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001294 push(@av_paren_type, $av_pending);
1295 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001296 $type = 'N';
1297
1298 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001299 my $new_type = pop(@av_paren_type);
1300 if ($new_type ne '_') {
1301 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001302 print "PAREN('$1') -> $type\n"
1303 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001304 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001305 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001306 }
1307
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001308 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001309 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001310 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001311 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001312
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001313 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1314 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001315 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001316 } elsif ($type eq 'E') {
1317 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001318 }
1319 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1320 $type = 'V';
1321
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001322 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001323 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001324 $type = 'V';
1325
1326 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001327 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001328 $type = 'N';
1329
Andy Whitcroftcf655042008-03-04 14:28:20 -08001330 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001331 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001332 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001333 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001334
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001335 } elsif ($cur =~/^(,)/) {
1336 print "COMMA($1)\n" if ($dbg_values > 1);
1337 $type = 'C';
1338
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001339 } elsif ($cur =~ /^(\?)/o) {
1340 print "QUESTION($1)\n" if ($dbg_values > 1);
1341 $type = 'N';
1342
1343 } elsif ($cur =~ /^(:)/o) {
1344 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1345
1346 substr($var, length($res), 1, $av_pend_colon);
1347 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1348 $type = 'E';
1349 } else {
1350 $type = 'N';
1351 }
1352 $av_pend_colon = 'O';
1353
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001354 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001355 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001356 $type = 'N';
1357
Andy Whitcroft0d413862008-10-15 22:02:16 -07001358 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001359 my $variant;
1360
1361 print "OPV($1)\n" if ($dbg_values > 1);
1362 if ($type eq 'V') {
1363 $variant = 'B';
1364 } else {
1365 $variant = 'U';
1366 }
1367
1368 substr($var, length($res), 1, $variant);
1369 $type = 'N';
1370
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001371 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001372 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001373 if ($1 ne '++' && $1 ne '--') {
1374 $type = 'N';
1375 }
1376
1377 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001378 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001379 }
1380 if (defined $1) {
1381 $cur = substr($cur, length($1));
1382 $res .= $type x length($1);
1383 }
1384 }
1385
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001386 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001387}
1388
Andy Whitcroft8905a672007-11-28 16:21:06 -08001389sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001390 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001391 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001392 ^(?:
1393 $Modifier|
1394 $Storage|
1395 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001396 DEFINE_\S+
1397 )$|
1398 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001399 goto|
1400 return|
1401 case|
1402 else|
1403 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001404 do|
1405 \#|
1406 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001407 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001408 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001409 )}x;
1410 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1411 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001412 # Check for modifiers.
1413 $possible =~ s/\s*$Storage\s*//g;
1414 $possible =~ s/\s*$Sparse\s*//g;
1415 if ($possible =~ /^\s*$/) {
1416
1417 } elsif ($possible =~ /\s/) {
1418 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001419 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001420 if ($modifier !~ $notPermitted) {
1421 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1422 push(@modifierList, $modifier);
1423 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001424 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001425
1426 } else {
1427 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1428 push(@typeList, $possible);
1429 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001430 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001431 } else {
1432 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001433 }
1434}
1435
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001436my $prefix = '';
1437
Joe Perches000d1cc12011-07-25 17:13:25 -07001438sub show_type {
Joe Perchescbec18a2014-04-03 14:49:19 -07001439 my ($type) = @_;
Joe Perches91bfe482013-09-11 14:23:59 -07001440
Joe Perchescbec18a2014-04-03 14:49:19 -07001441 return defined $use_type{$type} if (scalar keys %use_type > 0);
1442
1443 return !defined $ignore_type{$type};
Joe Perches000d1cc12011-07-25 17:13:25 -07001444}
1445
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001446sub report {
Joe Perchescbec18a2014-04-03 14:49:19 -07001447 my ($level, $type, $msg) = @_;
1448
1449 if (!show_type($type) ||
1450 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001451 return 0;
1452 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001453 my $line;
1454 if ($show_types) {
Joe Perchescbec18a2014-04-03 14:49:19 -07001455 $line = "$prefix$level:$type: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001456 } else {
Joe Perchescbec18a2014-04-03 14:49:19 -07001457 $line = "$prefix$level: $msg\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001458 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001459 $line = (split('\n', $line))[0] . "\n" if ($terse);
1460
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001461 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001462
1463 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001464}
Joe Perchescbec18a2014-04-03 14:49:19 -07001465
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001466sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001467 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001468}
Joe Perches000d1cc12011-07-25 17:13:25 -07001469
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001470sub ERROR {
Joe Perchescbec18a2014-04-03 14:49:19 -07001471 my ($type, $msg) = @_;
1472
1473 if (report("ERROR", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001474 our $clean = 0;
1475 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001476 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001477 }
Joe Perches3705ce52013-07-03 15:05:31 -07001478 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001479}
1480sub WARN {
Joe Perchescbec18a2014-04-03 14:49:19 -07001481 my ($type, $msg) = @_;
1482
1483 if (report("WARNING", $type, $msg)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001484 our $clean = 0;
1485 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001486 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001487 }
Joe Perches3705ce52013-07-03 15:05:31 -07001488 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001489}
1490sub CHK {
Joe Perchescbec18a2014-04-03 14:49:19 -07001491 my ($type, $msg) = @_;
1492
1493 if ($check && report("CHECK", $type, $msg)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001494 our $clean = 0;
1495 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001496 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001497 }
Joe Perches3705ce52013-07-03 15:05:31 -07001498 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001499}
1500
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001501sub check_absolute_file {
1502 my ($absolute, $herecurr) = @_;
1503 my $file = $absolute;
1504
1505 ##print "absolute<$absolute>\n";
1506
1507 # See if any suffix of this path is a path within the tree.
1508 while ($file =~ s@^[^/]*/@@) {
1509 if (-f "$root/$file") {
1510 ##print "file<$file>\n";
1511 last;
1512 }
1513 }
1514 if (! -f _) {
1515 return 0;
1516 }
1517
1518 # It is, so see if the prefix is acceptable.
1519 my $prefix = $absolute;
1520 substr($prefix, -length($file)) = '';
1521
1522 ##print "prefix<$prefix>\n";
1523 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001524 WARN("USE_RELATIVE_PATH",
1525 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001526 }
1527}
1528
Joe Perches3705ce52013-07-03 15:05:31 -07001529sub trim {
1530 my ($string) = @_;
1531
Joe Perchesb34c6482013-09-11 14:24:01 -07001532 $string =~ s/^\s+|\s+$//g;
1533
1534 return $string;
1535}
1536
1537sub ltrim {
1538 my ($string) = @_;
1539
1540 $string =~ s/^\s+//;
1541
1542 return $string;
1543}
1544
1545sub rtrim {
1546 my ($string) = @_;
1547
1548 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001549
1550 return $string;
1551}
1552
Joe Perches52ea8502013-11-12 15:10:09 -08001553sub string_find_replace {
1554 my ($string, $find, $replace) = @_;
1555
1556 $string =~ s/$find/$replace/g;
1557
1558 return $string;
1559}
1560
Joe Perches3705ce52013-07-03 15:05:31 -07001561sub tabify {
1562 my ($leading) = @_;
1563
1564 my $source_indent = 8;
1565 my $max_spaces_before_tab = $source_indent - 1;
1566 my $spaces_to_tab = " " x $source_indent;
1567
1568 #convert leading spaces to tabs
1569 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1570 #Remove spaces before a tab
1571 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1572
1573 return "$leading";
1574}
1575
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001576sub pos_last_openparen {
1577 my ($line) = @_;
1578
1579 my $pos = 0;
1580
1581 my $opens = $line =~ tr/\(/\(/;
1582 my $closes = $line =~ tr/\)/\)/;
1583
1584 my $last_openparen = 0;
1585
1586 if (($opens == 0) || ($closes >= $opens)) {
1587 return -1;
1588 }
1589
1590 my $len = length($line);
1591
1592 for ($pos = 0; $pos < $len; $pos++) {
1593 my $string = substr($line, $pos);
1594 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1595 $pos += length($1) - 1;
1596 } elsif (substr($line, $pos, 1) eq '(') {
1597 $last_openparen = $pos;
1598 } elsif (index($string, '(') == -1) {
1599 last;
1600 }
1601 }
1602
1603 return $last_openparen + 1;
1604}
1605
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001606sub process {
1607 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001608
1609 my $linenr=0;
1610 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001611 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001612 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001613 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001614
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001615 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001616 my $indent;
1617 my $previndent=0;
1618 my $stashindent=0;
1619
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001620 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001621 my $signoff = 0;
1622 my $is_patch = 0;
1623
Joe Perches15662b32011-10-31 17:13:12 -07001624 my $in_header_lines = 1;
1625 my $in_commit_log = 0; #Scanning lines before patch
1626
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001627 my $non_utf8_charset = 0;
1628
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001629 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001630 our $cnt_lines = 0;
1631 our $cnt_error = 0;
1632 our $cnt_warn = 0;
1633 our $cnt_chk = 0;
1634
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001635 # Trace the real file/line as we go.
1636 my $realfile = '';
1637 my $realline = 0;
1638 my $realcnt = 0;
1639 my $here = '';
1640 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001641 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001642 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001643 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001644
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001645 my $prev_values = 'E';
1646
1647 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001648 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001649 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001650 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001651 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001652
Joe Perches7e51f192013-09-11 14:23:57 -07001653 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001654
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001655 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001656 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001657 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001658 my @setup_docs = ();
1659 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001660
Joe Perchesd8b07712013-11-12 15:10:06 -08001661 my $camelcase_file_seeded = 0;
1662
Andy Whitcroft773647a2008-03-28 14:15:58 -07001663 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001664 my $line;
1665 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001666 $linenr++;
1667 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001668
Joe Perches3705ce52013-07-03 15:05:31 -07001669 push(@fixed, $rawline) if ($fix);
1670
Andy Whitcroft773647a2008-03-28 14:15:58 -07001671 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001672 $setup_docs = 0;
1673 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1674 $setup_docs = 1;
1675 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001676 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001677 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001678 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1679 $realline=$1-1;
1680 if (defined $2) {
1681 $realcnt=$3+1;
1682 } else {
1683 $realcnt=1+1;
1684 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001685 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001686
1687 # Guestimate if this is a continuing comment. Run
1688 # the context looking for a comment "edge". If this
1689 # edge is a close comment then we must be in a comment
1690 # at context start.
1691 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001692 my $cnt = $realcnt;
1693 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1694 next if (defined $rawlines[$ln - 1] &&
1695 $rawlines[$ln - 1] =~ /^-/);
1696 $cnt--;
1697 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001698 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001699 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1700 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1701 ($edge) = $1;
1702 last;
1703 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001704 }
1705 if (defined $edge && $edge eq '*/') {
1706 $in_comment = 1;
1707 }
1708
1709 # Guestimate if this is a continuing comment. If this
1710 # is the start of a diff block and this line starts
1711 # ' *' then it is very likely a comment.
1712 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001713 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001714 {
1715 $in_comment = 1;
1716 }
1717
1718 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1719 sanitise_line_reset($in_comment);
1720
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001721 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001722 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001723 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001724 $line = sanitise_line($rawline);
1725 }
1726 push(@lines, $line);
1727
1728 if ($realcnt > 1) {
1729 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1730 } else {
1731 $realcnt = 0;
1732 }
1733
1734 #print "==>$rawline\n";
1735 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001736
1737 if ($setup_docs && $line =~ /^\+/) {
1738 push(@setup_docs, $line);
1739 }
1740 }
1741
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001742 $prefix = '';
1743
Andy Whitcroft773647a2008-03-28 14:15:58 -07001744 $realcnt = 0;
1745 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001746 foreach my $line (@lines) {
1747 $linenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001748 my $sline = $line; #copy of $line
1749 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001750
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001751 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001752
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001753#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001754 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001755 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001756 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001757 $realline=$1-1;
1758 if (defined $2) {
1759 $realcnt=$3+1;
1760 } else {
1761 $realcnt=1+1;
1762 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001763 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001764 $prev_values = 'E';
1765
Andy Whitcroft773647a2008-03-28 14:15:58 -07001766 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001767 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001768 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001769 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001770 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001771
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001772# track the line number as we move through the hunk, note that
1773# new versions of GNU diff omit the leading space on completely
1774# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001775 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001776 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001777 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001778
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001779 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001780 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001781
1782 # Track the previous line.
1783 ($prevline, $stashline) = ($stashline, $line);
1784 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001785 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1786
Andy Whitcroft773647a2008-03-28 14:15:58 -07001787 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001788
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001789 } elsif ($realcnt == 1) {
1790 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001791 }
1792
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001793 my $hunk_line = ($realcnt != 0);
1794
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001795#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001796 $prefix = "$filename:$realline: " if ($emacs && $file);
1797 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1798
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001799 $here = "#$linenr: " if (!$file);
1800 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001801
1802 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001803 if ($line =~ /^diff --git.*?(\S+)$/) {
1804 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001805 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001806 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001807 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001808 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001809 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001810 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001811
1812 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001813 if (!$file && $tree && $p1_prefix ne '' &&
1814 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001815 WARN("PATCH_PREFIX",
1816 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001817 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001818
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001819 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001820 ERROR("MODIFIED_INCLUDE_ASM",
1821 "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 -07001822 }
1823 next;
1824 }
1825
Randy Dunlap389834b2007-06-08 13:47:03 -07001826 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001827
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001828 my $hereline = "$here\n$rawline\n";
1829 my $herecurr = "$here\n$rawline\n";
1830 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001831
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001832 $cnt_lines++ if ($realcnt != 0);
1833
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001834# Check for incorrect file permissions
1835 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1836 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001837 if ($realfile !~ m@scripts/@ &&
1838 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001839 ERROR("EXECUTE_PERMISSIONS",
1840 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001841 }
1842 }
1843
Joe Perches20112472011-07-25 17:13:23 -07001844# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001845 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001846 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001847 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001848 }
1849
1850# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001851 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001852 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001853 my $space_before = $1;
1854 my $sign_off = $2;
1855 my $space_after = $3;
1856 my $email = $4;
1857 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1858
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001859 if ($sign_off !~ /$signature_tags/) {
1860 WARN("BAD_SIGN_OFF",
1861 "Non-standard signature: $sign_off\n" . $herecurr);
1862 }
Joe Perches20112472011-07-25 17:13:23 -07001863 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07001864 if (WARN("BAD_SIGN_OFF",
1865 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1866 $fix) {
1867 $fixed[$linenr - 1] =
1868 "$ucfirst_sign_off $email";
1869 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001870 }
Joe Perches20112472011-07-25 17:13:23 -07001871 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07001872 if (WARN("BAD_SIGN_OFF",
1873 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1874 $fix) {
1875 $fixed[$linenr - 1] =
1876 "$ucfirst_sign_off $email";
1877 }
1878
Joe Perches20112472011-07-25 17:13:23 -07001879 }
1880 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07001881 if (WARN("BAD_SIGN_OFF",
1882 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1883 $fix) {
1884 $fixed[$linenr - 1] =
1885 "$ucfirst_sign_off $email";
1886 }
Joe Perches20112472011-07-25 17:13:23 -07001887 }
1888
1889 my ($email_name, $email_address, $comment) = parse_email($email);
1890 my $suggested_email = format_email(($email_name, $email_address));
1891 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001892 ERROR("BAD_SIGN_OFF",
1893 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001894 } else {
1895 my $dequoted = $suggested_email;
1896 $dequoted =~ s/^"//;
1897 $dequoted =~ s/" </ </;
1898 # Don't force email to have quotes
1899 # Allow just an angle bracketed address
1900 if ("$dequoted$comment" ne $email &&
1901 "<$email_address>$comment" ne $email &&
1902 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001903 WARN("BAD_SIGN_OFF",
1904 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001905 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001906 }
Joe Perches7e51f192013-09-11 14:23:57 -07001907
1908# Check for duplicate signatures
1909 my $sig_nospace = $line;
1910 $sig_nospace =~ s/\s//g;
1911 $sig_nospace = lc($sig_nospace);
1912 if (defined $signatures{$sig_nospace}) {
1913 WARN("BAD_SIGN_OFF",
1914 "Duplicate signature\n" . $herecurr);
1915 } else {
1916 $signatures{$sig_nospace} = 1;
1917 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001918 }
1919
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001920# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001921 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001922 ERROR("CORRUPTED_PATCH",
1923 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001924 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001925 }
1926
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001927# Check for absolute kernel paths.
1928 if ($tree) {
1929 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1930 my $file = $1;
1931
1932 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1933 check_absolute_file($1, $herecurr)) {
1934 #
1935 } else {
1936 check_absolute_file($file, $herecurr);
1937 }
1938 }
1939 }
1940
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001941# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1942 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001943 $rawline !~ m/^$UTF8*$/) {
1944 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1945
1946 my $blank = copy_spacing($rawline);
1947 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1948 my $hereptr = "$hereline$ptr\n";
1949
Joe Perches34d99212011-07-25 17:13:26 -07001950 CHK("INVALID_UTF8",
1951 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001952 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001953
Joe Perches15662b32011-10-31 17:13:12 -07001954# Check if it's the start of a commit log
1955# (not a header line and we haven't seen the patch filename)
1956 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001957 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001958 $in_header_lines = 0;
1959 $in_commit_log = 1;
1960 }
1961
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001962# Check if there is UTF-8 in a commit log when a mail header has explicitly
1963# declined it, i.e defined some charset where it is missing.
1964 if ($in_header_lines &&
1965 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1966 $1 !~ /utf-8/i) {
1967 $non_utf8_charset = 1;
1968 }
1969
1970 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001971 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001972 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001973 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1974 }
1975
Andy Whitcroft306708542008-10-15 22:02:28 -07001976# ignore non-hunk lines and lines being removed
1977 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001978
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001979#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001980 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001981 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07001982 if (ERROR("DOS_LINE_ENDINGS",
1983 "DOS line endings\n" . $herevet) &&
1984 $fix) {
1985 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
1986 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001987 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1988 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07001989 if (ERROR("TRAILING_WHITESPACE",
1990 "trailing whitespace\n" . $herevet) &&
1991 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07001992 $fixed[$linenr - 1] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001993 }
1994
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001995 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001996 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07001997
Josh Triplett4783f892013-11-12 15:10:12 -08001998# Check for FSF mailing addresses.
Alexander Duyck109d8cb22014-01-23 15:54:50 -08001999 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08002000 $rawline =~ /\b59\s+Temple\s+Pl/i ||
2001 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08002002 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
2003 my $msg_type = \&ERROR;
2004 $msg_type = \&CHK if ($file);
2005 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08002006 "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet)
Josh Triplett4783f892013-11-12 15:10:12 -08002007 }
2008
Andi Kleen33549572010-05-24 14:33:29 -07002009# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002010# Only applies when adding the entry originally, after that we do not have
2011# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07002012 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08002013 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07002014 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002015 my $cnt = $realcnt;
2016 my $ln = $linenr + 1;
2017 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002018 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002019 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002020 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002021 $f = $lines[$ln - 1];
2022 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2023 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002024
2025 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002026
2027 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
2028 $is_start = 1;
2029 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
2030 $length = -1;
2031 }
2032
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002033 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002034 $f =~ s/#.*//;
2035 $f =~ s/^\s+//;
2036 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002037 if ($f =~ /^\s*config\s/) {
2038 $is_end = 1;
2039 last;
2040 }
Andi Kleen33549572010-05-24 14:33:29 -07002041 $length++;
2042 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002043 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08002044 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2045 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002046 }
2047
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002048# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2049 if ($realfile =~ /Kconfig/ &&
2050 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2051 WARN("CONFIG_EXPERIMENTAL",
2052 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2053 }
2054
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002055 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2056 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2057 my $flag = $1;
2058 my $replacement = {
2059 'EXTRA_AFLAGS' => 'asflags-y',
2060 'EXTRA_CFLAGS' => 'ccflags-y',
2061 'EXTRA_CPPFLAGS' => 'cppflags-y',
2062 'EXTRA_LDFLAGS' => 'ldflags-y',
2063 };
2064
2065 WARN("DEPRECATED_VARIABLE",
2066 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2067 }
2068
Rob Herringbff5da42014-01-23 15:54:51 -08002069# check for DT compatible documentation
2070 if (defined $root && $realfile =~ /\.dts/ &&
2071 $rawline =~ /^\+\s*compatible\s*=/) {
2072 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2073
2074 foreach my $compat (@compats) {
2075 my $compat2 = $compat;
2076 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2077 $compat2 =~ s/\,[a-z]*\-/\,<\.\*>\-/;
2078 `grep -Erq "$compat|$compat2" $dt_path`;
2079 if ( $? >> 8 ) {
2080 WARN("UNDOCUMENTED_DT_STRING",
2081 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2082 }
2083
2084 my $vendor = $compat;
2085 my $vendor_path = $dt_path . "vendor-prefixes.txt";
2086 next if (! -f $vendor_path);
2087 $vendor =~ s/^([a-zA-Z0-9]+)\,.*/$1/;
2088 `grep -Eq "$vendor" $vendor_path`;
2089 if ( $? >> 8 ) {
2090 WARN("UNDOCUMENTED_DT_STRING",
2091 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vendor_path\n" . $herecurr);
2092 }
2093 }
2094 }
2095
Andy Whitcroft5368df202008-10-15 22:02:27 -07002096# check we are in a valid source file if not then ignore this hunk
2097 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2098
Joe Perches6cd7f382012-12-17 16:01:54 -08002099#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002100 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002101 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002102 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002103 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002104 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002105 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002106 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002107 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002108 }
2109
Josh Triplettca56dc02012-03-23 15:02:21 -07002110# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002111# to grep for the string. Make exceptions when the previous string ends in a
2112# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2113# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002114 if ($line =~ /^\+\s*"/ &&
2115 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002116 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002117 WARN("SPLIT_STRING",
2118 "quoted string split across lines\n" . $hereprev);
2119 }
2120
Joe Perches5e79d962010-03-05 13:43:55 -08002121# check for spaces before a quoted newline
2122 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002123 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2124 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2125 $fix) {
2126 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2127 }
2128
Joe Perches5e79d962010-03-05 13:43:55 -08002129 }
2130
Andy Whitcroft8905a672007-11-28 16:21:06 -08002131# check for adding lines without a newline.
2132 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002133 WARN("MISSING_EOF_NEWLINE",
2134 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002135 }
2136
Mike Frysinger42e41c52009-09-21 17:04:40 -07002137# Blackfin: use hi/lo macros
2138 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2139 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2140 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002141 ERROR("LO_MACRO",
2142 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002143 }
2144 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2145 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002146 ERROR("HI_MACRO",
2147 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002148 }
2149 }
2150
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002151# check we are in a valid source file C or perl if not then ignore this hunk
2152 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002153
2154# at the beginning of a line any tabs must come first and anything
2155# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002156 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2157 $rawline =~ /^\+\s* \s*/) {
2158 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002159 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002160 if (ERROR("CODE_INDENT",
2161 "code indent should use tabs where possible\n" . $herevet) &&
2162 $fix) {
2163 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2164 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002165 }
2166
Alberto Panizzo08e44362010-03-05 13:43:54 -08002167# check for space before tabs.
2168 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2169 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002170 if (WARN("SPACE_BEFORE_TAB",
2171 "please, no space before tabs\n" . $herevet) &&
2172 $fix) {
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002173 while ($fixed[$linenr - 1] =~
2174 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2175 while ($fixed[$linenr - 1] =~
2176 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002177 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002178 }
2179
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002180# check for && or || at the start of a line
2181 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2182 CHK("LOGICAL_CONTINUATIONS",
2183 "Logical continuations should be on the previous line\n" . $hereprev);
2184 }
2185
2186# check multi-line statement indentation matches previous line
2187 if ($^V && $^V ge 5.10.0 &&
2188 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
2189 $prevline =~ /^\+(\t*)(.*)$/;
2190 my $oldindent = $1;
2191 my $rest = $2;
2192
2193 my $pos = pos_last_openparen($rest);
2194 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002195 $line =~ /^(\+| )([ \t]*)/;
2196 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002197
2198 my $goodtabindent = $oldindent .
2199 "\t" x ($pos / 8) .
2200 " " x ($pos % 8);
2201 my $goodspaceindent = $oldindent . " " x $pos;
2202
2203 if ($newindent ne $goodtabindent &&
2204 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002205
2206 if (CHK("PARENTHESIS_ALIGNMENT",
2207 "Alignment should match open parenthesis\n" . $hereprev) &&
2208 $fix && $line =~ /^\+/) {
2209 $fixed[$linenr - 1] =~
2210 s/^\+[ \t]*/\+$goodtabindent/;
2211 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002212 }
2213 }
2214 }
2215
Joe Perches23f780c2013-07-03 15:05:31 -07002216 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002217 if (CHK("SPACING",
2218 "No space is necessary after a cast\n" . $hereprev) &&
2219 $fix) {
2220 $fixed[$linenr - 1] =~
2221 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2222 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002223 }
2224
Joe Perches05880602012-10-04 17:13:35 -07002225 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002226 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
Joe Perches85ad9782014-04-03 14:49:20 -07002227 $rawline =~ /^\+[ \t]*\*/ &&
2228 $realline > 2) {
Joe Perches05880602012-10-04 17:13:35 -07002229 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2230 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2231 }
2232
2233 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002234 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2235 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002236 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002237 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2238 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2239 "networking block comments start with * on subsequent lines\n" . $hereprev);
2240 }
2241
2242 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002243 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2244 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2245 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2246 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002247 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2248 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2249 }
2250
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002251# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002252# Exceptions:
2253# 1) within comments
2254# 2) indented preprocessor commands
2255# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002256 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002257 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002258 if (WARN("LEADING_SPACE",
2259 "please, no spaces at the start of a line\n" . $herevet) &&
2260 $fix) {
2261 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2262 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002263 }
2264
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002265# check we are in a valid C source file if not then ignore this hunk
2266 next if ($realfile !~ /\.(h|c)$/);
2267
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002268# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2269 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2270 WARN("CONFIG_EXPERIMENTAL",
2271 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2272 }
2273
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002274# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002275 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002276 WARN("CVS_KEYWORD",
2277 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002278 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002279
Mike Frysinger42e41c52009-09-21 17:04:40 -07002280# Blackfin: don't use __builtin_bfin_[cs]sync
2281 if ($line =~ /__builtin_bfin_csync/) {
2282 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002283 ERROR("CSYNC",
2284 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002285 }
2286 if ($line =~ /__builtin_bfin_ssync/) {
2287 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002288 ERROR("SSYNC",
2289 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002290 }
2291
Joe Perches56e77d72013-02-21 16:44:14 -08002292# check for old HOTPLUG __dev<foo> section markings
2293 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2294 WARN("HOTPLUG_SECTION",
2295 "Using $1 is unnecessary\n" . $herecurr);
2296 }
2297
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002298# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002299 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2300 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002301#print "LINE<$line>\n";
2302 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002303 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002304 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002305 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002306 $stat =~ s/\n./\n /g;
2307 $cond =~ s/\n./\n /g;
2308
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002309#print "linenr<$linenr> <$stat>\n";
2310 # If this statement has no statement boundaries within
2311 # it there is no point in retrying a statement scan
2312 # until we hit end of it.
2313 my $frag = $stat; $frag =~ s/;+\s*$//;
2314 if ($frag !~ /(?:{|;)/) {
2315#print "skip<$line_nr_next>\n";
2316 $suppress_statement = $line_nr_next;
2317 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002318
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002319 # Find the real next line.
2320 $realline_next = $line_nr_next;
2321 if (defined $realline_next &&
2322 (!defined $lines[$realline_next - 1] ||
2323 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2324 $realline_next++;
2325 }
2326
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002327 my $s = $stat;
2328 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002329
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002330 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002331 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002332
2333 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002334 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002335
Andy Whitcroft463f2862009-09-21 17:04:34 -07002336 } elsif ($s =~ /^.\s*else\b/s) {
2337
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002338 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002339 } 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 -07002340 my $type = $1;
2341 $type =~ s/\s+/ /g;
2342 possible($type, "A:" . $s);
2343
Andy Whitcroft8905a672007-11-28 16:21:06 -08002344 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002345 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002346 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002347 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002348
2349 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002350 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002351 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002352 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002353
2354 # Check for any sort of function declaration.
2355 # int foo(something bar, other baz);
2356 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002357 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 -08002358 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002359
Andy Whitcroftcf655042008-03-04 14:28:20 -08002360 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002361 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002362 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002363
Andy Whitcroft8905a672007-11-28 16:21:06 -08002364 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002365 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002366
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002367 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002368 }
2369 }
2370 }
2371
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002372 }
2373
Andy Whitcroft653d4872007-06-23 17:16:34 -07002374#
2375# Checks which may be anchored in the context.
2376#
2377
2378# Check for switch () and associated case and default
2379# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002380 if ($line=~/\bswitch\s*\(.*\)/) {
2381 my $err = '';
2382 my $sep = '';
2383 my @ctx = ctx_block_outer($linenr, $realcnt);
2384 shift(@ctx);
2385 for my $ctx (@ctx) {
2386 my ($clen, $cindent) = line_stats($ctx);
2387 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2388 $indent != $cindent) {
2389 $err .= "$sep$ctx\n";
2390 $sep = '';
2391 } else {
2392 $sep = "[...]\n";
2393 }
2394 }
2395 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002396 ERROR("SWITCH_CASE_INDENT_LEVEL",
2397 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002398 }
2399 }
2400
2401# if/while/etc brace do not go on next line, unless defining a do while loop,
2402# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002403 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002404 my $pre_ctx = "$1$2";
2405
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002406 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002407
2408 if ($line =~ /^\+\t{6,}/) {
2409 WARN("DEEP_INDENTATION",
2410 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2411 }
2412
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002413 my $ctx_cnt = $realcnt - $#ctx - 1;
2414 my $ctx = join("\n", @ctx);
2415
Andy Whitcroft548596d2008-07-23 21:29:01 -07002416 my $ctx_ln = $linenr;
2417 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002418
Andy Whitcroft548596d2008-07-23 21:29:01 -07002419 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2420 defined $lines[$ctx_ln - 1] &&
2421 $lines[$ctx_ln - 1] =~ /^-/)) {
2422 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2423 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002424 $ctx_ln++;
2425 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002426
Andy Whitcroft53210162008-07-23 21:29:03 -07002427 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2428 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002429
2430 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002431 ERROR("OPEN_BRACE",
2432 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002433 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002434 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002435 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2436 $ctx =~ /\)\s*\;\s*$/ &&
2437 defined $lines[$ctx_ln - 1])
2438 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002439 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2440 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002441 WARN("TRAILING_SEMICOLON",
2442 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002443 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002444 }
2445 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002446 }
2447
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002448# Check relative indent for conditionals and blocks.
2449 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002450 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2451 ctx_statement_block($linenr, $realcnt, 0)
2452 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002453 my ($s, $c) = ($stat, $cond);
2454
2455 substr($s, 0, length($c), '');
2456
2457 # Make sure we remove the line prefixes as we have
2458 # none on the first line, and are going to readd them
2459 # where necessary.
2460 $s =~ s/\n./\n/gs;
2461
2462 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002463 my @newlines = ($c =~ /\n/gs);
2464 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002465
2466 # We want to check the first line inside the block
2467 # starting at the end of the conditional, so remove:
2468 # 1) any blank line termination
2469 # 2) any opening brace { on end of the line
2470 # 3) any do (...) {
2471 my $continuation = 0;
2472 my $check = 0;
2473 $s =~ s/^.*\bdo\b//;
2474 $s =~ s/^\s*{//;
2475 if ($s =~ s/^\s*\\//) {
2476 $continuation = 1;
2477 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002478 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002479 $check = 1;
2480 $cond_lines++;
2481 }
2482
2483 # Also ignore a loop construct at the end of a
2484 # preprocessor statement.
2485 if (($prevline =~ /^.\s*#\s*define\s/ ||
2486 $prevline =~ /\\\s*$/) && $continuation == 0) {
2487 $check = 0;
2488 }
2489
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002490 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002491 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002492 while ($cond_ptr != $cond_lines) {
2493 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002494
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002495 # If we see an #else/#elif then the code
2496 # is not linear.
2497 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2498 $check = 0;
2499 }
2500
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002501 # Ignore:
2502 # 1) blank lines, they should be at 0,
2503 # 2) preprocessor lines, and
2504 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002505 if ($continuation ||
2506 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002507 $s =~ /^\s*#\s*?/ ||
2508 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002509 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002510 if ($s =~ s/^.*?\n//) {
2511 $cond_lines++;
2512 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002513 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002514 }
2515
2516 my (undef, $sindent) = line_stats("+" . $s);
2517 my $stat_real = raw_line($linenr, $cond_lines);
2518
2519 # Check if either of these lines are modified, else
2520 # this is not this patch's fault.
2521 if (!defined($stat_real) ||
2522 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2523 $check = 0;
2524 }
2525 if (defined($stat_real) && $cond_lines > 1) {
2526 $stat_real = "[...]\n$stat_real";
2527 }
2528
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002529 #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 -07002530
2531 if ($check && (($sindent % 8) != 0 ||
2532 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002533 WARN("SUSPECT_CODE_INDENT",
2534 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002535 }
2536 }
2537
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002538 # Track the 'values' across context and added lines.
2539 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002540 my ($curr_values, $curr_vars) =
2541 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002542 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002543 if ($dbg_values) {
2544 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002545 print "$linenr > .$outline\n";
2546 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002547 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002548 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002549 $prev_values = substr($curr_values, -1);
2550
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002551#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002552 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002553
Andy Whitcroft653d4872007-06-23 17:16:34 -07002554# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002555 if ($dbg_type) {
2556 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002557 ERROR("TEST_TYPE",
2558 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002559 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002560 ERROR("TEST_NOT_TYPE",
2561 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002562 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002563 next;
2564 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002565# TEST: allow direct testing of the attribute matcher.
2566 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002567 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002568 ERROR("TEST_ATTR",
2569 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002570 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002571 ERROR("TEST_NOT_ATTR",
2572 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002573 }
2574 next;
2575 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002576
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002577# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002578 if ($line =~ /^.\s*{/ &&
2579 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002580 ERROR("OPEN_BRACE",
2581 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002582 }
2583
Andy Whitcroft653d4872007-06-23 17:16:34 -07002584#
2585# Checks which are anchored on the added line.
2586#
2587
2588# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002589 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002590 my $path = $1;
2591 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002592 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002593 "malformed #include filename\n" . $herecurr);
2594 }
2595 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2596 ERROR("UAPI_INCLUDE",
2597 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002598 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002599 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002600
2601# no C99 // comments
2602 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002603 if (ERROR("C99_COMMENTS",
2604 "do not use C99 // comments\n" . $herecurr) &&
2605 $fix) {
2606 my $line = $fixed[$linenr - 1];
2607 if ($line =~ /\/\/(.*)$/) {
2608 my $comment = trim($1);
2609 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2610 }
2611 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002612 }
2613 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002614 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002615 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002616
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002617# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2618# the whole statement.
2619#print "APW <$lines[$realline_next - 1]>\n";
2620 if (defined $realline_next &&
2621 exists $lines[$realline_next - 1] &&
2622 !defined $suppress_export{$realline_next} &&
2623 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2624 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002625 # Handle definitions which produce identifiers with
2626 # a prefix:
2627 # XXX(foo);
2628 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002629 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002630 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002631 $name =~ /^${Ident}_$2/) {
2632#print "FOO C name<$name>\n";
2633 $suppress_export{$realline_next} = 1;
2634
2635 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002636 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002637 ^.DEFINE_$Ident\(\Q$name\E\)|
2638 ^.DECLARE_$Ident\(\Q$name\E\)|
2639 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002640 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2641 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002642 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002643#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2644 $suppress_export{$realline_next} = 2;
2645 } else {
2646 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002647 }
2648 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002649 if (!defined $suppress_export{$linenr} &&
2650 $prevline =~ /^.\s*$/ &&
2651 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2652 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2653#print "FOO B <$lines[$linenr - 1]>\n";
2654 $suppress_export{$linenr} = 2;
2655 }
2656 if (defined $suppress_export{$linenr} &&
2657 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002658 WARN("EXPORT_SYMBOL",
2659 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002660 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002661
Joe Eloff5150bda2010-08-09 17:21:00 -07002662# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002663 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2664 if (ERROR("GLOBAL_INITIALISERS",
2665 "do not initialise globals to 0 or NULL\n" .
2666 $herecurr) &&
2667 $fix) {
2668 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2669 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002670 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002671# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002672 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2673 if (ERROR("INITIALISED_STATIC",
2674 "do not initialise statics to 0 or NULL\n" .
2675 $herecurr) &&
2676 $fix) {
2677 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2678 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002679 }
2680
Joe Perchescb710ec2010-10-26 14:23:20 -07002681# check for static const char * arrays.
2682 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002683 WARN("STATIC_CONST_CHAR_ARRAY",
2684 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002685 $herecurr);
2686 }
2687
2688# check for static char foo[] = "bar" declarations.
2689 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002690 WARN("STATIC_CONST_CHAR_ARRAY",
2691 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002692 $herecurr);
2693 }
2694
Joe Perches9b0fa602014-04-03 14:49:18 -07002695# check for non-global char *foo[] = {"bar", ...} declarations.
2696 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) {
2697 WARN("STATIC_CONST_CHAR_ARRAY",
2698 "char * array declaration might be better as static const\n" .
2699 $herecurr);
2700 }
2701
Joe Perchesb36190c2014-01-27 17:07:18 -08002702# check for function declarations without arguments like "int foo()"
2703 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2704 if (ERROR("FUNCTION_WITHOUT_ARGS",
2705 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2706 $fix) {
2707 $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2708 }
2709 }
2710
Joe Perches92e112f2013-12-13 11:36:22 -07002711# check for uses of DEFINE_PCI_DEVICE_TABLE
2712 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2713 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2714 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2715 $fix) {
2716 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2717 }
Joe Perches93ed0e22010-10-26 14:23:21 -07002718 }
2719
Andy Whitcroft653d4872007-06-23 17:16:34 -07002720# check for new typedefs, only function parameters and sparse annotations
2721# make sense.
2722 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002723 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002724 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002725 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002726 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002727 WARN("NEW_TYPEDEFS",
2728 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002729 }
2730
2731# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002732 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002733 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2734 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002735 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002736
Andy Whitcroft65863862009-01-06 14:41:21 -08002737 # Should start with a space.
2738 $to =~ s/^(\S)/ $1/;
2739 # Should not end with a space.
2740 $to =~ s/\s+$//;
2741 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002742 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002743 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002744
Joe Perches3705ce52013-07-03 15:05:31 -07002745## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08002746 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07002747 if (ERROR("POINTER_LOCATION",
2748 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2749 $fix) {
2750 my $sub_from = $ident;
2751 my $sub_to = $ident;
2752 $sub_to =~ s/\Q$from\E/$to/;
2753 $fixed[$linenr - 1] =~
2754 s@\Q$sub_from\E@$sub_to@;
2755 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002756 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002757 }
2758 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2759 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002760 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002761
Andy Whitcroft65863862009-01-06 14:41:21 -08002762 # Should start with a space.
2763 $to =~ s/^(\S)/ $1/;
2764 # Should not end with a space.
2765 $to =~ s/\s+$//;
2766 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002767 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002768 }
2769 # Modifiers should have spaces.
2770 $to =~ s/(\b$Modifier$)/$1 /;
2771
Joe Perches3705ce52013-07-03 15:05:31 -07002772## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08002773 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002774 if (ERROR("POINTER_LOCATION",
2775 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2776 $fix) {
2777
2778 my $sub_from = $match;
2779 my $sub_to = $match;
2780 $sub_to =~ s/\Q$from\E/$to/;
2781 $fixed[$linenr - 1] =~
2782 s@\Q$sub_from\E@$sub_to@;
2783 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002784 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002785 }
2786
2787# # no BUG() or BUG_ON()
2788# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2789# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2790# print "$herecurr";
2791# $clean = 0;
2792# }
2793
Andy Whitcroft8905a672007-11-28 16:21:06 -08002794 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002795 WARN("LINUX_VERSION_CODE",
2796 "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 -08002797 }
2798
Joe Perches17441222011-06-15 15:08:17 -07002799# check for uses of printk_ratelimit
2800 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002801 WARN("PRINTK_RATELIMITED",
2802"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002803 }
2804
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002805# printk should use KERN_* levels. Note that follow on printk's on the
2806# same line do not need a level, so we use the current block context
2807# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002808# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002809# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002810 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002811 my $ok = 0;
2812 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2813 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002814 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002815 # with "\n" ignore it, else it is to blame
2816 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2817 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2818 $ok = 1;
2819 }
2820 last;
2821 }
2822 }
2823 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002824 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2825 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002826 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002827 }
2828
Joe Perches243f3802012-05-31 16:26:09 -07002829 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2830 my $orig = $1;
2831 my $level = lc($orig);
2832 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002833 my $level2 = $level;
2834 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002835 WARN("PREFER_PR_LEVEL",
Joe Perches8f26b832012-10-04 17:13:32 -07002836 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Joe Perches243f3802012-05-31 16:26:09 -07002837 }
2838
2839 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002840 if (WARN("PREFER_PR_LEVEL",
2841 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2842 $fix) {
2843 $fixed[$linenr - 1] =~
2844 s/\bpr_warning\b/pr_warn/;
2845 }
Joe Perches243f3802012-05-31 16:26:09 -07002846 }
2847
Joe Perchesdc139312013-02-21 16:44:13 -08002848 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2849 my $orig = $1;
2850 my $level = lc($orig);
2851 $level = "warn" if ($level eq "warning");
2852 $level = "dbg" if ($level eq "debug");
2853 WARN("PREFER_DEV_LEVEL",
2854 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2855 }
2856
Andy Whitcroft653d4872007-06-23 17:16:34 -07002857# function brace can't be on same line, except for #defines of do while,
2858# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002859 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2860 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002861 ERROR("OPEN_BRACE",
2862 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002863 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002864
Andy Whitcroft8905a672007-11-28 16:21:06 -08002865# open braces for enum, union and struct go on the same line.
2866 if ($line =~ /^.\s*{/ &&
2867 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002868 ERROR("OPEN_BRACE",
2869 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002870 }
2871
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002872# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07002873 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2874 if (WARN("SPACING",
2875 "missing space after $1 definition\n" . $herecurr) &&
2876 $fix) {
2877 $fixed[$linenr - 1] =~
2878 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2879 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002880 }
2881
Joe Perches31070b52014-01-23 15:54:49 -08002882# Function pointer declarations
2883# check spacing between type, funcptr, and args
2884# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002885 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08002886 my $declare = $1;
2887 my $pre_pointer_space = $2;
2888 my $post_pointer_space = $3;
2889 my $funcname = $4;
2890 my $post_funcname_space = $5;
2891 my $pre_args_space = $6;
2892
Joe Perches91f72e92014-04-03 14:49:12 -07002893# the $Declare variable will capture all spaces after the type
2894# so check it for a missing trailing missing space but pointer return types
2895# don't need a space so don't warn for those.
2896 my $post_declare_space = "";
2897 if ($declare =~ /(\s+)$/) {
2898 $post_declare_space = $1;
2899 $declare = rtrim($declare);
2900 }
2901 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08002902 WARN("SPACING",
2903 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07002904 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08002905 }
2906
2907# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002908# This test is not currently implemented because these declarations are
2909# equivalent to
2910# int foo(int bar, ...)
2911# and this is form shouldn't/doesn't generate a checkpatch warning.
2912#
2913# elsif ($declare =~ /\s{2,}$/) {
2914# WARN("SPACING",
2915# "Multiple spaces after return type\n" . $herecurr);
2916# }
Joe Perches31070b52014-01-23 15:54:49 -08002917
2918# unnecessary space "type ( *funcptr)(args...)"
2919 if (defined $pre_pointer_space &&
2920 $pre_pointer_space =~ /^\s/) {
2921 WARN("SPACING",
2922 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
2923 }
2924
2925# unnecessary space "type (* funcptr)(args...)"
2926 if (defined $post_pointer_space &&
2927 $post_pointer_space =~ /^\s/) {
2928 WARN("SPACING",
2929 "Unnecessary space before function pointer name\n" . $herecurr);
2930 }
2931
2932# unnecessary space "type (*funcptr )(args...)"
2933 if (defined $post_funcname_space &&
2934 $post_funcname_space =~ /^\s/) {
2935 WARN("SPACING",
2936 "Unnecessary space after function pointer name\n" . $herecurr);
2937 }
2938
2939# unnecessary space "type (*funcptr) (args...)"
2940 if (defined $pre_args_space &&
2941 $pre_args_space =~ /^\s/) {
2942 WARN("SPACING",
2943 "Unnecessary space before function pointer arguments\n" . $herecurr);
2944 }
2945
2946 if (show_type("SPACING") && $fix) {
2947 $fixed[$linenr - 1] =~
Joe Perches91f72e92014-04-03 14:49:12 -07002948 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08002949 }
2950 }
2951
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002952# check for spacing round square brackets; allowed:
2953# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002954# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2955# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002956 while ($line =~ /(.*?\s)\[/g) {
2957 my ($where, $prefix) = ($-[1], $1);
2958 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002959 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002960 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002961 if (ERROR("BRACKET_SPACE",
2962 "space prohibited before open square bracket '['\n" . $herecurr) &&
2963 $fix) {
2964 $fixed[$linenr - 1] =~
2965 s/^(\+.*?)\s+\[/$1\[/;
2966 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002967 }
2968 }
2969
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002970# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002971 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002972 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002973 my $ctx_before = substr($line, 0, $-[1]);
2974 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002975
2976 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002977 if ($name =~ /^(?:
2978 if|for|while|switch|return|case|
2979 volatile|__volatile__|
2980 __attribute__|format|__extension__|
2981 asm|__asm__)$/x)
2982 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002983 # cpp #define statements have non-optional spaces, ie
2984 # if there is a space between the name and the open
2985 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002986 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002987
2988 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002989 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002990
2991 # If this whole things ends with a type its most
2992 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002993 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002994
2995 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07002996 if (WARN("SPACING",
2997 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
2998 $fix) {
2999 $fixed[$linenr - 1] =~
3000 s/\b$name\s+\(/$name\(/;
3001 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003002 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003003 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07003004
Andy Whitcroft653d4872007-06-23 17:16:34 -07003005# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003006 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003007 my $fixed_line = "";
3008 my $line_fixed = 0;
3009
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003010 my $ops = qr{
3011 <<=|>>=|<=|>=|==|!=|
3012 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
3013 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003014 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08003015 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003016 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08003017 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07003018
3019## print("element count: <" . $#elements . ">\n");
3020## foreach my $el (@elements) {
3021## print("el: <$el>\n");
3022## }
3023
3024 my @fix_elements = ();
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003025 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003026
Joe Perches3705ce52013-07-03 15:05:31 -07003027 foreach my $el (@elements) {
3028 push(@fix_elements, substr($rawline, $off, length($el)));
3029 $off += length($el);
3030 }
3031
3032 $off = 0;
3033
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003034 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003035 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003036
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003037 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003038
3039 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3040
3041## print("n: <$n> good: <$good>\n");
3042
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003043 $off += length($elements[$n]);
3044
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003045 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003046 my $ca = substr($opline, 0, $off);
3047 my $cc = '';
3048 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3049 $cc = substr($opline, $off + length($elements[$n + 1]));
3050 }
3051 my $cb = "$ca$;$cc";
3052
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003053 my $a = '';
3054 $a = 'V' if ($elements[$n] ne '');
3055 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003056 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003057 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3058 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003059 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003060
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003061 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003062
3063 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003064 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003065 $c = 'V' if ($elements[$n + 2] ne '');
3066 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003067 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003068 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3069 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003070 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003071 } else {
3072 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003073 }
3074
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003075 my $ctx = "${a}x${c}";
3076
3077 my $at = "(ctx:$ctx)";
3078
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003079 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003080 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003081
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003082 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003083 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003084
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003085 # Get the full operator variant.
3086 my $opv = $op . substr($curr_vars, $off, 1);
3087
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003088 # Ignore operators passed as parameters.
3089 if ($op_type ne 'V' &&
3090 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3091
Andy Whitcroftcf655042008-03-04 14:28:20 -08003092# # Ignore comments
3093# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003094
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003095 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003096 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003097 if ($ctx !~ /.x[WEBC]/ &&
3098 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003099 if (ERROR("SPACING",
3100 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003101 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003102 $line_fixed = 1;
3103 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003104 }
3105
3106 # // is a comment
3107 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003108
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003109 # No spaces for:
3110 # ->
3111 # : when part of a bitfield
3112 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003113 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003114 if (ERROR("SPACING",
3115 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003116 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003117 if (defined $fix_elements[$n + 2]) {
3118 $fix_elements[$n + 2] =~ s/^\s+//;
3119 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003120 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003121 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003122 }
3123
3124 # , must have a space on the right.
3125 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003126 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003127 if (ERROR("SPACING",
3128 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003129 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003130 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003131 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07003132 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003133 }
3134
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003135 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003136 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003137 #warn "'*' is part of type\n";
3138
3139 # unary operators should have a space before and
3140 # none after. May be left adjacent to another
3141 # unary operator, or a cast
3142 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003143 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003144 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003145 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003146 if (ERROR("SPACING",
3147 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003148 if ($n != $last_after + 2) {
3149 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3150 $line_fixed = 1;
3151 }
Joe Perches3705ce52013-07-03 15:05:31 -07003152 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003153 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003154 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003155 # A unary '*' may be const
3156
3157 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003158 if (ERROR("SPACING",
3159 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003160 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003161 if (defined $fix_elements[$n + 2]) {
3162 $fix_elements[$n + 2] =~ s/^\s+//;
3163 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003164 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003165 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003166 }
3167
3168 # unary ++ and unary -- are allowed no space on one side.
3169 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003170 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003171 if (ERROR("SPACING",
3172 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003173 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003174 $line_fixed = 1;
3175 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003176 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003177 if ($ctx =~ /Wx[BE]/ ||
3178 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003179 if (ERROR("SPACING",
3180 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003181 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003182 $line_fixed = 1;
3183 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003184 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003185 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003186 if (ERROR("SPACING",
3187 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003188 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003189 if (defined $fix_elements[$n + 2]) {
3190 $fix_elements[$n + 2] =~ s/^\s+//;
3191 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003192 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003193 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003194 }
3195
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003196 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003197 } elsif ($op eq '<<' or $op eq '>>' or
3198 $op eq '&' or $op eq '^' or $op eq '|' or
3199 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003200 $op eq '*' or $op eq '/' or
3201 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003202 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003203 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003204 if (ERROR("SPACING",
3205 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003206 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3207 if (defined $fix_elements[$n + 2]) {
3208 $fix_elements[$n + 2] =~ s/^\s+//;
3209 }
Joe Perches3705ce52013-07-03 15:05:31 -07003210 $line_fixed = 1;
3211 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003212 }
3213
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003214 # A colon needs no spaces before when it is
3215 # terminating a case value or a label.
3216 } elsif ($opv eq ':C' || $opv eq ':L') {
3217 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003218 if (ERROR("SPACING",
3219 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003220 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003221 $line_fixed = 1;
3222 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003223 }
3224
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003225 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003226 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003227 my $ok = 0;
3228
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003229 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003230 if (($op eq '<' &&
3231 $cc =~ /^\S+\@\S+>/) ||
3232 ($op eq '>' &&
3233 $ca =~ /<\S+\@\S+$/))
3234 {
3235 $ok = 1;
3236 }
3237
Joe Perches84731622013-11-12 15:10:05 -08003238 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003239 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003240 my $msg_type = \&ERROR;
3241 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3242
3243 if (&{$msg_type}("SPACING",
3244 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003245 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3246 if (defined $fix_elements[$n + 2]) {
3247 $fix_elements[$n + 2] =~ s/^\s+//;
3248 }
Joe Perches3705ce52013-07-03 15:05:31 -07003249 $line_fixed = 1;
3250 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003251 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003252 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003253 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003254
3255## print("n: <$n> GOOD: <$good>\n");
3256
3257 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003258 }
Joe Perches3705ce52013-07-03 15:05:31 -07003259
3260 if (($#elements % 2) == 0) {
3261 $fixed_line = $fixed_line . $fix_elements[$#elements];
3262 }
3263
3264 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3265 $fixed[$linenr - 1] = $fixed_line;
3266 }
3267
3268
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003269 }
3270
Joe Perches786b6322013-07-03 15:05:32 -07003271# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003272 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003273 if (WARN("SPACING",
3274 "space prohibited before semicolon\n" . $herecurr) &&
3275 $fix) {
3276 1 while $fixed[$linenr - 1] =~
3277 s/^(\+.*\S)\s+;/$1;/;
3278 }
3279 }
3280
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003281# check for multiple assignments
3282 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003283 CHK("MULTIPLE_ASSIGNMENTS",
3284 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003285 }
3286
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003287## # check for multiple declarations, allowing for a function declaration
3288## # continuation.
3289## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3290## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3291##
3292## # Remove any bracketed sections to ensure we do not
3293## # falsly report the parameters of functions.
3294## my $ln = $line;
3295## while ($ln =~ s/\([^\(\)]*\)//g) {
3296## }
3297## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003298## WARN("MULTIPLE_DECLARATION",
3299## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003300## }
3301## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003302
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003303#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003304 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3305 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003306 if (ERROR("SPACING",
3307 "space required before the open brace '{'\n" . $herecurr) &&
3308 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003309 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003310 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003311 }
3312
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003313## # check for blank lines before declarations
3314## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3315## $prevrawline =~ /^.\s*$/) {
3316## WARN("SPACING",
3317## "No blank lines before declarations\n" . $hereprev);
3318## }
3319##
3320
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003321# closing brace should have a space following it when it has anything
3322# on the line
3323 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003324 if (ERROR("SPACING",
3325 "space required after that close brace '}'\n" . $herecurr) &&
3326 $fix) {
3327 $fixed[$linenr - 1] =~
3328 s/}((?!(?:,|;|\)))\S)/} $1/;
3329 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003330 }
3331
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003332# check spacing on square brackets
3333 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003334 if (ERROR("SPACING",
3335 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3336 $fix) {
3337 $fixed[$linenr - 1] =~
3338 s/\[\s+/\[/;
3339 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003340 }
3341 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003342 if (ERROR("SPACING",
3343 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3344 $fix) {
3345 $fixed[$linenr - 1] =~
3346 s/\s+\]/\]/;
3347 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003348 }
3349
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003350# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003351 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3352 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003353 if (ERROR("SPACING",
3354 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3355 $fix) {
3356 $fixed[$linenr - 1] =~
3357 s/\(\s+/\(/;
3358 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003359 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003360 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003361 $line !~ /for\s*\(.*;\s+\)/ &&
3362 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003363 if (ERROR("SPACING",
3364 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3365 $fix) {
3366 $fixed[$linenr - 1] =~
3367 s/\s+\)/\)/;
3368 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003369 }
3370
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003371#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003372 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003373 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003374 if (WARN("INDENTED_LABEL",
3375 "labels should not be indented\n" . $herecurr) &&
3376 $fix) {
3377 $fixed[$linenr - 1] =~
3378 s/^(.)\s+/$1/;
3379 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003380 }
3381
Joe Perches5b9553a2014-04-03 14:49:21 -07003382# return is not a function
Joe Perches507e5142013-11-12 15:10:13 -08003383 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003384 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003385 if ($^V && $^V ge 5.10.0 &&
Joe Perches5b9553a2014-04-03 14:49:21 -07003386 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) {
3387 my $value = $1;
3388 $value = deparenthesize($value);
3389 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) {
3390 ERROR("RETURN_PARENTHESES",
3391 "return is not a function, parentheses are not required\n" . $herecurr);
3392 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003393 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003394 ERROR("SPACING",
3395 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003396 }
3397 }
Joe Perches507e5142013-11-12 15:10:13 -08003398
Joe Perches189248d2014-01-23 15:54:47 -08003399# if statements using unnecessary parentheses - ie: if ((foo == bar))
3400 if ($^V && $^V ge 5.10.0 &&
3401 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3402 my $openparens = $1;
3403 my $count = $openparens =~ tr@\(@\(@;
3404 my $msg = "";
3405 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3406 my $comp = $4; #Not $1 because of $LvalOrFunc
3407 $msg = " - maybe == should be = ?" if ($comp eq "==");
3408 WARN("UNNECESSARY_PARENTHESES",
3409 "Unnecessary parentheses$msg\n" . $herecurr);
3410 }
3411 }
3412
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003413# Return of what appears to be an errno should normally be -'ve
3414 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3415 my $name = $1;
3416 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003417 WARN("USE_NEGATIVE_ERRNO",
3418 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003419 }
3420 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003421
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003422# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003423 if ($line =~ /\b(if|while|for|switch)\(/) {
3424 if (ERROR("SPACING",
3425 "space required before the open parenthesis '('\n" . $herecurr) &&
3426 $fix) {
3427 $fixed[$linenr - 1] =~
3428 s/\b(if|while|for|switch)\(/$1 \(/;
3429 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003430 }
3431
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003432# Check for illegal assignment in if conditional -- and check for trailing
3433# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003434 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003435 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3436 ctx_statement_block($linenr, $realcnt, 0)
3437 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003438 my ($stat_next) = ctx_statement_block($line_nr_next,
3439 $remain_next, $off_next);
3440 $stat_next =~ s/\n./\n /g;
3441 ##print "stat<$stat> stat_next<$stat_next>\n";
3442
3443 if ($stat_next =~ /^\s*while\b/) {
3444 # If the statement carries leading newlines,
3445 # then count those as offsets.
3446 my ($whitespace) =
3447 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3448 my $offset =
3449 statement_rawlines($whitespace) - 1;
3450
3451 $suppress_whiletrailers{$line_nr_next +
3452 $offset} = 1;
3453 }
3454 }
3455 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003456 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003457 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003458 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003459
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003460 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003461 ERROR("ASSIGN_IN_IF",
3462 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003463 }
3464
3465 # Find out what is on the end of the line after the
3466 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003467 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003468 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003469 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003470 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3471 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003472 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003473 # Find out how long the conditional actually is.
3474 my @newlines = ($c =~ /\n/gs);
3475 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003476 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003477
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003478 $stat_real = raw_line($linenr, $cond_lines)
3479 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003480 if (defined($stat_real) && $cond_lines > 1) {
3481 $stat_real = "[...]\n$stat_real";
3482 }
3483
Joe Perches000d1cc12011-07-25 17:13:25 -07003484 ERROR("TRAILING_STATEMENTS",
3485 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003486 }
3487 }
3488
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003489# Check for bitwise tests written as boolean
3490 if ($line =~ /
3491 (?:
3492 (?:\[|\(|\&\&|\|\|)
3493 \s*0[xX][0-9]+\s*
3494 (?:\&\&|\|\|)
3495 |
3496 (?:\&\&|\|\|)
3497 \s*0[xX][0-9]+\s*
3498 (?:\&\&|\|\||\)|\])
3499 )/x)
3500 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003501 WARN("HEXADECIMAL_BOOLEAN_TEST",
3502 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003503 }
3504
Andy Whitcroft8905a672007-11-28 16:21:06 -08003505# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003506 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3507 my $s = $1;
3508 $s =~ s/$;//g; # Remove any comments
3509 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003510 ERROR("TRAILING_STATEMENTS",
3511 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003512 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003513 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003514# if should not continue a brace
3515 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003516 ERROR("TRAILING_STATEMENTS",
3517 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003518 $herecurr);
3519 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003520# case and default should not have general statements after them
3521 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3522 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003523 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003524 \s*return\s+
3525 )/xg)
3526 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003527 ERROR("TRAILING_STATEMENTS",
3528 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003529 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003530
3531 # Check for }<nl>else {, these must be at the same
3532 # indent level to be relevant to each other.
3533 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3534 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003535 ERROR("ELSE_AFTER_BRACE",
3536 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003537 }
3538
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003539 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3540 $previndent == $indent) {
3541 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3542
3543 # Find out what is on the end of the line after the
3544 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003545 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003546 $s =~ s/\n.*//g;
3547
3548 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003549 ERROR("WHILE_AFTER_BRACE",
3550 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003551 }
3552 }
3553
Joe Perches95e2c602013-07-03 15:05:20 -07003554#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003555 while ($line =~ m{($Constant|$Lval)}g) {
3556 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003557
3558#gcc binary extension
3559 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003560 if (WARN("GCC_BINARY_CONSTANT",
3561 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3562 $fix) {
3563 my $hexval = sprintf("0x%x", oct($var));
3564 $fixed[$linenr - 1] =~
3565 s/\b$var\b/$hexval/;
3566 }
Joe Perches95e2c602013-07-03 15:05:20 -07003567 }
3568
3569#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003570 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003571 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003572#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003573 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003574#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003575 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003576 while ($var =~ m{($Ident)}g) {
3577 my $word = $1;
3578 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08003579 if ($check) {
3580 seed_camelcase_includes();
3581 if (!$file && !$camelcase_file_seeded) {
3582 seed_camelcase_file($realfile);
3583 $camelcase_file_seeded = 1;
3584 }
3585 }
Joe Perches7e781f62013-09-11 14:23:55 -07003586 if (!defined $camelcase{$word}) {
3587 $camelcase{$word} = 1;
3588 CHK("CAMELCASE",
3589 "Avoid CamelCase: <$word>\n" . $herecurr);
3590 }
Joe Perches34456862013-07-03 15:05:34 -07003591 }
Joe Perches323c1262012-12-17 16:02:07 -08003592 }
3593 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003594
3595#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003596 if ($line =~ /\#\s*define.*\\\s+$/) {
3597 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3598 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3599 $fix) {
3600 $fixed[$linenr - 1] =~ s/\s+$//;
3601 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003602 }
3603
Andy Whitcroft653d4872007-06-23 17:16:34 -07003604#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003605 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003606 my $file = "$1.h";
3607 my $checkfile = "include/linux/$file";
3608 if (-f "$root/$checkfile" &&
3609 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003610 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003611 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003612 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003613 CHK("ARCH_INCLUDE_LINUX",
3614 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003615 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003616 WARN("INCLUDE_LINUX",
3617 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003618 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003619 }
3620 }
3621
Andy Whitcroft653d4872007-06-23 17:16:34 -07003622# multi-statement macros should be enclosed in a do while loop, grab the
3623# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003624# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07003625 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3626 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003627 my $ln = $linenr;
3628 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003629 my ($off, $dstat, $dcond, $rest);
3630 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003631 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003632 ctx_statement_block($linenr, $realcnt, 0);
3633 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003634 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003635 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003636
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003637 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003638 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003639 $dstat =~ s/\\\n.//g;
3640 $dstat =~ s/^\s*//s;
3641 $dstat =~ s/\s*$//s;
3642
3643 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003644 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3645 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003646 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003647 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003648 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003649
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003650 # Flatten any obvious string concatentation.
3651 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3652 $dstat =~ s/$Ident\s*("X*")/$1/)
3653 {
3654 }
3655
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003656 my $exceptions = qr{
3657 $Declare|
3658 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003659 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003660 DECLARE_PER_CPU|
3661 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003662 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003663 union|
3664 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003665 \.$Ident\s*=\s*|
3666 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003667 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003668 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003669 if ($dstat ne '' &&
3670 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3671 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07003672 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003673 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003674 $dstat !~ /$exceptions/ &&
3675 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003676 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003677 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003678 $dstat !~ /^for\s*$Constant$/ && # for (...)
3679 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3680 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07003681 $dstat !~ /^\({/ && # ({...
3682 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003683 {
3684 $ctx =~ s/\n*$//;
3685 my $herectx = $here . "\n";
3686 my $cnt = statement_rawlines($ctx);
3687
3688 for (my $n = 0; $n < $cnt; $n++) {
3689 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003690 }
3691
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003692 if ($dstat =~ /;/) {
3693 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3694 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3695 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003696 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003697 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003698 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003699 }
Joe Perches5023d342012-12-17 16:01:47 -08003700
Joe Perches481eb482012-12-17 16:01:56 -08003701# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003702
3703 } else {
3704 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003705 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3706 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003707 $line =~ /^\+.*\\$/) {
3708 WARN("LINE_CONTINUATIONS",
3709 "Avoid unnecessary line continuations\n" . $herecurr);
3710 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003711 }
3712
Joe Perchesb13edf72012-07-30 14:41:24 -07003713# do {} while (0) macro tests:
3714# single-statement macros do not need to be enclosed in do while (0) loop,
3715# macro should not end with a semicolon
3716 if ($^V && $^V ge 5.10.0 &&
3717 $realfile !~ m@/vmlinux.lds.h$@ &&
3718 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3719 my $ln = $linenr;
3720 my $cnt = $realcnt;
3721 my ($off, $dstat, $dcond, $rest);
3722 my $ctx = '';
3723 ($dstat, $dcond, $ln, $cnt, $off) =
3724 ctx_statement_block($linenr, $realcnt, 0);
3725 $ctx = $dstat;
3726
3727 $dstat =~ s/\\\n.//g;
3728
3729 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3730 my $stmts = $2;
3731 my $semis = $3;
3732
3733 $ctx =~ s/\n*$//;
3734 my $cnt = statement_rawlines($ctx);
3735 my $herectx = $here . "\n";
3736
3737 for (my $n = 0; $n < $cnt; $n++) {
3738 $herectx .= raw_line($linenr, $n) . "\n";
3739 }
3740
Joe Perchesac8e97f2012-08-21 16:15:53 -07003741 if (($stmts =~ tr/;/;/) == 1 &&
3742 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003743 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3744 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3745 }
3746 if (defined $semis && $semis ne "") {
3747 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3748 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3749 }
3750 }
3751 }
3752
Mike Frysinger080ba922009-01-06 14:41:25 -08003753# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3754# all assignments may have only one of the following with an assignment:
3755# .
3756# ALIGN(...)
3757# VMLINUX_SYMBOL(...)
3758 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003759 WARN("MISSING_VMLINUX_SYMBOL",
3760 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003761 }
3762
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003763# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003764 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3765 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003766 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003767 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003768 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3769 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003770 my @allowed = ();
3771 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003772 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003773 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003774 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003775 for my $chunk (@chunks) {
3776 my ($cond, $block) = @{$chunk};
3777
Andy Whitcroft773647a2008-03-28 14:15:58 -07003778 # If the condition carries leading newlines, then count those as offsets.
3779 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3780 my $offset = statement_rawlines($whitespace) - 1;
3781
Joe Perchesaad4f612012-03-23 15:02:19 -07003782 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003783 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3784
3785 # We have looked at and allowed this specific line.
3786 $suppress_ifbraces{$ln + $offset} = 1;
3787
3788 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003789 $ln += statement_rawlines($block) - 1;
3790
Andy Whitcroft773647a2008-03-28 14:15:58 -07003791 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003792
3793 $seen++ if ($block =~ /^\s*{/);
3794
Joe Perchesaad4f612012-03-23 15:02:19 -07003795 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003796 if (statement_lines($cond) > 1) {
3797 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003798 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003799 }
3800 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003801 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003802 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003803 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003804 if (statement_block_size($block) > 1) {
3805 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003806 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003807 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003808 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003809 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003810 if ($seen) {
3811 my $sum_allowed = 0;
3812 foreach (@allowed) {
3813 $sum_allowed += $_;
3814 }
3815 if ($sum_allowed == 0) {
3816 WARN("BRACES",
3817 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3818 } elsif ($sum_allowed != $allow &&
3819 $seen != $allow) {
3820 CHK("BRACES",
3821 "braces {} should be used on all arms of this statement\n" . $herectx);
3822 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003823 }
3824 }
3825 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003826 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003827 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003828 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003829
Andy Whitcroftcf655042008-03-04 14:28:20 -08003830 # Check the pre-context.
3831 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3832 #print "APW: ALLOWED: pre<$1>\n";
3833 $allowed = 1;
3834 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003835
3836 my ($level, $endln, @chunks) =
3837 ctx_statement_full($linenr, $realcnt, $-[0]);
3838
Andy Whitcroftcf655042008-03-04 14:28:20 -08003839 # Check the condition.
3840 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003841 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003842 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003843 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003844 }
3845 if (statement_lines($cond) > 1) {
3846 #print "APW: ALLOWED: cond<$cond>\n";
3847 $allowed = 1;
3848 }
3849 if ($block =~/\b(?:if|for|while)\b/) {
3850 #print "APW: ALLOWED: block<$block>\n";
3851 $allowed = 1;
3852 }
3853 if (statement_block_size($block) > 1) {
3854 #print "APW: ALLOWED: lines block<$block>\n";
3855 $allowed = 1;
3856 }
3857 # Check the post-context.
3858 if (defined $chunks[1]) {
3859 my ($cond, $block) = @{$chunks[1]};
3860 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003861 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003862 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003863 if ($block =~ /^\s*\{/) {
3864 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3865 $allowed = 1;
3866 }
3867 }
3868 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003869 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003870 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003871
Andy Whitcroftf0556632008-10-15 22:02:23 -07003872 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003873 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003874 }
3875
Joe Perches000d1cc12011-07-25 17:13:25 -07003876 WARN("BRACES",
3877 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003878 }
3879 }
3880
Joe Perches0979ae62012-12-17 16:01:59 -08003881# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07003882 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003883 CHK("BRACES",
3884 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3885 }
Joe Perches77b9a532013-07-03 15:05:29 -07003886 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003887 CHK("BRACES",
3888 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3889 }
3890
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003891# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003892 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3893 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003894 WARN("VOLATILE",
3895 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003896 }
3897
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003898# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003899 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003900 CHK("REDUNDANT_CODE",
3901 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003902 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003903 }
3904
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003905# check for needless "if (<foo>) fn(<foo>)" uses
3906 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3907 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3908 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3909 WARN('NEEDLESS_IF',
3910 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003911 }
3912 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003913
Joe Perches8716de32013-09-11 14:24:05 -07003914# check for bad placement of section $InitAttribute (e.g.: __initdata)
3915 if ($line =~ /(\b$InitAttribute\b)/) {
3916 my $attr = $1;
3917 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
3918 my $ptr = $1;
3919 my $var = $2;
3920 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
3921 ERROR("MISPLACED_INIT",
3922 "$attr should be placed after $var\n" . $herecurr)) ||
3923 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
3924 WARN("MISPLACED_INIT",
3925 "$attr should be placed after $var\n" . $herecurr))) &&
3926 $fix) {
3927 $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;
3928 }
3929 }
3930 }
3931
Joe Perchese970b8842013-11-12 15:10:10 -08003932# check for $InitAttributeData (ie: __initdata) with const
3933 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
3934 my $attr = $1;
3935 $attr =~ /($InitAttributePrefix)(.*)/;
3936 my $attr_prefix = $1;
3937 my $attr_type = $2;
3938 if (ERROR("INIT_ATTRIBUTE",
3939 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
3940 $fix) {
3941 $fixed[$linenr - 1] =~
3942 s/$InitAttributeData/${attr_prefix}initconst/;
3943 }
3944 }
3945
3946# check for $InitAttributeConst (ie: __initconst) without const
3947 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
3948 my $attr = $1;
3949 if (ERROR("INIT_ATTRIBUTE",
3950 "Use of $attr requires a separate use of const\n" . $herecurr) &&
3951 $fix) {
3952 my $lead = $fixed[$linenr - 1] =~
3953 /(^\+\s*(?:static\s+))/;
3954 $lead = rtrim($1);
3955 $lead = "$lead " if ($lead !~ /^\+$/);
3956 $lead = "${lead}const ";
3957 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
3958 }
3959 }
3960
Joe Perchesfbdb8132014-04-03 14:49:14 -07003961# don't use __constant_<foo> functions outside of include/uapi/
3962 if ($realfile !~ m@^include/uapi/@ &&
3963 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
3964 my $constant_func = $1;
3965 my $func = $constant_func;
3966 $func =~ s/^__constant_//;
3967 if (WARN("CONSTANT_CONVERSION",
3968 "$constant_func should be $func\n" . $herecurr) &&
3969 $fix) {
3970 $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
3971 }
3972 }
3973
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003974# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08003975 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07003976 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003977 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07003978 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003979 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07003980 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
3981 }
3982 if ($delay > 2000) {
3983 WARN("LONG_UDELAY",
3984 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003985 }
3986 }
3987
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003988# warn about unexpectedly long msleep's
3989 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3990 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003991 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07003992 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003993 }
3994 }
3995
Joe Perches36ec1932013-07-03 15:05:25 -07003996# check for comparisons of jiffies
3997 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
3998 WARN("JIFFIES_COMPARISON",
3999 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4000 }
4001
Joe Perches9d7a34a2013-07-03 15:05:26 -07004002# check for comparisons of get_jiffies_64()
4003 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
4004 WARN("JIFFIES_COMPARISON",
4005 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4006 }
4007
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004008# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004009# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07004010# print "#ifdef in C files should be avoided\n";
4011# print "$herecurr";
4012# $clean = 0;
4013# }
4014
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004015# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004016 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07004017 if (ERROR("SPACING",
4018 "exactly one space required after that #$1\n" . $herecurr) &&
4019 $fix) {
4020 $fixed[$linenr - 1] =~
4021 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
4022 }
4023
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07004024 }
4025
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004026# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004027 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4028 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004029 my $which = $1;
4030 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004031 CHK("UNCOMMENTED_DEFINITION",
4032 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004033 }
4034 }
4035# check for memory barriers without a comment.
4036 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4037 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004038 WARN("MEMORY_BARRIER",
4039 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004040 }
4041 }
4042# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004043 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004044 CHK("ARCH_DEFINES",
4045 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004046 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004047
Tobias Klauserd4977c72010-05-24 14:33:30 -07004048# Check that the storage class is at the beginning of a declaration
4049 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004050 WARN("STORAGE_CLASS",
4051 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004052 }
4053
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004054# check the location of the inline attribute, that it is between
4055# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004056 if ($line =~ /\b$Type\s+$Inline\b/ ||
4057 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004058 ERROR("INLINE_LOCATION",
4059 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004060 }
4061
Andy Whitcroft8905a672007-11-28 16:21:06 -08004062# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004063 if ($realfile !~ m@\binclude/uapi/@ &&
4064 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004065 if (WARN("INLINE",
4066 "plain inline is preferred over $1\n" . $herecurr) &&
4067 $fix) {
4068 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4069
4070 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004071 }
4072
Joe Perches3d130fd2011-01-12 17:00:00 -08004073# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004074 if ($realfile !~ m@\binclude/uapi/@ &&
4075 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004076 WARN("PREFER_PACKED",
4077 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004078 }
4079
Joe Perches39b7e282011-07-25 17:13:24 -07004080# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004081 if ($realfile !~ m@\binclude/uapi/@ &&
4082 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004083 WARN("PREFER_ALIGNED",
4084 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004085 }
4086
Joe Perches5f14d3b2012-01-10 15:09:52 -08004087# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004088 if ($realfile !~ m@\binclude/uapi/@ &&
4089 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004090 if (WARN("PREFER_PRINTF",
4091 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4092 $fix) {
4093 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4094
4095 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004096 }
4097
Joe Perches6061d942012-03-23 15:02:16 -07004098# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004099 if ($realfile !~ m@\binclude/uapi/@ &&
4100 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004101 if (WARN("PREFER_SCANF",
4102 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4103 $fix) {
4104 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4105 }
Joe Perches6061d942012-03-23 15:02:16 -07004106 }
4107
Joe Perches8f53a9b2010-03-05 13:43:48 -08004108# check for sizeof(&)
4109 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004110 WARN("SIZEOF_ADDRESS",
4111 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004112 }
4113
Joe Perches66c80b62012-07-30 14:41:22 -07004114# check for sizeof without parenthesis
4115 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004116 if (WARN("SIZEOF_PARENTHESIS",
4117 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4118 $fix) {
4119 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4120 }
Joe Perches66c80b62012-07-30 14:41:22 -07004121 }
4122
Joe Perches428e2fd2011-05-24 17:13:39 -07004123# check for line continuations in quoted strings with odd counts of "
4124 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004125 WARN("LINE_CONTINUATIONS",
4126 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004127 }
4128
Joe Perches88982fe2012-12-17 16:02:00 -08004129# check for struct spinlock declarations
4130 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4131 WARN("USE_SPINLOCK_T",
4132 "struct spinlock should be spinlock_t\n" . $herecurr);
4133 }
4134
Joe Perchesa6962d72013-04-29 16:18:13 -07004135# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004136 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004137 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004138 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004139 if (WARN("PREFER_SEQ_PUTS",
4140 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4141 $fix) {
4142 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4143 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004144 }
4145 }
4146
Andy Whitcroft554e1652012-01-10 15:09:57 -08004147# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004148 if ($^V && $^V ge 5.10.0 &&
4149 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004150 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004151
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004152 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004153 my $ms_val = $7;
4154 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004155
Andy Whitcroft554e1652012-01-10 15:09:57 -08004156 if ($ms_size =~ /^(0x|)0$/i) {
4157 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004158 "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 -08004159 } elsif ($ms_size =~ /^(0x|)1$/i) {
4160 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004161 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4162 }
4163 }
4164
Joe Perches98a9bba2014-01-23 15:54:52 -08004165# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4166 if ($^V && $^V ge 5.10.0 &&
4167 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4168 if (WARN("PREFER_ETHER_ADDR_COPY",
4169 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4170 $fix) {
4171 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4172 }
4173 }
4174
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004175# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004176 if ($^V && $^V ge 5.10.0 &&
4177 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004178 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004179 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004180 my $call = $1;
4181 my $cast1 = deparenthesize($2);
4182 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004183 my $cast2 = deparenthesize($7);
4184 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004185 my $cast;
4186
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004187 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004188 $cast = "$cast1 or $cast2";
4189 } elsif ($cast1 ne "") {
4190 $cast = $cast1;
4191 } else {
4192 $cast = $cast2;
4193 }
4194 WARN("MINMAX",
4195 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004196 }
4197 }
4198
Joe Perches4a273192012-07-30 14:41:20 -07004199# check usleep_range arguments
4200 if ($^V && $^V ge 5.10.0 &&
4201 defined $stat &&
4202 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4203 my $min = $1;
4204 my $max = $7;
4205 if ($min eq $max) {
4206 WARN("USLEEP_RANGE",
4207 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4208 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4209 $min > $max) {
4210 WARN("USLEEP_RANGE",
4211 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4212 }
4213 }
4214
Joe Perches823b7942013-11-12 15:10:15 -08004215# check for naked sscanf
4216 if ($^V && $^V ge 5.10.0 &&
4217 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004218 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004219 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4220 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4221 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4222 my $lc = $stat =~ tr@\n@@;
4223 $lc = $lc + $linenr;
4224 my $stat_real = raw_line($linenr, 0);
4225 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4226 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4227 }
4228 WARN("NAKED_SSCANF",
4229 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4230 }
4231
Joe Perches70dc8a42013-09-11 14:23:58 -07004232# check for new externs in .h files.
4233 if ($realfile =~ /\.h$/ &&
4234 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004235 if (CHK("AVOID_EXTERNS",
4236 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004237 $fix) {
4238 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4239 }
4240 }
4241
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004242# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004243 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004244 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004245 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004246 my $function_name = $1;
4247 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004248
4249 my $s = $stat;
4250 if (defined $cond) {
4251 substr($s, 0, length($cond), '');
4252 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004253 if ($s =~ /^\s*;/ &&
4254 $function_name ne 'uninitialized_var')
4255 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004256 WARN("AVOID_EXTERNS",
4257 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004258 }
4259
4260 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004261 WARN("FUNCTION_ARGUMENTS",
4262 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004263 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004264
4265 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4266 $stat =~ /^.\s*extern\s+/)
4267 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004268 WARN("AVOID_EXTERNS",
4269 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004270 }
4271
4272# checks for new __setup's
4273 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4274 my $name = $1;
4275
4276 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004277 CHK("UNDOCUMENTED_SETUP",
4278 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004279 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004280 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004281
4282# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004283 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004284 WARN("UNNECESSARY_CASTS",
4285 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004286 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004287
Joe Perchesa640d252013-07-03 15:05:21 -07004288# alloc style
4289# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4290 if ($^V && $^V ge 5.10.0 &&
4291 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4292 CHK("ALLOC_SIZEOF_STRUCT",
4293 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4294 }
4295
Joe Perches972fdea2013-04-29 16:18:12 -07004296# check for krealloc arg reuse
4297 if ($^V && $^V ge 5.10.0 &&
4298 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4299 WARN("KREALLOC_ARG_REUSE",
4300 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4301 }
4302
Joe Perches5ce59ae2013-02-21 16:44:18 -08004303# check for alloc argument mismatch
4304 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4305 WARN("ALLOC_ARRAY_ARGS",
4306 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4307 }
4308
David Rientjes7e4915e2014-01-23 15:54:42 -08004309# check for GFP_NOWAIT use
4310 if ($line =~ /\b__GFP_NOFAIL\b/) {
4311 WARN("__GFP_NOFAIL",
4312 "Use of __GFP_NOFAIL is deprecated, no new users should be added\n" . $herecurr);
4313 }
4314
Joe Perchescaf2a542011-01-12 16:59:56 -08004315# check for multiple semicolons
4316 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004317 if (WARN("ONE_SEMICOLON",
4318 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4319 $fix) {
4320 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4321 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004322 }
4323
Joe Perchesc34c09a2014-01-23 15:54:43 -08004324# check for case / default statements not preceeded by break/fallthrough/switch
4325 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4326 my $has_break = 0;
4327 my $has_statement = 0;
4328 my $count = 0;
4329 my $prevline = $linenr;
4330 while ($prevline > 1 && $count < 3 && !$has_break) {
4331 $prevline--;
4332 my $rline = $rawlines[$prevline - 1];
4333 my $fline = $lines[$prevline - 1];
4334 last if ($fline =~ /^\@\@/);
4335 next if ($fline =~ /^\-/);
4336 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4337 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4338 next if ($fline =~ /^.[\s$;]*$/);
4339 $has_statement = 1;
4340 $count++;
4341 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4342 }
4343 if (!$has_break && $has_statement) {
4344 WARN("MISSING_BREAK",
4345 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4346 }
4347 }
4348
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004349# check for switch/default statements without a break;
4350 if ($^V && $^V ge 5.10.0 &&
4351 defined $stat &&
4352 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4353 my $ctx = '';
4354 my $herectx = $here . "\n";
4355 my $cnt = statement_rawlines($stat);
4356 for (my $n = 0; $n < $cnt; $n++) {
4357 $herectx .= raw_line($linenr, $n) . "\n";
4358 }
4359 WARN("DEFAULT_NO_BREAK",
4360 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004361 }
4362
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004363# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004364 if ($line =~ /\b__FUNCTION__\b/) {
4365 if (WARN("USE_FUNC",
4366 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4367 $fix) {
4368 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4369 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004370 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004371
Joe Perches2c924882012-03-23 15:02:20 -07004372# check for use of yield()
4373 if ($line =~ /\byield\s*\(\s*\)/) {
4374 WARN("YIELD",
4375 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4376 }
4377
Joe Perches179f8f42013-07-03 15:05:30 -07004378# check for comparisons against true and false
4379 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4380 my $lead = $1;
4381 my $arg = $2;
4382 my $test = $3;
4383 my $otype = $4;
4384 my $trail = $5;
4385 my $op = "!";
4386
4387 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4388
4389 my $type = lc($otype);
4390 if ($type =~ /^(?:true|false)$/) {
4391 if (("$test" eq "==" && "$type" eq "true") ||
4392 ("$test" eq "!=" && "$type" eq "false")) {
4393 $op = "";
4394 }
4395
4396 CHK("BOOL_COMPARISON",
4397 "Using comparison to $otype is error prone\n" . $herecurr);
4398
4399## maybe suggesting a correct construct would better
4400## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4401
4402 }
4403 }
4404
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004405# check for semaphores initialized locked
4406 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004407 WARN("CONSIDER_COMPLETION",
4408 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004409 }
Joe Perches6712d852012-03-23 15:02:20 -07004410
Joe Perches67d0a072011-10-31 17:13:10 -07004411# recommend kstrto* over simple_strto* and strict_strto*
4412 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004413 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004414 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004415 }
Joe Perches6712d852012-03-23 15:02:20 -07004416
Michael Ellermanf3db6632008-07-23 21:28:57 -07004417# check for __initcall(), use device_initcall() explicitly please
4418 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004419 WARN("USE_DEVICE_INITCALL",
4420 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07004421 }
Joe Perches6712d852012-03-23 15:02:20 -07004422
Emese Revfy79404842010-03-05 13:43:53 -08004423# check for various ops structs, ensure they are const.
4424 my $struct_ops = qr{acpi_dock_ops|
4425 address_space_operations|
4426 backlight_ops|
4427 block_device_operations|
4428 dentry_operations|
4429 dev_pm_ops|
4430 dma_map_ops|
4431 extent_io_ops|
4432 file_lock_operations|
4433 file_operations|
4434 hv_ops|
4435 ide_dma_ops|
4436 intel_dvo_dev_ops|
4437 item_operations|
4438 iwl_ops|
4439 kgdb_arch|
4440 kgdb_io|
4441 kset_uevent_ops|
4442 lock_manager_operations|
4443 microcode_ops|
4444 mtrr_ops|
4445 neigh_ops|
4446 nlmsvc_binding|
4447 pci_raw_ops|
4448 pipe_buf_operations|
4449 platform_hibernation_ops|
4450 platform_suspend_ops|
4451 proto_ops|
4452 rpc_pipe_ops|
4453 seq_operations|
4454 snd_ac97_build_ops|
4455 soc_pcmcia_socket_ops|
4456 stacktrace_ops|
4457 sysfs_ops|
4458 tty_operations|
4459 usb_mon_operations|
4460 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004461 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004462 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004463 WARN("CONST_STRUCT",
4464 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004465 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004466 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004467
4468# use of NR_CPUS is usually wrong
4469# ignore definitions of NR_CPUS and usage to define arrays as likely right
4470 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004471 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4472 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004473 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4474 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4475 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004476 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004477 WARN("NR_CPUS",
4478 "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 -07004479 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004480
Joe Perches52ea8502013-11-12 15:10:09 -08004481# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4482 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4483 ERROR("DEFINE_ARCH_HAS",
4484 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4485 }
4486
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004487# check for %L{u,d,i} in strings
4488 my $string;
4489 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4490 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004491 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004492 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004493 WARN("PRINTF_L",
4494 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004495 last;
4496 }
4497 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004498
4499# whine mightly about in_atomic
4500 if ($line =~ /\bin_atomic\s*\(/) {
4501 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004502 ERROR("IN_ATOMIC",
4503 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004504 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004505 WARN("IN_ATOMIC",
4506 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004507 }
4508 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004509
4510# check for lockdep_set_novalidate_class
4511 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4512 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4513 if ($realfile !~ m@^kernel/lockdep@ &&
4514 $realfile !~ m@^include/linux/lockdep@ &&
4515 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004516 ERROR("LOCKDEP",
4517 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004518 }
4519 }
Dave Jones88f88312011-01-12 16:59:59 -08004520
4521 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4522 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004523 WARN("EXPORTED_WORLD_WRITABLE",
4524 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004525 }
Joe Perches24358802014-04-03 14:49:13 -07004526
4527 foreach my $entry (@mode_permission_funcs) {
4528 my $func = $entry->[0];
4529 my $arg_pos = $entry->[1];
4530
4531 my $skip_args = "";
4532 if ($arg_pos > 1) {
4533 $arg_pos--;
4534 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4535 }
4536 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4537 if ($^V && $^V ge 5.10.0 &&
4538 $line =~ /$test/) {
4539 my $val = $1;
4540 $val = $6 if ($skip_args ne "");
4541
Joe Perches1727cc72014-04-03 14:49:15 -07004542 if ($val !~ /^0$/ &&
4543 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4544 length($val) ne 4)) {
Joe Perches24358802014-04-03 14:49:13 -07004545 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches1727cc72014-04-03 14:49:15 -07004546 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perches24358802014-04-03 14:49:13 -07004547 }
4548 }
4549 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004550 }
4551
4552 # If we have no input at all, then there is nothing to report on
4553 # so just keep quiet.
4554 if ($#rawlines == -1) {
4555 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004556 }
4557
Andy Whitcroft8905a672007-11-28 16:21:06 -08004558 # In mailback mode only produce a report in the negative, for
4559 # things that appear to be patches.
4560 if ($mailback && ($clean == 1 || !$is_patch)) {
4561 exit(0);
4562 }
4563
4564 # This is not a patch, and we are are in 'no-patch' mode so
4565 # just keep quiet.
4566 if (!$chk_patch && !$is_patch) {
4567 exit(0);
4568 }
4569
4570 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004571 ERROR("NOT_UNIFIED_DIFF",
4572 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004573 }
4574 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004575 ERROR("MISSING_SIGN_OFF",
4576 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004577 }
4578
Andy Whitcroft8905a672007-11-28 16:21:06 -08004579 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004580 if ($summary && !($clean == 1 && $quiet == 1)) {
4581 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004582 print "total: $cnt_error errors, $cnt_warn warnings, " .
4583 (($check)? "$cnt_chk checks, " : "") .
4584 "$cnt_lines lines checked\n";
4585 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004586 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004587
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004588 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004589
4590 if ($^V lt 5.10.0) {
4591 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4592 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4593 }
4594
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004595 # If there were whitespace errors which cleanpatch can fix
4596 # then suggest that.
4597 if ($rpt_cleaners) {
4598 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4599 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07004600 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004601 }
4602 }
4603
Joe Perches91bfe482013-09-11 14:23:59 -07004604 hash_show_words(\%use_type, "Used");
4605 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07004606
Joe Perches3705ce52013-07-03 15:05:31 -07004607 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
Joe Perches9624b8d2014-01-23 15:54:44 -08004608 my $newfile = $filename;
4609 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07004610 my $linecount = 0;
4611 my $f;
4612
4613 open($f, '>', $newfile)
4614 or die "$P: Can't open $newfile for write\n";
4615 foreach my $fixed_line (@fixed) {
4616 $linecount++;
4617 if ($file) {
4618 if ($linecount > 3) {
4619 $fixed_line =~ s/^\+//;
4620 print $f $fixed_line. "\n";
4621 }
4622 } else {
4623 print $f $fixed_line . "\n";
4624 }
4625 }
4626 close($f);
4627
4628 if (!$quiet) {
4629 print << "EOM";
4630Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4631
4632Do _NOT_ trust the results written to this file.
4633Do _NOT_ submit these changes without inspecting them for correctness.
4634
4635This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4636No warranties, expressed or implied...
4637
4638EOM
4639 }
4640 }
4641
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004642 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004643 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004644 }
4645 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004646 print << "EOM";
4647$vname has style problems, please review.
4648
4649If any of these errors are false positives, please report
4650them to the maintainer, see CHECKPATCH in MAINTAINERS.
4651EOM
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004652 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004653
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004654 return $clean;
4655}