| blob | 4904ced676d40289356aa3358f894fa7efa4b5c0 |
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
66 Options:
71 --emacs emacs compile window format
72 --terse one line per report
75 single git commit with:
79 multiple git commits with:
83 git merges are ignored
98 is all off)
100 literally
103 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
104 with potential errors corrected to the preferred
105 checkpatch style
110 runtime errors.
113 --codespellfile Use this codespell dictionary
118 EOM
121 }
126 }
144 }
149 }
152 }
174 }
175 }
178 }
180 GetOptions(
227 }
228 }
233 }
249 }
250 }
259 }
261 }
262 }
272 ## no critic
275 }
282 }
288 }
295 }
296 }
301 }
302 }
312 __user|
313 __kernel|
314 __force|
315 __iomem|
316 __pmem|
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 }
1149 }
1156 }
1179 #warn "CSB: blk<$blk> remain<$remain>\n";
1180 # If we are about to drop off the end, pull in more
1181 # context.
1192 }
1193 # Bail if there is no further context.
1194 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1197 }
1201 }
1202 }
1207 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1209 # Handle nested #if/#else.
1216 }
1218 # Statement ends at the ';' or a close '}' at the
1219 # outermost level.
1222 }
1224 # An else is really a conditional as long as its not else if
1231 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1232 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1233 }
1238 }
1246 #warn "CSB: mark coff<$coff>\n";
1247 }
1248 }
1252 }
1260 }
1262 }
1263 }
1264 # Preprocessor commands end at the newline unless escaped.
1270 }
1272 }
1273 # We are truly at the end, so shuffle to the next line.
1278 }
1283 #warn "STATEMENT<$statement>\n";
1284 #warn "CONDITION<$condition>\n";
1286 #print "coff<$coff> soff<$off> loff<$loff>\n";
1290 }
1295 # Strip the diff line prefixes and rip blank lines at start and end.
1303 }
1311 }
1332 }
1333 }
1341 # Grab the first conditional/block pair.
1344 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1348 }
1350 # Pull in the following conditional/block pairs and see if they
1351 # could continue the statement.
1355 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1357 #print "C: push\n";
1359 }
1362 }
1381 # Handle nested #if/#else.
1388 }
1391 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1395 }
1402 }
1403 }
1407 }
1410 }
1413 }
1419 }
1425 }
1431 }
1436 }
1441 }
1446 # Catch a comment on the end of the line itself.
1450 # Look through the context and try and figure out if there is a
1451 # comment.
1456 #warn " $line\n";
1459 }
1462 }
1465 }
1469 }
1470 }
1474 }
1479 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1480 ##print "CMMT: $cmt\n";
1483 }
1496 }
1499 }
1511 }
1512 }
1516 }
1528 }
1548 }
1569 }
1598 # Assume all arms of the conditional end as this
1599 # one does, and continue as if the #endif was not here.
1616 }
1647 }
1659 }
1692 }
1707 }
1716 }
1720 }
1724 }
1725 }
1728 }
1737 DEFINE_\S+
1738 )$|
1742 case|
1746 \#|
1747 \#\#|
1753 # Check for modifiers.
1764 }
1765 }
1770 }
1771 build_types();
1774 }
1775 }
1785 }
1793 }
1802 }
1803 }
1808 }
1816 }
1822 }
1826 }
1837 }
1838 }
1865 }
1871 }
1878 }
1883 }
1886 }
1889 }
1897 };
1899 }
1907 };
1910 }
1919 }
1921 }
1929 }
1931 }
1939 }
1941 }
1947 ##print "absolute<$absolute>\n";
1949 # See if any suffix of this path is a path within the tree.
1952 ##print "file<$file>\n";
1954 }
1955 }
1958 }
1960 # It is, so see if the prefix is acceptable.
1964 ##print "prefix<$prefix>\n";
1968 }
1969 }
1977 }
1985 }
1993 }
2001 }
2010 #convert leading spaces to tabs
2012 #Remove spaces before a tab
2016 }
2030 }
2042 }
2043 }
2046 }
2082 # Trace the real file/line as we go.
2094 # suppression flags
2102 # Pre-scan the patch sanitizing the lines.
2103 # Pre-scan the patch looking for any __setup documentation.
2104 #
2110 sanitise_line_reset();
2122 }
2123 #next;
2124 }
2131 }
2134 # Guestimate if this is a continuing comment. Run
2135 # the context looking for a comment "edge". If this
2136 # edge is a close comment then we must be in a comment
2137 # at context start.
2144 #print "RAW<$rawlines[$ln - 1]>\n";
2150 }
2151 }
2154 }
2156 # Guestimate if this is a continuing comment. If this
2157 # is the start of a diff block and this line starts
2158 # ' *' then it is very likely a comment.
2161 {
2163 }
2165 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2169 # Standardise the strings and chars within the input to
2170 # simplify matching -- only bother with positive lines.
2172 }
2179 }
2181 #print "==>$rawline\n";
2182 #print "-->$line\n";
2186 }
2187 }
2202 #extract the line range in the file after the patch is applied
2212 }
2213 annotate_reset();
2222 # track the line number as we move through the hunk, note that
2223 # new versions of GNU diff omit the leading space on completely
2224 # blank context lines so we need to count that too.
2229 # Measure the line length and indent.
2232 # Track the previous line.
2237 #warn "line<$line>\n";
2241 }
2249 # extract the filename as it passes
2265 }
2269 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2270 }
2272 }
2274 #make up the handle for any error we report on this line
2282 }
2283 }
2290 }
2292 }
2302 # Check if the commit log has what seems like a diff which can confuse patch
2311 }
2313 # Check for incorrect file permissions
2320 }
2321 }
2323 # Check the patch for a signoff:
2327 }
2329 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2330 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2333 }
2335 # Check signature styles
2347 }
2354 }
2355 }
2362 }
2364 }
2371 }
2372 }
2383 # Don't force email to have quotes
2384 # Allow just an angle bracketed address
2390 }
2391 }
2393 # Check for duplicate signatures
2402 }
2403 }
2405 # Check email subject for common tools that don't need to be mentioned
2410 }
2412 # Check for old stable address
2416 }
2418 # Check for unwanted Gerrit info
2422 }
2424 # Check if the commit log is in a possible stack dump
2428 # timestamp
2430 # stack dump address
2432 }
2434 # Check for line lengths > 75 in commit log, warn once
2438 # file delta changes
2440 # filename then :
2442 # A Fixes: or Link: line
2447 }
2449 # Reset possible stack dump if a blank line is found
2453 }
2455 # Check for git id commit length and improperly formed commit descriptions
2479 }
2501 }
2508 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2509 }
2510 }
2512 # Check for added, moved or deleted files
2521 }
2523 # Check for wrappage within a valid hunk of the file
2528 }
2530 # Check for absolute kernel paths.
2537 #
2540 }
2541 }
2542 }
2544 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2555 }
2557 # Check if it's the start of a commit log
2558 # (not a header line and we haven't seen the patch filename)
2564 }
2566 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2567 # declined it, i.e defined some charset where it is missing.
2572 }
2578 }
2580 # Check for various typo / spelling mistakes
2594 }
2595 }
2596 }
2598 # ignore non-hunk lines and lines being removed
2601 #trailing whitespace
2608 }
2615 }
2618 }
2620 # Check for FSF mailing addresses.
2628 "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)
2629 }
2631 # check for Kconfig help text having a real description
2632 # Only applies when adding the entry originally, after that we do not have
2633 # sufficient context to determine whether it is indeed long enough.
2654 }
2663 }
2665 }
2669 }
2670 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2671 }
2673 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2677 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2678 }
2680 # discourage the use of boolean for type definition attributes of Kconfig options
2685 }
2695 };
2698 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2699 }
2701 # check for DT compatible documentation
2720 }
2727 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2728 }
2729 }
2730 }
2732 # check we are in a valid source file if not then ignore this hunk
2735 # line length limit (with some exclusions)
2736 #
2737 # There are a few types of lines that may extend beyond $max_line_length:
2738 # logging functions like pr_info that end in a string
2739 # lines with a single string
2740 # #defines that are a single string
2741 #
2742 # There are 3 different line length message types:
2743 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2744 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2745 # LONG_LINE all other lines longer than $max_line_length
2746 #
2747 # if LONG_LINE is ignored, the other 2 types are also ignored
2748 #
2753 # Check the allowed long line types first
2755 # logging functions that end in a string that starts
2756 # before $max_line_length
2757 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2761 # lines with only strings (w/ possible termination)
2762 # #defines with only strings
2767 # Otherwise set the alternate message types
2769 # a comment starts before $max_line_length
2774 # a quoted string starts before $max_line_length
2778 }
2784 }
2785 }
2787 # check for adding lines without a newline.
2788 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2791 }
2793 # Blackfin: use hi/lo macros
2799 }
2804 }
2805 }
2807 # check we are in a valid source file C or perl if not then ignore this hunk
2810 # at the beginning of a line any tabs must come first and anything
2811 # more than 8 must use tabs.
2820 }
2821 }
2823 # check for space before tabs.
2833 }
2834 }
2836 # check for && or || at the start of a line
2840 }
2842 # check indentation starts on a tab stop
2851 }
2852 }
2853 }
2855 # check multi-line statement indentation matches previous line
2857 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2880 }
2881 }
2882 }
2883 }
2885 # check for space after cast like "(int) foo" or "(struct foo) bar"
2886 # avoid checking a few false positives:
2887 # "sizeof(<type>)" or "__alignof__(<type>)"
2888 # function pointer declarations like "(*foo)(int) = bar;"
2889 # structure definitions like "(struct foo) { 0 };"
2890 # multiline macros that define functions
2891 # known attributes or the __attribute__ keyword
2899 }
2900 }
2902 # Block comment styles
2903 # Networking with an initial /*
2910 }
2912 # Block comments use * on subsequent lines
2920 }
2922 # Block comments use */ on trailing lines
2929 }
2931 # check for missing blank lines after struct/union declarations
2932 # with exceptions for various attributes and macros
2947 }
2948 }
2950 # check for multiple consecutive blank lines
2958 }
2961 }
2963 # check for missing blank lines after declarations
2965 # actual declarations
2967 # function pointer declarations
2969 # foo bar; where foo is some local typedef or #define
2971 # known declaration macros
2973 # for "else if" which can look like "$Ident $Ident"
2975 # other possible extensions of declaration lines
2977 # not starting a section or a macro "\" extended line
2979 # looks like a declaration
2981 # function pointer declarations
2983 # foo bar; where foo is some local typedef or #define
2985 # known declaration macros
2987 # start of struct or union or enum
2989 # start or end of block or continuation of declaration
2991 # bitfield continuation
2993 # other possible extensions of declaration lines
2995 # indentation of previous and current line are the same
3001 }
3002 }
3004 # check for spaces at the beginning of a line.
3005 # Exceptions:
3006 # 1) within comments
3007 # 2) indented preprocessor commands
3008 # 3) hanging labels
3015 }
3016 }
3018 # check we are in a valid C source file if not then ignore this hunk
3021 # check indentation of any line with a bare else
3022 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3023 # if the previous line is a break or return and is indented 1 tab more...
3032 }
3033 }
3035 # check indentation of a line with a break;
3036 # if the previous line is a goto or return and is indented the same # of tabs
3042 }
3043 }
3045 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3048 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3049 }
3051 # check for RCS/CVS revision markers
3055 }
3057 # Blackfin: don't use __builtin_bfin_[cs]sync
3062 }
3067 }
3069 # check for old HOTPLUG __dev<foo> section markings
3073 }
3075 # Check for potential 'bare' types
3078 #print "LINE<$line>\n";
3086 #print "linenr<$linenr> <$stat>\n";
3087 # If this statement has no statement boundaries within
3088 # it there is no point in retrying a statement scan
3089 # until we hit end of it.
3092 #print "skip<$line_nr_next>\n";
3094 }
3096 # Find the real next line.
3102 }
3107 # Ignore goto labels.
3110 # Ignore functions being called
3115 # declarations always start with types
3116 } 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) {
3121 # definitions in global scope can only start with types
3124 }
3126 # any (foo ... *) is a pointer cast, and foo is a type
3129 }
3131 # Check for any sort of function declaration.
3132 # int foo(something bar, other baz);
3133 # void (*store_gdt)(x86_descr_ptr *);
3134 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3142 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3145 }
3146 }
3147 }
3149 }
3151 #
3152 # Checks which may be anchored in the context.
3153 #
3155 # Check for switch () and associated case and default
3156 # statements should be at the same indent.
3170 }
3171 }
3175 }
3176 }
3178 # if/while/etc brace do not go on next line, unless defining a do while loop,
3179 # or if that brace on the next line is for something else
3180 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3188 }
3199 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3202 }
3204 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3205 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3211 }
3215 {
3221 }
3222 }
3223 }
3225 # Check relative indent for conditionals and blocks.
3226 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3234 # remove inline comments
3238 # Find out how long the conditional actually is.
3242 # Make sure we remove the line prefixes as we have
3243 # none on the first line, and are going to readd them
3244 # where necessary.
3248 }
3250 # We want to check the first line inside the block
3251 # starting at the end of the conditional, so remove:
3252 # 1) any blank line termination
3253 # 2) any opening brace { on end of the line
3254 # 3) any do (...) {
3261 }
3265 }
3267 # Also ignore a loop construct at the end of a
3268 # preprocessor statement.
3272 }
3279 # If we see an #else/#elif then the code
3280 # is not linear.
3283 }
3285 # Ignore:
3286 # 1) blank lines, they should be at 0,
3287 # 2) preprocessor lines, and
3288 # 3) labels.
3296 }
3297 }
3298 }
3303 # Check if either of these lines are modified, else
3304 # this is not this patch's fault.
3308 }
3311 }
3313 #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";
3320 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3321 }
3322 }
3324 # Track the 'values' across context and added lines.
3334 }
3337 #ignore lines not being added
3340 # check for declarations of signed or unsigned without int
3352 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3360 }
3361 }
3362 }
3364 # TEST: allow direct testing of the type matcher.
3372 }
3374 }
3375 # TEST: allow direct testing of the attribute matcher.
3383 }
3385 }
3387 # check for initialisation to aggregates open brace on the next line
3401 }
3402 }
3404 #
3405 # Checks which are anchored on the added line.
3406 #
3408 # check for malformed paths in #include statements (uses RAW line)
3414 }
3418 }
3419 }
3421 # no C99 // comments
3430 }
3431 }
3432 }
3433 # Remove C99 comments.
3437 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3438 # the whole statement.
3439 #print "APW <$lines[$realline_next - 1]>\n";
3445 # Handle definitions which produce identifiers with
3446 # a prefix:
3447 # XXX(foo);
3448 # EXPORT_SYMBOL(something_foo);
3452 #print "FOO C name<$name>\n";
3463 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3467 }
3468 }
3473 #print "FOO B <$lines[$linenr - 1]>\n";
3475 }
3480 }
3482 # check for global initialisers.
3488 }
3489 }
3490 # check for static initialisers.
3497 }
3498 }
3500 # check for misordered declarations of char/short/int/long with signed/unsigned
3504 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3505 }
3507 # check for static const char * arrays.
3512 }
3514 # check for static char foo[] = "bar" declarations.
3519 }
3521 # check for const <foo> const where <foo> is not a pointer or array type
3530 }
3531 }
3533 # check for non-global char *foo[] = {"bar", ...} declarations.
3538 }
3540 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3543 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3549 }
3550 }
3551 }
3553 # check for function declarations without arguments like "int foo()"
3559 }
3560 }
3562 # check for uses of DEFINE_PCI_DEVICE_TABLE
3567 $fixed[$fixlinenr] =~ s/\b(?:static\s+|)DEFINE_PCI_DEVICE_TABLE\s*\(\s*(\w+)\s*\)\s*=\s*/static const struct pci_device_id $1\[\] = /;
3568 }
3569 }
3571 # check for new typedefs, only function parameters and sparse annotations
3572 # make sense.
3580 }
3582 # * goes on variable not on type
3583 # (char*[ const])
3585 #print "AA<$1>\n";
3588 # Should start with a space.
3590 # Should not end with a space.
3592 # '*'s should not have spaces between.
3594 }
3596 ## print "1: from<$from> to<$to> ident<$ident>\n";
3606 }
3607 }
3608 }
3610 #print "BB<$1>\n";
3613 # Should start with a space.
3615 # Should not end with a space.
3617 # '*'s should not have spaces between.
3619 }
3620 # Modifiers should have spaces.
3623 ## print "2: from<$from> to<$to> ident<$ident>\n";
3634 }
3635 }
3636 }
3638 # avoid BUG() or BUG_ON()
3643 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3644 }
3646 # avoid LINUX_VERSION_CODE
3649 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3650 }
3652 # check for uses of printk_ratelimit
3656 }
3658 # printk should use KERN_* levels. Note that follow on printk's on the
3659 # same line do not need a level, so we use the current block context
3660 # to try and find and validate the current printk. In summary the current
3661 # printk includes all preceding printk's which have no newline on the end.
3662 # we assume the first bad printk is the one to report.
3666 #print "CHECK<$lines[$ln - 1]\n";
3667 # we have a preceding printk if it ends
3668 # with "\n" ignore it, else it is to blame
3672 }
3674 }
3675 }
3679 }
3680 }
3689 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3690 }
3698 }
3699 }
3708 }
3710 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3711 # number of false positives, but assembly files are not checked, so at
3712 # least the arch entry code will not trigger this warning.
3716 }
3718 # function brace can't be on same line, except for #defines of do while,
3719 # or if closed on same line
3734 }
3735 }
3736 }
3738 # open braces for enum, union and struct go on the same line.
3752 }
3753 }
3754 }
3756 # missing space after union, struct or enum definition
3763 }
3764 }
3766 # Function pointer declarations
3767 # check spacing between type, funcptr, and args
3768 # canonical declaration is "type (*funcptr)(args...)"
3777 # the $Declare variable will capture all spaces after the type
3778 # so check it for a missing trailing missing space but pointer return types
3779 # don't need a space so don't warn for those.
3784 }
3789 }
3791 # unnecessary space "type (*funcptr)(args...)"
3792 # This test is not currently implemented because these declarations are
3793 # equivalent to
3794 # int foo(int bar, ...)
3795 # and this is form shouldn't/doesn't generate a checkpatch warning.
3796 #
3797 # elsif ($declare =~ /\s{2,}$/) {
3798 # WARN("SPACING",
3799 # "Multiple spaces after return type\n" . $herecurr);
3800 # }
3802 # unnecessary space "type ( *funcptr)(args...)"
3807 }
3809 # unnecessary space "type (* funcptr)(args...)"
3814 }
3816 # unnecessary space "type (*funcptr )(args...)"
3821 }
3823 # unnecessary space "type (*funcptr) (args...)"
3828 }
3832 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3833 }
3834 }
3836 # check for spacing round square brackets; allowed:
3837 # 1. with a type on the left -- int [] a;
3838 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3839 # 3. inside a curly brace -- = { [0...10] = 5 }
3850 }
3851 }
3852 }
3854 # check for spaces between functions and their parentheses.
3860 # Ignore those directives where spaces _are_ permitted.
3866 {
3867 # cpp #define statements have non-optional spaces, ie
3868 # if there is a space between the name and the open
3869 # parenthesis it is simply not a parameter group.
3872 # cpp #elif statement condition may start with a (
3875 # If this whole things ends with a type its most
3876 # likely a typedef for a function.
3885 }
3886 }
3887 }
3889 # Check operator spacing.
3895 <<=|>>=|<=|>=|==|!=|
3897 =>|->|<<|>>|<|>|=|!|~|
3903 ## print("element count: <" . $#elements . ">\n");
3904 ## foreach my $el (@elements) {
3905 ## print("el: <$el>\n");
3906 ## }
3914 }
3925 ## print("n: <$n> good: <$good>\n");
3929 # Pick up the preceding and succeeding characters.
3934 }
3957 }
3966 # Pull out the value of this operator.
3969 # Get the full operator variant.
3972 # Ignore operators passed as parameters.
3976 # # Ignore comments
3977 # } elsif ($op =~ /^$;+$/) {
3979 # ; should have either the end of line or a space or \ after it
3987 }
3988 }
3990 # // is a comment
3993 # : when part of a bitfield
3995 # skip the bitfield test for now
3997 # No spaces for:
3998 # ->
4006 }
4008 }
4009 }
4011 # , must not have a space before and must have a space on the right.
4020 }
4021 }
4028 }
4029 }
4035 }
4038 }
4039 }
4041 # '*' as part of a type definition -- reported already.
4043 #warn "'*' is part of type\n";
4045 # unary operators should have a space before and
4046 # none after. May be left adjacent to another
4047 # unary operator, or a cast
4057 }
4058 }
4059 }
4061 # A unary '*' may be const
4069 }
4071 }
4072 }
4074 # unary ++ and unary -- are allowed no space on one side.
4081 }
4082 }
4089 }
4090 }
4097 }
4099 }
4100 }
4102 # << and >> may either have or not have spaces both sides
4108 {
4116 }
4122 }
4123 }
4130 }
4132 }
4133 }
4135 # A colon needs no spaces before when it is
4136 # terminating a case value or a label.
4143 }
4144 }
4146 # All the others need spaces both sides.
4150 # Ignore email addresses <foo@bar>
4155 {
4157 }
4159 # for asm volatile statements
4160 # ignore a colon with another
4161 # colon immediately before or after
4165 }
4167 # messages are ERROR, but ?: are CHK
4177 }
4179 }
4180 }
4181 }
4184 ## print("n: <$n> GOOD: <$good>\n");
4187 }
4191 }
4195 }
4198 }
4200 # check for whitespace before a non-naked semicolon
4207 }
4208 }
4210 # check for multiple assignments
4214 }
4216 ## # check for multiple declarations, allowing for a function declaration
4217 ## # continuation.
4218 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4219 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4220 ##
4221 ## # Remove any bracketed sections to ensure we do not
4222 ## # falsly report the parameters of functions.
4223 ## my $ln = $line;
4224 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4225 ## }
4226 ## if ($ln =~ /,/) {
4227 ## WARN("MULTIPLE_DECLARATION",
4228 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4229 ## }
4230 ## }
4232 #need space before brace following if, while, etc
4239 }
4240 }
4242 ## # check for blank lines before declarations
4243 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4244 ## $prevrawline =~ /^.\s*$/) {
4245 ## WARN("SPACING",
4246 ## "No blank lines before declarations\n" . $hereprev);
4247 ## }
4248 ##
4250 # closing brace should have a space following it when it has anything
4251 # on the line
4258 }
4259 }
4261 # check spacing on square brackets
4268 }
4269 }
4276 }
4277 }
4279 # check spacing on parentheses
4287 }
4288 }
4297 }
4298 }
4300 # check unnecessary parentheses around addressof/dereference single $Lvals
4301 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4309 }
4310 }
4312 # check for unnecessary parentheses around function pointer uses
4313 # ie: (foo->bar)(); should be foo->bar();
4314 # but not "if (foo->bar) (" to avoid some false positives
4323 }
4324 }
4326 #goto labels aren't indented, allow a single space however
4334 }
4335 }
4337 # return is not a function
4347 }
4351 }
4352 }
4354 # unnecessary return in a void function
4355 # at end-of-function, with the previous line a single leading tab, then return;
4356 # and the line before that not a goto label target like "out:"
4364 }
4366 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4372 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4377 }
4378 }
4380 # comparisons with a constant or upper case identifier on the left
4381 # avoid cases like "foo + BAR < baz"
4382 # only fix matches surrounded by parentheses to avoid incorrect
4383 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4404 }
4406 }
4407 }
4409 # Return of what appears to be an errno should normally be negative
4415 }
4416 }
4418 # Need a space before open parenthesis after if, while etc
4425 }
4426 }
4428 # Check for illegal assignment in if conditional -- and check for trailing
4429 # statements after the conditional.
4437 ##print "stat<$stat> stat_next<$stat_next>\n";
4440 # If the statement carries leading newlines,
4441 # then count those as offsets.
4449 }
4450 }
4459 }
4461 # Find out what is on the end of the line after the
4462 # conditional.
4468 {
4469 # Find out how long the conditional actually is.
4478 }
4482 }
4483 }
4485 # Check for bitwise tests written as boolean
4491 |
4496 {
4499 }
4501 # if and else should not have general statements after it
4508 }
4509 }
4510 # if should not continue a brace
4515 }
4516 # case and default should not have general statements after them
4522 {
4525 }
4527 # Check for }<nl>else {, these must be at the same
4528 # indent level to be relevant to each other.
4540 }
4544 }
4545 }
4551 # Find out what is on the end of the line after the
4552 # conditional.
4568 }
4569 }
4570 }
4572 #Specific variable tests
4576 #gcc binary extension
4584 }
4585 }
4587 #CamelCase
4590 #Ignore Page<foo> variants
4592 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4594 #Ignore some three character SI units explicitly, like MiB and KHz
4600 seed_camelcase_includes();
4604 }
4605 }
4610 }
4611 }
4612 }
4613 }
4615 #no spaces allowed after \ in define
4621 }
4622 }
4624 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4625 # itself <asm/foo.h> (uses RAW line)
4632 {
4641 }
4642 }
4643 }
4644 }
4646 # multi-statement macros should be enclosed in a do while loop, grab the
4647 # first statement and ensure its the whole macro if its not enclosed
4648 # in a known good container
4660 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4661 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4672 # Flatten any parentheses and braces
4676 {
4677 }
4679 # Flatten any obvious string concatentation.
4682 {
4683 }
4685 # Make asm volatile uses seem like a generic function
4690 module_param_named|
4691 MODULE_PARM_DESC|
4692 DECLARE_PER_CPU|
4693 DEFINE_PER_CPU|
4694 __typeof__\(|
4695 union|
4696 struct|
4701 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4705 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4710 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4716 {
4723 }
4731 }
4732 }
4734 # check for macros with flow control, but without ## concatenation
4735 # ## concatenation is commonly a macro that defines a function so ignore those
4742 }
4745 }
4747 # check for line continuations outside of #defines, preprocessor #, and asm
4756 }
4757 }
4759 # do {} while (0) macro tests:
4760 # single-statement macros do not need to be enclosed in do while (0) loop,
4761 # macro should not end with a semicolon
4776 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4786 }
4792 }
4796 }
4804 }
4808 }
4809 }
4811 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4812 # all assignments may have only one of the following with an assignment:
4813 # .
4814 # ALIGN(...)
4815 # VMLINUX_SYMBOL(...)
4819 }
4821 # check for redundant bracing round if etc
4825 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4826 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4836 # If the condition carries leading newlines, then count those as offsets.
4841 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4843 # We have looked at and allowed this specific line.
4853 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
4855 #print "APW: ALLOWED: cond<$cond>\n";
4857 }
4859 #print "APW: ALLOWED: block<$block>\n";
4861 }
4863 #print "APW: ALLOWED: lines block<$block>\n";
4865 }
4867 }
4872 }
4880 }
4881 }
4882 }
4883 }
4888 # Check the pre-context.
4890 #print "APW: ALLOWED: pre<$1>\n";
4892 }
4897 # Check the condition.
4899 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
4902 }
4904 #print "APW: ALLOWED: cond<$cond>\n";
4906 }
4908 #print "APW: ALLOWED: block<$block>\n";
4910 }
4912 #print "APW: ALLOWED: lines block<$block>\n";
4914 }
4915 # Check the post-context.
4920 }
4922 #print "APW: ALLOWED: chunk-1 block<$block>\n";
4924 }
4925 }
4932 }
4936 }
4937 }
4939 # check for unnecessary blank lines around braces
4945 }
4946 }
4952 }
4953 }
4955 # no volatiles please
4959 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
4960 }
4962 # Check for user-visible strings broken across lines, which breaks the ability
4963 # to grep for the string. Make exceptions when the previous string ends in a
4964 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
4965 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
4978 }
4990 }
4992 }
4993 }
4995 # check for missing a space in a string concatenation
4999 }
5001 # check for spaces before a quoted newline
5007 }
5009 }
5011 # concatenated string without spaces between elements
5015 }
5017 # uncoalesced string fragments
5021 }
5023 # check for %L{u,d,i} and 0x%[udi] in strings
5032 }
5036 }
5037 }
5039 # check for line continuations in quoted strings with odd counts of "
5043 }
5045 # warn about #if 0
5050 }
5052 # check for needless "if (<foo>) fn(<foo>)" uses
5056 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5068 }
5073 }
5076 }
5080 }
5081 }
5082 }
5083 }
5085 # check for unnecessary "Out of Memory" messages
5094 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5096 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5099 }
5100 }
5102 # check for logging functions with KERN_<LEVEL>
5110 }
5111 }
5113 # check for mask then right shift without a parentheses
5119 }
5121 # check for pointer comparisons to NULL
5131 }
5132 }
5133 }
5135 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5138 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5148 $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;
5149 }
5150 }
5151 }
5153 # check for $InitAttributeData (ie: __initdata) with const
5164 }
5165 }
5167 # check for $InitAttributeConst (ie: __initconst) without const
5179 }
5180 }
5182 # check for __read_mostly with const non-pointer (should just be const)
5189 }
5190 }
5192 # don't use __constant_<foo> functions outside of include/uapi/
5194 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5202 }
5203 }
5205 # prefer usleep_range over udelay
5208 # ignore udelay's < 10, however
5211 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5212 }
5216 }
5217 }
5219 # warn about unexpectedly long msleep's
5223 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5224 }
5225 }
5227 # check for comparisons of jiffies
5230 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5231 }
5233 # check for comparisons of get_jiffies_64()
5236 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5237 }
5239 # warn about #ifdefs in C files
5240 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5241 # print "#ifdef in C files should be avoided\n";
5242 # print "$herecurr";
5243 # $clean = 0;
5244 # }
5246 # warn about spacing in #ifdefs
5253 }
5255 }
5257 # check for spinlock_t definitions without a comment.
5264 }
5265 }
5266 # check for memory barriers without a comment.
5269 mb|
5270 rmb|
5271 wmb|
5272 read_barrier_depends
5275 mb__before_atomic|
5276 mb__after_atomic|
5277 store_release|
5278 load_acquire|
5279 store_mb|
5292 }
5293 }
5303 }
5305 # check for waitqueue_active without a comment.
5310 }
5311 }
5313 # Check for expedited grace periods that interrupt non-idle non-nohz
5314 # online CPUs. These expedited can therefore degrade real-time response
5315 # if used carelessly, and should be avoided where not absolutely
5316 # needed. It is always OK to use synchronize_rcu_expedited() and
5317 # synchronize_sched_expedited() at boot time (before real-time applications
5318 # start) and in error situations where real-time response is compromised in
5319 # any case. Note that synchronize_srcu_expedited() does -not- interrupt
5320 # other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5321 # Of course, nothing comes for free, and srcu_read_lock() and
5322 # srcu_read_unlock() do contain full memory barriers in payment for
5323 # synchronize_srcu_expedited() non-interruption properties.
5326 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5328 }
5330 # check of hardware specific defines
5331 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5334 }
5336 # Check that the storage class is at the beginning of a declaration
5340 }
5342 # check the location of the inline attribute, that it is between
5343 # storage class and type.
5348 }
5350 # Check for __inline__ and __inline, prefer inline
5358 }
5359 }
5361 # Check for __attribute__ packed, prefer __packed
5366 }
5368 # Check for __attribute__ aligned, prefer __aligned
5373 }
5375 # Check for __attribute__ format(printf, prefer __printf
5379 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5381 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5383 }
5384 }
5386 # Check for __attribute__ format(scanf, prefer __scanf
5390 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5392 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5393 }
5394 }
5396 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5398 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5403 }
5405 # check for c99 types like uint8_t used outside of uapi/
5419 }
5420 }
5421 }
5423 # check for cast of C90 native int or longer types constants
5438 }
5440 }
5441 }
5443 # check for sizeof(&)
5447 }
5449 # check for sizeof without parenthesis
5454 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5455 }
5456 }
5458 # check for struct spinlock declarations
5462 }
5464 # check for seq_printf uses that could be seq_puts
5473 }
5474 }
5475 }
5477 # Check for misused memsets
5492 }
5493 }
5495 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5500 "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5502 $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5503 }
5504 }
5506 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5511 "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5512 }
5514 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5515 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5526 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5527 }
5532 $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5533 }
5534 }
5535 }
5537 # typecasts on min/max could be min_t/max_t
5555 }
5558 }
5559 }
5561 # check usleep_range arguments
5569 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5573 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5574 }
5575 }
5577 # check for naked sscanf
5589 }
5592 }
5594 # check for simple sscanf that should be kstrto<foo>
5603 }
5611 }
5612 }
5613 }
5615 # check for new externs in .h files.
5622 }
5623 }
5625 # check for new externs in .c files.
5628 {
5635 }
5638 {
5641 }
5646 }
5650 {
5653 }
5655 # checks for new __setup's
5662 }
5663 }
5665 # check for pointless casting of kmalloc return
5668 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5669 }
5671 # alloc style
5672 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5674 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5677 }
5679 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5681 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5692 }
5698 $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;
5700 }
5701 }
5702 }
5704 # check for krealloc arg reuse
5709 }
5711 # check for alloc argument mismatch
5715 }
5717 # check for multiple semicolons
5723 }
5724 }
5726 # check for #defines like: 1 << <digit> that could be BIT(digit)
5734 }
5735 }
5737 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5738 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5744 }
5745 }
5747 # check for case / default statements not preceded by break/fallthrough/switch
5765 }
5769 }
5770 }
5772 # check for switch/default statements without a break;
5781 }
5784 }
5786 # check for gcc specific __FUNCTION__
5792 }
5793 }
5795 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5799 }
5801 # check for use of yield()
5805 }
5807 # check for comparisons against true and false
5823 }
5828 ## maybe suggesting a correct construct would better
5829 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5831 }
5832 }
5834 # check for semaphores initialized locked
5838 }
5840 # recommend kstrto* over simple_strto* and strict_strto*
5844 }
5846 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
5849 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
5850 }
5852 # check for various structs that are normally const (ops, kgdb, device_tree)
5854 acpi_dock_ops|
5855 address_space_operations|
5856 backlight_ops|
5857 block_device_operations|
5858 dentry_operations|
5859 dev_pm_ops|
5860 dma_map_ops|
5861 extent_io_ops|
5862 file_lock_operations|
5863 file_operations|
5864 hv_ops|
5865 ide_dma_ops|
5866 intel_dvo_dev_ops|
5867 item_operations|
5868 iwl_ops|
5869 kgdb_arch|
5870 kgdb_io|
5871 kset_uevent_ops|
5872 lock_manager_operations|
5873 microcode_ops|
5874 mtrr_ops|
5875 neigh_ops|
5876 nlmsvc_binding|
5877 of_device_id|
5878 pci_raw_ops|
5879 pipe_buf_operations|
5880 platform_hibernation_ops|
5881 platform_suspend_ops|
5882 proto_ops|
5883 rpc_pipe_ops|
5884 seq_operations|
5885 snd_ac97_build_ops|
5886 soc_pcmcia_socket_ops|
5887 stacktrace_ops|
5888 sysfs_ops|
5889 tty_operations|
5890 uart_ops|
5891 usb_mon_operations|
5898 }
5900 # use of NR_CPUS is usually wrong
5901 # ignore definitions of NR_CPUS and usage to define arrays as likely right
5908 {
5910 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
5911 }
5913 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
5917 }
5919 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
5924 }
5926 # whine mightly about in_atomic
5934 }
5935 }
5937 # whine about ACCESS_ONCE
5948 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
5949 }
5955 }
5956 }
5957 }
5959 # check for lockdep_set_novalidate_class
5967 }
5968 }
5973 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
5974 }
5976 # Mode permission misuses where it seems decimal should be octal
5977 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
5988 }
6001 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6002 }
6003 }
6004 }
6005 }
6007 # validate content of MODULE_LICENSE against list from include/linux/module.h
6011 GPL|
6012 GPL\ v2|
6017 Proprietary
6022 }
6023 }
6024 }
6026 # If we have no input at all, then there is nothing to report on
6027 # so just keep quiet.
6030 }
6032 # In mailback mode only produce a report in the negative, for
6033 # things that appear to be patches.
6036 }
6038 # This is not a patch, and we are are in 'no-patch' mode so
6039 # just keep quiet.
6042 }
6047 }
6051 }
6059 }
6062 # If there were any defects found and not already fixing them
6068 EOM
6069 }
6070 # If there were whitespace errors which cleanpatch can fix
6071 # then suggest that.
6078 EOM
6079 }
6080 }
6100 }
6103 }
6104 }
6112 Do _NOT_ trust the results written to this file.
6115 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6117 EOM
6118 }
6119 }
6127 }
6128 }
6130 }