| blob | 8b80bac055e490219f97d913f33bce165960fe92 |
1 #!/usr/bin/env perl
2 # (c) 2001, Dave Jones. (the file handling bit)
3 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
4 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
5 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
6 # Licensed under the terms of the GNU GPL License version 2
70 Options:
75 --emacs emacs compile window format
76 --terse one line per report
79 single git commit with:
83 multiple git commits with:
87 git merges are ignored
102 is all off)
104 literally
107 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
108 with potential errors corrected to the preferred
109 checkpatch style
114 runtime errors.
117 --codespellfile Use this codespell dictionary
118 --typedefsfile Read additional types from this file
124 EOM
127 }
132 }
148 # Also catch when type or level is passed through a variable
149 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
151 }
156 }
159 }
181 }
182 }
185 }
187 # Perl's Getopt::Long allows options to take optional arguments after a space.
188 # Prevent --color by itself from consuming other arguments
192 }
193 }
195 GetOptions(
245 }
246 }
248 #if no filenames are given, push '-' to read patch from stdin
251 }
263 }
279 }
280 }
289 }
291 }
292 }
302 ## no critic
305 }
312 }
318 }
325 }
326 }
331 }
332 }
342 __user|
343 __kernel|
344 __force|
345 __iomem|
346 __must_check|
347 __init_refok|
348 __kprobes|
349 __ref|
350 __rcu|
351 __private
359 # Notes to $Attribute:
360 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
362 const|
363 __percpu|
364 __nocast|
365 __safe|
366 __bitwise|
367 __packed__|
368 __packed2__|
369 __naked|
370 __maybe_unused|
371 __always_unused|
372 __noreturn|
373 __used|
374 __cold|
375 __pure|
376 __noclone|
377 __deprecated|
378 __read_mostly|
379 __kprobes|
381 ____cacheline_aligned|
382 ____cacheline_aligned_in_smp|
383 ____cacheline_internodealigned_in_smp|
384 __weak
406 <=|>=|==|!=|
407 =>|->|<<|>>|<|>|!|~|
441 )};
444 atomic_t
445 )};
450 )};
456 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
458 panic|
461 )};
470 To:|
471 Cc:
472 )};
491 );
514 );
535 )};
542 );
546 );
553 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
560 );
562 #Create a search pattern for all these functions to speed up a loop below
567 }
570 S_IWUGO |
571 S_IWOTH |
572 S_IRWXUGO |
573 S_IALLUGO |
594 );
596 #Create a search pattern for all these strings to speed up a loop below
601 }
604 irq|
605 memory|
607 reboot
608 )};
609 # memory.h: ARM has a custom one
611 # Load common spelling mistakes and build regular expression list.
628 }
632 }
651 }
655 }
656 }
675 }
679 }
682 }
685 }
695 }
714 )
721 )
730 )
734 $NonptrType
739 $NonptrTypeMisordered
745 }
746 build_types();
750 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
751 # requires at least perl version v5.10.0
752 # Any use must be runtime checked with $^V
762 )};
771 }
776 }
800 }
801 }
802 }
809 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
812 }
836 }
838 }
846 }
850 }
855 }
859 }
867 }
869 }
870 }
884 # Maybe one day convert this block of bash into something that returns
885 # all matching commit ids, but it's very slow...
886 #
887 # echo "checking commits $1..."
888 # git rev-list --remotes | grep -i "^$1" |
889 # while read line ; do
890 # git log --format='%H %s' -1 $line |
891 # echo "commit $(cut -c 1-12,41-)"
892 # done
893 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
898 }
901 }
912 # If input is git commits, extract all commits from the commit expressions.
913 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
926 }
935 }
936 }
939 }
955 }
962 }
966 }
973 }
977 }
986 build_types();
987 }
998 EOM
999 }
1005 EOM
1006 }
1007 }
1018 );
1023 }
1024 }
1026 }
1049 # If there's a name left after stripping spaces and
1050 # leading quotes, and the address doesn't have both
1051 # leading and trailing angle brackets, the address
1052 # is invalid. ie:
1053 # "joe smith joe@smith.com" bad
1054 # "joe smith <joe@smith.com" bad
1059 }
1060 }
1070 }
1073 }
1087 }
1093 }
1096 }
1104 }
1105 }
1108 }
1116 }
1117 }
1120 }
1133 }
1135 }
1138 }
1141 }
1145 }
1150 # Drop the diff line leader and expand tabs
1154 # Pick the indent from the front of the line.
1158 }
1169 }
1170 }
1181 # Always copy over the diff marker.
1187 # Comments we are wacking completly including the begin
1188 # and end, all to $;.
1195 }
1201 }
1208 }
1210 # A \ in a string means ignore the next character.
1216 }
1217 # Regular quotes.
1226 }
1227 }
1229 #print "c<$c> SQ<$sanitise_quote>\n";
1238 }
1239 }
1243 }
1245 # The pathname on a #include may be surrounded by '<' and '>'.
1250 # The whole of a #error is a string.
1254 }
1259 }
1262 }
1269 }
1292 #warn "CSB: blk<$blk> remain<$remain>\n";
1293 # If we are about to drop off the end, pull in more
1294 # context.
1305 }
1306 # Bail if there is no further context.
1307 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1310 }
1314 }
1315 }
1320 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1322 # Handle nested #if/#else.
1329 }
1331 # Statement ends at the ';' or a close '}' at the
1332 # outermost level.
1335 }
1337 # An else is really a conditional as long as its not else if
1344 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1345 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1346 }
1351 }
1359 #warn "CSB: mark coff<$coff>\n";
1360 }
1361 }
1365 }
1373 }
1375 }
1376 }
1377 # Preprocessor commands end at the newline unless escaped.
1383 }
1385 }
1386 # We are truly at the end, so shuffle to the next line.
1391 }
1396 #warn "STATEMENT<$statement>\n";
1397 #warn "CONDITION<$condition>\n";
1399 #print "coff<$coff> soff<$off> loff<$loff>\n";
1403 }
1408 # Strip the diff line prefixes and rip blank lines at start and end.
1416 }
1424 }
1445 }
1446 }
1454 # Grab the first conditional/block pair.
1457 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1461 }
1463 # Pull in the following conditional/block pairs and see if they
1464 # could continue the statement.
1468 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1470 #print "C: push\n";
1472 }
1475 }
1494 # Handle nested #if/#else.
1501 }
1504 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1508 }
1515 }
1516 }
1520 }
1523 }
1526 }
1532 }
1538 }
1544 }
1549 }
1554 }
1559 # Catch a comment on the end of the line itself.
1563 # Look through the context and try and figure out if there is a
1564 # comment.
1569 #warn " $line\n";
1572 }
1575 }
1578 }
1582 }
1583 }
1587 }
1592 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1593 ##print "CMMT: $cmt\n";
1596 }
1609 }
1612 }
1624 }
1625 }
1629 }
1641 }
1661 }
1682 }
1711 # Assume all arms of the conditional end as this
1712 # one does, and continue as if the #endif was not here.
1729 }
1760 }
1772 }
1805 }
1820 }
1829 }
1833 }
1837 }
1838 }
1841 }
1850 DEFINE_\S+
1851 )$|
1855 case|
1859 \#|
1860 \#\#|
1866 # Check for modifiers.
1877 }
1878 }
1883 }
1884 build_types();
1887 }
1888 }
1900 }
1908 }
1917 }
1918 }
1923 }
1931 }
1937 }
1941 }
1952 }
1953 }
1980 }
1986 }
1993 }
1998 }
2001 }
2004 }
2012 };
2014 }
2022 };
2025 }
2034 }
2036 }
2044 }
2046 }
2054 }
2056 }
2062 ##print "absolute<$absolute>\n";
2064 # See if any suffix of this path is a path within the tree.
2067 ##print "file<$file>\n";
2069 }
2070 }
2073 }
2075 # It is, so see if the prefix is acceptable.
2079 ##print "prefix<$prefix>\n";
2083 }
2084 }
2092 }
2100 }
2108 }
2116 }
2125 #convert leading spaces to tabs
2127 #Remove spaces before a tab
2131 }
2145 }
2157 }
2158 }
2161 }
2198 # Trace the real file/line as we go.
2211 # suppression flags
2219 # Pre-scan the patch sanitizing the lines.
2220 # Pre-scan the patch looking for any __setup documentation.
2221 #
2227 sanitise_line_reset();
2239 }
2240 #next;
2241 }
2248 }
2251 # Guestimate if this is a continuing comment. Run
2252 # the context looking for a comment "edge". If this
2253 # edge is a close comment then we must be in a comment
2254 # at context start.
2261 #print "RAW<$rawlines[$ln - 1]>\n";
2267 }
2268 }
2271 }
2273 # Guestimate if this is a continuing comment. If this
2274 # is the start of a diff block and this line starts
2275 # ' *' then it is very likely a comment.
2278 {
2280 }
2282 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2286 # Standardise the strings and chars within the input to
2287 # simplify matching -- only bother with positive lines.
2289 }
2296 }
2298 #print "==>$rawline\n";
2299 #print "-->$line\n";
2303 }
2304 }
2319 #extract the line range in the file after the patch is applied
2330 }
2331 annotate_reset();
2342 }
2345 # track the line number as we move through the hunk, note that
2346 # new versions of GNU diff omit the leading space on completely
2347 # blank context lines so we need to count that too.
2352 # Measure the line length and indent.
2355 # Track the previous line.
2360 #warn "line<$line>\n";
2364 }
2372 # extract the filename as it passes
2388 }
2392 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2393 }
2395 }
2397 #make up the handle for any error we report on this line
2405 }
2406 }
2411 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2412 }
2417 }
2419 }
2429 # Check if the commit log has what seems like a diff which can confuse patch
2438 }
2440 # Check for incorrect file permissions
2447 }
2448 }
2450 # Check the patch for a signoff:
2454 }
2456 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2457 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2460 }
2462 # Check signature styles
2474 }
2481 }
2482 }
2489 }
2491 }
2498 }
2499 }
2510 # Don't force email to have quotes
2511 # Allow just an angle bracketed address
2517 }
2518 }
2520 # Check for duplicate signatures
2529 }
2530 }
2532 # Check email subject for common tools that don't need to be mentioned
2537 }
2539 # Check for old stable address
2543 }
2545 # Check for unwanted Gerrit info
2549 }
2551 # Check if the commit log is in a possible stack dump
2555 # timestamp
2557 # stack dump address
2559 }
2561 # Check for line lengths > 75 in commit log, warn once
2565 # file delta changes
2567 # filename then :
2569 # A Fixes: or Link: line
2574 }
2576 # Reset possible stack dump if a blank line is found
2580 }
2582 # Check for git id commit length and improperly formed commit descriptions
2607 }
2629 }
2637 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2638 }
2639 }
2641 # Check for added, moved or deleted files
2651 }
2653 # Check for wrappage within a valid hunk of the file
2658 }
2660 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2671 }
2673 # Check if it's the start of a commit log
2674 # (not a header line and we haven't seen the patch filename)
2681 }
2683 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2684 # declined it, i.e defined some charset where it is missing.
2689 }
2695 }
2697 # Check for absolute kernel paths in commit message
2704 #
2707 }
2708 }
2709 }
2711 # Check for various typo / spelling mistakes
2725 }
2726 }
2727 }
2729 # ignore non-hunk lines and lines being removed
2732 #trailing whitespace
2739 }
2746 }
2749 }
2751 # Check for FSF mailing addresses.
2760 "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)
2761 }
2763 # check for Kconfig help text having a real description
2764 # Only applies when adding the entry originally, after that we do not have
2765 # sufficient context to determine whether it is indeed long enough.
2786 }
2795 }
2797 }
2801 }
2802 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2803 }
2805 # check for MAINTAINERS entries that don't have the right form
2813 }
2814 }
2816 # discourage the use of boolean for type definition attributes of Kconfig options
2821 }
2831 };
2834 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2835 }
2837 # check for DT compatible documentation
2856 }
2863 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2864 }
2865 }
2866 }
2868 # check we are in a valid source file if not then ignore this hunk
2871 # line length limit (with some exclusions)
2872 #
2873 # There are a few types of lines that may extend beyond $max_line_length:
2874 # logging functions like pr_info that end in a string
2875 # lines with a single string
2876 # #defines that are a single string
2877 #
2878 # There are 3 different line length message types:
2879 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
2880 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2881 # LONG_LINE all other lines longer than $max_line_length
2882 #
2883 # if LONG_LINE is ignored, the other 2 types are also ignored
2884 #
2889 # Check the allowed long line types first
2891 # logging functions that end in a string that starts
2892 # before $max_line_length
2893 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2897 # lines with only strings (w/ possible termination)
2898 # #defines with only strings
2903 # EFI_GUID is another special case
2907 # Otherwise set the alternate message types
2909 # a comment starts before $max_line_length
2914 # a quoted string starts before $max_line_length
2918 }
2924 }
2925 }
2927 # check for adding lines without a newline.
2928 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2931 }
2933 # Blackfin: use hi/lo macros
2939 }
2944 }
2945 }
2947 # check we are in a valid source file C or perl if not then ignore this hunk
2950 # at the beginning of a line any tabs must come first and anything
2951 # more than 8 must use tabs.
2960 }
2961 }
2963 # check for space before tabs.
2973 }
2974 }
2976 # check for && or || at the start of a line
2980 }
2982 # check indentation starts on a tab stop
2991 }
2992 }
2993 }
2995 # check multi-line statement indentation matches previous line
2997 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3020 }
3021 }
3022 }
3023 }
3025 # check for space after cast like "(int) foo" or "(struct foo) bar"
3026 # avoid checking a few false positives:
3027 # "sizeof(<type>)" or "__alignof__(<type>)"
3028 # function pointer declarations like "(*foo)(int) = bar;"
3029 # structure definitions like "(struct foo) { 0 };"
3030 # multiline macros that define functions
3031 # known attributes or the __attribute__ keyword
3039 }
3040 }
3042 # Block comment styles
3043 # Networking with an initial /*
3050 }
3052 # Block comments use * on subsequent lines
3060 }
3062 # Block comments use */ on trailing lines
3069 }
3071 # Block comment * alignment
3085 }
3092 }
3093 }
3095 # check for missing blank lines after struct/union declarations
3096 # with exceptions for various attributes and macros
3111 }
3112 }
3114 # check for multiple consecutive blank lines
3122 }
3125 }
3127 # check for missing blank lines after declarations
3129 # actual declarations
3131 # function pointer declarations
3133 # foo bar; where foo is some local typedef or #define
3135 # known declaration macros
3137 # for "else if" which can look like "$Ident $Ident"
3139 # other possible extensions of declaration lines
3141 # not starting a section or a macro "\" extended line
3143 # looks like a declaration
3145 # function pointer declarations
3147 # foo bar; where foo is some local typedef or #define
3149 # known declaration macros
3151 # start of struct or union or enum
3153 # start or end of block or continuation of declaration
3155 # bitfield continuation
3157 # other possible extensions of declaration lines
3159 # indentation of previous and current line are the same
3165 }
3166 }
3168 # check for spaces at the beginning of a line.
3169 # Exceptions:
3170 # 1) within comments
3171 # 2) indented preprocessor commands
3172 # 3) hanging labels
3179 }
3180 }
3182 # check we are in a valid C source file if not then ignore this hunk
3185 # check if this appears to be the start function declaration, save the name
3189 }
3191 # check if this appears to be the end of function declaration
3194 }
3196 # check indentation of any line with a bare else
3197 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3198 # if the previous line is a break or return and is indented 1 tab more...
3207 }
3208 }
3210 # check indentation of a line with a break;
3211 # if the previous line is a goto or return and is indented the same # of tabs
3217 }
3218 }
3220 # check for RCS/CVS revision markers
3224 }
3226 # Blackfin: don't use __builtin_bfin_[cs]sync
3231 }
3236 }
3238 # check for old HOTPLUG __dev<foo> section markings
3242 }
3244 # Check for potential 'bare' types
3247 #print "LINE<$line>\n";
3255 #print "linenr<$linenr> <$stat>\n";
3256 # If this statement has no statement boundaries within
3257 # it there is no point in retrying a statement scan
3258 # until we hit end of it.
3261 #print "skip<$line_nr_next>\n";
3263 }
3265 # Find the real next line.
3271 }
3276 # Ignore goto labels.
3279 # Ignore functions being called
3284 # declarations always start with types
3285 } 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) {
3290 # definitions in global scope can only start with types
3293 }
3295 # any (foo ... *) is a pointer cast, and foo is a type
3298 }
3300 # Check for any sort of function declaration.
3301 # int foo(something bar, other baz);
3302 # void (*store_gdt)(x86_descr_ptr *);
3303 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3311 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3314 }
3315 }
3316 }
3318 }
3320 #
3321 # Checks which may be anchored in the context.
3322 #
3324 # Check for switch () and associated case and default
3325 # statements should be at the same indent.
3339 }
3340 }
3344 }
3345 }
3347 # if/while/etc brace do not go on next line, unless defining a do while loop,
3348 # or if that brace on the next line is for something else
3349 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3357 }
3368 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3371 }
3373 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3374 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3380 }
3384 {
3390 }
3391 }
3392 }
3394 # Check relative indent for conditionals and blocks.
3395 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3403 # remove inline comments
3407 # Find out how long the conditional actually is.
3411 # Make sure we remove the line prefixes as we have
3412 # none on the first line, and are going to readd them
3413 # where necessary.
3417 }
3419 # We want to check the first line inside the block
3420 # starting at the end of the conditional, so remove:
3421 # 1) any blank line termination
3422 # 2) any opening brace { on end of the line
3423 # 3) any do (...) {
3430 }
3434 }
3436 # Also ignore a loop construct at the end of a
3437 # preprocessor statement.
3441 }
3448 # If we see an #else/#elif then the code
3449 # is not linear.
3452 }
3454 # Ignore:
3455 # 1) blank lines, they should be at 0,
3456 # 2) preprocessor lines, and
3457 # 3) labels.
3465 }
3466 }
3467 }
3472 # Check if either of these lines are modified, else
3473 # this is not this patch's fault.
3477 }
3480 }
3482 #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";
3491 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3492 }
3493 }
3495 # Track the 'values' across context and added lines.
3505 }
3508 #ignore lines not being added
3511 # check for dereferences that span multiple lines
3521 }
3523 # check for declarations of signed or unsigned without int
3524 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3535 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3543 }
3544 }
3545 }
3547 # TEST: allow direct testing of the type matcher.
3555 }
3557 }
3558 # TEST: allow direct testing of the attribute matcher.
3566 }
3568 }
3570 # check for initialisation to aggregates open brace on the next line
3584 }
3585 }
3587 #
3588 # Checks which are anchored on the added line.
3589 #
3591 # check for malformed paths in #include statements (uses RAW line)
3597 }
3601 }
3602 }
3604 # no C99 // comments
3613 }
3614 }
3615 }
3616 # Remove C99 comments.
3620 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3621 # the whole statement.
3622 #print "APW <$lines[$realline_next - 1]>\n";
3628 # Handle definitions which produce identifiers with
3629 # a prefix:
3630 # XXX(foo);
3631 # EXPORT_SYMBOL(something_foo);
3635 #print "FOO C name<$name>\n";
3646 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3650 }
3651 }
3656 #print "FOO B <$lines[$linenr - 1]>\n";
3658 }
3663 }
3665 # check for global initialisers.
3671 }
3672 }
3673 # check for static initialisers.
3680 }
3681 }
3683 # check for misordered declarations of char/short/int/long with signed/unsigned
3687 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3688 }
3690 # check for static const char * arrays.
3695 }
3697 # check for static char foo[] = "bar" declarations.
3702 }
3704 # check for const <foo> const where <foo> is not a pointer or array type
3713 }
3714 }
3716 # check for non-global char *foo[] = {"bar", ...} declarations.
3721 }
3723 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3726 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3732 }
3733 }
3734 }
3736 # check for function declarations without arguments like "int foo()"
3742 }
3743 }
3745 # check for new typedefs, only function parameters and sparse annotations
3746 # make sense.
3754 }
3756 # * goes on variable not on type
3757 # (char*[ const])
3759 #print "AA<$1>\n";
3762 # Should start with a space.
3764 # Should not end with a space.
3766 # '*'s should not have spaces between.
3768 }
3770 ## print "1: from<$from> to<$to> ident<$ident>\n";
3780 }
3781 }
3782 }
3784 #print "BB<$1>\n";
3787 # Should start with a space.
3789 # Should not end with a space.
3791 # '*'s should not have spaces between.
3793 }
3794 # Modifiers should have spaces.
3797 ## print "2: from<$from> to<$to> ident<$ident>\n";
3808 }
3809 }
3810 }
3812 # avoid BUG() or BUG_ON()
3817 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3818 }
3820 # avoid LINUX_VERSION_CODE
3823 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3824 }
3826 # check for uses of printk_ratelimit
3830 }
3832 # printk should use KERN_* levels. Note that follow on printk's on the
3833 # same line do not need a level, so we use the current block context
3834 # to try and find and validate the current printk. In summary the current
3835 # printk includes all preceding printk's which have no newline on the end.
3836 # we assume the first bad printk is the one to report.
3840 #print "CHECK<$lines[$ln - 1]\n";
3841 # we have a preceding printk if it ends
3842 # with "\n" ignore it, else it is to blame
3846 }
3848 }
3849 }
3853 }
3854 }
3863 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3864 }
3872 }
3873 }
3882 }
3884 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3885 # number of false positives, but assembly files are not checked, so at
3886 # least the arch entry code will not trigger this warning.
3890 }
3892 # function brace can't be on same line, except for #defines of do while,
3893 # or if closed on same line
3908 }
3909 }
3910 }
3912 # open braces for enum, union and struct go on the same line.
3926 }
3927 }
3928 }
3930 # missing space after union, struct or enum definition
3937 }
3938 }
3940 # Function pointer declarations
3941 # check spacing between type, funcptr, and args
3942 # canonical declaration is "type (*funcptr)(args...)"
3951 # the $Declare variable will capture all spaces after the type
3952 # so check it for a missing trailing missing space but pointer return types
3953 # don't need a space so don't warn for those.
3958 }
3963 }
3965 # unnecessary space "type (*funcptr)(args...)"
3966 # This test is not currently implemented because these declarations are
3967 # equivalent to
3968 # int foo(int bar, ...)
3969 # and this is form shouldn't/doesn't generate a checkpatch warning.
3970 #
3971 # elsif ($declare =~ /\s{2,}$/) {
3972 # WARN("SPACING",
3973 # "Multiple spaces after return type\n" . $herecurr);
3974 # }
3976 # unnecessary space "type ( *funcptr)(args...)"
3981 }
3983 # unnecessary space "type (* funcptr)(args...)"
3988 }
3990 # unnecessary space "type (*funcptr )(args...)"
3995 }
3997 # unnecessary space "type (*funcptr) (args...)"
4002 }
4006 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4007 }
4008 }
4010 # check for spacing round square brackets; allowed:
4011 # 1. with a type on the left -- int [] a;
4012 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4013 # 3. inside a curly brace -- = { [0...10] = 5 }
4024 }
4025 }
4026 }
4028 # check for spaces between functions and their parentheses.
4034 # Ignore those directives where spaces _are_ permitted.
4040 {
4041 # cpp #define statements have non-optional spaces, ie
4042 # if there is a space between the name and the open
4043 # parenthesis it is simply not a parameter group.
4046 # cpp #elif statement condition may start with a (
4049 # If this whole things ends with a type its most
4050 # likely a typedef for a function.
4059 }
4060 }
4061 }
4063 # Check operator spacing.
4069 <<=|>>=|<=|>=|==|!=|
4071 =>|->|<<|>>|<|>|=|!|~|
4077 ## print("element count: <" . $#elements . ">\n");
4078 ## foreach my $el (@elements) {
4079 ## print("el: <$el>\n");
4080 ## }
4088 }
4099 ## print("n: <$n> good: <$good>\n");
4103 # Pick up the preceding and succeeding characters.
4108 }
4131 }
4140 # Pull out the value of this operator.
4143 # Get the full operator variant.
4146 # Ignore operators passed as parameters.
4150 # # Ignore comments
4151 # } elsif ($op =~ /^$;+$/) {
4153 # ; should have either the end of line or a space or \ after it
4161 }
4162 }
4164 # // is a comment
4167 # : when part of a bitfield
4169 # skip the bitfield test for now
4171 # No spaces for:
4172 # ->
4180 }
4182 }
4183 }
4185 # , must not have a space before and must have a space on the right.
4194 }
4195 }
4202 }
4203 }
4209 }
4212 }
4213 }
4215 # '*' as part of a type definition -- reported already.
4217 #warn "'*' is part of type\n";
4219 # unary operators should have a space before and
4220 # none after. May be left adjacent to another
4221 # unary operator, or a cast
4231 }
4232 }
4233 }
4235 # A unary '*' may be const
4243 }
4245 }
4246 }
4248 # unary ++ and unary -- are allowed no space on one side.
4255 }
4256 }
4263 }
4264 }
4271 }
4273 }
4274 }
4276 # << and >> may either have or not have spaces both sides
4282 {
4290 }
4296 }
4297 }
4304 }
4306 }
4307 }
4309 # A colon needs no spaces before when it is
4310 # terminating a case value or a label.
4317 }
4318 }
4320 # All the others need spaces both sides.
4324 # Ignore email addresses <foo@bar>
4329 {
4331 }
4333 # for asm volatile statements
4334 # ignore a colon with another
4335 # colon immediately before or after
4339 }
4341 # messages are ERROR, but ?: are CHK
4351 }
4353 }
4354 }
4355 }
4358 ## print("n: <$n> GOOD: <$good>\n");
4361 }
4365 }
4369 }
4372 }
4374 # check for whitespace before a non-naked semicolon
4381 }
4382 }
4384 # check for multiple assignments
4388 }
4390 ## # check for multiple declarations, allowing for a function declaration
4391 ## # continuation.
4392 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4393 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4394 ##
4395 ## # Remove any bracketed sections to ensure we do not
4396 ## # falsly report the parameters of functions.
4397 ## my $ln = $line;
4398 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4399 ## }
4400 ## if ($ln =~ /,/) {
4401 ## WARN("MULTIPLE_DECLARATION",
4402 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4403 ## }
4404 ## }
4406 #need space before brace following if, while, etc
4413 }
4414 }
4416 ## # check for blank lines before declarations
4417 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4418 ## $prevrawline =~ /^.\s*$/) {
4419 ## WARN("SPACING",
4420 ## "No blank lines before declarations\n" . $hereprev);
4421 ## }
4422 ##
4424 # closing brace should have a space following it when it has anything
4425 # on the line
4432 }
4433 }
4435 # check spacing on square brackets
4442 }
4443 }
4450 }
4451 }
4453 # check spacing on parentheses
4461 }
4462 }
4471 }
4472 }
4474 # check unnecessary parentheses around addressof/dereference single $Lvals
4475 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4483 }
4484 }
4486 # check for unnecessary parentheses around function pointer uses
4487 # ie: (foo->bar)(); should be foo->bar();
4488 # but not "if (foo->bar) (" to avoid some false positives
4497 }
4498 }
4500 # check for unnecessary parentheses around comparisons in if uses
4506 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4508 # avoid parentheses around potential macro args
4517 }
4518 }
4521 }
4522 }
4524 #goto labels aren't indented, allow a single space however
4532 }
4533 }
4535 # return is not a function
4545 }
4549 }
4550 }
4552 # unnecessary return in a void function
4553 # at end-of-function, with the previous line a single leading tab, then return;
4554 # and the line before that not a goto label target like "out:"
4562 }
4564 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4570 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4575 }
4576 }
4578 # comparisons with a constant or upper case identifier on the left
4579 # avoid cases like "foo + BAR < baz"
4580 # only fix matches surrounded by parentheses to avoid incorrect
4581 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4602 }
4604 }
4605 }
4607 # Return of what appears to be an errno should normally be negative
4613 }
4614 }
4616 # Need a space before open parenthesis after if, while etc
4623 }
4624 }
4626 # Check for illegal assignment in if conditional -- and check for trailing
4627 # statements after the conditional.
4635 ##print "stat<$stat> stat_next<$stat_next>\n";
4638 # If the statement carries leading newlines,
4639 # then count those as offsets.
4647 }
4648 }
4657 }
4659 # Find out what is on the end of the line after the
4660 # conditional.
4666 {
4667 # Find out how long the conditional actually is.
4676 }
4680 }
4681 }
4683 # Check for bitwise tests written as boolean
4689 |
4694 {
4697 }
4699 # if and else should not have general statements after it
4706 }
4707 }
4708 # if should not continue a brace
4713 }
4714 # case and default should not have general statements after them
4720 {
4723 }
4725 # Check for }<nl>else {, these must be at the same
4726 # indent level to be relevant to each other.
4738 }
4742 }
4743 }
4749 # Find out what is on the end of the line after the
4750 # conditional.
4766 }
4767 }
4768 }
4770 #Specific variable tests
4774 #gcc binary extension
4782 }
4783 }
4785 #CamelCase
4788 #Ignore Page<foo> variants
4790 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4792 #Ignore some three character SI units explicitly, like MiB and KHz
4798 seed_camelcase_includes();
4802 }
4803 }
4808 }
4809 }
4810 }
4811 }
4813 #no spaces allowed after \ in define
4819 }
4820 }
4822 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4823 # itself <asm/foo.h> (uses RAW line)
4830 {
4839 }
4840 }
4841 }
4842 }
4844 # multi-statement macros should be enclosed in a do while loop, grab the
4845 # first statement and ensure its the whole macro if its not enclosed
4846 # in a known good container
4858 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4859 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4873 }
4880 # Flatten any parentheses and braces
4884 {
4885 }
4887 # Flatten any obvious string concatentation.
4890 {
4891 }
4893 # Make asm volatile uses seem like a generic function
4898 module_param_named|
4899 MODULE_PARM_DESC|
4900 DECLARE_PER_CPU|
4901 DEFINE_PER_CPU|
4902 __typeof__\(|
4903 union|
4904 struct|
4909 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4917 }
4922 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4927 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4933 {
4936 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4943 }
4945 }
4947 # Make $define_stmt single line, comment-free, etc
4958 }
4959 }
4964 # check if any macro arguments are reused (ignore '...' and 'type')
4969 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
4976 }
4977 # check if any macro arguments may have other precedence issues
4983 }
4984 }
4986 # check for macros with flow control, but without ## concatenation
4987 # ## concatenation is commonly a macro that defines a function so ignore those
4994 }
4997 }
4999 # check for line continuations outside of #defines, preprocessor #, and asm
5008 }
5009 }
5011 # do {} while (0) macro tests:
5012 # single-statement macros do not need to be enclosed in do while (0) loop,
5013 # macro should not end with a semicolon
5028 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5038 }
5044 }
5048 }
5056 }
5060 }
5061 }
5063 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5064 # all assignments may have only one of the following with an assignment:
5065 # .
5066 # ALIGN(...)
5067 # VMLINUX_SYMBOL(...)
5071 }
5073 # check for redundant bracing round if etc
5077 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5078 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5088 # If the condition carries leading newlines, then count those as offsets.
5093 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5095 # We have looked at and allowed this specific line.
5105 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5107 #print "APW: ALLOWED: cond<$cond>\n";
5109 }
5111 #print "APW: ALLOWED: block<$block>\n";
5113 }
5115 #print "APW: ALLOWED: lines block<$block>\n";
5117 }
5119 }
5124 }
5132 }
5133 }
5134 }
5135 }
5140 # Check the pre-context.
5142 #print "APW: ALLOWED: pre<$1>\n";
5144 }
5149 # Check the condition.
5151 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5154 }
5156 #print "APW: ALLOWED: cond<$cond>\n";
5158 }
5160 #print "APW: ALLOWED: block<$block>\n";
5162 }
5164 #print "APW: ALLOWED: lines block<$block>\n";
5166 }
5167 # Check the post-context.
5172 }
5174 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5176 }
5177 }
5184 }
5188 }
5189 }
5191 # check for single line unbalanced braces
5195 }
5197 # check for unnecessary blank lines around braces
5203 }
5204 }
5210 }
5211 }
5213 # no volatiles please
5217 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5218 }
5220 # Check for user-visible strings broken across lines, which breaks the ability
5221 # to grep for the string. Make exceptions when the previous string ends in a
5222 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5223 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5236 }
5248 }
5250 }
5251 }
5253 # check for missing a space in a string concatenation
5257 }
5259 # check for an embedded function name in a string when the function is known
5260 # This does not work very well for -f --file checking as it depends on patch
5261 # context providing the function name or a single line form for in-file
5262 # function declarations
5268 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5269 }
5271 # check for spaces before a quoted newline
5277 }
5279 }
5281 # concatenated string without spaces between elements
5285 }
5287 # uncoalesced string fragments
5291 }
5293 # check for non-standard and hex prefixed decimal printf formats
5299 # check for %L
5304 }
5305 # check for %Z
5310 }
5311 # check for 0x<decimal>
5315 }
5316 }
5318 # check for line continuations in quoted strings with odd counts of "
5322 }
5324 # warn about #if 0
5329 }
5331 # check for needless "if (<foo>) fn(<foo>)" uses
5335 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5347 }
5352 }
5355 }
5359 }
5360 }
5361 }
5362 }
5364 # check for unnecessary "Out of Memory" messages
5373 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5375 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)/) {
5378 }
5379 }
5381 # check for logging functions with KERN_<LEVEL>
5389 }
5390 }
5392 # check for logging continuations
5396 }
5398 # check for mask then right shift without a parentheses
5404 }
5406 # check for pointer comparisons to NULL
5416 }
5417 }
5418 }
5420 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5423 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5433 $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;
5434 }
5435 }
5436 }
5438 # check for $InitAttributeData (ie: __initdata) with const
5449 }
5450 }
5452 # check for $InitAttributeConst (ie: __initconst) without const
5464 }
5465 }
5467 # check for __read_mostly with const non-pointer (should just be const)
5474 }
5475 }
5477 # don't use __constant_<foo> functions outside of include/uapi/
5479 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5487 }
5488 }
5490 # prefer usleep_range over udelay
5493 # ignore udelay's < 10, however
5496 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5497 }
5501 }
5502 }
5504 # warn about unexpectedly long msleep's
5508 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5509 }
5510 }
5512 # check for comparisons of jiffies
5515 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5516 }
5518 # check for comparisons of get_jiffies_64()
5521 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5522 }
5524 # warn about #ifdefs in C files
5525 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5526 # print "#ifdef in C files should be avoided\n";
5527 # print "$herecurr";
5528 # $clean = 0;
5529 # }
5531 # warn about spacing in #ifdefs
5538 }
5540 }
5542 # check for spinlock_t definitions without a comment.
5549 }
5550 }
5551 # check for memory barriers without a comment.
5554 mb|
5555 rmb|
5556 wmb|
5557 read_barrier_depends
5560 mb__before_atomic|
5561 mb__after_atomic|
5562 store_release|
5563 load_acquire|
5564 store_mb|
5577 }
5578 }
5588 }
5590 # check for waitqueue_active without a comment.
5595 }
5596 }
5598 # check of hardware specific defines
5599 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5602 }
5604 # check that the storage class is not after a type
5608 }
5609 # Check that the storage class is at the beginning of a declaration
5616 }
5618 # check the location of the inline attribute, that it is between
5619 # storage class and type.
5624 }
5626 # Check for __inline__ and __inline, prefer inline
5634 }
5635 }
5637 # Check for __attribute__ packed, prefer __packed
5642 }
5644 # Check for __attribute__ aligned, prefer __aligned
5649 }
5651 # Check for __attribute__ format(printf, prefer __printf
5655 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5657 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5659 }
5660 }
5662 # Check for __attribute__ format(scanf, prefer __scanf
5666 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5668 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5669 }
5670 }
5672 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5674 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5679 }
5681 # check for c99 types like uint8_t used outside of uapi/ and tools/
5696 }
5697 }
5698 }
5700 # check for cast of C90 native int or longer types constants
5715 }
5717 }
5718 }
5720 # check for sizeof(&)
5724 }
5726 # check for sizeof without parenthesis
5731 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5732 }
5733 }
5735 # check for struct spinlock declarations
5739 }
5741 # check for seq_printf uses that could be seq_puts
5750 }
5751 }
5752 }
5754 # check for vsprintf extension %p<foo> misuses
5768 }
5769 }
5774 }
5777 }
5778 }
5780 # Check for misused memsets
5795 }
5796 }
5798 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5799 # if ($^V && $^V ge 5.10.0 &&
5800 # defined $stat &&
5801 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5802 # if (WARN("PREFER_ETHER_ADDR_COPY",
5803 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5804 # $fix) {
5805 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5806 # }
5807 # }
5809 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5810 # if ($^V && $^V ge 5.10.0 &&
5811 # defined $stat &&
5812 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5813 # WARN("PREFER_ETHER_ADDR_EQUAL",
5814 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5815 # }
5817 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5818 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5819 # if ($^V && $^V ge 5.10.0 &&
5820 # defined $stat &&
5821 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5822 #
5823 # my $ms_val = $7;
5824 #
5825 # if ($ms_val =~ /^(?:0x|)0+$/i) {
5826 # if (WARN("PREFER_ETH_ZERO_ADDR",
5827 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5828 # $fix) {
5829 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5830 # }
5831 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5832 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
5833 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5834 # $fix) {
5835 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5836 # }
5837 # }
5838 # }
5840 # typecasts on min/max could be min_t/max_t
5858 }
5861 }
5862 }
5864 # check usleep_range arguments
5872 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5876 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5877 }
5878 }
5880 # check for naked sscanf
5892 }
5895 }
5897 # check for simple sscanf that should be kstrto<foo>
5906 }
5914 }
5915 }
5916 }
5918 # check for new externs in .h files.
5925 }
5926 }
5928 # check for new externs in .c files.
5931 {
5938 }
5941 {
5944 }
5949 }
5953 {
5956 }
5958 # check for function declarations that have arguments without identifier names
5968 }
5969 }
5970 }
5972 # check for function definitions
5978 # check for multiline function definition with misplaced open brace
5988 }
5992 }
5993 }
5995 # checks for new __setup's
6001 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6002 }
6003 }
6005 # check for pointless casting of kmalloc return
6008 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6009 }
6011 # alloc style
6012 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6014 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6017 }
6019 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6022 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6033 }
6041 }
6046 $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;
6047 }
6048 }
6049 }
6051 # check for krealloc arg reuse
6056 }
6058 # check for alloc argument mismatch
6062 }
6064 # check for multiple semicolons
6070 }
6071 }
6073 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6082 }
6083 }
6085 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6086 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6092 }
6093 }
6095 # check for case / default statements not preceded by break/fallthrough/switch
6113 }
6117 }
6118 }
6120 # check for switch/default statements without a break;
6129 }
6132 }
6134 # check for gcc specific __FUNCTION__
6140 }
6141 }
6143 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6147 }
6149 # check for use of yield()
6153 }
6155 # check for comparisons against true and false
6171 }
6176 ## maybe suggesting a correct construct would better
6177 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6179 }
6180 }
6182 # check for semaphores initialized locked
6186 }
6188 # recommend kstrto* over simple_strto* and strict_strto*
6192 }
6194 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6197 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6198 }
6200 # check for various structs that are normally const (ops, kgdb, device_tree)
6201 # and avoid what seem like struct definitions 'struct foo {'
6206 }
6208 # use of NR_CPUS is usually wrong
6209 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6216 {
6218 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6219 }
6221 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6225 }
6227 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6232 }
6234 # whine mightly about in_atomic
6242 }
6243 }
6245 # whine about ACCESS_ONCE
6256 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6257 }
6263 }
6264 }
6265 }
6267 # check for mutex_trylock_recursive usage
6271 }
6273 # check for lockdep_set_novalidate_class
6281 }
6282 }
6287 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6288 }
6290 # Mode permission misuses where it seems decimal should be octal
6291 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6304 }
6310 }
6319 }
6322 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6323 }
6324 }
6325 }
6326 }
6328 # check for uses of S_<PERMS> that could be octal for readability
6345 }
6350 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6353 }
6354 }
6356 # validate content of MODULE_LICENSE against list from include/linux/module.h
6360 GPL|
6361 GPL\ v2|
6366 Proprietary
6371 }
6372 }
6373 }
6375 # If we have no input at all, then there is nothing to report on
6376 # so just keep quiet.
6379 }
6381 # In mailback mode only produce a report in the negative, for
6382 # things that appear to be patches.
6385 }
6387 # This is not a patch, and we are are in 'no-patch' mode so
6388 # just keep quiet.
6391 }
6396 }
6400 }
6408 }
6411 # If there were any defects found and not already fixing them
6417 EOM
6418 }
6419 # If there were whitespace errors which cleanpatch can fix
6420 # then suggest that.
6427 EOM
6428 }
6429 }
6449 }
6452 }
6453 }
6461 Do _NOT_ trust the results written to this file.
6464 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6466 EOM
6467 }
6468 }
6476 }
6477 }
6479 }