| blob | 7cbe6e72e363b79e8d464c68a73f4892a8382feb |
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>
65 # git output parsing needs US English output, so first set backtick child process LANGUAGE
75 Options:
80 --emacs emacs compile window format
81 --terse one line per report
84 single git commit with:
88 multiple git commits with:
92 git merges are ignored
107 is all off)
109 literally
112 "<inputfile>.EXPERIMENTAL-checkpatch-fixes"
113 with potential errors corrected to the preferred
114 checkpatch style
119 runtime errors.
122 --codespellfile Use this codespell dictionary
123 --typedefsfile Read additional types from this file
129 EOM
132 }
137 }
153 # Also catch when type or level is passed through a variable
154 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) {
156 }
161 }
164 }
186 }
187 }
190 }
192 # Perl's Getopt::Long allows options to take optional arguments after a space.
193 # Prevent --color by itself from consuming other arguments
197 }
198 }
200 GetOptions(
251 }
253 #if no filenames are given, push '-' to read patch from stdin
256 }
268 }
284 }
285 }
294 }
296 }
297 }
307 ## no critic
310 }
317 }
323 }
330 }
331 }
336 }
337 }
347 __user|
348 __kernel|
349 __force|
350 __iomem|
351 __must_check|
352 __kprobes|
353 __ref|
354 __refconst|
355 __refdata|
356 __rcu|
357 __private
365 # Notes to $Attribute:
366 # We need \b after 'init' otherwise 'initconst' will cause a false positive in a check
368 const|
369 __percpu|
370 __nocast|
371 __safe|
372 __bitwise|
373 __packed__|
374 __packed2__|
375 __naked|
376 __maybe_unused|
377 __always_unused|
378 __noreturn|
379 __used|
380 __cold|
381 __pure|
382 __noclone|
383 __deprecated|
384 __read_mostly|
385 __ro_after_init|
386 __kprobes|
388 ____cacheline_aligned|
389 ____cacheline_aligned_in_smp|
390 ____cacheline_internodealigned_in_smp|
391 __weak
413 <=|>=|==|!=|
414 =>|->|<<|>>|<|>|!|~|
448 )};
451 atomic_t
452 )};
457 )};
463 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)|
464 TP_printk|
466 panic|
469 )};
477 # dev_alloc_skb/netdev_alloc_skb, et al
478 dma_alloc_coherent
479 )};
489 To:|
490 Cc:
491 )};
510 );
533 );
554 )};
561 );
565 );
572 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2],
579 );
581 #Create a search pattern for all these functions to speed up a loop below
586 }
600 );
602 #Create a search pattern for all these strings to speed up a loop below
607 }
611 S_IWUGO |
612 S_IWOTH |
613 S_IRWXUGO |
614 S_IALLUGO |
635 );
637 #Create a search pattern for all these strings to speed up a loop below
642 }
669 }
673 }
676 irq|
677 memory|
679 reboot
680 )};
681 # memory.h: ARM has a custom one
683 # Load common spelling mistakes and build regular expression list.
700 }
704 }
723 }
727 }
728 }
747 }
751 }
754 }
757 }
767 }
786 )
793 )
802 )
806 $NonptrType
811 $NonptrTypeMisordered
817 }
818 build_types();
822 # Using $balanced_parens, $LvalOrFunc, or $FuncArg
823 # requires at least perl version v5.10.0
824 # Any use must be runtime checked with $^V
835 )};
844 }
849 }
873 }
874 }
875 }
885 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`;
886 }
889 }
894 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$root/.git"));
900 }
913 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`;
924 }
926 }
934 }
938 }
943 }
947 }
955 }
957 }
958 }
972 # Maybe one day convert this block of bash into something that returns
973 # all matching commit ids, but it's very slow...
974 #
975 # echo "checking commits $1..."
976 # git rev-list --remotes | grep -i "^$1" |
977 # while read line ; do
978 # git log --format='%H %s' -1 $line |
979 # echo "commit $(cut -c 1-12,41-)"
980 # done
981 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) {
986 }
989 }
1000 # If input is git commits, extract all commits from the commit expressions.
1001 # For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'.
1014 }
1023 }
1024 }
1027 }
1044 }
1051 }
1055 }
1062 }
1066 }
1075 build_types();
1076 }
1087 EOM
1088 }
1094 EOM
1095 }
1096 }
1107 );
1112 }
1113 }
1115 }
1138 # If there's a name left after stripping spaces and
1139 # leading quotes, and the address doesn't have both
1140 # leading and trailing angle brackets, the address
1141 # is invalid. ie:
1142 # "joe smith joe@smith.com" bad
1143 # "joe smith <joe@smith.com" bad
1148 }
1149 }
1159 }
1162 }
1176 }
1182 }
1185 }
1193 }
1194 }
1197 }
1205 }
1206 }
1209 }
1222 }
1224 }
1227 }
1230 }
1234 }
1239 # Drop the diff line leader and expand tabs
1243 # Pick the indent from the front of the line.
1247 }
1258 }
1259 }
1270 # Always copy over the diff marker.
1276 # Comments we are whacking completely including the begin
1277 # and end, all to $;.
1284 }
1290 }
1297 }
1299 # A \ in a string means ignore the next character.
1305 }
1306 # Regular quotes.
1315 }
1316 }
1318 #print "c<$c> SQ<$sanitise_quote>\n";
1327 }
1328 }
1332 }
1334 # The pathname on a #include may be surrounded by '<' and '>'.
1339 # The whole of a #error is a string.
1343 }
1348 }
1351 }
1359 }
1382 #warn "CSB: blk<$blk> remain<$remain>\n";
1383 # If we are about to drop off the end, pull in more
1384 # context.
1395 }
1396 # Bail if there is no further context.
1397 #warn "CSB: blk<$blk> off<$off> len<$len>\n";
1400 }
1404 }
1405 }
1410 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n";
1412 # Handle nested #if/#else.
1419 }
1421 # Statement ends at the ';' or a close '}' at the
1422 # outermost level.
1425 }
1427 # An else is really a conditional as long as its not else if
1434 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n";
1435 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n";
1436 }
1441 }
1449 #warn "CSB: mark coff<$coff>\n";
1450 }
1451 }
1455 }
1463 }
1465 }
1466 }
1467 # Preprocessor commands end at the newline unless escaped.
1473 }
1475 }
1476 # We are truly at the end, so shuffle to the next line.
1481 }
1486 #warn "STATEMENT<$statement>\n";
1487 #warn "CONDITION<$condition>\n";
1489 #print "coff<$coff> soff<$off> loff<$loff>\n";
1493 }
1498 # Strip the diff line prefixes and rip blank lines at start and end.
1506 }
1514 }
1535 }
1536 }
1544 # Grab the first conditional/block pair.
1547 #print "F: c<$condition> s<$statement> remain<$remain>\n";
1551 }
1553 # Pull in the following conditional/block pairs and see if they
1554 # could continue the statement.
1558 #print "C: c<$condition> s<$statement> remain<$remain>\n";
1560 #print "C: push\n";
1562 }
1565 }
1584 # Handle nested #if/#else.
1591 }
1594 ##print "C<$c>L<$level><$open$close>O<$off>\n";
1598 }
1605 }
1606 }
1610 }
1613 }
1616 }
1622 }
1628 }
1634 }
1639 }
1644 }
1649 # Catch a comment on the end of the line itself.
1653 # Look through the context and try and figure out if there is a
1654 # comment.
1659 #warn " $line\n";
1662 }
1665 }
1668 }
1672 }
1673 }
1677 }
1682 ##print "LINE: $rawlines[$end_line - 1 ]\n";
1683 ##print "CMMT: $cmt\n";
1686 }
1699 }
1702 }
1710 }
1713 }
1721 }
1724 }
1736 }
1737 }
1741 }
1753 }
1773 }
1794 }
1823 # Assume all arms of the conditional end as this
1824 # one does, and continue as if the #endif was not here.
1841 }
1872 }
1884 }
1917 }
1932 }
1941 }
1945 }
1949 }
1950 }
1953 }
1962 DEFINE_\S+
1963 )$|
1967 case|
1971 \#|
1972 \#\#|
1978 # Check for modifiers.
1989 }
1990 }
1995 }
1996 build_types();
1999 }
2000 }
2012 }
2020 }
2029 }
2030 }
2035 }
2043 }
2049 }
2053 }
2064 }
2065 }
2092 }
2098 }
2105 }
2110 }
2113 }
2116 }
2124 };
2126 }
2134 };
2137 }
2146 }
2148 }
2156 }
2158 }
2166 }
2168 }
2174 ##print "absolute<$absolute>\n";
2176 # See if any suffix of this path is a path within the tree.
2179 ##print "file<$file>\n";
2181 }
2182 }
2185 }
2187 # It is, so see if the prefix is acceptable.
2191 ##print "prefix<$prefix>\n";
2195 }
2196 }
2204 }
2212 }
2220 }
2228 }
2237 #convert leading spaces to tabs
2239 #Remove spaces before a tab
2243 }
2257 }
2269 }
2270 }
2273 }
2314 # Trace the real file/line as we go.
2327 # suppression flags
2335 # Pre-scan the patch sanitizing the lines.
2336 # Pre-scan the patch looking for any __setup documentation.
2337 #
2345 sanitise_line_reset();
2357 }
2358 #next;
2359 }
2366 }
2369 # Guestimate if this is a continuing comment. Run
2370 # the context looking for a comment "edge". If this
2371 # edge is a close comment then we must be in a comment
2372 # at context start.
2379 #print "RAW<$rawlines[$ln - 1]>\n";
2385 }
2386 }
2389 }
2391 # Guestimate if this is a continuing comment. If this
2392 # is the start of a diff block and this line starts
2393 # ' *' then it is very likely a comment.
2396 {
2398 }
2400 ##print "COMMENT:$in_comment edge<$edge> $rawline\n";
2404 # Standardise the strings and chars within the input to
2405 # simplify matching -- only bother with positive lines.
2407 }
2414 }
2416 #print "==>$rawline\n";
2417 #print "-->$line\n";
2421 }
2422 }
2437 # check if it's a mode change, rename or start of a patch
2443 }
2445 #extract the line range in the file after the patch is applied
2456 }
2457 annotate_reset();
2468 }
2471 # track the line number as we move through the hunk, note that
2472 # new versions of GNU diff omit the leading space on completely
2473 # blank context lines so we need to count that too.
2478 # Measure the line length and indent.
2481 # Track the previous line.
2486 #warn "line<$line>\n";
2490 }
2498 # extract the filename as it passes
2514 }
2518 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n");
2519 }
2521 }
2523 #make up the handle for any error we report on this line
2531 }
2532 }
2537 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n");
2538 }
2543 }
2554 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.txt\n");
2555 }
2556 }
2559 }
2569 # Verify the existence of a commit log if appropriate
2570 # 2 is used because a $signature is counted in $commit_log_lines
2574 }
2579 }
2581 # Check if the commit log has what seems like a diff which can confuse patch
2590 }
2592 # Check for incorrect file permissions
2599 }
2600 }
2602 # Check the patch for a From:
2607 }
2609 # Check the patch for a signoff:
2618 }
2619 }
2620 }
2622 # Check if MAINTAINERS is being updated. If so, there's probably no need to
2623 # emit the "does MAINTAINERS need updating?" message on file add/move/delete
2626 }
2628 # Check signature styles
2640 }
2647 }
2648 }
2655 }
2657 }
2664 }
2665 }
2676 # Don't force email to have quotes
2677 # Allow just an angle bracketed address
2683 }
2684 }
2686 # Check for duplicate signatures
2695 }
2697 # Check Co-developed-by: immediately followed by Signed-off-by: with same name and email
2701 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline);
2702 }
2708 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2711 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]);
2712 }
2713 }
2714 }
2716 # Check email subject for common tools that don't need to be mentioned
2721 }
2723 # Check for unwanted Gerrit info
2727 }
2729 # Check if the commit log is in a possible stack dump
2733 # timestamp
2737 # stack dump address styles
2739 }
2741 # Check for line lengths > 75 in commit log, warn once
2745 # file delta changes
2747 # filename then :
2749 # A Fixes: or Link: line
2754 }
2756 # Reset possible stack dump if a blank line is found
2760 }
2762 # Check for git id commit length and improperly formed commit descriptions
2787 }
2809 }
2817 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr);
2818 }
2819 }
2821 # Check for added, moved or deleted files
2831 }
2833 # Check for adding new DT bindings not in schema format
2838 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n");
2839 }
2841 # Check for wrappage within a valid hunk of the file
2846 }
2848 # UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php
2859 }
2861 # Check if it's the start of a commit log
2862 # (not a header line and we haven't seen the patch filename)
2869 }
2871 # Check if there is UTF-8 in a commit log when a mail header has explicitly
2872 # declined it, i.e defined some charset where it is missing.
2877 }
2883 }
2885 # Check for absolute kernel paths in commit message
2892 #
2895 }
2896 }
2897 }
2899 # Check for various typo / spelling mistakes
2913 }
2914 }
2915 }
2917 # check for invalid commit id
2925 }
2926 }
2928 # ignore non-hunk lines and lines being removed
2931 #trailing whitespace
2938 }
2945 }
2948 }
2950 # Check for FSF mailing addresses.
2959 "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)
2960 }
2962 # check for Kconfig help text having a real description
2963 # Only applies when adding the entry originally, after that we do not have
2964 # sufficient context to determine whether it is indeed long enough.
2966 # 'choice' is usually the last thing on the line (though
2967 # Kconfig supports named choices), so use a word boundary
2968 # (\b) rather than a whitespace character (\s)
2990 }
2992 }
2999 # This only checks context lines in the patch
3000 # and so hopefully shouldn't trigger false
3001 # positives, even though some of these are
3002 # common words in help texts
3007 }
3009 }
3013 }
3014 #print "is_start<$is_start> is_end<$is_end> length<$length>\n";
3015 }
3017 # check for MAINTAINERS entries that don't have the right form
3025 }
3026 }
3028 # discourage the use of boolean for type definition attributes of Kconfig options
3033 }
3043 };
3046 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag});
3047 }
3049 # check for DT compatible documentation
3068 }
3075 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr);
3076 }
3077 }
3078 }
3080 # check for using SPDX license tag at beginning of files
3094 }
3096 # check SPDX comment style for .[chsS] files
3102 }
3113 }
3114 }
3115 }
3116 }
3118 # check we are in a valid source file if not then ignore this hunk
3121 # check for using SPDX-License-Identifier on the wrong line number
3127 }
3129 # line length limit (with some exclusions)
3130 #
3131 # There are a few types of lines that may extend beyond $max_line_length:
3132 # logging functions like pr_info that end in a string
3133 # lines with a single string
3134 # #defines that are a single string
3135 # lines with an RFC3986 like URL
3136 #
3137 # There are 3 different line length message types:
3138 # LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length
3139 # LONG_LINE_STRING a string starts before but extends beyond $max_line_length
3140 # LONG_LINE all other lines longer than $max_line_length
3141 #
3142 # if LONG_LINE is ignored, the other 2 types are also ignored
3143 #
3148 # Check the allowed long line types first
3150 # logging functions that end in a string that starts
3151 # before $max_line_length
3152 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ &&
3156 # lines with only strings (w/ possible termination)
3157 # #defines with only strings
3162 # More special cases
3167 # URL ($rawline is used in case the URL is in a comment)
3171 # Otherwise set the alternate message types
3173 # a comment starts before $max_line_length
3178 # a quoted string starts before $max_line_length
3182 }
3188 }
3189 }
3191 # check for adding lines without a newline.
3192 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) {
3195 }
3197 # check we are in a valid source file C or perl if not then ignore this hunk
3200 # at the beginning of a line any tabs must come first and anything
3201 # more than 8 must use tabs.
3210 }
3211 }
3213 # check for space before tabs.
3223 }
3224 }
3226 # check for assignments on the start of a line
3230 }
3232 # check for && or || at the start of a line
3236 }
3238 # check indentation starts on a tab stop
3240 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) {
3247 }
3248 }
3249 }
3251 # check multi-line statement indentation matches previous line
3253 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) {
3276 }
3277 }
3278 }
3279 }
3281 # check for space after cast like "(int) foo" or "(struct foo) bar"
3282 # avoid checking a few false positives:
3283 # "sizeof(<type>)" or "__alignof__(<type>)"
3284 # function pointer declarations like "(*foo)(int) = bar;"
3285 # structure definitions like "(struct foo) { 0 };"
3286 # multiline macros that define functions
3287 # known attributes or the __attribute__ keyword
3295 }
3296 }
3298 # Block comment styles
3299 # Networking with an initial /*
3306 }
3308 # Block comments use * on subsequent lines
3316 }
3318 # Block comments use */ on trailing lines
3325 }
3327 # Block comment * alignment
3341 }
3348 }
3349 }
3351 # check for missing blank lines after struct/union declarations
3352 # with exceptions for various attributes and macros
3368 }
3369 }
3371 # check for multiple consecutive blank lines
3379 }
3382 }
3384 # check for missing blank lines after declarations
3386 # actual declarations
3388 # function pointer declarations
3390 # foo bar; where foo is some local typedef or #define
3392 # known declaration macros
3394 # for "else if" which can look like "$Ident $Ident"
3396 # other possible extensions of declaration lines
3398 # not starting a section or a macro "\" extended line
3400 # looks like a declaration
3402 # function pointer declarations
3404 # foo bar; where foo is some local typedef or #define
3406 # known declaration macros
3408 # start of struct or union or enum
3410 # start or end of block or continuation of declaration
3412 # bitfield continuation
3414 # other possible extensions of declaration lines
3416 # indentation of previous and current line are the same
3422 }
3423 }
3425 # check for spaces at the beginning of a line.
3426 # Exceptions:
3427 # 1) within comments
3428 # 2) indented preprocessor commands
3429 # 3) hanging labels
3436 }
3437 }
3439 # check we are in a valid C source file if not then ignore this hunk
3442 # check for unusual line ending [ or (
3446 }
3448 # check if this appears to be the start function declaration, save the name
3452 }
3454 # check if this appears to be the end of function declaration
3457 }
3459 # check indentation of any line with a bare else
3460 # (but not if it is a multiple line "if (foo) return bar; else return baz;")
3461 # if the previous line is a break or return and is indented 1 tab more...
3470 }
3471 }
3473 # check indentation of a line with a break;
3474 # if the previous line is a goto or return and is indented the same # of tabs
3480 }
3481 }
3483 # check for RCS/CVS revision markers
3487 }
3489 # check for old HOTPLUG __dev<foo> section markings
3493 }
3495 # Check for potential 'bare' types
3498 #print "LINE<$line>\n";
3506 #print "linenr<$linenr> <$stat>\n";
3507 # If this statement has no statement boundaries within
3508 # it there is no point in retrying a statement scan
3509 # until we hit end of it.
3512 #print "skip<$line_nr_next>\n";
3514 }
3516 # Find the real next line.
3522 }
3527 # Ignore goto labels.
3530 # Ignore functions being called
3535 # declarations always start with types
3536 } 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) {
3541 # definitions in global scope can only start with types
3544 }
3546 # any (foo ... *) is a pointer cast, and foo is a type
3549 }
3551 # Check for any sort of function declaration.
3552 # int foo(something bar, other baz);
3553 # void (*store_gdt)(x86_descr_ptr *);
3554 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) {
3562 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) {
3565 }
3566 }
3567 }
3569 }
3571 #
3572 # Checks which may be anchored in the context.
3573 #
3575 # Check for switch () and associated case and default
3576 # statements should be at the same indent.
3590 }
3591 }
3595 }
3596 }
3598 # if/while/etc brace do not go on next line, unless defining a do while loop,
3599 # or if that brace on the next line is for something else
3600 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) {
3608 }
3619 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n";
3622 }
3624 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n";
3625 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n";
3631 }
3635 {
3641 }
3642 }
3643 }
3645 # Check relative indent for conditionals and blocks.
3646 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) {
3654 # remove inline comments
3658 # Find out how long the conditional actually is.
3662 # Make sure we remove the line prefixes as we have
3663 # none on the first line, and are going to readd them
3664 # where necessary.
3668 }
3670 # We want to check the first line inside the block
3671 # starting at the end of the conditional, so remove:
3672 # 1) any blank line termination
3673 # 2) any opening brace { on end of the line
3674 # 3) any do (...) {
3681 }
3685 }
3687 # Also ignore a loop construct at the end of a
3688 # preprocessor statement.
3692 }
3699 # If we see an #else/#elif then the code
3700 # is not linear.
3703 }
3705 # Ignore:
3706 # 1) blank lines, they should be at 0,
3707 # 2) preprocessor lines, and
3708 # 3) labels.
3716 }
3717 }
3718 }
3723 # Check if either of these lines are modified, else
3724 # this is not this patch's fault.
3728 }
3731 }
3733 #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";
3742 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n");
3743 }
3744 }
3746 # Track the 'values' across context and added lines.
3756 }
3759 #ignore lines not being added
3762 # check for dereferences that span multiple lines
3772 }
3774 # check for declarations of signed or unsigned without int
3775 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) {
3786 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) &&
3794 }
3795 }
3796 }
3798 # TEST: allow direct testing of the type matcher.
3806 }
3808 }
3809 # TEST: allow direct testing of the attribute matcher.
3817 }
3819 }
3821 # check for initialisation to aggregates open brace on the next line
3835 }
3836 }
3838 #
3839 # Checks which are anchored on the added line.
3840 #
3842 # check for malformed paths in #include statements (uses RAW line)
3848 }
3852 }
3853 }
3855 # no C99 // comments
3864 }
3865 }
3866 }
3867 # Remove C99 comments.
3871 # EXPORT_SYMBOL should immediately follow the thing it is exporting, consider
3872 # the whole statement.
3873 #print "APW <$lines[$realline_next - 1]>\n";
3879 # Handle definitions which produce identifiers with
3880 # a prefix:
3881 # XXX(foo);
3882 # EXPORT_SYMBOL(something_foo);
3886 #print "FOO C name<$name>\n";
3897 #print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n";
3901 }
3902 }
3907 #print "FOO B <$lines[$linenr - 1]>\n";
3909 }
3914 }
3916 # check for global initialisers.
3922 }
3923 }
3924 # check for static initialisers.
3931 }
3932 }
3934 # check for misordered declarations of char/short/int/long with signed/unsigned
3938 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr);
3939 }
3941 # check for unnecessary <signed> int declarations of short/long/long long
3958 }
3959 }
3961 # check for static const char * arrays.
3966 }
3968 # check for initialized const char arrays that should be static const
3969 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) {
3974 }
3975 }
3977 # check for static char foo[] = "bar" declarations.
3982 }
3984 # check for const <foo> const where <foo> is not a pointer or array type
3993 }
3994 }
3996 # check for non-global char *foo[] = {"bar", ...} declarations.
4001 }
4003 # check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo)
4006 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) {
4012 }
4013 }
4014 }
4016 # check for function declarations without arguments like "int foo()"
4022 }
4023 }
4025 # check for new typedefs, only function parameters and sparse annotations
4026 # make sense.
4034 }
4036 # * goes on variable not on type
4037 # (char*[ const])
4039 #print "AA<$1>\n";
4042 # Should start with a space.
4044 # Should not end with a space.
4046 # '*'s should not have spaces between.
4048 }
4050 ## print "1: from<$from> to<$to> ident<$ident>\n";
4060 }
4061 }
4062 }
4064 #print "BB<$1>\n";
4067 # Should start with a space.
4069 # Should not end with a space.
4071 # '*'s should not have spaces between.
4073 }
4074 # Modifiers should have spaces.
4077 ## print "2: from<$from> to<$to> ident<$ident>\n";
4088 }
4089 }
4090 }
4092 # avoid BUG() or BUG_ON()
4097 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr);
4098 }
4100 # avoid LINUX_VERSION_CODE
4103 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr);
4104 }
4106 # check for uses of printk_ratelimit
4110 }
4112 # printk should use KERN_* levels
4116 }
4125 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to printk(KERN_$orig ...\n" . $herecurr);
4126 }
4134 }
4135 }
4144 }
4146 # ENOSYS means "bad syscall nr" and nothing else. This will have a small
4147 # number of false positives, but assembly files are not checked, so at
4148 # least the arch entry code will not trigger this warning.
4152 }
4154 # function brace can't be on same line, except for #defines of do while,
4155 # or if closed on same line
4172 }
4173 }
4174 }
4176 # open braces for enum, union and struct go on the same line.
4190 }
4191 }
4192 }
4194 # missing space after union, struct or enum definition
4201 }
4202 }
4204 # Function pointer declarations
4205 # check spacing between type, funcptr, and args
4206 # canonical declaration is "type (*funcptr)(args...)"
4215 # the $Declare variable will capture all spaces after the type
4216 # so check it for a missing trailing missing space but pointer return types
4217 # don't need a space so don't warn for those.
4222 }
4227 }
4229 # unnecessary space "type (*funcptr)(args...)"
4230 # This test is not currently implemented because these declarations are
4231 # equivalent to
4232 # int foo(int bar, ...)
4233 # and this is form shouldn't/doesn't generate a checkpatch warning.
4234 #
4235 # elsif ($declare =~ /\s{2,}$/) {
4236 # WARN("SPACING",
4237 # "Multiple spaces after return type\n" . $herecurr);
4238 # }
4240 # unnecessary space "type ( *funcptr)(args...)"
4245 }
4247 # unnecessary space "type (* funcptr)(args...)"
4252 }
4254 # unnecessary space "type (*funcptr )(args...)"
4259 }
4261 # unnecessary space "type (*funcptr) (args...)"
4266 }
4270 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex;
4271 }
4272 }
4274 # check for spacing round square brackets; allowed:
4275 # 1. with a type on the left -- int [] a;
4276 # 2. at the beginning of a line for slice initialisers -- [0...10] = 5,
4277 # 3. inside a curly brace -- = { [0...10] = 5 }
4288 }
4289 }
4290 }
4292 # check for spaces between functions and their parentheses.
4298 # Ignore those directives where spaces _are_ permitted.
4304 {
4305 # cpp #define statements have non-optional spaces, ie
4306 # if there is a space between the name and the open
4307 # parenthesis it is simply not a parameter group.
4310 # cpp #elif statement condition may start with a (
4313 # If this whole things ends with a type its most
4314 # likely a typedef for a function.
4323 }
4324 }
4325 }
4327 # Check operator spacing.
4333 <<=|>>=|<=|>=|==|!=|
4335 =>|->|<<|>>|<|>|=|!|~|
4341 ## print("element count: <" . $#elements . ">\n");
4342 ## foreach my $el (@elements) {
4343 ## print("el: <$el>\n");
4344 ## }
4352 }
4363 ## print("n: <$n> good: <$good>\n");
4367 # Pick up the preceding and succeeding characters.
4372 }
4395 }
4404 # Pull out the value of this operator.
4407 # Get the full operator variant.
4410 # Ignore operators passed as parameters.
4414 # # Ignore comments
4415 # } elsif ($op =~ /^$;+$/) {
4417 # ; should have either the end of line or a space or \ after it
4425 }
4426 }
4428 # // is a comment
4431 # : when part of a bitfield
4433 # skip the bitfield test for now
4435 # No spaces for:
4436 # ->
4444 }
4446 }
4447 }
4449 # , must not have a space before and must have a space on the right.
4458 }
4459 }
4466 }
4467 }
4473 }
4476 }
4477 }
4479 # '*' as part of a type definition -- reported already.
4481 #warn "'*' is part of type\n";
4483 # unary operators should have a space before and
4484 # none after. May be left adjacent to another
4485 # unary operator, or a cast
4495 }
4496 }
4497 }
4499 # A unary '*' may be const
4507 }
4509 }
4510 }
4512 # unary ++ and unary -- are allowed no space on one side.
4519 }
4520 }
4527 }
4528 }
4535 }
4537 }
4538 }
4540 # << and >> may either have or not have spaces both sides
4546 {
4554 }
4560 }
4561 }
4568 }
4570 }
4571 }
4573 # A colon needs no spaces before when it is
4574 # terminating a case value or a label.
4581 }
4582 }
4584 # All the others need spaces both sides.
4588 # Ignore email addresses <foo@bar>
4593 {
4595 }
4597 # for asm volatile statements
4598 # ignore a colon with another
4599 # colon immediately before or after
4603 }
4605 # messages are ERROR, but ?: are CHK
4615 }
4617 }
4618 }
4619 }
4622 ## print("n: <$n> GOOD: <$good>\n");
4625 }
4629 }
4633 }
4636 }
4638 # check for whitespace before a non-naked semicolon
4645 }
4646 }
4648 # check for multiple assignments
4652 }
4654 ## # check for multiple declarations, allowing for a function declaration
4655 ## # continuation.
4656 ## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ &&
4657 ## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) {
4658 ##
4659 ## # Remove any bracketed sections to ensure we do not
4660 ## # falsly report the parameters of functions.
4661 ## my $ln = $line;
4662 ## while ($ln =~ s/\([^\(\)]*\)//g) {
4663 ## }
4664 ## if ($ln =~ /,/) {
4665 ## WARN("MULTIPLE_DECLARATION",
4666 ## "declaring multiple variables together should be avoided\n" . $herecurr);
4667 ## }
4668 ## }
4670 #need space before brace following if, while, etc
4677 }
4678 }
4680 ## # check for blank lines before declarations
4681 ## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ &&
4682 ## $prevrawline =~ /^.\s*$/) {
4683 ## WARN("SPACING",
4684 ## "No blank lines before declarations\n" . $hereprev);
4685 ## }
4686 ##
4688 # closing brace should have a space following it when it has anything
4689 # on the line
4696 }
4697 }
4699 # check spacing on square brackets
4706 }
4707 }
4714 }
4715 }
4717 # check spacing on parentheses
4725 }
4726 }
4735 }
4736 }
4738 # check unnecessary parentheses around addressof/dereference single $Lvals
4739 # ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar
4747 }
4748 }
4750 # check for unnecessary parentheses around function pointer uses
4751 # ie: (foo->bar)(); should be foo->bar();
4752 # but not "if (foo->bar) (" to avoid some false positives
4761 }
4762 }
4764 # check for unnecessary parentheses around comparisons in if uses
4765 # when !drivers/staging or command-line uses --strict
4772 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) {
4774 # avoid parentheses around potential macro args
4783 }
4784 }
4787 }
4788 }
4790 #goto labels aren't indented, allow a single space however
4798 }
4799 }
4801 # return is not a function
4811 }
4815 }
4816 }
4818 # unnecessary return in a void function
4819 # at end-of-function, with the previous line a single leading tab, then return;
4820 # and the line before that not a goto label target like "out:"
4828 }
4830 # if statements using unnecessary parentheses - ie: if ((foo == bar))
4836 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) {
4841 }
4842 }
4844 # comparisons with a constant or upper case identifier on the left
4845 # avoid cases like "foo + BAR < baz"
4846 # only fix matches surrounded by parentheses to avoid incorrect
4847 # conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5"
4868 }
4870 }
4871 }
4873 # Return of what appears to be an errno should normally be negative
4879 }
4880 }
4882 # Need a space before open parenthesis after if, while etc
4889 }
4890 }
4892 # Check for illegal assignment in if conditional -- and check for trailing
4893 # statements after the conditional.
4901 ##print "stat<$stat> stat_next<$stat_next>\n";
4904 # If the statement carries leading newlines,
4905 # then count those as offsets.
4913 }
4914 }
4923 }
4925 # Find out what is on the end of the line after the
4926 # conditional.
4932 {
4933 # Find out how long the conditional actually is.
4942 }
4946 }
4947 }
4949 # Check for bitwise tests written as boolean
4955 |
4960 {
4963 }
4965 # if and else should not have general statements after it
4972 }
4973 }
4974 # if should not continue a brace
4979 }
4980 # case and default should not have general statements after them
4986 {
4989 }
4991 # Check for }<nl>else {, these must be at the same
4992 # indent level to be relevant to each other.
5004 }
5008 }
5009 }
5015 # Find out what is on the end of the line after the
5016 # conditional.
5032 }
5033 }
5034 }
5036 #Specific variable tests
5040 #CamelCase
5043 #Ignore Page<foo> variants
5045 #Ignore SI style variants like nS, mV and dB
5046 #(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE)
5048 #Ignore some three character SI units explicitly, like MiB and KHz
5054 seed_camelcase_includes();
5058 }
5059 }
5064 }
5065 }
5066 }
5067 }
5069 #no spaces allowed after \ in define
5075 }
5076 }
5078 # warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes
5079 # itself <asm/foo.h> (uses RAW line)
5086 {
5095 }
5096 }
5097 }
5098 }
5100 # multi-statement macros should be enclosed in a do while loop, grab the
5101 # first statement and ensure its the whole macro if its not enclosed
5102 # in a known good container
5114 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n";
5115 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n";
5130 }
5137 # Flatten any parentheses and braces
5141 {
5142 }
5144 # Flatten any obvious string concatentation.
5147 {
5148 }
5150 # Make asm volatile uses seem like a generic function
5155 module_param_named|
5156 MODULE_PARM_DESC|
5157 DECLARE_PER_CPU|
5158 DEFINE_PER_CPU|
5159 __typeof__\(|
5160 union|
5161 struct|
5166 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n";
5175 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz
5180 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...)
5186 {
5189 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx");
5196 }
5198 }
5200 # Make $define_stmt single line, comment-free, etc
5211 }
5212 }
5217 # check if any macro arguments are reused (ignore '...' and 'type')
5222 $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g;
5229 }
5230 # check if any macro arguments may have other precedence issues
5236 }
5237 }
5239 # check for macros with flow control, but without ## concatenation
5240 # ## concatenation is commonly a macro that defines a function so ignore those
5247 }
5249 # check for line continuations outside of #defines, preprocessor #, and asm
5258 }
5259 }
5261 # do {} while (0) macro tests:
5262 # single-statement macros do not need to be enclosed in do while (0) loop,
5263 # macro should not end with a semicolon
5278 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) {
5290 }
5294 }
5302 }
5303 }
5305 # check for redundant bracing round if etc
5309 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n";
5310 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n";
5320 # If the condition carries leading newlines, then count those as offsets.
5325 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n";
5327 # We have looked at and allowed this specific line.
5337 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n";
5339 #print "APW: ALLOWED: cond<$cond>\n";
5341 }
5343 #print "APW: ALLOWED: block<$block>\n";
5345 }
5347 #print "APW: ALLOWED: lines block<$block>\n";
5349 }
5351 }
5356 }
5364 }
5365 }
5366 }
5367 }
5372 # Check the pre-context.
5374 #print "APW: ALLOWED: pre<$1>\n";
5376 }
5381 # Check the condition.
5383 #print "CHECKING<$linenr> cond<$cond> block<$block>\n";
5386 }
5388 #print "APW: ALLOWED: cond<$cond>\n";
5390 }
5392 #print "APW: ALLOWED: block<$block>\n";
5394 }
5396 #print "APW: ALLOWED: lines block<$block>\n";
5398 }
5399 # Check the post-context.
5404 }
5406 #print "APW: ALLOWED: chunk-1 block<$block>\n";
5408 }
5409 }
5416 }
5417 }
5419 # check for single line unbalanced braces
5423 }
5425 # check for unnecessary blank lines around braces
5431 }
5432 }
5438 }
5439 }
5441 # no volatiles please
5445 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr);
5446 }
5448 # Check for user-visible strings broken across lines, which breaks the ability
5449 # to grep for the string. Make exceptions when the previous string ends in a
5450 # newline (multiple lines in one string constant) or '\t', '\r', ';', or '{'
5451 # (common in inline assembly) or is a octal \123 or hexadecimal \xaf value
5464 }
5476 }
5478 }
5479 }
5481 # check for missing a space in a string concatenation
5485 }
5487 # check for an embedded function name in a string when the function is known
5488 # This does not work very well for -f --file checking as it depends on patch
5489 # context providing the function name or a single line form for in-file
5490 # function declarations
5496 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr);
5497 }
5499 # check for spaces before a quoted newline
5505 }
5507 }
5509 # concatenated string without spaces between elements
5518 }
5519 }
5520 }
5522 # uncoalesced string fragments
5530 }
5531 }
5532 }
5534 # check for non-standard and hex prefixed decimal printf formats
5540 # check for %L
5545 }
5546 # check for %Z
5551 }
5552 # check for 0x<decimal>
5556 }
5557 }
5559 # check for line continuations in quoted strings with odd counts of "
5563 }
5565 # warn about #if 0
5569 }
5571 # warn about #if 1
5575 }
5577 # check for needless "if (<foo>) fn(<foo>)" uses
5581 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) {
5593 }
5598 }
5601 }
5605 }
5606 }
5607 }
5608 }
5610 # check for unnecessary "Out of Memory" messages
5619 # print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n");
5621 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ &&
5625 }
5626 }
5628 # check for logging functions with KERN_<LEVEL>
5636 }
5637 }
5639 # check for logging continuations
5643 }
5645 # check for mask then right shift without a parentheses
5651 }
5653 # check for pointer comparisons to NULL
5663 }
5664 }
5665 }
5667 # check for bad placement of section $InitAttribute (e.g.: __initdata)
5670 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) {
5680 $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;
5681 }
5682 }
5683 }
5685 # check for $InitAttributeData (ie: __initdata) with const
5696 }
5697 }
5699 # check for $InitAttributeConst (ie: __initconst) without const
5711 }
5712 }
5714 # check for __read_mostly with const non-pointer (should just be const)
5721 }
5722 }
5724 # don't use __constant_<foo> functions outside of include/uapi/
5726 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) {
5734 }
5735 }
5737 # prefer usleep_range over udelay
5740 # ignore udelay's < 10, however
5743 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5744 }
5748 }
5749 }
5751 # warn about unexpectedly long msleep's
5755 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr);
5756 }
5757 }
5759 # check for comparisons of jiffies
5762 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr);
5763 }
5765 # check for comparisons of get_jiffies_64()
5768 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr);
5769 }
5771 # warn about #ifdefs in C files
5772 # if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) {
5773 # print "#ifdef in C files should be avoided\n";
5774 # print "$herecurr";
5775 # $clean = 0;
5776 # }
5778 # warn about spacing in #ifdefs
5785 }
5787 }
5789 # check for spinlock_t definitions without a comment.
5796 }
5797 }
5798 # check for memory barriers without a comment.
5801 mb|
5802 rmb|
5803 wmb|
5804 read_barrier_depends
5807 mb__before_atomic|
5808 mb__after_atomic|
5809 store_release|
5810 load_acquire|
5811 store_mb|
5824 }
5825 }
5835 }
5837 # check for waitqueue_active without a comment.
5842 }
5843 }
5845 # check for smp_read_barrier_depends and read_barrier_depends
5849 }
5851 # check of hardware specific defines
5852 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) {
5855 }
5857 # check that the storage class is not after a type
5861 }
5862 # Check that the storage class is at the beginning of a declaration
5869 }
5871 # check the location of the inline attribute, that it is between
5872 # storage class and type.
5877 }
5879 # Check for __inline__ and __inline, prefer inline
5887 }
5888 }
5890 # Check for __attribute__ packed, prefer __packed
5895 }
5897 # Check for __attribute__ aligned, prefer __aligned
5902 }
5904 # Check for __attribute__ section, prefer __section
5912 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*_*section_*\s*\(\s*\Q$old\E\s*\)\s*\)\s*\)/__section($new)/;
5913 }
5914 }
5916 # Check for __attribute__ format(printf, prefer __printf
5920 "__printf(string-index, first-to-check) is preferred over __attribute__((format(printf, string-index, first-to-check)))\n" . $herecurr) &&
5922 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*printf\s*,\s*(.*)\)\s*\)\s*\)/"__printf(" . trim($1) . ")"/ex;
5924 }
5925 }
5927 # Check for __attribute__ format(scanf, prefer __scanf
5931 "__scanf(string-index, first-to-check) is preferred over __attribute__((format(scanf, string-index, first-to-check)))\n" . $herecurr) &&
5933 $fixed[$fixlinenr] =~ s/\b__attribute__\s*\(\s*\(\s*format\s*\(\s*scanf\s*,\s*(.*)\)\s*\)\s*\)/"__scanf(" . trim($1) . ")"/ex;
5934 }
5935 }
5937 # Check for __attribute__ weak, or __weak declarations (may have link issues)
5939 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ &&
5944 }
5946 # check for c99 types like uint8_t used outside of uapi/ and tools/
5961 }
5962 }
5963 }
5965 # check for cast of C90 native int or longer types constants
5980 }
5982 }
5983 }
5985 # check for sizeof(&)
5989 }
5991 # check for sizeof without parenthesis
5996 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex;
5997 }
5998 }
6000 # check for struct spinlock declarations
6004 }
6006 # check for seq_printf uses that could be seq_puts
6015 }
6016 }
6017 }
6019 # check for vsprintf extension %p<foo> misuses
6045 }
6049 }
6051 "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");
6052 }
6053 }
6061 }
6065 }
6066 }
6067 }
6069 # Check for misused memsets
6084 }
6085 }
6087 # Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar)
6088 # if ($perl_version_ok &&
6089 # defined $stat &&
6090 # $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6091 # if (WARN("PREFER_ETHER_ADDR_COPY",
6092 # "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") &&
6093 # $fix) {
6094 # $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/;
6095 # }
6096 # }
6098 # Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar)
6099 # if ($perl_version_ok &&
6100 # defined $stat &&
6101 # $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6102 # WARN("PREFER_ETHER_ADDR_EQUAL",
6103 # "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n")
6104 # }
6106 # check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr
6107 # check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr
6108 # if ($perl_version_ok &&
6109 # defined $stat &&
6110 # $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) {
6111 #
6112 # my $ms_val = $7;
6113 #
6114 # if ($ms_val =~ /^(?:0x|)0+$/i) {
6115 # if (WARN("PREFER_ETH_ZERO_ADDR",
6116 # "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") &&
6117 # $fix) {
6118 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/;
6119 # }
6120 # } elsif ($ms_val =~ /^(?:0xff|255)$/i) {
6121 # if (WARN("PREFER_ETH_BROADCAST_ADDR",
6122 # "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") &&
6123 # $fix) {
6124 # $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/;
6125 # }
6126 # }
6127 # }
6129 # typecasts on min/max could be min_t/max_t
6147 }
6150 }
6151 }
6153 # check usleep_range arguments
6161 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6165 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n");
6166 }
6167 }
6169 # check for naked sscanf
6181 }
6183 # check for simple sscanf that should be kstrto<foo>
6197 }
6198 }
6199 }
6201 # check for new externs in .h files.
6208 }
6209 }
6211 # check for new externs in .c files.
6214 {
6221 }
6224 {
6227 }
6232 }
6236 {
6239 }
6241 # check for function declarations that have arguments without identifier names
6243 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s &&
6251 }
6252 }
6253 }
6255 # check for function definitions
6261 # check for multiline function definition with misplaced open brace
6271 }
6275 }
6276 }
6278 # checks for new __setup's
6284 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.rst\n" . $herecurr);
6285 }
6286 }
6288 # check for pointless casting of alloc functions
6291 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr);
6292 }
6294 # alloc style
6295 # p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...)
6297 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) {
6300 }
6302 # check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc
6305 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) {
6316 }
6326 $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;
6327 }
6328 }
6329 }
6331 # check for krealloc arg reuse
6337 }
6339 # check for alloc argument mismatch
6343 }
6345 # check for multiple semicolons
6351 }
6352 }
6354 # check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi
6363 }
6364 }
6366 # check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE
6367 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(CONFIG_[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) {
6373 }
6374 }
6376 # check for case / default statements not preceded by break/fallthrough/switch
6393 $has_break = 1 if ($fline =~ /\bswitch\b|\b(?:break\s*;[\s$;]*$|exit\s*\(\b|return\b|goto\b|continue\b)/);
6394 }
6398 }
6399 }
6401 # check for switch/default statements without a break;
6410 }
6412 # check for gcc specific __FUNCTION__
6418 }
6419 }
6421 # check for uses of __DATE__, __TIME__, __TIMESTAMP__
6425 }
6427 # check for use of yield()
6431 }
6433 # check for comparisons against true and false
6449 }
6454 ## maybe suggesting a correct construct would better
6455 ## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr);
6457 }
6458 }
6460 # check for semaphores initialized locked
6464 }
6466 # recommend kstrto* over simple_strto* and strict_strto*
6470 }
6472 # check for __initcall(), use device_initcall() explicitly or more appropriate function please
6475 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr);
6476 }
6478 # check for spin_is_locked(), suggest lockdep instead
6481 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr);
6482 }
6484 # check for deprecated apis
6490 }
6492 # check for various structs that are normally const (ops, kgdb, device_tree)
6493 # and avoid what seem like struct definitions 'struct foo {'
6498 }
6500 # use of NR_CPUS is usually wrong
6501 # ignore definitions of NR_CPUS and usage to define arrays as likely right
6508 {
6510 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr);
6511 }
6513 # Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong.
6517 }
6519 # likely/unlikely comparisons similar to "(likely(foo) > 0)"
6524 }
6526 # nested likely/unlikely calls
6530 }
6532 # whine mightly about in_atomic
6540 }
6541 }
6543 # check for mutex_trylock_recursive usage
6547 }
6549 # check for lockdep_set_novalidate_class
6557 }
6558 }
6563 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr);
6564 }
6566 # check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO>
6567 # and whether or not function naming is typical and if
6568 # DEVICE_ATTR permissions uses are unusual too
6571 $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*\)/) {
6583 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/;
6584 }
6591 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/;
6592 }
6599 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/;
6600 }
6611 }
6614 }
6620 }
6621 }
6623 # Mode permission misuses where it seems decimal should be octal
6624 # This uses a shortcut match to avoid unnecessary uses of a slow foreach loop
6625 # o Ignore module_param*(...) uses with a decimal 0 permission as that has a
6626 # specific definition of not visible in sysfs.
6627 # o Ignore proc_create*(...) uses with a decimal 0 permission as that means
6628 # use the default permissions
6644 }
6654 }
6657 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real);
6658 }
6659 }
6660 }
6661 }
6663 # check for uses of S_<PERMS> that could be octal for readability
6668 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) &&
6671 }
6672 }
6674 # validate content of MODULE_LICENSE against list from include/linux/module.h
6678 GPL|
6679 GPL\ v2|
6684 Proprietary
6689 }
6690 }
6692 # check for sysctl duplicate constants
6695 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr);
6696 }
6697 }
6699 # If we have no input at all, then there is nothing to report on
6700 # so just keep quiet.
6703 }
6705 # In mailback mode only produce a report in the negative, for
6706 # things that appear to be patches.
6709 }
6711 # This is not a patch, and we are are in 'no-patch' mode so
6712 # just keep quiet.
6715 }
6720 }
6728 }
6729 }
6737 }
6740 # If there were any defects found and not already fixing them
6746 EOM
6747 }
6748 # If there were whitespace errors which cleanpatch can fix
6749 # then suggest that.
6756 EOM
6757 }
6758 }
6778 }
6781 }
6782 }
6790 Do _NOT_ trust the results written to this file.
6793 This EXPERIMENTAL file is simply a convenience to help rewrite patches.
6795 EOM
6796 }
6797 }
6805 }
6806 }
6808 }