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> 9 10use strict; 11use warnings; 12use POSIX; 13use File::Basename; 14use Cwd 'abs_path'; 15use Term::ANSIColor qw(:constants); 16use Encode qw(decode encode); 17 18my $P = $0; 19my $D = dirname(abs_path($P)); 20 21my $V = '0.32'; 22 23use Getopt::Long qw(:config no_auto_abbrev); 24 25my $quiet = 0; 26my $tree = 1; 27my $chk_signoff = 1; 28my $chk_patch = 1; 29my $tst_only; 30my $emacs = 0; 31my $terse = 0; 32my $showfile = 0; 33my $file = 0; 34my $git = 0; 35my %git_commits = (); 36my $check = 0; 37my $check_orig = 0; 38my $summary = 1; 39my $mailback = 0; 40my $summary_file = 0; 41my $show_types = 0; 42my $list_types = 0; 43my $fix = 0; 44my $fix_inplace = 0; 45my $root; 46my $gitroot = $ENV{'GIT_DIR'}; 47$gitroot = ".git" if !defined($gitroot); 48my %debug; 49my %camelcase = (); 50my %use_type = (); 51my @use = (); 52my %ignore_type = (); 53my @ignore = (); 54my $help = 0; 55my $configuration_file = ".checkpatch.conf"; 56my $max_line_length = 100; 57my $ignore_perl_version = 0; 58my $minimum_perl_version = 5.10.0; 59my $min_conf_desc_length = 4; 60my $spelling_file = "$D/spelling.txt"; 61my $codespell = 0; 62my $codespellfile = "/usr/share/codespell/dictionary.txt"; 63my $conststructsfile = "$D/const_structs.checkpatch"; 64my $typedefsfile; 65my $color = "auto"; 66my $allow_c99_comments = 1; # Can be overridden by --ignore C99_COMMENT_TOLERANCE 67# git output parsing needs US English output, so first set backtick child process LANGUAGE 68my $git_command ='export LANGUAGE=en_US.UTF-8; git'; 69my $tabsize = 8; 70my ${CONFIG_} = "CONFIG_"; 71 72sub help { 73 my ($exitcode) = @_; 74 75 print << "EOM"; 76Usage: $P [OPTION]... [FILE]... 77Version: $V 78 79Options: 80 -q, --quiet quiet 81 --no-tree run without a kernel tree 82 --no-signoff do not check for 'Signed-off-by' line 83 --patch treat FILE as patchfile (default) 84 --emacs emacs compile window format 85 --terse one line per report 86 --showfile emit diffed file position, not input file position 87 -g, --git treat FILE as a single commit or git revision range 88 single git commit with: 89 <rev> 90 <rev>^ 91 <rev>~n 92 multiple git commits with: 93 <rev1>..<rev2> 94 <rev1>...<rev2> 95 <rev>-<count> 96 git merges are ignored 97 -f, --file treat FILE as regular source file 98 --subjective, --strict enable more subjective tests 99 --list-types list the possible message types 100 --types TYPE(,TYPE2...) show only these comma separated message types 101 --ignore TYPE(,TYPE2...) ignore various comma separated message types 102 --show-types show the specific message type in the output 103 --max-line-length=n set the maximum line length, (default $max_line_length) 104 if exceeded, warn on patches 105 requires --strict for use with --file 106 --min-conf-desc-length=n set the min description length, if shorter, warn 107 --tab-size=n set the number of spaces for tab (default $tabsize) 108 --root=PATH PATH to the kernel tree root 109 --no-summary suppress the per-file summary 110 --mailback only produce a report in case of warnings/errors 111 --summary-file include the filename in summary 112 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 113 'values', 'possible', 'type', and 'attr' (default 114 is all off) 115 --test-only=WORD report only warnings/errors containing WORD 116 literally 117 --fix EXPERIMENTAL - may create horrible results 118 If correctable single-line errors exist, create 119 "<inputfile>.EXPERIMENTAL-checkpatch-fixes" 120 with potential errors corrected to the preferred 121 checkpatch style 122 --fix-inplace EXPERIMENTAL - may create horrible results 123 Is the same as --fix, but overwrites the input 124 file. It's your fault if there's no backup or git 125 --ignore-perl-version override checking of perl version. expect 126 runtime errors. 127 --codespell Use the codespell dictionary for spelling/typos 128 (default:/usr/share/codespell/dictionary.txt) 129 --codespellfile Use this codespell dictionary 130 --typedefsfile Read additional types from this file 131 --color[=WHEN] Use colors 'always', 'never', or only when output 132 is a terminal ('auto'). Default is 'auto'. 133 --kconfig-prefix=WORD use WORD as a prefix for Kconfig symbols (default 134 ${CONFIG_}) 135 -h, --help, --version display this help and exit 136 137When FILE is - read standard input. 138EOM 139 140 exit($exitcode); 141} 142 143sub uniq { 144 my %seen; 145 return grep { !$seen{$_}++ } @_; 146} 147 148sub list_types { 149 my ($exitcode) = @_; 150 151 my $count = 0; 152 153 local $/ = undef; 154 155 open(my $script, '<', abs_path($P)) or 156 die "$P: Can't read '$P' $!\n"; 157 158 my $text = <$script>; 159 close($script); 160 161 my @types = (); 162 # Also catch when type or level is passed through a variable 163 for ($text =~ /(?:(?:\bCHK|\bWARN|\bERROR|&\{\$msg_level})\s*\(|\$msg_type\s*=)\s*"([^"]+)"/g) { 164 push (@types, $_); 165 } 166 @types = sort(uniq(@types)); 167 print("#\tMessage type\n\n"); 168 foreach my $type (@types) { 169 print(++$count . "\t" . $type . "\n"); 170 } 171 172 exit($exitcode); 173} 174 175my $conf = which_conf($configuration_file); 176if (-f $conf) { 177 my @conf_args; 178 open(my $conffile, '<', "$conf") 179 or warn "$P: Can't find a readable $configuration_file file $!\n"; 180 181 while (<$conffile>) { 182 my $line = $_; 183 184 $line =~ s/\s*\n?$//g; 185 $line =~ s/^\s*//g; 186 $line =~ s/\s+/ /g; 187 188 next if ($line =~ m/^\s*#/); 189 next if ($line =~ m/^\s*$/); 190 191 my @words = split(" ", $line); 192 foreach my $word (@words) { 193 last if ($word =~ m/^#/); 194 push (@conf_args, $word); 195 } 196 } 197 close($conffile); 198 unshift(@ARGV, @conf_args) if @conf_args; 199} 200 201# Perl's Getopt::Long allows options to take optional arguments after a space. 202# Prevent --color by itself from consuming other arguments 203foreach (@ARGV) { 204 if ($_ eq "--color" || $_ eq "-color") { 205 $_ = "--color=$color"; 206 } 207} 208 209GetOptions( 210 'q|quiet+' => \$quiet, 211 'tree!' => \$tree, 212 'signoff!' => \$chk_signoff, 213 'patch!' => \$chk_patch, 214 'emacs!' => \$emacs, 215 'terse!' => \$terse, 216 'showfile!' => \$showfile, 217 'f|file!' => \$file, 218 'g|git!' => \$git, 219 'subjective!' => \$check, 220 'strict!' => \$check, 221 'ignore=s' => \@ignore, 222 'types=s' => \@use, 223 'show-types!' => \$show_types, 224 'list-types!' => \$list_types, 225 'max-line-length=i' => \$max_line_length, 226 'min-conf-desc-length=i' => \$min_conf_desc_length, 227 'tab-size=i' => \$tabsize, 228 'root=s' => \$root, 229 'summary!' => \$summary, 230 'mailback!' => \$mailback, 231 'summary-file!' => \$summary_file, 232 'fix!' => \$fix, 233 'fix-inplace!' => \$fix_inplace, 234 'ignore-perl-version!' => \$ignore_perl_version, 235 'debug=s' => \%debug, 236 'test-only=s' => \$tst_only, 237 'codespell!' => \$codespell, 238 'codespellfile=s' => \$codespellfile, 239 'typedefsfile=s' => \$typedefsfile, 240 'color=s' => \$color, 241 'no-color' => \$color, #keep old behaviors of -nocolor 242 'nocolor' => \$color, #keep old behaviors of -nocolor 243 'kconfig-prefix=s' => \${CONFIG_}, 244 'h|help' => \$help, 245 'version' => \$help 246) or help(1); 247 248help(0) if ($help); 249 250list_types(0) if ($list_types); 251 252$fix = 1 if ($fix_inplace); 253$check_orig = $check; 254 255die "$P: --git cannot be used with --file or --fix\n" if ($git && ($file || $fix)); 256 257my $exit = 0; 258 259my $perl_version_ok = 1; 260if ($^V && $^V lt $minimum_perl_version) { 261 $perl_version_ok = 0; 262 printf "$P: requires at least perl version %vd\n", $minimum_perl_version; 263 exit(1) if (!$ignore_perl_version); 264} 265 266#if no filenames are given, push '-' to read patch from stdin 267if ($#ARGV < 0) { 268 push(@ARGV, '-'); 269} 270 271if ($color =~ /^[01]$/) { 272 $color = !$color; 273} elsif ($color =~ /^always$/i) { 274 $color = 1; 275} elsif ($color =~ /^never$/i) { 276 $color = 0; 277} elsif ($color =~ /^auto$/i) { 278 $color = (-t STDOUT); 279} else { 280 die "$P: Invalid color mode: $color\n"; 281} 282 283# skip TAB size 1 to avoid additional checks on $tabsize - 1 284die "$P: Invalid TAB size: $tabsize\n" if ($tabsize < 2); 285 286sub hash_save_array_words { 287 my ($hashRef, $arrayRef) = @_; 288 289 my @array = split(/,/, join(',', @$arrayRef)); 290 foreach my $word (@array) { 291 $word =~ s/\s*\n?$//g; 292 $word =~ s/^\s*//g; 293 $word =~ s/\s+/ /g; 294 $word =~ tr/[a-z]/[A-Z]/; 295 296 next if ($word =~ m/^\s*#/); 297 next if ($word =~ m/^\s*$/); 298 299 $hashRef->{$word}++; 300 } 301} 302 303sub hash_show_words { 304 my ($hashRef, $prefix) = @_; 305 306 if (keys %$hashRef) { 307 print "\nNOTE: $prefix message types:"; 308 foreach my $word (sort keys %$hashRef) { 309 print " $word"; 310 } 311 print "\n"; 312 } 313} 314 315hash_save_array_words(\%ignore_type, \@ignore); 316hash_save_array_words(\%use_type, \@use); 317 318my $dbg_values = 0; 319my $dbg_possible = 0; 320my $dbg_type = 0; 321my $dbg_attr = 0; 322for my $key (keys %debug) { 323 ## no critic 324 eval "\${dbg_$key} = '$debug{$key}';"; 325 die "$@" if ($@); 326} 327 328my $rpt_cleaners = 0; 329 330if ($terse) { 331 $emacs = 1; 332 $quiet++; 333} 334 335if ($tree) { 336 if (defined $root) { 337 if (!top_of_kernel_tree($root)) { 338 die "$P: $root: --root does not point at a valid tree\n"; 339 } 340 } else { 341 if (top_of_kernel_tree('.')) { 342 $root = '.'; 343 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 344 top_of_kernel_tree($1)) { 345 $root = $1; 346 } 347 } 348 349 if (!defined $root) { 350 print "Must be run from the top-level dir. of a kernel tree\n"; 351 exit(2); 352 } 353} 354 355my $emitted_corrupt = 0; 356 357our $Ident = qr{ 358 [A-Za-z_][A-Za-z\d_]* 359 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 360 }x; 361our $Storage = qr{extern|static|asmlinkage}; 362our $Sparse = qr{ 363 __user| 364 __kernel| 365 __force| 366 __iomem| 367 __must_check| 368 __kprobes| 369 __ref| 370 __refconst| 371 __refdata| 372 __rcu| 373 __private 374 }x; 375our $InitAttributePrefix = qr{__(?:mem|cpu|dev|net_|)}; 376our $InitAttributeData = qr{$InitAttributePrefix(?:initdata\b)}; 377our $InitAttributeConst = qr{$InitAttributePrefix(?:initconst\b)}; 378our $InitAttributeInit = qr{$InitAttributePrefix(?:init\b)}; 379our $InitAttribute = qr{$InitAttributeData|$InitAttributeConst|$InitAttributeInit}; 380 381# Notes to $Attribute: 382# We need \b after 'init' otherwise 'initconst' will cause a false positive in a check 383our $Attribute = qr{ 384 const| 385 volatile| 386 __percpu| 387 __nocast| 388 __safe| 389 __bitwise| 390 __packed__| 391 __packed2__| 392 __naked| 393 __maybe_unused| 394 __always_unused| 395 __noreturn| 396 __used| 397 __cold| 398 __pure| 399 __noclone| 400 __deprecated| 401 __read_mostly| 402 __ro_after_init| 403 __kprobes| 404 $InitAttribute| 405 ____cacheline_aligned| 406 ____cacheline_aligned_in_smp| 407 ____cacheline_internodealigned_in_smp| 408 __weak 409 }x; 410our $Modifier; 411our $Inline = qr{inline|__always_inline|noinline|__inline|__inline__}; 412our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 413our $Lval = qr{$Ident(?:$Member)*}; 414 415our $Int_type = qr{(?i)llu|ull|ll|lu|ul|l|u}; 416our $Binary = qr{(?i)0b[01]+$Int_type?}; 417our $Hex = qr{(?i)0x[0-9a-f]+$Int_type?}; 418our $Int = qr{[0-9]+$Int_type?}; 419our $Octal = qr{0[0-7]+$Int_type?}; 420our $String = qr{"[X\t]*"}; 421our $Float_hex = qr{(?i)0x[0-9a-f]+p-?[0-9]+[fl]?}; 422our $Float_dec = qr{(?i)(?:[0-9]+\.[0-9]*|[0-9]*\.[0-9]+)(?:e-?[0-9]+)?[fl]?}; 423our $Float_int = qr{(?i)[0-9]+e-?[0-9]+[fl]?}; 424our $Float = qr{$Float_hex|$Float_dec|$Float_int}; 425our $Constant = qr{$Float|$Binary|$Octal|$Hex|$Int}; 426our $Assignment = qr{\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=}; 427our $Compare = qr{<=|>=|==|!=|<|(?<!-)>}; 428our $Arithmetic = qr{\+|-|\*|\/|%}; 429our $Operators = qr{ 430 <=|>=|==|!=| 431 =>|->|<<|>>|<|>|!|~| 432 &&|\|\||,|\^|\+\+|--|&|\||$Arithmetic 433 }x; 434 435our $c90_Keywords = qr{do|for|while|if|else|return|goto|continue|switch|default|case|break}x; 436 437our $BasicType; 438our $NonptrType; 439our $NonptrTypeMisordered; 440our $NonptrTypeWithAttr; 441our $Type; 442our $TypeMisordered; 443our $Declare; 444our $DeclareMisordered; 445 446our $NON_ASCII_UTF8 = qr{ 447 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 448 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 449 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 450 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 451 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 452 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 453 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 454}x; 455 456our $UTF8 = qr{ 457 [\x09\x0A\x0D\x20-\x7E] # ASCII 458 | $NON_ASCII_UTF8 459}x; 460 461our $typeC99Typedefs = qr{(?:__)?(?:[us]_?)?int_?(?:8|16|32|64)_t}; 462our $typeOtherOSTypedefs = qr{(?x: 463 u_(?:char|short|int|long) | # bsd 464 u(?:nchar|short|int|long) # sysv 465)}; 466our $typeKernelTypedefs = qr{(?x: 467 (?:__)?(?:u|s|be|le)(?:8|16|32|64)| 468 atomic_t 469)}; 470our $typeTypedefs = qr{(?x: 471 $typeC99Typedefs\b| 472 $typeOtherOSTypedefs\b| 473 $typeKernelTypedefs\b 474)}; 475 476our $zero_initializer = qr{(?:(?:0[xX])?0+$Int_type?|NULL|false)\b}; 477 478our $logFunctions = qr{(?x: 479 printk(?:_ratelimited|_once|_deferred_once|_deferred|)| 480 (?:[a-z0-9]+_){1,2}(?:printk|emerg|alert|crit|err|warning|warn|notice|info|debug|dbg|vdbg|devel|cont|WARN)(?:_ratelimited|_once|)| 481 TP_printk| 482 WARN(?:_RATELIMIT|_ONCE|)| 483 panic| 484 MODULE_[A-Z_]+| 485 seq_vprintf|seq_printf|seq_puts 486)}; 487 488our $allocFunctions = qr{(?x: 489 (?:(?:devm_)? 490 (?:kv|k|v)[czm]alloc(?:_array)?(?:_node)? | 491 kstrdup(?:_const)? | 492 kmemdup(?:_nul)?) | 493 (?:\w+)?alloc_skb(?:_ip_align)? | 494 # dev_alloc_skb/netdev_alloc_skb, et al 495 dma_alloc_coherent 496)}; 497 498our $signature_tags = qr{(?xi: 499 Signed-off-by:| 500 Co-developed-by:| 501 Acked-by:| 502 Tested-by:| 503 Reviewed-by:| 504 Reported-by:| 505 Suggested-by:| 506 To:| 507 Cc: 508)}; 509 510our $tracing_logging_tags = qr{(?xi: 511 [=-]*> | 512 <[=-]* | 513 \[ | 514 \] | 515 start | 516 called | 517 entered | 518 entry | 519 enter | 520 in | 521 inside | 522 here | 523 begin | 524 exit | 525 end | 526 done | 527 leave | 528 completed | 529 out | 530 return | 531 [\.\!:\s]* 532)}; 533 534sub edit_distance_min { 535 my (@arr) = @_; 536 my $len = scalar @arr; 537 if ((scalar @arr) < 1) { 538 # if underflow, return 539 return; 540 } 541 my $min = $arr[0]; 542 for my $i (0 .. ($len-1)) { 543 if ($arr[$i] < $min) { 544 $min = $arr[$i]; 545 } 546 } 547 return $min; 548} 549 550sub get_edit_distance { 551 my ($str1, $str2) = @_; 552 $str1 = lc($str1); 553 $str2 = lc($str2); 554 $str1 =~ s/-//g; 555 $str2 =~ s/-//g; 556 my $len1 = length($str1); 557 my $len2 = length($str2); 558 # two dimensional array storing minimum edit distance 559 my @distance; 560 for my $i (0 .. $len1) { 561 for my $j (0 .. $len2) { 562 if ($i == 0) { 563 $distance[$i][$j] = $j; 564 } elsif ($j == 0) { 565 $distance[$i][$j] = $i; 566 } elsif (substr($str1, $i-1, 1) eq substr($str2, $j-1, 1)) { 567 $distance[$i][$j] = $distance[$i - 1][$j - 1]; 568 } else { 569 my $dist1 = $distance[$i][$j - 1]; #insert distance 570 my $dist2 = $distance[$i - 1][$j]; # remove 571 my $dist3 = $distance[$i - 1][$j - 1]; #replace 572 $distance[$i][$j] = 1 + edit_distance_min($dist1, $dist2, $dist3); 573 } 574 } 575 } 576 return $distance[$len1][$len2]; 577} 578 579sub find_standard_signature { 580 my ($sign_off) = @_; 581 my @standard_signature_tags = ( 582 'Signed-off-by:', 'Co-developed-by:', 'Acked-by:', 'Tested-by:', 583 'Reviewed-by:', 'Reported-by:', 'Suggested-by:' 584 ); 585 foreach my $signature (@standard_signature_tags) { 586 return $signature if (get_edit_distance($sign_off, $signature) <= 2); 587 } 588 589 return ""; 590} 591 592our @typeListMisordered = ( 593 qr{char\s+(?:un)?signed}, 594 qr{int\s+(?:(?:un)?signed\s+)?short\s}, 595 qr{int\s+short(?:\s+(?:un)?signed)}, 596 qr{short\s+int(?:\s+(?:un)?signed)}, 597 qr{(?:un)?signed\s+int\s+short}, 598 qr{short\s+(?:un)?signed}, 599 qr{long\s+int\s+(?:un)?signed}, 600 qr{int\s+long\s+(?:un)?signed}, 601 qr{long\s+(?:un)?signed\s+int}, 602 qr{int\s+(?:un)?signed\s+long}, 603 qr{int\s+(?:un)?signed}, 604 qr{int\s+long\s+long\s+(?:un)?signed}, 605 qr{long\s+long\s+int\s+(?:un)?signed}, 606 qr{long\s+long\s+(?:un)?signed\s+int}, 607 qr{long\s+long\s+(?:un)?signed}, 608 qr{long\s+(?:un)?signed}, 609); 610 611our @typeList = ( 612 qr{void}, 613 qr{(?:(?:un)?signed\s+)?char}, 614 qr{(?:(?:un)?signed\s+)?short\s+int}, 615 qr{(?:(?:un)?signed\s+)?short}, 616 qr{(?:(?:un)?signed\s+)?int}, 617 qr{(?:(?:un)?signed\s+)?long\s+int}, 618 qr{(?:(?:un)?signed\s+)?long\s+long\s+int}, 619 qr{(?:(?:un)?signed\s+)?long\s+long}, 620 qr{(?:(?:un)?signed\s+)?long}, 621 qr{(?:un)?signed}, 622 qr{float}, 623 qr{double}, 624 qr{bool}, 625 qr{struct\s+$Ident}, 626 qr{union\s+$Ident}, 627 qr{enum\s+$Ident}, 628 qr{${Ident}_t}, 629 qr{${Ident}_handler}, 630 qr{${Ident}_handler_fn}, 631 @typeListMisordered, 632); 633 634our $C90_int_types = qr{(?x: 635 long\s+long\s+int\s+(?:un)?signed| 636 long\s+long\s+(?:un)?signed\s+int| 637 long\s+long\s+(?:un)?signed| 638 (?:(?:un)?signed\s+)?long\s+long\s+int| 639 (?:(?:un)?signed\s+)?long\s+long| 640 int\s+long\s+long\s+(?:un)?signed| 641 int\s+(?:(?:un)?signed\s+)?long\s+long| 642 643 long\s+int\s+(?:un)?signed| 644 long\s+(?:un)?signed\s+int| 645 long\s+(?:un)?signed| 646 (?:(?:un)?signed\s+)?long\s+int| 647 (?:(?:un)?signed\s+)?long| 648 int\s+long\s+(?:un)?signed| 649 int\s+(?:(?:un)?signed\s+)?long| 650 651 int\s+(?:un)?signed| 652 (?:(?:un)?signed\s+)?int 653)}; 654 655our @typeListFile = (); 656our @typeListWithAttr = ( 657 @typeList, 658 qr{struct\s+$InitAttribute\s+$Ident}, 659 qr{union\s+$InitAttribute\s+$Ident}, 660); 661 662our @modifierList = ( 663 qr{fastcall}, 664); 665our @modifierListFile = (); 666 667our @mode_permission_funcs = ( 668 ["module_param", 3], 669 ["module_param_(?:array|named|string)", 4], 670 ["module_param_array_named", 5], 671 ["debugfs_create_(?:file|u8|u16|u32|u64|x8|x16|x32|x64|size_t|atomic_t|bool|blob|regset32|u32_array)", 2], 672 ["proc_create(?:_data|)", 2], 673 ["(?:CLASS|DEVICE|SENSOR|SENSOR_DEVICE|IIO_DEVICE)_ATTR", 2], 674 ["IIO_DEV_ATTR_[A-Z_]+", 1], 675 ["SENSOR_(?:DEVICE_|)ATTR_2", 2], 676 ["SENSOR_TEMPLATE(?:_2|)", 3], 677 ["__ATTR", 2], 678); 679 680my $word_pattern = '\b[A-Z]?[a-z]{2,}\b'; 681 682#Create a search pattern for all these functions to speed up a loop below 683our $mode_perms_search = ""; 684foreach my $entry (@mode_permission_funcs) { 685 $mode_perms_search .= '|' if ($mode_perms_search ne ""); 686 $mode_perms_search .= $entry->[0]; 687} 688$mode_perms_search = "(?:${mode_perms_search})"; 689 690our %deprecated_apis = ( 691 "synchronize_rcu_bh" => "synchronize_rcu", 692 "synchronize_rcu_bh_expedited" => "synchronize_rcu_expedited", 693 "call_rcu_bh" => "call_rcu", 694 "rcu_barrier_bh" => "rcu_barrier", 695 "synchronize_sched" => "synchronize_rcu", 696 "synchronize_sched_expedited" => "synchronize_rcu_expedited", 697 "call_rcu_sched" => "call_rcu", 698 "rcu_barrier_sched" => "rcu_barrier", 699 "get_state_synchronize_sched" => "get_state_synchronize_rcu", 700 "cond_synchronize_sched" => "cond_synchronize_rcu", 701); 702 703#Create a search pattern for all these strings to speed up a loop below 704our $deprecated_apis_search = ""; 705foreach my $entry (keys %deprecated_apis) { 706 $deprecated_apis_search .= '|' if ($deprecated_apis_search ne ""); 707 $deprecated_apis_search .= $entry; 708} 709$deprecated_apis_search = "(?:${deprecated_apis_search})"; 710 711our $mode_perms_world_writable = qr{ 712 S_IWUGO | 713 S_IWOTH | 714 S_IRWXUGO | 715 S_IALLUGO | 716 0[0-7][0-7][2367] 717}x; 718 719our %mode_permission_string_types = ( 720 "S_IRWXU" => 0700, 721 "S_IRUSR" => 0400, 722 "S_IWUSR" => 0200, 723 "S_IXUSR" => 0100, 724 "S_IRWXG" => 0070, 725 "S_IRGRP" => 0040, 726 "S_IWGRP" => 0020, 727 "S_IXGRP" => 0010, 728 "S_IRWXO" => 0007, 729 "S_IROTH" => 0004, 730 "S_IWOTH" => 0002, 731 "S_IXOTH" => 0001, 732 "S_IRWXUGO" => 0777, 733 "S_IRUGO" => 0444, 734 "S_IWUGO" => 0222, 735 "S_IXUGO" => 0111, 736); 737 738#Create a search pattern for all these strings to speed up a loop below 739our $mode_perms_string_search = ""; 740foreach my $entry (keys %mode_permission_string_types) { 741 $mode_perms_string_search .= '|' if ($mode_perms_string_search ne ""); 742 $mode_perms_string_search .= $entry; 743} 744our $single_mode_perms_string_search = "(?:${mode_perms_string_search})"; 745our $multi_mode_perms_string_search = qr{ 746 ${single_mode_perms_string_search} 747 (?:\s*\|\s*${single_mode_perms_string_search})* 748}x; 749 750sub perms_to_octal { 751 my ($string) = @_; 752 753 return trim($string) if ($string =~ /^\s*0[0-7]{3,3}\s*$/); 754 755 my $val = ""; 756 my $oval = ""; 757 my $to = 0; 758 my $curpos = 0; 759 my $lastpos = 0; 760 while ($string =~ /\b(($single_mode_perms_string_search)\b(?:\s*\|\s*)?\s*)/g) { 761 $curpos = pos($string); 762 my $match = $2; 763 my $omatch = $1; 764 last if ($lastpos > 0 && ($curpos - length($omatch) != $lastpos)); 765 $lastpos = $curpos; 766 $to |= $mode_permission_string_types{$match}; 767 $val .= '\s*\|\s*' if ($val ne ""); 768 $val .= $match; 769 $oval .= $omatch; 770 } 771 $oval =~ s/^\s*\|\s*//; 772 $oval =~ s/\s*\|\s*$//; 773 return sprintf("%04o", $to); 774} 775 776our $allowed_asm_includes = qr{(?x: 777 irq| 778 memory| 779 time| 780 reboot 781)}; 782# memory.h: ARM has a custom one 783 784# Load common spelling mistakes and build regular expression list. 785my $misspellings; 786my %spelling_fix; 787 788if (open(my $spelling, '<', $spelling_file)) { 789 while (<$spelling>) { 790 my $line = $_; 791 792 $line =~ s/\s*\n?$//g; 793 $line =~ s/^\s*//g; 794 795 next if ($line =~ m/^\s*#/); 796 next if ($line =~ m/^\s*$/); 797 798 my ($suspect, $fix) = split(/\|\|/, $line); 799 800 $spelling_fix{$suspect} = $fix; 801 } 802 close($spelling); 803} else { 804 warn "No typos will be found - file '$spelling_file': $!\n"; 805} 806 807if ($codespell) { 808 if (open(my $spelling, '<', $codespellfile)) { 809 while (<$spelling>) { 810 my $line = $_; 811 812 $line =~ s/\s*\n?$//g; 813 $line =~ s/^\s*//g; 814 815 next if ($line =~ m/^\s*#/); 816 next if ($line =~ m/^\s*$/); 817 next if ($line =~ m/, disabled/i); 818 819 $line =~ s/,.*$//; 820 821 my ($suspect, $fix) = split(/->/, $line); 822 823 $spelling_fix{$suspect} = $fix; 824 } 825 close($spelling); 826 } else { 827 warn "No codespell typos will be found - file '$codespellfile': $!\n"; 828 } 829} 830 831$misspellings = join("|", sort keys %spelling_fix) if keys %spelling_fix; 832 833sub read_words { 834 my ($wordsRef, $file) = @_; 835 836 if (open(my $words, '<', $file)) { 837 while (<$words>) { 838 my $line = $_; 839 840 $line =~ s/\s*\n?$//g; 841 $line =~ s/^\s*//g; 842 843 next if ($line =~ m/^\s*#/); 844 next if ($line =~ m/^\s*$/); 845 if ($line =~ /\s/) { 846 print("$file: '$line' invalid - ignored\n"); 847 next; 848 } 849 850 $$wordsRef .= '|' if (defined $$wordsRef); 851 $$wordsRef .= $line; 852 } 853 close($file); 854 return 1; 855 } 856 857 return 0; 858} 859 860my $const_structs; 861if (show_type("CONST_STRUCT")) { 862 read_words(\$const_structs, $conststructsfile) 863 or warn "No structs that should be const will be found - file '$conststructsfile': $!\n"; 864} 865 866if (defined($typedefsfile)) { 867 my $typeOtherTypedefs; 868 read_words(\$typeOtherTypedefs, $typedefsfile) 869 or warn "No additional types will be considered - file '$typedefsfile': $!\n"; 870 $typeTypedefs .= '|' . $typeOtherTypedefs if (defined $typeOtherTypedefs); 871} 872 873sub build_types { 874 my $mods = "(?x: \n" . join("|\n ", (@modifierList, @modifierListFile)) . "\n)"; 875 my $all = "(?x: \n" . join("|\n ", (@typeList, @typeListFile)) . "\n)"; 876 my $Misordered = "(?x: \n" . join("|\n ", @typeListMisordered) . "\n)"; 877 my $allWithAttr = "(?x: \n" . join("|\n ", @typeListWithAttr) . "\n)"; 878 $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 879 $BasicType = qr{ 880 (?:$typeTypedefs\b)| 881 (?:${all}\b) 882 }x; 883 $NonptrType = qr{ 884 (?:$Modifier\s+|const\s+)* 885 (?: 886 (?:typeof|__typeof__)\s*\([^\)]*\)| 887 (?:$typeTypedefs\b)| 888 (?:${all}\b) 889 ) 890 (?:\s+$Modifier|\s+const)* 891 }x; 892 $NonptrTypeMisordered = qr{ 893 (?:$Modifier\s+|const\s+)* 894 (?: 895 (?:${Misordered}\b) 896 ) 897 (?:\s+$Modifier|\s+const)* 898 }x; 899 $NonptrTypeWithAttr = qr{ 900 (?:$Modifier\s+|const\s+)* 901 (?: 902 (?:typeof|__typeof__)\s*\([^\)]*\)| 903 (?:$typeTypedefs\b)| 904 (?:${allWithAttr}\b) 905 ) 906 (?:\s+$Modifier|\s+const)* 907 }x; 908 $Type = qr{ 909 $NonptrType 910 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 911 (?:\s+$Inline|\s+$Modifier)* 912 }x; 913 $TypeMisordered = qr{ 914 $NonptrTypeMisordered 915 (?:(?:\s|\*|\[\])+\s*const|(?:\s|\*\s*(?:const\s*)?|\[\])+|(?:\s*\[\s*\])+){0,4} 916 (?:\s+$Inline|\s+$Modifier)* 917 }x; 918 $Declare = qr{(?:$Storage\s+(?:$Inline\s+)?)?$Type}; 919 $DeclareMisordered = qr{(?:$Storage\s+(?:$Inline\s+)?)?$TypeMisordered}; 920} 921build_types(); 922 923our $Typecast = qr{\s*(\(\s*$NonptrType\s*\)){0,1}\s*}; 924 925# Using $balanced_parens, $LvalOrFunc, or $FuncArg 926# requires at least perl version v5.10.0 927# Any use must be runtime checked with $^V 928 929our $balanced_parens = qr/(\((?:[^\(\)]++|(?-1))*\))/; 930our $LvalOrFunc = qr{((?:[\&\*]\s*)?$Lval)\s*($balanced_parens{0,1})\s*}; 931our $FuncArg = qr{$Typecast{0,1}($LvalOrFunc|$Constant|$String)}; 932 933our $declaration_macros = qr{(?x: 934 (?:$Storage\s+)?(?:[A-Z_][A-Z0-9]*_){0,2}(?:DEFINE|DECLARE)(?:_[A-Z0-9]+){1,6}\s*\(| 935 (?:$Storage\s+)?[HLP]?LIST_HEAD\s*\(| 936 (?:SKCIPHER_REQUEST|SHASH_DESC|AHASH_REQUEST)_ON_STACK\s*\( 937)}; 938 939our %allow_repeated_words = ( 940 add => '', 941 added => '', 942 bad => '', 943 be => '', 944); 945 946sub deparenthesize { 947 my ($string) = @_; 948 return "" if (!defined($string)); 949 950 while ($string =~ /^\s*\(.*\)\s*$/) { 951 $string =~ s@^\s*\(\s*@@; 952 $string =~ s@\s*\)\s*$@@; 953 } 954 955 $string =~ s@\s+@ @g; 956 957 return $string; 958} 959 960sub seed_camelcase_file { 961 my ($file) = @_; 962 963 return if (!(-f $file)); 964 965 local $/; 966 967 open(my $include_file, '<', "$file") 968 or warn "$P: Can't read '$file' $!\n"; 969 my $text = <$include_file>; 970 close($include_file); 971 972 my @lines = split('\n', $text); 973 974 foreach my $line (@lines) { 975 next if ($line !~ /(?:[A-Z][a-z]|[a-z][A-Z])/); 976 if ($line =~ /^[ \t]*(?:#[ \t]*define|typedef\s+$Type)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)/) { 977 $camelcase{$1} = 1; 978 } elsif ($line =~ /^\s*$Declare\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[\(\[,;]/) { 979 $camelcase{$1} = 1; 980 } elsif ($line =~ /^\s*(?:union|struct|enum)\s+(\w*(?:[A-Z][a-z]|[a-z][A-Z])\w*)\s*[;\{]/) { 981 $camelcase{$1} = 1; 982 } 983 } 984} 985 986our %maintained_status = (); 987 988sub is_maintained_obsolete { 989 my ($filename) = @_; 990 991 return 0 if (!$tree || !(-e "$root/scripts/get_maintainer.pl")); 992 993 if (!exists($maintained_status{$filename})) { 994 $maintained_status{$filename} = `perl $root/scripts/get_maintainer.pl --status --nom --nol --nogit --nogit-fallback -f $filename 2>&1`; 995 } 996 997 return $maintained_status{$filename} =~ /obsolete/i; 998} 999 1000sub is_SPDX_License_valid { 1001 my ($license) = @_; 1002 1003 return 1 if (!$tree || which("python") eq "" || !(-e "$root/scripts/spdxcheck.py") || !(-e "$gitroot")); 1004 1005 my $root_path = abs_path($root); 1006 my $status = `cd "$root_path"; echo "$license" | python scripts/spdxcheck.py -`; 1007 return 0 if ($status ne ""); 1008 return 1; 1009} 1010 1011my $camelcase_seeded = 0; 1012sub seed_camelcase_includes { 1013 return if ($camelcase_seeded); 1014 1015 my $files; 1016 my $camelcase_cache = ""; 1017 my @include_files = (); 1018 1019 $camelcase_seeded = 1; 1020 1021 if (-e "$gitroot") { 1022 my $git_last_include_commit = `${git_command} log --no-merges --pretty=format:"%h%n" -1 -- include`; 1023 chomp $git_last_include_commit; 1024 $camelcase_cache = ".checkpatch-camelcase.git.$git_last_include_commit"; 1025 } else { 1026 my $last_mod_date = 0; 1027 $files = `find $root/include -name "*.h"`; 1028 @include_files = split('\n', $files); 1029 foreach my $file (@include_files) { 1030 my $date = POSIX::strftime("%Y%m%d%H%M", 1031 localtime((stat $file)[9])); 1032 $last_mod_date = $date if ($last_mod_date < $date); 1033 } 1034 $camelcase_cache = ".checkpatch-camelcase.date.$last_mod_date"; 1035 } 1036 1037 if ($camelcase_cache ne "" && -f $camelcase_cache) { 1038 open(my $camelcase_file, '<', "$camelcase_cache") 1039 or warn "$P: Can't read '$camelcase_cache' $!\n"; 1040 while (<$camelcase_file>) { 1041 chomp; 1042 $camelcase{$_} = 1; 1043 } 1044 close($camelcase_file); 1045 1046 return; 1047 } 1048 1049 if (-e "$gitroot") { 1050 $files = `${git_command} ls-files "include/*.h"`; 1051 @include_files = split('\n', $files); 1052 } 1053 1054 foreach my $file (@include_files) { 1055 seed_camelcase_file($file); 1056 } 1057 1058 if ($camelcase_cache ne "") { 1059 unlink glob ".checkpatch-camelcase.*"; 1060 open(my $camelcase_file, '>', "$camelcase_cache") 1061 or warn "$P: Can't write '$camelcase_cache' $!\n"; 1062 foreach (sort { lc($a) cmp lc($b) } keys(%camelcase)) { 1063 print $camelcase_file ("$_\n"); 1064 } 1065 close($camelcase_file); 1066 } 1067} 1068 1069sub git_is_single_file { 1070 my ($filename) = @_; 1071 1072 return 0 if ((which("git") eq "") || !(-e "$gitroot")); 1073 1074 my $output = `${git_command} ls-files -- $filename 2>/dev/null`; 1075 my $count = $output =~ tr/\n//; 1076 return $count eq 1 && $output =~ m{^${filename}$}; 1077} 1078 1079sub git_commit_info { 1080 my ($commit, $id, $desc) = @_; 1081 1082 return ($id, $desc) if ((which("git") eq "") || !(-e "$gitroot")); 1083 1084 my $output = `${git_command} log --no-color --format='%H %s' -1 $commit 2>&1`; 1085 $output =~ s/^\s*//gm; 1086 my @lines = split("\n", $output); 1087 1088 return ($id, $desc) if ($#lines < 0); 1089 1090 if ($lines[0] =~ /^error: short SHA1 $commit is ambiguous/) { 1091# Maybe one day convert this block of bash into something that returns 1092# all matching commit ids, but it's very slow... 1093# 1094# echo "checking commits $1..." 1095# git rev-list --remotes | grep -i "^$1" | 1096# while read line ; do 1097# git log --format='%H %s' -1 $line | 1098# echo "commit $(cut -c 1-12,41-)" 1099# done 1100 } elsif ($lines[0] =~ /^fatal: ambiguous argument '$commit': unknown revision or path not in the working tree\./) { 1101 $id = undef; 1102 } else { 1103 $id = substr($lines[0], 0, 12); 1104 $desc = substr($lines[0], 41); 1105 } 1106 1107 return ($id, $desc); 1108} 1109 1110$chk_signoff = 0 if ($file); 1111 1112my @rawlines = (); 1113my @lines = (); 1114my @fixed = (); 1115my @fixed_inserted = (); 1116my @fixed_deleted = (); 1117my $fixlinenr = -1; 1118 1119# If input is git commits, extract all commits from the commit expressions. 1120# For example, HEAD-3 means we need check 'HEAD, HEAD~1, HEAD~2'. 1121die "$P: No git repository found\n" if ($git && !-e "$gitroot"); 1122 1123if ($git) { 1124 my @commits = (); 1125 foreach my $commit_expr (@ARGV) { 1126 my $git_range; 1127 if ($commit_expr =~ m/^(.*)-(\d+)$/) { 1128 $git_range = "-$2 $1"; 1129 } elsif ($commit_expr =~ m/\.\./) { 1130 $git_range = "$commit_expr"; 1131 } else { 1132 $git_range = "-1 $commit_expr"; 1133 } 1134 my $lines = `${git_command} log --no-color --no-merges --pretty=format:'%H %s' $git_range`; 1135 foreach my $line (split(/\n/, $lines)) { 1136 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 1137 next if (!defined($1) || !defined($2)); 1138 my $sha1 = $1; 1139 my $subject = $2; 1140 unshift(@commits, $sha1); 1141 $git_commits{$sha1} = $subject; 1142 } 1143 } 1144 die "$P: no git commits after extraction!\n" if (@commits == 0); 1145 @ARGV = @commits; 1146} 1147 1148my $vname; 1149$allow_c99_comments = !defined $ignore_type{"C99_COMMENT_TOLERANCE"}; 1150for my $filename (@ARGV) { 1151 my $FILE; 1152 my $is_git_file = git_is_single_file($filename); 1153 my $oldfile = $file; 1154 $file = 1 if ($is_git_file); 1155 if ($git) { 1156 open($FILE, '-|', "git format-patch -M --stdout -1 $filename") || 1157 die "$P: $filename: git format-patch failed - $!\n"; 1158 } elsif ($file) { 1159 open($FILE, '-|', "diff -u /dev/null $filename") || 1160 die "$P: $filename: diff failed - $!\n"; 1161 } elsif ($filename eq '-') { 1162 open($FILE, '<&STDIN'); 1163 } else { 1164 open($FILE, '<', "$filename") || 1165 die "$P: $filename: open failed - $!\n"; 1166 } 1167 if ($filename eq '-') { 1168 $vname = 'Your patch'; 1169 } elsif ($git) { 1170 $vname = "Commit " . substr($filename, 0, 12) . ' ("' . $git_commits{$filename} . '")'; 1171 } else { 1172 $vname = $filename; 1173 } 1174 while (<$FILE>) { 1175 chomp; 1176 push(@rawlines, $_); 1177 $vname = qq("$1") if ($filename eq '-' && $_ =~ m/^Subject:\s+(.+)/i); 1178 } 1179 close($FILE); 1180 1181 if ($#ARGV > 0 && $quiet == 0) { 1182 print '-' x length($vname) . "\n"; 1183 print "$vname\n"; 1184 print '-' x length($vname) . "\n"; 1185 } 1186 1187 if (!process($filename)) { 1188 $exit = 1; 1189 } 1190 @rawlines = (); 1191 @lines = (); 1192 @fixed = (); 1193 @fixed_inserted = (); 1194 @fixed_deleted = (); 1195 $fixlinenr = -1; 1196 @modifierListFile = (); 1197 @typeListFile = (); 1198 build_types(); 1199 $file = $oldfile if ($is_git_file); 1200} 1201 1202if (!$quiet) { 1203 hash_show_words(\%use_type, "Used"); 1204 hash_show_words(\%ignore_type, "Ignored"); 1205 1206 if (!$perl_version_ok) { 1207 print << "EOM" 1208 1209NOTE: perl $^V is not modern enough to detect all possible issues. 1210 An upgrade to at least perl $minimum_perl_version is suggested. 1211EOM 1212 } 1213 if ($exit) { 1214 print << "EOM" 1215 1216NOTE: If any of the errors are false positives, please report 1217 them to the maintainer, see CHECKPATCH in MAINTAINERS. 1218EOM 1219 } 1220} 1221 1222exit($exit); 1223 1224sub top_of_kernel_tree { 1225 my ($root) = @_; 1226 1227 my @tree_check = ( 1228 "COPYING", "CREDITS", "Kbuild", "MAINTAINERS", "Makefile", 1229 "README", "Documentation", "arch", "include", "drivers", 1230 "fs", "init", "ipc", "kernel", "lib", "scripts", 1231 ); 1232 1233 foreach my $check (@tree_check) { 1234 if (! -e $root . '/' . $check) { 1235 return 0; 1236 } 1237 } 1238 return 1; 1239} 1240 1241sub parse_email { 1242 my ($formatted_email) = @_; 1243 1244 my $name = ""; 1245 my $quoted = ""; 1246 my $name_comment = ""; 1247 my $address = ""; 1248 my $comment = ""; 1249 1250 if ($formatted_email =~ /^(.*)<(\S+\@\S+)>(.*)$/) { 1251 $name = $1; 1252 $address = $2; 1253 $comment = $3 if defined $3; 1254 } elsif ($formatted_email =~ /^\s*<(\S+\@\S+)>(.*)$/) { 1255 $address = $1; 1256 $comment = $2 if defined $2; 1257 } elsif ($formatted_email =~ /(\S+\@\S+)(.*)$/) { 1258 $address = $1; 1259 $comment = $2 if defined $2; 1260 $formatted_email =~ s/\Q$address\E.*$//; 1261 $name = $formatted_email; 1262 $name = trim($name); 1263 $name =~ s/^\"|\"$//g; 1264 # If there's a name left after stripping spaces and 1265 # leading quotes, and the address doesn't have both 1266 # leading and trailing angle brackets, the address 1267 # is invalid. ie: 1268 # "joe smith joe@smith.com" bad 1269 # "joe smith <joe@smith.com" bad 1270 if ($name ne "" && $address !~ /^<[^>]+>$/) { 1271 $name = ""; 1272 $address = ""; 1273 $comment = ""; 1274 } 1275 } 1276 1277 # Extract comments from names excluding quoted parts 1278 # "John D. (Doe)" - Do not extract 1279 if ($name =~ s/\"(.+)\"//) { 1280 $quoted = $1; 1281 } 1282 while ($name =~ s/\s*($balanced_parens)\s*/ /) { 1283 $name_comment .= trim($1); 1284 } 1285 $name =~ s/^[ \"]+|[ \"]+$//g; 1286 $name = trim("$quoted $name"); 1287 1288 $address = trim($address); 1289 $address =~ s/^\<|\>$//g; 1290 $comment = trim($comment); 1291 1292 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 1293 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 1294 $name = "\"$name\""; 1295 } 1296 1297 return ($name, $name_comment, $address, $comment); 1298} 1299 1300sub format_email { 1301 my ($name, $name_comment, $address, $comment) = @_; 1302 1303 my $formatted_email; 1304 1305 $name =~ s/^[ \"]+|[ \"]+$//g; 1306 $address = trim($address); 1307 $address =~ s/(?:\.|\,|\")+$//; ##trailing commas, dots or quotes 1308 1309 if ($name =~ /[^\w \-]/i) { ##has "must quote" chars 1310 $name =~ s/(?<!\\)"/\\"/g; ##escape quotes 1311 $name = "\"$name\""; 1312 } 1313 1314 $name_comment = trim($name_comment); 1315 $name_comment = " $name_comment" if ($name_comment ne ""); 1316 $comment = trim($comment); 1317 $comment = " $comment" if ($comment ne ""); 1318 1319 if ("$name" eq "") { 1320 $formatted_email = "$address"; 1321 } else { 1322 $formatted_email = "$name$name_comment <$address>"; 1323 } 1324 $formatted_email .= "$comment"; 1325 return $formatted_email; 1326} 1327 1328sub reformat_email { 1329 my ($email) = @_; 1330 1331 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 1332 return format_email($email_name, $name_comment, $email_address, $comment); 1333} 1334 1335sub same_email_addresses { 1336 my ($email1, $email2) = @_; 1337 1338 my ($email1_name, $name1_comment, $email1_address, $comment1) = parse_email($email1); 1339 my ($email2_name, $name2_comment, $email2_address, $comment2) = parse_email($email2); 1340 1341 return $email1_name eq $email2_name && 1342 $email1_address eq $email2_address && 1343 $name1_comment eq $name2_comment && 1344 $comment1 eq $comment2; 1345} 1346 1347sub which { 1348 my ($bin) = @_; 1349 1350 foreach my $path (split(/:/, $ENV{PATH})) { 1351 if (-e "$path/$bin") { 1352 return "$path/$bin"; 1353 } 1354 } 1355 1356 return ""; 1357} 1358 1359sub which_conf { 1360 my ($conf) = @_; 1361 1362 foreach my $path (split(/:/, ".:$ENV{HOME}:.scripts")) { 1363 if (-e "$path/$conf") { 1364 return "$path/$conf"; 1365 } 1366 } 1367 1368 return ""; 1369} 1370 1371sub expand_tabs { 1372 my ($str) = @_; 1373 1374 my $res = ''; 1375 my $n = 0; 1376 for my $c (split(//, $str)) { 1377 if ($c eq "\t") { 1378 $res .= ' '; 1379 $n++; 1380 for (; ($n % $tabsize) != 0; $n++) { 1381 $res .= ' '; 1382 } 1383 next; 1384 } 1385 $res .= $c; 1386 $n++; 1387 } 1388 1389 return $res; 1390} 1391sub copy_spacing { 1392 (my $res = shift) =~ tr/\t/ /c; 1393 return $res; 1394} 1395 1396sub line_stats { 1397 my ($line) = @_; 1398 1399 # Drop the diff line leader and expand tabs 1400 $line =~ s/^.//; 1401 $line = expand_tabs($line); 1402 1403 # Pick the indent from the front of the line. 1404 my ($white) = ($line =~ /^(\s*)/); 1405 1406 return (length($line), length($white)); 1407} 1408 1409my $sanitise_quote = ''; 1410 1411sub sanitise_line_reset { 1412 my ($in_comment) = @_; 1413 1414 if ($in_comment) { 1415 $sanitise_quote = '*/'; 1416 } else { 1417 $sanitise_quote = ''; 1418 } 1419} 1420sub sanitise_line { 1421 my ($line) = @_; 1422 1423 my $res = ''; 1424 my $l = ''; 1425 1426 my $qlen = 0; 1427 my $off = 0; 1428 my $c; 1429 1430 # Always copy over the diff marker. 1431 $res = substr($line, 0, 1); 1432 1433 for ($off = 1; $off < length($line); $off++) { 1434 $c = substr($line, $off, 1); 1435 1436 # Comments we are whacking completely including the begin 1437 # and end, all to $;. 1438 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 1439 $sanitise_quote = '*/'; 1440 1441 substr($res, $off, 2, "$;$;"); 1442 $off++; 1443 next; 1444 } 1445 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 1446 $sanitise_quote = ''; 1447 substr($res, $off, 2, "$;$;"); 1448 $off++; 1449 next; 1450 } 1451 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 1452 $sanitise_quote = '//'; 1453 1454 substr($res, $off, 2, $sanitise_quote); 1455 $off++; 1456 next; 1457 } 1458 1459 # A \ in a string means ignore the next character. 1460 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 1461 $c eq "\\") { 1462 substr($res, $off, 2, 'XX'); 1463 $off++; 1464 next; 1465 } 1466 # Regular quotes. 1467 if ($c eq "'" || $c eq '"') { 1468 if ($sanitise_quote eq '') { 1469 $sanitise_quote = $c; 1470 1471 substr($res, $off, 1, $c); 1472 next; 1473 } elsif ($sanitise_quote eq $c) { 1474 $sanitise_quote = ''; 1475 } 1476 } 1477 1478 #print "c<$c> SQ<$sanitise_quote>\n"; 1479 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 1480 substr($res, $off, 1, $;); 1481 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 1482 substr($res, $off, 1, $;); 1483 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 1484 substr($res, $off, 1, 'X'); 1485 } else { 1486 substr($res, $off, 1, $c); 1487 } 1488 } 1489 1490 if ($sanitise_quote eq '//') { 1491 $sanitise_quote = ''; 1492 } 1493 1494 # The pathname on a #include may be surrounded by '<' and '>'. 1495 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 1496 my $clean = 'X' x length($1); 1497 $res =~ s@\<.*\>@<$clean>@; 1498 1499 # The whole of a #error is a string. 1500 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 1501 my $clean = 'X' x length($1); 1502 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 1503 } 1504 1505 if ($allow_c99_comments && $res =~ m@(//.*$)@) { 1506 my $match = $1; 1507 $res =~ s/\Q$match\E/"$;" x length($match)/e; 1508 } 1509 1510 return $res; 1511} 1512 1513sub get_quoted_string { 1514 my ($line, $rawline) = @_; 1515 1516 return "" if (!defined($line) || !defined($rawline)); 1517 return "" if ($line !~ m/($String)/g); 1518 return substr($rawline, $-[0], $+[0] - $-[0]); 1519} 1520 1521sub ctx_statement_block { 1522 my ($linenr, $remain, $off) = @_; 1523 my $line = $linenr - 1; 1524 my $blk = ''; 1525 my $soff = $off; 1526 my $coff = $off - 1; 1527 my $coff_set = 0; 1528 1529 my $loff = 0; 1530 1531 my $type = ''; 1532 my $level = 0; 1533 my @stack = (); 1534 my $p; 1535 my $c; 1536 my $len = 0; 1537 1538 my $remainder; 1539 while (1) { 1540 @stack = (['', 0]) if ($#stack == -1); 1541 1542 #warn "CSB: blk<$blk> remain<$remain>\n"; 1543 # If we are about to drop off the end, pull in more 1544 # context. 1545 if ($off >= $len) { 1546 for (; $remain > 0; $line++) { 1547 last if (!defined $lines[$line]); 1548 next if ($lines[$line] =~ /^-/); 1549 $remain--; 1550 $loff = $len; 1551 $blk .= $lines[$line] . "\n"; 1552 $len = length($blk); 1553 $line++; 1554 last; 1555 } 1556 # Bail if there is no further context. 1557 #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 1558 if ($off >= $len) { 1559 last; 1560 } 1561 if ($level == 0 && substr($blk, $off) =~ /^.\s*#\s*define/) { 1562 $level++; 1563 $type = '#'; 1564 } 1565 } 1566 $p = $c; 1567 $c = substr($blk, $off, 1); 1568 $remainder = substr($blk, $off); 1569 1570 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 1571 1572 # Handle nested #if/#else. 1573 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 1574 push(@stack, [ $type, $level ]); 1575 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 1576 ($type, $level) = @{$stack[$#stack - 1]}; 1577 } elsif ($remainder =~ /^#\s*endif\b/) { 1578 ($type, $level) = @{pop(@stack)}; 1579 } 1580 1581 # Statement ends at the ';' or a close '}' at the 1582 # outermost level. 1583 if ($level == 0 && $c eq ';') { 1584 last; 1585 } 1586 1587 # An else is really a conditional as long as its not else if 1588 if ($level == 0 && $coff_set == 0 && 1589 (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 1590 $remainder =~ /^(else)(?:\s|{)/ && 1591 $remainder !~ /^else\s+if\b/) { 1592 $coff = $off + length($1) - 1; 1593 $coff_set = 1; 1594 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 1595 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 1596 } 1597 1598 if (($type eq '' || $type eq '(') && $c eq '(') { 1599 $level++; 1600 $type = '('; 1601 } 1602 if ($type eq '(' && $c eq ')') { 1603 $level--; 1604 $type = ($level != 0)? '(' : ''; 1605 1606 if ($level == 0 && $coff < $soff) { 1607 $coff = $off; 1608 $coff_set = 1; 1609 #warn "CSB: mark coff<$coff>\n"; 1610 } 1611 } 1612 if (($type eq '' || $type eq '{') && $c eq '{') { 1613 $level++; 1614 $type = '{'; 1615 } 1616 if ($type eq '{' && $c eq '}') { 1617 $level--; 1618 $type = ($level != 0)? '{' : ''; 1619 1620 if ($level == 0) { 1621 if (substr($blk, $off + 1, 1) eq ';') { 1622 $off++; 1623 } 1624 last; 1625 } 1626 } 1627 # Preprocessor commands end at the newline unless escaped. 1628 if ($type eq '#' && $c eq "\n" && $p ne "\\") { 1629 $level--; 1630 $type = ''; 1631 $off++; 1632 last; 1633 } 1634 $off++; 1635 } 1636 # We are truly at the end, so shuffle to the next line. 1637 if ($off == $len) { 1638 $loff = $len + 1; 1639 $line++; 1640 $remain--; 1641 } 1642 1643 my $statement = substr($blk, $soff, $off - $soff + 1); 1644 my $condition = substr($blk, $soff, $coff - $soff + 1); 1645 1646 #warn "STATEMENT<$statement>\n"; 1647 #warn "CONDITION<$condition>\n"; 1648 1649 #print "coff<$coff> soff<$off> loff<$loff>\n"; 1650 1651 return ($statement, $condition, 1652 $line, $remain + 1, $off - $loff + 1, $level); 1653} 1654 1655sub statement_lines { 1656 my ($stmt) = @_; 1657 1658 # Strip the diff line prefixes and rip blank lines at start and end. 1659 $stmt =~ s/(^|\n)./$1/g; 1660 $stmt =~ s/^\s*//; 1661 $stmt =~ s/\s*$//; 1662 1663 my @stmt_lines = ($stmt =~ /\n/g); 1664 1665 return $#stmt_lines + 2; 1666} 1667 1668sub statement_rawlines { 1669 my ($stmt) = @_; 1670 1671 my @stmt_lines = ($stmt =~ /\n/g); 1672 1673 return $#stmt_lines + 2; 1674} 1675 1676sub statement_block_size { 1677 my ($stmt) = @_; 1678 1679 $stmt =~ s/(^|\n)./$1/g; 1680 $stmt =~ s/^\s*{//; 1681 $stmt =~ s/}\s*$//; 1682 $stmt =~ s/^\s*//; 1683 $stmt =~ s/\s*$//; 1684 1685 my @stmt_lines = ($stmt =~ /\n/g); 1686 my @stmt_statements = ($stmt =~ /;/g); 1687 1688 my $stmt_lines = $#stmt_lines + 2; 1689 my $stmt_statements = $#stmt_statements + 1; 1690 1691 if ($stmt_lines > $stmt_statements) { 1692 return $stmt_lines; 1693 } else { 1694 return $stmt_statements; 1695 } 1696} 1697 1698sub ctx_statement_full { 1699 my ($linenr, $remain, $off) = @_; 1700 my ($statement, $condition, $level); 1701 1702 my (@chunks); 1703 1704 # Grab the first conditional/block pair. 1705 ($statement, $condition, $linenr, $remain, $off, $level) = 1706 ctx_statement_block($linenr, $remain, $off); 1707 #print "F: c<$condition> s<$statement> remain<$remain>\n"; 1708 push(@chunks, [ $condition, $statement ]); 1709 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 1710 return ($level, $linenr, @chunks); 1711 } 1712 1713 # Pull in the following conditional/block pairs and see if they 1714 # could continue the statement. 1715 for (;;) { 1716 ($statement, $condition, $linenr, $remain, $off, $level) = 1717 ctx_statement_block($linenr, $remain, $off); 1718 #print "C: c<$condition> s<$statement> remain<$remain>\n"; 1719 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 1720 #print "C: push\n"; 1721 push(@chunks, [ $condition, $statement ]); 1722 } 1723 1724 return ($level, $linenr, @chunks); 1725} 1726 1727sub ctx_block_get { 1728 my ($linenr, $remain, $outer, $open, $close, $off) = @_; 1729 my $line; 1730 my $start = $linenr - 1; 1731 my $blk = ''; 1732 my @o; 1733 my @c; 1734 my @res = (); 1735 1736 my $level = 0; 1737 my @stack = ($level); 1738 for ($line = $start; $remain > 0; $line++) { 1739 next if ($rawlines[$line] =~ /^-/); 1740 $remain--; 1741 1742 $blk .= $rawlines[$line]; 1743 1744 # Handle nested #if/#else. 1745 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 1746 push(@stack, $level); 1747 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 1748 $level = $stack[$#stack - 1]; 1749 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 1750 $level = pop(@stack); 1751 } 1752 1753 foreach my $c (split(//, $lines[$line])) { 1754 ##print "C<$c>L<$level><$open$close>O<$off>\n"; 1755 if ($off > 0) { 1756 $off--; 1757 next; 1758 } 1759 1760 if ($c eq $close && $level > 0) { 1761 $level--; 1762 last if ($level == 0); 1763 } elsif ($c eq $open) { 1764 $level++; 1765 } 1766 } 1767 1768 if (!$outer || $level <= 1) { 1769 push(@res, $rawlines[$line]); 1770 } 1771 1772 last if ($level == 0); 1773 } 1774 1775 return ($level, @res); 1776} 1777sub ctx_block_outer { 1778 my ($linenr, $remain) = @_; 1779 1780 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 1781 return @r; 1782} 1783sub ctx_block { 1784 my ($linenr, $remain) = @_; 1785 1786 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1787 return @r; 1788} 1789sub ctx_statement { 1790 my ($linenr, $remain, $off) = @_; 1791 1792 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1793 return @r; 1794} 1795sub ctx_block_level { 1796 my ($linenr, $remain) = @_; 1797 1798 return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 1799} 1800sub ctx_statement_level { 1801 my ($linenr, $remain, $off) = @_; 1802 1803 return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 1804} 1805 1806sub ctx_locate_comment { 1807 my ($first_line, $end_line) = @_; 1808 1809 # If c99 comment on the current line, or the line before or after 1810 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@^\+.*(//.*$)@); 1811 return $current_comment if (defined $current_comment); 1812 ($current_comment) = ($rawlines[$end_line - 2] =~ m@^[\+ ].*(//.*$)@); 1813 return $current_comment if (defined $current_comment); 1814 ($current_comment) = ($rawlines[$end_line] =~ m@^[\+ ].*(//.*$)@); 1815 return $current_comment if (defined $current_comment); 1816 1817 # Catch a comment on the end of the line itself. 1818 ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 1819 return $current_comment if (defined $current_comment); 1820 1821 # Look through the context and try and figure out if there is a 1822 # comment. 1823 my $in_comment = 0; 1824 $current_comment = ''; 1825 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 1826 my $line = $rawlines[$linenr - 1]; 1827 #warn " $line\n"; 1828 if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 1829 $in_comment = 1; 1830 } 1831 if ($line =~ m@/\*@) { 1832 $in_comment = 1; 1833 } 1834 if (!$in_comment && $current_comment ne '') { 1835 $current_comment = ''; 1836 } 1837 $current_comment .= $line . "\n" if ($in_comment); 1838 if ($line =~ m@\*/@) { 1839 $in_comment = 0; 1840 } 1841 } 1842 1843 chomp($current_comment); 1844 return($current_comment); 1845} 1846sub ctx_has_comment { 1847 my ($first_line, $end_line) = @_; 1848 my $cmt = ctx_locate_comment($first_line, $end_line); 1849 1850 ##print "LINE: $rawlines[$end_line - 1 ]\n"; 1851 ##print "CMMT: $cmt\n"; 1852 1853 return ($cmt ne ''); 1854} 1855 1856sub raw_line { 1857 my ($linenr, $cnt) = @_; 1858 1859 my $offset = $linenr - 1; 1860 $cnt++; 1861 1862 my $line; 1863 while ($cnt) { 1864 $line = $rawlines[$offset++]; 1865 next if (defined($line) && $line =~ /^-/); 1866 $cnt--; 1867 } 1868 1869 return $line; 1870} 1871 1872sub get_stat_real { 1873 my ($linenr, $lc) = @_; 1874 1875 my $stat_real = raw_line($linenr, 0); 1876 for (my $count = $linenr + 1; $count <= $lc; $count++) { 1877 $stat_real = $stat_real . "\n" . raw_line($count, 0); 1878 } 1879 1880 return $stat_real; 1881} 1882 1883sub get_stat_here { 1884 my ($linenr, $cnt, $here) = @_; 1885 1886 my $herectx = $here . "\n"; 1887 for (my $n = 0; $n < $cnt; $n++) { 1888 $herectx .= raw_line($linenr, $n) . "\n"; 1889 } 1890 1891 return $herectx; 1892} 1893 1894sub cat_vet { 1895 my ($vet) = @_; 1896 my ($res, $coded); 1897 1898 $res = ''; 1899 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 1900 $res .= $1; 1901 if ($2 ne '') { 1902 $coded = sprintf("^%c", unpack('C', $2) + 64); 1903 $res .= $coded; 1904 } 1905 } 1906 $res =~ s/$/\$/; 1907 1908 return $res; 1909} 1910 1911my $av_preprocessor = 0; 1912my $av_pending; 1913my @av_paren_type; 1914my $av_pend_colon; 1915 1916sub annotate_reset { 1917 $av_preprocessor = 0; 1918 $av_pending = '_'; 1919 @av_paren_type = ('E'); 1920 $av_pend_colon = 'O'; 1921} 1922 1923sub annotate_values { 1924 my ($stream, $type) = @_; 1925 1926 my $res; 1927 my $var = '_' x length($stream); 1928 my $cur = $stream; 1929 1930 print "$stream\n" if ($dbg_values > 1); 1931 1932 while (length($cur)) { 1933 @av_paren_type = ('E') if ($#av_paren_type < 0); 1934 print " <" . join('', @av_paren_type) . 1935 "> <$type> <$av_pending>" if ($dbg_values > 1); 1936 if ($cur =~ /^(\s+)/o) { 1937 print "WS($1)\n" if ($dbg_values > 1); 1938 if ($1 =~ /\n/ && $av_preprocessor) { 1939 $type = pop(@av_paren_type); 1940 $av_preprocessor = 0; 1941 } 1942 1943 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 1944 print "CAST($1)\n" if ($dbg_values > 1); 1945 push(@av_paren_type, $type); 1946 $type = 'c'; 1947 1948 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1949 print "DECLARE($1)\n" if ($dbg_values > 1); 1950 $type = 'T'; 1951 1952 } elsif ($cur =~ /^($Modifier)\s*/) { 1953 print "MODIFIER($1)\n" if ($dbg_values > 1); 1954 $type = 'T'; 1955 1956 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1957 print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1958 $av_preprocessor = 1; 1959 push(@av_paren_type, $type); 1960 if ($2 ne '') { 1961 $av_pending = 'N'; 1962 } 1963 $type = 'E'; 1964 1965 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1966 print "UNDEF($1)\n" if ($dbg_values > 1); 1967 $av_preprocessor = 1; 1968 push(@av_paren_type, $type); 1969 1970 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1971 print "PRE_START($1)\n" if ($dbg_values > 1); 1972 $av_preprocessor = 1; 1973 1974 push(@av_paren_type, $type); 1975 push(@av_paren_type, $type); 1976 $type = 'E'; 1977 1978 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1979 print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1980 $av_preprocessor = 1; 1981 1982 push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1983 1984 $type = 'E'; 1985 1986 } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1987 print "PRE_END($1)\n" if ($dbg_values > 1); 1988 1989 $av_preprocessor = 1; 1990 1991 # Assume all arms of the conditional end as this 1992 # one does, and continue as if the #endif was not here. 1993 pop(@av_paren_type); 1994 push(@av_paren_type, $type); 1995 $type = 'E'; 1996 1997 } elsif ($cur =~ /^(\\\n)/o) { 1998 print "PRECONT($1)\n" if ($dbg_values > 1); 1999 2000 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 2001 print "ATTR($1)\n" if ($dbg_values > 1); 2002 $av_pending = $type; 2003 $type = 'N'; 2004 2005 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 2006 print "SIZEOF($1)\n" if ($dbg_values > 1); 2007 if (defined $2) { 2008 $av_pending = 'V'; 2009 } 2010 $type = 'N'; 2011 2012 } elsif ($cur =~ /^(if|while|for)\b/o) { 2013 print "COND($1)\n" if ($dbg_values > 1); 2014 $av_pending = 'E'; 2015 $type = 'N'; 2016 2017 } elsif ($cur =~/^(case)/o) { 2018 print "CASE($1)\n" if ($dbg_values > 1); 2019 $av_pend_colon = 'C'; 2020 $type = 'N'; 2021 2022 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 2023 print "KEYWORD($1)\n" if ($dbg_values > 1); 2024 $type = 'N'; 2025 2026 } elsif ($cur =~ /^(\()/o) { 2027 print "PAREN('$1')\n" if ($dbg_values > 1); 2028 push(@av_paren_type, $av_pending); 2029 $av_pending = '_'; 2030 $type = 'N'; 2031 2032 } elsif ($cur =~ /^(\))/o) { 2033 my $new_type = pop(@av_paren_type); 2034 if ($new_type ne '_') { 2035 $type = $new_type; 2036 print "PAREN('$1') -> $type\n" 2037 if ($dbg_values > 1); 2038 } else { 2039 print "PAREN('$1')\n" if ($dbg_values > 1); 2040 } 2041 2042 } elsif ($cur =~ /^($Ident)\s*\(/o) { 2043 print "FUNC($1)\n" if ($dbg_values > 1); 2044 $type = 'V'; 2045 $av_pending = 'V'; 2046 2047 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 2048 if (defined $2 && $type eq 'C' || $type eq 'T') { 2049 $av_pend_colon = 'B'; 2050 } elsif ($type eq 'E') { 2051 $av_pend_colon = 'L'; 2052 } 2053 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 2054 $type = 'V'; 2055 2056 } elsif ($cur =~ /^($Ident|$Constant)/o) { 2057 print "IDENT($1)\n" if ($dbg_values > 1); 2058 $type = 'V'; 2059 2060 } elsif ($cur =~ /^($Assignment)/o) { 2061 print "ASSIGN($1)\n" if ($dbg_values > 1); 2062 $type = 'N'; 2063 2064 } elsif ($cur =~/^(;|{|})/) { 2065 print "END($1)\n" if ($dbg_values > 1); 2066 $type = 'E'; 2067 $av_pend_colon = 'O'; 2068 2069 } elsif ($cur =~/^(,)/) { 2070 print "COMMA($1)\n" if ($dbg_values > 1); 2071 $type = 'C'; 2072 2073 } elsif ($cur =~ /^(\?)/o) { 2074 print "QUESTION($1)\n" if ($dbg_values > 1); 2075 $type = 'N'; 2076 2077 } elsif ($cur =~ /^(:)/o) { 2078 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 2079 2080 substr($var, length($res), 1, $av_pend_colon); 2081 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 2082 $type = 'E'; 2083 } else { 2084 $type = 'N'; 2085 } 2086 $av_pend_colon = 'O'; 2087 2088 } elsif ($cur =~ /^(\[)/o) { 2089 print "CLOSE($1)\n" if ($dbg_values > 1); 2090 $type = 'N'; 2091 2092 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 2093 my $variant; 2094 2095 print "OPV($1)\n" if ($dbg_values > 1); 2096 if ($type eq 'V') { 2097 $variant = 'B'; 2098 } else { 2099 $variant = 'U'; 2100 } 2101 2102 substr($var, length($res), 1, $variant); 2103 $type = 'N'; 2104 2105 } elsif ($cur =~ /^($Operators)/o) { 2106 print "OP($1)\n" if ($dbg_values > 1); 2107 if ($1 ne '++' && $1 ne '--') { 2108 $type = 'N'; 2109 } 2110 2111 } elsif ($cur =~ /(^.)/o) { 2112 print "C($1)\n" if ($dbg_values > 1); 2113 } 2114 if (defined $1) { 2115 $cur = substr($cur, length($1)); 2116 $res .= $type x length($1); 2117 } 2118 } 2119 2120 return ($res, $var); 2121} 2122 2123sub possible { 2124 my ($possible, $line) = @_; 2125 my $notPermitted = qr{(?: 2126 ^(?: 2127 $Modifier| 2128 $Storage| 2129 $Type| 2130 DEFINE_\S+ 2131 )$| 2132 ^(?: 2133 goto| 2134 return| 2135 case| 2136 else| 2137 asm|__asm__| 2138 do| 2139 \#| 2140 \#\#| 2141 )(?:\s|$)| 2142 ^(?:typedef|struct|enum)\b 2143 )}x; 2144 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 2145 if ($possible !~ $notPermitted) { 2146 # Check for modifiers. 2147 $possible =~ s/\s*$Storage\s*//g; 2148 $possible =~ s/\s*$Sparse\s*//g; 2149 if ($possible =~ /^\s*$/) { 2150 2151 } elsif ($possible =~ /\s/) { 2152 $possible =~ s/\s*$Type\s*//g; 2153 for my $modifier (split(' ', $possible)) { 2154 if ($modifier !~ $notPermitted) { 2155 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 2156 push(@modifierListFile, $modifier); 2157 } 2158 } 2159 2160 } else { 2161 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 2162 push(@typeListFile, $possible); 2163 } 2164 build_types(); 2165 } else { 2166 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 2167 } 2168} 2169 2170my $prefix = ''; 2171 2172sub show_type { 2173 my ($type) = @_; 2174 2175 $type =~ tr/[a-z]/[A-Z]/; 2176 2177 return defined $use_type{$type} if (scalar keys %use_type > 0); 2178 2179 return !defined $ignore_type{$type}; 2180} 2181 2182sub report { 2183 my ($level, $type, $msg) = @_; 2184 2185 if (!show_type($type) || 2186 (defined $tst_only && $msg !~ /\Q$tst_only\E/)) { 2187 return 0; 2188 } 2189 my $output = ''; 2190 if ($color) { 2191 if ($level eq 'ERROR') { 2192 $output .= RED; 2193 } elsif ($level eq 'WARNING') { 2194 $output .= YELLOW; 2195 } else { 2196 $output .= GREEN; 2197 } 2198 } 2199 $output .= $prefix . $level . ':'; 2200 if ($show_types) { 2201 $output .= BLUE if ($color); 2202 $output .= "$type:"; 2203 } 2204 $output .= RESET if ($color); 2205 $output .= ' ' . $msg . "\n"; 2206 2207 if ($showfile) { 2208 my @lines = split("\n", $output, -1); 2209 splice(@lines, 1, 1); 2210 $output = join("\n", @lines); 2211 } 2212 $output = (split('\n', $output))[0] . "\n" if ($terse); 2213 2214 push(our @report, $output); 2215 2216 return 1; 2217} 2218 2219sub report_dump { 2220 our @report; 2221} 2222 2223sub fixup_current_range { 2224 my ($lineRef, $offset, $length) = @_; 2225 2226 if ($$lineRef =~ /^\@\@ -\d+,\d+ \+(\d+),(\d+) \@\@/) { 2227 my $o = $1; 2228 my $l = $2; 2229 my $no = $o + $offset; 2230 my $nl = $l + $length; 2231 $$lineRef =~ s/\+$o,$l \@\@/\+$no,$nl \@\@/; 2232 } 2233} 2234 2235sub fix_inserted_deleted_lines { 2236 my ($linesRef, $insertedRef, $deletedRef) = @_; 2237 2238 my $range_last_linenr = 0; 2239 my $delta_offset = 0; 2240 2241 my $old_linenr = 0; 2242 my $new_linenr = 0; 2243 2244 my $next_insert = 0; 2245 my $next_delete = 0; 2246 2247 my @lines = (); 2248 2249 my $inserted = @{$insertedRef}[$next_insert++]; 2250 my $deleted = @{$deletedRef}[$next_delete++]; 2251 2252 foreach my $old_line (@{$linesRef}) { 2253 my $save_line = 1; 2254 my $line = $old_line; #don't modify the array 2255 if ($line =~ /^(?:\+\+\+|\-\-\-)\s+\S+/) { #new filename 2256 $delta_offset = 0; 2257 } elsif ($line =~ /^\@\@ -\d+,\d+ \+\d+,\d+ \@\@/) { #new hunk 2258 $range_last_linenr = $new_linenr; 2259 fixup_current_range(\$line, $delta_offset, 0); 2260 } 2261 2262 while (defined($deleted) && ${$deleted}{'LINENR'} == $old_linenr) { 2263 $deleted = @{$deletedRef}[$next_delete++]; 2264 $save_line = 0; 2265 fixup_current_range(\$lines[$range_last_linenr], $delta_offset--, -1); 2266 } 2267 2268 while (defined($inserted) && ${$inserted}{'LINENR'} == $old_linenr) { 2269 push(@lines, ${$inserted}{'LINE'}); 2270 $inserted = @{$insertedRef}[$next_insert++]; 2271 $new_linenr++; 2272 fixup_current_range(\$lines[$range_last_linenr], $delta_offset++, 1); 2273 } 2274 2275 if ($save_line) { 2276 push(@lines, $line); 2277 $new_linenr++; 2278 } 2279 2280 $old_linenr++; 2281 } 2282 2283 return @lines; 2284} 2285 2286sub fix_insert_line { 2287 my ($linenr, $line) = @_; 2288 2289 my $inserted = { 2290 LINENR => $linenr, 2291 LINE => $line, 2292 }; 2293 push(@fixed_inserted, $inserted); 2294} 2295 2296sub fix_delete_line { 2297 my ($linenr, $line) = @_; 2298 2299 my $deleted = { 2300 LINENR => $linenr, 2301 LINE => $line, 2302 }; 2303 2304 push(@fixed_deleted, $deleted); 2305} 2306 2307sub ERROR { 2308 my ($type, $msg) = @_; 2309 2310 if (report("ERROR", $type, $msg)) { 2311 our $clean = 0; 2312 our $cnt_error++; 2313 return 1; 2314 } 2315 return 0; 2316} 2317sub WARN { 2318 my ($type, $msg) = @_; 2319 2320 if (report("WARNING", $type, $msg)) { 2321 our $clean = 0; 2322 our $cnt_warn++; 2323 return 1; 2324 } 2325 return 0; 2326} 2327sub CHK { 2328 my ($type, $msg) = @_; 2329 2330 if ($check && report("CHECK", $type, $msg)) { 2331 our $clean = 0; 2332 our $cnt_chk++; 2333 return 1; 2334 } 2335 return 0; 2336} 2337 2338sub check_absolute_file { 2339 my ($absolute, $herecurr) = @_; 2340 my $file = $absolute; 2341 2342 ##print "absolute<$absolute>\n"; 2343 2344 # See if any suffix of this path is a path within the tree. 2345 while ($file =~ s@^[^/]*/@@) { 2346 if (-f "$root/$file") { 2347 ##print "file<$file>\n"; 2348 last; 2349 } 2350 } 2351 if (! -f _) { 2352 return 0; 2353 } 2354 2355 # It is, so see if the prefix is acceptable. 2356 my $prefix = $absolute; 2357 substr($prefix, -length($file)) = ''; 2358 2359 ##print "prefix<$prefix>\n"; 2360 if ($prefix ne ".../") { 2361 WARN("USE_RELATIVE_PATH", 2362 "use relative pathname instead of absolute in changelog text\n" . $herecurr); 2363 } 2364} 2365 2366sub trim { 2367 my ($string) = @_; 2368 2369 $string =~ s/^\s+|\s+$//g; 2370 2371 return $string; 2372} 2373 2374sub ltrim { 2375 my ($string) = @_; 2376 2377 $string =~ s/^\s+//; 2378 2379 return $string; 2380} 2381 2382sub rtrim { 2383 my ($string) = @_; 2384 2385 $string =~ s/\s+$//; 2386 2387 return $string; 2388} 2389 2390sub string_find_replace { 2391 my ($string, $find, $replace) = @_; 2392 2393 $string =~ s/$find/$replace/g; 2394 2395 return $string; 2396} 2397 2398sub tabify { 2399 my ($leading) = @_; 2400 2401 my $source_indent = $tabsize; 2402 my $max_spaces_before_tab = $source_indent - 1; 2403 my $spaces_to_tab = " " x $source_indent; 2404 2405 #convert leading spaces to tabs 2406 1 while $leading =~ s@^([\t]*)$spaces_to_tab@$1\t@g; 2407 #Remove spaces before a tab 2408 1 while $leading =~ s@^([\t]*)( {1,$max_spaces_before_tab})\t@$1\t@g; 2409 2410 return "$leading"; 2411} 2412 2413sub pos_last_openparen { 2414 my ($line) = @_; 2415 2416 my $pos = 0; 2417 2418 my $opens = $line =~ tr/\(/\(/; 2419 my $closes = $line =~ tr/\)/\)/; 2420 2421 my $last_openparen = 0; 2422 2423 if (($opens == 0) || ($closes >= $opens)) { 2424 return -1; 2425 } 2426 2427 my $len = length($line); 2428 2429 for ($pos = 0; $pos < $len; $pos++) { 2430 my $string = substr($line, $pos); 2431 if ($string =~ /^($FuncArg|$balanced_parens)/) { 2432 $pos += length($1) - 1; 2433 } elsif (substr($line, $pos, 1) eq '(') { 2434 $last_openparen = $pos; 2435 } elsif (index($string, '(') == -1) { 2436 last; 2437 } 2438 } 2439 2440 return length(expand_tabs(substr($line, 0, $last_openparen))) + 1; 2441} 2442 2443sub get_raw_comment { 2444 my ($line, $rawline) = @_; 2445 my $comment = ''; 2446 2447 for my $i (0 .. (length($line) - 1)) { 2448 if (substr($line, $i, 1) eq "$;") { 2449 $comment .= substr($rawline, $i, 1); 2450 } 2451 } 2452 2453 return $comment; 2454} 2455 2456sub exclude_global_initialisers { 2457 my ($realfile) = @_; 2458 2459 # Do not check for BPF programs (tools/testing/selftests/bpf/progs/*.c, samples/bpf/*_kern.c, *.bpf.c). 2460 return $realfile =~ m@^tools/testing/selftests/bpf/progs/.*\.c$@ || 2461 $realfile =~ m@^samples/bpf/.*_kern\.c$@ || 2462 $realfile =~ m@/bpf/.*\.bpf\.c$@; 2463} 2464 2465sub process { 2466 my $filename = shift; 2467 2468 my $linenr=0; 2469 my $prevline=""; 2470 my $prevrawline=""; 2471 my $stashline=""; 2472 my $stashrawline=""; 2473 2474 my $length; 2475 my $indent; 2476 my $previndent=0; 2477 my $stashindent=0; 2478 2479 our $clean = 1; 2480 my $signoff = 0; 2481 my $author = ''; 2482 my $authorsignoff = 0; 2483 my $author_sob = ''; 2484 my $is_patch = 0; 2485 my $is_binding_patch = -1; 2486 my $in_header_lines = $file ? 0 : 1; 2487 my $in_commit_log = 0; #Scanning lines before patch 2488 my $has_patch_separator = 0; #Found a --- line 2489 my $has_commit_log = 0; #Encountered lines before patch 2490 my $commit_log_lines = 0; #Number of commit log lines 2491 my $commit_log_possible_stack_dump = 0; 2492 my $commit_log_long_line = 0; 2493 my $commit_log_has_diff = 0; 2494 my $reported_maintainer_file = 0; 2495 my $non_utf8_charset = 0; 2496 2497 my $last_blank_line = 0; 2498 my $last_coalesced_string_linenr = -1; 2499 2500 our @report = (); 2501 our $cnt_lines = 0; 2502 our $cnt_error = 0; 2503 our $cnt_warn = 0; 2504 our $cnt_chk = 0; 2505 2506 # Trace the real file/line as we go. 2507 my $realfile = ''; 2508 my $realline = 0; 2509 my $realcnt = 0; 2510 my $here = ''; 2511 my $context_function; #undef'd unless there's a known function 2512 my $in_comment = 0; 2513 my $comment_edge = 0; 2514 my $first_line = 0; 2515 my $p1_prefix = ''; 2516 2517 my $prev_values = 'E'; 2518 2519 # suppression flags 2520 my %suppress_ifbraces; 2521 my %suppress_whiletrailers; 2522 my %suppress_export; 2523 my $suppress_statement = 0; 2524 2525 my %signatures = (); 2526 2527 # Pre-scan the patch sanitizing the lines. 2528 # Pre-scan the patch looking for any __setup documentation. 2529 # 2530 my @setup_docs = (); 2531 my $setup_docs = 0; 2532 2533 my $camelcase_file_seeded = 0; 2534 2535 my $checklicenseline = 1; 2536 2537 sanitise_line_reset(); 2538 my $line; 2539 foreach my $rawline (@rawlines) { 2540 $linenr++; 2541 $line = $rawline; 2542 2543 push(@fixed, $rawline) if ($fix); 2544 2545 if ($rawline=~/^\+\+\+\s+(\S+)/) { 2546 $setup_docs = 0; 2547 if ($1 =~ m@Documentation/admin-guide/kernel-parameters.txt$@) { 2548 $setup_docs = 1; 2549 } 2550 #next; 2551 } 2552 if ($rawline =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 2553 $realline=$1-1; 2554 if (defined $2) { 2555 $realcnt=$3+1; 2556 } else { 2557 $realcnt=1+1; 2558 } 2559 $in_comment = 0; 2560 2561 # Guestimate if this is a continuing comment. Run 2562 # the context looking for a comment "edge". If this 2563 # edge is a close comment then we must be in a comment 2564 # at context start. 2565 my $edge; 2566 my $cnt = $realcnt; 2567 for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 2568 next if (defined $rawlines[$ln - 1] && 2569 $rawlines[$ln - 1] =~ /^-/); 2570 $cnt--; 2571 #print "RAW<$rawlines[$ln - 1]>\n"; 2572 last if (!defined $rawlines[$ln - 1]); 2573 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 2574 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 2575 ($edge) = $1; 2576 last; 2577 } 2578 } 2579 if (defined $edge && $edge eq '*/') { 2580 $in_comment = 1; 2581 } 2582 2583 # Guestimate if this is a continuing comment. If this 2584 # is the start of a diff block and this line starts 2585 # ' *' then it is very likely a comment. 2586 if (!defined $edge && 2587 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 2588 { 2589 $in_comment = 1; 2590 } 2591 2592 ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 2593 sanitise_line_reset($in_comment); 2594 2595 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 2596 # Standardise the strings and chars within the input to 2597 # simplify matching -- only bother with positive lines. 2598 $line = sanitise_line($rawline); 2599 } 2600 push(@lines, $line); 2601 2602 if ($realcnt > 1) { 2603 $realcnt-- if ($line =~ /^(?:\+| |$)/); 2604 } else { 2605 $realcnt = 0; 2606 } 2607 2608 #print "==>$rawline\n"; 2609 #print "-->$line\n"; 2610 2611 if ($setup_docs && $line =~ /^\+/) { 2612 push(@setup_docs, $line); 2613 } 2614 } 2615 2616 $prefix = ''; 2617 2618 $realcnt = 0; 2619 $linenr = 0; 2620 $fixlinenr = -1; 2621 foreach my $line (@lines) { 2622 $linenr++; 2623 $fixlinenr++; 2624 my $sline = $line; #copy of $line 2625 $sline =~ s/$;/ /g; #with comments as spaces 2626 2627 my $rawline = $rawlines[$linenr - 1]; 2628 my $raw_comment = get_raw_comment($line, $rawline); 2629 2630# check if it's a mode change, rename or start of a patch 2631 if (!$in_commit_log && 2632 ($line =~ /^ mode change [0-7]+ => [0-7]+ \S+\s*$/ || 2633 ($line =~ /^rename (?:from|to) \S+\s*$/ || 2634 $line =~ /^diff --git a\/[\w\/\.\_\-]+ b\/\S+\s*$/))) { 2635 $is_patch = 1; 2636 } 2637 2638#extract the line range in the file after the patch is applied 2639 if (!$in_commit_log && 2640 $line =~ /^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@(.*)/) { 2641 my $context = $4; 2642 $is_patch = 1; 2643 $first_line = $linenr + 1; 2644 $realline=$1-1; 2645 if (defined $2) { 2646 $realcnt=$3+1; 2647 } else { 2648 $realcnt=1+1; 2649 } 2650 annotate_reset(); 2651 $prev_values = 'E'; 2652 2653 %suppress_ifbraces = (); 2654 %suppress_whiletrailers = (); 2655 %suppress_export = (); 2656 $suppress_statement = 0; 2657 if ($context =~ /\b(\w+)\s*\(/) { 2658 $context_function = $1; 2659 } else { 2660 undef $context_function; 2661 } 2662 next; 2663 2664# track the line number as we move through the hunk, note that 2665# new versions of GNU diff omit the leading space on completely 2666# blank context lines so we need to count that too. 2667 } elsif ($line =~ /^( |\+|$)/) { 2668 $realline++; 2669 $realcnt-- if ($realcnt != 0); 2670 2671 # Measure the line length and indent. 2672 ($length, $indent) = line_stats($rawline); 2673 2674 # Track the previous line. 2675 ($prevline, $stashline) = ($stashline, $line); 2676 ($previndent, $stashindent) = ($stashindent, $indent); 2677 ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 2678 2679 #warn "line<$line>\n"; 2680 2681 } elsif ($realcnt == 1) { 2682 $realcnt--; 2683 } 2684 2685 my $hunk_line = ($realcnt != 0); 2686 2687 $here = "#$linenr: " if (!$file); 2688 $here = "#$realline: " if ($file); 2689 2690 my $found_file = 0; 2691 # extract the filename as it passes 2692 if ($line =~ /^diff --git.*?(\S+)$/) { 2693 $realfile = $1; 2694 $realfile =~ s@^([^/]*)/@@ if (!$file); 2695 $in_commit_log = 0; 2696 $found_file = 1; 2697 } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 2698 $realfile = $1; 2699 $realfile =~ s@^([^/]*)/@@ if (!$file); 2700 $in_commit_log = 0; 2701 2702 $p1_prefix = $1; 2703 if (!$file && $tree && $p1_prefix ne '' && 2704 -e "$root/$p1_prefix") { 2705 WARN("PATCH_PREFIX", 2706 "patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 2707 } 2708 2709 if ($realfile =~ m@^include/asm/@) { 2710 ERROR("MODIFIED_INCLUDE_ASM", 2711 "do not modify files in include/asm, change architecture specific files in include/asm-<architecture>\n" . "$here$rawline\n"); 2712 } 2713 $found_file = 1; 2714 } 2715 2716#make up the handle for any error we report on this line 2717 if ($showfile) { 2718 $prefix = "$realfile:$realline: " 2719 } elsif ($emacs) { 2720 if ($file) { 2721 $prefix = "$filename:$realline: "; 2722 } else { 2723 $prefix = "$filename:$linenr: "; 2724 } 2725 } 2726 2727 if ($found_file) { 2728 if (is_maintained_obsolete($realfile)) { 2729 WARN("OBSOLETE", 2730 "$realfile is marked as 'obsolete' in the MAINTAINERS hierarchy. No unnecessary modifications please.\n"); 2731 } 2732 if ($realfile =~ m@^(?:drivers/net/|net/|drivers/staging/)@) { 2733 $check = 1; 2734 } else { 2735 $check = $check_orig; 2736 } 2737 $checklicenseline = 1; 2738 2739 if ($realfile !~ /^MAINTAINERS/) { 2740 my $last_binding_patch = $is_binding_patch; 2741 2742 $is_binding_patch = () = $realfile =~ m@^(?:Documentation/devicetree/|include/dt-bindings/)@; 2743 2744 if (($last_binding_patch != -1) && 2745 ($last_binding_patch ^ $is_binding_patch)) { 2746 WARN("DT_SPLIT_BINDING_PATCH", 2747 "DT binding docs and includes should be a separate patch. See: Documentation/devicetree/bindings/submitting-patches.rst\n"); 2748 } 2749 } 2750 2751 next; 2752 } 2753 2754 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 2755 2756 my $hereline = "$here\n$rawline\n"; 2757 my $herecurr = "$here\n$rawline\n"; 2758 my $hereprev = "$here\n$prevrawline\n$rawline\n"; 2759 2760 $cnt_lines++ if ($realcnt != 0); 2761 2762# Verify the existence of a commit log if appropriate 2763# 2 is used because a $signature is counted in $commit_log_lines 2764 if ($in_commit_log) { 2765 if ($line !~ /^\s*$/) { 2766 $commit_log_lines++; #could be a $signature 2767 } 2768 } elsif ($has_commit_log && $commit_log_lines < 2) { 2769 WARN("COMMIT_MESSAGE", 2770 "Missing commit description - Add an appropriate one\n"); 2771 $commit_log_lines = 2; #warn only once 2772 } 2773 2774# Check if the commit log has what seems like a diff which can confuse patch 2775 if ($in_commit_log && !$commit_log_has_diff && 2776 (($line =~ m@^\s+diff\b.*a/([\w/]+)@ && 2777 $line =~ m@^\s+diff\b.*a/[\w/]+\s+b/$1\b@) || 2778 $line =~ m@^\s*(?:\-\-\-\s+a/|\+\+\+\s+b/)@ || 2779 $line =~ m/^\s*\@\@ \-\d+,\d+ \+\d+,\d+ \@\@/)) { 2780 ERROR("DIFF_IN_COMMIT_MSG", 2781 "Avoid using diff content in the commit message - patch(1) might not work\n" . $herecurr); 2782 $commit_log_has_diff = 1; 2783 } 2784 2785# Check for incorrect file permissions 2786 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 2787 my $permhere = $here . "FILE: $realfile\n"; 2788 if ($realfile !~ m@scripts/@ && 2789 $realfile !~ /\.(py|pl|awk|sh)$/) { 2790 ERROR("EXECUTE_PERMISSIONS", 2791 "do not set execute permissions for source files\n" . $permhere); 2792 } 2793 } 2794 2795# Check the patch for a From: 2796 if (decode("MIME-Header", $line) =~ /^From:\s*(.*)/) { 2797 $author = $1; 2798 my $curline = $linenr; 2799 while(defined($rawlines[$curline]) && ($rawlines[$curline++] =~ /^[ \t]\s*(.*)/)) { 2800 $author .= $1; 2801 } 2802 $author = encode("utf8", $author) if ($line =~ /=\?utf-8\?/i); 2803 $author =~ s/"//g; 2804 $author = reformat_email($author); 2805 } 2806 2807# Check the patch for a signoff: 2808 if ($line =~ /^\s*signed-off-by:\s*(.*)/i) { 2809 $signoff++; 2810 $in_commit_log = 0; 2811 if ($author ne '' && $authorsignoff != 1) { 2812 if (same_email_addresses($1, $author)) { 2813 $authorsignoff = 1; 2814 } else { 2815 my $ctx = $1; 2816 my ($email_name, $email_comment, $email_address, $comment1) = parse_email($ctx); 2817 my ($author_name, $author_comment, $author_address, $comment2) = parse_email($author); 2818 2819 if ($email_address eq $author_address && $email_name eq $author_name) { 2820 $author_sob = $ctx; 2821 $authorsignoff = 2; 2822 } elsif ($email_address eq $author_address) { 2823 $author_sob = $ctx; 2824 $authorsignoff = 3; 2825 } elsif ($email_name eq $author_name) { 2826 $author_sob = $ctx; 2827 $authorsignoff = 4; 2828 2829 my $address1 = $email_address; 2830 my $address2 = $author_address; 2831 2832 if ($address1 =~ /(\S+)\+\S+(\@.*)/) { 2833 $address1 = "$1$2"; 2834 } 2835 if ($address2 =~ /(\S+)\+\S+(\@.*)/) { 2836 $address2 = "$1$2"; 2837 } 2838 if ($address1 eq $address2) { 2839 $authorsignoff = 5; 2840 } 2841 } 2842 } 2843 } 2844 } 2845 2846# Check for patch separator 2847 if ($line =~ /^---$/) { 2848 $has_patch_separator = 1; 2849 $in_commit_log = 0; 2850 } 2851 2852# Check if MAINTAINERS is being updated. If so, there's probably no need to 2853# emit the "does MAINTAINERS need updating?" message on file add/move/delete 2854 if ($line =~ /^\s*MAINTAINERS\s*\|/) { 2855 $reported_maintainer_file = 1; 2856 } 2857 2858# Check signature styles 2859 if (!$in_header_lines && 2860 $line =~ /^(\s*)([a-z0-9_-]+by:|$signature_tags)(\s*)(.*)/i) { 2861 my $space_before = $1; 2862 my $sign_off = $2; 2863 my $space_after = $3; 2864 my $email = $4; 2865 my $ucfirst_sign_off = ucfirst(lc($sign_off)); 2866 2867 if ($sign_off !~ /$signature_tags/) { 2868 my $suggested_signature = find_standard_signature($sign_off); 2869 if ($suggested_signature eq "") { 2870 WARN("BAD_SIGN_OFF", 2871 "Non-standard signature: $sign_off\n" . $herecurr); 2872 } else { 2873 if (WARN("BAD_SIGN_OFF", 2874 "Non-standard signature: '$sign_off' - perhaps '$suggested_signature'?\n" . $herecurr) && 2875 $fix) { 2876 $fixed[$fixlinenr] =~ s/$sign_off/$suggested_signature/; 2877 } 2878 } 2879 } 2880 if (defined $space_before && $space_before ne "") { 2881 if (WARN("BAD_SIGN_OFF", 2882 "Do not use whitespace before $ucfirst_sign_off\n" . $herecurr) && 2883 $fix) { 2884 $fixed[$fixlinenr] = 2885 "$ucfirst_sign_off $email"; 2886 } 2887 } 2888 if ($sign_off =~ /-by:$/i && $sign_off ne $ucfirst_sign_off) { 2889 if (WARN("BAD_SIGN_OFF", 2890 "'$ucfirst_sign_off' is the preferred signature form\n" . $herecurr) && 2891 $fix) { 2892 $fixed[$fixlinenr] = 2893 "$ucfirst_sign_off $email"; 2894 } 2895 2896 } 2897 if (!defined $space_after || $space_after ne " ") { 2898 if (WARN("BAD_SIGN_OFF", 2899 "Use a single space after $ucfirst_sign_off\n" . $herecurr) && 2900 $fix) { 2901 $fixed[$fixlinenr] = 2902 "$ucfirst_sign_off $email"; 2903 } 2904 } 2905 2906 my ($email_name, $name_comment, $email_address, $comment) = parse_email($email); 2907 my $suggested_email = format_email(($email_name, $name_comment, $email_address, $comment)); 2908 if ($suggested_email eq "") { 2909 ERROR("BAD_SIGN_OFF", 2910 "Unrecognized email address: '$email'\n" . $herecurr); 2911 } else { 2912 my $dequoted = $suggested_email; 2913 $dequoted =~ s/^"//; 2914 $dequoted =~ s/" </ </; 2915 # Don't force email to have quotes 2916 # Allow just an angle bracketed address 2917 if (!same_email_addresses($email, $suggested_email)) { 2918 if (WARN("BAD_SIGN_OFF", 2919 "email address '$email' might be better as '$suggested_email'\n" . $herecurr) && 2920 $fix) { 2921 $fixed[$fixlinenr] =~ s/\Q$email\E/$suggested_email/; 2922 } 2923 } 2924 2925 # Address part shouldn't have comments 2926 my $stripped_address = $email_address; 2927 $stripped_address =~ s/\([^\(\)]*\)//g; 2928 if ($email_address ne $stripped_address) { 2929 if (WARN("BAD_SIGN_OFF", 2930 "address part of email should not have comments: '$email_address'\n" . $herecurr) && 2931 $fix) { 2932 $fixed[$fixlinenr] =~ s/\Q$email_address\E/$stripped_address/; 2933 } 2934 } 2935 2936 # Only one name comment should be allowed 2937 my $comment_count = () = $name_comment =~ /\([^\)]+\)/g; 2938 if ($comment_count > 1) { 2939 WARN("BAD_SIGN_OFF", 2940 "Use a single name comment in email: '$email'\n" . $herecurr); 2941 } 2942 2943 2944 # stable@vger.kernel.org or stable@kernel.org shouldn't 2945 # have an email name. In addition comments should strictly 2946 # begin with a # 2947 if ($email =~ /^.*stable\@(?:vger\.)?kernel\.org/i) { 2948 if (($comment ne "" && $comment !~ /^#.+/) || 2949 ($email_name ne "")) { 2950 my $cur_name = $email_name; 2951 my $new_comment = $comment; 2952 $cur_name =~ s/[a-zA-Z\s\-\"]+//g; 2953 2954 # Remove brackets enclosing comment text 2955 # and # from start of comments to get comment text 2956 $new_comment =~ s/^\((.*)\)$/$1/; 2957 $new_comment =~ s/^\[(.*)\]$/$1/; 2958 $new_comment =~ s/^[\s\#]+|\s+$//g; 2959 2960 $new_comment = trim("$new_comment $cur_name") if ($cur_name ne $new_comment); 2961 $new_comment = " # $new_comment" if ($new_comment ne ""); 2962 my $new_email = "$email_address$new_comment"; 2963 2964 if (WARN("BAD_STABLE_ADDRESS_STYLE", 2965 "Invalid email format for stable: '$email', prefer '$new_email'\n" . $herecurr) && 2966 $fix) { 2967 $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/; 2968 } 2969 } 2970 } elsif ($comment ne "" && $comment !~ /^(?:#.+|\(.+\))$/) { 2971 my $new_comment = $comment; 2972 2973 # Extract comment text from within brackets or 2974 # c89 style /*...*/ comments 2975 $new_comment =~ s/^\[(.*)\]$/$1/; 2976 $new_comment =~ s/^\/\*(.*)\*\/$/$1/; 2977 2978 $new_comment = trim($new_comment); 2979 $new_comment =~ s/^[^\w]$//; # Single lettered comment with non word character is usually a typo 2980 $new_comment = "($new_comment)" if ($new_comment ne ""); 2981 my $new_email = format_email($email_name, $name_comment, $email_address, $new_comment); 2982 2983 if (WARN("BAD_SIGN_OFF", 2984 "Unexpected content after email: '$email', should be: '$new_email'\n" . $herecurr) && 2985 $fix) { 2986 $fixed[$fixlinenr] =~ s/\Q$email\E/$new_email/; 2987 } 2988 } 2989 } 2990 2991# Check for duplicate signatures 2992 my $sig_nospace = $line; 2993 $sig_nospace =~ s/\s//g; 2994 $sig_nospace = lc($sig_nospace); 2995 if (defined $signatures{$sig_nospace}) { 2996 WARN("BAD_SIGN_OFF", 2997 "Duplicate signature\n" . $herecurr); 2998 } else { 2999 $signatures{$sig_nospace} = 1; 3000 } 3001 3002# Check Co-developed-by: immediately followed by Signed-off-by: with same name and email 3003 if ($sign_off =~ /^co-developed-by:$/i) { 3004 if ($email eq $author) { 3005 WARN("BAD_SIGN_OFF", 3006 "Co-developed-by: should not be used to attribute nominal patch author '$author'\n" . "$here\n" . $rawline); 3007 } 3008 if (!defined $lines[$linenr]) { 3009 WARN("BAD_SIGN_OFF", 3010 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline); 3011 } elsif ($rawlines[$linenr] !~ /^\s*signed-off-by:\s*(.*)/i) { 3012 WARN("BAD_SIGN_OFF", 3013 "Co-developed-by: must be immediately followed by Signed-off-by:\n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 3014 } elsif ($1 ne $email) { 3015 WARN("BAD_SIGN_OFF", 3016 "Co-developed-by and Signed-off-by: name/email do not match \n" . "$here\n" . $rawline . "\n" .$rawlines[$linenr]); 3017 } 3018 } 3019 } 3020 3021# Check email subject for common tools that don't need to be mentioned 3022 if ($in_header_lines && 3023 $line =~ /^Subject:.*\b(?:checkpatch|sparse|smatch)\b[^:]/i) { 3024 WARN("EMAIL_SUBJECT", 3025 "A patch subject line should describe the change not the tool that found it\n" . $herecurr); 3026 } 3027 3028# Check for Gerrit Change-Ids not in any patch context 3029 if ($realfile eq '' && !$has_patch_separator && $line =~ /^\s*change-id:/i) { 3030 if (ERROR("GERRIT_CHANGE_ID", 3031 "Remove Gerrit Change-Id's before submitting upstream\n" . $herecurr) && 3032 $fix) { 3033 fix_delete_line($fixlinenr, $rawline); 3034 } 3035 } 3036 3037# Check if the commit log is in a possible stack dump 3038 if ($in_commit_log && !$commit_log_possible_stack_dump && 3039 ($line =~ /^\s*(?:WARNING:|BUG:)/ || 3040 $line =~ /^\s*\[\s*\d+\.\d{6,6}\s*\]/ || 3041 # timestamp 3042 $line =~ /^\s*\[\<[0-9a-fA-F]{8,}\>\]/) || 3043 $line =~ /^(?:\s+\w+:\s+[0-9a-fA-F]+){3,3}/ || 3044 $line =~ /^\s*\#\d+\s*\[[0-9a-fA-F]+\]\s*\w+ at [0-9a-fA-F]+/) { 3045 # stack dump address styles 3046 $commit_log_possible_stack_dump = 1; 3047 } 3048 3049# Check for line lengths > 75 in commit log, warn once 3050 if ($in_commit_log && !$commit_log_long_line && 3051 length($line) > 75 && 3052 !($line =~ /^\s*[a-zA-Z0-9_\/\.]+\s+\|\s+\d+/ || 3053 # file delta changes 3054 $line =~ /^\s*(?:[\w\.\-]+\/)++[\w\.\-]+:/ || 3055 # filename then : 3056 $line =~ /^\s*(?:Fixes:|Link:|$signature_tags)/i || 3057 # A Fixes: or Link: line or signature tag line 3058 $commit_log_possible_stack_dump)) { 3059 WARN("COMMIT_LOG_LONG_LINE", 3060 "Possible unwrapped commit description (prefer a maximum 75 chars per line)\n" . $herecurr); 3061 $commit_log_long_line = 1; 3062 } 3063 3064# Reset possible stack dump if a blank line is found 3065 if ($in_commit_log && $commit_log_possible_stack_dump && 3066 $line =~ /^\s*$/) { 3067 $commit_log_possible_stack_dump = 0; 3068 } 3069 3070# Check for lines starting with a # 3071 if ($in_commit_log && $line =~ /^#/) { 3072 if (WARN("COMMIT_COMMENT_SYMBOL", 3073 "Commit log lines starting with '#' are dropped by git as comments\n" . $herecurr) && 3074 $fix) { 3075 $fixed[$fixlinenr] =~ s/^/ /; 3076 } 3077 } 3078 3079# Check for git id commit length and improperly formed commit descriptions 3080 if ($in_commit_log && !$commit_log_possible_stack_dump && 3081 $line !~ /^\s*(?:Link|Patchwork|http|https|BugLink|base-commit):/i && 3082 $line !~ /^This reverts commit [0-9a-f]{7,40}/ && 3083 ($line =~ /\bcommit\s+[0-9a-f]{5,}\b/i || 3084 ($line =~ /(?:\s|^)[0-9a-f]{12,40}(?:[\s"'\(\[]|$)/i && 3085 $line !~ /[\<\[][0-9a-f]{12,40}[\>\]]/i && 3086 $line !~ /\bfixes:\s*[0-9a-f]{12,40}/i))) { 3087 my $init_char = "c"; 3088 my $orig_commit = ""; 3089 my $short = 1; 3090 my $long = 0; 3091 my $case = 1; 3092 my $space = 1; 3093 my $hasdesc = 0; 3094 my $hasparens = 0; 3095 my $id = '0123456789ab'; 3096 my $orig_desc = "commit description"; 3097 my $description = ""; 3098 3099 if ($line =~ /\b(c)ommit\s+([0-9a-f]{5,})\b/i) { 3100 $init_char = $1; 3101 $orig_commit = lc($2); 3102 } elsif ($line =~ /\b([0-9a-f]{12,40})\b/i) { 3103 $orig_commit = lc($1); 3104 } 3105 3106 $short = 0 if ($line =~ /\bcommit\s+[0-9a-f]{12,40}/i); 3107 $long = 1 if ($line =~ /\bcommit\s+[0-9a-f]{41,}/i); 3108 $space = 0 if ($line =~ /\bcommit [0-9a-f]/i); 3109 $case = 0 if ($line =~ /\b[Cc]ommit\s+[0-9a-f]{5,40}[^A-F]/); 3110 if ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)"\)/i) { 3111 $orig_desc = $1; 3112 $hasparens = 1; 3113 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s*$/i && 3114 defined $rawlines[$linenr] && 3115 $rawlines[$linenr] =~ /^\s*\("([^"]+)"\)/) { 3116 $orig_desc = $1; 3117 $hasparens = 1; 3118 } elsif ($line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("[^"]+$/i && 3119 defined $rawlines[$linenr] && 3120 $rawlines[$linenr] =~ /^\s*[^"]+"\)/) { 3121 $line =~ /\bcommit\s+[0-9a-f]{5,}\s+\("([^"]+)$/i; 3122 $orig_desc = $1; 3123 $rawlines[$linenr] =~ /^\s*([^"]+)"\)/; 3124 $orig_desc .= " " . $1; 3125 $hasparens = 1; 3126 } 3127 3128 ($id, $description) = git_commit_info($orig_commit, 3129 $id, $orig_desc); 3130 3131 if (defined($id) && 3132 ($short || $long || $space || $case || ($orig_desc ne $description) || !$hasparens)) { 3133 ERROR("GIT_COMMIT_ID", 3134 "Please use git commit description style 'commit <12+ chars of sha1> (\"<title line>\")' - ie: '${init_char}ommit $id (\"$description\")'\n" . $herecurr); 3135 } 3136 } 3137 3138# Check for added, moved or deleted files 3139 if (!$reported_maintainer_file && !$in_commit_log && 3140 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 3141 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 3142 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 3143 (defined($1) || defined($2))))) { 3144 $is_patch = 1; 3145 $reported_maintainer_file = 1; 3146 WARN("FILE_PATH_CHANGES", 3147 "added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 3148 } 3149 3150# Check for adding new DT bindings not in schema format 3151 if (!$in_commit_log && 3152 ($line =~ /^new file mode\s*\d+\s*$/) && 3153 ($realfile =~ m@^Documentation/devicetree/bindings/.*\.txt$@)) { 3154 WARN("DT_SCHEMA_BINDING_PATCH", 3155 "DT bindings should be in DT schema format. See: Documentation/devicetree/writing-schema.rst\n"); 3156 } 3157 3158# Check for wrappage within a valid hunk of the file 3159 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 3160 ERROR("CORRUPTED_PATCH", 3161 "patch seems to be corrupt (line wrapped?)\n" . 3162 $herecurr) if (!$emitted_corrupt++); 3163 } 3164 3165# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 3166 if (($realfile =~ /^$/ || $line =~ /^\+/) && 3167 $rawline !~ m/^$UTF8*$/) { 3168 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 3169 3170 my $blank = copy_spacing($rawline); 3171 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 3172 my $hereptr = "$hereline$ptr\n"; 3173 3174 CHK("INVALID_UTF8", 3175 "Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 3176 } 3177 3178# Check if it's the start of a commit log 3179# (not a header line and we haven't seen the patch filename) 3180 if ($in_header_lines && $realfile =~ /^$/ && 3181 !($rawline =~ /^\s+(?:\S|$)/ || 3182 $rawline =~ /^(?:commit\b|from\b|[\w-]+:)/i)) { 3183 $in_header_lines = 0; 3184 $in_commit_log = 1; 3185 $has_commit_log = 1; 3186 } 3187 3188# Check if there is UTF-8 in a commit log when a mail header has explicitly 3189# declined it, i.e defined some charset where it is missing. 3190 if ($in_header_lines && 3191 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 3192 $1 !~ /utf-8/i) { 3193 $non_utf8_charset = 1; 3194 } 3195 3196 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 3197 $rawline =~ /$NON_ASCII_UTF8/) { 3198 WARN("UTF8_BEFORE_PATCH", 3199 "8-bit UTF-8 used in possible commit log\n" . $herecurr); 3200 } 3201 3202# Check for absolute kernel paths in commit message 3203 if ($tree && $in_commit_log) { 3204 while ($line =~ m{(?:^|\s)(/\S*)}g) { 3205 my $file = $1; 3206 3207 if ($file =~ m{^(.*?)(?::\d+)+:?$} && 3208 check_absolute_file($1, $herecurr)) { 3209 # 3210 } else { 3211 check_absolute_file($file, $herecurr); 3212 } 3213 } 3214 } 3215 3216# Check for various typo / spelling mistakes 3217 if (defined($misspellings) && 3218 ($in_commit_log || $line =~ /^(?:\+|Subject:)/i)) { 3219 while ($rawline =~ /(?:^|[^\w\-'`])($misspellings)(?:[^\w\-'`]|$)/gi) { 3220 my $typo = $1; 3221 my $blank = copy_spacing($rawline); 3222 my $ptr = substr($blank, 0, $-[1]) . "^" x length($typo); 3223 my $hereptr = "$hereline$ptr\n"; 3224 my $typo_fix = $spelling_fix{lc($typo)}; 3225 $typo_fix = ucfirst($typo_fix) if ($typo =~ /^[A-Z]/); 3226 $typo_fix = uc($typo_fix) if ($typo =~ /^[A-Z]+$/); 3227 my $msg_level = \&WARN; 3228 $msg_level = \&CHK if ($file); 3229 if (&{$msg_level}("TYPO_SPELLING", 3230 "'$typo' may be misspelled - perhaps '$typo_fix'?\n" . $hereptr) && 3231 $fix) { 3232 $fixed[$fixlinenr] =~ s/(^|[^A-Za-z@])($typo)($|[^A-Za-z@])/$1$typo_fix$3/; 3233 } 3234 } 3235 } 3236 3237# check for invalid commit id 3238 if ($in_commit_log && $line =~ /(^fixes:|\bcommit)\s+([0-9a-f]{6,40})\b/i) { 3239 my $id; 3240 my $description; 3241 ($id, $description) = git_commit_info($2, undef, undef); 3242 if (!defined($id)) { 3243 WARN("UNKNOWN_COMMIT_ID", 3244 "Unknown commit id '$2', maybe rebased or not pulled?\n" . $herecurr); 3245 } 3246 } 3247 3248# check for repeated words separated by a single space 3249# avoid false positive from list command eg, '-rw-r--r-- 1 root root' 3250 if (($rawline =~ /^\+/ || $in_commit_log) && 3251 $rawline !~ /[bcCdDlMnpPs\?-][rwxsStT-]{9}/) { 3252 pos($rawline) = 1 if (!$in_commit_log); 3253 while ($rawline =~ /\b($word_pattern) (?=($word_pattern))/g) { 3254 3255 my $first = $1; 3256 my $second = $2; 3257 my $start_pos = $-[1]; 3258 my $end_pos = $+[2]; 3259 if ($first =~ /(?:struct|union|enum)/) { 3260 pos($rawline) += length($first) + length($second) + 1; 3261 next; 3262 } 3263 3264 next if (lc($first) ne lc($second)); 3265 next if ($first eq 'long'); 3266 3267 # check for character before and after the word matches 3268 my $start_char = ''; 3269 my $end_char = ''; 3270 $start_char = substr($rawline, $start_pos - 1, 1) if ($start_pos > ($in_commit_log ? 0 : 1)); 3271 $end_char = substr($rawline, $end_pos, 1) if ($end_pos < length($rawline)); 3272 3273 next if ($start_char =~ /^\S$/); 3274 next if (index(" \t.,;?!", $end_char) == -1); 3275 3276 # avoid repeating hex occurrences like 'ff ff fe 09 ...' 3277 if ($first =~ /\b[0-9a-f]{2,}\b/i) { 3278 next if (!exists($allow_repeated_words{lc($first)})); 3279 } 3280 3281 if (WARN("REPEATED_WORD", 3282 "Possible repeated word: '$first'\n" . $herecurr) && 3283 $fix) { 3284 $fixed[$fixlinenr] =~ s/\b$first $second\b/$first/; 3285 } 3286 } 3287 3288 # if it's a repeated word on consecutive lines in a comment block 3289 if ($prevline =~ /$;+\s*$/ && 3290 $prevrawline =~ /($word_pattern)\s*$/) { 3291 my $last_word = $1; 3292 if ($rawline =~ /^\+\s*\*\s*$last_word /) { 3293 if (WARN("REPEATED_WORD", 3294 "Possible repeated word: '$last_word'\n" . $hereprev) && 3295 $fix) { 3296 $fixed[$fixlinenr] =~ s/(\+\s*\*\s*)$last_word /$1/; 3297 } 3298 } 3299 } 3300 } 3301 3302# ignore non-hunk lines and lines being removed 3303 next if (!$hunk_line || $line =~ /^-/); 3304 3305#trailing whitespace 3306 if ($line =~ /^\+.*\015/) { 3307 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3308 if (ERROR("DOS_LINE_ENDINGS", 3309 "DOS line endings\n" . $herevet) && 3310 $fix) { 3311 $fixed[$fixlinenr] =~ s/[\s\015]+$//; 3312 } 3313 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 3314 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3315 if (ERROR("TRAILING_WHITESPACE", 3316 "trailing whitespace\n" . $herevet) && 3317 $fix) { 3318 $fixed[$fixlinenr] =~ s/\s+$//; 3319 } 3320 3321 $rpt_cleaners = 1; 3322 } 3323 3324# Check for FSF mailing addresses. 3325 if ($rawline =~ /\bwrite to the Free/i || 3326 $rawline =~ /\b675\s+Mass\s+Ave/i || 3327 $rawline =~ /\b59\s+Temple\s+Pl/i || 3328 $rawline =~ /\b51\s+Franklin\s+St/i) { 3329 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3330 my $msg_level = \&ERROR; 3331 $msg_level = \&CHK if ($file); 3332 &{$msg_level}("FSF_MAILING_ADDRESS", 3333 "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) 3334 } 3335 3336# check for Kconfig help text having a real description 3337# Only applies when adding the entry originally, after that we do not have 3338# sufficient context to determine whether it is indeed long enough. 3339 if ($realfile =~ /Kconfig/ && 3340 # 'choice' is usually the last thing on the line (though 3341 # Kconfig supports named choices), so use a word boundary 3342 # (\b) rather than a whitespace character (\s) 3343 $line =~ /^\+\s*(?:config|menuconfig|choice)\b/) { 3344 my $length = 0; 3345 my $cnt = $realcnt; 3346 my $ln = $linenr + 1; 3347 my $f; 3348 my $is_start = 0; 3349 my $is_end = 0; 3350 for (; $cnt > 0 && defined $lines[$ln - 1]; $ln++) { 3351 $f = $lines[$ln - 1]; 3352 $cnt-- if ($lines[$ln - 1] !~ /^-/); 3353 $is_end = $lines[$ln - 1] =~ /^\+/; 3354 3355 next if ($f =~ /^-/); 3356 last if (!$file && $f =~ /^\@\@/); 3357 3358 if ($lines[$ln - 1] =~ /^\+\s*(?:bool|tristate|prompt)\s*["']/) { 3359 $is_start = 1; 3360 } elsif ($lines[$ln - 1] =~ /^\+\s*(?:---)?help(?:---)?$/) { 3361 $length = -1; 3362 } 3363 3364 $f =~ s/^.//; 3365 $f =~ s/#.*//; 3366 $f =~ s/^\s+//; 3367 next if ($f =~ /^$/); 3368 3369 # This only checks context lines in the patch 3370 # and so hopefully shouldn't trigger false 3371 # positives, even though some of these are 3372 # common words in help texts 3373 if ($f =~ /^\s*(?:config|menuconfig|choice|endchoice| 3374 if|endif|menu|endmenu|source)\b/x) { 3375 $is_end = 1; 3376 last; 3377 } 3378 $length++; 3379 } 3380 if ($is_start && $is_end && $length < $min_conf_desc_length) { 3381 WARN("CONFIG_DESCRIPTION", 3382 "please write a paragraph that describes the config symbol fully\n" . $herecurr); 3383 } 3384 #print "is_start<$is_start> is_end<$is_end> length<$length>\n"; 3385 } 3386 3387# check MAINTAINERS entries 3388 if ($realfile =~ /^MAINTAINERS$/) { 3389# check MAINTAINERS entries for the right form 3390 if ($rawline =~ /^\+[A-Z]:/ && 3391 $rawline !~ /^\+[A-Z]:\t\S/) { 3392 if (WARN("MAINTAINERS_STYLE", 3393 "MAINTAINERS entries use one tab after TYPE:\n" . $herecurr) && 3394 $fix) { 3395 $fixed[$fixlinenr] =~ s/^(\+[A-Z]):\s*/$1:\t/; 3396 } 3397 } 3398# check MAINTAINERS entries for the right ordering too 3399 my $preferred_order = 'MRLSWQBCPTFXNK'; 3400 if ($rawline =~ /^\+[A-Z]:/ && 3401 $prevrawline =~ /^[\+ ][A-Z]:/) { 3402 $rawline =~ /^\+([A-Z]):\s*(.*)/; 3403 my $cur = $1; 3404 my $curval = $2; 3405 $prevrawline =~ /^[\+ ]([A-Z]):\s*(.*)/; 3406 my $prev = $1; 3407 my $prevval = $2; 3408 my $curindex = index($preferred_order, $cur); 3409 my $previndex = index($preferred_order, $prev); 3410 if ($curindex < 0) { 3411 WARN("MAINTAINERS_STYLE", 3412 "Unknown MAINTAINERS entry type: '$cur'\n" . $herecurr); 3413 } else { 3414 if ($previndex >= 0 && $curindex < $previndex) { 3415 WARN("MAINTAINERS_STYLE", 3416 "Misordered MAINTAINERS entry - list '$cur:' before '$prev:'\n" . $hereprev); 3417 } elsif ((($prev eq 'F' && $cur eq 'F') || 3418 ($prev eq 'X' && $cur eq 'X')) && 3419 ($prevval cmp $curval) > 0) { 3420 WARN("MAINTAINERS_STYLE", 3421 "Misordered MAINTAINERS entry - list file patterns in alphabetic order\n" . $hereprev); 3422 } 3423 } 3424 } 3425 } 3426 3427 if (($realfile =~ /Makefile.*/ || $realfile =~ /Kbuild.*/) && 3428 ($line =~ /\+(EXTRA_[A-Z]+FLAGS).*/)) { 3429 my $flag = $1; 3430 my $replacement = { 3431 'EXTRA_AFLAGS' => 'asflags-y', 3432 'EXTRA_CFLAGS' => 'ccflags-y', 3433 'EXTRA_CPPFLAGS' => 'cppflags-y', 3434 'EXTRA_LDFLAGS' => 'ldflags-y', 3435 }; 3436 3437 WARN("DEPRECATED_VARIABLE", 3438 "Use of $flag is deprecated, please use \`$replacement->{$flag} instead.\n" . $herecurr) if ($replacement->{$flag}); 3439 } 3440 3441# check for DT compatible documentation 3442 if (defined $root && 3443 (($realfile =~ /\.dtsi?$/ && $line =~ /^\+\s*compatible\s*=\s*\"/) || 3444 ($realfile =~ /\.[ch]$/ && $line =~ /^\+.*\.compatible\s*=\s*\"/))) { 3445 3446 my @compats = $rawline =~ /\"([a-zA-Z0-9\-\,\.\+_]+)\"/g; 3447 3448 my $dt_path = $root . "/Documentation/devicetree/bindings/"; 3449 my $vp_file = $dt_path . "vendor-prefixes.yaml"; 3450 3451 foreach my $compat (@compats) { 3452 my $compat2 = $compat; 3453 $compat2 =~ s/\,[a-zA-Z0-9]*\-/\,<\.\*>\-/; 3454 my $compat3 = $compat; 3455 $compat3 =~ s/\,([a-z]*)[0-9]*\-/\,$1<\.\*>\-/; 3456 `grep -Erq "$compat|$compat2|$compat3" $dt_path`; 3457 if ( $? >> 8 ) { 3458 WARN("UNDOCUMENTED_DT_STRING", 3459 "DT compatible string \"$compat\" appears un-documented -- check $dt_path\n" . $herecurr); 3460 } 3461 3462 next if $compat !~ /^([a-zA-Z0-9\-]+)\,/; 3463 my $vendor = $1; 3464 `grep -Eq "\\"\\^\Q$vendor\E,\\.\\*\\":" $vp_file`; 3465 if ( $? >> 8 ) { 3466 WARN("UNDOCUMENTED_DT_STRING", 3467 "DT compatible string vendor \"$vendor\" appears un-documented -- check $vp_file\n" . $herecurr); 3468 } 3469 } 3470 } 3471 3472# check for using SPDX license tag at beginning of files 3473 if ($realline == $checklicenseline) { 3474 if ($rawline =~ /^[ \+]\s*\#\!\s*\//) { 3475 $checklicenseline = 2; 3476 } elsif ($rawline =~ /^\+/) { 3477 my $comment = ""; 3478 if ($realfile =~ /\.(h|s|S)$/) { 3479 $comment = '/*'; 3480 } elsif ($realfile =~ /\.(c|dts|dtsi)$/) { 3481 $comment = '//'; 3482 } elsif (($checklicenseline == 2) || $realfile =~ /\.(sh|pl|py|awk|tc|yaml)$/) { 3483 $comment = '#'; 3484 } elsif ($realfile =~ /\.rst$/) { 3485 $comment = '..'; 3486 } 3487 3488# check SPDX comment style for .[chsS] files 3489 if ($realfile =~ /\.[chsS]$/ && 3490 $rawline =~ /SPDX-License-Identifier:/ && 3491 $rawline !~ m@^\+\s*\Q$comment\E\s*@) { 3492 WARN("SPDX_LICENSE_TAG", 3493 "Improper SPDX comment style for '$realfile', please use '$comment' instead\n" . $herecurr); 3494 } 3495 3496 if ($comment !~ /^$/ && 3497 $rawline !~ m@^\+\Q$comment\E SPDX-License-Identifier: @) { 3498 WARN("SPDX_LICENSE_TAG", 3499 "Missing or malformed SPDX-License-Identifier tag in line $checklicenseline\n" . $herecurr); 3500 } elsif ($rawline =~ /(SPDX-License-Identifier: .*)/) { 3501 my $spdx_license = $1; 3502 if (!is_SPDX_License_valid($spdx_license)) { 3503 WARN("SPDX_LICENSE_TAG", 3504 "'$spdx_license' is not supported in LICENSES/...\n" . $herecurr); 3505 } 3506 if ($realfile =~ m@^Documentation/devicetree/bindings/@ && 3507 not $spdx_license =~ /GPL-2\.0.*BSD-2-Clause/) { 3508 my $msg_level = \&WARN; 3509 $msg_level = \&CHK if ($file); 3510 if (&{$msg_level}("SPDX_LICENSE_TAG", 3511 3512 "DT binding documents should be licensed (GPL-2.0-only OR BSD-2-Clause)\n" . $herecurr) && 3513 $fix) { 3514 $fixed[$fixlinenr] =~ s/SPDX-License-Identifier: .*/SPDX-License-Identifier: (GPL-2.0-only OR BSD-2-Clause)/; 3515 } 3516 } 3517 } 3518 } 3519 } 3520 3521# check for embedded filenames 3522 if ($rawline =~ /^\+.*\Q$realfile\E/) { 3523 WARN("EMBEDDED_FILENAME", 3524 "It's generally not useful to have the filename in the file\n" . $herecurr); 3525 } 3526 3527# check we are in a valid source file if not then ignore this hunk 3528 next if ($realfile !~ /\.(h|c|s|S|sh|dtsi|dts)$/); 3529 3530# check for using SPDX-License-Identifier on the wrong line number 3531 if ($realline != $checklicenseline && 3532 $rawline =~ /\bSPDX-License-Identifier:/ && 3533 substr($line, @-, @+ - @-) eq "$;" x (@+ - @-)) { 3534 WARN("SPDX_LICENSE_TAG", 3535 "Misplaced SPDX-License-Identifier tag - use line $checklicenseline instead\n" . $herecurr); 3536 } 3537 3538# line length limit (with some exclusions) 3539# 3540# There are a few types of lines that may extend beyond $max_line_length: 3541# logging functions like pr_info that end in a string 3542# lines with a single string 3543# #defines that are a single string 3544# lines with an RFC3986 like URL 3545# 3546# There are 3 different line length message types: 3547# LONG_LINE_COMMENT a comment starts before but extends beyond $max_line_length 3548# LONG_LINE_STRING a string starts before but extends beyond $max_line_length 3549# LONG_LINE all other lines longer than $max_line_length 3550# 3551# if LONG_LINE is ignored, the other 2 types are also ignored 3552# 3553 3554 if ($line =~ /^\+/ && $length > $max_line_length) { 3555 my $msg_type = "LONG_LINE"; 3556 3557 # Check the allowed long line types first 3558 3559 # logging functions that end in a string that starts 3560 # before $max_line_length 3561 if ($line =~ /^\+\s*$logFunctions\s*\(\s*(?:(?:KERN_\S+\s*|[^"]*))?($String\s*(?:|,|\)\s*;)\s*)$/ && 3562 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 3563 $msg_type = ""; 3564 3565 # lines with only strings (w/ possible termination) 3566 # #defines with only strings 3567 } elsif ($line =~ /^\+\s*$String\s*(?:\s*|,|\)\s*;)\s*$/ || 3568 $line =~ /^\+\s*#\s*define\s+\w+\s+$String$/) { 3569 $msg_type = ""; 3570 3571 # More special cases 3572 } elsif ($line =~ /^\+.*\bEFI_GUID\s*\(/ || 3573 $line =~ /^\+\s*(?:\w+)?\s*DEFINE_PER_CPU/) { 3574 $msg_type = ""; 3575 3576 # URL ($rawline is used in case the URL is in a comment) 3577 } elsif ($rawline =~ /^\+.*\b[a-z][\w\.\+\-]*:\/\/\S+/i) { 3578 $msg_type = ""; 3579 3580 # Otherwise set the alternate message types 3581 3582 # a comment starts before $max_line_length 3583 } elsif ($line =~ /($;[\s$;]*)$/ && 3584 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 3585 $msg_type = "LONG_LINE_COMMENT" 3586 3587 # a quoted string starts before $max_line_length 3588 } elsif ($sline =~ /\s*($String(?:\s*(?:\\|,\s*|\)\s*;\s*))?)$/ && 3589 length(expand_tabs(substr($line, 1, length($line) - length($1) - 1))) <= $max_line_length) { 3590 $msg_type = "LONG_LINE_STRING" 3591 } 3592 3593 if ($msg_type ne "" && 3594 (show_type("LONG_LINE") || show_type($msg_type))) { 3595 my $msg_level = \&WARN; 3596 $msg_level = \&CHK if ($file); 3597 &{$msg_level}($msg_type, 3598 "line length of $length exceeds $max_line_length columns\n" . $herecurr); 3599 } 3600 } 3601 3602# check for adding lines without a newline. 3603 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 3604 if (WARN("MISSING_EOF_NEWLINE", 3605 "adding a line without newline at end of file\n" . $herecurr) && 3606 $fix) { 3607 fix_delete_line($fixlinenr+1, "No newline at end of file"); 3608 } 3609 } 3610 3611# check for .L prefix local symbols in .S files 3612 if ($realfile =~ /\.S$/ && 3613 $line =~ /^\+\s*(?:[A-Z]+_)?SYM_[A-Z]+_(?:START|END)(?:_[A-Z_]+)?\s*\(\s*\.L/) { 3614 WARN("AVOID_L_PREFIX", 3615 "Avoid using '.L' prefixed local symbol names for denoting a range of code via 'SYM_*_START/END' annotations; see Documentation/asm-annotations.rst\n" . $herecurr); 3616 } 3617 3618# check we are in a valid source file C or perl if not then ignore this hunk 3619 next if ($realfile !~ /\.(h|c|pl|dtsi|dts)$/); 3620 3621# at the beginning of a line any tabs must come first and anything 3622# more than $tabsize must use tabs. 3623 if ($rawline =~ /^\+\s* \t\s*\S/ || 3624 $rawline =~ /^\+\s* \s*/) { 3625 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3626 $rpt_cleaners = 1; 3627 if (ERROR("CODE_INDENT", 3628 "code indent should use tabs where possible\n" . $herevet) && 3629 $fix) { 3630 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 3631 } 3632 } 3633 3634# check for space before tabs. 3635 if ($rawline =~ /^\+/ && $rawline =~ / \t/) { 3636 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3637 if (WARN("SPACE_BEFORE_TAB", 3638 "please, no space before tabs\n" . $herevet) && 3639 $fix) { 3640 while ($fixed[$fixlinenr] =~ 3641 s/(^\+.*) {$tabsize,$tabsize}\t/$1\t\t/) {} 3642 while ($fixed[$fixlinenr] =~ 3643 s/(^\+.*) +\t/$1\t/) {} 3644 } 3645 } 3646 3647# check for assignments on the start of a line 3648 if ($sline =~ /^\+\s+($Assignment)[^=]/) { 3649 my $operator = $1; 3650 if (CHK("ASSIGNMENT_CONTINUATIONS", 3651 "Assignment operator '$1' should be on the previous line\n" . $hereprev) && 3652 $fix && $prevrawline =~ /^\+/) { 3653 # add assignment operator to the previous line, remove from current line 3654 $fixed[$fixlinenr - 1] .= " $operator"; 3655 $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//; 3656 } 3657 } 3658 3659# check for && or || at the start of a line 3660 if ($rawline =~ /^\+\s*(&&|\|\|)/) { 3661 my $operator = $1; 3662 if (CHK("LOGICAL_CONTINUATIONS", 3663 "Logical continuations should be on the previous line\n" . $hereprev) && 3664 $fix && $prevrawline =~ /^\+/) { 3665 # insert logical operator at last non-comment, non-whitepsace char on previous line 3666 $prevline =~ /[\s$;]*$/; 3667 my $line_end = substr($prevrawline, $-[0]); 3668 $fixed[$fixlinenr - 1] =~ s/\Q$line_end\E$/ $operator$line_end/; 3669 $fixed[$fixlinenr] =~ s/\Q$operator\E\s*//; 3670 } 3671 } 3672 3673# check indentation starts on a tab stop 3674 if ($perl_version_ok && 3675 $sline =~ /^\+\t+( +)(?:$c90_Keywords\b|\{\s*$|\}\s*(?:else\b|while\b|\s*$)|$Declare\s*$Ident\s*[;=])/) { 3676 my $indent = length($1); 3677 if ($indent % $tabsize) { 3678 if (WARN("TABSTOP", 3679 "Statements should start on a tabstop\n" . $herecurr) && 3680 $fix) { 3681 $fixed[$fixlinenr] =~ s@(^\+\t+) +@$1 . "\t" x ($indent/$tabsize)@e; 3682 } 3683 } 3684 } 3685 3686# check multi-line statement indentation matches previous line 3687 if ($perl_version_ok && 3688 $prevline =~ /^\+([ \t]*)((?:$c90_Keywords(?:\s+if)\s*)|(?:$Declare\s*)?(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*|(?:\*\s*)*$Lval\s*=\s*$Ident\s*)\(.*(\&\&|\|\||,)\s*$/) { 3689 $prevline =~ /^\+(\t*)(.*)$/; 3690 my $oldindent = $1; 3691 my $rest = $2; 3692 3693 my $pos = pos_last_openparen($rest); 3694 if ($pos >= 0) { 3695 $line =~ /^(\+| )([ \t]*)/; 3696 my $newindent = $2; 3697 3698 my $goodtabindent = $oldindent . 3699 "\t" x ($pos / $tabsize) . 3700 " " x ($pos % $tabsize); 3701 my $goodspaceindent = $oldindent . " " x $pos; 3702 3703 if ($newindent ne $goodtabindent && 3704 $newindent ne $goodspaceindent) { 3705 3706 if (CHK("PARENTHESIS_ALIGNMENT", 3707 "Alignment should match open parenthesis\n" . $hereprev) && 3708 $fix && $line =~ /^\+/) { 3709 $fixed[$fixlinenr] =~ 3710 s/^\+[ \t]*/\+$goodtabindent/; 3711 } 3712 } 3713 } 3714 } 3715 3716# check for space after cast like "(int) foo" or "(struct foo) bar" 3717# avoid checking a few false positives: 3718# "sizeof(<type>)" or "__alignof__(<type>)" 3719# function pointer declarations like "(*foo)(int) = bar;" 3720# structure definitions like "(struct foo) { 0 };" 3721# multiline macros that define functions 3722# known attributes or the __attribute__ keyword 3723 if ($line =~ /^\+(.*)\(\s*$Type\s*\)([ \t]++)((?![={]|\\$|$Attribute|__attribute__))/ && 3724 (!defined($1) || $1 !~ /\b(?:sizeof|__alignof__)\s*$/)) { 3725 if (CHK("SPACING", 3726 "No space is necessary after a cast\n" . $herecurr) && 3727 $fix) { 3728 $fixed[$fixlinenr] =~ 3729 s/(\(\s*$Type\s*\))[ \t]+/$1/; 3730 } 3731 } 3732 3733# Block comment styles 3734# Networking with an initial /* 3735 if ($realfile =~ m@^(drivers/net/|net/)@ && 3736 $prevrawline =~ /^\+[ \t]*\/\*[ \t]*$/ && 3737 $rawline =~ /^\+[ \t]*\*/ && 3738 $realline > 3) { # Do not warn about the initial copyright comment block after SPDX-License-Identifier 3739 WARN("NETWORKING_BLOCK_COMMENT_STYLE", 3740 "networking block comments don't use an empty /* line, use /* Comment...\n" . $hereprev); 3741 } 3742 3743# Block comments use * on subsequent lines 3744 if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3745 $prevrawline =~ /^\+.*?\/\*/ && #starting /* 3746 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 3747 $rawline =~ /^\+/ && #line is new 3748 $rawline !~ /^\+[ \t]*\*/) { #no leading * 3749 WARN("BLOCK_COMMENT_STYLE", 3750 "Block comments use * on subsequent lines\n" . $hereprev); 3751 } 3752 3753# Block comments use */ on trailing lines 3754 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 3755 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 3756 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 3757 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 3758 WARN("BLOCK_COMMENT_STYLE", 3759 "Block comments use a trailing */ on a separate line\n" . $herecurr); 3760 } 3761 3762# Block comment * alignment 3763 if ($prevline =~ /$;[ \t]*$/ && #ends in comment 3764 $line =~ /^\+[ \t]*$;/ && #leading comment 3765 $rawline =~ /^\+[ \t]*\*/ && #leading * 3766 (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 3767 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 3768 $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 3769 my $oldindent; 3770 $prevrawline =~ m@^\+([ \t]*/?)\*@; 3771 if (defined($1)) { 3772 $oldindent = expand_tabs($1); 3773 } else { 3774 $prevrawline =~ m@^\+(.*/?)\*@; 3775 $oldindent = expand_tabs($1); 3776 } 3777 $rawline =~ m@^\+([ \t]*)\*@; 3778 my $newindent = $1; 3779 $newindent = expand_tabs($newindent); 3780 if (length($oldindent) ne length($newindent)) { 3781 WARN("BLOCK_COMMENT_STYLE", 3782 "Block comments should align the * on each line\n" . $hereprev); 3783 } 3784 } 3785 3786# check for missing blank lines after struct/union declarations 3787# with exceptions for various attributes and macros 3788 if ($prevline =~ /^[\+ ]};?\s*$/ && 3789 $line =~ /^\+/ && 3790 !($line =~ /^\+\s*$/ || 3791 $line =~ /^\+\s*EXPORT_SYMBOL/ || 3792 $line =~ /^\+\s*MODULE_/i || 3793 $line =~ /^\+\s*\#\s*(?:end|elif|else)/ || 3794 $line =~ /^\+[a-z_]*init/ || 3795 $line =~ /^\+\s*(?:static\s+)?[A-Z_]*ATTR/ || 3796 $line =~ /^\+\s*DECLARE/ || 3797 $line =~ /^\+\s*builtin_[\w_]*driver/ || 3798 $line =~ /^\+\s*__setup/)) { 3799 if (CHK("LINE_SPACING", 3800 "Please use a blank line after function/struct/union/enum declarations\n" . $hereprev) && 3801 $fix) { 3802 fix_insert_line($fixlinenr, "\+"); 3803 } 3804 } 3805 3806# check for multiple consecutive blank lines 3807 if ($prevline =~ /^[\+ ]\s*$/ && 3808 $line =~ /^\+\s*$/ && 3809 $last_blank_line != ($linenr - 1)) { 3810 if (CHK("LINE_SPACING", 3811 "Please don't use multiple blank lines\n" . $hereprev) && 3812 $fix) { 3813 fix_delete_line($fixlinenr, $rawline); 3814 } 3815 3816 $last_blank_line = $linenr; 3817 } 3818 3819# check for missing blank lines after declarations 3820# (declarations must have the same indentation and not be at the start of line) 3821 if (($prevline =~ /\+(\s+)\S/) && $sline =~ /^\+$1\S/) { 3822 # use temporaries 3823 my $sl = $sline; 3824 my $pl = $prevline; 3825 # remove $Attribute/$Sparse uses to simplify comparisons 3826 $sl =~ s/\b(?:$Attribute|$Sparse)\b//g; 3827 $pl =~ s/\b(?:$Attribute|$Sparse)\b//g; 3828 if (($pl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 3829 # function pointer declarations 3830 $pl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 3831 # foo bar; where foo is some local typedef or #define 3832 $pl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 3833 # known declaration macros 3834 $pl =~ /^\+\s+$declaration_macros/) && 3835 # for "else if" which can look like "$Ident $Ident" 3836 !($pl =~ /^\+\s+$c90_Keywords\b/ || 3837 # other possible extensions of declaration lines 3838 $pl =~ /(?:$Compare|$Assignment|$Operators)\s*$/ || 3839 # not starting a section or a macro "\" extended line 3840 $pl =~ /(?:\{\s*|\\)$/) && 3841 # looks like a declaration 3842 !($sl =~ /^\+\s+$Declare\s*$Ident\s*[=,;:\[]/ || 3843 # function pointer declarations 3844 $sl =~ /^\+\s+$Declare\s*\(\s*\*\s*$Ident\s*\)\s*[=,;:\[\(]/ || 3845 # foo bar; where foo is some local typedef or #define 3846 $sl =~ /^\+\s+$Ident(?:\s+|\s*\*\s*)$Ident\s*[=,;\[]/ || 3847 # known declaration macros 3848 $sl =~ /^\+\s+$declaration_macros/ || 3849 # start of struct or union or enum 3850 $sl =~ /^\+\s+(?:static\s+)?(?:const\s+)?(?:union|struct|enum|typedef)\b/ || 3851 # start or end of block or continuation of declaration 3852 $sl =~ /^\+\s+(?:$|[\{\}\.\#\"\?\:\(\[])/ || 3853 # bitfield continuation 3854 $sl =~ /^\+\s+$Ident\s*:\s*\d+\s*[,;]/ || 3855 # other possible extensions of declaration lines 3856 $sl =~ /^\+\s+\(?\s*(?:$Compare|$Assignment|$Operators)/)) { 3857 if (WARN("LINE_SPACING", 3858 "Missing a blank line after declarations\n" . $hereprev) && 3859 $fix) { 3860 fix_insert_line($fixlinenr, "\+"); 3861 } 3862 } 3863 } 3864 3865# check for spaces at the beginning of a line. 3866# Exceptions: 3867# 1) within comments 3868# 2) indented preprocessor commands 3869# 3) hanging labels 3870 if ($rawline =~ /^\+ / && $line !~ /^\+ *(?:$;|#|$Ident:)/) { 3871 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 3872 if (WARN("LEADING_SPACE", 3873 "please, no spaces at the start of a line\n" . $herevet) && 3874 $fix) { 3875 $fixed[$fixlinenr] =~ s/^\+([ \t]+)/"\+" . tabify($1)/e; 3876 } 3877 } 3878 3879# check we are in a valid C source file if not then ignore this hunk 3880 next if ($realfile !~ /\.(h|c)$/); 3881 3882# check for unusual line ending [ or ( 3883 if ($line =~ /^\+.*([\[\(])\s*$/) { 3884 CHK("OPEN_ENDED_LINE", 3885 "Lines should not end with a '$1'\n" . $herecurr); 3886 } 3887 3888# check if this appears to be the start function declaration, save the name 3889 if ($sline =~ /^\+\{\s*$/ && 3890 $prevline =~ /^\+(?:(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*)?($Ident)\(/) { 3891 $context_function = $1; 3892 } 3893 3894# check if this appears to be the end of function declaration 3895 if ($sline =~ /^\+\}\s*$/) { 3896 undef $context_function; 3897 } 3898 3899# check indentation of any line with a bare else 3900# (but not if it is a multiple line "if (foo) return bar; else return baz;") 3901# if the previous line is a break or return and is indented 1 tab more... 3902 if ($sline =~ /^\+([\t]+)(?:}[ \t]*)?else(?:[ \t]*{)?\s*$/) { 3903 my $tabs = length($1) + 1; 3904 if ($prevline =~ /^\+\t{$tabs,$tabs}break\b/ || 3905 ($prevline =~ /^\+\t{$tabs,$tabs}return\b/ && 3906 defined $lines[$linenr] && 3907 $lines[$linenr] !~ /^[ \+]\t{$tabs,$tabs}return/)) { 3908 WARN("UNNECESSARY_ELSE", 3909 "else is not generally useful after a break or return\n" . $hereprev); 3910 } 3911 } 3912 3913# check indentation of a line with a break; 3914# if the previous line is a goto, return or break 3915# and is indented the same # of tabs 3916 if ($sline =~ /^\+([\t]+)break\s*;\s*$/) { 3917 my $tabs = $1; 3918 if ($prevline =~ /^\+$tabs(goto|return|break)\b/) { 3919 if (WARN("UNNECESSARY_BREAK", 3920 "break is not useful after a $1\n" . $hereprev) && 3921 $fix) { 3922 fix_delete_line($fixlinenr, $rawline); 3923 } 3924 } 3925 } 3926 3927# check for RCS/CVS revision markers 3928 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|)/) { 3929 WARN("CVS_KEYWORD", 3930 "CVS style keyword markers, these will _not_ be updated\n". $herecurr); 3931 } 3932 3933# check for old HOTPLUG __dev<foo> section markings 3934 if ($line =~ /\b(__dev(init|exit)(data|const|))\b/) { 3935 WARN("HOTPLUG_SECTION", 3936 "Using $1 is unnecessary\n" . $herecurr); 3937 } 3938 3939# Check for potential 'bare' types 3940 my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 3941 $realline_next); 3942#print "LINE<$line>\n"; 3943 if ($linenr > $suppress_statement && 3944 $realcnt && $sline =~ /.\s*\S/) { 3945 ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 3946 ctx_statement_block($linenr, $realcnt, 0); 3947 $stat =~ s/\n./\n /g; 3948 $cond =~ s/\n./\n /g; 3949 3950#print "linenr<$linenr> <$stat>\n"; 3951 # If this statement has no statement boundaries within 3952 # it there is no point in retrying a statement scan 3953 # until we hit end of it. 3954 my $frag = $stat; $frag =~ s/;+\s*$//; 3955 if ($frag !~ /(?:{|;)/) { 3956#print "skip<$line_nr_next>\n"; 3957 $suppress_statement = $line_nr_next; 3958 } 3959 3960 # Find the real next line. 3961 $realline_next = $line_nr_next; 3962 if (defined $realline_next && 3963 (!defined $lines[$realline_next - 1] || 3964 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 3965 $realline_next++; 3966 } 3967 3968 my $s = $stat; 3969 $s =~ s/{.*$//s; 3970 3971 # Ignore goto labels. 3972 if ($s =~ /$Ident:\*$/s) { 3973 3974 # Ignore functions being called 3975 } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 3976 3977 } elsif ($s =~ /^.\s*else\b/s) { 3978 3979 # declarations always start with types 3980 } 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) { 3981 my $type = $1; 3982 $type =~ s/\s+/ /g; 3983 possible($type, "A:" . $s); 3984 3985 # definitions in global scope can only start with types 3986 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 3987 possible($1, "B:" . $s); 3988 } 3989 3990 # any (foo ... *) is a pointer cast, and foo is a type 3991 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 3992 possible($1, "C:" . $s); 3993 } 3994 3995 # Check for any sort of function declaration. 3996 # int foo(something bar, other baz); 3997 # void (*store_gdt)(x86_descr_ptr *); 3998 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 3999 my ($name_len) = length($1); 4000 4001 my $ctx = $s; 4002 substr($ctx, 0, $name_len + 1, ''); 4003 $ctx =~ s/\)[^\)]*$//; 4004 4005 for my $arg (split(/\s*,\s*/, $ctx)) { 4006 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 4007 4008 possible($1, "D:" . $s); 4009 } 4010 } 4011 } 4012 4013 } 4014 4015# 4016# Checks which may be anchored in the context. 4017# 4018 4019# Check for switch () and associated case and default 4020# statements should be at the same indent. 4021 if ($line=~/\bswitch\s*\(.*\)/) { 4022 my $err = ''; 4023 my $sep = ''; 4024 my @ctx = ctx_block_outer($linenr, $realcnt); 4025 shift(@ctx); 4026 for my $ctx (@ctx) { 4027 my ($clen, $cindent) = line_stats($ctx); 4028 if ($ctx =~ /^\+\s*(case\s+|default:)/ && 4029 $indent != $cindent) { 4030 $err .= "$sep$ctx\n"; 4031 $sep = ''; 4032 } else { 4033 $sep = "[...]\n"; 4034 } 4035 } 4036 if ($err ne '') { 4037 ERROR("SWITCH_CASE_INDENT_LEVEL", 4038 "switch and case should be at the same indent\n$hereline$err"); 4039 } 4040 } 4041 4042# if/while/etc brace do not go on next line, unless defining a do while loop, 4043# or if that brace on the next line is for something else 4044 if ($line =~ /(.*)\b((?:if|while|for|switch|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 4045 my $pre_ctx = "$1$2"; 4046 4047 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 4048 4049 if ($line =~ /^\+\t{6,}/) { 4050 WARN("DEEP_INDENTATION", 4051 "Too many leading tabs - consider code refactoring\n" . $herecurr); 4052 } 4053 4054 my $ctx_cnt = $realcnt - $#ctx - 1; 4055 my $ctx = join("\n", @ctx); 4056 4057 my $ctx_ln = $linenr; 4058 my $ctx_skip = $realcnt; 4059 4060 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 4061 defined $lines[$ctx_ln - 1] && 4062 $lines[$ctx_ln - 1] =~ /^-/)) { 4063 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 4064 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 4065 $ctx_ln++; 4066 } 4067 4068 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 4069 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 4070 4071 if ($ctx !~ /{\s*/ && defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*{/) { 4072 ERROR("OPEN_BRACE", 4073 "that open brace { should be on the previous line\n" . 4074 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 4075 } 4076 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 4077 $ctx =~ /\)\s*\;\s*$/ && 4078 defined $lines[$ctx_ln - 1]) 4079 { 4080 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 4081 if ($nindent > $indent) { 4082 WARN("TRAILING_SEMICOLON", 4083 "trailing semicolon indicates no statements, indent implies otherwise\n" . 4084 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 4085 } 4086 } 4087 } 4088 4089# Check relative indent for conditionals and blocks. 4090 if ($line =~ /\b(?:(?:if|while|for|(?:[a-z_]+|)for_each[a-z_]+)\s*\(|(?:do|else)\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 4091 ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 4092 ctx_statement_block($linenr, $realcnt, 0) 4093 if (!defined $stat); 4094 my ($s, $c) = ($stat, $cond); 4095 4096 substr($s, 0, length($c), ''); 4097 4098 # remove inline comments 4099 $s =~ s/$;/ /g; 4100 $c =~ s/$;/ /g; 4101 4102 # Find out how long the conditional actually is. 4103 my @newlines = ($c =~ /\n/gs); 4104 my $cond_lines = 1 + $#newlines; 4105 4106 # Make sure we remove the line prefixes as we have 4107 # none on the first line, and are going to readd them 4108 # where necessary. 4109 $s =~ s/\n./\n/gs; 4110 while ($s =~ /\n\s+\\\n/) { 4111 $cond_lines += $s =~ s/\n\s+\\\n/\n/g; 4112 } 4113 4114 # We want to check the first line inside the block 4115 # starting at the end of the conditional, so remove: 4116 # 1) any blank line termination 4117 # 2) any opening brace { on end of the line 4118 # 3) any do (...) { 4119 my $continuation = 0; 4120 my $check = 0; 4121 $s =~ s/^.*\bdo\b//; 4122 $s =~ s/^\s*{//; 4123 if ($s =~ s/^\s*\\//) { 4124 $continuation = 1; 4125 } 4126 if ($s =~ s/^\s*?\n//) { 4127 $check = 1; 4128 $cond_lines++; 4129 } 4130 4131 # Also ignore a loop construct at the end of a 4132 # preprocessor statement. 4133 if (($prevline =~ /^.\s*#\s*define\s/ || 4134 $prevline =~ /\\\s*$/) && $continuation == 0) { 4135 $check = 0; 4136 } 4137 4138 my $cond_ptr = -1; 4139 $continuation = 0; 4140 while ($cond_ptr != $cond_lines) { 4141 $cond_ptr = $cond_lines; 4142 4143 # If we see an #else/#elif then the code 4144 # is not linear. 4145 if ($s =~ /^\s*\#\s*(?:else|elif)/) { 4146 $check = 0; 4147 } 4148 4149 # Ignore: 4150 # 1) blank lines, they should be at 0, 4151 # 2) preprocessor lines, and 4152 # 3) labels. 4153 if ($continuation || 4154 $s =~ /^\s*?\n/ || 4155 $s =~ /^\s*#\s*?/ || 4156 $s =~ /^\s*$Ident\s*:/) { 4157 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 4158 if ($s =~ s/^.*?\n//) { 4159 $cond_lines++; 4160 } 4161 } 4162 } 4163 4164 my (undef, $sindent) = line_stats("+" . $s); 4165 my $stat_real = raw_line($linenr, $cond_lines); 4166 4167 # Check if either of these lines are modified, else 4168 # this is not this patch's fault. 4169 if (!defined($stat_real) || 4170 $stat !~ /^\+/ && $stat_real !~ /^\+/) { 4171 $check = 0; 4172 } 4173 if (defined($stat_real) && $cond_lines > 1) { 4174 $stat_real = "[...]\n$stat_real"; 4175 } 4176 4177 #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"; 4178 4179 if ($check && $s ne '' && 4180 (($sindent % $tabsize) != 0 || 4181 ($sindent < $indent) || 4182 ($sindent == $indent && 4183 ($s !~ /^\s*(?:\}|\{|else\b)/)) || 4184 ($sindent > $indent + $tabsize))) { 4185 WARN("SUSPECT_CODE_INDENT", 4186 "suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 4187 } 4188 } 4189 4190 # Track the 'values' across context and added lines. 4191 my $opline = $line; $opline =~ s/^./ /; 4192 my ($curr_values, $curr_vars) = 4193 annotate_values($opline . "\n", $prev_values); 4194 $curr_values = $prev_values . $curr_values; 4195 if ($dbg_values) { 4196 my $outline = $opline; $outline =~ s/\t/ /g; 4197 print "$linenr > .$outline\n"; 4198 print "$linenr > $curr_values\n"; 4199 print "$linenr > $curr_vars\n"; 4200 } 4201 $prev_values = substr($curr_values, -1); 4202 4203#ignore lines not being added 4204 next if ($line =~ /^[^\+]/); 4205 4206# check for self assignments used to avoid compiler warnings 4207# e.g.: int foo = foo, *bar = NULL; 4208# struct foo bar = *(&(bar)); 4209 if ($line =~ /^\+\s*(?:$Declare)?([A-Za-z_][A-Za-z\d_]*)\s*=/) { 4210 my $var = $1; 4211 if ($line =~ /^\+\s*(?:$Declare)?$var\s*=\s*(?:$var|\*\s*\(?\s*&\s*\(?\s*$var\s*\)?\s*\)?)\s*[;,]/) { 4212 WARN("SELF_ASSIGNMENT", 4213 "Do not use self-assignments to avoid compiler warnings\n" . $herecurr); 4214 } 4215 } 4216 4217# check for dereferences that span multiple lines 4218 if ($prevline =~ /^\+.*$Lval\s*(?:\.|->)\s*$/ && 4219 $line =~ /^\+\s*(?!\#\s*(?!define\s+|if))\s*$Lval/) { 4220 $prevline =~ /($Lval\s*(?:\.|->))\s*$/; 4221 my $ref = $1; 4222 $line =~ /^.\s*($Lval)/; 4223 $ref .= $1; 4224 $ref =~ s/\s//g; 4225 WARN("MULTILINE_DEREFERENCE", 4226 "Avoid multiple line dereference - prefer '$ref'\n" . $hereprev); 4227 } 4228 4229# check for declarations of signed or unsigned without int 4230 while ($line =~ m{\b($Declare)\s*(?!char\b|short\b|int\b|long\b)\s*($Ident)?\s*[=,;\[\)\(]}g) { 4231 my $type = $1; 4232 my $var = $2; 4233 $var = "" if (!defined $var); 4234 if ($type =~ /^(?:(?:$Storage|$Inline|$Attribute)\s+)*((?:un)?signed)((?:\s*\*)*)\s*$/) { 4235 my $sign = $1; 4236 my $pointer = $2; 4237 4238 $pointer = "" if (!defined $pointer); 4239 4240 if (WARN("UNSPECIFIED_INT", 4241 "Prefer '" . trim($sign) . " int" . rtrim($pointer) . "' to bare use of '$sign" . rtrim($pointer) . "'\n" . $herecurr) && 4242 $fix) { 4243 my $decl = trim($sign) . " int "; 4244 my $comp_pointer = $pointer; 4245 $comp_pointer =~ s/\s//g; 4246 $decl .= $comp_pointer; 4247 $decl = rtrim($decl) if ($var eq ""); 4248 $fixed[$fixlinenr] =~ s@\b$sign\s*\Q$pointer\E\s*$var\b@$decl$var@; 4249 } 4250 } 4251 } 4252 4253# TEST: allow direct testing of the type matcher. 4254 if ($dbg_type) { 4255 if ($line =~ /^.\s*$Declare\s*$/) { 4256 ERROR("TEST_TYPE", 4257 "TEST: is type\n" . $herecurr); 4258 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 4259 ERROR("TEST_NOT_TYPE", 4260 "TEST: is not type ($1 is)\n". $herecurr); 4261 } 4262 next; 4263 } 4264# TEST: allow direct testing of the attribute matcher. 4265 if ($dbg_attr) { 4266 if ($line =~ /^.\s*$Modifier\s*$/) { 4267 ERROR("TEST_ATTR", 4268 "TEST: is attr\n" . $herecurr); 4269 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 4270 ERROR("TEST_NOT_ATTR", 4271 "TEST: is not attr ($1 is)\n". $herecurr); 4272 } 4273 next; 4274 } 4275 4276# check for initialisation to aggregates open brace on the next line 4277 if ($line =~ /^.\s*{/ && 4278 $prevline =~ /(?:^|[^=])=\s*$/) { 4279 if (ERROR("OPEN_BRACE", 4280 "that open brace { should be on the previous line\n" . $hereprev) && 4281 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 4282 fix_delete_line($fixlinenr - 1, $prevrawline); 4283 fix_delete_line($fixlinenr, $rawline); 4284 my $fixedline = $prevrawline; 4285 $fixedline =~ s/\s*=\s*$/ = {/; 4286 fix_insert_line($fixlinenr, $fixedline); 4287 $fixedline = $line; 4288 $fixedline =~ s/^(.\s*)\{\s*/$1/; 4289 fix_insert_line($fixlinenr, $fixedline); 4290 } 4291 } 4292 4293# 4294# Checks which are anchored on the added line. 4295# 4296 4297# check for malformed paths in #include statements (uses RAW line) 4298 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 4299 my $path = $1; 4300 if ($path =~ m{//}) { 4301 ERROR("MALFORMED_INCLUDE", 4302 "malformed #include filename\n" . $herecurr); 4303 } 4304 if ($path =~ "^uapi/" && $realfile =~ m@\binclude/uapi/@) { 4305 ERROR("UAPI_INCLUDE", 4306 "No #include in ...include/uapi/... should use a uapi/ path prefix\n" . $herecurr); 4307 } 4308 } 4309 4310# no C99 // comments 4311 if ($line =~ m{//}) { 4312 if (ERROR("C99_COMMENTS", 4313 "do not use C99 // comments\n" . $herecurr) && 4314 $fix) { 4315 my $line = $fixed[$fixlinenr]; 4316 if ($line =~ /\/\/(.*)$/) { 4317 my $comment = trim($1); 4318 $fixed[$fixlinenr] =~ s@\/\/(.*)$@/\* $comment \*/@; 4319 } 4320 } 4321 } 4322 # Remove C99 comments. 4323 $line =~ s@//.*@@; 4324 $opline =~ s@//.*@@; 4325 4326# EXPORT_SYMBOL should immediately follow the thing it is exporting, consider 4327# the whole statement. 4328#print "APW <$lines[$realline_next - 1]>\n"; 4329 if (defined $realline_next && 4330 exists $lines[$realline_next - 1] && 4331 !defined $suppress_export{$realline_next} && 4332 ($lines[$realline_next - 1] =~ /EXPORT_SYMBOL.*\((.*)\)/)) { 4333 # Handle definitions which produce identifiers with 4334 # a prefix: 4335 # XXX(foo); 4336 # EXPORT_SYMBOL(something_foo); 4337 my $name = $1; 4338 if ($stat =~ /^(?:.\s*}\s*\n)?.([A-Z_]+)\s*\(\s*($Ident)/ && 4339 $name =~ /^${Ident}_$2/) { 4340#print "FOO C name<$name>\n"; 4341 $suppress_export{$realline_next} = 1; 4342 4343 } elsif ($stat !~ /(?: 4344 \n.}\s*$| 4345 ^.DEFINE_$Ident\(\Q$name\E\)| 4346 ^.DECLARE_$Ident\(\Q$name\E\)| 4347 ^.LIST_HEAD\(\Q$name\E\)| 4348 ^.(?:$Storage\s+)?$Type\s*\(\s*\*\s*\Q$name\E\s*\)\s*\(| 4349 \b\Q$name\E(?:\s+$Attribute)*\s*(?:;|=|\[|\() 4350 )/x) { 4351#print "FOO A<$lines[$realline_next - 1]> stat<$stat> name<$name>\n"; 4352 $suppress_export{$realline_next} = 2; 4353 } else { 4354 $suppress_export{$realline_next} = 1; 4355 } 4356 } 4357 if (!defined $suppress_export{$linenr} && 4358 $prevline =~ /^.\s*$/ && 4359 ($line =~ /EXPORT_SYMBOL.*\((.*)\)/)) { 4360#print "FOO B <$lines[$linenr - 1]>\n"; 4361 $suppress_export{$linenr} = 2; 4362 } 4363 if (defined $suppress_export{$linenr} && 4364 $suppress_export{$linenr} == 2) { 4365 WARN("EXPORT_SYMBOL", 4366 "EXPORT_SYMBOL(foo); should immediately follow its function/variable\n" . $herecurr); 4367 } 4368 4369# check for global initialisers. 4370 if ($line =~ /^\+$Type\s*$Ident(?:\s+$Modifier)*\s*=\s*($zero_initializer)\s*;/ && 4371 !exclude_global_initialisers($realfile)) { 4372 if (ERROR("GLOBAL_INITIALISERS", 4373 "do not initialise globals to $1\n" . $herecurr) && 4374 $fix) { 4375 $fixed[$fixlinenr] =~ s/(^.$Type\s*$Ident(?:\s+$Modifier)*)\s*=\s*$zero_initializer\s*;/$1;/; 4376 } 4377 } 4378# check for static initialisers. 4379 if ($line =~ /^\+.*\bstatic\s.*=\s*($zero_initializer)\s*;/) { 4380 if (ERROR("INITIALISED_STATIC", 4381 "do not initialise statics to $1\n" . 4382 $herecurr) && 4383 $fix) { 4384 $fixed[$fixlinenr] =~ s/(\bstatic\s.*?)\s*=\s*$zero_initializer\s*;/$1;/; 4385 } 4386 } 4387 4388# check for misordered declarations of char/short/int/long with signed/unsigned 4389 while ($sline =~ m{(\b$TypeMisordered\b)}g) { 4390 my $tmp = trim($1); 4391 WARN("MISORDERED_TYPE", 4392 "type '$tmp' should be specified in [[un]signed] [short|int|long|long long] order\n" . $herecurr); 4393 } 4394 4395# check for unnecessary <signed> int declarations of short/long/long long 4396 while ($sline =~ m{\b($TypeMisordered(\s*\*)*|$C90_int_types)\b}g) { 4397 my $type = trim($1); 4398 next if ($type !~ /\bint\b/); 4399 next if ($type !~ /\b(?:short|long\s+long|long)\b/); 4400 my $new_type = $type; 4401 $new_type =~ s/\b\s*int\s*\b/ /; 4402 $new_type =~ s/\b\s*(?:un)?signed\b\s*/ /; 4403 $new_type =~ s/^const\s+//; 4404 $new_type = "unsigned $new_type" if ($type =~ /\bunsigned\b/); 4405 $new_type = "const $new_type" if ($type =~ /^const\b/); 4406 $new_type =~ s/\s+/ /g; 4407 $new_type = trim($new_type); 4408 if (WARN("UNNECESSARY_INT", 4409 "Prefer '$new_type' over '$type' as the int is unnecessary\n" . $herecurr) && 4410 $fix) { 4411 $fixed[$fixlinenr] =~ s/\b\Q$type\E\b/$new_type/; 4412 } 4413 } 4414 4415# check for static const char * arrays. 4416 if ($line =~ /\bstatic\s+const\s+char\s*\*\s*(\w+)\s*\[\s*\]\s*=\s*/) { 4417 WARN("STATIC_CONST_CHAR_ARRAY", 4418 "static const char * array should probably be static const char * const\n" . 4419 $herecurr); 4420 } 4421 4422# check for initialized const char arrays that should be static const 4423 if ($line =~ /^\+\s*const\s+(char|unsigned\s+char|_*u8|(?:[us]_)?int8_t)\s+\w+\s*\[\s*(?:\w+\s*)?\]\s*=\s*"/) { 4424 if (WARN("STATIC_CONST_CHAR_ARRAY", 4425 "const array should probably be static const\n" . $herecurr) && 4426 $fix) { 4427 $fixed[$fixlinenr] =~ s/(^.\s*)const\b/${1}static const/; 4428 } 4429 } 4430 4431# check for static char foo[] = "bar" declarations. 4432 if ($line =~ /\bstatic\s+char\s+(\w+)\s*\[\s*\]\s*=\s*"/) { 4433 WARN("STATIC_CONST_CHAR_ARRAY", 4434 "static char array declaration should probably be static const char\n" . 4435 $herecurr); 4436 } 4437 4438# check for const <foo> const where <foo> is not a pointer or array type 4439 if ($sline =~ /\bconst\s+($BasicType)\s+const\b/) { 4440 my $found = $1; 4441 if ($sline =~ /\bconst\s+\Q$found\E\s+const\b\s*\*/) { 4442 WARN("CONST_CONST", 4443 "'const $found const *' should probably be 'const $found * const'\n" . $herecurr); 4444 } elsif ($sline !~ /\bconst\s+\Q$found\E\s+const\s+\w+\s*\[/) { 4445 WARN("CONST_CONST", 4446 "'const $found const' should probably be 'const $found'\n" . $herecurr); 4447 } 4448 } 4449 4450# check for const static or static <non ptr type> const declarations 4451# prefer 'static const <foo>' over 'const static <foo>' and 'static <foo> const' 4452 if ($sline =~ /^\+\s*const\s+static\s+($Type)\b/ || 4453 $sline =~ /^\+\s*static\s+($BasicType)\s+const\b/) { 4454 if (WARN("STATIC_CONST", 4455 "Move const after static - use 'static const $1'\n" . $herecurr) && 4456 $fix) { 4457 $fixed[$fixlinenr] =~ s/\bconst\s+static\b/static const/; 4458 $fixed[$fixlinenr] =~ s/\bstatic\s+($BasicType)\s+const\b/static const $1/; 4459 } 4460 } 4461 4462# check for non-global char *foo[] = {"bar", ...} declarations. 4463 if ($line =~ /^.\s+(?:static\s+|const\s+)?char\s+\*\s*\w+\s*\[\s*\]\s*=\s*\{/) { 4464 WARN("STATIC_CONST_CHAR_ARRAY", 4465 "char * array declaration might be better as static const\n" . 4466 $herecurr); 4467 } 4468 4469# check for sizeof(foo)/sizeof(foo[0]) that could be ARRAY_SIZE(foo) 4470 if ($line =~ m@\bsizeof\s*\(\s*($Lval)\s*\)@) { 4471 my $array = $1; 4472 if ($line =~ m@\b(sizeof\s*\(\s*\Q$array\E\s*\)\s*/\s*sizeof\s*\(\s*\Q$array\E\s*\[\s*0\s*\]\s*\))@) { 4473 my $array_div = $1; 4474 if (WARN("ARRAY_SIZE", 4475 "Prefer ARRAY_SIZE($array)\n" . $herecurr) && 4476 $fix) { 4477 $fixed[$fixlinenr] =~ s/\Q$array_div\E/ARRAY_SIZE($array)/; 4478 } 4479 } 4480 } 4481 4482# check for function declarations without arguments like "int foo()" 4483 if ($line =~ /(\b$Type\s*$Ident)\s*\(\s*\)/) { 4484 if (ERROR("FUNCTION_WITHOUT_ARGS", 4485 "Bad function definition - $1() should probably be $1(void)\n" . $herecurr) && 4486 $fix) { 4487 $fixed[$fixlinenr] =~ s/(\b($Type)\s+($Ident))\s*\(\s*\)/$2 $3(void)/; 4488 } 4489 } 4490 4491# check for new typedefs, only function parameters and sparse annotations 4492# make sense. 4493 if ($line =~ /\btypedef\s/ && 4494 $line !~ /\btypedef\s+$Type\s*\(\s*\*?$Ident\s*\)\s*\(/ && 4495 $line !~ /\btypedef\s+$Type\s+$Ident\s*\(/ && 4496 $line !~ /\b$typeTypedefs\b/ && 4497 $line !~ /\b__bitwise\b/) { 4498 WARN("NEW_TYPEDEFS", 4499 "do not add new typedefs\n" . $herecurr); 4500 } 4501 4502# * goes on variable not on type 4503 # (char*[ const]) 4504 while ($line =~ m{(\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\))}g) { 4505 #print "AA<$1>\n"; 4506 my ($ident, $from, $to) = ($1, $2, $2); 4507 4508 # Should start with a space. 4509 $to =~ s/^(\S)/ $1/; 4510 # Should not end with a space. 4511 $to =~ s/\s+$//; 4512 # '*'s should not have spaces between. 4513 while ($to =~ s/\*\s+\*/\*\*/) { 4514 } 4515 4516## print "1: from<$from> to<$to> ident<$ident>\n"; 4517 if ($from ne $to) { 4518 if (ERROR("POINTER_LOCATION", 4519 "\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr) && 4520 $fix) { 4521 my $sub_from = $ident; 4522 my $sub_to = $ident; 4523 $sub_to =~ s/\Q$from\E/$to/; 4524 $fixed[$fixlinenr] =~ 4525 s@\Q$sub_from\E@$sub_to@; 4526 } 4527 } 4528 } 4529 while ($line =~ m{(\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident))}g) { 4530 #print "BB<$1>\n"; 4531 my ($match, $from, $to, $ident) = ($1, $2, $2, $3); 4532 4533 # Should start with a space. 4534 $to =~ s/^(\S)/ $1/; 4535 # Should not end with a space. 4536 $to =~ s/\s+$//; 4537 # '*'s should not have spaces between. 4538 while ($to =~ s/\*\s+\*/\*\*/) { 4539 } 4540 # Modifiers should have spaces. 4541 $to =~ s/(\b$Modifier$)/$1 /; 4542 4543## print "2: from<$from> to<$to> ident<$ident>\n"; 4544 if ($from ne $to && $ident !~ /^$Modifier$/) { 4545 if (ERROR("POINTER_LOCATION", 4546 "\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr) && 4547 $fix) { 4548 4549 my $sub_from = $match; 4550 my $sub_to = $match; 4551 $sub_to =~ s/\Q$from\E/$to/; 4552 $fixed[$fixlinenr] =~ 4553 s@\Q$sub_from\E@$sub_to@; 4554 } 4555 } 4556 } 4557 4558# avoid BUG() or BUG_ON() 4559 if ($line =~ /\b(?:BUG|BUG_ON)\b/) { 4560 my $msg_level = \&WARN; 4561 $msg_level = \&CHK if ($file); 4562 &{$msg_level}("AVOID_BUG", 4563 "Avoid crashing the kernel - try using WARN_ON & recovery code rather than BUG() or BUG_ON()\n" . $herecurr); 4564 } 4565 4566# avoid LINUX_VERSION_CODE 4567 if ($line =~ /\bLINUX_VERSION_CODE\b/) { 4568 WARN("LINUX_VERSION_CODE", 4569 "LINUX_VERSION_CODE should be avoided, code should be for the version to which it is merged\n" . $herecurr); 4570 } 4571 4572# check for uses of printk_ratelimit 4573 if ($line =~ /\bprintk_ratelimit\s*\(/) { 4574 WARN("PRINTK_RATELIMITED", 4575 "Prefer printk_ratelimited or pr_<level>_ratelimited to printk_ratelimit\n" . $herecurr); 4576 } 4577 4578# printk should use KERN_* levels 4579 if ($line =~ /\bprintk\s*\(\s*(?!KERN_[A-Z]+\b)/) { 4580 WARN("PRINTK_WITHOUT_KERN_LEVEL", 4581 "printk() should include KERN_<LEVEL> facility level\n" . $herecurr); 4582 } 4583 4584# prefer variants of (subsystem|netdev|dev|pr)_<level> to printk(KERN_<LEVEL> 4585 if ($line =~ /\b(printk(_once|_ratelimited)?)\s*\(\s*KERN_([A-Z]+)/) { 4586 my $printk = $1; 4587 my $modifier = $2; 4588 my $orig = $3; 4589 $modifier = "" if (!defined($modifier)); 4590 my $level = lc($orig); 4591 $level = "warn" if ($level eq "warning"); 4592 my $level2 = $level; 4593 $level2 = "dbg" if ($level eq "debug"); 4594 $level .= $modifier; 4595 $level2 .= $modifier; 4596 WARN("PREFER_PR_LEVEL", 4597 "Prefer [subsystem eg: netdev]_$level2([subsystem]dev, ... then dev_$level2(dev, ... then pr_$level(... to $printk(KERN_$orig ...\n" . $herecurr); 4598 } 4599 4600# prefer dev_<level> to dev_printk(KERN_<LEVEL> 4601 if ($line =~ /\bdev_printk\s*\(\s*KERN_([A-Z]+)/) { 4602 my $orig = $1; 4603 my $level = lc($orig); 4604 $level = "warn" if ($level eq "warning"); 4605 $level = "dbg" if ($level eq "debug"); 4606 WARN("PREFER_DEV_LEVEL", 4607 "Prefer dev_$level(... to dev_printk(KERN_$orig, ...\n" . $herecurr); 4608 } 4609 4610# trace_printk should not be used in production code. 4611 if ($line =~ /\b(trace_printk|trace_puts|ftrace_vprintk)\s*\(/) { 4612 WARN("TRACE_PRINTK", 4613 "Do not use $1() in production code (this can be ignored if built only with a debug config option)\n" . $herecurr); 4614 } 4615 4616# ENOSYS means "bad syscall nr" and nothing else. This will have a small 4617# number of false positives, but assembly files are not checked, so at 4618# least the arch entry code will not trigger this warning. 4619 if ($line =~ /\bENOSYS\b/) { 4620 WARN("ENOSYS", 4621 "ENOSYS means 'invalid syscall nr' and nothing else\n" . $herecurr); 4622 } 4623 4624# ENOTSUPP is not a standard error code and should be avoided in new patches. 4625# Folks usually mean EOPNOTSUPP (also called ENOTSUP), when they type ENOTSUPP. 4626# Similarly to ENOSYS warning a small number of false positives is expected. 4627 if (!$file && $line =~ /\bENOTSUPP\b/) { 4628 if (WARN("ENOTSUPP", 4629 "ENOTSUPP is not a SUSV4 error code, prefer EOPNOTSUPP\n" . $herecurr) && 4630 $fix) { 4631 $fixed[$fixlinenr] =~ s/\bENOTSUPP\b/EOPNOTSUPP/; 4632 } 4633 } 4634 4635# function brace can't be on same line, except for #defines of do while, 4636# or if closed on same line 4637 if ($perl_version_ok && 4638 $sline =~ /$Type\s*$Ident\s*$balanced_parens\s*\{/ && 4639 $sline !~ /\#\s*define\b.*do\s*\{/ && 4640 $sline !~ /}/) { 4641 if (ERROR("OPEN_BRACE", 4642 "open brace '{' following function definitions go on the next line\n" . $herecurr) && 4643 $fix) { 4644 fix_delete_line($fixlinenr, $rawline); 4645 my $fixed_line = $rawline; 4646 $fixed_line =~ /(^..*$Type\s*$Ident\(.*\)\s*)\{(.*)$/; 4647 my $line1 = $1; 4648 my $line2 = $2; 4649 fix_insert_line($fixlinenr, ltrim($line1)); 4650 fix_insert_line($fixlinenr, "\+{"); 4651 if ($line2 !~ /^\s*$/) { 4652 fix_insert_line($fixlinenr, "\+\t" . trim($line2)); 4653 } 4654 } 4655 } 4656 4657# open braces for enum, union and struct go on the same line. 4658 if ($line =~ /^.\s*{/ && 4659 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 4660 if (ERROR("OPEN_BRACE", 4661 "open brace '{' following $1 go on the same line\n" . $hereprev) && 4662 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 4663 fix_delete_line($fixlinenr - 1, $prevrawline); 4664 fix_delete_line($fixlinenr, $rawline); 4665 my $fixedline = rtrim($prevrawline) . " {"; 4666 fix_insert_line($fixlinenr, $fixedline); 4667 $fixedline = $rawline; 4668 $fixedline =~ s/^(.\s*)\{\s*/$1\t/; 4669 if ($fixedline !~ /^\+\s*$/) { 4670 fix_insert_line($fixlinenr, $fixedline); 4671 } 4672 } 4673 } 4674 4675# missing space after union, struct or enum definition 4676 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident){1,2}[=\{]/) { 4677 if (WARN("SPACING", 4678 "missing space after $1 definition\n" . $herecurr) && 4679 $fix) { 4680 $fixed[$fixlinenr] =~ 4681 s/^(.\s*(?:typedef\s+)?(?:enum|union|struct)(?:\s+$Ident){1,2})([=\{])/$1 $2/; 4682 } 4683 } 4684 4685# Function pointer declarations 4686# check spacing between type, funcptr, and args 4687# canonical declaration is "type (*funcptr)(args...)" 4688 if ($line =~ /^.\s*($Declare)\((\s*)\*(\s*)($Ident)(\s*)\)(\s*)\(/) { 4689 my $declare = $1; 4690 my $pre_pointer_space = $2; 4691 my $post_pointer_space = $3; 4692 my $funcname = $4; 4693 my $post_funcname_space = $5; 4694 my $pre_args_space = $6; 4695 4696# the $Declare variable will capture all spaces after the type 4697# so check it for a missing trailing missing space but pointer return types 4698# don't need a space so don't warn for those. 4699 my $post_declare_space = ""; 4700 if ($declare =~ /(\s+)$/) { 4701 $post_declare_space = $1; 4702 $declare = rtrim($declare); 4703 } 4704 if ($declare !~ /\*$/ && $post_declare_space =~ /^$/) { 4705 WARN("SPACING", 4706 "missing space after return type\n" . $herecurr); 4707 $post_declare_space = " "; 4708 } 4709 4710# unnecessary space "type (*funcptr)(args...)" 4711# This test is not currently implemented because these declarations are 4712# equivalent to 4713# int foo(int bar, ...) 4714# and this is form shouldn't/doesn't generate a checkpatch warning. 4715# 4716# elsif ($declare =~ /\s{2,}$/) { 4717# WARN("SPACING", 4718# "Multiple spaces after return type\n" . $herecurr); 4719# } 4720 4721# unnecessary space "type ( *funcptr)(args...)" 4722 if (defined $pre_pointer_space && 4723 $pre_pointer_space =~ /^\s/) { 4724 WARN("SPACING", 4725 "Unnecessary space after function pointer open parenthesis\n" . $herecurr); 4726 } 4727 4728# unnecessary space "type (* funcptr)(args...)" 4729 if (defined $post_pointer_space && 4730 $post_pointer_space =~ /^\s/) { 4731 WARN("SPACING", 4732 "Unnecessary space before function pointer name\n" . $herecurr); 4733 } 4734 4735# unnecessary space "type (*funcptr )(args...)" 4736 if (defined $post_funcname_space && 4737 $post_funcname_space =~ /^\s/) { 4738 WARN("SPACING", 4739 "Unnecessary space after function pointer name\n" . $herecurr); 4740 } 4741 4742# unnecessary space "type (*funcptr) (args...)" 4743 if (defined $pre_args_space && 4744 $pre_args_space =~ /^\s/) { 4745 WARN("SPACING", 4746 "Unnecessary space before function pointer arguments\n" . $herecurr); 4747 } 4748 4749 if (show_type("SPACING") && $fix) { 4750 $fixed[$fixlinenr] =~ 4751 s/^(.\s*)$Declare\s*\(\s*\*\s*$Ident\s*\)\s*\(/$1 . $declare . $post_declare_space . '(*' . $funcname . ')('/ex; 4752 } 4753 } 4754 4755# check for spacing round square brackets; allowed: 4756# 1. with a type on the left -- int [] a; 4757# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 4758# 3. inside a curly brace -- = { [0...10] = 5 } 4759 while ($line =~ /(.*?\s)\[/g) { 4760 my ($where, $prefix) = ($-[1], $1); 4761 if ($prefix !~ /$Type\s+$/ && 4762 ($where != 0 || $prefix !~ /^.\s+$/) && 4763 $prefix !~ /[{,:]\s+$/) { 4764 if (ERROR("BRACKET_SPACE", 4765 "space prohibited before open square bracket '['\n" . $herecurr) && 4766 $fix) { 4767 $fixed[$fixlinenr] =~ 4768 s/^(\+.*?)\s+\[/$1\[/; 4769 } 4770 } 4771 } 4772 4773# check for spaces between functions and their parentheses. 4774 while ($line =~ /($Ident)\s+\(/g) { 4775 my $name = $1; 4776 my $ctx_before = substr($line, 0, $-[1]); 4777 my $ctx = "$ctx_before$name"; 4778 4779 # Ignore those directives where spaces _are_ permitted. 4780 if ($name =~ /^(?: 4781 if|for|while|switch|return|case| 4782 volatile|__volatile__| 4783 __attribute__|format|__extension__| 4784 asm|__asm__)$/x) 4785 { 4786 # cpp #define statements have non-optional spaces, ie 4787 # if there is a space between the name and the open 4788 # parenthesis it is simply not a parameter group. 4789 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 4790 4791 # cpp #elif statement condition may start with a ( 4792 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 4793 4794 # If this whole things ends with a type its most 4795 # likely a typedef for a function. 4796 } elsif ($ctx =~ /$Type$/) { 4797 4798 } else { 4799 if (WARN("SPACING", 4800 "space prohibited between function name and open parenthesis '('\n" . $herecurr) && 4801 $fix) { 4802 $fixed[$fixlinenr] =~ 4803 s/\b$name\s+\(/$name\(/; 4804 } 4805 } 4806 } 4807 4808# Check operator spacing. 4809 if (!($line=~/\#\s*include/)) { 4810 my $fixed_line = ""; 4811 my $line_fixed = 0; 4812 4813 my $ops = qr{ 4814 <<=|>>=|<=|>=|==|!=| 4815 \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 4816 =>|->|<<|>>|<|>|=|!|~| 4817 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 4818 \?:|\?|: 4819 }x; 4820 my @elements = split(/($ops|;)/, $opline); 4821 4822## print("element count: <" . $#elements . ">\n"); 4823## foreach my $el (@elements) { 4824## print("el: <$el>\n"); 4825## } 4826 4827 my @fix_elements = (); 4828 my $off = 0; 4829 4830 foreach my $el (@elements) { 4831 push(@fix_elements, substr($rawline, $off, length($el))); 4832 $off += length($el); 4833 } 4834 4835 $off = 0; 4836 4837 my $blank = copy_spacing($opline); 4838 my $last_after = -1; 4839 4840 for (my $n = 0; $n < $#elements; $n += 2) { 4841 4842 my $good = $fix_elements[$n] . $fix_elements[$n + 1]; 4843 4844## print("n: <$n> good: <$good>\n"); 4845 4846 $off += length($elements[$n]); 4847 4848 # Pick up the preceding and succeeding characters. 4849 my $ca = substr($opline, 0, $off); 4850 my $cc = ''; 4851 if (length($opline) >= ($off + length($elements[$n + 1]))) { 4852 $cc = substr($opline, $off + length($elements[$n + 1])); 4853 } 4854 my $cb = "$ca$;$cc"; 4855 4856 my $a = ''; 4857 $a = 'V' if ($elements[$n] ne ''); 4858 $a = 'W' if ($elements[$n] =~ /\s$/); 4859 $a = 'C' if ($elements[$n] =~ /$;$/); 4860 $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 4861 $a = 'O' if ($elements[$n] eq ''); 4862 $a = 'E' if ($ca =~ /^\s*$/); 4863 4864 my $op = $elements[$n + 1]; 4865 4866 my $c = ''; 4867 if (defined $elements[$n + 2]) { 4868 $c = 'V' if ($elements[$n + 2] ne ''); 4869 $c = 'W' if ($elements[$n + 2] =~ /^\s/); 4870 $c = 'C' if ($elements[$n + 2] =~ /^$;/); 4871 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 4872 $c = 'O' if ($elements[$n + 2] eq ''); 4873 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 4874 } else { 4875 $c = 'E'; 4876 } 4877 4878 my $ctx = "${a}x${c}"; 4879 4880 my $at = "(ctx:$ctx)"; 4881 4882 my $ptr = substr($blank, 0, $off) . "^"; 4883 my $hereptr = "$hereline$ptr\n"; 4884 4885 # Pull out the value of this operator. 4886 my $op_type = substr($curr_values, $off + 1, 1); 4887 4888 # Get the full operator variant. 4889 my $opv = $op . substr($curr_vars, $off, 1); 4890 4891 # Ignore operators passed as parameters. 4892 if ($op_type ne 'V' && 4893 $ca =~ /\s$/ && $cc =~ /^\s*[,\)]/) { 4894 4895# # Ignore comments 4896# } elsif ($op =~ /^$;+$/) { 4897 4898 # ; should have either the end of line or a space or \ after it 4899 } elsif ($op eq ';') { 4900 if ($ctx !~ /.x[WEBC]/ && 4901 $cc !~ /^\\/ && $cc !~ /^;/) { 4902 if (ERROR("SPACING", 4903 "space required after that '$op' $at\n" . $hereptr)) { 4904 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 4905 $line_fixed = 1; 4906 } 4907 } 4908 4909 # // is a comment 4910 } elsif ($op eq '//') { 4911 4912 # : when part of a bitfield 4913 } elsif ($opv eq ':B') { 4914 # skip the bitfield test for now 4915 4916 # No spaces for: 4917 # -> 4918 } elsif ($op eq '->') { 4919 if ($ctx =~ /Wx.|.xW/) { 4920 if (ERROR("SPACING", 4921 "spaces prohibited around that '$op' $at\n" . $hereptr)) { 4922 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 4923 if (defined $fix_elements[$n + 2]) { 4924 $fix_elements[$n + 2] =~ s/^\s+//; 4925 } 4926 $line_fixed = 1; 4927 } 4928 } 4929 4930 # , must not have a space before and must have a space on the right. 4931 } elsif ($op eq ',') { 4932 my $rtrim_before = 0; 4933 my $space_after = 0; 4934 if ($ctx =~ /Wx./) { 4935 if (ERROR("SPACING", 4936 "space prohibited before that '$op' $at\n" . $hereptr)) { 4937 $line_fixed = 1; 4938 $rtrim_before = 1; 4939 } 4940 } 4941 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/) { 4942 if (ERROR("SPACING", 4943 "space required after that '$op' $at\n" . $hereptr)) { 4944 $line_fixed = 1; 4945 $last_after = $n; 4946 $space_after = 1; 4947 } 4948 } 4949 if ($rtrim_before || $space_after) { 4950 if ($rtrim_before) { 4951 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 4952 } else { 4953 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 4954 } 4955 if ($space_after) { 4956 $good .= " "; 4957 } 4958 } 4959 4960 # '*' as part of a type definition -- reported already. 4961 } elsif ($opv eq '*_') { 4962 #warn "'*' is part of type\n"; 4963 4964 # unary operators should have a space before and 4965 # none after. May be left adjacent to another 4966 # unary operator, or a cast 4967 } elsif ($op eq '!' || $op eq '~' || 4968 $opv eq '*U' || $opv eq '-U' || 4969 $opv eq '&U' || $opv eq '&&U') { 4970 if ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 4971 if (ERROR("SPACING", 4972 "space required before that '$op' $at\n" . $hereptr)) { 4973 if ($n != $last_after + 2) { 4974 $good = $fix_elements[$n] . " " . ltrim($fix_elements[$n + 1]); 4975 $line_fixed = 1; 4976 } 4977 } 4978 } 4979 if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 4980 # A unary '*' may be const 4981 4982 } elsif ($ctx =~ /.xW/) { 4983 if (ERROR("SPACING", 4984 "space prohibited after that '$op' $at\n" . $hereptr)) { 4985 $good = $fix_elements[$n] . rtrim($fix_elements[$n + 1]); 4986 if (defined $fix_elements[$n + 2]) { 4987 $fix_elements[$n + 2] =~ s/^\s+//; 4988 } 4989 $line_fixed = 1; 4990 } 4991 } 4992 4993 # unary ++ and unary -- are allowed no space on one side. 4994 } elsif ($op eq '++' or $op eq '--') { 4995 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 4996 if (ERROR("SPACING", 4997 "space required one side of that '$op' $at\n" . $hereptr)) { 4998 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]) . " "; 4999 $line_fixed = 1; 5000 } 5001 } 5002 if ($ctx =~ /Wx[BE]/ || 5003 ($ctx =~ /Wx./ && $cc =~ /^;/)) { 5004 if (ERROR("SPACING", 5005 "space prohibited before that '$op' $at\n" . $hereptr)) { 5006 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 5007 $line_fixed = 1; 5008 } 5009 } 5010 if ($ctx =~ /ExW/) { 5011 if (ERROR("SPACING", 5012 "space prohibited after that '$op' $at\n" . $hereptr)) { 5013 $good = $fix_elements[$n] . trim($fix_elements[$n + 1]); 5014 if (defined $fix_elements[$n + 2]) { 5015 $fix_elements[$n + 2] =~ s/^\s+//; 5016 } 5017 $line_fixed = 1; 5018 } 5019 } 5020 5021 # << and >> may either have or not have spaces both sides 5022 } elsif ($op eq '<<' or $op eq '>>' or 5023 $op eq '&' or $op eq '^' or $op eq '|' or 5024 $op eq '+' or $op eq '-' or 5025 $op eq '*' or $op eq '/' or 5026 $op eq '%') 5027 { 5028 if ($check) { 5029 if (defined $fix_elements[$n + 2] && $ctx !~ /[EW]x[EW]/) { 5030 if (CHK("SPACING", 5031 "spaces preferred around that '$op' $at\n" . $hereptr)) { 5032 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5033 $fix_elements[$n + 2] =~ s/^\s+//; 5034 $line_fixed = 1; 5035 } 5036 } elsif (!defined $fix_elements[$n + 2] && $ctx !~ /Wx[OE]/) { 5037 if (CHK("SPACING", 5038 "space preferred before that '$op' $at\n" . $hereptr)) { 5039 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]); 5040 $line_fixed = 1; 5041 } 5042 } 5043 } elsif ($ctx =~ /Wx[^WCE]|[^WCE]xW/) { 5044 if (ERROR("SPACING", 5045 "need consistent spacing around '$op' $at\n" . $hereptr)) { 5046 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5047 if (defined $fix_elements[$n + 2]) { 5048 $fix_elements[$n + 2] =~ s/^\s+//; 5049 } 5050 $line_fixed = 1; 5051 } 5052 } 5053 5054 # A colon needs no spaces before when it is 5055 # terminating a case value or a label. 5056 } elsif ($opv eq ':C' || $opv eq ':L') { 5057 if ($ctx =~ /Wx./ and $realfile !~ m@.*\.lds\.h$@) { 5058 if (ERROR("SPACING", 5059 "space prohibited before that '$op' $at\n" . $hereptr)) { 5060 $good = rtrim($fix_elements[$n]) . trim($fix_elements[$n + 1]); 5061 $line_fixed = 1; 5062 } 5063 } 5064 5065 # All the others need spaces both sides. 5066 } elsif ($ctx !~ /[EWC]x[CWE]/) { 5067 my $ok = 0; 5068 5069 # Ignore email addresses <foo@bar> 5070 if (($op eq '<' && 5071 $cc =~ /^\S+\@\S+>/) || 5072 ($op eq '>' && 5073 $ca =~ /<\S+\@\S+$/)) 5074 { 5075 $ok = 1; 5076 } 5077 5078 # for asm volatile statements 5079 # ignore a colon with another 5080 # colon immediately before or after 5081 if (($op eq ':') && 5082 ($ca =~ /:$/ || $cc =~ /^:/)) { 5083 $ok = 1; 5084 } 5085 5086 # messages are ERROR, but ?: are CHK 5087 if ($ok == 0) { 5088 my $msg_level = \&ERROR; 5089 $msg_level = \&CHK if (($op eq '?:' || $op eq '?' || $op eq ':') && $ctx =~ /VxV/); 5090 5091 if (&{$msg_level}("SPACING", 5092 "spaces required around that '$op' $at\n" . $hereptr)) { 5093 $good = rtrim($fix_elements[$n]) . " " . trim($fix_elements[$n + 1]) . " "; 5094 if (defined $fix_elements[$n + 2]) { 5095 $fix_elements[$n + 2] =~ s/^\s+//; 5096 } 5097 $line_fixed = 1; 5098 } 5099 } 5100 } 5101 $off += length($elements[$n + 1]); 5102 5103## print("n: <$n> GOOD: <$good>\n"); 5104 5105 $fixed_line = $fixed_line . $good; 5106 } 5107 5108 if (($#elements % 2) == 0) { 5109 $fixed_line = $fixed_line . $fix_elements[$#elements]; 5110 } 5111 5112 if ($fix && $line_fixed && $fixed_line ne $fixed[$fixlinenr]) { 5113 $fixed[$fixlinenr] = $fixed_line; 5114 } 5115 5116 5117 } 5118 5119# check for whitespace before a non-naked semicolon 5120 if ($line =~ /^\+.*\S\s+;\s*$/) { 5121 if (WARN("SPACING", 5122 "space prohibited before semicolon\n" . $herecurr) && 5123 $fix) { 5124 1 while $fixed[$fixlinenr] =~ 5125 s/^(\+.*\S)\s+;/$1;/; 5126 } 5127 } 5128 5129# check for multiple assignments 5130 if ($line =~ /^.\s*$Lval\s*=\s*$Lval\s*=(?!=)/) { 5131 CHK("MULTIPLE_ASSIGNMENTS", 5132 "multiple assignments should be avoided\n" . $herecurr); 5133 } 5134 5135## # check for multiple declarations, allowing for a function declaration 5136## # continuation. 5137## if ($line =~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Ident.*/ && 5138## $line !~ /^.\s*$Type\s+$Ident(?:\s*=[^,{]*)?\s*,\s*$Type\s*$Ident.*/) { 5139## 5140## # Remove any bracketed sections to ensure we do not 5141## # falsely report the parameters of functions. 5142## my $ln = $line; 5143## while ($ln =~ s/\([^\(\)]*\)//g) { 5144## } 5145## if ($ln =~ /,/) { 5146## WARN("MULTIPLE_DECLARATION", 5147## "declaring multiple variables together should be avoided\n" . $herecurr); 5148## } 5149## } 5150 5151#need space before brace following if, while, etc 5152 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 5153 $line =~ /\b(?:else|do)\{/) { 5154 if (ERROR("SPACING", 5155 "space required before the open brace '{'\n" . $herecurr) && 5156 $fix) { 5157 $fixed[$fixlinenr] =~ s/^(\+.*(?:do|else|\)))\{/$1 {/; 5158 } 5159 } 5160 5161## # check for blank lines before declarations 5162## if ($line =~ /^.\t+$Type\s+$Ident(?:\s*=.*)?;/ && 5163## $prevrawline =~ /^.\s*$/) { 5164## WARN("SPACING", 5165## "No blank lines before declarations\n" . $hereprev); 5166## } 5167## 5168 5169# closing brace should have a space following it when it has anything 5170# on the line 5171 if ($line =~ /}(?!(?:,|;|\)|\}))\S/) { 5172 if (ERROR("SPACING", 5173 "space required after that close brace '}'\n" . $herecurr) && 5174 $fix) { 5175 $fixed[$fixlinenr] =~ 5176 s/}((?!(?:,|;|\)))\S)/} $1/; 5177 } 5178 } 5179 5180# check spacing on square brackets 5181 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 5182 if (ERROR("SPACING", 5183 "space prohibited after that open square bracket '['\n" . $herecurr) && 5184 $fix) { 5185 $fixed[$fixlinenr] =~ 5186 s/\[\s+/\[/; 5187 } 5188 } 5189 if ($line =~ /\s\]/) { 5190 if (ERROR("SPACING", 5191 "space prohibited before that close square bracket ']'\n" . $herecurr) && 5192 $fix) { 5193 $fixed[$fixlinenr] =~ 5194 s/\s+\]/\]/; 5195 } 5196 } 5197 5198# check spacing on parentheses 5199 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 5200 $line !~ /for\s*\(\s+;/) { 5201 if (ERROR("SPACING", 5202 "space prohibited after that open parenthesis '('\n" . $herecurr) && 5203 $fix) { 5204 $fixed[$fixlinenr] =~ 5205 s/\(\s+/\(/; 5206 } 5207 } 5208 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 5209 $line !~ /for\s*\(.*;\s+\)/ && 5210 $line !~ /:\s+\)/) { 5211 if (ERROR("SPACING", 5212 "space prohibited before that close parenthesis ')'\n" . $herecurr) && 5213 $fix) { 5214 $fixed[$fixlinenr] =~ 5215 s/\s+\)/\)/; 5216 } 5217 } 5218 5219# check unnecessary parentheses around addressof/dereference single $Lvals 5220# ie: &(foo->bar) should be &foo->bar and *(foo->bar) should be *foo->bar 5221 5222 while ($line =~ /(?:[^&]&\s*|\*)\(\s*($Ident\s*(?:$Member\s*)+)\s*\)/g) { 5223 my $var = $1; 5224 if (CHK("UNNECESSARY_PARENTHESES", 5225 "Unnecessary parentheses around $var\n" . $herecurr) && 5226 $fix) { 5227 $fixed[$fixlinenr] =~ s/\(\s*\Q$var\E\s*\)/$var/; 5228 } 5229 } 5230 5231# check for unnecessary parentheses around function pointer uses 5232# ie: (foo->bar)(); should be foo->bar(); 5233# but not "if (foo->bar) (" to avoid some false positives 5234 if ($line =~ /(\bif\s*|)(\(\s*$Ident\s*(?:$Member\s*)+\))[ \t]*\(/ && $1 !~ /^if/) { 5235 my $var = $2; 5236 if (CHK("UNNECESSARY_PARENTHESES", 5237 "Unnecessary parentheses around function pointer $var\n" . $herecurr) && 5238 $fix) { 5239 my $var2 = deparenthesize($var); 5240 $var2 =~ s/\s//g; 5241 $fixed[$fixlinenr] =~ s/\Q$var\E/$var2/; 5242 } 5243 } 5244 5245# check for unnecessary parentheses around comparisons in if uses 5246# when !drivers/staging or command-line uses --strict 5247 if (($realfile !~ m@^(?:drivers/staging/)@ || $check_orig) && 5248 $perl_version_ok && defined($stat) && 5249 $stat =~ /(^.\s*if\s*($balanced_parens))/) { 5250 my $if_stat = $1; 5251 my $test = substr($2, 1, -1); 5252 my $herectx; 5253 while ($test =~ /(?:^|[^\w\&\!\~])+\s*\(\s*([\&\!\~]?\s*$Lval\s*(?:$Compare\s*$FuncArg)?)\s*\)/g) { 5254 my $match = $1; 5255 # avoid parentheses around potential macro args 5256 next if ($match =~ /^\s*\w+\s*$/); 5257 if (!defined($herectx)) { 5258 $herectx = $here . "\n"; 5259 my $cnt = statement_rawlines($if_stat); 5260 for (my $n = 0; $n < $cnt; $n++) { 5261 my $rl = raw_line($linenr, $n); 5262 $herectx .= $rl . "\n"; 5263 last if $rl =~ /^[ \+].*\{/; 5264 } 5265 } 5266 CHK("UNNECESSARY_PARENTHESES", 5267 "Unnecessary parentheses around '$match'\n" . $herectx); 5268 } 5269 } 5270 5271#goto labels aren't indented, allow a single space however 5272 if ($line=~/^.\s+[A-Za-z\d_]+:(?![0-9]+)/ and 5273 !($line=~/^. [A-Za-z\d_]+:/) and !($line=~/^.\s+default:/)) { 5274 if (WARN("INDENTED_LABEL", 5275 "labels should not be indented\n" . $herecurr) && 5276 $fix) { 5277 $fixed[$fixlinenr] =~ 5278 s/^(.)\s+/$1/; 5279 } 5280 } 5281 5282# check if a statement with a comma should be two statements like: 5283# foo = bar(), /* comma should be semicolon */ 5284# bar = baz(); 5285 if (defined($stat) && 5286 $stat =~ /^\+\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*,\s*(?:$Lval\s*$Assignment\s*)?$FuncArg\s*;\s*$/) { 5287 my $cnt = statement_rawlines($stat); 5288 my $herectx = get_stat_here($linenr, $cnt, $here); 5289 WARN("SUSPECT_COMMA_SEMICOLON", 5290 "Possible comma where semicolon could be used\n" . $herectx); 5291 } 5292 5293# return is not a function 5294 if (defined($stat) && $stat =~ /^.\s*return(\s*)\(/s) { 5295 my $spacing = $1; 5296 if ($perl_version_ok && 5297 $stat =~ /^.\s*return\s*($balanced_parens)\s*;\s*$/) { 5298 my $value = $1; 5299 $value = deparenthesize($value); 5300 if ($value =~ m/^\s*$FuncArg\s*(?:\?|$)/) { 5301 ERROR("RETURN_PARENTHESES", 5302 "return is not a function, parentheses are not required\n" . $herecurr); 5303 } 5304 } elsif ($spacing !~ /\s+/) { 5305 ERROR("SPACING", 5306 "space required before the open parenthesis '('\n" . $herecurr); 5307 } 5308 } 5309 5310# unnecessary return in a void function 5311# at end-of-function, with the previous line a single leading tab, then return; 5312# and the line before that not a goto label target like "out:" 5313 if ($sline =~ /^[ \+]}\s*$/ && 5314 $prevline =~ /^\+\treturn\s*;\s*$/ && 5315 $linenr >= 3 && 5316 $lines[$linenr - 3] =~ /^[ +]/ && 5317 $lines[$linenr - 3] !~ /^[ +]\s*$Ident\s*:/) { 5318 WARN("RETURN_VOID", 5319 "void function return statements are not generally useful\n" . $hereprev); 5320 } 5321 5322# if statements using unnecessary parentheses - ie: if ((foo == bar)) 5323 if ($perl_version_ok && 5324 $line =~ /\bif\s*((?:\(\s*){2,})/) { 5325 my $openparens = $1; 5326 my $count = $openparens =~ tr@\(@\(@; 5327 my $msg = ""; 5328 if ($line =~ /\bif\s*(?:\(\s*){$count,$count}$LvalOrFunc\s*($Compare)\s*$LvalOrFunc(?:\s*\)){$count,$count}/) { 5329 my $comp = $4; #Not $1 because of $LvalOrFunc 5330 $msg = " - maybe == should be = ?" if ($comp eq "=="); 5331 WARN("UNNECESSARY_PARENTHESES", 5332 "Unnecessary parentheses$msg\n" . $herecurr); 5333 } 5334 } 5335 5336# comparisons with a constant or upper case identifier on the left 5337# avoid cases like "foo + BAR < baz" 5338# only fix matches surrounded by parentheses to avoid incorrect 5339# conversions like "FOO < baz() + 5" being "misfixed" to "baz() > FOO + 5" 5340 if ($perl_version_ok && 5341 $line =~ /^\+(.*)\b($Constant|[A-Z_][A-Z0-9_]*)\s*($Compare)\s*($LvalOrFunc)/) { 5342 my $lead = $1; 5343 my $const = $2; 5344 my $comp = $3; 5345 my $to = $4; 5346 my $newcomp = $comp; 5347 if ($lead !~ /(?:$Operators|\.)\s*$/ && 5348 $to !~ /^(?:Constant|[A-Z_][A-Z0-9_]*)$/ && 5349 WARN("CONSTANT_COMPARISON", 5350 "Comparisons should place the constant on the right side of the test\n" . $herecurr) && 5351 $fix) { 5352 if ($comp eq "<") { 5353 $newcomp = ">"; 5354 } elsif ($comp eq "<=") { 5355 $newcomp = ">="; 5356 } elsif ($comp eq ">") { 5357 $newcomp = "<"; 5358 } elsif ($comp eq ">=") { 5359 $newcomp = "<="; 5360 } 5361 $fixed[$fixlinenr] =~ s/\(\s*\Q$const\E\s*$Compare\s*\Q$to\E\s*\)/($to $newcomp $const)/; 5362 } 5363 } 5364 5365# Return of what appears to be an errno should normally be negative 5366 if ($sline =~ /\breturn(?:\s*\(+\s*|\s+)(E[A-Z]+)(?:\s*\)+\s*|\s*)[;:,]/) { 5367 my $name = $1; 5368 if ($name ne 'EOF' && $name ne 'ERROR') { 5369 WARN("USE_NEGATIVE_ERRNO", 5370 "return of an errno should typically be negative (ie: return -$1)\n" . $herecurr); 5371 } 5372 } 5373 5374# Need a space before open parenthesis after if, while etc 5375 if ($line =~ /\b(if|while|for|switch)\(/) { 5376 if (ERROR("SPACING", 5377 "space required before the open parenthesis '('\n" . $herecurr) && 5378 $fix) { 5379 $fixed[$fixlinenr] =~ 5380 s/\b(if|while|for|switch)\(/$1 \(/; 5381 } 5382 } 5383 5384# Check for illegal assignment in if conditional -- and check for trailing 5385# statements after the conditional. 5386 if ($line =~ /do\s*(?!{)/) { 5387 ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 5388 ctx_statement_block($linenr, $realcnt, 0) 5389 if (!defined $stat); 5390 my ($stat_next) = ctx_statement_block($line_nr_next, 5391 $remain_next, $off_next); 5392 $stat_next =~ s/\n./\n /g; 5393 ##print "stat<$stat> stat_next<$stat_next>\n"; 5394 5395 if ($stat_next =~ /^\s*while\b/) { 5396 # If the statement carries leading newlines, 5397 # then count those as offsets. 5398 my ($whitespace) = 5399 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 5400 my $offset = 5401 statement_rawlines($whitespace) - 1; 5402 5403 $suppress_whiletrailers{$line_nr_next + 5404 $offset} = 1; 5405 } 5406 } 5407 if (!defined $suppress_whiletrailers{$linenr} && 5408 defined($stat) && defined($cond) && 5409 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 5410 my ($s, $c) = ($stat, $cond); 5411 5412 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 5413 if (ERROR("ASSIGN_IN_IF", 5414 "do not use assignment in if condition\n" . $herecurr) && 5415 $fix && $perl_version_ok) { 5416 if ($rawline =~ /^\+(\s+)if\s*\(\s*(\!)?\s*\(\s*(($Lval)\s*=\s*$LvalOrFunc)\s*\)\s*(?:($Compare)\s*($FuncArg))?\s*\)\s*(\{)?\s*$/) { 5417 my $space = $1; 5418 my $not = $2; 5419 my $statement = $3; 5420 my $assigned = $4; 5421 my $test = $8; 5422 my $against = $9; 5423 my $brace = $15; 5424 fix_delete_line($fixlinenr, $rawline); 5425 fix_insert_line($fixlinenr, "$space$statement;"); 5426 my $newline = "${space}if ("; 5427 $newline .= '!' if defined($not); 5428 $newline .= '(' if (defined $not && defined($test) && defined($against)); 5429 $newline .= "$assigned"; 5430 $newline .= " $test $against" if (defined($test) && defined($against)); 5431 $newline .= ')' if (defined $not && defined($test) && defined($against)); 5432 $newline .= ')'; 5433 $newline .= " {" if (defined($brace)); 5434 fix_insert_line($fixlinenr + 1, $newline); 5435 } 5436 } 5437 } 5438 5439 # Find out what is on the end of the line after the 5440 # conditional. 5441 substr($s, 0, length($c), ''); 5442 $s =~ s/\n.*//g; 5443 $s =~ s/$;//g; # Remove any comments 5444 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 5445 $c !~ /}\s*while\s*/) 5446 { 5447 # Find out how long the conditional actually is. 5448 my @newlines = ($c =~ /\n/gs); 5449 my $cond_lines = 1 + $#newlines; 5450 my $stat_real = ''; 5451 5452 $stat_real = raw_line($linenr, $cond_lines) 5453 . "\n" if ($cond_lines); 5454 if (defined($stat_real) && $cond_lines > 1) { 5455 $stat_real = "[...]\n$stat_real"; 5456 } 5457 5458 ERROR("TRAILING_STATEMENTS", 5459 "trailing statements should be on next line\n" . $herecurr . $stat_real); 5460 } 5461 } 5462 5463# Check for bitwise tests written as boolean 5464 if ($line =~ / 5465 (?: 5466 (?:\[|\(|\&\&|\|\|) 5467 \s*0[xX][0-9]+\s* 5468 (?:\&\&|\|\|) 5469 | 5470 (?:\&\&|\|\|) 5471 \s*0[xX][0-9]+\s* 5472 (?:\&\&|\|\||\)|\]) 5473 )/x) 5474 { 5475 WARN("HEXADECIMAL_BOOLEAN_TEST", 5476 "boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 5477 } 5478 5479# if and else should not have general statements after it 5480 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 5481 my $s = $1; 5482 $s =~ s/$;//g; # Remove any comments 5483 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 5484 ERROR("TRAILING_STATEMENTS", 5485 "trailing statements should be on next line\n" . $herecurr); 5486 } 5487 } 5488# if should not continue a brace 5489 if ($line =~ /}\s*if\b/) { 5490 ERROR("TRAILING_STATEMENTS", 5491 "trailing statements should be on next line (or did you mean 'else if'?)\n" . 5492 $herecurr); 5493 } 5494# case and default should not have general statements after them 5495 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 5496 $line !~ /\G(?: 5497 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 5498 \s*return\s+ 5499 )/xg) 5500 { 5501 ERROR("TRAILING_STATEMENTS", 5502 "trailing statements should be on next line\n" . $herecurr); 5503 } 5504 5505 # Check for }<nl>else {, these must be at the same 5506 # indent level to be relevant to each other. 5507 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ && 5508 $previndent == $indent) { 5509 if (ERROR("ELSE_AFTER_BRACE", 5510 "else should follow close brace '}'\n" . $hereprev) && 5511 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 5512 fix_delete_line($fixlinenr - 1, $prevrawline); 5513 fix_delete_line($fixlinenr, $rawline); 5514 my $fixedline = $prevrawline; 5515 $fixedline =~ s/}\s*$//; 5516 if ($fixedline !~ /^\+\s*$/) { 5517 fix_insert_line($fixlinenr, $fixedline); 5518 } 5519 $fixedline = $rawline; 5520 $fixedline =~ s/^(.\s*)else/$1} else/; 5521 fix_insert_line($fixlinenr, $fixedline); 5522 } 5523 } 5524 5525 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ && 5526 $previndent == $indent) { 5527 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 5528 5529 # Find out what is on the end of the line after the 5530 # conditional. 5531 substr($s, 0, length($c), ''); 5532 $s =~ s/\n.*//g; 5533 5534 if ($s =~ /^\s*;/) { 5535 if (ERROR("WHILE_AFTER_BRACE", 5536 "while should follow close brace '}'\n" . $hereprev) && 5537 $fix && $prevline =~ /^\+/ && $line =~ /^\+/) { 5538 fix_delete_line($fixlinenr - 1, $prevrawline); 5539 fix_delete_line($fixlinenr, $rawline); 5540 my $fixedline = $prevrawline; 5541 my $trailing = $rawline; 5542 $trailing =~ s/^\+//; 5543 $trailing = trim($trailing); 5544 $fixedline =~ s/}\s*$/} $trailing/; 5545 fix_insert_line($fixlinenr, $fixedline); 5546 } 5547 } 5548 } 5549 5550#Specific variable tests 5551 while ($line =~ m{($Constant|$Lval)}g) { 5552 my $var = $1; 5553 5554#CamelCase 5555 if ($var !~ /^$Constant$/ && 5556 $var =~ /[A-Z][a-z]|[a-z][A-Z]/ && 5557#Ignore some autogenerated defines and enum values 5558 $var !~ /^(?:[A-Z]+_){1,5}[A-Z]{1,3}[a-z]/ && 5559#Ignore Page<foo> variants 5560 $var !~ /^(?:Clear|Set|TestClear|TestSet|)Page[A-Z]/ && 5561#Ignore SI style variants like nS, mV and dB 5562#(ie: max_uV, regulator_min_uA_show, RANGE_mA_VALUE) 5563 $var !~ /^(?:[a-z0-9_]*|[A-Z0-9_]*)?_?[a-z][A-Z](?:_[a-z0-9_]+|_[A-Z0-9_]+)?$/ && 5564#Ignore some three character SI units explicitly, like MiB and KHz 5565 $var !~ /^(?:[a-z_]*?)_?(?:[KMGT]iB|[KMGT]?Hz)(?:_[a-z_]+)?$/) { 5566 while ($var =~ m{($Ident)}g) { 5567 my $word = $1; 5568 next if ($word !~ /[A-Z][a-z]|[a-z][A-Z]/); 5569 if ($check) { 5570 seed_camelcase_includes(); 5571 if (!$file && !$camelcase_file_seeded) { 5572 seed_camelcase_file($realfile); 5573 $camelcase_file_seeded = 1; 5574 } 5575 } 5576 if (!defined $camelcase{$word}) { 5577 $camelcase{$word} = 1; 5578 CHK("CAMELCASE", 5579 "Avoid CamelCase: <$word>\n" . $herecurr); 5580 } 5581 } 5582 } 5583 } 5584 5585#no spaces allowed after \ in define 5586 if ($line =~ /\#\s*define.*\\\s+$/) { 5587 if (WARN("WHITESPACE_AFTER_LINE_CONTINUATION", 5588 "Whitespace after \\ makes next lines useless\n" . $herecurr) && 5589 $fix) { 5590 $fixed[$fixlinenr] =~ s/\s+$//; 5591 } 5592 } 5593 5594# warn if <asm/foo.h> is #included and <linux/foo.h> is available and includes 5595# itself <asm/foo.h> (uses RAW line) 5596 if ($tree && $rawline =~ m{^.\s*\#\s*include\s*\<asm\/(.*)\.h\>}) { 5597 my $file = "$1.h"; 5598 my $checkfile = "include/linux/$file"; 5599 if (-f "$root/$checkfile" && 5600 $realfile ne $checkfile && 5601 $1 !~ /$allowed_asm_includes/) 5602 { 5603 my $asminclude = `grep -Ec "#include\\s+<asm/$file>" $root/$checkfile`; 5604 if ($asminclude > 0) { 5605 if ($realfile =~ m{^arch/}) { 5606 CHK("ARCH_INCLUDE_LINUX", 5607 "Consider using #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5608 } else { 5609 WARN("INCLUDE_LINUX", 5610 "Use #include <linux/$file> instead of <asm/$file>\n" . $herecurr); 5611 } 5612 } 5613 } 5614 } 5615 5616# multi-statement macros should be enclosed in a do while loop, grab the 5617# first statement and ensure its the whole macro if its not enclosed 5618# in a known good container 5619 if ($realfile !~ m@/vmlinux.lds.h$@ && 5620 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 5621 my $ln = $linenr; 5622 my $cnt = $realcnt; 5623 my ($off, $dstat, $dcond, $rest); 5624 my $ctx = ''; 5625 my $has_flow_statement = 0; 5626 my $has_arg_concat = 0; 5627 ($dstat, $dcond, $ln, $cnt, $off) = 5628 ctx_statement_block($linenr, $realcnt, 0); 5629 $ctx = $dstat; 5630 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 5631 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 5632 5633 $has_flow_statement = 1 if ($ctx =~ /\b(goto|return)\b/); 5634 $has_arg_concat = 1 if ($ctx =~ /\#\#/ && $ctx !~ /\#\#\s*(?:__VA_ARGS__|args)\b/); 5635 5636 $dstat =~ s/^.\s*\#\s*define\s+$Ident(\([^\)]*\))?\s*//; 5637 my $define_args = $1; 5638 my $define_stmt = $dstat; 5639 my @def_args = (); 5640 5641 if (defined $define_args && $define_args ne "") { 5642 $define_args = substr($define_args, 1, length($define_args) - 2); 5643 $define_args =~ s/\s*//g; 5644 $define_args =~ s/\\\+?//g; 5645 @def_args = split(",", $define_args); 5646 } 5647 5648 $dstat =~ s/$;//g; 5649 $dstat =~ s/\\\n.//g; 5650 $dstat =~ s/^\s*//s; 5651 $dstat =~ s/\s*$//s; 5652 5653 # Flatten any parentheses and braces 5654 while ($dstat =~ s/\([^\(\)]*\)/1u/ || 5655 $dstat =~ s/\{[^\{\}]*\}/1u/ || 5656 $dstat =~ s/.\[[^\[\]]*\]/1u/) 5657 { 5658 } 5659 5660 # Flatten any obvious string concatenation. 5661 while ($dstat =~ s/($String)\s*$Ident/$1/ || 5662 $dstat =~ s/$Ident\s*($String)/$1/) 5663 { 5664 } 5665 5666 # Make asm volatile uses seem like a generic function 5667 $dstat =~ s/\b_*asm_*\s+_*volatile_*\b/asm_volatile/g; 5668 5669 my $exceptions = qr{ 5670 $Declare| 5671 module_param_named| 5672 MODULE_PARM_DESC| 5673 DECLARE_PER_CPU| 5674 DEFINE_PER_CPU| 5675 __typeof__\(| 5676 union| 5677 struct| 5678 \.$Ident\s*=\s*| 5679 ^\"|\"$| 5680 ^\[ 5681 }x; 5682 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 5683 5684 $ctx =~ s/\n*$//; 5685 my $stmt_cnt = statement_rawlines($ctx); 5686 my $herectx = get_stat_here($linenr, $stmt_cnt, $here); 5687 5688 if ($dstat ne '' && 5689 $dstat !~ /^(?:$Ident|-?$Constant),$/ && # 10, // foo(), 5690 $dstat !~ /^(?:$Ident|-?$Constant);$/ && # foo(); 5691 $dstat !~ /^[!~-]?(?:$Lval|$Constant)$/ && # 10 // foo() // !foo // ~foo // -foo // foo->bar // foo.bar->baz 5692 $dstat !~ /^'X'$/ && $dstat !~ /^'XX'$/ && # character constants 5693 $dstat !~ /$exceptions/ && 5694 $dstat !~ /^\.$Ident\s*=/ && # .foo = 5695 $dstat !~ /^(?:\#\s*$Ident|\#\s*$Constant)\s*$/ && # stringification #foo 5696 $dstat !~ /^do\s*$Constant\s*while\s*$Constant;?$/ && # do {...} while (...); // do {...} while (...) 5697 $dstat !~ /^while\s*$Constant\s*$Constant\s*$/ && # while (...) {...} 5698 $dstat !~ /^for\s*$Constant$/ && # for (...) 5699 $dstat !~ /^for\s*$Constant\s+(?:$Ident|-?$Constant)$/ && # for (...) bar() 5700 $dstat !~ /^do\s*{/ && # do {... 5701 $dstat !~ /^\(\{/ && # ({... 5702 $ctx !~ /^.\s*#\s*define\s+TRACE_(?:SYSTEM|INCLUDE_FILE|INCLUDE_PATH)\b/) 5703 { 5704 if ($dstat =~ /^\s*if\b/) { 5705 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5706 "Macros starting with if should be enclosed by a do - while loop to avoid possible if/else logic defects\n" . "$herectx"); 5707 } elsif ($dstat =~ /;/) { 5708 ERROR("MULTISTATEMENT_MACRO_USE_DO_WHILE", 5709 "Macros with multiple statements should be enclosed in a do - while loop\n" . "$herectx"); 5710 } else { 5711 ERROR("COMPLEX_MACRO", 5712 "Macros with complex values should be enclosed in parentheses\n" . "$herectx"); 5713 } 5714 5715 } 5716 5717 # Make $define_stmt single line, comment-free, etc 5718 my @stmt_array = split('\n', $define_stmt); 5719 my $first = 1; 5720 $define_stmt = ""; 5721 foreach my $l (@stmt_array) { 5722 $l =~ s/\\$//; 5723 if ($first) { 5724 $define_stmt = $l; 5725 $first = 0; 5726 } elsif ($l =~ /^[\+ ]/) { 5727 $define_stmt .= substr($l, 1); 5728 } 5729 } 5730 $define_stmt =~ s/$;//g; 5731 $define_stmt =~ s/\s+/ /g; 5732 $define_stmt = trim($define_stmt); 5733 5734# check if any macro arguments are reused (ignore '...' and 'type') 5735 foreach my $arg (@def_args) { 5736 next if ($arg =~ /\.\.\./); 5737 next if ($arg =~ /^type$/i); 5738 my $tmp_stmt = $define_stmt; 5739 $tmp_stmt =~ s/\b(sizeof|typeof|__typeof__|__builtin\w+|typecheck\s*\(\s*$Type\s*,|\#+)\s*\(*\s*$arg\s*\)*\b//g; 5740 $tmp_stmt =~ s/\#+\s*$arg\b//g; 5741 $tmp_stmt =~ s/\b$arg\s*\#\#//g; 5742 my $use_cnt = () = $tmp_stmt =~ /\b$arg\b/g; 5743 if ($use_cnt > 1) { 5744 CHK("MACRO_ARG_REUSE", 5745 "Macro argument reuse '$arg' - possible side-effects?\n" . "$herectx"); 5746 } 5747# check if any macro arguments may have other precedence issues 5748 if ($tmp_stmt =~ m/($Operators)?\s*\b$arg\b\s*($Operators)?/m && 5749 ((defined($1) && $1 ne ',') || 5750 (defined($2) && $2 ne ','))) { 5751 CHK("MACRO_ARG_PRECEDENCE", 5752 "Macro argument '$arg' may be better as '($arg)' to avoid precedence issues\n" . "$herectx"); 5753 } 5754 } 5755 5756# check for macros with flow control, but without ## concatenation 5757# ## concatenation is commonly a macro that defines a function so ignore those 5758 if ($has_flow_statement && !$has_arg_concat) { 5759 my $cnt = statement_rawlines($ctx); 5760 my $herectx = get_stat_here($linenr, $cnt, $here); 5761 5762 WARN("MACRO_WITH_FLOW_CONTROL", 5763 "Macros with flow control statements should be avoided\n" . "$herectx"); 5764 } 5765 5766# check for line continuations outside of #defines, preprocessor #, and asm 5767 5768 } else { 5769 if ($prevline !~ /^..*\\$/ && 5770 $line !~ /^\+\s*\#.*\\$/ && # preprocessor 5771 $line !~ /^\+.*\b(__asm__|asm)\b.*\\$/ && # asm 5772 $line =~ /^\+.*\\$/) { 5773 WARN("LINE_CONTINUATIONS", 5774 "Avoid unnecessary line continuations\n" . $herecurr); 5775 } 5776 } 5777 5778# do {} while (0) macro tests: 5779# single-statement macros do not need to be enclosed in do while (0) loop, 5780# macro should not end with a semicolon 5781 if ($perl_version_ok && 5782 $realfile !~ m@/vmlinux.lds.h$@ && 5783 $line =~ /^.\s*\#\s*define\s+$Ident(\()?/) { 5784 my $ln = $linenr; 5785 my $cnt = $realcnt; 5786 my ($off, $dstat, $dcond, $rest); 5787 my $ctx = ''; 5788 ($dstat, $dcond, $ln, $cnt, $off) = 5789 ctx_statement_block($linenr, $realcnt, 0); 5790 $ctx = $dstat; 5791 5792 $dstat =~ s/\\\n.//g; 5793 $dstat =~ s/$;/ /g; 5794 5795 if ($dstat =~ /^\+\s*#\s*define\s+$Ident\s*${balanced_parens}\s*do\s*{(.*)\s*}\s*while\s*\(\s*0\s*\)\s*([;\s]*)\s*$/) { 5796 my $stmts = $2; 5797 my $semis = $3; 5798 5799 $ctx =~ s/\n*$//; 5800 my $cnt = statement_rawlines($ctx); 5801 my $herectx = get_stat_here($linenr, $cnt, $here); 5802 5803 if (($stmts =~ tr/;/;/) == 1 && 5804 $stmts !~ /^\s*(if|while|for|switch)\b/) { 5805 WARN("SINGLE_STATEMENT_DO_WHILE_MACRO", 5806 "Single statement macros should not use a do {} while (0) loop\n" . "$herectx"); 5807 } 5808 if (defined $semis && $semis ne "") { 5809 WARN("DO_WHILE_MACRO_WITH_TRAILING_SEMICOLON", 5810 "do {} while (0) macros should not be semicolon terminated\n" . "$herectx"); 5811 } 5812 } elsif ($dstat =~ /^\+\s*#\s*define\s+$Ident.*;\s*$/) { 5813 $ctx =~ s/\n*$//; 5814 my $cnt = statement_rawlines($ctx); 5815 my $herectx = get_stat_here($linenr, $cnt, $here); 5816 5817 WARN("TRAILING_SEMICOLON", 5818 "macros should not use a trailing semicolon\n" . "$herectx"); 5819 } 5820 } 5821 5822# check for redundant bracing round if etc 5823 if ($line =~ /(^.*)\bif\b/ && $1 !~ /else\s*$/) { 5824 my ($level, $endln, @chunks) = 5825 ctx_statement_full($linenr, $realcnt, 1); 5826 #print "chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 5827 #print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n"; 5828 if ($#chunks > 0 && $level == 0) { 5829 my @allowed = (); 5830 my $allow = 0; 5831 my $seen = 0; 5832 my $herectx = $here . "\n"; 5833 my $ln = $linenr - 1; 5834 for my $chunk (@chunks) { 5835 my ($cond, $block) = @{$chunk}; 5836 5837 # If the condition carries leading newlines, then count those as offsets. 5838 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 5839 my $offset = statement_rawlines($whitespace) - 1; 5840 5841 $allowed[$allow] = 0; 5842 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 5843 5844 # We have looked at and allowed this specific line. 5845 $suppress_ifbraces{$ln + $offset} = 1; 5846 5847 $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 5848 $ln += statement_rawlines($block) - 1; 5849 5850 substr($block, 0, length($cond), ''); 5851 5852 $seen++ if ($block =~ /^\s*{/); 5853 5854 #print "cond<$cond> block<$block> allowed<$allowed[$allow]>\n"; 5855 if (statement_lines($cond) > 1) { 5856 #print "APW: ALLOWED: cond<$cond>\n"; 5857 $allowed[$allow] = 1; 5858 } 5859 if ($block =~/\b(?:if|for|while)\b/) { 5860 #print "APW: ALLOWED: block<$block>\n"; 5861 $allowed[$allow] = 1; 5862 } 5863 if (statement_block_size($block) > 1) { 5864 #print "APW: ALLOWED: lines block<$block>\n"; 5865 $allowed[$allow] = 1; 5866 } 5867 $allow++; 5868 } 5869 if ($seen) { 5870 my $sum_allowed = 0; 5871 foreach (@allowed) { 5872 $sum_allowed += $_; 5873 } 5874 if ($sum_allowed == 0) { 5875 WARN("BRACES", 5876 "braces {} are not necessary for any arm of this statement\n" . $herectx); 5877 } elsif ($sum_allowed != $allow && 5878 $seen != $allow) { 5879 CHK("BRACES", 5880 "braces {} should be used on all arms of this statement\n" . $herectx); 5881 } 5882 } 5883 } 5884 } 5885 if (!defined $suppress_ifbraces{$linenr - 1} && 5886 $line =~ /\b(if|while|for|else)\b/) { 5887 my $allowed = 0; 5888 5889 # Check the pre-context. 5890 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 5891 #print "APW: ALLOWED: pre<$1>\n"; 5892 $allowed = 1; 5893 } 5894 5895 my ($level, $endln, @chunks) = 5896 ctx_statement_full($linenr, $realcnt, $-[0]); 5897 5898 # Check the condition. 5899 my ($cond, $block) = @{$chunks[0]}; 5900 #print "CHECKING<$linenr> cond<$cond> block<$block>\n"; 5901 if (defined $cond) { 5902 substr($block, 0, length($cond), ''); 5903 } 5904 if (statement_lines($cond) > 1) { 5905 #print "APW: ALLOWED: cond<$cond>\n"; 5906 $allowed = 1; 5907 } 5908 if ($block =~/\b(?:if|for|while)\b/) { 5909 #print "APW: ALLOWED: block<$block>\n"; 5910 $allowed = 1; 5911 } 5912 if (statement_block_size($block) > 1) { 5913 #print "APW: ALLOWED: lines block<$block>\n"; 5914 $allowed = 1; 5915 } 5916 # Check the post-context. 5917 if (defined $chunks[1]) { 5918 my ($cond, $block) = @{$chunks[1]}; 5919 if (defined $cond) { 5920 substr($block, 0, length($cond), ''); 5921 } 5922 if ($block =~ /^\s*\{/) { 5923 #print "APW: ALLOWED: chunk-1 block<$block>\n"; 5924 $allowed = 1; 5925 } 5926 } 5927 if ($level == 0 && $block =~ /^\s*\{/ && !$allowed) { 5928 my $cnt = statement_rawlines($block); 5929 my $herectx = get_stat_here($linenr, $cnt, $here); 5930 5931 WARN("BRACES", 5932 "braces {} are not necessary for single statement blocks\n" . $herectx); 5933 } 5934 } 5935 5936# check for single line unbalanced braces 5937 if ($sline =~ /^.\s*\}\s*else\s*$/ || 5938 $sline =~ /^.\s*else\s*\{\s*$/) { 5939 CHK("BRACES", "Unbalanced braces around else statement\n" . $herecurr); 5940 } 5941 5942# check for unnecessary blank lines around braces 5943 if (($line =~ /^.\s*}\s*$/ && $prevrawline =~ /^.\s*$/)) { 5944 if (CHK("BRACES", 5945 "Blank lines aren't necessary before a close brace '}'\n" . $hereprev) && 5946 $fix && $prevrawline =~ /^\+/) { 5947 fix_delete_line($fixlinenr - 1, $prevrawline); 5948 } 5949 } 5950 if (($rawline =~ /^.\s*$/ && $prevline =~ /^..*{\s*$/)) { 5951 if (CHK("BRACES", 5952 "Blank lines aren't necessary after an open brace '{'\n" . $hereprev) && 5953 $fix) { 5954 fix_delete_line($fixlinenr, $rawline); 5955 } 5956 } 5957 5958# no volatiles please 5959 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 5960 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/) { 5961 WARN("VOLATILE", 5962 "Use of volatile is usually wrong: see Documentation/process/volatile-considered-harmful.rst\n" . $herecurr); 5963 } 5964 5965# Check for user-visible strings broken across lines, which breaks the ability 5966# to grep for the string. Make exceptions when the previous string ends in a 5967# newline (multiple lines in one string constant) or '\t', '\r', ';', or '{' 5968# (common in inline assembly) or is a octal \123 or hexadecimal \xaf value 5969 if ($line =~ /^\+\s*$String/ && 5970 $prevline =~ /"\s*$/ && 5971 $prevrawline !~ /(?:\\(?:[ntr]|[0-7]{1,3}|x[0-9a-fA-F]{1,2})|;\s*|\{\s*)"\s*$/) { 5972 if (WARN("SPLIT_STRING", 5973 "quoted string split across lines\n" . $hereprev) && 5974 $fix && 5975 $prevrawline =~ /^\+.*"\s*$/ && 5976 $last_coalesced_string_linenr != $linenr - 1) { 5977 my $extracted_string = get_quoted_string($line, $rawline); 5978 my $comma_close = ""; 5979 if ($rawline =~ /\Q$extracted_string\E(\s*\)\s*;\s*$|\s*,\s*)/) { 5980 $comma_close = $1; 5981 } 5982 5983 fix_delete_line($fixlinenr - 1, $prevrawline); 5984 fix_delete_line($fixlinenr, $rawline); 5985 my $fixedline = $prevrawline; 5986 $fixedline =~ s/"\s*$//; 5987 $fixedline .= substr($extracted_string, 1) . trim($comma_close); 5988 fix_insert_line($fixlinenr - 1, $fixedline); 5989 $fixedline = $rawline; 5990 $fixedline =~ s/\Q$extracted_string\E\Q$comma_close\E//; 5991 if ($fixedline !~ /\+\s*$/) { 5992 fix_insert_line($fixlinenr, $fixedline); 5993 } 5994 $last_coalesced_string_linenr = $linenr; 5995 } 5996 } 5997 5998# check for missing a space in a string concatenation 5999 if ($prevrawline =~ /[^\\]\w"$/ && $rawline =~ /^\+[\t ]+"\w/) { 6000 WARN('MISSING_SPACE', 6001 "break quoted strings at a space character\n" . $hereprev); 6002 } 6003 6004# check for an embedded function name in a string when the function is known 6005# This does not work very well for -f --file checking as it depends on patch 6006# context providing the function name or a single line form for in-file 6007# function declarations 6008 if ($line =~ /^\+.*$String/ && 6009 defined($context_function) && 6010 get_quoted_string($line, $rawline) =~ /\b$context_function\b/ && 6011 length(get_quoted_string($line, $rawline)) != (length($context_function) + 2)) { 6012 WARN("EMBEDDED_FUNCTION_NAME", 6013 "Prefer using '\"%s...\", __func__' to using '$context_function', this function's name, in a string\n" . $herecurr); 6014 } 6015 6016# check for unnecessary function tracing like uses 6017# This does not use $logFunctions because there are many instances like 6018# 'dprintk(FOO, "%s()\n", __func__);' which do not match $logFunctions 6019 if ($rawline =~ /^\+.*\([^"]*"$tracing_logging_tags{0,3}%s(?:\s*\(\s*\)\s*)?$tracing_logging_tags{0,3}(?:\\n)?"\s*,\s*__func__\s*\)\s*;/) { 6020 if (WARN("TRACING_LOGGING", 6021 "Unnecessary ftrace-like logging - prefer using ftrace\n" . $herecurr) && 6022 $fix) { 6023 fix_delete_line($fixlinenr, $rawline); 6024 } 6025 } 6026 6027# check for spaces before a quoted newline 6028 if ($rawline =~ /^.*\".*\s\\n/) { 6029 if (WARN("QUOTED_WHITESPACE_BEFORE_NEWLINE", 6030 "unnecessary whitespace before a quoted newline\n" . $herecurr) && 6031 $fix) { 6032 $fixed[$fixlinenr] =~ s/^(\+.*\".*)\s+\\n/$1\\n/; 6033 } 6034 6035 } 6036 6037# concatenated string without spaces between elements 6038 if ($line =~ /$String[A-Za-z0-9_]/ || $line =~ /[A-Za-z0-9_]$String/) { 6039 if (CHK("CONCATENATED_STRING", 6040 "Concatenated strings should use spaces between elements\n" . $herecurr) && 6041 $fix) { 6042 while ($line =~ /($String)/g) { 6043 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 6044 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E([A-Za-z0-9_])/$extracted_string $1/; 6045 $fixed[$fixlinenr] =~ s/([A-Za-z0-9_])\Q$extracted_string\E/$1 $extracted_string/; 6046 } 6047 } 6048 } 6049 6050# uncoalesced string fragments 6051 if ($line =~ /$String\s*"/) { 6052 if (WARN("STRING_FRAGMENTS", 6053 "Consecutive strings are generally better as a single string\n" . $herecurr) && 6054 $fix) { 6055 while ($line =~ /($String)(?=\s*")/g) { 6056 my $extracted_string = substr($rawline, $-[0], $+[0] - $-[0]); 6057 $fixed[$fixlinenr] =~ s/\Q$extracted_string\E\s*"/substr($extracted_string, 0, -1)/e; 6058 } 6059 } 6060 } 6061 6062# check for non-standard and hex prefixed decimal printf formats 6063 my $show_L = 1; #don't show the same defect twice 6064 my $show_Z = 1; 6065 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 6066 my $string = substr($rawline, $-[1], $+[1] - $-[1]); 6067 $string =~ s/%%/__/g; 6068 # check for %L 6069 if ($show_L && $string =~ /%[\*\d\.\$]*L([diouxX])/) { 6070 WARN("PRINTF_L", 6071 "\%L$1 is non-standard C, use %ll$1\n" . $herecurr); 6072 $show_L = 0; 6073 } 6074 # check for %Z 6075 if ($show_Z && $string =~ /%[\*\d\.\$]*Z([diouxX])/) { 6076 WARN("PRINTF_Z", 6077 "%Z$1 is non-standard C, use %z$1\n" . $herecurr); 6078 $show_Z = 0; 6079 } 6080 # check for 0x<decimal> 6081 if ($string =~ /0x%[\*\d\.\$\Llzth]*[diou]/) { 6082 ERROR("PRINTF_0XDECIMAL", 6083 "Prefixing 0x with decimal output is defective\n" . $herecurr); 6084 } 6085 } 6086 6087# check for line continuations in quoted strings with odd counts of " 6088 if ($rawline =~ /\\$/ && $sline =~ tr/"/"/ % 2) { 6089 WARN("LINE_CONTINUATIONS", 6090 "Avoid line continuations in quoted strings\n" . $herecurr); 6091 } 6092 6093# warn about #if 0 6094 if ($line =~ /^.\s*\#\s*if\s+0\b/) { 6095 WARN("IF_0", 6096 "Consider removing the code enclosed by this #if 0 and its #endif\n" . $herecurr); 6097 } 6098 6099# warn about #if 1 6100 if ($line =~ /^.\s*\#\s*if\s+1\b/) { 6101 WARN("IF_1", 6102 "Consider removing the #if 1 and its #endif\n" . $herecurr); 6103 } 6104 6105# check for needless "if (<foo>) fn(<foo>)" uses 6106 if ($prevline =~ /\bif\s*\(\s*($Lval)\s*\)/) { 6107 my $tested = quotemeta($1); 6108 my $expr = '\s*\(\s*' . $tested . '\s*\)\s*;'; 6109 if ($line =~ /\b(kfree|usb_free_urb|debugfs_remove(?:_recursive)?|(?:kmem_cache|mempool|dma_pool)_destroy)$expr/) { 6110 my $func = $1; 6111 if (WARN('NEEDLESS_IF', 6112 "$func(NULL) is safe and this check is probably not required\n" . $hereprev) && 6113 $fix) { 6114 my $do_fix = 1; 6115 my $leading_tabs = ""; 6116 my $new_leading_tabs = ""; 6117 if ($lines[$linenr - 2] =~ /^\+(\t*)if\s*\(\s*$tested\s*\)\s*$/) { 6118 $leading_tabs = $1; 6119 } else { 6120 $do_fix = 0; 6121 } 6122 if ($lines[$linenr - 1] =~ /^\+(\t+)$func\s*\(\s*$tested\s*\)\s*;\s*$/) { 6123 $new_leading_tabs = $1; 6124 if (length($leading_tabs) + 1 ne length($new_leading_tabs)) { 6125 $do_fix = 0; 6126 } 6127 } else { 6128 $do_fix = 0; 6129 } 6130 if ($do_fix) { 6131 fix_delete_line($fixlinenr - 1, $prevrawline); 6132 $fixed[$fixlinenr] =~ s/^\+$new_leading_tabs/\+$leading_tabs/; 6133 } 6134 } 6135 } 6136 } 6137 6138# check for unnecessary "Out of Memory" messages 6139 if ($line =~ /^\+.*\b$logFunctions\s*\(/ && 6140 $prevline =~ /^[ \+]\s*if\s*\(\s*(\!\s*|NULL\s*==\s*)?($Lval)(\s*==\s*NULL\s*)?\s*\)/ && 6141 (defined $1 || defined $3) && 6142 $linenr > 3) { 6143 my $testval = $2; 6144 my $testline = $lines[$linenr - 3]; 6145 6146 my ($s, $c) = ctx_statement_block($linenr - 3, $realcnt, 0); 6147# print("line: <$line>\nprevline: <$prevline>\ns: <$s>\nc: <$c>\n\n\n"); 6148 6149 if ($s =~ /(?:^|\n)[ \+]\s*(?:$Type\s*)?\Q$testval\E\s*=\s*(?:\([^\)]*\)\s*)?\s*$allocFunctions\s*\(/ && 6150 $s !~ /\b__GFP_NOWARN\b/ ) { 6151 WARN("OOM_MESSAGE", 6152 "Possible unnecessary 'out of memory' message\n" . $hereprev); 6153 } 6154 } 6155 6156# check for logging functions with KERN_<LEVEL> 6157 if ($line !~ /printk(?:_ratelimited|_once)?\s*\(/ && 6158 $line =~ /\b$logFunctions\s*\(.*\b(KERN_[A-Z]+)\b/) { 6159 my $level = $1; 6160 if (WARN("UNNECESSARY_KERN_LEVEL", 6161 "Possible unnecessary $level\n" . $herecurr) && 6162 $fix) { 6163 $fixed[$fixlinenr] =~ s/\s*$level\s*//; 6164 } 6165 } 6166 6167# check for logging continuations 6168 if ($line =~ /\bprintk\s*\(\s*KERN_CONT\b|\bpr_cont\s*\(/) { 6169 WARN("LOGGING_CONTINUATION", 6170 "Avoid logging continuation uses where feasible\n" . $herecurr); 6171 } 6172 6173# check for unnecessary use of %h[xudi] and %hh[xudi] in logging functions 6174 if (defined $stat && 6175 $line =~ /\b$logFunctions\s*\(/ && 6176 index($stat, '"') >= 0) { 6177 my $lc = $stat =~ tr@\n@@; 6178 $lc = $lc + $linenr; 6179 my $stat_real = get_stat_real($linenr, $lc); 6180 pos($stat_real) = index($stat_real, '"'); 6181 while ($stat_real =~ /[^\"%]*(%[\#\d\.\*\-]*(h+)[idux])/g) { 6182 my $pspec = $1; 6183 my $h = $2; 6184 my $lineoff = substr($stat_real, 0, $-[1]) =~ tr@\n@@; 6185 if (WARN("UNNECESSARY_MODIFIER", 6186 "Integer promotion: Using '$h' in '$pspec' is unnecessary\n" . "$here\n$stat_real\n") && 6187 $fix && $fixed[$fixlinenr + $lineoff] =~ /^\+/) { 6188 my $nspec = $pspec; 6189 $nspec =~ s/h//g; 6190 $fixed[$fixlinenr + $lineoff] =~ s/\Q$pspec\E/$nspec/; 6191 } 6192 } 6193 } 6194 6195# check for mask then right shift without a parentheses 6196 if ($perl_version_ok && 6197 $line =~ /$LvalOrFunc\s*\&\s*($LvalOrFunc)\s*>>/ && 6198 $4 !~ /^\&/) { # $LvalOrFunc may be &foo, ignore if so 6199 WARN("MASK_THEN_SHIFT", 6200 "Possible precedence defect with mask then right shift - may need parentheses\n" . $herecurr); 6201 } 6202 6203# check for pointer comparisons to NULL 6204 if ($perl_version_ok) { 6205 while ($line =~ /\b$LvalOrFunc\s*(==|\!=)\s*NULL\b/g) { 6206 my $val = $1; 6207 my $equal = "!"; 6208 $equal = "" if ($4 eq "!="); 6209 if (CHK("COMPARISON_TO_NULL", 6210 "Comparison to NULL could be written \"${equal}${val}\"\n" . $herecurr) && 6211 $fix) { 6212 $fixed[$fixlinenr] =~ s/\b\Q$val\E\s*(?:==|\!=)\s*NULL\b/$equal$val/; 6213 } 6214 } 6215 } 6216 6217# check for bad placement of section $InitAttribute (e.g.: __initdata) 6218 if ($line =~ /(\b$InitAttribute\b)/) { 6219 my $attr = $1; 6220 if ($line =~ /^\+\s*static\s+(?:const\s+)?(?:$attr\s+)?($NonptrTypeWithAttr)\s+(?:$attr\s+)?($Ident(?:\[[^]]*\])?)\s*[=;]/) { 6221 my $ptr = $1; 6222 my $var = $2; 6223 if ((($ptr =~ /\b(union|struct)\s+$attr\b/ && 6224 ERROR("MISPLACED_INIT", 6225 "$attr should be placed after $var\n" . $herecurr)) || 6226 ($ptr !~ /\b(union|struct)\s+$attr\b/ && 6227 WARN("MISPLACED_INIT", 6228 "$attr should be placed after $var\n" . $herecurr))) && 6229 $fix) { 6230 $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; 6231 } 6232 } 6233 } 6234 6235# check for $InitAttributeData (ie: __initdata) with const 6236 if ($line =~ /\bconst\b/ && $line =~ /($InitAttributeData)/) { 6237 my $attr = $1; 6238 $attr =~ /($InitAttributePrefix)(.*)/; 6239 my $attr_prefix = $1; 6240 my $attr_type = $2; 6241 if (ERROR("INIT_ATTRIBUTE", 6242 "Use of const init definition must use ${attr_prefix}initconst\n" . $herecurr) && 6243 $fix) { 6244 $fixed[$fixlinenr] =~ 6245 s/$InitAttributeData/${attr_prefix}initconst/; 6246 } 6247 } 6248 6249# check for $InitAttributeConst (ie: __initconst) without const 6250 if ($line !~ /\bconst\b/ && $line =~ /($InitAttributeConst)/) { 6251 my $attr = $1; 6252 if (ERROR("INIT_ATTRIBUTE", 6253 "Use of $attr requires a separate use of const\n" . $herecurr) && 6254 $fix) { 6255 my $lead = $fixed[$fixlinenr] =~ 6256 /(^\+\s*(?:static\s+))/; 6257 $lead = rtrim($1); 6258 $lead = "$lead " if ($lead !~ /^\+$/); 6259 $lead = "${lead}const "; 6260 $fixed[$fixlinenr] =~ s/(^\+\s*(?:static\s+))/$lead/; 6261 } 6262 } 6263 6264# check for __read_mostly with const non-pointer (should just be const) 6265 if ($line =~ /\b__read_mostly\b/ && 6266 $line =~ /($Type)\s*$Ident/ && $1 !~ /\*\s*$/ && $1 =~ /\bconst\b/) { 6267 if (ERROR("CONST_READ_MOSTLY", 6268 "Invalid use of __read_mostly with const type\n" . $herecurr) && 6269 $fix) { 6270 $fixed[$fixlinenr] =~ s/\s+__read_mostly\b//; 6271 } 6272 } 6273 6274# don't use __constant_<foo> functions outside of include/uapi/ 6275 if ($realfile !~ m@^include/uapi/@ && 6276 $line =~ /(__constant_(?:htons|ntohs|[bl]e(?:16|32|64)_to_cpu|cpu_to_[bl]e(?:16|32|64)))\s*\(/) { 6277 my $constant_func = $1; 6278 my $func = $constant_func; 6279 $func =~ s/^__constant_//; 6280 if (WARN("CONSTANT_CONVERSION", 6281 "$constant_func should be $func\n" . $herecurr) && 6282 $fix) { 6283 $fixed[$fixlinenr] =~ s/\b$constant_func\b/$func/g; 6284 } 6285 } 6286 6287# prefer usleep_range over udelay 6288 if ($line =~ /\budelay\s*\(\s*(\d+)\s*\)/) { 6289 my $delay = $1; 6290 # ignore udelay's < 10, however 6291 if (! ($delay < 10) ) { 6292 CHK("USLEEP_RANGE", 6293 "usleep_range is preferred over udelay; see Documentation/timers/timers-howto.rst\n" . $herecurr); 6294 } 6295 if ($delay > 2000) { 6296 WARN("LONG_UDELAY", 6297 "long udelay - prefer mdelay; see arch/arm/include/asm/delay.h\n" . $herecurr); 6298 } 6299 } 6300 6301# warn about unexpectedly long msleep's 6302 if ($line =~ /\bmsleep\s*\((\d+)\);/) { 6303 if ($1 < 20) { 6304 WARN("MSLEEP", 6305 "msleep < 20ms can sleep for up to 20ms; see Documentation/timers/timers-howto.rst\n" . $herecurr); 6306 } 6307 } 6308 6309# check for comparisons of jiffies 6310 if ($line =~ /\bjiffies\s*$Compare|$Compare\s*jiffies\b/) { 6311 WARN("JIFFIES_COMPARISON", 6312 "Comparing jiffies is almost always wrong; prefer time_after, time_before and friends\n" . $herecurr); 6313 } 6314 6315# check for comparisons of get_jiffies_64() 6316 if ($line =~ /\bget_jiffies_64\s*\(\s*\)\s*$Compare|$Compare\s*get_jiffies_64\s*\(\s*\)/) { 6317 WARN("JIFFIES_COMPARISON", 6318 "Comparing get_jiffies_64() is almost always wrong; prefer time_after64, time_before64 and friends\n" . $herecurr); 6319 } 6320 6321# warn about #ifdefs in C files 6322# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 6323# print "#ifdef in C files should be avoided\n"; 6324# print "$herecurr"; 6325# $clean = 0; 6326# } 6327 6328# warn about spacing in #ifdefs 6329 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 6330 if (ERROR("SPACING", 6331 "exactly one space required after that #$1\n" . $herecurr) && 6332 $fix) { 6333 $fixed[$fixlinenr] =~ 6334 s/^(.\s*\#\s*(ifdef|ifndef|elif))\s{2,}/$1 /; 6335 } 6336 6337 } 6338 6339# check for spinlock_t definitions without a comment. 6340 if ($line =~ /^.\s*(struct\s+mutex|spinlock_t)\s+\S+;/ || 6341 $line =~ /^.\s*(DEFINE_MUTEX)\s*\(/) { 6342 my $which = $1; 6343 if (!ctx_has_comment($first_line, $linenr)) { 6344 CHK("UNCOMMENTED_DEFINITION", 6345 "$1 definition without comment\n" . $herecurr); 6346 } 6347 } 6348# check for memory barriers without a comment. 6349 6350 my $barriers = qr{ 6351 mb| 6352 rmb| 6353 wmb 6354 }x; 6355 my $barrier_stems = qr{ 6356 mb__before_atomic| 6357 mb__after_atomic| 6358 store_release| 6359 load_acquire| 6360 store_mb| 6361 (?:$barriers) 6362 }x; 6363 my $all_barriers = qr{ 6364 (?:$barriers)| 6365 smp_(?:$barrier_stems)| 6366 virt_(?:$barrier_stems) 6367 }x; 6368 6369 if ($line =~ /\b(?:$all_barriers)\s*\(/) { 6370 if (!ctx_has_comment($first_line, $linenr)) { 6371 WARN("MEMORY_BARRIER", 6372 "memory barrier without comment\n" . $herecurr); 6373 } 6374 } 6375 6376 my $underscore_smp_barriers = qr{__smp_(?:$barrier_stems)}x; 6377 6378 if ($realfile !~ m@^include/asm-generic/@ && 6379 $realfile !~ m@/barrier\.h$@ && 6380 $line =~ m/\b(?:$underscore_smp_barriers)\s*\(/ && 6381 $line !~ m/^.\s*\#\s*define\s+(?:$underscore_smp_barriers)\s*\(/) { 6382 WARN("MEMORY_BARRIER", 6383 "__smp memory barriers shouldn't be used outside barrier.h and asm-generic\n" . $herecurr); 6384 } 6385 6386# check for waitqueue_active without a comment. 6387 if ($line =~ /\bwaitqueue_active\s*\(/) { 6388 if (!ctx_has_comment($first_line, $linenr)) { 6389 WARN("WAITQUEUE_ACTIVE", 6390 "waitqueue_active without comment\n" . $herecurr); 6391 } 6392 } 6393 6394# check for data_race without a comment. 6395 if ($line =~ /\bdata_race\s*\(/) { 6396 if (!ctx_has_comment($first_line, $linenr)) { 6397 WARN("DATA_RACE", 6398 "data_race without comment\n" . $herecurr); 6399 } 6400 } 6401 6402# check of hardware specific defines 6403 if ($line =~ m@^.\s*\#\s*if.*\b(__i386__|__powerpc64__|__sun__|__s390x__)\b@ && $realfile !~ m@include/asm-@) { 6404 CHK("ARCH_DEFINES", 6405 "architecture specific defines should be avoided\n" . $herecurr); 6406 } 6407 6408# check that the storage class is not after a type 6409 if ($line =~ /\b($Type)\s+($Storage)\b/) { 6410 WARN("STORAGE_CLASS", 6411 "storage class '$2' should be located before type '$1'\n" . $herecurr); 6412 } 6413# Check that the storage class is at the beginning of a declaration 6414 if ($line =~ /\b$Storage\b/ && 6415 $line !~ /^.\s*$Storage/ && 6416 $line =~ /^.\s*(.+?)\$Storage\s/ && 6417 $1 !~ /[\,\)]\s*$/) { 6418 WARN("STORAGE_CLASS", 6419 "storage class should be at the beginning of the declaration\n" . $herecurr); 6420 } 6421 6422# check the location of the inline attribute, that it is between 6423# storage class and type. 6424 if ($line =~ /\b$Type\s+$Inline\b/ || 6425 $line =~ /\b$Inline\s+$Storage\b/) { 6426 ERROR("INLINE_LOCATION", 6427 "inline keyword should sit between storage class and type\n" . $herecurr); 6428 } 6429 6430# Check for __inline__ and __inline, prefer inline 6431 if ($realfile !~ m@\binclude/uapi/@ && 6432 $line =~ /\b(__inline__|__inline)\b/) { 6433 if (WARN("INLINE", 6434 "plain inline is preferred over $1\n" . $herecurr) && 6435 $fix) { 6436 $fixed[$fixlinenr] =~ s/\b(__inline__|__inline)\b/inline/; 6437 6438 } 6439 } 6440 6441# Check for compiler attributes 6442 if ($realfile !~ m@\binclude/uapi/@ && 6443 $rawline =~ /\b__attribute__\s*\(\s*($balanced_parens)\s*\)/) { 6444 my $attr = $1; 6445 $attr =~ s/\s*\(\s*(.*)\)\s*/$1/; 6446 6447 my %attr_list = ( 6448 "alias" => "__alias", 6449 "aligned" => "__aligned", 6450 "always_inline" => "__always_inline", 6451 "assume_aligned" => "__assume_aligned", 6452 "cold" => "__cold", 6453 "const" => "__attribute_const__", 6454 "copy" => "__copy", 6455 "designated_init" => "__designated_init", 6456 "externally_visible" => "__visible", 6457 "format" => "printf|scanf", 6458 "gnu_inline" => "__gnu_inline", 6459 "malloc" => "__malloc", 6460 "mode" => "__mode", 6461 "no_caller_saved_registers" => "__no_caller_saved_registers", 6462 "noclone" => "__noclone", 6463 "noinline" => "noinline", 6464 "nonstring" => "__nonstring", 6465 "noreturn" => "__noreturn", 6466 "packed" => "__packed", 6467 "pure" => "__pure", 6468 "section" => "__section", 6469 "used" => "__used", 6470 "weak" => "__weak" 6471 ); 6472 6473 while ($attr =~ /\s*(\w+)\s*(${balanced_parens})?/g) { 6474 my $orig_attr = $1; 6475 my $params = ''; 6476 $params = $2 if defined($2); 6477 my $curr_attr = $orig_attr; 6478 $curr_attr =~ s/^[\s_]+|[\s_]+$//g; 6479 if (exists($attr_list{$curr_attr})) { 6480 my $new = $attr_list{$curr_attr}; 6481 if ($curr_attr eq "format" && $params) { 6482 $params =~ /^\s*\(\s*(\w+)\s*,\s*(.*)/; 6483 $new = "__$1\($2"; 6484 } else { 6485 $new = "$new$params"; 6486 } 6487 if (WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", 6488 "Prefer $new over __attribute__(($orig_attr$params))\n" . $herecurr) && 6489 $fix) { 6490 my $remove = "\Q$orig_attr\E" . '\s*' . "\Q$params\E" . '(?:\s*,\s*)?'; 6491 $fixed[$fixlinenr] =~ s/$remove//; 6492 $fixed[$fixlinenr] =~ s/\b__attribute__/$new __attribute__/; 6493 $fixed[$fixlinenr] =~ s/\}\Q$new\E/} $new/; 6494 $fixed[$fixlinenr] =~ s/ __attribute__\s*\(\s*\(\s*\)\s*\)//; 6495 } 6496 } 6497 } 6498 6499 # Check for __attribute__ unused, prefer __always_unused or __maybe_unused 6500 if ($attr =~ /^_*unused/) { 6501 WARN("PREFER_DEFINED_ATTRIBUTE_MACRO", 6502 "__always_unused or __maybe_unused is preferred over __attribute__((__unused__))\n" . $herecurr); 6503 } 6504 } 6505 6506# Check for __attribute__ weak, or __weak declarations (may have link issues) 6507 if ($perl_version_ok && 6508 $line =~ /(?:$Declare|$DeclareMisordered)\s*$Ident\s*$balanced_parens\s*(?:$Attribute)?\s*;/ && 6509 ($line =~ /\b__attribute__\s*\(\s*\(.*\bweak\b/ || 6510 $line =~ /\b__weak\b/)) { 6511 ERROR("WEAK_DECLARATION", 6512 "Using weak declarations can have unintended link defects\n" . $herecurr); 6513 } 6514 6515# check for c99 types like uint8_t used outside of uapi/ and tools/ 6516 if ($realfile !~ m@\binclude/uapi/@ && 6517 $realfile !~ m@\btools/@ && 6518 $line =~ /\b($Declare)\s*$Ident\s*[=;,\[]/) { 6519 my $type = $1; 6520 if ($type =~ /\b($typeC99Typedefs)\b/) { 6521 $type = $1; 6522 my $kernel_type = 'u'; 6523 $kernel_type = 's' if ($type =~ /^_*[si]/); 6524 $type =~ /(\d+)/; 6525 $kernel_type .= $1; 6526 if (CHK("PREFER_KERNEL_TYPES", 6527 "Prefer kernel type '$kernel_type' over '$type'\n" . $herecurr) && 6528 $fix) { 6529 $fixed[$fixlinenr] =~ s/\b$type\b/$kernel_type/; 6530 } 6531 } 6532 } 6533 6534# check for cast of C90 native int or longer types constants 6535 if ($line =~ /(\(\s*$C90_int_types\s*\)\s*)($Constant)\b/) { 6536 my $cast = $1; 6537 my $const = $2; 6538 my $suffix = ""; 6539 my $newconst = $const; 6540 $newconst =~ s/${Int_type}$//; 6541 $suffix .= 'U' if ($cast =~ /\bunsigned\b/); 6542 if ($cast =~ /\blong\s+long\b/) { 6543 $suffix .= 'LL'; 6544 } elsif ($cast =~ /\blong\b/) { 6545 $suffix .= 'L'; 6546 } 6547 if (WARN("TYPECAST_INT_CONSTANT", 6548 "Unnecessary typecast of c90 int constant - '$cast$const' could be '$const$suffix'\n" . $herecurr) && 6549 $fix) { 6550 $fixed[$fixlinenr] =~ s/\Q$cast\E$const\b/$newconst$suffix/; 6551 } 6552 } 6553 6554# check for sizeof(&) 6555 if ($line =~ /\bsizeof\s*\(\s*\&/) { 6556 WARN("SIZEOF_ADDRESS", 6557 "sizeof(& should be avoided\n" . $herecurr); 6558 } 6559 6560# check for sizeof without parenthesis 6561 if ($line =~ /\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/) { 6562 if (WARN("SIZEOF_PARENTHESIS", 6563 "sizeof $1 should be sizeof($1)\n" . $herecurr) && 6564 $fix) { 6565 $fixed[$fixlinenr] =~ s/\bsizeof\s+((?:\*\s*|)$Lval|$Type(?:\s+$Lval|))/"sizeof(" . trim($1) . ")"/ex; 6566 } 6567 } 6568 6569# check for struct spinlock declarations 6570 if ($line =~ /^.\s*\bstruct\s+spinlock\s+\w+\s*;/) { 6571 WARN("USE_SPINLOCK_T", 6572 "struct spinlock should be spinlock_t\n" . $herecurr); 6573 } 6574 6575# check for seq_printf uses that could be seq_puts 6576 if ($sline =~ /\bseq_printf\s*\(.*"\s*\)\s*;\s*$/) { 6577 my $fmt = get_quoted_string($line, $rawline); 6578 $fmt =~ s/%%//g; 6579 if ($fmt !~ /%/) { 6580 if (WARN("PREFER_SEQ_PUTS", 6581 "Prefer seq_puts to seq_printf\n" . $herecurr) && 6582 $fix) { 6583 $fixed[$fixlinenr] =~ s/\bseq_printf\b/seq_puts/; 6584 } 6585 } 6586 } 6587 6588# check for vsprintf extension %p<foo> misuses 6589 if ($perl_version_ok && 6590 defined $stat && 6591 $stat =~ /^\+(?![^\{]*\{\s*).*\b(\w+)\s*\(.*$String\s*,/s && 6592 $1 !~ /^_*volatile_*$/) { 6593 my $stat_real; 6594 6595 my $lc = $stat =~ tr@\n@@; 6596 $lc = $lc + $linenr; 6597 for (my $count = $linenr; $count <= $lc; $count++) { 6598 my $specifier; 6599 my $extension; 6600 my $qualifier; 6601 my $bad_specifier = ""; 6602 my $fmt = get_quoted_string($lines[$count - 1], raw_line($count, 0)); 6603 $fmt =~ s/%%//g; 6604 6605 while ($fmt =~ /(\%[\*\d\.]*p(\w)(\w*))/g) { 6606 $specifier = $1; 6607 $extension = $2; 6608 $qualifier = $3; 6609 if ($extension !~ /[SsBKRraEehMmIiUDdgVCbGNOxtf]/ || 6610 ($extension eq "f" && 6611 defined $qualifier && $qualifier !~ /^w/)) { 6612 $bad_specifier = $specifier; 6613 last; 6614 } 6615 if ($extension eq "x" && !defined($stat_real)) { 6616 if (!defined($stat_real)) { 6617 $stat_real = get_stat_real($linenr, $lc); 6618 } 6619 WARN("VSPRINTF_SPECIFIER_PX", 6620 "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"); 6621 } 6622 } 6623 if ($bad_specifier ne "") { 6624 my $stat_real = get_stat_real($linenr, $lc); 6625 my $ext_type = "Invalid"; 6626 my $use = ""; 6627 if ($bad_specifier =~ /p[Ff]/) { 6628 $use = " - use %pS instead"; 6629 $use =~ s/pS/ps/ if ($bad_specifier =~ /pf/); 6630 } 6631 6632 WARN("VSPRINTF_POINTER_EXTENSION", 6633 "$ext_type vsprintf pointer extension '$bad_specifier'$use\n" . "$here\n$stat_real\n"); 6634 } 6635 } 6636 } 6637 6638# Check for misused memsets 6639 if ($perl_version_ok && 6640 defined $stat && 6641 $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*$FuncArg\s*\)/) { 6642 6643 my $ms_addr = $2; 6644 my $ms_val = $7; 6645 my $ms_size = $12; 6646 6647 if ($ms_size =~ /^(0x|)0$/i) { 6648 ERROR("MEMSET", 6649 "memset to 0's uses 0 as the 2nd argument, not the 3rd\n" . "$here\n$stat\n"); 6650 } elsif ($ms_size =~ /^(0x|)1$/i) { 6651 WARN("MEMSET", 6652 "single byte memset is suspicious. Swapped 2nd/3rd argument?\n" . "$here\n$stat\n"); 6653 } 6654 } 6655 6656# Check for memcpy(foo, bar, ETH_ALEN) that could be ether_addr_copy(foo, bar) 6657# if ($perl_version_ok && 6658# defined $stat && 6659# $stat =~ /^\+(?:.*?)\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6660# if (WARN("PREFER_ETHER_ADDR_COPY", 6661# "Prefer ether_addr_copy() over memcpy() if the Ethernet addresses are __aligned(2)\n" . "$here\n$stat\n") && 6662# $fix) { 6663# $fixed[$fixlinenr] =~ s/\bmemcpy\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/ether_addr_copy($2, $7)/; 6664# } 6665# } 6666 6667# Check for memcmp(foo, bar, ETH_ALEN) that could be ether_addr_equal*(foo, bar) 6668# if ($perl_version_ok && 6669# defined $stat && 6670# $stat =~ /^\+(?:.*?)\bmemcmp\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6671# WARN("PREFER_ETHER_ADDR_EQUAL", 6672# "Prefer ether_addr_equal() or ether_addr_equal_unaligned() over memcmp()\n" . "$here\n$stat\n") 6673# } 6674 6675# check for memset(foo, 0x0, ETH_ALEN) that could be eth_zero_addr 6676# check for memset(foo, 0xFF, ETH_ALEN) that could be eth_broadcast_addr 6677# if ($perl_version_ok && 6678# defined $stat && 6679# $stat =~ /^\+(?:.*?)\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\,\s*ETH_ALEN\s*\)/) { 6680# 6681# my $ms_val = $7; 6682# 6683# if ($ms_val =~ /^(?:0x|)0+$/i) { 6684# if (WARN("PREFER_ETH_ZERO_ADDR", 6685# "Prefer eth_zero_addr over memset()\n" . "$here\n$stat\n") && 6686# $fix) { 6687# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_zero_addr($2)/; 6688# } 6689# } elsif ($ms_val =~ /^(?:0xff|255)$/i) { 6690# if (WARN("PREFER_ETH_BROADCAST_ADDR", 6691# "Prefer eth_broadcast_addr() over memset()\n" . "$here\n$stat\n") && 6692# $fix) { 6693# $fixed[$fixlinenr] =~ s/\bmemset\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*,\s*ETH_ALEN\s*\)/eth_broadcast_addr($2)/; 6694# } 6695# } 6696# } 6697 6698# strlcpy uses that should likely be strscpy 6699 if ($line =~ /\bstrlcpy\s*\(/) { 6700 WARN("STRLCPY", 6701 "Prefer strscpy over strlcpy - see: https://lore.kernel.org/r/CAHk-=wgfRnXz0W3D37d01q3JFkr_i_uTL=V6A6G1oUZcprmknw\@mail.gmail.com/\n" . $herecurr); 6702 } 6703 6704# typecasts on min/max could be min_t/max_t 6705 if ($perl_version_ok && 6706 defined $stat && 6707 $stat =~ /^\+(?:.*?)\b(min|max)\s*\(\s*$FuncArg\s*,\s*$FuncArg\s*\)/) { 6708 if (defined $2 || defined $7) { 6709 my $call = $1; 6710 my $cast1 = deparenthesize($2); 6711 my $arg1 = $3; 6712 my $cast2 = deparenthesize($7); 6713 my $arg2 = $8; 6714 my $cast; 6715 6716 if ($cast1 ne "" && $cast2 ne "" && $cast1 ne $cast2) { 6717 $cast = "$cast1 or $cast2"; 6718 } elsif ($cast1 ne "") { 6719 $cast = $cast1; 6720 } else { 6721 $cast = $cast2; 6722 } 6723 WARN("MINMAX", 6724 "$call() should probably be ${call}_t($cast, $arg1, $arg2)\n" . "$here\n$stat\n"); 6725 } 6726 } 6727 6728# check usleep_range arguments 6729 if ($perl_version_ok && 6730 defined $stat && 6731 $stat =~ /^\+(?:.*?)\busleep_range\s*\(\s*($FuncArg)\s*,\s*($FuncArg)\s*\)/) { 6732 my $min = $1; 6733 my $max = $7; 6734 if ($min eq $max) { 6735 WARN("USLEEP_RANGE", 6736 "usleep_range should not use min == max args; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 6737 } elsif ($min =~ /^\d+$/ && $max =~ /^\d+$/ && 6738 $min > $max) { 6739 WARN("USLEEP_RANGE", 6740 "usleep_range args reversed, use min then max; see Documentation/timers/timers-howto.rst\n" . "$here\n$stat\n"); 6741 } 6742 } 6743 6744# check for naked sscanf 6745 if ($perl_version_ok && 6746 defined $stat && 6747 $line =~ /\bsscanf\b/ && 6748 ($stat !~ /$Ident\s*=\s*sscanf\s*$balanced_parens/ && 6749 $stat !~ /\bsscanf\s*$balanced_parens\s*(?:$Compare)/ && 6750 $stat !~ /(?:$Compare)\s*\bsscanf\s*$balanced_parens/)) { 6751 my $lc = $stat =~ tr@\n@@; 6752 $lc = $lc + $linenr; 6753 my $stat_real = get_stat_real($linenr, $lc); 6754 WARN("NAKED_SSCANF", 6755 "unchecked sscanf return value\n" . "$here\n$stat_real\n"); 6756 } 6757 6758# check for simple sscanf that should be kstrto<foo> 6759 if ($perl_version_ok && 6760 defined $stat && 6761 $line =~ /\bsscanf\b/) { 6762 my $lc = $stat =~ tr@\n@@; 6763 $lc = $lc + $linenr; 6764 my $stat_real = get_stat_real($linenr, $lc); 6765 if ($stat_real =~ /\bsscanf\b\s*\(\s*$FuncArg\s*,\s*("[^"]+")/) { 6766 my $format = $6; 6767 my $count = $format =~ tr@%@%@; 6768 if ($count == 1 && 6769 $format =~ /^"\%(?i:ll[udxi]|[udxi]ll|ll|[hl]h?[udxi]|[udxi][hl]h?|[hl]h?|[udxi])"$/) { 6770 WARN("SSCANF_TO_KSTRTO", 6771 "Prefer kstrto<type> to single variable sscanf\n" . "$here\n$stat_real\n"); 6772 } 6773 } 6774 } 6775 6776# check for new externs in .h files. 6777 if ($realfile =~ /\.h$/ && 6778 $line =~ /^\+\s*(extern\s+)$Type\s*$Ident\s*\(/s) { 6779 if (CHK("AVOID_EXTERNS", 6780 "extern prototypes should be avoided in .h files\n" . $herecurr) && 6781 $fix) { 6782 $fixed[$fixlinenr] =~ s/(.*)\bextern\b\s*(.*)/$1$2/; 6783 } 6784 } 6785 6786# check for new externs in .c files. 6787 if ($realfile =~ /\.c$/ && defined $stat && 6788 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 6789 { 6790 my $function_name = $1; 6791 my $paren_space = $2; 6792 6793 my $s = $stat; 6794 if (defined $cond) { 6795 substr($s, 0, length($cond), ''); 6796 } 6797 if ($s =~ /^\s*;/) 6798 { 6799 WARN("AVOID_EXTERNS", 6800 "externs should be avoided in .c files\n" . $herecurr); 6801 } 6802 6803 if ($paren_space =~ /\n/) { 6804 WARN("FUNCTION_ARGUMENTS", 6805 "arguments for function declarations should follow identifier\n" . $herecurr); 6806 } 6807 6808 } elsif ($realfile =~ /\.c$/ && defined $stat && 6809 $stat =~ /^.\s*extern\s+/) 6810 { 6811 WARN("AVOID_EXTERNS", 6812 "externs should be avoided in .c files\n" . $herecurr); 6813 } 6814 6815# check for function declarations that have arguments without identifier names 6816 if (defined $stat && 6817 $stat =~ /^.\s*(?:extern\s+)?$Type\s*(?:$Ident|\(\s*\*\s*$Ident\s*\))\s*\(\s*([^{]+)\s*\)\s*;/s && 6818 $1 ne "void") { 6819 my $args = trim($1); 6820 while ($args =~ m/\s*($Type\s*(?:$Ident|\(\s*\*\s*$Ident?\s*\)\s*$balanced_parens)?)/g) { 6821 my $arg = trim($1); 6822 if ($arg =~ /^$Type$/ && $arg !~ /enum\s+$Ident$/) { 6823 WARN("FUNCTION_ARGUMENTS", 6824 "function definition argument '$arg' should also have an identifier name\n" . $herecurr); 6825 } 6826 } 6827 } 6828 6829# check for function definitions 6830 if ($perl_version_ok && 6831 defined $stat && 6832 $stat =~ /^.\s*(?:$Storage\s+)?$Type\s*($Ident)\s*$balanced_parens\s*{/s) { 6833 $context_function = $1; 6834 6835# check for multiline function definition with misplaced open brace 6836 my $ok = 0; 6837 my $cnt = statement_rawlines($stat); 6838 my $herectx = $here . "\n"; 6839 for (my $n = 0; $n < $cnt; $n++) { 6840 my $rl = raw_line($linenr, $n); 6841 $herectx .= $rl . "\n"; 6842 $ok = 1 if ($rl =~ /^[ \+]\{/); 6843 $ok = 1 if ($rl =~ /\{/ && $n == 0); 6844 last if $rl =~ /^[ \+].*\{/; 6845 } 6846 if (!$ok) { 6847 ERROR("OPEN_BRACE", 6848 "open brace '{' following function definitions go on the next line\n" . $herectx); 6849 } 6850 } 6851 6852# checks for new __setup's 6853 if ($rawline =~ /\b__setup\("([^"]*)"/) { 6854 my $name = $1; 6855 6856 if (!grep(/$name/, @setup_docs)) { 6857 CHK("UNDOCUMENTED_SETUP", 6858 "__setup appears un-documented -- check Documentation/admin-guide/kernel-parameters.txt\n" . $herecurr); 6859 } 6860 } 6861 6862# check for pointless casting of alloc functions 6863 if ($line =~ /\*\s*\)\s*$allocFunctions\b/) { 6864 WARN("UNNECESSARY_CASTS", 6865 "unnecessary cast may hide bugs, see http://c-faq.com/malloc/mallocnocast.html\n" . $herecurr); 6866 } 6867 6868# alloc style 6869# p = alloc(sizeof(struct foo), ...) should be p = alloc(sizeof(*p), ...) 6870 if ($perl_version_ok && 6871 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*((?:kv|k|v)[mz]alloc(?:_node)?)\s*\(\s*(sizeof\s*\(\s*struct\s+$Lval\s*\))/) { 6872 CHK("ALLOC_SIZEOF_STRUCT", 6873 "Prefer $3(sizeof(*$1)...) over $3($4...)\n" . $herecurr); 6874 } 6875 6876# check for k[mz]alloc with multiplies that could be kmalloc_array/kcalloc 6877 if ($perl_version_ok && 6878 defined $stat && 6879 $stat =~ /^\+\s*($Lval)\s*\=\s*(?:$balanced_parens)?\s*(k[mz]alloc)\s*\(\s*($FuncArg)\s*\*\s*($FuncArg)\s*,/) { 6880 my $oldfunc = $3; 6881 my $a1 = $4; 6882 my $a2 = $10; 6883 my $newfunc = "kmalloc_array"; 6884 $newfunc = "kcalloc" if ($oldfunc eq "kzalloc"); 6885 my $r1 = $a1; 6886 my $r2 = $a2; 6887 if ($a1 =~ /^sizeof\s*\S/) { 6888 $r1 = $a2; 6889 $r2 = $a1; 6890 } 6891 if ($r1 !~ /^sizeof\b/ && $r2 =~ /^sizeof\s*\S/ && 6892 !($r1 =~ /^$Constant$/ || $r1 =~ /^[A-Z_][A-Z0-9_]*$/)) { 6893 my $cnt = statement_rawlines($stat); 6894 my $herectx = get_stat_here($linenr, $cnt, $here); 6895 6896 if (WARN("ALLOC_WITH_MULTIPLY", 6897 "Prefer $newfunc over $oldfunc with multiply\n" . $herectx) && 6898 $cnt == 1 && 6899 $fix) { 6900 $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; 6901 } 6902 } 6903 } 6904 6905# check for krealloc arg reuse 6906 if ($perl_version_ok && 6907 $line =~ /\b($Lval)\s*\=\s*(?:$balanced_parens)?\s*krealloc\s*\(\s*($Lval)\s*,/ && 6908 $1 eq $3) { 6909 WARN("KREALLOC_ARG_REUSE", 6910 "Reusing the krealloc arg is almost always a bug\n" . $herecurr); 6911 } 6912 6913# check for alloc argument mismatch 6914 if ($line =~ /\b(kcalloc|kmalloc_array)\s*\(\s*sizeof\b/) { 6915 WARN("ALLOC_ARRAY_ARGS", 6916 "$1 uses number as first arg, sizeof is generally wrong\n" . $herecurr); 6917 } 6918 6919# check for multiple semicolons 6920 if ($line =~ /;\s*;\s*$/) { 6921 if (WARN("ONE_SEMICOLON", 6922 "Statements terminations use 1 semicolon\n" . $herecurr) && 6923 $fix) { 6924 $fixed[$fixlinenr] =~ s/(\s*;\s*){2,}$/;/g; 6925 } 6926 } 6927 6928# check for #defines like: 1 << <digit> that could be BIT(digit), it is not exported to uapi 6929 if ($realfile !~ m@^include/uapi/@ && 6930 $line =~ /#\s*define\s+\w+\s+\(?\s*1\s*([ulUL]*)\s*\<\<\s*(?:\d+|$Ident)\s*\)?/) { 6931 my $ull = ""; 6932 $ull = "_ULL" if (defined($1) && $1 =~ /ll/i); 6933 if (CHK("BIT_MACRO", 6934 "Prefer using the BIT$ull macro\n" . $herecurr) && 6935 $fix) { 6936 $fixed[$fixlinenr] =~ s/\(?\s*1\s*[ulUL]*\s*<<\s*(\d+|$Ident)\s*\)?/BIT${ull}($1)/; 6937 } 6938 } 6939 6940# check for IS_ENABLED() without CONFIG_<FOO> ($rawline for comments too) 6941 if ($rawline =~ /\bIS_ENABLED\s*\(\s*(\w+)\s*\)/ && $1 !~ /^${CONFIG_}/) { 6942 WARN("IS_ENABLED_CONFIG", 6943 "IS_ENABLED($1) is normally used as IS_ENABLED(${CONFIG_}$1)\n" . $herecurr); 6944 } 6945 6946# check for #if defined CONFIG_<FOO> || defined CONFIG_<FOO>_MODULE 6947 if ($line =~ /^\+\s*#\s*if\s+defined(?:\s*\(?\s*|\s+)(${CONFIG_}[A-Z_]+)\s*\)?\s*\|\|\s*defined(?:\s*\(?\s*|\s+)\1_MODULE\s*\)?\s*$/) { 6948 my $config = $1; 6949 if (WARN("PREFER_IS_ENABLED", 6950 "Prefer IS_ENABLED(<FOO>) to ${CONFIG_}<FOO> || ${CONFIG_}<FOO>_MODULE\n" . $herecurr) && 6951 $fix) { 6952 $fixed[$fixlinenr] = "\+#if IS_ENABLED($config)"; 6953 } 6954 } 6955 6956# check for /* fallthrough */ like comment, prefer fallthrough; 6957 my @fallthroughs = ( 6958 'fallthrough', 6959 '@fallthrough@', 6960 'lint -fallthrough[ \t]*', 6961 'intentional(?:ly)?[ \t]*fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)', 6962 '(?:else,?\s*)?FALL(?:S | |-)?THR(?:OUGH|U|EW)[ \t.!]*(?:-[^\n\r]*)?', 6963 'Fall(?:(?:s | |-)[Tt]|t)hr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 6964 'fall(?:s | |-)?thr(?:ough|u|ew)[ \t.!]*(?:-[^\n\r]*)?', 6965 ); 6966 if ($raw_comment ne '') { 6967 foreach my $ft (@fallthroughs) { 6968 if ($raw_comment =~ /$ft/) { 6969 my $msg_level = \&WARN; 6970 $msg_level = \&CHK if ($file); 6971 &{$msg_level}("PREFER_FALLTHROUGH", 6972 "Prefer 'fallthrough;' over fallthrough comment\n" . $herecurr); 6973 last; 6974 } 6975 } 6976 } 6977 6978# check for switch/default statements without a break; 6979 if ($perl_version_ok && 6980 defined $stat && 6981 $stat =~ /^\+[$;\s]*(?:case[$;\s]+\w+[$;\s]*:[$;\s]*|)*[$;\s]*\bdefault[$;\s]*:[$;\s]*;/g) { 6982 my $cnt = statement_rawlines($stat); 6983 my $herectx = get_stat_here($linenr, $cnt, $here); 6984 6985 WARN("DEFAULT_NO_BREAK", 6986 "switch default: should use break\n" . $herectx); 6987 } 6988 6989# check for gcc specific __FUNCTION__ 6990 if ($line =~ /\b__FUNCTION__\b/) { 6991 if (WARN("USE_FUNC", 6992 "__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr) && 6993 $fix) { 6994 $fixed[$fixlinenr] =~ s/\b__FUNCTION__\b/__func__/g; 6995 } 6996 } 6997 6998# check for uses of __DATE__, __TIME__, __TIMESTAMP__ 6999 while ($line =~ /\b(__(?:DATE|TIME|TIMESTAMP)__)\b/g) { 7000 ERROR("DATE_TIME", 7001 "Use of the '$1' macro makes the build non-deterministic\n" . $herecurr); 7002 } 7003 7004# check for use of yield() 7005 if ($line =~ /\byield\s*\(\s*\)/) { 7006 WARN("YIELD", 7007 "Using yield() is generally wrong. See yield() kernel-doc (sched/core.c)\n" . $herecurr); 7008 } 7009 7010# check for comparisons against true and false 7011 if ($line =~ /\+\s*(.*?)\b(true|false|$Lval)\s*(==|\!=)\s*(true|false|$Lval)\b(.*)$/i) { 7012 my $lead = $1; 7013 my $arg = $2; 7014 my $test = $3; 7015 my $otype = $4; 7016 my $trail = $5; 7017 my $op = "!"; 7018 7019 ($arg, $otype) = ($otype, $arg) if ($arg =~ /^(?:true|false)$/i); 7020 7021 my $type = lc($otype); 7022 if ($type =~ /^(?:true|false)$/) { 7023 if (("$test" eq "==" && "$type" eq "true") || 7024 ("$test" eq "!=" && "$type" eq "false")) { 7025 $op = ""; 7026 } 7027 7028 CHK("BOOL_COMPARISON", 7029 "Using comparison to $otype is error prone\n" . $herecurr); 7030 7031## maybe suggesting a correct construct would better 7032## "Using comparison to $otype is error prone. Perhaps use '${lead}${op}${arg}${trail}'\n" . $herecurr); 7033 7034 } 7035 } 7036 7037# check for semaphores initialized locked 7038 if ($line =~ /^.\s*sema_init.+,\W?0\W?\)/) { 7039 WARN("CONSIDER_COMPLETION", 7040 "consider using a completion\n" . $herecurr); 7041 } 7042 7043# recommend kstrto* over simple_strto* and strict_strto* 7044 if ($line =~ /\b((simple|strict)_(strto(l|ll|ul|ull)))\s*\(/) { 7045 WARN("CONSIDER_KSTRTO", 7046 "$1 is obsolete, use k$3 instead\n" . $herecurr); 7047 } 7048 7049# check for __initcall(), use device_initcall() explicitly or more appropriate function please 7050 if ($line =~ /^.\s*__initcall\s*\(/) { 7051 WARN("USE_DEVICE_INITCALL", 7052 "please use device_initcall() or more appropriate function instead of __initcall() (see include/linux/init.h)\n" . $herecurr); 7053 } 7054 7055# check for spin_is_locked(), suggest lockdep instead 7056 if ($line =~ /\bspin_is_locked\(/) { 7057 WARN("USE_LOCKDEP", 7058 "Where possible, use lockdep_assert_held instead of assertions based on spin_is_locked\n" . $herecurr); 7059 } 7060 7061# check for deprecated apis 7062 if ($line =~ /\b($deprecated_apis_search)\b\s*\(/) { 7063 my $deprecated_api = $1; 7064 my $new_api = $deprecated_apis{$deprecated_api}; 7065 WARN("DEPRECATED_API", 7066 "Deprecated use of '$deprecated_api', prefer '$new_api' instead\n" . $herecurr); 7067 } 7068 7069# check for various structs that are normally const (ops, kgdb, device_tree) 7070# and avoid what seem like struct definitions 'struct foo {' 7071 if (defined($const_structs) && 7072 $line !~ /\bconst\b/ && 7073 $line =~ /\bstruct\s+($const_structs)\b(?!\s*\{)/) { 7074 WARN("CONST_STRUCT", 7075 "struct $1 should normally be const\n" . $herecurr); 7076 } 7077 7078# use of NR_CPUS is usually wrong 7079# ignore definitions of NR_CPUS and usage to define arrays as likely right 7080# ignore designated initializers using NR_CPUS 7081 if ($line =~ /\bNR_CPUS\b/ && 7082 $line !~ /^.\s*\s*#\s*if\b.*\bNR_CPUS\b/ && 7083 $line !~ /^.\s*\s*#\s*define\b.*\bNR_CPUS\b/ && 7084 $line !~ /^.\s*$Declare\s.*\[[^\]]*NR_CPUS[^\]]*\]/ && 7085 $line !~ /\[[^\]]*\.\.\.[^\]]*NR_CPUS[^\]]*\]/ && 7086 $line !~ /\[[^\]]*NR_CPUS[^\]]*\.\.\.[^\]]*\]/ && 7087 $line !~ /^.\s*\.\w+\s*=\s*.*\bNR_CPUS\b/) 7088 { 7089 WARN("NR_CPUS", 7090 "usage of NR_CPUS is often wrong - consider using cpu_possible(), num_possible_cpus(), for_each_possible_cpu(), etc\n" . $herecurr); 7091 } 7092 7093# Use of __ARCH_HAS_<FOO> or ARCH_HAVE_<BAR> is wrong. 7094 if ($line =~ /\+\s*#\s*define\s+((?:__)?ARCH_(?:HAS|HAVE)\w*)\b/) { 7095 ERROR("DEFINE_ARCH_HAS", 7096 "#define of '$1' is wrong - use Kconfig variables or standard guards instead\n" . $herecurr); 7097 } 7098 7099# likely/unlikely comparisons similar to "(likely(foo) > 0)" 7100 if ($perl_version_ok && 7101 $line =~ /\b((?:un)?likely)\s*\(\s*$FuncArg\s*\)\s*$Compare/) { 7102 WARN("LIKELY_MISUSE", 7103 "Using $1 should generally have parentheses around the comparison\n" . $herecurr); 7104 } 7105 7106# nested likely/unlikely calls 7107 if ($line =~ /\b(?:(?:un)?likely)\s*\(\s*!?\s*(IS_ERR(?:_OR_NULL|_VALUE)?|WARN)/) { 7108 WARN("LIKELY_MISUSE", 7109 "nested (un)?likely() calls, $1 already uses unlikely() internally\n" . $herecurr); 7110 } 7111 7112# whine mightly about in_atomic 7113 if ($line =~ /\bin_atomic\s*\(/) { 7114 if ($realfile =~ m@^drivers/@) { 7115 ERROR("IN_ATOMIC", 7116 "do not use in_atomic in drivers\n" . $herecurr); 7117 } elsif ($realfile !~ m@^kernel/@) { 7118 WARN("IN_ATOMIC", 7119 "use of in_atomic() is incorrect outside core kernel code\n" . $herecurr); 7120 } 7121 } 7122 7123# check for lockdep_set_novalidate_class 7124 if ($line =~ /^.\s*lockdep_set_novalidate_class\s*\(/ || 7125 $line =~ /__lockdep_no_validate__\s*\)/ ) { 7126 if ($realfile !~ m@^kernel/lockdep@ && 7127 $realfile !~ m@^include/linux/lockdep@ && 7128 $realfile !~ m@^drivers/base/core@) { 7129 ERROR("LOCKDEP", 7130 "lockdep_no_validate class is reserved for device->mutex.\n" . $herecurr); 7131 } 7132 } 7133 7134 if ($line =~ /debugfs_create_\w+.*\b$mode_perms_world_writable\b/ || 7135 $line =~ /DEVICE_ATTR.*\b$mode_perms_world_writable\b/) { 7136 WARN("EXPORTED_WORLD_WRITABLE", 7137 "Exporting world writable files is usually an error. Consider more restrictive permissions.\n" . $herecurr); 7138 } 7139 7140# check for DEVICE_ATTR uses that could be DEVICE_ATTR_<FOO> 7141# and whether or not function naming is typical and if 7142# DEVICE_ATTR permissions uses are unusual too 7143 if ($perl_version_ok && 7144 defined $stat && 7145 $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*\)/) { 7146 my $var = $1; 7147 my $perms = $2; 7148 my $show = $3; 7149 my $store = $4; 7150 my $octal_perms = perms_to_octal($perms); 7151 if ($show =~ /^${var}_show$/ && 7152 $store =~ /^${var}_store$/ && 7153 $octal_perms eq "0644") { 7154 if (WARN("DEVICE_ATTR_RW", 7155 "Use DEVICE_ATTR_RW\n" . $herecurr) && 7156 $fix) { 7157 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*$store\s*\)/DEVICE_ATTR_RW(${var})/; 7158 } 7159 } elsif ($show =~ /^${var}_show$/ && 7160 $store =~ /^NULL$/ && 7161 $octal_perms eq "0444") { 7162 if (WARN("DEVICE_ATTR_RO", 7163 "Use DEVICE_ATTR_RO\n" . $herecurr) && 7164 $fix) { 7165 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*$show\s*,\s*NULL\s*\)/DEVICE_ATTR_RO(${var})/; 7166 } 7167 } elsif ($show =~ /^NULL$/ && 7168 $store =~ /^${var}_store$/ && 7169 $octal_perms eq "0200") { 7170 if (WARN("DEVICE_ATTR_WO", 7171 "Use DEVICE_ATTR_WO\n" . $herecurr) && 7172 $fix) { 7173 $fixed[$fixlinenr] =~ s/\bDEVICE_ATTR\s*\(\s*$var\s*,\s*\Q$perms\E\s*,\s*NULL\s*,\s*$store\s*\)/DEVICE_ATTR_WO(${var})/; 7174 } 7175 } elsif ($octal_perms eq "0644" || 7176 $octal_perms eq "0444" || 7177 $octal_perms eq "0200") { 7178 my $newshow = "$show"; 7179 $newshow = "${var}_show" if ($show ne "NULL" && $show ne "${var}_show"); 7180 my $newstore = $store; 7181 $newstore = "${var}_store" if ($store ne "NULL" && $store ne "${var}_store"); 7182 my $rename = ""; 7183 if ($show ne $newshow) { 7184 $rename .= " '$show' to '$newshow'"; 7185 } 7186 if ($store ne $newstore) { 7187 $rename .= " '$store' to '$newstore'"; 7188 } 7189 WARN("DEVICE_ATTR_FUNCTIONS", 7190 "Consider renaming function(s)$rename\n" . $herecurr); 7191 } else { 7192 WARN("DEVICE_ATTR_PERMS", 7193 "DEVICE_ATTR unusual permissions '$perms' used\n" . $herecurr); 7194 } 7195 } 7196 7197# Mode permission misuses where it seems decimal should be octal 7198# This uses a shortcut match to avoid unnecessary uses of a slow foreach loop 7199# o Ignore module_param*(...) uses with a decimal 0 permission as that has a 7200# specific definition of not visible in sysfs. 7201# o Ignore proc_create*(...) uses with a decimal 0 permission as that means 7202# use the default permissions 7203 if ($perl_version_ok && 7204 defined $stat && 7205 $line =~ /$mode_perms_search/) { 7206 foreach my $entry (@mode_permission_funcs) { 7207 my $func = $entry->[0]; 7208 my $arg_pos = $entry->[1]; 7209 7210 my $lc = $stat =~ tr@\n@@; 7211 $lc = $lc + $linenr; 7212 my $stat_real = get_stat_real($linenr, $lc); 7213 7214 my $skip_args = ""; 7215 if ($arg_pos > 1) { 7216 $arg_pos--; 7217 $skip_args = "(?:\\s*$FuncArg\\s*,\\s*){$arg_pos,$arg_pos}"; 7218 } 7219 my $test = "\\b$func\\s*\\(${skip_args}($FuncArg(?:\\|\\s*$FuncArg)*)\\s*[,\\)]"; 7220 if ($stat =~ /$test/) { 7221 my $val = $1; 7222 $val = $6 if ($skip_args ne ""); 7223 if (!($func =~ /^(?:module_param|proc_create)/ && $val eq "0") && 7224 (($val =~ /^$Int$/ && $val !~ /^$Octal$/) || 7225 ($val =~ /^$Octal$/ && length($val) ne 4))) { 7226 ERROR("NON_OCTAL_PERMISSIONS", 7227 "Use 4 digit octal (0777) not decimal permissions\n" . "$here\n" . $stat_real); 7228 } 7229 if ($val =~ /^$Octal$/ && (oct($val) & 02)) { 7230 ERROR("EXPORTED_WORLD_WRITABLE", 7231 "Exporting writable files is usually an error. Consider more restrictive permissions.\n" . "$here\n" . $stat_real); 7232 } 7233 } 7234 } 7235 } 7236 7237# check for uses of S_<PERMS> that could be octal for readability 7238 while ($line =~ m{\b($multi_mode_perms_string_search)\b}g) { 7239 my $oval = $1; 7240 my $octal = perms_to_octal($oval); 7241 if (WARN("SYMBOLIC_PERMS", 7242 "Symbolic permissions '$oval' are not preferred. Consider using octal permissions '$octal'.\n" . $herecurr) && 7243 $fix) { 7244 $fixed[$fixlinenr] =~ s/\Q$oval\E/$octal/; 7245 } 7246 } 7247 7248# validate content of MODULE_LICENSE against list from include/linux/module.h 7249 if ($line =~ /\bMODULE_LICENSE\s*\(\s*($String)\s*\)/) { 7250 my $extracted_string = get_quoted_string($line, $rawline); 7251 my $valid_licenses = qr{ 7252 GPL| 7253 GPL\ v2| 7254 GPL\ and\ additional\ rights| 7255 Dual\ BSD/GPL| 7256 Dual\ MIT/GPL| 7257 Dual\ MPL/GPL| 7258 Proprietary 7259 }x; 7260 if ($extracted_string !~ /^"(?:$valid_licenses)"$/x) { 7261 WARN("MODULE_LICENSE", 7262 "unknown module license " . $extracted_string . "\n" . $herecurr); 7263 } 7264 } 7265 7266# check for sysctl duplicate constants 7267 if ($line =~ /\.extra[12]\s*=\s*&(zero|one|int_max)\b/) { 7268 WARN("DUPLICATED_SYSCTL_CONST", 7269 "duplicated sysctl range checking value '$1', consider using the shared one in include/linux/sysctl.h\n" . $herecurr); 7270 } 7271 } 7272 7273 # If we have no input at all, then there is nothing to report on 7274 # so just keep quiet. 7275 if ($#rawlines == -1) { 7276 exit(0); 7277 } 7278 7279 # In mailback mode only produce a report in the negative, for 7280 # things that appear to be patches. 7281 if ($mailback && ($clean == 1 || !$is_patch)) { 7282 exit(0); 7283 } 7284 7285 # This is not a patch, and we are in 'no-patch' mode so 7286 # just keep quiet. 7287 if (!$chk_patch && !$is_patch) { 7288 exit(0); 7289 } 7290 7291 if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 7292 ERROR("NOT_UNIFIED_DIFF", 7293 "Does not appear to be a unified-diff format patch\n"); 7294 } 7295 if ($is_patch && $has_commit_log && $chk_signoff) { 7296 if ($signoff == 0) { 7297 ERROR("MISSING_SIGN_OFF", 7298 "Missing Signed-off-by: line(s)\n"); 7299 } elsif ($authorsignoff != 1) { 7300 # authorsignoff values: 7301 # 0 -> missing sign off 7302 # 1 -> sign off identical 7303 # 2 -> names and addresses match, comments mismatch 7304 # 3 -> addresses match, names different 7305 # 4 -> names match, addresses different 7306 # 5 -> names match, addresses excluding subaddress details (refer RFC 5233) match 7307 7308 my $sob_msg = "'From: $author' != 'Signed-off-by: $author_sob'"; 7309 7310 if ($authorsignoff == 0) { 7311 ERROR("NO_AUTHOR_SIGN_OFF", 7312 "Missing Signed-off-by: line by nominal patch author '$author'\n"); 7313 } elsif ($authorsignoff == 2) { 7314 CHK("FROM_SIGN_OFF_MISMATCH", 7315 "From:/Signed-off-by: email comments mismatch: $sob_msg\n"); 7316 } elsif ($authorsignoff == 3) { 7317 WARN("FROM_SIGN_OFF_MISMATCH", 7318 "From:/Signed-off-by: email name mismatch: $sob_msg\n"); 7319 } elsif ($authorsignoff == 4) { 7320 WARN("FROM_SIGN_OFF_MISMATCH", 7321 "From:/Signed-off-by: email address mismatch: $sob_msg\n"); 7322 } elsif ($authorsignoff == 5) { 7323 WARN("FROM_SIGN_OFF_MISMATCH", 7324 "From:/Signed-off-by: email subaddress mismatch: $sob_msg\n"); 7325 } 7326 } 7327 } 7328 7329 print report_dump(); 7330 if ($summary && !($clean == 1 && $quiet == 1)) { 7331 print "$filename " if ($summary_file); 7332 print "total: $cnt_error errors, $cnt_warn warnings, " . 7333 (($check)? "$cnt_chk checks, " : "") . 7334 "$cnt_lines lines checked\n"; 7335 } 7336 7337 if ($quiet == 0) { 7338 # If there were any defects found and not already fixing them 7339 if (!$clean and !$fix) { 7340 print << "EOM" 7341 7342NOTE: For some of the reported defects, checkpatch may be able to 7343 mechanically convert to the typical style using --fix or --fix-inplace. 7344EOM 7345 } 7346 # If there were whitespace errors which cleanpatch can fix 7347 # then suggest that. 7348 if ($rpt_cleaners) { 7349 $rpt_cleaners = 0; 7350 print << "EOM" 7351 7352NOTE: Whitespace errors detected. 7353 You may wish to use scripts/cleanpatch or scripts/cleanfile 7354EOM 7355 } 7356 } 7357 7358 if ($clean == 0 && $fix && 7359 ("@rawlines" ne "@fixed" || 7360 $#fixed_inserted >= 0 || $#fixed_deleted >= 0)) { 7361 my $newfile = $filename; 7362 $newfile .= ".EXPERIMENTAL-checkpatch-fixes" if (!$fix_inplace); 7363 my $linecount = 0; 7364 my $f; 7365 7366 @fixed = fix_inserted_deleted_lines(\@fixed, \@fixed_inserted, \@fixed_deleted); 7367 7368 open($f, '>', $newfile) 7369 or die "$P: Can't open $newfile for write\n"; 7370 foreach my $fixed_line (@fixed) { 7371 $linecount++; 7372 if ($file) { 7373 if ($linecount > 3) { 7374 $fixed_line =~ s/^\+//; 7375 print $f $fixed_line . "\n"; 7376 } 7377 } else { 7378 print $f $fixed_line . "\n"; 7379 } 7380 } 7381 close($f); 7382 7383 if (!$quiet) { 7384 print << "EOM"; 7385 7386Wrote EXPERIMENTAL --fix correction(s) to '$newfile' 7387 7388Do _NOT_ trust the results written to this file. 7389Do _NOT_ submit these changes without inspecting them for correctness. 7390 7391This EXPERIMENTAL file is simply a convenience to help rewrite patches. 7392No warranties, expressed or implied... 7393EOM 7394 } 7395 } 7396 7397 if ($quiet == 0) { 7398 print "\n"; 7399 if ($clean == 1) { 7400 print "$vname has no obvious style problems and is ready for submission.\n"; 7401 } else { 7402 print "$vname has style problems, please review.\n"; 7403 } 7404 } 7405 return $clean; 7406} 7407