| blob | 6ac6550d751c169b21853f67d4b6261f2547ac81 |
1 #!/usr/bin/perl -w
2 # (c) 2001, Dave Jones. (the file handling bit)
3 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6 # Licensed under the terms of the GNU GPL License version 2
63 Options:
68 --emacs emacs compile window format
69 --terse one line per report
84 is all off)
86 literally
89 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
90 with potential errors corrected to the preferred
91 checkpatch style
96 runtime errors.
99 --codespellfile Use this codespell dictionary
104 EOM
107 }
129 }
130 }
133 }
135 GetOptions(
178 }
179 }
184 }
200 }
201 }
210 }
212 }
213 }
223 ## no critic
226 }
233 }
239 }
246 }
247 }
252 }
253 }
263 __user|
264 __kernel|
265 __force|
266 __iomem|
267 __pmem|
268 __must_check|
269 __init_refok|
270 __kprobes|
271 __ref|
272 __rcu
280 # Notes to $Attribute:
281 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
283 const|
284 __percpu|
285 __nocast|
286 __safe|
287 __bitwise__|
288 __packed__|
289 __packed2__|
290 __naked|
291 __maybe_unused|
292 __always_unused|
293 __noreturn|
294 __used|
295 __cold|
296 __pure|
297 __noclone|
298 __deprecated|
299 __read_mostly|
300 __kprobes|
302 ____cacheline_aligned|
303 ____cacheline_aligned_in_smp|
304 ____cacheline_internodealigned_in_smp|
305 __weak
327 <=|>=|==|!=|
328 =>|->|<<|>>|<|>|!|~|
362 )};
365 atomic_t
366 )};
371 )};
377 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
379 panic|
382 )};
391 To:|
392 Cc:
393 )};
412 );
435 );
441 );
445 );
452 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
455 );
457 #Create a search pattern for all these functions to speed up a loop below
462 }
465 S_IWUGO |
466 S_IWOTH |
467 S_IRWXUGO |
468 S_IALLUGO |
473 irq|
474 memory|
476 reboot
477 )};
478 # memory.h: ARM has a custom one
480 # Load common spelling mistakes and build regular expression list.
497 }
501 }
520 }
524 }
525 }
545 )
552 )
561 )
565 $NonptrType
570 $NonptrTypeMisordered
576 }
577 build_types();
581 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
582 # requires at least perl version v5.10.0
583 # Any use must be runtime checked with $^V
593 )};
602 }
607 }
631 }
632 }
633 }
657 }
659 }
667 }
671 }
676 }
680 }
688 }
690 }
691 }
705 # Maybe one day convert this block of bash into something that returns
706 # all matching commit ids, but it's very slow...
707 #
708 # echo "checking commits $1..."
709 # git rev-list --remotes | grep -i "^$1" |
710 # while read line ; do
711 # git log --format='%H %s' -1 $line |
712 # echo "commit $(cut -c 1-12,41-)"
713 # done
714 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
718 }
721 }
743 }
748 }
752 }
759 }
763 }
772 build_types();
773 }
784 EOM
785 }
791 EOM
792 }
793 }
804 );
809 }
810 }
812 }
835 # If there's a name left after stripping spaces and
836 # leading quotes, and the address doesn't have both
837 # leading and trailing angle brackets, the address
838 # is invalid. ie:
839 # "joe smith joe@smith.com" bad
840 # "joe smith <joe@smith.com" bad
845 }
846 }
856 }
859 }
873 }
879 }
882 }
890 }
891 }
894 }
902 }
903 }
906 }
919 }
921 }
924 }
927 }
931 }
936 # Drop the diff line leader and expand tabs
940 # Pick the indent from the front of the line.
944 }
955 }
956 }
967 # Always copy over the diff marker.
973 # Comments we are wacking completly including the begin
974 # and end, all to $;.
981 }
987 }
994 }
996 # A \ in a string means ignore the next character.
1002 }
1003 # Regular quotes.
1012 }
1013 }
1015 #print "c<$c> SQ<$sanitise_quote>\n";
1024 }
1025 }
1029 }
1031 # The pathname on a #include may be surrounded by '<' and '>'.
1036 # The whole of a #error is a string.
1040 }
1043 }
1050 }
1073 #warn "CSB: blk<$blk> remain<$remain>\n";
1074 # If we are about to drop off the end, pull in more
1075 # context.
1086 }
1087 # Bail if there is no further context.
1088 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1091 }
1095 }
1096 }
1101 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1103 # Handle nested #if/#else.
1110 }
1112 # Statement ends at the ';' or a close '}' at the
1113 # outermost level.
1116 }
1118 # An else is really a conditional as long as its not else if
1125 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1126 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1127 }
1132 }
1140 #warn "CSB: mark coff<$coff>\n";
1141 }
1142 }
1146 }
1154 }
1156 }
1157 }
1158 # Preprocessor commands end at the newline unless escaped.
1164 }
1166 }
1167 # We are truly at the end, so shuffle to the next line.
1172 }
1177 #warn "STATEMENT<$statement>\n";
1178 #warn "CONDITION<$condition>\n";
1180 #print "coff<$coff> soff<$off> loff<$loff>\n";
1184 }
1189 # Strip the diff line prefixes and rip blank lines at start and end.
1197 }
1205 }
1226 }
1227 }
1235 # Grab the first conditional/block pair.
1238 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1242 }
1244 # Pull in the following conditional/block pairs and see if they
1245 # could continue the statement.
1249 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1251 #print "C: push\n";
1253 }
1256 }
1275 # Handle nested #if/#else.
1282 }
1285 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1289 }
1296 }
1297 }
1301 }
1304 }
1307 }
1313 }
1319 }
1325 }
1330 }
1335 }
1340 # Catch a comment on the end of the line itself.
1344 # Look through the context and try and figure out if there is a
1345 # comment.
1350 #warn " $line\n";
1353 }
1356 }
1359 }
1363 }
1364 }
1368 }
1373 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1374 ##print "CMMT: $cmt\n";
1377 }
1390 }
1393 }
1405 }
1406 }
1410 }
1422 }
1442 }
1463 }
1492 # Assume all arms of the conditional end as this
1493 # one does, and continue as if the #endif was not here.
1510 }
1541 }
1553 }
1586 }
1601 }
1610 }
1614 }
1618 }
1619 }
1622 }
1631 DEFINE_\S+
1632 )$|
1636 case|
1640 \#|
1641 \#\#|
1647 # Check for modifiers.
1658 }
1659 }
1664 }
1665 build_types();
1668 }
1669 }
1679 }
1687 }
1696 }
1697 }
1702 }
1710 }
1716 }
1720 }
1731 }
1732 }
1759 }
1765 }
1772 }
1777 }
1780 }
1783 }
1791 };
1793 }
1801 };
1804 }
1813 }
1815 }
1823 }
1825 }
1833 }
1835 }
1841 ##print "absolute<$absolute>\n";
1843 # See if any suffix of this path is a path within the tree.
1846 ##print "file<$file>\n";
1848 }
1849 }
1852 }
1854 # It is, so see if the prefix is acceptable.
1858 ##print "prefix<$prefix>\n";
1862 }
1863 }
1871 }
1879 }
1887 }
1895 }
1904 #convert leading spaces to tabs
1906 #Remove spaces before a tab
1910 }
1924 }
1936 }
1937 }
1940 }
1976 # Trace the real file/line as we go.
1988 # suppression flags
1996 # Pre-scan the patch sanitizing the lines.
1997 # Pre-scan the patch looking for any __setup documentation.
1998 #
2004 sanitise_line_reset();
2016 }
2017 #next;
2018 }
2025 }
2028 # Guestimate if this is a continuing comment. Run
2029 # the context looking for a comment "edge". If this
2030 # edge is a close comment then we must be in a comment
2031 # at context start.
2038 #print "RAW<$rawlines[$ln - 1]>\n";
2044 }
2045 }
2048 }
2050 # Guestimate if this is a continuing comment. If this
2051 # is the start of a diff block and this line starts
2052 # ' *' then it is very likely a comment.
2055 {
2057 }
2059 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2063 # Standardise the strings and chars within the input to
2064 # simplify matching -- only bother with positive lines.
2066 }
2073 }
2075 #print "==>$rawline\n";
2076 #print "-->$line\n";
2080 }
2081 }
2096 #extract the line range in the file after the patch is applied
2106 }
2107 annotate_reset();
2116 # track the line number as we move through the hunk, note that
2117 # new versions of GNU diff omit the leading space on completely
2118 # blank context lines so we need to count that too.
2123 # Measure the line length and indent.
2126 # Track the previous line.
2131 #warn "line<$line>\n";
2135 }
2143 # extract the filename as it passes
2159 }
2163 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2164 }
2166 }
2168 #make up the handle for any error we report on this line
2176 }
2177 }
2184 }
2186 }
2196 # Check if the commit log has what seems like a diff which can confuse patch
2205 }
2207 # Check for incorrect file permissions
2214 }
2215 }
2217 # Check the patch for a signoff:
2221 }
2223 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2224 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2227 }
2229 # Check signature styles
2241 }
2248 }
2249 }
2256 }
2258 }
2265 }
2266 }
2277 # Don't force email to have quotes
2278 # Allow just an angle bracketed address
2284 }
2285 }
2287 # Check for duplicate signatures
2296 }
2297 }
2299 # Check email subject for common tools that don't need to be mentioned
2304 }
2306 # Check for old stable address
2310 }
2312 # Check for unwanted Gerrit info
2316 }
2318 # Check if the commit log is in a possible stack dump
2322 # timestamp
2324 # stack dump address
2326 }
2328 # Check for line lengths > 75 in commit log, warn once
2332 # file delta changes
2334 # filename then :
2336 # A Fixes: or Link: line
2341 }
2343 # Reset possible stack dump if a blank line is found
2347 }
2349 # Check for git id commit length and improperly formed commit descriptions
2372 }
2394 }
2401 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2402 }
2403 }
2405 # Check for added, moved or deleted files
2414 }
2416 # Check for wrappage within a valid hunk of the file
2421 }
2423 # Check for absolute kernel paths.
2430 #
2433 }
2434 }
2435 }
2437 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2448 }
2450 # Check if it's the start of a commit log
2451 # (not a header line and we haven't seen the patch filename)
2457 }
2459 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2460 # declined it, i.e defined some charset where it is missing.
2465 }
2471 }
2473 # Check for various typo / spelling mistakes
2487 }
2488 }
2489 }
2491 # ignore non-hunk lines and lines being removed
2494 #trailing whitespace
2501 }
2508 }
2511 }
2513 # Check for FSF mailing addresses.
2521 "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)
2522 }
2524 # check for Kconfig help text having a real description
2525 # Only applies when adding the entry originally, after that we do not have
2526 # sufficient context to determine whether it is indeed long enough.
2547 }
2556 }
2558 }
2562 }
2563 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2564 }
2566 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2570 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2571 }
2573 # discourage the use of boolean for type definition attributes of Kconfig options
2578 }
2588 };
2591 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2592 }
2594 # check for DT compatible documentation
2613 }
2620 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2621 }
2622 }
2623 }
2625 # check we are in a valid source file if not then ignore this hunk
2628 # line length limit (with some exclusions)
2629 #
2630 # There are a few types of lines that may extend beyond $max_line_length:
2631 # logging functions like pr_info that end in a string
2632 # lines with a single string
2633 # #defines that are a single string
2634 #
2635 # There are 3 different line length message types:
2636 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2637 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2638 # LONG_LINE all other lines longer than $max_line_length
2639 #
2640 # if LONG_LINE is ignored, the other 2 types are also ignored
2641 #
2646 # Check the allowed long line types first
2648 # logging functions that end in a string that starts
2649 # before $max_line_length
2650 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2654 # lines with only strings (w/ possible termination)
2655 # #defines with only strings
2660 # Otherwise set the alternate message types
2662 # a comment starts before $max_line_length
2667 # a quoted string starts before $max_line_length
2671 }
2677 }
2678 }
2680 # check for adding lines without a newline.
2681 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2684 }
2686 # Blackfin: use hi/lo macros
2692 }
2697 }
2698 }
2700 # check we are in a valid source file C or perl if not then ignore this hunk
2703 # at the beginning of a line any tabs must come first and anything
2704 # more than 8 must use tabs.
2713 }
2714 }
2716 # check for space before tabs.
2726 }
2727 }
2729 # check for && or || at the start of a line
2733 }
2735 # check multi-line statement indentation matches previous line
2737 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2760 }
2761 }
2762 }
2763 }
2765 # check for space after cast like "(int) foo" or "(struct foo) bar"
2766 # avoid checking a few false positives:
2767 # "sizeof(<type>)" or "__alignof__(<type>)"
2768 # function pointer declarations like "(*foo)(int) = bar;"
2769 # structure definitions like "(struct foo) { 0 };"
2770 # multiline macros that define functions
2771 # known attributes or the __attribute__ keyword
2779 }
2780 }
2782 # Block comment styles
2783 # Networking with an initial /*
2790 }
2792 # Block comments use * on subsequent lines
2800 }
2802 # Block comments use */ on trailing lines
2809 }
2811 # check for missing blank lines after struct/union declarations
2812 # with exceptions for various attributes and macros
2827 }
2828 }
2830 # check for multiple consecutive blank lines
2838 }
2841 }
2843 # check for missing blank lines after declarations
2845 # actual declarations
2847 # function pointer declarations
2849 # foo bar; where foo is some local typedef or #define
2851 # known declaration macros
2853 # for "else if" which can look like "$Ident $Ident"
2855 # other possible extensions of declaration lines
2857 # not starting a section or a macro "\" extended line
2859 # looks like a declaration
2861 # function pointer declarations
2863 # foo bar; where foo is some local typedef or #define
2865 # known declaration macros
2867 # start of struct or union or enum
2869 # start or end of block or continuation of declaration
2871 # bitfield continuation
2873 # other possible extensions of declaration lines
2875 # indentation of previous and current line are the same
2881 }
2882 }
2884 # check for spaces at the beginning of a line.
2885 # Exceptions:
2886 # 1) within comments
2887 # 2) indented preprocessor commands
2888 # 3) hanging labels
2895 }
2896 }
2898 # check we are in a valid C source file if not then ignore this hunk
2901 # check indentation of any line with a bare else
2902 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
2903 # if the previous line is a break or return and is indented 1 tab more...
2912 }
2913 }
2915 # check indentation of a line with a break;
2916 # if the previous line is a goto or return and is indented the same # of tabs
2922 }
2923 }
2925 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
2928 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2929 }
2931 # check for RCS/CVS revision markers
2935 }
2937 # Blackfin: don't use __builtin_bfin_[cs]sync
2942 }
2947 }
2949 # check for old HOTPLUG __dev<foo> section markings
2953 }
2955 # Check for potential 'bare' types
2958 #print "LINE<$line>\n";
2966 #print "linenr<$linenr> <$stat>\n";
2967 # If this statement has no statement boundaries within
2968 # it there is no point in retrying a statement scan
2969 # until we hit end of it.
2972 #print "skip<$line_nr_next>\n";
2974 }
2976 # Find the real next line.
2982 }
2987 # Ignore goto labels.
2990 # Ignore functions being called
2995 # declarations always start with types
2996 } 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) {
3001 # definitions in global scope can only start with types
3004 }
3006 # any (foo ... *) is a pointer cast, and foo is a type
3009 }
3011 # Check for any sort of function declaration.
3012 # int foo(something bar, other baz);
3013 # void (*store_gdt)(x86_descr_ptr *);
3014 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3022 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3025 }
3026 }
3027 }
3029 }
3031 #
3032 # Checks which may be anchored in the context.
3033 #
3035 # Check for switch () and associated case and default
3036 # statements should be at the same indent.
3050 }
3051 }
3055 }
3056 }
3058 # if/while/etc brace do not go on next line, unless defining a do while loop,
3059 # or if that brace on the next line is for something else
3060 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3068 }
3079 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3082 }
3084 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3085 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3091 }
3095 {
3101 }
3102 }
3103 }
3105 # Check relative indent for conditionals and blocks.
3106 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3114 # remove inline comments
3118 # Find out how long the conditional actually is.
3122 # Make sure we remove the line prefixes as we have
3123 # none on the first line, and are going to readd them
3124 # where necessary.
3128 }
3130 # We want to check the first line inside the block
3131 # starting at the end of the conditional, so remove:
3132 # 1) any blank line termination
3133 # 2) any opening brace { on end of the line
3134 # 3) any do (...) {
3141 }
3145 }
3147 # Also ignore a loop construct at the end of a
3148 # preprocessor statement.
3152 }
3159 # If we see an #else/#elif then the code
3160 # is not linear.
3163 }
3165 # Ignore:
3166 # 1) blank lines, they should be at 0,
3167 # 2) preprocessor lines, and
3168 # 3) labels.
3176 }
3177 }
3178 }
3183 # Check if either of these lines are modified, else
3184 # this is not this patch's fault.
3188 }
3191 }
3193 #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";
3200 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3201 }
3202 }
3204 # Track the 'values' across context and added lines.
3214 }
3217 #ignore lines not being added
3220 # TEST: allow direct testing of the type matcher.
3228 }
3230 }
3231 # TEST: allow direct testing of the attribute matcher.
3239 }
3241 }
3243 # check for initialisation to aggregates open brace on the next line
3257 }
3258 }
3260 #
3261 # Checks which are anchored on the added line.
3262 #
3264 # check for malformed paths in #include statements (uses RAW line)
3270 }
3274 }
3275 }
3277 # no C99 // comments
3286 }
3287 }
3288 }
3289 # Remove C99 comments.
3293 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3294 # the whole statement.
3295 #print "APW <$lines[$realline_next - 1]>\n";
3301 # Handle definitions which produce identifiers with
3302 # a prefix:
3303 # XXX(foo);
3304 # EXPORT_SYMBOL(something_foo);
3308 #print "FOO C name<$name>\n";
3319 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3323 }
3324 }
3329 #print "FOO B <$lines[$linenr - 1]>\n";
3331 }
3336 }
3338 # check for global initialisers.
3344 }
3345 }
3346 # check for static initialisers.
3353 }
3354 }
3356 # check for misordered declarations of char/short/int/long with signed/unsigned
3360 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3361 }
3363 # check for static const char * arrays.
3368 }
3370 # check for static char foo[] = "bar" declarations.
3375 }
3377 # check for const <foo> const where <foo> is not a pointer or array type
3386 }
3387 }
3389 # check for non-global char *foo[] = {"bar", ...} declarations.
3394 }
3396 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3399 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3405 }
3406 }
3407 }
3409 # check for function declarations without arguments like "int foo()"
3415 }
3416 }
3418 # check for uses of DEFINE_PCI_DEVICE_TABLE
3423 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3424 }
3425 }
3427 # check for new typedefs, only function parameters and sparse annotations
3428 # make sense.
3436 }
3438 # * goes on variable not on type
3439 # (char*[ const])
3441 #print "AA<$1>\n";
3444 # Should start with a space.
3446 # Should not end with a space.
3448 # '*'s should not have spaces between.
3450 }
3452 ## print "1: from<$from> to<$to> ident<$ident>\n";
3462 }
3463 }
3464 }
3466 #print "BB<$1>\n";
3469 # Should start with a space.
3471 # Should not end with a space.
3473 # '*'s should not have spaces between.
3475 }
3476 # Modifiers should have spaces.
3479 ## print "2: from<$from> to<$to> ident<$ident>\n";
3490 }
3491 }
3492 }
3494 # avoid BUG() or BUG_ON()
3499 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3500 }
3502 # avoid LINUX_VERSION_CODE
3505 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3506 }
3508 # check for uses of printk_ratelimit
3512 }
3514 # printk should use KERN_* levels. Note that follow on printk's on the
3515 # same line do not need a level, so we use the current block context
3516 # to try and find and validate the current printk. In summary the current
3517 # printk includes all preceding printk's which have no newline on the end.
3518 # we assume the first bad printk is the one to report.
3522 #print "CHECK<$lines[$ln - 1]\n";
3523 # we have a preceding printk if it ends
3524 # with "\n" ignore it, else it is to blame
3528 }
3530 }
3531 }
3535 }
3536 }
3545 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3546 }
3554 }
3555 }
3564 }
3566 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3567 # number of false positives, but assembly files are not checked, so at
3568 # least the arch entry code will not trigger this warning.
3572 }
3574 # function brace can't be on same line, except for #defines of do while,
3575 # or if closed on same line
3590 }
3591 }
3592 }
3594 # open braces for enum, union and struct go on the same line.
3608 }
3609 }
3610 }
3612 # missing space after union, struct or enum definition
3619 }
3620 }
3622 # Function pointer declarations
3623 # check spacing between type, funcptr, and args
3624 # canonical declaration is "type (*funcptr)(args...)"
3633 # the $Declare variable will capture all spaces after the type
3634 # so check it for a missing trailing missing space but pointer return types
3635 # don't need a space so don't warn for those.
3640 }
3645 }
3647 # unnecessary space "type (*funcptr)(args...)"
3648 # This test is not currently implemented because these declarations are
3649 # equivalent to
3650 # int foo(int bar, ...)
3651 # and this is form shouldn't/doesn't generate a checkpatch warning.
3652 #
3653 # elsif ($declare =~ /\s{2,}$/) {
3654 # WARN("SPACING",
3655 # "Multiple spaces after return type\n" . $herecurr);
3656 # }
3658 # unnecessary space "type ( *funcptr)(args...)"
3663 }
3665 # unnecessary space "type (* funcptr)(args...)"
3670 }
3672 # unnecessary space "type (*funcptr )(args...)"
3677 }
3679 # unnecessary space "type (*funcptr) (args...)"
3684 }
3688 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3689 }
3690 }
3692 # check for spacing round square brackets; allowed:
3693 # 1. with a type on the left -- int [] a;
3694 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3695 # 3. inside a curly brace -- = { [0...10] = 5 }
3706 }
3707 }
3708 }
3710 # check for spaces between functions and their parentheses.
3716 # Ignore those directives where spaces _are_ permitted.
3722 {
3723 # cpp #define statements have non-optional spaces, ie
3724 # if there is a space between the name and the open
3725 # parenthesis it is simply not a parameter group.
3728 # cpp #elif statement condition may start with a (
3731 # If this whole things ends with a type its most
3732 # likely a typedef for a function.
3741 }
3742 }
3743 }
3745 # Check operator spacing.
3751 <<=|>>=|<=|>=|==|!=|
3753 =>|->|<<|>>|<|>|=|!|~|
3759 ## print("element count: <" . $#elements . ">\n");
3760 ## foreach my $el (@elements) {
3761 ## print("el: <$el>\n");
3762 ## }
3770 }
3781 ## print("n: <$n> good: <$good>\n");
3785 # Pick up the preceding and succeeding characters.
3790 }
3813 }
3822 # Pull out the value of this operator.
3825 # Get the full operator variant.
3828 # Ignore operators passed as parameters.
3832 # # Ignore comments
3833 # } elsif ($op =~ /^$;+$/) {
3835 # ; should have either the end of line or a space or \ after it
3843 }
3844 }
3846 # // is a comment
3849 # : when part of a bitfield
3851 # skip the bitfield test for now
3853 # No spaces for:
3854 # ->
3862 }
3864 }
3865 }
3867 # , must not have a space before and must have a space on the right.
3876 }
3877 }
3884 }
3885 }
3891 }
3894 }
3895 }
3897 # '*' as part of a type definition -- reported already.
3899 #warn "'*' is part of type\n";
3901 # unary operators should have a space before and
3902 # none after. May be left adjacent to another
3903 # unary operator, or a cast
3913 }
3914 }
3915 }
3917 # A unary '*' may be const
3925 }
3927 }
3928 }
3930 # unary ++ and unary -- are allowed no space on one side.
3937 }
3938 }
3945 }
3946 }
3953 }
3955 }
3956 }
3958 # << and >> may either have or not have spaces both sides
3964 {
3972 }
3978 }
3979 }
3986 }
3988 }
3989 }
3991 # A colon needs no spaces before when it is
3992 # terminating a case value or a label.
3999 }
4000 }
4002 # All the others need spaces both sides.
4006 # Ignore email addresses <foo@bar>
4011 {
4013 }
4015 # for asm volatile statements
4016 # ignore a colon with another
4017 # colon immediately before or after
4021 }
4023 # messages are ERROR, but ?: are CHK
4033 }
4035 }
4036 }
4037 }
4040 ## print("n: <$n> GOOD: <$good>\n");
4043 }
4047 }
4051 }
4054 }
4056 # check for whitespace before a non-naked semicolon
4063 }
4064 }
4066 # check for multiple assignments
4070 }
4072 ## # check for multiple declarations, allowing for a function declaration
4073 ## # continuation.
4074 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4075 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4076 ##
4077 ## # Remove any bracketed sections to ensure we do not
4078 ## # falsly report the parameters of functions.
4079 ## my $ln = $line;
4080 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4081 ## }
4082 ## if ($ln =~ /,/) {
4083 ## WARN("MULTIPLE_DECLARATION",
4084 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4085 ## }
4086 ## }
4088 #need space before brace following if, while, etc
4095 }
4096 }
4098 ## # check for blank lines before declarations
4099 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4100 ## $prevrawline =~ /^.\s*$/) {
4101 ## WARN("SPACING",
4102 ## "No blank lines before declarations\n" . $hereprev);
4103 ## }
4104 ##
4106 # closing brace should have a space following it when it has anything
4107 # on the line
4114 }
4115 }
4117 # check spacing on square brackets
4124 }
4125 }
4132 }
4133 }
4135 # check spacing on parentheses
4143 }
4144 }
4153 }
4154 }
4156 # check unnecessary parentheses around addressof/dereference single $Lvals
4157 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4165 }
4166 }
4168 # check for unnecessary parentheses around function pointer uses
4169 # ie: (foo->bar)(); should be foo->bar();
4170 # but not "if (foo->bar) (" to avoid some false positives
4179 }
4180 }
4182 #goto labels aren't indented, allow a single space however
4190 }
4191 }
4193 # return is not a function
4203 }
4207 }
4208 }
4210 # unnecessary return in a void function
4211 # at end-of-function, with the previous line a single leading tab, then return;
4212 # and the line before that not a goto label target like "out:"
4220 }
4222 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4228 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4233 }
4234 }
4236 # comparisons with a constant or upper case identifier on the left
4237 # avoid cases like "foo + BAR < baz"
4238 # only fix matches surrounded by parentheses to avoid incorrect
4239 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4260 }
4262 }
4263 }
4265 # Return of what appears to be an errno should normally be negative
4271 }
4272 }
4274 # Need a space before open parenthesis after if, while etc
4281 }
4282 }
4284 # Check for illegal assignment in if conditional -- and check for trailing
4285 # statements after the conditional.
4293 ##print "stat<$stat> stat_next<$stat_next>\n";
4296 # If the statement carries leading newlines,
4297 # then count those as offsets.
4305 }
4306 }
4315 }
4317 # Find out what is on the end of the line after the
4318 # conditional.
4324 {
4325 # Find out how long the conditional actually is.
4334 }
4338 }
4339 }
4341 # Check for bitwise tests written as boolean
4347 |
4352 {
4355 }
4357 # if and else should not have general statements after it
4364 }
4365 }
4366 # if should not continue a brace
4371 }
4372 # case and default should not have general statements after them
4378 {
4381 }
4383 # Check for }<nl>else {, these must be at the same
4384 # indent level to be relevant to each other.
4396 }
4400 }
4401 }
4407 # Find out what is on the end of the line after the
4408 # conditional.
4424 }
4425 }
4426 }
4428 #Specific variable tests
4432 #gcc binary extension
4440 }
4441 }
4443 #CamelCase
4446 #Ignore Page<foo> variants
4448 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4450 #Ignore some three character SI units explicitly, like MiB and KHz
4456 seed_camelcase_includes();
4460 }
4461 }
4466 }
4467 }
4468 }
4469 }
4471 #no spaces allowed after \ in define
4477 }
4478 }
4480 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4481 # itself <asm/foo.h> (uses RAW line)
4488 {
4497 }
4498 }
4499 }
4500 }
4502 # multi-statement macros should be enclosed in a do while loop, grab the
4503 # first statement and ensure its the whole macro if its not enclosed
4504 # in a known good container
4516 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4517 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4528 # Flatten any parentheses and braces
4532 {
4533 }
4535 # Flatten any obvious string concatentation.
4538 {
4539 }
4543 module_param_named|
4544 MODULE_PARM_DESC|
4545 DECLARE_PER_CPU|
4546 DEFINE_PER_CPU|
4547 __typeof__\(|
4548 union|
4549 struct|
4553 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4557 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4562 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4568 {
4575 }
4583 }
4584 }
4586 # check for macros with flow control, but without ## concatenation
4587 # ## concatenation is commonly a macro that defines a function so ignore those
4594 }
4597 }
4599 # check for line continuations outside of #defines, preprocessor #, and asm
4608 }
4609 }
4611 # do {} while (0) macro tests:
4612 # single-statement macros do not need to be enclosed in do while (0) loop,
4613 # macro should not end with a semicolon
4628 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4638 }
4644 }
4648 }
4656 }
4660 }
4661 }
4663 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4664 # all assignments may have only one of the following with an assignment:
4665 # .
4666 # ALIGN(...)
4667 # VMLINUX_SYMBOL(...)
4671 }
4673 # check for redundant bracing round if etc
4677 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4678 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4688 # If the condition carries leading newlines, then count those as offsets.
4693 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4695 # We have looked at and allowed this specific line.
4705 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4707 #print "APW: ALLOWED: cond<$cond>\n";
4709 }
4711 #print "APW: ALLOWED: block<$block>\n";
4713 }
4715 #print "APW: ALLOWED: lines block<$block>\n";
4717 }
4719 }
4724 }
4732 }
4733 }
4734 }
4735 }
4740 # Check the pre-context.
4742 #print "APW: ALLOWED: pre<$1>\n";
4744 }
4749 # Check the condition.
4751 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4754 }
4756 #print "APW: ALLOWED: cond<$cond>\n";
4758 }
4760 #print "APW: ALLOWED: block<$block>\n";
4762 }
4764 #print "APW: ALLOWED: lines block<$block>\n";
4766 }
4767 # Check the post-context.
4772 }
4774 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4776 }
4777 }
4784 }
4788 }
4789 }
4791 # check for unnecessary blank lines around braces
4797 }
4798 }
4804 }
4805 }
4807 # no volatiles please
4811 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4812 }
4814 # Check for user-visible strings broken across lines, which breaks the ability
4815 # to grep for the string. Make exceptions when the previous string ends in a
4816 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4817 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4830 }
4842 }
4844 }
4845 }
4847 # check for missing a space in a string concatenation
4851 }
4853 # check for spaces before a quoted newline
4859 }
4861 }
4863 # concatenated string without spaces between elements
4867 }
4869 # uncoalesced string fragments
4873 }
4875 # check for %L{u,d,i} and 0x%[udi] in strings
4884 }
4888 }
4889 }
4891 # check for line continuations in quoted strings with odd counts of "
4895 }
4897 # warn about #if 0
4902 }
4904 # check for needless "if (<foo>) fn(<foo>)" uses
4908 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
4920 }
4925 }
4928 }
4932 }
4933 }
4934 }
4935 }
4937 # check for unnecessary "Out of Memory" messages
4946 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
4948 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
4951 }
4952 }
4954 # check for logging functions with KERN_<LEVEL>
4962 }
4963 }
4965 # check for mask then right shift without a parentheses
4971 }
4973 # check for pointer comparisons to NULL
4983 }
4984 }
4985 }
4987 # check for bad placement of section $InitAttribute (e.g.: __initdata)
4990 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5000 $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;
5001 }
5002 }
5003 }
5005 # check for $InitAttributeData (ie: __initdata) with const
5016 }
5017 }
5019 # check for $InitAttributeConst (ie: __initconst) without const
5031 }
5032 }
5034 # check for __read_mostly with const non-pointer (should just be const)
5041 }
5042 }
5044 # don't use __constant_<foo> functions outside of include/uapi/
5046 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5054 }
5055 }
5057 # prefer usleep_range over udelay
5060 # ignore udelay's < 10, however
5063 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5064 }
5068 }
5069 }
5071 # warn about unexpectedly long msleep's
5075 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5076 }
5077 }
5079 # check for comparisons of jiffies
5082 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5083 }
5085 # check for comparisons of get_jiffies_64()
5088 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5089 }
5091 # warn about #ifdefs in C files
5092 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5093 # print "#ifdef in C files should be avoided\n";
5094 # print "$herecurr";
5095 # $clean = 0;
5096 # }
5098 # warn about spacing in #ifdefs
5105 }
5107 }
5109 # check for spinlock_t definitions without a comment.
5116 }
5117 }
5118 # check for memory barriers without a comment.
5119 if ($line =~ /\b(mb|rmb|wmb|read_barrier_depends|smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) {
5123 }
5124 }
5126 # check for waitqueue_active without a comment.
5131 }
5132 }
5134 # Check for expedited grace periods that interrupt non-idle non-nohz
5135 # online CPUs. These expedited can therefore degrade real-time response
5136 # if used carelessly, and should be avoided where not absolutely
5137 # needed. It is always OK to use synchronize_rcu_expedited() and
5138 # synchronize_sched_expedited() at boot time (before real-time applications
5139 # start) and in error situations where real-time response is compromised in
5140 # any case. Note that synchronize_srcu_expedited() does -not- interrupt
5141 # other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5142 # Of course, nothing comes for free, and srcu_read_lock() and
5143 # srcu_read_unlock() do contain full memory barriers in payment for
5144 # synchronize_srcu_expedited() non-interruption properties.
5147 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5149 }
5151 # check of hardware specific defines
5152 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5155 }
5157 # Check that the storage class is at the beginning of a declaration
5161 }
5163 # check the location of the inline attribute, that it is between
5164 # storage class and type.
5169 }
5171 # Check for __inline__ and __inline, prefer inline
5179 }
5180 }
5182 # Check for __attribute__ packed, prefer __packed
5187 }
5189 # Check for __attribute__ aligned, prefer __aligned
5194 }
5196 # Check for __attribute__ format(printf, prefer __printf
5200 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5202 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5204 }
5205 }
5207 # Check for __attribute__ format(scanf, prefer __scanf
5211 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5213 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5214 }
5215 }
5217 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5219 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5224 }
5226 # check for c99 types like uint8_t used outside of uapi/
5240 }
5241 }
5242 }
5244 # check for sizeof(&)
5248 }
5250 # check for sizeof without parenthesis
5255 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5256 }
5257 }
5259 # check for struct spinlock declarations
5263 }
5265 # check for seq_printf uses that could be seq_puts
5274 }
5275 }
5276 }
5278 # Check for misused memsets
5293 }
5294 }
5296 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5301 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5303 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5304 }
5305 }
5307 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5312 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5313 }
5315 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5316 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5327 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5328 }
5333 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5334 }
5335 }
5336 }
5338 # typecasts on min/max could be min_t/max_t
5356 }
5359 }
5360 }
5362 # check usleep_range arguments
5370 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5374 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5375 }
5376 }
5378 # check for naked sscanf
5390 }
5393 }
5395 # check for simple sscanf that should be kstrto<foo>
5404 }
5412 }
5413 }
5414 }
5416 # check for new externs in .h files.
5423 }
5424 }
5426 # check for new externs in .c files.
5429 {
5436 }
5439 {
5442 }
5447 }
5451 {
5454 }
5456 # checks for new __setup's
5463 }
5464 }
5466 # check for pointless casting of kmalloc return
5469 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5470 }
5472 # alloc style
5473 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5475 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5478 }
5480 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5482 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5493 }
5499 $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;
5501 }
5502 }
5503 }
5505 # check for krealloc arg reuse
5510 }
5512 # check for alloc argument mismatch
5516 }
5518 # check for multiple semicolons
5524 }
5525 }
5527 # check for #defines like: 1 << <digit> that could be BIT(digit)
5535 }
5536 }
5538 # check for case / default statements not preceded by break/fallthrough/switch
5556 }
5560 }
5561 }
5563 # check for switch/default statements without a break;
5572 }
5575 }
5577 # check for gcc specific __FUNCTION__
5583 }
5584 }
5586 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5590 }
5592 # check for use of yield()
5596 }
5598 # check for comparisons against true and false
5614 }
5619 ## maybe suggesting a correct construct would better
5620 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5622 }
5623 }
5625 # check for semaphores initialized locked
5629 }
5631 # recommend kstrto* over simple_strto* and strict_strto*
5635 }
5637 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5640 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5641 }
5643 # check for various structs that are normally const (ops, kgdb, device_tree)
5645 acpi_dock_ops|
5646 address_space_operations|
5647 backlight_ops|
5648 block_device_operations|
5649 dentry_operations|
5650 dev_pm_ops|
5651 dma_map_ops|
5652 extent_io_ops|
5653 file_lock_operations|
5654 file_operations|
5655 hv_ops|
5656 ide_dma_ops|
5657 intel_dvo_dev_ops|
5658 item_operations|
5659 iwl_ops|
5660 kgdb_arch|
5661 kgdb_io|
5662 kset_uevent_ops|
5663 lock_manager_operations|
5664 microcode_ops|
5665 mtrr_ops|
5666 neigh_ops|
5667 nlmsvc_binding|
5668 of_device_id|
5669 pci_raw_ops|
5670 pipe_buf_operations|
5671 platform_hibernation_ops|
5672 platform_suspend_ops|
5673 proto_ops|
5674 rpc_pipe_ops|
5675 seq_operations|
5676 snd_ac97_build_ops|
5677 soc_pcmcia_socket_ops|
5678 stacktrace_ops|
5679 sysfs_ops|
5680 tty_operations|
5681 uart_ops|
5682 usb_mon_operations|
5689 }
5691 # use of NR_CPUS is usually wrong
5692 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5699 {
5701 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5702 }
5704 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5708 }
5710 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5715 }
5717 # whine mightly about in_atomic
5725 }
5726 }
5728 # check for lockdep_set_novalidate_class
5736 }
5737 }
5742 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5743 }
5745 # Mode permission misuses where it seems decimal should be octal
5746 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5757 }
5770 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5771 }
5772 }
5773 }
5774 }
5776 # validate content of MODULE_LICENSE against list from include/linux/module.h
5780 GPL|
5781 GPL\ v2|
5786 Proprietary
5791 }
5792 }
5793 }
5795 # If we have no input at all, then there is nothing to report on
5796 # so just keep quiet.
5799 }
5801 # In mailback mode only produce a report in the negative, for
5802 # things that appear to be patches.
5805 }
5807 # This is not a patch, and we are are in 'no-patch' mode so
5808 # just keep quiet.
5811 }
5816 }
5820 }
5828 }
5831 # If there were whitespace errors which cleanpatch can fix
5832 # then suggest that.
5839 EOM
5840 }
5841 }
5861 }
5864 }
5865 }
5873 Do _NOT_ trust the results written to this file.
5876 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
5878 EOM
5879 }
5880 }
5888 }
5889 }
5891 }