| blob | 92e888ed939f9833a3b17f32ae7d15813ec4c46f |
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>
67 # git output parsing needs US English output, so first set backtick child process LANGUAGE
79 Options:
84 --emacs emacs compile window format
85 --terse one line per report
88 single git commit with:
92 multiple git commits with:
96 git merges are ignored
114 is all off)
116 literally
119 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
120 with potential errors corrected to the preferred
121 checkpatch style
126 runtime errors.
129 --codespellfile Use this codespell dictionary
130 --typedefsfile Read additional types from this file
138 EOM
141 }
146 }
162 # Also catch when type or level is passed through a variable
163 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
165 }
170 }
173 }
195 }
196 }
199 }
201 # Perl's Getopt::Long allows options to take optional arguments after a space.
202 # Prevent --color by itself from consuming other arguments
206 }
207 }
209 GetOptions(
264 }
266 #if no filenames are given, push '-' to read patch from stdin
269 }
281 }
283 # skip TAB size 1 to avoid additional checks on $tabsize - 1
300 }
301 }
310 }
312 }
313 }
323 ## no critic
326 }
333 }
339 }
346 }
347 }
352 }
353 }
363 __user|
364 __kernel|
365 __force|
366 __iomem|
367 __must_check|
368 __kprobes|
369 __ref|
370 __refconst|
371 __refdata|
372 __rcu|
373 __private
381 # Notes to $Attribute:
382 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
384 const|
385 __percpu|
386 __nocast|
387 __safe|
388 __bitwise|
389 __packed__|
390 __packed2__|
391 __naked|
392 __maybe_unused|
393 __always_unused|
394 __noreturn|
395 __used|
396 __cold|
397 __pure|
398 __noclone|
399 __deprecated|
400 __read_mostly|
401 __ro_after_init|
402 __kprobes|
404 ____cacheline_aligned|
405 ____cacheline_aligned_in_smp|
406 ____cacheline_internodealigned_in_smp|
407 __weak
429 <=|>=|==|!=|
430 =>|->|<<|>>|<|>|!|~|
464 )};
467 atomic_t
468 )};
473 )};
479 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
480 TP_printk|
482 panic|
485 )};
493 # dev_alloc_skb/netdev_alloc_skb, et al
494 dma_alloc_coherent
495 )};
505 To:|
506 Cc:
507 )};
513 # if underflow, return
515 }
520 }
521 }
523 }
533 # two dimensional array storing minimum edit distance
548 }
549 }
550 }
552 }
559 );
562 }
565 }
584 );
607 );
628 )};
635 );
639 );
646 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
653 );
657 #Create a search pattern for all these functions to speed up a loop below
662 }
676 );
678 #Create a search pattern for all these strings to speed up a loop below
683 }
687 S_IWUGO |
688 S_IWOTH |
689 S_IRWXUGO |
690 S_IALLUGO |
711 );
713 #Create a search pattern for all these strings to speed up a loop below
718 }
745 }
749 }
752 irq|
753 memory|
755 reboot
756 )};
757 # memory.h: ARM has a custom one
759 # Load common spelling mistakes and build regular expression list.
776 }
780 }
799 }
803 }
804 }
823 }
827 }
830 }
833 }
839 }
846 }
864 )
871 )
880 )
884 $NonptrType
889 $NonptrTypeMisordered
895 }
896 build_types();
900 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
901 # requires at least perl version v5.10.0
902 # Any use must be runtime checked with $^V
912 )};
919 );
928 }
933 }
957 }
958 }
959 }
969 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
970 }
973 }
978 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$gitroot"));
984 }
997 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
1008 }
1010 }
1018 }
1022 }
1027 }
1031 }
1039 }
1041 }
1042 }
1052 }
1066 # Maybe one day convert this block of bash into something that returns
1067 # all matching commit ids, but it's very slow...
1068 #
1069 # echo "checking commits $1..."
1070 # git rev-list --remotes | grep -i "^$1" |
1071 # while read line ; do
1072 # git log --format='%H %s' -1 $line |
1073 # echo "commit $(cut -c 1-12,41-)"
1074 # done
1075 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
1080 }
1083 }
1094 # If input is git commits, extract all commits from the commit expressions.
1095 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1108 }
1117 }
1118 }
1121 }
1141 }
1148 }
1153 }
1160 }
1164 }
1173 build_types();
1175 }
1186 EOM
1187 }
1193 EOM
1194 }
1195 }
1206 );
1211 }
1212 }
1214 }
1239 # If there's a name left after stripping spaces and
1240 # leading quotes, and the address doesn't have both
1241 # leading and trailing angle brackets, the address
1242 # is invalid. ie:
1243 # "joe smith joe@smith.com" bad
1244 # "joe smith <joe@smith.com" bad
1249 }
1250 }
1252 # Extract comments from names excluding quoted parts
1253 # "John D. (Doe)" - Do not extract
1256 }
1259 }
1270 }
1273 }
1287 }
1298 }
1301 }
1308 }
1320 }
1328 }
1329 }
1332 }
1340 }
1341 }
1344 }
1357 }
1359 }
1362 }
1365 }
1369 }
1374 # Drop the diff line leader and expand tabs
1378 # Pick the indent from the front of the line.
1382 }
1393 }
1394 }
1405 # Always copy over the diff marker.
1411 # Comments we are whacking completely including the begin
1412 # and end, all to $;.
1419 }
1425 }
1432 }
1434 # A \ in a string means ignore the next character.
1440 }
1441 # Regular quotes.
1450 }
1451 }
1453 #print "c<$c> SQ<$sanitise_quote>\n";
1462 }
1463 }
1467 }
1469 # The pathname on a #include may be surrounded by '<' and '>'.
1474 # The whole of a #error is a string.
1478 }
1483 }
1486 }
1494 }
1517 #warn "CSB: blk<$blk> remain<$remain>\n";
1518 # If we are about to drop off the end, pull in more
1519 # context.
1530 }
1531 # Bail if there is no further context.
1532 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1535 }
1539 }
1540 }
1545 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1547 # Handle nested #if/#else.
1554 }
1556 # Statement ends at the ';' or a close '}' at the
1557 # outermost level.
1560 }
1562 # An else is really a conditional as long as its not else if
1569 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1570 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1571 }
1576 }
1584 #warn "CSB: mark coff<$coff>\n";
1585 }
1586 }
1590 }
1598 }
1600 }
1601 }
1602 # Preprocessor commands end at the newline unless escaped.
1608 }
1610 }
1611 # We are truly at the end, so shuffle to the next line.
1616 }
1621 #warn "STATEMENT<$statement>\n";
1622 #warn "CONDITION<$condition>\n";
1624 #print "coff<$coff> soff<$off> loff<$loff>\n";
1628 }
1633 # Strip the diff line prefixes and rip blank lines at start and end.
1641 }
1649 }
1670 }
1671 }
1679 # Grab the first conditional/block pair.
1682 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1686 }
1688 # Pull in the following conditional/block pairs and see if they
1689 # could continue the statement.
1693 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1695 #print "C: push\n";
1697 }
1700 }
1719 # Handle nested #if/#else.
1726 }
1729 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1733 }
1740 }
1741 }
1745 }
1748 }
1751 }
1757 }
1763 }
1769 }
1774 }
1779 }
1784 # If c99 comment on the current line, or the line before or after
1792 # Catch a comment on the end of the line itself.
1796 # Look through the context and try and figure out if there is a
1797 # comment.
1802 #warn " $line\n";
1805 }
1808 }
1811 }
1815 }
1816 }
1820 }
1825 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1826 ##print "CMMT: $cmt\n";
1829 }
1842 }
1845 }
1853 }
1856 }
1864 }
1867 }
1879 }
1880 }
1884 }
1896 }
1916 }
1937 }
1966 # Assume all arms of the conditional end as this
1967 # one does, and continue as if the #endif was not here.
1984 }
2015 }
2027 }
2060 }
2075 }
2084 }
2088 }
2092 }
2093 }
2096 }
2105 DEFINE_\S+
2106 )$|
2110 case|
2114 \#|
2115 \#\#|
2121 # Check for modifiers.
2132 }
2133 }
2138 }
2139 build_types();
2142 }
2143 }
2155 }
2163 }
2172 }
2173 }
2178 }
2186 }
2192 }
2196 }
2207 }
2208 }
2235 }
2241 }
2248 }
2253 }
2256 }
2259 }
2267 };
2269 }
2277 };
2280 }
2289 }
2291 }
2299 }
2301 }
2309 }
2311 }
2317 ##print "absolute<$absolute>\n";
2319 # See if any suffix of this path is a path within the tree.
2322 ##print "file<$file>\n";
2324 }
2325 }
2328 }
2330 # It is, so see if the prefix is acceptable.
2334 ##print "prefix<$prefix>\n";
2338 }
2339 }
2347 }
2355 }
2363 }
2371 }
2380 #convert leading spaces to tabs
2382 #Remove spaces before a tab
2386 }
2400 }
2412 }
2413 }
2416 }
2425 }
2426 }
2429 }
2472 # Trace the real file/line as we go.
2485 # suppression flags
2493 # Pre-scan the patch sanitizing the lines.
2494 # Pre-scan the patch looking for any __setup documentation.
2495 #
2503 sanitise_line_reset();
2515 }
2516 #next;
2517 }
2524 }
2527 # Guestimate if this is a continuing comment. Run
2528 # the context looking for a comment "edge". If this
2529 # edge is a close comment then we must be in a comment
2530 # at context start.
2537 #print "RAW<$rawlines[$ln - 1]>\n";
2543 }
2544 }
2547 }
2549 # Guestimate if this is a continuing comment. If this
2550 # is the start of a diff block and this line starts
2551 # ' *' then it is very likely a comment.
2554 {
2556 }
2558 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2562 # Standardise the strings and chars within the input to
2563 # simplify matching -- only bother with positive lines.
2565 }
2572 }
2574 #print "==>$rawline\n";
2575 #print "-->$line\n";
2579 }
2580 }
2596 # check if it's a mode change, rename or start of a patch
2602 }
2604 #extract the line range in the file after the patch is applied
2615 }
2616 annotate_reset();
2627 }
2630 # track the line number as we move through the hunk, note that
2631 # new versions of GNU diff omit the leading space on completely
2632 # blank context lines so we need to count that too.
2637 # Measure the line length and indent.
2640 # Track the previous line.
2645 #warn "line<$line>\n";
2649 }
2657 # extract the filename as it passes
2673 }
2677 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2678 }
2680 }
2682 #make up the handle for any error we report on this line
2690 }
2691 }
2696 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2697 }
2702 }
2713 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
2714 }
2715 }
2718 }
2728 # Verify the existence of a commit log if appropriate
2729 # 2 is used because a $signature is counted in $commit_log_lines
2733 }
2738 }
2740 # Check if the commit log has what seems like a diff which can confuse patch
2749 }
2751 # Check for incorrect file permissions
2758 }
2759 }
2761 # Check the patch for a From:
2767 }
2771 }
2773 # Check the patch for a signoff:
2800 }
2803 }
2806 }
2807 }
2808 }
2809 }
2810 }
2812 # Check for patch separator
2816 }
2818 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2819 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2822 }
2824 # Check signature styles
2843 }
2844 }
2845 }
2852 }
2853 }
2860 }
2862 }
2869 }
2870 }
2881 # Don't force email to have quotes
2882 # Allow just an angle bracketed address
2888 }
2889 }
2891 # Address part shouldn't have comments
2899 }
2900 }
2902 # Only one name comment should be allowed
2907 }
2910 # stable@vger.kernel.org or stable@kernel.org shouldn't
2911 # have an email name. In addition comments should strictly
2912 # begin with a #
2920 # Remove brackets enclosing comment text
2921 # and # from start of comments to get comment text
2934 }
2935 }
2939 # Extract comment text from within brackets or
2940 # c89 style /*...*/ comments
2945 $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo
2953 }
2954 }
2955 }
2957 # Check for duplicate signatures
2966 }
2968 # Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2972 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2973 }
2979 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2982 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2983 }
2984 }
2985 }
2987 # Check email subject for common tools that don't need to be mentioned
2992 }
2994 # Check for Gerrit Change-Ids not in any patch context
3000 }
3001 }
3003 # Check if the commit log is in a possible stack dump
3007 # timestamp
3011 # stack dump address styles
3013 }
3015 # Check for line lengths > 75 in commit log, warn once
3019 # file delta changes
3021 # filename then :
3023 # A Fixes: or Link: line or signature tag line
3028 }
3030 # Reset possible stack dump if a blank line is found
3034 }
3036 # Check for lines starting with a #
3042 }
3043 }
3045 # Check for git id commit length and improperly formed commit descriptions
3070 }
3092 }
3100 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
3101 }
3102 }
3104 # Check for added, moved or deleted files
3114 }
3116 # Check for adding new DT bindings not in schema format
3121 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
3122 }
3124 # Check for wrappage within a valid hunk of the file
3129 }
3131 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
3142 }
3144 # Check if it's the start of a commit log
3145 # (not a header line and we haven't seen the patch filename)
3152 }
3154 # Check if there is UTF-8 in a commit log when a mail header has explicitly
3155 # declined it, i.e defined some charset where it is missing.
3160 }
3166 }
3168 # Check for absolute kernel paths in commit message
3175 #
3178 }
3179 }
3180 }
3182 # Check for various typo / spelling mistakes
3199 }
3200 }
3201 }
3203 # check for invalid commit id
3211 }
3212 }
3214 # check for repeated words separated by a single space
3215 # avoid false positive from list command eg, '-rw-r--r-- 1 root root'
3228 }
3233 # check for character before and after the word matches
3242 # avoid repeating hex occurrences like 'ff ff fe 09 ...'
3245 }
3251 }
3252 }
3254 # if it's a repeated word on consecutive lines in a comment block
3263 }
3264 }
3265 }
3266 }
3268 # ignore non-hunk lines and lines being removed
3271 #trailing whitespace
3278 }
3285 }
3288 }
3290 # Check for FSF mailing addresses.
3299 "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)
3300 }
3302 # check for Kconfig help text having a real description
3303 # Only applies when adding the entry originally, after that we do not have
3304 # sufficient context to determine whether it is indeed long enough.
3306 # 'choice' is usually the last thing on the line (though
3307 # Kconfig supports named choices), so use a word boundary
3308 # (\b) rather than a whitespace character (\s)
3328 }
3335 # This only checks context lines in the patch
3336 # and so hopefully shouldn't trigger false
3337 # positives, even though some of these are
3338 # common words in help texts
3343 }
3345 }
3349 }
3350 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3351 }
3353 # check MAINTAINERS entries
3355 # check MAINTAINERS entries for the right form
3362 }
3363 }
3364 # check MAINTAINERS entries for the right ordering too
3388 }
3389 }
3390 }
3391 }
3393 # discourage the use of boolean for type definition attributes of Kconfig options
3398 }
3408 };
3411 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3412 }
3414 # check for DT compatible documentation
3433 }
3440 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3441 }
3442 }
3443 }
3445 # check for using SPDX license tag at beginning of files
3459 }
3461 # check SPDX comment style for .[chsS] files
3467 }
3478 }
3487 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3488 }
3489 }
3490 }
3491 }
3492 }
3494 # check for embedded filenames
3498 }
3500 # check we are in a valid source file if not then ignore this hunk
3503 # check for using SPDX-License-Identifier on the wrong line number
3509 }
3511 # line length limit (with some exclusions)
3512 #
3513 # There are a few types of lines that may extend beyond $max_line_length:
3514 # logging functions like pr_info that end in a string
3515 # lines with a single string
3516 # #defines that are a single string
3517 # lines with an RFC3986 like URL
3518 #
3519 # There are 3 different line length message types:
3520 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3521 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3522 # LONG_LINE all other lines longer than $max_line_length
3523 #
3524 # if LONG_LINE is ignored, the other 2 types are also ignored
3525 #
3530 # Check the allowed long line types first
3532 # logging functions that end in a string that starts
3533 # before $max_line_length
3534 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3538 # lines with only strings (w/ possible termination)
3539 # #defines with only strings
3544 # More special cases
3549 # URL ($rawline is used in case the URL is in a comment)
3553 # Otherwise set the alternate message types
3555 # a comment starts before $max_line_length
3560 # a quoted string starts before $max_line_length
3564 }
3572 }
3573 }
3575 # check for adding lines without a newline.
3576 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3581 }
3582 }
3584 # check we are in a valid source file C or perl if not then ignore this hunk
3587 # at the beginning of a line any tabs must come first and anything
3588 # more than $tabsize must use tabs.
3597 }
3598 }
3600 # check for space before tabs.
3610 }
3611 }
3613 # check for assignments on the start of a line
3619 # add assignment operator to the previous line, remove from current line
3622 }
3623 }
3625 # check for && or || at the start of a line
3631 # insert logical operator at last non-comment, non-whitepsace char on previous line
3636 }
3637 }
3639 # check indentation starts on a tab stop
3641 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3648 }
3649 }
3650 }
3652 # check multi-line statement indentation matches previous line
3654 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3677 }
3678 }
3679 }
3680 }
3682 # check for space after cast like "(int) foo" or "(struct foo) bar"
3683 # avoid checking a few false positives:
3684 # "sizeof(<type>)" or "__alignof__(<type>)"
3685 # function pointer declarations like "(*foo)(int) = bar;"
3686 # structure definitions like "(struct foo) { 0 };"
3687 # multiline macros that define functions
3688 # known attributes or the __attribute__ keyword
3696 }
3697 }
3699 # Block comment styles
3700 # Networking with an initial /*
3704 $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier
3707 }
3709 # Block comments use * on subsequent lines
3717 }
3719 # Block comments use */ on trailing lines
3726 }
3728 # Block comment * alignment
3742 }
3749 }
3750 }
3752 # check for missing blank lines after struct/union declarations
3753 # with exceptions for various attributes and macros
3769 }
3770 }
3772 # check for multiple consecutive blank lines
3780 }
3783 }
3785 # check for missing blank lines after declarations
3787 # actual declarations
3789 # function pointer declarations
3791 # foo bar; where foo is some local typedef or #define
3793 # known declaration macros
3795 # for "else if" which can look like "$Ident $Ident"
3797 # other possible extensions of declaration lines
3799 # not starting a section or a macro "\" extended line
3801 # looks like a declaration
3803 # function pointer declarations
3805 # foo bar; where foo is some local typedef or #define
3807 # known declaration macros
3809 # start of struct or union or enum
3811 # start or end of block or continuation of declaration
3813 # bitfield continuation
3815 # other possible extensions of declaration lines
3817 # indentation of previous and current line are the same
3823 }
3824 }
3826 # check for spaces at the beginning of a line.
3827 # Exceptions:
3828 # 1) within comments
3829 # 2) indented preprocessor commands
3830 # 3) hanging labels
3837 }
3838 }
3840 # check we are in a valid C source file if not then ignore this hunk
3843 # check for unusual line ending [ or (
3847 }
3849 # check if this appears to be the start function declaration, save the name
3853 }
3855 # check if this appears to be the end of function declaration
3858 }
3860 # check indentation of any line with a bare else
3861 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3862 # if the previous line is a break or return and is indented 1 tab more...
3871 }
3872 }
3874 # check indentation of a line with a break;
3875 # if the previous line is a goto, return or break
3876 # and is indented the same # of tabs
3884 }
3885 }
3886 }
3888 # check for RCS/CVS revision markers
3892 }
3894 # check for old HOTPLUG __dev<foo> section markings
3898 }
3900 # Check for potential 'bare' types
3903 #print "LINE<$line>\n";
3911 #print "linenr<$linenr> <$stat>\n";
3912 # If this statement has no statement boundaries within
3913 # it there is no point in retrying a statement scan
3914 # until we hit end of it.
3917 #print "skip<$line_nr_next>\n";
3919 }
3921 # Find the real next line.
3927 }
3932 # Ignore goto labels.
3935 # Ignore functions being called
3940 # declarations always start with types
3941 } 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) {
3946 # definitions in global scope can only start with types
3949 }
3951 # any (foo ... *) is a pointer cast, and foo is a type
3954 }
3956 # Check for any sort of function declaration.
3957 # int foo(something bar, other baz);
3958 # void (*store_gdt)(x86_descr_ptr *);
3959 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3967 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3970 }
3971 }
3972 }
3974 }
3976 #
3977 # Checks which may be anchored in the context.
3978 #
3980 # Check for switch () and associated case and default
3981 # statements should be at the same indent.
3995 }
3996 }
4000 }
4001 }
4003 # if/while/etc brace do not go on next line, unless defining a do while loop,
4004 # or if that brace on the next line is for something else
4005 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
4013 }
4024 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
4027 }
4029 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
4030 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
4036 }
4040 {
4046 }
4047 }
4048 }
4050 # Check relative indent for conditionals and blocks.
4051 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
4059 # remove inline comments
4063 # Find out how long the conditional actually is.
4067 # Make sure we remove the line prefixes as we have
4068 # none on the first line, and are going to readd them
4069 # where necessary.
4073 }
4075 # We want to check the first line inside the block
4076 # starting at the end of the conditional, so remove:
4077 # 1) any blank line termination
4078 # 2) any opening brace { on end of the line
4079 # 3) any do (...) {
4086 }
4090 }
4092 # Also ignore a loop construct at the end of a
4093 # preprocessor statement.
4097 }
4104 # If we see an #else/#elif then the code
4105 # is not linear.
4108 }
4110 # Ignore:
4111 # 1) blank lines, they should be at 0,
4112 # 2) preprocessor lines, and
4113 # 3) labels.
4121 }
4122 }
4123 }
4128 # Check if either of these lines are modified, else
4129 # this is not this patch's fault.
4133 }
4136 }
4138 #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";
4147 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
4148 }
4149 }
4151 # Track the 'values' across context and added lines.
4161 }
4164 #ignore lines not being added
4167 # check for self assignments used to avoid compiler warnings
4168 # e.g.: int foo = foo, *bar = NULL;
4169 # struct foo bar = *(&(bar));
4172 if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) {
4175 }
4176 }
4178 # check for dereferences that span multiple lines
4188 }
4190 # check for declarations of signed or unsigned without int
4191 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
4202 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
4210 }
4211 }
4212 }
4214 # TEST: allow direct testing of the type matcher.
4222 }
4224 }
4225 # TEST: allow direct testing of the attribute matcher.
4233 }
4235 }
4237 # check for initialisation to aggregates open brace on the next line
4251 }
4252 }
4254 #
4255 # Checks which are anchored on the added line.
4256 #
4258 # check for malformed paths in #include statements (uses RAW line)
4264 }
4268 }
4269 }
4271 # no C99 // comments
4280 }
4281 }
4282 }
4283 # Remove C99 comments.
4287 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4288 # the whole statement.
4289 #print "APW <$lines[$realline_next - 1]>\n";
4295 # Handle definitions which produce identifiers with
4296 # a prefix:
4297 # XXX(foo);
4298 # EXPORT_SYMBOL(something_foo);
4302 #print "FOO C name<$name>\n";
4313 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4317 }
4318 }
4323 #print "FOO B <$lines[$linenr - 1]>\n";
4325 }
4330 }
4332 # check for global initialisers.
4338 }
4339 }
4340 # check for static initialisers.
4347 }
4348 }
4350 # check for misordered declarations of char/short/int/long with signed/unsigned
4354 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4355 }
4357 # check for unnecessary <signed> int declarations of short/long/long long
4374 }
4375 }
4377 # check for static const char * arrays.
4382 }
4384 # check for initialized const char arrays that should be static const
4385 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4390 }
4391 }
4393 # check for static char foo[] = "bar" declarations.
4398 }
4400 # check for const <foo> const where <foo> is not a pointer or array type
4409 }
4410 }
4412 # check for const static or static <non ptr type> const declarations
4413 # prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const'
4421 }
4422 }
4424 # check for non-global char *foo[] = {"bar", ...} declarations.
4429 }
4431 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4434 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4440 }
4441 }
4442 }
4444 # check for function declarations without arguments like "int foo()"
4450 }
4451 }
4453 # check for new typedefs, only function parameters and sparse annotations
4454 # make sense.
4462 }
4464 # * goes on variable not on type
4465 # (char*[ const])
4467 #print "AA<$1>\n";
4470 # Should start with a space.
4472 # Should not end with a space.
4474 # '*'s should not have spaces between.
4476 }
4478 ## print "1: from<$from> to<$to> ident<$ident>\n";
4488 }
4489 }
4490 }
4492 #print "BB<$1>\n";
4495 # Should start with a space.
4497 # Should not end with a space.
4499 # '*'s should not have spaces between.
4501 }
4502 # Modifiers should have spaces.
4505 ## print "2: from<$from> to<$to> ident<$ident>\n";
4516 }
4517 }
4518 }
4520 # avoid BUG() or BUG_ON()
4525 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4526 }
4528 # avoid LINUX_VERSION_CODE
4531 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4532 }
4534 # check for uses of printk_ratelimit
4538 }
4540 # printk should use KERN_* levels
4544 }
4546 # prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL>
4559 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to $printk(KERN_$orig ...\n" . $herecurr);
4560 }
4562 # prefer dev_<level> to dev_printk(KERN_<LEVEL>
4570 }
4572 # trace_printk should not be used in production code.
4575 "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr);
4576 }
4578 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4579 # number of false positives, but assembly files are not checked, so at
4580 # least the arch entry code will not trigger this warning.
4584 }
4586 # ENOTSUPP is not a standard error code and should be avoided in new patches.
4587 # Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4588 # Similarly to ENOSYS warning a small number of false positives is expected.
4594 }
4595 }
4597 # function brace can't be on same line, except for #defines of do while,
4598 # or if closed on same line
4615 }
4616 }
4617 }
4619 # open braces for enum, union and struct go on the same line.
4633 }
4634 }
4635 }
4637 # missing space after union, struct or enum definition
4644 }
4645 }
4647 # Function pointer declarations
4648 # check spacing between type, funcptr, and args
4649 # canonical declaration is "type (*funcptr)(args...)"
4658 # the $Declare variable will capture all spaces after the type
4659 # so check it for a missing trailing missing space but pointer return types
4660 # don't need a space so don't warn for those.
4665 }
4670 }
4672 # unnecessary space "type (*funcptr)(args...)"
4673 # This test is not currently implemented because these declarations are
4674 # equivalent to
4675 # int foo(int bar, ...)
4676 # and this is form shouldn't/doesn't generate a checkpatch warning.
4677 #
4678 # elsif ($declare =~ /\s{2,}$/) {
4679 # WARN("SPACING",
4680 # "Multiple spaces after return type\n" . $herecurr);
4681 # }
4683 # unnecessary space "type ( *funcptr)(args...)"
4688 }
4690 # unnecessary space "type (* funcptr)(args...)"
4695 }
4697 # unnecessary space "type (*funcptr )(args...)"
4702 }
4704 # unnecessary space "type (*funcptr) (args...)"
4709 }
4713 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4714 }
4715 }
4717 # check for spacing round square brackets; allowed:
4718 # 1. with a type on the left -- int [] a;
4719 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4720 # 3. inside a curly brace -- = { [0...10] = 5 }
4731 }
4732 }
4733 }
4735 # check for spaces between functions and their parentheses.
4741 # Ignore those directives where spaces _are_ permitted.
4747 {
4748 # cpp #define statements have non-optional spaces, ie
4749 # if there is a space between the name and the open
4750 # parenthesis it is simply not a parameter group.
4753 # cpp #elif statement condition may start with a (
4756 # If this whole things ends with a type its most
4757 # likely a typedef for a function.
4766 }
4767 }
4768 }
4770 # Check operator spacing.
4776 <<=|>>=|<=|>=|==|!=|
4778 =>|->|<<|>>|<|>|=|!|~|
4784 ## print("element count: <" . $#elements . ">\n");
4785 ## foreach my $el (@elements) {
4786 ## print("el: <$el>\n");
4787 ## }
4795 }
4806 ## print("n: <$n> good: <$good>\n");
4810 # Pick up the preceding and succeeding characters.
4815 }
4838 }
4847 # Pull out the value of this operator.
4850 # Get the full operator variant.
4853 # Ignore operators passed as parameters.
4857 # # Ignore comments
4858 # } elsif ($op =~ /^$;+$/) {
4860 # ; should have either the end of line or a space or \ after it
4868 }
4869 }
4871 # // is a comment
4874 # : when part of a bitfield
4876 # skip the bitfield test for now
4878 # No spaces for:
4879 # ->
4887 }
4889 }
4890 }
4892 # , must not have a space before and must have a space on the right.
4901 }
4902 }
4909 }
4910 }
4916 }
4919 }
4920 }
4922 # '*' as part of a type definition -- reported already.
4924 #warn "'*' is part of type\n";
4926 # unary operators should have a space before and
4927 # none after. May be left adjacent to another
4928 # unary operator, or a cast
4938 }
4939 }
4940 }
4942 # A unary '*' may be const
4950 }
4952 }
4953 }
4955 # unary ++ and unary -- are allowed no space on one side.
4962 }
4963 }
4970 }
4971 }
4978 }
4980 }
4981 }
4983 # << and >> may either have or not have spaces both sides
4989 {
4997 }
5003 }
5004 }
5011 }
5013 }
5014 }
5016 # A colon needs no spaces before when it is
5017 # terminating a case value or a label.
5024 }
5025 }
5027 # All the others need spaces both sides.
5031 # Ignore email addresses <foo@bar>
5036 {
5038 }
5040 # for asm volatile statements
5041 # ignore a colon with another
5042 # colon immediately before or after
5046 }
5048 # messages are ERROR, but ?: are CHK
5058 }
5060 }
5061 }
5062 }
5065 ## print("n: <$n> GOOD: <$good>\n");
5068 }
5072 }
5076 }
5079 }
5081 # check for whitespace before a non-naked semicolon
5088 }
5089 }
5091 # check for multiple assignments
5095 }
5097 ## # check for multiple declarations, allowing for a function declaration
5098 ## # continuation.
5099 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
5100 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
5101 ##
5102 ## # Remove any bracketed sections to ensure we do not
5103 ## # falsely report the parameters of functions.
5104 ## my $ln = $line;
5105 ## while ($ln =~ s/\([^\(\)]*\)//g) {
5106 ## }
5107 ## if ($ln =~ /,/) {
5108 ## WARN("MULTIPLE_DECLARATION",
5109 ## "declaring multiple variables together should be avoided\n" . $herecurr);
5110 ## }
5111 ## }
5113 #need space before brace following if, while, etc
5120 }
5121 }
5123 ## # check for blank lines before declarations
5124 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
5125 ## $prevrawline =~ /^.\s*$/) {
5126 ## WARN("SPACING",
5127 ## "No blank lines before declarations\n" . $hereprev);
5128 ## }
5129 ##
5131 # closing brace should have a space following it when it has anything
5132 # on the line
5139 }
5140 }
5142 # check spacing on square brackets
5149 }
5150 }
5157 }
5158 }
5160 # check spacing on parentheses
5168 }
5169 }
5178 }
5179 }
5181 # check unnecessary parentheses around addressof/dereference single $Lvals
5182 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
5190 }
5191 }
5193 # check for unnecessary parentheses around function pointer uses
5194 # ie: (foo->bar)(); should be foo->bar();
5195 # but not "if (foo->bar) (" to avoid some false positives
5204 }
5205 }
5207 # check for unnecessary parentheses around comparisons in if uses
5208 # when !drivers/staging or command-line uses --strict
5215 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
5217 # avoid parentheses around potential macro args
5226 }
5227 }
5230 }
5231 }
5233 #goto labels aren't indented, allow a single space however
5241 }
5242 }
5244 # check if a statement with a comma should be two statements like:
5245 # foo = bar(), /* comma should be semicolon */
5246 # bar = baz();
5248 $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
5253 }
5255 # return is not a function
5265 }
5269 }
5270 }
5272 # unnecessary return in a void function
5273 # at end-of-function, with the previous line a single leading tab, then return;
5274 # and the line before that not a goto label target like "out:"
5282 }
5284 # if statements using unnecessary parentheses - ie: if ((foo == bar))
5290 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
5295 }
5296 }
5298 # comparisons with a constant or upper case identifier on the left
5299 # avoid cases like "foo + BAR < baz"
5300 # only fix matches surrounded by parentheses to avoid incorrect
5301 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
5322 }
5324 }
5325 }
5327 # Return of what appears to be an errno should normally be negative
5333 }
5334 }
5336 # Need a space before open parenthesis after if, while etc
5343 }
5344 }
5346 # Check for illegal assignment in if conditional -- and check for trailing
5347 # statements after the conditional.
5355 ##print "stat<$stat> stat_next<$stat_next>\n";
5358 # If the statement carries leading newlines,
5359 # then count those as offsets.
5367 }
5368 }
5378 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5397 }
5398 }
5399 }
5401 # Find out what is on the end of the line after the
5402 # conditional.
5408 {
5409 # Find out how long the conditional actually is.
5418 }
5422 }
5423 }
5425 # Check for bitwise tests written as boolean
5431 |
5436 {
5439 }
5441 # if and else should not have general statements after it
5448 }
5449 }
5450 # if should not continue a brace
5455 }
5456 # case and default should not have general statements after them
5462 {
5465 }
5467 # Check for }<nl>else {, these must be at the same
5468 # indent level to be relevant to each other.
5480 }
5484 }
5485 }
5491 # Find out what is on the end of the line after the
5492 # conditional.
5508 }
5509 }
5510 }
5512 #Specific variable tests
5516 #CamelCase
5519 #Ignore some autogenerated defines and enum values
5521 #Ignore Page<foo> variants
5523 #Ignore SI style variants like nS, mV and dB
5524 #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5526 #Ignore some three character SI units explicitly, like MiB and KHz
5532 seed_camelcase_includes();
5536 }
5537 }
5542 }
5543 }
5544 }
5545 }
5547 #no spaces allowed after \ in define
5553 }
5554 }
5556 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5557 # itself <asm/foo.h> (uses RAW line)
5564 {
5573 }
5574 }
5575 }
5576 }
5578 # multi-statement macros should be enclosed in a do while loop, grab the
5579 # first statement and ensure its the whole macro if its not enclosed
5580 # in a known good container
5592 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5593 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5608 }
5615 # Flatten any parentheses and braces
5619 {
5620 }
5622 # Flatten any obvious string concatenation.
5625 {
5626 }
5628 # Make asm volatile uses seem like a generic function
5633 module_param_named|
5634 MODULE_PARM_DESC|
5635 DECLARE_PER_CPU|
5636 DEFINE_PER_CPU|
5637 __typeof__\(|
5638 union|
5639 struct|
5644 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5653 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5658 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5665 {
5668 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5675 }
5677 }
5679 # Make $define_stmt single line, comment-free, etc
5690 }
5691 }
5696 # check if any macro arguments are reused (ignore '...' and 'type')
5701 $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5708 }
5709 # check if any macro arguments may have other precedence issues
5715 }
5716 }
5718 # check for macros with flow control, but without ## concatenation
5719 # ## concatenation is commonly a macro that defines a function so ignore those
5726 }
5728 # check for line continuations outside of #defines, preprocessor #, and asm
5737 }
5738 }
5740 # do {} while (0) macro tests:
5741 # single-statement macros do not need to be enclosed in do while (0) loop,
5742 # macro should not end with a semicolon
5757 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5769 }
5773 }
5781 }
5782 }
5784 # check for redundant bracing round if etc
5788 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5789 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5799 # If the condition carries leading newlines, then count those as offsets.
5804 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5806 # We have looked at and allowed this specific line.
5816 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5818 #print "APW: ALLOWED: cond<$cond>\n";
5820 }
5822 #print "APW: ALLOWED: block<$block>\n";
5824 }
5826 #print "APW: ALLOWED: lines block<$block>\n";
5828 }
5830 }
5835 }
5843 }
5844 }
5845 }
5846 }
5851 # Check the pre-context.
5853 #print "APW: ALLOWED: pre<$1>\n";
5855 }
5860 # Check the condition.
5862 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5865 }
5867 #print "APW: ALLOWED: cond<$cond>\n";
5869 }
5871 #print "APW: ALLOWED: block<$block>\n";
5873 }
5875 #print "APW: ALLOWED: lines block<$block>\n";
5877 }
5878 # Check the post-context.
5883 }
5885 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5887 }
5888 }
5895 }
5896 }
5898 # check for single line unbalanced braces
5902 }
5904 # check for unnecessary blank lines around braces
5910 }
5911 }
5917 }
5918 }
5920 # no volatiles please
5924 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5925 }
5927 # Check for user-visible strings broken across lines, which breaks the ability
5928 # to grep for the string. Make exceptions when the previous string ends in a
5929 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5930 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5943 }
5955 }
5957 }
5958 }
5960 # check for missing a space in a string concatenation
5964 }
5966 # check for an embedded function name in a string when the function is known
5967 # This does not work very well for -f --file checking as it depends on patch
5968 # context providing the function name or a single line form for in-file
5969 # function declarations
5975 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5976 }
5978 # check for spaces before a quoted newline
5984 }
5986 }
5988 # concatenated string without spaces between elements
5997 }
5998 }
5999 }
6001 # uncoalesced string fragments
6009 }
6010 }
6011 }
6013 # check for non-standard and hex prefixed decimal printf formats
6019 # check for %L
6024 }
6025 # check for %Z
6030 }
6031 # check for 0x<decimal>
6035 }
6036 }
6038 # check for line continuations in quoted strings with odd counts of "
6042 }
6044 # warn about #if 0
6048 }
6050 # warn about #if 1
6054 }
6056 # check for needless "if (<foo>) fn(<foo>)" uses
6060 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
6072 }
6077 }
6080 }
6084 }
6085 }
6086 }
6087 }
6089 # check for unnecessary "Out of Memory" messages
6098 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
6100 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
6104 }
6105 }
6107 # check for logging functions with KERN_<LEVEL>
6115 }
6116 }
6118 # check for logging continuations
6122 }
6124 # check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions
6142 }
6143 }
6144 }
6146 # check for mask then right shift without a parentheses
6152 }
6154 # check for pointer comparisons to NULL
6164 }
6165 }
6166 }
6168 # check for bad placement of section $InitAttribute (e.g.: __initdata)
6171 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
6181 $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;
6182 }
6183 }
6184 }
6186 # check for $InitAttributeData (ie: __initdata) with const
6197 }
6198 }
6200 # check for $InitAttributeConst (ie: __initconst) without const
6212 }
6213 }
6215 # check for __read_mostly with const non-pointer (should just be const)
6222 }
6223 }
6225 # don't use __constant_<foo> functions outside of include/uapi/
6227 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
6235 }
6236 }
6238 # prefer usleep_range over udelay
6241 # ignore udelay's < 10, however
6244 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
6245 }
6249 }
6250 }
6252 # warn about unexpectedly long msleep's
6256 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
6257 }
6258 }
6260 # check for comparisons of jiffies
6263 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
6264 }
6266 # check for comparisons of get_jiffies_64()
6269 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
6270 }
6272 # warn about #ifdefs in C files
6273 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
6274 # print "#ifdef in C files should be avoided\n";
6275 # print "$herecurr";
6276 # $clean = 0;
6277 # }
6279 # warn about spacing in #ifdefs
6286 }
6288 }
6290 # check for spinlock_t definitions without a comment.
6297 }
6298 }
6299 # check for memory barriers without a comment.
6302 mb|
6303 rmb|
6304 wmb
6307 mb__before_atomic|
6308 mb__after_atomic|
6309 store_release|
6310 load_acquire|
6311 store_mb|
6324 }
6325 }
6335 }
6337 # check for waitqueue_active without a comment.
6342 }
6343 }
6345 # check for data_race without a comment.
6350 }
6351 }
6353 # check of hardware specific defines
6354 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
6357 }
6359 # check that the storage class is not after a type
6363 }
6364 # Check that the storage class is at the beginning of a declaration
6371 }
6373 # check the location of the inline attribute, that it is between
6374 # storage class and type.
6379 }
6381 # Check for __inline__ and __inline, prefer inline
6389 }
6390 }
6392 # Check for compiler attributes
6422 );
6437 }
6446 }
6447 }
6448 }
6450 # Check for __attribute__ unused, prefer __always_unused or __maybe_unused
6453 "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr);
6454 }
6455 }
6457 # Check for __attribute__ weak, or __weak declarations (may have link issues)
6459 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6464 }
6466 # check for c99 types like uint8_t used outside of uapi/ and tools/
6481 }
6482 }
6483 }
6485 # check for cast of C90 native int or longer types constants
6500 }
6502 }
6503 }
6505 # check for sizeof(&)
6509 }
6511 # check for sizeof without parenthesis
6516 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6517 }
6518 }
6520 # check for struct spinlock declarations
6524 }
6526 # check for seq_printf uses that could be seq_puts
6535 }
6536 }
6537 }
6539 # check for vsprintf extension %p<foo> misuses
6565 }
6569 }
6571 "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");
6572 }
6573 }
6581 }
6585 }
6586 }
6587 }
6589 # Check for misused memsets
6604 }
6605 }
6607 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6608 # if ($perl_version_ok &&
6609 # defined $stat &&
6610 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6611 # if (WARN("PREFER_ETHER_ADDR_COPY",
6612 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6613 # $fix) {
6614 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6615 # }
6616 # }
6618 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6619 # if ($perl_version_ok &&
6620 # defined $stat &&
6621 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6622 # WARN("PREFER_ETHER_ADDR_EQUAL",
6623 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6624 # }
6626 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6627 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6628 # if ($perl_version_ok &&
6629 # defined $stat &&
6630 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6631 #
6632 # my $ms_val = $7;
6633 #
6634 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6635 # if (WARN("PREFER_ETH_ZERO_ADDR",
6636 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6637 # $fix) {
6638 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6639 # }
6640 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6641 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6642 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6643 # $fix) {
6644 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6645 # }
6646 # }
6647 # }
6649 # strlcpy uses that should likely be strscpy
6652 "Prefer strscpy over strlcpy - see: https://lore.kernel.org/r/CAHk-=wgfRnXz0W3D37d01q3JFkr_i_uTL=V6A6G1oUZcprmknw\@mail.gmail.com/\n" . $herecurr);
6653 }
6655 # typecasts on min/max could be min_t/max_t
6673 }
6676 }
6677 }
6679 # check usleep_range arguments
6687 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6691 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6692 }
6693 }
6695 # check for naked sscanf
6707 }
6709 # check for simple sscanf that should be kstrto<foo>
6723 }
6724 }
6725 }
6727 # check for new externs in .h files.
6734 }
6735 }
6737 # check for new externs in .c files.
6740 {
6747 }
6749 {
6752 }
6757 }
6761 {
6764 }
6766 # check for function declarations that have arguments without identifier names
6768 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6776 }
6777 }
6778 }
6780 # check for function definitions
6786 # check for multiline function definition with misplaced open brace
6796 }
6800 }
6801 }
6803 # checks for new __setup's
6809 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
6810 }
6811 }
6813 # check for pointless casting of alloc functions
6816 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6817 }
6819 # alloc style
6820 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6822 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6825 }
6827 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6830 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6841 }
6851 $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;
6852 }
6853 }
6854 }
6856 # check for krealloc arg reuse
6862 }
6864 # check for alloc argument mismatch
6868 }
6870 # check for multiple semicolons
6876 }
6877 }
6879 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6888 }
6889 }
6891 # check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
6895 }
6897 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6898 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(${CONFIG_}[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6904 }
6905 }
6907 # check for /* fallthrough */ like comment, prefer fallthrough;
6916 );
6925 }
6926 }
6927 }
6929 # check for switch/default statements without a break;
6938 }
6940 # check for gcc specific __FUNCTION__
6946 }
6947 }
6949 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6953 }
6955 # check for use of yield()
6959 }
6961 # check for comparisons against true and false
6977 }
6982 ## maybe suggesting a correct construct would better
6983 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6985 }
6986 }
6988 # check for semaphores initialized locked
6992 }
6994 # recommend kstrto* over simple_strto* and strict_strto*
6998 }
7000 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
7003 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
7004 }
7006 # check for spin_is_locked(), suggest lockdep instead
7009 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
7010 }
7012 # check for deprecated apis
7018 }
7020 # check for various structs that are normally const (ops, kgdb, device_tree)
7021 # and avoid what seem like struct definitions 'struct foo {'
7027 }
7029 # use of NR_CPUS is usually wrong
7030 # ignore definitions of NR_CPUS and usage to define arrays as likely right
7037 {
7039 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
7040 }
7042 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
7046 }
7048 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
7053 }
7055 # nested likely/unlikely calls
7059 }
7061 # whine mightly about in_atomic
7069 }
7070 }
7072 # check for mutex_trylock_recursive usage
7076 }
7078 # check for lockdep_set_novalidate_class
7086 }
7087 }
7092 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
7093 }
7095 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
7096 # and whether or not function naming is typical and if
7097 # DEVICE_ATTR permissions uses are unusual too
7100 $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*\)/) {
7112 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
7113 }
7120 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
7121 }
7128 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
7129 }
7140 }
7143 }
7149 }
7150 }
7152 # Mode permission misuses where it seems decimal should be octal
7153 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
7154 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
7155 # specific definition of not visible in sysfs.
7156 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
7157 # use the default permissions
7173 }
7183 }
7186 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
7187 }
7188 }
7189 }
7190 }
7192 # check for uses of S_<PERMS> that could be octal for readability
7197 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
7200 }
7201 }
7203 # validate content of MODULE_LICENSE against list from include/linux/module.h
7207 GPL|
7208 GPL\ v2|
7213 Proprietary
7218 }
7219 }
7221 # check for sysctl duplicate constants
7224 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
7225 }
7226 }
7228 # If we have no input at all, then there is nothing to report on
7229 # so just keep quiet.
7232 }
7234 # In mailback mode only produce a report in the negative, for
7235 # things that appear to be patches.
7238 }
7240 # This is not a patch, and we are in 'no-patch' mode so
7241 # just keep quiet.
7244 }
7249 }
7255 # authorsignoff values:
7256 # 0 -> missing sign off
7257 # 1 -> sign off identical
7258 # 2 -> names and addresses match, comments mismatch
7259 # 3 -> addresses match, names different
7260 # 4 -> names match, addresses different
7261 # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match
7280 }
7281 }
7282 }
7290 }
7293 # If there were any defects found and not already fixing them
7299 EOM
7300 }
7301 # If there were whitespace errors which cleanpatch can fix
7302 # then suggest that.
7309 EOM
7310 }
7311 }
7331 }
7334 }
7335 }
7343 Do _NOT_ trust the results written to this file.
7346 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
7348 EOM
7349 }
7350 }
7358 }
7359 }
7361 }