| blob | 4b9569fa931b90200a2c809598fe3765b157fbb7 |
1 #!/usr/bin/perl -w
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
69 Options:
74 --emacs emacs compile window format
75 --terse one line per report
78 single git commit with:
82 multiple git commits with:
86 git merges are ignored
101 is all off)
103 literally
106 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
107 with potential errors corrected to the preferred
108 checkpatch style
113 runtime errors.
116 --codespellfile Use this codespell dictionary
117 --typedefsfile Read additional types from this file
122 EOM
125 }
130 }
148 }
153 }
156 }
178 }
179 }
182 }
184 GetOptions(
232 }
233 }
235 #if no filenames are given, push '-' to read patch from stdin
238 }
254 }
255 }
264 }
266 }
267 }
277 ## no critic
280 }
287 }
293 }
300 }
301 }
306 }
307 }
317 __user|
318 __kernel|
319 __force|
320 __iomem|
321 __must_check|
322 __init_refok|
323 __kprobes|
324 __ref|
325 __rcu|
326 __private
334 # Notes to $Attribute:
335 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
337 const|
338 __percpu|
339 __nocast|
340 __safe|
341 __bitwise|
342 __packed__|
343 __packed2__|
344 __naked|
345 __maybe_unused|
346 __always_unused|
347 __noreturn|
348 __used|
349 __cold|
350 __pure|
351 __noclone|
352 __deprecated|
353 __read_mostly|
354 __kprobes|
356 ____cacheline_aligned|
357 ____cacheline_aligned_in_smp|
358 ____cacheline_internodealigned_in_smp|
359 __weak
381 <=|>=|==|!=|
382 =>|->|<<|>>|<|>|!|~|
416 )};
419 atomic_t
420 )};
425 )};
431 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
433 panic|
436 )};
445 To:|
446 Cc:
447 )};
466 );
489 );
510 )};
517 );
521 );
528 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
535 );
537 #Create a search pattern for all these functions to speed up a loop below
542 }
545 S_IWUGO |
546 S_IWOTH |
547 S_IRWXUGO |
548 S_IALLUGO |
569 );
571 #Create a search pattern for all these strings to speed up a loop below
576 }
579 irq|
580 memory|
582 reboot
583 )};
584 # memory.h: ARM has a custom one
586 # Load common spelling mistakes and build regular expression list.
603 }
607 }
626 }
630 }
631 }
650 }
654 }
657 }
660 }
670 }
689 )
696 )
705 )
709 $NonptrType
714 $NonptrTypeMisordered
720 }
721 build_types();
725 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
726 # requires at least perl version v5.10.0
727 # Any use must be runtime checked with $^V
737 )};
746 }
751 }
775 }
776 }
777 }
784 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
787 }
811 }
813 }
821 }
825 }
830 }
834 }
842 }
844 }
845 }
859 # Maybe one day convert this block of bash into something that returns
860 # all matching commit ids, but it's very slow...
861 #
862 # echo "checking commits $1..."
863 # git rev-list --remotes | grep -i "^$1" |
864 # while read line ; do
865 # git log --format='%H %s' -1 $line |
866 # echo "commit $(cut -c 1-12,41-)"
867 # done
868 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
872 }
875 }
886 # If input is git commits, extract all commits from the commit expressions.
887 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
900 }
909 }
910 }
913 }
929 }
936 }
940 }
947 }
951 }
960 build_types();
961 }
972 EOM
973 }
979 EOM
980 }
981 }
992 );
997 }
998 }
1000 }
1023 # If there's a name left after stripping spaces and
1024 # leading quotes, and the address doesn't have both
1025 # leading and trailing angle brackets, the address
1026 # is invalid. ie:
1027 # "joe smith joe@smith.com" bad
1028 # "joe smith <joe@smith.com" bad
1033 }
1034 }
1044 }
1047 }
1061 }
1067 }
1070 }
1078 }
1079 }
1082 }
1090 }
1091 }
1094 }
1107 }
1109 }
1112 }
1115 }
1119 }
1124 # Drop the diff line leader and expand tabs
1128 # Pick the indent from the front of the line.
1132 }
1143 }
1144 }
1155 # Always copy over the diff marker.
1161 # Comments we are wacking completly including the begin
1162 # and end, all to $;.
1169 }
1175 }
1182 }
1184 # A \ in a string means ignore the next character.
1190 }
1191 # Regular quotes.
1200 }
1201 }
1203 #print "c<$c> SQ<$sanitise_quote>\n";
1212 }
1213 }
1217 }
1219 # The pathname on a #include may be surrounded by '<' and '>'.
1224 # The whole of a #error is a string.
1228 }
1233 }
1236 }
1243 }
1266 #warn "CSB: blk<$blk> remain<$remain>\n";
1267 # If we are about to drop off the end, pull in more
1268 # context.
1279 }
1280 # Bail if there is no further context.
1281 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1284 }
1288 }
1289 }
1294 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1296 # Handle nested #if/#else.
1303 }
1305 # Statement ends at the ';' or a close '}' at the
1306 # outermost level.
1309 }
1311 # An else is really a conditional as long as its not else if
1318 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1319 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1320 }
1325 }
1333 #warn "CSB: mark coff<$coff>\n";
1334 }
1335 }
1339 }
1347 }
1349 }
1350 }
1351 # Preprocessor commands end at the newline unless escaped.
1357 }
1359 }
1360 # We are truly at the end, so shuffle to the next line.
1365 }
1370 #warn "STATEMENT<$statement>\n";
1371 #warn "CONDITION<$condition>\n";
1373 #print "coff<$coff> soff<$off> loff<$loff>\n";
1377 }
1382 # Strip the diff line prefixes and rip blank lines at start and end.
1390 }
1398 }
1419 }
1420 }
1428 # Grab the first conditional/block pair.
1431 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1435 }
1437 # Pull in the following conditional/block pairs and see if they
1438 # could continue the statement.
1442 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1444 #print "C: push\n";
1446 }
1449 }
1468 # Handle nested #if/#else.
1475 }
1478 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1482 }
1489 }
1490 }
1494 }
1497 }
1500 }
1506 }
1512 }
1518 }
1523 }
1528 }
1533 # Catch a comment on the end of the line itself.
1537 # Look through the context and try and figure out if there is a
1538 # comment.
1543 #warn " $line\n";
1546 }
1549 }
1552 }
1556 }
1557 }
1561 }
1566 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1567 ##print "CMMT: $cmt\n";
1570 }
1583 }
1586 }
1598 }
1599 }
1603 }
1615 }
1635 }
1656 }
1685 # Assume all arms of the conditional end as this
1686 # one does, and continue as if the #endif was not here.
1703 }
1734 }
1746 }
1779 }
1794 }
1803 }
1807 }
1811 }
1812 }
1815 }
1824 DEFINE_\S+
1825 )$|
1829 case|
1833 \#|
1834 \#\#|
1840 # Check for modifiers.
1851 }
1852 }
1857 }
1858 build_types();
1861 }
1862 }
1874 }
1882 }
1891 }
1892 }
1897 }
1905 }
1911 }
1915 }
1926 }
1927 }
1954 }
1960 }
1967 }
1972 }
1975 }
1978 }
1986 };
1988 }
1996 };
1999 }
2008 }
2010 }
2018 }
2020 }
2028 }
2030 }
2036 ##print "absolute<$absolute>\n";
2038 # See if any suffix of this path is a path within the tree.
2041 ##print "file<$file>\n";
2043 }
2044 }
2047 }
2049 # It is, so see if the prefix is acceptable.
2053 ##print "prefix<$prefix>\n";
2057 }
2058 }
2066 }
2074 }
2082 }
2090 }
2099 #convert leading spaces to tabs
2101 #Remove spaces before a tab
2105 }
2119 }
2131 }
2132 }
2135 }
2172 # Trace the real file/line as we go.
2185 # suppression flags
2193 # Pre-scan the patch sanitizing the lines.
2194 # Pre-scan the patch looking for any __setup documentation.
2195 #
2201 sanitise_line_reset();
2213 }
2214 #next;
2215 }
2222 }
2225 # Guestimate if this is a continuing comment. Run
2226 # the context looking for a comment "edge". If this
2227 # edge is a close comment then we must be in a comment
2228 # at context start.
2235 #print "RAW<$rawlines[$ln - 1]>\n";
2241 }
2242 }
2245 }
2247 # Guestimate if this is a continuing comment. If this
2248 # is the start of a diff block and this line starts
2249 # ' *' then it is very likely a comment.
2252 {
2254 }
2256 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2260 # Standardise the strings and chars within the input to
2261 # simplify matching -- only bother with positive lines.
2263 }
2270 }
2272 #print "==>$rawline\n";
2273 #print "-->$line\n";
2277 }
2278 }
2293 #extract the line range in the file after the patch is applied
2304 }
2305 annotate_reset();
2316 }
2319 # track the line number as we move through the hunk, note that
2320 # new versions of GNU diff omit the leading space on completely
2321 # blank context lines so we need to count that too.
2326 # Measure the line length and indent.
2329 # Track the previous line.
2334 #warn "line<$line>\n";
2338 }
2346 # extract the filename as it passes
2362 }
2366 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2367 }
2369 }
2371 #make up the handle for any error we report on this line
2379 }
2380 }
2385 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2386 }
2391 }
2393 }
2403 # Check if the commit log has what seems like a diff which can confuse patch
2412 }
2414 # Check for incorrect file permissions
2421 }
2422 }
2424 # Check the patch for a signoff:
2428 }
2430 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2431 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2434 }
2436 # Check signature styles
2448 }
2455 }
2456 }
2463 }
2465 }
2472 }
2473 }
2484 # Don't force email to have quotes
2485 # Allow just an angle bracketed address
2491 }
2492 }
2494 # Check for duplicate signatures
2503 }
2504 }
2506 # Check email subject for common tools that don't need to be mentioned
2511 }
2513 # Check for old stable address
2517 }
2519 # Check for unwanted Gerrit info
2523 }
2525 # Check if the commit log is in a possible stack dump
2529 # timestamp
2531 # stack dump address
2533 }
2535 # Check for line lengths > 75 in commit log, warn once
2539 # file delta changes
2541 # filename then :
2543 # A Fixes: or Link: line
2548 }
2550 # Reset possible stack dump if a blank line is found
2554 }
2556 # Check for git id commit length and improperly formed commit descriptions
2581 }
2603 }
2610 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2611 }
2612 }
2614 # Check for added, moved or deleted files
2624 }
2626 # Check for wrappage within a valid hunk of the file
2631 }
2633 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2644 }
2646 # Check if it's the start of a commit log
2647 # (not a header line and we haven't seen the patch filename)
2654 }
2656 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2657 # declined it, i.e defined some charset where it is missing.
2662 }
2668 }
2670 # Check for absolute kernel paths in commit message
2677 #
2680 }
2681 }
2682 }
2684 # Check for various typo / spelling mistakes
2698 }
2699 }
2700 }
2702 # ignore non-hunk lines and lines being removed
2705 #trailing whitespace
2712 }
2719 }
2722 }
2724 # Check for FSF mailing addresses.
2733 "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)
2734 }
2736 # check for Kconfig help text having a real description
2737 # Only applies when adding the entry originally, after that we do not have
2738 # sufficient context to determine whether it is indeed long enough.
2759 }
2768 }
2770 }
2774 }
2775 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2776 }
2778 # discourage the use of boolean for type definition attributes of Kconfig options
2783 }
2793 };
2796 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2797 }
2799 # check for DT compatible documentation
2818 }
2825 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2826 }
2827 }
2828 }
2830 # check we are in a valid source file if not then ignore this hunk
2833 # line length limit (with some exclusions)
2834 #
2835 # There are a few types of lines that may extend beyond $max_line_length:
2836 # logging functions like pr_info that end in a string
2837 # lines with a single string
2838 # #defines that are a single string
2839 #
2840 # There are 3 different line length message types:
2841 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2842 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2843 # LONG_LINE all other lines longer than $max_line_length
2844 #
2845 # if LONG_LINE is ignored, the other 2 types are also ignored
2846 #
2851 # Check the allowed long line types first
2853 # logging functions that end in a string that starts
2854 # before $max_line_length
2855 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2859 # lines with only strings (w/ possible termination)
2860 # #defines with only strings
2865 # EFI_GUID is another special case
2869 # Otherwise set the alternate message types
2871 # a comment starts before $max_line_length
2876 # a quoted string starts before $max_line_length
2880 }
2886 }
2887 }
2889 # check for adding lines without a newline.
2890 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2893 }
2895 # Blackfin: use hi/lo macros
2901 }
2906 }
2907 }
2909 # check we are in a valid source file C or perl if not then ignore this hunk
2912 # at the beginning of a line any tabs must come first and anything
2913 # more than 8 must use tabs.
2922 }
2923 }
2925 # check for space before tabs.
2935 }
2936 }
2938 # check for && or || at the start of a line
2942 }
2944 # check indentation starts on a tab stop
2953 }
2954 }
2955 }
2957 # check multi-line statement indentation matches previous line
2959 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2982 }
2983 }
2984 }
2985 }
2987 # check for space after cast like "(int) foo" or "(struct foo) bar"
2988 # avoid checking a few false positives:
2989 # "sizeof(<type>)" or "__alignof__(<type>)"
2990 # function pointer declarations like "(*foo)(int) = bar;"
2991 # structure definitions like "(struct foo) { 0 };"
2992 # multiline macros that define functions
2993 # known attributes or the __attribute__ keyword
3001 }
3002 }
3004 # Block comment styles
3005 # Networking with an initial /*
3012 }
3014 # Block comments use * on subsequent lines
3022 }
3024 # Block comments use */ on trailing lines
3031 }
3033 # Block comment * alignment
3047 }
3054 }
3055 }
3057 # check for missing blank lines after struct/union declarations
3058 # with exceptions for various attributes and macros
3073 }
3074 }
3076 # check for multiple consecutive blank lines
3084 }
3087 }
3089 # check for missing blank lines after declarations
3091 # actual declarations
3093 # function pointer declarations
3095 # foo bar; where foo is some local typedef or #define
3097 # known declaration macros
3099 # for "else if" which can look like "$Ident $Ident"
3101 # other possible extensions of declaration lines
3103 # not starting a section or a macro "\" extended line
3105 # looks like a declaration
3107 # function pointer declarations
3109 # foo bar; where foo is some local typedef or #define
3111 # known declaration macros
3113 # start of struct or union or enum
3115 # start or end of block or continuation of declaration
3117 # bitfield continuation
3119 # other possible extensions of declaration lines
3121 # indentation of previous and current line are the same
3127 }
3128 }
3130 # check for spaces at the beginning of a line.
3131 # Exceptions:
3132 # 1) within comments
3133 # 2) indented preprocessor commands
3134 # 3) hanging labels
3141 }
3142 }
3144 # check we are in a valid C source file if not then ignore this hunk
3147 # check if this appears to be the start function declaration, save the name
3151 }
3153 # check if this appears to be the end of function declaration
3156 }
3158 # check indentation of any line with a bare else
3159 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3160 # if the previous line is a break or return and is indented 1 tab more...
3169 }
3170 }
3172 # check indentation of a line with a break;
3173 # if the previous line is a goto or return and is indented the same # of tabs
3179 }
3180 }
3182 # check for RCS/CVS revision markers
3186 }
3188 # Blackfin: don't use __builtin_bfin_[cs]sync
3193 }
3198 }
3200 # check for old HOTPLUG __dev<foo> section markings
3204 }
3206 # Check for potential 'bare' types
3209 #print "LINE<$line>\n";
3217 #print "linenr<$linenr> <$stat>\n";
3218 # If this statement has no statement boundaries within
3219 # it there is no point in retrying a statement scan
3220 # until we hit end of it.
3223 #print "skip<$line_nr_next>\n";
3225 }
3227 # Find the real next line.
3233 }
3238 # Ignore goto labels.
3241 # Ignore functions being called
3246 # declarations always start with types
3247 } 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) {
3252 # definitions in global scope can only start with types
3255 }
3257 # any (foo ... *) is a pointer cast, and foo is a type
3260 }
3262 # Check for any sort of function declaration.
3263 # int foo(something bar, other baz);
3264 # void (*store_gdt)(x86_descr_ptr *);
3265 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3273 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3276 }
3277 }
3278 }
3280 }
3282 #
3283 # Checks which may be anchored in the context.
3284 #
3286 # Check for switch () and associated case and default
3287 # statements should be at the same indent.
3301 }
3302 }
3306 }
3307 }
3309 # if/while/etc brace do not go on next line, unless defining a do while loop,
3310 # or if that brace on the next line is for something else
3311 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3319 }
3330 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3333 }
3335 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3336 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3342 }
3346 {
3352 }
3353 }
3354 }
3356 # Check relative indent for conditionals and blocks.
3357 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3365 # remove inline comments
3369 # Find out how long the conditional actually is.
3373 # Make sure we remove the line prefixes as we have
3374 # none on the first line, and are going to readd them
3375 # where necessary.
3379 }
3381 # We want to check the first line inside the block
3382 # starting at the end of the conditional, so remove:
3383 # 1) any blank line termination
3384 # 2) any opening brace { on end of the line
3385 # 3) any do (...) {
3392 }
3396 }
3398 # Also ignore a loop construct at the end of a
3399 # preprocessor statement.
3403 }
3410 # If we see an #else/#elif then the code
3411 # is not linear.
3414 }
3416 # Ignore:
3417 # 1) blank lines, they should be at 0,
3418 # 2) preprocessor lines, and
3419 # 3) labels.
3427 }
3428 }
3429 }
3434 # Check if either of these lines are modified, else
3435 # this is not this patch's fault.
3439 }
3442 }
3444 #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";
3453 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3454 }
3455 }
3457 # Track the 'values' across context and added lines.
3467 }
3470 #ignore lines not being added
3473 # check for dereferences that span multiple lines
3483 }
3485 # check for declarations of signed or unsigned without int
3486 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3497 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3505 }
3506 }
3507 }
3509 # TEST: allow direct testing of the type matcher.
3517 }
3519 }
3520 # TEST: allow direct testing of the attribute matcher.
3528 }
3530 }
3532 # check for initialisation to aggregates open brace on the next line
3546 }
3547 }
3549 #
3550 # Checks which are anchored on the added line.
3551 #
3553 # check for malformed paths in #include statements (uses RAW line)
3559 }
3563 }
3564 }
3566 # no C99 // comments
3575 }
3576 }
3577 }
3578 # Remove C99 comments.
3582 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3583 # the whole statement.
3584 #print "APW <$lines[$realline_next - 1]>\n";
3590 # Handle definitions which produce identifiers with
3591 # a prefix:
3592 # XXX(foo);
3593 # EXPORT_SYMBOL(something_foo);
3597 #print "FOO C name<$name>\n";
3608 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3612 }
3613 }
3618 #print "FOO B <$lines[$linenr - 1]>\n";
3620 }
3625 }
3627 # check for global initialisers.
3633 }
3634 }
3635 # check for static initialisers.
3642 }
3643 }
3645 # check for misordered declarations of char/short/int/long with signed/unsigned
3649 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3650 }
3652 # check for static const char * arrays.
3657 }
3659 # check for static char foo[] = "bar" declarations.
3664 }
3666 # check for const <foo> const where <foo> is not a pointer or array type
3675 }
3676 }
3678 # check for non-global char *foo[] = {"bar", ...} declarations.
3683 }
3685 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3688 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3694 }
3695 }
3696 }
3698 # check for function declarations without arguments like "int foo()"
3704 }
3705 }
3707 # check for new typedefs, only function parameters and sparse annotations
3708 # make sense.
3716 }
3718 # * goes on variable not on type
3719 # (char*[ const])
3721 #print "AA<$1>\n";
3724 # Should start with a space.
3726 # Should not end with a space.
3728 # '*'s should not have spaces between.
3730 }
3732 ## print "1: from<$from> to<$to> ident<$ident>\n";
3742 }
3743 }
3744 }
3746 #print "BB<$1>\n";
3749 # Should start with a space.
3751 # Should not end with a space.
3753 # '*'s should not have spaces between.
3755 }
3756 # Modifiers should have spaces.
3759 ## print "2: from<$from> to<$to> ident<$ident>\n";
3770 }
3771 }
3772 }
3774 # avoid BUG() or BUG_ON()
3779 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3780 }
3782 # avoid LINUX_VERSION_CODE
3785 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3786 }
3788 # check for uses of printk_ratelimit
3792 }
3794 # printk should use KERN_* levels. Note that follow on printk's on the
3795 # same line do not need a level, so we use the current block context
3796 # to try and find and validate the current printk. In summary the current
3797 # printk includes all preceding printk's which have no newline on the end.
3798 # we assume the first bad printk is the one to report.
3802 #print "CHECK<$lines[$ln - 1]\n";
3803 # we have a preceding printk if it ends
3804 # with "\n" ignore it, else it is to blame
3808 }
3810 }
3811 }
3815 }
3816 }
3825 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3826 }
3834 }
3835 }
3844 }
3846 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3847 # number of false positives, but assembly files are not checked, so at
3848 # least the arch entry code will not trigger this warning.
3852 }
3854 # function brace can't be on same line, except for #defines of do while,
3855 # or if closed on same line
3870 }
3871 }
3872 }
3874 # open braces for enum, union and struct go on the same line.
3888 }
3889 }
3890 }
3892 # missing space after union, struct or enum definition
3899 }
3900 }
3902 # Function pointer declarations
3903 # check spacing between type, funcptr, and args
3904 # canonical declaration is "type (*funcptr)(args...)"
3913 # the $Declare variable will capture all spaces after the type
3914 # so check it for a missing trailing missing space but pointer return types
3915 # don't need a space so don't warn for those.
3920 }
3925 }
3927 # unnecessary space "type (*funcptr)(args...)"
3928 # This test is not currently implemented because these declarations are
3929 # equivalent to
3930 # int foo(int bar, ...)
3931 # and this is form shouldn't/doesn't generate a checkpatch warning.
3932 #
3933 # elsif ($declare =~ /\s{2,}$/) {
3934 # WARN("SPACING",
3935 # "Multiple spaces after return type\n" . $herecurr);
3936 # }
3938 # unnecessary space "type ( *funcptr)(args...)"
3943 }
3945 # unnecessary space "type (* funcptr)(args...)"
3950 }
3952 # unnecessary space "type (*funcptr )(args...)"
3957 }
3959 # unnecessary space "type (*funcptr) (args...)"
3964 }
3968 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3969 }
3970 }
3972 # check for spacing round square brackets; allowed:
3973 # 1. with a type on the left -- int [] a;
3974 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3975 # 3. inside a curly brace -- = { [0...10] = 5 }
3986 }
3987 }
3988 }
3990 # check for spaces between functions and their parentheses.
3996 # Ignore those directives where spaces _are_ permitted.
4002 {
4003 # cpp #define statements have non-optional spaces, ie
4004 # if there is a space between the name and the open
4005 # parenthesis it is simply not a parameter group.
4008 # cpp #elif statement condition may start with a (
4011 # If this whole things ends with a type its most
4012 # likely a typedef for a function.
4021 }
4022 }
4023 }
4025 # Check operator spacing.
4031 <<=|>>=|<=|>=|==|!=|
4033 =>|->|<<|>>|<|>|=|!|~|
4039 ## print("element count: <" . $#elements . ">\n");
4040 ## foreach my $el (@elements) {
4041 ## print("el: <$el>\n");
4042 ## }
4050 }
4061 ## print("n: <$n> good: <$good>\n");
4065 # Pick up the preceding and succeeding characters.
4070 }
4093 }
4102 # Pull out the value of this operator.
4105 # Get the full operator variant.
4108 # Ignore operators passed as parameters.
4112 # # Ignore comments
4113 # } elsif ($op =~ /^$;+$/) {
4115 # ; should have either the end of line or a space or \ after it
4123 }
4124 }
4126 # // is a comment
4129 # : when part of a bitfield
4131 # skip the bitfield test for now
4133 # No spaces for:
4134 # ->
4142 }
4144 }
4145 }
4147 # , must not have a space before and must have a space on the right.
4156 }
4157 }
4164 }
4165 }
4171 }
4174 }
4175 }
4177 # '*' as part of a type definition -- reported already.
4179 #warn "'*' is part of type\n";
4181 # unary operators should have a space before and
4182 # none after. May be left adjacent to another
4183 # unary operator, or a cast
4193 }
4194 }
4195 }
4197 # A unary '*' may be const
4205 }
4207 }
4208 }
4210 # unary ++ and unary -- are allowed no space on one side.
4217 }
4218 }
4225 }
4226 }
4233 }
4235 }
4236 }
4238 # << and >> may either have or not have spaces both sides
4244 {
4252 }
4258 }
4259 }
4266 }
4268 }
4269 }
4271 # A colon needs no spaces before when it is
4272 # terminating a case value or a label.
4279 }
4280 }
4282 # All the others need spaces both sides.
4286 # Ignore email addresses <foo@bar>
4291 {
4293 }
4295 # for asm volatile statements
4296 # ignore a colon with another
4297 # colon immediately before or after
4301 }
4303 # messages are ERROR, but ?: are CHK
4313 }
4315 }
4316 }
4317 }
4320 ## print("n: <$n> GOOD: <$good>\n");
4323 }
4327 }
4331 }
4334 }
4336 # check for whitespace before a non-naked semicolon
4343 }
4344 }
4346 # check for multiple assignments
4350 }
4352 ## # check for multiple declarations, allowing for a function declaration
4353 ## # continuation.
4354 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4355 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4356 ##
4357 ## # Remove any bracketed sections to ensure we do not
4358 ## # falsly report the parameters of functions.
4359 ## my $ln = $line;
4360 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4361 ## }
4362 ## if ($ln =~ /,/) {
4363 ## WARN("MULTIPLE_DECLARATION",
4364 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4365 ## }
4366 ## }
4368 #need space before brace following if, while, etc
4375 }
4376 }
4378 ## # check for blank lines before declarations
4379 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4380 ## $prevrawline =~ /^.\s*$/) {
4381 ## WARN("SPACING",
4382 ## "No blank lines before declarations\n" . $hereprev);
4383 ## }
4384 ##
4386 # closing brace should have a space following it when it has anything
4387 # on the line
4394 }
4395 }
4397 # check spacing on square brackets
4404 }
4405 }
4412 }
4413 }
4415 # check spacing on parentheses
4423 }
4424 }
4433 }
4434 }
4436 # check unnecessary parentheses around addressof/dereference single $Lvals
4437 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4445 }
4446 }
4448 # check for unnecessary parentheses around function pointer uses
4449 # ie: (foo->bar)(); should be foo->bar();
4450 # but not "if (foo->bar) (" to avoid some false positives
4459 }
4460 }
4462 #goto labels aren't indented, allow a single space however
4470 }
4471 }
4473 # return is not a function
4483 }
4487 }
4488 }
4490 # unnecessary return in a void function
4491 # at end-of-function, with the previous line a single leading tab, then return;
4492 # and the line before that not a goto label target like "out:"
4500 }
4502 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4508 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4513 }
4514 }
4516 # comparisons with a constant or upper case identifier on the left
4517 # avoid cases like "foo + BAR < baz"
4518 # only fix matches surrounded by parentheses to avoid incorrect
4519 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4540 }
4542 }
4543 }
4545 # Return of what appears to be an errno should normally be negative
4551 }
4552 }
4554 # Need a space before open parenthesis after if, while etc
4561 }
4562 }
4564 # Check for illegal assignment in if conditional -- and check for trailing
4565 # statements after the conditional.
4573 ##print "stat<$stat> stat_next<$stat_next>\n";
4576 # If the statement carries leading newlines,
4577 # then count those as offsets.
4585 }
4586 }
4595 }
4597 # Find out what is on the end of the line after the
4598 # conditional.
4604 {
4605 # Find out how long the conditional actually is.
4614 }
4618 }
4619 }
4621 # Check for bitwise tests written as boolean
4627 |
4632 {
4635 }
4637 # if and else should not have general statements after it
4644 }
4645 }
4646 # if should not continue a brace
4651 }
4652 # case and default should not have general statements after them
4658 {
4661 }
4663 # Check for }<nl>else {, these must be at the same
4664 # indent level to be relevant to each other.
4676 }
4680 }
4681 }
4687 # Find out what is on the end of the line after the
4688 # conditional.
4704 }
4705 }
4706 }
4708 #Specific variable tests
4712 #gcc binary extension
4720 }
4721 }
4723 #CamelCase
4726 #Ignore Page<foo> variants
4728 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4730 #Ignore some three character SI units explicitly, like MiB and KHz
4736 seed_camelcase_includes();
4740 }
4741 }
4746 }
4747 }
4748 }
4749 }
4751 #no spaces allowed after \ in define
4757 }
4758 }
4760 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4761 # itself <asm/foo.h> (uses RAW line)
4768 {
4777 }
4778 }
4779 }
4780 }
4782 # multi-statement macros should be enclosed in a do while loop, grab the
4783 # first statement and ensure its the whole macro if its not enclosed
4784 # in a known good container
4796 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4797 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4811 }
4818 # Flatten any parentheses and braces
4822 {
4823 }
4825 # Flatten any obvious string concatentation.
4828 {
4829 }
4831 # Make asm volatile uses seem like a generic function
4836 module_param_named|
4837 MODULE_PARM_DESC|
4838 DECLARE_PER_CPU|
4839 DEFINE_PER_CPU|
4840 __typeof__\(|
4841 union|
4842 struct|
4847 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4855 }
4860 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4865 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4871 {
4874 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4881 }
4883 }
4885 # Make $define_stmt single line, comment-free, etc
4896 }
4897 }
4902 # check if any macro arguments are reused (ignore '...' and 'type')
4907 $tmp =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
4914 }
4915 # check if any macro arguments may have other precedence issues
4921 }
4922 }
4924 # check for macros with flow control, but without ## concatenation
4925 # ## concatenation is commonly a macro that defines a function so ignore those
4932 }
4935 }
4937 # check for line continuations outside of #defines, preprocessor #, and asm
4946 }
4947 }
4949 # do {} while (0) macro tests:
4950 # single-statement macros do not need to be enclosed in do while (0) loop,
4951 # macro should not end with a semicolon
4966 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4976 }
4982 }
4986 }
4994 }
4998 }
4999 }
5001 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5002 # all assignments may have only one of the following with an assignment:
5003 # .
5004 # ALIGN(...)
5005 # VMLINUX_SYMBOL(...)
5009 }
5011 # check for redundant bracing round if etc
5015 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5016 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5026 # If the condition carries leading newlines, then count those as offsets.
5031 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5033 # We have looked at and allowed this specific line.
5043 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5045 #print "APW: ALLOWED: cond<$cond>\n";
5047 }
5049 #print "APW: ALLOWED: block<$block>\n";
5051 }
5053 #print "APW: ALLOWED: lines block<$block>\n";
5055 }
5057 }
5062 }
5070 }
5071 }
5072 }
5073 }
5078 # Check the pre-context.
5080 #print "APW: ALLOWED: pre<$1>\n";
5082 }
5087 # Check the condition.
5089 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5092 }
5094 #print "APW: ALLOWED: cond<$cond>\n";
5096 }
5098 #print "APW: ALLOWED: block<$block>\n";
5100 }
5102 #print "APW: ALLOWED: lines block<$block>\n";
5104 }
5105 # Check the post-context.
5110 }
5112 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5114 }
5115 }
5122 }
5126 }
5127 }
5129 # check for single line unbalanced braces
5133 }
5135 # check for unnecessary blank lines around braces
5141 }
5142 }
5148 }
5149 }
5151 # no volatiles please
5155 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5156 }
5158 # Check for user-visible strings broken across lines, which breaks the ability
5159 # to grep for the string. Make exceptions when the previous string ends in a
5160 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5161 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5174 }
5186 }
5188 }
5189 }
5191 # check for missing a space in a string concatenation
5195 }
5197 # check for an embedded function name in a string when the function is known
5198 # This does not work very well for -f --file checking as it depends on patch
5199 # context providing the function name or a single line form for in-file
5200 # function declarations
5206 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5207 }
5209 # check for spaces before a quoted newline
5215 }
5217 }
5219 # concatenated string without spaces between elements
5223 }
5225 # uncoalesced string fragments
5229 }
5231 # check for non-standard and hex prefixed decimal printf formats
5237 # check for %L
5242 }
5243 # check for %Z
5248 }
5249 # check for 0x<decimal>
5253 }
5254 }
5256 # check for line continuations in quoted strings with odd counts of "
5260 }
5262 # warn about #if 0
5267 }
5269 # check for needless "if (<foo>) fn(<foo>)" uses
5273 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5285 }
5290 }
5293 }
5297 }
5298 }
5299 }
5300 }
5302 # check for unnecessary "Out of Memory" messages
5311 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5313 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5316 }
5317 }
5319 # check for logging functions with KERN_<LEVEL>
5327 }
5328 }
5330 # check for logging continuations
5334 }
5336 # check for mask then right shift without a parentheses
5342 }
5344 # check for pointer comparisons to NULL
5354 }
5355 }
5356 }
5358 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5361 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5371 $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;
5372 }
5373 }
5374 }
5376 # check for $InitAttributeData (ie: __initdata) with const
5387 }
5388 }
5390 # check for $InitAttributeConst (ie: __initconst) without const
5402 }
5403 }
5405 # check for __read_mostly with const non-pointer (should just be const)
5412 }
5413 }
5415 # don't use __constant_<foo> functions outside of include/uapi/
5417 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5425 }
5426 }
5428 # prefer usleep_range over udelay
5431 # ignore udelay's < 10, however
5434 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5435 }
5439 }
5440 }
5442 # warn about unexpectedly long msleep's
5446 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5447 }
5448 }
5450 # check for comparisons of jiffies
5453 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5454 }
5456 # check for comparisons of get_jiffies_64()
5459 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5460 }
5462 # warn about #ifdefs in C files
5463 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5464 # print "#ifdef in C files should be avoided\n";
5465 # print "$herecurr";
5466 # $clean = 0;
5467 # }
5469 # warn about spacing in #ifdefs
5476 }
5478 }
5480 # check for spinlock_t definitions without a comment.
5487 }
5488 }
5489 # check for memory barriers without a comment.
5492 mb|
5493 rmb|
5494 wmb|
5495 read_barrier_depends
5498 mb__before_atomic|
5499 mb__after_atomic|
5500 store_release|
5501 load_acquire|
5502 store_mb|
5515 }
5516 }
5526 }
5528 # check for waitqueue_active without a comment.
5533 }
5534 }
5536 # Check for expedited grace periods that interrupt non-idle non-nohz
5537 # online CPUs. These expedited can therefore degrade real-time response
5538 # if used carelessly, and should be avoided where not absolutely
5539 # needed. It is always OK to use synchronize_rcu_expedited() and
5540 # synchronize_sched_expedited() at boot time (before real-time applications
5541 # start) and in error situations where real-time response is compromised in
5542 # any case. Note that synchronize_srcu_expedited() does -not- interrupt
5543 # other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5544 # Of course, nothing comes for free, and srcu_read_lock() and
5545 # srcu_read_unlock() do contain full memory barriers in payment for
5546 # synchronize_srcu_expedited() non-interruption properties.
5549 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5551 }
5553 # check of hardware specific defines
5554 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5557 }
5559 # Check that the storage class is at the beginning of a declaration
5563 }
5565 # check the location of the inline attribute, that it is between
5566 # storage class and type.
5571 }
5573 # Check for __inline__ and __inline, prefer inline
5581 }
5582 }
5584 # Check for __attribute__ packed, prefer __packed
5589 }
5591 # Check for __attribute__ aligned, prefer __aligned
5596 }
5598 # Check for __attribute__ format(printf, prefer __printf
5602 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5604 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5606 }
5607 }
5609 # Check for __attribute__ format(scanf, prefer __scanf
5613 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5615 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5616 }
5617 }
5619 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5621 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5626 }
5628 # check for c99 types like uint8_t used outside of uapi/ and tools/
5643 }
5644 }
5645 }
5647 # check for cast of C90 native int or longer types constants
5662 }
5664 }
5665 }
5667 # check for sizeof(&)
5671 }
5673 # check for sizeof without parenthesis
5678 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5679 }
5680 }
5682 # check for struct spinlock declarations
5686 }
5688 # check for seq_printf uses that could be seq_puts
5697 }
5698 }
5699 }
5701 # check for vsprintf extension %p<foo> misuses
5715 }
5716 }
5721 }
5724 }
5725 }
5727 # Check for misused memsets
5742 }
5743 }
5745 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5746 # if ($^V && $^V ge 5.10.0 &&
5747 # defined $stat &&
5748 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5749 # if (WARN("PREFER_ETHER_ADDR_COPY",
5750 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5751 # $fix) {
5752 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5753 # }
5754 # }
5756 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5757 # if ($^V && $^V ge 5.10.0 &&
5758 # defined $stat &&
5759 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5760 # WARN("PREFER_ETHER_ADDR_EQUAL",
5761 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5762 # }
5764 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5765 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5766 # if ($^V && $^V ge 5.10.0 &&
5767 # defined $stat &&
5768 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5769 #
5770 # my $ms_val = $7;
5771 #
5772 # if ($ms_val =~ /^(?:0x|)0+$/i) {
5773 # if (WARN("PREFER_ETH_ZERO_ADDR",
5774 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5775 # $fix) {
5776 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5777 # }
5778 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5779 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
5780 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5781 # $fix) {
5782 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5783 # }
5784 # }
5785 # }
5787 # typecasts on min/max could be min_t/max_t
5805 }
5808 }
5809 }
5811 # check usleep_range arguments
5819 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5823 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5824 }
5825 }
5827 # check for naked sscanf
5839 }
5842 }
5844 # check for simple sscanf that should be kstrto<foo>
5853 }
5861 }
5862 }
5863 }
5865 # check for new externs in .h files.
5872 }
5873 }
5875 # check for new externs in .c files.
5878 {
5885 }
5888 {
5891 }
5896 }
5900 {
5903 }
5914 }
5915 }
5916 }
5918 # checks for new __setup's
5924 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
5925 }
5926 }
5928 # check for pointless casting of kmalloc return
5931 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5932 }
5934 # alloc style
5935 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5937 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5940 }
5942 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5945 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5956 }
5964 }
5969 $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;
5970 }
5971 }
5972 }
5974 # check for krealloc arg reuse
5979 }
5981 # check for alloc argument mismatch
5985 }
5987 # check for multiple semicolons
5993 }
5994 }
5996 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6005 }
6006 }
6008 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6009 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6015 }
6016 }
6018 # check for case / default statements not preceded by break/fallthrough/switch
6036 }
6040 }
6041 }
6043 # check for switch/default statements without a break;
6052 }
6055 }
6057 # check for gcc specific __FUNCTION__
6063 }
6064 }
6066 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6070 }
6072 # check for use of yield()
6076 }
6078 # check for comparisons against true and false
6094 }
6099 ## maybe suggesting a correct construct would better
6100 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6102 }
6103 }
6105 # check for semaphores initialized locked
6109 }
6111 # recommend kstrto* over simple_strto* and strict_strto*
6115 }
6117 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6120 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6121 }
6123 # check for various structs that are normally const (ops, kgdb, device_tree)
6124 # and avoid what seem like struct definitions 'struct foo {'
6129 }
6131 # use of NR_CPUS is usually wrong
6132 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6139 {
6141 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6142 }
6144 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6148 }
6150 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6155 }
6157 # whine mightly about in_atomic
6165 }
6166 }
6168 # whine about ACCESS_ONCE
6179 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6180 }
6186 }
6187 }
6188 }
6190 # check for mutex_trylock_recursive usage
6194 }
6196 # check for lockdep_set_novalidate_class
6204 }
6205 }
6210 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6211 }
6213 # Mode permission misuses where it seems decimal should be octal
6214 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6227 }
6233 }
6242 }
6245 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6246 }
6247 }
6248 }
6249 }
6251 # check for uses of S_<PERMS> that could be octal for readability
6268 }
6273 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6276 }
6277 }
6279 # validate content of MODULE_LICENSE against list from include/linux/module.h
6283 GPL|
6284 GPL\ v2|
6289 Proprietary
6294 }
6295 }
6296 }
6298 # If we have no input at all, then there is nothing to report on
6299 # so just keep quiet.
6302 }
6304 # In mailback mode only produce a report in the negative, for
6305 # things that appear to be patches.
6308 }
6310 # This is not a patch, and we are are in 'no-patch' mode so
6311 # just keep quiet.
6314 }
6319 }
6323 }
6331 }
6334 # If there were any defects found and not already fixing them
6340 EOM
6341 }
6342 # If there were whitespace errors which cleanpatch can fix
6343 # then suggest that.
6350 EOM
6351 }
6352 }
6372 }
6375 }
6376 }
6384 Do _NOT_ trust the results written to this file.
6387 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6389 EOM
6390 }
6391 }
6399 }
6400 }
6402 }