| blob | 182be0f124074c6d508d8a97e498ea7925665a1f |
1 #!/usr/bin/perl -w
2 # (c) 2001, Dave Jones. (the file handling bit)
3 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6 # Licensed under the terms of the GNU GPL License version 2
54 Options:
59 --emacs emacs compile window format
60 --terse one line per report
73 is all off)
75 literally
78 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
79 with potential errors corrected to the preferred
80 checkpatch style
85 runtime errors.
89 EOM
92 }
114 }
115 }
118 }
120 GetOptions(
158 }
159 }
164 }
180 }
181 }
190 }
192 }
193 }
203 ## no critic
206 }
213 }
219 }
226 }
227 }
232 }
233 }
243 __user|
244 __kernel|
245 __force|
246 __iomem|
247 __must_check|
248 __init_refok|
249 __kprobes|
250 __ref|
251 __rcu
259 # Notes to $Attribute:
260 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
262 const|
263 __percpu|
264 __nocast|
265 __safe|
266 __bitwise__|
267 __packed__|
268 __packed2__|
269 __naked|
270 __maybe_unused|
271 __always_unused|
272 __noreturn|
273 __used|
274 __cold|
275 __noclone|
276 __deprecated|
277 __read_mostly|
278 __kprobes|
280 ____cacheline_aligned|
281 ____cacheline_aligned_in_smp|
282 ____cacheline_internodealigned_in_smp|
283 __weak
304 <=|>=|==|!=|
305 =>|->|<<|>>|<|>|!|~|
333 atomic_t
334 )};
338 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
340 panic|
343 )};
352 To:|
353 Cc:
354 )};
375 );
380 );
384 );
390 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
393 );
395 #Create a search pattern for all these functions to speed up a loop below
400 }
405 )};
408 irq|
409 memory
410 )};
411 # memory.h: ARM has a custom one
424 )
433 )
437 $NonptrType
442 }
443 build_types();
447 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
448 # requires at least perl version v5.10.0
449 # Any use must be runtime checked with $^V
462 }
467 }
491 }
492 }
493 }
517 }
519 }
527 }
531 }
536 }
540 }
548 }
550 }
551 }
569 }
574 }
578 }
582 }
586 }
597 );
602 }
603 }
605 }
628 # If there's a name left after stripping spaces and
629 # leading quotes, and the address doesn't have both
630 # leading and trailing angle brackets, the address
631 # is invalid. ie:
632 # "joe smith joe@smith.com" bad
633 # "joe smith <joe@smith.com" bad
638 }
639 }
649 }
652 }
666 }
672 }
675 }
683 }
684 }
687 }
700 }
702 }
705 }
708 }
712 }
717 # Drop the diff line leader and expand tabs
721 # Pick the indent from the front of the line.
725 }
736 }
737 }
748 # Always copy over the diff marker.
754 # Comments we are wacking completly including the begin
755 # and end, all to $;.
762 }
768 }
775 }
777 # A \ in a string means ignore the next character.
783 }
784 # Regular quotes.
793 }
794 }
796 #print "c<$c> SQ<$sanitise_quote>\n";
805 }
806 }
810 }
812 # The pathname on a #include may be surrounded by '<' and '>'.
817 # The whole of a #error is a string.
821 }
824 }
831 }
854 #warn "CSB: blk<$blk> remain<$remain>\n";
855 # If we are about to drop off the end, pull in more
856 # context.
867 }
868 # Bail if there is no further context.
869 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
872 }
876 }
877 }
882 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
884 # Handle nested #if/#else.
891 }
893 # Statement ends at the ';' or a close '}' at the
894 # outermost level.
897 }
899 # An else is really a conditional as long as its not else if
906 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
907 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
908 }
913 }
921 #warn "CSB: mark coff<$coff>\n";
922 }
923 }
927 }
935 }
937 }
938 }
939 # Preprocessor commands end at the newline unless escaped.
945 }
947 }
948 # We are truly at the end, so shuffle to the next line.
953 }
958 #warn "STATEMENT<$statement>\n";
959 #warn "CONDITION<$condition>\n";
961 #print "coff<$coff> soff<$off> loff<$loff>\n";
965 }
970 # Strip the diff line prefixes and rip blank lines at start and end.
978 }
986 }
1007 }
1008 }
1016 # Grab the first conditional/block pair.
1019 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1023 }
1025 # Pull in the following conditional/block pairs and see if they
1026 # could continue the statement.
1030 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1032 #print "C: push\n";
1034 }
1037 }
1056 # Handle nested #if/#else.
1063 }
1066 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1070 }
1077 }
1078 }
1082 }
1085 }
1088 }
1094 }
1100 }
1106 }
1111 }
1116 }
1121 # Catch a comment on the end of the line itself.
1125 # Look through the context and try and figure out if there is a
1126 # comment.
1131 #warn " $line\n";
1134 }
1137 }
1140 }
1144 }
1145 }
1149 }
1154 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1155 ##print "CMMT: $cmt\n";
1158 }
1171 }
1174 }
1186 }
1187 }
1191 }
1203 }
1223 }
1244 }
1273 # Assume all arms of the conditional end as this
1274 # one does, and continue as if the #endif was not here.
1291 }
1322 }
1334 }
1367 }
1382 }
1391 }
1395 }
1399 }
1400 }
1403 }
1412 DEFINE_\S+
1413 )$|
1417 case|
1421 \#|
1422 \#\#|
1428 # Check for modifiers.
1439 }
1440 }
1445 }
1446 build_types();
1449 }
1450 }
1460 }
1468 }
1474 }
1480 }
1484 }
1493 }
1495 }
1503 }
1505 }
1513 }
1515 }
1521 ##print "absolute<$absolute>\n";
1523 # See if any suffix of this path is a path within the tree.
1526 ##print "file<$file>\n";
1528 }
1529 }
1532 }
1534 # It is, so see if the prefix is acceptable.
1538 ##print "prefix<$prefix>\n";
1542 }
1543 }
1551 }
1559 }
1567 }
1575 }
1584 #convert leading spaces to tabs
1586 #Remove spaces before a tab
1590 }
1604 }
1616 }
1617 }
1620 }
1651 # Trace the real file/line as we go.
1663 # suppression flags
1671 # Pre-scan the patch sanitizing the lines.
1672 # Pre-scan the patch looking for any __setup documentation.
1673 #
1679 sanitise_line_reset();
1691 }
1692 #next;
1693 }
1700 }
1703 # Guestimate if this is a continuing comment. Run
1704 # the context looking for a comment "edge". If this
1705 # edge is a close comment then we must be in a comment
1706 # at context start.
1713 #print "RAW<$rawlines[$ln - 1]>\n";
1719 }
1720 }
1723 }
1725 # Guestimate if this is a continuing comment. If this
1726 # is the start of a diff block and this line starts
1727 # ' *' then it is very likely a comment.
1730 {
1732 }
1734 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1738 # Standardise the strings and chars within the input to
1739 # simplify matching -- only bother with positive lines.
1741 }
1748 }
1750 #print "==>$rawline\n";
1751 #print "-->$line\n";
1755 }
1756 }
1769 #extract the line range in the file after the patch is applied
1778 }
1779 annotate_reset();
1788 # track the line number as we move through the hunk, note that
1789 # new versions of GNU diff omit the leading space on completely
1790 # blank context lines so we need to count that too.
1795 # Measure the line length and indent.
1798 # Track the previous line.
1803 #warn "line<$line>\n";
1807 }
1811 #make up the handle for any error we report on this line
1819 # extract the filename as it passes
1835 }
1839 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1840 }
1842 }
1849 }
1851 }
1861 # Check for incorrect file permissions
1868 }
1869 }
1871 # Check the patch for a signoff:
1875 }
1877 # Check signature styles
1889 }
1896 }
1897 }
1904 }
1906 }
1913 }
1914 }
1925 # Don't force email to have quotes
1926 # Allow just an angle bracketed address
1932 }
1933 }
1935 # Check for duplicate signatures
1944 }
1945 }
1947 # Check for old stable address
1951 }
1953 # Check for unwanted Gerrit info
1957 }
1959 # Check for wrappage within a valid hunk of the file
1964 }
1966 # Check for absolute kernel paths.
1973 #
1976 }
1977 }
1978 }
1980 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1991 }
1993 # Check if it's the start of a commit log
1994 # (not a header line and we haven't seen the patch filename)
1999 }
2001 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2002 # declined it, i.e defined some charset where it is missing.
2007 }
2013 }
2015 # ignore non-hunk lines and lines being removed
2018 #trailing whitespace
2025 }
2032 }
2035 }
2037 # Check for FSF mailing addresses.
2045 "Do not include the paragraph about writing to the Free Software Foundation's mailing address from the sample GPL notice. The FSF has changed addresses in the past, and may do so again. Linux already includes a copy of the GPL.\n" . $herevet)
2046 }
2048 # check for Kconfig help text having a real description
2049 # Only applies when adding the entry originally, after that we do not have
2050 # sufficient context to determine whether it is indeed long enough.
2070 }
2079 }
2081 }
2083 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2084 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2085 }
2087 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2091 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2092 }
2102 };
2105 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2106 }
2108 # check for DT compatible documentation
2127 }
2134 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2135 }
2136 }
2137 }
2139 # check we are in a valid source file if not then ignore this hunk
2142 #line length limit
2145 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2148 {
2151 }
2153 # Check for user-visible strings broken across lines, which breaks the ability
2154 # to grep for the string. Make exceptions when the previous string ends in a
2155 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2156 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
2162 }
2164 # check for spaces before a quoted newline
2170 }
2172 }
2174 # check for adding lines without a newline.
2175 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2178 }
2180 # Blackfin: use hi/lo macros
2186 }
2191 }
2192 }
2194 # check we are in a valid source file C or perl if not then ignore this hunk
2197 # at the beginning of a line any tabs must come first and anything
2198 # more than 8 must use tabs.
2207 }
2208 }
2210 # check for space before tabs.
2220 }
2221 }
2223 # check for && or || at the start of a line
2227 }
2229 # check multi-line statement indentation matches previous line
2231 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2254 }
2255 }
2256 }
2257 }
2265 }
2266 }
2274 }
2283 }
2292 }
2294 # check for missing blank lines after declarations
2296 # actual declarations
2298 # foo bar; where foo is some local typedef or #define
2300 # known declaration macros
2302 # for "else if" which can look like "$Ident $Ident"
2304 # other possible extensions of declaration lines
2306 # not starting a section or a macro "\" extended line
2308 # looks like a declaration
2310 # foo bar; where foo is some local typedef or #define
2312 # known declaration macros
2314 # start of struct or union or enum
2316 # start or end of block or continuation of declaration
2318 # bitfield continuation
2320 # other possible extensions of declaration lines
2322 # indentation of previous and current line are the same
2326 }
2328 # check for spaces at the beginning of a line.
2329 # Exceptions:
2330 # 1) within comments
2331 # 2) indented preprocessor commands
2332 # 3) hanging labels
2339 }
2340 }
2342 # check we are in a valid C source file if not then ignore this hunk
2345 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2348 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2349 }
2351 # check for RCS/CVS revision markers
2355 }
2357 # Blackfin: don't use __builtin_bfin_[cs]sync
2362 }
2367 }
2369 # check for old HOTPLUG __dev<foo> section markings
2373 }
2375 # Check for potential 'bare' types
2378 #print "LINE<$line>\n";
2386 #print "linenr<$linenr> <$stat>\n";
2387 # If this statement has no statement boundaries within
2388 # it there is no point in retrying a statement scan
2389 # until we hit end of it.
2392 #print "skip<$line_nr_next>\n";
2394 }
2396 # Find the real next line.
2402 }
2407 # Ignore goto labels.
2410 # Ignore functions being called
2415 # declarations always start with types
2416 } 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) {
2421 # definitions in global scope can only start with types
2424 }
2426 # any (foo ... *) is a pointer cast, and foo is a type
2429 }
2431 # Check for any sort of function declaration.
2432 # int foo(something bar, other baz);
2433 # void (*store_gdt)(x86_descr_ptr *);
2434 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2442 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2445 }
2446 }
2447 }
2449 }
2451 #
2452 # Checks which may be anchored in the context.
2453 #
2455 # Check for switch () and associated case and default
2456 # statements should be at the same indent.
2470 }
2471 }
2475 }
2476 }
2478 # if/while/etc brace do not go on next line, unless defining a do while loop,
2479 # or if that brace on the next line is for something else
2488 }
2499 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2502 }
2504 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2505 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2511 }
2515 {
2521 }
2522 }
2523 }
2525 # Check relative indent for conditionals and blocks.
2526 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2534 # Make sure we remove the line prefixes as we have
2535 # none on the first line, and are going to readd them
2536 # where necessary.
2539 # Find out how long the conditional actually is.
2543 # We want to check the first line inside the block
2544 # starting at the end of the conditional, so remove:
2545 # 1) any blank line termination
2546 # 2) any opening brace { on end of the line
2547 # 3) any do (...) {
2554 }
2558 }
2560 # Also ignore a loop construct at the end of a
2561 # preprocessor statement.
2565 }
2572 # If we see an #else/#elif then the code
2573 # is not linear.
2576 }
2578 # Ignore:
2579 # 1) blank lines, they should be at 0,
2580 # 2) preprocessor lines, and
2581 # 3) labels.
2589 }
2590 }
2591 }
2596 # Check if either of these lines are modified, else
2597 # this is not this patch's fault.
2601 }
2604 }
2606 #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";
2611 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2612 }
2613 }
2615 # Track the 'values' across context and added lines.
2625 }
2628 #ignore lines not being added
2631 # TEST: allow direct testing of the type matcher.
2639 }
2641 }
2642 # TEST: allow direct testing of the attribute matcher.
2650 }
2652 }
2654 # check for initialisation to aggregates open brace on the next line
2659 }
2661 #
2662 # Checks which are anchored on the added line.
2663 #
2665 # check for malformed paths in #include statements (uses RAW line)
2671 }
2675 }
2676 }
2678 # no C99 // comments
2687 }
2688 }
2689 }
2690 # Remove C99 comments.
2694 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2695 # the whole statement.
2696 #print "APW <$lines[$realline_next - 1]>\n";
2702 # Handle definitions which produce identifiers with
2703 # a prefix:
2704 # XXX(foo);
2705 # EXPORT_SYMBOL(something_foo);
2709 #print "FOO C name<$name>\n";
2720 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2724 }
2725 }
2730 #print "FOO B <$lines[$linenr - 1]>\n";
2732 }
2737 }
2739 # check for global initialisers.
2746 }
2747 }
2748 # check for static initialisers.
2755 }
2756 }
2758 # check for static const char * arrays.
2763 }
2765 # check for static char foo[] = "bar" declarations.
2770 }
2772 # check for non-global char *foo[] = {"bar", ...} declarations.
2777 }
2779 # check for function declarations without arguments like "int foo()"
2785 }
2786 }
2788 # check for uses of DEFINE_PCI_DEVICE_TABLE
2793 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2794 }
2795 }
2797 # check for new typedefs, only function parameters and sparse annotations
2798 # make sense.
2806 }
2808 # * goes on variable not on type
2809 # (char*[ const])
2811 #print "AA<$1>\n";
2814 # Should start with a space.
2816 # Should not end with a space.
2818 # '*'s should not have spaces between.
2820 }
2822 ## print "1: from<$from> to<$to> ident<$ident>\n";
2832 }
2833 }
2834 }
2836 #print "BB<$1>\n";
2839 # Should start with a space.
2841 # Should not end with a space.
2843 # '*'s should not have spaces between.
2845 }
2846 # Modifiers should have spaces.
2849 ## print "2: from<$from> to<$to> ident<$ident>\n";
2860 }
2861 }
2862 }
2864 # # no BUG() or BUG_ON()
2865 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
2866 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2867 # print "$herecurr";
2868 # $clean = 0;
2869 # }
2873 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2874 }
2876 # check for uses of printk_ratelimit
2880 }
2882 # printk should use KERN_* levels. Note that follow on printk's on the
2883 # same line do not need a level, so we use the current block context
2884 # to try and find and validate the current printk. In summary the current
2885 # printk includes all preceding printk's which have no newline on the end.
2886 # we assume the first bad printk is the one to report.
2890 #print "CHECK<$lines[$ln - 1]\n";
2891 # we have a preceding printk if it ends
2892 # with "\n" ignore it, else it is to blame
2896 }
2898 }
2899 }
2903 }
2904 }
2913 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
2914 }
2922 }
2923 }
2932 }
2934 # function brace can't be on same line, except for #defines of do while,
2935 # or if closed on same line
2940 }
2942 # open braces for enum, union and struct go on the same line.
2947 }
2949 # missing space after union, struct or enum definition
2956 }
2957 }
2959 # Function pointer declarations
2960 # check spacing between type, funcptr, and args
2961 # canonical declaration is "type (*funcptr)(args...)"
2970 # the $Declare variable will capture all spaces after the type
2971 # so check it for a missing trailing missing space but pointer return types
2972 # don't need a space so don't warn for those.
2977 }
2982 }
2984 # unnecessary space "type (*funcptr)(args...)"
2985 # This test is not currently implemented because these declarations are
2986 # equivalent to
2987 # int foo(int bar, ...)
2988 # and this is form shouldn't/doesn't generate a checkpatch warning.
2989 #
2990 # elsif ($declare =~ /\s{2,}$/) {
2991 # WARN("SPACING",
2992 # "Multiple spaces after return type\n" . $herecurr);
2993 # }
2995 # unnecessary space "type ( *funcptr)(args...)"
3000 }
3002 # unnecessary space "type (* funcptr)(args...)"
3007 }
3009 # unnecessary space "type (*funcptr )(args...)"
3014 }
3016 # unnecessary space "type (*funcptr) (args...)"
3021 }
3025 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3026 }
3027 }
3029 # check for spacing round square brackets; allowed:
3030 # 1. with a type on the left -- int [] a;
3031 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3032 # 3. inside a curly brace -- = { [0...10] = 5 }
3043 }
3044 }
3045 }
3047 # check for spaces between functions and their parentheses.
3053 # Ignore those directives where spaces _are_ permitted.
3059 {
3060 # cpp #define statements have non-optional spaces, ie
3061 # if there is a space between the name and the open
3062 # parenthesis it is simply not a parameter group.
3065 # cpp #elif statement condition may start with a (
3068 # If this whole things ends with a type its most
3069 # likely a typedef for a function.
3078 }
3079 }
3080 }
3082 # Check operator spacing.
3088 <<=|>>=|<=|>=|==|!=|
3090 =>|->|<<|>>|<|>|=|!|~|
3096 ## print("element count: <" . $#elements . ">\n");
3097 ## foreach my $el (@elements) {
3098 ## print("el: <$el>\n");
3099 ## }
3107 }
3118 ## print("n: <$n> good: <$good>\n");
3122 # Pick up the preceding and succeeding characters.
3127 }
3150 }
3159 # Pull out the value of this operator.
3162 # Get the full operator variant.
3165 # Ignore operators passed as parameters.
3169 # # Ignore comments
3170 # } elsif ($op =~ /^$;+$/) {
3172 # ; should have either the end of line or a space or \ after it
3180 }
3181 }
3183 # // is a comment
3186 # : when part of a bitfield
3188 # skip the bitfield test for now
3190 # No spaces for:
3191 # ->
3199 }
3201 }
3202 }
3204 # , must have a space on the right.
3212 }
3213 }
3215 # '*' as part of a type definition -- reported already.
3217 #warn "'*' is part of type\n";
3219 # unary operators should have a space before and
3220 # none after. May be left adjacent to another
3221 # unary operator, or a cast
3231 }
3232 }
3233 }
3235 # A unary '*' may be const
3243 }
3245 }
3246 }
3248 # unary ++ and unary -- are allowed no space on one side.
3255 }
3256 }
3263 }
3264 }
3271 }
3273 }
3274 }
3276 # << and >> may either have or not have spaces both sides
3282 {
3289 }
3291 }
3292 }
3294 # A colon needs no spaces before when it is
3295 # terminating a case value or a label.
3302 }
3303 }
3305 # All the others need spaces both sides.
3309 # Ignore email addresses <foo@bar>
3314 {
3316 }
3318 # messages are ERROR, but ?: are CHK
3328 }
3330 }
3331 }
3332 }
3335 ## print("n: <$n> GOOD: <$good>\n");
3338 }
3342 }
3346 }
3349 }
3351 # check for whitespace before a non-naked semicolon
3358 }
3359 }
3361 # check for multiple assignments
3365 }
3367 ## # check for multiple declarations, allowing for a function declaration
3368 ## # continuation.
3369 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3370 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3371 ##
3372 ## # Remove any bracketed sections to ensure we do not
3373 ## # falsly report the parameters of functions.
3374 ## my $ln = $line;
3375 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3376 ## }
3377 ## if ($ln =~ /,/) {
3378 ## WARN("MULTIPLE_DECLARATION",
3379 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3380 ## }
3381 ## }
3383 #need space before brace following if, while, etc
3390 }
3391 }
3393 ## # check for blank lines before declarations
3394 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3395 ## $prevrawline =~ /^.\s*$/) {
3396 ## WARN("SPACING",
3397 ## "No blank lines before declarations\n" . $hereprev);
3398 ## }
3399 ##
3401 # closing brace should have a space following it when it has anything
3402 # on the line
3409 }
3410 }
3412 # check spacing on square brackets
3419 }
3420 }
3427 }
3428 }
3430 # check spacing on parentheses
3438 }
3439 }
3448 }
3449 }
3451 #goto labels aren't indented, allow a single space however
3459 }
3460 }
3462 # return is not a function
3472 }
3476 }
3477 }
3479 # unnecessary return in a void function
3480 # at end-of-function, with the previous line a single leading tab, then return;
3481 # and the line before that not a goto label target like "out:"
3489 }
3491 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3497 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3502 }
3503 }
3505 # Return of what appears to be an errno should normally be -'ve
3511 }
3512 }
3514 # Need a space before open parenthesis after if, while etc
3521 }
3522 }
3524 # Check for illegal assignment in if conditional -- and check for trailing
3525 # statements after the conditional.
3533 ##print "stat<$stat> stat_next<$stat_next>\n";
3536 # If the statement carries leading newlines,
3537 # then count those as offsets.
3545 }
3546 }
3555 }
3557 # Find out what is on the end of the line after the
3558 # conditional.
3564 {
3565 # Find out how long the conditional actually is.
3574 }
3578 }
3579 }
3581 # Check for bitwise tests written as boolean
3587 |
3592 {
3595 }
3597 # if and else should not have general statements after it
3604 }
3605 }
3606 # if should not continue a brace
3611 }
3612 # case and default should not have general statements after them
3618 {
3621 }
3623 # Check for }<nl>else {, these must be at the same
3624 # indent level to be relevant to each other.
3629 }
3635 # Find out what is on the end of the line after the
3636 # conditional.
3643 }
3644 }
3646 #Specific variable tests
3650 #gcc binary extension
3658 }
3659 }
3661 #CamelCase
3664 #Ignore Page<foo> variants
3666 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3672 seed_camelcase_includes();
3676 }
3677 }
3682 }
3683 }
3684 }
3685 }
3687 #no spaces allowed after \ in define
3693 }
3694 }
3696 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
3703 {
3710 }
3711 }
3712 }
3714 # multi-statement macros should be enclosed in a do while loop, grab the
3715 # first statement and ensure its the whole macro if its not enclosed
3716 # in a known good container
3726 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3727 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3735 # Flatten any parentheses and braces
3739 {
3740 }
3742 # Flatten any obvious string concatentation.
3745 {
3746 }
3750 module_param_named|
3751 MODULE_PARM_DESC|
3752 DECLARE_PER_CPU|
3753 DEFINE_PER_CPU|
3754 __typeof__\(|
3755 union|
3756 struct|
3760 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3764 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
3769 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
3775 {
3782 }
3790 }
3791 }
3793 # check for line continuations outside of #defines, preprocessor #, and asm
3802 }
3803 }
3805 # do {} while (0) macro tests:
3806 # single-statement macros do not need to be enclosed in do while (0) loop,
3807 # macro should not end with a semicolon
3821 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3831 }
3837 }
3841 }
3849 }
3853 }
3854 }
3856 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3857 # all assignments may have only one of the following with an assignment:
3858 # .
3859 # ALIGN(...)
3860 # VMLINUX_SYMBOL(...)
3864 }
3866 # check for redundant bracing round if etc
3870 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3871 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3881 # If the condition carries leading newlines, then count those as offsets.
3886 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3888 # We have looked at and allowed this specific line.
3898 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3900 #print "APW: ALLOWED: cond<$cond>\n";
3902 }
3904 #print "APW: ALLOWED: block<$block>\n";
3906 }
3908 #print "APW: ALLOWED: lines block<$block>\n";
3910 }
3912 }
3917 }
3925 }
3926 }
3927 }
3928 }
3933 # Check the pre-context.
3935 #print "APW: ALLOWED: pre<$1>\n";
3937 }
3942 # Check the condition.
3944 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3947 }
3949 #print "APW: ALLOWED: cond<$cond>\n";
3951 }
3953 #print "APW: ALLOWED: block<$block>\n";
3955 }
3957 #print "APW: ALLOWED: lines block<$block>\n";
3959 }
3960 # Check the post-context.
3965 }
3967 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3969 }
3970 }
3977 }
3981 }
3982 }
3984 # check for unnecessary blank lines around braces
3988 }
3992 }
3994 # no volatiles please
3998 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3999 }
4001 # warn about #if 0
4006 }
4008 # check for needless "if (<foo>) fn(<foo>)" uses
4014 }
4015 }
4017 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4020 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4030 $fixed[$linenr - 1] =~ s/(\bstatic\s+(?:const\s+)?)(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*([=;])\s*/"$1" . trim(string_find_replace($2, "\\s*$attr\\s*", " ")) . " " . trim(string_find_replace($3, "\\s*$attr\\s*", "")) . " $attr" . ("$4" eq ";" ? ";" : " = ")/e;
4031 }
4032 }
4033 }
4035 # check for $InitAttributeData (ie: __initdata) with const
4046 }
4047 }
4049 # check for $InitAttributeConst (ie: __initconst) without const
4061 }
4062 }
4064 # don't use __constant_<foo> functions outside of include/uapi/
4066 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4074 }
4075 }
4077 # prefer usleep_range over udelay
4080 # ignore udelay's < 10, however
4083 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4084 }
4088 }
4089 }
4091 # warn about unexpectedly long msleep's
4095 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4096 }
4097 }
4099 # check for comparisons of jiffies
4102 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4103 }
4105 # check for comparisons of get_jiffies_64()
4108 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4109 }
4111 # warn about #ifdefs in C files
4112 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4113 # print "#ifdef in C files should be avoided\n";
4114 # print "$herecurr";
4115 # $clean = 0;
4116 # }
4118 # warn about spacing in #ifdefs
4125 }
4127 }
4129 # check for spinlock_t definitions without a comment.
4136 }
4137 }
4138 # check for memory barriers without a comment.
4139 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4143 }
4144 }
4145 # check of hardware specific defines
4146 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4149 }
4151 # Check that the storage class is at the beginning of a declaration
4155 }
4157 # check the location of the inline attribute, that it is between
4158 # storage class and type.
4163 }
4165 # Check for __inline__ and __inline, prefer inline
4173 }
4174 }
4176 # Check for __attribute__ packed, prefer __packed
4181 }
4183 # Check for __attribute__ aligned, prefer __aligned
4188 }
4190 # Check for __attribute__ format(printf, prefer __printf
4194 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4196 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4198 }
4199 }
4201 # Check for __attribute__ format(scanf, prefer __scanf
4205 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4207 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4208 }
4209 }
4211 # check for sizeof(&)
4215 }
4217 # check for sizeof without parenthesis
4222 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4223 }
4224 }
4226 # check for line continuations in quoted strings with odd counts of "
4230 }
4232 # check for struct spinlock declarations
4236 }
4238 # check for seq_printf uses that could be seq_puts
4246 }
4247 }
4248 }
4250 # Check for misused memsets
4265 }
4266 }
4268 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4272 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4274 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4275 }
4276 }
4278 # typecasts on min/max could be min_t/max_t
4296 }
4299 }
4300 }
4302 # check usleep_range arguments
4310 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4314 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4315 }
4316 }
4318 # check for naked sscanf
4330 }
4333 }
4335 # check for simple sscanf that should be kstrto<foo>
4344 }
4352 }
4353 }
4354 }
4356 # check for new externs in .h files.
4363 }
4364 }
4366 # check for new externs in .c files.
4369 {
4376 }
4379 {
4382 }
4387 }
4391 {
4394 }
4396 # checks for new __setup's
4403 }
4404 }
4406 # check for pointless casting of kmalloc return
4409 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
4410 }
4412 # alloc style
4413 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4415 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4418 }
4420 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4422 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/) {
4437 }
4438 $fixed[$linenr - 1] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
4440 }
4441 }
4442 }
4444 # check for krealloc arg reuse
4449 }
4451 # check for alloc argument mismatch
4455 }
4457 # check for multiple semicolons
4463 }
4464 }
4466 # check for case / default statements not preceeded by break/fallthrough/switch
4484 }
4488 }
4489 }
4491 # check for switch/default statements without a break;
4500 }
4503 }
4505 # check for gcc specific __FUNCTION__
4511 }
4512 }
4514 # check for use of yield()
4518 }
4520 # check for comparisons against true and false
4536 }
4541 ## maybe suggesting a correct construct would better
4542 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4544 }
4545 }
4547 # check for semaphores initialized locked
4551 }
4553 # recommend kstrto* over simple_strto* and strict_strto*
4557 }
4559 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
4562 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
4563 }
4565 # check for various ops structs, ensure they are const.
4567 address_space_operations|
4568 backlight_ops|
4569 block_device_operations|
4570 dentry_operations|
4571 dev_pm_ops|
4572 dma_map_ops|
4573 extent_io_ops|
4574 file_lock_operations|
4575 file_operations|
4576 hv_ops|
4577 ide_dma_ops|
4578 intel_dvo_dev_ops|
4579 item_operations|
4580 iwl_ops|
4581 kgdb_arch|
4582 kgdb_io|
4583 kset_uevent_ops|
4584 lock_manager_operations|
4585 microcode_ops|
4586 mtrr_ops|
4587 neigh_ops|
4588 nlmsvc_binding|
4589 pci_raw_ops|
4590 pipe_buf_operations|
4591 platform_hibernation_ops|
4592 platform_suspend_ops|
4593 proto_ops|
4594 rpc_pipe_ops|
4595 seq_operations|
4596 snd_ac97_build_ops|
4597 soc_pcmcia_socket_ops|
4598 stacktrace_ops|
4599 sysfs_ops|
4600 tty_operations|
4601 usb_mon_operations|
4608 }
4610 # use of NR_CPUS is usually wrong
4611 # ignore definitions of NR_CPUS and usage to define arrays as likely right
4618 {
4620 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
4621 }
4623 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4627 }
4629 # check for %L{u,d,i} in strings
4638 }
4639 }
4641 # whine mightly about in_atomic
4649 }
4650 }
4652 # check for lockdep_set_novalidate_class
4660 }
4661 }
4666 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
4667 }
4669 # Mode permission misuses where it seems decimal should be octal
4670 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4681 }
4692 }
4693 }
4694 }
4695 }
4696 }
4698 # If we have no input at all, then there is nothing to report on
4699 # so just keep quiet.
4702 }
4704 # In mailback mode only produce a report in the negative, for
4705 # things that appear to be patches.
4708 }
4710 # This is not a patch, and we are are in 'no-patch' mode so
4711 # just keep quiet.
4714 }
4719 }
4723 }
4732 }
4739 }
4741 # If there were whitespace errors which cleanpatch can fix
4742 # then suggest that.
4747 }
4748 }
4767 }
4770 }
4771 }
4778 Do _NOT_ trust the results written to this file.
4781 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4784 EOM
4785 }
4786 }
4790 }
4795 If any of these errors are false positives, please report
4797 EOM
4798 }
4801 }