1#!/usr/bin/env perl 2# (c) 2001, Dave Jones. (the file handling bit) 3# (c) 2005, Joel Schopp <jschopp@austin.ibm.com> (the ugly bit) 4# (c) 2007,2008, Andy Whitcroft <apw@uk.ibm.com> (new conditions, test suite) 5# (c) 2008-2010 Andy Whitcroft <apw@canonical.com> 6# Licensed under the terms of the GNU GPL License version 2 7 8use strict; 9use warnings; 10use Term::ANSIColor qw(:constants); 11 12my $P = $0; 13$P =~ s@.*/@@g; 14 15our $SrcFile = qr{\.(?:h|c|cpp|s|S|pl|py|sh)$}; 16 17my $V = '0.31'; 18 19use Getopt::Long qw(:config no_auto_abbrev); 20 21my $quiet = 0; 22my $tree = 1; 23my $chk_signoff = 1; 24my $chk_patch = undef; 25my $chk_branch = undef; 26my $tst_only; 27my $emacs = 0; 28my $terse = 0; 29my $file = undef; 30my $color = "auto"; 31my $no_warnings = 0; 32my $summary = 1; 33my $mailback = 0; 34my $summary_file = 0; 35my $root; 36my %debug; 37my $help = 0; 38 39sub help { 40 my ($exitcode) = @_; 41 42 print << "EOM"; 43Usage: 44 45 $P [OPTION]... [FILE]... 46 $P [OPTION]... [GIT-REV-LIST] 47 48Version: $V 49 50Options: 51 -q, --quiet quiet 52 --no-tree run without a kernel tree 53 --no-signoff do not check for 'Signed-off-by' line 54 --patch treat FILE as patchfile 55 --branch treat args as GIT revision list 56 --emacs emacs compile window format 57 --terse one line per report 58 -f, --file treat FILE as regular source file 59 --strict fail if only warnings are found 60 --root=PATH PATH to the kernel tree root 61 --no-summary suppress the per-file summary 62 --mailback only produce a report in case of warnings/errors 63 --summary-file include the filename in summary 64 --debug KEY=[0|1] turn on/off debugging of KEY, where KEY is one of 65 'values', 'possible', 'type', and 'attr' (default 66 is all off) 67 --test-only=WORD report only warnings/errors containing WORD 68 literally 69 --color[=WHEN] Use colors 'always', 'never', or only when output 70 is a terminal ('auto'). Default is 'auto'. 71 -h, --help, --version display this help and exit 72 73When FILE is - read standard input. 74EOM 75 76 exit($exitcode); 77} 78 79# Perl's Getopt::Long allows options to take optional arguments after a space. 80# Prevent --color by itself from consuming other arguments 81foreach (@ARGV) { 82 if ($_ eq "--color" || $_ eq "-color") { 83 $_ = "--color=$color"; 84 } 85} 86 87GetOptions( 88 'q|quiet+' => \$quiet, 89 'tree!' => \$tree, 90 'signoff!' => \$chk_signoff, 91 'patch!' => \$chk_patch, 92 'branch!' => \$chk_branch, 93 'emacs!' => \$emacs, 94 'terse!' => \$terse, 95 'f|file!' => \$file, 96 'strict!' => \$no_warnings, 97 'root=s' => \$root, 98 'summary!' => \$summary, 99 'mailback!' => \$mailback, 100 'summary-file!' => \$summary_file, 101 102 'debug=s' => \%debug, 103 'test-only=s' => \$tst_only, 104 'color=s' => \$color, 105 'no-color' => sub { $color = 'never'; }, 106 'h|help' => \$help, 107 'version' => \$help 108) or help(1); 109 110help(0) if ($help); 111 112my $exit = 0; 113 114if ($#ARGV < 0) { 115 print "$P: no input files\n"; 116 exit(1); 117} 118 119if (!defined $chk_branch && !defined $chk_patch && !defined $file) { 120 $chk_branch = $ARGV[0] =~ /.\.\./ ? 1 : 0; 121 $file = $ARGV[0] =~ /$SrcFile/ ? 1 : 0; 122 $chk_patch = $chk_branch || $file ? 0 : 1; 123} elsif (!defined $chk_branch && !defined $chk_patch) { 124 if ($file) { 125 $chk_branch = $chk_patch = 0; 126 } else { 127 $chk_branch = $ARGV[0] =~ /.\.\./ ? 1 : 0; 128 $chk_patch = $chk_branch ? 0 : 1; 129 } 130} elsif (!defined $chk_branch && !defined $file) { 131 if ($chk_patch) { 132 $chk_branch = $file = 0; 133 } else { 134 $chk_branch = $ARGV[0] =~ /.\.\./ ? 1 : 0; 135 $file = $chk_branch ? 0 : 1; 136 } 137} elsif (!defined $chk_patch && !defined $file) { 138 if ($chk_branch) { 139 $chk_patch = $file = 0; 140 } else { 141 $file = $ARGV[0] =~ /$SrcFile/ ? 1 : 0; 142 $chk_patch = $file ? 0 : 1; 143 } 144} elsif (!defined $chk_branch) { 145 $chk_branch = $chk_patch || $file ? 0 : 1; 146} elsif (!defined $chk_patch) { 147 $chk_patch = $chk_branch || $file ? 0 : 1; 148} elsif (!defined $file) { 149 $file = $chk_patch || $chk_branch ? 0 : 1; 150} 151 152if (($chk_patch && $chk_branch) || 153 ($chk_patch && $file) || 154 ($chk_branch && $file)) { 155 die "Only one of --file, --branch, --patch is permitted\n"; 156} 157if (!$chk_patch && !$chk_branch && !$file) { 158 die "One of --file, --branch, --patch is required\n"; 159} 160 161if ($color =~ /^always$/i) { 162 $color = 1; 163} elsif ($color =~ /^never$/i) { 164 $color = 0; 165} elsif ($color =~ /^auto$/i) { 166 $color = (-t STDOUT); 167} else { 168 die "Invalid color mode: $color\n"; 169} 170 171my $dbg_values = 0; 172my $dbg_possible = 0; 173my $dbg_type = 0; 174my $dbg_attr = 0; 175my $dbg_adv_dcs = 0; 176my $dbg_adv_checking = 0; 177my $dbg_adv_apw = 0; 178for my $key (keys %debug) { 179 ## no critic 180 eval "\${dbg_$key} = '$debug{$key}';"; 181 die "$@" if ($@); 182} 183 184my $rpt_cleaners = 0; 185 186if ($terse) { 187 $emacs = 1; 188 $quiet++; 189} 190 191if ($tree) { 192 if (defined $root) { 193 if (!top_of_kernel_tree($root)) { 194 die "$P: $root: --root does not point at a valid tree\n"; 195 } 196 } else { 197 if (top_of_kernel_tree('.')) { 198 $root = '.'; 199 } elsif ($0 =~ m@(.*)/scripts/[^/]*$@ && 200 top_of_kernel_tree($1)) { 201 $root = $1; 202 } 203 } 204 205 if (!defined $root) { 206 print "Must be run from the top-level dir. of a kernel tree\n"; 207 exit(2); 208 } 209} 210 211my $emitted_corrupt = 0; 212 213our $Ident = qr{ 214 [A-Za-z_][A-Za-z\d_]* 215 (?:\s*\#\#\s*[A-Za-z_][A-Za-z\d_]*)* 216 }x; 217our $Storage = qr{extern|static|asmlinkage}; 218our $Sparse = qr{ 219 __force 220 }x; 221 222# Notes to $Attribute: 223our $Attribute = qr{ 224 const| 225 volatile| 226 QEMU_NORETURN| 227 QEMU_WARN_UNUSED_RESULT| 228 QEMU_SENTINEL| 229 QEMU_PACKED| 230 GCC_FMT_ATTR 231 }x; 232our $Modifier; 233our $Inline = qr{inline}; 234our $Member = qr{->$Ident|\.$Ident|\[[^]]*\]}; 235our $Lval = qr{$Ident(?:$Member)*}; 236 237our $Constant = qr{(?:[0-9]+|0x[0-9a-fA-F]+)[UL]*}; 238our $Assignment = qr{(?:\*\=|/=|%=|\+=|-=|<<=|>>=|&=|\^=|\|=|=)}; 239our $Compare = qr{<=|>=|==|!=|<|>}; 240our $Operators = qr{ 241 <=|>=|==|!=| 242 =>|->|<<|>>|<|>|!|~| 243 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|% 244 }x; 245 246our $NonptrType; 247our $Type; 248our $Declare; 249 250our $NON_ASCII_UTF8 = qr{ 251 [\xC2-\xDF][\x80-\xBF] # non-overlong 2-byte 252 | \xE0[\xA0-\xBF][\x80-\xBF] # excluding overlongs 253 | [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} # straight 3-byte 254 | \xED[\x80-\x9F][\x80-\xBF] # excluding surrogates 255 | \xF0[\x90-\xBF][\x80-\xBF]{2} # planes 1-3 256 | [\xF1-\xF3][\x80-\xBF]{3} # planes 4-15 257 | \xF4[\x80-\x8F][\x80-\xBF]{2} # plane 16 258}x; 259 260our $UTF8 = qr{ 261 [\x09\x0A\x0D\x20-\x7E] # ASCII 262 | $NON_ASCII_UTF8 263}x; 264 265# some readers default to ISO-8859-1 when showing email source. detect 266# when UTF-8 is incorrectly interpreted as ISO-8859-1 and reencoded back. 267# False positives are possible but very unlikely. 268our $UTF8_MOJIBAKE = qr{ 269 \xC3[\x82-\x9F] \xC2[\x80-\xBF] # c2-df 80-bf 270 | \xC3\xA0 \xC2[\xA0-\xBF] \xC2[\x80-\xBF] # e0 a0-bf 80-bf 271 | \xC3[\xA1-\xAC\xAE\xAF] (?: \xC2[\x80-\xBF]){2} # e1-ec/ee/ef 80-bf 80-bf 272 | \xC3\xAD \xC2[\x80-\x9F] \xC2[\x80-\xBF] # ed 80-9f 80-bf 273 | \xC3\xB0 \xC2[\x90-\xBF] (?: \xC2[\x80-\xBF]){2} # f0 90-bf 80-bf 80-bf 274 | \xC3[\xB1-\xB3] (?: \xC2[\x80-\xBF]){3} # f1-f3 80-bf 80-bf 80-bf 275 | \xC3\xB4 \xC2[\x80-\x8F] (?: \xC2[\x80-\xBF]){2} # f4 80-b8 80-bf 80-bf 276}x; 277 278# There are still some false positives, but this catches most 279# common cases. 280our $typeTypedefs = qr{(?x: 281 (?![KMGTPE]iB) # IEC binary prefix (do not match) 282 [A-Z][A-Z\d_]*[a-z][A-Za-z\d_]* # camelcase 283 | [A-Z][A-Z\d_]*AIOCB # all uppercase 284 | [A-Z][A-Z\d_]*CPU # all uppercase 285 | QEMUBH # all uppercase 286)}; 287 288our @typeList = ( 289 qr{void}, 290 qr{(?:unsigned\s+)?char}, 291 qr{(?:unsigned\s+)?short}, 292 qr{(?:unsigned\s+)?int}, 293 qr{(?:unsigned\s+)?long}, 294 qr{(?:unsigned\s+)?long\s+int}, 295 qr{(?:unsigned\s+)?long\s+long}, 296 qr{(?:unsigned\s+)?long\s+long\s+int}, 297 qr{unsigned}, 298 qr{float}, 299 qr{double}, 300 qr{bool}, 301 qr{struct\s+$Ident}, 302 qr{union\s+$Ident}, 303 qr{enum\s+$Ident}, 304 qr{${Ident}_t}, 305 qr{${Ident}_handler}, 306 qr{${Ident}_handler_fn}, 307 qr{target_(?:u)?long}, 308 qr{hwaddr}, 309 # external libraries 310 qr{xml${Ident}}, 311 qr{xen\w+_handle}, 312 # Glib definitions 313 qr{gchar}, 314 qr{gshort}, 315 qr{glong}, 316 qr{gint}, 317 qr{gboolean}, 318 qr{guchar}, 319 qr{gushort}, 320 qr{gulong}, 321 qr{guint}, 322 qr{gfloat}, 323 qr{gdouble}, 324 qr{gpointer}, 325 qr{gconstpointer}, 326 qr{gint8}, 327 qr{guint8}, 328 qr{gint16}, 329 qr{guint16}, 330 qr{gint32}, 331 qr{guint32}, 332 qr{gint64}, 333 qr{guint64}, 334 qr{gsize}, 335 qr{gssize}, 336 qr{goffset}, 337 qr{gintptr}, 338 qr{guintptr}, 339); 340 341# This can be modified by sub possible. Since it can be empty, be careful 342# about regexes that always match, because they can cause infinite loops. 343our @modifierList = ( 344); 345 346sub build_types { 347 my $all = "(?x: \n" . join("|\n ", @typeList) . "\n)"; 348 if (@modifierList > 0) { 349 my $mods = "(?x: \n" . join("|\n ", @modifierList) . "\n)"; 350 $Modifier = qr{(?:$Attribute|$Sparse|$mods)}; 351 } else { 352 $Modifier = qr{(?:$Attribute|$Sparse)}; 353 } 354 $NonptrType = qr{ 355 (?:$Modifier\s+|const\s+)* 356 (?: 357 (?:typeof|__typeof__)\s*\(\s*\**\s*$Ident\s*\)| 358 (?:$typeTypedefs\b)| 359 (?:${all}\b) 360 ) 361 (?:\s+$Modifier|\s+const)* 362 }x; 363 $Type = qr{ 364 $NonptrType 365 (?:[\s\*]+\s*const|[\s\*]+|(?:\s*\[\s*\])+)? 366 (?:\s+$Inline|\s+$Modifier)* 367 }x; 368 $Declare = qr{(?:$Storage\s+)?$Type}; 369} 370build_types(); 371 372$chk_signoff = 0 if ($file); 373 374my @rawlines = (); 375my @lines = (); 376my $vname; 377if ($chk_branch) { 378 my @patches; 379 my %git_commits = (); 380 my $HASH; 381 open($HASH, "-|", "git", "log", "--reverse", "--no-merges", "--format=%H %s", $ARGV[0]) || 382 die "$P: git log --reverse --no-merges --format='%H %s' $ARGV[0] failed - $!\n"; 383 384 for my $line (<$HASH>) { 385 $line =~ /^([0-9a-fA-F]{40,40}) (.*)$/; 386 next if (!defined($1) || !defined($2)); 387 my $sha1 = $1; 388 my $subject = $2; 389 push(@patches, $sha1); 390 $git_commits{$sha1} = $subject; 391 } 392 393 close $HASH; 394 395 die "$P: no revisions returned for revlist '$chk_branch'\n" 396 unless @patches; 397 398 my $i = 1; 399 my $num_patches = @patches; 400 for my $hash (@patches) { 401 my $FILE; 402 open($FILE, '-|', "git", "show", $hash) || 403 die "$P: git show $hash - $!\n"; 404 while (<$FILE>) { 405 chomp; 406 push(@rawlines, $_); 407 } 408 close($FILE); 409 $vname = substr($hash, 0, 12) . ' (' . $git_commits{$hash} . ')'; 410 if ($num_patches > 1 && $quiet == 0) { 411 my $prefix = "$i/$num_patches"; 412 $prefix = BLUE . BOLD . $prefix . RESET if $color; 413 print "$prefix Checking commit $vname\n"; 414 $vname = "Patch $i/$num_patches"; 415 } else { 416 $vname = "Commit " . $vname; 417 } 418 if (!process($hash)) { 419 $exit = 1; 420 print "\n" if ($num_patches > 1 && $quiet == 0); 421 } 422 @rawlines = (); 423 @lines = (); 424 $i++; 425 } 426} else { 427 for my $filename (@ARGV) { 428 my $FILE; 429 if ($file) { 430 open($FILE, '-|', "diff -u /dev/null $filename") || 431 die "$P: $filename: diff failed - $!\n"; 432 } elsif ($filename eq '-') { 433 open($FILE, '<&STDIN'); 434 } else { 435 open($FILE, '<', "$filename") || 436 die "$P: $filename: open failed - $!\n"; 437 } 438 if ($filename eq '-') { 439 $vname = 'Your patch'; 440 } else { 441 $vname = $filename; 442 } 443 print "Checking $filename...\n" if @ARGV > 1 && $quiet == 0; 444 while (<$FILE>) { 445 chomp; 446 push(@rawlines, $_); 447 } 448 close($FILE); 449 if (!process($filename)) { 450 $exit = 1; 451 } 452 @rawlines = (); 453 @lines = (); 454 } 455} 456 457exit($exit); 458 459sub top_of_kernel_tree { 460 my ($root) = @_; 461 462 my @tree_check = ( 463 "COPYING", "MAINTAINERS", "Makefile", 464 "README.rst", "docs", "VERSION", 465 "vl.c" 466 ); 467 468 foreach my $check (@tree_check) { 469 if (! -e $root . '/' . $check) { 470 return 0; 471 } 472 } 473 return 1; 474} 475 476sub expand_tabs { 477 my ($str) = @_; 478 479 my $res = ''; 480 my $n = 0; 481 for my $c (split(//, $str)) { 482 if ($c eq "\t") { 483 $res .= ' '; 484 $n++; 485 for (; ($n % 8) != 0; $n++) { 486 $res .= ' '; 487 } 488 next; 489 } 490 $res .= $c; 491 $n++; 492 } 493 494 return $res; 495} 496sub copy_spacing { 497 (my $res = shift) =~ tr/\t/ /c; 498 return $res; 499} 500 501sub line_stats { 502 my ($line) = @_; 503 504 # Drop the diff line leader and expand tabs 505 $line =~ s/^.//; 506 $line = expand_tabs($line); 507 508 # Pick the indent from the front of the line. 509 my ($white) = ($line =~ /^(\s*)/); 510 511 return (length($line), length($white)); 512} 513 514my $sanitise_quote = ''; 515 516sub sanitise_line_reset { 517 my ($in_comment) = @_; 518 519 if ($in_comment) { 520 $sanitise_quote = '*/'; 521 } else { 522 $sanitise_quote = ''; 523 } 524} 525sub sanitise_line { 526 my ($line) = @_; 527 528 my $res = ''; 529 my $l = ''; 530 531 my $qlen = 0; 532 my $off = 0; 533 my $c; 534 535 # Always copy over the diff marker. 536 $res = substr($line, 0, 1); 537 538 for ($off = 1; $off < length($line); $off++) { 539 $c = substr($line, $off, 1); 540 541 # Comments we are wacking completely including the begin 542 # and end, all to $;. 543 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '/*') { 544 $sanitise_quote = '*/'; 545 546 substr($res, $off, 2, "$;$;"); 547 $off++; 548 next; 549 } 550 if ($sanitise_quote eq '*/' && substr($line, $off, 2) eq '*/') { 551 $sanitise_quote = ''; 552 substr($res, $off, 2, "$;$;"); 553 $off++; 554 next; 555 } 556 if ($sanitise_quote eq '' && substr($line, $off, 2) eq '//') { 557 $sanitise_quote = '//'; 558 559 substr($res, $off, 2, $sanitise_quote); 560 $off++; 561 next; 562 } 563 564 # A \ in a string means ignore the next character. 565 if (($sanitise_quote eq "'" || $sanitise_quote eq '"') && 566 $c eq "\\") { 567 substr($res, $off, 2, 'XX'); 568 $off++; 569 next; 570 } 571 # Regular quotes. 572 if ($c eq "'" || $c eq '"') { 573 if ($sanitise_quote eq '') { 574 $sanitise_quote = $c; 575 576 substr($res, $off, 1, $c); 577 next; 578 } elsif ($sanitise_quote eq $c) { 579 $sanitise_quote = ''; 580 } 581 } 582 583 #print "c<$c> SQ<$sanitise_quote>\n"; 584 if ($off != 0 && $sanitise_quote eq '*/' && $c ne "\t") { 585 substr($res, $off, 1, $;); 586 } elsif ($off != 0 && $sanitise_quote eq '//' && $c ne "\t") { 587 substr($res, $off, 1, $;); 588 } elsif ($off != 0 && $sanitise_quote && $c ne "\t") { 589 substr($res, $off, 1, 'X'); 590 } else { 591 substr($res, $off, 1, $c); 592 } 593 } 594 595 if ($sanitise_quote eq '//') { 596 $sanitise_quote = ''; 597 } 598 599 # The pathname on a #include may be surrounded by '<' and '>'. 600 if ($res =~ /^.\s*\#\s*include\s+\<(.*)\>/) { 601 my $clean = 'X' x length($1); 602 $res =~ s@\<.*\>@<$clean>@; 603 604 # The whole of a #error is a string. 605 } elsif ($res =~ /^.\s*\#\s*(?:error|warning)\s+(.*)\b/) { 606 my $clean = 'X' x length($1); 607 $res =~ s@(\#\s*(?:error|warning)\s+).*@$1$clean@; 608 } 609 610 return $res; 611} 612 613sub ctx_statement_block { 614 my ($linenr, $remain, $off) = @_; 615 my $line = $linenr - 1; 616 my $blk = ''; 617 my $soff = $off; 618 my $coff = $off - 1; 619 my $coff_set = 0; 620 621 my $loff = 0; 622 623 my $type = ''; 624 my $level = 0; 625 my @stack = (); 626 my $p; 627 my $c; 628 my $len = 0; 629 630 my $remainder; 631 while (1) { 632 @stack = (['', 0]) if ($#stack == -1); 633 634 #warn "CSB: blk<$blk> remain<$remain>\n"; 635 # If we are about to drop off the end, pull in more 636 # context. 637 if ($off >= $len) { 638 for (; $remain > 0; $line++) { 639 last if (!defined $lines[$line]); 640 next if ($lines[$line] =~ /^-/); 641 $remain--; 642 $loff = $len; 643 $blk .= $lines[$line] . "\n"; 644 $len = length($blk); 645 $line++; 646 last; 647 } 648 # Bail if there is no further context. 649 #warn "CSB: blk<$blk> off<$off> len<$len>\n"; 650 if ($off >= $len) { 651 last; 652 } 653 } 654 $p = $c; 655 $c = substr($blk, $off, 1); 656 $remainder = substr($blk, $off); 657 658 #warn "CSB: c<$c> type<$type> level<$level> remainder<$remainder> coff_set<$coff_set>\n"; 659 660 # Handle nested #if/#else. 661 if ($remainder =~ /^#\s*(?:ifndef|ifdef|if)\s/) { 662 push(@stack, [ $type, $level ]); 663 } elsif ($remainder =~ /^#\s*(?:else|elif)\b/) { 664 ($type, $level) = @{$stack[$#stack - 1]}; 665 } elsif ($remainder =~ /^#\s*endif\b/) { 666 ($type, $level) = @{pop(@stack)}; 667 } 668 669 # Statement ends at the ';' or a close '}' at the 670 # outermost level. 671 if ($level == 0 && $c eq ';') { 672 last; 673 } 674 675 # An else is really a conditional as long as its not else if 676 if ($level == 0 && $coff_set == 0 && 677 (!defined($p) || $p =~ /(?:\s|\}|\+)/) && 678 $remainder =~ /^(else)(?:\s|{)/ && 679 $remainder !~ /^else\s+if\b/) { 680 $coff = $off + length($1) - 1; 681 $coff_set = 1; 682 #warn "CSB: mark coff<$coff> soff<$soff> 1<$1>\n"; 683 #warn "[" . substr($blk, $soff, $coff - $soff + 1) . "]\n"; 684 } 685 686 if (($type eq '' || $type eq '(') && $c eq '(') { 687 $level++; 688 $type = '('; 689 } 690 if ($type eq '(' && $c eq ')') { 691 $level--; 692 $type = ($level != 0)? '(' : ''; 693 694 if ($level == 0 && $coff < $soff) { 695 $coff = $off; 696 $coff_set = 1; 697 #warn "CSB: mark coff<$coff>\n"; 698 } 699 } 700 if (($type eq '' || $type eq '{') && $c eq '{') { 701 $level++; 702 $type = '{'; 703 } 704 if ($type eq '{' && $c eq '}') { 705 $level--; 706 $type = ($level != 0)? '{' : ''; 707 708 if ($level == 0) { 709 if (substr($blk, $off + 1, 1) eq ';') { 710 $off++; 711 } 712 last; 713 } 714 } 715 $off++; 716 } 717 # We are truly at the end, so shuffle to the next line. 718 if ($off == $len) { 719 $loff = $len + 1; 720 $line++; 721 $remain--; 722 } 723 724 my $statement = substr($blk, $soff, $off - $soff + 1); 725 my $condition = substr($blk, $soff, $coff - $soff + 1); 726 727 #warn "STATEMENT<$statement>\n"; 728 #warn "CONDITION<$condition>\n"; 729 730 #print "coff<$coff> soff<$off> loff<$loff>\n"; 731 732 return ($statement, $condition, 733 $line, $remain + 1, $off - $loff + 1, $level); 734} 735 736sub statement_lines { 737 my ($stmt) = @_; 738 739 # Strip the diff line prefixes and rip blank lines at start and end. 740 $stmt =~ s/(^|\n)./$1/g; 741 $stmt =~ s/^\s*//; 742 $stmt =~ s/\s*$//; 743 744 my @stmt_lines = ($stmt =~ /\n/g); 745 746 return $#stmt_lines + 2; 747} 748 749sub statement_rawlines { 750 my ($stmt) = @_; 751 752 my @stmt_lines = ($stmt =~ /\n/g); 753 754 return $#stmt_lines + 2; 755} 756 757sub statement_block_size { 758 my ($stmt) = @_; 759 760 $stmt =~ s/(^|\n)./$1/g; 761 $stmt =~ s/^\s*\{//; 762 $stmt =~ s/}\s*$//; 763 $stmt =~ s/^\s*//; 764 $stmt =~ s/\s*$//; 765 766 my @stmt_lines = ($stmt =~ /\n/g); 767 my @stmt_statements = ($stmt =~ /;/g); 768 769 my $stmt_lines = $#stmt_lines + 2; 770 my $stmt_statements = $#stmt_statements + 1; 771 772 if ($stmt_lines > $stmt_statements) { 773 return $stmt_lines; 774 } else { 775 return $stmt_statements; 776 } 777} 778 779sub ctx_statement_full { 780 my ($linenr, $remain, $off) = @_; 781 my ($statement, $condition, $level); 782 783 my (@chunks); 784 785 # Grab the first conditional/block pair. 786 ($statement, $condition, $linenr, $remain, $off, $level) = 787 ctx_statement_block($linenr, $remain, $off); 788 #print "F: c<$condition> s<$statement> remain<$remain>\n"; 789 push(@chunks, [ $condition, $statement ]); 790 if (!($remain > 0 && $condition =~ /^\s*(?:\n[+-])?\s*(?:if|else|do)\b/s)) { 791 return ($level, $linenr, @chunks); 792 } 793 794 # Pull in the following conditional/block pairs and see if they 795 # could continue the statement. 796 for (;;) { 797 ($statement, $condition, $linenr, $remain, $off, $level) = 798 ctx_statement_block($linenr, $remain, $off); 799 #print "C: c<$condition> s<$statement> remain<$remain>\n"; 800 last if (!($remain > 0 && $condition =~ /^(?:\s*\n[+-])*\s*(?:else|do)\b/s)); 801 #print "C: push\n"; 802 push(@chunks, [ $condition, $statement ]); 803 } 804 805 return ($level, $linenr, @chunks); 806} 807 808sub ctx_block_get { 809 my ($linenr, $remain, $outer, $open, $close, $off) = @_; 810 my $line; 811 my $start = $linenr - 1; 812 my $blk = ''; 813 my @o; 814 my @c; 815 my @res = (); 816 817 my $level = 0; 818 my @stack = ($level); 819 for ($line = $start; $remain > 0; $line++) { 820 next if ($rawlines[$line] =~ /^-/); 821 $remain--; 822 823 $blk .= $rawlines[$line]; 824 825 # Handle nested #if/#else. 826 if ($lines[$line] =~ /^.\s*#\s*(?:ifndef|ifdef|if)\s/) { 827 push(@stack, $level); 828 } elsif ($lines[$line] =~ /^.\s*#\s*(?:else|elif)\b/) { 829 $level = $stack[$#stack - 1]; 830 } elsif ($lines[$line] =~ /^.\s*#\s*endif\b/) { 831 $level = pop(@stack); 832 } 833 834 foreach my $c (split(//, $lines[$line])) { 835 ##print "C<$c>L<$level><$open$close>O<$off>\n"; 836 if ($off > 0) { 837 $off--; 838 next; 839 } 840 841 if ($c eq $close && $level > 0) { 842 $level--; 843 last if ($level == 0); 844 } elsif ($c eq $open) { 845 $level++; 846 } 847 } 848 849 if (!$outer || $level <= 1) { 850 push(@res, $rawlines[$line]); 851 } 852 853 last if ($level == 0); 854 } 855 856 return ($level, @res); 857} 858sub ctx_block_outer { 859 my ($linenr, $remain) = @_; 860 861 my ($level, @r) = ctx_block_get($linenr, $remain, 1, '{', '}', 0); 862 return @r; 863} 864sub ctx_block { 865 my ($linenr, $remain) = @_; 866 867 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '{', '}', 0); 868 return @r; 869} 870sub ctx_statement { 871 my ($linenr, $remain, $off) = @_; 872 873 my ($level, @r) = ctx_block_get($linenr, $remain, 0, '(', ')', $off); 874 return @r; 875} 876sub ctx_block_level { 877 my ($linenr, $remain) = @_; 878 879 return ctx_block_get($linenr, $remain, 0, '{', '}', 0); 880} 881sub ctx_statement_level { 882 my ($linenr, $remain, $off) = @_; 883 884 return ctx_block_get($linenr, $remain, 0, '(', ')', $off); 885} 886 887sub ctx_locate_comment { 888 my ($first_line, $end_line) = @_; 889 890 # Catch a comment on the end of the line itself. 891 my ($current_comment) = ($rawlines[$end_line - 1] =~ m@.*(/\*.*\*/)\s*(?:\\\s*)?$@); 892 return $current_comment if (defined $current_comment); 893 894 # Look through the context and try and figure out if there is a 895 # comment. 896 my $in_comment = 0; 897 $current_comment = ''; 898 for (my $linenr = $first_line; $linenr < $end_line; $linenr++) { 899 my $line = $rawlines[$linenr - 1]; 900 #warn " $line\n"; 901 if ($linenr == $first_line and $line =~ m@^.\s*\*@) { 902 $in_comment = 1; 903 } 904 if ($line =~ m@/\*@) { 905 $in_comment = 1; 906 } 907 if (!$in_comment && $current_comment ne '') { 908 $current_comment = ''; 909 } 910 $current_comment .= $line . "\n" if ($in_comment); 911 if ($line =~ m@\*/@) { 912 $in_comment = 0; 913 } 914 } 915 916 chomp($current_comment); 917 return($current_comment); 918} 919sub ctx_has_comment { 920 my ($first_line, $end_line) = @_; 921 my $cmt = ctx_locate_comment($first_line, $end_line); 922 923 ##print "LINE: $rawlines[$end_line - 1 ]\n"; 924 ##print "CMMT: $cmt\n"; 925 926 return ($cmt ne ''); 927} 928 929sub raw_line { 930 my ($linenr, $cnt) = @_; 931 932 my $offset = $linenr - 1; 933 $cnt++; 934 935 my $line; 936 while ($cnt) { 937 $line = $rawlines[$offset++]; 938 next if (defined($line) && $line =~ /^-/); 939 $cnt--; 940 } 941 942 return $line; 943} 944 945sub cat_vet { 946 my ($vet) = @_; 947 my ($res, $coded); 948 949 $res = ''; 950 while ($vet =~ /([^[:cntrl:]]*)([[:cntrl:]]|$)/g) { 951 $res .= $1; 952 if ($2 ne '') { 953 $coded = sprintf("^%c", unpack('C', $2) + 64); 954 $res .= $coded; 955 } 956 } 957 $res =~ s/$/\$/; 958 959 return $res; 960} 961 962my $av_preprocessor = 0; 963my $av_pending; 964my @av_paren_type; 965my $av_pend_colon; 966 967sub annotate_reset { 968 $av_preprocessor = 0; 969 $av_pending = '_'; 970 @av_paren_type = ('E'); 971 $av_pend_colon = 'O'; 972} 973 974sub annotate_values { 975 my ($stream, $type) = @_; 976 977 my $res; 978 my $var = '_' x length($stream); 979 my $cur = $stream; 980 981 print "$stream\n" if ($dbg_values > 1); 982 983 while (length($cur)) { 984 @av_paren_type = ('E') if ($#av_paren_type < 0); 985 print " <" . join('', @av_paren_type) . 986 "> <$type> <$av_pending>" if ($dbg_values > 1); 987 if ($cur =~ /^(\s+)/o) { 988 print "WS($1)\n" if ($dbg_values > 1); 989 if ($1 =~ /\n/ && $av_preprocessor) { 990 $type = pop(@av_paren_type); 991 $av_preprocessor = 0; 992 } 993 994 } elsif ($cur =~ /^(\(\s*$Type\s*)\)/ && $av_pending eq '_') { 995 print "CAST($1)\n" if ($dbg_values > 1); 996 push(@av_paren_type, $type); 997 $type = 'C'; 998 999 } elsif ($cur =~ /^($Type)\s*(?:$Ident|,|\)|\(|\s*$)/) { 1000 print "DECLARE($1)\n" if ($dbg_values > 1); 1001 $type = 'T'; 1002 1003 } elsif ($cur =~ /^($Modifier)\s*/) { 1004 print "MODIFIER($1)\n" if ($dbg_values > 1); 1005 $type = 'T'; 1006 1007 } elsif ($cur =~ /^(\#\s*define\s*$Ident)(\(?)/o) { 1008 print "DEFINE($1,$2)\n" if ($dbg_values > 1); 1009 $av_preprocessor = 1; 1010 push(@av_paren_type, $type); 1011 if ($2 ne '') { 1012 $av_pending = 'N'; 1013 } 1014 $type = 'E'; 1015 1016 } elsif ($cur =~ /^(\#\s*(?:undef\s*$Ident|include\b))/o) { 1017 print "UNDEF($1)\n" if ($dbg_values > 1); 1018 $av_preprocessor = 1; 1019 push(@av_paren_type, $type); 1020 1021 } elsif ($cur =~ /^(\#\s*(?:ifdef|ifndef|if))/o) { 1022 print "PRE_START($1)\n" if ($dbg_values > 1); 1023 $av_preprocessor = 1; 1024 1025 push(@av_paren_type, $type); 1026 push(@av_paren_type, $type); 1027 $type = 'E'; 1028 1029 } elsif ($cur =~ /^(\#\s*(?:else|elif))/o) { 1030 print "PRE_RESTART($1)\n" if ($dbg_values > 1); 1031 $av_preprocessor = 1; 1032 1033 push(@av_paren_type, $av_paren_type[$#av_paren_type]); 1034 1035 $type = 'E'; 1036 1037 } elsif ($cur =~ /^(\#\s*(?:endif))/o) { 1038 print "PRE_END($1)\n" if ($dbg_values > 1); 1039 1040 $av_preprocessor = 1; 1041 1042 # Assume all arms of the conditional end as this 1043 # one does, and continue as if the #endif was not here. 1044 pop(@av_paren_type); 1045 push(@av_paren_type, $type); 1046 $type = 'E'; 1047 1048 } elsif ($cur =~ /^(\\\n)/o) { 1049 print "PRECONT($1)\n" if ($dbg_values > 1); 1050 1051 } elsif ($cur =~ /^(__attribute__)\s*\(?/o) { 1052 print "ATTR($1)\n" if ($dbg_values > 1); 1053 $av_pending = $type; 1054 $type = 'N'; 1055 1056 } elsif ($cur =~ /^(sizeof)\s*(\()?/o) { 1057 print "SIZEOF($1)\n" if ($dbg_values > 1); 1058 if (defined $2) { 1059 $av_pending = 'V'; 1060 } 1061 $type = 'N'; 1062 1063 } elsif ($cur =~ /^(if|while|for)\b/o) { 1064 print "COND($1)\n" if ($dbg_values > 1); 1065 $av_pending = 'E'; 1066 $type = 'N'; 1067 1068 } elsif ($cur =~/^(case)/o) { 1069 print "CASE($1)\n" if ($dbg_values > 1); 1070 $av_pend_colon = 'C'; 1071 $type = 'N'; 1072 1073 } elsif ($cur =~/^(return|else|goto|typeof|__typeof__)\b/o) { 1074 print "KEYWORD($1)\n" if ($dbg_values > 1); 1075 $type = 'N'; 1076 1077 } elsif ($cur =~ /^(\()/o) { 1078 print "PAREN('$1')\n" if ($dbg_values > 1); 1079 push(@av_paren_type, $av_pending); 1080 $av_pending = '_'; 1081 $type = 'N'; 1082 1083 } elsif ($cur =~ /^(\))/o) { 1084 my $new_type = pop(@av_paren_type); 1085 if ($new_type ne '_') { 1086 $type = $new_type; 1087 print "PAREN('$1') -> $type\n" 1088 if ($dbg_values > 1); 1089 } else { 1090 print "PAREN('$1')\n" if ($dbg_values > 1); 1091 } 1092 1093 } elsif ($cur =~ /^($Ident)\s*\(/o) { 1094 print "FUNC($1)\n" if ($dbg_values > 1); 1095 $type = 'V'; 1096 $av_pending = 'V'; 1097 1098 } elsif ($cur =~ /^($Ident\s*):(?:\s*\d+\s*(,|=|;))?/) { 1099 if (defined $2 && $type eq 'C' || $type eq 'T') { 1100 $av_pend_colon = 'B'; 1101 } elsif ($type eq 'E') { 1102 $av_pend_colon = 'L'; 1103 } 1104 print "IDENT_COLON($1,$type>$av_pend_colon)\n" if ($dbg_values > 1); 1105 $type = 'V'; 1106 1107 } elsif ($cur =~ /^($Ident|$Constant)/o) { 1108 print "IDENT($1)\n" if ($dbg_values > 1); 1109 $type = 'V'; 1110 1111 } elsif ($cur =~ /^($Assignment)/o) { 1112 print "ASSIGN($1)\n" if ($dbg_values > 1); 1113 $type = 'N'; 1114 1115 } elsif ($cur =~/^(;|{|})/) { 1116 print "END($1)\n" if ($dbg_values > 1); 1117 $type = 'E'; 1118 $av_pend_colon = 'O'; 1119 1120 } elsif ($cur =~/^(,)/) { 1121 print "COMMA($1)\n" if ($dbg_values > 1); 1122 $type = 'C'; 1123 1124 } elsif ($cur =~ /^(\?)/o) { 1125 print "QUESTION($1)\n" if ($dbg_values > 1); 1126 $type = 'N'; 1127 1128 } elsif ($cur =~ /^(:)/o) { 1129 print "COLON($1,$av_pend_colon)\n" if ($dbg_values > 1); 1130 1131 substr($var, length($res), 1, $av_pend_colon); 1132 if ($av_pend_colon eq 'C' || $av_pend_colon eq 'L') { 1133 $type = 'E'; 1134 } else { 1135 $type = 'N'; 1136 } 1137 $av_pend_colon = 'O'; 1138 1139 } elsif ($cur =~ /^(\[)/o) { 1140 print "CLOSE($1)\n" if ($dbg_values > 1); 1141 $type = 'N'; 1142 1143 } elsif ($cur =~ /^(-(?![->])|\+(?!\+)|\*|\&\&|\&)/o) { 1144 my $variant; 1145 1146 print "OPV($1)\n" if ($dbg_values > 1); 1147 if ($type eq 'V') { 1148 $variant = 'B'; 1149 } else { 1150 $variant = 'U'; 1151 } 1152 1153 substr($var, length($res), 1, $variant); 1154 $type = 'N'; 1155 1156 } elsif ($cur =~ /^($Operators)/o) { 1157 print "OP($1)\n" if ($dbg_values > 1); 1158 if ($1 ne '++' && $1 ne '--') { 1159 $type = 'N'; 1160 } 1161 1162 } elsif ($cur =~ /(^.)/o) { 1163 print "C($1)\n" if ($dbg_values > 1); 1164 } 1165 if (defined $1) { 1166 $cur = substr($cur, length($1)); 1167 $res .= $type x length($1); 1168 } 1169 } 1170 1171 return ($res, $var); 1172} 1173 1174sub possible { 1175 my ($possible, $line) = @_; 1176 my $notPermitted = qr{(?: 1177 ^(?: 1178 $Modifier| 1179 $Storage| 1180 $Type| 1181 DEFINE_\S+ 1182 )$| 1183 ^(?: 1184 goto| 1185 return| 1186 case| 1187 else| 1188 asm|__asm__| 1189 do 1190 )(?:\s|$)| 1191 ^(?:typedef|struct|enum)\b| 1192 ^\# 1193 )}x; 1194 warn "CHECK<$possible> ($line)\n" if ($dbg_possible > 2); 1195 if ($possible !~ $notPermitted) { 1196 # Check for modifiers. 1197 $possible =~ s/\s*$Storage\s*//g; 1198 $possible =~ s/\s*$Sparse\s*//g; 1199 if ($possible =~ /^\s*$/) { 1200 1201 } elsif ($possible =~ /\s/) { 1202 $possible =~ s/\s*(?:$Type|\#\#)\s*//g; 1203 for my $modifier (split(' ', $possible)) { 1204 if ($modifier !~ $notPermitted) { 1205 warn "MODIFIER: $modifier ($possible) ($line)\n" if ($dbg_possible); 1206 push(@modifierList, $modifier); 1207 } 1208 } 1209 1210 } else { 1211 warn "POSSIBLE: $possible ($line)\n" if ($dbg_possible); 1212 push(@typeList, $possible); 1213 } 1214 build_types(); 1215 } else { 1216 warn "NOTPOSS: $possible ($line)\n" if ($dbg_possible > 1); 1217 } 1218} 1219 1220my $prefix = ''; 1221 1222sub report { 1223 my ($level, $msg) = @_; 1224 if (defined $tst_only && $msg !~ /\Q$tst_only\E/) { 1225 return 0; 1226 } 1227 1228 my $output = ''; 1229 $output .= BOLD if $color; 1230 $output .= $prefix; 1231 $output .= RED if $color && $level eq 'ERROR'; 1232 $output .= MAGENTA if $color && $level eq 'WARNING'; 1233 $output .= $level . ':'; 1234 $output .= RESET if $color; 1235 $output .= ' ' . $msg . "\n"; 1236 1237 $output = (split('\n', $output))[0] . "\n" if ($terse); 1238 1239 push(our @report, $output); 1240 1241 return 1; 1242} 1243sub report_dump { 1244 our @report; 1245} 1246sub ERROR { 1247 if (report("ERROR", $_[0])) { 1248 our $clean = 0; 1249 our $cnt_error++; 1250 } 1251} 1252sub WARN { 1253 if (report("WARNING", $_[0])) { 1254 our $clean = 0; 1255 our $cnt_warn++; 1256 } 1257} 1258 1259sub process { 1260 my $filename = shift; 1261 1262 my $linenr=0; 1263 my $prevline=""; 1264 my $prevrawline=""; 1265 my $stashline=""; 1266 my $stashrawline=""; 1267 1268 my $length; 1269 my $indent; 1270 my $previndent=0; 1271 my $stashindent=0; 1272 1273 our $clean = 1; 1274 my $signoff = 0; 1275 my $is_patch = 0; 1276 1277 my $in_header_lines = $file ? 0 : 1; 1278 my $in_commit_log = 0; #Scanning lines before patch 1279 my $reported_maintainer_file = 0; 1280 my $non_utf8_charset = 0; 1281 1282 our @report = (); 1283 our $cnt_lines = 0; 1284 our $cnt_error = 0; 1285 our $cnt_warn = 0; 1286 our $cnt_chk = 0; 1287 1288 # Trace the real file/line as we go. 1289 my $realfile = ''; 1290 my $realline = 0; 1291 my $realcnt = 0; 1292 my $here = ''; 1293 my $in_comment = 0; 1294 my $comment_edge = 0; 1295 my $first_line = 0; 1296 my $p1_prefix = ''; 1297 1298 my $prev_values = 'E'; 1299 1300 # suppression flags 1301 my %suppress_ifbraces; 1302 my %suppress_whiletrailers; 1303 my %suppress_export; 1304 1305 # Pre-scan the patch sanitizing the lines. 1306 1307 sanitise_line_reset(); 1308 my $line; 1309 foreach my $rawline (@rawlines) { 1310 $linenr++; 1311 $line = $rawline; 1312 1313 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1314 $realline=$1-1; 1315 if (defined $2) { 1316 $realcnt=$3+1; 1317 } else { 1318 $realcnt=1+1; 1319 } 1320 $in_comment = 0; 1321 1322 # Guestimate if this is a continuing comment. Run 1323 # the context looking for a comment "edge". If this 1324 # edge is a close comment then we must be in a comment 1325 # at context start. 1326 my $edge; 1327 my $cnt = $realcnt; 1328 for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 1329 next if (defined $rawlines[$ln - 1] && 1330 $rawlines[$ln - 1] =~ /^-/); 1331 $cnt--; 1332 #print "RAW<$rawlines[$ln - 1]>\n"; 1333 last if (!defined $rawlines[$ln - 1]); 1334 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1335 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1336 ($edge) = $1; 1337 last; 1338 } 1339 } 1340 if (defined $edge && $edge eq '*/') { 1341 $in_comment = 1; 1342 } 1343 1344 # Guestimate if this is a continuing comment. If this 1345 # is the start of a diff block and this line starts 1346 # ' *' then it is very likely a comment. 1347 if (!defined $edge && 1348 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1349 { 1350 $in_comment = 1; 1351 } 1352 1353 ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1354 sanitise_line_reset($in_comment); 1355 1356 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1357 # Standardise the strings and chars within the input to 1358 # simplify matching -- only bother with positive lines. 1359 $line = sanitise_line($rawline); 1360 } 1361 push(@lines, $line); 1362 1363 if ($realcnt > 1) { 1364 $realcnt-- if ($line =~ /^(?:\+| |$)/); 1365 } else { 1366 $realcnt = 0; 1367 } 1368 1369 #print "==>$rawline\n"; 1370 #print "-->$line\n"; 1371 } 1372 1373 $prefix = ''; 1374 1375 $realcnt = 0; 1376 $linenr = 0; 1377 foreach my $line (@lines) { 1378 $linenr++; 1379 1380 my $rawline = $rawlines[$linenr - 1]; 1381 1382#extract the line range in the file after the patch is applied 1383 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1384 $is_patch = 1; 1385 $first_line = $linenr + 1; 1386 $realline=$1-1; 1387 if (defined $2) { 1388 $realcnt=$3+1; 1389 } else { 1390 $realcnt=1+1; 1391 } 1392 annotate_reset(); 1393 $prev_values = 'E'; 1394 1395 %suppress_ifbraces = (); 1396 %suppress_whiletrailers = (); 1397 %suppress_export = (); 1398 next; 1399 1400# track the line number as we move through the hunk, note that 1401# new versions of GNU diff omit the leading space on completely 1402# blank context lines so we need to count that too. 1403 } elsif ($line =~ /^( |\+|$)/) { 1404 $realline++; 1405 $realcnt-- if ($realcnt != 0); 1406 1407 # Measure the line length and indent. 1408 ($length, $indent) = line_stats($rawline); 1409 1410 # Track the previous line. 1411 ($prevline, $stashline) = ($stashline, $line); 1412 ($previndent, $stashindent) = ($stashindent, $indent); 1413 ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1414 1415 #warn "line<$line>\n"; 1416 1417 } elsif ($realcnt == 1) { 1418 $realcnt--; 1419 } 1420 1421 my $hunk_line = ($realcnt != 0); 1422 1423#make up the handle for any error we report on this line 1424 $prefix = "$filename:$realline: " if ($emacs && $file); 1425 $prefix = "$filename:$linenr: " if ($emacs && !$file); 1426 1427 $here = "#$linenr: " if (!$file); 1428 $here = "#$realline: " if ($file); 1429 1430 # extract the filename as it passes 1431 if ($line =~ /^diff --git.*?(\S+)$/) { 1432 $realfile = $1; 1433 $realfile =~ s@^([^/]*)/@@ if (!$file); 1434 } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1435 $realfile = $1; 1436 $realfile =~ s@^([^/]*)/@@ if (!$file); 1437 1438 $p1_prefix = $1; 1439 if (!$file && $tree && $p1_prefix ne '' && 1440 -e "$root/$p1_prefix") { 1441 WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 1442 } 1443 1444 next; 1445 } 1446 1447 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 1448 1449 my $hereline = "$here\n$rawline\n"; 1450 my $herecurr = "$here\n$rawline\n"; 1451 my $hereprev = "$here\n$prevrawline\n$rawline\n"; 1452 1453 $cnt_lines++ if ($realcnt != 0); 1454 1455# Check for incorrect file permissions 1456 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 1457 my $permhere = $here . "FILE: $realfile\n"; 1458 if ($realfile =~ /(\bMakefile(?:\.objs)?|\.c|\.cc|\.cpp|\.h|\.mak|\.[sS])$/) { 1459 ERROR("do not set execute permissions for source files\n" . $permhere); 1460 } 1461 } 1462 1463# Only allow Python 3 interpreter 1464 if ($realline == 1 && 1465 $line =~ /^\+#!\ *\/usr\/bin\/(?:env )?python$/) { 1466 ERROR("please use python3 interpreter\n" . $herecurr); 1467 } 1468 1469# Accept git diff extended headers as valid patches 1470 if ($line =~ /^(?:rename|copy) (?:from|to) [\w\/\.\-]+\s*$/) { 1471 $is_patch = 1; 1472 } 1473 1474 if ($line =~ /^Author: .*via Qemu-devel.*<qemu-devel\@nongnu.org>/) { 1475 ERROR("Author email address is mangled by the mailing list\n" . $herecurr); 1476 } 1477 1478#check the patch for a signoff: 1479 if ($line =~ /^\s*signed-off-by:/i) { 1480 # This is a signoff, if ugly, so do not double report. 1481 $signoff++; 1482 $in_commit_log = 0; 1483 1484 if (!($line =~ /^\s*Signed-off-by:/)) { 1485 ERROR("The correct form is \"Signed-off-by\"\n" . 1486 $herecurr); 1487 } 1488 if ($line =~ /^\s*signed-off-by:\S/i) { 1489 ERROR("space required after Signed-off-by:\n" . 1490 $herecurr); 1491 } 1492 } 1493 1494# Check if MAINTAINERS is being updated. If so, there's probably no need to 1495# emit the "does MAINTAINERS need updating?" message on file add/move/delete 1496 if ($line =~ /^\s*MAINTAINERS\s*\|/) { 1497 $reported_maintainer_file = 1; 1498 } 1499 1500# Check for added, moved or deleted files 1501 if (!$reported_maintainer_file && !$in_commit_log && 1502 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 1503 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 1504 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 1505 (defined($1) || defined($2))))) { 1506 $reported_maintainer_file = 1; 1507 WARN("added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 1508 } 1509 1510# Check for wrappage within a valid hunk of the file 1511 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1512 ERROR("patch seems to be corrupt (line wrapped?)\n" . 1513 $herecurr) if (!$emitted_corrupt++); 1514 } 1515 1516# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1517 if (($realfile =~ /^$/ || $line =~ /^\+/) && 1518 $rawline !~ m/^$UTF8*$/) { 1519 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1520 1521 my $blank = copy_spacing($rawline); 1522 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1523 my $hereptr = "$hereline$ptr\n"; 1524 1525 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 1526 } 1527 1528 if ($rawline =~ m/$UTF8_MOJIBAKE/) { 1529 ERROR("Doubly-encoded UTF-8\n" . $herecurr); 1530 } 1531# Check if it's the start of a commit log 1532# (not a header line and we haven't seen the patch filename) 1533 if ($in_header_lines && $realfile =~ /^$/ && 1534 !($rawline =~ /^\s+\S/ || 1535 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 1536 $in_header_lines = 0; 1537 $in_commit_log = 1; 1538 } 1539 1540# Check if there is UTF-8 in a commit log when a mail header has explicitly 1541# declined it, i.e defined some charset where it is missing. 1542 if ($in_header_lines && 1543 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1544 $1 !~ /utf-8/i) { 1545 $non_utf8_charset = 1; 1546 } 1547 1548 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 1549 $rawline =~ /$NON_ASCII_UTF8/) { 1550 WARN("8-bit UTF-8 used in possible commit log\n" . $herecurr); 1551 } 1552 1553# ignore non-hunk lines and lines being removed 1554 next if (!$hunk_line || $line =~ /^-/); 1555 1556# ignore files that are being periodically imported from Linux 1557 next if ($realfile =~ /^(linux-headers|include\/standard-headers)\//); 1558 1559#trailing whitespace 1560 if ($line =~ /^\+.*\015/) { 1561 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1562 ERROR("DOS line endings\n" . $herevet); 1563 1564 } elsif ($realfile =~ /^docs\/.+\.txt/ || 1565 $realfile =~ /^docs\/.+\.md/) { 1566 if ($rawline =~ /^\+\s+$/ && $rawline !~ /^\+ {4}$/) { 1567 # TODO: properly check we're in a code block 1568 # (surrounding text is 4-column aligned) 1569 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1570 ERROR("code blocks in documentation should have " . 1571 "empty lines with exactly 4 columns of " . 1572 "whitespace\n" . $herevet); 1573 } 1574 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1575 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1576 ERROR("trailing whitespace\n" . $herevet); 1577 $rpt_cleaners = 1; 1578 } 1579 1580# checks for trace-events files 1581 if ($realfile =~ /trace-events$/ && $line =~ /^\+/) { 1582 if ($rawline =~ /%[-+ 0]*#/) { 1583 ERROR("Don't use '#' flag of printf format ('%#') in " . 1584 "trace-events, use '0x' prefix instead\n" . $herecurr); 1585 } else { 1586 my $hex = 1587 qr/%[-+ *.0-9]*([hljztL]|ll|hh)?(x|X|"\s*PRI[xX][^"]*"?)/; 1588 1589 # don't consider groups splitted by [.:/ ], like 2A.20:12ab 1590 my $tmpline = $rawline; 1591 $tmpline =~ s/($hex[.:\/ ])+$hex//g; 1592 1593 if ($tmpline =~ /(?<!0x)$hex/) { 1594 ERROR("Hex numbers must be prefixed with '0x'\n" . 1595 $herecurr); 1596 } 1597 } 1598 } 1599 1600# check we are in a valid source file if not then ignore this hunk 1601 next if ($realfile !~ /$SrcFile/); 1602 1603#90 column limit; exempt URLs, if no other words on line 1604 if ($line =~ /^\+/ && 1605 !($line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 1606 !($rawline =~ /^[^[:alnum:]]*https?:\S*$/) && 1607 $length > 80) 1608 { 1609 if ($length > 90) { 1610 ERROR("line over 90 characters\n" . $herecurr); 1611 } else { 1612 WARN("line over 80 characters\n" . $herecurr); 1613 } 1614 } 1615 1616# check for spaces before a quoted newline 1617 if ($rawline =~ /^.*\".*\s\\n/) { 1618 ERROR("unnecessary whitespace before a quoted newline\n" . $herecurr); 1619 } 1620 1621# check for adding lines without a newline. 1622 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 1623 ERROR("adding a line without newline at end of file\n" . $herecurr); 1624 } 1625 1626# check for RCS/CVS revision markers 1627 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|\b)/) { 1628 ERROR("CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1629 } 1630 1631# tabs are only allowed in assembly source code, and in 1632# some scripts we imported from other projects. 1633 next if ($realfile =~ /\.(s|S)$/); 1634 next if ($realfile =~ /(checkpatch|get_maintainer|texi2pod)\.pl$/); 1635 1636 if ($rawline =~ /^\+.*\t/) { 1637 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1638 ERROR("code indent should never use tabs\n" . $herevet); 1639 $rpt_cleaners = 1; 1640 } 1641 1642# check we are in a valid C source file if not then ignore this hunk 1643 next if ($realfile !~ /\.(h|c|cpp)$/); 1644 1645# Block comment styles 1646 1647 # Block comments use /* on a line of its own 1648 if ($rawline !~ m@^\+.*/\*.*\*/[ \t)}]*$@ && #inline /*...*/ 1649 $rawline =~ m@^\+.*/\*\*?+[ \t]*[^ \t]@) { # /* or /** non-blank 1650 WARN("Block comments use a leading /* on a separate line\n" . $herecurr); 1651 } 1652 1653# Block comments use * on subsequent lines 1654 if ($prevline =~ /$;[ \t]*$/ && #ends in comment 1655 $prevrawline =~ /^\+.*?\/\*/ && #starting /* 1656 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 1657 $rawline =~ /^\+/ && #line is new 1658 $rawline !~ /^\+[ \t]*\*/) { #no leading * 1659 WARN("Block comments use * on subsequent lines\n" . $hereprev); 1660 } 1661 1662# Block comments use */ on trailing lines 1663 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 1664 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 1665 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 1666 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 1667 WARN("Block comments use a trailing */ on a separate line\n" . $herecurr); 1668 } 1669 1670# Block comment * alignment 1671 if ($prevline =~ /$;[ \t]*$/ && #ends in comment 1672 $line =~ /^\+[ \t]*$;/ && #leading comment 1673 $rawline =~ /^\+[ \t]*\*/ && #leading * 1674 (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 1675 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 1676 $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 1677 my $oldindent; 1678 $prevrawline =~ m@^\+([ \t]*/?)\*@; 1679 if (defined($1)) { 1680 $oldindent = expand_tabs($1); 1681 } else { 1682 $prevrawline =~ m@^\+(.*/?)\*@; 1683 $oldindent = expand_tabs($1); 1684 } 1685 $rawline =~ m@^\+([ \t]*)\*@; 1686 my $newindent = $1; 1687 $newindent = expand_tabs($newindent); 1688 if (length($oldindent) ne length($newindent)) { 1689 WARN("Block comments should align the * on each line\n" . $hereprev); 1690 } 1691 } 1692 1693# Check for potential 'bare' types 1694 my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 1695 $realline_next); 1696 if ($realcnt && $line =~ /.\s*\S/) { 1697 ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1698 ctx_statement_block($linenr, $realcnt, 0); 1699 $stat =~ s/\n./\n /g; 1700 $cond =~ s/\n./\n /g; 1701 1702 # Find the real next line. 1703 $realline_next = $line_nr_next; 1704 if (defined $realline_next && 1705 (!defined $lines[$realline_next - 1] || 1706 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 1707 $realline_next++; 1708 } 1709 1710 my $s = $stat; 1711 $s =~ s/{.*$//s; 1712 1713 # Ignore goto labels. 1714 if ($s =~ /$Ident:\*$/s) { 1715 1716 # Ignore functions being called 1717 } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1718 1719 } elsif ($s =~ /^.\s*else\b/s) { 1720 1721 # declarations always start with types 1722 } 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) { 1723 my $type = $1; 1724 $type =~ s/\s+/ /g; 1725 possible($type, "A:" . $s); 1726 1727 # definitions in global scope can only start with types 1728 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 1729 possible($1, "B:" . $s); 1730 } 1731 1732 # any (foo ... *) is a pointer cast, and foo is a type 1733 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 1734 possible($1, "C:" . $s); 1735 } 1736 1737 # Check for any sort of function declaration. 1738 # int foo(something bar, other baz); 1739 # void (*store_gdt)(x86_descr_ptr *); 1740 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 1741 my ($name_len) = length($1); 1742 1743 my $ctx = $s; 1744 substr($ctx, 0, $name_len + 1, ''); 1745 $ctx =~ s/\)[^\)]*$//; 1746 1747 for my $arg (split(/\s*,\s*/, $ctx)) { 1748 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 1749 1750 possible($1, "D:" . $s); 1751 } 1752 } 1753 } 1754 1755 } 1756 1757# 1758# Checks which may be anchored in the context. 1759# 1760 1761# Check for switch () and associated case and default 1762# statements should be at the same indent. 1763 if ($line=~/\bswitch\s*\(.*\)/) { 1764 my $err = ''; 1765 my $sep = ''; 1766 my @ctx = ctx_block_outer($linenr, $realcnt); 1767 shift(@ctx); 1768 for my $ctx (@ctx) { 1769 my ($clen, $cindent) = line_stats($ctx); 1770 if ($ctx =~ /^\+\s*(case\s+|default:)/ && 1771 $indent != $cindent) { 1772 $err .= "$sep$ctx\n"; 1773 $sep = ''; 1774 } else { 1775 $sep = "[...]\n"; 1776 } 1777 } 1778 if ($err ne '') { 1779 ERROR("switch and case should be at the same indent\n$hereline$err"); 1780 } 1781 } 1782 1783# if/while/etc brace do not go on next line, unless defining a do while loop, 1784# or if that brace on the next line is for something else 1785 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 1786 my $pre_ctx = "$1$2"; 1787 1788 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 1789 my $ctx_cnt = $realcnt - $#ctx - 1; 1790 my $ctx = join("\n", @ctx); 1791 1792 my $ctx_ln = $linenr; 1793 my $ctx_skip = $realcnt; 1794 1795 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 1796 defined $lines[$ctx_ln - 1] && 1797 $lines[$ctx_ln - 1] =~ /^-/)) { 1798 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 1799 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 1800 $ctx_ln++; 1801 } 1802 1803 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 1804 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 1805 1806 # The length of the "previous line" is checked against 80 because it 1807 # includes the + at the beginning of the line (if the actual line has 1808 # 79 or 80 characters, it is no longer possible to add a space and an 1809 # opening brace there) 1810 if ($#ctx == 0 && $ctx !~ /{\s*/ && 1811 defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*\{/ && 1812 defined($lines[$ctx_ln - 2]) && length($lines[$ctx_ln - 2]) < 80) { 1813 ERROR("that open brace { should be on the previous line\n" . 1814 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 1815 } 1816 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 1817 $ctx =~ /\)\s*\;\s*$/ && 1818 defined $lines[$ctx_ln - 1]) 1819 { 1820 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 1821 if ($nindent > $indent) { 1822 ERROR("trailing semicolon indicates no statements, indent implies otherwise\n" . 1823 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 1824 } 1825 } 1826 } 1827 1828# 'do ... while (0/false)' only makes sense in macros, without trailing ';' 1829 if ($line =~ /while\s*\((0|false)\);/) { 1830 ERROR("suspicious ; after while (0)\n" . $herecurr); 1831 } 1832 1833# Check relative indent for conditionals and blocks. 1834 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 1835 my ($s, $c) = ($stat, $cond); 1836 1837 substr($s, 0, length($c), ''); 1838 1839 # Make sure we remove the line prefixes as we have 1840 # none on the first line, and are going to readd them 1841 # where necessary. 1842 $s =~ s/\n./\n/gs; 1843 1844 # Find out how long the conditional actually is. 1845 my @newlines = ($c =~ /\n/gs); 1846 my $cond_lines = 1 + $#newlines; 1847 1848 # We want to check the first line inside the block 1849 # starting at the end of the conditional, so remove: 1850 # 1) any blank line termination 1851 # 2) any opening brace { on end of the line 1852 # 3) any do (...) { 1853 my $continuation = 0; 1854 my $check = 0; 1855 $s =~ s/^.*\bdo\b//; 1856 $s =~ s/^\s*\{//; 1857 if ($s =~ s/^\s*\\//) { 1858 $continuation = 1; 1859 } 1860 if ($s =~ s/^\s*?\n//) { 1861 $check = 1; 1862 $cond_lines++; 1863 } 1864 1865 # Also ignore a loop construct at the end of a 1866 # preprocessor statement. 1867 if (($prevline =~ /^.\s*#\s*define\s/ || 1868 $prevline =~ /\\\s*$/) && $continuation == 0) { 1869 $check = 0; 1870 } 1871 1872 my $cond_ptr = -1; 1873 $continuation = 0; 1874 while ($cond_ptr != $cond_lines) { 1875 $cond_ptr = $cond_lines; 1876 1877 # If we see an #else/#elif then the code 1878 # is not linear. 1879 if ($s =~ /^\s*\#\s*(?:else|elif)/) { 1880 $check = 0; 1881 } 1882 1883 # Ignore: 1884 # 1) blank lines, they should be at 0, 1885 # 2) preprocessor lines, and 1886 # 3) labels. 1887 if ($continuation || 1888 $s =~ /^\s*?\n/ || 1889 $s =~ /^\s*#\s*?/ || 1890 $s =~ /^\s*$Ident\s*:/) { 1891 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 1892 if ($s =~ s/^.*?\n//) { 1893 $cond_lines++; 1894 } 1895 } 1896 } 1897 1898 my (undef, $sindent) = line_stats("+" . $s); 1899 my $stat_real = raw_line($linenr, $cond_lines); 1900 1901 # Check if either of these lines are modified, else 1902 # this is not this patch's fault. 1903 if (!defined($stat_real) || 1904 $stat !~ /^\+/ && $stat_real !~ /^\+/) { 1905 $check = 0; 1906 } 1907 if (defined($stat_real) && $cond_lines > 1) { 1908 $stat_real = "[...]\n$stat_real"; 1909 } 1910 1911 #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"; 1912 1913 if ($check && (($sindent % 4) != 0 || 1914 ($sindent <= $indent && $s ne ''))) { 1915 ERROR("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 1916 } 1917 } 1918 1919 # Track the 'values' across context and added lines. 1920 my $opline = $line; $opline =~ s/^./ /; 1921 my ($curr_values, $curr_vars) = 1922 annotate_values($opline . "\n", $prev_values); 1923 $curr_values = $prev_values . $curr_values; 1924 if ($dbg_values) { 1925 my $outline = $opline; $outline =~ s/\t/ /g; 1926 print "$linenr > .$outline\n"; 1927 print "$linenr > $curr_values\n"; 1928 print "$linenr > $curr_vars\n"; 1929 } 1930 $prev_values = substr($curr_values, -1); 1931 1932#ignore lines not being added 1933 if ($line=~/^[^\+]/) {next;} 1934 1935# TEST: allow direct testing of the type matcher. 1936 if ($dbg_type) { 1937 if ($line =~ /^.\s*$Declare\s*$/) { 1938 ERROR("TEST: is type\n" . $herecurr); 1939 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 1940 ERROR("TEST: is not type ($1 is)\n". $herecurr); 1941 } 1942 next; 1943 } 1944# TEST: allow direct testing of the attribute matcher. 1945 if ($dbg_attr) { 1946 if ($line =~ /^.\s*$Modifier\s*$/) { 1947 ERROR("TEST: is attr\n" . $herecurr); 1948 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 1949 ERROR("TEST: is not attr ($1 is)\n". $herecurr); 1950 } 1951 next; 1952 } 1953 1954# check for initialisation to aggregates open brace on the next line 1955 if ($line =~ /^.\s*\{/ && 1956 $prevline =~ /(?:^|[^=])=\s*$/) { 1957 ERROR("that open brace { should be on the previous line\n" . $hereprev); 1958 } 1959 1960# 1961# Checks which are anchored on the added line. 1962# 1963 1964# check for malformed paths in #include statements (uses RAW line) 1965 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 1966 my $path = $1; 1967 if ($path =~ m{//}) { 1968 ERROR("malformed #include filename\n" . 1969 $herecurr); 1970 } 1971 } 1972 1973# no C99 // comments 1974 if ($line =~ m{//} && 1975 $rawline !~ m{// SPDX-License-Identifier: }) { 1976 ERROR("do not use C99 // comments\n" . $herecurr); 1977 } 1978 # Remove C99 comments. 1979 $line =~ s@//.*@@; 1980 $opline =~ s@//.*@@; 1981 1982# check for global initialisers. 1983 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 1984 ERROR("do not initialise globals to 0 or NULL\n" . 1985 $herecurr); 1986 } 1987# check for static initialisers. 1988 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 1989 ERROR("do not initialise statics to 0 or NULL\n" . 1990 $herecurr); 1991 } 1992 1993# * goes on variable not on type 1994 # (char*[ const]) 1995 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) { 1996 my ($from, $to) = ($1, $1); 1997 1998 # Should start with a space. 1999 $to =~ s/^(\S)/ $1/; 2000 # Should not end with a space. 2001 $to =~ s/\s+$//; 2002 # '*'s should not have spaces between. 2003 while ($to =~ s/\*\s+\*/\*\*/) { 2004 } 2005 2006 #print "from<$from> to<$to>\n"; 2007 if ($from ne $to) { 2008 ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 2009 } 2010 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) { 2011 my ($from, $to, $ident) = ($1, $1, $2); 2012 2013 # Should start with a space. 2014 $to =~ s/^(\S)/ $1/; 2015 # Should not end with a space. 2016 $to =~ s/\s+$//; 2017 # '*'s should not have spaces between. 2018 while ($to =~ s/\*\s+\*/\*\*/) { 2019 } 2020 # Modifiers should have spaces. 2021 $to =~ s/(\b$Modifier$)/$1 /; 2022 2023 #print "from<$from> to<$to> ident<$ident>\n"; 2024 if ($from ne $to && $ident !~ /^$Modifier$/) { 2025 ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 2026 } 2027 } 2028 2029# function brace can't be on same line, except for #defines of do while, 2030# or if closed on same line 2031 if (($line=~/$Type\s*$Ident\(.*\).*\s\{/) and 2032 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) { 2033 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr); 2034 } 2035 2036# open braces for enum, union and struct go on the same line. 2037 if ($line =~ /^.\s*\{/ && 2038 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2039 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev); 2040 } 2041 2042# missing space after union, struct or enum definition 2043 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { 2044 ERROR("missing space after $1 definition\n" . $herecurr); 2045 } 2046 2047# check for spacing round square brackets; allowed: 2048# 1. with a type on the left -- int [] a; 2049# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2050# 3. inside a curly brace -- = { [0...10] = 5 } 2051# 4. after a comma -- [1] = 5, [2] = 6 2052# 5. in a macro definition -- #define abc(x) [x] = y 2053 while ($line =~ /(.*?\s)\[/g) { 2054 my ($where, $prefix) = ($-[1], $1); 2055 if ($prefix !~ /$Type\s+$/ && 2056 ($where != 0 || $prefix !~ /^.\s+$/) && 2057 $prefix !~ /\#\s*define[^(]*\([^)]*\)\s+$/ && 2058 $prefix !~ /[,{:]\s+$/) { 2059 ERROR("space prohibited before open square bracket '['\n" . $herecurr); 2060 } 2061 } 2062 2063# check for spaces between functions and their parentheses. 2064 while ($line =~ /($Ident)\s+\(/g) { 2065 my $name = $1; 2066 my $ctx_before = substr($line, 0, $-[1]); 2067 my $ctx = "$ctx_before$name"; 2068 2069 # Ignore those directives where spaces _are_ permitted. 2070 if ($name =~ /^(?: 2071 if|for|while|switch|return|case| 2072 volatile|__volatile__|coroutine_fn| 2073 __attribute__|format|__extension__| 2074 asm|__asm__)$/x) 2075 { 2076 2077 # Ignore 'catch (...)' in C++ 2078 } elsif ($name =~ /^catch$/ && $realfile =~ /(\.cpp|\.h)$/) { 2079 2080 # cpp #define statements have non-optional spaces, ie 2081 # if there is a space between the name and the open 2082 # parenthesis it is simply not a parameter group. 2083 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2084 2085 # cpp #elif statement condition may start with a ( 2086 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2087 2088 # If this whole things ends with a type its most 2089 # likely a typedef for a function. 2090 } elsif ($ctx =~ /$Type$/) { 2091 2092 } else { 2093 ERROR("space prohibited between function name and open parenthesis '('\n" . $herecurr); 2094 } 2095 } 2096# Check operator spacing. 2097 if (!($line=~/\#\s*include/)) { 2098 my $ops = qr{ 2099 <<=|>>=|<=|>=|==|!=| 2100 \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 2101 =>|->|<<|>>|<|>|=|!|~| 2102 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 2103 \?|::|: 2104 }x; 2105 my @elements = split(/($ops|;)/, $opline); 2106 my $off = 0; 2107 2108 my $blank = copy_spacing($opline); 2109 2110 for (my $n = 0; $n < $#elements; $n += 2) { 2111 $off += length($elements[$n]); 2112 2113 # Pick up the preceding and succeeding characters. 2114 my $ca = substr($opline, 0, $off); 2115 my $cc = ''; 2116 if (length($opline) >= ($off + length($elements[$n + 1]))) { 2117 $cc = substr($opline, $off + length($elements[$n + 1])); 2118 } 2119 my $cb = "$ca$;$cc"; 2120 2121 my $a = ''; 2122 $a = 'V' if ($elements[$n] ne ''); 2123 $a = 'W' if ($elements[$n] =~ /\s$/); 2124 $a = 'C' if ($elements[$n] =~ /$;$/); 2125 $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 2126 $a = 'O' if ($elements[$n] eq ''); 2127 $a = 'E' if ($ca =~ /^\s*$/); 2128 2129 my $op = $elements[$n + 1]; 2130 2131 my $c = ''; 2132 if (defined $elements[$n + 2]) { 2133 $c = 'V' if ($elements[$n + 2] ne ''); 2134 $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2135 $c = 'C' if ($elements[$n + 2] =~ /^$;/); 2136 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 2137 $c = 'O' if ($elements[$n + 2] eq ''); 2138 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 2139 } else { 2140 $c = 'E'; 2141 } 2142 2143 my $ctx = "${a}x${c}"; 2144 2145 my $at = "(ctx:$ctx)"; 2146 2147 my $ptr = substr($blank, 0, $off) . "^"; 2148 my $hereptr = "$hereline$ptr\n"; 2149 2150 # Pull out the value of this operator. 2151 my $op_type = substr($curr_values, $off + 1, 1); 2152 2153 # Get the full operator variant. 2154 my $opv = $op . substr($curr_vars, $off, 1); 2155 2156 # Ignore operators passed as parameters. 2157 if ($op_type ne 'V' && 2158 $ca =~ /\s$/ && $cc =~ /^\s*,/) { 2159 2160# # Ignore comments 2161# } elsif ($op =~ /^$;+$/) { 2162 2163 # ; should have either the end of line or a space or \ after it 2164 } elsif ($op eq ';') { 2165 if ($ctx !~ /.x[WEBC]/ && 2166 $cc !~ /^\\/ && $cc !~ /^;/) { 2167 ERROR("space required after that '$op' $at\n" . $hereptr); 2168 } 2169 2170 # // is a comment 2171 } elsif ($op eq '//') { 2172 2173 # Ignore : used in class declaration in C++ 2174 } elsif ($opv eq ':B' && $ctx =~ /Wx[WE]/ && 2175 $line =~ /class/ && $realfile =~ /(\.cpp|\.h)$/) { 2176 2177 # No spaces for: 2178 # -> 2179 # : when part of a bitfield 2180 } elsif ($op eq '->' || $opv eq ':B') { 2181 if ($ctx =~ /Wx.|.xW/) { 2182 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr); 2183 } 2184 2185 # , must have a space on the right. 2186 # not required when having a single },{ on one line 2187 } elsif ($op eq ',') { 2188 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/ && 2189 ($elements[$n] . $elements[$n + 2]) !~ " *}\\{") { 2190 ERROR("space required after that '$op' $at\n" . $hereptr); 2191 } 2192 2193 # '*' as part of a type definition -- reported already. 2194 } elsif ($opv eq '*_') { 2195 #warn "'*' is part of type\n"; 2196 2197 # unary operators should have a space before and 2198 # none after. May be left adjacent to another 2199 # unary operator, or a cast 2200 } elsif ($op eq '!' || $op eq '~' || 2201 $opv eq '*U' || $opv eq '-U' || 2202 $opv eq '&U' || $opv eq '&&U') { 2203 if ($op eq '~' && $ca =~ /::$/ && $realfile =~ /(\.cpp|\.h)$/) { 2204 # '~' used as a name of Destructor 2205 2206 } elsif ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 2207 ERROR("space required before that '$op' $at\n" . $hereptr); 2208 } 2209 if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 2210 # A unary '*' may be const 2211 2212 } elsif ($ctx =~ /.xW/) { 2213 ERROR("space prohibited after that '$op' $at\n" . $hereptr); 2214 } 2215 2216 # unary ++ and unary -- are allowed no space on one side. 2217 } elsif ($op eq '++' or $op eq '--') { 2218 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 2219 ERROR("space required one side of that '$op' $at\n" . $hereptr); 2220 } 2221 if ($ctx =~ /Wx[BE]/ || 2222 ($ctx =~ /Wx./ && $cc =~ /^;/)) { 2223 ERROR("space prohibited before that '$op' $at\n" . $hereptr); 2224 } 2225 if ($ctx =~ /ExW/) { 2226 ERROR("space prohibited after that '$op' $at\n" . $hereptr); 2227 } 2228 2229 # A colon needs no spaces before when it is 2230 # terminating a case value or a label. 2231 } elsif ($opv eq ':C' || $opv eq ':L') { 2232 if ($ctx =~ /Wx./) { 2233 ERROR("space prohibited before that '$op' $at\n" . $hereptr); 2234 } 2235 2236 # All the others need spaces both sides. 2237 } elsif ($ctx !~ /[EWC]x[CWE]/) { 2238 my $ok = 0; 2239 2240 if ($realfile =~ /\.cpp|\.h$/) { 2241 # Ignore template arguments <...> in C++ 2242 if (($op eq '<' || $op eq '>') && $line =~ /<.*>/) { 2243 $ok = 1; 2244 } 2245 2246 # Ignore :: in C++ 2247 if ($op eq '::') { 2248 $ok = 1; 2249 } 2250 } 2251 2252 # Ignore email addresses <foo@bar> 2253 if (($op eq '<' && 2254 $cc =~ /^\S+\@\S+>/) || 2255 ($op eq '>' && 2256 $ca =~ /<\S+\@\S+$/)) 2257 { 2258 $ok = 1; 2259 } 2260 2261 # Ignore ?: 2262 if (($opv eq ':O' && $ca =~ /\?$/) || 2263 ($op eq '?' && $cc =~ /^:/)) { 2264 $ok = 1; 2265 } 2266 2267 if ($ok == 0) { 2268 ERROR("spaces required around that '$op' $at\n" . $hereptr); 2269 } 2270 } 2271 $off += length($elements[$n + 1]); 2272 } 2273 } 2274 2275#need space before brace following if, while, etc 2276 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 2277 $line =~ /do\{/) { 2278 ERROR("space required before the open brace '{'\n" . $herecurr); 2279 } 2280 2281# closing brace should have a space following it when it has anything 2282# on the line 2283 if ($line =~ /}(?!(?:,|;|\)))\S/) { 2284 ERROR("space required after that close brace '}'\n" . $herecurr); 2285 } 2286 2287# check spacing on square brackets 2288 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 2289 ERROR("space prohibited after that open square bracket '['\n" . $herecurr); 2290 } 2291 if ($line =~ /\s\]/) { 2292 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr); 2293 } 2294 2295# check spacing on parentheses 2296 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 2297 $line !~ /for\s*\(\s+;/) { 2298 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr); 2299 } 2300 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 2301 $line !~ /for\s*\(.*;\s+\)/ && 2302 $line !~ /:\s+\)/) { 2303 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr); 2304 } 2305 2306# Return is not a function. 2307 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 2308 my $spacing = $1; 2309 my $value = $2; 2310 2311 # Flatten any parentheses 2312 $value =~ s/\(/ \(/g; 2313 $value =~ s/\)/\) /g; 2314 while ($value =~ s/\[[^\{\}]*\]/1/ || 2315 $value !~ /(?:$Ident|-?$Constant)\s* 2316 $Compare\s* 2317 (?:$Ident|-?$Constant)/x && 2318 $value =~ s/\([^\(\)]*\)/1/) { 2319 } 2320#print "value<$value>\n"; 2321 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/ && 2322 $line =~ /;$/) { 2323 ERROR("return is not a function, parentheses are not required\n" . $herecurr); 2324 2325 } elsif ($spacing !~ /\s+/) { 2326 ERROR("space required before the open parenthesis '('\n" . $herecurr); 2327 } 2328 } 2329# Return of what appears to be an errno should normally be -'ve 2330 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 2331 my $name = $1; 2332 if ($name ne 'EOF' && $name ne 'ERROR') { 2333 ERROR("return of an errno should typically be -ve (return -$1)\n" . $herecurr); 2334 } 2335 } 2336 2337 if ($line =~ /^.\s*(Q(?:S?LIST|SIMPLEQ|TAILQ)_HEAD)\s*\(\s*[^,]/ && 2338 $line !~ /^.typedef/) { 2339 ERROR("named $1 should be typedefed separately\n" . $herecurr); 2340 } 2341 2342# Need a space before open parenthesis after if, while etc 2343 if ($line=~/\b(if|while|for|switch)\(/) { 2344 ERROR("space required before the open parenthesis '('\n" . $herecurr); 2345 } 2346 2347# Check for illegal assignment in if conditional -- and check for trailing 2348# statements after the conditional. 2349 if ($line =~ /do\s*(?!{)/) { 2350 my ($stat_next) = ctx_statement_block($line_nr_next, 2351 $remain_next, $off_next); 2352 $stat_next =~ s/\n./\n /g; 2353 ##print "stat<$stat> stat_next<$stat_next>\n"; 2354 2355 if ($stat_next =~ /^\s*while\b/) { 2356 # If the statement carries leading newlines, 2357 # then count those as offsets. 2358 my ($whitespace) = 2359 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 2360 my $offset = 2361 statement_rawlines($whitespace) - 1; 2362 2363 $suppress_whiletrailers{$line_nr_next + 2364 $offset} = 1; 2365 } 2366 } 2367 if (!defined $suppress_whiletrailers{$linenr} && 2368 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 2369 my ($s, $c) = ($stat, $cond); 2370 2371 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 2372 ERROR("do not use assignment in if condition\n" . $herecurr); 2373 } 2374 2375 # Find out what is on the end of the line after the 2376 # conditional. 2377 substr($s, 0, length($c), ''); 2378 $s =~ s/\n.*//g; 2379 $s =~ s/$;//g; # Remove any comments 2380 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 2381 $c !~ /}\s*while\s*/) 2382 { 2383 # Find out how long the conditional actually is. 2384 my @newlines = ($c =~ /\n/gs); 2385 my $cond_lines = 1 + $#newlines; 2386 my $stat_real = ''; 2387 2388 $stat_real = raw_line($linenr, $cond_lines) 2389 . "\n" if ($cond_lines); 2390 if (defined($stat_real) && $cond_lines > 1) { 2391 $stat_real = "[...]\n$stat_real"; 2392 } 2393 2394 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real); 2395 } 2396 } 2397 2398# Check for bitwise tests written as boolean 2399 if ($line =~ / 2400 (?: 2401 (?:\[|\(|\&\&|\|\|) 2402 \s*0[xX][0-9]+\s* 2403 (?:\&\&|\|\|) 2404 | 2405 (?:\&\&|\|\|) 2406 \s*0[xX][0-9]+\s* 2407 (?:\&\&|\|\||\)|\]) 2408 )/x) 2409 { 2410 ERROR("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 2411 } 2412 2413# if and else should not have general statements after it 2414 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 2415 my $s = $1; 2416 $s =~ s/$;//g; # Remove any comments 2417 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 2418 ERROR("trailing statements should be on next line\n" . $herecurr); 2419 } 2420 } 2421# if should not continue a brace 2422 if ($line =~ /}\s*if\b/) { 2423 ERROR("trailing statements should be on next line\n" . 2424 $herecurr); 2425 } 2426# case and default should not have general statements after them 2427 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 2428 $line !~ /\G(?: 2429 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 2430 \s*return\s+ 2431 )/xg) 2432 { 2433 ERROR("trailing statements should be on next line\n" . $herecurr); 2434 } 2435 2436 # Check for }<nl>else {, these must be at the same 2437 # indent level to be relevant to each other. 2438 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 2439 $previndent == $indent) { 2440 ERROR("else should follow close brace '}'\n" . $hereprev); 2441 } 2442 2443 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 2444 $previndent == $indent) { 2445 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 2446 2447 # Find out what is on the end of the line after the 2448 # conditional. 2449 substr($s, 0, length($c), ''); 2450 $s =~ s/\n.*//g; 2451 2452 if ($s =~ /^\s*;/) { 2453 ERROR("while should follow close brace '}'\n" . $hereprev); 2454 } 2455 } 2456 2457#studly caps, commented out until figure out how to distinguish between use of existing and adding new 2458# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { 2459# print "No studly caps, use _\n"; 2460# print "$herecurr"; 2461# $clean = 0; 2462# } 2463 2464#no spaces allowed after \ in define 2465 if ($line=~/\#\s*define.*\\\s$/) { 2466 ERROR("Whitespace after \\ makes next lines useless\n" . $herecurr); 2467 } 2468 2469# multi-statement macros should be enclosed in a do while loop, grab the 2470# first statement and ensure its the whole macro if its not enclosed 2471# in a known good container 2472 if ($realfile !~ m@/vmlinux.lds.h$@ && 2473 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 2474 my $ln = $linenr; 2475 my $cnt = $realcnt; 2476 my ($off, $dstat, $dcond, $rest); 2477 my $ctx = ''; 2478 2479 my $args = defined($1); 2480 2481 # Find the end of the macro and limit our statement 2482 # search to that. 2483 while ($cnt > 0 && defined $lines[$ln - 1] && 2484 $lines[$ln - 1] =~ /^(?:-|..*\\$)/) 2485 { 2486 $ctx .= $rawlines[$ln - 1] . "\n"; 2487 $cnt-- if ($lines[$ln - 1] !~ /^-/); 2488 $ln++; 2489 } 2490 $ctx .= $rawlines[$ln - 1]; 2491 2492 ($dstat, $dcond, $ln, $cnt, $off) = 2493 ctx_statement_block($linenr, $ln - $linenr + 1, 0); 2494 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 2495 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 2496 2497 # Extract the remainder of the define (if any) and 2498 # rip off surrounding spaces, and trailing \'s. 2499 $rest = ''; 2500 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) { 2501 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n"; 2502 if ($off != 0 || $lines[$ln - 1] !~ /^-/) { 2503 $rest .= substr($lines[$ln - 1], $off) . "\n"; 2504 $cnt--; 2505 } 2506 $ln++; 2507 $off = 0; 2508 } 2509 $rest =~ s/\\\n.//g; 2510 $rest =~ s/^\s*//s; 2511 $rest =~ s/\s*$//s; 2512 2513 # Clean up the original statement. 2514 if ($args) { 2515 substr($dstat, 0, length($dcond), ''); 2516 } else { 2517 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//; 2518 } 2519 $dstat =~ s/$;//g; 2520 $dstat =~ s/\\\n.//g; 2521 $dstat =~ s/^\s*//s; 2522 $dstat =~ s/\s*$//s; 2523 2524 # Flatten any parentheses and braces 2525 while ($dstat =~ s/\([^\(\)]*\)/1/ || 2526 $dstat =~ s/\{[^\{\}]*\}/1/ || 2527 $dstat =~ s/\[[^\{\}]*\]/1/) 2528 { 2529 } 2530 2531 my $exceptions = qr{ 2532 $Declare| 2533 module_param_named| 2534 MODULE_PARAM_DESC| 2535 DECLARE_PER_CPU| 2536 DEFINE_PER_CPU| 2537 __typeof__\(| 2538 union| 2539 struct| 2540 \.$Ident\s*=\s*| 2541 ^\"|\"$ 2542 }x; 2543 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 2544 if ($rest ne '' && $rest ne ',') { 2545 if ($rest !~ /while\s*\(/ && 2546 $dstat !~ /$exceptions/) 2547 { 2548 ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n"); 2549 } 2550 2551 } elsif ($ctx !~ /;/) { 2552 if ($dstat ne '' && 2553 $dstat !~ /^(?:$Ident|-?$Constant)$/ && 2554 $dstat !~ /$exceptions/ && 2555 $dstat !~ /^\.$Ident\s*=/ && 2556 $dstat =~ /$Operators/) 2557 { 2558 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n"); 2559 } 2560 } 2561 } 2562 2563# check for missing bracing around if etc 2564 if ($line =~ /(^.*)\b(?:if|while|for)\b/ && 2565 $line !~ /\#\s*if/) { 2566 my $allowed = 0; 2567 2568 # Check the pre-context. 2569 if ($line =~ /(\}.*?)$/) { 2570 my $pre = $1; 2571 2572 if ($line !~ /else/) { 2573 print "APW: ALLOWED: pre<$pre> line<$line>\n" 2574 if $dbg_adv_apw; 2575 $allowed = 1; 2576 } 2577 } 2578 my ($level, $endln, @chunks) = 2579 ctx_statement_full($linenr, $realcnt, 1); 2580 if ($dbg_adv_apw) { 2581 print "APW: chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 2582 print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n" 2583 if $#chunks >= 1; 2584 } 2585 if ($#chunks >= 0 && $level == 0) { 2586 my $seen = 0; 2587 my $herectx = $here . "\n"; 2588 my $ln = $linenr - 1; 2589 for my $chunk (@chunks) { 2590 my ($cond, $block) = @{$chunk}; 2591 2592 # If the condition carries leading newlines, then count those as offsets. 2593 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 2594 my $offset = statement_rawlines($whitespace) - 1; 2595 2596 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 2597 2598 # We have looked at and allowed this specific line. 2599 $suppress_ifbraces{$ln + $offset} = 1; 2600 2601 $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 2602 $ln += statement_rawlines($block) - 1; 2603 2604 substr($block, 0, length($cond), ''); 2605 2606 my $spaced_block = $block; 2607 $spaced_block =~ s/\n\+/ /g; 2608 2609 $seen++ if ($spaced_block =~ /^\s*\{/); 2610 2611 print "APW: cond<$cond> block<$block> allowed<$allowed>\n" 2612 if $dbg_adv_apw; 2613 if (statement_lines($cond) > 1) { 2614 print "APW: ALLOWED: cond<$cond>\n" 2615 if $dbg_adv_apw; 2616 $allowed = 1; 2617 } 2618 if ($block =~/\b(?:if|for|while)\b/) { 2619 print "APW: ALLOWED: block<$block>\n" 2620 if $dbg_adv_apw; 2621 $allowed = 1; 2622 } 2623 if (statement_block_size($block) > 1) { 2624 print "APW: ALLOWED: lines block<$block>\n" 2625 if $dbg_adv_apw; 2626 $allowed = 1; 2627 } 2628 } 2629 if ($seen != ($#chunks + 1) && !$allowed) { 2630 ERROR("braces {} are necessary for all arms of this statement\n" . $herectx); 2631 } 2632 } 2633 } 2634 if (!defined $suppress_ifbraces{$linenr - 1} && 2635 $line =~ /\b(if|while|for|else)\b/ && 2636 $line !~ /\#\s*if/ && 2637 $line !~ /\#\s*else/) { 2638 my $allowed = 0; 2639 2640 # Check the pre-context. 2641 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 2642 my $pre = $1; 2643 2644 if ($line !~ /else/) { 2645 print "APW: ALLOWED: pre<$pre> line<$line>\n" 2646 if $dbg_adv_apw; 2647 $allowed = 1; 2648 } 2649 } 2650 2651 my ($level, $endln, @chunks) = 2652 ctx_statement_full($linenr, $realcnt, $-[0]); 2653 2654 # Check the condition. 2655 my ($cond, $block) = @{$chunks[0]}; 2656 print "CHECKING<$linenr> cond<$cond> block<$block>\n" 2657 if $dbg_adv_checking; 2658 if (defined $cond) { 2659 substr($block, 0, length($cond), ''); 2660 } 2661 if (statement_lines($cond) > 1) { 2662 print "APW: ALLOWED: cond<$cond>\n" 2663 if $dbg_adv_apw; 2664 $allowed = 1; 2665 } 2666 if ($block =~/\b(?:if|for|while)\b/) { 2667 print "APW: ALLOWED: block<$block>\n" 2668 if $dbg_adv_apw; 2669 $allowed = 1; 2670 } 2671 if (statement_block_size($block) > 1) { 2672 print "APW: ALLOWED: lines block<$block>\n" 2673 if $dbg_adv_apw; 2674 $allowed = 1; 2675 } 2676 # Check the post-context. 2677 if (defined $chunks[1]) { 2678 my ($cond, $block) = @{$chunks[1]}; 2679 if (defined $cond) { 2680 substr($block, 0, length($cond), ''); 2681 } 2682 if ($block =~ /^\s*\{/) { 2683 print "APW: ALLOWED: chunk-1 block<$block>\n" 2684 if $dbg_adv_apw; 2685 $allowed = 1; 2686 } 2687 } 2688 print "DCS: level=$level block<$block> allowed=$allowed\n" 2689 if $dbg_adv_dcs; 2690 if ($level == 0 && $block !~ /^\s*\{/ && !$allowed) { 2691 my $herectx = $here . "\n";; 2692 my $cnt = statement_rawlines($block); 2693 2694 for (my $n = 0; $n < $cnt; $n++) { 2695 $herectx .= raw_line($linenr, $n) . "\n";; 2696 } 2697 2698 ERROR("braces {} are necessary even for single statement blocks\n" . $herectx); 2699 } 2700 } 2701 2702# no volatiles please 2703 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 2704 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/ && 2705 $line !~ /sig_atomic_t/ && 2706 !ctx_has_comment($first_line, $linenr)) { 2707 my $msg = "Use of volatile is usually wrong, please add a comment\n" . $herecurr; 2708 ERROR($msg); 2709 } 2710 2711# warn about #if 0 2712 if ($line =~ /^.\s*\#\s*if\s+0\b/) { 2713 ERROR("if this code is redundant consider removing it\n" . 2714 $herecurr); 2715 } 2716 2717# check for needless g_free() checks 2718 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 2719 my $expr = $1; 2720 if ($line =~ /\bg_free\(\Q$expr\E\);/) { 2721 ERROR("g_free(NULL) is safe this check is probably not required\n" . $hereprev); 2722 } 2723 } 2724 2725# warn about #ifdefs in C files 2726# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 2727# print "#ifdef in C files should be avoided\n"; 2728# print "$herecurr"; 2729# $clean = 0; 2730# } 2731 2732# warn about spacing in #ifdefs 2733 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 2734 ERROR("exactly one space required after that #$1\n" . $herecurr); 2735 } 2736# check for memory barriers without a comment. 2737 if ($line =~ /\b(smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 2738 if (!ctx_has_comment($first_line, $linenr)) { 2739 ERROR("memory barrier without comment\n" . $herecurr); 2740 } 2741 } 2742# check of hardware specific defines 2743# we have e.g. CONFIG_LINUX and CONFIG_WIN32 for common cases 2744# where they might be necessary. 2745 if ($line =~ m@^.\s*\#\s*if.*\b__@) { 2746 WARN("architecture specific defines should be avoided\n" . $herecurr); 2747 } 2748 2749# Check that the storage class is at the beginning of a declaration 2750 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 2751 ERROR("storage class should be at the beginning of the declaration\n" . $herecurr) 2752 } 2753 2754# check the location of the inline attribute, that it is between 2755# storage class and type. 2756 if ($line =~ /\b$Type\s+$Inline\b/ || 2757 $line =~ /\b$Inline\s+$Storage\b/) { 2758 ERROR("inline keyword should sit between storage class and type\n" . $herecurr); 2759 } 2760 2761# check for sizeof(&) 2762 if ($line =~ /\bsizeof\s*\(\s*\&/) { 2763 ERROR("sizeof(& should be avoided\n" . $herecurr); 2764 } 2765 2766# check for new externs in .c files. 2767 if ($realfile =~ /\.c$/ && defined $stat && 2768 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 2769 { 2770 my $function_name = $1; 2771 my $paren_space = $2; 2772 2773 my $s = $stat; 2774 if (defined $cond) { 2775 substr($s, 0, length($cond), ''); 2776 } 2777 if ($s =~ /^\s*;/ && 2778 $function_name ne 'uninitialized_var') 2779 { 2780 ERROR("externs should be avoided in .c files\n" . $herecurr); 2781 } 2782 2783 if ($paren_space =~ /\n/) { 2784 ERROR("arguments for function declarations should follow identifier\n" . $herecurr); 2785 } 2786 2787 } elsif ($realfile =~ /\.c$/ && defined $stat && 2788 $stat =~ /^.\s*extern\s+/) 2789 { 2790 ERROR("externs should be avoided in .c files\n" . $herecurr); 2791 } 2792 2793# check for pointless casting of g_malloc return 2794 if ($line =~ /\*\s*\)\s*g_(try)?(m|re)alloc(0?)(_n)?\b/) { 2795 if ($2 == 'm') { 2796 ERROR("unnecessary cast may hide bugs, use g_$1new$3 instead\n" . $herecurr); 2797 } else { 2798 ERROR("unnecessary cast may hide bugs, use g_$1renew$3 instead\n" . $herecurr); 2799 } 2800 } 2801 2802# check for gcc specific __FUNCTION__ 2803 if ($line =~ /__FUNCTION__/) { 2804 ERROR("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 2805 } 2806 2807# recommend g_path_get_* over g_strdup(basename/dirname(...)) 2808 if ($line =~ /\bg_strdup\s*\(\s*(basename|dirname)\s*\(/) { 2809 WARN("consider using g_path_get_$1() in preference to g_strdup($1())\n" . $herecurr); 2810 } 2811 2812# recommend qemu_strto* over strto* for numeric conversions 2813 if ($line =~ /\b(strto[^kd].*?)\s*\(/) { 2814 ERROR("consider using qemu_$1 in preference to $1\n" . $herecurr); 2815 } 2816# recommend sigaction over signal for portability, when establishing a handler 2817 if ($line =~ /\bsignal\s*\(/ && !($line =~ /SIG_(?:IGN|DFL)/)) { 2818 ERROR("use sigaction to establish signal handlers; signal is not portable\n" . $herecurr); 2819 } 2820# check for module_init(), use category-specific init macros explicitly please 2821 if ($line =~ /^module_init\s*\(/) { 2822 ERROR("please use block_init(), type_init() etc. instead of module_init()\n" . $herecurr); 2823 } 2824# check for various ops structs, ensure they are const. 2825 my $struct_ops = qr{AIOCBInfo| 2826 BdrvActionOps| 2827 BlockDevOps| 2828 BlockJobDriver| 2829 DisplayChangeListenerOps| 2830 GraphicHwOps| 2831 IDEDMAOps| 2832 KVMCapabilityInfo| 2833 MemoryRegionIOMMUOps| 2834 MemoryRegionOps| 2835 MemoryRegionPortio| 2836 QEMUFileOps| 2837 SCSIBusInfo| 2838 SCSIReqOps| 2839 Spice[A-Z][a-zA-Z0-9]*Interface| 2840 USBDesc[A-Z][a-zA-Z0-9]*| 2841 VhostOps| 2842 VMStateDescription| 2843 VMStateInfo}x; 2844 if ($line !~ /\bconst\b/ && 2845 $line =~ /\b($struct_ops)\b.*=/) { 2846 ERROR("initializer for struct $1 should normally be const\n" . 2847 $herecurr); 2848 } 2849 2850# check for %L{u,d,i} in strings 2851 my $string; 2852 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 2853 $string = substr($rawline, $-[1], $+[1] - $-[1]); 2854 $string =~ s/%%/__/g; 2855 if ($string =~ /(?<!%)%L[udi]/) { 2856 ERROR("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 2857 last; 2858 } 2859 } 2860 2861# QEMU specific tests 2862 if ($rawline =~ /\b(?:Qemu|QEmu)\b/) { 2863 ERROR("use QEMU instead of Qemu or QEmu\n" . $herecurr); 2864 } 2865 2866# Qemu error function tests 2867 2868 # Find newlines in error messages 2869 my $qemu_error_funcs = qr{error_setg| 2870 error_setg_errno| 2871 error_setg_win32| 2872 error_setg_file_open| 2873 error_set| 2874 error_prepend| 2875 warn_reportf_err| 2876 error_reportf_err| 2877 error_vreport| 2878 warn_vreport| 2879 info_vreport| 2880 error_report| 2881 warn_report| 2882 info_report| 2883 g_test_message}x; 2884 2885 if ($rawline =~ /\b(?:$qemu_error_funcs)\s*\(.*\".*\\n/) { 2886 ERROR("Error messages should not contain newlines\n" . $herecurr); 2887 } 2888 2889 # Continue checking for error messages that contains newlines. This 2890 # check handles cases where string literals are spread over multiple lines. 2891 # Example: 2892 # error_report("Error msg line #1" 2893 # "Error msg line #2\n"); 2894 my $quoted_newline_regex = qr{\+\s*\".*\\n.*\"}; 2895 my $continued_str_literal = qr{\+\s*\".*\"}; 2896 2897 if ($rawline =~ /$quoted_newline_regex/) { 2898 # Backtrack to first line that does not contain only a quoted literal 2899 # and assume that it is the start of the statement. 2900 my $i = $linenr - 2; 2901 2902 while (($i >= 0) & $rawlines[$i] =~ /$continued_str_literal/) { 2903 $i--; 2904 } 2905 2906 if ($rawlines[$i] =~ /\b(?:$qemu_error_funcs)\s*\(/) { 2907 ERROR("Error messages should not contain newlines\n" . $herecurr); 2908 } 2909 } 2910 2911# check for non-portable libc calls that have portable alternatives in QEMU 2912 if ($line =~ /\bffs\(/) { 2913 ERROR("use ctz32() instead of ffs()\n" . $herecurr); 2914 } 2915 if ($line =~ /\bffsl\(/) { 2916 ERROR("use ctz32() or ctz64() instead of ffsl()\n" . $herecurr); 2917 } 2918 if ($line =~ /\bffsll\(/) { 2919 ERROR("use ctz64() instead of ffsll()\n" . $herecurr); 2920 } 2921 if ($line =~ /\bbzero\(/) { 2922 ERROR("use memset() instead of bzero()\n" . $herecurr); 2923 } 2924 if ($line =~ /\bgetpagesize\(\)/) { 2925 ERROR("use qemu_real_host_page_size instead of getpagesize()\n" . $herecurr); 2926 } 2927 if ($line =~ /\bsysconf\(_SC_PAGESIZE\)/) { 2928 ERROR("use qemu_real_host_page_size instead of sysconf(_SC_PAGESIZE)\n" . $herecurr); 2929 } 2930 my $non_exit_glib_asserts = qr{g_assert_cmpstr| 2931 g_assert_cmpint| 2932 g_assert_cmpuint| 2933 g_assert_cmphex| 2934 g_assert_cmpfloat| 2935 g_assert_true| 2936 g_assert_false| 2937 g_assert_nonnull| 2938 g_assert_null| 2939 g_assert_no_error| 2940 g_assert_error| 2941 g_test_assert_expected_messages| 2942 g_test_trap_assert_passed| 2943 g_test_trap_assert_stdout| 2944 g_test_trap_assert_stdout_unmatched| 2945 g_test_trap_assert_stderr| 2946 g_test_trap_assert_stderr_unmatched}x; 2947 if ($realfile !~ /^tests\// && 2948 $line =~ /\b(?:$non_exit_glib_asserts)\(/) { 2949 ERROR("Use g_assert or g_assert_not_reached\n". $herecurr); 2950 } 2951 } 2952 2953 if ($is_patch && $chk_signoff && $signoff == 0) { 2954 ERROR("Missing Signed-off-by: line(s)\n"); 2955 } 2956 2957 # If we have no input at all, then there is nothing to report on 2958 # so just keep quiet. 2959 if ($#rawlines == -1) { 2960 return 1; 2961 } 2962 2963 # In mailback mode only produce a report in the negative, for 2964 # things that appear to be patches. 2965 if ($mailback && ($clean == 1 || !$is_patch)) { 2966 return 1; 2967 } 2968 2969 # This is not a patch, and we are are in 'no-patch' mode so 2970 # just keep quiet. 2971 if (!$chk_patch && !$is_patch) { 2972 return 1; 2973 } 2974 2975 if (!$is_patch) { 2976 ERROR("Does not appear to be a unified-diff format patch\n"); 2977 } 2978 2979 print report_dump(); 2980 if ($summary && !($clean == 1 && $quiet == 1)) { 2981 print "$filename " if ($summary_file); 2982 print "total: $cnt_error errors, $cnt_warn warnings, " . 2983 "$cnt_lines lines checked\n"; 2984 print "\n" if ($quiet == 0); 2985 } 2986 2987 if ($quiet == 0) { 2988 # If there were whitespace errors which cleanpatch can fix 2989 # then suggest that. 2990# if ($rpt_cleaners) { 2991# print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 2992# print " scripts/cleanfile\n\n"; 2993# } 2994 } 2995 2996 if ($clean == 1 && $quiet == 0) { 2997 print "$vname has no obvious style problems and is ready for submission.\n" 2998 } 2999 if ($clean == 0 && $quiet == 0) { 3000 print "$vname has style problems, please review. If any of these errors\n"; 3001 print "are false positives report them to the maintainer, see\n"; 3002 print "CHECKPATCH in MAINTAINERS.\n"; 3003 } 3004 3005 return ($no_warnings ? $clean : $cnt_error == 0); 3006} 3007