| blob | 60d4a79674b6efd5f82d5f5ac052e9c3bdba8796 |
1 #!/usr/bin/env perl
2 # SPDX-License-Identifier: GPL-2.0
3 #
4 # (c) 2001, Dave Jones. (the file handling bit)
5 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
6 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
7 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
8 # (c) 2010-2018 Joe Perches <joe@perches.com>
65 # git output parsing needs US English output, so first set backtick child process LANGUAGE
76 Options:
81 --emacs emacs compile window format
82 --terse one line per report
85 single git commit with:
89 multiple git commits with:
93 git merges are ignored
111 is all off)
113 literally
116 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
117 with potential errors corrected to the preferred
118 checkpatch style
123 runtime errors.
126 --codespellfile Use this codespell dictionary
127 --typedefsfile Read additional types from this file
133 EOM
136 }
141 }
157 # Also catch when type or level is passed through a variable
158 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
160 }
165 }
168 }
190 }
191 }
194 }
196 # Perl's Getopt::Long allows options to take optional arguments after a space.
197 # Prevent --color by itself from consuming other arguments
201 }
202 }
204 GetOptions(
258 }
260 #if no filenames are given, push '-' to read patch from stdin
263 }
275 }
277 # skip TAB size 1 to avoid additional checks on $tabsize - 1
294 }
295 }
304 }
306 }
307 }
317 ## no critic
320 }
327 }
333 }
340 }
341 }
346 }
347 }
357 __user|
358 __kernel|
359 __force|
360 __iomem|
361 __must_check|
362 __kprobes|
363 __ref|
364 __refconst|
365 __refdata|
366 __rcu|
367 __private
375 # Notes to $Attribute:
376 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
378 const|
379 __percpu|
380 __nocast|
381 __safe|
382 __bitwise|
383 __packed__|
384 __packed2__|
385 __naked|
386 __maybe_unused|
387 __always_unused|
388 __noreturn|
389 __used|
390 __cold|
391 __pure|
392 __noclone|
393 __deprecated|
394 __read_mostly|
395 __ro_after_init|
396 __kprobes|
398 ____cacheline_aligned|
399 ____cacheline_aligned_in_smp|
400 ____cacheline_internodealigned_in_smp|
401 __weak
423 <=|>=|==|!=|
424 =>|->|<<|>>|<|>|!|~|
458 )};
461 atomic_t
462 )};
467 )};
473 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
474 TP_printk|
476 panic|
479 )};
487 # dev_alloc_skb/netdev_alloc_skb, et al
488 dma_alloc_coherent
489 )};
499 To:|
500 Cc:
501 )};
520 );
543 );
564 )};
571 );
575 );
582 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
589 );
593 #Create a search pattern for all these functions to speed up a loop below
598 }
612 );
614 #Create a search pattern for all these strings to speed up a loop below
619 }
623 S_IWUGO |
624 S_IWOTH |
625 S_IRWXUGO |
626 S_IALLUGO |
647 );
649 #Create a search pattern for all these strings to speed up a loop below
654 }
681 }
685 }
688 irq|
689 memory|
691 reboot
692 )};
693 # memory.h: ARM has a custom one
695 # Load common spelling mistakes and build regular expression list.
712 }
716 }
735 }
739 }
740 }
759 }
763 }
766 }
769 }
775 }
782 }
800 )
807 )
816 )
820 $NonptrType
825 $NonptrTypeMisordered
831 }
832 build_types();
836 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
837 # requires at least perl version v5.10.0
838 # Any use must be runtime checked with $^V
848 )};
857 }
862 }
886 }
887 }
888 }
898 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
899 }
902 }
907 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
913 }
926 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
937 }
939 }
947 }
951 }
956 }
960 }
968 }
970 }
971 }
985 # Maybe one day convert this block of bash into something that returns
986 # all matching commit ids, but it's very slow...
987 #
988 # echo "checking commits $1..."
989 # git rev-list --remotes | grep -i "^$1" |
990 # while read line ; do
991 # git log --format='%H %s' -1 $line |
992 # echo "commit $(cut -c 1-12,41-)"
993 # done
994 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
999 }
1002 }
1013 # If input is git commits, extract all commits from the commit expressions.
1014 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1027 }
1036 }
1037 }
1040 }
1057 }
1064 }
1069 }
1076 }
1080 }
1089 build_types();
1090 }
1101 EOM
1102 }
1108 EOM
1109 }
1110 }
1121 );
1126 }
1127 }
1129 }
1153 # If there's a name left after stripping spaces and
1154 # leading quotes, and the address doesn't have both
1155 # leading and trailing angle brackets, the address
1156 # is invalid. ie:
1157 # "joe smith joe@smith.com" bad
1158 # "joe smith <joe@smith.com" bad
1163 }
1164 }
1171 }
1178 }
1181 }
1195 }
1201 }
1204 }
1211 }
1221 }
1229 }
1230 }
1233 }
1241 }
1242 }
1245 }
1258 }
1260 }
1263 }
1266 }
1270 }
1275 # Drop the diff line leader and expand tabs
1279 # Pick the indent from the front of the line.
1283 }
1294 }
1295 }
1306 # Always copy over the diff marker.
1312 # Comments we are whacking completely including the begin
1313 # and end, all to $;.
1320 }
1326 }
1333 }
1335 # A \ in a string means ignore the next character.
1341 }
1342 # Regular quotes.
1351 }
1352 }
1354 #print "c<$c> SQ<$sanitise_quote>\n";
1363 }
1364 }
1368 }
1370 # The pathname on a #include may be surrounded by '<' and '>'.
1375 # The whole of a #error is a string.
1379 }
1384 }
1387 }
1395 }
1418 #warn "CSB: blk<$blk> remain<$remain>\n";
1419 # If we are about to drop off the end, pull in more
1420 # context.
1431 }
1432 # Bail if there is no further context.
1433 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1436 }
1440 }
1441 }
1446 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1448 # Handle nested #if/#else.
1455 }
1457 # Statement ends at the ';' or a close '}' at the
1458 # outermost level.
1461 }
1463 # An else is really a conditional as long as its not else if
1470 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1471 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1472 }
1477 }
1485 #warn "CSB: mark coff<$coff>\n";
1486 }
1487 }
1491 }
1499 }
1501 }
1502 }
1503 # Preprocessor commands end at the newline unless escaped.
1509 }
1511 }
1512 # We are truly at the end, so shuffle to the next line.
1517 }
1522 #warn "STATEMENT<$statement>\n";
1523 #warn "CONDITION<$condition>\n";
1525 #print "coff<$coff> soff<$off> loff<$loff>\n";
1529 }
1534 # Strip the diff line prefixes and rip blank lines at start and end.
1542 }
1550 }
1571 }
1572 }
1580 # Grab the first conditional/block pair.
1583 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1587 }
1589 # Pull in the following conditional/block pairs and see if they
1590 # could continue the statement.
1594 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1596 #print "C: push\n";
1598 }
1601 }
1620 # Handle nested #if/#else.
1627 }
1630 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1634 }
1641 }
1642 }
1646 }
1649 }
1652 }
1658 }
1664 }
1670 }
1675 }
1680 }
1685 # If c99 comment on the current line, or the line before or after
1693 # Catch a comment on the end of the line itself.
1697 # Look through the context and try and figure out if there is a
1698 # comment.
1703 #warn " $line\n";
1706 }
1709 }
1712 }
1716 }
1717 }
1721 }
1726 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1727 ##print "CMMT: $cmt\n";
1730 }
1743 }
1746 }
1754 }
1757 }
1765 }
1768 }
1780 }
1781 }
1785 }
1797 }
1817 }
1838 }
1867 # Assume all arms of the conditional end as this
1868 # one does, and continue as if the #endif was not here.
1885 }
1916 }
1928 }
1961 }
1976 }
1985 }
1989 }
1993 }
1994 }
1997 }
2006 DEFINE_\S+
2007 )$|
2011 case|
2015 \#|
2016 \#\#|
2022 # Check for modifiers.
2033 }
2034 }
2039 }
2040 build_types();
2043 }
2044 }
2056 }
2064 }
2073 }
2074 }
2079 }
2087 }
2093 }
2097 }
2108 }
2109 }
2136 }
2142 }
2149 }
2154 }
2157 }
2160 }
2168 };
2170 }
2178 };
2181 }
2190 }
2192 }
2200 }
2202 }
2210 }
2212 }
2218 ##print "absolute<$absolute>\n";
2220 # See if any suffix of this path is a path within the tree.
2223 ##print "file<$file>\n";
2225 }
2226 }
2229 }
2231 # It is, so see if the prefix is acceptable.
2235 ##print "prefix<$prefix>\n";
2239 }
2240 }
2248 }
2256 }
2264 }
2272 }
2281 #convert leading spaces to tabs
2283 #Remove spaces before a tab
2287 }
2301 }
2313 }
2314 }
2317 }
2326 }
2327 }
2330 }
2372 # Trace the real file/line as we go.
2385 # suppression flags
2393 # Pre-scan the patch sanitizing the lines.
2394 # Pre-scan the patch looking for any __setup documentation.
2395 #
2403 sanitise_line_reset();
2415 }
2416 #next;
2417 }
2424 }
2427 # Guestimate if this is a continuing comment. Run
2428 # the context looking for a comment "edge". If this
2429 # edge is a close comment then we must be in a comment
2430 # at context start.
2437 #print "RAW<$rawlines[$ln - 1]>\n";
2443 }
2444 }
2447 }
2449 # Guestimate if this is a continuing comment. If this
2450 # is the start of a diff block and this line starts
2451 # ' *' then it is very likely a comment.
2454 {
2456 }
2458 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2462 # Standardise the strings and chars within the input to
2463 # simplify matching -- only bother with positive lines.
2465 }
2472 }
2474 #print "==>$rawline\n";
2475 #print "-->$line\n";
2479 }
2480 }
2496 # check if it's a mode change, rename or start of a patch
2502 }
2504 #extract the line range in the file after the patch is applied
2515 }
2516 annotate_reset();
2527 }
2530 # track the line number as we move through the hunk, note that
2531 # new versions of GNU diff omit the leading space on completely
2532 # blank context lines so we need to count that too.
2537 # Measure the line length and indent.
2540 # Track the previous line.
2545 #warn "line<$line>\n";
2549 }
2557 # extract the filename as it passes
2573 }
2577 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2578 }
2580 }
2582 #make up the handle for any error we report on this line
2590 }
2591 }
2596 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2597 }
2602 }
2613 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n");
2614 }
2615 }
2618 }
2628 # Verify the existence of a commit log if appropriate
2629 # 2 is used because a $signature is counted in $commit_log_lines
2633 }
2638 }
2640 # Check if the commit log has what seems like a diff which can confuse patch
2649 }
2651 # Check for incorrect file permissions
2658 }
2659 }
2661 # Check the patch for a From:
2667 }
2669 # Check the patch for a signoff:
2676 }
2677 }
2678 }
2680 # Check for patch separator
2684 }
2686 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2687 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2690 }
2692 # Check signature styles
2704 }
2711 }
2712 }
2719 }
2721 }
2728 }
2729 }
2740 # Don't force email to have quotes
2741 # Allow just an angle bracketed address
2745 }
2746 }
2748 # Check for duplicate signatures
2757 }
2759 # Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2763 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2764 }
2770 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2773 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2774 }
2775 }
2776 }
2778 # Check email subject for common tools that don't need to be mentioned
2783 }
2785 # Check for Gerrit Change-Ids not in any patch context
2789 }
2791 # Check if the commit log is in a possible stack dump
2795 # timestamp
2799 # stack dump address styles
2801 }
2803 # Check for line lengths > 75 in commit log, warn once
2807 # file delta changes
2809 # filename then :
2811 # A Fixes: or Link: line
2816 }
2818 # Reset possible stack dump if a blank line is found
2822 }
2824 # Check for git id commit length and improperly formed commit descriptions
2849 }
2871 }
2879 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2880 }
2881 }
2883 # Check for added, moved or deleted files
2893 }
2895 # Check for adding new DT bindings not in schema format
2900 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
2901 }
2903 # Check for wrappage within a valid hunk of the file
2908 }
2910 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2921 }
2923 # Check if it's the start of a commit log
2924 # (not a header line and we haven't seen the patch filename)
2931 }
2933 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2934 # declined it, i.e defined some charset where it is missing.
2939 }
2945 }
2947 # Check for absolute kernel paths in commit message
2954 #
2957 }
2958 }
2959 }
2961 # Check for various typo / spelling mistakes
2975 }
2976 }
2977 }
2979 # check for invalid commit id
2987 }
2988 }
2990 # ignore non-hunk lines and lines being removed
2993 #trailing whitespace
3000 }
3007 }
3010 }
3012 # Check for FSF mailing addresses.
3021 "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)
3022 }
3024 # check for Kconfig help text having a real description
3025 # Only applies when adding the entry originally, after that we do not have
3026 # sufficient context to determine whether it is indeed long enough.
3028 # 'choice' is usually the last thing on the line (though
3029 # Kconfig supports named choices), so use a word boundary
3030 # (\b) rather than a whitespace character (\s)
3050 }
3057 # This only checks context lines in the patch
3058 # and so hopefully shouldn't trigger false
3059 # positives, even though some of these are
3060 # common words in help texts
3065 }
3067 }
3071 }
3072 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3073 }
3075 # check MAINTAINERS entries
3077 # check MAINTAINERS entries for the right form
3084 }
3085 }
3086 # check MAINTAINERS entries for the right ordering too
3110 }
3111 }
3112 }
3113 }
3115 # discourage the use of boolean for type definition attributes of Kconfig options
3120 }
3130 };
3133 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3134 }
3136 # check for DT compatible documentation
3155 }
3162 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3163 }
3164 }
3165 }
3167 # check for using SPDX license tag at beginning of files
3181 }
3183 # check SPDX comment style for .[chsS] files
3189 }
3200 }
3209 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3210 }
3211 }
3212 }
3213 }
3214 }
3216 # check we are in a valid source file if not then ignore this hunk
3219 # check for using SPDX-License-Identifier on the wrong line number
3225 }
3227 # line length limit (with some exclusions)
3228 #
3229 # There are a few types of lines that may extend beyond $max_line_length:
3230 # logging functions like pr_info that end in a string
3231 # lines with a single string
3232 # #defines that are a single string
3233 # lines with an RFC3986 like URL
3234 #
3235 # There are 3 different line length message types:
3236 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3237 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3238 # LONG_LINE all other lines longer than $max_line_length
3239 #
3240 # if LONG_LINE is ignored, the other 2 types are also ignored
3241 #
3246 # Check the allowed long line types first
3248 # logging functions that end in a string that starts
3249 # before $max_line_length
3250 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3254 # lines with only strings (w/ possible termination)
3255 # #defines with only strings
3260 # More special cases
3265 # URL ($rawline is used in case the URL is in a comment)
3269 # Otherwise set the alternate message types
3271 # a comment starts before $max_line_length
3276 # a quoted string starts before $max_line_length
3280 }
3288 }
3289 }
3291 # check for adding lines without a newline.
3292 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3295 }
3297 # check we are in a valid source file C or perl if not then ignore this hunk
3300 # at the beginning of a line any tabs must come first and anything
3301 # more than $tabsize must use tabs.
3310 }
3311 }
3313 # check for repeated words separated by a single space
3323 }
3332 }
3333 }
3335 # if it's a repeated word on consecutive lines in a comment block
3344 }
3345 }
3346 }
3347 }
3349 # check for space before tabs.
3359 }
3360 }
3362 # check for assignments on the start of a line
3366 }
3368 # check for && or || at the start of a line
3372 }
3374 # check indentation starts on a tab stop
3376 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3383 }
3384 }
3385 }
3387 # check multi-line statement indentation matches previous line
3389 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3412 }
3413 }
3414 }
3415 }
3417 # check for space after cast like "(int) foo" or "(struct foo) bar"
3418 # avoid checking a few false positives:
3419 # "sizeof(<type>)" or "__alignof__(<type>)"
3420 # function pointer declarations like "(*foo)(int) = bar;"
3421 # structure definitions like "(struct foo) { 0 };"
3422 # multiline macros that define functions
3423 # known attributes or the __attribute__ keyword
3431 }
3432 }
3434 # Block comment styles
3435 # Networking with an initial /*
3442 }
3444 # Block comments use * on subsequent lines
3452 }
3454 # Block comments use */ on trailing lines
3461 }
3463 # Block comment * alignment
3477 }
3484 }
3485 }
3487 # check for missing blank lines after struct/union declarations
3488 # with exceptions for various attributes and macros
3504 }
3505 }
3507 # check for multiple consecutive blank lines
3515 }
3518 }
3520 # check for missing blank lines after declarations
3522 # actual declarations
3524 # function pointer declarations
3526 # foo bar; where foo is some local typedef or #define
3528 # known declaration macros
3530 # for "else if" which can look like "$Ident $Ident"
3532 # other possible extensions of declaration lines
3534 # not starting a section or a macro "\" extended line
3536 # looks like a declaration
3538 # function pointer declarations
3540 # foo bar; where foo is some local typedef or #define
3542 # known declaration macros
3544 # start of struct or union or enum
3546 # start or end of block or continuation of declaration
3548 # bitfield continuation
3550 # other possible extensions of declaration lines
3552 # indentation of previous and current line are the same
3558 }
3559 }
3561 # check for spaces at the beginning of a line.
3562 # Exceptions:
3563 # 1) within comments
3564 # 2) indented preprocessor commands
3565 # 3) hanging labels
3572 }
3573 }
3575 # check we are in a valid C source file if not then ignore this hunk
3578 # check for unusual line ending [ or (
3582 }
3584 # check if this appears to be the start function declaration, save the name
3588 }
3590 # check if this appears to be the end of function declaration
3593 }
3595 # check indentation of any line with a bare else
3596 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3597 # if the previous line is a break or return and is indented 1 tab more...
3606 }
3607 }
3609 # check indentation of a line with a break;
3610 # if the previous line is a goto or return and is indented the same # of tabs
3616 }
3617 }
3619 # check for RCS/CVS revision markers
3623 }
3625 # check for old HOTPLUG __dev<foo> section markings
3629 }
3631 # Check for potential 'bare' types
3634 #print "LINE<$line>\n";
3642 #print "linenr<$linenr> <$stat>\n";
3643 # If this statement has no statement boundaries within
3644 # it there is no point in retrying a statement scan
3645 # until we hit end of it.
3648 #print "skip<$line_nr_next>\n";
3650 }
3652 # Find the real next line.
3658 }
3663 # Ignore goto labels.
3666 # Ignore functions being called
3671 # declarations always start with types
3672 } 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) {
3677 # definitions in global scope can only start with types
3680 }
3682 # any (foo ... *) is a pointer cast, and foo is a type
3685 }
3687 # Check for any sort of function declaration.
3688 # int foo(something bar, other baz);
3689 # void (*store_gdt)(x86_descr_ptr *);
3690 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3698 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3701 }
3702 }
3703 }
3705 }
3707 #
3708 # Checks which may be anchored in the context.
3709 #
3711 # Check for switch () and associated case and default
3712 # statements should be at the same indent.
3726 }
3727 }
3731 }
3732 }
3734 # if/while/etc brace do not go on next line, unless defining a do while loop,
3735 # or if that brace on the next line is for something else
3736 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3744 }
3755 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3758 }
3760 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3761 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3767 }
3771 {
3777 }
3778 }
3779 }
3781 # Check relative indent for conditionals and blocks.
3782 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3790 # remove inline comments
3794 # Find out how long the conditional actually is.
3798 # Make sure we remove the line prefixes as we have
3799 # none on the first line, and are going to readd them
3800 # where necessary.
3804 }
3806 # We want to check the first line inside the block
3807 # starting at the end of the conditional, so remove:
3808 # 1) any blank line termination
3809 # 2) any opening brace { on end of the line
3810 # 3) any do (...) {
3817 }
3821 }
3823 # Also ignore a loop construct at the end of a
3824 # preprocessor statement.
3828 }
3835 # If we see an #else/#elif then the code
3836 # is not linear.
3839 }
3841 # Ignore:
3842 # 1) blank lines, they should be at 0,
3843 # 2) preprocessor lines, and
3844 # 3) labels.
3852 }
3853 }
3854 }
3859 # Check if either of these lines are modified, else
3860 # this is not this patch's fault.
3864 }
3867 }
3869 #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";
3878 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3879 }
3880 }
3882 # Track the 'values' across context and added lines.
3892 }
3895 #ignore lines not being added
3898 # check for dereferences that span multiple lines
3908 }
3910 # check for declarations of signed or unsigned without int
3911 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3922 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3930 }
3931 }
3932 }
3934 # TEST: allow direct testing of the type matcher.
3942 }
3944 }
3945 # TEST: allow direct testing of the attribute matcher.
3953 }
3955 }
3957 # check for initialisation to aggregates open brace on the next line
3971 }
3972 }
3974 #
3975 # Checks which are anchored on the added line.
3976 #
3978 # check for malformed paths in #include statements (uses RAW line)
3984 }
3988 }
3989 }
3991 # no C99 // comments
4000 }
4001 }
4002 }
4003 # Remove C99 comments.
4007 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
4008 # the whole statement.
4009 #print "APW <$lines[$realline_next - 1]>\n";
4015 # Handle definitions which produce identifiers with
4016 # a prefix:
4017 # XXX(foo);
4018 # EXPORT_SYMBOL(something_foo);
4022 #print "FOO C name<$name>\n";
4033 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
4037 }
4038 }
4043 #print "FOO B <$lines[$linenr - 1]>\n";
4045 }
4050 }
4052 # check for global initialisers.
4058 }
4059 }
4060 # check for static initialisers.
4067 }
4068 }
4070 # check for misordered declarations of char/short/int/long with signed/unsigned
4074 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4075 }
4077 # check for unnecessary <signed> int declarations of short/long/long long
4094 }
4095 }
4097 # check for static const char * arrays.
4102 }
4104 # check for initialized const char arrays that should be static const
4105 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4110 }
4111 }
4113 # check for static char foo[] = "bar" declarations.
4118 }
4120 # check for const <foo> const where <foo> is not a pointer or array type
4129 }
4130 }
4132 # check for non-global char *foo[] = {"bar", ...} declarations.
4137 }
4139 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4142 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4148 }
4149 }
4150 }
4152 # check for function declarations without arguments like "int foo()"
4158 }
4159 }
4161 # check for new typedefs, only function parameters and sparse annotations
4162 # make sense.
4170 }
4172 # * goes on variable not on type
4173 # (char*[ const])
4175 #print "AA<$1>\n";
4178 # Should start with a space.
4180 # Should not end with a space.
4182 # '*'s should not have spaces between.
4184 }
4186 ## print "1: from<$from> to<$to> ident<$ident>\n";
4196 }
4197 }
4198 }
4200 #print "BB<$1>\n";
4203 # Should start with a space.
4205 # Should not end with a space.
4207 # '*'s should not have spaces between.
4209 }
4210 # Modifiers should have spaces.
4213 ## print "2: from<$from> to<$to> ident<$ident>\n";
4224 }
4225 }
4226 }
4228 # avoid BUG() or BUG_ON()
4233 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4234 }
4236 # avoid LINUX_VERSION_CODE
4239 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4240 }
4242 # check for uses of printk_ratelimit
4246 }
4248 # printk should use KERN_* levels
4252 }
4261 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
4262 }
4271 }
4273 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4274 # number of false positives, but assembly files are not checked, so at
4275 # least the arch entry code will not trigger this warning.
4279 }
4281 # ENOTSUPP is not a standard error code and should be avoided in new patches.
4282 # Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP.
4283 # Similarly to ENOSYS warning a small number of false positives is expected.
4289 }
4290 }
4292 # function brace can't be on same line, except for #defines of do while,
4293 # or if closed on same line
4310 }
4311 }
4312 }
4314 # open braces for enum, union and struct go on the same line.
4328 }
4329 }
4330 }
4332 # missing space after union, struct or enum definition
4339 }
4340 }
4342 # Function pointer declarations
4343 # check spacing between type, funcptr, and args
4344 # canonical declaration is "type (*funcptr)(args...)"
4353 # the $Declare variable will capture all spaces after the type
4354 # so check it for a missing trailing missing space but pointer return types
4355 # don't need a space so don't warn for those.
4360 }
4365 }
4367 # unnecessary space "type (*funcptr)(args...)"
4368 # This test is not currently implemented because these declarations are
4369 # equivalent to
4370 # int foo(int bar, ...)
4371 # and this is form shouldn't/doesn't generate a checkpatch warning.
4372 #
4373 # elsif ($declare =~ /\s{2,}$/) {
4374 # WARN("SPACING",
4375 # "Multiple spaces after return type\n" . $herecurr);
4376 # }
4378 # unnecessary space "type ( *funcptr)(args...)"
4383 }
4385 # unnecessary space "type (* funcptr)(args...)"
4390 }
4392 # unnecessary space "type (*funcptr )(args...)"
4397 }
4399 # unnecessary space "type (*funcptr) (args...)"
4404 }
4408 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4409 }
4410 }
4412 # check for spacing round square brackets; allowed:
4413 # 1. with a type on the left -- int [] a;
4414 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4415 # 3. inside a curly brace -- = { [0...10] = 5 }
4426 }
4427 }
4428 }
4430 # check for spaces between functions and their parentheses.
4436 # Ignore those directives where spaces _are_ permitted.
4442 {
4443 # cpp #define statements have non-optional spaces, ie
4444 # if there is a space between the name and the open
4445 # parenthesis it is simply not a parameter group.
4448 # cpp #elif statement condition may start with a (
4451 # If this whole things ends with a type its most
4452 # likely a typedef for a function.
4461 }
4462 }
4463 }
4465 # Check operator spacing.
4471 <<=|>>=|<=|>=|==|!=|
4473 =>|->|<<|>>|<|>|=|!|~|
4479 ## print("element count: <" . $#elements . ">\n");
4480 ## foreach my $el (@elements) {
4481 ## print("el: <$el>\n");
4482 ## }
4490 }
4501 ## print("n: <$n> good: <$good>\n");
4505 # Pick up the preceding and succeeding characters.
4510 }
4533 }
4542 # Pull out the value of this operator.
4545 # Get the full operator variant.
4548 # Ignore operators passed as parameters.
4552 # # Ignore comments
4553 # } elsif ($op =~ /^$;+$/) {
4555 # ; should have either the end of line or a space or \ after it
4563 }
4564 }
4566 # // is a comment
4569 # : when part of a bitfield
4571 # skip the bitfield test for now
4573 # No spaces for:
4574 # ->
4582 }
4584 }
4585 }
4587 # , must not have a space before and must have a space on the right.
4596 }
4597 }
4604 }
4605 }
4611 }
4614 }
4615 }
4617 # '*' as part of a type definition -- reported already.
4619 #warn "'*' is part of type\n";
4621 # unary operators should have a space before and
4622 # none after. May be left adjacent to another
4623 # unary operator, or a cast
4633 }
4634 }
4635 }
4637 # A unary '*' may be const
4645 }
4647 }
4648 }
4650 # unary ++ and unary -- are allowed no space on one side.
4657 }
4658 }
4665 }
4666 }
4673 }
4675 }
4676 }
4678 # << and >> may either have or not have spaces both sides
4684 {
4692 }
4698 }
4699 }
4706 }
4708 }
4709 }
4711 # A colon needs no spaces before when it is
4712 # terminating a case value or a label.
4719 }
4720 }
4722 # All the others need spaces both sides.
4726 # Ignore email addresses <foo@bar>
4731 {
4733 }
4735 # for asm volatile statements
4736 # ignore a colon with another
4737 # colon immediately before or after
4741 }
4743 # messages are ERROR, but ?: are CHK
4753 }
4755 }
4756 }
4757 }
4760 ## print("n: <$n> GOOD: <$good>\n");
4763 }
4767 }
4771 }
4774 }
4776 # check for whitespace before a non-naked semicolon
4783 }
4784 }
4786 # check for multiple assignments
4790 }
4792 ## # check for multiple declarations, allowing for a function declaration
4793 ## # continuation.
4794 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4795 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4796 ##
4797 ## # Remove any bracketed sections to ensure we do not
4798 ## # falsly report the parameters of functions.
4799 ## my $ln = $line;
4800 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4801 ## }
4802 ## if ($ln =~ /,/) {
4803 ## WARN("MULTIPLE_DECLARATION",
4804 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4805 ## }
4806 ## }
4808 #need space before brace following if, while, etc
4815 }
4816 }
4818 ## # check for blank lines before declarations
4819 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4820 ## $prevrawline =~ /^.\s*$/) {
4821 ## WARN("SPACING",
4822 ## "No blank lines before declarations\n" . $hereprev);
4823 ## }
4824 ##
4826 # closing brace should have a space following it when it has anything
4827 # on the line
4834 }
4835 }
4837 # check spacing on square brackets
4844 }
4845 }
4852 }
4853 }
4855 # check spacing on parentheses
4863 }
4864 }
4873 }
4874 }
4876 # check unnecessary parentheses around addressof/dereference single $Lvals
4877 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4885 }
4886 }
4888 # check for unnecessary parentheses around function pointer uses
4889 # ie: (foo->bar)(); should be foo->bar();
4890 # but not "if (foo->bar) (" to avoid some false positives
4899 }
4900 }
4902 # check for unnecessary parentheses around comparisons in if uses
4903 # when !drivers/staging or command-line uses --strict
4910 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4912 # avoid parentheses around potential macro args
4921 }
4922 }
4925 }
4926 }
4928 #goto labels aren't indented, allow a single space however
4936 }
4937 }
4939 # return is not a function
4949 }
4953 }
4954 }
4956 # unnecessary return in a void function
4957 # at end-of-function, with the previous line a single leading tab, then return;
4958 # and the line before that not a goto label target like "out:"
4966 }
4968 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4974 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4979 }
4980 }
4982 # comparisons with a constant or upper case identifier on the left
4983 # avoid cases like "foo + BAR < baz"
4984 # only fix matches surrounded by parentheses to avoid incorrect
4985 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
5006 }
5008 }
5009 }
5011 # Return of what appears to be an errno should normally be negative
5017 }
5018 }
5020 # Need a space before open parenthesis after if, while etc
5027 }
5028 }
5030 # Check for illegal assignment in if conditional -- and check for trailing
5031 # statements after the conditional.
5039 ##print "stat<$stat> stat_next<$stat_next>\n";
5042 # If the statement carries leading newlines,
5043 # then count those as offsets.
5051 }
5052 }
5062 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) {
5081 }
5082 }
5083 }
5085 # Find out what is on the end of the line after the
5086 # conditional.
5092 {
5093 # Find out how long the conditional actually is.
5102 }
5106 }
5107 }
5109 # Check for bitwise tests written as boolean
5115 |
5120 {
5123 }
5125 # if and else should not have general statements after it
5132 }
5133 }
5134 # if should not continue a brace
5139 }
5140 # case and default should not have general statements after them
5146 {
5149 }
5151 # Check for }<nl>else {, these must be at the same
5152 # indent level to be relevant to each other.
5164 }
5168 }
5169 }
5175 # Find out what is on the end of the line after the
5176 # conditional.
5192 }
5193 }
5194 }
5196 #Specific variable tests
5200 #CamelCase
5203 #Ignore Page<foo> variants
5205 #Ignore SI style variants like nS, mV and dB
5206 #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5208 #Ignore some three character SI units explicitly, like MiB and KHz
5214 seed_camelcase_includes();
5218 }
5219 }
5224 }
5225 }
5226 }
5227 }
5229 #no spaces allowed after \ in define
5235 }
5236 }
5238 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5239 # itself <asm/foo.h> (uses RAW line)
5246 {
5255 }
5256 }
5257 }
5258 }
5260 # multi-statement macros should be enclosed in a do while loop, grab the
5261 # first statement and ensure its the whole macro if its not enclosed
5262 # in a known good container
5274 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5275 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5290 }
5297 # Flatten any parentheses and braces
5301 {
5302 }
5304 # Flatten any obvious string concatenation.
5307 {
5308 }
5310 # Make asm volatile uses seem like a generic function
5315 module_param_named|
5316 MODULE_PARM_DESC|
5317 DECLARE_PER_CPU|
5318 DEFINE_PER_CPU|
5319 __typeof__\(|
5320 union|
5321 struct|
5326 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5335 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5340 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5346 {
5349 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5356 }
5358 }
5360 # Make $define_stmt single line, comment-free, etc
5371 }
5372 }
5377 # check if any macro arguments are reused (ignore '...' and 'type')
5382 $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5389 }
5390 # check if any macro arguments may have other precedence issues
5396 }
5397 }
5399 # check for macros with flow control, but without ## concatenation
5400 # ## concatenation is commonly a macro that defines a function so ignore those
5407 }
5409 # check for line continuations outside of #defines, preprocessor #, and asm
5418 }
5419 }
5421 # do {} while (0) macro tests:
5422 # single-statement macros do not need to be enclosed in do while (0) loop,
5423 # macro should not end with a semicolon
5438 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5450 }
5454 }
5462 }
5463 }
5465 # check for redundant bracing round if etc
5469 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5470 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5480 # If the condition carries leading newlines, then count those as offsets.
5485 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5487 # We have looked at and allowed this specific line.
5497 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5499 #print "APW: ALLOWED: cond<$cond>\n";
5501 }
5503 #print "APW: ALLOWED: block<$block>\n";
5505 }
5507 #print "APW: ALLOWED: lines block<$block>\n";
5509 }
5511 }
5516 }
5524 }
5525 }
5526 }
5527 }
5532 # Check the pre-context.
5534 #print "APW: ALLOWED: pre<$1>\n";
5536 }
5541 # Check the condition.
5543 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5546 }
5548 #print "APW: ALLOWED: cond<$cond>\n";
5550 }
5552 #print "APW: ALLOWED: block<$block>\n";
5554 }
5556 #print "APW: ALLOWED: lines block<$block>\n";
5558 }
5559 # Check the post-context.
5564 }
5566 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5568 }
5569 }
5576 }
5577 }
5579 # check for single line unbalanced braces
5583 }
5585 # check for unnecessary blank lines around braces
5591 }
5592 }
5598 }
5599 }
5601 # no volatiles please
5605 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5606 }
5608 # Check for user-visible strings broken across lines, which breaks the ability
5609 # to grep for the string. Make exceptions when the previous string ends in a
5610 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5611 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5624 }
5636 }
5638 }
5639 }
5641 # check for missing a space in a string concatenation
5645 }
5647 # check for an embedded function name in a string when the function is known
5648 # This does not work very well for -f --file checking as it depends on patch
5649 # context providing the function name or a single line form for in-file
5650 # function declarations
5656 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5657 }
5659 # check for spaces before a quoted newline
5665 }
5667 }
5669 # concatenated string without spaces between elements
5678 }
5679 }
5680 }
5682 # uncoalesced string fragments
5690 }
5691 }
5692 }
5694 # check for non-standard and hex prefixed decimal printf formats
5700 # check for %L
5705 }
5706 # check for %Z
5711 }
5712 # check for 0x<decimal>
5716 }
5717 }
5719 # check for line continuations in quoted strings with odd counts of "
5723 }
5725 # warn about #if 0
5729 }
5731 # warn about #if 1
5735 }
5737 # check for needless "if (<foo>) fn(<foo>)" uses
5741 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5753 }
5758 }
5761 }
5765 }
5766 }
5767 }
5768 }
5770 # check for unnecessary "Out of Memory" messages
5779 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5781 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5785 }
5786 }
5788 # check for logging functions with KERN_<LEVEL>
5796 }
5797 }
5799 # check for logging continuations
5803 }
5805 # check for mask then right shift without a parentheses
5811 }
5813 # check for pointer comparisons to NULL
5823 }
5824 }
5825 }
5827 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5830 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5840 $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;
5841 }
5842 }
5843 }
5845 # check for $InitAttributeData (ie: __initdata) with const
5856 }
5857 }
5859 # check for $InitAttributeConst (ie: __initconst) without const
5871 }
5872 }
5874 # check for __read_mostly with const non-pointer (should just be const)
5881 }
5882 }
5884 # don't use __constant_<foo> functions outside of include/uapi/
5886 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5894 }
5895 }
5897 # prefer usleep_range over udelay
5900 # ignore udelay's < 10, however
5903 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5904 }
5908 }
5909 }
5911 # warn about unexpectedly long msleep's
5915 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5916 }
5917 }
5919 # check for comparisons of jiffies
5922 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5923 }
5925 # check for comparisons of get_jiffies_64()
5928 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5929 }
5931 # warn about #ifdefs in C files
5932 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5933 # print "#ifdef in C files should be avoided\n";
5934 # print "$herecurr";
5935 # $clean = 0;
5936 # }
5938 # warn about spacing in #ifdefs
5945 }
5947 }
5949 # check for spinlock_t definitions without a comment.
5956 }
5957 }
5958 # check for memory barriers without a comment.
5961 mb|
5962 rmb|
5963 wmb
5966 mb__before_atomic|
5967 mb__after_atomic|
5968 store_release|
5969 load_acquire|
5970 store_mb|
5983 }
5984 }
5994 }
5996 # check for waitqueue_active without a comment.
6001 }
6002 }
6004 # check for data_race without a comment.
6009 }
6010 }
6012 # check of hardware specific defines
6013 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
6016 }
6018 # check that the storage class is not after a type
6022 }
6023 # Check that the storage class is at the beginning of a declaration
6030 }
6032 # check the location of the inline attribute, that it is between
6033 # storage class and type.
6038 }
6040 # Check for __inline__ and __inline, prefer inline
6048 }
6049 }
6051 # Check for __attribute__ packed, prefer __packed
6056 }
6058 # Check for __attribute__ aligned, prefer __aligned
6063 }
6065 # Check for __attribute__ section, prefer __section
6073 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
6074 }
6075 }
6077 # Check for __attribute__ format(printf, prefer __printf
6081 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
6083 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
6085 }
6086 }
6088 # Check for __attribute__ format(scanf, prefer __scanf
6092 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
6094 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
6095 }
6096 }
6098 # Check for __attribute__ weak, or __weak declarations (may have link issues)
6100 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
6105 }
6107 # check for c99 types like uint8_t used outside of uapi/ and tools/
6122 }
6123 }
6124 }
6126 # check for cast of C90 native int or longer types constants
6141 }
6143 }
6144 }
6146 # check for sizeof(&)
6150 }
6152 # check for sizeof without parenthesis
6157 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6158 }
6159 }
6161 # check for struct spinlock declarations
6165 }
6167 # check for seq_printf uses that could be seq_puts
6176 }
6177 }
6178 }
6180 # check for vsprintf extension %p<foo> misuses
6206 }
6210 }
6212 "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");
6213 }
6214 }
6222 }
6226 }
6227 }
6228 }
6230 # Check for misused memsets
6245 }
6246 }
6248 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6249 # if ($perl_version_ok &&
6250 # defined $stat &&
6251 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6252 # if (WARN("PREFER_ETHER_ADDR_COPY",
6253 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6254 # $fix) {
6255 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6256 # }
6257 # }
6259 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6260 # if ($perl_version_ok &&
6261 # defined $stat &&
6262 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6263 # WARN("PREFER_ETHER_ADDR_EQUAL",
6264 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6265 # }
6267 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6268 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6269 # if ($perl_version_ok &&
6270 # defined $stat &&
6271 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6272 #
6273 # my $ms_val = $7;
6274 #
6275 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6276 # if (WARN("PREFER_ETH_ZERO_ADDR",
6277 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6278 # $fix) {
6279 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6280 # }
6281 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6282 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6283 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6284 # $fix) {
6285 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6286 # }
6287 # }
6288 # }
6290 # typecasts on min/max could be min_t/max_t
6308 }
6311 }
6312 }
6314 # check usleep_range arguments
6322 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6326 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6327 }
6328 }
6330 # check for naked sscanf
6342 }
6344 # check for simple sscanf that should be kstrto<foo>
6358 }
6359 }
6360 }
6362 # check for new externs in .h files.
6369 }
6370 }
6372 # check for new externs in .c files.
6375 {
6382 }
6384 {
6387 }
6392 }
6396 {
6399 }
6401 # check for function declarations that have arguments without identifier names
6403 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6411 }
6412 }
6413 }
6415 # check for function definitions
6421 # check for multiline function definition with misplaced open brace
6431 }
6435 }
6436 }
6438 # checks for new __setup's
6444 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr);
6445 }
6446 }
6448 # check for pointless casting of alloc functions
6451 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6452 }
6454 # alloc style
6455 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6457 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6460 }
6462 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6465 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6476 }
6486 $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;
6487 }
6488 }
6489 }
6491 # check for krealloc arg reuse
6497 }
6499 # check for alloc argument mismatch
6503 }
6505 # check for multiple semicolons
6511 }
6512 }
6514 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6523 }
6524 }
6526 # check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too)
6530 }
6532 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6533 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6539 }
6540 }
6542 # check for /* fallthrough */ like comment, prefer fallthrough;
6551 );
6560 }
6561 }
6562 }
6564 # check for switch/default statements without a break;
6573 }
6575 # check for gcc specific __FUNCTION__
6581 }
6582 }
6584 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6588 }
6590 # check for use of yield()
6594 }
6596 # check for comparisons against true and false
6612 }
6617 ## maybe suggesting a correct construct would better
6618 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6620 }
6621 }
6623 # check for semaphores initialized locked
6627 }
6629 # recommend kstrto* over simple_strto* and strict_strto*
6633 }
6635 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6638 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6639 }
6641 # check for spin_is_locked(), suggest lockdep instead
6644 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6645 }
6647 # check for deprecated apis
6653 }
6655 # check for various structs that are normally const (ops, kgdb, device_tree)
6656 # and avoid what seem like struct definitions 'struct foo {'
6662 }
6664 # use of NR_CPUS is usually wrong
6665 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6672 {
6674 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6675 }
6677 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6681 }
6683 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6688 }
6690 # nested likely/unlikely calls
6694 }
6696 # whine mightly about in_atomic
6704 }
6705 }
6707 # check for mutex_trylock_recursive usage
6711 }
6713 # check for lockdep_set_novalidate_class
6721 }
6722 }
6727 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6728 }
6730 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6731 # and whether or not function naming is typical and if
6732 # DEVICE_ATTR permissions uses are unusual too
6735 $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*\)/) {
6747 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6748 }
6755 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6756 }
6763 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6764 }
6775 }
6778 }
6784 }
6785 }
6787 # Mode permission misuses where it seems decimal should be octal
6788 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6789 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6790 # specific definition of not visible in sysfs.
6791 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6792 # use the default permissions
6808 }
6818 }
6821 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6822 }
6823 }
6824 }
6825 }
6827 # check for uses of S_<PERMS> that could be octal for readability
6832 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6835 }
6836 }
6838 # validate content of MODULE_LICENSE against list from include/linux/module.h
6842 GPL|
6843 GPL\ v2|
6848 Proprietary
6853 }
6854 }
6856 # check for sysctl duplicate constants
6859 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6860 }
6861 }
6863 # If we have no input at all, then there is nothing to report on
6864 # so just keep quiet.
6867 }
6869 # In mailback mode only produce a report in the negative, for
6870 # things that appear to be patches.
6873 }
6875 # This is not a patch, and we are are in 'no-patch' mode so
6876 # just keep quiet.
6879 }
6884 }
6892 }
6893 }
6901 }
6904 # If there were any defects found and not already fixing them
6910 EOM
6911 }
6912 # If there were whitespace errors which cleanpatch can fix
6913 # then suggest that.
6920 EOM
6921 }
6922 }
6942 }
6945 }
6946 }
6954 Do _NOT_ trust the results written to this file.
6957 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6959 EOM
6960 }
6961 }
6969 }
6970 }
6972 }