| blob | 4de3cc42fc50dca7a3d620ccca99cb4a55b685f5 |
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
67 Options:
72 --emacs emacs compile window format
73 --terse one line per report
76 single git commit with:
80 multiple git commits with:
84 git merges are ignored
99 is all off)
101 literally
104 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
105 with potential errors corrected to the preferred
106 checkpatch style
111 runtime errors.
114 --codespellfile Use this codespell dictionary
119 EOM
122 }
127 }
145 }
150 }
153 }
175 }
176 }
179 }
181 GetOptions(
228 }
229 }
231 #if no filenames are given, push '-' to read patch from stdin
234 }
250 }
251 }
260 }
262 }
263 }
273 ## no critic
276 }
283 }
289 }
296 }
297 }
302 }
303 }
313 __user|
314 __kernel|
315 __force|
316 __iomem|
317 __must_check|
318 __init_refok|
319 __kprobes|
320 __ref|
321 __rcu|
322 __private
330 # Notes to $Attribute:
331 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
333 const|
334 __percpu|
335 __nocast|
336 __safe|
337 __bitwise__|
338 __packed__|
339 __packed2__|
340 __naked|
341 __maybe_unused|
342 __always_unused|
343 __noreturn|
344 __used|
345 __cold|
346 __pure|
347 __noclone|
348 __deprecated|
349 __read_mostly|
350 __kprobes|
352 ____cacheline_aligned|
353 ____cacheline_aligned_in_smp|
354 ____cacheline_internodealigned_in_smp|
355 __weak
377 <=|>=|==|!=|
378 =>|->|<<|>>|<|>|!|~|
412 )};
415 atomic_t
416 )};
421 )};
427 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
429 panic|
432 )};
441 To:|
442 Cc:
443 )};
462 );
485 );
506 )};
513 );
517 );
524 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
527 );
529 #Create a search pattern for all these functions to speed up a loop below
534 }
537 S_IWUGO |
538 S_IWOTH |
539 S_IRWXUGO |
540 S_IALLUGO |
545 irq|
546 memory|
548 reboot
549 )};
550 # memory.h: ARM has a custom one
552 # Load common spelling mistakes and build regular expression list.
569 }
573 }
592 }
596 }
597 }
617 )
624 )
633 )
637 $NonptrType
642 $NonptrTypeMisordered
648 }
649 build_types();
653 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
654 # requires at least perl version v5.10.0
655 # Any use must be runtime checked with $^V
665 )};
674 }
679 }
703 }
704 }
705 }
729 }
731 }
739 }
743 }
748 }
752 }
760 }
762 }
763 }
777 # Maybe one day convert this block of bash into something that returns
778 # all matching commit ids, but it's very slow...
779 #
780 # echo "checking commits $1..."
781 # git rev-list --remotes | grep -i "^$1" |
782 # while read line ; do
783 # git log --format='%H %s' -1 $line |
784 # echo "commit $(cut -c 1-12,41-)"
785 # done
786 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
790 }
793 }
804 # If input is git commits, extract all commits from the commit expressions.
805 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
818 }
827 }
828 }
831 }
847 }
854 }
858 }
865 }
869 }
878 build_types();
879 }
890 EOM
891 }
897 EOM
898 }
899 }
910 );
915 }
916 }
918 }
941 # If there's a name left after stripping spaces and
942 # leading quotes, and the address doesn't have both
943 # leading and trailing angle brackets, the address
944 # is invalid. ie:
945 # "joe smith joe@smith.com" bad
946 # "joe smith <joe@smith.com" bad
951 }
952 }
962 }
965 }
979 }
985 }
988 }
996 }
997 }
1000 }
1008 }
1009 }
1012 }
1025 }
1027 }
1030 }
1033 }
1037 }
1042 # Drop the diff line leader and expand tabs
1046 # Pick the indent from the front of the line.
1050 }
1061 }
1062 }
1073 # Always copy over the diff marker.
1079 # Comments we are wacking completly including the begin
1080 # and end, all to $;.
1087 }
1093 }
1100 }
1102 # A \ in a string means ignore the next character.
1108 }
1109 # Regular quotes.
1118 }
1119 }
1121 #print "c<$c> SQ<$sanitise_quote>\n";
1130 }
1131 }
1135 }
1137 # The pathname on a #include may be surrounded by '<' and '>'.
1142 # The whole of a #error is a string.
1146 }
1151 }
1154 }
1161 }
1184 #warn "CSB: blk<$blk> remain<$remain>\n";
1185 # If we are about to drop off the end, pull in more
1186 # context.
1197 }
1198 # Bail if there is no further context.
1199 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1202 }
1206 }
1207 }
1212 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1214 # Handle nested #if/#else.
1221 }
1223 # Statement ends at the ';' or a close '}' at the
1224 # outermost level.
1227 }
1229 # An else is really a conditional as long as its not else if
1236 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1237 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1238 }
1243 }
1251 #warn "CSB: mark coff<$coff>\n";
1252 }
1253 }
1257 }
1265 }
1267 }
1268 }
1269 # Preprocessor commands end at the newline unless escaped.
1275 }
1277 }
1278 # We are truly at the end, so shuffle to the next line.
1283 }
1288 #warn "STATEMENT<$statement>\n";
1289 #warn "CONDITION<$condition>\n";
1291 #print "coff<$coff> soff<$off> loff<$loff>\n";
1295 }
1300 # Strip the diff line prefixes and rip blank lines at start and end.
1308 }
1316 }
1337 }
1338 }
1346 # Grab the first conditional/block pair.
1349 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1353 }
1355 # Pull in the following conditional/block pairs and see if they
1356 # could continue the statement.
1360 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1362 #print "C: push\n";
1364 }
1367 }
1386 # Handle nested #if/#else.
1393 }
1396 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1400 }
1407 }
1408 }
1412 }
1415 }
1418 }
1424 }
1430 }
1436 }
1441 }
1446 }
1451 # Catch a comment on the end of the line itself.
1455 # Look through the context and try and figure out if there is a
1456 # comment.
1461 #warn " $line\n";
1464 }
1467 }
1470 }
1474 }
1475 }
1479 }
1484 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1485 ##print "CMMT: $cmt\n";
1488 }
1501 }
1504 }
1516 }
1517 }
1521 }
1533 }
1553 }
1574 }
1603 # Assume all arms of the conditional end as this
1604 # one does, and continue as if the #endif was not here.
1621 }
1652 }
1664 }
1697 }
1712 }
1721 }
1725 }
1729 }
1730 }
1733 }
1742 DEFINE_\S+
1743 )$|
1747 case|
1751 \#|
1752 \#\#|
1758 # Check for modifiers.
1769 }
1770 }
1775 }
1776 build_types();
1779 }
1780 }
1790 }
1798 }
1807 }
1808 }
1813 }
1821 }
1827 }
1831 }
1842 }
1843 }
1870 }
1876 }
1883 }
1888 }
1891 }
1894 }
1902 };
1904 }
1912 };
1915 }
1924 }
1926 }
1934 }
1936 }
1944 }
1946 }
1952 ##print "absolute<$absolute>\n";
1954 # See if any suffix of this path is a path within the tree.
1957 ##print "file<$file>\n";
1959 }
1960 }
1963 }
1965 # It is, so see if the prefix is acceptable.
1969 ##print "prefix<$prefix>\n";
1973 }
1974 }
1982 }
1990 }
1998 }
2006 }
2015 #convert leading spaces to tabs
2017 #Remove spaces before a tab
2021 }
2035 }
2047 }
2048 }
2051 }
2088 # Trace the real file/line as we go.
2100 # suppression flags
2108 # Pre-scan the patch sanitizing the lines.
2109 # Pre-scan the patch looking for any __setup documentation.
2110 #
2116 sanitise_line_reset();
2128 }
2129 #next;
2130 }
2137 }
2140 # Guestimate if this is a continuing comment. Run
2141 # the context looking for a comment "edge". If this
2142 # edge is a close comment then we must be in a comment
2143 # at context start.
2150 #print "RAW<$rawlines[$ln - 1]>\n";
2156 }
2157 }
2160 }
2162 # Guestimate if this is a continuing comment. If this
2163 # is the start of a diff block and this line starts
2164 # ' *' then it is very likely a comment.
2167 {
2169 }
2171 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2175 # Standardise the strings and chars within the input to
2176 # simplify matching -- only bother with positive lines.
2178 }
2185 }
2187 #print "==>$rawline\n";
2188 #print "-->$line\n";
2192 }
2193 }
2208 #extract the line range in the file after the patch is applied
2218 }
2219 annotate_reset();
2228 # track the line number as we move through the hunk, note that
2229 # new versions of GNU diff omit the leading space on completely
2230 # blank context lines so we need to count that too.
2235 # Measure the line length and indent.
2238 # Track the previous line.
2243 #warn "line<$line>\n";
2247 }
2255 # extract the filename as it passes
2271 }
2275 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2276 }
2278 }
2280 #make up the handle for any error we report on this line
2288 }
2289 }
2296 }
2298 }
2308 # Check if the commit log has what seems like a diff which can confuse patch
2317 }
2319 # Check for incorrect file permissions
2326 }
2327 }
2329 # Check the patch for a signoff:
2333 }
2335 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2336 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2339 }
2341 # Check signature styles
2353 }
2360 }
2361 }
2368 }
2370 }
2377 }
2378 }
2389 # Don't force email to have quotes
2390 # Allow just an angle bracketed address
2396 }
2397 }
2399 # Check for duplicate signatures
2408 }
2409 }
2411 # Check email subject for common tools that don't need to be mentioned
2416 }
2418 # Check for old stable address
2422 }
2424 # Check for unwanted Gerrit info
2428 }
2430 # Check if the commit log is in a possible stack dump
2434 # timestamp
2436 # stack dump address
2438 }
2440 # Check for line lengths > 75 in commit log, warn once
2444 # file delta changes
2446 # filename then :
2448 # A Fixes: or Link: line
2453 }
2455 # Reset possible stack dump if a blank line is found
2459 }
2461 # Check for git id commit length and improperly formed commit descriptions
2485 }
2507 }
2514 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2515 }
2516 }
2518 # Check for added, moved or deleted files
2527 }
2529 # Check for wrappage within a valid hunk of the file
2534 }
2536 # Check for absolute kernel paths.
2543 #
2546 }
2547 }
2548 }
2550 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2561 }
2563 # Check if it's the start of a commit log
2564 # (not a header line and we haven't seen the patch filename)
2571 }
2573 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2574 # declined it, i.e defined some charset where it is missing.
2579 }
2585 }
2587 # Check for various typo / spelling mistakes
2601 }
2602 }
2603 }
2605 # ignore non-hunk lines and lines being removed
2608 #trailing whitespace
2615 }
2622 }
2625 }
2627 # Check for FSF mailing addresses.
2635 "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)
2636 }
2638 # check for Kconfig help text having a real description
2639 # Only applies when adding the entry originally, after that we do not have
2640 # sufficient context to determine whether it is indeed long enough.
2661 }
2670 }
2672 }
2676 }
2677 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2678 }
2680 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2684 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2685 }
2687 # discourage the use of boolean for type definition attributes of Kconfig options
2692 }
2702 };
2705 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2706 }
2708 # check for DT compatible documentation
2727 }
2734 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2735 }
2736 }
2737 }
2739 # check we are in a valid source file if not then ignore this hunk
2742 # line length limit (with some exclusions)
2743 #
2744 # There are a few types of lines that may extend beyond $max_line_length:
2745 # logging functions like pr_info that end in a string
2746 # lines with a single string
2747 # #defines that are a single string
2748 #
2749 # There are 3 different line length message types:
2750 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2751 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2752 # LONG_LINE all other lines longer than $max_line_length
2753 #
2754 # if LONG_LINE is ignored, the other 2 types are also ignored
2755 #
2760 # Check the allowed long line types first
2762 # logging functions that end in a string that starts
2763 # before $max_line_length
2764 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2768 # lines with only strings (w/ possible termination)
2769 # #defines with only strings
2774 # EFI_GUID is another special case
2778 # Otherwise set the alternate message types
2780 # a comment starts before $max_line_length
2785 # a quoted string starts before $max_line_length
2789 }
2795 }
2796 }
2798 # check for adding lines without a newline.
2799 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2802 }
2804 # Blackfin: use hi/lo macros
2810 }
2815 }
2816 }
2818 # check we are in a valid source file C or perl if not then ignore this hunk
2821 # at the beginning of a line any tabs must come first and anything
2822 # more than 8 must use tabs.
2831 }
2832 }
2834 # check for space before tabs.
2844 }
2845 }
2847 # check for && or || at the start of a line
2851 }
2853 # check indentation starts on a tab stop
2862 }
2863 }
2864 }
2866 # check multi-line statement indentation matches previous line
2868 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2891 }
2892 }
2893 }
2894 }
2896 # check for space after cast like "(int) foo" or "(struct foo) bar"
2897 # avoid checking a few false positives:
2898 # "sizeof(<type>)" or "__alignof__(<type>)"
2899 # function pointer declarations like "(*foo)(int) = bar;"
2900 # structure definitions like "(struct foo) { 0 };"
2901 # multiline macros that define functions
2902 # known attributes or the __attribute__ keyword
2910 }
2911 }
2913 # Block comment styles
2914 # Networking with an initial /*
2921 }
2923 # Block comments use * on subsequent lines
2931 }
2933 # Block comments use */ on trailing lines
2940 }
2942 # check for missing blank lines after struct/union declarations
2943 # with exceptions for various attributes and macros
2958 }
2959 }
2961 # check for multiple consecutive blank lines
2969 }
2972 }
2974 # check for missing blank lines after declarations
2976 # actual declarations
2978 # function pointer declarations
2980 # foo bar; where foo is some local typedef or #define
2982 # known declaration macros
2984 # for "else if" which can look like "$Ident $Ident"
2986 # other possible extensions of declaration lines
2988 # not starting a section or a macro "\" extended line
2990 # looks like a declaration
2992 # function pointer declarations
2994 # foo bar; where foo is some local typedef or #define
2996 # known declaration macros
2998 # start of struct or union or enum
3000 # start or end of block or continuation of declaration
3002 # bitfield continuation
3004 # other possible extensions of declaration lines
3006 # indentation of previous and current line are the same
3012 }
3013 }
3015 # check for spaces at the beginning of a line.
3016 # Exceptions:
3017 # 1) within comments
3018 # 2) indented preprocessor commands
3019 # 3) hanging labels
3026 }
3027 }
3029 # check we are in a valid C source file if not then ignore this hunk
3032 # check indentation of any line with a bare else
3033 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3034 # if the previous line is a break or return and is indented 1 tab more...
3043 }
3044 }
3046 # check indentation of a line with a break;
3047 # if the previous line is a goto or return and is indented the same # of tabs
3053 }
3054 }
3056 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3059 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3060 }
3062 # check for RCS/CVS revision markers
3066 }
3068 # Blackfin: don't use __builtin_bfin_[cs]sync
3073 }
3078 }
3080 # check for old HOTPLUG __dev<foo> section markings
3084 }
3086 # Check for potential 'bare' types
3089 #print "LINE<$line>\n";
3097 #print "linenr<$linenr> <$stat>\n";
3098 # If this statement has no statement boundaries within
3099 # it there is no point in retrying a statement scan
3100 # until we hit end of it.
3103 #print "skip<$line_nr_next>\n";
3105 }
3107 # Find the real next line.
3113 }
3118 # Ignore goto labels.
3121 # Ignore functions being called
3126 # declarations always start with types
3127 } 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) {
3132 # definitions in global scope can only start with types
3135 }
3137 # any (foo ... *) is a pointer cast, and foo is a type
3140 }
3142 # Check for any sort of function declaration.
3143 # int foo(something bar, other baz);
3144 # void (*store_gdt)(x86_descr_ptr *);
3145 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3153 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3156 }
3157 }
3158 }
3160 }
3162 #
3163 # Checks which may be anchored in the context.
3164 #
3166 # Check for switch () and associated case and default
3167 # statements should be at the same indent.
3181 }
3182 }
3186 }
3187 }
3189 # if/while/etc brace do not go on next line, unless defining a do while loop,
3190 # or if that brace on the next line is for something else
3191 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3199 }
3210 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3213 }
3215 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3216 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3222 }
3226 {
3232 }
3233 }
3234 }
3236 # Check relative indent for conditionals and blocks.
3237 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3245 # remove inline comments
3249 # Find out how long the conditional actually is.
3253 # Make sure we remove the line prefixes as we have
3254 # none on the first line, and are going to readd them
3255 # where necessary.
3259 }
3261 # We want to check the first line inside the block
3262 # starting at the end of the conditional, so remove:
3263 # 1) any blank line termination
3264 # 2) any opening brace { on end of the line
3265 # 3) any do (...) {
3272 }
3276 }
3278 # Also ignore a loop construct at the end of a
3279 # preprocessor statement.
3283 }
3290 # If we see an #else/#elif then the code
3291 # is not linear.
3294 }
3296 # Ignore:
3297 # 1) blank lines, they should be at 0,
3298 # 2) preprocessor lines, and
3299 # 3) labels.
3307 }
3308 }
3309 }
3314 # Check if either of these lines are modified, else
3315 # this is not this patch's fault.
3319 }
3322 }
3324 #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";
3331 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3332 }
3333 }
3335 # Track the 'values' across context and added lines.
3345 }
3348 #ignore lines not being added
3351 # check for declarations of signed or unsigned without int
3352 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3363 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3371 }
3372 }
3373 }
3375 # TEST: allow direct testing of the type matcher.
3383 }
3385 }
3386 # TEST: allow direct testing of the attribute matcher.
3394 }
3396 }
3398 # check for initialisation to aggregates open brace on the next line
3412 }
3413 }
3415 #
3416 # Checks which are anchored on the added line.
3417 #
3419 # check for malformed paths in #include statements (uses RAW line)
3425 }
3429 }
3430 }
3432 # no C99 // comments
3441 }
3442 }
3443 }
3444 # Remove C99 comments.
3448 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3449 # the whole statement.
3450 #print "APW <$lines[$realline_next - 1]>\n";
3456 # Handle definitions which produce identifiers with
3457 # a prefix:
3458 # XXX(foo);
3459 # EXPORT_SYMBOL(something_foo);
3463 #print "FOO C name<$name>\n";
3474 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3478 }
3479 }
3484 #print "FOO B <$lines[$linenr - 1]>\n";
3486 }
3491 }
3493 # check for global initialisers.
3499 }
3500 }
3501 # check for static initialisers.
3508 }
3509 }
3511 # check for misordered declarations of char/short/int/long with signed/unsigned
3515 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3516 }
3518 # check for static const char * arrays.
3523 }
3525 # check for static char foo[] = "bar" declarations.
3530 }
3532 # check for const <foo> const where <foo> is not a pointer or array type
3541 }
3542 }
3544 # check for non-global char *foo[] = {"bar", ...} declarations.
3549 }
3551 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3554 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3560 }
3561 }
3562 }
3564 # check for function declarations without arguments like "int foo()"
3570 }
3571 }
3573 # check for uses of DEFINE_PCI_DEVICE_TABLE
3578 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3579 }
3580 }
3582 # check for new typedefs, only function parameters and sparse annotations
3583 # make sense.
3591 }
3593 # * goes on variable not on type
3594 # (char*[ const])
3596 #print "AA<$1>\n";
3599 # Should start with a space.
3601 # Should not end with a space.
3603 # '*'s should not have spaces between.
3605 }
3607 ## print "1: from<$from> to<$to> ident<$ident>\n";
3617 }
3618 }
3619 }
3621 #print "BB<$1>\n";
3624 # Should start with a space.
3626 # Should not end with a space.
3628 # '*'s should not have spaces between.
3630 }
3631 # Modifiers should have spaces.
3634 ## print "2: from<$from> to<$to> ident<$ident>\n";
3645 }
3646 }
3647 }
3649 # avoid BUG() or BUG_ON()
3654 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3655 }
3657 # avoid LINUX_VERSION_CODE
3660 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3661 }
3663 # check for uses of printk_ratelimit
3667 }
3669 # printk should use KERN_* levels. Note that follow on printk's on the
3670 # same line do not need a level, so we use the current block context
3671 # to try and find and validate the current printk. In summary the current
3672 # printk includes all preceding printk's which have no newline on the end.
3673 # we assume the first bad printk is the one to report.
3677 #print "CHECK<$lines[$ln - 1]\n";
3678 # we have a preceding printk if it ends
3679 # with "\n" ignore it, else it is to blame
3683 }
3685 }
3686 }
3690 }
3691 }
3700 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3701 }
3709 }
3710 }
3719 }
3721 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3722 # number of false positives, but assembly files are not checked, so at
3723 # least the arch entry code will not trigger this warning.
3727 }
3729 # function brace can't be on same line, except for #defines of do while,
3730 # or if closed on same line
3745 }
3746 }
3747 }
3749 # open braces for enum, union and struct go on the same line.
3763 }
3764 }
3765 }
3767 # missing space after union, struct or enum definition
3774 }
3775 }
3777 # Function pointer declarations
3778 # check spacing between type, funcptr, and args
3779 # canonical declaration is "type (*funcptr)(args...)"
3788 # the $Declare variable will capture all spaces after the type
3789 # so check it for a missing trailing missing space but pointer return types
3790 # don't need a space so don't warn for those.
3795 }
3800 }
3802 # unnecessary space "type (*funcptr)(args...)"
3803 # This test is not currently implemented because these declarations are
3804 # equivalent to
3805 # int foo(int bar, ...)
3806 # and this is form shouldn't/doesn't generate a checkpatch warning.
3807 #
3808 # elsif ($declare =~ /\s{2,}$/) {
3809 # WARN("SPACING",
3810 # "Multiple spaces after return type\n" . $herecurr);
3811 # }
3813 # unnecessary space "type ( *funcptr)(args...)"
3818 }
3820 # unnecessary space "type (* funcptr)(args...)"
3825 }
3827 # unnecessary space "type (*funcptr )(args...)"
3832 }
3834 # unnecessary space "type (*funcptr) (args...)"
3839 }
3843 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3844 }
3845 }
3847 # check for spacing round square brackets; allowed:
3848 # 1. with a type on the left -- int [] a;
3849 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3850 # 3. inside a curly brace -- = { [0...10] = 5 }
3861 }
3862 }
3863 }
3865 # check for spaces between functions and their parentheses.
3871 # Ignore those directives where spaces _are_ permitted.
3877 {
3878 # cpp #define statements have non-optional spaces, ie
3879 # if there is a space between the name and the open
3880 # parenthesis it is simply not a parameter group.
3883 # cpp #elif statement condition may start with a (
3886 # If this whole things ends with a type its most
3887 # likely a typedef for a function.
3896 }
3897 }
3898 }
3900 # Check operator spacing.
3906 <<=|>>=|<=|>=|==|!=|
3908 =>|->|<<|>>|<|>|=|!|~|
3914 ## print("element count: <" . $#elements . ">\n");
3915 ## foreach my $el (@elements) {
3916 ## print("el: <$el>\n");
3917 ## }
3925 }
3936 ## print("n: <$n> good: <$good>\n");
3940 # Pick up the preceding and succeeding characters.
3945 }
3968 }
3977 # Pull out the value of this operator.
3980 # Get the full operator variant.
3983 # Ignore operators passed as parameters.
3987 # # Ignore comments
3988 # } elsif ($op =~ /^$;+$/) {
3990 # ; should have either the end of line or a space or \ after it
3998 }
3999 }
4001 # // is a comment
4004 # : when part of a bitfield
4006 # skip the bitfield test for now
4008 # No spaces for:
4009 # ->
4017 }
4019 }
4020 }
4022 # , must not have a space before and must have a space on the right.
4031 }
4032 }
4039 }
4040 }
4046 }
4049 }
4050 }
4052 # '*' as part of a type definition -- reported already.
4054 #warn "'*' is part of type\n";
4056 # unary operators should have a space before and
4057 # none after. May be left adjacent to another
4058 # unary operator, or a cast
4068 }
4069 }
4070 }
4072 # A unary '*' may be const
4080 }
4082 }
4083 }
4085 # unary ++ and unary -- are allowed no space on one side.
4092 }
4093 }
4100 }
4101 }
4108 }
4110 }
4111 }
4113 # << and >> may either have or not have spaces both sides
4119 {
4127 }
4133 }
4134 }
4141 }
4143 }
4144 }
4146 # A colon needs no spaces before when it is
4147 # terminating a case value or a label.
4154 }
4155 }
4157 # All the others need spaces both sides.
4161 # Ignore email addresses <foo@bar>
4166 {
4168 }
4170 # for asm volatile statements
4171 # ignore a colon with another
4172 # colon immediately before or after
4176 }
4178 # messages are ERROR, but ?: are CHK
4188 }
4190 }
4191 }
4192 }
4195 ## print("n: <$n> GOOD: <$good>\n");
4198 }
4202 }
4206 }
4209 }
4211 # check for whitespace before a non-naked semicolon
4218 }
4219 }
4221 # check for multiple assignments
4225 }
4227 ## # check for multiple declarations, allowing for a function declaration
4228 ## # continuation.
4229 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4230 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4231 ##
4232 ## # Remove any bracketed sections to ensure we do not
4233 ## # falsly report the parameters of functions.
4234 ## my $ln = $line;
4235 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4236 ## }
4237 ## if ($ln =~ /,/) {
4238 ## WARN("MULTIPLE_DECLARATION",
4239 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4240 ## }
4241 ## }
4243 #need space before brace following if, while, etc
4250 }
4251 }
4253 ## # check for blank lines before declarations
4254 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4255 ## $prevrawline =~ /^.\s*$/) {
4256 ## WARN("SPACING",
4257 ## "No blank lines before declarations\n" . $hereprev);
4258 ## }
4259 ##
4261 # closing brace should have a space following it when it has anything
4262 # on the line
4269 }
4270 }
4272 # check spacing on square brackets
4279 }
4280 }
4287 }
4288 }
4290 # check spacing on parentheses
4298 }
4299 }
4308 }
4309 }
4311 # check unnecessary parentheses around addressof/dereference single $Lvals
4312 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4320 }
4321 }
4323 # check for unnecessary parentheses around function pointer uses
4324 # ie: (foo->bar)(); should be foo->bar();
4325 # but not "if (foo->bar) (" to avoid some false positives
4334 }
4335 }
4337 #goto labels aren't indented, allow a single space however
4345 }
4346 }
4348 # return is not a function
4358 }
4362 }
4363 }
4365 # unnecessary return in a void function
4366 # at end-of-function, with the previous line a single leading tab, then return;
4367 # and the line before that not a goto label target like "out:"
4375 }
4377 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4383 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4388 }
4389 }
4391 # comparisons with a constant or upper case identifier on the left
4392 # avoid cases like "foo + BAR < baz"
4393 # only fix matches surrounded by parentheses to avoid incorrect
4394 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4415 }
4417 }
4418 }
4420 # Return of what appears to be an errno should normally be negative
4426 }
4427 }
4429 # Need a space before open parenthesis after if, while etc
4436 }
4437 }
4439 # Check for illegal assignment in if conditional -- and check for trailing
4440 # statements after the conditional.
4448 ##print "stat<$stat> stat_next<$stat_next>\n";
4451 # If the statement carries leading newlines,
4452 # then count those as offsets.
4460 }
4461 }
4470 }
4472 # Find out what is on the end of the line after the
4473 # conditional.
4479 {
4480 # Find out how long the conditional actually is.
4489 }
4493 }
4494 }
4496 # Check for bitwise tests written as boolean
4502 |
4507 {
4510 }
4512 # if and else should not have general statements after it
4519 }
4520 }
4521 # if should not continue a brace
4526 }
4527 # case and default should not have general statements after them
4533 {
4536 }
4538 # Check for }<nl>else {, these must be at the same
4539 # indent level to be relevant to each other.
4551 }
4555 }
4556 }
4562 # Find out what is on the end of the line after the
4563 # conditional.
4579 }
4580 }
4581 }
4583 #Specific variable tests
4587 #gcc binary extension
4595 }
4596 }
4598 #CamelCase
4601 #Ignore Page<foo> variants
4603 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4605 #Ignore some three character SI units explicitly, like MiB and KHz
4611 seed_camelcase_includes();
4615 }
4616 }
4621 }
4622 }
4623 }
4624 }
4626 #no spaces allowed after \ in define
4632 }
4633 }
4635 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4636 # itself <asm/foo.h> (uses RAW line)
4643 {
4652 }
4653 }
4654 }
4655 }
4657 # multi-statement macros should be enclosed in a do while loop, grab the
4658 # first statement and ensure its the whole macro if its not enclosed
4659 # in a known good container
4671 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4672 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4683 # Flatten any parentheses and braces
4687 {
4688 }
4690 # Flatten any obvious string concatentation.
4693 {
4694 }
4696 # Make asm volatile uses seem like a generic function
4701 module_param_named|
4702 MODULE_PARM_DESC|
4703 DECLARE_PER_CPU|
4704 DEFINE_PER_CPU|
4705 __typeof__\(|
4706 union|
4707 struct|
4712 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4716 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4721 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4727 {
4734 }
4742 }
4743 }
4745 # check for macros with flow control, but without ## concatenation
4746 # ## concatenation is commonly a macro that defines a function so ignore those
4753 }
4756 }
4758 # check for line continuations outside of #defines, preprocessor #, and asm
4767 }
4768 }
4770 # do {} while (0) macro tests:
4771 # single-statement macros do not need to be enclosed in do while (0) loop,
4772 # macro should not end with a semicolon
4787 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4797 }
4803 }
4807 }
4815 }
4819 }
4820 }
4822 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4823 # all assignments may have only one of the following with an assignment:
4824 # .
4825 # ALIGN(...)
4826 # VMLINUX_SYMBOL(...)
4830 }
4832 # check for redundant bracing round if etc
4836 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4837 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4847 # If the condition carries leading newlines, then count those as offsets.
4852 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4854 # We have looked at and allowed this specific line.
4864 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4866 #print "APW: ALLOWED: cond<$cond>\n";
4868 }
4870 #print "APW: ALLOWED: block<$block>\n";
4872 }
4874 #print "APW: ALLOWED: lines block<$block>\n";
4876 }
4878 }
4883 }
4891 }
4892 }
4893 }
4894 }
4899 # Check the pre-context.
4901 #print "APW: ALLOWED: pre<$1>\n";
4903 }
4908 # Check the condition.
4910 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4913 }
4915 #print "APW: ALLOWED: cond<$cond>\n";
4917 }
4919 #print "APW: ALLOWED: block<$block>\n";
4921 }
4923 #print "APW: ALLOWED: lines block<$block>\n";
4925 }
4926 # Check the post-context.
4931 }
4933 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4935 }
4936 }
4943 }
4947 }
4948 }
4950 # check for unnecessary blank lines around braces
4956 }
4957 }
4963 }
4964 }
4966 # no volatiles please
4970 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4971 }
4973 # Check for user-visible strings broken across lines, which breaks the ability
4974 # to grep for the string. Make exceptions when the previous string ends in a
4975 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4976 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4989 }
5001 }
5003 }
5004 }
5006 # check for missing a space in a string concatenation
5010 }
5012 # check for spaces before a quoted newline
5018 }
5020 }
5022 # concatenated string without spaces between elements
5026 }
5028 # uncoalesced string fragments
5032 }
5034 # check for %L{u,d,i} and 0x%[udi] in strings
5043 }
5047 }
5048 }
5050 # check for line continuations in quoted strings with odd counts of "
5054 }
5056 # warn about #if 0
5061 }
5063 # check for needless "if (<foo>) fn(<foo>)" uses
5067 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5079 }
5084 }
5087 }
5091 }
5092 }
5093 }
5094 }
5096 # check for unnecessary "Out of Memory" messages
5105 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5107 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5110 }
5111 }
5113 # check for logging functions with KERN_<LEVEL>
5121 }
5122 }
5124 # check for mask then right shift without a parentheses
5130 }
5132 # check for pointer comparisons to NULL
5142 }
5143 }
5144 }
5146 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5149 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5159 $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;
5160 }
5161 }
5162 }
5164 # check for $InitAttributeData (ie: __initdata) with const
5175 }
5176 }
5178 # check for $InitAttributeConst (ie: __initconst) without const
5190 }
5191 }
5193 # check for __read_mostly with const non-pointer (should just be const)
5200 }
5201 }
5203 # don't use __constant_<foo> functions outside of include/uapi/
5205 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5213 }
5214 }
5216 # prefer usleep_range over udelay
5219 # ignore udelay's < 10, however
5222 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5223 }
5227 }
5228 }
5230 # warn about unexpectedly long msleep's
5234 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5235 }
5236 }
5238 # check for comparisons of jiffies
5241 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5242 }
5244 # check for comparisons of get_jiffies_64()
5247 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5248 }
5250 # warn about #ifdefs in C files
5251 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5252 # print "#ifdef in C files should be avoided\n";
5253 # print "$herecurr";
5254 # $clean = 0;
5255 # }
5257 # warn about spacing in #ifdefs
5264 }
5266 }
5268 # check for spinlock_t definitions without a comment.
5275 }
5276 }
5277 # check for memory barriers without a comment.
5280 mb|
5281 rmb|
5282 wmb|
5283 read_barrier_depends
5286 mb__before_atomic|
5287 mb__after_atomic|
5288 store_release|
5289 load_acquire|
5290 store_mb|
5303 }
5304 }
5314 }
5316 # check for waitqueue_active without a comment.
5321 }
5322 }
5324 # Check for expedited grace periods that interrupt non-idle non-nohz
5325 # online CPUs. These expedited can therefore degrade real-time response
5326 # if used carelessly, and should be avoided where not absolutely
5327 # needed. It is always OK to use synchronize_rcu_expedited() and
5328 # synchronize_sched_expedited() at boot time (before real-time applications
5329 # start) and in error situations where real-time response is compromised in
5330 # any case. Note that synchronize_srcu_expedited() does -not- interrupt
5331 # other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5332 # Of course, nothing comes for free, and srcu_read_lock() and
5333 # srcu_read_unlock() do contain full memory barriers in payment for
5334 # synchronize_srcu_expedited() non-interruption properties.
5337 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5339 }
5341 # check of hardware specific defines
5342 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5345 }
5347 # Check that the storage class is at the beginning of a declaration
5351 }
5353 # check the location of the inline attribute, that it is between
5354 # storage class and type.
5359 }
5361 # Check for __inline__ and __inline, prefer inline
5369 }
5370 }
5372 # Check for __attribute__ packed, prefer __packed
5377 }
5379 # Check for __attribute__ aligned, prefer __aligned
5384 }
5386 # Check for __attribute__ format(printf, prefer __printf
5390 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5392 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5394 }
5395 }
5397 # Check for __attribute__ format(scanf, prefer __scanf
5401 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5403 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5404 }
5405 }
5407 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5409 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5414 }
5416 # check for c99 types like uint8_t used outside of uapi/
5430 }
5431 }
5432 }
5434 # check for cast of C90 native int or longer types constants
5449 }
5451 }
5452 }
5454 # check for sizeof(&)
5458 }
5460 # check for sizeof without parenthesis
5465 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5466 }
5467 }
5469 # check for struct spinlock declarations
5473 }
5475 # check for seq_printf uses that could be seq_puts
5484 }
5485 }
5486 }
5488 # Check for misused memsets
5503 }
5504 }
5506 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5511 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5513 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5514 }
5515 }
5517 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5522 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5523 }
5525 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5526 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5537 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5538 }
5543 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5544 }
5545 }
5546 }
5548 # typecasts on min/max could be min_t/max_t
5566 }
5569 }
5570 }
5572 # check usleep_range arguments
5580 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5584 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5585 }
5586 }
5588 # check for naked sscanf
5600 }
5603 }
5605 # check for simple sscanf that should be kstrto<foo>
5614 }
5622 }
5623 }
5624 }
5626 # check for new externs in .h files.
5633 }
5634 }
5636 # check for new externs in .c files.
5639 {
5646 }
5649 {
5652 }
5657 }
5661 {
5664 }
5666 # checks for new __setup's
5673 }
5674 }
5676 # check for pointless casting of kmalloc return
5679 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5680 }
5682 # alloc style
5683 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5685 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5688 }
5690 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5692 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5703 }
5709 $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;
5711 }
5712 }
5713 }
5715 # check for krealloc arg reuse
5720 }
5722 # check for alloc argument mismatch
5726 }
5728 # check for multiple semicolons
5734 }
5735 }
5737 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5746 }
5747 }
5749 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5750 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5756 }
5757 }
5759 # check for case / default statements not preceded by break/fallthrough/switch
5777 }
5781 }
5782 }
5784 # check for switch/default statements without a break;
5793 }
5796 }
5798 # check for gcc specific __FUNCTION__
5804 }
5805 }
5807 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5811 }
5813 # check for use of yield()
5817 }
5819 # check for comparisons against true and false
5835 }
5840 ## maybe suggesting a correct construct would better
5841 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5843 }
5844 }
5846 # check for semaphores initialized locked
5850 }
5852 # recommend kstrto* over simple_strto* and strict_strto*
5856 }
5858 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5861 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5862 }
5864 # check for various structs that are normally const (ops, kgdb, device_tree)
5866 acpi_dock_ops|
5867 address_space_operations|
5868 backlight_ops|
5869 block_device_operations|
5870 dentry_operations|
5871 dev_pm_ops|
5872 dma_map_ops|
5873 extent_io_ops|
5874 file_lock_operations|
5875 file_operations|
5876 hv_ops|
5877 ide_dma_ops|
5878 intel_dvo_dev_ops|
5879 item_operations|
5880 iwl_ops|
5881 kgdb_arch|
5882 kgdb_io|
5883 kset_uevent_ops|
5884 lock_manager_operations|
5885 microcode_ops|
5886 mtrr_ops|
5887 neigh_ops|
5888 nlmsvc_binding|
5889 of_device_id|
5890 pci_raw_ops|
5891 pipe_buf_operations|
5892 platform_hibernation_ops|
5893 platform_suspend_ops|
5894 proto_ops|
5895 rpc_pipe_ops|
5896 seq_operations|
5897 snd_ac97_build_ops|
5898 soc_pcmcia_socket_ops|
5899 stacktrace_ops|
5900 sysfs_ops|
5901 tty_operations|
5902 uart_ops|
5903 usb_mon_operations|
5910 }
5912 # use of NR_CPUS is usually wrong
5913 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5920 {
5922 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5923 }
5925 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5929 }
5931 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5936 }
5938 # whine mightly about in_atomic
5946 }
5947 }
5949 # whine about ACCESS_ONCE
5960 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
5961 }
5967 }
5968 }
5969 }
5971 # check for lockdep_set_novalidate_class
5979 }
5980 }
5985 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5986 }
5988 # Mode permission misuses where it seems decimal should be octal
5989 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6000 }
6013 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6014 }
6015 }
6016 }
6017 }
6019 # validate content of MODULE_LICENSE against list from include/linux/module.h
6023 GPL|
6024 GPL\ v2|
6029 Proprietary
6034 }
6035 }
6036 }
6038 # If we have no input at all, then there is nothing to report on
6039 # so just keep quiet.
6042 }
6044 # In mailback mode only produce a report in the negative, for
6045 # things that appear to be patches.
6048 }
6050 # This is not a patch, and we are are in 'no-patch' mode so
6051 # just keep quiet.
6054 }
6059 }
6063 }
6071 }
6074 # If there were any defects found and not already fixing them
6080 EOM
6081 }
6082 # If there were whitespace errors which cleanpatch can fix
6083 # then suggest that.
6090 EOM
6091 }
6092 }
6112 }
6115 }
6116 }
6124 Do _NOT_ trust the results written to this file.
6127 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6129 EOM
6130 }
6131 }
6139 }
6140 }
6142 }