| blob | 55171647f51679fa19066fb68f633ec374e77863 |
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
2595 }
2597 # Check for wrappage within a valid hunk of the file
2602 }
2604 # Check for absolute kernel paths.
2611 #
2614 }
2615 }
2616 }
2618 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2629 }
2631 # Check if it's the start of a commit log
2632 # (not a header line and we haven't seen the patch filename)
2639 }
2641 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2642 # declined it, i.e defined some charset where it is missing.
2647 }
2653 }
2655 # Check for various typo / spelling mistakes
2669 }
2670 }
2671 }
2673 # ignore non-hunk lines and lines being removed
2676 #trailing whitespace
2683 }
2690 }
2693 }
2695 # Check for FSF mailing addresses.
2703 "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)
2704 }
2706 # check for Kconfig help text having a real description
2707 # Only applies when adding the entry originally, after that we do not have
2708 # sufficient context to determine whether it is indeed long enough.
2729 }
2738 }
2740 }
2744 }
2745 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2746 }
2748 # discourage the addition of CONFIG_EXPERIMENTAL in Kconfig.
2752 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
2753 }
2755 # discourage the use of boolean for type definition attributes of Kconfig options
2760 }
2770 };
2773 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2774 }
2776 # check for DT compatible documentation
2795 }
2802 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2803 }
2804 }
2805 }
2807 # check we are in a valid source file if not then ignore this hunk
2810 # line length limit (with some exclusions)
2811 #
2812 # There are a few types of lines that may extend beyond $max_line_length:
2813 # logging functions like pr_info that end in a string
2814 # lines with a single string
2815 # #defines that are a single string
2816 #
2817 # There are 3 different line length message types:
2818 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_linelength
2819 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
2820 # LONG_LINE all other lines longer than $max_line_length
2821 #
2822 # if LONG_LINE is ignored, the other 2 types are also ignored
2823 #
2828 # Check the allowed long line types first
2830 # logging functions that end in a string that starts
2831 # before $max_line_length
2832 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
2836 # lines with only strings (w/ possible termination)
2837 # #defines with only strings
2842 # EFI_GUID is another special case
2846 # Otherwise set the alternate message types
2848 # a comment starts before $max_line_length
2853 # a quoted string starts before $max_line_length
2857 }
2863 }
2864 }
2866 # check for adding lines without a newline.
2867 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
2870 }
2872 # Blackfin: use hi/lo macros
2878 }
2883 }
2884 }
2886 # check we are in a valid source file C or perl if not then ignore this hunk
2889 # at the beginning of a line any tabs must come first and anything
2890 # more than 8 must use tabs.
2899 }
2900 }
2902 # check for space before tabs.
2912 }
2913 }
2915 # check for && or || at the start of a line
2919 }
2921 # check indentation starts on a tab stop
2930 }
2931 }
2932 }
2934 # check multi-line statement indentation matches previous line
2936 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|$Ident\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
2959 }
2960 }
2961 }
2962 }
2964 # check for space after cast like "(int) foo" or "(struct foo) bar"
2965 # avoid checking a few false positives:
2966 # "sizeof(<type>)" or "__alignof__(<type>)"
2967 # function pointer declarations like "(*foo)(int) = bar;"
2968 # structure definitions like "(struct foo) { 0 };"
2969 # multiline macros that define functions
2970 # known attributes or the __attribute__ keyword
2978 }
2979 }
2981 # Block comment styles
2982 # Networking with an initial /*
2989 }
2991 # Block comments use * on subsequent lines
2999 }
3001 # Block comments use */ on trailing lines
3008 }
3010 # Block comment * alignment
3024 }
3031 }
3032 }
3034 # check for missing blank lines after struct/union declarations
3035 # with exceptions for various attributes and macros
3050 }
3051 }
3053 # check for multiple consecutive blank lines
3061 }
3064 }
3066 # check for missing blank lines after declarations
3068 # actual declarations
3070 # function pointer declarations
3072 # foo bar; where foo is some local typedef or #define
3074 # known declaration macros
3076 # for "else if" which can look like "$Ident $Ident"
3078 # other possible extensions of declaration lines
3080 # not starting a section or a macro "\" extended line
3082 # looks like a declaration
3084 # function pointer declarations
3086 # foo bar; where foo is some local typedef or #define
3088 # known declaration macros
3090 # start of struct or union or enum
3092 # start or end of block or continuation of declaration
3094 # bitfield continuation
3096 # other possible extensions of declaration lines
3098 # indentation of previous and current line are the same
3104 }
3105 }
3107 # check for spaces at the beginning of a line.
3108 # Exceptions:
3109 # 1) within comments
3110 # 2) indented preprocessor commands
3111 # 3) hanging labels
3118 }
3119 }
3121 # check we are in a valid C source file if not then ignore this hunk
3124 # check indentation of any line with a bare else
3125 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3126 # if the previous line is a break or return and is indented 1 tab more...
3135 }
3136 }
3138 # check indentation of a line with a break;
3139 # if the previous line is a goto or return and is indented the same # of tabs
3145 }
3146 }
3148 # discourage the addition of CONFIG_EXPERIMENTAL in #if(def).
3151 "Use of CONFIG_EXPERIMENTAL is deprecated. For alternatives, see https://lkml.org/lkml/2012/10/23/580\n");
3152 }
3154 # check for RCS/CVS revision markers
3158 }
3160 # Blackfin: don't use __builtin_bfin_[cs]sync
3165 }
3170 }
3172 # check for old HOTPLUG __dev<foo> section markings
3176 }
3178 # Check for potential 'bare' types
3181 #print "LINE<$line>\n";
3189 #print "linenr<$linenr> <$stat>\n";
3190 # If this statement has no statement boundaries within
3191 # it there is no point in retrying a statement scan
3192 # until we hit end of it.
3195 #print "skip<$line_nr_next>\n";
3197 }
3199 # Find the real next line.
3205 }
3210 # Ignore goto labels.
3213 # Ignore functions being called
3218 # declarations always start with types
3219 } 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) {
3224 # definitions in global scope can only start with types
3227 }
3229 # any (foo ... *) is a pointer cast, and foo is a type
3232 }
3234 # Check for any sort of function declaration.
3235 # int foo(something bar, other baz);
3236 # void (*store_gdt)(x86_descr_ptr *);
3237 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3245 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3248 }
3249 }
3250 }
3252 }
3254 #
3255 # Checks which may be anchored in the context.
3256 #
3258 # Check for switch () and associated case and default
3259 # statements should be at the same indent.
3273 }
3274 }
3278 }
3279 }
3281 # if/while/etc brace do not go on next line, unless defining a do while loop,
3282 # or if that brace on the next line is for something else
3283 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3291 }
3302 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3305 }
3307 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3308 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3314 }
3318 {
3324 }
3325 }
3326 }
3328 # Check relative indent for conditionals and blocks.
3329 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3337 # remove inline comments
3341 # Find out how long the conditional actually is.
3345 # Make sure we remove the line prefixes as we have
3346 # none on the first line, and are going to readd them
3347 # where necessary.
3351 }
3353 # We want to check the first line inside the block
3354 # starting at the end of the conditional, so remove:
3355 # 1) any blank line termination
3356 # 2) any opening brace { on end of the line
3357 # 3) any do (...) {
3364 }
3368 }
3370 # Also ignore a loop construct at the end of a
3371 # preprocessor statement.
3375 }
3382 # If we see an #else/#elif then the code
3383 # is not linear.
3386 }
3388 # Ignore:
3389 # 1) blank lines, they should be at 0,
3390 # 2) preprocessor lines, and
3391 # 3) labels.
3399 }
3400 }
3401 }
3406 # Check if either of these lines are modified, else
3407 # this is not this patch's fault.
3411 }
3414 }
3416 #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";
3423 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3424 }
3425 }
3427 # Track the 'values' across context and added lines.
3437 }
3440 #ignore lines not being added
3443 # check for declarations of signed or unsigned without int
3444 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3455 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3463 }
3464 }
3465 }
3467 # TEST: allow direct testing of the type matcher.
3475 }
3477 }
3478 # TEST: allow direct testing of the attribute matcher.
3486 }
3488 }
3490 # check for initialisation to aggregates open brace on the next line
3504 }
3505 }
3507 #
3508 # Checks which are anchored on the added line.
3509 #
3511 # check for malformed paths in #include statements (uses RAW line)
3517 }
3521 }
3522 }
3524 # no C99 // comments
3533 }
3534 }
3535 }
3536 # Remove C99 comments.
3540 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3541 # the whole statement.
3542 #print "APW <$lines[$realline_next - 1]>\n";
3548 # Handle definitions which produce identifiers with
3549 # a prefix:
3550 # XXX(foo);
3551 # EXPORT_SYMBOL(something_foo);
3555 #print "FOO C name<$name>\n";
3566 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3570 }
3571 }
3576 #print "FOO B <$lines[$linenr - 1]>\n";
3578 }
3583 }
3585 # check for global initialisers.
3591 }
3592 }
3593 # check for static initialisers.
3600 }
3601 }
3603 # check for misordered declarations of char/short/int/long with signed/unsigned
3607 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3608 }
3610 # check for static const char * arrays.
3615 }
3617 # check for static char foo[] = "bar" declarations.
3622 }
3624 # check for const <foo> const where <foo> is not a pointer or array type
3633 }
3634 }
3636 # check for non-global char *foo[] = {"bar", ...} declarations.
3641 }
3643 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3646 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3652 }
3653 }
3654 }
3656 # check for function declarations without arguments like "int foo()"
3662 }
3663 }
3665 # check for new typedefs, only function parameters and sparse annotations
3666 # make sense.
3674 }
3676 # * goes on variable not on type
3677 # (char*[ const])
3679 #print "AA<$1>\n";
3682 # Should start with a space.
3684 # Should not end with a space.
3686 # '*'s should not have spaces between.
3688 }
3690 ## print "1: from<$from> to<$to> ident<$ident>\n";
3700 }
3701 }
3702 }
3704 #print "BB<$1>\n";
3707 # Should start with a space.
3709 # Should not end with a space.
3711 # '*'s should not have spaces between.
3713 }
3714 # Modifiers should have spaces.
3717 ## print "2: from<$from> to<$to> ident<$ident>\n";
3728 }
3729 }
3730 }
3732 # avoid BUG() or BUG_ON()
3737 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3738 }
3740 # avoid LINUX_VERSION_CODE
3743 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
3744 }
3746 # check for uses of printk_ratelimit
3750 }
3752 # printk should use KERN_* levels. Note that follow on printk's on the
3753 # same line do not need a level, so we use the current block context
3754 # to try and find and validate the current printk. In summary the current
3755 # printk includes all preceding printk's which have no newline on the end.
3756 # we assume the first bad printk is the one to report.
3760 #print "CHECK<$lines[$ln - 1]\n";
3761 # we have a preceding printk if it ends
3762 # with "\n" ignore it, else it is to blame
3766 }
3768 }
3769 }
3773 }
3774 }
3783 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
3784 }
3792 }
3793 }
3802 }
3804 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
3805 # number of false positives, but assembly files are not checked, so at
3806 # least the arch entry code will not trigger this warning.
3810 }
3812 # function brace can't be on same line, except for #defines of do while,
3813 # or if closed on same line
3828 }
3829 }
3830 }
3832 # open braces for enum, union and struct go on the same line.
3846 }
3847 }
3848 }
3850 # missing space after union, struct or enum definition
3857 }
3858 }
3860 # Function pointer declarations
3861 # check spacing between type, funcptr, and args
3862 # canonical declaration is "type (*funcptr)(args...)"
3871 # the $Declare variable will capture all spaces after the type
3872 # so check it for a missing trailing missing space but pointer return types
3873 # don't need a space so don't warn for those.
3878 }
3883 }
3885 # unnecessary space "type (*funcptr)(args...)"
3886 # This test is not currently implemented because these declarations are
3887 # equivalent to
3888 # int foo(int bar, ...)
3889 # and this is form shouldn't/doesn't generate a checkpatch warning.
3890 #
3891 # elsif ($declare =~ /\s{2,}$/) {
3892 # WARN("SPACING",
3893 # "Multiple spaces after return type\n" . $herecurr);
3894 # }
3896 # unnecessary space "type ( *funcptr)(args...)"
3901 }
3903 # unnecessary space "type (* funcptr)(args...)"
3908 }
3910 # unnecessary space "type (*funcptr )(args...)"
3915 }
3917 # unnecessary space "type (*funcptr) (args...)"
3922 }
3926 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
3927 }
3928 }
3930 # check for spacing round square brackets; allowed:
3931 # 1. with a type on the left -- int [] a;
3932 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
3933 # 3. inside a curly brace -- = { [0...10] = 5 }
3944 }
3945 }
3946 }
3948 # check for spaces between functions and their parentheses.
3954 # Ignore those directives where spaces _are_ permitted.
3960 {
3961 # cpp #define statements have non-optional spaces, ie
3962 # if there is a space between the name and the open
3963 # parenthesis it is simply not a parameter group.
3966 # cpp #elif statement condition may start with a (
3969 # If this whole things ends with a type its most
3970 # likely a typedef for a function.
3979 }
3980 }
3981 }
3983 # Check operator spacing.
3989 <<=|>>=|<=|>=|==|!=|
3991 =>|->|<<|>>|<|>|=|!|~|
3997 ## print("element count: <" . $#elements . ">\n");
3998 ## foreach my $el (@elements) {
3999 ## print("el: <$el>\n");
4000 ## }
4008 }
4019 ## print("n: <$n> good: <$good>\n");
4023 # Pick up the preceding and succeeding characters.
4028 }
4051 }
4060 # Pull out the value of this operator.
4063 # Get the full operator variant.
4066 # Ignore operators passed as parameters.
4070 # # Ignore comments
4071 # } elsif ($op =~ /^$;+$/) {
4073 # ; should have either the end of line or a space or \ after it
4081 }
4082 }
4084 # // is a comment
4087 # : when part of a bitfield
4089 # skip the bitfield test for now
4091 # No spaces for:
4092 # ->
4100 }
4102 }
4103 }
4105 # , must not have a space before and must have a space on the right.
4114 }
4115 }
4122 }
4123 }
4129 }
4132 }
4133 }
4135 # '*' as part of a type definition -- reported already.
4137 #warn "'*' is part of type\n";
4139 # unary operators should have a space before and
4140 # none after. May be left adjacent to another
4141 # unary operator, or a cast
4151 }
4152 }
4153 }
4155 # A unary '*' may be const
4163 }
4165 }
4166 }
4168 # unary ++ and unary -- are allowed no space on one side.
4175 }
4176 }
4183 }
4184 }
4191 }
4193 }
4194 }
4196 # << and >> may either have or not have spaces both sides
4202 {
4210 }
4216 }
4217 }
4224 }
4226 }
4227 }
4229 # A colon needs no spaces before when it is
4230 # terminating a case value or a label.
4237 }
4238 }
4240 # All the others need spaces both sides.
4244 # Ignore email addresses <foo@bar>
4249 {
4251 }
4253 # for asm volatile statements
4254 # ignore a colon with another
4255 # colon immediately before or after
4259 }
4261 # messages are ERROR, but ?: are CHK
4271 }
4273 }
4274 }
4275 }
4278 ## print("n: <$n> GOOD: <$good>\n");
4281 }
4285 }
4289 }
4292 }
4294 # check for whitespace before a non-naked semicolon
4301 }
4302 }
4304 # check for multiple assignments
4308 }
4310 ## # check for multiple declarations, allowing for a function declaration
4311 ## # continuation.
4312 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4313 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4314 ##
4315 ## # Remove any bracketed sections to ensure we do not
4316 ## # falsly report the parameters of functions.
4317 ## my $ln = $line;
4318 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4319 ## }
4320 ## if ($ln =~ /,/) {
4321 ## WARN("MULTIPLE_DECLARATION",
4322 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4323 ## }
4324 ## }
4326 #need space before brace following if, while, etc
4333 }
4334 }
4336 ## # check for blank lines before declarations
4337 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4338 ## $prevrawline =~ /^.\s*$/) {
4339 ## WARN("SPACING",
4340 ## "No blank lines before declarations\n" . $hereprev);
4341 ## }
4342 ##
4344 # closing brace should have a space following it when it has anything
4345 # on the line
4352 }
4353 }
4355 # check spacing on square brackets
4362 }
4363 }
4370 }
4371 }
4373 # check spacing on parentheses
4381 }
4382 }
4391 }
4392 }
4394 # check unnecessary parentheses around addressof/dereference single $Lvals
4395 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4403 }
4404 }
4406 # check for unnecessary parentheses around function pointer uses
4407 # ie: (foo->bar)(); should be foo->bar();
4408 # but not "if (foo->bar) (" to avoid some false positives
4417 }
4418 }
4420 #goto labels aren't indented, allow a single space however
4428 }
4429 }
4431 # return is not a function
4441 }
4445 }
4446 }
4448 # unnecessary return in a void function
4449 # at end-of-function, with the previous line a single leading tab, then return;
4450 # and the line before that not a goto label target like "out:"
4458 }
4460 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4466 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4471 }
4472 }
4474 # comparisons with a constant or upper case identifier on the left
4475 # avoid cases like "foo + BAR < baz"
4476 # only fix matches surrounded by parentheses to avoid incorrect
4477 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4498 }
4500 }
4501 }
4503 # Return of what appears to be an errno should normally be negative
4509 }
4510 }
4512 # Need a space before open parenthesis after if, while etc
4519 }
4520 }
4522 # Check for illegal assignment in if conditional -- and check for trailing
4523 # statements after the conditional.
4531 ##print "stat<$stat> stat_next<$stat_next>\n";
4534 # If the statement carries leading newlines,
4535 # then count those as offsets.
4543 }
4544 }
4553 }
4555 # Find out what is on the end of the line after the
4556 # conditional.
4562 {
4563 # Find out how long the conditional actually is.
4572 }
4576 }
4577 }
4579 # Check for bitwise tests written as boolean
4585 |
4590 {
4593 }
4595 # if and else should not have general statements after it
4602 }
4603 }
4604 # if should not continue a brace
4609 }
4610 # case and default should not have general statements after them
4616 {
4619 }
4621 # Check for }<nl>else {, these must be at the same
4622 # indent level to be relevant to each other.
4634 }
4638 }
4639 }
4645 # Find out what is on the end of the line after the
4646 # conditional.
4662 }
4663 }
4664 }
4666 #Specific variable tests
4670 #gcc binary extension
4678 }
4679 }
4681 #CamelCase
4684 #Ignore Page<foo> variants
4686 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4688 #Ignore some three character SI units explicitly, like MiB and KHz
4694 seed_camelcase_includes();
4698 }
4699 }
4704 }
4705 }
4706 }
4707 }
4709 #no spaces allowed after \ in define
4715 }
4716 }
4718 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4719 # itself <asm/foo.h> (uses RAW line)
4726 {
4735 }
4736 }
4737 }
4738 }
4740 # multi-statement macros should be enclosed in a do while loop, grab the
4741 # first statement and ensure its the whole macro if its not enclosed
4742 # in a known good container
4754 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
4755 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
4769 }
4776 # Flatten any parentheses and braces
4780 {
4781 }
4783 # Flatten any obvious string concatentation.
4786 {
4787 }
4789 # Make asm volatile uses seem like a generic function
4794 module_param_named|
4795 MODULE_PARM_DESC|
4796 DECLARE_PER_CPU|
4797 DEFINE_PER_CPU|
4798 __typeof__\(|
4799 union|
4800 struct|
4805 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
4813 }
4818 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
4823 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
4829 {
4837 }
4839 }
4841 # Make $define_stmt single line, comment-free, etc
4852 }
4853 }
4858 # check if any macro arguments are reused (ignore '...' and 'type')
4863 $tmp =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
4870 }
4871 # check if any macro arguments may have other precedence issues
4877 }
4878 }
4880 # check for macros with flow control, but without ## concatenation
4881 # ## concatenation is commonly a macro that defines a function so ignore those
4888 }
4891 }
4893 # check for line continuations outside of #defines, preprocessor #, and asm
4902 }
4903 }
4905 # do {} while (0) macro tests:
4906 # single-statement macros do not need to be enclosed in do while (0) loop,
4907 # macro should not end with a semicolon
4922 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
4932 }
4938 }
4942 }
4950 }
4954 }
4955 }
4957 # make sure symbols are always wrapped with VMLINUX_SYMBOL() ...
4958 # all assignments may have only one of the following with an assignment:
4959 # .
4960 # ALIGN(...)
4961 # VMLINUX_SYMBOL(...)
4965 }
4967 # check for redundant bracing round if etc
4971 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
4972 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
4982 # If the condition carries leading newlines, then count those as offsets.
4987 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
4989 # We have looked at and allowed this specific line.
4999 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5001 #print "APW: ALLOWED: cond<$cond>\n";
5003 }
5005 #print "APW: ALLOWED: block<$block>\n";
5007 }
5009 #print "APW: ALLOWED: lines block<$block>\n";
5011 }
5013 }
5018 }
5026 }
5027 }
5028 }
5029 }
5034 # Check the pre-context.
5036 #print "APW: ALLOWED: pre<$1>\n";
5038 }
5043 # Check the condition.
5045 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5048 }
5050 #print "APW: ALLOWED: cond<$cond>\n";
5052 }
5054 #print "APW: ALLOWED: block<$block>\n";
5056 }
5058 #print "APW: ALLOWED: lines block<$block>\n";
5060 }
5061 # Check the post-context.
5066 }
5068 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5070 }
5071 }
5078 }
5082 }
5083 }
5085 # check for unnecessary blank lines around braces
5091 }
5092 }
5098 }
5099 }
5101 # no volatiles please
5105 "Use of volatile is usually wrong: see Documentation/volatile-considered-harmful.txt\n" . $herecurr);
5106 }
5108 # Check for user-visible strings broken across lines, which breaks the ability
5109 # to grep for the string. Make exceptions when the previous string ends in a
5110 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5111 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5124 }
5136 }
5138 }
5139 }
5141 # check for missing a space in a string concatenation
5145 }
5147 # check for spaces before a quoted newline
5153 }
5155 }
5157 # concatenated string without spaces between elements
5161 }
5163 # uncoalesced string fragments
5167 }
5169 # check for %L{u,d,i} and 0x%[udi] in strings
5178 }
5182 }
5183 }
5185 # check for line continuations in quoted strings with odd counts of "
5189 }
5191 # warn about #if 0
5196 }
5198 # check for needless "if (<foo>) fn(<foo>)" uses
5202 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5214 }
5219 }
5222 }
5226 }
5227 }
5228 }
5229 }
5231 # check for unnecessary "Out of Memory" messages
5240 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5242 if ($c =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|(?:dev_)?alloc_skb)/) {
5245 }
5246 }
5248 # check for logging functions with KERN_<LEVEL>
5256 }
5257 }
5259 # check for mask then right shift without a parentheses
5265 }
5267 # check for pointer comparisons to NULL
5277 }
5278 }
5279 }
5281 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5284 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5294 $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;
5295 }
5296 }
5297 }
5299 # check for $InitAttributeData (ie: __initdata) with const
5310 }
5311 }
5313 # check for $InitAttributeConst (ie: __initconst) without const
5325 }
5326 }
5328 # check for __read_mostly with const non-pointer (should just be const)
5335 }
5336 }
5338 # don't use __constant_<foo> functions outside of include/uapi/
5340 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5348 }
5349 }
5351 # prefer usleep_range over udelay
5354 # ignore udelay's < 10, however
5357 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5358 }
5362 }
5363 }
5365 # warn about unexpectedly long msleep's
5369 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5370 }
5371 }
5373 # check for comparisons of jiffies
5376 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5377 }
5379 # check for comparisons of get_jiffies_64()
5382 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5383 }
5385 # warn about #ifdefs in C files
5386 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5387 # print "#ifdef in C files should be avoided\n";
5388 # print "$herecurr";
5389 # $clean = 0;
5390 # }
5392 # warn about spacing in #ifdefs
5399 }
5401 }
5403 # check for spinlock_t definitions without a comment.
5410 }
5411 }
5412 # check for memory barriers without a comment.
5415 mb|
5416 rmb|
5417 wmb|
5418 read_barrier_depends
5421 mb__before_atomic|
5422 mb__after_atomic|
5423 store_release|
5424 load_acquire|
5425 store_mb|
5438 }
5439 }
5449 }
5451 # check for waitqueue_active without a comment.
5456 }
5457 }
5459 # Check for expedited grace periods that interrupt non-idle non-nohz
5460 # online CPUs. These expedited can therefore degrade real-time response
5461 # if used carelessly, and should be avoided where not absolutely
5462 # needed. It is always OK to use synchronize_rcu_expedited() and
5463 # synchronize_sched_expedited() at boot time (before real-time applications
5464 # start) and in error situations where real-time response is compromised in
5465 # any case. Note that synchronize_srcu_expedited() does -not- interrupt
5466 # other CPUs, so don't warn on uses of synchronize_srcu_expedited().
5467 # Of course, nothing comes for free, and srcu_read_lock() and
5468 # srcu_read_unlock() do contain full memory barriers in payment for
5469 # synchronize_srcu_expedited() non-interruption properties.
5472 "expedited RCU grace periods should be avoided where they can degrade real-time response\n" . $herecurr);
5474 }
5476 # check of hardware specific defines
5477 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5480 }
5482 # Check that the storage class is at the beginning of a declaration
5486 }
5488 # check the location of the inline attribute, that it is between
5489 # storage class and type.
5494 }
5496 # Check for __inline__ and __inline, prefer inline
5504 }
5505 }
5507 # Check for __attribute__ packed, prefer __packed
5512 }
5514 # Check for __attribute__ aligned, prefer __aligned
5519 }
5521 # Check for __attribute__ format(printf, prefer __printf
5525 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5527 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5529 }
5530 }
5532 # Check for __attribute__ format(scanf, prefer __scanf
5536 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5538 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5539 }
5540 }
5542 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5544 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5549 }
5551 # check for c99 types like uint8_t used outside of uapi/
5565 }
5566 }
5567 }
5569 # check for cast of C90 native int or longer types constants
5584 }
5586 }
5587 }
5589 # check for sizeof(&)
5593 }
5595 # check for sizeof without parenthesis
5600 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5601 }
5602 }
5604 # check for struct spinlock declarations
5608 }
5610 # check for seq_printf uses that could be seq_puts
5619 }
5620 }
5621 }
5623 # Check for misused memsets
5638 }
5639 }
5641 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5642 # if ($^V && $^V ge 5.10.0 &&
5643 # defined $stat &&
5644 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5645 # if (WARN("PREFER_ETHER_ADDR_COPY",
5646 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5647 # $fix) {
5648 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5649 # }
5650 # }
5652 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5653 # if ($^V && $^V ge 5.10.0 &&
5654 # defined $stat &&
5655 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5656 # WARN("PREFER_ETHER_ADDR_EQUAL",
5657 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5658 # }
5660 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5661 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5662 # if ($^V && $^V ge 5.10.0 &&
5663 # defined $stat &&
5664 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5665 #
5666 # my $ms_val = $7;
5667 #
5668 # if ($ms_val =~ /^(?:0x|)0+$/i) {
5669 # if (WARN("PREFER_ETH_ZERO_ADDR",
5670 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
5671 # $fix) {
5672 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
5673 # }
5674 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
5675 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
5676 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
5677 # $fix) {
5678 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
5679 # }
5680 # }
5681 # }
5683 # typecasts on min/max could be min_t/max_t
5701 }
5704 }
5705 }
5707 # check usleep_range arguments
5715 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5719 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
5720 }
5721 }
5723 # check for naked sscanf
5735 }
5738 }
5740 # check for simple sscanf that should be kstrto<foo>
5749 }
5757 }
5758 }
5759 }
5761 # check for new externs in .h files.
5768 }
5769 }
5771 # check for new externs in .c files.
5774 {
5781 }
5784 {
5787 }
5792 }
5796 {
5799 }
5810 }
5811 }
5812 }
5814 # checks for new __setup's
5821 }
5822 }
5824 # check for pointless casting of kmalloc return
5827 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
5828 }
5830 # alloc style
5831 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
5833 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
5836 }
5838 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
5840 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
5851 }
5857 $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;
5859 }
5860 }
5861 }
5863 # check for krealloc arg reuse
5868 }
5870 # check for alloc argument mismatch
5874 }
5876 # check for multiple semicolons
5882 }
5883 }
5885 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
5894 }
5895 }
5897 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
5898 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
5904 }
5905 }
5907 # check for case / default statements not preceded by break/fallthrough/switch
5925 }
5929 }
5930 }
5932 # check for switch/default statements without a break;
5941 }
5944 }
5946 # check for gcc specific __FUNCTION__
5952 }
5953 }
5955 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
5959 }
5961 # check for use of yield()
5965 }
5967 # check for comparisons against true and false
5983 }
5988 ## maybe suggesting a correct construct would better
5989 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
5991 }
5992 }
5994 # check for semaphores initialized locked
5998 }
6000 # recommend kstrto* over simple_strto* and strict_strto*
6004 }
6006 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6009 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6010 }
6012 # check for various structs that are normally const (ops, kgdb, device_tree)
6018 }
6020 # use of NR_CPUS is usually wrong
6021 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6028 {
6030 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6031 }
6033 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6037 }
6039 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6044 }
6046 # whine mightly about in_atomic
6054 }
6055 }
6057 # whine about ACCESS_ONCE
6068 $fixed[$fixlinenr] =~ s/\bACCESS_ONCE\s*\(\s*\Q$par\E\s*\)\s*$eq\s*\Q$fun\E/WRITE_ONCE($par, $fun)/;
6069 }
6075 }
6076 }
6077 }
6079 # check for lockdep_set_novalidate_class
6087 }
6088 }
6093 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6094 }
6096 # Mode permission misuses where it seems decimal should be octal
6097 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6110 }
6116 }
6125 }
6128 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6129 }
6130 }
6131 }
6132 }
6134 # check for uses of S_<PERMS> that could be octal for readability
6151 }
6156 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6159 }
6160 }
6162 # validate content of MODULE_LICENSE against list from include/linux/module.h
6166 GPL|
6167 GPL\ v2|
6172 Proprietary
6177 }
6178 }
6179 }
6181 # If we have no input at all, then there is nothing to report on
6182 # so just keep quiet.
6185 }
6187 # In mailback mode only produce a report in the negative, for
6188 # things that appear to be patches.
6191 }
6193 # This is not a patch, and we are are in 'no-patch' mode so
6194 # just keep quiet.
6197 }
6202 }
6206 }
6214 }
6217 # If there were any defects found and not already fixing them
6223 EOM
6224 }
6225 # If there were whitespace errors which cleanpatch can fix
6226 # then suggest that.
6233 EOM
6234 }
6235 }
6255 }
6258 }
6259 }
6267 Do _NOT_ trust the results written to this file.
6270 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6272 EOM
6273 }
6274 }
6282 }
6283 }
6285 }