| blob | b8eb57f38c74ae2feae98f9021d2c408ab579bbb |
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
85 Options:
91 --emacs emacs compile window format
92 --terse one line per report
95 single git commit with:
99 multiple git commits with:
103 git merges are ignored
121 is all off)
123 literally
126 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
127 with potential errors corrected to the preferred
128 checkpatch style
133 runtime errors.
136 --codespellfile Use this codespell dictionary
137 --typedefsfile Read additional types from this file
146 EOM
149 }
154 }
170 # Also catch when type or level is passed through a variable
171 while ($text =~ /(?:(\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
177 }
180 }
181 }
194 }
206 }
207 }
213 }
214 }
217 }
239 }
240 }
243 }
261 }
275 }
276 }
277 }
281 }
283 }
285 # Perl's Getopt::Long allows options to take optional arguments after a space.
286 # Prevent --color by itself from consuming other arguments
290 }
291 }
293 GetOptions(
335 # Use the user provided codespell file unconditionally
338 # If /usr/share/codespell/dictionary.txt is not present, try to find it
339 # under codespell's install directory: <codespell_root>/data/dictionary.txt
343 import os.path as op
344 import codespell_lib
348 EOF
352 }
353 }
355 # $help is 1 if either -h, --help or --version is passed as option - exitcode: 0
356 # $help is 2 if invalid option is passed - exitcode: 1
372 }
387 }
389 #if no filenames are given, push '-' to read patch from stdin
392 }
394 # skip TAB size 1 to avoid additional checks on $tabsize - 1
411 }
412 }
421 }
423 }
424 }
434 ## no critic
437 }
444 }
450 }
457 }
458 }
463 }
464 }
474 __user|
475 __kernel|
476 __force|
477 __iomem|
478 __must_check|
479 __kprobes|
480 __ref|
481 __refconst|
482 __refdata|
483 __rcu|
484 __private
492 # Notes to $Attribute:
493 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
495 const|
496 volatile|
497 __percpu|
498 __nocast|
499 __safe|
500 __bitwise|
501 __packed__|
502 __packed2__|
503 __naked|
504 __maybe_unused|
505 __always_unused|
506 __noreturn|
507 __used|
508 __cold|
509 __pure|
510 __noclone|
511 __deprecated|
512 __read_mostly|
513 __ro_after_init|
514 __kprobes|
516 ____cacheline_aligned|
517 ____cacheline_aligned_in_smp|
518 ____cacheline_internodealigned_in_smp|
519 __weak|
542 <=|>=|==|!=|
543 =>|->|<<|>>|<|>|!|~|
577 )};
580 atomic_t
581 )};
586 )};
592 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
593 TP_printk|
595 panic|
596 debug|
600 )};
608 # dev_alloc_skb/netdev_alloc_skb, et al
609 dma_alloc_coherent
610 )};
620 To:|
621 Cc:
622 )};
625 [=-]*> |
626 <[=-]* |
627 \[ |
628 \] |
629 start |
630 called |
631 entered |
632 entry |
633 enter |
635 inside |
636 here |
637 begin |
639 end |
640 done |
641 leave |
642 completed |
643 out |
646 )};
652 # if underflow, return
654 }
659 }
660 }
662 }
672 # two dimensional array storing minimum edit distance
687 }
688 }
689 }
691 }
698 );
701 }
704 }
723 );
746 );
767 )};
774 );
778 );
785 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
792 );
796 #Create a search pattern for all these functions to speed up a loop below
801 }
815 );
817 #Create a search pattern for all these strings to speed up a loop below
822 }
826 S_IWUGO |
827 S_IWOTH |
828 S_IRWXUGO |
829 S_IALLUGO |
850 );
852 #Create a search pattern for all these strings to speed up a loop below
857 }
884 }
888 }
891 irq|
892 memory|
894 reboot
895 )};
896 # memory.h: ARM has a custom one
898 # Load common spelling mistakes and build regular expression list.
915 }
919 }
938 }
942 }
943 }
962 }
966 }
969 }
972 }
978 }
985 }
1003 )
1010 )
1019 )
1023 $NonptrType
1028 $NonptrTypeMisordered
1034 }
1035 build_types();
1039 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
1040 # requires at least perl version v5.10.0
1041 # Any use must be runtime checked with $^V
1051 )};
1058 );
1067 }
1072 }
1096 }
1097 }
1098 }
1108 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
1109 }
1112 }
1117 return 1 if (!$tree || which("python3") eq "" || !(-x "$root/scripts/spdxcheck.py") || !(-e "$gitroot"));
1123 }
1136 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
1147 }
1149 }
1157 }
1161 }
1166 }
1170 }
1178 }
1180 }
1181 }
1191 }
1205 # Maybe one day convert this block of bash into something that returns
1206 # all matching commit ids, but it's very slow...
1207 #
1208 # echo "checking commits $1..."
1209 # git rev-list --remotes | grep -i "^$1" |
1210 # while read line ; do
1211 # git log --format='%H %s' -1 $line |
1212 # echo "commit $(cut -c 1-12,41-)"
1213 # done
1214 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ ||
1220 }
1223 }
1234 # If input is git commits, extract all commits from the commit expressions.
1235 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1248 }
1257 }
1258 }
1261 }
1281 }
1288 }
1293 }
1300 }
1304 }
1313 build_types();
1315 }
1326 EOM
1327 }
1333 EOM
1334 }
1335 }
1346 );
1351 }
1352 }
1354 }
1379 # If there's a name left after stripping spaces and
1380 # leading quotes, and the address doesn't have both
1381 # leading and trailing angle brackets, the address
1382 # is invalid. ie:
1383 # "joe smith joe@smith.com" bad
1384 # "joe smith <joe@smith.com" bad
1389 }
1390 }
1392 # Extract comments from names excluding quoted parts
1393 # "John D. (Doe)" - Do not extract
1396 }
1399 }
1410 }
1413 }
1427 }
1438 }
1441 }
1448 }
1460 }
1468 }
1469 }
1472 }
1480 }
1481 }
1484 }
1497 }
1499 }
1502 }
1505 }
1509 }
1514 # Drop the diff line leader and expand tabs
1518 # Pick the indent from the front of the line.
1522 }
1533 }
1534 }
1545 # Always copy over the diff marker.
1551 # Comments we are whacking completely including the begin
1552 # and end, all to $;.
1559 }
1565 }
1572 }
1574 # A \ in a string means ignore the next character.
1580 }
1581 # Regular quotes.
1590 }
1591 }
1593 #print "c<$c> SQ<$sanitise_quote>\n";
1602 }
1603 }
1607 }
1609 # The pathname on a #include may be surrounded by '<' and '>'.
1614 # The whole of a #error is a string.
1618 }
1623 }
1626 }
1634 }
1657 #warn "CSB: blk<$blk> remain<$remain>\n";
1658 # If we are about to drop off the end, pull in more
1659 # context.
1670 }
1671 # Bail if there is no further context.
1672 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1675 }
1679 }
1680 }
1685 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1687 # Handle nested #if/#else.
1694 }
1696 # Statement ends at the ';' or a close '}' at the
1697 # outermost level.
1700 }
1702 # An else is really a conditional as long as its not else if
1709 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1710 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1711 }
1716 }
1724 #warn "CSB: mark coff<$coff>\n";
1725 }
1726 }
1730 }
1738 }
1740 }
1741 }
1742 # Preprocessor commands end at the newline unless escaped.
1748 }
1750 }
1751 # We are truly at the end, so shuffle to the next line.
1756 }
1761 #warn "STATEMENT<$statement>\n";
1762 #warn "CONDITION<$condition>\n";
1764 #print "coff<$coff> soff<$off> loff<$loff>\n";
1768 }
1773 # Strip the diff line prefixes and rip blank lines at start and end.
1781 }
1789 }
1810 }
1811 }
1819 # Grab the first conditional/block pair.
1822 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1826 }
1828 # Pull in the following conditional/block pairs and see if they
1829 # could continue the statement.
1833 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1835 #print "C: push\n";
1837 }
1840 }
1859 # Handle nested #if/#else.
1866 }
1869 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1873 }
1880 }
1881 }
1885 }
1888 }
1891 }
1897 }
1903 }
1909 }
1914 }
1919 }
1924 # If c99 comment on the current line, or the line before or after
1932 # Catch a comment on the end of the line itself.
1936 # Look through the context and try and figure out if there is a
1937 # comment.
1942 #warn " $line\n";
1945 }
1948 }
1951 }
1955 }
1956 }
1960 }
1965 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1966 ##print "CMMT: $cmt\n";
1969 }
1982 }
1985 }
1993 }
1996 }
2004 }
2007 }
2019 }
2020 }
2024 }
2036 }
2056 }
2077 }
2106 # Assume all arms of the conditional end as this
2107 # one does, and continue as if the #endif was not here.
2124 }
2155 }
2167 }
2200 }
2215 }
2224 }
2228 }
2232 }
2233 }
2236 }
2245 DEFINE_\S+
2246 )$|
2250 case|
2254 \#|
2255 \#\#|
2261 # Check for modifiers.
2272 }
2273 }
2278 }
2279 build_types();
2282 }
2283 }
2295 }
2303 }
2312 }
2313 }
2318 }
2326 }
2330 }
2336 }
2341 }
2345 }
2356 }
2357 }
2384 }
2390 }
2397 }
2402 }
2405 }
2408 }
2416 };
2418 }
2426 };
2429 }
2438 }
2440 }
2448 }
2450 }
2458 }
2460 }
2466 ##print "absolute<$absolute>\n";
2468 # See if any suffix of this path is a path within the tree.
2471 ##print "file<$file>\n";
2473 }
2474 }
2477 }
2479 # It is, so see if the prefix is acceptable.
2483 ##print "prefix<$prefix>\n";
2487 }
2488 }
2496 }
2504 }
2512 }
2520 }
2529 #convert leading spaces to tabs
2531 #Remove spaces before a tab
2535 }
2549 }
2561 }
2562 }
2565 }
2574 }
2575 }
2578 }
2580 # Args:
2581 # line: Patch line to check
2582 # auto: Auto variable name, e.g. "per_child_auto"
2583 # suffix: Suffix to expect on member, e.g. "_priv"
2584 # warning: Warning name, e.g. "PRIV_AUTO"
2588 # Use _priv as a suffix for the device-private data struct
2595 }
2596 }
2597 }
2599 # Checks specific to U-Boot
2603 # ask for a test if a new uclass ID is added
2606 "Possible new uclass - make sure to add a sandbox driver, plus a test in test/dm/<name>.c\n" . $herecurr);
2607 }
2609 # try to get people to use the livetree API, except when changing tooling
2613 }
2615 # add tests for new commands
2619 }
2621 # use if instead of #if
2625 }
2627 # prefer strl(cpy|cat) over strn(cpy|cat)
2630 "strl$1 is preferred over strn$1 because it always produces a nul-terminated string\n" . $herecurr);
2631 }
2633 # use Kconfig for all CONFIG symbols
2637 }
2639 # Don't put dm.h in header files
2643 }
2645 # Don't add common.h to files
2649 }
2651 # Do not disable fdt / initrd relocation
2655 }
2657 # make sure 'skip_board_fixup' is not
2661 }
2663 # Do not use CONFIG_ prefix in CONFIG_IS_ENABLED() calls
2667 }
2669 # Use _priv as a suffix for the device-private data struct
2674 }
2675 }
2677 # Check struct names for the 'auto' members of struct driver
2684 # Now the ones for struct uclass, skipping those in common with above
2690 # Avoid using the pre-schema driver model tags
2694 }
2695 }
2700 # Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c).
2704 }
2749 # Trace the real file/line as we go.
2762 # suppression flags
2770 # Pre-scan the patch sanitizing the lines.
2771 # Pre-scan the patch looking for any __setup documentation.
2772 #
2780 sanitise_line_reset();
2792 }
2793 #next;
2794 }
2801 }
2804 # Guestimate if this is a continuing comment. Run
2805 # the context looking for a comment "edge". If this
2806 # edge is a close comment then we must be in a comment
2807 # at context start.
2814 #print "RAW<$rawlines[$ln - 1]>\n";
2820 }
2821 }
2824 }
2826 # Guestimate if this is a continuing comment. If this
2827 # is the start of a diff block and this line starts
2828 # ' *' then it is very likely a comment.
2831 {
2833 }
2835 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2839 # Standardise the strings and chars within the input to
2840 # simplify matching -- only bother with positive lines.
2842 }
2849 }
2851 #print "==>$rawline\n";
2852 #print "-->$line\n";
2856 }
2857 }
2873 # check if it's a mode change, rename or start of a patch
2879 }
2881 #extract the line range in the file after the patch is applied
2892 }
2893 annotate_reset();
2904 }
2907 # track the line number as we move through the hunk, note that
2908 # new versions of GNU diff omit the leading space on completely
2909 # blank context lines so we need to count that too.
2914 # Measure the line length and indent.
2917 # Track the previous line.
2922 #warn "line<$line>\n";
2926 }
2934 # extract the filename as it passes
2950 }
2954 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2955 }
2957 }
2959 #make up the handle for any error we report on this line
2967 }
2968 }
2973 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2974 }
2979 }
2990 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
2991 }
2992 }
2995 }
3005 # Verify the existence of a commit log if appropriate
3006 # 2 is used because a $signature is counted in $commit_log_lines
3010 }
3015 }
3017 # Check if the commit log has what seems like a diff which can confuse patch
3026 }
3028 # Check for incorrect file permissions
3035 }
3036 }
3038 # Check the patch for a From:
3044 }
3048 }
3050 # Check the patch for a signoff:
3077 }
3080 }
3083 }
3084 }
3085 }
3086 }
3087 }
3089 # Check for patch separator
3093 }
3095 # Check if MAINTAINERS is being updated. If so, there's probably no need to
3096 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
3099 }
3101 # Check signature styles
3120 }
3121 }
3122 }
3129 }
3130 }
3137 }
3139 }
3146 }
3147 }
3158 # Don't force email to have quotes
3159 # Allow just an angle bracketed address
3165 }
3166 }
3168 # Address part shouldn't have comments
3176 }
3177 }
3179 # Only one name comment should be allowed
3184 }
3187 # stable@vger.kernel.org or stable@kernel.org shouldn't
3188 # have an email name. In addition comments should strictly
3189 # begin with a #
3197 # Remove brackets enclosing comment text
3198 # and # from start of comments to get comment text
3211 }
3212 }
3216 # Extract comment text from within brackets or
3217 # c89 style /*...*/ comments
3222 $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo
3230 }
3231 }
3232 }
3234 # Check for duplicate signatures
3243 }
3245 # Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
3249 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
3250 }
3256 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
3259 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
3260 }
3261 }
3262 }
3264 # Check email subject for common tools that don't need to be mentioned
3269 }
3271 # Check for Gerrit Change-Ids not in any patch context
3277 }
3278 }
3280 # Check if the commit log is in a possible stack dump
3284 # timestamp
3288 # stack dump address styles
3290 }
3292 # Check for line lengths > 75 in commit log, warn once
3296 # file delta changes
3298 # filename then :
3300 # A Fixes: or Link: line or signature tag line
3305 }
3307 # Reset possible stack dump if a blank line is found
3311 }
3313 # Check for lines starting with a #
3319 }
3320 }
3322 # Check for git id commit length and improperly formed commit descriptions
3323 # A correctly formed commit description is:
3324 # commit <SHA-1 hash length 12+ chars> ("Complete commit subject")
3325 # with the commit subject '("' prefix and '")' suffix
3326 # This is a fairly compilicated block as it tests for what appears to be
3327 # bare SHA-1 hash with minimum length of 5. It also avoids several types of
3328 # possible SHA-1 matches.
3329 # A commit match can span multiple lines so this block attempts to find a
3330 # complete typical commit on a maximum of 3 lines
3336 ($line =~ /\bcommit\s*$/i && defined($rawlines[$linenr]) && $rawlines[$linenr] =~ /^\s*[0-9a-f]{5,}\b/i)) ||
3359 # Always strip leading/trailing parens then double quotes if existing
3364 }
3366 }
3370 }
3372 }
3383 }
3392 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herectx);
3393 }
3394 #don't report the next line if this line ends in commit and the sha1 hash is the next line
3396 }
3398 # Check for added, moved or deleted files
3408 }
3410 # Check for adding new DT bindings not in schema format
3415 "DT bindings should be in DT schema format. See: Documentation/devicetree/bindings/writing-schema.rst\n");
3416 }
3418 # Check for wrappage within a valid hunk of the file
3423 }
3425 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
3436 }
3438 # Check if it's the start of a commit log
3439 # (not a header line and we haven't seen the patch filename)
3446 }
3448 # Check if there is UTF-8 in a commit log when a mail header has explicitly
3449 # declined it, i.e defined some charset where it is missing.
3454 }
3460 }
3462 # Check for absolute kernel paths in commit message
3469 #
3472 }
3473 }
3474 }
3476 # Check for various typo / spelling mistakes
3493 }
3494 }
3495 }
3497 # check for invalid commit id
3505 }
3506 }
3508 # check for repeated words separated by a single space
3509 # avoid false positive from list command eg, '-rw-r--r-- 1 root root'
3522 }
3527 # check for character before and after the word matches
3536 # avoid repeating hex occurrences like 'ff ff fe 09 ...'
3539 }
3545 }
3546 }
3548 # if it's a repeated word on consecutive lines in a comment block
3557 }
3558 }
3559 }
3560 }
3562 # ignore non-hunk lines and lines being removed
3565 #trailing whitespace
3572 }
3579 }
3582 }
3584 # Check for FSF mailing addresses.
3593 "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)
3594 }
3596 # check for Kconfig help text having a real description
3597 # Only applies when adding the entry originally, after that we do not have
3598 # sufficient context to determine whether it is indeed long enough.
3600 # 'choice' is usually the last thing on the line (though
3601 # Kconfig supports named choices), so use a word boundary
3602 # (\b) rather than a whitespace character (\s)
3622 }
3629 # This only checks context lines in the patch
3630 # and so hopefully shouldn't trigger false
3631 # positives, even though some of these are
3632 # common words in help texts
3637 }
3639 }
3643 }
3644 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3645 }
3647 # check MAINTAINERS entries
3649 # check MAINTAINERS entries for the right form
3656 }
3657 }
3658 # check MAINTAINERS entries for the right ordering too
3682 }
3683 }
3684 }
3685 }
3695 };
3698 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3699 }
3701 # check for DT compatible documentation
3720 }
3727 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3728 }
3729 }
3730 }
3732 # check for using SPDX license tag at beginning of files
3746 }
3748 # check SPDX comment style for .[chsS] files
3754 }
3765 }
3774 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3775 }
3776 }
3777 }
3778 }
3779 }
3781 # check for embedded filenames
3785 }
3787 # check we are in a valid source file if not then ignore this hunk
3790 # check for using SPDX-License-Identifier on the wrong line number
3796 }
3798 # line length limit (with some exclusions)
3799 #
3800 # There are a few types of lines that may extend beyond $max_line_length:
3801 # logging functions like pr_info that end in a string
3802 # lines with a single string
3803 # #defines that are a single string
3804 # lines with an RFC3986 like URL
3805 #
3806 # There are 3 different line length message types:
3807 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3808 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3809 # LONG_LINE all other lines longer than $max_line_length
3810 #
3811 # if LONG_LINE is ignored, the other 2 types are also ignored
3812 #
3817 # Check the allowed long line types first
3819 # logging functions that end in a string that starts
3820 # before $max_line_length
3821 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3825 # lines with only strings (w/ possible termination)
3826 # #defines with only strings
3831 # More special cases
3836 # URL ($rawline is used in case the URL is in a comment)
3840 # Otherwise set the alternate message types
3842 # a comment starts before $max_line_length
3847 # a quoted string starts before $max_line_length
3851 }
3859 }
3860 }
3862 # check for adding lines without a newline.
3863 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3868 }
3869 }
3871 # check for .L prefix local symbols in .S files
3875 "Avoid using '.L' prefixed local symbol names for denoting a range of code via 'SYM_*_START/END' annotations; see Documentation/asm-annotations.rst\n" . $herecurr);
3876 }
3880 }
3882 # check we are in a valid source file C or perl if not then ignore this hunk
3885 # at the beginning of a line any tabs must come first and anything
3886 # more than $tabsize must use tabs.
3895 }
3896 }
3898 # check for space before tabs.
3908 }
3909 }
3911 # check for assignments on the start of a line
3917 # add assignment operator to the previous line, remove from current line
3920 }
3921 }
3923 # check for && or || at the start of a line
3929 # insert logical operator at last non-comment, non-whitepsace char on previous line
3934 }
3935 }
3937 # check indentation starts on a tab stop
3939 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3946 }
3947 }
3948 }
3950 # check multi-line statement indentation matches previous line
3952 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3975 }
3976 }
3977 }
3978 }
3980 # check for space after cast like "(int) foo" or "(struct foo) bar"
3981 # avoid checking a few false positives:
3982 # "sizeof(<type>)" or "__alignof__(<type>)"
3983 # function pointer declarations like "(*foo)(int) = bar;"
3984 # structure definitions like "(struct foo) { 0 };"
3985 # multiline macros that define functions
3986 # known attributes or the __attribute__ keyword
3994 }
3995 }
3997 # Block comment styles
3998 # Networking with an initial /*
4002 $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier
4005 }
4007 # Block comments use * on subsequent lines
4015 }
4017 # Block comments use */ on trailing lines
4024 }
4026 # Block comment * alignment
4040 }
4047 }
4048 }
4050 # check for missing blank lines after struct/union declarations
4051 # with exceptions for various attributes and macros
4067 }
4068 }
4070 # check for multiple consecutive blank lines
4078 }
4081 }
4083 # check for missing blank lines after declarations
4084 # (declarations must have the same indentation and not be at the start of line)
4086 # use temporaries
4089 # remove $Attribute/$Sparse uses to simplify comparisons
4093 # function pointer declarations
4095 # foo bar; where foo is some local typedef or #define
4097 # known declaration macros
4099 # for "else if" which can look like "$Ident $Ident"
4101 # other possible extensions of declaration lines
4103 # not starting a section or a macro "\" extended line
4105 # looks like a declaration
4107 # function pointer declarations
4109 # foo bar; where foo is some local typedef or #define
4111 # known declaration macros
4113 # start of struct or union or enum
4115 # start or end of block or continuation of declaration
4117 # bitfield continuation
4119 # other possible extensions of declaration lines
4125 }
4126 }
4127 }
4129 # check for spaces at the beginning of a line.
4130 # Exceptions:
4131 # 1) within comments
4132 # 2) indented preprocessor commands
4133 # 3) hanging labels
4140 }
4141 }
4143 # check we are in a valid C source file if not then ignore this hunk
4146 # check for unusual line ending [ or (
4150 }
4152 # check if this appears to be the start function declaration, save the name
4156 }
4158 # check if this appears to be the end of function declaration
4161 }
4163 # check indentation of any line with a bare else
4164 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
4165 # if the previous line is a break or return and is indented 1 tab more...
4174 }
4175 }
4177 # check indentation of a line with a break;
4178 # if the previous line is a goto, return or break
4179 # and is indented the same # of tabs
4187 }
4188 }
4189 }
4191 # check for RCS/CVS revision markers
4195 }
4197 # check for old HOTPLUG __dev<foo> section markings
4201 }
4203 # Check for potential 'bare' types
4206 #print "LINE<$line>\n";
4214 #print "linenr<$linenr> <$stat>\n";
4215 # If this statement has no statement boundaries within
4216 # it there is no point in retrying a statement scan
4217 # until we hit end of it.
4220 #print "skip<$line_nr_next>\n";
4222 }
4224 # Find the real next line.
4230 }
4235 # Ignore goto labels.
4238 # Ignore functions being called
4243 # declarations always start with types
4244 } 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) {
4249 # definitions in global scope can only start with types
4252 }
4254 # any (foo ... *) is a pointer cast, and foo is a type
4257 }
4259 # Check for any sort of function declaration.
4260 # int foo(something bar, other baz);
4261 # void (*store_gdt)(x86_descr_ptr *);
4262 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
4270 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
4273 }
4274 }
4275 }
4277 }
4279 #
4280 # Checks which may be anchored in the context.
4281 #
4283 # Check for switch () and associated case and default
4284 # statements should be at the same indent.
4298 }
4299 }
4303 }
4304 }
4306 # if/while/etc brace do not go on next line, unless defining a do while loop,
4307 # or if that brace on the next line is for something else
4308 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
4316 }
4327 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
4330 }
4332 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
4333 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
4339 }
4343 {
4349 }
4350 }
4351 }
4353 # Check relative indent for conditionals and blocks.
4354 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
4362 # remove inline comments
4366 # Find out how long the conditional actually is.
4370 # Make sure we remove the line prefixes as we have
4371 # none on the first line, and are going to readd them
4372 # where necessary.
4376 }
4378 # We want to check the first line inside the block
4379 # starting at the end of the conditional, so remove:
4380 # 1) any blank line termination
4381 # 2) any opening brace { on end of the line
4382 # 3) any do (...) {
4389 }
4393 }
4395 # Also ignore a loop construct at the end of a
4396 # preprocessor statement.
4400 }
4407 # If we see an #else/#elif then the code
4408 # is not linear.
4411 }
4413 # Ignore:
4414 # 1) blank lines, they should be at 0,
4415 # 2) preprocessor lines, and
4416 # 3) labels.
4424 }
4425 }
4426 }
4431 # Check if either of these lines are modified, else
4432 # this is not this patch's fault.
4436 }
4439 }
4441 #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";
4450 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
4451 }
4452 }
4454 # Track the 'values' across context and added lines.
4464 }
4467 #ignore lines not being added
4470 # check for self assignments used to avoid compiler warnings
4471 # e.g.: int foo = foo, *bar = NULL;
4472 # struct foo bar = *(&(bar));
4475 if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) {
4478 }
4479 }
4481 # check for dereferences that span multiple lines
4491 }
4493 # check for declarations of signed or unsigned without int
4494 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
4505 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
4513 }
4514 }
4515 }
4517 # TEST: allow direct testing of the type matcher.
4525 }
4527 }
4528 # TEST: allow direct testing of the attribute matcher.
4536 }
4538 }
4540 # check for initialisation to aggregates open brace on the next line
4554 }
4555 }
4557 #
4558 # Checks which are anchored on the added line.
4559 #
4561 # check for malformed paths in #include statements (uses RAW line)
4567 }
4571 }
4572 }
4574 # no C99 // comments
4583 }
4584 }
4585 }
4586 # Remove C99 comments.
4590 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4591 # the whole statement.
4592 #print "APW <$lines[$realline_next - 1]>\n";
4597 # Handle definitions which produce identifiers with
4598 # a prefix:
4599 # XXX(foo);
4600 # EXPORT_SYMBOL(something_foo);
4605 #print "FOO C name<$name>\n";
4616 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4620 }
4621 }
4625 #print "FOO B <$lines[$linenr - 1]>\n";
4627 }
4632 }
4634 # check for global initialisers.
4641 }
4642 }
4643 # check for static initialisers.
4650 }
4651 }
4653 # check for misordered declarations of char/short/int/long with signed/unsigned
4657 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4658 }
4660 # check for unnecessary <signed> int declarations of short/long/long long
4677 }
4678 }
4680 # check for static const char * arrays.
4685 }
4687 # check for initialized const char arrays that should be static const
4688 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4693 }
4694 }
4696 # check for static char foo[] = "bar" declarations.
4701 }
4703 # check for const <foo> const where <foo> is not a pointer or array type
4712 }
4713 }
4715 # check for const static or static <non ptr type> const declarations
4716 # prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const'
4724 }
4725 }
4727 # check for non-global char *foo[] = {"bar", ...} declarations.
4732 }
4734 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4737 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4743 }
4744 }
4745 }
4747 # check for function declarations without arguments like "int foo()"
4753 }
4754 }
4756 # check for new typedefs, only function parameters and sparse annotations
4757 # make sense.
4765 }
4767 # * goes on variable not on type
4768 # (char*[ const])
4770 #print "AA<$1>\n";
4773 # Should start with a space.
4775 # Should not end with a space.
4777 # '*'s should not have spaces between.
4779 }
4781 ## print "1: from<$from> to<$to> ident<$ident>\n";
4791 }
4792 }
4793 }
4795 #print "BB<$1>\n";
4798 # Should start with a space.
4800 # Should not end with a space.
4802 # '*'s should not have spaces between.
4804 }
4805 # Modifiers should have spaces.
4808 ## print "2: from<$from> to<$to> ident<$ident>\n";
4819 }
4820 }
4821 }
4823 # avoid BUG() or BUG_ON()
4828 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4829 }
4831 # avoid LINUX_VERSION_CODE
4834 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4835 }
4837 # check for uses of printk_ratelimit
4841 }
4843 # printk should use KERN_* levels
4847 }
4849 # prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL>
4862 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to $printk(KERN_$orig ...\n" . $herecurr);
4863 }
4865 # prefer dev_<level> to dev_printk(KERN_<LEVEL>
4873 }
4875 # trace_printk should not be used in production code.
4878 "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr);
4879 }
4881 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4882 # number of false positives, but assembly files are not checked, so at
4883 # least the arch entry code will not trigger this warning.
4887 }
4889 # ENOTSUPP is not a standard error code and should be avoided in new patches.
4890 # Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4891 # Similarly to ENOSYS warning a small number of false positives is expected.
4897 }
4898 }
4900 # function brace can't be on same line, except for #defines of do while,
4901 # or if closed on same line
4918 }
4919 }
4920 }
4922 # open braces for enum, union and struct go on the same line.
4936 }
4937 }
4938 }
4940 # missing space after union, struct or enum definition
4947 }
4948 }
4950 # Function pointer declarations
4951 # check spacing between type, funcptr, and args
4952 # canonical declaration is "type (*funcptr)(args...)"
4961 # the $Declare variable will capture all spaces after the type
4962 # so check it for a missing trailing missing space but pointer return types
4963 # don't need a space so don't warn for those.
4968 }
4973 }
4975 # unnecessary space "type (*funcptr)(args...)"
4976 # This test is not currently implemented because these declarations are
4977 # equivalent to
4978 # int foo(int bar, ...)
4979 # and this is form shouldn't/doesn't generate a checkpatch warning.
4980 #
4981 # elsif ($declare =~ /\s{2,}$/) {
4982 # WARN("SPACING",
4983 # "Multiple spaces after return type\n" . $herecurr);
4984 # }
4986 # unnecessary space "type ( *funcptr)(args...)"
4991 }
4993 # unnecessary space "type (* funcptr)(args...)"
4998 }
5000 # unnecessary space "type (*funcptr )(args...)"
5005 }
5007 # unnecessary space "type (*funcptr) (args...)"
5012 }
5016 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
5017 }
5018 }
5020 # check for spacing round square brackets; allowed:
5021 # 1. with a type on the left -- int [] a;
5022 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
5023 # 3. inside a curly brace -- = { [0...10] = 5 }
5034 }
5035 }
5036 }
5038 # check for spaces between functions and their parentheses.
5044 # Ignore those directives where spaces _are_ permitted.
5050 {
5051 # cpp #define statements have non-optional spaces, ie
5052 # if there is a space between the name and the open
5053 # parenthesis it is simply not a parameter group.
5056 # cpp #elif statement condition may start with a (
5059 # If this whole things ends with a type its most
5060 # likely a typedef for a function.
5069 }
5070 }
5071 }
5073 # Check operator spacing.
5079 <<=|>>=|<=|>=|==|!=|
5081 =>|->|<<|>>|<|>|=|!|~|
5087 ## print("element count: <" . $#elements . ">\n");
5088 ## foreach my $el (@elements) {
5089 ## print("el: <$el>\n");
5090 ## }
5098 }
5109 ## print("n: <$n> good: <$good>\n");
5113 # Pick up the preceding and succeeding characters.
5118 }
5141 }
5150 # Pull out the value of this operator.
5153 # Get the full operator variant.
5156 # Ignore operators passed as parameters.
5160 # # Ignore comments
5161 # } elsif ($op =~ /^$;+$/) {
5163 # ; should have either the end of line or a space or \ after it
5171 }
5172 }
5174 # // is a comment
5177 # : when part of a bitfield
5179 # skip the bitfield test for now
5181 # No spaces for:
5182 # ->
5190 }
5192 }
5193 }
5195 # , must not have a space before and must have a space on the right.
5204 }
5205 }
5212 }
5213 }
5219 }
5222 }
5223 }
5225 # '*' as part of a type definition -- reported already.
5227 #warn "'*' is part of type\n";
5229 # unary operators should have a space before and
5230 # none after. May be left adjacent to another
5231 # unary operator, or a cast
5241 }
5242 }
5243 }
5245 # A unary '*' may be const
5253 }
5255 }
5256 }
5258 # unary ++ and unary -- are allowed no space on one side.
5265 }
5266 }
5273 }
5274 }
5281 }
5283 }
5284 }
5286 # << and >> may either have or not have spaces both sides
5292 {
5300 }
5306 }
5307 }
5314 }
5316 }
5317 }
5319 # A colon needs no spaces before when it is
5320 # terminating a case value or a label.
5327 }
5328 }
5330 # All the others need spaces both sides.
5334 # Ignore email addresses <foo@bar>
5339 {
5341 }
5343 # for asm volatile statements
5344 # ignore a colon with another
5345 # colon immediately before or after
5349 }
5351 # messages are ERROR, but ?: are CHK
5361 }
5363 }
5364 }
5365 }
5368 ## print("n: <$n> GOOD: <$good>\n");
5371 }
5375 }
5379 }
5382 }
5384 # check for whitespace before a non-naked semicolon
5391 }
5392 }
5394 # check for multiple assignments
5398 }
5400 ## # check for multiple declarations, allowing for a function declaration
5401 ## # continuation.
5402 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
5403 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
5404 ##
5405 ## # Remove any bracketed sections to ensure we do not
5406 ## # falsely report the parameters of functions.
5407 ## my $ln = $line;
5408 ## while ($ln =~ s/\([^\(\)]*\)//g) {
5409 ## }
5410 ## if ($ln =~ /,/) {
5411 ## WARN("MULTIPLE_DECLARATION",
5412 ## "declaring multiple variables together should be avoided\n" . $herecurr);
5413 ## }
5414 ## }
5416 #need space before brace following if, while, etc
5423 }
5424 }
5426 ## # check for blank lines before declarations
5427 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
5428 ## $prevrawline =~ /^.\s*$/) {
5429 ## WARN("SPACING",
5430 ## "No blank lines before declarations\n" . $hereprev);
5431 ## }
5432 ##
5434 # closing brace should have a space following it when it has anything
5435 # on the line
5442 }
5443 }
5445 # check spacing on square brackets
5452 }
5453 }
5460 }
5461 }
5463 # check spacing on parentheses
5471 }
5472 }
5481 }
5482 }
5484 # check unnecessary parentheses around addressof/dereference single $Lvals
5485 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
5493 }
5494 }
5496 # check for unnecessary parentheses around function pointer uses
5497 # ie: (foo->bar)(); should be foo->bar();
5498 # but not "if (foo->bar) (" to avoid some false positives
5507 }
5508 }
5510 # check for unnecessary parentheses around comparisons in if uses
5511 # when !drivers/staging or command-line uses --strict
5518 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
5520 # avoid parentheses around potential macro args
5529 }
5530 }
5533 }
5534 }
5536 # check that goto labels aren't indented (allow a single space indentation)
5537 # and ignore bitfield definitions like foo:1
5538 # Strictly, labels can have whitespace after the identifier and before the :
5539 # but this is not allowed here as many ?: uses would appear to be labels
5548 }
5549 }
5551 # check if a statement with a comma should be two statements like:
5552 # foo = bar(), /* comma should be semicolon */
5553 # bar = baz();
5555 $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
5560 }
5562 # return is not a function
5572 }
5576 }
5577 }
5579 # unnecessary return in a void function
5580 # at end-of-function, with the previous line a single leading tab, then return;
5581 # and the line before that not a goto label target like "out:"
5589 }
5591 # if statements using unnecessary parentheses - ie: if ((foo == bar))
5597 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
5602 }
5603 }
5605 # comparisons with a constant or upper case identifier on the left
5606 # avoid cases like "foo + BAR < baz"
5607 # only fix matches surrounded by parentheses to avoid incorrect
5608 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
5629 }
5631 }
5632 }
5634 # Return of what appears to be an errno should normally be negative
5640 }
5641 }
5643 # Need a space before open parenthesis after if, while etc
5650 }
5651 }
5653 # Check for illegal assignment in if conditional -- and check for trailing
5654 # statements after the conditional.
5662 ##print "stat<$stat> stat_next<$stat_next>\n";
5665 # If the statement carries leading newlines,
5666 # then count those as offsets.
5674 }
5675 }
5685 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5704 }
5705 }
5706 }
5708 # Find out what is on the end of the line after the
5709 # conditional.
5715 {
5716 # Find out how long the conditional actually is.
5725 }
5729 }
5730 }
5732 # Check for bitwise tests written as boolean
5738 |
5743 {
5746 }
5748 # if and else should not have general statements after it
5755 }
5756 }
5757 # if should not continue a brace
5762 }
5763 # case and default should not have general statements after them
5769 {
5772 }
5774 # Check for }<nl>else {, these must be at the same
5775 # indent level to be relevant to each other.
5787 }
5791 }
5792 }
5798 # Find out what is on the end of the line after the
5799 # conditional.
5815 }
5816 }
5817 }
5819 #Specific variable tests
5823 #CamelCase
5826 #Ignore some autogenerated defines and enum values
5828 #Ignore Page<foo> variants
5830 #Ignore SI style variants like nS, mV and dB
5831 #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5833 #Ignore some three character SI units explicitly, like MiB and KHz
5839 seed_camelcase_includes();
5843 }
5844 }
5849 }
5850 }
5851 }
5852 }
5854 #no spaces allowed after \ in define
5860 }
5861 }
5863 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5864 # itself <asm/foo.h> (uses RAW line)
5871 {
5880 }
5881 }
5882 }
5883 }
5885 # multi-statement macros should be enclosed in a do while loop, grab the
5886 # first statement and ensure its the whole macro if its not enclosed
5887 # in a known good container
5899 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5900 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5915 }
5922 # Flatten any parentheses and braces
5926 {
5927 }
5929 # Flatten any obvious string concatenation.
5932 {
5933 }
5935 # Make asm volatile uses seem like a generic function
5940 module_param_named|
5941 MODULE_PARM_DESC|
5942 DECLARE_PER_CPU|
5943 DEFINE_PER_CPU|
5944 __typeof__\(|
5945 union|
5946 struct|
5951 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5960 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5965 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5972 {
5975 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5982 }
5984 }
5986 # Make $define_stmt single line, comment-free, etc
5997 }
5998 }
6003 # check if any macro arguments are reused (ignore '...' and 'type')
6008 $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;
6015 }
6016 # check if any macro arguments may have other precedence issues
6022 }
6023 }
6025 # check for macros with flow control, but without ## concatenation
6026 # ## concatenation is commonly a macro that defines a function so ignore those
6033 }
6035 # check for line continuations outside of #defines, preprocessor #, and asm
6044 }
6045 }
6047 # do {} while (0) macro tests:
6048 # single-statement macros do not need to be enclosed in do while (0) loop,
6049 # macro should not end with a semicolon
6064 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
6076 }
6080 }
6088 }
6089 }
6091 # check for redundant bracing round if etc
6095 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
6096 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
6106 # If the condition carries leading newlines, then count those as offsets.
6111 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
6113 # We have looked at and allowed this specific line.
6123 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
6125 #print "APW: ALLOWED: cond<$cond>\n";
6127 }
6129 #print "APW: ALLOWED: block<$block>\n";
6131 }
6133 #print "APW: ALLOWED: lines block<$block>\n";
6135 }
6137 }
6142 }
6150 }
6151 }
6152 }
6153 }
6158 # Check the pre-context.
6160 #print "APW: ALLOWED: pre<$1>\n";
6162 }
6167 # Check the condition.
6169 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
6172 }
6174 #print "APW: ALLOWED: cond<$cond>\n";
6176 }
6178 #print "APW: ALLOWED: block<$block>\n";
6180 }
6182 #print "APW: ALLOWED: lines block<$block>\n";
6184 }
6185 # Check the post-context.
6190 }
6192 #print "APW: ALLOWED: chunk-1 block<$block>\n";
6194 }
6195 }
6202 }
6203 }
6205 # check for single line unbalanced braces
6209 }
6211 # check for unnecessary blank lines around braces
6217 }
6218 }
6224 }
6225 }
6227 # no volatiles please
6231 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
6232 }
6234 # Check for user-visible strings broken across lines, which breaks the ability
6235 # to grep for the string. Make exceptions when the previous string ends in a
6236 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
6237 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
6250 }
6262 }
6264 }
6265 }
6267 # check for missing a space in a string concatenation
6271 }
6273 # check for an embedded function name in a string when the function is known
6274 # This does not work very well for -f --file checking as it depends on patch
6275 # context providing the function name or a single line form for in-file
6276 # function declarations
6282 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
6283 }
6285 # check for unnecessary function tracing like uses
6286 # This does not use $logFunctions because there are many instances like
6287 # 'dprintk(FOO, "%s()\n", __func__);' which do not match $logFunctions
6288 if ($rawline =~ /^\+.*\([^"]*"$tracing_logging_tags{0,3}%s(?:\s*\(\s*\)\s*)?$tracing_logging_tags{0,3}(?:\\n)?"\s*,\s*__func__\s*\)\s*;/) {
6293 }
6294 }
6296 # check for spaces before a quoted newline
6302 }
6304 }
6306 # concatenated string without spaces between elements
6316 }
6317 }
6318 }
6320 # uncoalesced string fragments
6328 }
6329 }
6330 }
6332 # check for non-standard and hex prefixed decimal printf formats
6338 # check for %L
6343 }
6344 # check for %Z
6349 }
6350 # check for 0x<decimal>
6354 }
6355 }
6357 # check for line continuations in quoted strings with odd counts of "
6361 }
6363 # warn about #if 0
6367 }
6369 # warn about #if 1
6373 }
6375 # check for needless "if (<foo>) fn(<foo>)" uses
6379 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
6391 }
6396 }
6399 }
6403 }
6404 }
6405 }
6406 }
6408 # check for unnecessary "Out of Memory" messages
6417 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
6419 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
6423 }
6424 }
6426 # check for logging functions with KERN_<LEVEL>
6434 }
6435 }
6437 # check for logging continuations
6441 }
6443 # check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions
6461 }
6462 }
6463 }
6465 # check for mask then right shift without a parentheses
6471 }
6473 # check for pointer comparisons to NULL
6483 }
6484 }
6485 }
6487 # check for bad placement of section $InitAttribute (e.g.: __initdata)
6490 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
6500 $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;
6501 }
6502 }
6503 }
6505 # check for $InitAttributeData (ie: __initdata) with const
6516 }
6517 }
6519 # check for $InitAttributeConst (ie: __initconst) without const
6531 }
6532 }
6534 # check for __read_mostly with const non-pointer (should just be const)
6541 }
6542 }
6544 # don't use __constant_<foo> functions outside of include/uapi/
6546 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
6554 }
6555 }
6557 # prefer usleep_range over udelay
6560 # ignore udelay's < 10, however
6563 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
6564 }
6568 }
6569 }
6571 # warn about unexpectedly long msleep's
6575 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
6576 }
6577 }
6579 # check for comparisons of jiffies
6582 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
6583 }
6585 # check for comparisons of get_jiffies_64()
6588 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
6589 }
6591 # warn about #ifdefs in C files
6592 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
6593 # print "#ifdef in C files should be avoided\n";
6594 # print "$herecurr";
6595 # $clean = 0;
6596 # }
6598 # warn about spacing in #ifdefs
6605 }
6607 }
6609 # check for spinlock_t definitions without a comment.
6616 }
6617 }
6618 # check for memory barriers without a comment.
6621 mb|
6622 rmb|
6623 wmb
6626 mb__before_atomic|
6627 mb__after_atomic|
6628 store_release|
6629 load_acquire|
6630 store_mb|
6643 }
6644 }
6654 }
6656 # check for waitqueue_active without a comment.
6661 }
6662 }
6664 # check for data_race without a comment.
6669 }
6670 }
6672 # check of hardware specific defines
6673 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
6676 }
6678 # check that the storage class is not after a type
6682 }
6683 # Check that the storage class is at the beginning of a declaration
6690 }
6692 # check the location of the inline attribute, that it is between
6693 # storage class and type.
6698 }
6700 # Check for __inline__ and __inline, prefer inline
6708 }
6709 }
6711 # Check for compiler attributes
6741 );
6756 }
6765 }
6766 }
6767 }
6769 # Check for __attribute__ unused, prefer __always_unused or __maybe_unused
6772 "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr);
6773 }
6774 }
6776 # Check for __attribute__ weak, or __weak declarations (may have link issues)
6778 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6783 }
6785 # check for c99 types like uint8_t used outside of uapi/ and tools/
6800 }
6801 }
6802 }
6804 # check for cast of C90 native int or longer types constants
6816 }
6818 "Unnecessary typecast of c90 int constant - '$cast$const' could be '$const$suffix'\n" . $herecurr) &&
6821 }
6822 }
6824 # check for sizeof(&)
6828 }
6830 # check for sizeof without parenthesis
6835 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6836 }
6837 }
6839 # check for struct spinlock declarations
6843 }
6845 # check for seq_printf uses that could be seq_puts
6854 }
6855 }
6856 }
6858 # check for vsprintf extension %p<foo> misuses
6886 }
6890 }
6892 "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");
6893 }
6894 }
6902 }
6906 }
6907 }
6908 }
6910 # Check for misused memsets
6925 }
6926 }
6928 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6929 # if ($perl_version_ok &&
6930 # defined $stat &&
6931 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6932 # if (WARN("PREFER_ETHER_ADDR_COPY",
6933 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6934 # $fix) {
6935 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6936 # }
6937 # }
6939 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6940 # if ($perl_version_ok &&
6941 # defined $stat &&
6942 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6943 # WARN("PREFER_ETHER_ADDR_EQUAL",
6944 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6945 # }
6947 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6948 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6949 # if ($perl_version_ok &&
6950 # defined $stat &&
6951 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6952 #
6953 # my $ms_val = $7;
6954 #
6955 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6956 # if (WARN("PREFER_ETH_ZERO_ADDR",
6957 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6958 # $fix) {
6959 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6960 # }
6961 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6962 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6963 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6964 # $fix) {
6965 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6966 # }
6967 # }
6968 # }
6970 # typecasts on min/max could be min_t/max_t
6988 }
6991 }
6992 }
6994 # check usleep_range arguments
7002 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
7006 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
7007 }
7008 }
7010 # check for naked sscanf
7022 }
7024 # check for simple sscanf that should be kstrto<foo>
7038 }
7039 }
7040 }
7042 # check for new externs in .h files.
7049 }
7050 }
7052 # check for new externs in .c files.
7055 {
7062 }
7064 {
7067 }
7072 }
7076 {
7079 }
7081 # check for function declarations that have arguments without identifier names
7083 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
7091 }
7092 }
7093 }
7095 # check for function definitions
7101 # check for multiline function definition with misplaced open brace
7111 }
7115 }
7116 }
7118 # checks for new __setup's
7124 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
7125 }
7126 }
7128 # check for pointless casting of alloc functions
7131 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
7132 }
7134 # alloc style
7135 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
7137 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
7140 }
7142 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
7145 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
7156 }
7166 $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;
7167 }
7168 }
7169 }
7171 # check for krealloc arg reuse
7177 }
7179 # check for alloc argument mismatch
7183 }
7185 # check for multiple semicolons
7191 }
7192 }
7194 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
7203 }
7204 }
7206 # check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
7210 }
7212 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
7213 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(${CONFIG_}[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
7219 }
7220 }
7222 # check for /* fallthrough */ like comment, prefer fallthrough;
7231 );
7240 }
7241 }
7242 }
7244 # check for switch/default statements without a break;
7253 }
7255 # check for gcc specific __FUNCTION__
7261 }
7262 }
7264 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
7268 }
7270 # check for use of yield()
7274 }
7276 # check for comparisons against true and false
7292 }
7297 ## maybe suggesting a correct construct would better
7298 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
7300 }
7301 }
7303 # check for semaphores initialized locked
7307 }
7309 # recommend kstrto* over simple_strto* and strict_strto*
7313 }
7315 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
7318 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
7319 }
7321 # check for spin_is_locked(), suggest lockdep instead
7324 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
7325 }
7327 # check for deprecated apis
7333 }
7335 # check for various structs that are normally const (ops, kgdb, device_tree)
7336 # and avoid what seem like struct definitions 'struct foo {'
7342 }
7344 # use of NR_CPUS is usually wrong
7345 # ignore definitions of NR_CPUS and usage to define arrays as likely right
7346 # ignore designated initializers using NR_CPUS
7354 {
7356 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
7357 }
7359 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
7363 }
7365 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
7370 }
7372 # return sysfs_emit(foo, fmt, ...) fmt without newline
7380 }
7381 }
7383 # nested likely/unlikely calls
7387 }
7389 # whine mightly about in_atomic
7397 }
7398 }
7400 # check for lockdep_set_novalidate_class
7408 }
7409 }
7414 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
7415 }
7417 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
7418 # and whether or not function naming is typical and if
7419 # DEVICE_ATTR permissions uses are unusual too
7422 $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*\)/) {
7434 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
7435 }
7442 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
7443 }
7450 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
7451 }
7462 }
7465 }
7471 }
7472 }
7474 # Mode permission misuses where it seems decimal should be octal
7475 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
7476 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
7477 # specific definition of not visible in sysfs.
7478 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
7479 # use the default permissions
7495 }
7505 }
7508 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
7509 }
7510 }
7511 }
7512 }
7514 # check for uses of S_<PERMS> that could be octal for readability
7519 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
7522 }
7523 }
7525 # validate content of MODULE_LICENSE against list from include/linux/module.h
7529 GPL|
7530 GPL\ v2|
7535 Proprietary
7540 }
7541 }
7543 # check for sysctl duplicate constants
7546 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
7547 }
7548 }
7550 # If we have no input at all, then there is nothing to report on
7551 # so just keep quiet.
7554 }
7556 # In mailback mode only produce a report in the negative, for
7557 # things that appear to be patches.
7560 }
7562 # This is not a patch, and we are in 'no-patch' mode so
7563 # just keep quiet.
7566 }
7571 }
7577 # authorsignoff values:
7578 # 0 -> missing sign off
7579 # 1 -> sign off identical
7580 # 2 -> names and addresses match, comments mismatch
7581 # 3 -> addresses match, names different
7582 # 4 -> names match, addresses different
7583 # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match
7602 }
7603 }
7604 }
7612 }
7615 # If there were any defects found and not already fixing them
7621 EOM
7622 }
7623 # If there were whitespace errors which cleanpatch can fix
7624 # then suggest that.
7631 EOM
7632 }
7633 }
7653 }
7656 }
7657 }
7665 Do _NOT_ trust the results written to this file.
7668 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
7670 EOM
7671 }
7672 }
7680 }
7681 }
7683 }