| blob | 982c52ca6473569148dbffb5585a46888149bf48 |
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
68 Options:
73 --emacs emacs compile window format
74 --terse one line per report
77 single git commit with:
81 multiple git commits with:
85 git merges are ignored
100 is all off)
102 literally
105 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
106 with potential errors corrected to the preferred
107 checkpatch style
112 runtime errors.
115 --codespellfile Use this codespell dictionary
120 EOM
123 }
128 }
146 }
151 }
154 }
176 }
177 }
180 }
182 GetOptions(
229 }
230 }
232 #if no filenames are given, push '-' to read patch from stdin
235 }
251 }
252 }
261 }
263 }
264 }
274 ## no critic
277 }
284 }
290 }
297 }
298 }
303 }
304 }
314 __user|
315 __kernel|
316 __force|
317 __iomem|
318 __must_check|
319 __init_refok|
320 __kprobes|
321 __ref|
322 __rcu|
323 __private
331 # Notes to $Attribute:
332 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
334 const|
335 __percpu|
336 __nocast|
337 __safe|
338 __bitwise|
339 __packed__|
340 __packed2__|
341 __naked|
342 __maybe_unused|
343 __always_unused|
344 __noreturn|
345 __used|
346 __cold|
347 __pure|
348 __noclone|
349 __deprecated|
350 __read_mostly|
351 __kprobes|
353 ____cacheline_aligned|
354 ____cacheline_aligned_in_smp|
355 ____cacheline_internodealigned_in_smp|
356 __weak
378 <=|>=|==|!=|
379 =>|->|<<|>>|<|>|!|~|
413 )};
416 atomic_t
417 )};
422 )};
428 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
430 panic|
433 )};
442 To:|
443 Cc:
444 )};
463 );
486 );
507 )};
514 );
518 );
525 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
532 );
534 #Create a search pattern for all these functions to speed up a loop below
539 }
542 S_IWUGO |
543 S_IWOTH |
544 S_IRWXUGO |
545 S_IALLUGO |
566 );
568 #Create a search pattern for all these strings to speed up a loop below
573 }
576 irq|
577 memory|
579 reboot
580 )};
581 # memory.h: ARM has a custom one
583 # Load common spelling mistakes and build regular expression list.
600 }
604 }
623 }
627 }
628 }
645 }
649 }
653 }
671 )
678 )
687 )
691 $NonptrType
696 $NonptrTypeMisordered
702 }
703 build_types();
707 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
708 # requires at least perl version v5.10.0
709 # Any use must be runtime checked with $^V
719 )};
728 }
733 }
757 }
758 }
759 }
766 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
769 }
793 }
795 }
803 }
807 }
812 }
816 }
824 }
826 }
827 }
841 # Maybe one day convert this block of bash into something that returns
842 # all matching commit ids, but it's very slow...
843 #
844 # echo "checking commits $1..."
845 # git rev-list --remotes | grep -i "^$1" |
846 # while read line ; do
847 # git log --format='%H %s' -1 $line |
848 # echo "commit $(cut -c 1-12,41-)"
849 # done
850 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
854 }
857 }
868 # If input is git commits, extract all commits from the commit expressions.
869 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
882 }
891 }
892 }
895 }
911 }
918 }
922 }
929 }
933 }
942 build_types();
943 }
954 EOM
955 }
961 EOM
962 }
963 }
974 );
979 }
980 }
982 }
1005 # If there's a name left after stripping spaces and
1006 # leading quotes, and the address doesn't have both
1007 # leading and trailing angle brackets, the address
1008 # is invalid. ie:
1009 # "joe smith joe@smith.com" bad
1010 # "joe smith <joe@smith.com" bad
1015 }
1016 }
1026 }
1029 }
1043 }
1049 }
1052 }
1060 }
1061 }
1064 }
1072 }
1073 }
1076 }
1089 }
1091 }
1094 }
1097 }
1101 }
1106 # Drop the diff line leader and expand tabs
1110 # Pick the indent from the front of the line.
1114 }
1125 }
1126 }
1137 # Always copy over the diff marker.
1143 # Comments we are wacking completly including the begin
1144 # and end, all to $;.
1151 }
1157 }
1164 }
1166 # A \ in a string means ignore the next character.
1172 }
1173 # Regular quotes.
1182 }
1183 }
1185 #print "c<$c> SQ<$sanitise_quote>\n";
1194 }
1195 }
1199 }
1201 # The pathname on a #include may be surrounded by '<' and '>'.
1206 # The whole of a #error is a string.
1210 }
1215 }
1218 }
1225 }
1248 #warn "CSB: blk<$blk> remain<$remain>\n";
1249 # If we are about to drop off the end, pull in more
1250 # context.
1261 }
1262 # Bail if there is no further context.
1263 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1266 }
1270 }
1271 }
1276 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1278 # Handle nested #if/#else.
1285 }
1287 # Statement ends at the ';' or a close '}' at the
1288 # outermost level.
1291 }
1293 # An else is really a conditional as long as its not else if
1300 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1301 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1302 }
1307 }
1315 #warn "CSB: mark coff<$coff>\n";
1316 }
1317 }
1321 }
1329 }
1331 }
1332 }
1333 # Preprocessor commands end at the newline unless escaped.
1339 }
1341 }
1342 # We are truly at the end, so shuffle to the next line.
1347 }
1352 #warn "STATEMENT<$statement>\n";
1353 #warn "CONDITION<$condition>\n";
1355 #print "coff<$coff> soff<$off> loff<$loff>\n";
1359 }
1364 # Strip the diff line prefixes and rip blank lines at start and end.
1372 }
1380 }
1401 }
1402 }
1410 # Grab the first conditional/block pair.
1413 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1417 }
1419 # Pull in the following conditional/block pairs and see if they
1420 # could continue the statement.
1424 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1426 #print "C: push\n";
1428 }
1431 }
1450 # Handle nested #if/#else.
1457 }
1460 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1464 }
1471 }
1472 }
1476 }
1479 }
1482 }
1488 }
1494 }
1500 }
1505 }
1510 }
1515 # Catch a comment on the end of the line itself.
1519 # Look through the context and try and figure out if there is a
1520 # comment.
1525 #warn " $line\n";
1528 }
1531 }
1534 }
1538 }
1539 }
1543 }
1548 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1549 ##print "CMMT: $cmt\n";
1552 }
1565 }
1568 }
1580 }
1581 }
1585 }
1597 }
1617 }
1638 }
1667 # Assume all arms of the conditional end as this
1668 # one does, and continue as if the #endif was not here.
1685 }
1716 }
1728 }
1761 }
1776 }
1785 }
1789 }
1793 }
1794 }
1797 }
1806 DEFINE_\S+
1807 )$|
1811 case|
1815 \#|
1816 \#\#|
1822 # Check for modifiers.
1833 }
1834 }
1839 }
1840 build_types();
1843 }
1844 }
1854 }
1862 }
1871 }
1872 }
1877 }
1885 }
1891 }
1895 }
1906 }
1907 }
1934 }
1940 }
1947 }
1952 }
1955 }
1958 }
1966 };
1968 }
1976 };
1979 }
1988 }
1990 }
1998 }
2000 }
2008 }
2010 }
2016 ##print "absolute<$absolute>\n";
2018 # See if any suffix of this path is a path within the tree.
2021 ##print "file<$file>\n";
2023 }
2024 }
2027 }
2029 # It is, so see if the prefix is acceptable.
2033 ##print "prefix<$prefix>\n";
2037 }
2038 }
2046 }
2054 }
2062 }
2070 }
2079 #convert leading spaces to tabs
2081 #Remove spaces before a tab
2085 }
2099 }
2111 }
2112 }
2115 }
2152 # Trace the real file/line as we go.
2164 # suppression flags
2172 # Pre-scan the patch sanitizing the lines.
2173 # Pre-scan the patch looking for any __setup documentation.
2174 #
2180 sanitise_line_reset();
2192 }
2193 #next;
2194 }
2201 }
2204 # Guestimate if this is a continuing comment. Run
2205 # the context looking for a comment "edge". If this
2206 # edge is a close comment then we must be in a comment
2207 # at context start.
2214 #print "RAW<$rawlines[$ln - 1]>\n";
2220 }
2221 }
2224 }
2226 # Guestimate if this is a continuing comment. If this
2227 # is the start of a diff block and this line starts
2228 # ' *' then it is very likely a comment.
2231 {
2233 }
2235 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2239 # Standardise the strings and chars within the input to
2240 # simplify matching -- only bother with positive lines.
2242 }
2249 }
2251 #print "==>$rawline\n";
2252 #print "-->$line\n";
2256 }
2257 }
2272 #extract the line range in the file after the patch is applied
2282 }
2283 annotate_reset();
2292 # track the line number as we move through the hunk, note that
2293 # new versions of GNU diff omit the leading space on completely
2294 # blank context lines so we need to count that too.
2299 # Measure the line length and indent.
2302 # Track the previous line.
2307 #warn "line<$line>\n";
2311 }
2319 # extract the filename as it passes
2335 }
2339 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2340 }
2342 }
2344 #make up the handle for any error we report on this line
2352 }
2353 }
2358 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2359 }
2364 }
2366 }
2376 # Check if the commit log has what seems like a diff which can confuse patch
2385 }
2387 # Check for incorrect file permissions
2394 }
2395 }
2397 # Check the patch for a signoff:
2401 }
2403 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2404 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2407 }
2409 # Check signature styles
2421 }
2428 }
2429 }
2436 }
2438 }
2445 }
2446 }
2457 # Don't force email to have quotes
2458 # Allow just an angle bracketed address
2464 }
2465 }
2467 # Check for duplicate signatures
2476 }
2477 }
2479 # Check email subject for common tools that don't need to be mentioned
2484 }
2486 # Check for old stable address
2490 }
2492 # Check for unwanted Gerrit info
2496 }
2498 # Check if the commit log is in a possible stack dump
2502 # timestamp
2504 # stack dump address
2506 }
2508 # Check for line lengths > 75 in commit log, warn once
2512 # file delta changes
2514 # filename then :
2516 # A Fixes: or Link: line
2521 }
2523 # Reset possible stack dump if a blank line is found
2527 }
2529 # Check for git id commit length and improperly formed commit descriptions
2553 }
2575 }
2582 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2583 }
2584 }
2586 # Check for added, moved or deleted files
2596 }
2598 # Check for wrappage within a valid hunk of the file
2603 }
2605 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2616 }
2618 # Check if it's the start of a commit log
2619 # (not a header line and we haven't seen the patch filename)
2626 }
2628 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2629 # declined it, i.e defined some charset where it is missing.
2634 }
2640 }
2642 # Check for absolute kernel paths in commit message
2649 #
2652 }
2653 }
2654 }
2656 # Check for various typo / spelling mistakes
2670 }
2671 }
2672 }
2674 # ignore non-hunk lines and lines being removed
2677 #trailing whitespace
2684 }
2691 }
2694 }
2696 # Check for FSF mailing addresses.
2704 "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)
2705 }
2707 # check for Kconfig help text having a real description
2708 # Only applies when adding the entry originally, after that we do not have
2709 # sufficient context to determine whether it is indeed long enough.
2730 }
2739 }
2741 }
2745 }
2746 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2747 }
2749 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2753 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2754 }
2756 # discourage the use of boolean for type definition attributes of Kconfig options
2761 }
2771 };
2774 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2775 }
2777 # check for DT compatible documentation
2796 }
2803 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2804 }
2805 }
2806 }
2808 # check we are in a valid source file if not then ignore this hunk
2811 # line length limit (with some exclusions)
2812 #
2813 # There are a few types of lines that may extend beyond $max_line_length:
2814 # logging functions like pr_info that end in a string
2815 # lines with a single string
2816 # #defines that are a single string
2817 #
2818 # There are 3 different line length message types:
2819 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2820 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2821 # LONG_LINE all other lines longer than $max_line_length
2822 #
2823 # if LONG_LINE is ignored, the other 2 types are also ignored
2824 #
2829 # Check the allowed long line types first
2831 # logging functions that end in a string that starts
2832 # before $max_line_length
2833 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2837 # lines with only strings (w/ possible termination)
2838 # #defines with only strings
2843 # EFI_GUID is another special case
2847 # Otherwise set the alternate message types
2849 # a comment starts before $max_line_length
2854 # a quoted string starts before $max_line_length
2858 }
2864 }
2865 }
2867 # check for adding lines without a newline.
2868 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2871 }
2873 # Blackfin: use hi/lo macros
2879 }
2884 }
2885 }
2887 # check we are in a valid source file C or perl if not then ignore this hunk
2890 # at the beginning of a line any tabs must come first and anything
2891 # more than 8 must use tabs.
2900 }
2901 }
2903 # check for space before tabs.
2913 }
2914 }
2916 # check for && or || at the start of a line
2920 }
2922 # check indentation starts on a tab stop
2931 }
2932 }
2933 }
2935 # check multi-line statement indentation matches previous line
2937 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2960 }
2961 }
2962 }
2963 }
2965 # check for space after cast like "(int) foo" or "(struct foo) bar"
2966 # avoid checking a few false positives:
2967 # "sizeof(<type>)" or "__alignof__(<type>)"
2968 # function pointer declarations like "(*foo)(int) = bar;"
2969 # structure definitions like "(struct foo) { 0 };"
2970 # multiline macros that define functions
2971 # known attributes or the __attribute__ keyword
2979 }
2980 }
2982 # Block comment styles
2983 # Networking with an initial /*
2990 }
2992 # Block comments use * on subsequent lines
3000 }
3002 # Block comments use */ on trailing lines
3009 }
3011 # Block comment * alignment
3025 }
3032 }
3033 }
3035 # check for missing blank lines after struct/union declarations
3036 # with exceptions for various attributes and macros
3051 }
3052 }
3054 # check for multiple consecutive blank lines
3062 }
3065 }
3067 # check for missing blank lines after declarations
3069 # actual declarations
3071 # function pointer declarations
3073 # foo bar; where foo is some local typedef or #define
3075 # known declaration macros
3077 # for "else if" which can look like "$Ident $Ident"
3079 # other possible extensions of declaration lines
3081 # not starting a section or a macro "\" extended line
3083 # looks like a declaration
3085 # function pointer declarations
3087 # foo bar; where foo is some local typedef or #define
3089 # known declaration macros
3091 # start of struct or union or enum
3093 # start or end of block or continuation of declaration
3095 # bitfield continuation
3097 # other possible extensions of declaration lines
3099 # indentation of previous and current line are the same
3105 }
3106 }
3108 # check for spaces at the beginning of a line.
3109 # Exceptions:
3110 # 1) within comments
3111 # 2) indented preprocessor commands
3112 # 3) hanging labels
3119 }
3120 }
3122 # check we are in a valid C source file if not then ignore this hunk
3125 # check indentation of any line with a bare else
3126 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3127 # if the previous line is a break or return and is indented 1 tab more...
3136 }
3137 }
3139 # check indentation of a line with a break;
3140 # if the previous line is a goto or return and is indented the same # of tabs
3146 }
3147 }
3149 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3152 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3153 }
3155 # check for RCS/CVS revision markers
3159 }
3161 # Blackfin: don't use __builtin_bfin_[cs]sync
3166 }
3171 }
3173 # check for old HOTPLUG __dev<foo> section markings
3177 }
3179 # Check for potential 'bare' types
3182 #print "LINE<$line>\n";
3190 #print "linenr<$linenr> <$stat>\n";
3191 # If this statement has no statement boundaries within
3192 # it there is no point in retrying a statement scan
3193 # until we hit end of it.
3196 #print "skip<$line_nr_next>\n";
3198 }
3200 # Find the real next line.
3206 }
3211 # Ignore goto labels.
3214 # Ignore functions being called
3219 # declarations always start with types
3220 } 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) {
3225 # definitions in global scope can only start with types
3228 }
3230 # any (foo ... *) is a pointer cast, and foo is a type
3233 }
3235 # Check for any sort of function declaration.
3236 # int foo(something bar, other baz);
3237 # void (*store_gdt)(x86_descr_ptr *);
3238 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3246 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3249 }
3250 }
3251 }
3253 }
3255 #
3256 # Checks which may be anchored in the context.
3257 #
3259 # Check for switch () and associated case and default
3260 # statements should be at the same indent.
3274 }
3275 }
3279 }
3280 }
3282 # if/while/etc brace do not go on next line, unless defining a do while loop,
3283 # or if that brace on the next line is for something else
3284 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3292 }
3303 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3306 }
3308 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3309 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3315 }
3319 {
3325 }
3326 }
3327 }
3329 # Check relative indent for conditionals and blocks.
3330 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3338 # remove inline comments
3342 # Find out how long the conditional actually is.
3346 # Make sure we remove the line prefixes as we have
3347 # none on the first line, and are going to readd them
3348 # where necessary.
3352 }
3354 # We want to check the first line inside the block
3355 # starting at the end of the conditional, so remove:
3356 # 1) any blank line termination
3357 # 2) any opening brace { on end of the line
3358 # 3) any do (...) {
3365 }
3369 }
3371 # Also ignore a loop construct at the end of a
3372 # preprocessor statement.
3376 }
3383 # If we see an #else/#elif then the code
3384 # is not linear.
3387 }
3389 # Ignore:
3390 # 1) blank lines, they should be at 0,
3391 # 2) preprocessor lines, and
3392 # 3) labels.
3400 }
3401 }
3402 }
3407 # Check if either of these lines are modified, else
3408 # this is not this patch's fault.
3412 }
3415 }
3417 #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";
3424 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3425 }
3426 }
3428 # Track the 'values' across context and added lines.
3438 }
3441 #ignore lines not being added
3444 # check for dereferences that span multiple lines
3454 }
3456 # check for declarations of signed or unsigned without int
3457 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3468 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3476 }
3477 }
3478 }
3480 # TEST: allow direct testing of the type matcher.
3488 }
3490 }
3491 # TEST: allow direct testing of the attribute matcher.
3499 }
3501 }
3503 # check for initialisation to aggregates open brace on the next line
3517 }
3518 }
3520 #
3521 # Checks which are anchored on the added line.
3522 #
3524 # check for malformed paths in #include statements (uses RAW line)
3530 }
3534 }
3535 }
3537 # no C99 // comments
3546 }
3547 }
3548 }
3549 # Remove C99 comments.
3553 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3554 # the whole statement.
3555 #print "APW <$lines[$realline_next - 1]>\n";
3561 # Handle definitions which produce identifiers with
3562 # a prefix:
3563 # XXX(foo);
3564 # EXPORT_SYMBOL(something_foo);
3568 #print "FOO C name<$name>\n";
3579 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3583 }
3584 }
3589 #print "FOO B <$lines[$linenr - 1]>\n";
3591 }
3596 }
3598 # check for global initialisers.
3604 }
3605 }
3606 # check for static initialisers.
3613 }
3614 }
3616 # check for misordered declarations of char/short/int/long with signed/unsigned
3620 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3621 }
3623 # check for static const char * arrays.
3628 }
3630 # check for static char foo[] = "bar" declarations.
3635 }
3637 # check for const <foo> const where <foo> is not a pointer or array type
3646 }
3647 }
3649 # check for non-global char *foo[] = {"bar", ...} declarations.
3654 }
3656 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3659 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3665 }
3666 }
3667 }
3669 # check for function declarations without arguments like "int foo()"
3675 }
3676 }
3678 # check for new typedefs, only function parameters and sparse annotations
3679 # make sense.
3687 }
3689 # * goes on variable not on type
3690 # (char*[ const])
3692 #print "AA<$1>\n";
3695 # Should start with a space.
3697 # Should not end with a space.
3699 # '*'s should not have spaces between.
3701 }
3703 ## print "1: from<$from> to<$to> ident<$ident>\n";
3713 }
3714 }
3715 }
3717 #print "BB<$1>\n";
3720 # Should start with a space.
3722 # Should not end with a space.
3724 # '*'s should not have spaces between.
3726 }
3727 # Modifiers should have spaces.
3730 ## print "2: from<$from> to<$to> ident<$ident>\n";
3741 }
3742 }
3743 }
3745 # avoid BUG() or BUG_ON()
3750 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3751 }
3753 # avoid LINUX_VERSION_CODE
3756 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3757 }
3759 # check for uses of printk_ratelimit
3763 }
3765 # printk should use KERN_* levels. Note that follow on printk's on the
3766 # same line do not need a level, so we use the current block context
3767 # to try and find and validate the current printk. In summary the current
3768 # printk includes all preceding printk's which have no newline on the end.
3769 # we assume the first bad printk is the one to report.
3773 #print "CHECK<$lines[$ln - 1]\n";
3774 # we have a preceding printk if it ends
3775 # with "\n" ignore it, else it is to blame
3779 }
3781 }
3782 }
3786 }
3787 }
3796 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3797 }
3805 }
3806 }
3815 }
3817 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3818 # number of false positives, but assembly files are not checked, so at
3819 # least the arch entry code will not trigger this warning.
3823 }
3825 # function brace can't be on same line, except for #defines of do while,
3826 # or if closed on same line
3841 }
3842 }
3843 }
3845 # open braces for enum, union and struct go on the same line.
3859 }
3860 }
3861 }
3863 # missing space after union, struct or enum definition
3870 }
3871 }
3873 # Function pointer declarations
3874 # check spacing between type, funcptr, and args
3875 # canonical declaration is "type (*funcptr)(args...)"
3884 # the $Declare variable will capture all spaces after the type
3885 # so check it for a missing trailing missing space but pointer return types
3886 # don't need a space so don't warn for those.
3891 }
3896 }
3898 # unnecessary space "type (*funcptr)(args...)"
3899 # This test is not currently implemented because these declarations are
3900 # equivalent to
3901 # int foo(int bar, ...)
3902 # and this is form shouldn't/doesn't generate a checkpatch warning.
3903 #
3904 # elsif ($declare =~ /\s{2,}$/) {
3905 # WARN("SPACING",
3906 # "Multiple spaces after return type\n" . $herecurr);
3907 # }
3909 # unnecessary space "type ( *funcptr)(args...)"
3914 }
3916 # unnecessary space "type (* funcptr)(args...)"
3921 }
3923 # unnecessary space "type (*funcptr )(args...)"
3928 }
3930 # unnecessary space "type (*funcptr) (args...)"
3935 }
3939 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3940 }
3941 }
3943 # check for spacing round square brackets; allowed:
3944 # 1. with a type on the left -- int [] a;
3945 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3946 # 3. inside a curly brace -- = { [0...10] = 5 }
3957 }
3958 }
3959 }
3961 # check for spaces between functions and their parentheses.
3967 # Ignore those directives where spaces _are_ permitted.
3973 {
3974 # cpp #define statements have non-optional spaces, ie
3975 # if there is a space between the name and the open
3976 # parenthesis it is simply not a parameter group.
3979 # cpp #elif statement condition may start with a (
3982 # If this whole things ends with a type its most
3983 # likely a typedef for a function.
3992 }
3993 }
3994 }
3996 # Check operator spacing.
4002 <<=|>>=|<=|>=|==|!=|
4004 =>|->|<<|>>|<|>|=|!|~|
4010 ## print("element count: <" . $#elements . ">\n");
4011 ## foreach my $el (@elements) {
4012 ## print("el: <$el>\n");
4013 ## }
4021 }
4032 ## print("n: <$n> good: <$good>\n");
4036 # Pick up the preceding and succeeding characters.
4041 }
4064 }
4073 # Pull out the value of this operator.
4076 # Get the full operator variant.
4079 # Ignore operators passed as parameters.
4083 # # Ignore comments
4084 # } elsif ($op =~ /^$;+$/) {
4086 # ; should have either the end of line or a space or \ after it
4094 }
4095 }
4097 # // is a comment
4100 # : when part of a bitfield
4102 # skip the bitfield test for now
4104 # No spaces for:
4105 # ->
4113 }
4115 }
4116 }
4118 # , must not have a space before and must have a space on the right.
4127 }
4128 }
4135 }
4136 }
4142 }
4145 }
4146 }
4148 # '*' as part of a type definition -- reported already.
4150 #warn "'*' is part of type\n";
4152 # unary operators should have a space before and
4153 # none after. May be left adjacent to another
4154 # unary operator, or a cast
4164 }
4165 }
4166 }
4168 # A unary '*' may be const
4176 }
4178 }
4179 }
4181 # unary ++ and unary -- are allowed no space on one side.
4188 }
4189 }
4196 }
4197 }
4204 }
4206 }
4207 }
4209 # << and >> may either have or not have spaces both sides
4215 {
4223 }
4229 }
4230 }
4237 }
4239 }
4240 }
4242 # A colon needs no spaces before when it is
4243 # terminating a case value or a label.
4250 }
4251 }
4253 # All the others need spaces both sides.
4257 # Ignore email addresses <foo@bar>
4262 {
4264 }
4266 # for asm volatile statements
4267 # ignore a colon with another
4268 # colon immediately before or after
4272 }
4274 # messages are ERROR, but ?: are CHK
4284 }
4286 }
4287 }
4288 }
4291 ## print("n: <$n> GOOD: <$good>\n");
4294 }
4298 }
4302 }
4305 }
4307 # check for whitespace before a non-naked semicolon
4314 }
4315 }
4317 # check for multiple assignments
4321 }
4323 ## # check for multiple declarations, allowing for a function declaration
4324 ## # continuation.
4325 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4326 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4327 ##
4328 ## # Remove any bracketed sections to ensure we do not
4329 ## # falsly report the parameters of functions.
4330 ## my $ln = $line;
4331 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4332 ## }
4333 ## if ($ln =~ /,/) {
4334 ## WARN("MULTIPLE_DECLARATION",
4335 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4336 ## }
4337 ## }
4339 #need space before brace following if, while, etc
4346 }
4347 }
4349 ## # check for blank lines before declarations
4350 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4351 ## $prevrawline =~ /^.\s*$/) {
4352 ## WARN("SPACING",
4353 ## "No blank lines before declarations\n" . $hereprev);
4354 ## }
4355 ##
4357 # closing brace should have a space following it when it has anything
4358 # on the line
4365 }
4366 }
4368 # check spacing on square brackets
4375 }
4376 }
4383 }
4384 }
4386 # check spacing on parentheses
4394 }
4395 }
4404 }
4405 }
4407 # check unnecessary parentheses around addressof/dereference single $Lvals
4408 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4416 }
4417 }
4419 # check for unnecessary parentheses around function pointer uses
4420 # ie: (foo->bar)(); should be foo->bar();
4421 # but not "if (foo->bar) (" to avoid some false positives
4430 }
4431 }
4433 #goto labels aren't indented, allow a single space however
4441 }
4442 }
4444 # return is not a function
4454 }
4458 }
4459 }
4461 # unnecessary return in a void function
4462 # at end-of-function, with the previous line a single leading tab, then return;
4463 # and the line before that not a goto label target like "out:"
4471 }
4473 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4479 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4484 }
4485 }
4487 # comparisons with a constant or upper case identifier on the left
4488 # avoid cases like "foo + BAR < baz"
4489 # only fix matches surrounded by parentheses to avoid incorrect
4490 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4511 }
4513 }
4514 }
4516 # Return of what appears to be an errno should normally be negative
4522 }
4523 }
4525 # Need a space before open parenthesis after if, while etc
4532 }
4533 }
4535 # Check for illegal assignment in if conditional -- and check for trailing
4536 # statements after the conditional.
4544 ##print "stat<$stat> stat_next<$stat_next>\n";
4547 # If the statement carries leading newlines,
4548 # then count those as offsets.
4556 }
4557 }
4566 }
4568 # Find out what is on the end of the line after the
4569 # conditional.
4575 {
4576 # Find out how long the conditional actually is.
4585 }
4589 }
4590 }
4592 # Check for bitwise tests written as boolean
4598 |
4603 {
4606 }
4608 # if and else should not have general statements after it
4615 }
4616 }
4617 # if should not continue a brace
4622 }
4623 # case and default should not have general statements after them
4629 {
4632 }
4634 # Check for }<nl>else {, these must be at the same
4635 # indent level to be relevant to each other.
4647 }
4651 }
4652 }
4658 # Find out what is on the end of the line after the
4659 # conditional.
4675 }
4676 }
4677 }
4679 #Specific variable tests
4683 #gcc binary extension
4691 }
4692 }
4694 #CamelCase
4697 #Ignore Page<foo> variants
4699 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4701 #Ignore some three character SI units explicitly, like MiB and KHz
4707 seed_camelcase_includes();
4711 }
4712 }
4717 }
4718 }
4719 }
4720 }
4722 #no spaces allowed after \ in define
4728 }
4729 }
4731 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4732 # itself <asm/foo.h> (uses RAW line)
4739 {
4748 }
4749 }
4750 }
4751 }
4753 # multi-statement macros should be enclosed in a do while loop, grab the
4754 # first statement and ensure its the whole macro if its not enclosed
4755 # in a known good container
4767 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4768 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4782 }
4789 # Flatten any parentheses and braces
4793 {
4794 }
4796 # Flatten any obvious string concatentation.
4799 {
4800 }
4802 # Make asm volatile uses seem like a generic function
4807 module_param_named|
4808 MODULE_PARM_DESC|
4809 DECLARE_PER_CPU|
4810 DEFINE_PER_CPU|
4811 __typeof__\(|
4812 union|
4813 struct|
4818 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4826 }
4831 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4836 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4842 {
4850 }
4852 }
4854 # Make $define_stmt single line, comment-free, etc
4865 }
4866 }
4871 # check if any macro arguments are reused (ignore '...' and 'type')
4876 $tmp =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
4883 }
4884 # check if any macro arguments may have other precedence issues
4890 }
4891 }
4893 # check for macros with flow control, but without ## concatenation
4894 # ## concatenation is commonly a macro that defines a function so ignore those
4901 }
4904 }
4906 # check for line continuations outside of #defines, preprocessor #, and asm
4915 }
4916 }
4918 # do {} while (0) macro tests:
4919 # single-statement macros do not need to be enclosed in do while (0) loop,
4920 # macro should not end with a semicolon
4935 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4945 }
4951 }
4955 }
4963 }
4967 }
4968 }
4970 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4971 # all assignments may have only one of the following with an assignment:
4972 # .
4973 # ALIGN(...)
4974 # VMLINUX_SYMBOL(...)
4978 }
4980 # check for redundant bracing round if etc
4984 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4985 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4995 # If the condition carries leading newlines, then count those as offsets.
5000 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5002 # We have looked at and allowed this specific line.
5012 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5014 #print "APW: ALLOWED: cond<$cond>\n";
5016 }
5018 #print "APW: ALLOWED: block<$block>\n";
5020 }
5022 #print "APW: ALLOWED: lines block<$block>\n";
5024 }
5026 }
5031 }
5039 }
5040 }
5041 }
5042 }
5047 # Check the pre-context.
5049 #print "APW: ALLOWED: pre<$1>\n";
5051 }
5056 # Check the condition.
5058 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5061 }
5063 #print "APW: ALLOWED: cond<$cond>\n";
5065 }
5067 #print "APW: ALLOWED: block<$block>\n";
5069 }
5071 #print "APW: ALLOWED: lines block<$block>\n";
5073 }
5074 # Check the post-context.
5079 }
5081 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5083 }
5084 }
5091 }
5095 }
5096 }
5098 # check for unnecessary blank lines around braces
5104 }
5105 }
5111 }
5112 }
5114 # no volatiles please
5118 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5119 }
5121 # Check for user-visible strings broken across lines, which breaks the ability
5122 # to grep for the string. Make exceptions when the previous string ends in a
5123 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5124 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5137 }
5149 }
5151 }
5152 }
5154 # check for missing a space in a string concatenation
5158 }
5160 # check for spaces before a quoted newline
5166 }
5168 }
5170 # concatenated string without spaces between elements
5174 }
5176 # uncoalesced string fragments
5180 }
5182 # check for %L{u,d,i} and 0x%[udi] in strings
5191 }
5195 }
5196 }
5198 # check for line continuations in quoted strings with odd counts of "
5202 }
5204 # warn about #if 0
5209 }
5211 # check for needless "if (<foo>) fn(<foo>)" uses
5215 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5227 }
5232 }
5235 }
5239 }
5240 }
5241 }
5242 }
5244 # check for unnecessary "Out of Memory" messages
5253 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5255 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5258 }
5259 }
5261 # check for logging functions with KERN_<LEVEL>
5269 }
5270 }
5272 # check for mask then right shift without a parentheses
5278 }
5280 # check for pointer comparisons to NULL
5290 }
5291 }
5292 }
5294 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5297 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5307 $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;
5308 }
5309 }
5310 }
5312 # check for $InitAttributeData (ie: __initdata) with const
5323 }
5324 }
5326 # check for $InitAttributeConst (ie: __initconst) without const
5338 }
5339 }
5341 # check for __read_mostly with const non-pointer (should just be const)
5348 }
5349 }
5351 # don't use __constant_<foo> functions outside of include/uapi/
5353 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5361 }
5362 }
5364 # prefer usleep_range over udelay
5367 # ignore udelay's < 10, however
5370 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5371 }
5375 }
5376 }
5378 # warn about unexpectedly long msleep's
5382 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5383 }
5384 }
5386 # check for comparisons of jiffies
5389 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5390 }
5392 # check for comparisons of get_jiffies_64()
5395 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5396 }
5398 # warn about #ifdefs in C files
5399 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5400 # print "#ifdef in C files should be avoided\n";
5401 # print "$herecurr";
5402 # $clean = 0;
5403 # }
5405 # warn about spacing in #ifdefs
5412 }
5414 }
5416 # check for spinlock_t definitions without a comment.
5423 }
5424 }
5425 # check for memory barriers without a comment.
5428 mb|
5429 rmb|
5430 wmb|
5431 read_barrier_depends
5434 mb__before_atomic|
5435 mb__after_atomic|
5436 store_release|
5437 load_acquire|
5438 store_mb|
5451 }
5452 }
5462 }
5464 # check for waitqueue_active without a comment.
5469 }
5470 }
5472 # Check for expedited grace periods that interrupt non-idle non-nohz
5473 # online CPUs. These expedited can therefore degrade real-time response
5474 # if used carelessly, and should be avoided where not absolutely
5475 # needed. It is always OK to use synchronize_rcu_expedited() and
5476 # synchronize_sched_expedited() at boot time (before real-time applications
5477 # start) and in error situations where real-time response is compromised in
5478 # any case. Note that synchronize_srcu_expedited() does -not- interrupt
5479 # other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5480 # Of course, nothing comes for free, and srcu_read_lock() and
5481 # srcu_read_unlock() do contain full memory barriers in payment for
5482 # synchronize_srcu_expedited() non-interruption properties.
5485 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5487 }
5489 # check of hardware specific defines
5490 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5493 }
5495 # Check that the storage class is at the beginning of a declaration
5499 }
5501 # check the location of the inline attribute, that it is between
5502 # storage class and type.
5507 }
5509 # Check for __inline__ and __inline, prefer inline
5517 }
5518 }
5520 # Check for __attribute__ packed, prefer __packed
5525 }
5527 # Check for __attribute__ aligned, prefer __aligned
5532 }
5534 # Check for __attribute__ format(printf, prefer __printf
5538 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5540 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5542 }
5543 }
5545 # Check for __attribute__ format(scanf, prefer __scanf
5549 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5551 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5552 }
5553 }
5555 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5557 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5562 }
5564 # check for c99 types like uint8_t used outside of uapi/ and tools/
5579 }
5580 }
5581 }
5583 # check for cast of C90 native int or longer types constants
5598 }
5600 }
5601 }
5603 # check for sizeof(&)
5607 }
5609 # check for sizeof without parenthesis
5614 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5615 }
5616 }
5618 # check for struct spinlock declarations
5622 }
5624 # check for seq_printf uses that could be seq_puts
5633 }
5634 }
5635 }
5637 # Check for misused memsets
5652 }
5653 }
5655 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5656 # if ($^V && $^V ge 5.10.0 &&
5657 # defined $stat &&
5658 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5659 # if (WARN("PREFER_ETHER_ADDR_COPY",
5660 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5661 # $fix) {
5662 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5663 # }
5664 # }
5666 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5667 # if ($^V && $^V ge 5.10.0 &&
5668 # defined $stat &&
5669 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5670 # WARN("PREFER_ETHER_ADDR_EQUAL",
5671 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5672 # }
5674 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5675 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5676 # if ($^V && $^V ge 5.10.0 &&
5677 # defined $stat &&
5678 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5679 #
5680 # my $ms_val = $7;
5681 #
5682 # if ($ms_val =~ /^(?:0x|)0+$/i) {
5683 # if (WARN("PREFER_ETH_ZERO_ADDR",
5684 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5685 # $fix) {
5686 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5687 # }
5688 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5689 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
5690 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5691 # $fix) {
5692 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5693 # }
5694 # }
5695 # }
5697 # typecasts on min/max could be min_t/max_t
5715 }
5718 }
5719 }
5721 # check usleep_range arguments
5729 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5733 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5734 }
5735 }
5737 # check for naked sscanf
5749 }
5752 }
5754 # check for simple sscanf that should be kstrto<foo>
5763 }
5771 }
5772 }
5773 }
5775 # check for new externs in .h files.
5782 }
5783 }
5785 # check for new externs in .c files.
5788 {
5795 }
5798 {
5801 }
5806 }
5810 {
5813 }
5824 }
5825 }
5826 }
5828 # checks for new __setup's
5834 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
5835 }
5836 }
5838 # check for pointless casting of kmalloc return
5841 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5842 }
5844 # alloc style
5845 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5847 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5850 }
5852 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5854 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5865 }
5871 $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;
5873 }
5874 }
5875 }
5877 # check for krealloc arg reuse
5882 }
5884 # check for alloc argument mismatch
5888 }
5890 # check for multiple semicolons
5896 }
5897 }
5899 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5908 }
5909 }
5911 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5912 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5918 }
5919 }
5921 # check for case / default statements not preceded by break/fallthrough/switch
5939 }
5943 }
5944 }
5946 # check for switch/default statements without a break;
5955 }
5958 }
5960 # check for gcc specific __FUNCTION__
5966 }
5967 }
5969 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5973 }
5975 # check for use of yield()
5979 }
5981 # check for comparisons against true and false
5997 }
6002 ## maybe suggesting a correct construct would better
6003 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6005 }
6006 }
6008 # check for semaphores initialized locked
6012 }
6014 # recommend kstrto* over simple_strto* and strict_strto*
6018 }
6020 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6023 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6024 }
6026 # check for various structs that are normally const (ops, kgdb, device_tree)
6032 }
6034 # use of NR_CPUS is usually wrong
6035 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6042 {
6044 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6045 }
6047 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6051 }
6053 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6058 }
6060 # whine mightly about in_atomic
6068 }
6069 }
6071 # whine about ACCESS_ONCE
6082 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6083 }
6089 }
6090 }
6091 }
6093 # check for mutex_trylock_recursive usage
6097 }
6099 # check for lockdep_set_novalidate_class
6107 }
6108 }
6113 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6114 }
6116 # Mode permission misuses where it seems decimal should be octal
6117 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6130 }
6136 }
6145 }
6148 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6149 }
6150 }
6151 }
6152 }
6154 # check for uses of S_<PERMS> that could be octal for readability
6171 }
6176 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6179 }
6180 }
6182 # validate content of MODULE_LICENSE against list from include/linux/module.h
6186 GPL|
6187 GPL\ v2|
6192 Proprietary
6197 }
6198 }
6199 }
6201 # If we have no input at all, then there is nothing to report on
6202 # so just keep quiet.
6205 }
6207 # In mailback mode only produce a report in the negative, for
6208 # things that appear to be patches.
6211 }
6213 # This is not a patch, and we are are in 'no-patch' mode so
6214 # just keep quiet.
6217 }
6222 }
6226 }
6234 }
6237 # If there were any defects found and not already fixing them
6243 EOM
6244 }
6245 # If there were whitespace errors which cleanpatch can fix
6246 # then suggest that.
6253 EOM
6254 }
6255 }
6275 }
6278 }
6279 }
6287 Do _NOT_ trust the results written to this file.
6290 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6292 EOM
6293 }
6294 }
6302 }
6303 }
6305 }