/usr/lib/llvm-4.0/bin/scan-build is in clang-tools-4.0 1:4.0.1-10~deb9u2.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 | #!/usr/bin/env perl
#
# The LLVM Compiler Infrastructure
#
# This file is distributed under the University of Illinois Open Source
# License. See LICENSE.TXT for details.
#
##===----------------------------------------------------------------------===##
#
# A script designed to wrap a build so that all calls to gcc are intercepted
# and piped to the static analyzer.
#
##===----------------------------------------------------------------------===##
use strict;
use warnings;
use FindBin qw($RealBin);
use Digest::MD5;
use File::Basename;
use File::Find;
use File::Copy qw(copy);
use File::Path qw( rmtree mkpath );
use Term::ANSIColor;
use Term::ANSIColor qw(:constants);
use Cwd qw/ getcwd abs_path /;
use Sys::Hostname;
use Hash::Util qw(lock_keys);
my $Prog = "scan-build";
my $BuildName;
my $BuildDate;
my $TERM = $ENV{'TERM'};
my $UseColor = (defined $TERM and $TERM =~ 'xterm-.*color' and -t STDOUT
and defined $ENV{'SCAN_BUILD_COLOR'});
# Portability: getpwuid is not implemented for Win32 (see Perl language
# reference, perlport), use getlogin instead.
my $UserName = HtmlEscape(getlogin() || getpwuid($<) || 'unknown');
my $HostName = HtmlEscape(hostname() || 'unknown');
my $CurrentDir = HtmlEscape(getcwd());
my $CmdArgs;
my $Date = localtime();
# Command-line/config arguments.
my %Options = (
Verbose => 0, # Verbose output from this script.
AnalyzeHeaders => 0,
OutputDir => undef, # Parent directory to store HTML files.
HtmlTitle => basename($CurrentDir)." - scan-build results",
IgnoreErrors => 0, # Ignore build errors.
ViewResults => 0, # View results when the build terminates.
ExitStatusFoundBugs => 0, # Exit status reflects whether bugs were found
ShowDescription => 0, # Display the description of the defect in the list
KeepEmpty => 0, # Don't remove output directory even with 0 results.
EnableCheckers => {},
DisableCheckers => {},
UseCC => undef, # C compiler to use for compilation.
UseCXX => undef, # C++ compiler to use for compilation.
AnalyzerTarget => undef,
StoreModel => undef,
ConstraintsModel => undef,
InternalStats => undef,
OutputFormat => "html",
ConfigOptions => [], # Options to pass through to the analyzer's -analyzer-config flag.
ReportFailures => undef,
AnalyzerStats => 0,
MaxLoop => 0,
PluginsToLoad => [],
AnalyzerDiscoveryMethod => undef,
OverrideCompiler => 0, # The flag corresponding to the --override-compiler command line option.
ForceAnalyzeDebugCode => 0
);
lock_keys(%Options);
##----------------------------------------------------------------------------##
# Diagnostics
##----------------------------------------------------------------------------##
sub Diag {
if ($UseColor) {
print BOLD, MAGENTA "$Prog: @_";
print RESET;
}
else {
print "$Prog: @_";
}
}
sub ErrorDiag {
if ($UseColor) {
print STDERR BOLD, RED "$Prog: ";
print STDERR RESET, RED @_;
print STDERR RESET;
} else {
print STDERR "$Prog: @_";
}
}
sub DiagCrashes {
my $Dir = shift;
Diag ("The analyzer encountered problems on some source files.\n");
Diag ("Preprocessed versions of these sources were deposited in '$Dir/failures'.\n");
Diag ("Please consider submitting a bug report using these files:\n");
Diag (" http://clang-analyzer.llvm.org/filing_bugs.html\n")
}
sub DieDiag {
if ($UseColor) {
print STDERR BOLD, RED "$Prog: ";
print STDERR RESET, RED @_;
print STDERR RESET;
}
else {
print STDERR "$Prog: ", @_;
}
exit 1;
}
##----------------------------------------------------------------------------##
# Print default checker names
##----------------------------------------------------------------------------##
if (grep /^--help-checkers$/, @ARGV) {
my @options = qx($0 -h);
foreach (@options) {
next unless /^ \+/;
s/^\s*//;
my ($sign, $name, @text) = split ' ', $_;
print $name, $/ if $sign eq '+';
}
exit 0;
}
##----------------------------------------------------------------------------##
# Declaration of Clang options. Populated later.
##----------------------------------------------------------------------------##
my $Clang;
my $ClangSB;
my $ClangCXX;
my $ClangVersion;
##----------------------------------------------------------------------------##
# GetHTMLRunDir - Construct an HTML directory name for the current sub-run.
##----------------------------------------------------------------------------##
sub GetHTMLRunDir {
die "Not enough arguments." if (@_ == 0);
my $Dir = shift @_;
my $TmpMode = 0;
if (!defined $Dir) {
$Dir = $ENV{'TMPDIR'} || $ENV{'TEMP'} || $ENV{'TMP'} || "/tmp";
$TmpMode = 1;
}
# Chop off any trailing '/' characters.
while ($Dir =~ /\/$/) { chop $Dir; }
# Get current date and time.
my @CurrentTime = localtime();
my $year = $CurrentTime[5] + 1900;
my $day = $CurrentTime[3];
my $month = $CurrentTime[4] + 1;
my $hour = $CurrentTime[2];
my $min = $CurrentTime[1];
my $sec = $CurrentTime[0];
my $TimeString = sprintf("%02d%02d%02d", $hour, $min, $sec);
my $DateString = sprintf("%d-%02d-%02d-%s-$$",
$year, $month, $day, $TimeString);
# Determine the run number.
my $RunNumber;
if (-d $Dir) {
if (! -r $Dir) {
DieDiag("directory '$Dir' exists but is not readable.\n");
}
# Iterate over all files in the specified directory.
my $max = 0;
opendir(DIR, $Dir);
my @FILES = grep { -d "$Dir/$_" } readdir(DIR);
closedir(DIR);
foreach my $f (@FILES) {
# Strip the prefix '$Prog-' if we are dumping files to /tmp.
if ($TmpMode) {
next if (!($f =~ /^$Prog-(.+)/));
$f = $1;
}
my @x = split/-/, $f;
next if (scalar(@x) != 4);
next if ($x[0] != $year);
next if ($x[1] != $month);
next if ($x[2] != $day);
next if ($x[3] != $TimeString);
next if ($x[4] != $$);
if ($x[5] > $max) {
$max = $x[5];
}
}
$RunNumber = $max + 1;
}
else {
if (-x $Dir) {
DieDiag("'$Dir' exists but is not a directory.\n");
}
if ($TmpMode) {
DieDiag("The directory '/tmp' does not exist or cannot be accessed.\n");
}
# $Dir does not exist. It will be automatically created by the
# clang driver. Set the run number to 1.
$RunNumber = 1;
}
die "RunNumber must be defined!" if (!defined $RunNumber);
# Append the run number.
my $NewDir;
if ($TmpMode) {
$NewDir = "$Dir/$Prog-$DateString-$RunNumber";
}
else {
$NewDir = "$Dir/$DateString-$RunNumber";
}
# Make sure that the directory does not exist in order to avoid hijack.
if (-e $NewDir) {
DieDiag("The directory '$NewDir' already exists.\n");
}
mkpath($NewDir);
return $NewDir;
}
sub SetHtmlEnv {
die "Wrong number of arguments." if (scalar(@_) != 2);
my $Args = shift;
my $Dir = shift;
die "No build command." if (scalar(@$Args) == 0);
my $Cmd = $$Args[0];
if ($Cmd =~ /configure/ || $Cmd =~ /autogen/) {
return;
}
if ($Options{Verbose}) {
Diag("Emitting reports for this run to '$Dir'.\n");
}
$ENV{'CCC_ANALYZER_HTML'} = $Dir;
}
##----------------------------------------------------------------------------##
# ComputeDigest - Compute a digest of the specified file.
##----------------------------------------------------------------------------##
sub ComputeDigest {
my $FName = shift;
DieDiag("Cannot read $FName to compute Digest.\n") if (! -r $FName);
# Use Digest::MD5. We don't have to be cryptographically secure. We're
# just looking for duplicate files that come from a non-malicious source.
# We use Digest::MD5 because it is a standard Perl module that should
# come bundled on most systems.
open(FILE, $FName) or DieDiag("Cannot open $FName when computing Digest.\n");
binmode FILE;
my $Result = Digest::MD5->new->addfile(*FILE)->hexdigest;
close(FILE);
# Return the digest.
return $Result;
}
##----------------------------------------------------------------------------##
# UpdatePrefix - Compute the common prefix of files.
##----------------------------------------------------------------------------##
my $Prefix;
sub UpdatePrefix {
my $x = shift;
my $y = basename($x);
$x =~ s/\Q$y\E$//;
if (!defined $Prefix) {
$Prefix = $x;
return;
}
chop $Prefix while (!($x =~ /^\Q$Prefix/));
}
sub GetPrefix {
return $Prefix;
}
##----------------------------------------------------------------------------##
# UpdateInFilePath - Update the path in the report file.
##----------------------------------------------------------------------------##
sub UpdateInFilePath {
my $fname = shift;
my $regex = shift;
my $newtext = shift;
open (RIN, $fname) or die "cannot open $fname";
open (ROUT, ">", "$fname.tmp") or die "cannot open $fname.tmp";
while (<RIN>) {
s/$regex/$newtext/;
print ROUT $_;
}
close (ROUT);
close (RIN);
rename("$fname.tmp", $fname)
}
##----------------------------------------------------------------------------##
# AddStatLine - Decode and insert a statistics line into the database.
##----------------------------------------------------------------------------##
sub AddStatLine {
my $Line = shift;
my $Stats = shift;
my $File = shift;
print $Line . "\n";
my $Regex = qr/(.*?)\ ->\ Total\ CFGBlocks:\ (\d+)\ \|\ Unreachable
\ CFGBlocks:\ (\d+)\ \|\ Exhausted\ Block:\ (yes|no)\ \|\ Empty\ WorkList:
\ (yes|no)/x;
if ($Line !~ $Regex) {
return;
}
# Create a hash of the interesting fields
my $Row = {
Filename => $File,
Function => $1,
Total => $2,
Unreachable => $3,
Aborted => $4,
Empty => $5
};
# Add them to the stats array
push @$Stats, $Row;
}
##----------------------------------------------------------------------------##
# ScanFile - Scan a report file for various identifying attributes.
##----------------------------------------------------------------------------##
# Sometimes a source file is scanned more than once, and thus produces
# multiple error reports. We use a cache to solve this problem.
my %AlreadyScanned;
sub ScanFile {
my $Index = shift;
my $Dir = shift;
my $FName = shift;
my $Stats = shift;
# Compute a digest for the report file. Determine if we have already
# scanned a file that looks just like it.
my $digest = ComputeDigest("$Dir/$FName");
if (defined $AlreadyScanned{$digest}) {
# Redundant file. Remove it.
unlink("$Dir/$FName");
return;
}
$AlreadyScanned{$digest} = 1;
# At this point the report file is not world readable. Make it happen.
chmod(0644, "$Dir/$FName");
# Scan the report file for tags.
open(IN, "$Dir/$FName") or DieDiag("Cannot open '$Dir/$FName'\n");
my $BugType = "";
my $BugFile = "";
my $BugFunction = "";
my $BugCategory = "";
my $BugDescription = "";
my $BugPathLength = 1;
my $BugLine = 0;
while (<IN>) {
last if (/<!-- BUGMETAEND -->/);
if (/<!-- BUGTYPE (.*) -->$/) {
$BugType = $1;
}
elsif (/<!-- BUGFILE (.*) -->$/) {
$BugFile = abs_path($1);
if (!defined $BugFile) {
# The file no longer exists: use the original path.
$BugFile = $1;
}
UpdatePrefix($BugFile);
}
elsif (/<!-- BUGPATHLENGTH (.*) -->$/) {
$BugPathLength = $1;
}
elsif (/<!-- BUGLINE (.*) -->$/) {
$BugLine = $1;
}
elsif (/<!-- BUGCATEGORY (.*) -->$/) {
$BugCategory = $1;
}
elsif (/<!-- BUGDESC (.*) -->$/) {
$BugDescription = $1;
}
elsif (/<!-- FUNCTIONNAME (.*) -->$/) {
$BugFunction = $1;
}
}
close(IN);
if (!defined $BugCategory) {
$BugCategory = "Other";
}
# Don't add internal statistics to the bug reports
if ($BugCategory =~ /statistics/i) {
AddStatLine($BugDescription, $Stats, $BugFile);
return;
}
push @$Index,[ $FName, $BugCategory, $BugType, $BugFile, $BugFunction, $BugLine,
$BugPathLength ];
if ($Options{ShowDescription}) {
push @{ $Index->[-1] }, $BugDescription
}
}
##----------------------------------------------------------------------------##
# CopyFiles - Copy resource files to target directory.
##----------------------------------------------------------------------------##
sub CopyFiles {
my $Dir = shift;
my $JS = Cwd::realpath("$RealBin/../share/scan-build/sorttable.js");
DieDiag("Cannot find 'sorttable.js'.\n")
if (! -r $JS);
copy($JS, "$Dir");
DieDiag("Could not copy 'sorttable.js' to '$Dir'.\n")
if (! -r "$Dir/sorttable.js");
my $CSS = Cwd::realpath("$RealBin/../share/scan-build/scanview.css");
DieDiag("Cannot find 'scanview.css'.\n")
if (! -r $CSS);
copy($CSS, "$Dir");
DieDiag("Could not copy 'scanview.css' to '$Dir'.\n")
if (! -r $CSS);
}
##----------------------------------------------------------------------------##
# CalcStats - Calculates visitation statistics and returns the string.
##----------------------------------------------------------------------------##
sub CalcStats {
my $Stats = shift;
my $TotalBlocks = 0;
my $UnreachedBlocks = 0;
my $TotalFunctions = scalar(@$Stats);
my $BlockAborted = 0;
my $WorkListAborted = 0;
my $Aborted = 0;
# Calculate the unique files
my $FilesHash = {};
foreach my $Row (@$Stats) {
$FilesHash->{$Row->{Filename}} = 1;
$TotalBlocks += $Row->{Total};
$UnreachedBlocks += $Row->{Unreachable};
$BlockAborted++ if $Row->{Aborted} eq 'yes';
$WorkListAborted++ if $Row->{Empty} eq 'no';
$Aborted++ if $Row->{Aborted} eq 'yes' || $Row->{Empty} eq 'no';
}
my $TotalFiles = scalar(keys(%$FilesHash));
# Calculations
my $PercentAborted = sprintf("%.2f", $Aborted / $TotalFunctions * 100);
my $PercentBlockAborted = sprintf("%.2f", $BlockAborted / $TotalFunctions
* 100);
my $PercentWorkListAborted = sprintf("%.2f", $WorkListAborted /
$TotalFunctions * 100);
my $PercentBlocksUnreached = sprintf("%.2f", $UnreachedBlocks / $TotalBlocks
* 100);
my $StatsString = "Analyzed $TotalBlocks blocks in $TotalFunctions functions"
. " in $TotalFiles files\n"
. "$Aborted functions aborted early ($PercentAborted%)\n"
. "$BlockAborted had aborted blocks ($PercentBlockAborted%)\n"
. "$WorkListAborted had unfinished worklists ($PercentWorkListAborted%)\n"
. "$UnreachedBlocks blocks were never reached ($PercentBlocksUnreached%)\n";
return $StatsString;
}
##----------------------------------------------------------------------------##
# Postprocess - Postprocess the results of an analysis scan.
##----------------------------------------------------------------------------##
my @filesFound;
my $baseDir;
sub FileWanted {
my $baseDirRegEx = quotemeta $baseDir;
my $file = $File::Find::name;
# The name of the file is generated by clang binary (HTMLDiagnostics.cpp)
if ($file =~ /report-.*\.html$/) {
my $relative_file = $file;
$relative_file =~ s/$baseDirRegEx//g;
push @filesFound, $relative_file;
}
}
sub Postprocess {
my $Dir = shift;
my $BaseDir = shift;
my $AnalyzerStats = shift;
my $KeepEmpty = shift;
die "No directory specified." if (!defined $Dir);
if (! -d $Dir) {
Diag("No bugs found.\n");
return 0;
}
$baseDir = $Dir . "/";
find({ wanted => \&FileWanted, follow => 0}, $Dir);
if (scalar(@filesFound) == 0 and ! -e "$Dir/failures") {
if (! $KeepEmpty) {
Diag("Removing directory '$Dir' because it contains no reports.\n");
rmtree($Dir) or die "Cannot rmtree '$Dir' : $!";
}
Diag("No bugs found.\n");
return 0;
}
# Scan each report file and build an index.
my @Index;
my @Stats;
foreach my $file (@filesFound) { ScanFile(\@Index, $Dir, $file, \@Stats); }
# Scan the failures directory and use the information in the .info files
# to update the common prefix directory.
my @failures;
my @attributes_ignored;
if (-d "$Dir/failures") {
opendir(DIR, "$Dir/failures");
@failures = grep { /[.]info.txt$/ && !/attribute_ignored/; } readdir(DIR);
closedir(DIR);
opendir(DIR, "$Dir/failures");
@attributes_ignored = grep { /^attribute_ignored/; } readdir(DIR);
closedir(DIR);
foreach my $file (@failures) {
open IN, "$Dir/failures/$file" or DieDiag("cannot open $file\n");
my $Path = <IN>;
if (defined $Path) { UpdatePrefix($Path); }
close IN;
}
}
# Generate an index.html file.
my $FName = "$Dir/index.html";
open(OUT, ">", $FName) or DieDiag("Cannot create file '$FName'\n");
# Print out the header.
print OUT <<ENDTEXT;
<html>
<head>
<title>${Options{HtmlTitle}}</title>
<link type="text/css" rel="stylesheet" href="scanview.css"/>
<script src="sorttable.js"></script>
<script language='javascript' type="text/javascript">
function SetDisplay(RowClass, DisplayVal)
{
var Rows = document.getElementsByTagName("tr");
for ( var i = 0 ; i < Rows.length; ++i ) {
if (Rows[i].className == RowClass) {
Rows[i].style.display = DisplayVal;
}
}
}
function CopyCheckedStateToCheckButtons(SummaryCheckButton) {
var Inputs = document.getElementsByTagName("input");
for ( var i = 0 ; i < Inputs.length; ++i ) {
if (Inputs[i].type == "checkbox") {
if(Inputs[i] != SummaryCheckButton) {
Inputs[i].checked = SummaryCheckButton.checked;
Inputs[i].onclick();
}
}
}
}
function returnObjById( id ) {
if (document.getElementById)
var returnVar = document.getElementById(id);
else if (document.all)
var returnVar = document.all[id];
else if (document.layers)
var returnVar = document.layers[id];
return returnVar;
}
var NumUnchecked = 0;
function ToggleDisplay(CheckButton, ClassName) {
if (CheckButton.checked) {
SetDisplay(ClassName, "");
if (--NumUnchecked == 0) {
returnObjById("AllBugsCheck").checked = true;
}
}
else {
SetDisplay(ClassName, "none");
NumUnchecked++;
returnObjById("AllBugsCheck").checked = false;
}
}
</script>
<!-- SUMMARYENDHEAD -->
</head>
<body>
<h1>${Options{HtmlTitle}}</h1>
<table>
<tr><th>User:</th><td>${UserName}\@${HostName}</td></tr>
<tr><th>Working Directory:</th><td>${CurrentDir}</td></tr>
<tr><th>Command Line:</th><td>${CmdArgs}</td></tr>
<tr><th>Clang Version:</th><td>${ClangVersion}</td></tr>
<tr><th>Date:</th><td>${Date}</td></tr>
ENDTEXT
print OUT "<tr><th>Version:</th><td>${BuildName} (${BuildDate})</td></tr>\n"
if (defined($BuildName) && defined($BuildDate));
print OUT <<ENDTEXT;
</table>
ENDTEXT
if (scalar(@filesFound)) {
# Print out the summary table.
my %Totals;
for my $row ( @Index ) {
my $bug_type = ($row->[2]);
my $bug_category = ($row->[1]);
my $key = "$bug_category:$bug_type";
if (!defined $Totals{$key}) { $Totals{$key} = [1,$bug_category,$bug_type]; }
else { $Totals{$key}->[0]++; }
}
print OUT "<h2>Bug Summary</h2>";
if (defined $BuildName) {
print OUT "\n<p>Results in this analysis run are based on analyzer build <b>$BuildName</b>.</p>\n"
}
my $TotalBugs = scalar(@Index);
print OUT <<ENDTEXT;
<table>
<thead><tr><td>Bug Type</td><td>Quantity</td><td class="sorttable_nosort">Display?</td></tr></thead>
<tr style="font-weight:bold"><td class="SUMM_DESC">All Bugs</td><td class="Q">$TotalBugs</td><td><center><input type="checkbox" id="AllBugsCheck" onClick="CopyCheckedStateToCheckButtons(this);" checked/></center></td></tr>
ENDTEXT
my $last_category;
for my $key (
sort {
my $x = $Totals{$a};
my $y = $Totals{$b};
my $res = $x->[1] cmp $y->[1];
$res = $x->[2] cmp $y->[2] if ($res == 0);
$res
} keys %Totals )
{
my $val = $Totals{$key};
my $category = $val->[1];
if (!defined $last_category or $last_category ne $category) {
$last_category = $category;
print OUT "<tr><th>$category</th><th colspan=2></th></tr>\n";
}
my $x = lc $key;
$x =~ s/[ ,'":\/()]+/_/g;
print OUT "<tr><td class=\"SUMM_DESC\">";
print OUT $val->[2];
print OUT "</td><td class=\"Q\">";
print OUT $val->[0];
print OUT "</td><td><center><input type=\"checkbox\" onClick=\"ToggleDisplay(this,'bt_$x');\" checked/></center></td></tr>\n";
}
# Print out the table of errors.
print OUT <<ENDTEXT;
</table>
<h2>Reports</h2>
<table class="sortable" style="table-layout:automatic">
<thead><tr>
<td>Bug Group</td>
<td class="sorttable_sorted">Bug Type<span id="sorttable_sortfwdind"> ▾</span></td>
<td>File</td>
<td>Function/Method</td>
<td class="Q">Line</td>
<td class="Q">Path Length</td>
ENDTEXT
if ($Options{ShowDescription}) {
print OUT <<ENDTEXT;
<td class="Q">Description</td>
ENDTEXT
}
print OUT <<ENDTEXT;
<td class="sorttable_nosort"></td>
<!-- REPORTBUGCOL -->
</tr></thead>
<tbody>
ENDTEXT
my $prefix = GetPrefix();
my $regex;
my $InFileRegex;
my $InFilePrefix = "File:</td><td>";
if (defined $prefix) {
$regex = qr/^\Q$prefix\E/is;
$InFileRegex = qr/\Q$InFilePrefix$prefix\E/is;
}
for my $row ( sort { $a->[2] cmp $b->[2] } @Index ) {
my $x = "$row->[1]:$row->[2]";
$x = lc $x;
$x =~ s/[ ,'":\/()]+/_/g;
my $ReportFile = $row->[0];
print OUT "<tr class=\"bt_$x\">";
print OUT "<td class=\"DESC\">";
print OUT $row->[1]; # $BugCategory
print OUT "</td>";
print OUT "<td class=\"DESC\">";
print OUT $row->[2]; # $BugType
print OUT "</td>";
# Update the file prefix.
my $fname = $row->[3];
if (defined $regex) {
$fname =~ s/$regex//;
UpdateInFilePath("$Dir/$ReportFile", $InFileRegex, $InFilePrefix)
}
print OUT "<td>";
my @fname = split /\//,$fname;
if ($#fname > 0) {
while ($#fname >= 0) {
my $x = shift @fname;
print OUT $x;
if ($#fname >= 0) {
print OUT "/";
}
}
}
else {
print OUT $fname;
}
print OUT "</td>";
print OUT "<td class=\"DESC\">";
print OUT $row->[4]; # Function
print OUT "</td>";
# Print out the quantities.
for my $j ( 5 .. 6 ) { # Line & Path length
print OUT "<td class=\"Q\">$row->[$j]</td>";
}
# Print the rest of the columns.
for (my $j = 7; $j <= $#{$row}; ++$j) {
print OUT "<td>$row->[$j]</td>"
}
# Emit the "View" link.
print OUT "<td><a href=\"$ReportFile#EndPath\">View Report</a></td>";
# Emit REPORTBUG markers.
print OUT "\n<!-- REPORTBUG id=\"$ReportFile\" -->\n";
# End the row.
print OUT "</tr>\n";
}
print OUT "</tbody>\n</table>\n\n";
}
if (scalar (@failures) || scalar(@attributes_ignored)) {
print OUT "<h2>Analyzer Failures</h2>\n";
if (scalar @attributes_ignored) {
print OUT "The analyzer's parser ignored the following attributes:<p>\n";
print OUT "<table>\n";
print OUT "<thead><tr><td>Attribute</td><td>Source File</td><td>Preprocessed File</td><td>STDERR Output</td></tr></thead>\n";
foreach my $file (sort @attributes_ignored) {
die "cannot demangle attribute name\n" if (! ($file =~ /^attribute_ignored_(.+).txt/));
my $attribute = $1;
# Open the attribute file to get the first file that failed.
next if (!open (ATTR, "$Dir/failures/$file"));
my $ppfile = <ATTR>;
chomp $ppfile;
close ATTR;
next if (! -e "$Dir/failures/$ppfile");
# Open the info file and get the name of the source file.
open (INFO, "$Dir/failures/$ppfile.info.txt") or
die "Cannot open $Dir/failures/$ppfile.info.txt\n";
my $srcfile = <INFO>;
chomp $srcfile;
close (INFO);
# Print the information in the table.
my $prefix = GetPrefix();
if (defined $prefix) { $srcfile =~ s/^\Q$prefix//; }
print OUT "<tr><td>$attribute</td><td>$srcfile</td><td><a href=\"failures/$ppfile\">$ppfile</a></td><td><a href=\"failures/$ppfile.stderr.txt\">$ppfile.stderr.txt</a></td></tr>\n";
my $ppfile_clang = $ppfile;
$ppfile_clang =~ s/[.](.+)$/.clang.$1/;
print OUT " <!-- REPORTPROBLEM src=\"$srcfile\" file=\"failures/$ppfile\" clangfile=\"failures/$ppfile_clang\" stderr=\"failures/$ppfile.stderr.txt\" info=\"failures/$ppfile.info.txt\" -->\n";
}
print OUT "</table>\n";
}
if (scalar @failures) {
print OUT "<p>The analyzer had problems processing the following files:</p>\n";
print OUT "<table>\n";
print OUT "<thead><tr><td>Problem</td><td>Source File</td><td>Preprocessed File</td><td>STDERR Output</td></tr></thead>\n";
foreach my $file (sort @failures) {
$file =~ /(.+).info.txt$/;
# Get the preprocessed file.
my $ppfile = $1;
# Open the info file and get the name of the source file.
open (INFO, "$Dir/failures/$file") or
die "Cannot open $Dir/failures/$file\n";
my $srcfile = <INFO>;
chomp $srcfile;
my $problem = <INFO>;
chomp $problem;
close (INFO);
# Print the information in the table.
my $prefix = GetPrefix();
if (defined $prefix) { $srcfile =~ s/^\Q$prefix//; }
print OUT "<tr><td>$problem</td><td>$srcfile</td><td><a href=\"failures/$ppfile\">$ppfile</a></td><td><a href=\"failures/$ppfile.stderr.txt\">$ppfile.stderr.txt</a></td></tr>\n";
my $ppfile_clang = $ppfile;
$ppfile_clang =~ s/[.](.+)$/.clang.$1/;
print OUT " <!-- REPORTPROBLEM src=\"$srcfile\" file=\"failures/$ppfile\" clangfile=\"failures/$ppfile_clang\" stderr=\"failures/$ppfile.stderr.txt\" info=\"failures/$ppfile.info.txt\" -->\n";
}
print OUT "</table>\n";
}
print OUT "<p>Please consider submitting preprocessed files as <a href=\"http://clang-analyzer.llvm.org/filing_bugs.html\">bug reports</a>. <!-- REPORTCRASHES --> </p>\n";
}
print OUT "</body></html>\n";
close(OUT);
CopyFiles($Dir);
# Make sure $Dir and $BaseDir are world readable/executable.
chmod(0755, $Dir);
if (defined $BaseDir) { chmod(0755, $BaseDir); }
# Print statistics
print CalcStats(\@Stats) if $AnalyzerStats;
my $Num = scalar(@Index);
if ($Num == 1) {
Diag("$Num bug found.\n");
} else {
Diag("$Num bugs found.\n");
}
if ($Num > 0 && -r "$Dir/index.html") {
Diag("Run 'scan-view $Dir' to examine bug reports.\n");
}
DiagCrashes($Dir) if (scalar @failures || scalar @attributes_ignored);
return $Num;
}
##----------------------------------------------------------------------------##
# RunBuildCommand - Run the build command.
##----------------------------------------------------------------------------##
sub AddIfNotPresent {
my $Args = shift;
my $Arg = shift;
my $found = 0;
foreach my $k (@$Args) {
if ($k eq $Arg) {
$found = 1;
last;
}
}
if ($found == 0) {
push @$Args, $Arg;
}
}
sub SetEnv {
my $EnvVars = shift @_;
foreach my $var ('CC', 'CXX', 'CLANG', 'CLANG_CXX',
'CCC_ANALYZER_ANALYSIS', 'CCC_ANALYZER_PLUGINS',
'CCC_ANALYZER_CONFIG') {
die "$var is undefined\n" if (!defined $var);
$ENV{$var} = $EnvVars->{$var};
}
foreach my $var ('CCC_ANALYZER_STORE_MODEL',
'CCC_ANALYZER_CONSTRAINTS_MODEL',
'CCC_ANALYZER_INTERNAL_STATS',
'CCC_ANALYZER_OUTPUT_FORMAT',
'CCC_CC',
'CCC_CXX',
'CCC_REPORT_FAILURES',
'CLANG_ANALYZER_TARGET',
'CCC_ANALYZER_FORCE_ANALYZE_DEBUG_CODE') {
my $x = $EnvVars->{$var};
if (defined $x) { $ENV{$var} = $x }
}
my $Verbose = $EnvVars->{'VERBOSE'};
if ($Verbose >= 2) {
$ENV{'CCC_ANALYZER_VERBOSE'} = 1;
}
if ($Verbose >= 3) {
$ENV{'CCC_ANALYZER_LOG'} = 1;
}
}
sub RunXcodebuild {
my $Args = shift;
my $IgnoreErrors = shift;
my $CCAnalyzer = shift;
my $CXXAnalyzer = shift;
my $EnvVars = shift;
if ($IgnoreErrors) {
AddIfNotPresent($Args,"-PBXBuildsContinueAfterErrors=YES");
}
# Detect the version of Xcode. If Xcode 4.6 or higher, use new
# in situ support for analyzer interposition without needed to override
# the compiler.
open(DETECT_XCODE, "-|", $Args->[0], "-version") or
die "error: cannot detect version of xcodebuild\n";
my $oldBehavior = 1;
while(<DETECT_XCODE>) {
if (/^Xcode (.+)$/) {
my $ver = $1;
if ($ver =~ /^([0-9]+[.][0-9]+)[^0-9]?/) {
if ($1 >= 4.6) {
$oldBehavior = 0;
last;
}
}
}
}
close(DETECT_XCODE);
# If --override-compiler is explicitely requested, resort to the old
# behavior regardless of Xcode version.
if ($Options{OverrideCompiler}) {
$oldBehavior = 1;
}
if ($oldBehavior == 0) {
my $OutputDir = $EnvVars->{"OUTPUT_DIR"};
my $CLANG = $EnvVars->{"CLANG"};
my $OtherFlags = $EnvVars->{"CCC_ANALYZER_ANALYSIS"};
push @$Args,
"RUN_CLANG_STATIC_ANALYZER=YES",
"CLANG_ANALYZER_OUTPUT=plist-html",
"CLANG_ANALYZER_EXEC=$CLANG",
"CLANG_ANALYZER_OUTPUT_DIR=$OutputDir",
"CLANG_ANALYZER_OTHER_FLAGS=$OtherFlags";
return (system(@$Args) >> 8);
}
# Default to old behavior where we insert a bogus compiler.
SetEnv($EnvVars);
# Check if using iPhone SDK 3.0 (simulator). If so the compiler being
# used should be gcc-4.2.
if (!defined $ENV{"CCC_CC"}) {
for (my $i = 0 ; $i < scalar(@$Args); ++$i) {
if ($Args->[$i] eq "-sdk" && $i + 1 < scalar(@$Args)) {
if (@$Args[$i+1] =~ /^iphonesimulator3/) {
$ENV{"CCC_CC"} = "gcc-4.2";
$ENV{"CCC_CXX"} = "g++-4.2";
}
}
}
}
# Disable PCH files until clang supports them.
AddIfNotPresent($Args,"GCC_PRECOMPILE_PREFIX_HEADER=NO");
# When 'CC' is set, xcodebuild uses it to do all linking, even if we are
# linking C++ object files. Set 'LDPLUSPLUS' so that xcodebuild uses 'g++'
# (via c++-analyzer) when linking such files.
$ENV{"LDPLUSPLUS"} = $CXXAnalyzer;
return (system(@$Args) >> 8);
}
sub RunBuildCommand {
my $Args = shift;
my $IgnoreErrors = shift;
my $Cmd = $Args->[0];
my $CCAnalyzer = shift;
my $CXXAnalyzer = shift;
my $EnvVars = shift;
if ($Cmd =~ /\bxcodebuild$/) {
return RunXcodebuild($Args, $IgnoreErrors, $CCAnalyzer, $CXXAnalyzer, $EnvVars);
}
# Setup the environment.
SetEnv($EnvVars);
if ($Cmd =~ /(.*\/?gcc[^\/]*$)/ or
$Cmd =~ /(.*\/?cc[^\/]*$)/ or
$Cmd =~ /(.*\/?llvm-gcc[^\/]*$)/ or
$Cmd =~ /(.*\/?clang$)/ or
$Cmd =~ /(.*\/?ccc-analyzer[^\/]*$)/) {
if (!($Cmd =~ /ccc-analyzer/) and !defined $ENV{"CCC_CC"}) {
$ENV{"CCC_CC"} = $1;
}
shift @$Args;
unshift @$Args, $CCAnalyzer;
}
elsif ($Cmd =~ /(.*\/?g\+\+[^\/]*$)/ or
$Cmd =~ /(.*\/?c\+\+[^\/]*$)/ or
$Cmd =~ /(.*\/?llvm-g\+\+[^\/]*$)/ or
$Cmd =~ /(.*\/?clang\+\+$)/ or
$Cmd =~ /(.*\/?c\+\+-analyzer[^\/]*$)/) {
if (!($Cmd =~ /c\+\+-analyzer/) and !defined $ENV{"CCC_CXX"}) {
$ENV{"CCC_CXX"} = $1;
}
shift @$Args;
unshift @$Args, $CXXAnalyzer;
}
elsif ($Cmd eq "make" or $Cmd eq "gmake" or $Cmd eq "mingw32-make") {
AddIfNotPresent($Args, "CC=$CCAnalyzer");
AddIfNotPresent($Args, "CXX=$CXXAnalyzer");
if ($IgnoreErrors) {
AddIfNotPresent($Args,"-k");
AddIfNotPresent($Args,"-i");
}
}
return (system(@$Args) >> 8);
}
##----------------------------------------------------------------------------##
# DisplayHelp - Utility function to display all help options.
##----------------------------------------------------------------------------##
sub DisplayHelp {
my $ArgClangNotFoundErrMsg = shift;
print <<ENDTEXT;
USAGE: $Prog [options] <build command> [build options]
ENDTEXT
if (defined $BuildName) {
print "ANALYZER BUILD: $BuildName ($BuildDate)\n\n";
}
print <<ENDTEXT;
OPTIONS:
-analyze-headers
Also analyze functions in #included files. By default, such functions
are skipped unless they are called by functions within the main source file.
--force-analyze-debug-code
Tells analyzer to enable assertions in code even if they were disabled
during compilation to enable more precise results.
-o <output location>
Specifies the output directory for analyzer reports. Subdirectories will be
created as needed to represent separate "runs" of the analyzer. If this
option is not specified, a directory is created in /tmp (TMPDIR on Mac OS X)
to store the reports.
-h
--help
Display this message.
-k
--keep-going
Add a "keep on going" option to the specified build command. This option
currently supports make and xcodebuild. This is a convenience option; one
can specify this behavior directly using build options.
--html-title [title]
--html-title=[title]
Specify the title used on generated HTML pages. If not specified, a default
title will be used.
--show-description
Display the description of defects in the list
-plist
By default the output of scan-build is a set of HTML files. This option
outputs the results as a set of .plist files.
-plist-html
By default the output of scan-build is a set of HTML files. This option
outputs the results as a set of HTML and .plist files.
--status-bugs
By default, the exit status of scan-build is the same as the executed build
command. Specifying this option causes the exit status of scan-build to be 1
if it found potential bugs and 0 otherwise.
--use-cc [compiler path]
--use-cc=[compiler path]
scan-build analyzes a project by interposing a "fake compiler", which
executes a real compiler for compilation and the static analyzer for analysis.
Because of the current implementation of interposition, scan-build does not
know what compiler your project normally uses. Instead, it simply overrides
the CC environment variable, and guesses your default compiler.
In the future, this interposition mechanism to be improved, but if you need
scan-build to use a specific compiler for *compilation* then you can use
this option to specify a path to that compiler.
If the given compiler is a cross compiler, you may also need to provide
--analyzer-target option to properly analyze the source code because static
analyzer runs as if the code is compiled for the host machine by default.
--use-c++ [compiler path]
--use-c++=[compiler path]
This is the same as "--use-cc" but for C++ code.
--analyzer-target [target triple name for analysis]
--analyzer-target=[target triple name for analysis]
This provides target triple information to clang static analyzer.
It only changes the target for analysis but doesn't change the target of a
real compiler given by --use-cc and --use-c++ options.
-v
Enable verbose output from scan-build. A second and third '-v' increases
verbosity.
-V
--view
View analysis results in a web browser when the build completes.
ADVANCED OPTIONS:
-no-failure-reports
Do not create a 'failures' subdirectory that includes analyzer crash reports
and preprocessed source files.
-stats
Generates visitation statistics for the project being analyzed.
-maxloop <loop count>
Specifiy the number of times a block can be visited before giving up.
Default is 4. Increase for more comprehensive coverage at a cost of speed.
-internal-stats
Generate internal analyzer statistics.
--use-analyzer [Xcode|path to clang]
--use-analyzer=[Xcode|path to clang]
scan-build uses the 'clang' executable relative to itself for static
analysis. One can override this behavior with this option by using the
'clang' packaged with Xcode (on OS X) or from the PATH.
--keep-empty
Don't remove the build results directory even if no issues were reported.
--override-compiler
Always resort to the ccc-analyzer even when better interposition methods
are available.
-analyzer-config <options>
Provide options to pass through to the analyzer's -analyzer-config flag.
Several options are separated with comma: 'key1=val1,key2=val2'
Available options:
* stable-report-filename=true or false (default)
Switch the page naming to:
report-<filename>-<function/method name>-<id>.html
instead of report-XXXXXX.html
CONTROLLING CHECKERS:
A default group of checkers are always run unless explicitly disabled.
Checkers may be enabled/disabled using the following options:
-enable-checker [checker name]
-disable-checker [checker name]
LOADING CHECKERS:
Loading external checkers using the clang plugin interface:
-load-plugin [plugin library]
ENDTEXT
if (defined $Clang && -x $Clang) {
# Query clang for list of checkers that are enabled.
# create a list to load the plugins via the 'Xclang' command line
# argument
my @PluginLoadCommandline_xclang;
foreach my $param ( @{$Options{PluginsToLoad}} ) {
push ( @PluginLoadCommandline_xclang, "-Xclang" );
push ( @PluginLoadCommandline_xclang, "-load" );
push ( @PluginLoadCommandline_xclang, "-Xclang" );
push ( @PluginLoadCommandline_xclang, $param );
}
my %EnabledCheckers;
foreach my $lang ("c", "objective-c", "objective-c++", "c++") {
my $ExecLine = join(' ', qq/"$Clang"/, @PluginLoadCommandline_xclang, "--analyze", "-x", $lang, "-", "-###", "2>&1", "|");
open(PS, $ExecLine);
while (<PS>) {
foreach my $val (split /\s+/) {
$val =~ s/\"//g;
if ($val =~ /-analyzer-checker\=([^\s]+)/) {
$EnabledCheckers{$1} = 1;
}
}
}
}
# Query clang for complete list of checkers.
my @PluginLoadCommandline;
foreach my $param ( @{$Options{PluginsToLoad}} ) {
push ( @PluginLoadCommandline, "-load" );
push ( @PluginLoadCommandline, $param );
}
my $ExecLine = join(' ', qq/"$Clang"/, "-cc1", @PluginLoadCommandline, "-analyzer-checker-help", "2>&1", "|");
open(PS, $ExecLine);
my $foundCheckers = 0;
while (<PS>) {
if (/CHECKERS:/) {
$foundCheckers = 1;
last;
}
}
if (!$foundCheckers) {
print " *** Could not query Clang for the list of available checkers.";
}
else {
print("\nAVAILABLE CHECKERS:\n\n");
my $skip = 0;
while(<PS>) {
if (/experimental/) {
$skip = 1;
next;
}
if ($skip) {
next if (!/^\s\s[^\s]/);
$skip = 0;
}
s/^\s\s//;
if (/^([^\s]+)/) {
# Is the checker enabled?
my $checker = $1;
my $enabled = 0;
my $aggregate = "";
foreach my $domain (split /\./, $checker) {
$aggregate .= $domain;
if ($EnabledCheckers{$aggregate}) {
$enabled =1;
last;
}
# append a dot, if an additional domain is added in the next iteration
$aggregate .= ".";
}
if ($enabled) {
print " + ";
}
else {
print " ";
}
}
else {
print " ";
}
print $_;
}
print "\nNOTE: \"+\" indicates that an analysis is enabled by default.\n";
}
close PS;
}
else {
print " *** Could not query Clang for the list of available checkers.\n";
if (defined $ArgClangNotFoundErrMsg) {
print " *** Reason: $ArgClangNotFoundErrMsg\n";
}
}
print <<ENDTEXT
BUILD OPTIONS
You can specify any build option acceptable to the build command.
EXAMPLE
scan-build -o /tmp/myhtmldir make -j4
The above example causes analysis reports to be deposited into a subdirectory
of "/tmp/myhtmldir" and to run "make" with the "-j4" option. A different
subdirectory is created each time scan-build analyzes a project. The analyzer
should support most parallel builds, but not distributed builds.
ENDTEXT
}
##----------------------------------------------------------------------------##
# HtmlEscape - HTML entity encode characters that are special in HTML
##----------------------------------------------------------------------------##
sub HtmlEscape {
# copy argument to new variable so we don't clobber the original
my $arg = shift || '';
my $tmp = $arg;
$tmp =~ s/&/&/g;
$tmp =~ s/</</g;
$tmp =~ s/>/>/g;
return $tmp;
}
##----------------------------------------------------------------------------##
# ShellEscape - backslash escape characters that are special to the shell
##----------------------------------------------------------------------------##
sub ShellEscape {
# copy argument to new variable so we don't clobber the original
my $arg = shift || '';
if ($arg =~ /["\s]/) { return "'" . $arg . "'"; }
return $arg;
}
##----------------------------------------------------------------------------##
# FindClang - searches for 'clang' executable.
##----------------------------------------------------------------------------##
sub FindClang {
if (!defined $Options{AnalyzerDiscoveryMethod}) {
$Clang = Cwd::realpath("$RealBin/bin/clang") if (-f "$RealBin/bin/clang");
if (!defined $Clang || ! -x $Clang) {
$Clang = Cwd::realpath("/usr/lib/llvm-4.0/bin/clang");
}
if (!defined $Clang || ! -x $Clang) {
return "error: Cannot find an executable 'clang' relative to" .
" scan-build. Consider using --use-analyzer to pick a version of" .
" 'clang' to use for static analysis.\n";
}
}
else {
if ($Options{AnalyzerDiscoveryMethod} =~ /^[Xx]code$/) {
my $xcrun = `which xcrun`;
chomp $xcrun;
if ($xcrun eq "") {
return "Cannot find 'xcrun' to find 'clang' for analysis.\n";
}
$Clang = `$xcrun -toolchain XcodeDefault -find clang`;
chomp $Clang;
if ($Clang eq "") {
return "No 'clang' executable found by 'xcrun'\n";
}
}
else {
$Clang = $Options{AnalyzerDiscoveryMethod};
if (!defined $Clang or not -x $Clang) {
return "Cannot find an executable clang at '$Options{AnalyzerDiscoveryMethod}'\n";
}
}
}
return undef;
}
##----------------------------------------------------------------------------##
# Process command-line arguments.
##----------------------------------------------------------------------------##
my $RequestDisplayHelp = 0;
my $ForceDisplayHelp = 0;
sub ProcessArgs {
my $Args = shift;
my $NumArgs = 0;
while (@$Args) {
$NumArgs++;
# Scan for options we recognize.
my $arg = $Args->[0];
if ($arg eq "-h" or $arg eq "--help") {
$RequestDisplayHelp = 1;
shift @$Args;
next;
}
if ($arg eq '-analyze-headers') {
shift @$Args;
$Options{AnalyzeHeaders} = 1;
next;
}
if ($arg eq "-o") {
shift @$Args;
if (!@$Args) {
DieDiag("'-o' option requires a target directory name.\n");
}
# Construct an absolute path. Uses the current working directory
# as a base if the original path was not absolute.
my $OutDir = shift @$Args;
mkpath($OutDir) unless (-e $OutDir); # abs_path wants existing dir
$Options{OutputDir} = abs_path($OutDir);
next;
}
if ($arg =~ /^--html-title(=(.+))?$/) {
shift @$Args;
if (!defined $2 || $2 eq '') {
if (!@$Args) {
DieDiag("'--html-title' option requires a string.\n");
}
$Options{HtmlTitle} = shift @$Args;
} else {
$Options{HtmlTitle} = $2;
}
next;
}
if ($arg eq "-k" or $arg eq "--keep-going") {
shift @$Args;
$Options{IgnoreErrors} = 1;
next;
}
if ($arg =~ /^--use-cc(=(.+))?$/) {
shift @$Args;
my $cc;
if (!defined $2 || $2 eq "") {
if (!@$Args) {
DieDiag("'--use-cc' option requires a compiler executable name.\n");
}
$cc = shift @$Args;
}
else {
$cc = $2;
}
$Options{UseCC} = $cc;
next;
}
if ($arg =~ /^--use-c\+\+(=(.+))?$/) {
shift @$Args;
my $cxx;
if (!defined $2 || $2 eq "") {
if (!@$Args) {
DieDiag("'--use-c++' option requires a compiler executable name.\n");
}
$cxx = shift @$Args;
}
else {
$cxx = $2;
}
$Options{UseCXX} = $cxx;
next;
}
if ($arg =~ /^--analyzer-target(=(.+))?$/) {
shift @ARGV;
my $AnalyzerTarget;
if (!defined $2 || $2 eq "") {
if (!@ARGV) {
DieDiag("'--analyzer-target' option requires a target triple name.\n");
}
$AnalyzerTarget = shift @ARGV;
}
else {
$AnalyzerTarget = $2;
}
$Options{AnalyzerTarget} = $AnalyzerTarget;
next;
}
if ($arg eq "-v") {
shift @$Args;
$Options{Verbose}++;
next;
}
if ($arg eq "-V" or $arg eq "--view") {
shift @$Args;
$Options{ViewResults} = 1;
next;
}
if ($arg eq "--status-bugs") {
shift @$Args;
$Options{ExitStatusFoundBugs} = 1;
next;
}
if ($arg eq "--show-description") {
shift @$Args;
$Options{ShowDescription} = 1;
next;
}
if ($arg eq "-store") {
shift @$Args;
$Options{StoreModel} = shift @$Args;
next;
}
if ($arg eq "-constraints") {
shift @$Args;
$Options{ConstraintsModel} = shift @$Args;
next;
}
if ($arg eq "-internal-stats") {
shift @$Args;
$Options{InternalStats} = 1;
next;
}
if ($arg eq "-plist") {
shift @$Args;
$Options{OutputFormat} = "plist";
next;
}
if ($arg eq "-plist-html") {
shift @$Args;
$Options{OutputFormat} = "plist-html";
next;
}
if ($arg eq "-analyzer-config") {
shift @$Args;
push @{$Options{ConfigOptions}}, shift @$Args;
next;
}
if ($arg eq "-no-failure-reports") {
shift @$Args;
$Options{ReportFailures} = 0;
next;
}
if ($arg eq "-stats") {
shift @$Args;
$Options{AnalyzerStats} = 1;
next;
}
if ($arg eq "-maxloop") {
shift @$Args;
$Options{MaxLoop} = shift @$Args;
next;
}
if ($arg eq "-enable-checker") {
shift @$Args;
my $Checker = shift @$Args;
# Store $NumArgs to preserve the order the checkers were enabled.
$Options{EnableCheckers}{$Checker} = $NumArgs;
delete $Options{DisableCheckers}{$Checker};
next;
}
if ($arg eq "-disable-checker") {
shift @$Args;
my $Checker = shift @$Args;
# Store $NumArgs to preserve the order the checkers were disabled.
$Options{DisableCheckers}{$Checker} = $NumArgs;
delete $Options{EnableCheckers}{$Checker};
next;
}
if ($arg eq "-load-plugin") {
shift @$Args;
push @{$Options{PluginsToLoad}}, shift @$Args;
next;
}
if ($arg eq "--use-analyzer") {
shift @$Args;
$Options{AnalyzerDiscoveryMethod} = shift @$Args;
next;
}
if ($arg =~ /^--use-analyzer=(.+)$/) {
shift @$Args;
$Options{AnalyzerDiscoveryMethod} = $1;
next;
}
if ($arg eq "--keep-empty") {
shift @$Args;
$Options{KeepEmpty} = 1;
next;
}
if ($arg eq "--override-compiler") {
shift @$Args;
$Options{OverrideCompiler} = 1;
next;
}
if ($arg eq "--force-analyze-debug-code") {
shift @$Args;
$Options{ForceAnalyzeDebugCode} = 1;
next;
}
DieDiag("unrecognized option '$arg'\n") if ($arg =~ /^-/);
$NumArgs--;
last;
}
return $NumArgs;
}
if (!@ARGV) {
$ForceDisplayHelp = 1
}
ProcessArgs(\@ARGV);
# All arguments are now shifted from @ARGV. The rest is a build command, if any.
if (!@ARGV and !$RequestDisplayHelp) {
ErrorDiag("No build command specified.\n\n");
$ForceDisplayHelp = 1;
}
my $ClangNotFoundErrMsg = FindClang();
if ($ForceDisplayHelp || $RequestDisplayHelp) {
DisplayHelp($ClangNotFoundErrMsg);
exit $ForceDisplayHelp;
}
DieDiag($ClangNotFoundErrMsg) if (defined $ClangNotFoundErrMsg);
$ClangCXX = $Clang;
if ($Clang !~ /\+\+(\.exe)?$/) {
# If $Clang holds the name of the clang++ executable then we leave
# $ClangCXX and $Clang equal, otherwise construct the name of the clang++
# executable from the clang executable name.
# Determine operating system under which this copy of Perl was built.
my $IsWinBuild = ($^O =~/msys|cygwin|MSWin32/);
if($IsWinBuild) {
$ClangCXX =~ s/.exe$/++.exe/;
}
else {
$ClangCXX =~ s/\-\d+\.\d+$//;
$ClangCXX .= "++";
}
}
# Make sure to use "" to handle paths with spaces.
$ClangVersion = HtmlEscape(`"$Clang" --version`);
# Determine where results go.
$CmdArgs = HtmlEscape(join(' ', map(ShellEscape($_), @ARGV)));
# Determine the output directory for the HTML reports.
my $BaseDir = $Options{OutputDir};
$Options{OutputDir} = GetHTMLRunDir($Options{OutputDir});
# Determine the location of ccc-analyzer.
my $AbsRealBin = Cwd::realpath($RealBin);
my $Cmd = "$AbsRealBin/../libexec/ccc-analyzer";
my $CmdCXX = "$AbsRealBin/../libexec/c++-analyzer";
# Portability: use less strict but portable check -e (file exists) instead of
# non-portable -x (file is executable). On some windows ports -x just checks
# file extension to determine if a file is executable (see Perl language
# reference, perlport)
if (!defined $Cmd || ! -e $Cmd) {
$Cmd = "$AbsRealBin/ccc-analyzer";
DieDiag("'ccc-analyzer' does not exist at '$Cmd'\n") if(! -e $Cmd);
}
if (!defined $CmdCXX || ! -e $CmdCXX) {
$CmdCXX = "$AbsRealBin/c++-analyzer";
DieDiag("'c++-analyzer' does not exist at '$CmdCXX'\n") if(! -e $CmdCXX);
}
Diag("Using '$Clang' for static analysis\n");
SetHtmlEnv(\@ARGV, $Options{OutputDir});
my @AnalysesToRun;
foreach (sort { $Options{EnableCheckers}{$a} <=> $Options{EnableCheckers}{$b} }
keys %{$Options{EnableCheckers}}) {
# Push checkers in order they were enabled.
push @AnalysesToRun, "-analyzer-checker", $_;
}
foreach (sort { $Options{DisableCheckers}{$a} <=> $Options{DisableCheckers}{$b} }
keys %{$Options{DisableCheckers}}) {
# Push checkers in order they were disabled.
push @AnalysesToRun, "-analyzer-disable-checker", $_;
}
if ($Options{AnalyzeHeaders}) { push @AnalysesToRun, "-analyzer-opt-analyze-headers"; }
if ($Options{AnalyzerStats}) { push @AnalysesToRun, '-analyzer-checker=debug.Stats'; }
if ($Options{MaxLoop} > 0) { push @AnalysesToRun, "-analyzer-max-loop $Options{MaxLoop}"; }
# Delay setting up other environment variables in case we can do true
# interposition.
my $CCC_ANALYZER_ANALYSIS = join ' ', @AnalysesToRun;
my $CCC_ANALYZER_PLUGINS = join ' ', map { "-load ".$_ } @{$Options{PluginsToLoad}};
my $CCC_ANALYZER_CONFIG = join ' ', map { "-analyzer-config ".$_ } @{$Options{ConfigOptions}};
my %EnvVars = (
'CC' => $Cmd,
'CXX' => $CmdCXX,
'CLANG' => $Clang,
'CLANG_CXX' => $ClangCXX,
'VERBOSE' => $Options{Verbose},
'CCC_ANALYZER_ANALYSIS' => $CCC_ANALYZER_ANALYSIS,
'CCC_ANALYZER_PLUGINS' => $CCC_ANALYZER_PLUGINS,
'CCC_ANALYZER_CONFIG' => $CCC_ANALYZER_CONFIG,
'OUTPUT_DIR' => $Options{OutputDir},
'CCC_CC' => $Options{UseCC},
'CCC_CXX' => $Options{UseCXX},
'CCC_REPORT_FAILURES' => $Options{ReportFailures},
'CCC_ANALYZER_STORE_MODEL' => $Options{StoreModel},
'CCC_ANALYZER_CONSTRAINTS_MODEL' => $Options{ConstraintsModel},
'CCC_ANALYZER_INTERNAL_STATS' => $Options{InternalStats},
'CCC_ANALYZER_OUTPUT_FORMAT' => $Options{OutputFormat},
'CLANG_ANALYZER_TARGET' => $Options{AnalyzerTarget},
'CCC_ANALYZER_FORCE_ANALYZE_DEBUG_CODE' => $Options{ForceAnalyzeDebugCode}
);
# Run the build.
my $ExitStatus = RunBuildCommand(\@ARGV, $Options{IgnoreErrors}, $Cmd, $CmdCXX,
\%EnvVars);
if (defined $Options{OutputFormat}) {
if ($Options{OutputFormat} =~ /plist/) {
Diag "Analysis run complete.\n";
Diag "Analysis results (plist files) deposited in '$Options{OutputDir}'\n";
}
if ($Options{OutputFormat} =~ /html/) {
# Postprocess the HTML directory.
my $NumBugs = Postprocess($Options{OutputDir}, $BaseDir,
$Options{AnalyzerStats}, $Options{KeepEmpty});
if ($Options{ViewResults} and -r "$Options{OutputDir}/index.html") {
Diag "Analysis run complete.\n";
Diag "Viewing analysis results in '$Options{OutputDir}' using scan-view.\n";
my $ScanView = Cwd::realpath("$RealBin/scan-view");
if (! -x $ScanView) { $ScanView = "scan-view"; }
if (! -x $ScanView) { $ScanView = Cwd::realpath("$RealBin/../../scan-view/bin/scan-view"); }
exec $ScanView, "$Options{OutputDir}";
}
if ($Options{ExitStatusFoundBugs}) {
exit 1 if ($NumBugs > 0);
exit 0;
}
}
}
exit $ExitStatus;
|