| blob | b6ac890dff97cbc43780addb4e2ea3e8aad46313 |
1 #!/usr/bin/env perl
2 # SPDX-License-Identifier: GPL-2.0-only
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>
75 # For coreboot jenkins
76 # If taint mode is enabled, Untaint the path - files must be in /bin, /usr/bin or /usr/local/bin
80 }
89 Options:
95 --emacs emacs compile window format
96 --terse one line per report
99 single git commit with:
103 multiple git commits with:
107 git merges are ignored
126 is all off)
128 literally
131 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
132 with potential errors corrected to the preferred
133 checkpatch style
138 runtime errors.
141 --codespellfile Use this codespell dictionary
142 --typedefsfile Read additional types from this file
150 EOM
153 }
158 }
174 # Also catch when type or level is passed through a variable
175 while ($text =~ /(?:(\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
181 }
184 }
185 }
198 }
210 }
211 }
217 }
218 }
221 }
243 }
244 }
247 }
265 }
279 }
280 }
281 }
285 }
287 }
289 # Perl's Getopt::Long allows options to take optional arguments after a space.
290 # Prevent --color by itself from consuming other arguments
294 }
295 }
297 GetOptions(
339 # Use the user provided codespell file unconditionally
342 # If /usr/share/codespell/dictionary.txt is not present, try to find it
343 # under codespell's install directory: <codespell_root>/data/dictionary.txt
347 import os.path as op
348 import codespell_lib
352 EOF
356 }
357 }
359 # $help is 1 if either -h, --help or --version is passed as option - exitcode: 0
360 # $help is 2 if invalid option is passed - exitcode: 1
376 }
391 }
393 #if no filenames are given, push '-' to read patch from stdin
396 }
398 # skip TAB size 1 to avoid additional checks on $tabsize - 1
415 }
416 }
425 }
427 }
428 }
438 ## no critic
441 }
448 }
454 }
461 }
462 }
467 }
468 }
478 __user|
479 __kernel|
480 __force|
481 __iomem|
482 __must_check|
483 __kprobes|
484 __ref|
485 __refconst|
486 __refdata|
487 __rcu|
488 __private
496 # Notes to $Attribute:
497 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
499 const|
500 volatile|
501 __percpu|
502 __nocast|
503 __safe|
504 __bitwise|
505 __packed__|
506 __packed2__|
507 __naked|
508 __maybe_unused|
509 __always_unused|
510 __noreturn|
511 __used|
512 __cold|
513 __pure|
514 __noclone|
515 __deprecated|
516 __read_mostly|
517 __ro_after_init|
518 __kprobes|
520 ____cacheline_aligned|
521 ____cacheline_aligned_in_smp|
522 ____cacheline_internodealigned_in_smp|
523 __weak|
546 <=|>=|==|!=|
547 =>|->|<<|>>|<|>|!|~|
581 )};
584 atomic_t
585 )};
590 )};
596 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
597 TP_printk|
599 panic|
602 )};
610 # dev_alloc_skb/netdev_alloc_skb, et al
611 dma_alloc_coherent
612 )};
622 To:|
623 Cc:
624 )};
643 );
666 );
687 )};
694 );
698 );
705 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
712 );
716 #Create a search pattern for all these functions to speed up a loop below
721 }
725 S_IWUGO |
726 S_IWOTH |
727 S_IRWXUGO |
728 S_IALLUGO |
749 );
751 #Create a search pattern for all these strings to speed up a loop below
756 }
783 }
787 }
790 irq|
791 memory|
793 reboot
794 )};
795 # memory.h: ARM has a custom one
797 # Load common spelling mistakes and build regular expression list.
814 }
818 }
837 }
841 }
842 }
861 }
865 }
868 }
871 }
877 }
884 }
902 )
909 )
918 )
922 $NonptrType
927 $NonptrTypeMisordered
933 }
934 build_types();
938 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
939 # requires at least perl version v5.10.0
940 # Any use must be runtime checked with $^V
951 )};
958 );
967 }
972 }
996 }
997 }
998 }
1005 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
1008 }
1021 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
1032 }
1034 }
1042 }
1046 }
1051 }
1055 }
1063 }
1065 }
1066 }
1080 # Maybe one day convert this block of bash into something that returns
1081 # all matching commit ids, but it's very slow...
1082 #
1083 # echo "checking commits $1..."
1084 # git rev-list --remotes | grep -i "^$1" |
1085 # while read line ; do
1086 # git log --format='%H %s' -1 $line |
1087 # echo "commit $(cut -c 1-12,41-)"
1088 # done
1089 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./ ||
1095 }
1098 }
1109 # If input is git commits, extract all commits from the commit expressions.
1110 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1123 }
1132 }
1133 }
1136 }
1143 # coreboot: Mark filename as untainted
1157 }
1164 }
1168 }
1175 }
1179 }
1188 build_types();
1189 }
1200 EOM
1201 }
1207 EOM
1208 }
1209 }
1220 );
1225 }
1226 }
1228 }
1251 # If there's a name left after stripping spaces and
1252 # leading quotes, and the address doesn't have both
1253 # leading and trailing angle brackets, the address
1254 # is invalid. ie:
1255 # "joe smith joe@smith.com" bad
1256 # "joe smith <joe@smith.com" bad
1261 }
1262 }
1272 }
1275 }
1289 }
1295 }
1298 }
1306 }
1307 }
1310 }
1318 }
1319 }
1322 }
1335 }
1337 }
1340 }
1343 }
1347 }
1352 # Drop the diff line leader and expand tabs
1355 # Treat labels like whitespace when counting indentation
1360 # Pick the indent from the front of the line.
1364 }
1375 }
1376 }
1387 # Always copy over the diff marker.
1393 # Comments we are whacking completely including the begin
1394 # and end, all to $;.
1401 }
1407 }
1414 }
1416 # A \ in a string means ignore the next character.
1422 }
1423 # Regular quotes.
1432 }
1433 }
1435 #print "c<$c> SQ<$sanitise_quote>\n";
1444 }
1445 }
1449 }
1451 # The pathname on a #include may be surrounded by '<' and '>'.
1456 # The whole of a #error is a string.
1460 }
1465 }
1468 }
1476 }
1497 #warn "CSB: blk<$blk> remain<$remain>\n";
1498 # If we are about to drop off the end, pull in more
1499 # context.
1510 }
1511 # Bail if there is no further context.
1512 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1515 }
1519 }
1520 }
1525 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1527 # Handle nested #if/#else.
1534 }
1536 # Statement ends at the ';' or a close '}' at the
1537 # outermost level.
1540 }
1542 # An else is really a conditional as long as its not else if
1549 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1550 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1551 }
1556 }
1564 #warn "CSB: mark coff<$coff>\n";
1565 }
1566 }
1570 }
1578 }
1580 }
1581 }
1582 # Preprocessor commands end at the newline unless escaped.
1588 }
1590 }
1591 # We are truly at the end, so shuffle to the next line.
1596 }
1601 #warn "STATEMENT<$statement>\n";
1602 #warn "CONDITION<$condition>\n";
1604 #print "coff<$coff> soff<$off> loff<$loff>\n";
1608 }
1613 # Strip the diff line prefixes and rip blank lines at start and end.
1621 }
1629 }
1650 }
1651 }
1659 # Grab the first conditional/block pair.
1662 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1666 }
1668 # Pull in the following conditional/block pairs and see if they
1669 # could continue the statement.
1673 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1675 #print "C: push\n";
1677 }
1680 }
1699 # Handle nested #if/#else.
1706 }
1709 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1713 }
1720 }
1721 }
1725 }
1728 }
1731 }
1737 }
1743 }
1749 }
1754 }
1759 }
1764 # If c99 comment on the current line, or the line before or after
1772 # Catch a comment on the end of the line itself.
1776 # Look through the context and try and figure out if there is a
1777 # comment.
1782 #warn " $line\n";
1785 }
1788 }
1791 }
1795 }
1796 }
1800 }
1805 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1806 ##print "CMMT: $cmt\n";
1809 }
1822 }
1824 # coreboot: This probably shouldn't happen, but it does.
1825 # Return a defined value so we don't get an error.
1830 }
1831 }
1839 }
1842 }
1850 }
1853 }
1865 }
1866 }
1870 }
1882 }
1902 }
1923 }
1952 # Assume all arms of the conditional end as this
1953 # one does, and continue as if the #endif was not here.
1970 }
2001 }
2013 }
2046 }
2061 }
2070 }
2074 }
2078 }
2079 }
2082 }
2091 DEFINE_\S+
2092 )$|
2096 case|
2100 \#|
2101 \#\#|
2107 # Check for modifiers.
2118 }
2119 }
2124 }
2125 build_types();
2128 }
2129 }
2141 }
2149 }
2158 }
2159 }
2164 }
2172 }
2176 }
2182 }
2187 }
2191 }
2202 }
2203 }
2230 }
2236 }
2243 }
2248 }
2251 }
2254 }
2262 };
2264 }
2272 };
2275 }
2284 }
2286 }
2294 }
2296 }
2304 }
2306 }
2312 ##print "absolute<$absolute>\n";
2314 # See if any suffix of this path is a path within the tree.
2317 ##print "file<$file>\n";
2319 }
2320 }
2323 }
2325 # It is, so see if the prefix is acceptable.
2329 ##print "prefix<$prefix>\n";
2333 }
2334 }
2342 }
2350 }
2358 }
2366 }
2375 #convert leading spaces to tabs
2377 #Remove spaces before a tab
2381 }
2395 }
2407 }
2408 }
2411 }
2420 }
2421 }
2424 }
2429 # Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c).
2433 }
2475 # Trace the real file/line as we go.
2488 # suppression flags
2496 # Pre-scan the patch sanitizing the lines.
2497 # Pre-scan the patch looking for any __setup documentation.
2498 #
2506 sanitise_line_reset();
2518 }
2519 #next;
2520 }
2527 }
2530 # Guestimate if this is a continuing comment. Run
2531 # the context looking for a comment "edge". If this
2532 # edge is a close comment then we must be in a comment
2533 # at context start.
2540 #print "RAW<$rawlines[$ln - 1]>\n";
2546 }
2547 }
2550 }
2552 # Guestimate if this is a continuing comment. If this
2553 # is the start of a diff block and this line starts
2554 # ' *' then it is very likely a comment.
2557 {
2559 }
2561 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2565 # Standardise the strings and chars within the input to
2566 # simplify matching -- only bother with positive lines.
2568 }
2575 }
2577 #print "==>$rawline\n";
2578 #print "-->$line\n";
2582 }
2583 }
2599 # check if it's a mode change, rename or start of a patch
2605 }
2607 #extract the line range in the file after the patch is applied
2618 }
2619 annotate_reset();
2630 }
2633 # track the line number as we move through the hunk, note that
2634 # new versions of GNU diff omit the leading space on completely
2635 # blank context lines so we need to count that too.
2640 # Measure the line length and indent.
2643 # Track the previous line.
2648 #warn "line<$line>\n";
2652 }
2660 # extract the filename as it passes
2676 }
2680 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2681 }
2683 }
2685 # coreboot
2690 }
2691 }
2694 }
2696 #make up the handle for any error we report on this line
2704 }
2705 }
2710 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2711 }
2716 }
2719 }
2729 # Verify the existence of a commit log if appropriate
2730 # 2 is used because a $signature is counted in $commit_log_lines
2734 }
2739 }
2741 # Check if the commit log has what seems like a diff which can confuse patch
2750 }
2752 # Check for incorrect file permissions
2759 }
2760 }
2762 # Check the patch for a signoff:
2789 }
2792 }
2795 }
2796 }
2797 }
2798 }
2799 }
2801 # Check for patch separator
2805 }
2807 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2808 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2811 }
2813 # Check signature styles
2825 }
2832 }
2833 }
2840 }
2842 }
2849 }
2850 }
2861 # Don't force email to have quotes
2862 # Allow just an angle bracketed address
2868 }
2869 }
2871 # Check for duplicate signatures
2880 }
2881 }
2883 # Check email subject for common tools that don't need to be mentioned
2888 }
2890 # Check for Gerrit Change-Ids not in any patch context
2896 }
2897 }
2899 # Check if the commit log is in a possible stack dump
2903 # timestamp
2907 # stack dump address styles
2909 }
2911 # coreboot: The line length limit is 72
2912 # Check for line lengths > 72 in commit log
2915 # file delta changes
2917 # filename then :
2919 # A Fixes: or Link: line or signature tag line
2924 }
2926 # coreboot: The line subject limit is 65
2927 # Check for line lengths > 65 in commit subject
2928 # coreboot: Check for a period at the end of the subject line
2936 }
2940 }
2941 }
2943 # Reset possible stack dump if a blank line is found
2947 }
2949 # Check for git id commit length and improperly formed commit descriptions
2974 }
2996 }
3004 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
3005 }
3006 }
3008 # Check for added, moved or deleted files
3018 }
3020 # Check for wrappage within a valid hunk of the file
3025 }
3027 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
3038 }
3040 # Check if it's the start of a commit log
3041 # (not a header line and we haven't seen the patch filename)
3048 }
3050 # Check if there is UTF-8 in a commit log when a mail header has explicitly
3051 # declined it, i.e defined some charset where it is missing.
3056 }
3062 }
3064 # Check for absolute kernel paths in commit message
3071 #
3074 }
3075 }
3076 }
3078 # Check for various typo / spelling mistakes
3095 }
3096 }
3097 }
3098 # check for repeated words separated by a single space
3099 # avoid false positive from list command eg, '-rw-r--r-- 1 root root'
3112 }
3117 # check for character before and after the word matches
3126 # avoid repeating hex occurrences like 'ff ff fe 09 ...'
3129 }
3135 }
3136 }
3138 # if it's a repeated word on consecutive lines in a comment block
3147 }
3148 }
3149 }
3150 }
3152 # ignore non-hunk lines and lines being removed
3155 #trailing whitespace
3162 }
3169 }
3172 }
3174 # Check for FSF mailing addresses.
3183 "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)
3184 }
3186 # check for Kconfig help text having a real description
3187 # Only applies when adding the entry originally, after that we do not have
3188 # sufficient context to determine whether it is indeed long enough.
3190 # 'choice' is usually the last thing on the line (though
3191 # Kconfig supports named choices), so use a word boundary
3192 # (\b) rather than a whitespace character (\s)
3207 }
3211 }
3218 # At the end of this Kconfig block:
3219 # This only checks context lines in the patch
3220 # and so hopefully shouldn't trigger false
3221 # positives, even though some of these are
3222 # common words in help texts
3226 }
3228 }
3233 "please write a help paragraph that fully describes the config symbol\n" . "$here\n$stat_real\n");
3234 }
3235 }
3237 # check for MAINTAINERS entries that don't have the right form
3245 }
3246 }
3256 };
3259 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3260 }
3262 # check for DT compatible documentation
3281 }
3288 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3289 }
3290 }
3291 }
3293 # check for using SPDX license tag at beginning of files
3307 }
3313 }
3314 }
3315 }
3317 # check we are in a valid source file if not then ignore this hunk
3320 # line length limit (with some exclusions)
3321 #
3322 # There are a few types of lines that may extend beyond $max_line_length:
3323 # logging functions like pr_info that end in a string
3324 # lines with a single string
3325 # #defines that are a single string
3326 # lines with an RFC3986 like URL
3327 #
3328 # There are 3 different line length message types:
3329 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3330 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3331 # LONG_LINE all other lines longer than $max_line_length
3332 #
3333 # if LONG_LINE is ignored, the other 2 types are also ignored
3334 #
3340 # Check the allowed long line types first
3342 # logging functions that end in a string that starts
3343 # before $max_line_length
3344 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3348 # lines with only strings (w/ possible termination)
3349 # #defines with only strings
3354 # More special cases
3359 # URL ($rawline is used in case the URL is in a comment)
3363 # Otherwise set the alternate message types
3365 # a comment starts before $max_line_length
3370 # a quoted string starts before $max_line_length
3374 }
3382 }
3383 }
3385 # check for adding lines without a newline.
3386 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3391 }
3392 }
3394 # check we are in a valid source file C or perl if not then ignore this hunk
3397 # at the beginning of a line any tabs must come first and anything
3398 # more than $tabsize must use tabs.
3407 }
3408 }
3410 # check for space before tabs.
3420 }
3421 }
3423 # check for assignments on the start of a line
3429 # add assignment operator to the previous line, remove from current line
3432 }
3433 }
3435 # check for && or || at the start of a line
3441 # insert logical operator at last non-comment, non-whitepsace char on previous line
3446 }
3447 }
3449 # check indentation starts on a tab stop
3451 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3458 }
3459 }
3460 }
3462 # check multi-line statement indentation matches previous line
3464 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3487 }
3488 }
3489 }
3490 }
3492 # check for space after cast like "(int) foo" or "(struct foo) bar"
3493 # avoid checking a few false positives:
3494 # "sizeof(<type>)" or "__alignof__(<type>)"
3495 # function pointer declarations like "(*foo)(int) = bar;"
3496 # structure definitions like "(struct foo) { 0 };"
3497 # multiline macros that define functions
3498 # known attributes or the __attribute__ keyword
3506 }
3507 }
3509 # Block comment styles
3510 # Networking with an initial /*
3517 }
3519 # Block comments use * on subsequent lines
3527 }
3529 # Block comments use */ on trailing lines
3536 }
3538 # Block comment * alignment
3552 }
3559 }
3560 }
3562 # check for missing blank lines after struct/union declarations
3563 # with exceptions for various attributes and macros
3579 }
3580 }
3582 # check for multiple consecutive blank lines
3590 }
3593 }
3595 # check for missing blank lines after declarations
3596 # (declarations must have the same indentation and not be at the start of line)
3598 # use temporaries
3601 # remove $Attribute/$Sparse uses to simplify comparisons
3605 # function pointer declarations
3607 # foo bar; where foo is some local typedef or #define
3609 # known declaration macros
3611 # for "else if" which can look like "$Ident $Ident"
3613 # other possible extensions of declaration lines
3615 # not starting a section or a macro "\" extended line
3617 # looks like a declaration
3619 # function pointer declarations
3621 # foo bar; where foo is some local typedef or #define
3623 # known declaration macros
3625 # start of struct or union or enum
3627 # start or end of block or continuation of declaration
3629 # bitfield continuation
3631 # other possible extensions of declaration lines
3637 }
3638 }
3639 }
3641 # check for spaces at the beginning of a line.
3642 # Exceptions:
3643 # 1) within comments
3644 # 2) indented preprocessor commands
3645 # 3) hanging labels
3652 }
3653 }
3655 # check we are in a valid C source file if not then ignore this hunk
3658 # check for unusual line ending [ or (
3662 }
3664 # check if this appears to be the start function declaration, save the name
3668 }
3670 # check if this appears to be the end of function declaration
3673 }
3675 # check indentation of any line with a bare else
3676 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3677 # if the previous line is a break or return and is indented 1 tab more...
3686 }
3687 }
3689 # check indentation of a line with a break;
3690 # if the previous line is a goto, return or break
3691 # and is indented the same # of tabs
3699 }
3700 }
3701 }
3703 # check for RCS/CVS revision markers
3707 }
3709 # check for old HOTPLUG __dev<foo> section markings
3713 }
3715 # Check for potential 'bare' types
3718 #print "LINE<$line>\n";
3726 #print "linenr<$linenr> <$stat>\n";
3727 # If this statement has no statement boundaries within
3728 # it there is no point in retrying a statement scan
3729 # until we hit end of it.
3732 #print "skip<$line_nr_next>\n";
3734 }
3736 # Find the real next line.
3742 }
3747 # Ignore goto labels.
3750 # Ignore functions being called
3755 # declarations always start with types
3756 } 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) {
3761 # definitions in global scope can only start with types
3764 }
3766 # any (foo ... *) is a pointer cast, and foo is a type
3769 }
3771 # Check for any sort of function declaration.
3772 # int foo(something bar, other baz);
3773 # void (*store_gdt)(x86_descr_ptr *);
3774 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3782 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3785 }
3786 }
3787 }
3789 }
3791 #
3792 # Checks which may be anchored in the context.
3793 #
3795 # Check for switch () and associated case and default
3796 # statements should be at the same indent.
3810 }
3811 }
3815 }
3816 }
3818 # if/while/etc brace do not go on next line, unless defining a do while loop,
3819 # or if that brace on the next line is for something else
3820 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3828 }
3839 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3842 }
3844 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3845 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3851 }
3855 {
3861 }
3862 }
3863 }
3865 # Check relative indent for conditionals and blocks.
3866 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3874 # remove inline comments
3878 # Find out how long the conditional actually is.
3882 # Make sure we remove the line prefixes as we have
3883 # none on the first line, and are going to readd them
3884 # where necessary.
3888 }
3890 # We want to check the first line inside the block
3891 # starting at the end of the conditional, so remove:
3892 # 1) any blank line termination
3893 # 2) any opening brace { on end of the line
3894 # 3) any do (...) {
3901 }
3905 }
3907 # Also ignore a loop construct at the end of a
3908 # preprocessor statement.
3912 }
3919 # If we see an #else/#elif then the code
3920 # is not linear.
3923 }
3925 # Ignore:
3926 # 1) blank lines, they should be at 0,
3927 # 2) preprocessor lines, and
3928 # 3) labels.
3936 }
3937 }
3938 }
3943 # Check if either of these lines are modified, else
3944 # this is not this patch's fault.
3948 }
3951 }
3953 #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";
3962 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3963 }
3965 # Also check if the next statement after the previous condition has the same indent
3970 # Remove line prefixes
3973 # Remove any comments
3976 # Remove any leading labels
3979 # Skip this check for in case next statement starts with 'else'
3982 # Remove while that belongs to a do {} while
3985 }
3987 # Remove blank lines
3990 # Get the real next lines
3997 }
4000 #print "stat_next<$stat_next> stat<$stat> indent<$indent> nindent<$nindent> s_next<$s_next> stat_next_real<$stat_next_real>\n";
4006 }
4007 }
4008 }
4010 # Track the 'values' across context and added lines.
4020 }
4023 #ignore lines not being added
4026 # check for self assignments used to avoid compiler warnings
4027 # e.g.: int foo = foo, *bar = NULL;
4028 # struct foo bar = *(&(bar));
4031 if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) {
4034 }
4035 }
4037 # check for dereferences that span multiple lines
4047 }
4049 # check for declarations of signed or unsigned without int
4050 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
4061 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
4069 }
4070 }
4071 }
4073 # TEST: allow direct testing of the type matcher.
4081 }
4083 }
4084 # TEST: allow direct testing of the attribute matcher.
4092 }
4094 }
4096 # check for initialisation to aggregates open brace on the next line
4110 }
4111 }
4113 #
4114 # Checks which are anchored on the added line.
4115 #
4117 # check for malformed paths in #include statements (uses RAW line)
4123 }
4127 }
4128 }
4130 # no C99 // comments
4139 }
4140 }
4141 }
4142 # Remove C99 comments.
4146 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4147 # the whole statement.
4148 #print "APW <$lines[$realline_next - 1]>\n";
4154 # Handle definitions which produce identifiers with
4155 # a prefix:
4156 # XXX(foo);
4157 # EXPORT_SYMBOL(something_foo);
4162 #print "FOO C name<$name>\n";
4173 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4177 }
4178 }
4183 #print "FOO B <$lines[$linenr - 1]>\n";
4185 }
4190 }
4192 # check for global initialisers.
4198 }
4199 }
4200 # check for static initialisers.
4207 }
4208 }
4210 # check for misordered declarations of char/short/int/long with signed/unsigned
4214 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4215 }
4217 # check for unnecessary <signed> int declarations of short/long/long long
4234 }
4235 }
4237 # check for static const char * arrays.
4242 }
4244 # check for initialized const char arrays that should be static const
4245 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4250 }
4251 }
4253 # check for static char foo[] = "bar" declarations.
4258 }
4260 # check for const <foo> const where <foo> is not a pointer or array type
4269 }
4270 }
4272 # check for const static or static <non ptr type> const declarations
4273 # prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const'
4281 }
4282 }
4284 # check for non-global char *foo[] = {"bar", ...} declarations.
4289 }
4291 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4294 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4300 }
4301 }
4302 }
4304 # check for function declarations without arguments like "int foo()"
4310 }
4311 }
4313 # check for new typedefs, only function parameters and sparse annotations
4314 # make sense.
4322 }
4324 # * goes on variable not on type
4325 # (char*[ const])
4327 #print "AA<$1>\n";
4330 # Should start with a space.
4332 # Should not end with a space.
4334 # '*'s should not have spaces between.
4336 }
4338 ## print "1: from<$from> to<$to> ident<$ident>\n";
4348 }
4349 }
4350 }
4352 #print "BB<$1>\n";
4355 # Should start with a space.
4357 # Should not end with a space.
4359 # '*'s should not have spaces between.
4361 }
4362 # Modifiers should have spaces.
4365 ## print "2: from<$from> to<$to> ident<$ident>\n";
4376 }
4377 }
4378 }
4380 # avoid BUG() or BUG_ON()
4385 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4386 }
4388 # avoid LINUX_VERSION_CODE
4391 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4392 }
4394 # check for uses of printk_ratelimit
4398 }
4400 # printk should use KERN_* levels
4404 }
4413 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
4414 }
4422 }
4423 }
4432 }
4434 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4435 # number of false positives, but assembly files are not checked, so at
4436 # least the arch entry code will not trigger this warning.
4440 }
4442 # function brace can't be on same line, except for #defines of do while,
4443 # or if closed on same line
4460 }
4461 }
4462 }
4464 # open braces for enum, union and struct go on the same line.
4478 }
4479 }
4480 }
4482 # missing space after union, struct or enum definition
4489 }
4490 }
4492 # Function pointer declarations
4493 # check spacing between type, funcptr, and args
4494 # canonical declaration is "type (*funcptr)(args...)"
4503 # the $Declare variable will capture all spaces after the type
4504 # so check it for a missing trailing missing space but pointer return types
4505 # don't need a space so don't warn for those.
4510 }
4515 }
4517 # unnecessary space "type (*funcptr)(args...)"
4518 # This test is not currently implemented because these declarations are
4519 # equivalent to
4520 # int foo(int bar, ...)
4521 # and this is form shouldn't/doesn't generate a checkpatch warning.
4522 #
4523 # elsif ($declare =~ /\s{2,}$/) {
4524 # WARN("SPACING",
4525 # "Multiple spaces after return type\n" . $herecurr);
4526 # }
4528 # unnecessary space "type ( *funcptr)(args...)"
4533 }
4535 # unnecessary space "type (* funcptr)(args...)"
4540 }
4542 # unnecessary space "type (*funcptr )(args...)"
4547 }
4549 # unnecessary space "type (*funcptr) (args...)"
4554 }
4558 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4559 }
4560 }
4562 # check for spacing round square brackets; allowed:
4563 # 1. with a type on the left -- int [] a;
4564 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4565 # 3. inside a curly brace -- = { [0...10] = 5 }
4566 # 4. in an extended asm instruction -- : [r0]"r"(r0) (coreboot)
4577 }
4578 }
4579 }
4581 # check for spaces between functions and their parentheses.
4587 # Ignore those directives where spaces _are_ permitted.
4593 {
4594 # cpp #define statements have non-optional spaces, ie
4595 # if there is a space between the name and the open
4596 # parenthesis it is simply not a parameter group.
4599 # cpp #elif statement condition may start with a (
4602 # If this whole things ends with a type its most
4603 # likely a typedef for a function.
4612 }
4613 }
4614 }
4616 # Check operator spacing.
4622 <<=|>>=|<=|>=|==|!=|
4624 =>|->|<<|>>|<|>|=|!|~|
4630 ## print("element count: <" . $#elements . ">\n");
4631 ## foreach my $el (@elements) {
4632 ## print("el: <$el>\n");
4633 ## }
4641 }
4652 ## print("n: <$n> good: <$good>\n");
4656 # Pick up the preceding and succeeding characters.
4661 }
4684 }
4693 # Pull out the value of this operator.
4696 # Get the full operator variant.
4699 # Ignore operators passed as parameters.
4703 # # Ignore comments
4704 # } elsif ($op =~ /^$;+$/) {
4706 # ; should have either the end of line or a space or \ after it
4714 }
4715 }
4717 # // is a comment
4720 # : when part of a bitfield
4722 # skip the bitfield test for now
4724 # No spaces for:
4725 # ->
4733 }
4735 }
4736 }
4738 # , must not have a space before and must have a space on the right.
4747 }
4748 }
4755 }
4756 }
4762 }
4765 }
4766 }
4768 # '*' as part of a type definition -- reported already.
4770 #warn "'*' is part of type\n";
4772 # unary operators should have a space before and
4773 # none after. May be left adjacent to another
4774 # unary operator, or a cast
4784 }
4785 }
4786 }
4788 # A unary '*' may be const
4796 }
4798 }
4799 }
4801 # unary ++ and unary -- are allowed no space on one side.
4808 }
4809 }
4816 }
4817 }
4824 }
4826 }
4827 }
4829 # << and >> may either have or not have spaces both sides
4835 {
4843 }
4849 }
4850 }
4857 }
4859 }
4860 }
4862 # A colon needs no spaces before when it is
4863 # terminating a case value or a label.
4870 }
4871 }
4873 # All the others need spaces both sides.
4877 # Ignore email addresses <foo@bar>
4882 {
4884 }
4886 # for asm volatile statements
4887 # ignore a colon with another
4888 # colon immediately before or after
4892 }
4894 # messages are ERROR, but ?: are CHK
4904 }
4906 }
4907 }
4908 }
4911 ## print("n: <$n> GOOD: <$good>\n");
4914 }
4918 }
4922 }
4925 }
4927 # check for whitespace before a non-naked semicolon
4934 }
4935 }
4937 # check for multiple assignments
4941 }
4943 ## # check for multiple declarations, allowing for a function declaration
4944 ## # continuation.
4945 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4946 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4947 ##
4948 ## # Remove any bracketed sections to ensure we do not
4949 ## # falsely report the parameters of functions.
4950 ## my $ln = $line;
4951 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4952 ## }
4953 ## if ($ln =~ /,/) {
4954 ## WARN("MULTIPLE_DECLARATION",
4955 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4956 ## }
4957 ## }
4959 #need space before brace following if, while, etc
4965 #coreboot - Open braces must be escaped in regex
4967 }
4968 }
4970 ## # check for blank lines before declarations
4971 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4972 ## $prevrawline =~ /^.\s*$/) {
4973 ## WARN("SPACING",
4974 ## "No blank lines before declarations\n" . $hereprev);
4975 ## }
4976 ##
4978 # closing brace should have a space following it when it has anything
4979 # on the line
4986 }
4987 }
4989 # check spacing on square brackets
4996 }
4997 }
5004 }
5005 }
5007 # check spacing on parentheses
5015 }
5016 }
5025 }
5026 }
5028 # check unnecessary parentheses around addressof/dereference single $Lvals
5029 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
5037 }
5038 }
5040 # check for unnecessary parentheses around function pointer uses
5041 # ie: (foo->bar)(); should be foo->bar();
5042 # but not "if (foo->bar) (" to avoid some false positives
5051 }
5052 }
5054 # check for unnecessary parentheses around comparisons in if uses
5055 # when !drivers/staging or command-line uses --strict
5062 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
5064 # avoid parentheses around potential macro args
5073 }
5074 }
5077 }
5078 }
5080 # check that goto labels aren't indented (allow a single space indentation)
5081 # and ignore bitfield definitions like foo:1
5082 # Strictly, labels can have whitespace after the identifier and before the :
5083 # but this is not allowed here as many ?: uses would appear to be labels
5092 }
5093 }
5095 # check if a statement with a comma should be two statements like:
5096 # foo = bar(), /* comma should be semicolon */
5097 # bar = baz();
5099 $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) {
5104 }
5106 # return is not a function
5116 }
5120 }
5121 }
5123 # unnecessary return in a void function
5124 # at end-of-function, with the previous line a single leading tab, then return;
5125 # and the line before that not a goto label target like "out:"
5133 }
5135 # if statements using unnecessary parentheses - ie: if ((foo == bar))
5141 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
5146 }
5147 }
5149 # comparisons with a constant or upper case identifier on the left
5150 # avoid cases like "foo + BAR < baz"
5151 # only fix matches surrounded by parentheses to avoid incorrect
5152 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
5173 }
5175 }
5176 }
5178 # Return of what appears to be an errno should normally be negative
5184 }
5185 }
5187 # Need a space before open parenthesis after if, while etc
5194 }
5195 }
5197 # Check for illegal assignment in if conditional -- and check for trailing
5198 # statements after the conditional.
5206 ##print "stat<$stat> stat_next<$stat_next>\n";
5209 # If the statement carries leading newlines,
5210 # then count those as offsets.
5218 }
5219 }
5230 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5250 }
5251 }
5252 }
5254 # Find out what is on the end of the line after the
5255 # conditional.
5261 {
5262 # Find out how long the conditional actually is.
5271 }
5285 }
5286 }
5287 }
5288 }
5290 # Check for bitwise tests written as boolean
5296 |
5301 {
5304 }
5306 # if and else should not have general statements after it
5313 }
5314 }
5315 # if should not continue a brace
5320 }
5321 # case and default should not have general statements after them
5327 {
5330 }
5332 # Check for }<nl>else {, these must be at the same
5333 # indent level to be relevant to each other.
5345 }
5349 }
5350 }
5356 # Find out what is on the end of the line after the
5357 # conditional.
5373 }
5374 }
5375 }
5377 #Specific variable tests
5381 #gcc binary extension
5389 }
5390 }
5392 #CamelCase
5395 #Ignore Page<foo> variants
5397 #Ignore SI style variants like nS, mV and dB
5398 #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5400 #Ignore some three character SI units explicitly, like MiB and KHz
5406 seed_camelcase_includes();
5410 }
5411 }
5416 }
5417 }
5418 }
5419 }
5421 #no spaces allowed after \ in define
5427 }
5428 }
5430 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5431 # itself <asm/foo.h> (uses RAW line)
5438 {
5447 }
5448 }
5449 }
5450 }
5452 # multi-statement macros should be enclosed in a do while loop, grab the
5453 # first statement and ensure its the whole macro if its not enclosed
5454 # in a known good container
5466 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5467 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5482 }
5489 # Flatten any parentheses and braces
5493 {
5494 }
5496 # Flatten any obvious string concatenation.
5499 {
5500 }
5502 # Make asm volatile uses seem like a generic function
5507 module_param_named|
5508 MODULE_PARM_DESC|
5509 DECLARE_PER_CPU|
5510 DEFINE_PER_CPU|
5511 __typeof__\(|
5512 union|
5513 struct|
5518 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5527 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5532 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5539 {
5542 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5549 }
5551 }
5553 # Make $define_stmt single line, comment-free, etc
5564 }
5565 }
5570 # check if any macro arguments are reused (ignore '...' and 'type')
5575 $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;
5582 }
5583 # check if any macro arguments may have other precedence issues
5589 }
5590 }
5592 # check for macros with flow control, but without ## concatenation
5593 # ## concatenation is commonly a macro that defines a function so ignore those
5600 }
5602 # check for line continuations outside of #defines, preprocessor #, and asm
5611 }
5612 }
5614 # do {} while (0) macro tests:
5615 # single-statement macros do not need to be enclosed in do while (0) loop,
5616 # macro should not end with a semicolon
5631 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5643 }
5647 }
5655 }
5656 }
5658 # check for redundant bracing round if etc
5662 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5663 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5673 # If the condition carries leading newlines, then count those as offsets.
5678 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5680 # We have looked at and allowed this specific line.
5690 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5692 #print "APW: ALLOWED: cond<$cond>\n";
5694 }
5696 #print "APW: ALLOWED: block<$block>\n";
5698 }
5700 #print "APW: ALLOWED: lines block<$block>\n";
5702 }
5704 }
5709 }
5711 # coreboot has decided to allow braces around single line statement blocks
5712 #WARN("BRACES",
5713 # "braces {} are not necessary for any arm of this statement\n" . $herectx);
5718 }
5719 }
5720 }
5721 }
5726 # Check the pre-context.
5728 #print "APW: ALLOWED: pre<$1>\n";
5730 }
5735 # Check the condition.
5737 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5740 }
5742 #print "APW: ALLOWED: cond<$cond>\n";
5744 }
5746 #print "APW: ALLOWED: block<$block>\n";
5748 }
5750 #print "APW: ALLOWED: lines block<$block>\n";
5752 }
5753 # Check the post-context.
5758 }
5760 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5762 }
5763 }
5764 # coreboot has decided to allow braces around single line statement blocks
5765 #if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) {
5766 # my $cnt = statement_rawlines($block);
5767 # my $herectx = get_stat_here($linenr, $cnt, $here);
5768 #
5769 # WARN("BRACES",
5770 # "braces {} are not necessary for single statement blocks\n" . $herectx);
5771 #}
5772 }
5774 # check for single line unbalanced braces
5778 }
5780 # check for unnecessary blank lines around braces
5786 }
5787 }
5793 }
5794 }
5796 # no volatiles please
5800 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5801 }
5803 # Check for user-visible strings broken across lines, which breaks the ability
5804 # to grep for the string. Make exceptions when the previous string ends in a
5805 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5806 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5819 }
5831 }
5833 }
5834 }
5836 # check for missing a space in a string concatenation
5840 }
5842 # check for an embedded function name in a string when the function is known
5843 # This does not work very well for -f --file checking as it depends on patch
5844 # context providing the function name or a single line form for in-file
5845 # function declarations
5851 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5852 }
5854 # check for spaces before a quoted newline
5860 }
5862 }
5864 # concatenated string without spaces between elements
5874 }
5875 }
5876 }
5878 # uncoalesced string fragments
5886 }
5887 }
5888 }
5890 # check for non-standard and hex prefixed decimal printf formats
5896 # check for %L
5901 }
5902 # check for %Z
5907 }
5908 # check for 0x<decimal>
5912 }
5913 }
5915 # check for line continuations in quoted strings with odd counts of "
5919 }
5921 # warn about #if 0
5925 }
5927 # warn about #if 1
5931 }
5933 # check for needless "if (<foo>) fn(<foo>)" uses
5937 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5949 }
5954 }
5957 }
5961 }
5962 }
5963 }
5964 }
5966 # check for unnecessary "Out of Memory" messages
5975 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5977 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5981 }
5982 }
5984 # check for logging functions with KERN_<LEVEL>
5992 }
5993 }
5995 # check for logging continuations
5999 }
6001 # check for mask then right shift without a parentheses
6007 }
6009 # check for pointer comparisons to NULL
6019 }
6020 }
6021 }
6023 # check for bad placement of section $InitAttribute (e.g.: __initdata)
6026 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
6036 $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;
6037 }
6038 }
6039 }
6041 # check for $InitAttributeData (ie: __initdata) with const
6052 }
6053 }
6055 # check for $InitAttributeConst (ie: __initconst) without const
6067 }
6068 }
6070 # check for __read_mostly with const non-pointer (should just be const)
6077 }
6078 }
6080 # don't use __constant_<foo> functions outside of include/uapi/
6082 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
6090 }
6091 }
6093 # prefer usleep_range over udelay
6096 # ignore udelay's < 10, however
6099 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
6100 }
6104 }
6105 }
6107 # warn about unexpectedly long msleep's
6111 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
6112 }
6113 }
6115 # check for comparisons of jiffies
6118 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
6119 }
6121 # check for comparisons of get_jiffies_64()
6124 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
6125 }
6127 # warn about #ifdefs in C files
6128 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
6129 # print "#ifdef in C files should be avoided\n";
6130 # print "$herecurr";
6131 # $clean = 0;
6132 # }
6134 # warn about spacing in #ifdefs
6141 }
6143 }
6145 # check for spinlock_t definitions without a comment.
6152 }
6153 }
6154 # check for memory barriers without a comment.
6157 mb|
6158 rmb|
6159 wmb
6162 mb__before_atomic|
6163 mb__after_atomic|
6164 store_release|
6165 load_acquire|
6166 store_mb|
6179 }
6180 }
6190 }
6192 # check for waitqueue_active without a comment.
6197 }
6198 }
6200 # check for data_race without a comment.
6205 }
6206 }
6208 # check of hardware specific defines
6209 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
6212 }
6214 # check that the storage class is not after a type
6218 }
6219 # Check that the storage class is at the beginning of a declaration
6226 }
6228 # check the location of the inline attribute, that it is between
6229 # storage class and type.
6234 }
6236 # Check for __inline__ and __inline, prefer inline
6244 }
6245 }
6247 # Check for compiler attributes
6277 );
6292 }
6301 }
6302 }
6303 }
6305 # Check for __attribute__ unused, prefer __always_unused or __maybe_unused
6308 "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr);
6309 }
6310 }
6312 # Check for __attribute__ weak, or __weak declarations (may have link issues)
6314 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6319 }
6321 # check for c99 types like uint8_t used outside of uapi/ and tools/
6336 }
6337 }
6338 }
6340 # check for cast of C90 native int or longer types constants
6352 }
6354 "Unnecessary typecast of c90 int constant - '$cast$const' could be '$const$suffix'\n" . $herecurr) &&
6357 }
6358 }
6360 # check for sizeof(&)
6364 }
6366 # check for sizeof without parenthesis
6371 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6372 }
6373 }
6375 # check for struct spinlock declarations
6379 }
6381 # check for seq_printf uses that could be seq_puts
6390 }
6391 }
6392 }
6394 # check for vsprintf extension %p<foo> misuses
6416 }
6420 }
6422 "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");
6423 }
6424 }
6433 }
6437 }
6438 }
6439 }
6441 # Check for misused memsets
6456 }
6457 }
6459 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6460 # if ($perl_version_ok &&
6461 # defined $stat &&
6462 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6463 # if (WARN("PREFER_ETHER_ADDR_COPY",
6464 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6465 # $fix) {
6466 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6467 # }
6468 # }
6470 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6471 # if ($perl_version_ok &&
6472 # defined $stat &&
6473 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6474 # WARN("PREFER_ETHER_ADDR_EQUAL",
6475 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6476 # }
6478 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6479 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6480 # if ($perl_version_ok &&
6481 # defined $stat &&
6482 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6483 #
6484 # my $ms_val = $7;
6485 #
6486 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6487 # if (WARN("PREFER_ETH_ZERO_ADDR",
6488 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6489 # $fix) {
6490 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6491 # }
6492 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6493 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6494 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6495 # $fix) {
6496 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6497 # }
6498 # }
6499 # }
6501 # strlcpy uses that should likely be strscpy
6504 "Prefer strscpy over strlcpy - see: https://lore.kernel.org/r/CAHk-=wgfRnXz0W3D37d01q3JFkr_i_uTL=V6A6G1oUZcprmknw\@mail.gmail.com/\n" . $herecurr);
6505 }
6507 # typecasts on min/max could be min_t/max_t
6525 }
6528 }
6529 }
6531 # check usleep_range arguments
6539 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
6543 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
6544 }
6545 }
6547 # check for naked sscanf
6559 }
6561 # check for simple sscanf that should be kstrto<foo>
6575 }
6576 }
6577 }
6579 # check for new externs in .h files.
6586 }
6587 }
6589 # check for new externs in .c files.
6592 {
6599 }
6601 {
6604 }
6609 }
6613 {
6616 }
6618 # check for function declarations that have arguments without identifier names
6620 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6628 }
6629 }
6630 }
6632 # check for function definitions
6638 # check for multiline function definition with misplaced open brace
6648 }
6652 }
6653 }
6655 # checks for new __setup's
6661 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6662 }
6663 }
6665 # check for pointless casting of alloc functions
6668 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6669 }
6671 # alloc style
6672 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6674 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6677 }
6679 # check for (kv|k)[mz]alloc with multiplies that could be kmalloc_array/kvmalloc_array/kvcalloc/kcalloc
6682 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k)[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6695 }
6705 $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;
6706 }
6707 }
6708 }
6710 # check for krealloc arg reuse
6715 }
6717 # check for alloc argument mismatch
6721 }
6723 # check for multiple semicolons
6729 }
6730 }
6732 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6741 }
6742 }
6744 # check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
6748 }
6750 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6751 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(${CONFIG_}[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6757 }
6758 }
6760 # check for /* fallthrough */ like comment, prefer fallthrough;
6769 );
6778 }
6779 }
6780 }
6782 # check for switch/default statements without a break;
6791 }
6793 # check for gcc specific __FUNCTION__
6799 }
6800 }
6802 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6806 }
6808 # check for use of yield()
6812 }
6814 # check for comparisons against true and false
6830 }
6835 ## maybe suggesting a correct construct would better
6836 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6838 }
6839 }
6841 # check for bool bitfields
6844 "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr);
6845 }
6847 # check for semaphores initialized locked
6851 }
6853 # recommend kstrto* over simple_strto* and strict_strto*
6857 }
6859 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6862 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6863 }
6865 # check for various structs that are normally const (ops, kgdb, device_tree)
6866 # and avoid what seem like struct definitions 'struct foo {'
6872 }
6874 # use of NR_CPUS is usually wrong
6875 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6882 {
6884 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6885 }
6887 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6891 }
6893 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6898 }
6900 # check for array definition/declarations that should use flexible arrays instead
6904 "Use C99 flexible arrays - see https://docs.kernel.org/process/deprecated.html#zero-length-and-one-element-arrays\n" . $hereprev) &&
6907 }
6908 }
6910 # whine mightly about in_atomic
6918 }
6919 }
6921 # check for mutex_trylock_recursive usage
6925 }
6927 # check for lockdep_set_novalidate_class
6935 }
6936 }
6941 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6942 }
6944 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6945 # and whether or not function naming is typical and if
6946 # DEVICE_ATTR permissions uses are unusual too
6949 $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*\)/) {
6961 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6962 }
6969 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6970 }
6977 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6978 }
6989 }
6992 }
6998 }
6999 }
7001 # Mode permission misuses where it seems decimal should be octal
7002 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
7003 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
7004 # specific definition of not visible in sysfs.
7005 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
7006 # use the default permissions
7022 }
7032 }
7035 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
7036 }
7037 }
7038 }
7039 }
7041 # check for uses of S_<PERMS> that could be octal for readability
7046 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
7049 }
7050 }
7052 # validate content of MODULE_LICENSE against list from include/linux/module.h
7056 GPL|
7057 GPL\ v2|
7062 Proprietary
7067 }
7068 }
7069 }
7071 # If we have no input at all, then there is nothing to report on
7072 # so just keep quiet.
7075 }
7077 # In mailback mode only produce a report in the negative, for
7078 # things that appear to be patches.
7081 }
7083 # This is not a patch, and we are in 'no-patch' mode so
7084 # just keep quiet.
7087 }
7092 }
7098 # authorsignoff values:
7099 # 0 -> missing sign off
7100 # 1 -> sign off identical
7101 # 2 -> names and addresses match, comments mismatch
7102 # 3 -> addresses match, names different
7103 # 4 -> names match, addresses different
7104 # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match
7123 }
7124 }
7125 }
7133 }
7136 # If there were any defects found and not already fixing them
7142 EOM
7143 }
7144 # If there were whitespace errors which cleanpatch can fix
7145 # then suggest that.
7152 EOM
7153 }
7154 }
7174 }
7177 }
7178 }
7186 Do _NOT_ trust the results written to this file.
7189 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
7191 EOM
7192 }
7193 }
7201 }
7202 }
7204 }