| blob | 4d08b398411fdec9b6707b4cd0db2fd73f1b13fa |
1 #!/usr/bin/perl -w
2 # (c) 2001, Dave Jones. (the file handling bit)
3 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6 # Licensed under the terms of the GNU GPL License version 2
54 Options:
59 --emacs emacs compile window format
60 --terse one line per report
73 is all off)
75 literally
78 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
79 with potential errors corrected to the preferred
80 checkpatch style
85 runtime errors.
89 EOM
92 }
114 }
115 }
118 }
120 GetOptions(
158 }
159 }
164 }
180 }
181 }
190 }
192 }
193 }
203 ## no critic
206 }
213 }
219 }
226 }
227 }
232 }
233 }
243 __user|
244 __kernel|
245 __force|
246 __iomem|
247 __must_check|
248 __init_refok|
249 __kprobes|
250 __ref|
251 __rcu
259 # Notes to $Attribute:
260 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
262 const|
263 __percpu|
264 __nocast|
265 __safe|
266 __bitwise__|
267 __packed__|
268 __packed2__|
269 __naked|
270 __maybe_unused|
271 __always_unused|
272 __noreturn|
273 __used|
274 __cold|
275 __noclone|
276 __deprecated|
277 __read_mostly|
278 __kprobes|
280 ____cacheline_aligned|
281 ____cacheline_aligned_in_smp|
282 ____cacheline_internodealigned_in_smp|
283 __weak
304 <=|>=|==|!=|
305 =>|->|<<|>>|<|>|!|~|
336 atomic_t
337 )};
341 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
343 panic|
346 )};
355 To:|
356 Cc:
357 )};
376 );
399 );
404 );
408 );
414 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
417 );
419 #Create a search pattern for all these functions to speed up a loop below
424 }
427 irq|
428 memory
429 )};
430 # memory.h: ARM has a custom one
444 )
451 )
460 )
464 $NonptrType
469 $NonptrTypeMisordered
475 }
476 build_types();
480 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
481 # requires at least perl version v5.10.0
482 # Any use must be runtime checked with $^V
492 )};
501 }
506 }
530 }
531 }
532 }
556 }
558 }
566 }
570 }
575 }
579 }
587 }
589 }
590 }
602 # Maybe one day convert this block of bash into something that returns
603 # all matching commit ids, but it's very slow...
604 #
605 # echo "checking commits $1..."
606 # git rev-list --remotes | grep -i "^$1" |
607 # while read line ; do
608 # git log --format='%H %s' -1 $line |
609 # echo "commit $(cut -c 1-12,41-)"
610 # done
611 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
615 }
618 }
640 }
645 }
649 }
653 }
660 }
671 );
676 }
677 }
679 }
702 # If there's a name left after stripping spaces and
703 # leading quotes, and the address doesn't have both
704 # leading and trailing angle brackets, the address
705 # is invalid. ie:
706 # "joe smith joe@smith.com" bad
707 # "joe smith <joe@smith.com" bad
712 }
713 }
723 }
726 }
740 }
746 }
749 }
757 }
758 }
761 }
769 }
770 }
773 }
786 }
788 }
791 }
794 }
798 }
803 # Drop the diff line leader and expand tabs
807 # Pick the indent from the front of the line.
811 }
822 }
823 }
834 # Always copy over the diff marker.
840 # Comments we are wacking completly including the begin
841 # and end, all to $;.
848 }
854 }
861 }
863 # A \ in a string means ignore the next character.
869 }
870 # Regular quotes.
879 }
880 }
882 #print "c<$c> SQ<$sanitise_quote>\n";
891 }
892 }
896 }
898 # The pathname on a #include may be surrounded by '<' and '>'.
903 # The whole of a #error is a string.
907 }
910 }
917 }
940 #warn "CSB: blk<$blk> remain<$remain>\n";
941 # If we are about to drop off the end, pull in more
942 # context.
953 }
954 # Bail if there is no further context.
955 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
958 }
962 }
963 }
968 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
970 # Handle nested #if/#else.
977 }
979 # Statement ends at the ';' or a close '}' at the
980 # outermost level.
983 }
985 # An else is really a conditional as long as its not else if
992 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
993 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
994 }
999 }
1007 #warn "CSB: mark coff<$coff>\n";
1008 }
1009 }
1013 }
1021 }
1023 }
1024 }
1025 # Preprocessor commands end at the newline unless escaped.
1031 }
1033 }
1034 # We are truly at the end, so shuffle to the next line.
1039 }
1044 #warn "STATEMENT<$statement>\n";
1045 #warn "CONDITION<$condition>\n";
1047 #print "coff<$coff> soff<$off> loff<$loff>\n";
1051 }
1056 # Strip the diff line prefixes and rip blank lines at start and end.
1064 }
1072 }
1093 }
1094 }
1102 # Grab the first conditional/block pair.
1105 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1109 }
1111 # Pull in the following conditional/block pairs and see if they
1112 # could continue the statement.
1116 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1118 #print "C: push\n";
1120 }
1123 }
1142 # Handle nested #if/#else.
1149 }
1152 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1156 }
1163 }
1164 }
1168 }
1171 }
1174 }
1180 }
1186 }
1192 }
1197 }
1202 }
1207 # Catch a comment on the end of the line itself.
1211 # Look through the context and try and figure out if there is a
1212 # comment.
1217 #warn " $line\n";
1220 }
1223 }
1226 }
1230 }
1231 }
1235 }
1240 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1241 ##print "CMMT: $cmt\n";
1244 }
1257 }
1260 }
1272 }
1273 }
1277 }
1289 }
1309 }
1330 }
1359 # Assume all arms of the conditional end as this
1360 # one does, and continue as if the #endif was not here.
1377 }
1408 }
1420 }
1453 }
1468 }
1477 }
1481 }
1485 }
1486 }
1489 }
1498 DEFINE_\S+
1499 )$|
1503 case|
1507 \#|
1508 \#\#|
1514 # Check for modifiers.
1525 }
1526 }
1531 }
1532 build_types();
1535 }
1536 }
1546 }
1554 }
1560 }
1566 }
1570 }
1581 }
1582 }
1609 }
1615 }
1622 }
1627 }
1630 }
1633 }
1641 };
1643 }
1651 };
1654 }
1663 }
1665 }
1673 }
1675 }
1683 }
1685 }
1691 ##print "absolute<$absolute>\n";
1693 # See if any suffix of this path is a path within the tree.
1696 ##print "file<$file>\n";
1698 }
1699 }
1702 }
1704 # It is, so see if the prefix is acceptable.
1708 ##print "prefix<$prefix>\n";
1712 }
1713 }
1721 }
1729 }
1737 }
1745 }
1754 #convert leading spaces to tabs
1756 #Remove spaces before a tab
1760 }
1774 }
1786 }
1787 }
1790 }
1823 # Trace the real file/line as we go.
1835 # suppression flags
1843 # Pre-scan the patch sanitizing the lines.
1844 # Pre-scan the patch looking for any __setup documentation.
1845 #
1851 sanitise_line_reset();
1863 }
1864 #next;
1865 }
1872 }
1875 # Guestimate if this is a continuing comment. Run
1876 # the context looking for a comment "edge". If this
1877 # edge is a close comment then we must be in a comment
1878 # at context start.
1885 #print "RAW<$rawlines[$ln - 1]>\n";
1891 }
1892 }
1895 }
1897 # Guestimate if this is a continuing comment. If this
1898 # is the start of a diff block and this line starts
1899 # ' *' then it is very likely a comment.
1902 {
1904 }
1906 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1910 # Standardise the strings and chars within the input to
1911 # simplify matching -- only bother with positive lines.
1913 }
1920 }
1922 #print "==>$rawline\n";
1923 #print "-->$line\n";
1927 }
1928 }
1943 #extract the line range in the file after the patch is applied
1952 }
1953 annotate_reset();
1962 # track the line number as we move through the hunk, note that
1963 # new versions of GNU diff omit the leading space on completely
1964 # blank context lines so we need to count that too.
1969 # Measure the line length and indent.
1972 # Track the previous line.
1977 #warn "line<$line>\n";
1981 }
1985 #make up the handle for any error we report on this line
1993 # extract the filename as it passes
2009 }
2013 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2014 }
2016 }
2023 }
2025 }
2035 # Check for incorrect file permissions
2042 }
2043 }
2045 # Check the patch for a signoff:
2049 }
2051 # Check signature styles
2063 }
2070 }
2071 }
2078 }
2080 }
2087 }
2088 }
2099 # Don't force email to have quotes
2100 # Allow just an angle bracketed address
2106 }
2107 }
2109 # Check for duplicate signatures
2118 }
2119 }
2121 # Check for old stable address
2125 }
2127 # Check for unwanted Gerrit info
2131 }
2133 # Check for improperly formed commit descriptions
2147 "Please use 12 or more chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
2148 }
2150 # Check for added, moved or deleted files
2159 }
2161 # Check for wrappage within a valid hunk of the file
2166 }
2168 # Check for absolute kernel paths.
2175 #
2178 }
2179 }
2180 }
2182 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2193 }
2195 # Check if it's the start of a commit log
2196 # (not a header line and we haven't seen the patch filename)
2202 }
2204 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2205 # declined it, i.e defined some charset where it is missing.
2210 }
2216 }
2218 # ignore non-hunk lines and lines being removed
2221 #trailing whitespace
2228 }
2235 }
2238 }
2240 # Check for FSF mailing addresses.
2248 "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)
2249 }
2251 # check for Kconfig help text having a real description
2252 # Only applies when adding the entry originally, after that we do not have
2253 # sufficient context to determine whether it is indeed long enough.
2274 }
2283 }
2285 }
2287 "please write a paragraph that describes the config symbol fully\n" . $herecurr) if ($is_start && $is_end && $length < 4);
2288 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2289 }
2291 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2295 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2296 }
2306 };
2309 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2310 }
2312 # check for DT compatible documentation
2331 }
2338 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2339 }
2340 }
2341 }
2343 # check we are in a valid source file if not then ignore this hunk
2346 #line length limit
2349 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2352 {
2355 }
2357 # Check for user-visible strings broken across lines, which breaks the ability
2358 # to grep for the string. Make exceptions when the previous string ends in a
2359 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
2360 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
2366 }
2368 # check for missing a space in a string concatination
2372 }
2374 # check for spaces before a quoted newline
2380 }
2382 }
2384 # check for adding lines without a newline.
2385 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2388 }
2390 # Blackfin: use hi/lo macros
2396 }
2401 }
2402 }
2404 # check we are in a valid source file C or perl if not then ignore this hunk
2407 # at the beginning of a line any tabs must come first and anything
2408 # more than 8 must use tabs.
2417 }
2418 }
2420 # check for space before tabs.
2430 }
2431 }
2433 # check for && or || at the start of a line
2437 }
2439 # check multi-line statement indentation matches previous line
2441 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2464 }
2465 }
2466 }
2467 }
2475 }
2476 }
2484 }
2493 }
2502 }
2504 # check for missing blank lines after struct/union declarations
2505 # with exceptions for various attributes and macros
2520 }
2521 }
2523 # check for multiple consecutive blank lines
2531 }
2534 }
2536 # check for missing blank lines after declarations
2538 # actual declarations
2540 # function pointer declarations
2542 # foo bar; where foo is some local typedef or #define
2544 # known declaration macros
2546 # for "else if" which can look like "$Ident $Ident"
2548 # other possible extensions of declaration lines
2550 # not starting a section or a macro "\" extended line
2552 # looks like a declaration
2554 # function pointer declarations
2556 # foo bar; where foo is some local typedef or #define
2558 # known declaration macros
2560 # start of struct or union or enum
2562 # start or end of block or continuation of declaration
2564 # bitfield continuation
2566 # other possible extensions of declaration lines
2568 # indentation of previous and current line are the same
2574 }
2575 }
2577 # check for spaces at the beginning of a line.
2578 # Exceptions:
2579 # 1) within comments
2580 # 2) indented preprocessor commands
2581 # 3) hanging labels
2588 }
2589 }
2591 # check we are in a valid C source file if not then ignore this hunk
2594 # check indentation of any line with a bare else
2595 # if the previous line is a break or return and is indented 1 tab more...
2601 }
2602 }
2604 # check indentation of a line with a break;
2605 # if the previous line is a goto or return and is indented the same # of tabs
2611 }
2612 }
2614 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2617 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2618 }
2620 # check for RCS/CVS revision markers
2624 }
2626 # Blackfin: don't use __builtin_bfin_[cs]sync
2631 }
2636 }
2638 # check for old HOTPLUG __dev<foo> section markings
2642 }
2644 # Check for potential 'bare' types
2647 #print "LINE<$line>\n";
2655 #print "linenr<$linenr> <$stat>\n";
2656 # If this statement has no statement boundaries within
2657 # it there is no point in retrying a statement scan
2658 # until we hit end of it.
2661 #print "skip<$line_nr_next>\n";
2663 }
2665 # Find the real next line.
2671 }
2676 # Ignore goto labels.
2679 # Ignore functions being called
2684 # declarations always start with types
2685 } 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) {
2690 # definitions in global scope can only start with types
2693 }
2695 # any (foo ... *) is a pointer cast, and foo is a type
2698 }
2700 # Check for any sort of function declaration.
2701 # int foo(something bar, other baz);
2702 # void (*store_gdt)(x86_descr_ptr *);
2703 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2711 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2714 }
2715 }
2716 }
2718 }
2720 #
2721 # Checks which may be anchored in the context.
2722 #
2724 # Check for switch () and associated case and default
2725 # statements should be at the same indent.
2739 }
2740 }
2744 }
2745 }
2747 # if/while/etc brace do not go on next line, unless defining a do while loop,
2748 # or if that brace on the next line is for something else
2749 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2757 }
2768 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2771 }
2773 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2774 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2780 }
2784 {
2790 }
2791 }
2792 }
2794 # Check relative indent for conditionals and blocks.
2795 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2803 # Make sure we remove the line prefixes as we have
2804 # none on the first line, and are going to readd them
2805 # where necessary.
2808 # Find out how long the conditional actually is.
2812 # We want to check the first line inside the block
2813 # starting at the end of the conditional, so remove:
2814 # 1) any blank line termination
2815 # 2) any opening brace { on end of the line
2816 # 3) any do (...) {
2823 }
2827 }
2829 # Also ignore a loop construct at the end of a
2830 # preprocessor statement.
2834 }
2841 # If we see an #else/#elif then the code
2842 # is not linear.
2845 }
2847 # Ignore:
2848 # 1) blank lines, they should be at 0,
2849 # 2) preprocessor lines, and
2850 # 3) labels.
2858 }
2859 }
2860 }
2865 # Check if either of these lines are modified, else
2866 # this is not this patch's fault.
2870 }
2873 }
2875 #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";
2880 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2881 }
2882 }
2884 # Track the 'values' across context and added lines.
2894 }
2897 #ignore lines not being added
2900 # TEST: allow direct testing of the type matcher.
2908 }
2910 }
2911 # TEST: allow direct testing of the attribute matcher.
2919 }
2921 }
2923 # check for initialisation to aggregates open brace on the next line
2937 }
2938 }
2940 #
2941 # Checks which are anchored on the added line.
2942 #
2944 # check for malformed paths in #include statements (uses RAW line)
2950 }
2954 }
2955 }
2957 # no C99 // comments
2966 }
2967 }
2968 }
2969 # Remove C99 comments.
2973 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
2974 # the whole statement.
2975 #print "APW <$lines[$realline_next - 1]>\n";
2981 # Handle definitions which produce identifiers with
2982 # a prefix:
2983 # XXX(foo);
2984 # EXPORT_SYMBOL(something_foo);
2988 #print "FOO C name<$name>\n";
2999 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3003 }
3004 }
3009 #print "FOO B <$lines[$linenr - 1]>\n";
3011 }
3016 }
3018 # check for global initialisers.
3025 }
3026 }
3027 # check for static initialisers.
3034 }
3035 }
3037 # check for misordered declarations of char/short/int/long with signed/unsigned
3041 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3042 }
3044 # check for static const char * arrays.
3049 }
3051 # check for static char foo[] = "bar" declarations.
3056 }
3058 # check for non-global char *foo[] = {"bar", ...} declarations.
3063 }
3065 # check for function declarations without arguments like "int foo()"
3071 }
3072 }
3074 # check for uses of DEFINE_PCI_DEVICE_TABLE
3079 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3080 }
3081 }
3083 # check for new typedefs, only function parameters and sparse annotations
3084 # make sense.
3092 }
3094 # * goes on variable not on type
3095 # (char*[ const])
3097 #print "AA<$1>\n";
3100 # Should start with a space.
3102 # Should not end with a space.
3104 # '*'s should not have spaces between.
3106 }
3108 ## print "1: from<$from> to<$to> ident<$ident>\n";
3118 }
3119 }
3120 }
3122 #print "BB<$1>\n";
3125 # Should start with a space.
3127 # Should not end with a space.
3129 # '*'s should not have spaces between.
3131 }
3132 # Modifiers should have spaces.
3135 ## print "2: from<$from> to<$to> ident<$ident>\n";
3146 }
3147 }
3148 }
3150 # # no BUG() or BUG_ON()
3151 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
3152 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3153 # print "$herecurr";
3154 # $clean = 0;
3155 # }
3159 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3160 }
3162 # check for uses of printk_ratelimit
3166 }
3168 # printk should use KERN_* levels. Note that follow on printk's on the
3169 # same line do not need a level, so we use the current block context
3170 # to try and find and validate the current printk. In summary the current
3171 # printk includes all preceding printk's which have no newline on the end.
3172 # we assume the first bad printk is the one to report.
3176 #print "CHECK<$lines[$ln - 1]\n";
3177 # we have a preceding printk if it ends
3178 # with "\n" ignore it, else it is to blame
3182 }
3184 }
3185 }
3189 }
3190 }
3199 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3200 }
3208 }
3209 }
3218 }
3220 # function brace can't be on same line, except for #defines of do while,
3221 # or if closed on same line
3236 }
3237 }
3238 }
3240 # open braces for enum, union and struct go on the same line.
3254 }
3255 }
3256 }
3258 # missing space after union, struct or enum definition
3265 }
3266 }
3268 # Function pointer declarations
3269 # check spacing between type, funcptr, and args
3270 # canonical declaration is "type (*funcptr)(args...)"
3279 # the $Declare variable will capture all spaces after the type
3280 # so check it for a missing trailing missing space but pointer return types
3281 # don't need a space so don't warn for those.
3286 }
3291 }
3293 # unnecessary space "type (*funcptr)(args...)"
3294 # This test is not currently implemented because these declarations are
3295 # equivalent to
3296 # int foo(int bar, ...)
3297 # and this is form shouldn't/doesn't generate a checkpatch warning.
3298 #
3299 # elsif ($declare =~ /\s{2,}$/) {
3300 # WARN("SPACING",
3301 # "Multiple spaces after return type\n" . $herecurr);
3302 # }
3304 # unnecessary space "type ( *funcptr)(args...)"
3309 }
3311 # unnecessary space "type (* funcptr)(args...)"
3316 }
3318 # unnecessary space "type (*funcptr )(args...)"
3323 }
3325 # unnecessary space "type (*funcptr) (args...)"
3330 }
3334 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3335 }
3336 }
3338 # check for spacing round square brackets; allowed:
3339 # 1. with a type on the left -- int [] a;
3340 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3341 # 3. inside a curly brace -- = { [0...10] = 5 }
3352 }
3353 }
3354 }
3356 # check for spaces between functions and their parentheses.
3362 # Ignore those directives where spaces _are_ permitted.
3368 {
3369 # cpp #define statements have non-optional spaces, ie
3370 # if there is a space between the name and the open
3371 # parenthesis it is simply not a parameter group.
3374 # cpp #elif statement condition may start with a (
3377 # If this whole things ends with a type its most
3378 # likely a typedef for a function.
3387 }
3388 }
3389 }
3391 # Check operator spacing.
3397 <<=|>>=|<=|>=|==|!=|
3399 =>|->|<<|>>|<|>|=|!|~|
3405 ## print("element count: <" . $#elements . ">\n");
3406 ## foreach my $el (@elements) {
3407 ## print("el: <$el>\n");
3408 ## }
3416 }
3427 ## print("n: <$n> good: <$good>\n");
3431 # Pick up the preceding and succeeding characters.
3436 }
3459 }
3468 # Pull out the value of this operator.
3471 # Get the full operator variant.
3474 # Ignore operators passed as parameters.
3478 # # Ignore comments
3479 # } elsif ($op =~ /^$;+$/) {
3481 # ; should have either the end of line or a space or \ after it
3489 }
3490 }
3492 # // is a comment
3495 # : when part of a bitfield
3497 # skip the bitfield test for now
3499 # No spaces for:
3500 # ->
3508 }
3510 }
3511 }
3513 # , must have a space on the right.
3521 }
3522 }
3524 # '*' as part of a type definition -- reported already.
3526 #warn "'*' is part of type\n";
3528 # unary operators should have a space before and
3529 # none after. May be left adjacent to another
3530 # unary operator, or a cast
3540 }
3541 }
3542 }
3544 # A unary '*' may be const
3552 }
3554 }
3555 }
3557 # unary ++ and unary -- are allowed no space on one side.
3564 }
3565 }
3572 }
3573 }
3580 }
3582 }
3583 }
3585 # << and >> may either have or not have spaces both sides
3591 {
3598 }
3600 }
3601 }
3603 # A colon needs no spaces before when it is
3604 # terminating a case value or a label.
3611 }
3612 }
3614 # All the others need spaces both sides.
3618 # Ignore email addresses <foo@bar>
3623 {
3625 }
3627 # messages are ERROR, but ?: are CHK
3637 }
3639 }
3640 }
3641 }
3644 ## print("n: <$n> GOOD: <$good>\n");
3647 }
3651 }
3655 }
3658 }
3660 # check for whitespace before a non-naked semicolon
3667 }
3668 }
3670 # check for multiple assignments
3674 }
3676 ## # check for multiple declarations, allowing for a function declaration
3677 ## # continuation.
3678 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3679 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3680 ##
3681 ## # Remove any bracketed sections to ensure we do not
3682 ## # falsly report the parameters of functions.
3683 ## my $ln = $line;
3684 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3685 ## }
3686 ## if ($ln =~ /,/) {
3687 ## WARN("MULTIPLE_DECLARATION",
3688 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3689 ## }
3690 ## }
3692 #need space before brace following if, while, etc
3699 }
3700 }
3702 ## # check for blank lines before declarations
3703 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3704 ## $prevrawline =~ /^.\s*$/) {
3705 ## WARN("SPACING",
3706 ## "No blank lines before declarations\n" . $hereprev);
3707 ## }
3708 ##
3710 # closing brace should have a space following it when it has anything
3711 # on the line
3718 }
3719 }
3721 # check spacing on square brackets
3728 }
3729 }
3736 }
3737 }
3739 # check spacing on parentheses
3747 }
3748 }
3758 }
3759 }
3761 # check unnecessary parentheses around addressof/dereference single $Lvals
3762 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3767 }
3769 #goto labels aren't indented, allow a single space however
3777 }
3778 }
3780 # return is not a function
3790 }
3794 }
3795 }
3797 # unnecessary return in a void function
3798 # at end-of-function, with the previous line a single leading tab, then return;
3799 # and the line before that not a goto label target like "out:"
3807 }
3809 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3815 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3820 }
3821 }
3823 # Return of what appears to be an errno should normally be -'ve
3829 }
3830 }
3832 # Need a space before open parenthesis after if, while etc
3839 }
3840 }
3842 # Check for illegal assignment in if conditional -- and check for trailing
3843 # statements after the conditional.
3851 ##print "stat<$stat> stat_next<$stat_next>\n";
3854 # If the statement carries leading newlines,
3855 # then count those as offsets.
3863 }
3864 }
3873 }
3875 # Find out what is on the end of the line after the
3876 # conditional.
3882 {
3883 # Find out how long the conditional actually is.
3892 }
3896 }
3897 }
3899 # Check for bitwise tests written as boolean
3905 |
3910 {
3913 }
3915 # if and else should not have general statements after it
3922 }
3923 }
3924 # if should not continue a brace
3929 }
3930 # case and default should not have general statements after them
3936 {
3939 }
3941 # Check for }<nl>else {, these must be at the same
3942 # indent level to be relevant to each other.
3954 }
3958 }
3959 }
3965 # Find out what is on the end of the line after the
3966 # conditional.
3982 }
3983 }
3984 }
3986 #Specific variable tests
3990 #gcc binary extension
3998 }
3999 }
4001 #CamelCase
4004 #Ignore Page<foo> variants
4006 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4012 seed_camelcase_includes();
4016 }
4017 }
4022 }
4023 }
4024 }
4025 }
4027 #no spaces allowed after \ in define
4033 }
4034 }
4036 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
4043 {
4050 }
4051 }
4052 }
4054 # multi-statement macros should be enclosed in a do while loop, grab the
4055 # first statement and ensure its the whole macro if its not enclosed
4056 # in a known good container
4066 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4067 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4075 # Flatten any parentheses and braces
4079 {
4080 }
4082 # Flatten any obvious string concatentation.
4085 {
4086 }
4090 module_param_named|
4091 MODULE_PARM_DESC|
4092 DECLARE_PER_CPU|
4093 DEFINE_PER_CPU|
4094 __typeof__\(|
4095 union|
4096 struct|
4100 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4104 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4109 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4115 {
4122 }
4130 }
4131 }
4133 # check for line continuations outside of #defines, preprocessor #, and asm
4142 }
4143 }
4145 # do {} while (0) macro tests:
4146 # single-statement macros do not need to be enclosed in do while (0) loop,
4147 # macro should not end with a semicolon
4161 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4171 }
4177 }
4181 }
4189 }
4193 }
4194 }
4196 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4197 # all assignments may have only one of the following with an assignment:
4198 # .
4199 # ALIGN(...)
4200 # VMLINUX_SYMBOL(...)
4204 }
4206 # check for redundant bracing round if etc
4210 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4211 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4221 # If the condition carries leading newlines, then count those as offsets.
4226 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4228 # We have looked at and allowed this specific line.
4238 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4240 #print "APW: ALLOWED: cond<$cond>\n";
4242 }
4244 #print "APW: ALLOWED: block<$block>\n";
4246 }
4248 #print "APW: ALLOWED: lines block<$block>\n";
4250 }
4252 }
4257 }
4265 }
4266 }
4267 }
4268 }
4273 # Check the pre-context.
4275 #print "APW: ALLOWED: pre<$1>\n";
4277 }
4282 # Check the condition.
4284 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4287 }
4289 #print "APW: ALLOWED: cond<$cond>\n";
4291 }
4293 #print "APW: ALLOWED: block<$block>\n";
4295 }
4297 #print "APW: ALLOWED: lines block<$block>\n";
4299 }
4300 # Check the post-context.
4305 }
4307 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4309 }
4310 }
4317 }
4321 }
4322 }
4324 # check for unnecessary blank lines around braces
4328 }
4332 }
4334 # no volatiles please
4338 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4339 }
4341 # warn about #if 0
4346 }
4348 # check for needless "if (<foo>) fn(<foo>)" uses
4354 }
4355 }
4357 # check for unnecessary "Out of Memory" messages
4366 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4368 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4371 }
4372 }
4374 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4377 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4387 $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;
4388 }
4389 }
4390 }
4392 # check for $InitAttributeData (ie: __initdata) with const
4403 }
4404 }
4406 # check for $InitAttributeConst (ie: __initconst) without const
4418 }
4419 }
4421 # don't use __constant_<foo> functions outside of include/uapi/
4423 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4431 }
4432 }
4434 # prefer usleep_range over udelay
4437 # ignore udelay's < 10, however
4440 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4441 }
4445 }
4446 }
4448 # warn about unexpectedly long msleep's
4452 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4453 }
4454 }
4456 # check for comparisons of jiffies
4459 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4460 }
4462 # check for comparisons of get_jiffies_64()
4465 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4466 }
4468 # warn about #ifdefs in C files
4469 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4470 # print "#ifdef in C files should be avoided\n";
4471 # print "$herecurr";
4472 # $clean = 0;
4473 # }
4475 # warn about spacing in #ifdefs
4482 }
4484 }
4486 # check for spinlock_t definitions without a comment.
4493 }
4494 }
4495 # check for memory barriers without a comment.
4496 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4500 }
4501 }
4502 # check of hardware specific defines
4503 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4506 }
4508 # Check that the storage class is at the beginning of a declaration
4512 }
4514 # check the location of the inline attribute, that it is between
4515 # storage class and type.
4520 }
4522 # Check for __inline__ and __inline, prefer inline
4530 }
4531 }
4533 # Check for __attribute__ packed, prefer __packed
4538 }
4540 # Check for __attribute__ aligned, prefer __aligned
4545 }
4547 # Check for __attribute__ format(printf, prefer __printf
4551 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4553 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4555 }
4556 }
4558 # Check for __attribute__ format(scanf, prefer __scanf
4562 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4564 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4565 }
4566 }
4568 # check for sizeof(&)
4572 }
4574 # check for sizeof without parenthesis
4579 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4580 }
4581 }
4583 # check for line continuations in quoted strings with odd counts of "
4587 }
4589 # check for struct spinlock declarations
4593 }
4595 # check for seq_printf uses that could be seq_puts
4603 }
4604 }
4605 }
4607 # Check for misused memsets
4622 }
4623 }
4625 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4629 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4631 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4632 }
4633 }
4635 # typecasts on min/max could be min_t/max_t
4653 }
4656 }
4657 }
4659 # check usleep_range arguments
4667 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4671 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4672 }
4673 }
4675 # check for naked sscanf
4687 }
4690 }
4692 # check for simple sscanf that should be kstrto<foo>
4701 }
4709 }
4710 }
4711 }
4713 # check for new externs in .h files.
4720 }
4721 }
4723 # check for new externs in .c files.
4726 {
4733 }
4736 {
4739 }
4744 }
4748 {
4751 }
4753 # checks for new __setup's
4760 }
4761 }
4763 # check for pointless casting of kmalloc return
4766 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
4767 }
4769 # alloc style
4770 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4772 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4775 }
4777 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4779 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
4790 }
4796 $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;
4798 }
4799 }
4800 }
4802 # check for krealloc arg reuse
4807 }
4809 # check for alloc argument mismatch
4813 }
4815 # check for multiple semicolons
4821 }
4822 }
4824 # check for case / default statements not preceded by break/fallthrough/switch
4842 }
4846 }
4847 }
4849 # check for switch/default statements without a break;
4858 }
4861 }
4863 # check for gcc specific __FUNCTION__
4869 }
4870 }
4872 # check for use of yield()
4876 }
4878 # check for comparisons against true and false
4894 }
4899 ## maybe suggesting a correct construct would better
4900 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
4902 }
4903 }
4905 # check for semaphores initialized locked
4909 }
4911 # recommend kstrto* over simple_strto* and strict_strto*
4915 }
4917 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
4920 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
4921 }
4923 # check for various ops structs, ensure they are const.
4925 address_space_operations|
4926 backlight_ops|
4927 block_device_operations|
4928 dentry_operations|
4929 dev_pm_ops|
4930 dma_map_ops|
4931 extent_io_ops|
4932 file_lock_operations|
4933 file_operations|
4934 hv_ops|
4935 ide_dma_ops|
4936 intel_dvo_dev_ops|
4937 item_operations|
4938 iwl_ops|
4939 kgdb_arch|
4940 kgdb_io|
4941 kset_uevent_ops|
4942 lock_manager_operations|
4943 microcode_ops|
4944 mtrr_ops|
4945 neigh_ops|
4946 nlmsvc_binding|
4947 pci_raw_ops|
4948 pipe_buf_operations|
4949 platform_hibernation_ops|
4950 platform_suspend_ops|
4951 proto_ops|
4952 rpc_pipe_ops|
4953 seq_operations|
4954 snd_ac97_build_ops|
4955 soc_pcmcia_socket_ops|
4956 stacktrace_ops|
4957 sysfs_ops|
4958 tty_operations|
4959 usb_mon_operations|
4966 }
4968 # use of NR_CPUS is usually wrong
4969 # ignore definitions of NR_CPUS and usage to define arrays as likely right
4976 {
4978 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
4979 }
4981 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
4985 }
4987 # check for %L{u,d,i} in strings
4996 }
4997 }
4999 # whine mightly about in_atomic
5007 }
5008 }
5010 # check for lockdep_set_novalidate_class
5018 }
5019 }
5024 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5025 }
5027 # Mode permission misuses where it seems decimal should be octal
5028 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5039 }
5050 }
5051 }
5052 }
5053 }
5054 }
5056 # If we have no input at all, then there is nothing to report on
5057 # so just keep quiet.
5060 }
5062 # In mailback mode only produce a report in the negative, for
5063 # things that appear to be patches.
5066 }
5068 # This is not a patch, and we are are in 'no-patch' mode so
5069 # just keep quiet.
5072 }
5077 }
5081 }
5090 }
5097 }
5099 # If there were whitespace errors which cleanpatch can fix
5100 # then suggest that.
5105 }
5106 }
5129 }
5132 }
5133 }
5140 Do _NOT_ trust the results written to this file.
5143 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5146 EOM
5147 }
5148 }
5152 }
5157 If any of these errors are false positives, please report
5159 EOM
5160 }
5163 }