| blob | f2a1131b2f8baf06f28e286d6b9203d4d1a873f6 |
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 )};
375 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
377 panic|
380 )};
389 To:|
390 Cc:
391 )};
410 );
433 );
439 );
443 );
450 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
453 );
455 #Create a search pattern for all these functions to speed up a loop below
460 }
463 S_IWUGO |
464 S_IWOTH |
465 S_IRWXUGO |
466 S_IALLUGO |
471 irq|
472 memory|
474 reboot
475 )};
476 # memory.h: ARM has a custom one
478 # Load common spelling mistakes and build regular expression list.
495 }
499 }
518 }
522 }
523 }
543 )
550 )
559 )
563 $NonptrType
568 $NonptrTypeMisordered
574 }
575 build_types();
579 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
580 # requires at least perl version v5.10.0
581 # Any use must be runtime checked with $^V
591 )};
600 }
605 }
629 }
630 }
631 }
655 }
657 }
665 }
669 }
674 }
678 }
686 }
688 }
689 }
703 # Maybe one day convert this block of bash into something that returns
704 # all matching commit ids, but it's very slow...
705 #
706 # echo "checking commits $1..."
707 # git rev-list --remotes | grep -i "^$1" |
708 # while read line ; do
709 # git log --format='%H %s' -1 $line |
710 # echo "commit $(cut -c 1-12,41-)"
711 # done
712 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
716 }
719 }
741 }
746 }
750 }
757 }
761 }
770 build_types();
771 }
782 EOM
783 }
789 EOM
790 }
791 }
802 );
807 }
808 }
810 }
833 # If there's a name left after stripping spaces and
834 # leading quotes, and the address doesn't have both
835 # leading and trailing angle brackets, the address
836 # is invalid. ie:
837 # "joe smith joe@smith.com" bad
838 # "joe smith <joe@smith.com" bad
843 }
844 }
854 }
857 }
871 }
877 }
880 }
888 }
889 }
892 }
900 }
901 }
904 }
917 }
919 }
922 }
925 }
929 }
934 # Drop the diff line leader and expand tabs
938 # Pick the indent from the front of the line.
942 }
953 }
954 }
965 # Always copy over the diff marker.
971 # Comments we are wacking completly including the begin
972 # and end, all to $;.
979 }
985 }
992 }
994 # A \ in a string means ignore the next character.
1000 }
1001 # Regular quotes.
1010 }
1011 }
1013 #print "c<$c> SQ<$sanitise_quote>\n";
1022 }
1023 }
1027 }
1029 # The pathname on a #include may be surrounded by '<' and '>'.
1034 # The whole of a #error is a string.
1038 }
1041 }
1048 }
1071 #warn "CSB: blk<$blk> remain<$remain>\n";
1072 # If we are about to drop off the end, pull in more
1073 # context.
1084 }
1085 # Bail if there is no further context.
1086 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1089 }
1093 }
1094 }
1099 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1101 # Handle nested #if/#else.
1108 }
1110 # Statement ends at the ';' or a close '}' at the
1111 # outermost level.
1114 }
1116 # An else is really a conditional as long as its not else if
1123 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1124 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1125 }
1130 }
1138 #warn "CSB: mark coff<$coff>\n";
1139 }
1140 }
1144 }
1152 }
1154 }
1155 }
1156 # Preprocessor commands end at the newline unless escaped.
1162 }
1164 }
1165 # We are truly at the end, so shuffle to the next line.
1170 }
1175 #warn "STATEMENT<$statement>\n";
1176 #warn "CONDITION<$condition>\n";
1178 #print "coff<$coff> soff<$off> loff<$loff>\n";
1182 }
1187 # Strip the diff line prefixes and rip blank lines at start and end.
1195 }
1203 }
1224 }
1225 }
1233 # Grab the first conditional/block pair.
1236 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1240 }
1242 # Pull in the following conditional/block pairs and see if they
1243 # could continue the statement.
1247 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1249 #print "C: push\n";
1251 }
1254 }
1273 # Handle nested #if/#else.
1280 }
1283 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1287 }
1294 }
1295 }
1299 }
1302 }
1305 }
1311 }
1317 }
1323 }
1328 }
1333 }
1338 # Catch a comment on the end of the line itself.
1342 # Look through the context and try and figure out if there is a
1343 # comment.
1348 #warn " $line\n";
1351 }
1354 }
1357 }
1361 }
1362 }
1366 }
1371 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1372 ##print "CMMT: $cmt\n";
1375 }
1388 }
1391 }
1403 }
1404 }
1408 }
1420 }
1440 }
1461 }
1490 # Assume all arms of the conditional end as this
1491 # one does, and continue as if the #endif was not here.
1508 }
1539 }
1551 }
1584 }
1599 }
1608 }
1612 }
1616 }
1617 }
1620 }
1629 DEFINE_\S+
1630 )$|
1634 case|
1638 \#|
1639 \#\#|
1645 # Check for modifiers.
1656 }
1657 }
1662 }
1663 build_types();
1666 }
1667 }
1677 }
1685 }
1694 }
1695 }
1700 }
1708 }
1714 }
1718 }
1729 }
1730 }
1757 }
1763 }
1770 }
1775 }
1778 }
1781 }
1789 };
1791 }
1799 };
1802 }
1811 }
1813 }
1821 }
1823 }
1831 }
1833 }
1839 ##print "absolute<$absolute>\n";
1841 # See if any suffix of this path is a path within the tree.
1844 ##print "file<$file>\n";
1846 }
1847 }
1850 }
1852 # It is, so see if the prefix is acceptable.
1856 ##print "prefix<$prefix>\n";
1860 }
1861 }
1869 }
1877 }
1885 }
1893 }
1902 #convert leading spaces to tabs
1904 #Remove spaces before a tab
1908 }
1922 }
1934 }
1935 }
1938 }
1974 # Trace the real file/line as we go.
1986 # suppression flags
1994 # Pre-scan the patch sanitizing the lines.
1995 # Pre-scan the patch looking for any __setup documentation.
1996 #
2002 sanitise_line_reset();
2014 }
2015 #next;
2016 }
2023 }
2026 # Guestimate if this is a continuing comment. Run
2027 # the context looking for a comment "edge". If this
2028 # edge is a close comment then we must be in a comment
2029 # at context start.
2036 #print "RAW<$rawlines[$ln - 1]>\n";
2042 }
2043 }
2046 }
2048 # Guestimate if this is a continuing comment. If this
2049 # is the start of a diff block and this line starts
2050 # ' *' then it is very likely a comment.
2053 {
2055 }
2057 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2061 # Standardise the strings and chars within the input to
2062 # simplify matching -- only bother with positive lines.
2064 }
2071 }
2073 #print "==>$rawline\n";
2074 #print "-->$line\n";
2078 }
2079 }
2094 #extract the line range in the file after the patch is applied
2104 }
2105 annotate_reset();
2114 # track the line number as we move through the hunk, note that
2115 # new versions of GNU diff omit the leading space on completely
2116 # blank context lines so we need to count that too.
2121 # Measure the line length and indent.
2124 # Track the previous line.
2129 #warn "line<$line>\n";
2133 }
2141 # extract the filename as it passes
2157 }
2161 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2162 }
2164 }
2166 #make up the handle for any error we report on this line
2174 }
2175 }
2182 }
2184 }
2194 # Check if the commit log has what seems like a diff which can confuse patch
2203 }
2205 # Check for incorrect file permissions
2212 }
2213 }
2215 # Check the patch for a signoff:
2219 }
2221 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2222 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2225 }
2227 # Check signature styles
2239 }
2246 }
2247 }
2254 }
2256 }
2263 }
2264 }
2275 # Don't force email to have quotes
2276 # Allow just an angle bracketed address
2282 }
2283 }
2285 # Check for duplicate signatures
2294 }
2295 }
2297 # Check email subject for common tools that don't need to be mentioned
2302 }
2304 # Check for old stable address
2308 }
2310 # Check for unwanted Gerrit info
2314 }
2316 # Check for line lengths > 75 in commit log, warn once
2320 # file delta changes
2322 # filename then :
2324 # A Fixes: or Link: line
2329 }
2331 # Check if the commit log is in a possible stack dump
2335 # timestamp
2337 # stack dump address
2339 }
2341 # Reset possible stack dump if a blank line is found
2345 }
2347 # Check for git id commit length and improperly formed commit descriptions
2369 }
2391 }
2398 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2399 }
2400 }
2402 # Check for added, moved or deleted files
2411 }
2413 # Check for wrappage within a valid hunk of the file
2418 }
2420 # Check for absolute kernel paths.
2427 #
2430 }
2431 }
2432 }
2434 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2445 }
2447 # Check if it's the start of a commit log
2448 # (not a header line and we haven't seen the patch filename)
2454 }
2456 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2457 # declined it, i.e defined some charset where it is missing.
2462 }
2468 }
2470 # Check for various typo / spelling mistakes
2484 }
2485 }
2486 }
2488 # ignore non-hunk lines and lines being removed
2491 #trailing whitespace
2498 }
2505 }
2508 }
2510 # Check for FSF mailing addresses.
2518 "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)
2519 }
2521 # check for Kconfig help text having a real description
2522 # Only applies when adding the entry originally, after that we do not have
2523 # sufficient context to determine whether it is indeed long enough.
2544 }
2553 }
2555 }
2559 }
2560 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2561 }
2563 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2567 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2568 }
2570 # discourage the use of boolean for type definition attributes of Kconfig options
2575 }
2585 };
2588 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2589 }
2591 # check for DT compatible documentation
2610 }
2617 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2618 }
2619 }
2620 }
2622 # check we are in a valid source file if not then ignore this hunk
2625 # line length limit (with some exclusions)
2626 #
2627 # There are a few types of lines that may extend beyond $max_line_length:
2628 # logging functions like pr_info that end in a string
2629 # lines with a single string
2630 # #defines that are a single string
2631 #
2632 # There are 3 different line length message types:
2633 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2634 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2635 # LONG_LINE all other lines longer than $max_line_length
2636 #
2637 # if LONG_LINE is ignored, the other 2 types are also ignored
2638 #
2643 # Check the allowed long line types first
2645 # logging functions that end in a string that starts
2646 # before $max_line_length
2647 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2651 # lines with only strings (w/ possible termination)
2652 # #defines with only strings
2657 # Otherwise set the alternate message types
2659 # a comment starts before $max_line_length
2664 # a quoted string starts before $max_line_length
2668 }
2674 }
2675 }
2677 # check for adding lines without a newline.
2678 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2681 }
2683 # Blackfin: use hi/lo macros
2689 }
2694 }
2695 }
2697 # check we are in a valid source file C or perl if not then ignore this hunk
2700 # at the beginning of a line any tabs must come first and anything
2701 # more than 8 must use tabs.
2710 }
2711 }
2713 # check for space before tabs.
2723 }
2724 }
2726 # check for && or || at the start of a line
2730 }
2732 # check multi-line statement indentation matches previous line
2734 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2757 }
2758 }
2759 }
2760 }
2762 # check for space after cast like "(int) foo" or "(struct foo) bar"
2763 # avoid checking a few false positives:
2764 # "sizeof(<type>)" or "__alignof__(<type>)"
2765 # function pointer declarations like "(*foo)(int) = bar;"
2766 # structure definitions like "(struct foo) { 0 };"
2767 # multiline macros that define functions
2768 # known attributes or the __attribute__ keyword
2776 }
2777 }
2779 # Block comment styles
2780 # Networking with an initial /*
2787 }
2789 # Block comments use * on subsequent lines
2797 }
2799 # Block comments use */ on trailing lines
2806 }
2808 # check for missing blank lines after struct/union declarations
2809 # with exceptions for various attributes and macros
2824 }
2825 }
2827 # check for multiple consecutive blank lines
2835 }
2838 }
2840 # check for missing blank lines after declarations
2842 # actual declarations
2844 # function pointer declarations
2846 # foo bar; where foo is some local typedef or #define
2848 # known declaration macros
2850 # for "else if" which can look like "$Ident $Ident"
2852 # other possible extensions of declaration lines
2854 # not starting a section or a macro "\" extended line
2856 # looks like a declaration
2858 # function pointer declarations
2860 # foo bar; where foo is some local typedef or #define
2862 # known declaration macros
2864 # start of struct or union or enum
2866 # start or end of block or continuation of declaration
2868 # bitfield continuation
2870 # other possible extensions of declaration lines
2872 # indentation of previous and current line are the same
2878 }
2879 }
2881 # check for spaces at the beginning of a line.
2882 # Exceptions:
2883 # 1) within comments
2884 # 2) indented preprocessor commands
2885 # 3) hanging labels
2892 }
2893 }
2895 # check we are in a valid C source file if not then ignore this hunk
2898 # check indentation of any line with a bare else
2899 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2900 # if the previous line is a break or return and is indented 1 tab more...
2909 }
2910 }
2912 # check indentation of a line with a break;
2913 # if the previous line is a goto or return and is indented the same # of tabs
2919 }
2920 }
2922 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2925 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2926 }
2928 # check for RCS/CVS revision markers
2932 }
2934 # Blackfin: don't use __builtin_bfin_[cs]sync
2939 }
2944 }
2946 # check for old HOTPLUG __dev<foo> section markings
2950 }
2952 # Check for potential 'bare' types
2955 #print "LINE<$line>\n";
2963 #print "linenr<$linenr> <$stat>\n";
2964 # If this statement has no statement boundaries within
2965 # it there is no point in retrying a statement scan
2966 # until we hit end of it.
2969 #print "skip<$line_nr_next>\n";
2971 }
2973 # Find the real next line.
2979 }
2984 # Ignore goto labels.
2987 # Ignore functions being called
2992 # declarations always start with types
2993 } 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) {
2998 # definitions in global scope can only start with types
3001 }
3003 # any (foo ... *) is a pointer cast, and foo is a type
3006 }
3008 # Check for any sort of function declaration.
3009 # int foo(something bar, other baz);
3010 # void (*store_gdt)(x86_descr_ptr *);
3011 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3019 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3022 }
3023 }
3024 }
3026 }
3028 #
3029 # Checks which may be anchored in the context.
3030 #
3032 # Check for switch () and associated case and default
3033 # statements should be at the same indent.
3047 }
3048 }
3052 }
3053 }
3055 # if/while/etc brace do not go on next line, unless defining a do while loop,
3056 # or if that brace on the next line is for something else
3057 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3065 }
3076 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3079 }
3081 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3082 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3088 }
3092 {
3098 }
3099 }
3100 }
3102 # Check relative indent for conditionals and blocks.
3103 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3111 # remove inline comments
3115 # Find out how long the conditional actually is.
3119 # Make sure we remove the line prefixes as we have
3120 # none on the first line, and are going to readd them
3121 # where necessary.
3125 }
3127 # We want to check the first line inside the block
3128 # starting at the end of the conditional, so remove:
3129 # 1) any blank line termination
3130 # 2) any opening brace { on end of the line
3131 # 3) any do (...) {
3138 }
3142 }
3144 # Also ignore a loop construct at the end of a
3145 # preprocessor statement.
3149 }
3156 # If we see an #else/#elif then the code
3157 # is not linear.
3160 }
3162 # Ignore:
3163 # 1) blank lines, they should be at 0,
3164 # 2) preprocessor lines, and
3165 # 3) labels.
3173 }
3174 }
3175 }
3180 # Check if either of these lines are modified, else
3181 # this is not this patch's fault.
3185 }
3188 }
3190 #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";
3197 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3198 }
3199 }
3201 # Track the 'values' across context and added lines.
3211 }
3214 #ignore lines not being added
3217 # TEST: allow direct testing of the type matcher.
3225 }
3227 }
3228 # TEST: allow direct testing of the attribute matcher.
3236 }
3238 }
3240 # check for initialisation to aggregates open brace on the next line
3254 }
3255 }
3257 #
3258 # Checks which are anchored on the added line.
3259 #
3261 # check for malformed paths in #include statements (uses RAW line)
3267 }
3271 }
3272 }
3274 # no C99 // comments
3283 }
3284 }
3285 }
3286 # Remove C99 comments.
3290 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3291 # the whole statement.
3292 #print "APW <$lines[$realline_next - 1]>\n";
3298 # Handle definitions which produce identifiers with
3299 # a prefix:
3300 # XXX(foo);
3301 # EXPORT_SYMBOL(something_foo);
3305 #print "FOO C name<$name>\n";
3316 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3320 }
3321 }
3326 #print "FOO B <$lines[$linenr - 1]>\n";
3328 }
3333 }
3335 # check for global initialisers.
3342 }
3343 }
3344 # check for static initialisers.
3351 }
3352 }
3354 # check for misordered declarations of char/short/int/long with signed/unsigned
3358 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3359 }
3361 # check for static const char * arrays.
3366 }
3368 # check for static char foo[] = "bar" declarations.
3373 }
3375 # check for const <foo> const where <foo> is not a pointer or array type
3384 }
3385 }
3387 # check for non-global char *foo[] = {"bar", ...} declarations.
3392 }
3394 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3397 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3403 }
3404 }
3405 }
3407 # check for function declarations without arguments like "int foo()"
3413 }
3414 }
3416 # check for uses of DEFINE_PCI_DEVICE_TABLE
3421 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3422 }
3423 }
3425 # check for new typedefs, only function parameters and sparse annotations
3426 # make sense.
3434 }
3436 # * goes on variable not on type
3437 # (char*[ const])
3439 #print "AA<$1>\n";
3442 # Should start with a space.
3444 # Should not end with a space.
3446 # '*'s should not have spaces between.
3448 }
3450 ## print "1: from<$from> to<$to> ident<$ident>\n";
3460 }
3461 }
3462 }
3464 #print "BB<$1>\n";
3467 # Should start with a space.
3469 # Should not end with a space.
3471 # '*'s should not have spaces between.
3473 }
3474 # Modifiers should have spaces.
3477 ## print "2: from<$from> to<$to> ident<$ident>\n";
3488 }
3489 }
3490 }
3492 # avoid BUG() or BUG_ON()
3497 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3498 }
3500 # avoid LINUX_VERSION_CODE
3503 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3504 }
3506 # check for uses of printk_ratelimit
3510 }
3512 # printk should use KERN_* levels. Note that follow on printk's on the
3513 # same line do not need a level, so we use the current block context
3514 # to try and find and validate the current printk. In summary the current
3515 # printk includes all preceding printk's which have no newline on the end.
3516 # we assume the first bad printk is the one to report.
3520 #print "CHECK<$lines[$ln - 1]\n";
3521 # we have a preceding printk if it ends
3522 # with "\n" ignore it, else it is to blame
3526 }
3528 }
3529 }
3533 }
3534 }
3543 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3544 }
3552 }
3553 }
3562 }
3564 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3565 # number of false positives, but assembly files are not checked, so at
3566 # least the arch entry code will not trigger this warning.
3570 }
3572 # function brace can't be on same line, except for #defines of do while,
3573 # or if closed on same line
3588 }
3589 }
3590 }
3592 # open braces for enum, union and struct go on the same line.
3606 }
3607 }
3608 }
3610 # missing space after union, struct or enum definition
3617 }
3618 }
3620 # Function pointer declarations
3621 # check spacing between type, funcptr, and args
3622 # canonical declaration is "type (*funcptr)(args...)"
3631 # the $Declare variable will capture all spaces after the type
3632 # so check it for a missing trailing missing space but pointer return types
3633 # don't need a space so don't warn for those.
3638 }
3643 }
3645 # unnecessary space "type (*funcptr)(args...)"
3646 # This test is not currently implemented because these declarations are
3647 # equivalent to
3648 # int foo(int bar, ...)
3649 # and this is form shouldn't/doesn't generate a checkpatch warning.
3650 #
3651 # elsif ($declare =~ /\s{2,}$/) {
3652 # WARN("SPACING",
3653 # "Multiple spaces after return type\n" . $herecurr);
3654 # }
3656 # unnecessary space "type ( *funcptr)(args...)"
3661 }
3663 # unnecessary space "type (* funcptr)(args...)"
3668 }
3670 # unnecessary space "type (*funcptr )(args...)"
3675 }
3677 # unnecessary space "type (*funcptr) (args...)"
3682 }
3686 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3687 }
3688 }
3690 # check for spacing round square brackets; allowed:
3691 # 1. with a type on the left -- int [] a;
3692 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3693 # 3. inside a curly brace -- = { [0...10] = 5 }
3704 }
3705 }
3706 }
3708 # check for spaces between functions and their parentheses.
3714 # Ignore those directives where spaces _are_ permitted.
3720 {
3721 # cpp #define statements have non-optional spaces, ie
3722 # if there is a space between the name and the open
3723 # parenthesis it is simply not a parameter group.
3726 # cpp #elif statement condition may start with a (
3729 # If this whole things ends with a type its most
3730 # likely a typedef for a function.
3739 }
3740 }
3741 }
3743 # Check operator spacing.
3749 <<=|>>=|<=|>=|==|!=|
3751 =>|->|<<|>>|<|>|=|!|~|
3757 ## print("element count: <" . $#elements . ">\n");
3758 ## foreach my $el (@elements) {
3759 ## print("el: <$el>\n");
3760 ## }
3768 }
3779 ## print("n: <$n> good: <$good>\n");
3783 # Pick up the preceding and succeeding characters.
3788 }
3811 }
3820 # Pull out the value of this operator.
3823 # Get the full operator variant.
3826 # Ignore operators passed as parameters.
3830 # # Ignore comments
3831 # } elsif ($op =~ /^$;+$/) {
3833 # ; should have either the end of line or a space or \ after it
3841 }
3842 }
3844 # // is a comment
3847 # : when part of a bitfield
3849 # skip the bitfield test for now
3851 # No spaces for:
3852 # ->
3860 }
3862 }
3863 }
3865 # , must not have a space before and must have a space on the right.
3874 }
3875 }
3882 }
3883 }
3889 }
3892 }
3893 }
3895 # '*' as part of a type definition -- reported already.
3897 #warn "'*' is part of type\n";
3899 # unary operators should have a space before and
3900 # none after. May be left adjacent to another
3901 # unary operator, or a cast
3911 }
3912 }
3913 }
3915 # A unary '*' may be const
3923 }
3925 }
3926 }
3928 # unary ++ and unary -- are allowed no space on one side.
3935 }
3936 }
3943 }
3944 }
3951 }
3953 }
3954 }
3956 # << and >> may either have or not have spaces both sides
3962 {
3970 }
3976 }
3977 }
3984 }
3986 }
3987 }
3989 # A colon needs no spaces before when it is
3990 # terminating a case value or a label.
3997 }
3998 }
4000 # All the others need spaces both sides.
4004 # Ignore email addresses <foo@bar>
4009 {
4011 }
4013 # for asm volatile statements
4014 # ignore a colon with another
4015 # colon immediately before or after
4019 }
4021 # messages are ERROR, but ?: are CHK
4031 }
4033 }
4034 }
4035 }
4038 ## print("n: <$n> GOOD: <$good>\n");
4041 }
4045 }
4049 }
4052 }
4054 # check for whitespace before a non-naked semicolon
4061 }
4062 }
4064 # check for multiple assignments
4068 }
4070 ## # check for multiple declarations, allowing for a function declaration
4071 ## # continuation.
4072 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4073 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4074 ##
4075 ## # Remove any bracketed sections to ensure we do not
4076 ## # falsly report the parameters of functions.
4077 ## my $ln = $line;
4078 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4079 ## }
4080 ## if ($ln =~ /,/) {
4081 ## WARN("MULTIPLE_DECLARATION",
4082 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4083 ## }
4084 ## }
4086 #need space before brace following if, while, etc
4093 }
4094 }
4096 ## # check for blank lines before declarations
4097 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4098 ## $prevrawline =~ /^.\s*$/) {
4099 ## WARN("SPACING",
4100 ## "No blank lines before declarations\n" . $hereprev);
4101 ## }
4102 ##
4104 # closing brace should have a space following it when it has anything
4105 # on the line
4112 }
4113 }
4115 # check spacing on square brackets
4122 }
4123 }
4130 }
4131 }
4133 # check spacing on parentheses
4141 }
4142 }
4151 }
4152 }
4154 # check unnecessary parentheses around addressof/dereference single $Lvals
4155 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4163 }
4164 }
4166 # check for unnecessary parentheses around function pointer uses
4167 # ie: (foo->bar)(); should be foo->bar();
4168 # but not "if (foo->bar) (" to avoid some false positives
4177 }
4178 }
4180 #goto labels aren't indented, allow a single space however
4188 }
4189 }
4191 # return is not a function
4201 }
4205 }
4206 }
4208 # unnecessary return in a void function
4209 # at end-of-function, with the previous line a single leading tab, then return;
4210 # and the line before that not a goto label target like "out:"
4218 }
4220 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4226 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4231 }
4232 }
4234 # comparisons with a constant or upper case identifier on the left
4235 # avoid cases like "foo + BAR < baz"
4236 # only fix matches surrounded by parentheses to avoid incorrect
4237 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4258 }
4260 }
4261 }
4263 # Return of what appears to be an errno should normally be negative
4269 }
4270 }
4272 # Need a space before open parenthesis after if, while etc
4279 }
4280 }
4282 # Check for illegal assignment in if conditional -- and check for trailing
4283 # statements after the conditional.
4291 ##print "stat<$stat> stat_next<$stat_next>\n";
4294 # If the statement carries leading newlines,
4295 # then count those as offsets.
4303 }
4304 }
4313 }
4315 # Find out what is on the end of the line after the
4316 # conditional.
4322 {
4323 # Find out how long the conditional actually is.
4332 }
4336 }
4337 }
4339 # Check for bitwise tests written as boolean
4345 |
4350 {
4353 }
4355 # if and else should not have general statements after it
4362 }
4363 }
4364 # if should not continue a brace
4369 }
4370 # case and default should not have general statements after them
4376 {
4379 }
4381 # Check for }<nl>else {, these must be at the same
4382 # indent level to be relevant to each other.
4394 }
4398 }
4399 }
4405 # Find out what is on the end of the line after the
4406 # conditional.
4422 }
4423 }
4424 }
4426 #Specific variable tests
4430 #gcc binary extension
4438 }
4439 }
4441 #CamelCase
4444 #Ignore Page<foo> variants
4446 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4448 #Ignore some three character SI units explicitly, like MiB and KHz
4454 seed_camelcase_includes();
4458 }
4459 }
4464 }
4465 }
4466 }
4467 }
4469 #no spaces allowed after \ in define
4475 }
4476 }
4478 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4479 # itself <asm/foo.h> (uses RAW line)
4486 {
4495 }
4496 }
4497 }
4498 }
4500 # multi-statement macros should be enclosed in a do while loop, grab the
4501 # first statement and ensure its the whole macro if its not enclosed
4502 # in a known good container
4514 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4515 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4526 # Flatten any parentheses and braces
4530 {
4531 }
4533 # Flatten any obvious string concatentation.
4536 {
4537 }
4541 module_param_named|
4542 MODULE_PARM_DESC|
4543 DECLARE_PER_CPU|
4544 DEFINE_PER_CPU|
4545 __typeof__\(|
4546 union|
4547 struct|
4551 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4555 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4560 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4566 {
4573 }
4581 }
4582 }
4584 # check for macros with flow control, but without ## concatenation
4585 # ## concatenation is commonly a macro that defines a function so ignore those
4592 }
4595 }
4597 # check for line continuations outside of #defines, preprocessor #, and asm
4606 }
4607 }
4609 # do {} while (0) macro tests:
4610 # single-statement macros do not need to be enclosed in do while (0) loop,
4611 # macro should not end with a semicolon
4626 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4636 }
4642 }
4646 }
4654 }
4658 }
4659 }
4661 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4662 # all assignments may have only one of the following with an assignment:
4663 # .
4664 # ALIGN(...)
4665 # VMLINUX_SYMBOL(...)
4669 }
4671 # check for redundant bracing round if etc
4675 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4676 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4686 # If the condition carries leading newlines, then count those as offsets.
4691 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4693 # We have looked at and allowed this specific line.
4703 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4705 #print "APW: ALLOWED: cond<$cond>\n";
4707 }
4709 #print "APW: ALLOWED: block<$block>\n";
4711 }
4713 #print "APW: ALLOWED: lines block<$block>\n";
4715 }
4717 }
4722 }
4730 }
4731 }
4732 }
4733 }
4738 # Check the pre-context.
4740 #print "APW: ALLOWED: pre<$1>\n";
4742 }
4747 # Check the condition.
4749 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4752 }
4754 #print "APW: ALLOWED: cond<$cond>\n";
4756 }
4758 #print "APW: ALLOWED: block<$block>\n";
4760 }
4762 #print "APW: ALLOWED: lines block<$block>\n";
4764 }
4765 # Check the post-context.
4770 }
4772 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4774 }
4775 }
4782 }
4786 }
4787 }
4789 # check for unnecessary blank lines around braces
4795 }
4796 }
4802 }
4803 }
4805 # no volatiles please
4809 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4810 }
4812 # Check for user-visible strings broken across lines, which breaks the ability
4813 # to grep for the string. Make exceptions when the previous string ends in a
4814 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4815 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4828 }
4840 }
4842 }
4843 }
4845 # check for missing a space in a string concatenation
4849 }
4851 # check for spaces before a quoted newline
4857 }
4859 }
4861 # concatenated string without spaces between elements
4865 }
4867 # uncoalesced string fragments
4871 }
4873 # check for %L{u,d,i} and 0x%[udi] in strings
4882 }
4886 }
4887 }
4889 # check for line continuations in quoted strings with odd counts of "
4893 }
4895 # warn about #if 0
4900 }
4902 # check for needless "if (<foo>) fn(<foo>)" uses
4906 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
4918 }
4923 }
4926 }
4930 }
4931 }
4932 }
4933 }
4935 # check for unnecessary "Out of Memory" messages
4944 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4946 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4949 }
4950 }
4952 # check for logging functions with KERN_<LEVEL>
4960 }
4961 }
4963 # check for mask then right shift without a parentheses
4969 }
4971 # check for pointer comparisons to NULL
4981 }
4982 }
4983 }
4985 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4988 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4998 $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;
4999 }
5000 }
5001 }
5003 # check for $InitAttributeData (ie: __initdata) with const
5014 }
5015 }
5017 # check for $InitAttributeConst (ie: __initconst) without const
5029 }
5030 }
5032 # check for __read_mostly with const non-pointer (should just be const)
5039 }
5040 }
5042 # don't use __constant_<foo> functions outside of include/uapi/
5044 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5052 }
5053 }
5055 # prefer usleep_range over udelay
5058 # ignore udelay's < 10, however
5061 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5062 }
5066 }
5067 }
5069 # warn about unexpectedly long msleep's
5073 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5074 }
5075 }
5077 # check for comparisons of jiffies
5080 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5081 }
5083 # check for comparisons of get_jiffies_64()
5086 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5087 }
5089 # warn about #ifdefs in C files
5090 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5091 # print "#ifdef in C files should be avoided\n";
5092 # print "$herecurr";
5093 # $clean = 0;
5094 # }
5096 # warn about spacing in #ifdefs
5103 }
5105 }
5107 # check for spinlock_t definitions without a comment.
5114 }
5115 }
5116 # check for memory barriers without a comment.
5117 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
5121 }
5122 }
5124 # check for waitqueue_active without a comment.
5129 }
5130 }
5132 # Check for expedited grace periods that interrupt non-idle non-nohz
5133 # online CPUs. These expedited can therefore degrade real-time response
5134 # if used carelessly, and should be avoided where not absolutely
5135 # needed. It is always OK to use synchronize_rcu_expedited() and
5136 # synchronize_sched_expedited() at boot time (before real-time applications
5137 # start) and in error situations where real-time response is compromised in
5138 # any case. Note that synchronize_srcu_expedited() does -not- interrupt
5139 # other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5140 # Of course, nothing comes for free, and srcu_read_lock() and
5141 # srcu_read_unlock() do contain full memory barriers in payment for
5142 # synchronize_srcu_expedited() non-interruption properties.
5145 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5147 }
5149 # check of hardware specific defines
5150 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5153 }
5155 # Check that the storage class is at the beginning of a declaration
5159 }
5161 # check the location of the inline attribute, that it is between
5162 # storage class and type.
5167 }
5169 # Check for __inline__ and __inline, prefer inline
5177 }
5178 }
5180 # Check for __attribute__ packed, prefer __packed
5185 }
5187 # Check for __attribute__ aligned, prefer __aligned
5192 }
5194 # Check for __attribute__ format(printf, prefer __printf
5198 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5200 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5202 }
5203 }
5205 # Check for __attribute__ format(scanf, prefer __scanf
5209 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5211 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5212 }
5213 }
5215 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5217 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5222 }
5224 # check for c99 types like uint8_t used outside of uapi/
5238 }
5239 }
5240 }
5242 # check for sizeof(&)
5246 }
5248 # check for sizeof without parenthesis
5253 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5254 }
5255 }
5257 # check for struct spinlock declarations
5261 }
5263 # check for seq_printf uses that could be seq_puts
5272 }
5273 }
5274 }
5276 # Check for misused memsets
5291 }
5292 }
5294 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5299 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5301 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5302 }
5303 }
5305 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5310 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5311 }
5313 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5314 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5325 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5326 }
5331 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5332 }
5333 }
5334 }
5336 # typecasts on min/max could be min_t/max_t
5354 }
5357 }
5358 }
5360 # check usleep_range arguments
5368 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5372 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5373 }
5374 }
5376 # check for naked sscanf
5388 }
5391 }
5393 # check for simple sscanf that should be kstrto<foo>
5402 }
5410 }
5411 }
5412 }
5414 # check for new externs in .h files.
5421 }
5422 }
5424 # check for new externs in .c files.
5427 {
5434 }
5437 {
5440 }
5445 }
5449 {
5452 }
5454 # checks for new __setup's
5461 }
5462 }
5464 # check for pointless casting of kmalloc return
5467 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5468 }
5470 # alloc style
5471 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5473 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5476 }
5478 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5480 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5491 }
5497 $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;
5499 }
5500 }
5501 }
5503 # check for krealloc arg reuse
5508 }
5510 # check for alloc argument mismatch
5514 }
5516 # check for multiple semicolons
5522 }
5523 }
5525 # check for #defines like: 1 << <digit> that could be BIT(digit)
5533 }
5534 }
5536 # check for case / default statements not preceded by break/fallthrough/switch
5554 }
5558 }
5559 }
5561 # check for switch/default statements without a break;
5570 }
5573 }
5575 # check for gcc specific __FUNCTION__
5581 }
5582 }
5584 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5588 }
5590 # check for use of yield()
5594 }
5596 # check for comparisons against true and false
5612 }
5617 ## maybe suggesting a correct construct would better
5618 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5620 }
5621 }
5623 # check for semaphores initialized locked
5627 }
5629 # recommend kstrto* over simple_strto* and strict_strto*
5633 }
5635 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5638 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5639 }
5641 # check for various structs that are normally const (ops, kgdb, device_tree)
5643 acpi_dock_ops|
5644 address_space_operations|
5645 backlight_ops|
5646 block_device_operations|
5647 dentry_operations|
5648 dev_pm_ops|
5649 dma_map_ops|
5650 extent_io_ops|
5651 file_lock_operations|
5652 file_operations|
5653 hv_ops|
5654 ide_dma_ops|
5655 intel_dvo_dev_ops|
5656 item_operations|
5657 iwl_ops|
5658 kgdb_arch|
5659 kgdb_io|
5660 kset_uevent_ops|
5661 lock_manager_operations|
5662 microcode_ops|
5663 mtrr_ops|
5664 neigh_ops|
5665 nlmsvc_binding|
5666 of_device_id|
5667 pci_raw_ops|
5668 pipe_buf_operations|
5669 platform_hibernation_ops|
5670 platform_suspend_ops|
5671 proto_ops|
5672 rpc_pipe_ops|
5673 seq_operations|
5674 snd_ac97_build_ops|
5675 soc_pcmcia_socket_ops|
5676 stacktrace_ops|
5677 sysfs_ops|
5678 tty_operations|
5679 uart_ops|
5680 usb_mon_operations|
5687 }
5689 # use of NR_CPUS is usually wrong
5690 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5697 {
5699 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5700 }
5702 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5706 }
5708 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5713 }
5715 # whine mightly about in_atomic
5723 }
5724 }
5726 # check for lockdep_set_novalidate_class
5734 }
5735 }
5740 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5741 }
5743 # Mode permission misuses where it seems decimal should be octal
5744 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5755 }
5768 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5769 }
5770 }
5771 }
5772 }
5774 # validate content of MODULE_LICENSE against list from include/linux/module.h
5778 GPL|
5779 GPL\ v2|
5784 Proprietary
5789 }
5790 }
5791 }
5793 # If we have no input at all, then there is nothing to report on
5794 # so just keep quiet.
5797 }
5799 # In mailback mode only produce a report in the negative, for
5800 # things that appear to be patches.
5803 }
5805 # This is not a patch, and we are are in 'no-patch' mode so
5806 # just keep quiet.
5809 }
5814 }
5818 }
5826 }
5829 # If there were whitespace errors which cleanpatch can fix
5830 # then suggest that.
5837 EOM
5838 }
5839 }
5859 }
5862 }
5863 }
5871 Do _NOT_ trust the results written to this file.
5874 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5876 EOM
5877 }
5878 }
5886 }
5887 }
5889 }