blob: 646295cd99906a84ba384fa445b224bf208b8ba2 [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));
442 $string =~ s@^\s*\(\s*@@g;
443 $string =~ s@\s*\)\s*$@@g;
444 $string =~ s@\s+@ @g;
445 return $string;
446}
447
Joe Perches34456862013-07-03 15:05:34 -0700448sub seed_camelcase_file {
449 my ($file) = @_;
450
451 return if (!(-f $file));
452
453 local $/;
454
455 open(my $include_file, '<', "$file")
456 or warn "$P: Can't read '$file' $!\n";
457 my $text = <$include_file>;
458 close($include_file);
459
460 my @lines = split('\n', $text);
461
462 foreach my $line (@lines) {
463 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
464 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
465 $camelcase{$1} = 1;
Joe Perches11ea5162013-11-12 15:10:08 -0800466 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) {
467 $camelcase{$1} = 1;
468 } 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 -0700469 $camelcase{$1} = 1;
470 }
471 }
472}
473
474my $camelcase_seeded = 0;
475sub seed_camelcase_includes {
476 return if ($camelcase_seeded);
477
478 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700479 my $camelcase_cache = "";
480 my @include_files = ();
481
482 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700483
Richard Genoud3645e322014-02-10 14:25:32 -0800484 if (-e ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700485 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
486 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700487 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700488 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700489 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700490 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700491 @include_files = split('\n', $files);
492 foreach my $file (@include_files) {
493 my $date = POSIX::strftime("%Y%m%d%H%M",
494 localtime((stat $file)[9]));
495 $last_mod_date = $date if ($last_mod_date < $date);
496 }
497 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700498 }
Joe Perchesc707a812013-07-08 16:00:43 -0700499
500 if ($camelcase_cache ne "" && -f $camelcase_cache) {
501 open(my $camelcase_file, '<', "$camelcase_cache")
502 or warn "$P: Can't read '$camelcase_cache' $!\n";
503 while (<$camelcase_file>) {
504 chomp;
505 $camelcase{$_} = 1;
506 }
507 close($camelcase_file);
508
509 return;
510 }
511
Richard Genoud3645e322014-02-10 14:25:32 -0800512 if (-e ".git") {
Joe Perchesc707a812013-07-08 16:00:43 -0700513 $files = `git ls-files "include/*.h"`;
514 @include_files = split('\n', $files);
515 }
516
Joe Perches34456862013-07-03 15:05:34 -0700517 foreach my $file (@include_files) {
518 seed_camelcase_file($file);
519 }
Joe Perches351b2a12013-07-03 15:05:36 -0700520
Joe Perchesc707a812013-07-08 16:00:43 -0700521 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700522 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700523 open(my $camelcase_file, '>', "$camelcase_cache")
524 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700525 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
526 print $camelcase_file ("$_\n");
527 }
528 close($camelcase_file);
529 }
Joe Perches34456862013-07-03 15:05:34 -0700530}
531
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700532$chk_signoff = 0 if ($file);
533
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700534my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800535my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700536my @fixed = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800537my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700538for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800539 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700540 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800541 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700542 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800543 } elsif ($filename eq '-') {
544 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700545 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800546 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700547 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700548 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800549 if ($filename eq '-') {
550 $vname = 'Your patch';
551 } else {
552 $vname = $filename;
553 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800554 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700555 chomp;
556 push(@rawlines, $_);
557 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800558 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800559 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700560 $exit = 1;
561 }
562 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800563 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700564 @fixed = ();
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700565}
566
567exit($exit);
568
569sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700570 my ($root) = @_;
571
572 my @tree_check = (
573 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
574 "README", "Documentation", "arch", "include", "drivers",
575 "fs", "init", "ipc", "kernel", "lib", "scripts",
576 );
577
578 foreach my $check (@tree_check) {
579 if (! -e $root . '/' . $check) {
580 return 0;
581 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700582 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700583 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700584}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700585
Joe Perches20112472011-07-25 17:13:23 -0700586sub parse_email {
587 my ($formatted_email) = @_;
588
589 my $name = "";
590 my $address = "";
591 my $comment = "";
592
593 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
594 $name = $1;
595 $address = $2;
596 $comment = $3 if defined $3;
597 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
598 $address = $1;
599 $comment = $2 if defined $2;
600 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
601 $address = $1;
602 $comment = $2 if defined $2;
603 $formatted_email =~ s/$address.*$//;
604 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700605 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700606 $name =~ s/^\"|\"$//g;
607 # If there's a name left after stripping spaces and
608 # leading quotes, and the address doesn't have both
609 # leading and trailing angle brackets, the address
610 # is invalid. ie:
611 # "joe smith joe@smith.com" bad
612 # "joe smith <joe@smith.com" bad
613 if ($name ne "" && $address !~ /^<[^>]+>$/) {
614 $name = "";
615 $address = "";
616 $comment = "";
617 }
618 }
619
Joe Perches3705ce52013-07-03 15:05:31 -0700620 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700621 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700622 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700623 $address =~ s/^\<|\>$//g;
624
625 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
626 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
627 $name = "\"$name\"";
628 }
629
630 return ($name, $address, $comment);
631}
632
633sub format_email {
634 my ($name, $address) = @_;
635
636 my $formatted_email;
637
Joe Perches3705ce52013-07-03 15:05:31 -0700638 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700639 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700640 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700641
642 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
643 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
644 $name = "\"$name\"";
645 }
646
647 if ("$name" eq "") {
648 $formatted_email = "$address";
649 } else {
650 $formatted_email = "$name <$address>";
651 }
652
653 return $formatted_email;
654}
655
Joe Perches000d1cc12011-07-25 17:13:25 -0700656sub which_conf {
657 my ($conf) = @_;
658
659 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
660 if (-e "$path/$conf") {
661 return "$path/$conf";
662 }
663 }
664
665 return "";
666}
667
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700668sub expand_tabs {
669 my ($str) = @_;
670
671 my $res = '';
672 my $n = 0;
673 for my $c (split(//, $str)) {
674 if ($c eq "\t") {
675 $res .= ' ';
676 $n++;
677 for (; ($n % 8) != 0; $n++) {
678 $res .= ' ';
679 }
680 next;
681 }
682 $res .= $c;
683 $n++;
684 }
685
686 return $res;
687}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700688sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700689 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700690 return $res;
691}
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -0700692
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700693sub line_stats {
694 my ($line) = @_;
695
696 # Drop the diff line leader and expand tabs
697 $line =~ s/^.//;
698 $line = expand_tabs($line);
699
700 # Pick the indent from the front of the line.
701 my ($white) = ($line =~ /^(\s*)/);
702
703 return (length($line), length($white));
704}
705
Andy Whitcroft773647a2008-03-28 14:15:58 -0700706my $sanitise_quote = '';
707
708sub sanitise_line_reset {
709 my ($in_comment) = @_;
710
711 if ($in_comment) {
712 $sanitise_quote = '*/';
713 } else {
714 $sanitise_quote = '';
715 }
716}
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700717sub sanitise_line {
718 my ($line) = @_;
719
720 my $res = '';
721 my $l = '';
722
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800723 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700724 my $off = 0;
725 my $c;
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700726
Andy Whitcroft773647a2008-03-28 14:15:58 -0700727 # Always copy over the diff marker.
728 $res = substr($line, 0, 1);
729
730 for ($off = 1; $off < length($line); $off++) {
731 $c = substr($line, $off, 1);
732
733 # Comments we are wacking completly including the begin
734 # and end, all to $;.
735 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
736 $sanitise_quote = '*/';
737
738 substr($res, $off, 2, "$;$;");
739 $off++;
740 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800741 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700742 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700743 $sanitise_quote = '';
744 substr($res, $off, 2, "$;$;");
745 $off++;
746 next;
747 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700748 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
749 $sanitise_quote = '//';
750
751 substr($res, $off, 2, $sanitise_quote);
752 $off++;
753 next;
754 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700755
756 # A \ in a string means ignore the next character.
757 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
758 $c eq "\\") {
759 substr($res, $off, 2, 'XX');
760 $off++;
761 next;
762 }
763 # Regular quotes.
764 if ($c eq "'" || $c eq '"') {
765 if ($sanitise_quote eq '') {
766 $sanitise_quote = $c;
767
768 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700769 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700770 } elsif ($sanitise_quote eq $c) {
771 $sanitise_quote = '';
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700772 }
773 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700774
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800775 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700776 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
777 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700778 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
779 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700780 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
781 substr($res, $off, 1, 'X');
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700782 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700783 substr($res, $off, 1, $c);
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700784 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800785 }
786
Daniel Walker113f04a2009-09-21 17:04:35 -0700787 if ($sanitise_quote eq '//') {
788 $sanitise_quote = '';
789 }
790
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800791 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700792 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800793 my $clean = 'X' x length($1);
794 $res =~ s@\<.*\>@<$clean>@;
795
796 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700797 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800798 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700799 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800800 }
801
Andy Whitcroft00df344f2007-06-08 13:47:06 -0700802 return $res;
803}
804
Joe Perchesa6962d72013-04-29 16:18:13 -0700805sub get_quoted_string {
806 my ($line, $rawline) = @_;
807
808 return "" if ($line !~ m/(\"[X]+\")/g);
809 return substr($rawline, $-[0], $+[0] - $-[0]);
810}
811
Andy Whitcroft8905a672007-11-28 16:21:06 -0800812sub ctx_statement_block {
813 my ($linenr, $remain, $off) = @_;
814 my $line = $linenr - 1;
815 my $blk = '';
816 my $soff = $off;
817 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700818 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800819
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800820 my $loff = 0;
821
Andy Whitcroft8905a672007-11-28 16:21:06 -0800822 my $type = '';
823 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800824 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800825 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800826 my $c;
827 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800828
829 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800830 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800831 @stack = (['', 0]) if ($#stack == -1);
832
Andy Whitcroft773647a2008-03-28 14:15:58 -0700833 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800834 # If we are about to drop off the end, pull in more
835 # context.
836 if ($off >= $len) {
837 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700838 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800839 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800840 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800841 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800842 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800843 $len = length($blk);
844 $line++;
845 last;
846 }
847 # Bail if there is no further context.
848 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800849 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800850 last;
851 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800852 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
853 $level++;
854 $type = '#';
855 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800856 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800857 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800858 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800859 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800860
Andy Whitcroft773647a2008-03-28 14:15:58 -0700861 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800862
863 # Handle nested #if/#else.
864 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
865 push(@stack, [ $type, $level ]);
866 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
867 ($type, $level) = @{$stack[$#stack - 1]};
868 } elsif ($remainder =~ /^#\s*endif\b/) {
869 ($type, $level) = @{pop(@stack)};
870 }
871
Andy Whitcroft8905a672007-11-28 16:21:06 -0800872 # Statement ends at the ';' or a close '}' at the
873 # outermost level.
874 if ($level == 0 && $c eq ';') {
875 last;
876 }
877
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800878 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700879 if ($level == 0 && $coff_set == 0 &&
880 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
881 $remainder =~ /^(else)(?:\s|{)/ &&
882 $remainder !~ /^else\s+if\b/) {
883 $coff = $off + length($1) - 1;
884 $coff_set = 1;
885 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
886 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800887 }
888
Andy Whitcroft8905a672007-11-28 16:21:06 -0800889 if (($type eq '' || $type eq '(') && $c eq '(') {
890 $level++;
891 $type = '(';
892 }
893 if ($type eq '(' && $c eq ')') {
894 $level--;
895 $type = ($level != 0)? '(' : '';
896
897 if ($level == 0 && $coff < $soff) {
898 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700899 $coff_set = 1;
900 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800901 }
902 }
903 if (($type eq '' || $type eq '{') && $c eq '{') {
904 $level++;
905 $type = '{';
906 }
907 if ($type eq '{' && $c eq '}') {
908 $level--;
909 $type = ($level != 0)? '{' : '';
910
911 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700912 if (substr($blk, $off + 1, 1) eq ';') {
913 $off++;
914 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800915 last;
916 }
917 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800918 # Preprocessor commands end at the newline unless escaped.
919 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
920 $level--;
921 $type = '';
922 $off++;
923 last;
924 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800925 $off++;
926 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700927 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800928 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700929 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800930 $line++;
931 $remain--;
932 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800933
934 my $statement = substr($blk, $soff, $off - $soff + 1);
935 my $condition = substr($blk, $soff, $coff - $soff + 1);
936
937 #warn "STATEMENT<$statement>\n";
938 #warn "CONDITION<$condition>\n";
939
Andy Whitcroft773647a2008-03-28 14:15:58 -0700940 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800941
942 return ($statement, $condition,
943 $line, $remain + 1, $off - $loff + 1, $level);
944}
945
Andy Whitcroftcf655042008-03-04 14:28:20 -0800946sub statement_lines {
947 my ($stmt) = @_;
948
949 # Strip the diff line prefixes and rip blank lines at start and end.
950 $stmt =~ s/(^|\n)./$1/g;
951 $stmt =~ s/^\s*//;
952 $stmt =~ s/\s*$//;
953
954 my @stmt_lines = ($stmt =~ /\n/g);
955
956 return $#stmt_lines + 2;
957}
958
959sub statement_rawlines {
960 my ($stmt) = @_;
961
962 my @stmt_lines = ($stmt =~ /\n/g);
963
964 return $#stmt_lines + 2;
965}
966
967sub statement_block_size {
968 my ($stmt) = @_;
969
970 $stmt =~ s/(^|\n)./$1/g;
971 $stmt =~ s/^\s*{//;
972 $stmt =~ s/}\s*$//;
973 $stmt =~ s/^\s*//;
974 $stmt =~ s/\s*$//;
975
976 my @stmt_lines = ($stmt =~ /\n/g);
977 my @stmt_statements = ($stmt =~ /;/g);
978
979 my $stmt_lines = $#stmt_lines + 2;
980 my $stmt_statements = $#stmt_statements + 1;
981
982 if ($stmt_lines > $stmt_statements) {
983 return $stmt_lines;
984 } else {
985 return $stmt_statements;
986 }
987}
988
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800989sub ctx_statement_full {
990 my ($linenr, $remain, $off) = @_;
991 my ($statement, $condition, $level);
992
993 my (@chunks);
994
Andy Whitcroftcf655042008-03-04 14:28:20 -0800995 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800996 ($statement, $condition, $linenr, $remain, $off, $level) =
997 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700998 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800999 push(@chunks, [ $condition, $statement ]);
1000 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
1001 return ($level, $linenr, @chunks);
1002 }
1003
1004 # Pull in the following conditional/block pairs and see if they
1005 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001006 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001007 ($statement, $condition, $linenr, $remain, $off, $level) =
1008 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001009 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07001010 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -08001011 #print "C: push\n";
1012 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001013 }
1014
1015 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001016}
1017
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001018sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001019 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001020 my $line;
1021 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001022 my $blk = '';
1023 my @o;
1024 my @c;
1025 my @res = ();
1026
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001027 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001028 my @stack = ($level);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001029 for ($line = $start; $remain > 0; $line++) {
1030 next if ($rawlines[$line] =~ /^-/);
1031 $remain--;
1032
1033 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001034
1035 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001036 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001037 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001038 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001039 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001040 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001041 $level = pop(@stack);
1042 }
1043
Andy Whitcroft01464f32010-10-26 14:23:19 -07001044 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001045 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1046 if ($off > 0) {
1047 $off--;
1048 next;
1049 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001050
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001051 if ($c eq $close && $level > 0) {
1052 $level--;
1053 last if ($level == 0);
1054 } elsif ($c eq $open) {
1055 $level++;
1056 }
1057 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001058
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001059 if (!$outer || $level <= 1) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001060 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001061 }
1062
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001063 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001064 }
1065
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001066 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001067}
1068sub ctx_block_outer {
1069 my ($linenr, $remain) = @_;
1070
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001071 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1072 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001073}
1074sub ctx_block {
1075 my ($linenr, $remain) = @_;
1076
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001077 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1078 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001079}
1080sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001081 my ($linenr, $remain, $off) = @_;
1082
1083 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1084 return @r;
1085}
1086sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001087 my ($linenr, $remain) = @_;
1088
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001089 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001090}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001091sub ctx_statement_level {
1092 my ($linenr, $remain, $off) = @_;
1093
1094 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1095}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001096
1097sub ctx_locate_comment {
1098 my ($first_line, $end_line) = @_;
1099
1100 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001101 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001102 return $current_comment if (defined $current_comment);
1103
1104 # Look through the context and try and figure out if there is a
1105 # comment.
1106 my $in_comment = 0;
1107 $current_comment = '';
1108 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001109 my $line = $rawlines[$linenr - 1];
1110 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001111 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1112 $in_comment = 1;
1113 }
1114 if ($line =~ m@/\*@) {
1115 $in_comment = 1;
1116 }
1117 if (!$in_comment && $current_comment ne '') {
1118 $current_comment = '';
1119 }
1120 $current_comment .= $line . "\n" if ($in_comment);
1121 if ($line =~ m@\*/@) {
1122 $in_comment = 0;
1123 }
1124 }
1125
1126 chomp($current_comment);
1127 return($current_comment);
1128}
1129sub ctx_has_comment {
1130 my ($first_line, $end_line) = @_;
1131 my $cmt = ctx_locate_comment($first_line, $end_line);
1132
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001133 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001134 ##print "CMMT: $cmt\n";
1135
1136 return ($cmt ne '');
1137}
1138
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001139sub raw_line {
1140 my ($linenr, $cnt) = @_;
1141
1142 my $offset = $linenr - 1;
1143 $cnt++;
1144
1145 my $line;
1146 while ($cnt) {
1147 $line = $rawlines[$offset++];
1148 next if (defined($line) && $line =~ /^-/);
1149 $cnt--;
1150 }
1151
1152 return $line;
1153}
1154
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001155sub cat_vet {
1156 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001157 my ($res, $coded);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001158
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001159 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001160 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1161 $res .= $1;
1162 if ($2 ne '') {
1163 $coded = sprintf("^%c", unpack('C', $2) + 64);
1164 $res .= $coded;
1165 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001166 }
1167 $res =~ s/$/\$/;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001168
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001169 return $res;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001170}
1171
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001172my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001173my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001174my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001175my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001176
1177sub annotate_reset {
1178 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001179 $av_pending = '_';
1180 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001181 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001182}
1183
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001184sub annotate_values {
1185 my ($stream, $type) = @_;
1186
1187 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001188 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001189 my $cur = $stream;
1190
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001191 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001192
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001193 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001194 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001195 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001196 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001197 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001198 print "WS($1)\n" if ($dbg_values > 1);
1199 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001200 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001201 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001202 }
1203
Florian Micklerc023e4732011-01-12 16:59:58 -08001204 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001205 print "CAST($1)\n" if ($dbg_values > 1);
1206 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001207 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001208
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001209 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001210 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001211 $type = 'T';
1212
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001213 } elsif ($cur =~ /^($Modifier)\s*/) {
1214 print "MODIFIER($1)\n" if ($dbg_values > 1);
1215 $type = 'T';
1216
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001217 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001218 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001219 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001220 push(@av_paren_type, $type);
1221 if ($2 ne '') {
1222 $av_pending = 'N';
1223 }
1224 $type = 'E';
1225
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001226 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001227 print "UNDEF($1)\n" if ($dbg_values > 1);
1228 $av_preprocessor = 1;
1229 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001230
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001231 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001232 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001233 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001234
1235 push(@av_paren_type, $type);
1236 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001237 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001238
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001239 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001240 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1241 $av_preprocessor = 1;
1242
1243 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1244
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001245 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001246
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001247 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001248 print "PRE_END($1)\n" if ($dbg_values > 1);
1249
1250 $av_preprocessor = 1;
1251
1252 # Assume all arms of the conditional end as this
1253 # one does, and continue as if the #endif was not here.
1254 pop(@av_paren_type);
1255 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001256 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001257
1258 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001259 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001260
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001261 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1262 print "ATTR($1)\n" if ($dbg_values > 1);
1263 $av_pending = $type;
1264 $type = 'N';
1265
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001266 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001267 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001268 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001269 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001270 }
1271 $type = 'N';
1272
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001273 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001274 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001275 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001276 $type = 'N';
1277
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001278 } elsif ($cur =~/^(case)/o) {
1279 print "CASE($1)\n" if ($dbg_values > 1);
1280 $av_pend_colon = 'C';
1281 $type = 'N';
1282
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001283 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001284 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001285 $type = 'N';
1286
1287 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001288 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001289 push(@av_paren_type, $av_pending);
1290 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001291 $type = 'N';
1292
1293 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001294 my $new_type = pop(@av_paren_type);
1295 if ($new_type ne '_') {
1296 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001297 print "PAREN('$1') -> $type\n"
1298 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001299 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001300 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001301 }
1302
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001303 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001304 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001305 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001306 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001307
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001308 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1309 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001310 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001311 } elsif ($type eq 'E') {
1312 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001313 }
1314 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1315 $type = 'V';
1316
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001317 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001318 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001319 $type = 'V';
1320
1321 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001322 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001323 $type = 'N';
1324
Andy Whitcroftcf655042008-03-04 14:28:20 -08001325 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001326 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001327 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001328 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001329
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001330 } elsif ($cur =~/^(,)/) {
1331 print "COMMA($1)\n" if ($dbg_values > 1);
1332 $type = 'C';
1333
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001334 } elsif ($cur =~ /^(\?)/o) {
1335 print "QUESTION($1)\n" if ($dbg_values > 1);
1336 $type = 'N';
1337
1338 } elsif ($cur =~ /^(:)/o) {
1339 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1340
1341 substr($var, length($res), 1, $av_pend_colon);
1342 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1343 $type = 'E';
1344 } else {
1345 $type = 'N';
1346 }
1347 $av_pend_colon = 'O';
1348
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001349 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001350 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001351 $type = 'N';
1352
Andy Whitcroft0d413862008-10-15 22:02:16 -07001353 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001354 my $variant;
1355
1356 print "OPV($1)\n" if ($dbg_values > 1);
1357 if ($type eq 'V') {
1358 $variant = 'B';
1359 } else {
1360 $variant = 'U';
1361 }
1362
1363 substr($var, length($res), 1, $variant);
1364 $type = 'N';
1365
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001366 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001367 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001368 if ($1 ne '++' && $1 ne '--') {
1369 $type = 'N';
1370 }
1371
1372 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001373 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001374 }
1375 if (defined $1) {
1376 $cur = substr($cur, length($1));
1377 $res .= $type x length($1);
1378 }
1379 }
1380
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001381 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001382}
1383
Andy Whitcroft8905a672007-11-28 16:21:06 -08001384sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001385 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001386 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001387 ^(?:
1388 $Modifier|
1389 $Storage|
1390 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001391 DEFINE_\S+
1392 )$|
1393 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001394 goto|
1395 return|
1396 case|
1397 else|
1398 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001399 do|
1400 \#|
1401 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001402 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001403 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001404 )}x;
1405 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1406 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001407 # Check for modifiers.
1408 $possible =~ s/\s*$Storage\s*//g;
1409 $possible =~ s/\s*$Sparse\s*//g;
1410 if ($possible =~ /^\s*$/) {
1411
1412 } elsif ($possible =~ /\s/) {
1413 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001414 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001415 if ($modifier !~ $notPermitted) {
1416 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1417 push(@modifierList, $modifier);
1418 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001419 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001420
1421 } else {
1422 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1423 push(@typeList, $possible);
1424 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001425 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001426 } else {
1427 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001428 }
1429}
1430
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001431my $prefix = '';
1432
Joe Perches000d1cc12011-07-25 17:13:25 -07001433sub show_type {
Joe Perches91bfe482013-09-11 14:23:59 -07001434 return defined $use_type{$_[0]} if (scalar keys %use_type > 0);
1435
1436 return !defined $ignore_type{$_[0]};
Joe Perches000d1cc12011-07-25 17:13:25 -07001437}
1438
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001439sub report {
Joe Perches000d1cc12011-07-25 17:13:25 -07001440 if (!show_type($_[1]) ||
1441 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001442 return 0;
1443 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001444 my $line;
1445 if ($show_types) {
1446 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1447 } else {
1448 $line = "$prefix$_[0]: $_[2]\n";
1449 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001450 $line = (split('\n', $line))[0] . "\n" if ($terse);
1451
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001452 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001453
1454 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001455}
1456sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001457 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001458}
Joe Perches000d1cc12011-07-25 17:13:25 -07001459
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001460sub ERROR {
Joe Perches000d1cc12011-07-25 17:13:25 -07001461 if (report("ERROR", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001462 our $clean = 0;
1463 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001464 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001465 }
Joe Perches3705ce52013-07-03 15:05:31 -07001466 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001467}
1468sub WARN {
Joe Perches000d1cc12011-07-25 17:13:25 -07001469 if (report("WARNING", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001470 our $clean = 0;
1471 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001472 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001473 }
Joe Perches3705ce52013-07-03 15:05:31 -07001474 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001475}
1476sub CHK {
Joe Perches000d1cc12011-07-25 17:13:25 -07001477 if ($check && report("CHECK", $_[0], $_[1])) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001478 our $clean = 0;
1479 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001480 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001481 }
Joe Perches3705ce52013-07-03 15:05:31 -07001482 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001483}
1484
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001485sub check_absolute_file {
1486 my ($absolute, $herecurr) = @_;
1487 my $file = $absolute;
1488
1489 ##print "absolute<$absolute>\n";
1490
1491 # See if any suffix of this path is a path within the tree.
1492 while ($file =~ s@^[^/]*/@@) {
1493 if (-f "$root/$file") {
1494 ##print "file<$file>\n";
1495 last;
1496 }
1497 }
1498 if (! -f _) {
1499 return 0;
1500 }
1501
1502 # It is, so see if the prefix is acceptable.
1503 my $prefix = $absolute;
1504 substr($prefix, -length($file)) = '';
1505
1506 ##print "prefix<$prefix>\n";
1507 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001508 WARN("USE_RELATIVE_PATH",
1509 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001510 }
1511}
1512
Joe Perches3705ce52013-07-03 15:05:31 -07001513sub trim {
1514 my ($string) = @_;
1515
Joe Perchesb34c6482013-09-11 14:24:01 -07001516 $string =~ s/^\s+|\s+$//g;
1517
1518 return $string;
1519}
1520
1521sub ltrim {
1522 my ($string) = @_;
1523
1524 $string =~ s/^\s+//;
1525
1526 return $string;
1527}
1528
1529sub rtrim {
1530 my ($string) = @_;
1531
1532 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001533
1534 return $string;
1535}
1536
Joe Perches52ea8502013-11-12 15:10:09 -08001537sub string_find_replace {
1538 my ($string, $find, $replace) = @_;
1539
1540 $string =~ s/$find/$replace/g;
1541
1542 return $string;
1543}
1544
Joe Perches3705ce52013-07-03 15:05:31 -07001545sub tabify {
1546 my ($leading) = @_;
1547
1548 my $source_indent = 8;
1549 my $max_spaces_before_tab = $source_indent - 1;
1550 my $spaces_to_tab = " " x $source_indent;
1551
1552 #convert leading spaces to tabs
1553 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1554 #Remove spaces before a tab
1555 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1556
1557 return "$leading";
1558}
1559
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001560sub pos_last_openparen {
1561 my ($line) = @_;
1562
1563 my $pos = 0;
1564
1565 my $opens = $line =~ tr/\(/\(/;
1566 my $closes = $line =~ tr/\)/\)/;
1567
1568 my $last_openparen = 0;
1569
1570 if (($opens == 0) || ($closes >= $opens)) {
1571 return -1;
1572 }
1573
1574 my $len = length($line);
1575
1576 for ($pos = 0; $pos < $len; $pos++) {
1577 my $string = substr($line, $pos);
1578 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1579 $pos += length($1) - 1;
1580 } elsif (substr($line, $pos, 1) eq '(') {
1581 $last_openparen = $pos;
1582 } elsif (index($string, '(') == -1) {
1583 last;
1584 }
1585 }
1586
1587 return $last_openparen + 1;
1588}
1589
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001590sub process {
1591 my $filename = shift;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001592
1593 my $linenr=0;
1594 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001595 my $prevrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001596 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001597 my $stashrawline="";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001598
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001599 my $length;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001600 my $indent;
1601 my $previndent=0;
1602 my $stashindent=0;
1603
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001604 our $clean = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001605 my $signoff = 0;
1606 my $is_patch = 0;
1607
Joe Perches15662b32011-10-31 17:13:12 -07001608 my $in_header_lines = 1;
1609 my $in_commit_log = 0; #Scanning lines before patch
1610
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001611 my $non_utf8_charset = 0;
1612
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001613 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001614 our $cnt_lines = 0;
1615 our $cnt_error = 0;
1616 our $cnt_warn = 0;
1617 our $cnt_chk = 0;
1618
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001619 # Trace the real file/line as we go.
1620 my $realfile = '';
1621 my $realline = 0;
1622 my $realcnt = 0;
1623 my $here = '';
1624 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001625 my $comment_edge = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001626 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001627 my $p1_prefix = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001628
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001629 my $prev_values = 'E';
1630
1631 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001632 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001633 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001634 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001635 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001636
Joe Perches7e51f192013-09-11 14:23:57 -07001637 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001638
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001639 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001640 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001641 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001642 my @setup_docs = ();
1643 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001644
Joe Perchesd8b07712013-11-12 15:10:06 -08001645 my $camelcase_file_seeded = 0;
1646
Andy Whitcroft773647a2008-03-28 14:15:58 -07001647 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001648 my $line;
1649 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001650 $linenr++;
1651 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001652
Joe Perches3705ce52013-07-03 15:05:31 -07001653 push(@fixed, $rawline) if ($fix);
1654
Andy Whitcroft773647a2008-03-28 14:15:58 -07001655 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001656 $setup_docs = 0;
1657 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1658 $setup_docs = 1;
1659 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001660 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001661 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001662 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1663 $realline=$1-1;
1664 if (defined $2) {
1665 $realcnt=$3+1;
1666 } else {
1667 $realcnt=1+1;
1668 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001669 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001670
1671 # Guestimate if this is a continuing comment. Run
1672 # the context looking for a comment "edge". If this
1673 # edge is a close comment then we must be in a comment
1674 # at context start.
1675 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001676 my $cnt = $realcnt;
1677 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1678 next if (defined $rawlines[$ln - 1] &&
1679 $rawlines[$ln - 1] =~ /^-/);
1680 $cnt--;
1681 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001682 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001683 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1684 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1685 ($edge) = $1;
1686 last;
1687 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001688 }
1689 if (defined $edge && $edge eq '*/') {
1690 $in_comment = 1;
1691 }
1692
1693 # Guestimate if this is a continuing comment. If this
1694 # is the start of a diff block and this line starts
1695 # ' *' then it is very likely a comment.
1696 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001697 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001698 {
1699 $in_comment = 1;
1700 }
1701
1702 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1703 sanitise_line_reset($in_comment);
1704
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001705 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001706 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001707 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001708 $line = sanitise_line($rawline);
1709 }
1710 push(@lines, $line);
1711
1712 if ($realcnt > 1) {
1713 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1714 } else {
1715 $realcnt = 0;
1716 }
1717
1718 #print "==>$rawline\n";
1719 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001720
1721 if ($setup_docs && $line =~ /^\+/) {
1722 push(@setup_docs, $line);
1723 }
1724 }
1725
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001726 $prefix = '';
1727
Andy Whitcroft773647a2008-03-28 14:15:58 -07001728 $realcnt = 0;
1729 $linenr = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001730 foreach my $line (@lines) {
1731 $linenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001732 my $sline = $line; #copy of $line
1733 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001734
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001735 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001736
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001737#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001738 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001739 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001740 $first_line = $linenr + 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001741 $realline=$1-1;
1742 if (defined $2) {
1743 $realcnt=$3+1;
1744 } else {
1745 $realcnt=1+1;
1746 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001747 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001748 $prev_values = 'E';
1749
Andy Whitcroft773647a2008-03-28 14:15:58 -07001750 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001751 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001752 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001753 $suppress_statement = 0;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001754 next;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001755
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001756# track the line number as we move through the hunk, note that
1757# new versions of GNU diff omit the leading space on completely
1758# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001759 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001760 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001761 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001762
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001763 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001764 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001765
1766 # Track the previous line.
1767 ($prevline, $stashline) = ($stashline, $line);
1768 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001769 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1770
Andy Whitcroft773647a2008-03-28 14:15:58 -07001771 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001772
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001773 } elsif ($realcnt == 1) {
1774 $realcnt--;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001775 }
1776
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001777 my $hunk_line = ($realcnt != 0);
1778
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001779#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001780 $prefix = "$filename:$realline: " if ($emacs && $file);
1781 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1782
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001783 $here = "#$linenr: " if (!$file);
1784 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001785
1786 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001787 if ($line =~ /^diff --git.*?(\S+)$/) {
1788 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001789 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001790 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001791 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001792 $realfile = $1;
Joe Perches2b7ab452013-11-12 15:10:14 -08001793 $realfile =~ s@^([^/]*)/@@ if (!$file);
Joe Perches270c49a2012-01-10 15:09:50 -08001794 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001795
1796 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001797 if (!$file && $tree && $p1_prefix ne '' &&
1798 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001799 WARN("PATCH_PREFIX",
1800 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001801 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001802
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001803 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001804 ERROR("MODIFIED_INCLUDE_ASM",
1805 "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 -07001806 }
1807 next;
1808 }
1809
Randy Dunlap389834b2007-06-08 13:47:03 -07001810 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001811
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001812 my $hereline = "$here\n$rawline\n";
1813 my $herecurr = "$here\n$rawline\n";
1814 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001815
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001816 $cnt_lines++ if ($realcnt != 0);
1817
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001818# Check for incorrect file permissions
1819 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1820 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001821 if ($realfile !~ m@scripts/@ &&
1822 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001823 ERROR("EXECUTE_PERMISSIONS",
1824 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001825 }
1826 }
1827
Joe Perches20112472011-07-25 17:13:23 -07001828# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001829 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001830 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001831 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001832 }
1833
1834# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001835 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001836 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001837 my $space_before = $1;
1838 my $sign_off = $2;
1839 my $space_after = $3;
1840 my $email = $4;
1841 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1842
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001843 if ($sign_off !~ /$signature_tags/) {
1844 WARN("BAD_SIGN_OFF",
1845 "Non-standard signature: $sign_off\n" . $herecurr);
1846 }
Joe Perches20112472011-07-25 17:13:23 -07001847 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07001848 if (WARN("BAD_SIGN_OFF",
1849 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1850 $fix) {
1851 $fixed[$linenr - 1] =
1852 "$ucfirst_sign_off $email";
1853 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001854 }
Joe Perches20112472011-07-25 17:13:23 -07001855 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07001856 if (WARN("BAD_SIGN_OFF",
1857 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1858 $fix) {
1859 $fixed[$linenr - 1] =
1860 "$ucfirst_sign_off $email";
1861 }
1862
Joe Perches20112472011-07-25 17:13:23 -07001863 }
1864 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07001865 if (WARN("BAD_SIGN_OFF",
1866 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1867 $fix) {
1868 $fixed[$linenr - 1] =
1869 "$ucfirst_sign_off $email";
1870 }
Joe Perches20112472011-07-25 17:13:23 -07001871 }
1872
1873 my ($email_name, $email_address, $comment) = parse_email($email);
1874 my $suggested_email = format_email(($email_name, $email_address));
1875 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001876 ERROR("BAD_SIGN_OFF",
1877 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001878 } else {
1879 my $dequoted = $suggested_email;
1880 $dequoted =~ s/^"//;
1881 $dequoted =~ s/" </ </;
1882 # Don't force email to have quotes
1883 # Allow just an angle bracketed address
1884 if ("$dequoted$comment" ne $email &&
1885 "<$email_address>$comment" ne $email &&
1886 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001887 WARN("BAD_SIGN_OFF",
1888 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001889 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001890 }
Joe Perches7e51f192013-09-11 14:23:57 -07001891
1892# Check for duplicate signatures
1893 my $sig_nospace = $line;
1894 $sig_nospace =~ s/\s//g;
1895 $sig_nospace = lc($sig_nospace);
1896 if (defined $signatures{$sig_nospace}) {
1897 WARN("BAD_SIGN_OFF",
1898 "Duplicate signature\n" . $herecurr);
1899 } else {
1900 $signatures{$sig_nospace} = 1;
1901 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001902 }
1903
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001904# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001905 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001906 ERROR("CORRUPTED_PATCH",
1907 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001908 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001909 }
1910
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001911# Check for absolute kernel paths.
1912 if ($tree) {
1913 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1914 my $file = $1;
1915
1916 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1917 check_absolute_file($1, $herecurr)) {
1918 #
1919 } else {
1920 check_absolute_file($file, $herecurr);
1921 }
1922 }
1923 }
1924
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001925# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1926 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001927 $rawline !~ m/^$UTF8*$/) {
1928 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1929
1930 my $blank = copy_spacing($rawline);
1931 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1932 my $hereptr = "$hereline$ptr\n";
1933
Joe Perches34d99212011-07-25 17:13:26 -07001934 CHK("INVALID_UTF8",
1935 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001936 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001937
Joe Perches15662b32011-10-31 17:13:12 -07001938# Check if it's the start of a commit log
1939# (not a header line and we haven't seen the patch filename)
1940 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001941 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001942 $in_header_lines = 0;
1943 $in_commit_log = 1;
1944 }
1945
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001946# Check if there is UTF-8 in a commit log when a mail header has explicitly
1947# declined it, i.e defined some charset where it is missing.
1948 if ($in_header_lines &&
1949 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1950 $1 !~ /utf-8/i) {
1951 $non_utf8_charset = 1;
1952 }
1953
1954 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001955 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001956 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001957 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1958 }
1959
Andy Whitcroft306708542008-10-15 22:02:28 -07001960# ignore non-hunk lines and lines being removed
1961 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07001962
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001963#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001964 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001965 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07001966 if (ERROR("DOS_LINE_ENDINGS",
1967 "DOS line endings\n" . $herevet) &&
1968 $fix) {
1969 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
1970 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001971 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1972 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07001973 if (ERROR("TRAILING_WHITESPACE",
1974 "trailing whitespace\n" . $herevet) &&
1975 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07001976 $fixed[$linenr - 1] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001977 }
1978
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001979 $rpt_cleaners = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07001980 }
Andy Whitcroft5368df202008-10-15 22:02:27 -07001981
Josh Triplett4783f892013-11-12 15:10:12 -08001982# Check for FSF mailing addresses.
Alexander Duyck109d8cb22014-01-23 15:54:50 -08001983 if ($rawline =~ /\bwrite to the Free/i ||
Joe Perches3e2232f2014-01-23 15:54:48 -08001984 $rawline =~ /\b59\s+Temple\s+Pl/i ||
1985 $rawline =~ /\b51\s+Franklin\s+St/i) {
Josh Triplett4783f892013-11-12 15:10:12 -08001986 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1987 my $msg_type = \&ERROR;
1988 $msg_type = \&CHK if ($file);
1989 &{$msg_type}("FSF_MAILING_ADDRESS",
Joe Perches3e2232f2014-01-23 15:54:48 -08001990 "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 -08001991 }
1992
Andi Kleen33549572010-05-24 14:33:29 -07001993# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001994# Only applies when adding the entry originally, after that we do not have
1995# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07001996 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08001997 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07001998 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001999 my $cnt = $realcnt;
2000 my $ln = $linenr + 1;
2001 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002002 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002003 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08002004 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002005 $f = $lines[$ln - 1];
2006 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2007 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002008
2009 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08002010
2011 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
2012 $is_start = 1;
2013 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
2014 $length = -1;
2015 }
2016
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002017 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07002018 $f =~ s/#.*//;
2019 $f =~ s/^\s+//;
2020 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07002021 if ($f =~ /^\s*config\s/) {
2022 $is_end = 1;
2023 last;
2024 }
Andi Kleen33549572010-05-24 14:33:29 -07002025 $length++;
2026 }
Joe Perches000d1cc12011-07-25 17:13:25 -07002027 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08002028 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2029 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07002030 }
2031
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002032# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2033 if ($realfile =~ /Kconfig/ &&
2034 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
2035 WARN("CONFIG_EXPERIMENTAL",
2036 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2037 }
2038
Arnaud Lacombec68e5872011-08-15 01:07:14 -04002039 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
2040 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
2041 my $flag = $1;
2042 my $replacement = {
2043 'EXTRA_AFLAGS' => 'asflags-y',
2044 'EXTRA_CFLAGS' => 'ccflags-y',
2045 'EXTRA_CPPFLAGS' => 'cppflags-y',
2046 'EXTRA_LDFLAGS' => 'ldflags-y',
2047 };
2048
2049 WARN("DEPRECATED_VARIABLE",
2050 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2051 }
2052
Rob Herringbff5da42014-01-23 15:54:51 -08002053# check for DT compatible documentation
2054 if (defined $root && $realfile =~ /\.dts/ &&
2055 $rawline =~ /^\+\s*compatible\s*=/) {
2056 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g;
2057
2058 foreach my $compat (@compats) {
2059 my $compat2 = $compat;
2060 my $dt_path = $root . "/Documentation/devicetree/bindings/";
2061 $compat2 =~ s/\,[a-z]*\-/\,<\.\*>\-/;
2062 `grep -Erq "$compat|$compat2" $dt_path`;
2063 if ( $? >> 8 ) {
2064 WARN("UNDOCUMENTED_DT_STRING",
2065 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr);
2066 }
2067
2068 my $vendor = $compat;
2069 my $vendor_path = $dt_path . "vendor-prefixes.txt";
2070 next if (! -f $vendor_path);
2071 $vendor =~ s/^([a-zA-Z0-9]+)\,.*/$1/;
2072 `grep -Eq "$vendor" $vendor_path`;
2073 if ( $? >> 8 ) {
2074 WARN("UNDOCUMENTED_DT_STRING",
2075 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vendor_path\n" . $herecurr);
2076 }
2077 }
2078 }
2079
Andy Whitcroft5368df202008-10-15 22:02:27 -07002080# check we are in a valid source file if not then ignore this hunk
2081 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2082
Joe Perches6cd7f382012-12-17 16:01:54 -08002083#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002084 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002085 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002086 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002087 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002088 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002089 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002090 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002091 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002092 }
2093
Josh Triplettca56dc02012-03-23 15:02:21 -07002094# Check for user-visible strings broken across lines, which breaks the ability
Joe Perches8c5fcd22014-01-23 15:54:40 -08002095# to grep for the string. Make exceptions when the previous string ends in a
2096# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2097# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
Josh Triplettca56dc02012-03-23 15:02:21 -07002098 if ($line =~ /^\+\s*"/ &&
2099 $prevline =~ /"\s*$/ &&
Joe Perches8c5fcd22014-01-23 15:54:40 -08002100 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) {
Josh Triplettca56dc02012-03-23 15:02:21 -07002101 WARN("SPLIT_STRING",
2102 "quoted string split across lines\n" . $hereprev);
2103 }
2104
Joe Perches5e79d962010-03-05 13:43:55 -08002105# check for spaces before a quoted newline
2106 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002107 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2108 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2109 $fix) {
2110 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2111 }
2112
Joe Perches5e79d962010-03-05 13:43:55 -08002113 }
2114
Andy Whitcroft8905a672007-11-28 16:21:06 -08002115# check for adding lines without a newline.
2116 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002117 WARN("MISSING_EOF_NEWLINE",
2118 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002119 }
2120
Mike Frysinger42e41c52009-09-21 17:04:40 -07002121# Blackfin: use hi/lo macros
2122 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2123 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2124 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002125 ERROR("LO_MACRO",
2126 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002127 }
2128 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2129 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002130 ERROR("HI_MACRO",
2131 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002132 }
2133 }
2134
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002135# check we are in a valid source file C or perl if not then ignore this hunk
2136 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002137
2138# at the beginning of a line any tabs must come first and anything
2139# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002140 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2141 $rawline =~ /^\+\s* \s*/) {
2142 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002143 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002144 if (ERROR("CODE_INDENT",
2145 "code indent should use tabs where possible\n" . $herevet) &&
2146 $fix) {
2147 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2148 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002149 }
2150
Alberto Panizzo08e44362010-03-05 13:43:54 -08002151# check for space before tabs.
2152 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2153 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002154 if (WARN("SPACE_BEFORE_TAB",
2155 "please, no space before tabs\n" . $herevet) &&
2156 $fix) {
Joe Perchesc76f4cb2014-01-23 15:54:46 -08002157 while ($fixed[$linenr - 1] =~
2158 s/(^\+.*) {8,8}+\t/$1\t\t/) {}
2159 while ($fixed[$linenr - 1] =~
2160 s/(^\+.*) +\t/$1\t/) {}
Joe Perches3705ce52013-07-03 15:05:31 -07002161 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002162 }
2163
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002164# check for && or || at the start of a line
2165 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2166 CHK("LOGICAL_CONTINUATIONS",
2167 "Logical continuations should be on the previous line\n" . $hereprev);
2168 }
2169
2170# check multi-line statement indentation matches previous line
2171 if ($^V && $^V ge 5.10.0 &&
2172 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
2173 $prevline =~ /^\+(\t*)(.*)$/;
2174 my $oldindent = $1;
2175 my $rest = $2;
2176
2177 my $pos = pos_last_openparen($rest);
2178 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002179 $line =~ /^(\+| )([ \t]*)/;
2180 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002181
2182 my $goodtabindent = $oldindent .
2183 "\t" x ($pos / 8) .
2184 " " x ($pos % 8);
2185 my $goodspaceindent = $oldindent . " " x $pos;
2186
2187 if ($newindent ne $goodtabindent &&
2188 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002189
2190 if (CHK("PARENTHESIS_ALIGNMENT",
2191 "Alignment should match open parenthesis\n" . $hereprev) &&
2192 $fix && $line =~ /^\+/) {
2193 $fixed[$linenr - 1] =~
2194 s/^\+[ \t]*/\+$goodtabindent/;
2195 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002196 }
2197 }
2198 }
2199
Joe Perches23f780c2013-07-03 15:05:31 -07002200 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002201 if (CHK("SPACING",
2202 "No space is necessary after a cast\n" . $hereprev) &&
2203 $fix) {
2204 $fixed[$linenr - 1] =~
2205 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2206 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002207 }
2208
Joe Perches05880602012-10-04 17:13:35 -07002209 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002210 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2211 $rawline =~ /^\+[ \t]*\*/) {
Joe Perches05880602012-10-04 17:13:35 -07002212 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2213 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2214 }
2215
2216 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002217 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2218 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002219 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002220 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2221 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2222 "networking block comments start with * on subsequent lines\n" . $hereprev);
2223 }
2224
2225 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002226 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2227 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2228 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2229 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002230 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2231 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2232 }
2233
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002234# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002235# Exceptions:
2236# 1) within comments
2237# 2) indented preprocessor commands
2238# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002239 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002240 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002241 if (WARN("LEADING_SPACE",
2242 "please, no spaces at the start of a line\n" . $herevet) &&
2243 $fix) {
2244 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2245 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002246 }
2247
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002248# check we are in a valid C source file if not then ignore this hunk
2249 next if ($realfile !~ /\.(h|c)$/);
2250
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002251# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2252 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2253 WARN("CONFIG_EXPERIMENTAL",
2254 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2255 }
2256
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002257# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002258 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002259 WARN("CVS_KEYWORD",
2260 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002261 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002262
Mike Frysinger42e41c52009-09-21 17:04:40 -07002263# Blackfin: don't use __builtin_bfin_[cs]sync
2264 if ($line =~ /__builtin_bfin_csync/) {
2265 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002266 ERROR("CSYNC",
2267 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002268 }
2269 if ($line =~ /__builtin_bfin_ssync/) {
2270 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002271 ERROR("SSYNC",
2272 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002273 }
2274
Joe Perches56e77d72013-02-21 16:44:14 -08002275# check for old HOTPLUG __dev<foo> section markings
2276 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2277 WARN("HOTPLUG_SECTION",
2278 "Using $1 is unnecessary\n" . $herecurr);
2279 }
2280
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002281# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002282 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2283 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002284#print "LINE<$line>\n";
2285 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002286 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002287 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002288 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002289 $stat =~ s/\n./\n /g;
2290 $cond =~ s/\n./\n /g;
2291
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002292#print "linenr<$linenr> <$stat>\n";
2293 # If this statement has no statement boundaries within
2294 # it there is no point in retrying a statement scan
2295 # until we hit end of it.
2296 my $frag = $stat; $frag =~ s/;+\s*$//;
2297 if ($frag !~ /(?:{|;)/) {
2298#print "skip<$line_nr_next>\n";
2299 $suppress_statement = $line_nr_next;
2300 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002301
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002302 # Find the real next line.
2303 $realline_next = $line_nr_next;
2304 if (defined $realline_next &&
2305 (!defined $lines[$realline_next - 1] ||
2306 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2307 $realline_next++;
2308 }
2309
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002310 my $s = $stat;
2311 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002312
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002313 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002314 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002315
2316 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002317 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002318
Andy Whitcroft463f2862009-09-21 17:04:34 -07002319 } elsif ($s =~ /^.\s*else\b/s) {
2320
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002321 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002322 } 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 -07002323 my $type = $1;
2324 $type =~ s/\s+/ /g;
2325 possible($type, "A:" . $s);
2326
Andy Whitcroft8905a672007-11-28 16:21:06 -08002327 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002328 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002329 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002330 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002331
2332 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002333 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002334 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002335 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002336
2337 # Check for any sort of function declaration.
2338 # int foo(something bar, other baz);
2339 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002340 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 -08002341 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002342
Andy Whitcroftcf655042008-03-04 14:28:20 -08002343 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002344 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002345 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002346
Andy Whitcroft8905a672007-11-28 16:21:06 -08002347 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002348 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002349
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002350 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002351 }
2352 }
2353 }
2354
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002355 }
2356
Andy Whitcroft653d4872007-06-23 17:16:34 -07002357#
2358# Checks which may be anchored in the context.
2359#
2360
2361# Check for switch () and associated case and default
2362# statements should be at the same indent.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002363 if ($line=~/\bswitch\s*\(.*\)/) {
2364 my $err = '';
2365 my $sep = '';
2366 my @ctx = ctx_block_outer($linenr, $realcnt);
2367 shift(@ctx);
2368 for my $ctx (@ctx) {
2369 my ($clen, $cindent) = line_stats($ctx);
2370 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2371 $indent != $cindent) {
2372 $err .= "$sep$ctx\n";
2373 $sep = '';
2374 } else {
2375 $sep = "[...]\n";
2376 }
2377 }
2378 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002379 ERROR("SWITCH_CASE_INDENT_LEVEL",
2380 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002381 }
2382 }
2383
2384# if/while/etc brace do not go on next line, unless defining a do while loop,
2385# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002386 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002387 my $pre_ctx = "$1$2";
2388
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002389 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002390
2391 if ($line =~ /^\+\t{6,}/) {
2392 WARN("DEEP_INDENTATION",
2393 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2394 }
2395
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002396 my $ctx_cnt = $realcnt - $#ctx - 1;
2397 my $ctx = join("\n", @ctx);
2398
Andy Whitcroft548596d2008-07-23 21:29:01 -07002399 my $ctx_ln = $linenr;
2400 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002401
Andy Whitcroft548596d2008-07-23 21:29:01 -07002402 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2403 defined $lines[$ctx_ln - 1] &&
2404 $lines[$ctx_ln - 1] =~ /^-/)) {
2405 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2406 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002407 $ctx_ln++;
2408 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002409
Andy Whitcroft53210162008-07-23 21:29:03 -07002410 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2411 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002412
2413 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002414 ERROR("OPEN_BRACE",
2415 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002416 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002417 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002418 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2419 $ctx =~ /\)\s*\;\s*$/ &&
2420 defined $lines[$ctx_ln - 1])
2421 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002422 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2423 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002424 WARN("TRAILING_SEMICOLON",
2425 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002426 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002427 }
2428 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002429 }
2430
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002431# Check relative indent for conditionals and blocks.
2432 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002433 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2434 ctx_statement_block($linenr, $realcnt, 0)
2435 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002436 my ($s, $c) = ($stat, $cond);
2437
2438 substr($s, 0, length($c), '');
2439
2440 # Make sure we remove the line prefixes as we have
2441 # none on the first line, and are going to readd them
2442 # where necessary.
2443 $s =~ s/\n./\n/gs;
2444
2445 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002446 my @newlines = ($c =~ /\n/gs);
2447 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002448
2449 # We want to check the first line inside the block
2450 # starting at the end of the conditional, so remove:
2451 # 1) any blank line termination
2452 # 2) any opening brace { on end of the line
2453 # 3) any do (...) {
2454 my $continuation = 0;
2455 my $check = 0;
2456 $s =~ s/^.*\bdo\b//;
2457 $s =~ s/^\s*{//;
2458 if ($s =~ s/^\s*\\//) {
2459 $continuation = 1;
2460 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002461 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002462 $check = 1;
2463 $cond_lines++;
2464 }
2465
2466 # Also ignore a loop construct at the end of a
2467 # preprocessor statement.
2468 if (($prevline =~ /^.\s*#\s*define\s/ ||
2469 $prevline =~ /\\\s*$/) && $continuation == 0) {
2470 $check = 0;
2471 }
2472
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002473 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002474 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002475 while ($cond_ptr != $cond_lines) {
2476 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002477
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002478 # If we see an #else/#elif then the code
2479 # is not linear.
2480 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2481 $check = 0;
2482 }
2483
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002484 # Ignore:
2485 # 1) blank lines, they should be at 0,
2486 # 2) preprocessor lines, and
2487 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002488 if ($continuation ||
2489 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002490 $s =~ /^\s*#\s*?/ ||
2491 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002492 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002493 if ($s =~ s/^.*?\n//) {
2494 $cond_lines++;
2495 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002496 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002497 }
2498
2499 my (undef, $sindent) = line_stats("+" . $s);
2500 my $stat_real = raw_line($linenr, $cond_lines);
2501
2502 # Check if either of these lines are modified, else
2503 # this is not this patch's fault.
2504 if (!defined($stat_real) ||
2505 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2506 $check = 0;
2507 }
2508 if (defined($stat_real) && $cond_lines > 1) {
2509 $stat_real = "[...]\n$stat_real";
2510 }
2511
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002512 #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 -07002513
2514 if ($check && (($sindent % 8) != 0 ||
2515 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002516 WARN("SUSPECT_CODE_INDENT",
2517 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002518 }
2519 }
2520
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002521 # Track the 'values' across context and added lines.
2522 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002523 my ($curr_values, $curr_vars) =
2524 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002525 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002526 if ($dbg_values) {
2527 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002528 print "$linenr > .$outline\n";
2529 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002530 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002531 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002532 $prev_values = substr($curr_values, -1);
2533
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002534#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002535 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002536
Andy Whitcroft653d4872007-06-23 17:16:34 -07002537# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002538 if ($dbg_type) {
2539 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002540 ERROR("TEST_TYPE",
2541 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002542 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002543 ERROR("TEST_NOT_TYPE",
2544 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002545 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002546 next;
2547 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002548# TEST: allow direct testing of the attribute matcher.
2549 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002550 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002551 ERROR("TEST_ATTR",
2552 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002553 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002554 ERROR("TEST_NOT_ATTR",
2555 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002556 }
2557 next;
2558 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002559
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002560# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002561 if ($line =~ /^.\s*{/ &&
2562 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002563 ERROR("OPEN_BRACE",
2564 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002565 }
2566
Andy Whitcroft653d4872007-06-23 17:16:34 -07002567#
2568# Checks which are anchored on the added line.
2569#
2570
2571# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002572 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002573 my $path = $1;
2574 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002575 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002576 "malformed #include filename\n" . $herecurr);
2577 }
2578 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2579 ERROR("UAPI_INCLUDE",
2580 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002581 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002582 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002583
2584# no C99 // comments
2585 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002586 if (ERROR("C99_COMMENTS",
2587 "do not use C99 // comments\n" . $herecurr) &&
2588 $fix) {
2589 my $line = $fixed[$linenr - 1];
2590 if ($line =~ /\/\/(.*)$/) {
2591 my $comment = trim($1);
2592 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2593 }
2594 }
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002595 }
2596 # Remove C99 comments.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002597 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002598 $opline =~ s@//.*@@;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002599
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002600# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2601# the whole statement.
2602#print "APW <$lines[$realline_next - 1]>\n";
2603 if (defined $realline_next &&
2604 exists $lines[$realline_next - 1] &&
2605 !defined $suppress_export{$realline_next} &&
2606 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2607 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002608 # Handle definitions which produce identifiers with
2609 # a prefix:
2610 # XXX(foo);
2611 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002612 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002613 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002614 $name =~ /^${Ident}_$2/) {
2615#print "FOO C name<$name>\n";
2616 $suppress_export{$realline_next} = 1;
2617
2618 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002619 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002620 ^.DEFINE_$Ident\(\Q$name\E\)|
2621 ^.DECLARE_$Ident\(\Q$name\E\)|
2622 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002623 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2624 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002625 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002626#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2627 $suppress_export{$realline_next} = 2;
2628 } else {
2629 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002630 }
2631 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002632 if (!defined $suppress_export{$linenr} &&
2633 $prevline =~ /^.\s*$/ &&
2634 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2635 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2636#print "FOO B <$lines[$linenr - 1]>\n";
2637 $suppress_export{$linenr} = 2;
2638 }
2639 if (defined $suppress_export{$linenr} &&
2640 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002641 WARN("EXPORT_SYMBOL",
2642 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002643 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002644
Joe Eloff5150bda2010-08-09 17:21:00 -07002645# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002646 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2647 if (ERROR("GLOBAL_INITIALISERS",
2648 "do not initialise globals to 0 or NULL\n" .
2649 $herecurr) &&
2650 $fix) {
2651 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2652 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002653 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002654# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002655 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2656 if (ERROR("INITIALISED_STATIC",
2657 "do not initialise statics to 0 or NULL\n" .
2658 $herecurr) &&
2659 $fix) {
2660 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2661 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002662 }
2663
Joe Perchescb710ec2010-10-26 14:23:20 -07002664# check for static const char * arrays.
2665 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002666 WARN("STATIC_CONST_CHAR_ARRAY",
2667 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002668 $herecurr);
2669 }
2670
2671# check for static char foo[] = "bar" declarations.
2672 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002673 WARN("STATIC_CONST_CHAR_ARRAY",
2674 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002675 $herecurr);
2676 }
2677
Joe Perchesb36190c2014-01-27 17:07:18 -08002678# check for function declarations without arguments like "int foo()"
2679 if ($line =~ /(\b$Type\s+$Ident)\s*\(\s*\)/) {
2680 if (ERROR("FUNCTION_WITHOUT_ARGS",
2681 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) &&
2682 $fix) {
2683 $fixed[$linenr - 1] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/;
2684 }
2685 }
2686
Joe Perches92e112f2013-12-13 11:36:22 -07002687# check for uses of DEFINE_PCI_DEVICE_TABLE
2688 if ($line =~ /\bDEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=/) {
2689 if (WARN("DEFINE_PCI_DEVICE_TABLE",
2690 "Prefer struct pci_device_id over deprecated DEFINE_PCI_DEVICE_TABLE\n" . $herecurr) &&
2691 $fix) {
2692 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2693 }
Joe Perches93ed0e22010-10-26 14:23:21 -07002694 }
2695
Andy Whitcroft653d4872007-06-23 17:16:34 -07002696# check for new typedefs, only function parameters and sparse annotations
2697# make sense.
2698 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002699 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002700 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002701 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002702 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002703 WARN("NEW_TYPEDEFS",
2704 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002705 }
2706
2707# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002708 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002709 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2710 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002711 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002712
Andy Whitcroft65863862009-01-06 14:41:21 -08002713 # Should start with a space.
2714 $to =~ s/^(\S)/ $1/;
2715 # Should not end with a space.
2716 $to =~ s/\s+$//;
2717 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002718 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002719 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002720
Joe Perches3705ce52013-07-03 15:05:31 -07002721## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08002722 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07002723 if (ERROR("POINTER_LOCATION",
2724 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2725 $fix) {
2726 my $sub_from = $ident;
2727 my $sub_to = $ident;
2728 $sub_to =~ s/\Q$from\E/$to/;
2729 $fixed[$linenr - 1] =~
2730 s@\Q$sub_from\E@$sub_to@;
2731 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002732 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002733 }
2734 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2735 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002736 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002737
Andy Whitcroft65863862009-01-06 14:41:21 -08002738 # Should start with a space.
2739 $to =~ s/^(\S)/ $1/;
2740 # Should not end with a space.
2741 $to =~ s/\s+$//;
2742 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002743 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002744 }
2745 # Modifiers should have spaces.
2746 $to =~ s/(\b$Modifier$)/$1 /;
2747
Joe Perches3705ce52013-07-03 15:05:31 -07002748## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08002749 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002750 if (ERROR("POINTER_LOCATION",
2751 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2752 $fix) {
2753
2754 my $sub_from = $match;
2755 my $sub_to = $match;
2756 $sub_to =~ s/\Q$from\E/$to/;
2757 $fixed[$linenr - 1] =~
2758 s@\Q$sub_from\E@$sub_to@;
2759 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002760 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002761 }
2762
2763# # no BUG() or BUG_ON()
2764# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2765# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2766# print "$herecurr";
2767# $clean = 0;
2768# }
2769
Andy Whitcroft8905a672007-11-28 16:21:06 -08002770 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002771 WARN("LINUX_VERSION_CODE",
2772 "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 -08002773 }
2774
Joe Perches17441222011-06-15 15:08:17 -07002775# check for uses of printk_ratelimit
2776 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002777 WARN("PRINTK_RATELIMITED",
2778"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002779 }
2780
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002781# printk should use KERN_* levels. Note that follow on printk's on the
2782# same line do not need a level, so we use the current block context
2783# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002784# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002785# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002786 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002787 my $ok = 0;
2788 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2789 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002790 # we have a preceding printk if it ends
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002791 # with "\n" ignore it, else it is to blame
2792 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2793 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2794 $ok = 1;
2795 }
2796 last;
2797 }
2798 }
2799 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002800 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2801 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df344f2007-06-08 13:47:06 -07002802 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002803 }
2804
Joe Perches243f3802012-05-31 16:26:09 -07002805 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2806 my $orig = $1;
2807 my $level = lc($orig);
2808 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002809 my $level2 = $level;
2810 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002811 WARN("PREFER_PR_LEVEL",
Joe Perches8f26b832012-10-04 17:13:32 -07002812 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Joe Perches243f3802012-05-31 16:26:09 -07002813 }
2814
2815 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002816 if (WARN("PREFER_PR_LEVEL",
2817 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2818 $fix) {
2819 $fixed[$linenr - 1] =~
2820 s/\bpr_warning\b/pr_warn/;
2821 }
Joe Perches243f3802012-05-31 16:26:09 -07002822 }
2823
Joe Perchesdc139312013-02-21 16:44:13 -08002824 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2825 my $orig = $1;
2826 my $level = lc($orig);
2827 $level = "warn" if ($level eq "warning");
2828 $level = "dbg" if ($level eq "debug");
2829 WARN("PREFER_DEV_LEVEL",
2830 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2831 }
2832
Andy Whitcroft653d4872007-06-23 17:16:34 -07002833# function brace can't be on same line, except for #defines of do while,
2834# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002835 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2836 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002837 ERROR("OPEN_BRACE",
2838 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002839 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002840
Andy Whitcroft8905a672007-11-28 16:21:06 -08002841# open braces for enum, union and struct go on the same line.
2842 if ($line =~ /^.\s*{/ &&
2843 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002844 ERROR("OPEN_BRACE",
2845 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002846 }
2847
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002848# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07002849 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2850 if (WARN("SPACING",
2851 "missing space after $1 definition\n" . $herecurr) &&
2852 $fix) {
2853 $fixed[$linenr - 1] =~
2854 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2855 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002856 }
2857
Joe Perches31070b52014-01-23 15:54:49 -08002858# Function pointer declarations
2859# check spacing between type, funcptr, and args
2860# canonical declaration is "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002861 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) {
Joe Perches31070b52014-01-23 15:54:49 -08002862 my $declare = $1;
2863 my $pre_pointer_space = $2;
2864 my $post_pointer_space = $3;
2865 my $funcname = $4;
2866 my $post_funcname_space = $5;
2867 my $pre_args_space = $6;
2868
Joe Perches91f72e92014-04-03 14:49:12 -07002869# the $Declare variable will capture all spaces after the type
2870# so check it for a missing trailing missing space but pointer return types
2871# don't need a space so don't warn for those.
2872 my $post_declare_space = "";
2873 if ($declare =~ /(\s+)$/) {
2874 $post_declare_space = $1;
2875 $declare = rtrim($declare);
2876 }
2877 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) {
Joe Perches31070b52014-01-23 15:54:49 -08002878 WARN("SPACING",
2879 "missing space after return type\n" . $herecurr);
Joe Perches91f72e92014-04-03 14:49:12 -07002880 $post_declare_space = " ";
Joe Perches31070b52014-01-23 15:54:49 -08002881 }
2882
2883# unnecessary space "type (*funcptr)(args...)"
Joe Perches91f72e92014-04-03 14:49:12 -07002884# This test is not currently implemented because these declarations are
2885# equivalent to
2886# int foo(int bar, ...)
2887# and this is form shouldn't/doesn't generate a checkpatch warning.
2888#
2889# elsif ($declare =~ /\s{2,}$/) {
2890# WARN("SPACING",
2891# "Multiple spaces after return type\n" . $herecurr);
2892# }
Joe Perches31070b52014-01-23 15:54:49 -08002893
2894# unnecessary space "type ( *funcptr)(args...)"
2895 if (defined $pre_pointer_space &&
2896 $pre_pointer_space =~ /^\s/) {
2897 WARN("SPACING",
2898 "Unnecessary space after function pointer open parenthesis\n" . $herecurr);
2899 }
2900
2901# unnecessary space "type (* funcptr)(args...)"
2902 if (defined $post_pointer_space &&
2903 $post_pointer_space =~ /^\s/) {
2904 WARN("SPACING",
2905 "Unnecessary space before function pointer name\n" . $herecurr);
2906 }
2907
2908# unnecessary space "type (*funcptr )(args...)"
2909 if (defined $post_funcname_space &&
2910 $post_funcname_space =~ /^\s/) {
2911 WARN("SPACING",
2912 "Unnecessary space after function pointer name\n" . $herecurr);
2913 }
2914
2915# unnecessary space "type (*funcptr) (args...)"
2916 if (defined $pre_args_space &&
2917 $pre_args_space =~ /^\s/) {
2918 WARN("SPACING",
2919 "Unnecessary space before function pointer arguments\n" . $herecurr);
2920 }
2921
2922 if (show_type("SPACING") && $fix) {
2923 $fixed[$linenr - 1] =~
Joe Perches91f72e92014-04-03 14:49:12 -07002924 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
Joe Perches31070b52014-01-23 15:54:49 -08002925 }
2926 }
2927
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002928# check for spacing round square brackets; allowed:
2929# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002930# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2931# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002932 while ($line =~ /(.*?\s)\[/g) {
2933 my ($where, $prefix) = ($-[1], $1);
2934 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002935 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002936 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002937 if (ERROR("BRACKET_SPACE",
2938 "space prohibited before open square bracket '['\n" . $herecurr) &&
2939 $fix) {
2940 $fixed[$linenr - 1] =~
2941 s/^(\+.*?)\s+\[/$1\[/;
2942 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002943 }
2944 }
2945
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002946# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002947 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002948 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002949 my $ctx_before = substr($line, 0, $-[1]);
2950 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002951
2952 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002953 if ($name =~ /^(?:
2954 if|for|while|switch|return|case|
2955 volatile|__volatile__|
2956 __attribute__|format|__extension__|
2957 asm|__asm__)$/x)
2958 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002959 # cpp #define statements have non-optional spaces, ie
2960 # if there is a space between the name and the open
2961 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002962 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002963
2964 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002965 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002966
2967 # If this whole things ends with a type its most
2968 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002969 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002970
2971 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07002972 if (WARN("SPACING",
2973 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
2974 $fix) {
2975 $fixed[$linenr - 1] =~
2976 s/\b$name\s+\(/$name\(/;
2977 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002978 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002979 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07002980
Andy Whitcroft653d4872007-06-23 17:16:34 -07002981# Check operator spacing.
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07002982 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002983 my $fixed_line = "";
2984 my $line_fixed = 0;
2985
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002986 my $ops = qr{
2987 <<=|>>=|<=|>=|==|!=|
2988 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2989 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002990 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
Joe Perches84731622013-11-12 15:10:05 -08002991 \?:|\?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002992 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002993 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07002994
2995## print("element count: <" . $#elements . ">\n");
2996## foreach my $el (@elements) {
2997## print("el: <$el>\n");
2998## }
2999
3000 my @fix_elements = ();
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003001 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003002
Joe Perches3705ce52013-07-03 15:05:31 -07003003 foreach my $el (@elements) {
3004 push(@fix_elements, substr($rawline, $off, length($el)));
3005 $off += length($el);
3006 }
3007
3008 $off = 0;
3009
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003010 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07003011 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003012
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003013 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07003014
3015 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
3016
3017## print("n: <$n> good: <$good>\n");
3018
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003019 $off += length($elements[$n]);
3020
Lucas De Marchi25985ed2011-03-30 22:57:33 -03003021 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003022 my $ca = substr($opline, 0, $off);
3023 my $cc = '';
3024 if (length($opline) >= ($off + length($elements[$n + 1]))) {
3025 $cc = substr($opline, $off + length($elements[$n + 1]));
3026 }
3027 my $cb = "$ca$;$cc";
3028
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003029 my $a = '';
3030 $a = 'V' if ($elements[$n] ne '');
3031 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003032 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003033 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
3034 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07003035 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003036
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003037 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003038
3039 my $c = '';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003040 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003041 $c = 'V' if ($elements[$n + 2] ne '');
3042 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003043 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003044 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
3045 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08003046 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003047 } else {
3048 $c = 'E';
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003049 }
3050
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003051 my $ctx = "${a}x${c}";
3052
3053 my $at = "(ctx:$ctx)";
3054
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003055 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003056 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003057
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003058 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003059 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003060
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003061 # Get the full operator variant.
3062 my $opv = $op . substr($curr_vars, $off, 1);
3063
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003064 # Ignore operators passed as parameters.
3065 if ($op_type ne 'V' &&
3066 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
3067
Andy Whitcroftcf655042008-03-04 14:28:20 -08003068# # Ignore comments
3069# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003070
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003071 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003072 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003073 if ($ctx !~ /.x[WEBC]/ &&
3074 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003075 if (ERROR("SPACING",
3076 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003077 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003078 $line_fixed = 1;
3079 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003080 }
3081
3082 # // is a comment
3083 } elsif ($op eq '//') {
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003084
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003085 # No spaces for:
3086 # ->
3087 # : when part of a bitfield
3088 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003089 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003090 if (ERROR("SPACING",
3091 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003092 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003093 if (defined $fix_elements[$n + 2]) {
3094 $fix_elements[$n + 2] =~ s/^\s+//;
3095 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003096 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003097 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003098 }
3099
3100 # , must have a space on the right.
3101 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003102 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003103 if (ERROR("SPACING",
3104 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003105 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003106 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07003107 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07003108 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003109 }
3110
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003111 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003112 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003113 #warn "'*' is part of type\n";
3114
3115 # unary operators should have a space before and
3116 # none after. May be left adjacent to another
3117 # unary operator, or a cast
3118 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07003119 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07003120 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003121 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003122 if (ERROR("SPACING",
3123 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003124 if ($n != $last_after + 2) {
3125 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
3126 $line_fixed = 1;
3127 }
Joe Perches3705ce52013-07-03 15:05:31 -07003128 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003129 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08003130 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003131 # A unary '*' may be const
3132
3133 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003134 if (ERROR("SPACING",
3135 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003136 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003137 if (defined $fix_elements[$n + 2]) {
3138 $fix_elements[$n + 2] =~ s/^\s+//;
3139 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003140 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003141 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003142 }
3143
3144 # unary ++ and unary -- are allowed no space on one side.
3145 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003146 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003147 if (ERROR("SPACING",
3148 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003149 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003150 $line_fixed = 1;
3151 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003152 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003153 if ($ctx =~ /Wx[BE]/ ||
3154 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003155 if (ERROR("SPACING",
3156 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003157 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003158 $line_fixed = 1;
3159 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003160 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003161 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003162 if (ERROR("SPACING",
3163 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003164 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003165 if (defined $fix_elements[$n + 2]) {
3166 $fix_elements[$n + 2] =~ s/^\s+//;
3167 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003168 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003169 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003170 }
3171
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003172 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003173 } elsif ($op eq '<<' or $op eq '>>' or
3174 $op eq '&' or $op eq '^' or $op eq '|' or
3175 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003176 $op eq '*' or $op eq '/' or
3177 $op eq '%')
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003178 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003179 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003180 if (ERROR("SPACING",
3181 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003182 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3183 if (defined $fix_elements[$n + 2]) {
3184 $fix_elements[$n + 2] =~ s/^\s+//;
3185 }
Joe Perches3705ce52013-07-03 15:05:31 -07003186 $line_fixed = 1;
3187 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003188 }
3189
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003190 # A colon needs no spaces before when it is
3191 # terminating a case value or a label.
3192 } elsif ($opv eq ':C' || $opv eq ':L') {
3193 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003194 if (ERROR("SPACING",
3195 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003196 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003197 $line_fixed = 1;
3198 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003199 }
3200
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003201 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003202 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003203 my $ok = 0;
3204
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003205 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003206 if (($op eq '<' &&
3207 $cc =~ /^\S+\@\S+>/) ||
3208 ($op eq '>' &&
3209 $ca =~ /<\S+\@\S+$/))
3210 {
3211 $ok = 1;
3212 }
3213
Joe Perches84731622013-11-12 15:10:05 -08003214 # messages are ERROR, but ?: are CHK
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003215 if ($ok == 0) {
Joe Perches84731622013-11-12 15:10:05 -08003216 my $msg_type = \&ERROR;
3217 $msg_type = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/);
3218
3219 if (&{$msg_type}("SPACING",
3220 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003221 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3222 if (defined $fix_elements[$n + 2]) {
3223 $fix_elements[$n + 2] =~ s/^\s+//;
3224 }
Joe Perches3705ce52013-07-03 15:05:31 -07003225 $line_fixed = 1;
3226 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003227 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003228 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003229 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003230
3231## print("n: <$n> GOOD: <$good>\n");
3232
3233 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003234 }
Joe Perches3705ce52013-07-03 15:05:31 -07003235
3236 if (($#elements % 2) == 0) {
3237 $fixed_line = $fixed_line . $fix_elements[$#elements];
3238 }
3239
3240 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3241 $fixed[$linenr - 1] = $fixed_line;
3242 }
3243
3244
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003245 }
3246
Joe Perches786b6322013-07-03 15:05:32 -07003247# check for whitespace before a non-naked semicolon
Joe Perchesd2e248e2014-01-23 15:54:41 -08003248 if ($line =~ /^\+.*\S\s+;\s*$/) {
Joe Perches786b6322013-07-03 15:05:32 -07003249 if (WARN("SPACING",
3250 "space prohibited before semicolon\n" . $herecurr) &&
3251 $fix) {
3252 1 while $fixed[$linenr - 1] =~
3253 s/^(\+.*\S)\s+;/$1;/;
3254 }
3255 }
3256
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003257# check for multiple assignments
3258 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003259 CHK("MULTIPLE_ASSIGNMENTS",
3260 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003261 }
3262
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003263## # check for multiple declarations, allowing for a function declaration
3264## # continuation.
3265## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3266## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3267##
3268## # Remove any bracketed sections to ensure we do not
3269## # falsly report the parameters of functions.
3270## my $ln = $line;
3271## while ($ln =~ s/\([^\(\)]*\)//g) {
3272## }
3273## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003274## WARN("MULTIPLE_DECLARATION",
3275## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003276## }
3277## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003278
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003279#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003280 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3281 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003282 if (ERROR("SPACING",
3283 "space required before the open brace '{'\n" . $herecurr) &&
3284 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003285 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003286 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003287 }
3288
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003289## # check for blank lines before declarations
3290## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3291## $prevrawline =~ /^.\s*$/) {
3292## WARN("SPACING",
3293## "No blank lines before declarations\n" . $hereprev);
3294## }
3295##
3296
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003297# closing brace should have a space following it when it has anything
3298# on the line
3299 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003300 if (ERROR("SPACING",
3301 "space required after that close brace '}'\n" . $herecurr) &&
3302 $fix) {
3303 $fixed[$linenr - 1] =~
3304 s/}((?!(?:,|;|\)))\S)/} $1/;
3305 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003306 }
3307
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003308# check spacing on square brackets
3309 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003310 if (ERROR("SPACING",
3311 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3312 $fix) {
3313 $fixed[$linenr - 1] =~
3314 s/\[\s+/\[/;
3315 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003316 }
3317 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003318 if (ERROR("SPACING",
3319 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3320 $fix) {
3321 $fixed[$linenr - 1] =~
3322 s/\s+\]/\]/;
3323 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003324 }
3325
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003326# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003327 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3328 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003329 if (ERROR("SPACING",
3330 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3331 $fix) {
3332 $fixed[$linenr - 1] =~
3333 s/\(\s+/\(/;
3334 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003335 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003336 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003337 $line !~ /for\s*\(.*;\s+\)/ &&
3338 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003339 if (ERROR("SPACING",
3340 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3341 $fix) {
3342 $fixed[$linenr - 1] =~
3343 s/\s+\)/\)/;
3344 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003345 }
3346
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003347#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003348 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003349 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003350 if (WARN("INDENTED_LABEL",
3351 "labels should not be indented\n" . $herecurr) &&
3352 $fix) {
3353 $fixed[$linenr - 1] =~
3354 s/^(.)\s+/$1/;
3355 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003356 }
3357
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003358# Return is not a function.
Joe Perches507e5142013-11-12 15:10:13 -08003359 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003360 my $spacing = $1;
Joe Perches507e5142013-11-12 15:10:13 -08003361 if ($^V && $^V ge 5.10.0 &&
3362 $stat =~ /^.\s*return\s*$balanced_parens\s*;\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003363 ERROR("RETURN_PARENTHESES",
3364 "return is not a function, parentheses are not required\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003365
3366 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003367 ERROR("SPACING",
3368 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003369 }
3370 }
Joe Perches507e5142013-11-12 15:10:13 -08003371
Joe Perches189248d2014-01-23 15:54:47 -08003372# if statements using unnecessary parentheses - ie: if ((foo == bar))
3373 if ($^V && $^V ge 5.10.0 &&
3374 $line =~ /\bif\s*((?:\(\s*){2,})/) {
3375 my $openparens = $1;
3376 my $count = $openparens =~ tr@\(@\(@;
3377 my $msg = "";
3378 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3379 my $comp = $4; #Not $1 because of $LvalOrFunc
3380 $msg = " - maybe == should be = ?" if ($comp eq "==");
3381 WARN("UNNECESSARY_PARENTHESES",
3382 "Unnecessary parentheses$msg\n" . $herecurr);
3383 }
3384 }
3385
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003386# Return of what appears to be an errno should normally be -'ve
3387 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3388 my $name = $1;
3389 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003390 WARN("USE_NEGATIVE_ERRNO",
3391 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003392 }
3393 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003394
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003395# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003396 if ($line =~ /\b(if|while|for|switch)\(/) {
3397 if (ERROR("SPACING",
3398 "space required before the open parenthesis '('\n" . $herecurr) &&
3399 $fix) {
3400 $fixed[$linenr - 1] =~
3401 s/\b(if|while|for|switch)\(/$1 \(/;
3402 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003403 }
3404
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003405# Check for illegal assignment in if conditional -- and check for trailing
3406# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003407 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003408 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3409 ctx_statement_block($linenr, $realcnt, 0)
3410 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003411 my ($stat_next) = ctx_statement_block($line_nr_next,
3412 $remain_next, $off_next);
3413 $stat_next =~ s/\n./\n /g;
3414 ##print "stat<$stat> stat_next<$stat_next>\n";
3415
3416 if ($stat_next =~ /^\s*while\b/) {
3417 # If the statement carries leading newlines,
3418 # then count those as offsets.
3419 my ($whitespace) =
3420 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3421 my $offset =
3422 statement_rawlines($whitespace) - 1;
3423
3424 $suppress_whiletrailers{$line_nr_next +
3425 $offset} = 1;
3426 }
3427 }
3428 if (!defined $suppress_whiletrailers{$linenr} &&
Joe Perchesc11230f2013-11-21 14:31:57 -08003429 defined($stat) && defined($cond) &&
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003430 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003431 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003432
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003433 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003434 ERROR("ASSIGN_IN_IF",
3435 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003436 }
3437
3438 # Find out what is on the end of the line after the
3439 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003440 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003441 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003442 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003443 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3444 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003445 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003446 # Find out how long the conditional actually is.
3447 my @newlines = ($c =~ /\n/gs);
3448 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003449 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003450
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003451 $stat_real = raw_line($linenr, $cond_lines)
3452 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003453 if (defined($stat_real) && $cond_lines > 1) {
3454 $stat_real = "[...]\n$stat_real";
3455 }
3456
Joe Perches000d1cc12011-07-25 17:13:25 -07003457 ERROR("TRAILING_STATEMENTS",
3458 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003459 }
3460 }
3461
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003462# Check for bitwise tests written as boolean
3463 if ($line =~ /
3464 (?:
3465 (?:\[|\(|\&\&|\|\|)
3466 \s*0[xX][0-9]+\s*
3467 (?:\&\&|\|\|)
3468 |
3469 (?:\&\&|\|\|)
3470 \s*0[xX][0-9]+\s*
3471 (?:\&\&|\|\||\)|\])
3472 )/x)
3473 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003474 WARN("HEXADECIMAL_BOOLEAN_TEST",
3475 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003476 }
3477
Andy Whitcroft8905a672007-11-28 16:21:06 -08003478# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003479 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3480 my $s = $1;
3481 $s =~ s/$;//g; # Remove any comments
3482 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003483 ERROR("TRAILING_STATEMENTS",
3484 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003485 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003486 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003487# if should not continue a brace
3488 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003489 ERROR("TRAILING_STATEMENTS",
3490 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003491 $herecurr);
3492 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003493# case and default should not have general statements after them
3494 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3495 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003496 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003497 \s*return\s+
3498 )/xg)
3499 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003500 ERROR("TRAILING_STATEMENTS",
3501 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003502 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003503
3504 # Check for }<nl>else {, these must be at the same
3505 # indent level to be relevant to each other.
3506 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3507 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003508 ERROR("ELSE_AFTER_BRACE",
3509 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003510 }
3511
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003512 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3513 $previndent == $indent) {
3514 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3515
3516 # Find out what is on the end of the line after the
3517 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003518 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003519 $s =~ s/\n.*//g;
3520
3521 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003522 ERROR("WHILE_AFTER_BRACE",
3523 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003524 }
3525 }
3526
Joe Perches95e2c602013-07-03 15:05:20 -07003527#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003528 while ($line =~ m{($Constant|$Lval)}g) {
3529 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003530
3531#gcc binary extension
3532 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003533 if (WARN("GCC_BINARY_CONSTANT",
3534 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3535 $fix) {
3536 my $hexval = sprintf("0x%x", oct($var));
3537 $fixed[$linenr - 1] =~
3538 s/\b$var\b/$hexval/;
3539 }
Joe Perches95e2c602013-07-03 15:05:20 -07003540 }
3541
3542#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003543 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003544 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003545#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003546 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003547#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003548 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003549 while ($var =~ m{($Ident)}g) {
3550 my $word = $1;
3551 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
Joe Perchesd8b07712013-11-12 15:10:06 -08003552 if ($check) {
3553 seed_camelcase_includes();
3554 if (!$file && !$camelcase_file_seeded) {
3555 seed_camelcase_file($realfile);
3556 $camelcase_file_seeded = 1;
3557 }
3558 }
Joe Perches7e781f62013-09-11 14:23:55 -07003559 if (!defined $camelcase{$word}) {
3560 $camelcase{$word} = 1;
3561 CHK("CAMELCASE",
3562 "Avoid CamelCase: <$word>\n" . $herecurr);
3563 }
Joe Perches34456862013-07-03 15:05:34 -07003564 }
Joe Perches323c1262012-12-17 16:02:07 -08003565 }
3566 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003567
3568#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003569 if ($line =~ /\#\s*define.*\\\s+$/) {
3570 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3571 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3572 $fix) {
3573 $fixed[$linenr - 1] =~ s/\s+$//;
3574 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003575 }
3576
Andy Whitcroft653d4872007-06-23 17:16:34 -07003577#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003578 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003579 my $file = "$1.h";
3580 my $checkfile = "include/linux/$file";
3581 if (-f "$root/$checkfile" &&
3582 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003583 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003584 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003585 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003586 CHK("ARCH_INCLUDE_LINUX",
3587 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003588 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003589 WARN("INCLUDE_LINUX",
3590 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003591 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003592 }
3593 }
3594
Andy Whitcroft653d4872007-06-23 17:16:34 -07003595# multi-statement macros should be enclosed in a do while loop, grab the
3596# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003597# in a known good container
Andy Whitcroftb8f96a312008-07-23 21:29:07 -07003598 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3599 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003600 my $ln = $linenr;
3601 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003602 my ($off, $dstat, $dcond, $rest);
3603 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003604 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003605 ctx_statement_block($linenr, $realcnt, 0);
3606 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003607 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003608 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003609
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003610 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003611 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003612 $dstat =~ s/\\\n.//g;
3613 $dstat =~ s/^\s*//s;
3614 $dstat =~ s/\s*$//s;
3615
3616 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003617 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3618 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003619 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003620 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003621 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003622
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003623 # Flatten any obvious string concatentation.
3624 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3625 $dstat =~ s/$Ident\s*("X*")/$1/)
3626 {
3627 }
3628
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003629 my $exceptions = qr{
3630 $Declare|
3631 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003632 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003633 DECLARE_PER_CPU|
3634 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003635 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003636 union|
3637 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003638 \.$Ident\s*=\s*|
3639 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003640 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003641 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003642 if ($dstat ne '' &&
3643 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3644 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07003645 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003646 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003647 $dstat !~ /$exceptions/ &&
3648 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003649 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003650 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003651 $dstat !~ /^for\s*$Constant$/ && # for (...)
3652 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3653 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07003654 $dstat !~ /^\({/ && # ({...
3655 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003656 {
3657 $ctx =~ s/\n*$//;
3658 my $herectx = $here . "\n";
3659 my $cnt = statement_rawlines($ctx);
3660
3661 for (my $n = 0; $n < $cnt; $n++) {
3662 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003663 }
3664
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003665 if ($dstat =~ /;/) {
3666 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3667 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3668 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003669 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003670 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003671 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003672 }
Joe Perches5023d342012-12-17 16:01:47 -08003673
Joe Perches481eb482012-12-17 16:01:56 -08003674# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003675
3676 } else {
3677 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003678 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3679 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003680 $line =~ /^\+.*\\$/) {
3681 WARN("LINE_CONTINUATIONS",
3682 "Avoid unnecessary line continuations\n" . $herecurr);
3683 }
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07003684 }
3685
Joe Perchesb13edf72012-07-30 14:41:24 -07003686# do {} while (0) macro tests:
3687# single-statement macros do not need to be enclosed in do while (0) loop,
3688# macro should not end with a semicolon
3689 if ($^V && $^V ge 5.10.0 &&
3690 $realfile !~ m@/vmlinux.lds.h$@ &&
3691 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3692 my $ln = $linenr;
3693 my $cnt = $realcnt;
3694 my ($off, $dstat, $dcond, $rest);
3695 my $ctx = '';
3696 ($dstat, $dcond, $ln, $cnt, $off) =
3697 ctx_statement_block($linenr, $realcnt, 0);
3698 $ctx = $dstat;
3699
3700 $dstat =~ s/\\\n.//g;
3701
3702 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3703 my $stmts = $2;
3704 my $semis = $3;
3705
3706 $ctx =~ s/\n*$//;
3707 my $cnt = statement_rawlines($ctx);
3708 my $herectx = $here . "\n";
3709
3710 for (my $n = 0; $n < $cnt; $n++) {
3711 $herectx .= raw_line($linenr, $n) . "\n";
3712 }
3713
Joe Perchesac8e97f2012-08-21 16:15:53 -07003714 if (($stmts =~ tr/;/;/) == 1 &&
3715 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003716 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3717 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3718 }
3719 if (defined $semis && $semis ne "") {
3720 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3721 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3722 }
3723 }
3724 }
3725
Mike Frysinger080ba922009-01-06 14:41:25 -08003726# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3727# all assignments may have only one of the following with an assignment:
3728# .
3729# ALIGN(...)
3730# VMLINUX_SYMBOL(...)
3731 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003732 WARN("MISSING_VMLINUX_SYMBOL",
3733 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003734 }
3735
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003736# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003737 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3738 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003739 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003740 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003741 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3742 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003743 my @allowed = ();
3744 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003745 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003746 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003747 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003748 for my $chunk (@chunks) {
3749 my ($cond, $block) = @{$chunk};
3750
Andy Whitcroft773647a2008-03-28 14:15:58 -07003751 # If the condition carries leading newlines, then count those as offsets.
3752 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3753 my $offset = statement_rawlines($whitespace) - 1;
3754
Joe Perchesaad4f612012-03-23 15:02:19 -07003755 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003756 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3757
3758 # We have looked at and allowed this specific line.
3759 $suppress_ifbraces{$ln + $offset} = 1;
3760
3761 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003762 $ln += statement_rawlines($block) - 1;
3763
Andy Whitcroft773647a2008-03-28 14:15:58 -07003764 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003765
3766 $seen++ if ($block =~ /^\s*{/);
3767
Joe Perchesaad4f612012-03-23 15:02:19 -07003768 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003769 if (statement_lines($cond) > 1) {
3770 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003771 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003772 }
3773 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003774 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003775 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003776 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003777 if (statement_block_size($block) > 1) {
3778 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003779 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003780 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003781 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003782 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003783 if ($seen) {
3784 my $sum_allowed = 0;
3785 foreach (@allowed) {
3786 $sum_allowed += $_;
3787 }
3788 if ($sum_allowed == 0) {
3789 WARN("BRACES",
3790 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3791 } elsif ($sum_allowed != $allow &&
3792 $seen != $allow) {
3793 CHK("BRACES",
3794 "braces {} should be used on all arms of this statement\n" . $herectx);
3795 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003796 }
3797 }
3798 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003799 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003800 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003801 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003802
Andy Whitcroftcf655042008-03-04 14:28:20 -08003803 # Check the pre-context.
3804 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3805 #print "APW: ALLOWED: pre<$1>\n";
3806 $allowed = 1;
3807 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003808
3809 my ($level, $endln, @chunks) =
3810 ctx_statement_full($linenr, $realcnt, $-[0]);
3811
Andy Whitcroftcf655042008-03-04 14:28:20 -08003812 # Check the condition.
3813 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003814 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003815 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003816 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003817 }
3818 if (statement_lines($cond) > 1) {
3819 #print "APW: ALLOWED: cond<$cond>\n";
3820 $allowed = 1;
3821 }
3822 if ($block =~/\b(?:if|for|while)\b/) {
3823 #print "APW: ALLOWED: block<$block>\n";
3824 $allowed = 1;
3825 }
3826 if (statement_block_size($block) > 1) {
3827 #print "APW: ALLOWED: lines block<$block>\n";
3828 $allowed = 1;
3829 }
3830 # Check the post-context.
3831 if (defined $chunks[1]) {
3832 my ($cond, $block) = @{$chunks[1]};
3833 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003834 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003835 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003836 if ($block =~ /^\s*\{/) {
3837 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3838 $allowed = 1;
3839 }
3840 }
3841 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003842 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003843 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003844
Andy Whitcroftf0556632008-10-15 22:02:23 -07003845 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003846 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003847 }
3848
Joe Perches000d1cc12011-07-25 17:13:25 -07003849 WARN("BRACES",
3850 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003851 }
3852 }
3853
Joe Perches0979ae62012-12-17 16:01:59 -08003854# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07003855 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003856 CHK("BRACES",
3857 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3858 }
Joe Perches77b9a532013-07-03 15:05:29 -07003859 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003860 CHK("BRACES",
3861 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3862 }
3863
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003864# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003865 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3866 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003867 WARN("VOLATILE",
3868 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003869 }
3870
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003871# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003872 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003873 CHK("REDUNDANT_CODE",
3874 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003875 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003876 }
3877
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003878# check for needless "if (<foo>) fn(<foo>)" uses
3879 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3880 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3881 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3882 WARN('NEEDLESS_IF',
3883 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003884 }
3885 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003886
Joe Perches8716de32013-09-11 14:24:05 -07003887# check for bad placement of section $InitAttribute (e.g.: __initdata)
3888 if ($line =~ /(\b$InitAttribute\b)/) {
3889 my $attr = $1;
3890 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
3891 my $ptr = $1;
3892 my $var = $2;
3893 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
3894 ERROR("MISPLACED_INIT",
3895 "$attr should be placed after $var\n" . $herecurr)) ||
3896 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
3897 WARN("MISPLACED_INIT",
3898 "$attr should be placed after $var\n" . $herecurr))) &&
3899 $fix) {
3900 $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;
3901 }
3902 }
3903 }
3904
Joe Perchese970b8842013-11-12 15:10:10 -08003905# check for $InitAttributeData (ie: __initdata) with const
3906 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) {
3907 my $attr = $1;
3908 $attr =~ /($InitAttributePrefix)(.*)/;
3909 my $attr_prefix = $1;
3910 my $attr_type = $2;
3911 if (ERROR("INIT_ATTRIBUTE",
3912 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) &&
3913 $fix) {
3914 $fixed[$linenr - 1] =~
3915 s/$InitAttributeData/${attr_prefix}initconst/;
3916 }
3917 }
3918
3919# check for $InitAttributeConst (ie: __initconst) without const
3920 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) {
3921 my $attr = $1;
3922 if (ERROR("INIT_ATTRIBUTE",
3923 "Use of $attr requires a separate use of const\n" . $herecurr) &&
3924 $fix) {
3925 my $lead = $fixed[$linenr - 1] =~
3926 /(^\+\s*(?:static\s+))/;
3927 $lead = rtrim($1);
3928 $lead = "$lead " if ($lead !~ /^\+$/);
3929 $lead = "${lead}const ";
3930 $fixed[$linenr - 1] =~ s/(^\+\s*(?:static\s+))/$lead/;
3931 }
3932 }
3933
Joe Perchesfbdb8132014-04-03 14:49:14 -07003934# don't use __constant_<foo> functions outside of include/uapi/
3935 if ($realfile !~ m@^include/uapi/@ &&
3936 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
3937 my $constant_func = $1;
3938 my $func = $constant_func;
3939 $func =~ s/^__constant_//;
3940 if (WARN("CONSTANT_CONVERSION",
3941 "$constant_func should be $func\n" . $herecurr) &&
3942 $fix) {
3943 $fixed[$linenr - 1] =~ s/\b$constant_func\b/$func/g;
3944 }
3945 }
3946
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003947# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08003948 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Joe Perches43c1d772014-04-03 14:49:11 -07003949 my $delay = $1;
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003950 # ignore udelay's < 10, however
Joe Perches43c1d772014-04-03 14:49:11 -07003951 if (! ($delay < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003952 CHK("USLEEP_RANGE",
Joe Perches43c1d772014-04-03 14:49:11 -07003953 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
3954 }
3955 if ($delay > 2000) {
3956 WARN("LONG_UDELAY",
3957 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003958 }
3959 }
3960
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003961# warn about unexpectedly long msleep's
3962 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3963 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003964 WARN("MSLEEP",
Joe Perches43c1d772014-04-03 14:49:11 -07003965 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003966 }
3967 }
3968
Joe Perches36ec1932013-07-03 15:05:25 -07003969# check for comparisons of jiffies
3970 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
3971 WARN("JIFFIES_COMPARISON",
3972 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
3973 }
3974
Joe Perches9d7a34a2013-07-03 15:05:26 -07003975# check for comparisons of get_jiffies_64()
3976 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
3977 WARN("JIFFIES_COMPARISON",
3978 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
3979 }
3980
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003981# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003982# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df344f2007-06-08 13:47:06 -07003983# print "#ifdef in C files should be avoided\n";
3984# print "$herecurr";
3985# $clean = 0;
3986# }
3987
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003988# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003989 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003990 if (ERROR("SPACING",
3991 "exactly one space required after that #$1\n" . $herecurr) &&
3992 $fix) {
3993 $fixed[$linenr - 1] =~
3994 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
3995 }
3996
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003997 }
3998
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003999# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004000 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
4001 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004002 my $which = $1;
4003 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004004 CHK("UNCOMMENTED_DEFINITION",
4005 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004006 }
4007 }
4008# check for memory barriers without a comment.
4009 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4010 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perchesc1fd7bb2013-11-12 15:10:11 -08004011 WARN("MEMORY_BARRIER",
4012 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07004013 }
4014 }
4015# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004016 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004017 CHK("ARCH_DEFINES",
4018 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004019 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004020
Tobias Klauserd4977c72010-05-24 14:33:30 -07004021# Check that the storage class is at the beginning of a declaration
4022 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004023 WARN("STORAGE_CLASS",
4024 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07004025 }
4026
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004027# check the location of the inline attribute, that it is between
4028# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004029 if ($line =~ /\b$Type\s+$Inline\b/ ||
4030 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004031 ERROR("INLINE_LOCATION",
4032 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004033 }
4034
Andy Whitcroft8905a672007-11-28 16:21:06 -08004035# Check for __inline__ and __inline, prefer inline
Joe Perches2b7ab452013-11-12 15:10:14 -08004036 if ($realfile !~ m@\binclude/uapi/@ &&
4037 $line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004038 if (WARN("INLINE",
4039 "plain inline is preferred over $1\n" . $herecurr) &&
4040 $fix) {
4041 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
4042
4043 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004044 }
4045
Joe Perches3d130fd2011-01-12 17:00:00 -08004046# Check for __attribute__ packed, prefer __packed
Joe Perches2b7ab452013-11-12 15:10:14 -08004047 if ($realfile !~ m@\binclude/uapi/@ &&
4048 $line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004049 WARN("PREFER_PACKED",
4050 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08004051 }
4052
Joe Perches39b7e282011-07-25 17:13:24 -07004053# Check for __attribute__ aligned, prefer __aligned
Joe Perches2b7ab452013-11-12 15:10:14 -08004054 if ($realfile !~ m@\binclude/uapi/@ &&
4055 $line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004056 WARN("PREFER_ALIGNED",
4057 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07004058 }
4059
Joe Perches5f14d3b2012-01-10 15:09:52 -08004060# Check for __attribute__ format(printf, prefer __printf
Joe Perches2b7ab452013-11-12 15:10:14 -08004061 if ($realfile !~ m@\binclude/uapi/@ &&
4062 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004063 if (WARN("PREFER_PRINTF",
4064 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4065 $fix) {
4066 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4067
4068 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08004069 }
4070
Joe Perches6061d942012-03-23 15:02:16 -07004071# Check for __attribute__ format(scanf, prefer __scanf
Joe Perches2b7ab452013-11-12 15:10:14 -08004072 if ($realfile !~ m@\binclude/uapi/@ &&
4073 $line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004074 if (WARN("PREFER_SCANF",
4075 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4076 $fix) {
4077 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4078 }
Joe Perches6061d942012-03-23 15:02:16 -07004079 }
4080
Joe Perches8f53a9b2010-03-05 13:43:48 -08004081# check for sizeof(&)
4082 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004083 WARN("SIZEOF_ADDRESS",
4084 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08004085 }
4086
Joe Perches66c80b62012-07-30 14:41:22 -07004087# check for sizeof without parenthesis
4088 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004089 if (WARN("SIZEOF_PARENTHESIS",
4090 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
4091 $fix) {
4092 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4093 }
Joe Perches66c80b62012-07-30 14:41:22 -07004094 }
4095
Joe Perches428e2fd2011-05-24 17:13:39 -07004096# check for line continuations in quoted strings with odd counts of "
4097 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004098 WARN("LINE_CONTINUATIONS",
4099 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07004100 }
4101
Joe Perches88982fe2012-12-17 16:02:00 -08004102# check for struct spinlock declarations
4103 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
4104 WARN("USE_SPINLOCK_T",
4105 "struct spinlock should be spinlock_t\n" . $herecurr);
4106 }
4107
Joe Perchesa6962d72013-04-29 16:18:13 -07004108# check for seq_printf uses that could be seq_puts
Joe Perches06668722013-11-12 15:10:07 -08004109 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) {
Joe Perchesa6962d72013-04-29 16:18:13 -07004110 my $fmt = get_quoted_string($line, $rawline);
Joe Perches06668722013-11-12 15:10:07 -08004111 if ($fmt ne "" && $fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004112 if (WARN("PREFER_SEQ_PUTS",
4113 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
4114 $fix) {
4115 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
4116 }
Joe Perchesa6962d72013-04-29 16:18:13 -07004117 }
4118 }
4119
Andy Whitcroft554e1652012-01-10 15:09:57 -08004120# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004121 if ($^V && $^V ge 5.10.0 &&
4122 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004123 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08004124
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004125 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004126 my $ms_val = $7;
4127 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004128
Andy Whitcroft554e1652012-01-10 15:09:57 -08004129 if ($ms_size =~ /^(0x|)0$/i) {
4130 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004131 "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 -08004132 } elsif ($ms_size =~ /^(0x|)1$/i) {
4133 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004134 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
4135 }
4136 }
4137
Joe Perches98a9bba2014-01-23 15:54:52 -08004138# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4139 if ($^V && $^V ge 5.10.0 &&
4140 $line =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/s) {
4141 if (WARN("PREFER_ETHER_ADDR_COPY",
4142 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4143 $fix) {
4144 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4145 }
4146 }
4147
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004148# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004149 if ($^V && $^V ge 5.10.0 &&
4150 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004151 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004152 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004153 my $call = $1;
4154 my $cast1 = deparenthesize($2);
4155 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004156 my $cast2 = deparenthesize($7);
4157 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004158 my $cast;
4159
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004160 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08004161 $cast = "$cast1 or $cast2";
4162 } elsif ($cast1 ne "") {
4163 $cast = $cast1;
4164 } else {
4165 $cast = $cast2;
4166 }
4167 WARN("MINMAX",
4168 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08004169 }
4170 }
4171
Joe Perches4a273192012-07-30 14:41:20 -07004172# check usleep_range arguments
4173 if ($^V && $^V ge 5.10.0 &&
4174 defined $stat &&
4175 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
4176 my $min = $1;
4177 my $max = $7;
4178 if ($min eq $max) {
4179 WARN("USLEEP_RANGE",
4180 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4181 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
4182 $min > $max) {
4183 WARN("USLEEP_RANGE",
4184 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4185 }
4186 }
4187
Joe Perches823b7942013-11-12 15:10:15 -08004188# check for naked sscanf
4189 if ($^V && $^V ge 5.10.0 &&
4190 defined $stat &&
Joe Perches6c8bd702014-04-03 14:49:16 -07004191 $line =~ /\bsscanf\b/ &&
Joe Perches823b7942013-11-12 15:10:15 -08004192 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ &&
4193 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ &&
4194 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) {
4195 my $lc = $stat =~ tr@\n@@;
4196 $lc = $lc + $linenr;
4197 my $stat_real = raw_line($linenr, 0);
4198 for (my $count = $linenr + 1; $count <= $lc; $count++) {
4199 $stat_real = $stat_real . "\n" . raw_line($count, 0);
4200 }
4201 WARN("NAKED_SSCANF",
4202 "unchecked sscanf return value\n" . "$here\n$stat_real\n");
4203 }
4204
Joe Perches70dc8a42013-09-11 14:23:58 -07004205# check for new externs in .h files.
4206 if ($realfile =~ /\.h$/ &&
4207 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
Joe Perchesd1d85782013-09-24 15:27:46 -07004208 if (CHK("AVOID_EXTERNS",
4209 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
Joe Perches70dc8a42013-09-11 14:23:58 -07004210 $fix) {
4211 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
4212 }
4213 }
4214
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004215# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004216 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004217 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004218 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004219 my $function_name = $1;
4220 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004221
4222 my $s = $stat;
4223 if (defined $cond) {
4224 substr($s, 0, length($cond), '');
4225 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004226 if ($s =~ /^\s*;/ &&
4227 $function_name ne 'uninitialized_var')
4228 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004229 WARN("AVOID_EXTERNS",
4230 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004231 }
4232
4233 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004234 WARN("FUNCTION_ARGUMENTS",
4235 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004236 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004237
4238 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4239 $stat =~ /^.\s*extern\s+/)
4240 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004241 WARN("AVOID_EXTERNS",
4242 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004243 }
4244
4245# checks for new __setup's
4246 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4247 my $name = $1;
4248
4249 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004250 CHK("UNDOCUMENTED_SETUP",
4251 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004252 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004253 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004254
4255# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004256 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004257 WARN("UNNECESSARY_CASTS",
4258 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004259 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004260
Joe Perchesa640d252013-07-03 15:05:21 -07004261# alloc style
4262# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4263 if ($^V && $^V ge 5.10.0 &&
4264 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4265 CHK("ALLOC_SIZEOF_STRUCT",
4266 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4267 }
4268
Joe Perches972fdea2013-04-29 16:18:12 -07004269# check for krealloc arg reuse
4270 if ($^V && $^V ge 5.10.0 &&
4271 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4272 WARN("KREALLOC_ARG_REUSE",
4273 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4274 }
4275
Joe Perches5ce59ae2013-02-21 16:44:18 -08004276# check for alloc argument mismatch
4277 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4278 WARN("ALLOC_ARRAY_ARGS",
4279 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4280 }
4281
David Rientjes7e4915e2014-01-23 15:54:42 -08004282# check for GFP_NOWAIT use
4283 if ($line =~ /\b__GFP_NOFAIL\b/) {
4284 WARN("__GFP_NOFAIL",
4285 "Use of __GFP_NOFAIL is deprecated, no new users should be added\n" . $herecurr);
4286 }
4287
Joe Perchescaf2a542011-01-12 16:59:56 -08004288# check for multiple semicolons
4289 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004290 if (WARN("ONE_SEMICOLON",
4291 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4292 $fix) {
4293 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4294 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004295 }
4296
Joe Perchesc34c09a2014-01-23 15:54:43 -08004297# check for case / default statements not preceeded by break/fallthrough/switch
4298 if ($line =~ /^.\s*(?:case\s+(?:$Ident|$Constant)\s*|default):/) {
4299 my $has_break = 0;
4300 my $has_statement = 0;
4301 my $count = 0;
4302 my $prevline = $linenr;
4303 while ($prevline > 1 && $count < 3 && !$has_break) {
4304 $prevline--;
4305 my $rline = $rawlines[$prevline - 1];
4306 my $fline = $lines[$prevline - 1];
4307 last if ($fline =~ /^\@\@/);
4308 next if ($fline =~ /^\-/);
4309 next if ($fline =~ /^.(?:\s*(?:case\s+(?:$Ident|$Constant)[\s$;]*|default):[\s$;]*)*$/);
4310 $has_break = 1 if ($rline =~ /fall[\s_-]*(through|thru)/i);
4311 next if ($fline =~ /^.[\s$;]*$/);
4312 $has_statement = 1;
4313 $count++;
4314 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|return\b|goto\b|continue\b)/);
4315 }
4316 if (!$has_break && $has_statement) {
4317 WARN("MISSING_BREAK",
4318 "Possible switch case/default not preceeded by break or fallthrough comment\n" . $herecurr);
4319 }
4320 }
4321
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004322# check for switch/default statements without a break;
4323 if ($^V && $^V ge 5.10.0 &&
4324 defined $stat &&
4325 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4326 my $ctx = '';
4327 my $herectx = $here . "\n";
4328 my $cnt = statement_rawlines($stat);
4329 for (my $n = 0; $n < $cnt; $n++) {
4330 $herectx .= raw_line($linenr, $n) . "\n";
4331 }
4332 WARN("DEFAULT_NO_BREAK",
4333 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004334 }
4335
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004336# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004337 if ($line =~ /\b__FUNCTION__\b/) {
4338 if (WARN("USE_FUNC",
4339 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4340 $fix) {
4341 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4342 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004343 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004344
Joe Perches2c924882012-03-23 15:02:20 -07004345# check for use of yield()
4346 if ($line =~ /\byield\s*\(\s*\)/) {
4347 WARN("YIELD",
4348 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4349 }
4350
Joe Perches179f8f42013-07-03 15:05:30 -07004351# check for comparisons against true and false
4352 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4353 my $lead = $1;
4354 my $arg = $2;
4355 my $test = $3;
4356 my $otype = $4;
4357 my $trail = $5;
4358 my $op = "!";
4359
4360 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4361
4362 my $type = lc($otype);
4363 if ($type =~ /^(?:true|false)$/) {
4364 if (("$test" eq "==" && "$type" eq "true") ||
4365 ("$test" eq "!=" && "$type" eq "false")) {
4366 $op = "";
4367 }
4368
4369 CHK("BOOL_COMPARISON",
4370 "Using comparison to $otype is error prone\n" . $herecurr);
4371
4372## maybe suggesting a correct construct would better
4373## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4374
4375 }
4376 }
4377
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004378# check for semaphores initialized locked
4379 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004380 WARN("CONSIDER_COMPLETION",
4381 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004382 }
Joe Perches6712d852012-03-23 15:02:20 -07004383
Joe Perches67d0a072011-10-31 17:13:10 -07004384# recommend kstrto* over simple_strto* and strict_strto*
4385 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004386 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004387 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004388 }
Joe Perches6712d852012-03-23 15:02:20 -07004389
Michael Ellermanf3db6632008-07-23 21:28:57 -07004390# check for __initcall(), use device_initcall() explicitly please
4391 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004392 WARN("USE_DEVICE_INITCALL",
4393 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07004394 }
Joe Perches6712d852012-03-23 15:02:20 -07004395
Emese Revfy79404842010-03-05 13:43:53 -08004396# check for various ops structs, ensure they are const.
4397 my $struct_ops = qr{acpi_dock_ops|
4398 address_space_operations|
4399 backlight_ops|
4400 block_device_operations|
4401 dentry_operations|
4402 dev_pm_ops|
4403 dma_map_ops|
4404 extent_io_ops|
4405 file_lock_operations|
4406 file_operations|
4407 hv_ops|
4408 ide_dma_ops|
4409 intel_dvo_dev_ops|
4410 item_operations|
4411 iwl_ops|
4412 kgdb_arch|
4413 kgdb_io|
4414 kset_uevent_ops|
4415 lock_manager_operations|
4416 microcode_ops|
4417 mtrr_ops|
4418 neigh_ops|
4419 nlmsvc_binding|
4420 pci_raw_ops|
4421 pipe_buf_operations|
4422 platform_hibernation_ops|
4423 platform_suspend_ops|
4424 proto_ops|
4425 rpc_pipe_ops|
4426 seq_operations|
4427 snd_ac97_build_ops|
4428 soc_pcmcia_socket_ops|
4429 stacktrace_ops|
4430 sysfs_ops|
4431 tty_operations|
4432 usb_mon_operations|
4433 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004434 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004435 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004436 WARN("CONST_STRUCT",
4437 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004438 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004439 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004440
4441# use of NR_CPUS is usually wrong
4442# ignore definitions of NR_CPUS and usage to define arrays as likely right
4443 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004444 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4445 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004446 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4447 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4448 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004449 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004450 WARN("NR_CPUS",
4451 "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 -07004452 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004453
Joe Perches52ea8502013-11-12 15:10:09 -08004454# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4455 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) {
4456 ERROR("DEFINE_ARCH_HAS",
4457 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr);
4458 }
4459
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004460# check for %L{u,d,i} in strings
4461 my $string;
4462 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4463 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004464 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004465 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004466 WARN("PRINTF_L",
4467 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004468 last;
4469 }
4470 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004471
4472# whine mightly about in_atomic
4473 if ($line =~ /\bin_atomic\s*\(/) {
4474 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004475 ERROR("IN_ATOMIC",
4476 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004477 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004478 WARN("IN_ATOMIC",
4479 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004480 }
4481 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004482
4483# check for lockdep_set_novalidate_class
4484 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4485 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4486 if ($realfile !~ m@^kernel/lockdep@ &&
4487 $realfile !~ m@^include/linux/lockdep@ &&
4488 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004489 ERROR("LOCKDEP",
4490 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004491 }
4492 }
Dave Jones88f88312011-01-12 16:59:59 -08004493
4494 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4495 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004496 WARN("EXPORTED_WORLD_WRITABLE",
4497 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004498 }
Joe Perches24358802014-04-03 14:49:13 -07004499
4500 foreach my $entry (@mode_permission_funcs) {
4501 my $func = $entry->[0];
4502 my $arg_pos = $entry->[1];
4503
4504 my $skip_args = "";
4505 if ($arg_pos > 1) {
4506 $arg_pos--;
4507 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}";
4508 }
4509 my $test = "\\b$func\\s*\\(${skip_args}([\\d]+)\\s*[,\\)]";
4510 if ($^V && $^V ge 5.10.0 &&
4511 $line =~ /$test/) {
4512 my $val = $1;
4513 $val = $6 if ($skip_args ne "");
4514
Joe Perches1727cc72014-04-03 14:49:15 -07004515 if ($val !~ /^0$/ &&
4516 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) ||
4517 length($val) ne 4)) {
Joe Perches24358802014-04-03 14:49:13 -07004518 ERROR("NON_OCTAL_PERMISSIONS",
Joe Perches1727cc72014-04-03 14:49:15 -07004519 "Use 4 digit octal (0777) not decimal permissions\n" . $herecurr);
Joe Perches24358802014-04-03 14:49:13 -07004520 }
4521 }
4522 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004523 }
4524
4525 # If we have no input at all, then there is nothing to report on
4526 # so just keep quiet.
4527 if ($#rawlines == -1) {
4528 exit(0);
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004529 }
4530
Andy Whitcroft8905a672007-11-28 16:21:06 -08004531 # In mailback mode only produce a report in the negative, for
4532 # things that appear to be patches.
4533 if ($mailback && ($clean == 1 || !$is_patch)) {
4534 exit(0);
4535 }
4536
4537 # This is not a patch, and we are are in 'no-patch' mode so
4538 # just keep quiet.
4539 if (!$chk_patch && !$is_patch) {
4540 exit(0);
4541 }
4542
4543 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004544 ERROR("NOT_UNIFIED_DIFF",
4545 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004546 }
4547 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004548 ERROR("MISSING_SIGN_OFF",
4549 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004550 }
4551
Andy Whitcroft8905a672007-11-28 16:21:06 -08004552 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004553 if ($summary && !($clean == 1 && $quiet == 1)) {
4554 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004555 print "total: $cnt_error errors, $cnt_warn warnings, " .
4556 (($check)? "$cnt_chk checks, " : "") .
4557 "$cnt_lines lines checked\n";
4558 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004559 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004560
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004561 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004562
4563 if ($^V lt 5.10.0) {
4564 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4565 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4566 }
4567
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004568 # If there were whitespace errors which cleanpatch can fix
4569 # then suggest that.
4570 if ($rpt_cleaners) {
4571 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4572 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07004573 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004574 }
4575 }
4576
Joe Perches91bfe482013-09-11 14:23:59 -07004577 hash_show_words(\%use_type, "Used");
4578 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07004579
Joe Perches3705ce52013-07-03 15:05:31 -07004580 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
Joe Perches9624b8d2014-01-23 15:54:44 -08004581 my $newfile = $filename;
4582 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace);
Joe Perches3705ce52013-07-03 15:05:31 -07004583 my $linecount = 0;
4584 my $f;
4585
4586 open($f, '>', $newfile)
4587 or die "$P: Can't open $newfile for write\n";
4588 foreach my $fixed_line (@fixed) {
4589 $linecount++;
4590 if ($file) {
4591 if ($linecount > 3) {
4592 $fixed_line =~ s/^\+//;
4593 print $f $fixed_line. "\n";
4594 }
4595 } else {
4596 print $f $fixed_line . "\n";
4597 }
4598 }
4599 close($f);
4600
4601 if (!$quiet) {
4602 print << "EOM";
4603Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4604
4605Do _NOT_ trust the results written to this file.
4606Do _NOT_ submit these changes without inspecting them for correctness.
4607
4608This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4609No warranties, expressed or implied...
4610
4611EOM
4612 }
4613 }
4614
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004615 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004616 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004617 }
4618 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004619 print << "EOM";
4620$vname has style problems, please review.
4621
4622If any of these errors are false positives, please report
4623them to the maintainer, see CHECKPATCH in MAINTAINERS.
4624EOM
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004625 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004626
Andy Whitcroft0a920b5b2007-06-01 00:46:48 -07004627 return $clean;
4628}