]> git.proxmox.com Git - mirror_qemu.git/blob - scripts/checkpatch.pl
projects / mirror_qemu.git / blob
? search:
summary | shortlog | log | commit | commitdiff | tree
blame | history | raw | HEAD
Merge remote-tracking branch 'remotes/bonzini/tags/for-upstream' into staging
[mirror_qemu.git] / scripts / checkpatch.pl
1 #!/usr/bin/env perl
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 use warnings;
10
11 my $P = $0;
12 $P =~ s@.*/@@g;
13
14 our $SrcFile = qr{\.(?:h|c|cpp|s|S|pl|py|sh)$};
15
16 my $V = '0.31';
17
18 use Getopt::Long qw(:config no_auto_abbrev);
19
20 my $quiet = 0;
21 my $tree = 1;
22 my $chk_signoff = 1;
23 my $chk_patch = undef;
24 my $chk_branch = undef;
25 my $tst_only;
26 my $emacs = 0;
27 my $terse = 0;
28 my $file = undef;
29 my $no_warnings = 0;
30 my $summary = 1;
31 my $mailback = 0;
32 my $summary_file = 0;
33 my $root;
34 my %debug;
35 my $help = 0;
36
37 sub help {
38 my ($exitcode) = @_;
39
40 print << "EOM";
41 Usage:
42
43 $P [OPTION]... [FILE]...
44 $P [OPTION]... [GIT-REV-LIST]
45
46 Version: $V
47
48 Options:
49 -q, --quiet quiet
50 --no-tree run without a kernel tree
51 --no-signoff do not check for 'Signed-off-by' line
52 --patch treat FILE as patchfile
53 --branch treat args as GIT revision list
54 --emacs emacs compile window format
55 --terse one line per report
56 -f, --file treat FILE as regular source file
57 --strict fail if only warnings are found
58 --root=PATH PATH to the kernel tree root
59 --no-summary suppress the per-file summary
60 --mailback only produce a report in case of warnings/errors
61 --summary-file include the filename in summary
62 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
63 'values', 'possible', 'type', and 'attr' (default
64 is all off)
65 --test-only=WORD report only warnings/errors containing WORD
66 literally
67 -h, --help, --version display this help and exit
68
69 When FILE is - read standard input.
70 EOM
71
72 exit($exitcode);
73 }
74
75 GetOptions(
76 'q|quiet+' => \$quiet,
77 'tree!' => \$tree,
78 'signoff!' => \$chk_signoff,
79 'patch!' => \$chk_patch,
80 'branch!' => \$chk_branch,
81 'emacs!' => \$emacs,
82 'terse!' => \$terse,
83 'f|file!' => \$file,
84 'strict!' => \$no_warnings,
85 'root=s' => \$root,
86 'summary!' => \$summary,
87 'mailback!' => \$mailback,
88 'summary-file!' => \$summary_file,
89
90 'debug=s' => \%debug,
91 'test-only=s' => \$tst_only,
92 'h|help' => \$help,
93 'version' => \$help
94 ) or help(1);
95
96 help(0) if ($help);
97
98 my $exit = 0;
99
100 if ($#ARGV < 0) {
101 print "$P: no input files\n";
102 exit(1);
103 }
104
105 if (!defined $chk_branch && !defined $chk_patch && !defined $file) {
106 $chk_branch = $ARGV[0] =~ /.\.\./ ? 1 : 0;
107 $file = $ARGV[0] =~ /$SrcFile/ ? 1 : 0;
108 $chk_patch = $chk_branch || $file ? 0 : 1;
109 } elsif (!defined $chk_branch && !defined $chk_patch) {
110 if ($file) {
111 $chk_branch = $chk_patch = 0;
112 } else {
113 $chk_branch = $ARGV[0] =~ /.\.\./ ? 1 : 0;
114 $chk_patch = $chk_branch ? 0 : 1;
115 }
116 } elsif (!defined $chk_branch && !defined $file) {
117 if ($chk_patch) {
118 $chk_branch = $file = 0;
119 } else {
120 $chk_branch = $ARGV[0] =~ /.\.\./ ? 1 : 0;
121 $file = $chk_branch ? 0 : 1;
122 }
123 } elsif (!defined $chk_patch && !defined $file) {
124 if ($chk_branch) {
125 $chk_patch = $file = 0;
126 } else {
127 $file = $ARGV[0] =~ /$SrcFile/ ? 1 : 0;
128 $chk_patch = $file ? 0 : 1;
129 }
130 } elsif (!defined $chk_branch) {
131 $chk_branch = $chk_patch || $file ? 0 : 1;
132 } elsif (!defined $chk_patch) {
133 $chk_patch = $chk_branch || $file ? 0 : 1;
134 } elsif (!defined $file) {
135 $file = $chk_patch || $chk_branch ? 0 : 1;
136 }
137
138 if (($chk_patch && $chk_branch) ||
139 ($chk_patch && $file) ||
140 ($chk_branch && $file)) {
141 die "Only one of --file, --branch, --patch is permitted\n";
142 }
143 if (!$chk_patch && !$chk_branch && !$file) {
144 die "One of --file, --branch, --patch is required\n";
145 }
146
147 my $dbg_values = 0;
148 my $dbg_possible = 0;
149 my $dbg_type = 0;
150 my $dbg_attr = 0;
151 my $dbg_adv_dcs = 0;
152 my $dbg_adv_checking = 0;
153 my $dbg_adv_apw = 0;
154 for my $key (keys %debug) {
155 ## no critic
156 eval "\${dbg_$key} = '$debug{$key}';";
157 die "$@" if ($@);
158 }
159
160 my $rpt_cleaners = 0;
161
162 if ($terse) {
163 $emacs = 1;
164 $quiet++;
165 }
166
167 if ($tree) {
168 if (defined $root) {
169 if (!top_of_kernel_tree($root)) {
170 die "$P: $root: --root does not point at a valid tree\n";
171 }
172 } else {
173 if (top_of_kernel_tree('.')) {
174 $root = '.';
175 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
176 top_of_kernel_tree($1)) {
177 $root = $1;
178 }
179 }
180
181 if (!defined $root) {
182 print "Must be run from the top-level dir. of a kernel tree\n";
183 exit(2);
184 }
185 }
186
187 my $emitted_corrupt = 0;
188
189 our $Ident = qr{
190 [A-Za-z_][A-Za-z\d_]*
191 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
192 }x;
193 our $Storage = qr{extern|static|asmlinkage};
194 our $Sparse = qr{
195 __force
196 }x;
197
198 # Notes to $Attribute:
199 our $Attribute = qr{
200 const|
201 volatile|
202 QEMU_NORETURN|
203 QEMU_WARN_UNUSED_RESULT|
204 QEMU_SENTINEL|
205 QEMU_ARTIFICIAL|
206 QEMU_PACKED|
207 GCC_FMT_ATTR
208 }x;
209 our $Modifier;
210 our $Inline = qr{inline};
211 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
212 our $Lval = qr{$Ident(?:$Member)*};
213
214 our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*};
215 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
216 our $Compare = qr{<=|>=|==|!=|<|>};
217 our $Operators = qr{
218 <=|>=|==|!=|
219 =>|->|<<|>>|<|>|!|~|
220 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
221 }x;
222
223 our $NonptrType;
224 our $Type;
225 our $Declare;
226
227 our $UTF8 = qr {
228 [\x09\x0A\x0D\x20-\x7E] # ASCII
229 | [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
230 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
231 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
232 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
233 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
234 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
235 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
236 }x;
237
238 # There are still some false positives, but this catches most
239 # common cases.
240 our $typeTypedefs = qr{(?x:
241 [A-Z][A-Z\d_]*[a-z][A-Za-z\d_]* # camelcase
242 | [A-Z][A-Z\d_]*AIOCB # all uppercase
243 | [A-Z][A-Z\d_]*CPU # all uppercase
244 | QEMUBH # all uppercase
245 )};
246
247 our @typeList = (
248 qr{void},
249 qr{(?:unsigned\s+)?char},
250 qr{(?:unsigned\s+)?short},
251 qr{(?:unsigned\s+)?int},
252 qr{(?:unsigned\s+)?long},
253 qr{(?:unsigned\s+)?long\s+int},
254 qr{(?:unsigned\s+)?long\s+long},
255 qr{(?:unsigned\s+)?long\s+long\s+int},
256 qr{unsigned},
257 qr{float},
258 qr{double},
259 qr{bool},
260 qr{struct\s+$Ident},
261 qr{union\s+$Ident},
262 qr{enum\s+$Ident},
263 qr{${Ident}_t},
264 qr{${Ident}_handler},
265 qr{${Ident}_handler_fn},
266 qr{target_(?:u)?long},
267 qr{hwaddr},
268 qr{xml${Ident}},
269 );
270
271 # This can be modified by sub possible. Since it can be empty, be careful
272 # about regexes that always match, because they can cause infinite loops.
273 our @modifierList = (
274 );
275
276 sub build_types {
277 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
278 if (@modifierList > 0) {
279 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
280 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
281 } else {
282 $Modifier = qr{(?:$Attribute|$Sparse)};
283 }
284 $NonptrType = qr{
285 (?:$Modifier\s+|const\s+)*
286 (?:
287 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)|
288 (?:$typeTypedefs\b)|
289 (?:${all}\b)
290 )
291 (?:\s+$Modifier|\s+const)*
292 }x;
293 $Type = qr{
294 $NonptrType
295 (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
296 (?:\s+$Inline|\s+$Modifier)*
297 }x;
298 $Declare = qr{(?:$Storage\s+)?$Type};
299 }
300 build_types();
301
302 $chk_signoff = 0 if ($file);
303
304 my @rawlines = ();
305 my @lines = ();
306 my $vname;
307 if ($chk_branch) {
308 my @patches;
309 my $HASH;
310 open($HASH, "-|", "git", "log", "--format=%H", $ARGV[0]) ||
311 die "$P: git log --format=%H $ARGV[0] failed - $!\n";
312
313 while (<$HASH>) {
314 chomp;
315 push @patches, $_;
316 }
317
318 close $HASH;
319
320 die "$P: no revisions returned for revlist '$chk_branch'\n"
321 unless @patches;
322
323 for my $hash (@patches) {
324 my $FILE;
325 open($FILE, '-|', "git", "show", $hash) ||
326 die "$P: git show $hash - $!\n";
327 $vname = $hash;
328 while (<$FILE>) {
329 chomp;
330 push(@rawlines, $_);
331 }
332 close($FILE);
333 if (!process($hash)) {
334 $exit = 1;
335 }
336 @rawlines = ();
337 @lines = ();
338 }
339 } else {
340 for my $filename (@ARGV) {
341 my $FILE;
342 if ($file) {
343 open($FILE, '-|', "diff -u /dev/null $filename") ||
344 die "$P: $filename: diff failed - $!\n";
345 } elsif ($filename eq '-') {
346 open($FILE, '<&STDIN');
347 } else {
348 open($FILE, '<', "$filename") ||
349 die "$P: $filename: open failed - $!\n";
350 }
351 if ($filename eq '-') {
352 $vname = 'Your patch';
353 } else {
354 $vname = $filename;
355 }
356 while (<$FILE>) {
357 chomp;
358 push(@rawlines, $_);
359 }
360 close($FILE);
361 if (!process($filename)) {
362 $exit = 1;
363 }
364 @rawlines = ();
365 @lines = ();
366 }
367 }
368
369 exit($exit);
370
371 sub top_of_kernel_tree {
372 my ($root) = @_;
373
374 my @tree_check = (
375 "COPYING", "MAINTAINERS", "Makefile",
376 "README", "docs", "VERSION",
377 "vl.c"
378 );
379
380 foreach my $check (@tree_check) {
381 if (! -e $root . '/' . $check) {
382 return 0;
383 }
384 }
385 return 1;
386 }
387
388 sub expand_tabs {
389 my ($str) = @_;
390
391 my $res = '';
392 my $n = 0;
393 for my $c (split(//, $str)) {
394 if ($c eq "\t") {
395 $res .= ' ';
396 $n++;
397 for (; ($n % 8) != 0; $n++) {
398 $res .= ' ';
399 }
400 next;
401 }
402 $res .= $c;
403 $n++;
404 }
405
406 return $res;
407 }
408 sub copy_spacing {
409 (my $res = shift) =~ tr/\t/ /c;
410 return $res;
411 }
412
413 sub line_stats {
414 my ($line) = @_;
415
416 # Drop the diff line leader and expand tabs
417 $line =~ s/^.//;
418 $line = expand_tabs($line);
419
420 # Pick the indent from the front of the line.
421 my ($white) = ($line =~ /^(\s*)/);
422
423 return (length($line), length($white));
424 }
425
426 my $sanitise_quote = '';
427
428 sub sanitise_line_reset {
429 my ($in_comment) = @_;
430
431 if ($in_comment) {
432 $sanitise_quote = '*/';
433 } else {
434 $sanitise_quote = '';
435 }
436 }
437 sub sanitise_line {
438 my ($line) = @_;
439
440 my $res = '';
441 my $l = '';
442
443 my $qlen = 0;
444 my $off = 0;
445 my $c;
446
447 # Always copy over the diff marker.
448 $res = substr($line, 0, 1);
449
450 for ($off = 1; $off < length($line); $off++) {
451 $c = substr($line, $off, 1);
452
453 # Comments we are wacking completely including the begin
454 # and end, all to $;.
455 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
456 $sanitise_quote = '*/';
457
458 substr($res, $off, 2, "$;$;");
459 $off++;
460 next;
461 }
462 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
463 $sanitise_quote = '';
464 substr($res, $off, 2, "$;$;");
465 $off++;
466 next;
467 }
468 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
469 $sanitise_quote = '//';
470
471 substr($res, $off, 2, $sanitise_quote);
472 $off++;
473 next;
474 }
475
476 # A \ in a string means ignore the next character.
477 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
478 $c eq "\\") {
479 substr($res, $off, 2, 'XX');
480 $off++;
481 next;
482 }
483 # Regular quotes.
484 if ($c eq "'" || $c eq '"') {
485 if ($sanitise_quote eq '') {
486 $sanitise_quote = $c;
487
488 substr($res, $off, 1, $c);
489 next;
490 } elsif ($sanitise_quote eq $c) {
491 $sanitise_quote = '';
492 }
493 }
494
495 #print "c<$c> SQ<$sanitise_quote>\n";
496 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
497 substr($res, $off, 1, $;);
498 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
499 substr($res, $off, 1, $;);
500 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
501 substr($res, $off, 1, 'X');
502 } else {
503 substr($res, $off, 1, $c);
504 }
505 }
506
507 if ($sanitise_quote eq '//') {
508 $sanitise_quote = '';
509 }
510
511 # The pathname on a #include may be surrounded by '<' and '>'.
512 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
513 my $clean = 'X' x length($1);
514 $res =~ s@\<.*\>@<$clean>@;
515
516 # The whole of a #error is a string.
517 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
518 my $clean = 'X' x length($1);
519 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
520 }
521
522 return $res;
523 }
524
525 sub ctx_statement_block {
526 my ($linenr, $remain, $off) = @_;
527 my $line = $linenr - 1;
528 my $blk = '';
529 my $soff = $off;
530 my $coff = $off - 1;
531 my $coff_set = 0;
532
533 my $loff = 0;
534
535 my $type = '';
536 my $level = 0;
537 my @stack = ();
538 my $p;
539 my $c;
540 my $len = 0;
541
542 my $remainder;
543 while (1) {
544 @stack = (['', 0]) if ($#stack == -1);
545
546 #warn "CSB: blk<$blk> remain<$remain>\n";
547 # If we are about to drop off the end, pull in more
548 # context.
549 if ($off >= $len) {
550 for (; $remain > 0; $line++) {
551 last if (!defined $lines[$line]);
552 next if ($lines[$line] =~ /^-/);
553 $remain--;
554 $loff = $len;
555 $blk .= $lines[$line] . "\n";
556 $len = length($blk);
557 $line++;
558 last;
559 }
560 # Bail if there is no further context.
561 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
562 if ($off >= $len) {
563 last;
564 }
565 }
566 $p = $c;
567 $c = substr($blk, $off, 1);
568 $remainder = substr($blk, $off);
569
570 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
571
572 # Handle nested #if/#else.
573 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
574 push(@stack, [ $type, $level ]);
575 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
576 ($type, $level) = @{$stack[$#stack - 1]};
577 } elsif ($remainder =~ /^#\s*endif\b/) {
578 ($type, $level) = @{pop(@stack)};
579 }
580
581 # Statement ends at the ';' or a close '}' at the
582 # outermost level.
583 if ($level == 0 && $c eq ';') {
584 last;
585 }
586
587 # An else is really a conditional as long as its not else if
588 if ($level == 0 && $coff_set == 0 &&
589 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
590 $remainder =~ /^(else)(?:\s|{)/ &&
591 $remainder !~ /^else\s+if\b/) {
592 $coff = $off + length($1) - 1;
593 $coff_set = 1;
594 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
595 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
596 }
597
598 if (($type eq '' || $type eq '(') && $c eq '(') {
599 $level++;
600 $type = '(';
601 }
602 if ($type eq '(' && $c eq ')') {
603 $level--;
604 $type = ($level != 0)? '(' : '';
605
606 if ($level == 0 && $coff < $soff) {
607 $coff = $off;
608 $coff_set = 1;
609 #warn "CSB: mark coff<$coff>\n";
610 }
611 }
612 if (($type eq '' || $type eq '{') && $c eq '{') {
613 $level++;
614 $type = '{';
615 }
616 if ($type eq '{' && $c eq '}') {
617 $level--;
618 $type = ($level != 0)? '{' : '';
619
620 if ($level == 0) {
621 if (substr($blk, $off + 1, 1) eq ';') {
622 $off++;
623 }
624 last;
625 }
626 }
627 $off++;
628 }
629 # We are truly at the end, so shuffle to the next line.
630 if ($off == $len) {
631 $loff = $len + 1;
632 $line++;
633 $remain--;
634 }
635
636 my $statement = substr($blk, $soff, $off - $soff + 1);
637 my $condition = substr($blk, $soff, $coff - $soff + 1);
638
639 #warn "STATEMENT<$statement>\n";
640 #warn "CONDITION<$condition>\n";
641
642 #print "coff<$coff> soff<$off> loff<$loff>\n";
643
644 return ($statement, $condition,
645 $line, $remain + 1, $off - $loff + 1, $level);
646 }
647
648 sub statement_lines {
649 my ($stmt) = @_;
650
651 # Strip the diff line prefixes and rip blank lines at start and end.
652 $stmt =~ s/(^|\n)./$1/g;
653 $stmt =~ s/^\s*//;
654 $stmt =~ s/\s*$//;
655
656 my @stmt_lines = ($stmt =~ /\n/g);
657
658 return $#stmt_lines + 2;
659 }
660
661 sub statement_rawlines {
662 my ($stmt) = @_;
663
664 my @stmt_lines = ($stmt =~ /\n/g);
665
666 return $#stmt_lines + 2;
667 }
668
669 sub statement_block_size {
670 my ($stmt) = @_;
671
672 $stmt =~ s/(^|\n)./$1/g;
673 $stmt =~ s/^\s*\{//;
674 $stmt =~ s/}\s*$//;
675 $stmt =~ s/^\s*//;
676 $stmt =~ s/\s*$//;
677
678 my @stmt_lines = ($stmt =~ /\n/g);
679 my @stmt_statements = ($stmt =~ /;/g);
680
681 my $stmt_lines = $#stmt_lines + 2;
682 my $stmt_statements = $#stmt_statements + 1;
683
684 if ($stmt_lines > $stmt_statements) {
685 return $stmt_lines;
686 } else {
687 return $stmt_statements;
688 }
689 }
690
691 sub ctx_statement_full {
692 my ($linenr, $remain, $off) = @_;
693 my ($statement, $condition, $level);
694
695 my (@chunks);
696
697 # Grab the first conditional/block pair.
698 ($statement, $condition, $linenr, $remain, $off, $level) =
699 ctx_statement_block($linenr, $remain, $off);
700 #print "F: c<$condition> s<$statement> remain<$remain>\n";
701 push(@chunks, [ $condition, $statement ]);
702 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
703 return ($level, $linenr, @chunks);
704 }
705
706 # Pull in the following conditional/block pairs and see if they
707 # could continue the statement.
708 for (;;) {
709 ($statement, $condition, $linenr, $remain, $off, $level) =
710 ctx_statement_block($linenr, $remain, $off);
711 #print "C: c<$condition> s<$statement> remain<$remain>\n";
712 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
713 #print "C: push\n";
714 push(@chunks, [ $condition, $statement ]);
715 }
716
717 return ($level, $linenr, @chunks);
718 }
719
720 sub ctx_block_get {
721 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
722 my $line;
723 my $start = $linenr - 1;
724 my $blk = '';
725 my @o;
726 my @c;
727 my @res = ();
728
729 my $level = 0;
730 my @stack = ($level);
731 for ($line = $start; $remain > 0; $line++) {
732 next if ($rawlines[$line] =~ /^-/);
733 $remain--;
734
735 $blk .= $rawlines[$line];
736
737 # Handle nested #if/#else.
738 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
739 push(@stack, $level);
740 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
741 $level = $stack[$#stack - 1];
742 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
743 $level = pop(@stack);
744 }
745
746 foreach my $c (split(//, $lines[$line])) {
747 ##print "C<$c>L<$level><$open$close>O<$off>\n";
748 if ($off > 0) {
749 $off--;
750 next;
751 }
752
753 if ($c eq $close && $level > 0) {
754 $level--;
755 last if ($level == 0);
756 } elsif ($c eq $open) {
757 $level++;
758 }
759 }
760
761 if (!$outer || $level <= 1) {
762 push(@res, $rawlines[$line]);
763 }
764
765 last if ($level == 0);
766 }
767
768 return ($level, @res);
769 }
770 sub ctx_block_outer {
771 my ($linenr, $remain) = @_;
772
773 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
774 return @r;
775 }
776 sub ctx_block {
777 my ($linenr, $remain) = @_;
778
779 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
780 return @r;
781 }
782 sub ctx_statement {
783 my ($linenr, $remain, $off) = @_;
784
785 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
786 return @r;
787 }
788 sub ctx_block_level {
789 my ($linenr, $remain) = @_;
790
791 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
792 }
793 sub ctx_statement_level {
794 my ($linenr, $remain, $off) = @_;
795
796 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
797 }
798
799 sub ctx_locate_comment {
800 my ($first_line, $end_line) = @_;
801
802 # Catch a comment on the end of the line itself.
803 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
804 return $current_comment if (defined $current_comment);
805
806 # Look through the context and try and figure out if there is a
807 # comment.
808 my $in_comment = 0;
809 $current_comment = '';
810 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
811 my $line = $rawlines[$linenr - 1];
812 #warn " $line\n";
813 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
814 $in_comment = 1;
815 }
816 if ($line =~ m@/\*@) {
817 $in_comment = 1;
818 }
819 if (!$in_comment && $current_comment ne '') {
820 $current_comment = '';
821 }
822 $current_comment .= $line . "\n" if ($in_comment);
823 if ($line =~ m@\*/@) {
824 $in_comment = 0;
825 }
826 }
827
828 chomp($current_comment);
829 return($current_comment);
830 }
831 sub ctx_has_comment {
832 my ($first_line, $end_line) = @_;
833 my $cmt = ctx_locate_comment($first_line, $end_line);
834
835 ##print "LINE: $rawlines[$end_line - 1 ]\n";
836 ##print "CMMT: $cmt\n";
837
838 return ($cmt ne '');
839 }
840
841 sub raw_line {
842 my ($linenr, $cnt) = @_;
843
844 my $offset = $linenr - 1;
845 $cnt++;
846
847 my $line;
848 while ($cnt) {
849 $line = $rawlines[$offset++];
850 next if (defined($line) && $line =~ /^-/);
851 $cnt--;
852 }
853
854 return $line;
855 }
856
857 sub cat_vet {
858 my ($vet) = @_;
859 my ($res, $coded);
860
861 $res = '';
862 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
863 $res .= $1;
864 if ($2 ne '') {
865 $coded = sprintf("^%c", unpack('C', $2) + 64);
866 $res .= $coded;
867 }
868 }
869 $res =~ s/$/\$/;
870
871 return $res;
872 }
873
874 my $av_preprocessor = 0;
875 my $av_pending;
876 my @av_paren_type;
877 my $av_pend_colon;
878
879 sub annotate_reset {
880 $av_preprocessor = 0;
881 $av_pending = '_';
882 @av_paren_type = ('E');
883 $av_pend_colon = 'O';
884 }
885
886 sub annotate_values {
887 my ($stream, $type) = @_;
888
889 my $res;
890 my $var = '_' x length($stream);
891 my $cur = $stream;
892
893 print "$stream\n" if ($dbg_values > 1);
894
895 while (length($cur)) {
896 @av_paren_type = ('E') if ($#av_paren_type < 0);
897 print " <" . join('', @av_paren_type) .
898 "> <$type> <$av_pending>" if ($dbg_values > 1);
899 if ($cur =~ /^(\s+)/o) {
900 print "WS($1)\n" if ($dbg_values > 1);
901 if ($1 =~ /\n/ && $av_preprocessor) {
902 $type = pop(@av_paren_type);
903 $av_preprocessor = 0;
904 }
905
906 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
907 print "CAST($1)\n" if ($dbg_values > 1);
908 push(@av_paren_type, $type);
909 $type = 'C';
910
911 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
912 print "DECLARE($1)\n" if ($dbg_values > 1);
913 $type = 'T';
914
915 } elsif ($cur =~ /^($Modifier)\s*/) {
916 print "MODIFIER($1)\n" if ($dbg_values > 1);
917 $type = 'T';
918
919 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
920 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
921 $av_preprocessor = 1;
922 push(@av_paren_type, $type);
923 if ($2 ne '') {
924 $av_pending = 'N';
925 }
926 $type = 'E';
927
928 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
929 print "UNDEF($1)\n" if ($dbg_values > 1);
930 $av_preprocessor = 1;
931 push(@av_paren_type, $type);
932
933 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
934 print "PRE_START($1)\n" if ($dbg_values > 1);
935 $av_preprocessor = 1;
936
937 push(@av_paren_type, $type);
938 push(@av_paren_type, $type);
939 $type = 'E';
940
941 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
942 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
943 $av_preprocessor = 1;
944
945 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
946
947 $type = 'E';
948
949 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
950 print "PRE_END($1)\n" if ($dbg_values > 1);
951
952 $av_preprocessor = 1;
953
954 # Assume all arms of the conditional end as this
955 # one does, and continue as if the #endif was not here.
956 pop(@av_paren_type);
957 push(@av_paren_type, $type);
958 $type = 'E';
959
960 } elsif ($cur =~ /^(\\\n)/o) {
961 print "PRECONT($1)\n" if ($dbg_values > 1);
962
963 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
964 print "ATTR($1)\n" if ($dbg_values > 1);
965 $av_pending = $type;
966 $type = 'N';
967
968 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
969 print "SIZEOF($1)\n" if ($dbg_values > 1);
970 if (defined $2) {
971 $av_pending = 'V';
972 }
973 $type = 'N';
974
975 } elsif ($cur =~ /^(if|while|for)\b/o) {
976 print "COND($1)\n" if ($dbg_values > 1);
977 $av_pending = 'E';
978 $type = 'N';
979
980 } elsif ($cur =~/^(case)/o) {
981 print "CASE($1)\n" if ($dbg_values > 1);
982 $av_pend_colon = 'C';
983 $type = 'N';
984
985 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
986 print "KEYWORD($1)\n" if ($dbg_values > 1);
987 $type = 'N';
988
989 } elsif ($cur =~ /^(\()/o) {
990 print "PAREN('$1')\n" if ($dbg_values > 1);
991 push(@av_paren_type, $av_pending);
992 $av_pending = '_';
993 $type = 'N';
994
995 } elsif ($cur =~ /^(\))/o) {
996 my $new_type = pop(@av_paren_type);
997 if ($new_type ne '_') {
998 $type = $new_type;
999 print "PAREN('$1') -> $type\n"
1000 if ($dbg_values > 1);
1001 } else {
1002 print "PAREN('$1')\n" if ($dbg_values > 1);
1003 }
1004
1005 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1006 print "FUNC($1)\n" if ($dbg_values > 1);
1007 $type = 'V';
1008 $av_pending = 'V';
1009
1010 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1011 if (defined $2 && $type eq 'C' || $type eq 'T') {
1012 $av_pend_colon = 'B';
1013 } elsif ($type eq 'E') {
1014 $av_pend_colon = 'L';
1015 }
1016 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1017 $type = 'V';
1018
1019 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1020 print "IDENT($1)\n" if ($dbg_values > 1);
1021 $type = 'V';
1022
1023 } elsif ($cur =~ /^($Assignment)/o) {
1024 print "ASSIGN($1)\n" if ($dbg_values > 1);
1025 $type = 'N';
1026
1027 } elsif ($cur =~/^(;|{|})/) {
1028 print "END($1)\n" if ($dbg_values > 1);
1029 $type = 'E';
1030 $av_pend_colon = 'O';
1031
1032 } elsif ($cur =~/^(,)/) {
1033 print "COMMA($1)\n" if ($dbg_values > 1);
1034 $type = 'C';
1035
1036 } elsif ($cur =~ /^(\?)/o) {
1037 print "QUESTION($1)\n" if ($dbg_values > 1);
1038 $type = 'N';
1039
1040 } elsif ($cur =~ /^(:)/o) {
1041 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1042
1043 substr($var, length($res), 1, $av_pend_colon);
1044 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1045 $type = 'E';
1046 } else {
1047 $type = 'N';
1048 }
1049 $av_pend_colon = 'O';
1050
1051 } elsif ($cur =~ /^(\[)/o) {
1052 print "CLOSE($1)\n" if ($dbg_values > 1);
1053 $type = 'N';
1054
1055 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1056 my $variant;
1057
1058 print "OPV($1)\n" if ($dbg_values > 1);
1059 if ($type eq 'V') {
1060 $variant = 'B';
1061 } else {
1062 $variant = 'U';
1063 }
1064
1065 substr($var, length($res), 1, $variant);
1066 $type = 'N';
1067
1068 } elsif ($cur =~ /^($Operators)/o) {
1069 print "OP($1)\n" if ($dbg_values > 1);
1070 if ($1 ne '++' && $1 ne '--') {
1071 $type = 'N';
1072 }
1073
1074 } elsif ($cur =~ /(^.)/o) {
1075 print "C($1)\n" if ($dbg_values > 1);
1076 }
1077 if (defined $1) {
1078 $cur = substr($cur, length($1));
1079 $res .= $type x length($1);
1080 }
1081 }
1082
1083 return ($res, $var);
1084 }
1085
1086 sub possible {
1087 my ($possible, $line) = @_;
1088 my $notPermitted = qr{(?:
1089 ^(?:
1090 $Modifier|
1091 $Storage|
1092 $Type|
1093 DEFINE_\S+
1094 )$|
1095 ^(?:
1096 goto|
1097 return|
1098 case|
1099 else|
1100 asm|__asm__|
1101 do|
1102 \#|
1103 \#\#
1104 )(?:\s|$)|
1105 ^(?:typedef|struct|enum)\b
1106 )}x;
1107 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1108 if ($possible !~ $notPermitted) {
1109 # Check for modifiers.
1110 $possible =~ s/\s*$Storage\s*//g;
1111 $possible =~ s/\s*$Sparse\s*//g;
1112 if ($possible =~ /^\s*$/) {
1113
1114 } elsif ($possible =~ /\s/) {
1115 $possible =~ s/\s*$Type\s*//g;
1116 for my $modifier (split(' ', $possible)) {
1117 if ($modifier !~ $notPermitted) {
1118 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1119 push(@modifierList, $modifier);
1120 }
1121 }
1122
1123 } else {
1124 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1125 push(@typeList, $possible);
1126 }
1127 build_types();
1128 } else {
1129 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1130 }
1131 }
1132
1133 my $prefix = '';
1134
1135 sub report {
1136 if (defined $tst_only && $_[0] !~ /\Q$tst_only\E/) {
1137 return 0;
1138 }
1139 my $line = $prefix . $_[0];
1140
1141 $line = (split('\n', $line))[0] . "\n" if ($terse);
1142
1143 push(our @report, $line);
1144
1145 return 1;
1146 }
1147 sub report_dump {
1148 our @report;
1149 }
1150 sub ERROR {
1151 if (report("ERROR: $_[0]\n")) {
1152 our $clean = 0;
1153 our $cnt_error++;
1154 }
1155 }
1156 sub WARN {
1157 if (report("WARNING: $_[0]\n")) {
1158 our $clean = 0;
1159 our $cnt_warn++;
1160 }
1161 }
1162
1163 sub process {
1164 my $filename = shift;
1165
1166 my $linenr=0;
1167 my $prevline="";
1168 my $prevrawline="";
1169 my $stashline="";
1170 my $stashrawline="";
1171
1172 my $length;
1173 my $indent;
1174 my $previndent=0;
1175 my $stashindent=0;
1176
1177 our $clean = 1;
1178 my $signoff = 0;
1179 my $is_patch = 0;
1180
1181 our @report = ();
1182 our $cnt_lines = 0;
1183 our $cnt_error = 0;
1184 our $cnt_warn = 0;
1185 our $cnt_chk = 0;
1186
1187 # Trace the real file/line as we go.
1188 my $realfile = '';
1189 my $realline = 0;
1190 my $realcnt = 0;
1191 my $here = '';
1192 my $in_comment = 0;
1193 my $comment_edge = 0;
1194 my $first_line = 0;
1195 my $p1_prefix = '';
1196
1197 my $prev_values = 'E';
1198
1199 # suppression flags
1200 my %suppress_ifbraces;
1201 my %suppress_whiletrailers;
1202 my %suppress_export;
1203
1204 # Pre-scan the patch sanitizing the lines.
1205
1206 sanitise_line_reset();
1207 my $line;
1208 foreach my $rawline (@rawlines) {
1209 $linenr++;
1210 $line = $rawline;
1211
1212 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1213 $realline=$1-1;
1214 if (defined $2) {
1215 $realcnt=$3+1;
1216 } else {
1217 $realcnt=1+1;
1218 }
1219 $in_comment = 0;
1220
1221 # Guestimate if this is a continuing comment. Run
1222 # the context looking for a comment "edge". If this
1223 # edge is a close comment then we must be in a comment
1224 # at context start.
1225 my $edge;
1226 my $cnt = $realcnt;
1227 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1228 next if (defined $rawlines[$ln - 1] &&
1229 $rawlines[$ln - 1] =~ /^-/);
1230 $cnt--;
1231 #print "RAW<$rawlines[$ln - 1]>\n";
1232 last if (!defined $rawlines[$ln - 1]);
1233 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1234 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1235 ($edge) = $1;
1236 last;
1237 }
1238 }
1239 if (defined $edge && $edge eq '*/') {
1240 $in_comment = 1;
1241 }
1242
1243 # Guestimate if this is a continuing comment. If this
1244 # is the start of a diff block and this line starts
1245 # ' *' then it is very likely a comment.
1246 if (!defined $edge &&
1247 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1248 {
1249 $in_comment = 1;
1250 }
1251
1252 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1253 sanitise_line_reset($in_comment);
1254
1255 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1256 # Standardise the strings and chars within the input to
1257 # simplify matching -- only bother with positive lines.
1258 $line = sanitise_line($rawline);
1259 }
1260 push(@lines, $line);
1261
1262 if ($realcnt > 1) {
1263 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1264 } else {
1265 $realcnt = 0;
1266 }
1267
1268 #print "==>$rawline\n";
1269 #print "-->$line\n";
1270 }
1271
1272 $prefix = '';
1273
1274 $realcnt = 0;
1275 $linenr = 0;
1276 foreach my $line (@lines) {
1277 $linenr++;
1278
1279 my $rawline = $rawlines[$linenr - 1];
1280
1281 #extract the line range in the file after the patch is applied
1282 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1283 $is_patch = 1;
1284 $first_line = $linenr + 1;
1285 $realline=$1-1;
1286 if (defined $2) {
1287 $realcnt=$3+1;
1288 } else {
1289 $realcnt=1+1;
1290 }
1291 annotate_reset();
1292 $prev_values = 'E';
1293
1294 %suppress_ifbraces = ();
1295 %suppress_whiletrailers = ();
1296 %suppress_export = ();
1297 next;
1298
1299 # track the line number as we move through the hunk, note that
1300 # new versions of GNU diff omit the leading space on completely
1301 # blank context lines so we need to count that too.
1302 } elsif ($line =~ /^( |\+|$)/) {
1303 $realline++;
1304 $realcnt-- if ($realcnt != 0);
1305
1306 # Measure the line length and indent.
1307 ($length, $indent) = line_stats($rawline);
1308
1309 # Track the previous line.
1310 ($prevline, $stashline) = ($stashline, $line);
1311 ($previndent, $stashindent) = ($stashindent, $indent);
1312 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1313
1314 #warn "line<$line>\n";
1315
1316 } elsif ($realcnt == 1) {
1317 $realcnt--;
1318 }
1319
1320 my $hunk_line = ($realcnt != 0);
1321
1322 #make up the handle for any error we report on this line
1323 $prefix = "$filename:$realline: " if ($emacs && $file);
1324 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1325
1326 $here = "#$linenr: " if (!$file);
1327 $here = "#$realline: " if ($file);
1328
1329 # extract the filename as it passes
1330 if ($line =~ /^diff --git.*?(\S+)$/) {
1331 $realfile = $1;
1332 $realfile =~ s@^([^/]*)/@@;
1333
1334 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1335 $realfile = $1;
1336 $realfile =~ s@^([^/]*)/@@;
1337
1338 $p1_prefix = $1;
1339 if (!$file && $tree && $p1_prefix ne '' &&
1340 -e "$root/$p1_prefix") {
1341 WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1342 }
1343
1344 next;
1345 }
1346
1347 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1348
1349 my $hereline = "$here\n$rawline\n";
1350 my $herecurr = "$here\n$rawline\n";
1351 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1352
1353 $cnt_lines++ if ($realcnt != 0);
1354
1355 # Check for incorrect file permissions
1356 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1357 my $permhere = $here . "FILE: $realfile\n";
1358 if ($realfile =~ /(\bMakefile(?:\.objs)?|\.c|\.cc|\.cpp|\.h|\.mak|\.[sS])$/) {
1359 ERROR("do not set execute permissions for source files\n" . $permhere);
1360 }
1361 }
1362
1363 # Accept git diff extended headers as valid patches
1364 if ($line =~ /^(?:rename|copy) (?:from|to) [\w\/\.\-]+\s*$/) {
1365 $is_patch = 1;
1366 }
1367
1368 #check the patch for a signoff:
1369 if ($line =~ /^\s*signed-off-by:/i) {
1370 # This is a signoff, if ugly, so do not double report.
1371 $signoff++;
1372 if (!($line =~ /^\s*Signed-off-by:/)) {
1373 ERROR("The correct form is \"Signed-off-by\"\n" .
1374 $herecurr);
1375 }
1376 if ($line =~ /^\s*signed-off-by:\S/i) {
1377 ERROR("space required after Signed-off-by:\n" .
1378 $herecurr);
1379 }
1380 }
1381
1382 # Check for wrappage within a valid hunk of the file
1383 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1384 ERROR("patch seems to be corrupt (line wrapped?)\n" .
1385 $herecurr) if (!$emitted_corrupt++);
1386 }
1387
1388 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1389 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1390 $rawline !~ m/^$UTF8*$/) {
1391 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1392
1393 my $blank = copy_spacing($rawline);
1394 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1395 my $hereptr = "$hereline$ptr\n";
1396
1397 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1398 }
1399
1400 # ignore non-hunk lines and lines being removed
1401 next if (!$hunk_line || $line =~ /^-/);
1402
1403 # ignore files that are being periodically imported from Linux
1404 next if ($realfile =~ /^(linux-headers|include\/standard-headers)\//);
1405
1406 #trailing whitespace
1407 if ($line =~ /^\+.*\015/) {
1408 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1409 ERROR("DOS line endings\n" . $herevet);
1410
1411 } elsif ($realfile =~ /^docs\/.+\.txt/ ||
1412 $realfile =~ /^docs\/.+\.md/) {
1413 if ($rawline =~ /^\+\s+$/ && $rawline !~ /^\+ {4}$/) {
1414 # TODO: properly check we're in a code block
1415 # (surrounding text is 4-column aligned)
1416 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1417 ERROR("code blocks in documentation should have " .
1418 "empty lines with exactly 4 columns of " .
1419 "whitespace\n" . $herevet);
1420 }
1421 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1422 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1423 ERROR("trailing whitespace\n" . $herevet);
1424 $rpt_cleaners = 1;
1425 }
1426
1427 # checks for trace-events files
1428 if ($realfile =~ /trace-events$/ && $line =~ /^\+/) {
1429 if ($rawline =~ /%[-+ 0]*#/) {
1430 ERROR("Don't use '#' flag of printf format ('%#') in " .
1431 "trace-events, use '0x' prefix instead\n" . $herecurr);
1432 } else {
1433 my $hex =
1434 qr/%[-+ *.0-9]*([hljztL]|ll|hh)?(x|X|"\s*PRI[xX][^"]*"?)/;
1435
1436 # don't consider groups splitted by [.:/ ], like 2A.20:12ab
1437 my $tmpline = $rawline;
1438 $tmpline =~ s/($hex[.:\/ ])+$hex//g;
1439
1440 if ($tmpline =~ /(?<!0x)$hex/) {
1441 ERROR("Hex numbers must be prefixed with '0x'\n" .
1442 $herecurr);
1443 }
1444 }
1445 }
1446
1447 # check we are in a valid source file if not then ignore this hunk
1448 next if ($realfile !~ /$SrcFile/);
1449
1450 #90 column limit; exempt URLs, if no other words on line
1451 if ($line =~ /^\+/ &&
1452 !($line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1453 !($rawline =~ /^[^[:alnum:]]*https?:\S*$/) &&
1454 $length > 80)
1455 {
1456 if ($length > 90) {
1457 ERROR("line over 90 characters\n" . $herecurr);
1458 } else {
1459 WARN("line over 80 characters\n" . $herecurr);
1460 }
1461 }
1462
1463 # check for spaces before a quoted newline
1464 if ($rawline =~ /^.*\".*\s\\n/) {
1465 ERROR("unnecessary whitespace before a quoted newline\n" . $herecurr);
1466 }
1467
1468 # check for adding lines without a newline.
1469 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1470 ERROR("adding a line without newline at end of file\n" . $herecurr);
1471 }
1472
1473 # check for RCS/CVS revision markers
1474 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|\b)/) {
1475 ERROR("CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1476 }
1477
1478 # tabs are only allowed in assembly source code, and in
1479 # some scripts we imported from other projects.
1480 next if ($realfile =~ /\.(s|S)$/);
1481 next if ($realfile =~ /(checkpatch|get_maintainer|texi2pod)\.pl$/);
1482
1483 if ($rawline =~ /^\+.*\t/) {
1484 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1485 ERROR("code indent should never use tabs\n" . $herevet);
1486 $rpt_cleaners = 1;
1487 }
1488
1489 # check we are in a valid C source file if not then ignore this hunk
1490 next if ($realfile !~ /\.(h|c|cpp)$/);
1491
1492 # Check for potential 'bare' types
1493 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1494 $realline_next);
1495 if ($realcnt && $line =~ /.\s*\S/) {
1496 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1497 ctx_statement_block($linenr, $realcnt, 0);
1498 $stat =~ s/\n./\n /g;
1499 $cond =~ s/\n./\n /g;
1500
1501 # Find the real next line.
1502 $realline_next = $line_nr_next;
1503 if (defined $realline_next &&
1504 (!defined $lines[$realline_next - 1] ||
1505 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1506 $realline_next++;
1507 }
1508
1509 my $s = $stat;
1510 $s =~ s/{.*$//s;
1511
1512 # Ignore goto labels.
1513 if ($s =~ /$Ident:\*$/s) {
1514
1515 # Ignore functions being called
1516 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1517
1518 } elsif ($s =~ /^.\s*else\b/s) {
1519
1520 # declarations always start with types
1521 } 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) {
1522 my $type = $1;
1523 $type =~ s/\s+/ /g;
1524 possible($type, "A:" . $s);
1525
1526 # definitions in global scope can only start with types
1527 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1528 possible($1, "B:" . $s);
1529 }
1530
1531 # any (foo ... *) is a pointer cast, and foo is a type
1532 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1533 possible($1, "C:" . $s);
1534 }
1535
1536 # Check for any sort of function declaration.
1537 # int foo(something bar, other baz);
1538 # void (*store_gdt)(x86_descr_ptr *);
1539 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1540 my ($name_len) = length($1);
1541
1542 my $ctx = $s;
1543 substr($ctx, 0, $name_len + 1, '');
1544 $ctx =~ s/\)[^\)]*$//;
1545
1546 for my $arg (split(/\s*,\s*/, $ctx)) {
1547 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1548
1549 possible($1, "D:" . $s);
1550 }
1551 }
1552 }
1553
1554 }
1555
1556 #
1557 # Checks which may be anchored in the context.
1558 #
1559
1560 # Check for switch () and associated case and default
1561 # statements should be at the same indent.
1562 if ($line=~/\bswitch\s*\(.*\)/) {
1563 my $err = '';
1564 my $sep = '';
1565 my @ctx = ctx_block_outer($linenr, $realcnt);
1566 shift(@ctx);
1567 for my $ctx (@ctx) {
1568 my ($clen, $cindent) = line_stats($ctx);
1569 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1570 $indent != $cindent) {
1571 $err .= "$sep$ctx\n";
1572 $sep = '';
1573 } else {
1574 $sep = "[...]\n";
1575 }
1576 }
1577 if ($err ne '') {
1578 ERROR("switch and case should be at the same indent\n$hereline$err");
1579 }
1580 }
1581
1582 # if/while/etc brace do not go on next line, unless defining a do while loop,
1583 # or if that brace on the next line is for something else
1584 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
1585 my $pre_ctx = "$1$2";
1586
1587 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
1588 my $ctx_cnt = $realcnt - $#ctx - 1;
1589 my $ctx = join("\n", @ctx);
1590
1591 my $ctx_ln = $linenr;
1592 my $ctx_skip = $realcnt;
1593
1594 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
1595 defined $lines[$ctx_ln - 1] &&
1596 $lines[$ctx_ln - 1] =~ /^-/)) {
1597 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
1598 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
1599 $ctx_ln++;
1600 }
1601
1602 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
1603 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
1604
1605 # The length of the "previous line" is checked against 80 because it
1606 # includes the + at the beginning of the line (if the actual line has
1607 # 79 or 80 characters, it is no longer possible to add a space and an
1608 # opening brace there)
1609 if ($#ctx == 0 && $ctx !~ /{\s*/ &&
1610 defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*\{/ &&
1611 defined($lines[$ctx_ln - 2]) && length($lines[$ctx_ln - 2]) < 80) {
1612 ERROR("that open brace { should be on the previous line\n" .
1613 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1614 }
1615 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
1616 $ctx =~ /\)\s*\;\s*$/ &&
1617 defined $lines[$ctx_ln - 1])
1618 {
1619 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
1620 if ($nindent > $indent) {
1621 ERROR("trailing semicolon indicates no statements, indent implies otherwise\n" .
1622 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
1623 }
1624 }
1625 }
1626
1627 # 'do ... while (0/false)' only makes sense in macros, without trailing ';'
1628 if ($line =~ /while\s*\((0|false)\);/) {
1629 ERROR("suspicious ; after while (0)\n" . $herecurr);
1630 }
1631
1632 # Check relative indent for conditionals and blocks.
1633 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
1634 my ($s, $c) = ($stat, $cond);
1635
1636 substr($s, 0, length($c), '');
1637
1638 # Make sure we remove the line prefixes as we have
1639 # none on the first line, and are going to readd them
1640 # where necessary.
1641 $s =~ s/\n./\n/gs;
1642
1643 # Find out how long the conditional actually is.
1644 my @newlines = ($c =~ /\n/gs);
1645 my $cond_lines = 1 + $#newlines;
1646
1647 # We want to check the first line inside the block
1648 # starting at the end of the conditional, so remove:
1649 # 1) any blank line termination
1650 # 2) any opening brace { on end of the line
1651 # 3) any do (...) {
1652 my $continuation = 0;
1653 my $check = 0;
1654 $s =~ s/^.*\bdo\b//;
1655 $s =~ s/^\s*\{//;
1656 if ($s =~ s/^\s*\\//) {
1657 $continuation = 1;
1658 }
1659 if ($s =~ s/^\s*?\n//) {
1660 $check = 1;
1661 $cond_lines++;
1662 }
1663
1664 # Also ignore a loop construct at the end of a
1665 # preprocessor statement.
1666 if (($prevline =~ /^.\s*#\s*define\s/ ||
1667 $prevline =~ /\\\s*$/) && $continuation == 0) {
1668 $check = 0;
1669 }
1670
1671 my $cond_ptr = -1;
1672 $continuation = 0;
1673 while ($cond_ptr != $cond_lines) {
1674 $cond_ptr = $cond_lines;
1675
1676 # If we see an #else/#elif then the code
1677 # is not linear.
1678 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
1679 $check = 0;
1680 }
1681
1682 # Ignore:
1683 # 1) blank lines, they should be at 0,
1684 # 2) preprocessor lines, and
1685 # 3) labels.
1686 if ($continuation ||
1687 $s =~ /^\s*?\n/ ||
1688 $s =~ /^\s*#\s*?/ ||
1689 $s =~ /^\s*$Ident\s*:/) {
1690 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
1691 if ($s =~ s/^.*?\n//) {
1692 $cond_lines++;
1693 }
1694 }
1695 }
1696
1697 my (undef, $sindent) = line_stats("+" . $s);
1698 my $stat_real = raw_line($linenr, $cond_lines);
1699
1700 # Check if either of these lines are modified, else
1701 # this is not this patch's fault.
1702 if (!defined($stat_real) ||
1703 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
1704 $check = 0;
1705 }
1706 if (defined($stat_real) && $cond_lines > 1) {
1707 $stat_real = "[...]\n$stat_real";
1708 }
1709
1710 #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";
1711
1712 if ($check && (($sindent % 4) != 0 ||
1713 ($sindent <= $indent && $s ne ''))) {
1714 ERROR("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
1715 }
1716 }
1717
1718 # Track the 'values' across context and added lines.
1719 my $opline = $line; $opline =~ s/^./ /;
1720 my ($curr_values, $curr_vars) =
1721 annotate_values($opline . "\n", $prev_values);
1722 $curr_values = $prev_values . $curr_values;
1723 if ($dbg_values) {
1724 my $outline = $opline; $outline =~ s/\t/ /g;
1725 print "$linenr > .$outline\n";
1726 print "$linenr > $curr_values\n";
1727 print "$linenr > $curr_vars\n";
1728 }
1729 $prev_values = substr($curr_values, -1);
1730
1731 #ignore lines not being added
1732 if ($line=~/^[^\+]/) {next;}
1733
1734 # TEST: allow direct testing of the type matcher.
1735 if ($dbg_type) {
1736 if ($line =~ /^.\s*$Declare\s*$/) {
1737 ERROR("TEST: is type\n" . $herecurr);
1738 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
1739 ERROR("TEST: is not type ($1 is)\n". $herecurr);
1740 }
1741 next;
1742 }
1743 # TEST: allow direct testing of the attribute matcher.
1744 if ($dbg_attr) {
1745 if ($line =~ /^.\s*$Modifier\s*$/) {
1746 ERROR("TEST: is attr\n" . $herecurr);
1747 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
1748 ERROR("TEST: is not attr ($1 is)\n". $herecurr);
1749 }
1750 next;
1751 }
1752
1753 # check for initialisation to aggregates open brace on the next line
1754 if ($line =~ /^.\s*\{/ &&
1755 $prevline =~ /(?:^|[^=])=\s*$/) {
1756 ERROR("that open brace { should be on the previous line\n" . $hereprev);
1757 }
1758
1759 #
1760 # Checks which are anchored on the added line.
1761 #
1762
1763 # check for malformed paths in #include statements (uses RAW line)
1764 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
1765 my $path = $1;
1766 if ($path =~ m{//}) {
1767 ERROR("malformed #include filename\n" .
1768 $herecurr);
1769 }
1770 }
1771
1772 # no C99 // comments
1773 if ($line =~ m{//}) {
1774 ERROR("do not use C99 // comments\n" . $herecurr);
1775 }
1776 # Remove C99 comments.
1777 $line =~ s@//.*@@;
1778 $opline =~ s@//.*@@;
1779
1780 # check for global initialisers.
1781 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
1782 ERROR("do not initialise globals to 0 or NULL\n" .
1783 $herecurr);
1784 }
1785 # check for static initialisers.
1786 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
1787 ERROR("do not initialise statics to 0 or NULL\n" .
1788 $herecurr);
1789 }
1790
1791 # * goes on variable not on type
1792 # (char*[ const])
1793 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) {
1794 my ($from, $to) = ($1, $1);
1795
1796 # Should start with a space.
1797 $to =~ s/^(\S)/ $1/;
1798 # Should not end with a space.
1799 $to =~ s/\s+$//;
1800 # '*'s should not have spaces between.
1801 while ($to =~ s/\*\s+\*/\*\*/) {
1802 }
1803
1804 #print "from<$from> to<$to>\n";
1805 if ($from ne $to) {
1806 ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
1807 }
1808 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) {
1809 my ($from, $to, $ident) = ($1, $1, $2);
1810
1811 # Should start with a space.
1812 $to =~ s/^(\S)/ $1/;
1813 # Should not end with a space.
1814 $to =~ s/\s+$//;
1815 # '*'s should not have spaces between.
1816 while ($to =~ s/\*\s+\*/\*\*/) {
1817 }
1818 # Modifiers should have spaces.
1819 $to =~ s/(\b$Modifier$)/$1 /;
1820
1821 #print "from<$from> to<$to> ident<$ident>\n";
1822 if ($from ne $to && $ident !~ /^$Modifier$/) {
1823 ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
1824 }
1825 }
1826
1827 # function brace can't be on same line, except for #defines of do while,
1828 # or if closed on same line
1829 if (($line=~/$Type\s*$Ident\(.*\).*\s\{/) and
1830 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) {
1831 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr);
1832 }
1833
1834 # open braces for enum, union and struct go on the same line.
1835 if ($line =~ /^.\s*\{/ &&
1836 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
1837 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev);
1838 }
1839
1840 # missing space after union, struct or enum definition
1841 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
1842 ERROR("missing space after $1 definition\n" . $herecurr);
1843 }
1844
1845 # check for spacing round square brackets; allowed:
1846 # 1. with a type on the left -- int [] a;
1847 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
1848 # 3. inside a curly brace -- = { [0...10] = 5 }
1849 # 4. after a comma -- [1] = 5, [2] = 6
1850 # 5. in a macro definition -- #define abc(x) [x] = y
1851 while ($line =~ /(.*?\s)\[/g) {
1852 my ($where, $prefix) = ($-[1], $1);
1853 if ($prefix !~ /$Type\s+$/ &&
1854 ($where != 0 || $prefix !~ /^.\s+$/) &&
1855 $prefix !~ /{\s+$/ &&
1856 $prefix !~ /\#\s*define[^(]*\([^)]*\)\s+$/ &&
1857 $prefix !~ /,\s+$/) {
1858 ERROR("space prohibited before open square bracket '['\n" . $herecurr);
1859 }
1860 }
1861
1862 # check for spaces between functions and their parentheses.
1863 while ($line =~ /($Ident)\s+\(/g) {
1864 my $name = $1;
1865 my $ctx_before = substr($line, 0, $-[1]);
1866 my $ctx = "$ctx_before$name";
1867
1868 # Ignore those directives where spaces _are_ permitted.
1869 if ($name =~ /^(?:
1870 if|for|while|switch|return|case|
1871 volatile|__volatile__|coroutine_fn|
1872 __attribute__|format|__extension__|
1873 asm|__asm__)$/x)
1874 {
1875
1876 # Ignore 'catch (...)' in C++
1877 } elsif ($name =~ /^catch$/ && $realfile =~ /(\.cpp|\.h)$/) {
1878
1879 # cpp #define statements have non-optional spaces, ie
1880 # if there is a space between the name and the open
1881 # parenthesis it is simply not a parameter group.
1882 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
1883
1884 # cpp #elif statement condition may start with a (
1885 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
1886
1887 # If this whole things ends with a type its most
1888 # likely a typedef for a function.
1889 } elsif ($ctx =~ /$Type$/) {
1890
1891 } else {
1892 ERROR("space prohibited between function name and open parenthesis '('\n" . $herecurr);
1893 }
1894 }
1895 # Check operator spacing.
1896 if (!($line=~/\#\s*include/)) {
1897 my $ops = qr{
1898 <<=|>>=|<=|>=|==|!=|
1899 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
1900 =>|->|<<|>>|<|>|=|!|~|
1901 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
1902 \?|::|:
1903 }x;
1904 my @elements = split(/($ops|;)/, $opline);
1905 my $off = 0;
1906
1907 my $blank = copy_spacing($opline);
1908
1909 for (my $n = 0; $n < $#elements; $n += 2) {
1910 $off += length($elements[$n]);
1911
1912 # Pick up the preceding and succeeding characters.
1913 my $ca = substr($opline, 0, $off);
1914 my $cc = '';
1915 if (length($opline) >= ($off + length($elements[$n + 1]))) {
1916 $cc = substr($opline, $off + length($elements[$n + 1]));
1917 }
1918 my $cb = "$ca$;$cc";
1919
1920 my $a = '';
1921 $a = 'V' if ($elements[$n] ne '');
1922 $a = 'W' if ($elements[$n] =~ /\s$/);
1923 $a = 'C' if ($elements[$n] =~ /$;$/);
1924 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
1925 $a = 'O' if ($elements[$n] eq '');
1926 $a = 'E' if ($ca =~ /^\s*$/);
1927
1928 my $op = $elements[$n + 1];
1929
1930 my $c = '';
1931 if (defined $elements[$n + 2]) {
1932 $c = 'V' if ($elements[$n + 2] ne '');
1933 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
1934 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
1935 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
1936 $c = 'O' if ($elements[$n + 2] eq '');
1937 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
1938 } else {
1939 $c = 'E';
1940 }
1941
1942 my $ctx = "${a}x${c}";
1943
1944 my $at = "(ctx:$ctx)";
1945
1946 my $ptr = substr($blank, 0, $off) . "^";
1947 my $hereptr = "$hereline$ptr\n";
1948
1949 # Pull out the value of this operator.
1950 my $op_type = substr($curr_values, $off + 1, 1);
1951
1952 # Get the full operator variant.
1953 my $opv = $op . substr($curr_vars, $off, 1);
1954
1955 # Ignore operators passed as parameters.
1956 if ($op_type ne 'V' &&
1957 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
1958
1959 # # Ignore comments
1960 # } elsif ($op =~ /^$;+$/) {
1961
1962 # ; should have either the end of line or a space or \ after it
1963 } elsif ($op eq ';') {
1964 if ($ctx !~ /.x[WEBC]/ &&
1965 $cc !~ /^\\/ && $cc !~ /^;/) {
1966 ERROR("space required after that '$op' $at\n" . $hereptr);
1967 }
1968
1969 # // is a comment
1970 } elsif ($op eq '//') {
1971
1972 # Ignore : used in class declaration in C++
1973 } elsif ($opv eq ':B' && $ctx =~ /Wx[WE]/ &&
1974 $line =~ /class/ && $realfile =~ /(\.cpp|\.h)$/) {
1975
1976 # No spaces for:
1977 # ->
1978 # : when part of a bitfield
1979 } elsif ($op eq '->' || $opv eq ':B') {
1980 if ($ctx =~ /Wx.|.xW/) {
1981 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr);
1982 }
1983
1984 # , must have a space on the right.
1985 # not required when having a single },{ on one line
1986 } elsif ($op eq ',') {
1987 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/ &&
1988 ($elements[$n] . $elements[$n + 2]) !~ " *}\\{") {
1989 ERROR("space required after that '$op' $at\n" . $hereptr);
1990 }
1991
1992 # '*' as part of a type definition -- reported already.
1993 } elsif ($opv eq '*_') {
1994 #warn "'*' is part of type\n";
1995
1996 # unary operators should have a space before and
1997 # none after. May be left adjacent to another
1998 # unary operator, or a cast
1999 } elsif ($op eq '!' || $op eq '~' ||
2000 $opv eq '*U' || $opv eq '-U' ||
2001 $opv eq '&U' || $opv eq '&&U') {
2002 if ($op eq '~' && $ca =~ /::$/ && $realfile =~ /(\.cpp|\.h)$/) {
2003 # '~' used as a name of Destructor
2004
2005 } elsif ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2006 ERROR("space required before that '$op' $at\n" . $hereptr);
2007 }
2008 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2009 # A unary '*' may be const
2010
2011 } elsif ($ctx =~ /.xW/) {
2012 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
2013 }
2014
2015 # unary ++ and unary -- are allowed no space on one side.
2016 } elsif ($op eq '++' or $op eq '--') {
2017 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2018 ERROR("space required one side of that '$op' $at\n" . $hereptr);
2019 }
2020 if ($ctx =~ /Wx[BE]/ ||
2021 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2022 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
2023 }
2024 if ($ctx =~ /ExW/) {
2025 ERROR("space prohibited after that '$op' $at\n" . $hereptr);
2026 }
2027
2028 # A colon needs no spaces before when it is
2029 # terminating a case value or a label.
2030 } elsif ($opv eq ':C' || $opv eq ':L') {
2031 if ($ctx =~ /Wx./) {
2032 ERROR("space prohibited before that '$op' $at\n" . $hereptr);
2033 }
2034
2035 # All the others need spaces both sides.
2036 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2037 my $ok = 0;
2038
2039 if ($realfile =~ /\.cpp|\.h$/) {
2040 # Ignore template arguments <...> in C++
2041 if (($op eq '<' || $op eq '>') && $line =~ /<.*>/) {
2042 $ok = 1;
2043 }
2044
2045 # Ignore :: in C++
2046 if ($op eq '::') {
2047 $ok = 1;
2048 }
2049 }
2050
2051 # Ignore email addresses <foo@bar>
2052 if (($op eq '<' &&
2053 $cc =~ /^\S+\@\S+>/) ||
2054 ($op eq '>' &&
2055 $ca =~ /<\S+\@\S+$/))
2056 {
2057 $ok = 1;
2058 }
2059
2060 # Ignore ?:
2061 if (($opv eq ':O' && $ca =~ /\?$/) ||
2062 ($op eq '?' && $cc =~ /^:/)) {
2063 $ok = 1;
2064 }
2065
2066 if ($ok == 0) {
2067 ERROR("spaces required around that '$op' $at\n" . $hereptr);
2068 }
2069 }
2070 $off += length($elements[$n + 1]);
2071 }
2072 }
2073
2074 #need space before brace following if, while, etc
2075 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) ||
2076 $line =~ /do\{/) {
2077 ERROR("space required before the open brace '{'\n" . $herecurr);
2078 }
2079
2080 # closing brace should have a space following it when it has anything
2081 # on the line
2082 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2083 ERROR("space required after that close brace '}'\n" . $herecurr);
2084 }
2085
2086 # check spacing on square brackets
2087 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2088 ERROR("space prohibited after that open square bracket '['\n" . $herecurr);
2089 }
2090 if ($line =~ /\s\]/) {
2091 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr);
2092 }
2093
2094 # check spacing on parentheses
2095 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2096 $line !~ /for\s*\(\s+;/) {
2097 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr);
2098 }
2099 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2100 $line !~ /for\s*\(.*;\s+\)/ &&
2101 $line !~ /:\s+\)/) {
2102 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr);
2103 }
2104
2105 # Return is not a function.
2106 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2107 my $spacing = $1;
2108 my $value = $2;
2109
2110 # Flatten any parentheses
2111 $value =~ s/\(/ \(/g;
2112 $value =~ s/\)/\) /g;
2113 while ($value =~ s/\[[^\{\}]*\]/1/ ||
2114 $value !~ /(?:$Ident|-?$Constant)\s*
2115 $Compare\s*
2116 (?:$Ident|-?$Constant)/x &&
2117 $value =~ s/\([^\(\)]*\)/1/) {
2118 }
2119 #print "value<$value>\n";
2120 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2121 ERROR("return is not a function, parentheses are not required\n" . $herecurr);
2122
2123 } elsif ($spacing !~ /\s+/) {
2124 ERROR("space required before the open parenthesis '('\n" . $herecurr);
2125 }
2126 }
2127 # Return of what appears to be an errno should normally be -'ve
2128 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2129 my $name = $1;
2130 if ($name ne 'EOF' && $name ne 'ERROR') {
2131 ERROR("return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2132 }
2133 }
2134
2135 # Need a space before open parenthesis after if, while etc
2136 if ($line=~/\b(if|while|for|switch)\(/) {
2137 ERROR("space required before the open parenthesis '('\n" . $herecurr);
2138 }
2139
2140 # Check for illegal assignment in if conditional -- and check for trailing
2141 # statements after the conditional.
2142 if ($line =~ /do\s*(?!{)/) {
2143 my ($stat_next) = ctx_statement_block($line_nr_next,
2144 $remain_next, $off_next);
2145 $stat_next =~ s/\n./\n /g;
2146 ##print "stat<$stat> stat_next<$stat_next>\n";
2147
2148 if ($stat_next =~ /^\s*while\b/) {
2149 # If the statement carries leading newlines,
2150 # then count those as offsets.
2151 my ($whitespace) =
2152 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2153 my $offset =
2154 statement_rawlines($whitespace) - 1;
2155
2156 $suppress_whiletrailers{$line_nr_next +
2157 $offset} = 1;
2158 }
2159 }
2160 if (!defined $suppress_whiletrailers{$linenr} &&
2161 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2162 my ($s, $c) = ($stat, $cond);
2163
2164 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2165 ERROR("do not use assignment in if condition\n" . $herecurr);
2166 }
2167
2168 # Find out what is on the end of the line after the
2169 # conditional.
2170 substr($s, 0, length($c), '');
2171 $s =~ s/\n.*//g;
2172 $s =~ s/$;//g; # Remove any comments
2173 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2174 $c !~ /}\s*while\s*/)
2175 {
2176 # Find out how long the conditional actually is.
2177 my @newlines = ($c =~ /\n/gs);
2178 my $cond_lines = 1 + $#newlines;
2179 my $stat_real = '';
2180
2181 $stat_real = raw_line($linenr, $cond_lines)
2182 . "\n" if ($cond_lines);
2183 if (defined($stat_real) && $cond_lines > 1) {
2184 $stat_real = "[...]\n$stat_real";
2185 }
2186
2187 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real);
2188 }
2189 }
2190
2191 # Check for bitwise tests written as boolean
2192 if ($line =~ /
2193 (?:
2194 (?:\[|\(|\&\&|\|\|)
2195 \s*0[xX][0-9]+\s*
2196 (?:\&\&|\|\|)
2197 |
2198 (?:\&\&|\|\|)
2199 \s*0[xX][0-9]+\s*
2200 (?:\&\&|\|\||\)|\])
2201 )/x)
2202 {
2203 ERROR("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2204 }
2205
2206 # if and else should not have general statements after it
2207 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2208 my $s = $1;
2209 $s =~ s/$;//g; # Remove any comments
2210 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2211 ERROR("trailing statements should be on next line\n" . $herecurr);
2212 }
2213 }
2214 # if should not continue a brace
2215 if ($line =~ /}\s*if\b/) {
2216 ERROR("trailing statements should be on next line\n" .
2217 $herecurr);
2218 }
2219 # case and default should not have general statements after them
2220 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2221 $line !~ /\G(?:
2222 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2223 \s*return\s+
2224 )/xg)
2225 {
2226 ERROR("trailing statements should be on next line\n" . $herecurr);
2227 }
2228
2229 # Check for }<nl>else {, these must be at the same
2230 # indent level to be relevant to each other.
2231 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2232 $previndent == $indent) {
2233 ERROR("else should follow close brace '}'\n" . $hereprev);
2234 }
2235
2236 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2237 $previndent == $indent) {
2238 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2239
2240 # Find out what is on the end of the line after the
2241 # conditional.
2242 substr($s, 0, length($c), '');
2243 $s =~ s/\n.*//g;
2244
2245 if ($s =~ /^\s*;/) {
2246 ERROR("while should follow close brace '}'\n" . $hereprev);
2247 }
2248 }
2249
2250 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2251 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2252 # print "No studly caps, use _\n";
2253 # print "$herecurr";
2254 # $clean = 0;
2255 # }
2256
2257 #no spaces allowed after \ in define
2258 if ($line=~/\#\s*define.*\\\s$/) {
2259 ERROR("Whitespace after \\ makes next lines useless\n" . $herecurr);
2260 }
2261
2262 # multi-statement macros should be enclosed in a do while loop, grab the
2263 # first statement and ensure its the whole macro if its not enclosed
2264 # in a known good container
2265 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2266 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2267 my $ln = $linenr;
2268 my $cnt = $realcnt;
2269 my ($off, $dstat, $dcond, $rest);
2270 my $ctx = '';
2271
2272 my $args = defined($1);
2273
2274 # Find the end of the macro and limit our statement
2275 # search to that.
2276 while ($cnt > 0 && defined $lines[$ln - 1] &&
2277 $lines[$ln - 1] =~ /^(?:-|..*\\$)/)
2278 {
2279 $ctx .= $rawlines[$ln - 1] . "\n";
2280 $cnt-- if ($lines[$ln - 1] !~ /^-/);
2281 $ln++;
2282 }
2283 $ctx .= $rawlines[$ln - 1];
2284
2285 ($dstat, $dcond, $ln, $cnt, $off) =
2286 ctx_statement_block($linenr, $ln - $linenr + 1, 0);
2287 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2288 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2289
2290 # Extract the remainder of the define (if any) and
2291 # rip off surrounding spaces, and trailing \'s.
2292 $rest = '';
2293 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) {
2294 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n";
2295 if ($off != 0 || $lines[$ln - 1] !~ /^-/) {
2296 $rest .= substr($lines[$ln - 1], $off) . "\n";
2297 $cnt--;
2298 }
2299 $ln++;
2300 $off = 0;
2301 }
2302 $rest =~ s/\\\n.//g;
2303 $rest =~ s/^\s*//s;
2304 $rest =~ s/\s*$//s;
2305
2306 # Clean up the original statement.
2307 if ($args) {
2308 substr($dstat, 0, length($dcond), '');
2309 } else {
2310 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//;
2311 }
2312 $dstat =~ s/$;//g;
2313 $dstat =~ s/\\\n.//g;
2314 $dstat =~ s/^\s*//s;
2315 $dstat =~ s/\s*$//s;
2316
2317 # Flatten any parentheses and braces
2318 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2319 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2320 $dstat =~ s/\[[^\{\}]*\]/1/)
2321 {
2322 }
2323
2324 my $exceptions = qr{
2325 $Declare|
2326 module_param_named|
2327 MODULE_PARAM_DESC|
2328 DECLARE_PER_CPU|
2329 DEFINE_PER_CPU|
2330 __typeof__\(|
2331 union|
2332 struct|
2333 \.$Ident\s*=\s*|
2334 ^\"|\"$
2335 }x;
2336 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2337 if ($rest ne '' && $rest ne ',') {
2338 if ($rest !~ /while\s*\(/ &&
2339 $dstat !~ /$exceptions/)
2340 {
2341 ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n");
2342 }
2343
2344 } elsif ($ctx !~ /;/) {
2345 if ($dstat ne '' &&
2346 $dstat !~ /^(?:$Ident|-?$Constant)$/ &&
2347 $dstat !~ /$exceptions/ &&
2348 $dstat !~ /^\.$Ident\s*=/ &&
2349 $dstat =~ /$Operators/)
2350 {
2351 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n");
2352 }
2353 }
2354 }
2355
2356 # check for missing bracing around if etc
2357 if ($line =~ /(^.*)\b(?:if|while|for)\b/ &&
2358 $line !~ /\#\s*if/) {
2359 my $allowed = 0;
2360
2361 # Check the pre-context.
2362 if ($line =~ /(\}.*?)$/) {
2363 my $pre = $1;
2364
2365 if ($line !~ /else/) {
2366 print "APW: ALLOWED: pre<$pre> line<$line>\n"
2367 if $dbg_adv_apw;
2368 $allowed = 1;
2369 }
2370 }
2371 my ($level, $endln, @chunks) =
2372 ctx_statement_full($linenr, $realcnt, 1);
2373 if ($dbg_adv_apw) {
2374 print "APW: chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2375 print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"
2376 if $#chunks >= 1;
2377 }
2378 if ($#chunks >= 0 && $level == 0) {
2379 my $seen = 0;
2380 my $herectx = $here . "\n";
2381 my $ln = $linenr - 1;
2382 for my $chunk (@chunks) {
2383 my ($cond, $block) = @{$chunk};
2384
2385 # If the condition carries leading newlines, then count those as offsets.
2386 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
2387 my $offset = statement_rawlines($whitespace) - 1;
2388
2389 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
2390
2391 # We have looked at and allowed this specific line.
2392 $suppress_ifbraces{$ln + $offset} = 1;
2393
2394 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
2395 $ln += statement_rawlines($block) - 1;
2396
2397 substr($block, 0, length($cond), '');
2398
2399 my $spaced_block = $block;
2400 $spaced_block =~ s/\n\+/ /g;
2401
2402 $seen++ if ($spaced_block =~ /^\s*\{/);
2403
2404 print "APW: cond<$cond> block<$block> allowed<$allowed>\n"
2405 if $dbg_adv_apw;
2406 if (statement_lines($cond) > 1) {
2407 print "APW: ALLOWED: cond<$cond>\n"
2408 if $dbg_adv_apw;
2409 $allowed = 1;
2410 }
2411 if ($block =~/\b(?:if|for|while)\b/) {
2412 print "APW: ALLOWED: block<$block>\n"
2413 if $dbg_adv_apw;
2414 $allowed = 1;
2415 }
2416 if (statement_block_size($block) > 1) {
2417 print "APW: ALLOWED: lines block<$block>\n"
2418 if $dbg_adv_apw;
2419 $allowed = 1;
2420 }
2421 }
2422 if ($seen != ($#chunks + 1) && !$allowed) {
2423 ERROR("braces {} are necessary for all arms of this statement\n" . $herectx);
2424 }
2425 }
2426 }
2427 if (!defined $suppress_ifbraces{$linenr - 1} &&
2428 $line =~ /\b(if|while|for|else)\b/ &&
2429 $line !~ /\#\s*if/ &&
2430 $line !~ /\#\s*else/) {
2431 my $allowed = 0;
2432
2433 # Check the pre-context.
2434 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
2435 my $pre = $1;
2436
2437 if ($line !~ /else/) {
2438 print "APW: ALLOWED: pre<$pre> line<$line>\n"
2439 if $dbg_adv_apw;
2440 $allowed = 1;
2441 }
2442 }
2443
2444 my ($level, $endln, @chunks) =
2445 ctx_statement_full($linenr, $realcnt, $-[0]);
2446
2447 # Check the condition.
2448 my ($cond, $block) = @{$chunks[0]};
2449 print "CHECKING<$linenr> cond<$cond> block<$block>\n"
2450 if $dbg_adv_checking;
2451 if (defined $cond) {
2452 substr($block, 0, length($cond), '');
2453 }
2454 if (statement_lines($cond) > 1) {
2455 print "APW: ALLOWED: cond<$cond>\n"
2456 if $dbg_adv_apw;
2457 $allowed = 1;
2458 }
2459 if ($block =~/\b(?:if|for|while)\b/) {
2460 print "APW: ALLOWED: block<$block>\n"
2461 if $dbg_adv_apw;
2462 $allowed = 1;
2463 }
2464 if (statement_block_size($block) > 1) {
2465 print "APW: ALLOWED: lines block<$block>\n"
2466 if $dbg_adv_apw;
2467 $allowed = 1;
2468 }
2469 # Check the post-context.
2470 if (defined $chunks[1]) {
2471 my ($cond, $block) = @{$chunks[1]};
2472 if (defined $cond) {
2473 substr($block, 0, length($cond), '');
2474 }
2475 if ($block =~ /^\s*\{/) {
2476 print "APW: ALLOWED: chunk-1 block<$block>\n"
2477 if $dbg_adv_apw;
2478 $allowed = 1;
2479 }
2480 }
2481 print "DCS: level=$level block<$block> allowed=$allowed\n"
2482 if $dbg_adv_dcs;
2483 if ($level == 0 && $block !~ /^\s*\{/ && !$allowed) {
2484 my $herectx = $here . "\n";;
2485 my $cnt = statement_rawlines($block);
2486
2487 for (my $n = 0; $n < $cnt; $n++) {
2488 $herectx .= raw_line($linenr, $n) . "\n";;
2489 }
2490
2491 ERROR("braces {} are necessary even for single statement blocks\n" . $herectx);
2492 }
2493 }
2494
2495 # no volatiles please
2496 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
2497 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/ &&
2498 $line !~ /sig_atomic_t/ &&
2499 !ctx_has_comment($first_line, $linenr)) {
2500 my $msg = "Use of volatile is usually wrong, please add a comment\n" . $herecurr;
2501 ERROR($msg);
2502 }
2503
2504 # warn about #if 0
2505 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
2506 ERROR("if this code is redundant consider removing it\n" .
2507 $herecurr);
2508 }
2509
2510 # check for needless g_free() checks
2511 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
2512 my $expr = $1;
2513 if ($line =~ /\bg_free\(\Q$expr\E\);/) {
2514 ERROR("g_free(NULL) is safe this check is probably not required\n" . $hereprev);
2515 }
2516 }
2517
2518 # warn about #ifdefs in C files
2519 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
2520 # print "#ifdef in C files should be avoided\n";
2521 # print "$herecurr";
2522 # $clean = 0;
2523 # }
2524
2525 # warn about spacing in #ifdefs
2526 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
2527 ERROR("exactly one space required after that #$1\n" . $herecurr);
2528 }
2529 # check for memory barriers without a comment.
2530 if ($line =~ /\b(smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
2531 if (!ctx_has_comment($first_line, $linenr)) {
2532 ERROR("memory barrier without comment\n" . $herecurr);
2533 }
2534 }
2535 # check of hardware specific defines
2536 # we have e.g. CONFIG_LINUX and CONFIG_WIN32 for common cases
2537 # where they might be necessary.
2538 if ($line =~ m@^.\s*\#\s*if.*\b__@) {
2539 WARN("architecture specific defines should be avoided\n" . $herecurr);
2540 }
2541
2542 # Check that the storage class is at the beginning of a declaration
2543 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
2544 ERROR("storage class should be at the beginning of the declaration\n" . $herecurr)
2545 }
2546
2547 # check the location of the inline attribute, that it is between
2548 # storage class and type.
2549 if ($line =~ /\b$Type\s+$Inline\b/ ||
2550 $line =~ /\b$Inline\s+$Storage\b/) {
2551 ERROR("inline keyword should sit between storage class and type\n" . $herecurr);
2552 }
2553
2554 # check for sizeof(&)
2555 if ($line =~ /\bsizeof\s*\(\s*\&/) {
2556 ERROR("sizeof(& should be avoided\n" . $herecurr);
2557 }
2558
2559 # check for new externs in .c files.
2560 if ($realfile =~ /\.c$/ && defined $stat &&
2561 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
2562 {
2563 my $function_name = $1;
2564 my $paren_space = $2;
2565
2566 my $s = $stat;
2567 if (defined $cond) {
2568 substr($s, 0, length($cond), '');
2569 }
2570 if ($s =~ /^\s*;/ &&
2571 $function_name ne 'uninitialized_var')
2572 {
2573 ERROR("externs should be avoided in .c files\n" . $herecurr);
2574 }
2575
2576 if ($paren_space =~ /\n/) {
2577 ERROR("arguments for function declarations should follow identifier\n" . $herecurr);
2578 }
2579
2580 } elsif ($realfile =~ /\.c$/ && defined $stat &&
2581 $stat =~ /^.\s*extern\s+/)
2582 {
2583 ERROR("externs should be avoided in .c files\n" . $herecurr);
2584 }
2585
2586 # check for pointless casting of g_malloc return
2587 if ($line =~ /\*\s*\)\s*g_(try)?(m|re)alloc(0?)(_n)?\b/) {
2588 if ($2 == 'm') {
2589 ERROR("unnecessary cast may hide bugs, use g_$1new$3 instead\n" . $herecurr);
2590 } else {
2591 ERROR("unnecessary cast may hide bugs, use g_$1renew$3 instead\n" . $herecurr);
2592 }
2593 }
2594
2595 # check for gcc specific __FUNCTION__
2596 if ($line =~ /__FUNCTION__/) {
2597 ERROR("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
2598 }
2599
2600 # recommend g_path_get_* over g_strdup(basename/dirname(...))
2601 if ($line =~ /\bg_strdup\s*\(\s*(basename|dirname)\s*\(/) {
2602 WARN("consider using g_path_get_$1() in preference to g_strdup($1())\n" . $herecurr);
2603 }
2604
2605 # recommend qemu_strto* over strto* for numeric conversions
2606 if ($line =~ /\b(strto[^kd].*?)\s*\(/) {
2607 ERROR("consider using qemu_$1 in preference to $1\n" . $herecurr);
2608 }
2609 # recommend sigaction over signal for portability, when establishing a handler
2610 if ($line =~ /\bsignal\s*\(/ && !($line =~ /SIG_(?:IGN|DFL)/)) {
2611 ERROR("use sigaction to establish signal handlers; signal is not portable\n" . $herecurr);
2612 }
2613 # check for module_init(), use category-specific init macros explicitly please
2614 if ($line =~ /^module_init\s*\(/) {
2615 ERROR("please use block_init(), type_init() etc. instead of module_init()\n" . $herecurr);
2616 }
2617 # check for various ops structs, ensure they are const.
2618 my $struct_ops = qr{AIOCBInfo|
2619 BdrvActionOps|
2620 BlockDevOps|
2621 BlockJobDriver|
2622 DisplayChangeListenerOps|
2623 GraphicHwOps|
2624 IDEDMAOps|
2625 KVMCapabilityInfo|
2626 MemoryRegionIOMMUOps|
2627 MemoryRegionOps|
2628 MemoryRegionPortio|
2629 QEMUFileOps|
2630 SCSIBusInfo|
2631 SCSIReqOps|
2632 Spice[A-Z][a-zA-Z0-9]*Interface|
2633 USBDesc[A-Z][a-zA-Z0-9]*|
2634 VhostOps|
2635 VMStateDescription|
2636 VMStateInfo}x;
2637 if ($line !~ /\bconst\b/ &&
2638 $line =~ /\b($struct_ops)\b.*=/) {
2639 ERROR("initializer for struct $1 should normally be const\n" .
2640 $herecurr);
2641 }
2642
2643 # check for %L{u,d,i} in strings
2644 my $string;
2645 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
2646 $string = substr($rawline, $-[1], $+[1] - $-[1]);
2647 $string =~ s/%%/__/g;
2648 if ($string =~ /(?<!%)%L[udi]/) {
2649 ERROR("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
2650 last;
2651 }
2652 }
2653
2654 # QEMU specific tests
2655 if ($rawline =~ /\b(?:Qemu|QEmu)\b/) {
2656 ERROR("use QEMU instead of Qemu or QEmu\n" . $herecurr);
2657 }
2658
2659 # Qemu error function tests
2660
2661 # Find newlines in error messages
2662 my $qemu_error_funcs = qr{error_setg|
2663 error_setg_errno|
2664 error_setg_win32|
2665 error_setg_file_open|
2666 error_set|
2667 error_prepend|
2668 warn_reportf_err|
2669 error_reportf_err|
2670 error_vreport|
2671 warn_vreport|
2672 info_vreport|
2673 error_report|
2674 warn_report|
2675 info_report}x;
2676
2677 if ($rawline =~ /\b(?:$qemu_error_funcs)\s*\(.*\".*\\n/) {
2678 ERROR("Error messages should not contain newlines\n" . $herecurr);
2679 }
2680
2681 # Continue checking for error messages that contains newlines. This
2682 # check handles cases where string literals are spread over multiple lines.
2683 # Example:
2684 # error_report("Error msg line #1"
2685 # "Error msg line #2\n");
2686 my $quoted_newline_regex = qr{\+\s*\".*\\n.*\"};
2687 my $continued_str_literal = qr{\+\s*\".*\"};
2688
2689 if ($rawline =~ /$quoted_newline_regex/) {
2690 # Backtrack to first line that does not contain only a quoted literal
2691 # and assume that it is the start of the statement.
2692 my $i = $linenr - 2;
2693
2694 while (($i >= 0) & $rawlines[$i] =~ /$continued_str_literal/) {
2695 $i--;
2696 }
2697
2698 if ($rawlines[$i] =~ /\b(?:$qemu_error_funcs)\s*\(/) {
2699 ERROR("Error messages should not contain newlines\n" . $herecurr);
2700 }
2701 }
2702
2703 # check for non-portable libc calls that have portable alternatives in QEMU
2704 if ($line =~ /\bffs\(/) {
2705 ERROR("use ctz32() instead of ffs()\n" . $herecurr);
2706 }
2707 if ($line =~ /\bffsl\(/) {
2708 ERROR("use ctz32() or ctz64() instead of ffsl()\n" . $herecurr);
2709 }
2710 if ($line =~ /\bffsll\(/) {
2711 ERROR("use ctz64() instead of ffsll()\n" . $herecurr);
2712 }
2713 if ($line =~ /\bbzero\(/) {
2714 ERROR("use memset() instead of bzero()\n" . $herecurr);
2715 }
2716 my $non_exit_glib_asserts = qr{g_assert_cmpstr|
2717 g_assert_cmpint|
2718 g_assert_cmpuint|
2719 g_assert_cmphex|
2720 g_assert_cmpfloat|
2721 g_assert_true|
2722 g_assert_false|
2723 g_assert_nonnull|
2724 g_assert_null|
2725 g_assert_no_error|
2726 g_assert_error|
2727 g_test_assert_expected_messages|
2728 g_test_trap_assert_passed|
2729 g_test_trap_assert_stdout|
2730 g_test_trap_assert_stdout_unmatched|
2731 g_test_trap_assert_stderr|
2732 g_test_trap_assert_stderr_unmatched}x;
2733 if ($realfile !~ /^tests\// &&
2734 $line =~ /\b(?:$non_exit_glib_asserts)\(/) {
2735 ERROR("Use g_assert or g_assert_not_reached\n". $herecurr);
2736 }
2737 }
2738
2739 # If we have no input at all, then there is nothing to report on
2740 # so just keep quiet.
2741 if ($#rawlines == -1) {
2742 exit(0);
2743 }
2744
2745 # In mailback mode only produce a report in the negative, for
2746 # things that appear to be patches.
2747 if ($mailback && ($clean == 1 || !$is_patch)) {
2748 exit(0);
2749 }
2750
2751 # This is not a patch, and we are are in 'no-patch' mode so
2752 # just keep quiet.
2753 if (!$chk_patch && !$is_patch) {
2754 exit(0);
2755 }
2756
2757 if (!$is_patch) {
2758 ERROR("Does not appear to be a unified-diff format patch\n");
2759 }
2760 if ($is_patch && $chk_signoff && $signoff == 0) {
2761 ERROR("Missing Signed-off-by: line(s)\n");
2762 }
2763
2764 print report_dump();
2765 if ($summary && !($clean == 1 && $quiet == 1)) {
2766 print "$filename " if ($summary_file);
2767 print "total: $cnt_error errors, $cnt_warn warnings, " .
2768 "$cnt_lines lines checked\n";
2769 print "\n" if ($quiet == 0);
2770 }
2771
2772 if ($quiet == 0) {
2773 # If there were whitespace errors which cleanpatch can fix
2774 # then suggest that.
2775 # if ($rpt_cleaners) {
2776 # print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
2777 # print " scripts/cleanfile\n\n";
2778 # }
2779 }
2780
2781 if ($clean == 1 && $quiet == 0) {
2782 print "$vname has no obvious style problems and is ready for submission.\n"
2783 }
2784 if ($clean == 0 && $quiet == 0) {
2785 print "$vname has style problems, please review. If any of these errors\n";
2786 print "are false positives report them to the maintainer, see\n";
2787 print "CHECKPATCH in MAINTAINERS.\n";
2788 }
2789
2790 return ($no_warnings ? $clean : $cnt_error == 0);
2791 }
QEMU mirror