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