| blob | f0bb6d60c07b182686ff203ca3c4fee90e954ab8 |
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
58 Options:
63 --emacs emacs compile window format
64 --terse one line per report
78 is all off)
80 literally
83 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
84 with potential errors corrected to the preferred
85 checkpatch style
90 runtime errors.
94 EOM
97 }
119 }
120 }
123 }
125 GetOptions(
164 }
165 }
170 }
186 }
187 }
196 }
198 }
199 }
209 ## no critic
212 }
219 }
225 }
232 }
233 }
238 }
239 }
249 __user|
250 __kernel|
251 __force|
252 __iomem|
253 __must_check|
254 __init_refok|
255 __kprobes|
256 __ref|
257 __rcu
265 # Notes to $Attribute:
266 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
268 const|
269 __percpu|
270 __nocast|
271 __safe|
272 __bitwise__|
273 __packed__|
274 __packed2__|
275 __naked|
276 __maybe_unused|
277 __always_unused|
278 __noreturn|
279 __used|
280 __cold|
281 __noclone|
282 __deprecated|
283 __read_mostly|
284 __kprobes|
286 ____cacheline_aligned|
287 ____cacheline_aligned_in_smp|
288 ____cacheline_internodealigned_in_smp|
289 __weak
310 <=|>=|==|!=|
311 =>|->|<<|>>|<|>|!|~|
342 atomic_t
343 )};
347 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
349 panic|
352 )};
361 To:|
362 Cc:
363 )};
382 );
405 );
410 );
414 );
420 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
423 );
425 #Create a search pattern for all these functions to speed up a loop below
430 }
433 irq|
434 memory|
436 reboot
437 )};
438 # memory.h: ARM has a custom one
440 # Load common spelling mistakes and build regular expression list.
459 }
464 }
478 )
485 )
494 )
498 $NonptrType
503 $NonptrTypeMisordered
509 }
510 build_types();
514 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
515 # requires at least perl version v5.10.0
516 # Any use must be runtime checked with $^V
526 )};
535 }
540 }
564 }
565 }
566 }
590 }
592 }
600 }
604 }
609 }
613 }
621 }
623 }
624 }
636 # Maybe one day convert this block of bash into something that returns
637 # all matching commit ids, but it's very slow...
638 #
639 # echo "checking commits $1..."
640 # git rev-list --remotes | grep -i "^$1" |
641 # while read line ; do
642 # git log --format='%H %s' -1 $line |
643 # echo "commit $(cut -c 1-12,41-)"
644 # done
645 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
649 }
652 }
674 }
679 }
683 }
687 }
694 }
705 );
710 }
711 }
713 }
736 # If there's a name left after stripping spaces and
737 # leading quotes, and the address doesn't have both
738 # leading and trailing angle brackets, the address
739 # is invalid. ie:
740 # "joe smith joe@smith.com" bad
741 # "joe smith <joe@smith.com" bad
746 }
747 }
757 }
760 }
774 }
780 }
783 }
791 }
792 }
795 }
803 }
804 }
807 }
820 }
822 }
825 }
828 }
832 }
837 # Drop the diff line leader and expand tabs
841 # Pick the indent from the front of the line.
845 }
856 }
857 }
868 # Always copy over the diff marker.
874 # Comments we are wacking completly including the begin
875 # and end, all to $;.
882 }
888 }
895 }
897 # A \ in a string means ignore the next character.
903 }
904 # Regular quotes.
913 }
914 }
916 #print "c<$c> SQ<$sanitise_quote>\n";
925 }
926 }
930 }
932 # The pathname on a #include may be surrounded by '<' and '>'.
937 # The whole of a #error is a string.
941 }
944 }
951 }
974 #warn "CSB: blk<$blk> remain<$remain>\n";
975 # If we are about to drop off the end, pull in more
976 # context.
987 }
988 # Bail if there is no further context.
989 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
992 }
996 }
997 }
1002 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1004 # Handle nested #if/#else.
1011 }
1013 # Statement ends at the ';' or a close '}' at the
1014 # outermost level.
1017 }
1019 # An else is really a conditional as long as its not else if
1026 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1027 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1028 }
1033 }
1041 #warn "CSB: mark coff<$coff>\n";
1042 }
1043 }
1047 }
1055 }
1057 }
1058 }
1059 # Preprocessor commands end at the newline unless escaped.
1065 }
1067 }
1068 # We are truly at the end, so shuffle to the next line.
1073 }
1078 #warn "STATEMENT<$statement>\n";
1079 #warn "CONDITION<$condition>\n";
1081 #print "coff<$coff> soff<$off> loff<$loff>\n";
1085 }
1090 # Strip the diff line prefixes and rip blank lines at start and end.
1098 }
1106 }
1127 }
1128 }
1136 # Grab the first conditional/block pair.
1139 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1143 }
1145 # Pull in the following conditional/block pairs and see if they
1146 # could continue the statement.
1150 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1152 #print "C: push\n";
1154 }
1157 }
1176 # Handle nested #if/#else.
1183 }
1186 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1190 }
1197 }
1198 }
1202 }
1205 }
1208 }
1214 }
1220 }
1226 }
1231 }
1236 }
1241 # Catch a comment on the end of the line itself.
1245 # Look through the context and try and figure out if there is a
1246 # comment.
1251 #warn " $line\n";
1254 }
1257 }
1260 }
1264 }
1265 }
1269 }
1274 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1275 ##print "CMMT: $cmt\n";
1278 }
1291 }
1294 }
1306 }
1307 }
1311 }
1323 }
1343 }
1364 }
1393 # Assume all arms of the conditional end as this
1394 # one does, and continue as if the #endif was not here.
1411 }
1442 }
1454 }
1487 }
1502 }
1511 }
1515 }
1519 }
1520 }
1523 }
1532 DEFINE_\S+
1533 )$|
1537 case|
1541 \#|
1542 \#\#|
1548 # Check for modifiers.
1559 }
1560 }
1565 }
1566 build_types();
1569 }
1570 }
1580 }
1588 }
1594 }
1600 }
1604 }
1615 }
1616 }
1643 }
1649 }
1656 }
1661 }
1664 }
1667 }
1675 };
1677 }
1685 };
1688 }
1697 }
1699 }
1707 }
1709 }
1717 }
1719 }
1725 ##print "absolute<$absolute>\n";
1727 # See if any suffix of this path is a path within the tree.
1730 ##print "file<$file>\n";
1732 }
1733 }
1736 }
1738 # It is, so see if the prefix is acceptable.
1742 ##print "prefix<$prefix>\n";
1746 }
1747 }
1755 }
1763 }
1771 }
1779 }
1788 #convert leading spaces to tabs
1790 #Remove spaces before a tab
1794 }
1808 }
1820 }
1821 }
1824 }
1858 # Trace the real file/line as we go.
1870 # suppression flags
1878 # Pre-scan the patch sanitizing the lines.
1879 # Pre-scan the patch looking for any __setup documentation.
1880 #
1886 sanitise_line_reset();
1898 }
1899 #next;
1900 }
1907 }
1910 # Guestimate if this is a continuing comment. Run
1911 # the context looking for a comment "edge". If this
1912 # edge is a close comment then we must be in a comment
1913 # at context start.
1920 #print "RAW<$rawlines[$ln - 1]>\n";
1926 }
1927 }
1930 }
1932 # Guestimate if this is a continuing comment. If this
1933 # is the start of a diff block and this line starts
1934 # ' *' then it is very likely a comment.
1937 {
1939 }
1941 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
1945 # Standardise the strings and chars within the input to
1946 # simplify matching -- only bother with positive lines.
1948 }
1955 }
1957 #print "==>$rawline\n";
1958 #print "-->$line\n";
1962 }
1963 }
1978 #extract the line range in the file after the patch is applied
1987 }
1988 annotate_reset();
1997 # track the line number as we move through the hunk, note that
1998 # new versions of GNU diff omit the leading space on completely
1999 # blank context lines so we need to count that too.
2004 # Measure the line length and indent.
2007 # Track the previous line.
2012 #warn "line<$line>\n";
2016 }
2020 #make up the handle for any error we report on this line
2028 # extract the filename as it passes
2044 }
2048 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2049 }
2051 }
2058 }
2060 }
2070 # Check for incorrect file permissions
2077 }
2078 }
2080 # Check the patch for a signoff:
2084 }
2086 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2087 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2090 }
2092 # Check signature styles
2104 }
2111 }
2112 }
2119 }
2121 }
2128 }
2129 }
2140 # Don't force email to have quotes
2141 # Allow just an angle bracketed address
2147 }
2148 }
2150 # Check for duplicate signatures
2159 }
2160 }
2162 # Check for old stable address
2166 }
2168 # Check for unwanted Gerrit info
2172 }
2174 # Check for improperly formed commit descriptions
2188 "Please use 12 or more chars for the git commit ID like: '${init_char}ommit $id (\"$desc\")'\n" . $herecurr);
2189 }
2191 # Check for added, moved or deleted files
2200 }
2202 # Check for wrappage within a valid hunk of the file
2207 }
2209 # Check for absolute kernel paths.
2216 #
2219 }
2220 }
2221 }
2223 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2234 }
2236 # Check if it's the start of a commit log
2237 # (not a header line and we haven't seen the patch filename)
2243 }
2245 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2246 # declined it, i.e defined some charset where it is missing.
2251 }
2257 }
2259 # Check for various typo / spelling mistakes
2272 }
2273 }
2274 }
2276 # ignore non-hunk lines and lines being removed
2279 #trailing whitespace
2286 }
2293 }
2296 }
2298 # Check for FSF mailing addresses.
2306 "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)
2307 }
2309 # check for Kconfig help text having a real description
2310 # Only applies when adding the entry originally, after that we do not have
2311 # sufficient context to determine whether it is indeed long enough.
2332 }
2341 }
2343 }
2347 }
2348 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2349 }
2351 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2355 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2356 }
2366 };
2369 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2370 }
2372 # check for DT compatible documentation
2391 }
2398 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2399 }
2400 }
2401 }
2403 # check we are in a valid source file if not then ignore this hunk
2406 #line length limit
2409 !($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(KERN_\S+\s*|[^"]*))?"[X\t]*"\s*(?:|,|\)\s*;)\s*$/ ||
2412 {
2415 }
2417 # check for adding lines without a newline.
2418 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2421 }
2423 # Blackfin: use hi/lo macros
2429 }
2434 }
2435 }
2437 # check we are in a valid source file C or perl if not then ignore this hunk
2440 # at the beginning of a line any tabs must come first and anything
2441 # more than 8 must use tabs.
2450 }
2451 }
2453 # check for space before tabs.
2463 }
2464 }
2466 # check for && or || at the start of a line
2470 }
2472 # check multi-line statement indentation matches previous line
2474 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2497 }
2498 }
2499 }
2500 }
2509 }
2510 }
2518 }
2527 }
2536 }
2538 # check for missing blank lines after struct/union declarations
2539 # with exceptions for various attributes and macros
2554 }
2555 }
2557 # check for multiple consecutive blank lines
2565 }
2568 }
2570 # check for missing blank lines after declarations
2572 # actual declarations
2574 # function pointer declarations
2576 # foo bar; where foo is some local typedef or #define
2578 # known declaration macros
2580 # for "else if" which can look like "$Ident $Ident"
2582 # other possible extensions of declaration lines
2584 # not starting a section or a macro "\" extended line
2586 # looks like a declaration
2588 # function pointer declarations
2590 # foo bar; where foo is some local typedef or #define
2592 # known declaration macros
2594 # start of struct or union or enum
2596 # start or end of block or continuation of declaration
2598 # bitfield continuation
2600 # other possible extensions of declaration lines
2602 # indentation of previous and current line are the same
2608 }
2609 }
2611 # check for spaces at the beginning of a line.
2612 # Exceptions:
2613 # 1) within comments
2614 # 2) indented preprocessor commands
2615 # 3) hanging labels
2622 }
2623 }
2625 # check we are in a valid C source file if not then ignore this hunk
2628 # check indentation of any line with a bare else
2629 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2630 # if the previous line is a break or return and is indented 1 tab more...
2639 }
2640 }
2642 # check indentation of a line with a break;
2643 # if the previous line is a goto or return and is indented the same # of tabs
2649 }
2650 }
2652 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2655 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2656 }
2658 # check for RCS/CVS revision markers
2662 }
2664 # Blackfin: don't use __builtin_bfin_[cs]sync
2669 }
2674 }
2676 # check for old HOTPLUG __dev<foo> section markings
2680 }
2682 # Check for potential 'bare' types
2685 #print "LINE<$line>\n";
2693 #print "linenr<$linenr> <$stat>\n";
2694 # If this statement has no statement boundaries within
2695 # it there is no point in retrying a statement scan
2696 # until we hit end of it.
2699 #print "skip<$line_nr_next>\n";
2701 }
2703 # Find the real next line.
2709 }
2714 # Ignore goto labels.
2717 # Ignore functions being called
2722 # declarations always start with types
2723 } 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) {
2728 # definitions in global scope can only start with types
2731 }
2733 # any (foo ... *) is a pointer cast, and foo is a type
2736 }
2738 # Check for any sort of function declaration.
2739 # int foo(something bar, other baz);
2740 # void (*store_gdt)(x86_descr_ptr *);
2741 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2749 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2752 }
2753 }
2754 }
2756 }
2758 #
2759 # Checks which may be anchored in the context.
2760 #
2762 # Check for switch () and associated case and default
2763 # statements should be at the same indent.
2777 }
2778 }
2782 }
2783 }
2785 # if/while/etc brace do not go on next line, unless defining a do while loop,
2786 # or if that brace on the next line is for something else
2787 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
2795 }
2806 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
2809 }
2811 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
2812 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
2818 }
2822 {
2828 }
2829 }
2830 }
2832 # Check relative indent for conditionals and blocks.
2833 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
2841 # Make sure we remove the line prefixes as we have
2842 # none on the first line, and are going to readd them
2843 # where necessary.
2846 # Find out how long the conditional actually is.
2850 # We want to check the first line inside the block
2851 # starting at the end of the conditional, so remove:
2852 # 1) any blank line termination
2853 # 2) any opening brace { on end of the line
2854 # 3) any do (...) {
2861 }
2865 }
2867 # Also ignore a loop construct at the end of a
2868 # preprocessor statement.
2872 }
2879 # If we see an #else/#elif then the code
2880 # is not linear.
2883 }
2885 # Ignore:
2886 # 1) blank lines, they should be at 0,
2887 # 2) preprocessor lines, and
2888 # 3) labels.
2896 }
2897 }
2898 }
2903 # Check if either of these lines are modified, else
2904 # this is not this patch's fault.
2908 }
2911 }
2913 #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";
2918 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
2919 }
2920 }
2922 # Track the 'values' across context and added lines.
2932 }
2935 #ignore lines not being added
2938 # TEST: allow direct testing of the type matcher.
2946 }
2948 }
2949 # TEST: allow direct testing of the attribute matcher.
2957 }
2959 }
2961 # check for initialisation to aggregates open brace on the next line
2975 }
2976 }
2978 #
2979 # Checks which are anchored on the added line.
2980 #
2982 # check for malformed paths in #include statements (uses RAW line)
2988 }
2992 }
2993 }
2995 # no C99 // comments
3004 }
3005 }
3006 }
3007 # Remove C99 comments.
3011 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3012 # the whole statement.
3013 #print "APW <$lines[$realline_next - 1]>\n";
3019 # Handle definitions which produce identifiers with
3020 # a prefix:
3021 # XXX(foo);
3022 # EXPORT_SYMBOL(something_foo);
3026 #print "FOO C name<$name>\n";
3037 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3041 }
3042 }
3047 #print "FOO B <$lines[$linenr - 1]>\n";
3049 }
3054 }
3056 # check for global initialisers.
3063 }
3064 }
3065 # check for static initialisers.
3072 }
3073 }
3075 # check for misordered declarations of char/short/int/long with signed/unsigned
3079 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3080 }
3082 # check for static const char * arrays.
3087 }
3089 # check for static char foo[] = "bar" declarations.
3094 }
3096 # check for non-global char *foo[] = {"bar", ...} declarations.
3101 }
3103 # check for function declarations without arguments like "int foo()"
3109 }
3110 }
3112 # check for uses of DEFINE_PCI_DEVICE_TABLE
3117 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3118 }
3119 }
3121 # check for new typedefs, only function parameters and sparse annotations
3122 # make sense.
3130 }
3132 # * goes on variable not on type
3133 # (char*[ const])
3135 #print "AA<$1>\n";
3138 # Should start with a space.
3140 # Should not end with a space.
3142 # '*'s should not have spaces between.
3144 }
3146 ## print "1: from<$from> to<$to> ident<$ident>\n";
3156 }
3157 }
3158 }
3160 #print "BB<$1>\n";
3163 # Should start with a space.
3165 # Should not end with a space.
3167 # '*'s should not have spaces between.
3169 }
3170 # Modifiers should have spaces.
3173 ## print "2: from<$from> to<$to> ident<$ident>\n";
3184 }
3185 }
3186 }
3188 # # no BUG() or BUG_ON()
3189 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
3190 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3191 # print "$herecurr";
3192 # $clean = 0;
3193 # }
3197 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3198 }
3200 # check for uses of printk_ratelimit
3204 }
3206 # printk should use KERN_* levels. Note that follow on printk's on the
3207 # same line do not need a level, so we use the current block context
3208 # to try and find and validate the current printk. In summary the current
3209 # printk includes all preceding printk's which have no newline on the end.
3210 # we assume the first bad printk is the one to report.
3214 #print "CHECK<$lines[$ln - 1]\n";
3215 # we have a preceding printk if it ends
3216 # with "\n" ignore it, else it is to blame
3220 }
3222 }
3223 }
3227 }
3228 }
3237 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3238 }
3246 }
3247 }
3256 }
3258 # function brace can't be on same line, except for #defines of do while,
3259 # or if closed on same line
3274 }
3275 }
3276 }
3278 # open braces for enum, union and struct go on the same line.
3292 }
3293 }
3294 }
3296 # missing space after union, struct or enum definition
3303 }
3304 }
3306 # Function pointer declarations
3307 # check spacing between type, funcptr, and args
3308 # canonical declaration is "type (*funcptr)(args...)"
3317 # the $Declare variable will capture all spaces after the type
3318 # so check it for a missing trailing missing space but pointer return types
3319 # don't need a space so don't warn for those.
3324 }
3329 }
3331 # unnecessary space "type (*funcptr)(args...)"
3332 # This test is not currently implemented because these declarations are
3333 # equivalent to
3334 # int foo(int bar, ...)
3335 # and this is form shouldn't/doesn't generate a checkpatch warning.
3336 #
3337 # elsif ($declare =~ /\s{2,}$/) {
3338 # WARN("SPACING",
3339 # "Multiple spaces after return type\n" . $herecurr);
3340 # }
3342 # unnecessary space "type ( *funcptr)(args...)"
3347 }
3349 # unnecessary space "type (* funcptr)(args...)"
3354 }
3356 # unnecessary space "type (*funcptr )(args...)"
3361 }
3363 # unnecessary space "type (*funcptr) (args...)"
3368 }
3372 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3373 }
3374 }
3376 # check for spacing round square brackets; allowed:
3377 # 1. with a type on the left -- int [] a;
3378 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3379 # 3. inside a curly brace -- = { [0...10] = 5 }
3390 }
3391 }
3392 }
3394 # check for spaces between functions and their parentheses.
3400 # Ignore those directives where spaces _are_ permitted.
3406 {
3407 # cpp #define statements have non-optional spaces, ie
3408 # if there is a space between the name and the open
3409 # parenthesis it is simply not a parameter group.
3412 # cpp #elif statement condition may start with a (
3415 # If this whole things ends with a type its most
3416 # likely a typedef for a function.
3425 }
3426 }
3427 }
3429 # Check operator spacing.
3435 <<=|>>=|<=|>=|==|!=|
3437 =>|->|<<|>>|<|>|=|!|~|
3443 ## print("element count: <" . $#elements . ">\n");
3444 ## foreach my $el (@elements) {
3445 ## print("el: <$el>\n");
3446 ## }
3454 }
3465 ## print("n: <$n> good: <$good>\n");
3469 # Pick up the preceding and succeeding characters.
3474 }
3497 }
3506 # Pull out the value of this operator.
3509 # Get the full operator variant.
3512 # Ignore operators passed as parameters.
3516 # # Ignore comments
3517 # } elsif ($op =~ /^$;+$/) {
3519 # ; should have either the end of line or a space or \ after it
3527 }
3528 }
3530 # // is a comment
3533 # : when part of a bitfield
3535 # skip the bitfield test for now
3537 # No spaces for:
3538 # ->
3546 }
3548 }
3549 }
3551 # , must not have a space before and must have a space on the right.
3560 }
3561 }
3568 }
3569 }
3575 }
3578 }
3579 }
3581 # '*' as part of a type definition -- reported already.
3583 #warn "'*' is part of type\n";
3585 # unary operators should have a space before and
3586 # none after. May be left adjacent to another
3587 # unary operator, or a cast
3597 }
3598 }
3599 }
3601 # A unary '*' may be const
3609 }
3611 }
3612 }
3614 # unary ++ and unary -- are allowed no space on one side.
3621 }
3622 }
3629 }
3630 }
3637 }
3639 }
3640 }
3642 # << and >> may either have or not have spaces both sides
3648 {
3655 }
3657 }
3658 }
3660 # A colon needs no spaces before when it is
3661 # terminating a case value or a label.
3668 }
3669 }
3671 # All the others need spaces both sides.
3675 # Ignore email addresses <foo@bar>
3680 {
3682 }
3684 # messages are ERROR, but ?: are CHK
3694 }
3696 }
3697 }
3698 }
3701 ## print("n: <$n> GOOD: <$good>\n");
3704 }
3708 }
3712 }
3715 }
3717 # check for whitespace before a non-naked semicolon
3724 }
3725 }
3727 # check for multiple assignments
3731 }
3733 ## # check for multiple declarations, allowing for a function declaration
3734 ## # continuation.
3735 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
3736 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
3737 ##
3738 ## # Remove any bracketed sections to ensure we do not
3739 ## # falsly report the parameters of functions.
3740 ## my $ln = $line;
3741 ## while ($ln =~ s/\([^\(\)]*\)//g) {
3742 ## }
3743 ## if ($ln =~ /,/) {
3744 ## WARN("MULTIPLE_DECLARATION",
3745 ## "declaring multiple variables together should be avoided\n" . $herecurr);
3746 ## }
3747 ## }
3749 #need space before brace following if, while, etc
3756 }
3757 }
3759 ## # check for blank lines before declarations
3760 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
3761 ## $prevrawline =~ /^.\s*$/) {
3762 ## WARN("SPACING",
3763 ## "No blank lines before declarations\n" . $hereprev);
3764 ## }
3765 ##
3767 # closing brace should have a space following it when it has anything
3768 # on the line
3775 }
3776 }
3778 # check spacing on square brackets
3785 }
3786 }
3793 }
3794 }
3796 # check spacing on parentheses
3804 }
3805 }
3814 }
3815 }
3817 # check unnecessary parentheses around addressof/dereference single $Lvals
3818 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
3826 }
3827 }
3829 # check for unnecessary parentheses around function pointer uses
3830 # ie: (foo->bar)(); should be foo->bar();
3831 # but not "if (foo->bar) (" to avoid some false positives
3840 }
3841 }
3843 #goto labels aren't indented, allow a single space however
3851 }
3852 }
3854 # return is not a function
3864 }
3868 }
3869 }
3871 # unnecessary return in a void function
3872 # at end-of-function, with the previous line a single leading tab, then return;
3873 # and the line before that not a goto label target like "out:"
3881 }
3883 # if statements using unnecessary parentheses - ie: if ((foo == bar))
3889 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
3894 }
3895 }
3897 # Return of what appears to be an errno should normally be -'ve
3903 }
3904 }
3906 # Need a space before open parenthesis after if, while etc
3913 }
3914 }
3916 # Check for illegal assignment in if conditional -- and check for trailing
3917 # statements after the conditional.
3925 ##print "stat<$stat> stat_next<$stat_next>\n";
3928 # If the statement carries leading newlines,
3929 # then count those as offsets.
3937 }
3938 }
3947 }
3949 # Find out what is on the end of the line after the
3950 # conditional.
3956 {
3957 # Find out how long the conditional actually is.
3966 }
3970 }
3971 }
3973 # Check for bitwise tests written as boolean
3979 |
3984 {
3987 }
3989 # if and else should not have general statements after it
3996 }
3997 }
3998 # if should not continue a brace
4003 }
4004 # case and default should not have general statements after them
4010 {
4013 }
4015 # Check for }<nl>else {, these must be at the same
4016 # indent level to be relevant to each other.
4028 }
4032 }
4033 }
4039 # Find out what is on the end of the line after the
4040 # conditional.
4056 }
4057 }
4058 }
4060 #Specific variable tests
4064 #gcc binary extension
4072 }
4073 }
4075 #CamelCase
4078 #Ignore Page<foo> variants
4080 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4082 #Ignore some three character SI units explicitly, like MiB and KHz
4088 seed_camelcase_includes();
4092 }
4093 }
4098 }
4099 }
4100 }
4101 }
4103 #no spaces allowed after \ in define
4109 }
4110 }
4112 #warn if <asm/foo.h> is #included and <linux/foo.h> is available (uses RAW line)
4119 {
4126 }
4127 }
4128 }
4130 # multi-statement macros should be enclosed in a do while loop, grab the
4131 # first statement and ensure its the whole macro if its not enclosed
4132 # in a known good container
4144 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4145 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4156 # Flatten any parentheses and braces
4160 {
4161 }
4163 # Flatten any obvious string concatentation.
4166 {
4167 }
4171 module_param_named|
4172 MODULE_PARM_DESC|
4173 DECLARE_PER_CPU|
4174 DEFINE_PER_CPU|
4175 __typeof__\(|
4176 union|
4177 struct|
4181 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4185 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4190 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4196 {
4203 }
4211 }
4212 }
4214 # check for macros with flow control, but without ## concatenation
4215 # ## concatenation is commonly a macro that defines a function so ignore those
4222 }
4225 }
4227 # check for line continuations outside of #defines, preprocessor #, and asm
4236 }
4237 }
4239 # do {} while (0) macro tests:
4240 # single-statement macros do not need to be enclosed in do while (0) loop,
4241 # macro should not end with a semicolon
4255 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4265 }
4271 }
4275 }
4283 }
4287 }
4288 }
4290 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4291 # all assignments may have only one of the following with an assignment:
4292 # .
4293 # ALIGN(...)
4294 # VMLINUX_SYMBOL(...)
4298 }
4300 # check for redundant bracing round if etc
4304 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4305 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4315 # If the condition carries leading newlines, then count those as offsets.
4320 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4322 # We have looked at and allowed this specific line.
4332 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4334 #print "APW: ALLOWED: cond<$cond>\n";
4336 }
4338 #print "APW: ALLOWED: block<$block>\n";
4340 }
4342 #print "APW: ALLOWED: lines block<$block>\n";
4344 }
4346 }
4351 }
4359 }
4360 }
4361 }
4362 }
4367 # Check the pre-context.
4369 #print "APW: ALLOWED: pre<$1>\n";
4371 }
4376 # Check the condition.
4378 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4381 }
4383 #print "APW: ALLOWED: cond<$cond>\n";
4385 }
4387 #print "APW: ALLOWED: block<$block>\n";
4389 }
4391 #print "APW: ALLOWED: lines block<$block>\n";
4393 }
4394 # Check the post-context.
4399 }
4401 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4403 }
4404 }
4411 }
4415 }
4416 }
4418 # check for unnecessary blank lines around braces
4422 }
4426 }
4428 # no volatiles please
4432 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4433 }
4435 # Check for user-visible strings broken across lines, which breaks the ability
4436 # to grep for the string. Make exceptions when the previous string ends in a
4437 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4438 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4451 }
4463 }
4465 }
4466 }
4468 # check for missing a space in a string concatenation
4472 }
4474 # check for spaces before a quoted newline
4480 }
4482 }
4484 # concatenated string without spaces between elements
4488 }
4490 # uncoalesced string fragments
4494 }
4496 # check for %L{u,d,i} in strings
4505 }
4506 }
4508 # check for line continuations in quoted strings with odd counts of "
4512 }
4514 # warn about #if 0
4519 }
4521 # check for needless "if (<foo>) fn(<foo>)" uses
4527 }
4528 }
4530 # check for unnecessary "Out of Memory" messages
4539 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4541 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4544 }
4545 }
4547 # check for logging functions with KERN_<LEVEL>
4555 }
4556 }
4558 # check for mask then right shift without a parentheses
4564 }
4566 # check for pointer comparisons to NULL
4576 }
4577 }
4578 }
4580 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4583 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4593 $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;
4594 }
4595 }
4596 }
4598 # check for $InitAttributeData (ie: __initdata) with const
4609 }
4610 }
4612 # check for $InitAttributeConst (ie: __initconst) without const
4624 }
4625 }
4627 # don't use __constant_<foo> functions outside of include/uapi/
4629 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4637 }
4638 }
4640 # prefer usleep_range over udelay
4643 # ignore udelay's < 10, however
4646 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4647 }
4651 }
4652 }
4654 # warn about unexpectedly long msleep's
4658 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4659 }
4660 }
4662 # check for comparisons of jiffies
4665 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4666 }
4668 # check for comparisons of get_jiffies_64()
4671 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4672 }
4674 # warn about #ifdefs in C files
4675 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4676 # print "#ifdef in C files should be avoided\n";
4677 # print "$herecurr";
4678 # $clean = 0;
4679 # }
4681 # warn about spacing in #ifdefs
4688 }
4690 }
4692 # check for spinlock_t definitions without a comment.
4699 }
4700 }
4701 # check for memory barriers without a comment.
4702 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
4706 }
4707 }
4708 # check of hardware specific defines
4709 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
4712 }
4714 # Check that the storage class is at the beginning of a declaration
4718 }
4720 # check the location of the inline attribute, that it is between
4721 # storage class and type.
4726 }
4728 # Check for __inline__ and __inline, prefer inline
4736 }
4737 }
4739 # Check for __attribute__ packed, prefer __packed
4744 }
4746 # Check for __attribute__ aligned, prefer __aligned
4751 }
4753 # Check for __attribute__ format(printf, prefer __printf
4757 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
4759 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
4761 }
4762 }
4764 # Check for __attribute__ format(scanf, prefer __scanf
4768 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
4770 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
4771 }
4772 }
4774 # Check for __attribute__ weak, or __weak declarations (may have link issues)
4776 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
4781 }
4783 # check for sizeof(&)
4787 }
4789 # check for sizeof without parenthesis
4794 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
4795 }
4796 }
4798 # check for struct spinlock declarations
4802 }
4804 # check for seq_printf uses that could be seq_puts
4812 }
4813 }
4814 }
4816 # Check for misused memsets
4831 }
4832 }
4834 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
4838 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . $herecurr) &&
4840 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
4841 }
4842 }
4844 # typecasts on min/max could be min_t/max_t
4862 }
4865 }
4866 }
4868 # check usleep_range arguments
4876 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4880 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
4881 }
4882 }
4884 # check for naked sscanf
4896 }
4899 }
4901 # check for simple sscanf that should be kstrto<foo>
4910 }
4918 }
4919 }
4920 }
4922 # check for new externs in .h files.
4929 }
4930 }
4932 # check for new externs in .c files.
4935 {
4942 }
4945 {
4948 }
4953 }
4957 {
4960 }
4962 # checks for new __setup's
4969 }
4970 }
4972 # check for pointless casting of kmalloc return
4975 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
4976 }
4978 # alloc style
4979 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
4981 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
4984 }
4986 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
4988 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
4999 }
5005 $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;
5007 }
5008 }
5009 }
5011 # check for krealloc arg reuse
5016 }
5018 # check for alloc argument mismatch
5022 }
5024 # check for multiple semicolons
5030 }
5031 }
5033 # check for #defines like: 1 << <digit> that could be BIT(digit)
5041 }
5042 }
5044 # check for case / default statements not preceded by break/fallthrough/switch
5062 }
5066 }
5067 }
5069 # check for switch/default statements without a break;
5078 }
5081 }
5083 # check for gcc specific __FUNCTION__
5089 }
5090 }
5092 # check for use of yield()
5096 }
5098 # check for comparisons against true and false
5114 }
5119 ## maybe suggesting a correct construct would better
5120 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5122 }
5123 }
5125 # check for semaphores initialized locked
5129 }
5131 # recommend kstrto* over simple_strto* and strict_strto*
5135 }
5137 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5140 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5141 }
5143 # check for various ops structs, ensure they are const.
5145 address_space_operations|
5146 backlight_ops|
5147 block_device_operations|
5148 dentry_operations|
5149 dev_pm_ops|
5150 dma_map_ops|
5151 extent_io_ops|
5152 file_lock_operations|
5153 file_operations|
5154 hv_ops|
5155 ide_dma_ops|
5156 intel_dvo_dev_ops|
5157 item_operations|
5158 iwl_ops|
5159 kgdb_arch|
5160 kgdb_io|
5161 kset_uevent_ops|
5162 lock_manager_operations|
5163 microcode_ops|
5164 mtrr_ops|
5165 neigh_ops|
5166 nlmsvc_binding|
5167 pci_raw_ops|
5168 pipe_buf_operations|
5169 platform_hibernation_ops|
5170 platform_suspend_ops|
5171 proto_ops|
5172 rpc_pipe_ops|
5173 seq_operations|
5174 snd_ac97_build_ops|
5175 soc_pcmcia_socket_ops|
5176 stacktrace_ops|
5177 sysfs_ops|
5178 tty_operations|
5179 usb_mon_operations|
5186 }
5188 # use of NR_CPUS is usually wrong
5189 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5196 {
5198 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5199 }
5201 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5205 }
5207 # whine mightly about in_atomic
5215 }
5216 }
5218 # check for lockdep_set_novalidate_class
5226 }
5227 }
5232 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5233 }
5235 # Mode permission misuses where it seems decimal should be octal
5236 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5247 }
5258 }
5259 }
5260 }
5261 }
5262 }
5264 # If we have no input at all, then there is nothing to report on
5265 # so just keep quiet.
5268 }
5270 # In mailback mode only produce a report in the negative, for
5271 # things that appear to be patches.
5274 }
5276 # This is not a patch, and we are are in 'no-patch' mode so
5277 # just keep quiet.
5280 }
5285 }
5289 }
5298 }
5305 }
5307 # If there were whitespace errors which cleanpatch can fix
5308 # then suggest that.
5313 }
5314 }
5337 }
5340 }
5341 }
5348 Do _NOT_ trust the results written to this file.
5351 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5354 EOM
5355 }
5356 }
5360 }
5365 If any of these errors are false positives, please report
5367 EOM
5368 }
5371 }