| blob | 95cda3ecc66b859ec1c86762810bfbd200687ef0 |
1 #!/usr/bin/env perl
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
70 Options:
75 --emacs emacs compile window format
76 --terse one line per report
79 single git commit with:
83 multiple git commits with:
87 git merges are ignored
102 is all off)
104 literally
107 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
108 with potential errors corrected to the preferred
109 checkpatch style
114 runtime errors.
117 --codespellfile Use this codespell dictionary
118 --typedefsfile Read additional types from this file
124 EOM
127 }
132 }
148 # Also catch when type or level is passed through a variable
149 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
151 }
156 }
159 }
181 }
182 }
185 }
187 # Perl's Getopt::Long allows options to take optional arguments after a space.
188 # Prevent --color by itself from consuming other arguments
192 }
193 }
195 GetOptions(
245 }
246 }
248 #if no filenames are given, push '-' to read patch from stdin
251 }
263 }
279 }
280 }
289 }
291 }
292 }
302 ## no critic
305 }
312 }
318 }
325 }
326 }
331 }
332 }
342 __user|
343 __kernel|
344 __force|
345 __iomem|
346 __must_check|
347 __init_refok|
348 __kprobes|
349 __ref|
350 __rcu|
351 __private
359 # Notes to $Attribute:
360 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
362 const|
363 __percpu|
364 __nocast|
365 __safe|
366 __bitwise|
367 __packed__|
368 __packed2__|
369 __naked|
370 __maybe_unused|
371 __always_unused|
372 __noreturn|
373 __used|
374 __cold|
375 __pure|
376 __noclone|
377 __deprecated|
378 __read_mostly|
379 __kprobes|
381 ____cacheline_aligned|
382 ____cacheline_aligned_in_smp|
383 ____cacheline_internodealigned_in_smp|
384 __weak
406 <=|>=|==|!=|
407 =>|->|<<|>>|<|>|!|~|
441 )};
444 atomic_t
445 )};
450 )};
456 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
457 TP_printk|
459 panic|
462 )};
471 To:|
472 Cc:
473 )};
492 );
515 );
536 )};
543 );
547 );
554 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
561 );
563 #Create a search pattern for all these functions to speed up a loop below
568 }
571 S_IWUGO |
572 S_IWOTH |
573 S_IRWXUGO |
574 S_IALLUGO |
595 );
597 #Create a search pattern for all these strings to speed up a loop below
602 }
605 irq|
606 memory|
608 reboot
609 )};
610 # memory.h: ARM has a custom one
612 # Load common spelling mistakes and build regular expression list.
629 }
633 }
652 }
656 }
657 }
676 }
680 }
683 }
686 }
696 }
715 )
722 )
731 )
735 $NonptrType
740 $NonptrTypeMisordered
746 }
747 build_types();
751 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
752 # requires at least perl version v5.10.0
753 # Any use must be runtime checked with $^V
763 )};
772 }
777 }
801 }
802 }
803 }
810 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
813 }
837 }
839 }
847 }
851 }
856 }
860 }
868 }
870 }
871 }
885 # Maybe one day convert this block of bash into something that returns
886 # all matching commit ids, but it's very slow...
887 #
888 # echo "checking commits $1..."
889 # git rev-list --remotes | grep -i "^$1" |
890 # while read line ; do
891 # git log --format='%H %s' -1 $line |
892 # echo "commit $(cut -c 1-12,41-)"
893 # done
894 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
899 }
902 }
913 # If input is git commits, extract all commits from the commit expressions.
914 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
927 }
936 }
937 }
940 }
956 }
963 }
967 }
974 }
978 }
987 build_types();
988 }
999 EOM
1000 }
1006 EOM
1007 }
1008 }
1019 );
1024 }
1025 }
1027 }
1050 # If there's a name left after stripping spaces and
1051 # leading quotes, and the address doesn't have both
1052 # leading and trailing angle brackets, the address
1053 # is invalid. ie:
1054 # "joe smith joe@smith.com" bad
1055 # "joe smith <joe@smith.com" bad
1060 }
1061 }
1071 }
1074 }
1088 }
1094 }
1097 }
1105 }
1106 }
1109 }
1117 }
1118 }
1121 }
1134 }
1136 }
1139 }
1142 }
1146 }
1151 # Drop the diff line leader and expand tabs
1155 # Pick the indent from the front of the line.
1159 }
1170 }
1171 }
1182 # Always copy over the diff marker.
1188 # Comments we are wacking completly including the begin
1189 # and end, all to $;.
1196 }
1202 }
1209 }
1211 # A \ in a string means ignore the next character.
1217 }
1218 # Regular quotes.
1227 }
1228 }
1230 #print "c<$c> SQ<$sanitise_quote>\n";
1239 }
1240 }
1244 }
1246 # The pathname on a #include may be surrounded by '<' and '>'.
1251 # The whole of a #error is a string.
1255 }
1260 }
1263 }
1270 }
1293 #warn "CSB: blk<$blk> remain<$remain>\n";
1294 # If we are about to drop off the end, pull in more
1295 # context.
1306 }
1307 # Bail if there is no further context.
1308 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1311 }
1315 }
1316 }
1321 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1323 # Handle nested #if/#else.
1330 }
1332 # Statement ends at the ';' or a close '}' at the
1333 # outermost level.
1336 }
1338 # An else is really a conditional as long as its not else if
1345 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1346 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1347 }
1352 }
1360 #warn "CSB: mark coff<$coff>\n";
1361 }
1362 }
1366 }
1374 }
1376 }
1377 }
1378 # Preprocessor commands end at the newline unless escaped.
1384 }
1386 }
1387 # We are truly at the end, so shuffle to the next line.
1392 }
1397 #warn "STATEMENT<$statement>\n";
1398 #warn "CONDITION<$condition>\n";
1400 #print "coff<$coff> soff<$off> loff<$loff>\n";
1404 }
1409 # Strip the diff line prefixes and rip blank lines at start and end.
1417 }
1425 }
1446 }
1447 }
1455 # Grab the first conditional/block pair.
1458 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1462 }
1464 # Pull in the following conditional/block pairs and see if they
1465 # could continue the statement.
1469 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1471 #print "C: push\n";
1473 }
1476 }
1495 # Handle nested #if/#else.
1502 }
1505 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1509 }
1516 }
1517 }
1521 }
1524 }
1527 }
1533 }
1539 }
1545 }
1550 }
1555 }
1560 # Catch a comment on the end of the line itself.
1564 # Look through the context and try and figure out if there is a
1565 # comment.
1570 #warn " $line\n";
1573 }
1576 }
1579 }
1583 }
1584 }
1588 }
1593 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1594 ##print "CMMT: $cmt\n";
1597 }
1610 }
1613 }
1625 }
1626 }
1630 }
1642 }
1662 }
1683 }
1712 # Assume all arms of the conditional end as this
1713 # one does, and continue as if the #endif was not here.
1730 }
1761 }
1773 }
1806 }
1821 }
1830 }
1834 }
1838 }
1839 }
1842 }
1851 DEFINE_\S+
1852 )$|
1856 case|
1860 \#|
1861 \#\#|
1867 # Check for modifiers.
1878 }
1879 }
1884 }
1885 build_types();
1888 }
1889 }
1901 }
1909 }
1918 }
1919 }
1924 }
1932 }
1938 }
1942 }
1953 }
1954 }
1981 }
1987 }
1994 }
1999 }
2002 }
2005 }
2013 };
2015 }
2023 };
2026 }
2035 }
2037 }
2045 }
2047 }
2055 }
2057 }
2063 ##print "absolute<$absolute>\n";
2065 # See if any suffix of this path is a path within the tree.
2068 ##print "file<$file>\n";
2070 }
2071 }
2074 }
2076 # It is, so see if the prefix is acceptable.
2080 ##print "prefix<$prefix>\n";
2084 }
2085 }
2093 }
2101 }
2109 }
2117 }
2126 #convert leading spaces to tabs
2128 #Remove spaces before a tab
2132 }
2146 }
2158 }
2159 }
2162 }
2199 # Trace the real file/line as we go.
2212 # suppression flags
2220 # Pre-scan the patch sanitizing the lines.
2221 # Pre-scan the patch looking for any __setup documentation.
2222 #
2228 sanitise_line_reset();
2240 }
2241 #next;
2242 }
2249 }
2252 # Guestimate if this is a continuing comment. Run
2253 # the context looking for a comment "edge". If this
2254 # edge is a close comment then we must be in a comment
2255 # at context start.
2262 #print "RAW<$rawlines[$ln - 1]>\n";
2268 }
2269 }
2272 }
2274 # Guestimate if this is a continuing comment. If this
2275 # is the start of a diff block and this line starts
2276 # ' *' then it is very likely a comment.
2279 {
2281 }
2283 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2287 # Standardise the strings and chars within the input to
2288 # simplify matching -- only bother with positive lines.
2290 }
2297 }
2299 #print "==>$rawline\n";
2300 #print "-->$line\n";
2304 }
2305 }
2320 #extract the line range in the file after the patch is applied
2331 }
2332 annotate_reset();
2343 }
2346 # track the line number as we move through the hunk, note that
2347 # new versions of GNU diff omit the leading space on completely
2348 # blank context lines so we need to count that too.
2353 # Measure the line length and indent.
2356 # Track the previous line.
2361 #warn "line<$line>\n";
2365 }
2373 # extract the filename as it passes
2389 }
2393 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2394 }
2396 }
2398 #make up the handle for any error we report on this line
2406 }
2407 }
2412 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2413 }
2418 }
2420 }
2430 # Check if the commit log has what seems like a diff which can confuse patch
2439 }
2441 # Check for incorrect file permissions
2448 }
2449 }
2451 # Check the patch for a signoff:
2455 }
2457 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2458 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2461 }
2463 # Check signature styles
2475 }
2482 }
2483 }
2490 }
2492 }
2499 }
2500 }
2511 # Don't force email to have quotes
2512 # Allow just an angle bracketed address
2518 }
2519 }
2521 # Check for duplicate signatures
2530 }
2531 }
2533 # Check email subject for common tools that don't need to be mentioned
2538 }
2540 # Check for old stable address
2544 }
2546 # Check for unwanted Gerrit info
2550 }
2552 # Check if the commit log is in a possible stack dump
2556 # timestamp
2558 # stack dump address
2560 }
2562 # Check for line lengths > 75 in commit log, warn once
2566 # file delta changes
2568 # filename then :
2570 # A Fixes: or Link: line
2575 }
2577 # Reset possible stack dump if a blank line is found
2581 }
2583 # Check for git id commit length and improperly formed commit descriptions
2608 }
2630 }
2638 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2639 }
2640 }
2642 # Check for added, moved or deleted files
2652 }
2654 # Check for wrappage within a valid hunk of the file
2659 }
2661 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2672 }
2674 # Check if it's the start of a commit log
2675 # (not a header line and we haven't seen the patch filename)
2682 }
2684 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2685 # declined it, i.e defined some charset where it is missing.
2690 }
2696 }
2698 # Check for absolute kernel paths in commit message
2705 #
2708 }
2709 }
2710 }
2712 # Check for various typo / spelling mistakes
2726 }
2727 }
2728 }
2730 # ignore non-hunk lines and lines being removed
2733 #trailing whitespace
2740 }
2747 }
2750 }
2752 # Check for FSF mailing addresses.
2761 "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)
2762 }
2764 # check for Kconfig help text having a real description
2765 # Only applies when adding the entry originally, after that we do not have
2766 # sufficient context to determine whether it is indeed long enough.
2787 }
2796 }
2798 }
2802 }
2803 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2804 }
2806 # check for MAINTAINERS entries that don't have the right form
2814 }
2815 }
2817 # discourage the use of boolean for type definition attributes of Kconfig options
2822 }
2832 };
2835 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2836 }
2838 # check for DT compatible documentation
2857 }
2864 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2865 }
2866 }
2867 }
2869 # check we are in a valid source file if not then ignore this hunk
2872 # line length limit (with some exclusions)
2873 #
2874 # There are a few types of lines that may extend beyond $max_line_length:
2875 # logging functions like pr_info that end in a string
2876 # lines with a single string
2877 # #defines that are a single string
2878 #
2879 # There are 3 different line length message types:
2880 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
2881 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2882 # LONG_LINE all other lines longer than $max_line_length
2883 #
2884 # if LONG_LINE is ignored, the other 2 types are also ignored
2885 #
2890 # Check the allowed long line types first
2892 # logging functions that end in a string that starts
2893 # before $max_line_length
2894 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2898 # lines with only strings (w/ possible termination)
2899 # #defines with only strings
2904 # More special cases
2909 # Otherwise set the alternate message types
2911 # a comment starts before $max_line_length
2916 # a quoted string starts before $max_line_length
2920 }
2926 }
2927 }
2929 # check for adding lines without a newline.
2930 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2933 }
2935 # Blackfin: use hi/lo macros
2941 }
2946 }
2947 }
2949 # check we are in a valid source file C or perl if not then ignore this hunk
2952 # at the beginning of a line any tabs must come first and anything
2953 # more than 8 must use tabs.
2962 }
2963 }
2965 # check for space before tabs.
2975 }
2976 }
2978 # check for && or || at the start of a line
2982 }
2984 # check indentation starts on a tab stop
2993 }
2994 }
2995 }
2997 # check multi-line statement indentation matches previous line
2999 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3022 }
3023 }
3024 }
3025 }
3027 # check for space after cast like "(int) foo" or "(struct foo) bar"
3028 # avoid checking a few false positives:
3029 # "sizeof(<type>)" or "__alignof__(<type>)"
3030 # function pointer declarations like "(*foo)(int) = bar;"
3031 # structure definitions like "(struct foo) { 0 };"
3032 # multiline macros that define functions
3033 # known attributes or the __attribute__ keyword
3041 }
3042 }
3044 # Block comment styles
3045 # Networking with an initial /*
3052 }
3054 # Block comments use * on subsequent lines
3062 }
3064 # Block comments use */ on trailing lines
3071 }
3073 # Block comment * alignment
3087 }
3094 }
3095 }
3097 # check for missing blank lines after struct/union declarations
3098 # with exceptions for various attributes and macros
3114 }
3115 }
3117 # check for multiple consecutive blank lines
3125 }
3128 }
3130 # check for missing blank lines after declarations
3132 # actual declarations
3134 # function pointer declarations
3136 # foo bar; where foo is some local typedef or #define
3138 # known declaration macros
3140 # for "else if" which can look like "$Ident $Ident"
3142 # other possible extensions of declaration lines
3144 # not starting a section or a macro "\" extended line
3146 # looks like a declaration
3148 # function pointer declarations
3150 # foo bar; where foo is some local typedef or #define
3152 # known declaration macros
3154 # start of struct or union or enum
3156 # start or end of block or continuation of declaration
3158 # bitfield continuation
3160 # other possible extensions of declaration lines
3162 # indentation of previous and current line are the same
3168 }
3169 }
3171 # check for spaces at the beginning of a line.
3172 # Exceptions:
3173 # 1) within comments
3174 # 2) indented preprocessor commands
3175 # 3) hanging labels
3182 }
3183 }
3185 # check we are in a valid C source file if not then ignore this hunk
3188 # check for unusual line ending [ or (
3192 }
3194 # check if this appears to be the start function declaration, save the name
3198 }
3200 # check if this appears to be the end of function declaration
3203 }
3205 # check indentation of any line with a bare else
3206 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3207 # if the previous line is a break or return and is indented 1 tab more...
3216 }
3217 }
3219 # check indentation of a line with a break;
3220 # if the previous line is a goto or return and is indented the same # of tabs
3226 }
3227 }
3229 # check for RCS/CVS revision markers
3233 }
3235 # Blackfin: don't use __builtin_bfin_[cs]sync
3240 }
3245 }
3247 # check for old HOTPLUG __dev<foo> section markings
3251 }
3253 # Check for potential 'bare' types
3256 #print "LINE<$line>\n";
3264 #print "linenr<$linenr> <$stat>\n";
3265 # If this statement has no statement boundaries within
3266 # it there is no point in retrying a statement scan
3267 # until we hit end of it.
3270 #print "skip<$line_nr_next>\n";
3272 }
3274 # Find the real next line.
3280 }
3285 # Ignore goto labels.
3288 # Ignore functions being called
3293 # declarations always start with types
3294 } 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) {
3299 # definitions in global scope can only start with types
3302 }
3304 # any (foo ... *) is a pointer cast, and foo is a type
3307 }
3309 # Check for any sort of function declaration.
3310 # int foo(something bar, other baz);
3311 # void (*store_gdt)(x86_descr_ptr *);
3312 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3320 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3323 }
3324 }
3325 }
3327 }
3329 #
3330 # Checks which may be anchored in the context.
3331 #
3333 # Check for switch () and associated case and default
3334 # statements should be at the same indent.
3348 }
3349 }
3353 }
3354 }
3356 # if/while/etc brace do not go on next line, unless defining a do while loop,
3357 # or if that brace on the next line is for something else
3358 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3366 }
3377 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3380 }
3382 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3383 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3389 }
3393 {
3399 }
3400 }
3401 }
3403 # Check relative indent for conditionals and blocks.
3404 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3412 # remove inline comments
3416 # Find out how long the conditional actually is.
3420 # Make sure we remove the line prefixes as we have
3421 # none on the first line, and are going to readd them
3422 # where necessary.
3426 }
3428 # We want to check the first line inside the block
3429 # starting at the end of the conditional, so remove:
3430 # 1) any blank line termination
3431 # 2) any opening brace { on end of the line
3432 # 3) any do (...) {
3439 }
3443 }
3445 # Also ignore a loop construct at the end of a
3446 # preprocessor statement.
3450 }
3457 # If we see an #else/#elif then the code
3458 # is not linear.
3461 }
3463 # Ignore:
3464 # 1) blank lines, they should be at 0,
3465 # 2) preprocessor lines, and
3466 # 3) labels.
3474 }
3475 }
3476 }
3481 # Check if either of these lines are modified, else
3482 # this is not this patch's fault.
3486 }
3489 }
3491 #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";
3500 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3501 }
3502 }
3504 # Track the 'values' across context and added lines.
3514 }
3517 #ignore lines not being added
3520 # check for dereferences that span multiple lines
3530 }
3532 # check for declarations of signed or unsigned without int
3533 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3544 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3552 }
3553 }
3554 }
3556 # TEST: allow direct testing of the type matcher.
3564 }
3566 }
3567 # TEST: allow direct testing of the attribute matcher.
3575 }
3577 }
3579 # check for initialisation to aggregates open brace on the next line
3593 }
3594 }
3596 #
3597 # Checks which are anchored on the added line.
3598 #
3600 # check for malformed paths in #include statements (uses RAW line)
3606 }
3610 }
3611 }
3613 # no C99 // comments
3622 }
3623 }
3624 }
3625 # Remove C99 comments.
3629 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3630 # the whole statement.
3631 #print "APW <$lines[$realline_next - 1]>\n";
3637 # Handle definitions which produce identifiers with
3638 # a prefix:
3639 # XXX(foo);
3640 # EXPORT_SYMBOL(something_foo);
3644 #print "FOO C name<$name>\n";
3655 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3659 }
3660 }
3665 #print "FOO B <$lines[$linenr - 1]>\n";
3667 }
3672 }
3674 # check for global initialisers.
3680 }
3681 }
3682 # check for static initialisers.
3689 }
3690 }
3692 # check for misordered declarations of char/short/int/long with signed/unsigned
3696 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3697 }
3699 # check for static const char * arrays.
3704 }
3706 # check for static char foo[] = "bar" declarations.
3711 }
3713 # check for const <foo> const where <foo> is not a pointer or array type
3722 }
3723 }
3725 # check for non-global char *foo[] = {"bar", ...} declarations.
3730 }
3732 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3735 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3741 }
3742 }
3743 }
3745 # check for function declarations without arguments like "int foo()"
3751 }
3752 }
3754 # check for new typedefs, only function parameters and sparse annotations
3755 # make sense.
3763 }
3765 # * goes on variable not on type
3766 # (char*[ const])
3768 #print "AA<$1>\n";
3771 # Should start with a space.
3773 # Should not end with a space.
3775 # '*'s should not have spaces between.
3777 }
3779 ## print "1: from<$from> to<$to> ident<$ident>\n";
3789 }
3790 }
3791 }
3793 #print "BB<$1>\n";
3796 # Should start with a space.
3798 # Should not end with a space.
3800 # '*'s should not have spaces between.
3802 }
3803 # Modifiers should have spaces.
3806 ## print "2: from<$from> to<$to> ident<$ident>\n";
3817 }
3818 }
3819 }
3821 # avoid BUG() or BUG_ON()
3826 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3827 }
3829 # avoid LINUX_VERSION_CODE
3832 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3833 }
3835 # check for uses of printk_ratelimit
3839 }
3841 # printk should use KERN_* levels
3845 }
3854 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3855 }
3863 }
3864 }
3873 }
3875 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3876 # number of false positives, but assembly files are not checked, so at
3877 # least the arch entry code will not trigger this warning.
3881 }
3883 # function brace can't be on same line, except for #defines of do while,
3884 # or if closed on same line
3899 }
3900 }
3901 }
3903 # open braces for enum, union and struct go on the same line.
3917 }
3918 }
3919 }
3921 # missing space after union, struct or enum definition
3928 }
3929 }
3931 # Function pointer declarations
3932 # check spacing between type, funcptr, and args
3933 # canonical declaration is "type (*funcptr)(args...)"
3942 # the $Declare variable will capture all spaces after the type
3943 # so check it for a missing trailing missing space but pointer return types
3944 # don't need a space so don't warn for those.
3949 }
3954 }
3956 # unnecessary space "type (*funcptr)(args...)"
3957 # This test is not currently implemented because these declarations are
3958 # equivalent to
3959 # int foo(int bar, ...)
3960 # and this is form shouldn't/doesn't generate a checkpatch warning.
3961 #
3962 # elsif ($declare =~ /\s{2,}$/) {
3963 # WARN("SPACING",
3964 # "Multiple spaces after return type\n" . $herecurr);
3965 # }
3967 # unnecessary space "type ( *funcptr)(args...)"
3972 }
3974 # unnecessary space "type (* funcptr)(args...)"
3979 }
3981 # unnecessary space "type (*funcptr )(args...)"
3986 }
3988 # unnecessary space "type (*funcptr) (args...)"
3993 }
3997 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3998 }
3999 }
4001 # check for spacing round square brackets; allowed:
4002 # 1. with a type on the left -- int [] a;
4003 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4004 # 3. inside a curly brace -- = { [0...10] = 5 }
4015 }
4016 }
4017 }
4019 # check for spaces between functions and their parentheses.
4025 # Ignore those directives where spaces _are_ permitted.
4031 {
4032 # cpp #define statements have non-optional spaces, ie
4033 # if there is a space between the name and the open
4034 # parenthesis it is simply not a parameter group.
4037 # cpp #elif statement condition may start with a (
4040 # If this whole things ends with a type its most
4041 # likely a typedef for a function.
4050 }
4051 }
4052 }
4054 # Check operator spacing.
4060 <<=|>>=|<=|>=|==|!=|
4062 =>|->|<<|>>|<|>|=|!|~|
4068 ## print("element count: <" . $#elements . ">\n");
4069 ## foreach my $el (@elements) {
4070 ## print("el: <$el>\n");
4071 ## }
4079 }
4090 ## print("n: <$n> good: <$good>\n");
4094 # Pick up the preceding and succeeding characters.
4099 }
4122 }
4131 # Pull out the value of this operator.
4134 # Get the full operator variant.
4137 # Ignore operators passed as parameters.
4141 # # Ignore comments
4142 # } elsif ($op =~ /^$;+$/) {
4144 # ; should have either the end of line or a space or \ after it
4152 }
4153 }
4155 # // is a comment
4158 # : when part of a bitfield
4160 # skip the bitfield test for now
4162 # No spaces for:
4163 # ->
4171 }
4173 }
4174 }
4176 # , must not have a space before and must have a space on the right.
4185 }
4186 }
4193 }
4194 }
4200 }
4203 }
4204 }
4206 # '*' as part of a type definition -- reported already.
4208 #warn "'*' is part of type\n";
4210 # unary operators should have a space before and
4211 # none after. May be left adjacent to another
4212 # unary operator, or a cast
4222 }
4223 }
4224 }
4226 # A unary '*' may be const
4234 }
4236 }
4237 }
4239 # unary ++ and unary -- are allowed no space on one side.
4246 }
4247 }
4254 }
4255 }
4262 }
4264 }
4265 }
4267 # << and >> may either have or not have spaces both sides
4273 {
4281 }
4287 }
4288 }
4295 }
4297 }
4298 }
4300 # A colon needs no spaces before when it is
4301 # terminating a case value or a label.
4308 }
4309 }
4311 # All the others need spaces both sides.
4315 # Ignore email addresses <foo@bar>
4320 {
4322 }
4324 # for asm volatile statements
4325 # ignore a colon with another
4326 # colon immediately before or after
4330 }
4332 # messages are ERROR, but ?: are CHK
4342 }
4344 }
4345 }
4346 }
4349 ## print("n: <$n> GOOD: <$good>\n");
4352 }
4356 }
4360 }
4363 }
4365 # check for whitespace before a non-naked semicolon
4372 }
4373 }
4375 # check for multiple assignments
4379 }
4381 ## # check for multiple declarations, allowing for a function declaration
4382 ## # continuation.
4383 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4384 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4385 ##
4386 ## # Remove any bracketed sections to ensure we do not
4387 ## # falsly report the parameters of functions.
4388 ## my $ln = $line;
4389 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4390 ## }
4391 ## if ($ln =~ /,/) {
4392 ## WARN("MULTIPLE_DECLARATION",
4393 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4394 ## }
4395 ## }
4397 #need space before brace following if, while, etc
4404 }
4405 }
4407 ## # check for blank lines before declarations
4408 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4409 ## $prevrawline =~ /^.\s*$/) {
4410 ## WARN("SPACING",
4411 ## "No blank lines before declarations\n" . $hereprev);
4412 ## }
4413 ##
4415 # closing brace should have a space following it when it has anything
4416 # on the line
4423 }
4424 }
4426 # check spacing on square brackets
4433 }
4434 }
4441 }
4442 }
4444 # check spacing on parentheses
4452 }
4453 }
4462 }
4463 }
4465 # check unnecessary parentheses around addressof/dereference single $Lvals
4466 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4474 }
4475 }
4477 # check for unnecessary parentheses around function pointer uses
4478 # ie: (foo->bar)(); should be foo->bar();
4479 # but not "if (foo->bar) (" to avoid some false positives
4488 }
4489 }
4491 # check for unnecessary parentheses around comparisons in if uses
4497 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4499 # avoid parentheses around potential macro args
4508 }
4509 }
4512 }
4513 }
4515 #goto labels aren't indented, allow a single space however
4523 }
4524 }
4526 # return is not a function
4536 }
4540 }
4541 }
4543 # unnecessary return in a void function
4544 # at end-of-function, with the previous line a single leading tab, then return;
4545 # and the line before that not a goto label target like "out:"
4553 }
4555 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4561 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4566 }
4567 }
4569 # comparisons with a constant or upper case identifier on the left
4570 # avoid cases like "foo + BAR < baz"
4571 # only fix matches surrounded by parentheses to avoid incorrect
4572 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4593 }
4595 }
4596 }
4598 # Return of what appears to be an errno should normally be negative
4604 }
4605 }
4607 # Need a space before open parenthesis after if, while etc
4614 }
4615 }
4617 # Check for illegal assignment in if conditional -- and check for trailing
4618 # statements after the conditional.
4626 ##print "stat<$stat> stat_next<$stat_next>\n";
4629 # If the statement carries leading newlines,
4630 # then count those as offsets.
4638 }
4639 }
4648 }
4650 # Find out what is on the end of the line after the
4651 # conditional.
4657 {
4658 # Find out how long the conditional actually is.
4667 }
4671 }
4672 }
4674 # Check for bitwise tests written as boolean
4680 |
4685 {
4688 }
4690 # if and else should not have general statements after it
4697 }
4698 }
4699 # if should not continue a brace
4704 }
4705 # case and default should not have general statements after them
4711 {
4714 }
4716 # Check for }<nl>else {, these must be at the same
4717 # indent level to be relevant to each other.
4729 }
4733 }
4734 }
4740 # Find out what is on the end of the line after the
4741 # conditional.
4757 }
4758 }
4759 }
4761 #Specific variable tests
4765 #gcc binary extension
4773 }
4774 }
4776 #CamelCase
4779 #Ignore Page<foo> variants
4781 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4783 #Ignore some three character SI units explicitly, like MiB and KHz
4789 seed_camelcase_includes();
4793 }
4794 }
4799 }
4800 }
4801 }
4802 }
4804 #no spaces allowed after \ in define
4810 }
4811 }
4813 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4814 # itself <asm/foo.h> (uses RAW line)
4821 {
4830 }
4831 }
4832 }
4833 }
4835 # multi-statement macros should be enclosed in a do while loop, grab the
4836 # first statement and ensure its the whole macro if its not enclosed
4837 # in a known good container
4849 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4850 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4864 }
4871 # Flatten any parentheses and braces
4875 {
4876 }
4878 # Flatten any obvious string concatentation.
4881 {
4882 }
4884 # Make asm volatile uses seem like a generic function
4889 module_param_named|
4890 MODULE_PARM_DESC|
4891 DECLARE_PER_CPU|
4892 DEFINE_PER_CPU|
4893 __typeof__\(|
4894 union|
4895 struct|
4900 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4908 }
4913 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4918 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4924 {
4927 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4934 }
4936 }
4938 # Make $define_stmt single line, comment-free, etc
4949 }
4950 }
4955 # check if any macro arguments are reused (ignore '...' and 'type')
4960 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
4967 }
4968 # check if any macro arguments may have other precedence issues
4974 }
4975 }
4977 # check for macros with flow control, but without ## concatenation
4978 # ## concatenation is commonly a macro that defines a function so ignore those
4985 }
4988 }
4990 # check for line continuations outside of #defines, preprocessor #, and asm
4999 }
5000 }
5002 # do {} while (0) macro tests:
5003 # single-statement macros do not need to be enclosed in do while (0) loop,
5004 # macro should not end with a semicolon
5019 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5029 }
5035 }
5039 }
5047 }
5051 }
5052 }
5054 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5055 # all assignments may have only one of the following with an assignment:
5056 # .
5057 # ALIGN(...)
5058 # VMLINUX_SYMBOL(...)
5062 }
5064 # check for redundant bracing round if etc
5068 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5069 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5079 # If the condition carries leading newlines, then count those as offsets.
5084 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5086 # We have looked at and allowed this specific line.
5096 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5098 #print "APW: ALLOWED: cond<$cond>\n";
5100 }
5102 #print "APW: ALLOWED: block<$block>\n";
5104 }
5106 #print "APW: ALLOWED: lines block<$block>\n";
5108 }
5110 }
5115 }
5123 }
5124 }
5125 }
5126 }
5131 # Check the pre-context.
5133 #print "APW: ALLOWED: pre<$1>\n";
5135 }
5140 # Check the condition.
5142 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5145 }
5147 #print "APW: ALLOWED: cond<$cond>\n";
5149 }
5151 #print "APW: ALLOWED: block<$block>\n";
5153 }
5155 #print "APW: ALLOWED: lines block<$block>\n";
5157 }
5158 # Check the post-context.
5163 }
5165 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5167 }
5168 }
5175 }
5179 }
5180 }
5182 # check for single line unbalanced braces
5186 }
5188 # check for unnecessary blank lines around braces
5194 }
5195 }
5201 }
5202 }
5204 # no volatiles please
5208 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5209 }
5211 # Check for user-visible strings broken across lines, which breaks the ability
5212 # to grep for the string. Make exceptions when the previous string ends in a
5213 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5214 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5227 }
5239 }
5241 }
5242 }
5244 # check for missing a space in a string concatenation
5248 }
5250 # check for an embedded function name in a string when the function is known
5251 # This does not work very well for -f --file checking as it depends on patch
5252 # context providing the function name or a single line form for in-file
5253 # function declarations
5259 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5260 }
5262 # check for spaces before a quoted newline
5268 }
5270 }
5272 # concatenated string without spaces between elements
5276 }
5278 # uncoalesced string fragments
5282 }
5284 # check for non-standard and hex prefixed decimal printf formats
5290 # check for %L
5295 }
5296 # check for %Z
5301 }
5302 # check for 0x<decimal>
5306 }
5307 }
5309 # check for line continuations in quoted strings with odd counts of "
5313 }
5315 # warn about #if 0
5320 }
5322 # check for needless "if (<foo>) fn(<foo>)" uses
5326 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5338 }
5343 }
5346 }
5350 }
5351 }
5352 }
5353 }
5355 # check for unnecessary "Out of Memory" messages
5364 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5366 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|kmemdup|(?:dev_)?alloc_skb)/) {
5369 }
5370 }
5372 # check for logging functions with KERN_<LEVEL>
5380 }
5381 }
5383 # check for logging continuations
5387 }
5389 # check for mask then right shift without a parentheses
5395 }
5397 # check for pointer comparisons to NULL
5407 }
5408 }
5409 }
5411 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5414 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5424 $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;
5425 }
5426 }
5427 }
5429 # check for $InitAttributeData (ie: __initdata) with const
5440 }
5441 }
5443 # check for $InitAttributeConst (ie: __initconst) without const
5455 }
5456 }
5458 # check for __read_mostly with const non-pointer (should just be const)
5465 }
5466 }
5468 # don't use __constant_<foo> functions outside of include/uapi/
5470 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5478 }
5479 }
5481 # prefer usleep_range over udelay
5484 # ignore udelay's < 10, however
5487 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5488 }
5492 }
5493 }
5495 # warn about unexpectedly long msleep's
5499 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5500 }
5501 }
5503 # check for comparisons of jiffies
5506 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5507 }
5509 # check for comparisons of get_jiffies_64()
5512 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5513 }
5515 # warn about #ifdefs in C files
5516 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5517 # print "#ifdef in C files should be avoided\n";
5518 # print "$herecurr";
5519 # $clean = 0;
5520 # }
5522 # warn about spacing in #ifdefs
5529 }
5531 }
5533 # check for spinlock_t definitions without a comment.
5540 }
5541 }
5542 # check for memory barriers without a comment.
5545 mb|
5546 rmb|
5547 wmb|
5548 read_barrier_depends
5551 mb__before_atomic|
5552 mb__after_atomic|
5553 store_release|
5554 load_acquire|
5555 store_mb|
5568 }
5569 }
5579 }
5581 # check for waitqueue_active without a comment.
5586 }
5587 }
5589 # check of hardware specific defines
5590 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5593 }
5595 # check that the storage class is not after a type
5599 }
5600 # Check that the storage class is at the beginning of a declaration
5607 }
5609 # check the location of the inline attribute, that it is between
5610 # storage class and type.
5615 }
5617 # Check for __inline__ and __inline, prefer inline
5625 }
5626 }
5628 # Check for __attribute__ packed, prefer __packed
5633 }
5635 # Check for __attribute__ aligned, prefer __aligned
5640 }
5642 # Check for __attribute__ format(printf, prefer __printf
5646 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5648 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5650 }
5651 }
5653 # Check for __attribute__ format(scanf, prefer __scanf
5657 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5659 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5660 }
5661 }
5663 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5665 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5670 }
5672 # check for c99 types like uint8_t used outside of uapi/ and tools/
5687 }
5688 }
5689 }
5691 # check for cast of C90 native int or longer types constants
5706 }
5708 }
5709 }
5711 # check for sizeof(&)
5715 }
5717 # check for sizeof without parenthesis
5722 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5723 }
5724 }
5726 # check for struct spinlock declarations
5730 }
5732 # check for seq_printf uses that could be seq_puts
5741 }
5742 }
5743 }
5745 # check for vsprintf extension %p<foo> misuses
5759 }
5760 }
5765 }
5768 }
5769 }
5771 # Check for misused memsets
5786 }
5787 }
5789 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5790 # if ($^V && $^V ge 5.10.0 &&
5791 # defined $stat &&
5792 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5793 # if (WARN("PREFER_ETHER_ADDR_COPY",
5794 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5795 # $fix) {
5796 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5797 # }
5798 # }
5800 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5801 # if ($^V && $^V ge 5.10.0 &&
5802 # defined $stat &&
5803 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5804 # WARN("PREFER_ETHER_ADDR_EQUAL",
5805 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5806 # }
5808 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5809 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5810 # if ($^V && $^V ge 5.10.0 &&
5811 # defined $stat &&
5812 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5813 #
5814 # my $ms_val = $7;
5815 #
5816 # if ($ms_val =~ /^(?:0x|)0+$/i) {
5817 # if (WARN("PREFER_ETH_ZERO_ADDR",
5818 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5819 # $fix) {
5820 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5821 # }
5822 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5823 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
5824 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5825 # $fix) {
5826 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5827 # }
5828 # }
5829 # }
5831 # typecasts on min/max could be min_t/max_t
5849 }
5852 }
5853 }
5855 # check usleep_range arguments
5863 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5867 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5868 }
5869 }
5871 # check for naked sscanf
5883 }
5886 }
5888 # check for simple sscanf that should be kstrto<foo>
5897 }
5905 }
5906 }
5907 }
5909 # check for new externs in .h files.
5916 }
5917 }
5919 # check for new externs in .c files.
5922 {
5929 }
5932 {
5935 }
5940 }
5944 {
5947 }
5949 # check for function declarations that have arguments without identifier names
5951 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
5959 }
5960 }
5961 }
5963 # check for function definitions
5969 # check for multiline function definition with misplaced open brace
5979 }
5983 }
5984 }
5986 # checks for new __setup's
5992 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
5993 }
5994 }
5996 # check for pointless casting of kmalloc return
5999 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6000 }
6002 # alloc style
6003 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6005 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6008 }
6010 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6013 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6024 }
6032 }
6037 $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;
6038 }
6039 }
6040 }
6042 # check for krealloc arg reuse
6047 }
6049 # check for alloc argument mismatch
6053 }
6055 # check for multiple semicolons
6061 }
6062 }
6064 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6073 }
6074 }
6076 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6077 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6083 }
6084 }
6086 # check for case / default statements not preceded by break/fallthrough/switch
6103 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6104 }
6108 }
6109 }
6111 # check for switch/default statements without a break;
6120 }
6123 }
6125 # check for gcc specific __FUNCTION__
6131 }
6132 }
6134 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6138 }
6140 # check for use of yield()
6144 }
6146 # check for comparisons against true and false
6162 }
6167 ## maybe suggesting a correct construct would better
6168 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6170 }
6171 }
6173 # check for semaphores initialized locked
6177 }
6179 # recommend kstrto* over simple_strto* and strict_strto*
6183 }
6185 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6188 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6189 }
6191 # check for various structs that are normally const (ops, kgdb, device_tree)
6192 # and avoid what seem like struct definitions 'struct foo {'
6197 }
6199 # use of NR_CPUS is usually wrong
6200 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6207 {
6209 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6210 }
6212 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6216 }
6218 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6223 }
6225 # whine mightly about in_atomic
6233 }
6234 }
6236 # whine about ACCESS_ONCE
6247 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6248 }
6254 }
6255 }
6256 }
6258 # check for mutex_trylock_recursive usage
6262 }
6264 # check for lockdep_set_novalidate_class
6272 }
6273 }
6278 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6279 }
6281 # Mode permission misuses where it seems decimal should be octal
6282 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6295 }
6301 }
6310 }
6313 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6314 }
6315 }
6316 }
6317 }
6319 # check for uses of S_<PERMS> that could be octal for readability
6336 }
6341 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6344 }
6345 }
6347 # validate content of MODULE_LICENSE against list from include/linux/module.h
6351 GPL|
6352 GPL\ v2|
6357 Proprietary
6362 }
6363 }
6364 }
6366 # If we have no input at all, then there is nothing to report on
6367 # so just keep quiet.
6370 }
6372 # In mailback mode only produce a report in the negative, for
6373 # things that appear to be patches.
6376 }
6378 # This is not a patch, and we are are in 'no-patch' mode so
6379 # just keep quiet.
6382 }
6387 }
6391 }
6399 }
6402 # If there were any defects found and not already fixing them
6408 EOM
6409 }
6410 # If there were whitespace errors which cleanpatch can fix
6411 # then suggest that.
6418 EOM
6419 }
6420 }
6440 }
6443 }
6444 }
6452 Do _NOT_ trust the results written to this file.
6455 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6457 EOM
6458 }
6459 }
6467 }
6468 }
6470 }