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 | (?: |
c45dcabd | 318 | (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\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); | |
1035 | $type = 'C'; | |
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__| | |
1227 | do | |
9a974fdb | 1228 | )(?:\s|$)| |
0776e594 | 1229 | ^(?:typedef|struct|enum)\b |
9a974fdb AW |
1230 | )}x; |
1231 | warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); | |
1232 | if ($possible !~ $notPermitted) { | |
c45dcabd AW |
1233 | # Check for modifiers. |
1234 | $possible =~ s/\s*$Storage\s*//g; | |
1235 | $possible =~ s/\s*$Sparse\s*//g; | |
1236 | if ($possible =~ /^\s*$/) { | |
1237 | ||
1238 | } elsif ($possible =~ /\s/) { | |
1239 | $possible =~ s/\s*$Type\s*//g; | |
d2506586 | 1240 | for my $modifier (split(' ', $possible)) { |
9a974fdb AW |
1241 | if ($modifier !~ $notPermitted) { |
1242 | warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); | |
1243 | push(@modifierList, $modifier); | |
1244 | } | |
d2506586 | 1245 | } |
c45dcabd AW |
1246 | |
1247 | } else { | |
1248 | warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); | |
1249 | push(@typeList, $possible); | |
1250 | } | |
8905a67c | 1251 | build_types(); |
0776e594 AW |
1252 | } else { |
1253 | warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); | |
8905a67c AW |
1254 | } |
1255 | } | |
1256 | ||
6c72ffaa AW |
1257 | my $prefix = ''; |
1258 | ||
000d1cc1 JP |
1259 | sub show_type { |
1260 | return !defined $ignore_type{$_[0]}; | |
1261 | } | |
1262 | ||
f0a594c1 | 1263 | sub report { |
000d1cc1 JP |
1264 | if (!show_type($_[1]) || |
1265 | (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) { | |
773647a0 AW |
1266 | return 0; |
1267 | } | |
000d1cc1 JP |
1268 | my $line; |
1269 | if ($show_types) { | |
1270 | $line = "$prefix$_[0]:$_[1]: $_[2]\n"; | |
1271 | } else { | |
1272 | $line = "$prefix$_[0]: $_[2]\n"; | |
1273 | } | |
8905a67c AW |
1274 | $line = (split('\n', $line))[0] . "\n" if ($terse); |
1275 | ||
13214adf | 1276 | push(our @report, $line); |
773647a0 AW |
1277 | |
1278 | return 1; | |
f0a594c1 AW |
1279 | } |
1280 | sub report_dump { | |
13214adf | 1281 | our @report; |
f0a594c1 | 1282 | } |
000d1cc1 | 1283 | |
de7d4f0e | 1284 | sub ERROR { |
000d1cc1 | 1285 | if (report("ERROR", $_[0], $_[1])) { |
773647a0 AW |
1286 | our $clean = 0; |
1287 | our $cnt_error++; | |
1288 | } | |
de7d4f0e AW |
1289 | } |
1290 | sub WARN { | |
000d1cc1 | 1291 | if (report("WARNING", $_[0], $_[1])) { |
773647a0 AW |
1292 | our $clean = 0; |
1293 | our $cnt_warn++; | |
1294 | } | |
de7d4f0e AW |
1295 | } |
1296 | sub CHK { | |
000d1cc1 | 1297 | if ($check && report("CHECK", $_[0], $_[1])) { |
6c72ffaa AW |
1298 | our $clean = 0; |
1299 | our $cnt_chk++; | |
1300 | } | |
de7d4f0e AW |
1301 | } |
1302 | ||
6ecd9674 AW |
1303 | sub check_absolute_file { |
1304 | my ($absolute, $herecurr) = @_; | |
1305 | my $file = $absolute; | |
1306 | ||
1307 | ##print "absolute<$absolute>\n"; | |
1308 | ||
1309 | # See if any suffix of this path is a path within the tree. | |
1310 | while ($file =~ s@^[^/]*/@@) { | |
1311 | if (-f "$root/$file") { | |
1312 | ##print "file<$file>\n"; | |
1313 | last; | |
1314 | } | |
1315 | } | |
1316 | if (! -f _) { | |
1317 | return 0; | |
1318 | } | |
1319 | ||
1320 | # It is, so see if the prefix is acceptable. | |
1321 | my $prefix = $absolute; | |
1322 | substr($prefix, -length($file)) = ''; | |
1323 | ||
1324 | ##print "prefix<$prefix>\n"; | |
1325 | if ($prefix ne ".../") { | |
000d1cc1 JP |
1326 | WARN("USE_RELATIVE_PATH", |
1327 | "use relative pathname instead of absolute in changelog text\n" . $herecurr); | |
6ecd9674 AW |
1328 | } |
1329 | } | |
1330 | ||
0a920b5b AW |
1331 | sub process { |
1332 | my $filename = shift; | |
0a920b5b AW |
1333 | |
1334 | my $linenr=0; | |
1335 | my $prevline=""; | |
c2fdda0d | 1336 | my $prevrawline=""; |
0a920b5b | 1337 | my $stashline=""; |
c2fdda0d | 1338 | my $stashrawline=""; |
0a920b5b | 1339 | |
4a0df2ef | 1340 | my $length; |
0a920b5b AW |
1341 | my $indent; |
1342 | my $previndent=0; | |
1343 | my $stashindent=0; | |
1344 | ||
de7d4f0e | 1345 | our $clean = 1; |
0a920b5b AW |
1346 | my $signoff = 0; |
1347 | my $is_patch = 0; | |
1348 | ||
15662b3e JP |
1349 | my $in_header_lines = 1; |
1350 | my $in_commit_log = 0; #Scanning lines before patch | |
1351 | ||
13214adf | 1352 | our @report = (); |
6c72ffaa AW |
1353 | our $cnt_lines = 0; |
1354 | our $cnt_error = 0; | |
1355 | our $cnt_warn = 0; | |
1356 | our $cnt_chk = 0; | |
1357 | ||
0a920b5b AW |
1358 | # Trace the real file/line as we go. |
1359 | my $realfile = ''; | |
1360 | my $realline = 0; | |
1361 | my $realcnt = 0; | |
1362 | my $here = ''; | |
1363 | my $in_comment = 0; | |
c2fdda0d | 1364 | my $comment_edge = 0; |
0a920b5b | 1365 | my $first_line = 0; |
1e855726 | 1366 | my $p1_prefix = ''; |
0a920b5b | 1367 | |
13214adf AW |
1368 | my $prev_values = 'E'; |
1369 | ||
1370 | # suppression flags | |
773647a0 | 1371 | my %suppress_ifbraces; |
170d3a22 | 1372 | my %suppress_whiletrailers; |
2b474a1a | 1373 | my %suppress_export; |
653d4876 | 1374 | |
c2fdda0d | 1375 | # Pre-scan the patch sanitizing the lines. |
de7d4f0e | 1376 | # Pre-scan the patch looking for any __setup documentation. |
c2fdda0d | 1377 | # |
de7d4f0e AW |
1378 | my @setup_docs = (); |
1379 | my $setup_docs = 0; | |
773647a0 AW |
1380 | |
1381 | sanitise_line_reset(); | |
c2fdda0d AW |
1382 | my $line; |
1383 | foreach my $rawline (@rawlines) { | |
773647a0 AW |
1384 | $linenr++; |
1385 | $line = $rawline; | |
c2fdda0d | 1386 | |
773647a0 | 1387 | if ($rawline=~/^\+\+\+\s+(\S+)/) { |
de7d4f0e AW |
1388 | $setup_docs = 0; |
1389 | if ($1 =~ m@Documentation/kernel-parameters.txt$@) { | |
1390 | $setup_docs = 1; | |
1391 | } | |
773647a0 AW |
1392 | #next; |
1393 | } | |
1394 | if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { | |
1395 | $realline=$1-1; | |
1396 | if (defined $2) { | |
1397 | $realcnt=$3+1; | |
1398 | } else { | |
1399 | $realcnt=1+1; | |
1400 | } | |
c45dcabd | 1401 | $in_comment = 0; |
773647a0 AW |
1402 | |
1403 | # Guestimate if this is a continuing comment. Run | |
1404 | # the context looking for a comment "edge". If this | |
1405 | # edge is a close comment then we must be in a comment | |
1406 | # at context start. | |
1407 | my $edge; | |
01fa9147 AW |
1408 | my $cnt = $realcnt; |
1409 | for (my $ln = $linenr + 1; $cnt > 0; $ln++) { | |
1410 | next if (defined $rawlines[$ln - 1] && | |
1411 | $rawlines[$ln - 1] =~ /^-/); | |
1412 | $cnt--; | |
1413 | #print "RAW<$rawlines[$ln - 1]>\n"; | |
721c1cb6 | 1414 | last if (!defined $rawlines[$ln - 1]); |
fae17dae AW |
1415 | if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && |
1416 | $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { | |
1417 | ($edge) = $1; | |
1418 | last; | |
1419 | } | |
773647a0 AW |
1420 | } |
1421 | if (defined $edge && $edge eq '*/') { | |
1422 | $in_comment = 1; | |
1423 | } | |
1424 | ||
1425 | # Guestimate if this is a continuing comment. If this | |
1426 | # is the start of a diff block and this line starts | |
1427 | # ' *' then it is very likely a comment. | |
1428 | if (!defined $edge && | |
83242e0c | 1429 | $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) |
773647a0 AW |
1430 | { |
1431 | $in_comment = 1; | |
1432 | } | |
1433 | ||
1434 | ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; | |
1435 | sanitise_line_reset($in_comment); | |
1436 | ||
171ae1a4 | 1437 | } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { |
773647a0 | 1438 | # Standardise the strings and chars within the input to |
171ae1a4 | 1439 | # simplify matching -- only bother with positive lines. |
773647a0 | 1440 | $line = sanitise_line($rawline); |
de7d4f0e | 1441 | } |
773647a0 AW |
1442 | push(@lines, $line); |
1443 | ||
1444 | if ($realcnt > 1) { | |
1445 | $realcnt-- if ($line =~ /^(?:\+| |$)/); | |
1446 | } else { | |
1447 | $realcnt = 0; | |
1448 | } | |
1449 | ||
1450 | #print "==>$rawline\n"; | |
1451 | #print "-->$line\n"; | |
de7d4f0e AW |
1452 | |
1453 | if ($setup_docs && $line =~ /^\+/) { | |
1454 | push(@setup_docs, $line); | |
1455 | } | |
1456 | } | |
1457 | ||
6c72ffaa AW |
1458 | $prefix = ''; |
1459 | ||
773647a0 AW |
1460 | $realcnt = 0; |
1461 | $linenr = 0; | |
0a920b5b AW |
1462 | foreach my $line (@lines) { |
1463 | $linenr++; | |
1464 | ||
c2fdda0d | 1465 | my $rawline = $rawlines[$linenr - 1]; |
6c72ffaa | 1466 | |
0a920b5b | 1467 | #extract the line range in the file after the patch is applied |
6c72ffaa | 1468 | if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { |
0a920b5b | 1469 | $is_patch = 1; |
4a0df2ef | 1470 | $first_line = $linenr + 1; |
0a920b5b AW |
1471 | $realline=$1-1; |
1472 | if (defined $2) { | |
1473 | $realcnt=$3+1; | |
1474 | } else { | |
1475 | $realcnt=1+1; | |
1476 | } | |
c2fdda0d | 1477 | annotate_reset(); |
13214adf AW |
1478 | $prev_values = 'E'; |
1479 | ||
773647a0 | 1480 | %suppress_ifbraces = (); |
170d3a22 | 1481 | %suppress_whiletrailers = (); |
2b474a1a | 1482 | %suppress_export = (); |
0a920b5b | 1483 | next; |
0a920b5b | 1484 | |
4a0df2ef AW |
1485 | # track the line number as we move through the hunk, note that |
1486 | # new versions of GNU diff omit the leading space on completely | |
1487 | # blank context lines so we need to count that too. | |
773647a0 | 1488 | } elsif ($line =~ /^( |\+|$)/) { |
0a920b5b | 1489 | $realline++; |
d8aaf121 | 1490 | $realcnt-- if ($realcnt != 0); |
0a920b5b | 1491 | |
4a0df2ef | 1492 | # Measure the line length and indent. |
c2fdda0d | 1493 | ($length, $indent) = line_stats($rawline); |
0a920b5b AW |
1494 | |
1495 | # Track the previous line. | |
1496 | ($prevline, $stashline) = ($stashline, $line); | |
1497 | ($previndent, $stashindent) = ($stashindent, $indent); | |
c2fdda0d AW |
1498 | ($prevrawline, $stashrawline) = ($stashrawline, $rawline); |
1499 | ||
773647a0 | 1500 | #warn "line<$line>\n"; |
6c72ffaa | 1501 | |
d8aaf121 AW |
1502 | } elsif ($realcnt == 1) { |
1503 | $realcnt--; | |
0a920b5b AW |
1504 | } |
1505 | ||
cc77cdca AW |
1506 | my $hunk_line = ($realcnt != 0); |
1507 | ||
0a920b5b | 1508 | #make up the handle for any error we report on this line |
773647a0 AW |
1509 | $prefix = "$filename:$realline: " if ($emacs && $file); |
1510 | $prefix = "$filename:$linenr: " if ($emacs && !$file); | |
1511 | ||
6c72ffaa AW |
1512 | $here = "#$linenr: " if (!$file); |
1513 | $here = "#$realline: " if ($file); | |
773647a0 AW |
1514 | |
1515 | # extract the filename as it passes | |
3bf9a009 RV |
1516 | if ($line =~ /^diff --git.*?(\S+)$/) { |
1517 | $realfile = $1; | |
1518 | $realfile =~ s@^([^/]*)/@@; | |
270c49a0 | 1519 | $in_commit_log = 0; |
3bf9a009 | 1520 | } elsif ($line =~ /^\+\+\+\s+(\S+)/) { |
773647a0 | 1521 | $realfile = $1; |
1e855726 | 1522 | $realfile =~ s@^([^/]*)/@@; |
270c49a0 | 1523 | $in_commit_log = 0; |
1e855726 WS |
1524 | |
1525 | $p1_prefix = $1; | |
e2f7aa4b AW |
1526 | if (!$file && $tree && $p1_prefix ne '' && |
1527 | -e "$root/$p1_prefix") { | |
000d1cc1 JP |
1528 | WARN("PATCH_PREFIX", |
1529 | "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); | |
1e855726 | 1530 | } |
773647a0 | 1531 | |
c1ab3326 | 1532 | if ($realfile =~ m@^include/asm/@) { |
000d1cc1 JP |
1533 | ERROR("MODIFIED_INCLUDE_ASM", |
1534 | "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); | |
773647a0 AW |
1535 | } |
1536 | next; | |
1537 | } | |
1538 | ||
389834b6 | 1539 | $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); |
0a920b5b | 1540 | |
c2fdda0d AW |
1541 | my $hereline = "$here\n$rawline\n"; |
1542 | my $herecurr = "$here\n$rawline\n"; | |
1543 | my $hereprev = "$here\n$prevrawline\n$rawline\n"; | |
0a920b5b | 1544 | |
6c72ffaa AW |
1545 | $cnt_lines++ if ($realcnt != 0); |
1546 | ||
3bf9a009 RV |
1547 | # Check for incorrect file permissions |
1548 | if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { | |
1549 | my $permhere = $here . "FILE: $realfile\n"; | |
1550 | if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) { | |
000d1cc1 JP |
1551 | ERROR("EXECUTE_PERMISSIONS", |
1552 | "do not set execute permissions for source files\n" . $permhere); | |
3bf9a009 RV |
1553 | } |
1554 | } | |
1555 | ||
20112475 | 1556 | # Check the patch for a signoff: |
d8aaf121 | 1557 | if ($line =~ /^\s*signed-off-by:/i) { |
4a0df2ef | 1558 | $signoff++; |
15662b3e | 1559 | $in_commit_log = 0; |
20112475 JP |
1560 | } |
1561 | ||
1562 | # Check signature styles | |
270c49a0 JP |
1563 | if (!$in_header_lines && |
1564 | $line =~ /^(\s*)($signature_tags)(\s*)(.*)/) { | |
20112475 JP |
1565 | my $space_before = $1; |
1566 | my $sign_off = $2; | |
1567 | my $space_after = $3; | |
1568 | my $email = $4; | |
1569 | my $ucfirst_sign_off = ucfirst(lc($sign_off)); | |
1570 | ||
1571 | if (defined $space_before && $space_before ne "") { | |
000d1cc1 JP |
1572 | WARN("BAD_SIGN_OFF", |
1573 | "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr); | |
20112475 JP |
1574 | } |
1575 | if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { | |
000d1cc1 JP |
1576 | WARN("BAD_SIGN_OFF", |
1577 | "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr); | |
20112475 JP |
1578 | } |
1579 | if (!defined $space_after || $space_after ne " ") { | |
000d1cc1 JP |
1580 | WARN("BAD_SIGN_OFF", |
1581 | "Use a single space after $ucfirst_sign_off\n" . $herecurr); | |
0a920b5b | 1582 | } |
20112475 JP |
1583 | |
1584 | my ($email_name, $email_address, $comment) = parse_email($email); | |
1585 | my $suggested_email = format_email(($email_name, $email_address)); | |
1586 | if ($suggested_email eq "") { | |
000d1cc1 JP |
1587 | ERROR("BAD_SIGN_OFF", |
1588 | "Unrecognized email address: '$email'\n" . $herecurr); | |
20112475 JP |
1589 | } else { |
1590 | my $dequoted = $suggested_email; | |
1591 | $dequoted =~ s/^"//; | |
1592 | $dequoted =~ s/" </ </; | |
1593 | # Don't force email to have quotes | |
1594 | # Allow just an angle bracketed address | |
1595 | if ("$dequoted$comment" ne $email && | |
1596 | "<$email_address>$comment" ne $email && | |
1597 | "$suggested_email$comment" ne $email) { | |
000d1cc1 JP |
1598 | WARN("BAD_SIGN_OFF", |
1599 | "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr); | |
20112475 | 1600 | } |
0a920b5b AW |
1601 | } |
1602 | } | |
1603 | ||
00df344f | 1604 | # Check for wrappage within a valid hunk of the file |
8905a67c | 1605 | if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { |
000d1cc1 JP |
1606 | ERROR("CORRUPTED_PATCH", |
1607 | "patch seems to be corrupt (line wrapped?)\n" . | |
6c72ffaa | 1608 | $herecurr) if (!$emitted_corrupt++); |
de7d4f0e AW |
1609 | } |
1610 | ||
6ecd9674 AW |
1611 | # Check for absolute kernel paths. |
1612 | if ($tree) { | |
1613 | while ($line =~ m{(?:^|\s)(/\S*)}g) { | |
1614 | my $file = $1; | |
1615 | ||
1616 | if ($file =~ m{^(.*?)(?::\d+)+:?$} && | |
1617 | check_absolute_file($1, $herecurr)) { | |
1618 | # | |
1619 | } else { | |
1620 | check_absolute_file($file, $herecurr); | |
1621 | } | |
1622 | } | |
1623 | } | |
1624 | ||
de7d4f0e AW |
1625 | # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php |
1626 | if (($realfile =~ /^$/ || $line =~ /^\+/) && | |
171ae1a4 AW |
1627 | $rawline !~ m/^$UTF8*$/) { |
1628 | my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); | |
1629 | ||
1630 | my $blank = copy_spacing($rawline); | |
1631 | my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; | |
1632 | my $hereptr = "$hereline$ptr\n"; | |
1633 | ||
34d99219 JP |
1634 | CHK("INVALID_UTF8", |
1635 | "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); | |
00df344f AW |
1636 | } |
1637 | ||
15662b3e JP |
1638 | # Check if it's the start of a commit log |
1639 | # (not a header line and we haven't seen the patch filename) | |
1640 | if ($in_header_lines && $realfile =~ /^$/ && | |
270c49a0 | 1641 | $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) { |
15662b3e JP |
1642 | $in_header_lines = 0; |
1643 | $in_commit_log = 1; | |
1644 | } | |
1645 | ||
1646 | # Still not yet in a patch, check for any UTF-8 | |
1647 | if ($in_commit_log && $realfile =~ /^$/ && | |
1648 | $rawline =~ /$NON_ASCII_UTF8/) { | |
1649 | CHK("UTF8_BEFORE_PATCH", | |
1650 | "8-bit UTF-8 used in possible commit log\n" . $herecurr); | |
1651 | } | |
1652 | ||
30670854 AW |
1653 | # ignore non-hunk lines and lines being removed |
1654 | next if (!$hunk_line || $line =~ /^-/); | |
0a920b5b | 1655 | |
0a920b5b | 1656 | #trailing whitespace |
9c0ca6f9 | 1657 | if ($line =~ /^\+.*\015/) { |
c2fdda0d | 1658 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
000d1cc1 JP |
1659 | ERROR("DOS_LINE_ENDINGS", |
1660 | "DOS line endings\n" . $herevet); | |
9c0ca6f9 | 1661 | |
c2fdda0d AW |
1662 | } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { |
1663 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; | |
000d1cc1 JP |
1664 | ERROR("TRAILING_WHITESPACE", |
1665 | "trailing whitespace\n" . $herevet); | |
d2c0a235 | 1666 | $rpt_cleaners = 1; |
0a920b5b | 1667 | } |
5368df20 | 1668 | |
3354957a | 1669 | # check for Kconfig help text having a real description |
9fe287d7 AW |
1670 | # Only applies when adding the entry originally, after that we do not have |
1671 | # sufficient context to determine whether it is indeed long enough. | |
3354957a | 1672 | if ($realfile =~ /Kconfig/ && |
9fe287d7 | 1673 | $line =~ /\+\s*(?:---)?help(?:---)?$/) { |
3354957a | 1674 | my $length = 0; |
9fe287d7 AW |
1675 | my $cnt = $realcnt; |
1676 | my $ln = $linenr + 1; | |
1677 | my $f; | |
1678 | my $is_end = 0; | |
1679 | while ($cnt > 0 && defined $lines[$ln - 1]) { | |
1680 | $f = $lines[$ln - 1]; | |
1681 | $cnt-- if ($lines[$ln - 1] !~ /^-/); | |
1682 | $is_end = $lines[$ln - 1] =~ /^\+/; | |
1683 | $ln++; | |
1684 | ||
1685 | next if ($f =~ /^-/); | |
1686 | $f =~ s/^.//; | |
3354957a AK |
1687 | $f =~ s/#.*//; |
1688 | $f =~ s/^\s+//; | |
1689 | next if ($f =~ /^$/); | |
9fe287d7 AW |
1690 | if ($f =~ /^\s*config\s/) { |
1691 | $is_end = 1; | |
1692 | last; | |
1693 | } | |
3354957a AK |
1694 | $length++; |
1695 | } | |
000d1cc1 JP |
1696 | WARN("CONFIG_DESCRIPTION", |
1697 | "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_end && $length < 4); | |
9fe287d7 | 1698 | #print "is_end<$is_end> length<$length>\n"; |
3354957a AK |
1699 | } |
1700 | ||
c68e5878 AL |
1701 | if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && |
1702 | ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { | |
1703 | my $flag = $1; | |
1704 | my $replacement = { | |
1705 | 'EXTRA_AFLAGS' => 'asflags-y', | |
1706 | 'EXTRA_CFLAGS' => 'ccflags-y', | |
1707 | 'EXTRA_CPPFLAGS' => 'cppflags-y', | |
1708 | 'EXTRA_LDFLAGS' => 'ldflags-y', | |
1709 | }; | |
1710 | ||
1711 | WARN("DEPRECATED_VARIABLE", | |
1712 | "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); | |
1713 | } | |
1714 | ||
5368df20 AW |
1715 | # check we are in a valid source file if not then ignore this hunk |
1716 | next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/); | |
1717 | ||
0a920b5b | 1718 | #80 column limit |
c45dcabd | 1719 | if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ && |
f4c014c0 | 1720 | $rawline !~ /^.\s*\*\s*\@$Ident\s/ && |
0fccc622 | 1721 | !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ || |
8bbea968 | 1722 | $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && |
f4c014c0 | 1723 | $length > 80) |
c45dcabd | 1724 | { |
000d1cc1 JP |
1725 | WARN("LONG_LINE", |
1726 | "line over 80 characters\n" . $herecurr); | |
0a920b5b AW |
1727 | } |
1728 | ||
5e79d96e JP |
1729 | # check for spaces before a quoted newline |
1730 | if ($rawline =~ /^.*\".*\s\\n/) { | |
000d1cc1 JP |
1731 | WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", |
1732 | "unnecessary whitespace before a quoted newline\n" . $herecurr); | |
5e79d96e JP |
1733 | } |
1734 | ||
8905a67c AW |
1735 | # check for adding lines without a newline. |
1736 | if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { | |
000d1cc1 JP |
1737 | WARN("MISSING_EOF_NEWLINE", |
1738 | "adding a line without newline at end of file\n" . $herecurr); | |
8905a67c AW |
1739 | } |
1740 | ||
42e41c54 MF |
1741 | # Blackfin: use hi/lo macros |
1742 | if ($realfile =~ m@arch/blackfin/.*\.S$@) { | |
1743 | if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) { | |
1744 | my $herevet = "$here\n" . cat_vet($line) . "\n"; | |
000d1cc1 JP |
1745 | ERROR("LO_MACRO", |
1746 | "use the LO() macro, not (... & 0xFFFF)\n" . $herevet); | |
42e41c54 MF |
1747 | } |
1748 | if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) { | |
1749 | my $herevet = "$here\n" . cat_vet($line) . "\n"; | |
000d1cc1 JP |
1750 | ERROR("HI_MACRO", |
1751 | "use the HI() macro, not (... >> 16)\n" . $herevet); | |
42e41c54 MF |
1752 | } |
1753 | } | |
1754 | ||
b9ea10d6 AW |
1755 | # check we are in a valid source file C or perl if not then ignore this hunk |
1756 | next if ($realfile !~ /\.(h|c|pl)$/); | |
0a920b5b AW |
1757 | |
1758 | # at the beginning of a line any tabs must come first and anything | |
1759 | # more than 8 must use tabs. | |
c2fdda0d AW |
1760 | if ($rawline =~ /^\+\s* \t\s*\S/ || |
1761 | $rawline =~ /^\+\s* \s*/) { | |
1762 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; | |
000d1cc1 JP |
1763 | ERROR("CODE_INDENT", |
1764 | "code indent should use tabs where possible\n" . $herevet); | |
d2c0a235 | 1765 | $rpt_cleaners = 1; |
0a920b5b AW |
1766 | } |
1767 | ||
08e44365 AP |
1768 | # check for space before tabs. |
1769 | if ($rawline =~ /^\+/ && $rawline =~ / \t/) { | |
1770 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; | |
000d1cc1 JP |
1771 | WARN("SPACE_BEFORE_TAB", |
1772 | "please, no space before tabs\n" . $herevet); | |
08e44365 AP |
1773 | } |
1774 | ||
5f7ddae6 | 1775 | # check for spaces at the beginning of a line. |
6b4c5beb AW |
1776 | # Exceptions: |
1777 | # 1) within comments | |
1778 | # 2) indented preprocessor commands | |
1779 | # 3) hanging labels | |
1780 | if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) { | |
5f7ddae6 | 1781 | my $herevet = "$here\n" . cat_vet($rawline) . "\n"; |
000d1cc1 JP |
1782 | WARN("LEADING_SPACE", |
1783 | "please, no spaces at the start of a line\n" . $herevet); | |
5f7ddae6 RR |
1784 | } |
1785 | ||
b9ea10d6 AW |
1786 | # check we are in a valid C source file if not then ignore this hunk |
1787 | next if ($realfile !~ /\.(h|c)$/); | |
1788 | ||
c2fdda0d | 1789 | # check for RCS/CVS revision markers |
cf655043 | 1790 | if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { |
000d1cc1 JP |
1791 | WARN("CVS_KEYWORD", |
1792 | "CVS style keyword markers, these will _not_ be updated\n". $herecurr); | |
c2fdda0d | 1793 | } |
22f2a2ef | 1794 | |
42e41c54 MF |
1795 | # Blackfin: don't use __builtin_bfin_[cs]sync |
1796 | if ($line =~ /__builtin_bfin_csync/) { | |
1797 | my $herevet = "$here\n" . cat_vet($line) . "\n"; | |
000d1cc1 JP |
1798 | ERROR("CSYNC", |
1799 | "use the CSYNC() macro in asm/blackfin.h\n" . $herevet); | |
42e41c54 MF |
1800 | } |
1801 | if ($line =~ /__builtin_bfin_ssync/) { | |
1802 | my $herevet = "$here\n" . cat_vet($line) . "\n"; | |
000d1cc1 JP |
1803 | ERROR("SSYNC", |
1804 | "use the SSYNC() macro in asm/blackfin.h\n" . $herevet); | |
42e41c54 MF |
1805 | } |
1806 | ||
9c0ca6f9 | 1807 | # Check for potential 'bare' types |
2b474a1a AW |
1808 | my ($stat, $cond, $line_nr_next, $remain_next, $off_next, |
1809 | $realline_next); | |
9c9ba34e | 1810 | if ($realcnt && $line =~ /.\s*\S/) { |
170d3a22 | 1811 | ($stat, $cond, $line_nr_next, $remain_next, $off_next) = |
f5fe35dd | 1812 | ctx_statement_block($linenr, $realcnt, 0); |
171ae1a4 AW |
1813 | $stat =~ s/\n./\n /g; |
1814 | $cond =~ s/\n./\n /g; | |
1815 | ||
f74bd194 AW |
1816 | #print "stat<$stat>\n"; |
1817 | ||
2b474a1a AW |
1818 | # Find the real next line. |
1819 | $realline_next = $line_nr_next; | |
1820 | if (defined $realline_next && | |
1821 | (!defined $lines[$realline_next - 1] || | |
1822 | substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { | |
1823 | $realline_next++; | |
1824 | } | |
1825 | ||
171ae1a4 AW |
1826 | my $s = $stat; |
1827 | $s =~ s/{.*$//s; | |
cf655043 | 1828 | |
c2fdda0d | 1829 | # Ignore goto labels. |
171ae1a4 | 1830 | if ($s =~ /$Ident:\*$/s) { |
c2fdda0d AW |
1831 | |
1832 | # Ignore functions being called | |
171ae1a4 | 1833 | } elsif ($s =~ /^.\s*$Ident\s*\(/s) { |
c2fdda0d | 1834 | |
463f2864 AW |
1835 | } elsif ($s =~ /^.\s*else\b/s) { |
1836 | ||
c45dcabd | 1837 | # declarations always start with types |
d2506586 | 1838 | } 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 |
1839 | my $type = $1; |
1840 | $type =~ s/\s+/ /g; | |
1841 | possible($type, "A:" . $s); | |
1842 | ||
8905a67c | 1843 | # definitions in global scope can only start with types |
a6a84062 | 1844 | } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { |
c45dcabd | 1845 | possible($1, "B:" . $s); |
c2fdda0d | 1846 | } |
8905a67c AW |
1847 | |
1848 | # any (foo ... *) is a pointer cast, and foo is a type | |
65863862 | 1849 | while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { |
c45dcabd | 1850 | possible($1, "C:" . $s); |
8905a67c AW |
1851 | } |
1852 | ||
1853 | # Check for any sort of function declaration. | |
1854 | # int foo(something bar, other baz); | |
1855 | # void (*store_gdt)(x86_descr_ptr *); | |
171ae1a4 | 1856 | if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { |
8905a67c | 1857 | my ($name_len) = length($1); |
8905a67c | 1858 | |
cf655043 | 1859 | my $ctx = $s; |
773647a0 | 1860 | substr($ctx, 0, $name_len + 1, ''); |
8905a67c | 1861 | $ctx =~ s/\)[^\)]*$//; |
cf655043 | 1862 | |
8905a67c | 1863 | for my $arg (split(/\s*,\s*/, $ctx)) { |
c45dcabd | 1864 | if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { |
8905a67c | 1865 | |
c45dcabd | 1866 | possible($1, "D:" . $s); |
8905a67c AW |
1867 | } |
1868 | } | |
9c0ca6f9 | 1869 | } |
8905a67c | 1870 | |
9c0ca6f9 AW |
1871 | } |
1872 | ||
653d4876 AW |
1873 | # |
1874 | # Checks which may be anchored in the context. | |
1875 | # | |
00df344f | 1876 | |
653d4876 AW |
1877 | # Check for switch () and associated case and default |
1878 | # statements should be at the same indent. | |
00df344f AW |
1879 | if ($line=~/\bswitch\s*\(.*\)/) { |
1880 | my $err = ''; | |
1881 | my $sep = ''; | |
1882 | my @ctx = ctx_block_outer($linenr, $realcnt); | |
1883 | shift(@ctx); | |
1884 | for my $ctx (@ctx) { | |
1885 | my ($clen, $cindent) = line_stats($ctx); | |
1886 | if ($ctx =~ /^\+\s*(case\s+|default:)/ && | |
1887 | $indent != $cindent) { | |
1888 | $err .= "$sep$ctx\n"; | |
1889 | $sep = ''; | |
1890 | } else { | |
1891 | $sep = "[...]\n"; | |
1892 | } | |
1893 | } | |
1894 | if ($err ne '') { | |
000d1cc1 JP |
1895 | ERROR("SWITCH_CASE_INDENT_LEVEL", |
1896 | "switch and case should be at the same indent\n$hereline$err"); | |
de7d4f0e AW |
1897 | } |
1898 | } | |
1899 | ||
1900 | # if/while/etc brace do not go on next line, unless defining a do while loop, | |
1901 | # or if that brace on the next line is for something else | |
c45dcabd | 1902 | if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { |
773647a0 AW |
1903 | my $pre_ctx = "$1$2"; |
1904 | ||
9c0ca6f9 | 1905 | my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); |
de7d4f0e AW |
1906 | my $ctx_cnt = $realcnt - $#ctx - 1; |
1907 | my $ctx = join("\n", @ctx); | |
1908 | ||
548596d5 AW |
1909 | my $ctx_ln = $linenr; |
1910 | my $ctx_skip = $realcnt; | |
773647a0 | 1911 | |
548596d5 AW |
1912 | while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && |
1913 | defined $lines[$ctx_ln - 1] && | |
1914 | $lines[$ctx_ln - 1] =~ /^-/)) { | |
1915 | ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; | |
1916 | $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); | |
de7d4f0e | 1917 | $ctx_ln++; |
de7d4f0e | 1918 | } |
548596d5 | 1919 | |
53210168 AW |
1920 | #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; |
1921 | #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; | |
de7d4f0e | 1922 | |
773647a0 | 1923 | if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { |
000d1cc1 JP |
1924 | ERROR("OPEN_BRACE", |
1925 | "that open brace { should be on the previous line\n" . | |
01464f30 | 1926 | "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); |
00df344f | 1927 | } |
773647a0 AW |
1928 | if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && |
1929 | $ctx =~ /\)\s*\;\s*$/ && | |
1930 | defined $lines[$ctx_ln - 1]) | |
1931 | { | |
9c0ca6f9 AW |
1932 | my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); |
1933 | if ($nindent > $indent) { | |
000d1cc1 JP |
1934 | WARN("TRAILING_SEMICOLON", |
1935 | "trailing semicolon indicates no statements, indent implies otherwise\n" . | |
01464f30 | 1936 | "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); |
9c0ca6f9 AW |
1937 | } |
1938 | } | |
00df344f AW |
1939 | } |
1940 | ||
4d001e4d AW |
1941 | # Check relative indent for conditionals and blocks. |
1942 | if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { | |
1943 | my ($s, $c) = ($stat, $cond); | |
1944 | ||
1945 | substr($s, 0, length($c), ''); | |
1946 | ||
1947 | # Make sure we remove the line prefixes as we have | |
1948 | # none on the first line, and are going to readd them | |
1949 | # where necessary. | |
1950 | $s =~ s/\n./\n/gs; | |
1951 | ||
1952 | # Find out how long the conditional actually is. | |
6f779c18 AW |
1953 | my @newlines = ($c =~ /\n/gs); |
1954 | my $cond_lines = 1 + $#newlines; | |
4d001e4d AW |
1955 | |
1956 | # We want to check the first line inside the block | |
1957 | # starting at the end of the conditional, so remove: | |
1958 | # 1) any blank line termination | |
1959 | # 2) any opening brace { on end of the line | |
1960 | # 3) any do (...) { | |
1961 | my $continuation = 0; | |
1962 | my $check = 0; | |
1963 | $s =~ s/^.*\bdo\b//; | |
1964 | $s =~ s/^\s*{//; | |
1965 | if ($s =~ s/^\s*\\//) { | |
1966 | $continuation = 1; | |
1967 | } | |
9bd49efe | 1968 | if ($s =~ s/^\s*?\n//) { |
4d001e4d AW |
1969 | $check = 1; |
1970 | $cond_lines++; | |
1971 | } | |
1972 | ||
1973 | # Also ignore a loop construct at the end of a | |
1974 | # preprocessor statement. | |
1975 | if (($prevline =~ /^.\s*#\s*define\s/ || | |
1976 | $prevline =~ /\\\s*$/) && $continuation == 0) { | |
1977 | $check = 0; | |
1978 | } | |
1979 | ||
9bd49efe | 1980 | my $cond_ptr = -1; |
740504c6 | 1981 | $continuation = 0; |
9bd49efe AW |
1982 | while ($cond_ptr != $cond_lines) { |
1983 | $cond_ptr = $cond_lines; | |
1984 | ||
f16fa28f AW |
1985 | # If we see an #else/#elif then the code |
1986 | # is not linear. | |
1987 | if ($s =~ /^\s*\#\s*(?:else|elif)/) { | |
1988 | $check = 0; | |
1989 | } | |
1990 | ||
9bd49efe AW |
1991 | # Ignore: |
1992 | # 1) blank lines, they should be at 0, | |
1993 | # 2) preprocessor lines, and | |
1994 | # 3) labels. | |
740504c6 AW |
1995 | if ($continuation || |
1996 | $s =~ /^\s*?\n/ || | |
9bd49efe AW |
1997 | $s =~ /^\s*#\s*?/ || |
1998 | $s =~ /^\s*$Ident\s*:/) { | |
740504c6 | 1999 | $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; |
30dad6eb AW |
2000 | if ($s =~ s/^.*?\n//) { |
2001 | $cond_lines++; | |
2002 | } | |
9bd49efe | 2003 | } |
4d001e4d AW |
2004 | } |
2005 | ||
2006 | my (undef, $sindent) = line_stats("+" . $s); | |
2007 | my $stat_real = raw_line($linenr, $cond_lines); | |
2008 | ||
2009 | # Check if either of these lines are modified, else | |
2010 | # this is not this patch's fault. | |
2011 | if (!defined($stat_real) || | |
2012 | $stat !~ /^\+/ && $stat_real !~ /^\+/) { | |
2013 | $check = 0; | |
2014 | } | |
2015 | if (defined($stat_real) && $cond_lines > 1) { | |
2016 | $stat_real = "[...]\n$stat_real"; | |
2017 | } | |
2018 | ||
9bd49efe | 2019 | #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 |
2020 | |
2021 | if ($check && (($sindent % 8) != 0 || | |
2022 | ($sindent <= $indent && $s ne ''))) { | |
000d1cc1 JP |
2023 | WARN("SUSPECT_CODE_INDENT", |
2024 | "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); | |
4d001e4d AW |
2025 | } |
2026 | } | |
2027 | ||
6c72ffaa AW |
2028 | # Track the 'values' across context and added lines. |
2029 | my $opline = $line; $opline =~ s/^./ /; | |
1f65f947 AW |
2030 | my ($curr_values, $curr_vars) = |
2031 | annotate_values($opline . "\n", $prev_values); | |
6c72ffaa | 2032 | $curr_values = $prev_values . $curr_values; |
c2fdda0d AW |
2033 | if ($dbg_values) { |
2034 | my $outline = $opline; $outline =~ s/\t/ /g; | |
cf655043 AW |
2035 | print "$linenr > .$outline\n"; |
2036 | print "$linenr > $curr_values\n"; | |
1f65f947 | 2037 | print "$linenr > $curr_vars\n"; |
c2fdda0d | 2038 | } |
6c72ffaa AW |
2039 | $prev_values = substr($curr_values, -1); |
2040 | ||
00df344f AW |
2041 | #ignore lines not being added |
2042 | if ($line=~/^[^\+]/) {next;} | |
2043 | ||
653d4876 | 2044 | # TEST: allow direct testing of the type matcher. |
7429c690 AW |
2045 | if ($dbg_type) { |
2046 | if ($line =~ /^.\s*$Declare\s*$/) { | |
000d1cc1 JP |
2047 | ERROR("TEST_TYPE", |
2048 | "TEST: is type\n" . $herecurr); | |
7429c690 | 2049 | } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { |
000d1cc1 JP |
2050 | ERROR("TEST_NOT_TYPE", |
2051 | "TEST: is not type ($1 is)\n". $herecurr); | |
7429c690 | 2052 | } |
653d4876 AW |
2053 | next; |
2054 | } | |
a1ef277e AW |
2055 | # TEST: allow direct testing of the attribute matcher. |
2056 | if ($dbg_attr) { | |
9360b0e5 | 2057 | if ($line =~ /^.\s*$Modifier\s*$/) { |
000d1cc1 JP |
2058 | ERROR("TEST_ATTR", |
2059 | "TEST: is attr\n" . $herecurr); | |
9360b0e5 | 2060 | } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { |
000d1cc1 JP |
2061 | ERROR("TEST_NOT_ATTR", |
2062 | "TEST: is not attr ($1 is)\n". $herecurr); | |
a1ef277e AW |
2063 | } |
2064 | next; | |
2065 | } | |
653d4876 | 2066 | |
f0a594c1 | 2067 | # check for initialisation to aggregates open brace on the next line |
99423c20 AW |
2068 | if ($line =~ /^.\s*{/ && |
2069 | $prevline =~ /(?:^|[^=])=\s*$/) { | |
000d1cc1 JP |
2070 | ERROR("OPEN_BRACE", |
2071 | "that open brace { should be on the previous line\n" . $hereprev); | |
f0a594c1 AW |
2072 | } |
2073 | ||
653d4876 AW |
2074 | # |
2075 | # Checks which are anchored on the added line. | |
2076 | # | |
2077 | ||
2078 | # check for malformed paths in #include statements (uses RAW line) | |
c45dcabd | 2079 | if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { |
653d4876 AW |
2080 | my $path = $1; |
2081 | if ($path =~ m{//}) { | |
000d1cc1 JP |
2082 | ERROR("MALFORMED_INCLUDE", |
2083 | "malformed #include filename\n" . | |
de7d4f0e | 2084 | $herecurr); |
653d4876 | 2085 | } |
653d4876 | 2086 | } |
00df344f | 2087 | |
0a920b5b | 2088 | # no C99 // comments |
00df344f | 2089 | if ($line =~ m{//}) { |
000d1cc1 JP |
2090 | ERROR("C99_COMMENTS", |
2091 | "do not use C99 // comments\n" . $herecurr); | |
0a920b5b | 2092 | } |
00df344f | 2093 | # Remove C99 comments. |
0a920b5b | 2094 | $line =~ s@//.*@@; |
6c72ffaa | 2095 | $opline =~ s@//.*@@; |
0a920b5b | 2096 | |
2b474a1a AW |
2097 | # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider |
2098 | # the whole statement. | |
2099 | #print "APW <$lines[$realline_next - 1]>\n"; | |
2100 | if (defined $realline_next && | |
2101 | exists $lines[$realline_next - 1] && | |
2102 | !defined $suppress_export{$realline_next} && | |
2103 | ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ || | |
2104 | $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { | |
3cbf62df AW |
2105 | # Handle definitions which produce identifiers with |
2106 | # a prefix: | |
2107 | # XXX(foo); | |
2108 | # EXPORT_SYMBOL(something_foo); | |
653d4876 | 2109 | my $name = $1; |
3cbf62df AW |
2110 | if ($stat =~ /^.([A-Z_]+)\s*\(\s*($Ident)/ && |
2111 | $name =~ /^${Ident}_$2/) { | |
2112 | #print "FOO C name<$name>\n"; | |
2113 | $suppress_export{$realline_next} = 1; | |
2114 | ||
2115 | } elsif ($stat !~ /(?: | |
2b474a1a | 2116 | \n.}\s*$| |
48012058 AW |
2117 | ^.DEFINE_$Ident\(\Q$name\E\)| |
2118 | ^.DECLARE_$Ident\(\Q$name\E\)| | |
2119 | ^.LIST_HEAD\(\Q$name\E\)| | |
2b474a1a AW |
2120 | ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| |
2121 | \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() | |
48012058 | 2122 | )/x) { |
2b474a1a AW |
2123 | #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; |
2124 | $suppress_export{$realline_next} = 2; | |
2125 | } else { | |
2126 | $suppress_export{$realline_next} = 1; | |
0a920b5b AW |
2127 | } |
2128 | } | |
2b474a1a AW |
2129 | if (!defined $suppress_export{$linenr} && |
2130 | $prevline =~ /^.\s*$/ && | |
2131 | ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ || | |
2132 | $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) { | |
2133 | #print "FOO B <$lines[$linenr - 1]>\n"; | |
2134 | $suppress_export{$linenr} = 2; | |
2135 | } | |
2136 | if (defined $suppress_export{$linenr} && | |
2137 | $suppress_export{$linenr} == 2) { | |
000d1cc1 JP |
2138 | WARN("EXPORT_SYMBOL", |
2139 | "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); | |
2b474a1a | 2140 | } |
0a920b5b | 2141 | |
5150bda4 | 2142 | # check for global initialisers. |
c45dcabd | 2143 | if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { |
000d1cc1 JP |
2144 | ERROR("GLOBAL_INITIALISERS", |
2145 | "do not initialise globals to 0 or NULL\n" . | |
f0a594c1 AW |
2146 | $herecurr); |
2147 | } | |
653d4876 | 2148 | # check for static initialisers. |
2d1bafd7 | 2149 | if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { |
000d1cc1 JP |
2150 | ERROR("INITIALISED_STATIC", |
2151 | "do not initialise statics to 0 or NULL\n" . | |
de7d4f0e | 2152 | $herecurr); |
0a920b5b AW |
2153 | } |
2154 | ||
cb710eca JP |
2155 | # check for static const char * arrays. |
2156 | if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { | |
000d1cc1 JP |
2157 | WARN("STATIC_CONST_CHAR_ARRAY", |
2158 | "static const char * array should probably be static const char * const\n" . | |
cb710eca JP |
2159 | $herecurr); |
2160 | } | |
2161 | ||
2162 | # check for static char foo[] = "bar" declarations. | |
2163 | if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { | |
000d1cc1 JP |
2164 | WARN("STATIC_CONST_CHAR_ARRAY", |
2165 | "static char array declaration should probably be static const char\n" . | |
cb710eca JP |
2166 | $herecurr); |
2167 | } | |
2168 | ||
93ed0e2d JP |
2169 | # check for declarations of struct pci_device_id |
2170 | if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) { | |
000d1cc1 JP |
2171 | WARN("DEFINE_PCI_DEVICE_TABLE", |
2172 | "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr); | |
93ed0e2d JP |
2173 | } |
2174 | ||
653d4876 AW |
2175 | # check for new typedefs, only function parameters and sparse annotations |
2176 | # make sense. | |
2177 | if ($line =~ /\btypedef\s/ && | |
8054576d | 2178 | $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && |
c45dcabd | 2179 | $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && |
8ed22cad | 2180 | $line !~ /\b$typeTypedefs\b/ && |
653d4876 | 2181 | $line !~ /\b__bitwise(?:__|)\b/) { |
000d1cc1 JP |
2182 | WARN("NEW_TYPEDEFS", |
2183 | "do not add new typedefs\n" . $herecurr); | |
0a920b5b AW |
2184 | } |
2185 | ||
2186 | # * goes on variable not on type | |
65863862 | 2187 | # (char*[ const]) |
00ef4ece | 2188 | if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) { |
65863862 AW |
2189 | my ($from, $to) = ($1, $1); |
2190 | ||
2191 | # Should start with a space. | |
2192 | $to =~ s/^(\S)/ $1/; | |
2193 | # Should not end with a space. | |
2194 | $to =~ s/\s+$//; | |
2195 | # '*'s should not have spaces between. | |
f9a0b3d1 | 2196 | while ($to =~ s/\*\s+\*/\*\*/) { |
65863862 | 2197 | } |
d8aaf121 | 2198 | |
65863862 AW |
2199 | #print "from<$from> to<$to>\n"; |
2200 | if ($from ne $to) { | |
000d1cc1 JP |
2201 | ERROR("POINTER_LOCATION", |
2202 | "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); | |
65863862 | 2203 | } |
00ef4ece | 2204 | } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) { |
65863862 AW |
2205 | my ($from, $to, $ident) = ($1, $1, $2); |
2206 | ||
2207 | # Should start with a space. | |
2208 | $to =~ s/^(\S)/ $1/; | |
2209 | # Should not end with a space. | |
2210 | $to =~ s/\s+$//; | |
2211 | # '*'s should not have spaces between. | |
f9a0b3d1 | 2212 | while ($to =~ s/\*\s+\*/\*\*/) { |
65863862 AW |
2213 | } |
2214 | # Modifiers should have spaces. | |
2215 | $to =~ s/(\b$Modifier$)/$1 /; | |
d8aaf121 | 2216 | |
667026e7 AW |
2217 | #print "from<$from> to<$to> ident<$ident>\n"; |
2218 | if ($from ne $to && $ident !~ /^$Modifier$/) { | |
000d1cc1 JP |
2219 | ERROR("POINTER_LOCATION", |
2220 | "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); | |
65863862 | 2221 | } |
0a920b5b AW |
2222 | } |
2223 | ||
2224 | # # no BUG() or BUG_ON() | |
2225 | # if ($line =~ /\b(BUG|BUG_ON)\b/) { | |
2226 | # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n"; | |
2227 | # print "$herecurr"; | |
2228 | # $clean = 0; | |
2229 | # } | |
2230 | ||
8905a67c | 2231 | if ($line =~ /\bLINUX_VERSION_CODE\b/) { |
000d1cc1 JP |
2232 | WARN("LINUX_VERSION_CODE", |
2233 | "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); | |
8905a67c AW |
2234 | } |
2235 | ||
17441227 JP |
2236 | # check for uses of printk_ratelimit |
2237 | if ($line =~ /\bprintk_ratelimit\s*\(/) { | |
000d1cc1 JP |
2238 | WARN("PRINTK_RATELIMITED", |
2239 | "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); | |
17441227 JP |
2240 | } |
2241 | ||
00df344f AW |
2242 | # printk should use KERN_* levels. Note that follow on printk's on the |
2243 | # same line do not need a level, so we use the current block context | |
2244 | # to try and find and validate the current printk. In summary the current | |
25985edc | 2245 | # printk includes all preceding printk's which have no newline on the end. |
00df344f | 2246 | # we assume the first bad printk is the one to report. |
f0a594c1 | 2247 | if ($line =~ /\bprintk\((?!KERN_)\s*"/) { |
00df344f AW |
2248 | my $ok = 0; |
2249 | for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) { | |
2250 | #print "CHECK<$lines[$ln - 1]\n"; | |
25985edc | 2251 | # we have a preceding printk if it ends |
00df344f AW |
2252 | # with "\n" ignore it, else it is to blame |
2253 | if ($lines[$ln - 1] =~ m{\bprintk\(}) { | |
2254 | if ($rawlines[$ln - 1] !~ m{\\n"}) { | |
2255 | $ok = 1; | |
2256 | } | |
2257 | last; | |
2258 | } | |
2259 | } | |
2260 | if ($ok == 0) { | |
000d1cc1 JP |
2261 | WARN("PRINTK_WITHOUT_KERN_LEVEL", |
2262 | "printk() should include KERN_ facility level\n" . $herecurr); | |
00df344f | 2263 | } |
0a920b5b AW |
2264 | } |
2265 | ||
653d4876 AW |
2266 | # function brace can't be on same line, except for #defines of do while, |
2267 | # or if closed on same line | |
c45dcabd AW |
2268 | if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and |
2269 | !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) { | |
000d1cc1 JP |
2270 | ERROR("OPEN_BRACE", |
2271 | "open brace '{' following function declarations go on the next line\n" . $herecurr); | |
0a920b5b | 2272 | } |
653d4876 | 2273 | |
8905a67c AW |
2274 | # open braces for enum, union and struct go on the same line. |
2275 | if ($line =~ /^.\s*{/ && | |
2276 | $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { | |
000d1cc1 JP |
2277 | ERROR("OPEN_BRACE", |
2278 | "open brace '{' following $1 go on the same line\n" . $hereprev); | |
8905a67c AW |
2279 | } |
2280 | ||
0c73b4eb AW |
2281 | # missing space after union, struct or enum definition |
2282 | if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { | |
000d1cc1 JP |
2283 | WARN("SPACING", |
2284 | "missing space after $1 definition\n" . $herecurr); | |
0c73b4eb AW |
2285 | } |
2286 | ||
8d31cfce AW |
2287 | # check for spacing round square brackets; allowed: |
2288 | # 1. with a type on the left -- int [] a; | |
fe2a7dbc AW |
2289 | # 2. at the beginning of a line for slice initialisers -- [0...10] = 5, |
2290 | # 3. inside a curly brace -- = { [0...10] = 5 } | |
8d31cfce AW |
2291 | while ($line =~ /(.*?\s)\[/g) { |
2292 | my ($where, $prefix) = ($-[1], $1); | |
2293 | if ($prefix !~ /$Type\s+$/ && | |
fe2a7dbc AW |
2294 | ($where != 0 || $prefix !~ /^.\s+$/) && |
2295 | $prefix !~ /{\s+$/) { | |
000d1cc1 JP |
2296 | ERROR("BRACKET_SPACE", |
2297 | "space prohibited before open square bracket '['\n" . $herecurr); | |
8d31cfce AW |
2298 | } |
2299 | } | |
2300 | ||
f0a594c1 | 2301 | # check for spaces between functions and their parentheses. |
6c72ffaa | 2302 | while ($line =~ /($Ident)\s+\(/g) { |
c2fdda0d | 2303 | my $name = $1; |
773647a0 AW |
2304 | my $ctx_before = substr($line, 0, $-[1]); |
2305 | my $ctx = "$ctx_before$name"; | |
c2fdda0d AW |
2306 | |
2307 | # Ignore those directives where spaces _are_ permitted. | |
773647a0 AW |
2308 | if ($name =~ /^(?: |
2309 | if|for|while|switch|return|case| | |
2310 | volatile|__volatile__| | |
2311 | __attribute__|format|__extension__| | |
2312 | asm|__asm__)$/x) | |
2313 | { | |
c2fdda0d AW |
2314 | |
2315 | # cpp #define statements have non-optional spaces, ie | |
2316 | # if there is a space between the name and the open | |
2317 | # parenthesis it is simply not a parameter group. | |
c45dcabd | 2318 | } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { |
773647a0 AW |
2319 | |
2320 | # cpp #elif statement condition may start with a ( | |
c45dcabd | 2321 | } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { |
c2fdda0d AW |
2322 | |
2323 | # If this whole things ends with a type its most | |
2324 | # likely a typedef for a function. | |
773647a0 | 2325 | } elsif ($ctx =~ /$Type$/) { |
c2fdda0d AW |
2326 | |
2327 | } else { | |
000d1cc1 JP |
2328 | WARN("SPACING", |
2329 | "space prohibited between function name and open parenthesis '('\n" . $herecurr); | |
6c72ffaa | 2330 | } |
f0a594c1 | 2331 | } |
653d4876 | 2332 | # Check operator spacing. |
0a920b5b | 2333 | if (!($line=~/\#\s*include/)) { |
9c0ca6f9 AW |
2334 | my $ops = qr{ |
2335 | <<=|>>=|<=|>=|==|!=| | |
2336 | \+=|-=|\*=|\/=|%=|\^=|\|=|&=| | |
2337 | =>|->|<<|>>|<|>|=|!|~| | |
1f65f947 AW |
2338 | &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| |
2339 | \?|: | |
9c0ca6f9 | 2340 | }x; |
cf655043 | 2341 | my @elements = split(/($ops|;)/, $opline); |
00df344f | 2342 | my $off = 0; |
6c72ffaa AW |
2343 | |
2344 | my $blank = copy_spacing($opline); | |
2345 | ||
0a920b5b | 2346 | for (my $n = 0; $n < $#elements; $n += 2) { |
4a0df2ef AW |
2347 | $off += length($elements[$n]); |
2348 | ||
25985edc | 2349 | # Pick up the preceding and succeeding characters. |
773647a0 AW |
2350 | my $ca = substr($opline, 0, $off); |
2351 | my $cc = ''; | |
2352 | if (length($opline) >= ($off + length($elements[$n + 1]))) { | |
2353 | $cc = substr($opline, $off + length($elements[$n + 1])); | |
2354 | } | |
2355 | my $cb = "$ca$;$cc"; | |
2356 | ||
4a0df2ef AW |
2357 | my $a = ''; |
2358 | $a = 'V' if ($elements[$n] ne ''); | |
2359 | $a = 'W' if ($elements[$n] =~ /\s$/); | |
cf655043 | 2360 | $a = 'C' if ($elements[$n] =~ /$;$/); |
4a0df2ef AW |
2361 | $a = 'B' if ($elements[$n] =~ /(\[|\()$/); |
2362 | $a = 'O' if ($elements[$n] eq ''); | |
773647a0 | 2363 | $a = 'E' if ($ca =~ /^\s*$/); |
4a0df2ef | 2364 | |
0a920b5b | 2365 | my $op = $elements[$n + 1]; |
4a0df2ef AW |
2366 | |
2367 | my $c = ''; | |
0a920b5b | 2368 | if (defined $elements[$n + 2]) { |
4a0df2ef AW |
2369 | $c = 'V' if ($elements[$n + 2] ne ''); |
2370 | $c = 'W' if ($elements[$n + 2] =~ /^\s/); | |
cf655043 | 2371 | $c = 'C' if ($elements[$n + 2] =~ /^$;/); |
4a0df2ef AW |
2372 | $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); |
2373 | $c = 'O' if ($elements[$n + 2] eq ''); | |
8b1b3378 | 2374 | $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); |
4a0df2ef AW |
2375 | } else { |
2376 | $c = 'E'; | |
0a920b5b AW |
2377 | } |
2378 | ||
4a0df2ef AW |
2379 | my $ctx = "${a}x${c}"; |
2380 | ||
2381 | my $at = "(ctx:$ctx)"; | |
2382 | ||
6c72ffaa | 2383 | my $ptr = substr($blank, 0, $off) . "^"; |
de7d4f0e | 2384 | my $hereptr = "$hereline$ptr\n"; |
0a920b5b | 2385 | |
74048ed8 | 2386 | # Pull out the value of this operator. |
6c72ffaa | 2387 | my $op_type = substr($curr_values, $off + 1, 1); |
0a920b5b | 2388 | |
1f65f947 AW |
2389 | # Get the full operator variant. |
2390 | my $opv = $op . substr($curr_vars, $off, 1); | |
2391 | ||
13214adf AW |
2392 | # Ignore operators passed as parameters. |
2393 | if ($op_type ne 'V' && | |
2394 | $ca =~ /\s$/ && $cc =~ /^\s*,/) { | |
2395 | ||
cf655043 AW |
2396 | # # Ignore comments |
2397 | # } elsif ($op =~ /^$;+$/) { | |
13214adf | 2398 | |
d8aaf121 | 2399 | # ; should have either the end of line or a space or \ after it |
13214adf | 2400 | } elsif ($op eq ';') { |
cf655043 AW |
2401 | if ($ctx !~ /.x[WEBC]/ && |
2402 | $cc !~ /^\\/ && $cc !~ /^;/) { | |
000d1cc1 JP |
2403 | ERROR("SPACING", |
2404 | "space required after that '$op' $at\n" . $hereptr); | |
d8aaf121 AW |
2405 | } |
2406 | ||
2407 | # // is a comment | |
2408 | } elsif ($op eq '//') { | |
0a920b5b | 2409 | |
1f65f947 AW |
2410 | # No spaces for: |
2411 | # -> | |
2412 | # : when part of a bitfield | |
2413 | } elsif ($op eq '->' || $opv eq ':B') { | |
4a0df2ef | 2414 | if ($ctx =~ /Wx.|.xW/) { |
000d1cc1 JP |
2415 | ERROR("SPACING", |
2416 | "spaces prohibited around that '$op' $at\n" . $hereptr); | |
0a920b5b AW |
2417 | } |
2418 | ||
2419 | # , must have a space on the right. | |
2420 | } elsif ($op eq ',') { | |
cf655043 | 2421 | if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { |
000d1cc1 JP |
2422 | ERROR("SPACING", |
2423 | "space required after that '$op' $at\n" . $hereptr); | |
0a920b5b AW |
2424 | } |
2425 | ||
9c0ca6f9 | 2426 | # '*' as part of a type definition -- reported already. |
74048ed8 | 2427 | } elsif ($opv eq '*_') { |
9c0ca6f9 AW |
2428 | #warn "'*' is part of type\n"; |
2429 | ||
2430 | # unary operators should have a space before and | |
2431 | # none after. May be left adjacent to another | |
2432 | # unary operator, or a cast | |
2433 | } elsif ($op eq '!' || $op eq '~' || | |
74048ed8 | 2434 | $opv eq '*U' || $opv eq '-U' || |
0d413866 | 2435 | $opv eq '&U' || $opv eq '&&U') { |
cf655043 | 2436 | if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { |
000d1cc1 JP |
2437 | ERROR("SPACING", |
2438 | "space required before that '$op' $at\n" . $hereptr); | |
0a920b5b | 2439 | } |
a3340b35 | 2440 | if ($op eq '*' && $cc =~/\s*$Modifier\b/) { |
171ae1a4 AW |
2441 | # A unary '*' may be const |
2442 | ||
2443 | } elsif ($ctx =~ /.xW/) { | |
000d1cc1 JP |
2444 | ERROR("SPACING", |
2445 | "space prohibited after that '$op' $at\n" . $hereptr); | |
0a920b5b AW |
2446 | } |
2447 | ||
2448 | # unary ++ and unary -- are allowed no space on one side. | |
2449 | } elsif ($op eq '++' or $op eq '--') { | |
773647a0 | 2450 | if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { |
000d1cc1 JP |
2451 | ERROR("SPACING", |
2452 | "space required one side of that '$op' $at\n" . $hereptr); | |
773647a0 AW |
2453 | } |
2454 | if ($ctx =~ /Wx[BE]/ || | |
2455 | ($ctx =~ /Wx./ && $cc =~ /^;/)) { | |
000d1cc1 JP |
2456 | ERROR("SPACING", |
2457 | "space prohibited before that '$op' $at\n" . $hereptr); | |
0a920b5b | 2458 | } |
773647a0 | 2459 | if ($ctx =~ /ExW/) { |
000d1cc1 JP |
2460 | ERROR("SPACING", |
2461 | "space prohibited after that '$op' $at\n" . $hereptr); | |
653d4876 | 2462 | } |
0a920b5b | 2463 | |
773647a0 | 2464 | |
0a920b5b | 2465 | # << and >> may either have or not have spaces both sides |
9c0ca6f9 AW |
2466 | } elsif ($op eq '<<' or $op eq '>>' or |
2467 | $op eq '&' or $op eq '^' or $op eq '|' or | |
2468 | $op eq '+' or $op eq '-' or | |
c2fdda0d AW |
2469 | $op eq '*' or $op eq '/' or |
2470 | $op eq '%') | |
0a920b5b | 2471 | { |
773647a0 | 2472 | if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { |
000d1cc1 JP |
2473 | ERROR("SPACING", |
2474 | "need consistent spacing around '$op' $at\n" . | |
de7d4f0e | 2475 | $hereptr); |
0a920b5b AW |
2476 | } |
2477 | ||
1f65f947 AW |
2478 | # A colon needs no spaces before when it is |
2479 | # terminating a case value or a label. | |
2480 | } elsif ($opv eq ':C' || $opv eq ':L') { | |
2481 | if ($ctx =~ /Wx./) { | |
000d1cc1 JP |
2482 | ERROR("SPACING", |
2483 | "space prohibited before that '$op' $at\n" . $hereptr); | |
1f65f947 AW |
2484 | } |
2485 | ||
0a920b5b | 2486 | # All the others need spaces both sides. |
cf655043 | 2487 | } elsif ($ctx !~ /[EWC]x[CWE]/) { |
1f65f947 AW |
2488 | my $ok = 0; |
2489 | ||
22f2a2ef | 2490 | # Ignore email addresses <foo@bar> |
1f65f947 AW |
2491 | if (($op eq '<' && |
2492 | $cc =~ /^\S+\@\S+>/) || | |
2493 | ($op eq '>' && | |
2494 | $ca =~ /<\S+\@\S+$/)) | |
2495 | { | |
2496 | $ok = 1; | |
2497 | } | |
2498 | ||
2499 | # Ignore ?: | |
2500 | if (($opv eq ':O' && $ca =~ /\?$/) || | |
2501 | ($op eq '?' && $cc =~ /^:/)) { | |
2502 | $ok = 1; | |
2503 | } | |
2504 | ||
2505 | if ($ok == 0) { | |
000d1cc1 JP |
2506 | ERROR("SPACING", |
2507 | "spaces required around that '$op' $at\n" . $hereptr); | |
22f2a2ef | 2508 | } |
0a920b5b | 2509 | } |
4a0df2ef | 2510 | $off += length($elements[$n + 1]); |
0a920b5b AW |
2511 | } |
2512 | } | |
2513 | ||
f0a594c1 AW |
2514 | # check for multiple assignments |
2515 | if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { | |
000d1cc1 JP |
2516 | CHK("MULTIPLE_ASSIGNMENTS", |
2517 | "multiple assignments should be avoided\n" . $herecurr); | |
f0a594c1 AW |
2518 | } |
2519 | ||
22f2a2ef AW |
2520 | ## # check for multiple declarations, allowing for a function declaration |
2521 | ## # continuation. | |
2522 | ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && | |
2523 | ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { | |
2524 | ## | |
2525 | ## # Remove any bracketed sections to ensure we do not | |
2526 | ## # falsly report the parameters of functions. | |
2527 | ## my $ln = $line; | |
2528 | ## while ($ln =~ s/\([^\(\)]*\)//g) { | |
2529 | ## } | |
2530 | ## if ($ln =~ /,/) { | |
000d1cc1 JP |
2531 | ## WARN("MULTIPLE_DECLARATION", |
2532 | ## "declaring multiple variables together should be avoided\n" . $herecurr); | |
22f2a2ef AW |
2533 | ## } |
2534 | ## } | |
f0a594c1 | 2535 | |
0a920b5b | 2536 | #need space before brace following if, while, etc |
22f2a2ef AW |
2537 | if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) || |
2538 | $line =~ /do{/) { | |
000d1cc1 JP |
2539 | ERROR("SPACING", |
2540 | "space required before the open brace '{'\n" . $herecurr); | |
de7d4f0e AW |
2541 | } |
2542 | ||
2543 | # closing brace should have a space following it when it has anything | |
2544 | # on the line | |
2545 | if ($line =~ /}(?!(?:,|;|\)))\S/) { | |
000d1cc1 JP |
2546 | ERROR("SPACING", |
2547 | "space required after that close brace '}'\n" . $herecurr); | |
0a920b5b AW |
2548 | } |
2549 | ||
22f2a2ef AW |
2550 | # check spacing on square brackets |
2551 | if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { | |
000d1cc1 JP |
2552 | ERROR("SPACING", |
2553 | "space prohibited after that open square bracket '['\n" . $herecurr); | |
22f2a2ef AW |
2554 | } |
2555 | if ($line =~ /\s\]/) { | |
000d1cc1 JP |
2556 | ERROR("SPACING", |
2557 | "space prohibited before that close square bracket ']'\n" . $herecurr); | |
22f2a2ef AW |
2558 | } |
2559 | ||
c45dcabd | 2560 | # check spacing on parentheses |
9c0ca6f9 AW |
2561 | if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && |
2562 | $line !~ /for\s*\(\s+;/) { | |
000d1cc1 JP |
2563 | ERROR("SPACING", |
2564 | "space prohibited after that open parenthesis '('\n" . $herecurr); | |
22f2a2ef | 2565 | } |
13214adf | 2566 | if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && |
c45dcabd AW |
2567 | $line !~ /for\s*\(.*;\s+\)/ && |
2568 | $line !~ /:\s+\)/) { | |
000d1cc1 JP |
2569 | ERROR("SPACING", |
2570 | "space prohibited before that close parenthesis ')'\n" . $herecurr); | |
22f2a2ef AW |
2571 | } |
2572 | ||
0a920b5b | 2573 | #goto labels aren't indented, allow a single space however |
4a0df2ef | 2574 | if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and |
0a920b5b | 2575 | !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { |
000d1cc1 JP |
2576 | WARN("INDENTED_LABEL", |
2577 | "labels should not be indented\n" . $herecurr); | |
0a920b5b AW |
2578 | } |
2579 | ||
c45dcabd AW |
2580 | # Return is not a function. |
2581 | if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { | |
2582 | my $spacing = $1; | |
2583 | my $value = $2; | |
2584 | ||
86f9d059 | 2585 | # Flatten any parentheses |
fb2d2c1b AW |
2586 | $value =~ s/\(/ \(/g; |
2587 | $value =~ s/\)/\) /g; | |
63f17f89 AW |
2588 | while ($value =~ s/\[[^\{\}]*\]/1/ || |
2589 | $value !~ /(?:$Ident|-?$Constant)\s* | |
2590 | $Compare\s* | |
2591 | (?:$Ident|-?$Constant)/x && | |
2592 | $value =~ s/\([^\(\)]*\)/1/) { | |
c45dcabd | 2593 | } |
fb2d2c1b AW |
2594 | #print "value<$value>\n"; |
2595 | if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) { | |
000d1cc1 JP |
2596 | ERROR("RETURN_PARENTHESES", |
2597 | "return is not a function, parentheses are not required\n" . $herecurr); | |
c45dcabd AW |
2598 | |
2599 | } elsif ($spacing !~ /\s+/) { | |
000d1cc1 JP |
2600 | ERROR("SPACING", |
2601 | "space required before the open parenthesis '('\n" . $herecurr); | |
c45dcabd AW |
2602 | } |
2603 | } | |
53a3c448 AW |
2604 | # Return of what appears to be an errno should normally be -'ve |
2605 | if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { | |
2606 | my $name = $1; | |
2607 | if ($name ne 'EOF' && $name ne 'ERROR') { | |
000d1cc1 JP |
2608 | WARN("USE_NEGATIVE_ERRNO", |
2609 | "return of an errno should typically be -ve (return -$1)\n" . $herecurr); | |
53a3c448 AW |
2610 | } |
2611 | } | |
c45dcabd | 2612 | |
0a920b5b | 2613 | # Need a space before open parenthesis after if, while etc |
4a0df2ef | 2614 | if ($line=~/\b(if|while|for|switch)\(/) { |
000d1cc1 | 2615 | ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr); |
0a920b5b AW |
2616 | } |
2617 | ||
f5fe35dd AW |
2618 | # Check for illegal assignment in if conditional -- and check for trailing |
2619 | # statements after the conditional. | |
170d3a22 AW |
2620 | if ($line =~ /do\s*(?!{)/) { |
2621 | my ($stat_next) = ctx_statement_block($line_nr_next, | |
2622 | $remain_next, $off_next); | |
2623 | $stat_next =~ s/\n./\n /g; | |
2624 | ##print "stat<$stat> stat_next<$stat_next>\n"; | |
2625 | ||
2626 | if ($stat_next =~ /^\s*while\b/) { | |
2627 | # If the statement carries leading newlines, | |
2628 | # then count those as offsets. | |
2629 | my ($whitespace) = | |
2630 | ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); | |
2631 | my $offset = | |
2632 | statement_rawlines($whitespace) - 1; | |
2633 | ||
2634 | $suppress_whiletrailers{$line_nr_next + | |
2635 | $offset} = 1; | |
2636 | } | |
2637 | } | |
2638 | if (!defined $suppress_whiletrailers{$linenr} && | |
2639 | $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { | |
171ae1a4 | 2640 | my ($s, $c) = ($stat, $cond); |
8905a67c | 2641 | |
b53c8e10 | 2642 | if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { |
000d1cc1 JP |
2643 | ERROR("ASSIGN_IN_IF", |
2644 | "do not use assignment in if condition\n" . $herecurr); | |
8905a67c AW |
2645 | } |
2646 | ||
2647 | # Find out what is on the end of the line after the | |
2648 | # conditional. | |
773647a0 | 2649 | substr($s, 0, length($c), ''); |
8905a67c | 2650 | $s =~ s/\n.*//g; |
13214adf | 2651 | $s =~ s/$;//g; # Remove any comments |
53210168 AW |
2652 | if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && |
2653 | $c !~ /}\s*while\s*/) | |
773647a0 | 2654 | { |
bb44ad39 AW |
2655 | # Find out how long the conditional actually is. |
2656 | my @newlines = ($c =~ /\n/gs); | |
2657 | my $cond_lines = 1 + $#newlines; | |
42bdf74c | 2658 | my $stat_real = ''; |
bb44ad39 | 2659 | |
42bdf74c HS |
2660 | $stat_real = raw_line($linenr, $cond_lines) |
2661 | . "\n" if ($cond_lines); | |
bb44ad39 AW |
2662 | if (defined($stat_real) && $cond_lines > 1) { |
2663 | $stat_real = "[...]\n$stat_real"; | |
2664 | } | |
2665 | ||
000d1cc1 JP |
2666 | ERROR("TRAILING_STATEMENTS", |
2667 | "trailing statements should be on next line\n" . $herecurr . $stat_real); | |
8905a67c AW |
2668 | } |
2669 | } | |
2670 | ||
13214adf AW |
2671 | # Check for bitwise tests written as boolean |
2672 | if ($line =~ / | |
2673 | (?: | |
2674 | (?:\[|\(|\&\&|\|\|) | |
2675 | \s*0[xX][0-9]+\s* | |
2676 | (?:\&\&|\|\|) | |
2677 | | | |
2678 | (?:\&\&|\|\|) | |
2679 | \s*0[xX][0-9]+\s* | |
2680 | (?:\&\&|\|\||\)|\]) | |
2681 | )/x) | |
2682 | { | |
000d1cc1 JP |
2683 | WARN("HEXADECIMAL_BOOLEAN_TEST", |
2684 | "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); | |
13214adf AW |
2685 | } |
2686 | ||
8905a67c | 2687 | # if and else should not have general statements after it |
13214adf AW |
2688 | if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { |
2689 | my $s = $1; | |
2690 | $s =~ s/$;//g; # Remove any comments | |
2691 | if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { | |
000d1cc1 JP |
2692 | ERROR("TRAILING_STATEMENTS", |
2693 | "trailing statements should be on next line\n" . $herecurr); | |
13214adf | 2694 | } |
0a920b5b | 2695 | } |
39667782 AW |
2696 | # if should not continue a brace |
2697 | if ($line =~ /}\s*if\b/) { | |
000d1cc1 JP |
2698 | ERROR("TRAILING_STATEMENTS", |
2699 | "trailing statements should be on next line\n" . | |
39667782 AW |
2700 | $herecurr); |
2701 | } | |
a1080bf8 AW |
2702 | # case and default should not have general statements after them |
2703 | if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && | |
2704 | $line !~ /\G(?: | |
3fef12d6 | 2705 | (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| |
a1080bf8 AW |
2706 | \s*return\s+ |
2707 | )/xg) | |
2708 | { | |
000d1cc1 JP |
2709 | ERROR("TRAILING_STATEMENTS", |
2710 | "trailing statements should be on next line\n" . $herecurr); | |
a1080bf8 | 2711 | } |
0a920b5b AW |
2712 | |
2713 | # Check for }<nl>else {, these must be at the same | |
2714 | # indent level to be relevant to each other. | |
2715 | if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and | |
2716 | $previndent == $indent) { | |
000d1cc1 JP |
2717 | ERROR("ELSE_AFTER_BRACE", |
2718 | "else should follow close brace '}'\n" . $hereprev); | |
0a920b5b AW |
2719 | } |
2720 | ||
c2fdda0d AW |
2721 | if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and |
2722 | $previndent == $indent) { | |
2723 | my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); | |
2724 | ||
2725 | # Find out what is on the end of the line after the | |
2726 | # conditional. | |
773647a0 | 2727 | substr($s, 0, length($c), ''); |
c2fdda0d AW |
2728 | $s =~ s/\n.*//g; |
2729 | ||
2730 | if ($s =~ /^\s*;/) { | |
000d1cc1 JP |
2731 | ERROR("WHILE_AFTER_BRACE", |
2732 | "while should follow close brace '}'\n" . $hereprev); | |
c2fdda0d AW |
2733 | } |
2734 | } | |
2735 | ||
0a920b5b AW |
2736 | #studly caps, commented out until figure out how to distinguish between use of existing and adding new |
2737 | # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { | |
2738 | # print "No studly caps, use _\n"; | |
2739 | # print "$herecurr"; | |
2740 | # $clean = 0; | |
2741 | # } | |
2742 | ||
2743 | #no spaces allowed after \ in define | |
c45dcabd | 2744 | if ($line=~/\#\s*define.*\\\s$/) { |
000d1cc1 JP |
2745 | WARN("WHITESPACE_AFTER_LINE_CONTINUATION", |
2746 | "Whitepspace after \\ makes next lines useless\n" . $herecurr); | |
0a920b5b AW |
2747 | } |
2748 | ||
653d4876 | 2749 | #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line) |
c45dcabd | 2750 | if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { |
e09dec48 AW |
2751 | my $file = "$1.h"; |
2752 | my $checkfile = "include/linux/$file"; | |
2753 | if (-f "$root/$checkfile" && | |
2754 | $realfile ne $checkfile && | |
7840a94c | 2755 | $1 !~ /$allowed_asm_includes/) |
c45dcabd | 2756 | { |
e09dec48 | 2757 | if ($realfile =~ m{^arch/}) { |
000d1cc1 JP |
2758 | CHK("ARCH_INCLUDE_LINUX", |
2759 | "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); | |
e09dec48 | 2760 | } else { |
000d1cc1 JP |
2761 | WARN("INCLUDE_LINUX", |
2762 | "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); | |
e09dec48 | 2763 | } |
0a920b5b AW |
2764 | } |
2765 | } | |
2766 | ||
653d4876 AW |
2767 | # multi-statement macros should be enclosed in a do while loop, grab the |
2768 | # first statement and ensure its the whole macro if its not enclosed | |
cf655043 | 2769 | # in a known good container |
b8f96a31 AW |
2770 | if ($realfile !~ m@/vmlinux.lds.h$@ && |
2771 | $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { | |
d8aaf121 AW |
2772 | my $ln = $linenr; |
2773 | my $cnt = $realcnt; | |
c45dcabd AW |
2774 | my ($off, $dstat, $dcond, $rest); |
2775 | my $ctx = ''; | |
c45dcabd | 2776 | ($dstat, $dcond, $ln, $cnt, $off) = |
f74bd194 AW |
2777 | ctx_statement_block($linenr, $realcnt, 0); |
2778 | $ctx = $dstat; | |
c45dcabd | 2779 | #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; |
a3bb97a7 | 2780 | #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; |
c45dcabd | 2781 | |
f74bd194 | 2782 | $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//; |
292f1a9b | 2783 | $dstat =~ s/$;//g; |
c45dcabd AW |
2784 | $dstat =~ s/\\\n.//g; |
2785 | $dstat =~ s/^\s*//s; | |
2786 | $dstat =~ s/\s*$//s; | |
de7d4f0e | 2787 | |
c45dcabd | 2788 | # Flatten any parentheses and braces |
bf30d6ed AW |
2789 | while ($dstat =~ s/\([^\(\)]*\)/1/ || |
2790 | $dstat =~ s/\{[^\{\}]*\}/1/ || | |
2791 | $dstat =~ s/\[[^\{\}]*\]/1/) | |
2792 | { | |
de7d4f0e | 2793 | } |
d8aaf121 | 2794 | |
c45dcabd AW |
2795 | my $exceptions = qr{ |
2796 | $Declare| | |
2797 | module_param_named| | |
2798 | MODULE_PARAM_DESC| | |
2799 | DECLARE_PER_CPU| | |
2800 | DEFINE_PER_CPU| | |
383099fd | 2801 | __typeof__\(| |
22fd2d3e SS |
2802 | union| |
2803 | struct| | |
ea71a0a0 AW |
2804 | \.$Ident\s*=\s*| |
2805 | ^\"|\"$ | |
c45dcabd | 2806 | }x; |
5eaa20b9 | 2807 | #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; |
f74bd194 AW |
2808 | if ($dstat ne '' && |
2809 | $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), | |
2810 | $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); | |
2811 | $dstat !~ /^(?:$Ident|-?$Constant)$/ && # 10 // foo() | |
2812 | $dstat !~ /$exceptions/ && | |
2813 | $dstat !~ /^\.$Ident\s*=/ && # .foo = | |
2814 | $dstat !~ /^do\s*$Constant\s*while\s*$Constant;$/ && # do {...} while (...); | |
2815 | $dstat !~ /^for\s*$Constant$/ && # for (...) | |
2816 | $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() | |
2817 | $dstat !~ /^do\s*{/ && # do {... | |
2818 | $dstat !~ /^\({/) # ({... | |
2819 | { | |
2820 | $ctx =~ s/\n*$//; | |
2821 | my $herectx = $here . "\n"; | |
2822 | my $cnt = statement_rawlines($ctx); | |
2823 | ||
2824 | for (my $n = 0; $n < $cnt; $n++) { | |
2825 | $herectx .= raw_line($linenr, $n) . "\n"; | |
c45dcabd AW |
2826 | } |
2827 | ||
f74bd194 AW |
2828 | if ($dstat =~ /;/) { |
2829 | ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", | |
2830 | "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); | |
2831 | } else { | |
000d1cc1 | 2832 | ERROR("COMPLEX_MACRO", |
f74bd194 | 2833 | "Macros with complex values should be enclosed in parenthesis\n" . "$herectx"); |
d8aaf121 | 2834 | } |
653d4876 | 2835 | } |
0a920b5b AW |
2836 | } |
2837 | ||
080ba929 MF |
2838 | # make sure symbols are always wrapped with VMLINUX_SYMBOL() ... |
2839 | # all assignments may have only one of the following with an assignment: | |
2840 | # . | |
2841 | # ALIGN(...) | |
2842 | # VMLINUX_SYMBOL(...) | |
2843 | if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) { | |
000d1cc1 JP |
2844 | WARN("MISSING_VMLINUX_SYMBOL", |
2845 | "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr); | |
080ba929 MF |
2846 | } |
2847 | ||
f0a594c1 | 2848 | # check for redundant bracing round if etc |
13214adf AW |
2849 | if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { |
2850 | my ($level, $endln, @chunks) = | |
cf655043 | 2851 | ctx_statement_full($linenr, $realcnt, 1); |
13214adf | 2852 | #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; |
cf655043 AW |
2853 | #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; |
2854 | if ($#chunks > 0 && $level == 0) { | |
13214adf AW |
2855 | my $allowed = 0; |
2856 | my $seen = 0; | |
773647a0 | 2857 | my $herectx = $here . "\n"; |
cf655043 | 2858 | my $ln = $linenr - 1; |
13214adf AW |
2859 | for my $chunk (@chunks) { |
2860 | my ($cond, $block) = @{$chunk}; | |
2861 | ||
773647a0 AW |
2862 | # If the condition carries leading newlines, then count those as offsets. |
2863 | my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); | |
2864 | my $offset = statement_rawlines($whitespace) - 1; | |
2865 | ||
2866 | #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; | |
2867 | ||
2868 | # We have looked at and allowed this specific line. | |
2869 | $suppress_ifbraces{$ln + $offset} = 1; | |
2870 | ||
2871 | $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; | |
cf655043 AW |
2872 | $ln += statement_rawlines($block) - 1; |
2873 | ||
773647a0 | 2874 | substr($block, 0, length($cond), ''); |
13214adf AW |
2875 | |
2876 | $seen++ if ($block =~ /^\s*{/); | |
2877 | ||
cf655043 AW |
2878 | #print "cond<$cond> block<$block> allowed<$allowed>\n"; |
2879 | if (statement_lines($cond) > 1) { | |
2880 | #print "APW: ALLOWED: cond<$cond>\n"; | |
13214adf AW |
2881 | $allowed = 1; |
2882 | } | |
2883 | if ($block =~/\b(?:if|for|while)\b/) { | |
cf655043 | 2884 | #print "APW: ALLOWED: block<$block>\n"; |
13214adf AW |
2885 | $allowed = 1; |
2886 | } | |
cf655043 AW |
2887 | if (statement_block_size($block) > 1) { |
2888 | #print "APW: ALLOWED: lines block<$block>\n"; | |
13214adf AW |
2889 | $allowed = 1; |
2890 | } | |
2891 | } | |
2892 | if ($seen && !$allowed) { | |
000d1cc1 JP |
2893 | WARN("BRACES", |
2894 | "braces {} are not necessary for any arm of this statement\n" . $herectx); | |
13214adf AW |
2895 | } |
2896 | } | |
2897 | } | |
773647a0 | 2898 | if (!defined $suppress_ifbraces{$linenr - 1} && |
13214adf | 2899 | $line =~ /\b(if|while|for|else)\b/) { |
cf655043 AW |
2900 | my $allowed = 0; |
2901 | ||
2902 | # Check the pre-context. | |
2903 | if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { | |
2904 | #print "APW: ALLOWED: pre<$1>\n"; | |
2905 | $allowed = 1; | |
2906 | } | |
773647a0 AW |
2907 | |
2908 | my ($level, $endln, @chunks) = | |
2909 | ctx_statement_full($linenr, $realcnt, $-[0]); | |
2910 | ||
cf655043 AW |
2911 | # Check the condition. |
2912 | my ($cond, $block) = @{$chunks[0]}; | |
773647a0 | 2913 | #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; |
cf655043 | 2914 | if (defined $cond) { |
773647a0 | 2915 | substr($block, 0, length($cond), ''); |
cf655043 AW |
2916 | } |
2917 | if (statement_lines($cond) > 1) { | |
2918 | #print "APW: ALLOWED: cond<$cond>\n"; | |
2919 | $allowed = 1; | |
2920 | } | |
2921 | if ($block =~/\b(?:if|for|while)\b/) { | |
2922 | #print "APW: ALLOWED: block<$block>\n"; | |
2923 | $allowed = 1; | |
2924 | } | |
2925 | if (statement_block_size($block) > 1) { | |
2926 | #print "APW: ALLOWED: lines block<$block>\n"; | |
2927 | $allowed = 1; | |
2928 | } | |
2929 | # Check the post-context. | |
2930 | if (defined $chunks[1]) { | |
2931 | my ($cond, $block) = @{$chunks[1]}; | |
2932 | if (defined $cond) { | |
773647a0 | 2933 | substr($block, 0, length($cond), ''); |
cf655043 AW |
2934 | } |
2935 | if ($block =~ /^\s*\{/) { | |
2936 | #print "APW: ALLOWED: chunk-1 block<$block>\n"; | |
2937 | $allowed = 1; | |
2938 | } | |
2939 | } | |
2940 | if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { | |
69932487 | 2941 | my $herectx = $here . "\n"; |
f055663c | 2942 | my $cnt = statement_rawlines($block); |
cf655043 | 2943 | |
f055663c | 2944 | for (my $n = 0; $n < $cnt; $n++) { |
69932487 | 2945 | $herectx .= raw_line($linenr, $n) . "\n"; |
f0a594c1 | 2946 | } |
cf655043 | 2947 | |
000d1cc1 JP |
2948 | WARN("BRACES", |
2949 | "braces {} are not necessary for single statement blocks\n" . $herectx); | |
f0a594c1 AW |
2950 | } |
2951 | } | |
2952 | ||
653d4876 | 2953 | # don't include deprecated include files (uses RAW line) |
4a0df2ef | 2954 | for my $inc (@dep_includes) { |
c45dcabd | 2955 | if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) { |
000d1cc1 JP |
2956 | ERROR("DEPRECATED_INCLUDE", |
2957 | "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr); | |
0a920b5b AW |
2958 | } |
2959 | } | |
2960 | ||
4a0df2ef AW |
2961 | # don't use deprecated functions |
2962 | for my $func (@dep_functions) { | |
00df344f | 2963 | if ($line =~ /\b$func\b/) { |
000d1cc1 JP |
2964 | ERROR("DEPRECATED_FUNCTION", |
2965 | "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr); | |
4a0df2ef AW |
2966 | } |
2967 | } | |
2968 | ||
2969 | # no volatiles please | |
6c72ffaa AW |
2970 | my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; |
2971 | if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { | |
000d1cc1 JP |
2972 | WARN("VOLATILE", |
2973 | "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr); | |
4a0df2ef AW |
2974 | } |
2975 | ||
00df344f | 2976 | # warn about #if 0 |
c45dcabd | 2977 | if ($line =~ /^.\s*\#\s*if\s+0\b/) { |
000d1cc1 JP |
2978 | CHK("REDUNDANT_CODE", |
2979 | "if this code is redundant consider removing it\n" . | |
de7d4f0e | 2980 | $herecurr); |
4a0df2ef AW |
2981 | } |
2982 | ||
f0a594c1 AW |
2983 | # check for needless kfree() checks |
2984 | if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { | |
2985 | my $expr = $1; | |
2986 | if ($line =~ /\bkfree\(\Q$expr\E\);/) { | |
000d1cc1 JP |
2987 | WARN("NEEDLESS_KFREE", |
2988 | "kfree(NULL) is safe this check is probably not required\n" . $hereprev); | |
f0a594c1 AW |
2989 | } |
2990 | } | |
4c432a8f GKH |
2991 | # check for needless usb_free_urb() checks |
2992 | if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { | |
2993 | my $expr = $1; | |
2994 | if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) { | |
000d1cc1 JP |
2995 | WARN("NEEDLESS_USB_FREE_URB", |
2996 | "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev); | |
4c432a8f GKH |
2997 | } |
2998 | } | |
f0a594c1 | 2999 | |
1a15a250 PP |
3000 | # prefer usleep_range over udelay |
3001 | if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) { | |
3002 | # ignore udelay's < 10, however | |
3003 | if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) { | |
000d1cc1 JP |
3004 | CHK("USLEEP_RANGE", |
3005 | "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line); | |
1a15a250 PP |
3006 | } |
3007 | } | |
3008 | ||
09ef8725 PP |
3009 | # warn about unexpectedly long msleep's |
3010 | if ($line =~ /\bmsleep\s*\((\d+)\);/) { | |
3011 | if ($1 < 20) { | |
000d1cc1 JP |
3012 | WARN("MSLEEP", |
3013 | "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line); | |
09ef8725 PP |
3014 | } |
3015 | } | |
3016 | ||
00df344f | 3017 | # warn about #ifdefs in C files |
c45dcabd | 3018 | # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { |
00df344f AW |
3019 | # print "#ifdef in C files should be avoided\n"; |
3020 | # print "$herecurr"; | |
3021 | # $clean = 0; | |
3022 | # } | |
3023 | ||
22f2a2ef | 3024 | # warn about spacing in #ifdefs |
c45dcabd | 3025 | if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { |
000d1cc1 JP |
3026 | ERROR("SPACING", |
3027 | "exactly one space required after that #$1\n" . $herecurr); | |
22f2a2ef AW |
3028 | } |
3029 | ||
4a0df2ef | 3030 | # check for spinlock_t definitions without a comment. |
171ae1a4 AW |
3031 | if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || |
3032 | $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { | |
4a0df2ef AW |
3033 | my $which = $1; |
3034 | if (!ctx_has_comment($first_line, $linenr)) { | |
000d1cc1 JP |
3035 | CHK("UNCOMMENTED_DEFINITION", |
3036 | "$1 definition without comment\n" . $herecurr); | |
4a0df2ef AW |
3037 | } |
3038 | } | |
3039 | # check for memory barriers without a comment. | |
3040 | if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { | |
3041 | if (!ctx_has_comment($first_line, $linenr)) { | |
000d1cc1 JP |
3042 | CHK("MEMORY_BARRIER", |
3043 | "memory barrier without comment\n" . $herecurr); | |
4a0df2ef AW |
3044 | } |
3045 | } | |
3046 | # check of hardware specific defines | |
c45dcabd | 3047 | if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { |
000d1cc1 JP |
3048 | CHK("ARCH_DEFINES", |
3049 | "architecture specific defines should be avoided\n" . $herecurr); | |
0a920b5b | 3050 | } |
653d4876 | 3051 | |
d4977c78 TK |
3052 | # Check that the storage class is at the beginning of a declaration |
3053 | if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { | |
000d1cc1 JP |
3054 | WARN("STORAGE_CLASS", |
3055 | "storage class should be at the beginning of the declaration\n" . $herecurr) | |
d4977c78 TK |
3056 | } |
3057 | ||
de7d4f0e AW |
3058 | # check the location of the inline attribute, that it is between |
3059 | # storage class and type. | |
9c0ca6f9 AW |
3060 | if ($line =~ /\b$Type\s+$Inline\b/ || |
3061 | $line =~ /\b$Inline\s+$Storage\b/) { | |
000d1cc1 JP |
3062 | ERROR("INLINE_LOCATION", |
3063 | "inline keyword should sit between storage class and type\n" . $herecurr); | |
de7d4f0e AW |
3064 | } |
3065 | ||
8905a67c AW |
3066 | # Check for __inline__ and __inline, prefer inline |
3067 | if ($line =~ /\b(__inline__|__inline)\b/) { | |
000d1cc1 JP |
3068 | WARN("INLINE", |
3069 | "plain inline is preferred over $1\n" . $herecurr); | |
8905a67c AW |
3070 | } |
3071 | ||
3d130fd0 JP |
3072 | # Check for __attribute__ packed, prefer __packed |
3073 | if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) { | |
000d1cc1 JP |
3074 | WARN("PREFER_PACKED", |
3075 | "__packed is preferred over __attribute__((packed))\n" . $herecurr); | |
3d130fd0 JP |
3076 | } |
3077 | ||
39b7e287 JP |
3078 | # Check for __attribute__ aligned, prefer __aligned |
3079 | if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) { | |
000d1cc1 JP |
3080 | WARN("PREFER_ALIGNED", |
3081 | "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr); | |
39b7e287 JP |
3082 | } |
3083 | ||
5f14d3bd JP |
3084 | # Check for __attribute__ format(printf, prefer __printf |
3085 | if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) { | |
3086 | WARN("PREFER_PRINTF", | |
3087 | "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr); | |
3088 | } | |
3089 | ||
8f53a9b8 JP |
3090 | # check for sizeof(&) |
3091 | if ($line =~ /\bsizeof\s*\(\s*\&/) { | |
000d1cc1 JP |
3092 | WARN("SIZEOF_ADDRESS", |
3093 | "sizeof(& should be avoided\n" . $herecurr); | |
8f53a9b8 JP |
3094 | } |
3095 | ||
428e2fdc JP |
3096 | # check for line continuations in quoted strings with odd counts of " |
3097 | if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) { | |
000d1cc1 JP |
3098 | WARN("LINE_CONTINUATIONS", |
3099 | "Avoid line continuations in quoted strings\n" . $herecurr); | |
428e2fdc JP |
3100 | } |
3101 | ||
554e165c | 3102 | # Check for misused memsets |
d7c76ba7 JP |
3103 | if (defined $stat && |
3104 | $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) { | |
3105 | ||
3106 | my $ms_addr = $2; | |
3107 | my $ms_val = $8; | |
3108 | my $ms_size = $14; | |
554e165c | 3109 | |
554e165c AW |
3110 | if ($ms_size =~ /^(0x|)0$/i) { |
3111 | ERROR("MEMSET", | |
d7c76ba7 | 3112 | "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); |
554e165c AW |
3113 | } elsif ($ms_size =~ /^(0x|)1$/i) { |
3114 | WARN("MEMSET", | |
d7c76ba7 JP |
3115 | "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); |
3116 | } | |
3117 | } | |
3118 | ||
3119 | # typecasts on min/max could be min_t/max_t | |
3120 | if (defined $stat && | |
3121 | $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { | |
3122 | if (defined $2 || defined $8) { | |
3123 | my $call = $1; | |
3124 | my $cast1 = deparenthesize($2); | |
3125 | my $arg1 = $3; | |
3126 | my $cast2 = deparenthesize($8); | |
3127 | my $arg2 = $9; | |
3128 | my $cast; | |
3129 | ||
3130 | if ($cast1 ne "" && $cast2 ne "") { | |
3131 | $cast = "$cast1 or $cast2"; | |
3132 | } elsif ($cast1 ne "") { | |
3133 | $cast = $cast1; | |
3134 | } else { | |
3135 | $cast = $cast2; | |
3136 | } | |
3137 | WARN("MINMAX", | |
3138 | "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); | |
554e165c AW |
3139 | } |
3140 | } | |
3141 | ||
de7d4f0e | 3142 | # check for new externs in .c files. |
171ae1a4 | 3143 | if ($realfile =~ /\.c$/ && defined $stat && |
c45dcabd | 3144 | $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) |
171ae1a4 | 3145 | { |
c45dcabd AW |
3146 | my $function_name = $1; |
3147 | my $paren_space = $2; | |
171ae1a4 AW |
3148 | |
3149 | my $s = $stat; | |
3150 | if (defined $cond) { | |
3151 | substr($s, 0, length($cond), ''); | |
3152 | } | |
c45dcabd AW |
3153 | if ($s =~ /^\s*;/ && |
3154 | $function_name ne 'uninitialized_var') | |
3155 | { | |
000d1cc1 JP |
3156 | WARN("AVOID_EXTERNS", |
3157 | "externs should be avoided in .c files\n" . $herecurr); | |
171ae1a4 AW |
3158 | } |
3159 | ||
3160 | if ($paren_space =~ /\n/) { | |
000d1cc1 JP |
3161 | WARN("FUNCTION_ARGUMENTS", |
3162 | "arguments for function declarations should follow identifier\n" . $herecurr); | |
171ae1a4 | 3163 | } |
9c9ba34e AW |
3164 | |
3165 | } elsif ($realfile =~ /\.c$/ && defined $stat && | |
3166 | $stat =~ /^.\s*extern\s+/) | |
3167 | { | |
000d1cc1 JP |
3168 | WARN("AVOID_EXTERNS", |
3169 | "externs should be avoided in .c files\n" . $herecurr); | |
de7d4f0e AW |
3170 | } |
3171 | ||
3172 | # checks for new __setup's | |
3173 | if ($rawline =~ /\b__setup\("([^"]*)"/) { | |
3174 | my $name = $1; | |
3175 | ||
3176 | if (!grep(/$name/, @setup_docs)) { | |
000d1cc1 JP |
3177 | CHK("UNDOCUMENTED_SETUP", |
3178 | "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr); | |
de7d4f0e | 3179 | } |
653d4876 | 3180 | } |
9c0ca6f9 AW |
3181 | |
3182 | # check for pointless casting of kmalloc return | |
caf2a54f | 3183 | if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) { |
000d1cc1 JP |
3184 | WARN("UNNECESSARY_CASTS", |
3185 | "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); | |
9c0ca6f9 | 3186 | } |
13214adf | 3187 | |
caf2a54f JP |
3188 | # check for multiple semicolons |
3189 | if ($line =~ /;\s*;\s*$/) { | |
000d1cc1 JP |
3190 | WARN("ONE_SEMICOLON", |
3191 | "Statements terminations use 1 semicolon\n" . $herecurr); | |
caf2a54f JP |
3192 | } |
3193 | ||
13214adf AW |
3194 | # check for gcc specific __FUNCTION__ |
3195 | if ($line =~ /__FUNCTION__/) { | |
000d1cc1 JP |
3196 | WARN("USE_FUNC", |
3197 | "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); | |
13214adf | 3198 | } |
773647a0 | 3199 | |
4882720b TG |
3200 | # check for semaphores initialized locked |
3201 | if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { | |
000d1cc1 JP |
3202 | WARN("CONSIDER_COMPLETION", |
3203 | "consider using a completion\n" . $herecurr); | |
1704f47b | 3204 | |
773647a0 | 3205 | } |
67d0a075 JP |
3206 | # recommend kstrto* over simple_strto* and strict_strto* |
3207 | if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { | |
000d1cc1 | 3208 | WARN("CONSIDER_KSTRTO", |
67d0a075 | 3209 | "$1 is obsolete, use k$3 instead\n" . $herecurr); |
773647a0 | 3210 | } |
f3db6639 ME |
3211 | # check for __initcall(), use device_initcall() explicitly please |
3212 | if ($line =~ /^.\s*__initcall\s*\(/) { | |
000d1cc1 JP |
3213 | WARN("USE_DEVICE_INITCALL", |
3214 | "please use device_initcall() instead of __initcall()\n" . $herecurr); | |
f3db6639 | 3215 | } |
79404849 ER |
3216 | # check for various ops structs, ensure they are const. |
3217 | my $struct_ops = qr{acpi_dock_ops| | |
3218 | address_space_operations| | |
3219 | backlight_ops| | |
3220 | block_device_operations| | |
3221 | dentry_operations| | |
3222 | dev_pm_ops| | |
3223 | dma_map_ops| | |
3224 | extent_io_ops| | |
3225 | file_lock_operations| | |
3226 | file_operations| | |
3227 | hv_ops| | |
3228 | ide_dma_ops| | |
3229 | intel_dvo_dev_ops| | |
3230 | item_operations| | |
3231 | iwl_ops| | |
3232 | kgdb_arch| | |
3233 | kgdb_io| | |
3234 | kset_uevent_ops| | |
3235 | lock_manager_operations| | |
3236 | microcode_ops| | |
3237 | mtrr_ops| | |
3238 | neigh_ops| | |
3239 | nlmsvc_binding| | |
3240 | pci_raw_ops| | |
3241 | pipe_buf_operations| | |
3242 | platform_hibernation_ops| | |
3243 | platform_suspend_ops| | |
3244 | proto_ops| | |
3245 | rpc_pipe_ops| | |
3246 | seq_operations| | |
3247 | snd_ac97_build_ops| | |
3248 | soc_pcmcia_socket_ops| | |
3249 | stacktrace_ops| | |
3250 | sysfs_ops| | |
3251 | tty_operations| | |
3252 | usb_mon_operations| | |
3253 | wd_ops}x; | |
6903ffb2 | 3254 | if ($line !~ /\bconst\b/ && |
79404849 | 3255 | $line =~ /\bstruct\s+($struct_ops)\b/) { |
000d1cc1 JP |
3256 | WARN("CONST_STRUCT", |
3257 | "struct $1 should normally be const\n" . | |
6903ffb2 | 3258 | $herecurr); |
2b6db5cb | 3259 | } |
773647a0 AW |
3260 | |
3261 | # use of NR_CPUS is usually wrong | |
3262 | # ignore definitions of NR_CPUS and usage to define arrays as likely right | |
3263 | if ($line =~ /\bNR_CPUS\b/ && | |
c45dcabd AW |
3264 | $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && |
3265 | $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && | |
171ae1a4 AW |
3266 | $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && |
3267 | $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && | |
3268 | $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/) | |
773647a0 | 3269 | { |
000d1cc1 JP |
3270 | WARN("NR_CPUS", |
3271 | "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); | |
773647a0 | 3272 | } |
9c9ba34e AW |
3273 | |
3274 | # check for %L{u,d,i} in strings | |
3275 | my $string; | |
3276 | while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { | |
3277 | $string = substr($rawline, $-[1], $+[1] - $-[1]); | |
2a1bc5d5 | 3278 | $string =~ s/%%/__/g; |
9c9ba34e | 3279 | if ($string =~ /(?<!%)%L[udi]/) { |
000d1cc1 JP |
3280 | WARN("PRINTF_L", |
3281 | "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); | |
9c9ba34e AW |
3282 | last; |
3283 | } | |
3284 | } | |
691d77b6 AW |
3285 | |
3286 | # whine mightly about in_atomic | |
3287 | if ($line =~ /\bin_atomic\s*\(/) { | |
3288 | if ($realfile =~ m@^drivers/@) { | |
000d1cc1 JP |
3289 | ERROR("IN_ATOMIC", |
3290 | "do not use in_atomic in drivers\n" . $herecurr); | |
f4a87736 | 3291 | } elsif ($realfile !~ m@^kernel/@) { |
000d1cc1 JP |
3292 | WARN("IN_ATOMIC", |
3293 | "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); | |
691d77b6 AW |
3294 | } |
3295 | } | |
1704f47b PZ |
3296 | |
3297 | # check for lockdep_set_novalidate_class | |
3298 | if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || | |
3299 | $line =~ /__lockdep_no_validate__\s*\)/ ) { | |
3300 | if ($realfile !~ m@^kernel/lockdep@ && | |
3301 | $realfile !~ m@^include/linux/lockdep@ && | |
3302 | $realfile !~ m@^drivers/base/core@) { | |
000d1cc1 JP |
3303 | ERROR("LOCKDEP", |
3304 | "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); | |
1704f47b PZ |
3305 | } |
3306 | } | |
88f8831c DJ |
3307 | |
3308 | if ($line =~ /debugfs_create_file.*S_IWUGO/ || | |
3309 | $line =~ /DEVICE_ATTR.*S_IWUGO/ ) { | |
000d1cc1 JP |
3310 | WARN("EXPORTED_WORLD_WRITABLE", |
3311 | "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); | |
88f8831c | 3312 | } |
13214adf AW |
3313 | } |
3314 | ||
3315 | # If we have no input at all, then there is nothing to report on | |
3316 | # so just keep quiet. | |
3317 | if ($#rawlines == -1) { | |
3318 | exit(0); | |
0a920b5b AW |
3319 | } |
3320 | ||
8905a67c AW |
3321 | # In mailback mode only produce a report in the negative, for |
3322 | # things that appear to be patches. | |
3323 | if ($mailback && ($clean == 1 || !$is_patch)) { | |
3324 | exit(0); | |
3325 | } | |
3326 | ||
3327 | # This is not a patch, and we are are in 'no-patch' mode so | |
3328 | # just keep quiet. | |
3329 | if (!$chk_patch && !$is_patch) { | |
3330 | exit(0); | |
3331 | } | |
3332 | ||
3333 | if (!$is_patch) { | |
000d1cc1 JP |
3334 | ERROR("NOT_UNIFIED_DIFF", |
3335 | "Does not appear to be a unified-diff format patch\n"); | |
0a920b5b AW |
3336 | } |
3337 | if ($is_patch && $chk_signoff && $signoff == 0) { | |
000d1cc1 JP |
3338 | ERROR("MISSING_SIGN_OFF", |
3339 | "Missing Signed-off-by: line(s)\n"); | |
0a920b5b AW |
3340 | } |
3341 | ||
8905a67c | 3342 | print report_dump(); |
13214adf AW |
3343 | if ($summary && !($clean == 1 && $quiet == 1)) { |
3344 | print "$filename " if ($summary_file); | |
8905a67c AW |
3345 | print "total: $cnt_error errors, $cnt_warn warnings, " . |
3346 | (($check)? "$cnt_chk checks, " : "") . | |
3347 | "$cnt_lines lines checked\n"; | |
3348 | print "\n" if ($quiet == 0); | |
f0a594c1 | 3349 | } |
8905a67c | 3350 | |
d2c0a235 AW |
3351 | if ($quiet == 0) { |
3352 | # If there were whitespace errors which cleanpatch can fix | |
3353 | # then suggest that. | |
3354 | if ($rpt_cleaners) { | |
3355 | print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; | |
3356 | print " scripts/cleanfile\n\n"; | |
b0781216 | 3357 | $rpt_cleaners = 0; |
d2c0a235 AW |
3358 | } |
3359 | } | |
3360 | ||
000d1cc1 JP |
3361 | if (keys %ignore_type) { |
3362 | print "NOTE: Ignored message types:"; | |
3363 | foreach my $ignore (sort keys %ignore_type) { | |
3364 | print " $ignore"; | |
3365 | } | |
3366 | print "\n"; | |
3367 | print "\n" if ($quiet == 0); | |
3368 | } | |
3369 | ||
0a920b5b | 3370 | if ($clean == 1 && $quiet == 0) { |
c2fdda0d | 3371 | print "$vname has no obvious style problems and is ready for submission.\n" |
0a920b5b AW |
3372 | } |
3373 | if ($clean == 0 && $quiet == 0) { | |
000d1cc1 JP |
3374 | print << "EOM"; |
3375 | $vname has style problems, please review. | |
3376 | ||
3377 | If any of these errors are false positives, please report | |
3378 | them to the maintainer, see CHECKPATCH in MAINTAINERS. | |
3379 | EOM | |
0a920b5b | 3380 | } |
13214adf | 3381 | |
0a920b5b AW |
3382 | return $clean; |
3383 | } |