blob: 9163651edc5092ddb8ad862103233f8ac834cc35 [file] [log] [blame]
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001#!/usr/bin/perl -w
Dave Jonesdbf004d2010-01-12 16:59:52 -05002# (c) 2001, Dave Jones. (the file handling bit)
Andy Whitcroft00df3442007-06-08 13:47:06 -07003# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
Andy Whitcroft2a5a2c22009-01-06 14:41:23 -08004# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
Andy Whitcroft015830b2010-10-26 14:23:17 -07005# (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
Andy Whitcroft0a920b52007-06-01 00:46:48 -07006# Licensed under the terms of the GNU GPL License version 2
7
8use strict;
Joe Perchesc707a812013-07-08 16:00:43 -07009use POSIX;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070010
11my $P = $0;
Andy Whitcroft00df3442007-06-08 13:47:06 -070012$P =~ s@.*/@@g;
Andy Whitcroft0a920b52007-06-01 00:46:48 -070013
Joe Perches000d1cc12011-07-25 17:13:25 -070014my $V = '0.32';
Andy Whitcroft0a920b52007-06-01 00:46:48 -070015
16use Getopt::Long qw(:config no_auto_abbrev);
17
18my $quiet = 0;
19my $tree = 1;
20my $chk_signoff = 1;
21my $chk_patch = 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -070022my $tst_only;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070023my $emacs = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080024my $terse = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070025my $file = 0;
26my $check = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -080027my $summary = 1;
28my $mailback = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -080029my $summary_file = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070030my $show_types = 0;
Joe Perches3705ce52013-07-03 15:05:31 -070031my $fix = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -070032my $root;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -080033my %debug;
Joe Perches000d1cc12011-07-25 17:13:25 -070034my %ignore_type = ();
Joe Perches34456862013-07-03 15:05:34 -070035my %camelcase = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070036my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070037my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070038my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080039my $max_line_length = 80;
Hannes Eder77f5b102009-09-21 17:04:37 -070040
41sub help {
42 my ($exitcode) = @_;
43
44 print << "EOM";
45Usage: $P [OPTION]... [FILE]...
46Version: $V
47
48Options:
49 -q, --quiet quiet
50 --no-tree run without a kernel tree
51 --no-signoff do not check for 'Signed-off-by' line
52 --patch treat FILE as patchfile (default)
53 --emacs emacs compile window format
54 --terse one line per report
55 -f, --file treat FILE as regular source file
56 --subjective, --strict enable more subjective tests
Joe Perches000d1cc12011-07-25 17:13:25 -070057 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080058 --max-line-length=n set the maximum line length, if exceeded, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070059 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070060 --root=PATH PATH to the kernel tree root
61 --no-summary suppress the per-file summary
62 --mailback only produce a report in case of warnings/errors
63 --summary-file include the filename in summary
64 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
65 'values', 'possible', 'type', and 'attr' (default
66 is all off)
67 --test-only=WORD report only warnings/errors containing WORD
68 literally
Joe Perches3705ce52013-07-03 15:05:31 -070069 --fix EXPERIMENTAL - may create horrible results
70 If correctable single-line errors exist, create
71 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
72 with potential errors corrected to the preferred
73 checkpatch style
Hannes Eder77f5b102009-09-21 17:04:37 -070074 -h, --help, --version display this help and exit
75
76When FILE is - read standard input.
77EOM
78
79 exit($exitcode);
80}
81
Joe Perches000d1cc12011-07-25 17:13:25 -070082my $conf = which_conf($configuration_file);
83if (-f $conf) {
84 my @conf_args;
85 open(my $conffile, '<', "$conf")
86 or warn "$P: Can't find a readable $configuration_file file $!\n";
87
88 while (<$conffile>) {
89 my $line = $_;
90
91 $line =~ s/\s*\n?$//g;
92 $line =~ s/^\s*//g;
93 $line =~ s/\s+/ /g;
94
95 next if ($line =~ m/^\s*#/);
96 next if ($line =~ m/^\s*$/);
97
98 my @words = split(" ", $line);
99 foreach my $word (@words) {
100 last if ($word =~ m/^#/);
101 push (@conf_args, $word);
102 }
103 }
104 close($conffile);
105 unshift(@ARGV, @conf_args) if @conf_args;
106}
107
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700108GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700109 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700110 'tree!' => \$tree,
111 'signoff!' => \$chk_signoff,
112 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700113 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800114 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700115 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700116 'subjective!' => \$check,
117 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700118 'ignore=s' => \@ignore,
119 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800120 'max-line-length=i' => \$max_line_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700121 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800122 'summary!' => \$summary,
123 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800124 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700125 'fix!' => \$fix,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800126 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700127 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700128 'h|help' => \$help,
129 'version' => \$help
130) or help(1);
131
132help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700133
134my $exit = 0;
135
136if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700137 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700138 exit(1);
139}
140
Joe Perches000d1cc12011-07-25 17:13:25 -0700141@ignore = split(/,/, join(',',@ignore));
142foreach my $word (@ignore) {
143 $word =~ s/\s*\n?$//g;
144 $word =~ s/^\s*//g;
145 $word =~ s/\s+/ /g;
146 $word =~ tr/[a-z]/[A-Z]/;
147
148 next if ($word =~ m/^\s*#/);
149 next if ($word =~ m/^\s*$/);
150
151 $ignore_type{$word}++;
152}
153
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800154my $dbg_values = 0;
155my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700156my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700157my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800158for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800159 ## no critic
160 eval "\${dbg_$key} = '$debug{$key}';";
161 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800162}
163
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700164my $rpt_cleaners = 0;
165
Andy Whitcroft8905a672007-11-28 16:21:06 -0800166if ($terse) {
167 $emacs = 1;
168 $quiet++;
169}
170
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700171if ($tree) {
172 if (defined $root) {
173 if (!top_of_kernel_tree($root)) {
174 die "$P: $root: --root does not point at a valid tree\n";
175 }
176 } else {
177 if (top_of_kernel_tree('.')) {
178 $root = '.';
179 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
180 top_of_kernel_tree($1)) {
181 $root = $1;
182 }
183 }
184
185 if (!defined $root) {
186 print "Must be run from the top-level dir. of a kernel tree\n";
187 exit(2);
188 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700189}
190
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700191my $emitted_corrupt = 0;
192
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700193our $Ident = qr{
194 [A-Za-z_][A-Za-z\d_]*
195 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
196 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700197our $Storage = qr{extern|static|asmlinkage};
198our $Sparse = qr{
199 __user|
200 __kernel|
201 __force|
202 __iomem|
203 __must_check|
204 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800205 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700206 __ref|
207 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700208 }x;
Wolfram Sang52131292010-03-05 13:43:51 -0800209
210# Notes to $Attribute:
211# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700212our $Attribute = qr{
213 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700214 __percpu|
215 __nocast|
216 __safe|
217 __bitwise__|
218 __packed__|
219 __packed2__|
220 __naked|
221 __maybe_unused|
222 __always_unused|
223 __noreturn|
224 __used|
225 __cold|
226 __noclone|
227 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700228 __read_mostly|
229 __kprobes|
Wolfram Sang52131292010-03-05 13:43:51 -0800230 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700231 ____cacheline_aligned|
232 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800233 ____cacheline_internodealigned_in_smp|
234 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700235 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700236our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700237our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700238our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
239our $Lval = qr{$Ident(?:$Member)*};
240
Joe Perches95e2c602013-07-03 15:05:20 -0700241our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
242our $Binary = qr{(?i)0b[01]+$Int_type?};
243our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
244our $Int = qr{[0-9]+$Int_type?};
Joe Perches326b1ff2013-02-04 14:28:51 -0800245our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
246our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
247our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800248our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches95e2c602013-07-03 15:05:20 -0700249our $Constant = qr{$Float|$Binary|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800250our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800251our $Compare = qr{<=|>=|==|!=|<|>};
Joe Perches23f780c2013-07-03 15:05:31 -0700252our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700253our $Operators = qr{
254 <=|>=|==|!=|
255 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700256 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700257 }x;
258
Andy Whitcroft8905a672007-11-28 16:21:06 -0800259our $NonptrType;
260our $Type;
261our $Declare;
262
Joe Perches15662b32011-10-31 17:13:12 -0700263our $NON_ASCII_UTF8 = qr{
264 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700265 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
266 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
267 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
268 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
269 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
270 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
271}x;
272
Joe Perches15662b32011-10-31 17:13:12 -0700273our $UTF8 = qr{
274 [\x09\x0A\x0D\x20-\x7E] # ASCII
275 | $NON_ASCII_UTF8
276}x;
277
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700278our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700279 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700280 atomic_t
281)};
282
Joe Perches691e6692010-03-05 13:43:51 -0800283our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700284 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700285 (?:[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 -0700286 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700287 panic|
288 MODULE_[A-Z_]+
Joe Perches691e6692010-03-05 13:43:51 -0800289)};
290
Joe Perches20112472011-07-25 17:13:23 -0700291our $signature_tags = qr{(?xi:
292 Signed-off-by:|
293 Acked-by:|
294 Tested-by:|
295 Reviewed-by:|
296 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700297 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700298 To:|
299 Cc:
300)};
301
Andy Whitcroft8905a672007-11-28 16:21:06 -0800302our @typeList = (
303 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700304 qr{(?:unsigned\s+)?char},
305 qr{(?:unsigned\s+)?short},
306 qr{(?:unsigned\s+)?int},
307 qr{(?:unsigned\s+)?long},
308 qr{(?:unsigned\s+)?long\s+int},
309 qr{(?:unsigned\s+)?long\s+long},
310 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800311 qr{unsigned},
312 qr{float},
313 qr{double},
314 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800315 qr{struct\s+$Ident},
316 qr{union\s+$Ident},
317 qr{enum\s+$Ident},
318 qr{${Ident}_t},
319 qr{${Ident}_handler},
320 qr{${Ident}_handler_fn},
321);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700322our @modifierList = (
323 qr{fastcall},
324);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800325
Wolfram Sang7840a942010-08-09 17:20:57 -0700326our $allowed_asm_includes = qr{(?x:
327 irq|
328 memory
329)};
330# memory.h: ARM has a custom one
331
Andy Whitcroft8905a672007-11-28 16:21:06 -0800332sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700333 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
334 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700335 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800336 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700337 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800338 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800339 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700340 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700341 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800342 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700343 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800344 }x;
345 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700346 $NonptrType
Andy Whitcroftb337d8b2012-03-23 15:02:18 -0700347 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700348 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800349 }x;
350 $Declare = qr{(?:$Storage\s+)?$Type};
351}
352build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700353
Joe Perches7d2367a2011-07-25 17:13:22 -0700354our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700355
356# Using $balanced_parens, $LvalOrFunc, or $FuncArg
357# requires at least perl version v5.10.0
358# Any use must be runtime checked with $^V
359
360our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
361our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800362our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700363
364sub deparenthesize {
365 my ($string) = @_;
366 return "" if (!defined($string));
367 $string =~ s@^\s*\(\s*@@g;
368 $string =~ s@\s*\)\s*$@@g;
369 $string =~ s@\s+@ @g;
370 return $string;
371}
372
Joe Perches34456862013-07-03 15:05:34 -0700373sub seed_camelcase_file {
374 my ($file) = @_;
375
376 return if (!(-f $file));
377
378 local $/;
379
380 open(my $include_file, '<', "$file")
381 or warn "$P: Can't read '$file' $!\n";
382 my $text = <$include_file>;
383 close($include_file);
384
385 my @lines = split('\n', $text);
386
387 foreach my $line (@lines) {
388 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
389 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
390 $camelcase{$1} = 1;
391 }
392 elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*\(/) {
393 $camelcase{$1} = 1;
394 }
395 }
396}
397
398my $camelcase_seeded = 0;
399sub seed_camelcase_includes {
400 return if ($camelcase_seeded);
401
402 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700403 my $camelcase_cache = "";
404 my @include_files = ();
405
406 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700407
Joe Perches34456862013-07-03 15:05:34 -0700408 if (-d ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700409 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
410 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700411 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700412 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700413 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700414 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700415 @include_files = split('\n', $files);
416 foreach my $file (@include_files) {
417 my $date = POSIX::strftime("%Y%m%d%H%M",
418 localtime((stat $file)[9]));
419 $last_mod_date = $date if ($last_mod_date < $date);
420 }
421 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700422 }
Joe Perchesc707a812013-07-08 16:00:43 -0700423
424 if ($camelcase_cache ne "" && -f $camelcase_cache) {
425 open(my $camelcase_file, '<', "$camelcase_cache")
426 or warn "$P: Can't read '$camelcase_cache' $!\n";
427 while (<$camelcase_file>) {
428 chomp;
429 $camelcase{$_} = 1;
430 }
431 close($camelcase_file);
432
433 return;
434 }
435
436 if (-d ".git") {
437 $files = `git ls-files "include/*.h"`;
438 @include_files = split('\n', $files);
439 }
440
Joe Perches34456862013-07-03 15:05:34 -0700441 foreach my $file (@include_files) {
442 seed_camelcase_file($file);
443 }
Joe Perches351b2a12013-07-03 15:05:36 -0700444
Joe Perchesc707a812013-07-08 16:00:43 -0700445 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700446 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700447 open(my $camelcase_file, '>', "$camelcase_cache")
448 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700449 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
450 print $camelcase_file ("$_\n");
451 }
452 close($camelcase_file);
453 }
Joe Perches34456862013-07-03 15:05:34 -0700454}
455
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700456$chk_signoff = 0 if ($file);
457
Andy Whitcroft00df3442007-06-08 13:47:06 -0700458my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800459my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700460my @fixed = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800461my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700462for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800463 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700464 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800465 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700466 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800467 } elsif ($filename eq '-') {
468 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700469 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800470 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700471 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700472 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800473 if ($filename eq '-') {
474 $vname = 'Your patch';
475 } else {
476 $vname = $filename;
477 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800478 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700479 chomp;
480 push(@rawlines, $_);
481 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800482 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800483 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700484 $exit = 1;
485 }
486 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800487 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700488 @fixed = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700489}
490
491exit($exit);
492
493sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700494 my ($root) = @_;
495
496 my @tree_check = (
497 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
498 "README", "Documentation", "arch", "include", "drivers",
499 "fs", "init", "ipc", "kernel", "lib", "scripts",
500 );
501
502 foreach my $check (@tree_check) {
503 if (! -e $root . '/' . $check) {
504 return 0;
505 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700506 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700507 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700508}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700509
Joe Perches20112472011-07-25 17:13:23 -0700510sub parse_email {
511 my ($formatted_email) = @_;
512
513 my $name = "";
514 my $address = "";
515 my $comment = "";
516
517 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
518 $name = $1;
519 $address = $2;
520 $comment = $3 if defined $3;
521 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
522 $address = $1;
523 $comment = $2 if defined $2;
524 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
525 $address = $1;
526 $comment = $2 if defined $2;
527 $formatted_email =~ s/$address.*$//;
528 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700529 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700530 $name =~ s/^\"|\"$//g;
531 # If there's a name left after stripping spaces and
532 # leading quotes, and the address doesn't have both
533 # leading and trailing angle brackets, the address
534 # is invalid. ie:
535 # "joe smith joe@smith.com" bad
536 # "joe smith <joe@smith.com" bad
537 if ($name ne "" && $address !~ /^<[^>]+>$/) {
538 $name = "";
539 $address = "";
540 $comment = "";
541 }
542 }
543
Joe Perches3705ce52013-07-03 15:05:31 -0700544 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700545 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700546 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700547 $address =~ s/^\<|\>$//g;
548
549 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
550 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
551 $name = "\"$name\"";
552 }
553
554 return ($name, $address, $comment);
555}
556
557sub format_email {
558 my ($name, $address) = @_;
559
560 my $formatted_email;
561
Joe Perches3705ce52013-07-03 15:05:31 -0700562 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700563 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700564 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700565
566 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
567 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
568 $name = "\"$name\"";
569 }
570
571 if ("$name" eq "") {
572 $formatted_email = "$address";
573 } else {
574 $formatted_email = "$name <$address>";
575 }
576
577 return $formatted_email;
578}
579
Joe Perches000d1cc12011-07-25 17:13:25 -0700580sub which_conf {
581 my ($conf) = @_;
582
583 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
584 if (-e "$path/$conf") {
585 return "$path/$conf";
586 }
587 }
588
589 return "";
590}
591
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700592sub expand_tabs {
593 my ($str) = @_;
594
595 my $res = '';
596 my $n = 0;
597 for my $c (split(//, $str)) {
598 if ($c eq "\t") {
599 $res .= ' ';
600 $n++;
601 for (; ($n % 8) != 0; $n++) {
602 $res .= ' ';
603 }
604 next;
605 }
606 $res .= $c;
607 $n++;
608 }
609
610 return $res;
611}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700612sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700613 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700614 return $res;
615}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700616
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700617sub line_stats {
618 my ($line) = @_;
619
620 # Drop the diff line leader and expand tabs
621 $line =~ s/^.//;
622 $line = expand_tabs($line);
623
624 # Pick the indent from the front of the line.
625 my ($white) = ($line =~ /^(\s*)/);
626
627 return (length($line), length($white));
628}
629
Andy Whitcroft773647a2008-03-28 14:15:58 -0700630my $sanitise_quote = '';
631
632sub sanitise_line_reset {
633 my ($in_comment) = @_;
634
635 if ($in_comment) {
636 $sanitise_quote = '*/';
637 } else {
638 $sanitise_quote = '';
639 }
640}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700641sub sanitise_line {
642 my ($line) = @_;
643
644 my $res = '';
645 my $l = '';
646
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800647 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700648 my $off = 0;
649 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700650
Andy Whitcroft773647a2008-03-28 14:15:58 -0700651 # Always copy over the diff marker.
652 $res = substr($line, 0, 1);
653
654 for ($off = 1; $off < length($line); $off++) {
655 $c = substr($line, $off, 1);
656
657 # Comments we are wacking completly including the begin
658 # and end, all to $;.
659 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
660 $sanitise_quote = '*/';
661
662 substr($res, $off, 2, "$;$;");
663 $off++;
664 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800665 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700666 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700667 $sanitise_quote = '';
668 substr($res, $off, 2, "$;$;");
669 $off++;
670 next;
671 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700672 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
673 $sanitise_quote = '//';
674
675 substr($res, $off, 2, $sanitise_quote);
676 $off++;
677 next;
678 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700679
680 # A \ in a string means ignore the next character.
681 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
682 $c eq "\\") {
683 substr($res, $off, 2, 'XX');
684 $off++;
685 next;
686 }
687 # Regular quotes.
688 if ($c eq "'" || $c eq '"') {
689 if ($sanitise_quote eq '') {
690 $sanitise_quote = $c;
691
692 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700693 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700694 } elsif ($sanitise_quote eq $c) {
695 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700696 }
697 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700698
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800699 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700700 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
701 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700702 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
703 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700704 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
705 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700706 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700707 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700708 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800709 }
710
Daniel Walker113f04a2009-09-21 17:04:35 -0700711 if ($sanitise_quote eq '//') {
712 $sanitise_quote = '';
713 }
714
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800715 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700716 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800717 my $clean = 'X' x length($1);
718 $res =~ s@\<.*\>@<$clean>@;
719
720 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700721 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800722 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700723 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800724 }
725
Andy Whitcroft00df3442007-06-08 13:47:06 -0700726 return $res;
727}
728
Joe Perchesa6962d72013-04-29 16:18:13 -0700729sub get_quoted_string {
730 my ($line, $rawline) = @_;
731
732 return "" if ($line !~ m/(\"[X]+\")/g);
733 return substr($rawline, $-[0], $+[0] - $-[0]);
734}
735
Andy Whitcroft8905a672007-11-28 16:21:06 -0800736sub ctx_statement_block {
737 my ($linenr, $remain, $off) = @_;
738 my $line = $linenr - 1;
739 my $blk = '';
740 my $soff = $off;
741 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700742 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800743
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800744 my $loff = 0;
745
Andy Whitcroft8905a672007-11-28 16:21:06 -0800746 my $type = '';
747 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800748 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800749 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800750 my $c;
751 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800752
753 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800754 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800755 @stack = (['', 0]) if ($#stack == -1);
756
Andy Whitcroft773647a2008-03-28 14:15:58 -0700757 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800758 # If we are about to drop off the end, pull in more
759 # context.
760 if ($off >= $len) {
761 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700762 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800763 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800764 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800765 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800766 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800767 $len = length($blk);
768 $line++;
769 last;
770 }
771 # Bail if there is no further context.
772 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800773 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800774 last;
775 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800776 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
777 $level++;
778 $type = '#';
779 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800780 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800781 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800782 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800783 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800784
Andy Whitcroft773647a2008-03-28 14:15:58 -0700785 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800786
787 # Handle nested #if/#else.
788 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
789 push(@stack, [ $type, $level ]);
790 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
791 ($type, $level) = @{$stack[$#stack - 1]};
792 } elsif ($remainder =~ /^#\s*endif\b/) {
793 ($type, $level) = @{pop(@stack)};
794 }
795
Andy Whitcroft8905a672007-11-28 16:21:06 -0800796 # Statement ends at the ';' or a close '}' at the
797 # outermost level.
798 if ($level == 0 && $c eq ';') {
799 last;
800 }
801
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800802 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700803 if ($level == 0 && $coff_set == 0 &&
804 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
805 $remainder =~ /^(else)(?:\s|{)/ &&
806 $remainder !~ /^else\s+if\b/) {
807 $coff = $off + length($1) - 1;
808 $coff_set = 1;
809 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
810 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800811 }
812
Andy Whitcroft8905a672007-11-28 16:21:06 -0800813 if (($type eq '' || $type eq '(') && $c eq '(') {
814 $level++;
815 $type = '(';
816 }
817 if ($type eq '(' && $c eq ')') {
818 $level--;
819 $type = ($level != 0)? '(' : '';
820
821 if ($level == 0 && $coff < $soff) {
822 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700823 $coff_set = 1;
824 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800825 }
826 }
827 if (($type eq '' || $type eq '{') && $c eq '{') {
828 $level++;
829 $type = '{';
830 }
831 if ($type eq '{' && $c eq '}') {
832 $level--;
833 $type = ($level != 0)? '{' : '';
834
835 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700836 if (substr($blk, $off + 1, 1) eq ';') {
837 $off++;
838 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800839 last;
840 }
841 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800842 # Preprocessor commands end at the newline unless escaped.
843 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
844 $level--;
845 $type = '';
846 $off++;
847 last;
848 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800849 $off++;
850 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700851 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800852 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700853 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800854 $line++;
855 $remain--;
856 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800857
858 my $statement = substr($blk, $soff, $off - $soff + 1);
859 my $condition = substr($blk, $soff, $coff - $soff + 1);
860
861 #warn "STATEMENT<$statement>\n";
862 #warn "CONDITION<$condition>\n";
863
Andy Whitcroft773647a2008-03-28 14:15:58 -0700864 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800865
866 return ($statement, $condition,
867 $line, $remain + 1, $off - $loff + 1, $level);
868}
869
Andy Whitcroftcf655042008-03-04 14:28:20 -0800870sub statement_lines {
871 my ($stmt) = @_;
872
873 # Strip the diff line prefixes and rip blank lines at start and end.
874 $stmt =~ s/(^|\n)./$1/g;
875 $stmt =~ s/^\s*//;
876 $stmt =~ s/\s*$//;
877
878 my @stmt_lines = ($stmt =~ /\n/g);
879
880 return $#stmt_lines + 2;
881}
882
883sub statement_rawlines {
884 my ($stmt) = @_;
885
886 my @stmt_lines = ($stmt =~ /\n/g);
887
888 return $#stmt_lines + 2;
889}
890
891sub statement_block_size {
892 my ($stmt) = @_;
893
894 $stmt =~ s/(^|\n)./$1/g;
895 $stmt =~ s/^\s*{//;
896 $stmt =~ s/}\s*$//;
897 $stmt =~ s/^\s*//;
898 $stmt =~ s/\s*$//;
899
900 my @stmt_lines = ($stmt =~ /\n/g);
901 my @stmt_statements = ($stmt =~ /;/g);
902
903 my $stmt_lines = $#stmt_lines + 2;
904 my $stmt_statements = $#stmt_statements + 1;
905
906 if ($stmt_lines > $stmt_statements) {
907 return $stmt_lines;
908 } else {
909 return $stmt_statements;
910 }
911}
912
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800913sub ctx_statement_full {
914 my ($linenr, $remain, $off) = @_;
915 my ($statement, $condition, $level);
916
917 my (@chunks);
918
Andy Whitcroftcf655042008-03-04 14:28:20 -0800919 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800920 ($statement, $condition, $linenr, $remain, $off, $level) =
921 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700922 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800923 push(@chunks, [ $condition, $statement ]);
924 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
925 return ($level, $linenr, @chunks);
926 }
927
928 # Pull in the following conditional/block pairs and see if they
929 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800930 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800931 ($statement, $condition, $linenr, $remain, $off, $level) =
932 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800933 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700934 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800935 #print "C: push\n";
936 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800937 }
938
939 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800940}
941
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700942sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700943 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700944 my $line;
945 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700946 my $blk = '';
947 my @o;
948 my @c;
949 my @res = ();
950
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700951 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800952 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700953 for ($line = $start; $remain > 0; $line++) {
954 next if ($rawlines[$line] =~ /^-/);
955 $remain--;
956
957 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800958
959 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -0700960 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800961 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -0700962 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800963 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -0700964 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800965 $level = pop(@stack);
966 }
967
Andy Whitcroft01464f32010-10-26 14:23:19 -0700968 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700969 ##print "C<$c>L<$level><$open$close>O<$off>\n";
970 if ($off > 0) {
971 $off--;
972 next;
973 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700974
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700975 if ($c eq $close && $level > 0) {
976 $level--;
977 last if ($level == 0);
978 } elsif ($c eq $open) {
979 $level++;
980 }
981 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700982
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700983 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -0700984 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700985 }
986
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700987 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700988 }
989
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700990 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700991}
992sub ctx_block_outer {
993 my ($linenr, $remain) = @_;
994
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700995 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
996 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700997}
998sub ctx_block {
999 my ($linenr, $remain) = @_;
1000
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001001 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1002 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001003}
1004sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001005 my ($linenr, $remain, $off) = @_;
1006
1007 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1008 return @r;
1009}
1010sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001011 my ($linenr, $remain) = @_;
1012
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001013 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001014}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001015sub ctx_statement_level {
1016 my ($linenr, $remain, $off) = @_;
1017
1018 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1019}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001020
1021sub ctx_locate_comment {
1022 my ($first_line, $end_line) = @_;
1023
1024 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001025 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001026 return $current_comment if (defined $current_comment);
1027
1028 # Look through the context and try and figure out if there is a
1029 # comment.
1030 my $in_comment = 0;
1031 $current_comment = '';
1032 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001033 my $line = $rawlines[$linenr - 1];
1034 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001035 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1036 $in_comment = 1;
1037 }
1038 if ($line =~ m@/\*@) {
1039 $in_comment = 1;
1040 }
1041 if (!$in_comment && $current_comment ne '') {
1042 $current_comment = '';
1043 }
1044 $current_comment .= $line . "\n" if ($in_comment);
1045 if ($line =~ m@\*/@) {
1046 $in_comment = 0;
1047 }
1048 }
1049
1050 chomp($current_comment);
1051 return($current_comment);
1052}
1053sub ctx_has_comment {
1054 my ($first_line, $end_line) = @_;
1055 my $cmt = ctx_locate_comment($first_line, $end_line);
1056
Andy Whitcroft00df3442007-06-08 13:47:06 -07001057 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001058 ##print "CMMT: $cmt\n";
1059
1060 return ($cmt ne '');
1061}
1062
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001063sub raw_line {
1064 my ($linenr, $cnt) = @_;
1065
1066 my $offset = $linenr - 1;
1067 $cnt++;
1068
1069 my $line;
1070 while ($cnt) {
1071 $line = $rawlines[$offset++];
1072 next if (defined($line) && $line =~ /^-/);
1073 $cnt--;
1074 }
1075
1076 return $line;
1077}
1078
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001079sub cat_vet {
1080 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001081 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001082
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001083 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001084 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1085 $res .= $1;
1086 if ($2 ne '') {
1087 $coded = sprintf("^%c", unpack('C', $2) + 64);
1088 $res .= $coded;
1089 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001090 }
1091 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001092
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001093 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001094}
1095
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001096my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001097my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001098my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001099my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001100
1101sub annotate_reset {
1102 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001103 $av_pending = '_';
1104 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001105 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001106}
1107
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001108sub annotate_values {
1109 my ($stream, $type) = @_;
1110
1111 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001112 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001113 my $cur = $stream;
1114
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001115 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001116
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001117 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001118 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001119 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001120 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001121 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001122 print "WS($1)\n" if ($dbg_values > 1);
1123 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001124 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001125 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001126 }
1127
Florian Micklerc023e4732011-01-12 16:59:58 -08001128 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001129 print "CAST($1)\n" if ($dbg_values > 1);
1130 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001131 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001132
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001133 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001134 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001135 $type = 'T';
1136
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001137 } elsif ($cur =~ /^($Modifier)\s*/) {
1138 print "MODIFIER($1)\n" if ($dbg_values > 1);
1139 $type = 'T';
1140
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001141 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001142 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001143 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001144 push(@av_paren_type, $type);
1145 if ($2 ne '') {
1146 $av_pending = 'N';
1147 }
1148 $type = 'E';
1149
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001150 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001151 print "UNDEF($1)\n" if ($dbg_values > 1);
1152 $av_preprocessor = 1;
1153 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001154
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001155 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001156 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001157 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001158
1159 push(@av_paren_type, $type);
1160 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001161 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001162
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001163 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001164 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1165 $av_preprocessor = 1;
1166
1167 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1168
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001169 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001170
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001171 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001172 print "PRE_END($1)\n" if ($dbg_values > 1);
1173
1174 $av_preprocessor = 1;
1175
1176 # Assume all arms of the conditional end as this
1177 # one does, and continue as if the #endif was not here.
1178 pop(@av_paren_type);
1179 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001180 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001181
1182 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001183 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001184
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001185 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1186 print "ATTR($1)\n" if ($dbg_values > 1);
1187 $av_pending = $type;
1188 $type = 'N';
1189
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001190 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001191 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001192 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001193 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001194 }
1195 $type = 'N';
1196
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001197 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001198 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001199 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001200 $type = 'N';
1201
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001202 } elsif ($cur =~/^(case)/o) {
1203 print "CASE($1)\n" if ($dbg_values > 1);
1204 $av_pend_colon = 'C';
1205 $type = 'N';
1206
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001207 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001208 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001209 $type = 'N';
1210
1211 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001212 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001213 push(@av_paren_type, $av_pending);
1214 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001215 $type = 'N';
1216
1217 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001218 my $new_type = pop(@av_paren_type);
1219 if ($new_type ne '_') {
1220 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001221 print "PAREN('$1') -> $type\n"
1222 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001223 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001224 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001225 }
1226
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001227 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001228 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001229 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001230 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001231
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001232 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1233 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001234 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001235 } elsif ($type eq 'E') {
1236 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001237 }
1238 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1239 $type = 'V';
1240
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001241 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001242 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001243 $type = 'V';
1244
1245 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001246 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001247 $type = 'N';
1248
Andy Whitcroftcf655042008-03-04 14:28:20 -08001249 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001250 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001251 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001252 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001253
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001254 } elsif ($cur =~/^(,)/) {
1255 print "COMMA($1)\n" if ($dbg_values > 1);
1256 $type = 'C';
1257
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001258 } elsif ($cur =~ /^(\?)/o) {
1259 print "QUESTION($1)\n" if ($dbg_values > 1);
1260 $type = 'N';
1261
1262 } elsif ($cur =~ /^(:)/o) {
1263 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1264
1265 substr($var, length($res), 1, $av_pend_colon);
1266 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1267 $type = 'E';
1268 } else {
1269 $type = 'N';
1270 }
1271 $av_pend_colon = 'O';
1272
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001273 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001274 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001275 $type = 'N';
1276
Andy Whitcroft0d413862008-10-15 22:02:16 -07001277 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001278 my $variant;
1279
1280 print "OPV($1)\n" if ($dbg_values > 1);
1281 if ($type eq 'V') {
1282 $variant = 'B';
1283 } else {
1284 $variant = 'U';
1285 }
1286
1287 substr($var, length($res), 1, $variant);
1288 $type = 'N';
1289
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001290 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001291 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001292 if ($1 ne '++' && $1 ne '--') {
1293 $type = 'N';
1294 }
1295
1296 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001297 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001298 }
1299 if (defined $1) {
1300 $cur = substr($cur, length($1));
1301 $res .= $type x length($1);
1302 }
1303 }
1304
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001305 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001306}
1307
Andy Whitcroft8905a672007-11-28 16:21:06 -08001308sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001309 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001310 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001311 ^(?:
1312 $Modifier|
1313 $Storage|
1314 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001315 DEFINE_\S+
1316 )$|
1317 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001318 goto|
1319 return|
1320 case|
1321 else|
1322 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001323 do|
1324 \#|
1325 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001326 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001327 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001328 )}x;
1329 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1330 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001331 # Check for modifiers.
1332 $possible =~ s/\s*$Storage\s*//g;
1333 $possible =~ s/\s*$Sparse\s*//g;
1334 if ($possible =~ /^\s*$/) {
1335
1336 } elsif ($possible =~ /\s/) {
1337 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001338 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001339 if ($modifier !~ $notPermitted) {
1340 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1341 push(@modifierList, $modifier);
1342 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001343 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001344
1345 } else {
1346 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1347 push(@typeList, $possible);
1348 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001349 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001350 } else {
1351 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001352 }
1353}
1354
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001355my $prefix = '';
1356
Joe Perches000d1cc12011-07-25 17:13:25 -07001357sub show_type {
1358 return !defined $ignore_type{$_[0]};
1359}
1360
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001361sub report {
Joe Perches000d1cc12011-07-25 17:13:25 -07001362 if (!show_type($_[1]) ||
1363 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001364 return 0;
1365 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001366 my $line;
1367 if ($show_types) {
1368 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1369 } else {
1370 $line = "$prefix$_[0]: $_[2]\n";
1371 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001372 $line = (split('\n', $line))[0] . "\n" if ($terse);
1373
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001374 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001375
1376 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001377}
1378sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001379 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001380}
Joe Perches000d1cc12011-07-25 17:13:25 -07001381
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001382sub ERROR {
Joe Perches000d1cc12011-07-25 17:13:25 -07001383 if (report("ERROR", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001384 our $clean = 0;
1385 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001386 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001387 }
Joe Perches3705ce52013-07-03 15:05:31 -07001388 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001389}
1390sub WARN {
Joe Perches000d1cc12011-07-25 17:13:25 -07001391 if (report("WARNING", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001392 our $clean = 0;
1393 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001394 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001395 }
Joe Perches3705ce52013-07-03 15:05:31 -07001396 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001397}
1398sub CHK {
Joe Perches000d1cc12011-07-25 17:13:25 -07001399 if ($check && report("CHECK", $_[0], $_[1])) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001400 our $clean = 0;
1401 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001402 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001403 }
Joe Perches3705ce52013-07-03 15:05:31 -07001404 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001405}
1406
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001407sub check_absolute_file {
1408 my ($absolute, $herecurr) = @_;
1409 my $file = $absolute;
1410
1411 ##print "absolute<$absolute>\n";
1412
1413 # See if any suffix of this path is a path within the tree.
1414 while ($file =~ s@^[^/]*/@@) {
1415 if (-f "$root/$file") {
1416 ##print "file<$file>\n";
1417 last;
1418 }
1419 }
1420 if (! -f _) {
1421 return 0;
1422 }
1423
1424 # It is, so see if the prefix is acceptable.
1425 my $prefix = $absolute;
1426 substr($prefix, -length($file)) = '';
1427
1428 ##print "prefix<$prefix>\n";
1429 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001430 WARN("USE_RELATIVE_PATH",
1431 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001432 }
1433}
1434
Joe Perches3705ce52013-07-03 15:05:31 -07001435sub trim {
1436 my ($string) = @_;
1437
1438 $string =~ s/(^\s+|\s+$)//g;
1439
1440 return $string;
1441}
1442
1443sub tabify {
1444 my ($leading) = @_;
1445
1446 my $source_indent = 8;
1447 my $max_spaces_before_tab = $source_indent - 1;
1448 my $spaces_to_tab = " " x $source_indent;
1449
1450 #convert leading spaces to tabs
1451 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1452 #Remove spaces before a tab
1453 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1454
1455 return "$leading";
1456}
1457
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001458sub pos_last_openparen {
1459 my ($line) = @_;
1460
1461 my $pos = 0;
1462
1463 my $opens = $line =~ tr/\(/\(/;
1464 my $closes = $line =~ tr/\)/\)/;
1465
1466 my $last_openparen = 0;
1467
1468 if (($opens == 0) || ($closes >= $opens)) {
1469 return -1;
1470 }
1471
1472 my $len = length($line);
1473
1474 for ($pos = 0; $pos < $len; $pos++) {
1475 my $string = substr($line, $pos);
1476 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1477 $pos += length($1) - 1;
1478 } elsif (substr($line, $pos, 1) eq '(') {
1479 $last_openparen = $pos;
1480 } elsif (index($string, '(') == -1) {
1481 last;
1482 }
1483 }
1484
1485 return $last_openparen + 1;
1486}
1487
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001488sub process {
1489 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001490
1491 my $linenr=0;
1492 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001493 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001494 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001495 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001496
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001497 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001498 my $indent;
1499 my $previndent=0;
1500 my $stashindent=0;
1501
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001502 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001503 my $signoff = 0;
1504 my $is_patch = 0;
1505
Joe Perches15662b32011-10-31 17:13:12 -07001506 my $in_header_lines = 1;
1507 my $in_commit_log = 0; #Scanning lines before patch
1508
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001509 my $non_utf8_charset = 0;
1510
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001511 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001512 our $cnt_lines = 0;
1513 our $cnt_error = 0;
1514 our $cnt_warn = 0;
1515 our $cnt_chk = 0;
1516
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001517 # Trace the real file/line as we go.
1518 my $realfile = '';
1519 my $realline = 0;
1520 my $realcnt = 0;
1521 my $here = '';
1522 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001523 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001524 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001525 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001526
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001527 my $prev_values = 'E';
1528
1529 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001530 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001531 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001532 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001533 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001534
Joe Perches323c1262012-12-17 16:02:07 -08001535
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001536 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001537 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001538 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001539 my @setup_docs = ();
1540 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001541
1542 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001543 my $line;
1544 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001545 $linenr++;
1546 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001547
Joe Perches3705ce52013-07-03 15:05:31 -07001548 push(@fixed, $rawline) if ($fix);
1549
Andy Whitcroft773647a2008-03-28 14:15:58 -07001550 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001551 $setup_docs = 0;
1552 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1553 $setup_docs = 1;
1554 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001555 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001556 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001557 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1558 $realline=$1-1;
1559 if (defined $2) {
1560 $realcnt=$3+1;
1561 } else {
1562 $realcnt=1+1;
1563 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001564 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001565
1566 # Guestimate if this is a continuing comment. Run
1567 # the context looking for a comment "edge". If this
1568 # edge is a close comment then we must be in a comment
1569 # at context start.
1570 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001571 my $cnt = $realcnt;
1572 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1573 next if (defined $rawlines[$ln - 1] &&
1574 $rawlines[$ln - 1] =~ /^-/);
1575 $cnt--;
1576 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001577 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001578 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1579 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1580 ($edge) = $1;
1581 last;
1582 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001583 }
1584 if (defined $edge && $edge eq '*/') {
1585 $in_comment = 1;
1586 }
1587
1588 # Guestimate if this is a continuing comment. If this
1589 # is the start of a diff block and this line starts
1590 # ' *' then it is very likely a comment.
1591 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001592 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001593 {
1594 $in_comment = 1;
1595 }
1596
1597 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1598 sanitise_line_reset($in_comment);
1599
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001600 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001601 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001602 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001603 $line = sanitise_line($rawline);
1604 }
1605 push(@lines, $line);
1606
1607 if ($realcnt > 1) {
1608 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1609 } else {
1610 $realcnt = 0;
1611 }
1612
1613 #print "==>$rawline\n";
1614 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001615
1616 if ($setup_docs && $line =~ /^\+/) {
1617 push(@setup_docs, $line);
1618 }
1619 }
1620
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001621 $prefix = '';
1622
Andy Whitcroft773647a2008-03-28 14:15:58 -07001623 $realcnt = 0;
1624 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001625 foreach my $line (@lines) {
1626 $linenr++;
1627
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001628 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001629
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001630#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001631 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001632 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001633 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001634 $realline=$1-1;
1635 if (defined $2) {
1636 $realcnt=$3+1;
1637 } else {
1638 $realcnt=1+1;
1639 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001640 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001641 $prev_values = 'E';
1642
Andy Whitcroft773647a2008-03-28 14:15:58 -07001643 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001644 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001645 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001646 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001647 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001648
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001649# track the line number as we move through the hunk, note that
1650# new versions of GNU diff omit the leading space on completely
1651# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001652 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001653 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001654 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001655
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001656 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001657 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001658
1659 # Track the previous line.
1660 ($prevline, $stashline) = ($stashline, $line);
1661 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001662 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1663
Andy Whitcroft773647a2008-03-28 14:15:58 -07001664 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001665
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001666 } elsif ($realcnt == 1) {
1667 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001668 }
1669
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001670 my $hunk_line = ($realcnt != 0);
1671
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001672#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001673 $prefix = "$filename:$realline: " if ($emacs && $file);
1674 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1675
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001676 $here = "#$linenr: " if (!$file);
1677 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001678
1679 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001680 if ($line =~ /^diff --git.*?(\S+)$/) {
1681 $realfile = $1;
1682 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001683 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001684 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001685 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001686 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001687 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001688
1689 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001690 if (!$file && $tree && $p1_prefix ne '' &&
1691 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001692 WARN("PATCH_PREFIX",
1693 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001694 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001695
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001696 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001697 ERROR("MODIFIED_INCLUDE_ASM",
1698 "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 -07001699 }
1700 next;
1701 }
1702
Randy Dunlap389834b2007-06-08 13:47:03 -07001703 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001704
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001705 my $hereline = "$here\n$rawline\n";
1706 my $herecurr = "$here\n$rawline\n";
1707 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001708
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001709 $cnt_lines++ if ($realcnt != 0);
1710
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001711# Check for incorrect file permissions
1712 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1713 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001714 if ($realfile !~ m@scripts/@ &&
1715 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001716 ERROR("EXECUTE_PERMISSIONS",
1717 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001718 }
1719 }
1720
Joe Perches20112472011-07-25 17:13:23 -07001721# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001722 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001723 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001724 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001725 }
1726
1727# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001728 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001729 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001730 my $space_before = $1;
1731 my $sign_off = $2;
1732 my $space_after = $3;
1733 my $email = $4;
1734 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1735
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001736 if ($sign_off !~ /$signature_tags/) {
1737 WARN("BAD_SIGN_OFF",
1738 "Non-standard signature: $sign_off\n" . $herecurr);
1739 }
Joe Perches20112472011-07-25 17:13:23 -07001740 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07001741 if (WARN("BAD_SIGN_OFF",
1742 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1743 $fix) {
1744 $fixed[$linenr - 1] =
1745 "$ucfirst_sign_off $email";
1746 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001747 }
Joe Perches20112472011-07-25 17:13:23 -07001748 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07001749 if (WARN("BAD_SIGN_OFF",
1750 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1751 $fix) {
1752 $fixed[$linenr - 1] =
1753 "$ucfirst_sign_off $email";
1754 }
1755
Joe Perches20112472011-07-25 17:13:23 -07001756 }
1757 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07001758 if (WARN("BAD_SIGN_OFF",
1759 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1760 $fix) {
1761 $fixed[$linenr - 1] =
1762 "$ucfirst_sign_off $email";
1763 }
Joe Perches20112472011-07-25 17:13:23 -07001764 }
1765
1766 my ($email_name, $email_address, $comment) = parse_email($email);
1767 my $suggested_email = format_email(($email_name, $email_address));
1768 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001769 ERROR("BAD_SIGN_OFF",
1770 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001771 } else {
1772 my $dequoted = $suggested_email;
1773 $dequoted =~ s/^"//;
1774 $dequoted =~ s/" </ </;
1775 # Don't force email to have quotes
1776 # Allow just an angle bracketed address
1777 if ("$dequoted$comment" ne $email &&
1778 "<$email_address>$comment" ne $email &&
1779 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001780 WARN("BAD_SIGN_OFF",
1781 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001782 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001783 }
1784 }
1785
Andy Whitcroft00df3442007-06-08 13:47:06 -07001786# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001787 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001788 ERROR("CORRUPTED_PATCH",
1789 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001790 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001791 }
1792
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001793# Check for absolute kernel paths.
1794 if ($tree) {
1795 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1796 my $file = $1;
1797
1798 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1799 check_absolute_file($1, $herecurr)) {
1800 #
1801 } else {
1802 check_absolute_file($file, $herecurr);
1803 }
1804 }
1805 }
1806
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001807# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1808 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001809 $rawline !~ m/^$UTF8*$/) {
1810 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1811
1812 my $blank = copy_spacing($rawline);
1813 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1814 my $hereptr = "$hereline$ptr\n";
1815
Joe Perches34d99212011-07-25 17:13:26 -07001816 CHK("INVALID_UTF8",
1817 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001818 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001819
Joe Perches15662b32011-10-31 17:13:12 -07001820# Check if it's the start of a commit log
1821# (not a header line and we haven't seen the patch filename)
1822 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001823 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001824 $in_header_lines = 0;
1825 $in_commit_log = 1;
1826 }
1827
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001828# Check if there is UTF-8 in a commit log when a mail header has explicitly
1829# declined it, i.e defined some charset where it is missing.
1830 if ($in_header_lines &&
1831 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1832 $1 !~ /utf-8/i) {
1833 $non_utf8_charset = 1;
1834 }
1835
1836 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001837 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001838 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001839 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1840 }
1841
Andy Whitcroft306708542008-10-15 22:02:28 -07001842# ignore non-hunk lines and lines being removed
1843 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001844
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001845#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001846 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001847 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07001848 if (ERROR("DOS_LINE_ENDINGS",
1849 "DOS line endings\n" . $herevet) &&
1850 $fix) {
1851 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
1852 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001853 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1854 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07001855 if (ERROR("TRAILING_WHITESPACE",
1856 "trailing whitespace\n" . $herevet) &&
1857 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07001858 $fixed[$linenr - 1] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001859 }
1860
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001861 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001862 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001863
Andi Kleen33549572010-05-24 14:33:29 -07001864# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001865# Only applies when adding the entry originally, after that we do not have
1866# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07001867 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08001868 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07001869 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001870 my $cnt = $realcnt;
1871 my $ln = $linenr + 1;
1872 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001873 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001874 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001875 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001876 $f = $lines[$ln - 1];
1877 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1878 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001879
1880 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08001881
1882 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1883 $is_start = 1;
1884 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1885 $length = -1;
1886 }
1887
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001888 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07001889 $f =~ s/#.*//;
1890 $f =~ s/^\s+//;
1891 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001892 if ($f =~ /^\s*config\s/) {
1893 $is_end = 1;
1894 last;
1895 }
Andi Kleen33549572010-05-24 14:33:29 -07001896 $length++;
1897 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001898 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08001899 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1900 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07001901 }
1902
Kees Cook1ba8dfd2012-12-17 16:01:48 -08001903# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
1904 if ($realfile =~ /Kconfig/ &&
1905 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
1906 WARN("CONFIG_EXPERIMENTAL",
1907 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1908 }
1909
Arnaud Lacombec68e5872011-08-15 01:07:14 -04001910 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1911 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1912 my $flag = $1;
1913 my $replacement = {
1914 'EXTRA_AFLAGS' => 'asflags-y',
1915 'EXTRA_CFLAGS' => 'ccflags-y',
1916 'EXTRA_CPPFLAGS' => 'cppflags-y',
1917 'EXTRA_LDFLAGS' => 'ldflags-y',
1918 };
1919
1920 WARN("DEPRECATED_VARIABLE",
1921 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1922 }
1923
Andy Whitcroft5368df22008-10-15 22:02:27 -07001924# check we are in a valid source file if not then ignore this hunk
1925 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1926
Joe Perches6cd7f382012-12-17 16:01:54 -08001927#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001928 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07001929 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07001930 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07001931 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08001932 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001933 {
Joe Perches000d1cc12011-07-25 17:13:25 -07001934 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08001935 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001936 }
1937
Josh Triplettca56dc02012-03-23 15:02:21 -07001938# Check for user-visible strings broken across lines, which breaks the ability
1939# to grep for the string. Limited to strings used as parameters (those
1940# following an open parenthesis), which almost completely eliminates false
1941# positives, as well as warning only once per parameter rather than once per
1942# line of the string. Make an exception when the previous string ends in a
1943# newline (multiple lines in one string constant) or \n\t (common in inline
1944# assembly to indent the instruction on the following line).
1945 if ($line =~ /^\+\s*"/ &&
1946 $prevline =~ /"\s*$/ &&
1947 $prevline =~ /\(/ &&
1948 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1949 WARN("SPLIT_STRING",
1950 "quoted string split across lines\n" . $hereprev);
1951 }
1952
Joe Perches5e79d962010-03-05 13:43:55 -08001953# check for spaces before a quoted newline
1954 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07001955 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1956 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
1957 $fix) {
1958 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
1959 }
1960
Joe Perches5e79d962010-03-05 13:43:55 -08001961 }
1962
Andy Whitcroft8905a672007-11-28 16:21:06 -08001963# check for adding lines without a newline.
1964 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001965 WARN("MISSING_EOF_NEWLINE",
1966 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001967 }
1968
Mike Frysinger42e41c52009-09-21 17:04:40 -07001969# Blackfin: use hi/lo macros
1970 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1971 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1972 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001973 ERROR("LO_MACRO",
1974 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001975 }
1976 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1977 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07001978 ERROR("HI_MACRO",
1979 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07001980 }
1981 }
1982
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07001983# check we are in a valid source file C or perl if not then ignore this hunk
1984 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001985
1986# at the beginning of a line any tabs must come first and anything
1987# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001988 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1989 $rawline =~ /^\+\s* \s*/) {
1990 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001991 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07001992 if (ERROR("CODE_INDENT",
1993 "code indent should use tabs where possible\n" . $herevet) &&
1994 $fix) {
1995 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
1996 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001997 }
1998
Alberto Panizzo08e44362010-03-05 13:43:54 -08001999# check for space before tabs.
2000 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2001 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002002 if (WARN("SPACE_BEFORE_TAB",
2003 "please, no space before tabs\n" . $herevet) &&
2004 $fix) {
2005 $fixed[$linenr - 1] =~
2006 s/(^\+.*) +\t/$1\t/;
2007 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002008 }
2009
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002010# check for && or || at the start of a line
2011 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2012 CHK("LOGICAL_CONTINUATIONS",
2013 "Logical continuations should be on the previous line\n" . $hereprev);
2014 }
2015
2016# check multi-line statement indentation matches previous line
2017 if ($^V && $^V ge 5.10.0 &&
2018 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
2019 $prevline =~ /^\+(\t*)(.*)$/;
2020 my $oldindent = $1;
2021 my $rest = $2;
2022
2023 my $pos = pos_last_openparen($rest);
2024 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002025 $line =~ /^(\+| )([ \t]*)/;
2026 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002027
2028 my $goodtabindent = $oldindent .
2029 "\t" x ($pos / 8) .
2030 " " x ($pos % 8);
2031 my $goodspaceindent = $oldindent . " " x $pos;
2032
2033 if ($newindent ne $goodtabindent &&
2034 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002035
2036 if (CHK("PARENTHESIS_ALIGNMENT",
2037 "Alignment should match open parenthesis\n" . $hereprev) &&
2038 $fix && $line =~ /^\+/) {
2039 $fixed[$linenr - 1] =~
2040 s/^\+[ \t]*/\+$goodtabindent/;
2041 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002042 }
2043 }
2044 }
2045
Joe Perches23f780c2013-07-03 15:05:31 -07002046 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002047 if (CHK("SPACING",
2048 "No space is necessary after a cast\n" . $hereprev) &&
2049 $fix) {
2050 $fixed[$linenr - 1] =~
2051 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2052 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002053 }
2054
Joe Perches05880602012-10-04 17:13:35 -07002055 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002056 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2057 $rawline =~ /^\+[ \t]*\*/) {
Joe Perches05880602012-10-04 17:13:35 -07002058 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2059 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2060 }
2061
2062 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002063 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2064 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
2065 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2066 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2067 "networking block comments start with * on subsequent lines\n" . $hereprev);
2068 }
2069
2070 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002071 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2072 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2073 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2074 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002075 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2076 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2077 }
2078
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002079# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002080# Exceptions:
2081# 1) within comments
2082# 2) indented preprocessor commands
2083# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002084 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002085 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002086 if (WARN("LEADING_SPACE",
2087 "please, no spaces at the start of a line\n" . $herevet) &&
2088 $fix) {
2089 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2090 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002091 }
2092
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002093# check we are in a valid C source file if not then ignore this hunk
2094 next if ($realfile !~ /\.(h|c)$/);
2095
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002096# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2097 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2098 WARN("CONFIG_EXPERIMENTAL",
2099 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2100 }
2101
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002102# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002103 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002104 WARN("CVS_KEYWORD",
2105 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002106 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002107
Mike Frysinger42e41c52009-09-21 17:04:40 -07002108# Blackfin: don't use __builtin_bfin_[cs]sync
2109 if ($line =~ /__builtin_bfin_csync/) {
2110 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002111 ERROR("CSYNC",
2112 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002113 }
2114 if ($line =~ /__builtin_bfin_ssync/) {
2115 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002116 ERROR("SSYNC",
2117 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002118 }
2119
Joe Perches56e77d72013-02-21 16:44:14 -08002120# check for old HOTPLUG __dev<foo> section markings
2121 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2122 WARN("HOTPLUG_SECTION",
2123 "Using $1 is unnecessary\n" . $herecurr);
2124 }
2125
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002126# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002127 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2128 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002129#print "LINE<$line>\n";
2130 if ($linenr >= $suppress_statement &&
2131 $realcnt && $line =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002132 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002133 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002134 $stat =~ s/\n./\n /g;
2135 $cond =~ s/\n./\n /g;
2136
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002137#print "linenr<$linenr> <$stat>\n";
2138 # If this statement has no statement boundaries within
2139 # it there is no point in retrying a statement scan
2140 # until we hit end of it.
2141 my $frag = $stat; $frag =~ s/;+\s*$//;
2142 if ($frag !~ /(?:{|;)/) {
2143#print "skip<$line_nr_next>\n";
2144 $suppress_statement = $line_nr_next;
2145 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002146
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002147 # Find the real next line.
2148 $realline_next = $line_nr_next;
2149 if (defined $realline_next &&
2150 (!defined $lines[$realline_next - 1] ||
2151 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2152 $realline_next++;
2153 }
2154
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002155 my $s = $stat;
2156 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002157
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002158 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002159 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002160
2161 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002162 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002163
Andy Whitcroft463f2862009-09-21 17:04:34 -07002164 } elsif ($s =~ /^.\s*else\b/s) {
2165
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002166 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002167 } 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 -07002168 my $type = $1;
2169 $type =~ s/\s+/ /g;
2170 possible($type, "A:" . $s);
2171
Andy Whitcroft8905a672007-11-28 16:21:06 -08002172 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002173 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002174 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002175 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002176
2177 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002178 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002179 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002180 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002181
2182 # Check for any sort of function declaration.
2183 # int foo(something bar, other baz);
2184 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002185 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 -08002186 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002187
Andy Whitcroftcf655042008-03-04 14:28:20 -08002188 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002189 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002190 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002191
Andy Whitcroft8905a672007-11-28 16:21:06 -08002192 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002193 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002194
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002195 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002196 }
2197 }
2198 }
2199
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002200 }
2201
Andy Whitcroft653d4872007-06-23 17:16:34 -07002202#
2203# Checks which may be anchored in the context.
2204#
2205
2206# Check for switch () and associated case and default
2207# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002208 if ($line=~/\bswitch\s*\(.*\)/) {
2209 my $err = '';
2210 my $sep = '';
2211 my @ctx = ctx_block_outer($linenr, $realcnt);
2212 shift(@ctx);
2213 for my $ctx (@ctx) {
2214 my ($clen, $cindent) = line_stats($ctx);
2215 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2216 $indent != $cindent) {
2217 $err .= "$sep$ctx\n";
2218 $sep = '';
2219 } else {
2220 $sep = "[...]\n";
2221 }
2222 }
2223 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002224 ERROR("SWITCH_CASE_INDENT_LEVEL",
2225 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002226 }
2227 }
2228
2229# if/while/etc brace do not go on next line, unless defining a do while loop,
2230# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002231 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002232 my $pre_ctx = "$1$2";
2233
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002234 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002235
2236 if ($line =~ /^\+\t{6,}/) {
2237 WARN("DEEP_INDENTATION",
2238 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2239 }
2240
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002241 my $ctx_cnt = $realcnt - $#ctx - 1;
2242 my $ctx = join("\n", @ctx);
2243
Andy Whitcroft548596d2008-07-23 21:29:01 -07002244 my $ctx_ln = $linenr;
2245 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002246
Andy Whitcroft548596d2008-07-23 21:29:01 -07002247 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2248 defined $lines[$ctx_ln - 1] &&
2249 $lines[$ctx_ln - 1] =~ /^-/)) {
2250 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2251 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002252 $ctx_ln++;
2253 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002254
Andy Whitcroft53210162008-07-23 21:29:03 -07002255 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2256 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002257
2258 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002259 ERROR("OPEN_BRACE",
2260 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002261 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002262 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002263 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2264 $ctx =~ /\)\s*\;\s*$/ &&
2265 defined $lines[$ctx_ln - 1])
2266 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002267 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2268 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002269 WARN("TRAILING_SEMICOLON",
2270 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002271 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002272 }
2273 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002274 }
2275
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002276# Check relative indent for conditionals and blocks.
2277 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002278 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2279 ctx_statement_block($linenr, $realcnt, 0)
2280 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002281 my ($s, $c) = ($stat, $cond);
2282
2283 substr($s, 0, length($c), '');
2284
2285 # Make sure we remove the line prefixes as we have
2286 # none on the first line, and are going to readd them
2287 # where necessary.
2288 $s =~ s/\n./\n/gs;
2289
2290 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002291 my @newlines = ($c =~ /\n/gs);
2292 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002293
2294 # We want to check the first line inside the block
2295 # starting at the end of the conditional, so remove:
2296 # 1) any blank line termination
2297 # 2) any opening brace { on end of the line
2298 # 3) any do (...) {
2299 my $continuation = 0;
2300 my $check = 0;
2301 $s =~ s/^.*\bdo\b//;
2302 $s =~ s/^\s*{//;
2303 if ($s =~ s/^\s*\\//) {
2304 $continuation = 1;
2305 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002306 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002307 $check = 1;
2308 $cond_lines++;
2309 }
2310
2311 # Also ignore a loop construct at the end of a
2312 # preprocessor statement.
2313 if (($prevline =~ /^.\s*#\s*define\s/ ||
2314 $prevline =~ /\\\s*$/) && $continuation == 0) {
2315 $check = 0;
2316 }
2317
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002318 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002319 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002320 while ($cond_ptr != $cond_lines) {
2321 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002322
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002323 # If we see an #else/#elif then the code
2324 # is not linear.
2325 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2326 $check = 0;
2327 }
2328
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002329 # Ignore:
2330 # 1) blank lines, they should be at 0,
2331 # 2) preprocessor lines, and
2332 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002333 if ($continuation ||
2334 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002335 $s =~ /^\s*#\s*?/ ||
2336 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002337 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002338 if ($s =~ s/^.*?\n//) {
2339 $cond_lines++;
2340 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002341 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002342 }
2343
2344 my (undef, $sindent) = line_stats("+" . $s);
2345 my $stat_real = raw_line($linenr, $cond_lines);
2346
2347 # Check if either of these lines are modified, else
2348 # this is not this patch's fault.
2349 if (!defined($stat_real) ||
2350 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2351 $check = 0;
2352 }
2353 if (defined($stat_real) && $cond_lines > 1) {
2354 $stat_real = "[...]\n$stat_real";
2355 }
2356
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002357 #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 -07002358
2359 if ($check && (($sindent % 8) != 0 ||
2360 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002361 WARN("SUSPECT_CODE_INDENT",
2362 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002363 }
2364 }
2365
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002366 # Track the 'values' across context and added lines.
2367 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002368 my ($curr_values, $curr_vars) =
2369 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002370 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002371 if ($dbg_values) {
2372 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002373 print "$linenr > .$outline\n";
2374 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002375 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002376 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002377 $prev_values = substr($curr_values, -1);
2378
Andy Whitcroft00df3442007-06-08 13:47:06 -07002379#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002380 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002381
Andy Whitcroft653d4872007-06-23 17:16:34 -07002382# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002383 if ($dbg_type) {
2384 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002385 ERROR("TEST_TYPE",
2386 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002387 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002388 ERROR("TEST_NOT_TYPE",
2389 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002390 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002391 next;
2392 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002393# TEST: allow direct testing of the attribute matcher.
2394 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002395 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002396 ERROR("TEST_ATTR",
2397 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002398 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002399 ERROR("TEST_NOT_ATTR",
2400 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002401 }
2402 next;
2403 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002404
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002405# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002406 if ($line =~ /^.\s*{/ &&
2407 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002408 ERROR("OPEN_BRACE",
2409 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002410 }
2411
Andy Whitcroft653d4872007-06-23 17:16:34 -07002412#
2413# Checks which are anchored on the added line.
2414#
2415
2416# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002417 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002418 my $path = $1;
2419 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002420 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002421 "malformed #include filename\n" . $herecurr);
2422 }
2423 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2424 ERROR("UAPI_INCLUDE",
2425 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002426 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002427 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002428
2429# no C99 // comments
2430 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002431 if (ERROR("C99_COMMENTS",
2432 "do not use C99 // comments\n" . $herecurr) &&
2433 $fix) {
2434 my $line = $fixed[$linenr - 1];
2435 if ($line =~ /\/\/(.*)$/) {
2436 my $comment = trim($1);
2437 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2438 }
2439 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002440 }
2441 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002442 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002443 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002444
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002445# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2446# the whole statement.
2447#print "APW <$lines[$realline_next - 1]>\n";
2448 if (defined $realline_next &&
2449 exists $lines[$realline_next - 1] &&
2450 !defined $suppress_export{$realline_next} &&
2451 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2452 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002453 # Handle definitions which produce identifiers with
2454 # a prefix:
2455 # XXX(foo);
2456 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002457 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002458 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002459 $name =~ /^${Ident}_$2/) {
2460#print "FOO C name<$name>\n";
2461 $suppress_export{$realline_next} = 1;
2462
2463 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002464 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002465 ^.DEFINE_$Ident\(\Q$name\E\)|
2466 ^.DECLARE_$Ident\(\Q$name\E\)|
2467 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002468 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2469 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002470 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002471#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2472 $suppress_export{$realline_next} = 2;
2473 } else {
2474 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002475 }
2476 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002477 if (!defined $suppress_export{$linenr} &&
2478 $prevline =~ /^.\s*$/ &&
2479 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2480 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2481#print "FOO B <$lines[$linenr - 1]>\n";
2482 $suppress_export{$linenr} = 2;
2483 }
2484 if (defined $suppress_export{$linenr} &&
2485 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002486 WARN("EXPORT_SYMBOL",
2487 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002488 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002489
Joe Eloff5150bda2010-08-09 17:21:00 -07002490# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002491 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2492 if (ERROR("GLOBAL_INITIALISERS",
2493 "do not initialise globals to 0 or NULL\n" .
2494 $herecurr) &&
2495 $fix) {
2496 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2497 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002498 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002499# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002500 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2501 if (ERROR("INITIALISED_STATIC",
2502 "do not initialise statics to 0 or NULL\n" .
2503 $herecurr) &&
2504 $fix) {
2505 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2506 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002507 }
2508
Joe Perchescb710ec2010-10-26 14:23:20 -07002509# check for static const char * arrays.
2510 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002511 WARN("STATIC_CONST_CHAR_ARRAY",
2512 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002513 $herecurr);
2514 }
2515
2516# check for static char foo[] = "bar" declarations.
2517 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002518 WARN("STATIC_CONST_CHAR_ARRAY",
2519 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002520 $herecurr);
2521 }
2522
Joe Perches93ed0e22010-10-26 14:23:21 -07002523# check for declarations of struct pci_device_id
2524 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002525 WARN("DEFINE_PCI_DEVICE_TABLE",
2526 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
Joe Perches93ed0e22010-10-26 14:23:21 -07002527 }
2528
Andy Whitcroft653d4872007-06-23 17:16:34 -07002529# check for new typedefs, only function parameters and sparse annotations
2530# make sense.
2531 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002532 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002533 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002534 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002535 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002536 WARN("NEW_TYPEDEFS",
2537 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002538 }
2539
2540# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002541 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002542 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2543 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002544 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002545
Andy Whitcroft65863862009-01-06 14:41:21 -08002546 # Should start with a space.
2547 $to =~ s/^(\S)/ $1/;
2548 # Should not end with a space.
2549 $to =~ s/\s+$//;
2550 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002551 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002552 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002553
Joe Perches3705ce52013-07-03 15:05:31 -07002554## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08002555 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07002556 if (ERROR("POINTER_LOCATION",
2557 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2558 $fix) {
2559 my $sub_from = $ident;
2560 my $sub_to = $ident;
2561 $sub_to =~ s/\Q$from\E/$to/;
2562 $fixed[$linenr - 1] =~
2563 s@\Q$sub_from\E@$sub_to@;
2564 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002565 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002566 }
2567 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2568 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002569 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002570
Andy Whitcroft65863862009-01-06 14:41:21 -08002571 # Should start with a space.
2572 $to =~ s/^(\S)/ $1/;
2573 # Should not end with a space.
2574 $to =~ s/\s+$//;
2575 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002576 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002577 }
2578 # Modifiers should have spaces.
2579 $to =~ s/(\b$Modifier$)/$1 /;
2580
Joe Perches3705ce52013-07-03 15:05:31 -07002581## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08002582 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002583 if (ERROR("POINTER_LOCATION",
2584 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2585 $fix) {
2586
2587 my $sub_from = $match;
2588 my $sub_to = $match;
2589 $sub_to =~ s/\Q$from\E/$to/;
2590 $fixed[$linenr - 1] =~
2591 s@\Q$sub_from\E@$sub_to@;
2592 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002593 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002594 }
2595
2596# # no BUG() or BUG_ON()
2597# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2598# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2599# print "$herecurr";
2600# $clean = 0;
2601# }
2602
Andy Whitcroft8905a672007-11-28 16:21:06 -08002603 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002604 WARN("LINUX_VERSION_CODE",
2605 "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 -08002606 }
2607
Joe Perches17441222011-06-15 15:08:17 -07002608# check for uses of printk_ratelimit
2609 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002610 WARN("PRINTK_RATELIMITED",
2611"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002612 }
2613
Andy Whitcroft00df3442007-06-08 13:47:06 -07002614# printk should use KERN_* levels. Note that follow on printk's on the
2615# same line do not need a level, so we use the current block context
2616# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002617# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002618# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002619 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002620 my $ok = 0;
2621 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2622 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002623 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07002624 # with "\n" ignore it, else it is to blame
2625 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2626 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2627 $ok = 1;
2628 }
2629 last;
2630 }
2631 }
2632 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002633 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2634 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002635 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002636 }
2637
Joe Perches243f3802012-05-31 16:26:09 -07002638 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2639 my $orig = $1;
2640 my $level = lc($orig);
2641 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002642 my $level2 = $level;
2643 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002644 WARN("PREFER_PR_LEVEL",
Joe Perches8f26b832012-10-04 17:13:32 -07002645 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Joe Perches243f3802012-05-31 16:26:09 -07002646 }
2647
2648 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002649 if (WARN("PREFER_PR_LEVEL",
2650 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2651 $fix) {
2652 $fixed[$linenr - 1] =~
2653 s/\bpr_warning\b/pr_warn/;
2654 }
Joe Perches243f3802012-05-31 16:26:09 -07002655 }
2656
Joe Perchesdc139312013-02-21 16:44:13 -08002657 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2658 my $orig = $1;
2659 my $level = lc($orig);
2660 $level = "warn" if ($level eq "warning");
2661 $level = "dbg" if ($level eq "debug");
2662 WARN("PREFER_DEV_LEVEL",
2663 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2664 }
2665
Andy Whitcroft653d4872007-06-23 17:16:34 -07002666# function brace can't be on same line, except for #defines of do while,
2667# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002668 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2669 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002670 ERROR("OPEN_BRACE",
2671 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002672 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002673
Andy Whitcroft8905a672007-11-28 16:21:06 -08002674# open braces for enum, union and struct go on the same line.
2675 if ($line =~ /^.\s*{/ &&
2676 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002677 ERROR("OPEN_BRACE",
2678 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002679 }
2680
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002681# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07002682 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2683 if (WARN("SPACING",
2684 "missing space after $1 definition\n" . $herecurr) &&
2685 $fix) {
2686 $fixed[$linenr - 1] =~
2687 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2688 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002689 }
2690
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002691# check for spacing round square brackets; allowed:
2692# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002693# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2694# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002695 while ($line =~ /(.*?\s)\[/g) {
2696 my ($where, $prefix) = ($-[1], $1);
2697 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002698 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002699 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002700 if (ERROR("BRACKET_SPACE",
2701 "space prohibited before open square bracket '['\n" . $herecurr) &&
2702 $fix) {
2703 $fixed[$linenr - 1] =~
2704 s/^(\+.*?)\s+\[/$1\[/;
2705 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002706 }
2707 }
2708
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002709# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002710 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002711 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002712 my $ctx_before = substr($line, 0, $-[1]);
2713 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002714
2715 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002716 if ($name =~ /^(?:
2717 if|for|while|switch|return|case|
2718 volatile|__volatile__|
2719 __attribute__|format|__extension__|
2720 asm|__asm__)$/x)
2721 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002722 # cpp #define statements have non-optional spaces, ie
2723 # if there is a space between the name and the open
2724 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002725 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002726
2727 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002728 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002729
2730 # If this whole things ends with a type its most
2731 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002732 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002733
2734 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07002735 if (WARN("SPACING",
2736 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
2737 $fix) {
2738 $fixed[$linenr - 1] =~
2739 s/\b$name\s+\(/$name\(/;
2740 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002741 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002742 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07002743
Andy Whitcroft653d4872007-06-23 17:16:34 -07002744# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002745 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002746 my $fixed_line = "";
2747 my $line_fixed = 0;
2748
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002749 my $ops = qr{
2750 <<=|>>=|<=|>=|==|!=|
2751 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2752 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002753 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2754 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002755 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002756 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07002757
2758## print("element count: <" . $#elements . ">\n");
2759## foreach my $el (@elements) {
2760## print("el: <$el>\n");
2761## }
2762
2763 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07002764 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002765
Joe Perches3705ce52013-07-03 15:05:31 -07002766 foreach my $el (@elements) {
2767 push(@fix_elements, substr($rawline, $off, length($el)));
2768 $off += length($el);
2769 }
2770
2771 $off = 0;
2772
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002773 my $blank = copy_spacing($opline);
2774
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002775 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07002776
2777 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
2778
2779## print("n: <$n> good: <$good>\n");
2780
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002781 $off += length($elements[$n]);
2782
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002783 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002784 my $ca = substr($opline, 0, $off);
2785 my $cc = '';
2786 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2787 $cc = substr($opline, $off + length($elements[$n + 1]));
2788 }
2789 my $cb = "$ca$;$cc";
2790
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002791 my $a = '';
2792 $a = 'V' if ($elements[$n] ne '');
2793 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002794 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002795 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2796 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07002797 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002798
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002799 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002800
2801 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002802 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002803 $c = 'V' if ($elements[$n + 2] ne '');
2804 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002805 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002806 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2807 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08002808 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002809 } else {
2810 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002811 }
2812
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002813 my $ctx = "${a}x${c}";
2814
2815 my $at = "(ctx:$ctx)";
2816
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002817 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002818 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002819
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002820 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002821 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002822
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002823 # Get the full operator variant.
2824 my $opv = $op . substr($curr_vars, $off, 1);
2825
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002826 # Ignore operators passed as parameters.
2827 if ($op_type ne 'V' &&
2828 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2829
Andy Whitcroftcf655042008-03-04 14:28:20 -08002830# # Ignore comments
2831# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002832
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002833 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002834 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002835 if ($ctx !~ /.x[WEBC]/ &&
2836 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002837 if (ERROR("SPACING",
2838 "space required after that '$op' $at\n" . $hereptr)) {
2839 $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
2840 $line_fixed = 1;
2841 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002842 }
2843
2844 # // is a comment
2845 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002846
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002847 # No spaces for:
2848 # ->
2849 # : when part of a bitfield
2850 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002851 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002852 if (ERROR("SPACING",
2853 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
2854 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2855 $line_fixed = 1;
2856 if (defined $fix_elements[$n + 2]) {
2857 $fix_elements[$n + 2] =~ s/^\s+//;
2858 }
2859 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002860 }
2861
2862 # , must have a space on the right.
2863 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002864 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002865 if (ERROR("SPACING",
2866 "space required after that '$op' $at\n" . $hereptr)) {
2867 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]) . " ";
2868 $line_fixed = 1;
2869 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002870 }
2871
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002872 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002873 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002874 #warn "'*' is part of type\n";
2875
2876 # unary operators should have a space before and
2877 # none after. May be left adjacent to another
2878 # unary operator, or a cast
2879 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002880 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002881 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002882 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002883 if (ERROR("SPACING",
2884 "space required before that '$op' $at\n" . $hereptr)) {
2885 $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]);
2886 $line_fixed = 1;
2887 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002888 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002889 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002890 # A unary '*' may be const
2891
2892 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002893 if (ERROR("SPACING",
2894 "space prohibited after that '$op' $at\n" . $hereptr)) {
2895 $fixed_line =~ s/\s+$//;
2896 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2897 $line_fixed = 1;
2898 if (defined $fix_elements[$n + 2]) {
2899 $fix_elements[$n + 2] =~ s/^\s+//;
2900 }
2901 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002902 }
2903
2904 # unary ++ and unary -- are allowed no space on one side.
2905 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002906 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002907 if (ERROR("SPACING",
2908 "space required one side of that '$op' $at\n" . $hereptr)) {
2909 $fixed_line =~ s/\s+$//;
2910 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]) . " ";
2911 $line_fixed = 1;
2912 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002913 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002914 if ($ctx =~ /Wx[BE]/ ||
2915 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002916 if (ERROR("SPACING",
2917 "space prohibited before that '$op' $at\n" . $hereptr)) {
2918 $fixed_line =~ s/\s+$//;
2919 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2920 $line_fixed = 1;
2921 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002922 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002923 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002924 if (ERROR("SPACING",
2925 "space prohibited after that '$op' $at\n" . $hereptr)) {
2926 $fixed_line =~ s/\s+$//;
2927 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2928 $line_fixed = 1;
2929 if (defined $fix_elements[$n + 2]) {
2930 $fix_elements[$n + 2] =~ s/^\s+//;
2931 }
2932 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002933 }
2934
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002935 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002936 } elsif ($op eq '<<' or $op eq '>>' or
2937 $op eq '&' or $op eq '^' or $op eq '|' or
2938 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002939 $op eq '*' or $op eq '/' or
2940 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002941 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002942 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002943 if (ERROR("SPACING",
2944 "need consistent spacing around '$op' $at\n" . $hereptr)) {
2945 $fixed_line =~ s/\s+$//;
2946 $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
2947 $line_fixed = 1;
2948 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002949 }
2950
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002951 # A colon needs no spaces before when it is
2952 # terminating a case value or a label.
2953 } elsif ($opv eq ':C' || $opv eq ':L') {
2954 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07002955 if (ERROR("SPACING",
2956 "space prohibited before that '$op' $at\n" . $hereptr)) {
2957 $good = trim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
2958 $line_fixed = 1;
2959 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002960 }
2961
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002962 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08002963 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002964 my $ok = 0;
2965
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002966 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002967 if (($op eq '<' &&
2968 $cc =~ /^\S+\@\S+>/) ||
2969 ($op eq '>' &&
2970 $ca =~ /<\S+\@\S+$/))
2971 {
2972 $ok = 1;
2973 }
2974
2975 # Ignore ?:
2976 if (($opv eq ':O' && $ca =~ /\?$/) ||
2977 ($op eq '?' && $cc =~ /^:/)) {
2978 $ok = 1;
2979 }
2980
2981 if ($ok == 0) {
Joe Perches3705ce52013-07-03 15:05:31 -07002982 if (ERROR("SPACING",
2983 "spaces required around that '$op' $at\n" . $hereptr)) {
2984 $good = trim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
2985 $good = $fix_elements[$n] . " " . trim($fix_elements[$n + 1]) . " ";
2986 $line_fixed = 1;
2987 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002988 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002989 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002990 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07002991
2992## print("n: <$n> GOOD: <$good>\n");
2993
2994 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002995 }
Joe Perches3705ce52013-07-03 15:05:31 -07002996
2997 if (($#elements % 2) == 0) {
2998 $fixed_line = $fixed_line . $fix_elements[$#elements];
2999 }
3000
3001 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3002 $fixed[$linenr - 1] = $fixed_line;
3003 }
3004
3005
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003006 }
3007
Joe Perches786b6322013-07-03 15:05:32 -07003008# check for whitespace before a non-naked semicolon
3009 if ($line =~ /^\+.*\S\s+;/) {
3010 if (WARN("SPACING",
3011 "space prohibited before semicolon\n" . $herecurr) &&
3012 $fix) {
3013 1 while $fixed[$linenr - 1] =~
3014 s/^(\+.*\S)\s+;/$1;/;
3015 }
3016 }
3017
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003018# check for multiple assignments
3019 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003020 CHK("MULTIPLE_ASSIGNMENTS",
3021 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003022 }
3023
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003024## # check for multiple declarations, allowing for a function declaration
3025## # continuation.
3026## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3027## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3028##
3029## # Remove any bracketed sections to ensure we do not
3030## # falsly report the parameters of functions.
3031## my $ln = $line;
3032## while ($ln =~ s/\([^\(\)]*\)//g) {
3033## }
3034## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003035## WARN("MULTIPLE_DECLARATION",
3036## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003037## }
3038## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003039
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003040#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003041 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3042 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003043 if (ERROR("SPACING",
3044 "space required before the open brace '{'\n" . $herecurr) &&
3045 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003046 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003047 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003048 }
3049
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003050## # check for blank lines before declarations
3051## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3052## $prevrawline =~ /^.\s*$/) {
3053## WARN("SPACING",
3054## "No blank lines before declarations\n" . $hereprev);
3055## }
3056##
3057
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003058# closing brace should have a space following it when it has anything
3059# on the line
3060 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003061 if (ERROR("SPACING",
3062 "space required after that close brace '}'\n" . $herecurr) &&
3063 $fix) {
3064 $fixed[$linenr - 1] =~
3065 s/}((?!(?:,|;|\)))\S)/} $1/;
3066 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003067 }
3068
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003069# check spacing on square brackets
3070 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003071 if (ERROR("SPACING",
3072 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3073 $fix) {
3074 $fixed[$linenr - 1] =~
3075 s/\[\s+/\[/;
3076 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003077 }
3078 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003079 if (ERROR("SPACING",
3080 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3081 $fix) {
3082 $fixed[$linenr - 1] =~
3083 s/\s+\]/\]/;
3084 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003085 }
3086
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003087# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003088 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3089 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003090 if (ERROR("SPACING",
3091 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3092 $fix) {
3093 $fixed[$linenr - 1] =~
3094 s/\(\s+/\(/;
3095 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003096 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003097 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003098 $line !~ /for\s*\(.*;\s+\)/ &&
3099 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003100 if (ERROR("SPACING",
3101 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3102 $fix) {
3103 $fixed[$linenr - 1] =~
3104 s/\s+\)/\)/;
3105 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003106 }
3107
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003108#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003109 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003110 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003111 if (WARN("INDENTED_LABEL",
3112 "labels should not be indented\n" . $herecurr) &&
3113 $fix) {
3114 $fixed[$linenr - 1] =~
3115 s/^(.)\s+/$1/;
3116 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003117 }
3118
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003119# Return is not a function.
3120 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
3121 my $spacing = $1;
3122 my $value = $2;
3123
Andy Whitcroft86f9d052009-01-06 14:41:24 -08003124 # Flatten any parentheses
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07003125 $value =~ s/\(/ \(/g;
3126 $value =~ s/\)/\) /g;
Andy Whitcrofte01886a2012-01-10 15:10:08 -08003127 while ($value =~ s/\[[^\[\]]*\]/1/ ||
Andy Whitcroft63f17f82009-01-15 13:51:06 -08003128 $value !~ /(?:$Ident|-?$Constant)\s*
3129 $Compare\s*
3130 (?:$Ident|-?$Constant)/x &&
3131 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003132 }
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07003133#print "value<$value>\n";
3134 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003135 ERROR("RETURN_PARENTHESES",
3136 "return is not a function, parentheses are not required\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003137
3138 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003139 ERROR("SPACING",
3140 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003141 }
3142 }
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003143# Return of what appears to be an errno should normally be -'ve
3144 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3145 my $name = $1;
3146 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003147 WARN("USE_NEGATIVE_ERRNO",
3148 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003149 }
3150 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003151
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003152# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003153 if ($line =~ /\b(if|while|for|switch)\(/) {
3154 if (ERROR("SPACING",
3155 "space required before the open parenthesis '('\n" . $herecurr) &&
3156 $fix) {
3157 $fixed[$linenr - 1] =~
3158 s/\b(if|while|for|switch)\(/$1 \(/;
3159 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003160 }
3161
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003162# Check for illegal assignment in if conditional -- and check for trailing
3163# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003164 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003165 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3166 ctx_statement_block($linenr, $realcnt, 0)
3167 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003168 my ($stat_next) = ctx_statement_block($line_nr_next,
3169 $remain_next, $off_next);
3170 $stat_next =~ s/\n./\n /g;
3171 ##print "stat<$stat> stat_next<$stat_next>\n";
3172
3173 if ($stat_next =~ /^\s*while\b/) {
3174 # If the statement carries leading newlines,
3175 # then count those as offsets.
3176 my ($whitespace) =
3177 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3178 my $offset =
3179 statement_rawlines($whitespace) - 1;
3180
3181 $suppress_whiletrailers{$line_nr_next +
3182 $offset} = 1;
3183 }
3184 }
3185 if (!defined $suppress_whiletrailers{$linenr} &&
3186 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003187 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003188
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003189 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003190 ERROR("ASSIGN_IN_IF",
3191 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003192 }
3193
3194 # Find out what is on the end of the line after the
3195 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003196 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003197 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003198 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003199 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3200 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003201 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003202 # Find out how long the conditional actually is.
3203 my @newlines = ($c =~ /\n/gs);
3204 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003205 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003206
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003207 $stat_real = raw_line($linenr, $cond_lines)
3208 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003209 if (defined($stat_real) && $cond_lines > 1) {
3210 $stat_real = "[...]\n$stat_real";
3211 }
3212
Joe Perches000d1cc12011-07-25 17:13:25 -07003213 ERROR("TRAILING_STATEMENTS",
3214 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003215 }
3216 }
3217
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003218# Check for bitwise tests written as boolean
3219 if ($line =~ /
3220 (?:
3221 (?:\[|\(|\&\&|\|\|)
3222 \s*0[xX][0-9]+\s*
3223 (?:\&\&|\|\|)
3224 |
3225 (?:\&\&|\|\|)
3226 \s*0[xX][0-9]+\s*
3227 (?:\&\&|\|\||\)|\])
3228 )/x)
3229 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003230 WARN("HEXADECIMAL_BOOLEAN_TEST",
3231 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003232 }
3233
Andy Whitcroft8905a672007-11-28 16:21:06 -08003234# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003235 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3236 my $s = $1;
3237 $s =~ s/$;//g; # Remove any comments
3238 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003239 ERROR("TRAILING_STATEMENTS",
3240 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003241 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003242 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003243# if should not continue a brace
3244 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003245 ERROR("TRAILING_STATEMENTS",
3246 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003247 $herecurr);
3248 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003249# case and default should not have general statements after them
3250 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3251 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003252 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003253 \s*return\s+
3254 )/xg)
3255 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003256 ERROR("TRAILING_STATEMENTS",
3257 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003258 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003259
3260 # Check for }<nl>else {, these must be at the same
3261 # indent level to be relevant to each other.
3262 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3263 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003264 ERROR("ELSE_AFTER_BRACE",
3265 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003266 }
3267
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003268 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3269 $previndent == $indent) {
3270 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3271
3272 # Find out what is on the end of the line after the
3273 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003274 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003275 $s =~ s/\n.*//g;
3276
3277 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003278 ERROR("WHILE_AFTER_BRACE",
3279 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003280 }
3281 }
3282
Joe Perches95e2c602013-07-03 15:05:20 -07003283#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003284 while ($line =~ m{($Constant|$Lval)}g) {
3285 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003286
3287#gcc binary extension
3288 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003289 if (WARN("GCC_BINARY_CONSTANT",
3290 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3291 $fix) {
3292 my $hexval = sprintf("0x%x", oct($var));
3293 $fixed[$linenr - 1] =~
3294 s/\b$var\b/$hexval/;
3295 }
Joe Perches95e2c602013-07-03 15:05:20 -07003296 }
3297
3298#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003299 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003300 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003301#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003302 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003303#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003304 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
3305 seed_camelcase_includes() if ($check);
3306 if (!defined $camelcase{$var}) {
3307 $camelcase{$var} = 1;
3308 CHK("CAMELCASE",
3309 "Avoid CamelCase: <$var>\n" . $herecurr);
3310 }
Joe Perches323c1262012-12-17 16:02:07 -08003311 }
3312 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003313
3314#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003315 if ($line =~ /\#\s*define.*\\\s+$/) {
3316 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3317 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3318 $fix) {
3319 $fixed[$linenr - 1] =~ s/\s+$//;
3320 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003321 }
3322
Andy Whitcroft653d4872007-06-23 17:16:34 -07003323#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003324 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003325 my $file = "$1.h";
3326 my $checkfile = "include/linux/$file";
3327 if (-f "$root/$checkfile" &&
3328 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003329 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003330 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003331 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003332 CHK("ARCH_INCLUDE_LINUX",
3333 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003334 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003335 WARN("INCLUDE_LINUX",
3336 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003337 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003338 }
3339 }
3340
Andy Whitcroft653d4872007-06-23 17:16:34 -07003341# multi-statement macros should be enclosed in a do while loop, grab the
3342# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003343# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07003344 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3345 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003346 my $ln = $linenr;
3347 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003348 my ($off, $dstat, $dcond, $rest);
3349 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003350 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003351 ctx_statement_block($linenr, $realcnt, 0);
3352 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003353 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003354 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003355
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003356 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003357 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003358 $dstat =~ s/\\\n.//g;
3359 $dstat =~ s/^\s*//s;
3360 $dstat =~ s/\s*$//s;
3361
3362 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003363 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3364 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003365 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003366 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003367 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003368
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003369 # Flatten any obvious string concatentation.
3370 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3371 $dstat =~ s/$Ident\s*("X*")/$1/)
3372 {
3373 }
3374
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003375 my $exceptions = qr{
3376 $Declare|
3377 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003378 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003379 DECLARE_PER_CPU|
3380 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003381 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003382 union|
3383 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003384 \.$Ident\s*=\s*|
3385 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003386 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003387 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003388 if ($dstat ne '' &&
3389 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3390 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07003391 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003392 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003393 $dstat !~ /$exceptions/ &&
3394 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003395 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003396 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003397 $dstat !~ /^for\s*$Constant$/ && # for (...)
3398 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3399 $dstat !~ /^do\s*{/ && # do {...
3400 $dstat !~ /^\({/) # ({...
3401 {
3402 $ctx =~ s/\n*$//;
3403 my $herectx = $here . "\n";
3404 my $cnt = statement_rawlines($ctx);
3405
3406 for (my $n = 0; $n < $cnt; $n++) {
3407 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003408 }
3409
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003410 if ($dstat =~ /;/) {
3411 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3412 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3413 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003414 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003415 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003416 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003417 }
Joe Perches5023d342012-12-17 16:01:47 -08003418
Joe Perches481eb482012-12-17 16:01:56 -08003419# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003420
3421 } else {
3422 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003423 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3424 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003425 $line =~ /^\+.*\\$/) {
3426 WARN("LINE_CONTINUATIONS",
3427 "Avoid unnecessary line continuations\n" . $herecurr);
3428 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003429 }
3430
Joe Perchesb13edf72012-07-30 14:41:24 -07003431# do {} while (0) macro tests:
3432# single-statement macros do not need to be enclosed in do while (0) loop,
3433# macro should not end with a semicolon
3434 if ($^V && $^V ge 5.10.0 &&
3435 $realfile !~ m@/vmlinux.lds.h$@ &&
3436 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3437 my $ln = $linenr;
3438 my $cnt = $realcnt;
3439 my ($off, $dstat, $dcond, $rest);
3440 my $ctx = '';
3441 ($dstat, $dcond, $ln, $cnt, $off) =
3442 ctx_statement_block($linenr, $realcnt, 0);
3443 $ctx = $dstat;
3444
3445 $dstat =~ s/\\\n.//g;
3446
3447 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3448 my $stmts = $2;
3449 my $semis = $3;
3450
3451 $ctx =~ s/\n*$//;
3452 my $cnt = statement_rawlines($ctx);
3453 my $herectx = $here . "\n";
3454
3455 for (my $n = 0; $n < $cnt; $n++) {
3456 $herectx .= raw_line($linenr, $n) . "\n";
3457 }
3458
Joe Perchesac8e97f2012-08-21 16:15:53 -07003459 if (($stmts =~ tr/;/;/) == 1 &&
3460 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003461 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3462 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3463 }
3464 if (defined $semis && $semis ne "") {
3465 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3466 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3467 }
3468 }
3469 }
3470
Mike Frysinger080ba922009-01-06 14:41:25 -08003471# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3472# all assignments may have only one of the following with an assignment:
3473# .
3474# ALIGN(...)
3475# VMLINUX_SYMBOL(...)
3476 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003477 WARN("MISSING_VMLINUX_SYMBOL",
3478 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003479 }
3480
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003481# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003482 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3483 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003484 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003485 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003486 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3487 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003488 my @allowed = ();
3489 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003490 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003491 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003492 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003493 for my $chunk (@chunks) {
3494 my ($cond, $block) = @{$chunk};
3495
Andy Whitcroft773647a2008-03-28 14:15:58 -07003496 # If the condition carries leading newlines, then count those as offsets.
3497 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3498 my $offset = statement_rawlines($whitespace) - 1;
3499
Joe Perchesaad4f612012-03-23 15:02:19 -07003500 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003501 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3502
3503 # We have looked at and allowed this specific line.
3504 $suppress_ifbraces{$ln + $offset} = 1;
3505
3506 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003507 $ln += statement_rawlines($block) - 1;
3508
Andy Whitcroft773647a2008-03-28 14:15:58 -07003509 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003510
3511 $seen++ if ($block =~ /^\s*{/);
3512
Joe Perchesaad4f612012-03-23 15:02:19 -07003513 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003514 if (statement_lines($cond) > 1) {
3515 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003516 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003517 }
3518 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003519 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003520 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003521 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003522 if (statement_block_size($block) > 1) {
3523 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003524 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003525 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003526 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003527 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003528 if ($seen) {
3529 my $sum_allowed = 0;
3530 foreach (@allowed) {
3531 $sum_allowed += $_;
3532 }
3533 if ($sum_allowed == 0) {
3534 WARN("BRACES",
3535 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3536 } elsif ($sum_allowed != $allow &&
3537 $seen != $allow) {
3538 CHK("BRACES",
3539 "braces {} should be used on all arms of this statement\n" . $herectx);
3540 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003541 }
3542 }
3543 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003544 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003545 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003546 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003547
Andy Whitcroftcf655042008-03-04 14:28:20 -08003548 # Check the pre-context.
3549 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3550 #print "APW: ALLOWED: pre<$1>\n";
3551 $allowed = 1;
3552 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003553
3554 my ($level, $endln, @chunks) =
3555 ctx_statement_full($linenr, $realcnt, $-[0]);
3556
Andy Whitcroftcf655042008-03-04 14:28:20 -08003557 # Check the condition.
3558 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003559 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003560 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003561 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003562 }
3563 if (statement_lines($cond) > 1) {
3564 #print "APW: ALLOWED: cond<$cond>\n";
3565 $allowed = 1;
3566 }
3567 if ($block =~/\b(?:if|for|while)\b/) {
3568 #print "APW: ALLOWED: block<$block>\n";
3569 $allowed = 1;
3570 }
3571 if (statement_block_size($block) > 1) {
3572 #print "APW: ALLOWED: lines block<$block>\n";
3573 $allowed = 1;
3574 }
3575 # Check the post-context.
3576 if (defined $chunks[1]) {
3577 my ($cond, $block) = @{$chunks[1]};
3578 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003579 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003580 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003581 if ($block =~ /^\s*\{/) {
3582 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3583 $allowed = 1;
3584 }
3585 }
3586 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003587 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003588 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003589
Andy Whitcroftf0556632008-10-15 22:02:23 -07003590 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003591 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003592 }
3593
Joe Perches000d1cc12011-07-25 17:13:25 -07003594 WARN("BRACES",
3595 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003596 }
3597 }
3598
Joe Perches0979ae62012-12-17 16:01:59 -08003599# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07003600 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003601 CHK("BRACES",
3602 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3603 }
Joe Perches77b9a532013-07-03 15:05:29 -07003604 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003605 CHK("BRACES",
3606 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3607 }
3608
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003609# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003610 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3611 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003612 WARN("VOLATILE",
3613 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003614 }
3615
Andy Whitcroft00df3442007-06-08 13:47:06 -07003616# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003617 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003618 CHK("REDUNDANT_CODE",
3619 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003620 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003621 }
3622
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003623# check for needless "if (<foo>) fn(<foo>)" uses
3624 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3625 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3626 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3627 WARN('NEEDLESS_IF',
3628 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003629 }
3630 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003631
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003632# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08003633 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003634 # ignore udelay's < 10, however
Bruce Allan37581c22013-02-21 16:44:19 -08003635 if (! ($1 < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003636 CHK("USLEEP_RANGE",
3637 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003638 }
3639 }
3640
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003641# warn about unexpectedly long msleep's
3642 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3643 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003644 WARN("MSLEEP",
3645 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003646 }
3647 }
3648
Joe Perches36ec1932013-07-03 15:05:25 -07003649# check for comparisons of jiffies
3650 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
3651 WARN("JIFFIES_COMPARISON",
3652 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
3653 }
3654
Joe Perches9d7a34a2013-07-03 15:05:26 -07003655# check for comparisons of get_jiffies_64()
3656 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
3657 WARN("JIFFIES_COMPARISON",
3658 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
3659 }
3660
Andy Whitcroft00df3442007-06-08 13:47:06 -07003661# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003662# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003663# print "#ifdef in C files should be avoided\n";
3664# print "$herecurr";
3665# $clean = 0;
3666# }
3667
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003668# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003669 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003670 if (ERROR("SPACING",
3671 "exactly one space required after that #$1\n" . $herecurr) &&
3672 $fix) {
3673 $fixed[$linenr - 1] =~
3674 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
3675 }
3676
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003677 }
3678
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003679# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003680 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3681 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003682 my $which = $1;
3683 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003684 CHK("UNCOMMENTED_DEFINITION",
3685 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003686 }
3687 }
3688# check for memory barriers without a comment.
3689 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3690 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003691 CHK("MEMORY_BARRIER",
3692 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003693 }
3694 }
3695# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003696 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003697 CHK("ARCH_DEFINES",
3698 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003699 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003700
Tobias Klauserd4977c72010-05-24 14:33:30 -07003701# Check that the storage class is at the beginning of a declaration
3702 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003703 WARN("STORAGE_CLASS",
3704 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07003705 }
3706
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003707# check the location of the inline attribute, that it is between
3708# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003709 if ($line =~ /\b$Type\s+$Inline\b/ ||
3710 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003711 ERROR("INLINE_LOCATION",
3712 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003713 }
3714
Andy Whitcroft8905a672007-11-28 16:21:06 -08003715# Check for __inline__ and __inline, prefer inline
3716 if ($line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003717 if (WARN("INLINE",
3718 "plain inline is preferred over $1\n" . $herecurr) &&
3719 $fix) {
3720 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
3721
3722 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003723 }
3724
Joe Perches3d130fd2011-01-12 17:00:00 -08003725# Check for __attribute__ packed, prefer __packed
3726 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003727 WARN("PREFER_PACKED",
3728 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08003729 }
3730
Joe Perches39b7e282011-07-25 17:13:24 -07003731# Check for __attribute__ aligned, prefer __aligned
3732 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003733 WARN("PREFER_ALIGNED",
3734 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07003735 }
3736
Joe Perches5f14d3b2012-01-10 15:09:52 -08003737# Check for __attribute__ format(printf, prefer __printf
3738 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003739 if (WARN("PREFER_PRINTF",
3740 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
3741 $fix) {
3742 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
3743
3744 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08003745 }
3746
Joe Perches6061d942012-03-23 15:02:16 -07003747# Check for __attribute__ format(scanf, prefer __scanf
3748 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003749 if (WARN("PREFER_SCANF",
3750 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
3751 $fix) {
3752 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
3753 }
Joe Perches6061d942012-03-23 15:02:16 -07003754 }
3755
Joe Perches8f53a9b2010-03-05 13:43:48 -08003756# check for sizeof(&)
3757 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003758 WARN("SIZEOF_ADDRESS",
3759 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08003760 }
3761
Joe Perches66c80b62012-07-30 14:41:22 -07003762# check for sizeof without parenthesis
3763 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003764 if (WARN("SIZEOF_PARENTHESIS",
3765 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
3766 $fix) {
3767 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
3768 }
Joe Perches66c80b62012-07-30 14:41:22 -07003769 }
3770
Joe Perches428e2fd2011-05-24 17:13:39 -07003771# check for line continuations in quoted strings with odd counts of "
3772 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003773 WARN("LINE_CONTINUATIONS",
3774 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07003775 }
3776
Joe Perches88982fe2012-12-17 16:02:00 -08003777# check for struct spinlock declarations
3778 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
3779 WARN("USE_SPINLOCK_T",
3780 "struct spinlock should be spinlock_t\n" . $herecurr);
3781 }
3782
Joe Perchesa6962d72013-04-29 16:18:13 -07003783# check for seq_printf uses that could be seq_puts
3784 if ($line =~ /\bseq_printf\s*\(/) {
3785 my $fmt = get_quoted_string($line, $rawline);
3786 if ($fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003787 if (WARN("PREFER_SEQ_PUTS",
3788 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
3789 $fix) {
3790 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
3791 }
Joe Perchesa6962d72013-04-29 16:18:13 -07003792 }
3793 }
3794
Andy Whitcroft554e1652012-01-10 15:09:57 -08003795# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003796 if ($^V && $^V ge 5.10.0 &&
3797 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003798 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08003799
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003800 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003801 my $ms_val = $7;
3802 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003803
Andy Whitcroft554e1652012-01-10 15:09:57 -08003804 if ($ms_size =~ /^(0x|)0$/i) {
3805 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003806 "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 -08003807 } elsif ($ms_size =~ /^(0x|)1$/i) {
3808 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003809 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3810 }
3811 }
3812
3813# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003814 if ($^V && $^V ge 5.10.0 &&
3815 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003816 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003817 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003818 my $call = $1;
3819 my $cast1 = deparenthesize($2);
3820 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003821 my $cast2 = deparenthesize($7);
3822 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003823 my $cast;
3824
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003825 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003826 $cast = "$cast1 or $cast2";
3827 } elsif ($cast1 ne "") {
3828 $cast = $cast1;
3829 } else {
3830 $cast = $cast2;
3831 }
3832 WARN("MINMAX",
3833 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08003834 }
3835 }
3836
Joe Perches4a273192012-07-30 14:41:20 -07003837# check usleep_range arguments
3838 if ($^V && $^V ge 5.10.0 &&
3839 defined $stat &&
3840 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3841 my $min = $1;
3842 my $max = $7;
3843 if ($min eq $max) {
3844 WARN("USLEEP_RANGE",
3845 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3846 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3847 $min > $max) {
3848 WARN("USLEEP_RANGE",
3849 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3850 }
3851 }
3852
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003853# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003854 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003855 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003856 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003857 my $function_name = $1;
3858 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003859
3860 my $s = $stat;
3861 if (defined $cond) {
3862 substr($s, 0, length($cond), '');
3863 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003864 if ($s =~ /^\s*;/ &&
3865 $function_name ne 'uninitialized_var')
3866 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003867 WARN("AVOID_EXTERNS",
3868 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003869 }
3870
3871 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003872 WARN("FUNCTION_ARGUMENTS",
3873 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003874 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07003875
3876 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3877 $stat =~ /^.\s*extern\s+/)
3878 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003879 WARN("AVOID_EXTERNS",
3880 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003881 }
3882
3883# checks for new __setup's
3884 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3885 my $name = $1;
3886
3887 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003888 CHK("UNDOCUMENTED_SETUP",
3889 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003890 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003891 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003892
3893# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08003894 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003895 WARN("UNNECESSARY_CASTS",
3896 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003897 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003898
Joe Perchesa640d252013-07-03 15:05:21 -07003899# alloc style
3900# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
3901 if ($^V && $^V ge 5.10.0 &&
3902 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
3903 CHK("ALLOC_SIZEOF_STRUCT",
3904 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
3905 }
3906
Joe Perches972fdea2013-04-29 16:18:12 -07003907# check for krealloc arg reuse
3908 if ($^V && $^V ge 5.10.0 &&
3909 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
3910 WARN("KREALLOC_ARG_REUSE",
3911 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
3912 }
3913
Joe Perches5ce59ae2013-02-21 16:44:18 -08003914# check for alloc argument mismatch
3915 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
3916 WARN("ALLOC_ARRAY_ARGS",
3917 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
3918 }
3919
Joe Perchescaf2a542011-01-12 16:59:56 -08003920# check for multiple semicolons
3921 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003922 if (WARN("ONE_SEMICOLON",
3923 "Statements terminations use 1 semicolon\n" . $herecurr) &&
3924 $fix) {
3925 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
3926 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08003927 }
3928
3929# check for switch/default statements without a break;
3930 if ($^V && $^V ge 5.10.0 &&
3931 defined $stat &&
3932 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
3933 my $ctx = '';
3934 my $herectx = $here . "\n";
3935 my $cnt = statement_rawlines($stat);
3936 for (my $n = 0; $n < $cnt; $n++) {
3937 $herectx .= raw_line($linenr, $n) . "\n";
3938 }
3939 WARN("DEFAULT_NO_BREAK",
3940 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08003941 }
3942
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003943# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07003944 if ($line =~ /\b__FUNCTION__\b/) {
3945 if (WARN("USE_FUNC",
3946 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
3947 $fix) {
3948 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
3949 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003950 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003951
Joe Perches2c924882012-03-23 15:02:20 -07003952# check for use of yield()
3953 if ($line =~ /\byield\s*\(\s*\)/) {
3954 WARN("YIELD",
3955 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
3956 }
3957
Joe Perches179f8f42013-07-03 15:05:30 -07003958# check for comparisons against true and false
3959 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
3960 my $lead = $1;
3961 my $arg = $2;
3962 my $test = $3;
3963 my $otype = $4;
3964 my $trail = $5;
3965 my $op = "!";
3966
3967 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
3968
3969 my $type = lc($otype);
3970 if ($type =~ /^(?:true|false)$/) {
3971 if (("$test" eq "==" && "$type" eq "true") ||
3972 ("$test" eq "!=" && "$type" eq "false")) {
3973 $op = "";
3974 }
3975
3976 CHK("BOOL_COMPARISON",
3977 "Using comparison to $otype is error prone\n" . $herecurr);
3978
3979## maybe suggesting a correct construct would better
3980## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
3981
3982 }
3983 }
3984
Thomas Gleixner4882720b2010-09-07 14:34:01 +00003985# check for semaphores initialized locked
3986 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003987 WARN("CONSIDER_COMPLETION",
3988 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003989 }
Joe Perches6712d852012-03-23 15:02:20 -07003990
Joe Perches67d0a072011-10-31 17:13:10 -07003991# recommend kstrto* over simple_strto* and strict_strto*
3992 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003993 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07003994 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07003995 }
Joe Perches6712d852012-03-23 15:02:20 -07003996
Michael Ellermanf3db6632008-07-23 21:28:57 -07003997# check for __initcall(), use device_initcall() explicitly please
3998 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003999 WARN("USE_DEVICE_INITCALL",
4000 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07004001 }
Joe Perches6712d852012-03-23 15:02:20 -07004002
Emese Revfy79404842010-03-05 13:43:53 -08004003# check for various ops structs, ensure they are const.
4004 my $struct_ops = qr{acpi_dock_ops|
4005 address_space_operations|
4006 backlight_ops|
4007 block_device_operations|
4008 dentry_operations|
4009 dev_pm_ops|
4010 dma_map_ops|
4011 extent_io_ops|
4012 file_lock_operations|
4013 file_operations|
4014 hv_ops|
4015 ide_dma_ops|
4016 intel_dvo_dev_ops|
4017 item_operations|
4018 iwl_ops|
4019 kgdb_arch|
4020 kgdb_io|
4021 kset_uevent_ops|
4022 lock_manager_operations|
4023 microcode_ops|
4024 mtrr_ops|
4025 neigh_ops|
4026 nlmsvc_binding|
4027 pci_raw_ops|
4028 pipe_buf_operations|
4029 platform_hibernation_ops|
4030 platform_suspend_ops|
4031 proto_ops|
4032 rpc_pipe_ops|
4033 seq_operations|
4034 snd_ac97_build_ops|
4035 soc_pcmcia_socket_ops|
4036 stacktrace_ops|
4037 sysfs_ops|
4038 tty_operations|
4039 usb_mon_operations|
4040 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004041 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004042 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004043 WARN("CONST_STRUCT",
4044 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004045 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004046 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004047
4048# use of NR_CPUS is usually wrong
4049# ignore definitions of NR_CPUS and usage to define arrays as likely right
4050 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004051 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4052 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004053 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4054 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4055 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004056 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004057 WARN("NR_CPUS",
4058 "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 -07004059 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004060
4061# check for %L{u,d,i} in strings
4062 my $string;
4063 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4064 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004065 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004066 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004067 WARN("PRINTF_L",
4068 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004069 last;
4070 }
4071 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004072
4073# whine mightly about in_atomic
4074 if ($line =~ /\bin_atomic\s*\(/) {
4075 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004076 ERROR("IN_ATOMIC",
4077 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004078 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004079 WARN("IN_ATOMIC",
4080 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004081 }
4082 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004083
4084# check for lockdep_set_novalidate_class
4085 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4086 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4087 if ($realfile !~ m@^kernel/lockdep@ &&
4088 $realfile !~ m@^include/linux/lockdep@ &&
4089 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004090 ERROR("LOCKDEP",
4091 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004092 }
4093 }
Dave Jones88f88312011-01-12 16:59:59 -08004094
4095 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4096 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004097 WARN("EXPORTED_WORLD_WRITABLE",
4098 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004099 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004100 }
4101
4102 # If we have no input at all, then there is nothing to report on
4103 # so just keep quiet.
4104 if ($#rawlines == -1) {
4105 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004106 }
4107
Andy Whitcroft8905a672007-11-28 16:21:06 -08004108 # In mailback mode only produce a report in the negative, for
4109 # things that appear to be patches.
4110 if ($mailback && ($clean == 1 || !$is_patch)) {
4111 exit(0);
4112 }
4113
4114 # This is not a patch, and we are are in 'no-patch' mode so
4115 # just keep quiet.
4116 if (!$chk_patch && !$is_patch) {
4117 exit(0);
4118 }
4119
4120 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004121 ERROR("NOT_UNIFIED_DIFF",
4122 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004123 }
4124 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004125 ERROR("MISSING_SIGN_OFF",
4126 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004127 }
4128
Andy Whitcroft8905a672007-11-28 16:21:06 -08004129 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004130 if ($summary && !($clean == 1 && $quiet == 1)) {
4131 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004132 print "total: $cnt_error errors, $cnt_warn warnings, " .
4133 (($check)? "$cnt_chk checks, " : "") .
4134 "$cnt_lines lines checked\n";
4135 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004136 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004137
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004138 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004139
4140 if ($^V lt 5.10.0) {
4141 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4142 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4143 }
4144
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004145 # If there were whitespace errors which cleanpatch can fix
4146 # then suggest that.
4147 if ($rpt_cleaners) {
4148 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4149 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07004150 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004151 }
4152 }
4153
Artem Bityutskiy11232682012-03-23 15:02:17 -07004154 if ($quiet == 0 && keys %ignore_type) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004155 print "NOTE: Ignored message types:";
4156 foreach my $ignore (sort keys %ignore_type) {
4157 print " $ignore";
4158 }
Artem Bityutskiy11232682012-03-23 15:02:17 -07004159 print "\n\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07004160 }
4161
Joe Perches3705ce52013-07-03 15:05:31 -07004162 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
4163 my $newfile = $filename . ".EXPERIMENTAL-checkpatch-fixes";
4164 my $linecount = 0;
4165 my $f;
4166
4167 open($f, '>', $newfile)
4168 or die "$P: Can't open $newfile for write\n";
4169 foreach my $fixed_line (@fixed) {
4170 $linecount++;
4171 if ($file) {
4172 if ($linecount > 3) {
4173 $fixed_line =~ s/^\+//;
4174 print $f $fixed_line. "\n";
4175 }
4176 } else {
4177 print $f $fixed_line . "\n";
4178 }
4179 }
4180 close($f);
4181
4182 if (!$quiet) {
4183 print << "EOM";
4184Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4185
4186Do _NOT_ trust the results written to this file.
4187Do _NOT_ submit these changes without inspecting them for correctness.
4188
4189This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4190No warranties, expressed or implied...
4191
4192EOM
4193 }
4194 }
4195
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004196 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004197 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004198 }
4199 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004200 print << "EOM";
4201$vname has style problems, please review.
4202
4203If any of these errors are false positives, please report
4204them to the maintainer, see CHECKPATCH in MAINTAINERS.
4205EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004206 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004207
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004208 return $clean;
4209}