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 # Based on linux/scripts/checkpatch.pl from 2.6.38 but uses Lustre
9 # specific deprecated symbol/functions/include lists rather than
10 # Documentation/feature-removal-schedule.txt.
19 use Getopt::Long qw(:config no_auto_abbrev);
39 my $configuration_file = ".checkpatch.conf";
45 Usage: $P [OPTION]... [FILE]...
50 --no-tree run without a kernel tree
51 --no-signoff do not check for 'Signed-off-by' line
52 --patch treat FILE as patchfile (default)
53 --emacs emacs compile window format
54 --terse one line per report
55 -f, --file treat FILE as regular source file
56 --subjective, --strict enable more subjective tests
57 --ignore TYPE(,TYPE2...) ignore various comma separated message types
58 --show-types show the message "types" in the output
59 --root=PATH PATH to the kernel tree root
60 --no-summary suppress the per-file summary
61 --mailback only produce a report in case of warnings/errors
62 --summary-file include the filename in summary
63 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of
64 'values', 'possible', 'type', and 'attr' (default
66 --test-only=WORD report only warnings/errors containing WORD
68 -h, --help, --version display this help and exit
70 When FILE is - read standard input.
76 my $conf = which_conf($configuration_file);
79 open(my $conffile, '<', "$conf")
80 or warn "$P: Can't find a readable $configuration_file file $!\n";
85 $line =~ s/\s*\n?$//g;
89 next if ($line =~ m/^\s*#/);
90 next if ($line =~ m/^\s*$/);
92 my @words = split(" ", $line);
93 foreach my $word (@words) {
94 last if ($word =~ m/^#/);
95 push (@conf_args, $word);
99 unshift(@ARGV, @conf_args) if @conf_args;
103 'q|quiet+' => \$quiet,
105 'signoff!' => \$chk_signoff,
106 'patch!' => \$chk_patch,
110 'subjective!' => \$check,
111 'strict!' => \$check,
112 'ignore=s' => \@ignore,
113 'show-types!' => \$show_types,
115 'summary!' => \$summary,
116 'mailback!' => \$mailback,
117 'summary-file!' => \$summary_file,
119 'debug=s' => \%debug,
120 'test-only=s' => \$tst_only,
130 print "$P: no input files\n";
134 @ignore = split(/,/, join(',',@ignore));
135 foreach my $word (@ignore) {
136 $word =~ s/\s*\n?$//g;
139 $word =~ tr/[a-z]/[A-Z]/;
141 next if ($word =~ m/^\s*#/);
142 next if ($word =~ m/^\s*$/);
144 $ignore_type{$word}++;
148 my $dbg_possible = 0;
151 for my $key (keys %debug) {
153 eval "\${dbg_$key} = '$debug{$key}';";
157 my $rpt_cleaners = 0;
166 if (!top_of_kernel_tree($root)) {
167 die "$P: $root: --root does not point at a valid tree\n";
170 if (top_of_kernel_tree('.')) {
172 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ &&
173 top_of_kernel_tree($1)) {
178 if (!defined $root) {
179 print "Must be run from the top-level dir. of a kernel tree\n";
184 my $emitted_corrupt = 0;
187 [A-Za-z_][A-Za-z\d_]*
188 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)*
190 our $Storage = qr{extern|static|asmlinkage};
203 # Notes to $Attribute:
204 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
223 __(?:mem|cpu|dev|)(?:initdata|initconst|init\b)|
224 ____cacheline_aligned|
225 ____cacheline_aligned_in_smp|
226 ____cacheline_internodealigned_in_smp|
230 our $Inline = qr{inline|__always_inline|noinline};
231 our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]};
232 our $Lval = qr{$Ident(?:$Member)*};
234 our $Constant = qr{(?i:(?:[0-9]+|0x[0-9a-f]+)[ul]*)};
235 our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)};
236 our $Compare = qr{<=|>=|==|!=|<|>};
240 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%
247 our $NON_ASCII_UTF8 = qr{
248 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte
249 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs
250 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte
251 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates
252 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3
253 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15
254 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16
258 [\x09\x0A\x0D\x20-\x7E] # ASCII
262 our $typeTypedefs = qr{(?x:
263 (?:__)?(?:u|s|be|le)(?:8|16|32|64)|
267 our $logFunctions = qr{(?x:
268 printk(?:_ratelimited|_once|)|
269 [a-z0-9]+_(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
270 WARN(?:_RATELIMIT|_ONCE|)|
275 our $signature_tags = qr{(?xi:
287 qr{(?:unsigned\s+)?char},
288 qr{(?:unsigned\s+)?short},
289 qr{(?:unsigned\s+)?int},
290 qr{(?:unsigned\s+)?long},
291 qr{(?:unsigned\s+)?long\s+int},
292 qr{(?:unsigned\s+)?long\s+long},
293 qr{(?:unsigned\s+)?long\s+long\s+int},
302 qr{${Ident}_handler},
303 qr{${Ident}_handler_fn},
305 our @modifierList = (
309 our $allowed_asm_includes = qr{(?x:
313 # memory.h: ARM has a custom one
316 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)";
317 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)";
318 $Modifier = qr{(?:$Attribute|$Sparse|$mods)};
320 (?:$Modifier\s+|const\s+)*
322 (?:typeof|__typeof__)\s*\([^\)]*\)|
326 (?:\s+$Modifier|\s+const)*
330 (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)?
331 (?:\s+$Inline|\s+$Modifier)*
333 $Declare = qr{(?:$Storage\s+)?$Type};
337 our $match_balanced_parentheses = qr/(\((?:[^\(\)]+|(-1))*\))/;
339 our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*};
340 our $LvalOrFunc = qr{($Lval)\s*($match_balanced_parentheses{0,1})\s*};
341 our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant)};
345 return "" if (!defined($string));
346 $string =~ s@^\s*\(\s*@@g;
347 $string =~ s@\s*\)\s*$@@g;
348 $string =~ s@\s+@ @g;
352 $chk_signoff = 0 if ($file);
355 'asm/types.h', 'linux/types.h',
356 'asm/uaccess.h', 'linux/uaccess.h',
359 my %dep_functions = (
361 'CFS_ATOMIC_INIT', 'ATOMIC_INIT',
362 'cfs_atomic_add', 'atomic_add',
363 'cfs_atomic_add_return', 'atomic_add_return',
364 'cfs_atomic_add_unless', 'atomic_add_unless',
365 'cfs_atomic_cmpxchg', 'atomic_cmpxchg',
366 'cfs_atomic_dec', 'atomic_dec',
367 'cfs_atomic_dec_and_lock', 'atomic_dec_and_lock',
368 'cfs_atomic_dec_and_test', 'atomic_dec_and_test',
369 'cfs_atomic_dec_return', 'atomic_dec_return',
370 'cfs_atomic_inc', 'atomic_inc',
371 'cfs_atomic_inc_and_test', 'atomic_inc_and_test',
372 'cfs_atomic_inc_not_zero', 'atomic_inc_not_zero',
373 'cfs_atomic_inc_return', 'atomic_inc_return',
374 'cfs_atomic_read', 'atomic_read',
375 'cfs_atomic_set', 'atomic_set',
376 'cfs_atomic_sub', 'atomic_sub',
377 'cfs_atomic_sub_and_test', 'atomic_sub_and_test',
378 'cfs_atomic_sub_return', 'atomic_sub_return',
379 'cfs_atomic_t', 'atomic_t',
381 'CFS_HLIST_HEAD', 'HLIST_HEAD',
382 'CFS_HLIST_HEAD_INIT', 'HLIST_HEAD_INIT',
383 'CFS_INIT_HLIST_HEAD', 'INIT_HLIST_HEAD',
384 'CFS_INIT_HLIST_NODE', 'INIT_HLIST_NODE',
385 'cfs_hlist_add_after', 'hlist_add_after',
386 'cfs_hlist_add_before', 'hlist_add_before',
387 'cfs_hlist_add_head', 'hlist_add_head',
388 'cfs_hlist_del', 'hlist_del',
389 'cfs_hlist_del_init', 'hlist_del_init',
390 'cfs_hlist_empty', 'hlist_empty',
391 'cfs_hlist_entry', 'hlist_entry',
392 'cfs_hlist_for_each', 'hlist_for_each',
393 'cfs_hlist_for_each_safe', 'hlist_for_each_safe',
394 'cfs_hlist_head_t', 'struct hlist_head',
395 'cfs_hlist_node_t', 'struct hlist_node',
396 'cfs_hlist_unhashed', 'hlist_unhashed',
398 'cfs_inode_t', 'struct inode',
400 'CFS_INIT_LIST_HEAD', 'INIT_LIST_HEAD',
401 'CFS_LIST_HEAD', 'struct list_head foo = LIST_HEAD_INIT(foo);',
402 'CFS_LIST_HEAD_INIT', 'LIST_HEAD_INIT',
403 'cfs_list_add', 'list_add',
404 'cfs_list_add_tail', 'list_add_tail',
405 'cfs_list_del', 'list_del',
406 'cfs_list_del_init', 'list_del_init',
407 'cfs_list_empty', 'list_empty',
408 'cfs_list_empty_careful', 'list_empty_careful',
409 'cfs_list_entry', 'list_entry',
410 'cfs_list_for_each', 'list_for_each',
411 'cfs_list_for_each_entry', 'list_for_each_entry',
412 'cfs_list_for_each_entry_continue',
413 'list_for_each_entry_continue',
414 'cfs_list_for_each_entry_reverse',
415 'list_for_each_entry_reverse',
416 'cfs_list_for_each_entry_safe',
417 'list_for_each_entry_safe',
418 'cfs_list_for_each_entry_safe_from',
419 'list_for_each_entry_safe_from',
420 'cfs_list_for_each_entry_safe_reverse',
421 'list_for_each_entry_safe_reverse',
422 'cfs_list_for_each_entry_safe_typed',
423 'list_for_each_entry_safe_typed',
424 'cfs_list_for_each_entry_typed',
425 'list_for_each_entry_typed',
426 'cfs_list_for_each_prev', 'list_for_each_prev',
427 'cfs_list_for_each_safe', 'list_for_each_safe',
428 'cfs_list_move', 'list_move',
429 'cfs_list_move_tail', 'list_move_tail',
430 'cfs_list_splice', 'list_splice',
431 'cfs_list_splice_init', 'list_splice_init',
432 'cfs_list_splice_tail', 'list_splice_tail',
433 'cfs_list_t', 'struct list_head',
435 'CFS_PAGE_MASK', 'PAGE_CACHE_MASK or PAGE_MASK',
436 'CFS_PAGE_SIZE', 'PAGE_CACHE_SIZE or PAGE_SIZE',
438 'cfs_proc_dir_entry_t', 'struct proc_dir_entry',
440 'cfs_rcu_head_t', 'struct rcu_head',
442 'cfs_hash_lock_t', 'union cfs_hash_lock',
443 'cfs_hash_bucket_t', 'struct cfs_hash_bucket',
444 'cfs_hash_bd_t', 'struct cfs_hash_bd',
445 'cfs_hash_t', 'struct cfs_hash',
446 'cfs_hash_lock_ops_t', 'struct cfs_hash_lock_ops',
447 'cfs_hash_hlist_ops_t', 'struct cfs_hash_hlist_ops',
448 'cfs_hash_ops_t', 'struct cfs_hash_ops',
449 'cfs_hash_head_t', 'struct cfs_hash_head',
450 'cfs_hash_head_dep_t', 'struct cfs_hash_head_dep',
451 'cfs_hash_dhead_t', 'struct cfs_hash_dhead',
452 'cfs_hash_dhead_dep_t', 'struct cfs_hash_dhead_dep',
453 'cfs_hash_lookup_intent_t', 'enum cfs_hash_lookup_intent',
454 'cfs_hash_cond_arg_t', 'struct cfs_hash_cond_arg',
456 'ldlm_appetite_t', 'enum ldlm_appetite',
457 'ldlm_cancel_flags_t', 'enum ldlm_cancel_flags',
458 'ldlm_error_t', 'enum ldlm_error',
459 'ldlm_ns_hash_def_t', 'struct ldlm_ns_hash_def',
460 'ldlm_mode_t', 'enum ldlm_mode',
461 'ldlm_ns_type_t', 'enum ldlm_ns_type',
462 'ldlm_policy_data_t', 'enum ldlm_policy_data',
463 'ldlm_policy_res_t', 'enum ldlm_policy_res',
464 'ldlm_side_t', 'enum ldlm_side',
465 'ldlm_type_t', 'enum ldlm_type',
466 'ldlm_wire_policy_data_t', 'union ldlm_wire_policy_data',
468 'LPROCFS', 'CONFIG_PROC_FS',
470 'sprintf', 'snprintf',
473 'tempnam', 'mkstemp',
474 'f_dentry', 'f_path.dentry',
480 for my $filename (@ARGV) {
483 open($FILE, '-|', "diff -u /dev/null $filename") ||
484 die "$P: $filename: diff failed - $!\n";
485 } elsif ($filename eq '-') {
486 open($FILE, '<&STDIN');
488 open($FILE, '<', "$filename") ||
489 die "$P: $filename: open failed - $!\n";
491 if ($filename eq '-') {
492 $vname = 'Your patch';
501 if (!process($filename)) {
510 sub top_of_kernel_tree {
514 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
515 "README", "Documentation", "arch", "include", "drivers",
516 "fs", "init", "ipc", "kernel", "lib", "scripts",
519 foreach my $check (@tree_check) {
520 if (! -e $root . '/' . $check) {
528 my ($formatted_email) = @_;
534 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
537 $comment = $3 if defined $3;
538 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
540 $comment = $2 if defined $2;
541 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
543 $comment = $2 if defined $2;
544 $formatted_email =~ s/$address.*$//;
545 $name = $formatted_email;
546 $name =~ s/^\s+|\s+$//g;
547 $name =~ s/^\"|\"$//g;
548 # If there's a name left after stripping spaces and
549 # leading quotes, and the address doesn't have both
550 # leading and trailing angle brackets, the address
552 # "joe smith joe@smith.com" bad
553 # "joe smith <joe@smith.com" bad
554 if ($name ne "" && $address !~ /^<[^>]+>$/) {
561 $name =~ s/^\s+|\s+$//g;
562 $name =~ s/^\"|\"$//g;
563 $address =~ s/^\s+|\s+$//g;
564 $address =~ s/^\<|\>$//g;
566 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
567 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
571 return ($name, $address, $comment);
575 my ($name, $address) = @_;
579 $name =~ s/^\s+|\s+$//g;
580 $name =~ s/^\"|\"$//g;
581 $address =~ s/^\s+|\s+$//g;
583 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
584 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
589 $formatted_email = "$address";
591 $formatted_email = "$name <$address>";
594 return $formatted_email;
600 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
601 if (-e "$path/$conf") {
602 return "$path/$conf";
614 for my $c (split(//, $str)) {
618 for (; ($n % 8) != 0; $n++) {
630 (my $res = shift) =~ tr/\t/ /c;
637 # Drop the diff line leader and expand tabs
639 $line = expand_tabs($line);
641 # Pick the indent from the front of the line.
642 my ($white) = ($line =~ /^(\s*)/);
644 return (length($line), length($white));
647 my $sanitise_quote = '';
649 sub sanitise_line_reset {
650 my ($in_comment) = @_;
653 $sanitise_quote = '*/';
655 $sanitise_quote = '';
668 # Always copy over the diff marker.
669 $res = substr($line, 0, 1);
671 for ($off = 1; $off < length($line); $off++) {
672 $c = substr($line, $off, 1);
674 # Comments we are wacking completly including the begin
675 # and end, all to $;.
676 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
677 $sanitise_quote = '*/';
679 substr($res, $off, 2, "$;$;");
683 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
684 $sanitise_quote = '';
685 substr($res, $off, 2, "$;$;");
689 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
690 $sanitise_quote = '//';
692 substr($res, $off, 2, $sanitise_quote);
697 # A \ in a string means ignore the next character.
698 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
700 substr($res, $off, 2, 'XX');
705 if ($c eq "'" || $c eq '"') {
706 if ($sanitise_quote eq '') {
707 $sanitise_quote = $c;
709 substr($res, $off, 1, $c);
711 } elsif ($sanitise_quote eq $c) {
712 $sanitise_quote = '';
716 #print "c<$c> SQ<$sanitise_quote>\n";
717 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
718 substr($res, $off, 1, $;);
719 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
720 substr($res, $off, 1, $;);
721 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
722 substr($res, $off, 1, 'X');
724 substr($res, $off, 1, $c);
728 if ($sanitise_quote eq '//') {
729 $sanitise_quote = '';
732 # The pathname on a #include may be surrounded by '<' and '>'.
733 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
734 my $clean = 'X' x length($1);
735 $res =~ s@\<.*\>@<$clean>@;
737 # The whole of a #error is a string.
738 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
739 my $clean = 'X' x length($1);
740 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
746 sub ctx_statement_block {
747 my ($linenr, $remain, $off) = @_;
748 my $line = $linenr - 1;
765 @stack = (['', 0]) if ($#stack == -1);
767 #warn "CSB: blk<$blk> remain<$remain>\n";
768 # If we are about to drop off the end, pull in more
771 for (; $remain > 0; $line++) {
772 last if (!defined $lines[$line]);
773 next if ($lines[$line] =~ /^-/);
776 $blk .= $lines[$line] . "\n";
781 # Bail if there is no further context.
782 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
786 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
792 $c = substr($blk, $off, 1);
793 $remainder = substr($blk, $off);
795 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
797 # Handle nested #if/#else.
798 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
799 push(@stack, [ $type, $level ]);
800 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
801 ($type, $level) = @{$stack[$#stack - 1]};
802 } elsif ($remainder =~ /^#\s*endif\b/) {
803 ($type, $level) = @{pop(@stack)};
806 # Statement ends at the ';' or a close '}' at the
808 if ($level == 0 && $c eq ';') {
812 # An else is really a conditional as long as its not else if
813 if ($level == 0 && $coff_set == 0 &&
814 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
815 $remainder =~ /^(else)(?:\s|{)/ &&
816 $remainder !~ /^else\s+if\b/) {
817 $coff = $off + length($1) - 1;
819 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
820 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
823 if (($type eq '' || $type eq '(') && $c eq '(') {
827 if ($type eq '(' && $c eq ')') {
829 $type = ($level != 0)? '(' : '';
831 if ($level == 0 && $coff < $soff) {
834 #warn "CSB: mark coff<$coff>\n";
837 if (($type eq '' || $type eq '{') && $c eq '{') {
841 if ($type eq '{' && $c eq '}') {
843 $type = ($level != 0)? '{' : '';
846 if (substr($blk, $off + 1, 1) eq ';') {
852 # Preprocessor commands end at the newline unless escaped.
853 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
861 # We are truly at the end, so shuffle to the next line.
868 my $statement = substr($blk, $soff, $off - $soff + 1);
869 my $condition = substr($blk, $soff, $coff - $soff + 1);
871 #warn "STATEMENT<$statement>\n";
872 #warn "CONDITION<$condition>\n";
874 #print "coff<$coff> soff<$off> loff<$loff>\n";
876 return ($statement, $condition,
877 $line, $remain + 1, $off - $loff + 1, $level);
880 sub statement_lines {
883 # Strip the diff line prefixes and rip blank lines at start and end.
884 $stmt =~ s/(^|\n)./$1/g;
888 my @stmt_lines = ($stmt =~ /\n/g);
890 return $#stmt_lines + 2;
893 sub statement_rawlines {
896 my @stmt_lines = ($stmt =~ /\n/g);
898 return $#stmt_lines + 2;
901 sub statement_block_size {
904 $stmt =~ s/(^|\n)./$1/g;
910 my @stmt_lines = ($stmt =~ /\n/g);
911 my @stmt_statements = ($stmt =~ /;/g);
913 my $stmt_lines = $#stmt_lines + 2;
914 my $stmt_statements = $#stmt_statements + 1;
916 if ($stmt_lines > $stmt_statements) {
919 return $stmt_statements;
923 sub ctx_statement_full {
924 my ($linenr, $remain, $off) = @_;
925 my ($statement, $condition, $level);
929 # Grab the first conditional/block pair.
930 ($statement, $condition, $linenr, $remain, $off, $level) =
931 ctx_statement_block($linenr, $remain, $off);
932 #print "F: c<$condition> s<$statement> remain<$remain>\n";
933 push(@chunks, [ $condition, $statement ]);
934 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
935 return ($level, $linenr, @chunks);
938 # Pull in the following conditional/block pairs and see if they
939 # could continue the statement.
941 ($statement, $condition, $linenr, $remain, $off, $level) =
942 ctx_statement_block($linenr, $remain, $off);
943 #print "C: c<$condition> s<$statement> remain<$remain>\n";
944 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
946 push(@chunks, [ $condition, $statement ]);
949 return ($level, $linenr, @chunks);
953 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
955 my $start = $linenr - 1;
962 my @stack = ($level);
963 for ($line = $start; $remain > 0; $line++) {
964 next if ($rawlines[$line] =~ /^-/);
967 $blk .= $rawlines[$line];
969 # Handle nested #if/#else.
970 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
971 push(@stack, $level);
972 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
973 $level = $stack[$#stack - 1];
974 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
975 $level = pop(@stack);
978 foreach my $c (split(//, $lines[$line])) {
979 ##print "C<$c>L<$level><$open$close>O<$off>\n";
985 if ($c eq $close && $level > 0) {
987 last if ($level == 0);
988 } elsif ($c eq $open) {
993 if (!$outer || $level <= 1) {
994 push(@res, $rawlines[$line]);
997 last if ($level == 0);
1000 return ($level, @res);
1002 sub ctx_block_outer {
1003 my ($linenr, $remain) = @_;
1005 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1009 my ($linenr, $remain) = @_;
1011 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1015 my ($linenr, $remain, $off) = @_;
1017 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1020 sub ctx_block_level {
1021 my ($linenr, $remain) = @_;
1023 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1025 sub ctx_statement_level {
1026 my ($linenr, $remain, $off) = @_;
1028 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1031 sub ctx_locate_comment {
1032 my ($first_line, $end_line) = @_;
1034 # Catch a comment on the end of the line itself.
1035 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1036 return $current_comment if (defined $current_comment);
1038 # Look through the context and try and figure out if there is a
1041 $current_comment = '';
1042 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1043 my $line = $rawlines[$linenr - 1];
1045 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1048 if ($line =~ m@/\*@) {
1051 if (!$in_comment && $current_comment ne '') {
1052 $current_comment = '';
1054 $current_comment .= $line . "\n" if ($in_comment);
1055 if ($line =~ m@\*/@) {
1060 chomp($current_comment);
1061 return($current_comment);
1063 sub ctx_has_comment {
1064 my ($first_line, $end_line) = @_;
1065 my $cmt = ctx_locate_comment($first_line, $end_line);
1067 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1068 ##print "CMMT: $cmt\n";
1070 return ($cmt ne '');
1074 my ($linenr, $cnt) = @_;
1076 my $offset = $linenr - 1;
1081 $line = $rawlines[$offset++];
1082 next if (defined($line) && $line =~ /^-/);
1094 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1097 $coded = sprintf("^%c", unpack('C', $2) + 64);
1106 my $av_preprocessor = 0;
1111 sub annotate_reset {
1112 $av_preprocessor = 0;
1114 @av_paren_type = ('E');
1115 $av_pend_colon = 'O';
1118 sub annotate_values {
1119 my ($stream, $type) = @_;
1122 my $var = '_' x length($stream);
1125 print "$stream\n" if ($dbg_values > 1);
1127 while (length($cur)) {
1128 @av_paren_type = ('E') if ($#av_paren_type < 0);
1129 print " <" . join('', @av_paren_type) .
1130 "> <$type> <$av_pending>" if ($dbg_values > 1);
1131 if ($cur =~ /^(\s+)/o) {
1132 print "WS($1)\n" if ($dbg_values > 1);
1133 if ($1 =~ /\n/ && $av_preprocessor) {
1134 $type = pop(@av_paren_type);
1135 $av_preprocessor = 0;
1138 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1139 print "CAST($1)\n" if ($dbg_values > 1);
1140 push(@av_paren_type, $type);
1143 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1144 print "DECLARE($1)\n" if ($dbg_values > 1);
1147 } elsif ($cur =~ /^($Modifier)\s*/) {
1148 print "MODIFIER($1)\n" if ($dbg_values > 1);
1151 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1152 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1153 $av_preprocessor = 1;
1154 push(@av_paren_type, $type);
1160 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1161 print "UNDEF($1)\n" if ($dbg_values > 1);
1162 $av_preprocessor = 1;
1163 push(@av_paren_type, $type);
1165 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1166 print "PRE_START($1)\n" if ($dbg_values > 1);
1167 $av_preprocessor = 1;
1169 push(@av_paren_type, $type);
1170 push(@av_paren_type, $type);
1173 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1174 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1175 $av_preprocessor = 1;
1177 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1181 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1182 print "PRE_END($1)\n" if ($dbg_values > 1);
1184 $av_preprocessor = 1;
1186 # Assume all arms of the conditional end as this
1187 # one does, and continue as if the #endif was not here.
1188 pop(@av_paren_type);
1189 push(@av_paren_type, $type);
1192 } elsif ($cur =~ /^(\\\n)/o) {
1193 print "PRECONT($1)\n" if ($dbg_values > 1);
1195 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1196 print "ATTR($1)\n" if ($dbg_values > 1);
1197 $av_pending = $type;
1200 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1201 print "SIZEOF($1)\n" if ($dbg_values > 1);
1207 } elsif ($cur =~ /^(if|while|for)\b/o) {
1208 print "COND($1)\n" if ($dbg_values > 1);
1212 } elsif ($cur =~/^(case)/o) {
1213 print "CASE($1)\n" if ($dbg_values > 1);
1214 $av_pend_colon = 'C';
1217 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1218 print "KEYWORD($1)\n" if ($dbg_values > 1);
1221 } elsif ($cur =~ /^(\()/o) {
1222 print "PAREN('$1')\n" if ($dbg_values > 1);
1223 push(@av_paren_type, $av_pending);
1227 } elsif ($cur =~ /^(\))/o) {
1228 my $new_type = pop(@av_paren_type);
1229 if ($new_type ne '_') {
1231 print "PAREN('$1') -> $type\n"
1232 if ($dbg_values > 1);
1234 print "PAREN('$1')\n" if ($dbg_values > 1);
1237 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1238 print "FUNC($1)\n" if ($dbg_values > 1);
1242 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1243 if (defined $2 && $type eq 'C' || $type eq 'T') {
1244 $av_pend_colon = 'B';
1245 } elsif ($type eq 'E') {
1246 $av_pend_colon = 'L';
1248 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1251 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1252 print "IDENT($1)\n" if ($dbg_values > 1);
1255 } elsif ($cur =~ /^($Assignment)/o) {
1256 print "ASSIGN($1)\n" if ($dbg_values > 1);
1259 } elsif ($cur =~/^(;|{|})/) {
1260 print "END($1)\n" if ($dbg_values > 1);
1262 $av_pend_colon = 'O';
1264 } elsif ($cur =~/^(,)/) {
1265 print "COMMA($1)\n" if ($dbg_values > 1);
1268 } elsif ($cur =~ /^(\?)/o) {
1269 print "QUESTION($1)\n" if ($dbg_values > 1);
1272 } elsif ($cur =~ /^(:)/o) {
1273 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1275 substr($var, length($res), 1, $av_pend_colon);
1276 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1281 $av_pend_colon = 'O';
1283 } elsif ($cur =~ /^(\[)/o) {
1284 print "CLOSE($1)\n" if ($dbg_values > 1);
1287 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1290 print "OPV($1)\n" if ($dbg_values > 1);
1297 substr($var, length($res), 1, $variant);
1300 } elsif ($cur =~ /^($Operators)/o) {
1301 print "OP($1)\n" if ($dbg_values > 1);
1302 if ($1 ne '++' && $1 ne '--') {
1306 } elsif ($cur =~ /(^.)/o) {
1307 print "C($1)\n" if ($dbg_values > 1);
1310 $cur = substr($cur, length($1));
1311 $res .= $type x length($1);
1315 return ($res, $var);
1319 my ($possible, $line) = @_;
1320 my $notPermitted = qr{(?:
1337 ^(?:typedef|struct|enum)\b
1339 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1340 if ($possible !~ $notPermitted) {
1341 # Check for modifiers.
1342 $possible =~ s/\s*$Storage\s*//g;
1343 $possible =~ s/\s*$Sparse\s*//g;
1344 if ($possible =~ /^\s*$/) {
1346 } elsif ($possible =~ /\s/) {
1347 $possible =~ s/\s*$Type\s*//g;
1348 for my $modifier (split(' ', $possible)) {
1349 if ($modifier !~ $notPermitted) {
1350 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1351 push(@modifierList, $modifier);
1356 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1357 push(@typeList, $possible);
1361 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1368 return !defined $ignore_type{$_[0]};
1372 if (!show_type($_[1]) ||
1373 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1378 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1380 $line = "$prefix$_[0]: $_[2]\n";
1382 $line = (split('\n', $line))[0] . "\n" if ($terse);
1384 push(our @report, $line);
1393 if (report("ERROR", $_[0], $_[1])) {
1399 if (report("WARNING", $_[0], $_[1])) {
1405 if ($check && report("CHECK", $_[0], $_[1])) {
1411 sub check_absolute_file {
1412 my ($absolute, $herecurr) = @_;
1413 my $file = $absolute;
1415 ##print "absolute<$absolute>\n";
1417 # See if any suffix of this path is a path within the tree.
1418 while ($file =~ s@^[^/]*/@@) {
1419 if (-f "$root/$file") {
1420 ##print "file<$file>\n";
1428 # It is, so see if the prefix is acceptable.
1429 my $prefix = $absolute;
1430 substr($prefix, -length($file)) = '';
1432 ##print "prefix<$prefix>\n";
1433 if ($prefix ne ".../") {
1434 WARN("USE_RELATIVE_PATH",
1435 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1440 my $filename = shift;
1446 my $stashrawline="";
1457 my $in_header_lines = 1;
1458 my $in_commit_log = 0; #Scanning lines before patch
1466 # Trace the real file/line as we go.
1472 my $comment_edge = 0;
1476 my $prev_values = 'E';
1479 my %suppress_ifbraces;
1480 my %suppress_whiletrailers;
1481 my %suppress_export;
1482 my $suppress_statement = 0;
1484 # Pre-scan the patch sanitizing the lines.
1485 # Pre-scan the patch looking for any __setup documentation.
1487 my @setup_docs = ();
1490 sanitise_line_reset();
1492 foreach my $rawline (@rawlines) {
1496 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1498 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1503 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1512 # Guestimate if this is a continuing comment. Run
1513 # the context looking for a comment "edge". If this
1514 # edge is a close comment then we must be in a comment
1518 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1519 next if (defined $rawlines[$ln - 1] &&
1520 $rawlines[$ln - 1] =~ /^-/);
1522 #print "RAW<$rawlines[$ln - 1]>\n";
1523 last if (!defined $rawlines[$ln - 1]);
1524 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1525 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1530 if (defined $edge && $edge eq '*/') {
1534 # Guestimate if this is a continuing comment. If this
1535 # is the start of a diff block and this line starts
1536 # ' *' then it is very likely a comment.
1537 if (!defined $edge &&
1538 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1543 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1544 sanitise_line_reset($in_comment);
1546 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1547 # Standardise the strings and chars within the input to
1548 # simplify matching -- only bother with positive lines.
1549 $line = sanitise_line($rawline);
1551 push(@lines, $line);
1554 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1559 #print "==>$rawline\n";
1560 #print "-->$line\n";
1562 if ($setup_docs && $line =~ /^\+/) {
1563 push(@setup_docs, $line);
1571 foreach my $line (@lines) {
1574 my $rawline = $rawlines[$linenr - 1];
1576 #extract the line range in the file after the patch is applied
1577 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1579 $first_line = $linenr + 1;
1589 %suppress_ifbraces = ();
1590 %suppress_whiletrailers = ();
1591 %suppress_export = ();
1592 $suppress_statement = 0;
1595 # track the line number as we move through the hunk, note that
1596 # new versions of GNU diff omit the leading space on completely
1597 # blank context lines so we need to count that too.
1598 } elsif ($line =~ /^( |\+|$)/) {
1600 $realcnt-- if ($realcnt != 0);
1602 # Measure the line length and indent.
1603 ($length, $indent) = line_stats($rawline);
1605 # Track the previous line.
1606 ($prevline, $stashline) = ($stashline, $line);
1607 ($previndent, $stashindent) = ($stashindent, $indent);
1608 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1610 #warn "line<$line>\n";
1612 } elsif ($realcnt == 1) {
1616 my $hunk_line = ($realcnt != 0);
1618 #make up the handle for any error we report on this line
1619 $prefix = "$filename:$realline: " if ($emacs && $file);
1620 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1622 $here = "#$linenr: " if (!$file);
1623 $here = "#$realline: " if ($file);
1625 # extract the filename as it passes
1626 if ($line =~ /^diff --git.*?(\S+)$/) {
1628 $realfile =~ s@^([^/]*)/@@;
1630 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1632 $realfile =~ s@^([^/]*)/@@;
1636 if (!$file && $tree && $p1_prefix ne '' &&
1637 -e "$root/$p1_prefix") {
1638 WARN("PATCH_PREFIX",
1639 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1642 if ($realfile =~ m@^include/asm/@) {
1643 ERROR("MODIFIED_INCLUDE_ASM",
1644 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1649 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1651 my $hereline = "$here\n$rawline\n";
1652 my $herecurr = "$here\n$rawline\n";
1653 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1655 $cnt_lines++ if ($realcnt != 0);
1657 # Check for incorrect file permissions
1658 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1659 my $permhere = $here . "FILE: $realfile\n";
1660 if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
1661 ERROR("EXECUTE_PERMISSIONS",
1662 "do not set execute permissions for source files\n" . $permhere);
1666 # Check the patch for a signoff:
1667 if ($line =~ /^\s*signed-off-by:/i) {
1672 # Check signature styles
1673 if (!$in_header_lines &&
1674 $line =~ /^(\s*)($signature_tags)(\s*)(.*)/) {
1675 my $space_before = $1;
1677 my $space_after = $3;
1679 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1681 if (defined $space_before && $space_before ne "") {
1682 WARN("BAD_SIGN_OFF",
1683 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
1685 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1686 WARN("BAD_SIGN_OFF",
1687 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
1689 if (!defined $space_after || $space_after ne " ") {
1690 WARN("BAD_SIGN_OFF",
1691 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
1694 my ($email_name, $email_address, $comment) = parse_email($email);
1695 my $suggested_email = format_email(($email_name, $email_address));
1696 if ($suggested_email eq "") {
1697 ERROR("BAD_SIGN_OFF",
1698 "Unrecognized email address: '$email'\n" . $herecurr);
1700 my $dequoted = $suggested_email;
1701 $dequoted =~ s/^"//;
1702 $dequoted =~ s/" </ </;
1703 # Don't force email to have quotes
1704 # Allow just an angle bracketed address
1705 if ("$dequoted$comment" ne $email &&
1706 "<$email_address>$comment" ne $email &&
1707 "$suggested_email$comment" ne $email) {
1708 WARN("BAD_SIGN_OFF",
1709 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1714 # Check for wrappage within a valid hunk of the file
1715 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1716 ERROR("CORRUPTED_PATCH",
1717 "patch seems to be corrupt (line wrapped?)\n" .
1718 $herecurr) if (!$emitted_corrupt++);
1721 # Check for absolute kernel paths.
1723 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1726 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1727 check_absolute_file($1, $herecurr)) {
1730 check_absolute_file($file, $herecurr);
1735 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1736 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1737 $rawline !~ m/^$UTF8*$/) {
1738 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1740 my $blank = copy_spacing($rawline);
1741 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1742 my $hereptr = "$hereline$ptr\n";
1745 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1748 # Check if it's the start of a commit log
1749 # (not a header line and we haven't seen the patch filename)
1750 if ($in_header_lines && $realfile =~ /^$/ &&
1751 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1752 $in_header_lines = 0;
1756 # Still not yet in a patch, check for any UTF-8
1757 if ($in_commit_log && $realfile =~ /^$/ &&
1758 $rawline =~ /$NON_ASCII_UTF8/) {
1759 CHK("UTF8_BEFORE_PATCH",
1760 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1763 # ignore non-hunk lines and lines being removed
1764 next if (!$hunk_line || $line =~ /^-/);
1766 #trailing whitespace
1767 if ($line =~ /^\+.*\015/) {
1768 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1769 ERROR("DOS_LINE_ENDINGS",
1770 "DOS line endings\n" . $herevet);
1772 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1773 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1774 ERROR("TRAILING_WHITESPACE",
1775 "trailing whitespace\n" . $herevet);
1779 # check for Kconfig help text having a real description
1780 # Only applies when adding the entry originally, after that we do not have
1781 # sufficient context to determine whether it is indeed long enough.
1782 if ($realfile =~ /Kconfig/ &&
1783 $line =~ /.\s*config\s+/) {
1786 my $ln = $linenr + 1;
1790 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1791 $f = $lines[$ln - 1];
1792 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1793 $is_end = $lines[$ln - 1] =~ /^\+/;
1795 next if ($f =~ /^-/);
1797 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1799 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1806 next if ($f =~ /^$/);
1807 if ($f =~ /^\s*config\s/) {
1813 WARN("CONFIG_DESCRIPTION",
1814 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1815 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1818 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1819 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1822 'EXTRA_AFLAGS' => 'asflags-y',
1823 'EXTRA_CFLAGS' => 'ccflags-y',
1824 'EXTRA_CPPFLAGS' => 'cppflags-y',
1825 'EXTRA_LDFLAGS' => 'ldflags-y',
1828 WARN("DEPRECATED_VARIABLE",
1829 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1832 # check we are in a valid source file if not then ignore this hunk
1833 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1836 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1837 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1838 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1839 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1843 "line over 80 characters\n" . $herecurr);
1846 # check for spaces before a quoted newline
1847 if ($rawline =~ /^.*\".*\s\\n/) {
1848 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1849 "unnecessary whitespace before a quoted newline\n" . $herecurr);
1852 # check for adding lines without a newline.
1853 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1854 WARN("MISSING_EOF_NEWLINE",
1855 "adding a line without newline at end of file\n" . $herecurr);
1858 # Blackfin: use hi/lo macros
1859 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1860 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1861 my $herevet = "$here\n" . cat_vet($line) . "\n";
1863 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1865 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1866 my $herevet = "$here\n" . cat_vet($line) . "\n";
1868 "use the HI() macro, not (... >> 16)\n" . $herevet);
1872 # check we are in a valid source file C, perl or bash script
1873 # if not then ignore this hunk
1874 next if ($realfile !~ /\.(h|c|pl|sh)$/);
1876 # at the beginning of a line any tabs must come first and anything
1877 # more than 8 must use tabs.
1878 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1879 $rawline =~ /^\+\s* \s*/) {
1880 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1881 ERROR("CODE_INDENT",
1882 "code indent should use tabs where possible\n" . $herevet);
1886 # check for space before tabs.
1887 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1888 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1889 WARN("SPACE_BEFORE_TAB",
1890 "please, no space before tabs\n" . $herevet);
1893 # check for spaces at the beginning of a line.
1895 # 1) within comments
1896 # 2) indented preprocessor commands
1898 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
1899 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1900 WARN("LEADING_SPACE",
1901 "please, no spaces at the start of a line\n" . $herevet);
1904 # check we are in a valid C source file if not then ignore this hunk
1905 next if ($realfile !~ /\.(h|c)$/);
1907 # check for RCS/CVS revision markers
1908 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1910 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1913 # Blackfin: don't use __builtin_bfin_[cs]sync
1914 if ($line =~ /__builtin_bfin_csync/) {
1915 my $herevet = "$here\n" . cat_vet($line) . "\n";
1917 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1919 if ($line =~ /__builtin_bfin_ssync/) {
1920 my $herevet = "$here\n" . cat_vet($line) . "\n";
1922 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1925 # Check for potential 'bare' types
1926 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1928 #print "LINE<$line>\n";
1929 if ($linenr >= $suppress_statement &&
1930 $realcnt && $line =~ /.\s*\S/) {
1931 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1932 ctx_statement_block($linenr, $realcnt, 0);
1933 $stat =~ s/\n./\n /g;
1934 $cond =~ s/\n./\n /g;
1936 #print "linenr<$linenr> <$stat>\n";
1937 # If this statement has no statement boundaries within
1938 # it there is no point in retrying a statement scan
1939 # until we hit end of it.
1940 my $frag = $stat; $frag =~ s/;+\s*$//;
1941 if ($frag !~ /(?:{|;)/) {
1942 #print "skip<$line_nr_next>\n";
1943 $suppress_statement = $line_nr_next;
1946 # Find the real next line.
1947 $realline_next = $line_nr_next;
1948 if (defined $realline_next &&
1949 (!defined $lines[$realline_next - 1] ||
1950 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1957 # Ignore goto labels.
1958 if ($s =~ /$Ident:\*$/s) {
1960 # Ignore functions being called
1961 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1963 } elsif ($s =~ /^.\s*else\b/s) {
1965 # declarations always start with types
1966 } 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) {
1969 possible($type, "A:" . $s);
1971 # definitions in global scope can only start with types
1972 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
1973 possible($1, "B:" . $s);
1976 # any (foo ... *) is a pointer cast, and foo is a type
1977 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
1978 possible($1, "C:" . $s);
1981 # Check for any sort of function declaration.
1982 # int foo(something bar, other baz);
1983 # void (*store_gdt)(x86_descr_ptr *);
1984 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
1985 my ($name_len) = length($1);
1988 substr($ctx, 0, $name_len + 1, '');
1989 $ctx =~ s/\)[^\)]*$//;
1991 for my $arg (split(/\s*,\s*/, $ctx)) {
1992 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
1994 possible($1, "D:" . $s);
2002 # Checks which may be anchored in the context.
2005 # Check for switch () and associated case and default
2006 # statements should be at the same indent.
2007 if ($line=~/\bswitch\s*\(.*\)/) {
2010 my @ctx = ctx_block_outer($linenr, $realcnt);
2012 for my $ctx (@ctx) {
2013 my ($clen, $cindent) = line_stats($ctx);
2014 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2015 $indent != $cindent) {
2016 $err .= "$sep$ctx\n";
2023 ERROR("SWITCH_CASE_INDENT_LEVEL",
2024 "switch and case should be at the same indent\n$hereline$err");
2028 # if/while/etc brace do not go on next line, unless defining a do while loop,
2029 # or if that brace on the next line is for something else
2030 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2031 my $pre_ctx = "$1$2";
2033 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2035 if ($line =~ /^\+\t{6,}/) {
2036 WARN("DEEP_INDENTATION",
2037 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2040 my $ctx_cnt = $realcnt - $#ctx - 1;
2041 my $ctx = join("\n", @ctx);
2043 my $ctx_ln = $linenr;
2044 my $ctx_skip = $realcnt;
2046 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2047 defined $lines[$ctx_ln - 1] &&
2048 $lines[$ctx_ln - 1] =~ /^-/)) {
2049 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2050 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2054 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2055 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2057 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2059 "that open brace { should be on the previous line\n" .
2060 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2062 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2063 $ctx =~ /\)\s*\;\s*$/ &&
2064 defined $lines[$ctx_ln - 1])
2066 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2067 if ($nindent > $indent) {
2068 WARN("TRAILING_SEMICOLON",
2069 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2070 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2075 # Check relative indent for conditionals and blocks.
2076 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2077 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2078 ctx_statement_block($linenr, $realcnt, 0)
2079 if (!defined $stat);
2080 my ($s, $c) = ($stat, $cond);
2082 substr($s, 0, length($c), '');
2084 # Make sure we remove the line prefixes as we have
2085 # none on the first line, and are going to readd them
2089 # Find out how long the conditional actually is.
2090 my @newlines = ($c =~ /\n/gs);
2091 my $cond_lines = 1 + $#newlines;
2093 # We want to check the first line inside the block
2094 # starting at the end of the conditional, so remove:
2095 # 1) any blank line termination
2096 # 2) any opening brace { on end of the line
2098 my $continuation = 0;
2100 $s =~ s/^.*\bdo\b//;
2102 if ($s =~ s/^\s*\\//) {
2105 if ($s =~ s/^\s*?\n//) {
2110 # Also ignore a loop construct at the end of a
2111 # preprocessor statement.
2112 if (($prevline =~ /^.\s*#\s*define\s/ ||
2113 $prevline =~ /\\\s*$/) && $continuation == 0) {
2119 while ($cond_ptr != $cond_lines) {
2120 $cond_ptr = $cond_lines;
2122 # If we see an #else/#elif then the code
2124 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2129 # 1) blank lines, they should be at 0,
2130 # 2) preprocessor lines, and
2132 if ($continuation ||
2134 $s =~ /^\s*#\s*?/ ||
2135 $s =~ /^\s*$Ident\s*:/) {
2136 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2137 if ($s =~ s/^.*?\n//) {
2143 my (undef, $sindent) = line_stats("+" . $s);
2144 my $stat_real = raw_line($linenr, $cond_lines);
2146 # Check if either of these lines are modified, else
2147 # this is not this patch's fault.
2148 if (!defined($stat_real) ||
2149 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2152 if (defined($stat_real) && $cond_lines > 1) {
2153 $stat_real = "[...]\n$stat_real";
2156 #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";
2158 if ($check && (($sindent % 8) != 0 ||
2159 ($sindent <= $indent && $s ne ''))) {
2160 WARN("SUSPECT_CODE_INDENT",
2161 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2165 # Track the 'values' across context and added lines.
2166 my $opline = $line; $opline =~ s/^./ /;
2167 my ($curr_values, $curr_vars) =
2168 annotate_values($opline . "\n", $prev_values);
2169 $curr_values = $prev_values . $curr_values;
2171 my $outline = $opline; $outline =~ s/\t/ /g;
2172 print "$linenr > .$outline\n";
2173 print "$linenr > $curr_values\n";
2174 print "$linenr > $curr_vars\n";
2176 $prev_values = substr($curr_values, -1);
2178 #ignore lines not being added
2179 if ($line=~/^[^\+]/) {next;}
2181 # TEST: allow direct testing of the type matcher.
2183 if ($line =~ /^.\s*$Declare\s*$/) {
2185 "TEST: is type\n" . $herecurr);
2186 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2187 ERROR("TEST_NOT_TYPE",
2188 "TEST: is not type ($1 is)\n". $herecurr);
2192 # TEST: allow direct testing of the attribute matcher.
2194 if ($line =~ /^.\s*$Modifier\s*$/) {
2196 "TEST: is attr\n" . $herecurr);
2197 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2198 ERROR("TEST_NOT_ATTR",
2199 "TEST: is not attr ($1 is)\n". $herecurr);
2204 # check for initialisation to aggregates open brace on the next line
2205 if ($line =~ /^.\s*{/ &&
2206 $prevline =~ /(?:^|[^=])=\s*$/) {
2208 "that open brace { should be on the previous line\n" . $hereprev);
2212 # Checks which are anchored on the added line.
2215 # check for malformed paths in #include statements (uses RAW line)
2216 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2218 if ($path =~ m{//}) {
2219 ERROR("MALFORMED_INCLUDE",
2220 "malformed #include filename\n" .
2225 # no C99 // comments
2226 if ($line =~ m{//}) {
2227 ERROR("C99_COMMENTS",
2228 "do not use C99 // comments\n" . $herecurr);
2230 # Remove C99 comments.
2232 $opline =~ s@//.*@@;
2234 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2235 # the whole statement.
2236 #print "APW <$lines[$realline_next - 1]>\n";
2237 if (defined $realline_next &&
2238 exists $lines[$realline_next - 1] &&
2239 !defined $suppress_export{$realline_next} &&
2240 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2241 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2242 # Handle definitions which produce identifiers with
2245 # EXPORT_SYMBOL(something_foo);
2247 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2248 $name =~ /^${Ident}_$2/) {
2249 #print "FOO C name<$name>\n";
2250 $suppress_export{$realline_next} = 1;
2252 } elsif ($stat !~ /(?:
2254 ^.DEFINE_$Ident\(\Q$name\E\)|
2255 ^.DECLARE_$Ident\(\Q$name\E\)|
2256 ^.LIST_HEAD\(\Q$name\E\)|
2257 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2258 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2260 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2261 $suppress_export{$realline_next} = 2;
2263 $suppress_export{$realline_next} = 1;
2266 if (!defined $suppress_export{$linenr} &&
2267 $prevline =~ /^.\s*$/ &&
2268 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2269 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2270 #print "FOO B <$lines[$linenr - 1]>\n";
2271 $suppress_export{$linenr} = 2;
2273 if (defined $suppress_export{$linenr} &&
2274 $suppress_export{$linenr} == 2) {
2275 WARN("EXPORT_SYMBOL",
2276 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2279 # check for global initialisers.
2280 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2281 ERROR("GLOBAL_INITIALISERS",
2282 "do not initialise globals to 0 or NULL\n" .
2285 # check for static initialisers.
2286 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2287 ERROR("INITIALISED_STATIC",
2288 "do not initialise statics to 0 or NULL\n" .
2292 # check for static const char * arrays.
2293 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2294 WARN("STATIC_CONST_CHAR_ARRAY",
2295 "static const char * array should probably be static const char * const\n" .
2299 # check for static char foo[] = "bar" declarations.
2300 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2301 WARN("STATIC_CONST_CHAR_ARRAY",
2302 "static char array declaration should probably be static const char\n" .
2306 # check for declarations of struct pci_device_id
2307 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2308 WARN("DEFINE_PCI_DEVICE_TABLE",
2309 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2312 # check for new typedefs, only function parameters and sparse annotations
2314 if ($line =~ /\btypedef\s/ &&
2315 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2316 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2317 $line !~ /\b$typeTypedefs\b/ &&
2318 $line !~ /\b__bitwise(?:__|)\b/) {
2319 WARN("NEW_TYPEDEFS",
2320 "do not add new typedefs\n" . $herecurr);
2323 # * goes on variable not on type
2325 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2327 my ($from, $to) = ($2, $2);
2329 # Should start with a space.
2330 $to =~ s/^(\S)/ $1/;
2331 # Should not end with a space.
2333 # '*'s should not have spaces between.
2334 while ($to =~ s/\*\s+\*/\*\*/) {
2337 #print "from<$from> to<$to>\n";
2339 ERROR("POINTER_LOCATION",
2340 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
2343 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2345 my ($from, $to, $ident) = ($2, $2, $3);
2347 # Should start with a space.
2348 $to =~ s/^(\S)/ $1/;
2349 # Should not end with a space.
2351 # '*'s should not have spaces between.
2352 while ($to =~ s/\*\s+\*/\*\*/) {
2354 # Modifiers should have spaces.
2355 $to =~ s/(\b$Modifier$)/$1 /;
2357 #print "from<$from> to<$to> ident<$ident>\n";
2358 if ($from ne $to && $ident !~ /^$Modifier$/) {
2359 ERROR("POINTER_LOCATION",
2360 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
2364 # # no BUG() or BUG_ON()
2365 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
2366 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2367 # print "$herecurr";
2371 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2372 WARN("LINUX_VERSION_CODE",
2373 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2376 # check for uses of printk_ratelimit
2377 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2378 WARN("PRINTK_RATELIMITED",
2379 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2382 # printk should use KERN_* levels. Note that follow on printk's on the
2383 # same line do not need a level, so we use the current block context
2384 # to try and find and validate the current printk. In summary the current
2385 # printk includes all preceding printk's which have no newline on the end.
2386 # we assume the first bad printk is the one to report.
2387 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2389 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2390 #print "CHECK<$lines[$ln - 1]\n";
2391 # we have a preceding printk if it ends
2392 # with "\n" ignore it, else it is to blame
2393 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2394 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2401 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2402 "printk() should include KERN_ facility level\n" . $herecurr);
2406 # function brace can't be on same line, except for #defines of do while,
2407 # or if closed on same line
2408 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2409 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2411 "open brace '{' following function declarations go on the next line\n" . $herecurr);
2414 # open braces for enum, union and struct go on the same line.
2415 if ($line =~ /^.\s*{/ &&
2416 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2418 "open brace '{' following $1 go on the same line\n" . $hereprev);
2421 # missing space after union, struct or enum definition
2422 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2424 "missing space after $1 definition\n" . $herecurr);
2427 # check for spacing round square brackets; allowed:
2428 # 1. with a type on the left -- int [] a;
2429 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2430 # 3. inside a curly brace -- = { [0...10] = 5 }
2431 while ($line =~ /(.*?\s)\[/g) {
2432 my ($where, $prefix) = ($-[1], $1);
2433 if ($prefix !~ /$Type\s+$/ &&
2434 ($where != 0 || $prefix !~ /^.\s+$/) &&
2435 $prefix !~ /{\s+$/) {
2436 ERROR("BRACKET_SPACE",
2437 "space prohibited before open square bracket '['\n" . $herecurr);
2441 # check for spaces between functions and their parentheses.
2442 while ($line =~ /($Ident)\s+\(/g) {
2444 my $ctx_before = substr($line, 0, $-[1]);
2445 my $ctx = "$ctx_before$name";
2447 # Ignore those directives where spaces _are_ permitted.
2449 if|for|while|switch|return|case|
2450 volatile|__volatile__|
2451 __attribute__|format|__extension__|
2455 # cpp #define statements have non-optional spaces, ie
2456 # if there is a space between the name and the open
2457 # parenthesis it is simply not a parameter group.
2458 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2460 # cpp #elif statement condition may start with a (
2461 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2463 # If this whole things ends with a type its most
2464 # likely a typedef for a function.
2465 } elsif ($ctx =~ /$Type$/) {
2469 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
2472 # Check operator spacing.
2473 if (!($line=~/\#\s*include/)) {
2475 <<=|>>=|<=|>=|==|!=|
2476 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2477 =>|->|<<|>>|<|>|=|!|~|
2478 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2481 my @elements = split(/($ops|;)/, $opline);
2484 my $blank = copy_spacing($opline);
2486 for (my $n = 0; $n < $#elements; $n += 2) {
2487 $off += length($elements[$n]);
2489 # Pick up the preceding and succeeding characters.
2490 my $ca = substr($opline, 0, $off);
2492 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2493 $cc = substr($opline, $off + length($elements[$n + 1]));
2495 my $cb = "$ca$;$cc";
2498 $a = 'V' if ($elements[$n] ne '');
2499 $a = 'W' if ($elements[$n] =~ /\s$/);
2500 $a = 'C' if ($elements[$n] =~ /$;$/);
2501 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2502 $a = 'O' if ($elements[$n] eq '');
2503 $a = 'E' if ($ca =~ /^\s*$/);
2505 my $op = $elements[$n + 1];
2508 if (defined $elements[$n + 2]) {
2509 $c = 'V' if ($elements[$n + 2] ne '');
2510 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2511 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2512 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2513 $c = 'O' if ($elements[$n + 2] eq '');
2514 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2519 my $ctx = "${a}x${c}";
2521 my $at = "(ctx:$ctx)";
2523 my $ptr = substr($blank, 0, $off) . "^";
2524 my $hereptr = "$hereline$ptr\n";
2526 # Pull out the value of this operator.
2527 my $op_type = substr($curr_values, $off + 1, 1);
2529 # Get the full operator variant.
2530 my $opv = $op . substr($curr_vars, $off, 1);
2532 # Ignore operators passed as parameters.
2533 if ($op_type ne 'V' &&
2534 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2537 # } elsif ($op =~ /^$;+$/) {
2539 # ; should have either the end of line or a space or \ after it
2540 } elsif ($op eq ';') {
2541 if ($ctx !~ /.x[WEBC]/ &&
2542 $cc !~ /^\\/ && $cc !~ /^;/) {
2544 "space required after that '$op' $at\n" . $hereptr);
2548 } elsif ($op eq '//') {
2552 # : when part of a bitfield
2553 } elsif ($op eq '->' || $opv eq ':B') {
2554 if ($ctx =~ /Wx.|.xW/) {
2556 "spaces prohibited around that '$op' $at\n" . $hereptr);
2559 # , must have a space on the right.
2560 } elsif ($op eq ',') {
2561 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2563 "space required after that '$op' $at\n" . $hereptr);
2566 # '*' as part of a type definition -- reported already.
2567 } elsif ($opv eq '*_') {
2568 #warn "'*' is part of type\n";
2570 # unary operators should have a space before and
2571 # none after. May be left adjacent to another
2572 # unary operator, or a cast
2573 } elsif ($op eq '!' || $op eq '~' ||
2574 $opv eq '*U' || $opv eq '-U' ||
2575 $opv eq '&U' || $opv eq '&&U') {
2576 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2578 "space required before that '$op' $at\n" . $hereptr);
2580 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2581 # A unary '*' may be const
2583 } elsif ($ctx =~ /.xW/) {
2585 "space prohibited after that '$op' $at\n" . $hereptr);
2588 # unary ++ and unary -- are allowed no space on one side.
2589 } elsif ($op eq '++' or $op eq '--') {
2590 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2592 "space required one side of that '$op' $at\n" . $hereptr);
2594 if ($ctx =~ /Wx[BE]/ ||
2595 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2597 "space prohibited before that '$op' $at\n" . $hereptr);
2599 if ($ctx =~ /ExW/) {
2601 "space prohibited after that '$op' $at\n" . $hereptr);
2605 # << and >> may either have or not have spaces both sides
2606 } elsif ($op eq '<<' or $op eq '>>' or
2607 $op eq '&' or $op eq '^' or $op eq '|' or
2608 $op eq '+' or $op eq '-' or
2609 $op eq '*' or $op eq '/' or
2612 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2614 "need consistent spacing around '$op' $at\n" .
2618 # A colon needs no spaces before when it is
2619 # terminating a case value or a label.
2620 } elsif ($opv eq ':C' || $opv eq ':L') {
2621 if ($ctx =~ /Wx./) {
2623 "space prohibited before that '$op' $at\n" . $hereptr);
2626 # All the others need spaces both sides.
2627 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2630 # Ignore email addresses <foo@bar>
2632 $cc =~ /^\S+\@\S+>/) ||
2634 $ca =~ /<\S+\@\S+$/))
2640 if (($opv eq ':O' && $ca =~ /\?$/) ||
2641 ($op eq '?' && $cc =~ /^:/)) {
2647 "spaces required around that '$op' $at\n" . $hereptr);
2650 $off += length($elements[$n + 1]);
2654 # check for multiple assignments
2655 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2656 CHK("MULTIPLE_ASSIGNMENTS",
2657 "multiple assignments should be avoided\n" . $herecurr);
2660 ## # check for multiple declarations, allowing for a function declaration
2662 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2663 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2665 ## # Remove any bracketed sections to ensure we do not
2666 ## # falsly report the parameters of functions.
2668 ## while ($ln =~ s/\([^\(\)]*\)//g) {
2670 ## if ($ln =~ /,/) {
2671 ## WARN("MULTIPLE_DECLARATION",
2672 ## "declaring multiple variables together should be avoided\n" . $herecurr);
2676 #need space before brace following if, while, etc
2677 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2680 "space required before the open brace '{'\n" . $herecurr);
2683 # closing brace should have a space following it when it has anything
2685 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2687 "space required after that close brace '}'\n" . $herecurr);
2690 # check spacing on square brackets
2691 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2693 "space prohibited after that open square bracket '['\n" . $herecurr);
2695 if ($line =~ /\s\]/) {
2697 "space prohibited before that close square bracket ']'\n" . $herecurr);
2700 # check spacing on parentheses
2701 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2702 $line !~ /for\s*\(\s+;/) {
2704 "space prohibited after that open parenthesis '('\n" . $herecurr);
2706 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2707 $line !~ /for\s*\(.*;\s+\)/ &&
2708 $line !~ /:\s+\)/) {
2710 "space prohibited before that close parenthesis ')'\n" . $herecurr);
2713 #goto labels aren't indented, allow a single space however
2714 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2715 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2716 WARN("INDENTED_LABEL",
2717 "labels should not be indented\n" . $herecurr);
2720 # Return is not a function.
2721 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2725 # Flatten any parentheses
2726 $value =~ s/\(/ \(/g;
2727 $value =~ s/\)/\) /g;
2728 while ($value =~ s/\[[^\[\]]*\]/1/ ||
2729 $value !~ /(?:$Ident|-?$Constant)\s*
2731 (?:$Ident|-?$Constant)/x &&
2732 $value =~ s/\([^\(\)]*\)/1/) {
2734 #print "value<$value>\n";
2735 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2736 ERROR("RETURN_PARENTHESES",
2737 "return is not a function, parentheses are not required\n" . $herecurr);
2739 } elsif ($spacing !~ /\s+/) {
2741 "space required before the open parenthesis '('\n" . $herecurr);
2744 # Return of what appears to be an errno should normally be -'ve
2745 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2747 if ($name ne 'EOF' && $name ne 'ERROR') {
2748 WARN("USE_NEGATIVE_ERRNO",
2749 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2753 # Need a space before open parenthesis after if, while etc
2754 if ($line=~/\b(if|while|for|switch)\(/) {
2755 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
2758 # Check for illegal assignment in if conditional -- and check for trailing
2759 # statements after the conditional.
2760 if ($line =~ /do\s*(?!{)/) {
2761 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2762 ctx_statement_block($linenr, $realcnt, 0)
2763 if (!defined $stat);
2764 my ($stat_next) = ctx_statement_block($line_nr_next,
2765 $remain_next, $off_next);
2766 $stat_next =~ s/\n./\n /g;
2767 ##print "stat<$stat> stat_next<$stat_next>\n";
2769 if ($stat_next =~ /^\s*while\b/) {
2770 # If the statement carries leading newlines,
2771 # then count those as offsets.
2773 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2775 statement_rawlines($whitespace) - 1;
2777 $suppress_whiletrailers{$line_nr_next +
2781 if (!defined $suppress_whiletrailers{$linenr} &&
2782 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2783 my ($s, $c) = ($stat, $cond);
2785 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2786 ERROR("ASSIGN_IN_IF",
2787 "do not use assignment in if condition\n" . $herecurr);
2790 # Find out what is on the end of the line after the
2792 substr($s, 0, length($c), '');
2794 $s =~ s/$;//g; # Remove any comments
2795 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2796 $c !~ /}\s*while\s*/)
2798 # Find out how long the conditional actually is.
2799 my @newlines = ($c =~ /\n/gs);
2800 my $cond_lines = 1 + $#newlines;
2803 $stat_real = raw_line($linenr, $cond_lines)
2804 . "\n" if ($cond_lines);
2805 if (defined($stat_real) && $cond_lines > 1) {
2806 $stat_real = "[...]\n$stat_real";
2809 ERROR("TRAILING_STATEMENTS",
2810 "trailing statements should be on next line\n" . $herecurr . $stat_real);
2814 # Check for bitwise tests written as boolean
2826 WARN("HEXADECIMAL_BOOLEAN_TEST",
2827 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2830 # if and else should not have general statements after it
2831 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2833 $s =~ s/$;//g; # Remove any comments
2834 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2835 ERROR("TRAILING_STATEMENTS",
2836 "trailing statements should be on next line\n" . $herecurr);
2839 # if should not continue a brace
2840 if ($line =~ /}\s*if\b/) {
2841 ERROR("TRAILING_STATEMENTS",
2842 "trailing statements should be on next line\n" .
2845 # case and default should not have general statements after them
2846 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2848 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2852 ERROR("TRAILING_STATEMENTS",
2853 "trailing statements should be on next line\n" . $herecurr);
2856 # Check for }<nl>else {, these must be at the same
2857 # indent level to be relevant to each other.
2858 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2859 $previndent == $indent) {
2860 ERROR("ELSE_AFTER_BRACE",
2861 "else should follow close brace '}'\n" . $hereprev);
2864 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2865 $previndent == $indent) {
2866 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2868 # Find out what is on the end of the line after the
2870 substr($s, 0, length($c), '');
2873 if ($s =~ /^\s*;/) {
2874 ERROR("WHILE_AFTER_BRACE",
2875 "while should follow close brace '}'\n" . $hereprev);
2879 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2880 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2881 # print "No studly caps, use _\n";
2882 # print "$herecurr";
2886 #no spaces allowed after \ in define
2887 if ($line=~/\#\s*define.*\\\s$/) {
2888 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2889 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
2892 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2893 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2895 my $checkfile = "include/linux/$file";
2896 if (-f "$root/$checkfile" &&
2897 $realfile ne $checkfile &&
2898 $1 !~ /$allowed_asm_includes/)
2900 if ($realfile =~ m{^arch/}) {
2901 CHK("ARCH_INCLUDE_LINUX",
2902 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2904 WARN("INCLUDE_LINUX",
2905 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2910 # multi-statement macros should be enclosed in a do while loop, grab the
2911 # first statement and ensure its the whole macro if its not enclosed
2912 # in a known good container
2913 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2914 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2917 my ($off, $dstat, $dcond, $rest);
2919 ($dstat, $dcond, $ln, $cnt, $off) =
2920 ctx_statement_block($linenr, $realcnt, 0);
2922 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2923 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2925 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
2927 $dstat =~ s/\\\n.//g;
2928 $dstat =~ s/^\s*//s;
2929 $dstat =~ s/\s*$//s;
2931 # Flatten any parentheses and braces
2932 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2933 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2934 $dstat =~ s/\[[^\[\]]*\]/1/)
2938 my $exceptions = qr{
2950 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2952 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
2953 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
2954 $dstat !~ /^(?:$Ident|-?$Constant)$/ && # 10 // foo()
2955 $dstat !~ /$exceptions/ &&
2956 $dstat !~ /^\.$Ident\s*=/ && # .foo =
2957 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
2958 $dstat !~ /^for\s*$Constant$/ && # for (...)
2959 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
2960 $dstat !~ /^do\s*{/ && # do {...
2961 $dstat !~ /^\({/) # ({...
2964 my $herectx = $here . "\n";
2965 my $cnt = statement_rawlines($ctx);
2967 for (my $n = 0; $n < $cnt; $n++) {
2968 $herectx .= raw_line($linenr, $n) . "\n";
2971 if ($dstat =~ /;/) {
2972 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
2973 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
2975 ERROR("COMPLEX_MACRO",
2976 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
2981 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
2982 # all assignments may have only one of the following with an assignment:
2985 # VMLINUX_SYMBOL(...)
2986 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
2987 WARN("MISSING_VMLINUX_SYMBOL",
2988 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
2991 # check for redundant bracing round if etc
2992 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
2993 my ($level, $endln, @chunks) =
2994 ctx_statement_full($linenr, $realcnt, 1);
2995 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
2996 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
2997 if ($#chunks > 0 && $level == 0) {
3000 my $herectx = $here . "\n";
3001 my $ln = $linenr - 1;
3002 for my $chunk (@chunks) {
3003 my ($cond, $block) = @{$chunk};
3005 # If the condition carries leading newlines, then count those as offsets.
3006 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3007 my $offset = statement_rawlines($whitespace) - 1;
3009 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3011 # We have looked at and allowed this specific line.
3012 $suppress_ifbraces{$ln + $offset} = 1;
3014 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
3015 $ln += statement_rawlines($block) - 1;
3017 substr($block, 0, length($cond), '');
3019 $seen++ if ($block =~ /^\s*{/);
3021 #print "cond<$cond> block<$block> allowed<$allowed>\n";
3022 if (statement_lines($cond) > 1) {
3023 #print "APW: ALLOWED: cond<$cond>\n";
3026 if ($block =~/\b(?:if|for|while)\b/) {
3027 #print "APW: ALLOWED: block<$block>\n";
3030 if (statement_block_size($block) > 1) {
3031 #print "APW: ALLOWED: lines block<$block>\n";
3035 if ($seen && !$allowed) {
3037 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3041 if (!defined $suppress_ifbraces{$linenr - 1} &&
3042 $line =~ /\b(if|while|for|else)\b/) {
3045 # Check the pre-context.
3046 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3047 #print "APW: ALLOWED: pre<$1>\n";
3051 my ($level, $endln, @chunks) =
3052 ctx_statement_full($linenr, $realcnt, $-[0]);
3054 # Check the condition.
3055 my ($cond, $block) = @{$chunks[0]};
3056 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3057 if (defined $cond) {
3058 substr($block, 0, length($cond), '');
3060 if (statement_lines($cond) > 1) {
3061 #print "APW: ALLOWED: cond<$cond>\n";
3064 if ($block =~/\b(?:if|for|while)\b/) {
3065 #print "APW: ALLOWED: block<$block>\n";
3068 if (statement_block_size($block) > 1) {
3069 #print "APW: ALLOWED: lines block<$block>\n";
3072 # Check the post-context.
3073 if (defined $chunks[1]) {
3074 my ($cond, $block) = @{$chunks[1]};
3075 if (defined $cond) {
3076 substr($block, 0, length($cond), '');
3078 if ($block =~ /^\s*\{/) {
3079 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3083 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3084 my $herectx = $here . "\n";
3085 my $cnt = statement_rawlines($block);
3087 for (my $n = 0; $n < $cnt; $n++) {
3088 $herectx .= raw_line($linenr, $n) . "\n";
3092 "braces {} are not necessary for single statement blocks\n" . $herectx);
3096 # don't include deprecated include files (uses RAW line)
3097 for my $inc (keys %dep_includes) {
3098 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
3099 ERROR("DEPRECATED_INCLUDE",
3100 "Don't use <$inc>, include " .
3101 "$dep_includes{$inc} instead\n" .
3106 # don't use deprecated functions
3107 for my $func (keys %dep_functions) {
3108 if ($line =~ /\b$func\b/) {
3109 ERROR("DEPRECATED_FUNCTION",
3110 "$func is deprecated, " .
3111 "use $dep_functions{$func} instead\n" .
3116 # try to replace assertions with error handling
3117 if ($line =~ /\bLASSERTF?\s*\(/) {
3119 "try to replace assertions with error handling\n" .
3123 # avoid new console messages
3124 if ($line =~ /\bLCONSOLE[A-Z_]*\s*\(/) {
3126 "avoid adding new console messages\n" .
3130 # minimize new CERROR messages
3131 if ($line =~ /\bC(EMERG|ERROR|NETERR|WARN)\s*\(/) {
3133 "think hard before adding new CERROR messages\n" .
3137 # no volatiles please
3138 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3139 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3141 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3145 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3146 CHK("REDUNDANT_CODE",
3147 "if this code is redundant consider removing it\n" .
3151 # check for needless kfree() checks
3152 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3154 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
3155 WARN("NEEDLESS_KFREE",
3156 "kfree(NULL) is safe this check is probably not required\n" . $hereprev);
3159 # check for needless usb_free_urb() checks
3160 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3162 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
3163 WARN("NEEDLESS_USB_FREE_URB",
3164 "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
3168 # prefer usleep_range over udelay
3169 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3170 # ignore udelay's < 10, however
3171 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
3173 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3177 # warn about unexpectedly long msleep's
3178 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3181 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3185 # warn about #ifdefs in C files
3186 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3187 # print "#ifdef in C files should be avoided\n";
3188 # print "$herecurr";
3192 # warn about spacing in #ifdefs
3193 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3195 "exactly one space required after that #$1\n" . $herecurr);
3198 # check for spinlock_t definitions without a comment.
3199 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3200 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3202 if (!ctx_has_comment($first_line, $linenr)) {
3203 CHK("UNCOMMENTED_DEFINITION",
3204 "$1 definition without comment\n" . $herecurr);
3207 # check for memory barriers without a comment.
3208 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3209 if (!ctx_has_comment($first_line, $linenr)) {
3210 CHK("MEMORY_BARRIER",
3211 "memory barrier without comment\n" . $herecurr);
3214 # check of hardware specific defines
3215 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3217 "architecture specific defines should be avoided\n" . $herecurr);
3220 # Check that the storage class is at the beginning of a declaration
3221 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3222 WARN("STORAGE_CLASS",
3223 "storage class should be at the beginning of the declaration\n" . $herecurr)
3226 # check the location of the inline attribute, that it is between
3227 # storage class and type.
3228 if ($line =~ /\b$Type\s+$Inline\b/ ||
3229 $line =~ /\b$Inline\s+$Storage\b/) {
3230 ERROR("INLINE_LOCATION",
3231 "inline keyword should sit between storage class and type\n" . $herecurr);
3234 # Check for __inline__ and __inline, prefer inline
3235 if ($line =~ /\b(__inline__|__inline)\b/) {
3237 "plain inline is preferred over $1\n" . $herecurr);
3240 # Check for __attribute__ packed, prefer __packed
3241 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3242 WARN("PREFER_PACKED",
3243 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3246 # Check for __attribute__ aligned, prefer __aligned
3247 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3248 WARN("PREFER_ALIGNED",
3249 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3252 # Check for __attribute__ format(printf, prefer __printf
3253 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3254 WARN("PREFER_PRINTF",
3255 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, 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 (defined $stat &&
3272 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
3278 if ($ms_size =~ /^(0x|)0$/i) {
3280 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3281 } elsif ($ms_size =~ /^(0x|)1$/i) {
3283 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3287 # typecasts on min/max could be min_t/max_t
3288 if (defined $stat &&
3289 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3290 if (defined $2 || defined $8) {
3292 my $cast1 = deparenthesize($2);
3294 my $cast2 = deparenthesize($8);
3298 if ($cast1 ne "" && $cast2 ne "") {
3299 $cast = "$cast1 or $cast2";
3300 } elsif ($cast1 ne "") {
3306 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
3310 # check for new externs in .c files.
3311 if ($realfile =~ /\.c$/ && defined $stat &&
3312 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3314 my $function_name = $1;
3315 my $paren_space = $2;
3318 if (defined $cond) {
3319 substr($s, 0, length($cond), '');
3321 if ($s =~ /^\s*;/ &&
3322 $function_name ne 'uninitialized_var')
3324 WARN("AVOID_EXTERNS",
3325 "externs should be avoided in .c files\n" . $herecurr);
3328 if ($paren_space =~ /\n/) {
3329 WARN("FUNCTION_ARGUMENTS",
3330 "arguments for function declarations should follow identifier\n" . $herecurr);
3333 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3334 $stat =~ /^.\s*extern\s+/)
3336 WARN("AVOID_EXTERNS",
3337 "externs should be avoided in .c files\n" . $herecurr);
3340 # checks for new __setup's
3341 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3344 if (!grep(/$name/, @setup_docs)) {
3345 CHK("UNDOCUMENTED_SETUP",
3346 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3350 # check for pointless casting of kmalloc return
3351 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
3352 WARN("UNNECESSARY_CASTS",
3353 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
3356 # check for multiple semicolons
3357 if ($line =~ /;\s*;\s*$/) {
3358 WARN("ONE_SEMICOLON",
3359 "Statements terminations use 1 semicolon\n" . $herecurr);
3362 # check for gcc specific __FUNCTION__
3363 if ($line =~ /__FUNCTION__/) {
3365 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
3368 # check for semaphores initialized locked
3369 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
3370 WARN("CONSIDER_COMPLETION",
3371 "consider using a completion\n" . $herecurr);
3374 # recommend kstrto* over simple_strto* and strict_strto*
3375 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
3376 WARN("CONSIDER_KSTRTO",
3377 "$1 is obsolete, use k$3 instead\n" . $herecurr);
3379 # check for __initcall(), use device_initcall() explicitly please
3380 if ($line =~ /^.\s*__initcall\s*\(/) {
3381 WARN("USE_DEVICE_INITCALL",
3382 "please use device_initcall() instead of __initcall()\n" . $herecurr);
3384 # check for various ops structs, ensure they are const.
3385 my $struct_ops = qr{acpi_dock_ops|
3386 address_space_operations|
3388 block_device_operations|
3393 file_lock_operations|
3403 lock_manager_operations|
3409 pipe_buf_operations|
3410 platform_hibernation_ops|
3411 platform_suspend_ops|
3416 soc_pcmcia_socket_ops|
3422 if ($line !~ /\bconst\b/ &&
3423 $line =~ /\bstruct\s+($struct_ops)\b/) {
3424 WARN("CONST_STRUCT",
3425 "struct $1 should normally be const\n" .
3429 # use of NR_CPUS is usually wrong
3430 # ignore definitions of NR_CPUS and usage to define arrays as likely right
3431 if ($line =~ /\bNR_CPUS\b/ &&
3432 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3433 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
3434 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3435 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3436 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
3439 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
3442 # check for %L{u,d,i} in strings
3444 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3445 $string = substr($rawline, $-[1], $+[1] - $-[1]);
3446 $string =~ s/%%/__/g;
3447 if ($string =~ /(?<!%)%L[udi]/) {
3449 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
3454 # whine mightly about in_atomic
3455 if ($line =~ /\bin_atomic\s*\(/) {
3456 if ($realfile =~ m@^drivers/@) {
3458 "do not use in_atomic in drivers\n" . $herecurr);
3459 } elsif ($realfile !~ m@^kernel/@) {
3461 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
3465 # check for lockdep_set_novalidate_class
3466 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3467 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3468 if ($realfile !~ m@^kernel/lockdep@ &&
3469 $realfile !~ m@^include/linux/lockdep@ &&
3470 $realfile !~ m@^drivers/base/core@) {
3472 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
3476 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3477 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
3478 WARN("EXPORTED_WORLD_WRITABLE",
3479 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
3482 if ($rawline =~ /version 3/) {
3484 "using GPLv3 is usually wrong\n" . $herecurr);
3488 # If we have no input at all, then there is nothing to report on
3489 # so just keep quiet.
3490 if ($#rawlines == -1) {
3494 # In mailback mode only produce a report in the negative, for
3495 # things that appear to be patches.
3496 if ($mailback && ($clean == 1 || !$is_patch)) {
3500 # This is not a patch, and we are are in 'no-patch' mode so
3502 if (!$chk_patch && !$is_patch) {
3507 ERROR("NOT_UNIFIED_DIFF",
3508 "Does not appear to be a unified-diff format patch\n");
3510 if ($is_patch && $chk_signoff && $signoff == 0) {
3511 ERROR("MISSING_SIGN_OFF",
3512 "Missing Signed-off-by: line(s)\n");
3515 print report_dump();
3516 if ($summary && !($clean == 1 && $quiet == 1)) {
3517 print "$filename " if ($summary_file);
3518 print "total: $cnt_error errors, $cnt_warn warnings, " .
3519 (($check)? "$cnt_chk checks, " : "") .
3520 "$cnt_lines lines checked\n";
3521 print "\n" if ($quiet == 0);
3525 # If there were whitespace errors which cleanpatch can fix
3526 # then suggest that.
3527 if ($rpt_cleaners) {
3528 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3529 print " scripts/cleanfile\n\n";
3534 if (keys %ignore_type) {
3535 print "NOTE: Ignored message types:";
3536 foreach my $ignore (sort keys %ignore_type) {
3540 print "\n" if ($quiet == 0);
3543 if ($clean == 1 && $quiet == 0) {
3544 print "$vname has no obvious style problems and is ready for submission.\n"
3546 if ($clean == 0 && $quiet == 0) {
3548 $vname has style problems, please review.
3550 If any of these errors are false positives, please report
3551 them to the maintainer, see CHECKPATCH in MAINTAINERS.