Skip to content

Commit 38bc605

Browse files
cachemeifyoucancachemeifyoucan
committed
[Caching] Embed bridging header in binary module correctly when caching
When caching is enabled with include-tree, the bridging header PCH is created from the include tree directly. Setup the rewriter correctly when embedding the bridging header into swift binary module. rdar://125719747
1 parent e5d7885 commit 38bc605

File tree

6 files changed

+137
-17
lines changed

6 files changed

+137
-17
lines changed

‎include/swift/AST/DiagnosticsClangImporter.def

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ WARNING(could_not_rewrite_bridging_header,none,
4242
ERROR(bridging_header_pch_error,Fatal,
4343
"failed to emit precompiled header '%0' for bridging header '%1'",
4444
(StringRef, StringRef))
45+
ERROR(err_rewrite_bridging_header,none,
46+
"failed to serialize bridging header: '%0'", (StringRef))
4547

4648
ERROR(emit_pcm_error,Fatal,
4749
"failed to emit precompiled module '%0' for module map '%1'",

‎include/swift/ClangImporter/ClangImporter.h

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -402,8 +402,10 @@ class ClangImporter final : public ClangModuleLoader {
402402
getWrapperForModule(const clang::Module *mod,
403403
bool returnOverlayIfPossible = false) const override;
404404

405-
std::string getBridgingHeaderContents(StringRef headerPath, off_t &fileSize,
406-
time_t &fileModTime);
405+
std::string
406+
getBridgingHeaderContents(StringRef headerPath, off_t &fileSize,
407+
time_t &fileModTime,
408+
StringRef pchIncludeTree);
407409

408410
/// Makes a temporary replica of the ClangImporter's CompilerInstance, reads
409411
/// an Objective-C header file into the replica and emits a PCH file of its

‎lib/ClangImporter/ClangImporter.cpp

Lines changed: 63 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -55,13 +55,16 @@
5555
#include "clang/Basic/DiagnosticOptions.h"
5656
#include "clang/Basic/FileEntry.h"
5757
#include "clang/Basic/IdentifierTable.h"
58+
#include "clang/Basic/LangStandard.h"
5859
#include "clang/Basic/Module.h"
5960
#include "clang/Basic/TargetInfo.h"
6061
#include "clang/Basic/Version.h"
6162
#include "clang/CAS/CASOptions.h"
63+
#include "clang/CAS/IncludeTree.h"
6264
#include "clang/CodeGen/ObjectFilePCHContainerOperations.h"
6365
#include "clang/Frontend/CompilerInvocation.h"
6466
#include "clang/Frontend/FrontendActions.h"
67+
#include "clang/Frontend/IncludeTreePPActions.h"
6568
#include "clang/Frontend/TextDiagnosticPrinter.h"
6669
#include "clang/Frontend/Utils.h"
6770
#include "clang/Index/IndexingAction.h"
@@ -80,7 +83,11 @@
8083
#include "llvm/ADT/STLExtras.h"
8184
#include "llvm/ADT/SmallVector.h"
8285
#include "llvm/ADT/StringExtras.h"
86+
#include "llvm/CAS/CASReference.h"
87+
#include "llvm/CAS/ObjectStore.h"
8388
#include "llvm/Support/CrashRecoveryContext.h"
89+
#include "llvm/Support/Error.h"
90+
#include "llvm/Support/ErrorHandling.h"
8491
#include "llvm/Support/FileCollector.h"
8592
#include "llvm/Support/FileSystem.h"
8693
#include "llvm/Support/Memory.h"
@@ -1755,16 +1762,46 @@ bool ClangImporter::importBridgingHeader(StringRef header, ModuleDecl *adapter,
17551762
std::move(sourceBuffer), implicitImport);
17561763
}
17571764

1758-
std::string ClangImporter::getBridgingHeaderContents(StringRef headerPath,
1759-
off_t &fileSize,
1760-
time_t &fileModTime) {
1765+
static llvm::Expected<llvm::cas::ObjectRef>
1766+
setupIncludeTreeInput(clang::CompilerInvocation &invocation,
1767+
StringRef headerPath, StringRef pchIncludeTree) {
1768+
auto DB = invocation.getCASOpts().getOrCreateDatabases();
1769+
if (!DB)
1770+
return DB.takeError();
1771+
auto CAS = DB->first;
1772+
auto ID = CAS->parseID(pchIncludeTree);
1773+
if (!ID)
1774+
return ID.takeError();
1775+
auto includeTreeRef = CAS->getReference(*ID);
1776+
if (!includeTreeRef)
1777+
return llvm::cas::ObjectStore::createUnknownObjectError(*ID);
1778+
1779+
invocation.getFrontendOpts().Inputs.push_back(clang::FrontendInputFile(
1780+
*includeTreeRef, headerPath, clang::Language::ObjC));
1781+
1782+
return *includeTreeRef;
1783+
}
1784+
1785+
std::string ClangImporter::getBridgingHeaderContents(
1786+
StringRef headerPath, off_t &fileSize, time_t &fileModTime,
1787+
StringRef pchIncludeTree) {
17611788
auto invocation =
17621789
std::make_shared<clang::CompilerInvocation>(*Impl.Invocation);
17631790

17641791
invocation->getFrontendOpts().DisableFree = false;
17651792
invocation->getFrontendOpts().Inputs.clear();
1766-
invocation->getFrontendOpts().Inputs.push_back(
1767-
clang::FrontendInputFile(headerPath, clang::Language::ObjC));
1793+
1794+
std::optional<llvm::cas::ObjectRef> includeTreeRef;
1795+
if (pchIncludeTree.empty())
1796+
invocation->getFrontendOpts().Inputs.push_back(
1797+
clang::FrontendInputFile(headerPath, clang::Language::ObjC));
1798+
else if (auto err =
1799+
setupIncludeTreeInput(*invocation, headerPath, pchIncludeTree)
1800+
.moveInto(includeTreeRef)) {
1801+
Impl.diagnose({}, diag::err_rewrite_bridging_header,
1802+
toString(std::move(err)));
1803+
return "";
1804+
}
17681805

17691806
invocation->getPreprocessorOpts().resetNonModularOptions();
17701807

@@ -1785,18 +1822,36 @@ std::string ClangImporter::getBridgingHeaderContents(StringRef headerPath,
17851822
// write to an in-memory buffer.
17861823
class RewriteIncludesAction : public clang::PreprocessorFrontendAction {
17871824
raw_ostream &OS;
1825+
std::optional<llvm::cas::ObjectRef> includeTreeRef;
17881826

17891827
void ExecuteAction() override {
17901828
clang::CompilerInstance &compiler = getCompilerInstance();
1829+
// If the input is include tree, setup the IncludeTreePPAction.
1830+
if (includeTreeRef) {
1831+
auto IncludeTreeRoot = clang::cas::IncludeTreeRoot::get(
1832+
compiler.getOrCreateObjectStore(), *includeTreeRef);
1833+
if (!IncludeTreeRoot)
1834+
llvm::report_fatal_error(IncludeTreeRoot.takeError());
1835+
auto PPCachedAct =
1836+
clang::createPPActionsFromIncludeTree(*IncludeTreeRoot);
1837+
if (!PPCachedAct)
1838+
llvm::report_fatal_error(PPCachedAct.takeError());
1839+
compiler.getPreprocessor().setPPCachedActions(
1840+
std::move(*PPCachedAct));
1841+
}
1842+
17911843
clang::RewriteIncludesInInput(compiler.getPreprocessor(), &OS,
17921844
compiler.getPreprocessorOutputOpts());
17931845
}
1846+
17941847
public:
1795-
explicit RewriteIncludesAction(raw_ostream &os) : OS(os) {}
1848+
explicit RewriteIncludesAction(
1849+
raw_ostream &os, std::optional<llvm::cas::ObjectRef> includeTree)
1850+
: OS(os), includeTreeRef(includeTree) {}
17961851
};
17971852

17981853
llvm::raw_string_ostream os(result);
1799-
RewriteIncludesAction action(os);
1854+
RewriteIncludesAction action(os, includeTreeRef);
18001855
rewriteInstance.ExecuteAction(action);
18011856
});
18021857

@@ -2517,6 +2572,7 @@ ClangImporter::Implementation::Implementation(
25172572
!ctx.ClangImporterOpts.BridgingHeader.empty()),
25182573
DisableOverlayModules(ctx.ClangImporterOpts.DisableOverlayModules),
25192574
EnableClangSPI(ctx.ClangImporterOpts.EnableClangSPI),
2575+
UseClangIncludeTree(ctx.ClangImporterOpts.UseClangIncludeTree),
25202576
importSymbolicCXXDecls(
25212577
ctx.LangOpts.hasFeature(Feature::ImportSymbolicCXXDecls)),
25222578
IsReadingBridgingPCH(false),

‎lib/ClangImporter/ImporterImpl.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -467,6 +467,7 @@ class LLVM_LIBRARY_VISIBILITY ClangImporter::Implementation
467467
const bool BridgingHeaderExplicitlyRequested;
468468
const bool DisableOverlayModules;
469469
const bool EnableClangSPI;
470+
const bool UseClangIncludeTree;
470471
bool importSymbolicCXXDecls;
471472

472473
bool IsReadingBridgingPCH;

‎lib/Serialization/Serialization.cpp

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1321,21 +1321,25 @@ void Serializer::writeInputBlock() {
13211321
time_t importedHeaderModTime = 0;
13221322
std::string contents;
13231323
auto importedHeaderPath = Options.ImportedHeader;
1324+
std::string pchIncludeTree;
13241325
// We do not want to serialize the explicitly-specified .pch path if one was
13251326
// provided. Instead we write out the path to the original header source so
13261327
// that clients can consume it.
13271328
if (Options.ExplicitModuleBuild &&
13281329
llvm::sys::path::extension(importedHeaderPath)
1329-
.ends_with(file_types::getExtension(file_types::TY_PCH)))
1330-
importedHeaderPath = clangImporter->getClangInstance()
1331-
.getASTReader()
1332-
->getModuleManager()
1333-
.lookupByFileName(importedHeaderPath)
1334-
->OriginalSourceFileName;
1330+
.ends_with(file_types::getExtension(file_types::TY_PCH))) {
1331+
auto *pch = clangImporter->getClangInstance()
1332+
.getASTReader()
1333+
->getModuleManager()
1334+
.lookupByFileName(importedHeaderPath);
1335+
pchIncludeTree = pch->IncludeTreeID;
1336+
importedHeaderPath = pch->OriginalSourceFileName;
1337+
}
13351338

13361339
if (!importedHeaderPath.empty()) {
13371340
contents = clangImporter->getBridgingHeaderContents(
1338-
importedHeaderPath, importedHeaderSize, importedHeaderModTime);
1341+
importedHeaderPath, importedHeaderSize, importedHeaderModTime,
1342+
pchIncludeTree);
13391343
}
13401344
assert(publicImportSet.count(bridgingHeaderImport));
13411345
ImportedHeader.emit(ScratchRecord,

‎test/CAS/bridging-header.swift

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
// RUN: %empty-directory(%t)
22
// RUN: split-file %s %t
33

4+
// RUN: %target-swift-frontend -emit-module -o %t/temp.swiftmodule -module-name Test -swift-version 5 \
5+
// RUN: -disable-implicit-string-processing-module-import -disable-implicit-concurrency-module-import \
6+
// RUN: -Xcc -fmodule-map-file=%t/a.modulemap -Xcc -fmodule-map-file=%t/b.modulemap -import-objc-header %t/Bridging.h \
7+
// RUN: %t/test.swift
8+
49
// RUN: %target-swift-frontend -scan-dependencies -module-name Test -module-cache-path %t/clang-module-cache -O \
510
// RUN: -disable-implicit-string-processing-module-import -disable-implicit-concurrency-module-import \
611
// RUN: %t/test.swift -o %t/deps.json -swift-version 5 -cache-compile-job -cas-path %t/cas \
@@ -25,9 +30,57 @@
2530
// CHECK-NEXT: "-Xcc",
2631
// CHECK-NEXT: "llvmcas://{{.*}}"
2732

33+
/// Try build then import from a non-caching compilation.
34+
35+
// RUN: %{python} %S/Inputs/BuildCommandExtractor.py %t/deps.json clang:SwiftShims > %t/shim.cmd
36+
// RUN: %swift_frontend_plain @%t/shim.cmd
37+
// RUN: %{python} %S/Inputs/BuildCommandExtractor.py %t/deps.json clang:B > %t/B.cmd
38+
// RUN: %swift_frontend_plain @%t/B.cmd
39+
// RUN: %{python} %S/Inputs/BuildCommandExtractor.py %t/deps.json clang:A > %t/A.cmd
40+
// RUN: %swift_frontend_plain @%t/A.cmd
41+
42+
// RUN: %{python} %S/Inputs/GenerateExplicitModuleMap.py %t/deps.json > %t/map.json
43+
// RUN: llvm-cas --cas %t/cas --make-blob --data %t/map.json > %t/map.casid
44+
45+
// RUN: %{python} %S/Inputs/BuildCommandExtractor.py %t/deps.json bridgingHeader | tail -n +2 > %t/header.cmd
46+
// RUN: %target-swift-frontend @%t/header.cmd -disable-implicit-swift-modules %t/Bridging.h -O -o %t/bridging.pch
47+
// RUN: %cache-tool -cas-path %t/cas -cache-tool-action print-output-keys -- \
48+
// RUN: %target-swift-frontend @%t/header.cmd -disable-implicit-swift-modules %t/Bridging.h -O -o %t/bridging.pch > %t/keys.json
49+
// RUN: %{python} %S/Inputs/ExtractOutputKey.py %t/keys.json %t/Bridging.h > %t/key
50+
51+
// RUN: %{python} %S/Inputs/BuildCommandExtractor.py %t/deps.json Test > %t/MyApp.cmd
52+
// RUN: echo "\"-disable-implicit-string-processing-module-import\"" >> %t/MyApp.cmd
53+
// RUN: echo "\"-disable-implicit-concurrency-module-import\"" >> %t/MyApp.cmd
54+
// RUN: echo "\"-disable-implicit-swift-modules\"" >> %t/MyApp.cmd
55+
// RUN: echo "\"-import-objc-header\"" >> %t/MyApp.cmd
56+
// RUN: echo "\"%t/bridging.pch\"" >> %t/MyApp.cmd
57+
// RUN: echo "\"-bridging-header-pch-key\"" >> %t/MyApp.cmd
58+
// RUN: echo "\"@%t/key\"" >> %t/MyApp.cmd
59+
// RUN: echo "\"-explicit-swift-module-map-file\"" >> %t/MyApp.cmd
60+
// RUN: echo "\"@%t/map.casid\"" >> %t/MyApp.cmd
61+
62+
// RUN: %target-swift-frontend -cache-compile-job -module-name Test -O -cas-path %t/cas @%t/MyApp.cmd %t/test.swift \
63+
// RUN: -emit-module -o %t/Test.swiftmodule
64+
65+
// RUN: %target-swift-frontend -typecheck -module-name User -swift-version 5 \
66+
// RUN: -disable-implicit-string-processing-module-import -disable-implicit-concurrency-module-import \
67+
// RUN: -Xcc -fmodule-map-file=%t/a.modulemap -Xcc -fmodule-map-file=%t/b.modulemap \
68+
// RUN: -I %t %t/user.swift
69+
2870
//--- test.swift
2971
import B
30-
public func test() {}
72+
public func test() {
73+
b()
74+
}
75+
public class TestB: B {}
76+
77+
//--- user.swift
78+
import Test
79+
80+
func user() {
81+
var b: TestB
82+
test()
83+
}
3184

3285
//--- Bridging.h
3386
#include "Foo.h"
@@ -40,6 +93,8 @@ public func test() {}
4093

4194
//--- b.h
4295
void b(void);
96+
@interface B
97+
@end
4398
4499
//--- a.modulemap
45100
module A {

0 commit comments

Comments
 (0)