| blob | 447857ffaf6be157841f8b0283d8ac67cb37dc5e |
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>
72 Options:
77 --emacs emacs compile window format
78 --terse one line per report
81 single git commit with:
85 multiple git commits with:
89 git merges are ignored
104 is all off)
106 literally
109 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
110 with potential errors corrected to the preferred
111 checkpatch style
116 runtime errors.
119 --codespellfile Use this codespell dictionary
120 --typedefsfile Read additional types from this file
126 EOM
129 }
134 }
150 # Also catch when type or level is passed through a variable
151 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
153 }
158 }
161 }
183 }
184 }
187 }
189 # Perl's Getopt::Long allows options to take optional arguments after a space.
190 # Prevent --color by itself from consuming other arguments
194 }
195 }
197 GetOptions(
247 }
248 }
250 #if no filenames are given, push '-' to read patch from stdin
253 }
265 }
281 }
282 }
291 }
293 }
294 }
304 ## no critic
307 }
314 }
320 }
327 }
328 }
333 }
334 }
344 __user|
345 __kernel|
346 __force|
347 __iomem|
348 __must_check|
349 __init_refok|
350 __kprobes|
351 __ref|
352 __rcu|
353 __private
361 # Notes to $Attribute:
362 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
364 const|
365 __percpu|
366 __nocast|
367 __safe|
368 __bitwise|
369 __packed__|
370 __packed2__|
371 __naked|
372 __maybe_unused|
373 __always_unused|
374 __noreturn|
375 __used|
376 __cold|
377 __pure|
378 __noclone|
379 __deprecated|
380 __read_mostly|
381 __kprobes|
383 ____cacheline_aligned|
384 ____cacheline_aligned_in_smp|
385 ____cacheline_internodealigned_in_smp|
386 __weak
408 <=|>=|==|!=|
409 =>|->|<<|>>|<|>|!|~|
443 )};
446 atomic_t
447 )};
452 )};
458 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
459 TP_printk|
461 panic|
464 )};
473 To:|
474 Cc:
475 )};
494 );
517 );
538 )};
545 );
549 );
556 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
563 );
565 #Create a search pattern for all these functions to speed up a loop below
570 }
574 S_IWUGO |
575 S_IWOTH |
576 S_IRWXUGO |
577 S_IALLUGO |
598 );
600 #Create a search pattern for all these strings to speed up a loop below
605 }
632 }
636 }
639 irq|
640 memory|
642 reboot
643 )};
644 # memory.h: ARM has a custom one
646 # Load common spelling mistakes and build regular expression list.
663 }
667 }
686 }
690 }
691 }
710 }
714 }
717 }
720 }
730 }
749 )
756 )
765 )
769 $NonptrType
774 $NonptrTypeMisordered
780 }
781 build_types();
785 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
786 # requires at least perl version v5.10.0
787 # Any use must be runtime checked with $^V
798 )};
807 }
812 }
836 }
837 }
838 }
845 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
848 }
872 }
874 }
882 }
886 }
891 }
895 }
903 }
905 }
906 }
920 # Maybe one day convert this block of bash into something that returns
921 # all matching commit ids, but it's very slow...
922 #
923 # echo "checking commits $1..."
924 # git rev-list --remotes | grep -i "^$1" |
925 # while read line ; do
926 # git log --format='%H %s' -1 $line |
927 # echo "commit $(cut -c 1-12,41-)"
928 # done
929 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
934 }
937 }
948 # If input is git commits, extract all commits from the commit expressions.
949 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
962 }
971 }
972 }
975 }
991 }
998 }
1002 }
1009 }
1013 }
1022 build_types();
1023 }
1034 EOM
1035 }
1041 EOM
1042 }
1043 }
1054 );
1059 }
1060 }
1062 }
1085 # If there's a name left after stripping spaces and
1086 # leading quotes, and the address doesn't have both
1087 # leading and trailing angle brackets, the address
1088 # is invalid. ie:
1089 # "joe smith joe@smith.com" bad
1090 # "joe smith <joe@smith.com" bad
1095 }
1096 }
1106 }
1109 }
1123 }
1129 }
1132 }
1140 }
1141 }
1144 }
1152 }
1153 }
1156 }
1169 }
1171 }
1174 }
1177 }
1181 }
1186 # Drop the diff line leader and expand tabs
1190 # Pick the indent from the front of the line.
1194 }
1205 }
1206 }
1217 # Always copy over the diff marker.
1223 # Comments we are whacking completely including the begin
1224 # and end, all to $;.
1231 }
1237 }
1244 }
1246 # A \ in a string means ignore the next character.
1252 }
1253 # Regular quotes.
1262 }
1263 }
1265 #print "c<$c> SQ<$sanitise_quote>\n";
1274 }
1275 }
1279 }
1281 # The pathname on a #include may be surrounded by '<' and '>'.
1286 # The whole of a #error is a string.
1290 }
1295 }
1298 }
1306 }
1329 #warn "CSB: blk<$blk> remain<$remain>\n";
1330 # If we are about to drop off the end, pull in more
1331 # context.
1342 }
1343 # Bail if there is no further context.
1344 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1347 }
1351 }
1352 }
1357 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1359 # Handle nested #if/#else.
1366 }
1368 # Statement ends at the ';' or a close '}' at the
1369 # outermost level.
1372 }
1374 # An else is really a conditional as long as its not else if
1381 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1382 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1383 }
1388 }
1396 #warn "CSB: mark coff<$coff>\n";
1397 }
1398 }
1402 }
1410 }
1412 }
1413 }
1414 # Preprocessor commands end at the newline unless escaped.
1420 }
1422 }
1423 # We are truly at the end, so shuffle to the next line.
1428 }
1433 #warn "STATEMENT<$statement>\n";
1434 #warn "CONDITION<$condition>\n";
1436 #print "coff<$coff> soff<$off> loff<$loff>\n";
1440 }
1445 # Strip the diff line prefixes and rip blank lines at start and end.
1453 }
1461 }
1482 }
1483 }
1491 # Grab the first conditional/block pair.
1494 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1498 }
1500 # Pull in the following conditional/block pairs and see if they
1501 # could continue the statement.
1505 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1507 #print "C: push\n";
1509 }
1512 }
1531 # Handle nested #if/#else.
1538 }
1541 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1545 }
1552 }
1553 }
1557 }
1560 }
1563 }
1569 }
1575 }
1581 }
1586 }
1591 }
1596 # Catch a comment on the end of the line itself.
1600 # Look through the context and try and figure out if there is a
1601 # comment.
1606 #warn " $line\n";
1609 }
1612 }
1615 }
1619 }
1620 }
1624 }
1629 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1630 ##print "CMMT: $cmt\n";
1633 }
1646 }
1649 }
1657 }
1660 }
1668 }
1671 }
1683 }
1684 }
1688 }
1700 }
1720 }
1741 }
1770 # Assume all arms of the conditional end as this
1771 # one does, and continue as if the #endif was not here.
1788 }
1819 }
1831 }
1864 }
1879 }
1888 }
1892 }
1896 }
1897 }
1900 }
1909 DEFINE_\S+
1910 )$|
1914 case|
1918 \#|
1919 \#\#|
1925 # Check for modifiers.
1936 }
1937 }
1942 }
1943 build_types();
1946 }
1947 }
1959 }
1967 }
1976 }
1977 }
1982 }
1990 }
1996 }
2000 }
2011 }
2012 }
2039 }
2045 }
2052 }
2057 }
2060 }
2063 }
2071 };
2073 }
2081 };
2084 }
2093 }
2095 }
2103 }
2105 }
2113 }
2115 }
2121 ##print "absolute<$absolute>\n";
2123 # See if any suffix of this path is a path within the tree.
2126 ##print "file<$file>\n";
2128 }
2129 }
2132 }
2134 # It is, so see if the prefix is acceptable.
2138 ##print "prefix<$prefix>\n";
2142 }
2143 }
2151 }
2159 }
2167 }
2175 }
2184 #convert leading spaces to tabs
2186 #Remove spaces before a tab
2190 }
2204 }
2216 }
2217 }
2220 }
2257 # Trace the real file/line as we go.
2270 # suppression flags
2278 # Pre-scan the patch sanitizing the lines.
2279 # Pre-scan the patch looking for any __setup documentation.
2280 #
2288 sanitise_line_reset();
2300 }
2301 #next;
2302 }
2309 }
2312 # Guestimate if this is a continuing comment. Run
2313 # the context looking for a comment "edge". If this
2314 # edge is a close comment then we must be in a comment
2315 # at context start.
2322 #print "RAW<$rawlines[$ln - 1]>\n";
2328 }
2329 }
2332 }
2334 # Guestimate if this is a continuing comment. If this
2335 # is the start of a diff block and this line starts
2336 # ' *' then it is very likely a comment.
2339 {
2341 }
2343 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2347 # Standardise the strings and chars within the input to
2348 # simplify matching -- only bother with positive lines.
2350 }
2357 }
2359 #print "==>$rawline\n";
2360 #print "-->$line\n";
2364 }
2365 }
2380 # check if it's a mode change, rename or start of a patch
2386 }
2388 #extract the line range in the file after the patch is applied
2399 }
2400 annotate_reset();
2411 }
2414 # track the line number as we move through the hunk, note that
2415 # new versions of GNU diff omit the leading space on completely
2416 # blank context lines so we need to count that too.
2421 # Measure the line length and indent.
2424 # Track the previous line.
2429 #warn "line<$line>\n";
2433 }
2441 # extract the filename as it passes
2457 }
2461 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2462 }
2464 }
2466 #make up the handle for any error we report on this line
2474 }
2475 }
2480 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2481 }
2486 }
2489 }
2499 # Check if the commit log has what seems like a diff which can confuse patch
2508 }
2510 # Check for incorrect file permissions
2517 }
2518 }
2520 # Check the patch for a signoff:
2524 }
2526 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2527 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2530 }
2532 # Check signature styles
2544 }
2551 }
2552 }
2559 }
2561 }
2568 }
2569 }
2580 # Don't force email to have quotes
2581 # Allow just an angle bracketed address
2587 }
2588 }
2590 # Check for duplicate signatures
2599 }
2600 }
2602 # Check email subject for common tools that don't need to be mentioned
2607 }
2609 # Check for unwanted Gerrit info
2613 }
2615 # Check if the commit log is in a possible stack dump
2619 # timestamp
2621 # stack dump address
2623 }
2625 # Check for line lengths > 75 in commit log, warn once
2629 # file delta changes
2631 # filename then :
2633 # A Fixes: or Link: line
2638 }
2640 # Reset possible stack dump if a blank line is found
2644 }
2646 # Check for git id commit length and improperly formed commit descriptions
2671 }
2693 }
2701 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2702 }
2703 }
2705 # Check for added, moved or deleted files
2715 }
2717 # Check for wrappage within a valid hunk of the file
2722 }
2724 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2735 }
2737 # Check if it's the start of a commit log
2738 # (not a header line and we haven't seen the patch filename)
2745 }
2747 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2748 # declined it, i.e defined some charset where it is missing.
2753 }
2759 }
2761 # Check for absolute kernel paths in commit message
2768 #
2771 }
2772 }
2773 }
2775 # Check for various typo / spelling mistakes
2789 }
2790 }
2791 }
2793 # ignore non-hunk lines and lines being removed
2796 #trailing whitespace
2803 }
2810 }
2813 }
2815 # Check for FSF mailing addresses.
2824 "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)
2825 }
2827 # check for Kconfig help text having a real description
2828 # Only applies when adding the entry originally, after that we do not have
2829 # sufficient context to determine whether it is indeed long enough.
2831 # 'choice' is usually the last thing on the line (though
2832 # Kconfig supports named choices), so use a word boundary
2833 # (\b) rather than a whitespace character (\s)
2855 }
2857 }
2864 # This only checks context lines in the patch
2865 # and so hopefully shouldn't trigger false
2866 # positives, even though some of these are
2867 # common words in help texts
2872 }
2874 }
2878 }
2879 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2880 }
2882 # check for MAINTAINERS entries that don't have the right form
2890 }
2891 }
2893 # discourage the use of boolean for type definition attributes of Kconfig options
2898 }
2908 };
2911 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2912 }
2914 # check for DT compatible documentation
2933 }
2940 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2941 }
2942 }
2943 }
2945 # check for using SPDX license tag at beginning of files
2959 }
2965 }
2966 }
2967 }
2969 # check we are in a valid source file if not then ignore this hunk
2972 # line length limit (with some exclusions)
2973 #
2974 # There are a few types of lines that may extend beyond $max_line_length:
2975 # logging functions like pr_info that end in a string
2976 # lines with a single string
2977 # #defines that are a single string
2978 # lines with an RFC3986 like URL
2979 #
2980 # There are 3 different line length message types:
2981 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
2982 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2983 # LONG_LINE all other lines longer than $max_line_length
2984 #
2985 # if LONG_LINE is ignored, the other 2 types are also ignored
2986 #
2991 # Check the allowed long line types first
2993 # logging functions that end in a string that starts
2994 # before $max_line_length
2995 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2999 # lines with only strings (w/ possible termination)
3000 # #defines with only strings
3005 # More special cases
3010 # URL ($rawline is used in case the URL is in a comment)
3014 # Otherwise set the alternate message types
3016 # a comment starts before $max_line_length
3021 # a quoted string starts before $max_line_length
3025 }
3031 }
3032 }
3034 # check for adding lines without a newline.
3035 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3038 }
3040 # check we are in a valid source file C or perl if not then ignore this hunk
3043 # at the beginning of a line any tabs must come first and anything
3044 # more than 8 must use tabs.
3053 }
3054 }
3056 # check for space before tabs.
3066 }
3067 }
3069 # check for assignments on the start of a line
3073 }
3075 # check for && or || at the start of a line
3079 }
3081 # check indentation starts on a tab stop
3083 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3090 }
3091 }
3092 }
3094 # check multi-line statement indentation matches previous line
3096 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3119 }
3120 }
3121 }
3122 }
3124 # check for space after cast like "(int) foo" or "(struct foo) bar"
3125 # avoid checking a few false positives:
3126 # "sizeof(<type>)" or "__alignof__(<type>)"
3127 # function pointer declarations like "(*foo)(int) = bar;"
3128 # structure definitions like "(struct foo) { 0 };"
3129 # multiline macros that define functions
3130 # known attributes or the __attribute__ keyword
3138 }
3139 }
3141 # Block comment styles
3142 # Networking with an initial /*
3149 }
3151 # Block comments use * on subsequent lines
3159 }
3161 # Block comments use */ on trailing lines
3168 }
3170 # Block comment * alignment
3184 }
3191 }
3192 }
3194 # check for missing blank lines after struct/union declarations
3195 # with exceptions for various attributes and macros
3211 }
3212 }
3214 # check for multiple consecutive blank lines
3222 }
3225 }
3227 # check for missing blank lines after declarations
3229 # actual declarations
3231 # function pointer declarations
3233 # foo bar; where foo is some local typedef or #define
3235 # known declaration macros
3237 # for "else if" which can look like "$Ident $Ident"
3239 # other possible extensions of declaration lines
3241 # not starting a section or a macro "\" extended line
3243 # looks like a declaration
3245 # function pointer declarations
3247 # foo bar; where foo is some local typedef or #define
3249 # known declaration macros
3251 # start of struct or union or enum
3253 # start or end of block or continuation of declaration
3255 # bitfield continuation
3257 # other possible extensions of declaration lines
3259 # indentation of previous and current line are the same
3265 }
3266 }
3268 # check for spaces at the beginning of a line.
3269 # Exceptions:
3270 # 1) within comments
3271 # 2) indented preprocessor commands
3272 # 3) hanging labels
3279 }
3280 }
3282 # check we are in a valid C source file if not then ignore this hunk
3285 # check for unusual line ending [ or (
3289 }
3291 # check if this appears to be the start function declaration, save the name
3295 }
3297 # check if this appears to be the end of function declaration
3300 }
3302 # check indentation of any line with a bare else
3303 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3304 # if the previous line is a break or return and is indented 1 tab more...
3313 }
3314 }
3316 # check indentation of a line with a break;
3317 # if the previous line is a goto or return and is indented the same # of tabs
3323 }
3324 }
3326 # check for RCS/CVS revision markers
3330 }
3332 # check for old HOTPLUG __dev<foo> section markings
3336 }
3338 # Check for potential 'bare' types
3341 #print "LINE<$line>\n";
3349 #print "linenr<$linenr> <$stat>\n";
3350 # If this statement has no statement boundaries within
3351 # it there is no point in retrying a statement scan
3352 # until we hit end of it.
3355 #print "skip<$line_nr_next>\n";
3357 }
3359 # Find the real next line.
3365 }
3370 # Ignore goto labels.
3373 # Ignore functions being called
3378 # declarations always start with types
3379 } 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) {
3384 # definitions in global scope can only start with types
3387 }
3389 # any (foo ... *) is a pointer cast, and foo is a type
3392 }
3394 # Check for any sort of function declaration.
3395 # int foo(something bar, other baz);
3396 # void (*store_gdt)(x86_descr_ptr *);
3397 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3405 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3408 }
3409 }
3410 }
3412 }
3414 #
3415 # Checks which may be anchored in the context.
3416 #
3418 # Check for switch () and associated case and default
3419 # statements should be at the same indent.
3433 }
3434 }
3438 }
3439 }
3441 # if/while/etc brace do not go on next line, unless defining a do while loop,
3442 # or if that brace on the next line is for something else
3443 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3451 }
3462 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3465 }
3467 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3468 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3474 }
3478 {
3484 }
3485 }
3486 }
3488 # Check relative indent for conditionals and blocks.
3489 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3497 # remove inline comments
3501 # Find out how long the conditional actually is.
3505 # Make sure we remove the line prefixes as we have
3506 # none on the first line, and are going to readd them
3507 # where necessary.
3511 }
3513 # We want to check the first line inside the block
3514 # starting at the end of the conditional, so remove:
3515 # 1) any blank line termination
3516 # 2) any opening brace { on end of the line
3517 # 3) any do (...) {
3524 }
3528 }
3530 # Also ignore a loop construct at the end of a
3531 # preprocessor statement.
3535 }
3542 # If we see an #else/#elif then the code
3543 # is not linear.
3546 }
3548 # Ignore:
3549 # 1) blank lines, they should be at 0,
3550 # 2) preprocessor lines, and
3551 # 3) labels.
3559 }
3560 }
3561 }
3566 # Check if either of these lines are modified, else
3567 # this is not this patch's fault.
3571 }
3574 }
3576 #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";
3585 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3586 }
3587 }
3589 # Track the 'values' across context and added lines.
3599 }
3602 #ignore lines not being added
3605 # check for dereferences that span multiple lines
3615 }
3617 # check for declarations of signed or unsigned without int
3618 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3629 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3637 }
3638 }
3639 }
3641 # TEST: allow direct testing of the type matcher.
3649 }
3651 }
3652 # TEST: allow direct testing of the attribute matcher.
3660 }
3662 }
3664 # check for initialisation to aggregates open brace on the next line
3678 }
3679 }
3681 #
3682 # Checks which are anchored on the added line.
3683 #
3685 # check for malformed paths in #include statements (uses RAW line)
3691 }
3695 }
3696 }
3698 # no C99 // comments
3707 }
3708 }
3709 }
3710 # Remove C99 comments.
3714 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3715 # the whole statement.
3716 #print "APW <$lines[$realline_next - 1]>\n";
3722 # Handle definitions which produce identifiers with
3723 # a prefix:
3724 # XXX(foo);
3725 # EXPORT_SYMBOL(something_foo);
3729 #print "FOO C name<$name>\n";
3740 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3744 }
3745 }
3750 #print "FOO B <$lines[$linenr - 1]>\n";
3752 }
3757 }
3759 # check for global initialisers.
3765 }
3766 }
3767 # check for static initialisers.
3774 }
3775 }
3777 # check for misordered declarations of char/short/int/long with signed/unsigned
3781 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3782 }
3784 # check for static const char * arrays.
3789 }
3791 # check for static char foo[] = "bar" declarations.
3796 }
3798 # check for const <foo> const where <foo> is not a pointer or array type
3807 }
3808 }
3810 # check for non-global char *foo[] = {"bar", ...} declarations.
3815 }
3817 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3820 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3826 }
3827 }
3828 }
3830 # check for function declarations without arguments like "int foo()"
3836 }
3837 }
3839 # check for new typedefs, only function parameters and sparse annotations
3840 # make sense.
3848 }
3850 # * goes on variable not on type
3851 # (char*[ const])
3853 #print "AA<$1>\n";
3856 # Should start with a space.
3858 # Should not end with a space.
3860 # '*'s should not have spaces between.
3862 }
3864 ## print "1: from<$from> to<$to> ident<$ident>\n";
3874 }
3875 }
3876 }
3878 #print "BB<$1>\n";
3881 # Should start with a space.
3883 # Should not end with a space.
3885 # '*'s should not have spaces between.
3887 }
3888 # Modifiers should have spaces.
3891 ## print "2: from<$from> to<$to> ident<$ident>\n";
3902 }
3903 }
3904 }
3906 # avoid BUG() or BUG_ON()
3911 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3912 }
3914 # avoid LINUX_VERSION_CODE
3917 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3918 }
3920 # check for uses of printk_ratelimit
3924 }
3926 # printk should use KERN_* levels
3930 }
3939 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3940 }
3948 }
3949 }
3958 }
3960 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3961 # number of false positives, but assembly files are not checked, so at
3962 # least the arch entry code will not trigger this warning.
3966 }
3968 # function brace can't be on same line, except for #defines of do while,
3969 # or if closed on same line
3986 }
3987 }
3988 }
3990 # open braces for enum, union and struct go on the same line.
4004 }
4005 }
4006 }
4008 # missing space after union, struct or enum definition
4015 }
4016 }
4018 # Function pointer declarations
4019 # check spacing between type, funcptr, and args
4020 # canonical declaration is "type (*funcptr)(args...)"
4029 # the $Declare variable will capture all spaces after the type
4030 # so check it for a missing trailing missing space but pointer return types
4031 # don't need a space so don't warn for those.
4036 }
4041 }
4043 # unnecessary space "type (*funcptr)(args...)"
4044 # This test is not currently implemented because these declarations are
4045 # equivalent to
4046 # int foo(int bar, ...)
4047 # and this is form shouldn't/doesn't generate a checkpatch warning.
4048 #
4049 # elsif ($declare =~ /\s{2,}$/) {
4050 # WARN("SPACING",
4051 # "Multiple spaces after return type\n" . $herecurr);
4052 # }
4054 # unnecessary space "type ( *funcptr)(args...)"
4059 }
4061 # unnecessary space "type (* funcptr)(args...)"
4066 }
4068 # unnecessary space "type (*funcptr )(args...)"
4073 }
4075 # unnecessary space "type (*funcptr) (args...)"
4080 }
4084 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4085 }
4086 }
4088 # check for spacing round square brackets; allowed:
4089 # 1. with a type on the left -- int [] a;
4090 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4091 # 3. inside a curly brace -- = { [0...10] = 5 }
4102 }
4103 }
4104 }
4106 # check for spaces between functions and their parentheses.
4112 # Ignore those directives where spaces _are_ permitted.
4118 {
4119 # cpp #define statements have non-optional spaces, ie
4120 # if there is a space between the name and the open
4121 # parenthesis it is simply not a parameter group.
4124 # cpp #elif statement condition may start with a (
4127 # If this whole things ends with a type its most
4128 # likely a typedef for a function.
4137 }
4138 }
4139 }
4141 # Check operator spacing.
4147 <<=|>>=|<=|>=|==|!=|
4149 =>|->|<<|>>|<|>|=|!|~|
4155 ## print("element count: <" . $#elements . ">\n");
4156 ## foreach my $el (@elements) {
4157 ## print("el: <$el>\n");
4158 ## }
4166 }
4177 ## print("n: <$n> good: <$good>\n");
4181 # Pick up the preceding and succeeding characters.
4186 }
4209 }
4218 # Pull out the value of this operator.
4221 # Get the full operator variant.
4224 # Ignore operators passed as parameters.
4228 # # Ignore comments
4229 # } elsif ($op =~ /^$;+$/) {
4231 # ; should have either the end of line or a space or \ after it
4239 }
4240 }
4242 # // is a comment
4245 # : when part of a bitfield
4247 # skip the bitfield test for now
4249 # No spaces for:
4250 # ->
4258 }
4260 }
4261 }
4263 # , must not have a space before and must have a space on the right.
4272 }
4273 }
4280 }
4281 }
4287 }
4290 }
4291 }
4293 # '*' as part of a type definition -- reported already.
4295 #warn "'*' is part of type\n";
4297 # unary operators should have a space before and
4298 # none after. May be left adjacent to another
4299 # unary operator, or a cast
4309 }
4310 }
4311 }
4313 # A unary '*' may be const
4321 }
4323 }
4324 }
4326 # unary ++ and unary -- are allowed no space on one side.
4333 }
4334 }
4341 }
4342 }
4349 }
4351 }
4352 }
4354 # << and >> may either have or not have spaces both sides
4360 {
4368 }
4374 }
4375 }
4382 }
4384 }
4385 }
4387 # A colon needs no spaces before when it is
4388 # terminating a case value or a label.
4395 }
4396 }
4398 # All the others need spaces both sides.
4402 # Ignore email addresses <foo@bar>
4407 {
4409 }
4411 # for asm volatile statements
4412 # ignore a colon with another
4413 # colon immediately before or after
4417 }
4419 # messages are ERROR, but ?: are CHK
4429 }
4431 }
4432 }
4433 }
4436 ## print("n: <$n> GOOD: <$good>\n");
4439 }
4443 }
4447 }
4450 }
4452 # check for whitespace before a non-naked semicolon
4459 }
4460 }
4462 # check for multiple assignments
4466 }
4468 ## # check for multiple declarations, allowing for a function declaration
4469 ## # continuation.
4470 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4471 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4472 ##
4473 ## # Remove any bracketed sections to ensure we do not
4474 ## # falsly report the parameters of functions.
4475 ## my $ln = $line;
4476 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4477 ## }
4478 ## if ($ln =~ /,/) {
4479 ## WARN("MULTIPLE_DECLARATION",
4480 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4481 ## }
4482 ## }
4484 #need space before brace following if, while, etc
4491 }
4492 }
4494 ## # check for blank lines before declarations
4495 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4496 ## $prevrawline =~ /^.\s*$/) {
4497 ## WARN("SPACING",
4498 ## "No blank lines before declarations\n" . $hereprev);
4499 ## }
4500 ##
4502 # closing brace should have a space following it when it has anything
4503 # on the line
4510 }
4511 }
4513 # check spacing on square brackets
4520 }
4521 }
4528 }
4529 }
4531 # check spacing on parentheses
4539 }
4540 }
4549 }
4550 }
4552 # check unnecessary parentheses around addressof/dereference single $Lvals
4553 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4561 }
4562 }
4564 # check for unnecessary parentheses around function pointer uses
4565 # ie: (foo->bar)(); should be foo->bar();
4566 # but not "if (foo->bar) (" to avoid some false positives
4575 }
4576 }
4578 # check for unnecessary parentheses around comparisons in if uses
4579 # when !drivers/staging or command-line uses --strict
4586 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4588 # avoid parentheses around potential macro args
4597 }
4598 }
4601 }
4602 }
4604 #goto labels aren't indented, allow a single space however
4612 }
4613 }
4615 # return is not a function
4625 }
4629 }
4630 }
4632 # unnecessary return in a void function
4633 # at end-of-function, with the previous line a single leading tab, then return;
4634 # and the line before that not a goto label target like "out:"
4642 }
4644 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4650 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4655 }
4656 }
4658 # comparisons with a constant or upper case identifier on the left
4659 # avoid cases like "foo + BAR < baz"
4660 # only fix matches surrounded by parentheses to avoid incorrect
4661 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4682 }
4684 }
4685 }
4687 # Return of what appears to be an errno should normally be negative
4693 }
4694 }
4696 # Need a space before open parenthesis after if, while etc
4703 }
4704 }
4706 # Check for illegal assignment in if conditional -- and check for trailing
4707 # statements after the conditional.
4715 ##print "stat<$stat> stat_next<$stat_next>\n";
4718 # If the statement carries leading newlines,
4719 # then count those as offsets.
4727 }
4728 }
4737 }
4739 # Find out what is on the end of the line after the
4740 # conditional.
4746 {
4747 # Find out how long the conditional actually is.
4756 }
4760 }
4761 }
4763 # Check for bitwise tests written as boolean
4769 |
4774 {
4777 }
4779 # if and else should not have general statements after it
4786 }
4787 }
4788 # if should not continue a brace
4793 }
4794 # case and default should not have general statements after them
4800 {
4803 }
4805 # Check for }<nl>else {, these must be at the same
4806 # indent level to be relevant to each other.
4818 }
4822 }
4823 }
4829 # Find out what is on the end of the line after the
4830 # conditional.
4846 }
4847 }
4848 }
4850 #Specific variable tests
4854 #gcc binary extension
4862 }
4863 }
4865 #CamelCase
4868 #Ignore Page<foo> variants
4870 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4872 #Ignore some three character SI units explicitly, like MiB and KHz
4878 seed_camelcase_includes();
4882 }
4883 }
4888 }
4889 }
4890 }
4891 }
4893 #no spaces allowed after \ in define
4899 }
4900 }
4902 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4903 # itself <asm/foo.h> (uses RAW line)
4910 {
4919 }
4920 }
4921 }
4922 }
4924 # multi-statement macros should be enclosed in a do while loop, grab the
4925 # first statement and ensure its the whole macro if its not enclosed
4926 # in a known good container
4938 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4939 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4953 }
4960 # Flatten any parentheses and braces
4964 {
4965 }
4967 # Flatten any obvious string concatentation.
4970 {
4971 }
4973 # Make asm volatile uses seem like a generic function
4978 module_param_named|
4979 MODULE_PARM_DESC|
4980 DECLARE_PER_CPU|
4981 DEFINE_PER_CPU|
4982 __typeof__\(|
4983 union|
4984 struct|
4989 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4998 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5003 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5009 {
5012 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5019 }
5021 }
5023 # Make $define_stmt single line, comment-free, etc
5034 }
5035 }
5040 # check if any macro arguments are reused (ignore '...' and 'type')
5045 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5052 }
5053 # check if any macro arguments may have other precedence issues
5059 }
5060 }
5062 # check for macros with flow control, but without ## concatenation
5063 # ## concatenation is commonly a macro that defines a function so ignore those
5070 }
5072 # check for line continuations outside of #defines, preprocessor #, and asm
5081 }
5082 }
5084 # do {} while (0) macro tests:
5085 # single-statement macros do not need to be enclosed in do while (0) loop,
5086 # macro should not end with a semicolon
5101 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5113 }
5117 }
5125 }
5126 }
5128 # check for redundant bracing round if etc
5132 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5133 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5143 # If the condition carries leading newlines, then count those as offsets.
5148 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5150 # We have looked at and allowed this specific line.
5160 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5162 #print "APW: ALLOWED: cond<$cond>\n";
5164 }
5166 #print "APW: ALLOWED: block<$block>\n";
5168 }
5170 #print "APW: ALLOWED: lines block<$block>\n";
5172 }
5174 }
5179 }
5187 }
5188 }
5189 }
5190 }
5195 # Check the pre-context.
5197 #print "APW: ALLOWED: pre<$1>\n";
5199 }
5204 # Check the condition.
5206 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5209 }
5211 #print "APW: ALLOWED: cond<$cond>\n";
5213 }
5215 #print "APW: ALLOWED: block<$block>\n";
5217 }
5219 #print "APW: ALLOWED: lines block<$block>\n";
5221 }
5222 # Check the post-context.
5227 }
5229 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5231 }
5232 }
5239 }
5240 }
5242 # check for single line unbalanced braces
5246 }
5248 # check for unnecessary blank lines around braces
5254 }
5255 }
5261 }
5262 }
5264 # no volatiles please
5268 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5269 }
5271 # Check for user-visible strings broken across lines, which breaks the ability
5272 # to grep for the string. Make exceptions when the previous string ends in a
5273 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5274 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5287 }
5299 }
5301 }
5302 }
5304 # check for missing a space in a string concatenation
5308 }
5310 # check for an embedded function name in a string when the function is known
5311 # This does not work very well for -f --file checking as it depends on patch
5312 # context providing the function name or a single line form for in-file
5313 # function declarations
5319 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5320 }
5322 # check for spaces before a quoted newline
5328 }
5330 }
5332 # concatenated string without spaces between elements
5336 }
5338 # uncoalesced string fragments
5342 }
5344 # check for non-standard and hex prefixed decimal printf formats
5350 # check for %L
5355 }
5356 # check for %Z
5361 }
5362 # check for 0x<decimal>
5366 }
5367 }
5369 # check for line continuations in quoted strings with odd counts of "
5373 }
5375 # warn about #if 0
5380 }
5382 # check for needless "if (<foo>) fn(<foo>)" uses
5386 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5398 }
5403 }
5406 }
5410 }
5411 }
5412 }
5413 }
5415 # check for unnecessary "Out of Memory" messages
5424 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5426 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)/) {
5429 }
5430 }
5432 # check for logging functions with KERN_<LEVEL>
5440 }
5441 }
5443 # check for logging continuations
5447 }
5449 # check for mask then right shift without a parentheses
5455 }
5457 # check for pointer comparisons to NULL
5467 }
5468 }
5469 }
5471 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5474 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5484 $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;
5485 }
5486 }
5487 }
5489 # check for $InitAttributeData (ie: __initdata) with const
5500 }
5501 }
5503 # check for $InitAttributeConst (ie: __initconst) without const
5515 }
5516 }
5518 # check for __read_mostly with const non-pointer (should just be const)
5525 }
5526 }
5528 # don't use __constant_<foo> functions outside of include/uapi/
5530 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5538 }
5539 }
5541 # prefer usleep_range over udelay
5544 # ignore udelay's < 10, however
5547 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5548 }
5552 }
5553 }
5555 # warn about unexpectedly long msleep's
5559 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5560 }
5561 }
5563 # check for comparisons of jiffies
5566 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5567 }
5569 # check for comparisons of get_jiffies_64()
5572 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5573 }
5575 # warn about #ifdefs in C files
5576 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5577 # print "#ifdef in C files should be avoided\n";
5578 # print "$herecurr";
5579 # $clean = 0;
5580 # }
5582 # warn about spacing in #ifdefs
5589 }
5591 }
5593 # check for spinlock_t definitions without a comment.
5600 }
5601 }
5602 # check for memory barriers without a comment.
5605 mb|
5606 rmb|
5607 wmb|
5608 read_barrier_depends
5611 mb__before_atomic|
5612 mb__after_atomic|
5613 store_release|
5614 load_acquire|
5615 store_mb|
5628 }
5629 }
5639 }
5641 # check for waitqueue_active without a comment.
5646 }
5647 }
5649 # check for smp_read_barrier_depends and read_barrier_depends
5653 }
5655 # check of hardware specific defines
5656 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5659 }
5661 # check that the storage class is not after a type
5665 }
5666 # Check that the storage class is at the beginning of a declaration
5673 }
5675 # check the location of the inline attribute, that it is between
5676 # storage class and type.
5681 }
5683 # Check for __inline__ and __inline, prefer inline
5691 }
5692 }
5694 # Check for __attribute__ packed, prefer __packed
5699 }
5701 # Check for __attribute__ aligned, prefer __aligned
5706 }
5708 # Check for __attribute__ format(printf, prefer __printf
5712 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5714 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5716 }
5717 }
5719 # Check for __attribute__ format(scanf, prefer __scanf
5723 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5725 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5726 }
5727 }
5729 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5731 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5736 }
5738 # check for c99 types like uint8_t used outside of uapi/ and tools/
5753 }
5754 }
5755 }
5757 # check for cast of C90 native int or longer types constants
5772 }
5774 }
5775 }
5777 # check for sizeof(&)
5781 }
5783 # check for sizeof without parenthesis
5788 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5789 }
5790 }
5792 # check for struct spinlock declarations
5796 }
5798 # check for seq_printf uses that could be seq_puts
5807 }
5808 }
5809 }
5811 # check for vsprintf extension %p<foo> misuses
5833 }
5837 }
5839 "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");
5840 }
5841 }
5850 }
5854 }
5855 }
5856 }
5858 # Check for misused memsets
5873 }
5874 }
5876 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5877 # if ($^V && $^V ge 5.10.0 &&
5878 # defined $stat &&
5879 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5880 # if (WARN("PREFER_ETHER_ADDR_COPY",
5881 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5882 # $fix) {
5883 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5884 # }
5885 # }
5887 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5888 # if ($^V && $^V ge 5.10.0 &&
5889 # defined $stat &&
5890 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5891 # WARN("PREFER_ETHER_ADDR_EQUAL",
5892 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5893 # }
5895 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5896 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5897 # if ($^V && $^V ge 5.10.0 &&
5898 # defined $stat &&
5899 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5900 #
5901 # my $ms_val = $7;
5902 #
5903 # if ($ms_val =~ /^(?:0x|)0+$/i) {
5904 # if (WARN("PREFER_ETH_ZERO_ADDR",
5905 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5906 # $fix) {
5907 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5908 # }
5909 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5910 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
5911 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5912 # $fix) {
5913 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5914 # }
5915 # }
5916 # }
5918 # typecasts on min/max could be min_t/max_t
5936 }
5939 }
5940 }
5942 # check usleep_range arguments
5950 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5954 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5955 }
5956 }
5958 # check for naked sscanf
5970 }
5972 # check for simple sscanf that should be kstrto<foo>
5986 }
5987 }
5988 }
5990 # check for new externs in .h files.
5997 }
5998 }
6000 # check for new externs in .c files.
6003 {
6010 }
6013 {
6016 }
6021 }
6025 {
6028 }
6030 # check for function declarations that have arguments without identifier names
6032 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6040 }
6041 }
6042 }
6044 # check for function definitions
6050 # check for multiline function definition with misplaced open brace
6060 }
6064 }
6065 }
6067 # checks for new __setup's
6073 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6074 }
6075 }
6077 # check for pointless casting of kmalloc return
6080 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6081 }
6083 # alloc style
6084 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6086 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6089 }
6091 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6094 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6105 }
6115 $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;
6116 }
6117 }
6118 }
6120 # check for krealloc arg reuse
6125 }
6127 # check for alloc argument mismatch
6131 }
6133 # check for multiple semicolons
6139 }
6140 }
6142 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6151 }
6152 }
6154 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6155 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6161 }
6162 }
6164 # check for case / default statements not preceded by break/fallthrough/switch
6181 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6182 }
6186 }
6187 }
6189 # check for switch/default statements without a break;
6198 }
6200 # check for gcc specific __FUNCTION__
6206 }
6207 }
6209 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6213 }
6215 # check for use of yield()
6219 }
6221 # check for comparisons against true and false
6237 }
6242 ## maybe suggesting a correct construct would better
6243 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6245 }
6246 }
6248 # check for bool bitfields
6251 "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr);
6252 }
6254 # check for semaphores initialized locked
6258 }
6260 # recommend kstrto* over simple_strto* and strict_strto*
6264 }
6266 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6269 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6270 }
6272 # check for various structs that are normally const (ops, kgdb, device_tree)
6273 # and avoid what seem like struct definitions 'struct foo {'
6278 }
6280 # use of NR_CPUS is usually wrong
6281 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6288 {
6290 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6291 }
6293 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6297 }
6299 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6304 }
6306 # whine mightly about in_atomic
6314 }
6315 }
6317 # check for mutex_trylock_recursive usage
6321 }
6323 # check for lockdep_set_novalidate_class
6331 }
6332 }
6337 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6338 }
6340 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6341 # and whether or not function naming is typical and if
6342 # DEVICE_ATTR permissions uses are unusual too
6345 $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*\)/) {
6357 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6358 }
6365 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6366 }
6373 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6374 }
6385 }
6388 }
6394 }
6395 }
6397 # Mode permission misuses where it seems decimal should be octal
6398 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6399 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6400 # specific definition of not visible in sysfs.
6401 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6402 # use the default permissions
6418 }
6428 }
6431 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6432 }
6433 }
6434 }
6435 }
6437 # check for uses of S_<PERMS> that could be octal for readability
6442 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6445 }
6446 }
6448 # validate content of MODULE_LICENSE against list from include/linux/module.h
6452 GPL|
6453 GPL\ v2|
6458 Proprietary
6463 }
6464 }
6465 }
6467 # If we have no input at all, then there is nothing to report on
6468 # so just keep quiet.
6471 }
6473 # In mailback mode only produce a report in the negative, for
6474 # things that appear to be patches.
6477 }
6479 # This is not a patch, and we are are in 'no-patch' mode so
6480 # just keep quiet.
6483 }
6488 }
6492 }
6500 }
6503 # If there were any defects found and not already fixing them
6509 EOM
6510 }
6511 # If there were whitespace errors which cleanpatch can fix
6512 # then suggest that.
6519 EOM
6520 }
6521 }
6541 }
6544 }
6545 }
6553 Do _NOT_ trust the results written to this file.
6556 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6558 EOM
6559 }
6560 }
6568 }
6569 }
6571 }