| blob | 0ea2a1e24ade493ed22c6b817c91a07736b11563 |
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
301 <=|>=|==|!=|
302 =>|->|<<|>>|<|>|!|~|
328 atomic_t
329 )};
333 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
335 panic|
338 )};
347 To:|
348 Cc:
349 )};
370 );
375 );
379 );
382 irq|
383 memory
384 )};
385 # memory.h: ARM has a custom one
398 )
407 )
411 $NonptrType
416 }
417 build_types();
421 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
422 # requires at least perl version v5.10.0
423 # Any use must be runtime checked with $^V
436 }
460 }
461 }
462 }
486 }
488 }
496 }
500 }
505 }
509 }
517 }
519 }
520 }
538 }
543 }
547 }
551 }
555 }
566 );
571 }
572 }
574 }
597 # If there's a name left after stripping spaces and
598 # leading quotes, and the address doesn't have both
599 # leading and trailing angle brackets, the address
600 # is invalid. ie:
601 # "joe smith joe@smith.com" bad
602 # "joe smith <joe@smith.com" bad
607 }
608 }
618 }
621 }
635 }
641 }
644 }
652 }
653 }
656 }
669 }
671 }
674 }
677 }
681 }
686 # Drop the diff line leader and expand tabs
690 # Pick the indent from the front of the line.
694 }
705 }
706 }
717 # Always copy over the diff marker.
723 # Comments we are wacking completly including the begin
724 # and end, all to $;.
731 }
737 }
744 }
746 # A \ in a string means ignore the next character.
752 }
753 # Regular quotes.
762 }
763 }
765 #print "c<$c> SQ<$sanitise_quote>\n";
774 }
775 }
779 }
781 # The pathname on a #include may be surrounded by '<' and '>'.
786 # The whole of a #error is a string.
790 }
793 }
800 }
823 #warn "CSB: blk<$blk> remain<$remain>\n";
824 # If we are about to drop off the end, pull in more
825 # context.
836 }
837 # Bail if there is no further context.
838 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
841 }
845 }
846 }
851 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
853 # Handle nested #if/#else.
860 }
862 # Statement ends at the ';' or a close '}' at the
863 # outermost level.
866 }
868 # An else is really a conditional as long as its not else if
875 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
876 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
877 }
882 }
890 #warn "CSB: mark coff<$coff>\n";
891 }
892 }
896 }
904 }
906 }
907 }
908 # Preprocessor commands end at the newline unless escaped.
914 }
916 }
917 # We are truly at the end, so shuffle to the next line.
922 }
927 #warn "STATEMENT<$statement>\n";
928 #warn "CONDITION<$condition>\n";
930 #print "coff<$coff> soff<$off> loff<$loff>\n";
934 }
939 # Strip the diff line prefixes and rip blank lines at start and end.
947 }
955 }
976 }
977 }
985 # Grab the first conditional/block pair.
988 #print "F: c<$condition> s<$statement> remain<$remain>\n";
992 }
994 # Pull in the following conditional/block pairs and see if they
995 # could continue the statement.
999 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1001 #print "C: push\n";
1003 }
1006 }
1025 # Handle nested #if/#else.
1032 }
1035 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1039 }
1046 }
1047 }
1051 }
1054 }
1057 }
1063 }
1069 }
1075 }
1080 }
1085 }
1090 # Catch a comment on the end of the line itself.
1094 # Look through the context and try and figure out if there is a
1095 # comment.
1100 #warn " $line\n";
1103 }
1106 }
1109 }
1113 }
1114 }
1118 }
1123 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1124 ##print "CMMT: $cmt\n";
1127 }
1140 }
1143 }
1155 }
1156 }
1160 }
1172 }
1192 }
1213 }
1242 # Assume all arms of the conditional end as this
1243 # one does, and continue as if the #endif was not here.
1260 }
1291 }
1303 }
1336 }
1351 }
1360 }
1364 }
1368 }
1369 }
1372 }
1381 DEFINE_\S+
1382 )$|
1386 case|
1390 \#|
1391 \#\#|
1397 # Check for modifiers.
1408 }
1409 }
1414 }
1415 build_types();
1418 }
1419 }
1427 }
1433 }
1439 }
1445 }
1448 }
1455 }
1457 }
1463 }
1465 }
1471 }
1473 }
1479 ##print "absolute<$absolute>\n";
1481 # See if any suffix of this path is a path within the tree.
1484 ##print "file<$file>\n";
1486 }
1487 }
1490 }
1492 # It is, so see if the prefix is acceptable.
1496 ##print "prefix<$prefix>\n";
1500 }
1501 }
1509 }
1517 }
1525 }
1533 }
1542 #convert leading spaces to tabs
1544 #Remove spaces before a tab
1548 }
1562 }
1574 }
1575 }
1578 }
1609 # Trace the real file/line as we go.
1621 # suppression flags
1629 # Pre-scan the patch sanitizing the lines.
1630 # Pre-scan the patch looking for any __setup documentation.
1631 #
1637 sanitise_line_reset();
1649 }
1650 #next;
1651 }
1658 }
1661 # Guestimate if this is a continuing comment. Run
1662 # the context looking for a comment "edge". If this
1663 # edge is a close comment then we must be in a comment
1664 # at context start.
1671 #print "RAW<$rawlines[$ln - 1]>\n";
1677 }
1678 }
1681 }
1683 # Guestimate if this is a continuing comment. If this
1684 # is the start of a diff block and this line starts
1685 # ' *' then it is very likely a comment.
1688 {
1690 }
1692 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1696 # Standardise the strings and chars within the input to
1697 # simplify matching -- only bother with positive lines.
1699 }
1706 }
1708 #print "==>$rawline\n";
1709 #print "-->$line\n";
1713 }
1714 }
1727 #extract the line range in the file after the patch is applied
1736 }
1737 annotate_reset();
1746 # track the line number as we move through the hunk, note that
1747 # new versions of GNU diff omit the leading space on completely
1748 # blank context lines so we need to count that too.
1753 # Measure the line length and indent.
1756 # Track the previous line.
1761 #warn "line<$line>\n";
1765 }
1769 #make up the handle for any error we report on this line
1776 # extract the filename as it passes
1791 }
1795 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
1796 }
1798 }
1808 # Check for incorrect file permissions
1815 }
1816 }
1818 # Check the patch for a signoff:
1822 }
1824 # Check signature styles
1836 }
1843 }
1844 }
1851 }
1853 }
1860 }
1861 }
1872 # Don't force email to have quotes
1873 # Allow just an angle bracketed address
1879 }
1880 }
1882 # Check for duplicate signatures
1891 }
1892 }
1894 # Check for wrappage within a valid hunk of the file
1899 }
1901 # Check for absolute kernel paths.
1908 #
1911 }
1912 }
1913 }
1915 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
1926 }
1928 # Check if it's the start of a commit log
1929 # (not a header line and we haven't seen the patch filename)
1934 }
1936 # Check if there is UTF-8 in a commit log when a mail header has explicitly
1937 # declined it, i.e defined some charset where it is missing.
1942 }
1948 }
1950 # ignore non-hunk lines and lines being removed
1953 #trailing whitespace
1960 }
1967 }
1970 }
1972 # Check for FSF mailing addresses.
1980 "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)
1981 }
1983 # check for Kconfig help text having a real description
1984 # Only applies when adding the entry originally, after that we do not have
1985 # sufficient context to determine whether it is indeed long enough.
2005 }
2014 }
2016 }
2018 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2019 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2020 }
2022 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2026 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2027 }
2037 };
2040 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2041 }
2043 # check for DT compatible documentation
2056 }
2065 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vendor_path\n" . $herecurr);
2066 }
2067 }
2068 }
2070 # check we are in a valid source file if not then ignore this hunk
2073 #line length limit
2076 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2079 {
2082 }
2084 # Check for user-visible strings broken across lines, which breaks the ability
2085 # to grep for the string. Make exceptions when the previous string ends in a
2086 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2087 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
2093 }
2095 # check for spaces before a quoted newline
2101 }
2103 }
2105 # check for adding lines without a newline.
2106 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2109 }
2111 # Blackfin: use hi/lo macros
2117 }
2122 }
2123 }
2125 # check we are in a valid source file C or perl if not then ignore this hunk
2128 # at the beginning of a line any tabs must come first and anything
2129 # more than 8 must use tabs.
2138 }
2139 }
2141 # check for space before tabs.
2151 }
2152 }
2154 # check for && or || at the start of a line
2158 }
2160 # check multi-line statement indentation matches previous line
2185 }
2186 }
2187 }
2188 }
2196 }
2197 }
2204 }
2213 }
2222 }
2224 # check for spaces at the beginning of a line.
2225 # Exceptions:
2226 # 1) within comments
2227 # 2) indented preprocessor commands
2228 # 3) hanging labels
2235 }
2236 }
2238 # check we are in a valid C source file if not then ignore this hunk
2241 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2244 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2245 }
2247 # check for RCS/CVS revision markers
2251 }
2253 # Blackfin: don't use __builtin_bfin_[cs]sync
2258 }
2263 }
2265 # check for old HOTPLUG __dev<foo> section markings
2269 }
2271 # Check for potential 'bare' types
2274 #print "LINE<$line>\n";
2282 #print "linenr<$linenr> <$stat>\n";
2283 # If this statement has no statement boundaries within
2284 # it there is no point in retrying a statement scan
2285 # until we hit end of it.
2288 #print "skip<$line_nr_next>\n";
2290 }
2292 # Find the real next line.
2298 }
2303 # Ignore goto labels.
2306 # Ignore functions being called
2311 # declarations always start with types
2312 } 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) {
2317 # definitions in global scope can only start with types
2320 }
2322 # any (foo ... *) is a pointer cast, and foo is a type
2325 }
2327 # Check for any sort of function declaration.
2328 # int foo(something bar, other baz);
2329 # void (*store_gdt)(x86_descr_ptr *);
2330 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2338 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2341 }
2342 }
2343 }
2345 }
2347 #
2348 # Checks which may be anchored in the context.
2349 #
2351 # Check for switch () and associated case and default
2352 # statements should be at the same indent.
2366 }
2367 }
2371 }
2372 }
2374 # if/while/etc brace do not go on next line, unless defining a do while loop,
2375 # or if that brace on the next line is for something else
2384 }
2395 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2398 }
2400 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2401 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2407 }
2411 {
2417 }
2418 }
2419 }
2421 # Check relative indent for conditionals and blocks.
2422 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2430 # Make sure we remove the line prefixes as we have
2431 # none on the first line, and are going to readd them
2432 # where necessary.
2435 # Find out how long the conditional actually is.
2439 # We want to check the first line inside the block
2440 # starting at the end of the conditional, so remove:
2441 # 1) any blank line termination
2442 # 2) any opening brace { on end of the line
2443 # 3) any do (...) {
2450 }
2454 }
2456 # Also ignore a loop construct at the end of a
2457 # preprocessor statement.
2461 }
2468 # If we see an #else/#elif then the code
2469 # is not linear.
2472 }
2474 # Ignore:
2475 # 1) blank lines, they should be at 0,
2476 # 2) preprocessor lines, and
2477 # 3) labels.
2485 }
2486 }
2487 }
2492 # Check if either of these lines are modified, else
2493 # this is not this patch's fault.
2497 }
2500 }
2502 #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";
2507 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2508 }
2509 }
2511 # Track the 'values' across context and added lines.
2521 }
2524 #ignore lines not being added
2527 # TEST: allow direct testing of the type matcher.
2535 }
2537 }
2538 # TEST: allow direct testing of the attribute matcher.
2546 }
2548 }
2550 # check for initialisation to aggregates open brace on the next line
2555 }
2557 #
2558 # Checks which are anchored on the added line.
2559 #
2561 # check for malformed paths in #include statements (uses RAW line)
2567 }
2571 }
2572 }
2574 # no C99 // comments
2583 }
2584 }
2585 }
2586 # Remove C99 comments.
2590 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2591 # the whole statement.
2592 #print "APW <$lines[$realline_next - 1]>\n";
2598 # Handle definitions which produce identifiers with
2599 # a prefix:
2600 # XXX(foo);
2601 # EXPORT_SYMBOL(something_foo);
2605 #print "FOO C name<$name>\n";
2616 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
2620 }
2621 }
2626 #print "FOO B <$lines[$linenr - 1]>\n";
2628 }
2633 }
2635 # check for global initialisers.
2642 }
2643 }
2644 # check for static initialisers.
2651 }
2652 }
2654 # check for static const char * arrays.
2659 }
2661 # check for static char foo[] = "bar" declarations.
2666 }
2668 # check for function declarations without arguments like "int foo()"
2674 }
2675 }
2677 # check for uses of DEFINE_PCI_DEVICE_TABLE
2682 $fixed[$linenr - 1] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
2683 }
2684 }
2686 # check for new typedefs, only function parameters and sparse annotations
2687 # make sense.
2695 }
2697 # * goes on variable not on type
2698 # (char*[ const])
2700 #print "AA<$1>\n";
2703 # Should start with a space.
2705 # Should not end with a space.
2707 # '*'s should not have spaces between.
2709 }
2711 ## print "1: from<$from> to<$to> ident<$ident>\n";
2721 }
2722 }
2723 }
2725 #print "BB<$1>\n";
2728 # Should start with a space.
2730 # Should not end with a space.
2732 # '*'s should not have spaces between.
2734 }
2735 # Modifiers should have spaces.
2738 ## print "2: from<$from> to<$to> ident<$ident>\n";
2749 }
2750 }
2751 }
2753 # # no BUG() or BUG_ON()
2754 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
2755 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
2756 # print "$herecurr";
2757 # $clean = 0;
2758 # }
2762 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
2763 }
2765 # check for uses of printk_ratelimit
2769 }
2771 # printk should use KERN_* levels. Note that follow on printk's on the
2772 # same line do not need a level, so we use the current block context
2773 # to try and find and validate the current printk. In summary the current
2774 # printk includes all preceding printk's which have no newline on the end.
2775 # we assume the first bad printk is the one to report.
2779 #print "CHECK<$lines[$ln - 1]\n";
2780 # we have a preceding printk if it ends
2781 # with "\n" ignore it, else it is to blame
2785 }
2787 }
2788 }
2792 }
2793 }
2802 "Prefer netdev_$level2(netdev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
2803 }
2811 }
2812 }
2821 }
2823 # function brace can't be on same line, except for #defines of do while,
2824 # or if closed on same line
2829 }
2831 # open braces for enum, union and struct go on the same line.
2836 }
2838 # missing space after union, struct or enum definition
2845 }
2846 }
2848 # Function pointer declarations
2849 # check spacing between type, funcptr, and args
2850 # canonical declaration is "type (*funcptr)(args...)"
2851 #
2852 # the $Declare variable will capture all spaces after the type
2853 # so check it for trailing missing spaces or multiple spaces
2865 }
2867 # unnecessary space "type (*funcptr)(args...)"
2871 }
2873 # unnecessary space "type ( *funcptr)(args...)"
2878 }
2880 # unnecessary space "type (* funcptr)(args...)"
2885 }
2887 # unnecessary space "type (*funcptr )(args...)"
2892 }
2894 # unnecessary space "type (*funcptr) (args...)"
2899 }
2904 }
2905 }
2907 # check for spacing round square brackets; allowed:
2908 # 1. with a type on the left -- int [] a;
2909 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
2910 # 3. inside a curly brace -- = { [0...10] = 5 }
2921 }
2922 }
2923 }
2925 # check for spaces between functions and their parentheses.
2931 # Ignore those directives where spaces _are_ permitted.
2937 {
2938 # cpp #define statements have non-optional spaces, ie
2939 # if there is a space between the name and the open
2940 # parenthesis it is simply not a parameter group.
2943 # cpp #elif statement condition may start with a (
2946 # If this whole things ends with a type its most
2947 # likely a typedef for a function.
2956 }
2957 }
2958 }
2960 # Check operator spacing.
2966 <<=|>>=|<=|>=|==|!=|
2968 =>|->|<<|>>|<|>|=|!|~|
2974 ## print("element count: <" . $#elements . ">\n");
2975 ## foreach my $el (@elements) {
2976 ## print("el: <$el>\n");
2977 ## }
2985 }
2996 ## print("n: <$n> good: <$good>\n");
3000 # Pick up the preceding and succeeding characters.
3005 }
3028 }
3037 # Pull out the value of this operator.
3040 # Get the full operator variant.
3043 # Ignore operators passed as parameters.
3047 # # Ignore comments
3048 # } elsif ($op =~ /^$;+$/) {
3050 # ; should have either the end of line or a space or \ after it
3058 }
3059 }
3061 # // is a comment
3064 # No spaces for:
3065 # ->
3066 # : when part of a bitfield
3074 }
3076 }
3077 }
3079 # , must have a space on the right.
3087 }
3088 }
3090 # '*' as part of a type definition -- reported already.
3092 #warn "'*' is part of type\n";
3094 # unary operators should have a space before and
3095 # none after. May be left adjacent to another
3096 # unary operator, or a cast
3106 }
3107 }
3108 }
3110 # A unary '*' may be const
3118 }
3120 }
3121 }
3123 # unary ++ and unary -- are allowed no space on one side.
3130 }
3131 }
3138 }
3139 }
3146 }
3148 }
3149 }
3151 # << and >> may either have or not have spaces both sides
3157 {
3164 }
3166 }
3167 }
3169 # A colon needs no spaces before when it is
3170 # terminating a case value or a label.
3177 }
3178 }
3180 # All the others need spaces both sides.
3184 # Ignore email addresses <foo@bar>
3189 {
3191 }
3193 # messages are ERROR, but ?: are CHK
3203 }
3205 }
3206 }
3207 }
3210 ## print("n: <$n> GOOD: <$good>\n");
3213 }
3217 }
3221 }
3224 }
3226 # check for whitespace before a non-naked semicolon
3233 }
3234 }
3236 # check for multiple assignments
3240 }
3242 ## # check for multiple declarations, allowing for a function declaration
3243 ## # continuation.
3244 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3245 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3246 ##
3247 ## # Remove any bracketed sections to ensure we do not
3248 ## # falsly report the parameters of functions.
3249 ## my $ln = $line;
3250 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3251 ## }
3252 ## if ($ln =~ /,/) {
3253 ## WARN("MULTIPLE_DECLARATION",
3254 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3255 ## }
3256 ## }
3258 #need space before brace following if, while, etc
3265 }
3266 }
3268 ## # check for blank lines before declarations
3269 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3270 ## $prevrawline =~ /^.\s*$/) {
3271 ## WARN("SPACING",
3272 ## "No blank lines before declarations\n" . $hereprev);
3273 ## }
3274 ##
3276 # closing brace should have a space following it when it has anything
3277 # on the line
3284 }
3285 }
3287 # check spacing on square brackets
3294 }
3295 }
3302 }
3303 }
3305 # check spacing on parentheses
3313 }
3314 }
3323 }
3324 }
3326 #goto labels aren't indented, allow a single space however
3334 }
3335 }
3337 # Return is not a function.
3348 }
3349 }
3351 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3357 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3362 }
3363 }
3365 # Return of what appears to be an errno should normally be -'ve
3371 }
3372 }
3374 # Need a space before open parenthesis after if, while etc
3381 }
3382 }
3384 # Check for illegal assignment in if conditional -- and check for trailing
3385 # statements after the conditional.
3393 ##print "stat<$stat> stat_next<$stat_next>\n";
3396 # If the statement carries leading newlines,
3397 # then count those as offsets.
3405 }
3406 }
3415 }
3417 # Find out what is on the end of the line after the
3418 # conditional.
3424 {
3425 # Find out how long the conditional actually is.
3434 }
3438 }
3439 }
3441 # Check for bitwise tests written as boolean
3447 |
3452 {
3455 }
3457 # if and else should not have general statements after it
3464 }
3465 }
3466 # if should not continue a brace
3471 }
3472 # case and default should not have general statements after them
3478 {
3481 }
3483 # Check for }<nl>else {, these must be at the same
3484 # indent level to be relevant to each other.
3489 }
3495 # Find out what is on the end of the line after the
3496 # conditional.
3503 }
3504 }
3506 #Specific variable tests
3510 #gcc binary extension
3518 }
3519 }
3521 #CamelCase
3524 #Ignore Page<foo> variants
3526 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
3532 seed_camelcase_includes();
3536 }
3537 }
3542 }
3543 }
3544 }
3545 }
3547 #no spaces allowed after \ in define
3553 }
3554 }
3556 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
3563 {
3570 }
3571 }
3572 }
3574 # multi-statement macros should be enclosed in a do while loop, grab the
3575 # first statement and ensure its the whole macro if its not enclosed
3576 # in a known good container
3586 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
3587 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
3595 # Flatten any parentheses and braces
3599 {
3600 }
3602 # Flatten any obvious string concatentation.
3605 {
3606 }
3610 module_param_named|
3611 MODULE_PARM_DESC|
3612 DECLARE_PER_CPU|
3613 DEFINE_PER_CPU|
3614 __typeof__\(|
3615 union|
3616 struct|
3620 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
3624 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
3629 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
3635 {
3642 }
3650 }
3651 }
3653 # check for line continuations outside of #defines, preprocessor #, and asm
3662 }
3663 }
3665 # do {} while (0) macro tests:
3666 # single-statement macros do not need to be enclosed in do while (0) loop,
3667 # macro should not end with a semicolon
3681 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
3691 }
3697 }
3701 }
3702 }
3703 }
3705 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
3706 # all assignments may have only one of the following with an assignment:
3707 # .
3708 # ALIGN(...)
3709 # VMLINUX_SYMBOL(...)
3713 }
3715 # check for redundant bracing round if etc
3719 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
3720 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
3730 # If the condition carries leading newlines, then count those as offsets.
3735 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
3737 # We have looked at and allowed this specific line.
3747 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
3749 #print "APW: ALLOWED: cond<$cond>\n";
3751 }
3753 #print "APW: ALLOWED: block<$block>\n";
3755 }
3757 #print "APW: ALLOWED: lines block<$block>\n";
3759 }
3761 }
3766 }
3774 }
3775 }
3776 }
3777 }
3782 # Check the pre-context.
3784 #print "APW: ALLOWED: pre<$1>\n";
3786 }
3791 # Check the condition.
3793 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
3796 }
3798 #print "APW: ALLOWED: cond<$cond>\n";
3800 }
3802 #print "APW: ALLOWED: block<$block>\n";
3804 }
3806 #print "APW: ALLOWED: lines block<$block>\n";
3808 }
3809 # Check the post-context.
3814 }
3816 #print "APW: ALLOWED: chunk-1 block<$block>\n";
3818 }
3819 }
3826 }
3830 }
3831 }
3833 # check for unnecessary blank lines around braces
3837 }
3841 }
3843 # no volatiles please
3847 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
3848 }
3850 # warn about #if 0
3855 }
3857 # check for needless "if (<foo>) fn(<foo>)" uses
3863 }
3864 }
3866 # check for bad placement of section $InitAttribute (e.g.: __initdata)
3869 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
3879 $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;
3880 }
3881 }
3882 }
3884 # check for $InitAttributeData (ie: __initdata) with const
3895 }
3896 }
3898 # check for $InitAttributeConst (ie: __initconst) without const
3910 }
3911 }
3913 # prefer usleep_range over udelay
3915 # ignore udelay's < 10, however
3919 }
3920 }
3922 # warn about unexpectedly long msleep's
3926 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $line);
3927 }
3928 }
3930 # check for comparisons of jiffies
3933 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
3934 }
3936 # check for comparisons of get_jiffies_64()
3939 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
3940 }
3942 # warn about #ifdefs in C files
3943 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
3944 # print "#ifdef in C files should be avoided\n";
3945 # print "$herecurr";
3946 # $clean = 0;
3947 # }
3949 # warn about spacing in #ifdefs
3956 }
3958 }
3960 # check for spinlock_t definitions without a comment.
3967 }
3968 }
3969 # check for memory barriers without a comment.
3970 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
3974 }
3975 }
3976 # check of hardware specific defines
3977 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
3980 }
3982 # Check that the storage class is at the beginning of a declaration
3986 }
3988 # check the location of the inline attribute, that it is between
3989 # storage class and type.
3994 }
3996 # Check for __inline__ and __inline, prefer inline
4004 }
4005 }
4007 # Check for __attribute__ packed, prefer __packed
4012 }
4014 # Check for __attribute__ aligned, prefer __aligned
4019 }
4021 # Check for __attribute__ format(printf, prefer __printf
4025 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4027 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4029 }
4030 }
4032 # Check for __attribute__ format(scanf, prefer __scanf
4036 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4038 $fixed[$linenr - 1] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4039 }
4040 }
4042 # check for sizeof(&)
4046 }
4048 # check for sizeof without parenthesis
4053 $fixed[$linenr - 1] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4054 }
4055 }
4057 # check for line continuations in quoted strings with odd counts of "
4061 }
4063 # check for struct spinlock declarations
4067 }
4069 # check for seq_printf uses that could be seq_puts
4077 }
4078 }
4079 }
4081 # Check for misused memsets
4096 }
4097 }
4099 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4103 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4105 $fixed[$linenr - 1] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4106 }
4107 }
4109 # typecasts on min/max could be min_t/max_t
4127 }
4130 }
4131 }
4133 # check usleep_range arguments
4141 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4145 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4146 }
4147 }
4149 # check for naked sscanf
4161 }
4164 }
4166 # check for new externs in .h files.
4173 }
4174 }
4176 # check for new externs in .c files.
4179 {
4186 }
4189 {
4192 }
4197 }
4201 {
4204 }
4206 # checks for new __setup's
4213 }
4214 }
4216 # check for pointless casting of kmalloc return
4219 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
4220 }
4222 # alloc style
4223 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4225 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4228 }
4230 # check for krealloc arg reuse
4235 }
4237 # check for alloc argument mismatch
4241 }
4243 # check for GFP_NOWAIT use
4247 }
4249 # check for multiple semicolons
4255 }
4256 }
4258 # check for case / default statements not preceeded by break/fallthrough/switch
4276 }
4280 }
4281 }
4283 # check for switch/default statements without a break;
4292 }
4295 }
4297 # check for gcc specific __FUNCTION__
4303 }
4304 }
4306 # check for use of yield()
4310 }
4312 # check for comparisons against true and false
4328 }
4333 ## maybe suggesting a correct construct would better
4334 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4336 }
4337 }
4339 # check for semaphores initialized locked
4343 }
4345 # recommend kstrto* over simple_strto* and strict_strto*
4349 }
4351 # check for __initcall(), use device_initcall() explicitly please
4355 }
4357 # check for various ops structs, ensure they are const.
4359 address_space_operations|
4360 backlight_ops|
4361 block_device_operations|
4362 dentry_operations|
4363 dev_pm_ops|
4364 dma_map_ops|
4365 extent_io_ops|
4366 file_lock_operations|
4367 file_operations|
4368 hv_ops|
4369 ide_dma_ops|
4370 intel_dvo_dev_ops|
4371 item_operations|
4372 iwl_ops|
4373 kgdb_arch|
4374 kgdb_io|
4375 kset_uevent_ops|
4376 lock_manager_operations|
4377 microcode_ops|
4378 mtrr_ops|
4379 neigh_ops|
4380 nlmsvc_binding|
4381 pci_raw_ops|
4382 pipe_buf_operations|
4383 platform_hibernation_ops|
4384 platform_suspend_ops|
4385 proto_ops|
4386 rpc_pipe_ops|
4387 seq_operations|
4388 snd_ac97_build_ops|
4389 soc_pcmcia_socket_ops|
4390 stacktrace_ops|
4391 sysfs_ops|
4392 tty_operations|
4393 usb_mon_operations|
4400 }
4402 # use of NR_CPUS is usually wrong
4403 # ignore definitions of NR_CPUS and usage to define arrays as likely right
4410 {
4412 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
4413 }
4415 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4419 }
4421 # check for %L{u,d,i} in strings
4430 }
4431 }
4433 # whine mightly about in_atomic
4441 }
4442 }
4444 # check for lockdep_set_novalidate_class
4452 }
4453 }
4458 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
4459 }
4460 }
4462 # If we have no input at all, then there is nothing to report on
4463 # so just keep quiet.
4466 }
4468 # In mailback mode only produce a report in the negative, for
4469 # things that appear to be patches.
4472 }
4474 # This is not a patch, and we are are in 'no-patch' mode so
4475 # just keep quiet.
4478 }
4483 }
4487 }
4496 }
4503 }
4505 # If there were whitespace errors which cleanpatch can fix
4506 # then suggest that.
4511 }
4512 }
4531 }
4534 }
4535 }
4542 Do _NOT_ trust the results written to this file.
4545 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
4548 EOM
4549 }
4550 }
4554 }
4559 If any of these errors are false positives, please report
4561 EOM
4562 }
4565 }