| blob | 374abf44363615004537cb895d3b55bc410ae99b |
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
57 Options:
62 --emacs emacs compile window format
63 --terse one line per report
77 is all off)
79 literally
82 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
83 with potential errors corrected to the preferred
84 checkpatch style
89 runtime errors.
93 EOM
96 }
118 }
119 }
122 }
124 GetOptions(
163 }
164 }
169 }
185 }
186 }
195 }
197 }
198 }
208 ## no critic
211 }
218 }
224 }
231 }
232 }
237 }
238 }
248 __user|
249 __kernel|
250 __force|
251 __iomem|
252 __must_check|
253 __init_refok|
254 __kprobes|
255 __ref|
256 __rcu
264 # Notes to $Attribute:
265 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
267 const|
268 __percpu|
269 __nocast|
270 __safe|
271 __bitwise__|
272 __packed__|
273 __packed2__|
274 __naked|
275 __maybe_unused|
276 __always_unused|
277 __noreturn|
278 __used|
279 __cold|
280 __noclone|
281 __deprecated|
282 __read_mostly|
283 __kprobes|
285 ____cacheline_aligned|
286 ____cacheline_aligned_in_smp|
287 ____cacheline_internodealigned_in_smp|
288 __weak
309 <=|>=|==|!=|
310 =>|->|<<|>>|<|>|!|~|
341 atomic_t
342 )};
346 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
348 panic|
351 )};
360 To:|
361 Cc:
362 )};
381 );
404 );
409 );
413 );
419 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
422 );
424 #Create a search pattern for all these functions to speed up a loop below
429 }
432 irq|
433 memory|
435 reboot
436 )};
437 # memory.h: ARM has a custom one
439 # Load common spelling mistakes and build regular expression list.
458 }
474 )
481 )
490 )
494 $NonptrType
499 $NonptrTypeMisordered
505 }
506 build_types();
510 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
511 # requires at least perl version v5.10.0
512 # Any use must be runtime checked with $^V
522 )};
531 }
536 }
560 }
561 }
562 }
586 }
588 }
596 }
600 }
605 }
609 }
617 }
619 }
620 }
632 # Maybe one day convert this block of bash into something that returns
633 # all matching commit ids, but it's very slow...
634 #
635 # echo "checking commits $1..."
636 # git rev-list --remotes | grep -i "^$1" |
637 # while read line ; do
638 # git log --format='%H %s' -1 $line |
639 # echo "commit $(cut -c 1-12,41-)"
640 # done
641 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
645 }
648 }
670 }
675 }
679 }
683 }
690 }
701 );
706 }
707 }
709 }
732 # If there's a name left after stripping spaces and
733 # leading quotes, and the address doesn't have both
734 # leading and trailing angle brackets, the address
735 # is invalid. ie:
736 # "joe smith joe@smith.com" bad
737 # "joe smith <joe@smith.com" bad
742 }
743 }
753 }
756 }
770 }
776 }
779 }
787 }
788 }
791 }
799 }
800 }
803 }
816 }
818 }
821 }
824 }
828 }
833 # Drop the diff line leader and expand tabs
837 # Pick the indent from the front of the line.
841 }
852 }
853 }
864 # Always copy over the diff marker.
870 # Comments we are wacking completly including the begin
871 # and end, all to $;.
878 }
884 }
891 }
893 # A \ in a string means ignore the next character.
899 }
900 # Regular quotes.
909 }
910 }
912 #print "c<$c> SQ<$sanitise_quote>\n";
921 }
922 }
926 }
928 # The pathname on a #include may be surrounded by '<' and '>'.
933 # The whole of a #error is a string.
937 }
940 }
947 }
970 #warn "CSB: blk<$blk> remain<$remain>\n";
971 # If we are about to drop off the end, pull in more
972 # context.
983 }
984 # Bail if there is no further context.
985 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
988 }
992 }
993 }
998 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1000 # Handle nested #if/#else.
1007 }
1009 # Statement ends at the ';' or a close '}' at the
1010 # outermost level.
1013 }
1015 # An else is really a conditional as long as its not else if
1022 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1023 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1024 }
1029 }
1037 #warn "CSB: mark coff<$coff>\n";
1038 }
1039 }
1043 }
1051 }
1053 }
1054 }
1055 # Preprocessor commands end at the newline unless escaped.
1061 }
1063 }
1064 # We are truly at the end, so shuffle to the next line.
1069 }
1074 #warn "STATEMENT<$statement>\n";
1075 #warn "CONDITION<$condition>\n";
1077 #print "coff<$coff> soff<$off> loff<$loff>\n";
1081 }
1086 # Strip the diff line prefixes and rip blank lines at start and end.
1094 }
1102 }
1123 }
1124 }
1132 # Grab the first conditional/block pair.
1135 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1139 }
1141 # Pull in the following conditional/block pairs and see if they
1142 # could continue the statement.
1146 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1148 #print "C: push\n";
1150 }
1153 }
1172 # Handle nested #if/#else.
1179 }
1182 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1186 }
1193 }
1194 }
1198 }
1201 }
1204 }
1210 }
1216 }
1222 }
1227 }
1232 }
1237 # Catch a comment on the end of the line itself.
1241 # Look through the context and try and figure out if there is a
1242 # comment.
1247 #warn " $line\n";
1250 }
1253 }
1256 }
1260 }
1261 }
1265 }
1270 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1271 ##print "CMMT: $cmt\n";
1274 }
1287 }
1290 }
1302 }
1303 }
1307 }
1319 }
1339 }
1360 }
1389 # Assume all arms of the conditional end as this
1390 # one does, and continue as if the #endif was not here.
1407 }
1438 }
1450 }
1483 }
1498 }
1507 }
1511 }
1515 }
1516 }
1519 }
1528 DEFINE_\S+
1529 )$|
1533 case|
1537 \#|
1538 \#\#|
1544 # Check for modifiers.
1555 }
1556 }
1561 }
1562 build_types();
1565 }
1566 }
1576 }
1584 }
1590 }
1596 }
1600 }
1611 }
1612 }
1639 }
1645 }
1652 }
1657 }
1660 }
1663 }
1671 };
1673 }
1681 };
1684 }
1693 }
1695 }
1703 }
1705 }
1713 }
1715 }
1721 ##print "absolute<$absolute>\n";
1723 # See if any suffix of this path is a path within the tree.
1726 ##print "file<$file>\n";
1728 }
1729 }
1732 }
1734 # It is, so see if the prefix is acceptable.
1738 ##print "prefix<$prefix>\n";
1742 }
1743 }
1751 }
1759 }
1767 }
1775 }
1784 #convert leading spaces to tabs
1786 #Remove spaces before a tab
1790 }
1804 }
1816 }
1817 }
1820 }
1853 # Trace the real file/line as we go.
1865 # suppression flags
1873 # Pre-scan the patch sanitizing the lines.
1874 # Pre-scan the patch looking for any __setup documentation.
1875 #
1881 sanitise_line_reset();
1893 }
1894 #next;
1895 }
1902 }
1905 # Guestimate if this is a continuing comment. Run
1906 # the context looking for a comment "edge". If this
1907 # edge is a close comment then we must be in a comment
1908 # at context start.
1915 #print "RAW<$rawlines[$ln - 1]>\n";
1921 }
1922 }
1925 }
1927 # Guestimate if this is a continuing comment. If this
1928 # is the start of a diff block and this line starts
1929 # ' *' then it is very likely a comment.
1932 {
1934 }
1936 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1940 # Standardise the strings and chars within the input to
1941 # simplify matching -- only bother with positive lines.
1943 }
1950 }
1952 #print "==>$rawline\n";
1953 #print "-->$line\n";
1957 }
1958 }
1973 #extract the line range in the file after the patch is applied
1982 }
1983 annotate_reset();
1992 # track the line number as we move through the hunk, note that
1993 # new versions of GNU diff omit the leading space on completely
1994 # blank context lines so we need to count that too.
1999 # Measure the line length and indent.
2002 # Track the previous line.
2007 #warn "line<$line>\n";
2011 }
2015 #make up the handle for any error we report on this line
2023 # extract the filename as it passes
2039 }
2043 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2044 }
2046 }
2053 }
2055 }
2065 # Check for incorrect file permissions
2072 }
2073 }
2075 # Check the patch for a signoff:
2079 }
2081 # Check signature styles
2093 }
2100 }
2101 }
2108 }
2110 }
2117 }
2118 }
2129 # Don't force email to have quotes
2130 # Allow just an angle bracketed address
2136 }
2137 }
2139 # Check for duplicate signatures
2148 }
2149 }
2151 # Check for old stable address
2155 }
2157 # Check for unwanted Gerrit info
2161 }
2163 # Check for improperly formed commit descriptions
2177 "Please use 12 or more chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
2178 }
2180 # Check for added, moved or deleted files
2189 }
2191 # Check for wrappage within a valid hunk of the file
2196 }
2198 # Check for absolute kernel paths.
2205 #
2208 }
2209 }
2210 }
2212 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2223 }
2225 # Check if it's the start of a commit log
2226 # (not a header line and we haven't seen the patch filename)
2232 }
2234 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2235 # declined it, i.e defined some charset where it is missing.
2240 }
2246 }
2248 # Check for various typo / spelling mistakes
2261 }
2262 }
2263 }
2265 # ignore non-hunk lines and lines being removed
2268 #trailing whitespace
2275 }
2282 }
2285 }
2287 # Check for FSF mailing addresses.
2295 "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)
2296 }
2298 # check for Kconfig help text having a real description
2299 # Only applies when adding the entry originally, after that we do not have
2300 # sufficient context to determine whether it is indeed long enough.
2321 }
2330 }
2332 }
2336 }
2337 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2338 }
2340 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2344 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2345 }
2355 };
2358 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2359 }
2361 # check for DT compatible documentation
2380 }
2387 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2388 }
2389 }
2390 }
2392 # check we are in a valid source file if not then ignore this hunk
2395 #line length limit
2398 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2401 {
2404 }
2406 # Check for user-visible strings broken across lines, which breaks the ability
2407 # to grep for the string. Make exceptions when the previous string ends in a
2408 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2409 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
2415 }
2417 # check for missing a space in a string concatination
2421 }
2423 # check for spaces before a quoted newline
2429 }
2431 }
2433 # check for adding lines without a newline.
2434 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2437 }
2439 # Blackfin: use hi/lo macros
2445 }
2450 }
2451 }
2453 # check we are in a valid source file C or perl if not then ignore this hunk
2456 # at the beginning of a line any tabs must come first and anything
2457 # more than 8 must use tabs.
2466 }
2467 }
2469 # check for space before tabs.
2479 }
2480 }
2482 # check for && or || at the start of a line
2486 }
2488 # check multi-line statement indentation matches previous line
2490 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2513 }
2514 }
2515 }
2516 }
2524 }
2525 }
2533 }
2542 }
2551 }
2553 # check for missing blank lines after struct/union declarations
2554 # with exceptions for various attributes and macros
2569 }
2570 }
2572 # check for multiple consecutive blank lines
2580 }
2583 }
2585 # check for missing blank lines after declarations
2587 # actual declarations
2589 # function pointer declarations
2591 # foo bar; where foo is some local typedef or #define
2593 # known declaration macros
2595 # for "else if" which can look like "$Ident $Ident"
2597 # other possible extensions of declaration lines
2599 # not starting a section or a macro "\" extended line
2601 # looks like a declaration
2603 # function pointer declarations
2605 # foo bar; where foo is some local typedef or #define
2607 # known declaration macros
2609 # start of struct or union or enum
2611 # start or end of block or continuation of declaration
2613 # bitfield continuation
2615 # other possible extensions of declaration lines
2617 # indentation of previous and current line are the same
2623 }
2624 }
2626 # check for spaces at the beginning of a line.
2627 # Exceptions:
2628 # 1) within comments
2629 # 2) indented preprocessor commands
2630 # 3) hanging labels
2637 }
2638 }
2640 # check we are in a valid C source file if not then ignore this hunk
2643 # check indentation of any line with a bare else
2644 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2645 # if the previous line is a break or return and is indented 1 tab more...
2654 }
2655 }
2657 # check indentation of a line with a break;
2658 # if the previous line is a goto or return and is indented the same # of tabs
2664 }
2665 }
2667 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2670 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2671 }
2673 # check for RCS/CVS revision markers
2677 }
2679 # Blackfin: don't use __builtin_bfin_[cs]sync
2684 }
2689 }
2691 # check for old HOTPLUG __dev<foo> section markings
2695 }
2697 # Check for potential 'bare' types
2700 #print "LINE<$line>\n";
2708 #print "linenr<$linenr> <$stat>\n";
2709 # If this statement has no statement boundaries within
2710 # it there is no point in retrying a statement scan
2711 # until we hit end of it.
2714 #print "skip<$line_nr_next>\n";
2716 }
2718 # Find the real next line.
2724 }
2729 # Ignore goto labels.
2732 # Ignore functions being called
2737 # declarations always start with types
2738 } 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) {
2743 # definitions in global scope can only start with types
2746 }
2748 # any (foo ... *) is a pointer cast, and foo is a type
2751 }
2753 # Check for any sort of function declaration.
2754 # int foo(something bar, other baz);
2755 # void (*store_gdt)(x86_descr_ptr *);
2756 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2764 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2767 }
2768 }
2769 }
2771 }
2773 #
2774 # Checks which may be anchored in the context.
2775 #
2777 # Check for switch () and associated case and default
2778 # statements should be at the same indent.
2792 }
2793 }
2797 }
2798 }
2800 # if/while/etc brace do not go on next line, unless defining a do while loop,
2801 # or if that brace on the next line is for something else
2802 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2810 }
2821 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2824 }
2826 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2827 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2833 }
2837 {
2843 }
2844 }
2845 }
2847 # Check relative indent for conditionals and blocks.
2848 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2856 # Make sure we remove the line prefixes as we have
2857 # none on the first line, and are going to readd them
2858 # where necessary.
2861 # Find out how long the conditional actually is.
2865 # We want to check the first line inside the block
2866 # starting at the end of the conditional, so remove:
2867 # 1) any blank line termination
2868 # 2) any opening brace { on end of the line
2869 # 3) any do (...) {
2876 }
2880 }
2882 # Also ignore a loop construct at the end of a
2883 # preprocessor statement.
2887 }
2894 # If we see an #else/#elif then the code
2895 # is not linear.
2898 }
2900 # Ignore:
2901 # 1) blank lines, they should be at 0,
2902 # 2) preprocessor lines, and
2903 # 3) labels.
2911 }
2912 }
2913 }
2918 # Check if either of these lines are modified, else
2919 # this is not this patch's fault.
2923 }
2926 }
2928 #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";
2933 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2934 }
2935 }
2937 # Track the 'values' across context and added lines.
2947 }
2950 #ignore lines not being added
2953 # TEST: allow direct testing of the type matcher.
2961 }
2963 }
2964 # TEST: allow direct testing of the attribute matcher.
2972 }
2974 }
2976 # check for initialisation to aggregates open brace on the next line
2990 }
2991 }
2993 #
2994 # Checks which are anchored on the added line.
2995 #
2997 # check for malformed paths in #include statements (uses RAW line)
3003 }
3007 }
3008 }
3010 # no C99 // comments
3019 }
3020 }
3021 }
3022 # Remove C99 comments.
3026 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3027 # the whole statement.
3028 #print "APW <$lines[$realline_next - 1]>\n";
3034 # Handle definitions which produce identifiers with
3035 # a prefix:
3036 # XXX(foo);
3037 # EXPORT_SYMBOL(something_foo);
3041 #print "FOO C name<$name>\n";
3052 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3056 }
3057 }
3062 #print "FOO B <$lines[$linenr - 1]>\n";
3064 }
3069 }
3071 # check for global initialisers.
3078 }
3079 }
3080 # check for static initialisers.
3087 }
3088 }
3090 # check for misordered declarations of char/short/int/long with signed/unsigned
3094 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3095 }
3097 # check for static const char * arrays.
3102 }
3104 # check for static char foo[] = "bar" declarations.
3109 }
3111 # check for non-global char *foo[] = {"bar", ...} declarations.
3116 }
3118 # check for function declarations without arguments like "int foo()"
3124 }
3125 }
3127 # check for uses of DEFINE_PCI_DEVICE_TABLE
3132 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3133 }
3134 }
3136 # check for new typedefs, only function parameters and sparse annotations
3137 # make sense.
3145 }
3147 # * goes on variable not on type
3148 # (char*[ const])
3150 #print "AA<$1>\n";
3153 # Should start with a space.
3155 # Should not end with a space.
3157 # '*'s should not have spaces between.
3159 }
3161 ## print "1: from<$from> to<$to> ident<$ident>\n";
3171 }
3172 }
3173 }
3175 #print "BB<$1>\n";
3178 # Should start with a space.
3180 # Should not end with a space.
3182 # '*'s should not have spaces between.
3184 }
3185 # Modifiers should have spaces.
3188 ## print "2: from<$from> to<$to> ident<$ident>\n";
3199 }
3200 }
3201 }
3203 # # no BUG() or BUG_ON()
3204 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
3205 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3206 # print "$herecurr";
3207 # $clean = 0;
3208 # }
3212 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3213 }
3215 # check for uses of printk_ratelimit
3219 }
3221 # printk should use KERN_* levels. Note that follow on printk's on the
3222 # same line do not need a level, so we use the current block context
3223 # to try and find and validate the current printk. In summary the current
3224 # printk includes all preceding printk's which have no newline on the end.
3225 # we assume the first bad printk is the one to report.
3229 #print "CHECK<$lines[$ln - 1]\n";
3230 # we have a preceding printk if it ends
3231 # with "\n" ignore it, else it is to blame
3235 }
3237 }
3238 }
3242 }
3243 }
3252 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3253 }
3261 }
3262 }
3271 }
3273 # function brace can't be on same line, except for #defines of do while,
3274 # or if closed on same line
3289 }
3290 }
3291 }
3293 # open braces for enum, union and struct go on the same line.
3307 }
3308 }
3309 }
3311 # missing space after union, struct or enum definition
3318 }
3319 }
3321 # Function pointer declarations
3322 # check spacing between type, funcptr, and args
3323 # canonical declaration is "type (*funcptr)(args...)"
3332 # the $Declare variable will capture all spaces after the type
3333 # so check it for a missing trailing missing space but pointer return types
3334 # don't need a space so don't warn for those.
3339 }
3344 }
3346 # unnecessary space "type (*funcptr)(args...)"
3347 # This test is not currently implemented because these declarations are
3348 # equivalent to
3349 # int foo(int bar, ...)
3350 # and this is form shouldn't/doesn't generate a checkpatch warning.
3351 #
3352 # elsif ($declare =~ /\s{2,}$/) {
3353 # WARN("SPACING",
3354 # "Multiple spaces after return type\n" . $herecurr);
3355 # }
3357 # unnecessary space "type ( *funcptr)(args...)"
3362 }
3364 # unnecessary space "type (* funcptr)(args...)"
3369 }
3371 # unnecessary space "type (*funcptr )(args...)"
3376 }
3378 # unnecessary space "type (*funcptr) (args...)"
3383 }
3387 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3388 }
3389 }
3391 # check for spacing round square brackets; allowed:
3392 # 1. with a type on the left -- int [] a;
3393 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3394 # 3. inside a curly brace -- = { [0...10] = 5 }
3405 }
3406 }
3407 }
3409 # check for spaces between functions and their parentheses.
3415 # Ignore those directives where spaces _are_ permitted.
3421 {
3422 # cpp #define statements have non-optional spaces, ie
3423 # if there is a space between the name and the open
3424 # parenthesis it is simply not a parameter group.
3427 # cpp #elif statement condition may start with a (
3430 # If this whole things ends with a type its most
3431 # likely a typedef for a function.
3440 }
3441 }
3442 }
3444 # Check operator spacing.
3450 <<=|>>=|<=|>=|==|!=|
3452 =>|->|<<|>>|<|>|=|!|~|
3458 ## print("element count: <" . $#elements . ">\n");
3459 ## foreach my $el (@elements) {
3460 ## print("el: <$el>\n");
3461 ## }
3469 }
3480 ## print("n: <$n> good: <$good>\n");
3484 # Pick up the preceding and succeeding characters.
3489 }
3512 }
3521 # Pull out the value of this operator.
3524 # Get the full operator variant.
3527 # Ignore operators passed as parameters.
3531 # # Ignore comments
3532 # } elsif ($op =~ /^$;+$/) {
3534 # ; should have either the end of line or a space or \ after it
3542 }
3543 }
3545 # // is a comment
3548 # : when part of a bitfield
3550 # skip the bitfield test for now
3552 # No spaces for:
3553 # ->
3561 }
3563 }
3564 }
3566 # , must have a space on the right.
3574 }
3575 }
3577 # '*' as part of a type definition -- reported already.
3579 #warn "'*' is part of type\n";
3581 # unary operators should have a space before and
3582 # none after. May be left adjacent to another
3583 # unary operator, or a cast
3593 }
3594 }
3595 }
3597 # A unary '*' may be const
3605 }
3607 }
3608 }
3610 # unary ++ and unary -- are allowed no space on one side.
3617 }
3618 }
3625 }
3626 }
3633 }
3635 }
3636 }
3638 # << and >> may either have or not have spaces both sides
3644 {
3651 }
3653 }
3654 }
3656 # A colon needs no spaces before when it is
3657 # terminating a case value or a label.
3664 }
3665 }
3667 # All the others need spaces both sides.
3671 # Ignore email addresses <foo@bar>
3676 {
3678 }
3680 # messages are ERROR, but ?: are CHK
3690 }
3692 }
3693 }
3694 }
3697 ## print("n: <$n> GOOD: <$good>\n");
3700 }
3704 }
3708 }
3711 }
3713 # check for whitespace before a non-naked semicolon
3720 }
3721 }
3723 # check for multiple assignments
3727 }
3729 ## # check for multiple declarations, allowing for a function declaration
3730 ## # continuation.
3731 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3732 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3733 ##
3734 ## # Remove any bracketed sections to ensure we do not
3735 ## # falsly report the parameters of functions.
3736 ## my $ln = $line;
3737 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3738 ## }
3739 ## if ($ln =~ /,/) {
3740 ## WARN("MULTIPLE_DECLARATION",
3741 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3742 ## }
3743 ## }
3745 #need space before brace following if, while, etc
3752 }
3753 }
3755 ## # check for blank lines before declarations
3756 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3757 ## $prevrawline =~ /^.\s*$/) {
3758 ## WARN("SPACING",
3759 ## "No blank lines before declarations\n" . $hereprev);
3760 ## }
3761 ##
3763 # closing brace should have a space following it when it has anything
3764 # on the line
3771 }
3772 }
3774 # check spacing on square brackets
3781 }
3782 }
3789 }
3790 }
3792 # check spacing on parentheses
3800 }
3801 }
3810 }
3811 }
3813 # check unnecessary parentheses around addressof/dereference single $Lvals
3814 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3819 }
3821 #goto labels aren't indented, allow a single space however
3829 }
3830 }
3832 # return is not a function
3842 }
3846 }
3847 }
3849 # unnecessary return in a void function
3850 # at end-of-function, with the previous line a single leading tab, then return;
3851 # and the line before that not a goto label target like "out:"
3859 }
3861 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3867 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3872 }
3873 }
3875 # Return of what appears to be an errno should normally be -'ve
3881 }
3882 }
3884 # Need a space before open parenthesis after if, while etc
3891 }
3892 }
3894 # Check for illegal assignment in if conditional -- and check for trailing
3895 # statements after the conditional.
3903 ##print "stat<$stat> stat_next<$stat_next>\n";
3906 # If the statement carries leading newlines,
3907 # then count those as offsets.
3915 }
3916 }
3925 }
3927 # Find out what is on the end of the line after the
3928 # conditional.
3934 {
3935 # Find out how long the conditional actually is.
3944 }
3948 }
3949 }
3951 # Check for bitwise tests written as boolean
3957 |
3962 {
3965 }
3967 # if and else should not have general statements after it
3974 }
3975 }
3976 # if should not continue a brace
3981 }
3982 # case and default should not have general statements after them
3988 {
3991 }
3993 # Check for }<nl>else {, these must be at the same
3994 # indent level to be relevant to each other.
4006 }
4010 }
4011 }
4017 # Find out what is on the end of the line after the
4018 # conditional.
4034 }
4035 }
4036 }
4038 #Specific variable tests
4042 #gcc binary extension
4050 }
4051 }
4053 #CamelCase
4056 #Ignore Page<foo> variants
4058 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4064 seed_camelcase_includes();
4068 }
4069 }
4074 }
4075 }
4076 }
4077 }
4079 #no spaces allowed after \ in define
4085 }
4086 }
4088 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
4095 {
4102 }
4103 }
4104 }
4106 # multi-statement macros should be enclosed in a do while loop, grab the
4107 # first statement and ensure its the whole macro if its not enclosed
4108 # in a known good container
4120 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4121 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4132 # Flatten any parentheses and braces
4136 {
4137 }
4139 # Flatten any obvious string concatentation.
4142 {
4143 }
4147 module_param_named|
4148 MODULE_PARM_DESC|
4149 DECLARE_PER_CPU|
4150 DEFINE_PER_CPU|
4151 __typeof__\(|
4152 union|
4153 struct|
4157 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4161 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4166 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4172 {
4179 }
4187 }
4188 }
4190 # check for macros with flow control, but without ## concatenation
4191 # ## concatenation is commonly a macro that defines a function so ignore those
4198 }
4201 }
4203 # check for line continuations outside of #defines, preprocessor #, and asm
4212 }
4213 }
4215 # do {} while (0) macro tests:
4216 # single-statement macros do not need to be enclosed in do while (0) loop,
4217 # macro should not end with a semicolon
4231 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4241 }
4247 }
4251 }
4259 }
4263 }
4264 }
4266 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4267 # all assignments may have only one of the following with an assignment:
4268 # .
4269 # ALIGN(...)
4270 # VMLINUX_SYMBOL(...)
4274 }
4276 # check for redundant bracing round if etc
4280 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4281 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4291 # If the condition carries leading newlines, then count those as offsets.
4296 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4298 # We have looked at and allowed this specific line.
4308 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4310 #print "APW: ALLOWED: cond<$cond>\n";
4312 }
4314 #print "APW: ALLOWED: block<$block>\n";
4316 }
4318 #print "APW: ALLOWED: lines block<$block>\n";
4320 }
4322 }
4327 }
4335 }
4336 }
4337 }
4338 }
4343 # Check the pre-context.
4345 #print "APW: ALLOWED: pre<$1>\n";
4347 }
4352 # Check the condition.
4354 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4357 }
4359 #print "APW: ALLOWED: cond<$cond>\n";
4361 }
4363 #print "APW: ALLOWED: block<$block>\n";
4365 }
4367 #print "APW: ALLOWED: lines block<$block>\n";
4369 }
4370 # Check the post-context.
4375 }
4377 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4379 }
4380 }
4387 }
4391 }
4392 }
4394 # check for unnecessary blank lines around braces
4398 }
4402 }
4404 # no volatiles please
4408 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4409 }
4411 # concatenated string without spaces between elements
4415 }
4417 # warn about #if 0
4422 }
4424 # check for needless "if (<foo>) fn(<foo>)" uses
4430 }
4431 }
4433 # check for unnecessary "Out of Memory" messages
4442 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4444 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4447 }
4448 }
4450 # check for logging functions with KERN_<LEVEL>
4458 }
4459 }
4461 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4464 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4474 $fixed[$fixlinenr] =~ 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;
4475 }
4476 }
4477 }
4479 # check for $InitAttributeData (ie: __initdata) with const
4490 }
4491 }
4493 # check for $InitAttributeConst (ie: __initconst) without const
4505 }
4506 }
4508 # don't use __constant_<foo> functions outside of include/uapi/
4510 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4518 }
4519 }
4521 # prefer usleep_range over udelay
4524 # ignore udelay's < 10, however
4527 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4528 }
4532 }
4533 }
4535 # warn about unexpectedly long msleep's
4539 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4540 }
4541 }
4543 # check for comparisons of jiffies
4546 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4547 }
4549 # check for comparisons of get_jiffies_64()
4552 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4553 }
4555 # warn about #ifdefs in C files
4556 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4557 # print "#ifdef in C files should be avoided\n";
4558 # print "$herecurr";
4559 # $clean = 0;
4560 # }
4562 # warn about spacing in #ifdefs
4569 }
4571 }
4573 # check for spinlock_t definitions without a comment.
4580 }
4581 }
4582 # check for memory barriers without a comment.
4583 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4587 }
4588 }
4589 # check of hardware specific defines
4590 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4593 }
4595 # Check that the storage class is at the beginning of a declaration
4599 }
4601 # check the location of the inline attribute, that it is between
4602 # storage class and type.
4607 }
4609 # Check for __inline__ and __inline, prefer inline
4617 }
4618 }
4620 # Check for __attribute__ packed, prefer __packed
4625 }
4627 # Check for __attribute__ aligned, prefer __aligned
4632 }
4634 # Check for __attribute__ format(printf, prefer __printf
4638 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4640 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4642 }
4643 }
4645 # Check for __attribute__ format(scanf, prefer __scanf
4649 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4651 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4652 }
4653 }
4655 # check for sizeof(&)
4659 }
4661 # check for sizeof without parenthesis
4666 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4667 }
4668 }
4670 # check for line continuations in quoted strings with odd counts of "
4674 }
4676 # check for struct spinlock declarations
4680 }
4682 # check for seq_printf uses that could be seq_puts
4690 }
4691 }
4692 }
4694 # Check for misused memsets
4709 }
4710 }
4712 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4716 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4718 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4719 }
4720 }
4722 # typecasts on min/max could be min_t/max_t
4740 }
4743 }
4744 }
4746 # check usleep_range arguments
4754 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4758 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4759 }
4760 }
4762 # check for naked sscanf
4774 }
4777 }
4779 # check for simple sscanf that should be kstrto<foo>
4788 }
4796 }
4797 }
4798 }
4800 # check for new externs in .h files.
4807 }
4808 }
4810 # check for new externs in .c files.
4813 {
4820 }
4823 {
4826 }
4831 }
4835 {
4838 }
4840 # checks for new __setup's
4847 }
4848 }
4850 # check for pointless casting of kmalloc return
4853 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
4854 }
4856 # alloc style
4857 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4859 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4862 }
4864 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4866 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
4877 }
4883 $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
4885 }
4886 }
4887 }
4889 # check for krealloc arg reuse
4894 }
4896 # check for alloc argument mismatch
4900 }
4902 # check for multiple semicolons
4908 }
4909 }
4911 # check for case / default statements not preceded by break/fallthrough/switch
4929 }
4933 }
4934 }
4936 # check for switch/default statements without a break;
4945 }
4948 }
4950 # check for gcc specific __FUNCTION__
4956 }
4957 }
4959 # check for use of yield()
4963 }
4965 # check for comparisons against true and false
4981 }
4986 ## maybe suggesting a correct construct would better
4987 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4989 }
4990 }
4992 # check for semaphores initialized locked
4996 }
4998 # recommend kstrto* over simple_strto* and strict_strto*
5002 }
5004 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5007 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5008 }
5010 # check for various ops structs, ensure they are const.
5012 address_space_operations|
5013 backlight_ops|
5014 block_device_operations|
5015 dentry_operations|
5016 dev_pm_ops|
5017 dma_map_ops|
5018 extent_io_ops|
5019 file_lock_operations|
5020 file_operations|
5021 hv_ops|
5022 ide_dma_ops|
5023 intel_dvo_dev_ops|
5024 item_operations|
5025 iwl_ops|
5026 kgdb_arch|
5027 kgdb_io|
5028 kset_uevent_ops|
5029 lock_manager_operations|
5030 microcode_ops|
5031 mtrr_ops|
5032 neigh_ops|
5033 nlmsvc_binding|
5034 pci_raw_ops|
5035 pipe_buf_operations|
5036 platform_hibernation_ops|
5037 platform_suspend_ops|
5038 proto_ops|
5039 rpc_pipe_ops|
5040 seq_operations|
5041 snd_ac97_build_ops|
5042 soc_pcmcia_socket_ops|
5043 stacktrace_ops|
5044 sysfs_ops|
5045 tty_operations|
5046 usb_mon_operations|
5053 }
5055 # use of NR_CPUS is usually wrong
5056 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5063 {
5065 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5066 }
5068 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5072 }
5074 # check for %L{u,d,i} in strings
5083 }
5084 }
5086 # whine mightly about in_atomic
5094 }
5095 }
5097 # check for lockdep_set_novalidate_class
5105 }
5106 }
5111 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5112 }
5114 # Mode permission misuses where it seems decimal should be octal
5115 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5126 }
5137 }
5138 }
5139 }
5140 }
5141 }
5143 # If we have no input at all, then there is nothing to report on
5144 # so just keep quiet.
5147 }
5149 # In mailback mode only produce a report in the negative, for
5150 # things that appear to be patches.
5153 }
5155 # This is not a patch, and we are are in 'no-patch' mode so
5156 # just keep quiet.
5159 }
5164 }
5168 }
5177 }
5184 }
5186 # If there were whitespace errors which cleanpatch can fix
5187 # then suggest that.
5192 }
5193 }
5216 }
5219 }
5220 }
5227 Do _NOT_ trust the results written to this file.
5230 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5233 EOM
5234 }
5235 }
5239 }
5244 If any of these errors are false positives, please report
5246 EOM
5247 }
5250 }