| blob | a09333fd7cef81053bf204dd03a4db07bbb833ef |
1 #!/usr/bin/env perl
2 # SPDX-License-Identifier: GPL-2.0
3 #
4 # (c) 2001, Dave Jones. (the file handling bit)
5 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
6 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
7 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
8 # (c) 2010-2018 Joe Perches <joe@perches.com>
73 Options:
78 --emacs emacs compile window format
79 --terse one line per report
82 single git commit with:
86 multiple git commits with:
90 git merges are ignored
105 is all off)
107 literally
110 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
111 with potential errors corrected to the preferred
112 checkpatch style
117 runtime errors.
120 --codespellfile Use this codespell dictionary
121 --typedefsfile Read additional types from this file
127 EOM
130 }
135 }
151 # Also catch when type or level is passed through a variable
152 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
154 }
159 }
162 }
184 }
185 }
188 }
190 # Perl's Getopt::Long allows options to take optional arguments after a space.
191 # Prevent --color by itself from consuming other arguments
195 }
196 }
198 GetOptions(
249 }
251 #if no filenames are given, push '-' to read patch from stdin
254 }
266 }
282 }
283 }
292 }
294 }
295 }
305 ## no critic
308 }
315 }
321 }
328 }
329 }
334 }
335 }
345 __user|
346 __kernel|
347 __force|
348 __iomem|
349 __must_check|
350 __kprobes|
351 __ref|
352 __refconst|
353 __refdata|
354 __rcu|
355 __private
363 # Notes to $Attribute:
364 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
366 const|
367 __percpu|
368 __nocast|
369 __safe|
370 __bitwise|
371 __packed__|
372 __packed2__|
373 __naked|
374 __maybe_unused|
375 __always_unused|
376 __noreturn|
377 __used|
378 __cold|
379 __pure|
380 __noclone|
381 __deprecated|
382 __read_mostly|
383 __ro_after_init|
384 __kprobes|
386 ____cacheline_aligned|
387 ____cacheline_aligned_in_smp|
388 ____cacheline_internodealigned_in_smp|
389 __weak
411 <=|>=|==|!=|
412 =>|->|<<|>>|<|>|!|~|
446 )};
449 atomic_t
450 )};
455 )};
461 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
462 TP_printk|
464 panic|
467 )};
475 # dev_alloc_skb/netdev_alloc_skb, et al
476 dma_alloc_coherent
477 )};
487 To:|
488 Cc:
489 )};
508 );
531 );
552 )};
559 );
563 );
570 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
577 );
579 #Create a search pattern for all these functions to speed up a loop below
584 }
598 );
600 #Create a search pattern for all these strings to speed up a loop below
605 }
609 S_IWUGO |
610 S_IWOTH |
611 S_IRWXUGO |
612 S_IALLUGO |
633 );
635 #Create a search pattern for all these strings to speed up a loop below
640 }
667 }
671 }
674 irq|
675 memory|
677 reboot
678 )};
679 # memory.h: ARM has a custom one
681 # Load common spelling mistakes and build regular expression list.
698 }
702 }
721 }
725 }
726 }
745 }
749 }
752 }
755 }
765 }
784 )
791 )
800 )
804 $NonptrType
809 $NonptrTypeMisordered
815 }
816 build_types();
820 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
821 # requires at least perl version v5.10.0
822 # Any use must be runtime checked with $^V
833 )};
842 }
847 }
871 }
872 }
873 }
880 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
883 }
888 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
894 }
918 }
920 }
928 }
932 }
937 }
941 }
949 }
951 }
952 }
966 # Maybe one day convert this block of bash into something that returns
967 # all matching commit ids, but it's very slow...
968 #
969 # echo "checking commits $1..."
970 # git rev-list --remotes | grep -i "^$1" |
971 # while read line ; do
972 # git log --format='%H %s' -1 $line |
973 # echo "commit $(cut -c 1-12,41-)"
974 # done
975 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
980 }
983 }
994 # If input is git commits, extract all commits from the commit expressions.
995 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1008 }
1017 }
1018 }
1021 }
1038 }
1045 }
1049 }
1056 }
1060 }
1069 build_types();
1070 }
1081 EOM
1082 }
1088 EOM
1089 }
1090 }
1101 );
1106 }
1107 }
1109 }
1132 # If there's a name left after stripping spaces and
1133 # leading quotes, and the address doesn't have both
1134 # leading and trailing angle brackets, the address
1135 # is invalid. ie:
1136 # "joe smith joe@smith.com" bad
1137 # "joe smith <joe@smith.com" bad
1142 }
1143 }
1153 }
1156 }
1170 }
1176 }
1179 }
1187 }
1188 }
1191 }
1199 }
1200 }
1203 }
1216 }
1218 }
1221 }
1224 }
1228 }
1233 # Drop the diff line leader and expand tabs
1237 # Pick the indent from the front of the line.
1241 }
1252 }
1253 }
1264 # Always copy over the diff marker.
1270 # Comments we are whacking completely including the begin
1271 # and end, all to $;.
1278 }
1284 }
1291 }
1293 # A \ in a string means ignore the next character.
1299 }
1300 # Regular quotes.
1309 }
1310 }
1312 #print "c<$c> SQ<$sanitise_quote>\n";
1321 }
1322 }
1326 }
1328 # The pathname on a #include may be surrounded by '<' and '>'.
1333 # The whole of a #error is a string.
1337 }
1342 }
1345 }
1353 }
1376 #warn "CSB: blk<$blk> remain<$remain>\n";
1377 # If we are about to drop off the end, pull in more
1378 # context.
1389 }
1390 # Bail if there is no further context.
1391 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1394 }
1398 }
1399 }
1404 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1406 # Handle nested #if/#else.
1413 }
1415 # Statement ends at the ';' or a close '}' at the
1416 # outermost level.
1419 }
1421 # An else is really a conditional as long as its not else if
1428 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1429 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1430 }
1435 }
1443 #warn "CSB: mark coff<$coff>\n";
1444 }
1445 }
1449 }
1457 }
1459 }
1460 }
1461 # Preprocessor commands end at the newline unless escaped.
1467 }
1469 }
1470 # We are truly at the end, so shuffle to the next line.
1475 }
1480 #warn "STATEMENT<$statement>\n";
1481 #warn "CONDITION<$condition>\n";
1483 #print "coff<$coff> soff<$off> loff<$loff>\n";
1487 }
1492 # Strip the diff line prefixes and rip blank lines at start and end.
1500 }
1508 }
1529 }
1530 }
1538 # Grab the first conditional/block pair.
1541 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1545 }
1547 # Pull in the following conditional/block pairs and see if they
1548 # could continue the statement.
1552 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1554 #print "C: push\n";
1556 }
1559 }
1578 # Handle nested #if/#else.
1585 }
1588 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1592 }
1599 }
1600 }
1604 }
1607 }
1610 }
1616 }
1622 }
1628 }
1633 }
1638 }
1643 # Catch a comment on the end of the line itself.
1647 # Look through the context and try and figure out if there is a
1648 # comment.
1653 #warn " $line\n";
1656 }
1659 }
1662 }
1666 }
1667 }
1671 }
1676 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1677 ##print "CMMT: $cmt\n";
1680 }
1693 }
1696 }
1704 }
1707 }
1715 }
1718 }
1730 }
1731 }
1735 }
1747 }
1767 }
1788 }
1817 # Assume all arms of the conditional end as this
1818 # one does, and continue as if the #endif was not here.
1835 }
1866 }
1878 }
1911 }
1926 }
1935 }
1939 }
1943 }
1944 }
1947 }
1956 DEFINE_\S+
1957 )$|
1961 case|
1965 \#|
1966 \#\#|
1972 # Check for modifiers.
1983 }
1984 }
1989 }
1990 build_types();
1993 }
1994 }
2006 }
2014 }
2023 }
2024 }
2029 }
2037 }
2043 }
2047 }
2058 }
2059 }
2086 }
2092 }
2099 }
2104 }
2107 }
2110 }
2118 };
2120 }
2128 };
2131 }
2140 }
2142 }
2150 }
2152 }
2160 }
2162 }
2168 ##print "absolute<$absolute>\n";
2170 # See if any suffix of this path is a path within the tree.
2173 ##print "file<$file>\n";
2175 }
2176 }
2179 }
2181 # It is, so see if the prefix is acceptable.
2185 ##print "prefix<$prefix>\n";
2189 }
2190 }
2198 }
2206 }
2214 }
2222 }
2231 #convert leading spaces to tabs
2233 #Remove spaces before a tab
2237 }
2251 }
2263 }
2264 }
2267 }
2308 # Trace the real file/line as we go.
2321 # suppression flags
2329 # Pre-scan the patch sanitizing the lines.
2330 # Pre-scan the patch looking for any __setup documentation.
2331 #
2339 sanitise_line_reset();
2351 }
2352 #next;
2353 }
2360 }
2363 # Guestimate if this is a continuing comment. Run
2364 # the context looking for a comment "edge". If this
2365 # edge is a close comment then we must be in a comment
2366 # at context start.
2373 #print "RAW<$rawlines[$ln - 1]>\n";
2379 }
2380 }
2383 }
2385 # Guestimate if this is a continuing comment. If this
2386 # is the start of a diff block and this line starts
2387 # ' *' then it is very likely a comment.
2390 {
2392 }
2394 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2398 # Standardise the strings and chars within the input to
2399 # simplify matching -- only bother with positive lines.
2401 }
2408 }
2410 #print "==>$rawline\n";
2411 #print "-->$line\n";
2415 }
2416 }
2431 # check if it's a mode change, rename or start of a patch
2437 }
2439 #extract the line range in the file after the patch is applied
2450 }
2451 annotate_reset();
2462 }
2465 # track the line number as we move through the hunk, note that
2466 # new versions of GNU diff omit the leading space on completely
2467 # blank context lines so we need to count that too.
2472 # Measure the line length and indent.
2475 # Track the previous line.
2480 #warn "line<$line>\n";
2484 }
2492 # extract the filename as it passes
2508 }
2512 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2513 }
2515 }
2517 #make up the handle for any error we report on this line
2525 }
2526 }
2531 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2532 }
2537 }
2548 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2549 }
2550 }
2553 }
2563 # Verify the existence of a commit log if appropriate
2564 # 2 is used because a $signature is counted in $commit_log_lines
2568 }
2573 }
2575 # Check if the commit log has what seems like a diff which can confuse patch
2584 }
2586 # Check for incorrect file permissions
2593 }
2594 }
2596 # Check the patch for a From:
2601 }
2603 # Check the patch for a signoff:
2612 }
2613 }
2614 }
2616 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2617 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2620 }
2622 # Check signature styles
2634 }
2641 }
2642 }
2649 }
2651 }
2658 }
2659 }
2670 # Don't force email to have quotes
2671 # Allow just an angle bracketed address
2677 }
2678 }
2680 # Check for duplicate signatures
2689 }
2690 }
2692 # Check email subject for common tools that don't need to be mentioned
2697 }
2699 # Check for unwanted Gerrit info
2703 }
2705 # Check if the commit log is in a possible stack dump
2709 # timestamp
2711 # stack dump address
2713 }
2715 # Check for line lengths > 75 in commit log, warn once
2719 # file delta changes
2721 # filename then :
2723 # A Fixes: or Link: line
2728 }
2730 # Reset possible stack dump if a blank line is found
2734 }
2736 # Check for git id commit length and improperly formed commit descriptions
2761 }
2783 }
2791 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2792 }
2793 }
2795 # Check for added, moved or deleted files
2805 }
2807 # Check for wrappage within a valid hunk of the file
2812 }
2814 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2825 }
2827 # Check if it's the start of a commit log
2828 # (not a header line and we haven't seen the patch filename)
2835 }
2837 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2838 # declined it, i.e defined some charset where it is missing.
2843 }
2849 }
2851 # Check for absolute kernel paths in commit message
2858 #
2861 }
2862 }
2863 }
2865 # Check for various typo / spelling mistakes
2879 }
2880 }
2881 }
2883 # ignore non-hunk lines and lines being removed
2886 #trailing whitespace
2893 }
2900 }
2903 }
2905 # Check for FSF mailing addresses.
2914 "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)
2915 }
2917 # check for Kconfig help text having a real description
2918 # Only applies when adding the entry originally, after that we do not have
2919 # sufficient context to determine whether it is indeed long enough.
2921 # 'choice' is usually the last thing on the line (though
2922 # Kconfig supports named choices), so use a word boundary
2923 # (\b) rather than a whitespace character (\s)
2945 }
2947 }
2954 # This only checks context lines in the patch
2955 # and so hopefully shouldn't trigger false
2956 # positives, even though some of these are
2957 # common words in help texts
2962 }
2964 }
2968 }
2969 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2970 }
2972 # check for MAINTAINERS entries that don't have the right form
2980 }
2981 }
2983 # discourage the use of boolean for type definition attributes of Kconfig options
2988 }
2998 };
3001 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3002 }
3004 # check for DT compatible documentation
3023 }
3030 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3031 }
3032 }
3033 }
3035 # check for using SPDX license tag at beginning of files
3049 }
3051 # check SPDX comment style for .[chsS] files
3057 }
3068 }
3069 }
3070 }
3071 }
3073 # check we are in a valid source file if not then ignore this hunk
3076 # check for using SPDX-License-Identifier on the wrong line number
3082 }
3084 # line length limit (with some exclusions)
3085 #
3086 # There are a few types of lines that may extend beyond $max_line_length:
3087 # logging functions like pr_info that end in a string
3088 # lines with a single string
3089 # #defines that are a single string
3090 # lines with an RFC3986 like URL
3091 #
3092 # There are 3 different line length message types:
3093 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3094 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3095 # LONG_LINE all other lines longer than $max_line_length
3096 #
3097 # if LONG_LINE is ignored, the other 2 types are also ignored
3098 #
3103 # Check the allowed long line types first
3105 # logging functions that end in a string that starts
3106 # before $max_line_length
3107 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3111 # lines with only strings (w/ possible termination)
3112 # #defines with only strings
3117 # More special cases
3122 # URL ($rawline is used in case the URL is in a comment)
3126 # Otherwise set the alternate message types
3128 # a comment starts before $max_line_length
3133 # a quoted string starts before $max_line_length
3137 }
3143 }
3144 }
3146 # check for adding lines without a newline.
3147 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3150 }
3152 # check we are in a valid source file C or perl if not then ignore this hunk
3155 # at the beginning of a line any tabs must come first and anything
3156 # more than 8 must use tabs.
3165 }
3166 }
3168 # check for space before tabs.
3178 }
3179 }
3181 # check for assignments on the start of a line
3185 }
3187 # check for && or || at the start of a line
3191 }
3193 # check indentation starts on a tab stop
3195 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3202 }
3203 }
3204 }
3206 # check multi-line statement indentation matches previous line
3208 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3231 }
3232 }
3233 }
3234 }
3236 # check for space after cast like "(int) foo" or "(struct foo) bar"
3237 # avoid checking a few false positives:
3238 # "sizeof(<type>)" or "__alignof__(<type>)"
3239 # function pointer declarations like "(*foo)(int) = bar;"
3240 # structure definitions like "(struct foo) { 0 };"
3241 # multiline macros that define functions
3242 # known attributes or the __attribute__ keyword
3250 }
3251 }
3253 # Block comment styles
3254 # Networking with an initial /*
3261 }
3263 # Block comments use * on subsequent lines
3271 }
3273 # Block comments use */ on trailing lines
3280 }
3282 # Block comment * alignment
3296 }
3303 }
3304 }
3306 # check for missing blank lines after struct/union declarations
3307 # with exceptions for various attributes and macros
3323 }
3324 }
3326 # check for multiple consecutive blank lines
3334 }
3337 }
3339 # check for missing blank lines after declarations
3341 # actual declarations
3343 # function pointer declarations
3345 # foo bar; where foo is some local typedef or #define
3347 # known declaration macros
3349 # for "else if" which can look like "$Ident $Ident"
3351 # other possible extensions of declaration lines
3353 # not starting a section or a macro "\" extended line
3355 # looks like a declaration
3357 # function pointer declarations
3359 # foo bar; where foo is some local typedef or #define
3361 # known declaration macros
3363 # start of struct or union or enum
3365 # start or end of block or continuation of declaration
3367 # bitfield continuation
3369 # other possible extensions of declaration lines
3371 # indentation of previous and current line are the same
3377 }
3378 }
3380 # check for spaces at the beginning of a line.
3381 # Exceptions:
3382 # 1) within comments
3383 # 2) indented preprocessor commands
3384 # 3) hanging labels
3391 }
3392 }
3394 # check we are in a valid C source file if not then ignore this hunk
3397 # check for unusual line ending [ or (
3401 }
3403 # check if this appears to be the start function declaration, save the name
3407 }
3409 # check if this appears to be the end of function declaration
3412 }
3414 # check indentation of any line with a bare else
3415 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3416 # if the previous line is a break or return and is indented 1 tab more...
3425 }
3426 }
3428 # check indentation of a line with a break;
3429 # if the previous line is a goto or return and is indented the same # of tabs
3435 }
3436 }
3438 # check for RCS/CVS revision markers
3442 }
3444 # check for old HOTPLUG __dev<foo> section markings
3448 }
3450 # Check for potential 'bare' types
3453 #print "LINE<$line>\n";
3461 #print "linenr<$linenr> <$stat>\n";
3462 # If this statement has no statement boundaries within
3463 # it there is no point in retrying a statement scan
3464 # until we hit end of it.
3467 #print "skip<$line_nr_next>\n";
3469 }
3471 # Find the real next line.
3477 }
3482 # Ignore goto labels.
3485 # Ignore functions being called
3490 # declarations always start with types
3491 } 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) {
3496 # definitions in global scope can only start with types
3499 }
3501 # any (foo ... *) is a pointer cast, and foo is a type
3504 }
3506 # Check for any sort of function declaration.
3507 # int foo(something bar, other baz);
3508 # void (*store_gdt)(x86_descr_ptr *);
3509 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3517 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3520 }
3521 }
3522 }
3524 }
3526 #
3527 # Checks which may be anchored in the context.
3528 #
3530 # Check for switch () and associated case and default
3531 # statements should be at the same indent.
3545 }
3546 }
3550 }
3551 }
3553 # if/while/etc brace do not go on next line, unless defining a do while loop,
3554 # or if that brace on the next line is for something else
3555 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3563 }
3574 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3577 }
3579 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3580 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3586 }
3590 {
3596 }
3597 }
3598 }
3600 # Check relative indent for conditionals and blocks.
3601 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3609 # remove inline comments
3613 # Find out how long the conditional actually is.
3617 # Make sure we remove the line prefixes as we have
3618 # none on the first line, and are going to readd them
3619 # where necessary.
3623 }
3625 # We want to check the first line inside the block
3626 # starting at the end of the conditional, so remove:
3627 # 1) any blank line termination
3628 # 2) any opening brace { on end of the line
3629 # 3) any do (...) {
3636 }
3640 }
3642 # Also ignore a loop construct at the end of a
3643 # preprocessor statement.
3647 }
3654 # If we see an #else/#elif then the code
3655 # is not linear.
3658 }
3660 # Ignore:
3661 # 1) blank lines, they should be at 0,
3662 # 2) preprocessor lines, and
3663 # 3) labels.
3671 }
3672 }
3673 }
3678 # Check if either of these lines are modified, else
3679 # this is not this patch's fault.
3683 }
3686 }
3688 #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";
3697 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3698 }
3699 }
3701 # Track the 'values' across context and added lines.
3711 }
3714 #ignore lines not being added
3717 # check for dereferences that span multiple lines
3727 }
3729 # check for declarations of signed or unsigned without int
3730 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3741 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3749 }
3750 }
3751 }
3753 # TEST: allow direct testing of the type matcher.
3761 }
3763 }
3764 # TEST: allow direct testing of the attribute matcher.
3772 }
3774 }
3776 # check for initialisation to aggregates open brace on the next line
3790 }
3791 }
3793 #
3794 # Checks which are anchored on the added line.
3795 #
3797 # check for malformed paths in #include statements (uses RAW line)
3803 }
3807 }
3808 }
3810 # no C99 // comments
3819 }
3820 }
3821 }
3822 # Remove C99 comments.
3826 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3827 # the whole statement.
3828 #print "APW <$lines[$realline_next - 1]>\n";
3834 # Handle definitions which produce identifiers with
3835 # a prefix:
3836 # XXX(foo);
3837 # EXPORT_SYMBOL(something_foo);
3841 #print "FOO C name<$name>\n";
3852 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3856 }
3857 }
3862 #print "FOO B <$lines[$linenr - 1]>\n";
3864 }
3869 }
3871 # check for global initialisers.
3877 }
3878 }
3879 # check for static initialisers.
3886 }
3887 }
3889 # check for misordered declarations of char/short/int/long with signed/unsigned
3893 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3894 }
3896 # check for unnecessary <signed> int declarations of short/long/long long
3913 }
3914 }
3916 # check for static const char * arrays.
3921 }
3923 # check for initialized const char arrays that should be static const
3924 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
3929 }
3930 }
3932 # check for static char foo[] = "bar" declarations.
3937 }
3939 # check for const <foo> const where <foo> is not a pointer or array type
3948 }
3949 }
3951 # check for non-global char *foo[] = {"bar", ...} declarations.
3956 }
3958 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3961 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3967 }
3968 }
3969 }
3971 # check for function declarations without arguments like "int foo()"
3977 }
3978 }
3980 # check for new typedefs, only function parameters and sparse annotations
3981 # make sense.
3989 }
3991 # * goes on variable not on type
3992 # (char*[ const])
3994 #print "AA<$1>\n";
3997 # Should start with a space.
3999 # Should not end with a space.
4001 # '*'s should not have spaces between.
4003 }
4005 ## print "1: from<$from> to<$to> ident<$ident>\n";
4015 }
4016 }
4017 }
4019 #print "BB<$1>\n";
4022 # Should start with a space.
4024 # Should not end with a space.
4026 # '*'s should not have spaces between.
4028 }
4029 # Modifiers should have spaces.
4032 ## print "2: from<$from> to<$to> ident<$ident>\n";
4043 }
4044 }
4045 }
4047 # avoid BUG() or BUG_ON()
4052 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4053 }
4055 # avoid LINUX_VERSION_CODE
4058 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4059 }
4061 # check for uses of printk_ratelimit
4065 }
4067 # printk should use KERN_* levels
4071 }
4080 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
4081 }
4089 }
4090 }
4099 }
4101 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4102 # number of false positives, but assembly files are not checked, so at
4103 # least the arch entry code will not trigger this warning.
4107 }
4109 # function brace can't be on same line, except for #defines of do while,
4110 # or if closed on same line
4127 }
4128 }
4129 }
4131 # open braces for enum, union and struct go on the same line.
4145 }
4146 }
4147 }
4149 # missing space after union, struct or enum definition
4156 }
4157 }
4159 # Function pointer declarations
4160 # check spacing between type, funcptr, and args
4161 # canonical declaration is "type (*funcptr)(args...)"
4170 # the $Declare variable will capture all spaces after the type
4171 # so check it for a missing trailing missing space but pointer return types
4172 # don't need a space so don't warn for those.
4177 }
4182 }
4184 # unnecessary space "type (*funcptr)(args...)"
4185 # This test is not currently implemented because these declarations are
4186 # equivalent to
4187 # int foo(int bar, ...)
4188 # and this is form shouldn't/doesn't generate a checkpatch warning.
4189 #
4190 # elsif ($declare =~ /\s{2,}$/) {
4191 # WARN("SPACING",
4192 # "Multiple spaces after return type\n" . $herecurr);
4193 # }
4195 # unnecessary space "type ( *funcptr)(args...)"
4200 }
4202 # unnecessary space "type (* funcptr)(args...)"
4207 }
4209 # unnecessary space "type (*funcptr )(args...)"
4214 }
4216 # unnecessary space "type (*funcptr) (args...)"
4221 }
4225 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4226 }
4227 }
4229 # check for spacing round square brackets; allowed:
4230 # 1. with a type on the left -- int [] a;
4231 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4232 # 3. inside a curly brace -- = { [0...10] = 5 }
4243 }
4244 }
4245 }
4247 # check for spaces between functions and their parentheses.
4253 # Ignore those directives where spaces _are_ permitted.
4259 {
4260 # cpp #define statements have non-optional spaces, ie
4261 # if there is a space between the name and the open
4262 # parenthesis it is simply not a parameter group.
4265 # cpp #elif statement condition may start with a (
4268 # If this whole things ends with a type its most
4269 # likely a typedef for a function.
4278 }
4279 }
4280 }
4282 # Check operator spacing.
4288 <<=|>>=|<=|>=|==|!=|
4290 =>|->|<<|>>|<|>|=|!|~|
4296 ## print("element count: <" . $#elements . ">\n");
4297 ## foreach my $el (@elements) {
4298 ## print("el: <$el>\n");
4299 ## }
4307 }
4318 ## print("n: <$n> good: <$good>\n");
4322 # Pick up the preceding and succeeding characters.
4327 }
4350 }
4359 # Pull out the value of this operator.
4362 # Get the full operator variant.
4365 # Ignore operators passed as parameters.
4369 # # Ignore comments
4370 # } elsif ($op =~ /^$;+$/) {
4372 # ; should have either the end of line or a space or \ after it
4380 }
4381 }
4383 # // is a comment
4386 # : when part of a bitfield
4388 # skip the bitfield test for now
4390 # No spaces for:
4391 # ->
4399 }
4401 }
4402 }
4404 # , must not have a space before and must have a space on the right.
4413 }
4414 }
4421 }
4422 }
4428 }
4431 }
4432 }
4434 # '*' as part of a type definition -- reported already.
4436 #warn "'*' is part of type\n";
4438 # unary operators should have a space before and
4439 # none after. May be left adjacent to another
4440 # unary operator, or a cast
4450 }
4451 }
4452 }
4454 # A unary '*' may be const
4462 }
4464 }
4465 }
4467 # unary ++ and unary -- are allowed no space on one side.
4474 }
4475 }
4482 }
4483 }
4490 }
4492 }
4493 }
4495 # << and >> may either have or not have spaces both sides
4501 {
4509 }
4515 }
4516 }
4523 }
4525 }
4526 }
4528 # A colon needs no spaces before when it is
4529 # terminating a case value or a label.
4536 }
4537 }
4539 # All the others need spaces both sides.
4543 # Ignore email addresses <foo@bar>
4548 {
4550 }
4552 # for asm volatile statements
4553 # ignore a colon with another
4554 # colon immediately before or after
4558 }
4560 # messages are ERROR, but ?: are CHK
4570 }
4572 }
4573 }
4574 }
4577 ## print("n: <$n> GOOD: <$good>\n");
4580 }
4584 }
4588 }
4591 }
4593 # check for whitespace before a non-naked semicolon
4600 }
4601 }
4603 # check for multiple assignments
4607 }
4609 ## # check for multiple declarations, allowing for a function declaration
4610 ## # continuation.
4611 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4612 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4613 ##
4614 ## # Remove any bracketed sections to ensure we do not
4615 ## # falsly report the parameters of functions.
4616 ## my $ln = $line;
4617 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4618 ## }
4619 ## if ($ln =~ /,/) {
4620 ## WARN("MULTIPLE_DECLARATION",
4621 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4622 ## }
4623 ## }
4625 #need space before brace following if, while, etc
4632 }
4633 }
4635 ## # check for blank lines before declarations
4636 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4637 ## $prevrawline =~ /^.\s*$/) {
4638 ## WARN("SPACING",
4639 ## "No blank lines before declarations\n" . $hereprev);
4640 ## }
4641 ##
4643 # closing brace should have a space following it when it has anything
4644 # on the line
4651 }
4652 }
4654 # check spacing on square brackets
4661 }
4662 }
4669 }
4670 }
4672 # check spacing on parentheses
4680 }
4681 }
4690 }
4691 }
4693 # check unnecessary parentheses around addressof/dereference single $Lvals
4694 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4702 }
4703 }
4705 # check for unnecessary parentheses around function pointer uses
4706 # ie: (foo->bar)(); should be foo->bar();
4707 # but not "if (foo->bar) (" to avoid some false positives
4716 }
4717 }
4719 # check for unnecessary parentheses around comparisons in if uses
4720 # when !drivers/staging or command-line uses --strict
4727 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4729 # avoid parentheses around potential macro args
4738 }
4739 }
4742 }
4743 }
4745 #goto labels aren't indented, allow a single space however
4753 }
4754 }
4756 # return is not a function
4766 }
4770 }
4771 }
4773 # unnecessary return in a void function
4774 # at end-of-function, with the previous line a single leading tab, then return;
4775 # and the line before that not a goto label target like "out:"
4783 }
4785 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4791 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4796 }
4797 }
4799 # comparisons with a constant or upper case identifier on the left
4800 # avoid cases like "foo + BAR < baz"
4801 # only fix matches surrounded by parentheses to avoid incorrect
4802 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4823 }
4825 }
4826 }
4828 # Return of what appears to be an errno should normally be negative
4834 }
4835 }
4837 # Need a space before open parenthesis after if, while etc
4844 }
4845 }
4847 # Check for illegal assignment in if conditional -- and check for trailing
4848 # statements after the conditional.
4856 ##print "stat<$stat> stat_next<$stat_next>\n";
4859 # If the statement carries leading newlines,
4860 # then count those as offsets.
4868 }
4869 }
4878 }
4880 # Find out what is on the end of the line after the
4881 # conditional.
4887 {
4888 # Find out how long the conditional actually is.
4897 }
4901 }
4902 }
4904 # Check for bitwise tests written as boolean
4910 |
4915 {
4918 }
4920 # if and else should not have general statements after it
4927 }
4928 }
4929 # if should not continue a brace
4934 }
4935 # case and default should not have general statements after them
4941 {
4944 }
4946 # Check for }<nl>else {, these must be at the same
4947 # indent level to be relevant to each other.
4959 }
4963 }
4964 }
4970 # Find out what is on the end of the line after the
4971 # conditional.
4987 }
4988 }
4989 }
4991 #Specific variable tests
4995 #CamelCase
4998 #Ignore Page<foo> variants
5000 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
5002 #Ignore some three character SI units explicitly, like MiB and KHz
5008 seed_camelcase_includes();
5012 }
5013 }
5018 }
5019 }
5020 }
5021 }
5023 #no spaces allowed after \ in define
5029 }
5030 }
5032 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5033 # itself <asm/foo.h> (uses RAW line)
5040 {
5049 }
5050 }
5051 }
5052 }
5054 # multi-statement macros should be enclosed in a do while loop, grab the
5055 # first statement and ensure its the whole macro if its not enclosed
5056 # in a known good container
5068 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5069 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5084 }
5091 # Flatten any parentheses and braces
5095 {
5096 }
5098 # Flatten any obvious string concatentation.
5101 {
5102 }
5104 # Make asm volatile uses seem like a generic function
5109 module_param_named|
5110 MODULE_PARM_DESC|
5111 DECLARE_PER_CPU|
5112 DEFINE_PER_CPU|
5113 __typeof__\(|
5114 union|
5115 struct|
5120 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5129 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5134 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5140 {
5143 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5150 }
5152 }
5154 # Make $define_stmt single line, comment-free, etc
5165 }
5166 }
5171 # check if any macro arguments are reused (ignore '...' and 'type')
5176 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5183 }
5184 # check if any macro arguments may have other precedence issues
5190 }
5191 }
5193 # check for macros with flow control, but without ## concatenation
5194 # ## concatenation is commonly a macro that defines a function so ignore those
5201 }
5203 # check for line continuations outside of #defines, preprocessor #, and asm
5212 }
5213 }
5215 # do {} while (0) macro tests:
5216 # single-statement macros do not need to be enclosed in do while (0) loop,
5217 # macro should not end with a semicolon
5232 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5244 }
5248 }
5256 }
5257 }
5259 # check for redundant bracing round if etc
5263 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5264 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5274 # If the condition carries leading newlines, then count those as offsets.
5279 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5281 # We have looked at and allowed this specific line.
5291 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5293 #print "APW: ALLOWED: cond<$cond>\n";
5295 }
5297 #print "APW: ALLOWED: block<$block>\n";
5299 }
5301 #print "APW: ALLOWED: lines block<$block>\n";
5303 }
5305 }
5310 }
5318 }
5319 }
5320 }
5321 }
5326 # Check the pre-context.
5328 #print "APW: ALLOWED: pre<$1>\n";
5330 }
5335 # Check the condition.
5337 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5340 }
5342 #print "APW: ALLOWED: cond<$cond>\n";
5344 }
5346 #print "APW: ALLOWED: block<$block>\n";
5348 }
5350 #print "APW: ALLOWED: lines block<$block>\n";
5352 }
5353 # Check the post-context.
5358 }
5360 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5362 }
5363 }
5370 }
5371 }
5373 # check for single line unbalanced braces
5377 }
5379 # check for unnecessary blank lines around braces
5385 }
5386 }
5392 }
5393 }
5395 # no volatiles please
5399 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5400 }
5402 # Check for user-visible strings broken across lines, which breaks the ability
5403 # to grep for the string. Make exceptions when the previous string ends in a
5404 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5405 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5418 }
5430 }
5432 }
5433 }
5435 # check for missing a space in a string concatenation
5439 }
5441 # check for an embedded function name in a string when the function is known
5442 # This does not work very well for -f --file checking as it depends on patch
5443 # context providing the function name or a single line form for in-file
5444 # function declarations
5450 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5451 }
5453 # check for spaces before a quoted newline
5459 }
5461 }
5463 # concatenated string without spaces between elements
5472 }
5473 }
5474 }
5476 # uncoalesced string fragments
5484 }
5485 }
5486 }
5488 # check for non-standard and hex prefixed decimal printf formats
5494 # check for %L
5499 }
5500 # check for %Z
5505 }
5506 # check for 0x<decimal>
5510 }
5511 }
5513 # check for line continuations in quoted strings with odd counts of "
5517 }
5519 # warn about #if 0
5523 }
5525 # warn about #if 1
5529 }
5531 # check for needless "if (<foo>) fn(<foo>)" uses
5535 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5547 }
5552 }
5555 }
5559 }
5560 }
5561 }
5562 }
5564 # check for unnecessary "Out of Memory" messages
5573 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5575 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5579 }
5580 }
5582 # check for logging functions with KERN_<LEVEL>
5590 }
5591 }
5593 # check for logging continuations
5597 }
5599 # check for mask then right shift without a parentheses
5605 }
5607 # check for pointer comparisons to NULL
5617 }
5618 }
5619 }
5621 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5624 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5634 $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;
5635 }
5636 }
5637 }
5639 # check for $InitAttributeData (ie: __initdata) with const
5650 }
5651 }
5653 # check for $InitAttributeConst (ie: __initconst) without const
5665 }
5666 }
5668 # check for __read_mostly with const non-pointer (should just be const)
5675 }
5676 }
5678 # don't use __constant_<foo> functions outside of include/uapi/
5680 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5688 }
5689 }
5691 # prefer usleep_range over udelay
5694 # ignore udelay's < 10, however
5697 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5698 }
5702 }
5703 }
5705 # warn about unexpectedly long msleep's
5709 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5710 }
5711 }
5713 # check for comparisons of jiffies
5716 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5717 }
5719 # check for comparisons of get_jiffies_64()
5722 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5723 }
5725 # warn about #ifdefs in C files
5726 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5727 # print "#ifdef in C files should be avoided\n";
5728 # print "$herecurr";
5729 # $clean = 0;
5730 # }
5732 # warn about spacing in #ifdefs
5739 }
5741 }
5743 # check for spinlock_t definitions without a comment.
5750 }
5751 }
5752 # check for memory barriers without a comment.
5755 mb|
5756 rmb|
5757 wmb|
5758 read_barrier_depends
5761 mb__before_atomic|
5762 mb__after_atomic|
5763 store_release|
5764 load_acquire|
5765 store_mb|
5778 }
5779 }
5789 }
5791 # check for waitqueue_active without a comment.
5796 }
5797 }
5799 # check for smp_read_barrier_depends and read_barrier_depends
5803 }
5805 # check of hardware specific defines
5806 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5809 }
5811 # check that the storage class is not after a type
5815 }
5816 # Check that the storage class is at the beginning of a declaration
5823 }
5825 # check the location of the inline attribute, that it is between
5826 # storage class and type.
5831 }
5833 # Check for __inline__ and __inline, prefer inline
5841 }
5842 }
5844 # Check for __attribute__ packed, prefer __packed
5849 }
5851 # Check for __attribute__ aligned, prefer __aligned
5856 }
5858 # Check for __attribute__ format(printf, prefer __printf
5862 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5864 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5866 }
5867 }
5869 # Check for __attribute__ format(scanf, prefer __scanf
5873 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5875 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5876 }
5877 }
5879 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5881 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5886 }
5888 # check for c99 types like uint8_t used outside of uapi/ and tools/
5903 }
5904 }
5905 }
5907 # check for cast of C90 native int or longer types constants
5922 }
5924 }
5925 }
5927 # check for sizeof(&)
5931 }
5933 # check for sizeof without parenthesis
5938 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5939 }
5940 }
5942 # check for struct spinlock declarations
5946 }
5948 # check for seq_printf uses that could be seq_puts
5957 }
5958 }
5959 }
5961 # check for vsprintf extension %p<foo> misuses
5983 }
5987 }
5989 "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n");
5990 }
5991 }
6000 }
6004 }
6005 }
6006 }
6008 # Check for misused memsets
6023 }
6024 }
6026 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6027 # if ($perl_version_ok &&
6028 # defined $stat &&
6029 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6030 # if (WARN("PREFER_ETHER_ADDR_COPY",
6031 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6032 # $fix) {
6033 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6034 # }
6035 # }
6037 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6038 # if ($perl_version_ok &&
6039 # defined $stat &&
6040 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6041 # WARN("PREFER_ETHER_ADDR_EQUAL",
6042 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6043 # }
6045 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6046 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6047 # if ($perl_version_ok &&
6048 # defined $stat &&
6049 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6050 #
6051 # my $ms_val = $7;
6052 #
6053 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6054 # if (WARN("PREFER_ETH_ZERO_ADDR",
6055 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6056 # $fix) {
6057 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6058 # }
6059 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6060 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6061 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6062 # $fix) {
6063 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6064 # }
6065 # }
6066 # }
6068 # typecasts on min/max could be min_t/max_t
6086 }
6089 }
6090 }
6092 # check usleep_range arguments
6100 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
6104 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
6105 }
6106 }
6108 # check for naked sscanf
6120 }
6122 # check for simple sscanf that should be kstrto<foo>
6136 }
6137 }
6138 }
6140 # check for new externs in .h files.
6147 }
6148 }
6150 # check for new externs in .c files.
6153 {
6160 }
6163 {
6166 }
6171 }
6175 {
6178 }
6180 # check for function declarations that have arguments without identifier names
6182 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6190 }
6191 }
6192 }
6194 # check for function definitions
6200 # check for multiline function definition with misplaced open brace
6210 }
6214 }
6215 }
6217 # checks for new __setup's
6223 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6224 }
6225 }
6227 # check for pointless casting of alloc functions
6230 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6231 }
6233 # alloc style
6234 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6236 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6239 }
6241 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6244 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6255 }
6265 $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;
6266 }
6267 }
6268 }
6270 # check for krealloc arg reuse
6276 }
6278 # check for alloc argument mismatch
6282 }
6284 # check for multiple semicolons
6290 }
6291 }
6293 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6302 }
6303 }
6305 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6306 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6312 }
6313 }
6315 # check for case / default statements not preceded by break/fallthrough/switch
6332 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6333 }
6337 }
6338 }
6340 # check for switch/default statements without a break;
6349 }
6351 # check for gcc specific __FUNCTION__
6357 }
6358 }
6360 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6364 }
6366 # check for use of yield()
6370 }
6372 # check for comparisons against true and false
6388 }
6393 ## maybe suggesting a correct construct would better
6394 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6396 }
6397 }
6399 # check for semaphores initialized locked
6403 }
6405 # recommend kstrto* over simple_strto* and strict_strto*
6409 }
6411 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6414 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6415 }
6417 # check for spin_is_locked(), suggest lockdep instead
6420 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6421 }
6423 # check for deprecated apis
6429 }
6431 # check for various structs that are normally const (ops, kgdb, device_tree)
6432 # and avoid what seem like struct definitions 'struct foo {'
6437 }
6439 # use of NR_CPUS is usually wrong
6440 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6447 {
6449 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6450 }
6452 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6456 }
6458 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6463 }
6465 # whine mightly about in_atomic
6473 }
6474 }
6476 # check for mutex_trylock_recursive usage
6480 }
6482 # check for lockdep_set_novalidate_class
6490 }
6491 }
6496 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6497 }
6499 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6500 # and whether or not function naming is typical and if
6501 # DEVICE_ATTR permissions uses are unusual too
6504 $stat =~ /\bDEVICE_ATTR\s*\(\s*(\w+)\s*,\s*\(?\s*(\s*(?:${multi_mode_perms_string_search}|0[0-7]{3,3})\s*)\s*\)?\s*,\s*(\w+)\s*,\s*(\w+)\s*\)/) {
6516 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6517 }
6524 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6525 }
6532 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6533 }
6544 }
6547 }
6553 }
6554 }
6556 # Mode permission misuses where it seems decimal should be octal
6557 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6558 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6559 # specific definition of not visible in sysfs.
6560 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6561 # use the default permissions
6577 }
6587 }
6590 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6591 }
6592 }
6593 }
6594 }
6596 # check for uses of S_<PERMS> that could be octal for readability
6601 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6604 }
6605 }
6607 # validate content of MODULE_LICENSE against list from include/linux/module.h
6611 GPL|
6612 GPL\ v2|
6617 Proprietary
6622 }
6623 }
6624 }
6626 # If we have no input at all, then there is nothing to report on
6627 # so just keep quiet.
6630 }
6632 # In mailback mode only produce a report in the negative, for
6633 # things that appear to be patches.
6636 }
6638 # This is not a patch, and we are are in 'no-patch' mode so
6639 # just keep quiet.
6642 }
6647 }
6655 }
6656 }
6664 }
6667 # If there were any defects found and not already fixing them
6673 EOM
6674 }
6675 # If there were whitespace errors which cleanpatch can fix
6676 # then suggest that.
6683 EOM
6684 }
6685 }
6705 }
6708 }
6709 }
6717 Do _NOT_ trust the results written to this file.
6720 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6722 EOM
6723 }
6724 }
6732 }
6733 }
6735 }