| blob | d5c8e9a3a73cfc1450b7c698e10aa9848a01dad2 |
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 __must_check|
268 __init_refok|
269 __kprobes|
270 __ref|
271 __rcu
279 # Notes to $Attribute:
280 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
282 const|
283 __percpu|
284 __nocast|
285 __safe|
286 __bitwise__|
287 __packed__|
288 __packed2__|
289 __naked|
290 __maybe_unused|
291 __always_unused|
292 __noreturn|
293 __used|
294 __cold|
295 __pure|
296 __noclone|
297 __deprecated|
298 __read_mostly|
299 __kprobes|
301 ____cacheline_aligned|
302 ____cacheline_aligned_in_smp|
303 ____cacheline_internodealigned_in_smp|
304 __weak
326 <=|>=|==|!=|
327 =>|->|<<|>>|<|>|!|~|
361 )};
364 atomic_t
365 )};
370 )};
374 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
376 panic|
379 )};
388 To:|
389 Cc:
390 )};
409 );
432 );
438 );
442 );
449 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
452 );
454 #Create a search pattern for all these functions to speed up a loop below
459 }
462 S_IWUGO |
463 S_IWOTH |
464 S_IRWXUGO |
465 S_IALLUGO |
470 irq|
471 memory|
473 reboot
474 )};
475 # memory.h: ARM has a custom one
477 # Load common spelling mistakes and build regular expression list.
494 }
498 }
517 }
521 }
522 }
542 )
549 )
558 )
562 $NonptrType
567 $NonptrTypeMisordered
573 }
574 build_types();
578 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
579 # requires at least perl version v5.10.0
580 # Any use must be runtime checked with $^V
590 )};
599 }
604 }
628 }
629 }
630 }
654 }
656 }
664 }
668 }
673 }
677 }
685 }
687 }
688 }
702 # Maybe one day convert this block of bash into something that returns
703 # all matching commit ids, but it's very slow...
704 #
705 # echo "checking commits $1..."
706 # git rev-list --remotes | grep -i "^$1" |
707 # while read line ; do
708 # git log --format='%H %s' -1 $line |
709 # echo "commit $(cut -c 1-12,41-)"
710 # done
711 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
715 }
718 }
740 }
745 }
749 }
756 }
760 }
769 build_types();
770 }
781 EOM
782 }
788 EOM
789 }
790 }
801 );
806 }
807 }
809 }
832 # If there's a name left after stripping spaces and
833 # leading quotes, and the address doesn't have both
834 # leading and trailing angle brackets, the address
835 # is invalid. ie:
836 # "joe smith joe@smith.com" bad
837 # "joe smith <joe@smith.com" bad
842 }
843 }
853 }
856 }
870 }
876 }
879 }
887 }
888 }
891 }
899 }
900 }
903 }
916 }
918 }
921 }
924 }
928 }
933 # Drop the diff line leader and expand tabs
937 # Pick the indent from the front of the line.
941 }
952 }
953 }
964 # Always copy over the diff marker.
970 # Comments we are wacking completly including the begin
971 # and end, all to $;.
978 }
984 }
991 }
993 # A \ in a string means ignore the next character.
999 }
1000 # Regular quotes.
1009 }
1010 }
1012 #print "c<$c> SQ<$sanitise_quote>\n";
1021 }
1022 }
1026 }
1028 # The pathname on a #include may be surrounded by '<' and '>'.
1033 # The whole of a #error is a string.
1037 }
1040 }
1047 }
1070 #warn "CSB: blk<$blk> remain<$remain>\n";
1071 # If we are about to drop off the end, pull in more
1072 # context.
1083 }
1084 # Bail if there is no further context.
1085 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1088 }
1092 }
1093 }
1098 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1100 # Handle nested #if/#else.
1107 }
1109 # Statement ends at the ';' or a close '}' at the
1110 # outermost level.
1113 }
1115 # An else is really a conditional as long as its not else if
1122 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1123 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1124 }
1129 }
1137 #warn "CSB: mark coff<$coff>\n";
1138 }
1139 }
1143 }
1151 }
1153 }
1154 }
1155 # Preprocessor commands end at the newline unless escaped.
1161 }
1163 }
1164 # We are truly at the end, so shuffle to the next line.
1169 }
1174 #warn "STATEMENT<$statement>\n";
1175 #warn "CONDITION<$condition>\n";
1177 #print "coff<$coff> soff<$off> loff<$loff>\n";
1181 }
1186 # Strip the diff line prefixes and rip blank lines at start and end.
1194 }
1202 }
1223 }
1224 }
1232 # Grab the first conditional/block pair.
1235 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1239 }
1241 # Pull in the following conditional/block pairs and see if they
1242 # could continue the statement.
1246 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1248 #print "C: push\n";
1250 }
1253 }
1272 # Handle nested #if/#else.
1279 }
1282 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1286 }
1293 }
1294 }
1298 }
1301 }
1304 }
1310 }
1316 }
1322 }
1327 }
1332 }
1337 # Catch a comment on the end of the line itself.
1341 # Look through the context and try and figure out if there is a
1342 # comment.
1347 #warn " $line\n";
1350 }
1353 }
1356 }
1360 }
1361 }
1365 }
1370 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1371 ##print "CMMT: $cmt\n";
1374 }
1387 }
1390 }
1402 }
1403 }
1407 }
1419 }
1439 }
1460 }
1489 # Assume all arms of the conditional end as this
1490 # one does, and continue as if the #endif was not here.
1507 }
1538 }
1550 }
1583 }
1598 }
1607 }
1611 }
1615 }
1616 }
1619 }
1628 DEFINE_\S+
1629 )$|
1633 case|
1637 \#|
1638 \#\#|
1644 # Check for modifiers.
1655 }
1656 }
1661 }
1662 build_types();
1665 }
1666 }
1676 }
1684 }
1693 }
1694 }
1699 }
1707 }
1713 }
1717 }
1728 }
1729 }
1756 }
1762 }
1769 }
1774 }
1777 }
1780 }
1788 };
1790 }
1798 };
1801 }
1810 }
1812 }
1820 }
1822 }
1830 }
1832 }
1838 ##print "absolute<$absolute>\n";
1840 # See if any suffix of this path is a path within the tree.
1843 ##print "file<$file>\n";
1845 }
1846 }
1849 }
1851 # It is, so see if the prefix is acceptable.
1855 ##print "prefix<$prefix>\n";
1859 }
1860 }
1868 }
1876 }
1884 }
1892 }
1901 #convert leading spaces to tabs
1903 #Remove spaces before a tab
1907 }
1921 }
1933 }
1934 }
1937 }
1973 # Trace the real file/line as we go.
1985 # suppression flags
1993 # Pre-scan the patch sanitizing the lines.
1994 # Pre-scan the patch looking for any __setup documentation.
1995 #
2001 sanitise_line_reset();
2013 }
2014 #next;
2015 }
2022 }
2025 # Guestimate if this is a continuing comment. Run
2026 # the context looking for a comment "edge". If this
2027 # edge is a close comment then we must be in a comment
2028 # at context start.
2035 #print "RAW<$rawlines[$ln - 1]>\n";
2041 }
2042 }
2045 }
2047 # Guestimate if this is a continuing comment. If this
2048 # is the start of a diff block and this line starts
2049 # ' *' then it is very likely a comment.
2052 {
2054 }
2056 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2060 # Standardise the strings and chars within the input to
2061 # simplify matching -- only bother with positive lines.
2063 }
2070 }
2072 #print "==>$rawline\n";
2073 #print "-->$line\n";
2077 }
2078 }
2093 #extract the line range in the file after the patch is applied
2103 }
2104 annotate_reset();
2113 # track the line number as we move through the hunk, note that
2114 # new versions of GNU diff omit the leading space on completely
2115 # blank context lines so we need to count that too.
2120 # Measure the line length and indent.
2123 # Track the previous line.
2128 #warn "line<$line>\n";
2132 }
2140 # extract the filename as it passes
2156 }
2160 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2161 }
2163 }
2165 #make up the handle for any error we report on this line
2170 }
2177 }
2179 }
2189 # Check if the commit log has what seems like a diff which can confuse patch
2198 }
2200 # Check for incorrect file permissions
2207 }
2208 }
2210 # Check the patch for a signoff:
2214 }
2216 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2217 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2220 }
2222 # Check signature styles
2234 }
2241 }
2242 }
2249 }
2251 }
2258 }
2259 }
2270 # Don't force email to have quotes
2271 # Allow just an angle bracketed address
2277 }
2278 }
2280 # Check for duplicate signatures
2289 }
2290 }
2292 # Check email subject for common tools that don't need to be mentioned
2297 }
2299 # Check for old stable address
2303 }
2305 # Check for unwanted Gerrit info
2309 }
2311 # Check for line lengths > 75 in commit log, warn once
2317 }
2319 # Check for git id commit length and improperly formed commit descriptions
2353 }
2360 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2361 }
2362 }
2364 # Check for added, moved or deleted files
2373 }
2375 # Check for wrappage within a valid hunk of the file
2380 }
2382 # Check for absolute kernel paths.
2389 #
2392 }
2393 }
2394 }
2396 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2407 }
2409 # Check if it's the start of a commit log
2410 # (not a header line and we haven't seen the patch filename)
2416 }
2418 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2419 # declined it, i.e defined some charset where it is missing.
2424 }
2430 }
2432 # Check for various typo / spelling mistakes
2446 }
2447 }
2448 }
2450 # ignore non-hunk lines and lines being removed
2453 #trailing whitespace
2460 }
2467 }
2470 }
2472 # Check for FSF mailing addresses.
2480 "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)
2481 }
2483 # check for Kconfig help text having a real description
2484 # Only applies when adding the entry originally, after that we do not have
2485 # sufficient context to determine whether it is indeed long enough.
2506 }
2515 }
2517 }
2521 }
2522 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2523 }
2525 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2529 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2530 }
2532 # discourage the use of boolean for type definition attributes of Kconfig options
2537 }
2547 };
2550 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2551 }
2553 # check for DT compatible documentation
2572 }
2579 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2580 }
2581 }
2582 }
2584 # check we are in a valid source file if not then ignore this hunk
2587 # line length limit (with some exclusions)
2588 #
2589 # There are a few types of lines that may extend beyond $max_line_length:
2590 # logging functions like pr_info that end in a string
2591 # lines with a single string
2592 # #defines that are a single string
2593 #
2594 # There are 3 different line length message types:
2595 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2596 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2597 # LONG_LINE all other lines longer than $max_line_length
2598 #
2599 # if LONG_LINE is ignored, the other 2 types are also ignored
2600 #
2605 # Check the allowed long line types first
2607 # logging functions that end in a string that starts
2608 # before $max_line_length
2609 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2613 # lines with only strings (w/ possible termination)
2614 # #defines with only strings
2619 # Otherwise set the alternate message types
2621 # a comment starts before $max_line_length
2626 # a quoted string starts before $max_line_length
2630 }
2636 }
2637 }
2639 # check for adding lines without a newline.
2640 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2643 }
2645 # Blackfin: use hi/lo macros
2651 }
2656 }
2657 }
2659 # check we are in a valid source file C or perl if not then ignore this hunk
2662 # at the beginning of a line any tabs must come first and anything
2663 # more than 8 must use tabs.
2672 }
2673 }
2675 # check for space before tabs.
2685 }
2686 }
2688 # check for && or || at the start of a line
2692 }
2694 # check multi-line statement indentation matches previous line
2696 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2719 }
2720 }
2721 }
2722 }
2724 # check for space after cast like "(int) foo" or "(struct foo) bar"
2725 # avoid checking a few false positives:
2726 # "sizeof(<type>)" or "__alignof__(<type>)"
2727 # function pointer declarations like "(*foo)(int) = bar;"
2728 # structure definitions like "(struct foo) { 0 };"
2729 # multiline macros that define functions
2730 # known attributes or the __attribute__ keyword
2738 }
2739 }
2747 }
2756 }
2765 }
2767 # check for missing blank lines after struct/union declarations
2768 # with exceptions for various attributes and macros
2783 }
2784 }
2786 # check for multiple consecutive blank lines
2794 }
2797 }
2799 # check for missing blank lines after declarations
2801 # actual declarations
2803 # function pointer declarations
2805 # foo bar; where foo is some local typedef or #define
2807 # known declaration macros
2809 # for "else if" which can look like "$Ident $Ident"
2811 # other possible extensions of declaration lines
2813 # not starting a section or a macro "\" extended line
2815 # looks like a declaration
2817 # function pointer declarations
2819 # foo bar; where foo is some local typedef or #define
2821 # known declaration macros
2823 # start of struct or union or enum
2825 # start or end of block or continuation of declaration
2827 # bitfield continuation
2829 # other possible extensions of declaration lines
2831 # indentation of previous and current line are the same
2837 }
2838 }
2840 # check for spaces at the beginning of a line.
2841 # Exceptions:
2842 # 1) within comments
2843 # 2) indented preprocessor commands
2844 # 3) hanging labels
2851 }
2852 }
2854 # check we are in a valid C source file if not then ignore this hunk
2857 # check indentation of any line with a bare else
2858 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2859 # if the previous line is a break or return and is indented 1 tab more...
2868 }
2869 }
2871 # check indentation of a line with a break;
2872 # if the previous line is a goto or return and is indented the same # of tabs
2878 }
2879 }
2881 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2884 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2885 }
2887 # check for RCS/CVS revision markers
2891 }
2893 # Blackfin: don't use __builtin_bfin_[cs]sync
2898 }
2903 }
2905 # check for old HOTPLUG __dev<foo> section markings
2909 }
2911 # Check for potential 'bare' types
2914 #print "LINE<$line>\n";
2922 #print "linenr<$linenr> <$stat>\n";
2923 # If this statement has no statement boundaries within
2924 # it there is no point in retrying a statement scan
2925 # until we hit end of it.
2928 #print "skip<$line_nr_next>\n";
2930 }
2932 # Find the real next line.
2938 }
2943 # Ignore goto labels.
2946 # Ignore functions being called
2951 # declarations always start with types
2952 } 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) {
2957 # definitions in global scope can only start with types
2960 }
2962 # any (foo ... *) is a pointer cast, and foo is a type
2965 }
2967 # Check for any sort of function declaration.
2968 # int foo(something bar, other baz);
2969 # void (*store_gdt)(x86_descr_ptr *);
2970 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
2978 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
2981 }
2982 }
2983 }
2985 }
2987 #
2988 # Checks which may be anchored in the context.
2989 #
2991 # Check for switch () and associated case and default
2992 # statements should be at the same indent.
3006 }
3007 }
3011 }
3012 }
3014 # if/while/etc brace do not go on next line, unless defining a do while loop,
3015 # or if that brace on the next line is for something else
3016 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3024 }
3035 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3038 }
3040 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3041 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3047 }
3051 {
3057 }
3058 }
3059 }
3061 # Check relative indent for conditionals and blocks.
3062 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3070 # Make sure we remove the line prefixes as we have
3071 # none on the first line, and are going to readd them
3072 # where necessary.
3075 # Find out how long the conditional actually is.
3079 # We want to check the first line inside the block
3080 # starting at the end of the conditional, so remove:
3081 # 1) any blank line termination
3082 # 2) any opening brace { on end of the line
3083 # 3) any do (...) {
3090 }
3094 }
3096 # Also ignore a loop construct at the end of a
3097 # preprocessor statement.
3101 }
3108 # If we see an #else/#elif then the code
3109 # is not linear.
3112 }
3114 # Ignore:
3115 # 1) blank lines, they should be at 0,
3116 # 2) preprocessor lines, and
3117 # 3) labels.
3125 }
3126 }
3127 }
3132 # Check if either of these lines are modified, else
3133 # this is not this patch's fault.
3137 }
3140 }
3142 #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";
3147 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3148 }
3149 }
3151 # Track the 'values' across context and added lines.
3161 }
3164 #ignore lines not being added
3167 # TEST: allow direct testing of the type matcher.
3175 }
3177 }
3178 # TEST: allow direct testing of the attribute matcher.
3186 }
3188 }
3190 # check for initialisation to aggregates open brace on the next line
3204 }
3205 }
3207 #
3208 # Checks which are anchored on the added line.
3209 #
3211 # check for malformed paths in #include statements (uses RAW line)
3217 }
3221 }
3222 }
3224 # no C99 // comments
3233 }
3234 }
3235 }
3236 # Remove C99 comments.
3240 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3241 # the whole statement.
3242 #print "APW <$lines[$realline_next - 1]>\n";
3248 # Handle definitions which produce identifiers with
3249 # a prefix:
3250 # XXX(foo);
3251 # EXPORT_SYMBOL(something_foo);
3255 #print "FOO C name<$name>\n";
3266 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3270 }
3271 }
3276 #print "FOO B <$lines[$linenr - 1]>\n";
3278 }
3283 }
3285 # check for global initialisers.
3292 }
3293 }
3294 # check for static initialisers.
3301 }
3302 }
3304 # check for misordered declarations of char/short/int/long with signed/unsigned
3308 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3309 }
3311 # check for static const char * arrays.
3316 }
3318 # check for static char foo[] = "bar" declarations.
3323 }
3325 # check for const <foo> const where <foo> is not a pointer or array type
3334 }
3335 }
3337 # check for non-global char *foo[] = {"bar", ...} declarations.
3342 }
3344 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3347 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3353 }
3354 }
3355 }
3357 # check for function declarations without arguments like "int foo()"
3363 }
3364 }
3366 # check for uses of DEFINE_PCI_DEVICE_TABLE
3371 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3372 }
3373 }
3375 # check for new typedefs, only function parameters and sparse annotations
3376 # make sense.
3384 }
3386 # * goes on variable not on type
3387 # (char*[ const])
3389 #print "AA<$1>\n";
3392 # Should start with a space.
3394 # Should not end with a space.
3396 # '*'s should not have spaces between.
3398 }
3400 ## print "1: from<$from> to<$to> ident<$ident>\n";
3410 }
3411 }
3412 }
3414 #print "BB<$1>\n";
3417 # Should start with a space.
3419 # Should not end with a space.
3421 # '*'s should not have spaces between.
3423 }
3424 # Modifiers should have spaces.
3427 ## print "2: from<$from> to<$to> ident<$ident>\n";
3438 }
3439 }
3440 }
3442 # # no BUG() or BUG_ON()
3443 # if ($line =~ /\b(BUG|BUG_ON)\b/) {
3444 # print "Try to use WARN_ON & Recovery code rather than BUG() or BUG_ON()\n";
3445 # print "$herecurr";
3446 # $clean = 0;
3447 # }
3451 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3452 }
3454 # check for uses of printk_ratelimit
3458 }
3460 # printk should use KERN_* levels. Note that follow on printk's on the
3461 # same line do not need a level, so we use the current block context
3462 # to try and find and validate the current printk. In summary the current
3463 # printk includes all preceding printk's which have no newline on the end.
3464 # we assume the first bad printk is the one to report.
3468 #print "CHECK<$lines[$ln - 1]\n";
3469 # we have a preceding printk if it ends
3470 # with "\n" ignore it, else it is to blame
3474 }
3476 }
3477 }
3481 }
3482 }
3491 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3492 }
3500 }
3501 }
3510 }
3512 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3513 # number of false positives, but assembly files are not checked, so at
3514 # least the arch entry code will not trigger this warning.
3518 }
3520 # function brace can't be on same line, except for #defines of do while,
3521 # or if closed on same line
3536 }
3537 }
3538 }
3540 # open braces for enum, union and struct go on the same line.
3554 }
3555 }
3556 }
3558 # missing space after union, struct or enum definition
3565 }
3566 }
3568 # Function pointer declarations
3569 # check spacing between type, funcptr, and args
3570 # canonical declaration is "type (*funcptr)(args...)"
3579 # the $Declare variable will capture all spaces after the type
3580 # so check it for a missing trailing missing space but pointer return types
3581 # don't need a space so don't warn for those.
3586 }
3591 }
3593 # unnecessary space "type (*funcptr)(args...)"
3594 # This test is not currently implemented because these declarations are
3595 # equivalent to
3596 # int foo(int bar, ...)
3597 # and this is form shouldn't/doesn't generate a checkpatch warning.
3598 #
3599 # elsif ($declare =~ /\s{2,}$/) {
3600 # WARN("SPACING",
3601 # "Multiple spaces after return type\n" . $herecurr);
3602 # }
3604 # unnecessary space "type ( *funcptr)(args...)"
3609 }
3611 # unnecessary space "type (* funcptr)(args...)"
3616 }
3618 # unnecessary space "type (*funcptr )(args...)"
3623 }
3625 # unnecessary space "type (*funcptr) (args...)"
3630 }
3634 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3635 }
3636 }
3638 # check for spacing round square brackets; allowed:
3639 # 1. with a type on the left -- int [] a;
3640 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3641 # 3. inside a curly brace -- = { [0...10] = 5 }
3652 }
3653 }
3654 }
3656 # check for spaces between functions and their parentheses.
3662 # Ignore those directives where spaces _are_ permitted.
3668 {
3669 # cpp #define statements have non-optional spaces, ie
3670 # if there is a space between the name and the open
3671 # parenthesis it is simply not a parameter group.
3674 # cpp #elif statement condition may start with a (
3677 # If this whole things ends with a type its most
3678 # likely a typedef for a function.
3687 }
3688 }
3689 }
3691 # Check operator spacing.
3697 <<=|>>=|<=|>=|==|!=|
3699 =>|->|<<|>>|<|>|=|!|~|
3705 ## print("element count: <" . $#elements . ">\n");
3706 ## foreach my $el (@elements) {
3707 ## print("el: <$el>\n");
3708 ## }
3716 }
3727 ## print("n: <$n> good: <$good>\n");
3731 # Pick up the preceding and succeeding characters.
3736 }
3759 }
3768 # Pull out the value of this operator.
3771 # Get the full operator variant.
3774 # Ignore operators passed as parameters.
3778 # # Ignore comments
3779 # } elsif ($op =~ /^$;+$/) {
3781 # ; should have either the end of line or a space or \ after it
3789 }
3790 }
3792 # // is a comment
3795 # : when part of a bitfield
3797 # skip the bitfield test for now
3799 # No spaces for:
3800 # ->
3808 }
3810 }
3811 }
3813 # , must not have a space before and must have a space on the right.
3822 }
3823 }
3830 }
3831 }
3837 }
3840 }
3841 }
3843 # '*' as part of a type definition -- reported already.
3845 #warn "'*' is part of type\n";
3847 # unary operators should have a space before and
3848 # none after. May be left adjacent to another
3849 # unary operator, or a cast
3859 }
3860 }
3861 }
3863 # A unary '*' may be const
3871 }
3873 }
3874 }
3876 # unary ++ and unary -- are allowed no space on one side.
3883 }
3884 }
3891 }
3892 }
3899 }
3901 }
3902 }
3904 # << and >> may either have or not have spaces both sides
3910 {
3918 }
3924 }
3925 }
3932 }
3934 }
3935 }
3937 # A colon needs no spaces before when it is
3938 # terminating a case value or a label.
3945 }
3946 }
3948 # All the others need spaces both sides.
3952 # Ignore email addresses <foo@bar>
3957 {
3959 }
3961 # for asm volatile statements
3962 # ignore a colon with another
3963 # colon immediately before or after
3967 }
3969 # messages are ERROR, but ?: are CHK
3979 }
3981 }
3982 }
3983 }
3986 ## print("n: <$n> GOOD: <$good>\n");
3989 }
3993 }
3997 }
4000 }
4002 # check for whitespace before a non-naked semicolon
4009 }
4010 }
4012 # check for multiple assignments
4016 }
4018 ## # check for multiple declarations, allowing for a function declaration
4019 ## # continuation.
4020 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4021 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4022 ##
4023 ## # Remove any bracketed sections to ensure we do not
4024 ## # falsly report the parameters of functions.
4025 ## my $ln = $line;
4026 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4027 ## }
4028 ## if ($ln =~ /,/) {
4029 ## WARN("MULTIPLE_DECLARATION",
4030 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4031 ## }
4032 ## }
4034 #need space before brace following if, while, etc
4041 }
4042 }
4044 ## # check for blank lines before declarations
4045 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4046 ## $prevrawline =~ /^.\s*$/) {
4047 ## WARN("SPACING",
4048 ## "No blank lines before declarations\n" . $hereprev);
4049 ## }
4050 ##
4052 # closing brace should have a space following it when it has anything
4053 # on the line
4060 }
4061 }
4063 # check spacing on square brackets
4070 }
4071 }
4078 }
4079 }
4081 # check spacing on parentheses
4089 }
4090 }
4099 }
4100 }
4102 # check unnecessary parentheses around addressof/dereference single $Lvals
4103 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4111 }
4112 }
4114 # check for unnecessary parentheses around function pointer uses
4115 # ie: (foo->bar)(); should be foo->bar();
4116 # but not "if (foo->bar) (" to avoid some false positives
4125 }
4126 }
4128 #goto labels aren't indented, allow a single space however
4136 }
4137 }
4139 # return is not a function
4149 }
4153 }
4154 }
4156 # unnecessary return in a void function
4157 # at end-of-function, with the previous line a single leading tab, then return;
4158 # and the line before that not a goto label target like "out:"
4166 }
4168 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4174 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4179 }
4180 }
4182 # Return of what appears to be an errno should normally be negative
4188 }
4189 }
4191 # Need a space before open parenthesis after if, while etc
4198 }
4199 }
4201 # Check for illegal assignment in if conditional -- and check for trailing
4202 # statements after the conditional.
4210 ##print "stat<$stat> stat_next<$stat_next>\n";
4213 # If the statement carries leading newlines,
4214 # then count those as offsets.
4222 }
4223 }
4232 }
4234 # Find out what is on the end of the line after the
4235 # conditional.
4241 {
4242 # Find out how long the conditional actually is.
4251 }
4255 }
4256 }
4258 # Check for bitwise tests written as boolean
4264 |
4269 {
4272 }
4274 # if and else should not have general statements after it
4281 }
4282 }
4283 # if should not continue a brace
4288 }
4289 # case and default should not have general statements after them
4295 {
4298 }
4300 # Check for }<nl>else {, these must be at the same
4301 # indent level to be relevant to each other.
4313 }
4317 }
4318 }
4324 # Find out what is on the end of the line after the
4325 # conditional.
4341 }
4342 }
4343 }
4345 #Specific variable tests
4349 #gcc binary extension
4357 }
4358 }
4360 #CamelCase
4363 #Ignore Page<foo> variants
4365 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4367 #Ignore some three character SI units explicitly, like MiB and KHz
4373 seed_camelcase_includes();
4377 }
4378 }
4383 }
4384 }
4385 }
4386 }
4388 #no spaces allowed after \ in define
4394 }
4395 }
4397 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4398 # itself <asm/foo.h> (uses RAW line)
4405 {
4414 }
4415 }
4416 }
4417 }
4419 # multi-statement macros should be enclosed in a do while loop, grab the
4420 # first statement and ensure its the whole macro if its not enclosed
4421 # in a known good container
4433 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4434 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4445 # Flatten any parentheses and braces
4449 {
4450 }
4452 # Flatten any obvious string concatentation.
4455 {
4456 }
4460 module_param_named|
4461 MODULE_PARM_DESC|
4462 DECLARE_PER_CPU|
4463 DEFINE_PER_CPU|
4464 __typeof__\(|
4465 union|
4466 struct|
4470 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4474 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4479 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4485 {
4492 }
4500 }
4501 }
4503 # check for macros with flow control, but without ## concatenation
4504 # ## concatenation is commonly a macro that defines a function so ignore those
4511 }
4514 }
4516 # check for line continuations outside of #defines, preprocessor #, and asm
4525 }
4526 }
4528 # do {} while (0) macro tests:
4529 # single-statement macros do not need to be enclosed in do while (0) loop,
4530 # macro should not end with a semicolon
4545 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4555 }
4561 }
4565 }
4573 }
4577 }
4578 }
4580 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4581 # all assignments may have only one of the following with an assignment:
4582 # .
4583 # ALIGN(...)
4584 # VMLINUX_SYMBOL(...)
4588 }
4590 # check for redundant bracing round if etc
4594 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4595 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4605 # If the condition carries leading newlines, then count those as offsets.
4610 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4612 # We have looked at and allowed this specific line.
4622 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4624 #print "APW: ALLOWED: cond<$cond>\n";
4626 }
4628 #print "APW: ALLOWED: block<$block>\n";
4630 }
4632 #print "APW: ALLOWED: lines block<$block>\n";
4634 }
4636 }
4641 }
4649 }
4650 }
4651 }
4652 }
4657 # Check the pre-context.
4659 #print "APW: ALLOWED: pre<$1>\n";
4661 }
4666 # Check the condition.
4668 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4671 }
4673 #print "APW: ALLOWED: cond<$cond>\n";
4675 }
4677 #print "APW: ALLOWED: block<$block>\n";
4679 }
4681 #print "APW: ALLOWED: lines block<$block>\n";
4683 }
4684 # Check the post-context.
4689 }
4691 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4693 }
4694 }
4701 }
4705 }
4706 }
4708 # check for unnecessary blank lines around braces
4714 }
4715 }
4721 }
4722 }
4724 # no volatiles please
4728 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4729 }
4731 # Check for user-visible strings broken across lines, which breaks the ability
4732 # to grep for the string. Make exceptions when the previous string ends in a
4733 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4734 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4747 }
4759 }
4761 }
4762 }
4764 # check for missing a space in a string concatenation
4768 }
4770 # check for spaces before a quoted newline
4776 }
4778 }
4780 # concatenated string without spaces between elements
4784 }
4786 # uncoalesced string fragments
4790 }
4792 # check for %L{u,d,i} in strings
4801 }
4802 }
4804 # check for line continuations in quoted strings with odd counts of "
4808 }
4810 # warn about #if 0
4815 }
4817 # check for needless "if (<foo>) fn(<foo>)" uses
4823 }
4824 }
4826 # check for unnecessary "Out of Memory" messages
4835 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4837 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4840 }
4841 }
4843 # check for logging functions with KERN_<LEVEL>
4851 }
4852 }
4854 # check for mask then right shift without a parentheses
4860 }
4862 # check for pointer comparisons to NULL
4872 }
4873 }
4874 }
4876 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4879 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
4889 $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;
4890 }
4891 }
4892 }
4894 # check for $InitAttributeData (ie: __initdata) with const
4905 }
4906 }
4908 # check for $InitAttributeConst (ie: __initconst) without const
4920 }
4921 }
4923 # check for __read_mostly with const non-pointer (should just be const)
4930 }
4931 }
4933 # don't use __constant_<foo> functions outside of include/uapi/
4935 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
4943 }
4944 }
4946 # prefer usleep_range over udelay
4949 # ignore udelay's < 10, however
4952 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4953 }
4957 }
4958 }
4960 # warn about unexpectedly long msleep's
4964 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
4965 }
4966 }
4968 # check for comparisons of jiffies
4971 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
4972 }
4974 # check for comparisons of get_jiffies_64()
4977 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
4978 }
4980 # warn about #ifdefs in C files
4981 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
4982 # print "#ifdef in C files should be avoided\n";
4983 # print "$herecurr";
4984 # $clean = 0;
4985 # }
4987 # warn about spacing in #ifdefs
4994 }
4996 }
4998 # check for spinlock_t definitions without a comment.
5005 }
5006 }
5007 # check for memory barriers without a comment.
5008 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
5012 }
5013 }
5014 # check for waitqueue_active without a comment.
5019 }
5020 }
5021 # check of hardware specific defines
5022 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5025 }
5027 # Check that the storage class is at the beginning of a declaration
5031 }
5033 # check the location of the inline attribute, that it is between
5034 # storage class and type.
5039 }
5041 # Check for __inline__ and __inline, prefer inline
5049 }
5050 }
5052 # Check for __attribute__ packed, prefer __packed
5057 }
5059 # Check for __attribute__ aligned, prefer __aligned
5064 }
5066 # Check for __attribute__ format(printf, prefer __printf
5070 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5072 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5074 }
5075 }
5077 # Check for __attribute__ format(scanf, prefer __scanf
5081 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5083 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5084 }
5085 }
5087 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5089 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5094 }
5096 # check for c99 types like uint8_t used outside of uapi/
5110 }
5111 }
5112 }
5114 # check for sizeof(&)
5118 }
5120 # check for sizeof without parenthesis
5125 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5126 }
5127 }
5129 # check for struct spinlock declarations
5133 }
5135 # check for seq_printf uses that could be seq_puts
5144 }
5145 }
5146 }
5148 # Check for misused memsets
5163 }
5164 }
5166 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5171 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5173 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5174 }
5175 }
5177 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5182 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5183 }
5185 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5186 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5197 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5198 }
5203 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5204 }
5205 }
5206 }
5208 # typecasts on min/max could be min_t/max_t
5226 }
5229 }
5230 }
5232 # check usleep_range arguments
5240 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5244 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5245 }
5246 }
5248 # check for naked sscanf
5260 }
5263 }
5265 # check for simple sscanf that should be kstrto<foo>
5274 }
5282 }
5283 }
5284 }
5286 # check for new externs in .h files.
5293 }
5294 }
5296 # check for new externs in .c files.
5299 {
5306 }
5309 {
5312 }
5317 }
5321 {
5324 }
5326 # checks for new __setup's
5333 }
5334 }
5336 # check for pointless casting of kmalloc return
5339 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5340 }
5342 # alloc style
5343 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5345 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5348 }
5350 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5352 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5363 }
5369 $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;
5371 }
5372 }
5373 }
5375 # check for krealloc arg reuse
5380 }
5382 # check for alloc argument mismatch
5386 }
5388 # check for multiple semicolons
5394 }
5395 }
5397 # check for #defines like: 1 << <digit> that could be BIT(digit)
5405 }
5406 }
5408 # check for case / default statements not preceded by break/fallthrough/switch
5426 }
5430 }
5431 }
5433 # check for switch/default statements without a break;
5442 }
5445 }
5447 # check for gcc specific __FUNCTION__
5453 }
5454 }
5456 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5460 }
5462 # check for use of yield()
5466 }
5468 # check for comparisons against true and false
5484 }
5489 ## maybe suggesting a correct construct would better
5490 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5492 }
5493 }
5495 # check for semaphores initialized locked
5499 }
5501 # recommend kstrto* over simple_strto* and strict_strto*
5505 }
5507 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5510 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5511 }
5513 # check for various structs that are normally const (ops, kgdb, device_tree)
5515 acpi_dock_ops|
5516 address_space_operations|
5517 backlight_ops|
5518 block_device_operations|
5519 dentry_operations|
5520 dev_pm_ops|
5521 dma_map_ops|
5522 extent_io_ops|
5523 file_lock_operations|
5524 file_operations|
5525 hv_ops|
5526 ide_dma_ops|
5527 intel_dvo_dev_ops|
5528 item_operations|
5529 iwl_ops|
5530 kgdb_arch|
5531 kgdb_io|
5532 kset_uevent_ops|
5533 lock_manager_operations|
5534 microcode_ops|
5535 mtrr_ops|
5536 neigh_ops|
5537 nlmsvc_binding|
5538 of_device_id|
5539 pci_raw_ops|
5540 pipe_buf_operations|
5541 platform_hibernation_ops|
5542 platform_suspend_ops|
5543 proto_ops|
5544 rpc_pipe_ops|
5545 seq_operations|
5546 snd_ac97_build_ops|
5547 soc_pcmcia_socket_ops|
5548 stacktrace_ops|
5549 sysfs_ops|
5550 tty_operations|
5551 uart_ops|
5552 usb_mon_operations|
5559 }
5561 # use of NR_CPUS is usually wrong
5562 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5569 {
5571 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5572 }
5574 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5578 }
5580 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5585 }
5587 # whine mightly about in_atomic
5595 }
5596 }
5598 # check for lockdep_set_novalidate_class
5606 }
5607 }
5612 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5613 }
5615 # Mode permission misuses where it seems decimal should be octal
5616 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5627 }
5640 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5641 }
5642 }
5643 }
5644 }
5646 # validate content of MODULE_LICENSE against list from include/linux/module.h
5650 GPL|
5651 GPL\ v2|
5656 Proprietary
5661 }
5662 }
5663 }
5665 # If we have no input at all, then there is nothing to report on
5666 # so just keep quiet.
5669 }
5671 # In mailback mode only produce a report in the negative, for
5672 # things that appear to be patches.
5675 }
5677 # This is not a patch, and we are are in 'no-patch' mode so
5678 # just keep quiet.
5681 }
5686 }
5690 }
5698 }
5701 # If there were whitespace errors which cleanpatch can fix
5702 # then suggest that.
5709 EOM
5710 }
5711 }
5731 }
5734 }
5735 }
5743 Do _NOT_ trust the results written to this file.
5746 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5748 EOM
5749 }
5750 }
5758 }
5759 }
5761 }