| blob | b83be177edf0ac70760171665700847257bfbe5b |
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(
256 }
258 #if no filenames are given, push '-' to read patch from stdin
261 }
273 }
275 # skip TAB size 1 to avoid additional checks on $tabsize - 1
292 }
293 }
302 }
304 }
305 }
315 ## no critic
318 }
325 }
331 }
338 }
339 }
344 }
345 }
355 __user|
356 __kernel|
357 __force|
358 __iomem|
359 __must_check|
360 __kprobes|
361 __ref|
362 __refconst|
363 __refdata|
364 __rcu|
365 __private
373 # Notes to $Attribute:
374 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
376 const|
377 __percpu|
378 __nocast|
379 __safe|
380 __bitwise|
381 __packed__|
382 __packed2__|
383 __naked|
384 __maybe_unused|
385 __always_unused|
386 __noreturn|
387 __used|
388 __cold|
389 __pure|
390 __noclone|
391 __deprecated|
392 __read_mostly|
393 __ro_after_init|
394 __kprobes|
396 ____cacheline_aligned|
397 ____cacheline_aligned_in_smp|
398 ____cacheline_internodealigned_in_smp|
399 __weak
421 <=|>=|==|!=|
422 =>|->|<<|>>|<|>|!|~|
456 )};
459 atomic_t
460 )};
465 )};
471 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
472 TP_printk|
474 panic|
477 )};
485 # dev_alloc_skb/netdev_alloc_skb, et al
486 dma_alloc_coherent
487 )};
497 To:|
498 Cc:
499 )};
518 );
541 );
562 )};
569 );
573 );
580 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
587 );
589 #Create a search pattern for all these functions to speed up a loop below
594 }
608 );
610 #Create a search pattern for all these strings to speed up a loop below
615 }
619 S_IWUGO |
620 S_IWOTH |
621 S_IRWXUGO |
622 S_IALLUGO |
643 );
645 #Create a search pattern for all these strings to speed up a loop below
650 }
677 }
681 }
684 irq|
685 memory|
687 reboot
688 )};
689 # memory.h: ARM has a custom one
691 # Load common spelling mistakes and build regular expression list.
708 }
712 }
731 }
735 }
736 }
755 }
759 }
762 }
765 }
775 }
794 )
801 )
810 )
814 $NonptrType
819 $NonptrTypeMisordered
825 }
826 build_types();
830 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
831 # requires at least perl version v5.10.0
832 # Any use must be runtime checked with $^V
843 )};
852 }
857 }
881 }
882 }
883 }
893 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
894 }
897 }
902 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
908 }
921 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
932 }
934 }
942 }
946 }
951 }
955 }
963 }
965 }
966 }
980 # Maybe one day convert this block of bash into something that returns
981 # all matching commit ids, but it's very slow...
982 #
983 # echo "checking commits $1..."
984 # git rev-list --remotes | grep -i "^$1" |
985 # while read line ; do
986 # git log --format='%H %s' -1 $line |
987 # echo "commit $(cut -c 1-12,41-)"
988 # done
989 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
994 }
997 }
1008 # If input is git commits, extract all commits from the commit expressions.
1009 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1022 }
1031 }
1032 }
1035 }
1052 }
1059 }
1063 }
1070 }
1074 }
1083 build_types();
1084 }
1095 EOM
1096 }
1102 EOM
1103 }
1104 }
1115 );
1120 }
1121 }
1123 }
1147 # If there's a name left after stripping spaces and
1148 # leading quotes, and the address doesn't have both
1149 # leading and trailing angle brackets, the address
1150 # is invalid. ie:
1151 # "joe smith joe@smith.com" bad
1152 # "joe smith <joe@smith.com" bad
1157 }
1158 }
1165 }
1172 }
1175 }
1189 }
1195 }
1198 }
1205 }
1215 }
1223 }
1224 }
1227 }
1235 }
1236 }
1239 }
1252 }
1254 }
1257 }
1260 }
1264 }
1269 # Drop the diff line leader and expand tabs
1273 # Pick the indent from the front of the line.
1277 }
1288 }
1289 }
1300 # Always copy over the diff marker.
1306 # Comments we are whacking completely including the begin
1307 # and end, all to $;.
1314 }
1320 }
1327 }
1329 # A \ in a string means ignore the next character.
1335 }
1336 # Regular quotes.
1345 }
1346 }
1348 #print "c<$c> SQ<$sanitise_quote>\n";
1357 }
1358 }
1362 }
1364 # The pathname on a #include may be surrounded by '<' and '>'.
1369 # The whole of a #error is a string.
1373 }
1378 }
1381 }
1389 }
1412 #warn "CSB: blk<$blk> remain<$remain>\n";
1413 # If we are about to drop off the end, pull in more
1414 # context.
1425 }
1426 # Bail if there is no further context.
1427 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1430 }
1434 }
1435 }
1440 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1442 # Handle nested #if/#else.
1449 }
1451 # Statement ends at the ';' or a close '}' at the
1452 # outermost level.
1455 }
1457 # An else is really a conditional as long as its not else if
1464 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1465 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1466 }
1471 }
1479 #warn "CSB: mark coff<$coff>\n";
1480 }
1481 }
1485 }
1493 }
1495 }
1496 }
1497 # Preprocessor commands end at the newline unless escaped.
1503 }
1505 }
1506 # We are truly at the end, so shuffle to the next line.
1511 }
1516 #warn "STATEMENT<$statement>\n";
1517 #warn "CONDITION<$condition>\n";
1519 #print "coff<$coff> soff<$off> loff<$loff>\n";
1523 }
1528 # Strip the diff line prefixes and rip blank lines at start and end.
1536 }
1544 }
1565 }
1566 }
1574 # Grab the first conditional/block pair.
1577 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1581 }
1583 # Pull in the following conditional/block pairs and see if they
1584 # could continue the statement.
1588 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1590 #print "C: push\n";
1592 }
1595 }
1614 # Handle nested #if/#else.
1621 }
1624 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1628 }
1635 }
1636 }
1640 }
1643 }
1646 }
1652 }
1658 }
1664 }
1669 }
1674 }
1679 # Catch a comment on the end of the line itself.
1683 # Look through the context and try and figure out if there is a
1684 # comment.
1689 #warn " $line\n";
1692 }
1695 }
1698 }
1702 }
1703 }
1707 }
1712 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1713 ##print "CMMT: $cmt\n";
1716 }
1729 }
1732 }
1740 }
1743 }
1751 }
1754 }
1766 }
1767 }
1771 }
1783 }
1803 }
1824 }
1853 # Assume all arms of the conditional end as this
1854 # one does, and continue as if the #endif was not here.
1871 }
1902 }
1914 }
1947 }
1962 }
1971 }
1975 }
1979 }
1980 }
1983 }
1992 DEFINE_\S+
1993 )$|
1997 case|
2001 \#|
2002 \#\#|
2008 # Check for modifiers.
2019 }
2020 }
2025 }
2026 build_types();
2029 }
2030 }
2042 }
2050 }
2059 }
2060 }
2065 }
2073 }
2079 }
2083 }
2094 }
2095 }
2122 }
2128 }
2135 }
2140 }
2143 }
2146 }
2154 };
2156 }
2164 };
2167 }
2176 }
2178 }
2186 }
2188 }
2196 }
2198 }
2204 ##print "absolute<$absolute>\n";
2206 # See if any suffix of this path is a path within the tree.
2209 ##print "file<$file>\n";
2211 }
2212 }
2215 }
2217 # It is, so see if the prefix is acceptable.
2221 ##print "prefix<$prefix>\n";
2225 }
2226 }
2234 }
2242 }
2250 }
2258 }
2267 #convert leading spaces to tabs
2269 #Remove spaces before a tab
2273 }
2287 }
2299 }
2300 }
2303 }
2312 }
2313 }
2316 }
2358 # Trace the real file/line as we go.
2371 # suppression flags
2379 # Pre-scan the patch sanitizing the lines.
2380 # Pre-scan the patch looking for any __setup documentation.
2381 #
2389 sanitise_line_reset();
2401 }
2402 #next;
2403 }
2410 }
2413 # Guestimate if this is a continuing comment. Run
2414 # the context looking for a comment "edge". If this
2415 # edge is a close comment then we must be in a comment
2416 # at context start.
2423 #print "RAW<$rawlines[$ln - 1]>\n";
2429 }
2430 }
2433 }
2435 # Guestimate if this is a continuing comment. If this
2436 # is the start of a diff block and this line starts
2437 # ' *' then it is very likely a comment.
2440 {
2442 }
2444 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2448 # Standardise the strings and chars within the input to
2449 # simplify matching -- only bother with positive lines.
2451 }
2458 }
2460 #print "==>$rawline\n";
2461 #print "-->$line\n";
2465 }
2466 }
2482 # check if it's a mode change, rename or start of a patch
2488 }
2490 #extract the line range in the file after the patch is applied
2501 }
2502 annotate_reset();
2513 }
2516 # track the line number as we move through the hunk, note that
2517 # new versions of GNU diff omit the leading space on completely
2518 # blank context lines so we need to count that too.
2523 # Measure the line length and indent.
2526 # Track the previous line.
2531 #warn "line<$line>\n";
2535 }
2543 # extract the filename as it passes
2559 }
2563 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2564 }
2566 }
2568 #make up the handle for any error we report on this line
2576 }
2577 }
2582 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2583 }
2588 }
2599 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2600 }
2601 }
2604 }
2614 # Verify the existence of a commit log if appropriate
2615 # 2 is used because a $signature is counted in $commit_log_lines
2619 }
2624 }
2626 # Check if the commit log has what seems like a diff which can confuse patch
2635 }
2637 # Check for incorrect file permissions
2644 }
2645 }
2647 # Check the patch for a From:
2653 }
2655 # Check the patch for a signoff:
2662 }
2663 }
2664 }
2666 # Check for patch separator
2670 }
2672 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2673 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2676 }
2678 # Check signature styles
2690 }
2697 }
2698 }
2705 }
2707 }
2714 }
2715 }
2726 # Don't force email to have quotes
2727 # Allow just an angle bracketed address
2731 }
2732 }
2734 # Check for duplicate signatures
2743 }
2745 # Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2749 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2750 }
2756 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2759 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2760 }
2761 }
2762 }
2764 # Check email subject for common tools that don't need to be mentioned
2769 }
2771 # Check for Gerrit Change-Ids not in any patch context
2775 }
2777 # Check if the commit log is in a possible stack dump
2781 # timestamp
2785 # stack dump address styles
2787 }
2789 # Check for line lengths > 75 in commit log, warn once
2793 # file delta changes
2795 # filename then :
2797 # A Fixes: or Link: line
2802 }
2804 # Reset possible stack dump if a blank line is found
2808 }
2810 # Check for git id commit length and improperly formed commit descriptions
2835 }
2857 }
2865 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2866 }
2867 }
2869 # Check for added, moved or deleted files
2879 }
2881 # Check for adding new DT bindings not in schema format
2886 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
2887 }
2889 # Check for wrappage within a valid hunk of the file
2894 }
2896 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2907 }
2909 # Check if it's the start of a commit log
2910 # (not a header line and we haven't seen the patch filename)
2917 }
2919 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2920 # declined it, i.e defined some charset where it is missing.
2925 }
2931 }
2933 # Check for absolute kernel paths in commit message
2940 #
2943 }
2944 }
2945 }
2947 # Check for various typo / spelling mistakes
2961 }
2962 }
2963 }
2965 # check for invalid commit id
2973 }
2974 }
2976 # ignore non-hunk lines and lines being removed
2979 #trailing whitespace
2986 }
2993 }
2996 }
2998 # Check for FSF mailing addresses.
3007 "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)
3008 }
3010 # check for Kconfig help text having a real description
3011 # Only applies when adding the entry originally, after that we do not have
3012 # sufficient context to determine whether it is indeed long enough.
3014 # 'choice' is usually the last thing on the line (though
3015 # Kconfig supports named choices), so use a word boundary
3016 # (\b) rather than a whitespace character (\s)
3038 }
3040 }
3047 # This only checks context lines in the patch
3048 # and so hopefully shouldn't trigger false
3049 # positives, even though some of these are
3050 # common words in help texts
3055 }
3057 }
3061 }
3062 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3063 }
3065 # check for MAINTAINERS entries that don't have the right form
3073 }
3074 }
3076 # discourage the use of boolean for type definition attributes of Kconfig options
3081 }
3091 };
3094 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3095 }
3097 # check for DT compatible documentation
3116 }
3123 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3124 }
3125 }
3126 }
3128 # check for using SPDX license tag at beginning of files
3142 }
3144 # check SPDX comment style for .[chsS] files
3150 }
3161 }
3170 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/;
3171 }
3172 }
3173 }
3174 }
3175 }
3177 # check we are in a valid source file if not then ignore this hunk
3180 # check for using SPDX-License-Identifier on the wrong line number
3186 }
3188 # line length limit (with some exclusions)
3189 #
3190 # There are a few types of lines that may extend beyond $max_line_length:
3191 # logging functions like pr_info that end in a string
3192 # lines with a single string
3193 # #defines that are a single string
3194 # lines with an RFC3986 like URL
3195 #
3196 # There are 3 different line length message types:
3197 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3198 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3199 # LONG_LINE all other lines longer than $max_line_length
3200 #
3201 # if LONG_LINE is ignored, the other 2 types are also ignored
3202 #
3207 # Check the allowed long line types first
3209 # logging functions that end in a string that starts
3210 # before $max_line_length
3211 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3215 # lines with only strings (w/ possible termination)
3216 # #defines with only strings
3221 # More special cases
3226 # URL ($rawline is used in case the URL is in a comment)
3230 # Otherwise set the alternate message types
3232 # a comment starts before $max_line_length
3237 # a quoted string starts before $max_line_length
3241 }
3249 }
3250 }
3252 # check for adding lines without a newline.
3253 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3256 }
3258 # check we are in a valid source file C or perl if not then ignore this hunk
3261 # at the beginning of a line any tabs must come first and anything
3262 # more than $tabsize must use tabs.
3271 }
3272 }
3274 # check for space before tabs.
3284 }
3285 }
3287 # check for assignments on the start of a line
3291 }
3293 # check for && or || at the start of a line
3297 }
3299 # check indentation starts on a tab stop
3301 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3308 }
3309 }
3310 }
3312 # check multi-line statement indentation matches previous line
3314 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3337 }
3338 }
3339 }
3340 }
3342 # check for space after cast like "(int) foo" or "(struct foo) bar"
3343 # avoid checking a few false positives:
3344 # "sizeof(<type>)" or "__alignof__(<type>)"
3345 # function pointer declarations like "(*foo)(int) = bar;"
3346 # structure definitions like "(struct foo) { 0 };"
3347 # multiline macros that define functions
3348 # known attributes or the __attribute__ keyword
3356 }
3357 }
3359 # Block comment styles
3360 # Networking with an initial /*
3367 }
3369 # Block comments use * on subsequent lines
3377 }
3379 # Block comments use */ on trailing lines
3386 }
3388 # Block comment * alignment
3402 }
3409 }
3410 }
3412 # check for missing blank lines after struct/union declarations
3413 # with exceptions for various attributes and macros
3429 }
3430 }
3432 # check for multiple consecutive blank lines
3440 }
3443 }
3445 # check for missing blank lines after declarations
3447 # actual declarations
3449 # function pointer declarations
3451 # foo bar; where foo is some local typedef or #define
3453 # known declaration macros
3455 # for "else if" which can look like "$Ident $Ident"
3457 # other possible extensions of declaration lines
3459 # not starting a section or a macro "\" extended line
3461 # looks like a declaration
3463 # function pointer declarations
3465 # foo bar; where foo is some local typedef or #define
3467 # known declaration macros
3469 # start of struct or union or enum
3471 # start or end of block or continuation of declaration
3473 # bitfield continuation
3475 # other possible extensions of declaration lines
3477 # indentation of previous and current line are the same
3483 }
3484 }
3486 # check for spaces at the beginning of a line.
3487 # Exceptions:
3488 # 1) within comments
3489 # 2) indented preprocessor commands
3490 # 3) hanging labels
3497 }
3498 }
3500 # check we are in a valid C source file if not then ignore this hunk
3503 # check for unusual line ending [ or (
3507 }
3509 # check if this appears to be the start function declaration, save the name
3513 }
3515 # check if this appears to be the end of function declaration
3518 }
3520 # check indentation of any line with a bare else
3521 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3522 # if the previous line is a break or return and is indented 1 tab more...
3531 }
3532 }
3534 # check indentation of a line with a break;
3535 # if the previous line is a goto or return and is indented the same # of tabs
3541 }
3542 }
3544 # check for RCS/CVS revision markers
3548 }
3550 # check for old HOTPLUG __dev<foo> section markings
3554 }
3556 # Check for potential 'bare' types
3559 #print "LINE<$line>\n";
3567 #print "linenr<$linenr> <$stat>\n";
3568 # If this statement has no statement boundaries within
3569 # it there is no point in retrying a statement scan
3570 # until we hit end of it.
3573 #print "skip<$line_nr_next>\n";
3575 }
3577 # Find the real next line.
3583 }
3588 # Ignore goto labels.
3591 # Ignore functions being called
3596 # declarations always start with types
3597 } 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) {
3602 # definitions in global scope can only start with types
3605 }
3607 # any (foo ... *) is a pointer cast, and foo is a type
3610 }
3612 # Check for any sort of function declaration.
3613 # int foo(something bar, other baz);
3614 # void (*store_gdt)(x86_descr_ptr *);
3615 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3623 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3626 }
3627 }
3628 }
3630 }
3632 #
3633 # Checks which may be anchored in the context.
3634 #
3636 # Check for switch () and associated case and default
3637 # statements should be at the same indent.
3651 }
3652 }
3656 }
3657 }
3659 # if/while/etc brace do not go on next line, unless defining a do while loop,
3660 # or if that brace on the next line is for something else
3661 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3669 }
3680 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3683 }
3685 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3686 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3692 }
3696 {
3702 }
3703 }
3704 }
3706 # Check relative indent for conditionals and blocks.
3707 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3715 # remove inline comments
3719 # Find out how long the conditional actually is.
3723 # Make sure we remove the line prefixes as we have
3724 # none on the first line, and are going to readd them
3725 # where necessary.
3729 }
3731 # We want to check the first line inside the block
3732 # starting at the end of the conditional, so remove:
3733 # 1) any blank line termination
3734 # 2) any opening brace { on end of the line
3735 # 3) any do (...) {
3742 }
3746 }
3748 # Also ignore a loop construct at the end of a
3749 # preprocessor statement.
3753 }
3760 # If we see an #else/#elif then the code
3761 # is not linear.
3764 }
3766 # Ignore:
3767 # 1) blank lines, they should be at 0,
3768 # 2) preprocessor lines, and
3769 # 3) labels.
3777 }
3778 }
3779 }
3784 # Check if either of these lines are modified, else
3785 # this is not this patch's fault.
3789 }
3792 }
3794 #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";
3803 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3804 }
3805 }
3807 # Track the 'values' across context and added lines.
3817 }
3820 #ignore lines not being added
3823 # check for dereferences that span multiple lines
3833 }
3835 # check for declarations of signed or unsigned without int
3836 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3847 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3855 }
3856 }
3857 }
3859 # TEST: allow direct testing of the type matcher.
3867 }
3869 }
3870 # TEST: allow direct testing of the attribute matcher.
3878 }
3880 }
3882 # check for initialisation to aggregates open brace on the next line
3896 }
3897 }
3899 #
3900 # Checks which are anchored on the added line.
3901 #
3903 # check for malformed paths in #include statements (uses RAW line)
3909 }
3913 }
3914 }
3916 # no C99 // comments
3925 }
3926 }
3927 }
3928 # Remove C99 comments.
3932 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3933 # the whole statement.
3934 #print "APW <$lines[$realline_next - 1]>\n";
3940 # Handle definitions which produce identifiers with
3941 # a prefix:
3942 # XXX(foo);
3943 # EXPORT_SYMBOL(something_foo);
3947 #print "FOO C name<$name>\n";
3958 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3962 }
3963 }
3968 #print "FOO B <$lines[$linenr - 1]>\n";
3970 }
3975 }
3977 # check for global initialisers.
3983 }
3984 }
3985 # check for static initialisers.
3992 }
3993 }
3995 # check for misordered declarations of char/short/int/long with signed/unsigned
3999 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
4000 }
4002 # check for unnecessary <signed> int declarations of short/long/long long
4019 }
4020 }
4022 # check for static const char * arrays.
4027 }
4029 # check for initialized const char arrays that should be static const
4030 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
4035 }
4036 }
4038 # check for static char foo[] = "bar" declarations.
4043 }
4045 # check for const <foo> const where <foo> is not a pointer or array type
4054 }
4055 }
4057 # check for non-global char *foo[] = {"bar", ...} declarations.
4062 }
4064 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4067 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4073 }
4074 }
4075 }
4077 # check for function declarations without arguments like "int foo()"
4083 }
4084 }
4086 # check for new typedefs, only function parameters and sparse annotations
4087 # make sense.
4095 }
4097 # * goes on variable not on type
4098 # (char*[ const])
4100 #print "AA<$1>\n";
4103 # Should start with a space.
4105 # Should not end with a space.
4107 # '*'s should not have spaces between.
4109 }
4111 ## print "1: from<$from> to<$to> ident<$ident>\n";
4121 }
4122 }
4123 }
4125 #print "BB<$1>\n";
4128 # Should start with a space.
4130 # Should not end with a space.
4132 # '*'s should not have spaces between.
4134 }
4135 # Modifiers should have spaces.
4138 ## print "2: from<$from> to<$to> ident<$ident>\n";
4149 }
4150 }
4151 }
4153 # avoid BUG() or BUG_ON()
4158 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4159 }
4161 # avoid LINUX_VERSION_CODE
4164 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4165 }
4167 # check for uses of printk_ratelimit
4171 }
4173 # printk should use KERN_* levels
4177 }
4186 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
4187 }
4196 }
4198 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4199 # number of false positives, but assembly files are not checked, so at
4200 # least the arch entry code will not trigger this warning.
4204 }
4206 # function brace can't be on same line, except for #defines of do while,
4207 # or if closed on same line
4224 }
4225 }
4226 }
4228 # open braces for enum, union and struct go on the same line.
4242 }
4243 }
4244 }
4246 # missing space after union, struct or enum definition
4253 }
4254 }
4256 # Function pointer declarations
4257 # check spacing between type, funcptr, and args
4258 # canonical declaration is "type (*funcptr)(args...)"
4267 # the $Declare variable will capture all spaces after the type
4268 # so check it for a missing trailing missing space but pointer return types
4269 # don't need a space so don't warn for those.
4274 }
4279 }
4281 # unnecessary space "type (*funcptr)(args...)"
4282 # This test is not currently implemented because these declarations are
4283 # equivalent to
4284 # int foo(int bar, ...)
4285 # and this is form shouldn't/doesn't generate a checkpatch warning.
4286 #
4287 # elsif ($declare =~ /\s{2,}$/) {
4288 # WARN("SPACING",
4289 # "Multiple spaces after return type\n" . $herecurr);
4290 # }
4292 # unnecessary space "type ( *funcptr)(args...)"
4297 }
4299 # unnecessary space "type (* funcptr)(args...)"
4304 }
4306 # unnecessary space "type (*funcptr )(args...)"
4311 }
4313 # unnecessary space "type (*funcptr) (args...)"
4318 }
4322 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4323 }
4324 }
4326 # check for spacing round square brackets; allowed:
4327 # 1. with a type on the left -- int [] a;
4328 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4329 # 3. inside a curly brace -- = { [0...10] = 5 }
4340 }
4341 }
4342 }
4344 # check for spaces between functions and their parentheses.
4350 # Ignore those directives where spaces _are_ permitted.
4356 {
4357 # cpp #define statements have non-optional spaces, ie
4358 # if there is a space between the name and the open
4359 # parenthesis it is simply not a parameter group.
4362 # cpp #elif statement condition may start with a (
4365 # If this whole things ends with a type its most
4366 # likely a typedef for a function.
4375 }
4376 }
4377 }
4379 # Check operator spacing.
4385 <<=|>>=|<=|>=|==|!=|
4387 =>|->|<<|>>|<|>|=|!|~|
4393 ## print("element count: <" . $#elements . ">\n");
4394 ## foreach my $el (@elements) {
4395 ## print("el: <$el>\n");
4396 ## }
4404 }
4415 ## print("n: <$n> good: <$good>\n");
4419 # Pick up the preceding and succeeding characters.
4424 }
4447 }
4456 # Pull out the value of this operator.
4459 # Get the full operator variant.
4462 # Ignore operators passed as parameters.
4466 # # Ignore comments
4467 # } elsif ($op =~ /^$;+$/) {
4469 # ; should have either the end of line or a space or \ after it
4477 }
4478 }
4480 # // is a comment
4483 # : when part of a bitfield
4485 # skip the bitfield test for now
4487 # No spaces for:
4488 # ->
4496 }
4498 }
4499 }
4501 # , must not have a space before and must have a space on the right.
4510 }
4511 }
4518 }
4519 }
4525 }
4528 }
4529 }
4531 # '*' as part of a type definition -- reported already.
4533 #warn "'*' is part of type\n";
4535 # unary operators should have a space before and
4536 # none after. May be left adjacent to another
4537 # unary operator, or a cast
4547 }
4548 }
4549 }
4551 # A unary '*' may be const
4559 }
4561 }
4562 }
4564 # unary ++ and unary -- are allowed no space on one side.
4571 }
4572 }
4579 }
4580 }
4587 }
4589 }
4590 }
4592 # << and >> may either have or not have spaces both sides
4598 {
4606 }
4612 }
4613 }
4620 }
4622 }
4623 }
4625 # A colon needs no spaces before when it is
4626 # terminating a case value or a label.
4633 }
4634 }
4636 # All the others need spaces both sides.
4640 # Ignore email addresses <foo@bar>
4645 {
4647 }
4649 # for asm volatile statements
4650 # ignore a colon with another
4651 # colon immediately before or after
4655 }
4657 # messages are ERROR, but ?: are CHK
4667 }
4669 }
4670 }
4671 }
4674 ## print("n: <$n> GOOD: <$good>\n");
4677 }
4681 }
4685 }
4688 }
4690 # check for whitespace before a non-naked semicolon
4697 }
4698 }
4700 # check for multiple assignments
4704 }
4706 ## # check for multiple declarations, allowing for a function declaration
4707 ## # continuation.
4708 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4709 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4710 ##
4711 ## # Remove any bracketed sections to ensure we do not
4712 ## # falsly report the parameters of functions.
4713 ## my $ln = $line;
4714 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4715 ## }
4716 ## if ($ln =~ /,/) {
4717 ## WARN("MULTIPLE_DECLARATION",
4718 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4719 ## }
4720 ## }
4722 #need space before brace following if, while, etc
4729 }
4730 }
4732 ## # check for blank lines before declarations
4733 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4734 ## $prevrawline =~ /^.\s*$/) {
4735 ## WARN("SPACING",
4736 ## "No blank lines before declarations\n" . $hereprev);
4737 ## }
4738 ##
4740 # closing brace should have a space following it when it has anything
4741 # on the line
4748 }
4749 }
4751 # check spacing on square brackets
4758 }
4759 }
4766 }
4767 }
4769 # check spacing on parentheses
4777 }
4778 }
4787 }
4788 }
4790 # check unnecessary parentheses around addressof/dereference single $Lvals
4791 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4799 }
4800 }
4802 # check for unnecessary parentheses around function pointer uses
4803 # ie: (foo->bar)(); should be foo->bar();
4804 # but not "if (foo->bar) (" to avoid some false positives
4813 }
4814 }
4816 # check for unnecessary parentheses around comparisons in if uses
4817 # when !drivers/staging or command-line uses --strict
4824 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4826 # avoid parentheses around potential macro args
4835 }
4836 }
4839 }
4840 }
4842 #goto labels aren't indented, allow a single space however
4850 }
4851 }
4853 # return is not a function
4863 }
4867 }
4868 }
4870 # unnecessary return in a void function
4871 # at end-of-function, with the previous line a single leading tab, then return;
4872 # and the line before that not a goto label target like "out:"
4880 }
4882 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4888 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4893 }
4894 }
4896 # comparisons with a constant or upper case identifier on the left
4897 # avoid cases like "foo + BAR < baz"
4898 # only fix matches surrounded by parentheses to avoid incorrect
4899 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4920 }
4922 }
4923 }
4925 # Return of what appears to be an errno should normally be negative
4931 }
4932 }
4934 # Need a space before open parenthesis after if, while etc
4941 }
4942 }
4944 # Check for illegal assignment in if conditional -- and check for trailing
4945 # statements after the conditional.
4953 ##print "stat<$stat> stat_next<$stat_next>\n";
4956 # If the statement carries leading newlines,
4957 # then count those as offsets.
4965 }
4966 }
4975 }
4977 # Find out what is on the end of the line after the
4978 # conditional.
4984 {
4985 # Find out how long the conditional actually is.
4994 }
4998 }
4999 }
5001 # Check for bitwise tests written as boolean
5007 |
5012 {
5015 }
5017 # if and else should not have general statements after it
5024 }
5025 }
5026 # if should not continue a brace
5031 }
5032 # case and default should not have general statements after them
5038 {
5041 }
5043 # Check for }<nl>else {, these must be at the same
5044 # indent level to be relevant to each other.
5056 }
5060 }
5061 }
5067 # Find out what is on the end of the line after the
5068 # conditional.
5084 }
5085 }
5086 }
5088 #Specific variable tests
5092 #CamelCase
5095 #Ignore Page<foo> variants
5097 #Ignore SI style variants like nS, mV and dB
5098 #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5100 #Ignore some three character SI units explicitly, like MiB and KHz
5106 seed_camelcase_includes();
5110 }
5111 }
5116 }
5117 }
5118 }
5119 }
5121 #no spaces allowed after \ in define
5127 }
5128 }
5130 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5131 # itself <asm/foo.h> (uses RAW line)
5138 {
5147 }
5148 }
5149 }
5150 }
5152 # multi-statement macros should be enclosed in a do while loop, grab the
5153 # first statement and ensure its the whole macro if its not enclosed
5154 # in a known good container
5166 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5167 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5182 }
5189 # Flatten any parentheses and braces
5193 {
5194 }
5196 # Flatten any obvious string concatenation.
5199 {
5200 }
5202 # Make asm volatile uses seem like a generic function
5207 module_param_named|
5208 MODULE_PARM_DESC|
5209 DECLARE_PER_CPU|
5210 DEFINE_PER_CPU|
5211 __typeof__\(|
5212 union|
5213 struct|
5218 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5227 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5232 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5238 {
5241 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5248 }
5250 }
5252 # Make $define_stmt single line, comment-free, etc
5263 }
5264 }
5269 # check if any macro arguments are reused (ignore '...' and 'type')
5274 $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5281 }
5282 # check if any macro arguments may have other precedence issues
5288 }
5289 }
5291 # check for macros with flow control, but without ## concatenation
5292 # ## concatenation is commonly a macro that defines a function so ignore those
5299 }
5301 # check for line continuations outside of #defines, preprocessor #, and asm
5310 }
5311 }
5313 # do {} while (0) macro tests:
5314 # single-statement macros do not need to be enclosed in do while (0) loop,
5315 # macro should not end with a semicolon
5330 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5342 }
5346 }
5354 }
5355 }
5357 # check for redundant bracing round if etc
5361 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5362 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5372 # If the condition carries leading newlines, then count those as offsets.
5377 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5379 # We have looked at and allowed this specific line.
5389 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5391 #print "APW: ALLOWED: cond<$cond>\n";
5393 }
5395 #print "APW: ALLOWED: block<$block>\n";
5397 }
5399 #print "APW: ALLOWED: lines block<$block>\n";
5401 }
5403 }
5408 }
5416 }
5417 }
5418 }
5419 }
5424 # Check the pre-context.
5426 #print "APW: ALLOWED: pre<$1>\n";
5428 }
5433 # Check the condition.
5435 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5438 }
5440 #print "APW: ALLOWED: cond<$cond>\n";
5442 }
5444 #print "APW: ALLOWED: block<$block>\n";
5446 }
5448 #print "APW: ALLOWED: lines block<$block>\n";
5450 }
5451 # Check the post-context.
5456 }
5458 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5460 }
5461 }
5468 }
5469 }
5471 # check for single line unbalanced braces
5475 }
5477 # check for unnecessary blank lines around braces
5483 }
5484 }
5490 }
5491 }
5493 # no volatiles please
5497 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5498 }
5500 # Check for user-visible strings broken across lines, which breaks the ability
5501 # to grep for the string. Make exceptions when the previous string ends in a
5502 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5503 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5516 }
5528 }
5530 }
5531 }
5533 # check for missing a space in a string concatenation
5537 }
5539 # check for an embedded function name in a string when the function is known
5540 # This does not work very well for -f --file checking as it depends on patch
5541 # context providing the function name or a single line form for in-file
5542 # function declarations
5548 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5549 }
5551 # check for spaces before a quoted newline
5557 }
5559 }
5561 # concatenated string without spaces between elements
5570 }
5571 }
5572 }
5574 # uncoalesced string fragments
5582 }
5583 }
5584 }
5586 # check for non-standard and hex prefixed decimal printf formats
5592 # check for %L
5597 }
5598 # check for %Z
5603 }
5604 # check for 0x<decimal>
5608 }
5609 }
5611 # check for line continuations in quoted strings with odd counts of "
5615 }
5617 # warn about #if 0
5621 }
5623 # warn about #if 1
5627 }
5629 # check for needless "if (<foo>) fn(<foo>)" uses
5633 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5645 }
5650 }
5653 }
5657 }
5658 }
5659 }
5660 }
5662 # check for unnecessary "Out of Memory" messages
5671 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5673 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5677 }
5678 }
5680 # check for logging functions with KERN_<LEVEL>
5688 }
5689 }
5691 # check for logging continuations
5695 }
5697 # check for mask then right shift without a parentheses
5703 }
5705 # check for pointer comparisons to NULL
5715 }
5716 }
5717 }
5719 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5722 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5732 $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;
5733 }
5734 }
5735 }
5737 # check for $InitAttributeData (ie: __initdata) with const
5748 }
5749 }
5751 # check for $InitAttributeConst (ie: __initconst) without const
5763 }
5764 }
5766 # check for __read_mostly with const non-pointer (should just be const)
5773 }
5774 }
5776 # don't use __constant_<foo> functions outside of include/uapi/
5778 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5786 }
5787 }
5789 # prefer usleep_range over udelay
5792 # ignore udelay's < 10, however
5795 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5796 }
5800 }
5801 }
5803 # warn about unexpectedly long msleep's
5807 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5808 }
5809 }
5811 # check for comparisons of jiffies
5814 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5815 }
5817 # check for comparisons of get_jiffies_64()
5820 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5821 }
5823 # warn about #ifdefs in C files
5824 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5825 # print "#ifdef in C files should be avoided\n";
5826 # print "$herecurr";
5827 # $clean = 0;
5828 # }
5830 # warn about spacing in #ifdefs
5837 }
5839 }
5841 # check for spinlock_t definitions without a comment.
5848 }
5849 }
5850 # check for memory barriers without a comment.
5853 mb|
5854 rmb|
5855 wmb|
5856 read_barrier_depends
5859 mb__before_atomic|
5860 mb__after_atomic|
5861 store_release|
5862 load_acquire|
5863 store_mb|
5876 }
5877 }
5887 }
5889 # check for waitqueue_active without a comment.
5894 }
5895 }
5897 # check for smp_read_barrier_depends and read_barrier_depends
5901 }
5903 # check of hardware specific defines
5904 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5907 }
5909 # check that the storage class is not after a type
5913 }
5914 # Check that the storage class is at the beginning of a declaration
5921 }
5923 # check the location of the inline attribute, that it is between
5924 # storage class and type.
5929 }
5931 # Check for __inline__ and __inline, prefer inline
5939 }
5940 }
5942 # Check for __attribute__ packed, prefer __packed
5947 }
5949 # Check for __attribute__ aligned, prefer __aligned
5954 }
5956 # Check for __attribute__ section, prefer __section
5964 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
5965 }
5966 }
5968 # Check for __attribute__ format(printf, prefer __printf
5972 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5974 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5976 }
5977 }
5979 # Check for __attribute__ format(scanf, prefer __scanf
5983 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5985 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5986 }
5987 }
5989 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5991 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5996 }
5998 # check for c99 types like uint8_t used outside of uapi/ and tools/
6013 }
6014 }
6015 }
6017 # check for cast of C90 native int or longer types constants
6032 }
6034 }
6035 }
6037 # check for sizeof(&)
6041 }
6043 # check for sizeof without parenthesis
6048 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
6049 }
6050 }
6052 # check for struct spinlock declarations
6056 }
6058 # check for seq_printf uses that could be seq_puts
6067 }
6068 }
6069 }
6071 # check for vsprintf extension %p<foo> misuses
6097 }
6101 }
6103 "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");
6104 }
6105 }
6113 }
6117 }
6118 }
6119 }
6121 # Check for misused memsets
6136 }
6137 }
6139 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6140 # if ($perl_version_ok &&
6141 # defined $stat &&
6142 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6143 # if (WARN("PREFER_ETHER_ADDR_COPY",
6144 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6145 # $fix) {
6146 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6147 # }
6148 # }
6150 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6151 # if ($perl_version_ok &&
6152 # defined $stat &&
6153 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6154 # WARN("PREFER_ETHER_ADDR_EQUAL",
6155 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6156 # }
6158 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6159 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6160 # if ($perl_version_ok &&
6161 # defined $stat &&
6162 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6163 #
6164 # my $ms_val = $7;
6165 #
6166 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6167 # if (WARN("PREFER_ETH_ZERO_ADDR",
6168 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6169 # $fix) {
6170 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6171 # }
6172 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6173 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6174 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6175 # $fix) {
6176 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6177 # }
6178 # }
6179 # }
6181 # typecasts on min/max could be min_t/max_t
6199 }
6202 }
6203 }
6205 # check usleep_range arguments
6213 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6217 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6218 }
6219 }
6221 # check for naked sscanf
6233 }
6235 # check for simple sscanf that should be kstrto<foo>
6249 }
6250 }
6251 }
6253 # check for new externs in .h files.
6260 }
6261 }
6263 # check for new externs in .c files.
6266 {
6273 }
6276 {
6279 }
6284 }
6288 {
6291 }
6293 # check for function declarations that have arguments without identifier names
6294 # while avoiding uninitialized_var(x)
6296 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:($Ident)|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6307 }
6308 }
6309 }
6311 # check for function definitions
6317 # check for multiline function definition with misplaced open brace
6327 }
6331 }
6332 }
6334 # checks for new __setup's
6340 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6341 }
6342 }
6344 # check for pointless casting of alloc functions
6347 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6348 }
6350 # alloc style
6351 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6353 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6356 }
6358 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6361 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6372 }
6382 $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;
6383 }
6384 }
6385 }
6387 # check for krealloc arg reuse
6393 }
6395 # check for alloc argument mismatch
6399 }
6401 # check for multiple semicolons
6407 }
6408 }
6410 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6419 }
6420 }
6422 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6423 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6429 }
6430 }
6432 # check for case / default statements not preceded by break/fallthrough/switch
6449 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6450 }
6454 }
6455 }
6457 # check for /* fallthrough */ like comment, prefer fallthrough;
6466 );
6475 }
6476 }
6477 }
6479 # check for switch/default statements without a break;
6488 }
6490 # check for gcc specific __FUNCTION__
6496 }
6497 }
6499 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6503 }
6505 # check for use of yield()
6509 }
6511 # check for comparisons against true and false
6527 }
6532 ## maybe suggesting a correct construct would better
6533 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6535 }
6536 }
6538 # check for semaphores initialized locked
6542 }
6544 # recommend kstrto* over simple_strto* and strict_strto*
6548 }
6550 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6553 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6554 }
6556 # check for spin_is_locked(), suggest lockdep instead
6559 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6560 }
6562 # check for deprecated apis
6568 }
6570 # check for various structs that are normally const (ops, kgdb, device_tree)
6571 # and avoid what seem like struct definitions 'struct foo {'
6576 }
6578 # use of NR_CPUS is usually wrong
6579 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6586 {
6588 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6589 }
6591 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6595 }
6597 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6602 }
6604 # nested likely/unlikely calls
6608 }
6610 # whine mightly about in_atomic
6618 }
6619 }
6621 # check for mutex_trylock_recursive usage
6625 }
6627 # check for lockdep_set_novalidate_class
6635 }
6636 }
6641 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6642 }
6644 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6645 # and whether or not function naming is typical and if
6646 # DEVICE_ATTR permissions uses are unusual too
6649 $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*\)/) {
6661 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6662 }
6669 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6670 }
6677 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6678 }
6689 }
6692 }
6698 }
6699 }
6701 # Mode permission misuses where it seems decimal should be octal
6702 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6703 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6704 # specific definition of not visible in sysfs.
6705 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6706 # use the default permissions
6722 }
6732 }
6735 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6736 }
6737 }
6738 }
6739 }
6741 # check for uses of S_<PERMS> that could be octal for readability
6746 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6749 }
6750 }
6752 # validate content of MODULE_LICENSE against list from include/linux/module.h
6756 GPL|
6757 GPL\ v2|
6762 Proprietary
6767 }
6768 }
6770 # check for sysctl duplicate constants
6773 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6774 }
6775 }
6777 # If we have no input at all, then there is nothing to report on
6778 # so just keep quiet.
6781 }
6783 # In mailback mode only produce a report in the negative, for
6784 # things that appear to be patches.
6787 }
6789 # This is not a patch, and we are are in 'no-patch' mode so
6790 # just keep quiet.
6793 }
6798 }
6806 }
6807 }
6815 }
6818 # If there were any defects found and not already fixing them
6824 EOM
6825 }
6826 # If there were whitespace errors which cleanpatch can fix
6827 # then suggest that.
6834 EOM
6835 }
6836 }
6856 }
6859 }
6860 }
6868 Do _NOT_ trust the results written to this file.
6871 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6873 EOM
6874 }
6875 }
6883 }
6884 }
6886 }