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