| blob | 0147c91fa549e6ab46b68c47b46425b272c37571 |
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
63 Options:
68 --emacs emacs compile window format
69 --terse one line per report
84 is all off)
86 literally
89 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
90 with potential errors corrected to the preferred
91 checkpatch style
96 runtime errors.
99 --codespellfile Use this codespell dictionary
104 EOM
107 }
129 }
130 }
133 }
135 GetOptions(
178 }
179 }
184 }
200 }
201 }
210 }
212 }
213 }
223 ## no critic
226 }
233 }
239 }
246 }
247 }
252 }
253 }
263 __user|
264 __kernel|
265 __force|
266 __iomem|
267 __pmem|
268 __must_check|
269 __init_refok|
270 __kprobes|
271 __ref|
272 __rcu
280 # Notes to $Attribute:
281 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
283 const|
284 __percpu|
285 __nocast|
286 __safe|
287 __bitwise__|
288 __packed__|
289 __packed2__|
290 __naked|
291 __maybe_unused|
292 __always_unused|
293 __noreturn|
294 __used|
295 __cold|
296 __pure|
297 __noclone|
298 __deprecated|
299 __read_mostly|
300 __kprobes|
302 ____cacheline_aligned|
303 ____cacheline_aligned_in_smp|
304 ____cacheline_internodealigned_in_smp|
305 __weak
327 <=|>=|==|!=|
328 =>|->|<<|>>|<|>|!|~|
362 )};
365 atomic_t
366 )};
371 )};
377 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
379 panic|
382 )};
391 To:|
392 Cc:
393 )};
412 );
435 );
456 )};
463 );
467 );
474 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
477 );
479 #Create a search pattern for all these functions to speed up a loop below
484 }
487 S_IWUGO |
488 S_IWOTH |
489 S_IRWXUGO |
490 S_IALLUGO |
495 irq|
496 memory|
498 reboot
499 )};
500 # memory.h: ARM has a custom one
502 # Load common spelling mistakes and build regular expression list.
519 }
523 }
542 }
546 }
547 }
567 )
574 )
583 )
587 $NonptrType
592 $NonptrTypeMisordered
598 }
599 build_types();
603 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
604 # requires at least perl version v5.10.0
605 # Any use must be runtime checked with $^V
615 )};
624 }
629 }
653 }
654 }
655 }
679 }
681 }
689 }
693 }
698 }
702 }
710 }
712 }
713 }
727 # Maybe one day convert this block of bash into something that returns
728 # all matching commit ids, but it's very slow...
729 #
730 # echo "checking commits $1..."
731 # git rev-list --remotes | grep -i "^$1" |
732 # while read line ; do
733 # git log --format='%H %s' -1 $line |
734 # echo "commit $(cut -c 1-12,41-)"
735 # done
736 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
740 }
743 }
765 }
770 }
774 }
781 }
785 }
794 build_types();
795 }
806 EOM
807 }
813 EOM
814 }
815 }
826 );
831 }
832 }
834 }
857 # If there's a name left after stripping spaces and
858 # leading quotes, and the address doesn't have both
859 # leading and trailing angle brackets, the address
860 # is invalid. ie:
861 # "joe smith joe@smith.com" bad
862 # "joe smith <joe@smith.com" bad
867 }
868 }
878 }
881 }
895 }
901 }
904 }
912 }
913 }
916 }
924 }
925 }
928 }
941 }
943 }
946 }
949 }
953 }
958 # Drop the diff line leader and expand tabs
962 # Pick the indent from the front of the line.
966 }
977 }
978 }
989 # Always copy over the diff marker.
995 # Comments we are wacking completly including the begin
996 # and end, all to $;.
1003 }
1009 }
1016 }
1018 # A \ in a string means ignore the next character.
1024 }
1025 # Regular quotes.
1034 }
1035 }
1037 #print "c<$c> SQ<$sanitise_quote>\n";
1046 }
1047 }
1051 }
1053 # The pathname on a #include may be surrounded by '<' and '>'.
1058 # The whole of a #error is a string.
1062 }
1065 }
1072 }
1095 #warn "CSB: blk<$blk> remain<$remain>\n";
1096 # If we are about to drop off the end, pull in more
1097 # context.
1108 }
1109 # Bail if there is no further context.
1110 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1113 }
1117 }
1118 }
1123 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1125 # Handle nested #if/#else.
1132 }
1134 # Statement ends at the ';' or a close '}' at the
1135 # outermost level.
1138 }
1140 # An else is really a conditional as long as its not else if
1147 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1148 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1149 }
1154 }
1162 #warn "CSB: mark coff<$coff>\n";
1163 }
1164 }
1168 }
1176 }
1178 }
1179 }
1180 # Preprocessor commands end at the newline unless escaped.
1186 }
1188 }
1189 # We are truly at the end, so shuffle to the next line.
1194 }
1199 #warn "STATEMENT<$statement>\n";
1200 #warn "CONDITION<$condition>\n";
1202 #print "coff<$coff> soff<$off> loff<$loff>\n";
1206 }
1211 # Strip the diff line prefixes and rip blank lines at start and end.
1219 }
1227 }
1248 }
1249 }
1257 # Grab the first conditional/block pair.
1260 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1264 }
1266 # Pull in the following conditional/block pairs and see if they
1267 # could continue the statement.
1271 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1273 #print "C: push\n";
1275 }
1278 }
1297 # Handle nested #if/#else.
1304 }
1307 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1311 }
1318 }
1319 }
1323 }
1326 }
1329 }
1335 }
1341 }
1347 }
1352 }
1357 }
1362 # Catch a comment on the end of the line itself.
1366 # Look through the context and try and figure out if there is a
1367 # comment.
1372 #warn " $line\n";
1375 }
1378 }
1381 }
1385 }
1386 }
1390 }
1395 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1396 ##print "CMMT: $cmt\n";
1399 }
1412 }
1415 }
1427 }
1428 }
1432 }
1444 }
1464 }
1485 }
1514 # Assume all arms of the conditional end as this
1515 # one does, and continue as if the #endif was not here.
1532 }
1563 }
1575 }
1608 }
1623 }
1632 }
1636 }
1640 }
1641 }
1644 }
1653 DEFINE_\S+
1654 )$|
1658 case|
1662 \#|
1663 \#\#|
1669 # Check for modifiers.
1680 }
1681 }
1686 }
1687 build_types();
1690 }
1691 }
1701 }
1709 }
1718 }
1719 }
1724 }
1732 }
1738 }
1742 }
1753 }
1754 }
1781 }
1787 }
1794 }
1799 }
1802 }
1805 }
1813 };
1815 }
1823 };
1826 }
1835 }
1837 }
1845 }
1847 }
1855 }
1857 }
1863 ##print "absolute<$absolute>\n";
1865 # See if any suffix of this path is a path within the tree.
1868 ##print "file<$file>\n";
1870 }
1871 }
1874 }
1876 # It is, so see if the prefix is acceptable.
1880 ##print "prefix<$prefix>\n";
1884 }
1885 }
1893 }
1901 }
1909 }
1917 }
1926 #convert leading spaces to tabs
1928 #Remove spaces before a tab
1932 }
1946 }
1958 }
1959 }
1962 }
1998 # Trace the real file/line as we go.
2010 # suppression flags
2018 # Pre-scan the patch sanitizing the lines.
2019 # Pre-scan the patch looking for any __setup documentation.
2020 #
2026 sanitise_line_reset();
2038 }
2039 #next;
2040 }
2047 }
2050 # Guestimate if this is a continuing comment. Run
2051 # the context looking for a comment "edge". If this
2052 # edge is a close comment then we must be in a comment
2053 # at context start.
2060 #print "RAW<$rawlines[$ln - 1]>\n";
2066 }
2067 }
2070 }
2072 # Guestimate if this is a continuing comment. If this
2073 # is the start of a diff block and this line starts
2074 # ' *' then it is very likely a comment.
2077 {
2079 }
2081 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2085 # Standardise the strings and chars within the input to
2086 # simplify matching -- only bother with positive lines.
2088 }
2095 }
2097 #print "==>$rawline\n";
2098 #print "-->$line\n";
2102 }
2103 }
2118 #extract the line range in the file after the patch is applied
2128 }
2129 annotate_reset();
2138 # track the line number as we move through the hunk, note that
2139 # new versions of GNU diff omit the leading space on completely
2140 # blank context lines so we need to count that too.
2145 # Measure the line length and indent.
2148 # Track the previous line.
2153 #warn "line<$line>\n";
2157 }
2165 # extract the filename as it passes
2181 }
2185 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2186 }
2188 }
2190 #make up the handle for any error we report on this line
2198 }
2199 }
2206 }
2208 }
2218 # Check if the commit log has what seems like a diff which can confuse patch
2227 }
2229 # Check for incorrect file permissions
2236 }
2237 }
2239 # Check the patch for a signoff:
2243 }
2245 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2246 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2249 }
2251 # Check signature styles
2263 }
2270 }
2271 }
2278 }
2280 }
2287 }
2288 }
2299 # Don't force email to have quotes
2300 # Allow just an angle bracketed address
2306 }
2307 }
2309 # Check for duplicate signatures
2318 }
2319 }
2321 # Check email subject for common tools that don't need to be mentioned
2326 }
2328 # Check for old stable address
2332 }
2334 # Check for unwanted Gerrit info
2338 }
2340 # Check if the commit log is in a possible stack dump
2344 # timestamp
2346 # stack dump address
2348 }
2350 # Check for line lengths > 75 in commit log, warn once
2354 # file delta changes
2356 # filename then :
2358 # A Fixes: or Link: line
2363 }
2365 # Reset possible stack dump if a blank line is found
2369 }
2371 # Check for git id commit length and improperly formed commit descriptions
2394 }
2416 }
2423 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2424 }
2425 }
2427 # Check for added, moved or deleted files
2436 }
2438 # Check for wrappage within a valid hunk of the file
2443 }
2445 # Check for absolute kernel paths.
2452 #
2455 }
2456 }
2457 }
2459 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2470 }
2472 # Check if it's the start of a commit log
2473 # (not a header line and we haven't seen the patch filename)
2479 }
2481 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2482 # declined it, i.e defined some charset where it is missing.
2487 }
2493 }
2495 # Check for various typo / spelling mistakes
2509 }
2510 }
2511 }
2513 # ignore non-hunk lines and lines being removed
2516 #trailing whitespace
2523 }
2530 }
2533 }
2535 # Check for FSF mailing addresses.
2543 "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)
2544 }
2546 # check for Kconfig help text having a real description
2547 # Only applies when adding the entry originally, after that we do not have
2548 # sufficient context to determine whether it is indeed long enough.
2569 }
2578 }
2580 }
2584 }
2585 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2586 }
2588 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2592 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2593 }
2595 # discourage the use of boolean for type definition attributes of Kconfig options
2600 }
2610 };
2613 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2614 }
2616 # check for DT compatible documentation
2635 }
2642 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2643 }
2644 }
2645 }
2647 # check we are in a valid source file if not then ignore this hunk
2650 # line length limit (with some exclusions)
2651 #
2652 # There are a few types of lines that may extend beyond $max_line_length:
2653 # logging functions like pr_info that end in a string
2654 # lines with a single string
2655 # #defines that are a single string
2656 #
2657 # There are 3 different line length message types:
2658 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2659 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2660 # LONG_LINE all other lines longer than $max_line_length
2661 #
2662 # if LONG_LINE is ignored, the other 2 types are also ignored
2663 #
2668 # Check the allowed long line types first
2670 # logging functions that end in a string that starts
2671 # before $max_line_length
2672 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2676 # lines with only strings (w/ possible termination)
2677 # #defines with only strings
2682 # Otherwise set the alternate message types
2684 # a comment starts before $max_line_length
2689 # a quoted string starts before $max_line_length
2693 }
2699 }
2700 }
2702 # check for adding lines without a newline.
2703 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2706 }
2708 # Blackfin: use hi/lo macros
2714 }
2719 }
2720 }
2722 # check we are in a valid source file C or perl if not then ignore this hunk
2725 # at the beginning of a line any tabs must come first and anything
2726 # more than 8 must use tabs.
2735 }
2736 }
2738 # check for space before tabs.
2748 }
2749 }
2751 # check for && or || at the start of a line
2755 }
2757 # check multi-line statement indentation matches previous line
2759 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2782 }
2783 }
2784 }
2785 }
2787 # check for space after cast like "(int) foo" or "(struct foo) bar"
2788 # avoid checking a few false positives:
2789 # "sizeof(<type>)" or "__alignof__(<type>)"
2790 # function pointer declarations like "(*foo)(int) = bar;"
2791 # structure definitions like "(struct foo) { 0 };"
2792 # multiline macros that define functions
2793 # known attributes or the __attribute__ keyword
2801 }
2802 }
2804 # Block comment styles
2805 # Networking with an initial /*
2812 }
2814 # Block comments use * on subsequent lines
2822 }
2824 # Block comments use */ on trailing lines
2831 }
2833 # check for missing blank lines after struct/union declarations
2834 # with exceptions for various attributes and macros
2849 }
2850 }
2852 # check for multiple consecutive blank lines
2860 }
2863 }
2865 # check for missing blank lines after declarations
2867 # actual declarations
2869 # function pointer declarations
2871 # foo bar; where foo is some local typedef or #define
2873 # known declaration macros
2875 # for "else if" which can look like "$Ident $Ident"
2877 # other possible extensions of declaration lines
2879 # not starting a section or a macro "\" extended line
2881 # looks like a declaration
2883 # function pointer declarations
2885 # foo bar; where foo is some local typedef or #define
2887 # known declaration macros
2889 # start of struct or union or enum
2891 # start or end of block or continuation of declaration
2893 # bitfield continuation
2895 # other possible extensions of declaration lines
2897 # indentation of previous and current line are the same
2903 }
2904 }
2906 # check for spaces at the beginning of a line.
2907 # Exceptions:
2908 # 1) within comments
2909 # 2) indented preprocessor commands
2910 # 3) hanging labels
2917 }
2918 }
2920 # check we are in a valid C source file if not then ignore this hunk
2923 # check indentation of any line with a bare else
2924 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2925 # if the previous line is a break or return and is indented 1 tab more...
2934 }
2935 }
2937 # check indentation of a line with a break;
2938 # if the previous line is a goto or return and is indented the same # of tabs
2944 }
2945 }
2947 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2950 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2951 }
2953 # check for RCS/CVS revision markers
2957 }
2959 # Blackfin: don't use __builtin_bfin_[cs]sync
2964 }
2969 }
2971 # check for old HOTPLUG __dev<foo> section markings
2975 }
2977 # Check for potential 'bare' types
2980 #print "LINE<$line>\n";
2988 #print "linenr<$linenr> <$stat>\n";
2989 # If this statement has no statement boundaries within
2990 # it there is no point in retrying a statement scan
2991 # until we hit end of it.
2994 #print "skip<$line_nr_next>\n";
2996 }
2998 # Find the real next line.
3004 }
3009 # Ignore goto labels.
3012 # Ignore functions being called
3017 # declarations always start with types
3018 } 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) {
3023 # definitions in global scope can only start with types
3026 }
3028 # any (foo ... *) is a pointer cast, and foo is a type
3031 }
3033 # Check for any sort of function declaration.
3034 # int foo(something bar, other baz);
3035 # void (*store_gdt)(x86_descr_ptr *);
3036 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3044 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3047 }
3048 }
3049 }
3051 }
3053 #
3054 # Checks which may be anchored in the context.
3055 #
3057 # Check for switch () and associated case and default
3058 # statements should be at the same indent.
3072 }
3073 }
3077 }
3078 }
3080 # if/while/etc brace do not go on next line, unless defining a do while loop,
3081 # or if that brace on the next line is for something else
3082 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3090 }
3101 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3104 }
3106 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3107 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3113 }
3117 {
3123 }
3124 }
3125 }
3127 # Check relative indent for conditionals and blocks.
3128 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3136 # remove inline comments
3140 # Find out how long the conditional actually is.
3144 # Make sure we remove the line prefixes as we have
3145 # none on the first line, and are going to readd them
3146 # where necessary.
3150 }
3152 # We want to check the first line inside the block
3153 # starting at the end of the conditional, so remove:
3154 # 1) any blank line termination
3155 # 2) any opening brace { on end of the line
3156 # 3) any do (...) {
3163 }
3167 }
3169 # Also ignore a loop construct at the end of a
3170 # preprocessor statement.
3174 }
3181 # If we see an #else/#elif then the code
3182 # is not linear.
3185 }
3187 # Ignore:
3188 # 1) blank lines, they should be at 0,
3189 # 2) preprocessor lines, and
3190 # 3) labels.
3198 }
3199 }
3200 }
3205 # Check if either of these lines are modified, else
3206 # this is not this patch's fault.
3210 }
3213 }
3215 #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";
3222 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3223 }
3224 }
3226 # Track the 'values' across context and added lines.
3236 }
3239 #ignore lines not being added
3242 # TEST: allow direct testing of the type matcher.
3250 }
3252 }
3253 # TEST: allow direct testing of the attribute matcher.
3261 }
3263 }
3265 # check for initialisation to aggregates open brace on the next line
3279 }
3280 }
3282 #
3283 # Checks which are anchored on the added line.
3284 #
3286 # check for malformed paths in #include statements (uses RAW line)
3292 }
3296 }
3297 }
3299 # no C99 // comments
3308 }
3309 }
3310 }
3311 # Remove C99 comments.
3315 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3316 # the whole statement.
3317 #print "APW <$lines[$realline_next - 1]>\n";
3323 # Handle definitions which produce identifiers with
3324 # a prefix:
3325 # XXX(foo);
3326 # EXPORT_SYMBOL(something_foo);
3330 #print "FOO C name<$name>\n";
3341 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3345 }
3346 }
3351 #print "FOO B <$lines[$linenr - 1]>\n";
3353 }
3358 }
3360 # check for global initialisers.
3366 }
3367 }
3368 # check for static initialisers.
3375 }
3376 }
3378 # check for misordered declarations of char/short/int/long with signed/unsigned
3382 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3383 }
3385 # check for static const char * arrays.
3390 }
3392 # check for static char foo[] = "bar" declarations.
3397 }
3399 # check for const <foo> const where <foo> is not a pointer or array type
3408 }
3409 }
3411 # check for non-global char *foo[] = {"bar", ...} declarations.
3416 }
3418 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3421 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3427 }
3428 }
3429 }
3431 # check for function declarations without arguments like "int foo()"
3437 }
3438 }
3440 # check for uses of DEFINE_PCI_DEVICE_TABLE
3445 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3446 }
3447 }
3449 # check for new typedefs, only function parameters and sparse annotations
3450 # make sense.
3458 }
3460 # * goes on variable not on type
3461 # (char*[ const])
3463 #print "AA<$1>\n";
3466 # Should start with a space.
3468 # Should not end with a space.
3470 # '*'s should not have spaces between.
3472 }
3474 ## print "1: from<$from> to<$to> ident<$ident>\n";
3484 }
3485 }
3486 }
3488 #print "BB<$1>\n";
3491 # Should start with a space.
3493 # Should not end with a space.
3495 # '*'s should not have spaces between.
3497 }
3498 # Modifiers should have spaces.
3501 ## print "2: from<$from> to<$to> ident<$ident>\n";
3512 }
3513 }
3514 }
3516 # avoid BUG() or BUG_ON()
3521 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3522 }
3524 # avoid LINUX_VERSION_CODE
3527 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3528 }
3530 # check for uses of printk_ratelimit
3534 }
3536 # printk should use KERN_* levels. Note that follow on printk's on the
3537 # same line do not need a level, so we use the current block context
3538 # to try and find and validate the current printk. In summary the current
3539 # printk includes all preceding printk's which have no newline on the end.
3540 # we assume the first bad printk is the one to report.
3544 #print "CHECK<$lines[$ln - 1]\n";
3545 # we have a preceding printk if it ends
3546 # with "\n" ignore it, else it is to blame
3550 }
3552 }
3553 }
3557 }
3558 }
3567 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3568 }
3576 }
3577 }
3586 }
3588 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3589 # number of false positives, but assembly files are not checked, so at
3590 # least the arch entry code will not trigger this warning.
3594 }
3596 # function brace can't be on same line, except for #defines of do while,
3597 # or if closed on same line
3612 }
3613 }
3614 }
3616 # open braces for enum, union and struct go on the same line.
3630 }
3631 }
3632 }
3634 # missing space after union, struct or enum definition
3641 }
3642 }
3644 # Function pointer declarations
3645 # check spacing between type, funcptr, and args
3646 # canonical declaration is "type (*funcptr)(args...)"
3655 # the $Declare variable will capture all spaces after the type
3656 # so check it for a missing trailing missing space but pointer return types
3657 # don't need a space so don't warn for those.
3662 }
3667 }
3669 # unnecessary space "type (*funcptr)(args...)"
3670 # This test is not currently implemented because these declarations are
3671 # equivalent to
3672 # int foo(int bar, ...)
3673 # and this is form shouldn't/doesn't generate a checkpatch warning.
3674 #
3675 # elsif ($declare =~ /\s{2,}$/) {
3676 # WARN("SPACING",
3677 # "Multiple spaces after return type\n" . $herecurr);
3678 # }
3680 # unnecessary space "type ( *funcptr)(args...)"
3685 }
3687 # unnecessary space "type (* funcptr)(args...)"
3692 }
3694 # unnecessary space "type (*funcptr )(args...)"
3699 }
3701 # unnecessary space "type (*funcptr) (args...)"
3706 }
3710 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3711 }
3712 }
3714 # check for spacing round square brackets; allowed:
3715 # 1. with a type on the left -- int [] a;
3716 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3717 # 3. inside a curly brace -- = { [0...10] = 5 }
3728 }
3729 }
3730 }
3732 # check for spaces between functions and their parentheses.
3738 # Ignore those directives where spaces _are_ permitted.
3744 {
3745 # cpp #define statements have non-optional spaces, ie
3746 # if there is a space between the name and the open
3747 # parenthesis it is simply not a parameter group.
3750 # cpp #elif statement condition may start with a (
3753 # If this whole things ends with a type its most
3754 # likely a typedef for a function.
3763 }
3764 }
3765 }
3767 # Check operator spacing.
3773 <<=|>>=|<=|>=|==|!=|
3775 =>|->|<<|>>|<|>|=|!|~|
3781 ## print("element count: <" . $#elements . ">\n");
3782 ## foreach my $el (@elements) {
3783 ## print("el: <$el>\n");
3784 ## }
3792 }
3803 ## print("n: <$n> good: <$good>\n");
3807 # Pick up the preceding and succeeding characters.
3812 }
3835 }
3844 # Pull out the value of this operator.
3847 # Get the full operator variant.
3850 # Ignore operators passed as parameters.
3854 # # Ignore comments
3855 # } elsif ($op =~ /^$;+$/) {
3857 # ; should have either the end of line or a space or \ after it
3865 }
3866 }
3868 # // is a comment
3871 # : when part of a bitfield
3873 # skip the bitfield test for now
3875 # No spaces for:
3876 # ->
3884 }
3886 }
3887 }
3889 # , must not have a space before and must have a space on the right.
3898 }
3899 }
3906 }
3907 }
3913 }
3916 }
3917 }
3919 # '*' as part of a type definition -- reported already.
3921 #warn "'*' is part of type\n";
3923 # unary operators should have a space before and
3924 # none after. May be left adjacent to another
3925 # unary operator, or a cast
3935 }
3936 }
3937 }
3939 # A unary '*' may be const
3947 }
3949 }
3950 }
3952 # unary ++ and unary -- are allowed no space on one side.
3959 }
3960 }
3967 }
3968 }
3975 }
3977 }
3978 }
3980 # << and >> may either have or not have spaces both sides
3986 {
3994 }
4000 }
4001 }
4008 }
4010 }
4011 }
4013 # A colon needs no spaces before when it is
4014 # terminating a case value or a label.
4021 }
4022 }
4024 # All the others need spaces both sides.
4028 # Ignore email addresses <foo@bar>
4033 {
4035 }
4037 # for asm volatile statements
4038 # ignore a colon with another
4039 # colon immediately before or after
4043 }
4045 # messages are ERROR, but ?: are CHK
4055 }
4057 }
4058 }
4059 }
4062 ## print("n: <$n> GOOD: <$good>\n");
4065 }
4069 }
4073 }
4076 }
4078 # check for whitespace before a non-naked semicolon
4085 }
4086 }
4088 # check for multiple assignments
4092 }
4094 ## # check for multiple declarations, allowing for a function declaration
4095 ## # continuation.
4096 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4097 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4098 ##
4099 ## # Remove any bracketed sections to ensure we do not
4100 ## # falsly report the parameters of functions.
4101 ## my $ln = $line;
4102 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4103 ## }
4104 ## if ($ln =~ /,/) {
4105 ## WARN("MULTIPLE_DECLARATION",
4106 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4107 ## }
4108 ## }
4110 #need space before brace following if, while, etc
4117 }
4118 }
4120 ## # check for blank lines before declarations
4121 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4122 ## $prevrawline =~ /^.\s*$/) {
4123 ## WARN("SPACING",
4124 ## "No blank lines before declarations\n" . $hereprev);
4125 ## }
4126 ##
4128 # closing brace should have a space following it when it has anything
4129 # on the line
4136 }
4137 }
4139 # check spacing on square brackets
4146 }
4147 }
4154 }
4155 }
4157 # check spacing on parentheses
4165 }
4166 }
4175 }
4176 }
4178 # check unnecessary parentheses around addressof/dereference single $Lvals
4179 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4187 }
4188 }
4190 # check for unnecessary parentheses around function pointer uses
4191 # ie: (foo->bar)(); should be foo->bar();
4192 # but not "if (foo->bar) (" to avoid some false positives
4201 }
4202 }
4204 #goto labels aren't indented, allow a single space however
4212 }
4213 }
4215 # return is not a function
4225 }
4229 }
4230 }
4232 # unnecessary return in a void function
4233 # at end-of-function, with the previous line a single leading tab, then return;
4234 # and the line before that not a goto label target like "out:"
4242 }
4244 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4250 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4255 }
4256 }
4258 # comparisons with a constant or upper case identifier on the left
4259 # avoid cases like "foo + BAR < baz"
4260 # only fix matches surrounded by parentheses to avoid incorrect
4261 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4282 }
4284 }
4285 }
4287 # Return of what appears to be an errno should normally be negative
4293 }
4294 }
4296 # Need a space before open parenthesis after if, while etc
4303 }
4304 }
4306 # Check for illegal assignment in if conditional -- and check for trailing
4307 # statements after the conditional.
4315 ##print "stat<$stat> stat_next<$stat_next>\n";
4318 # If the statement carries leading newlines,
4319 # then count those as offsets.
4327 }
4328 }
4337 }
4339 # Find out what is on the end of the line after the
4340 # conditional.
4346 {
4347 # Find out how long the conditional actually is.
4356 }
4360 }
4361 }
4363 # Check for bitwise tests written as boolean
4369 |
4374 {
4377 }
4379 # if and else should not have general statements after it
4386 }
4387 }
4388 # if should not continue a brace
4393 }
4394 # case and default should not have general statements after them
4400 {
4403 }
4405 # Check for }<nl>else {, these must be at the same
4406 # indent level to be relevant to each other.
4418 }
4422 }
4423 }
4429 # Find out what is on the end of the line after the
4430 # conditional.
4446 }
4447 }
4448 }
4450 #Specific variable tests
4454 #gcc binary extension
4462 }
4463 }
4465 #CamelCase
4468 #Ignore Page<foo> variants
4470 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4472 #Ignore some three character SI units explicitly, like MiB and KHz
4478 seed_camelcase_includes();
4482 }
4483 }
4488 }
4489 }
4490 }
4491 }
4493 #no spaces allowed after \ in define
4499 }
4500 }
4502 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4503 # itself <asm/foo.h> (uses RAW line)
4510 {
4519 }
4520 }
4521 }
4522 }
4524 # multi-statement macros should be enclosed in a do while loop, grab the
4525 # first statement and ensure its the whole macro if its not enclosed
4526 # in a known good container
4538 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4539 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4550 # Flatten any parentheses and braces
4554 {
4555 }
4557 # Flatten any obvious string concatentation.
4560 {
4561 }
4565 module_param_named|
4566 MODULE_PARM_DESC|
4567 DECLARE_PER_CPU|
4568 DEFINE_PER_CPU|
4569 __typeof__\(|
4570 union|
4571 struct|
4576 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4580 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4585 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4591 {
4598 }
4606 }
4607 }
4609 # check for macros with flow control, but without ## concatenation
4610 # ## concatenation is commonly a macro that defines a function so ignore those
4617 }
4620 }
4622 # check for line continuations outside of #defines, preprocessor #, and asm
4631 }
4632 }
4634 # do {} while (0) macro tests:
4635 # single-statement macros do not need to be enclosed in do while (0) loop,
4636 # macro should not end with a semicolon
4651 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4661 }
4667 }
4671 }
4679 }
4683 }
4684 }
4686 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4687 # all assignments may have only one of the following with an assignment:
4688 # .
4689 # ALIGN(...)
4690 # VMLINUX_SYMBOL(...)
4694 }
4696 # check for redundant bracing round if etc
4700 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4701 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4711 # If the condition carries leading newlines, then count those as offsets.
4716 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4718 # We have looked at and allowed this specific line.
4728 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4730 #print "APW: ALLOWED: cond<$cond>\n";
4732 }
4734 #print "APW: ALLOWED: block<$block>\n";
4736 }
4738 #print "APW: ALLOWED: lines block<$block>\n";
4740 }
4742 }
4747 }
4755 }
4756 }
4757 }
4758 }
4763 # Check the pre-context.
4765 #print "APW: ALLOWED: pre<$1>\n";
4767 }
4772 # Check the condition.
4774 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4777 }
4779 #print "APW: ALLOWED: cond<$cond>\n";
4781 }
4783 #print "APW: ALLOWED: block<$block>\n";
4785 }
4787 #print "APW: ALLOWED: lines block<$block>\n";
4789 }
4790 # Check the post-context.
4795 }
4797 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4799 }
4800 }
4807 }
4811 }
4812 }
4814 # check for unnecessary blank lines around braces
4820 }
4821 }
4827 }
4828 }
4830 # no volatiles please
4834 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4835 }
4837 # Check for user-visible strings broken across lines, which breaks the ability
4838 # to grep for the string. Make exceptions when the previous string ends in a
4839 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4840 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4853 }
4865 }
4867 }
4868 }
4870 # check for missing a space in a string concatenation
4874 }
4876 # check for spaces before a quoted newline
4882 }
4884 }
4886 # concatenated string without spaces between elements
4890 }
4892 # uncoalesced string fragments
4896 }
4898 # check for %L{u,d,i} and 0x%[udi] in strings
4907 }
4911 }
4912 }
4914 # check for line continuations in quoted strings with odd counts of "
4918 }
4920 # warn about #if 0
4925 }
4927 # check for needless "if (<foo>) fn(<foo>)" uses
4931 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
4943 }
4948 }
4951 }
4955 }
4956 }
4957 }
4958 }
4960 # check for unnecessary "Out of Memory" messages
4969 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4971 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4974 }
4975 }
4977 # check for logging functions with KERN_<LEVEL>
4985 }
4986 }
4988 # check for mask then right shift without a parentheses
4994 }
4996 # check for pointer comparisons to NULL
5006 }
5007 }
5008 }
5010 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5013 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5023 $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;
5024 }
5025 }
5026 }
5028 # check for $InitAttributeData (ie: __initdata) with const
5039 }
5040 }
5042 # check for $InitAttributeConst (ie: __initconst) without const
5054 }
5055 }
5057 # check for __read_mostly with const non-pointer (should just be const)
5064 }
5065 }
5067 # don't use __constant_<foo> functions outside of include/uapi/
5069 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5077 }
5078 }
5080 # prefer usleep_range over udelay
5083 # ignore udelay's < 10, however
5086 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5087 }
5091 }
5092 }
5094 # warn about unexpectedly long msleep's
5098 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5099 }
5100 }
5102 # check for comparisons of jiffies
5105 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5106 }
5108 # check for comparisons of get_jiffies_64()
5111 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5112 }
5114 # warn about #ifdefs in C files
5115 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5116 # print "#ifdef in C files should be avoided\n";
5117 # print "$herecurr";
5118 # $clean = 0;
5119 # }
5121 # warn about spacing in #ifdefs
5128 }
5130 }
5132 # check for spinlock_t definitions without a comment.
5139 }
5140 }
5141 # check for memory barriers without a comment.
5144 mb|
5145 rmb|
5146 wmb|
5147 read_barrier_depends
5150 mb__before_atomic|
5151 mb__after_atomic|
5152 store_release|
5153 load_acquire|
5154 store_mb|
5167 }
5168 }
5178 }
5180 # check for waitqueue_active without a comment.
5185 }
5186 }
5188 # Check for expedited grace periods that interrupt non-idle non-nohz
5189 # online CPUs. These expedited can therefore degrade real-time response
5190 # if used carelessly, and should be avoided where not absolutely
5191 # needed. It is always OK to use synchronize_rcu_expedited() and
5192 # synchronize_sched_expedited() at boot time (before real-time applications
5193 # start) and in error situations where real-time response is compromised in
5194 # any case. Note that synchronize_srcu_expedited() does -not- interrupt
5195 # other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5196 # Of course, nothing comes for free, and srcu_read_lock() and
5197 # srcu_read_unlock() do contain full memory barriers in payment for
5198 # synchronize_srcu_expedited() non-interruption properties.
5201 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5203 }
5205 # check of hardware specific defines
5206 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5209 }
5211 # Check that the storage class is at the beginning of a declaration
5215 }
5217 # check the location of the inline attribute, that it is between
5218 # storage class and type.
5223 }
5225 # Check for __inline__ and __inline, prefer inline
5233 }
5234 }
5236 # Check for __attribute__ packed, prefer __packed
5241 }
5243 # Check for __attribute__ aligned, prefer __aligned
5248 }
5250 # Check for __attribute__ format(printf, prefer __printf
5254 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5256 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5258 }
5259 }
5261 # Check for __attribute__ format(scanf, prefer __scanf
5265 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5267 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5268 }
5269 }
5271 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5273 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5278 }
5280 # check for c99 types like uint8_t used outside of uapi/
5294 }
5295 }
5296 }
5298 # check for cast of C90 native int or longer types constants
5313 }
5315 }
5316 }
5318 # check for sizeof(&)
5322 }
5324 # check for sizeof without parenthesis
5329 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5330 }
5331 }
5333 # check for struct spinlock declarations
5337 }
5339 # check for seq_printf uses that could be seq_puts
5348 }
5349 }
5350 }
5352 # Check for misused memsets
5367 }
5368 }
5370 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5375 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5377 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5378 }
5379 }
5381 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5386 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5387 }
5389 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5390 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5401 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5402 }
5407 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5408 }
5409 }
5410 }
5412 # typecasts on min/max could be min_t/max_t
5430 }
5433 }
5434 }
5436 # check usleep_range arguments
5444 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5448 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5449 }
5450 }
5452 # check for naked sscanf
5464 }
5467 }
5469 # check for simple sscanf that should be kstrto<foo>
5478 }
5486 }
5487 }
5488 }
5490 # check for new externs in .h files.
5497 }
5498 }
5500 # check for new externs in .c files.
5503 {
5510 }
5513 {
5516 }
5521 }
5525 {
5528 }
5530 # checks for new __setup's
5537 }
5538 }
5540 # check for pointless casting of kmalloc return
5543 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5544 }
5546 # alloc style
5547 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5549 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5552 }
5554 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5556 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5567 }
5573 $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;
5575 }
5576 }
5577 }
5579 # check for krealloc arg reuse
5584 }
5586 # check for alloc argument mismatch
5590 }
5592 # check for multiple semicolons
5598 }
5599 }
5601 # check for #defines like: 1 << <digit> that could be BIT(digit)
5609 }
5610 }
5612 # check for case / default statements not preceded by break/fallthrough/switch
5630 }
5634 }
5635 }
5637 # check for switch/default statements without a break;
5646 }
5649 }
5651 # check for gcc specific __FUNCTION__
5657 }
5658 }
5660 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5664 }
5666 # check for use of yield()
5670 }
5672 # check for comparisons against true and false
5688 }
5693 ## maybe suggesting a correct construct would better
5694 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5696 }
5697 }
5699 # check for semaphores initialized locked
5703 }
5705 # recommend kstrto* over simple_strto* and strict_strto*
5709 }
5711 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5714 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5715 }
5717 # check for various structs that are normally const (ops, kgdb, device_tree)
5719 acpi_dock_ops|
5720 address_space_operations|
5721 backlight_ops|
5722 block_device_operations|
5723 dentry_operations|
5724 dev_pm_ops|
5725 dma_map_ops|
5726 extent_io_ops|
5727 file_lock_operations|
5728 file_operations|
5729 hv_ops|
5730 ide_dma_ops|
5731 intel_dvo_dev_ops|
5732 item_operations|
5733 iwl_ops|
5734 kgdb_arch|
5735 kgdb_io|
5736 kset_uevent_ops|
5737 lock_manager_operations|
5738 microcode_ops|
5739 mtrr_ops|
5740 neigh_ops|
5741 nlmsvc_binding|
5742 of_device_id|
5743 pci_raw_ops|
5744 pipe_buf_operations|
5745 platform_hibernation_ops|
5746 platform_suspend_ops|
5747 proto_ops|
5748 rpc_pipe_ops|
5749 seq_operations|
5750 snd_ac97_build_ops|
5751 soc_pcmcia_socket_ops|
5752 stacktrace_ops|
5753 sysfs_ops|
5754 tty_operations|
5755 uart_ops|
5756 usb_mon_operations|
5763 }
5765 # use of NR_CPUS is usually wrong
5766 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5773 {
5775 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5776 }
5778 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5782 }
5784 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5789 }
5791 # whine mightly about in_atomic
5799 }
5800 }
5802 # check for lockdep_set_novalidate_class
5810 }
5811 }
5816 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5817 }
5819 # Mode permission misuses where it seems decimal should be octal
5820 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5831 }
5844 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5845 }
5846 }
5847 }
5848 }
5850 # validate content of MODULE_LICENSE against list from include/linux/module.h
5854 GPL|
5855 GPL\ v2|
5860 Proprietary
5865 }
5866 }
5867 }
5869 # If we have no input at all, then there is nothing to report on
5870 # so just keep quiet.
5873 }
5875 # In mailback mode only produce a report in the negative, for
5876 # things that appear to be patches.
5879 }
5881 # This is not a patch, and we are are in 'no-patch' mode so
5882 # just keep quiet.
5885 }
5890 }
5894 }
5902 }
5905 # If there were whitespace errors which cleanpatch can fix
5906 # then suggest that.
5913 EOM
5914 }
5915 }
5935 }
5938 }
5939 }
5947 Do _NOT_ trust the results written to this file.
5950 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5952 EOM
5953 }
5954 }
5962 }
5963 }
5965 }