| blob | 4427572b24771ddb1f2bf3de3176f9437f643951 |
1 #!/usr/bin/env perl
2 # SPDX-License-Identifier: GPL-2.0
3 #
4 # (c) 2001, Dave Jones. (the file handling bit)
5 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
6 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
7 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
8 # (c) 2010-2018 Joe Perches <joe@perches.com>
73 # git output parsing needs US English output, so first set backtick child process LANGUAGE
87 Options:
94 --emacs emacs compile window format
95 --terse one line per report
98 single git commit with:
102 multiple git commits with:
106 git merges are ignored
124 is all off)
126 literally
129 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
130 with potential errors corrected to the preferred
131 checkpatch style
136 runtime errors.
139 --codespellfile Use this codespell dictionary
140 --typedefsfile Read additional types from this file
148 EOM
151 }
156 }
172 # Also catch when type or level is passed through a variable
173 while ($text =~ /(?:(\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
179 }
182 }
183 }
196 }
208 }
209 }
215 }
216 }
219 }
241 }
242 }
245 }
263 }
277 }
278 }
279 }
283 }
285 }
287 # Perl's Getopt::Long allows options to take optional arguments after a space.
288 # Prevent --color by itself from consuming other arguments
292 }
293 }
295 GetOptions(
337 # Use the user provided codespell file unconditionally
340 # If /usr/share/codespell/dictionary.txt is not present, try to find it
341 # under codespell's install directory: <codespell_root>/data/dictionary.txt
345 import os.path as op
346 import codespell_lib
350 EOF
354 }
355 }
357 # $help is 1 if either -h, --help or --version is passed as option - exitcode: 0
358 # $help is 2 if invalid option is passed - exitcode: 1
374 }
389 }
391 #if no filenames are given, push '-' to read patch from stdin
394 }
396 # skip TAB size 1 to avoid additional checks on $tabsize - 1
413 }
414 }
423 }
425 }
426 }
436 ## no critic
439 }
446 }
452 }
459 }
460 }
465 }
466 }
476 __user|
477 __kernel|
478 __force|
479 __iomem|
480 __must_check|
481 __kprobes|
482 __ref|
483 __refconst|
484 __refdata|
485 __rcu|
486 __private
494 # Notes to $Attribute:
495 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
497 const|
498 volatile|
499 __percpu|
500 __nocast|
501 __safe|
502 __bitwise|
503 __packed__|
504 __packed2__|
505 __naked|
506 __maybe_unused|
507 __always_unused|
508 __noreturn|
509 __used|
510 __cold|
511 __pure|
512 __noclone|
513 __deprecated|
514 __read_mostly|
515 __ro_after_init|
516 __kprobes|
519 ____cacheline_aligned|
520 ____cacheline_aligned_in_smp|
521 ____cacheline_internodealigned_in_smp|
522 __weak|
545 <=|>=|==|!=|
546 =>|->|<<|>>|<|>|!|~|
580 )};
583 atomic_t
584 )};
586 FILE
587 )};
593 )};
599 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
600 TP_printk|
602 panic|
605 )};
613 # dev_alloc_skb/netdev_alloc_skb, et al
614 dma_alloc_coherent
615 )};
625 To:|
626 Cc:
627 )};
631 #Create a search and print patterns for all these strings to be used directly below
638 }
642 }
646 [=-]*> |
647 <[=-]* |
648 \[ |
649 \] |
650 start |
651 called |
652 entered |
653 entry |
654 enter |
656 inside |
657 here |
658 begin |
660 end |
661 done |
662 leave |
663 completed |
664 out |
667 )};
673 # if underflow, return
675 }
680 }
681 }
683 }
693 # two dimensional array storing minimum edit distance
708 }
709 }
710 }
712 }
719 );
722 }
725 }
735 \Qspinics.net\E
736 )};
755 );
778 );
799 )};
806 );
810 );
817 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
824 );
828 #Create a search pattern for all these functions to speed up a loop below
833 }
851 );
853 #Create a search pattern for all these strings to speed up a loop below
858 }
862 S_IWUGO |
863 S_IWOTH |
864 S_IRWXUGO |
865 S_IALLUGO |
886 );
888 #Create a search pattern for all these strings to speed up a loop below
893 }
920 }
924 }
927 irq|
928 memory|
930 reboot
931 )};
932 # memory.h: ARM has a custom one
934 # Load common spelling mistakes and build regular expression list.
951 }
955 }
974 }
978 }
979 }
998 }
1002 }
1005 }
1008 }
1014 }
1021 }
1039 )
1046 )
1055 )
1059 $NonptrType
1064 $NonptrTypeMisordered
1070 }
1071 build_types();
1075 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
1076 # requires at least perl version v5.10.0
1077 # Any use must be runtime checked with $^V
1088 )};
1095 );
1104 }
1109 }
1133 }
1134 }
1135 }
1145 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
1146 }
1149 }
1154 return 1 if (!$tree || which("python3") eq "" || !(-x "$root/scripts/spdxcheck.py") || !(-e "$gitroot"));
1160 }
1173 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
1184 }
1186 }
1194 }
1198 }
1203 }
1207 }
1215 }
1217 }
1218 }
1228 }
1242 # Maybe one day convert this block of bash into something that returns
1243 # all matching commit ids, but it's very slow...
1244 #
1245 # echo "checking commits $1..."
1246 # git rev-list --remotes | grep -i "^$1" |
1247 # while read line ; do
1248 # git log --format='%H %s' -1 $line |
1249 # echo "commit $(cut -c 1-12,41-)"
1250 # done
1251 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ ||
1257 }
1260 }
1272 # If input is git commits, extract all commits from the commit expressions.
1273 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1286 }
1295 }
1296 }
1299 }
1319 }
1326 }
1331 }
1338 }
1342 }
1351 build_types();
1353 }
1364 EOM
1365 }
1371 EOM
1372 }
1373 }
1384 );
1389 }
1390 }
1392 }
1417 # If there's a name left after stripping spaces and
1418 # leading quotes, and the address doesn't have both
1419 # leading and trailing angle brackets, the address
1420 # is invalid. ie:
1421 # "joe smith joe@smith.com" bad
1422 # "joe smith <joe@smith.com" bad
1427 }
1428 }
1430 # Extract comments from names excluding quoted parts
1431 # "John D. (Doe)" - Do not extract
1434 }
1437 }
1448 }
1451 }
1465 }
1476 }
1479 }
1486 }
1498 }
1506 }
1507 }
1510 }
1518 }
1519 }
1522 }
1535 }
1537 }
1540 }
1543 }
1547 }
1552 # Drop the diff line leader and expand tabs
1556 # Pick the indent from the front of the line.
1560 }
1571 }
1572 }
1583 # Always copy over the diff marker.
1589 # Comments we are whacking completely including the begin
1590 # and end, all to $;.
1597 }
1603 }
1610 }
1612 # A \ in a string means ignore the next character.
1618 }
1619 # Regular quotes.
1628 }
1629 }
1631 #print "c<$c> SQ<$sanitise_quote>\n";
1640 }
1641 }
1645 }
1647 # The pathname on a #include may be surrounded by '<' and '>'.
1652 # The whole of a #error is a string.
1656 }
1661 }
1664 }
1672 }
1695 #warn "CSB: blk<$blk> remain<$remain>\n";
1696 # If we are about to drop off the end, pull in more
1697 # context.
1708 }
1709 # Bail if there is no further context.
1710 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1713 }
1717 }
1718 }
1723 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1725 # Handle nested #if/#else.
1732 }
1734 # Statement ends at the ';' or a close '}' at the
1735 # outermost level.
1738 }
1740 # An else is really a conditional as long as its not else if
1747 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1748 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1749 }
1754 }
1762 #warn "CSB: mark coff<$coff>\n";
1763 }
1764 }
1768 }
1776 }
1778 }
1779 }
1780 # Preprocessor commands end at the newline unless escaped.
1786 }
1788 }
1789 # We are truly at the end, so shuffle to the next line.
1794 }
1799 #warn "STATEMENT<$statement>\n";
1800 #warn "CONDITION<$condition>\n";
1802 #print "coff<$coff> soff<$off> loff<$loff>\n";
1806 }
1811 # Strip the diff line prefixes and rip blank lines at start and end.
1819 }
1827 }
1848 }
1849 }
1857 # Grab the first conditional/block pair.
1860 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1864 }
1866 # Pull in the following conditional/block pairs and see if they
1867 # could continue the statement.
1871 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1873 #print "C: push\n";
1875 }
1878 }
1897 # Handle nested #if/#else.
1904 }
1907 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1911 }
1918 }
1919 }
1923 }
1926 }
1929 }
1935 }
1941 }
1947 }
1952 }
1957 }
1962 # If c99 comment on the current line, or the line before or after
1970 # Catch a comment on the end of the line itself.
1974 # Look through the context and try and figure out if there is a
1975 # comment.
1980 #warn " $line\n";
1983 }
1986 }
1989 }
1993 }
1994 }
1998 }
2003 ##print "LINE: $rawlines[$end_line - 1 ]\n";
2004 ##print "CMMT: $cmt\n";
2007 }
2020 }
2023 }
2031 }
2034 }
2042 }
2045 }
2057 }
2058 }
2062 }
2074 }
2094 }
2115 }
2144 # Assume all arms of the conditional end as this
2145 # one does, and continue as if the #endif was not here.
2162 }
2193 }
2205 }
2238 }
2253 }
2262 }
2266 }
2270 }
2271 }
2274 }
2283 DEFINE_\S+
2284 )$|
2288 case|
2292 \#|
2293 \#\#|
2299 # Check for modifiers.
2310 }
2311 }
2316 }
2317 build_types();
2320 }
2321 }
2333 }
2341 }
2350 }
2351 }
2356 }
2364 }
2368 }
2374 }
2379 }
2383 }
2394 }
2395 }
2422 }
2428 }
2435 }
2440 }
2443 }
2446 }
2454 };
2456 }
2464 };
2467 }
2476 }
2478 }
2486 }
2488 }
2496 }
2498 }
2504 ##print "absolute<$absolute>\n";
2506 # See if any suffix of this path is a path within the tree.
2509 ##print "file<$file>\n";
2511 }
2512 }
2515 }
2517 # It is, so see if the prefix is acceptable.
2521 ##print "prefix<$prefix>\n";
2525 }
2526 }
2534 }
2542 }
2550 }
2558 }
2567 #convert leading spaces to tabs
2569 #Remove spaces before a tab
2573 }
2587 }
2599 }
2600 }
2603 }
2612 }
2613 }
2616 }
2621 # Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c).
2625 }
2673 # Trace the real file/line as we go.
2686 # suppression flags
2694 # Pre-scan the patch sanitizing the lines.
2695 # Pre-scan the patch looking for any __setup documentation.
2696 #
2704 sanitise_line_reset();
2716 }
2717 #next;
2718 }
2725 }
2728 # Guestimate if this is a continuing comment. Run
2729 # the context looking for a comment "edge". If this
2730 # edge is a close comment then we must be in a comment
2731 # at context start.
2738 #print "RAW<$rawlines[$ln - 1]>\n";
2744 }
2745 }
2748 }
2750 # Guestimate if this is a continuing comment. If this
2751 # is the start of a diff block and this line starts
2752 # ' *' then it is very likely a comment.
2755 {
2757 }
2759 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2763 # Standardise the strings and chars within the input to
2764 # simplify matching -- only bother with positive lines.
2766 }
2773 }
2775 #print "==>$rawline\n";
2776 #print "-->$line\n";
2780 }
2781 }
2797 # check if it's a mode change, rename or start of a patch
2803 }
2805 #extract the line range in the file after the patch is applied
2816 }
2817 annotate_reset();
2828 }
2831 # track the line number as we move through the hunk, note that
2832 # new versions of GNU diff omit the leading space on completely
2833 # blank context lines so we need to count that too.
2838 # Measure the line length and indent.
2841 # Track the previous line.
2846 #warn "line<$line>\n";
2850 }
2858 # extract the filename as it passes
2874 }
2878 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2879 }
2881 }
2883 #make up the handle for any error we report on this line
2891 }
2892 }
2897 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2898 }
2903 }
2914 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
2915 }
2916 }
2919 }
2929 # Verify the existence of a commit log if appropriate
2930 # 2 is used because a $signature is counted in $commit_log_lines
2934 }
2939 }
2941 # Check if the commit log has what seems like a diff which can confuse patch
2950 }
2952 # Check for incorrect file permissions
2959 }
2960 }
2962 # Check the patch for a From:
2968 }
2972 }
2974 # Check the patch for a signoff:
3001 }
3004 }
3007 }
3008 }
3009 }
3010 }
3011 }
3013 # Check for patch separator
3017 }
3019 # Check if MAINTAINERS is being updated. If so, there's probably no need to
3020 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
3023 }
3025 # Check signature styles
3044 }
3045 }
3046 }
3053 }
3054 }
3061 }
3063 }
3070 }
3071 }
3082 # Don't force email to have quotes
3083 # Allow just an angle bracketed address
3089 }
3090 }
3092 # Address part shouldn't have comments
3100 }
3101 }
3103 # Only one name comment should be allowed
3108 }
3111 # stable@vger.kernel.org or stable@kernel.org shouldn't
3112 # have an email name. In addition comments should strictly
3113 # begin with a #
3121 # Remove brackets enclosing comment text
3122 # and # from start of comments to get comment text
3135 }
3136 }
3140 # Extract comment text from within brackets or
3141 # c89 style /*...*/ comments
3146 $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo
3154 }
3155 }
3156 }
3158 # Check for duplicate signatures
3167 }
3169 # Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
3173 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . $herecurr);
3174 }
3180 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . $herecurr . $rawlines[$linenr] . "\n");
3183 "Co-developed-by and Signed-off-by: name/email do not match\n" . $herecurr . $rawlines[$linenr] . "\n");
3184 }
3185 }
3187 # check if Reported-by: is followed by a Closes: tag
3191 "Reported-by: should be immediately followed by Closes: with a URL to the report\n" . $herecurr . "\n");
3194 "Reported-by: should be immediately followed by Closes: with a URL to the report\n" . $herecurr . $rawlines[$linenr] . "\n");
3195 }
3196 }
3197 }
3199 # These indicate a bug fix
3203 }
3208 }
3210 # Check Fixes: styles is correct
3234 # Always strip leading/trailing parens then double quotes if existing
3239 }
3240 }
3248 "Please use correct Fixes: style 'Fixes: <12 chars of sha1> (\"<title line>\")' - ie: 'Fixes: $cid (\"$ctitle\")'\n" . $herecurr) &&
3251 }
3252 }
3253 }
3255 # Check email subject for common tools that don't need to be mentioned
3260 }
3262 # Check for Gerrit Change-Ids not in any patch context
3268 }
3269 }
3271 # Check if the commit log is in a possible stack dump
3275 # timestamp
3279 # stack dump address styles
3281 }
3283 # Check for line lengths > 75 in commit log, warn once
3287 # file delta changes
3289 # filename then :
3291 # A Fixes:, link or signature tag line
3296 }
3298 # Reset possible stack dump if a blank line is found
3302 }
3304 # Check for odd tags before a URI/URL
3313 }
3314 }
3316 # Check for misuse of the link tags
3324 }
3325 }
3327 # Check for lines starting with a #
3333 }
3334 }
3336 # Check for git id commit length and improperly formed commit descriptions
3337 # A correctly formed commit description is:
3338 # commit <SHA-1 hash length 12+ chars> ("Complete commit subject")
3339 # with the commit subject '("' prefix and '")' suffix
3340 # This is a fairly compilicated block as it tests for what appears to be
3341 # bare SHA-1 hash with minimum length of 5. It also avoids several types of
3342 # possible SHA-1 matches.
3343 # A commit match can span multiple lines so this block attempts to find a
3344 # complete typical commit on a maximum of 3 lines
3350 ($line =~ /\bcommit\s*$/i && defined($rawlines[$linenr]) && $rawlines[$linenr] =~ /^\s*[0-9a-f]{5,}\b/i)) ||
3373 # Always strip leading/trailing parens then double quotes if existing
3378 }
3380 }
3384 }
3386 }
3397 }
3406 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herectx);
3407 }
3408 #don't report the next line if this line ends in commit and the sha1 hash is the next line
3410 }
3412 # Check for mailing list archives other than lore.kernel.org
3415 "Use lore.kernel.org archive links when possible - see https://lore.kernel.org/lists.html\n" . $herecurr);
3416 }
3418 # Check for added, moved or deleted files
3428 }
3430 # Check for adding new DT bindings not in schema format
3435 "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n");
3436 }
3438 # Check for wrappage within a valid hunk of the file
3443 }
3445 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
3456 }
3458 # Check if it's the start of a commit log
3459 # (not a header line and we haven't seen the patch filename)
3466 }
3468 # Check if there is UTF-8 in a commit log when a mail header has explicitly
3469 # declined it, i.e defined some charset where it is missing.
3474 }
3480 }
3482 # Check for absolute kernel paths in commit message
3489 #
3492 }
3493 }
3494 }
3496 # Check for various typo / spelling mistakes
3513 }
3514 }
3515 }
3517 # check for invalid commit id
3525 }
3526 }
3528 # check for repeated words separated by a single space
3529 # avoid false positive from list command eg, '-rw-r--r-- 1 root root'
3542 }
3547 # check for character before and after the word matches
3556 # avoid repeating hex occurrences like 'ff ff fe 09 ...'
3559 }
3565 }
3566 }
3568 # if it's a repeated word on consecutive lines in a comment block
3577 }
3578 }
3579 }
3580 }
3582 # ignore non-hunk lines and lines being removed
3585 #trailing whitespace
3592 }
3599 }
3602 }
3604 # Check for FSF mailing addresses.
3613 "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)
3614 }
3616 # check for Kconfig help text having a real description
3617 # Only applies when adding the entry originally, after that we do not have
3618 # sufficient context to determine whether it is indeed long enough.
3620 # 'choice' is usually the last thing on the line (though
3621 # Kconfig supports named choices), so use a word boundary
3622 # (\b) rather than a whitespace character (\s)
3637 }
3641 }
3648 # At the end of this Kconfig block:
3649 # This only checks context lines in the patch
3650 # and so hopefully shouldn't trigger false
3651 # positives, even though some of these are
3652 # common words in help texts
3656 }
3658 }
3663 "please write a help paragraph that fully describes the config symbol\n" . "$here\n$stat_real\n");
3664 }
3665 }
3667 # check MAINTAINERS entries
3669 # check MAINTAINERS entries for the right form
3676 }
3677 }
3678 # check MAINTAINERS entries for the right ordering too
3702 }
3703 }
3704 }
3705 }
3715 };
3718 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3719 }
3721 # check for DT compatible documentation
3740 }
3747 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3748 }
3749 }
3750 }
3752 # check for using SPDX license tag at beginning of files
3766 }
3768 # check SPDX comment style for .[chsS] files
3774 }
3785 }
3794 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3795 }
3796 }
3801 }
3802 }
3803 }
3804 }
3806 # check for embedded filenames
3810 }
3812 # check we are in a valid source file if not then ignore this hunk
3815 # check for using SPDX-License-Identifier on the wrong line number
3821 }
3823 # line length limit (with some exclusions)
3824 #
3825 # There are a few types of lines that may extend beyond $max_line_length:
3826 # logging functions like pr_info that end in a string
3827 # lines with a single string
3828 # #defines that are a single string
3829 # lines with an RFC3986 like URL
3830 #
3831 # There are 3 different line length message types:
3832 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3833 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3834 # LONG_LINE all other lines longer than $max_line_length
3835 #
3836 # if LONG_LINE is ignored, the other 2 types are also ignored
3837 #
3842 # Check the allowed long line types first
3844 # logging functions that end in a string that starts
3845 # before $max_line_length
3846 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3850 # lines with only strings (w/ possible termination)
3851 # #defines with only strings
3856 # More special cases
3861 # URL ($rawline is used in case the URL is in a comment)
3865 # Otherwise set the alternate message types
3867 # a comment starts before $max_line_length
3872 # a quoted string starts before $max_line_length
3876 }
3884 }
3885 }
3887 # check for adding lines without a newline.
3888 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3893 }
3894 }
3896 # check for .L prefix local symbols in .S files
3900 "Avoid using '.L' prefixed local symbol names for denoting a range of code via 'SYM_*_START/END' annotations; see Documentation/core-api/asm-annotations.rst\n" . $herecurr);
3901 }
3903 # check we are in a valid source file C or perl if not then ignore this hunk
3906 # at the beginning of a line any tabs must come first and anything
3907 # more than $tabsize must use tabs.
3916 }
3917 }
3919 # check for space before tabs.
3929 }
3930 }
3932 # check for assignments on the start of a line
3938 # add assignment operator to the previous line, remove from current line
3941 }
3942 }
3944 # check for && or || at the start of a line
3950 # insert logical operator at last non-comment, non-whitepsace char on previous line
3955 }
3956 }
3958 # check indentation starts on a tab stop
3960 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3967 }
3968 }
3969 }
3971 # check multi-line statement indentation matches previous line
3973 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3996 }
3997 }
3998 }
3999 }
4001 # check for space after cast like "(int) foo" or "(struct foo) bar"
4002 # avoid checking a few false positives:
4003 # "sizeof(<type>)" or "__alignof__(<type>)"
4004 # function pointer declarations like "(*foo)(int) = bar;"
4005 # structure definitions like "(struct foo) { 0 };"
4006 # multiline macros that define functions
4007 # known attributes or the __attribute__ keyword
4015 }
4016 }
4018 # Block comments use * on subsequent lines
4026 }
4028 # Block comments use */ on trailing lines
4035 }
4037 # Block comment * alignment
4051 }
4058 }
4059 }
4061 # check for missing blank lines after struct/union declarations
4062 # with exceptions for various attributes and macros
4078 }
4079 }
4081 # check for multiple consecutive blank lines
4089 }
4092 }
4094 # check for missing blank lines after declarations
4095 # (declarations must have the same indentation and not be at the start of line)
4097 # use temporaries
4100 # remove $Attribute/$Sparse uses to simplify comparisons
4104 # function pointer declarations
4106 # foo bar; where foo is some local typedef or #define
4108 # known declaration macros
4110 # for "else if" which can look like "$Ident $Ident"
4112 # other possible extensions of declaration lines
4114 # not starting a section or a macro "\" extended line
4116 # looks like a declaration
4118 # function pointer declarations
4120 # foo bar; where foo is some local typedef or #define
4122 # known declaration macros
4124 # start of struct or union or enum
4126 # start or end of block or continuation of declaration
4128 # bitfield continuation
4130 # other possible extensions of declaration lines
4136 }
4137 }
4138 }
4140 # check for spaces at the beginning of a line.
4141 # Exceptions:
4142 # 1) within comments
4143 # 2) indented preprocessor commands
4144 # 3) hanging labels
4151 }
4152 }
4154 # check we are in a valid C source file if not then ignore this hunk
4157 # check for unusual line ending [ or (
4161 }
4163 # check if this appears to be the start function declaration, save the name
4167 }
4169 # check if this appears to be the end of function declaration
4172 }
4174 # check indentation of any line with a bare else
4175 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
4176 # if the previous line is a break or return and is indented 1 tab more...
4185 }
4186 }
4188 # check indentation of a line with a break;
4189 # if the previous line is a goto, return or break
4190 # and is indented the same # of tabs
4198 }
4199 }
4200 }
4202 # check for RCS/CVS revision markers
4206 }
4208 # check for old HOTPLUG __dev<foo> section markings
4212 }
4214 # Check for potential 'bare' types
4217 #print "LINE<$line>\n";
4225 #print "linenr<$linenr> <$stat>\n";
4226 # If this statement has no statement boundaries within
4227 # it there is no point in retrying a statement scan
4228 # until we hit end of it.
4231 #print "skip<$line_nr_next>\n";
4233 }
4235 # Find the real next line.
4241 }
4246 # Ignore goto labels.
4249 # Ignore functions being called
4254 # declarations always start with types
4255 } 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) {
4260 # definitions in global scope can only start with types
4263 }
4265 # any (foo ... *) is a pointer cast, and foo is a type
4268 }
4270 # Check for any sort of function declaration.
4271 # int foo(something bar, other baz);
4272 # void (*store_gdt)(x86_descr_ptr *);
4273 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
4281 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
4284 }
4285 }
4286 }
4288 }
4290 #
4291 # Checks which may be anchored in the context.
4292 #
4294 # Check for switch () and associated case and default
4295 # statements should be at the same indent.
4309 }
4310 }
4314 }
4315 }
4317 # if/while/etc brace do not go on next line, unless defining a do while loop,
4318 # or if that brace on the next line is for something else
4319 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
4327 }
4338 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
4341 }
4343 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
4344 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
4350 }
4354 {
4360 }
4361 }
4362 }
4364 # Check relative indent for conditionals and blocks.
4365 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
4373 # remove inline comments
4377 # Find out how long the conditional actually is.
4381 # Make sure we remove the line prefixes as we have
4382 # none on the first line, and are going to readd them
4383 # where necessary.
4387 }
4389 # We want to check the first line inside the block
4390 # starting at the end of the conditional, so remove:
4391 # 1) any blank line termination
4392 # 2) any opening brace { on end of the line
4393 # 3) any do (...) {
4400 }
4404 }
4406 # Also ignore a loop construct at the end of a
4407 # preprocessor statement.
4411 }
4418 # If we see an #else/#elif then the code
4419 # is not linear.
4422 }
4424 # Ignore:
4425 # 1) blank lines, they should be at 0,
4426 # 2) preprocessor lines, and
4427 # 3) labels.
4435 }
4436 }
4437 }
4442 # Check if either of these lines are modified, else
4443 # this is not this patch's fault.
4447 }
4450 }
4452 #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";
4461 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
4462 }
4463 }
4465 # Track the 'values' across context and added lines.
4475 }
4478 #ignore lines not being added
4481 # check for self assignments used to avoid compiler warnings
4482 # e.g.: int foo = foo, *bar = NULL;
4483 # struct foo bar = *(&(bar));
4486 if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) {
4489 }
4490 }
4492 # check for dereferences that span multiple lines
4502 }
4504 # check for declarations of signed or unsigned without int
4505 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
4516 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
4524 }
4525 }
4526 }
4528 # TEST: allow direct testing of the type matcher.
4536 }
4538 }
4539 # TEST: allow direct testing of the attribute matcher.
4547 }
4549 }
4551 # check for initialisation to aggregates open brace on the next line
4565 }
4566 }
4568 #
4569 # Checks which are anchored on the added line.
4570 #
4572 # check for malformed paths in #include statements (uses RAW line)
4578 }
4582 }
4583 }
4585 # no C99 // comments
4594 }
4595 }
4596 }
4597 # Remove C99 comments.
4601 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4602 # the whole statement.
4603 #print "APW <$lines[$realline_next - 1]>\n";
4608 # Handle definitions which produce identifiers with
4609 # a prefix:
4610 # XXX(foo);
4611 # EXPORT_SYMBOL(something_foo);
4616 #print "FOO C name<$name>\n";
4627 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4631 }
4632 }
4636 #print "FOO B <$lines[$linenr - 1]>\n";
4638 }
4643 }
4645 # check for global initialisers.
4652 }
4653 }
4654 # check for static initialisers.
4661 }
4662 }
4664 # check for misordered declarations of char/short/int/long with signed/unsigned
4668 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4669 }
4671 # check for unnecessary <signed> int declarations of short/long/long long
4688 }
4689 }
4691 # check for static const char * arrays.
4696 }
4698 # check for initialized const char arrays that should be static const
4699 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4704 }
4705 }
4707 # check for static char foo[] = "bar" declarations.
4712 }
4714 # check for const <foo> const where <foo> is not a pointer or array type
4723 }
4724 }
4726 # check for const static or static <non ptr type> const declarations
4727 # prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const'
4735 }
4736 }
4738 # check for non-global char *foo[] = {"bar", ...} declarations.
4743 }
4745 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4748 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4754 }
4755 }
4756 }
4758 # check for function declarations without arguments like "int foo()"
4764 }
4765 }
4767 # check for new typedefs, only function parameters and sparse annotations
4768 # make sense.
4776 }
4778 # * goes on variable not on type
4779 # (char*[ const])
4781 #print "AA<$1>\n";
4784 # Should start with a space.
4786 # Should not end with a space.
4788 # '*'s should not have spaces between.
4790 }
4792 ## print "1: from<$from> to<$to> ident<$ident>\n";
4802 }
4803 }
4804 }
4806 #print "BB<$1>\n";
4809 # Should start with a space.
4811 # Should not end with a space.
4813 # '*'s should not have spaces between.
4815 }
4816 # Modifiers should have spaces.
4819 ## print "2: from<$from> to<$to> ident<$ident>\n";
4830 }
4831 }
4832 }
4834 # do not use BUG() or variants
4835 if ($line =~ /\b(?!AA_|BUILD_|DCCP_|IDA_|KVM_|RWLOCK_|snd_|SPIN_)(?:[a-zA-Z_]*_)?BUG(?:_ON)?(?:_[A-Z_]+)?\s*\(/) {
4839 "Do not crash the kernel unless it is absolutely unavoidable--use WARN_ON_ONCE() plus recovery code (if feasible) instead of BUG() or variants\n" . $herecurr);
4840 }
4842 # avoid LINUX_VERSION_CODE
4845 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4846 }
4848 # check for uses of printk_ratelimit
4852 }
4854 # printk should use KERN_* levels
4858 }
4860 # prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL>
4873 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to $printk(KERN_$orig ...\n" . $herecurr);
4874 }
4876 # prefer dev_<level> to dev_printk(KERN_<LEVEL>
4884 }
4886 # trace_printk should not be used in production code.
4889 "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr);
4890 }
4892 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4893 # number of false positives, but assembly files are not checked, so at
4894 # least the arch entry code will not trigger this warning.
4898 }
4900 # ENOTSUPP is not a standard error code and should be avoided in new patches.
4901 # Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4902 # Similarly to ENOSYS warning a small number of false positives is expected.
4908 }
4909 }
4911 # function brace can't be on same line, except for #defines of do while,
4912 # or if closed on same line
4929 }
4930 }
4931 }
4933 # open braces for enum, union and struct go on the same line.
4947 }
4948 }
4949 }
4951 # missing space after union, struct or enum definition
4958 }
4959 }
4961 # Function pointer declarations
4962 # check spacing between type, funcptr, and args
4963 # canonical declaration is "type (*funcptr)(args...)"
4972 # the $Declare variable will capture all spaces after the type
4973 # so check it for a missing trailing missing space but pointer return types
4974 # don't need a space so don't warn for those.
4979 }
4984 }
4986 # unnecessary space "type (*funcptr)(args...)"
4987 # This test is not currently implemented because these declarations are
4988 # equivalent to
4989 # int foo(int bar, ...)
4990 # and this is form shouldn't/doesn't generate a checkpatch warning.
4991 #
4992 # elsif ($declare =~ /\s{2,}$/) {
4993 # WARN("SPACING",
4994 # "Multiple spaces after return type\n" . $herecurr);
4995 # }
4997 # unnecessary space "type ( *funcptr)(args...)"
5002 }
5004 # unnecessary space "type (* funcptr)(args...)"
5009 }
5011 # unnecessary space "type (*funcptr )(args...)"
5016 }
5018 # unnecessary space "type (*funcptr) (args...)"
5023 }
5027 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
5028 }
5029 }
5031 # check for spacing round square brackets; allowed:
5032 # 1. with a type on the left -- int [] a;
5033 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
5034 # 3. inside a curly brace -- = { [0...10] = 5 }
5045 }
5046 }
5047 }
5049 # check for spaces between functions and their parentheses.
5055 # Ignore those directives where spaces _are_ permitted.
5061 {
5062 # cpp #define statements have non-optional spaces, ie
5063 # if there is a space between the name and the open
5064 # parenthesis it is simply not a parameter group.
5067 # cpp #elif statement condition may start with a (
5070 # If this whole things ends with a type its most
5071 # likely a typedef for a function.
5080 }
5081 }
5082 }
5084 # Check operator spacing.
5090 <<=|>>=|<=|>=|==|!=|
5092 =>|->|<<|>>|<|>|=|!|~|
5098 ## print("element count: <" . $#elements . ">\n");
5099 ## foreach my $el (@elements) {
5100 ## print("el: <$el>\n");
5101 ## }
5109 }
5120 ## print("n: <$n> good: <$good>\n");
5124 # Pick up the preceding and succeeding characters.
5129 }
5152 }
5161 # Pull out the value of this operator.
5164 # Get the full operator variant.
5167 # Ignore operators passed as parameters.
5171 # # Ignore comments
5172 # } elsif ($op =~ /^$;+$/) {
5174 # ; should have either the end of line or a space or \ after it
5182 }
5183 }
5185 # // is a comment
5188 # : when part of a bitfield
5190 # skip the bitfield test for now
5192 # No spaces for:
5193 # ->
5201 }
5203 }
5204 }
5206 # , must not have a space before and must have a space on the right.
5215 }
5216 }
5223 }
5224 }
5230 }
5233 }
5234 }
5236 # '*' as part of a type definition -- reported already.
5238 #warn "'*' is part of type\n";
5240 # unary operators should have a space before and
5241 # none after. May be left adjacent to another
5242 # unary operator, or a cast
5252 }
5253 }
5254 }
5256 # A unary '*' may be const
5264 }
5266 }
5267 }
5269 # unary ++ and unary -- are allowed no space on one side.
5276 }
5277 }
5284 }
5285 }
5292 }
5294 }
5295 }
5297 # << and >> may either have or not have spaces both sides
5303 {
5311 }
5317 }
5318 }
5325 }
5327 }
5328 }
5330 # A colon needs no spaces before when it is
5331 # terminating a case value or a label.
5338 }
5339 }
5341 # All the others need spaces both sides.
5345 # Ignore email addresses <foo@bar>
5350 {
5352 }
5354 # for asm volatile statements
5355 # ignore a colon with another
5356 # colon immediately before or after
5360 }
5362 # messages are ERROR, but ?: are CHK
5372 }
5374 }
5375 }
5376 }
5379 ## print("n: <$n> GOOD: <$good>\n");
5382 }
5386 }
5390 }
5393 }
5395 # check for whitespace before a non-naked semicolon
5402 }
5403 }
5405 # check for multiple assignments
5409 }
5411 ## # check for multiple declarations, allowing for a function declaration
5412 ## # continuation.
5413 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
5414 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
5415 ##
5416 ## # Remove any bracketed sections to ensure we do not
5417 ## # falsely report the parameters of functions.
5418 ## my $ln = $line;
5419 ## while ($ln =~ s/\([^\(\)]*\)//g) {
5420 ## }
5421 ## if ($ln =~ /,/) {
5422 ## WARN("MULTIPLE_DECLARATION",
5423 ## "declaring multiple variables together should be avoided\n" . $herecurr);
5424 ## }
5425 ## }
5427 #need space before brace following if, while, etc
5434 }
5435 }
5437 ## # check for blank lines before declarations
5438 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
5439 ## $prevrawline =~ /^.\s*$/) {
5440 ## WARN("SPACING",
5441 ## "No blank lines before declarations\n" . $hereprev);
5442 ## }
5443 ##
5445 # closing brace should have a space following it when it has anything
5446 # on the line
5453 }
5454 }
5456 # check spacing on square brackets
5463 }
5464 }
5471 }
5472 }
5474 # check spacing on parentheses
5482 }
5483 }
5492 }
5493 }
5495 # check unnecessary parentheses around addressof/dereference single $Lvals
5496 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
5504 }
5505 }
5507 # check for unnecessary parentheses around function pointer uses
5508 # ie: (foo->bar)(); should be foo->bar();
5509 # but not "if (foo->bar) (" to avoid some false positives
5518 }
5519 }
5521 # check for unnecessary parentheses around comparisons in if uses
5522 # when !drivers/staging or command-line uses --strict
5529 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
5531 # avoid parentheses around potential macro args
5540 }
5541 }
5544 }
5545 }
5547 # check that goto labels aren't indented (allow a single space indentation)
5548 # and ignore bitfield definitions like foo:1
5549 # Strictly, labels can have whitespace after the identifier and before the :
5550 # but this is not allowed here as many ?: uses would appear to be labels
5559 }
5560 }
5562 # check if a statement with a comma should be two statements like:
5563 # foo = bar(), /* comma should be semicolon */
5564 # bar = baz();
5566 $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
5571 }
5573 # return is not a function
5583 }
5587 }
5588 }
5590 # unnecessary return in a void function
5591 # at end-of-function, with the previous line a single leading tab, then return;
5592 # and the line before that not a goto label target like "out:"
5600 }
5602 # if statements using unnecessary parentheses - ie: if ((foo == bar))
5608 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
5613 }
5614 }
5616 # comparisons with a constant or upper case identifier on the left
5617 # avoid cases like "foo + BAR < baz"
5618 # only fix matches surrounded by parentheses to avoid incorrect
5619 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
5640 }
5642 }
5643 }
5645 # Return of what appears to be an errno should normally be negative
5651 }
5652 }
5654 # Need a space before open parenthesis after if, while etc
5661 }
5662 }
5664 # Check for illegal assignment in if conditional -- and check for trailing
5665 # statements after the conditional.
5673 ##print "stat<$stat> stat_next<$stat_next>\n";
5676 # If the statement carries leading newlines,
5677 # then count those as offsets.
5685 }
5686 }
5697 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5717 }
5718 }
5719 }
5721 # Find out what is on the end of the line after the
5722 # conditional.
5728 {
5729 # Find out how long the conditional actually is.
5738 }
5752 }
5753 }
5754 }
5755 }
5757 # Check for bitwise tests written as boolean
5763 |
5768 {
5771 }
5773 # if and else should not have general statements after it
5780 }
5781 }
5782 # if should not continue a brace
5787 }
5788 # case and default should not have general statements after them
5794 {
5797 }
5799 # Check for }<nl>else {, these must be at the same
5800 # indent level to be relevant to each other.
5812 }
5816 }
5817 }
5823 # Find out what is on the end of the line after the
5824 # conditional.
5840 }
5841 }
5842 }
5844 #Specific variable tests
5848 #CamelCase
5851 #Ignore some autogenerated defines and enum values
5853 #Ignore Page<foo> variants
5855 #Ignore ETHTOOL_LINK_MODE_<foo> variants
5857 #Ignore SI style variants like nS, mV and dB
5858 #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5860 #Ignore some three character SI units explicitly, like MiB and KHz
5866 seed_camelcase_includes();
5870 }
5871 }
5876 }
5877 }
5878 }
5879 }
5881 #no spaces allowed after \ in define
5887 }
5888 }
5890 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5891 # itself <asm/foo.h> (uses RAW line)
5898 {
5907 }
5908 }
5909 }
5910 }
5912 # multi-statement macros should be enclosed in a do while loop, grab the
5913 # first statement and ensure its the whole macro if its not enclosed
5914 # in a known good container
5926 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5927 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5942 }
5949 # Flatten any parentheses and braces
5953 {
5954 }
5956 # Flatten any obvious string concatenation.
5959 {
5960 }
5962 # Make asm volatile uses seem like a generic function
5967 module_param_named|
5968 MODULE_PARM_DESC|
5969 DECLARE_PER_CPU|
5970 DEFINE_PER_CPU|
5971 __typeof__\(|
5972 union|
5973 struct|
5978 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5987 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5993 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
6000 {
6003 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
6010 }
6012 }
6014 # Make $define_stmt single line, comment-free, etc
6025 }
6026 }
6031 # check if any macro arguments are reused (ignore '...' and 'type')
6036 $tmp_stmt =~ s/\b(__must_be_array|offsetof|sizeof|sizeof_field|__stringify|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
6043 }
6044 # check if any macro arguments may have other precedence issues
6050 }
6052 # check if this is an unused argument
6056 }
6057 }
6059 # check for macros with flow control, but without ## concatenation
6060 # ## concatenation is commonly a macro that defines a function so ignore those
6067 }
6069 # check for line continuations outside of #defines, preprocessor #, and asm
6073 #print "REAL: $realfile\nln: $line\nkeys:", sort keys %maybe_linker_symbol;
6081 }
6082 }
6084 # do {} while (0) macro tests:
6085 # single-statement macros do not need to be enclosed in do while (0) loop,
6086 # macro should not end with a semicolon
6101 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
6113 }
6117 }
6125 }
6126 }
6128 # check for redundant bracing round if etc
6132 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
6133 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
6143 # If the condition carries leading newlines, then count those as offsets.
6148 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
6150 # We have looked at and allowed this specific line.
6160 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
6162 #print "APW: ALLOWED: cond<$cond>\n";
6164 }
6166 #print "APW: ALLOWED: block<$block>\n";
6168 }
6170 #print "APW: ALLOWED: lines block<$block>\n";
6172 }
6174 }
6179 }
6187 }
6188 }
6189 }
6190 }
6195 # Check the pre-context.
6197 #print "APW: ALLOWED: pre<$1>\n";
6199 }
6204 # Check the condition.
6206 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
6209 }
6211 #print "APW: ALLOWED: cond<$cond>\n";
6213 }
6215 #print "APW: ALLOWED: block<$block>\n";
6217 }
6219 #print "APW: ALLOWED: lines block<$block>\n";
6221 }
6222 # Check the post-context.
6227 }
6229 #print "APW: ALLOWED: chunk-1 block<$block>\n";
6231 }
6232 }
6239 }
6240 }
6242 # check for single line unbalanced braces
6246 }
6248 # check for unnecessary blank lines around braces
6254 }
6255 }
6261 }
6262 }
6264 # no volatiles please
6268 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
6269 }
6271 # Check for user-visible strings broken across lines, which breaks the ability
6272 # to grep for the string. Make exceptions when the previous string ends in a
6273 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
6274 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
6287 }
6299 }
6301 }
6302 }
6304 # check for missing a space in a string concatenation
6308 }
6310 # check for an embedded function name in a string when the function is known
6311 # This does not work very well for -f --file checking as it depends on patch
6312 # context providing the function name or a single line form for in-file
6313 # function declarations
6319 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
6320 }
6322 # check for unnecessary function tracing like uses
6323 # This does not use $logFunctions because there are many instances like
6324 # 'dprintk(FOO, "%s()\n", __func__);' which do not match $logFunctions
6325 if ($rawline =~ /^\+.*\([^"]*"$tracing_logging_tags{0,3}%s(?:\s*\(\s*\)\s*)?$tracing_logging_tags{0,3}(?:\\n)?"\s*,\s*__func__\s*\)\s*;/) {
6330 }
6331 }
6333 # check for spaces before a quoted newline
6339 }
6341 }
6343 # concatenated string without spaces between elements
6353 }
6354 }
6355 }
6357 # uncoalesced string fragments
6365 }
6366 }
6367 }
6369 # check for non-standard and hex prefixed decimal printf formats
6375 # check for %L
6380 }
6381 # check for %Z
6386 }
6387 # check for 0x<decimal>
6391 }
6392 }
6394 # check for line continuations in quoted strings with odd counts of "
6398 }
6400 # warn about #if 0
6404 }
6406 # warn about #if 1
6410 }
6412 # check for needless "if (<foo>) fn(<foo>)" uses
6416 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
6428 }
6433 }
6436 }
6440 }
6441 }
6442 }
6443 }
6445 # check for unnecessary "Out of Memory" messages
6454 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
6456 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
6460 }
6461 }
6463 # check for logging functions with KERN_<LEVEL>
6471 }
6472 }
6474 # check for logging continuations
6478 }
6480 # check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions
6498 }
6499 }
6500 }
6502 # check for mask then right shift without a parentheses
6508 }
6510 # check for pointer comparisons to NULL
6520 }
6521 }
6522 }
6524 # check for bad placement of section $InitAttribute (e.g.: __initdata)
6527 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
6537 $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;
6538 }
6539 }
6540 }
6542 # check for $InitAttributeData (ie: __initdata) with const
6553 }
6554 }
6556 # check for $InitAttributeConst (ie: __initconst) without const
6568 }
6569 }
6571 # check for __read_mostly with const non-pointer (should just be const)
6578 }
6579 }
6581 # don't use __constant_<foo> functions outside of include/uapi/
6583 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
6591 }
6592 }
6594 # prefer usleep_range over udelay
6597 # ignore udelay's < 10, however
6600 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
6601 }
6605 }
6606 }
6608 # warn about unexpectedly long msleep's
6612 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
6613 }
6614 }
6616 # check for comparisons of jiffies
6619 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
6620 }
6622 # check for comparisons of get_jiffies_64()
6625 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
6626 }
6628 # warn about #ifdefs in C files
6629 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
6630 # print "#ifdef in C files should be avoided\n";
6631 # print "$herecurr";
6632 # $clean = 0;
6633 # }
6635 # warn about spacing in #ifdefs
6642 }
6644 }
6646 # check for spinlock_t definitions without a comment.
6653 }
6654 }
6655 # check for memory barriers without a comment.
6658 mb|
6659 rmb|
6660 wmb
6663 mb__before_atomic|
6664 mb__after_atomic|
6665 store_release|
6666 load_acquire|
6667 store_mb|
6680 }
6681 }
6691 }
6693 # check for waitqueue_active without a comment.
6698 }
6699 }
6701 # check for data_race without a comment.
6706 }
6707 }
6709 # check of hardware specific defines
6710 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
6713 }
6715 # check that the storage class is not after a type
6719 }
6720 # Check that the storage class is at the beginning of a declaration
6727 }
6729 # check the location of the inline attribute, that it is between
6730 # storage class and type.
6735 }
6737 # Check for __inline__ and __inline, prefer inline
6745 }
6746 }
6748 # Check for compiler attributes
6778 );
6793 }
6802 }
6803 }
6804 }
6806 # Check for __attribute__ unused, prefer __always_unused or __maybe_unused
6809 "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr);
6810 }
6811 }
6813 # Check for __attribute__ weak, or __weak declarations (may have link issues)
6815 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6820 }
6822 # check for c99 types like uint8_t used outside of uapi/ and tools/
6837 }
6838 }
6839 }
6841 # check for cast of C90 native int or longer types constants
6853 }
6855 "Unnecessary typecast of c90 int constant - '$cast$const' could be '$const$suffix'\n" . $herecurr) &&
6858 }
6859 }
6861 # check for sizeof(&)
6865 }
6867 # check for sizeof without parenthesis
6872 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6873 }
6874 }
6876 # check for struct spinlock declarations
6880 }
6882 # check for seq_printf uses that could be seq_puts
6891 }
6892 }
6893 }
6895 # check for vsprintf extension %p<foo> misuses
6923 }
6927 }
6929 "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");
6930 }
6931 }
6943 }
6947 }
6948 }
6949 }
6951 # Check for misused memsets
6966 }
6967 }
6969 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6970 # if ($perl_version_ok &&
6971 # defined $stat &&
6972 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6973 # if (WARN("PREFER_ETHER_ADDR_COPY",
6974 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6975 # $fix) {
6976 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6977 # }
6978 # }
6980 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6981 # if ($perl_version_ok &&
6982 # defined $stat &&
6983 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6984 # WARN("PREFER_ETHER_ADDR_EQUAL",
6985 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6986 # }
6988 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6989 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6990 # if ($perl_version_ok &&
6991 # defined $stat &&
6992 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6993 #
6994 # my $ms_val = $7;
6995 #
6996 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6997 # if (WARN("PREFER_ETH_ZERO_ADDR",
6998 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6999 # $fix) {
7000 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
7001 # }
7002 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
7003 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
7004 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
7005 # $fix) {
7006 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
7007 # }
7008 # }
7009 # }
7011 # strcpy uses that should likely be strscpy
7015 }
7017 # strlcpy uses that should likely be strscpy
7021 }
7023 # strncpy uses that should likely be strscpy or strscpy_pad
7026 "Prefer strscpy, strscpy_pad, or __nonstring over strncpy - see: https://github.com/KSPP/linux/issues/90\n" . $herecurr);
7027 }
7029 # ethtool_sprintf uses that should likely be ethtool_puts
7034 $fixed[$fixlinenr] =~ s/\bethtool_sprintf\s*\(\s*($FuncArg)\s*,\s*($FuncArg)/ethtool_puts($1, $7)/;
7035 }
7036 }
7038 # use $rawline because $line loses %s via sanitization and thus we can't match against it.
7043 $fixed[$fixlinenr] =~ s/\bethtool_sprintf\s*\(\s*($FuncArg)\s*,\s*"\%s"\s*,\s*($FuncArg)/ethtool_puts($1, $7)/;
7044 }
7045 }
7048 # typecasts on min/max could be min_t/max_t
7066 }
7069 }
7070 }
7072 # check usleep_range arguments
7080 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
7084 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
7085 }
7086 }
7088 # check for naked sscanf
7100 }
7102 # check for simple sscanf that should be kstrto<foo>
7116 }
7117 }
7118 }
7120 # check for new externs in .h files.
7127 }
7128 }
7130 # check for new externs in .c files.
7133 {
7140 }
7142 {
7145 }
7150 }
7154 {
7158 #print "Linker symbol? $st_name : $s\n";
7159 goto LIKELY_LINKER_SYMBOL
7161 }
7165 LIKELY_LINKER_SYMBOL:
7169 {
7172 }
7174 # check for function declarations that have arguments without identifier names
7176 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
7184 }
7185 }
7186 }
7188 # check for function definitions
7194 # check for multiline function definition with misplaced open brace
7204 }
7208 }
7209 }
7211 # checks for new __setup's
7217 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
7218 }
7219 }
7221 # check for pointless casting of alloc functions
7224 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
7225 }
7227 # alloc style
7228 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
7230 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
7233 }
7235 # check for (kv|k)[mz]alloc with multiplies that could be kmalloc_array/kvmalloc_array/kvcalloc/kcalloc
7238 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
7251 }
7261 $fixed[$fixlinenr] =~ s/\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)/$1 . ' = ' . "$newfunc(" . trim($r1) . ', ' . trim($r2)/e;
7262 }
7263 }
7264 }
7266 # check for krealloc arg reuse
7272 }
7274 # check for alloc argument mismatch
7278 }
7280 # check for multiple semicolons
7286 }
7287 }
7289 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
7298 }
7299 }
7301 # check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
7305 }
7307 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
7308 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(${CONFIG_}[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
7314 }
7315 }
7317 # check for /* fallthrough */ like comment, prefer fallthrough;
7326 );
7335 }
7336 }
7337 }
7339 # check for switch/default statements without a break;
7348 }
7350 # check for gcc specific __FUNCTION__
7356 }
7357 }
7359 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
7363 }
7365 # check for use of yield()
7369 }
7371 # check for comparisons against true and false
7387 }
7392 ## maybe suggesting a correct construct would better
7393 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
7395 }
7396 }
7398 # check for semaphores initialized locked
7402 }
7404 # recommend kstrto* over simple_strto* and strict_strto*
7408 }
7410 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
7413 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
7414 }
7416 # check for spin_is_locked(), suggest lockdep instead
7419 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
7420 }
7422 # check for deprecated apis
7428 }
7430 # check for various structs that are normally const (ops, kgdb, device_tree)
7431 # and avoid what seem like struct definitions 'struct foo {'
7437 }
7439 # use of NR_CPUS is usually wrong
7440 # ignore definitions of NR_CPUS and usage to define arrays as likely right
7441 # ignore designated initializers using NR_CPUS
7449 {
7451 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
7452 }
7454 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
7458 }
7460 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
7465 }
7467 # return sysfs_emit(foo, fmt, ...) fmt without newline
7475 }
7476 }
7478 # check for array definition/declarations that should use flexible arrays instead
7482 "Use C99 flexible arrays - see https://docs.kernel.org/process/deprecated.html#zero-length-and-one-element-arrays\n" . $hereprev) &&
7485 }
7486 }
7488 # nested likely/unlikely calls
7492 }
7494 # whine mightly about in_atomic
7502 }
7503 }
7505 # Complain about RCU Tasks Trace used outside of BPF (and of course, RCU).
7507 rcu_read_lock_trace |
7508 rcu_read_lock_trace_held |
7509 rcu_read_unlock_trace |
7510 call_rcu_tasks_trace |
7511 synchronize_rcu_tasks_trace |
7512 rcu_barrier_tasks_trace |
7513 rcu_request_urgent_qs_task
7514 )};
7520 include/linux/rcu
7521 )};
7526 }
7527 }
7529 # check for lockdep_set_novalidate_class
7537 }
7538 }
7543 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
7544 }
7546 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
7547 # and whether or not function naming is typical and if
7548 # DEVICE_ATTR permissions uses are unusual too
7551 $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*\)/) {
7563 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
7564 }
7571 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
7572 }
7579 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
7580 }
7591 }
7594 }
7600 }
7601 }
7603 # Mode permission misuses where it seems decimal should be octal
7604 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
7605 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
7606 # specific definition of not visible in sysfs.
7607 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
7608 # use the default permissions
7624 }
7634 }
7637 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
7638 }
7639 }
7640 }
7641 }
7643 # check for uses of S_<PERMS> that could be octal for readability
7648 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
7651 }
7652 }
7654 # validate content of MODULE_LICENSE against list from include/linux/module.h
7658 GPL|
7659 GPL\ v2|
7664 Proprietary
7669 }
7672 "Prefer \"GPL\" over \"GPL v2\" - see commit bf7fbeeae6db (\"module: Cure the MODULE_LICENSE \"GPL\" vs. \"GPL v2\" bogosity\")\n" . $herecurr) &&
7675 }
7676 }
7677 }
7679 # check for sysctl duplicate constants
7682 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
7683 }
7684 }
7686 # If we have no input at all, then there is nothing to report on
7687 # so just keep quiet.
7690 }
7692 # In mailback mode only produce a report in the negative, for
7693 # things that appear to be patches.
7696 }
7698 # This is not a patch, and we are in 'no-patch' mode so
7699 # just keep quiet.
7702 }
7707 }
7712 }
7713 }
7719 # authorsignoff values:
7720 # 0 -> missing sign off
7721 # 1 -> sign off identical
7722 # 2 -> names and addresses match, comments mismatch
7723 # 3 -> addresses match, names different
7724 # 4 -> names match, addresses different
7725 # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match
7744 }
7745 }
7746 }
7754 }
7757 # If there were any defects found and not already fixing them
7763 EOM
7764 }
7765 # If there were whitespace errors which cleanpatch can fix
7766 # then suggest that.
7773 EOM
7774 }
7775 }
7795 }
7798 }
7799 }
7807 Do _NOT_ trust the results written to this file.
7810 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
7812 EOM
7813 }
7814 }
7822 }
7823 }
7825 }