| blob | 161b0224d6ae9ca927269664eaded3bcce41e91f |
1 #!/usr/bin/env perl
2 # SPDX-License-Identifier: GPL-2.0
3 #
4 # (c) 2001, Dave Jones. (the file handling bit)
5 # (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit)
6 # (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite)
7 # (c) 2008-2010 Andy Whitcroft <apw@canonical.com>
8 # (c) 2010-2018 Joe Perches <joe@perches.com>
73 Options:
78 --emacs emacs compile window format
79 --terse one line per report
82 single git commit with:
86 multiple git commits with:
90 git merges are ignored
105 is all off)
107 literally
110 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
111 with potential errors corrected to the preferred
112 checkpatch style
117 runtime errors.
120 --codespellfile Use this codespell dictionary
121 --typedefsfile Read additional types from this file
127 EOM
130 }
135 }
151 # Also catch when type or level is passed through a variable
152 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
154 }
159 }
162 }
184 }
185 }
188 }
190 # Perl's Getopt::Long allows options to take optional arguments after a space.
191 # Prevent --color by itself from consuming other arguments
195 }
196 }
198 GetOptions(
249 }
251 #if no filenames are given, push '-' to read patch from stdin
254 }
266 }
282 }
283 }
292 }
294 }
295 }
305 ## no critic
308 }
315 }
321 }
328 }
329 }
334 }
335 }
345 __user|
346 __kernel|
347 __force|
348 __iomem|
349 __must_check|
350 __kprobes|
351 __ref|
352 __refconst|
353 __refdata|
354 __rcu|
355 __private
363 # Notes to $Attribute:
364 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
366 const|
367 __percpu|
368 __nocast|
369 __safe|
370 __bitwise|
371 __packed__|
372 __packed2__|
373 __naked|
374 __maybe_unused|
375 __always_unused|
376 __noreturn|
377 __used|
378 __cold|
379 __pure|
380 __noclone|
381 __deprecated|
382 __read_mostly|
383 __ro_after_init|
384 __kprobes|
386 ____cacheline_aligned|
387 ____cacheline_aligned_in_smp|
388 ____cacheline_internodealigned_in_smp|
389 __weak
411 <=|>=|==|!=|
412 =>|->|<<|>>|<|>|!|~|
446 )};
449 atomic_t
450 )};
455 )};
461 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
462 TP_printk|
464 panic|
467 )};
476 To:|
477 Cc:
478 )};
497 );
520 );
541 )};
548 );
552 );
559 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
566 );
568 #Create a search pattern for all these functions to speed up a loop below
573 }
577 S_IWUGO |
578 S_IWOTH |
579 S_IRWXUGO |
580 S_IALLUGO |
601 );
603 #Create a search pattern for all these strings to speed up a loop below
608 }
635 }
639 }
642 irq|
643 memory|
645 reboot
646 )};
647 # memory.h: ARM has a custom one
649 # Load common spelling mistakes and build regular expression list.
666 }
670 }
689 }
693 }
694 }
713 }
717 }
720 }
723 }
733 }
752 )
759 )
768 )
772 $NonptrType
777 $NonptrTypeMisordered
783 }
784 build_types();
788 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
789 # requires at least perl version v5.10.0
790 # Any use must be runtime checked with $^V
801 )};
810 }
815 }
839 }
840 }
841 }
848 my $status = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
851 }
856 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
862 }
886 }
888 }
896 }
900 }
905 }
909 }
917 }
919 }
920 }
934 # Maybe one day convert this block of bash into something that returns
935 # all matching commit ids, but it's very slow...
936 #
937 # echo "checking commits $1..."
938 # git rev-list --remotes | grep -i "^$1" |
939 # while read line ; do
940 # git log --format='%H %s' -1 $line |
941 # echo "commit $(cut -c 1-12,41-)"
942 # done
943 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
948 }
951 }
962 # If input is git commits, extract all commits from the commit expressions.
963 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
976 }
985 }
986 }
989 }
1005 }
1012 }
1016 }
1023 }
1027 }
1036 build_types();
1037 }
1048 EOM
1049 }
1055 EOM
1056 }
1057 }
1068 );
1073 }
1074 }
1076 }
1099 # If there's a name left after stripping spaces and
1100 # leading quotes, and the address doesn't have both
1101 # leading and trailing angle brackets, the address
1102 # is invalid. ie:
1103 # "joe smith joe@smith.com" bad
1104 # "joe smith <joe@smith.com" bad
1109 }
1110 }
1120 }
1123 }
1137 }
1143 }
1146 }
1154 }
1155 }
1158 }
1166 }
1167 }
1170 }
1183 }
1185 }
1188 }
1191 }
1195 }
1200 # Drop the diff line leader and expand tabs
1204 # Pick the indent from the front of the line.
1208 }
1219 }
1220 }
1231 # Always copy over the diff marker.
1237 # Comments we are whacking completely including the begin
1238 # and end, all to $;.
1245 }
1251 }
1258 }
1260 # A \ in a string means ignore the next character.
1266 }
1267 # Regular quotes.
1276 }
1277 }
1279 #print "c<$c> SQ<$sanitise_quote>\n";
1288 }
1289 }
1293 }
1295 # The pathname on a #include may be surrounded by '<' and '>'.
1300 # The whole of a #error is a string.
1304 }
1309 }
1312 }
1320 }
1343 #warn "CSB: blk<$blk> remain<$remain>\n";
1344 # If we are about to drop off the end, pull in more
1345 # context.
1356 }
1357 # Bail if there is no further context.
1358 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1361 }
1365 }
1366 }
1371 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1373 # Handle nested #if/#else.
1380 }
1382 # Statement ends at the ';' or a close '}' at the
1383 # outermost level.
1386 }
1388 # An else is really a conditional as long as its not else if
1395 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1396 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1397 }
1402 }
1410 #warn "CSB: mark coff<$coff>\n";
1411 }
1412 }
1416 }
1424 }
1426 }
1427 }
1428 # Preprocessor commands end at the newline unless escaped.
1434 }
1436 }
1437 # We are truly at the end, so shuffle to the next line.
1442 }
1447 #warn "STATEMENT<$statement>\n";
1448 #warn "CONDITION<$condition>\n";
1450 #print "coff<$coff> soff<$off> loff<$loff>\n";
1454 }
1459 # Strip the diff line prefixes and rip blank lines at start and end.
1467 }
1475 }
1496 }
1497 }
1505 # Grab the first conditional/block pair.
1508 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1512 }
1514 # Pull in the following conditional/block pairs and see if they
1515 # could continue the statement.
1519 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1521 #print "C: push\n";
1523 }
1526 }
1545 # Handle nested #if/#else.
1552 }
1555 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1559 }
1566 }
1567 }
1571 }
1574 }
1577 }
1583 }
1589 }
1595 }
1600 }
1605 }
1610 # Catch a comment on the end of the line itself.
1614 # Look through the context and try and figure out if there is a
1615 # comment.
1620 #warn " $line\n";
1623 }
1626 }
1629 }
1633 }
1634 }
1638 }
1643 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1644 ##print "CMMT: $cmt\n";
1647 }
1660 }
1663 }
1671 }
1674 }
1682 }
1685 }
1697 }
1698 }
1702 }
1714 }
1734 }
1755 }
1784 # Assume all arms of the conditional end as this
1785 # one does, and continue as if the #endif was not here.
1802 }
1833 }
1845 }
1878 }
1893 }
1902 }
1906 }
1910 }
1911 }
1914 }
1923 DEFINE_\S+
1924 )$|
1928 case|
1932 \#|
1933 \#\#|
1939 # Check for modifiers.
1950 }
1951 }
1956 }
1957 build_types();
1960 }
1961 }
1973 }
1981 }
1990 }
1991 }
1996 }
2004 }
2010 }
2014 }
2025 }
2026 }
2053 }
2059 }
2066 }
2071 }
2074 }
2077 }
2085 };
2087 }
2095 };
2098 }
2107 }
2109 }
2117 }
2119 }
2127 }
2129 }
2135 ##print "absolute<$absolute>\n";
2137 # See if any suffix of this path is a path within the tree.
2140 ##print "file<$file>\n";
2142 }
2143 }
2146 }
2148 # It is, so see if the prefix is acceptable.
2152 ##print "prefix<$prefix>\n";
2156 }
2157 }
2165 }
2173 }
2181 }
2189 }
2198 #convert leading spaces to tabs
2200 #Remove spaces before a tab
2204 }
2218 }
2230 }
2231 }
2234 }
2275 # Trace the real file/line as we go.
2288 # suppression flags
2296 # Pre-scan the patch sanitizing the lines.
2297 # Pre-scan the patch looking for any __setup documentation.
2298 #
2306 sanitise_line_reset();
2318 }
2319 #next;
2320 }
2327 }
2330 # Guestimate if this is a continuing comment. Run
2331 # the context looking for a comment "edge". If this
2332 # edge is a close comment then we must be in a comment
2333 # at context start.
2340 #print "RAW<$rawlines[$ln - 1]>\n";
2346 }
2347 }
2350 }
2352 # Guestimate if this is a continuing comment. If this
2353 # is the start of a diff block and this line starts
2354 # ' *' then it is very likely a comment.
2357 {
2359 }
2361 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2365 # Standardise the strings and chars within the input to
2366 # simplify matching -- only bother with positive lines.
2368 }
2375 }
2377 #print "==>$rawline\n";
2378 #print "-->$line\n";
2382 }
2383 }
2398 # check if it's a mode change, rename or start of a patch
2404 }
2406 #extract the line range in the file after the patch is applied
2417 }
2418 annotate_reset();
2429 }
2432 # track the line number as we move through the hunk, note that
2433 # new versions of GNU diff omit the leading space on completely
2434 # blank context lines so we need to count that too.
2439 # Measure the line length and indent.
2442 # Track the previous line.
2447 #warn "line<$line>\n";
2451 }
2459 # extract the filename as it passes
2475 }
2479 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2480 }
2482 }
2484 #make up the handle for any error we report on this line
2492 }
2493 }
2498 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2499 }
2504 }
2515 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2516 }
2517 }
2520 }
2530 # Verify the existence of a commit log if appropriate
2531 # 2 is used because a $signature is counted in $commit_log_lines
2535 }
2540 }
2542 # Check if the commit log has what seems like a diff which can confuse patch
2551 }
2553 # Check for incorrect file permissions
2560 }
2561 }
2563 # Check the patch for a From:
2568 }
2570 # Check the patch for a signoff:
2579 }
2580 }
2581 }
2583 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2584 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2587 }
2589 # Check signature styles
2601 }
2608 }
2609 }
2616 }
2618 }
2625 }
2626 }
2637 # Don't force email to have quotes
2638 # Allow just an angle bracketed address
2644 }
2645 }
2647 # Check for duplicate signatures
2656 }
2657 }
2659 # Check email subject for common tools that don't need to be mentioned
2664 }
2666 # Check for unwanted Gerrit info
2670 }
2672 # Check if the commit log is in a possible stack dump
2676 # timestamp
2678 # stack dump address
2680 }
2682 # Check for line lengths > 75 in commit log, warn once
2686 # file delta changes
2688 # filename then :
2690 # A Fixes: or Link: line
2695 }
2697 # Reset possible stack dump if a blank line is found
2701 }
2703 # Check for git id commit length and improperly formed commit descriptions
2728 }
2750 }
2758 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2759 }
2760 }
2762 # Check for added, moved or deleted files
2772 }
2774 # Check for wrappage within a valid hunk of the file
2779 }
2781 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2792 }
2794 # Check if it's the start of a commit log
2795 # (not a header line and we haven't seen the patch filename)
2802 }
2804 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2805 # declined it, i.e defined some charset where it is missing.
2810 }
2816 }
2818 # Check for absolute kernel paths in commit message
2825 #
2828 }
2829 }
2830 }
2832 # Check for various typo / spelling mistakes
2846 }
2847 }
2848 }
2850 # ignore non-hunk lines and lines being removed
2853 #trailing whitespace
2860 }
2867 }
2870 }
2872 # Check for FSF mailing addresses.
2881 "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)
2882 }
2884 # check for Kconfig help text having a real description
2885 # Only applies when adding the entry originally, after that we do not have
2886 # sufficient context to determine whether it is indeed long enough.
2888 # 'choice' is usually the last thing on the line (though
2889 # Kconfig supports named choices), so use a word boundary
2890 # (\b) rather than a whitespace character (\s)
2912 }
2914 }
2921 # This only checks context lines in the patch
2922 # and so hopefully shouldn't trigger false
2923 # positives, even though some of these are
2924 # common words in help texts
2929 }
2931 }
2935 }
2936 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
2937 }
2939 # check for MAINTAINERS entries that don't have the right form
2947 }
2948 }
2950 # discourage the use of boolean for type definition attributes of Kconfig options
2955 }
2965 };
2968 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
2969 }
2971 # check for DT compatible documentation
2990 }
2997 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
2998 }
2999 }
3000 }
3002 # check for using SPDX license tag at beginning of files
3016 }
3027 }
3028 }
3029 }
3030 }
3032 # check we are in a valid source file if not then ignore this hunk
3035 # line length limit (with some exclusions)
3036 #
3037 # There are a few types of lines that may extend beyond $max_line_length:
3038 # logging functions like pr_info that end in a string
3039 # lines with a single string
3040 # #defines that are a single string
3041 # lines with an RFC3986 like URL
3042 #
3043 # There are 3 different line length message types:
3044 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3045 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3046 # LONG_LINE all other lines longer than $max_line_length
3047 #
3048 # if LONG_LINE is ignored, the other 2 types are also ignored
3049 #
3054 # Check the allowed long line types first
3056 # logging functions that end in a string that starts
3057 # before $max_line_length
3058 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3062 # lines with only strings (w/ possible termination)
3063 # #defines with only strings
3068 # More special cases
3073 # URL ($rawline is used in case the URL is in a comment)
3077 # Otherwise set the alternate message types
3079 # a comment starts before $max_line_length
3084 # a quoted string starts before $max_line_length
3088 }
3094 }
3095 }
3097 # check for adding lines without a newline.
3098 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3101 }
3103 # check we are in a valid source file C or perl if not then ignore this hunk
3106 # at the beginning of a line any tabs must come first and anything
3107 # more than 8 must use tabs.
3116 }
3117 }
3119 # check for space before tabs.
3129 }
3130 }
3132 # check for assignments on the start of a line
3136 }
3138 # check for && or || at the start of a line
3142 }
3144 # check indentation starts on a tab stop
3146 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3153 }
3154 }
3155 }
3157 # check multi-line statement indentation matches previous line
3159 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3182 }
3183 }
3184 }
3185 }
3187 # check for space after cast like "(int) foo" or "(struct foo) bar"
3188 # avoid checking a few false positives:
3189 # "sizeof(<type>)" or "__alignof__(<type>)"
3190 # function pointer declarations like "(*foo)(int) = bar;"
3191 # structure definitions like "(struct foo) { 0 };"
3192 # multiline macros that define functions
3193 # known attributes or the __attribute__ keyword
3201 }
3202 }
3204 # Block comment styles
3205 # Networking with an initial /*
3212 }
3214 # Block comments use * on subsequent lines
3222 }
3224 # Block comments use */ on trailing lines
3231 }
3233 # Block comment * alignment
3247 }
3254 }
3255 }
3257 # check for missing blank lines after struct/union declarations
3258 # with exceptions for various attributes and macros
3274 }
3275 }
3277 # check for multiple consecutive blank lines
3285 }
3288 }
3290 # check for missing blank lines after declarations
3292 # actual declarations
3294 # function pointer declarations
3296 # foo bar; where foo is some local typedef or #define
3298 # known declaration macros
3300 # for "else if" which can look like "$Ident $Ident"
3302 # other possible extensions of declaration lines
3304 # not starting a section or a macro "\" extended line
3306 # looks like a declaration
3308 # function pointer declarations
3310 # foo bar; where foo is some local typedef or #define
3312 # known declaration macros
3314 # start of struct or union or enum
3316 # start or end of block or continuation of declaration
3318 # bitfield continuation
3320 # other possible extensions of declaration lines
3322 # indentation of previous and current line are the same
3328 }
3329 }
3331 # check for spaces at the beginning of a line.
3332 # Exceptions:
3333 # 1) within comments
3334 # 2) indented preprocessor commands
3335 # 3) hanging labels
3342 }
3343 }
3345 # check we are in a valid C source file if not then ignore this hunk
3348 # check for unusual line ending [ or (
3352 }
3354 # check if this appears to be the start function declaration, save the name
3358 }
3360 # check if this appears to be the end of function declaration
3363 }
3365 # check indentation of any line with a bare else
3366 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3367 # if the previous line is a break or return and is indented 1 tab more...
3376 }
3377 }
3379 # check indentation of a line with a break;
3380 # if the previous line is a goto or return and is indented the same # of tabs
3386 }
3387 }
3389 # check for RCS/CVS revision markers
3393 }
3395 # check for old HOTPLUG __dev<foo> section markings
3399 }
3401 # Check for potential 'bare' types
3404 #print "LINE<$line>\n";
3412 #print "linenr<$linenr> <$stat>\n";
3413 # If this statement has no statement boundaries within
3414 # it there is no point in retrying a statement scan
3415 # until we hit end of it.
3418 #print "skip<$line_nr_next>\n";
3420 }
3422 # Find the real next line.
3428 }
3433 # Ignore goto labels.
3436 # Ignore functions being called
3441 # declarations always start with types
3442 } 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) {
3447 # definitions in global scope can only start with types
3450 }
3452 # any (foo ... *) is a pointer cast, and foo is a type
3455 }
3457 # Check for any sort of function declaration.
3458 # int foo(something bar, other baz);
3459 # void (*store_gdt)(x86_descr_ptr *);
3460 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3468 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3471 }
3472 }
3473 }
3475 }
3477 #
3478 # Checks which may be anchored in the context.
3479 #
3481 # Check for switch () and associated case and default
3482 # statements should be at the same indent.
3496 }
3497 }
3501 }
3502 }
3504 # if/while/etc brace do not go on next line, unless defining a do while loop,
3505 # or if that brace on the next line is for something else
3506 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3514 }
3525 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3528 }
3530 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3531 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3537 }
3541 {
3547 }
3548 }
3549 }
3551 # Check relative indent for conditionals and blocks.
3552 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3560 # remove inline comments
3564 # Find out how long the conditional actually is.
3568 # Make sure we remove the line prefixes as we have
3569 # none on the first line, and are going to readd them
3570 # where necessary.
3574 }
3576 # We want to check the first line inside the block
3577 # starting at the end of the conditional, so remove:
3578 # 1) any blank line termination
3579 # 2) any opening brace { on end of the line
3580 # 3) any do (...) {
3587 }
3591 }
3593 # Also ignore a loop construct at the end of a
3594 # preprocessor statement.
3598 }
3605 # If we see an #else/#elif then the code
3606 # is not linear.
3609 }
3611 # Ignore:
3612 # 1) blank lines, they should be at 0,
3613 # 2) preprocessor lines, and
3614 # 3) labels.
3622 }
3623 }
3624 }
3629 # Check if either of these lines are modified, else
3630 # this is not this patch's fault.
3634 }
3637 }
3639 #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";
3648 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3649 }
3650 }
3652 # Track the 'values' across context and added lines.
3662 }
3665 #ignore lines not being added
3668 # check for dereferences that span multiple lines
3678 }
3680 # check for declarations of signed or unsigned without int
3681 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3692 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3700 }
3701 }
3702 }
3704 # TEST: allow direct testing of the type matcher.
3712 }
3714 }
3715 # TEST: allow direct testing of the attribute matcher.
3723 }
3725 }
3727 # check for initialisation to aggregates open brace on the next line
3741 }
3742 }
3744 #
3745 # Checks which are anchored on the added line.
3746 #
3748 # check for malformed paths in #include statements (uses RAW line)
3754 }
3758 }
3759 }
3761 # no C99 // comments
3770 }
3771 }
3772 }
3773 # Remove C99 comments.
3777 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3778 # the whole statement.
3779 #print "APW <$lines[$realline_next - 1]>\n";
3785 # Handle definitions which produce identifiers with
3786 # a prefix:
3787 # XXX(foo);
3788 # EXPORT_SYMBOL(something_foo);
3792 #print "FOO C name<$name>\n";
3803 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3807 }
3808 }
3813 #print "FOO B <$lines[$linenr - 1]>\n";
3815 }
3820 }
3822 # check for global initialisers.
3828 }
3829 }
3830 # check for static initialisers.
3837 }
3838 }
3840 # check for misordered declarations of char/short/int/long with signed/unsigned
3844 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3845 }
3847 # check for unnecessary <signed> int declarations of short/long/long long
3864 }
3865 }
3867 # check for static const char * arrays.
3872 }
3874 # check for static char foo[] = "bar" declarations.
3879 }
3881 # check for const <foo> const where <foo> is not a pointer or array type
3890 }
3891 }
3893 # check for non-global char *foo[] = {"bar", ...} declarations.
3898 }
3900 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
3903 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
3909 }
3910 }
3911 }
3913 # check for function declarations without arguments like "int foo()"
3919 }
3920 }
3922 # check for new typedefs, only function parameters and sparse annotations
3923 # make sense.
3931 }
3933 # * goes on variable not on type
3934 # (char*[ const])
3936 #print "AA<$1>\n";
3939 # Should start with a space.
3941 # Should not end with a space.
3943 # '*'s should not have spaces between.
3945 }
3947 ## print "1: from<$from> to<$to> ident<$ident>\n";
3957 }
3958 }
3959 }
3961 #print "BB<$1>\n";
3964 # Should start with a space.
3966 # Should not end with a space.
3968 # '*'s should not have spaces between.
3970 }
3971 # Modifiers should have spaces.
3974 ## print "2: from<$from> to<$to> ident<$ident>\n";
3985 }
3986 }
3987 }
3989 # avoid BUG() or BUG_ON()
3994 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
3995 }
3997 # avoid LINUX_VERSION_CODE
4000 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4001 }
4003 # check for uses of printk_ratelimit
4007 }
4009 # printk should use KERN_* levels
4013 }
4022 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
4023 }
4031 }
4032 }
4041 }
4043 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4044 # number of false positives, but assembly files are not checked, so at
4045 # least the arch entry code will not trigger this warning.
4049 }
4051 # function brace can't be on same line, except for #defines of do while,
4052 # or if closed on same line
4069 }
4070 }
4071 }
4073 # open braces for enum, union and struct go on the same line.
4087 }
4088 }
4089 }
4091 # missing space after union, struct or enum definition
4098 }
4099 }
4101 # Function pointer declarations
4102 # check spacing between type, funcptr, and args
4103 # canonical declaration is "type (*funcptr)(args...)"
4112 # the $Declare variable will capture all spaces after the type
4113 # so check it for a missing trailing missing space but pointer return types
4114 # don't need a space so don't warn for those.
4119 }
4124 }
4126 # unnecessary space "type (*funcptr)(args...)"
4127 # This test is not currently implemented because these declarations are
4128 # equivalent to
4129 # int foo(int bar, ...)
4130 # and this is form shouldn't/doesn't generate a checkpatch warning.
4131 #
4132 # elsif ($declare =~ /\s{2,}$/) {
4133 # WARN("SPACING",
4134 # "Multiple spaces after return type\n" . $herecurr);
4135 # }
4137 # unnecessary space "type ( *funcptr)(args...)"
4142 }
4144 # unnecessary space "type (* funcptr)(args...)"
4149 }
4151 # unnecessary space "type (*funcptr )(args...)"
4156 }
4158 # unnecessary space "type (*funcptr) (args...)"
4163 }
4167 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4168 }
4169 }
4171 # check for spacing round square brackets; allowed:
4172 # 1. with a type on the left -- int [] a;
4173 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4174 # 3. inside a curly brace -- = { [0...10] = 5 }
4185 }
4186 }
4187 }
4189 # check for spaces between functions and their parentheses.
4195 # Ignore those directives where spaces _are_ permitted.
4201 {
4202 # cpp #define statements have non-optional spaces, ie
4203 # if there is a space between the name and the open
4204 # parenthesis it is simply not a parameter group.
4207 # cpp #elif statement condition may start with a (
4210 # If this whole things ends with a type its most
4211 # likely a typedef for a function.
4220 }
4221 }
4222 }
4224 # Check operator spacing.
4230 <<=|>>=|<=|>=|==|!=|
4232 =>|->|<<|>>|<|>|=|!|~|
4238 ## print("element count: <" . $#elements . ">\n");
4239 ## foreach my $el (@elements) {
4240 ## print("el: <$el>\n");
4241 ## }
4249 }
4260 ## print("n: <$n> good: <$good>\n");
4264 # Pick up the preceding and succeeding characters.
4269 }
4292 }
4301 # Pull out the value of this operator.
4304 # Get the full operator variant.
4307 # Ignore operators passed as parameters.
4311 # # Ignore comments
4312 # } elsif ($op =~ /^$;+$/) {
4314 # ; should have either the end of line or a space or \ after it
4322 }
4323 }
4325 # // is a comment
4328 # : when part of a bitfield
4330 # skip the bitfield test for now
4332 # No spaces for:
4333 # ->
4341 }
4343 }
4344 }
4346 # , must not have a space before and must have a space on the right.
4355 }
4356 }
4363 }
4364 }
4370 }
4373 }
4374 }
4376 # '*' as part of a type definition -- reported already.
4378 #warn "'*' is part of type\n";
4380 # unary operators should have a space before and
4381 # none after. May be left adjacent to another
4382 # unary operator, or a cast
4392 }
4393 }
4394 }
4396 # A unary '*' may be const
4404 }
4406 }
4407 }
4409 # unary ++ and unary -- are allowed no space on one side.
4416 }
4417 }
4424 }
4425 }
4432 }
4434 }
4435 }
4437 # << and >> may either have or not have spaces both sides
4443 {
4451 }
4457 }
4458 }
4465 }
4467 }
4468 }
4470 # A colon needs no spaces before when it is
4471 # terminating a case value or a label.
4478 }
4479 }
4481 # All the others need spaces both sides.
4485 # Ignore email addresses <foo@bar>
4490 {
4492 }
4494 # for asm volatile statements
4495 # ignore a colon with another
4496 # colon immediately before or after
4500 }
4502 # messages are ERROR, but ?: are CHK
4512 }
4514 }
4515 }
4516 }
4519 ## print("n: <$n> GOOD: <$good>\n");
4522 }
4526 }
4530 }
4533 }
4535 # check for whitespace before a non-naked semicolon
4542 }
4543 }
4545 # check for multiple assignments
4549 }
4551 ## # check for multiple declarations, allowing for a function declaration
4552 ## # continuation.
4553 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4554 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4555 ##
4556 ## # Remove any bracketed sections to ensure we do not
4557 ## # falsly report the parameters of functions.
4558 ## my $ln = $line;
4559 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4560 ## }
4561 ## if ($ln =~ /,/) {
4562 ## WARN("MULTIPLE_DECLARATION",
4563 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4564 ## }
4565 ## }
4567 #need space before brace following if, while, etc
4574 }
4575 }
4577 ## # check for blank lines before declarations
4578 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4579 ## $prevrawline =~ /^.\s*$/) {
4580 ## WARN("SPACING",
4581 ## "No blank lines before declarations\n" . $hereprev);
4582 ## }
4583 ##
4585 # closing brace should have a space following it when it has anything
4586 # on the line
4593 }
4594 }
4596 # check spacing on square brackets
4603 }
4604 }
4611 }
4612 }
4614 # check spacing on parentheses
4622 }
4623 }
4632 }
4633 }
4635 # check unnecessary parentheses around addressof/dereference single $Lvals
4636 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4644 }
4645 }
4647 # check for unnecessary parentheses around function pointer uses
4648 # ie: (foo->bar)(); should be foo->bar();
4649 # but not "if (foo->bar) (" to avoid some false positives
4658 }
4659 }
4661 # check for unnecessary parentheses around comparisons in if uses
4662 # when !drivers/staging or command-line uses --strict
4669 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4671 # avoid parentheses around potential macro args
4680 }
4681 }
4684 }
4685 }
4687 #goto labels aren't indented, allow a single space however
4695 }
4696 }
4698 # return is not a function
4708 }
4712 }
4713 }
4715 # unnecessary return in a void function
4716 # at end-of-function, with the previous line a single leading tab, then return;
4717 # and the line before that not a goto label target like "out:"
4725 }
4727 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4733 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4738 }
4739 }
4741 # comparisons with a constant or upper case identifier on the left
4742 # avoid cases like "foo + BAR < baz"
4743 # only fix matches surrounded by parentheses to avoid incorrect
4744 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4765 }
4767 }
4768 }
4770 # Return of what appears to be an errno should normally be negative
4776 }
4777 }
4779 # Need a space before open parenthesis after if, while etc
4786 }
4787 }
4789 # Check for illegal assignment in if conditional -- and check for trailing
4790 # statements after the conditional.
4798 ##print "stat<$stat> stat_next<$stat_next>\n";
4801 # If the statement carries leading newlines,
4802 # then count those as offsets.
4810 }
4811 }
4820 }
4822 # Find out what is on the end of the line after the
4823 # conditional.
4829 {
4830 # Find out how long the conditional actually is.
4839 }
4843 }
4844 }
4846 # Check for bitwise tests written as boolean
4852 |
4857 {
4860 }
4862 # if and else should not have general statements after it
4869 }
4870 }
4871 # if should not continue a brace
4876 }
4877 # case and default should not have general statements after them
4883 {
4886 }
4888 # Check for }<nl>else {, these must be at the same
4889 # indent level to be relevant to each other.
4901 }
4905 }
4906 }
4912 # Find out what is on the end of the line after the
4913 # conditional.
4929 }
4930 }
4931 }
4933 #Specific variable tests
4937 #gcc binary extension
4945 }
4946 }
4948 #CamelCase
4951 #Ignore Page<foo> variants
4953 #Ignore SI style variants like nS, mV and dB (ie: max_uV, regulator_min_uA_show)
4955 #Ignore some three character SI units explicitly, like MiB and KHz
4961 seed_camelcase_includes();
4965 }
4966 }
4971 }
4972 }
4973 }
4974 }
4976 #no spaces allowed after \ in define
4982 }
4983 }
4985 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
4986 # itself <asm/foo.h> (uses RAW line)
4993 {
5002 }
5003 }
5004 }
5005 }
5007 # multi-statement macros should be enclosed in a do while loop, grab the
5008 # first statement and ensure its the whole macro if its not enclosed
5009 # in a known good container
5021 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5022 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5037 }
5044 # Flatten any parentheses and braces
5048 {
5049 }
5051 # Flatten any obvious string concatentation.
5054 {
5055 }
5057 # Make asm volatile uses seem like a generic function
5062 module_param_named|
5063 MODULE_PARM_DESC|
5064 DECLARE_PER_CPU|
5065 DEFINE_PER_CPU|
5066 __typeof__\(|
5067 union|
5068 struct|
5073 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5082 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5087 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5093 {
5096 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5103 }
5105 }
5107 # Make $define_stmt single line, comment-free, etc
5118 }
5119 }
5124 # check if any macro arguments are reused (ignore '...' and 'type')
5129 $tmp_stmt =~ s/\b(typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5136 }
5137 # check if any macro arguments may have other precedence issues
5143 }
5144 }
5146 # check for macros with flow control, but without ## concatenation
5147 # ## concatenation is commonly a macro that defines a function so ignore those
5154 }
5156 # check for line continuations outside of #defines, preprocessor #, and asm
5165 }
5166 }
5168 # do {} while (0) macro tests:
5169 # single-statement macros do not need to be enclosed in do while (0) loop,
5170 # macro should not end with a semicolon
5185 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5197 }
5201 }
5209 }
5210 }
5212 # check for redundant bracing round if etc
5216 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5217 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5227 # If the condition carries leading newlines, then count those as offsets.
5232 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5234 # We have looked at and allowed this specific line.
5244 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5246 #print "APW: ALLOWED: cond<$cond>\n";
5248 }
5250 #print "APW: ALLOWED: block<$block>\n";
5252 }
5254 #print "APW: ALLOWED: lines block<$block>\n";
5256 }
5258 }
5263 }
5271 }
5272 }
5273 }
5274 }
5279 # Check the pre-context.
5281 #print "APW: ALLOWED: pre<$1>\n";
5283 }
5288 # Check the condition.
5290 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5293 }
5295 #print "APW: ALLOWED: cond<$cond>\n";
5297 }
5299 #print "APW: ALLOWED: block<$block>\n";
5301 }
5303 #print "APW: ALLOWED: lines block<$block>\n";
5305 }
5306 # Check the post-context.
5311 }
5313 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5315 }
5316 }
5323 }
5324 }
5326 # check for single line unbalanced braces
5330 }
5332 # check for unnecessary blank lines around braces
5338 }
5339 }
5345 }
5346 }
5348 # no volatiles please
5352 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5353 }
5355 # Check for user-visible strings broken across lines, which breaks the ability
5356 # to grep for the string. Make exceptions when the previous string ends in a
5357 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5358 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5371 }
5383 }
5385 }
5386 }
5388 # check for missing a space in a string concatenation
5392 }
5394 # check for an embedded function name in a string when the function is known
5395 # This does not work very well for -f --file checking as it depends on patch
5396 # context providing the function name or a single line form for in-file
5397 # function declarations
5403 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5404 }
5406 # check for spaces before a quoted newline
5412 }
5414 }
5416 # concatenated string without spaces between elements
5425 }
5426 }
5427 }
5429 # uncoalesced string fragments
5437 }
5438 }
5439 }
5441 # check for non-standard and hex prefixed decimal printf formats
5447 # check for %L
5452 }
5453 # check for %Z
5458 }
5459 # check for 0x<decimal>
5463 }
5464 }
5466 # check for line continuations in quoted strings with odd counts of "
5470 }
5472 # warn about #if 0
5476 }
5478 # warn about #if 1
5482 }
5484 # check for needless "if (<foo>) fn(<foo>)" uses
5488 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5500 }
5505 }
5508 }
5512 }
5513 }
5514 }
5515 }
5517 # check for unnecessary "Out of Memory" messages
5526 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5528 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*(?:devm_)?(?:[kv][czm]alloc(?:_node|_array)?\b|kstrdup|kmemdup|(?:dev_)?alloc_skb)/) {
5531 }
5532 }
5534 # check for logging functions with KERN_<LEVEL>
5542 }
5543 }
5545 # check for logging continuations
5549 }
5551 # check for mask then right shift without a parentheses
5557 }
5559 # check for pointer comparisons to NULL
5569 }
5570 }
5571 }
5573 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5576 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5586 $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;
5587 }
5588 }
5589 }
5591 # check for $InitAttributeData (ie: __initdata) with const
5602 }
5603 }
5605 # check for $InitAttributeConst (ie: __initconst) without const
5617 }
5618 }
5620 # check for __read_mostly with const non-pointer (should just be const)
5627 }
5628 }
5630 # don't use __constant_<foo> functions outside of include/uapi/
5632 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5640 }
5641 }
5643 # prefer usleep_range over udelay
5646 # ignore udelay's < 10, however
5649 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5650 }
5654 }
5655 }
5657 # warn about unexpectedly long msleep's
5661 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.txt\n" . $herecurr);
5662 }
5663 }
5665 # check for comparisons of jiffies
5668 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5669 }
5671 # check for comparisons of get_jiffies_64()
5674 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5675 }
5677 # warn about #ifdefs in C files
5678 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5679 # print "#ifdef in C files should be avoided\n";
5680 # print "$herecurr";
5681 # $clean = 0;
5682 # }
5684 # warn about spacing in #ifdefs
5691 }
5693 }
5695 # check for spinlock_t definitions without a comment.
5702 }
5703 }
5704 # check for memory barriers without a comment.
5707 mb|
5708 rmb|
5709 wmb|
5710 read_barrier_depends
5713 mb__before_atomic|
5714 mb__after_atomic|
5715 store_release|
5716 load_acquire|
5717 store_mb|
5730 }
5731 }
5741 }
5743 # check for waitqueue_active without a comment.
5748 }
5749 }
5751 # check for smp_read_barrier_depends and read_barrier_depends
5755 }
5757 # check of hardware specific defines
5758 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5761 }
5763 # check that the storage class is not after a type
5767 }
5768 # Check that the storage class is at the beginning of a declaration
5775 }
5777 # check the location of the inline attribute, that it is between
5778 # storage class and type.
5783 }
5785 # Check for __inline__ and __inline, prefer inline
5793 }
5794 }
5796 # Check for __attribute__ packed, prefer __packed
5801 }
5803 # Check for __attribute__ aligned, prefer __aligned
5808 }
5810 # Check for __attribute__ format(printf, prefer __printf
5814 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5816 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5818 }
5819 }
5821 # Check for __attribute__ format(scanf, prefer __scanf
5825 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5827 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5828 }
5829 }
5831 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5833 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5838 }
5840 # check for c99 types like uint8_t used outside of uapi/ and tools/
5855 }
5856 }
5857 }
5859 # check for cast of C90 native int or longer types constants
5874 }
5876 }
5877 }
5879 # check for sizeof(&)
5883 }
5885 # check for sizeof without parenthesis
5890 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5891 }
5892 }
5894 # check for struct spinlock declarations
5898 }
5900 # check for seq_printf uses that could be seq_puts
5909 }
5910 }
5911 }
5913 # check for vsprintf extension %p<foo> misuses
5935 }
5939 }
5941 "Using vsprintf specifier '\%px' potentially exposes the kernel memory layout, if you don't really need the address please consider using '\%p'.\n" . "$here\n$stat_real\n");
5942 }
5943 }
5952 }
5956 }
5957 }
5958 }
5960 # Check for misused memsets
5975 }
5976 }
5978 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
5979 # if ($perl_version_ok &&
5980 # defined $stat &&
5981 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5982 # if (WARN("PREFER_ETHER_ADDR_COPY",
5983 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
5984 # $fix) {
5985 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
5986 # }
5987 # }
5989 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
5990 # if ($perl_version_ok &&
5991 # defined $stat &&
5992 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
5993 # WARN("PREFER_ETHER_ADDR_EQUAL",
5994 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
5995 # }
5997 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
5998 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
5999 # if ($perl_version_ok &&
6000 # defined $stat &&
6001 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6002 #
6003 # my $ms_val = $7;
6004 #
6005 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6006 # if (WARN("PREFER_ETH_ZERO_ADDR",
6007 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6008 # $fix) {
6009 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6010 # }
6011 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6012 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6013 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6014 # $fix) {
6015 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6016 # }
6017 # }
6018 # }
6020 # typecasts on min/max could be min_t/max_t
6038 }
6041 }
6042 }
6044 # check usleep_range arguments
6052 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
6056 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.txt\n" . "$here\n$stat\n");
6057 }
6058 }
6060 # check for naked sscanf
6072 }
6074 # check for simple sscanf that should be kstrto<foo>
6088 }
6089 }
6090 }
6092 # check for new externs in .h files.
6099 }
6100 }
6102 # check for new externs in .c files.
6105 {
6112 }
6115 {
6118 }
6123 }
6127 {
6130 }
6132 # check for function declarations that have arguments without identifier names
6134 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6142 }
6143 }
6144 }
6146 # check for function definitions
6152 # check for multiline function definition with misplaced open brace
6162 }
6166 }
6167 }
6169 # checks for new __setup's
6175 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6176 }
6177 }
6179 # check for pointless casting of kmalloc return
6182 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6183 }
6185 # alloc style
6186 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6188 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*([kv][mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6191 }
6193 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6196 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6207 }
6217 $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;
6218 }
6219 }
6220 }
6222 # check for krealloc arg reuse
6228 }
6230 # check for alloc argument mismatch
6234 }
6236 # check for multiple semicolons
6242 }
6243 }
6245 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6254 }
6255 }
6257 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6258 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6264 }
6265 }
6267 # check for case / default statements not preceded by break/fallthrough/switch
6284 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6285 }
6289 }
6290 }
6292 # check for switch/default statements without a break;
6301 }
6303 # check for gcc specific __FUNCTION__
6309 }
6310 }
6312 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6316 }
6318 # check for use of yield()
6322 }
6324 # check for comparisons against true and false
6340 }
6345 ## maybe suggesting a correct construct would better
6346 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6348 }
6349 }
6351 # check for bool bitfields
6354 "Avoid using bool as bitfield. Prefer bool bitfields as unsigned int or u<8|16|32>\n" . $herecurr);
6355 }
6357 # check for bool use in .h files
6361 "Avoid using bool structure members because of possible alignment issues - see: https://lkml.org/lkml/2017/11/21/384\n" . $herecurr);
6362 }
6364 # check for semaphores initialized locked
6368 }
6370 # recommend kstrto* over simple_strto* and strict_strto*
6374 }
6376 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6379 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6380 }
6382 # check for various structs that are normally const (ops, kgdb, device_tree)
6383 # and avoid what seem like struct definitions 'struct foo {'
6388 }
6390 # use of NR_CPUS is usually wrong
6391 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6398 {
6400 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6401 }
6403 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6407 }
6409 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6414 }
6416 # whine mightly about in_atomic
6424 }
6425 }
6427 # check for mutex_trylock_recursive usage
6431 }
6433 # check for lockdep_set_novalidate_class
6441 }
6442 }
6447 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6448 }
6450 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6451 # and whether or not function naming is typical and if
6452 # DEVICE_ATTR permissions uses are unusual too
6455 $stat =~ /\bDEVICE_ATTR\s*\(\s*(\w+)\s*,\s*\(?\s*(\s*(?:${multi_mode_perms_string_search}|0[0-7]{3,3})\s*)\s*\)?\s*,\s*(\w+)\s*,\s*(\w+)\s*\)/) {
6467 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6468 }
6475 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6476 }
6483 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6484 }
6495 }
6498 }
6504 }
6505 }
6507 # Mode permission misuses where it seems decimal should be octal
6508 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6509 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6510 # specific definition of not visible in sysfs.
6511 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6512 # use the default permissions
6528 }
6538 }
6541 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6542 }
6543 }
6544 }
6545 }
6547 # check for uses of S_<PERMS> that could be octal for readability
6552 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6555 }
6556 }
6558 # validate content of MODULE_LICENSE against list from include/linux/module.h
6562 GPL|
6563 GPL\ v2|
6568 Proprietary
6573 }
6574 }
6575 }
6577 # If we have no input at all, then there is nothing to report on
6578 # so just keep quiet.
6581 }
6583 # In mailback mode only produce a report in the negative, for
6584 # things that appear to be patches.
6587 }
6589 # This is not a patch, and we are are in 'no-patch' mode so
6590 # just keep quiet.
6593 }
6598 }
6606 }
6607 }
6615 }
6618 # If there were any defects found and not already fixing them
6624 EOM
6625 }
6626 # If there were whitespace errors which cleanpatch can fix
6627 # then suggest that.
6634 EOM
6635 }
6636 }
6656 }
6659 }
6660 }
6668 Do _NOT_ trust the results written to this file.
6671 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6673 EOM
6674 }
6675 }
6683 }
6684 }
6686 }