| blob | 6fcc66afb088083080a4b492be6af4b67d4c1430 |
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
75 Options:
80 --emacs emacs compile window format
81 --terse one line per report
84 single git commit with:
88 multiple git commits with:
92 git merges are ignored
107 is all off)
109 literally
112 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
113 with potential errors corrected to the preferred
114 checkpatch style
119 runtime errors.
122 --codespellfile Use this codespell dictionary
123 --typedefsfile Read additional types from this file
129 EOM
132 }
137 }
153 # Also catch when type or level is passed through a variable
154 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
156 }
161 }
164 }
186 }
187 }
190 }
192 # Perl's Getopt::Long allows options to take optional arguments after a space.
193 # Prevent --color by itself from consuming other arguments
197 }
198 }
200 GetOptions(
251 }
253 #if no filenames are given, push '-' to read patch from stdin
256 }
268 }
284 }
285 }
294 }
296 }
297 }
307 ## no critic
310 }
317 }
323 }
330 }
331 }
336 }
337 }
347 __user|
348 __kernel|
349 __force|
350 __iomem|
351 __must_check|
352 __kprobes|
353 __ref|
354 __refconst|
355 __refdata|
356 __rcu|
357 __private
365 # Notes to $Attribute:
366 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
368 const|
369 __percpu|
370 __nocast|
371 __safe|
372 __bitwise|
373 __packed__|
374 __packed2__|
375 __naked|
376 __maybe_unused|
377 __always_unused|
378 __noreturn|
379 __used|
380 __cold|
381 __pure|
382 __noclone|
383 __deprecated|
384 __read_mostly|
385 __ro_after_init|
386 __kprobes|
388 ____cacheline_aligned|
389 ____cacheline_aligned_in_smp|
390 ____cacheline_internodealigned_in_smp|
391 __weak
413 <=|>=|==|!=|
414 =>|->|<<|>>|<|>|!|~|
448 )};
451 atomic_t
452 )};
457 )};
463 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
464 TP_printk|
466 panic|
469 )};
477 # dev_alloc_skb/netdev_alloc_skb, et al
478 dma_alloc_coherent
479 )};
489 To:|
490 Cc:
491 )};
510 );
533 );
554 )};
561 );
565 );
572 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
579 );
581 #Create a search pattern for all these functions to speed up a loop below
586 }
600 );
602 #Create a search pattern for all these strings to speed up a loop below
607 }
611 S_IWUGO |
612 S_IWOTH |
613 S_IRWXUGO |
614 S_IALLUGO |
635 );
637 #Create a search pattern for all these strings to speed up a loop below
642 }
669 }
673 }
676 irq|
677 memory|
679 reboot
680 )};
681 # memory.h: ARM has a custom one
683 # Load common spelling mistakes and build regular expression list.
700 }
704 }
723 }
727 }
728 }
747 }
751 }
754 }
757 }
767 }
786 )
793 )
802 )
806 $NonptrType
811 $NonptrTypeMisordered
817 }
818 build_types();
822 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
823 # requires at least perl version v5.10.0
824 # Any use must be runtime checked with $^V
835 )};
844 }
849 }
873 }
874 }
875 }
882 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
885 }
890 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
896 }
909 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
920 }
922 }
930 }
934 }
939 }
943 }
951 }
953 }
954 }
968 # Maybe one day convert this block of bash into something that returns
969 # all matching commit ids, but it's very slow...
970 #
971 # echo "checking commits $1..."
972 # git rev-list --remotes | grep -i "^$1" |
973 # while read line ; do
974 # git log --format='%H %s' -1 $line |
975 # echo "commit $(cut -c 1-12,41-)"
976 # done
977 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
982 }
985 }
996 # If input is git commits, extract all commits from the commit expressions.
997 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1010 }
1019 }
1020 }
1023 }
1040 }
1047 }
1051 }
1058 }
1062 }
1071 build_types();
1072 }
1083 EOM
1084 }
1090 EOM
1091 }
1092 }
1103 );
1108 }
1109 }
1111 }
1134 # If there's a name left after stripping spaces and
1135 # leading quotes, and the address doesn't have both
1136 # leading and trailing angle brackets, the address
1137 # is invalid. ie:
1138 # "joe smith joe@smith.com" bad
1139 # "joe smith <joe@smith.com" bad
1144 }
1145 }
1155 }
1158 }
1172 }
1178 }
1181 }
1189 }
1190 }
1193 }
1201 }
1202 }
1205 }
1218 }
1220 }
1223 }
1226 }
1230 }
1235 # Drop the diff line leader and expand tabs
1239 # Pick the indent from the front of the line.
1243 }
1254 }
1255 }
1266 # Always copy over the diff marker.
1272 # Comments we are whacking completely including the begin
1273 # and end, all to $;.
1280 }
1286 }
1293 }
1295 # A \ in a string means ignore the next character.
1301 }
1302 # Regular quotes.
1311 }
1312 }
1314 #print "c<$c> SQ<$sanitise_quote>\n";
1323 }
1324 }
1328 }
1330 # The pathname on a #include may be surrounded by '<' and '>'.
1335 # The whole of a #error is a string.
1339 }
1344 }
1347 }
1355 }
1378 #warn "CSB: blk<$blk> remain<$remain>\n";
1379 # If we are about to drop off the end, pull in more
1380 # context.
1391 }
1392 # Bail if there is no further context.
1393 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1396 }
1400 }
1401 }
1406 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1408 # Handle nested #if/#else.
1415 }
1417 # Statement ends at the ';' or a close '}' at the
1418 # outermost level.
1421 }
1423 # An else is really a conditional as long as its not else if
1430 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1431 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1432 }
1437 }
1445 #warn "CSB: mark coff<$coff>\n";
1446 }
1447 }
1451 }
1459 }
1461 }
1462 }
1463 # Preprocessor commands end at the newline unless escaped.
1469 }
1471 }
1472 # We are truly at the end, so shuffle to the next line.
1477 }
1482 #warn "STATEMENT<$statement>\n";
1483 #warn "CONDITION<$condition>\n";
1485 #print "coff<$coff> soff<$off> loff<$loff>\n";
1489 }
1494 # Strip the diff line prefixes and rip blank lines at start and end.
1502 }
1510 }
1531 }
1532 }
1540 # Grab the first conditional/block pair.
1543 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1547 }
1549 # Pull in the following conditional/block pairs and see if they
1550 # could continue the statement.
1554 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1556 #print "C: push\n";
1558 }
1561 }
1580 # Handle nested #if/#else.
1587 }
1590 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1594 }
1601 }
1602 }
1606 }
1609 }
1612 }
1618 }
1624 }
1630 }
1635 }
1640 }
1645 # Catch a comment on the end of the line itself.
1649 # Look through the context and try and figure out if there is a
1650 # comment.
1655 #warn " $line\n";
1658 }
1661 }
1664 }
1668 }
1669 }
1673 }
1678 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1679 ##print "CMMT: $cmt\n";
1682 }
1695 }
1698 }
1706 }
1709 }
1717 }
1720 }
1732 }
1733 }
1737 }
1749 }
1769 }
1790 }
1819 # Assume all arms of the conditional end as this
1820 # one does, and continue as if the #endif was not here.
1837 }
1868 }
1880 }
1913 }
1928 }
1937 }
1941 }
1945 }
1946 }
1949 }
1958 DEFINE_\S+
1959 )$|
1963 case|
1967 \#|
1968 \#\#|
1974 # Check for modifiers.
1985 }
1986 }
1991 }
1992 build_types();
1995 }
1996 }
2008 }
2016 }
2025 }
2026 }
2031 }
2039 }
2045 }
2049 }
2060 }
2061 }
2088 }
2094 }
2101 }
2106 }
2109 }
2112 }
2120 };
2122 }
2130 };
2133 }
2142 }
2144 }
2152 }
2154 }
2162 }
2164 }
2170 ##print "absolute<$absolute>\n";
2172 # See if any suffix of this path is a path within the tree.
2175 ##print "file<$file>\n";
2177 }
2178 }
2181 }
2183 # It is, so see if the prefix is acceptable.
2187 ##print "prefix<$prefix>\n";
2191 }
2192 }
2200 }
2208 }
2216 }
2224 }
2233 #convert leading spaces to tabs
2235 #Remove spaces before a tab
2239 }
2253 }
2265 }
2266 }
2269 }
2310 # Trace the real file/line as we go.
2323 # suppression flags
2331 # Pre-scan the patch sanitizing the lines.
2332 # Pre-scan the patch looking for any __setup documentation.
2333 #
2341 sanitise_line_reset();
2353 }
2354 #next;
2355 }
2362 }
2365 # Guestimate if this is a continuing comment. Run
2366 # the context looking for a comment "edge". If this
2367 # edge is a close comment then we must be in a comment
2368 # at context start.
2375 #print "RAW<$rawlines[$ln - 1]>\n";
2381 }
2382 }
2385 }
2387 # Guestimate if this is a continuing comment. If this
2388 # is the start of a diff block and this line starts
2389 # ' *' then it is very likely a comment.
2392 {
2394 }
2396 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2400 # Standardise the strings and chars within the input to
2401 # simplify matching -- only bother with positive lines.
2403 }
2410 }
2412 #print "==>$rawline\n";
2413 #print "-->$line\n";
2417 }
2418 }
2433 # check if it's a mode change, rename or start of a patch
2439 }
2441 #extract the line range in the file after the patch is applied
2452 }
2453 annotate_reset();
2464 }
2467 # track the line number as we move through the hunk, note that
2468 # new versions of GNU diff omit the leading space on completely
2469 # blank context lines so we need to count that too.
2474 # Measure the line length and indent.
2477 # Track the previous line.
2482 #warn "line<$line>\n";
2486 }
2494 # extract the filename as it passes
2510 }
2514 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2515 }
2517 }
2519 #make up the handle for any error we report on this line
2527 }
2528 }
2533 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2534 }
2539 }
2550 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2551 }
2552 }
2555 }
2565 # Verify the existence of a commit log if appropriate
2566 # 2 is used because a $signature is counted in $commit_log_lines
2570 }
2575 }
2577 # Check if the commit log has what seems like a diff which can confuse patch
2586 }
2588 # Check for incorrect file permissions
2595 }
2596 }
2598 # Check the patch for a From:
2603 }
2605 # Check the patch for a signoff:
2614 }
2615 }
2616 }
2618 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2619 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2622 }
2624 # Check signature styles
2636 }
2643 }
2644 }
2651 }
2653 }
2660 }
2661 }
2672 # Don't force email to have quotes
2673 # Allow just an angle bracketed address
2679 }
2680 }
2682 # Check for duplicate signatures
2691 }
2693 # Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2697 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2698 }
2704 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2707 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2708 }
2709 }
2710 }
2712 # Check email subject for common tools that don't need to be mentioned
2717 }
2719 # Check for unwanted Gerrit info
2723 }
2725 # Check if the commit log is in a possible stack dump
2729 # timestamp
2733 # stack dump address styles
2735 }
2737 # Check for line lengths > 75 in commit log, warn once
2741 # file delta changes
2743 # filename then :
2745 # A Fixes: or Link: line
2750 }
2752 # Reset possible stack dump if a blank line is found
2756 }
2758 # Check for git id commit length and improperly formed commit descriptions
2783 }
2805 }
2813 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2814 }
2815 }
2817 # Check for added, moved or deleted files
2827 }
2829 # Check for wrappage within a valid hunk of the file
2834 }
2836 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2847 }
2849 # Check if it's the start of a commit log
2850 # (not a header line and we haven't seen the patch filename)
2857 }
2859 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2860 # declined it, i.e defined some charset where it is missing.
2865 }
2871 }
2873 # Check for absolute kernel paths in commit message
2880 #
2883 }
2884 }
2885 }
2887 # Check for various typo / spelling mistakes
2901 }
2902 }
2903 }
2905 # check for invalid commit id
2913 }
2914 }
2916 # ignore non-hunk lines and lines being removed
2919 #trailing whitespace
2926 }
2933 }
2936 }
2938 # Check for FSF mailing addresses.
2947 "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)
2948 }
2950 # check for Kconfig help text having a real description
2951 # Only applies when adding the entry originally, after that we do not have
2952 # sufficient context to determine whether it is indeed long enough.
2954 # 'choice' is usually the last thing on the line (though
2955 # Kconfig supports named choices), so use a word boundary
2956 # (\b) rather than a whitespace character (\s)
2978 }
2980 }
2987 # This only checks context lines in the patch
2988 # and so hopefully shouldn't trigger false
2989 # positives, even though some of these are
2990 # common words in help texts
2995 }
2997 }
3001 }
3002 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3003 }
3005 # check for MAINTAINERS entries that don't have the right form
3013 }
3014 }
3016 # discourage the use of boolean for type definition attributes of Kconfig options
3021 }
3031 };
3034 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3035 }
3037 # check for DT compatible documentation
3056 }
3063 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3064 }
3065 }
3066 }
3068 # check for using SPDX license tag at beginning of files
3082 }
3084 # check SPDX comment style for .[chsS] files
3090 }
3101 }
3102 }
3103 }
3104 }
3106 # check we are in a valid source file if not then ignore this hunk
3109 # check for using SPDX-License-Identifier on the wrong line number
3115 }
3117 # line length limit (with some exclusions)
3118 #
3119 # There are a few types of lines that may extend beyond $max_line_length:
3120 # logging functions like pr_info that end in a string
3121 # lines with a single string
3122 # #defines that are a single string
3123 # lines with an RFC3986 like URL
3124 #
3125 # There are 3 different line length message types:
3126 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3127 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3128 # LONG_LINE all other lines longer than $max_line_length
3129 #
3130 # if LONG_LINE is ignored, the other 2 types are also ignored
3131 #
3136 # Check the allowed long line types first
3138 # logging functions that end in a string that starts
3139 # before $max_line_length
3140 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3144 # lines with only strings (w/ possible termination)
3145 # #defines with only strings
3150 # More special cases
3155 # URL ($rawline is used in case the URL is in a comment)
3159 # Otherwise set the alternate message types
3161 # a comment starts before $max_line_length
3166 # a quoted string starts before $max_line_length
3170 }
3176 }
3177 }
3179 # check for adding lines without a newline.
3180 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3183 }
3185 # check we are in a valid source file C or perl if not then ignore this hunk
3188 # at the beginning of a line any tabs must come first and anything
3189 # more than 8 must use tabs.
3198 }
3199 }
3201 # check for space before tabs.
3211 }
3212 }
3214 # check for assignments on the start of a line
3218 }
3220 # check for && or || at the start of a line
3224 }
3226 # check indentation starts on a tab stop
3228 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3235 }
3236 }
3237 }
3239 # check multi-line statement indentation matches previous line
3241 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3264 }
3265 }
3266 }
3267 }
3269 # check for space after cast like "(int) foo" or "(struct foo) bar"
3270 # avoid checking a few false positives:
3271 # "sizeof(<type>)" or "__alignof__(<type>)"
3272 # function pointer declarations like "(*foo)(int) = bar;"
3273 # structure definitions like "(struct foo) { 0 };"
3274 # multiline macros that define functions
3275 # known attributes or the __attribute__ keyword
3283 }
3284 }
3286 # Block comment styles
3287 # Networking with an initial /*
3294 }
3296 # Block comments use * on subsequent lines
3304 }
3306 # Block comments use */ on trailing lines
3313 }
3315 # Block comment * alignment
3329 }
3336 }
3337 }
3339 # check for missing blank lines after struct/union declarations
3340 # with exceptions for various attributes and macros
3356 }
3357 }
3359 # check for multiple consecutive blank lines
3367 }
3370 }
3372 # check for missing blank lines after declarations
3374 # actual declarations
3376 # function pointer declarations
3378 # foo bar; where foo is some local typedef or #define
3380 # known declaration macros
3382 # for "else if" which can look like "$Ident $Ident"
3384 # other possible extensions of declaration lines
3386 # not starting a section or a macro "\" extended line
3388 # looks like a declaration
3390 # function pointer declarations
3392 # foo bar; where foo is some local typedef or #define
3394 # known declaration macros
3396 # start of struct or union or enum
3398 # start or end of block or continuation of declaration
3400 # bitfield continuation
3402 # other possible extensions of declaration lines
3404 # indentation of previous and current line are the same
3410 }
3411 }
3413 # check for spaces at the beginning of a line.
3414 # Exceptions:
3415 # 1) within comments
3416 # 2) indented preprocessor commands
3417 # 3) hanging labels
3424 }
3425 }
3427 # check we are in a valid C source file if not then ignore this hunk
3430 # check for unusual line ending [ or (
3434 }
3436 # check if this appears to be the start function declaration, save the name
3440 }
3442 # check if this appears to be the end of function declaration
3445 }
3447 # check indentation of any line with a bare else
3448 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3449 # if the previous line is a break or return and is indented 1 tab more...
3458 }
3459 }
3461 # check indentation of a line with a break;
3462 # if the previous line is a goto or return and is indented the same # of tabs
3468 }
3469 }
3471 # check for RCS/CVS revision markers
3475 }
3477 # check for old HOTPLUG __dev<foo> section markings
3481 }
3483 # Check for potential 'bare' types
3486 #print "LINE<$line>\n";
3494 #print "linenr<$linenr> <$stat>\n";
3495 # If this statement has no statement boundaries within
3496 # it there is no point in retrying a statement scan
3497 # until we hit end of it.
3500 #print "skip<$line_nr_next>\n";
3502 }
3504 # Find the real next line.
3510 }
3515 # Ignore goto labels.
3518 # Ignore functions being called
3523 # declarations always start with types
3524 } 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) {
3529 # definitions in global scope can only start with types
3532 }
3534 # any (foo ... *) is a pointer cast, and foo is a type
3537 }
3539 # Check for any sort of function declaration.
3540 # int foo(something bar, other baz);
3541 # void (*store_gdt)(x86_descr_ptr *);
3542 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3550 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3553 }
3554 }
3555 }
3557 }
3559 #
3560 # Checks which may be anchored in the context.
3561 #
3563 # Check for switch () and associated case and default
3564 # statements should be at the same indent.
3578 }
3579 }
3583 }
3584 }
3586 # if/while/etc brace do not go on next line, unless defining a do while loop,
3587 # or if that brace on the next line is for something else
3588 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3596 }
3607 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3610 }
3612 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3613 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3619 }
3623 {
3629 }
3630 }
3631 }
3633 # Check relative indent for conditionals and blocks.
3634 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3642 # remove inline comments
3646 # Find out how long the conditional actually is.
3650 # Make sure we remove the line prefixes as we have
3651 # none on the first line, and are going to readd them
3652 # where necessary.
3656 }
3658 # We want to check the first line inside the block
3659 # starting at the end of the conditional, so remove:
3660 # 1) any blank line termination
3661 # 2) any opening brace { on end of the line
3662 # 3) any do (...) {
3669 }
3673 }
3675 # Also ignore a loop construct at the end of a
3676 # preprocessor statement.
3680 }
3687 # If we see an #else/#elif then the code
3688 # is not linear.
3691 }
3693 # Ignore:
3694 # 1) blank lines, they should be at 0,
3695 # 2) preprocessor lines, and
3696 # 3) labels.
3704 }
3705 }
3706 }
3711 # Check if either of these lines are modified, else
3712 # this is not this patch's fault.
3716 }
3719 }
3721 #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";
3730 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3731 }
3732 }
3734 # Track the 'values' across context and added lines.
3744 }
3747 #ignore lines not being added
3750 # check for dereferences that span multiple lines
3760 }
3762 # check for declarations of signed or unsigned without int
3763 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3774 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3782 }
3783 }
3784 }
3786 # TEST: allow direct testing of the type matcher.
3794 }
3796 }
3797 # TEST: allow direct testing of the attribute matcher.
3805 }
3807 }
3809 # check for initialisation to aggregates open brace on the next line
3823 }
3824 }
3826 #
3827 # Checks which are anchored on the added line.
3828 #
3830 # check for malformed paths in #include statements (uses RAW line)
3836 }
3840 }
3841 }
3843 # no C99 // comments
3852 }
3853 }
3854 }
3855 # Remove C99 comments.
3859 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3860 # the whole statement.
3861 #print "APW <$lines[$realline_next - 1]>\n";
3867 # Handle definitions which produce identifiers with
3868 # a prefix:
3869 # XXX(foo);
3870 # EXPORT_SYMBOL(something_foo);
3874 #print "FOO C name<$name>\n";
3885 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3889 }
3890 }
3895 #print "FOO B <$lines[$linenr - 1]>\n";
3897 }
3902 }
3904 # check for global initialisers.
3910 }
3911 }
3912 # check for static initialisers.
3919 }
3920 }
3922 # check for misordered declarations of char/short/int/long with signed/unsigned
3926 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3927 }
3929 # check for unnecessary <signed> int declarations of short/long/long long
3946 }
3947 }
3949 # check for static const char * arrays.
3954 }
3956 # check for initialized const char arrays that should be static const
3957 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
3962 }
3963 }
3965 # check for static char foo[] = "bar" declarations.
3970 }
3972 # check for const <foo> const where <foo> is not a pointer or array type
3981 }
3982 }
3984 # check for non-global char *foo[] = {"bar", ...} declarations.
3989 }
3991 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3994 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4000 }
4001 }
4002 }
4004 # check for function declarations without arguments like "int foo()"
4010 }
4011 }
4013 # check for new typedefs, only function parameters and sparse annotations
4014 # make sense.
4022 }
4024 # * goes on variable not on type
4025 # (char*[ const])
4027 #print "AA<$1>\n";
4030 # Should start with a space.
4032 # Should not end with a space.
4034 # '*'s should not have spaces between.
4036 }
4038 ## print "1: from<$from> to<$to> ident<$ident>\n";
4048 }
4049 }
4050 }
4052 #print "BB<$1>\n";
4055 # Should start with a space.
4057 # Should not end with a space.
4059 # '*'s should not have spaces between.
4061 }
4062 # Modifiers should have spaces.
4065 ## print "2: from<$from> to<$to> ident<$ident>\n";
4076 }
4077 }
4078 }
4080 # avoid BUG() or BUG_ON()
4085 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4086 }
4088 # avoid LINUX_VERSION_CODE
4091 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4092 }
4094 # check for uses of printk_ratelimit
4098 }
4100 # printk should use KERN_* levels
4104 }
4113 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
4114 }
4122 }
4123 }
4132 }
4134 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4135 # number of false positives, but assembly files are not checked, so at
4136 # least the arch entry code will not trigger this warning.
4140 }
4142 # function brace can't be on same line, except for #defines of do while,
4143 # or if closed on same line
4160 }
4161 }
4162 }
4164 # open braces for enum, union and struct go on the same line.
4178 }
4179 }
4180 }
4182 # missing space after union, struct or enum definition
4189 }
4190 }
4192 # Function pointer declarations
4193 # check spacing between type, funcptr, and args
4194 # canonical declaration is "type (*funcptr)(args...)"
4203 # the $Declare variable will capture all spaces after the type
4204 # so check it for a missing trailing missing space but pointer return types
4205 # don't need a space so don't warn for those.
4210 }
4215 }
4217 # unnecessary space "type (*funcptr)(args...)"
4218 # This test is not currently implemented because these declarations are
4219 # equivalent to
4220 # int foo(int bar, ...)
4221 # and this is form shouldn't/doesn't generate a checkpatch warning.
4222 #
4223 # elsif ($declare =~ /\s{2,}$/) {
4224 # WARN("SPACING",
4225 # "Multiple spaces after return type\n" . $herecurr);
4226 # }
4228 # unnecessary space "type ( *funcptr)(args...)"
4233 }
4235 # unnecessary space "type (* funcptr)(args...)"
4240 }
4242 # unnecessary space "type (*funcptr )(args...)"
4247 }
4249 # unnecessary space "type (*funcptr) (args...)"
4254 }
4258 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4259 }
4260 }
4262 # check for spacing round square brackets; allowed:
4263 # 1. with a type on the left -- int [] a;
4264 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4265 # 3. inside a curly brace -- = { [0...10] = 5 }
4276 }
4277 }
4278 }
4280 # check for spaces between functions and their parentheses.
4286 # Ignore those directives where spaces _are_ permitted.
4292 {
4293 # cpp #define statements have non-optional spaces, ie
4294 # if there is a space between the name and the open
4295 # parenthesis it is simply not a parameter group.
4298 # cpp #elif statement condition may start with a (
4301 # If this whole things ends with a type its most
4302 # likely a typedef for a function.
4311 }
4312 }
4313 }
4315 # Check operator spacing.
4321 <<=|>>=|<=|>=|==|!=|
4323 =>|->|<<|>>|<|>|=|!|~|
4329 ## print("element count: <" . $#elements . ">\n");
4330 ## foreach my $el (@elements) {
4331 ## print("el: <$el>\n");
4332 ## }
4340 }
4351 ## print("n: <$n> good: <$good>\n");
4355 # Pick up the preceding and succeeding characters.
4360 }
4383 }
4392 # Pull out the value of this operator.
4395 # Get the full operator variant.
4398 # Ignore operators passed as parameters.
4402 # # Ignore comments
4403 # } elsif ($op =~ /^$;+$/) {
4405 # ; should have either the end of line or a space or \ after it
4413 }
4414 }
4416 # // is a comment
4419 # : when part of a bitfield
4421 # skip the bitfield test for now
4423 # No spaces for:
4424 # ->
4432 }
4434 }
4435 }
4437 # , must not have a space before and must have a space on the right.
4446 }
4447 }
4454 }
4455 }
4461 }
4464 }
4465 }
4467 # '*' as part of a type definition -- reported already.
4469 #warn "'*' is part of type\n";
4471 # unary operators should have a space before and
4472 # none after. May be left adjacent to another
4473 # unary operator, or a cast
4483 }
4484 }
4485 }
4487 # A unary '*' may be const
4495 }
4497 }
4498 }
4500 # unary ++ and unary -- are allowed no space on one side.
4507 }
4508 }
4515 }
4516 }
4523 }
4525 }
4526 }
4528 # << and >> may either have or not have spaces both sides
4534 {
4542 }
4548 }
4549 }
4556 }
4558 }
4559 }
4561 # A colon needs no spaces before when it is
4562 # terminating a case value or a label.
4569 }
4570 }
4572 # All the others need spaces both sides.
4576 # Ignore email addresses <foo@bar>
4581 {
4583 }
4585 # for asm volatile statements
4586 # ignore a colon with another
4587 # colon immediately before or after
4591 }
4593 # messages are ERROR, but ?: are CHK
4603 }
4605 }
4606 }
4607 }
4610 ## print("n: <$n> GOOD: <$good>\n");
4613 }
4617 }
4621 }
4624 }
4626 # check for whitespace before a non-naked semicolon
4633 }
4634 }
4636 # check for multiple assignments
4640 }
4642 ## # check for multiple declarations, allowing for a function declaration
4643 ## # continuation.
4644 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4645 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4646 ##
4647 ## # Remove any bracketed sections to ensure we do not
4648 ## # falsly report the parameters of functions.
4649 ## my $ln = $line;
4650 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4651 ## }
4652 ## if ($ln =~ /,/) {
4653 ## WARN("MULTIPLE_DECLARATION",
4654 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4655 ## }
4656 ## }
4658 #need space before brace following if, while, etc
4665 }
4666 }
4668 ## # check for blank lines before declarations
4669 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4670 ## $prevrawline =~ /^.\s*$/) {
4671 ## WARN("SPACING",
4672 ## "No blank lines before declarations\n" . $hereprev);
4673 ## }
4674 ##
4676 # closing brace should have a space following it when it has anything
4677 # on the line
4684 }
4685 }
4687 # check spacing on square brackets
4694 }
4695 }
4702 }
4703 }
4705 # check spacing on parentheses
4713 }
4714 }
4723 }
4724 }
4726 # check unnecessary parentheses around addressof/dereference single $Lvals
4727 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4735 }
4736 }
4738 # check for unnecessary parentheses around function pointer uses
4739 # ie: (foo->bar)(); should be foo->bar();
4740 # but not "if (foo->bar) (" to avoid some false positives
4749 }
4750 }
4752 # check for unnecessary parentheses around comparisons in if uses
4753 # when !drivers/staging or command-line uses --strict
4760 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4762 # avoid parentheses around potential macro args
4771 }
4772 }
4775 }
4776 }
4778 #goto labels aren't indented, allow a single space however
4786 }
4787 }
4789 # return is not a function
4799 }
4803 }
4804 }
4806 # unnecessary return in a void function
4807 # at end-of-function, with the previous line a single leading tab, then return;
4808 # and the line before that not a goto label target like "out:"
4816 }
4818 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4824 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4829 }
4830 }
4832 # comparisons with a constant or upper case identifier on the left
4833 # avoid cases like "foo + BAR < baz"
4834 # only fix matches surrounded by parentheses to avoid incorrect
4835 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4856 }
4858 }
4859 }
4861 # Return of what appears to be an errno should normally be negative
4867 }
4868 }
4870 # Need a space before open parenthesis after if, while etc
4877 }
4878 }
4880 # Check for illegal assignment in if conditional -- and check for trailing
4881 # statements after the conditional.
4889 ##print "stat<$stat> stat_next<$stat_next>\n";
4892 # If the statement carries leading newlines,
4893 # then count those as offsets.
4901 }
4902 }
4911 }
4913 # Find out what is on the end of the line after the
4914 # conditional.
4920 {
4921 # Find out how long the conditional actually is.
4930 }
4934 }
4935 }
4937 # Check for bitwise tests written as boolean
4943 |
4948 {
4951 }
4953 # if and else should not have general statements after it
4960 }
4961 }
4962 # if should not continue a brace
4967 }
4968 # case and default should not have general statements after them
4974 {
4977 }
4979 # Check for }<nl>else {, these must be at the same
4980 # indent level to be relevant to each other.
4992 }
4996 }
4997 }
5003 # Find out what is on the end of the line after the
5004 # conditional.
5020 }
5021 }
5022 }
5024 #Specific variable tests
5028 #CamelCase
5031 #Ignore Page<foo> variants
5033 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
5035 #Ignore some three character SI units explicitly, like MiB and KHz
5041 seed_camelcase_includes();
5045 }
5046 }
5051 }
5052 }
5053 }
5054 }
5056 #no spaces allowed after \ in define
5062 }
5063 }
5065 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5066 # itself <asm/foo.h> (uses RAW line)
5073 {
5082 }
5083 }
5084 }
5085 }
5087 # multi-statement macros should be enclosed in a do while loop, grab the
5088 # first statement and ensure its the whole macro if its not enclosed
5089 # in a known good container
5101 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5102 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5117 }
5124 # Flatten any parentheses and braces
5128 {
5129 }
5131 # Flatten any obvious string concatentation.
5134 {
5135 }
5137 # Make asm volatile uses seem like a generic function
5142 module_param_named|
5143 MODULE_PARM_DESC|
5144 DECLARE_PER_CPU|
5145 DEFINE_PER_CPU|
5146 __typeof__\(|
5147 union|
5148 struct|
5153 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5162 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5167 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5173 {
5176 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5183 }
5185 }
5187 # Make $define_stmt single line, comment-free, etc
5198 }
5199 }
5204 # check if any macro arguments are reused (ignore '...' and 'type')
5209 $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5216 }
5217 # check if any macro arguments may have other precedence issues
5223 }
5224 }
5226 # check for macros with flow control, but without ## concatenation
5227 # ## concatenation is commonly a macro that defines a function so ignore those
5234 }
5236 # check for line continuations outside of #defines, preprocessor #, and asm
5245 }
5246 }
5248 # do {} while (0) macro tests:
5249 # single-statement macros do not need to be enclosed in do while (0) loop,
5250 # macro should not end with a semicolon
5265 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5277 }
5281 }
5289 }
5290 }
5292 # check for redundant bracing round if etc
5296 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5297 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5307 # If the condition carries leading newlines, then count those as offsets.
5312 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5314 # We have looked at and allowed this specific line.
5324 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5326 #print "APW: ALLOWED: cond<$cond>\n";
5328 }
5330 #print "APW: ALLOWED: block<$block>\n";
5332 }
5334 #print "APW: ALLOWED: lines block<$block>\n";
5336 }
5338 }
5343 }
5351 }
5352 }
5353 }
5354 }
5359 # Check the pre-context.
5361 #print "APW: ALLOWED: pre<$1>\n";
5363 }
5368 # Check the condition.
5370 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5373 }
5375 #print "APW: ALLOWED: cond<$cond>\n";
5377 }
5379 #print "APW: ALLOWED: block<$block>\n";
5381 }
5383 #print "APW: ALLOWED: lines block<$block>\n";
5385 }
5386 # Check the post-context.
5391 }
5393 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5395 }
5396 }
5403 }
5404 }
5406 # check for single line unbalanced braces
5410 }
5412 # check for unnecessary blank lines around braces
5418 }
5419 }
5425 }
5426 }
5428 # no volatiles please
5432 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5433 }
5435 # Check for user-visible strings broken across lines, which breaks the ability
5436 # to grep for the string. Make exceptions when the previous string ends in a
5437 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5438 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5451 }
5463 }
5465 }
5466 }
5468 # check for missing a space in a string concatenation
5472 }
5474 # check for an embedded function name in a string when the function is known
5475 # This does not work very well for -f --file checking as it depends on patch
5476 # context providing the function name or a single line form for in-file
5477 # function declarations
5483 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5484 }
5486 # check for spaces before a quoted newline
5492 }
5494 }
5496 # concatenated string without spaces between elements
5505 }
5506 }
5507 }
5509 # uncoalesced string fragments
5517 }
5518 }
5519 }
5521 # check for non-standard and hex prefixed decimal printf formats
5527 # check for %L
5532 }
5533 # check for %Z
5538 }
5539 # check for 0x<decimal>
5543 }
5544 }
5546 # check for line continuations in quoted strings with odd counts of "
5550 }
5552 # warn about #if 0
5556 }
5558 # warn about #if 1
5562 }
5564 # check for needless "if (<foo>) fn(<foo>)" uses
5568 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5580 }
5585 }
5588 }
5592 }
5593 }
5594 }
5595 }
5597 # check for unnecessary "Out of Memory" messages
5606 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5608 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5612 }
5613 }
5615 # check for logging functions with KERN_<LEVEL>
5623 }
5624 }
5626 # check for logging continuations
5630 }
5632 # check for mask then right shift without a parentheses
5638 }
5640 # check for pointer comparisons to NULL
5650 }
5651 }
5652 }
5654 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5657 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5667 $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;
5668 }
5669 }
5670 }
5672 # check for $InitAttributeData (ie: __initdata) with const
5683 }
5684 }
5686 # check for $InitAttributeConst (ie: __initconst) without const
5698 }
5699 }
5701 # check for __read_mostly with const non-pointer (should just be const)
5708 }
5709 }
5711 # don't use __constant_<foo> functions outside of include/uapi/
5713 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5721 }
5722 }
5724 # prefer usleep_range over udelay
5727 # ignore udelay's < 10, however
5730 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5731 }
5735 }
5736 }
5738 # warn about unexpectedly long msleep's
5742 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5743 }
5744 }
5746 # check for comparisons of jiffies
5749 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5750 }
5752 # check for comparisons of get_jiffies_64()
5755 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5756 }
5758 # warn about #ifdefs in C files
5759 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5760 # print "#ifdef in C files should be avoided\n";
5761 # print "$herecurr";
5762 # $clean = 0;
5763 # }
5765 # warn about spacing in #ifdefs
5772 }
5774 }
5776 # check for spinlock_t definitions without a comment.
5783 }
5784 }
5785 # check for memory barriers without a comment.
5788 mb|
5789 rmb|
5790 wmb|
5791 read_barrier_depends
5794 mb__before_atomic|
5795 mb__after_atomic|
5796 store_release|
5797 load_acquire|
5798 store_mb|
5811 }
5812 }
5822 }
5824 # check for waitqueue_active without a comment.
5829 }
5830 }
5832 # check for smp_read_barrier_depends and read_barrier_depends
5836 }
5838 # check of hardware specific defines
5839 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5842 }
5844 # check that the storage class is not after a type
5848 }
5849 # Check that the storage class is at the beginning of a declaration
5856 }
5858 # check the location of the inline attribute, that it is between
5859 # storage class and type.
5864 }
5866 # Check for __inline__ and __inline, prefer inline
5874 }
5875 }
5877 # Check for __attribute__ packed, prefer __packed
5882 }
5884 # Check for __attribute__ aligned, prefer __aligned
5889 }
5891 # Check for __attribute__ section, prefer __section
5899 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
5900 }
5901 }
5903 # Check for __attribute__ format(printf, prefer __printf
5907 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5909 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5911 }
5912 }
5914 # Check for __attribute__ format(scanf, prefer __scanf
5918 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5920 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5921 }
5922 }
5924 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5926 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5931 }
5933 # check for c99 types like uint8_t used outside of uapi/ and tools/
5948 }
5949 }
5950 }
5952 # check for cast of C90 native int or longer types constants
5967 }
5969 }
5970 }
5972 # check for sizeof(&)
5976 }
5978 # check for sizeof without parenthesis
5983 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5984 }
5985 }
5987 # check for struct spinlock declarations
5991 }
5993 # check for seq_printf uses that could be seq_puts
6002 }
6003 }
6004 }
6006 # check for vsprintf extension %p<foo> misuses
6028 }
6032 }
6034 "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");
6035 }
6036 }
6045 }
6049 }
6050 }
6051 }
6053 # Check for misused memsets
6068 }
6069 }
6071 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6072 # if ($perl_version_ok &&
6073 # defined $stat &&
6074 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6075 # if (WARN("PREFER_ETHER_ADDR_COPY",
6076 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6077 # $fix) {
6078 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6079 # }
6080 # }
6082 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6083 # if ($perl_version_ok &&
6084 # defined $stat &&
6085 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6086 # WARN("PREFER_ETHER_ADDR_EQUAL",
6087 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6088 # }
6090 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6091 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6092 # if ($perl_version_ok &&
6093 # defined $stat &&
6094 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6095 #
6096 # my $ms_val = $7;
6097 #
6098 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6099 # if (WARN("PREFER_ETH_ZERO_ADDR",
6100 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6101 # $fix) {
6102 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6103 # }
6104 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6105 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6106 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6107 # $fix) {
6108 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6109 # }
6110 # }
6111 # }
6113 # typecasts on min/max could be min_t/max_t
6131 }
6134 }
6135 }
6137 # check usleep_range arguments
6145 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6149 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6150 }
6151 }
6153 # check for naked sscanf
6165 }
6167 # check for simple sscanf that should be kstrto<foo>
6181 }
6182 }
6183 }
6185 # check for new externs in .h files.
6192 }
6193 }
6195 # check for new externs in .c files.
6198 {
6205 }
6208 {
6211 }
6216 }
6220 {
6223 }
6225 # check for function declarations that have arguments without identifier names
6227 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6235 }
6236 }
6237 }
6239 # check for function definitions
6245 # check for multiline function definition with misplaced open brace
6255 }
6259 }
6260 }
6262 # checks for new __setup's
6268 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6269 }
6270 }
6272 # check for pointless casting of alloc functions
6275 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6276 }
6278 # alloc style
6279 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6281 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6284 }
6286 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6289 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6300 }
6310 $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;
6311 }
6312 }
6313 }
6315 # check for krealloc arg reuse
6321 }
6323 # check for alloc argument mismatch
6327 }
6329 # check for multiple semicolons
6335 }
6336 }
6338 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6347 }
6348 }
6350 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6351 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6357 }
6358 }
6360 # check for case / default statements not preceded by break/fallthrough/switch
6377 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6378 }
6382 }
6383 }
6385 # check for switch/default statements without a break;
6394 }
6396 # check for gcc specific __FUNCTION__
6402 }
6403 }
6405 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6409 }
6411 # check for use of yield()
6415 }
6417 # check for comparisons against true and false
6433 }
6438 ## maybe suggesting a correct construct would better
6439 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6441 }
6442 }
6444 # check for semaphores initialized locked
6448 }
6450 # recommend kstrto* over simple_strto* and strict_strto*
6454 }
6456 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6459 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6460 }
6462 # check for spin_is_locked(), suggest lockdep instead
6465 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6466 }
6468 # check for deprecated apis
6474 }
6476 # check for various structs that are normally const (ops, kgdb, device_tree)
6477 # and avoid what seem like struct definitions 'struct foo {'
6482 }
6484 # use of NR_CPUS is usually wrong
6485 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6492 {
6494 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6495 }
6497 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6501 }
6503 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6508 }
6510 # nested likely/unlikely calls
6514 }
6516 # whine mightly about in_atomic
6524 }
6525 }
6527 # check for mutex_trylock_recursive usage
6531 }
6533 # check for lockdep_set_novalidate_class
6541 }
6542 }
6547 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6548 }
6550 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6551 # and whether or not function naming is typical and if
6552 # DEVICE_ATTR permissions uses are unusual too
6555 $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*\)/) {
6567 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6568 }
6575 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6576 }
6583 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6584 }
6595 }
6598 }
6604 }
6605 }
6607 # Mode permission misuses where it seems decimal should be octal
6608 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6609 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6610 # specific definition of not visible in sysfs.
6611 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6612 # use the default permissions
6628 }
6638 }
6641 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6642 }
6643 }
6644 }
6645 }
6647 # check for uses of S_<PERMS> that could be octal for readability
6652 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6655 }
6656 }
6658 # validate content of MODULE_LICENSE against list from include/linux/module.h
6662 GPL|
6663 GPL\ v2|
6668 Proprietary
6673 }
6674 }
6676 # check for sysctl duplicate constants
6679 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6680 }
6681 }
6683 # If we have no input at all, then there is nothing to report on
6684 # so just keep quiet.
6687 }
6689 # In mailback mode only produce a report in the negative, for
6690 # things that appear to be patches.
6693 }
6695 # This is not a patch, and we are are in 'no-patch' mode so
6696 # just keep quiet.
6699 }
6704 }
6712 }
6713 }
6721 }
6724 # If there were any defects found and not already fixing them
6730 EOM
6731 }
6732 # If there were whitespace errors which cleanpatch can fix
6733 # then suggest that.
6740 EOM
6741 }
6742 }
6762 }
6765 }
6766 }
6774 Do _NOT_ trust the results written to this file.
6777 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6779 EOM
6780 }
6781 }
6789 }
6790 }
6792 }