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 qemu 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 qemu 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 qemu 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 '$ARGV[0]'\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", "--patch-with-stat", $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 "linux-user", "softmmu" 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 1259# According to tests/qtest/bios-tables-test.c: do not 1260# change expected file in the same commit with adding test 1261sub checkfilename { 1262 my ($name, $acpi_testexpected, $acpi_nontestexpected) = @_; 1263 1264 # Note: shell script that rebuilds the expected files is in the same 1265 # directory as files themselves. 1266 # Note: allowed diff list can be changed both when changing expected 1267 # files and when changing tests. 1268 if ($name =~ m#^tests/data/acpi/# and not $name =~ m#^\.sh$#) { 1269 $$acpi_testexpected = $name; 1270 } elsif ($name !~ m#^tests/qtest/bios-tables-test-allowed-diff.h$#) { 1271 $$acpi_nontestexpected = $name; 1272 } 1273 if (defined $$acpi_testexpected and defined $$acpi_nontestexpected) { 1274 ERROR("Do not add expected files together with tests, " . 1275 "follow instructions in " . 1276 "tests/qtest/bios-tables-test.c: both " . 1277 $$acpi_testexpected . " and " . 1278 $$acpi_nontestexpected . " found\n"); 1279 } 1280} 1281 1282sub process { 1283 my $filename = shift; 1284 1285 my $linenr=0; 1286 my $prevline=""; 1287 my $prevrawline=""; 1288 my $stashline=""; 1289 my $stashrawline=""; 1290 1291 my $length; 1292 my $indent; 1293 my $previndent=0; 1294 my $stashindent=0; 1295 1296 our $clean = 1; 1297 my $signoff = 0; 1298 my $is_patch = 0; 1299 1300 my $in_header_lines = $file ? 0 : 1; 1301 my $in_commit_log = 0; #Scanning lines before patch 1302 my $reported_maintainer_file = 0; 1303 my $non_utf8_charset = 0; 1304 1305 our @report = (); 1306 our $cnt_lines = 0; 1307 our $cnt_error = 0; 1308 our $cnt_warn = 0; 1309 our $cnt_chk = 0; 1310 1311 # Trace the real file/line as we go. 1312 my $realfile = ''; 1313 my $realline = 0; 1314 my $realcnt = 0; 1315 my $here = ''; 1316 my $in_comment = 0; 1317 my $comment_edge = 0; 1318 my $first_line = 0; 1319 my $p1_prefix = ''; 1320 1321 my $prev_values = 'E'; 1322 1323 # suppression flags 1324 my %suppress_ifbraces; 1325 my %suppress_whiletrailers; 1326 my %suppress_export; 1327 1328 my $acpi_testexpected; 1329 my $acpi_nontestexpected; 1330 1331 # Pre-scan the patch sanitizing the lines. 1332 1333 sanitise_line_reset(); 1334 my $line; 1335 foreach my $rawline (@rawlines) { 1336 $linenr++; 1337 $line = $rawline; 1338 1339 if ($rawline=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1340 $realline=$1-1; 1341 if (defined $2) { 1342 $realcnt=$3+1; 1343 } else { 1344 $realcnt=1+1; 1345 } 1346 $in_comment = 0; 1347 1348 # Guestimate if this is a continuing comment. Run 1349 # the context looking for a comment "edge". If this 1350 # edge is a close comment then we must be in a comment 1351 # at context start. 1352 my $edge; 1353 my $cnt = $realcnt; 1354 for (my $ln = $linenr + 1; $cnt > 0; $ln++) { 1355 next if (defined $rawlines[$ln - 1] && 1356 $rawlines[$ln - 1] =~ /^-/); 1357 $cnt--; 1358 #print "RAW<$rawlines[$ln - 1]>\n"; 1359 last if (!defined $rawlines[$ln - 1]); 1360 if ($rawlines[$ln - 1] =~ m@(/\*|\*/)@ && 1361 $rawlines[$ln - 1] !~ m@"[^"]*(?:/\*|\*/)[^"]*"@) { 1362 ($edge) = $1; 1363 last; 1364 } 1365 } 1366 if (defined $edge && $edge eq '*/') { 1367 $in_comment = 1; 1368 } 1369 1370 # Guestimate if this is a continuing comment. If this 1371 # is the start of a diff block and this line starts 1372 # ' *' then it is very likely a comment. 1373 if (!defined $edge && 1374 $rawlines[$linenr] =~ m@^.\s*(?:\*\*+| \*)(?:\s|$)@) 1375 { 1376 $in_comment = 1; 1377 } 1378 1379 ##print "COMMENT:$in_comment edge<$edge> $rawline\n"; 1380 sanitise_line_reset($in_comment); 1381 1382 } elsif ($realcnt && $rawline =~ /^(?:\+| |$)/) { 1383 # Standardise the strings and chars within the input to 1384 # simplify matching -- only bother with positive lines. 1385 $line = sanitise_line($rawline); 1386 } 1387 push(@lines, $line); 1388 1389 if ($realcnt > 1) { 1390 $realcnt-- if ($line =~ /^(?:\+| |$)/); 1391 } else { 1392 $realcnt = 0; 1393 } 1394 1395 #print "==>$rawline\n"; 1396 #print "-->$line\n"; 1397 } 1398 1399 $prefix = ''; 1400 1401 $realcnt = 0; 1402 $linenr = 0; 1403 foreach my $line (@lines) { 1404 $linenr++; 1405 1406 my $rawline = $rawlines[$linenr - 1]; 1407 1408#extract the line range in the file after the patch is applied 1409 if ($line=~/^\@\@ -\d+(?:,\d+)? \+(\d+)(,(\d+))? \@\@/) { 1410 $is_patch = 1; 1411 $first_line = $linenr + 1; 1412 $realline=$1-1; 1413 if (defined $2) { 1414 $realcnt=$3+1; 1415 } else { 1416 $realcnt=1+1; 1417 } 1418 annotate_reset(); 1419 $prev_values = 'E'; 1420 1421 %suppress_ifbraces = (); 1422 %suppress_whiletrailers = (); 1423 %suppress_export = (); 1424 next; 1425 1426# track the line number as we move through the hunk, note that 1427# new versions of GNU diff omit the leading space on completely 1428# blank context lines so we need to count that too. 1429 } elsif ($line =~ /^( |\+|$)/) { 1430 $realline++; 1431 $realcnt-- if ($realcnt != 0); 1432 1433 # Measure the line length and indent. 1434 ($length, $indent) = line_stats($rawline); 1435 1436 # Track the previous line. 1437 ($prevline, $stashline) = ($stashline, $line); 1438 ($previndent, $stashindent) = ($stashindent, $indent); 1439 ($prevrawline, $stashrawline) = ($stashrawline, $rawline); 1440 1441 #warn "line<$line>\n"; 1442 1443 } elsif ($realcnt == 1) { 1444 $realcnt--; 1445 } 1446 1447 my $hunk_line = ($realcnt != 0); 1448 1449#make up the handle for any error we report on this line 1450 $prefix = "$filename:$realline: " if ($emacs && $file); 1451 $prefix = "$filename:$linenr: " if ($emacs && !$file); 1452 1453 $here = "#$linenr: " if (!$file); 1454 $here = "#$realline: " if ($file); 1455 1456 # extract the filename as it passes 1457 if ($line =~ /^diff --git.*?(\S+)$/) { 1458 $realfile = $1; 1459 $realfile =~ s@^([^/]*)/@@ if (!$file); 1460 checkfilename($realfile, \$acpi_testexpected, \$acpi_nontestexpected); 1461 } elsif ($line =~ /^\+\+\+\s+(\S+)/) { 1462 $realfile = $1; 1463 $realfile =~ s@^([^/]*)/@@ if (!$file); 1464 checkfilename($realfile, \$acpi_testexpected, \$acpi_nontestexpected); 1465 1466 $p1_prefix = $1; 1467 if (!$file && $tree && $p1_prefix ne '' && 1468 -e "$root/$p1_prefix") { 1469 WARN("patch prefix '$p1_prefix' exists, appears to be a -p0 patch\n"); 1470 } 1471 1472 next; 1473 } 1474 1475 $here .= "FILE: $realfile:$realline:" if ($realcnt != 0); 1476 1477 my $hereline = "$here\n$rawline\n"; 1478 my $herecurr = "$here\n$rawline\n"; 1479 my $hereprev = "$here\n$prevrawline\n$rawline\n"; 1480 1481 $cnt_lines++ if ($realcnt != 0); 1482 1483# Check for incorrect file permissions 1484 if ($line =~ /^new (file )?mode.*[7531]\d{0,2}$/) { 1485 my $permhere = $here . "FILE: $realfile\n"; 1486 if ($realfile =~ /(\bMakefile(?:\.objs)?|\.c|\.cc|\.cpp|\.h|\.mak|\.[sS])$/) { 1487 ERROR("do not set execute permissions for source files\n" . $permhere); 1488 } 1489 } 1490 1491# Only allow Python 3 interpreter 1492 if ($realline == 1 && 1493 $line =~ /^\+#!\ *\/usr\/bin\/(?:env )?python$/) { 1494 ERROR("please use python3 interpreter\n" . $herecurr); 1495 } 1496 1497# Accept git diff extended headers as valid patches 1498 if ($line =~ /^(?:rename|copy) (?:from|to) [\w\/\.\-]+\s*$/) { 1499 $is_patch = 1; 1500 } 1501 1502 if ($line =~ /^(Author|From): .* via .*<qemu-devel\@nongnu.org>/) { 1503 ERROR("Author email address is mangled by the mailing list\n" . $herecurr); 1504 } 1505 1506#check the patch for a signoff: 1507 if ($line =~ /^\s*signed-off-by:/i) { 1508 # This is a signoff, if ugly, so do not double report. 1509 $signoff++; 1510 $in_commit_log = 0; 1511 1512 if (!($line =~ /^\s*Signed-off-by:/)) { 1513 ERROR("The correct form is \"Signed-off-by\"\n" . 1514 $herecurr); 1515 } 1516 if ($line =~ /^\s*signed-off-by:\S/i) { 1517 ERROR("space required after Signed-off-by:\n" . 1518 $herecurr); 1519 } 1520 } 1521 1522# Check if MAINTAINERS is being updated. If so, there's probably no need to 1523# emit the "does MAINTAINERS need updating?" message on file add/move/delete 1524 if ($line =~ /^\s*MAINTAINERS\s*\|/) { 1525 $reported_maintainer_file = 1; 1526 } 1527 1528# Check for added, moved or deleted files 1529 if (!$reported_maintainer_file && !$in_commit_log && 1530 ($line =~ /^(?:new|deleted) file mode\s*\d+\s*$/ || 1531 $line =~ /^rename (?:from|to) [\w\/\.\-]+\s*$/ || 1532 ($line =~ /\{\s*([\w\/\.\-]*)\s*\=\>\s*([\w\/\.\-]*)\s*\}/ && 1533 (defined($1) || defined($2)))) && 1534 !(($realfile ne '') && 1535 defined($acpi_testexpected) && 1536 ($realfile eq $acpi_testexpected))) { 1537 $reported_maintainer_file = 1; 1538 WARN("added, moved or deleted file(s), does MAINTAINERS need updating?\n" . $herecurr); 1539 } 1540 1541# Check for wrappage within a valid hunk of the file 1542 if ($realcnt != 0 && $line !~ m{^(?:\+|-| |\\ No newline|$)}) { 1543 ERROR("patch seems to be corrupt (line wrapped?)\n" . 1544 $herecurr) if (!$emitted_corrupt++); 1545 } 1546 1547# UTF-8 regex found at http://www.w3.org/International/questions/qa-forms-utf-8.en.php 1548 if (($realfile =~ /^$/ || $line =~ /^\+/) && 1549 $rawline !~ m/^$UTF8*$/) { 1550 my ($utf8_prefix) = ($rawline =~ /^($UTF8*)/); 1551 1552 my $blank = copy_spacing($rawline); 1553 my $ptr = substr($blank, 0, length($utf8_prefix)) . "^"; 1554 my $hereptr = "$hereline$ptr\n"; 1555 1556 ERROR("Invalid UTF-8, patch and commit message should be encoded in UTF-8\n" . $hereptr); 1557 } 1558 1559 if ($rawline =~ m/$UTF8_MOJIBAKE/) { 1560 ERROR("Doubly-encoded UTF-8\n" . $herecurr); 1561 } 1562# Check if it's the start of a commit log 1563# (not a header line and we haven't seen the patch filename) 1564 if ($in_header_lines && $realfile =~ /^$/ && 1565 !($rawline =~ /^\s+\S/ || 1566 $rawline =~ /^(commit\b|from\b|[\w-]+:).*$/i)) { 1567 $in_header_lines = 0; 1568 $in_commit_log = 1; 1569 } 1570 1571# Check if there is UTF-8 in a commit log when a mail header has explicitly 1572# declined it, i.e defined some charset where it is missing. 1573 if ($in_header_lines && 1574 $rawline =~ /^Content-Type:.+charset="(.+)".*$/ && 1575 $1 !~ /utf-8/i) { 1576 $non_utf8_charset = 1; 1577 } 1578 1579 if ($in_commit_log && $non_utf8_charset && $realfile =~ /^$/ && 1580 $rawline =~ /$NON_ASCII_UTF8/) { 1581 WARN("8-bit UTF-8 used in possible commit log\n" . $herecurr); 1582 } 1583 1584# ignore non-hunk lines and lines being removed 1585 next if (!$hunk_line || $line =~ /^-/); 1586 1587# ignore files that are being periodically imported from Linux 1588 next if ($realfile =~ /^(linux-headers|include\/standard-headers)\//); 1589 1590#trailing whitespace 1591 if ($line =~ /^\+.*\015/) { 1592 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1593 ERROR("DOS line endings\n" . $herevet); 1594 1595 } elsif ($realfile =~ /^docs\/.+\.txt/ || 1596 $realfile =~ /^docs\/.+\.md/) { 1597 if ($rawline =~ /^\+\s+$/ && $rawline !~ /^\+ {4}$/) { 1598 # TODO: properly check we're in a code block 1599 # (surrounding text is 4-column aligned) 1600 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1601 ERROR("code blocks in documentation should have " . 1602 "empty lines with exactly 4 columns of " . 1603 "whitespace\n" . $herevet); 1604 } 1605 } elsif ($rawline =~ /^\+.*\S\s+$/ || $rawline =~ /^\+\s+$/) { 1606 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1607 ERROR("trailing whitespace\n" . $herevet); 1608 $rpt_cleaners = 1; 1609 } 1610 1611# checks for trace-events files 1612 if ($realfile =~ /trace-events$/ && $line =~ /^\+/) { 1613 if ($rawline =~ /%[-+ 0]*#/) { 1614 ERROR("Don't use '#' flag of printf format ('%#') in " . 1615 "trace-events, use '0x' prefix instead\n" . $herecurr); 1616 } else { 1617 my $hex = 1618 qr/%[-+ *.0-9]*([hljztL]|ll|hh)?(x|X|"\s*PRI[xX][^"]*"?)/; 1619 1620 # don't consider groups splitted by [.:/ ], like 2A.20:12ab 1621 my $tmpline = $rawline; 1622 $tmpline =~ s/($hex[.:\/ ])+$hex//g; 1623 1624 if ($tmpline =~ /(?<!0x)$hex/) { 1625 ERROR("Hex numbers must be prefixed with '0x'\n" . 1626 $herecurr); 1627 } 1628 } 1629 } 1630 1631# check we are in a valid source file if not then ignore this hunk 1632 next if ($realfile !~ /$SrcFile/); 1633 1634#90 column limit; exempt URLs, if no other words on line 1635 if ($line =~ /^\+/ && 1636 !($line =~ /^\+\s*"[^"]*"\s*(?:\s*|,|\)\s*;)\s*$/) && 1637 !($rawline =~ /^[^[:alnum:]]*https?:\S*$/) && 1638 $length > 80) 1639 { 1640 if ($length > 90) { 1641 ERROR("line over 90 characters\n" . $herecurr); 1642 } else { 1643 WARN("line over 80 characters\n" . $herecurr); 1644 } 1645 } 1646 1647# check for spaces before a quoted newline 1648 if ($rawline =~ /^.*\".*\s\\n/) { 1649 ERROR("unnecessary whitespace before a quoted newline\n" . $herecurr); 1650 } 1651 1652# check for adding lines without a newline. 1653 if ($line =~ /^\+/ && defined $lines[$linenr] && $lines[$linenr] =~ /^\\ No newline at end of file/) { 1654 ERROR("adding a line without newline at end of file\n" . $herecurr); 1655 } 1656 1657# check for RCS/CVS revision markers 1658 if ($rawline =~ /^\+.*\$(Revision|Log|Id)(?:\$|\b)/) { 1659 ERROR("CVS style keyword markers, these will _not_ be updated\n". $herecurr); 1660 } 1661 1662# tabs are only allowed in assembly source code, and in 1663# some scripts we imported from other projects. 1664 next if ($realfile =~ /\.(s|S)$/); 1665 next if ($realfile =~ /(checkpatch|get_maintainer)\.pl$/); 1666 1667 if ($rawline =~ /^\+.*\t/) { 1668 my $herevet = "$here\n" . cat_vet($rawline) . "\n"; 1669 ERROR("code indent should never use tabs\n" . $herevet); 1670 $rpt_cleaners = 1; 1671 } 1672 1673# check we are in a valid C source file if not then ignore this hunk 1674 next if ($realfile !~ /\.(h|c|cpp)$/); 1675 1676# Block comment styles 1677 1678 # Block comments use /* on a line of its own 1679 if ($rawline !~ m@^\+.*/\*.*\*/[ \t)}]*$@ && #inline /*...*/ 1680 $rawline =~ m@^\+.*/\*\*?+[ \t]*[^ \t]@) { # /* or /** non-blank 1681 WARN("Block comments use a leading /* on a separate line\n" . $herecurr); 1682 } 1683 1684# Block comments use * on subsequent lines 1685 if ($prevline =~ /$;[ \t]*$/ && #ends in comment 1686 $prevrawline =~ /^\+.*?\/\*/ && #starting /* 1687 $prevrawline !~ /\*\/[ \t]*$/ && #no trailing */ 1688 $rawline =~ /^\+/ && #line is new 1689 $rawline !~ /^\+[ \t]*\*/) { #no leading * 1690 WARN("Block comments use * on subsequent lines\n" . $hereprev); 1691 } 1692 1693# Block comments use */ on trailing lines 1694 if ($rawline !~ m@^\+[ \t]*\*/[ \t]*$@ && #trailing */ 1695 $rawline !~ m@^\+.*/\*.*\*/[ \t]*$@ && #inline /*...*/ 1696 $rawline !~ m@^\+.*\*{2,}/[ \t]*$@ && #trailing **/ 1697 $rawline =~ m@^\+[ \t]*.+\*\/[ \t]*$@) { #non blank */ 1698 WARN("Block comments use a trailing */ on a separate line\n" . $herecurr); 1699 } 1700 1701# Block comment * alignment 1702 if ($prevline =~ /$;[ \t]*$/ && #ends in comment 1703 $line =~ /^\+[ \t]*$;/ && #leading comment 1704 $rawline =~ /^\+[ \t]*\*/ && #leading * 1705 (($prevrawline =~ /^\+.*?\/\*/ && #leading /* 1706 $prevrawline !~ /\*\/[ \t]*$/) || #no trailing */ 1707 $prevrawline =~ /^\+[ \t]*\*/)) { #leading * 1708 my $oldindent; 1709 $prevrawline =~ m@^\+([ \t]*/?)\*@; 1710 if (defined($1)) { 1711 $oldindent = expand_tabs($1); 1712 } else { 1713 $prevrawline =~ m@^\+(.*/?)\*@; 1714 $oldindent = expand_tabs($1); 1715 } 1716 $rawline =~ m@^\+([ \t]*)\*@; 1717 my $newindent = $1; 1718 $newindent = expand_tabs($newindent); 1719 if (length($oldindent) ne length($newindent)) { 1720 WARN("Block comments should align the * on each line\n" . $hereprev); 1721 } 1722 } 1723 1724# Check for potential 'bare' types 1725 my ($stat, $cond, $line_nr_next, $remain_next, $off_next, 1726 $realline_next); 1727 if ($realcnt && $line =~ /.\s*\S/) { 1728 ($stat, $cond, $line_nr_next, $remain_next, $off_next) = 1729 ctx_statement_block($linenr, $realcnt, 0); 1730 $stat =~ s/\n./\n /g; 1731 $cond =~ s/\n./\n /g; 1732 1733 # Find the real next line. 1734 $realline_next = $line_nr_next; 1735 if (defined $realline_next && 1736 (!defined $lines[$realline_next - 1] || 1737 substr($lines[$realline_next - 1], $off_next) =~ /^\s*$/)) { 1738 $realline_next++; 1739 } 1740 1741 my $s = $stat; 1742 $s =~ s/{.*$//s; 1743 1744 # Ignore goto labels. 1745 if ($s =~ /$Ident:\*$/s) { 1746 1747 # Ignore functions being called 1748 } elsif ($s =~ /^.\s*$Ident\s*\(/s) { 1749 1750 } elsif ($s =~ /^.\s*else\b/s) { 1751 1752 # declarations always start with types 1753 } 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) { 1754 my $type = $1; 1755 $type =~ s/\s+/ /g; 1756 possible($type, "A:" . $s); 1757 1758 # definitions in global scope can only start with types 1759 } elsif ($s =~ /^.(?:$Storage\s+)?(?:$Inline\s+)?(?:const\s+)?($Ident)\b\s*(?!:)/s) { 1760 possible($1, "B:" . $s); 1761 } 1762 1763 # any (foo ... *) is a pointer cast, and foo is a type 1764 while ($s =~ /\(($Ident)(?:\s+$Sparse)*[\s\*]+\s*\)/sg) { 1765 possible($1, "C:" . $s); 1766 } 1767 1768 # Check for any sort of function declaration. 1769 # int foo(something bar, other baz); 1770 # void (*store_gdt)(x86_descr_ptr *); 1771 if ($prev_values eq 'E' && $s =~ /^(.(?:typedef\s*)?(?:(?:$Storage|$Inline)\s*)*\s*$Type\s*(?:\b$Ident|\(\*\s*$Ident\))\s*)\(/s) { 1772 my ($name_len) = length($1); 1773 1774 my $ctx = $s; 1775 substr($ctx, 0, $name_len + 1, ''); 1776 $ctx =~ s/\)[^\)]*$//; 1777 1778 for my $arg (split(/\s*,\s*/, $ctx)) { 1779 if ($arg =~ /^(?:const\s+)?($Ident)(?:\s+$Sparse)*\s*\**\s*(:?\b$Ident)?$/s || $arg =~ /^($Ident)$/s) { 1780 1781 possible($1, "D:" . $s); 1782 } 1783 } 1784 } 1785 1786 } 1787 1788# 1789# Checks which may be anchored in the context. 1790# 1791 1792# Check for switch () and associated case and default 1793# statements should be at the same indent. 1794 if ($line=~/\bswitch\s*\(.*\)/) { 1795 my $err = ''; 1796 my $sep = ''; 1797 my @ctx = ctx_block_outer($linenr, $realcnt); 1798 shift(@ctx); 1799 for my $ctx (@ctx) { 1800 my ($clen, $cindent) = line_stats($ctx); 1801 if ($ctx =~ /^\+\s*(case\s+|default:)/ && 1802 $indent != $cindent) { 1803 $err .= "$sep$ctx\n"; 1804 $sep = ''; 1805 } else { 1806 $sep = "[...]\n"; 1807 } 1808 } 1809 if ($err ne '') { 1810 ERROR("switch and case should be at the same indent\n$hereline$err"); 1811 } 1812 } 1813 1814# if/while/etc brace do not go on next line, unless defining a do while loop, 1815# or if that brace on the next line is for something else 1816 if ($line =~ /(.*)\b((?:if|while|for|switch)\s*\(|do\b|else\b)/ && $line !~ /^.\s*\#/) { 1817 my $pre_ctx = "$1$2"; 1818 1819 my ($level, @ctx) = ctx_statement_level($linenr, $realcnt, 0); 1820 my $ctx_cnt = $realcnt - $#ctx - 1; 1821 my $ctx = join("\n", @ctx); 1822 1823 my $ctx_ln = $linenr; 1824 my $ctx_skip = $realcnt; 1825 1826 while ($ctx_skip > $ctx_cnt || ($ctx_skip == $ctx_cnt && 1827 defined $lines[$ctx_ln - 1] && 1828 $lines[$ctx_ln - 1] =~ /^-/)) { 1829 ##print "SKIP<$ctx_skip> CNT<$ctx_cnt>\n"; 1830 $ctx_skip-- if (!defined $lines[$ctx_ln - 1] || $lines[$ctx_ln - 1] !~ /^-/); 1831 $ctx_ln++; 1832 } 1833 1834 #print "realcnt<$realcnt> ctx_cnt<$ctx_cnt>\n"; 1835 #print "pre<$pre_ctx>\nline<$line>\nctx<$ctx>\nnext<$lines[$ctx_ln - 1]>\n"; 1836 1837 # The length of the "previous line" is checked against 80 because it 1838 # includes the + at the beginning of the line (if the actual line has 1839 # 79 or 80 characters, it is no longer possible to add a space and an 1840 # opening brace there) 1841 if ($#ctx == 0 && $ctx !~ /{\s*/ && 1842 defined($lines[$ctx_ln - 1]) && $lines[$ctx_ln - 1] =~ /^\+\s*\{/ && 1843 defined($lines[$ctx_ln - 2]) && length($lines[$ctx_ln - 2]) < 80) { 1844 ERROR("that open brace { should be on the previous line\n" . 1845 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 1846 } 1847 if ($level == 0 && $pre_ctx !~ /}\s*while\s*\($/ && 1848 $ctx =~ /\)\s*\;\s*$/ && 1849 defined $lines[$ctx_ln - 1]) 1850 { 1851 my ($nlength, $nindent) = line_stats($lines[$ctx_ln - 1]); 1852 if ($nindent > $indent) { 1853 ERROR("trailing semicolon indicates no statements, indent implies otherwise\n" . 1854 "$here\n$ctx\n$rawlines[$ctx_ln - 1]\n"); 1855 } 1856 } 1857 } 1858 1859# 'do ... while (0/false)' only makes sense in macros, without trailing ';' 1860 if ($line =~ /while\s*\((0|false)\);/) { 1861 ERROR("suspicious ; after while (0)\n" . $herecurr); 1862 } 1863 1864# Check superfluous trailing ';' 1865 if ($line =~ /;;$/) { 1866 ERROR("superfluous trailing semicolon\n" . $herecurr); 1867 } 1868 1869# Check relative indent for conditionals and blocks. 1870 if ($line =~ /\b(?:(?:if|while|for)\s*\(|do\b)/ && $line !~ /^.\s*#/ && $line !~ /\}\s*while\s*/) { 1871 my ($s, $c) = ($stat, $cond); 1872 1873 substr($s, 0, length($c), ''); 1874 1875 # Make sure we remove the line prefixes as we have 1876 # none on the first line, and are going to re-add them 1877 # where necessary. 1878 $s =~ s/\n./\n/gs; 1879 1880 # Find out how long the conditional actually is. 1881 my @newlines = ($c =~ /\n/gs); 1882 my $cond_lines = 1 + $#newlines; 1883 1884 # We want to check the first line inside the block 1885 # starting at the end of the conditional, so remove: 1886 # 1) any blank line termination 1887 # 2) any opening brace { on end of the line 1888 # 3) any do (...) { 1889 my $continuation = 0; 1890 my $check = 0; 1891 $s =~ s/^.*\bdo\b//; 1892 $s =~ s/^\s*\{//; 1893 if ($s =~ s/^\s*\\//) { 1894 $continuation = 1; 1895 } 1896 if ($s =~ s/^\s*?\n//) { 1897 $check = 1; 1898 $cond_lines++; 1899 } 1900 1901 # Also ignore a loop construct at the end of a 1902 # preprocessor statement. 1903 if (($prevline =~ /^.\s*#\s*define\s/ || 1904 $prevline =~ /\\\s*$/) && $continuation == 0) { 1905 $check = 0; 1906 } 1907 1908 my $cond_ptr = -1; 1909 $continuation = 0; 1910 while ($cond_ptr != $cond_lines) { 1911 $cond_ptr = $cond_lines; 1912 1913 # If we see an #else/#elif then the code 1914 # is not linear. 1915 if ($s =~ /^\s*\#\s*(?:else|elif)/) { 1916 $check = 0; 1917 } 1918 1919 # Ignore: 1920 # 1) blank lines, they should be at 0, 1921 # 2) preprocessor lines, and 1922 # 3) labels. 1923 if ($continuation || 1924 $s =~ /^\s*?\n/ || 1925 $s =~ /^\s*#\s*?/ || 1926 $s =~ /^\s*$Ident\s*:/) { 1927 $continuation = ($s =~ /^.*?\\\n/) ? 1 : 0; 1928 if ($s =~ s/^.*?\n//) { 1929 $cond_lines++; 1930 } 1931 } 1932 } 1933 1934 my (undef, $sindent) = line_stats("+" . $s); 1935 my $stat_real = raw_line($linenr, $cond_lines); 1936 1937 # Check if either of these lines are modified, else 1938 # this is not this patch's fault. 1939 if (!defined($stat_real) || 1940 $stat !~ /^\+/ && $stat_real !~ /^\+/) { 1941 $check = 0; 1942 } 1943 if (defined($stat_real) && $cond_lines > 1) { 1944 $stat_real = "[...]\n$stat_real"; 1945 } 1946 1947 #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"; 1948 1949 if ($check && (($sindent % 4) != 0 || 1950 ($sindent <= $indent && $s ne ''))) { 1951 ERROR("suspect code indent for conditional statements ($indent, $sindent)\n" . $herecurr . "$stat_real\n"); 1952 } 1953 } 1954 1955 # Track the 'values' across context and added lines. 1956 my $opline = $line; $opline =~ s/^./ /; 1957 my ($curr_values, $curr_vars) = 1958 annotate_values($opline . "\n", $prev_values); 1959 $curr_values = $prev_values . $curr_values; 1960 if ($dbg_values) { 1961 my $outline = $opline; $outline =~ s/\t/ /g; 1962 print "$linenr > .$outline\n"; 1963 print "$linenr > $curr_values\n"; 1964 print "$linenr > $curr_vars\n"; 1965 } 1966 $prev_values = substr($curr_values, -1); 1967 1968#ignore lines not being added 1969 if ($line=~/^[^\+]/) {next;} 1970 1971# TEST: allow direct testing of the type matcher. 1972 if ($dbg_type) { 1973 if ($line =~ /^.\s*$Declare\s*$/) { 1974 ERROR("TEST: is type\n" . $herecurr); 1975 } elsif ($dbg_type > 1 && $line =~ /^.+($Declare)/) { 1976 ERROR("TEST: is not type ($1 is)\n". $herecurr); 1977 } 1978 next; 1979 } 1980# TEST: allow direct testing of the attribute matcher. 1981 if ($dbg_attr) { 1982 if ($line =~ /^.\s*$Modifier\s*$/) { 1983 ERROR("TEST: is attr\n" . $herecurr); 1984 } elsif ($dbg_attr > 1 && $line =~ /^.+($Modifier)/) { 1985 ERROR("TEST: is not attr ($1 is)\n". $herecurr); 1986 } 1987 next; 1988 } 1989 1990# check for initialisation to aggregates open brace on the next line 1991 if ($line =~ /^.\s*\{/ && 1992 $prevline =~ /(?:^|[^=])=\s*$/) { 1993 ERROR("that open brace { should be on the previous line\n" . $hereprev); 1994 } 1995 1996# 1997# Checks which are anchored on the added line. 1998# 1999 2000# check for malformed paths in #include statements (uses RAW line) 2001 if ($rawline =~ m{^.\s*\#\s*include\s+[<"](.*)[">]}) { 2002 my $path = $1; 2003 if ($path =~ m{//}) { 2004 ERROR("malformed #include filename\n" . 2005 $herecurr); 2006 } 2007 } 2008 2009# no C99 // comments 2010 if ($line =~ m{//} && 2011 $rawline !~ m{// SPDX-License-Identifier: }) { 2012 ERROR("do not use C99 // comments\n" . $herecurr); 2013 } 2014 # Remove C99 comments. 2015 $line =~ s@//.*@@; 2016 $opline =~ s@//.*@@; 2017 2018# check for global initialisers. 2019 if ($line =~ /^.$Type\s*$Ident\s*(?:\s+$Modifier)*\s*=\s*(0|NULL|false)\s*;/) { 2020 ERROR("do not initialise globals to 0 or NULL\n" . 2021 $herecurr); 2022 } 2023# check for static initialisers. 2024 if ($line =~ /\bstatic\s.*=\s*(0|NULL|false)\s*;/) { 2025 ERROR("do not initialise statics to 0 or NULL\n" . 2026 $herecurr); 2027 } 2028 2029# * goes on variable not on type 2030 # (char*[ const]) 2031 if ($line =~ m{\($NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)\)}) { 2032 my ($from, $to) = ($1, $1); 2033 2034 # Should start with a space. 2035 $to =~ s/^(\S)/ $1/; 2036 # Should not end with a space. 2037 $to =~ s/\s+$//; 2038 # '*'s should not have spaces between. 2039 while ($to =~ s/\*\s+\*/\*\*/) { 2040 } 2041 2042 #print "from<$from> to<$to>\n"; 2043 if ($from ne $to) { 2044 ERROR("\"(foo$from)\" should be \"(foo$to)\"\n" . $herecurr); 2045 } 2046 } elsif ($line =~ m{\b$NonptrType(\s*(?:$Modifier\b\s*|\*\s*)+)($Ident)}) { 2047 my ($from, $to, $ident) = ($1, $1, $2); 2048 2049 # Should start with a space. 2050 $to =~ s/^(\S)/ $1/; 2051 # Should not end with a space. 2052 $to =~ s/\s+$//; 2053 # '*'s should not have spaces between. 2054 while ($to =~ s/\*\s+\*/\*\*/) { 2055 } 2056 # Modifiers should have spaces. 2057 $to =~ s/(\b$Modifier$)/$1 /; 2058 2059 #print "from<$from> to<$to> ident<$ident>\n"; 2060 if ($from ne $to && $ident !~ /^$Modifier$/) { 2061 ERROR("\"foo${from}bar\" should be \"foo${to}bar\"\n" . $herecurr); 2062 } 2063 } 2064 2065# function brace can't be on same line, except for #defines of do while, 2066# or if closed on same line 2067 if (($line=~/$Type\s*$Ident\(.*\).*\s\{/) and 2068 !($line=~/\#\s*define.*do\s\{/) and !($line=~/}/)) { 2069 ERROR("open brace '{' following function declarations go on the next line\n" . $herecurr); 2070 } 2071 2072# open braces for enum, union and struct go on the same line. 2073 if ($line =~ /^.\s*\{/ && 2074 $prevline =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?\s*$/) { 2075 ERROR("open brace '{' following $1 go on the same line\n" . $hereprev); 2076 } 2077 2078# missing space after union, struct or enum definition 2079 if ($line =~ /^.\s*(?:typedef\s+)?(enum|union|struct)(?:\s+$Ident)?(?:\s+$Ident)?[=\{]/) { 2080 ERROR("missing space after $1 definition\n" . $herecurr); 2081 } 2082 2083# check for spacing round square brackets; allowed: 2084# 1. with a type on the left -- int [] a; 2085# 2. at the beginning of a line for slice initialisers -- [0...10] = 5, 2086# 3. inside a curly brace -- = { [0...10] = 5 } 2087# 4. after a comma -- [1] = 5, [2] = 6 2088# 5. in a macro definition -- #define abc(x) [x] = y 2089 while ($line =~ /(.*?\s)\[/g) { 2090 my ($where, $prefix) = ($-[1], $1); 2091 if ($prefix !~ /$Type\s+$/ && 2092 ($where != 0 || $prefix !~ /^.\s+$/) && 2093 $prefix !~ /\#\s*define[^(]*\([^)]*\)\s+$/ && 2094 $prefix !~ /[,{:]\s+$/) { 2095 ERROR("space prohibited before open square bracket '['\n" . $herecurr); 2096 } 2097 } 2098 2099# check for spaces between functions and their parentheses. 2100 while ($line =~ /($Ident)\s+\(/g) { 2101 my $name = $1; 2102 my $ctx_before = substr($line, 0, $-[1]); 2103 my $ctx = "$ctx_before$name"; 2104 2105 # Ignore those directives where spaces _are_ permitted. 2106 if ($name =~ /^(?: 2107 if|for|while|switch|return|case| 2108 volatile|__volatile__|coroutine_fn| 2109 __attribute__|format|__extension__| 2110 asm|__asm__)$/x) 2111 { 2112 2113 # Ignore 'catch (...)' in C++ 2114 } elsif ($name =~ /^catch$/ && $realfile =~ /(\.cpp|\.h)$/) { 2115 2116 # cpp #define statements have non-optional spaces, ie 2117 # if there is a space between the name and the open 2118 # parenthesis it is simply not a parameter group. 2119 } elsif ($ctx_before =~ /^.\s*\#\s*define\s*$/) { 2120 2121 # cpp #elif statement condition may start with a ( 2122 } elsif ($ctx =~ /^.\s*\#\s*elif\s*$/) { 2123 2124 # If this whole things ends with a type its most 2125 # likely a typedef for a function. 2126 } elsif ($ctx =~ /$Type$/) { 2127 2128 } else { 2129 ERROR("space prohibited between function name and open parenthesis '('\n" . $herecurr); 2130 } 2131 } 2132# Check operator spacing. 2133 if (!($line=~/\#\s*include/)) { 2134 my $ops = qr{ 2135 <<=|>>=|<=|>=|==|!=| 2136 \+=|-=|\*=|\/=|%=|\^=|\|=|&=| 2137 =>|->|<<|>>|<|>|=|!|~| 2138 &&|\|\||,|\^|\+\+|--|&|\||\+|-|\*|\/|%| 2139 \?|::|: 2140 }x; 2141 my @elements = split(/($ops|;)/, $opline); 2142 my $off = 0; 2143 2144 my $blank = copy_spacing($opline); 2145 2146 for (my $n = 0; $n < $#elements; $n += 2) { 2147 $off += length($elements[$n]); 2148 2149 # Pick up the preceding and succeeding characters. 2150 my $ca = substr($opline, 0, $off); 2151 my $cc = ''; 2152 if (length($opline) >= ($off + length($elements[$n + 1]))) { 2153 $cc = substr($opline, $off + length($elements[$n + 1])); 2154 } 2155 my $cb = "$ca$;$cc"; 2156 2157 my $a = ''; 2158 $a = 'V' if ($elements[$n] ne ''); 2159 $a = 'W' if ($elements[$n] =~ /\s$/); 2160 $a = 'C' if ($elements[$n] =~ /$;$/); 2161 $a = 'B' if ($elements[$n] =~ /(\[|\()$/); 2162 $a = 'O' if ($elements[$n] eq ''); 2163 $a = 'E' if ($ca =~ /^\s*$/); 2164 2165 my $op = $elements[$n + 1]; 2166 2167 my $c = ''; 2168 if (defined $elements[$n + 2]) { 2169 $c = 'V' if ($elements[$n + 2] ne ''); 2170 $c = 'W' if ($elements[$n + 2] =~ /^\s/); 2171 $c = 'C' if ($elements[$n + 2] =~ /^$;/); 2172 $c = 'B' if ($elements[$n + 2] =~ /^(\)|\]|;)/); 2173 $c = 'O' if ($elements[$n + 2] eq ''); 2174 $c = 'E' if ($elements[$n + 2] =~ /^\s*\\$/); 2175 } else { 2176 $c = 'E'; 2177 } 2178 2179 my $ctx = "${a}x${c}"; 2180 2181 my $at = "(ctx:$ctx)"; 2182 2183 my $ptr = substr($blank, 0, $off) . "^"; 2184 my $hereptr = "$hereline$ptr\n"; 2185 2186 # Pull out the value of this operator. 2187 my $op_type = substr($curr_values, $off + 1, 1); 2188 2189 # Get the full operator variant. 2190 my $opv = $op . substr($curr_vars, $off, 1); 2191 2192 # Ignore operators passed as parameters. 2193 if ($op_type ne 'V' && 2194 $ca =~ /\s$/ && $cc =~ /^\s*,/) { 2195 2196# # Ignore comments 2197# } elsif ($op =~ /^$;+$/) { 2198 2199 # ; should have either the end of line or a space or \ after it 2200 } elsif ($op eq ';') { 2201 if ($ctx !~ /.x[WEBC]/ && 2202 $cc !~ /^\\/ && $cc !~ /^;/) { 2203 ERROR("space required after that '$op' $at\n" . $hereptr); 2204 } 2205 2206 # // is a comment 2207 } elsif ($op eq '//') { 2208 2209 # Ignore : used in class declaration in C++ 2210 } elsif ($opv eq ':B' && $ctx =~ /Wx[WE]/ && 2211 $line =~ /class/ && $realfile =~ /(\.cpp|\.h)$/) { 2212 2213 # No spaces for: 2214 # -> 2215 # : when part of a bitfield 2216 } elsif ($op eq '->' || $opv eq ':B') { 2217 if ($ctx =~ /Wx.|.xW/) { 2218 ERROR("spaces prohibited around that '$op' $at\n" . $hereptr); 2219 } 2220 2221 # , must have a space on the right. 2222 # not required when having a single },{ on one line 2223 } elsif ($op eq ',') { 2224 if ($ctx !~ /.x[WEC]/ && $cc !~ /^}/ && 2225 ($elements[$n] . $elements[$n + 2]) !~ " *}\\{") { 2226 ERROR("space required after that '$op' $at\n" . $hereptr); 2227 } 2228 2229 # '*' as part of a type definition -- reported already. 2230 } elsif ($opv eq '*_') { 2231 #warn "'*' is part of type\n"; 2232 2233 # unary operators should have a space before and 2234 # none after. May be left adjacent to another 2235 # unary operator, or a cast 2236 } elsif ($op eq '!' || $op eq '~' || 2237 $opv eq '*U' || $opv eq '-U' || 2238 $opv eq '&U' || $opv eq '&&U') { 2239 if ($op eq '~' && $ca =~ /::$/ && $realfile =~ /(\.cpp|\.h)$/) { 2240 # '~' used as a name of Destructor 2241 2242 } elsif ($ctx !~ /[WEBC]x./ && $ca !~ /(?:\)|!|~|\*|-|\&|\||\+\+|\-\-|\{)$/) { 2243 ERROR("space required before that '$op' $at\n" . $hereptr); 2244 } 2245 if ($op eq '*' && $cc =~/\s*$Modifier\b/) { 2246 # A unary '*' may be const 2247 2248 } elsif ($ctx =~ /.xW/) { 2249 ERROR("space prohibited after that '$op' $at\n" . $hereptr); 2250 } 2251 2252 # unary ++ and unary -- are allowed no space on one side. 2253 } elsif ($op eq '++' or $op eq '--') { 2254 if ($ctx !~ /[WEOBC]x[^W]/ && $ctx !~ /[^W]x[WOBEC]/) { 2255 ERROR("space required one side of that '$op' $at\n" . $hereptr); 2256 } 2257 if ($ctx =~ /Wx[BE]/ || 2258 ($ctx =~ /Wx./ && $cc =~ /^;/)) { 2259 ERROR("space prohibited before that '$op' $at\n" . $hereptr); 2260 } 2261 if ($ctx =~ /ExW/) { 2262 ERROR("space prohibited after that '$op' $at\n" . $hereptr); 2263 } 2264 2265 # A colon needs no spaces before when it is 2266 # terminating a case value or a label. 2267 } elsif ($opv eq ':C' || $opv eq ':L') { 2268 if ($ctx =~ /Wx./) { 2269 ERROR("space prohibited before that '$op' $at\n" . $hereptr); 2270 } 2271 2272 # All the others need spaces both sides. 2273 } elsif ($ctx !~ /[EWC]x[CWE]/) { 2274 my $ok = 0; 2275 2276 if ($realfile =~ /\.cpp|\.h$/) { 2277 # Ignore template arguments <...> in C++ 2278 if (($op eq '<' || $op eq '>') && $line =~ /<.*>/) { 2279 $ok = 1; 2280 } 2281 2282 # Ignore :: in C++ 2283 if ($op eq '::') { 2284 $ok = 1; 2285 } 2286 } 2287 2288 # Ignore email addresses <foo@bar> 2289 if (($op eq '<' && 2290 $cc =~ /^\S+\@\S+>/) || 2291 ($op eq '>' && 2292 $ca =~ /<\S+\@\S+$/)) 2293 { 2294 $ok = 1; 2295 } 2296 2297 # Ignore ?: 2298 if (($opv eq ':O' && $ca =~ /\?$/) || 2299 ($op eq '?' && $cc =~ /^:/)) { 2300 $ok = 1; 2301 } 2302 2303 if ($ok == 0) { 2304 ERROR("spaces required around that '$op' $at\n" . $hereptr); 2305 } 2306 } 2307 $off += length($elements[$n + 1]); 2308 } 2309 } 2310 2311#need space before brace following if, while, etc 2312 if (($line =~ /\(.*\)\{/ && $line !~ /\($Type\)\{/) || 2313 $line =~ /do\{/) { 2314 ERROR("space required before the open brace '{'\n" . $herecurr); 2315 } 2316 2317# closing brace should have a space following it when it has anything 2318# on the line 2319 if ($line =~ /}(?!(?:,|;|\)))\S/) { 2320 ERROR("space required after that close brace '}'\n" . $herecurr); 2321 } 2322 2323# check spacing on square brackets 2324 if ($line =~ /\[\s/ && $line !~ /\[\s*$/) { 2325 ERROR("space prohibited after that open square bracket '['\n" . $herecurr); 2326 } 2327 if ($line =~ /\s\]/) { 2328 ERROR("space prohibited before that close square bracket ']'\n" . $herecurr); 2329 } 2330 2331# check spacing on parentheses 2332 if ($line =~ /\(\s/ && $line !~ /\(\s*(?:\\)?$/ && 2333 $line !~ /for\s*\(\s+;/) { 2334 ERROR("space prohibited after that open parenthesis '('\n" . $herecurr); 2335 } 2336 if ($line =~ /(\s+)\)/ && $line !~ /^.\s*\)/ && 2337 $line !~ /for\s*\(.*;\s+\)/ && 2338 $line !~ /:\s+\)/) { 2339 ERROR("space prohibited before that close parenthesis ')'\n" . $herecurr); 2340 } 2341 2342# Return is not a function. 2343 if (defined($stat) && $stat =~ /^.\s*return(\s*)(\(.*);/s) { 2344 my $spacing = $1; 2345 my $value = $2; 2346 2347 # Flatten any parentheses 2348 $value =~ s/\(/ \(/g; 2349 $value =~ s/\)/\) /g; 2350 while ($value =~ s/\[[^\{\}]*\]/1/ || 2351 $value !~ /(?:$Ident|-?$Constant)\s* 2352 $Compare\s* 2353 (?:$Ident|-?$Constant)/x && 2354 $value =~ s/\([^\(\)]*\)/1/) { 2355 } 2356#print "value<$value>\n"; 2357 if ($value =~ /^\s*(?:$Ident|-?$Constant)\s*$/ && 2358 $line =~ /;$/) { 2359 ERROR("return is not a function, parentheses are not required\n" . $herecurr); 2360 2361 } elsif ($spacing !~ /\s+/) { 2362 ERROR("space required before the open parenthesis '('\n" . $herecurr); 2363 } 2364 } 2365# Return of what appears to be an errno should normally be -'ve 2366 if ($line =~ /^.\s*return\s*(E[A-Z]*)\s*;/) { 2367 my $name = $1; 2368 if ($name ne 'EOF' && $name ne 'ERROR') { 2369 ERROR("return of an errno should typically be -ve (return -$1)\n" . $herecurr); 2370 } 2371 } 2372 2373 if ($line =~ /^.\s*(Q(?:S?LIST|SIMPLEQ|TAILQ)_HEAD)\s*\(\s*[^,]/ && 2374 $line !~ /^.typedef/) { 2375 ERROR("named $1 should be typedefed separately\n" . $herecurr); 2376 } 2377 2378# Need a space before open parenthesis after if, while etc 2379 if ($line=~/\b(if|while|for|switch)\(/) { 2380 ERROR("space required before the open parenthesis '('\n" . $herecurr); 2381 } 2382 2383# Check for illegal assignment in if conditional -- and check for trailing 2384# statements after the conditional. 2385 if ($line =~ /do\s*(?!{)/) { 2386 my ($stat_next) = ctx_statement_block($line_nr_next, 2387 $remain_next, $off_next); 2388 $stat_next =~ s/\n./\n /g; 2389 ##print "stat<$stat> stat_next<$stat_next>\n"; 2390 2391 if ($stat_next =~ /^\s*while\b/) { 2392 # If the statement carries leading newlines, 2393 # then count those as offsets. 2394 my ($whitespace) = 2395 ($stat_next =~ /^((?:\s*\n[+-])*\s*)/s); 2396 my $offset = 2397 statement_rawlines($whitespace) - 1; 2398 2399 $suppress_whiletrailers{$line_nr_next + 2400 $offset} = 1; 2401 } 2402 } 2403 if (!defined $suppress_whiletrailers{$linenr} && 2404 $line =~ /\b(?:if|while|for)\s*\(/ && $line !~ /^.\s*#/) { 2405 my ($s, $c) = ($stat, $cond); 2406 2407 if ($c =~ /\bif\s*\(.*[^<>!=]=[^=].*/s) { 2408 ERROR("do not use assignment in if condition\n" . $herecurr); 2409 } 2410 2411 # Find out what is on the end of the line after the 2412 # conditional. 2413 substr($s, 0, length($c), ''); 2414 $s =~ s/\n.*//g; 2415 $s =~ s/$;//g; # Remove any comments 2416 if (length($c) && $s !~ /^\s*{?\s*\\*\s*$/ && 2417 $c !~ /}\s*while\s*/) 2418 { 2419 # Find out how long the conditional actually is. 2420 my @newlines = ($c =~ /\n/gs); 2421 my $cond_lines = 1 + $#newlines; 2422 my $stat_real = ''; 2423 2424 $stat_real = raw_line($linenr, $cond_lines) 2425 . "\n" if ($cond_lines); 2426 if (defined($stat_real) && $cond_lines > 1) { 2427 $stat_real = "[...]\n$stat_real"; 2428 } 2429 2430 ERROR("trailing statements should be on next line\n" . $herecurr . $stat_real); 2431 } 2432 } 2433 2434# Check for bitwise tests written as boolean 2435 if ($line =~ / 2436 (?: 2437 (?:\[|\(|\&\&|\|\|) 2438 \s*0[xX][0-9]+\s* 2439 (?:\&\&|\|\|) 2440 | 2441 (?:\&\&|\|\|) 2442 \s*0[xX][0-9]+\s* 2443 (?:\&\&|\|\||\)|\]) 2444 )/x) 2445 { 2446 ERROR("boolean test with hexadecimal, perhaps just 1 \& or \|?\n" . $herecurr); 2447 } 2448 2449# if and else should not have general statements after it 2450 if ($line =~ /^.\s*(?:}\s*)?else\b(.*)/) { 2451 my $s = $1; 2452 $s =~ s/$;//g; # Remove any comments 2453 if ($s !~ /^\s*(?:\sif|(?:{|)\s*\\?\s*$)/) { 2454 ERROR("trailing statements should be on next line\n" . $herecurr); 2455 } 2456 } 2457# if should not continue a brace 2458 if ($line =~ /}\s*if\b/) { 2459 ERROR("trailing statements should be on next line\n" . 2460 $herecurr); 2461 } 2462# case and default should not have general statements after them 2463 if ($line =~ /^.\s*(?:case\s*.*|default\s*):/g && 2464 $line !~ /\G(?: 2465 (?:\s*$;*)(?:\s*{)?(?:\s*$;*)(?:\s*\\)?\s*$| 2466 \s*return\s+ 2467 )/xg) 2468 { 2469 ERROR("trailing statements should be on next line\n" . $herecurr); 2470 } 2471 2472 # Check for }<nl>else {, these must be at the same 2473 # indent level to be relevant to each other. 2474 if ($prevline=~/}\s*$/ and $line=~/^.\s*else\s*/ and 2475 $previndent == $indent) { 2476 ERROR("else should follow close brace '}'\n" . $hereprev); 2477 } 2478 2479 if ($prevline=~/}\s*$/ and $line=~/^.\s*while\s*/ and 2480 $previndent == $indent) { 2481 my ($s, $c) = ctx_statement_block($linenr, $realcnt, 0); 2482 2483 # Find out what is on the end of the line after the 2484 # conditional. 2485 substr($s, 0, length($c), ''); 2486 $s =~ s/\n.*//g; 2487 2488 if ($s =~ /^\s*;/) { 2489 ERROR("while should follow close brace '}'\n" . $hereprev); 2490 } 2491 } 2492 2493#studly caps, commented out until figure out how to distinguish between use of existing and adding new 2494# if (($line=~/[\w_][a-z\d]+[A-Z]/) and !($line=~/print/)) { 2495# print "No studly caps, use _\n"; 2496# print "$herecurr"; 2497# $clean = 0; 2498# } 2499 2500#no spaces allowed after \ in define 2501 if ($line=~/\#\s*define.*\\\s$/) { 2502 ERROR("Whitespace after \\ makes next lines useless\n" . $herecurr); 2503 } 2504 2505# multi-statement macros should be enclosed in a do while loop, grab the 2506# first statement and ensure its the whole macro if its not enclosed 2507# in a known good container 2508 if ($realfile !~ m@/vmlinux.lds.h$@ && 2509 $line =~ /^.\s*\#\s*define\s*$Ident(\()?/) { 2510 my $ln = $linenr; 2511 my $cnt = $realcnt; 2512 my ($off, $dstat, $dcond, $rest); 2513 my $ctx = ''; 2514 2515 my $args = defined($1); 2516 2517 # Find the end of the macro and limit our statement 2518 # search to that. 2519 while ($cnt > 0 && defined $lines[$ln - 1] && 2520 $lines[$ln - 1] =~ /^(?:-|..*\\$)/) 2521 { 2522 $ctx .= $rawlines[$ln - 1] . "\n"; 2523 $cnt-- if ($lines[$ln - 1] !~ /^-/); 2524 $ln++; 2525 } 2526 $ctx .= $rawlines[$ln - 1]; 2527 2528 ($dstat, $dcond, $ln, $cnt, $off) = 2529 ctx_statement_block($linenr, $ln - $linenr + 1, 0); 2530 #print "dstat<$dstat> dcond<$dcond> cnt<$cnt> off<$off>\n"; 2531 #print "LINE<$lines[$ln-1]> len<" . length($lines[$ln-1]) . "\n"; 2532 2533 # Extract the remainder of the define (if any) and 2534 # rip off surrounding spaces, and trailing \'s. 2535 $rest = ''; 2536 while ($off != 0 || ($cnt > 0 && $rest =~ /\\\s*$/)) { 2537 #print "ADDING cnt<$cnt> $off <" . substr($lines[$ln - 1], $off) . "> rest<$rest>\n"; 2538 if ($off != 0 || $lines[$ln - 1] !~ /^-/) { 2539 $rest .= substr($lines[$ln - 1], $off) . "\n"; 2540 $cnt--; 2541 } 2542 $ln++; 2543 $off = 0; 2544 } 2545 $rest =~ s/\\\n.//g; 2546 $rest =~ s/^\s*//s; 2547 $rest =~ s/\s*$//s; 2548 2549 # Clean up the original statement. 2550 if ($args) { 2551 substr($dstat, 0, length($dcond), ''); 2552 } else { 2553 $dstat =~ s/^.\s*\#\s*define\s+$Ident\s*//; 2554 } 2555 $dstat =~ s/$;//g; 2556 $dstat =~ s/\\\n.//g; 2557 $dstat =~ s/^\s*//s; 2558 $dstat =~ s/\s*$//s; 2559 2560 # Flatten any parentheses and braces 2561 while ($dstat =~ s/\([^\(\)]*\)/1/ || 2562 $dstat =~ s/\{[^\{\}]*\}/1/ || 2563 $dstat =~ s/\[[^\{\}]*\]/1/) 2564 { 2565 } 2566 2567 my $exceptions = qr{ 2568 $Declare| 2569 module_param_named| 2570 MODULE_PARAM_DESC| 2571 DECLARE_PER_CPU| 2572 DEFINE_PER_CPU| 2573 __typeof__\(| 2574 union| 2575 struct| 2576 \.$Ident\s*=\s*| 2577 ^\"|\"$ 2578 }x; 2579 #print "REST<$rest> dstat<$dstat> ctx<$ctx>\n"; 2580 if ($rest ne '' && $rest ne ',') { 2581 if ($rest !~ /while\s*\(/ && 2582 $dstat !~ /$exceptions/) 2583 { 2584 ERROR("Macros with multiple statements should be enclosed in a do - while loop\n" . "$here\n$ctx\n"); 2585 } 2586 2587 } elsif ($ctx !~ /;/) { 2588 if ($dstat ne '' && 2589 $dstat !~ /^(?:$Ident|-?$Constant)$/ && 2590 $dstat !~ /$exceptions/ && 2591 $dstat !~ /^\.$Ident\s*=/ && 2592 $dstat =~ /$Operators/) 2593 { 2594 ERROR("Macros with complex values should be enclosed in parenthesis\n" . "$here\n$ctx\n"); 2595 } 2596 } 2597 } 2598 2599# check for missing bracing around if etc 2600 if ($line =~ /(^.*)\b(?:if|while|for)\b/ && 2601 $line !~ /\#\s*if/) { 2602 my $allowed = 0; 2603 2604 # Check the pre-context. 2605 if ($line =~ /(\}.*?)$/) { 2606 my $pre = $1; 2607 2608 if ($line !~ /else/) { 2609 print "APW: ALLOWED: pre<$pre> line<$line>\n" 2610 if $dbg_adv_apw; 2611 $allowed = 1; 2612 } 2613 } 2614 my ($level, $endln, @chunks) = 2615 ctx_statement_full($linenr, $realcnt, 1); 2616 if ($dbg_adv_apw) { 2617 print "APW: chunks<$#chunks> linenr<$linenr> endln<$endln> level<$level>\n"; 2618 print "APW: <<$chunks[1][0]>><<$chunks[1][1]>>\n" 2619 if $#chunks >= 1; 2620 } 2621 if ($#chunks >= 0 && $level == 0) { 2622 my $seen = 0; 2623 my $herectx = $here . "\n"; 2624 my $ln = $linenr - 1; 2625 for my $chunk (@chunks) { 2626 my ($cond, $block) = @{$chunk}; 2627 2628 # If the condition carries leading newlines, then count those as offsets. 2629 my ($whitespace) = ($cond =~ /^((?:\s*\n[+-])*\s*)/s); 2630 my $offset = statement_rawlines($whitespace) - 1; 2631 2632 #print "COND<$cond> whitespace<$whitespace> offset<$offset>\n"; 2633 2634 # We have looked at and allowed this specific line. 2635 $suppress_ifbraces{$ln + $offset} = 1; 2636 2637 $herectx .= "$rawlines[$ln + $offset]\n[...]\n"; 2638 $ln += statement_rawlines($block) - 1; 2639 2640 substr($block, 0, length($cond), ''); 2641 2642 my $spaced_block = $block; 2643 $spaced_block =~ s/\n\+/ /g; 2644 2645 $seen++ if ($spaced_block =~ /^\s*\{/); 2646 2647 print "APW: cond<$cond> block<$block> allowed<$allowed>\n" 2648 if $dbg_adv_apw; 2649 if (statement_lines($cond) > 1) { 2650 print "APW: ALLOWED: cond<$cond>\n" 2651 if $dbg_adv_apw; 2652 $allowed = 1; 2653 } 2654 if ($block =~/\b(?:if|for|while)\b/) { 2655 print "APW: ALLOWED: block<$block>\n" 2656 if $dbg_adv_apw; 2657 $allowed = 1; 2658 } 2659 if (statement_block_size($block) > 1) { 2660 print "APW: ALLOWED: lines block<$block>\n" 2661 if $dbg_adv_apw; 2662 $allowed = 1; 2663 } 2664 } 2665 if ($seen != ($#chunks + 1) && !$allowed) { 2666 ERROR("braces {} are necessary for all arms of this statement\n" . $herectx); 2667 } 2668 } 2669 } 2670 if (!defined $suppress_ifbraces{$linenr - 1} && 2671 $line =~ /\b(if|while|for|else)\b/ && 2672 $line !~ /\#\s*if/ && 2673 $line !~ /\#\s*else/) { 2674 my $allowed = 0; 2675 2676 # Check the pre-context. 2677 if (substr($line, 0, $-[0]) =~ /(\}\s*)$/) { 2678 my $pre = $1; 2679 2680 if ($line !~ /else/) { 2681 print "APW: ALLOWED: pre<$pre> line<$line>\n" 2682 if $dbg_adv_apw; 2683 $allowed = 1; 2684 } 2685 } 2686 2687 my ($level, $endln, @chunks) = 2688 ctx_statement_full($linenr, $realcnt, $-[0]); 2689 2690 # Check the condition. 2691 my ($cond, $block) = @{$chunks[0]}; 2692 print "CHECKING<$linenr> cond<$cond> block<$block>\n" 2693 if $dbg_adv_checking; 2694 if (defined $cond) { 2695 substr($block, 0, length($cond), ''); 2696 } 2697 if (statement_lines($cond) > 1) { 2698 print "APW: ALLOWED: cond<$cond>\n" 2699 if $dbg_adv_apw; 2700 $allowed = 1; 2701 } 2702 if ($block =~/\b(?:if|for|while)\b/) { 2703 print "APW: ALLOWED: block<$block>\n" 2704 if $dbg_adv_apw; 2705 $allowed = 1; 2706 } 2707 if (statement_block_size($block) > 1) { 2708 print "APW: ALLOWED: lines block<$block>\n" 2709 if $dbg_adv_apw; 2710 $allowed = 1; 2711 } 2712 # Check the post-context. 2713 if (defined $chunks[1]) { 2714 my ($cond, $block) = @{$chunks[1]}; 2715 if (defined $cond) { 2716 substr($block, 0, length($cond), ''); 2717 } 2718 if ($block =~ /^\s*\{/) { 2719 print "APW: ALLOWED: chunk-1 block<$block>\n" 2720 if $dbg_adv_apw; 2721 $allowed = 1; 2722 } 2723 } 2724 print "DCS: level=$level block<$block> allowed=$allowed\n" 2725 if $dbg_adv_dcs; 2726 if ($level == 0 && $block !~ /^\s*\{/ && !$allowed) { 2727 my $herectx = $here . "\n";; 2728 my $cnt = statement_rawlines($block); 2729 2730 for (my $n = 0; $n < $cnt; $n++) { 2731 $herectx .= raw_line($linenr, $n) . "\n";; 2732 } 2733 2734 ERROR("braces {} are necessary even for single statement blocks\n" . $herectx); 2735 } 2736 } 2737 2738# no volatiles please 2739 my $asm_volatile = qr{\b(__asm__|asm)\s+(__volatile__|volatile)\b}; 2740 if ($line =~ /\bvolatile\b/ && $line !~ /$asm_volatile/ && 2741 $line !~ /sig_atomic_t/ && 2742 !ctx_has_comment($first_line, $linenr)) { 2743 my $msg = "Use of volatile is usually wrong, please add a comment\n" . $herecurr; 2744 ERROR($msg); 2745 } 2746 2747# warn about #if 0 2748 if ($line =~ /^.\s*\#\s*if\s+0\b/) { 2749 ERROR("if this code is redundant consider removing it\n" . 2750 $herecurr); 2751 } 2752 2753# check for needless g_free() checks 2754 if ($prevline =~ /\bif\s*\(([^\)]*)\)/) { 2755 my $expr = $1; 2756 if ($line =~ /\bg_free\(\Q$expr\E\);/) { 2757 ERROR("g_free(NULL) is safe this check is probably not required\n" . $hereprev); 2758 } 2759 } 2760 2761# warn about #ifdefs in C files 2762# if ($line =~ /^.\s*\#\s*if(|n)def/ && ($realfile =~ /\.c$/)) { 2763# print "#ifdef in C files should be avoided\n"; 2764# print "$herecurr"; 2765# $clean = 0; 2766# } 2767 2768# warn about spacing in #ifdefs 2769 if ($line =~ /^.\s*\#\s*(ifdef|ifndef|elif)\s\s+/) { 2770 ERROR("exactly one space required after that #$1\n" . $herecurr); 2771 } 2772# check for memory barriers without a comment. 2773 if ($line =~ /\b(smp_mb|smp_rmb|smp_wmb|smp_read_barrier_depends)\(/) { 2774 if (!ctx_has_comment($first_line, $linenr)) { 2775 ERROR("memory barrier without comment\n" . $herecurr); 2776 } 2777 } 2778# check of hardware specific defines 2779# we have e.g. CONFIG_LINUX and CONFIG_WIN32 for common cases 2780# where they might be necessary. 2781 if ($line =~ m@^.\s*\#\s*if.*\b__@) { 2782 WARN("architecture specific defines should be avoided\n" . $herecurr); 2783 } 2784 2785# Check that the storage class is at the beginning of a declaration 2786 if ($line =~ /\b$Storage\b/ && $line !~ /^.\s*$Storage\b/) { 2787 ERROR("storage class should be at the beginning of the declaration\n" . $herecurr) 2788 } 2789 2790# check the location of the inline attribute, that it is between 2791# storage class and type. 2792 if ($line =~ /\b$Type\s+$Inline\b/ || 2793 $line =~ /\b$Inline\s+$Storage\b/) { 2794 ERROR("inline keyword should sit between storage class and type\n" . $herecurr); 2795 } 2796 2797# check for sizeof(&) 2798 if ($line =~ /\bsizeof\s*\(\s*\&/) { 2799 ERROR("sizeof(& should be avoided\n" . $herecurr); 2800 } 2801 2802# check for new externs in .c files. 2803 if ($realfile =~ /\.c$/ && defined $stat && 2804 $stat =~ /^.\s*(?:extern\s+)?$Type\s+($Ident)(\s*)\(/s) 2805 { 2806 my $function_name = $1; 2807 my $paren_space = $2; 2808 2809 my $s = $stat; 2810 if (defined $cond) { 2811 substr($s, 0, length($cond), ''); 2812 } 2813 if ($s =~ /^\s*;/ && 2814 $function_name ne 'uninitialized_var') 2815 { 2816 ERROR("externs should be avoided in .c files\n" . $herecurr); 2817 } 2818 2819 if ($paren_space =~ /\n/) { 2820 ERROR("arguments for function declarations should follow identifier\n" . $herecurr); 2821 } 2822 2823 } elsif ($realfile =~ /\.c$/ && defined $stat && 2824 $stat =~ /^.\s*extern\s+/) 2825 { 2826 ERROR("externs should be avoided in .c files\n" . $herecurr); 2827 } 2828 2829# check for pointless casting of g_malloc return 2830 if ($line =~ /\*\s*\)\s*g_(try)?(m|re)alloc(0?)(_n)?\b/) { 2831 if ($2 == 'm') { 2832 ERROR("unnecessary cast may hide bugs, use g_$1new$3 instead\n" . $herecurr); 2833 } else { 2834 ERROR("unnecessary cast may hide bugs, use g_$1renew$3 instead\n" . $herecurr); 2835 } 2836 } 2837 2838# check for gcc specific __FUNCTION__ 2839 if ($line =~ /__FUNCTION__/) { 2840 ERROR("__func__ should be used instead of gcc specific __FUNCTION__\n" . $herecurr); 2841 } 2842 2843# recommend g_path_get_* over g_strdup(basename/dirname(...)) 2844 if ($line =~ /\bg_strdup\s*\(\s*(basename|dirname)\s*\(/) { 2845 WARN("consider using g_path_get_$1() in preference to g_strdup($1())\n" . $herecurr); 2846 } 2847 2848# recommend qemu_strto* over strto* for numeric conversions 2849 if ($line =~ /\b(strto[^kd].*?)\s*\(/) { 2850 ERROR("consider using qemu_$1 in preference to $1\n" . $herecurr); 2851 } 2852# recommend sigaction over signal for portability, when establishing a handler 2853 if ($line =~ /\bsignal\s*\(/ && !($line =~ /SIG_(?:IGN|DFL)/)) { 2854 ERROR("use sigaction to establish signal handlers; signal is not portable\n" . $herecurr); 2855 } 2856# check for module_init(), use category-specific init macros explicitly please 2857 if ($line =~ /^module_init\s*\(/) { 2858 ERROR("please use block_init(), type_init() etc. instead of module_init()\n" . $herecurr); 2859 } 2860# check for various ops structs, ensure they are const. 2861 my $struct_ops = qr{AIOCBInfo| 2862 BdrvActionOps| 2863 BlockDevOps| 2864 BlockJobDriver| 2865 DisplayChangeListenerOps| 2866 GraphicHwOps| 2867 IDEDMAOps| 2868 KVMCapabilityInfo| 2869 MemoryRegionIOMMUOps| 2870 MemoryRegionOps| 2871 MemoryRegionPortio| 2872 QEMUFileOps| 2873 SCSIBusInfo| 2874 SCSIReqOps| 2875 Spice[A-Z][a-zA-Z0-9]*Interface| 2876 USBDesc[A-Z][a-zA-Z0-9]*| 2877 VhostOps| 2878 VMStateDescription| 2879 VMStateInfo}x; 2880 if ($line !~ /\bconst\b/ && 2881 $line =~ /\b($struct_ops)\b.*=/) { 2882 ERROR("initializer for struct $1 should normally be const\n" . 2883 $herecurr); 2884 } 2885 2886# format strings checks 2887 my $string; 2888 while ($line =~ /(?:^|")([X\t]*)(?:"|$)/g) { 2889 $string = substr($rawline, $-[1], $+[1] - $-[1]); 2890 $string =~ s/%%/__/g; 2891 # check for %L{u,d,i} in strings 2892 if ($string =~ /(?<!%)%L[udi]/) { 2893 ERROR("\%Ld/%Lu are not-standard C, use %lld/%llu\n" . $herecurr); 2894 } 2895 # check for %# or %0# in printf-style format strings 2896 if ($string =~ /(?<!%)%0?#/) { 2897 ERROR("Don't use '#' flag of printf format " . 2898 "('%#') in format strings, use '0x' " . 2899 "prefix instead\n" . $herecurr); 2900 } 2901 } 2902 2903# QEMU specific tests 2904 if ($rawline =~ /\b(?:Qemu|QEmu)\b/) { 2905 ERROR("use QEMU instead of Qemu or QEmu\n" . $herecurr); 2906 } 2907 2908# Qemu error function tests 2909 2910 # Find newlines in error messages 2911 my $qemu_error_funcs = qr{error_setg| 2912 error_setg_errno| 2913 error_setg_win32| 2914 error_setg_file_open| 2915 error_set| 2916 error_prepend| 2917 warn_reportf_err| 2918 error_reportf_err| 2919 error_vreport| 2920 warn_vreport| 2921 info_vreport| 2922 error_report| 2923 warn_report| 2924 info_report| 2925 g_test_message}x; 2926 2927 if ($rawline =~ /\b(?:$qemu_error_funcs)\s*\(.*\".*\\n/) { 2928 ERROR("Error messages should not contain newlines\n" . $herecurr); 2929 } 2930 2931 # Continue checking for error messages that contains newlines. This 2932 # check handles cases where string literals are spread over multiple lines. 2933 # Example: 2934 # error_report("Error msg line #1" 2935 # "Error msg line #2\n"); 2936 my $quoted_newline_regex = qr{\+\s*\".*\\n.*\"}; 2937 my $continued_str_literal = qr{\+\s*\".*\"}; 2938 2939 if ($rawline =~ /$quoted_newline_regex/) { 2940 # Backtrack to first line that does not contain only a quoted literal 2941 # and assume that it is the start of the statement. 2942 my $i = $linenr - 2; 2943 2944 while (($i >= 0) & $rawlines[$i] =~ /$continued_str_literal/) { 2945 $i--; 2946 } 2947 2948 if ($rawlines[$i] =~ /\b(?:$qemu_error_funcs)\s*\(/) { 2949 ERROR("Error messages should not contain newlines\n" . $herecurr); 2950 } 2951 } 2952 2953# check for non-portable libc calls that have portable alternatives in QEMU 2954 if ($line =~ /\bffs\(/) { 2955 ERROR("use ctz32() instead of ffs()\n" . $herecurr); 2956 } 2957 if ($line =~ /\bffsl\(/) { 2958 ERROR("use ctz32() or ctz64() instead of ffsl()\n" . $herecurr); 2959 } 2960 if ($line =~ /\bffsll\(/) { 2961 ERROR("use ctz64() instead of ffsll()\n" . $herecurr); 2962 } 2963 if ($line =~ /\bbzero\(/) { 2964 ERROR("use memset() instead of bzero()\n" . $herecurr); 2965 } 2966 if ($line =~ /\bgetpagesize\(\)/) { 2967 ERROR("use qemu_real_host_page_size instead of getpagesize()\n" . $herecurr); 2968 } 2969 if ($line =~ /\bsysconf\(_SC_PAGESIZE\)/) { 2970 ERROR("use qemu_real_host_page_size instead of sysconf(_SC_PAGESIZE)\n" . $herecurr); 2971 } 2972 my $non_exit_glib_asserts = qr{g_assert_cmpstr| 2973 g_assert_cmpint| 2974 g_assert_cmpuint| 2975 g_assert_cmphex| 2976 g_assert_cmpfloat| 2977 g_assert_true| 2978 g_assert_false| 2979 g_assert_nonnull| 2980 g_assert_null| 2981 g_assert_no_error| 2982 g_assert_error| 2983 g_test_assert_expected_messages| 2984 g_test_trap_assert_passed| 2985 g_test_trap_assert_stdout| 2986 g_test_trap_assert_stdout_unmatched| 2987 g_test_trap_assert_stderr| 2988 g_test_trap_assert_stderr_unmatched}x; 2989 if ($realfile !~ /^tests\// && 2990 $line =~ /\b(?:$non_exit_glib_asserts)\(/) { 2991 ERROR("Use g_assert or g_assert_not_reached\n". $herecurr); 2992 } 2993 } 2994 2995 if ($is_patch && $chk_signoff && $signoff == 0) { 2996 ERROR("Missing Signed-off-by: line(s)\n"); 2997 } 2998 2999 # If we have no input at all, then there is nothing to report on 3000 # so just keep quiet. 3001 if ($#rawlines == -1) { 3002 return 1; 3003 } 3004 3005 # In mailback mode only produce a report in the negative, for 3006 # things that appear to be patches. 3007 if ($mailback && ($clean == 1 || !$is_patch)) { 3008 return 1; 3009 } 3010 3011 # This is not a patch, and we are are in 'no-patch' mode so 3012 # just keep quiet. 3013 if (!$chk_patch && !$is_patch) { 3014 return 1; 3015 } 3016 3017 if (!$is_patch && $filename !~ /cover-letter\.patch$/) { 3018 ERROR("Does not appear to be a unified-diff format patch\n"); 3019 } 3020 3021 print report_dump(); 3022 if ($summary && !($clean == 1 && $quiet == 1)) { 3023 print "$filename " if ($summary_file); 3024 print "total: $cnt_error errors, $cnt_warn warnings, " . 3025 "$cnt_lines lines checked\n"; 3026 print "\n" if ($quiet == 0); 3027 } 3028 3029 if ($quiet == 0) { 3030 # If there were whitespace errors which cleanpatch can fix 3031 # then suggest that. 3032# if ($rpt_cleaners) { 3033# print "NOTE: whitespace errors detected, you may wish to use scripts/cleanpatch or\n"; 3034# print " scripts/cleanfile\n\n"; 3035# } 3036 } 3037 3038 if ($clean == 1 && $quiet == 0) { 3039 print "$vname has no obvious style problems and is ready for submission.\n" 3040 } 3041 if ($clean == 0 && $quiet == 0) { 3042 print "$vname has style problems, please review. If any of these errors\n"; 3043 print "are false positives report them to the maintainer, see\n"; 3044 print "CHECKPATCH in MAINTAINERS.\n"; 3045 } 3046 3047 return ($no_warnings ? $clean : $cnt_error == 0); 3048} 3049