| blob | 2287a0bca863bf57ffabaae9de58aab0174826c3 |
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 }
150 }
155 }
158 }
180 }
181 }
184 }
186 # Perl's Getopt::Long allows options to take optional arguments after a space.
187 # Prevent --color by itself from consuming other arguments
191 }
192 }
194 GetOptions(
244 }
245 }
247 #if no filenames are given, push '-' to read patch from stdin
250 }
262 }
278 }
279 }
288 }
290 }
291 }
301 ## no critic
304 }
311 }
317 }
324 }
325 }
330 }
331 }
341 __user|
342 __kernel|
343 __force|
344 __iomem|
345 __must_check|
346 __init_refok|
347 __kprobes|
348 __ref|
349 __rcu|
350 __private
358 # Notes to $Attribute:
359 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
361 const|
362 __percpu|
363 __nocast|
364 __safe|
365 __bitwise|
366 __packed__|
367 __packed2__|
368 __naked|
369 __maybe_unused|
370 __always_unused|
371 __noreturn|
372 __used|
373 __cold|
374 __pure|
375 __noclone|
376 __deprecated|
377 __read_mostly|
378 __kprobes|
380 ____cacheline_aligned|
381 ____cacheline_aligned_in_smp|
382 ____cacheline_internodealigned_in_smp|
383 __weak
405 <=|>=|==|!=|
406 =>|->|<<|>>|<|>|!|~|
440 )};
443 atomic_t
444 )};
449 )};
455 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
457 panic|
460 )};
469 To:|
470 Cc:
471 )};
490 );
513 );
534 )};
541 );
545 );
552 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
559 );
561 #Create a search pattern for all these functions to speed up a loop below
566 }
569 S_IWUGO |
570 S_IWOTH |
571 S_IRWXUGO |
572 S_IALLUGO |
593 );
595 #Create a search pattern for all these strings to speed up a loop below
600 }
603 irq|
604 memory|
606 reboot
607 )};
608 # memory.h: ARM has a custom one
610 # Load common spelling mistakes and build regular expression list.
627 }
631 }
650 }
654 }
655 }
674 }
678 }
681 }
684 }
694 }
713 )
720 )
729 )
733 $NonptrType
738 $NonptrTypeMisordered
744 }
745 build_types();
749 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
750 # requires at least perl version v5.10.0
751 # Any use must be runtime checked with $^V
761 )};
770 }
775 }
799 }
800 }
801 }
808 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
811 }
835 }
837 }
845 }
849 }
854 }
858 }
866 }
868 }
869 }
883 # Maybe one day convert this block of bash into something that returns
884 # all matching commit ids, but it's very slow...
885 #
886 # echo "checking commits $1..."
887 # git rev-list --remotes | grep -i "^$1" |
888 # while read line ; do
889 # git log --format='%H %s' -1 $line |
890 # echo "commit $(cut -c 1-12,41-)"
891 # done
892 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
897 }
900 }
911 # If input is git commits, extract all commits from the commit expressions.
912 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
925 }
934 }
935 }
938 }
954 }
961 }
965 }
972 }
976 }
985 build_types();
986 }
997 EOM
998 }
1004 EOM
1005 }
1006 }
1017 );
1022 }
1023 }
1025 }
1048 # If there's a name left after stripping spaces and
1049 # leading quotes, and the address doesn't have both
1050 # leading and trailing angle brackets, the address
1051 # is invalid. ie:
1052 # "joe smith joe@smith.com" bad
1053 # "joe smith <joe@smith.com" bad
1058 }
1059 }
1069 }
1072 }
1086 }
1092 }
1095 }
1103 }
1104 }
1107 }
1115 }
1116 }
1119 }
1132 }
1134 }
1137 }
1140 }
1144 }
1149 # Drop the diff line leader and expand tabs
1153 # Pick the indent from the front of the line.
1157 }
1168 }
1169 }
1180 # Always copy over the diff marker.
1186 # Comments we are wacking completly including the begin
1187 # and end, all to $;.
1194 }
1200 }
1207 }
1209 # A \ in a string means ignore the next character.
1215 }
1216 # Regular quotes.
1225 }
1226 }
1228 #print "c<$c> SQ<$sanitise_quote>\n";
1237 }
1238 }
1242 }
1244 # The pathname on a #include may be surrounded by '<' and '>'.
1249 # The whole of a #error is a string.
1253 }
1258 }
1261 }
1268 }
1291 #warn "CSB: blk<$blk> remain<$remain>\n";
1292 # If we are about to drop off the end, pull in more
1293 # context.
1304 }
1305 # Bail if there is no further context.
1306 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1309 }
1313 }
1314 }
1319 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1321 # Handle nested #if/#else.
1328 }
1330 # Statement ends at the ';' or a close '}' at the
1331 # outermost level.
1334 }
1336 # An else is really a conditional as long as its not else if
1343 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1344 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1345 }
1350 }
1358 #warn "CSB: mark coff<$coff>\n";
1359 }
1360 }
1364 }
1372 }
1374 }
1375 }
1376 # Preprocessor commands end at the newline unless escaped.
1382 }
1384 }
1385 # We are truly at the end, so shuffle to the next line.
1390 }
1395 #warn "STATEMENT<$statement>\n";
1396 #warn "CONDITION<$condition>\n";
1398 #print "coff<$coff> soff<$off> loff<$loff>\n";
1402 }
1407 # Strip the diff line prefixes and rip blank lines at start and end.
1415 }
1423 }
1444 }
1445 }
1453 # Grab the first conditional/block pair.
1456 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1460 }
1462 # Pull in the following conditional/block pairs and see if they
1463 # could continue the statement.
1467 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1469 #print "C: push\n";
1471 }
1474 }
1493 # Handle nested #if/#else.
1500 }
1503 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1507 }
1514 }
1515 }
1519 }
1522 }
1525 }
1531 }
1537 }
1543 }
1548 }
1553 }
1558 # Catch a comment on the end of the line itself.
1562 # Look through the context and try and figure out if there is a
1563 # comment.
1568 #warn " $line\n";
1571 }
1574 }
1577 }
1581 }
1582 }
1586 }
1591 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1592 ##print "CMMT: $cmt\n";
1595 }
1608 }
1611 }
1623 }
1624 }
1628 }
1640 }
1660 }
1681 }
1710 # Assume all arms of the conditional end as this
1711 # one does, and continue as if the #endif was not here.
1728 }
1759 }
1771 }
1804 }
1819 }
1828 }
1832 }
1836 }
1837 }
1840 }
1849 DEFINE_\S+
1850 )$|
1854 case|
1858 \#|
1859 \#\#|
1865 # Check for modifiers.
1876 }
1877 }
1882 }
1883 build_types();
1886 }
1887 }
1899 }
1907 }
1916 }
1917 }
1922 }
1930 }
1936 }
1940 }
1951 }
1952 }
1979 }
1985 }
1992 }
1997 }
2000 }
2003 }
2011 };
2013 }
2021 };
2024 }
2033 }
2035 }
2043 }
2045 }
2053 }
2055 }
2061 ##print "absolute<$absolute>\n";
2063 # See if any suffix of this path is a path within the tree.
2066 ##print "file<$file>\n";
2068 }
2069 }
2072 }
2074 # It is, so see if the prefix is acceptable.
2078 ##print "prefix<$prefix>\n";
2082 }
2083 }
2091 }
2099 }
2107 }
2115 }
2124 #convert leading spaces to tabs
2126 #Remove spaces before a tab
2130 }
2144 }
2156 }
2157 }
2160 }
2197 # Trace the real file/line as we go.
2210 # suppression flags
2218 # Pre-scan the patch sanitizing the lines.
2219 # Pre-scan the patch looking for any __setup documentation.
2220 #
2226 sanitise_line_reset();
2238 }
2239 #next;
2240 }
2247 }
2250 # Guestimate if this is a continuing comment. Run
2251 # the context looking for a comment "edge". If this
2252 # edge is a close comment then we must be in a comment
2253 # at context start.
2260 #print "RAW<$rawlines[$ln - 1]>\n";
2266 }
2267 }
2270 }
2272 # Guestimate if this is a continuing comment. If this
2273 # is the start of a diff block and this line starts
2274 # ' *' then it is very likely a comment.
2277 {
2279 }
2281 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2285 # Standardise the strings and chars within the input to
2286 # simplify matching -- only bother with positive lines.
2288 }
2295 }
2297 #print "==>$rawline\n";
2298 #print "-->$line\n";
2302 }
2303 }
2318 #extract the line range in the file after the patch is applied
2329 }
2330 annotate_reset();
2341 }
2344 # track the line number as we move through the hunk, note that
2345 # new versions of GNU diff omit the leading space on completely
2346 # blank context lines so we need to count that too.
2351 # Measure the line length and indent.
2354 # Track the previous line.
2359 #warn "line<$line>\n";
2363 }
2371 # extract the filename as it passes
2387 }
2391 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2392 }
2394 }
2396 #make up the handle for any error we report on this line
2404 }
2405 }
2410 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2411 }
2416 }
2418 }
2428 # Check if the commit log has what seems like a diff which can confuse patch
2437 }
2439 # Check for incorrect file permissions
2446 }
2447 }
2449 # Check the patch for a signoff:
2453 }
2455 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2456 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2459 }
2461 # Check signature styles
2473 }
2480 }
2481 }
2488 }
2490 }
2497 }
2498 }
2509 # Don't force email to have quotes
2510 # Allow just an angle bracketed address
2516 }
2517 }
2519 # Check for duplicate signatures
2528 }
2529 }
2531 # Check email subject for common tools that don't need to be mentioned
2536 }
2538 # Check for old stable address
2542 }
2544 # Check for unwanted Gerrit info
2548 }
2550 # Check if the commit log is in a possible stack dump
2554 # timestamp
2556 # stack dump address
2558 }
2560 # Check for line lengths > 75 in commit log, warn once
2564 # file delta changes
2566 # filename then :
2568 # A Fixes: or Link: line
2573 }
2575 # Reset possible stack dump if a blank line is found
2579 }
2581 # Check for git id commit length and improperly formed commit descriptions
2606 }
2628 }
2636 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2637 }
2638 }
2640 # Check for added, moved or deleted files
2650 }
2652 # Check for wrappage within a valid hunk of the file
2657 }
2659 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2670 }
2672 # Check if it's the start of a commit log
2673 # (not a header line and we haven't seen the patch filename)
2680 }
2682 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2683 # declined it, i.e defined some charset where it is missing.
2688 }
2694 }
2696 # Check for absolute kernel paths in commit message
2703 #
2706 }
2707 }
2708 }
2710 # Check for various typo / spelling mistakes
2724 }
2725 }
2726 }
2728 # ignore non-hunk lines and lines being removed
2731 #trailing whitespace
2738 }
2745 }
2748 }
2750 # Check for FSF mailing addresses.
2759 "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)
2760 }
2762 # check for Kconfig help text having a real description
2763 # Only applies when adding the entry originally, after that we do not have
2764 # sufficient context to determine whether it is indeed long enough.
2785 }
2794 }
2796 }
2800 }
2801 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2802 }
2804 # check for MAINTAINERS entries that don't have the right form
2812 }
2813 }
2815 # discourage the use of boolean for type definition attributes of Kconfig options
2820 }
2830 };
2833 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2834 }
2836 # check for DT compatible documentation
2855 }
2862 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2863 }
2864 }
2865 }
2867 # check we are in a valid source file if not then ignore this hunk
2870 # line length limit (with some exclusions)
2871 #
2872 # There are a few types of lines that may extend beyond $max_line_length:
2873 # logging functions like pr_info that end in a string
2874 # lines with a single string
2875 # #defines that are a single string
2876 #
2877 # There are 3 different line length message types:
2878 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2879 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2880 # LONG_LINE all other lines longer than $max_line_length
2881 #
2882 # if LONG_LINE is ignored, the other 2 types are also ignored
2883 #
2888 # Check the allowed long line types first
2890 # logging functions that end in a string that starts
2891 # before $max_line_length
2892 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2896 # lines with only strings (w/ possible termination)
2897 # #defines with only strings
2902 # EFI_GUID is another special case
2906 # Otherwise set the alternate message types
2908 # a comment starts before $max_line_length
2913 # a quoted string starts before $max_line_length
2917 }
2923 }
2924 }
2926 # check for adding lines without a newline.
2927 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2930 }
2932 # Blackfin: use hi/lo macros
2938 }
2943 }
2944 }
2946 # check we are in a valid source file C or perl if not then ignore this hunk
2949 # at the beginning of a line any tabs must come first and anything
2950 # more than 8 must use tabs.
2959 }
2960 }
2962 # check for space before tabs.
2972 }
2973 }
2975 # check for && or || at the start of a line
2979 }
2981 # check indentation starts on a tab stop
2990 }
2991 }
2992 }
2994 # check multi-line statement indentation matches previous line
2996 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3019 }
3020 }
3021 }
3022 }
3024 # check for space after cast like "(int) foo" or "(struct foo) bar"
3025 # avoid checking a few false positives:
3026 # "sizeof(<type>)" or "__alignof__(<type>)"
3027 # function pointer declarations like "(*foo)(int) = bar;"
3028 # structure definitions like "(struct foo) { 0 };"
3029 # multiline macros that define functions
3030 # known attributes or the __attribute__ keyword
3038 }
3039 }
3041 # Block comment styles
3042 # Networking with an initial /*
3049 }
3051 # Block comments use * on subsequent lines
3059 }
3061 # Block comments use */ on trailing lines
3068 }
3070 # Block comment * alignment
3084 }
3091 }
3092 }
3094 # check for missing blank lines after struct/union declarations
3095 # with exceptions for various attributes and macros
3110 }
3111 }
3113 # check for multiple consecutive blank lines
3121 }
3124 }
3126 # check for missing blank lines after declarations
3128 # actual declarations
3130 # function pointer declarations
3132 # foo bar; where foo is some local typedef or #define
3134 # known declaration macros
3136 # for "else if" which can look like "$Ident $Ident"
3138 # other possible extensions of declaration lines
3140 # not starting a section or a macro "\" extended line
3142 # looks like a declaration
3144 # function pointer declarations
3146 # foo bar; where foo is some local typedef or #define
3148 # known declaration macros
3150 # start of struct or union or enum
3152 # start or end of block or continuation of declaration
3154 # bitfield continuation
3156 # other possible extensions of declaration lines
3158 # indentation of previous and current line are the same
3164 }
3165 }
3167 # check for spaces at the beginning of a line.
3168 # Exceptions:
3169 # 1) within comments
3170 # 2) indented preprocessor commands
3171 # 3) hanging labels
3178 }
3179 }
3181 # check we are in a valid C source file if not then ignore this hunk
3184 # check if this appears to be the start function declaration, save the name
3188 }
3190 # check if this appears to be the end of function declaration
3193 }
3195 # check indentation of any line with a bare else
3196 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3197 # if the previous line is a break or return and is indented 1 tab more...
3206 }
3207 }
3209 # check indentation of a line with a break;
3210 # if the previous line is a goto or return and is indented the same # of tabs
3216 }
3217 }
3219 # check for RCS/CVS revision markers
3223 }
3225 # Blackfin: don't use __builtin_bfin_[cs]sync
3230 }
3235 }
3237 # check for old HOTPLUG __dev<foo> section markings
3241 }
3243 # Check for potential 'bare' types
3246 #print "LINE<$line>\n";
3254 #print "linenr<$linenr> <$stat>\n";
3255 # If this statement has no statement boundaries within
3256 # it there is no point in retrying a statement scan
3257 # until we hit end of it.
3260 #print "skip<$line_nr_next>\n";
3262 }
3264 # Find the real next line.
3270 }
3275 # Ignore goto labels.
3278 # Ignore functions being called
3283 # declarations always start with types
3284 } 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) {
3289 # definitions in global scope can only start with types
3292 }
3294 # any (foo ... *) is a pointer cast, and foo is a type
3297 }
3299 # Check for any sort of function declaration.
3300 # int foo(something bar, other baz);
3301 # void (*store_gdt)(x86_descr_ptr *);
3302 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3310 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3313 }
3314 }
3315 }
3317 }
3319 #
3320 # Checks which may be anchored in the context.
3321 #
3323 # Check for switch () and associated case and default
3324 # statements should be at the same indent.
3338 }
3339 }
3343 }
3344 }
3346 # if/while/etc brace do not go on next line, unless defining a do while loop,
3347 # or if that brace on the next line is for something else
3348 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3356 }
3367 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3370 }
3372 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3373 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3379 }
3383 {
3389 }
3390 }
3391 }
3393 # Check relative indent for conditionals and blocks.
3394 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3402 # remove inline comments
3406 # Find out how long the conditional actually is.
3410 # Make sure we remove the line prefixes as we have
3411 # none on the first line, and are going to readd them
3412 # where necessary.
3416 }
3418 # We want to check the first line inside the block
3419 # starting at the end of the conditional, so remove:
3420 # 1) any blank line termination
3421 # 2) any opening brace { on end of the line
3422 # 3) any do (...) {
3429 }
3433 }
3435 # Also ignore a loop construct at the end of a
3436 # preprocessor statement.
3440 }
3447 # If we see an #else/#elif then the code
3448 # is not linear.
3451 }
3453 # Ignore:
3454 # 1) blank lines, they should be at 0,
3455 # 2) preprocessor lines, and
3456 # 3) labels.
3464 }
3465 }
3466 }
3471 # Check if either of these lines are modified, else
3472 # this is not this patch's fault.
3476 }
3479 }
3481 #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";
3490 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3491 }
3492 }
3494 # Track the 'values' across context and added lines.
3504 }
3507 #ignore lines not being added
3510 # check for dereferences that span multiple lines
3520 }
3522 # check for declarations of signed or unsigned without int
3523 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3534 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3542 }
3543 }
3544 }
3546 # TEST: allow direct testing of the type matcher.
3554 }
3556 }
3557 # TEST: allow direct testing of the attribute matcher.
3565 }
3567 }
3569 # check for initialisation to aggregates open brace on the next line
3583 }
3584 }
3586 #
3587 # Checks which are anchored on the added line.
3588 #
3590 # check for malformed paths in #include statements (uses RAW line)
3596 }
3600 }
3601 }
3603 # no C99 // comments
3612 }
3613 }
3614 }
3615 # Remove C99 comments.
3619 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3620 # the whole statement.
3621 #print "APW <$lines[$realline_next - 1]>\n";
3627 # Handle definitions which produce identifiers with
3628 # a prefix:
3629 # XXX(foo);
3630 # EXPORT_SYMBOL(something_foo);
3634 #print "FOO C name<$name>\n";
3645 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3649 }
3650 }
3655 #print "FOO B <$lines[$linenr - 1]>\n";
3657 }
3662 }
3664 # check for global initialisers.
3670 }
3671 }
3672 # check for static initialisers.
3679 }
3680 }
3682 # check for misordered declarations of char/short/int/long with signed/unsigned
3686 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3687 }
3689 # check for static const char * arrays.
3694 }
3696 # check for static char foo[] = "bar" declarations.
3701 }
3703 # check for const <foo> const where <foo> is not a pointer or array type
3712 }
3713 }
3715 # check for non-global char *foo[] = {"bar", ...} declarations.
3720 }
3722 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3725 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3731 }
3732 }
3733 }
3735 # check for function declarations without arguments like "int foo()"
3741 }
3742 }
3744 # check for new typedefs, only function parameters and sparse annotations
3745 # make sense.
3753 }
3755 # * goes on variable not on type
3756 # (char*[ const])
3758 #print "AA<$1>\n";
3761 # Should start with a space.
3763 # Should not end with a space.
3765 # '*'s should not have spaces between.
3767 }
3769 ## print "1: from<$from> to<$to> ident<$ident>\n";
3779 }
3780 }
3781 }
3783 #print "BB<$1>\n";
3786 # Should start with a space.
3788 # Should not end with a space.
3790 # '*'s should not have spaces between.
3792 }
3793 # Modifiers should have spaces.
3796 ## print "2: from<$from> to<$to> ident<$ident>\n";
3807 }
3808 }
3809 }
3811 # avoid BUG() or BUG_ON()
3816 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3817 }
3819 # avoid LINUX_VERSION_CODE
3822 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3823 }
3825 # check for uses of printk_ratelimit
3829 }
3831 # printk should use KERN_* levels. Note that follow on printk's on the
3832 # same line do not need a level, so we use the current block context
3833 # to try and find and validate the current printk. In summary the current
3834 # printk includes all preceding printk's which have no newline on the end.
3835 # we assume the first bad printk is the one to report.
3839 #print "CHECK<$lines[$ln - 1]\n";
3840 # we have a preceding printk if it ends
3841 # with "\n" ignore it, else it is to blame
3845 }
3847 }
3848 }
3852 }
3853 }
3862 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3863 }
3871 }
3872 }
3881 }
3883 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3884 # number of false positives, but assembly files are not checked, so at
3885 # least the arch entry code will not trigger this warning.
3889 }
3891 # function brace can't be on same line, except for #defines of do while,
3892 # or if closed on same line
3907 }
3908 }
3909 }
3911 # open braces for enum, union and struct go on the same line.
3925 }
3926 }
3927 }
3929 # missing space after union, struct or enum definition
3936 }
3937 }
3939 # Function pointer declarations
3940 # check spacing between type, funcptr, and args
3941 # canonical declaration is "type (*funcptr)(args...)"
3950 # the $Declare variable will capture all spaces after the type
3951 # so check it for a missing trailing missing space but pointer return types
3952 # don't need a space so don't warn for those.
3957 }
3962 }
3964 # unnecessary space "type (*funcptr)(args...)"
3965 # This test is not currently implemented because these declarations are
3966 # equivalent to
3967 # int foo(int bar, ...)
3968 # and this is form shouldn't/doesn't generate a checkpatch warning.
3969 #
3970 # elsif ($declare =~ /\s{2,}$/) {
3971 # WARN("SPACING",
3972 # "Multiple spaces after return type\n" . $herecurr);
3973 # }
3975 # unnecessary space "type ( *funcptr)(args...)"
3980 }
3982 # unnecessary space "type (* funcptr)(args...)"
3987 }
3989 # unnecessary space "type (*funcptr )(args...)"
3994 }
3996 # unnecessary space "type (*funcptr) (args...)"
4001 }
4005 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4006 }
4007 }
4009 # check for spacing round square brackets; allowed:
4010 # 1. with a type on the left -- int [] a;
4011 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4012 # 3. inside a curly brace -- = { [0...10] = 5 }
4023 }
4024 }
4025 }
4027 # check for spaces between functions and their parentheses.
4033 # Ignore those directives where spaces _are_ permitted.
4039 {
4040 # cpp #define statements have non-optional spaces, ie
4041 # if there is a space between the name and the open
4042 # parenthesis it is simply not a parameter group.
4045 # cpp #elif statement condition may start with a (
4048 # If this whole things ends with a type its most
4049 # likely a typedef for a function.
4058 }
4059 }
4060 }
4062 # Check operator spacing.
4068 <<=|>>=|<=|>=|==|!=|
4070 =>|->|<<|>>|<|>|=|!|~|
4076 ## print("element count: <" . $#elements . ">\n");
4077 ## foreach my $el (@elements) {
4078 ## print("el: <$el>\n");
4079 ## }
4087 }
4098 ## print("n: <$n> good: <$good>\n");
4102 # Pick up the preceding and succeeding characters.
4107 }
4130 }
4139 # Pull out the value of this operator.
4142 # Get the full operator variant.
4145 # Ignore operators passed as parameters.
4149 # # Ignore comments
4150 # } elsif ($op =~ /^$;+$/) {
4152 # ; should have either the end of line or a space or \ after it
4160 }
4161 }
4163 # // is a comment
4166 # : when part of a bitfield
4168 # skip the bitfield test for now
4170 # No spaces for:
4171 # ->
4179 }
4181 }
4182 }
4184 # , must not have a space before and must have a space on the right.
4193 }
4194 }
4201 }
4202 }
4208 }
4211 }
4212 }
4214 # '*' as part of a type definition -- reported already.
4216 #warn "'*' is part of type\n";
4218 # unary operators should have a space before and
4219 # none after. May be left adjacent to another
4220 # unary operator, or a cast
4230 }
4231 }
4232 }
4234 # A unary '*' may be const
4242 }
4244 }
4245 }
4247 # unary ++ and unary -- are allowed no space on one side.
4254 }
4255 }
4262 }
4263 }
4270 }
4272 }
4273 }
4275 # << and >> may either have or not have spaces both sides
4281 {
4289 }
4295 }
4296 }
4303 }
4305 }
4306 }
4308 # A colon needs no spaces before when it is
4309 # terminating a case value or a label.
4316 }
4317 }
4319 # All the others need spaces both sides.
4323 # Ignore email addresses <foo@bar>
4328 {
4330 }
4332 # for asm volatile statements
4333 # ignore a colon with another
4334 # colon immediately before or after
4338 }
4340 # messages are ERROR, but ?: are CHK
4350 }
4352 }
4353 }
4354 }
4357 ## print("n: <$n> GOOD: <$good>\n");
4360 }
4364 }
4368 }
4371 }
4373 # check for whitespace before a non-naked semicolon
4380 }
4381 }
4383 # check for multiple assignments
4387 }
4389 ## # check for multiple declarations, allowing for a function declaration
4390 ## # continuation.
4391 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4392 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4393 ##
4394 ## # Remove any bracketed sections to ensure we do not
4395 ## # falsly report the parameters of functions.
4396 ## my $ln = $line;
4397 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4398 ## }
4399 ## if ($ln =~ /,/) {
4400 ## WARN("MULTIPLE_DECLARATION",
4401 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4402 ## }
4403 ## }
4405 #need space before brace following if, while, etc
4412 }
4413 }
4415 ## # check for blank lines before declarations
4416 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4417 ## $prevrawline =~ /^.\s*$/) {
4418 ## WARN("SPACING",
4419 ## "No blank lines before declarations\n" . $hereprev);
4420 ## }
4421 ##
4423 # closing brace should have a space following it when it has anything
4424 # on the line
4431 }
4432 }
4434 # check spacing on square brackets
4441 }
4442 }
4449 }
4450 }
4452 # check spacing on parentheses
4460 }
4461 }
4470 }
4471 }
4473 # check unnecessary parentheses around addressof/dereference single $Lvals
4474 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4482 }
4483 }
4485 # check for unnecessary parentheses around function pointer uses
4486 # ie: (foo->bar)(); should be foo->bar();
4487 # but not "if (foo->bar) (" to avoid some false positives
4496 }
4497 }
4499 #goto labels aren't indented, allow a single space however
4507 }
4508 }
4510 # return is not a function
4520 }
4524 }
4525 }
4527 # unnecessary return in a void function
4528 # at end-of-function, with the previous line a single leading tab, then return;
4529 # and the line before that not a goto label target like "out:"
4537 }
4539 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4545 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4550 }
4551 }
4553 # comparisons with a constant or upper case identifier on the left
4554 # avoid cases like "foo + BAR < baz"
4555 # only fix matches surrounded by parentheses to avoid incorrect
4556 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4577 }
4579 }
4580 }
4582 # Return of what appears to be an errno should normally be negative
4588 }
4589 }
4591 # Need a space before open parenthesis after if, while etc
4598 }
4599 }
4601 # Check for illegal assignment in if conditional -- and check for trailing
4602 # statements after the conditional.
4610 ##print "stat<$stat> stat_next<$stat_next>\n";
4613 # If the statement carries leading newlines,
4614 # then count those as offsets.
4622 }
4623 }
4632 }
4634 # Find out what is on the end of the line after the
4635 # conditional.
4641 {
4642 # Find out how long the conditional actually is.
4651 }
4655 }
4656 }
4658 # Check for bitwise tests written as boolean
4664 |
4669 {
4672 }
4674 # if and else should not have general statements after it
4681 }
4682 }
4683 # if should not continue a brace
4688 }
4689 # case and default should not have general statements after them
4695 {
4698 }
4700 # Check for }<nl>else {, these must be at the same
4701 # indent level to be relevant to each other.
4713 }
4717 }
4718 }
4724 # Find out what is on the end of the line after the
4725 # conditional.
4741 }
4742 }
4743 }
4745 #Specific variable tests
4749 #gcc binary extension
4757 }
4758 }
4760 #CamelCase
4763 #Ignore Page<foo> variants
4765 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4767 #Ignore some three character SI units explicitly, like MiB and KHz
4773 seed_camelcase_includes();
4777 }
4778 }
4783 }
4784 }
4785 }
4786 }
4788 #no spaces allowed after \ in define
4794 }
4795 }
4797 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4798 # itself <asm/foo.h> (uses RAW line)
4805 {
4814 }
4815 }
4816 }
4817 }
4819 # multi-statement macros should be enclosed in a do while loop, grab the
4820 # first statement and ensure its the whole macro if its not enclosed
4821 # in a known good container
4833 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4834 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4848 }
4855 # Flatten any parentheses and braces
4859 {
4860 }
4862 # Flatten any obvious string concatentation.
4865 {
4866 }
4868 # Make asm volatile uses seem like a generic function
4873 module_param_named|
4874 MODULE_PARM_DESC|
4875 DECLARE_PER_CPU|
4876 DEFINE_PER_CPU|
4877 __typeof__\(|
4878 union|
4879 struct|
4884 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4892 }
4897 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4902 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4908 {
4911 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
4918 }
4920 }
4922 # Make $define_stmt single line, comment-free, etc
4933 }
4934 }
4939 # check if any macro arguments are reused (ignore '...' and 'type')
4944 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
4951 }
4952 # check if any macro arguments may have other precedence issues
4958 }
4959 }
4961 # check for macros with flow control, but without ## concatenation
4962 # ## concatenation is commonly a macro that defines a function so ignore those
4969 }
4972 }
4974 # check for line continuations outside of #defines, preprocessor #, and asm
4983 }
4984 }
4986 # do {} while (0) macro tests:
4987 # single-statement macros do not need to be enclosed in do while (0) loop,
4988 # macro should not end with a semicolon
5003 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5013 }
5019 }
5023 }
5031 }
5035 }
5036 }
5038 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
5039 # all assignments may have only one of the following with an assignment:
5040 # .
5041 # ALIGN(...)
5042 # VMLINUX_SYMBOL(...)
5046 }
5048 # check for redundant bracing round if etc
5052 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5053 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5063 # If the condition carries leading newlines, then count those as offsets.
5068 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5070 # We have looked at and allowed this specific line.
5080 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5082 #print "APW: ALLOWED: cond<$cond>\n";
5084 }
5086 #print "APW: ALLOWED: block<$block>\n";
5088 }
5090 #print "APW: ALLOWED: lines block<$block>\n";
5092 }
5094 }
5099 }
5107 }
5108 }
5109 }
5110 }
5115 # Check the pre-context.
5117 #print "APW: ALLOWED: pre<$1>\n";
5119 }
5124 # Check the condition.
5126 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5129 }
5131 #print "APW: ALLOWED: cond<$cond>\n";
5133 }
5135 #print "APW: ALLOWED: block<$block>\n";
5137 }
5139 #print "APW: ALLOWED: lines block<$block>\n";
5141 }
5142 # Check the post-context.
5147 }
5149 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5151 }
5152 }
5159 }
5163 }
5164 }
5166 # check for single line unbalanced braces
5170 }
5172 # check for unnecessary blank lines around braces
5178 }
5179 }
5185 }
5186 }
5188 # no volatiles please
5192 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5193 }
5195 # Check for user-visible strings broken across lines, which breaks the ability
5196 # to grep for the string. Make exceptions when the previous string ends in a
5197 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5198 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5211 }
5223 }
5225 }
5226 }
5228 # check for missing a space in a string concatenation
5232 }
5234 # check for an embedded function name in a string when the function is known
5235 # This does not work very well for -f --file checking as it depends on patch
5236 # context providing the function name or a single line form for in-file
5237 # function declarations
5243 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5244 }
5246 # check for spaces before a quoted newline
5252 }
5254 }
5256 # concatenated string without spaces between elements
5260 }
5262 # uncoalesced string fragments
5266 }
5268 # check for non-standard and hex prefixed decimal printf formats
5274 # check for %L
5279 }
5280 # check for %Z
5285 }
5286 # check for 0x<decimal>
5290 }
5291 }
5293 # check for line continuations in quoted strings with odd counts of "
5297 }
5299 # warn about #if 0
5304 }
5306 # check for needless "if (<foo>) fn(<foo>)" uses
5310 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5322 }
5327 }
5330 }
5334 }
5335 }
5336 }
5337 }
5339 # check for unnecessary "Out of Memory" messages
5348 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5350 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)/) {
5353 }
5354 }
5356 # check for logging functions with KERN_<LEVEL>
5364 }
5365 }
5367 # check for logging continuations
5371 }
5373 # check for mask then right shift without a parentheses
5379 }
5381 # check for pointer comparisons to NULL
5391 }
5392 }
5393 }
5395 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5398 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5408 $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;
5409 }
5410 }
5411 }
5413 # check for $InitAttributeData (ie: __initdata) with const
5424 }
5425 }
5427 # check for $InitAttributeConst (ie: __initconst) without const
5439 }
5440 }
5442 # check for __read_mostly with const non-pointer (should just be const)
5449 }
5450 }
5452 # don't use __constant_<foo> functions outside of include/uapi/
5454 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5462 }
5463 }
5465 # prefer usleep_range over udelay
5468 # ignore udelay's < 10, however
5471 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5472 }
5476 }
5477 }
5479 # warn about unexpectedly long msleep's
5483 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5484 }
5485 }
5487 # check for comparisons of jiffies
5490 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5491 }
5493 # check for comparisons of get_jiffies_64()
5496 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5497 }
5499 # warn about #ifdefs in C files
5500 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5501 # print "#ifdef in C files should be avoided\n";
5502 # print "$herecurr";
5503 # $clean = 0;
5504 # }
5506 # warn about spacing in #ifdefs
5513 }
5515 }
5517 # check for spinlock_t definitions without a comment.
5524 }
5525 }
5526 # check for memory barriers without a comment.
5529 mb|
5530 rmb|
5531 wmb|
5532 read_barrier_depends
5535 mb__before_atomic|
5536 mb__after_atomic|
5537 store_release|
5538 load_acquire|
5539 store_mb|
5552 }
5553 }
5563 }
5565 # check for waitqueue_active without a comment.
5570 }
5571 }
5573 # check of hardware specific defines
5574 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5577 }
5579 # check that the storage class is not after a type
5583 }
5584 # Check that the storage class is at the beginning of a declaration
5591 }
5593 # check the location of the inline attribute, that it is between
5594 # storage class and type.
5599 }
5601 # Check for __inline__ and __inline, prefer inline
5609 }
5610 }
5612 # Check for __attribute__ packed, prefer __packed
5617 }
5619 # Check for __attribute__ aligned, prefer __aligned
5624 }
5626 # Check for __attribute__ format(printf, prefer __printf
5630 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5632 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5634 }
5635 }
5637 # Check for __attribute__ format(scanf, prefer __scanf
5641 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5643 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5644 }
5645 }
5647 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5649 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5654 }
5656 # check for c99 types like uint8_t used outside of uapi/ and tools/
5671 }
5672 }
5673 }
5675 # check for cast of C90 native int or longer types constants
5690 }
5692 }
5693 }
5695 # check for sizeof(&)
5699 }
5701 # check for sizeof without parenthesis
5706 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5707 }
5708 }
5710 # check for struct spinlock declarations
5714 }
5716 # check for seq_printf uses that could be seq_puts
5725 }
5726 }
5727 }
5729 # check for vsprintf extension %p<foo> misuses
5743 }
5744 }
5749 }
5752 }
5753 }
5755 # Check for misused memsets
5770 }
5771 }
5773 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5774 # if ($^V && $^V ge 5.10.0 &&
5775 # defined $stat &&
5776 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5777 # if (WARN("PREFER_ETHER_ADDR_COPY",
5778 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5779 # $fix) {
5780 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5781 # }
5782 # }
5784 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5785 # if ($^V && $^V ge 5.10.0 &&
5786 # defined $stat &&
5787 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5788 # WARN("PREFER_ETHER_ADDR_EQUAL",
5789 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5790 # }
5792 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5793 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5794 # if ($^V && $^V ge 5.10.0 &&
5795 # defined $stat &&
5796 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5797 #
5798 # my $ms_val = $7;
5799 #
5800 # if ($ms_val =~ /^(?:0x|)0+$/i) {
5801 # if (WARN("PREFER_ETH_ZERO_ADDR",
5802 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5803 # $fix) {
5804 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5805 # }
5806 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5807 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
5808 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5809 # $fix) {
5810 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5811 # }
5812 # }
5813 # }
5815 # typecasts on min/max could be min_t/max_t
5833 }
5836 }
5837 }
5839 # check usleep_range arguments
5847 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5851 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5852 }
5853 }
5855 # check for naked sscanf
5867 }
5870 }
5872 # check for simple sscanf that should be kstrto<foo>
5881 }
5889 }
5890 }
5891 }
5893 # check for new externs in .h files.
5900 }
5901 }
5903 # check for new externs in .c files.
5906 {
5913 }
5916 {
5919 }
5924 }
5928 {
5931 }
5933 # check for function declarations that have arguments without identifier names
5943 }
5944 }
5945 }
5947 # check for function definitions
5953 # check for multiline function definition with misplaced open brace
5963 }
5967 }
5968 }
5970 # checks for new __setup's
5976 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
5977 }
5978 }
5980 # check for pointless casting of kmalloc return
5983 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5984 }
5986 # alloc style
5987 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5989 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5992 }
5994 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5997 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6008 }
6016 }
6021 $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;
6022 }
6023 }
6024 }
6026 # check for krealloc arg reuse
6031 }
6033 # check for alloc argument mismatch
6037 }
6039 # check for multiple semicolons
6045 }
6046 }
6048 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6057 }
6058 }
6060 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6061 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6067 }
6068 }
6070 # check for case / default statements not preceded by break/fallthrough/switch
6088 }
6092 }
6093 }
6095 # check for switch/default statements without a break;
6104 }
6107 }
6109 # check for gcc specific __FUNCTION__
6115 }
6116 }
6118 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6122 }
6124 # check for use of yield()
6128 }
6130 # check for comparisons against true and false
6146 }
6151 ## maybe suggesting a correct construct would better
6152 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6154 }
6155 }
6157 # check for semaphores initialized locked
6161 }
6163 # recommend kstrto* over simple_strto* and strict_strto*
6167 }
6169 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6172 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6173 }
6175 # check for various structs that are normally const (ops, kgdb, device_tree)
6176 # and avoid what seem like struct definitions 'struct foo {'
6181 }
6183 # use of NR_CPUS is usually wrong
6184 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6191 {
6193 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6194 }
6196 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6200 }
6202 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6207 }
6209 # whine mightly about in_atomic
6217 }
6218 }
6220 # whine about ACCESS_ONCE
6231 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6232 }
6238 }
6239 }
6240 }
6242 # check for mutex_trylock_recursive usage
6246 }
6248 # check for lockdep_set_novalidate_class
6256 }
6257 }
6262 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6263 }
6265 # Mode permission misuses where it seems decimal should be octal
6266 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6279 }
6285 }
6294 }
6297 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6298 }
6299 }
6300 }
6301 }
6303 # check for uses of S_<PERMS> that could be octal for readability
6320 }
6325 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6328 }
6329 }
6331 # validate content of MODULE_LICENSE against list from include/linux/module.h
6335 GPL|
6336 GPL\ v2|
6341 Proprietary
6346 }
6347 }
6348 }
6350 # If we have no input at all, then there is nothing to report on
6351 # so just keep quiet.
6354 }
6356 # In mailback mode only produce a report in the negative, for
6357 # things that appear to be patches.
6360 }
6362 # This is not a patch, and we are are in 'no-patch' mode so
6363 # just keep quiet.
6366 }
6371 }
6375 }
6383 }
6386 # If there were any defects found and not already fixing them
6392 EOM
6393 }
6394 # If there were whitespace errors which cleanpatch can fix
6395 # then suggest that.
6402 EOM
6403 }
6404 }
6424 }
6427 }
6428 }
6436 Do _NOT_ trust the results written to this file.
6439 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6441 EOM
6442 }
6443 }
6451 }
6452 }
6454 }