| blob | 377f373db6c002ab87ce739be7f87f1d19bbe0cc |
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 __ro_after_init|
384 __kprobes|
386 ____cacheline_aligned|
387 ____cacheline_aligned_in_smp|
388 ____cacheline_internodealigned_in_smp|
389 __weak
411 <=|>=|==|!=|
412 =>|->|<<|>>|<|>|!|~|
446 )};
449 atomic_t
450 )};
455 )};
461 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
462 TP_printk|
464 panic|
467 )};
476 To:|
477 Cc:
478 )};
497 );
520 );
541 )};
548 );
552 );
559 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
566 );
568 #Create a search pattern for all these functions to speed up a loop below
573 }
587 );
589 #Create a search pattern for all these strings to speed up a loop below
594 }
598 S_IWUGO |
599 S_IWOTH |
600 S_IRWXUGO |
601 S_IALLUGO |
622 );
624 #Create a search pattern for all these strings to speed up a loop below
629 }
656 }
660 }
663 irq|
664 memory|
666 reboot
667 )};
668 # memory.h: ARM has a custom one
670 # Load common spelling mistakes and build regular expression list.
687 }
691 }
710 }
714 }
715 }
734 }
738 }
741 }
744 }
754 }
773 )
780 )
789 )
793 $NonptrType
798 $NonptrTypeMisordered
804 }
805 build_types();
809 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
810 # requires at least perl version v5.10.0
811 # Any use must be runtime checked with $^V
822 )};
831 }
836 }
860 }
861 }
862 }
869 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
872 }
877 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
883 }
907 }
909 }
917 }
921 }
926 }
930 }
938 }
940 }
941 }
955 # Maybe one day convert this block of bash into something that returns
956 # all matching commit ids, but it's very slow...
957 #
958 # echo "checking commits $1..."
959 # git rev-list --remotes | grep -i "^$1" |
960 # while read line ; do
961 # git log --format='%H %s' -1 $line |
962 # echo "commit $(cut -c 1-12,41-)"
963 # done
964 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
969 }
972 }
983 # If input is git commits, extract all commits from the commit expressions.
984 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
997 }
1006 }
1007 }
1010 }
1026 }
1033 }
1037 }
1044 }
1048 }
1057 build_types();
1058 }
1069 EOM
1070 }
1076 EOM
1077 }
1078 }
1089 );
1094 }
1095 }
1097 }
1120 # If there's a name left after stripping spaces and
1121 # leading quotes, and the address doesn't have both
1122 # leading and trailing angle brackets, the address
1123 # is invalid. ie:
1124 # "joe smith joe@smith.com" bad
1125 # "joe smith <joe@smith.com" bad
1130 }
1131 }
1141 }
1144 }
1158 }
1164 }
1167 }
1175 }
1176 }
1179 }
1187 }
1188 }
1191 }
1204 }
1206 }
1209 }
1212 }
1216 }
1221 # Drop the diff line leader and expand tabs
1225 # Pick the indent from the front of the line.
1229 }
1240 }
1241 }
1252 # Always copy over the diff marker.
1258 # Comments we are whacking completely including the begin
1259 # and end, all to $;.
1266 }
1272 }
1279 }
1281 # A \ in a string means ignore the next character.
1287 }
1288 # Regular quotes.
1297 }
1298 }
1300 #print "c<$c> SQ<$sanitise_quote>\n";
1309 }
1310 }
1314 }
1316 # The pathname on a #include may be surrounded by '<' and '>'.
1321 # The whole of a #error is a string.
1325 }
1330 }
1333 }
1341 }
1364 #warn "CSB: blk<$blk> remain<$remain>\n";
1365 # If we are about to drop off the end, pull in more
1366 # context.
1377 }
1378 # Bail if there is no further context.
1379 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1382 }
1386 }
1387 }
1392 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1394 # Handle nested #if/#else.
1401 }
1403 # Statement ends at the ';' or a close '}' at the
1404 # outermost level.
1407 }
1409 # An else is really a conditional as long as its not else if
1416 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1417 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1418 }
1423 }
1431 #warn "CSB: mark coff<$coff>\n";
1432 }
1433 }
1437 }
1445 }
1447 }
1448 }
1449 # Preprocessor commands end at the newline unless escaped.
1455 }
1457 }
1458 # We are truly at the end, so shuffle to the next line.
1463 }
1468 #warn "STATEMENT<$statement>\n";
1469 #warn "CONDITION<$condition>\n";
1471 #print "coff<$coff> soff<$off> loff<$loff>\n";
1475 }
1480 # Strip the diff line prefixes and rip blank lines at start and end.
1488 }
1496 }
1517 }
1518 }
1526 # Grab the first conditional/block pair.
1529 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1533 }
1535 # Pull in the following conditional/block pairs and see if they
1536 # could continue the statement.
1540 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1542 #print "C: push\n";
1544 }
1547 }
1566 # Handle nested #if/#else.
1573 }
1576 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1580 }
1587 }
1588 }
1592 }
1595 }
1598 }
1604 }
1610 }
1616 }
1621 }
1626 }
1631 # Catch a comment on the end of the line itself.
1635 # Look through the context and try and figure out if there is a
1636 # comment.
1641 #warn " $line\n";
1644 }
1647 }
1650 }
1654 }
1655 }
1659 }
1664 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1665 ##print "CMMT: $cmt\n";
1668 }
1681 }
1684 }
1692 }
1695 }
1703 }
1706 }
1718 }
1719 }
1723 }
1735 }
1755 }
1776 }
1805 # Assume all arms of the conditional end as this
1806 # one does, and continue as if the #endif was not here.
1823 }
1854 }
1866 }
1899 }
1914 }
1923 }
1927 }
1931 }
1932 }
1935 }
1944 DEFINE_\S+
1945 )$|
1949 case|
1953 \#|
1954 \#\#|
1960 # Check for modifiers.
1971 }
1972 }
1977 }
1978 build_types();
1981 }
1982 }
1994 }
2002 }
2011 }
2012 }
2017 }
2025 }
2031 }
2035 }
2046 }
2047 }
2074 }
2080 }
2087 }
2092 }
2095 }
2098 }
2106 };
2108 }
2116 };
2119 }
2128 }
2130 }
2138 }
2140 }
2148 }
2150 }
2156 ##print "absolute<$absolute>\n";
2158 # See if any suffix of this path is a path within the tree.
2161 ##print "file<$file>\n";
2163 }
2164 }
2167 }
2169 # It is, so see if the prefix is acceptable.
2173 ##print "prefix<$prefix>\n";
2177 }
2178 }
2186 }
2194 }
2202 }
2210 }
2219 #convert leading spaces to tabs
2221 #Remove spaces before a tab
2225 }
2239 }
2251 }
2252 }
2255 }
2296 # Trace the real file/line as we go.
2309 # suppression flags
2317 # Pre-scan the patch sanitizing the lines.
2318 # Pre-scan the patch looking for any __setup documentation.
2319 #
2327 sanitise_line_reset();
2339 }
2340 #next;
2341 }
2348 }
2351 # Guestimate if this is a continuing comment. Run
2352 # the context looking for a comment "edge". If this
2353 # edge is a close comment then we must be in a comment
2354 # at context start.
2361 #print "RAW<$rawlines[$ln - 1]>\n";
2367 }
2368 }
2371 }
2373 # Guestimate if this is a continuing comment. If this
2374 # is the start of a diff block and this line starts
2375 # ' *' then it is very likely a comment.
2378 {
2380 }
2382 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2386 # Standardise the strings and chars within the input to
2387 # simplify matching -- only bother with positive lines.
2389 }
2396 }
2398 #print "==>$rawline\n";
2399 #print "-->$line\n";
2403 }
2404 }
2419 # check if it's a mode change, rename or start of a patch
2425 }
2427 #extract the line range in the file after the patch is applied
2438 }
2439 annotate_reset();
2450 }
2453 # track the line number as we move through the hunk, note that
2454 # new versions of GNU diff omit the leading space on completely
2455 # blank context lines so we need to count that too.
2460 # Measure the line length and indent.
2463 # Track the previous line.
2468 #warn "line<$line>\n";
2472 }
2480 # extract the filename as it passes
2496 }
2500 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2501 }
2503 }
2505 #make up the handle for any error we report on this line
2513 }
2514 }
2519 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2520 }
2525 }
2536 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2537 }
2538 }
2541 }
2551 # Verify the existence of a commit log if appropriate
2552 # 2 is used because a $signature is counted in $commit_log_lines
2556 }
2561 }
2563 # Check if the commit log has what seems like a diff which can confuse patch
2572 }
2574 # Check for incorrect file permissions
2581 }
2582 }
2584 # Check the patch for a From:
2589 }
2591 # Check the patch for a signoff:
2600 }
2601 }
2602 }
2604 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2605 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2608 }
2610 # Check signature styles
2622 }
2629 }
2630 }
2637 }
2639 }
2646 }
2647 }
2658 # Don't force email to have quotes
2659 # Allow just an angle bracketed address
2665 }
2666 }
2668 # Check for duplicate signatures
2677 }
2678 }
2680 # Check email subject for common tools that don't need to be mentioned
2685 }
2687 # Check for unwanted Gerrit info
2691 }
2693 # Check if the commit log is in a possible stack dump
2697 # timestamp
2699 # stack dump address
2701 }
2703 # Check for line lengths > 75 in commit log, warn once
2707 # file delta changes
2709 # filename then :
2711 # A Fixes: or Link: line
2716 }
2718 # Reset possible stack dump if a blank line is found
2722 }
2724 # Check for git id commit length and improperly formed commit descriptions
2749 }
2771 }
2779 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2780 }
2781 }
2783 # Check for added, moved or deleted files
2793 }
2795 # Check for wrappage within a valid hunk of the file
2800 }
2802 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2813 }
2815 # Check if it's the start of a commit log
2816 # (not a header line and we haven't seen the patch filename)
2823 }
2825 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2826 # declined it, i.e defined some charset where it is missing.
2831 }
2837 }
2839 # Check for absolute kernel paths in commit message
2846 #
2849 }
2850 }
2851 }
2853 # Check for various typo / spelling mistakes
2867 }
2868 }
2869 }
2871 # ignore non-hunk lines and lines being removed
2874 #trailing whitespace
2881 }
2888 }
2891 }
2893 # Check for FSF mailing addresses.
2902 "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)
2903 }
2905 # check for Kconfig help text having a real description
2906 # Only applies when adding the entry originally, after that we do not have
2907 # sufficient context to determine whether it is indeed long enough.
2909 # 'choice' is usually the last thing on the line (though
2910 # Kconfig supports named choices), so use a word boundary
2911 # (\b) rather than a whitespace character (\s)
2933 }
2935 }
2942 # This only checks context lines in the patch
2943 # and so hopefully shouldn't trigger false
2944 # positives, even though some of these are
2945 # common words in help texts
2950 }
2952 }
2956 }
2957 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2958 }
2960 # check for MAINTAINERS entries that don't have the right form
2968 }
2969 }
2971 # discourage the use of boolean for type definition attributes of Kconfig options
2976 }
2986 };
2989 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2990 }
2992 # check for DT compatible documentation
3011 }
3018 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3019 }
3020 }
3021 }
3023 # check for using SPDX license tag at beginning of files
3037 }
3048 }
3049 }
3050 }
3051 }
3053 # check we are in a valid source file if not then ignore this hunk
3056 # line length limit (with some exclusions)
3057 #
3058 # There are a few types of lines that may extend beyond $max_line_length:
3059 # logging functions like pr_info that end in a string
3060 # lines with a single string
3061 # #defines that are a single string
3062 # lines with an RFC3986 like URL
3063 #
3064 # There are 3 different line length message types:
3065 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3066 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3067 # LONG_LINE all other lines longer than $max_line_length
3068 #
3069 # if LONG_LINE is ignored, the other 2 types are also ignored
3070 #
3075 # Check the allowed long line types first
3077 # logging functions that end in a string that starts
3078 # before $max_line_length
3079 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3083 # lines with only strings (w/ possible termination)
3084 # #defines with only strings
3089 # More special cases
3094 # URL ($rawline is used in case the URL is in a comment)
3098 # Otherwise set the alternate message types
3100 # a comment starts before $max_line_length
3105 # a quoted string starts before $max_line_length
3109 }
3115 }
3116 }
3118 # check for adding lines without a newline.
3119 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3122 }
3124 # check we are in a valid source file C or perl if not then ignore this hunk
3127 # at the beginning of a line any tabs must come first and anything
3128 # more than 8 must use tabs.
3137 }
3138 }
3140 # check for space before tabs.
3150 }
3151 }
3153 # check for assignments on the start of a line
3157 }
3159 # check for && or || at the start of a line
3163 }
3165 # check indentation starts on a tab stop
3167 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3174 }
3175 }
3176 }
3178 # check multi-line statement indentation matches previous line
3180 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3203 }
3204 }
3205 }
3206 }
3208 # check for space after cast like "(int) foo" or "(struct foo) bar"
3209 # avoid checking a few false positives:
3210 # "sizeof(<type>)" or "__alignof__(<type>)"
3211 # function pointer declarations like "(*foo)(int) = bar;"
3212 # structure definitions like "(struct foo) { 0 };"
3213 # multiline macros that define functions
3214 # known attributes or the __attribute__ keyword
3222 }
3223 }
3225 # Block comment styles
3226 # Networking with an initial /*
3233 }
3235 # Block comments use * on subsequent lines
3243 }
3245 # Block comments use */ on trailing lines
3252 }
3254 # Block comment * alignment
3268 }
3275 }
3276 }
3278 # check for missing blank lines after struct/union declarations
3279 # with exceptions for various attributes and macros
3295 }
3296 }
3298 # check for multiple consecutive blank lines
3306 }
3309 }
3311 # check for missing blank lines after declarations
3313 # actual declarations
3315 # function pointer declarations
3317 # foo bar; where foo is some local typedef or #define
3319 # known declaration macros
3321 # for "else if" which can look like "$Ident $Ident"
3323 # other possible extensions of declaration lines
3325 # not starting a section or a macro "\" extended line
3327 # looks like a declaration
3329 # function pointer declarations
3331 # foo bar; where foo is some local typedef or #define
3333 # known declaration macros
3335 # start of struct or union or enum
3337 # start or end of block or continuation of declaration
3339 # bitfield continuation
3341 # other possible extensions of declaration lines
3343 # indentation of previous and current line are the same
3349 }
3350 }
3352 # check for spaces at the beginning of a line.
3353 # Exceptions:
3354 # 1) within comments
3355 # 2) indented preprocessor commands
3356 # 3) hanging labels
3363 }
3364 }
3366 # check we are in a valid C source file if not then ignore this hunk
3369 # check for unusual line ending [ or (
3373 }
3375 # check if this appears to be the start function declaration, save the name
3379 }
3381 # check if this appears to be the end of function declaration
3384 }
3386 # check indentation of any line with a bare else
3387 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3388 # if the previous line is a break or return and is indented 1 tab more...
3397 }
3398 }
3400 # check indentation of a line with a break;
3401 # if the previous line is a goto or return and is indented the same # of tabs
3407 }
3408 }
3410 # check for RCS/CVS revision markers
3414 }
3416 # check for old HOTPLUG __dev<foo> section markings
3420 }
3422 # Check for potential 'bare' types
3425 #print "LINE<$line>\n";
3433 #print "linenr<$linenr> <$stat>\n";
3434 # If this statement has no statement boundaries within
3435 # it there is no point in retrying a statement scan
3436 # until we hit end of it.
3439 #print "skip<$line_nr_next>\n";
3441 }
3443 # Find the real next line.
3449 }
3454 # Ignore goto labels.
3457 # Ignore functions being called
3462 # declarations always start with types
3463 } 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) {
3468 # definitions in global scope can only start with types
3471 }
3473 # any (foo ... *) is a pointer cast, and foo is a type
3476 }
3478 # Check for any sort of function declaration.
3479 # int foo(something bar, other baz);
3480 # void (*store_gdt)(x86_descr_ptr *);
3481 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3489 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3492 }
3493 }
3494 }
3496 }
3498 #
3499 # Checks which may be anchored in the context.
3500 #
3502 # Check for switch () and associated case and default
3503 # statements should be at the same indent.
3517 }
3518 }
3522 }
3523 }
3525 # if/while/etc brace do not go on next line, unless defining a do while loop,
3526 # or if that brace on the next line is for something else
3527 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3535 }
3546 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3549 }
3551 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3552 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3558 }
3562 {
3568 }
3569 }
3570 }
3572 # Check relative indent for conditionals and blocks.
3573 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3581 # remove inline comments
3585 # Find out how long the conditional actually is.
3589 # Make sure we remove the line prefixes as we have
3590 # none on the first line, and are going to readd them
3591 # where necessary.
3595 }
3597 # We want to check the first line inside the block
3598 # starting at the end of the conditional, so remove:
3599 # 1) any blank line termination
3600 # 2) any opening brace { on end of the line
3601 # 3) any do (...) {
3608 }
3612 }
3614 # Also ignore a loop construct at the end of a
3615 # preprocessor statement.
3619 }
3626 # If we see an #else/#elif then the code
3627 # is not linear.
3630 }
3632 # Ignore:
3633 # 1) blank lines, they should be at 0,
3634 # 2) preprocessor lines, and
3635 # 3) labels.
3643 }
3644 }
3645 }
3650 # Check if either of these lines are modified, else
3651 # this is not this patch's fault.
3655 }
3658 }
3660 #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";
3669 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3670 }
3671 }
3673 # Track the 'values' across context and added lines.
3683 }
3686 #ignore lines not being added
3689 # check for dereferences that span multiple lines
3699 }
3701 # check for declarations of signed or unsigned without int
3702 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3713 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3721 }
3722 }
3723 }
3725 # TEST: allow direct testing of the type matcher.
3733 }
3735 }
3736 # TEST: allow direct testing of the attribute matcher.
3744 }
3746 }
3748 # check for initialisation to aggregates open brace on the next line
3762 }
3763 }
3765 #
3766 # Checks which are anchored on the added line.
3767 #
3769 # check for malformed paths in #include statements (uses RAW line)
3775 }
3779 }
3780 }
3782 # no C99 // comments
3791 }
3792 }
3793 }
3794 # Remove C99 comments.
3798 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3799 # the whole statement.
3800 #print "APW <$lines[$realline_next - 1]>\n";
3806 # Handle definitions which produce identifiers with
3807 # a prefix:
3808 # XXX(foo);
3809 # EXPORT_SYMBOL(something_foo);
3813 #print "FOO C name<$name>\n";
3824 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3828 }
3829 }
3834 #print "FOO B <$lines[$linenr - 1]>\n";
3836 }
3841 }
3843 # check for global initialisers.
3849 }
3850 }
3851 # check for static initialisers.
3858 }
3859 }
3861 # check for misordered declarations of char/short/int/long with signed/unsigned
3865 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3866 }
3868 # check for unnecessary <signed> int declarations of short/long/long long
3885 }
3886 }
3888 # check for static const char * arrays.
3893 }
3895 # check for static char foo[] = "bar" declarations.
3900 }
3902 # check for const <foo> const where <foo> is not a pointer or array type
3911 }
3912 }
3914 # check for non-global char *foo[] = {"bar", ...} declarations.
3919 }
3921 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3924 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3930 }
3931 }
3932 }
3934 # check for function declarations without arguments like "int foo()"
3940 }
3941 }
3943 # check for new typedefs, only function parameters and sparse annotations
3944 # make sense.
3952 }
3954 # * goes on variable not on type
3955 # (char*[ const])
3957 #print "AA<$1>\n";
3960 # Should start with a space.
3962 # Should not end with a space.
3964 # '*'s should not have spaces between.
3966 }
3968 ## print "1: from<$from> to<$to> ident<$ident>\n";
3978 }
3979 }
3980 }
3982 #print "BB<$1>\n";
3985 # Should start with a space.
3987 # Should not end with a space.
3989 # '*'s should not have spaces between.
3991 }
3992 # Modifiers should have spaces.
3995 ## print "2: from<$from> to<$to> ident<$ident>\n";
4006 }
4007 }
4008 }
4010 # avoid BUG() or BUG_ON()
4015 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4016 }
4018 # avoid LINUX_VERSION_CODE
4021 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4022 }
4024 # check for uses of printk_ratelimit
4028 }
4030 # printk should use KERN_* levels
4034 }
4043 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
4044 }
4052 }
4053 }
4062 }
4064 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4065 # number of false positives, but assembly files are not checked, so at
4066 # least the arch entry code will not trigger this warning.
4070 }
4072 # function brace can't be on same line, except for #defines of do while,
4073 # or if closed on same line
4090 }
4091 }
4092 }
4094 # open braces for enum, union and struct go on the same line.
4108 }
4109 }
4110 }
4112 # missing space after union, struct or enum definition
4119 }
4120 }
4122 # Function pointer declarations
4123 # check spacing between type, funcptr, and args
4124 # canonical declaration is "type (*funcptr)(args...)"
4133 # the $Declare variable will capture all spaces after the type
4134 # so check it for a missing trailing missing space but pointer return types
4135 # don't need a space so don't warn for those.
4140 }
4145 }
4147 # unnecessary space "type (*funcptr)(args...)"
4148 # This test is not currently implemented because these declarations are
4149 # equivalent to
4150 # int foo(int bar, ...)
4151 # and this is form shouldn't/doesn't generate a checkpatch warning.
4152 #
4153 # elsif ($declare =~ /\s{2,}$/) {
4154 # WARN("SPACING",
4155 # "Multiple spaces after return type\n" . $herecurr);
4156 # }
4158 # unnecessary space "type ( *funcptr)(args...)"
4163 }
4165 # unnecessary space "type (* funcptr)(args...)"
4170 }
4172 # unnecessary space "type (*funcptr )(args...)"
4177 }
4179 # unnecessary space "type (*funcptr) (args...)"
4184 }
4188 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4189 }
4190 }
4192 # check for spacing round square brackets; allowed:
4193 # 1. with a type on the left -- int [] a;
4194 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4195 # 3. inside a curly brace -- = { [0...10] = 5 }
4206 }
4207 }
4208 }
4210 # check for spaces between functions and their parentheses.
4216 # Ignore those directives where spaces _are_ permitted.
4222 {
4223 # cpp #define statements have non-optional spaces, ie
4224 # if there is a space between the name and the open
4225 # parenthesis it is simply not a parameter group.
4228 # cpp #elif statement condition may start with a (
4231 # If this whole things ends with a type its most
4232 # likely a typedef for a function.
4241 }
4242 }
4243 }
4245 # Check operator spacing.
4251 <<=|>>=|<=|>=|==|!=|
4253 =>|->|<<|>>|<|>|=|!|~|
4259 ## print("element count: <" . $#elements . ">\n");
4260 ## foreach my $el (@elements) {
4261 ## print("el: <$el>\n");
4262 ## }
4270 }
4281 ## print("n: <$n> good: <$good>\n");
4285 # Pick up the preceding and succeeding characters.
4290 }
4313 }
4322 # Pull out the value of this operator.
4325 # Get the full operator variant.
4328 # Ignore operators passed as parameters.
4332 # # Ignore comments
4333 # } elsif ($op =~ /^$;+$/) {
4335 # ; should have either the end of line or a space or \ after it
4343 }
4344 }
4346 # // is a comment
4349 # : when part of a bitfield
4351 # skip the bitfield test for now
4353 # No spaces for:
4354 # ->
4362 }
4364 }
4365 }
4367 # , must not have a space before and must have a space on the right.
4376 }
4377 }
4384 }
4385 }
4391 }
4394 }
4395 }
4397 # '*' as part of a type definition -- reported already.
4399 #warn "'*' is part of type\n";
4401 # unary operators should have a space before and
4402 # none after. May be left adjacent to another
4403 # unary operator, or a cast
4413 }
4414 }
4415 }
4417 # A unary '*' may be const
4425 }
4427 }
4428 }
4430 # unary ++ and unary -- are allowed no space on one side.
4437 }
4438 }
4445 }
4446 }
4453 }
4455 }
4456 }
4458 # << and >> may either have or not have spaces both sides
4464 {
4472 }
4478 }
4479 }
4486 }
4488 }
4489 }
4491 # A colon needs no spaces before when it is
4492 # terminating a case value or a label.
4499 }
4500 }
4502 # All the others need spaces both sides.
4506 # Ignore email addresses <foo@bar>
4511 {
4513 }
4515 # for asm volatile statements
4516 # ignore a colon with another
4517 # colon immediately before or after
4521 }
4523 # messages are ERROR, but ?: are CHK
4533 }
4535 }
4536 }
4537 }
4540 ## print("n: <$n> GOOD: <$good>\n");
4543 }
4547 }
4551 }
4554 }
4556 # check for whitespace before a non-naked semicolon
4563 }
4564 }
4566 # check for multiple assignments
4570 }
4572 ## # check for multiple declarations, allowing for a function declaration
4573 ## # continuation.
4574 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4575 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4576 ##
4577 ## # Remove any bracketed sections to ensure we do not
4578 ## # falsly report the parameters of functions.
4579 ## my $ln = $line;
4580 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4581 ## }
4582 ## if ($ln =~ /,/) {
4583 ## WARN("MULTIPLE_DECLARATION",
4584 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4585 ## }
4586 ## }
4588 #need space before brace following if, while, etc
4595 }
4596 }
4598 ## # check for blank lines before declarations
4599 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4600 ## $prevrawline =~ /^.\s*$/) {
4601 ## WARN("SPACING",
4602 ## "No blank lines before declarations\n" . $hereprev);
4603 ## }
4604 ##
4606 # closing brace should have a space following it when it has anything
4607 # on the line
4614 }
4615 }
4617 # check spacing on square brackets
4624 }
4625 }
4632 }
4633 }
4635 # check spacing on parentheses
4643 }
4644 }
4653 }
4654 }
4656 # check unnecessary parentheses around addressof/dereference single $Lvals
4657 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4665 }
4666 }
4668 # check for unnecessary parentheses around function pointer uses
4669 # ie: (foo->bar)(); should be foo->bar();
4670 # but not "if (foo->bar) (" to avoid some false positives
4679 }
4680 }
4682 # check for unnecessary parentheses around comparisons in if uses
4683 # when !drivers/staging or command-line uses --strict
4690 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4692 # avoid parentheses around potential macro args
4701 }
4702 }
4705 }
4706 }
4708 #goto labels aren't indented, allow a single space however
4716 }
4717 }
4719 # return is not a function
4729 }
4733 }
4734 }
4736 # unnecessary return in a void function
4737 # at end-of-function, with the previous line a single leading tab, then return;
4738 # and the line before that not a goto label target like "out:"
4746 }
4748 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4754 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4759 }
4760 }
4762 # comparisons with a constant or upper case identifier on the left
4763 # avoid cases like "foo + BAR < baz"
4764 # only fix matches surrounded by parentheses to avoid incorrect
4765 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4786 }
4788 }
4789 }
4791 # Return of what appears to be an errno should normally be negative
4797 }
4798 }
4800 # Need a space before open parenthesis after if, while etc
4807 }
4808 }
4810 # Check for illegal assignment in if conditional -- and check for trailing
4811 # statements after the conditional.
4819 ##print "stat<$stat> stat_next<$stat_next>\n";
4822 # If the statement carries leading newlines,
4823 # then count those as offsets.
4831 }
4832 }
4841 }
4843 # Find out what is on the end of the line after the
4844 # conditional.
4850 {
4851 # Find out how long the conditional actually is.
4860 }
4864 }
4865 }
4867 # Check for bitwise tests written as boolean
4873 |
4878 {
4881 }
4883 # if and else should not have general statements after it
4890 }
4891 }
4892 # if should not continue a brace
4897 }
4898 # case and default should not have general statements after them
4904 {
4907 }
4909 # Check for }<nl>else {, these must be at the same
4910 # indent level to be relevant to each other.
4922 }
4926 }
4927 }
4933 # Find out what is on the end of the line after the
4934 # conditional.
4950 }
4951 }
4952 }
4954 #Specific variable tests
4958 #CamelCase
4961 #Ignore Page<foo> variants
4963 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4965 #Ignore some three character SI units explicitly, like MiB and KHz
4971 seed_camelcase_includes();
4975 }
4976 }
4981 }
4982 }
4983 }
4984 }
4986 #no spaces allowed after \ in define
4992 }
4993 }
4995 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4996 # itself <asm/foo.h> (uses RAW line)
5003 {
5012 }
5013 }
5014 }
5015 }
5017 # multi-statement macros should be enclosed in a do while loop, grab the
5018 # first statement and ensure its the whole macro if its not enclosed
5019 # in a known good container
5031 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5032 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5047 }
5054 # Flatten any parentheses and braces
5058 {
5059 }
5061 # Flatten any obvious string concatentation.
5064 {
5065 }
5067 # Make asm volatile uses seem like a generic function
5072 module_param_named|
5073 MODULE_PARM_DESC|
5074 DECLARE_PER_CPU|
5075 DEFINE_PER_CPU|
5076 __typeof__\(|
5077 union|
5078 struct|
5083 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5092 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5097 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5103 {
5106 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5113 }
5115 }
5117 # Make $define_stmt single line, comment-free, etc
5128 }
5129 }
5134 # check if any macro arguments are reused (ignore '...' and 'type')
5139 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5146 }
5147 # check if any macro arguments may have other precedence issues
5153 }
5154 }
5156 # check for macros with flow control, but without ## concatenation
5157 # ## concatenation is commonly a macro that defines a function so ignore those
5164 }
5166 # check for line continuations outside of #defines, preprocessor #, and asm
5175 }
5176 }
5178 # do {} while (0) macro tests:
5179 # single-statement macros do not need to be enclosed in do while (0) loop,
5180 # macro should not end with a semicolon
5195 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5207 }
5211 }
5219 }
5220 }
5222 # check for redundant bracing round if etc
5226 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5227 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5237 # If the condition carries leading newlines, then count those as offsets.
5242 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5244 # We have looked at and allowed this specific line.
5254 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5256 #print "APW: ALLOWED: cond<$cond>\n";
5258 }
5260 #print "APW: ALLOWED: block<$block>\n";
5262 }
5264 #print "APW: ALLOWED: lines block<$block>\n";
5266 }
5268 }
5273 }
5281 }
5282 }
5283 }
5284 }
5289 # Check the pre-context.
5291 #print "APW: ALLOWED: pre<$1>\n";
5293 }
5298 # Check the condition.
5300 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5303 }
5305 #print "APW: ALLOWED: cond<$cond>\n";
5307 }
5309 #print "APW: ALLOWED: block<$block>\n";
5311 }
5313 #print "APW: ALLOWED: lines block<$block>\n";
5315 }
5316 # Check the post-context.
5321 }
5323 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5325 }
5326 }
5333 }
5334 }
5336 # check for single line unbalanced braces
5340 }
5342 # check for unnecessary blank lines around braces
5348 }
5349 }
5355 }
5356 }
5358 # no volatiles please
5362 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5363 }
5365 # Check for user-visible strings broken across lines, which breaks the ability
5366 # to grep for the string. Make exceptions when the previous string ends in a
5367 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5368 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5381 }
5393 }
5395 }
5396 }
5398 # check for missing a space in a string concatenation
5402 }
5404 # check for an embedded function name in a string when the function is known
5405 # This does not work very well for -f --file checking as it depends on patch
5406 # context providing the function name or a single line form for in-file
5407 # function declarations
5413 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5414 }
5416 # check for spaces before a quoted newline
5422 }
5424 }
5426 # concatenated string without spaces between elements
5435 }
5436 }
5437 }
5439 # uncoalesced string fragments
5447 }
5448 }
5449 }
5451 # check for non-standard and hex prefixed decimal printf formats
5457 # check for %L
5462 }
5463 # check for %Z
5468 }
5469 # check for 0x<decimal>
5473 }
5474 }
5476 # check for line continuations in quoted strings with odd counts of "
5480 }
5482 # warn about #if 0
5486 }
5488 # warn about #if 1
5492 }
5494 # check for needless "if (<foo>) fn(<foo>)" uses
5498 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5510 }
5515 }
5518 }
5522 }
5523 }
5524 }
5525 }
5527 # check for unnecessary "Out of Memory" messages
5536 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5538 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)/) {
5541 }
5542 }
5544 # check for logging functions with KERN_<LEVEL>
5552 }
5553 }
5555 # check for logging continuations
5559 }
5561 # check for mask then right shift without a parentheses
5567 }
5569 # check for pointer comparisons to NULL
5579 }
5580 }
5581 }
5583 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5586 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5596 $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;
5597 }
5598 }
5599 }
5601 # check for $InitAttributeData (ie: __initdata) with const
5612 }
5613 }
5615 # check for $InitAttributeConst (ie: __initconst) without const
5627 }
5628 }
5630 # check for __read_mostly with const non-pointer (should just be const)
5637 }
5638 }
5640 # don't use __constant_<foo> functions outside of include/uapi/
5642 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5650 }
5651 }
5653 # prefer usleep_range over udelay
5656 # ignore udelay's < 10, however
5659 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5660 }
5664 }
5665 }
5667 # warn about unexpectedly long msleep's
5671 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5672 }
5673 }
5675 # check for comparisons of jiffies
5678 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5679 }
5681 # check for comparisons of get_jiffies_64()
5684 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5685 }
5687 # warn about #ifdefs in C files
5688 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5689 # print "#ifdef in C files should be avoided\n";
5690 # print "$herecurr";
5691 # $clean = 0;
5692 # }
5694 # warn about spacing in #ifdefs
5701 }
5703 }
5705 # check for spinlock_t definitions without a comment.
5712 }
5713 }
5714 # check for memory barriers without a comment.
5717 mb|
5718 rmb|
5719 wmb|
5720 read_barrier_depends
5723 mb__before_atomic|
5724 mb__after_atomic|
5725 store_release|
5726 load_acquire|
5727 store_mb|
5740 }
5741 }
5751 }
5753 # check for waitqueue_active without a comment.
5758 }
5759 }
5761 # check for smp_read_barrier_depends and read_barrier_depends
5765 }
5767 # check of hardware specific defines
5768 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5771 }
5773 # check that the storage class is not after a type
5777 }
5778 # Check that the storage class is at the beginning of a declaration
5785 }
5787 # check the location of the inline attribute, that it is between
5788 # storage class and type.
5793 }
5795 # Check for __inline__ and __inline, prefer inline
5803 }
5804 }
5806 # Check for __attribute__ packed, prefer __packed
5811 }
5813 # Check for __attribute__ aligned, prefer __aligned
5818 }
5820 # Check for __attribute__ format(printf, prefer __printf
5824 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5826 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5828 }
5829 }
5831 # Check for __attribute__ format(scanf, prefer __scanf
5835 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5837 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5838 }
5839 }
5841 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5843 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5848 }
5850 # check for c99 types like uint8_t used outside of uapi/ and tools/
5865 }
5866 }
5867 }
5869 # check for cast of C90 native int or longer types constants
5884 }
5886 }
5887 }
5889 # check for sizeof(&)
5893 }
5895 # check for sizeof without parenthesis
5900 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5901 }
5902 }
5904 # check for struct spinlock declarations
5908 }
5910 # check for seq_printf uses that could be seq_puts
5919 }
5920 }
5921 }
5923 # check for vsprintf extension %p<foo> misuses
5945 }
5949 }
5951 "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");
5952 }
5953 }
5962 }
5966 }
5967 }
5968 }
5970 # Check for misused memsets
5985 }
5986 }
5988 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5989 # if ($perl_version_ok &&
5990 # defined $stat &&
5991 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5992 # if (WARN("PREFER_ETHER_ADDR_COPY",
5993 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5994 # $fix) {
5995 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5996 # }
5997 # }
5999 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6000 # if ($perl_version_ok &&
6001 # defined $stat &&
6002 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6003 # WARN("PREFER_ETHER_ADDR_EQUAL",
6004 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6005 # }
6007 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6008 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6009 # if ($perl_version_ok &&
6010 # defined $stat &&
6011 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6012 #
6013 # my $ms_val = $7;
6014 #
6015 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6016 # if (WARN("PREFER_ETH_ZERO_ADDR",
6017 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6018 # $fix) {
6019 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6020 # }
6021 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6022 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6023 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6024 # $fix) {
6025 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6026 # }
6027 # }
6028 # }
6030 # typecasts on min/max could be min_t/max_t
6048 }
6051 }
6052 }
6054 # check usleep_range arguments
6062 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
6066 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
6067 }
6068 }
6070 # check for naked sscanf
6082 }
6084 # check for simple sscanf that should be kstrto<foo>
6098 }
6099 }
6100 }
6102 # check for new externs in .h files.
6109 }
6110 }
6112 # check for new externs in .c files.
6115 {
6122 }
6125 {
6128 }
6133 }
6137 {
6140 }
6142 # check for function declarations that have arguments without identifier names
6144 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6152 }
6153 }
6154 }
6156 # check for function definitions
6162 # check for multiline function definition with misplaced open brace
6172 }
6176 }
6177 }
6179 # checks for new __setup's
6185 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6186 }
6187 }
6189 # check for pointless casting of kmalloc return
6192 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6193 }
6195 # alloc style
6196 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6198 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6201 }
6203 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6206 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6217 }
6227 $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;
6228 }
6229 }
6230 }
6232 # check for krealloc arg reuse
6238 }
6240 # check for alloc argument mismatch
6244 }
6246 # check for multiple semicolons
6252 }
6253 }
6255 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6264 }
6265 }
6267 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6268 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6274 }
6275 }
6277 # check for case / default statements not preceded by break/fallthrough/switch
6294 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6295 }
6299 }
6300 }
6302 # check for switch/default statements without a break;
6311 }
6313 # check for gcc specific __FUNCTION__
6319 }
6320 }
6322 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6326 }
6328 # check for use of yield()
6332 }
6334 # check for comparisons against true and false
6350 }
6355 ## maybe suggesting a correct construct would better
6356 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6358 }
6359 }
6361 # check for bool bitfields
6364 "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr);
6365 }
6367 # check for bool use in .h files
6371 "Avoid using bool structure members because of possible alignment issues - see: https://lkml.org/lkml/2017/11/21/384\n" . $herecurr);
6372 }
6374 # check for semaphores initialized locked
6378 }
6380 # recommend kstrto* over simple_strto* and strict_strto*
6384 }
6386 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6389 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6390 }
6392 # check for spin_is_locked(), suggest lockdep instead
6395 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6396 }
6398 # check for deprecated apis
6404 }
6406 # check for various structs that are normally const (ops, kgdb, device_tree)
6407 # and avoid what seem like struct definitions 'struct foo {'
6412 }
6414 # use of NR_CPUS is usually wrong
6415 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6422 {
6424 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6425 }
6427 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6431 }
6433 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6438 }
6440 # whine mightly about in_atomic
6448 }
6449 }
6451 # check for mutex_trylock_recursive usage
6455 }
6457 # check for lockdep_set_novalidate_class
6465 }
6466 }
6471 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6472 }
6474 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6475 # and whether or not function naming is typical and if
6476 # DEVICE_ATTR permissions uses are unusual too
6479 $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*\)/) {
6491 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6492 }
6499 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6500 }
6507 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6508 }
6519 }
6522 }
6528 }
6529 }
6531 # Mode permission misuses where it seems decimal should be octal
6532 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6533 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6534 # specific definition of not visible in sysfs.
6535 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6536 # use the default permissions
6552 }
6562 }
6565 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6566 }
6567 }
6568 }
6569 }
6571 # check for uses of S_<PERMS> that could be octal for readability
6576 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6579 }
6580 }
6582 # validate content of MODULE_LICENSE against list from include/linux/module.h
6586 GPL|
6587 GPL\ v2|
6592 Proprietary
6597 }
6598 }
6599 }
6601 # If we have no input at all, then there is nothing to report on
6602 # so just keep quiet.
6605 }
6607 # In mailback mode only produce a report in the negative, for
6608 # things that appear to be patches.
6611 }
6613 # This is not a patch, and we are are in 'no-patch' mode so
6614 # just keep quiet.
6617 }
6622 }
6630 }
6631 }
6639 }
6642 # If there were any defects found and not already fixing them
6648 EOM
6649 }
6650 # If there were whitespace errors which cleanpatch can fix
6651 # then suggest that.
6658 EOM
6659 }
6660 }
6680 }
6683 }
6684 }
6692 Do _NOT_ trust the results written to this file.
6695 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6697 EOM
6698 }
6699 }
6707 }
6708 }
6710 }