| blob | 93a7edfe0f0592b988651bedcd3aa180b1e63a77 |
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 )};
475 # dev_alloc_skb/netdev_alloc_skb, et al
476 dma_alloc_coherent
477 )};
487 To:|
488 Cc:
489 )};
508 );
531 );
552 )};
559 );
563 );
570 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
577 );
579 #Create a search pattern for all these functions to speed up a loop below
584 }
598 );
600 #Create a search pattern for all these strings to speed up a loop below
605 }
609 S_IWUGO |
610 S_IWOTH |
611 S_IRWXUGO |
612 S_IALLUGO |
633 );
635 #Create a search pattern for all these strings to speed up a loop below
640 }
667 }
671 }
674 irq|
675 memory|
677 reboot
678 )};
679 # memory.h: ARM has a custom one
681 # Load common spelling mistakes and build regular expression list.
698 }
702 }
721 }
725 }
726 }
745 }
749 }
752 }
755 }
765 }
784 )
791 )
800 )
804 $NonptrType
809 $NonptrTypeMisordered
815 }
816 build_types();
820 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
821 # requires at least perl version v5.10.0
822 # Any use must be runtime checked with $^V
833 )};
842 }
847 }
871 }
872 }
873 }
880 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
883 }
888 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
894 }
918 }
920 }
928 }
932 }
937 }
941 }
949 }
951 }
952 }
966 # Maybe one day convert this block of bash into something that returns
967 # all matching commit ids, but it's very slow...
968 #
969 # echo "checking commits $1..."
970 # git rev-list --remotes | grep -i "^$1" |
971 # while read line ; do
972 # git log --format='%H %s' -1 $line |
973 # echo "commit $(cut -c 1-12,41-)"
974 # done
975 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
980 }
983 }
994 # If input is git commits, extract all commits from the commit expressions.
995 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1008 }
1017 }
1018 }
1021 }
1038 }
1045 }
1049 }
1056 }
1060 }
1069 build_types();
1070 }
1081 EOM
1082 }
1088 EOM
1089 }
1090 }
1101 );
1106 }
1107 }
1109 }
1132 # If there's a name left after stripping spaces and
1133 # leading quotes, and the address doesn't have both
1134 # leading and trailing angle brackets, the address
1135 # is invalid. ie:
1136 # "joe smith joe@smith.com" bad
1137 # "joe smith <joe@smith.com" bad
1142 }
1143 }
1153 }
1156 }
1170 }
1176 }
1179 }
1187 }
1188 }
1191 }
1199 }
1200 }
1203 }
1216 }
1218 }
1221 }
1224 }
1228 }
1233 # Drop the diff line leader and expand tabs
1237 # Pick the indent from the front of the line.
1241 }
1252 }
1253 }
1264 # Always copy over the diff marker.
1270 # Comments we are whacking completely including the begin
1271 # and end, all to $;.
1278 }
1284 }
1291 }
1293 # A \ in a string means ignore the next character.
1299 }
1300 # Regular quotes.
1309 }
1310 }
1312 #print "c<$c> SQ<$sanitise_quote>\n";
1321 }
1322 }
1326 }
1328 # The pathname on a #include may be surrounded by '<' and '>'.
1333 # The whole of a #error is a string.
1337 }
1342 }
1345 }
1353 }
1376 #warn "CSB: blk<$blk> remain<$remain>\n";
1377 # If we are about to drop off the end, pull in more
1378 # context.
1389 }
1390 # Bail if there is no further context.
1391 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1394 }
1398 }
1399 }
1404 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1406 # Handle nested #if/#else.
1413 }
1415 # Statement ends at the ';' or a close '}' at the
1416 # outermost level.
1419 }
1421 # An else is really a conditional as long as its not else if
1428 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1429 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1430 }
1435 }
1443 #warn "CSB: mark coff<$coff>\n";
1444 }
1445 }
1449 }
1457 }
1459 }
1460 }
1461 # Preprocessor commands end at the newline unless escaped.
1467 }
1469 }
1470 # We are truly at the end, so shuffle to the next line.
1475 }
1480 #warn "STATEMENT<$statement>\n";
1481 #warn "CONDITION<$condition>\n";
1483 #print "coff<$coff> soff<$off> loff<$loff>\n";
1487 }
1492 # Strip the diff line prefixes and rip blank lines at start and end.
1500 }
1508 }
1529 }
1530 }
1538 # Grab the first conditional/block pair.
1541 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1545 }
1547 # Pull in the following conditional/block pairs and see if they
1548 # could continue the statement.
1552 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1554 #print "C: push\n";
1556 }
1559 }
1578 # Handle nested #if/#else.
1585 }
1588 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1592 }
1599 }
1600 }
1604 }
1607 }
1610 }
1616 }
1622 }
1628 }
1633 }
1638 }
1643 # Catch a comment on the end of the line itself.
1647 # Look through the context and try and figure out if there is a
1648 # comment.
1653 #warn " $line\n";
1656 }
1659 }
1662 }
1666 }
1667 }
1671 }
1676 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1677 ##print "CMMT: $cmt\n";
1680 }
1693 }
1696 }
1704 }
1707 }
1715 }
1718 }
1730 }
1731 }
1735 }
1747 }
1767 }
1788 }
1817 # Assume all arms of the conditional end as this
1818 # one does, and continue as if the #endif was not here.
1835 }
1866 }
1878 }
1911 }
1926 }
1935 }
1939 }
1943 }
1944 }
1947 }
1956 DEFINE_\S+
1957 )$|
1961 case|
1965 \#|
1966 \#\#|
1972 # Check for modifiers.
1983 }
1984 }
1989 }
1990 build_types();
1993 }
1994 }
2006 }
2014 }
2023 }
2024 }
2029 }
2037 }
2043 }
2047 }
2058 }
2059 }
2086 }
2092 }
2099 }
2104 }
2107 }
2110 }
2118 };
2120 }
2128 };
2131 }
2140 }
2142 }
2150 }
2152 }
2160 }
2162 }
2168 ##print "absolute<$absolute>\n";
2170 # See if any suffix of this path is a path within the tree.
2173 ##print "file<$file>\n";
2175 }
2176 }
2179 }
2181 # It is, so see if the prefix is acceptable.
2185 ##print "prefix<$prefix>\n";
2189 }
2190 }
2198 }
2206 }
2214 }
2222 }
2231 #convert leading spaces to tabs
2233 #Remove spaces before a tab
2237 }
2251 }
2263 }
2264 }
2267 }
2308 # Trace the real file/line as we go.
2321 # suppression flags
2329 # Pre-scan the patch sanitizing the lines.
2330 # Pre-scan the patch looking for any __setup documentation.
2331 #
2339 sanitise_line_reset();
2351 }
2352 #next;
2353 }
2360 }
2363 # Guestimate if this is a continuing comment. Run
2364 # the context looking for a comment "edge". If this
2365 # edge is a close comment then we must be in a comment
2366 # at context start.
2373 #print "RAW<$rawlines[$ln - 1]>\n";
2379 }
2380 }
2383 }
2385 # Guestimate if this is a continuing comment. If this
2386 # is the start of a diff block and this line starts
2387 # ' *' then it is very likely a comment.
2390 {
2392 }
2394 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2398 # Standardise the strings and chars within the input to
2399 # simplify matching -- only bother with positive lines.
2401 }
2408 }
2410 #print "==>$rawline\n";
2411 #print "-->$line\n";
2415 }
2416 }
2431 # check if it's a mode change, rename or start of a patch
2437 }
2439 #extract the line range in the file after the patch is applied
2450 }
2451 annotate_reset();
2462 }
2465 # track the line number as we move through the hunk, note that
2466 # new versions of GNU diff omit the leading space on completely
2467 # blank context lines so we need to count that too.
2472 # Measure the line length and indent.
2475 # Track the previous line.
2480 #warn "line<$line>\n";
2484 }
2492 # extract the filename as it passes
2508 }
2512 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2513 }
2515 }
2517 #make up the handle for any error we report on this line
2525 }
2526 }
2531 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2532 }
2537 }
2548 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2549 }
2550 }
2553 }
2563 # Verify the existence of a commit log if appropriate
2564 # 2 is used because a $signature is counted in $commit_log_lines
2568 }
2573 }
2575 # Check if the commit log has what seems like a diff which can confuse patch
2584 }
2586 # Check for incorrect file permissions
2593 }
2594 }
2596 # Check the patch for a From:
2601 }
2603 # Check the patch for a signoff:
2612 }
2613 }
2614 }
2616 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2617 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2620 }
2622 # Check signature styles
2634 }
2641 }
2642 }
2649 }
2651 }
2658 }
2659 }
2670 # Don't force email to have quotes
2671 # Allow just an angle bracketed address
2677 }
2678 }
2680 # Check for duplicate signatures
2689 }
2691 # Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2695 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2696 }
2702 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2705 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2706 }
2707 }
2708 }
2710 # Check email subject for common tools that don't need to be mentioned
2715 }
2717 # Check for unwanted Gerrit info
2721 }
2723 # Check if the commit log is in a possible stack dump
2727 # timestamp
2729 # stack dump address
2731 }
2733 # Check for line lengths > 75 in commit log, warn once
2737 # file delta changes
2739 # filename then :
2741 # A Fixes: or Link: line
2746 }
2748 # Reset possible stack dump if a blank line is found
2752 }
2754 # Check for git id commit length and improperly formed commit descriptions
2779 }
2801 }
2809 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2810 }
2811 }
2813 # Check for added, moved or deleted files
2823 }
2825 # Check for wrappage within a valid hunk of the file
2830 }
2832 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2843 }
2845 # Check if it's the start of a commit log
2846 # (not a header line and we haven't seen the patch filename)
2853 }
2855 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2856 # declined it, i.e defined some charset where it is missing.
2861 }
2867 }
2869 # Check for absolute kernel paths in commit message
2876 #
2879 }
2880 }
2881 }
2883 # Check for various typo / spelling mistakes
2897 }
2898 }
2899 }
2901 # ignore non-hunk lines and lines being removed
2904 #trailing whitespace
2911 }
2918 }
2921 }
2923 # Check for FSF mailing addresses.
2932 "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)
2933 }
2935 # check for Kconfig help text having a real description
2936 # Only applies when adding the entry originally, after that we do not have
2937 # sufficient context to determine whether it is indeed long enough.
2939 # 'choice' is usually the last thing on the line (though
2940 # Kconfig supports named choices), so use a word boundary
2941 # (\b) rather than a whitespace character (\s)
2963 }
2965 }
2972 # This only checks context lines in the patch
2973 # and so hopefully shouldn't trigger false
2974 # positives, even though some of these are
2975 # common words in help texts
2980 }
2982 }
2986 }
2987 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2988 }
2990 # check for MAINTAINERS entries that don't have the right form
2998 }
2999 }
3001 # discourage the use of boolean for type definition attributes of Kconfig options
3006 }
3016 };
3019 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3020 }
3022 # check for DT compatible documentation
3041 }
3048 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3049 }
3050 }
3051 }
3053 # check for using SPDX license tag at beginning of files
3067 }
3069 # check SPDX comment style for .[chsS] files
3075 }
3086 }
3087 }
3088 }
3089 }
3091 # check we are in a valid source file if not then ignore this hunk
3094 # check for using SPDX-License-Identifier on the wrong line number
3100 }
3102 # line length limit (with some exclusions)
3103 #
3104 # There are a few types of lines that may extend beyond $max_line_length:
3105 # logging functions like pr_info that end in a string
3106 # lines with a single string
3107 # #defines that are a single string
3108 # lines with an RFC3986 like URL
3109 #
3110 # There are 3 different line length message types:
3111 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3112 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3113 # LONG_LINE all other lines longer than $max_line_length
3114 #
3115 # if LONG_LINE is ignored, the other 2 types are also ignored
3116 #
3121 # Check the allowed long line types first
3123 # logging functions that end in a string that starts
3124 # before $max_line_length
3125 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3129 # lines with only strings (w/ possible termination)
3130 # #defines with only strings
3135 # More special cases
3140 # URL ($rawline is used in case the URL is in a comment)
3144 # Otherwise set the alternate message types
3146 # a comment starts before $max_line_length
3151 # a quoted string starts before $max_line_length
3155 }
3161 }
3162 }
3164 # check for adding lines without a newline.
3165 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3168 }
3170 # check we are in a valid source file C or perl if not then ignore this hunk
3173 # at the beginning of a line any tabs must come first and anything
3174 # more than 8 must use tabs.
3183 }
3184 }
3186 # check for space before tabs.
3196 }
3197 }
3199 # check for assignments on the start of a line
3203 }
3205 # check for && or || at the start of a line
3209 }
3211 # check indentation starts on a tab stop
3213 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3220 }
3221 }
3222 }
3224 # check multi-line statement indentation matches previous line
3226 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3249 }
3250 }
3251 }
3252 }
3254 # check for space after cast like "(int) foo" or "(struct foo) bar"
3255 # avoid checking a few false positives:
3256 # "sizeof(<type>)" or "__alignof__(<type>)"
3257 # function pointer declarations like "(*foo)(int) = bar;"
3258 # structure definitions like "(struct foo) { 0 };"
3259 # multiline macros that define functions
3260 # known attributes or the __attribute__ keyword
3268 }
3269 }
3271 # Block comment styles
3272 # Networking with an initial /*
3279 }
3281 # Block comments use * on subsequent lines
3289 }
3291 # Block comments use */ on trailing lines
3298 }
3300 # Block comment * alignment
3314 }
3321 }
3322 }
3324 # check for missing blank lines after struct/union declarations
3325 # with exceptions for various attributes and macros
3341 }
3342 }
3344 # check for multiple consecutive blank lines
3352 }
3355 }
3357 # check for missing blank lines after declarations
3359 # actual declarations
3361 # function pointer declarations
3363 # foo bar; where foo is some local typedef or #define
3365 # known declaration macros
3367 # for "else if" which can look like "$Ident $Ident"
3369 # other possible extensions of declaration lines
3371 # not starting a section or a macro "\" extended line
3373 # looks like a declaration
3375 # function pointer declarations
3377 # foo bar; where foo is some local typedef or #define
3379 # known declaration macros
3381 # start of struct or union or enum
3383 # start or end of block or continuation of declaration
3385 # bitfield continuation
3387 # other possible extensions of declaration lines
3389 # indentation of previous and current line are the same
3395 }
3396 }
3398 # check for spaces at the beginning of a line.
3399 # Exceptions:
3400 # 1) within comments
3401 # 2) indented preprocessor commands
3402 # 3) hanging labels
3409 }
3410 }
3412 # check we are in a valid C source file if not then ignore this hunk
3415 # check for unusual line ending [ or (
3419 }
3421 # check if this appears to be the start function declaration, save the name
3425 }
3427 # check if this appears to be the end of function declaration
3430 }
3432 # check indentation of any line with a bare else
3433 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3434 # if the previous line is a break or return and is indented 1 tab more...
3443 }
3444 }
3446 # check indentation of a line with a break;
3447 # if the previous line is a goto or return and is indented the same # of tabs
3453 }
3454 }
3456 # check for RCS/CVS revision markers
3460 }
3462 # check for old HOTPLUG __dev<foo> section markings
3466 }
3468 # Check for potential 'bare' types
3471 #print "LINE<$line>\n";
3479 #print "linenr<$linenr> <$stat>\n";
3480 # If this statement has no statement boundaries within
3481 # it there is no point in retrying a statement scan
3482 # until we hit end of it.
3485 #print "skip<$line_nr_next>\n";
3487 }
3489 # Find the real next line.
3495 }
3500 # Ignore goto labels.
3503 # Ignore functions being called
3508 # declarations always start with types
3509 } 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) {
3514 # definitions in global scope can only start with types
3517 }
3519 # any (foo ... *) is a pointer cast, and foo is a type
3522 }
3524 # Check for any sort of function declaration.
3525 # int foo(something bar, other baz);
3526 # void (*store_gdt)(x86_descr_ptr *);
3527 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3535 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3538 }
3539 }
3540 }
3542 }
3544 #
3545 # Checks which may be anchored in the context.
3546 #
3548 # Check for switch () and associated case and default
3549 # statements should be at the same indent.
3563 }
3564 }
3568 }
3569 }
3571 # if/while/etc brace do not go on next line, unless defining a do while loop,
3572 # or if that brace on the next line is for something else
3573 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3581 }
3592 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3595 }
3597 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3598 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3604 }
3608 {
3614 }
3615 }
3616 }
3618 # Check relative indent for conditionals and blocks.
3619 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3627 # remove inline comments
3631 # Find out how long the conditional actually is.
3635 # Make sure we remove the line prefixes as we have
3636 # none on the first line, and are going to readd them
3637 # where necessary.
3641 }
3643 # We want to check the first line inside the block
3644 # starting at the end of the conditional, so remove:
3645 # 1) any blank line termination
3646 # 2) any opening brace { on end of the line
3647 # 3) any do (...) {
3654 }
3658 }
3660 # Also ignore a loop construct at the end of a
3661 # preprocessor statement.
3665 }
3672 # If we see an #else/#elif then the code
3673 # is not linear.
3676 }
3678 # Ignore:
3679 # 1) blank lines, they should be at 0,
3680 # 2) preprocessor lines, and
3681 # 3) labels.
3689 }
3690 }
3691 }
3696 # Check if either of these lines are modified, else
3697 # this is not this patch's fault.
3701 }
3704 }
3706 #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";
3715 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3716 }
3717 }
3719 # Track the 'values' across context and added lines.
3729 }
3732 #ignore lines not being added
3735 # check for dereferences that span multiple lines
3745 }
3747 # check for declarations of signed or unsigned without int
3748 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3759 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3767 }
3768 }
3769 }
3771 # TEST: allow direct testing of the type matcher.
3779 }
3781 }
3782 # TEST: allow direct testing of the attribute matcher.
3790 }
3792 }
3794 # check for initialisation to aggregates open brace on the next line
3808 }
3809 }
3811 #
3812 # Checks which are anchored on the added line.
3813 #
3815 # check for malformed paths in #include statements (uses RAW line)
3821 }
3825 }
3826 }
3828 # no C99 // comments
3837 }
3838 }
3839 }
3840 # Remove C99 comments.
3844 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3845 # the whole statement.
3846 #print "APW <$lines[$realline_next - 1]>\n";
3852 # Handle definitions which produce identifiers with
3853 # a prefix:
3854 # XXX(foo);
3855 # EXPORT_SYMBOL(something_foo);
3859 #print "FOO C name<$name>\n";
3870 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3874 }
3875 }
3880 #print "FOO B <$lines[$linenr - 1]>\n";
3882 }
3887 }
3889 # check for global initialisers.
3895 }
3896 }
3897 # check for static initialisers.
3904 }
3905 }
3907 # check for misordered declarations of char/short/int/long with signed/unsigned
3911 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3912 }
3914 # check for unnecessary <signed> int declarations of short/long/long long
3931 }
3932 }
3934 # check for static const char * arrays.
3939 }
3941 # check for initialized const char arrays that should be static const
3942 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
3947 }
3948 }
3950 # check for static char foo[] = "bar" declarations.
3955 }
3957 # check for const <foo> const where <foo> is not a pointer or array type
3966 }
3967 }
3969 # check for non-global char *foo[] = {"bar", ...} declarations.
3974 }
3976 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3979 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3985 }
3986 }
3987 }
3989 # check for function declarations without arguments like "int foo()"
3995 }
3996 }
3998 # check for new typedefs, only function parameters and sparse annotations
3999 # make sense.
4007 }
4009 # * goes on variable not on type
4010 # (char*[ const])
4012 #print "AA<$1>\n";
4015 # Should start with a space.
4017 # Should not end with a space.
4019 # '*'s should not have spaces between.
4021 }
4023 ## print "1: from<$from> to<$to> ident<$ident>\n";
4033 }
4034 }
4035 }
4037 #print "BB<$1>\n";
4040 # Should start with a space.
4042 # Should not end with a space.
4044 # '*'s should not have spaces between.
4046 }
4047 # Modifiers should have spaces.
4050 ## print "2: from<$from> to<$to> ident<$ident>\n";
4061 }
4062 }
4063 }
4065 # avoid BUG() or BUG_ON()
4070 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4071 }
4073 # avoid LINUX_VERSION_CODE
4076 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4077 }
4079 # check for uses of printk_ratelimit
4083 }
4085 # printk should use KERN_* levels
4089 }
4098 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
4099 }
4107 }
4108 }
4117 }
4119 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4120 # number of false positives, but assembly files are not checked, so at
4121 # least the arch entry code will not trigger this warning.
4125 }
4127 # function brace can't be on same line, except for #defines of do while,
4128 # or if closed on same line
4145 }
4146 }
4147 }
4149 # open braces for enum, union and struct go on the same line.
4163 }
4164 }
4165 }
4167 # missing space after union, struct or enum definition
4174 }
4175 }
4177 # Function pointer declarations
4178 # check spacing between type, funcptr, and args
4179 # canonical declaration is "type (*funcptr)(args...)"
4188 # the $Declare variable will capture all spaces after the type
4189 # so check it for a missing trailing missing space but pointer return types
4190 # don't need a space so don't warn for those.
4195 }
4200 }
4202 # unnecessary space "type (*funcptr)(args...)"
4203 # This test is not currently implemented because these declarations are
4204 # equivalent to
4205 # int foo(int bar, ...)
4206 # and this is form shouldn't/doesn't generate a checkpatch warning.
4207 #
4208 # elsif ($declare =~ /\s{2,}$/) {
4209 # WARN("SPACING",
4210 # "Multiple spaces after return type\n" . $herecurr);
4211 # }
4213 # unnecessary space "type ( *funcptr)(args...)"
4218 }
4220 # unnecessary space "type (* funcptr)(args...)"
4225 }
4227 # unnecessary space "type (*funcptr )(args...)"
4232 }
4234 # unnecessary space "type (*funcptr) (args...)"
4239 }
4243 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4244 }
4245 }
4247 # check for spacing round square brackets; allowed:
4248 # 1. with a type on the left -- int [] a;
4249 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4250 # 3. inside a curly brace -- = { [0...10] = 5 }
4261 }
4262 }
4263 }
4265 # check for spaces between functions and their parentheses.
4271 # Ignore those directives where spaces _are_ permitted.
4277 {
4278 # cpp #define statements have non-optional spaces, ie
4279 # if there is a space between the name and the open
4280 # parenthesis it is simply not a parameter group.
4283 # cpp #elif statement condition may start with a (
4286 # If this whole things ends with a type its most
4287 # likely a typedef for a function.
4296 }
4297 }
4298 }
4300 # Check operator spacing.
4306 <<=|>>=|<=|>=|==|!=|
4308 =>|->|<<|>>|<|>|=|!|~|
4314 ## print("element count: <" . $#elements . ">\n");
4315 ## foreach my $el (@elements) {
4316 ## print("el: <$el>\n");
4317 ## }
4325 }
4336 ## print("n: <$n> good: <$good>\n");
4340 # Pick up the preceding and succeeding characters.
4345 }
4368 }
4377 # Pull out the value of this operator.
4380 # Get the full operator variant.
4383 # Ignore operators passed as parameters.
4387 # # Ignore comments
4388 # } elsif ($op =~ /^$;+$/) {
4390 # ; should have either the end of line or a space or \ after it
4398 }
4399 }
4401 # // is a comment
4404 # : when part of a bitfield
4406 # skip the bitfield test for now
4408 # No spaces for:
4409 # ->
4417 }
4419 }
4420 }
4422 # , must not have a space before and must have a space on the right.
4431 }
4432 }
4439 }
4440 }
4446 }
4449 }
4450 }
4452 # '*' as part of a type definition -- reported already.
4454 #warn "'*' is part of type\n";
4456 # unary operators should have a space before and
4457 # none after. May be left adjacent to another
4458 # unary operator, or a cast
4468 }
4469 }
4470 }
4472 # A unary '*' may be const
4480 }
4482 }
4483 }
4485 # unary ++ and unary -- are allowed no space on one side.
4492 }
4493 }
4500 }
4501 }
4508 }
4510 }
4511 }
4513 # << and >> may either have or not have spaces both sides
4519 {
4527 }
4533 }
4534 }
4541 }
4543 }
4544 }
4546 # A colon needs no spaces before when it is
4547 # terminating a case value or a label.
4554 }
4555 }
4557 # All the others need spaces both sides.
4561 # Ignore email addresses <foo@bar>
4566 {
4568 }
4570 # for asm volatile statements
4571 # ignore a colon with another
4572 # colon immediately before or after
4576 }
4578 # messages are ERROR, but ?: are CHK
4588 }
4590 }
4591 }
4592 }
4595 ## print("n: <$n> GOOD: <$good>\n");
4598 }
4602 }
4606 }
4609 }
4611 # check for whitespace before a non-naked semicolon
4618 }
4619 }
4621 # check for multiple assignments
4625 }
4627 ## # check for multiple declarations, allowing for a function declaration
4628 ## # continuation.
4629 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4630 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4631 ##
4632 ## # Remove any bracketed sections to ensure we do not
4633 ## # falsly report the parameters of functions.
4634 ## my $ln = $line;
4635 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4636 ## }
4637 ## if ($ln =~ /,/) {
4638 ## WARN("MULTIPLE_DECLARATION",
4639 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4640 ## }
4641 ## }
4643 #need space before brace following if, while, etc
4650 }
4651 }
4653 ## # check for blank lines before declarations
4654 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4655 ## $prevrawline =~ /^.\s*$/) {
4656 ## WARN("SPACING",
4657 ## "No blank lines before declarations\n" . $hereprev);
4658 ## }
4659 ##
4661 # closing brace should have a space following it when it has anything
4662 # on the line
4669 }
4670 }
4672 # check spacing on square brackets
4679 }
4680 }
4687 }
4688 }
4690 # check spacing on parentheses
4698 }
4699 }
4708 }
4709 }
4711 # check unnecessary parentheses around addressof/dereference single $Lvals
4712 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4720 }
4721 }
4723 # check for unnecessary parentheses around function pointer uses
4724 # ie: (foo->bar)(); should be foo->bar();
4725 # but not "if (foo->bar) (" to avoid some false positives
4734 }
4735 }
4737 # check for unnecessary parentheses around comparisons in if uses
4738 # when !drivers/staging or command-line uses --strict
4745 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4747 # avoid parentheses around potential macro args
4756 }
4757 }
4760 }
4761 }
4763 #goto labels aren't indented, allow a single space however
4771 }
4772 }
4774 # return is not a function
4784 }
4788 }
4789 }
4791 # unnecessary return in a void function
4792 # at end-of-function, with the previous line a single leading tab, then return;
4793 # and the line before that not a goto label target like "out:"
4801 }
4803 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4809 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4814 }
4815 }
4817 # comparisons with a constant or upper case identifier on the left
4818 # avoid cases like "foo + BAR < baz"
4819 # only fix matches surrounded by parentheses to avoid incorrect
4820 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4841 }
4843 }
4844 }
4846 # Return of what appears to be an errno should normally be negative
4852 }
4853 }
4855 # Need a space before open parenthesis after if, while etc
4862 }
4863 }
4865 # Check for illegal assignment in if conditional -- and check for trailing
4866 # statements after the conditional.
4874 ##print "stat<$stat> stat_next<$stat_next>\n";
4877 # If the statement carries leading newlines,
4878 # then count those as offsets.
4886 }
4887 }
4896 }
4898 # Find out what is on the end of the line after the
4899 # conditional.
4905 {
4906 # Find out how long the conditional actually is.
4915 }
4919 }
4920 }
4922 # Check for bitwise tests written as boolean
4928 |
4933 {
4936 }
4938 # if and else should not have general statements after it
4945 }
4946 }
4947 # if should not continue a brace
4952 }
4953 # case and default should not have general statements after them
4959 {
4962 }
4964 # Check for }<nl>else {, these must be at the same
4965 # indent level to be relevant to each other.
4977 }
4981 }
4982 }
4988 # Find out what is on the end of the line after the
4989 # conditional.
5005 }
5006 }
5007 }
5009 #Specific variable tests
5013 #CamelCase
5016 #Ignore Page<foo> variants
5018 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
5020 #Ignore some three character SI units explicitly, like MiB and KHz
5026 seed_camelcase_includes();
5030 }
5031 }
5036 }
5037 }
5038 }
5039 }
5041 #no spaces allowed after \ in define
5047 }
5048 }
5050 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5051 # itself <asm/foo.h> (uses RAW line)
5058 {
5067 }
5068 }
5069 }
5070 }
5072 # multi-statement macros should be enclosed in a do while loop, grab the
5073 # first statement and ensure its the whole macro if its not enclosed
5074 # in a known good container
5086 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5087 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5102 }
5109 # Flatten any parentheses and braces
5113 {
5114 }
5116 # Flatten any obvious string concatentation.
5119 {
5120 }
5122 # Make asm volatile uses seem like a generic function
5127 module_param_named|
5128 MODULE_PARM_DESC|
5129 DECLARE_PER_CPU|
5130 DEFINE_PER_CPU|
5131 __typeof__\(|
5132 union|
5133 struct|
5138 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5147 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5152 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5158 {
5161 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5168 }
5170 }
5172 # Make $define_stmt single line, comment-free, etc
5183 }
5184 }
5189 # check if any macro arguments are reused (ignore '...' and 'type')
5194 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5201 }
5202 # check if any macro arguments may have other precedence issues
5208 }
5209 }
5211 # check for macros with flow control, but without ## concatenation
5212 # ## concatenation is commonly a macro that defines a function so ignore those
5219 }
5221 # check for line continuations outside of #defines, preprocessor #, and asm
5230 }
5231 }
5233 # do {} while (0) macro tests:
5234 # single-statement macros do not need to be enclosed in do while (0) loop,
5235 # macro should not end with a semicolon
5250 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5262 }
5266 }
5274 }
5275 }
5277 # check for redundant bracing round if etc
5281 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5282 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5292 # If the condition carries leading newlines, then count those as offsets.
5297 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5299 # We have looked at and allowed this specific line.
5309 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5311 #print "APW: ALLOWED: cond<$cond>\n";
5313 }
5315 #print "APW: ALLOWED: block<$block>\n";
5317 }
5319 #print "APW: ALLOWED: lines block<$block>\n";
5321 }
5323 }
5328 }
5336 }
5337 }
5338 }
5339 }
5344 # Check the pre-context.
5346 #print "APW: ALLOWED: pre<$1>\n";
5348 }
5353 # Check the condition.
5355 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5358 }
5360 #print "APW: ALLOWED: cond<$cond>\n";
5362 }
5364 #print "APW: ALLOWED: block<$block>\n";
5366 }
5368 #print "APW: ALLOWED: lines block<$block>\n";
5370 }
5371 # Check the post-context.
5376 }
5378 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5380 }
5381 }
5388 }
5389 }
5391 # check for single line unbalanced braces
5395 }
5397 # check for unnecessary blank lines around braces
5403 }
5404 }
5410 }
5411 }
5413 # no volatiles please
5417 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5418 }
5420 # Check for user-visible strings broken across lines, which breaks the ability
5421 # to grep for the string. Make exceptions when the previous string ends in a
5422 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5423 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5436 }
5448 }
5450 }
5451 }
5453 # check for missing a space in a string concatenation
5457 }
5459 # check for an embedded function name in a string when the function is known
5460 # This does not work very well for -f --file checking as it depends on patch
5461 # context providing the function name or a single line form for in-file
5462 # function declarations
5468 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5469 }
5471 # check for spaces before a quoted newline
5477 }
5479 }
5481 # concatenated string without spaces between elements
5490 }
5491 }
5492 }
5494 # uncoalesced string fragments
5502 }
5503 }
5504 }
5506 # check for non-standard and hex prefixed decimal printf formats
5512 # check for %L
5517 }
5518 # check for %Z
5523 }
5524 # check for 0x<decimal>
5528 }
5529 }
5531 # check for line continuations in quoted strings with odd counts of "
5535 }
5537 # warn about #if 0
5541 }
5543 # warn about #if 1
5547 }
5549 # check for needless "if (<foo>) fn(<foo>)" uses
5553 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5565 }
5570 }
5573 }
5577 }
5578 }
5579 }
5580 }
5582 # check for unnecessary "Out of Memory" messages
5591 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5593 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5597 }
5598 }
5600 # check for logging functions with KERN_<LEVEL>
5608 }
5609 }
5611 # check for logging continuations
5615 }
5617 # check for mask then right shift without a parentheses
5623 }
5625 # check for pointer comparisons to NULL
5635 }
5636 }
5637 }
5639 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5642 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5652 $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;
5653 }
5654 }
5655 }
5657 # check for $InitAttributeData (ie: __initdata) with const
5668 }
5669 }
5671 # check for $InitAttributeConst (ie: __initconst) without const
5683 }
5684 }
5686 # check for __read_mostly with const non-pointer (should just be const)
5693 }
5694 }
5696 # don't use __constant_<foo> functions outside of include/uapi/
5698 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5706 }
5707 }
5709 # prefer usleep_range over udelay
5712 # ignore udelay's < 10, however
5715 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5716 }
5720 }
5721 }
5723 # warn about unexpectedly long msleep's
5727 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5728 }
5729 }
5731 # check for comparisons of jiffies
5734 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5735 }
5737 # check for comparisons of get_jiffies_64()
5740 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5741 }
5743 # warn about #ifdefs in C files
5744 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5745 # print "#ifdef in C files should be avoided\n";
5746 # print "$herecurr";
5747 # $clean = 0;
5748 # }
5750 # warn about spacing in #ifdefs
5757 }
5759 }
5761 # check for spinlock_t definitions without a comment.
5768 }
5769 }
5770 # check for memory barriers without a comment.
5773 mb|
5774 rmb|
5775 wmb|
5776 read_barrier_depends
5779 mb__before_atomic|
5780 mb__after_atomic|
5781 store_release|
5782 load_acquire|
5783 store_mb|
5796 }
5797 }
5807 }
5809 # check for waitqueue_active without a comment.
5814 }
5815 }
5817 # check for smp_read_barrier_depends and read_barrier_depends
5821 }
5823 # check of hardware specific defines
5824 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5827 }
5829 # check that the storage class is not after a type
5833 }
5834 # Check that the storage class is at the beginning of a declaration
5841 }
5843 # check the location of the inline attribute, that it is between
5844 # storage class and type.
5849 }
5851 # Check for __inline__ and __inline, prefer inline
5859 }
5860 }
5862 # Check for __attribute__ packed, prefer __packed
5867 }
5869 # Check for __attribute__ aligned, prefer __aligned
5874 }
5876 # Check for __attribute__ format(printf, prefer __printf
5880 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5882 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5884 }
5885 }
5887 # Check for __attribute__ format(scanf, prefer __scanf
5891 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5893 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5894 }
5895 }
5897 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5899 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5904 }
5906 # check for c99 types like uint8_t used outside of uapi/ and tools/
5921 }
5922 }
5923 }
5925 # check for cast of C90 native int or longer types constants
5940 }
5942 }
5943 }
5945 # check for sizeof(&)
5949 }
5951 # check for sizeof without parenthesis
5956 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5957 }
5958 }
5960 # check for struct spinlock declarations
5964 }
5966 # check for seq_printf uses that could be seq_puts
5975 }
5976 }
5977 }
5979 # check for vsprintf extension %p<foo> misuses
6001 }
6005 }
6007 "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");
6008 }
6009 }
6018 }
6022 }
6023 }
6024 }
6026 # Check for misused memsets
6041 }
6042 }
6044 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6045 # if ($perl_version_ok &&
6046 # defined $stat &&
6047 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6048 # if (WARN("PREFER_ETHER_ADDR_COPY",
6049 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6050 # $fix) {
6051 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6052 # }
6053 # }
6055 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6056 # if ($perl_version_ok &&
6057 # defined $stat &&
6058 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6059 # WARN("PREFER_ETHER_ADDR_EQUAL",
6060 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6061 # }
6063 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6064 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6065 # if ($perl_version_ok &&
6066 # defined $stat &&
6067 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6068 #
6069 # my $ms_val = $7;
6070 #
6071 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6072 # if (WARN("PREFER_ETH_ZERO_ADDR",
6073 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6074 # $fix) {
6075 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6076 # }
6077 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6078 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6079 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6080 # $fix) {
6081 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6082 # }
6083 # }
6084 # }
6086 # typecasts on min/max could be min_t/max_t
6104 }
6107 }
6108 }
6110 # check usleep_range arguments
6118 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6122 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6123 }
6124 }
6126 # check for naked sscanf
6138 }
6140 # check for simple sscanf that should be kstrto<foo>
6154 }
6155 }
6156 }
6158 # check for new externs in .h files.
6165 }
6166 }
6168 # check for new externs in .c files.
6171 {
6178 }
6181 {
6184 }
6189 }
6193 {
6196 }
6198 # check for function declarations that have arguments without identifier names
6200 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6208 }
6209 }
6210 }
6212 # check for function definitions
6218 # check for multiline function definition with misplaced open brace
6228 }
6232 }
6233 }
6235 # checks for new __setup's
6241 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6242 }
6243 }
6245 # check for pointless casting of alloc functions
6248 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6249 }
6251 # alloc style
6252 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6254 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6257 }
6259 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6262 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6273 }
6283 $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;
6284 }
6285 }
6286 }
6288 # check for krealloc arg reuse
6294 }
6296 # check for alloc argument mismatch
6300 }
6302 # check for multiple semicolons
6308 }
6309 }
6311 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6320 }
6321 }
6323 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6324 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6330 }
6331 }
6333 # check for case / default statements not preceded by break/fallthrough/switch
6350 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6351 }
6355 }
6356 }
6358 # check for switch/default statements without a break;
6367 }
6369 # check for gcc specific __FUNCTION__
6375 }
6376 }
6378 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6382 }
6384 # check for use of yield()
6388 }
6390 # check for comparisons against true and false
6406 }
6411 ## maybe suggesting a correct construct would better
6412 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6414 }
6415 }
6417 # check for semaphores initialized locked
6421 }
6423 # recommend kstrto* over simple_strto* and strict_strto*
6427 }
6429 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6432 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6433 }
6435 # check for spin_is_locked(), suggest lockdep instead
6438 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6439 }
6441 # check for deprecated apis
6447 }
6449 # check for various structs that are normally const (ops, kgdb, device_tree)
6450 # and avoid what seem like struct definitions 'struct foo {'
6455 }
6457 # use of NR_CPUS is usually wrong
6458 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6465 {
6467 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6468 }
6470 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6474 }
6476 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6481 }
6483 # whine mightly about in_atomic
6491 }
6492 }
6494 # check for mutex_trylock_recursive usage
6498 }
6500 # check for lockdep_set_novalidate_class
6508 }
6509 }
6514 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6515 }
6517 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6518 # and whether or not function naming is typical and if
6519 # DEVICE_ATTR permissions uses are unusual too
6522 $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*\)/) {
6534 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6535 }
6542 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6543 }
6550 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6551 }
6562 }
6565 }
6571 }
6572 }
6574 # Mode permission misuses where it seems decimal should be octal
6575 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6576 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6577 # specific definition of not visible in sysfs.
6578 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6579 # use the default permissions
6595 }
6605 }
6608 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6609 }
6610 }
6611 }
6612 }
6614 # check for uses of S_<PERMS> that could be octal for readability
6619 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6622 }
6623 }
6625 # validate content of MODULE_LICENSE against list from include/linux/module.h
6629 GPL|
6630 GPL\ v2|
6635 Proprietary
6640 }
6641 }
6643 # check for sysctl duplicate constants
6646 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6647 }
6648 }
6650 # If we have no input at all, then there is nothing to report on
6651 # so just keep quiet.
6654 }
6656 # In mailback mode only produce a report in the negative, for
6657 # things that appear to be patches.
6660 }
6662 # This is not a patch, and we are are in 'no-patch' mode so
6663 # just keep quiet.
6666 }
6671 }
6679 }
6680 }
6688 }
6691 # If there were any defects found and not already fixing them
6697 EOM
6698 }
6699 # If there were whitespace errors which cleanpatch can fix
6700 # then suggest that.
6707 EOM
6708 }
6709 }
6729 }
6732 }
6733 }
6741 Do _NOT_ trust the results written to this file.
6744 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6746 EOM
6747 }
6748 }
6756 }
6757 }
6759 }