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_MASK',
436 'CFS_PAGE_SIZE', 'PAGE_SIZE',
437 'PAGE_CACHE_MASK', 'PAGE_MASK',
438 'PAGE_CACHE_SIZE', 'PAGE_SIZE',
439 'PAGE_CACHE_SHIFT', 'PAGE_SHIFT',
441 'page_cache_release', 'put_page',
442 'page_cache_get', 'get_page',
444 'cfs_proc_dir_entry_t', 'struct proc_dir_entry',
446 'cfs_rcu_head_t', 'struct rcu_head',
448 'cfs_hash_lock_t', 'union cfs_hash_lock',
449 'cfs_hash_bucket_t', 'struct cfs_hash_bucket',
450 'cfs_hash_bd_t', 'struct cfs_hash_bd',
451 'cfs_hash_t', 'struct cfs_hash',
452 'cfs_hash_lock_ops_t', 'struct cfs_hash_lock_ops',
453 'cfs_hash_hlist_ops_t', 'struct cfs_hash_hlist_ops',
454 'cfs_hash_ops_t', 'struct cfs_hash_ops',
455 'cfs_hash_head_t', 'struct cfs_hash_head',
456 'cfs_hash_head_dep_t', 'struct cfs_hash_head_dep',
457 'cfs_hash_dhead_t', 'struct cfs_hash_dhead',
458 'cfs_hash_dhead_dep_t', 'struct cfs_hash_dhead_dep',
459 'cfs_hash_lookup_intent_t', 'enum cfs_hash_lookup_intent',
460 'cfs_hash_cond_arg_t', 'struct cfs_hash_cond_arg',
462 'lnet_ni_status_t', 'struct lnet_ni_status',
463 'lnet_ping_info_t', 'struct lnet_ping_info',
464 'lnet_process_id_packed_t', 'struct lnet_process_id_packed',
465 'lnet_handle_wire_t', 'struct lnet_handle_wire',
466 'lnet_hdr_t', 'struct lnet_hdr',
467 'lnet_magicversion_t', 'struct lnet_magicversion',
468 'lnet_acceptor_connreq_t', 'struct lnet_acceptor_connreq',
469 'lnet_counters_t', 'struct lnet_counters',
471 'ldlm_appetite_t', 'enum ldlm_appetite',
472 'ldlm_cancel_flags_t', 'enum ldlm_cancel_flags',
473 'ldlm_error_t', 'enum ldlm_error',
474 'ldlm_ns_hash_def_t', 'struct ldlm_ns_hash_def',
475 'ldlm_mode_t', 'enum ldlm_mode',
476 'ldlm_ns_type_t', 'enum ldlm_ns_type',
477 'ldlm_policy_data_t', 'enum ldlm_policy_data',
478 'ldlm_policy_res_t', 'enum ldlm_policy_res',
479 'ldlm_side_t', 'enum ldlm_side',
480 'ldlm_type_t', 'enum ldlm_type',
481 'ldlm_wire_policy_data_t', 'union ldlm_wire_policy_data',
494 'LPROCFS', 'CONFIG_PROC_FS',
496 'sprintf', 'snprintf',
499 'tempnam', 'mkstemp',
500 'f_dentry', 'f_path.dentry',
501 '= seq_printf', 'seq_printf',
502 'return seq_printf', 'seq_printf',
504 'DN_MAX_BONUSLEN', 'DN_BONUS_SIZE(dnodesize)',
505 'DN_OLD_MAX_BONUSLEN', 'DN_BONUS_SIZE(DNODE_MIN_SIZE)',
511 for my $filename (@ARGV) {
514 open($FILE, '-|', "diff -u /dev/null $filename") ||
515 die "$P: $filename: diff failed - $!\n";
516 } elsif ($filename eq '-') {
517 open($FILE, '<&STDIN');
519 open($FILE, '<', "$filename") ||
520 die "$P: $filename: open failed - $!\n";
522 if ($filename eq '-') {
523 $vname = 'Your patch';
532 if (!process($filename)) {
541 sub top_of_kernel_tree {
545 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile",
546 "README", "Documentation", "arch", "include", "drivers",
547 "fs", "init", "ipc", "kernel", "lib", "scripts",
550 foreach my $check (@tree_check) {
551 if (! -e $root . '/' . $check) {
559 my ($formatted_email) = @_;
565 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) {
568 $comment = $3 if defined $3;
569 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) {
571 $comment = $2 if defined $2;
572 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) {
574 $comment = $2 if defined $2;
575 $formatted_email =~ s/$address.*$//;
576 $name = $formatted_email;
577 $name =~ s/^\s+|\s+$//g;
578 $name =~ s/^\"|\"$//g;
579 # If there's a name left after stripping spaces and
580 # leading quotes, and the address doesn't have both
581 # leading and trailing angle brackets, the address
583 # "joe smith joe@smith.com" bad
584 # "joe smith <joe@smith.com" bad
585 if ($name ne "" && $address !~ /^<[^>]+>$/) {
592 $name =~ s/^\s+|\s+$//g;
593 $name =~ s/^\"|\"$//g;
594 $address =~ s/^\s+|\s+$//g;
595 $address =~ s/^\<|\>$//g;
597 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
598 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
602 return ($name, $address, $comment);
606 my ($name, $address) = @_;
610 $name =~ s/^\s+|\s+$//g;
611 $name =~ s/^\"|\"$//g;
612 $address =~ s/^\s+|\s+$//g;
614 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars
615 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes
620 $formatted_email = "$address";
622 $formatted_email = "$name <$address>";
625 return $formatted_email;
631 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) {
632 if (-e "$path/$conf") {
633 return "$path/$conf";
645 for my $c (split(//, $str)) {
649 for (; ($n % 8) != 0; $n++) {
661 (my $res = shift) =~ tr/\t/ /c;
668 # Drop the diff line leader and expand tabs
670 $line = expand_tabs($line);
672 # Pick the indent from the front of the line.
673 my ($white) = ($line =~ /^(\s*)/);
675 return (length($line), length($white));
678 my $sanitise_quote = '';
680 sub sanitise_line_reset {
681 my ($in_comment) = @_;
684 $sanitise_quote = '*/';
686 $sanitise_quote = '';
699 # Always copy over the diff marker.
700 $res = substr($line, 0, 1);
702 for ($off = 1; $off < length($line); $off++) {
703 $c = substr($line, $off, 1);
705 # Comments we are wacking completly including the begin
706 # and end, all to $;.
707 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') {
708 $sanitise_quote = '*/';
710 substr($res, $off, 2, "$;$;");
714 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') {
715 $sanitise_quote = '';
716 substr($res, $off, 2, "$;$;");
720 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') {
721 $sanitise_quote = '//';
723 substr($res, $off, 2, $sanitise_quote);
728 # A \ in a string means ignore the next character.
729 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') &&
731 substr($res, $off, 2, 'XX');
736 if ($c eq "'" || $c eq '"') {
737 if ($sanitise_quote eq '') {
738 $sanitise_quote = $c;
740 substr($res, $off, 1, $c);
742 } elsif ($sanitise_quote eq $c) {
743 $sanitise_quote = '';
747 #print "c<$c> SQ<$sanitise_quote>\n";
748 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") {
749 substr($res, $off, 1, $;);
750 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") {
751 substr($res, $off, 1, $;);
752 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") {
753 substr($res, $off, 1, 'X');
755 substr($res, $off, 1, $c);
759 if ($sanitise_quote eq '//') {
760 $sanitise_quote = '';
763 # The pathname on a #include may be surrounded by '<' and '>'.
764 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) {
765 my $clean = 'X' x length($1);
766 $res =~ s@\<.*\>@<$clean>@;
768 # The whole of a #error is a string.
769 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) {
770 my $clean = 'X' x length($1);
771 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@;
777 sub ctx_statement_block {
778 my ($linenr, $remain, $off) = @_;
779 my $line = $linenr - 1;
796 @stack = (['', 0]) if ($#stack == -1);
798 #warn "CSB: blk<$blk> remain<$remain>\n";
799 # If we are about to drop off the end, pull in more
802 for (; $remain > 0; $line++) {
803 last if (!defined $lines[$line]);
804 next if ($lines[$line] =~ /^-/);
807 $blk .= $lines[$line] . "\n";
812 # Bail if there is no further context.
813 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
817 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) {
823 $c = substr($blk, $off, 1);
824 $remainder = substr($blk, $off);
826 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
828 # Handle nested #if/#else.
829 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) {
830 push(@stack, [ $type, $level ]);
831 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) {
832 ($type, $level) = @{$stack[$#stack - 1]};
833 } elsif ($remainder =~ /^#\s*endif\b/) {
834 ($type, $level) = @{pop(@stack)};
837 # Statement ends at the ';' or a close '}' at the
839 if ($level == 0 && $c eq ';') {
843 # An else is really a conditional as long as its not else if
844 if ($level == 0 && $coff_set == 0 &&
845 (!defined($p) || $p =~ /(?:\s|\}|\+)/) &&
846 $remainder =~ /^(else)(?:\s|{)/ &&
847 $remainder !~ /^else\s+if\b/) {
848 $coff = $off + length($1) - 1;
850 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
851 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
854 if (($type eq '' || $type eq '(') && $c eq '(') {
858 if ($type eq '(' && $c eq ')') {
860 $type = ($level != 0)? '(' : '';
862 if ($level == 0 && $coff < $soff) {
865 #warn "CSB: mark coff<$coff>\n";
868 if (($type eq '' || $type eq '{') && $c eq '{') {
872 if ($type eq '{' && $c eq '}') {
874 $type = ($level != 0)? '{' : '';
877 if (substr($blk, $off + 1, 1) eq ';') {
883 # Preprocessor commands end at the newline unless escaped.
884 if ($type eq '#' && $c eq "\n" && $p ne "\\") {
892 # We are truly at the end, so shuffle to the next line.
899 my $statement = substr($blk, $soff, $off - $soff + 1);
900 my $condition = substr($blk, $soff, $coff - $soff + 1);
902 #warn "STATEMENT<$statement>\n";
903 #warn "CONDITION<$condition>\n";
905 #print "coff<$coff> soff<$off> loff<$loff>\n";
907 return ($statement, $condition,
908 $line, $remain + 1, $off - $loff + 1, $level);
911 sub statement_lines {
914 # Strip the diff line prefixes and rip blank lines at start and end.
915 $stmt =~ s/(^|\n)./$1/g;
919 my @stmt_lines = ($stmt =~ /\n/g);
921 return $#stmt_lines + 2;
924 sub statement_rawlines {
927 my @stmt_lines = ($stmt =~ /\n/g);
929 return $#stmt_lines + 2;
932 sub statement_block_size {
935 $stmt =~ s/(^|\n)./$1/g;
941 my @stmt_lines = ($stmt =~ /\n/g);
942 my @stmt_statements = ($stmt =~ /;/g);
944 my $stmt_lines = $#stmt_lines + 2;
945 my $stmt_statements = $#stmt_statements + 1;
947 if ($stmt_lines > $stmt_statements) {
950 return $stmt_statements;
954 sub ctx_statement_full {
955 my ($linenr, $remain, $off) = @_;
956 my ($statement, $condition, $level);
960 # Grab the first conditional/block pair.
961 ($statement, $condition, $linenr, $remain, $off, $level) =
962 ctx_statement_block($linenr, $remain, $off);
963 #print "F: c<$condition> s<$statement> remain<$remain>\n";
964 push(@chunks, [ $condition, $statement ]);
965 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) {
966 return ($level, $linenr, @chunks);
969 # Pull in the following conditional/block pairs and see if they
970 # could continue the statement.
972 ($statement, $condition, $linenr, $remain, $off, $level) =
973 ctx_statement_block($linenr, $remain, $off);
974 #print "C: c<$condition> s<$statement> remain<$remain>\n";
975 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s));
977 push(@chunks, [ $condition, $statement ]);
980 return ($level, $linenr, @chunks);
984 my ($linenr, $remain, $outer, $open, $close, $off) = @_;
986 my $start = $linenr - 1;
993 my @stack = ($level);
994 for ($line = $start; $remain > 0; $line++) {
995 next if ($rawlines[$line] =~ /^-/);
998 $blk .= $rawlines[$line];
1000 # Handle nested #if/#else.
1001 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) {
1002 push(@stack, $level);
1003 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) {
1004 $level = $stack[$#stack - 1];
1005 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) {
1006 $level = pop(@stack);
1009 foreach my $c (split(//, $lines[$line])) {
1010 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1016 if ($c eq $close && $level > 0) {
1018 last if ($level == 0);
1019 } elsif ($c eq $open) {
1024 if (!$outer || $level <= 1) {
1025 push(@res, $rawlines[$line]);
1028 last if ($level == 0);
1031 return ($level, @res);
1033 sub ctx_block_outer {
1034 my ($linenr, $remain) = @_;
1036 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0);
1040 my ($linenr, $remain) = @_;
1042 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1046 my ($linenr, $remain, $off) = @_;
1048 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1051 sub ctx_block_level {
1052 my ($linenr, $remain) = @_;
1054 return ctx_block_get($linenr, $remain, 0, '{', '}', 0);
1056 sub ctx_statement_level {
1057 my ($linenr, $remain, $off) = @_;
1059 return ctx_block_get($linenr, $remain, 0, '(', ')', $off);
1062 sub ctx_locate_comment {
1063 my ($first_line, $end_line) = @_;
1065 # Catch a comment on the end of the line itself.
1066 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@);
1067 return $current_comment if (defined $current_comment);
1069 # Look through the context and try and figure out if there is a
1072 $current_comment = '';
1073 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) {
1074 my $line = $rawlines[$linenr - 1];
1076 if ($linenr == $first_line and $line =~ m@^.\s*\*@) {
1079 if ($line =~ m@/\*@) {
1082 if (!$in_comment && $current_comment ne '') {
1083 $current_comment = '';
1085 $current_comment .= $line . "\n" if ($in_comment);
1086 if ($line =~ m@\*/@) {
1091 chomp($current_comment);
1092 return($current_comment);
1094 sub ctx_has_comment {
1095 my ($first_line, $end_line) = @_;
1096 my $cmt = ctx_locate_comment($first_line, $end_line);
1098 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1099 ##print "CMMT: $cmt\n";
1101 return ($cmt ne '');
1105 my ($linenr, $cnt) = @_;
1107 my $offset = $linenr - 1;
1112 $line = $rawlines[$offset++];
1113 next if (defined($line) && $line =~ /^-/);
1125 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) {
1128 $coded = sprintf("^%c", unpack('C', $2) + 64);
1137 my $av_preprocessor = 0;
1142 sub annotate_reset {
1143 $av_preprocessor = 0;
1145 @av_paren_type = ('E');
1146 $av_pend_colon = 'O';
1149 sub annotate_values {
1150 my ($stream, $type) = @_;
1153 my $var = '_' x length($stream);
1156 print "$stream\n" if ($dbg_values > 1);
1158 while (length($cur)) {
1159 @av_paren_type = ('E') if ($#av_paren_type < 0);
1160 print " <" . join('', @av_paren_type) .
1161 "> <$type> <$av_pending>" if ($dbg_values > 1);
1162 if ($cur =~ /^(\s+)/o) {
1163 print "WS($1)\n" if ($dbg_values > 1);
1164 if ($1 =~ /\n/ && $av_preprocessor) {
1165 $type = pop(@av_paren_type);
1166 $av_preprocessor = 0;
1169 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') {
1170 print "CAST($1)\n" if ($dbg_values > 1);
1171 push(@av_paren_type, $type);
1174 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) {
1175 print "DECLARE($1)\n" if ($dbg_values > 1);
1178 } elsif ($cur =~ /^($Modifier)\s*/) {
1179 print "MODIFIER($1)\n" if ($dbg_values > 1);
1182 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) {
1183 print "DEFINE($1,$2)\n" if ($dbg_values > 1);
1184 $av_preprocessor = 1;
1185 push(@av_paren_type, $type);
1191 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) {
1192 print "UNDEF($1)\n" if ($dbg_values > 1);
1193 $av_preprocessor = 1;
1194 push(@av_paren_type, $type);
1196 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) {
1197 print "PRE_START($1)\n" if ($dbg_values > 1);
1198 $av_preprocessor = 1;
1200 push(@av_paren_type, $type);
1201 push(@av_paren_type, $type);
1204 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) {
1205 print "PRE_RESTART($1)\n" if ($dbg_values > 1);
1206 $av_preprocessor = 1;
1208 push(@av_paren_type, $av_paren_type[$#av_paren_type]);
1212 } elsif ($cur =~ /^(\#\s*(?:endif))/o) {
1213 print "PRE_END($1)\n" if ($dbg_values > 1);
1215 $av_preprocessor = 1;
1217 # Assume all arms of the conditional end as this
1218 # one does, and continue as if the #endif was not here.
1219 pop(@av_paren_type);
1220 push(@av_paren_type, $type);
1223 } elsif ($cur =~ /^(\\\n)/o) {
1224 print "PRECONT($1)\n" if ($dbg_values > 1);
1226 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) {
1227 print "ATTR($1)\n" if ($dbg_values > 1);
1228 $av_pending = $type;
1231 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) {
1232 print "SIZEOF($1)\n" if ($dbg_values > 1);
1238 } elsif ($cur =~ /^(if|while|for)\b/o) {
1239 print "COND($1)\n" if ($dbg_values > 1);
1243 } elsif ($cur =~/^(case)/o) {
1244 print "CASE($1)\n" if ($dbg_values > 1);
1245 $av_pend_colon = 'C';
1248 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) {
1249 print "KEYWORD($1)\n" if ($dbg_values > 1);
1252 } elsif ($cur =~ /^(\()/o) {
1253 print "PAREN('$1')\n" if ($dbg_values > 1);
1254 push(@av_paren_type, $av_pending);
1258 } elsif ($cur =~ /^(\))/o) {
1259 my $new_type = pop(@av_paren_type);
1260 if ($new_type ne '_') {
1262 print "PAREN('$1') -> $type\n"
1263 if ($dbg_values > 1);
1265 print "PAREN('$1')\n" if ($dbg_values > 1);
1268 } elsif ($cur =~ /^($Ident)\s*\(/o) {
1269 print "FUNC($1)\n" if ($dbg_values > 1);
1273 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) {
1274 if (defined $2 && $type eq 'C' || $type eq 'T') {
1275 $av_pend_colon = 'B';
1276 } elsif ($type eq 'E') {
1277 $av_pend_colon = 'L';
1279 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1);
1282 } elsif ($cur =~ /^($Ident|$Constant)/o) {
1283 print "IDENT($1)\n" if ($dbg_values > 1);
1286 } elsif ($cur =~ /^($Assignment)/o) {
1287 print "ASSIGN($1)\n" if ($dbg_values > 1);
1290 } elsif ($cur =~/^(;|{|})/) {
1291 print "END($1)\n" if ($dbg_values > 1);
1293 $av_pend_colon = 'O';
1295 } elsif ($cur =~/^(,)/) {
1296 print "COMMA($1)\n" if ($dbg_values > 1);
1299 } elsif ($cur =~ /^(\?)/o) {
1300 print "QUESTION($1)\n" if ($dbg_values > 1);
1303 } elsif ($cur =~ /^(:)/o) {
1304 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1);
1306 substr($var, length($res), 1, $av_pend_colon);
1307 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') {
1312 $av_pend_colon = 'O';
1314 } elsif ($cur =~ /^(\[)/o) {
1315 print "CLOSE($1)\n" if ($dbg_values > 1);
1318 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) {
1321 print "OPV($1)\n" if ($dbg_values > 1);
1328 substr($var, length($res), 1, $variant);
1331 } elsif ($cur =~ /^($Operators)/o) {
1332 print "OP($1)\n" if ($dbg_values > 1);
1333 if ($1 ne '++' && $1 ne '--') {
1337 } elsif ($cur =~ /(^.)/o) {
1338 print "C($1)\n" if ($dbg_values > 1);
1341 $cur = substr($cur, length($1));
1342 $res .= $type x length($1);
1346 return ($res, $var);
1350 my ($possible, $line) = @_;
1351 my $notPermitted = qr{(?:
1368 ^(?:typedef|struct|enum)\b
1370 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2);
1371 if ($possible !~ $notPermitted) {
1372 # Check for modifiers.
1373 $possible =~ s/\s*$Storage\s*//g;
1374 $possible =~ s/\s*$Sparse\s*//g;
1375 if ($possible =~ /^\s*$/) {
1377 } elsif ($possible =~ /\s/) {
1378 $possible =~ s/\s*$Type\s*//g;
1379 for my $modifier (split(' ', $possible)) {
1380 if ($modifier !~ $notPermitted) {
1381 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible);
1382 push(@modifierList, $modifier);
1387 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible);
1388 push(@typeList, $possible);
1392 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1);
1399 return !defined $ignore_type{$_[0]};
1403 if (!show_type($_[1]) ||
1404 (defined $tst_only && $_[2] !~ /\Q$tst_only\E/)) {
1409 $line = "$prefix$_[0]:$_[1]: $_[2]\n";
1411 $line = "$prefix$_[0]: $_[2]\n";
1413 $line = (split('\n', $line))[0] . "\n" if ($terse);
1415 push(our @report, $line);
1424 if (report("ERROR", $_[0], $_[1])) {
1430 if (report("WARNING", $_[0], $_[1])) {
1436 if ($check && report("CHECK", $_[0], $_[1])) {
1442 sub check_absolute_file {
1443 my ($absolute, $herecurr) = @_;
1444 my $file = $absolute;
1446 ##print "absolute<$absolute>\n";
1448 # See if any suffix of this path is a path within the tree.
1449 while ($file =~ s@^[^/]*/@@) {
1450 if (-f "$root/$file") {
1451 ##print "file<$file>\n";
1459 # It is, so see if the prefix is acceptable.
1460 my $prefix = $absolute;
1461 substr($prefix, -length($file)) = '';
1463 ##print "prefix<$prefix>\n";
1464 if ($prefix ne ".../") {
1465 WARN("USE_RELATIVE_PATH",
1466 "use relative pathname instead of absolute in changelog text\n" . $herecurr);
1471 my $filename = shift;
1477 my $stashrawline="";
1488 my $in_header_lines = 1;
1489 my $in_commit_log = 0; #Scanning lines before patch
1497 # Trace the real file/line as we go.
1503 my $comment_edge = 0;
1507 my $prev_values = 'E';
1510 my %suppress_ifbraces;
1511 my %suppress_whiletrailers;
1512 my %suppress_export;
1513 my $suppress_statement = 0;
1515 # Pre-scan the patch sanitizing the lines.
1516 # Pre-scan the patch looking for any __setup documentation.
1518 my @setup_docs = ();
1521 sanitise_line_reset();
1523 foreach my $rawline (@rawlines) {
1527 if ($rawline=~/^\+\+\+\s+(\S+)/) {
1529 if ($1 =~ m@Documentation/kernel-parameters.txt$@) {
1534 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1543 # Guestimate if this is a continuing comment. Run
1544 # the context looking for a comment "edge". If this
1545 # edge is a close comment then we must be in a comment
1549 for (my $ln = $linenr + 1; $cnt > 0; $ln++) {
1550 next if (defined $rawlines[$ln - 1] &&
1551 $rawlines[$ln - 1] =~ /^-/);
1553 #print "RAW<$rawlines[$ln - 1]>\n";
1554 last if (!defined $rawlines[$ln - 1]);
1555 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ &&
1556 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) {
1561 if (defined $edge && $edge eq '*/') {
1565 # Guestimate if this is a continuing comment. If this
1566 # is the start of a diff block and this line starts
1567 # ' *' then it is very likely a comment.
1568 if (!defined $edge &&
1569 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@)
1574 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1575 sanitise_line_reset($in_comment);
1577 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) {
1578 # Standardise the strings and chars within the input to
1579 # simplify matching -- only bother with positive lines.
1580 $line = sanitise_line($rawline);
1582 push(@lines, $line);
1585 $realcnt-- if ($line =~ /^(?:\+| |$)/);
1590 #print "==>$rawline\n";
1591 #print "-->$line\n";
1593 if ($setup_docs && $line =~ /^\+/) {
1594 push(@setup_docs, $line);
1602 foreach my $line (@lines) {
1605 my $rawline = $rawlines[$linenr - 1];
1607 #extract the line range in the file after the patch is applied
1608 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) {
1610 $first_line = $linenr + 1;
1620 %suppress_ifbraces = ();
1621 %suppress_whiletrailers = ();
1622 %suppress_export = ();
1623 $suppress_statement = 0;
1626 # track the line number as we move through the hunk, note that
1627 # new versions of GNU diff omit the leading space on completely
1628 # blank context lines so we need to count that too.
1629 } elsif ($line =~ /^( |\+|$)/) {
1631 $realcnt-- if ($realcnt != 0);
1633 # Measure the line length and indent.
1634 ($length, $indent) = line_stats($rawline);
1636 # Track the previous line.
1637 ($prevline, $stashline) = ($stashline, $line);
1638 ($previndent, $stashindent) = ($stashindent, $indent);
1639 ($prevrawline, $stashrawline) = ($stashrawline, $rawline);
1641 #warn "line<$line>\n";
1643 } elsif ($realcnt == 1) {
1647 my $hunk_line = ($realcnt != 0);
1649 #make up the handle for any error we report on this line
1650 $prefix = "$filename:$realline: " if ($emacs && $file);
1651 $prefix = "$filename:$linenr: " if ($emacs && !$file);
1653 $here = "#$linenr: " if (!$file);
1654 $here = "#$realline: " if ($file);
1656 # extract the filename as it passes
1657 if ($line =~ /^diff --git.*?(\S+)$/) {
1659 $realfile =~ s@^([^/]*)/@@;
1661 } elsif ($line =~ /^\+\+\+\s+(\S+)/) {
1663 $realfile =~ s@^([^/]*)/@@;
1667 if (!$file && $tree && $p1_prefix ne '' &&
1668 -e "$root/$p1_prefix") {
1669 WARN("PATCH_PREFIX",
1670 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n");
1673 if ($realfile =~ m@^include/asm/@) {
1674 ERROR("MODIFIED_INCLUDE_ASM",
1675 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1680 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0);
1682 my $hereline = "$here\n$rawline\n";
1683 my $herecurr = "$here\n$rawline\n";
1684 my $hereprev = "$here\n$prevrawline\n$rawline\n";
1686 $cnt_lines++ if ($realcnt != 0);
1688 # Check for incorrect file permissions
1689 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) {
1690 my $permhere = $here . "FILE: $realfile\n";
1691 if ($realfile =~ /(Makefile|Kconfig|\.c|\.h|\.S|\.tmpl)$/) {
1692 ERROR("EXECUTE_PERMISSIONS",
1693 "do not set execute permissions for source files\n" . $permhere);
1697 # Check the patch for a signoff:
1698 if ($line =~ /^\s*signed-off-by:/i) {
1703 # Check signature styles
1704 if (!$in_header_lines &&
1705 $line =~ /^(\s*)($signature_tags)(\s*)(.*)/) {
1706 my $space_before = $1;
1708 my $space_after = $3;
1710 my $ucfirst_sign_off = ucfirst(lc($sign_off));
1712 if (defined $space_before && $space_before ne "") {
1713 WARN("BAD_SIGN_OFF",
1714 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr);
1716 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) {
1717 WARN("BAD_SIGN_OFF",
1718 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr);
1720 if (!defined $space_after || $space_after ne " ") {
1721 WARN("BAD_SIGN_OFF",
1722 "Use a single space after $ucfirst_sign_off\n" . $herecurr);
1725 my ($email_name, $email_address, $comment) = parse_email($email);
1726 my $suggested_email = format_email(($email_name, $email_address));
1727 if ($suggested_email eq "") {
1728 ERROR("BAD_SIGN_OFF",
1729 "Unrecognized email address: '$email'\n" . $herecurr);
1731 my $dequoted = $suggested_email;
1732 $dequoted =~ s/^"//;
1733 $dequoted =~ s/" </ </;
1734 # Don't force email to have quotes
1735 # Allow just an angle bracketed address
1736 if ("$dequoted$comment" ne $email &&
1737 "<$email_address>$comment" ne $email &&
1738 "$suggested_email$comment" ne $email) {
1739 WARN("BAD_SIGN_OFF",
1740 "email address '$email' might be better as '$suggested_email$comment'\n" . $herecurr);
1745 # Check for wrappage within a valid hunk of the file
1746 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) {
1747 ERROR("CORRUPTED_PATCH",
1748 "patch seems to be corrupt (line wrapped?)\n" .
1749 $herecurr) if (!$emitted_corrupt++);
1752 # Check for absolute kernel paths.
1754 while ($line =~ m{(?:^|\s)(/\S*)}g) {
1757 if ($file =~ m{^(.*?)(?::\d+)+:?$} &&
1758 check_absolute_file($1, $herecurr)) {
1761 check_absolute_file($file, $herecurr);
1766 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1767 if (($realfile =~ /^$/ || $line =~ /^\+/) &&
1768 $rawline !~ m/^$UTF8*$/) {
1769 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/);
1771 my $blank = copy_spacing($rawline);
1772 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^";
1773 my $hereptr = "$hereline$ptr\n";
1776 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr);
1779 # Check if it's the start of a commit log
1780 # (not a header line and we haven't seen the patch filename)
1781 if ($in_header_lines && $realfile =~ /^$/ &&
1782 $rawline !~ /^(commit\b|from\b|[\w-]+:).+$/i) {
1783 $in_header_lines = 0;
1787 # Still not yet in a patch, check for any UTF-8
1788 if ($in_commit_log && $realfile =~ /^$/ &&
1789 $rawline =~ /$NON_ASCII_UTF8/) {
1790 CHK("UTF8_BEFORE_PATCH",
1791 "8-bit UTF-8 used in possible commit log\n" . $herecurr);
1794 # ignore non-hunk lines and lines being removed
1795 next if (!$hunk_line || $line =~ /^-/);
1797 #trailing whitespace
1798 if ($line =~ /^\+.*\015/) {
1799 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1800 ERROR("DOS_LINE_ENDINGS",
1801 "DOS line endings\n" . $herevet);
1803 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) {
1804 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1805 ERROR("TRAILING_WHITESPACE",
1806 "trailing whitespace\n" . $herevet);
1810 # check for Kconfig help text having a real description
1811 # Only applies when adding the entry originally, after that we do not have
1812 # sufficient context to determine whether it is indeed long enough.
1813 if ($realfile =~ /Kconfig/ &&
1814 $line =~ /.\s*config\s+/) {
1817 my $ln = $linenr + 1;
1821 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) {
1822 $f = $lines[$ln - 1];
1823 $cnt-- if ($lines[$ln - 1] !~ /^-/);
1824 $is_end = $lines[$ln - 1] =~ /^\+/;
1826 next if ($f =~ /^-/);
1828 if ($lines[$ln - 1] =~ /.\s*(?:bool|tristate)\s*\"/) {
1830 } elsif ($lines[$ln - 1] =~ /.\s*(?:---)?help(?:---)?$/) {
1837 next if ($f =~ /^$/);
1838 if ($f =~ /^\s*config\s/) {
1844 WARN("CONFIG_DESCRIPTION",
1845 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
1846 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
1849 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) &&
1850 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) {
1853 'EXTRA_AFLAGS' => 'asflags-y',
1854 'EXTRA_CFLAGS' => 'ccflags-y',
1855 'EXTRA_CPPFLAGS' => 'cppflags-y',
1856 'EXTRA_LDFLAGS' => 'ldflags-y',
1859 WARN("DEPRECATED_VARIABLE",
1860 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
1863 # check we are in a valid source file if not then ignore this hunk
1864 next if ($realfile !~ /\.(h|c|s|S|pl|sh)$/);
1867 if ($line =~ /^\+/ && $prevrawline !~ /\/\*\*/ &&
1868 $rawline !~ /^.\s*\*\s*\@$Ident\s/ &&
1869 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
1870 $line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) &&
1874 "line over 80 characters\n" . $herecurr);
1877 # check for spaces before a quoted newline
1878 if ($rawline =~ /^.*\".*\s\\n/) {
1879 WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE",
1880 "unnecessary whitespace before a quoted newline\n" . $herecurr);
1883 # check for adding lines without a newline.
1884 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
1885 WARN("MISSING_EOF_NEWLINE",
1886 "adding a line without newline at end of file\n" . $herecurr);
1889 # Blackfin: use hi/lo macros
1890 if ($realfile =~ m@arch/blackfin/.*\.S$@) {
1891 if ($line =~ /\.[lL][[:space:]]*=.*&[[:space:]]*0x[fF][fF][fF][fF]/) {
1892 my $herevet = "$here\n" . cat_vet($line) . "\n";
1894 "use the LO() macro, not (... & 0xFFFF)\n" . $herevet);
1896 if ($line =~ /\.[hH][[:space:]]*=.*>>[[:space:]]*16/) {
1897 my $herevet = "$here\n" . cat_vet($line) . "\n";
1899 "use the HI() macro, not (... >> 16)\n" . $herevet);
1903 # check we are in a valid source file C, perl or bash script
1904 # if not then ignore this hunk
1905 next if ($realfile !~ /\.(h|c|pl|sh)$/);
1907 # at the beginning of a line any tabs must come first and anything
1908 # more than 8 must use tabs.
1909 if ($rawline =~ /^\+\s* \t\s*\S/ ||
1910 $rawline =~ /^\+\s* \s*/) {
1911 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1912 ERROR("CODE_INDENT",
1913 "code indent should use tabs where possible\n" . $herevet);
1917 # check for space before tabs.
1918 if ($rawline =~ /^\+/ && $rawline =~ / \t/) {
1919 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1920 WARN("SPACE_BEFORE_TAB",
1921 "please, no space before tabs\n" . $herevet);
1924 # check for spaces at the beginning of a line.
1926 # 1) within comments
1927 # 2) indented preprocessor commands
1929 if ($rawline =~ /^\+ / && $line !~ /\+ *(?:$;|#|$Ident:)/) {
1930 my $herevet = "$here\n" . cat_vet($rawline) . "\n";
1931 WARN("LEADING_SPACE",
1932 "please, no spaces at the start of a line\n" . $herevet);
1935 # check we are in a valid C source file if not then ignore this hunk
1936 next if ($realfile !~ /\.(h|c)$/);
1938 # check for RCS/CVS revision markers
1939 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) {
1941 "CVS style keyword markers, these will _not_ be updated\n". $herecurr);
1944 # Blackfin: don't use __builtin_bfin_[cs]sync
1945 if ($line =~ /__builtin_bfin_csync/) {
1946 my $herevet = "$here\n" . cat_vet($line) . "\n";
1948 "use the CSYNC() macro in asm/blackfin.h\n" . $herevet);
1950 if ($line =~ /__builtin_bfin_ssync/) {
1951 my $herevet = "$here\n" . cat_vet($line) . "\n";
1953 "use the SSYNC() macro in asm/blackfin.h\n" . $herevet);
1956 # Check for potential 'bare' types
1957 my ($stat, $cond, $line_nr_next, $remain_next, $off_next,
1959 #print "LINE<$line>\n";
1960 if ($linenr >= $suppress_statement &&
1961 $realcnt && $line =~ /.\s*\S/) {
1962 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
1963 ctx_statement_block($linenr, $realcnt, 0);
1964 $stat =~ s/\n./\n /g;
1965 $cond =~ s/\n./\n /g;
1967 #print "linenr<$linenr> <$stat>\n";
1968 # If this statement has no statement boundaries within
1969 # it there is no point in retrying a statement scan
1970 # until we hit end of it.
1971 my $frag = $stat; $frag =~ s/;+\s*$//;
1972 if ($frag !~ /(?:{|;)/) {
1973 #print "skip<$line_nr_next>\n";
1974 $suppress_statement = $line_nr_next;
1977 # Find the real next line.
1978 $realline_next = $line_nr_next;
1979 if (defined $realline_next &&
1980 (!defined $lines[$realline_next - 1] ||
1981 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) {
1988 # Ignore goto labels.
1989 if ($s =~ /$Ident:\*$/s) {
1991 # Ignore functions being called
1992 } elsif ($s =~ /^.\s*$Ident\s*\(/s) {
1994 } elsif ($s =~ /^.\s*else\b/s) {
1996 # declarations always start with types
1997 } 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) {
2000 possible($type, "A:" . $s);
2002 # definitions in global scope can only start with types
2003 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) {
2004 possible($1, "B:" . $s);
2007 # any (foo ... *) is a pointer cast, and foo is a type
2008 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) {
2009 possible($1, "C:" . $s);
2012 # Check for any sort of function declaration.
2013 # int foo(something bar, other baz);
2014 # void (*store_gdt)(x86_descr_ptr *);
2015 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2016 my ($name_len) = length($1);
2019 substr($ctx, 0, $name_len + 1, '');
2020 $ctx =~ s/\)[^\)]*$//;
2022 for my $arg (split(/\s*,\s*/, $ctx)) {
2023 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2025 possible($1, "D:" . $s);
2033 # Checks which may be anchored in the context.
2036 # Check for switch () and associated case and default
2037 # statements should be at the same indent.
2038 if ($line=~/\bswitch\s*\(.*\)/) {
2041 my @ctx = ctx_block_outer($linenr, $realcnt);
2043 for my $ctx (@ctx) {
2044 my ($clen, $cindent) = line_stats($ctx);
2045 if ($ctx =~ /^\+\s*(case\s+|default:)/ &&
2046 $indent != $cindent) {
2047 $err .= "$sep$ctx\n";
2054 ERROR("SWITCH_CASE_INDENT_LEVEL",
2055 "switch and case should be at the same indent\n$hereline$err");
2059 # if/while/etc brace do not go on next line, unless defining a do while loop,
2060 # or if that brace on the next line is for something else
2061 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2062 my $pre_ctx = "$1$2";
2064 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0);
2066 if ($line =~ /^\+\t{6,}/) {
2067 WARN("DEEP_INDENTATION",
2068 "Too many leading tabs - consider code refactoring\n" . $herecurr);
2071 my $ctx_cnt = $realcnt - $#ctx - 1;
2072 my $ctx = join("\n", @ctx);
2074 my $ctx_ln = $linenr;
2075 my $ctx_skip = $realcnt;
2077 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt &&
2078 defined $lines[$ctx_ln - 1] &&
2079 $lines[$ctx_ln - 1] =~ /^-/)) {
2080 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2081 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/);
2085 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2086 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2088 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln -1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) {
2090 "that open brace { should be on the previous line\n" .
2091 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2093 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ &&
2094 $ctx =~ /\)\s*\;\s*$/ &&
2095 defined $lines[$ctx_ln - 1])
2097 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]);
2098 if ($nindent > $indent) {
2099 WARN("TRAILING_SEMICOLON",
2100 "trailing semicolon indicates no statements, indent implies otherwise\n" .
2101 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n");
2106 # Check relative indent for conditionals and blocks.
2107 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2108 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2109 ctx_statement_block($linenr, $realcnt, 0)
2110 if (!defined $stat);
2111 my ($s, $c) = ($stat, $cond);
2113 substr($s, 0, length($c), '');
2115 # Make sure we remove the line prefixes as we have
2116 # none on the first line, and are going to readd them
2120 # Find out how long the conditional actually is.
2121 my @newlines = ($c =~ /\n/gs);
2122 my $cond_lines = 1 + $#newlines;
2124 # We want to check the first line inside the block
2125 # starting at the end of the conditional, so remove:
2126 # 1) any blank line termination
2127 # 2) any opening brace { on end of the line
2129 my $continuation = 0;
2131 $s =~ s/^.*\bdo\b//;
2133 if ($s =~ s/^\s*\\//) {
2136 if ($s =~ s/^\s*?\n//) {
2141 # Also ignore a loop construct at the end of a
2142 # preprocessor statement.
2143 if (($prevline =~ /^.\s*#\s*define\s/ ||
2144 $prevline =~ /\\\s*$/) && $continuation == 0) {
2150 while ($cond_ptr != $cond_lines) {
2151 $cond_ptr = $cond_lines;
2153 # If we see an #else/#elif then the code
2155 if ($s =~ /^\s*\#\s*(?:else|elif)/) {
2160 # 1) blank lines, they should be at 0,
2161 # 2) preprocessor lines, and
2163 if ($continuation ||
2165 $s =~ /^\s*#\s*?/ ||
2166 $s =~ /^\s*$Ident\s*:/) {
2167 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0;
2168 if ($s =~ s/^.*?\n//) {
2174 my (undef, $sindent) = line_stats("+" . $s);
2175 my $stat_real = raw_line($linenr, $cond_lines);
2177 # Check if either of these lines are modified, else
2178 # this is not this patch's fault.
2179 if (!defined($stat_real) ||
2180 $stat !~ /^\+/ && $stat_real !~ /^\+/) {
2183 if (defined($stat_real) && $cond_lines > 1) {
2184 $stat_real = "[...]\n$stat_real";
2187 #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";
2189 if ($check && (($sindent % 8) != 0 ||
2190 ($sindent <= $indent && $s ne ''))) {
2191 WARN("SUSPECT_CODE_INDENT",
2192 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2196 # Track the 'values' across context and added lines.
2197 my $opline = $line; $opline =~ s/^./ /;
2198 my ($curr_values, $curr_vars) =
2199 annotate_values($opline . "\n", $prev_values);
2200 $curr_values = $prev_values . $curr_values;
2202 my $outline = $opline; $outline =~ s/\t/ /g;
2203 print "$linenr > .$outline\n";
2204 print "$linenr > $curr_values\n";
2205 print "$linenr > $curr_vars\n";
2207 $prev_values = substr($curr_values, -1);
2209 #ignore lines not being added
2210 if ($line=~/^[^\+]/) {next;}
2212 # TEST: allow direct testing of the type matcher.
2214 if ($line =~ /^.\s*$Declare\s*$/) {
2216 "TEST: is type\n" . $herecurr);
2217 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) {
2218 ERROR("TEST_NOT_TYPE",
2219 "TEST: is not type ($1 is)\n". $herecurr);
2223 # TEST: allow direct testing of the attribute matcher.
2225 if ($line =~ /^.\s*$Modifier\s*$/) {
2227 "TEST: is attr\n" . $herecurr);
2228 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) {
2229 ERROR("TEST_NOT_ATTR",
2230 "TEST: is not attr ($1 is)\n". $herecurr);
2235 # check for initialisation to aggregates open brace on the next line
2236 if ($line =~ /^.\s*{/ &&
2237 $prevline =~ /(?:^|[^=])=\s*$/) {
2239 "that open brace { should be on the previous line\n" . $hereprev);
2243 # Checks which are anchored on the added line.
2246 # check for malformed paths in #include statements (uses RAW line)
2247 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) {
2249 if ($path =~ m{//}) {
2250 ERROR("MALFORMED_INCLUDE",
2251 "malformed #include filename\n" .
2256 # no C99 // comments
2257 if ($line =~ m{//}) {
2258 ERROR("C99_COMMENTS",
2259 "do not use C99 // comments\n" . $herecurr);
2261 # Remove C99 comments.
2263 $opline =~ s@//.*@@;
2265 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2266 # the whole statement.
2267 #print "APW <$lines[$realline_next - 1]>\n";
2268 if (defined $realline_next &&
2269 exists $lines[$realline_next - 1] &&
2270 !defined $suppress_export{$realline_next} &&
2271 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2272 $lines[$realline_next - 1] =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2273 # Handle definitions which produce identifiers with
2276 # EXPORT_SYMBOL(something_foo);
2278 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ &&
2279 $name =~ /^${Ident}_$2/) {
2280 #print "FOO C name<$name>\n";
2281 $suppress_export{$realline_next} = 1;
2283 } elsif ($stat !~ /(?:
2285 ^.DEFINE_$Ident\(\Q$name\E\)|
2286 ^.DECLARE_$Ident\(\Q$name\E\)|
2287 ^.LIST_HEAD\(\Q$name\E\)|
2288 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(|
2289 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\()
2291 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2292 $suppress_export{$realline_next} = 2;
2294 $suppress_export{$realline_next} = 1;
2297 if (!defined $suppress_export{$linenr} &&
2298 $prevline =~ /^.\s*$/ &&
2299 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/ ||
2300 $line =~ /EXPORT_UNUSED_SYMBOL.*\((.*)\)/)) {
2301 #print "FOO B <$lines[$linenr - 1]>\n";
2302 $suppress_export{$linenr} = 2;
2304 if (defined $suppress_export{$linenr} &&
2305 $suppress_export{$linenr} == 2) {
2306 WARN("EXPORT_SYMBOL",
2307 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr);
2310 # check for global initialisers.
2311 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) {
2312 ERROR("GLOBAL_INITIALISERS",
2313 "do not initialise globals to 0 or NULL\n" .
2316 # check for static initialisers.
2317 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) {
2318 ERROR("INITIALISED_STATIC",
2319 "do not initialise statics to 0 or NULL\n" .
2323 # check for static const char * arrays.
2324 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) {
2325 WARN("STATIC_CONST_CHAR_ARRAY",
2326 "static const char * array should probably be static const char * const\n" .
2330 # check for static char foo[] = "bar" declarations.
2331 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) {
2332 WARN("STATIC_CONST_CHAR_ARRAY",
2333 "static char array declaration should probably be static const char\n" .
2337 # check for declarations of struct pci_device_id
2338 if ($line =~ /\bstruct\s+pci_device_id\s+\w+\s*\[\s*\]\s*\=\s*\{/) {
2339 WARN("DEFINE_PCI_DEVICE_TABLE",
2340 "Use DEFINE_PCI_DEVICE_TABLE for struct pci_device_id\n" . $herecurr);
2343 # check for new typedefs, only function parameters and sparse annotations
2345 if ($line =~ /\btypedef\s/ &&
2346 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ &&
2347 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ &&
2348 $line !~ /\b$typeTypedefs\b/ &&
2349 $line !~ /\b__bitwise(?:__|)\b/) {
2350 WARN("NEW_TYPEDEFS",
2351 "do not add new typedefs\n" . $herecurr);
2354 # * goes on variable not on type
2356 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) {
2358 my ($from, $to) = ($2, $2);
2360 # Should start with a space.
2361 $to =~ s/^(\S)/ $1/;
2362 # Should not end with a space.
2364 # '*'s should not have spaces between.
2365 while ($to =~ s/\*\s+\*/\*\*/) {
2368 #print "from<$from> to<$to>\n";
2370 ERROR("POINTER_LOCATION",
2371 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr);
2374 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) {
2376 my ($from, $to, $ident) = ($2, $2, $3);
2378 # Should start with a space.
2379 $to =~ s/^(\S)/ $1/;
2380 # Should not end with a space.
2382 # '*'s should not have spaces between.
2383 while ($to =~ s/\*\s+\*/\*\*/) {
2385 # Modifiers should have spaces.
2386 $to =~ s/(\b$Modifier$)/$1 /;
2388 #print "from<$from> to<$to> ident<$ident>\n";
2389 if ($from ne $to && $ident !~ /^$Modifier$/) {
2390 ERROR("POINTER_LOCATION",
2391 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr);
2395 # # no BUG() or BUG_ON()
2396 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
2397 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2398 # print "$herecurr";
2402 if ($line =~ /\bLINUX_VERSION_CODE\b/) {
2403 WARN("LINUX_VERSION_CODE",
2404 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2407 # check for uses of printk_ratelimit
2408 if ($line =~ /\bprintk_ratelimit\s*\(/) {
2409 WARN("PRINTK_RATELIMITED",
2410 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr);
2413 # printk should use KERN_* levels. Note that follow on printk's on the
2414 # same line do not need a level, so we use the current block context
2415 # to try and find and validate the current printk. In summary the current
2416 # printk includes all preceding printk's which have no newline on the end.
2417 # we assume the first bad printk is the one to report.
2418 if ($line =~ /\bprintk\((?!KERN_)\s*"/) {
2420 for (my $ln = $linenr - 1; $ln >= $first_line; $ln--) {
2421 #print "CHECK<$lines[$ln - 1]\n";
2422 # we have a preceding printk if it ends
2423 # with "\n" ignore it, else it is to blame
2424 if ($lines[$ln - 1] =~ m{\bprintk\(}) {
2425 if ($rawlines[$ln - 1] !~ m{\\n"}) {
2432 WARN("PRINTK_WITHOUT_KERN_LEVEL",
2433 "printk() should include KERN_ facility level\n" . $herecurr);
2437 # function brace can't be on same line, except for #defines of do while,
2438 # or if closed on same line
2439 if (($line=~/$Type\s*$Ident\(.*\).*\s{/) and
2440 !($line=~/\#\s*define.*do\s{/) and !($line=~/}/)) {
2442 "open brace '{' following function declarations go on the next line\n" . $herecurr);
2445 # open braces for enum, union and struct go on the same line.
2446 if ($line =~ /^.\s*{/ &&
2447 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) {
2449 "open brace '{' following $1 go on the same line\n" . $hereprev);
2452 # missing space after union, struct or enum definition
2453 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) {
2455 "missing space after $1 definition\n" . $herecurr);
2458 # check for spacing round square brackets; allowed:
2459 # 1. with a type on the left -- int [] a;
2460 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2461 # 3. inside a curly brace -- = { [0...10] = 5 }
2462 while ($line =~ /(.*?\s)\[/g) {
2463 my ($where, $prefix) = ($-[1], $1);
2464 if ($prefix !~ /$Type\s+$/ &&
2465 ($where != 0 || $prefix !~ /^.\s+$/) &&
2466 $prefix !~ /{\s+$/) {
2467 ERROR("BRACKET_SPACE",
2468 "space prohibited before open square bracket '['\n" . $herecurr);
2472 # check for spaces between functions and their parentheses.
2473 while ($line =~ /($Ident)\s+\(/g) {
2475 my $ctx_before = substr($line, 0, $-[1]);
2476 my $ctx = "$ctx_before$name";
2478 # Ignore those directives where spaces _are_ permitted.
2480 if|for|while|switch|return|case|
2481 volatile|__volatile__|
2482 __attribute__|format|__extension__|
2486 # cpp #define statements have non-optional spaces, ie
2487 # if there is a space between the name and the open
2488 # parenthesis it is simply not a parameter group.
2489 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) {
2491 # cpp #elif statement condition may start with a (
2492 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) {
2494 # If this whole things ends with a type its most
2495 # likely a typedef for a function.
2496 } elsif ($ctx =~ /$Type$/) {
2500 "space prohibited between function name and open parenthesis '('\n" . $herecurr);
2503 # Check operator spacing.
2504 if (!($line=~/\#\s*include/)) {
2506 <<=|>>=|<=|>=|==|!=|
2507 \+=|-=|\*=|\/=|%=|\^=|\|=|&=|
2508 =>|->|<<|>>|<|>|=|!|~|
2509 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%|
2512 my @elements = split(/($ops|;)/, $opline);
2515 my $blank = copy_spacing($opline);
2517 for (my $n = 0; $n < $#elements; $n += 2) {
2518 $off += length($elements[$n]);
2520 # Pick up the preceding and succeeding characters.
2521 my $ca = substr($opline, 0, $off);
2523 if (length($opline) >= ($off + length($elements[$n + 1]))) {
2524 $cc = substr($opline, $off + length($elements[$n + 1]));
2526 my $cb = "$ca$;$cc";
2529 $a = 'V' if ($elements[$n] ne '');
2530 $a = 'W' if ($elements[$n] =~ /\s$/);
2531 $a = 'C' if ($elements[$n] =~ /$;$/);
2532 $a = 'B' if ($elements[$n] =~ /(\[|\()$/);
2533 $a = 'O' if ($elements[$n] eq '');
2534 $a = 'E' if ($ca =~ /^\s*$/);
2536 my $op = $elements[$n + 1];
2539 if (defined $elements[$n + 2]) {
2540 $c = 'V' if ($elements[$n + 2] ne '');
2541 $c = 'W' if ($elements[$n + 2] =~ /^\s/);
2542 $c = 'C' if ($elements[$n + 2] =~ /^$;/);
2543 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/);
2544 $c = 'O' if ($elements[$n + 2] eq '');
2545 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/);
2550 my $ctx = "${a}x${c}";
2552 my $at = "(ctx:$ctx)";
2554 my $ptr = substr($blank, 0, $off) . "^";
2555 my $hereptr = "$hereline$ptr\n";
2557 # Pull out the value of this operator.
2558 my $op_type = substr($curr_values, $off + 1, 1);
2560 # Get the full operator variant.
2561 my $opv = $op . substr($curr_vars, $off, 1);
2563 # Ignore operators passed as parameters.
2564 if ($op_type ne 'V' &&
2565 $ca =~ /\s$/ && $cc =~ /^\s*,/) {
2568 # } elsif ($op =~ /^$;+$/) {
2570 # ; should have either the end of line or a space or \ after it
2571 } elsif ($op eq ';') {
2572 if ($ctx !~ /.x[WEBC]/ &&
2573 $cc !~ /^\\/ && $cc !~ /^;/) {
2575 "space required after that '$op' $at\n" . $hereptr);
2579 } elsif ($op eq '//') {
2583 # : when part of a bitfield
2584 } elsif ($op eq '->' || $opv eq ':B') {
2585 if ($ctx =~ /Wx.|.xW/) {
2587 "spaces prohibited around that '$op' $at\n" . $hereptr);
2590 # , must have a space on the right.
2591 } elsif ($op eq ',') {
2592 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) {
2594 "space required after that '$op' $at\n" . $hereptr);
2597 # '*' as part of a type definition -- reported already.
2598 } elsif ($opv eq '*_') {
2599 #warn "'*' is part of type\n";
2601 # unary operators should have a space before and
2602 # none after. May be left adjacent to another
2603 # unary operator, or a cast
2604 } elsif ($op eq '!' || $op eq '~' ||
2605 $opv eq '*U' || $opv eq '-U' ||
2606 $opv eq '&U' || $opv eq '&&U') {
2607 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) {
2609 "space required before that '$op' $at\n" . $hereptr);
2611 if ($op eq '*' && $cc =~/\s*$Modifier\b/) {
2612 # A unary '*' may be const
2614 } elsif ($ctx =~ /.xW/) {
2616 "space prohibited after that '$op' $at\n" . $hereptr);
2619 # unary ++ and unary -- are allowed no space on one side.
2620 } elsif ($op eq '++' or $op eq '--') {
2621 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) {
2623 "space required one side of that '$op' $at\n" . $hereptr);
2625 if ($ctx =~ /Wx[BE]/ ||
2626 ($ctx =~ /Wx./ && $cc =~ /^;/)) {
2628 "space prohibited before that '$op' $at\n" . $hereptr);
2630 if ($ctx =~ /ExW/) {
2632 "space prohibited after that '$op' $at\n" . $hereptr);
2636 # << and >> may either have or not have spaces both sides
2637 } elsif ($op eq '<<' or $op eq '>>' or
2638 $op eq '&' or $op eq '^' or $op eq '|' or
2639 $op eq '+' or $op eq '-' or
2640 $op eq '*' or $op eq '/' or
2643 if ($ctx =~ /Wx[^WCE]|[^WCE]xW/) {
2645 "need consistent spacing around '$op' $at\n" .
2649 # A colon needs no spaces before when it is
2650 # terminating a case value or a label.
2651 } elsif ($opv eq ':C' || $opv eq ':L') {
2652 if ($ctx =~ /Wx./) {
2654 "space prohibited before that '$op' $at\n" . $hereptr);
2657 # All the others need spaces both sides.
2658 } elsif ($ctx !~ /[EWC]x[CWE]/) {
2661 # Ignore email addresses <foo@bar>
2663 $cc =~ /^\S+\@\S+>/) ||
2665 $ca =~ /<\S+\@\S+$/))
2671 if (($opv eq ':O' && $ca =~ /\?$/) ||
2672 ($op eq '?' && $cc =~ /^:/)) {
2678 "spaces required around that '$op' $at\n" . $hereptr);
2681 $off += length($elements[$n + 1]);
2685 # check for multiple assignments
2686 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) {
2687 CHK("MULTIPLE_ASSIGNMENTS",
2688 "multiple assignments should be avoided\n" . $herecurr);
2691 ## # check for multiple declarations, allowing for a function declaration
2693 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
2694 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
2696 ## # Remove any bracketed sections to ensure we do not
2697 ## # falsly report the parameters of functions.
2699 ## while ($ln =~ s/\([^\(\)]*\)//g) {
2701 ## if ($ln =~ /,/) {
2702 ## WARN("MULTIPLE_DECLARATION",
2703 ## "declaring multiple variables together should be avoided\n" . $herecurr);
2707 #need space before brace following if, while, etc
2708 if (($line =~ /\(.*\){/ && $line !~ /\($Type\){/) ||
2711 "space required before the open brace '{'\n" . $herecurr);
2714 # closing brace should have a space following it when it has anything
2716 if ($line =~ /}(?!(?:,|;|\)))\S/) {
2718 "space required after that close brace '}'\n" . $herecurr);
2721 # check spacing on square brackets
2722 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) {
2724 "space prohibited after that open square bracket '['\n" . $herecurr);
2726 if ($line =~ /\s\]/) {
2728 "space prohibited before that close square bracket ']'\n" . $herecurr);
2731 # check spacing on parentheses
2732 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ &&
2733 $line !~ /for\s*\(\s+;/) {
2735 "space prohibited after that open parenthesis '('\n" . $herecurr);
2737 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ &&
2738 $line !~ /for\s*\(.*;\s+\)/ &&
2739 $line !~ /:\s+\)/) {
2741 "space prohibited before that close parenthesis ')'\n" . $herecurr);
2744 #goto labels aren't indented, allow a single space however
2745 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and
2746 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) {
2747 WARN("INDENTED_LABEL",
2748 "labels should not be indented\n" . $herecurr);
2751 # Return is not a function.
2752 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) {
2756 # Flatten any parentheses
2757 $value =~ s/\(/ \(/g;
2758 $value =~ s/\)/\) /g;
2759 while ($value =~ s/\[[^\[\]]*\]/1/ ||
2760 $value !~ /(?:$Ident|-?$Constant)\s*
2762 (?:$Ident|-?$Constant)/x &&
2763 $value =~ s/\([^\(\)]*\)/1/) {
2765 #print "value<$value>\n";
2766 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/) {
2767 ERROR("RETURN_PARENTHESES",
2768 "return is not a function, parentheses are not required\n" . $herecurr);
2770 } elsif ($spacing !~ /\s+/) {
2772 "space required before the open parenthesis '('\n" . $herecurr);
2775 # Return of what appears to be an errno should normally be -'ve
2776 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) {
2778 if ($name ne 'EOF' && $name ne 'ERROR') {
2779 WARN("USE_NEGATIVE_ERRNO",
2780 "return of an errno should typically be -ve (return -$1)\n" . $herecurr);
2784 # Need a space before open parenthesis after if, while etc
2785 if ($line=~/\b(if|while|for|switch)\(/) {
2786 ERROR("SPACING", "space required before the open parenthesis '('\n" . $herecurr);
2789 # Check for illegal assignment in if conditional -- and check for trailing
2790 # statements after the conditional.
2791 if ($line =~ /do\s*(?!{)/) {
2792 ($stat, $cond, $line_nr_next, $remain_next, $off_next) =
2793 ctx_statement_block($linenr, $realcnt, 0)
2794 if (!defined $stat);
2795 my ($stat_next) = ctx_statement_block($line_nr_next,
2796 $remain_next, $off_next);
2797 $stat_next =~ s/\n./\n /g;
2798 ##print "stat<$stat> stat_next<$stat_next>\n";
2800 if ($stat_next =~ /^\s*while\b/) {
2801 # If the statement carries leading newlines,
2802 # then count those as offsets.
2804 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s);
2806 statement_rawlines($whitespace) - 1;
2808 $suppress_whiletrailers{$line_nr_next +
2812 if (!defined $suppress_whiletrailers{$linenr} &&
2813 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) {
2814 my ($s, $c) = ($stat, $cond);
2816 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) {
2817 ERROR("ASSIGN_IN_IF",
2818 "do not use assignment in if condition\n" . $herecurr);
2821 # Find out what is on the end of the line after the
2823 substr($s, 0, length($c), '');
2825 $s =~ s/$;//g; # Remove any comments
2826 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ &&
2827 $c !~ /}\s*while\s*/)
2829 # Find out how long the conditional actually is.
2830 my @newlines = ($c =~ /\n/gs);
2831 my $cond_lines = 1 + $#newlines;
2834 $stat_real = raw_line($linenr, $cond_lines)
2835 . "\n" if ($cond_lines);
2836 if (defined($stat_real) && $cond_lines > 1) {
2837 $stat_real = "[...]\n$stat_real";
2840 ERROR("TRAILING_STATEMENTS",
2841 "trailing statements should be on next line\n" . $herecurr . $stat_real);
2845 # Check for bitwise tests written as boolean
2857 WARN("HEXADECIMAL_BOOLEAN_TEST",
2858 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr);
2861 # if and else should not have general statements after it
2862 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) {
2864 $s =~ s/$;//g; # Remove any comments
2865 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) {
2866 ERROR("TRAILING_STATEMENTS",
2867 "trailing statements should be on next line\n" . $herecurr);
2870 # if should not continue a brace
2871 if ($line =~ /}\s*if\b/) {
2872 ERROR("TRAILING_STATEMENTS",
2873 "trailing statements should be on next line\n" .
2876 # case and default should not have general statements after them
2877 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g &&
2879 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$|
2883 ERROR("TRAILING_STATEMENTS",
2884 "trailing statements should be on next line\n" . $herecurr);
2887 # Check for }<nl>else {, these must be at the same
2888 # indent level to be relevant to each other.
2889 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and
2890 $previndent == $indent) {
2891 ERROR("ELSE_AFTER_BRACE",
2892 "else should follow close brace '}'\n" . $hereprev);
2895 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and
2896 $previndent == $indent) {
2897 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0);
2899 # Find out what is on the end of the line after the
2901 substr($s, 0, length($c), '');
2904 if ($s =~ /^\s*;/) {
2905 ERROR("WHILE_AFTER_BRACE",
2906 "while should follow close brace '}'\n" . $hereprev);
2910 #studly caps, commented out until figure out how to distinguish between use of existing and adding new
2911 # if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) {
2912 # print "No studly caps, use _\n";
2913 # print "$herecurr";
2917 #no spaces allowed after \ in define
2918 if ($line=~/\#\s*define.*\\\s$/) {
2919 WARN("WHITESPACE_AFTER_LINE_CONTINUATION",
2920 "Whitepspace after \\ makes next lines useless\n" . $herecurr);
2923 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
2924 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) {
2926 my $checkfile = "include/linux/$file";
2927 if (-f "$root/$checkfile" &&
2928 $realfile ne $checkfile &&
2929 $1 !~ /$allowed_asm_includes/)
2931 if ($realfile =~ m{^arch/}) {
2932 CHK("ARCH_INCLUDE_LINUX",
2933 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2935 WARN("INCLUDE_LINUX",
2936 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr);
2941 # multi-statement macros should be enclosed in a do while loop, grab the
2942 # first statement and ensure its the whole macro if its not enclosed
2943 # in a known good container
2944 if ($realfile !~ m@/vmlinux.lds.h$@ &&
2945 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) {
2948 my ($off, $dstat, $dcond, $rest);
2950 ($dstat, $dcond, $ln, $cnt, $off) =
2951 ctx_statement_block($linenr, $realcnt, 0);
2953 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
2954 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
2956 $dstat =~ s/^.\s*\#\s*define\s+$Ident(?:\([^\)]*\))?\s*//;
2958 $dstat =~ s/\\\n.//g;
2959 $dstat =~ s/^\s*//s;
2960 $dstat =~ s/\s*$//s;
2962 # Flatten any parentheses and braces
2963 while ($dstat =~ s/\([^\(\)]*\)/1/ ||
2964 $dstat =~ s/\{[^\{\}]*\}/1/ ||
2965 $dstat =~ s/\[[^\[\]]*\]/1/)
2969 my $exceptions = qr{
2981 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
2983 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(),
2984 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo();
2985 $dstat !~ /^(?:$Ident|-?$Constant)$/ && # 10 // foo()
2986 $dstat !~ /$exceptions/ &&
2987 $dstat !~ /^\.$Ident\s*=/ && # .foo =
2988 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
2989 $dstat !~ /^for\s*$Constant$/ && # for (...)
2990 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar()
2991 $dstat !~ /^do\s*{/ && # do {...
2992 $dstat !~ /^\({/) # ({...
2995 my $herectx = $here . "\n";
2996 my $cnt = statement_rawlines($ctx);
2998 for (my $n = 0; $n < $cnt; $n++) {
2999 $herectx .= raw_line($linenr, $n) . "\n";
3002 if ($dstat =~ /;/) {
3003 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE",
3004 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx");
3006 ERROR("COMPLEX_MACRO",
3007 "Macros with complex values should be enclosed in parenthesis\n" . "$herectx");
3012 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3013 # all assignments may have only one of the following with an assignment:
3016 # VMLINUX_SYMBOL(...)
3017 if ($realfile eq 'vmlinux.lds.h' && $line =~ /(?:(?:^|\s)$Ident\s*=|=\s*$Ident(?:\s|$))/) {
3018 WARN("MISSING_VMLINUX_SYMBOL",
3019 "vmlinux.lds.h needs VMLINUX_SYMBOL() around C-visible symbols\n" . $herecurr);
3022 # check for redundant bracing round if etc
3023 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) {
3024 my ($level, $endln, @chunks) =
3025 ctx_statement_full($linenr, $realcnt, 1);
3026 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3027 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3028 if ($#chunks > 0 && $level == 0) {
3031 my $herectx = $here . "\n";
3032 my $ln = $linenr - 1;
3033 for my $chunk (@chunks) {
3034 my ($cond, $block) = @{$chunk};
3036 # If the condition carries leading newlines, then count those as offsets.
3037 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s);
3038 my $offset = statement_rawlines($whitespace) - 1;
3040 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3042 # We have looked at and allowed this specific line.
3043 $suppress_ifbraces{$ln + $offset} = 1;
3045 $herectx .= "$rawlines[$ln + $offset]\n[...]\n";
3046 $ln += statement_rawlines($block) - 1;
3048 substr($block, 0, length($cond), '');
3050 $seen++ if ($block =~ /^\s*{/);
3052 #print "cond<$cond> block<$block> allowed<$allowed>\n";
3053 if (statement_lines($cond) > 1) {
3054 #print "APW: ALLOWED: cond<$cond>\n";
3057 if ($block =~/\b(?:if|for|while)\b/) {
3058 #print "APW: ALLOWED: block<$block>\n";
3061 if (statement_block_size($block) > 1) {
3062 #print "APW: ALLOWED: lines block<$block>\n";
3066 if ($seen && !$allowed) {
3068 "braces {} are not necessary for any arm of this statement\n" . $herectx);
3072 if (!defined $suppress_ifbraces{$linenr - 1} &&
3073 $line =~ /\b(if|while|for|else)\b/) {
3076 # Check the pre-context.
3077 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) {
3078 #print "APW: ALLOWED: pre<$1>\n";
3082 my ($level, $endln, @chunks) =
3083 ctx_statement_full($linenr, $realcnt, $-[0]);
3085 # Check the condition.
3086 my ($cond, $block) = @{$chunks[0]};
3087 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3088 if (defined $cond) {
3089 substr($block, 0, length($cond), '');
3091 if (statement_lines($cond) > 1) {
3092 #print "APW: ALLOWED: cond<$cond>\n";
3095 if ($block =~/\b(?:if|for|while)\b/) {
3096 #print "APW: ALLOWED: block<$block>\n";
3099 if (statement_block_size($block) > 1) {
3100 #print "APW: ALLOWED: lines block<$block>\n";
3103 # Check the post-context.
3104 if (defined $chunks[1]) {
3105 my ($cond, $block) = @{$chunks[1]};
3106 if (defined $cond) {
3107 substr($block, 0, length($cond), '');
3109 if ($block =~ /^\s*\{/) {
3110 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3114 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
3115 my $herectx = $here . "\n";
3116 my $cnt = statement_rawlines($block);
3118 for (my $n = 0; $n < $cnt; $n++) {
3119 $herectx .= raw_line($linenr, $n) . "\n";
3123 "braces {} are not necessary for single statement blocks\n" . $herectx);
3127 # don't include deprecated include files (uses RAW line)
3128 for my $inc (keys %dep_includes) {
3129 if ($rawline =~ m@^.\s*\#\s*include\s*\<$inc>@) {
3130 ERROR("DEPRECATED_INCLUDE",
3131 "Don't use <$inc>, include " .
3132 "$dep_includes{$inc} instead\n" .
3137 # don't use deprecated functions
3138 for my $func (keys %dep_functions) {
3139 if ($line =~ /\b$func\b/) {
3140 ERROR("DEPRECATED_FUNCTION",
3141 "$func is deprecated, " .
3142 "use $dep_functions{$func} instead\n" .
3147 # try to replace assertions with error handling
3148 if ($line =~ /\bLASSERTF?\s*\(/) {
3150 "try to replace assertions with error handling\n" .
3154 # avoid new console messages
3155 if ($line =~ /\bLCONSOLE[A-Z_]*\s*\(/) {
3157 "avoid adding new console messages\n" .
3161 # minimize new CERROR messages
3162 if ($line =~ /\bC(EMERG|ERROR|NETERR|WARN)\s*\(/) {
3164 "think hard before adding new CERROR messages\n" .
3168 # no volatiles please
3169 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b};
3170 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) {
3172 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3176 if ($line =~ /^.\s*\#\s*if\s+0\b/) {
3177 CHK("REDUNDANT_CODE",
3178 "if this code is redundant consider removing it\n" .
3182 # check for needless kfree() checks
3183 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3185 if ($line =~ /\bkfree\(\Q$expr\E\);/) {
3186 WARN("NEEDLESS_KFREE",
3187 "kfree(NULL) is safe this check is probably not required\n" . $hereprev);
3190 # check for needless usb_free_urb() checks
3191 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) {
3193 if ($line =~ /\busb_free_urb\(\Q$expr\E\);/) {
3194 WARN("NEEDLESS_USB_FREE_URB",
3195 "usb_free_urb(NULL) is safe this check is probably not required\n" . $hereprev);
3199 # prefer usleep_range over udelay
3200 if ($line =~ /\budelay\s*\(\s*(\w+)\s*\)/) {
3201 # ignore udelay's < 10, however
3202 if (! (($1 =~ /(\d+)/) && ($1 < 10)) ) {
3204 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $line);
3208 # warn about unexpectedly long msleep's
3209 if ($line =~ /\bmsleep\s*\((\d+)\);/) {
3212 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3216 # warn about #ifdefs in C files
3217 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3218 # print "#ifdef in C files should be avoided\n";
3219 # print "$herecurr";
3223 # warn about spacing in #ifdefs
3224 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) {
3226 "exactly one space required after that #$1\n" . $herecurr);
3229 # check for spinlock_t definitions without a comment.
3230 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ ||
3231 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) {
3233 if (!ctx_has_comment($first_line, $linenr)) {
3234 CHK("UNCOMMENTED_DEFINITION",
3235 "$1 definition without comment\n" . $herecurr);
3238 # check for memory barriers without a comment.
3239 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3240 if (!ctx_has_comment($first_line, $linenr)) {
3241 CHK("MEMORY_BARRIER",
3242 "memory barrier without comment\n" . $herecurr);
3245 # check of hardware specific defines
3246 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3248 "architecture specific defines should be avoided\n" . $herecurr);
3251 # Check that the storage class is at the beginning of a declaration
3252 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) {
3253 WARN("STORAGE_CLASS",
3254 "storage class should be at the beginning of the declaration\n" . $herecurr)
3257 # check the location of the inline attribute, that it is between
3258 # storage class and type.
3259 if ($line =~ /\b$Type\s+$Inline\b/ ||
3260 $line =~ /\b$Inline\s+$Storage\b/) {
3261 ERROR("INLINE_LOCATION",
3262 "inline keyword should sit between storage class and type\n" . $herecurr);
3265 # Check for __inline__ and __inline, prefer inline
3266 if ($line =~ /\b(__inline__|__inline)\b/) {
3268 "plain inline is preferred over $1\n" . $herecurr);
3271 # Check for __attribute__ packed, prefer __packed
3272 if ($line =~ /\b__attribute__\s*\(\s*\(.*\bpacked\b/) {
3273 WARN("PREFER_PACKED",
3274 "__packed is preferred over __attribute__((packed))\n" . $herecurr);
3277 # Check for __attribute__ aligned, prefer __aligned
3278 if ($line =~ /\b__attribute__\s*\(\s*\(.*aligned/) {
3279 WARN("PREFER_ALIGNED",
3280 "__aligned(size) is preferred over __attribute__((aligned(size)))\n" . $herecurr);
3283 # Check for __attribute__ format(printf, prefer __printf
3284 if ($line =~ /\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf/) {
3285 WARN("PREFER_PRINTF",
3286 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr);
3289 # check for sizeof(&)
3290 if ($line =~ /\bsizeof\s*\(\s*\&/) {
3291 WARN("SIZEOF_ADDRESS",
3292 "sizeof(& should be avoided\n" . $herecurr);
3295 # check for line continuations in quoted strings with odd counts of "
3296 if ($rawline =~ /\\$/ && $rawline =~ tr/"/"/ % 2) {
3297 WARN("LINE_CONTINUATIONS",
3298 "Avoid line continuations in quoted strings\n" . $herecurr);
3301 # Check for misused memsets
3302 if (defined $stat &&
3303 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/s) {
3309 if ($ms_size =~ /^(0x|)0$/i) {
3311 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n");
3312 } elsif ($ms_size =~ /^(0x|)1$/i) {
3314 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n");
3318 # typecasts on min/max could be min_t/max_t
3319 if (defined $stat &&
3320 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) {
3321 if (defined $2 || defined $8) {
3323 my $cast1 = deparenthesize($2);
3325 my $cast2 = deparenthesize($8);
3329 if ($cast1 ne "" && $cast2 ne "") {
3330 $cast = "$cast1 or $cast2";
3331 } elsif ($cast1 ne "") {
3337 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n");
3341 # check for new externs in .c files.
3342 if ($realfile =~ /\.c$/ && defined $stat &&
3343 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s)
3345 my $function_name = $1;
3346 my $paren_space = $2;
3349 if (defined $cond) {
3350 substr($s, 0, length($cond), '');
3352 if ($s =~ /^\s*;/ &&
3353 $function_name ne 'uninitialized_var')
3355 WARN("AVOID_EXTERNS",
3356 "externs should be avoided in .c files\n" . $herecurr);
3359 if ($paren_space =~ /\n/) {
3360 WARN("FUNCTION_ARGUMENTS",
3361 "arguments for function declarations should follow identifier\n" . $herecurr);
3364 } elsif ($realfile =~ /\.c$/ && defined $stat &&
3365 $stat =~ /^.\s*extern\s+/)
3367 WARN("AVOID_EXTERNS",
3368 "externs should be avoided in .c files\n" . $herecurr);
3371 # checks for new __setup's
3372 if ($rawline =~ /\b__setup\("([^"]*)"/) {
3375 if (!grep(/$name/, @setup_docs)) {
3376 CHK("UNDOCUMENTED_SETUP",
3377 "__setup appears un-documented -- check Documentation/kernel-parameters.txt\n" . $herecurr);
3381 # check for pointless casting of kmalloc return
3382 if ($line =~ /\*\s*\)\s*[kv][czm]alloc(_node){0,1}\b/) {
3383 WARN("UNNECESSARY_CASTS",
3384 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
3387 # check for multiple semicolons
3388 if ($line =~ /;\s*;\s*$/) {
3389 WARN("ONE_SEMICOLON",
3390 "Statements terminations use 1 semicolon\n" . $herecurr);
3393 # check for gcc specific __FUNCTION__
3394 if ($line =~ /__FUNCTION__/) {
3396 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr);
3399 # check for semaphores initialized locked
3400 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) {
3401 WARN("CONSIDER_COMPLETION",
3402 "consider using a completion\n" . $herecurr);
3405 # recommend kstrto* over simple_strto* and strict_strto*
3406 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) {
3407 WARN("CONSIDER_KSTRTO",
3408 "$1 is obsolete, use k$3 instead\n" . $herecurr);
3410 # check for __initcall(), use device_initcall() explicitly please
3411 if ($line =~ /^.\s*__initcall\s*\(/) {
3412 WARN("USE_DEVICE_INITCALL",
3413 "please use device_initcall() instead of __initcall()\n" . $herecurr);
3415 # check for various ops structs, ensure they are const.
3416 my $struct_ops = qr{acpi_dock_ops|
3417 address_space_operations|
3419 block_device_operations|
3424 file_lock_operations|
3434 lock_manager_operations|
3440 pipe_buf_operations|
3441 platform_hibernation_ops|
3442 platform_suspend_ops|
3447 soc_pcmcia_socket_ops|
3453 if ($line !~ /\bconst\b/ &&
3454 $line =~ /\bstruct\s+($struct_ops)\b/) {
3455 WARN("CONST_STRUCT",
3456 "struct $1 should normally be const\n" .
3460 # use of NR_CPUS is usually wrong
3461 # ignore definitions of NR_CPUS and usage to define arrays as likely right
3462 if ($line =~ /\bNR_CPUS\b/ &&
3463 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ &&
3464 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ &&
3465 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ &&
3466 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ &&
3467 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/)
3470 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
3473 # check for %L{u,d,i} in strings
3475 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) {
3476 $string = substr($rawline, $-[1], $+[1] - $-[1]);
3477 $string =~ s/%%/__/g;
3478 if ($string =~ /(?<!%)%L[udi]/) {
3480 "\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr);
3485 # whine mightly about in_atomic
3486 if ($line =~ /\bin_atomic\s*\(/) {
3487 if ($realfile =~ m@^drivers/@) {
3489 "do not use in_atomic in drivers\n" . $herecurr);
3490 } elsif ($realfile !~ m@^kernel/@) {
3492 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr);
3496 # check for lockdep_set_novalidate_class
3497 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ ||
3498 $line =~ /__lockdep_no_validate__\s*\)/ ) {
3499 if ($realfile !~ m@^kernel/lockdep@ &&
3500 $realfile !~ m@^include/linux/lockdep@ &&
3501 $realfile !~ m@^drivers/base/core@) {
3503 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr);
3507 if ($line =~ /debugfs_create_file.*S_IWUGO/ ||
3508 $line =~ /DEVICE_ATTR.*S_IWUGO/ ) {
3509 WARN("EXPORTED_WORLD_WRITABLE",
3510 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
3513 if ($rawline =~ /version 3/) {
3515 "using GPLv3 is usually wrong\n" . $herecurr);
3519 # If we have no input at all, then there is nothing to report on
3520 # so just keep quiet.
3521 if ($#rawlines == -1) {
3525 # In mailback mode only produce a report in the negative, for
3526 # things that appear to be patches.
3527 if ($mailback && ($clean == 1 || !$is_patch)) {
3531 # This is not a patch, and we are are in 'no-patch' mode so
3533 if (!$chk_patch && !$is_patch) {
3538 ERROR("NOT_UNIFIED_DIFF",
3539 "Does not appear to be a unified-diff format patch\n");
3541 if ($is_patch && $chk_signoff && $signoff == 0) {
3542 ERROR("MISSING_SIGN_OFF",
3543 "Missing Signed-off-by: line(s)\n");
3546 print report_dump();
3547 if ($summary && !($clean == 1 && $quiet == 1)) {
3548 print "$filename " if ($summary_file);
3549 print "total: $cnt_error errors, $cnt_warn warnings, " .
3550 (($check)? "$cnt_chk checks, " : "") .
3551 "$cnt_lines lines checked\n";
3552 print "\n" if ($quiet == 0);
3556 # If there were whitespace errors which cleanpatch can fix
3557 # then suggest that.
3558 if ($rpt_cleaners) {
3559 print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n";
3560 print " scripts/cleanfile\n\n";
3565 if (keys %ignore_type) {
3566 print "NOTE: Ignored message types:";
3567 foreach my $ignore (sort keys %ignore_type) {
3571 print "\n" if ($quiet == 0);
3574 if ($clean == 1 && $quiet == 0) {
3575 print "$vname has no obvious style problems and is ready for submission.\n"
3577 if ($clean == 0 && $quiet == 0) {
3579 $vname has style problems, please review.
3581 If any of these errors are false positives, please report
3582 them to the maintainer, see CHECKPATCH in MAINTAINERS.