| blob | 34eb2160489d5cccda8e6d3d17596ff0a236bc6a |
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
53 Options:
58 --emacs emacs compile window format
59 --terse one line per report
72 is all off)
74 literally
77 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
78 with potential errors corrected to the preferred
79 checkpatch style
84 runtime errors.
88 EOM
91 }
113 }
114 }
117 }
119 GetOptions(
156 }
157 }
162 }
178 }
179 }
188 }
190 }
191 }
201 ## no critic
204 }
211 }
217 }
224 }
225 }
230 }
231 }
241 __user|
242 __kernel|
243 __force|
244 __iomem|
245 __must_check|
246 __init_refok|
247 __kprobes|
248 __ref|
249 __rcu
257 # Notes to $Attribute:
258 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
260 const|
261 __percpu|
262 __nocast|
263 __safe|
264 __bitwise__|
265 __packed__|
266 __packed2__|
267 __naked|
268 __maybe_unused|
269 __always_unused|
270 __noreturn|
271 __used|
272 __cold|
273 __noclone|
274 __deprecated|
275 __read_mostly|
276 __kprobes|
278 ____cacheline_aligned|
279 ____cacheline_aligned_in_smp|
280 ____cacheline_internodealigned_in_smp|
281 __weak
302 <=|>=|==|!=|
303 =>|->|<<|>>|<|>|!|~|
331 atomic_t
332 )};
336 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
338 panic|
341 )};
350 To:|
351 Cc:
352 )};
373 );
378 );
382 );
388 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
391 );
393 #Create a search pattern for all these functions to speed up a loop below
398 }
401 irq|
402 memory
403 )};
404 # memory.h: ARM has a custom one
417 )
426 )
430 $NonptrType
435 }
436 build_types();
440 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
441 # requires at least perl version v5.10.0
442 # Any use must be runtime checked with $^V
455 }
460 }
484 }
485 }
486 }
510 }
512 }
520 }
524 }
529 }
533 }
541 }
543 }
544 }
562 }
567 }
571 }
575 }
579 }
590 );
595 }
596 }
598 }
621 # If there's a name left after stripping spaces and
622 # leading quotes, and the address doesn't have both
623 # leading and trailing angle brackets, the address
624 # is invalid. ie:
625 # "joe smith joe@smith.com" bad
626 # "joe smith <joe@smith.com" bad
631 }
632 }
642 }
645 }
659 }
665 }
668 }
676 }
677 }
680 }
693 }
695 }
698 }
701 }
705 }
710 # Drop the diff line leader and expand tabs
714 # Pick the indent from the front of the line.
718 }
729 }
730 }
741 # Always copy over the diff marker.
747 # Comments we are wacking completly including the begin
748 # and end, all to $;.
755 }
761 }
768 }
770 # A \ in a string means ignore the next character.
776 }
777 # Regular quotes.
786 }
787 }
789 #print "c<$c> SQ<$sanitise_quote>\n";
798 }
799 }
803 }
805 # The pathname on a #include may be surrounded by '<' and '>'.
810 # The whole of a #error is a string.
814 }
817 }
824 }
847 #warn "CSB: blk<$blk> remain<$remain>\n";
848 # If we are about to drop off the end, pull in more
849 # context.
860 }
861 # Bail if there is no further context.
862 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
865 }
869 }
870 }
875 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
877 # Handle nested #if/#else.
884 }
886 # Statement ends at the ';' or a close '}' at the
887 # outermost level.
890 }
892 # An else is really a conditional as long as its not else if
899 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
900 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
901 }
906 }
914 #warn "CSB: mark coff<$coff>\n";
915 }
916 }
920 }
928 }
930 }
931 }
932 # Preprocessor commands end at the newline unless escaped.
938 }
940 }
941 # We are truly at the end, so shuffle to the next line.
946 }
951 #warn "STATEMENT<$statement>\n";
952 #warn "CONDITION<$condition>\n";
954 #print "coff<$coff> soff<$off> loff<$loff>\n";
958 }
963 # Strip the diff line prefixes and rip blank lines at start and end.
971 }
979 }
1000 }
1001 }
1009 # Grab the first conditional/block pair.
1012 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1016 }
1018 # Pull in the following conditional/block pairs and see if they
1019 # could continue the statement.
1023 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1025 #print "C: push\n";
1027 }
1030 }
1049 # Handle nested #if/#else.
1056 }
1059 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1063 }
1070 }
1071 }
1075 }
1078 }
1081 }
1087 }
1093 }
1099 }
1104 }
1109 }
1114 # Catch a comment on the end of the line itself.
1118 # Look through the context and try and figure out if there is a
1119 # comment.
1124 #warn " $line\n";
1127 }
1130 }
1133 }
1137 }
1138 }
1142 }
1147 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1148 ##print "CMMT: $cmt\n";
1151 }
1164 }
1167 }
1179 }
1180 }
1184 }
1196 }
1216 }
1237 }
1266 # Assume all arms of the conditional end as this
1267 # one does, and continue as if the #endif was not here.
1284 }
1315 }
1327 }
1360 }
1375 }
1384 }
1388 }
1392 }
1393 }
1396 }
1405 DEFINE_\S+
1406 )$|
1410 case|
1414 \#|
1415 \#\#|
1421 # Check for modifiers.
1432 }
1433 }
1438 }
1439 build_types();
1442 }
1443 }
1453 }
1461 }
1467 }
1473 }
1477 }
1486 }
1488 }
1496 }
1498 }
1506 }
1508 }
1514 ##print "absolute<$absolute>\n";
1516 # See if any suffix of this path is a path within the tree.
1519 ##print "file<$file>\n";
1521 }
1522 }
1525 }
1527 # It is, so see if the prefix is acceptable.
1531 ##print "prefix<$prefix>\n";
1535 }
1536 }
1544 }
1552 }
1560 }
1568 }
1577 #convert leading spaces to tabs
1579 #Remove spaces before a tab
1583 }
1597 }
1609 }
1610 }
1613 }
1644 # Trace the real file/line as we go.
1656 # suppression flags
1664 # Pre-scan the patch sanitizing the lines.
1665 # Pre-scan the patch looking for any __setup documentation.
1666 #
1672 sanitise_line_reset();
1684 }
1685 #next;
1686 }
1693 }
1696 # Guestimate if this is a continuing comment. Run
1697 # the context looking for a comment "edge". If this
1698 # edge is a close comment then we must be in a comment
1699 # at context start.
1706 #print "RAW<$rawlines[$ln - 1]>\n";
1712 }
1713 }
1716 }
1718 # Guestimate if this is a continuing comment. If this
1719 # is the start of a diff block and this line starts
1720 # ' *' then it is very likely a comment.
1723 {
1725 }
1727 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1731 # Standardise the strings and chars within the input to
1732 # simplify matching -- only bother with positive lines.
1734 }
1741 }
1743 #print "==>$rawline\n";
1744 #print "-->$line\n";
1748 }
1749 }
1762 #extract the line range in the file after the patch is applied
1771 }
1772 annotate_reset();
1781 # track the line number as we move through the hunk, note that
1782 # new versions of GNU diff omit the leading space on completely
1783 # blank context lines so we need to count that too.
1788 # Measure the line length and indent.
1791 # Track the previous line.
1796 #warn "line<$line>\n";
1800 }
1804 #make up the handle for any error we report on this line
1811 # extract the filename as it passes
1826 }
1830 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1831 }
1833 }
1843 # Check for incorrect file permissions
1850 }
1851 }
1853 # Check the patch for a signoff:
1857 }
1859 # Check signature styles
1871 }
1878 }
1879 }
1886 }
1888 }
1895 }
1896 }
1907 # Don't force email to have quotes
1908 # Allow just an angle bracketed address
1914 }
1915 }
1917 # Check for duplicate signatures
1926 }
1927 }
1929 # Check for unwanted Gerrit info
1933 }
1935 # Check for wrappage within a valid hunk of the file
1940 }
1942 # Check for absolute kernel paths.
1949 #
1952 }
1953 }
1954 }
1956 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1967 }
1969 # Check if it's the start of a commit log
1970 # (not a header line and we haven't seen the patch filename)
1975 }
1977 # Check if there is UTF-8 in a commit log when a mail header has explicitly
1978 # declined it, i.e defined some charset where it is missing.
1983 }
1989 }
1991 # ignore non-hunk lines and lines being removed
1994 #trailing whitespace
2001 }
2008 }
2011 }
2013 # Check for FSF mailing addresses.
2021 "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)
2022 }
2024 # check for Kconfig help text having a real description
2025 # Only applies when adding the entry originally, after that we do not have
2026 # sufficient context to determine whether it is indeed long enough.
2046 }
2055 }
2057 }
2059 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2060 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2061 }
2063 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2067 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2068 }
2078 };
2081 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2082 }
2084 # check for DT compatible documentation
2101 }
2108 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2109 }
2110 }
2111 }
2113 # check we are in a valid source file if not then ignore this hunk
2116 #line length limit
2119 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2122 {
2125 }
2127 # Check for user-visible strings broken across lines, which breaks the ability
2128 # to grep for the string. Make exceptions when the previous string ends in a
2129 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2130 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
2136 }
2138 # check for spaces before a quoted newline
2144 }
2146 }
2148 # check for adding lines without a newline.
2149 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2152 }
2154 # Blackfin: use hi/lo macros
2160 }
2165 }
2166 }
2168 # check we are in a valid source file C or perl if not then ignore this hunk
2171 # at the beginning of a line any tabs must come first and anything
2172 # more than 8 must use tabs.
2181 }
2182 }
2184 # check for space before tabs.
2194 }
2195 }
2197 # check for && or || at the start of a line
2201 }
2203 # check multi-line statement indentation matches previous line
2205 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2228 }
2229 }
2230 }
2231 }
2239 }
2240 }
2248 }
2257 }
2266 }
2268 # check for missing blank lines after declarations
2281 }
2283 # check for spaces at the beginning of a line.
2284 # Exceptions:
2285 # 1) within comments
2286 # 2) indented preprocessor commands
2287 # 3) hanging labels
2294 }
2295 }
2297 # check we are in a valid C source file if not then ignore this hunk
2300 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2303 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2304 }
2306 # check for RCS/CVS revision markers
2310 }
2312 # Blackfin: don't use __builtin_bfin_[cs]sync
2317 }
2322 }
2324 # check for old HOTPLUG __dev<foo> section markings
2328 }
2330 # Check for potential 'bare' types
2333 #print "LINE<$line>\n";
2341 #print "linenr<$linenr> <$stat>\n";
2342 # If this statement has no statement boundaries within
2343 # it there is no point in retrying a statement scan
2344 # until we hit end of it.
2347 #print "skip<$line_nr_next>\n";
2349 }
2351 # Find the real next line.
2357 }
2362 # Ignore goto labels.
2365 # Ignore functions being called
2370 # declarations always start with types
2371 } 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) {
2376 # definitions in global scope can only start with types
2379 }
2381 # any (foo ... *) is a pointer cast, and foo is a type
2384 }
2386 # Check for any sort of function declaration.
2387 # int foo(something bar, other baz);
2388 # void (*store_gdt)(x86_descr_ptr *);
2389 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2397 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2400 }
2401 }
2402 }
2404 }
2406 #
2407 # Checks which may be anchored in the context.
2408 #
2410 # Check for switch () and associated case and default
2411 # statements should be at the same indent.
2425 }
2426 }
2430 }
2431 }
2433 # if/while/etc brace do not go on next line, unless defining a do while loop,
2434 # or if that brace on the next line is for something else
2443 }
2454 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2457 }
2459 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2460 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2466 }
2470 {
2476 }
2477 }
2478 }
2480 # Check relative indent for conditionals and blocks.
2481 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2489 # Make sure we remove the line prefixes as we have
2490 # none on the first line, and are going to readd them
2491 # where necessary.
2494 # Find out how long the conditional actually is.
2498 # We want to check the first line inside the block
2499 # starting at the end of the conditional, so remove:
2500 # 1) any blank line termination
2501 # 2) any opening brace { on end of the line
2502 # 3) any do (...) {
2509 }
2513 }
2515 # Also ignore a loop construct at the end of a
2516 # preprocessor statement.
2520 }
2527 # If we see an #else/#elif then the code
2528 # is not linear.
2531 }
2533 # Ignore:
2534 # 1) blank lines, they should be at 0,
2535 # 2) preprocessor lines, and
2536 # 3) labels.
2544 }
2545 }
2546 }
2551 # Check if either of these lines are modified, else
2552 # this is not this patch's fault.
2556 }
2559 }
2561 #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";
2566 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2567 }
2568 }
2570 # Track the 'values' across context and added lines.
2580 }
2583 #ignore lines not being added
2586 # TEST: allow direct testing of the type matcher.
2594 }
2596 }
2597 # TEST: allow direct testing of the attribute matcher.
2605 }
2607 }
2609 # check for initialisation to aggregates open brace on the next line
2614 }
2616 #
2617 # Checks which are anchored on the added line.
2618 #
2620 # check for malformed paths in #include statements (uses RAW line)
2626 }
2630 }
2631 }
2633 # no C99 // comments
2642 }
2643 }
2644 }
2645 # Remove C99 comments.
2649 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2650 # the whole statement.
2651 #print "APW <$lines[$realline_next - 1]>\n";
2657 # Handle definitions which produce identifiers with
2658 # a prefix:
2659 # XXX(foo);
2660 # EXPORT_SYMBOL(something_foo);
2664 #print "FOO C name<$name>\n";
2675 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2679 }
2680 }
2685 #print "FOO B <$lines[$linenr - 1]>\n";
2687 }
2692 }
2694 # check for global initialisers.
2701 }
2702 }
2703 # check for static initialisers.
2710 }
2711 }
2713 # check for static const char * arrays.
2718 }
2720 # check for static char foo[] = "bar" declarations.
2725 }
2727 # check for non-global char *foo[] = {"bar", ...} declarations.
2732 }
2734 # check for function declarations without arguments like "int foo()"
2740 }
2741 }
2743 # check for uses of DEFINE_PCI_DEVICE_TABLE
2748 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2749 }
2750 }
2752 # check for new typedefs, only function parameters and sparse annotations
2753 # make sense.
2761 }
2763 # * goes on variable not on type
2764 # (char*[ const])
2766 #print "AA<$1>\n";
2769 # Should start with a space.
2771 # Should not end with a space.
2773 # '*'s should not have spaces between.
2775 }
2777 ## print "1: from<$from> to<$to> ident<$ident>\n";
2787 }
2788 }
2789 }
2791 #print "BB<$1>\n";
2794 # Should start with a space.
2796 # Should not end with a space.
2798 # '*'s should not have spaces between.
2800 }
2801 # Modifiers should have spaces.
2804 ## print "2: from<$from> to<$to> ident<$ident>\n";
2815 }
2816 }
2817 }
2819 # # no BUG() or BUG_ON()
2820 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
2821 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2822 # print "$herecurr";
2823 # $clean = 0;
2824 # }
2828 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2829 }
2831 # check for uses of printk_ratelimit
2835 }
2837 # printk should use KERN_* levels. Note that follow on printk's on the
2838 # same line do not need a level, so we use the current block context
2839 # to try and find and validate the current printk. In summary the current
2840 # printk includes all preceding printk's which have no newline on the end.
2841 # we assume the first bad printk is the one to report.
2845 #print "CHECK<$lines[$ln - 1]\n";
2846 # we have a preceding printk if it ends
2847 # with "\n" ignore it, else it is to blame
2851 }
2853 }
2854 }
2858 }
2859 }
2868 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
2869 }
2877 }
2878 }
2887 }
2889 # function brace can't be on same line, except for #defines of do while,
2890 # or if closed on same line
2895 }
2897 # open braces for enum, union and struct go on the same line.
2902 }
2904 # missing space after union, struct or enum definition
2911 }
2912 }
2914 # Function pointer declarations
2915 # check spacing between type, funcptr, and args
2916 # canonical declaration is "type (*funcptr)(args...)"
2925 # the $Declare variable will capture all spaces after the type
2926 # so check it for a missing trailing missing space but pointer return types
2927 # don't need a space so don't warn for those.
2932 }
2937 }
2939 # unnecessary space "type (*funcptr)(args...)"
2940 # This test is not currently implemented because these declarations are
2941 # equivalent to
2942 # int foo(int bar, ...)
2943 # and this is form shouldn't/doesn't generate a checkpatch warning.
2944 #
2945 # elsif ($declare =~ /\s{2,}$/) {
2946 # WARN("SPACING",
2947 # "Multiple spaces after return type\n" . $herecurr);
2948 # }
2950 # unnecessary space "type ( *funcptr)(args...)"
2955 }
2957 # unnecessary space "type (* funcptr)(args...)"
2962 }
2964 # unnecessary space "type (*funcptr )(args...)"
2969 }
2971 # unnecessary space "type (*funcptr) (args...)"
2976 }
2980 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
2981 }
2982 }
2984 # check for spacing round square brackets; allowed:
2985 # 1. with a type on the left -- int [] a;
2986 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2987 # 3. inside a curly brace -- = { [0...10] = 5 }
2998 }
2999 }
3000 }
3002 # check for spaces between functions and their parentheses.
3008 # Ignore those directives where spaces _are_ permitted.
3014 {
3015 # cpp #define statements have non-optional spaces, ie
3016 # if there is a space between the name and the open
3017 # parenthesis it is simply not a parameter group.
3020 # cpp #elif statement condition may start with a (
3023 # If this whole things ends with a type its most
3024 # likely a typedef for a function.
3033 }
3034 }
3035 }
3037 # Check operator spacing.
3043 <<=|>>=|<=|>=|==|!=|
3045 =>|->|<<|>>|<|>|=|!|~|
3051 ## print("element count: <" . $#elements . ">\n");
3052 ## foreach my $el (@elements) {
3053 ## print("el: <$el>\n");
3054 ## }
3062 }
3073 ## print("n: <$n> good: <$good>\n");
3077 # Pick up the preceding and succeeding characters.
3082 }
3105 }
3114 # Pull out the value of this operator.
3117 # Get the full operator variant.
3120 # Ignore operators passed as parameters.
3124 # # Ignore comments
3125 # } elsif ($op =~ /^$;+$/) {
3127 # ; should have either the end of line or a space or \ after it
3135 }
3136 }
3138 # // is a comment
3141 # : when part of a bitfield
3143 # skip the bitfield test for now
3145 # No spaces for:
3146 # ->
3154 }
3156 }
3157 }
3159 # , must have a space on the right.
3167 }
3168 }
3170 # '*' as part of a type definition -- reported already.
3172 #warn "'*' is part of type\n";
3174 # unary operators should have a space before and
3175 # none after. May be left adjacent to another
3176 # unary operator, or a cast
3186 }
3187 }
3188 }
3190 # A unary '*' may be const
3198 }
3200 }
3201 }
3203 # unary ++ and unary -- are allowed no space on one side.
3210 }
3211 }
3218 }
3219 }
3226 }
3228 }
3229 }
3231 # << and >> may either have or not have spaces both sides
3237 {
3244 }
3246 }
3247 }
3249 # A colon needs no spaces before when it is
3250 # terminating a case value or a label.
3257 }
3258 }
3260 # All the others need spaces both sides.
3264 # Ignore email addresses <foo@bar>
3269 {
3271 }
3273 # messages are ERROR, but ?: are CHK
3283 }
3285 }
3286 }
3287 }
3290 ## print("n: <$n> GOOD: <$good>\n");
3293 }
3297 }
3301 }
3304 }
3306 # check for whitespace before a non-naked semicolon
3313 }
3314 }
3316 # check for multiple assignments
3320 }
3322 ## # check for multiple declarations, allowing for a function declaration
3323 ## # continuation.
3324 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3325 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3326 ##
3327 ## # Remove any bracketed sections to ensure we do not
3328 ## # falsly report the parameters of functions.
3329 ## my $ln = $line;
3330 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3331 ## }
3332 ## if ($ln =~ /,/) {
3333 ## WARN("MULTIPLE_DECLARATION",
3334 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3335 ## }
3336 ## }
3338 #need space before brace following if, while, etc
3345 }
3346 }
3348 ## # check for blank lines before declarations
3349 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3350 ## $prevrawline =~ /^.\s*$/) {
3351 ## WARN("SPACING",
3352 ## "No blank lines before declarations\n" . $hereprev);
3353 ## }
3354 ##
3356 # closing brace should have a space following it when it has anything
3357 # on the line
3364 }
3365 }
3367 # check spacing on square brackets
3374 }
3375 }
3382 }
3383 }
3385 # check spacing on parentheses
3393 }
3394 }
3403 }
3404 }
3406 #goto labels aren't indented, allow a single space however
3414 }
3415 }
3417 # return is not a function
3427 }
3431 }
3432 }
3434 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3440 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3445 }
3446 }
3448 # Return of what appears to be an errno should normally be -'ve
3454 }
3455 }
3457 # Need a space before open parenthesis after if, while etc
3464 }
3465 }
3467 # Check for illegal assignment in if conditional -- and check for trailing
3468 # statements after the conditional.
3476 ##print "stat<$stat> stat_next<$stat_next>\n";
3479 # If the statement carries leading newlines,
3480 # then count those as offsets.
3488 }
3489 }
3498 }
3500 # Find out what is on the end of the line after the
3501 # conditional.
3507 {
3508 # Find out how long the conditional actually is.
3517 }
3521 }
3522 }
3524 # Check for bitwise tests written as boolean
3530 |
3535 {
3538 }
3540 # if and else should not have general statements after it
3547 }
3548 }
3549 # if should not continue a brace
3554 }
3555 # case and default should not have general statements after them
3561 {
3564 }
3566 # Check for }<nl>else {, these must be at the same
3567 # indent level to be relevant to each other.
3572 }
3578 # Find out what is on the end of the line after the
3579 # conditional.
3586 }
3587 }
3589 #Specific variable tests
3593 #gcc binary extension
3601 }
3602 }
3604 #CamelCase
3607 #Ignore Page<foo> variants
3609 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3615 seed_camelcase_includes();
3619 }
3620 }
3625 }
3626 }
3627 }
3628 }
3630 #no spaces allowed after \ in define
3636 }
3637 }
3639 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
3646 {
3653 }
3654 }
3655 }
3657 # multi-statement macros should be enclosed in a do while loop, grab the
3658 # first statement and ensure its the whole macro if its not enclosed
3659 # in a known good container
3669 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3670 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3678 # Flatten any parentheses and braces
3682 {
3683 }
3685 # Flatten any obvious string concatentation.
3688 {
3689 }
3693 module_param_named|
3694 MODULE_PARM_DESC|
3695 DECLARE_PER_CPU|
3696 DEFINE_PER_CPU|
3697 __typeof__\(|
3698 union|
3699 struct|
3703 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3707 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
3712 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
3718 {
3725 }
3733 }
3734 }
3736 # check for line continuations outside of #defines, preprocessor #, and asm
3745 }
3746 }
3748 # do {} while (0) macro tests:
3749 # single-statement macros do not need to be enclosed in do while (0) loop,
3750 # macro should not end with a semicolon
3764 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3774 }
3780 }
3784 }
3785 }
3786 }
3788 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3789 # all assignments may have only one of the following with an assignment:
3790 # .
3791 # ALIGN(...)
3792 # VMLINUX_SYMBOL(...)
3796 }
3798 # check for redundant bracing round if etc
3802 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3803 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3813 # If the condition carries leading newlines, then count those as offsets.
3818 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3820 # We have looked at and allowed this specific line.
3830 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3832 #print "APW: ALLOWED: cond<$cond>\n";
3834 }
3836 #print "APW: ALLOWED: block<$block>\n";
3838 }
3840 #print "APW: ALLOWED: lines block<$block>\n";
3842 }
3844 }
3849 }
3857 }
3858 }
3859 }
3860 }
3865 # Check the pre-context.
3867 #print "APW: ALLOWED: pre<$1>\n";
3869 }
3874 # Check the condition.
3876 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3879 }
3881 #print "APW: ALLOWED: cond<$cond>\n";
3883 }
3885 #print "APW: ALLOWED: block<$block>\n";
3887 }
3889 #print "APW: ALLOWED: lines block<$block>\n";
3891 }
3892 # Check the post-context.
3897 }
3899 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3901 }
3902 }
3909 }
3913 }
3914 }
3916 # check for unnecessary blank lines around braces
3920 }
3924 }
3926 # no volatiles please
3930 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3931 }
3933 # warn about #if 0
3938 }
3940 # check for needless "if (<foo>) fn(<foo>)" uses
3946 }
3947 }
3949 # check for bad placement of section $InitAttribute (e.g.: __initdata)
3952 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
3962 $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;
3963 }
3964 }
3965 }
3967 # check for $InitAttributeData (ie: __initdata) with const
3978 }
3979 }
3981 # check for $InitAttributeConst (ie: __initconst) without const
3993 }
3994 }
3996 # don't use __constant_<foo> functions outside of include/uapi/
3998 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4006 }
4007 }
4009 # prefer usleep_range over udelay
4012 # ignore udelay's < 10, however
4015 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4016 }
4020 }
4021 }
4023 # warn about unexpectedly long msleep's
4027 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4028 }
4029 }
4031 # check for comparisons of jiffies
4034 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4035 }
4037 # check for comparisons of get_jiffies_64()
4040 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4041 }
4043 # warn about #ifdefs in C files
4044 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4045 # print "#ifdef in C files should be avoided\n";
4046 # print "$herecurr";
4047 # $clean = 0;
4048 # }
4050 # warn about spacing in #ifdefs
4057 }
4059 }
4061 # check for spinlock_t definitions without a comment.
4068 }
4069 }
4070 # check for memory barriers without a comment.
4071 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4075 }
4076 }
4077 # check of hardware specific defines
4078 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4081 }
4083 # Check that the storage class is at the beginning of a declaration
4087 }
4089 # check the location of the inline attribute, that it is between
4090 # storage class and type.
4095 }
4097 # Check for __inline__ and __inline, prefer inline
4105 }
4106 }
4108 # Check for __attribute__ packed, prefer __packed
4113 }
4115 # Check for __attribute__ aligned, prefer __aligned
4120 }
4122 # Check for __attribute__ format(printf, prefer __printf
4126 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4128 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4130 }
4131 }
4133 # Check for __attribute__ format(scanf, prefer __scanf
4137 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4139 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4140 }
4141 }
4143 # check for sizeof(&)
4147 }
4149 # check for sizeof without parenthesis
4154 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4155 }
4156 }
4158 # check for line continuations in quoted strings with odd counts of "
4162 }
4164 # check for struct spinlock declarations
4168 }
4170 # check for seq_printf uses that could be seq_puts
4178 }
4179 }
4180 }
4182 # Check for misused memsets
4197 }
4198 }
4200 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4204 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4206 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4207 }
4208 }
4210 # typecasts on min/max could be min_t/max_t
4228 }
4231 }
4232 }
4234 # check usleep_range arguments
4242 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4246 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4247 }
4248 }
4250 # check for naked sscanf
4262 }
4265 }
4267 # check for new externs in .h files.
4274 }
4275 }
4277 # check for new externs in .c files.
4280 {
4287 }
4290 {
4293 }
4298 }
4302 {
4305 }
4307 # checks for new __setup's
4314 }
4315 }
4317 # check for pointless casting of kmalloc return
4320 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
4321 }
4323 # alloc style
4324 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4326 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4329 }
4331 # check for krealloc arg reuse
4336 }
4338 # check for alloc argument mismatch
4342 }
4344 # check for multiple semicolons
4350 }
4351 }
4353 # check for case / default statements not preceeded by break/fallthrough/switch
4371 }
4375 }
4376 }
4378 # check for switch/default statements without a break;
4387 }
4390 }
4392 # check for gcc specific __FUNCTION__
4398 }
4399 }
4401 # check for use of yield()
4405 }
4407 # check for comparisons against true and false
4423 }
4428 ## maybe suggesting a correct construct would better
4429 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4431 }
4432 }
4434 # check for semaphores initialized locked
4438 }
4440 # recommend kstrto* over simple_strto* and strict_strto*
4444 }
4446 # check for __initcall(), use device_initcall() explicitly please
4450 }
4452 # check for various ops structs, ensure they are const.
4454 address_space_operations|
4455 backlight_ops|
4456 block_device_operations|
4457 dentry_operations|
4458 dev_pm_ops|
4459 dma_map_ops|
4460 extent_io_ops|
4461 file_lock_operations|
4462 file_operations|
4463 hv_ops|
4464 ide_dma_ops|
4465 intel_dvo_dev_ops|
4466 item_operations|
4467 iwl_ops|
4468 kgdb_arch|
4469 kgdb_io|
4470 kset_uevent_ops|
4471 lock_manager_operations|
4472 microcode_ops|
4473 mtrr_ops|
4474 neigh_ops|
4475 nlmsvc_binding|
4476 pci_raw_ops|
4477 pipe_buf_operations|
4478 platform_hibernation_ops|
4479 platform_suspend_ops|
4480 proto_ops|
4481 rpc_pipe_ops|
4482 seq_operations|
4483 snd_ac97_build_ops|
4484 soc_pcmcia_socket_ops|
4485 stacktrace_ops|
4486 sysfs_ops|
4487 tty_operations|
4488 usb_mon_operations|
4495 }
4497 # use of NR_CPUS is usually wrong
4498 # ignore definitions of NR_CPUS and usage to define arrays as likely right
4505 {
4507 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
4508 }
4510 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4514 }
4516 # check for %L{u,d,i} in strings
4525 }
4526 }
4528 # whine mightly about in_atomic
4536 }
4537 }
4539 # check for lockdep_set_novalidate_class
4547 }
4548 }
4553 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
4554 }
4556 # Mode permission misuses where it seems decimal should be octal
4557 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
4568 }
4579 }
4580 }
4581 }
4582 }
4583 }
4585 # If we have no input at all, then there is nothing to report on
4586 # so just keep quiet.
4589 }
4591 # In mailback mode only produce a report in the negative, for
4592 # things that appear to be patches.
4595 }
4597 # This is not a patch, and we are are in 'no-patch' mode so
4598 # just keep quiet.
4601 }
4606 }
4610 }
4619 }
4626 }
4628 # If there were whitespace errors which cleanpatch can fix
4629 # then suggest that.
4634 }
4635 }
4654 }
4657 }
4658 }
4665 Do _NOT_ trust the results written to this file.
4668 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4671 EOM
4672 }
4673 }
4677 }
4682 If any of these errors are false positives, please report
4684 EOM
4685 }
4688 }