blob: 47016c304c847efffb96da5358224a9b5a93cc5e [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 Perches34456862013-07-03 15:05:34 -070034my %camelcase = ();
Joe Perches91bfe482013-09-11 14:23:59 -070035my %use_type = ();
36my @use = ();
37my %ignore_type = ();
Joe Perches000d1cc12011-07-25 17:13:25 -070038my @ignore = ();
Hannes Eder77f5b102009-09-21 17:04:37 -070039my $help = 0;
Joe Perches000d1cc12011-07-25 17:13:25 -070040my $configuration_file = ".checkpatch.conf";
Joe Perches6cd7f382012-12-17 16:01:54 -080041my $max_line_length = 80;
Dave Hansend62a2012013-09-11 14:23:56 -070042my $ignore_perl_version = 0;
43my $minimum_perl_version = 5.10.0;
Hannes Eder77f5b102009-09-21 17:04:37 -070044
45sub help {
46 my ($exitcode) = @_;
47
48 print << "EOM";
49Usage: $P [OPTION]... [FILE]...
50Version: $V
51
52Options:
53 -q, --quiet quiet
54 --no-tree run without a kernel tree
55 --no-signoff do not check for 'Signed-off-by' line
56 --patch treat FILE as patchfile (default)
57 --emacs emacs compile window format
58 --terse one line per report
59 -f, --file treat FILE as regular source file
60 --subjective, --strict enable more subjective tests
Joe Perches91bfe482013-09-11 14:23:59 -070061 --types TYPE(,TYPE2...) show only these comma separated message types
Joe Perches000d1cc12011-07-25 17:13:25 -070062 --ignore TYPE(,TYPE2...) ignore various comma separated message types
Joe Perches6cd7f382012-12-17 16:01:54 -080063 --max-line-length=n set the maximum line length, if exceeded, warn
Joe Perches000d1cc12011-07-25 17:13:25 -070064 --show-types show the message "types" in the output
Hannes Eder77f5b102009-09-21 17:04:37 -070065 --root=PATH PATH to the kernel tree root
66 --no-summary suppress the per-file summary
67 --mailback only produce a report in case of warnings/errors
68 --summary-file include the filename in summary
69 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
70 'values', 'possible', 'type', and 'attr' (default
71 is all off)
72 --test-only=WORD report only warnings/errors containing WORD
73 literally
Joe Perches3705ce52013-07-03 15:05:31 -070074 --fix EXPERIMENTAL - may create horrible results
75 If correctable single-line errors exist, create
76 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
77 with potential errors corrected to the preferred
78 checkpatch style
Dave Hansend62a2012013-09-11 14:23:56 -070079 --ignore-perl-version override checking of perl version. expect
80 runtime errors.
Hannes Eder77f5b102009-09-21 17:04:37 -070081 -h, --help, --version display this help and exit
82
83When FILE is - read standard input.
84EOM
85
86 exit($exitcode);
87}
88
Joe Perches000d1cc12011-07-25 17:13:25 -070089my $conf = which_conf($configuration_file);
90if (-f $conf) {
91 my @conf_args;
92 open(my $conffile, '<', "$conf")
93 or warn "$P: Can't find a readable $configuration_file file $!\n";
94
95 while (<$conffile>) {
96 my $line = $_;
97
98 $line =~ s/\s*\n?$//g;
99 $line =~ s/^\s*//g;
100 $line =~ s/\s+/ /g;
101
102 next if ($line =~ m/^\s*#/);
103 next if ($line =~ m/^\s*$/);
104
105 my @words = split(" ", $line);
106 foreach my $word (@words) {
107 last if ($word =~ m/^#/);
108 push (@conf_args, $word);
109 }
110 }
111 close($conffile);
112 unshift(@ARGV, @conf_args) if @conf_args;
113}
114
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700115GetOptions(
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700116 'q|quiet+' => \$quiet,
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700117 'tree!' => \$tree,
118 'signoff!' => \$chk_signoff,
119 'patch!' => \$chk_patch,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700120 'emacs!' => \$emacs,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800121 'terse!' => \$terse,
Hannes Eder77f5b102009-09-21 17:04:37 -0700122 'f|file!' => \$file,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700123 'subjective!' => \$check,
124 'strict!' => \$check,
Joe Perches000d1cc12011-07-25 17:13:25 -0700125 'ignore=s' => \@ignore,
Joe Perches91bfe482013-09-11 14:23:59 -0700126 'types=s' => \@use,
Joe Perches000d1cc12011-07-25 17:13:25 -0700127 'show-types!' => \$show_types,
Joe Perches6cd7f382012-12-17 16:01:54 -0800128 'max-line-length=i' => \$max_line_length,
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700129 'root=s' => \$root,
Andy Whitcroft8905a672007-11-28 16:21:06 -0800130 'summary!' => \$summary,
131 'mailback!' => \$mailback,
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800132 'summary-file!' => \$summary_file,
Joe Perches3705ce52013-07-03 15:05:31 -0700133 'fix!' => \$fix,
Dave Hansend62a2012013-09-11 14:23:56 -0700134 'ignore-perl-version!' => \$ignore_perl_version,
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800135 'debug=s' => \%debug,
Andy Whitcroft773647a2008-03-28 14:15:58 -0700136 'test-only=s' => \$tst_only,
Hannes Eder77f5b102009-09-21 17:04:37 -0700137 'h|help' => \$help,
138 'version' => \$help
139) or help(1);
140
141help(0) if ($help);
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700142
143my $exit = 0;
144
Dave Hansend62a2012013-09-11 14:23:56 -0700145if ($^V && $^V lt $minimum_perl_version) {
146 printf "$P: requires at least perl version %vd\n", $minimum_perl_version;
147 if (!$ignore_perl_version) {
148 exit(1);
149 }
150}
151
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700152if ($#ARGV < 0) {
Hannes Eder77f5b102009-09-21 17:04:37 -0700153 print "$P: no input files\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700154 exit(1);
155}
156
Joe Perches91bfe482013-09-11 14:23:59 -0700157sub hash_save_array_words {
158 my ($hashRef, $arrayRef) = @_;
Joe Perches000d1cc12011-07-25 17:13:25 -0700159
Joe Perches91bfe482013-09-11 14:23:59 -0700160 my @array = split(/,/, join(',', @$arrayRef));
161 foreach my $word (@array) {
162 $word =~ s/\s*\n?$//g;
163 $word =~ s/^\s*//g;
164 $word =~ s/\s+/ /g;
165 $word =~ tr/[a-z]/[A-Z]/;
Joe Perches000d1cc12011-07-25 17:13:25 -0700166
Joe Perches91bfe482013-09-11 14:23:59 -0700167 next if ($word =~ m/^\s*#/);
168 next if ($word =~ m/^\s*$/);
169
170 $hashRef->{$word}++;
171 }
Joe Perches000d1cc12011-07-25 17:13:25 -0700172}
173
Joe Perches91bfe482013-09-11 14:23:59 -0700174sub hash_show_words {
175 my ($hashRef, $prefix) = @_;
176
Joe Perches58cb3cf2013-09-11 14:24:04 -0700177 if ($quiet == 0 && keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700178 print "NOTE: $prefix message types:";
Joe Perches58cb3cf2013-09-11 14:24:04 -0700179 foreach my $word (sort keys %$hashRef) {
Joe Perches91bfe482013-09-11 14:23:59 -0700180 print " $word";
181 }
182 print "\n\n";
183 }
184}
185
186hash_save_array_words(\%ignore_type, \@ignore);
187hash_save_array_words(\%use_type, \@use);
188
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800189my $dbg_values = 0;
190my $dbg_possible = 0;
Andy Whitcroft7429c692008-07-23 21:29:06 -0700191my $dbg_type = 0;
Andy Whitcrofta1ef2772008-10-15 22:02:17 -0700192my $dbg_attr = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800193for my $key (keys %debug) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800194 ## no critic
195 eval "\${dbg_$key} = '$debug{$key}';";
196 die "$@" if ($@);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800197}
198
Andy Whitcroftd2c0a232010-10-26 14:23:12 -0700199my $rpt_cleaners = 0;
200
Andy Whitcroft8905a672007-11-28 16:21:06 -0800201if ($terse) {
202 $emacs = 1;
203 $quiet++;
204}
205
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700206if ($tree) {
207 if (defined $root) {
208 if (!top_of_kernel_tree($root)) {
209 die "$P: $root: --root does not point at a valid tree\n";
210 }
211 } else {
212 if (top_of_kernel_tree('.')) {
213 $root = '.';
214 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
215 top_of_kernel_tree($1)) {
216 $root = $1;
217 }
218 }
219
220 if (!defined $root) {
221 print "Must be run from the top-level dir. of a kernel tree\n";
222 exit(2);
223 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700224}
225
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700226my $emitted_corrupt = 0;
227
Andy Whitcroft2ceb5322009-10-26 16:50:14 -0700228our $Ident = qr{
229 [A-Za-z_][A-Za-z\d_]*
230 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
231 }x;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700232our $Storage = qr{extern|static|asmlinkage};
233our $Sparse = qr{
234 __user|
235 __kernel|
236 __force|
237 __iomem|
238 __must_check|
239 __init_refok|
Andy Whitcroft417495e2009-02-27 14:03:08 -0800240 __kprobes|
Sven Eckelmann165e72a2011-07-25 17:13:23 -0700241 __ref|
242 __rcu
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700243 }x;
Wolfram Sang52131292010-03-05 13:43:51 -0800244
Joe Perches8716de32013-09-11 14:24:05 -0700245our $InitAttribute = qr{__(?:mem|cpu|dev|net_|)(?:initdata|initconst|init\b)};
246
Wolfram Sang52131292010-03-05 13:43:51 -0800247# Notes to $Attribute:
248# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700249our $Attribute = qr{
250 const|
Joe Perches03f1df72010-10-26 14:23:16 -0700251 __percpu|
252 __nocast|
253 __safe|
254 __bitwise__|
255 __packed__|
256 __packed2__|
257 __naked|
258 __maybe_unused|
259 __always_unused|
260 __noreturn|
261 __used|
262 __cold|
263 __noclone|
264 __deprecated|
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700265 __read_mostly|
266 __kprobes|
Joe Perches8716de32013-09-11 14:24:05 -0700267 $InitAttribute|
Andy Whitcroft24e1d812008-10-15 22:02:18 -0700268 ____cacheline_aligned|
269 ____cacheline_aligned_in_smp|
Andy Whitcroft5fe3af12009-01-06 14:41:18 -0800270 ____cacheline_internodealigned_in_smp|
271 __weak
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700272 }x;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700273our $Modifier;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700274our $Inline = qr{inline|__always_inline|noinline};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700275our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
276our $Lval = qr{$Ident(?:$Member)*};
277
Joe Perches95e2c602013-07-03 15:05:20 -0700278our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u};
279our $Binary = qr{(?i)0b[01]+$Int_type?};
280our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?};
281our $Int = qr{[0-9]+$Int_type?};
Joe Perches326b1ff2013-02-04 14:28:51 -0800282our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?};
283our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?};
284our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?};
Joe Perches74349bc2012-12-17 16:02:05 -0800285our $Float = qr{$Float_hex|$Float_dec|$Float_int};
Joe Perches95e2c602013-07-03 15:05:20 -0700286our $Constant = qr{$Float|$Binary|$Hex|$Int};
Joe Perches326b1ff2013-02-04 14:28:51 -0800287our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=};
Andy Whitcroft86f9d052009-01-06 14:41:24 -0800288our $Compare = qr{<=|>=|==|!=|<|>};
Joe Perches23f780c2013-07-03 15:05:31 -0700289our $Arithmetic = qr{\+|-|\*|\/|%};
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700290our $Operators = qr{
291 <=|>=|==|!=|
292 =>|->|<<|>>|<|>|!|~|
Joe Perches23f780c2013-07-03 15:05:31 -0700293 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700294 }x;
295
Andy Whitcroft8905a672007-11-28 16:21:06 -0800296our $NonptrType;
Joe Perches8716de32013-09-11 14:24:05 -0700297our $NonptrTypeWithAttr;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800298our $Type;
299our $Declare;
300
Joe Perches15662b32011-10-31 17:13:12 -0700301our $NON_ASCII_UTF8 = qr{
302 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
Andy Whitcroft171ae1a2008-04-29 00:59:32 -0700303 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
304 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
305 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
306 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
307 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
308 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
309}x;
310
Joe Perches15662b32011-10-31 17:13:12 -0700311our $UTF8 = qr{
312 [\x09\x0A\x0D\x20-\x7E] # ASCII
313 | $NON_ASCII_UTF8
314}x;
315
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700316our $typeTypedefs = qr{(?x:
Andy Whitcroftfb9e9092009-09-21 17:04:38 -0700317 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700318 atomic_t
319)};
320
Joe Perches691e6692010-03-05 13:43:51 -0800321our $logFunctions = qr{(?x:
Joe Perches6e60c022011-07-25 17:13:27 -0700322 printk(?:_ratelimited|_once|)|
Jacob Keller7d0b6592013-07-03 15:05:35 -0700323 (?:[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 -0700324 WARN(?:_RATELIMIT|_ONCE|)|
Joe Perchesb0531722011-05-24 17:13:40 -0700325 panic|
326 MODULE_[A-Z_]+
Joe Perches691e6692010-03-05 13:43:51 -0800327)};
328
Joe Perches20112472011-07-25 17:13:23 -0700329our $signature_tags = qr{(?xi:
330 Signed-off-by:|
331 Acked-by:|
332 Tested-by:|
333 Reviewed-by:|
334 Reported-by:|
Mugunthan V N8543ae12013-04-29 16:18:17 -0700335 Suggested-by:|
Joe Perches20112472011-07-25 17:13:23 -0700336 To:|
337 Cc:
338)};
339
Andy Whitcroft8905a672007-11-28 16:21:06 -0800340our @typeList = (
341 qr{void},
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700342 qr{(?:unsigned\s+)?char},
343 qr{(?:unsigned\s+)?short},
344 qr{(?:unsigned\s+)?int},
345 qr{(?:unsigned\s+)?long},
346 qr{(?:unsigned\s+)?long\s+int},
347 qr{(?:unsigned\s+)?long\s+long},
348 qr{(?:unsigned\s+)?long\s+long\s+int},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800349 qr{unsigned},
350 qr{float},
351 qr{double},
352 qr{bool},
Andy Whitcroft8905a672007-11-28 16:21:06 -0800353 qr{struct\s+$Ident},
354 qr{union\s+$Ident},
355 qr{enum\s+$Ident},
356 qr{${Ident}_t},
357 qr{${Ident}_handler},
358 qr{${Ident}_handler_fn},
359);
Joe Perches8716de32013-09-11 14:24:05 -0700360our @typeListWithAttr = (
361 @typeList,
362 qr{struct\s+$InitAttribute\s+$Ident},
363 qr{union\s+$InitAttribute\s+$Ident},
364);
365
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700366our @modifierList = (
367 qr{fastcall},
368);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800369
Wolfram Sang7840a942010-08-09 17:20:57 -0700370our $allowed_asm_includes = qr{(?x:
371 irq|
372 memory
373)};
374# memory.h: ARM has a custom one
375
Andy Whitcroft8905a672007-11-28 16:21:06 -0800376sub build_types {
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700377 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
378 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
Joe Perches8716de32013-09-11 14:24:05 -0700379 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)";
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700380 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
Andy Whitcroft8905a672007-11-28 16:21:06 -0800381 $NonptrType = qr{
Andy Whitcroftd2172eb2008-07-23 21:29:07 -0700382 (?:$Modifier\s+|const\s+)*
Andy Whitcroftcf655042008-03-04 14:28:20 -0800383 (?:
Andy Whitcroft6b48db22012-01-10 15:10:13 -0800384 (?:typeof|__typeof__)\s*\([^\)]*\)|
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -0700385 (?:$typeTypedefs\b)|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700386 (?:${all}\b)
Andy Whitcroftcf655042008-03-04 14:28:20 -0800387 )
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700388 (?:\s+$Modifier|\s+const)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800389 }x;
Joe Perches8716de32013-09-11 14:24:05 -0700390 $NonptrTypeWithAttr = qr{
391 (?:$Modifier\s+|const\s+)*
392 (?:
393 (?:typeof|__typeof__)\s*\([^\)]*\)|
394 (?:$typeTypedefs\b)|
395 (?:${allWithAttr}\b)
396 )
397 (?:\s+$Modifier|\s+const)*
398 }x;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800399 $Type = qr{
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700400 $NonptrType
Andy Whitcroftb337d8b2012-03-23 15:02:18 -0700401 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -0700402 (?:\s+$Inline|\s+$Modifier)*
Andy Whitcroft8905a672007-11-28 16:21:06 -0800403 }x;
404 $Declare = qr{(?:$Storage\s+)?$Type};
405}
406build_types();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700407
Joe Perches7d2367a2011-07-25 17:13:22 -0700408our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
Joe Perchesd1fe9c02012-03-23 15:02:16 -0700409
410# Using $balanced_parens, $LvalOrFunc, or $FuncArg
411# requires at least perl version v5.10.0
412# Any use must be runtime checked with $^V
413
414our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
415our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
Joe Perchesd7c76ba2012-01-10 15:09:58 -0800416our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
Joe Perches7d2367a2011-07-25 17:13:22 -0700417
418sub deparenthesize {
419 my ($string) = @_;
420 return "" if (!defined($string));
421 $string =~ s@^\s*\(\s*@@g;
422 $string =~ s@\s*\)\s*$@@g;
423 $string =~ s@\s+@ @g;
424 return $string;
425}
426
Joe Perches34456862013-07-03 15:05:34 -0700427sub seed_camelcase_file {
428 my ($file) = @_;
429
430 return if (!(-f $file));
431
432 local $/;
433
434 open(my $include_file, '<', "$file")
435 or warn "$P: Can't read '$file' $!\n";
436 my $text = <$include_file>;
437 close($include_file);
438
439 my @lines = split('\n', $text);
440
441 foreach my $line (@lines) {
442 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/);
443 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) {
444 $camelcase{$1} = 1;
445 }
446 elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*\(/) {
447 $camelcase{$1} = 1;
448 }
449 }
450}
451
452my $camelcase_seeded = 0;
453sub seed_camelcase_includes {
454 return if ($camelcase_seeded);
455
456 my $files;
Joe Perchesc707a812013-07-08 16:00:43 -0700457 my $camelcase_cache = "";
458 my @include_files = ();
459
460 $camelcase_seeded = 1;
Joe Perches351b2a12013-07-03 15:05:36 -0700461
Joe Perches34456862013-07-03 15:05:34 -0700462 if (-d ".git") {
Joe Perches351b2a12013-07-03 15:05:36 -0700463 my $git_last_include_commit = `git log --no-merges --pretty=format:"%h%n" -1 -- include`;
464 chomp $git_last_include_commit;
Joe Perchesc707a812013-07-08 16:00:43 -0700465 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit";
Joe Perches34456862013-07-03 15:05:34 -0700466 } else {
Joe Perchesc707a812013-07-08 16:00:43 -0700467 my $last_mod_date = 0;
Joe Perches34456862013-07-03 15:05:34 -0700468 $files = `find $root/include -name "*.h"`;
Joe Perchesc707a812013-07-08 16:00:43 -0700469 @include_files = split('\n', $files);
470 foreach my $file (@include_files) {
471 my $date = POSIX::strftime("%Y%m%d%H%M",
472 localtime((stat $file)[9]));
473 $last_mod_date = $date if ($last_mod_date < $date);
474 }
475 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date";
Joe Perches34456862013-07-03 15:05:34 -0700476 }
Joe Perchesc707a812013-07-08 16:00:43 -0700477
478 if ($camelcase_cache ne "" && -f $camelcase_cache) {
479 open(my $camelcase_file, '<', "$camelcase_cache")
480 or warn "$P: Can't read '$camelcase_cache' $!\n";
481 while (<$camelcase_file>) {
482 chomp;
483 $camelcase{$_} = 1;
484 }
485 close($camelcase_file);
486
487 return;
488 }
489
490 if (-d ".git") {
491 $files = `git ls-files "include/*.h"`;
492 @include_files = split('\n', $files);
493 }
494
Joe Perches34456862013-07-03 15:05:34 -0700495 foreach my $file (@include_files) {
496 seed_camelcase_file($file);
497 }
Joe Perches351b2a12013-07-03 15:05:36 -0700498
Joe Perchesc707a812013-07-08 16:00:43 -0700499 if ($camelcase_cache ne "") {
Joe Perches351b2a12013-07-03 15:05:36 -0700500 unlink glob ".checkpatch-camelcase.*";
Joe Perchesc707a812013-07-08 16:00:43 -0700501 open(my $camelcase_file, '>', "$camelcase_cache")
502 or warn "$P: Can't write '$camelcase_cache' $!\n";
Joe Perches351b2a12013-07-03 15:05:36 -0700503 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) {
504 print $camelcase_file ("$_\n");
505 }
506 close($camelcase_file);
507 }
Joe Perches34456862013-07-03 15:05:34 -0700508}
509
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700510$chk_signoff = 0 if ($file);
511
Andy Whitcroft00df3442007-06-08 13:47:06 -0700512my @rawlines = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800513my @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700514my @fixed = ();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800515my $vname;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700516for my $filename (@ARGV) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800517 my $FILE;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700518 if ($file) {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800519 open($FILE, '-|', "diff -u /dev/null $filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700520 die "$P: $filename: diff failed - $!\n";
Andy Whitcroft21caa132009-01-06 14:41:30 -0800521 } elsif ($filename eq '-') {
522 open($FILE, '<&STDIN');
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700523 } else {
Andy Whitcroft21caa132009-01-06 14:41:30 -0800524 open($FILE, '<', "$filename") ||
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700525 die "$P: $filename: open failed - $!\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700526 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800527 if ($filename eq '-') {
528 $vname = 'Your patch';
529 } else {
530 $vname = $filename;
531 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800532 while (<$FILE>) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700533 chomp;
534 push(@rawlines, $_);
535 }
Andy Whitcroft21caa132009-01-06 14:41:30 -0800536 close($FILE);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800537 if (!process($filename)) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700538 $exit = 1;
539 }
540 @rawlines = ();
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800541 @lines = ();
Joe Perches3705ce52013-07-03 15:05:31 -0700542 @fixed = ();
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700543}
544
545exit($exit);
546
547sub top_of_kernel_tree {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700548 my ($root) = @_;
549
550 my @tree_check = (
551 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
552 "README", "Documentation", "arch", "include", "drivers",
553 "fs", "init", "ipc", "kernel", "lib", "scripts",
554 );
555
556 foreach my $check (@tree_check) {
557 if (! -e $root . '/' . $check) {
558 return 0;
559 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700560 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700561 return 1;
Joe Perches8f26b832012-10-04 17:13:32 -0700562}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700563
Joe Perches20112472011-07-25 17:13:23 -0700564sub parse_email {
565 my ($formatted_email) = @_;
566
567 my $name = "";
568 my $address = "";
569 my $comment = "";
570
571 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
572 $name = $1;
573 $address = $2;
574 $comment = $3 if defined $3;
575 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
576 $address = $1;
577 $comment = $2 if defined $2;
578 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
579 $address = $1;
580 $comment = $2 if defined $2;
581 $formatted_email =~ s/$address.*$//;
582 $name = $formatted_email;
Joe Perches3705ce52013-07-03 15:05:31 -0700583 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700584 $name =~ s/^\"|\"$//g;
585 # If there's a name left after stripping spaces and
586 # leading quotes, and the address doesn't have both
587 # leading and trailing angle brackets, the address
588 # is invalid. ie:
589 # "joe smith joe@smith.com" bad
590 # "joe smith <joe@smith.com" bad
591 if ($name ne "" && $address !~ /^<[^>]+>$/) {
592 $name = "";
593 $address = "";
594 $comment = "";
595 }
596 }
597
Joe Perches3705ce52013-07-03 15:05:31 -0700598 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700599 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700600 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700601 $address =~ s/^\<|\>$//g;
602
603 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
604 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
605 $name = "\"$name\"";
606 }
607
608 return ($name, $address, $comment);
609}
610
611sub format_email {
612 my ($name, $address) = @_;
613
614 my $formatted_email;
615
Joe Perches3705ce52013-07-03 15:05:31 -0700616 $name = trim($name);
Joe Perches20112472011-07-25 17:13:23 -0700617 $name =~ s/^\"|\"$//g;
Joe Perches3705ce52013-07-03 15:05:31 -0700618 $address = trim($address);
Joe Perches20112472011-07-25 17:13:23 -0700619
620 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
621 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
622 $name = "\"$name\"";
623 }
624
625 if ("$name" eq "") {
626 $formatted_email = "$address";
627 } else {
628 $formatted_email = "$name <$address>";
629 }
630
631 return $formatted_email;
632}
633
Joe Perches000d1cc12011-07-25 17:13:25 -0700634sub which_conf {
635 my ($conf) = @_;
636
637 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
638 if (-e "$path/$conf") {
639 return "$path/$conf";
640 }
641 }
642
643 return "";
644}
645
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700646sub expand_tabs {
647 my ($str) = @_;
648
649 my $res = '';
650 my $n = 0;
651 for my $c (split(//, $str)) {
652 if ($c eq "\t") {
653 $res .= ' ';
654 $n++;
655 for (; ($n % 8) != 0; $n++) {
656 $res .= ' ';
657 }
658 next;
659 }
660 $res .= $c;
661 $n++;
662 }
663
664 return $res;
665}
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700666sub copy_spacing {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700667 (my $res = shift) =~ tr/\t/ /c;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -0700668 return $res;
669}
Andy Whitcroft0a920b52007-06-01 00:46:48 -0700670
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700671sub line_stats {
672 my ($line) = @_;
673
674 # Drop the diff line leader and expand tabs
675 $line =~ s/^.//;
676 $line = expand_tabs($line);
677
678 # Pick the indent from the front of the line.
679 my ($white) = ($line =~ /^(\s*)/);
680
681 return (length($line), length($white));
682}
683
Andy Whitcroft773647a2008-03-28 14:15:58 -0700684my $sanitise_quote = '';
685
686sub sanitise_line_reset {
687 my ($in_comment) = @_;
688
689 if ($in_comment) {
690 $sanitise_quote = '*/';
691 } else {
692 $sanitise_quote = '';
693 }
694}
Andy Whitcroft00df3442007-06-08 13:47:06 -0700695sub sanitise_line {
696 my ($line) = @_;
697
698 my $res = '';
699 my $l = '';
700
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800701 my $qlen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700702 my $off = 0;
703 my $c;
Andy Whitcroft00df3442007-06-08 13:47:06 -0700704
Andy Whitcroft773647a2008-03-28 14:15:58 -0700705 # Always copy over the diff marker.
706 $res = substr($line, 0, 1);
707
708 for ($off = 1; $off < length($line); $off++) {
709 $c = substr($line, $off, 1);
710
711 # Comments we are wacking completly including the begin
712 # and end, all to $;.
713 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
714 $sanitise_quote = '*/';
715
716 substr($res, $off, 2, "$;$;");
717 $off++;
718 next;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800719 }
Andy Whitcroft81bc0e02008-10-15 22:02:26 -0700720 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700721 $sanitise_quote = '';
722 substr($res, $off, 2, "$;$;");
723 $off++;
724 next;
725 }
Daniel Walker113f04a2009-09-21 17:04:35 -0700726 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
727 $sanitise_quote = '//';
728
729 substr($res, $off, 2, $sanitise_quote);
730 $off++;
731 next;
732 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700733
734 # A \ in a string means ignore the next character.
735 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
736 $c eq "\\") {
737 substr($res, $off, 2, 'XX');
738 $off++;
739 next;
740 }
741 # Regular quotes.
742 if ($c eq "'" || $c eq '"') {
743 if ($sanitise_quote eq '') {
744 $sanitise_quote = $c;
745
746 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700747 next;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700748 } elsif ($sanitise_quote eq $c) {
749 $sanitise_quote = '';
Andy Whitcroft00df3442007-06-08 13:47:06 -0700750 }
751 }
Andy Whitcroft773647a2008-03-28 14:15:58 -0700752
Andy Whitcroftfae17da2009-01-06 14:41:20 -0800753 #print "c<$c> SQ<$sanitise_quote>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700754 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
755 substr($res, $off, 1, $;);
Daniel Walker113f04a2009-09-21 17:04:35 -0700756 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
757 substr($res, $off, 1, $;);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700758 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
759 substr($res, $off, 1, 'X');
Andy Whitcroft00df3442007-06-08 13:47:06 -0700760 } else {
Andy Whitcroft773647a2008-03-28 14:15:58 -0700761 substr($res, $off, 1, $c);
Andy Whitcroft00df3442007-06-08 13:47:06 -0700762 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800763 }
764
Daniel Walker113f04a2009-09-21 17:04:35 -0700765 if ($sanitise_quote eq '//') {
766 $sanitise_quote = '';
767 }
768
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800769 # The pathname on a #include may be surrounded by '<' and '>'.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700770 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800771 my $clean = 'X' x length($1);
772 $res =~ s@\<.*\>@<$clean>@;
773
774 # The whole of a #error is a string.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700775 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800776 my $clean = 'X' x length($1);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -0700777 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800778 }
779
Andy Whitcroft00df3442007-06-08 13:47:06 -0700780 return $res;
781}
782
Joe Perchesa6962d72013-04-29 16:18:13 -0700783sub get_quoted_string {
784 my ($line, $rawline) = @_;
785
786 return "" if ($line !~ m/(\"[X]+\")/g);
787 return substr($rawline, $-[0], $+[0] - $-[0]);
788}
789
Andy Whitcroft8905a672007-11-28 16:21:06 -0800790sub ctx_statement_block {
791 my ($linenr, $remain, $off) = @_;
792 my $line = $linenr - 1;
793 my $blk = '';
794 my $soff = $off;
795 my $coff = $off - 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700796 my $coff_set = 0;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800797
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800798 my $loff = 0;
799
Andy Whitcroft8905a672007-11-28 16:21:06 -0800800 my $type = '';
801 my $level = 0;
Andy Whitcrofta2750642009-01-15 13:51:04 -0800802 my @stack = ();
Andy Whitcroftcf655042008-03-04 14:28:20 -0800803 my $p;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800804 my $c;
805 my $len = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800806
807 my $remainder;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800808 while (1) {
Andy Whitcrofta2750642009-01-15 13:51:04 -0800809 @stack = (['', 0]) if ($#stack == -1);
810
Andy Whitcroft773647a2008-03-28 14:15:58 -0700811 #warn "CSB: blk<$blk> remain<$remain>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800812 # If we are about to drop off the end, pull in more
813 # context.
814 if ($off >= $len) {
815 for (; $remain > 0; $line++) {
Andy Whitcroftdea33492008-10-15 22:02:25 -0700816 last if (!defined $lines[$line]);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800817 next if ($lines[$line] =~ /^-/);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800818 $remain--;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800819 $loff = $len;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -0800820 $blk .= $lines[$line] . "\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800821 $len = length($blk);
822 $line++;
823 last;
824 }
825 # Bail if there is no further context.
826 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800827 if ($off >= $len) {
Andy Whitcroft8905a672007-11-28 16:21:06 -0800828 last;
829 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800830 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
831 $level++;
832 $type = '#';
833 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800834 }
Andy Whitcroftcf655042008-03-04 14:28:20 -0800835 $p = $c;
Andy Whitcroft8905a672007-11-28 16:21:06 -0800836 $c = substr($blk, $off, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800837 $remainder = substr($blk, $off);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800838
Andy Whitcroft773647a2008-03-28 14:15:58 -0700839 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
Andy Whitcroft4635f4f2009-01-06 14:41:27 -0800840
841 # Handle nested #if/#else.
842 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
843 push(@stack, [ $type, $level ]);
844 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
845 ($type, $level) = @{$stack[$#stack - 1]};
846 } elsif ($remainder =~ /^#\s*endif\b/) {
847 ($type, $level) = @{pop(@stack)};
848 }
849
Andy Whitcroft8905a672007-11-28 16:21:06 -0800850 # Statement ends at the ';' or a close '}' at the
851 # outermost level.
852 if ($level == 0 && $c eq ';') {
853 last;
854 }
855
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800856 # An else is really a conditional as long as its not else if
Andy Whitcroft773647a2008-03-28 14:15:58 -0700857 if ($level == 0 && $coff_set == 0 &&
858 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
859 $remainder =~ /^(else)(?:\s|{)/ &&
860 $remainder !~ /^else\s+if\b/) {
861 $coff = $off + length($1) - 1;
862 $coff_set = 1;
863 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
864 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800865 }
866
Andy Whitcroft8905a672007-11-28 16:21:06 -0800867 if (($type eq '' || $type eq '(') && $c eq '(') {
868 $level++;
869 $type = '(';
870 }
871 if ($type eq '(' && $c eq ')') {
872 $level--;
873 $type = ($level != 0)? '(' : '';
874
875 if ($level == 0 && $coff < $soff) {
876 $coff = $off;
Andy Whitcroft773647a2008-03-28 14:15:58 -0700877 $coff_set = 1;
878 #warn "CSB: mark coff<$coff>\n";
Andy Whitcroft8905a672007-11-28 16:21:06 -0800879 }
880 }
881 if (($type eq '' || $type eq '{') && $c eq '{') {
882 $level++;
883 $type = '{';
884 }
885 if ($type eq '{' && $c eq '}') {
886 $level--;
887 $type = ($level != 0)? '{' : '';
888
889 if ($level == 0) {
Patrick Pannutob998e002010-08-09 17:21:03 -0700890 if (substr($blk, $off + 1, 1) eq ';') {
891 $off++;
892 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800893 last;
894 }
895 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -0800896 # Preprocessor commands end at the newline unless escaped.
897 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
898 $level--;
899 $type = '';
900 $off++;
901 last;
902 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800903 $off++;
904 }
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700905 # We are truly at the end, so shuffle to the next line.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800906 if ($off == $len) {
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -0700907 $loff = $len + 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800908 $line++;
909 $remain--;
910 }
Andy Whitcroft8905a672007-11-28 16:21:06 -0800911
912 my $statement = substr($blk, $soff, $off - $soff + 1);
913 my $condition = substr($blk, $soff, $coff - $soff + 1);
914
915 #warn "STATEMENT<$statement>\n";
916 #warn "CONDITION<$condition>\n";
917
Andy Whitcroft773647a2008-03-28 14:15:58 -0700918 #print "coff<$coff> soff<$off> loff<$loff>\n";
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800919
920 return ($statement, $condition,
921 $line, $remain + 1, $off - $loff + 1, $level);
922}
923
Andy Whitcroftcf655042008-03-04 14:28:20 -0800924sub statement_lines {
925 my ($stmt) = @_;
926
927 # Strip the diff line prefixes and rip blank lines at start and end.
928 $stmt =~ s/(^|\n)./$1/g;
929 $stmt =~ s/^\s*//;
930 $stmt =~ s/\s*$//;
931
932 my @stmt_lines = ($stmt =~ /\n/g);
933
934 return $#stmt_lines + 2;
935}
936
937sub statement_rawlines {
938 my ($stmt) = @_;
939
940 my @stmt_lines = ($stmt =~ /\n/g);
941
942 return $#stmt_lines + 2;
943}
944
945sub statement_block_size {
946 my ($stmt) = @_;
947
948 $stmt =~ s/(^|\n)./$1/g;
949 $stmt =~ s/^\s*{//;
950 $stmt =~ s/}\s*$//;
951 $stmt =~ s/^\s*//;
952 $stmt =~ s/\s*$//;
953
954 my @stmt_lines = ($stmt =~ /\n/g);
955 my @stmt_statements = ($stmt =~ /;/g);
956
957 my $stmt_lines = $#stmt_lines + 2;
958 my $stmt_statements = $#stmt_statements + 1;
959
960 if ($stmt_lines > $stmt_statements) {
961 return $stmt_lines;
962 } else {
963 return $stmt_statements;
964 }
965}
966
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800967sub ctx_statement_full {
968 my ($linenr, $remain, $off) = @_;
969 my ($statement, $condition, $level);
970
971 my (@chunks);
972
Andy Whitcroftcf655042008-03-04 14:28:20 -0800973 # Grab the first conditional/block pair.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800974 ($statement, $condition, $linenr, $remain, $off, $level) =
975 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroft773647a2008-03-28 14:15:58 -0700976 #print "F: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -0800977 push(@chunks, [ $condition, $statement ]);
978 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
979 return ($level, $linenr, @chunks);
980 }
981
982 # Pull in the following conditional/block pairs and see if they
983 # could continue the statement.
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800984 for (;;) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800985 ($statement, $condition, $linenr, $remain, $off, $level) =
986 ctx_statement_block($linenr, $remain, $off);
Andy Whitcroftcf655042008-03-04 14:28:20 -0800987 #print "C: c<$condition> s<$statement> remain<$remain>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -0700988 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
Andy Whitcroftcf655042008-03-04 14:28:20 -0800989 #print "C: push\n";
990 push(@chunks, [ $condition, $statement ]);
Andy Whitcroft13214ad2008-02-08 04:22:03 -0800991 }
992
993 return ($level, $linenr, @chunks);
Andy Whitcroft8905a672007-11-28 16:21:06 -0800994}
995
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700996sub ctx_block_get {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -0700997 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -0700998 my $line;
999 my $start = $linenr - 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001000 my $blk = '';
1001 my @o;
1002 my @c;
1003 my @res = ();
1004
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001005 my $level = 0;
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001006 my @stack = ($level);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001007 for ($line = $start; $remain > 0; $line++) {
1008 next if ($rawlines[$line] =~ /^-/);
1009 $remain--;
1010
1011 $blk .= $rawlines[$line];
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001012
1013 # Handle nested #if/#else.
Andy Whitcroft01464f32010-10-26 14:23:19 -07001014 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001015 push(@stack, $level);
Andy Whitcroft01464f32010-10-26 14:23:19 -07001016 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001017 $level = $stack[$#stack - 1];
Andy Whitcroft01464f32010-10-26 14:23:19 -07001018 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
Andy Whitcroft4635f4f2009-01-06 14:41:27 -08001019 $level = pop(@stack);
1020 }
1021
Andy Whitcroft01464f32010-10-26 14:23:19 -07001022 foreach my $c (split(//, $lines[$line])) {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001023 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1024 if ($off > 0) {
1025 $off--;
1026 next;
1027 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001028
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001029 if ($c eq $close && $level > 0) {
1030 $level--;
1031 last if ($level == 0);
1032 } elsif ($c eq $open) {
1033 $level++;
1034 }
1035 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001036
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001037 if (!$outer || $level <= 1) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001038 push(@res, $rawlines[$line]);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001039 }
1040
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001041 last if ($level == 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001042 }
1043
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001044 return ($level, @res);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001045}
1046sub ctx_block_outer {
1047 my ($linenr, $remain) = @_;
1048
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001049 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1050 return @r;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001051}
1052sub ctx_block {
1053 my ($linenr, $remain) = @_;
1054
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001055 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1056 return @r;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001057}
1058sub ctx_statement {
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001059 my ($linenr, $remain, $off) = @_;
1060
1061 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1062 return @r;
1063}
1064sub ctx_block_level {
Andy Whitcroft653d4872007-06-23 17:16:34 -07001065 my ($linenr, $remain) = @_;
1066
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001067 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001068}
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001069sub ctx_statement_level {
1070 my ($linenr, $remain, $off) = @_;
1071
1072 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1073}
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001074
1075sub ctx_locate_comment {
1076 my ($first_line, $end_line) = @_;
1077
1078 # Catch a comment on the end of the line itself.
Andy Whitcroftbeae6332008-07-23 21:28:59 -07001079 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001080 return $current_comment if (defined $current_comment);
1081
1082 # Look through the context and try and figure out if there is a
1083 # comment.
1084 my $in_comment = 0;
1085 $current_comment = '';
1086 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07001087 my $line = $rawlines[$linenr - 1];
1088 #warn " $line\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001089 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1090 $in_comment = 1;
1091 }
1092 if ($line =~ m@/\*@) {
1093 $in_comment = 1;
1094 }
1095 if (!$in_comment && $current_comment ne '') {
1096 $current_comment = '';
1097 }
1098 $current_comment .= $line . "\n" if ($in_comment);
1099 if ($line =~ m@\*/@) {
1100 $in_comment = 0;
1101 }
1102 }
1103
1104 chomp($current_comment);
1105 return($current_comment);
1106}
1107sub ctx_has_comment {
1108 my ($first_line, $end_line) = @_;
1109 my $cmt = ctx_locate_comment($first_line, $end_line);
1110
Andy Whitcroft00df3442007-06-08 13:47:06 -07001111 ##print "LINE: $rawlines[$end_line - 1 ]\n";
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001112 ##print "CMMT: $cmt\n";
1113
1114 return ($cmt ne '');
1115}
1116
Andy Whitcroft4d001e42008-10-15 22:02:21 -07001117sub raw_line {
1118 my ($linenr, $cnt) = @_;
1119
1120 my $offset = $linenr - 1;
1121 $cnt++;
1122
1123 my $line;
1124 while ($cnt) {
1125 $line = $rawlines[$offset++];
1126 next if (defined($line) && $line =~ /^-/);
1127 $cnt--;
1128 }
1129
1130 return $line;
1131}
1132
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001133sub cat_vet {
1134 my ($vet) = @_;
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001135 my ($res, $coded);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001136
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001137 $res = '';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001138 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1139 $res .= $1;
1140 if ($2 ne '') {
1141 $coded = sprintf("^%c", unpack('C', $2) + 64);
1142 $res .= $coded;
1143 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001144 }
1145 $res =~ s/$/\$/;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001146
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001147 return $res;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001148}
1149
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001150my $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001151my $av_pending;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001152my @av_paren_type;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001153my $av_pend_colon;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001154
1155sub annotate_reset {
1156 $av_preprocessor = 0;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001157 $av_pending = '_';
1158 @av_paren_type = ('E');
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001159 $av_pend_colon = 'O';
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001160}
1161
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001162sub annotate_values {
1163 my ($stream, $type) = @_;
1164
1165 my $res;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001166 my $var = '_' x length($stream);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001167 my $cur = $stream;
1168
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001169 print "$stream\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001170
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001171 while (length($cur)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001172 @av_paren_type = ('E') if ($#av_paren_type < 0);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001173 print " <" . join('', @av_paren_type) .
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001174 "> <$type> <$av_pending>" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001175 if ($cur =~ /^(\s+)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001176 print "WS($1)\n" if ($dbg_values > 1);
1177 if ($1 =~ /\n/ && $av_preprocessor) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001178 $type = pop(@av_paren_type);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001179 $av_preprocessor = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001180 }
1181
Florian Micklerc023e4732011-01-12 16:59:58 -08001182 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001183 print "CAST($1)\n" if ($dbg_values > 1);
1184 push(@av_paren_type, $type);
Andy Whitcroftaddcdce2012-01-10 15:10:11 -08001185 $type = 'c';
Andy Whitcroft9446ef52010-10-26 14:23:13 -07001186
Andy Whitcrofte91b6e22010-10-26 14:23:11 -07001187 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001188 print "DECLARE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001189 $type = 'T';
1190
Andy Whitcroft389a2fe2008-07-23 21:29:05 -07001191 } elsif ($cur =~ /^($Modifier)\s*/) {
1192 print "MODIFIER($1)\n" if ($dbg_values > 1);
1193 $type = 'T';
1194
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001195 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001196 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001197 $av_preprocessor = 1;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001198 push(@av_paren_type, $type);
1199 if ($2 ne '') {
1200 $av_pending = 'N';
1201 }
1202 $type = 'E';
1203
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001204 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001205 print "UNDEF($1)\n" if ($dbg_values > 1);
1206 $av_preprocessor = 1;
1207 push(@av_paren_type, $type);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001208
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001209 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001210 print "PRE_START($1)\n" if ($dbg_values > 1);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001211 $av_preprocessor = 1;
Andy Whitcroftcf655042008-03-04 14:28:20 -08001212
1213 push(@av_paren_type, $type);
1214 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001215 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001216
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001217 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001218 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1219 $av_preprocessor = 1;
1220
1221 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1222
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001223 $type = 'E';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001224
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001225 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001226 print "PRE_END($1)\n" if ($dbg_values > 1);
1227
1228 $av_preprocessor = 1;
1229
1230 # Assume all arms of the conditional end as this
1231 # one does, and continue as if the #endif was not here.
1232 pop(@av_paren_type);
1233 push(@av_paren_type, $type);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001234 $type = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001235
1236 } elsif ($cur =~ /^(\\\n)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001237 print "PRECONT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001238
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001239 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1240 print "ATTR($1)\n" if ($dbg_values > 1);
1241 $av_pending = $type;
1242 $type = 'N';
1243
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001244 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001245 print "SIZEOF($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001246 if (defined $2) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001247 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001248 }
1249 $type = 'N';
1250
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001251 } elsif ($cur =~ /^(if|while|for)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001252 print "COND($1)\n" if ($dbg_values > 1);
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001253 $av_pending = 'E';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001254 $type = 'N';
1255
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001256 } elsif ($cur =~/^(case)/o) {
1257 print "CASE($1)\n" if ($dbg_values > 1);
1258 $av_pend_colon = 'C';
1259 $type = 'N';
1260
Andy Whitcroft14b111c2008-10-15 22:02:16 -07001261 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001262 print "KEYWORD($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001263 $type = 'N';
1264
1265 } elsif ($cur =~ /^(\()/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001266 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroftcf655042008-03-04 14:28:20 -08001267 push(@av_paren_type, $av_pending);
1268 $av_pending = '_';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001269 $type = 'N';
1270
1271 } elsif ($cur =~ /^(\))/o) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08001272 my $new_type = pop(@av_paren_type);
1273 if ($new_type ne '_') {
1274 $type = $new_type;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001275 print "PAREN('$1') -> $type\n"
1276 if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001277 } else {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001278 print "PAREN('$1')\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001279 }
1280
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001281 } elsif ($cur =~ /^($Ident)\s*\(/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001282 print "FUNC($1)\n" if ($dbg_values > 1);
Andy Whitcroftc8cb2ca2008-07-23 21:28:57 -07001283 $type = 'V';
Andy Whitcroftcf655042008-03-04 14:28:20 -08001284 $av_pending = 'V';
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001285
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001286 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1287 if (defined $2 && $type eq 'C' || $type eq 'T') {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001288 $av_pend_colon = 'B';
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001289 } elsif ($type eq 'E') {
1290 $av_pend_colon = 'L';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001291 }
1292 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1293 $type = 'V';
1294
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001295 } elsif ($cur =~ /^($Ident|$Constant)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001296 print "IDENT($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001297 $type = 'V';
1298
1299 } elsif ($cur =~ /^($Assignment)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001300 print "ASSIGN($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001301 $type = 'N';
1302
Andy Whitcroftcf655042008-03-04 14:28:20 -08001303 } elsif ($cur =~/^(;|{|})/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001304 print "END($1)\n" if ($dbg_values > 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001305 $type = 'E';
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001306 $av_pend_colon = 'O';
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001307
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001308 } elsif ($cur =~/^(,)/) {
1309 print "COMMA($1)\n" if ($dbg_values > 1);
1310 $type = 'C';
1311
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001312 } elsif ($cur =~ /^(\?)/o) {
1313 print "QUESTION($1)\n" if ($dbg_values > 1);
1314 $type = 'N';
1315
1316 } elsif ($cur =~ /^(:)/o) {
1317 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1318
1319 substr($var, length($res), 1, $av_pend_colon);
1320 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1321 $type = 'E';
1322 } else {
1323 $type = 'N';
1324 }
1325 $av_pend_colon = 'O';
1326
Andy Whitcroft8e761b02009-01-06 14:41:19 -08001327 } elsif ($cur =~ /^(\[)/o) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001328 print "CLOSE($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001329 $type = 'N';
1330
Andy Whitcroft0d413862008-10-15 22:02:16 -07001331 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
Andy Whitcroft74048ed2008-07-23 21:29:10 -07001332 my $variant;
1333
1334 print "OPV($1)\n" if ($dbg_values > 1);
1335 if ($type eq 'V') {
1336 $variant = 'B';
1337 } else {
1338 $variant = 'U';
1339 }
1340
1341 substr($var, length($res), 1, $variant);
1342 $type = 'N';
1343
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001344 } elsif ($cur =~ /^($Operators)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001345 print "OP($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001346 if ($1 ne '++' && $1 ne '--') {
1347 $type = 'N';
1348 }
1349
1350 } elsif ($cur =~ /(^.)/o) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001351 print "C($1)\n" if ($dbg_values > 1);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001352 }
1353 if (defined $1) {
1354 $cur = substr($cur, length($1));
1355 $res .= $type x length($1);
1356 }
1357 }
1358
Andy Whitcroft1f65f942008-07-23 21:29:10 -07001359 return ($res, $var);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001360}
1361
Andy Whitcroft8905a672007-11-28 16:21:06 -08001362sub possible {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001363 my ($possible, $line) = @_;
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001364 my $notPermitted = qr{(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001365 ^(?:
1366 $Modifier|
1367 $Storage|
1368 $Type|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001369 DEFINE_\S+
1370 )$|
1371 ^(?:
Andy Whitcroft0776e592008-10-15 22:02:29 -07001372 goto|
1373 return|
1374 case|
1375 else|
1376 asm|__asm__|
Andy Whitcroft89a88352012-01-10 15:10:00 -08001377 do|
1378 \#|
1379 \#\#|
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001380 )(?:\s|$)|
Andy Whitcroft0776e592008-10-15 22:02:29 -07001381 ^(?:typedef|struct|enum)\b
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001382 )}x;
1383 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1384 if ($possible !~ $notPermitted) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001385 # Check for modifiers.
1386 $possible =~ s/\s*$Storage\s*//g;
1387 $possible =~ s/\s*$Sparse\s*//g;
1388 if ($possible =~ /^\s*$/) {
1389
1390 } elsif ($possible =~ /\s/) {
1391 $possible =~ s/\s*$Type\s*//g;
Andy Whitcroftd2506582008-07-23 21:29:09 -07001392 for my $modifier (split(' ', $possible)) {
Andy Whitcroft9a974fd2009-10-26 16:50:12 -07001393 if ($modifier !~ $notPermitted) {
1394 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1395 push(@modifierList, $modifier);
1396 }
Andy Whitcroftd2506582008-07-23 21:29:09 -07001397 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001398
1399 } else {
1400 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1401 push(@typeList, $possible);
1402 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001403 build_types();
Andy Whitcroft0776e592008-10-15 22:02:29 -07001404 } else {
1405 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08001406 }
1407}
1408
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001409my $prefix = '';
1410
Joe Perches000d1cc12011-07-25 17:13:25 -07001411sub show_type {
Joe Perches91bfe482013-09-11 14:23:59 -07001412 return defined $use_type{$_[0]} if (scalar keys %use_type > 0);
1413
1414 return !defined $ignore_type{$_[0]};
Joe Perches000d1cc12011-07-25 17:13:25 -07001415}
1416
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001417sub report {
Joe Perches000d1cc12011-07-25 17:13:25 -07001418 if (!show_type($_[1]) ||
1419 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001420 return 0;
1421 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001422 my $line;
1423 if ($show_types) {
1424 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1425 } else {
1426 $line = "$prefix$_[0]: $_[2]\n";
1427 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08001428 $line = (split('\n', $line))[0] . "\n" if ($terse);
1429
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001430 push(our @report, $line);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001431
1432 return 1;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001433}
1434sub report_dump {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001435 our @report;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07001436}
Joe Perches000d1cc12011-07-25 17:13:25 -07001437
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001438sub ERROR {
Joe Perches000d1cc12011-07-25 17:13:25 -07001439 if (report("ERROR", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001440 our $clean = 0;
1441 our $cnt_error++;
Joe Perches3705ce52013-07-03 15:05:31 -07001442 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001443 }
Joe Perches3705ce52013-07-03 15:05:31 -07001444 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001445}
1446sub WARN {
Joe Perches000d1cc12011-07-25 17:13:25 -07001447 if (report("WARNING", $_[0], $_[1])) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001448 our $clean = 0;
1449 our $cnt_warn++;
Joe Perches3705ce52013-07-03 15:05:31 -07001450 return 1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001451 }
Joe Perches3705ce52013-07-03 15:05:31 -07001452 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001453}
1454sub CHK {
Joe Perches000d1cc12011-07-25 17:13:25 -07001455 if ($check && report("CHECK", $_[0], $_[1])) {
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001456 our $clean = 0;
1457 our $cnt_chk++;
Joe Perches3705ce52013-07-03 15:05:31 -07001458 return 1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001459 }
Joe Perches3705ce52013-07-03 15:05:31 -07001460 return 0;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001461}
1462
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001463sub check_absolute_file {
1464 my ($absolute, $herecurr) = @_;
1465 my $file = $absolute;
1466
1467 ##print "absolute<$absolute>\n";
1468
1469 # See if any suffix of this path is a path within the tree.
1470 while ($file =~ s@^[^/]*/@@) {
1471 if (-f "$root/$file") {
1472 ##print "file<$file>\n";
1473 last;
1474 }
1475 }
1476 if (! -f _) {
1477 return 0;
1478 }
1479
1480 # It is, so see if the prefix is acceptable.
1481 my $prefix = $absolute;
1482 substr($prefix, -length($file)) = '';
1483
1484 ##print "prefix<$prefix>\n";
1485 if ($prefix ne ".../") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001486 WARN("USE_RELATIVE_PATH",
1487 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001488 }
1489}
1490
Joe Perches3705ce52013-07-03 15:05:31 -07001491sub trim {
1492 my ($string) = @_;
1493
Joe Perchesb34c6482013-09-11 14:24:01 -07001494 $string =~ s/^\s+|\s+$//g;
1495
1496 return $string;
1497}
1498
1499sub ltrim {
1500 my ($string) = @_;
1501
1502 $string =~ s/^\s+//;
1503
1504 return $string;
1505}
1506
1507sub rtrim {
1508 my ($string) = @_;
1509
1510 $string =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001511
1512 return $string;
1513}
1514
1515sub tabify {
1516 my ($leading) = @_;
1517
1518 my $source_indent = 8;
1519 my $max_spaces_before_tab = $source_indent - 1;
1520 my $spaces_to_tab = " " x $source_indent;
1521
1522 #convert leading spaces to tabs
1523 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g;
1524 #Remove spaces before a tab
1525 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g;
1526
1527 return "$leading";
1528}
1529
Joe Perchesd1fe9c02012-03-23 15:02:16 -07001530sub pos_last_openparen {
1531 my ($line) = @_;
1532
1533 my $pos = 0;
1534
1535 my $opens = $line =~ tr/\(/\(/;
1536 my $closes = $line =~ tr/\)/\)/;
1537
1538 my $last_openparen = 0;
1539
1540 if (($opens == 0) || ($closes >= $opens)) {
1541 return -1;
1542 }
1543
1544 my $len = length($line);
1545
1546 for ($pos = 0; $pos < $len; $pos++) {
1547 my $string = substr($line, $pos);
1548 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1549 $pos += length($1) - 1;
1550 } elsif (substr($line, $pos, 1) eq '(') {
1551 $last_openparen = $pos;
1552 } elsif (index($string, '(') == -1) {
1553 last;
1554 }
1555 }
1556
1557 return $last_openparen + 1;
1558}
1559
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001560sub process {
1561 my $filename = shift;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001562
1563 my $linenr=0;
1564 my $prevline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001565 my $prevrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001566 my $stashline="";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001567 my $stashrawline="";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001568
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001569 my $length;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001570 my $indent;
1571 my $previndent=0;
1572 my $stashindent=0;
1573
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001574 our $clean = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001575 my $signoff = 0;
1576 my $is_patch = 0;
1577
Joe Perches15662b32011-10-31 17:13:12 -07001578 my $in_header_lines = 1;
1579 my $in_commit_log = 0; #Scanning lines before patch
1580
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001581 my $non_utf8_charset = 0;
1582
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001583 our @report = ();
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001584 our $cnt_lines = 0;
1585 our $cnt_error = 0;
1586 our $cnt_warn = 0;
1587 our $cnt_chk = 0;
1588
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001589 # Trace the real file/line as we go.
1590 my $realfile = '';
1591 my $realline = 0;
1592 my $realcnt = 0;
1593 my $here = '';
1594 my $in_comment = 0;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001595 my $comment_edge = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001596 my $first_line = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001597 my $p1_prefix = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001598
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001599 my $prev_values = 'E';
1600
1601 # suppression flags
Andy Whitcroft773647a2008-03-28 14:15:58 -07001602 my %suppress_ifbraces;
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001603 my %suppress_whiletrailers;
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001604 my %suppress_export;
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001605 my $suppress_statement = 0;
Andy Whitcroft653d4872007-06-23 17:16:34 -07001606
Joe Perches7e51f192013-09-11 14:23:57 -07001607 my %signatures = ();
Joe Perches323c1262012-12-17 16:02:07 -08001608
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001609 # Pre-scan the patch sanitizing the lines.
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001610 # Pre-scan the patch looking for any __setup documentation.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001611 #
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001612 my @setup_docs = ();
1613 my $setup_docs = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001614
1615 sanitise_line_reset();
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001616 my $line;
1617 foreach my $rawline (@rawlines) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001618 $linenr++;
1619 $line = $rawline;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001620
Joe Perches3705ce52013-07-03 15:05:31 -07001621 push(@fixed, $rawline) if ($fix);
1622
Andy Whitcroft773647a2008-03-28 14:15:58 -07001623 if ($rawline=~/^\+\+\+\s+(\S+)/) {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001624 $setup_docs = 0;
1625 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1626 $setup_docs = 1;
1627 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001628 #next;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001629 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001630 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1631 $realline=$1-1;
1632 if (defined $2) {
1633 $realcnt=$3+1;
1634 } else {
1635 $realcnt=1+1;
1636 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07001637 $in_comment = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07001638
1639 # Guestimate if this is a continuing comment. Run
1640 # the context looking for a comment "edge". If this
1641 # edge is a close comment then we must be in a comment
1642 # at context start.
1643 my $edge;
Andy Whitcroft01fa9142008-10-15 22:02:19 -07001644 my $cnt = $realcnt;
1645 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1646 next if (defined $rawlines[$ln - 1] &&
1647 $rawlines[$ln - 1] =~ /^-/);
1648 $cnt--;
1649 #print "RAW<$rawlines[$ln - 1]>\n";
Andy Whitcroft721c1cb2009-01-06 14:41:16 -08001650 last if (!defined $rawlines[$ln - 1]);
Andy Whitcroftfae17da2009-01-06 14:41:20 -08001651 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1652 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1653 ($edge) = $1;
1654 last;
1655 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001656 }
1657 if (defined $edge && $edge eq '*/') {
1658 $in_comment = 1;
1659 }
1660
1661 # Guestimate if this is a continuing comment. If this
1662 # is the start of a diff block and this line starts
1663 # ' *' then it is very likely a comment.
1664 if (!defined $edge &&
Andy Whitcroft83242e02009-01-06 14:41:17 -08001665 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
Andy Whitcroft773647a2008-03-28 14:15:58 -07001666 {
1667 $in_comment = 1;
1668 }
1669
1670 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1671 sanitise_line_reset($in_comment);
1672
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001673 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001674 # Standardise the strings and chars within the input to
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001675 # simplify matching -- only bother with positive lines.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001676 $line = sanitise_line($rawline);
1677 }
1678 push(@lines, $line);
1679
1680 if ($realcnt > 1) {
1681 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1682 } else {
1683 $realcnt = 0;
1684 }
1685
1686 #print "==>$rawline\n";
1687 #print "-->$line\n";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001688
1689 if ($setup_docs && $line =~ /^\+/) {
1690 push(@setup_docs, $line);
1691 }
1692 }
1693
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001694 $prefix = '';
1695
Andy Whitcroft773647a2008-03-28 14:15:58 -07001696 $realcnt = 0;
1697 $linenr = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001698 foreach my $line (@lines) {
1699 $linenr++;
Joe Perches1b5539b2013-09-11 14:24:03 -07001700 my $sline = $line; #copy of $line
1701 $sline =~ s/$;/ /g; #with comments as spaces
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001702
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001703 my $rawline = $rawlines[$linenr - 1];
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001704
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001705#extract the line range in the file after the patch is applied
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001706 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001707 $is_patch = 1;
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001708 $first_line = $linenr + 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001709 $realline=$1-1;
1710 if (defined $2) {
1711 $realcnt=$3+1;
1712 } else {
1713 $realcnt=1+1;
1714 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001715 annotate_reset();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08001716 $prev_values = 'E';
1717
Andy Whitcroft773647a2008-03-28 14:15:58 -07001718 %suppress_ifbraces = ();
Andy Whitcroft170d3a22008-10-15 22:02:30 -07001719 %suppress_whiletrailers = ();
Andy Whitcroft2b474a12009-10-26 16:50:16 -07001720 %suppress_export = ();
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08001721 $suppress_statement = 0;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001722 next;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001723
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001724# track the line number as we move through the hunk, note that
1725# new versions of GNU diff omit the leading space on completely
1726# blank context lines so we need to count that too.
Andy Whitcroft773647a2008-03-28 14:15:58 -07001727 } elsif ($line =~ /^( |\+|$)/) {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001728 $realline++;
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001729 $realcnt-- if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001730
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001731 # Measure the line length and indent.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001732 ($length, $indent) = line_stats($rawline);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001733
1734 # Track the previous line.
1735 ($prevline, $stashline) = ($stashline, $line);
1736 ($previndent, $stashindent) = ($stashindent, $indent);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001737 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1738
Andy Whitcroft773647a2008-03-28 14:15:58 -07001739 #warn "line<$line>\n";
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001740
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001741 } elsif ($realcnt == 1) {
1742 $realcnt--;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001743 }
1744
Andy Whitcroftcc77cdc2009-10-26 16:50:13 -07001745 my $hunk_line = ($realcnt != 0);
1746
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001747#make up the handle for any error we report on this line
Andy Whitcroft773647a2008-03-28 14:15:58 -07001748 $prefix = "$filename:$realline: " if ($emacs && $file);
1749 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1750
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001751 $here = "#$linenr: " if (!$file);
1752 $here = "#$realline: " if ($file);
Andy Whitcroft773647a2008-03-28 14:15:58 -07001753
1754 # extract the filename as it passes
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001755 if ($line =~ /^diff --git.*?(\S+)$/) {
1756 $realfile = $1;
1757 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001758 $in_commit_log = 0;
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001759 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07001760 $realfile = $1;
Wolfram Sang1e855722009-01-06 14:41:24 -08001761 $realfile =~ s@^([^/]*)/@@;
Joe Perches270c49a2012-01-10 15:09:50 -08001762 $in_commit_log = 0;
Wolfram Sang1e855722009-01-06 14:41:24 -08001763
1764 $p1_prefix = $1;
Andy Whitcrofte2f7aa42009-02-27 14:03:06 -08001765 if (!$file && $tree && $p1_prefix ne '' &&
1766 -e "$root/$p1_prefix") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001767 WARN("PATCH_PREFIX",
1768 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
Wolfram Sang1e855722009-01-06 14:41:24 -08001769 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07001770
Andy Whitcroftc1ab3322008-10-15 22:02:20 -07001771 if ($realfile =~ m@^include/asm/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001772 ERROR("MODIFIED_INCLUDE_ASM",
1773 "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 -07001774 }
1775 next;
1776 }
1777
Randy Dunlap389834b2007-06-08 13:47:03 -07001778 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001779
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001780 my $hereline = "$here\n$rawline\n";
1781 my $herecurr = "$here\n$rawline\n";
1782 my $hereprev = "$here\n$prevrawline\n$rawline\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001783
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001784 $cnt_lines++ if ($realcnt != 0);
1785
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001786# Check for incorrect file permissions
1787 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1788 my $permhere = $here . "FILE: $realfile\n";
Joe Perches04db4d22013-04-29 16:18:14 -07001789 if ($realfile !~ m@scripts/@ &&
1790 $realfile !~ /\.(py|pl|awk|sh)$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001791 ERROR("EXECUTE_PERMISSIONS",
1792 "do not set execute permissions for source files\n" . $permhere);
Rabin Vincent3bf9a002010-10-26 14:23:16 -07001793 }
1794 }
1795
Joe Perches20112472011-07-25 17:13:23 -07001796# Check the patch for a signoff:
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07001797 if ($line =~ /^\s*signed-off-by:/i) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07001798 $signoff++;
Joe Perches15662b32011-10-31 17:13:12 -07001799 $in_commit_log = 0;
Joe Perches20112472011-07-25 17:13:23 -07001800 }
1801
1802# Check signature styles
Joe Perches270c49a2012-01-10 15:09:50 -08001803 if (!$in_header_lines &&
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001804 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) {
Joe Perches20112472011-07-25 17:13:23 -07001805 my $space_before = $1;
1806 my $sign_off = $2;
1807 my $space_after = $3;
1808 my $email = $4;
1809 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1810
Joe Perchesce0338df3c2012-07-30 14:41:18 -07001811 if ($sign_off !~ /$signature_tags/) {
1812 WARN("BAD_SIGN_OFF",
1813 "Non-standard signature: $sign_off\n" . $herecurr);
1814 }
Joe Perches20112472011-07-25 17:13:23 -07001815 if (defined $space_before && $space_before ne "") {
Joe Perches3705ce52013-07-03 15:05:31 -07001816 if (WARN("BAD_SIGN_OFF",
1817 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) &&
1818 $fix) {
1819 $fixed[$linenr - 1] =
1820 "$ucfirst_sign_off $email";
1821 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001822 }
Joe Perches20112472011-07-25 17:13:23 -07001823 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
Joe Perches3705ce52013-07-03 15:05:31 -07001824 if (WARN("BAD_SIGN_OFF",
1825 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) &&
1826 $fix) {
1827 $fixed[$linenr - 1] =
1828 "$ucfirst_sign_off $email";
1829 }
1830
Joe Perches20112472011-07-25 17:13:23 -07001831 }
1832 if (!defined $space_after || $space_after ne " ") {
Joe Perches3705ce52013-07-03 15:05:31 -07001833 if (WARN("BAD_SIGN_OFF",
1834 "Use a single space after $ucfirst_sign_off\n" . $herecurr) &&
1835 $fix) {
1836 $fixed[$linenr - 1] =
1837 "$ucfirst_sign_off $email";
1838 }
Joe Perches20112472011-07-25 17:13:23 -07001839 }
1840
1841 my ($email_name, $email_address, $comment) = parse_email($email);
1842 my $suggested_email = format_email(($email_name, $email_address));
1843 if ($suggested_email eq "") {
Joe Perches000d1cc12011-07-25 17:13:25 -07001844 ERROR("BAD_SIGN_OFF",
1845 "Unrecognized email address: '$email'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001846 } else {
1847 my $dequoted = $suggested_email;
1848 $dequoted =~ s/^"//;
1849 $dequoted =~ s/" </ </;
1850 # Don't force email to have quotes
1851 # Allow just an angle bracketed address
1852 if ("$dequoted$comment" ne $email &&
1853 "<$email_address>$comment" ne $email &&
1854 "$suggested_email$comment" ne $email) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001855 WARN("BAD_SIGN_OFF",
1856 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
Joe Perches20112472011-07-25 17:13:23 -07001857 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001858 }
Joe Perches7e51f192013-09-11 14:23:57 -07001859
1860# Check for duplicate signatures
1861 my $sig_nospace = $line;
1862 $sig_nospace =~ s/\s//g;
1863 $sig_nospace = lc($sig_nospace);
1864 if (defined $signatures{$sig_nospace}) {
1865 WARN("BAD_SIGN_OFF",
1866 "Duplicate signature\n" . $herecurr);
1867 } else {
1868 $signatures{$sig_nospace} = 1;
1869 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001870 }
1871
Andy Whitcroft00df3442007-06-08 13:47:06 -07001872# Check for wrappage within a valid hunk of the file
Andy Whitcroft8905a672007-11-28 16:21:06 -08001873 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07001874 ERROR("CORRUPTED_PATCH",
1875 "patch seems to be corrupt (line wrapped?)\n" .
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07001876 $herecurr) if (!$emitted_corrupt++);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001877 }
1878
Andy Whitcroft6ecd9672008-10-15 22:02:21 -07001879# Check for absolute kernel paths.
1880 if ($tree) {
1881 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1882 my $file = $1;
1883
1884 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1885 check_absolute_file($1, $herecurr)) {
1886 #
1887 } else {
1888 check_absolute_file($file, $herecurr);
1889 }
1890 }
1891 }
1892
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07001893# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1894 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07001895 $rawline !~ m/^$UTF8*$/) {
1896 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1897
1898 my $blank = copy_spacing($rawline);
1899 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1900 my $hereptr = "$hereline$ptr\n";
1901
Joe Perches34d99212011-07-25 17:13:26 -07001902 CHK("INVALID_UTF8",
1903 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001904 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001905
Joe Perches15662b32011-10-31 17:13:12 -07001906# Check if it's the start of a commit log
1907# (not a header line and we haven't seen the patch filename)
1908 if ($in_header_lines && $realfile =~ /^$/ &&
Joe Perches270c49a2012-01-10 15:09:50 -08001909 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
Joe Perches15662b32011-10-31 17:13:12 -07001910 $in_header_lines = 0;
1911 $in_commit_log = 1;
1912 }
1913
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001914# Check if there is UTF-8 in a commit log when a mail header has explicitly
1915# declined it, i.e defined some charset where it is missing.
1916 if ($in_header_lines &&
1917 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ &&
1918 $1 !~ /utf-8/i) {
1919 $non_utf8_charset = 1;
1920 }
1921
1922 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ &&
Joe Perches15662b32011-10-31 17:13:12 -07001923 $rawline =~ /$NON_ASCII_UTF8/) {
Pasi Savanainenfa64205d2012-10-04 17:13:29 -07001924 WARN("UTF8_BEFORE_PATCH",
Joe Perches15662b32011-10-31 17:13:12 -07001925 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1926 }
1927
Andy Whitcroft306708542008-10-15 22:02:28 -07001928# ignore non-hunk lines and lines being removed
1929 next if (!$hunk_line || $line =~ /^-/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07001930
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001931#trailing whitespace
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07001932 if ($line =~ /^\+.*\015/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001933 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perchesd5e616f2013-09-11 14:23:54 -07001934 if (ERROR("DOS_LINE_ENDINGS",
1935 "DOS line endings\n" . $herevet) &&
1936 $fix) {
1937 $fixed[$linenr - 1] =~ s/[\s\015]+$//;
1938 }
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08001939 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1940 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07001941 if (ERROR("TRAILING_WHITESPACE",
1942 "trailing whitespace\n" . $herevet) &&
1943 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07001944 $fixed[$linenr - 1] =~ s/\s+$//;
Joe Perches3705ce52013-07-03 15:05:31 -07001945 }
1946
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07001947 $rpt_cleaners = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07001948 }
Andy Whitcroft5368df22008-10-15 22:02:27 -07001949
Andi Kleen33549572010-05-24 14:33:29 -07001950# check for Kconfig help text having a real description
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001951# Only applies when adding the entry originally, after that we do not have
1952# sufficient context to determine whether it is indeed long enough.
Andi Kleen33549572010-05-24 14:33:29 -07001953 if ($realfile =~ /Kconfig/ &&
Andy Whitcrofta1385802012-01-10 15:10:03 -08001954 $line =~ /.\s*config\s+/) {
Andi Kleen33549572010-05-24 14:33:29 -07001955 my $length = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001956 my $cnt = $realcnt;
1957 my $ln = $linenr + 1;
1958 my $f;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001959 my $is_start = 0;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001960 my $is_end = 0;
Andy Whitcrofta1385802012-01-10 15:10:03 -08001961 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001962 $f = $lines[$ln - 1];
1963 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1964 $is_end = $lines[$ln - 1] =~ /^\+/;
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001965
1966 next if ($f =~ /^-/);
Andy Whitcrofta1385802012-01-10 15:10:03 -08001967
1968 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1969 $is_start = 1;
1970 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1971 $length = -1;
1972 }
1973
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001974 $f =~ s/^.//;
Andi Kleen33549572010-05-24 14:33:29 -07001975 $f =~ s/#.*//;
1976 $f =~ s/^\s+//;
1977 next if ($f =~ /^$/);
Andy Whitcroft9fe287d72010-10-26 14:23:15 -07001978 if ($f =~ /^\s*config\s/) {
1979 $is_end = 1;
1980 last;
1981 }
Andi Kleen33549572010-05-24 14:33:29 -07001982 $length++;
1983 }
Joe Perches000d1cc12011-07-25 17:13:25 -07001984 WARN("CONFIG_DESCRIPTION",
Andy Whitcrofta1385802012-01-10 15:10:03 -08001985 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1986 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
Andi Kleen33549572010-05-24 14:33:29 -07001987 }
1988
Kees Cook1ba8dfd2012-12-17 16:01:48 -08001989# discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
1990 if ($realfile =~ /Kconfig/ &&
1991 $line =~ /.\s*depends on\s+.*\bEXPERIMENTAL\b/) {
1992 WARN("CONFIG_EXPERIMENTAL",
1993 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
1994 }
1995
Arnaud Lacombec68e5872011-08-15 01:07:14 -04001996 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1997 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1998 my $flag = $1;
1999 my $replacement = {
2000 'EXTRA_AFLAGS' => 'asflags-y',
2001 'EXTRA_CFLAGS' => 'ccflags-y',
2002 'EXTRA_CPPFLAGS' => 'cppflags-y',
2003 'EXTRA_LDFLAGS' => 'ldflags-y',
2004 };
2005
2006 WARN("DEPRECATED_VARIABLE",
2007 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2008 }
2009
Andy Whitcroft5368df22008-10-15 22:02:27 -07002010# check we are in a valid source file if not then ignore this hunk
2011 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
2012
Joe Perches6cd7f382012-12-17 16:01:54 -08002013#line length limit
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002014 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
Andy Whitcroftf4c014c2008-07-23 21:29:01 -07002015 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
Joe Perches0fccc622011-05-24 17:13:41 -07002016 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
Joe Perches8bbea962010-08-09 17:21:01 -07002017 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
Joe Perches6cd7f382012-12-17 16:01:54 -08002018 $length > $max_line_length)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002019 {
Joe Perches000d1cc12011-07-25 17:13:25 -07002020 WARN("LONG_LINE",
Joe Perches6cd7f382012-12-17 16:01:54 -08002021 "line over $max_line_length characters\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002022 }
2023
Josh Triplettca56dc02012-03-23 15:02:21 -07002024# Check for user-visible strings broken across lines, which breaks the ability
2025# to grep for the string. Limited to strings used as parameters (those
2026# following an open parenthesis), which almost completely eliminates false
2027# positives, as well as warning only once per parameter rather than once per
2028# line of the string. Make an exception when the previous string ends in a
2029# newline (multiple lines in one string constant) or \n\t (common in inline
2030# assembly to indent the instruction on the following line).
2031 if ($line =~ /^\+\s*"/ &&
2032 $prevline =~ /"\s*$/ &&
2033 $prevline =~ /\(/ &&
2034 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
2035 WARN("SPLIT_STRING",
2036 "quoted string split across lines\n" . $hereprev);
2037 }
2038
Joe Perches5e79d962010-03-05 13:43:55 -08002039# check for spaces before a quoted newline
2040 if ($rawline =~ /^.*\".*\s\\n/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002041 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
2042 "unnecessary whitespace before a quoted newline\n" . $herecurr) &&
2043 $fix) {
2044 $fixed[$linenr - 1] =~ s/^(\+.*\".*)\s+\\n/$1\\n/;
2045 }
2046
Joe Perches5e79d962010-03-05 13:43:55 -08002047 }
2048
Andy Whitcroft8905a672007-11-28 16:21:06 -08002049# check for adding lines without a newline.
2050 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002051 WARN("MISSING_EOF_NEWLINE",
2052 "adding a line without newline at end of file\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002053 }
2054
Mike Frysinger42e41c52009-09-21 17:04:40 -07002055# Blackfin: use hi/lo macros
2056 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
2057 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
2058 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002059 ERROR("LO_MACRO",
2060 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002061 }
2062 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
2063 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002064 ERROR("HI_MACRO",
2065 "use the HI() macro, not (... >> 16)\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002066 }
2067 }
2068
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002069# check we are in a valid source file C or perl if not then ignore this hunk
2070 next if ($realfile !~ /\.(h|c|pl)$/);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002071
2072# at the beginning of a line any tabs must come first and anything
2073# more than 8 must use tabs.
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002074 if ($rawline =~ /^\+\s* \t\s*\S/ ||
2075 $rawline =~ /^\+\s* \s*/) {
2076 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07002077 $rpt_cleaners = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002078 if (ERROR("CODE_INDENT",
2079 "code indent should use tabs where possible\n" . $herevet) &&
2080 $fix) {
2081 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2082 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002083 }
2084
Alberto Panizzo08e44362010-03-05 13:43:54 -08002085# check for space before tabs.
2086 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
2087 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002088 if (WARN("SPACE_BEFORE_TAB",
2089 "please, no space before tabs\n" . $herevet) &&
2090 $fix) {
2091 $fixed[$linenr - 1] =~
2092 s/(^\+.*) +\t/$1\t/;
2093 }
Alberto Panizzo08e44362010-03-05 13:43:54 -08002094 }
2095
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002096# check for && or || at the start of a line
2097 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
2098 CHK("LOGICAL_CONTINUATIONS",
2099 "Logical continuations should be on the previous line\n" . $hereprev);
2100 }
2101
2102# check multi-line statement indentation matches previous line
2103 if ($^V && $^V ge 5.10.0 &&
2104 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
2105 $prevline =~ /^\+(\t*)(.*)$/;
2106 my $oldindent = $1;
2107 my $rest = $2;
2108
2109 my $pos = pos_last_openparen($rest);
2110 if ($pos >= 0) {
Joe Perchesb34a26f2012-07-30 14:41:16 -07002111 $line =~ /^(\+| )([ \t]*)/;
2112 my $newindent = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002113
2114 my $goodtabindent = $oldindent .
2115 "\t" x ($pos / 8) .
2116 " " x ($pos % 8);
2117 my $goodspaceindent = $oldindent . " " x $pos;
2118
2119 if ($newindent ne $goodtabindent &&
2120 $newindent ne $goodspaceindent) {
Joe Perches3705ce52013-07-03 15:05:31 -07002121
2122 if (CHK("PARENTHESIS_ALIGNMENT",
2123 "Alignment should match open parenthesis\n" . $hereprev) &&
2124 $fix && $line =~ /^\+/) {
2125 $fixed[$linenr - 1] =~
2126 s/^\+[ \t]*/\+$goodtabindent/;
2127 }
Joe Perchesd1fe9c02012-03-23 15:02:16 -07002128 }
2129 }
2130 }
2131
Joe Perches23f780c2013-07-03 15:05:31 -07002132 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+(?!$Assignment|$Arithmetic)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002133 if (CHK("SPACING",
2134 "No space is necessary after a cast\n" . $hereprev) &&
2135 $fix) {
2136 $fixed[$linenr - 1] =~
2137 s/^(\+.*\*[ \t]*\))[ \t]+/$1/;
2138 }
Joe Perchesaad4f612012-03-23 15:02:19 -07002139 }
2140
Joe Perches05880602012-10-04 17:13:35 -07002141 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesfdb4bcd2013-07-03 15:05:23 -07002142 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ &&
2143 $rawline =~ /^\+[ \t]*\*/) {
Joe Perches05880602012-10-04 17:13:35 -07002144 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2145 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev);
2146 }
2147
2148 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesa605e322013-07-03 15:05:24 -07002149 $prevrawline =~ /^\+[ \t]*\/\*/ && #starting /*
2150 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */
Joe Perches61135e92013-09-11 14:23:59 -07002151 $rawline =~ /^\+/ && #line is new
Joe Perchesa605e322013-07-03 15:05:24 -07002152 $rawline !~ /^\+[ \t]*\*/) { #no leading *
2153 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2154 "networking block comments start with * on subsequent lines\n" . $hereprev);
2155 }
2156
2157 if ($realfile =~ m@^(drivers/net/|net/)@ &&
Joe Perchesc24f9f12012-11-08 15:53:29 -08002158 $rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */
2159 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/
2160 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/
2161 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */
Joe Perches05880602012-10-04 17:13:35 -07002162 WARN("NETWORKING_BLOCK_COMMENT_STYLE",
2163 "networking block comments put the trailing */ on a separate line\n" . $herecurr);
2164 }
2165
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002166# check for spaces at the beginning of a line.
Andy Whitcroft6b4c5be2010-10-26 14:23:11 -07002167# Exceptions:
2168# 1) within comments
2169# 2) indented preprocessor commands
2170# 3) hanging labels
Joe Perches3705ce52013-07-03 15:05:31 -07002171 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) {
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002172 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002173 if (WARN("LEADING_SPACE",
2174 "please, no spaces at the start of a line\n" . $herevet) &&
2175 $fix) {
2176 $fixed[$linenr - 1] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e;
2177 }
Raffaele Recalcati5f7ddae2010-08-09 17:20:59 -07002178 }
2179
Andy Whitcroftb9ea10d2008-10-15 22:02:24 -07002180# check we are in a valid C source file if not then ignore this hunk
2181 next if ($realfile !~ /\.(h|c)$/);
2182
Kees Cook1ba8dfd2012-12-17 16:01:48 -08002183# discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2184 if ($line =~ /^\+\s*\#\s*if.*\bCONFIG_EXPERIMENTAL\b/) {
2185 WARN("CONFIG_EXPERIMENTAL",
2186 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2187 }
2188
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002189# check for RCS/CVS revision markers
Andy Whitcroftcf655042008-03-04 14:28:20 -08002190 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002191 WARN("CVS_KEYWORD",
2192 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002193 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07002194
Mike Frysinger42e41c52009-09-21 17:04:40 -07002195# Blackfin: don't use __builtin_bfin_[cs]sync
2196 if ($line =~ /__builtin_bfin_csync/) {
2197 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002198 ERROR("CSYNC",
2199 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002200 }
2201 if ($line =~ /__builtin_bfin_ssync/) {
2202 my $herevet = "$here\n" . cat_vet($line) . "\n";
Joe Perches000d1cc12011-07-25 17:13:25 -07002203 ERROR("SSYNC",
2204 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
Mike Frysinger42e41c52009-09-21 17:04:40 -07002205 }
2206
Joe Perches56e77d72013-02-21 16:44:14 -08002207# check for old HOTPLUG __dev<foo> section markings
2208 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) {
2209 WARN("HOTPLUG_SECTION",
2210 "Using $1 is unnecessary\n" . $herecurr);
2211 }
2212
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002213# Check for potential 'bare' types
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002214 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
2215 $realline_next);
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002216#print "LINE<$line>\n";
2217 if ($linenr >= $suppress_statement &&
Joe Perches1b5539b2013-09-11 14:24:03 -07002218 $realcnt && $sline =~ /.\s*\S/) {
Andy Whitcroft170d3a22008-10-15 22:02:30 -07002219 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07002220 ctx_statement_block($linenr, $realcnt, 0);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002221 $stat =~ s/\n./\n /g;
2222 $cond =~ s/\n./\n /g;
2223
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002224#print "linenr<$linenr> <$stat>\n";
2225 # If this statement has no statement boundaries within
2226 # it there is no point in retrying a statement scan
2227 # until we hit end of it.
2228 my $frag = $stat; $frag =~ s/;+\s*$//;
2229 if ($frag !~ /(?:{|;)/) {
2230#print "skip<$line_nr_next>\n";
2231 $suppress_statement = $line_nr_next;
2232 }
Andy Whitcroftf74bd192012-01-10 15:09:54 -08002233
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002234 # Find the real next line.
2235 $realline_next = $line_nr_next;
2236 if (defined $realline_next &&
2237 (!defined $lines[$realline_next - 1] ||
2238 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
2239 $realline_next++;
2240 }
2241
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002242 my $s = $stat;
2243 $s =~ s/{.*$//s;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002244
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002245 # Ignore goto labels.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002246 if ($s =~ /$Ident:\*$/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002247
2248 # Ignore functions being called
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002249 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002250
Andy Whitcroft463f2862009-09-21 17:04:34 -07002251 } elsif ($s =~ /^.\s*else\b/s) {
2252
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002253 # declarations always start with types
Andy Whitcroftd2506582008-07-23 21:29:09 -07002254 } 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 -07002255 my $type = $1;
2256 $type =~ s/\s+/ /g;
2257 possible($type, "A:" . $s);
2258
Andy Whitcroft8905a672007-11-28 16:21:06 -08002259 # definitions in global scope can only start with types
Andy Whitcrofta6a840622008-10-15 22:02:30 -07002260 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002261 possible($1, "B:" . $s);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002262 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002263
2264 # any (foo ... *) is a pointer cast, and foo is a type
Andy Whitcroft65863862009-01-06 14:41:21 -08002265 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002266 possible($1, "C:" . $s);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002267 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08002268
2269 # Check for any sort of function declaration.
2270 # int foo(something bar, other baz);
2271 # void (*store_gdt)(x86_descr_ptr *);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002272 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 -08002273 my ($name_len) = length($1);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002274
Andy Whitcroftcf655042008-03-04 14:28:20 -08002275 my $ctx = $s;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002276 substr($ctx, 0, $name_len + 1, '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08002277 $ctx =~ s/\)[^\)]*$//;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002278
Andy Whitcroft8905a672007-11-28 16:21:06 -08002279 for my $arg (split(/\s*,\s*/, $ctx)) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002280 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
Andy Whitcroft8905a672007-11-28 16:21:06 -08002281
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002282 possible($1, "D:" . $s);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002283 }
2284 }
2285 }
2286
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002287 }
2288
Andy Whitcroft653d4872007-06-23 17:16:34 -07002289#
2290# Checks which may be anchored in the context.
2291#
2292
2293# Check for switch () and associated case and default
2294# statements should be at the same indent.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002295 if ($line=~/\bswitch\s*\(.*\)/) {
2296 my $err = '';
2297 my $sep = '';
2298 my @ctx = ctx_block_outer($linenr, $realcnt);
2299 shift(@ctx);
2300 for my $ctx (@ctx) {
2301 my ($clen, $cindent) = line_stats($ctx);
2302 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2303 $indent != $cindent) {
2304 $err .= "$sep$ctx\n";
2305 $sep = '';
2306 } else {
2307 $sep = "[...]\n";
2308 }
2309 }
2310 if ($err ne '') {
Joe Perches000d1cc12011-07-25 17:13:25 -07002311 ERROR("SWITCH_CASE_INDENT_LEVEL",
2312 "switch and case should be at the same indent\n$hereline$err");
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002313 }
2314 }
2315
2316# if/while/etc brace do not go on next line, unless defining a do while loop,
2317# or if that brace on the next line is for something else
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002318 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002319 my $pre_ctx = "$1$2";
2320
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002321 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
Joe Perches8eef05d2012-02-03 15:20:39 -08002322
2323 if ($line =~ /^\+\t{6,}/) {
2324 WARN("DEEP_INDENTATION",
2325 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2326 }
2327
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002328 my $ctx_cnt = $realcnt - $#ctx - 1;
2329 my $ctx = join("\n", @ctx);
2330
Andy Whitcroft548596d2008-07-23 21:29:01 -07002331 my $ctx_ln = $linenr;
2332 my $ctx_skip = $realcnt;
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002333
Andy Whitcroft548596d2008-07-23 21:29:01 -07002334 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2335 defined $lines[$ctx_ln - 1] &&
2336 $lines[$ctx_ln - 1] =~ /^-/)) {
2337 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2338 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
Andy Whitcroft773647a2008-03-28 14:15:58 -07002339 $ctx_ln++;
2340 }
Andy Whitcroft548596d2008-07-23 21:29:01 -07002341
Andy Whitcroft53210162008-07-23 21:29:03 -07002342 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2343 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
Andy Whitcroft773647a2008-03-28 14:15:58 -07002344
2345 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002346 ERROR("OPEN_BRACE",
2347 "that open brace { should be on the previous line\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002348 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft00df3442007-06-08 13:47:06 -07002349 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07002350 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2351 $ctx =~ /\)\s*\;\s*$/ &&
2352 defined $lines[$ctx_ln - 1])
2353 {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002354 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2355 if ($nindent > $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002356 WARN("TRAILING_SEMICOLON",
2357 "trailing semicolon indicates no statements, indent implies otherwise\n" .
Andy Whitcroft01464f32010-10-26 14:23:19 -07002358 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002359 }
2360 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002361 }
2362
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002363# Check relative indent for conditionals and blocks.
2364 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08002365 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2366 ctx_statement_block($linenr, $realcnt, 0)
2367 if (!defined $stat);
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002368 my ($s, $c) = ($stat, $cond);
2369
2370 substr($s, 0, length($c), '');
2371
2372 # Make sure we remove the line prefixes as we have
2373 # none on the first line, and are going to readd them
2374 # where necessary.
2375 $s =~ s/\n./\n/gs;
2376
2377 # Find out how long the conditional actually is.
Andy Whitcroft6f779c12008-10-15 22:02:27 -07002378 my @newlines = ($c =~ /\n/gs);
2379 my $cond_lines = 1 + $#newlines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002380
2381 # We want to check the first line inside the block
2382 # starting at the end of the conditional, so remove:
2383 # 1) any blank line termination
2384 # 2) any opening brace { on end of the line
2385 # 3) any do (...) {
2386 my $continuation = 0;
2387 my $check = 0;
2388 $s =~ s/^.*\bdo\b//;
2389 $s =~ s/^\s*{//;
2390 if ($s =~ s/^\s*\\//) {
2391 $continuation = 1;
2392 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002393 if ($s =~ s/^\s*?\n//) {
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002394 $check = 1;
2395 $cond_lines++;
2396 }
2397
2398 # Also ignore a loop construct at the end of a
2399 # preprocessor statement.
2400 if (($prevline =~ /^.\s*#\s*define\s/ ||
2401 $prevline =~ /\\\s*$/) && $continuation == 0) {
2402 $check = 0;
2403 }
2404
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002405 my $cond_ptr = -1;
Andy Whitcroft740504c2008-10-15 22:02:35 -07002406 $continuation = 0;
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002407 while ($cond_ptr != $cond_lines) {
2408 $cond_ptr = $cond_lines;
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002409
Andy Whitcroftf16fa282008-10-15 22:02:32 -07002410 # If we see an #else/#elif then the code
2411 # is not linear.
2412 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2413 $check = 0;
2414 }
2415
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002416 # Ignore:
2417 # 1) blank lines, they should be at 0,
2418 # 2) preprocessor lines, and
2419 # 3) labels.
Andy Whitcroft740504c2008-10-15 22:02:35 -07002420 if ($continuation ||
2421 $s =~ /^\s*?\n/ ||
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002422 $s =~ /^\s*#\s*?/ ||
2423 $s =~ /^\s*$Ident\s*:/) {
Andy Whitcroft740504c2008-10-15 22:02:35 -07002424 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
Andy Whitcroft30dad6e2009-09-21 17:04:36 -07002425 if ($s =~ s/^.*?\n//) {
2426 $cond_lines++;
2427 }
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002428 }
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002429 }
2430
2431 my (undef, $sindent) = line_stats("+" . $s);
2432 my $stat_real = raw_line($linenr, $cond_lines);
2433
2434 # Check if either of these lines are modified, else
2435 # this is not this patch's fault.
2436 if (!defined($stat_real) ||
2437 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2438 $check = 0;
2439 }
2440 if (defined($stat_real) && $cond_lines > 1) {
2441 $stat_real = "[...]\n$stat_real";
2442 }
2443
Andy Whitcroft9bd49ef2008-10-15 22:02:22 -07002444 #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 -07002445
2446 if ($check && (($sindent % 8) != 0 ||
2447 ($sindent <= $indent && $s ne ''))) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002448 WARN("SUSPECT_CODE_INDENT",
2449 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
Andy Whitcroft4d001e42008-10-15 22:02:21 -07002450 }
2451 }
2452
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002453 # Track the 'values' across context and added lines.
2454 my $opline = $line; $opline =~ s/^./ /;
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002455 my ($curr_values, $curr_vars) =
2456 annotate_values($opline . "\n", $prev_values);
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002457 $curr_values = $prev_values . $curr_values;
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002458 if ($dbg_values) {
2459 my $outline = $opline; $outline =~ s/\t/ /g;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002460 print "$linenr > .$outline\n";
2461 print "$linenr > $curr_values\n";
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002462 print "$linenr > $curr_vars\n";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002463 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002464 $prev_values = substr($curr_values, -1);
2465
Andy Whitcroft00df3442007-06-08 13:47:06 -07002466#ignore lines not being added
Joe Perches3705ce52013-07-03 15:05:31 -07002467 next if ($line =~ /^[^\+]/);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002468
Andy Whitcroft653d4872007-06-23 17:16:34 -07002469# TEST: allow direct testing of the type matcher.
Andy Whitcroft7429c692008-07-23 21:29:06 -07002470 if ($dbg_type) {
2471 if ($line =~ /^.\s*$Declare\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002472 ERROR("TEST_TYPE",
2473 "TEST: is type\n" . $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002474 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002475 ERROR("TEST_NOT_TYPE",
2476 "TEST: is not type ($1 is)\n". $herecurr);
Andy Whitcroft7429c692008-07-23 21:29:06 -07002477 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002478 next;
2479 }
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002480# TEST: allow direct testing of the attribute matcher.
2481 if ($dbg_attr) {
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002482 if ($line =~ /^.\s*$Modifier\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002483 ERROR("TEST_ATTR",
2484 "TEST: is attr\n" . $herecurr);
Andy Whitcroft9360b0e2009-02-27 14:03:08 -08002485 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002486 ERROR("TEST_NOT_ATTR",
2487 "TEST: is not attr ($1 is)\n". $herecurr);
Andy Whitcrofta1ef2772008-10-15 22:02:17 -07002488 }
2489 next;
2490 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002491
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002492# check for initialisation to aggregates open brace on the next line
Andy Whitcroft99423c22009-10-26 16:50:15 -07002493 if ($line =~ /^.\s*{/ &&
2494 $prevline =~ /(?:^|[^=])=\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002495 ERROR("OPEN_BRACE",
2496 "that open brace { should be on the previous line\n" . $hereprev);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002497 }
2498
Andy Whitcroft653d4872007-06-23 17:16:34 -07002499#
2500# Checks which are anchored on the added line.
2501#
2502
2503# check for malformed paths in #include statements (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002504 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
Andy Whitcroft653d4872007-06-23 17:16:34 -07002505 my $path = $1;
2506 if ($path =~ m{//}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002507 ERROR("MALFORMED_INCLUDE",
Joe Perches495e9d82012-12-20 15:05:37 -08002508 "malformed #include filename\n" . $herecurr);
2509 }
2510 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) {
2511 ERROR("UAPI_INCLUDE",
2512 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002513 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002514 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002515
2516# no C99 // comments
2517 if ($line =~ m{//}) {
Joe Perches3705ce52013-07-03 15:05:31 -07002518 if (ERROR("C99_COMMENTS",
2519 "do not use C99 // comments\n" . $herecurr) &&
2520 $fix) {
2521 my $line = $fixed[$linenr - 1];
2522 if ($line =~ /\/\/(.*)$/) {
2523 my $comment = trim($1);
2524 $fixed[$linenr - 1] =~ s@\/\/(.*)$@/\* $comment \*/@;
2525 }
2526 }
Andy Whitcroft00df3442007-06-08 13:47:06 -07002527 }
2528 # Remove C99 comments.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002529 $line =~ s@//.*@@;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002530 $opline =~ s@//.*@@;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002531
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002532# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2533# the whole statement.
2534#print "APW <$lines[$realline_next - 1]>\n";
2535 if (defined $realline_next &&
2536 exists $lines[$realline_next - 1] &&
2537 !defined $suppress_export{$realline_next} &&
2538 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2539 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002540 # Handle definitions which produce identifiers with
2541 # a prefix:
2542 # XXX(foo);
2543 # EXPORT_SYMBOL(something_foo);
Andy Whitcroft653d4872007-06-23 17:16:34 -07002544 my $name = $1;
Andy Whitcroft87a53872012-01-10 15:10:04 -08002545 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
Andy Whitcroft3cbf62d2010-10-26 14:23:18 -07002546 $name =~ /^${Ident}_$2/) {
2547#print "FOO C name<$name>\n";
2548 $suppress_export{$realline_next} = 1;
2549
2550 } elsif ($stat !~ /(?:
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002551 \n.}\s*$|
Andy Whitcroft48012052008-10-15 22:02:34 -07002552 ^.DEFINE_$Ident\(\Q$name\E\)|
2553 ^.DECLARE_$Ident\(\Q$name\E\)|
2554 ^.LIST_HEAD\(\Q$name\E\)|
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002555 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2556 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
Andy Whitcroft48012052008-10-15 22:02:34 -07002557 )/x) {
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002558#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2559 $suppress_export{$realline_next} = 2;
2560 } else {
2561 $suppress_export{$realline_next} = 1;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002562 }
2563 }
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002564 if (!defined $suppress_export{$linenr} &&
2565 $prevline =~ /^.\s*$/ &&
2566 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2567 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2568#print "FOO B <$lines[$linenr - 1]>\n";
2569 $suppress_export{$linenr} = 2;
2570 }
2571 if (defined $suppress_export{$linenr} &&
2572 $suppress_export{$linenr} == 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002573 WARN("EXPORT_SYMBOL",
2574 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
Andy Whitcroft2b474a12009-10-26 16:50:16 -07002575 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002576
Joe Eloff5150bda2010-08-09 17:21:00 -07002577# check for global initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002578 if ($line =~ /^\+(\s*$Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/) {
2579 if (ERROR("GLOBAL_INITIALISERS",
2580 "do not initialise globals to 0 or NULL\n" .
2581 $herecurr) &&
2582 $fix) {
2583 $fixed[$linenr - 1] =~ s/($Type\s*$Ident\s*(?:\s+$Modifier))*\s*=\s*(0|NULL|false)\s*;/$1;/;
2584 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002585 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002586# check for static initialisers.
Joe Perchesd5e616f2013-09-11 14:23:54 -07002587 if ($line =~ /^\+.*\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2588 if (ERROR("INITIALISED_STATIC",
2589 "do not initialise statics to 0 or NULL\n" .
2590 $herecurr) &&
2591 $fix) {
2592 $fixed[$linenr - 1] =~ s/(\bstatic\s.*?)\s*=\s*(0|NULL|false)\s*;/$1;/;
2593 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002594 }
2595
Joe Perchescb710ec2010-10-26 14:23:20 -07002596# check for static const char * arrays.
2597 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002598 WARN("STATIC_CONST_CHAR_ARRAY",
2599 "static const char * array should probably be static const char * const\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002600 $herecurr);
2601 }
2602
2603# check for static char foo[] = "bar" declarations.
2604 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002605 WARN("STATIC_CONST_CHAR_ARRAY",
2606 "static char array declaration should probably be static const char\n" .
Joe Perchescb710ec2010-10-26 14:23:20 -07002607 $herecurr);
2608 }
2609
Joe Perches93ed0e22010-10-26 14:23:21 -07002610# check for declarations of struct pci_device_id
2611 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002612 WARN("DEFINE_PCI_DEVICE_TABLE",
2613 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
Joe Perches93ed0e22010-10-26 14:23:21 -07002614 }
2615
Andy Whitcroft653d4872007-06-23 17:16:34 -07002616# check for new typedefs, only function parameters and sparse annotations
2617# make sense.
2618 if ($line =~ /\btypedef\s/ &&
Andy Whitcroft80545762009-01-06 14:41:26 -08002619 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002620 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
Andy Whitcroft8ed22ca2008-10-15 22:02:32 -07002621 $line !~ /\b$typeTypedefs\b/ &&
Andy Whitcroft653d4872007-06-23 17:16:34 -07002622 $line !~ /\b__bitwise(?:__|)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002623 WARN("NEW_TYPEDEFS",
2624 "do not add new typedefs\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002625 }
2626
2627# * goes on variable not on type
Andy Whitcroft65863862009-01-06 14:41:21 -08002628 # (char*[ const])
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002629 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2630 #print "AA<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002631 my ($ident, $from, $to) = ($1, $2, $2);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002632
Andy Whitcroft65863862009-01-06 14:41:21 -08002633 # Should start with a space.
2634 $to =~ s/^(\S)/ $1/;
2635 # Should not end with a space.
2636 $to =~ s/\s+$//;
2637 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002638 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002639 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002640
Joe Perches3705ce52013-07-03 15:05:31 -07002641## print "1: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft65863862009-01-06 14:41:21 -08002642 if ($from ne $to) {
Joe Perches3705ce52013-07-03 15:05:31 -07002643 if (ERROR("POINTER_LOCATION",
2644 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) &&
2645 $fix) {
2646 my $sub_from = $ident;
2647 my $sub_to = $ident;
2648 $sub_to =~ s/\Q$from\E/$to/;
2649 $fixed[$linenr - 1] =~
2650 s@\Q$sub_from\E@$sub_to@;
2651 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002652 }
Andy Whitcroftbfcb2cc2012-01-10 15:10:15 -08002653 }
2654 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2655 #print "BB<$1>\n";
Joe Perches3705ce52013-07-03 15:05:31 -07002656 my ($match, $from, $to, $ident) = ($1, $2, $2, $3);
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002657
Andy Whitcroft65863862009-01-06 14:41:21 -08002658 # Should start with a space.
2659 $to =~ s/^(\S)/ $1/;
2660 # Should not end with a space.
2661 $to =~ s/\s+$//;
2662 # '*'s should not have spaces between.
Andy Whitcroftf9a0b3d2009-01-15 13:51:05 -08002663 while ($to =~ s/\*\s+\*/\*\*/) {
Andy Whitcroft65863862009-01-06 14:41:21 -08002664 }
2665 # Modifiers should have spaces.
2666 $to =~ s/(\b$Modifier$)/$1 /;
2667
Joe Perches3705ce52013-07-03 15:05:31 -07002668## print "2: from<$from> to<$to> ident<$ident>\n";
Andy Whitcroft667026e2009-02-27 14:03:08 -08002669 if ($from ne $to && $ident !~ /^$Modifier$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002670 if (ERROR("POINTER_LOCATION",
2671 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) &&
2672 $fix) {
2673
2674 my $sub_from = $match;
2675 my $sub_to = $match;
2676 $sub_to =~ s/\Q$from\E/$to/;
2677 $fixed[$linenr - 1] =~
2678 s@\Q$sub_from\E@$sub_to@;
2679 }
Andy Whitcroft65863862009-01-06 14:41:21 -08002680 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002681 }
2682
2683# # no BUG() or BUG_ON()
2684# if ($line =~ /\b(BUG|BUG_ON)\b/) {
2685# print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2686# print "$herecurr";
2687# $clean = 0;
2688# }
2689
Andy Whitcroft8905a672007-11-28 16:21:06 -08002690 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002691 WARN("LINUX_VERSION_CODE",
2692 "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 -08002693 }
2694
Joe Perches17441222011-06-15 15:08:17 -07002695# check for uses of printk_ratelimit
2696 if ($line =~ /\bprintk_ratelimit\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002697 WARN("PRINTK_RATELIMITED",
2698"Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
Joe Perches17441222011-06-15 15:08:17 -07002699 }
2700
Andy Whitcroft00df3442007-06-08 13:47:06 -07002701# printk should use KERN_* levels. Note that follow on printk's on the
2702# same line do not need a level, so we use the current block context
2703# to try and find and validate the current printk. In summary the current
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002704# printk includes all preceding printk's which have no newline on the end.
Andy Whitcroft00df3442007-06-08 13:47:06 -07002705# we assume the first bad printk is the one to report.
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002706 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07002707 my $ok = 0;
2708 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2709 #print "CHECK<$lines[$ln - 1]\n";
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002710 # we have a preceding printk if it ends
Andy Whitcroft00df3442007-06-08 13:47:06 -07002711 # with "\n" ignore it, else it is to blame
2712 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2713 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2714 $ok = 1;
2715 }
2716 last;
2717 }
2718 }
2719 if ($ok == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002720 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2721 "printk() should include KERN_ facility level\n" . $herecurr);
Andy Whitcroft00df3442007-06-08 13:47:06 -07002722 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002723 }
2724
Joe Perches243f3802012-05-31 16:26:09 -07002725 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2726 my $orig = $1;
2727 my $level = lc($orig);
2728 $level = "warn" if ($level eq "warning");
Joe Perches8f26b832012-10-04 17:13:32 -07002729 my $level2 = $level;
2730 $level2 = "dbg" if ($level eq "debug");
Joe Perches243f3802012-05-31 16:26:09 -07002731 WARN("PREFER_PR_LEVEL",
Joe Perches8f26b832012-10-04 17:13:32 -07002732 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
Joe Perches243f3802012-05-31 16:26:09 -07002733 }
2734
2735 if ($line =~ /\bpr_warning\s*\(/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07002736 if (WARN("PREFER_PR_LEVEL",
2737 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr) &&
2738 $fix) {
2739 $fixed[$linenr - 1] =~
2740 s/\bpr_warning\b/pr_warn/;
2741 }
Joe Perches243f3802012-05-31 16:26:09 -07002742 }
2743
Joe Perchesdc139312013-02-21 16:44:13 -08002744 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) {
2745 my $orig = $1;
2746 my $level = lc($orig);
2747 $level = "warn" if ($level eq "warning");
2748 $level = "dbg" if ($level eq "debug");
2749 WARN("PREFER_DEV_LEVEL",
2750 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr);
2751 }
2752
Andy Whitcroft653d4872007-06-23 17:16:34 -07002753# function brace can't be on same line, except for #defines of do while,
2754# or if closed on same line
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002755 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2756 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002757 ERROR("OPEN_BRACE",
2758 "open brace '{' following function declarations go on the next line\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002759 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07002760
Andy Whitcroft8905a672007-11-28 16:21:06 -08002761# open braces for enum, union and struct go on the same line.
2762 if ($line =~ /^.\s*{/ &&
2763 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07002764 ERROR("OPEN_BRACE",
2765 "open brace '{' following $1 go on the same line\n" . $hereprev);
Andy Whitcroft8905a672007-11-28 16:21:06 -08002766 }
2767
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002768# missing space after union, struct or enum definition
Joe Perches3705ce52013-07-03 15:05:31 -07002769 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) {
2770 if (WARN("SPACING",
2771 "missing space after $1 definition\n" . $herecurr) &&
2772 $fix) {
2773 $fixed[$linenr - 1] =~
2774 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/;
2775 }
Andy Whitcroft0c73b4e2010-10-26 14:23:15 -07002776 }
2777
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002778# check for spacing round square brackets; allowed:
2779# 1. with a type on the left -- int [] a;
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002780# 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2781# 3. inside a curly brace -- = { [0...10] = 5 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002782 while ($line =~ /(.*?\s)\[/g) {
2783 my ($where, $prefix) = ($-[1], $1);
2784 if ($prefix !~ /$Type\s+$/ &&
Andy Whitcroftfe2a7db2008-10-15 22:02:15 -07002785 ($where != 0 || $prefix !~ /^.\s+$/) &&
Andy Whitcroftdaebc532012-03-23 15:02:17 -07002786 $prefix !~ /[{,]\s+$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002787 if (ERROR("BRACKET_SPACE",
2788 "space prohibited before open square bracket '['\n" . $herecurr) &&
2789 $fix) {
2790 $fixed[$linenr - 1] =~
2791 s/^(\+.*?)\s+\[/$1\[/;
2792 }
Andy Whitcroft8d31cfc2008-07-23 21:29:02 -07002793 }
2794 }
2795
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002796# check for spaces between functions and their parentheses.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002797 while ($line =~ /($Ident)\s+\(/g) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002798 my $name = $1;
Andy Whitcroft773647a2008-03-28 14:15:58 -07002799 my $ctx_before = substr($line, 0, $-[1]);
2800 my $ctx = "$ctx_before$name";
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002801
2802 # Ignore those directives where spaces _are_ permitted.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002803 if ($name =~ /^(?:
2804 if|for|while|switch|return|case|
2805 volatile|__volatile__|
2806 __attribute__|format|__extension__|
2807 asm|__asm__)$/x)
2808 {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002809 # cpp #define statements have non-optional spaces, ie
2810 # if there is a space between the name and the open
2811 # parenthesis it is simply not a parameter group.
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002812 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002813
2814 # cpp #elif statement condition may start with a (
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07002815 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002816
2817 # If this whole things ends with a type its most
2818 # likely a typedef for a function.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002819 } elsif ($ctx =~ /$Type$/) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08002820
2821 } else {
Joe Perches3705ce52013-07-03 15:05:31 -07002822 if (WARN("SPACING",
2823 "space prohibited between function name and open parenthesis '('\n" . $herecurr) &&
2824 $fix) {
2825 $fixed[$linenr - 1] =~
2826 s/\b$name\s+\(/$name\(/;
2827 }
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002828 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07002829 }
Eric Nelson9a4cad42012-05-31 16:26:09 -07002830
Andy Whitcroft653d4872007-06-23 17:16:34 -07002831# Check operator spacing.
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002832 if (!($line=~/\#\s*include/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07002833 my $fixed_line = "";
2834 my $line_fixed = 0;
2835
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002836 my $ops = qr{
2837 <<=|>>=|<=|>=|==|!=|
2838 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2839 =>|->|<<|>>|<|>|=|!|~|
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002840 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2841 \?|:
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002842 }x;
Andy Whitcroftcf655042008-03-04 14:28:20 -08002843 my @elements = split(/($ops|;)/, $opline);
Joe Perches3705ce52013-07-03 15:05:31 -07002844
2845## print("element count: <" . $#elements . ">\n");
2846## foreach my $el (@elements) {
2847## print("el: <$el>\n");
2848## }
2849
2850 my @fix_elements = ();
Andy Whitcroft00df3442007-06-08 13:47:06 -07002851 my $off = 0;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002852
Joe Perches3705ce52013-07-03 15:05:31 -07002853 foreach my $el (@elements) {
2854 push(@fix_elements, substr($rawline, $off, length($el)));
2855 $off += length($el);
2856 }
2857
2858 $off = 0;
2859
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002860 my $blank = copy_spacing($opline);
Joe Perchesb34c6482013-09-11 14:24:01 -07002861 my $last_after = -1;
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002862
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002863 for (my $n = 0; $n < $#elements; $n += 2) {
Joe Perches3705ce52013-07-03 15:05:31 -07002864
2865 my $good = $fix_elements[$n] . $fix_elements[$n + 1];
2866
2867## print("n: <$n> good: <$good>\n");
2868
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002869 $off += length($elements[$n]);
2870
Lucas De Marchi25985ed2011-03-30 22:57:33 -03002871 # Pick up the preceding and succeeding characters.
Andy Whitcroft773647a2008-03-28 14:15:58 -07002872 my $ca = substr($opline, 0, $off);
2873 my $cc = '';
2874 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2875 $cc = substr($opline, $off + length($elements[$n + 1]));
2876 }
2877 my $cb = "$ca$;$cc";
2878
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002879 my $a = '';
2880 $a = 'V' if ($elements[$n] ne '');
2881 $a = 'W' if ($elements[$n] =~ /\s$/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002882 $a = 'C' if ($elements[$n] =~ /$;$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002883 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2884 $a = 'O' if ($elements[$n] eq '');
Andy Whitcroft773647a2008-03-28 14:15:58 -07002885 $a = 'E' if ($ca =~ /^\s*$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002886
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002887 my $op = $elements[$n + 1];
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002888
2889 my $c = '';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002890 if (defined $elements[$n + 2]) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002891 $c = 'V' if ($elements[$n + 2] ne '');
2892 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
Andy Whitcroftcf655042008-03-04 14:28:20 -08002893 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002894 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2895 $c = 'O' if ($elements[$n + 2] eq '');
Andy Whitcroft8b1b3372009-01-06 14:41:27 -08002896 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002897 } else {
2898 $c = 'E';
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002899 }
2900
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002901 my $ctx = "${a}x${c}";
2902
2903 my $at = "(ctx:$ctx)";
2904
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002905 my $ptr = substr($blank, 0, $off) . "^";
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07002906 my $hereptr = "$hereline$ptr\n";
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002907
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002908 # Pull out the value of this operator.
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07002909 my $op_type = substr($curr_values, $off + 1, 1);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002910
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002911 # Get the full operator variant.
2912 my $opv = $op . substr($curr_vars, $off, 1);
2913
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002914 # Ignore operators passed as parameters.
2915 if ($op_type ne 'V' &&
2916 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2917
Andy Whitcroftcf655042008-03-04 14:28:20 -08002918# # Ignore comments
2919# } elsif ($op =~ /^$;+$/) {
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002920
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002921 # ; should have either the end of line or a space or \ after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08002922 } elsif ($op eq ';') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002923 if ($ctx !~ /.x[WEBC]/ &&
2924 $cc !~ /^\\/ && $cc !~ /^;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002925 if (ERROR("SPACING",
2926 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07002927 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07002928 $line_fixed = 1;
2929 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07002930 }
2931
2932 # // is a comment
2933 } elsif ($op eq '//') {
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002934
Andy Whitcroft1f65f942008-07-23 21:29:10 -07002935 # No spaces for:
2936 # ->
2937 # : when part of a bitfield
2938 } elsif ($op eq '->' || $opv eq ':B') {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07002939 if ($ctx =~ /Wx.|.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002940 if (ERROR("SPACING",
2941 "spaces prohibited around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07002942 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07002943 if (defined $fix_elements[$n + 2]) {
2944 $fix_elements[$n + 2] =~ s/^\s+//;
2945 }
Joe Perchesb34c6482013-09-11 14:24:01 -07002946 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002947 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002948 }
2949
2950 # , must have a space on the right.
2951 } elsif ($op eq ',') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002952 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002953 if (ERROR("SPACING",
2954 "space required after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07002955 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07002956 $line_fixed = 1;
Joe Perchesb34c6482013-09-11 14:24:01 -07002957 $last_after = $n;
Joe Perches3705ce52013-07-03 15:05:31 -07002958 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002959 }
2960
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002961 # '*' as part of a type definition -- reported already.
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002962 } elsif ($opv eq '*_') {
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07002963 #warn "'*' is part of type\n";
2964
2965 # unary operators should have a space before and
2966 # none after. May be left adjacent to another
2967 # unary operator, or a cast
2968 } elsif ($op eq '!' || $op eq '~' ||
Andy Whitcroft74048ed2008-07-23 21:29:10 -07002969 $opv eq '*U' || $opv eq '-U' ||
Andy Whitcroft0d413862008-10-15 22:02:16 -07002970 $opv eq '&U' || $opv eq '&&U') {
Andy Whitcroftcf655042008-03-04 14:28:20 -08002971 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002972 if (ERROR("SPACING",
2973 "space required before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07002974 if ($n != $last_after + 2) {
2975 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]);
2976 $line_fixed = 1;
2977 }
Joe Perches3705ce52013-07-03 15:05:31 -07002978 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002979 }
Andy Whitcrofta3340b32009-02-27 14:03:07 -08002980 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07002981 # A unary '*' may be const
2982
2983 } elsif ($ctx =~ /.xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002984 if (ERROR("SPACING",
2985 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07002986 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07002987 if (defined $fix_elements[$n + 2]) {
2988 $fix_elements[$n + 2] =~ s/^\s+//;
2989 }
Joe Perchesb34c6482013-09-11 14:24:01 -07002990 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07002991 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07002992 }
2993
2994 # unary ++ and unary -- are allowed no space on one side.
2995 } elsif ($op eq '++' or $op eq '--') {
Andy Whitcroft773647a2008-03-28 14:15:58 -07002996 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07002997 if (ERROR("SPACING",
2998 "space required one side of that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07002999 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " ";
Joe Perches3705ce52013-07-03 15:05:31 -07003000 $line_fixed = 1;
3001 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003002 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003003 if ($ctx =~ /Wx[BE]/ ||
3004 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003005 if (ERROR("SPACING",
3006 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003007 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003008 $line_fixed = 1;
3009 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003010 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003011 if ($ctx =~ /ExW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003012 if (ERROR("SPACING",
3013 "space prohibited after that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003014 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003015 if (defined $fix_elements[$n + 2]) {
3016 $fix_elements[$n + 2] =~ s/^\s+//;
3017 }
Joe Perchesb34c6482013-09-11 14:24:01 -07003018 $line_fixed = 1;
Joe Perches3705ce52013-07-03 15:05:31 -07003019 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003020 }
3021
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003022 # << and >> may either have or not have spaces both sides
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003023 } elsif ($op eq '<<' or $op eq '>>' or
3024 $op eq '&' or $op eq '^' or $op eq '|' or
3025 $op eq '+' or $op eq '-' or
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003026 $op eq '*' or $op eq '/' or
3027 $op eq '%')
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003028 {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003029 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003030 if (ERROR("SPACING",
3031 "need consistent spacing around '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003032 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3033 if (defined $fix_elements[$n + 2]) {
3034 $fix_elements[$n + 2] =~ s/^\s+//;
3035 }
Joe Perches3705ce52013-07-03 15:05:31 -07003036 $line_fixed = 1;
3037 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003038 }
3039
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003040 # A colon needs no spaces before when it is
3041 # terminating a case value or a label.
3042 } elsif ($opv eq ':C' || $opv eq ':L') {
3043 if ($ctx =~ /Wx./) {
Joe Perches3705ce52013-07-03 15:05:31 -07003044 if (ERROR("SPACING",
3045 "space prohibited before that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003046 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003047 $line_fixed = 1;
3048 }
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003049 }
3050
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003051 # All the others need spaces both sides.
Andy Whitcroftcf655042008-03-04 14:28:20 -08003052 } elsif ($ctx !~ /[EWC]x[CWE]/) {
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003053 my $ok = 0;
3054
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003055 # Ignore email addresses <foo@bar>
Andy Whitcroft1f65f942008-07-23 21:29:10 -07003056 if (($op eq '<' &&
3057 $cc =~ /^\S+\@\S+>/) ||
3058 ($op eq '>' &&
3059 $ca =~ /<\S+\@\S+$/))
3060 {
3061 $ok = 1;
3062 }
3063
3064 # Ignore ?:
3065 if (($opv eq ':O' && $ca =~ /\?$/) ||
3066 ($op eq '?' && $cc =~ /^:/)) {
3067 $ok = 1;
3068 }
3069
3070 if ($ok == 0) {
Joe Perches3705ce52013-07-03 15:05:31 -07003071 if (ERROR("SPACING",
3072 "spaces required around that '$op' $at\n" . $hereptr)) {
Joe Perchesb34c6482013-09-11 14:24:01 -07003073 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " ";
3074 if (defined $fix_elements[$n + 2]) {
3075 $fix_elements[$n + 2] =~ s/^\s+//;
3076 }
Joe Perches3705ce52013-07-03 15:05:31 -07003077 $line_fixed = 1;
3078 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003079 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003080 }
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003081 $off += length($elements[$n + 1]);
Joe Perches3705ce52013-07-03 15:05:31 -07003082
3083## print("n: <$n> GOOD: <$good>\n");
3084
3085 $fixed_line = $fixed_line . $good;
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003086 }
Joe Perches3705ce52013-07-03 15:05:31 -07003087
3088 if (($#elements % 2) == 0) {
3089 $fixed_line = $fixed_line . $fix_elements[$#elements];
3090 }
3091
3092 if ($fix && $line_fixed && $fixed_line ne $fixed[$linenr - 1]) {
3093 $fixed[$linenr - 1] = $fixed_line;
3094 }
3095
3096
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003097 }
3098
Joe Perches786b6322013-07-03 15:05:32 -07003099# check for whitespace before a non-naked semicolon
3100 if ($line =~ /^\+.*\S\s+;/) {
3101 if (WARN("SPACING",
3102 "space prohibited before semicolon\n" . $herecurr) &&
3103 $fix) {
3104 1 while $fixed[$linenr - 1] =~
3105 s/^(\+.*\S)\s+;/$1;/;
3106 }
3107 }
3108
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003109# check for multiple assignments
3110 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003111 CHK("MULTIPLE_ASSIGNMENTS",
3112 "multiple assignments should be avoided\n" . $herecurr);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003113 }
3114
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003115## # check for multiple declarations, allowing for a function declaration
3116## # continuation.
3117## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3118## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3119##
3120## # Remove any bracketed sections to ensure we do not
3121## # falsly report the parameters of functions.
3122## my $ln = $line;
3123## while ($ln =~ s/\([^\(\)]*\)//g) {
3124## }
3125## if ($ln =~ /,/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003126## WARN("MULTIPLE_DECLARATION",
3127## "declaring multiple variables together should be avoided\n" . $herecurr);
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003128## }
3129## }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003130
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003131#need space before brace following if, while, etc
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003132 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
3133 $line =~ /do{/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003134 if (ERROR("SPACING",
3135 "space required before the open brace '{'\n" . $herecurr) &&
3136 $fix) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003137 $fixed[$linenr - 1] =~ s/^(\+.*(?:do|\))){/$1 {/;
Joe Perches3705ce52013-07-03 15:05:31 -07003138 }
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003139 }
3140
Joe Perchesc4a62ef2013-07-03 15:05:28 -07003141## # check for blank lines before declarations
3142## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3143## $prevrawline =~ /^.\s*$/) {
3144## WARN("SPACING",
3145## "No blank lines before declarations\n" . $hereprev);
3146## }
3147##
3148
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003149# closing brace should have a space following it when it has anything
3150# on the line
3151 if ($line =~ /}(?!(?:,|;|\)))\S/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003152 if (ERROR("SPACING",
3153 "space required after that close brace '}'\n" . $herecurr) &&
3154 $fix) {
3155 $fixed[$linenr - 1] =~
3156 s/}((?!(?:,|;|\)))\S)/} $1/;
3157 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003158 }
3159
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003160# check spacing on square brackets
3161 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003162 if (ERROR("SPACING",
3163 "space prohibited after that open square bracket '['\n" . $herecurr) &&
3164 $fix) {
3165 $fixed[$linenr - 1] =~
3166 s/\[\s+/\[/;
3167 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003168 }
3169 if ($line =~ /\s\]/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003170 if (ERROR("SPACING",
3171 "space prohibited before that close square bracket ']'\n" . $herecurr) &&
3172 $fix) {
3173 $fixed[$linenr - 1] =~
3174 s/\s+\]/\]/;
3175 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003176 }
3177
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003178# check spacing on parentheses
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003179 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
3180 $line !~ /for\s*\(\s+;/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003181 if (ERROR("SPACING",
3182 "space prohibited after that open parenthesis '('\n" . $herecurr) &&
3183 $fix) {
3184 $fixed[$linenr - 1] =~
3185 s/\(\s+/\(/;
3186 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003187 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003188 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003189 $line !~ /for\s*\(.*;\s+\)/ &&
3190 $line !~ /:\s+\)/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003191 if (ERROR("SPACING",
3192 "space prohibited before that close parenthesis ')'\n" . $herecurr) &&
3193 $fix) {
3194 $fixed[$linenr - 1] =~
3195 s/\s+\)/\)/;
3196 }
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003197 }
3198
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003199#goto labels aren't indented, allow a single space however
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003200 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003201 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
Joe Perches3705ce52013-07-03 15:05:31 -07003202 if (WARN("INDENTED_LABEL",
3203 "labels should not be indented\n" . $herecurr) &&
3204 $fix) {
3205 $fixed[$linenr - 1] =~
3206 s/^(.)\s+/$1/;
3207 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003208 }
3209
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003210# Return is not a function.
3211 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
3212 my $spacing = $1;
3213 my $value = $2;
3214
Andy Whitcroft86f9d052009-01-06 14:41:24 -08003215 # Flatten any parentheses
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07003216 $value =~ s/\(/ \(/g;
3217 $value =~ s/\)/\) /g;
Andy Whitcrofte01886a2012-01-10 15:10:08 -08003218 while ($value =~ s/\[[^\[\]]*\]/1/ ||
Andy Whitcroft63f17f82009-01-15 13:51:06 -08003219 $value !~ /(?:$Ident|-?$Constant)\s*
3220 $Compare\s*
3221 (?:$Ident|-?$Constant)/x &&
3222 $value =~ s/\([^\(\)]*\)/1/) {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003223 }
Andy Whitcroftfb2d2c12010-10-26 14:23:12 -07003224#print "value<$value>\n";
3225 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003226 ERROR("RETURN_PARENTHESES",
3227 "return is not a function, parentheses are not required\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003228
3229 } elsif ($spacing !~ /\s+/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003230 ERROR("SPACING",
3231 "space required before the open parenthesis '('\n" . $herecurr);
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003232 }
3233 }
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003234# Return of what appears to be an errno should normally be -'ve
3235 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
3236 my $name = $1;
3237 if ($name ne 'EOF' && $name ne 'ERROR') {
Joe Perches000d1cc12011-07-25 17:13:25 -07003238 WARN("USE_NEGATIVE_ERRNO",
3239 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
Andy Whitcroft53a3c442010-10-26 14:23:14 -07003240 }
3241 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003242
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003243# Need a space before open parenthesis after if, while etc
Joe Perches3705ce52013-07-03 15:05:31 -07003244 if ($line =~ /\b(if|while|for|switch)\(/) {
3245 if (ERROR("SPACING",
3246 "space required before the open parenthesis '('\n" . $herecurr) &&
3247 $fix) {
3248 $fixed[$linenr - 1] =~
3249 s/\b(if|while|for|switch)\(/$1 \(/;
3250 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003251 }
3252
Andy Whitcroftf5fe35d2008-07-23 21:29:03 -07003253# Check for illegal assignment in if conditional -- and check for trailing
3254# statements after the conditional.
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003255 if ($line =~ /do\s*(?!{)/) {
Andy Whitcroft3e469cd2012-01-10 15:10:01 -08003256 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
3257 ctx_statement_block($linenr, $realcnt, 0)
3258 if (!defined $stat);
Andy Whitcroft170d3a22008-10-15 22:02:30 -07003259 my ($stat_next) = ctx_statement_block($line_nr_next,
3260 $remain_next, $off_next);
3261 $stat_next =~ s/\n./\n /g;
3262 ##print "stat<$stat> stat_next<$stat_next>\n";
3263
3264 if ($stat_next =~ /^\s*while\b/) {
3265 # If the statement carries leading newlines,
3266 # then count those as offsets.
3267 my ($whitespace) =
3268 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
3269 my $offset =
3270 statement_rawlines($whitespace) - 1;
3271
3272 $suppress_whiletrailers{$line_nr_next +
3273 $offset} = 1;
3274 }
3275 }
3276 if (!defined $suppress_whiletrailers{$linenr} &&
3277 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003278 my ($s, $c) = ($stat, $cond);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003279
Andy Whitcroftb53c8e12009-01-06 14:41:29 -08003280 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003281 ERROR("ASSIGN_IN_IF",
3282 "do not use assignment in if condition\n" . $herecurr);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003283 }
3284
3285 # Find out what is on the end of the line after the
3286 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003287 substr($s, 0, length($c), '');
Andy Whitcroft8905a672007-11-28 16:21:06 -08003288 $s =~ s/\n.*//g;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003289 $s =~ s/$;//g; # Remove any comments
Andy Whitcroft53210162008-07-23 21:29:03 -07003290 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
3291 $c !~ /}\s*while\s*/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07003292 {
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003293 # Find out how long the conditional actually is.
3294 my @newlines = ($c =~ /\n/gs);
3295 my $cond_lines = 1 + $#newlines;
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003296 my $stat_real = '';
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003297
Hidetoshi Seto42bdf742010-03-05 13:43:50 -08003298 $stat_real = raw_line($linenr, $cond_lines)
3299 . "\n" if ($cond_lines);
Andy Whitcroftbb44ad32008-10-15 22:02:34 -07003300 if (defined($stat_real) && $cond_lines > 1) {
3301 $stat_real = "[...]\n$stat_real";
3302 }
3303
Joe Perches000d1cc12011-07-25 17:13:25 -07003304 ERROR("TRAILING_STATEMENTS",
3305 "trailing statements should be on next line\n" . $herecurr . $stat_real);
Andy Whitcroft8905a672007-11-28 16:21:06 -08003306 }
3307 }
3308
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003309# Check for bitwise tests written as boolean
3310 if ($line =~ /
3311 (?:
3312 (?:\[|\(|\&\&|\|\|)
3313 \s*0[xX][0-9]+\s*
3314 (?:\&\&|\|\|)
3315 |
3316 (?:\&\&|\|\|)
3317 \s*0[xX][0-9]+\s*
3318 (?:\&\&|\|\||\)|\])
3319 )/x)
3320 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003321 WARN("HEXADECIMAL_BOOLEAN_TEST",
3322 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003323 }
3324
Andy Whitcroft8905a672007-11-28 16:21:06 -08003325# if and else should not have general statements after it
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003326 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
3327 my $s = $1;
3328 $s =~ s/$;//g; # Remove any comments
3329 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003330 ERROR("TRAILING_STATEMENTS",
3331 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003332 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003333 }
Andy Whitcroft39667782009-01-15 13:51:06 -08003334# if should not continue a brace
3335 if ($line =~ /}\s*if\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003336 ERROR("TRAILING_STATEMENTS",
3337 "trailing statements should be on next line\n" .
Andy Whitcroft39667782009-01-15 13:51:06 -08003338 $herecurr);
3339 }
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003340# case and default should not have general statements after them
3341 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
3342 $line !~ /\G(?:
Andy Whitcroft3fef12d2008-10-15 22:02:36 -07003343 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003344 \s*return\s+
3345 )/xg)
3346 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003347 ERROR("TRAILING_STATEMENTS",
3348 "trailing statements should be on next line\n" . $herecurr);
Andy Whitcrofta1080bf2008-10-15 22:02:25 -07003349 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003350
3351 # Check for }<nl>else {, these must be at the same
3352 # indent level to be relevant to each other.
3353 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
3354 $previndent == $indent) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003355 ERROR("ELSE_AFTER_BRACE",
3356 "else should follow close brace '}'\n" . $hereprev);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003357 }
3358
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003359 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
3360 $previndent == $indent) {
3361 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
3362
3363 # Find out what is on the end of the line after the
3364 # conditional.
Andy Whitcroft773647a2008-03-28 14:15:58 -07003365 substr($s, 0, length($c), '');
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003366 $s =~ s/\n.*//g;
3367
3368 if ($s =~ /^\s*;/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003369 ERROR("WHILE_AFTER_BRACE",
3370 "while should follow close brace '}'\n" . $hereprev);
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08003371 }
3372 }
3373
Joe Perches95e2c602013-07-03 15:05:20 -07003374#Specific variable tests
Joe Perches323c1262012-12-17 16:02:07 -08003375 while ($line =~ m{($Constant|$Lval)}g) {
3376 my $var = $1;
Joe Perches95e2c602013-07-03 15:05:20 -07003377
3378#gcc binary extension
3379 if ($var =~ /^$Binary$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003380 if (WARN("GCC_BINARY_CONSTANT",
3381 "Avoid gcc v4.3+ binary constant extension: <$var>\n" . $herecurr) &&
3382 $fix) {
3383 my $hexval = sprintf("0x%x", oct($var));
3384 $fixed[$linenr - 1] =~
3385 s/\b$var\b/$hexval/;
3386 }
Joe Perches95e2c602013-07-03 15:05:20 -07003387 }
3388
3389#CamelCase
Joe Perches807bd262013-07-03 15:05:22 -07003390 if ($var !~ /^$Constant$/ &&
Joe Perchesbe797942013-07-03 15:05:20 -07003391 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003392#Ignore Page<foo> variants
Joe Perches807bd262013-07-03 15:05:22 -07003393 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ &&
Joe Perches22735ce2013-07-03 15:05:33 -07003394#Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
Joe Perches34456862013-07-03 15:05:34 -07003395 $var !~ /^(?:[a-z_]*?)_?[a-z][A-Z](?:_[a-z_]+)?$/) {
Joe Perches7e781f62013-09-11 14:23:55 -07003396 while ($var =~ m{($Ident)}g) {
3397 my $word = $1;
3398 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/);
3399 seed_camelcase_includes() if ($check);
3400 if (!defined $camelcase{$word}) {
3401 $camelcase{$word} = 1;
3402 CHK("CAMELCASE",
3403 "Avoid CamelCase: <$word>\n" . $herecurr);
3404 }
Joe Perches34456862013-07-03 15:05:34 -07003405 }
Joe Perches323c1262012-12-17 16:02:07 -08003406 }
3407 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003408
3409#no spaces allowed after \ in define
Joe Perchesd5e616f2013-09-11 14:23:54 -07003410 if ($line =~ /\#\s*define.*\\\s+$/) {
3411 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
3412 "Whitespace after \\ makes next lines useless\n" . $herecurr) &&
3413 $fix) {
3414 $fixed[$linenr - 1] =~ s/\s+$//;
3415 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003416 }
3417
Andy Whitcroft653d4872007-06-23 17:16:34 -07003418#warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003419 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003420 my $file = "$1.h";
3421 my $checkfile = "include/linux/$file";
3422 if (-f "$root/$checkfile" &&
3423 $realfile ne $checkfile &&
Wolfram Sang7840a942010-08-09 17:20:57 -07003424 $1 !~ /$allowed_asm_includes/)
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003425 {
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003426 if ($realfile =~ m{^arch/}) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003427 CHK("ARCH_INCLUDE_LINUX",
3428 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003429 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003430 WARN("INCLUDE_LINUX",
3431 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
Andy Whitcrofte09dec42008-10-15 22:02:20 -07003432 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003433 }
3434 }
3435
Andy Whitcroft653d4872007-06-23 17:16:34 -07003436# multi-statement macros should be enclosed in a do while loop, grab the
3437# first statement and ensure its the whole macro if its not enclosed
Andy Whitcroftcf655042008-03-04 14:28:20 -08003438# in a known good container
Andy Whitcroftb8f96a32008-07-23 21:29:07 -07003439 if ($realfile !~ m@/vmlinux.lds.h$@ &&
3440 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003441 my $ln = $linenr;
3442 my $cnt = $realcnt;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003443 my ($off, $dstat, $dcond, $rest);
3444 my $ctx = '';
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003445 ($dstat, $dcond, $ln, $cnt, $off) =
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003446 ctx_statement_block($linenr, $realcnt, 0);
3447 $ctx = $dstat;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003448 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
Andy Whitcrofta3bb97a2008-07-23 21:29:00 -07003449 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003450
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003451 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
Andy Whitcroft292f1a92008-07-23 21:29:11 -07003452 $dstat =~ s/$;//g;
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003453 $dstat =~ s/\\\n.//g;
3454 $dstat =~ s/^\s*//s;
3455 $dstat =~ s/\s*$//s;
3456
3457 # Flatten any parentheses and braces
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003458 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
3459 $dstat =~ s/\{[^\{\}]*\}/1/ ||
Andy Whitcroftc81769f2012-01-10 15:10:10 -08003460 $dstat =~ s/\[[^\[\]]*\]/1/)
Andy Whitcroftbf30d6e2008-10-15 22:02:33 -07003461 {
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003462 }
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003463
Andy Whitcrofte45bab82012-03-23 15:02:18 -07003464 # Flatten any obvious string concatentation.
3465 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
3466 $dstat =~ s/$Ident\s*("X*")/$1/)
3467 {
3468 }
3469
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003470 my $exceptions = qr{
3471 $Declare|
3472 module_param_named|
Kees Cooka0a0a7a2012-10-04 17:13:38 -07003473 MODULE_PARM_DESC|
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003474 DECLARE_PER_CPU|
3475 DEFINE_PER_CPU|
Andy Whitcroft383099f2009-01-06 14:41:18 -08003476 __typeof__\(|
Stefani Seibold22fd2d32010-03-05 13:43:52 -08003477 union|
3478 struct|
Andy Whitcroftea71a0a2009-09-21 17:04:38 -07003479 \.$Ident\s*=\s*|
3480 ^\"|\"$
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003481 }x;
Andy Whitcroft5eaa20b2010-10-26 14:23:18 -07003482 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003483 if ($dstat ne '' &&
3484 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
3485 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
Joe Perches3cc4b1c2013-07-03 15:05:27 -07003486 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
Andy Whitcroftb9df76a2012-03-23 15:02:17 -07003487 $dstat !~ /^'X'$/ && # character constants
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003488 $dstat !~ /$exceptions/ &&
3489 $dstat !~ /^\.$Ident\s*=/ && # .foo =
Joe Perchese942e2c2013-04-17 15:58:26 -07003490 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo
Andy Whitcroft72f115f2012-01-10 15:10:06 -08003491 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003492 $dstat !~ /^for\s*$Constant$/ && # for (...)
3493 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
3494 $dstat !~ /^do\s*{/ && # do {...
Joe Perchesf95a7e62013-09-11 14:24:00 -07003495 $dstat !~ /^\({/ && # ({...
3496 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/)
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003497 {
3498 $ctx =~ s/\n*$//;
3499 my $herectx = $here . "\n";
3500 my $cnt = statement_rawlines($ctx);
3501
3502 for (my $n = 0; $n < $cnt; $n++) {
3503 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003504 }
3505
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003506 if ($dstat =~ /;/) {
3507 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3508 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3509 } else {
Joe Perches000d1cc12011-07-25 17:13:25 -07003510 ERROR("COMPLEX_MACRO",
Andy Whitcroftf74bd192012-01-10 15:09:54 -08003511 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
Andy Whitcroftd8aaf122007-06-23 17:16:44 -07003512 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003513 }
Joe Perches5023d342012-12-17 16:01:47 -08003514
Joe Perches481eb482012-12-17 16:01:56 -08003515# check for line continuations outside of #defines, preprocessor #, and asm
Joe Perches5023d342012-12-17 16:01:47 -08003516
3517 } else {
3518 if ($prevline !~ /^..*\\$/ &&
Joe Perches481eb482012-12-17 16:01:56 -08003519 $line !~ /^\+\s*\#.*\\$/ && # preprocessor
3520 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm
Joe Perches5023d342012-12-17 16:01:47 -08003521 $line =~ /^\+.*\\$/) {
3522 WARN("LINE_CONTINUATIONS",
3523 "Avoid unnecessary line continuations\n" . $herecurr);
3524 }
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003525 }
3526
Joe Perchesb13edf72012-07-30 14:41:24 -07003527# do {} while (0) macro tests:
3528# single-statement macros do not need to be enclosed in do while (0) loop,
3529# macro should not end with a semicolon
3530 if ($^V && $^V ge 5.10.0 &&
3531 $realfile !~ m@/vmlinux.lds.h$@ &&
3532 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) {
3533 my $ln = $linenr;
3534 my $cnt = $realcnt;
3535 my ($off, $dstat, $dcond, $rest);
3536 my $ctx = '';
3537 ($dstat, $dcond, $ln, $cnt, $off) =
3538 ctx_statement_block($linenr, $realcnt, 0);
3539 $ctx = $dstat;
3540
3541 $dstat =~ s/\\\n.//g;
3542
3543 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3544 my $stmts = $2;
3545 my $semis = $3;
3546
3547 $ctx =~ s/\n*$//;
3548 my $cnt = statement_rawlines($ctx);
3549 my $herectx = $here . "\n";
3550
3551 for (my $n = 0; $n < $cnt; $n++) {
3552 $herectx .= raw_line($linenr, $n) . "\n";
3553 }
3554
Joe Perchesac8e97f2012-08-21 16:15:53 -07003555 if (($stmts =~ tr/;/;/) == 1 &&
3556 $stmts !~ /^\s*(if|while|for|switch)\b/) {
Joe Perchesb13edf72012-07-30 14:41:24 -07003557 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO",
3558 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx");
3559 }
3560 if (defined $semis && $semis ne "") {
3561 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON",
3562 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx");
3563 }
3564 }
3565 }
3566
Mike Frysinger080ba922009-01-06 14:41:25 -08003567# make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3568# all assignments may have only one of the following with an assignment:
3569# .
3570# ALIGN(...)
3571# VMLINUX_SYMBOL(...)
3572 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003573 WARN("MISSING_VMLINUX_SYMBOL",
3574 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
Mike Frysinger080ba922009-01-06 14:41:25 -08003575 }
3576
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003577# check for redundant bracing round if etc
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003578 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3579 my ($level, $endln, @chunks) =
Andy Whitcroftcf655042008-03-04 14:28:20 -08003580 ctx_statement_full($linenr, $realcnt, 1);
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003581 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003582 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3583 if ($#chunks > 0 && $level == 0) {
Joe Perchesaad4f612012-03-23 15:02:19 -07003584 my @allowed = ();
3585 my $allow = 0;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003586 my $seen = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003587 my $herectx = $here . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003588 my $ln = $linenr - 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003589 for my $chunk (@chunks) {
3590 my ($cond, $block) = @{$chunk};
3591
Andy Whitcroft773647a2008-03-28 14:15:58 -07003592 # If the condition carries leading newlines, then count those as offsets.
3593 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3594 my $offset = statement_rawlines($whitespace) - 1;
3595
Joe Perchesaad4f612012-03-23 15:02:19 -07003596 $allowed[$allow] = 0;
Andy Whitcroft773647a2008-03-28 14:15:58 -07003597 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3598
3599 # We have looked at and allowed this specific line.
3600 $suppress_ifbraces{$ln + $offset} = 1;
3601
3602 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003603 $ln += statement_rawlines($block) - 1;
3604
Andy Whitcroft773647a2008-03-28 14:15:58 -07003605 substr($block, 0, length($cond), '');
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003606
3607 $seen++ if ($block =~ /^\s*{/);
3608
Joe Perchesaad4f612012-03-23 15:02:19 -07003609 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003610 if (statement_lines($cond) > 1) {
3611 #print "APW: ALLOWED: cond<$cond>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003612 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003613 }
3614 if ($block =~/\b(?:if|for|while)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003615 #print "APW: ALLOWED: block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003616 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003617 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003618 if (statement_block_size($block) > 1) {
3619 #print "APW: ALLOWED: lines block<$block>\n";
Joe Perchesaad4f612012-03-23 15:02:19 -07003620 $allowed[$allow] = 1;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003621 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003622 $allow++;
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003623 }
Joe Perchesaad4f612012-03-23 15:02:19 -07003624 if ($seen) {
3625 my $sum_allowed = 0;
3626 foreach (@allowed) {
3627 $sum_allowed += $_;
3628 }
3629 if ($sum_allowed == 0) {
3630 WARN("BRACES",
3631 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3632 } elsif ($sum_allowed != $allow &&
3633 $seen != $allow) {
3634 CHK("BRACES",
3635 "braces {} should be used on all arms of this statement\n" . $herectx);
3636 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003637 }
3638 }
3639 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003640 if (!defined $suppress_ifbraces{$linenr - 1} &&
Andy Whitcroft13214ad2008-02-08 04:22:03 -08003641 $line =~ /\b(if|while|for|else)\b/) {
Andy Whitcroftcf655042008-03-04 14:28:20 -08003642 my $allowed = 0;
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003643
Andy Whitcroftcf655042008-03-04 14:28:20 -08003644 # Check the pre-context.
3645 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3646 #print "APW: ALLOWED: pre<$1>\n";
3647 $allowed = 1;
3648 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07003649
3650 my ($level, $endln, @chunks) =
3651 ctx_statement_full($linenr, $realcnt, $-[0]);
3652
Andy Whitcroftcf655042008-03-04 14:28:20 -08003653 # Check the condition.
3654 my ($cond, $block) = @{$chunks[0]};
Andy Whitcroft773647a2008-03-28 14:15:58 -07003655 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003656 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003657 substr($block, 0, length($cond), '');
Andy Whitcroftcf655042008-03-04 14:28:20 -08003658 }
3659 if (statement_lines($cond) > 1) {
3660 #print "APW: ALLOWED: cond<$cond>\n";
3661 $allowed = 1;
3662 }
3663 if ($block =~/\b(?:if|for|while)\b/) {
3664 #print "APW: ALLOWED: block<$block>\n";
3665 $allowed = 1;
3666 }
3667 if (statement_block_size($block) > 1) {
3668 #print "APW: ALLOWED: lines block<$block>\n";
3669 $allowed = 1;
3670 }
3671 # Check the post-context.
3672 if (defined $chunks[1]) {
3673 my ($cond, $block) = @{$chunks[1]};
3674 if (defined $cond) {
Andy Whitcroft773647a2008-03-28 14:15:58 -07003675 substr($block, 0, length($cond), '');
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003676 }
Andy Whitcroftcf655042008-03-04 14:28:20 -08003677 if ($block =~ /^\s*\{/) {
3678 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3679 $allowed = 1;
3680 }
3681 }
3682 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003683 my $herectx = $here . "\n";
Andy Whitcroftf0556632008-10-15 22:02:23 -07003684 my $cnt = statement_rawlines($block);
Andy Whitcroftcf655042008-03-04 14:28:20 -08003685
Andy Whitcroftf0556632008-10-15 22:02:23 -07003686 for (my $n = 0; $n < $cnt; $n++) {
Justin P. Mattock69932482011-07-26 23:06:29 -07003687 $herectx .= raw_line($linenr, $n) . "\n";
Andy Whitcroftcf655042008-03-04 14:28:20 -08003688 }
3689
Joe Perches000d1cc12011-07-25 17:13:25 -07003690 WARN("BRACES",
3691 "braces {} are not necessary for single statement blocks\n" . $herectx);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003692 }
3693 }
3694
Joe Perches0979ae62012-12-17 16:01:59 -08003695# check for unnecessary blank lines around braces
Joe Perches77b9a532013-07-03 15:05:29 -07003696 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003697 CHK("BRACES",
3698 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev);
3699 }
Joe Perches77b9a532013-07-03 15:05:29 -07003700 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) {
Joe Perches0979ae62012-12-17 16:01:59 -08003701 CHK("BRACES",
3702 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev);
3703 }
3704
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003705# no volatiles please
Andy Whitcroft6c72ffa2007-10-18 03:05:08 -07003706 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3707 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003708 WARN("VOLATILE",
3709 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003710 }
3711
Andy Whitcroft00df3442007-06-08 13:47:06 -07003712# warn about #if 0
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003713 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003714 CHK("REDUNDANT_CODE",
3715 "if this code is redundant consider removing it\n" .
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003716 $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003717 }
3718
Andy Whitcroft03df4b52012-12-17 16:01:52 -08003719# check for needless "if (<foo>) fn(<foo>)" uses
3720 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) {
3721 my $expr = '\s*\(\s*' . quotemeta($1) . '\s*\)\s*;';
3722 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?)$expr/) {
3723 WARN('NEEDLESS_IF',
3724 "$1(NULL) is safe this check is probably not required\n" . $hereprev);
Greg Kroah-Hartman4c432a82008-07-23 21:29:04 -07003725 }
3726 }
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07003727
Joe Perches8716de32013-09-11 14:24:05 -07003728sub string_find_replace {
3729 my ($string, $find, $replace) = @_;
3730
3731 $string =~ s/$find/$replace/g;
3732
3733 return $string;
3734}
3735
3736# check for bad placement of section $InitAttribute (e.g.: __initdata)
3737 if ($line =~ /(\b$InitAttribute\b)/) {
3738 my $attr = $1;
3739 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
3740 my $ptr = $1;
3741 my $var = $2;
3742 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ &&
3743 ERROR("MISPLACED_INIT",
3744 "$attr should be placed after $var\n" . $herecurr)) ||
3745 ($ptr !~ /\b(union|struct)\s+$attr\b/ &&
3746 WARN("MISPLACED_INIT",
3747 "$attr should be placed after $var\n" . $herecurr))) &&
3748 $fix) {
3749 $fixed[$linenr - 1] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e;
3750 }
3751 }
3752 }
3753
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003754# prefer usleep_range over udelay
Bruce Allan37581c22013-02-21 16:44:19 -08003755 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) {
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003756 # ignore udelay's < 10, however
Bruce Allan37581c22013-02-21 16:44:19 -08003757 if (! ($1 < 10) ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003758 CHK("USLEEP_RANGE",
3759 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto1a15a252010-08-09 17:21:01 -07003760 }
3761 }
3762
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003763# warn about unexpectedly long msleep's
3764 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3765 if ($1 < 20) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003766 WARN("MSLEEP",
3767 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
Patrick Pannuto09ef8722010-08-09 17:21:02 -07003768 }
3769 }
3770
Joe Perches36ec1932013-07-03 15:05:25 -07003771# check for comparisons of jiffies
3772 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) {
3773 WARN("JIFFIES_COMPARISON",
3774 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
3775 }
3776
Joe Perches9d7a34a2013-07-03 15:05:26 -07003777# check for comparisons of get_jiffies_64()
3778 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) {
3779 WARN("JIFFIES_COMPARISON",
3780 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
3781 }
3782
Andy Whitcroft00df3442007-06-08 13:47:06 -07003783# warn about #ifdefs in C files
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003784# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
Andy Whitcroft00df3442007-06-08 13:47:06 -07003785# print "#ifdef in C files should be avoided\n";
3786# print "$herecurr";
3787# $clean = 0;
3788# }
3789
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003790# warn about spacing in #ifdefs
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003791 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
Joe Perches3705ce52013-07-03 15:05:31 -07003792 if (ERROR("SPACING",
3793 "exactly one space required after that #$1\n" . $herecurr) &&
3794 $fix) {
3795 $fixed[$linenr - 1] =~
3796 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /;
3797 }
3798
Andy Whitcroft22f2a2e2007-08-10 13:01:03 -07003799 }
3800
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003801# check for spinlock_t definitions without a comment.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003802 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3803 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003804 my $which = $1;
3805 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003806 CHK("UNCOMMENTED_DEFINITION",
3807 "$1 definition without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003808 }
3809 }
3810# check for memory barriers without a comment.
3811 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3812 if (!ctx_has_comment($first_line, $linenr)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003813 CHK("MEMORY_BARRIER",
3814 "memory barrier without comment\n" . $herecurr);
Andy Whitcroft4a0df2e2007-06-08 13:46:39 -07003815 }
3816 }
3817# check of hardware specific defines
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003818 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003819 CHK("ARCH_DEFINES",
3820 "architecture specific defines should be avoided\n" . $herecurr);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07003821 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07003822
Tobias Klauserd4977c72010-05-24 14:33:30 -07003823# Check that the storage class is at the beginning of a declaration
3824 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003825 WARN("STORAGE_CLASS",
3826 "storage class should be at the beginning of the declaration\n" . $herecurr)
Tobias Klauserd4977c72010-05-24 14:33:30 -07003827 }
3828
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003829# check the location of the inline attribute, that it is between
3830# storage class and type.
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07003831 if ($line =~ /\b$Type\s+$Inline\b/ ||
3832 $line =~ /\b$Inline\s+$Storage\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003833 ERROR("INLINE_LOCATION",
3834 "inline keyword should sit between storage class and type\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003835 }
3836
Andy Whitcroft8905a672007-11-28 16:21:06 -08003837# Check for __inline__ and __inline, prefer inline
3838 if ($line =~ /\b(__inline__|__inline)\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003839 if (WARN("INLINE",
3840 "plain inline is preferred over $1\n" . $herecurr) &&
3841 $fix) {
3842 $fixed[$linenr - 1] =~ s/\b(__inline__|__inline)\b/inline/;
3843
3844 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08003845 }
3846
Joe Perches3d130fd2011-01-12 17:00:00 -08003847# Check for __attribute__ packed, prefer __packed
3848 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003849 WARN("PREFER_PACKED",
3850 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
Joe Perches3d130fd2011-01-12 17:00:00 -08003851 }
3852
Joe Perches39b7e282011-07-25 17:13:24 -07003853# Check for __attribute__ aligned, prefer __aligned
3854 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003855 WARN("PREFER_ALIGNED",
3856 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
Joe Perches39b7e282011-07-25 17:13:24 -07003857 }
3858
Joe Perches5f14d3b2012-01-10 15:09:52 -08003859# Check for __attribute__ format(printf, prefer __printf
3860 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003861 if (WARN("PREFER_PRINTF",
3862 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
3863 $fix) {
3864 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
3865
3866 }
Joe Perches5f14d3b2012-01-10 15:09:52 -08003867 }
3868
Joe Perches6061d942012-03-23 15:02:16 -07003869# Check for __attribute__ format(scanf, prefer __scanf
3870 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003871 if (WARN("PREFER_SCANF",
3872 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
3873 $fix) {
3874 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
3875 }
Joe Perches6061d942012-03-23 15:02:16 -07003876 }
3877
Joe Perches8f53a9b2010-03-05 13:43:48 -08003878# check for sizeof(&)
3879 if ($line =~ /\bsizeof\s*\(\s*\&/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003880 WARN("SIZEOF_ADDRESS",
3881 "sizeof(& should be avoided\n" . $herecurr);
Joe Perches8f53a9b2010-03-05 13:43:48 -08003882 }
3883
Joe Perches66c80b62012-07-30 14:41:22 -07003884# check for sizeof without parenthesis
3885 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003886 if (WARN("SIZEOF_PARENTHESIS",
3887 "sizeof $1 should be sizeof($1)\n" . $herecurr) &&
3888 $fix) {
3889 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
3890 }
Joe Perches66c80b62012-07-30 14:41:22 -07003891 }
3892
Joe Perches428e2fd2011-05-24 17:13:39 -07003893# check for line continuations in quoted strings with odd counts of "
3894 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
Joe Perches000d1cc12011-07-25 17:13:25 -07003895 WARN("LINE_CONTINUATIONS",
3896 "Avoid line continuations in quoted strings\n" . $herecurr);
Joe Perches428e2fd2011-05-24 17:13:39 -07003897 }
3898
Joe Perches88982fe2012-12-17 16:02:00 -08003899# check for struct spinlock declarations
3900 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) {
3901 WARN("USE_SPINLOCK_T",
3902 "struct spinlock should be spinlock_t\n" . $herecurr);
3903 }
3904
Joe Perchesa6962d72013-04-29 16:18:13 -07003905# check for seq_printf uses that could be seq_puts
3906 if ($line =~ /\bseq_printf\s*\(/) {
3907 my $fmt = get_quoted_string($line, $rawline);
3908 if ($fmt !~ /[^\\]\%/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07003909 if (WARN("PREFER_SEQ_PUTS",
3910 "Prefer seq_puts to seq_printf\n" . $herecurr) &&
3911 $fix) {
3912 $fixed[$linenr - 1] =~ s/\bseq_printf\b/seq_puts/;
3913 }
Joe Perchesa6962d72013-04-29 16:18:13 -07003914 }
3915 }
3916
Andy Whitcroft554e1652012-01-10 15:09:57 -08003917# Check for misused memsets
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003918 if ($^V && $^V ge 5.10.0 &&
3919 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003920 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
Andy Whitcroft554e1652012-01-10 15:09:57 -08003921
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003922 my $ms_addr = $2;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003923 my $ms_val = $7;
3924 my $ms_size = $12;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003925
Andy Whitcroft554e1652012-01-10 15:09:57 -08003926 if ($ms_size =~ /^(0x|)0$/i) {
3927 ERROR("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003928 "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 -08003929 } elsif ($ms_size =~ /^(0x|)1$/i) {
3930 WARN("MEMSET",
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003931 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3932 }
3933 }
3934
3935# typecasts on min/max could be min_t/max_t
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003936 if ($^V && $^V ge 5.10.0 &&
3937 defined $stat &&
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003938 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003939 if (defined $2 || defined $7) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003940 my $call = $1;
3941 my $cast1 = deparenthesize($2);
3942 my $arg1 = $3;
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003943 my $cast2 = deparenthesize($7);
3944 my $arg2 = $8;
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003945 my $cast;
3946
Joe Perchesd1fe9c02012-03-23 15:02:16 -07003947 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
Joe Perchesd7c76ba2012-01-10 15:09:58 -08003948 $cast = "$cast1 or $cast2";
3949 } elsif ($cast1 ne "") {
3950 $cast = $cast1;
3951 } else {
3952 $cast = $cast2;
3953 }
3954 WARN("MINMAX",
3955 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
Andy Whitcroft554e1652012-01-10 15:09:57 -08003956 }
3957 }
3958
Joe Perches4a273192012-07-30 14:41:20 -07003959# check usleep_range arguments
3960 if ($^V && $^V ge 5.10.0 &&
3961 defined $stat &&
3962 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) {
3963 my $min = $1;
3964 my $max = $7;
3965 if ($min eq $max) {
3966 WARN("USLEEP_RANGE",
3967 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3968 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ &&
3969 $min > $max) {
3970 WARN("USLEEP_RANGE",
3971 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
3972 }
3973 }
3974
Joe Perches70dc8a42013-09-11 14:23:58 -07003975# check for new externs in .h files.
3976 if ($realfile =~ /\.h$/ &&
3977 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) {
3978 if (WARN("AVOID_EXTERNS",
3979 "extern prototypes should be avoided in .h files\n" . $herecurr) &&
3980 $fix) {
3981 $fixed[$linenr - 1] =~ s/(.*)\bextern\b\s*(.*)/$1$2/;
3982 }
3983 }
3984
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07003985# check for new externs in .c files.
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003986 if ($realfile =~ /\.c$/ && defined $stat &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003987 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003988 {
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003989 my $function_name = $1;
3990 my $paren_space = $2;
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07003991
3992 my $s = $stat;
3993 if (defined $cond) {
3994 substr($s, 0, length($cond), '');
3995 }
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07003996 if ($s =~ /^\s*;/ &&
3997 $function_name ne 'uninitialized_var')
3998 {
Joe Perches000d1cc12011-07-25 17:13:25 -07003999 WARN("AVOID_EXTERNS",
4000 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004001 }
4002
4003 if ($paren_space =~ /\n/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004004 WARN("FUNCTION_ARGUMENTS",
4005 "arguments for function declarations should follow identifier\n" . $herecurr);
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004006 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004007
4008 } elsif ($realfile =~ /\.c$/ && defined $stat &&
4009 $stat =~ /^.\s*extern\s+/)
4010 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004011 WARN("AVOID_EXTERNS",
4012 "externs should be avoided in .c files\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004013 }
4014
4015# checks for new __setup's
4016 if ($rawline =~ /\b__setup\("([^"]*)"/) {
4017 my $name = $1;
4018
4019 if (!grep(/$name/, @setup_docs)) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004020 CHK("UNDOCUMENTED_SETUP",
4021 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
Andy Whitcroftde7d4f02007-07-15 23:37:22 -07004022 }
Andy Whitcroft653d4872007-06-23 17:16:34 -07004023 }
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004024
4025# check for pointless casting of kmalloc return
Joe Perchescaf2a542011-01-12 16:59:56 -08004026 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004027 WARN("UNNECESSARY_CASTS",
4028 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
Andy Whitcroft9c0ca6f2007-10-16 23:29:38 -07004029 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004030
Joe Perchesa640d252013-07-03 15:05:21 -07004031# alloc style
4032# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4033 if ($^V && $^V ge 5.10.0 &&
4034 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4035 CHK("ALLOC_SIZEOF_STRUCT",
4036 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr);
4037 }
4038
Joe Perches972fdea2013-04-29 16:18:12 -07004039# check for krealloc arg reuse
4040 if ($^V && $^V ge 5.10.0 &&
4041 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*\1\s*,/) {
4042 WARN("KREALLOC_ARG_REUSE",
4043 "Reusing the krealloc arg is almost always a bug\n" . $herecurr);
4044 }
4045
Joe Perches5ce59ae2013-02-21 16:44:18 -08004046# check for alloc argument mismatch
4047 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) {
4048 WARN("ALLOC_ARRAY_ARGS",
4049 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr);
4050 }
4051
Joe Perchescaf2a542011-01-12 16:59:56 -08004052# check for multiple semicolons
4053 if ($line =~ /;\s*;\s*$/) {
Joe Perchesd5e616f2013-09-11 14:23:54 -07004054 if (WARN("ONE_SEMICOLON",
4055 "Statements terminations use 1 semicolon\n" . $herecurr) &&
4056 $fix) {
4057 $fixed[$linenr - 1] =~ s/(\s*;\s*){2,}$/;/g;
4058 }
Joe Perchesd1e2ad02012-12-17 16:02:01 -08004059 }
4060
4061# check for switch/default statements without a break;
4062 if ($^V && $^V ge 5.10.0 &&
4063 defined $stat &&
4064 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) {
4065 my $ctx = '';
4066 my $herectx = $here . "\n";
4067 my $cnt = statement_rawlines($stat);
4068 for (my $n = 0; $n < $cnt; $n++) {
4069 $herectx .= raw_line($linenr, $n) . "\n";
4070 }
4071 WARN("DEFAULT_NO_BREAK",
4072 "switch default: should use break\n" . $herectx);
Joe Perchescaf2a542011-01-12 16:59:56 -08004073 }
4074
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004075# check for gcc specific __FUNCTION__
Joe Perchesd5e616f2013-09-11 14:23:54 -07004076 if ($line =~ /\b__FUNCTION__\b/) {
4077 if (WARN("USE_FUNC",
4078 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) &&
4079 $fix) {
4080 $fixed[$linenr - 1] =~ s/\b__FUNCTION__\b/__func__/g;
4081 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004082 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004083
Joe Perches2c924882012-03-23 15:02:20 -07004084# check for use of yield()
4085 if ($line =~ /\byield\s*\(\s*\)/) {
4086 WARN("YIELD",
4087 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
4088 }
4089
Joe Perches179f8f42013-07-03 15:05:30 -07004090# check for comparisons against true and false
4091 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) {
4092 my $lead = $1;
4093 my $arg = $2;
4094 my $test = $3;
4095 my $otype = $4;
4096 my $trail = $5;
4097 my $op = "!";
4098
4099 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i);
4100
4101 my $type = lc($otype);
4102 if ($type =~ /^(?:true|false)$/) {
4103 if (("$test" eq "==" && "$type" eq "true") ||
4104 ("$test" eq "!=" && "$type" eq "false")) {
4105 $op = "";
4106 }
4107
4108 CHK("BOOL_COMPARISON",
4109 "Using comparison to $otype is error prone\n" . $herecurr);
4110
4111## maybe suggesting a correct construct would better
4112## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4113
4114 }
4115 }
4116
Thomas Gleixner4882720b2010-09-07 14:34:01 +00004117# check for semaphores initialized locked
4118 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004119 WARN("CONSIDER_COMPLETION",
4120 "consider using a completion\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004121 }
Joe Perches6712d852012-03-23 15:02:20 -07004122
Joe Perches67d0a072011-10-31 17:13:10 -07004123# recommend kstrto* over simple_strto* and strict_strto*
4124 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004125 WARN("CONSIDER_KSTRTO",
Joe Perches67d0a072011-10-31 17:13:10 -07004126 "$1 is obsolete, use k$3 instead\n" . $herecurr);
Andy Whitcroft773647a2008-03-28 14:15:58 -07004127 }
Joe Perches6712d852012-03-23 15:02:20 -07004128
Michael Ellermanf3db6632008-07-23 21:28:57 -07004129# check for __initcall(), use device_initcall() explicitly please
4130 if ($line =~ /^.\s*__initcall\s*\(/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004131 WARN("USE_DEVICE_INITCALL",
4132 "please use device_initcall() instead of __initcall()\n" . $herecurr);
Michael Ellermanf3db6632008-07-23 21:28:57 -07004133 }
Joe Perches6712d852012-03-23 15:02:20 -07004134
Emese Revfy79404842010-03-05 13:43:53 -08004135# check for various ops structs, ensure they are const.
4136 my $struct_ops = qr{acpi_dock_ops|
4137 address_space_operations|
4138 backlight_ops|
4139 block_device_operations|
4140 dentry_operations|
4141 dev_pm_ops|
4142 dma_map_ops|
4143 extent_io_ops|
4144 file_lock_operations|
4145 file_operations|
4146 hv_ops|
4147 ide_dma_ops|
4148 intel_dvo_dev_ops|
4149 item_operations|
4150 iwl_ops|
4151 kgdb_arch|
4152 kgdb_io|
4153 kset_uevent_ops|
4154 lock_manager_operations|
4155 microcode_ops|
4156 mtrr_ops|
4157 neigh_ops|
4158 nlmsvc_binding|
4159 pci_raw_ops|
4160 pipe_buf_operations|
4161 platform_hibernation_ops|
4162 platform_suspend_ops|
4163 proto_ops|
4164 rpc_pipe_ops|
4165 seq_operations|
4166 snd_ac97_build_ops|
4167 soc_pcmcia_socket_ops|
4168 stacktrace_ops|
4169 sysfs_ops|
4170 tty_operations|
4171 usb_mon_operations|
4172 wd_ops}x;
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004173 if ($line !~ /\bconst\b/ &&
Emese Revfy79404842010-03-05 13:43:53 -08004174 $line =~ /\bstruct\s+($struct_ops)\b/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004175 WARN("CONST_STRUCT",
4176 "struct $1 should normally be const\n" .
Andy Whitcroft6903ffb2009-01-15 13:51:07 -08004177 $herecurr);
Andy Whitcroft2b6db5c2009-01-06 14:41:29 -08004178 }
Andy Whitcroft773647a2008-03-28 14:15:58 -07004179
4180# use of NR_CPUS is usually wrong
4181# ignore definitions of NR_CPUS and usage to define arrays as likely right
4182 if ($line =~ /\bNR_CPUS\b/ &&
Andy Whitcroftc45dcab2008-06-05 22:46:01 -07004183 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
4184 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
Andy Whitcroft171ae1a2008-04-29 00:59:32 -07004185 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
4186 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
4187 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
Andy Whitcroft773647a2008-03-28 14:15:58 -07004188 {
Joe Perches000d1cc12011-07-25 17:13:25 -07004189 WARN("NR_CPUS",
4190 "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 -07004191 }
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004192
4193# check for %L{u,d,i} in strings
4194 my $string;
4195 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
4196 $string = substr($rawline, $-[1], $+[1] - $-[1]);
Andy Whitcroft2a1bc5d2008-10-15 22:02:23 -07004197 $string =~ s/%%/__/g;
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004198 if ($string =~ /(?<!%)%L[udi]/) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004199 WARN("PRINTF_L",
4200 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
Andy Whitcroft9c9ba342008-04-29 00:59:33 -07004201 last;
4202 }
4203 }
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004204
4205# whine mightly about in_atomic
4206 if ($line =~ /\bin_atomic\s*\(/) {
4207 if ($realfile =~ m@^drivers/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004208 ERROR("IN_ATOMIC",
4209 "do not use in_atomic in drivers\n" . $herecurr);
Andy Whitcroftf4a87732009-02-27 14:03:05 -08004210 } elsif ($realfile !~ m@^kernel/@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004211 WARN("IN_ATOMIC",
4212 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
Andy Whitcroft691d77b2009-01-06 14:41:16 -08004213 }
4214 }
Peter Zijlstra1704f472010-03-19 01:37:42 +01004215
4216# check for lockdep_set_novalidate_class
4217 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
4218 $line =~ /__lockdep_no_validate__\s*\)/ ) {
4219 if ($realfile !~ m@^kernel/lockdep@ &&
4220 $realfile !~ m@^include/linux/lockdep@ &&
4221 $realfile !~ m@^drivers/base/core@) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004222 ERROR("LOCKDEP",
4223 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
Peter Zijlstra1704f472010-03-19 01:37:42 +01004224 }
4225 }
Dave Jones88f88312011-01-12 16:59:59 -08004226
4227 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
4228 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004229 WARN("EXPORTED_WORLD_WRITABLE",
4230 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
Dave Jones88f88312011-01-12 16:59:59 -08004231 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004232 }
4233
4234 # If we have no input at all, then there is nothing to report on
4235 # so just keep quiet.
4236 if ($#rawlines == -1) {
4237 exit(0);
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004238 }
4239
Andy Whitcroft8905a672007-11-28 16:21:06 -08004240 # In mailback mode only produce a report in the negative, for
4241 # things that appear to be patches.
4242 if ($mailback && ($clean == 1 || !$is_patch)) {
4243 exit(0);
4244 }
4245
4246 # This is not a patch, and we are are in 'no-patch' mode so
4247 # just keep quiet.
4248 if (!$chk_patch && !$is_patch) {
4249 exit(0);
4250 }
4251
4252 if (!$is_patch) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004253 ERROR("NOT_UNIFIED_DIFF",
4254 "Does not appear to be a unified-diff format patch\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004255 }
4256 if ($is_patch && $chk_signoff && $signoff == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004257 ERROR("MISSING_SIGN_OFF",
4258 "Missing Signed-off-by: line(s)\n");
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004259 }
4260
Andy Whitcroft8905a672007-11-28 16:21:06 -08004261 print report_dump();
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004262 if ($summary && !($clean == 1 && $quiet == 1)) {
4263 print "$filename " if ($summary_file);
Andy Whitcroft8905a672007-11-28 16:21:06 -08004264 print "total: $cnt_error errors, $cnt_warn warnings, " .
4265 (($check)? "$cnt_chk checks, " : "") .
4266 "$cnt_lines lines checked\n";
4267 print "\n" if ($quiet == 0);
Andy Whitcroftf0a594c2007-07-19 01:48:34 -07004268 }
Andy Whitcroft8905a672007-11-28 16:21:06 -08004269
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004270 if ($quiet == 0) {
Joe Perchesd1fe9c02012-03-23 15:02:16 -07004271
4272 if ($^V lt 5.10.0) {
4273 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
4274 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
4275 }
4276
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004277 # If there were whitespace errors which cleanpatch can fix
4278 # then suggest that.
4279 if ($rpt_cleaners) {
4280 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
4281 print " scripts/cleanfile\n\n";
Mike Frysingerb0781212011-03-22 16:34:43 -07004282 $rpt_cleaners = 0;
Andy Whitcroftd2c0a232010-10-26 14:23:12 -07004283 }
4284 }
4285
Joe Perches91bfe482013-09-11 14:23:59 -07004286 hash_show_words(\%use_type, "Used");
4287 hash_show_words(\%ignore_type, "Ignored");
Joe Perches000d1cc12011-07-25 17:13:25 -07004288
Joe Perches3705ce52013-07-03 15:05:31 -07004289 if ($clean == 0 && $fix && "@rawlines" ne "@fixed") {
4290 my $newfile = $filename . ".EXPERIMENTAL-checkpatch-fixes";
4291 my $linecount = 0;
4292 my $f;
4293
4294 open($f, '>', $newfile)
4295 or die "$P: Can't open $newfile for write\n";
4296 foreach my $fixed_line (@fixed) {
4297 $linecount++;
4298 if ($file) {
4299 if ($linecount > 3) {
4300 $fixed_line =~ s/^\+//;
4301 print $f $fixed_line. "\n";
4302 }
4303 } else {
4304 print $f $fixed_line . "\n";
4305 }
4306 }
4307 close($f);
4308
4309 if (!$quiet) {
4310 print << "EOM";
4311Wrote EXPERIMENTAL --fix correction(s) to '$newfile'
4312
4313Do _NOT_ trust the results written to this file.
4314Do _NOT_ submit these changes without inspecting them for correctness.
4315
4316This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4317No warranties, expressed or implied...
4318
4319EOM
4320 }
4321 }
4322
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004323 if ($clean == 1 && $quiet == 0) {
Andy Whitcroftc2fdda02008-02-08 04:20:54 -08004324 print "$vname has no obvious style problems and is ready for submission.\n"
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004325 }
4326 if ($clean == 0 && $quiet == 0) {
Joe Perches000d1cc12011-07-25 17:13:25 -07004327 print << "EOM";
4328$vname has style problems, please review.
4329
4330If any of these errors are false positives, please report
4331them to the maintainer, see CHECKPATCH in MAINTAINERS.
4332EOM
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004333 }
Andy Whitcroft13214ad2008-02-08 04:22:03 -08004334
Andy Whitcroft0a920b52007-06-01 00:46:48 -07004335 return $clean;
4336}