| blob | 4c820607540bf646f8defa5417876a987c1bc74d |
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>
65 # git output parsing needs US English output, so first set backtick child process LANGUAGE
76 Options:
81 --emacs emacs compile window format
82 --terse one line per report
85 single git commit with:
89 multiple git commits with:
93 git merges are ignored
111 is all off)
113 literally
116 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
117 with potential errors corrected to the preferred
118 checkpatch style
123 runtime errors.
126 --codespellfile Use this codespell dictionary
127 --typedefsfile Read additional types from this file
133 EOM
136 }
141 }
157 # Also catch when type or level is passed through a variable
158 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
160 }
165 }
168 }
190 }
191 }
194 }
196 # Perl's Getopt::Long allows options to take optional arguments after a space.
197 # Prevent --color by itself from consuming other arguments
201 }
202 }
204 GetOptions(
258 }
260 #if no filenames are given, push '-' to read patch from stdin
263 }
275 }
277 # skip TAB size 1 to avoid additional checks on $tabsize - 1
294 }
295 }
304 }
306 }
307 }
317 ## no critic
320 }
327 }
333 }
340 }
341 }
346 }
347 }
357 __user|
358 __kernel|
359 __force|
360 __iomem|
361 __must_check|
362 __kprobes|
363 __ref|
364 __refconst|
365 __refdata|
366 __rcu|
367 __private
375 # Notes to $Attribute:
376 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
378 const|
379 __percpu|
380 __nocast|
381 __safe|
382 __bitwise|
383 __packed__|
384 __packed2__|
385 __naked|
386 __maybe_unused|
387 __always_unused|
388 __noreturn|
389 __used|
390 __cold|
391 __pure|
392 __noclone|
393 __deprecated|
394 __read_mostly|
395 __ro_after_init|
396 __kprobes|
398 ____cacheline_aligned|
399 ____cacheline_aligned_in_smp|
400 ____cacheline_internodealigned_in_smp|
401 __weak
423 <=|>=|==|!=|
424 =>|->|<<|>>|<|>|!|~|
458 )};
461 atomic_t
462 )};
467 )};
473 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
474 TP_printk|
476 panic|
479 )};
487 # dev_alloc_skb/netdev_alloc_skb, et al
488 dma_alloc_coherent
489 )};
499 To:|
500 Cc:
501 )};
520 );
543 );
564 )};
571 );
575 );
582 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
589 );
591 #Create a search pattern for all these functions to speed up a loop below
596 }
610 );
612 #Create a search pattern for all these strings to speed up a loop below
617 }
621 S_IWUGO |
622 S_IWOTH |
623 S_IRWXUGO |
624 S_IALLUGO |
645 );
647 #Create a search pattern for all these strings to speed up a loop below
652 }
679 }
683 }
686 irq|
687 memory|
689 reboot
690 )};
691 # memory.h: ARM has a custom one
693 # Load common spelling mistakes and build regular expression list.
710 }
714 }
733 }
737 }
738 }
757 }
761 }
764 }
767 }
777 }
796 )
803 )
812 )
816 $NonptrType
821 $NonptrTypeMisordered
827 }
828 build_types();
832 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
833 # requires at least perl version v5.10.0
834 # Any use must be runtime checked with $^V
845 )};
854 }
859 }
883 }
884 }
885 }
895 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
896 }
899 }
904 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
910 }
923 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
934 }
936 }
944 }
948 }
953 }
957 }
965 }
967 }
968 }
982 # Maybe one day convert this block of bash into something that returns
983 # all matching commit ids, but it's very slow...
984 #
985 # echo "checking commits $1..."
986 # git rev-list --remotes | grep -i "^$1" |
987 # while read line ; do
988 # git log --format='%H %s' -1 $line |
989 # echo "commit $(cut -c 1-12,41-)"
990 # done
991 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
996 }
999 }
1010 # If input is git commits, extract all commits from the commit expressions.
1011 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1024 }
1033 }
1034 }
1037 }
1054 }
1061 }
1066 }
1073 }
1077 }
1086 build_types();
1087 }
1098 EOM
1099 }
1105 EOM
1106 }
1107 }
1118 );
1123 }
1124 }
1126 }
1150 # If there's a name left after stripping spaces and
1151 # leading quotes, and the address doesn't have both
1152 # leading and trailing angle brackets, the address
1153 # is invalid. ie:
1154 # "joe smith joe@smith.com" bad
1155 # "joe smith <joe@smith.com" bad
1160 }
1161 }
1168 }
1175 }
1178 }
1192 }
1198 }
1201 }
1208 }
1218 }
1226 }
1227 }
1230 }
1238 }
1239 }
1242 }
1255 }
1257 }
1260 }
1263 }
1267 }
1272 # Drop the diff line leader and expand tabs
1276 # Pick the indent from the front of the line.
1280 }
1291 }
1292 }
1303 # Always copy over the diff marker.
1309 # Comments we are whacking completely including the begin
1310 # and end, all to $;.
1317 }
1323 }
1330 }
1332 # A \ in a string means ignore the next character.
1338 }
1339 # Regular quotes.
1348 }
1349 }
1351 #print "c<$c> SQ<$sanitise_quote>\n";
1360 }
1361 }
1365 }
1367 # The pathname on a #include may be surrounded by '<' and '>'.
1372 # The whole of a #error is a string.
1376 }
1381 }
1384 }
1392 }
1415 #warn "CSB: blk<$blk> remain<$remain>\n";
1416 # If we are about to drop off the end, pull in more
1417 # context.
1428 }
1429 # Bail if there is no further context.
1430 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1433 }
1437 }
1438 }
1443 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1445 # Handle nested #if/#else.
1452 }
1454 # Statement ends at the ';' or a close '}' at the
1455 # outermost level.
1458 }
1460 # An else is really a conditional as long as its not else if
1467 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1468 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1469 }
1474 }
1482 #warn "CSB: mark coff<$coff>\n";
1483 }
1484 }
1488 }
1496 }
1498 }
1499 }
1500 # Preprocessor commands end at the newline unless escaped.
1506 }
1508 }
1509 # We are truly at the end, so shuffle to the next line.
1514 }
1519 #warn "STATEMENT<$statement>\n";
1520 #warn "CONDITION<$condition>\n";
1522 #print "coff<$coff> soff<$off> loff<$loff>\n";
1526 }
1531 # Strip the diff line prefixes and rip blank lines at start and end.
1539 }
1547 }
1568 }
1569 }
1577 # Grab the first conditional/block pair.
1580 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1584 }
1586 # Pull in the following conditional/block pairs and see if they
1587 # could continue the statement.
1591 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1593 #print "C: push\n";
1595 }
1598 }
1617 # Handle nested #if/#else.
1624 }
1627 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1631 }
1638 }
1639 }
1643 }
1646 }
1649 }
1655 }
1661 }
1667 }
1672 }
1677 }
1682 # If c99 comment on the current line, or the line before or after
1690 # Catch a comment on the end of the line itself.
1694 # Look through the context and try and figure out if there is a
1695 # comment.
1700 #warn " $line\n";
1703 }
1706 }
1709 }
1713 }
1714 }
1718 }
1723 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1724 ##print "CMMT: $cmt\n";
1727 }
1740 }
1743 }
1751 }
1754 }
1762 }
1765 }
1777 }
1778 }
1782 }
1794 }
1814 }
1835 }
1864 # Assume all arms of the conditional end as this
1865 # one does, and continue as if the #endif was not here.
1882 }
1913 }
1925 }
1958 }
1973 }
1982 }
1986 }
1990 }
1991 }
1994 }
2003 DEFINE_\S+
2004 )$|
2008 case|
2012 \#|
2013 \#\#|
2019 # Check for modifiers.
2030 }
2031 }
2036 }
2037 build_types();
2040 }
2041 }
2053 }
2061 }
2070 }
2071 }
2076 }
2084 }
2090 }
2094 }
2105 }
2106 }
2133 }
2139 }
2146 }
2151 }
2154 }
2157 }
2165 };
2167 }
2175 };
2178 }
2187 }
2189 }
2197 }
2199 }
2207 }
2209 }
2215 ##print "absolute<$absolute>\n";
2217 # See if any suffix of this path is a path within the tree.
2220 ##print "file<$file>\n";
2222 }
2223 }
2226 }
2228 # It is, so see if the prefix is acceptable.
2232 ##print "prefix<$prefix>\n";
2236 }
2237 }
2245 }
2253 }
2261 }
2269 }
2278 #convert leading spaces to tabs
2280 #Remove spaces before a tab
2284 }
2298 }
2310 }
2311 }
2314 }
2323 }
2324 }
2327 }
2369 # Trace the real file/line as we go.
2382 # suppression flags
2390 # Pre-scan the patch sanitizing the lines.
2391 # Pre-scan the patch looking for any __setup documentation.
2392 #
2400 sanitise_line_reset();
2412 }
2413 #next;
2414 }
2421 }
2424 # Guestimate if this is a continuing comment. Run
2425 # the context looking for a comment "edge". If this
2426 # edge is a close comment then we must be in a comment
2427 # at context start.
2434 #print "RAW<$rawlines[$ln - 1]>\n";
2440 }
2441 }
2444 }
2446 # Guestimate if this is a continuing comment. If this
2447 # is the start of a diff block and this line starts
2448 # ' *' then it is very likely a comment.
2451 {
2453 }
2455 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2459 # Standardise the strings and chars within the input to
2460 # simplify matching -- only bother with positive lines.
2462 }
2469 }
2471 #print "==>$rawline\n";
2472 #print "-->$line\n";
2476 }
2477 }
2493 # check if it's a mode change, rename or start of a patch
2499 }
2501 #extract the line range in the file after the patch is applied
2512 }
2513 annotate_reset();
2524 }
2527 # track the line number as we move through the hunk, note that
2528 # new versions of GNU diff omit the leading space on completely
2529 # blank context lines so we need to count that too.
2534 # Measure the line length and indent.
2537 # Track the previous line.
2542 #warn "line<$line>\n";
2546 }
2554 # extract the filename as it passes
2570 }
2574 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2575 }
2577 }
2579 #make up the handle for any error we report on this line
2587 }
2588 }
2593 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2594 }
2599 }
2610 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
2611 }
2612 }
2615 }
2625 # Verify the existence of a commit log if appropriate
2626 # 2 is used because a $signature is counted in $commit_log_lines
2630 }
2635 }
2637 # Check if the commit log has what seems like a diff which can confuse patch
2646 }
2648 # Check for incorrect file permissions
2655 }
2656 }
2658 # Check the patch for a From:
2664 }
2666 # Check the patch for a signoff:
2673 }
2674 }
2675 }
2677 # Check for patch separator
2681 }
2683 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2684 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2687 }
2689 # Check signature styles
2701 }
2708 }
2709 }
2716 }
2718 }
2725 }
2726 }
2737 # Don't force email to have quotes
2738 # Allow just an angle bracketed address
2742 }
2743 }
2745 # Check for duplicate signatures
2754 }
2756 # Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2760 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2761 }
2767 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2770 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2771 }
2772 }
2773 }
2775 # Check email subject for common tools that don't need to be mentioned
2780 }
2782 # Check for Gerrit Change-Ids not in any patch context
2786 }
2788 # Check if the commit log is in a possible stack dump
2792 # timestamp
2796 # stack dump address styles
2798 }
2800 # Check for line lengths > 75 in commit log, warn once
2804 # file delta changes
2806 # filename then :
2808 # A Fixes: or Link: line
2813 }
2815 # Reset possible stack dump if a blank line is found
2819 }
2821 # Check for git id commit length and improperly formed commit descriptions
2846 }
2868 }
2876 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2877 }
2878 }
2880 # Check for added, moved or deleted files
2890 }
2892 # Check for adding new DT bindings not in schema format
2897 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
2898 }
2900 # Check for wrappage within a valid hunk of the file
2905 }
2907 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2918 }
2920 # Check if it's the start of a commit log
2921 # (not a header line and we haven't seen the patch filename)
2928 }
2930 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2931 # declined it, i.e defined some charset where it is missing.
2936 }
2942 }
2944 # Check for absolute kernel paths in commit message
2951 #
2954 }
2955 }
2956 }
2958 # Check for various typo / spelling mistakes
2972 }
2973 }
2974 }
2976 # check for invalid commit id
2984 }
2985 }
2987 # ignore non-hunk lines and lines being removed
2990 #trailing whitespace
2997 }
3004 }
3007 }
3009 # Check for FSF mailing addresses.
3018 "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)
3019 }
3021 # check for Kconfig help text having a real description
3022 # Only applies when adding the entry originally, after that we do not have
3023 # sufficient context to determine whether it is indeed long enough.
3025 # 'choice' is usually the last thing on the line (though
3026 # Kconfig supports named choices), so use a word boundary
3027 # (\b) rather than a whitespace character (\s)
3049 }
3051 }
3058 # This only checks context lines in the patch
3059 # and so hopefully shouldn't trigger false
3060 # positives, even though some of these are
3061 # common words in help texts
3066 }
3068 }
3072 }
3073 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3074 }
3076 # check MAINTAINERS entries
3078 # check MAINTAINERS entries for the right form
3085 }
3086 }
3087 # check MAINTAINERS entries for the right ordering too
3111 }
3112 }
3113 }
3114 }
3116 # discourage the use of boolean for type definition attributes of Kconfig options
3121 }
3131 };
3134 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3135 }
3137 # check for DT compatible documentation
3156 }
3163 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3164 }
3165 }
3166 }
3168 # check for using SPDX license tag at beginning of files
3182 }
3184 # check SPDX comment style for .[chsS] files
3190 }
3201 }
3210 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3211 }
3212 }
3213 }
3214 }
3215 }
3217 # check we are in a valid source file if not then ignore this hunk
3220 # check for using SPDX-License-Identifier on the wrong line number
3226 }
3228 # line length limit (with some exclusions)
3229 #
3230 # There are a few types of lines that may extend beyond $max_line_length:
3231 # logging functions like pr_info that end in a string
3232 # lines with a single string
3233 # #defines that are a single string
3234 # lines with an RFC3986 like URL
3235 #
3236 # There are 3 different line length message types:
3237 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3238 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3239 # LONG_LINE all other lines longer than $max_line_length
3240 #
3241 # if LONG_LINE is ignored, the other 2 types are also ignored
3242 #
3247 # Check the allowed long line types first
3249 # logging functions that end in a string that starts
3250 # before $max_line_length
3251 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3255 # lines with only strings (w/ possible termination)
3256 # #defines with only strings
3261 # More special cases
3266 # URL ($rawline is used in case the URL is in a comment)
3270 # Otherwise set the alternate message types
3272 # a comment starts before $max_line_length
3277 # a quoted string starts before $max_line_length
3281 }
3289 }
3290 }
3292 # check for adding lines without a newline.
3293 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3296 }
3298 # check we are in a valid source file C or perl if not then ignore this hunk
3301 # at the beginning of a line any tabs must come first and anything
3302 # more than $tabsize must use tabs.
3311 }
3312 }
3314 # check for space before tabs.
3324 }
3325 }
3327 # check for assignments on the start of a line
3331 }
3333 # check for && or || at the start of a line
3337 }
3339 # check indentation starts on a tab stop
3341 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3348 }
3349 }
3350 }
3352 # check multi-line statement indentation matches previous line
3354 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3377 }
3378 }
3379 }
3380 }
3382 # check for space after cast like "(int) foo" or "(struct foo) bar"
3383 # avoid checking a few false positives:
3384 # "sizeof(<type>)" or "__alignof__(<type>)"
3385 # function pointer declarations like "(*foo)(int) = bar;"
3386 # structure definitions like "(struct foo) { 0 };"
3387 # multiline macros that define functions
3388 # known attributes or the __attribute__ keyword
3396 }
3397 }
3399 # Block comment styles
3400 # Networking with an initial /*
3407 }
3409 # Block comments use * on subsequent lines
3417 }
3419 # Block comments use */ on trailing lines
3426 }
3428 # Block comment * alignment
3442 }
3449 }
3450 }
3452 # check for missing blank lines after struct/union declarations
3453 # with exceptions for various attributes and macros
3469 }
3470 }
3472 # check for multiple consecutive blank lines
3480 }
3483 }
3485 # check for missing blank lines after declarations
3487 # actual declarations
3489 # function pointer declarations
3491 # foo bar; where foo is some local typedef or #define
3493 # known declaration macros
3495 # for "else if" which can look like "$Ident $Ident"
3497 # other possible extensions of declaration lines
3499 # not starting a section or a macro "\" extended line
3501 # looks like a declaration
3503 # function pointer declarations
3505 # foo bar; where foo is some local typedef or #define
3507 # known declaration macros
3509 # start of struct or union or enum
3511 # start or end of block or continuation of declaration
3513 # bitfield continuation
3515 # other possible extensions of declaration lines
3517 # indentation of previous and current line are the same
3523 }
3524 }
3526 # check for spaces at the beginning of a line.
3527 # Exceptions:
3528 # 1) within comments
3529 # 2) indented preprocessor commands
3530 # 3) hanging labels
3537 }
3538 }
3540 # check we are in a valid C source file if not then ignore this hunk
3543 # check for unusual line ending [ or (
3547 }
3549 # check if this appears to be the start function declaration, save the name
3553 }
3555 # check if this appears to be the end of function declaration
3558 }
3560 # check indentation of any line with a bare else
3561 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3562 # if the previous line is a break or return and is indented 1 tab more...
3571 }
3572 }
3574 # check indentation of a line with a break;
3575 # if the previous line is a goto or return and is indented the same # of tabs
3581 }
3582 }
3584 # check for RCS/CVS revision markers
3588 }
3590 # check for old HOTPLUG __dev<foo> section markings
3594 }
3596 # Check for potential 'bare' types
3599 #print "LINE<$line>\n";
3607 #print "linenr<$linenr> <$stat>\n";
3608 # If this statement has no statement boundaries within
3609 # it there is no point in retrying a statement scan
3610 # until we hit end of it.
3613 #print "skip<$line_nr_next>\n";
3615 }
3617 # Find the real next line.
3623 }
3628 # Ignore goto labels.
3631 # Ignore functions being called
3636 # declarations always start with types
3637 } 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) {
3642 # definitions in global scope can only start with types
3645 }
3647 # any (foo ... *) is a pointer cast, and foo is a type
3650 }
3652 # Check for any sort of function declaration.
3653 # int foo(something bar, other baz);
3654 # void (*store_gdt)(x86_descr_ptr *);
3655 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3663 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3666 }
3667 }
3668 }
3670 }
3672 #
3673 # Checks which may be anchored in the context.
3674 #
3676 # Check for switch () and associated case and default
3677 # statements should be at the same indent.
3691 }
3692 }
3696 }
3697 }
3699 # if/while/etc brace do not go on next line, unless defining a do while loop,
3700 # or if that brace on the next line is for something else
3701 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3709 }
3720 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3723 }
3725 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3726 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3732 }
3736 {
3742 }
3743 }
3744 }
3746 # Check relative indent for conditionals and blocks.
3747 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3755 # remove inline comments
3759 # Find out how long the conditional actually is.
3763 # Make sure we remove the line prefixes as we have
3764 # none on the first line, and are going to readd them
3765 # where necessary.
3769 }
3771 # We want to check the first line inside the block
3772 # starting at the end of the conditional, so remove:
3773 # 1) any blank line termination
3774 # 2) any opening brace { on end of the line
3775 # 3) any do (...) {
3782 }
3786 }
3788 # Also ignore a loop construct at the end of a
3789 # preprocessor statement.
3793 }
3800 # If we see an #else/#elif then the code
3801 # is not linear.
3804 }
3806 # Ignore:
3807 # 1) blank lines, they should be at 0,
3808 # 2) preprocessor lines, and
3809 # 3) labels.
3817 }
3818 }
3819 }
3824 # Check if either of these lines are modified, else
3825 # this is not this patch's fault.
3829 }
3832 }
3834 #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";
3843 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3844 }
3845 }
3847 # Track the 'values' across context and added lines.
3857 }
3860 #ignore lines not being added
3863 # check for dereferences that span multiple lines
3873 }
3875 # check for declarations of signed or unsigned without int
3876 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3887 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3895 }
3896 }
3897 }
3899 # TEST: allow direct testing of the type matcher.
3907 }
3909 }
3910 # TEST: allow direct testing of the attribute matcher.
3918 }
3920 }
3922 # check for initialisation to aggregates open brace on the next line
3936 }
3937 }
3939 #
3940 # Checks which are anchored on the added line.
3941 #
3943 # check for malformed paths in #include statements (uses RAW line)
3949 }
3953 }
3954 }
3956 # no C99 // comments
3965 }
3966 }
3967 }
3968 # Remove C99 comments.
3972 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3973 # the whole statement.
3974 #print "APW <$lines[$realline_next - 1]>\n";
3980 # Handle definitions which produce identifiers with
3981 # a prefix:
3982 # XXX(foo);
3983 # EXPORT_SYMBOL(something_foo);
3987 #print "FOO C name<$name>\n";
3998 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4002 }
4003 }
4008 #print "FOO B <$lines[$linenr - 1]>\n";
4010 }
4015 }
4017 # check for global initialisers.
4023 }
4024 }
4025 # check for static initialisers.
4032 }
4033 }
4035 # check for misordered declarations of char/short/int/long with signed/unsigned
4039 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4040 }
4042 # check for unnecessary <signed> int declarations of short/long/long long
4059 }
4060 }
4062 # check for static const char * arrays.
4067 }
4069 # check for initialized const char arrays that should be static const
4070 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4075 }
4076 }
4078 # check for static char foo[] = "bar" declarations.
4083 }
4085 # check for const <foo> const where <foo> is not a pointer or array type
4094 }
4095 }
4097 # check for non-global char *foo[] = {"bar", ...} declarations.
4102 }
4104 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4107 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4113 }
4114 }
4115 }
4117 # check for function declarations without arguments like "int foo()"
4123 }
4124 }
4126 # check for new typedefs, only function parameters and sparse annotations
4127 # make sense.
4135 }
4137 # * goes on variable not on type
4138 # (char*[ const])
4140 #print "AA<$1>\n";
4143 # Should start with a space.
4145 # Should not end with a space.
4147 # '*'s should not have spaces between.
4149 }
4151 ## print "1: from<$from> to<$to> ident<$ident>\n";
4161 }
4162 }
4163 }
4165 #print "BB<$1>\n";
4168 # Should start with a space.
4170 # Should not end with a space.
4172 # '*'s should not have spaces between.
4174 }
4175 # Modifiers should have spaces.
4178 ## print "2: from<$from> to<$to> ident<$ident>\n";
4189 }
4190 }
4191 }
4193 # avoid BUG() or BUG_ON()
4198 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4199 }
4201 # avoid LINUX_VERSION_CODE
4204 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4205 }
4207 # check for uses of printk_ratelimit
4211 }
4213 # printk should use KERN_* levels
4217 }
4226 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
4227 }
4236 }
4238 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4239 # number of false positives, but assembly files are not checked, so at
4240 # least the arch entry code will not trigger this warning.
4244 }
4246 # ENOTSUPP is not a standard error code and should be avoided in new patches.
4247 # Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4248 # Similarly to ENOSYS warning a small number of false positives is expected.
4254 }
4255 }
4257 # function brace can't be on same line, except for #defines of do while,
4258 # or if closed on same line
4275 }
4276 }
4277 }
4279 # open braces for enum, union and struct go on the same line.
4293 }
4294 }
4295 }
4297 # missing space after union, struct or enum definition
4304 }
4305 }
4307 # Function pointer declarations
4308 # check spacing between type, funcptr, and args
4309 # canonical declaration is "type (*funcptr)(args...)"
4318 # the $Declare variable will capture all spaces after the type
4319 # so check it for a missing trailing missing space but pointer return types
4320 # don't need a space so don't warn for those.
4325 }
4330 }
4332 # unnecessary space "type (*funcptr)(args...)"
4333 # This test is not currently implemented because these declarations are
4334 # equivalent to
4335 # int foo(int bar, ...)
4336 # and this is form shouldn't/doesn't generate a checkpatch warning.
4337 #
4338 # elsif ($declare =~ /\s{2,}$/) {
4339 # WARN("SPACING",
4340 # "Multiple spaces after return type\n" . $herecurr);
4341 # }
4343 # unnecessary space "type ( *funcptr)(args...)"
4348 }
4350 # unnecessary space "type (* funcptr)(args...)"
4355 }
4357 # unnecessary space "type (*funcptr )(args...)"
4362 }
4364 # unnecessary space "type (*funcptr) (args...)"
4369 }
4373 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4374 }
4375 }
4377 # check for spacing round square brackets; allowed:
4378 # 1. with a type on the left -- int [] a;
4379 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4380 # 3. inside a curly brace -- = { [0...10] = 5 }
4391 }
4392 }
4393 }
4395 # check for spaces between functions and their parentheses.
4401 # Ignore those directives where spaces _are_ permitted.
4407 {
4408 # cpp #define statements have non-optional spaces, ie
4409 # if there is a space between the name and the open
4410 # parenthesis it is simply not a parameter group.
4413 # cpp #elif statement condition may start with a (
4416 # If this whole things ends with a type its most
4417 # likely a typedef for a function.
4426 }
4427 }
4428 }
4430 # Check operator spacing.
4436 <<=|>>=|<=|>=|==|!=|
4438 =>|->|<<|>>|<|>|=|!|~|
4444 ## print("element count: <" . $#elements . ">\n");
4445 ## foreach my $el (@elements) {
4446 ## print("el: <$el>\n");
4447 ## }
4455 }
4466 ## print("n: <$n> good: <$good>\n");
4470 # Pick up the preceding and succeeding characters.
4475 }
4498 }
4507 # Pull out the value of this operator.
4510 # Get the full operator variant.
4513 # Ignore operators passed as parameters.
4517 # # Ignore comments
4518 # } elsif ($op =~ /^$;+$/) {
4520 # ; should have either the end of line or a space or \ after it
4528 }
4529 }
4531 # // is a comment
4534 # : when part of a bitfield
4536 # skip the bitfield test for now
4538 # No spaces for:
4539 # ->
4547 }
4549 }
4550 }
4552 # , must not have a space before and must have a space on the right.
4561 }
4562 }
4569 }
4570 }
4576 }
4579 }
4580 }
4582 # '*' as part of a type definition -- reported already.
4584 #warn "'*' is part of type\n";
4586 # unary operators should have a space before and
4587 # none after. May be left adjacent to another
4588 # unary operator, or a cast
4598 }
4599 }
4600 }
4602 # A unary '*' may be const
4610 }
4612 }
4613 }
4615 # unary ++ and unary -- are allowed no space on one side.
4622 }
4623 }
4630 }
4631 }
4638 }
4640 }
4641 }
4643 # << and >> may either have or not have spaces both sides
4649 {
4657 }
4663 }
4664 }
4671 }
4673 }
4674 }
4676 # A colon needs no spaces before when it is
4677 # terminating a case value or a label.
4684 }
4685 }
4687 # All the others need spaces both sides.
4691 # Ignore email addresses <foo@bar>
4696 {
4698 }
4700 # for asm volatile statements
4701 # ignore a colon with another
4702 # colon immediately before or after
4706 }
4708 # messages are ERROR, but ?: are CHK
4718 }
4720 }
4721 }
4722 }
4725 ## print("n: <$n> GOOD: <$good>\n");
4728 }
4732 }
4736 }
4739 }
4741 # check for whitespace before a non-naked semicolon
4748 }
4749 }
4751 # check for multiple assignments
4755 }
4757 ## # check for multiple declarations, allowing for a function declaration
4758 ## # continuation.
4759 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4760 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4761 ##
4762 ## # Remove any bracketed sections to ensure we do not
4763 ## # falsly report the parameters of functions.
4764 ## my $ln = $line;
4765 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4766 ## }
4767 ## if ($ln =~ /,/) {
4768 ## WARN("MULTIPLE_DECLARATION",
4769 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4770 ## }
4771 ## }
4773 #need space before brace following if, while, etc
4780 }
4781 }
4783 ## # check for blank lines before declarations
4784 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4785 ## $prevrawline =~ /^.\s*$/) {
4786 ## WARN("SPACING",
4787 ## "No blank lines before declarations\n" . $hereprev);
4788 ## }
4789 ##
4791 # closing brace should have a space following it when it has anything
4792 # on the line
4799 }
4800 }
4802 # check spacing on square brackets
4809 }
4810 }
4817 }
4818 }
4820 # check spacing on parentheses
4828 }
4829 }
4838 }
4839 }
4841 # check unnecessary parentheses around addressof/dereference single $Lvals
4842 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4850 }
4851 }
4853 # check for unnecessary parentheses around function pointer uses
4854 # ie: (foo->bar)(); should be foo->bar();
4855 # but not "if (foo->bar) (" to avoid some false positives
4864 }
4865 }
4867 # check for unnecessary parentheses around comparisons in if uses
4868 # when !drivers/staging or command-line uses --strict
4875 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4877 # avoid parentheses around potential macro args
4886 }
4887 }
4890 }
4891 }
4893 #goto labels aren't indented, allow a single space however
4901 }
4902 }
4904 # return is not a function
4914 }
4918 }
4919 }
4921 # unnecessary return in a void function
4922 # at end-of-function, with the previous line a single leading tab, then return;
4923 # and the line before that not a goto label target like "out:"
4931 }
4933 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4939 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4944 }
4945 }
4947 # comparisons with a constant or upper case identifier on the left
4948 # avoid cases like "foo + BAR < baz"
4949 # only fix matches surrounded by parentheses to avoid incorrect
4950 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4971 }
4973 }
4974 }
4976 # Return of what appears to be an errno should normally be negative
4982 }
4983 }
4985 # Need a space before open parenthesis after if, while etc
4992 }
4993 }
4995 # Check for illegal assignment in if conditional -- and check for trailing
4996 # statements after the conditional.
5004 ##print "stat<$stat> stat_next<$stat_next>\n";
5007 # If the statement carries leading newlines,
5008 # then count those as offsets.
5016 }
5017 }
5026 }
5028 # Find out what is on the end of the line after the
5029 # conditional.
5035 {
5036 # Find out how long the conditional actually is.
5045 }
5049 }
5050 }
5052 # Check for bitwise tests written as boolean
5058 |
5063 {
5066 }
5068 # if and else should not have general statements after it
5075 }
5076 }
5077 # if should not continue a brace
5082 }
5083 # case and default should not have general statements after them
5089 {
5092 }
5094 # Check for }<nl>else {, these must be at the same
5095 # indent level to be relevant to each other.
5107 }
5111 }
5112 }
5118 # Find out what is on the end of the line after the
5119 # conditional.
5135 }
5136 }
5137 }
5139 #Specific variable tests
5143 #CamelCase
5146 #Ignore Page<foo> variants
5148 #Ignore SI style variants like nS, mV and dB
5149 #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5151 #Ignore some three character SI units explicitly, like MiB and KHz
5157 seed_camelcase_includes();
5161 }
5162 }
5167 }
5168 }
5169 }
5170 }
5172 #no spaces allowed after \ in define
5178 }
5179 }
5181 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5182 # itself <asm/foo.h> (uses RAW line)
5189 {
5198 }
5199 }
5200 }
5201 }
5203 # multi-statement macros should be enclosed in a do while loop, grab the
5204 # first statement and ensure its the whole macro if its not enclosed
5205 # in a known good container
5217 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5218 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5233 }
5240 # Flatten any parentheses and braces
5244 {
5245 }
5247 # Flatten any obvious string concatenation.
5250 {
5251 }
5253 # Make asm volatile uses seem like a generic function
5258 module_param_named|
5259 MODULE_PARM_DESC|
5260 DECLARE_PER_CPU|
5261 DEFINE_PER_CPU|
5262 __typeof__\(|
5263 union|
5264 struct|
5269 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5278 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5283 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5289 {
5292 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5299 }
5301 }
5303 # Make $define_stmt single line, comment-free, etc
5314 }
5315 }
5320 # check if any macro arguments are reused (ignore '...' and 'type')
5325 $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5332 }
5333 # check if any macro arguments may have other precedence issues
5339 }
5340 }
5342 # check for macros with flow control, but without ## concatenation
5343 # ## concatenation is commonly a macro that defines a function so ignore those
5350 }
5352 # check for line continuations outside of #defines, preprocessor #, and asm
5361 }
5362 }
5364 # do {} while (0) macro tests:
5365 # single-statement macros do not need to be enclosed in do while (0) loop,
5366 # macro should not end with a semicolon
5381 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5393 }
5397 }
5405 }
5406 }
5408 # check for redundant bracing round if etc
5412 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5413 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5423 # If the condition carries leading newlines, then count those as offsets.
5428 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5430 # We have looked at and allowed this specific line.
5440 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5442 #print "APW: ALLOWED: cond<$cond>\n";
5444 }
5446 #print "APW: ALLOWED: block<$block>\n";
5448 }
5450 #print "APW: ALLOWED: lines block<$block>\n";
5452 }
5454 }
5459 }
5467 }
5468 }
5469 }
5470 }
5475 # Check the pre-context.
5477 #print "APW: ALLOWED: pre<$1>\n";
5479 }
5484 # Check the condition.
5486 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5489 }
5491 #print "APW: ALLOWED: cond<$cond>\n";
5493 }
5495 #print "APW: ALLOWED: block<$block>\n";
5497 }
5499 #print "APW: ALLOWED: lines block<$block>\n";
5501 }
5502 # Check the post-context.
5507 }
5509 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5511 }
5512 }
5519 }
5520 }
5522 # check for single line unbalanced braces
5526 }
5528 # check for unnecessary blank lines around braces
5534 }
5535 }
5541 }
5542 }
5544 # no volatiles please
5548 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5549 }
5551 # Check for user-visible strings broken across lines, which breaks the ability
5552 # to grep for the string. Make exceptions when the previous string ends in a
5553 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5554 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5567 }
5579 }
5581 }
5582 }
5584 # check for missing a space in a string concatenation
5588 }
5590 # check for an embedded function name in a string when the function is known
5591 # This does not work very well for -f --file checking as it depends on patch
5592 # context providing the function name or a single line form for in-file
5593 # function declarations
5599 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5600 }
5602 # check for spaces before a quoted newline
5608 }
5610 }
5612 # concatenated string without spaces between elements
5621 }
5622 }
5623 }
5625 # uncoalesced string fragments
5633 }
5634 }
5635 }
5637 # check for non-standard and hex prefixed decimal printf formats
5643 # check for %L
5648 }
5649 # check for %Z
5654 }
5655 # check for 0x<decimal>
5659 }
5660 }
5662 # check for line continuations in quoted strings with odd counts of "
5666 }
5668 # warn about #if 0
5672 }
5674 # warn about #if 1
5678 }
5680 # check for needless "if (<foo>) fn(<foo>)" uses
5684 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5696 }
5701 }
5704 }
5708 }
5709 }
5710 }
5711 }
5713 # check for unnecessary "Out of Memory" messages
5722 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5724 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5728 }
5729 }
5731 # check for logging functions with KERN_<LEVEL>
5739 }
5740 }
5742 # check for logging continuations
5746 }
5748 # check for mask then right shift without a parentheses
5754 }
5756 # check for pointer comparisons to NULL
5766 }
5767 }
5768 }
5770 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5773 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5783 $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;
5784 }
5785 }
5786 }
5788 # check for $InitAttributeData (ie: __initdata) with const
5799 }
5800 }
5802 # check for $InitAttributeConst (ie: __initconst) without const
5814 }
5815 }
5817 # check for __read_mostly with const non-pointer (should just be const)
5824 }
5825 }
5827 # don't use __constant_<foo> functions outside of include/uapi/
5829 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5837 }
5838 }
5840 # prefer usleep_range over udelay
5843 # ignore udelay's < 10, however
5846 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5847 }
5851 }
5852 }
5854 # warn about unexpectedly long msleep's
5858 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5859 }
5860 }
5862 # check for comparisons of jiffies
5865 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5866 }
5868 # check for comparisons of get_jiffies_64()
5871 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5872 }
5874 # warn about #ifdefs in C files
5875 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5876 # print "#ifdef in C files should be avoided\n";
5877 # print "$herecurr";
5878 # $clean = 0;
5879 # }
5881 # warn about spacing in #ifdefs
5888 }
5890 }
5892 # check for spinlock_t definitions without a comment.
5899 }
5900 }
5901 # check for memory barriers without a comment.
5904 mb|
5905 rmb|
5906 wmb|
5907 read_barrier_depends
5910 mb__before_atomic|
5911 mb__after_atomic|
5912 store_release|
5913 load_acquire|
5914 store_mb|
5927 }
5928 }
5938 }
5940 # check for waitqueue_active without a comment.
5945 }
5946 }
5948 # check for data_race without a comment.
5953 }
5954 }
5956 # check for smp_read_barrier_depends and read_barrier_depends
5960 }
5962 # check of hardware specific defines
5963 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5966 }
5968 # check that the storage class is not after a type
5972 }
5973 # Check that the storage class is at the beginning of a declaration
5980 }
5982 # check the location of the inline attribute, that it is between
5983 # storage class and type.
5988 }
5990 # Check for __inline__ and __inline, prefer inline
5998 }
5999 }
6001 # Check for __attribute__ packed, prefer __packed
6006 }
6008 # Check for __attribute__ aligned, prefer __aligned
6013 }
6015 # Check for __attribute__ section, prefer __section
6023 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
6024 }
6025 }
6027 # Check for __attribute__ format(printf, prefer __printf
6031 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
6033 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
6035 }
6036 }
6038 # Check for __attribute__ format(scanf, prefer __scanf
6042 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
6044 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
6045 }
6046 }
6048 # Check for __attribute__ weak, or __weak declarations (may have link issues)
6050 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6055 }
6057 # check for c99 types like uint8_t used outside of uapi/ and tools/
6072 }
6073 }
6074 }
6076 # check for cast of C90 native int or longer types constants
6091 }
6093 }
6094 }
6096 # check for sizeof(&)
6100 }
6102 # check for sizeof without parenthesis
6107 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6108 }
6109 }
6111 # check for struct spinlock declarations
6115 }
6117 # check for seq_printf uses that could be seq_puts
6126 }
6127 }
6128 }
6130 # check for vsprintf extension %p<foo> misuses
6156 }
6160 }
6162 "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");
6163 }
6164 }
6172 }
6176 }
6177 }
6178 }
6180 # Check for misused memsets
6195 }
6196 }
6198 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6199 # if ($perl_version_ok &&
6200 # defined $stat &&
6201 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6202 # if (WARN("PREFER_ETHER_ADDR_COPY",
6203 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6204 # $fix) {
6205 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6206 # }
6207 # }
6209 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6210 # if ($perl_version_ok &&
6211 # defined $stat &&
6212 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6213 # WARN("PREFER_ETHER_ADDR_EQUAL",
6214 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6215 # }
6217 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6218 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6219 # if ($perl_version_ok &&
6220 # defined $stat &&
6221 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6222 #
6223 # my $ms_val = $7;
6224 #
6225 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6226 # if (WARN("PREFER_ETH_ZERO_ADDR",
6227 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6228 # $fix) {
6229 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6230 # }
6231 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6232 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6233 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6234 # $fix) {
6235 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6236 # }
6237 # }
6238 # }
6240 # typecasts on min/max could be min_t/max_t
6258 }
6261 }
6262 }
6264 # check usleep_range arguments
6272 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6276 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6277 }
6278 }
6280 # check for naked sscanf
6292 }
6294 # check for simple sscanf that should be kstrto<foo>
6308 }
6309 }
6310 }
6312 # check for new externs in .h files.
6319 }
6320 }
6322 # check for new externs in .c files.
6325 {
6332 }
6335 {
6338 }
6343 }
6347 {
6350 }
6352 # check for function declarations that have arguments without identifier names
6353 # while avoiding uninitialized_var(x)
6355 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:($Ident)|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6366 }
6367 }
6368 }
6370 # check for function definitions
6376 # check for multiline function definition with misplaced open brace
6386 }
6390 }
6391 }
6393 # checks for new __setup's
6399 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
6400 }
6401 }
6403 # check for pointless casting of alloc functions
6406 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6407 }
6409 # alloc style
6410 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6412 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6415 }
6417 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6420 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6431 }
6441 $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;
6442 }
6443 }
6444 }
6446 # check for krealloc arg reuse
6452 }
6454 # check for alloc argument mismatch
6458 }
6460 # check for multiple semicolons
6466 }
6467 }
6469 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6478 }
6479 }
6481 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6482 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6488 }
6489 }
6491 # check for case / default statements not preceded by break/fallthrough/switch
6508 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6509 }
6513 }
6514 }
6516 # check for /* fallthrough */ like comment, prefer fallthrough;
6525 );
6534 }
6535 }
6536 }
6538 # check for switch/default statements without a break;
6547 }
6549 # check for gcc specific __FUNCTION__
6555 }
6556 }
6558 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6562 }
6564 # check for use of yield()
6568 }
6570 # check for comparisons against true and false
6586 }
6591 ## maybe suggesting a correct construct would better
6592 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6594 }
6595 }
6597 # check for semaphores initialized locked
6601 }
6603 # recommend kstrto* over simple_strto* and strict_strto*
6607 }
6609 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6612 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6613 }
6615 # check for spin_is_locked(), suggest lockdep instead
6618 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6619 }
6621 # check for deprecated apis
6627 }
6629 # check for various structs that are normally const (ops, kgdb, device_tree)
6630 # and avoid what seem like struct definitions 'struct foo {'
6635 }
6637 # use of NR_CPUS is usually wrong
6638 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6645 {
6647 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6648 }
6650 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6654 }
6656 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6661 }
6663 # nested likely/unlikely calls
6667 }
6669 # whine mightly about in_atomic
6677 }
6678 }
6680 # check for mutex_trylock_recursive usage
6684 }
6686 # check for lockdep_set_novalidate_class
6694 }
6695 }
6700 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6701 }
6703 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6704 # and whether or not function naming is typical and if
6705 # DEVICE_ATTR permissions uses are unusual too
6708 $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*\)/) {
6720 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6721 }
6728 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6729 }
6736 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6737 }
6748 }
6751 }
6757 }
6758 }
6760 # Mode permission misuses where it seems decimal should be octal
6761 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6762 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6763 # specific definition of not visible in sysfs.
6764 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6765 # use the default permissions
6781 }
6791 }
6794 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6795 }
6796 }
6797 }
6798 }
6800 # check for uses of S_<PERMS> that could be octal for readability
6805 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6808 }
6809 }
6811 # validate content of MODULE_LICENSE against list from include/linux/module.h
6815 GPL|
6816 GPL\ v2|
6821 Proprietary
6826 }
6827 }
6829 # check for sysctl duplicate constants
6832 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6833 }
6834 }
6836 # If we have no input at all, then there is nothing to report on
6837 # so just keep quiet.
6840 }
6842 # In mailback mode only produce a report in the negative, for
6843 # things that appear to be patches.
6846 }
6848 # This is not a patch, and we are are in 'no-patch' mode so
6849 # just keep quiet.
6852 }
6857 }
6865 }
6866 }
6874 }
6877 # If there were any defects found and not already fixing them
6883 EOM
6884 }
6885 # If there were whitespace errors which cleanpatch can fix
6886 # then suggest that.
6893 EOM
6894 }
6895 }
6915 }
6918 }
6919 }
6927 Do _NOT_ trust the results written to this file.
6930 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6932 EOM
6933 }
6934 }
6942 }
6943 }
6945 }