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 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112
|
//===--------------- IncrementalCompilationTests.swift - Swift Testing ----===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2019 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
import XCTest
import TSCBasic
import Foundation
@_spi(Testing) import SwiftDriver
import SwiftOptions
import TestUtilities
// MARK: - Instance variables and initialization
final class IncrementalCompilationTests: XCTestCase {
var tempDir: AbsolutePath = try! AbsolutePath(validating: "/tmp")
var derivedDataDir: AbsolutePath {
tempDir.appending(component: "derivedData")
}
let module = "theModule"
var OFM: AbsolutePath {
tempDir.appending(component: "OFM.json")
}
let baseNamesAndContents = [
"main": "let foo = 1",
"other": "let bar = foo"
]
func inputPath(basename: String) -> AbsolutePath {
tempDir.appending(component: basename + ".swift")
}
var inputPathsAndContents: [(AbsolutePath, String)] {
baseNamesAndContents.map {
(inputPath(basename: $0.key), $0.value)
}
}
var derivedDataPath: AbsolutePath {
tempDir.appending(component: "derivedData")
}
var masterSwiftDepsPath: AbsolutePath {
derivedDataPath.appending(component: "\(module)-master.swiftdeps")
}
var priorsPath: AbsolutePath {
derivedDataPath.appending(component: "\(module)-master.priors")
}
func swiftDepsPath(basename: String) -> AbsolutePath {
derivedDataPath.appending(component: "\(basename).swiftdeps")
}
fileprivate var autolinkIncrementalExpectedDiags: [Diagnostic.Message] {
queuingExtractingAutolink(module)
}
fileprivate var autolinkLifecycleExpectedDiags: [Diagnostic.Message] {
extractingAutolink(module)
}
var commonArgs: [String] {
[
"swiftc",
"-module-name", module,
"-o", derivedDataPath.appending(component: module + ".o").nativePathString(escaped: true),
"-output-file-map", OFM.nativePathString(escaped: true),
"-driver-show-incremental",
"-driver-show-job-lifecycle",
"-enable-batch-mode",
// "-v",
"-save-temps",
"-incremental",
"-no-color-diagnostics",
]
+ inputPathsAndContents.map {$0.0.nativePathString(escaped: true)} .sorted()
}
var explicitModuleCacheDir: AbsolutePath {
tempDir.appending(component: "ModuleCache")
}
var explicitDependencyTestInputsPath: AbsolutePath {
tempDir.appending(component: "ExplicitTestInputs")
}
var explicitCDependenciesPath: AbsolutePath {
explicitDependencyTestInputsPath.appending(component: "CHeaders")
}
var explicitSwiftDependenciesPath: AbsolutePath {
explicitDependencyTestInputsPath.appending(component: "Swift")
}
var explicitDependencyTestInputsSourcePath: AbsolutePath {
var root: AbsolutePath = try! AbsolutePath(validating: #file)
while root.basename != "Tests" {
root = root.parentDirectory
}
return root.parentDirectory.appending(component: "TestInputs")
}
var explicitBuildArgs: [String] {
["-explicit-module-build",
"-module-cache-path", explicitModuleCacheDir.nativePathString(escaped: true),
// Disable implicit imports to keep tests simpler
"-Xfrontend", "-disable-implicit-concurrency-module-import",
"-Xfrontend", "-disable-implicit-string-processing-module-import",
"-I", explicitCDependenciesPath.nativePathString(escaped: true),
"-I", explicitSwiftDependenciesPath.nativePathString(escaped: true)] + extraExplicitBuildArgs
}
var extraExplicitBuildArgs: [String] = []
override func setUp() {
self.tempDir = try! withTemporaryDirectory(removeTreeOnDeinit: false) {$0}
try! localFileSystem.createDirectory(explicitModuleCacheDir)
try! localFileSystem.createDirectory(derivedDataPath)
try! localFileSystem.createDirectory(explicitDependencyTestInputsPath)
try! localFileSystem.createDirectory(explicitCDependenciesPath)
try! localFileSystem.createDirectory(explicitSwiftDependenciesPath)
OutputFileMapCreator.write(module: module,
inputPaths: inputPathsAndContents.map {$0.0},
derivedData: derivedDataPath,
to: OFM)
for (base, contents) in baseNamesAndContents {
write(contents, to: base)
}
// Set up a per-test copy of all the explicit build module input artifacts
do {
let ebmSwiftInputsSourcePath = explicitDependencyTestInputsSourcePath
.appending(component: "ExplicitModuleBuilds").appending(component: "Swift")
let ebmCInputsSourcePath = explicitDependencyTestInputsSourcePath
.appending(component: "ExplicitModuleBuilds").appending(component: "CHeaders")
stdoutStream.flush()
try! localFileSystem.getDirectoryContents(ebmSwiftInputsSourcePath).forEach { filePath in
let sourceFilePath = ebmSwiftInputsSourcePath.appending(component: filePath)
let destinationFilePath = explicitSwiftDependenciesPath.appending(component: filePath)
try! localFileSystem.copy(from: sourceFilePath, to: destinationFilePath)
}
try! localFileSystem.getDirectoryContents(ebmCInputsSourcePath).forEach { filePath in
let sourceFilePath = ebmCInputsSourcePath.appending(component: filePath)
let destinationFilePath = explicitCDependenciesPath.appending(component: filePath)
try! localFileSystem.copy(from: sourceFilePath, to: destinationFilePath)
}
}
let driver = try! Driver(args: ["swiftc", "-v"])
if driver.isFrontendArgSupported(.moduleLoadMode) {
self.extraExplicitBuildArgs = ["-Xfrontend", "-module-load-mode", "-Xfrontend", "prefer-interface"]
}
}
deinit {
try? localFileSystem.removeFileTree(tempDir)
}
}
// MARK: - Misc. tests
extension IncrementalCompilationTests {
func testOptionsParsing() throws {
let optionPairs: [(
Option, (IncrementalCompilationState.IncrementalDependencyAndInputSetup) -> Bool
)] = [
(.driverAlwaysRebuildDependents, {$0.alwaysRebuildDependents}),
(.driverShowIncremental, {$0.reporter != nil}),
(.driverEmitFineGrainedDependencyDotFileAfterEveryImport, {$0.emitDependencyDotFileAfterEveryImport}),
(.driverVerifyFineGrainedDependencyGraphAfterEveryImport, {$0.verifyDependencyGraphAfterEveryImport}),
(.enableIncrementalImports, {$0.isCrossModuleIncrementalBuildEnabled}),
(.disableIncrementalImports, {!$0.isCrossModuleIncrementalBuildEnabled}),
]
for (driverOption, stateOptionFn) in optionPairs {
try doABuild(
"initial",
checkDiagnostics: false,
extraArguments: [ driverOption.spelling ],
whenAutolinking: []
) {}
guard let sdkArgumentsForTesting = try Driver.sdkArgumentsForTesting()
else {
throw XCTSkip("Cannot perform this test on this host")
}
var driver = try Driver(args: self.commonArgs + [
driverOption.spelling,
] + sdkArgumentsForTesting)
_ = try driver.planBuild()
XCTAssertFalse(driver.diagnosticEngine.hasErrors)
let state = try XCTUnwrap(driver.incrementalCompilationState)
XCTAssertTrue(stateOptionFn(state.info))
}
}
/// Ensure that autolink output file goes with .o directory, to not prevent incremental omission of
/// autolink job.
/// Much of the code below is taking from testLinking(), but uses the output file map code here.
func testAutolinkOutputPath() throws {
var env = ProcessEnv.vars
env["SWIFT_DRIVER_TESTS_ENABLE_EXEC_PATH_FALLBACK"] = "1"
env["SWIFT_DRIVER_SWIFT_AUTOLINK_EXTRACT_EXEC"] = "/garbage/swift-autolink-extract"
env["SWIFT_DRIVER_DSYMUTIL_EXEC"] = "/garbage/dsymutil"
var driver = try Driver(
args: commonArgs
+ ["-emit-library", "-target", "x86_64-unknown-linux"],
env: env)
let plannedJobs = try driver.planBuild()
let autolinkExtractJob = try XCTUnwrap(
plannedJobs
.filter { $0.kind == .autolinkExtract }
.first)
let autoOuts = autolinkExtractJob.outputs.filter {$0.type == .autolink}
XCTAssertEqual(autoOuts.count, 1)
let autoOut = autoOuts[0]
let expected = try AbsolutePath(validating: "\(module).autolink", relativeTo: derivedDataPath)
XCTAssertEqual(autoOut.file.absolutePath, expected)
}
}
// MARK: - Dot file tests
extension IncrementalCompilationTests {
func testDependencyDotFiles() throws {
expectNoDotFiles()
try buildInitialState(extraArguments: ["-driver-emit-fine-grained-dependency-dot-file-after-every-import"])
expect(dotFilesFor: [
"main.swift",
DependencyGraphDotFileWriter.moduleDependencyGraphBasename,
"other.swift",
DependencyGraphDotFileWriter.moduleDependencyGraphBasename,
])
}
func testDependencyDotFilesCross() throws {
expectNoDotFiles()
try buildInitialState(extraArguments: [
"-driver-emit-fine-grained-dependency-dot-file-after-every-import",
])
removeDotFiles()
try checkNoPropagation(extraArguments: [
"-driver-emit-fine-grained-dependency-dot-file-after-every-import",
])
expect(dotFilesFor: [
DependencyGraphDotFileWriter.moduleDependencyGraphBasename,
"other.swift",
DependencyGraphDotFileWriter.moduleDependencyGraphBasename,
])
}
func expectNoDotFiles() {
guard localFileSystem.exists(derivedDataDir) else { return }
try! localFileSystem.getDirectoryContents(derivedDataDir)
.forEach {derivedFile in
XCTAssertFalse(derivedFile.hasSuffix("dot"))
}
}
func removeDotFiles() {
try! localFileSystem.getDirectoryContents(derivedDataDir)
.filter {$0.hasSuffix(".dot")}
.map {derivedDataDir.appending(component: $0)}
.forEach {try! localFileSystem.removeFileTree($0)}
}
private func expect(dotFilesFor importedFiles: [String]) {
let expectedDotFiles = Set(
importedFiles.enumerated()
.map { offset, element in "\(element).\(offset).dot" })
let actualDotFiles = Set(
try! localFileSystem.getDirectoryContents(derivedDataDir)
.filter {$0.hasSuffix(".dot")})
let missingDotFiles = expectedDotFiles.subtracting(actualDotFiles)
.sortedByDotFileSequenceNumbers()
let extraDotFiles = actualDotFiles.subtracting(expectedDotFiles)
.sortedByDotFileSequenceNumbers()
XCTAssertEqual(missingDotFiles, [])
XCTAssertEqual(extraDotFiles, [])
}
}
// MARK: - Post-compile jobs
extension IncrementalCompilationTests {
/// Ensure that if an output of post-compile job is missing, the job gets rerun.
func testIncrementalPostCompileJob() throws {
#if !os(Linux)
let driver = try XCTUnwrap(buildInitialState(checkDiagnostics: true))
for postCompileOutput in try driver.postCompileOutputs() {
let absPostCompileOutput = try XCTUnwrap(postCompileOutput.file.absolutePath)
try localFileSystem.removeFileTree(absPostCompileOutput)
XCTAssertFalse(localFileSystem.exists(absPostCompileOutput))
try checkNullBuild()
XCTAssertTrue(localFileSystem.exists(absPostCompileOutput))
}
#endif
}
}
fileprivate extension Driver {
func postCompileOutputs() throws -> [TypedVirtualPath] {
try XCTUnwrap(incrementalCompilationState).jobsAfterCompiles.flatMap {$0.outputs}
}
}
// MARK: - Explicit Module Build incremental tests
extension IncrementalCompilationTests {
func testExplicitIncrementalSimpleBuild() throws {
try buildInitialState(explicitModuleBuild: true)
try checkNullBuild(explicitModuleBuild: true)
}
// Simple re-use of a prior inter-module dependency graph on a null build
func testExplicitIncrementalSimpleBuildCheckDiagnostics() throws {
try buildInitialState(checkDiagnostics: true, explicitModuleBuild: true)
try checkNullBuild(checkDiagnostics: true, explicitModuleBuild: true)
}
// Source files have changed but the inter-module dependency graph still up-to-date
func testExplicitIncrementalBuildCheckGraphReuseOnChange() throws {
try buildInitialState(checkDiagnostics: true, explicitModuleBuild: true)
try checkReactionToTouchingAll(checkDiagnostics: true, explicitModuleBuild: true)
}
// Adding an import invalidates prior inter-module dependency graph.
func testExplicitIncrementalBuildNewImport() throws {
try buildInitialState(checkDiagnostics: true, explicitModuleBuild: true)
// Introduce a new import. This will cause a re-scan and a re-build of 'other.swift'
replace(contentsOf: "other", with: "import E;let bar = foo")
try doABuild(
"add import to 'other'",
checkDiagnostics: true,
extraArguments: explicitBuildArgs,
whenAutolinking: autolinkLifecycleExpectedDiags
) {
readGraph
enablingCrossModule
readInterModuleGraph
// Ensure a re-scan was performed
explicitMustReScanDueToChangedImports
maySkip("main")
schedulingChangedInitialQueuing("other")
skipping("main")
findingBatchingCompiling("other")
reading(deps: "other")
fingerprintsChanged("other")
fingerprintsMissingOfTopLevelName(name: "bar", "other")
moduleOutputNotFound("E")
moduleWillBeRebuiltOutOfDate("E")
explicitModulesWillBeRebuilt(["E"])
compilingExplicitSwiftDependency("E")
skipped("main")
schedLinking
}
}
// A dependency has changed one of its inputs
func testExplicitIncrementalBuildChangedDependency() throws {
// Add an import of 'E' to make sure followup changes has consistent inputs
replace(contentsOf: "other", with: "import E;let bar = foo")
try buildInitialState(checkDiagnostics: false, explicitModuleBuild: true)
// Just update the time-stamp of one of the module dependencies and use a value
// it is defined in.
touch(try AbsolutePath(validating: explicitSwiftDependenciesPath.appending(component: "E.swiftinterface").pathString))
replace(contentsOf: "other", with: "import E;let bar = foo + moduleEValue")
// Changing a dependency will mean that we both re-run the dependency scan,
// and also ensure that all source-files are re-built with a non-cascading build
// since the source files themselves have not changed.
try doABuild(
"update dependency (E) interface timestamp",
checkDiagnostics: true,
extraArguments: explicitBuildArgs,
whenAutolinking: autolinkLifecycleExpectedDiags
) {
readGraph
enablingCrossModule
readInterModuleGraph
// Ensure the above 'touch' is detected and causes a re-scan
explicitDependencyModuleOlderThanInput("E")
moduleInfoStaleOutOfDate("E")
explicitMustReScanDueToChangedDependencyInput
noFingerprintInSwiftModule("E.swiftinterface")
dependencyNewerThanNode("E.swiftinterface")
dependencyNewerThanNode("E.swiftinterface") // FIXME: Why do we see this twice?
maySkip("main")
schedulingChanged("other")
invalidatedExternally("main", "other")
queuingInitial("main", "other")
notSchedulingDependentsUnknownChanges("other")
findingBatchingCompiling("main", "other")
explicitDependencyModuleOlderThanInput("E")
moduleWillBeRebuiltOutOfDate("E")
explicitModulesWillBeRebuilt(["E"])
compilingExplicitSwiftDependency("E")
}
}
// A dependency has changed one of its inputs, ensure
// other modules that depend on it are invalidated also.
//
// test
// / \
// Y T
// / \ / \
// H R J
// \ \
// \-------G
//
// On this graph, inputs of 'G' are updated, causing it to be re-built
// as well as all modules on paths from root to it: 'Y', 'H', 'T','J'
func testExplicitIncrementalBuildChangedDependencyInvalidatesUpstreamDependencies() throws {
replace(contentsOf: "other", with: "import Y;import T")
try buildInitialState(checkDiagnostics: false, explicitModuleBuild: true)
// Just update the time-stamp of one of the module dependencies
touch(try AbsolutePath(validating: explicitSwiftDependenciesPath.appending(component: "G.swiftinterface").pathString))
// Changing a dependency will mean that we both re-run the dependency scan,
// and also ensure that all source-files are re-built with a non-cascading build
// since the source files themselves have not changed.
try doABuild(
"update dependency (G) interface timestamp",
checkDiagnostics: true,
extraArguments: explicitBuildArgs,
whenAutolinking: autolinkLifecycleExpectedDiags
) {
readGraph
enablingCrossModule
readInterModuleGraph
// Ensure the above 'touch' is detected and causes a re-scan
explicitDependencyModuleOlderThanInput("G")
moduleInfoStaleOutOfDate("G")
moduleInfoStaleInvalidatedDownstream("J")
moduleInfoStaleInvalidatedDownstream("T")
moduleInfoStaleInvalidatedDownstream("Y")
moduleInfoStaleInvalidatedDownstream("H")
explicitMustReScanDueToChangedDependencyInput
noFingerprintInSwiftModule("G.swiftinterface")
dependencyNewerThanNode("G.swiftinterface")
dependencyNewerThanNode("G.swiftinterface") // FIXME: Why do we see this twice?
reading(deps: "main")
reading(deps: "other")
fingerprintsMissingOfTopLevelName(name: "foo", "main")
maySkip("main")
maySkip("other")
invalidatedExternally("main", "other")
queuingInitial("main", "other")
findingBatchingCompiling("main", "other")
explicitDependencyModuleOlderThanInput("G")
moduleWillBeRebuiltInvalidatedDownstream("J")
moduleWillBeRebuiltInvalidatedDownstream("T")
moduleWillBeRebuiltInvalidatedDownstream("Y")
moduleWillBeRebuiltInvalidatedDownstream("H")
explicitModulesWillBeRebuilt(["G", "H", "J", "T", "Y"])
moduleWillBeRebuiltOutOfDate("G")
compilingExplicitSwiftDependency("G")
compilingExplicitSwiftDependency("J")
compilingExplicitSwiftDependency("T")
compilingExplicitSwiftDependency("Y")
compilingExplicitSwiftDependency("H")
schedulingPostCompileJobs
linking
}
}
// A dependency has been re-built to be newer than its dependents
// so we must ensure the dependents get re-built even though all the
// modules are up-to-date with respect to their textual source inputs.
//
// test
// \
// J
// \
// G
//
// On this graph, after the initial build, if G module binary file is newer
// than that of J, even if each of the modules is up-to-date w.r.t. their source inputs
// we still expect that J gets re-built
func testExplicitIncrementalBuildChangedDependencyBinaryInvalidatesUpstreamDependencies() throws {
replace(contentsOf: "other", with: "import J;")
try buildInitialState(checkDiagnostics: false, explicitModuleBuild: true)
let modCacheEntries = try localFileSystem.getDirectoryContents(explicitModuleCacheDir)
let nameOfGModule = try XCTUnwrap(modCacheEntries.first { $0.hasPrefix("G") && $0.hasSuffix(".swiftmodule")})
let pathToGModule = explicitModuleCacheDir.appending(component: nameOfGModule)
// Just update the time-stamp of one of the module dependencies' outputs.
touch(pathToGModule)
// Touch one of the inputs to actually trigger the incremental build
touch(inputPath(basename: "other"))
// Changing a dependency will mean that we both re-run the dependency scan,
// and also ensure that all source-files are re-built with a non-cascading build
// since the source files themselves have not changed.
try doABuild(
"update dependency (G) result timestamp",
checkDiagnostics: true,
extraArguments: explicitBuildArgs,
whenAutolinking: autolinkLifecycleExpectedDiags
) {
readGraph
enablingCrossModule
readInterModuleGraph
explicitDependencyModuleOlderThanInput("J")
moduleInfoStaleOutOfDate("J")
explicitMustReScanDueToChangedDependencyInput
maySkip("main")
schedulingChangedInitialQueuing("other")
skipping("main")
explicitDependencyModuleOlderThanInput("J")
moduleWillBeRebuiltOutOfDate("J")
explicitModulesWillBeRebuilt(["J"])
compilingExplicitSwiftDependency("J")
findingBatchingCompiling("other")
reading(deps: "other")
skipped("main")
schedulingPostCompileJobs
linking
}
}
}
extension IncrementalCompilationTests {
// A dependency has changed one of its inputs
func testIncrementalImplicitBuildChangedDependency() throws {
let extraAruments = ["-I", explicitCDependenciesPath.nativePathString(escaped: true),
"-I", explicitSwiftDependenciesPath.nativePathString(escaped: true)]
replace(contentsOf: "other", with: "import E;let bar = foo")
try buildInitialState(checkDiagnostics: false, extraArguments: extraAruments)
touch(try AbsolutePath(validating: explicitSwiftDependenciesPath.appending(component: "E.swiftinterface").pathString))
replace(contentsOf: "other", with: "import E;let bar = foo + moduleEValue")
// Changing a dependency will mean that we both re-run the dependency scan,
// and also ensure that all source-files are re-built with a non-cascading build
// since the source files themselves have not changed.
try doABuild(
"update dependency (E) interface timestamp",
checkDiagnostics: false,
extraArguments: extraAruments,
whenAutolinking: autolinkLifecycleExpectedDiags
) {
readGraph
enablingCrossModule
schedulingNoncascading("main", "other")
missing("main")
missing("other")
queuingInitial("main", "other")
notSchedulingDependentsDoNotNeedCascading("main", "other")
findingBatchingCompiling("main", "other")
}
}
}
// MARK: - Simpler incremental tests
extension IncrementalCompilationTests {
// FIXME: why does it fail on Linux in CI?
func testIncrementalDiagnostics() throws {
#if !os(Linux)
try testIncremental(checkDiagnostics: true)
#endif
}
func testIncremental() throws {
try testIncremental(checkDiagnostics: false)
}
func testIncremental(checkDiagnostics: Bool) throws {
try buildInitialState(checkDiagnostics: checkDiagnostics)
#if true // sometimes want to skip for debugging
try checkNullBuild(checkDiagnostics: checkDiagnostics)
try checkNoPropagation(checkDiagnostics: checkDiagnostics)
try checkReactionToTouchingAll(checkDiagnostics: checkDiagnostics)
#endif
try checkPropagationOfTopLevelChange(checkDiagnostics: checkDiagnostics)
}
func testFileMapMissingMainEntry() throws {
try buildInitialState(checkDiagnostics: true)
OutputFileMapCreator.write(
module: module, inputPaths: inputPathsAndContents.map {$0.0},
derivedData: derivedDataPath, to: OFM, excludeMainEntry: true)
try doABuild("output file map missing main entry", checkDiagnostics: true, extraArguments: [], whenAutolinking: []) {
missingMainDependencyEntry
disablingIncremental
foundBatchableJobs(2)
formingOneBatch
addingToBatchThenForming("main", "other")
compiling("main", "other")
startingLinking
finishedLinking
}
}
func testFileMapMissingMainEntryWMO() throws {
try buildInitialState(checkDiagnostics: true)
guard let sdkArgumentsForTesting = try Driver.sdkArgumentsForTesting()
else {
throw XCTSkip("Cannot perform this test on this host")
}
OutputFileMapCreator.write(
module: module, inputPaths: inputPathsAndContents.map {$0.0},
derivedData: derivedDataPath, to: OFM, excludeMainEntry: true)
let args = [
"swiftc",
"-module-name", module,
"-o", derivedDataPath.appending(component: module + ".o").pathString,
"-output-file-map", OFM.pathString,
"-incremental",
"-whole-module-optimization",
"-no-color-diagnostics",
] + inputPathsAndContents.map {$0.0.pathString}.sorted() + sdkArgumentsForTesting
_ = try doABuild(whenAutolinking: [], expecting: disabledForWMO, arguments: args)
}
// FIXME: Expect failure in Linux in CI just as testIncrementalDiagnostics
func testAlwaysRebuildDependents() throws {
#if !os(Linux)
try buildInitialState(checkDiagnostics: true)
try checkAlwaysRebuildDependents(checkDiagnostics: true)
#endif
}
/// Ensure that the mod date of the input comes back exactly the same via the build-record.
/// Otherwise the up-to-date calculation in `IncrementalCompilationState` will fail.
func testBuildRecordDateAccuracy() throws {
try buildInitialState()
try (1...10).forEach { n in
try checkNullBuild(checkDiagnostics: true)
}
}
func testNullBuildNoEmitModule() throws {
let extraArguments = ["-experimental-emit-module-separately", "-emit-module"]
try buildInitialState(extraArguments: extraArguments)
let driver = try checkNullBuild(extraArguments: extraArguments)
let mandatoryJobs = try XCTUnwrap(driver.incrementalCompilationState?.mandatoryJobsInOrder)
XCTAssertTrue(mandatoryJobs.isEmpty)
}
func testNullBuildNoVerify() throws {
let extraArguments = ["-experimental-emit-module-separately", "-emit-module", "-emit-module-interface", "-enable-library-evolution", "-verify-emitted-module-interface"]
try buildInitialState(extraArguments: extraArguments)
let driver = try checkNullBuild(extraArguments: extraArguments)
let mandatoryJobs = try XCTUnwrap(driver.incrementalCompilationState?.mandatoryJobsInOrder)
XCTAssertTrue(mandatoryJobs.isEmpty)
}
func testSymlinkModification() throws {
// Remap
// main.swift -> links/main.swift
// other.swift -> links/other.swift
for (file, _) in self.inputPathsAndContents {
try localFileSystem.createDirectory(tempDir.appending(component: "links"))
let linkTarget = tempDir.appending(component: "links").appending(component: file.basename)
try localFileSystem.move(from: file, to: linkTarget)
try localFileSystem.removeFileTree(file)
try localFileSystem.createSymbolicLink(file, pointingAt: linkTarget, relative: false)
}
try buildInitialState()
try checkReactionToTouchingSymlinks(checkDiagnostics: true)
try checkReactionToTouchingSymlinkTargets(checkDiagnostics: true)
}
/// Ensure that the driver can detect and then recover from a priors version mismatch
func testPriorsVersionDetectionAndRecovery() throws {
#if _runtime(_ObjC)
// create a baseline priors
try buildInitialState(checkDiagnostics: true)
let driver = try checkNullBuild(checkDiagnostics: true)
// Read the priors, change the minor version, and write it back out
let outputFileMap = try XCTUnwrap(driver.incrementalCompilationState).info.outputFileMap
let info = IncrementalCompilationState.IncrementalDependencyAndInputSetup
.mock(outputFileMap: outputFileMap)
let priorsModTime = try info.blockingConcurrentAccessOrMutation {
() -> Date in
let priorsWithOldVersion = try XCTUnwrap(ModuleDependencyGraph.read(
from: .absolute(priorsPath),
info: info))
let priorsModTime = try localFileSystem.getFileInfo(priorsPath).modTime
let incrementedVersion = ModuleDependencyGraph.serializedGraphVersion.withAlteredMinor
try priorsWithOldVersion.write(to: .absolute(priorsPath),
on: localFileSystem,
buildRecord: priorsWithOldVersion.buildRecord,
mockSerializedGraphVersion: incrementedVersion)
return priorsModTime
}
try setModTime(of: .absolute(priorsPath), to: priorsModTime)
try checkReactionToObsoletePriors()
try checkNullBuild(checkDiagnostics: true)
#endif
}
}
// MARK: - Test adding an input
extension IncrementalCompilationTests {
func testAddingInput() throws {
#if !os(Linux)
try testAddingInput(newInput: "another", defining: "nameInAnother")
#endif
}
/// Test the addition of an input file
///
/// - Parameters:
/// - newInput: basename without extension of new input file
/// - topLevelName: a new top level name defined in the new input
private func testAddingInput(newInput: String, defining topLevelName: String
) throws {
try buildInitialState(checkDiagnostics: true).withModuleDependencyGraph { initial in
initial.ensureOmits(sourceBasenameWithoutExt: newInput)
initial.ensureOmits(name: topLevelName)
}
write("let \(topLevelName) = foo", to: newInput)
let newInputsPath = inputPath(basename: newInput)
OutputFileMapCreator.write(module: module,
inputPaths: inputPathsAndContents.map {$0.0} + [newInputsPath],
derivedData: derivedDataPath,
to: OFM)
try checkReactionToAddingInput(newInput: newInput, definingTopLevel: topLevelName)
try checkRestorationOfIncrementalityAfterAddition(newInput: newInput, definingTopLevel: topLevelName)
}
}
// MARK: - Incremental file removal tests
/// In order to ensure robustness, test what happens under various conditions when a source file is
/// removed.
/// The following is a lot of work to get something that prints nicely. Need an enum with both a string and an int value.
fileprivate enum RemovalTestOption: String, CaseIterable, Comparable, Hashable, CustomStringConvertible {
case
removeInputFromInvocation,
removeSwiftDepsOfRemovedInput,
removedFileDependsOnChangedFile
private static let byInt = [Int: Self](uniqueKeysWithValues: allCases.enumerated().map{($0, $1)})
private static let intFor = [Self: Int](uniqueKeysWithValues: allCases.enumerated().map{($1, $0)})
var intValue: Int {Self.intFor[self]!}
init(fromInt i: Int) {self = Self.byInt[i]!}
static func < (lhs: RemovalTestOption, rhs: RemovalTestOption) -> Bool {
lhs.intValue < rhs.intValue
}
var mask: Int { 1 << intValue}
static let maxIntValue = allCases.map {$0.intValue} .max()!
static let maxCombinedValue = (1 << (maxIntValue + 1)) - 1
var description: String { rawValue }
}
/// Only 5 elements, an array is fine
fileprivate typealias RemovalTestOptions = [RemovalTestOption]
extension RemovalTestOptions {
fileprivate static let allCombinations: [RemovalTestOptions] =
(0...RemovalTestOption.maxCombinedValue) .map(decoding)
fileprivate static func decoding(_ bits: Int) -> Self {
RemovalTestOption.allCases.filter { opt in
(1 << opt.intValue) & bits != 0
}
}
}
extension IncrementalCompilationTests {
func testRemoval() throws {
#if _runtime(_ObjC)
for optionsToTest in RemovalTestOptions.allCombinations {
try testRemoval(optionsToTest)
}
#endif
}
private func testRemoval(_ options: RemovalTestOptions) throws {
setUp() // clear derived data, restore output file map
print("\n*** testRemoval \(options) ***", to: &stderrStream); stderrStream.flush()
let newInput = "another"
let topLevelName = "nameInAnother"
try testAddingInput(newInput: newInput, defining: topLevelName)
let removeInputFromInvocation = options.contains(.removeInputFromInvocation)
let removeSwiftDepsOfRemovedInput = options.contains(.removeSwiftDepsOfRemovedInput)
let removedFileDependsOnChangedFileAndMainWasChanged = options.contains(.removedFileDependsOnChangedFile)
_ = try self.checkNonincrementalAfterRemoving(
removedInput: newInput,
defining: topLevelName,
removeInputFromInvocation: removeInputFromInvocation,
removeSwiftDepsOfRemovedInput: removeSwiftDepsOfRemovedInput)
if removedFileDependsOnChangedFileAndMainWasChanged {
replace(contentsOf: "main", with: "let foo = \"hello\"")
}
try checkRestorationOfIncrementalityAfterRemoval(
removedInput: newInput,
defining: topLevelName,
removeInputFromInvocation: removeInputFromInvocation,
removeSwiftDepsOfRemovedInput: removeSwiftDepsOfRemovedInput,
removedFileDependsOnChangedFileAndMainWasChanged: removedFileDependsOnChangedFileAndMainWasChanged)
}
}
// MARK: - Incremental argument hashing tests
extension IncrementalCompilationTests {
func testNullBuildWhenAddingAndRemovingArgumentsNotAffectingIncrementalBuilds() throws {
// Adding, removing, or changing the arguments of options which don't affect incremental builds should result in a null build.
try buildInitialState(extraArguments: ["-driver-batch-size-limit", "5", "-debug-diagnostic-names"])
let driver = try checkNullBuild(extraArguments: ["-driver-batch-size-limit", "10", "-diagnostic-style", "swift"])
let mandatoryJobs = try XCTUnwrap(driver.incrementalCompilationState?.mandatoryJobsInOrder)
XCTAssertTrue(mandatoryJobs.isEmpty)
}
func testChangingOptionArgumentLeadsToRecompile() throws {
// If an option affects incremental builds, changing only the argument should trigger a full recompile.
try buildInitialState(extraArguments: ["-user-module-version", "1.0"])
try doABuild(
"change user module version",
checkDiagnostics: true,
extraArguments: ["-user-module-version", "1.1"],
whenAutolinking: autolinkLifecycleExpectedDiags
) {
enablingCrossModule
readGraph
differentArgsPassed
disablingIncrementalDifferentArgsPassed
findingBatchingCompiling("main", "other")
reading(deps: "main", "other")
schedLinking
}
}
func testOptionReorderingLeadsToRecompile() throws {
// Reordering options which affect incremental builds should trigger a full recompile.
try buildInitialState(extraArguments: ["-warnings-as-errors", "-no-warnings-as-errors"])
try doABuild(
"change user module version",
checkDiagnostics: true,
extraArguments: ["-no-warnings-as-errors", "-warnings-as-errors"],
whenAutolinking: autolinkLifecycleExpectedDiags
) {
enablingCrossModule
readGraph
differentArgsPassed
disablingIncrementalDifferentArgsPassed
findingBatchingCompiling("main", "other")
reading(deps: "main", "other")
schedLinking
}
}
func testArgumentReorderingLeadsToRecompile() throws {
// Reordering the arguments of an option which affect incremental builds should trigger a full recompile.
try buildInitialState(extraArguments: ["-Ifoo", "-Ibar"])
try doABuild(
"change user module version",
checkDiagnostics: true,
extraArguments: ["-Ibar", "-Ifoo"],
whenAutolinking: autolinkLifecycleExpectedDiags
) {
enablingCrossModule
readGraph
differentArgsPassed
disablingIncrementalDifferentArgsPassed
findingBatchingCompiling("main", "other")
reading(deps: "main", "other")
schedLinking
}
}
}
// MARK: - Incremental test stages
extension IncrementalCompilationTests {
/// Setup the initial post-build state.
///
/// - Parameters:
/// - checkDiagnostics: If true verify the diagnostics
/// - extraArguments: Additional command-line arguments
/// - Returns: The `Driver` object
@discardableResult
private func buildInitialState(
checkDiagnostics: Bool = false,
extraArguments: [String] = [],
explicitModuleBuild: Bool = false
) throws -> Driver {
@DiagsBuilder var implicitBuildInitialRemarks: [Diagnostic.Message] {
// Leave off the part after the colon because it varies on Linux:
// MacOS: The operation could not be completed. (TSCBasic.FileSystemError error 3.).
// Linux: The operation couldn’t be completed. (TSCBasic.FileSystemError error 3.)
enablingCrossModule
findingBatchingCompiling("main", "other")
reading(deps: "main", "other")
schedLinking
}
@DiagsBuilder var explicitBuildInitialRemarks: [Diagnostic.Message] {
implicitBuildInitialRemarks
explicitDidNotReadInterModuleGraph
compilingExplicitClangDependency("SwiftShims")
compilingExplicitSwiftDependency("Swift")
compilingExplicitSwiftDependency("SwiftOnoneSupport")
}
return try doABuild("initial",
checkDiagnostics: checkDiagnostics,
extraArguments: explicitModuleBuild ? explicitBuildArgs + extraArguments : extraArguments,
whenAutolinking: autolinkLifecycleExpectedDiags
) { explicitModuleBuild ? explicitBuildInitialRemarks : implicitBuildInitialRemarks }
}
/// Try a build with no changes.
///
/// - Parameters:
/// - checkDiagnostics: If true verify the diagnostics
/// - extraArguments: Additional command-line arguments
@discardableResult
private func checkNullBuild(
checkDiagnostics: Bool = false,
extraArguments: [String] = [],
explicitModuleBuild: Bool = false
) throws -> Driver {
@DiagsBuilder var implicitBuildNullRemarks: [Diagnostic.Message] {
enablingCrossModule
readGraph
maySkip("main", "other")
skipping("main", "other")
skipped("main", "other")
skippingLinking
}
@DiagsBuilder var explicitBuildNullRemarks: [Diagnostic.Message] {
implicitBuildNullRemarks
readInterModuleGraph
interModuleDependencyGraphUpToDate
}
return try doABuild(
"as is",
checkDiagnostics: checkDiagnostics,
extraArguments: explicitModuleBuild ? explicitBuildArgs + extraArguments : extraArguments,
whenAutolinking: []
) { explicitModuleBuild ? explicitBuildNullRemarks : implicitBuildNullRemarks }
}
/// Check reaction to touching a non-propagating input.
///
/// - Parameters:
/// - checkDiagnostics: If true verify the diagnostics
/// - extraArguments: Additional command-line arguments
private func checkNoPropagation(
checkDiagnostics: Bool = false,
extraArguments: [String] = []
) throws {
touch("other")
try doABuild(
"touch other; non-propagating",
checkDiagnostics: checkDiagnostics,
extraArguments: extraArguments,
whenAutolinking: autolinkLifecycleExpectedDiags
) {
enablingCrossModule
maySkip("main")
schedulingChangedInitialQueuing("other")
skipping("main")
readGraph
findingBatchingCompiling("other")
reading(deps: "other")
// Since the code is `bar = foo`, there is no fingprint for `bar`
fingerprintsMissingOfTopLevelName(name: "bar", "other")
schedLinking
skipped("main")
}
}
/// Check reaction to touching both inputs.
///
/// - Parameters:
/// - checkDiagnostics: If true verify the diagnostics
/// - extraArguments: Additional command-line arguments
private func checkReactionToTouchingAll(
checkDiagnostics: Bool = false,
extraArguments: [String] = [],
explicitModuleBuild: Bool = false
) throws {
@DiagsBuilder var implicitBuildRemarks: [Diagnostic.Message] {
readGraph
enablingCrossModule
schedulingChangedInitialQueuing("main", "other")
findingBatchingCompiling("main", "other")
reading(deps: "main", "other")
// Because `let foo = 1`, there is no fingerprint
fingerprintsMissingOfTopLevelName(name: "foo", "main")
fingerprintsMissingOfTopLevelName(name: "bar", "other")
schedLinking
}
@DiagsBuilder var explicitBuildRemarks: [Diagnostic.Message] {
implicitBuildRemarks
readInterModuleGraph
interModuleDependencyGraphUpToDate
}
touch("main")
touch("other")
try doABuild(
"touch both; non-propagating",
checkDiagnostics: checkDiagnostics,
extraArguments: explicitModuleBuild ? explicitBuildArgs + extraArguments : extraArguments,
whenAutolinking: autolinkLifecycleExpectedDiags
) { explicitModuleBuild ? explicitBuildRemarks : implicitBuildRemarks }
}
/// Check reaction to changing a top-level declaration.
///
/// - Parameters:
/// - checkDiagnostics: If true verify the diagnostics
/// - extraArguments: Additional command-line arguments
private func checkPropagationOfTopLevelChange(
checkDiagnostics: Bool = false,
extraArguments: [String] = []
) throws {
replace(contentsOf: "main", with: "let foo = \"hello\"")
try doABuild(
"replace contents of main; propagating into 2nd wave",
checkDiagnostics: checkDiagnostics,
extraArguments: extraArguments,
whenAutolinking: autolinkLifecycleExpectedDiags
) {
readGraph
enablingCrossModule
schedulingChanged("main")
maySkip("other")
queuingInitial("main")
notSchedulingDependentsUnknownChanges("main")
skipping("other")
findingBatchingCompiling("main")
reading(deps: "main")
fingerprintsChanged("main")
fingerprintsMissingOfTopLevelName(name: "foo", "main")
trace {
TraceStep(.interface, sourceFileProvide: "main")
TraceStep(.interface, topLevel: "foo", input: "main")
TraceStep(.implementation, sourceFileProvide: "other")
}
queuingLaterSchedInvalBatchLink("other")
findingBatchingCompiling("other")
reading(deps: "other")
fingerprintsMissingOfTopLevelName(name: "bar", "other")
schedLinking
}
}
/// Check functioning of `-driver-always-rebuild-dependents`
///
/// - Parameters:
/// - checkDiagnostics: If true verify the diagnostics
/// - extraArguments: Additional command-line arguments
private func checkAlwaysRebuildDependents(
checkDiagnostics: Bool = false,
extraArguments: [String] = []
) throws {
touch("main")
let extraArgument = "-driver-always-rebuild-dependents"
try doABuild(
"touch main; non-propagating but \(extraArgument)",
checkDiagnostics: checkDiagnostics,
extraArguments: [extraArgument],
whenAutolinking: autolinkLifecycleExpectedDiags
) {
enablingCrossModule
readGraph
maySkip("other")
queuingInitial("main")
schedulingAlwaysRebuild("main")
trace {
TraceStep(.interface, topLevel: "foo", input: "main")
TraceStep(.implementation, sourceFileProvide: "other")
}
foundDependent(of: "main", compiling: "other")
schedulingChanged("main")
schedulingDependent(of: "main", compiling: "other")
queuingBecauseInitial("other")
findingAndFormingBatch(2)
addingToBatchThenForming("main", "other")
schedulingPostCompileJobs
compiling("main", "other")
reading(deps: "main", "other")
fingerprintsMissingOfTopLevelName(name: "foo", "main")
fingerprintsMissingOfTopLevelName(name: "bar", "other")
linking
}
}
/// Check reaction to adding an input file.
///
/// - Parameters:
/// - newInput: The basename without extension of the new file
/// - topLevelName: The top-level decl name added by the new file
private func checkReactionToAddingInput(
newInput: String,
definingTopLevel topLevelName: String
) throws {
let newInputsPath = inputPath(basename: newInput)
let driver = try doABuild(
"after addition of \(newInput)",
checkDiagnostics: true,
extraArguments: [newInputsPath.pathString],
whenAutolinking: autolinkLifecycleExpectedDiags
) {
readGraph
enablingCrossModule
maySkip("main", "other")
schedulingNew(newInput)
missing(newInput)
queuingInitial(newInput)
notSchedulingDependentsNoEntry(newInput)
skipping("main", "other")
findingBatchingCompiling(newInput)
reading(deps: newInput)
newDefinitionOfSourceFile(.interface, newInput)
newDefinitionOfSourceFile(.implementation, newInput)
newDefinitionOfTopLevelName(.interface, name: topLevelName, input: newInput)
newDefinitionOfTopLevelName(.implementation, name: topLevelName, input: newInput)
schedLinking
skipped("main", "other")
}
try driver.withModuleDependencyGraph { graph in
XCTAssert(graph.contains(sourceBasenameWithoutExt: newInput))
XCTAssert(graph.contains(name: topLevelName))
}
}
/// Ensure that incremental builds happen after an addition.
///
/// - Parameters:
/// - newInput: The basename without extension of the new file
/// - topLevelName: The top-level decl name added by the new file
private func checkRestorationOfIncrementalityAfterAddition(
newInput: String,
definingTopLevel topLevelName: String
) throws {
let newInputPath = inputPath(basename: newInput)
let driver = try doABuild(
"after restoration of \(newInput)",
checkDiagnostics: true,
extraArguments: [newInputPath.pathString],
whenAutolinking: autolinkLifecycleExpectedDiags
) {
readGraph
enablingCrossModule
maySkip("main", "other", newInput)
skipping("main", "other", newInput)
skippingLinking
skipped(newInput, "main", "other")
}
try driver.withModuleDependencyGraph { graph in
XCTAssert(graph.contains(sourceBasenameWithoutExt: newInput))
XCTAssert(graph.contains(name: topLevelName))
}
}
/// Check fallback to nonincremental build after a removal.
///
/// - Parameters:
/// - newInput: The basename without extension of the removed input
/// - defining: A top level name defined by the removed file
/// - includeInputInInvocation: include the removed input in the invocation
private func checkNonincrementalAfterRemoving(
removedInput: String,
defining topLevelName: String,
removeInputFromInvocation: Bool,
removeSwiftDepsOfRemovedInput: Bool
) throws -> Driver {
let extraArguments = removeInputFromInvocation
? [] : [inputPath(basename: removedInput).pathString]
if removeSwiftDepsOfRemovedInput {
removeSwiftDeps(removedInput)
}
let driver = try doABuild(
"after removal of \(removedInput)",
checkDiagnostics: true,
extraArguments: extraArguments,
whenAutolinking: autolinkLifecycleExpectedDiags
) {
switch (removeInputFromInvocation, removeSwiftDepsOfRemovedInput) {
case (false, false):
// No change:
readGraphAndSkipAll("main", "other", removedInput)
case (true, _):
// Give up on incremental if an input is removed:
readGraph
disabledForRemoval(removedInput)
enablingCrossModule
reading(deps: "main", "other")
findingBatchingCompiling("main", "other")
schedulingPostCompileJobs
linking
case (false, true):
// Missing swiftdeps; compile it, read swiftdeps, link
readGraph
enablingCrossModule
maySkip("main", "other", removedInput)
missing(removedInput)
queuingInitial(removedInput)
skipping("main", "other")
findingBatchingCompiling(removedInput)
reading(deps: removedInput)
fingerprintsMissingOfTopLevelName(name: topLevelName, removedInput)
schedulingPostCompileJobs
linking
skipped("main", "other")
}
}
if !removeInputFromInvocation {
try driver.withModuleDependencyGraph { graph in
graph.verifyGraph()
XCTAssert(graph.contains(sourceBasenameWithoutExt: removedInput))
XCTAssert(graph.contains(name: topLevelName))
}
}
return driver
}
}
// MARK: - Incremental test stages; checkRestorationOfIncrementalityAfterRemoval
extension IncrementalCompilationTests {
/// Ensure that incremental builds happen after a removal.
///
/// - Parameters:
/// - newInput: The basename without extension of the new file
/// - topLevelName: The top-level decl name added by the new file
fileprivate func checkRestorationOfIncrementalityAfterRemoval(
removedInput: String,
defining topLevelName: String,
removeInputFromInvocation: Bool,
removeSwiftDepsOfRemovedInput: Bool,
removedFileDependsOnChangedFileAndMainWasChanged: Bool
) throws {
let inputs = ["main", "other"] + (removeInputFromInvocation ? [] : [removedInput])
let extraArguments = removeInputFromInvocation
? [] : [inputPath(basename: removedInput).pathString]
let mainChanged = removedFileDependsOnChangedFileAndMainWasChanged
let changedInputs = mainChanged ? ["main"] : []
let unchangedInputs = inputs.filter {!changedInputs.contains($0)}
let affectedInputs = removeInputFromInvocation
? ["other"] : [removedInput, "other"]
let affectedInputsInBuild = affectedInputs.filter(inputs.contains)
let affectedInputsInInvocationOrder = inputs.filter(affectedInputsInBuild.contains)
let driver = try doABuild(
"restoring incrementality after removal of \(removedInput)",
checkDiagnostics: true,
extraArguments: extraArguments,
whenAutolinking: autolinkLifecycleExpectedDiags
) {
readGraph
enablingCrossModule
if changedInputs.isEmpty {
skippingAll(inputs)
} else {
let swiftDepsReadAfterFirstWave = changedInputs
let omittedFromFirstWave = unchangedInputs
respondToChangedInputs(
changedInputs: changedInputs,
unchangedInputs: unchangedInputs,
swiftDepsReadAfterFirstWave: swiftDepsReadAfterFirstWave,
omittedFromFirstWave: omittedFromFirstWave)
integrateChangedMainWithPriors(
removedInput: removedInput,
defining: topLevelName,
affectedInputs: affectedInputs,
affectedInputsInBuild: affectedInputsInBuild,
affectedInputsInInvocationOrder: affectedInputsInInvocationOrder,
removeInputFromInvocation: removeInputFromInvocation)
schedLinking
}
}
try driver.withModuleDependencyGraph { graph in
graph.verifyGraph()
if removeInputFromInvocation {
graph.ensureOmits(sourceBasenameWithoutExt: removedInput)
graph.ensureOmits(name: topLevelName)
}
else {
XCTAssert(graph.contains(sourceBasenameWithoutExt: removedInput))
XCTAssert(graph.contains(name: topLevelName))
}
}
}
@DiagsBuilder private func respondToChangedInputs(
changedInputs: [String],
unchangedInputs: [String],
swiftDepsReadAfterFirstWave: [String],
omittedFromFirstWave: [String]
) -> [Diagnostic.Message] {
schedulingChanged(changedInputs)
maySkip(unchangedInputs)
queuingInitial(swiftDepsReadAfterFirstWave)
notSchedulingDependentsUnknownChanges(changedInputs)
skipping(omittedFromFirstWave)
findingBatchingCompiling(swiftDepsReadAfterFirstWave)
reading(deps: swiftDepsReadAfterFirstWave)
}
@DiagsBuilder private var addDefsWithoutGraph: [Diagnostic.Message] {
for (input, name) in [("main", "foo"), ("other", "bar")] {
newDefinitionOfSourceFile(.interface, input)
newDefinitionOfSourceFile(.implementation, input)
newDefinitionOfTopLevelName(.interface, name: name, input: input)
newDefinitionOfTopLevelName(.implementation, name: name, input: input)
}
}
@DiagsBuilder private func integrateChangedMainWithPriors(
removedInput: String,
defining topLevelName: String,
affectedInputs: [String],
affectedInputsInBuild: [String],
affectedInputsInInvocationOrder: [String],
removeInputFromInvocation: Bool
) -> [Diagnostic.Message]
{
fingerprintsChanged("main")
fingerprintsMissingOfTopLevelName(name: "foo", "main")
for input in affectedInputs {
trace {
TraceStep(.interface, sourceFileProvide: "main")
TraceStep(.interface, topLevel: "foo", input: "main")
TraceStep(.implementation, sourceFileProvide: input)
}
}
queuingLater(affectedInputsInBuild)
schedulingInvalidated(affectedInputsInBuild)
findingBatchingCompiling(affectedInputsInInvocationOrder)
reading(deps: "other")
fingerprintsMissingOfTopLevelName(name: "bar", "other")
let readingAnotherDeps = !removeInputFromInvocation // if removed, won't read it
if readingAnotherDeps {
reading(deps: removedInput)
fingerprintsMissingOfTopLevelName(name: topLevelName, removedInput)
}
}
private func checkReactionToObsoletePriors() throws {
try doABuild(
"check reaction to obsolete priors",
checkDiagnostics: true,
extraArguments: [],
whenAutolinking: autolinkLifecycleExpectedDiags) {
couldNotReadPriors
enablingCrossModule
findingBatchingCompiling("main", "other")
reading(deps: "main")
reading(deps: "other")
schedLinking
}
}
private func checkReactionToTouchingSymlinks(
checkDiagnostics: Bool = false,
extraArguments: [String] = []
) throws {
Thread.sleep(forTimeInterval: 1)
for (file, _) in self.inputPathsAndContents {
try localFileSystem.removeFileTree(file)
let linkTarget = tempDir.appending(component: "links").appending(component: file.basename)
try localFileSystem.createSymbolicLink(file, pointingAt: linkTarget, relative: false)
}
try doABuild(
"touch both symlinks; non-propagating",
checkDiagnostics: checkDiagnostics,
extraArguments: extraArguments,
whenAutolinking: autolinkLifecycleExpectedDiags
) {
enablingCrossModule
readGraph
maySkip("main", "other")
skipping("main", "other")
skippingLinking
skipped("main", "other")
}
}
private func checkReactionToTouchingSymlinkTargets(
checkDiagnostics: Bool = false,
extraArguments: [String] = []
) throws {
Thread.sleep(forTimeInterval: 1)
for (file, contents) in self.inputPathsAndContents {
let linkTarget = tempDir.appending(component: "links").appending(component: file.basename)
try! localFileSystem.writeFileContents(linkTarget) { $0.send(contents) }
}
try doABuild(
"touch both symlink targets; non-propagating",
checkDiagnostics: checkDiagnostics,
extraArguments: extraArguments,
whenAutolinking: autolinkLifecycleExpectedDiags
) {
enablingCrossModule
readGraph
schedulingChangedInitialQueuing("main", "other")
findingBatchingCompiling("main", "other")
reading(deps: "main", "other")
fingerprintsMissingOfTopLevelName(name: "foo", "main")
fingerprintsMissingOfTopLevelName(name: "bar", "other")
schedulingPostCompileJobs
linking
}
}
}
// MARK: - Incremental test perturbation helpers
extension IncrementalCompilationTests {
private func touch(_ name: String) {
print("*** touching \(name) ***", to: &stderrStream); stderrStream.flush()
let (path, _) = try! XCTUnwrap(inputPathsAndContents.filter {$0.0.pathString.contains(name)}.first)
touch(path)
}
private func touch(_ path: AbsolutePath) {
Thread.sleep(forTimeInterval: 1)
let existingContents = try! localFileSystem.readFileContents(path)
try! localFileSystem.writeFileContents(path) { $0.send(existingContents) }
}
/// Set modification time of a file
///
/// - Parameters:
/// - path: The file whose modificaiton time to change
/// - newModTime: The desired modification time
fileprivate func setModTime(of path: VirtualPath, to newModTime: Date) throws {
var fileAttributes = try FileManager.default.attributesOfItem(atPath: path.name)
fileAttributes[.modificationDate] = newModTime
try FileManager.default.setAttributes(fileAttributes, ofItemAtPath: path.name)
}
private func removeInput(_ name: String) {
print("*** removing input \(name) ***", to: &stderrStream); stderrStream.flush()
try! localFileSystem.removeFileTree(inputPath(basename: name))
}
private func removeSwiftDeps(_ name: String) {
print("*** removing swiftdeps \(name) ***", to: &stderrStream); stderrStream.flush()
let swiftDepsPath = swiftDepsPath(basename: name)
XCTAssert(localFileSystem.exists(swiftDepsPath))
try! localFileSystem.removeFileTree(swiftDepsPath)
}
private func replace(contentsOf name: String, with replacement: String) {
print("*** replacing \(name) ***", to: &stderrStream); stderrStream.flush()
let path = inputPath(basename: name)
let previousContents = try! localFileSystem.readFileContents(path).cString
try! localFileSystem.writeFileContents(path) { $0.send(replacement) }
let newContents = try! localFileSystem.readFileContents(path).cString
XCTAssert(previousContents != newContents, "\(path.pathString) unchanged after write")
XCTAssert(replacement == newContents, "\(path.pathString) failed to write")
}
private func write(_ contents: String, to basename: String) {
print("*** writing \(contents) to \(basename)")
try! localFileSystem.writeFileContents(inputPath(basename: basename)) { $0.send(contents) }
}
private func readPriors() -> ByteString? {
try? localFileSystem.readFileContents(priorsPath)
}
private func writePriors( _ contents: ByteString) {
try! localFileSystem.writeFileContents(priorsPath, bytes: contents)
}
}
// MARK: - Graph inspection
extension Driver {
/// Expose the protected ``ModuleDependencyGraph`` to a function and also prevent concurrent access or modification
func withModuleDependencyGraph(_ fn: (ModuleDependencyGraph) throws -> Void) throws {
let incrementalCompilationState = try XCTUnwrap(self.incrementalCompilationState, "no graph")
try incrementalCompilationState.blockingConcurrentAccessOrMutationToProtectedState {
try $0.testWithModuleDependencyGraph(fn)
}
}
func verifyNoGraph() {
XCTAssertNil(incrementalCompilationState)
}
}
fileprivate extension ModuleDependencyGraph {
/// A convenience for testing
var allNodes: [Node] {
var nodes = [Node]()
nodeFinder.forEachNode {nodes.append($0)}
return nodes
}
func contains(sourceBasenameWithoutExt target: String) -> Bool {
allNodes.contains {$0.contains(sourceBasenameWithoutExt: target, in: self)}
}
func contains(name target: String) -> Bool {
allNodes.contains {$0.contains(name: target, in: self)}
}
func ensureOmits(sourceBasenameWithoutExt target: String) {
// Written this way to show the faulty node when the assertion fails
nodeFinder.forEachNode { node in
XCTAssertFalse(node.contains(sourceBasenameWithoutExt: target, in: self),
"graph should omit source: \(target)")
}
}
func ensureOmits(name: String) {
// Written this way to show the faulty node when the assertion fails
nodeFinder.forEachNode { node in
XCTAssertFalse(node.contains(name: name, in: self),
"graph should omit decl named: \(name)")
}
}
}
fileprivate extension ModuleDependencyGraph.Node {
func contains(sourceBasenameWithoutExt target: String, in g: ModuleDependencyGraph) -> Bool {
switch key.designator {
case .sourceFileProvide(name: let name):
return (try? VirtualPath(path: name.lookup(in: g)))
.map {$0.basenameWithoutExt == target}
?? false
case .externalDepend(let externalDependency):
return externalDependency.path.map {
$0.basenameWithoutExt == target
}
?? false
case .topLevel, .dynamicLookup, .nominal, .member, .potentialMember:
return false
}
}
func contains(name target: String, in g: ModuleDependencyGraph) -> Bool {
switch key.designator {
case .topLevel(name: let name),
.dynamicLookup(name: let name):
return name.lookup(in: g) == target
case .externalDepend, .sourceFileProvide:
return false
case .nominal(context: let context),
.potentialMember(context: let context):
return context.lookup(in: g).range(of: target) != nil
case .member(context: let context, name: let name):
return context.lookup(in: g).range(of: target) != nil ||
name.lookup(in: g) == target
}
}
}
// MARK: - Build helpers
extension IncrementalCompilationTests {
@discardableResult
fileprivate func doABuild(
_ message: String,
checkDiagnostics: Bool,
extraArguments: [String],
whenAutolinking autolinkExpectedDiags: [Diagnostic.Message],
@DiagsBuilder expecting expectedDiags: () -> [Diagnostic.Message]
) throws -> Driver {
print("*** starting build \(message) ***", to: &stderrStream); stderrStream.flush()
guard let sdkArgumentsForTesting = try Driver.sdkArgumentsForTesting()
else {
throw XCTSkip("Cannot perform this test on this host")
}
let allArgs = commonArgs + extraArguments + sdkArgumentsForTesting
return try checkDiagnostics
? doABuild(whenAutolinking: autolinkExpectedDiags,
expecting: expectedDiags(),
arguments: allArgs)
: doABuildWithoutExpectations(arguments: allArgs)
}
private func doABuild(
whenAutolinking autolinkExpectedDiags: [Diagnostic.Message],
expecting expectedDiags: [Diagnostic.Message],
arguments: [String]
) throws -> Driver {
try assertDriverDiagnostics(args: arguments) {
driver, verifier in
verifier.forbidUnexpected(.error, .warning, .note, .remark, .ignored)
expectedDiags.forEach {verifier.expect($0)}
if driver.isAutolinkExtractJobNeeded {
autolinkExpectedDiags.forEach {verifier.expect($0)}
}
doTheCompile(&driver)
return driver
}
}
private func doABuildWithoutExpectations(arguments: [String]) throws -> Driver {
// If not checking, print out the diagnostics
let diagnosticEngine = DiagnosticsEngine(handlers: [
{print($0, to: &stderrStream); stderrStream.flush()}
])
var driver = try Driver(args: arguments, env: ProcessEnv.vars,
diagnosticsEngine: diagnosticEngine,
fileSystem: localFileSystem)
doTheCompile(&driver)
// Add a newline after any diagnostics for readability
print("", to: &stderrStream); stderrStream.flush()
return driver
}
private func doTheCompile(_ driver: inout Driver) {
let jobs = try! driver.planBuild()
try? driver.run(jobs: jobs)
}
}
// MARK: - Concisely specifying sequences of diagnostics
/// Build an array of diagnostics from a closure containing various things
@resultBuilder fileprivate enum DiagsBuilder {}
/// Build a series of messages from series of messages
extension DiagsBuilder {
static func buildBlock(_ components: [Diagnostic.Message]...) -> [Diagnostic.Message] {
components.flatMap {$0}
}
}
/// A statement can be String, Message, or \[Message\]
extension DiagsBuilder {
static func buildExpression(_ expression: String) -> [Diagnostic.Message] {
// Default a string to a remark
[.remark(expression)]
}
static func buildExpression(_ expression: [Diagnostic.Message]) -> [Diagnostic.Message] {
expression
}
static func buildExpression(_ expression: Diagnostic.Message) -> [Diagnostic.Message] {
[expression]
}
}
/// Handle control structures
extension DiagsBuilder {
static func buildArray(_ components: [[Diagnostic.Message]]) -> [Diagnostic.Message] {
components.flatMap{$0}
}
static func buildOptional(_ component: [Diagnostic.Message]?) -> [Diagnostic.Message] {
component ?? []
}
static func buildEither(first component: [Diagnostic.Message]) -> [Diagnostic.Message] {
component
}
static func buildEither(second component: [Diagnostic.Message]) -> [Diagnostic.Message] {
component
}
}
// MARK: - Shorthand diagnostics & sequences
/// Allow tests to specify diagnostics without extra punctuation
fileprivate protocol DiagVerifiable {}
extension IncrementalCompilationTests: DiagVerifiable {}
extension DiagVerifiable {
// MARK: - explicit builds
@DiagsBuilder var explicitDidNotReadInterModuleGraph: [Diagnostic.Message] {
"Incremental compilation: Incremental compilation did not attempt to read inter-module dependency graph."
}
@DiagsBuilder var explicitMustReScanCouldNotReadGraph: [Diagnostic.Message] {
"Incremental compilation: Incremental build must re-run dependency scan: Could not read inter-module dependency graph at"
}
@DiagsBuilder var readInterModuleGraph: [Diagnostic.Message] {
"Incremental compilation: Read inter-module dependency graph"
}
@DiagsBuilder var interModuleDependencyGraphUpToDate: [Diagnostic.Message] {
"Incremental compilation: Confirmed prior inter-module dependency graph is up-to-date at"
}
@DiagsBuilder var explicitMustReScanDueToChangedImports: [Diagnostic.Message] {
"Incremental compilation: Incremental build must re-run dependency scan: Target import set has changed."
}
@DiagsBuilder var explicitMustReScanDueToChangedDependencyInput: [Diagnostic.Message] {
"Incremental compilation: Incremental build must re-run dependency scan: Not all dependencies are up-to-date."
}
@DiagsBuilder func explicitDependencyModuleOlderThanInput(_ dependencyModuleName: String) -> [Diagnostic.Message] {
"Dependency module \(dependencyModuleName) is older than input file"
}
@DiagsBuilder func startCompilingExplicitClangDependency(_ dependencyModuleName: String) -> [Diagnostic.Message] {
"Starting Compiling Clang module \(dependencyModuleName)"
}
@DiagsBuilder func finishCompilingExplicitClangDependency(_ dependencyModuleName: String) -> [Diagnostic.Message] {
"Finished Compiling Clang module \(dependencyModuleName)"
}
@DiagsBuilder func startCompilingExplicitSwiftDependency(_ dependencyModuleName: String) -> [Diagnostic.Message] {
"Starting Compiling Swift module \(dependencyModuleName)"
}
@DiagsBuilder func finishCompilingExplicitSwiftDependency(_ dependencyModuleName: String) -> [Diagnostic.Message] {
"Finished Compiling Swift module \(dependencyModuleName)"
}
@DiagsBuilder func compilingExplicitClangDependency(_ dependencyModuleName: String) -> [Diagnostic.Message] {
startCompilingExplicitClangDependency(dependencyModuleName)
finishCompilingExplicitClangDependency(dependencyModuleName)
}
@DiagsBuilder func compilingExplicitSwiftDependency(_ dependencyModuleName: String) -> [Diagnostic.Message] {
startCompilingExplicitSwiftDependency(dependencyModuleName)
finishCompilingExplicitSwiftDependency(dependencyModuleName)
}
@DiagsBuilder func moduleOutputNotFound(_ moduleName: String) -> [Diagnostic.Message] {
"Incremental compilation: Module output not found: '\(moduleName)'"
}
@DiagsBuilder func moduleWillBeRebuiltOutOfDate(_ moduleName: String) -> [Diagnostic.Message] {
"Incremental compilation: Dependency module '\(moduleName)' will be re-built: Out-of-date"
}
@DiagsBuilder func moduleWillBeRebuiltInvalidatedDownstream(_ moduleName: String) -> [Diagnostic.Message] {
"Incremental compilation: Dependency module '\(moduleName)' will be re-built: Invalidated by downstream dependency"
}
@DiagsBuilder func moduleInfoStaleOutOfDate(_ moduleName: String) -> [Diagnostic.Message] {
"Incremental compilation: Dependency module '\(moduleName)' info is stale: Out-of-date"
}
@DiagsBuilder func moduleInfoStaleInvalidatedDownstream(_ moduleName: String) -> [Diagnostic.Message] {
"Incremental compilation: Dependency module '\(moduleName)' info is stale: Invalidated by downstream dependency"
}
@DiagsBuilder func explicitModulesWillBeRebuilt(_ moduleNames: [String]) -> [Diagnostic.Message] {
"Incremental compilation: Following explicit module dependencies will be re-built: [\(moduleNames.joined(separator: ", "))]"
}
// MARK: - misc
@DiagsBuilder var enablingCrossModule: [Diagnostic.Message] {
"Incremental compilation: Enabling incremental cross-module building"
}
@DiagsBuilder func disabledForRemoval(_ removedInput: String) -> [Diagnostic.Message] {
"Incremental compilation: Incremental compilation has been disabled, because the following inputs were used in the previous compilation but not in this one: \(removedInput).swift"
}
@DiagsBuilder var disabledForWMO: [Diagnostic.Message] {
"Incremental compilation has been disabled: it is not compatible with whole module optimization"
}
// MARK: - build record
@DiagsBuilder var cannotReadBuildRecord: [Diagnostic.Message] {
"Incremental compilation: Incremental compilation could not read build record at"
}
@DiagsBuilder var disablingIncrementalCannotReadBuildRecord: [Diagnostic.Message] {
"Incremental compilation: Disabling incremental build: could not read build record"
}
@DiagsBuilder var differentArgsPassed: [Diagnostic.Message] {
"Incremental compilation: Incremental compilation has been disabled, because different arguments were passed to the compiler"
}
@DiagsBuilder var disablingIncrementalDifferentArgsPassed: [Diagnostic.Message] {
"Incremental compilation: Disabling incremental build: different arguments were passed to the compiler"
}
@DiagsBuilder var missingMainDependencyEntry: [Diagnostic.Message] {
.warning("ignoring -incremental; output file map has no master dependencies entry (\"swift-dependencies\" under \"\")")
}
@DiagsBuilder var disablingIncremental: [Diagnostic.Message] {
"Incremental compilation: Disabling incremental build: no build record path"
}
// MARK: - graph
@DiagsBuilder var createdGraphFromSwiftdeps: [Diagnostic.Message] {
"Incremental compilation: Created dependency graph from swiftdeps files"
}
@DiagsBuilder var readGraph: [Diagnostic.Message] {
"Incremental compilation: Read dependency graph"
}
@DiagsBuilder var couldNotReadPriors: [Diagnostic.Message] {
.remark("Will not do cross-module incremental builds, wrong version of priors; expected")
}
// MARK: - dependencies
@DiagsBuilder func reading(deps inputs: [String]) -> [Diagnostic.Message] {
for input in inputs {
"Incremental compilation: Reading dependencies from \(input).swift"
}
}
@DiagsBuilder func reading(deps inputs: String...) -> [Diagnostic.Message] {
reading(deps: inputs)
}
@DiagsBuilder func fingerprintChanged(_ aspect: DependencyKey.DeclAspect, _ input: String) -> [Diagnostic.Message] {
"Incremental compilation: Fingerprint changed for existing \(aspect) of source file from \(input).swiftdeps in \(input).swift"
}
@DiagsBuilder func fingerprintsChanged(_ input: String) -> [Diagnostic.Message] {
for aspect: DependencyKey.DeclAspect in [.interface, .implementation] {
fingerprintChanged(aspect, input)
}
}
@DiagsBuilder func fingerprintsMissingOfTopLevelName(name: String, _ input: String) -> [Diagnostic.Message] {
for aspect: DependencyKey.DeclAspect in [.interface, .implementation] {
"Incremental compilation: Fingerprint missing for existing \(aspect) of top-level name '\(name)' in \(input).swift"
}
}
@DiagsBuilder func newDefinitionOfSourceFile(_ aspect: DependencyKey.DeclAspect, _ input: String) -> [Diagnostic.Message] {
"Incremental compilation: New definition: \(aspect) of source file from \(input).swiftdeps in \(input).swift"
}
@DiagsBuilder func newDefinitionOfTopLevelName(_ aspect: DependencyKey.DeclAspect, name: String, input: String) -> [Diagnostic.Message] {
"Incremental compilation: New definition: \(aspect) of top-level name '\(name)' in \(input).swift"
}
@DiagsBuilder func foundDependent(of defInput: String, compiling useInput: String) -> [Diagnostic.Message] {
"Incremental compilation: Found dependent of \(defInput).swift: {compile: \(useInput).o <= \(useInput).swift}"
}
@DiagsBuilder func hasMalformed(_ inputs: [String]) -> [Diagnostic.Message] {
for newInput in inputs {
"Incremental compilation: Has malformed dependency source; will queue {compile: \(newInput).o <= \(newInput).swift}"
}
}
@DiagsBuilder func hasMalformed(_ inputs: String...) -> [Diagnostic.Message] {
hasMalformed(inputs)
}
@DiagsBuilder func invalidatedExternally(_ inputs: [String]) -> [Diagnostic.Message] {
for input in inputs {
"Incremental compilation: Invalidated externally; will queue {compile: \(input).o <= \(input).swift}"
}
}
@DiagsBuilder func invalidatedExternally(_ inputs: String...) -> [Diagnostic.Message] {
invalidatedExternally(inputs)
}
@DiagsBuilder func failedToFindSource(_ input: String) -> [Diagnostic.Message] {
.warning("Failed to find source file '\(input).swift' in command line, recovering with a full rebuild. Next build will be incremental.")
}
@DiagsBuilder func failedToReadSomeSource(compiling input: String) -> [Diagnostic.Message] {
"Incremental compilation: Failed to read some dependencies source; compiling everything {compile: \(input).o <= \(input).swift}"
}
@DiagsBuilder func noFingerprintInSwiftModule(_ dependencyFile: String) -> [Diagnostic.Message] {
"No fingerprint in swiftmodule: Invalidating all nodes in newer: \(dependencyFile)"
}
@DiagsBuilder func dependencyNewerThanNode(_ dependencyFile: String) -> [Diagnostic.Message] {
"Newer: \(dependencyFile) -> SwiftDriver.ModuleDependencyGraph.Node"
}
// MARK: - tracing
@DiagsBuilder func trace(@TraceBuilder _ steps: () -> String) -> [Diagnostic.Message] {
steps()
}
// MARK: - scheduling
@DiagsBuilder func schedulingAlwaysRebuild(_ input: String) -> [Diagnostic.Message] {
"Incremental compilation: scheduling dependents of \(input).swift; -driver-always-rebuild-dependents"
}
@DiagsBuilder func schedulingNew(_ input: String) -> [Diagnostic.Message] {
"Incremental compilation: Scheduling new {compile: \(input).o <= \(input).swift}"
}
@DiagsBuilder func schedulingChanged(_ inputs: [String]) -> [Diagnostic.Message] {
for input in inputs {
"Incremental compilation: Scheduling changed input {compile: \(input).o <= \(input).swift}"
}
}
@DiagsBuilder func schedulingChanged(_ inputs: String...) -> [Diagnostic.Message] {
schedulingChanged(inputs)
}
@DiagsBuilder func schedulingNoncascading(_ inputs: [String]) -> [Diagnostic.Message] {
for input in inputs {
"Incremental compilation: Scheduling noncascading build {compile: \(input).o <= \(input).swift}"
}
}
@DiagsBuilder func schedulingNoncascading(_ inputs: String...) -> [Diagnostic.Message] {
schedulingNoncascading(inputs)
}
@DiagsBuilder func schedulingInvalidated(_ inputs: [String]) -> [Diagnostic.Message] {
for input in inputs {
"Incremental compilation: Scheduling invalidated {compile: \(input).o <= \(input).swift}"
}
}
@DiagsBuilder func schedulingInvalidated(_ inputs: String...) -> [Diagnostic.Message] { schedulingInvalidated(inputs) }
@DiagsBuilder func schedulingChangedInitialQueuing(_ inputs: String...) -> [Diagnostic.Message] {
for input in inputs {
schedulingChanged(input)
queuingInitial(input)
notSchedulingDependentsUnknownChanges(input)
}
}
@DiagsBuilder func schedulingDependent(of defInput: String, compiling useInput: String) -> [Diagnostic.Message] {
"Incremental compilation: Immediately scheduling dependent on \(defInput).swift {compile: \(useInput).o <= \(useInput).swift}"
}
@DiagsBuilder func notSchedulingDependentsNoEntry(_ input: String) -> [Diagnostic.Message] {
"Incremental compilation: not scheduling dependents of \(input).swift: no entry in build record or dependency graph"
}
@DiagsBuilder func notSchedulingDependentsUnknownChanges(_ inputs: [String]) -> [Diagnostic.Message] {
for input in inputs {
"Incremental compilation: not scheduling dependents of \(input).swift; unknown changes"
}
}
@DiagsBuilder func notSchedulingDependentsUnknownChanges(_ inputs: String...) -> [Diagnostic.Message] {
notSchedulingDependentsUnknownChanges(inputs)
}
@DiagsBuilder func notSchedulingDependentsDoNotNeedCascading(_ inputs: [String]) -> [Diagnostic.Message] {
for input in inputs {
"Incremental compilation: not scheduling dependents of \(input).swift: does not need cascading build"
}
}
@DiagsBuilder func notSchedulingDependentsDoNotNeedCascading(_ inputs: String...) -> [Diagnostic.Message] {
notSchedulingDependentsDoNotNeedCascading(inputs)
}
@DiagsBuilder func missing(_ input: String) -> [Diagnostic.Message] {
"Incremental compilation: Missing an output; will queue {compile: \(input).o <= \(input).swift}"
}
@DiagsBuilder func queuingInitial(_ inputs: [String]) -> [Diagnostic.Message] {
for input in inputs {
"Incremental compilation: Queuing (initial): {compile: \(input).o <= \(input).swift}"
}
}
@DiagsBuilder func queuingInitial(_ inputs: String...) -> [Diagnostic.Message] {
queuingInitial(inputs)
}
@DiagsBuilder func queuingBecauseInitial(_ input: String) -> [Diagnostic.Message] {
"Incremental compilation: Queuing because of the initial set: {compile: \(input).o <= \(input).swift}"
}
@DiagsBuilder func queuingLater(_ inputs: [String]) -> [Diagnostic.Message] {
for input in inputs {
"Incremental compilation: Queuing because of dependencies discovered later: {compile: \(input).o <= \(input).swift}"
}
}
@DiagsBuilder func queuingLater(_ inputs: String...) -> [Diagnostic.Message] { queuingLater(inputs) }
@DiagsBuilder func queuingLaterSchedInvalBatchLink(_ inputs: [String]) -> [Diagnostic.Message] {
queuingLater(inputs)
schedulingInvalidated(inputs)
}
@DiagsBuilder func queuingLaterSchedInvalBatchLink(_ inputs: String...) -> [Diagnostic.Message] {
queuingLaterSchedInvalBatchLink(inputs)
}
// MARK: - skipping
@DiagsBuilder func maySkip(_ inputs: [String]) -> [Diagnostic.Message] {
for input in inputs {
"Incremental compilation: May skip current input: {compile: \(input).o <= \(input).swift}"
}
}
@DiagsBuilder func maySkip(_ inputs: String...) -> [Diagnostic.Message] {
maySkip(inputs)
}
@DiagsBuilder func skipping(_ inputs: [String]) -> [Diagnostic.Message] {
for input in inputs {
"Incremental compilation: Skipping input: {compile: \(input).o <= \(input).swift}"
}
}
@DiagsBuilder func skipping(_ inputs: String...) -> [Diagnostic.Message] {
skipping(inputs)
}
@DiagsBuilder func skipped(_ inputs: [String]) -> [Diagnostic.Message] {
for input in inputs {
"Skipped Compiling \(input).swift"
}
}
@DiagsBuilder func skipped(_ inputs: String...) -> [Diagnostic.Message] {
skipped(inputs)
}
@DiagsBuilder func skippingAll(_ inputs: [String]) -> [Diagnostic.Message] {
maySkip(inputs)
skipping(inputs)
skippingLinking
skipped(inputs)
}
@DiagsBuilder func skippingAll(_ inputs: String...) -> [Diagnostic.Message] {
skippingAll(inputs)
}
@DiagsBuilder func readGraphAndSkipAll(_ inputs: [String]) -> [Diagnostic.Message] {
readGraph
enablingCrossModule
skippingAll(inputs)
}
@DiagsBuilder func readGraphAndSkipAll(_ inputs: String...) -> [Diagnostic.Message] {
readGraphAndSkipAll(inputs)
}
// MARK: - batching
@DiagsBuilder func addingToBatch(_ inputs: [String], _ b: Int) -> [Diagnostic.Message] {
for input in inputs {
"Adding {compile: \(input).swift} to batch \(b)"
}
}
@DiagsBuilder func formingBatch(_ inputs: [String]) -> [Diagnostic.Message] {
"Forming batch job from \(inputs.count) constituents: \(inputs.map{$0 + ".swift"}.joined(separator: ", "))"
}
@DiagsBuilder func formingBatch(_ inputs: String...) -> [Diagnostic.Message] {
formingBatch(inputs)
}
@DiagsBuilder func foundBatchableJobs(_ jobCount: Int) -> [Diagnostic.Message] {
// Omitting the "s" from "jobs" works for either 1 or many, since
// the verifier does prefix matching.
"Found \(jobCount) batchable job"
}
@DiagsBuilder var formingOneBatch: [Diagnostic.Message] { "Forming into 1 batch"}
@DiagsBuilder func findingAndFormingBatch(_ jobCount: Int) -> [Diagnostic.Message] {
foundBatchableJobs(jobCount); formingOneBatch
}
@DiagsBuilder func addingToBatchThenForming(_ inputs: [String]) -> [Diagnostic.Message] {
addingToBatch(inputs, 0); formingBatch(inputs)
}
@DiagsBuilder func addingToBatchThenForming(_ inputs: String...) -> [Diagnostic.Message] {
addingToBatchThenForming(inputs)
}
// MARK: - compiling
@DiagsBuilder func starting(_ inputs: [String]) -> [Diagnostic.Message] {
"Starting Compiling \(inputs.map{$0 + ".swift"}.joined(separator: ", "))"
}
@DiagsBuilder func finished(_ inputs: [String]) -> [Diagnostic.Message] {
"Finished Compiling \(inputs.map{$0 + ".swift"}.joined(separator: ", "))"
}
@DiagsBuilder func compiling(_ inputs: [String]) -> [Diagnostic.Message] {
starting(inputs); finished(inputs)
}
@DiagsBuilder func compiling(_ inputs: String...) -> [Diagnostic.Message] {
compiling(inputs)
}
// MARK: - batching and compiling
@DiagsBuilder func findingBatchingCompiling(_ inputs: [String]) -> [Diagnostic.Message] {
findingAndFormingBatch(inputs.count)
addingToBatchThenForming(inputs)
compiling(inputs)
}
@DiagsBuilder func findingBatchingCompiling(_ inputs: String...) -> [Diagnostic.Message] {
findingBatchingCompiling(inputs)
}
// MARK: - linking
@DiagsBuilder var schedulingPostCompileJobs: [Diagnostic.Message] {
"Incremental compilation: Scheduling all post-compile jobs because something was compiled"
}
@DiagsBuilder var startingLinking: [Diagnostic.Message] { "Starting Linking theModule" }
@DiagsBuilder var finishedLinking: [Diagnostic.Message] { "Finished Linking theModule" }
@DiagsBuilder var skippingLinking: [Diagnostic.Message] {
"Incremental compilation: Skipping job: Linking theModule; oldest output is current"
}
@DiagsBuilder var schedLinking: [Diagnostic.Message] { schedulingPostCompileJobs; linking }
@DiagsBuilder var linking: [Diagnostic.Message] { startingLinking; finishedLinking}
// MARK: - autolinking
@DiagsBuilder func queuingExtractingAutolink(_ module: String) -> [Diagnostic.Message] {
"Incremental compilation: Queuing Extracting autolink information for module \(module)"
}
@DiagsBuilder func startingExtractingAutolink(_ module: String) -> [Diagnostic.Message] {
"Starting Extracting autolink information for module \(module)"
}
@DiagsBuilder func finishedExtractingAutolink(_ module: String) -> [Diagnostic.Message] {
"Finished Extracting autolink information for module \(module)"
}
@DiagsBuilder func extractingAutolink(_ module: String) -> [Diagnostic.Message] {
startingExtractingAutolink(module)
finishedExtractingAutolink(module)
}
}
// MARK: - trace building
@resultBuilder fileprivate enum TraceBuilder {
static func buildBlock(_ components: TraceStep...) -> String {
// Omit "Incremental compilation: Traced: " prefix because depending on
// hash table iteration order "interface of source file from *.swiftdeps in *.swift ->"
// may occur first. Since the tests do substring matching, this will work.
"\(components.map {$0.messagePart}.joined(separator: " -> "))"
}
}
fileprivate struct TraceStep {
let messagePart: String
init(_ aspect: DependencyKey.DeclAspect, sourceFileProvide source: String) {
self.init(aspect, sourceFileProvide: source, input: source)
}
init(_ aspect: DependencyKey.DeclAspect, sourceFileProvide source: String, input: String?) {
self.init(aspect, input: input) { t in
.sourceFileProvide(name: "\(source).swiftdeps".intern(in: t))
}
}
init(_ aspect: DependencyKey.DeclAspect, topLevel name: String, input: String) {
self.init(aspect, input: input) { t in
.topLevel(name: name.intern(in: t))
}
}
private init(_ aspect: DependencyKey.DeclAspect,
input: String?,
_ createDesignator: (InternedStringTable) -> DependencyKey.Designator
) {
self.messagePart = MockIncrementalCompilationSynchronizer.withInternedStringTable { t in
let key = DependencyKey(aspect: aspect, designator: createDesignator(t))
let inputPart = input.map {" in \($0).swift"} ?? ""
return "\(key.description(in: t))\(inputPart)"
}
}
}
|