| blob | 5219280bf7ff351a742db19e6a35748f77efbeb8 |
1 #!/usr/bin/env perl
2 # SPDX-License-Identifier: GPL-2.0
3 #
4 # (c) 2001, Dave Jones. (the file handling bit)
5 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
6 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
7 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
8 # (c) 2010-2018 Joe Perches <joe@perches.com>
73 Options:
78 --emacs emacs compile window format
79 --terse one line per report
82 single git commit with:
86 multiple git commits with:
90 git merges are ignored
105 is all off)
107 literally
110 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
111 with potential errors corrected to the preferred
112 checkpatch style
117 runtime errors.
120 --codespellfile Use this codespell dictionary
121 --typedefsfile Read additional types from this file
127 EOM
130 }
135 }
151 # Also catch when type or level is passed through a variable
152 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
154 }
159 }
162 }
184 }
185 }
188 }
190 # Perl's Getopt::Long allows options to take optional arguments after a space.
191 # Prevent --color by itself from consuming other arguments
195 }
196 }
198 GetOptions(
249 }
251 #if no filenames are given, push '-' to read patch from stdin
254 }
266 }
282 }
283 }
292 }
294 }
295 }
305 ## no critic
308 }
315 }
321 }
328 }
329 }
334 }
335 }
345 __user|
346 __kernel|
347 __force|
348 __iomem|
349 __must_check|
350 __kprobes|
351 __ref|
352 __refconst|
353 __refdata|
354 __rcu|
355 __private
363 # Notes to $Attribute:
364 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
366 const|
367 __percpu|
368 __nocast|
369 __safe|
370 __bitwise|
371 __packed__|
372 __packed2__|
373 __naked|
374 __maybe_unused|
375 __always_unused|
376 __noreturn|
377 __used|
378 __cold|
379 __pure|
380 __noclone|
381 __deprecated|
382 __read_mostly|
383 __kprobes|
385 ____cacheline_aligned|
386 ____cacheline_aligned_in_smp|
387 ____cacheline_internodealigned_in_smp|
388 __weak
410 <=|>=|==|!=|
411 =>|->|<<|>>|<|>|!|~|
445 )};
448 atomic_t
449 )};
454 )};
460 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
461 TP_printk|
463 panic|
466 )};
475 To:|
476 Cc:
477 )};
496 );
519 );
540 )};
547 );
551 );
558 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
565 );
567 #Create a search pattern for all these functions to speed up a loop below
572 }
576 S_IWUGO |
577 S_IWOTH |
578 S_IRWXUGO |
579 S_IALLUGO |
600 );
602 #Create a search pattern for all these strings to speed up a loop below
607 }
634 }
638 }
641 irq|
642 memory|
644 reboot
645 )};
646 # memory.h: ARM has a custom one
648 # Load common spelling mistakes and build regular expression list.
665 }
669 }
688 }
692 }
693 }
712 }
716 }
719 }
722 }
732 }
751 )
758 )
767 )
771 $NonptrType
776 $NonptrTypeMisordered
782 }
783 build_types();
787 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
788 # requires at least perl version v5.10.0
789 # Any use must be runtime checked with $^V
800 )};
809 }
814 }
838 }
839 }
840 }
847 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
850 }
855 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
861 }
885 }
887 }
895 }
899 }
904 }
908 }
916 }
918 }
919 }
933 # Maybe one day convert this block of bash into something that returns
934 # all matching commit ids, but it's very slow...
935 #
936 # echo "checking commits $1..."
937 # git rev-list --remotes | grep -i "^$1" |
938 # while read line ; do
939 # git log --format='%H %s' -1 $line |
940 # echo "commit $(cut -c 1-12,41-)"
941 # done
942 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
947 }
950 }
961 # If input is git commits, extract all commits from the commit expressions.
962 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
975 }
984 }
985 }
988 }
1004 }
1011 }
1015 }
1022 }
1026 }
1035 build_types();
1036 }
1047 EOM
1048 }
1054 EOM
1055 }
1056 }
1067 );
1072 }
1073 }
1075 }
1098 # If there's a name left after stripping spaces and
1099 # leading quotes, and the address doesn't have both
1100 # leading and trailing angle brackets, the address
1101 # is invalid. ie:
1102 # "joe smith joe@smith.com" bad
1103 # "joe smith <joe@smith.com" bad
1108 }
1109 }
1119 }
1122 }
1136 }
1142 }
1145 }
1153 }
1154 }
1157 }
1165 }
1166 }
1169 }
1182 }
1184 }
1187 }
1190 }
1194 }
1199 # Drop the diff line leader and expand tabs
1203 # Pick the indent from the front of the line.
1207 }
1218 }
1219 }
1230 # Always copy over the diff marker.
1236 # Comments we are whacking completely including the begin
1237 # and end, all to $;.
1244 }
1250 }
1257 }
1259 # A \ in a string means ignore the next character.
1265 }
1266 # Regular quotes.
1275 }
1276 }
1278 #print "c<$c> SQ<$sanitise_quote>\n";
1287 }
1288 }
1292 }
1294 # The pathname on a #include may be surrounded by '<' and '>'.
1299 # The whole of a #error is a string.
1303 }
1308 }
1311 }
1319 }
1342 #warn "CSB: blk<$blk> remain<$remain>\n";
1343 # If we are about to drop off the end, pull in more
1344 # context.
1355 }
1356 # Bail if there is no further context.
1357 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1360 }
1364 }
1365 }
1370 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1372 # Handle nested #if/#else.
1379 }
1381 # Statement ends at the ';' or a close '}' at the
1382 # outermost level.
1385 }
1387 # An else is really a conditional as long as its not else if
1394 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1395 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1396 }
1401 }
1409 #warn "CSB: mark coff<$coff>\n";
1410 }
1411 }
1415 }
1423 }
1425 }
1426 }
1427 # Preprocessor commands end at the newline unless escaped.
1433 }
1435 }
1436 # We are truly at the end, so shuffle to the next line.
1441 }
1446 #warn "STATEMENT<$statement>\n";
1447 #warn "CONDITION<$condition>\n";
1449 #print "coff<$coff> soff<$off> loff<$loff>\n";
1453 }
1458 # Strip the diff line prefixes and rip blank lines at start and end.
1466 }
1474 }
1495 }
1496 }
1504 # Grab the first conditional/block pair.
1507 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1511 }
1513 # Pull in the following conditional/block pairs and see if they
1514 # could continue the statement.
1518 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1520 #print "C: push\n";
1522 }
1525 }
1544 # Handle nested #if/#else.
1551 }
1554 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1558 }
1565 }
1566 }
1570 }
1573 }
1576 }
1582 }
1588 }
1594 }
1599 }
1604 }
1609 # Catch a comment on the end of the line itself.
1613 # Look through the context and try and figure out if there is a
1614 # comment.
1619 #warn " $line\n";
1622 }
1625 }
1628 }
1632 }
1633 }
1637 }
1642 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1643 ##print "CMMT: $cmt\n";
1646 }
1659 }
1662 }
1670 }
1673 }
1681 }
1684 }
1696 }
1697 }
1701 }
1713 }
1733 }
1754 }
1783 # Assume all arms of the conditional end as this
1784 # one does, and continue as if the #endif was not here.
1801 }
1832 }
1844 }
1877 }
1892 }
1901 }
1905 }
1909 }
1910 }
1913 }
1922 DEFINE_\S+
1923 )$|
1927 case|
1931 \#|
1932 \#\#|
1938 # Check for modifiers.
1949 }
1950 }
1955 }
1956 build_types();
1959 }
1960 }
1972 }
1980 }
1989 }
1990 }
1995 }
2003 }
2009 }
2013 }
2024 }
2025 }
2052 }
2058 }
2065 }
2070 }
2073 }
2076 }
2084 };
2086 }
2094 };
2097 }
2106 }
2108 }
2116 }
2118 }
2126 }
2128 }
2134 ##print "absolute<$absolute>\n";
2136 # See if any suffix of this path is a path within the tree.
2139 ##print "file<$file>\n";
2141 }
2142 }
2145 }
2147 # It is, so see if the prefix is acceptable.
2151 ##print "prefix<$prefix>\n";
2155 }
2156 }
2164 }
2172 }
2180 }
2188 }
2197 #convert leading spaces to tabs
2199 #Remove spaces before a tab
2203 }
2217 }
2229 }
2230 }
2233 }
2274 # Trace the real file/line as we go.
2287 # suppression flags
2295 # Pre-scan the patch sanitizing the lines.
2296 # Pre-scan the patch looking for any __setup documentation.
2297 #
2305 sanitise_line_reset();
2317 }
2318 #next;
2319 }
2326 }
2329 # Guestimate if this is a continuing comment. Run
2330 # the context looking for a comment "edge". If this
2331 # edge is a close comment then we must be in a comment
2332 # at context start.
2339 #print "RAW<$rawlines[$ln - 1]>\n";
2345 }
2346 }
2349 }
2351 # Guestimate if this is a continuing comment. If this
2352 # is the start of a diff block and this line starts
2353 # ' *' then it is very likely a comment.
2356 {
2358 }
2360 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2364 # Standardise the strings and chars within the input to
2365 # simplify matching -- only bother with positive lines.
2367 }
2374 }
2376 #print "==>$rawline\n";
2377 #print "-->$line\n";
2381 }
2382 }
2397 # check if it's a mode change, rename or start of a patch
2403 }
2405 #extract the line range in the file after the patch is applied
2416 }
2417 annotate_reset();
2428 }
2431 # track the line number as we move through the hunk, note that
2432 # new versions of GNU diff omit the leading space on completely
2433 # blank context lines so we need to count that too.
2438 # Measure the line length and indent.
2441 # Track the previous line.
2446 #warn "line<$line>\n";
2450 }
2458 # extract the filename as it passes
2474 }
2478 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2479 }
2481 }
2483 #make up the handle for any error we report on this line
2491 }
2492 }
2497 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2498 }
2503 }
2514 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2515 }
2516 }
2519 }
2529 # Verify the existence of a commit log if appropriate
2530 # 2 is used because a $signature is counted in $commit_log_lines
2534 }
2539 }
2541 # Check if the commit log has what seems like a diff which can confuse patch
2550 }
2552 # Check for incorrect file permissions
2559 }
2560 }
2562 # Check the patch for a From:
2567 }
2569 # Check the patch for a signoff:
2578 }
2579 }
2580 }
2582 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2583 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2586 }
2588 # Check signature styles
2600 }
2607 }
2608 }
2615 }
2617 }
2624 }
2625 }
2636 # Don't force email to have quotes
2637 # Allow just an angle bracketed address
2643 }
2644 }
2646 # Check for duplicate signatures
2655 }
2656 }
2658 # Check email subject for common tools that don't need to be mentioned
2663 }
2665 # Check for unwanted Gerrit info
2669 }
2671 # Check if the commit log is in a possible stack dump
2675 # timestamp
2677 # stack dump address
2679 }
2681 # Check for line lengths > 75 in commit log, warn once
2685 # file delta changes
2687 # filename then :
2689 # A Fixes: or Link: line
2694 }
2696 # Reset possible stack dump if a blank line is found
2700 }
2702 # Check for git id commit length and improperly formed commit descriptions
2727 }
2749 }
2757 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2758 }
2759 }
2761 # Check for added, moved or deleted files
2771 }
2773 # Check for wrappage within a valid hunk of the file
2778 }
2780 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2791 }
2793 # Check if it's the start of a commit log
2794 # (not a header line and we haven't seen the patch filename)
2801 }
2803 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2804 # declined it, i.e defined some charset where it is missing.
2809 }
2815 }
2817 # Check for absolute kernel paths in commit message
2824 #
2827 }
2828 }
2829 }
2831 # Check for various typo / spelling mistakes
2845 }
2846 }
2847 }
2849 # ignore non-hunk lines and lines being removed
2852 #trailing whitespace
2859 }
2866 }
2869 }
2871 # Check for FSF mailing addresses.
2880 "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)
2881 }
2883 # check for Kconfig help text having a real description
2884 # Only applies when adding the entry originally, after that we do not have
2885 # sufficient context to determine whether it is indeed long enough.
2887 # 'choice' is usually the last thing on the line (though
2888 # Kconfig supports named choices), so use a word boundary
2889 # (\b) rather than a whitespace character (\s)
2911 }
2913 }
2920 # This only checks context lines in the patch
2921 # and so hopefully shouldn't trigger false
2922 # positives, even though some of these are
2923 # common words in help texts
2928 }
2930 }
2934 }
2935 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2936 }
2938 # check for MAINTAINERS entries that don't have the right form
2946 }
2947 }
2949 # discourage the use of boolean for type definition attributes of Kconfig options
2954 }
2964 };
2967 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2968 }
2970 # check for DT compatible documentation
2989 }
2996 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2997 }
2998 }
2999 }
3001 # check for using SPDX license tag at beginning of files
3015 }
3026 }
3027 }
3028 }
3029 }
3031 # check we are in a valid source file if not then ignore this hunk
3034 # line length limit (with some exclusions)
3035 #
3036 # There are a few types of lines that may extend beyond $max_line_length:
3037 # logging functions like pr_info that end in a string
3038 # lines with a single string
3039 # #defines that are a single string
3040 # lines with an RFC3986 like URL
3041 #
3042 # There are 3 different line length message types:
3043 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3044 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3045 # LONG_LINE all other lines longer than $max_line_length
3046 #
3047 # if LONG_LINE is ignored, the other 2 types are also ignored
3048 #
3053 # Check the allowed long line types first
3055 # logging functions that end in a string that starts
3056 # before $max_line_length
3057 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3061 # lines with only strings (w/ possible termination)
3062 # #defines with only strings
3067 # More special cases
3072 # URL ($rawline is used in case the URL is in a comment)
3076 # Otherwise set the alternate message types
3078 # a comment starts before $max_line_length
3083 # a quoted string starts before $max_line_length
3087 }
3093 }
3094 }
3096 # check for adding lines without a newline.
3097 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3100 }
3102 # check we are in a valid source file C or perl if not then ignore this hunk
3105 # at the beginning of a line any tabs must come first and anything
3106 # more than 8 must use tabs.
3115 }
3116 }
3118 # check for space before tabs.
3128 }
3129 }
3131 # check for assignments on the start of a line
3135 }
3137 # check for && or || at the start of a line
3141 }
3143 # check indentation starts on a tab stop
3145 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3152 }
3153 }
3154 }
3156 # check multi-line statement indentation matches previous line
3158 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3181 }
3182 }
3183 }
3184 }
3186 # check for space after cast like "(int) foo" or "(struct foo) bar"
3187 # avoid checking a few false positives:
3188 # "sizeof(<type>)" or "__alignof__(<type>)"
3189 # function pointer declarations like "(*foo)(int) = bar;"
3190 # structure definitions like "(struct foo) { 0 };"
3191 # multiline macros that define functions
3192 # known attributes or the __attribute__ keyword
3200 }
3201 }
3203 # Block comment styles
3204 # Networking with an initial /*
3211 }
3213 # Block comments use * on subsequent lines
3221 }
3223 # Block comments use */ on trailing lines
3230 }
3232 # Block comment * alignment
3246 }
3253 }
3254 }
3256 # check for missing blank lines after struct/union declarations
3257 # with exceptions for various attributes and macros
3273 }
3274 }
3276 # check for multiple consecutive blank lines
3284 }
3287 }
3289 # check for missing blank lines after declarations
3291 # actual declarations
3293 # function pointer declarations
3295 # foo bar; where foo is some local typedef or #define
3297 # known declaration macros
3299 # for "else if" which can look like "$Ident $Ident"
3301 # other possible extensions of declaration lines
3303 # not starting a section or a macro "\" extended line
3305 # looks like a declaration
3307 # function pointer declarations
3309 # foo bar; where foo is some local typedef or #define
3311 # known declaration macros
3313 # start of struct or union or enum
3315 # start or end of block or continuation of declaration
3317 # bitfield continuation
3319 # other possible extensions of declaration lines
3321 # indentation of previous and current line are the same
3327 }
3328 }
3330 # check for spaces at the beginning of a line.
3331 # Exceptions:
3332 # 1) within comments
3333 # 2) indented preprocessor commands
3334 # 3) hanging labels
3341 }
3342 }
3344 # check we are in a valid C source file if not then ignore this hunk
3347 # check for unusual line ending [ or (
3351 }
3353 # check if this appears to be the start function declaration, save the name
3357 }
3359 # check if this appears to be the end of function declaration
3362 }
3364 # check indentation of any line with a bare else
3365 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3366 # if the previous line is a break or return and is indented 1 tab more...
3375 }
3376 }
3378 # check indentation of a line with a break;
3379 # if the previous line is a goto or return and is indented the same # of tabs
3385 }
3386 }
3388 # check for RCS/CVS revision markers
3392 }
3394 # check for old HOTPLUG __dev<foo> section markings
3398 }
3400 # Check for potential 'bare' types
3403 #print "LINE<$line>\n";
3411 #print "linenr<$linenr> <$stat>\n";
3412 # If this statement has no statement boundaries within
3413 # it there is no point in retrying a statement scan
3414 # until we hit end of it.
3417 #print "skip<$line_nr_next>\n";
3419 }
3421 # Find the real next line.
3427 }
3432 # Ignore goto labels.
3435 # Ignore functions being called
3440 # declarations always start with types
3441 } 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) {
3446 # definitions in global scope can only start with types
3449 }
3451 # any (foo ... *) is a pointer cast, and foo is a type
3454 }
3456 # Check for any sort of function declaration.
3457 # int foo(something bar, other baz);
3458 # void (*store_gdt)(x86_descr_ptr *);
3459 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3467 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3470 }
3471 }
3472 }
3474 }
3476 #
3477 # Checks which may be anchored in the context.
3478 #
3480 # Check for switch () and associated case and default
3481 # statements should be at the same indent.
3495 }
3496 }
3500 }
3501 }
3503 # if/while/etc brace do not go on next line, unless defining a do while loop,
3504 # or if that brace on the next line is for something else
3505 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3513 }
3524 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3527 }
3529 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3530 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3536 }
3540 {
3546 }
3547 }
3548 }
3550 # Check relative indent for conditionals and blocks.
3551 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3559 # remove inline comments
3563 # Find out how long the conditional actually is.
3567 # Make sure we remove the line prefixes as we have
3568 # none on the first line, and are going to readd them
3569 # where necessary.
3573 }
3575 # We want to check the first line inside the block
3576 # starting at the end of the conditional, so remove:
3577 # 1) any blank line termination
3578 # 2) any opening brace { on end of the line
3579 # 3) any do (...) {
3586 }
3590 }
3592 # Also ignore a loop construct at the end of a
3593 # preprocessor statement.
3597 }
3604 # If we see an #else/#elif then the code
3605 # is not linear.
3608 }
3610 # Ignore:
3611 # 1) blank lines, they should be at 0,
3612 # 2) preprocessor lines, and
3613 # 3) labels.
3621 }
3622 }
3623 }
3628 # Check if either of these lines are modified, else
3629 # this is not this patch's fault.
3633 }
3636 }
3638 #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";
3647 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3648 }
3649 }
3651 # Track the 'values' across context and added lines.
3661 }
3664 #ignore lines not being added
3667 # check for dereferences that span multiple lines
3677 }
3679 # check for declarations of signed or unsigned without int
3680 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3691 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3699 }
3700 }
3701 }
3703 # TEST: allow direct testing of the type matcher.
3711 }
3713 }
3714 # TEST: allow direct testing of the attribute matcher.
3722 }
3724 }
3726 # check for initialisation to aggregates open brace on the next line
3740 }
3741 }
3743 #
3744 # Checks which are anchored on the added line.
3745 #
3747 # check for malformed paths in #include statements (uses RAW line)
3753 }
3757 }
3758 }
3760 # no C99 // comments
3769 }
3770 }
3771 }
3772 # Remove C99 comments.
3776 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3777 # the whole statement.
3778 #print "APW <$lines[$realline_next - 1]>\n";
3784 # Handle definitions which produce identifiers with
3785 # a prefix:
3786 # XXX(foo);
3787 # EXPORT_SYMBOL(something_foo);
3791 #print "FOO C name<$name>\n";
3802 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3806 }
3807 }
3812 #print "FOO B <$lines[$linenr - 1]>\n";
3814 }
3819 }
3821 # check for global initialisers.
3827 }
3828 }
3829 # check for static initialisers.
3836 }
3837 }
3839 # check for misordered declarations of char/short/int/long with signed/unsigned
3843 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3844 }
3846 # check for unnecessary <signed> int declarations of short/long/long long
3863 }
3864 }
3866 # check for static const char * arrays.
3871 }
3873 # check for static char foo[] = "bar" declarations.
3878 }
3880 # check for const <foo> const where <foo> is not a pointer or array type
3889 }
3890 }
3892 # check for non-global char *foo[] = {"bar", ...} declarations.
3897 }
3899 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3902 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3908 }
3909 }
3910 }
3912 # check for function declarations without arguments like "int foo()"
3918 }
3919 }
3921 # check for new typedefs, only function parameters and sparse annotations
3922 # make sense.
3930 }
3932 # * goes on variable not on type
3933 # (char*[ const])
3935 #print "AA<$1>\n";
3938 # Should start with a space.
3940 # Should not end with a space.
3942 # '*'s should not have spaces between.
3944 }
3946 ## print "1: from<$from> to<$to> ident<$ident>\n";
3956 }
3957 }
3958 }
3960 #print "BB<$1>\n";
3963 # Should start with a space.
3965 # Should not end with a space.
3967 # '*'s should not have spaces between.
3969 }
3970 # Modifiers should have spaces.
3973 ## print "2: from<$from> to<$to> ident<$ident>\n";
3984 }
3985 }
3986 }
3988 # avoid BUG() or BUG_ON()
3993 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3994 }
3996 # avoid LINUX_VERSION_CODE
3999 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4000 }
4002 # check for uses of printk_ratelimit
4006 }
4008 # printk should use KERN_* levels
4012 }
4021 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
4022 }
4030 }
4031 }
4040 }
4042 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4043 # number of false positives, but assembly files are not checked, so at
4044 # least the arch entry code will not trigger this warning.
4048 }
4050 # function brace can't be on same line, except for #defines of do while,
4051 # or if closed on same line
4068 }
4069 }
4070 }
4072 # open braces for enum, union and struct go on the same line.
4086 }
4087 }
4088 }
4090 # missing space after union, struct or enum definition
4097 }
4098 }
4100 # Function pointer declarations
4101 # check spacing between type, funcptr, and args
4102 # canonical declaration is "type (*funcptr)(args...)"
4111 # the $Declare variable will capture all spaces after the type
4112 # so check it for a missing trailing missing space but pointer return types
4113 # don't need a space so don't warn for those.
4118 }
4123 }
4125 # unnecessary space "type (*funcptr)(args...)"
4126 # This test is not currently implemented because these declarations are
4127 # equivalent to
4128 # int foo(int bar, ...)
4129 # and this is form shouldn't/doesn't generate a checkpatch warning.
4130 #
4131 # elsif ($declare =~ /\s{2,}$/) {
4132 # WARN("SPACING",
4133 # "Multiple spaces after return type\n" . $herecurr);
4134 # }
4136 # unnecessary space "type ( *funcptr)(args...)"
4141 }
4143 # unnecessary space "type (* funcptr)(args...)"
4148 }
4150 # unnecessary space "type (*funcptr )(args...)"
4155 }
4157 # unnecessary space "type (*funcptr) (args...)"
4162 }
4166 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4167 }
4168 }
4170 # check for spacing round square brackets; allowed:
4171 # 1. with a type on the left -- int [] a;
4172 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4173 # 3. inside a curly brace -- = { [0...10] = 5 }
4184 }
4185 }
4186 }
4188 # check for spaces between functions and their parentheses.
4194 # Ignore those directives where spaces _are_ permitted.
4200 {
4201 # cpp #define statements have non-optional spaces, ie
4202 # if there is a space between the name and the open
4203 # parenthesis it is simply not a parameter group.
4206 # cpp #elif statement condition may start with a (
4209 # If this whole things ends with a type its most
4210 # likely a typedef for a function.
4219 }
4220 }
4221 }
4223 # Check operator spacing.
4229 <<=|>>=|<=|>=|==|!=|
4231 =>|->|<<|>>|<|>|=|!|~|
4237 ## print("element count: <" . $#elements . ">\n");
4238 ## foreach my $el (@elements) {
4239 ## print("el: <$el>\n");
4240 ## }
4248 }
4259 ## print("n: <$n> good: <$good>\n");
4263 # Pick up the preceding and succeeding characters.
4268 }
4291 }
4300 # Pull out the value of this operator.
4303 # Get the full operator variant.
4306 # Ignore operators passed as parameters.
4310 # # Ignore comments
4311 # } elsif ($op =~ /^$;+$/) {
4313 # ; should have either the end of line or a space or \ after it
4321 }
4322 }
4324 # // is a comment
4327 # : when part of a bitfield
4329 # skip the bitfield test for now
4331 # No spaces for:
4332 # ->
4340 }
4342 }
4343 }
4345 # , must not have a space before and must have a space on the right.
4354 }
4355 }
4362 }
4363 }
4369 }
4372 }
4373 }
4375 # '*' as part of a type definition -- reported already.
4377 #warn "'*' is part of type\n";
4379 # unary operators should have a space before and
4380 # none after. May be left adjacent to another
4381 # unary operator, or a cast
4391 }
4392 }
4393 }
4395 # A unary '*' may be const
4403 }
4405 }
4406 }
4408 # unary ++ and unary -- are allowed no space on one side.
4415 }
4416 }
4423 }
4424 }
4431 }
4433 }
4434 }
4436 # << and >> may either have or not have spaces both sides
4442 {
4450 }
4456 }
4457 }
4464 }
4466 }
4467 }
4469 # A colon needs no spaces before when it is
4470 # terminating a case value or a label.
4477 }
4478 }
4480 # All the others need spaces both sides.
4484 # Ignore email addresses <foo@bar>
4489 {
4491 }
4493 # for asm volatile statements
4494 # ignore a colon with another
4495 # colon immediately before or after
4499 }
4501 # messages are ERROR, but ?: are CHK
4511 }
4513 }
4514 }
4515 }
4518 ## print("n: <$n> GOOD: <$good>\n");
4521 }
4525 }
4529 }
4532 }
4534 # check for whitespace before a non-naked semicolon
4541 }
4542 }
4544 # check for multiple assignments
4548 }
4550 ## # check for multiple declarations, allowing for a function declaration
4551 ## # continuation.
4552 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4553 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4554 ##
4555 ## # Remove any bracketed sections to ensure we do not
4556 ## # falsly report the parameters of functions.
4557 ## my $ln = $line;
4558 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4559 ## }
4560 ## if ($ln =~ /,/) {
4561 ## WARN("MULTIPLE_DECLARATION",
4562 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4563 ## }
4564 ## }
4566 #need space before brace following if, while, etc
4573 }
4574 }
4576 ## # check for blank lines before declarations
4577 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4578 ## $prevrawline =~ /^.\s*$/) {
4579 ## WARN("SPACING",
4580 ## "No blank lines before declarations\n" . $hereprev);
4581 ## }
4582 ##
4584 # closing brace should have a space following it when it has anything
4585 # on the line
4592 }
4593 }
4595 # check spacing on square brackets
4602 }
4603 }
4610 }
4611 }
4613 # check spacing on parentheses
4621 }
4622 }
4631 }
4632 }
4634 # check unnecessary parentheses around addressof/dereference single $Lvals
4635 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4643 }
4644 }
4646 # check for unnecessary parentheses around function pointer uses
4647 # ie: (foo->bar)(); should be foo->bar();
4648 # but not "if (foo->bar) (" to avoid some false positives
4657 }
4658 }
4660 # check for unnecessary parentheses around comparisons in if uses
4661 # when !drivers/staging or command-line uses --strict
4668 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4670 # avoid parentheses around potential macro args
4679 }
4680 }
4683 }
4684 }
4686 #goto labels aren't indented, allow a single space however
4694 }
4695 }
4697 # return is not a function
4707 }
4711 }
4712 }
4714 # unnecessary return in a void function
4715 # at end-of-function, with the previous line a single leading tab, then return;
4716 # and the line before that not a goto label target like "out:"
4724 }
4726 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4732 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4737 }
4738 }
4740 # comparisons with a constant or upper case identifier on the left
4741 # avoid cases like "foo + BAR < baz"
4742 # only fix matches surrounded by parentheses to avoid incorrect
4743 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4764 }
4766 }
4767 }
4769 # Return of what appears to be an errno should normally be negative
4775 }
4776 }
4778 # Need a space before open parenthesis after if, while etc
4785 }
4786 }
4788 # Check for illegal assignment in if conditional -- and check for trailing
4789 # statements after the conditional.
4797 ##print "stat<$stat> stat_next<$stat_next>\n";
4800 # If the statement carries leading newlines,
4801 # then count those as offsets.
4809 }
4810 }
4819 }
4821 # Find out what is on the end of the line after the
4822 # conditional.
4828 {
4829 # Find out how long the conditional actually is.
4838 }
4842 }
4843 }
4845 # Check for bitwise tests written as boolean
4851 |
4856 {
4859 }
4861 # if and else should not have general statements after it
4868 }
4869 }
4870 # if should not continue a brace
4875 }
4876 # case and default should not have general statements after them
4882 {
4885 }
4887 # Check for }<nl>else {, these must be at the same
4888 # indent level to be relevant to each other.
4900 }
4904 }
4905 }
4911 # Find out what is on the end of the line after the
4912 # conditional.
4928 }
4929 }
4930 }
4932 #Specific variable tests
4936 #gcc binary extension
4944 }
4945 }
4947 #CamelCase
4950 #Ignore Page<foo> variants
4952 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4954 #Ignore some three character SI units explicitly, like MiB and KHz
4960 seed_camelcase_includes();
4964 }
4965 }
4970 }
4971 }
4972 }
4973 }
4975 #no spaces allowed after \ in define
4981 }
4982 }
4984 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4985 # itself <asm/foo.h> (uses RAW line)
4992 {
5001 }
5002 }
5003 }
5004 }
5006 # multi-statement macros should be enclosed in a do while loop, grab the
5007 # first statement and ensure its the whole macro if its not enclosed
5008 # in a known good container
5020 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5021 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5036 }
5043 # Flatten any parentheses and braces
5047 {
5048 }
5050 # Flatten any obvious string concatentation.
5053 {
5054 }
5056 # Make asm volatile uses seem like a generic function
5061 module_param_named|
5062 MODULE_PARM_DESC|
5063 DECLARE_PER_CPU|
5064 DEFINE_PER_CPU|
5065 __typeof__\(|
5066 union|
5067 struct|
5072 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5081 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5086 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5092 {
5095 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5102 }
5104 }
5106 # Make $define_stmt single line, comment-free, etc
5117 }
5118 }
5123 # check if any macro arguments are reused (ignore '...' and 'type')
5128 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5135 }
5136 # check if any macro arguments may have other precedence issues
5142 }
5143 }
5145 # check for macros with flow control, but without ## concatenation
5146 # ## concatenation is commonly a macro that defines a function so ignore those
5153 }
5155 # check for line continuations outside of #defines, preprocessor #, and asm
5164 }
5165 }
5167 # do {} while (0) macro tests:
5168 # single-statement macros do not need to be enclosed in do while (0) loop,
5169 # macro should not end with a semicolon
5184 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5196 }
5200 }
5208 }
5209 }
5211 # check for redundant bracing round if etc
5215 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5216 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5226 # If the condition carries leading newlines, then count those as offsets.
5231 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5233 # We have looked at and allowed this specific line.
5243 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5245 #print "APW: ALLOWED: cond<$cond>\n";
5247 }
5249 #print "APW: ALLOWED: block<$block>\n";
5251 }
5253 #print "APW: ALLOWED: lines block<$block>\n";
5255 }
5257 }
5262 }
5270 }
5271 }
5272 }
5273 }
5278 # Check the pre-context.
5280 #print "APW: ALLOWED: pre<$1>\n";
5282 }
5287 # Check the condition.
5289 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5292 }
5294 #print "APW: ALLOWED: cond<$cond>\n";
5296 }
5298 #print "APW: ALLOWED: block<$block>\n";
5300 }
5302 #print "APW: ALLOWED: lines block<$block>\n";
5304 }
5305 # Check the post-context.
5310 }
5312 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5314 }
5315 }
5322 }
5323 }
5325 # check for single line unbalanced braces
5329 }
5331 # check for unnecessary blank lines around braces
5337 }
5338 }
5344 }
5345 }
5347 # no volatiles please
5351 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5352 }
5354 # Check for user-visible strings broken across lines, which breaks the ability
5355 # to grep for the string. Make exceptions when the previous string ends in a
5356 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5357 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5370 }
5382 }
5384 }
5385 }
5387 # check for missing a space in a string concatenation
5391 }
5393 # check for an embedded function name in a string when the function is known
5394 # This does not work very well for -f --file checking as it depends on patch
5395 # context providing the function name or a single line form for in-file
5396 # function declarations
5402 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5403 }
5405 # check for spaces before a quoted newline
5411 }
5413 }
5415 # concatenated string without spaces between elements
5424 }
5425 }
5426 }
5428 # uncoalesced string fragments
5436 }
5437 }
5438 }
5440 # check for non-standard and hex prefixed decimal printf formats
5446 # check for %L
5451 }
5452 # check for %Z
5457 }
5458 # check for 0x<decimal>
5462 }
5463 }
5465 # check for line continuations in quoted strings with odd counts of "
5469 }
5471 # warn about #if 0
5475 }
5477 # warn about #if 1
5481 }
5483 # check for needless "if (<foo>) fn(<foo>)" uses
5487 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5499 }
5504 }
5507 }
5511 }
5512 }
5513 }
5514 }
5516 # check for unnecessary "Out of Memory" messages
5525 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5527 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|kmemdup|(?:dev_)?alloc_skb)/) {
5530 }
5531 }
5533 # check for logging functions with KERN_<LEVEL>
5541 }
5542 }
5544 # check for logging continuations
5548 }
5550 # check for mask then right shift without a parentheses
5556 }
5558 # check for pointer comparisons to NULL
5568 }
5569 }
5570 }
5572 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5575 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5585 $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;
5586 }
5587 }
5588 }
5590 # check for $InitAttributeData (ie: __initdata) with const
5601 }
5602 }
5604 # check for $InitAttributeConst (ie: __initconst) without const
5616 }
5617 }
5619 # check for __read_mostly with const non-pointer (should just be const)
5626 }
5627 }
5629 # don't use __constant_<foo> functions outside of include/uapi/
5631 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5639 }
5640 }
5642 # prefer usleep_range over udelay
5645 # ignore udelay's < 10, however
5648 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5649 }
5653 }
5654 }
5656 # warn about unexpectedly long msleep's
5660 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5661 }
5662 }
5664 # check for comparisons of jiffies
5667 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5668 }
5670 # check for comparisons of get_jiffies_64()
5673 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5674 }
5676 # warn about #ifdefs in C files
5677 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5678 # print "#ifdef in C files should be avoided\n";
5679 # print "$herecurr";
5680 # $clean = 0;
5681 # }
5683 # warn about spacing in #ifdefs
5690 }
5692 }
5694 # check for spinlock_t definitions without a comment.
5701 }
5702 }
5703 # check for memory barriers without a comment.
5706 mb|
5707 rmb|
5708 wmb|
5709 read_barrier_depends
5712 mb__before_atomic|
5713 mb__after_atomic|
5714 store_release|
5715 load_acquire|
5716 store_mb|
5729 }
5730 }
5740 }
5742 # check for waitqueue_active without a comment.
5747 }
5748 }
5750 # check for smp_read_barrier_depends and read_barrier_depends
5754 }
5756 # check of hardware specific defines
5757 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5760 }
5762 # check that the storage class is not after a type
5766 }
5767 # Check that the storage class is at the beginning of a declaration
5774 }
5776 # check the location of the inline attribute, that it is between
5777 # storage class and type.
5782 }
5784 # Check for __inline__ and __inline, prefer inline
5792 }
5793 }
5795 # Check for __attribute__ packed, prefer __packed
5800 }
5802 # Check for __attribute__ aligned, prefer __aligned
5807 }
5809 # Check for __attribute__ format(printf, prefer __printf
5813 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5815 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5817 }
5818 }
5820 # Check for __attribute__ format(scanf, prefer __scanf
5824 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5826 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5827 }
5828 }
5830 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5832 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5837 }
5839 # check for c99 types like uint8_t used outside of uapi/ and tools/
5854 }
5855 }
5856 }
5858 # check for cast of C90 native int or longer types constants
5873 }
5875 }
5876 }
5878 # check for sizeof(&)
5882 }
5884 # check for sizeof without parenthesis
5889 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5890 }
5891 }
5893 # check for struct spinlock declarations
5897 }
5899 # check for seq_printf uses that could be seq_puts
5908 }
5909 }
5910 }
5912 # check for vsprintf extension %p<foo> misuses
5934 }
5938 }
5940 "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");
5941 }
5942 }
5951 }
5955 }
5956 }
5957 }
5959 # Check for misused memsets
5974 }
5975 }
5977 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5978 # if ($perl_version_ok &&
5979 # defined $stat &&
5980 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5981 # if (WARN("PREFER_ETHER_ADDR_COPY",
5982 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5983 # $fix) {
5984 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5985 # }
5986 # }
5988 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5989 # if ($perl_version_ok &&
5990 # defined $stat &&
5991 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5992 # WARN("PREFER_ETHER_ADDR_EQUAL",
5993 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5994 # }
5996 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5997 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5998 # if ($perl_version_ok &&
5999 # defined $stat &&
6000 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6001 #
6002 # my $ms_val = $7;
6003 #
6004 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6005 # if (WARN("PREFER_ETH_ZERO_ADDR",
6006 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6007 # $fix) {
6008 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6009 # }
6010 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6011 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6012 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6013 # $fix) {
6014 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6015 # }
6016 # }
6017 # }
6019 # typecasts on min/max could be min_t/max_t
6037 }
6040 }
6041 }
6043 # check usleep_range arguments
6051 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
6055 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
6056 }
6057 }
6059 # check for naked sscanf
6071 }
6073 # check for simple sscanf that should be kstrto<foo>
6087 }
6088 }
6089 }
6091 # check for new externs in .h files.
6098 }
6099 }
6101 # check for new externs in .c files.
6104 {
6111 }
6114 {
6117 }
6122 }
6126 {
6129 }
6131 # check for function declarations that have arguments without identifier names
6133 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6141 }
6142 }
6143 }
6145 # check for function definitions
6151 # check for multiline function definition with misplaced open brace
6161 }
6165 }
6166 }
6168 # checks for new __setup's
6174 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6175 }
6176 }
6178 # check for pointless casting of kmalloc return
6181 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6182 }
6184 # alloc style
6185 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6187 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6190 }
6192 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6195 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6206 }
6216 $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;
6217 }
6218 }
6219 }
6221 # check for krealloc arg reuse
6227 }
6229 # check for alloc argument mismatch
6233 }
6235 # check for multiple semicolons
6241 }
6242 }
6244 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6253 }
6254 }
6256 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6257 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6263 }
6264 }
6266 # check for case / default statements not preceded by break/fallthrough/switch
6283 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6284 }
6288 }
6289 }
6291 # check for switch/default statements without a break;
6300 }
6302 # check for gcc specific __FUNCTION__
6308 }
6309 }
6311 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6315 }
6317 # check for use of yield()
6321 }
6323 # check for comparisons against true and false
6339 }
6344 ## maybe suggesting a correct construct would better
6345 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6347 }
6348 }
6350 # check for bool bitfields
6353 "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr);
6354 }
6356 # check for bool use in .h files
6360 "Avoid using bool structure members because of possible alignment issues - see: https://lkml.org/lkml/2017/11/21/384\n" . $herecurr);
6361 }
6363 # check for semaphores initialized locked
6367 }
6369 # recommend kstrto* over simple_strto* and strict_strto*
6373 }
6375 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6378 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6379 }
6381 # check for various structs that are normally const (ops, kgdb, device_tree)
6382 # and avoid what seem like struct definitions 'struct foo {'
6387 }
6389 # use of NR_CPUS is usually wrong
6390 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6397 {
6399 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6400 }
6402 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6406 }
6408 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6413 }
6415 # whine mightly about in_atomic
6423 }
6424 }
6426 # check for mutex_trylock_recursive usage
6430 }
6432 # check for lockdep_set_novalidate_class
6440 }
6441 }
6446 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6447 }
6449 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6450 # and whether or not function naming is typical and if
6451 # DEVICE_ATTR permissions uses are unusual too
6454 $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*\)/) {
6466 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6467 }
6474 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6475 }
6482 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6483 }
6494 }
6497 }
6503 }
6504 }
6506 # Mode permission misuses where it seems decimal should be octal
6507 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6508 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6509 # specific definition of not visible in sysfs.
6510 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6511 # use the default permissions
6527 }
6537 }
6540 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6541 }
6542 }
6543 }
6544 }
6546 # check for uses of S_<PERMS> that could be octal for readability
6551 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6554 }
6555 }
6557 # validate content of MODULE_LICENSE against list from include/linux/module.h
6561 GPL|
6562 GPL\ v2|
6567 Proprietary
6572 }
6573 }
6574 }
6576 # If we have no input at all, then there is nothing to report on
6577 # so just keep quiet.
6580 }
6582 # In mailback mode only produce a report in the negative, for
6583 # things that appear to be patches.
6586 }
6588 # This is not a patch, and we are are in 'no-patch' mode so
6589 # just keep quiet.
6592 }
6597 }
6605 }
6606 }
6614 }
6617 # If there were any defects found and not already fixing them
6623 EOM
6624 }
6625 # If there were whitespace errors which cleanpatch can fix
6626 # then suggest that.
6633 EOM
6634 }
6635 }
6655 }
6658 }
6659 }
6667 Do _NOT_ trust the results written to this file.
6670 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6672 EOM
6673 }
6674 }
6682 }
6683 }
6685 }