checkpatch: suggest pr_<level> over printk(KERN_<LEVEL>
[linux-2.6/libata-dev.git] / scripts / checkpatch.pl
blobe5bd60ff48e3d553ef3921256123519df7b812b8
1 #!/usr/bin/perl -w
2 # (c) 2001, Dave Jones. (the file handling bit)
3 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6 # Licensed under the terms of the GNU GPL License version 2
8 use strict;
10 my $P = $0;
11 $P =~ s@.*/@@g;
13 my $V = '0.32';
15 use Getopt::Long qw(:config no_auto_abbrev);
17 my $quiet = 0;
18 my $tree = 1;
19 my $chk_signoff = 1;
20 my $chk_patch = 1;
21 my $tst_only;
22 my $emacs = 0;
23 my $terse = 0;
24 my $file = 0;
25 my $check = 0;
26 my $summary = 1;
27 my $mailback = 0;
28 my $summary_file = 0;
29 my $show_types = 0;
30 my $root;
31 my %debug;
32 my %ignore_type = ();
33 my @ignore = ();
34 my $help = 0;
35 my $configuration_file = ".checkpatch.conf";
37 sub help {
38 my ($exitcode) = @_;
40 print << "EOM";
41 Usage: $P [OPTION]... [FILE]...
42 Version: $V
44 Options:
45 -q, --quiet quiet
46 --no-tree run without a kernel tree
47 --no-signoff do not check for 'Signed-off-by' line
48 --patch treat FILE as patchfile (default)
49 --emacs emacs compile window format
50 --terse one line per report
51 -f, --file treat FILE as regular source file
52 --subjective, --strict enable more subjective tests
53 --ignore TYPE(,TYPE2...) ignore various comma separated message types
54 --show-types show the message "types" in the output
55 --root=PATH PATH to the kernel tree root
56 --no-summary suppress the per-file summary
57 --mailback only produce a report in case of warnings/errors
58 --summary-file include the filename in summary
59 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
60 'values', 'possible', 'type', and 'attr' (default
61 is all off)
62 --test-only=WORD report only warnings/errors containing WORD
63 literally
64 -h, --help, --version display this help and exit
66 When FILE is - read standard input.
67 EOM
69 exit($exitcode);
72 my $conf = which_conf($configuration_file);
73 if (-f $conf) {
74 my @conf_args;
75 open(my $conffile, '<', "$conf")
76 or warn "$P: Can't find a readable $configuration_file file $!\n";
78 while (<$conffile>) {
79 my $line = $_;
81 $line =~ s/\s*\n?$//g;
82 $line =~ s/^\s*//g;
83 $line =~ s/\s+/ /g;
85 next if ($line =~ m/^\s*#/);
86 next if ($line =~ m/^\s*$/);
88 my @words = split(" ", $line);
89 foreach my $word (@words) {
90 last if ($word =~ m/^#/);
91 push (@conf_args, $word);
94 close($conffile);
95 unshift(@ARGV, @conf_args) if @conf_args;
98 GetOptions(
99 'q|quiet+' => \$quiet,
100 'tree!' => \$tree,
101 'signoff!' => \$chk_signoff,
102 'patch!' => \$chk_patch,
103 'emacs!' => \$emacs,
104 'terse!' => \$terse,
105 'f|file!' => \$file,
106 'subjective!' => \$check,
107 'strict!' => \$check,
108 'ignore=s' => \@ignore,
109 'show-types!' => \$show_types,
110 'root=s' => \$root,
111 'summary!' => \$summary,
112 'mailback!' => \$mailback,
113 'summary-file!' => \$summary_file,
115 'debug=s' => \%debug,
116 'test-only=s' => \$tst_only,
117 'h|help' => \$help,
118 'version' => \$help
119 ) or help(1);
121 help(0) if ($help);
123 my $exit = 0;
125 if ($#ARGV < 0) {
126 print "$P: no input files\n";
127 exit(1);
130 @ignore = split(/,/, join(',',@ignore));
131 foreach my $word (@ignore) {
132 $word =~ s/\s*\n?$//g;
133 $word =~ s/^\s*//g;
134 $word =~ s/\s+/ /g;
135 $word =~ tr/[a-z]/[A-Z]/;
137 next if ($word =~ m/^\s*#/);
138 next if ($word =~ m/^\s*$/);
140 $ignore_type{$word}++;
143 my $dbg_values = 0;
144 my $dbg_possible = 0;
145 my $dbg_type = 0;
146 my $dbg_attr = 0;
147 for my $key (keys %debug) {
148 ## no critic
149 eval "\${dbg_$key} = '$debug{$key}';";
150 die "$@" if ($@);
153 my $rpt_cleaners = 0;
155 if ($terse) {
156 $emacs = 1;
157 $quiet++;
160 if ($tree) {
161 if (defined $root) {
162 if (!top_of_kernel_tree($root)) {
163 die "$P: $root: --root does not point at a valid tree\n";
165 } else {
166 if (top_of_kernel_tree('.')) {
167 $root = '.';
168 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
169 top_of_kernel_tree($1)) {
170 $root = $1;
174 if (!defined $root) {
175 print "Must be run from the top-level dir. of a kernel tree\n";
176 exit(2);
180 my $emitted_corrupt = 0;
182 our $Ident = qr{
183 [A-Za-z_][A-Za-z\d_]*
184 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
186 our $Storage = qr{extern|static|asmlinkage};
187 our $Sparse = qr{
188 __user|
189 __kernel|
190 __force|
191 __iomem|
192 __must_check|
193 __init_refok|
194 __kprobes|
195 __ref|
196 __rcu
199 # Notes to $Attribute:
200 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
201 our $Attribute = qr{
202 const|
203 __percpu|
204 __nocast|
205 __safe|
206 __bitwise__|
207 __packed__|
208 __packed2__|
209 __naked|
210 __maybe_unused|
211 __always_unused|
212 __noreturn|
213 __used|
214 __cold|
215 __noclone|
216 __deprecated|
217 __read_mostly|
218 __kprobes|
219 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
220 ____cacheline_aligned|
221 ____cacheline_aligned_in_smp|
222 ____cacheline_internodealigned_in_smp|
223 __weak
225 our $Modifier;
226 our $Inline = qr{inline|__always_inline|noinline};
227 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
228 our $Lval = qr{$Ident(?:$Member)*};
230 our $Constant = qr{(?i:(?:[0-9]+|0x[0-9a-f]+)[ul]*)};
231 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
232 our $Compare = qr{<=|>=|==|!=|<|>};
233 our $Operators = qr{
234 <=|>=|==|!=|
235 =>|->|<<|>>|<|>|!|~|
236 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
239 our $NonptrType;
240 our $Type;
241 our $Declare;
243 our $NON_ASCII_UTF8 = qr{
244 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
245 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
246 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
247 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
248 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
249 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
250 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
253 our $UTF8 = qr{
254 [\x09\x0A\x0D\x20-\x7E] # ASCII
255 | $NON_ASCII_UTF8
258 our $typeTypedefs = qr{(?x:
259 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
260 atomic_t
263 our $logFunctions = qr{(?x:
264 printk(?:_ratelimited|_once|)|
265 [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
266 WARN(?:_RATELIMIT|_ONCE|)|
267 panic|
268 MODULE_[A-Z_]+
271 our $signature_tags = qr{(?xi:
272 Signed-off-by:|
273 Acked-by:|
274 Tested-by:|
275 Reviewed-by:|
276 Reported-by:|
277 To:|
281 our @typeList = (
282 qr{void},
283 qr{(?:unsigned\s+)?char},
284 qr{(?:unsigned\s+)?short},
285 qr{(?:unsigned\s+)?int},
286 qr{(?:unsigned\s+)?long},
287 qr{(?:unsigned\s+)?long\s+int},
288 qr{(?:unsigned\s+)?long\s+long},
289 qr{(?:unsigned\s+)?long\s+long\s+int},
290 qr{unsigned},
291 qr{float},
292 qr{double},
293 qr{bool},
294 qr{struct\s+$Ident},
295 qr{union\s+$Ident},
296 qr{enum\s+$Ident},
297 qr{${Ident}_t},
298 qr{${Ident}_handler},
299 qr{${Ident}_handler_fn},
301 our @modifierList = (
302 qr{fastcall},
305 our $allowed_asm_includes = qr{(?x:
306 irq|
307 memory
309 # memory.h: ARM has a custom one
311 sub build_types {
312 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
313 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
314 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
315 $NonptrType = qr{
316 (?:$Modifier\s+|const\s+)*
318 (?:typeof|__typeof__)\s*\([^\)]*\)|
319 (?:$typeTypedefs\b)|
320 (?:${all}\b)
322 (?:\s+$Modifier|\s+const)*
324 $Type = qr{
325 $NonptrType
326 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*|\[\])+|(?:\s*\[\s*\])+)?
327 (?:\s+$Inline|\s+$Modifier)*
329 $Declare = qr{(?:$Storage\s+)?$Type};
331 build_types();
334 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
336 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
337 # requires at least perl version v5.10.0
338 # Any use must be runtime checked with $^V
340 our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/;
341 our $LvalOrFunc = qr{($Lval)\s*($balanced_parens{0,1})\s*};
342 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
344 sub deparenthesize {
345 my ($string) = @_;
346 return "" if (!defined($string));
347 $string =~ s@^\s*\(\s*@@g;
348 $string =~ s@\s*\)\s*$@@g;
349 $string =~ s@\s+@ @g;
350 return $string;
353 $chk_signoff = 0 if ($file);
355 my @dep_includes = ();
356 my @dep_functions = ();
357 my $removal = "Documentation/feature-removal-schedule.txt";
358 if ($tree && -f "$root/$removal") {
359 open(my $REMOVE, '<', "$root/$removal") ||
360 die "$P: $removal: open failed - $!\n";
361 while (<$REMOVE>) {
362 if (/^Check:\s+(.*\S)/) {
363 for my $entry (split(/[, ]+/, $1)) {
364 if ($entry =~ m@include/(.*)@) {
365 push(@dep_includes, $1);
367 } elsif ($entry !~ m@/@) {
368 push(@dep_functions, $entry);
373 close($REMOVE);
376 my @rawlines = ();
377 my @lines = ();
378 my $vname;
379 for my $filename (@ARGV) {
380 my $FILE;
381 if ($file) {
382 open($FILE, '-|', "diff -u /dev/null $filename") ||
383 die "$P: $filename: diff failed - $!\n";
384 } elsif ($filename eq '-') {
385 open($FILE, '<&STDIN');
386 } else {
387 open($FILE, '<', "$filename") ||
388 die "$P: $filename: open failed - $!\n";
390 if ($filename eq '-') {
391 $vname = 'Your patch';
392 } else {
393 $vname = $filename;
395 while (<$FILE>) {
396 chomp;
397 push(@rawlines, $_);
399 close($FILE);
400 if (!process($filename)) {
401 $exit = 1;
403 @rawlines = ();
404 @lines = ();
407 exit($exit);
409 sub top_of_kernel_tree {
410 my ($root) = @_;
412 my @tree_check = (
413 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
414 "README", "Documentation", "arch", "include", "drivers",
415 "fs", "init", "ipc", "kernel", "lib", "scripts",
418 foreach my $check (@tree_check) {
419 if (! -e $root . '/' . $check) {
420 return 0;
423 return 1;
426 sub parse_email {
427 my ($formatted_email) = @_;
429 my $name = "";
430 my $address = "";
431 my $comment = "";
433 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
434 $name = $1;
435 $address = $2;
436 $comment = $3 if defined $3;
437 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
438 $address = $1;
439 $comment = $2 if defined $2;
440 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
441 $address = $1;
442 $comment = $2 if defined $2;
443 $formatted_email =~ s/$address.*$//;
444 $name = $formatted_email;
445 $name =~ s/^\s+|\s+$//g;
446 $name =~ s/^\"|\"$//g;
447 # If there's a name left after stripping spaces and
448 # leading quotes, and the address doesn't have both
449 # leading and trailing angle brackets, the address
450 # is invalid. ie:
451 # "joe smith joe@smith.com" bad
452 # "joe smith <joe@smith.com" bad
453 if ($name ne "" && $address !~ /^<[^>]+>$/) {
454 $name = "";
455 $address = "";
456 $comment = "";
460 $name =~ s/^\s+|\s+$//g;
461 $name =~ s/^\"|\"$//g;
462 $address =~ s/^\s+|\s+$//g;
463 $address =~ s/^\<|\>$//g;
465 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
466 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
467 $name = "\"$name\"";
470 return ($name, $address, $comment);
473 sub format_email {
474 my ($name, $address) = @_;
476 my $formatted_email;
478 $name =~ s/^\s+|\s+$//g;
479 $name =~ s/^\"|\"$//g;
480 $address =~ s/^\s+|\s+$//g;
482 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
483 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
484 $name = "\"$name\"";
487 if ("$name" eq "") {
488 $formatted_email = "$address";
489 } else {
490 $formatted_email = "$name <$address>";
493 return $formatted_email;
496 sub which_conf {
497 my ($conf) = @_;
499 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
500 if (-e "$path/$conf") {
501 return "$path/$conf";
505 return "";
508 sub expand_tabs {
509 my ($str) = @_;
511 my $res = '';
512 my $n = 0;
513 for my $c (split(//, $str)) {
514 if ($c eq "\t") {
515 $res .= ' ';
516 $n++;
517 for (; ($n % 8) != 0; $n++) {
518 $res .= ' ';
520 next;
522 $res .= $c;
523 $n++;
526 return $res;
528 sub copy_spacing {
529 (my $res = shift) =~ tr/\t/ /c;
530 return $res;
533 sub line_stats {
534 my ($line) = @_;
536 # Drop the diff line leader and expand tabs
537 $line =~ s/^.//;
538 $line = expand_tabs($line);
540 # Pick the indent from the front of the line.
541 my ($white) = ($line =~ /^(\s*)/);
543 return (length($line), length($white));
546 my $sanitise_quote = '';
548 sub sanitise_line_reset {
549 my ($in_comment) = @_;
551 if ($in_comment) {
552 $sanitise_quote = '*/';
553 } else {
554 $sanitise_quote = '';
557 sub sanitise_line {
558 my ($line) = @_;
560 my $res = '';
561 my $l = '';
563 my $qlen = 0;
564 my $off = 0;
565 my $c;
567 # Always copy over the diff marker.
568 $res = substr($line, 0, 1);
570 for ($off = 1; $off < length($line); $off++) {
571 $c = substr($line, $off, 1);
573 # Comments we are wacking completly including the begin
574 # and end, all to $;.
575 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
576 $sanitise_quote = '*/';
578 substr($res, $off, 2, "$;$;");
579 $off++;
580 next;
582 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
583 $sanitise_quote = '';
584 substr($res, $off, 2, "$;$;");
585 $off++;
586 next;
588 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
589 $sanitise_quote = '//';
591 substr($res, $off, 2, $sanitise_quote);
592 $off++;
593 next;
596 # A \ in a string means ignore the next character.
597 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
598 $c eq "\\") {
599 substr($res, $off, 2, 'XX');
600 $off++;
601 next;
603 # Regular quotes.
604 if ($c eq "'" || $c eq '"') {
605 if ($sanitise_quote eq '') {
606 $sanitise_quote = $c;
608 substr($res, $off, 1, $c);
609 next;
610 } elsif ($sanitise_quote eq $c) {
611 $sanitise_quote = '';
615 #print "c<$c> SQ<$sanitise_quote>\n";
616 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
617 substr($res, $off, 1, $;);
618 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
619 substr($res, $off, 1, $;);
620 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
621 substr($res, $off, 1, 'X');
622 } else {
623 substr($res, $off, 1, $c);
627 if ($sanitise_quote eq '//') {
628 $sanitise_quote = '';
631 # The pathname on a #include may be surrounded by '<' and '>'.
632 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
633 my $clean = 'X' x length($1);
634 $res =~ s@\<.*\>@<$clean>@;
636 # The whole of a #error is a string.
637 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
638 my $clean = 'X' x length($1);
639 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
642 return $res;
645 sub ctx_statement_block {
646 my ($linenr, $remain, $off) = @_;
647 my $line = $linenr - 1;
648 my $blk = '';
649 my $soff = $off;
650 my $coff = $off - 1;
651 my $coff_set = 0;
653 my $loff = 0;
655 my $type = '';
656 my $level = 0;
657 my @stack = ();
658 my $p;
659 my $c;
660 my $len = 0;
662 my $remainder;
663 while (1) {
664 @stack = (['', 0]) if ($#stack == -1);
666 #warn "CSB: blk<$blk> remain<$remain>\n";
667 # If we are about to drop off the end, pull in more
668 # context.
669 if ($off >= $len) {
670 for (; $remain > 0; $line++) {
671 last if (!defined $lines[$line]);
672 next if ($lines[$line] =~ /^-/);
673 $remain--;
674 $loff = $len;
675 $blk .= $lines[$line] . "\n";
676 $len = length($blk);
677 $line++;
678 last;
680 # Bail if there is no further context.
681 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
682 if ($off >= $len) {
683 last;
685 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
686 $level++;
687 $type = '#';
690 $p = $c;
691 $c = substr($blk, $off, 1);
692 $remainder = substr($blk, $off);
694 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
696 # Handle nested #if/#else.
697 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
698 push(@stack, [ $type, $level ]);
699 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
700 ($type, $level) = @{$stack[$#stack - 1]};
701 } elsif ($remainder =~ /^#\s*endif\b/) {
702 ($type, $level) = @{pop(@stack)};
705 # Statement ends at the ';' or a close '}' at the
706 # outermost level.
707 if ($level == 0 && $c eq ';') {
708 last;
711 # An else is really a conditional as long as its not else if
712 if ($level == 0 && $coff_set == 0 &&
713 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
714 $remainder =~ /^(else)(?:\s|{)/ &&
715 $remainder !~ /^else\s+if\b/) {
716 $coff = $off + length($1) - 1;
717 $coff_set = 1;
718 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
719 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
722 if (($type eq '' || $type eq '(') && $c eq '(') {
723 $level++;
724 $type = '(';
726 if ($type eq '(' && $c eq ')') {
727 $level--;
728 $type = ($level != 0)? '(' : '';
730 if ($level == 0 && $coff < $soff) {
731 $coff = $off;
732 $coff_set = 1;
733 #warn "CSB: mark coff<$coff>\n";
736 if (($type eq '' || $type eq '{') && $c eq '{') {
737 $level++;
738 $type = '{';
740 if ($type eq '{' && $c eq '}') {
741 $level--;
742 $type = ($level != 0)? '{' : '';
744 if ($level == 0) {
745 if (substr($blk, $off + 1, 1) eq ';') {
746 $off++;
748 last;
751 # Preprocessor commands end at the newline unless escaped.
752 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
753 $level--;
754 $type = '';
755 $off++;
756 last;
758 $off++;
760 # We are truly at the end, so shuffle to the next line.
761 if ($off == $len) {
762 $loff = $len + 1;
763 $line++;
764 $remain--;
767 my $statement = substr($blk, $soff, $off - $soff + 1);
768 my $condition = substr($blk, $soff, $coff - $soff + 1);
770 #warn "STATEMENT<$statement>\n";
771 #warn "CONDITION<$condition>\n";
773 #print "coff<$coff> soff<$off> loff<$loff>\n";
775 return ($statement, $condition,
776 $line, $remain + 1, $off - $loff + 1, $level);
779 sub statement_lines {
780 my ($stmt) = @_;
782 # Strip the diff line prefixes and rip blank lines at start and end.
783 $stmt =~ s/(^|\n)./$1/g;
784 $stmt =~ s/^\s*//;
785 $stmt =~ s/\s*$//;
787 my @stmt_lines = ($stmt =~ /\n/g);
789 return $#stmt_lines + 2;
792 sub statement_rawlines {
793 my ($stmt) = @_;
795 my @stmt_lines = ($stmt =~ /\n/g);
797 return $#stmt_lines + 2;
800 sub statement_block_size {
801 my ($stmt) = @_;
803 $stmt =~ s/(^|\n)./$1/g;
804 $stmt =~ s/^\s*{//;
805 $stmt =~ s/}\s*$//;
806 $stmt =~ s/^\s*//;
807 $stmt =~ s/\s*$//;
809 my @stmt_lines = ($stmt =~ /\n/g);
810 my @stmt_statements = ($stmt =~ /;/g);
812 my $stmt_lines = $#stmt_lines + 2;
813 my $stmt_statements = $#stmt_statements + 1;
815 if ($stmt_lines > $stmt_statements) {
816 return $stmt_lines;
817 } else {
818 return $stmt_statements;
822 sub ctx_statement_full {
823 my ($linenr, $remain, $off) = @_;
824 my ($statement, $condition, $level);
826 my (@chunks);
828 # Grab the first conditional/block pair.
829 ($statement, $condition, $linenr, $remain, $off, $level) =
830 ctx_statement_block($linenr, $remain, $off);
831 #print "F: c<$condition> s<$statement> remain<$remain>\n";
832 push(@chunks, [ $condition, $statement ]);
833 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
834 return ($level, $linenr, @chunks);
837 # Pull in the following conditional/block pairs and see if they
838 # could continue the statement.
839 for (;;) {
840 ($statement, $condition, $linenr, $remain, $off, $level) =
841 ctx_statement_block($linenr, $remain, $off);
842 #print "C: c<$condition> s<$statement> remain<$remain>\n";
843 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
844 #print "C: push\n";
845 push(@chunks, [ $condition, $statement ]);
848 return ($level, $linenr, @chunks);
851 sub ctx_block_get {
852 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
853 my $line;
854 my $start = $linenr - 1;
855 my $blk = '';
856 my @o;
857 my @c;
858 my @res = ();
860 my $level = 0;
861 my @stack = ($level);
862 for ($line = $start; $remain > 0; $line++) {
863 next if ($rawlines[$line] =~ /^-/);
864 $remain--;
866 $blk .= $rawlines[$line];
868 # Handle nested #if/#else.
869 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
870 push(@stack, $level);
871 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
872 $level = $stack[$#stack - 1];
873 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
874 $level = pop(@stack);
877 foreach my $c (split(//, $lines[$line])) {
878 ##print "C<$c>L<$level><$open$close>O<$off>\n";
879 if ($off > 0) {
880 $off--;
881 next;
884 if ($c eq $close && $level > 0) {
885 $level--;
886 last if ($level == 0);
887 } elsif ($c eq $open) {
888 $level++;
892 if (!$outer || $level <= 1) {
893 push(@res, $rawlines[$line]);
896 last if ($level == 0);
899 return ($level, @res);
901 sub ctx_block_outer {
902 my ($linenr, $remain) = @_;
904 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
905 return @r;
907 sub ctx_block {
908 my ($linenr, $remain) = @_;
910 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
911 return @r;
913 sub ctx_statement {
914 my ($linenr, $remain, $off) = @_;
916 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
917 return @r;
919 sub ctx_block_level {
920 my ($linenr, $remain) = @_;
922 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
924 sub ctx_statement_level {
925 my ($linenr, $remain, $off) = @_;
927 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
930 sub ctx_locate_comment {
931 my ($first_line, $end_line) = @_;
933 # Catch a comment on the end of the line itself.
934 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
935 return $current_comment if (defined $current_comment);
937 # Look through the context and try and figure out if there is a
938 # comment.
939 my $in_comment = 0;
940 $current_comment = '';
941 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
942 my $line = $rawlines[$linenr - 1];
943 #warn " $line\n";
944 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
945 $in_comment = 1;
947 if ($line =~ m@/\*@) {
948 $in_comment = 1;
950 if (!$in_comment && $current_comment ne '') {
951 $current_comment = '';
953 $current_comment .= $line . "\n" if ($in_comment);
954 if ($line =~ m@\*/@) {
955 $in_comment = 0;
959 chomp($current_comment);
960 return($current_comment);
962 sub ctx_has_comment {
963 my ($first_line, $end_line) = @_;
964 my $cmt = ctx_locate_comment($first_line, $end_line);
966 ##print "LINE: $rawlines[$end_line - 1 ]\n";
967 ##print "CMMT: $cmt\n";
969 return ($cmt ne '');
972 sub raw_line {
973 my ($linenr, $cnt) = @_;
975 my $offset = $linenr - 1;
976 $cnt++;
978 my $line;
979 while ($cnt) {
980 $line = $rawlines[$offset++];
981 next if (defined($line) && $line =~ /^-/);
982 $cnt--;
985 return $line;
988 sub cat_vet {
989 my ($vet) = @_;
990 my ($res, $coded);
992 $res = '';
993 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
994 $res .= $1;
995 if ($2 ne '') {
996 $coded = sprintf("^%c", unpack('C', $2) + 64);
997 $res .= $coded;
1000 $res =~ s/$/\$/;
1002 return $res;
1005 my $av_preprocessor = 0;
1006 my $av_pending;
1007 my @av_paren_type;
1008 my $av_pend_colon;
1010 sub annotate_reset {
1011 $av_preprocessor = 0;
1012 $av_pending = '_';
1013 @av_paren_type = ('E');
1014 $av_pend_colon = 'O';
1017 sub annotate_values {
1018 my ($stream, $type) = @_;
1020 my $res;
1021 my $var = '_' x length($stream);
1022 my $cur = $stream;
1024 print "$stream\n" if ($dbg_values > 1);
1026 while (length($cur)) {
1027 @av_paren_type = ('E') if ($#av_paren_type < 0);
1028 print " <" . join('', @av_paren_type) .
1029 "> <$type> <$av_pending>" if ($dbg_values > 1);
1030 if ($cur =~ /^(\s+)/o) {
1031 print "WS($1)\n" if ($dbg_values > 1);
1032 if ($1 =~ /\n/ && $av_preprocessor) {
1033 $type = pop(@av_paren_type);
1034 $av_preprocessor = 0;
1037 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1038 print "CAST($1)\n" if ($dbg_values > 1);
1039 push(@av_paren_type, $type);
1040 $type = 'c';
1042 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1043 print "DECLARE($1)\n" if ($dbg_values > 1);
1044 $type = 'T';
1046 } elsif ($cur =~ /^($Modifier)\s*/) {
1047 print "MODIFIER($1)\n" if ($dbg_values > 1);
1048 $type = 'T';
1050 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1051 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1052 $av_preprocessor = 1;
1053 push(@av_paren_type, $type);
1054 if ($2 ne '') {
1055 $av_pending = 'N';
1057 $type = 'E';
1059 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1060 print "UNDEF($1)\n" if ($dbg_values > 1);
1061 $av_preprocessor = 1;
1062 push(@av_paren_type, $type);
1064 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1065 print "PRE_START($1)\n" if ($dbg_values > 1);
1066 $av_preprocessor = 1;
1068 push(@av_paren_type, $type);
1069 push(@av_paren_type, $type);
1070 $type = 'E';
1072 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1073 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1074 $av_preprocessor = 1;
1076 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1078 $type = 'E';
1080 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1081 print "PRE_END($1)\n" if ($dbg_values > 1);
1083 $av_preprocessor = 1;
1085 # Assume all arms of the conditional end as this
1086 # one does, and continue as if the #endif was not here.
1087 pop(@av_paren_type);
1088 push(@av_paren_type, $type);
1089 $type = 'E';
1091 } elsif ($cur =~ /^(\\\n)/o) {
1092 print "PRECONT($1)\n" if ($dbg_values > 1);
1094 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1095 print "ATTR($1)\n" if ($dbg_values > 1);
1096 $av_pending = $type;
1097 $type = 'N';
1099 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1100 print "SIZEOF($1)\n" if ($dbg_values > 1);
1101 if (defined $2) {
1102 $av_pending = 'V';
1104 $type = 'N';
1106 } elsif ($cur =~ /^(if|while|for)\b/o) {
1107 print "COND($1)\n" if ($dbg_values > 1);
1108 $av_pending = 'E';
1109 $type = 'N';
1111 } elsif ($cur =~/^(case)/o) {
1112 print "CASE($1)\n" if ($dbg_values > 1);
1113 $av_pend_colon = 'C';
1114 $type = 'N';
1116 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1117 print "KEYWORD($1)\n" if ($dbg_values > 1);
1118 $type = 'N';
1120 } elsif ($cur =~ /^(\()/o) {
1121 print "PAREN('$1')\n" if ($dbg_values > 1);
1122 push(@av_paren_type, $av_pending);
1123 $av_pending = '_';
1124 $type = 'N';
1126 } elsif ($cur =~ /^(\))/o) {
1127 my $new_type = pop(@av_paren_type);
1128 if ($new_type ne '_') {
1129 $type = $new_type;
1130 print "PAREN('$1') -> $type\n"
1131 if ($dbg_values > 1);
1132 } else {
1133 print "PAREN('$1')\n" if ($dbg_values > 1);
1136 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1137 print "FUNC($1)\n" if ($dbg_values > 1);
1138 $type = 'V';
1139 $av_pending = 'V';
1141 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1142 if (defined $2 && $type eq 'C' || $type eq 'T') {
1143 $av_pend_colon = 'B';
1144 } elsif ($type eq 'E') {
1145 $av_pend_colon = 'L';
1147 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1148 $type = 'V';
1150 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1151 print "IDENT($1)\n" if ($dbg_values > 1);
1152 $type = 'V';
1154 } elsif ($cur =~ /^($Assignment)/o) {
1155 print "ASSIGN($1)\n" if ($dbg_values > 1);
1156 $type = 'N';
1158 } elsif ($cur =~/^(;|{|})/) {
1159 print "END($1)\n" if ($dbg_values > 1);
1160 $type = 'E';
1161 $av_pend_colon = 'O';
1163 } elsif ($cur =~/^(,)/) {
1164 print "COMMA($1)\n" if ($dbg_values > 1);
1165 $type = 'C';
1167 } elsif ($cur =~ /^(\?)/o) {
1168 print "QUESTION($1)\n" if ($dbg_values > 1);
1169 $type = 'N';
1171 } elsif ($cur =~ /^(:)/o) {
1172 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1174 substr($var, length($res), 1, $av_pend_colon);
1175 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1176 $type = 'E';
1177 } else {
1178 $type = 'N';
1180 $av_pend_colon = 'O';
1182 } elsif ($cur =~ /^(\[)/o) {
1183 print "CLOSE($1)\n" if ($dbg_values > 1);
1184 $type = 'N';
1186 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1187 my $variant;
1189 print "OPV($1)\n" if ($dbg_values > 1);
1190 if ($type eq 'V') {
1191 $variant = 'B';
1192 } else {
1193 $variant = 'U';
1196 substr($var, length($res), 1, $variant);
1197 $type = 'N';
1199 } elsif ($cur =~ /^($Operators)/o) {
1200 print "OP($1)\n" if ($dbg_values > 1);
1201 if ($1 ne '++' && $1 ne '--') {
1202 $type = 'N';
1205 } elsif ($cur =~ /(^.)/o) {
1206 print "C($1)\n" if ($dbg_values > 1);
1208 if (defined $1) {
1209 $cur = substr($cur, length($1));
1210 $res .= $type x length($1);
1214 return ($res, $var);
1217 sub possible {
1218 my ($possible, $line) = @_;
1219 my $notPermitted = qr{(?:
1220 ^(?:
1221 $Modifier|
1222 $Storage|
1223 $Type|
1224 DEFINE_\S+
1226 ^(?:
1227 goto|
1228 return|
1229 case|
1230 else|
1231 asm|__asm__|
1234 \#\#|
1235 )(?:\s|$)|
1236 ^(?:typedef|struct|enum)\b
1237 )}x;
1238 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1239 if ($possible !~ $notPermitted) {
1240 # Check for modifiers.
1241 $possible =~ s/\s*$Storage\s*//g;
1242 $possible =~ s/\s*$Sparse\s*//g;
1243 if ($possible =~ /^\s*$/) {
1245 } elsif ($possible =~ /\s/) {
1246 $possible =~ s/\s*$Type\s*//g;
1247 for my $modifier (split(' ', $possible)) {
1248 if ($modifier !~ $notPermitted) {
1249 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1250 push(@modifierList, $modifier);
1254 } else {
1255 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1256 push(@typeList, $possible);
1258 build_types();
1259 } else {
1260 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1264 my $prefix = '';
1266 sub show_type {
1267 return !defined $ignore_type{$_[0]};
1270 sub report {
1271 if (!show_type($_[1]) ||
1272 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1273 return 0;
1275 my $line;
1276 if ($show_types) {
1277 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1278 } else {
1279 $line = "$prefix$_[0]: $_[2]\n";
1281 $line = (split('\n', $line))[0] . "\n" if ($terse);
1283 push(our @report, $line);
1285 return 1;
1287 sub report_dump {
1288 our @report;
1291 sub ERROR {
1292 if (report("ERROR", $_[0], $_[1])) {
1293 our $clean = 0;
1294 our $cnt_error++;
1297 sub WARN {
1298 if (report("WARNING", $_[0], $_[1])) {
1299 our $clean = 0;
1300 our $cnt_warn++;
1303 sub CHK {
1304 if ($check && report("CHECK", $_[0], $_[1])) {
1305 our $clean = 0;
1306 our $cnt_chk++;
1310 sub check_absolute_file {
1311 my ($absolute, $herecurr) = @_;
1312 my $file = $absolute;
1314 ##print "absolute<$absolute>\n";
1316 # See if any suffix of this path is a path within the tree.
1317 while ($file =~ s@^[^/]*/@@) {
1318 if (-f "$root/$file") {
1319 ##print "file<$file>\n";
1320 last;
1323 if (! -f _) {
1324 return 0;
1327 # It is, so see if the prefix is acceptable.
1328 my $prefix = $absolute;
1329 substr($prefix, -length($file)) = '';
1331 ##print "prefix<$prefix>\n";
1332 if ($prefix ne ".../") {
1333 WARN("USE_RELATIVE_PATH",
1334 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1338 sub pos_last_openparen {
1339 my ($line) = @_;
1341 my $pos = 0;
1343 my $opens = $line =~ tr/\(/\(/;
1344 my $closes = $line =~ tr/\)/\)/;
1346 my $last_openparen = 0;
1348 if (($opens == 0) || ($closes >= $opens)) {
1349 return -1;
1352 my $len = length($line);
1354 for ($pos = 0; $pos < $len; $pos++) {
1355 my $string = substr($line, $pos);
1356 if ($string =~ /^($FuncArg|$balanced_parens)/) {
1357 $pos += length($1) - 1;
1358 } elsif (substr($line, $pos, 1) eq '(') {
1359 $last_openparen = $pos;
1360 } elsif (index($string, '(') == -1) {
1361 last;
1365 return $last_openparen + 1;
1368 sub process {
1369 my $filename = shift;
1371 my $linenr=0;
1372 my $prevline="";
1373 my $prevrawline="";
1374 my $stashline="";
1375 my $stashrawline="";
1377 my $length;
1378 my $indent;
1379 my $previndent=0;
1380 my $stashindent=0;
1382 our $clean = 1;
1383 my $signoff = 0;
1384 my $is_patch = 0;
1386 my $in_header_lines = 1;
1387 my $in_commit_log = 0; #Scanning lines before patch
1389 our @report = ();
1390 our $cnt_lines = 0;
1391 our $cnt_error = 0;
1392 our $cnt_warn = 0;
1393 our $cnt_chk = 0;
1395 # Trace the real file/line as we go.
1396 my $realfile = '';
1397 my $realline = 0;
1398 my $realcnt = 0;
1399 my $here = '';
1400 my $in_comment = 0;
1401 my $comment_edge = 0;
1402 my $first_line = 0;
1403 my $p1_prefix = '';
1405 my $prev_values = 'E';
1407 # suppression flags
1408 my %suppress_ifbraces;
1409 my %suppress_whiletrailers;
1410 my %suppress_export;
1411 my $suppress_statement = 0;
1413 # Pre-scan the patch sanitizing the lines.
1414 # Pre-scan the patch looking for any __setup documentation.
1416 my @setup_docs = ();
1417 my $setup_docs = 0;
1419 sanitise_line_reset();
1420 my $line;
1421 foreach my $rawline (@rawlines) {
1422 $linenr++;
1423 $line = $rawline;
1425 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1426 $setup_docs = 0;
1427 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1428 $setup_docs = 1;
1430 #next;
1432 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1433 $realline=$1-1;
1434 if (defined $2) {
1435 $realcnt=$3+1;
1436 } else {
1437 $realcnt=1+1;
1439 $in_comment = 0;
1441 # Guestimate if this is a continuing comment. Run
1442 # the context looking for a comment "edge". If this
1443 # edge is a close comment then we must be in a comment
1444 # at context start.
1445 my $edge;
1446 my $cnt = $realcnt;
1447 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1448 next if (defined $rawlines[$ln - 1] &&
1449 $rawlines[$ln - 1] =~ /^-/);
1450 $cnt--;
1451 #print "RAW<$rawlines[$ln - 1]>\n";
1452 last if (!defined $rawlines[$ln - 1]);
1453 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1454 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1455 ($edge) = $1;
1456 last;
1459 if (defined $edge && $edge eq '*/') {
1460 $in_comment = 1;
1463 # Guestimate if this is a continuing comment. If this
1464 # is the start of a diff block and this line starts
1465 # ' *' then it is very likely a comment.
1466 if (!defined $edge &&
1467 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1469 $in_comment = 1;
1472 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1473 sanitise_line_reset($in_comment);
1475 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1476 # Standardise the strings and chars within the input to
1477 # simplify matching -- only bother with positive lines.
1478 $line = sanitise_line($rawline);
1480 push(@lines, $line);
1482 if ($realcnt > 1) {
1483 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1484 } else {
1485 $realcnt = 0;
1488 #print "==>$rawline\n";
1489 #print "-->$line\n";
1491 if ($setup_docs && $line =~ /^\+/) {
1492 push(@setup_docs, $line);
1496 $prefix = '';
1498 $realcnt = 0;
1499 $linenr = 0;
1500 foreach my $line (@lines) {
1501 $linenr++;
1503 my $rawline = $rawlines[$linenr - 1];
1505 #extract the line range in the file after the patch is applied
1506 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1507 $is_patch = 1;
1508 $first_line = $linenr + 1;
1509 $realline=$1-1;
1510 if (defined $2) {
1511 $realcnt=$3+1;
1512 } else {
1513 $realcnt=1+1;
1515 annotate_reset();
1516 $prev_values = 'E';
1518 %suppress_ifbraces = ();
1519 %suppress_whiletrailers = ();
1520 %suppress_export = ();
1521 $suppress_statement = 0;
1522 next;
1524 # track the line number as we move through the hunk, note that
1525 # new versions of GNU diff omit the leading space on completely
1526 # blank context lines so we need to count that too.
1527 } elsif ($line =~ /^( |\+|$)/) {
1528 $realline++;
1529 $realcnt-- if ($realcnt != 0);
1531 # Measure the line length and indent.
1532 ($length, $indent) = line_stats($rawline);
1534 # Track the previous line.
1535 ($prevline, $stashline) = ($stashline, $line);
1536 ($previndent, $stashindent) = ($stashindent, $indent);
1537 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1539 #warn "line<$line>\n";
1541 } elsif ($realcnt == 1) {
1542 $realcnt--;
1545 my $hunk_line = ($realcnt != 0);
1547 #make up the handle for any error we report on this line
1548 $prefix = "$filename:$realline: " if ($emacs && $file);
1549 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1551 $here = "#$linenr: " if (!$file);
1552 $here = "#$realline: " if ($file);
1554 # extract the filename as it passes
1555 if ($line =~ /^diff --git.*?(\S+)$/) {
1556 $realfile = $1;
1557 $realfile =~ s@^([^/]*)/@@;
1558 $in_commit_log = 0;
1559 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1560 $realfile = $1;
1561 $realfile =~ s@^([^/]*)/@@;
1562 $in_commit_log = 0;
1564 $p1_prefix = $1;
1565 if (!$file && $tree && $p1_prefix ne '' &&
1566 -e "$root/$p1_prefix") {
1567 WARN("PATCH_PREFIX",
1568 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1571 if ($realfile =~ m@^include/asm/@) {
1572 ERROR("MODIFIED_INCLUDE_ASM",
1573 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1575 next;
1578 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1580 my $hereline = "$here\n$rawline\n";
1581 my $herecurr = "$here\n$rawline\n";
1582 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1584 $cnt_lines++ if ($realcnt != 0);
1586 # Check for incorrect file permissions
1587 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1588 my $permhere = $here . "FILE: $realfile\n";
1589 if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
1590 ERROR("EXECUTE_PERMISSIONS",
1591 "do not set execute permissions for source files\n" . $permhere);
1595 # Check the patch for a signoff:
1596 if ($line =~ /^\s*signed-off-by:/i) {
1597 $signoff++;
1598 $in_commit_log = 0;
1601 # Check signature styles
1602 if (!$in_header_lines &&
1603 $line =~ /^(\s*)($signature_tags)(\s*)(.*)/) {
1604 my $space_before = $1;
1605 my $sign_off = $2;
1606 my $space_after = $3;
1607 my $email = $4;
1608 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1610 if (defined $space_before && $space_before ne "") {
1611 WARN("BAD_SIGN_OFF",
1612 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
1614 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1615 WARN("BAD_SIGN_OFF",
1616 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
1618 if (!defined $space_after || $space_after ne " ") {
1619 WARN("BAD_SIGN_OFF",
1620 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
1623 my ($email_name, $email_address, $comment) = parse_email($email);
1624 my $suggested_email = format_email(($email_name, $email_address));
1625 if ($suggested_email eq "") {
1626 ERROR("BAD_SIGN_OFF",
1627 "Unrecognized email address: '$email'\n" . $herecurr);
1628 } else {
1629 my $dequoted = $suggested_email;
1630 $dequoted =~ s/^"//;
1631 $dequoted =~ s/" </ </;
1632 # Don't force email to have quotes
1633 # Allow just an angle bracketed address
1634 if ("$dequoted$comment" ne $email &&
1635 "<$email_address>$comment" ne $email &&
1636 "$suggested_email$comment" ne $email) {
1637 WARN("BAD_SIGN_OFF",
1638 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1643 # Check for wrappage within a valid hunk of the file
1644 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1645 ERROR("CORRUPTED_PATCH",
1646 "patch seems to be corrupt (line wrapped?)\n" .
1647 $herecurr) if (!$emitted_corrupt++);
1650 # Check for absolute kernel paths.
1651 if ($tree) {
1652 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1653 my $file = $1;
1655 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1656 check_absolute_file($1, $herecurr)) {
1658 } else {
1659 check_absolute_file($file, $herecurr);
1664 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1665 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1666 $rawline !~ m/^$UTF8*$/) {
1667 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1669 my $blank = copy_spacing($rawline);
1670 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1671 my $hereptr = "$hereline$ptr\n";
1673 CHK("INVALID_UTF8",
1674 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1677 # Check if it's the start of a commit log
1678 # (not a header line and we haven't seen the patch filename)
1679 if ($in_header_lines && $realfile =~ /^$/ &&
1680 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1681 $in_header_lines = 0;
1682 $in_commit_log = 1;
1685 # Still not yet in a patch, check for any UTF-8
1686 if ($in_commit_log && $realfile =~ /^$/ &&
1687 $rawline =~ /$NON_ASCII_UTF8/) {
1688 CHK("UTF8_BEFORE_PATCH",
1689 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1692 # ignore non-hunk lines and lines being removed
1693 next if (!$hunk_line || $line =~ /^-/);
1695 #trailing whitespace
1696 if ($line =~ /^\+.*\015/) {
1697 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1698 ERROR("DOS_LINE_ENDINGS",
1699 "DOS line endings\n" . $herevet);
1701 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1702 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1703 ERROR("TRAILING_WHITESPACE",
1704 "trailing whitespace\n" . $herevet);
1705 $rpt_cleaners = 1;
1708 # check for Kconfig help text having a real description
1709 # Only applies when adding the entry originally, after that we do not have
1710 # sufficient context to determine whether it is indeed long enough.
1711 if ($realfile =~ /Kconfig/ &&
1712 $line =~ /.\s*config\s+/) {
1713 my $length = 0;
1714 my $cnt = $realcnt;
1715 my $ln = $linenr + 1;
1716 my $f;
1717 my $is_start = 0;
1718 my $is_end = 0;
1719 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1720 $f = $lines[$ln - 1];
1721 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1722 $is_end = $lines[$ln - 1] =~ /^\+/;
1724 next if ($f =~ /^-/);
1726 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1727 $is_start = 1;
1728 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1729 $length = -1;
1732 $f =~ s/^.//;
1733 $f =~ s/#.*//;
1734 $f =~ s/^\s+//;
1735 next if ($f =~ /^$/);
1736 if ($f =~ /^\s*config\s/) {
1737 $is_end = 1;
1738 last;
1740 $length++;
1742 WARN("CONFIG_DESCRIPTION",
1743 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1744 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1747 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1748 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1749 my $flag = $1;
1750 my $replacement = {
1751 'EXTRA_AFLAGS' => 'asflags-y',
1752 'EXTRA_CFLAGS' => 'ccflags-y',
1753 'EXTRA_CPPFLAGS' => 'cppflags-y',
1754 'EXTRA_LDFLAGS' => 'ldflags-y',
1757 WARN("DEPRECATED_VARIABLE",
1758 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1761 # check we are in a valid source file if not then ignore this hunk
1762 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1764 #80 column limit
1765 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1766 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1767 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1768 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1769 $length > 80)
1771 WARN("LONG_LINE",
1772 "line over 80 characters\n" . $herecurr);
1775 # Check for user-visible strings broken across lines, which breaks the ability
1776 # to grep for the string. Limited to strings used as parameters (those
1777 # following an open parenthesis), which almost completely eliminates false
1778 # positives, as well as warning only once per parameter rather than once per
1779 # line of the string. Make an exception when the previous string ends in a
1780 # newline (multiple lines in one string constant) or \n\t (common in inline
1781 # assembly to indent the instruction on the following line).
1782 if ($line =~ /^\+\s*"/ &&
1783 $prevline =~ /"\s*$/ &&
1784 $prevline =~ /\(/ &&
1785 $prevrawline !~ /\\n(?:\\t)*"\s*$/) {
1786 WARN("SPLIT_STRING",
1787 "quoted string split across lines\n" . $hereprev);
1790 # check for spaces before a quoted newline
1791 if ($rawline =~ /^.*\".*\s\\n/) {
1792 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1793 "unnecessary whitespace before a quoted newline\n" . $herecurr);
1796 # check for adding lines without a newline.
1797 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1798 WARN("MISSING_EOF_NEWLINE",
1799 "adding a line without newline at end of file\n" . $herecurr);
1802 # Blackfin: use hi/lo macros
1803 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1804 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1805 my $herevet = "$here\n" . cat_vet($line) . "\n";
1806 ERROR("LO_MACRO",
1807 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1809 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1810 my $herevet = "$here\n" . cat_vet($line) . "\n";
1811 ERROR("HI_MACRO",
1812 "use the HI() macro, not (... >> 16)\n" . $herevet);
1816 # check we are in a valid source file C or perl if not then ignore this hunk
1817 next if ($realfile !~ /\.(h|c|pl)$/);
1819 # at the beginning of a line any tabs must come first and anything
1820 # more than 8 must use tabs.
1821 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1822 $rawline =~ /^\+\s* \s*/) {
1823 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1824 ERROR("CODE_INDENT",
1825 "code indent should use tabs where possible\n" . $herevet);
1826 $rpt_cleaners = 1;
1829 # check for space before tabs.
1830 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1831 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1832 WARN("SPACE_BEFORE_TAB",
1833 "please, no space before tabs\n" . $herevet);
1836 # check for && or || at the start of a line
1837 if ($rawline =~ /^\+\s*(&&|\|\|)/) {
1838 CHK("LOGICAL_CONTINUATIONS",
1839 "Logical continuations should be on the previous line\n" . $hereprev);
1842 # check multi-line statement indentation matches previous line
1843 if ($^V && $^V ge 5.10.0 &&
1844 $prevline =~ /^\+(\t*)(if \(|$Ident\().*(\&\&|\|\||,)\s*$/) {
1845 $prevline =~ /^\+(\t*)(.*)$/;
1846 my $oldindent = $1;
1847 my $rest = $2;
1849 my $pos = pos_last_openparen($rest);
1850 if ($pos >= 0) {
1851 $line =~ /^\+([ \t]*)/;
1852 my $newindent = $1;
1854 my $goodtabindent = $oldindent .
1855 "\t" x ($pos / 8) .
1856 " " x ($pos % 8);
1857 my $goodspaceindent = $oldindent . " " x $pos;
1859 if ($newindent ne $goodtabindent &&
1860 $newindent ne $goodspaceindent) {
1861 CHK("PARENTHESIS_ALIGNMENT",
1862 "Alignment should match open parenthesis\n" . $hereprev);
1867 if ($line =~ /^\+.*\*[ \t]*\)[ \t]+/) {
1868 CHK("SPACING",
1869 "No space is necessary after a cast\n" . $hereprev);
1872 # check for spaces at the beginning of a line.
1873 # Exceptions:
1874 # 1) within comments
1875 # 2) indented preprocessor commands
1876 # 3) hanging labels
1877 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
1878 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1879 WARN("LEADING_SPACE",
1880 "please, no spaces at the start of a line\n" . $herevet);
1883 # check we are in a valid C source file if not then ignore this hunk
1884 next if ($realfile !~ /\.(h|c)$/);
1886 # check for RCS/CVS revision markers
1887 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1888 WARN("CVS_KEYWORD",
1889 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1892 # Blackfin: don't use __builtin_bfin_[cs]sync
1893 if ($line =~ /__builtin_bfin_csync/) {
1894 my $herevet = "$here\n" . cat_vet($line) . "\n";
1895 ERROR("CSYNC",
1896 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1898 if ($line =~ /__builtin_bfin_ssync/) {
1899 my $herevet = "$here\n" . cat_vet($line) . "\n";
1900 ERROR("SSYNC",
1901 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1904 # Check for potential 'bare' types
1905 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1906 $realline_next);
1907 #print "LINE<$line>\n";
1908 if ($linenr >= $suppress_statement &&
1909 $realcnt && $line =~ /.\s*\S/) {
1910 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1911 ctx_statement_block($linenr, $realcnt, 0);
1912 $stat =~ s/\n./\n /g;
1913 $cond =~ s/\n./\n /g;
1915 #print "linenr<$linenr> <$stat>\n";
1916 # If this statement has no statement boundaries within
1917 # it there is no point in retrying a statement scan
1918 # until we hit end of it.
1919 my $frag = $stat; $frag =~ s/;+\s*$//;
1920 if ($frag !~ /(?:{|;)/) {
1921 #print "skip<$line_nr_next>\n";
1922 $suppress_statement = $line_nr_next;
1925 # Find the real next line.
1926 $realline_next = $line_nr_next;
1927 if (defined $realline_next &&
1928 (!defined $lines[$realline_next - 1] ||
1929 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1930 $realline_next++;
1933 my $s = $stat;
1934 $s =~ s/{.*$//s;
1936 # Ignore goto labels.
1937 if ($s =~ /$Ident:\*$/s) {
1939 # Ignore functions being called
1940 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1942 } elsif ($s =~ /^.\s*else\b/s) {
1944 # declarations always start with types
1945 } 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) {
1946 my $type = $1;
1947 $type =~ s/\s+/ /g;
1948 possible($type, "A:" . $s);
1950 # definitions in global scope can only start with types
1951 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1952 possible($1, "B:" . $s);
1955 # any (foo ... *) is a pointer cast, and foo is a type
1956 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1957 possible($1, "C:" . $s);
1960 # Check for any sort of function declaration.
1961 # int foo(something bar, other baz);
1962 # void (*store_gdt)(x86_descr_ptr *);
1963 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1964 my ($name_len) = length($1);
1966 my $ctx = $s;
1967 substr($ctx, 0, $name_len + 1, '');
1968 $ctx =~ s/\)[^\)]*$//;
1970 for my $arg (split(/\s*,\s*/, $ctx)) {
1971 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1973 possible($1, "D:" . $s);
1981 # Checks which may be anchored in the context.
1984 # Check for switch () and associated case and default
1985 # statements should be at the same indent.
1986 if ($line=~/\bswitch\s*\(.*\)/) {
1987 my $err = '';
1988 my $sep = '';
1989 my @ctx = ctx_block_outer($linenr, $realcnt);
1990 shift(@ctx);
1991 for my $ctx (@ctx) {
1992 my ($clen, $cindent) = line_stats($ctx);
1993 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
1994 $indent != $cindent) {
1995 $err .= "$sep$ctx\n";
1996 $sep = '';
1997 } else {
1998 $sep = "[...]\n";
2001 if ($err ne '') {
2002 ERROR("SWITCH_CASE_INDENT_LEVEL",
2003 "switch and case should be at the same indent\n$hereline$err");
2007 # if/while/etc brace do not go on next line, unless defining a do while loop,
2008 # or if that brace on the next line is for something else
2009 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2010 my $pre_ctx = "$1$2";
2012 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2014 if ($line =~ /^\+\t{6,}/) {
2015 WARN("DEEP_INDENTATION",
2016 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2019 my $ctx_cnt = $realcnt - $#ctx - 1;
2020 my $ctx = join("\n", @ctx);
2022 my $ctx_ln = $linenr;
2023 my $ctx_skip = $realcnt;
2025 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2026 defined $lines[$ctx_ln - 1] &&
2027 $lines[$ctx_ln - 1] =~ /^-/)) {
2028 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2029 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2030 $ctx_ln++;
2033 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2034 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2036 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2037 ERROR("OPEN_BRACE",
2038 "that open brace { should be on the previous line\n" .
2039 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2041 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2042 $ctx =~ /\)\s*\;\s*$/ &&
2043 defined $lines[$ctx_ln - 1])
2045 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2046 if ($nindent > $indent) {
2047 WARN("TRAILING_SEMICOLON",
2048 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2049 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2054 # Check relative indent for conditionals and blocks.
2055 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2056 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2057 ctx_statement_block($linenr, $realcnt, 0)
2058 if (!defined $stat);
2059 my ($s, $c) = ($stat, $cond);
2061 substr($s, 0, length($c), '');
2063 # Make sure we remove the line prefixes as we have
2064 # none on the first line, and are going to readd them
2065 # where necessary.
2066 $s =~ s/\n./\n/gs;
2068 # Find out how long the conditional actually is.
2069 my @newlines = ($c =~ /\n/gs);
2070 my $cond_lines = 1 + $#newlines;
2072 # We want to check the first line inside the block
2073 # starting at the end of the conditional, so remove:
2074 # 1) any blank line termination
2075 # 2) any opening brace { on end of the line
2076 # 3) any do (...) {
2077 my $continuation = 0;
2078 my $check = 0;
2079 $s =~ s/^.*\bdo\b//;
2080 $s =~ s/^\s*{//;
2081 if ($s =~ s/^\s*\\//) {
2082 $continuation = 1;
2084 if ($s =~ s/^\s*?\n//) {
2085 $check = 1;
2086 $cond_lines++;
2089 # Also ignore a loop construct at the end of a
2090 # preprocessor statement.
2091 if (($prevline =~ /^.\s*#\s*define\s/ ||
2092 $prevline =~ /\\\s*$/) && $continuation == 0) {
2093 $check = 0;
2096 my $cond_ptr = -1;
2097 $continuation = 0;
2098 while ($cond_ptr != $cond_lines) {
2099 $cond_ptr = $cond_lines;
2101 # If we see an #else/#elif then the code
2102 # is not linear.
2103 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2104 $check = 0;
2107 # Ignore:
2108 # 1) blank lines, they should be at 0,
2109 # 2) preprocessor lines, and
2110 # 3) labels.
2111 if ($continuation ||
2112 $s =~ /^\s*?\n/ ||
2113 $s =~ /^\s*#\s*?/ ||
2114 $s =~ /^\s*$Ident\s*:/) {
2115 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2116 if ($s =~ s/^.*?\n//) {
2117 $cond_lines++;
2122 my (undef, $sindent) = line_stats("+" . $s);
2123 my $stat_real = raw_line($linenr, $cond_lines);
2125 # Check if either of these lines are modified, else
2126 # this is not this patch's fault.
2127 if (!defined($stat_real) ||
2128 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2129 $check = 0;
2131 if (defined($stat_real) && $cond_lines > 1) {
2132 $stat_real = "[...]\n$stat_real";
2135 #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";
2137 if ($check && (($sindent % 8) != 0 ||
2138 ($sindent <= $indent && $s ne ''))) {
2139 WARN("SUSPECT_CODE_INDENT",
2140 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2144 # Track the 'values' across context and added lines.
2145 my $opline = $line; $opline =~ s/^./ /;
2146 my ($curr_values, $curr_vars) =
2147 annotate_values($opline . "\n", $prev_values);
2148 $curr_values = $prev_values . $curr_values;
2149 if ($dbg_values) {
2150 my $outline = $opline; $outline =~ s/\t/ /g;
2151 print "$linenr > .$outline\n";
2152 print "$linenr > $curr_values\n";
2153 print "$linenr > $curr_vars\n";
2155 $prev_values = substr($curr_values, -1);
2157 #ignore lines not being added
2158 if ($line=~/^[^\+]/) {next;}
2160 # TEST: allow direct testing of the type matcher.
2161 if ($dbg_type) {
2162 if ($line =~ /^.\s*$Declare\s*$/) {
2163 ERROR("TEST_TYPE",
2164 "TEST: is type\n" . $herecurr);
2165 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2166 ERROR("TEST_NOT_TYPE",
2167 "TEST: is not type ($1 is)\n". $herecurr);
2169 next;
2171 # TEST: allow direct testing of the attribute matcher.
2172 if ($dbg_attr) {
2173 if ($line =~ /^.\s*$Modifier\s*$/) {
2174 ERROR("TEST_ATTR",
2175 "TEST: is attr\n" . $herecurr);
2176 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2177 ERROR("TEST_NOT_ATTR",
2178 "TEST: is not attr ($1 is)\n". $herecurr);
2180 next;
2183 # check for initialisation to aggregates open brace on the next line
2184 if ($line =~ /^.\s*{/ &&
2185 $prevline =~ /(?:^|[^=])=\s*$/) {
2186 ERROR("OPEN_BRACE",
2187 "that open brace { should be on the previous line\n" . $hereprev);
2191 # Checks which are anchored on the added line.
2194 # check for malformed paths in #include statements (uses RAW line)
2195 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2196 my $path = $1;
2197 if ($path =~ m{//}) {
2198 ERROR("MALFORMED_INCLUDE",
2199 "malformed #include filename\n" .
2200 $herecurr);
2204 # no C99 // comments
2205 if ($line =~ m{//}) {
2206 ERROR("C99_COMMENTS",
2207 "do not use C99 // comments\n" . $herecurr);
2209 # Remove C99 comments.
2210 $line =~ s@//.*@@;
2211 $opline =~ s@//.*@@;
2213 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2214 # the whole statement.
2215 #print "APW <$lines[$realline_next - 1]>\n";
2216 if (defined $realline_next &&
2217 exists $lines[$realline_next - 1] &&
2218 !defined $suppress_export{$realline_next} &&
2219 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2220 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2221 # Handle definitions which produce identifiers with
2222 # a prefix:
2223 # XXX(foo);
2224 # EXPORT_SYMBOL(something_foo);
2225 my $name = $1;
2226 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2227 $name =~ /^${Ident}_$2/) {
2228 #print "FOO C name<$name>\n";
2229 $suppress_export{$realline_next} = 1;
2231 } elsif ($stat !~ /(?:
2232 \n.}\s*$|
2233 ^.DEFINE_$Ident\(\Q$name\E\)|
2234 ^.DECLARE_$Ident\(\Q$name\E\)|
2235 ^.LIST_HEAD\(\Q$name\E\)|
2236 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2237 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2238 )/x) {
2239 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2240 $suppress_export{$realline_next} = 2;
2241 } else {
2242 $suppress_export{$realline_next} = 1;
2245 if (!defined $suppress_export{$linenr} &&
2246 $prevline =~ /^.\s*$/ &&
2247 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2248 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2249 #print "FOO B <$lines[$linenr - 1]>\n";
2250 $suppress_export{$linenr} = 2;
2252 if (defined $suppress_export{$linenr} &&
2253 $suppress_export{$linenr} == 2) {
2254 WARN("EXPORT_SYMBOL",
2255 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2258 # check for global initialisers.
2259 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2260 ERROR("GLOBAL_INITIALISERS",
2261 "do not initialise globals to 0 or NULL\n" .
2262 $herecurr);
2264 # check for static initialisers.
2265 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2266 ERROR("INITIALISED_STATIC",
2267 "do not initialise statics to 0 or NULL\n" .
2268 $herecurr);
2271 # check for static const char * arrays.
2272 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2273 WARN("STATIC_CONST_CHAR_ARRAY",
2274 "static const char * array should probably be static const char * const\n" .
2275 $herecurr);
2278 # check for static char foo[] = "bar" declarations.
2279 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2280 WARN("STATIC_CONST_CHAR_ARRAY",
2281 "static char array declaration should probably be static const char\n" .
2282 $herecurr);
2285 # check for declarations of struct pci_device_id
2286 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2287 WARN("DEFINE_PCI_DEVICE_TABLE",
2288 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2291 # check for new typedefs, only function parameters and sparse annotations
2292 # make sense.
2293 if ($line =~ /\btypedef\s/ &&
2294 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2295 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2296 $line !~ /\b$typeTypedefs\b/ &&
2297 $line !~ /\b__bitwise(?:__|)\b/) {
2298 WARN("NEW_TYPEDEFS",
2299 "do not add new typedefs\n" . $herecurr);
2302 # * goes on variable not on type
2303 # (char*[ const])
2304 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2305 #print "AA<$1>\n";
2306 my ($from, $to) = ($2, $2);
2308 # Should start with a space.
2309 $to =~ s/^(\S)/ $1/;
2310 # Should not end with a space.
2311 $to =~ s/\s+$//;
2312 # '*'s should not have spaces between.
2313 while ($to =~ s/\*\s+\*/\*\*/) {
2316 #print "from<$from> to<$to>\n";
2317 if ($from ne $to) {
2318 ERROR("POINTER_LOCATION",
2319 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
2322 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2323 #print "BB<$1>\n";
2324 my ($from, $to, $ident) = ($2, $2, $3);
2326 # Should start with a space.
2327 $to =~ s/^(\S)/ $1/;
2328 # Should not end with a space.
2329 $to =~ s/\s+$//;
2330 # '*'s should not have spaces between.
2331 while ($to =~ s/\*\s+\*/\*\*/) {
2333 # Modifiers should have spaces.
2334 $to =~ s/(\b$Modifier$)/$1 /;
2336 #print "from<$from> to<$to> ident<$ident>\n";
2337 if ($from ne $to && $ident !~ /^$Modifier$/) {
2338 ERROR("POINTER_LOCATION",
2339 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
2343 # # no BUG() or BUG_ON()
2344 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
2345 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2346 # print "$herecurr";
2347 # $clean = 0;
2350 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2351 WARN("LINUX_VERSION_CODE",
2352 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2355 # check for uses of printk_ratelimit
2356 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2357 WARN("PRINTK_RATELIMITED",
2358 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2361 # printk should use KERN_* levels. Note that follow on printk's on the
2362 # same line do not need a level, so we use the current block context
2363 # to try and find and validate the current printk. In summary the current
2364 # printk includes all preceding printk's which have no newline on the end.
2365 # we assume the first bad printk is the one to report.
2366 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2367 my $ok = 0;
2368 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2369 #print "CHECK<$lines[$ln - 1]\n";
2370 # we have a preceding printk if it ends
2371 # with "\n" ignore it, else it is to blame
2372 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2373 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2374 $ok = 1;
2376 last;
2379 if ($ok == 0) {
2380 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2381 "printk() should include KERN_ facility level\n" . $herecurr);
2385 if ($line =~ /\bprintk\s*\(\s*KERN_([A-Z]+)/) {
2386 my $orig = $1;
2387 my $level = lc($orig);
2388 $level = "warn" if ($level eq "warning");
2389 WARN("PREFER_PR_LEVEL",
2390 "Prefer pr_$level(... to printk(KERN_$1, ...\n" . $herecurr);
2393 if ($line =~ /\bpr_warning\s*\(/) {
2394 WARN("PREFER_PR_LEVEL",
2395 "Prefer pr_warn(... to pr_warning(...\n" . $herecurr);
2398 # function brace can't be on same line, except for #defines of do while,
2399 # or if closed on same line
2400 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2401 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2402 ERROR("OPEN_BRACE",
2403 "open brace '{' following function declarations go on the next line\n" . $herecurr);
2406 # open braces for enum, union and struct go on the same line.
2407 if ($line =~ /^.\s*{/ &&
2408 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2409 ERROR("OPEN_BRACE",
2410 "open brace '{' following $1 go on the same line\n" . $hereprev);
2413 # missing space after union, struct or enum definition
2414 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2415 WARN("SPACING",
2416 "missing space after $1 definition\n" . $herecurr);
2419 # check for spacing round square brackets; allowed:
2420 # 1. with a type on the left -- int [] a;
2421 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2422 # 3. inside a curly brace -- = { [0...10] = 5 }
2423 while ($line =~ /(.*?\s)\[/g) {
2424 my ($where, $prefix) = ($-[1], $1);
2425 if ($prefix !~ /$Type\s+$/ &&
2426 ($where != 0 || $prefix !~ /^.\s+$/) &&
2427 $prefix !~ /[{,]\s+$/) {
2428 ERROR("BRACKET_SPACE",
2429 "space prohibited before open square bracket '['\n" . $herecurr);
2433 # check for spaces between functions and their parentheses.
2434 while ($line =~ /($Ident)\s+\(/g) {
2435 my $name = $1;
2436 my $ctx_before = substr($line, 0, $-[1]);
2437 my $ctx = "$ctx_before$name";
2439 # Ignore those directives where spaces _are_ permitted.
2440 if ($name =~ /^(?:
2441 if|for|while|switch|return|case|
2442 volatile|__volatile__|
2443 __attribute__|format|__extension__|
2444 asm|__asm__)$/x)
2447 # cpp #define statements have non-optional spaces, ie
2448 # if there is a space between the name and the open
2449 # parenthesis it is simply not a parameter group.
2450 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2452 # cpp #elif statement condition may start with a (
2453 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2455 # If this whole things ends with a type its most
2456 # likely a typedef for a function.
2457 } elsif ($ctx =~ /$Type$/) {
2459 } else {
2460 WARN("SPACING",
2461 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
2465 # check for whitespace before a non-naked semicolon
2466 if ($line =~ /^\+.*\S\s+;/) {
2467 CHK("SPACING",
2468 "space prohibited before semicolon\n" . $herecurr);
2471 # Check operator spacing.
2472 if (!($line=~/\#\s*include/)) {
2473 my $ops = qr{
2474 <<=|>>=|<=|>=|==|!=|
2475 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2476 =>|->|<<|>>|<|>|=|!|~|
2477 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2478 \?|:
2480 my @elements = split(/($ops|;)/, $opline);
2481 my $off = 0;
2483 my $blank = copy_spacing($opline);
2485 for (my $n = 0; $n < $#elements; $n += 2) {
2486 $off += length($elements[$n]);
2488 # Pick up the preceding and succeeding characters.
2489 my $ca = substr($opline, 0, $off);
2490 my $cc = '';
2491 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2492 $cc = substr($opline, $off + length($elements[$n + 1]));
2494 my $cb = "$ca$;$cc";
2496 my $a = '';
2497 $a = 'V' if ($elements[$n] ne '');
2498 $a = 'W' if ($elements[$n] =~ /\s$/);
2499 $a = 'C' if ($elements[$n] =~ /$;$/);
2500 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2501 $a = 'O' if ($elements[$n] eq '');
2502 $a = 'E' if ($ca =~ /^\s*$/);
2504 my $op = $elements[$n + 1];
2506 my $c = '';
2507 if (defined $elements[$n + 2]) {
2508 $c = 'V' if ($elements[$n + 2] ne '');
2509 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2510 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2511 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2512 $c = 'O' if ($elements[$n + 2] eq '');
2513 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2514 } else {
2515 $c = 'E';
2518 my $ctx = "${a}x${c}";
2520 my $at = "(ctx:$ctx)";
2522 my $ptr = substr($blank, 0, $off) . "^";
2523 my $hereptr = "$hereline$ptr\n";
2525 # Pull out the value of this operator.
2526 my $op_type = substr($curr_values, $off + 1, 1);
2528 # Get the full operator variant.
2529 my $opv = $op . substr($curr_vars, $off, 1);
2531 # Ignore operators passed as parameters.
2532 if ($op_type ne 'V' &&
2533 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2535 # # Ignore comments
2536 # } elsif ($op =~ /^$;+$/) {
2538 # ; should have either the end of line or a space or \ after it
2539 } elsif ($op eq ';') {
2540 if ($ctx !~ /.x[WEBC]/ &&
2541 $cc !~ /^\\/ && $cc !~ /^;/) {
2542 ERROR("SPACING",
2543 "space required after that '$op' $at\n" . $hereptr);
2546 # // is a comment
2547 } elsif ($op eq '//') {
2549 # No spaces for:
2550 # ->
2551 # : when part of a bitfield
2552 } elsif ($op eq '->' || $opv eq ':B') {
2553 if ($ctx =~ /Wx.|.xW/) {
2554 ERROR("SPACING",
2555 "spaces prohibited around that '$op' $at\n" . $hereptr);
2558 # , must have a space on the right.
2559 } elsif ($op eq ',') {
2560 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2561 ERROR("SPACING",
2562 "space required after that '$op' $at\n" . $hereptr);
2565 # '*' as part of a type definition -- reported already.
2566 } elsif ($opv eq '*_') {
2567 #warn "'*' is part of type\n";
2569 # unary operators should have a space before and
2570 # none after. May be left adjacent to another
2571 # unary operator, or a cast
2572 } elsif ($op eq '!' || $op eq '~' ||
2573 $opv eq '*U' || $opv eq '-U' ||
2574 $opv eq '&U' || $opv eq '&&U') {
2575 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2576 ERROR("SPACING",
2577 "space required before that '$op' $at\n" . $hereptr);
2579 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2580 # A unary '*' may be const
2582 } elsif ($ctx =~ /.xW/) {
2583 ERROR("SPACING",
2584 "space prohibited after that '$op' $at\n" . $hereptr);
2587 # unary ++ and unary -- are allowed no space on one side.
2588 } elsif ($op eq '++' or $op eq '--') {
2589 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2590 ERROR("SPACING",
2591 "space required one side of that '$op' $at\n" . $hereptr);
2593 if ($ctx =~ /Wx[BE]/ ||
2594 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2595 ERROR("SPACING",
2596 "space prohibited before that '$op' $at\n" . $hereptr);
2598 if ($ctx =~ /ExW/) {
2599 ERROR("SPACING",
2600 "space prohibited after that '$op' $at\n" . $hereptr);
2604 # << and >> may either have or not have spaces both sides
2605 } elsif ($op eq '<<' or $op eq '>>' or
2606 $op eq '&' or $op eq '^' or $op eq '|' or
2607 $op eq '+' or $op eq '-' or
2608 $op eq '*' or $op eq '/' or
2609 $op eq '%')
2611 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2612 ERROR("SPACING",
2613 "need consistent spacing around '$op' $at\n" .
2614 $hereptr);
2617 # A colon needs no spaces before when it is
2618 # terminating a case value or a label.
2619 } elsif ($opv eq ':C' || $opv eq ':L') {
2620 if ($ctx =~ /Wx./) {
2621 ERROR("SPACING",
2622 "space prohibited before that '$op' $at\n" . $hereptr);
2625 # All the others need spaces both sides.
2626 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2627 my $ok = 0;
2629 # Ignore email addresses <foo@bar>
2630 if (($op eq '<' &&
2631 $cc =~ /^\S+\@\S+>/) ||
2632 ($op eq '>' &&
2633 $ca =~ /<\S+\@\S+$/))
2635 $ok = 1;
2638 # Ignore ?:
2639 if (($opv eq ':O' && $ca =~ /\?$/) ||
2640 ($op eq '?' && $cc =~ /^:/)) {
2641 $ok = 1;
2644 if ($ok == 0) {
2645 ERROR("SPACING",
2646 "spaces required around that '$op' $at\n" . $hereptr);
2649 $off += length($elements[$n + 1]);
2653 # check for multiple assignments
2654 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2655 CHK("MULTIPLE_ASSIGNMENTS",
2656 "multiple assignments should be avoided\n" . $herecurr);
2659 ## # check for multiple declarations, allowing for a function declaration
2660 ## # continuation.
2661 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2662 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2664 ## # Remove any bracketed sections to ensure we do not
2665 ## # falsly report the parameters of functions.
2666 ## my $ln = $line;
2667 ## while ($ln =~ s/\([^\(\)]*\)//g) {
2668 ## }
2669 ## if ($ln =~ /,/) {
2670 ## WARN("MULTIPLE_DECLARATION",
2671 ## "declaring multiple variables together should be avoided\n" . $herecurr);
2672 ## }
2673 ## }
2675 #need space before brace following if, while, etc
2676 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2677 $line =~ /do{/) {
2678 ERROR("SPACING",
2679 "space required before the open brace '{'\n" . $herecurr);
2682 # closing brace should have a space following it when it has anything
2683 # on the line
2684 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2685 ERROR("SPACING",
2686 "space required after that close brace '}'\n" . $herecurr);
2689 # check spacing on square brackets
2690 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2691 ERROR("SPACING",
2692 "space prohibited after that open square bracket '['\n" . $herecurr);
2694 if ($line =~ /\s\]/) {
2695 ERROR("SPACING",
2696 "space prohibited before that close square bracket ']'\n" . $herecurr);
2699 # check spacing on parentheses
2700 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2701 $line !~ /for\s*\(\s+;/) {
2702 ERROR("SPACING",
2703 "space prohibited after that open parenthesis '('\n" . $herecurr);
2705 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2706 $line !~ /for\s*\(.*;\s+\)/ &&
2707 $line !~ /:\s+\)/) {
2708 ERROR("SPACING",
2709 "space prohibited before that close parenthesis ')'\n" . $herecurr);
2712 #goto labels aren't indented, allow a single space however
2713 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2714 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2715 WARN("INDENTED_LABEL",
2716 "labels should not be indented\n" . $herecurr);
2719 # Return is not a function.
2720 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2721 my $spacing = $1;
2722 my $value = $2;
2724 # Flatten any parentheses
2725 $value =~ s/\(/ \(/g;
2726 $value =~ s/\)/\) /g;
2727 while ($value =~ s/\[[^\[\]]*\]/1/ ||
2728 $value !~ /(?:$Ident|-?$Constant)\s*
2729 $Compare\s*
2730 (?:$Ident|-?$Constant)/x &&
2731 $value =~ s/\([^\(\)]*\)/1/) {
2733 #print "value<$value>\n";
2734 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2735 ERROR("RETURN_PARENTHESES",
2736 "return is not a function, parentheses are not required\n" . $herecurr);
2738 } elsif ($spacing !~ /\s+/) {
2739 ERROR("SPACING",
2740 "space required before the open parenthesis '('\n" . $herecurr);
2743 # Return of what appears to be an errno should normally be -'ve
2744 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2745 my $name = $1;
2746 if ($name ne 'EOF' && $name ne 'ERROR') {
2747 WARN("USE_NEGATIVE_ERRNO",
2748 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2752 # Need a space before open parenthesis after if, while etc
2753 if ($line=~/\b(if|while|for|switch)\(/) {
2754 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
2757 # Check for illegal assignment in if conditional -- and check for trailing
2758 # statements after the conditional.
2759 if ($line =~ /do\s*(?!{)/) {
2760 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2761 ctx_statement_block($linenr, $realcnt, 0)
2762 if (!defined $stat);
2763 my ($stat_next) = ctx_statement_block($line_nr_next,
2764 $remain_next, $off_next);
2765 $stat_next =~ s/\n./\n /g;
2766 ##print "stat<$stat> stat_next<$stat_next>\n";
2768 if ($stat_next =~ /^\s*while\b/) {
2769 # If the statement carries leading newlines,
2770 # then count those as offsets.
2771 my ($whitespace) =
2772 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2773 my $offset =
2774 statement_rawlines($whitespace) - 1;
2776 $suppress_whiletrailers{$line_nr_next +
2777 $offset} = 1;
2780 if (!defined $suppress_whiletrailers{$linenr} &&
2781 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2782 my ($s, $c) = ($stat, $cond);
2784 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2785 ERROR("ASSIGN_IN_IF",
2786 "do not use assignment in if condition\n" . $herecurr);
2789 # Find out what is on the end of the line after the
2790 # conditional.
2791 substr($s, 0, length($c), '');
2792 $s =~ s/\n.*//g;
2793 $s =~ s/$;//g; # Remove any comments
2794 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2795 $c !~ /}\s*while\s*/)
2797 # Find out how long the conditional actually is.
2798 my @newlines = ($c =~ /\n/gs);
2799 my $cond_lines = 1 + $#newlines;
2800 my $stat_real = '';
2802 $stat_real = raw_line($linenr, $cond_lines)
2803 . "\n" if ($cond_lines);
2804 if (defined($stat_real) && $cond_lines > 1) {
2805 $stat_real = "[...]\n$stat_real";
2808 ERROR("TRAILING_STATEMENTS",
2809 "trailing statements should be on next line\n" . $herecurr . $stat_real);
2813 # Check for bitwise tests written as boolean
2814 if ($line =~ /
2816 (?:\[|\(|\&\&|\|\|)
2817 \s*0[xX][0-9]+\s*
2818 (?:\&\&|\|\|)
2820 (?:\&\&|\|\|)
2821 \s*0[xX][0-9]+\s*
2822 (?:\&\&|\|\||\)|\])
2823 )/x)
2825 WARN("HEXADECIMAL_BOOLEAN_TEST",
2826 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2829 # if and else should not have general statements after it
2830 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2831 my $s = $1;
2832 $s =~ s/$;//g; # Remove any comments
2833 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2834 ERROR("TRAILING_STATEMENTS",
2835 "trailing statements should be on next line\n" . $herecurr);
2838 # if should not continue a brace
2839 if ($line =~ /}\s*if\b/) {
2840 ERROR("TRAILING_STATEMENTS",
2841 "trailing statements should be on next line\n" .
2842 $herecurr);
2844 # case and default should not have general statements after them
2845 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2846 $line !~ /\G(?:
2847 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2848 \s*return\s+
2849 )/xg)
2851 ERROR("TRAILING_STATEMENTS",
2852 "trailing statements should be on next line\n" . $herecurr);
2855 # Check for }<nl>else {, these must be at the same
2856 # indent level to be relevant to each other.
2857 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2858 $previndent == $indent) {
2859 ERROR("ELSE_AFTER_BRACE",
2860 "else should follow close brace '}'\n" . $hereprev);
2863 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2864 $previndent == $indent) {
2865 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2867 # Find out what is on the end of the line after the
2868 # conditional.
2869 substr($s, 0, length($c), '');
2870 $s =~ s/\n.*//g;
2872 if ($s =~ /^\s*;/) {
2873 ERROR("WHILE_AFTER_BRACE",
2874 "while should follow close brace '}'\n" . $hereprev);
2878 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2879 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2880 # print "No studly caps, use _\n";
2881 # print "$herecurr";
2882 # $clean = 0;
2885 #no spaces allowed after \ in define
2886 if ($line=~/\#\s*define.*\\\s$/) {
2887 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2888 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
2891 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2892 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2893 my $file = "$1.h";
2894 my $checkfile = "include/linux/$file";
2895 if (-f "$root/$checkfile" &&
2896 $realfile ne $checkfile &&
2897 $1 !~ /$allowed_asm_includes/)
2899 if ($realfile =~ m{^arch/}) {
2900 CHK("ARCH_INCLUDE_LINUX",
2901 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2902 } else {
2903 WARN("INCLUDE_LINUX",
2904 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2909 # multi-statement macros should be enclosed in a do while loop, grab the
2910 # first statement and ensure its the whole macro if its not enclosed
2911 # in a known good container
2912 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2913 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2914 my $ln = $linenr;
2915 my $cnt = $realcnt;
2916 my ($off, $dstat, $dcond, $rest);
2917 my $ctx = '';
2918 ($dstat, $dcond, $ln, $cnt, $off) =
2919 ctx_statement_block($linenr, $realcnt, 0);
2920 $ctx = $dstat;
2921 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2922 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2924 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
2925 $dstat =~ s/$;//g;
2926 $dstat =~ s/\\\n.//g;
2927 $dstat =~ s/^\s*//s;
2928 $dstat =~ s/\s*$//s;
2930 # Flatten any parentheses and braces
2931 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2932 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2933 $dstat =~ s/\[[^\[\]]*\]/1/)
2937 # Flatten any obvious string concatentation.
2938 while ($dstat =~ s/("X*")\s*$Ident/$1/ ||
2939 $dstat =~ s/$Ident\s*("X*")/$1/)
2943 my $exceptions = qr{
2944 $Declare|
2945 module_param_named|
2946 MODULE_PARAM_DESC|
2947 DECLARE_PER_CPU|
2948 DEFINE_PER_CPU|
2949 __typeof__\(|
2950 union|
2951 struct|
2952 \.$Ident\s*=\s*|
2953 ^\"|\"$
2955 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2956 if ($dstat ne '' &&
2957 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
2958 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
2959 $dstat !~ /^[!~-]?(?:$Ident|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo
2960 $dstat !~ /^'X'$/ && # character constants
2961 $dstat !~ /$exceptions/ &&
2962 $dstat !~ /^\.$Ident\s*=/ && # .foo =
2963 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
2964 $dstat !~ /^for\s*$Constant$/ && # for (...)
2965 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
2966 $dstat !~ /^do\s*{/ && # do {...
2967 $dstat !~ /^\({/) # ({...
2969 $ctx =~ s/\n*$//;
2970 my $herectx = $here . "\n";
2971 my $cnt = statement_rawlines($ctx);
2973 for (my $n = 0; $n < $cnt; $n++) {
2974 $herectx .= raw_line($linenr, $n) . "\n";
2977 if ($dstat =~ /;/) {
2978 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
2979 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
2980 } else {
2981 ERROR("COMPLEX_MACRO",
2982 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
2987 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2988 # all assignments may have only one of the following with an assignment:
2990 # ALIGN(...)
2991 # VMLINUX_SYMBOL(...)
2992 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2993 WARN("MISSING_VMLINUX_SYMBOL",
2994 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2997 # check for redundant bracing round if etc
2998 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2999 my ($level, $endln, @chunks) =
3000 ctx_statement_full($linenr, $realcnt, 1);
3001 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3002 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3003 if ($#chunks > 0 && $level == 0) {
3004 my @allowed = ();
3005 my $allow = 0;
3006 my $seen = 0;
3007 my $herectx = $here . "\n";
3008 my $ln = $linenr - 1;
3009 for my $chunk (@chunks) {
3010 my ($cond, $block) = @{$chunk};
3012 # If the condition carries leading newlines, then count those as offsets.
3013 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3014 my $offset = statement_rawlines($whitespace) - 1;
3016 $allowed[$allow] = 0;
3017 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3019 # We have looked at and allowed this specific line.
3020 $suppress_ifbraces{$ln + $offset} = 1;
3022 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
3023 $ln += statement_rawlines($block) - 1;
3025 substr($block, 0, length($cond), '');
3027 $seen++ if ($block =~ /^\s*{/);
3029 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3030 if (statement_lines($cond) > 1) {
3031 #print "APW: ALLOWED: cond<$cond>\n";
3032 $allowed[$allow] = 1;
3034 if ($block =~/\b(?:if|for|while)\b/) {
3035 #print "APW: ALLOWED: block<$block>\n";
3036 $allowed[$allow] = 1;
3038 if (statement_block_size($block) > 1) {
3039 #print "APW: ALLOWED: lines block<$block>\n";
3040 $allowed[$allow] = 1;
3042 $allow++;
3044 if ($seen) {
3045 my $sum_allowed = 0;
3046 foreach (@allowed) {
3047 $sum_allowed += $_;
3049 if ($sum_allowed == 0) {
3050 WARN("BRACES",
3051 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3052 } elsif ($sum_allowed != $allow &&
3053 $seen != $allow) {
3054 CHK("BRACES",
3055 "braces {} should be used on all arms of this statement\n" . $herectx);
3060 if (!defined $suppress_ifbraces{$linenr - 1} &&
3061 $line =~ /\b(if|while|for|else)\b/) {
3062 my $allowed = 0;
3064 # Check the pre-context.
3065 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3066 #print "APW: ALLOWED: pre<$1>\n";
3067 $allowed = 1;
3070 my ($level, $endln, @chunks) =
3071 ctx_statement_full($linenr, $realcnt, $-[0]);
3073 # Check the condition.
3074 my ($cond, $block) = @{$chunks[0]};
3075 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3076 if (defined $cond) {
3077 substr($block, 0, length($cond), '');
3079 if (statement_lines($cond) > 1) {
3080 #print "APW: ALLOWED: cond<$cond>\n";
3081 $allowed = 1;
3083 if ($block =~/\b(?:if|for|while)\b/) {
3084 #print "APW: ALLOWED: block<$block>\n";
3085 $allowed = 1;
3087 if (statement_block_size($block) > 1) {
3088 #print "APW: ALLOWED: lines block<$block>\n";
3089 $allowed = 1;
3091 # Check the post-context.
3092 if (defined $chunks[1]) {
3093 my ($cond, $block) = @{$chunks[1]};
3094 if (defined $cond) {
3095 substr($block, 0, length($cond), '');
3097 if ($block =~ /^\s*\{/) {
3098 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3099 $allowed = 1;
3102 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3103 my $herectx = $here . "\n";
3104 my $cnt = statement_rawlines($block);
3106 for (my $n = 0; $n < $cnt; $n++) {
3107 $herectx .= raw_line($linenr, $n) . "\n";
3110 WARN("BRACES",
3111 "braces {} are not necessary for single statement blocks\n" . $herectx);
3115 # don't include deprecated include files (uses RAW line)
3116 for my $inc (@dep_includes) {
3117 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
3118 ERROR("DEPRECATED_INCLUDE",
3119 "Don't use <$inc>: see Documentation/feature-removal-schedule.txt\n" . $herecurr);
3123 # don't use deprecated functions
3124 for my $func (@dep_functions) {
3125 if ($line =~ /\b$func\b/) {
3126 ERROR("DEPRECATED_FUNCTION",
3127 "Don't use $func(): see Documentation/feature-removal-schedule.txt\n" . $herecurr);
3131 # no volatiles please
3132 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3133 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3134 WARN("VOLATILE",
3135 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3138 # warn about #if 0
3139 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3140 CHK("REDUNDANT_CODE",
3141 "if this code is redundant consider removing it\n" .
3142 $herecurr);
3145 # check for needless kfree() checks
3146 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3147 my $expr = $1;
3148 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
3149 WARN("NEEDLESS_KFREE",
3150 "kfree(NULL) is safe this check is probably not required\n" . $hereprev);
3153 # check for needless usb_free_urb() checks
3154 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3155 my $expr = $1;
3156 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
3157 WARN("NEEDLESS_USB_FREE_URB",
3158 "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
3162 # prefer usleep_range over udelay
3163 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3164 # ignore udelay's < 10, however
3165 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
3166 CHK("USLEEP_RANGE",
3167 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3171 # warn about unexpectedly long msleep's
3172 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3173 if ($1 < 20) {
3174 WARN("MSLEEP",
3175 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3179 # warn about #ifdefs in C files
3180 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3181 # print "#ifdef in C files should be avoided\n";
3182 # print "$herecurr";
3183 # $clean = 0;
3186 # warn about spacing in #ifdefs
3187 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3188 ERROR("SPACING",
3189 "exactly one space required after that #$1\n" . $herecurr);
3192 # check for spinlock_t definitions without a comment.
3193 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3194 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3195 my $which = $1;
3196 if (!ctx_has_comment($first_line, $linenr)) {
3197 CHK("UNCOMMENTED_DEFINITION",
3198 "$1 definition without comment\n" . $herecurr);
3201 # check for memory barriers without a comment.
3202 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3203 if (!ctx_has_comment($first_line, $linenr)) {
3204 CHK("MEMORY_BARRIER",
3205 "memory barrier without comment\n" . $herecurr);
3208 # check of hardware specific defines
3209 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3210 CHK("ARCH_DEFINES",
3211 "architecture specific defines should be avoided\n" . $herecurr);
3214 # Check that the storage class is at the beginning of a declaration
3215 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3216 WARN("STORAGE_CLASS",
3217 "storage class should be at the beginning of the declaration\n" . $herecurr)
3220 # check the location of the inline attribute, that it is between
3221 # storage class and type.
3222 if ($line =~ /\b$Type\s+$Inline\b/ ||
3223 $line =~ /\b$Inline\s+$Storage\b/) {
3224 ERROR("INLINE_LOCATION",
3225 "inline keyword should sit between storage class and type\n" . $herecurr);
3228 # Check for __inline__ and __inline, prefer inline
3229 if ($line =~ /\b(__inline__|__inline)\b/) {
3230 WARN("INLINE",
3231 "plain inline is preferred over $1\n" . $herecurr);
3234 # Check for __attribute__ packed, prefer __packed
3235 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3236 WARN("PREFER_PACKED",
3237 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3240 # Check for __attribute__ aligned, prefer __aligned
3241 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3242 WARN("PREFER_ALIGNED",
3243 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3246 # Check for __attribute__ format(printf, prefer __printf
3247 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3248 WARN("PREFER_PRINTF",
3249 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3252 # Check for __attribute__ format(scanf, prefer __scanf
3253 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\b/) {
3254 WARN("PREFER_SCANF",
3255 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr);
3258 # check for sizeof(&)
3259 if ($line =~ /\bsizeof\s*\(\s*\&/) {
3260 WARN("SIZEOF_ADDRESS",
3261 "sizeof(& should be avoided\n" . $herecurr);
3264 # check for line continuations in quoted strings with odd counts of "
3265 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3266 WARN("LINE_CONTINUATIONS",
3267 "Avoid line continuations in quoted strings\n" . $herecurr);
3270 # Check for misused memsets
3271 if ($^V && $^V ge 5.10.0 &&
3272 defined $stat &&
3273 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
3275 my $ms_addr = $2;
3276 my $ms_val = $7;
3277 my $ms_size = $12;
3279 if ($ms_size =~ /^(0x|)0$/i) {
3280 ERROR("MEMSET",
3281 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3282 } elsif ($ms_size =~ /^(0x|)1$/i) {
3283 WARN("MEMSET",
3284 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3288 # typecasts on min/max could be min_t/max_t
3289 if ($^V && $^V ge 5.10.0 &&
3290 defined $stat &&
3291 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3292 if (defined $2 || defined $7) {
3293 my $call = $1;
3294 my $cast1 = deparenthesize($2);
3295 my $arg1 = $3;
3296 my $cast2 = deparenthesize($7);
3297 my $arg2 = $8;
3298 my $cast;
3300 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) {
3301 $cast = "$cast1 or $cast2";
3302 } elsif ($cast1 ne "") {
3303 $cast = $cast1;
3304 } else {
3305 $cast = $cast2;
3307 WARN("MINMAX",
3308 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
3312 # check for new externs in .c files.
3313 if ($realfile =~ /\.c$/ && defined $stat &&
3314 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3316 my $function_name = $1;
3317 my $paren_space = $2;
3319 my $s = $stat;
3320 if (defined $cond) {
3321 substr($s, 0, length($cond), '');
3323 if ($s =~ /^\s*;/ &&
3324 $function_name ne 'uninitialized_var')
3326 WARN("AVOID_EXTERNS",
3327 "externs should be avoided in .c files\n" . $herecurr);
3330 if ($paren_space =~ /\n/) {
3331 WARN("FUNCTION_ARGUMENTS",
3332 "arguments for function declarations should follow identifier\n" . $herecurr);
3335 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3336 $stat =~ /^.\s*extern\s+/)
3338 WARN("AVOID_EXTERNS",
3339 "externs should be avoided in .c files\n" . $herecurr);
3342 # checks for new __setup's
3343 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3344 my $name = $1;
3346 if (!grep(/$name/, @setup_docs)) {
3347 CHK("UNDOCUMENTED_SETUP",
3348 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3352 # check for pointless casting of kmalloc return
3353 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
3354 WARN("UNNECESSARY_CASTS",
3355 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
3358 # check for multiple semicolons
3359 if ($line =~ /;\s*;\s*$/) {
3360 WARN("ONE_SEMICOLON",
3361 "Statements terminations use 1 semicolon\n" . $herecurr);
3364 # check for gcc specific __FUNCTION__
3365 if ($line =~ /__FUNCTION__/) {
3366 WARN("USE_FUNC",
3367 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
3370 # check for use of yield()
3371 if ($line =~ /\byield\s*\(\s*\)/) {
3372 WARN("YIELD",
3373 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr);
3376 # check for semaphores initialized locked
3377 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
3378 WARN("CONSIDER_COMPLETION",
3379 "consider using a completion\n" . $herecurr);
3382 # recommend kstrto* over simple_strto* and strict_strto*
3383 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
3384 WARN("CONSIDER_KSTRTO",
3385 "$1 is obsolete, use k$3 instead\n" . $herecurr);
3388 # check for __initcall(), use device_initcall() explicitly please
3389 if ($line =~ /^.\s*__initcall\s*\(/) {
3390 WARN("USE_DEVICE_INITCALL",
3391 "please use device_initcall() instead of __initcall()\n" . $herecurr);
3394 # check for various ops structs, ensure they are const.
3395 my $struct_ops = qr{acpi_dock_ops|
3396 address_space_operations|
3397 backlight_ops|
3398 block_device_operations|
3399 dentry_operations|
3400 dev_pm_ops|
3401 dma_map_ops|
3402 extent_io_ops|
3403 file_lock_operations|
3404 file_operations|
3405 hv_ops|
3406 ide_dma_ops|
3407 intel_dvo_dev_ops|
3408 item_operations|
3409 iwl_ops|
3410 kgdb_arch|
3411 kgdb_io|
3412 kset_uevent_ops|
3413 lock_manager_operations|
3414 microcode_ops|
3415 mtrr_ops|
3416 neigh_ops|
3417 nlmsvc_binding|
3418 pci_raw_ops|
3419 pipe_buf_operations|
3420 platform_hibernation_ops|
3421 platform_suspend_ops|
3422 proto_ops|
3423 rpc_pipe_ops|
3424 seq_operations|
3425 snd_ac97_build_ops|
3426 soc_pcmcia_socket_ops|
3427 stacktrace_ops|
3428 sysfs_ops|
3429 tty_operations|
3430 usb_mon_operations|
3431 wd_ops}x;
3432 if ($line !~ /\bconst\b/ &&
3433 $line =~ /\bstruct\s+($struct_ops)\b/) {
3434 WARN("CONST_STRUCT",
3435 "struct $1 should normally be const\n" .
3436 $herecurr);
3439 # use of NR_CPUS is usually wrong
3440 # ignore definitions of NR_CPUS and usage to define arrays as likely right
3441 if ($line =~ /\bNR_CPUS\b/ &&
3442 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3443 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
3444 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3445 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3446 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
3448 WARN("NR_CPUS",
3449 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
3452 # check for %L{u,d,i} in strings
3453 my $string;
3454 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3455 $string = substr($rawline, $-[1], $+[1] - $-[1]);
3456 $string =~ s/%%/__/g;
3457 if ($string =~ /(?<!%)%L[udi]/) {
3458 WARN("PRINTF_L",
3459 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
3460 last;
3464 # whine mightly about in_atomic
3465 if ($line =~ /\bin_atomic\s*\(/) {
3466 if ($realfile =~ m@^drivers/@) {
3467 ERROR("IN_ATOMIC",
3468 "do not use in_atomic in drivers\n" . $herecurr);
3469 } elsif ($realfile !~ m@^kernel/@) {
3470 WARN("IN_ATOMIC",
3471 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
3475 # check for lockdep_set_novalidate_class
3476 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3477 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3478 if ($realfile !~ m@^kernel/lockdep@ &&
3479 $realfile !~ m@^include/linux/lockdep@ &&
3480 $realfile !~ m@^drivers/base/core@) {
3481 ERROR("LOCKDEP",
3482 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
3486 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3487 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
3488 WARN("EXPORTED_WORLD_WRITABLE",
3489 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
3493 # If we have no input at all, then there is nothing to report on
3494 # so just keep quiet.
3495 if ($#rawlines == -1) {
3496 exit(0);
3499 # In mailback mode only produce a report in the negative, for
3500 # things that appear to be patches.
3501 if ($mailback && ($clean == 1 || !$is_patch)) {
3502 exit(0);
3505 # This is not a patch, and we are are in 'no-patch' mode so
3506 # just keep quiet.
3507 if (!$chk_patch && !$is_patch) {
3508 exit(0);
3511 if (!$is_patch) {
3512 ERROR("NOT_UNIFIED_DIFF",
3513 "Does not appear to be a unified-diff format patch\n");
3515 if ($is_patch && $chk_signoff && $signoff == 0) {
3516 ERROR("MISSING_SIGN_OFF",
3517 "Missing Signed-off-by: line(s)\n");
3520 print report_dump();
3521 if ($summary && !($clean == 1 && $quiet == 1)) {
3522 print "$filename " if ($summary_file);
3523 print "total: $cnt_error errors, $cnt_warn warnings, " .
3524 (($check)? "$cnt_chk checks, " : "") .
3525 "$cnt_lines lines checked\n";
3526 print "\n" if ($quiet == 0);
3529 if ($quiet == 0) {
3531 if ($^V lt 5.10.0) {
3532 print("NOTE: perl $^V is not modern enough to detect all possible issues.\n");
3533 print("An upgrade to at least perl v5.10.0 is suggested.\n\n");
3536 # If there were whitespace errors which cleanpatch can fix
3537 # then suggest that.
3538 if ($rpt_cleaners) {
3539 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3540 print " scripts/cleanfile\n\n";
3541 $rpt_cleaners = 0;
3545 if ($quiet == 0 && keys %ignore_type) {
3546 print "NOTE: Ignored message types:";
3547 foreach my $ignore (sort keys %ignore_type) {
3548 print " $ignore";
3550 print "\n\n";
3553 if ($clean == 1 && $quiet == 0) {
3554 print "$vname has no obvious style problems and is ready for submission.\n"
3556 if ($clean == 0 && $quiet == 0) {
3557 print << "EOM";
3558 $vname has style problems, please review.
3560 If any of these errors are false positives, please report
3561 them to the maintainer, see CHECKPATCH in MAINTAINERS.
3565 return $clean;