]>
Commit | Line | Data |
---|---|---|
0a920b5b | 1 | #!/usr/bin/perl -w |
dbf004d7 | 2 | # (c) 2001, Dave Jones. (the file handling bit) |
00df344f | 3 | # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit) |
2a5a2c25 | 4 | # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite) |
015830be | 5 | # (c) 2008-2010 Andy Whitcroft <apw@canonical.com> |
0a920b5b AW |
6 | # Licensed under the terms of the GNU GPL License version 2 |
7 | ||
8 | use strict; | |
9 | ||
10 | my $P = $0; | |
00df344f | 11 | $P =~ s@.*/@@g; |
0a920b5b | 12 | |
000d1cc1 | 13 | my $V = '0.32'; |
0a920b5b AW |
14 | |
15 | use Getopt::Long qw(:config no_auto_abbrev); | |
16 | ||
17 | my $quiet = 0; | |
18 | my $tree = 1; | |
19 | my $chk_signoff = 1; | |
20 | my $chk_patch = 1; | |
773647a0 | 21 | my $tst_only; |
6c72ffaa | 22 | my $emacs = 0; |
8905a67c | 23 | my $terse = 0; |
6c72ffaa AW |
24 | my $file = 0; |
25 | my $check = 0; | |
8905a67c AW |
26 | my $summary = 1; |
27 | my $mailback = 0; | |
13214adf | 28 | my $summary_file = 0; |
000d1cc1 | 29 | my $show_types = 0; |
6c72ffaa | 30 | my $root; |
c2fdda0d | 31 | my %debug; |
000d1cc1 JP |
32 | my %ignore_type = (); |
33 | my @ignore = (); | |
77f5b10a | 34 | my $help = 0; |
000d1cc1 | 35 | my $configuration_file = ".checkpatch.conf"; |
77f5b10a HE |
36 | |
37 | sub help { | |
38 | my ($exitcode) = @_; | |
39 | ||
40 | print << "EOM"; | |
41 | Usage: $P [OPTION]... [FILE]... | |
42 | Version: $V | |
43 | ||
44 | Options: | |
45 | -q, --quiet quiet | |
46 | --no-tree run without a kernel tree | |
47 | --no-signoff do not check for 'Signed-off-by' line | |
48 | --patch treat FILE as patchfile (default) | |
49 | --emacs emacs compile window format | |
50 | --terse one line per report | |
51 | -f, --file treat FILE as regular source file | |
52 | --subjective, --strict enable more subjective tests | |
000d1cc1 JP |
53 | --ignore TYPE(,TYPE2...) ignore various comma separated message types |
54 | --show-types show the message "types" in the output | |
77f5b10a HE |
55 | --root=PATH PATH to the kernel tree root |
56 | --no-summary suppress the per-file summary | |
57 | --mailback only produce a report in case of warnings/errors | |
58 | --summary-file include the filename in summary | |
59 | --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of | |
60 | 'values', 'possible', 'type', and 'attr' (default | |
61 | is all off) | |
62 | --test-only=WORD report only warnings/errors containing WORD | |
63 | literally | |
64 | -h, --help, --version display this help and exit | |
65 | ||
66 | When FILE is - read standard input. | |
67 | EOM | |
68 | ||
69 | exit($exitcode); | |
70 | } | |
71 | ||
000d1cc1 JP |
72 | my $conf = which_conf($configuration_file); |
73 | if (-f $conf) { | |
74 | my @conf_args; | |
75 | open(my $conffile, '<', "$conf") | |
76 | or warn "$P: Can't find a readable $configuration_file file $!\n"; | |
77 | ||
78 | while (<$conffile>) { | |
79 | my $line = $_; | |
80 | ||
81 | $line =~ s/\s*\n?$//g; | |
82 | $line =~ s/^\s*//g; | |
83 | $line =~ s/\s+/ /g; | |
84 | ||
85 | next if ($line =~ m/^\s*#/); | |
86 | next if ($line =~ m/^\s*$/); | |
87 | ||
88 | my @words = split(" ", $line); | |
89 | foreach my $word (@words) { | |
90 | last if ($word =~ m/^#/); | |
91 | push (@conf_args, $word); | |
92 | } | |
93 | } | |
94 | close($conffile); | |
95 | unshift(@ARGV, @conf_args) if @conf_args; | |
96 | } | |
97 | ||
0a920b5b | 98 | GetOptions( |
6c72ffaa | 99 | 'q|quiet+' => \$quiet, |
0a920b5b AW |
100 | 'tree!' => \$tree, |
101 | 'signoff!' => \$chk_signoff, | |
102 | 'patch!' => \$chk_patch, | |
6c72ffaa | 103 | 'emacs!' => \$emacs, |
8905a67c | 104 | 'terse!' => \$terse, |
77f5b10a | 105 | 'f|file!' => \$file, |
6c72ffaa AW |
106 | 'subjective!' => \$check, |
107 | 'strict!' => \$check, | |
000d1cc1 JP |
108 | 'ignore=s' => \@ignore, |
109 | 'show-types!' => \$show_types, | |
6c72ffaa | 110 | 'root=s' => \$root, |
8905a67c AW |
111 | 'summary!' => \$summary, |
112 | 'mailback!' => \$mailback, | |
13214adf AW |
113 | 'summary-file!' => \$summary_file, |
114 | ||
c2fdda0d | 115 | 'debug=s' => \%debug, |
773647a0 | 116 | 'test-only=s' => \$tst_only, |
77f5b10a HE |
117 | 'h|help' => \$help, |
118 | 'version' => \$help | |
119 | ) or help(1); | |
120 | ||
121 | help(0) if ($help); | |
0a920b5b AW |
122 | |
123 | my $exit = 0; | |
124 | ||
125 | if ($#ARGV < 0) { | |
77f5b10a | 126 | print "$P: no input files\n"; |
0a920b5b AW |
127 | exit(1); |
128 | } | |
129 | ||
000d1cc1 JP |
130 | @ignore = split(/,/, join(',',@ignore)); |
131 | foreach my $word (@ignore) { | |
132 | $word =~ s/\s*\n?$//g; | |
133 | $word =~ s/^\s*//g; | |
134 | $word =~ s/\s+/ /g; | |
135 | $word =~ tr/[a-z]/[A-Z]/; | |
136 | ||
137 | next if ($word =~ m/^\s*#/); | |
138 | next if ($word =~ m/^\s*$/); | |
139 | ||
140 | $ignore_type{$word}++; | |
141 | } | |
142 | ||
c2fdda0d AW |
143 | my $dbg_values = 0; |
144 | my $dbg_possible = 0; | |
7429c690 | 145 | my $dbg_type = 0; |
a1ef277e | 146 | my $dbg_attr = 0; |
c2fdda0d | 147 | for my $key (keys %debug) { |
21caa13c AW |
148 | ## no critic |
149 | eval "\${dbg_$key} = '$debug{$key}';"; | |
150 | die "$@" if ($@); | |
c2fdda0d AW |
151 | } |
152 | ||
d2c0a235 AW |
153 | my $rpt_cleaners = 0; |
154 | ||
8905a67c AW |
155 | if ($terse) { |
156 | $emacs = 1; | |
157 | $quiet++; | |
158 | } | |
159 | ||
6c72ffaa AW |
160 | if ($tree) { |
161 | if (defined $root) { | |
162 | if (!top_of_kernel_tree($root)) { | |
163 | die "$P: $root: --root does not point at a valid tree\n"; | |
164 | } | |
165 | } else { | |
166 | if (top_of_kernel_tree('.')) { | |
167 | $root = '.'; | |
168 | } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && | |
169 | top_of_kernel_tree($1)) { | |
170 | $root = $1; | |
171 | } | |
172 | } | |
173 | ||
174 | if (!defined $root) { | |
175 | print "Must be run from the top-level dir. of a kernel tree\n"; | |
176 | exit(2); | |
177 | } | |
0a920b5b AW |
178 | } |
179 | ||
6c72ffaa AW |
180 | my $emitted_corrupt = 0; |
181 | ||
2ceb532b AW |
182 | our $Ident = qr{ |
183 | [A-Za-z_][A-Za-z\d_]* | |
184 | (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* | |
185 | }x; | |
6c72ffaa AW |
186 | our $Storage = qr{extern|static|asmlinkage}; |
187 | our $Sparse = qr{ | |
188 | __user| | |
189 | __kernel| | |
190 | __force| | |
191 | __iomem| | |
192 | __must_check| | |
193 | __init_refok| | |
417495ed | 194 | __kprobes| |
165e72a6 SE |
195 | __ref| |
196 | __rcu | |
6c72ffaa | 197 | }x; |
52131292 WS |
198 | |
199 | # Notes to $Attribute: | |
200 | # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check | |
6c72ffaa AW |
201 | our $Attribute = qr{ |
202 | const| | |
03f1df7d JP |
203 | __percpu| |
204 | __nocast| | |
205 | __safe| | |
206 | __bitwise__| | |
207 | __packed__| | |
208 | __packed2__| | |
209 | __naked| | |
210 | __maybe_unused| | |
211 | __always_unused| | |
212 | __noreturn| | |
213 | __used| | |
214 | __cold| | |
215 | __noclone| | |
216 | __deprecated| | |
6c72ffaa AW |
217 | __read_mostly| |
218 | __kprobes| | |
52131292 | 219 | __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)| |
24e1d81a AW |
220 | ____cacheline_aligned| |
221 | ____cacheline_aligned_in_smp| | |
5fe3af11 AW |
222 | ____cacheline_internodealigned_in_smp| |
223 | __weak | |
6c72ffaa | 224 | }x; |
c45dcabd | 225 | our $Modifier; |
6c72ffaa | 226 | our $Inline = qr{inline|__always_inline|noinline}; |
6c72ffaa AW |
227 | our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; |
228 | our $Lval = qr{$Ident(?:$Member)*}; | |
229 | ||
d7c76ba7 | 230 | our $Constant = qr{(?i:(?:[0-9]+|0x[0-9a-f]+)[ul]*)}; |
6c72ffaa | 231 | our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)}; |
86f9d059 | 232 | our $Compare = qr{<=|>=|==|!=|<|>}; |
6c72ffaa AW |
233 | our $Operators = qr{ |
234 | <=|>=|==|!=| | |
235 | =>|->|<<|>>|<|>|!|~| | |
c2fdda0d | 236 | &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% |
6c72ffaa AW |
237 | }x; |
238 | ||
8905a67c AW |
239 | our $NonptrType; |
240 | our $Type; | |
241 | our $Declare; | |
242 | ||
15662b3e JP |
243 | our $NON_ASCII_UTF8 = qr{ |
244 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte | |
171ae1a4 AW |
245 | | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs |
246 | | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte | |
247 | | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates | |
248 | | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 | |
249 | | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 | |
250 | | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 | |
251 | }x; | |
252 | ||
15662b3e JP |
253 | our $UTF8 = qr{ |
254 | [\x09\x0A\x0D\x20-\x7E] # ASCII | |
255 | | $NON_ASCII_UTF8 | |
256 | }x; | |
257 | ||
8ed22cad | 258 | our $typeTypedefs = qr{(?x: |
fb9e9096 | 259 | (?:__)?(?:u|s|be|le)(?:8|16|32|64)| |
8ed22cad AW |
260 | atomic_t |
261 | )}; | |
262 | ||
691e669b | 263 | our $logFunctions = qr{(?x: |
6e60c02e JP |
264 | printk(?:_ratelimited|_once|)| |
265 | [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| | |
266 | WARN(?:_RATELIMIT|_ONCE|)| | |
b0531722 JP |
267 | panic| |
268 | MODULE_[A-Z_]+ | |
691e669b JP |
269 | )}; |
270 | ||
20112475 JP |
271 | our $signature_tags = qr{(?xi: |
272 | Signed-off-by:| | |
273 | Acked-by:| | |
274 | Tested-by:| | |
275 | Reviewed-by:| | |
276 | Reported-by:| | |
277 | To:| | |
278 | Cc: | |
279 | )}; | |
280 | ||
8905a67c AW |
281 | our @typeList = ( |
282 | qr{void}, | |
c45dcabd AW |
283 | qr{(?:unsigned\s+)?char}, |
284 | qr{(?:unsigned\s+)?short}, | |
285 | qr{(?:unsigned\s+)?int}, | |
286 | qr{(?:unsigned\s+)?long}, | |
287 | qr{(?:unsigned\s+)?long\s+int}, | |
288 | qr{(?:unsigned\s+)?long\s+long}, | |
289 | qr{(?:unsigned\s+)?long\s+long\s+int}, | |
8905a67c AW |
290 | qr{unsigned}, |
291 | qr{float}, | |
292 | qr{double}, | |
293 | qr{bool}, | |
8905a67c AW |
294 | qr{struct\s+$Ident}, |
295 | qr{union\s+$Ident}, | |
296 | qr{enum\s+$Ident}, | |
297 | qr{${Ident}_t}, | |
298 | qr{${Ident}_handler}, | |
299 | qr{${Ident}_handler_fn}, | |
300 | ); | |
c45dcabd AW |
301 | our @modifierList = ( |
302 | qr{fastcall}, | |
303 | ); | |
8905a67c | 304 | |
7840a94c WS |
305 | our $allowed_asm_includes = qr{(?x: |
306 | irq| | |
307 | memory | |
308 | )}; | |
309 | # memory.h: ARM has a custom one | |
310 | ||
8905a67c | 311 | sub build_types { |
d2172eb5 AW |
312 | my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; |
313 | my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; | |
c8cb2ca3 | 314 | $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; |
8905a67c | 315 | $NonptrType = qr{ |
d2172eb5 | 316 | (?:$Modifier\s+|const\s+)* |
cf655043 | 317 | (?: |
6b48db24 | 318 | (?:typeof|__typeof__)\s*\([^\)]*\)| |
8ed22cad | 319 | (?:$typeTypedefs\b)| |
c45dcabd | 320 | (?:${all}\b) |
cf655043 | 321 | ) |
c8cb2ca3 | 322 | (?:\s+$Modifier|\s+const)* |
8905a67c AW |
323 | }x; |
324 | $Type = qr{ | |
c45dcabd | 325 | $NonptrType |
65863862 | 326 | (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)? |
c8cb2ca3 | 327 | (?:\s+$Inline|\s+$Modifier)* |
8905a67c AW |
328 | }x; |
329 | $Declare = qr{(?:$Storage\s+)?$Type}; | |
330 | } | |
331 | build_types(); | |
6c72ffaa | 332 | |
7d2367af JP |
333 | our $match_balanced_parentheses = qr/(\((?:[^\(\)]+|(-1))*\))/; |
334 | ||
335 | our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; | |
336 | our $LvalOrFunc = qr{($Lval)\s*($match_balanced_parentheses{0,1})\s*}; | |
d7c76ba7 | 337 | our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)}; |
7d2367af JP |
338 | |
339 | sub deparenthesize { | |
340 | my ($string) = @_; | |
341 | return "" if (!defined($string)); | |
342 | $string =~ s@^\s*\(\s*@@g; | |
343 | $string =~ s@\s*\)\s*$@@g; | |
344 | $string =~ s@\s+@ @g; | |
345 | return $string; | |
346 | } | |
347 | ||
6c72ffaa AW |
348 | $chk_signoff = 0 if ($file); |
349 | ||
4a0df2ef AW |
350 | my @dep_includes = (); |
351 | my @dep_functions = (); | |
6c72ffaa AW |
352 | my $removal = "Documentation/feature-removal-schedule.txt"; |
353 | if ($tree && -f "$root/$removal") { | |
21caa13c | 354 | open(my $REMOVE, '<', "$root/$removal") || |
6c72ffaa | 355 | die "$P: $removal: open failed - $!\n"; |
21caa13c | 356 | while (<$REMOVE>) { |
f0a594c1 AW |
357 | if (/^Check:\s+(.*\S)/) { |
358 | for my $entry (split(/[, ]+/, $1)) { | |
359 | if ($entry =~ m@include/(.*)@) { | |
4a0df2ef | 360 | push(@dep_includes, $1); |
4a0df2ef | 361 | |
f0a594c1 AW |
362 | } elsif ($entry !~ m@/@) { |
363 | push(@dep_functions, $entry); | |
364 | } | |
4a0df2ef | 365 | } |
0a920b5b AW |
366 | } |
367 | } | |
21caa13c | 368 | close($REMOVE); |
0a920b5b AW |
369 | } |
370 | ||
00df344f | 371 | my @rawlines = (); |
c2fdda0d AW |
372 | my @lines = (); |
373 | my $vname; | |
6c72ffaa | 374 | for my $filename (@ARGV) { |
21caa13c | 375 | my $FILE; |
6c72ffaa | 376 | if ($file) { |
21caa13c | 377 | open($FILE, '-|', "diff -u /dev/null $filename") || |
6c72ffaa | 378 | die "$P: $filename: diff failed - $!\n"; |
21caa13c AW |
379 | } elsif ($filename eq '-') { |
380 | open($FILE, '<&STDIN'); | |
6c72ffaa | 381 | } else { |
21caa13c | 382 | open($FILE, '<', "$filename") || |
6c72ffaa | 383 | die "$P: $filename: open failed - $!\n"; |
0a920b5b | 384 | } |
c2fdda0d AW |
385 | if ($filename eq '-') { |
386 | $vname = 'Your patch'; | |
387 | } else { | |
388 | $vname = $filename; | |
389 | } | |
21caa13c | 390 | while (<$FILE>) { |
6c72ffaa AW |
391 | chomp; |
392 | push(@rawlines, $_); | |
393 | } | |
21caa13c | 394 | close($FILE); |
c2fdda0d | 395 | if (!process($filename)) { |
6c72ffaa AW |
396 | $exit = 1; |
397 | } | |
398 | @rawlines = (); | |
13214adf | 399 | @lines = (); |
0a920b5b AW |
400 | } |
401 | ||
402 | exit($exit); | |
403 | ||
404 | sub top_of_kernel_tree { | |
6c72ffaa AW |
405 | my ($root) = @_; |
406 | ||
407 | my @tree_check = ( | |
408 | "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", | |
409 | "README", "Documentation", "arch", "include", "drivers", | |
410 | "fs", "init", "ipc", "kernel", "lib", "scripts", | |
411 | ); | |
412 | ||
413 | foreach my $check (@tree_check) { | |
414 | if (! -e $root . '/' . $check) { | |
415 | return 0; | |
416 | } | |
0a920b5b | 417 | } |
6c72ffaa | 418 | return 1; |
000d1cc1 | 419 | } |
0a920b5b | 420 | |
20112475 JP |
421 | sub parse_email { |
422 | my ($formatted_email) = @_; | |
423 | ||
424 | my $name = ""; | |
425 | my $address = ""; | |
426 | my $comment = ""; | |
427 | ||
428 | if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { | |
429 | $name = $1; | |
430 | $address = $2; | |
431 | $comment = $3 if defined $3; | |
432 | } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { | |
433 | $address = $1; | |
434 | $comment = $2 if defined $2; | |
435 | } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { | |
436 | $address = $1; | |
437 | $comment = $2 if defined $2; | |
438 | $formatted_email =~ s/$address.*$//; | |
439 | $name = $formatted_email; | |
440 | $name =~ s/^\s+|\s+$//g; | |
441 | $name =~ s/^\"|\"$//g; | |
442 | # If there's a name left after stripping spaces and | |
443 | # leading quotes, and the address doesn't have both | |
444 | # leading and trailing angle brackets, the address | |
445 | # is invalid. ie: | |
446 | # "joe smith joe@smith.com" bad | |
447 | # "joe smith <joe@smith.com" bad | |
448 | if ($name ne "" && $address !~ /^<[^>]+>$/) { | |
449 | $name = ""; | |
450 | $address = ""; | |
451 | $comment = ""; | |
452 | } | |
453 | } | |
454 | ||
455 | $name =~ s/^\s+|\s+$//g; | |
456 | $name =~ s/^\"|\"$//g; | |
457 | $address =~ s/^\s+|\s+$//g; | |
458 | $address =~ s/^\<|\>$//g; | |
459 | ||
460 | if ($name =~ /[^\w \-]/i) { ##has "must quote" chars | |
461 | $name =~ s/(?<!\\)"/\\"/g; ##escape quotes | |
462 | $name = "\"$name\""; | |
463 | } | |
464 | ||
465 | return ($name, $address, $comment); | |
466 | } | |
467 | ||
468 | sub format_email { | |
469 | my ($name, $address) = @_; | |
470 | ||
471 | my $formatted_email; | |
472 | ||
473 | $name =~ s/^\s+|\s+$//g; | |
474 | $name =~ s/^\"|\"$//g; | |
475 | $address =~ s/^\s+|\s+$//g; | |
476 | ||
477 | if ($name =~ /[^\w \-]/i) { ##has "must quote" chars | |
478 | $name =~ s/(?<!\\)"/\\"/g; ##escape quotes | |
479 | $name = "\"$name\""; | |
480 | } | |
481 | ||
482 | if ("$name" eq "") { | |
483 | $formatted_email = "$address"; | |
484 | } else { | |
485 | $formatted_email = "$name <$address>"; | |
486 | } | |
487 | ||
488 | return $formatted_email; | |
489 | } | |
490 | ||
000d1cc1 JP |
491 | sub which_conf { |
492 | my ($conf) = @_; | |
493 | ||
494 | foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { | |
495 | if (-e "$path/$conf") { | |
496 | return "$path/$conf"; | |
497 | } | |
498 | } | |
499 | ||
500 | return ""; | |
501 | } | |
502 | ||
0a920b5b AW |
503 | sub expand_tabs { |
504 | my ($str) = @_; | |
505 | ||
506 | my $res = ''; | |
507 | my $n = 0; | |
508 | for my $c (split(//, $str)) { | |
509 | if ($c eq "\t") { | |
510 | $res .= ' '; | |
511 | $n++; | |
512 | for (; ($n % 8) != 0; $n++) { | |
513 | $res .= ' '; | |
514 | } | |
515 | next; | |
516 | } | |
517 | $res .= $c; | |
518 | $n++; | |
519 | } | |
520 | ||
521 | return $res; | |
522 | } | |
6c72ffaa | 523 | sub copy_spacing { |
773647a0 | 524 | (my $res = shift) =~ tr/\t/ /c; |
6c72ffaa AW |
525 | return $res; |
526 | } | |
0a920b5b | 527 | |
4a0df2ef AW |
528 | sub line_stats { |
529 | my ($line) = @_; | |
530 | ||
531 | # Drop the diff line leader and expand tabs | |
532 | $line =~ s/^.//; | |
533 | $line = expand_tabs($line); | |
534 | ||
535 | # Pick the indent from the front of the line. | |
536 | my ($white) = ($line =~ /^(\s*)/); | |
537 | ||
538 | return (length($line), length($white)); | |
539 | } | |
540 | ||
773647a0 AW |
541 | my $sanitise_quote = ''; |
542 | ||
543 | sub sanitise_line_reset { | |
544 | my ($in_comment) = @_; | |
545 | ||
546 | if ($in_comment) { | |
547 | $sanitise_quote = '*/'; | |
548 | } else { | |
549 | $sanitise_quote = ''; | |
550 | } | |
551 | } | |
00df344f AW |
552 | sub sanitise_line { |
553 | my ($line) = @_; | |
554 | ||
555 | my $res = ''; | |
556 | my $l = ''; | |
557 | ||
c2fdda0d | 558 | my $qlen = 0; |
773647a0 AW |
559 | my $off = 0; |
560 | my $c; | |
00df344f | 561 | |
773647a0 AW |
562 | # Always copy over the diff marker. |
563 | $res = substr($line, 0, 1); | |
564 | ||
565 | for ($off = 1; $off < length($line); $off++) { | |
566 | $c = substr($line, $off, 1); | |
567 | ||
568 | # Comments we are wacking completly including the begin | |
569 | # and end, all to $;. | |
570 | if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { | |
571 | $sanitise_quote = '*/'; | |
572 | ||
573 | substr($res, $off, 2, "$;$;"); | |
574 | $off++; | |
575 | next; | |
00df344f | 576 | } |
81bc0e02 | 577 | if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { |
773647a0 AW |
578 | $sanitise_quote = ''; |
579 | substr($res, $off, 2, "$;$;"); | |
580 | $off++; | |
581 | next; | |
c2fdda0d | 582 | } |
113f04a8 DW |
583 | if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { |
584 | $sanitise_quote = '//'; | |
585 | ||
586 | substr($res, $off, 2, $sanitise_quote); | |
587 | $off++; | |
588 | next; | |
589 | } | |
773647a0 AW |
590 | |
591 | # A \ in a string means ignore the next character. | |
592 | if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && | |
593 | $c eq "\\") { | |
594 | substr($res, $off, 2, 'XX'); | |
595 | $off++; | |
596 | next; | |
00df344f | 597 | } |
773647a0 AW |
598 | # Regular quotes. |
599 | if ($c eq "'" || $c eq '"') { | |
600 | if ($sanitise_quote eq '') { | |
601 | $sanitise_quote = $c; | |
00df344f | 602 | |
773647a0 AW |
603 | substr($res, $off, 1, $c); |
604 | next; | |
605 | } elsif ($sanitise_quote eq $c) { | |
606 | $sanitise_quote = ''; | |
607 | } | |
608 | } | |
00df344f | 609 | |
fae17dae | 610 | #print "c<$c> SQ<$sanitise_quote>\n"; |
773647a0 AW |
611 | if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { |
612 | substr($res, $off, 1, $;); | |
113f04a8 DW |
613 | } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { |
614 | substr($res, $off, 1, $;); | |
773647a0 AW |
615 | } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { |
616 | substr($res, $off, 1, 'X'); | |
617 | } else { | |
618 | substr($res, $off, 1, $c); | |
619 | } | |
c2fdda0d AW |
620 | } |
621 | ||
113f04a8 DW |
622 | if ($sanitise_quote eq '//') { |
623 | $sanitise_quote = ''; | |
624 | } | |
625 | ||
c2fdda0d | 626 | # The pathname on a #include may be surrounded by '<' and '>'. |
c45dcabd | 627 | if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { |
c2fdda0d AW |
628 | my $clean = 'X' x length($1); |
629 | $res =~ s@\<.*\>@<$clean>@; | |
630 | ||
631 | # The whole of a #error is a string. | |
c45dcabd | 632 | } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { |
c2fdda0d | 633 | my $clean = 'X' x length($1); |
c45dcabd | 634 | $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; |
c2fdda0d AW |
635 | } |
636 | ||
00df344f AW |
637 | return $res; |
638 | } | |
639 | ||
8905a67c AW |
640 | sub ctx_statement_block { |
641 | my ($linenr, $remain, $off) = @_; | |
642 | my $line = $linenr - 1; | |
643 | my $blk = ''; | |
644 | my $soff = $off; | |
645 | my $coff = $off - 1; | |
773647a0 | 646 | my $coff_set = 0; |
8905a67c | 647 | |
13214adf AW |
648 | my $loff = 0; |
649 | ||
8905a67c AW |
650 | my $type = ''; |
651 | my $level = 0; | |
a2750645 | 652 | my @stack = (); |
cf655043 | 653 | my $p; |
8905a67c AW |
654 | my $c; |
655 | my $len = 0; | |
13214adf AW |
656 | |
657 | my $remainder; | |
8905a67c | 658 | while (1) { |
a2750645 AW |
659 | @stack = (['', 0]) if ($#stack == -1); |
660 | ||
773647a0 | 661 | #warn "CSB: blk<$blk> remain<$remain>\n"; |
8905a67c AW |
662 | # If we are about to drop off the end, pull in more |
663 | # context. | |
664 | if ($off >= $len) { | |
665 | for (; $remain > 0; $line++) { | |
dea33496 | 666 | last if (!defined $lines[$line]); |
c2fdda0d | 667 | next if ($lines[$line] =~ /^-/); |
8905a67c | 668 | $remain--; |
13214adf | 669 | $loff = $len; |
c2fdda0d | 670 | $blk .= $lines[$line] . "\n"; |
8905a67c AW |
671 | $len = length($blk); |
672 | $line++; | |
673 | last; | |
674 | } | |
675 | # Bail if there is no further context. | |
676 | #warn "CSB: blk<$blk> off<$off> len<$len>\n"; | |
13214adf | 677 | if ($off >= $len) { |
8905a67c AW |
678 | last; |
679 | } | |
f74bd194 AW |
680 | if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { |
681 | $level++; | |
682 | $type = '#'; | |
683 | } | |
8905a67c | 684 | } |
cf655043 | 685 | $p = $c; |
8905a67c | 686 | $c = substr($blk, $off, 1); |
13214adf | 687 | $remainder = substr($blk, $off); |
8905a67c | 688 | |
773647a0 | 689 | #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; |
4635f4fb AW |
690 | |
691 | # Handle nested #if/#else. | |
692 | if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { | |
693 | push(@stack, [ $type, $level ]); | |
694 | } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { | |
695 | ($type, $level) = @{$stack[$#stack - 1]}; | |
696 | } elsif ($remainder =~ /^#\s*endif\b/) { | |
697 | ($type, $level) = @{pop(@stack)}; | |
698 | } | |
699 | ||
8905a67c AW |
700 | # Statement ends at the ';' or a close '}' at the |
701 | # outermost level. | |
702 | if ($level == 0 && $c eq ';') { | |
703 | last; | |
704 | } | |
705 | ||
13214adf | 706 | # An else is really a conditional as long as its not else if |
773647a0 AW |
707 | if ($level == 0 && $coff_set == 0 && |
708 | (!defined($p) || $p =~ /(?:\s|\}|\+)/) && | |
709 | $remainder =~ /^(else)(?:\s|{)/ && | |
710 | $remainder !~ /^else\s+if\b/) { | |
711 | $coff = $off + length($1) - 1; | |
712 | $coff_set = 1; | |
713 | #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; | |
714 | #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; | |
13214adf AW |
715 | } |
716 | ||
8905a67c AW |
717 | if (($type eq '' || $type eq '(') && $c eq '(') { |
718 | $level++; | |
719 | $type = '('; | |
720 | } | |
721 | if ($type eq '(' && $c eq ')') { | |
722 | $level--; | |
723 | $type = ($level != 0)? '(' : ''; | |
724 | ||
725 | if ($level == 0 && $coff < $soff) { | |
726 | $coff = $off; | |
773647a0 AW |
727 | $coff_set = 1; |
728 | #warn "CSB: mark coff<$coff>\n"; | |
8905a67c AW |
729 | } |
730 | } | |
731 | if (($type eq '' || $type eq '{') && $c eq '{') { | |
732 | $level++; | |
733 | $type = '{'; | |
734 | } | |
735 | if ($type eq '{' && $c eq '}') { | |
736 | $level--; | |
737 | $type = ($level != 0)? '{' : ''; | |
738 | ||
739 | if ($level == 0) { | |
b998e001 PP |
740 | if (substr($blk, $off + 1, 1) eq ';') { |
741 | $off++; | |
742 | } | |
8905a67c AW |
743 | last; |
744 | } | |
745 | } | |
f74bd194 AW |
746 | # Preprocessor commands end at the newline unless escaped. |
747 | if ($type eq '#' && $c eq "\n" && $p ne "\\") { | |
748 | $level--; | |
749 | $type = ''; | |
750 | $off++; | |
751 | last; | |
752 | } | |
8905a67c AW |
753 | $off++; |
754 | } | |
a3bb97a7 | 755 | # We are truly at the end, so shuffle to the next line. |
13214adf | 756 | if ($off == $len) { |
a3bb97a7 | 757 | $loff = $len + 1; |
13214adf AW |
758 | $line++; |
759 | $remain--; | |
760 | } | |
8905a67c AW |
761 | |
762 | my $statement = substr($blk, $soff, $off - $soff + 1); | |
763 | my $condition = substr($blk, $soff, $coff - $soff + 1); | |
764 | ||
765 | #warn "STATEMENT<$statement>\n"; | |
766 | #warn "CONDITION<$condition>\n"; | |
767 | ||
773647a0 | 768 | #print "coff<$coff> soff<$off> loff<$loff>\n"; |
13214adf AW |
769 | |
770 | return ($statement, $condition, | |
771 | $line, $remain + 1, $off - $loff + 1, $level); | |
772 | } | |
773 | ||
cf655043 AW |
774 | sub statement_lines { |
775 | my ($stmt) = @_; | |
776 | ||
777 | # Strip the diff line prefixes and rip blank lines at start and end. | |
778 | $stmt =~ s/(^|\n)./$1/g; | |
779 | $stmt =~ s/^\s*//; | |
780 | $stmt =~ s/\s*$//; | |
781 | ||
782 | my @stmt_lines = ($stmt =~ /\n/g); | |
783 | ||
784 | return $#stmt_lines + 2; | |
785 | } | |
786 | ||
787 | sub statement_rawlines { | |
788 | my ($stmt) = @_; | |
789 | ||
790 | my @stmt_lines = ($stmt =~ /\n/g); | |
791 | ||
792 | return $#stmt_lines + 2; | |
793 | } | |
794 | ||
795 | sub statement_block_size { | |
796 | my ($stmt) = @_; | |
797 | ||
798 | $stmt =~ s/(^|\n)./$1/g; | |
799 | $stmt =~ s/^\s*{//; | |
800 | $stmt =~ s/}\s*$//; | |
801 | $stmt =~ s/^\s*//; | |
802 | $stmt =~ s/\s*$//; | |
803 | ||
804 | my @stmt_lines = ($stmt =~ /\n/g); | |
805 | my @stmt_statements = ($stmt =~ /;/g); | |
806 | ||
807 | my $stmt_lines = $#stmt_lines + 2; | |
808 | my $stmt_statements = $#stmt_statements + 1; | |
809 | ||
810 | if ($stmt_lines > $stmt_statements) { | |
811 | return $stmt_lines; | |
812 | } else { | |
813 | return $stmt_statements; | |
814 | } | |
815 | } | |
816 | ||
13214adf AW |
817 | sub ctx_statement_full { |
818 | my ($linenr, $remain, $off) = @_; | |
819 | my ($statement, $condition, $level); | |
820 | ||
821 | my (@chunks); | |
822 | ||
cf655043 | 823 | # Grab the first conditional/block pair. |
13214adf AW |
824 | ($statement, $condition, $linenr, $remain, $off, $level) = |
825 | ctx_statement_block($linenr, $remain, $off); | |
773647a0 | 826 | #print "F: c<$condition> s<$statement> remain<$remain>\n"; |
cf655043 AW |
827 | push(@chunks, [ $condition, $statement ]); |
828 | if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { | |
829 | return ($level, $linenr, @chunks); | |
830 | } | |
831 | ||
832 | # Pull in the following conditional/block pairs and see if they | |
833 | # could continue the statement. | |
13214adf | 834 | for (;;) { |
13214adf AW |
835 | ($statement, $condition, $linenr, $remain, $off, $level) = |
836 | ctx_statement_block($linenr, $remain, $off); | |
cf655043 | 837 | #print "C: c<$condition> s<$statement> remain<$remain>\n"; |
773647a0 | 838 | last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); |
cf655043 AW |
839 | #print "C: push\n"; |
840 | push(@chunks, [ $condition, $statement ]); | |
13214adf AW |
841 | } |
842 | ||
843 | return ($level, $linenr, @chunks); | |
8905a67c AW |
844 | } |
845 | ||
4a0df2ef | 846 | sub ctx_block_get { |
f0a594c1 | 847 | my ($linenr, $remain, $outer, $open, $close, $off) = @_; |
4a0df2ef AW |
848 | my $line; |
849 | my $start = $linenr - 1; | |
4a0df2ef AW |
850 | my $blk = ''; |
851 | my @o; | |
852 | my @c; | |
853 | my @res = (); | |
854 | ||
f0a594c1 | 855 | my $level = 0; |
4635f4fb | 856 | my @stack = ($level); |
00df344f AW |
857 | for ($line = $start; $remain > 0; $line++) { |
858 | next if ($rawlines[$line] =~ /^-/); | |
859 | $remain--; | |
860 | ||
861 | $blk .= $rawlines[$line]; | |
4635f4fb AW |
862 | |
863 | # Handle nested #if/#else. | |
01464f30 | 864 | if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { |
4635f4fb | 865 | push(@stack, $level); |
01464f30 | 866 | } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { |
4635f4fb | 867 | $level = $stack[$#stack - 1]; |
01464f30 | 868 | } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { |
4635f4fb AW |
869 | $level = pop(@stack); |
870 | } | |
871 | ||
01464f30 | 872 | foreach my $c (split(//, $lines[$line])) { |
f0a594c1 AW |
873 | ##print "C<$c>L<$level><$open$close>O<$off>\n"; |
874 | if ($off > 0) { | |
875 | $off--; | |
876 | next; | |
877 | } | |
4a0df2ef | 878 | |
f0a594c1 AW |
879 | if ($c eq $close && $level > 0) { |
880 | $level--; | |
881 | last if ($level == 0); | |
882 | } elsif ($c eq $open) { | |
883 | $level++; | |
884 | } | |
885 | } | |
4a0df2ef | 886 | |
f0a594c1 | 887 | if (!$outer || $level <= 1) { |
00df344f | 888 | push(@res, $rawlines[$line]); |
4a0df2ef AW |
889 | } |
890 | ||
f0a594c1 | 891 | last if ($level == 0); |
4a0df2ef AW |
892 | } |
893 | ||
f0a594c1 | 894 | return ($level, @res); |
4a0df2ef AW |
895 | } |
896 | sub ctx_block_outer { | |
897 | my ($linenr, $remain) = @_; | |
898 | ||
f0a594c1 AW |
899 | my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); |
900 | return @r; | |
4a0df2ef AW |
901 | } |
902 | sub ctx_block { | |
903 | my ($linenr, $remain) = @_; | |
904 | ||
f0a594c1 AW |
905 | my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); |
906 | return @r; | |
653d4876 AW |
907 | } |
908 | sub ctx_statement { | |
f0a594c1 AW |
909 | my ($linenr, $remain, $off) = @_; |
910 | ||
911 | my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); | |
912 | return @r; | |
913 | } | |
914 | sub ctx_block_level { | |
653d4876 AW |
915 | my ($linenr, $remain) = @_; |
916 | ||
f0a594c1 | 917 | return ctx_block_get($linenr, $remain, 0, '{', '}', 0); |
4a0df2ef | 918 | } |
9c0ca6f9 AW |
919 | sub ctx_statement_level { |
920 | my ($linenr, $remain, $off) = @_; | |
921 | ||
922 | return ctx_block_get($linenr, $remain, 0, '(', ')', $off); | |
923 | } | |
4a0df2ef AW |
924 | |
925 | sub ctx_locate_comment { | |
926 | my ($first_line, $end_line) = @_; | |
927 | ||
928 | # Catch a comment on the end of the line itself. | |
beae6332 | 929 | my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); |
4a0df2ef AW |
930 | return $current_comment if (defined $current_comment); |
931 | ||
932 | # Look through the context and try and figure out if there is a | |
933 | # comment. | |
934 | my $in_comment = 0; | |
935 | $current_comment = ''; | |
936 | for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { | |
00df344f AW |
937 | my $line = $rawlines[$linenr - 1]; |
938 | #warn " $line\n"; | |
4a0df2ef AW |
939 | if ($linenr == $first_line and $line =~ m@^.\s*\*@) { |
940 | $in_comment = 1; | |
941 | } | |
942 | if ($line =~ m@/\*@) { | |
943 | $in_comment = 1; | |
944 | } | |
945 | if (!$in_comment && $current_comment ne '') { | |
946 | $current_comment = ''; | |
947 | } | |
948 | $current_comment .= $line . "\n" if ($in_comment); | |
949 | if ($line =~ m@\*/@) { | |
950 | $in_comment = 0; | |
951 | } | |
952 | } | |
953 | ||
954 | chomp($current_comment); | |
955 | return($current_comment); | |
956 | } | |
957 | sub ctx_has_comment { | |
958 | my ($first_line, $end_line) = @_; | |
959 | my $cmt = ctx_locate_comment($first_line, $end_line); | |
960 | ||
00df344f | 961 | ##print "LINE: $rawlines[$end_line - 1 ]\n"; |
4a0df2ef AW |
962 | ##print "CMMT: $cmt\n"; |
963 | ||
964 | return ($cmt ne ''); | |
965 | } | |
966 | ||
4d001e4d AW |
967 | sub raw_line { |
968 | my ($linenr, $cnt) = @_; | |
969 | ||
970 | my $offset = $linenr - 1; | |
971 | $cnt++; | |
972 | ||
973 | my $line; | |
974 | while ($cnt) { | |
975 | $line = $rawlines[$offset++]; | |
976 | next if (defined($line) && $line =~ /^-/); | |
977 | $cnt--; | |
978 | } | |
979 | ||
980 | return $line; | |
981 | } | |
982 | ||
6c72ffaa AW |
983 | sub cat_vet { |
984 | my ($vet) = @_; | |
985 | my ($res, $coded); | |
9c0ca6f9 | 986 | |
6c72ffaa AW |
987 | $res = ''; |
988 | while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { | |
989 | $res .= $1; | |
990 | if ($2 ne '') { | |
991 | $coded = sprintf("^%c", unpack('C', $2) + 64); | |
992 | $res .= $coded; | |
9c0ca6f9 AW |
993 | } |
994 | } | |
6c72ffaa | 995 | $res =~ s/$/\$/; |
9c0ca6f9 | 996 | |
6c72ffaa | 997 | return $res; |
9c0ca6f9 AW |
998 | } |
999 | ||
c2fdda0d | 1000 | my $av_preprocessor = 0; |
cf655043 | 1001 | my $av_pending; |
c2fdda0d | 1002 | my @av_paren_type; |
1f65f947 | 1003 | my $av_pend_colon; |
c2fdda0d AW |
1004 | |
1005 | sub annotate_reset { | |
1006 | $av_preprocessor = 0; | |
cf655043 AW |
1007 | $av_pending = '_'; |
1008 | @av_paren_type = ('E'); | |
1f65f947 | 1009 | $av_pend_colon = 'O'; |
c2fdda0d AW |
1010 | } |
1011 | ||
6c72ffaa AW |
1012 | sub annotate_values { |
1013 | my ($stream, $type) = @_; | |
0a920b5b | 1014 | |
6c72ffaa | 1015 | my $res; |
1f65f947 | 1016 | my $var = '_' x length($stream); |
6c72ffaa AW |
1017 | my $cur = $stream; |
1018 | ||
c2fdda0d | 1019 | print "$stream\n" if ($dbg_values > 1); |
6c72ffaa | 1020 | |
6c72ffaa | 1021 | while (length($cur)) { |
773647a0 | 1022 | @av_paren_type = ('E') if ($#av_paren_type < 0); |
cf655043 | 1023 | print " <" . join('', @av_paren_type) . |
171ae1a4 | 1024 | "> <$type> <$av_pending>" if ($dbg_values > 1); |
6c72ffaa | 1025 | if ($cur =~ /^(\s+)/o) { |
c2fdda0d AW |
1026 | print "WS($1)\n" if ($dbg_values > 1); |
1027 | if ($1 =~ /\n/ && $av_preprocessor) { | |
cf655043 | 1028 | $type = pop(@av_paren_type); |
c2fdda0d | 1029 | $av_preprocessor = 0; |
6c72ffaa AW |
1030 | } |
1031 | ||
c023e473 | 1032 | } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { |
9446ef56 AW |
1033 | print "CAST($1)\n" if ($dbg_values > 1); |
1034 | push(@av_paren_type, $type); | |
addcdcea | 1035 | $type = 'c'; |
9446ef56 | 1036 | |
e91b6e26 | 1037 | } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { |
c2fdda0d | 1038 | print "DECLARE($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
1039 | $type = 'T'; |
1040 | ||
389a2fe5 AW |
1041 | } elsif ($cur =~ /^($Modifier)\s*/) { |
1042 | print "MODIFIER($1)\n" if ($dbg_values > 1); | |
1043 | $type = 'T'; | |
1044 | ||
c45dcabd | 1045 | } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { |
171ae1a4 | 1046 | print "DEFINE($1,$2)\n" if ($dbg_values > 1); |
c2fdda0d | 1047 | $av_preprocessor = 1; |
171ae1a4 AW |
1048 | push(@av_paren_type, $type); |
1049 | if ($2 ne '') { | |
1050 | $av_pending = 'N'; | |
1051 | } | |
1052 | $type = 'E'; | |
1053 | ||
c45dcabd | 1054 | } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { |
171ae1a4 AW |
1055 | print "UNDEF($1)\n" if ($dbg_values > 1); |
1056 | $av_preprocessor = 1; | |
1057 | push(@av_paren_type, $type); | |
6c72ffaa | 1058 | |
c45dcabd | 1059 | } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { |
cf655043 | 1060 | print "PRE_START($1)\n" if ($dbg_values > 1); |
c2fdda0d | 1061 | $av_preprocessor = 1; |
cf655043 AW |
1062 | |
1063 | push(@av_paren_type, $type); | |
1064 | push(@av_paren_type, $type); | |
171ae1a4 | 1065 | $type = 'E'; |
cf655043 | 1066 | |
c45dcabd | 1067 | } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { |
cf655043 AW |
1068 | print "PRE_RESTART($1)\n" if ($dbg_values > 1); |
1069 | $av_preprocessor = 1; | |
1070 | ||
1071 | push(@av_paren_type, $av_paren_type[$#av_paren_type]); | |
1072 | ||
171ae1a4 | 1073 | $type = 'E'; |
cf655043 | 1074 | |
c45dcabd | 1075 | } elsif ($cur =~ /^(\#\s*(?:endif))/o) { |
cf655043 AW |
1076 | print "PRE_END($1)\n" if ($dbg_values > 1); |
1077 | ||
1078 | $av_preprocessor = 1; | |
1079 | ||
1080 | # Assume all arms of the conditional end as this | |
1081 | # one does, and continue as if the #endif was not here. | |
1082 | pop(@av_paren_type); | |
1083 | push(@av_paren_type, $type); | |
171ae1a4 | 1084 | $type = 'E'; |
6c72ffaa AW |
1085 | |
1086 | } elsif ($cur =~ /^(\\\n)/o) { | |
c2fdda0d | 1087 | print "PRECONT($1)\n" if ($dbg_values > 1); |
6c72ffaa | 1088 | |
171ae1a4 AW |
1089 | } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { |
1090 | print "ATTR($1)\n" if ($dbg_values > 1); | |
1091 | $av_pending = $type; | |
1092 | $type = 'N'; | |
1093 | ||
6c72ffaa | 1094 | } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { |
c2fdda0d | 1095 | print "SIZEOF($1)\n" if ($dbg_values > 1); |
6c72ffaa | 1096 | if (defined $2) { |
cf655043 | 1097 | $av_pending = 'V'; |
6c72ffaa AW |
1098 | } |
1099 | $type = 'N'; | |
1100 | ||
14b111c1 | 1101 | } elsif ($cur =~ /^(if|while|for)\b/o) { |
c2fdda0d | 1102 | print "COND($1)\n" if ($dbg_values > 1); |
14b111c1 | 1103 | $av_pending = 'E'; |
6c72ffaa AW |
1104 | $type = 'N'; |
1105 | ||
1f65f947 AW |
1106 | } elsif ($cur =~/^(case)/o) { |
1107 | print "CASE($1)\n" if ($dbg_values > 1); | |
1108 | $av_pend_colon = 'C'; | |
1109 | $type = 'N'; | |
1110 | ||
14b111c1 | 1111 | } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { |
c2fdda0d | 1112 | print "KEYWORD($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
1113 | $type = 'N'; |
1114 | ||
1115 | } elsif ($cur =~ /^(\()/o) { | |
c2fdda0d | 1116 | print "PAREN('$1')\n" if ($dbg_values > 1); |
cf655043 AW |
1117 | push(@av_paren_type, $av_pending); |
1118 | $av_pending = '_'; | |
6c72ffaa AW |
1119 | $type = 'N'; |
1120 | ||
1121 | } elsif ($cur =~ /^(\))/o) { | |
cf655043 AW |
1122 | my $new_type = pop(@av_paren_type); |
1123 | if ($new_type ne '_') { | |
1124 | $type = $new_type; | |
c2fdda0d AW |
1125 | print "PAREN('$1') -> $type\n" |
1126 | if ($dbg_values > 1); | |
6c72ffaa | 1127 | } else { |
c2fdda0d | 1128 | print "PAREN('$1')\n" if ($dbg_values > 1); |
6c72ffaa AW |
1129 | } |
1130 | ||
c8cb2ca3 | 1131 | } elsif ($cur =~ /^($Ident)\s*\(/o) { |
c2fdda0d | 1132 | print "FUNC($1)\n" if ($dbg_values > 1); |
c8cb2ca3 | 1133 | $type = 'V'; |
cf655043 | 1134 | $av_pending = 'V'; |
6c72ffaa | 1135 | |
8e761b04 AW |
1136 | } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { |
1137 | if (defined $2 && $type eq 'C' || $type eq 'T') { | |
1f65f947 | 1138 | $av_pend_colon = 'B'; |
8e761b04 AW |
1139 | } elsif ($type eq 'E') { |
1140 | $av_pend_colon = 'L'; | |
1f65f947 AW |
1141 | } |
1142 | print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); | |
1143 | $type = 'V'; | |
1144 | ||
6c72ffaa | 1145 | } elsif ($cur =~ /^($Ident|$Constant)/o) { |
c2fdda0d | 1146 | print "IDENT($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
1147 | $type = 'V'; |
1148 | ||
1149 | } elsif ($cur =~ /^($Assignment)/o) { | |
c2fdda0d | 1150 | print "ASSIGN($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
1151 | $type = 'N'; |
1152 | ||
cf655043 | 1153 | } elsif ($cur =~/^(;|{|})/) { |
c2fdda0d | 1154 | print "END($1)\n" if ($dbg_values > 1); |
13214adf | 1155 | $type = 'E'; |
1f65f947 AW |
1156 | $av_pend_colon = 'O'; |
1157 | ||
8e761b04 AW |
1158 | } elsif ($cur =~/^(,)/) { |
1159 | print "COMMA($1)\n" if ($dbg_values > 1); | |
1160 | $type = 'C'; | |
1161 | ||
1f65f947 AW |
1162 | } elsif ($cur =~ /^(\?)/o) { |
1163 | print "QUESTION($1)\n" if ($dbg_values > 1); | |
1164 | $type = 'N'; | |
1165 | ||
1166 | } elsif ($cur =~ /^(:)/o) { | |
1167 | print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); | |
1168 | ||
1169 | substr($var, length($res), 1, $av_pend_colon); | |
1170 | if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { | |
1171 | $type = 'E'; | |
1172 | } else { | |
1173 | $type = 'N'; | |
1174 | } | |
1175 | $av_pend_colon = 'O'; | |
13214adf | 1176 | |
8e761b04 | 1177 | } elsif ($cur =~ /^(\[)/o) { |
13214adf | 1178 | print "CLOSE($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
1179 | $type = 'N'; |
1180 | ||
0d413866 | 1181 | } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { |
74048ed8 AW |
1182 | my $variant; |
1183 | ||
1184 | print "OPV($1)\n" if ($dbg_values > 1); | |
1185 | if ($type eq 'V') { | |
1186 | $variant = 'B'; | |
1187 | } else { | |
1188 | $variant = 'U'; | |
1189 | } | |
1190 | ||
1191 | substr($var, length($res), 1, $variant); | |
1192 | $type = 'N'; | |
1193 | ||
6c72ffaa | 1194 | } elsif ($cur =~ /^($Operators)/o) { |
c2fdda0d | 1195 | print "OP($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
1196 | if ($1 ne '++' && $1 ne '--') { |
1197 | $type = 'N'; | |
1198 | } | |
1199 | ||
1200 | } elsif ($cur =~ /(^.)/o) { | |
c2fdda0d | 1201 | print "C($1)\n" if ($dbg_values > 1); |
6c72ffaa AW |
1202 | } |
1203 | if (defined $1) { | |
1204 | $cur = substr($cur, length($1)); | |
1205 | $res .= $type x length($1); | |
1206 | } | |
9c0ca6f9 | 1207 | } |
0a920b5b | 1208 | |
1f65f947 | 1209 | return ($res, $var); |
0a920b5b AW |
1210 | } |
1211 | ||
8905a67c | 1212 | sub possible { |
13214adf | 1213 | my ($possible, $line) = @_; |
9a974fdb | 1214 | my $notPermitted = qr{(?: |
0776e594 AW |
1215 | ^(?: |
1216 | $Modifier| | |
1217 | $Storage| | |
1218 | $Type| | |
9a974fdb AW |
1219 | DEFINE_\S+ |
1220 | )$| | |
1221 | ^(?: | |
0776e594 AW |
1222 | goto| |
1223 | return| | |
1224 | case| | |
1225 | else| | |
1226 | asm|__asm__| | |
89a88353 AW |
1227 | do| |
1228 | \#| | |
1229 | \#\#| | |
9a974fdb | 1230 | )(?:\s|$)| |
0776e594 | 1231 | ^(?:typedef|struct|enum)\b |
9a974fdb AW |
1232 | )}x; |
1233 | warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); | |
1234 | if ($possible !~ $notPermitted) { | |
c45dcabd AW |
1235 | # Check for modifiers. |
1236 | $possible =~ s/\s*$Storage\s*//g; | |
1237 | $possible =~ s/\s*$Sparse\s*//g; | |
1238 | if ($possible =~ /^\s*$/) { | |
1239 | ||
1240 | } elsif ($possible =~ /\s/) { | |
1241 | $possible =~ s/\s*$Type\s*//g; | |
d2506586 | 1242 | for my $modifier (split(' ', $possible)) { |
9a974fdb AW |
1243 | if ($modifier !~ $notPermitted) { |
1244 | warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); | |
1245 | push(@modifierList, $modifier); | |
1246 | } | |
d2506586 | 1247 | } |
c45dcabd AW |
1248 | |
1249 | } else { | |
1250 | warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); | |
1251 | push(@typeList, $possible); | |
1252 | } | |
8905a67c | 1253 | build_types(); |
0776e594 AW |
1254 | } else { |
1255 | warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); | |
8905a67c AW |
1256 | } |
1257 | } | |
1258 | ||
6c72ffaa AW |
1259 | my $prefix = ''; |
1260 | ||
000d1cc1 JP |
1261 | sub show_type { |
1262 | return !defined $ignore_type{$_[0]}; | |
1263 | } | |
1264 | ||
f0a594c1 | 1265 | sub report { |
000d1cc1 JP |
1266 | if (!show_type($_[1]) || |
1267 | (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) { | |
773647a0 AW |
1268 | return 0; |
1269 | } | |
000d1cc1 JP |
1270 | my $line; |
1271 | if ($show_types) { | |
1272 | $line = "$prefix$_[0]:$_[1]: $_[2]\n"; | |
1273 | } else { | |
1274 | $line = "$prefix$_[0]: $_[2]\n"; | |
1275 | } | |
8905a67c AW |
1276 | $line = (split('\n', $line))[0] . "\n" if ($terse); |
1277 | ||
13214adf | 1278 | push(our @report, $line); |
773647a0 AW |
1279 | |
1280 | return 1; | |
f0a594c1 AW |
1281 | } |
1282 | sub report_dump { | |
13214adf | 1283 | our @report; |
f0a594c1 | 1284 | } |
000d1cc1 | 1285 | |
de7d4f0e | 1286 | sub ERROR { |
000d1cc1 | 1287 | if (report("ERROR", $_[0], $_[1])) { |
773647a0 AW |
1288 | our $clean = 0; |
1289 | our $cnt_error++; | |
1290 | } | |
de7d4f0e AW |
1291 | } |
1292 | sub WARN { | |
000d1cc1 | 1293 | if (report("WARNING", $_[0], $_[1])) { |
773647a0 AW |
1294 | our $clean = 0; |
1295 | our $cnt_warn++; | |
1296 | } | |
de7d4f0e AW |
1297 | } |
1298 | sub CHK { | |
000d1cc1 | 1299 | if ($check && report("CHECK", $_[0], $_[1])) { |
6c72ffaa AW |
1300 | our $clean = 0; |
1301 | our $cnt_chk++; | |
1302 | } | |
de7d4f0e AW |
1303 | } |
1304 | ||
6ecd9674 AW |
1305 | sub check_absolute_file { |
1306 | my ($absolute, $herecurr) = @_; | |
1307 | my $file = $absolute; | |
1308 | ||
1309 | ##print "absolute<$absolute>\n"; | |
1310 | ||
1311 | # See if any suffix of this path is a path within the tree. | |
1312 | while ($file =~ s@^[^/]*/@@) { | |
1313 | if (-f "$root/$file") { | |
1314 | ##print "file<$file>\n"; | |
1315 | last; | |
1316 | } | |
1317 | } | |
1318 | if (! -f _) { | |
1319 | return 0; | |
1320 | } | |
1321 | ||
1322 | # It is, so see if the prefix is acceptable. | |
1323 | my $prefix = $absolute; | |
1324 | substr($prefix, -length($file)) = ''; | |
1325 | ||
1326 | ##print "prefix<$prefix>\n"; | |
1327 | if ($prefix ne ".../") { | |
000d1cc1 JP |
1328 | WARN("USE_RELATIVE_PATH", |
1329 | "use relative pathname instead of absolute in changelog text\n" . $herecurr); | |
6ecd9674 AW |
1330 | } |
1331 | } | |
1332 | ||
0a920b5b AW |
1333 | sub process { |
1334 | my $filename = shift; | |
0a920b5b AW |
1335 | |
1336 | my $linenr=0; | |
1337 | my $prevline=""; | |
c2fdda0d | 1338 | my $prevrawline=""; |
0a920b5b | 1339 | my $stashline=""; |
c2fdda0d | 1340 | my $stashrawline=""; |
0a920b5b | 1341 | |
4a0df2ef | 1342 | my $length; |
0a920b5b AW |
1343 | my $indent; |
1344 | my $previndent=0; | |
1345 | my $stashindent=0; | |
1346 | ||
de7d4f0e | 1347 | our $clean = 1; |
0a920b5b AW |
1348 | my $signoff = 0; |
1349 | my $is_patch = 0; | |
1350 | ||
15662b3e JP |
1351 | my $in_header_lines = 1; |
1352 | my $in_commit_log = 0; #Scanning lines before patch | |
1353 | ||
13214adf | 1354 | our @report = (); |
6c72ffaa AW |
1355 | our $cnt_lines = 0; |
1356 | our $cnt_error = 0; | |
1357 | our $cnt_warn = 0; | |
1358 | our $cnt_chk = 0; | |
1359 | ||
0a920b5b AW |
1360 | # Trace the real file/line as we go. |
1361 | my $realfile = ''; | |
1362 | my $realline = 0; | |
1363 | my $realcnt = 0; | |
1364 | my $here = ''; | |
1365 | my $in_comment = 0; | |
c2fdda0d | 1366 | my $comment_edge = 0; |
0a920b5b | 1367 | my $first_line = 0; |
1e855726 | 1368 | my $p1_prefix = ''; |
0a920b5b | 1369 | |
13214adf AW |
1370 | my $prev_values = 'E'; |
1371 | ||
1372 | # suppression flags | |
773647a0 | 1373 | my %suppress_ifbraces; |
170d3a22 | 1374 | my %suppress_whiletrailers; |
2b474a1a | 1375 | my %suppress_export; |
3e469cdc | 1376 | my $suppress_statement = 0; |
653d4876 | 1377 | |
c2fdda0d | 1378 | # Pre-scan the patch sanitizing the lines. |
de7d4f0e | 1379 | # Pre-scan the patch looking for any __setup documentation. |
c2fdda0d | 1380 | # |
de7d4f0e AW |
1381 | my @setup_docs = (); |
1382 | my $setup_docs = 0; | |
773647a0 AW |
1383 | |
1384 | sanitise_line_reset(); | |
c2fdda0d AW |
1385 | my $line; |
1386 | foreach my $rawline (@rawlines) { | |
773647a0 AW |
1387 | $linenr++; |
1388 | $line = $rawline; | |
c2fdda0d | 1389 | |
773647a0 | 1390 | if ($rawline=~/^\+\+\+\s+(\S+)/) { |
de7d4f0e AW |
1391 | $setup_docs = 0; |
1392 | if ($1 =~ m@Documentation/kernel-parameters.txt$@) { | |
1393 | $setup_docs = 1; | |
1394 | } | |
773647a0 AW |
1395 | #next; |
1396 | } | |
1397 | if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { | |
1398 | $realline=$1-1; | |
1399 | if (defined $2) { | |
1400 | $realcnt=$3+1; | |
1401 | } else { | |
1402 | $realcnt=1+1; | |
1403 | } | |
c45dcabd | 1404 | $in_comment = 0; |
773647a0 AW |
1405 | |
1406 | # Guestimate if this is a continuing comment. Run | |
1407 | # the context looking for a comment "edge". If this | |
1408 | # edge is a close comment then we must be in a comment | |
1409 | # at context start. | |
1410 | my $edge; | |
01fa9147 AW |
1411 | my $cnt = $realcnt; |
1412 | for (my $ln = $linenr + 1; $cnt > 0; $ln++) { | |
1413 | next if (defined $rawlines[$ln - 1] && | |
1414 | $rawlines[$ln - 1] =~ /^-/); | |
1415 | $cnt--; | |
1416 | #print "RAW<$rawlines[$ln - 1]>\n"; | |
721c1cb6 | 1417 | last if (!defined $rawlines[$ln - 1]); |
fae17dae AW |
1418 | if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && |
1419 | $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { | |
1420 | ($edge) = $1; | |
1421 | last; | |
1422 | } | |
773647a0 AW |
1423 | } |
1424 | if (defined $edge && $edge eq '*/') { | |
1425 | $in_comment = 1; | |
1426 | } | |
1427 | ||
1428 | # Guestimate if this is a continuing comment. If this | |
1429 | # is the start of a diff block and this line starts | |
1430 | # ' *' then it is very likely a comment. | |
1431 | if (!defined $edge && | |
83242e0c | 1432 | $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) |
773647a0 AW |
1433 | { |
1434 | $in_comment = 1; | |
1435 | } | |
1436 | ||
1437 | ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; | |
1438 | sanitise_line_reset($in_comment); | |
1439 | ||
171ae1a4 | 1440 | } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { |
773647a0 | 1441 | # Standardise the strings and chars within the input to |
171ae1a4 | 1442 | # simplify matching -- only bother with positive lines. |
773647a0 | 1443 | $line = sanitise_line($rawline); |
de7d4f0e | 1444 | } |
773647a0 AW |
1445 | push(@lines, $line); |
1446 | ||
1447 | if ($realcnt > 1) { | |
1448 | $realcnt-- if ($line =~ /^(?:\+| |$)/); | |
1449 | } else { | |
1450 | $realcnt = 0; | |
1451 | } | |
1452 | ||
1453 | #print "==>$rawline\n"; | |
1454 | #print "-->$line\n"; | |
de7d4f0e AW |
1455 | |
1456 | if ($setup_docs && $line =~ /^\+/) { | |
1457 | push(@setup_docs, $line); | |
1458 | } | |
1459 | } | |
1460 | ||
6c72ffaa AW |
1461 | $prefix = ''; |
1462 | ||
773647a0 AW |
1463 | $realcnt = 0; |
1464 | $linenr = 0; | |
0a920b5b AW |
1465 | foreach my $line (@lines) { |
1466 | $linenr++; | |
1467 | ||
c2fdda0d | 1468 | my $rawline = $rawlines[$linenr - 1]; |
6c72ffaa | 1469 | |
0a920b5b | 1470 | #extract the line range in the file after the patch is applied |
6c72ffaa | 1471 | if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { |
0a920b5b | 1472 | $is_patch = 1; |
4a0df2ef | 1473 | $first_line = $linenr + 1; |
0a920b5b AW |
1474 | $realline=$1-1; |
1475 | if (defined $2) { | |
1476 | $realcnt=$3+1; | |
1477 | } else { | |
1478 | $realcnt=1+1; | |
1479 | } | |
c2fdda0d | 1480 | annotate_reset(); |
13214adf AW |
1481 | $prev_values = 'E'; |
1482 | ||
773647a0 | 1483 | %suppress_ifbraces = (); |
170d3a22 | 1484 | %suppress_whiletrailers = (); |
2b474a1a | 1485 | %suppress_export = (); |
3e469cdc | 1486 | $suppress_statement = 0; |
0a920b5b | 1487 | next; |
0a920b5b | 1488 | |
4a0df2ef AW |
1489 | # track the line number as we move through the hunk, note that |
1490 | # new versions of GNU diff omit the leading space on completely | |
1491 | # blank context lines so we need to count that too. | |
773647a0 | 1492 | } elsif ($line =~ /^( |\+|$)/) { |
0a920b5b | 1493 | $realline++; |
d8aaf121 | 1494 | $realcnt-- if ($realcnt != 0); |
0a920b5b | 1495 | |
4a0df2ef | 1496 | # Measure the line length and indent. |
c2fdda0d | 1497 | ($length, $indent) = line_stats($rawline); |
0a920b5b AW |
1498 | |
1499 | # Track the previous line. | |
1500 | ($prevline, $stashline) = ($stashline, $line); | |
1501 | ($previndent, $stashindent) = ($stashindent, $indent); | |
c2fdda0d AW |
1502 | ($prevrawline, $stashrawline) = ($stashrawline, $rawline); |
1503 | ||
773647a0 | 1504 | #warn "line<$line>\n"; |
6c72ffaa | 1505 | |
d8aaf121 AW |
1506 | } elsif ($realcnt == 1) { |
1507 | $realcnt--; | |
0a920b5b AW |
1508 | } |
1509 | ||
cc77cdca AW |
1510 | my $hunk_line = ($realcnt != 0); |
1511 | ||
0a920b5b | 1512 | #make up the handle for any error we report on this line |
773647a0 AW |
1513 | $prefix = "$filename:$realline: " if ($emacs && $file); |
1514 | $prefix = "$filename:$linenr: " if ($emacs && !$file); | |
1515 | ||
6c72ffaa AW |
1516 | $here = "#$linenr: " if (!$file); |
1517 | $here = "#$realline: " if ($file); | |
773647a0 AW |
1518 | |
1519 | # extract the filename as it passes | |
3bf9a009 RV |
1520 | if ($line =~ /^diff --git.*?(\S+)$/) { |
1521 | $realfile = $1; | |
1522 | $realfile =~ s@^([^/]*)/@@; | |
270c49a0 | 1523 | $in_commit_log = 0; |
3bf9a009 | 1524 | } elsif ($line =~ /^\+\+\+\s+(\S+)/) { |
773647a0 | 1525 | $realfile = $1; |
1e855726 | 1526 | $realfile =~ s@^([^/]*)/@@; |
270c49a0 | 1527 | $in_commit_log = 0; |
1e855726 WS |
1528 | |
1529 | $p1_prefix = $1; | |
e2f7aa4b AW |
1530 | if (!$file && $tree && $p1_prefix ne '' && |
1531 | -e "$root/$p1_prefix") { | |
000d1cc1 JP |
1532 | WARN("PATCH_PREFIX", |
1533 | "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); | |
1e855726 | 1534 | } |
773647a0 | 1535 | |
c1ab3326 | 1536 | if ($realfile =~ m@^include/asm/@) { |
000d1cc1 JP |
1537 | ERROR("MODIFIED_INCLUDE_ASM", |
1538 | "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); | |
773647a0 AW |
1539 | } |
1540 | next; | |
1541 | } | |
1542 | ||
389834b6 | 1543 | $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); |
0a920b5b | 1544 | |
c2fdda0d AW |
1545 | my $hereline = "$here\n$rawline\n"; |
1546 | my $herecurr = "$here\n$rawline\n"; | |
1547 | my $hereprev = "$here\n$prevrawline\n$rawline\n"; | |
0a920b5b | 1548 | |
6c72ffaa AW |
1549 | $cnt_lines++ if ($realcnt != 0); |
1550 | ||
3bf9a009 RV |
1551 | # Check for incorrect file permissions |
1552 | if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { | |
1553 | my $permhere = $here . "FILE: $realfile\n"; | |
1554 | if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) { | |
000d1cc1 JP |
1555 | ERROR("EXECUTE_PERMISSIONS", |
1556 | "do not set execute permissions for source files\n" . $permhere); | |
3bf9a009 RV |
1557 | } |
1558 | } | |
1559 | ||
20112475 | 1560 | # Check the patch for a signoff: |
d8aaf121 | 1561 | if ($line =~ /^\s*signed-off-by:/i) { |
4a0df2ef | 1562 | $signoff++; |
15662b3e | 1563 | $in_commit_log = 0; |
20112475 JP |
1564 | } |
1565 | ||
1566 | # Check signature styles | |
270c49a0 JP |
1567 | if (!$in_header_lines && |
1568 | $line =~ /^(\s*)($signature_tags)(\s*)(.*)/) { | |
20112475 JP |
1569 | my $space_before = $1; |
1570 | my $sign_off = $2; | |
1571 | my $space_after = $3; | |
1572 | my $email = $4; | |
1573 | my $ucfirst_sign_off = ucfirst(lc($sign_off)); | |
1574 | ||
1575 | if (defined $space_before && $space_before ne "") { | |
000d1cc1 JP |
1576 | WARN("BAD_SIGN_OFF", |
1577 | "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr); | |
20112475 JP |
1578 | } |
1579 | if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { | |
000d1cc1 JP |
1580 | WARN("BAD_SIGN_OFF", |
1581 | "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr); | |
20112475 JP |
1582 | } |
1583 | if (!defined $space_after || $space_after ne " ") { | |
000d1cc1 JP |
1584 | WARN("BAD_SIGN_OFF", |
1585 | "Use a single space after $ucfirst_sign_off\n" . $herecurr); | |
0a920b5b | 1586 | } |
20112475 JP |
1587 | |
1588 | my ($email_name, $email_address, $comment) = parse_email($email); | |
1589 | my $suggested_email = format_email(($email_name, $email_address)); | |
1590 | if ($suggested_email eq "") { | |
000d1cc1 JP |
1591 | ERROR("BAD_SIGN_OFF", |
1592 | "Unrecognized email address: '$email'\n" . $herecurr); | |
20112475 JP |
1593 | } else { |
1594 | my $dequoted = $suggested_email; | |
1595 | $dequoted =~ s/^"//; | |
1596 | $dequoted =~ s/" </ </; | |
1597 | # Don't force email to have quotes | |
1598 | # Allow just an angle bracketed address | |
1599 | if ("$dequoted$comment" ne $email && | |
1600 | "<$email_address>$comment" ne $email && | |
1601 | "$suggested_email$comment" ne $email) { | |
000d1cc1 JP |
1602 | WARN("BAD_SIGN_OFF", |
1603 | "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); | |
20112475 | 1604 | } |
0a920b5b AW |
1605 | } |
1606 | } | |
1607 | ||
00df344f | 1608 | # Check for wrappage within a valid hunk of the file |
8905a67c | 1609 | if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { |
000d1cc1 JP |
1610 | ERROR("CORRUPTED_PATCH", |
1611 | "patch seems to be corrupt (line wrapped?)\n" . | |
6c72ffaa | 1612 | $herecurr) if (!$emitted_corrupt++); |
de7d4f0e AW |
1613 | } |
1614 | ||
6ecd9674 AW |
1615 | # Check for absolute kernel paths. |
1616 | if ($tree) { | |
1617 | while ($line =~ m{(?:^|\s)(/\S*)}g) { | |
1618 | my $file = $1; | |
1619 | ||
1620 | if ($file =~ m{^(.*?)(?::\d+)+:?$} && | |
1621 | check_absolute_file($1, $herecurr)) { | |
1622 | # | |
1623 | } else { | |
1624 | check_absolute_file($file, $herecurr); | |
1625 | } | |
1626 | } | |
1627 | } | |
1628 | ||
de7d4f0e AW |
1629 | # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php |
1630 | if (($realfile =~ /^$/ || $line =~ /^\+/) && | |
171ae1a4 AW |
1631 | $rawline !~ m/^$UTF8*$/) { |
1632 | my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); | |
1633 | ||
1634 | my $blank = copy_spacing($rawline); | |
1635 | my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; | |
1636 | my $hereptr = "$hereline$ptr\n"; | |
1637 | ||
34d99219 JP |
1638 | CHK("INVALID_UTF8", |
1639 | "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); | |
00df344f AW |
1640 | } |
1641 | ||
15662b3e JP |
1642 | # Check if it's the start of a commit log |
1643 | # (not a header line and we haven't seen the patch filename) | |
1644 | if ($in_header_lines && $realfile =~ /^$/ && | |
270c49a0 | 1645 | $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { |
15662b3e JP |
1646 | $in_header_lines = 0; |
1647 | $in_commit_log = 1; | |
1648 | } | |
1649 | ||
1650 | # Still not yet in a patch, check for any UTF-8 | |
1651 | if ($in_commit_log && $realfile =~ /^$/ && | |
1652 | $rawline =~ /$NON_ASCII_UTF8/) { | |
1653 | CHK("UTF8_BEFORE_PATCH", | |
1654 | "8-bit UTF-8 used in possible commit log\n" . $herecurr); | |
1655 | } | |
1656 | ||
30670854 AW |
1657 | # ignore non-hunk lines and lines being removed |
1658 | next if (!$hunk_line || $line =~ /^-/); | |
0a920b5b | 1659 | |
0a920b5b | 1660 | #trailing whitespace |
9c0ca6f9 | 1661 | if ($line =~ /^\+.*\015/) { |
c2fdda0d | 1662 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
000d1cc1 JP |
1663 | ERROR("DOS_LINE_ENDINGS", |
1664 | "DOS line endings\n" . $herevet); | |
9c0ca6f9 | 1665 | |
c2fdda0d AW |
1666 | } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { |
1667 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; | |
000d1cc1 JP |
1668 | ERROR("TRAILING_WHITESPACE", |
1669 | "trailing whitespace\n" . $herevet); | |
d2c0a235 | 1670 | $rpt_cleaners = 1; |
0a920b5b | 1671 | } |
5368df20 | 1672 | |
3354957a | 1673 | # check for Kconfig help text having a real description |
9fe287d7 AW |
1674 | # Only applies when adding the entry originally, after that we do not have |
1675 | # sufficient context to determine whether it is indeed long enough. | |
3354957a | 1676 | if ($realfile =~ /Kconfig/ && |
a1385803 | 1677 | $line =~ /.\s*config\s+/) { |
3354957a | 1678 | my $length = 0; |
9fe287d7 AW |
1679 | my $cnt = $realcnt; |
1680 | my $ln = $linenr + 1; | |
1681 | my $f; | |
a1385803 | 1682 | my $is_start = 0; |
9fe287d7 | 1683 | my $is_end = 0; |
a1385803 | 1684 | for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { |
9fe287d7 AW |
1685 | $f = $lines[$ln - 1]; |
1686 | $cnt-- if ($lines[$ln - 1] !~ /^-/); | |
1687 | $is_end = $lines[$ln - 1] =~ /^\+/; | |
9fe287d7 AW |
1688 | |
1689 | next if ($f =~ /^-/); | |
a1385803 AW |
1690 | |
1691 | if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) { | |
1692 | $is_start = 1; | |
1693 | } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) { | |
1694 | $length = -1; | |
1695 | } | |
1696 | ||
9fe287d7 | 1697 | $f =~ s/^.//; |
3354957a AK |
1698 | $f =~ s/#.*//; |
1699 | $f =~ s/^\s+//; | |
1700 | next if ($f =~ /^$/); | |
9fe287d7 AW |
1701 | if ($f =~ /^\s*config\s/) { |
1702 | $is_end = 1; | |
1703 | last; | |
1704 | } | |
3354957a AK |
1705 | $length++; |
1706 | } | |
000d1cc1 | 1707 | WARN("CONFIG_DESCRIPTION", |
a1385803 AW |
1708 | "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4); |
1709 | #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; | |
3354957a AK |
1710 | } |
1711 | ||
c68e5878 AL |
1712 | if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && |
1713 | ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { | |
1714 | my $flag = $1; | |
1715 | my $replacement = { | |
1716 | 'EXTRA_AFLAGS' => 'asflags-y', | |
1717 | 'EXTRA_CFLAGS' => 'ccflags-y', | |
1718 | 'EXTRA_CPPFLAGS' => 'cppflags-y', | |
1719 | 'EXTRA_LDFLAGS' => 'ldflags-y', | |
1720 | }; | |
1721 | ||
1722 | WARN("DEPRECATED_VARIABLE", | |
1723 | "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); | |
1724 | } | |
1725 | ||
5368df20 AW |
1726 | # check we are in a valid source file if not then ignore this hunk |
1727 | next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); | |
1728 | ||
0a920b5b | 1729 | #80 column limit |
c45dcabd | 1730 | if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && |
f4c014c0 | 1731 | $rawline !~ /^.\s*\*\s*\@$Ident\s/ && |
0fccc622 | 1732 | !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || |
8bbea968 | 1733 | $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && |
f4c014c0 | 1734 | $length > 80) |
c45dcabd | 1735 | { |
000d1cc1 JP |
1736 | WARN("LONG_LINE", |
1737 | "line over 80 characters\n" . $herecurr); | |
0a920b5b AW |
1738 | } |
1739 | ||
5e79d96e JP |
1740 | # check for spaces before a quoted newline |
1741 | if ($rawline =~ /^.*\".*\s\\n/) { | |
000d1cc1 JP |
1742 | WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", |
1743 | "unnecessary whitespace before a quoted newline\n" . $herecurr); | |
5e79d96e JP |
1744 | } |
1745 | ||
8905a67c AW |
1746 | # check for adding lines without a newline. |
1747 | if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { | |
000d1cc1 JP |
1748 | WARN("MISSING_EOF_NEWLINE", |
1749 | "adding a line without newline at end of file\n" . $herecurr); | |
8905a67c AW |
1750 | } |
1751 | ||
42e41c54 MF |
1752 | # Blackfin: use hi/lo macros |
1753 | if ($realfile =~ m@arch/blackfin/.*\.S$@) { | |
1754 | if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { | |
1755 | my $herevet = "$here\n" . cat_vet($line) . "\n"; | |
000d1cc1 JP |
1756 | ERROR("LO_MACRO", |
1757 | "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); | |
42e41c54 MF |
1758 | } |
1759 | if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { | |
1760 | my $herevet = "$here\n" . cat_vet($line) . "\n"; | |
000d1cc1 JP |
1761 | ERROR("HI_MACRO", |
1762 | "use the HI() macro, not (... >> 16)\n" . $herevet); | |
42e41c54 MF |
1763 | } |
1764 | } | |
1765 | ||
b9ea10d6 AW |
1766 | # check we are in a valid source file C or perl if not then ignore this hunk |
1767 | next if ($realfile !~ /\.(h|c|pl)$/); | |
0a920b5b AW |
1768 | |
1769 | # at the beginning of a line any tabs must come first and anything | |
1770 | # more than 8 must use tabs. | |
c2fdda0d AW |
1771 | if ($rawline =~ /^\+\s* \t\s*\S/ || |
1772 | $rawline =~ /^\+\s* \s*/) { | |
1773 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; | |
000d1cc1 JP |
1774 | ERROR("CODE_INDENT", |
1775 | "code indent should use tabs where possible\n" . $herevet); | |
d2c0a235 | 1776 | $rpt_cleaners = 1; |
0a920b5b AW |
1777 | } |
1778 | ||
08e44365 AP |
1779 | # check for space before tabs. |
1780 | if ($rawline =~ /^\+/ && $rawline =~ / \t/) { | |
1781 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; | |
000d1cc1 JP |
1782 | WARN("SPACE_BEFORE_TAB", |
1783 | "please, no space before tabs\n" . $herevet); | |
08e44365 AP |
1784 | } |
1785 | ||
5f7ddae6 | 1786 | # check for spaces at the beginning of a line. |
6b4c5beb AW |
1787 | # Exceptions: |
1788 | # 1) within comments | |
1789 | # 2) indented preprocessor commands | |
1790 | # 3) hanging labels | |
1791 | if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) { | |
5f7ddae6 | 1792 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
000d1cc1 JP |
1793 | WARN("LEADING_SPACE", |
1794 | "please, no spaces at the start of a line\n" . $herevet); | |
5f7ddae6 RR |
1795 | } |
1796 | ||
b9ea10d6 AW |
1797 | # check we are in a valid C source file if not then ignore this hunk |
1798 | next if ($realfile !~ /\.(h|c)$/); | |
1799 | ||
c2fdda0d | 1800 | # check for RCS/CVS revision markers |
cf655043 | 1801 | if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { |
000d1cc1 JP |
1802 | WARN("CVS_KEYWORD", |
1803 | "CVS style keyword markers, these will _not_ be updated\n". $herecurr); | |
c2fdda0d | 1804 | } |
22f2a2ef | 1805 | |
42e41c54 MF |
1806 | # Blackfin: don't use __builtin_bfin_[cs]sync |
1807 | if ($line =~ /__builtin_bfin_csync/) { | |
1808 | my $herevet = "$here\n" . cat_vet($line) . "\n"; | |
000d1cc1 JP |
1809 | ERROR("CSYNC", |
1810 | "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); | |
42e41c54 MF |
1811 | } |
1812 | if ($line =~ /__builtin_bfin_ssync/) { | |
1813 | my $herevet = "$here\n" . cat_vet($line) . "\n"; | |
000d1cc1 JP |
1814 | ERROR("SSYNC", |
1815 | "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); | |
42e41c54 MF |
1816 | } |
1817 | ||
9c0ca6f9 | 1818 | # Check for potential 'bare' types |
2b474a1a AW |
1819 | my ($stat, $cond, $line_nr_next, $remain_next, $off_next, |
1820 | $realline_next); | |
3e469cdc AW |
1821 | #print "LINE<$line>\n"; |
1822 | if ($linenr >= $suppress_statement && | |
1823 | $realcnt && $line =~ /.\s*\S/) { | |
170d3a22 | 1824 | ($stat, $cond, $line_nr_next, $remain_next, $off_next) = |
f5fe35dd | 1825 | ctx_statement_block($linenr, $realcnt, 0); |
171ae1a4 AW |
1826 | $stat =~ s/\n./\n /g; |
1827 | $cond =~ s/\n./\n /g; | |
1828 | ||
3e469cdc AW |
1829 | #print "linenr<$linenr> <$stat>\n"; |
1830 | # If this statement has no statement boundaries within | |
1831 | # it there is no point in retrying a statement scan | |
1832 | # until we hit end of it. | |
1833 | my $frag = $stat; $frag =~ s/;+\s*$//; | |
1834 | if ($frag !~ /(?:{|;)/) { | |
1835 | #print "skip<$line_nr_next>\n"; | |
1836 | $suppress_statement = $line_nr_next; | |
1837 | } | |
f74bd194 | 1838 | |
2b474a1a AW |
1839 | # Find the real next line. |
1840 | $realline_next = $line_nr_next; | |
1841 | if (defined $realline_next && | |
1842 | (!defined $lines[$realline_next - 1] || | |
1843 | substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { | |
1844 | $realline_next++; | |
1845 | } | |
1846 | ||
171ae1a4 AW |
1847 | my $s = $stat; |
1848 | $s =~ s/{.*$//s; | |
cf655043 | 1849 | |
c2fdda0d | 1850 | # Ignore goto labels. |
171ae1a4 | 1851 | if ($s =~ /$Ident:\*$/s) { |
c2fdda0d AW |
1852 | |
1853 | # Ignore functions being called | |
171ae1a4 | 1854 | } elsif ($s =~ /^.\s*$Ident\s*\(/s) { |
c2fdda0d | 1855 | |
463f2864 AW |
1856 | } elsif ($s =~ /^.\s*else\b/s) { |
1857 | ||
c45dcabd | 1858 | # declarations always start with types |
d2506586 | 1859 | } 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) { |
c45dcabd AW |
1860 | my $type = $1; |
1861 | $type =~ s/\s+/ /g; | |
1862 | possible($type, "A:" . $s); | |
1863 | ||
8905a67c | 1864 | # definitions in global scope can only start with types |
a6a84062 | 1865 | } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { |
c45dcabd | 1866 | possible($1, "B:" . $s); |
c2fdda0d | 1867 | } |
8905a67c AW |
1868 | |
1869 | # any (foo ... *) is a pointer cast, and foo is a type | |
65863862 | 1870 | while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { |
c45dcabd | 1871 | possible($1, "C:" . $s); |
8905a67c AW |
1872 | } |
1873 | ||
1874 | # Check for any sort of function declaration. | |
1875 | # int foo(something bar, other baz); | |
1876 | # void (*store_gdt)(x86_descr_ptr *); | |
171ae1a4 | 1877 | if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { |
8905a67c | 1878 | my ($name_len) = length($1); |
8905a67c | 1879 | |
cf655043 | 1880 | my $ctx = $s; |
773647a0 | 1881 | substr($ctx, 0, $name_len + 1, ''); |
8905a67c | 1882 | $ctx =~ s/\)[^\)]*$//; |
cf655043 | 1883 | |
8905a67c | 1884 | for my $arg (split(/\s*,\s*/, $ctx)) { |
c45dcabd | 1885 | if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { |
8905a67c | 1886 | |
c45dcabd | 1887 | possible($1, "D:" . $s); |
8905a67c AW |
1888 | } |
1889 | } | |
9c0ca6f9 | 1890 | } |
8905a67c | 1891 | |
9c0ca6f9 AW |
1892 | } |
1893 | ||
653d4876 AW |
1894 | # |
1895 | # Checks which may be anchored in the context. | |
1896 | # | |
00df344f | 1897 | |
653d4876 AW |
1898 | # Check for switch () and associated case and default |
1899 | # statements should be at the same indent. | |
00df344f AW |
1900 | if ($line=~/\bswitch\s*\(.*\)/) { |
1901 | my $err = ''; | |
1902 | my $sep = ''; | |
1903 | my @ctx = ctx_block_outer($linenr, $realcnt); | |
1904 | shift(@ctx); | |
1905 | for my $ctx (@ctx) { | |
1906 | my ($clen, $cindent) = line_stats($ctx); | |
1907 | if ($ctx =~ /^\+\s*(case\s+|default:)/ && | |
1908 | $indent != $cindent) { | |
1909 | $err .= "$sep$ctx\n"; | |
1910 | $sep = ''; | |
1911 | } else { | |
1912 | $sep = "[...]\n"; | |
1913 | } | |
1914 | } | |
1915 | if ($err ne '') { | |
000d1cc1 JP |
1916 | ERROR("SWITCH_CASE_INDENT_LEVEL", |
1917 | "switch and case should be at the same indent\n$hereline$err"); | |
de7d4f0e AW |
1918 | } |
1919 | } | |
1920 | ||
1921 | # if/while/etc brace do not go on next line, unless defining a do while loop, | |
1922 | # or if that brace on the next line is for something else | |
c45dcabd | 1923 | if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { |
773647a0 AW |
1924 | my $pre_ctx = "$1$2"; |
1925 | ||
9c0ca6f9 | 1926 | my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); |
de7d4f0e AW |
1927 | my $ctx_cnt = $realcnt - $#ctx - 1; |
1928 | my $ctx = join("\n", @ctx); | |
1929 | ||
548596d5 AW |
1930 | my $ctx_ln = $linenr; |
1931 | my $ctx_skip = $realcnt; | |
773647a0 | 1932 | |
548596d5 AW |
1933 | while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && |
1934 | defined $lines[$ctx_ln - 1] && | |
1935 | $lines[$ctx_ln - 1] =~ /^-/)) { | |
1936 | ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; | |
1937 | $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); | |
de7d4f0e | 1938 | $ctx_ln++; |
de7d4f0e | 1939 | } |
548596d5 | 1940 | |
53210168 AW |
1941 | #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; |
1942 | #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; | |
de7d4f0e | 1943 | |
773647a0 | 1944 | if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { |
000d1cc1 JP |
1945 | ERROR("OPEN_BRACE", |
1946 | "that open brace { should be on the previous line\n" . | |
01464f30 | 1947 | "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); |
00df344f | 1948 | } |
773647a0 AW |
1949 | if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && |
1950 | $ctx =~ /\)\s*\;\s*$/ && | |
1951 | defined $lines[$ctx_ln - 1]) | |
1952 | { | |
9c0ca6f9 AW |
1953 | my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); |
1954 | if ($nindent > $indent) { | |
000d1cc1 JP |
1955 | WARN("TRAILING_SEMICOLON", |
1956 | "trailing semicolon indicates no statements, indent implies otherwise\n" . | |
01464f30 | 1957 | "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); |
9c0ca6f9 AW |
1958 | } |
1959 | } | |
00df344f AW |
1960 | } |
1961 | ||
4d001e4d AW |
1962 | # Check relative indent for conditionals and blocks. |
1963 | if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { | |
3e469cdc AW |
1964 | ($stat, $cond, $line_nr_next, $remain_next, $off_next) = |
1965 | ctx_statement_block($linenr, $realcnt, 0) | |
1966 | if (!defined $stat); | |
4d001e4d AW |
1967 | my ($s, $c) = ($stat, $cond); |
1968 | ||
1969 | substr($s, 0, length($c), ''); | |
1970 | ||
1971 | # Make sure we remove the line prefixes as we have | |
1972 | # none on the first line, and are going to readd them | |
1973 | # where necessary. | |
1974 | $s =~ s/\n./\n/gs; | |
1975 | ||
1976 | # Find out how long the conditional actually is. | |
6f779c18 AW |
1977 | my @newlines = ($c =~ /\n/gs); |
1978 | my $cond_lines = 1 + $#newlines; | |
4d001e4d AW |
1979 | |
1980 | # We want to check the first line inside the block | |
1981 | # starting at the end of the conditional, so remove: | |
1982 | # 1) any blank line termination | |
1983 | # 2) any opening brace { on end of the line | |
1984 | # 3) any do (...) { | |
1985 | my $continuation = 0; | |
1986 | my $check = 0; | |
1987 | $s =~ s/^.*\bdo\b//; | |
1988 | $s =~ s/^\s*{//; | |
1989 | if ($s =~ s/^\s*\\//) { | |
1990 | $continuation = 1; | |
1991 | } | |
9bd49efe | 1992 | if ($s =~ s/^\s*?\n//) { |
4d001e4d AW |
1993 | $check = 1; |
1994 | $cond_lines++; | |
1995 | } | |
1996 | ||
1997 | # Also ignore a loop construct at the end of a | |
1998 | # preprocessor statement. | |
1999 | if (($prevline =~ /^.\s*#\s*define\s/ || | |
2000 | $prevline =~ /\\\s*$/) && $continuation == 0) { | |
2001 | $check = 0; | |
2002 | } | |
2003 | ||
9bd49efe | 2004 | my $cond_ptr = -1; |
740504c6 | 2005 | $continuation = 0; |
9bd49efe AW |
2006 | while ($cond_ptr != $cond_lines) { |
2007 | $cond_ptr = $cond_lines; | |
2008 | ||
f16fa28f AW |
2009 | # If we see an #else/#elif then the code |
2010 | # is not linear. | |
2011 | if ($s =~ /^\s*\#\s*(?:else|elif)/) { | |
2012 | $check = 0; | |
2013 | } | |
2014 | ||
9bd49efe AW |
2015 | # Ignore: |
2016 | # 1) blank lines, they should be at 0, | |
2017 | # 2) preprocessor lines, and | |
2018 | # 3) labels. | |
740504c6 AW |
2019 | if ($continuation || |
2020 | $s =~ /^\s*?\n/ || | |
9bd49efe AW |
2021 | $s =~ /^\s*#\s*?/ || |
2022 | $s =~ /^\s*$Ident\s*:/) { | |
740504c6 | 2023 | $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; |
30dad6eb AW |
2024 | if ($s =~ s/^.*?\n//) { |
2025 | $cond_lines++; | |
2026 | } | |
9bd49efe | 2027 | } |
4d001e4d AW |
2028 | } |
2029 | ||
2030 | my (undef, $sindent) = line_stats("+" . $s); | |
2031 | my $stat_real = raw_line($linenr, $cond_lines); | |
2032 | ||
2033 | # Check if either of these lines are modified, else | |
2034 | # this is not this patch's fault. | |
2035 | if (!defined($stat_real) || | |
2036 | $stat !~ /^\+/ && $stat_real !~ /^\+/) { | |
2037 | $check = 0; | |
2038 | } | |
2039 | if (defined($stat_real) && $cond_lines > 1) { | |
2040 | $stat_real = "[...]\n$stat_real"; | |
2041 | } | |
2042 | ||
9bd49efe | 2043 | #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"; |
4d001e4d AW |
2044 | |
2045 | if ($check && (($sindent % 8) != 0 || | |
2046 | ($sindent <= $indent && $s ne ''))) { | |
000d1cc1 JP |
2047 | WARN("SUSPECT_CODE_INDENT", |
2048 | "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); | |
4d001e4d AW |
2049 | } |
2050 | } | |
2051 | ||
6c72ffaa AW |
2052 | # Track the 'values' across context and added lines. |
2053 | my $opline = $line; $opline =~ s/^./ /; | |
1f65f947 AW |
2054 | my ($curr_values, $curr_vars) = |
2055 | annotate_values($opline . "\n", $prev_values); | |
6c72ffaa | 2056 | $curr_values = $prev_values . $curr_values; |
c2fdda0d AW |
2057 | if ($dbg_values) { |
2058 | my $outline = $opline; $outline =~ s/\t/ /g; | |
cf655043 AW |
2059 | print "$linenr > .$outline\n"; |
2060 | print "$linenr > $curr_values\n"; | |
1f65f947 | 2061 | print "$linenr > $curr_vars\n"; |
c2fdda0d | 2062 | } |
6c72ffaa AW |
2063 | $prev_values = substr($curr_values, -1); |
2064 | ||
00df344f AW |
2065 | #ignore lines not being added |
2066 | if ($line=~/^[^\+]/) {next;} | |
2067 | ||
653d4876 | 2068 | # TEST: allow direct testing of the type matcher. |
7429c690 AW |
2069 | if ($dbg_type) { |
2070 | if ($line =~ /^.\s*$Declare\s*$/) { | |
000d1cc1 JP |
2071 | ERROR("TEST_TYPE", |
2072 | "TEST: is type\n" . $herecurr); | |
7429c690 | 2073 | } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { |
000d1cc1 JP |
2074 | ERROR("TEST_NOT_TYPE", |
2075 | "TEST: is not type ($1 is)\n". $herecurr); | |
7429c690 | 2076 | } |
653d4876 AW |
2077 | next; |
2078 | } | |
a1ef277e AW |
2079 | # TEST: allow direct testing of the attribute matcher. |
2080 | if ($dbg_attr) { | |
9360b0e5 | 2081 | if ($line =~ /^.\s*$Modifier\s*$/) { |
000d1cc1 JP |
2082 | ERROR("TEST_ATTR", |
2083 | "TEST: is attr\n" . $herecurr); | |
9360b0e5 | 2084 | } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { |
000d1cc1 JP |
2085 | ERROR("TEST_NOT_ATTR", |
2086 | "TEST: is not attr ($1 is)\n". $herecurr); | |
a1ef277e AW |
2087 | } |
2088 | next; | |
2089 | } | |
653d4876 | 2090 | |
f0a594c1 | 2091 | # check for initialisation to aggregates open brace on the next line |
99423c20 AW |
2092 | if ($line =~ /^.\s*{/ && |
2093 | $prevline =~ /(?:^|[^=])=\s*$/) { | |
000d1cc1 JP |
2094 | ERROR("OPEN_BRACE", |
2095 | "that open brace { should be on the previous line\n" . $hereprev); | |
f0a594c1 AW |
2096 | } |
2097 | ||
653d4876 AW |
2098 | # |
2099 | # Checks which are anchored on the added line. | |
2100 | # | |
2101 | ||
2102 | # check for malformed paths in #include statements (uses RAW line) | |
c45dcabd | 2103 | if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { |
653d4876 AW |
2104 | my $path = $1; |
2105 | if ($path =~ m{//}) { | |
000d1cc1 JP |
2106 | ERROR("MALFORMED_INCLUDE", |
2107 | "malformed #include filename\n" . | |
de7d4f0e | 2108 | $herecurr); |
653d4876 | 2109 | } |
653d4876 | 2110 | } |
00df344f | 2111 | |
0a920b5b | 2112 | # no C99 // comments |
00df344f | 2113 | if ($line =~ m{//}) { |
000d1cc1 JP |
2114 | ERROR("C99_COMMENTS", |
2115 | "do not use C99 // comments\n" . $herecurr); | |
0a920b5b | 2116 | } |
00df344f | 2117 | # Remove C99 comments. |
0a920b5b | 2118 | $line =~ s@//.*@@; |
6c72ffaa | 2119 | $opline =~ s@//.*@@; |
0a920b5b | 2120 | |
2b474a1a AW |
2121 | # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider |
2122 | # the whole statement. | |
2123 | #print "APW <$lines[$realline_next - 1]>\n"; | |
2124 | if (defined $realline_next && | |
2125 | exists $lines[$realline_next - 1] && | |
2126 | !defined $suppress_export{$realline_next} && | |
2127 | ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || | |
2128 | $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { | |
3cbf62df AW |
2129 | # Handle definitions which produce identifiers with |
2130 | # a prefix: | |
2131 | # XXX(foo); | |
2132 | # EXPORT_SYMBOL(something_foo); | |
653d4876 | 2133 | my $name = $1; |
87a53877 | 2134 | if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && |
3cbf62df AW |
2135 | $name =~ /^${Ident}_$2/) { |
2136 | #print "FOO C name<$name>\n"; | |
2137 | $suppress_export{$realline_next} = 1; | |
2138 | ||
2139 | } elsif ($stat !~ /(?: | |
2b474a1a | 2140 | \n.}\s*$| |
48012058 AW |
2141 | ^.DEFINE_$Ident\(\Q$name\E\)| |
2142 | ^.DECLARE_$Ident\(\Q$name\E\)| | |
2143 | ^.LIST_HEAD\(\Q$name\E\)| | |
2b474a1a AW |
2144 | ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| |
2145 | \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() | |
48012058 | 2146 | )/x) { |
2b474a1a AW |
2147 | #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; |
2148 | $suppress_export{$realline_next} = 2; | |
2149 | } else { | |
2150 | $suppress_export{$realline_next} = 1; | |
0a920b5b AW |
2151 | } |
2152 | } | |
2b474a1a AW |
2153 | if (!defined $suppress_export{$linenr} && |
2154 | $prevline =~ /^.\s*$/ && | |
2155 | ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || | |
2156 | $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { | |
2157 | #print "FOO B <$lines[$linenr - 1]>\n"; | |
2158 | $suppress_export{$linenr} = 2; | |
2159 | } | |
2160 | if (defined $suppress_export{$linenr} && | |
2161 | $suppress_export{$linenr} == 2) { | |
000d1cc1 JP |
2162 | WARN("EXPORT_SYMBOL", |
2163 | "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); | |
2b474a1a | 2164 | } |
0a920b5b | 2165 | |
5150bda4 | 2166 | # check for global initialisers. |
c45dcabd | 2167 | if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { |
000d1cc1 JP |
2168 | ERROR("GLOBAL_INITIALISERS", |
2169 | "do not initialise globals to 0 or NULL\n" . | |
f0a594c1 AW |
2170 | $herecurr); |
2171 | } | |
653d4876 | 2172 | # check for static initialisers. |
2d1bafd7 | 2173 | if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { |
000d1cc1 JP |
2174 | ERROR("INITIALISED_STATIC", |
2175 | "do not initialise statics to 0 or NULL\n" . | |
de7d4f0e | 2176 | $herecurr); |
0a920b5b AW |
2177 | } |
2178 | ||
cb710eca JP |
2179 | # check for static const char * arrays. |
2180 | if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { | |
000d1cc1 JP |
2181 | WARN("STATIC_CONST_CHAR_ARRAY", |
2182 | "static const char * array should probably be static const char * const\n" . | |
cb710eca JP |
2183 | $herecurr); |
2184 | } | |
2185 | ||
2186 | # check for static char foo[] = "bar" declarations. | |
2187 | if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { | |
000d1cc1 JP |
2188 | WARN("STATIC_CONST_CHAR_ARRAY", |
2189 | "static char array declaration should probably be static const char\n" . | |
cb710eca JP |
2190 | $herecurr); |
2191 | } | |
2192 | ||
93ed0e2d JP |
2193 | # check for declarations of struct pci_device_id |
2194 | if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { | |
000d1cc1 JP |
2195 | WARN("DEFINE_PCI_DEVICE_TABLE", |
2196 | "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); | |
93ed0e2d JP |
2197 | } |
2198 | ||
653d4876 AW |
2199 | # check for new typedefs, only function parameters and sparse annotations |
2200 | # make sense. | |
2201 | if ($line =~ /\btypedef\s/ && | |
8054576d | 2202 | $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && |
c45dcabd | 2203 | $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && |
8ed22cad | 2204 | $line !~ /\b$typeTypedefs\b/ && |
653d4876 | 2205 | $line !~ /\b__bitwise(?:__|)\b/) { |
000d1cc1 JP |
2206 | WARN("NEW_TYPEDEFS", |
2207 | "do not add new typedefs\n" . $herecurr); | |
0a920b5b AW |
2208 | } |
2209 | ||
2210 | # * goes on variable not on type | |
65863862 | 2211 | # (char*[ const]) |
00ef4ece | 2212 | if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) { |
65863862 AW |
2213 | my ($from, $to) = ($1, $1); |
2214 | ||
2215 | # Should start with a space. | |
2216 | $to =~ s/^(\S)/ $1/; | |
2217 | # Should not end with a space. | |
2218 | $to =~ s/\s+$//; | |
2219 | # '*'s should not have spaces between. | |
f9a0b3d1 | 2220 | while ($to =~ s/\*\s+\*/\*\*/) { |
65863862 | 2221 | } |
d8aaf121 | 2222 | |
65863862 AW |
2223 | #print "from<$from> to<$to>\n"; |
2224 | if ($from ne $to) { | |
000d1cc1 JP |
2225 | ERROR("POINTER_LOCATION", |
2226 | "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); | |
65863862 | 2227 | } |
00ef4ece | 2228 | } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) { |
65863862 AW |
2229 | my ($from, $to, $ident) = ($1, $1, $2); |
2230 | ||
2231 | # Should start with a space. | |
2232 | $to =~ s/^(\S)/ $1/; | |
2233 | # Should not end with a space. | |
2234 | $to =~ s/\s+$//; | |
2235 | # '*'s should not have spaces between. | |
f9a0b3d1 | 2236 | while ($to =~ s/\*\s+\*/\*\*/) { |
65863862 AW |
2237 | } |
2238 | # Modifiers should have spaces. | |
2239 | $to =~ s/(\b$Modifier$)/$1 /; | |
d8aaf121 | 2240 | |
667026e7 AW |
2241 | #print "from<$from> to<$to> ident<$ident>\n"; |
2242 | if ($from ne $to && $ident !~ /^$Modifier$/) { | |
000d1cc1 JP |
2243 | ERROR("POINTER_LOCATION", |
2244 | "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); | |
65863862 | 2245 | } |
0a920b5b AW |
2246 | } |
2247 | ||
2248 | # # no BUG() or BUG_ON() | |
2249 | # if ($line =~ /\b(BUG|BUG_ON)\b/) { | |
2250 | # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; | |
2251 | # print "$herecurr"; | |
2252 | # $clean = 0; | |
2253 | # } | |
2254 | ||
8905a67c | 2255 | if ($line =~ /\bLINUX_VERSION_CODE\b/) { |
000d1cc1 JP |
2256 | WARN("LINUX_VERSION_CODE", |
2257 | "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); | |
8905a67c AW |
2258 | } |
2259 | ||
17441227 JP |
2260 | # check for uses of printk_ratelimit |
2261 | if ($line =~ /\bprintk_ratelimit\s*\(/) { | |
000d1cc1 JP |
2262 | WARN("PRINTK_RATELIMITED", |
2263 | "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); | |
17441227 JP |
2264 | } |
2265 | ||
00df344f AW |
2266 | # printk should use KERN_* levels. Note that follow on printk's on the |
2267 | # same line do not need a level, so we use the current block context | |
2268 | # to try and find and validate the current printk. In summary the current | |
25985edc | 2269 | # printk includes all preceding printk's which have no newline on the end. |
00df344f | 2270 | # we assume the first bad printk is the one to report. |
f0a594c1 | 2271 | if ($line =~ /\bprintk\((?!KERN_)\s*"/) { |
00df344f AW |
2272 | my $ok = 0; |
2273 | for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { | |
2274 | #print "CHECK<$lines[$ln - 1]\n"; | |
25985edc | 2275 | # we have a preceding printk if it ends |
00df344f AW |
2276 | # with "\n" ignore it, else it is to blame |
2277 | if ($lines[$ln - 1] =~ m{\bprintk\(}) { | |
2278 | if ($rawlines[$ln - 1] !~ m{\\n"}) { | |
2279 | $ok = 1; | |
2280 | } | |
2281 | last; | |
2282 | } | |
2283 | } | |
2284 | if ($ok == 0) { | |
000d1cc1 JP |
2285 | WARN("PRINTK_WITHOUT_KERN_LEVEL", |
2286 | "printk() should include KERN_ facility level\n" . $herecurr); | |
00df344f | 2287 | } |
0a920b5b AW |
2288 | } |
2289 | ||
653d4876 AW |
2290 | # function brace can't be on same line, except for #defines of do while, |
2291 | # or if closed on same line | |
c45dcabd AW |
2292 | if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and |
2293 | !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { | |
000d1cc1 JP |
2294 | ERROR("OPEN_BRACE", |
2295 | "open brace '{' following function declarations go on the next line\n" . $herecurr); | |
0a920b5b | 2296 | } |
653d4876 | 2297 | |
8905a67c AW |
2298 | # open braces for enum, union and struct go on the same line. |
2299 | if ($line =~ /^.\s*{/ && | |
2300 | $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { | |
000d1cc1 JP |
2301 | ERROR("OPEN_BRACE", |
2302 | "open brace '{' following $1 go on the same line\n" . $hereprev); | |
8905a67c AW |
2303 | } |
2304 | ||
0c73b4eb AW |
2305 | # missing space after union, struct or enum definition |
2306 | if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { | |
000d1cc1 JP |
2307 | WARN("SPACING", |
2308 | "missing space after $1 definition\n" . $herecurr); | |
0c73b4eb AW |
2309 | } |
2310 | ||
8d31cfce AW |
2311 | # check for spacing round square brackets; allowed: |
2312 | # 1. with a type on the left -- int [] a; | |
fe2a7dbc AW |
2313 | # 2. at the beginning of a line for slice initialisers -- [0...10] = 5, |
2314 | # 3. inside a curly brace -- = { [0...10] = 5 } | |
8d31cfce AW |
2315 | while ($line =~ /(.*?\s)\[/g) { |
2316 | my ($where, $prefix) = ($-[1], $1); | |
2317 | if ($prefix !~ /$Type\s+$/ && | |
fe2a7dbc AW |
2318 | ($where != 0 || $prefix !~ /^.\s+$/) && |
2319 | $prefix !~ /{\s+$/) { | |
000d1cc1 JP |
2320 | ERROR("BRACKET_SPACE", |
2321 | "space prohibited before open square bracket '['\n" . $herecurr); | |
8d31cfce AW |
2322 | } |
2323 | } | |
2324 | ||
f0a594c1 | 2325 | # check for spaces between functions and their parentheses. |
6c72ffaa | 2326 | while ($line =~ /($Ident)\s+\(/g) { |
c2fdda0d | 2327 | my $name = $1; |
773647a0 AW |
2328 | my $ctx_before = substr($line, 0, $-[1]); |
2329 | my $ctx = "$ctx_before$name"; | |
c2fdda0d AW |
2330 | |
2331 | # Ignore those directives where spaces _are_ permitted. | |
773647a0 AW |
2332 | if ($name =~ /^(?: |
2333 | if|for|while|switch|return|case| | |
2334 | volatile|__volatile__| | |
2335 | __attribute__|format|__extension__| | |
2336 | asm|__asm__)$/x) | |
2337 | { | |
c2fdda0d AW |
2338 | |
2339 | # cpp #define statements have non-optional spaces, ie | |
2340 | # if there is a space between the name and the open | |
2341 | # parenthesis it is simply not a parameter group. | |
c45dcabd | 2342 | } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { |
773647a0 AW |
2343 | |
2344 | # cpp #elif statement condition may start with a ( | |
c45dcabd | 2345 | } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { |
c2fdda0d AW |
2346 | |
2347 | # If this whole things ends with a type its most | |
2348 | # likely a typedef for a function. | |
773647a0 | 2349 | } elsif ($ctx =~ /$Type$/) { |
c2fdda0d AW |
2350 | |
2351 | } else { | |
000d1cc1 JP |
2352 | WARN("SPACING", |
2353 | "space prohibited between function name and open parenthesis '('\n" . $herecurr); | |
6c72ffaa | 2354 | } |
f0a594c1 | 2355 | } |
653d4876 | 2356 | # Check operator spacing. |
0a920b5b | 2357 | if (!($line=~/\#\s*include/)) { |
9c0ca6f9 AW |
2358 | my $ops = qr{ |
2359 | <<=|>>=|<=|>=|==|!=| | |
2360 | \+=|-=|\*=|\/=|%=|\^=|\|=|&=| | |
2361 | =>|->|<<|>>|<|>|=|!|~| | |
1f65f947 AW |
2362 | &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| |
2363 | \?|: | |
9c0ca6f9 | 2364 | }x; |
cf655043 | 2365 | my @elements = split(/($ops|;)/, $opline); |
00df344f | 2366 | my $off = 0; |
6c72ffaa AW |
2367 | |
2368 | my $blank = copy_spacing($opline); | |
2369 | ||
0a920b5b | 2370 | for (my $n = 0; $n < $#elements; $n += 2) { |
4a0df2ef AW |
2371 | $off += length($elements[$n]); |
2372 | ||
25985edc | 2373 | # Pick up the preceding and succeeding characters. |
773647a0 AW |
2374 | my $ca = substr($opline, 0, $off); |
2375 | my $cc = ''; | |
2376 | if (length($opline) >= ($off + length($elements[$n + 1]))) { | |
2377 | $cc = substr($opline, $off + length($elements[$n + 1])); | |
2378 | } | |
2379 | my $cb = "$ca$;$cc"; | |
2380 | ||
4a0df2ef AW |
2381 | my $a = ''; |
2382 | $a = 'V' if ($elements[$n] ne ''); | |
2383 | $a = 'W' if ($elements[$n] =~ /\s$/); | |
cf655043 | 2384 | $a = 'C' if ($elements[$n] =~ /$;$/); |
4a0df2ef AW |
2385 | $a = 'B' if ($elements[$n] =~ /(\[|\()$/); |
2386 | $a = 'O' if ($elements[$n] eq ''); | |
773647a0 | 2387 | $a = 'E' if ($ca =~ /^\s*$/); |
4a0df2ef | 2388 | |
0a920b5b | 2389 | my $op = $elements[$n + 1]; |
4a0df2ef AW |
2390 | |
2391 | my $c = ''; | |
0a920b5b | 2392 | if (defined $elements[$n + 2]) { |
4a0df2ef AW |
2393 | $c = 'V' if ($elements[$n + 2] ne ''); |
2394 | $c = 'W' if ($elements[$n + 2] =~ /^\s/); | |
cf655043 | 2395 | $c = 'C' if ($elements[$n + 2] =~ /^$;/); |
4a0df2ef AW |
2396 | $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); |
2397 | $c = 'O' if ($elements[$n + 2] eq ''); | |
8b1b3378 | 2398 | $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); |
4a0df2ef AW |
2399 | } else { |
2400 | $c = 'E'; | |
0a920b5b AW |
2401 | } |
2402 | ||
4a0df2ef AW |
2403 | my $ctx = "${a}x${c}"; |
2404 | ||
2405 | my $at = "(ctx:$ctx)"; | |
2406 | ||
6c72ffaa | 2407 | my $ptr = substr($blank, 0, $off) . "^"; |
de7d4f0e | 2408 | my $hereptr = "$hereline$ptr\n"; |
0a920b5b | 2409 | |
74048ed8 | 2410 | # Pull out the value of this operator. |
6c72ffaa | 2411 | my $op_type = substr($curr_values, $off + 1, 1); |
0a920b5b | 2412 | |
1f65f947 AW |
2413 | # Get the full operator variant. |
2414 | my $opv = $op . substr($curr_vars, $off, 1); | |
2415 | ||
13214adf AW |
2416 | # Ignore operators passed as parameters. |
2417 | if ($op_type ne 'V' && | |
2418 | $ca =~ /\s$/ && $cc =~ /^\s*,/) { | |
2419 | ||
cf655043 AW |
2420 | # # Ignore comments |
2421 | # } elsif ($op =~ /^$;+$/) { | |
13214adf | 2422 | |
d8aaf121 | 2423 | # ; should have either the end of line or a space or \ after it |
13214adf | 2424 | } elsif ($op eq ';') { |
cf655043 AW |
2425 | if ($ctx !~ /.x[WEBC]/ && |
2426 | $cc !~ /^\\/ && $cc !~ /^;/) { | |
000d1cc1 JP |
2427 | ERROR("SPACING", |
2428 | "space required after that '$op' $at\n" . $hereptr); | |
d8aaf121 AW |
2429 | } |
2430 | ||
2431 | # // is a comment | |
2432 | } elsif ($op eq '//') { | |
0a920b5b | 2433 | |
1f65f947 AW |
2434 | # No spaces for: |
2435 | # -> | |
2436 | # : when part of a bitfield | |
2437 | } elsif ($op eq '->' || $opv eq ':B') { | |
4a0df2ef | 2438 | if ($ctx =~ /Wx.|.xW/) { |
000d1cc1 JP |
2439 | ERROR("SPACING", |
2440 | "spaces prohibited around that '$op' $at\n" . $hereptr); | |
0a920b5b AW |
2441 | } |
2442 | ||
2443 | # , must have a space on the right. | |
2444 | } elsif ($op eq ',') { | |
cf655043 | 2445 | if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { |
000d1cc1 JP |
2446 | ERROR("SPACING", |
2447 | "space required after that '$op' $at\n" . $hereptr); | |
0a920b5b AW |
2448 | } |
2449 | ||
9c0ca6f9 | 2450 | # '*' as part of a type definition -- reported already. |
74048ed8 | 2451 | } elsif ($opv eq '*_') { |
9c0ca6f9 AW |
2452 | #warn "'*' is part of type\n"; |
2453 | ||
2454 | # unary operators should have a space before and | |
2455 | # none after. May be left adjacent to another | |
2456 | # unary operator, or a cast | |
2457 | } elsif ($op eq '!' || $op eq '~' || | |
74048ed8 | 2458 | $opv eq '*U' || $opv eq '-U' || |
0d413866 | 2459 | $opv eq '&U' || $opv eq '&&U') { |
cf655043 | 2460 | if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { |
000d1cc1 JP |
2461 | ERROR("SPACING", |
2462 | "space required before that '$op' $at\n" . $hereptr); | |
0a920b5b | 2463 | } |
a3340b35 | 2464 | if ($op eq '*' && $cc =~/\s*$Modifier\b/) { |
171ae1a4 AW |
2465 | # A unary '*' may be const |
2466 | ||
2467 | } elsif ($ctx =~ /.xW/) { | |
000d1cc1 JP |
2468 | ERROR("SPACING", |
2469 | "space prohibited after that '$op' $at\n" . $hereptr); | |
0a920b5b AW |
2470 | } |
2471 | ||
2472 | # unary ++ and unary -- are allowed no space on one side. | |
2473 | } elsif ($op eq '++' or $op eq '--') { | |
773647a0 | 2474 | if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { |
000d1cc1 JP |
2475 | ERROR("SPACING", |
2476 | "space required one side of that '$op' $at\n" . $hereptr); | |
773647a0 AW |
2477 | } |
2478 | if ($ctx =~ /Wx[BE]/ || | |
2479 | ($ctx =~ /Wx./ && $cc =~ /^;/)) { | |
000d1cc1 JP |
2480 | ERROR("SPACING", |
2481 | "space prohibited before that '$op' $at\n" . $hereptr); | |
0a920b5b | 2482 | } |
773647a0 | 2483 | if ($ctx =~ /ExW/) { |
000d1cc1 JP |
2484 | ERROR("SPACING", |
2485 | "space prohibited after that '$op' $at\n" . $hereptr); | |
653d4876 | 2486 | } |
0a920b5b | 2487 | |
773647a0 | 2488 | |
0a920b5b | 2489 | # << and >> may either have or not have spaces both sides |
9c0ca6f9 AW |
2490 | } elsif ($op eq '<<' or $op eq '>>' or |
2491 | $op eq '&' or $op eq '^' or $op eq '|' or | |
2492 | $op eq '+' or $op eq '-' or | |
c2fdda0d AW |
2493 | $op eq '*' or $op eq '/' or |
2494 | $op eq '%') | |
0a920b5b | 2495 | { |
773647a0 | 2496 | if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { |
000d1cc1 JP |
2497 | ERROR("SPACING", |
2498 | "need consistent spacing around '$op' $at\n" . | |
de7d4f0e | 2499 | $hereptr); |
0a920b5b AW |
2500 | } |
2501 | ||
1f65f947 AW |
2502 | # A colon needs no spaces before when it is |
2503 | # terminating a case value or a label. | |
2504 | } elsif ($opv eq ':C' || $opv eq ':L') { | |
2505 | if ($ctx =~ /Wx./) { | |
000d1cc1 JP |
2506 | ERROR("SPACING", |
2507 | "space prohibited before that '$op' $at\n" . $hereptr); | |
1f65f947 AW |
2508 | } |
2509 | ||
0a920b5b | 2510 | # All the others need spaces both sides. |
cf655043 | 2511 | } elsif ($ctx !~ /[EWC]x[CWE]/) { |
1f65f947 AW |
2512 | my $ok = 0; |
2513 | ||
22f2a2ef | 2514 | # Ignore email addresses <foo@bar> |
1f65f947 AW |
2515 | if (($op eq '<' && |
2516 | $cc =~ /^\S+\@\S+>/) || | |
2517 | ($op eq '>' && | |
2518 | $ca =~ /<\S+\@\S+$/)) | |
2519 | { | |
2520 | $ok = 1; | |
2521 | } | |
2522 | ||
2523 | # Ignore ?: | |
2524 | if (($opv eq ':O' && $ca =~ /\?$/) || | |
2525 | ($op eq '?' && $cc =~ /^:/)) { | |
2526 | $ok = 1; | |
2527 | } | |
2528 | ||
2529 | if ($ok == 0) { | |
000d1cc1 JP |
2530 | ERROR("SPACING", |
2531 | "spaces required around that '$op' $at\n" . $hereptr); | |
22f2a2ef | 2532 | } |
0a920b5b | 2533 | } |
4a0df2ef | 2534 | $off += length($elements[$n + 1]); |
0a920b5b AW |
2535 | } |
2536 | } | |
2537 | ||
f0a594c1 AW |
2538 | # check for multiple assignments |
2539 | if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { | |
000d1cc1 JP |
2540 | CHK("MULTIPLE_ASSIGNMENTS", |
2541 | "multiple assignments should be avoided\n" . $herecurr); | |
f0a594c1 AW |
2542 | } |
2543 | ||
22f2a2ef AW |
2544 | ## # check for multiple declarations, allowing for a function declaration |
2545 | ## # continuation. | |
2546 | ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && | |
2547 | ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { | |
2548 | ## | |
2549 | ## # Remove any bracketed sections to ensure we do not | |
2550 | ## # falsly report the parameters of functions. | |
2551 | ## my $ln = $line; | |
2552 | ## while ($ln =~ s/\([^\(\)]*\)//g) { | |
2553 | ## } | |
2554 | ## if ($ln =~ /,/) { | |
000d1cc1 JP |
2555 | ## WARN("MULTIPLE_DECLARATION", |
2556 | ## "declaring multiple variables together should be avoided\n" . $herecurr); | |
22f2a2ef AW |
2557 | ## } |
2558 | ## } | |
f0a594c1 | 2559 | |
0a920b5b | 2560 | #need space before brace following if, while, etc |
22f2a2ef AW |
2561 | if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || |
2562 | $line =~ /do{/) { | |
000d1cc1 JP |
2563 | ERROR("SPACING", |
2564 | "space required before the open brace '{'\n" . $herecurr); | |
de7d4f0e AW |
2565 | } |
2566 | ||
2567 | # closing brace should have a space following it when it has anything | |
2568 | # on the line | |
2569 | if ($line =~ /}(?!(?:,|;|\)))\S/) { | |
000d1cc1 JP |
2570 | ERROR("SPACING", |
2571 | "space required after that close brace '}'\n" . $herecurr); | |
0a920b5b AW |
2572 | } |
2573 | ||
22f2a2ef AW |
2574 | # check spacing on square brackets |
2575 | if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { | |
000d1cc1 JP |
2576 | ERROR("SPACING", |
2577 | "space prohibited after that open square bracket '['\n" . $herecurr); | |
22f2a2ef AW |
2578 | } |
2579 | if ($line =~ /\s\]/) { | |
000d1cc1 JP |
2580 | ERROR("SPACING", |
2581 | "space prohibited before that close square bracket ']'\n" . $herecurr); | |
22f2a2ef AW |
2582 | } |
2583 | ||
c45dcabd | 2584 | # check spacing on parentheses |
9c0ca6f9 AW |
2585 | if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && |
2586 | $line !~ /for\s*\(\s+;/) { | |
000d1cc1 JP |
2587 | ERROR("SPACING", |
2588 | "space prohibited after that open parenthesis '('\n" . $herecurr); | |
22f2a2ef | 2589 | } |
13214adf | 2590 | if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && |
c45dcabd AW |
2591 | $line !~ /for\s*\(.*;\s+\)/ && |
2592 | $line !~ /:\s+\)/) { | |
000d1cc1 JP |
2593 | ERROR("SPACING", |
2594 | "space prohibited before that close parenthesis ')'\n" . $herecurr); | |
22f2a2ef AW |
2595 | } |
2596 | ||
0a920b5b | 2597 | #goto labels aren't indented, allow a single space however |
4a0df2ef | 2598 | if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and |
0a920b5b | 2599 | !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { |
000d1cc1 JP |
2600 | WARN("INDENTED_LABEL", |
2601 | "labels should not be indented\n" . $herecurr); | |
0a920b5b AW |
2602 | } |
2603 | ||
c45dcabd AW |
2604 | # Return is not a function. |
2605 | if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { | |
2606 | my $spacing = $1; | |
2607 | my $value = $2; | |
2608 | ||
86f9d059 | 2609 | # Flatten any parentheses |
fb2d2c1b AW |
2610 | $value =~ s/\(/ \(/g; |
2611 | $value =~ s/\)/\) /g; | |
e01886ad | 2612 | while ($value =~ s/\[[^\[\]]*\]/1/ || |
63f17f89 AW |
2613 | $value !~ /(?:$Ident|-?$Constant)\s* |
2614 | $Compare\s* | |
2615 | (?:$Ident|-?$Constant)/x && | |
2616 | $value =~ s/\([^\(\)]*\)/1/) { | |
c45dcabd | 2617 | } |
fb2d2c1b AW |
2618 | #print "value<$value>\n"; |
2619 | if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) { | |
000d1cc1 JP |
2620 | ERROR("RETURN_PARENTHESES", |
2621 | "return is not a function, parentheses are not required\n" . $herecurr); | |
c45dcabd AW |
2622 | |
2623 | } elsif ($spacing !~ /\s+/) { | |
000d1cc1 JP |
2624 | ERROR("SPACING", |
2625 | "space required before the open parenthesis '('\n" . $herecurr); | |
c45dcabd AW |
2626 | } |
2627 | } | |
53a3c448 AW |
2628 | # Return of what appears to be an errno should normally be -'ve |
2629 | if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { | |
2630 | my $name = $1; | |
2631 | if ($name ne 'EOF' && $name ne 'ERROR') { | |
000d1cc1 JP |
2632 | WARN("USE_NEGATIVE_ERRNO", |
2633 | "return of an errno should typically be -ve (return -$1)\n" . $herecurr); | |
53a3c448 AW |
2634 | } |
2635 | } | |
c45dcabd | 2636 | |
0a920b5b | 2637 | # Need a space before open parenthesis after if, while etc |
4a0df2ef | 2638 | if ($line=~/\b(if|while|for|switch)\(/) { |
000d1cc1 | 2639 | ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr); |
0a920b5b AW |
2640 | } |
2641 | ||
f5fe35dd AW |
2642 | # Check for illegal assignment in if conditional -- and check for trailing |
2643 | # statements after the conditional. | |
170d3a22 | 2644 | if ($line =~ /do\s*(?!{)/) { |
3e469cdc AW |
2645 | ($stat, $cond, $line_nr_next, $remain_next, $off_next) = |
2646 | ctx_statement_block($linenr, $realcnt, 0) | |
2647 | if (!defined $stat); | |
170d3a22 AW |
2648 | my ($stat_next) = ctx_statement_block($line_nr_next, |
2649 | $remain_next, $off_next); | |
2650 | $stat_next =~ s/\n./\n /g; | |
2651 | ##print "stat<$stat> stat_next<$stat_next>\n"; | |
2652 | ||
2653 | if ($stat_next =~ /^\s*while\b/) { | |
2654 | # If the statement carries leading newlines, | |
2655 | # then count those as offsets. | |
2656 | my ($whitespace) = | |
2657 | ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); | |
2658 | my $offset = | |
2659 | statement_rawlines($whitespace) - 1; | |
2660 | ||
2661 | $suppress_whiletrailers{$line_nr_next + | |
2662 | $offset} = 1; | |
2663 | } | |
2664 | } | |
2665 | if (!defined $suppress_whiletrailers{$linenr} && | |
2666 | $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { | |
171ae1a4 | 2667 | my ($s, $c) = ($stat, $cond); |
8905a67c | 2668 | |
b53c8e10 | 2669 | if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { |
000d1cc1 JP |
2670 | ERROR("ASSIGN_IN_IF", |
2671 | "do not use assignment in if condition\n" . $herecurr); | |
8905a67c AW |
2672 | } |
2673 | ||
2674 | # Find out what is on the end of the line after the | |
2675 | # conditional. | |
773647a0 | 2676 | substr($s, 0, length($c), ''); |
8905a67c | 2677 | $s =~ s/\n.*//g; |
13214adf | 2678 | $s =~ s/$;//g; # Remove any comments |
53210168 AW |
2679 | if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && |
2680 | $c !~ /}\s*while\s*/) | |
773647a0 | 2681 | { |
bb44ad39 AW |
2682 | # Find out how long the conditional actually is. |
2683 | my @newlines = ($c =~ /\n/gs); | |
2684 | my $cond_lines = 1 + $#newlines; | |
42bdf74c | 2685 | my $stat_real = ''; |
bb44ad39 | 2686 | |
42bdf74c HS |
2687 | $stat_real = raw_line($linenr, $cond_lines) |
2688 | . "\n" if ($cond_lines); | |
bb44ad39 AW |
2689 | if (defined($stat_real) && $cond_lines > 1) { |
2690 | $stat_real = "[...]\n$stat_real"; | |
2691 | } | |
2692 | ||
000d1cc1 JP |
2693 | ERROR("TRAILING_STATEMENTS", |
2694 | "trailing statements should be on next line\n" . $herecurr . $stat_real); | |
8905a67c AW |
2695 | } |
2696 | } | |
2697 | ||
13214adf AW |
2698 | # Check for bitwise tests written as boolean |
2699 | if ($line =~ / | |
2700 | (?: | |
2701 | (?:\[|\(|\&\&|\|\|) | |
2702 | \s*0[xX][0-9]+\s* | |
2703 | (?:\&\&|\|\|) | |
2704 | | | |
2705 | (?:\&\&|\|\|) | |
2706 | \s*0[xX][0-9]+\s* | |
2707 | (?:\&\&|\|\||\)|\]) | |
2708 | )/x) | |
2709 | { | |
000d1cc1 JP |
2710 | WARN("HEXADECIMAL_BOOLEAN_TEST", |
2711 | "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); | |
13214adf AW |
2712 | } |
2713 | ||
8905a67c | 2714 | # if and else should not have general statements after it |
13214adf AW |
2715 | if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { |
2716 | my $s = $1; | |
2717 | $s =~ s/$;//g; # Remove any comments | |
2718 | if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { | |
000d1cc1 JP |
2719 | ERROR("TRAILING_STATEMENTS", |
2720 | "trailing statements should be on next line\n" . $herecurr); | |
13214adf | 2721 | } |
0a920b5b | 2722 | } |
39667782 AW |
2723 | # if should not continue a brace |
2724 | if ($line =~ /}\s*if\b/) { | |
000d1cc1 JP |
2725 | ERROR("TRAILING_STATEMENTS", |
2726 | "trailing statements should be on next line\n" . | |
39667782 AW |
2727 | $herecurr); |
2728 | } | |
a1080bf8 AW |
2729 | # case and default should not have general statements after them |
2730 | if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && | |
2731 | $line !~ /\G(?: | |
3fef12d6 | 2732 | (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| |
a1080bf8 AW |
2733 | \s*return\s+ |
2734 | )/xg) | |
2735 | { | |
000d1cc1 JP |
2736 | ERROR("TRAILING_STATEMENTS", |
2737 | "trailing statements should be on next line\n" . $herecurr); | |
a1080bf8 | 2738 | } |
0a920b5b AW |
2739 | |
2740 | # Check for }<nl>else {, these must be at the same | |
2741 | # indent level to be relevant to each other. | |
2742 | if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and | |
2743 | $previndent == $indent) { | |
000d1cc1 JP |
2744 | ERROR("ELSE_AFTER_BRACE", |
2745 | "else should follow close brace '}'\n" . $hereprev); | |
0a920b5b AW |
2746 | } |
2747 | ||
c2fdda0d AW |
2748 | if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and |
2749 | $previndent == $indent) { | |
2750 | my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); | |
2751 | ||
2752 | # Find out what is on the end of the line after the | |
2753 | # conditional. | |
773647a0 | 2754 | substr($s, 0, length($c), ''); |
c2fdda0d AW |
2755 | $s =~ s/\n.*//g; |
2756 | ||
2757 | if ($s =~ /^\s*;/) { | |
000d1cc1 JP |
2758 | ERROR("WHILE_AFTER_BRACE", |
2759 | "while should follow close brace '}'\n" . $hereprev); | |
c2fdda0d AW |
2760 | } |
2761 | } | |
2762 | ||
0a920b5b AW |
2763 | #studly caps, commented out until figure out how to distinguish between use of existing and adding new |
2764 | # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { | |
2765 | # print "No studly caps, use _\n"; | |
2766 | # print "$herecurr"; | |
2767 | # $clean = 0; | |
2768 | # } | |
2769 | ||
2770 | #no spaces allowed after \ in define | |
c45dcabd | 2771 | if ($line=~/\#\s*define.*\\\s$/) { |
000d1cc1 JP |
2772 | WARN("WHITESPACE_AFTER_LINE_CONTINUATION", |
2773 | "Whitepspace after \\ makes next lines useless\n" . $herecurr); | |
0a920b5b AW |
2774 | } |
2775 | ||
653d4876 | 2776 | #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) |
c45dcabd | 2777 | if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { |
e09dec48 AW |
2778 | my $file = "$1.h"; |
2779 | my $checkfile = "include/linux/$file"; | |
2780 | if (-f "$root/$checkfile" && | |
2781 | $realfile ne $checkfile && | |
7840a94c | 2782 | $1 !~ /$allowed_asm_includes/) |
c45dcabd | 2783 | { |
e09dec48 | 2784 | if ($realfile =~ m{^arch/}) { |
000d1cc1 JP |
2785 | CHK("ARCH_INCLUDE_LINUX", |
2786 | "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); | |
e09dec48 | 2787 | } else { |
000d1cc1 JP |
2788 | WARN("INCLUDE_LINUX", |
2789 | "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); | |
e09dec48 | 2790 | } |
0a920b5b AW |
2791 | } |
2792 | } | |
2793 | ||
653d4876 AW |
2794 | # multi-statement macros should be enclosed in a do while loop, grab the |
2795 | # first statement and ensure its the whole macro if its not enclosed | |
cf655043 | 2796 | # in a known good container |
b8f96a31 AW |
2797 | if ($realfile !~ m@/vmlinux.lds.h$@ && |
2798 | $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { | |
d8aaf121 AW |
2799 | my $ln = $linenr; |
2800 | my $cnt = $realcnt; | |
c45dcabd AW |
2801 | my ($off, $dstat, $dcond, $rest); |
2802 | my $ctx = ''; | |
c45dcabd | 2803 | ($dstat, $dcond, $ln, $cnt, $off) = |
f74bd194 AW |
2804 | ctx_statement_block($linenr, $realcnt, 0); |
2805 | $ctx = $dstat; | |
c45dcabd | 2806 | #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; |
a3bb97a7 | 2807 | #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; |
c45dcabd | 2808 | |
f74bd194 | 2809 | $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; |
292f1a9b | 2810 | $dstat =~ s/$;//g; |
c45dcabd AW |
2811 | $dstat =~ s/\\\n.//g; |
2812 | $dstat =~ s/^\s*//s; | |
2813 | $dstat =~ s/\s*$//s; | |
de7d4f0e | 2814 | |
c45dcabd | 2815 | # Flatten any parentheses and braces |
bf30d6ed AW |
2816 | while ($dstat =~ s/\([^\(\)]*\)/1/ || |
2817 | $dstat =~ s/\{[^\{\}]*\}/1/ || | |
c81769fd | 2818 | $dstat =~ s/\[[^\[\]]*\]/1/) |
bf30d6ed | 2819 | { |
de7d4f0e | 2820 | } |
d8aaf121 | 2821 | |
c45dcabd AW |
2822 | my $exceptions = qr{ |
2823 | $Declare| | |
2824 | module_param_named| | |
2825 | MODULE_PARAM_DESC| | |
2826 | DECLARE_PER_CPU| | |
2827 | DEFINE_PER_CPU| | |
383099fd | 2828 | __typeof__\(| |
22fd2d3e SS |
2829 | union| |
2830 | struct| | |
ea71a0a0 AW |
2831 | \.$Ident\s*=\s*| |
2832 | ^\"|\"$ | |
c45dcabd | 2833 | }x; |
5eaa20b9 | 2834 | #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; |
f74bd194 AW |
2835 | if ($dstat ne '' && |
2836 | $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), | |
2837 | $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); | |
2838 | $dstat !~ /^(?:$Ident|-?$Constant)$/ && # 10 // foo() | |
2839 | $dstat !~ /$exceptions/ && | |
2840 | $dstat !~ /^\.$Ident\s*=/ && # .foo = | |
72f115f9 | 2841 | $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) |
f74bd194 AW |
2842 | $dstat !~ /^for\s*$Constant$/ && # for (...) |
2843 | $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() | |
2844 | $dstat !~ /^do\s*{/ && # do {... | |
2845 | $dstat !~ /^\({/) # ({... | |
2846 | { | |
2847 | $ctx =~ s/\n*$//; | |
2848 | my $herectx = $here . "\n"; | |
2849 | my $cnt = statement_rawlines($ctx); | |
2850 | ||
2851 | for (my $n = 0; $n < $cnt; $n++) { | |
2852 | $herectx .= raw_line($linenr, $n) . "\n"; | |
c45dcabd AW |
2853 | } |
2854 | ||
f74bd194 AW |
2855 | if ($dstat =~ /;/) { |
2856 | ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", | |
2857 | "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); | |
2858 | } else { | |
000d1cc1 | 2859 | ERROR("COMPLEX_MACRO", |
f74bd194 | 2860 | "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); |
d8aaf121 | 2861 | } |
653d4876 | 2862 | } |
0a920b5b AW |
2863 | } |
2864 | ||
080ba929 MF |
2865 | # make sure symbols are always wrapped with VMLINUX_SYMBOL() ... |
2866 | # all assignments may have only one of the following with an assignment: | |
2867 | # . | |
2868 | # ALIGN(...) | |
2869 | # VMLINUX_SYMBOL(...) | |
2870 | if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { | |
000d1cc1 JP |
2871 | WARN("MISSING_VMLINUX_SYMBOL", |
2872 | "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); | |
080ba929 MF |
2873 | } |
2874 | ||
f0a594c1 | 2875 | # check for redundant bracing round if etc |
13214adf AW |
2876 | if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { |
2877 | my ($level, $endln, @chunks) = | |
cf655043 | 2878 | ctx_statement_full($linenr, $realcnt, 1); |
13214adf | 2879 | #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; |
cf655043 AW |
2880 | #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; |
2881 | if ($#chunks > 0 && $level == 0) { | |
13214adf AW |
2882 | my $allowed = 0; |
2883 | my $seen = 0; | |
773647a0 | 2884 | my $herectx = $here . "\n"; |
cf655043 | 2885 | my $ln = $linenr - 1; |
13214adf AW |
2886 | for my $chunk (@chunks) { |
2887 | my ($cond, $block) = @{$chunk}; | |
2888 | ||
773647a0 AW |
2889 | # If the condition carries leading newlines, then count those as offsets. |
2890 | my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); | |
2891 | my $offset = statement_rawlines($whitespace) - 1; | |
2892 | ||
2893 | #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; | |
2894 | ||
2895 | # We have looked at and allowed this specific line. | |
2896 | $suppress_ifbraces{$ln + $offset} = 1; | |
2897 | ||
2898 | $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; | |
cf655043 AW |
2899 | $ln += statement_rawlines($block) - 1; |
2900 | ||
773647a0 | 2901 | substr($block, 0, length($cond), ''); |
13214adf AW |
2902 | |
2903 | $seen++ if ($block =~ /^\s*{/); | |
2904 | ||
cf655043 AW |
2905 | #print "cond<$cond> block<$block> allowed<$allowed>\n"; |
2906 | if (statement_lines($cond) > 1) { | |
2907 | #print "APW: ALLOWED: cond<$cond>\n"; | |
13214adf AW |
2908 | $allowed = 1; |
2909 | } | |
2910 | if ($block =~/\b(?:if|for|while)\b/) { | |
cf655043 | 2911 | #print "APW: ALLOWED: block<$block>\n"; |
13214adf AW |
2912 | $allowed = 1; |
2913 | } | |
cf655043 AW |
2914 | if (statement_block_size($block) > 1) { |
2915 | #print "APW: ALLOWED: lines block<$block>\n"; | |
13214adf AW |
2916 | $allowed = 1; |
2917 | } | |
2918 | } | |
2919 | if ($seen && !$allowed) { | |
000d1cc1 JP |
2920 | WARN("BRACES", |
2921 | "braces {} are not necessary for any arm of this statement\n" . $herectx); | |
13214adf AW |
2922 | } |
2923 | } | |
2924 | } | |
773647a0 | 2925 | if (!defined $suppress_ifbraces{$linenr - 1} && |
13214adf | 2926 | $line =~ /\b(if|while|for|else)\b/) { |
cf655043 AW |
2927 | my $allowed = 0; |
2928 | ||
2929 | # Check the pre-context. | |
2930 | if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { | |
2931 | #print "APW: ALLOWED: pre<$1>\n"; | |
2932 | $allowed = 1; | |
2933 | } | |
773647a0 AW |
2934 | |
2935 | my ($level, $endln, @chunks) = | |
2936 | ctx_statement_full($linenr, $realcnt, $-[0]); | |
2937 | ||
cf655043 AW |
2938 | # Check the condition. |
2939 | my ($cond, $block) = @{$chunks[0]}; | |
773647a0 | 2940 | #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; |
cf655043 | 2941 | if (defined $cond) { |
773647a0 | 2942 | substr($block, 0, length($cond), ''); |
cf655043 AW |
2943 | } |
2944 | if (statement_lines($cond) > 1) { | |
2945 | #print "APW: ALLOWED: cond<$cond>\n"; | |
2946 | $allowed = 1; | |
2947 | } | |
2948 | if ($block =~/\b(?:if|for|while)\b/) { | |
2949 | #print "APW: ALLOWED: block<$block>\n"; | |
2950 | $allowed = 1; | |
2951 | } | |
2952 | if (statement_block_size($block) > 1) { | |
2953 | #print "APW: ALLOWED: lines block<$block>\n"; | |
2954 | $allowed = 1; | |
2955 | } | |
2956 | # Check the post-context. | |
2957 | if (defined $chunks[1]) { | |
2958 | my ($cond, $block) = @{$chunks[1]}; | |
2959 | if (defined $cond) { | |
773647a0 | 2960 | substr($block, 0, length($cond), ''); |
cf655043 AW |
2961 | } |
2962 | if ($block =~ /^\s*\{/) { | |
2963 | #print "APW: ALLOWED: chunk-1 block<$block>\n"; | |
2964 | $allowed = 1; | |
2965 | } | |
2966 | } | |
2967 | if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { | |
69932487 | 2968 | my $herectx = $here . "\n"; |
f055663c | 2969 | my $cnt = statement_rawlines($block); |
cf655043 | 2970 | |
f055663c | 2971 | for (my $n = 0; $n < $cnt; $n++) { |
69932487 | 2972 | $herectx .= raw_line($linenr, $n) . "\n"; |
f0a594c1 | 2973 | } |
cf655043 | 2974 | |
000d1cc1 JP |
2975 | WARN("BRACES", |
2976 | "braces {} are not necessary for single statement blocks\n" . $herectx); | |
f0a594c1 AW |
2977 | } |
2978 | } | |
2979 | ||
653d4876 | 2980 | # don't include deprecated include files (uses RAW line) |
4a0df2ef | 2981 | for my $inc (@dep_includes) { |
c45dcabd | 2982 | if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) { |
000d1cc1 JP |
2983 | ERROR("DEPRECATED_INCLUDE", |
2984 | "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr); | |
0a920b5b AW |
2985 | } |
2986 | } | |
2987 | ||
4a0df2ef AW |
2988 | # don't use deprecated functions |
2989 | for my $func (@dep_functions) { | |
00df344f | 2990 | if ($line =~ /\b$func\b/) { |
000d1cc1 JP |
2991 | ERROR("DEPRECATED_FUNCTION", |
2992 | "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr); | |
4a0df2ef AW |
2993 | } |
2994 | } | |
2995 | ||
2996 | # no volatiles please | |
6c72ffaa AW |
2997 | my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; |
2998 | if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { | |
000d1cc1 JP |
2999 | WARN("VOLATILE", |
3000 | "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); | |
4a0df2ef AW |
3001 | } |
3002 | ||
00df344f | 3003 | # warn about #if 0 |
c45dcabd | 3004 | if ($line =~ /^.\s*\#\s*if\s+0\b/) { |
000d1cc1 JP |
3005 | CHK("REDUNDANT_CODE", |
3006 | "if this code is redundant consider removing it\n" . | |
de7d4f0e | 3007 | $herecurr); |
4a0df2ef AW |
3008 | } |
3009 | ||
f0a594c1 AW |
3010 | # check for needless kfree() checks |
3011 | if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { | |
3012 | my $expr = $1; | |
3013 | if ($line =~ /\bkfree\(\Q$expr\E\);/) { | |
000d1cc1 JP |
3014 | WARN("NEEDLESS_KFREE", |
3015 | "kfree(NULL) is safe this check is probably not required\n" . $hereprev); | |
f0a594c1 AW |
3016 | } |
3017 | } | |
4c432a8f GKH |
3018 | # check for needless usb_free_urb() checks |
3019 | if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { | |
3020 | my $expr = $1; | |
3021 | if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) { | |
000d1cc1 JP |
3022 | WARN("NEEDLESS_USB_FREE_URB", |
3023 | "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev); | |
4c432a8f GKH |
3024 | } |
3025 | } | |
f0a594c1 | 3026 | |
1a15a250 PP |
3027 | # prefer usleep_range over udelay |
3028 | if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) { | |
3029 | # ignore udelay's < 10, however | |
3030 | if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) { | |
000d1cc1 JP |
3031 | CHK("USLEEP_RANGE", |
3032 | "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); | |
1a15a250 PP |
3033 | } |
3034 | } | |
3035 | ||
09ef8725 PP |
3036 | # warn about unexpectedly long msleep's |
3037 | if ($line =~ /\bmsleep\s*\((\d+)\);/) { | |
3038 | if ($1 < 20) { | |
000d1cc1 JP |
3039 | WARN("MSLEEP", |
3040 | "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); | |
09ef8725 PP |
3041 | } |
3042 | } | |
3043 | ||
00df344f | 3044 | # warn about #ifdefs in C files |
c45dcabd | 3045 | # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { |
00df344f AW |
3046 | # print "#ifdef in C files should be avoided\n"; |
3047 | # print "$herecurr"; | |
3048 | # $clean = 0; | |
3049 | # } | |
3050 | ||
22f2a2ef | 3051 | # warn about spacing in #ifdefs |
c45dcabd | 3052 | if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { |
000d1cc1 JP |
3053 | ERROR("SPACING", |
3054 | "exactly one space required after that #$1\n" . $herecurr); | |
22f2a2ef AW |
3055 | } |
3056 | ||
4a0df2ef | 3057 | # check for spinlock_t definitions without a comment. |
171ae1a4 AW |
3058 | if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || |
3059 | $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { | |
4a0df2ef AW |
3060 | my $which = $1; |
3061 | if (!ctx_has_comment($first_line, $linenr)) { | |
000d1cc1 JP |
3062 | CHK("UNCOMMENTED_DEFINITION", |
3063 | "$1 definition without comment\n" . $herecurr); | |
4a0df2ef AW |
3064 | } |
3065 | } | |
3066 | # check for memory barriers without a comment. | |
3067 | if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { | |
3068 | if (!ctx_has_comment($first_line, $linenr)) { | |
000d1cc1 JP |
3069 | CHK("MEMORY_BARRIER", |
3070 | "memory barrier without comment\n" . $herecurr); | |
4a0df2ef AW |
3071 | } |
3072 | } | |
3073 | # check of hardware specific defines | |
c45dcabd | 3074 | if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { |
000d1cc1 JP |
3075 | CHK("ARCH_DEFINES", |
3076 | "architecture specific defines should be avoided\n" . $herecurr); | |
0a920b5b | 3077 | } |
653d4876 | 3078 | |
d4977c78 TK |
3079 | # Check that the storage class is at the beginning of a declaration |
3080 | if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { | |
000d1cc1 JP |
3081 | WARN("STORAGE_CLASS", |
3082 | "storage class should be at the beginning of the declaration\n" . $herecurr) | |
d4977c78 TK |
3083 | } |
3084 | ||
de7d4f0e AW |
3085 | # check the location of the inline attribute, that it is between |
3086 | # storage class and type. | |
9c0ca6f9 AW |
3087 | if ($line =~ /\b$Type\s+$Inline\b/ || |
3088 | $line =~ /\b$Inline\s+$Storage\b/) { | |
000d1cc1 JP |
3089 | ERROR("INLINE_LOCATION", |
3090 | "inline keyword should sit between storage class and type\n" . $herecurr); | |
de7d4f0e AW |
3091 | } |
3092 | ||
8905a67c AW |
3093 | # Check for __inline__ and __inline, prefer inline |
3094 | if ($line =~ /\b(__inline__|__inline)\b/) { | |
000d1cc1 JP |
3095 | WARN("INLINE", |
3096 | "plain inline is preferred over $1\n" . $herecurr); | |
8905a67c AW |
3097 | } |
3098 | ||
3d130fd0 JP |
3099 | # Check for __attribute__ packed, prefer __packed |
3100 | if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { | |
000d1cc1 JP |
3101 | WARN("PREFER_PACKED", |
3102 | "__packed is preferred over __attribute__((packed))\n" . $herecurr); | |
3d130fd0 JP |
3103 | } |
3104 | ||
39b7e287 JP |
3105 | # Check for __attribute__ aligned, prefer __aligned |
3106 | if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { | |
000d1cc1 JP |
3107 | WARN("PREFER_ALIGNED", |
3108 | "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); | |
39b7e287 JP |
3109 | } |
3110 | ||
5f14d3bd JP |
3111 | # Check for __attribute__ format(printf, prefer __printf |
3112 | if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { | |
3113 | WARN("PREFER_PRINTF", | |
3114 | "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr); | |
3115 | } | |
3116 | ||
8f53a9b8 JP |
3117 | # check for sizeof(&) |
3118 | if ($line =~ /\bsizeof\s*\(\s*\&/) { | |
000d1cc1 JP |
3119 | WARN("SIZEOF_ADDRESS", |
3120 | "sizeof(& should be avoided\n" . $herecurr); | |
8f53a9b8 JP |
3121 | } |
3122 | ||
428e2fdc JP |
3123 | # check for line continuations in quoted strings with odd counts of " |
3124 | if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { | |
000d1cc1 JP |
3125 | WARN("LINE_CONTINUATIONS", |
3126 | "Avoid line continuations in quoted strings\n" . $herecurr); | |
428e2fdc JP |
3127 | } |
3128 | ||
554e165c | 3129 | # Check for misused memsets |
d7c76ba7 JP |
3130 | if (defined $stat && |
3131 | $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { | |
3132 | ||
3133 | my $ms_addr = $2; | |
3134 | my $ms_val = $8; | |
3135 | my $ms_size = $14; | |
554e165c | 3136 | |
554e165c AW |
3137 | if ($ms_size =~ /^(0x|)0$/i) { |
3138 | ERROR("MEMSET", | |
d7c76ba7 | 3139 | "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); |
554e165c AW |
3140 | } elsif ($ms_size =~ /^(0x|)1$/i) { |
3141 | WARN("MEMSET", | |
d7c76ba7 JP |
3142 | "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); |
3143 | } | |
3144 | } | |
3145 | ||
3146 | # typecasts on min/max could be min_t/max_t | |
3147 | if (defined $stat && | |
3148 | $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { | |
3149 | if (defined $2 || defined $8) { | |
3150 | my $call = $1; | |
3151 | my $cast1 = deparenthesize($2); | |
3152 | my $arg1 = $3; | |
3153 | my $cast2 = deparenthesize($8); | |
3154 | my $arg2 = $9; | |
3155 | my $cast; | |
3156 | ||
3157 | if ($cast1 ne "" && $cast2 ne "") { | |
3158 | $cast = "$cast1 or $cast2"; | |
3159 | } elsif ($cast1 ne "") { | |
3160 | $cast = $cast1; | |
3161 | } else { | |
3162 | $cast = $cast2; | |
3163 | } | |
3164 | WARN("MINMAX", | |
3165 | "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); | |
554e165c AW |
3166 | } |
3167 | } | |
3168 | ||
de7d4f0e | 3169 | # check for new externs in .c files. |
171ae1a4 | 3170 | if ($realfile =~ /\.c$/ && defined $stat && |
c45dcabd | 3171 | $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) |
171ae1a4 | 3172 | { |
c45dcabd AW |
3173 | my $function_name = $1; |
3174 | my $paren_space = $2; | |
171ae1a4 AW |
3175 | |
3176 | my $s = $stat; | |
3177 | if (defined $cond) { | |
3178 | substr($s, 0, length($cond), ''); | |
3179 | } | |
c45dcabd AW |
3180 | if ($s =~ /^\s*;/ && |
3181 | $function_name ne 'uninitialized_var') | |
3182 | { | |
000d1cc1 JP |
3183 | WARN("AVOID_EXTERNS", |
3184 | "externs should be avoided in .c files\n" . $herecurr); | |
171ae1a4 AW |
3185 | } |
3186 | ||
3187 | if ($paren_space =~ /\n/) { | |
000d1cc1 JP |
3188 | WARN("FUNCTION_ARGUMENTS", |
3189 | "arguments for function declarations should follow identifier\n" . $herecurr); | |
171ae1a4 | 3190 | } |
9c9ba34e AW |
3191 | |
3192 | } elsif ($realfile =~ /\.c$/ && defined $stat && | |
3193 | $stat =~ /^.\s*extern\s+/) | |
3194 | { | |
000d1cc1 JP |
3195 | WARN("AVOID_EXTERNS", |
3196 | "externs should be avoided in .c files\n" . $herecurr); | |
de7d4f0e AW |
3197 | } |
3198 | ||
3199 | # checks for new __setup's | |
3200 | if ($rawline =~ /\b__setup\("([^"]*)"/) { | |
3201 | my $name = $1; | |
3202 | ||
3203 | if (!grep(/$name/, @setup_docs)) { | |
000d1cc1 JP |
3204 | CHK("UNDOCUMENTED_SETUP", |
3205 | "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); | |
de7d4f0e | 3206 | } |
653d4876 | 3207 | } |
9c0ca6f9 AW |
3208 | |
3209 | # check for pointless casting of kmalloc return | |
caf2a54f | 3210 | if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { |
000d1cc1 JP |
3211 | WARN("UNNECESSARY_CASTS", |
3212 | "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); | |
9c0ca6f9 | 3213 | } |
13214adf | 3214 | |
caf2a54f JP |
3215 | # check for multiple semicolons |
3216 | if ($line =~ /;\s*;\s*$/) { | |
000d1cc1 JP |
3217 | WARN("ONE_SEMICOLON", |
3218 | "Statements terminations use 1 semicolon\n" . $herecurr); | |
caf2a54f JP |
3219 | } |
3220 | ||
13214adf AW |
3221 | # check for gcc specific __FUNCTION__ |
3222 | if ($line =~ /__FUNCTION__/) { | |
000d1cc1 JP |
3223 | WARN("USE_FUNC", |
3224 | "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); | |
13214adf | 3225 | } |
773647a0 | 3226 | |
4882720b TG |
3227 | # check for semaphores initialized locked |
3228 | if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { | |
000d1cc1 JP |
3229 | WARN("CONSIDER_COMPLETION", |
3230 | "consider using a completion\n" . $herecurr); | |
1704f47b | 3231 | |
773647a0 | 3232 | } |
67d0a075 JP |
3233 | # recommend kstrto* over simple_strto* and strict_strto* |
3234 | if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { | |
000d1cc1 | 3235 | WARN("CONSIDER_KSTRTO", |
67d0a075 | 3236 | "$1 is obsolete, use k$3 instead\n" . $herecurr); |
773647a0 | 3237 | } |
f3db6639 ME |
3238 | # check for __initcall(), use device_initcall() explicitly please |
3239 | if ($line =~ /^.\s*__initcall\s*\(/) { | |
000d1cc1 JP |
3240 | WARN("USE_DEVICE_INITCALL", |
3241 | "please use device_initcall() instead of __initcall()\n" . $herecurr); | |
f3db6639 | 3242 | } |
79404849 ER |
3243 | # check for various ops structs, ensure they are const. |
3244 | my $struct_ops = qr{acpi_dock_ops| | |
3245 | address_space_operations| | |
3246 | backlight_ops| | |
3247 | block_device_operations| | |
3248 | dentry_operations| | |
3249 | dev_pm_ops| | |
3250 | dma_map_ops| | |
3251 | extent_io_ops| | |
3252 | file_lock_operations| | |
3253 | file_operations| | |
3254 | hv_ops| | |
3255 | ide_dma_ops| | |
3256 | intel_dvo_dev_ops| | |
3257 | item_operations| | |
3258 | iwl_ops| | |
3259 | kgdb_arch| | |
3260 | kgdb_io| | |
3261 | kset_uevent_ops| | |
3262 | lock_manager_operations| | |
3263 | microcode_ops| | |
3264 | mtrr_ops| | |
3265 | neigh_ops| | |
3266 | nlmsvc_binding| | |
3267 | pci_raw_ops| | |
3268 | pipe_buf_operations| | |
3269 | platform_hibernation_ops| | |
3270 | platform_suspend_ops| | |
3271 | proto_ops| | |
3272 | rpc_pipe_ops| | |
3273 | seq_operations| | |
3274 | snd_ac97_build_ops| | |
3275 | soc_pcmcia_socket_ops| | |
3276 | stacktrace_ops| | |
3277 | sysfs_ops| | |
3278 | tty_operations| | |
3279 | usb_mon_operations| | |
3280 | wd_ops}x; | |
6903ffb2 | 3281 | if ($line !~ /\bconst\b/ && |
79404849 | 3282 | $line =~ /\bstruct\s+($struct_ops)\b/) { |
000d1cc1 JP |
3283 | WARN("CONST_STRUCT", |
3284 | "struct $1 should normally be const\n" . | |
6903ffb2 | 3285 | $herecurr); |
2b6db5cb | 3286 | } |
773647a0 AW |
3287 | |
3288 | # use of NR_CPUS is usually wrong | |
3289 | # ignore definitions of NR_CPUS and usage to define arrays as likely right | |
3290 | if ($line =~ /\bNR_CPUS\b/ && | |
c45dcabd AW |
3291 | $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && |
3292 | $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && | |
171ae1a4 AW |
3293 | $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && |
3294 | $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && | |
3295 | $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) | |
773647a0 | 3296 | { |
000d1cc1 JP |
3297 | WARN("NR_CPUS", |
3298 | "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); | |
773647a0 | 3299 | } |
9c9ba34e AW |
3300 | |
3301 | # check for %L{u,d,i} in strings | |
3302 | my $string; | |
3303 | while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { | |
3304 | $string = substr($rawline, $-[1], $+[1] - $-[1]); | |
2a1bc5d5 | 3305 | $string =~ s/%%/__/g; |
9c9ba34e | 3306 | if ($string =~ /(?<!%)%L[udi]/) { |
000d1cc1 JP |
3307 | WARN("PRINTF_L", |
3308 | "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); | |
9c9ba34e AW |
3309 | last; |
3310 | } | |
3311 | } | |
691d77b6 AW |
3312 | |
3313 | # whine mightly about in_atomic | |
3314 | if ($line =~ /\bin_atomic\s*\(/) { | |
3315 | if ($realfile =~ m@^drivers/@) { | |
000d1cc1 JP |
3316 | ERROR("IN_ATOMIC", |
3317 | "do not use in_atomic in drivers\n" . $herecurr); | |
f4a87736 | 3318 | } elsif ($realfile !~ m@^kernel/@) { |
000d1cc1 JP |
3319 | WARN("IN_ATOMIC", |
3320 | "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); | |
691d77b6 AW |
3321 | } |
3322 | } | |
1704f47b PZ |
3323 | |
3324 | # check for lockdep_set_novalidate_class | |
3325 | if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || | |
3326 | $line =~ /__lockdep_no_validate__\s*\)/ ) { | |
3327 | if ($realfile !~ m@^kernel/lockdep@ && | |
3328 | $realfile !~ m@^include/linux/lockdep@ && | |
3329 | $realfile !~ m@^drivers/base/core@) { | |
000d1cc1 JP |
3330 | ERROR("LOCKDEP", |
3331 | "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); | |
1704f47b PZ |
3332 | } |
3333 | } | |
88f8831c DJ |
3334 | |
3335 | if ($line =~ /debugfs_create_file.*S_IWUGO/ || | |
3336 | $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { | |
000d1cc1 JP |
3337 | WARN("EXPORTED_WORLD_WRITABLE", |
3338 | "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); | |
88f8831c | 3339 | } |
13214adf AW |
3340 | } |
3341 | ||
3342 | # If we have no input at all, then there is nothing to report on | |
3343 | # so just keep quiet. | |
3344 | if ($#rawlines == -1) { | |
3345 | exit(0); | |
0a920b5b AW |
3346 | } |
3347 | ||
8905a67c AW |
3348 | # In mailback mode only produce a report in the negative, for |
3349 | # things that appear to be patches. | |
3350 | if ($mailback && ($clean == 1 || !$is_patch)) { | |
3351 | exit(0); | |
3352 | } | |
3353 | ||
3354 | # This is not a patch, and we are are in 'no-patch' mode so | |
3355 | # just keep quiet. | |
3356 | if (!$chk_patch && !$is_patch) { | |
3357 | exit(0); | |
3358 | } | |
3359 | ||
3360 | if (!$is_patch) { | |
000d1cc1 JP |
3361 | ERROR("NOT_UNIFIED_DIFF", |
3362 | "Does not appear to be a unified-diff format patch\n"); | |
0a920b5b AW |
3363 | } |
3364 | if ($is_patch && $chk_signoff && $signoff == 0) { | |
000d1cc1 JP |
3365 | ERROR("MISSING_SIGN_OFF", |
3366 | "Missing Signed-off-by: line(s)\n"); | |
0a920b5b AW |
3367 | } |
3368 | ||
8905a67c | 3369 | print report_dump(); |
13214adf AW |
3370 | if ($summary && !($clean == 1 && $quiet == 1)) { |
3371 | print "$filename " if ($summary_file); | |
8905a67c AW |
3372 | print "total: $cnt_error errors, $cnt_warn warnings, " . |
3373 | (($check)? "$cnt_chk checks, " : "") . | |
3374 | "$cnt_lines lines checked\n"; | |
3375 | print "\n" if ($quiet == 0); | |
f0a594c1 | 3376 | } |
8905a67c | 3377 | |
d2c0a235 AW |
3378 | if ($quiet == 0) { |
3379 | # If there were whitespace errors which cleanpatch can fix | |
3380 | # then suggest that. | |
3381 | if ($rpt_cleaners) { | |
3382 | print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; | |
3383 | print " scripts/cleanfile\n\n"; | |
b0781216 | 3384 | $rpt_cleaners = 0; |
d2c0a235 AW |
3385 | } |
3386 | } | |
3387 | ||
000d1cc1 JP |
3388 | if (keys %ignore_type) { |
3389 | print "NOTE: Ignored message types:"; | |
3390 | foreach my $ignore (sort keys %ignore_type) { | |
3391 | print " $ignore"; | |
3392 | } | |
3393 | print "\n"; | |
3394 | print "\n" if ($quiet == 0); | |
3395 | } | |
3396 | ||
0a920b5b | 3397 | if ($clean == 1 && $quiet == 0) { |
c2fdda0d | 3398 | print "$vname has no obvious style problems and is ready for submission.\n" |
0a920b5b AW |
3399 | } |
3400 | if ($clean == 0 && $quiet == 0) { | |
000d1cc1 JP |
3401 | print << "EOM"; |
3402 | $vname has style problems, please review. | |
3403 | ||
3404 | If any of these errors are false positives, please report | |
3405 | them to the maintainer, see CHECKPATCH in MAINTAINERS. | |
3406 | EOM | |
0a920b5b | 3407 | } |
13214adf | 3408 | |
0a920b5b AW |
3409 | return $clean; |
3410 | } |