Skip to content

Commit cffb637

Browse files
daniel-grumbergdaniel-grumberg
authored
Merge pull request #73080 from daniel-grumberg/export-import-sgf-extract
[SymbolGraphGen] Correctly handle exported imports in swift-symbolgraph-extract
2 parents 8f59806 + f152885 commit cffb637

File tree

16 files changed

+270
-124
lines changed

16 files changed

+270
-124
lines changed

‎include/swift/AST/Module.h‎

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
#define SWIFT_MODULE_H
1919

2020
#include "swift/AST/AccessNotes.h"
21+
#include "swift/AST/AttrKind.h"
2122
#include "swift/AST/Decl.h"
2223
#include "swift/AST/DeclContext.h"
2324
#include "swift/AST/Identifier.h"
@@ -551,7 +552,7 @@ class ModuleDecl
551552
ModuleDecl *getUnderlyingModuleIfOverlay() const;
552553

553554
/// Returns true if this module is the Clang overlay of \p other.
554-
bool isClangOverlayOf(ModuleDecl *other);
555+
bool isClangOverlayOf(ModuleDecl *other) const;
555556

556557
/// Returns true if this module is the same module or either module is a clang
557558
/// overlay of the other.
@@ -1094,6 +1095,24 @@ class ModuleDecl
10941095
/// for that.
10951096
void getDisplayDecls(SmallVectorImpl<Decl*> &results, bool recursive = false) const;
10961097

1098+
struct ImportCollector {
1099+
SmallPtrSet<const ModuleDecl *, 4> imports;
1100+
llvm::SmallDenseMap<const ModuleDecl *, SmallPtrSet<Decl *, 4>, 4>
1101+
qualifiedImports;
1102+
AccessLevel minimumDocVisibility = AccessLevel::Private;
1103+
llvm::function_ref<bool(const ModuleDecl *)> importFilter = nullptr;
1104+
1105+
void collect(const ImportedModule &importedModule);
1106+
1107+
ImportCollector() = default;
1108+
ImportCollector(AccessLevel minimumDocVisibility)
1109+
: minimumDocVisibility(minimumDocVisibility) {}
1110+
};
1111+
1112+
void
1113+
getDisplayDeclsRecursivelyAndImports(SmallVectorImpl<Decl *> &results,
1114+
ImportCollector &importCollector) const;
1115+
10971116
using LinkLibraryCallback = llvm::function_ref<void(LinkLibrary)>;
10981117

10991118
/// Generate the list of libraries needed to link this module, based on its
@@ -1273,12 +1292,6 @@ inline SourceLoc extractNearestSourceLoc(const ModuleDecl *mod) {
12731292
return extractNearestSourceLoc(static_cast<const Decl *>(mod));
12741293
}
12751294

1276-
/// Collects modules that this module imports via `@_exported import`.
1277-
void collectParsedExportedImports(const ModuleDecl *M,
1278-
SmallPtrSetImpl<ModuleDecl *> &Imports,
1279-
llvm::SmallDenseMap<ModuleDecl *, SmallPtrSet<Decl *, 4>, 4> &QualifiedImports,
1280-
llvm::function_ref<bool(AttributedImport<ImportedModule>)> includeImport = nullptr);
1281-
12821295
/// If the import that would make the given declaration visibile is absent,
12831296
/// emit a diagnostic and a fix-it suggesting adding the missing import.
12841297
bool diagnoseMissingImportForMember(const ValueDecl *decl,

‎include/swift/Option/Options.td‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1573,6 +1573,10 @@ def output_dir : Separate<["-"], "output-dir">,
15731573
HelpText<"Output directory">,
15741574
MetaVarName<"<dir>">;
15751575

1576+
def experimental_allowed_reexported_modules: CommaJoined<["-"], "experimental-allowed-reexported-modules=">,
1577+
Flags<[NoDriverOption, SwiftSymbolGraphExtractOption]>,
1578+
HelpText<"Allow reexporting symbols from the provided modules if they are themselves exported from the main module. This is a comma separated list of module names.">;
1579+
15761580
def skip_synthesized_members: Flag<[ "-" ], "skip-synthesized-members">,
15771581
Flags<[NoDriverOption, SwiftSymbolGraphExtractOption]>,
15781582
HelpText<"Skip members inherited through classes or default implementations">;

‎include/swift/Sema/IDETypeChecking.h‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -162,6 +162,15 @@ namespace swift {
162162
void
163163
getTopLevelDeclsForDisplay(ModuleDecl *M, SmallVectorImpl<Decl*> &Results, bool Recursive = false);
164164

165+
/// Get all of the top-level declarations that should be printed as part of
166+
/// this module. This may force synthesis of top-level declarations that
167+
/// \p getDisplayDeclsForModule would only return if previous
168+
/// work happened to have synthesized them.
169+
void getTopLevelDeclsForDisplay(
170+
ModuleDecl *M, SmallVectorImpl<Decl *> &Results,
171+
llvm::function_ref<void(ModuleDecl *, SmallVectorImpl<Decl *> &)>
172+
getDisplayDeclsForModule);
173+
165174
struct ExtensionInfo {
166175
// The extension with the declarations to apply.
167176
ExtensionDecl *Ext;

‎include/swift/SymbolGraphGen/SymbolGraphOptions.h‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
//===----------------------------------------------------------------------===//
1212

1313
#include "llvm/TargetParser/Triple.h"
14+
#include "llvm/ADT/ArrayRef.h"
15+
1416
#include "swift/AST/AttrKind.h"
1517

1618
#ifndef SWIFT_SYMBOLGRAPHGEN_SYMBOLGRAPHOPTIONS_H
@@ -63,6 +65,10 @@ struct SymbolGraphOptions {
6365
/// but SourceKit should be able to load the information when pulling symbol
6466
/// information for individual queries.
6567
bool PrintPrivateStdlibSymbols = false;
68+
69+
/// If this has a value specifies an explicit allow list of reexported module
70+
/// names that should be included symbol graph.
71+
std::optional<llvm::ArrayRef<StringRef>> AllowedReexportedModules = {};
6672
};
6773

6874
} // end namespace symbolgraphgen

‎lib/AST/Module.cpp‎

Lines changed: 91 additions & 64 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
#include "swift/AST/ExistentialLayout.h"
2727
#include "swift/AST/FileUnit.h"
2828
#include "swift/AST/GenericEnvironment.h"
29+
#include "swift/AST/Import.h"
2930
#include "swift/AST/ImportCache.h"
3031
#include "swift/AST/LazyResolver.h"
3132
#include "swift/AST/LinkLibrary.h"
@@ -39,6 +40,7 @@
3940
#include "swift/AST/ProtocolConformance.h"
4041
#include "swift/AST/SourceFile.h"
4142
#include "swift/AST/SynthesizedFileUnit.h"
43+
#include "swift/AST/Type.h"
4244
#include "swift/AST/TypeCheckRequests.h"
4345
#include "swift/Basic/Compiler.h"
4446
#include "swift/Basic/SourceManager.h"
@@ -1288,42 +1290,6 @@ bool ModuleDecl::shouldCollectDisplayDecls() const {
12881290
return true;
12891291
}
12901292

1291-
void swift::collectParsedExportedImports(const ModuleDecl *M,
1292-
SmallPtrSetImpl<ModuleDecl *> &Imports,
1293-
llvm::SmallDenseMap<ModuleDecl *, SmallPtrSet<Decl *, 4>, 4> &QualifiedImports,
1294-
llvm::function_ref<bool(AttributedImport<ImportedModule>)> includeImport) {
1295-
for (const FileUnit *file : M->getFiles()) {
1296-
if (const SourceFile *source = dyn_cast<SourceFile>(file)) {
1297-
if (source->hasImports()) {
1298-
for (auto import : source->getImports()) {
1299-
if (import.options.contains(ImportFlags::Exported) &&
1300-
(!includeImport || includeImport(import)) &&
1301-
import.module.importedModule->shouldCollectDisplayDecls()) {
1302-
auto *TheModule = import.module.importedModule;
1303-
1304-
if (import.module.getAccessPath().size() > 0) {
1305-
if (QualifiedImports.find(TheModule) == QualifiedImports.end()) {
1306-
QualifiedImports.try_emplace(TheModule);
1307-
}
1308-
auto collectDecls = [&](ValueDecl *VD,
1309-
DeclVisibilityKind reason) {
1310-
if (reason == DeclVisibilityKind::VisibleAtTopLevel)
1311-
QualifiedImports[TheModule].insert(VD);
1312-
};
1313-
auto consumer = makeDeclConsumer(std::move(collectDecls));
1314-
TheModule->lookupVisibleDecls(
1315-
import.module.getAccessPath(), consumer,
1316-
NLKind::UnqualifiedLookup);
1317-
} else if (!Imports.contains(TheModule)) {
1318-
Imports.insert(TheModule);
1319-
}
1320-
}
1321-
}
1322-
}
1323-
}
1324-
}
1325-
}
1326-
13271293
void ModuleDecl::getLocalTypeDecls(SmallVectorImpl<TypeDecl*> &Results) const {
13281294
FORWARD(getLocalTypeDecls, (Results));
13291295
}
@@ -1544,40 +1510,101 @@ SourceFile::getExternalRawLocsForDecl(const Decl *D) const {
15441510
return Result;
15451511
}
15461512

1547-
void ModuleDecl::getDisplayDecls(SmallVectorImpl<Decl*> &Results, bool Recursive) const {
1548-
if (Recursive && isParsedModule(this)) {
1549-
SmallPtrSet<ModuleDecl *, 4> Modules;
1550-
llvm::SmallDenseMap<ModuleDecl *, SmallPtrSet<Decl *, 4>, 4> QualifiedImports;
1551-
collectParsedExportedImports(this, Modules, QualifiedImports);
1552-
for (const auto &QI : QualifiedImports) {
1553-
auto Module = QI.getFirst();
1554-
if (Modules.contains(Module)) continue;
1513+
void ModuleDecl::ImportCollector::collect(
1514+
const ImportedModule &importedModule) {
1515+
auto *module = importedModule.importedModule;
15551516

1556-
auto &Decls = QI.getSecond();
1557-
Results.append(Decls.begin(), Decls.end());
1558-
}
1559-
for (const ModuleDecl *import : Modules) {
1560-
import->getDisplayDecls(Results, Recursive);
1517+
if (!module->shouldCollectDisplayDecls())
1518+
return;
1519+
1520+
if (importFilter && !importFilter(module))
1521+
return;
1522+
1523+
if (importedModule.getAccessPath().size() > 0) {
1524+
auto collectDecls = [&](ValueDecl *VD, DeclVisibilityKind reason) {
1525+
if (reason == DeclVisibilityKind::VisibleAtTopLevel)
1526+
this->qualifiedImports[module].insert(VD);
1527+
};
1528+
auto consumer = makeDeclConsumer(std::move(collectDecls));
1529+
module->lookupVisibleDecls(importedModule.getAccessPath(), consumer,
1530+
NLKind::UnqualifiedLookup);
1531+
} else {
1532+
imports.insert(module);
1533+
}
1534+
}
1535+
1536+
static void
1537+
collectExportedImports(const ModuleDecl *module,
1538+
ModuleDecl::ImportCollector &importCollector) {
1539+
for (const FileUnit *file : module->getFiles()) {
1540+
if (const SourceFile *source = dyn_cast<SourceFile>(file)) {
1541+
if (source->hasImports()) {
1542+
for (const auto &import : source->getImports()) {
1543+
if (import.options.contains(ImportFlags::Exported) &&
1544+
import.docVisibility.value_or(AccessLevel::Public) >=
1545+
importCollector.minimumDocVisibility) {
1546+
importCollector.collect(import.module);
1547+
collectExportedImports(import.module.importedModule,
1548+
importCollector);
1549+
}
1550+
}
1551+
}
1552+
} else {
1553+
SmallVector<ImportedModule, 8> exportedImports;
1554+
file->getImportedModules(exportedImports,
1555+
ModuleDecl::ImportFilterKind::Exported);
1556+
for (const auto &im : exportedImports) {
1557+
// Skip collecting the underlying clang module as we already have the relevant import.
1558+
if (module->isClangOverlayOf(im.importedModule))
1559+
continue;
1560+
importCollector.collect(im);
1561+
collectExportedImports(im.importedModule, importCollector);
1562+
}
15611563
}
15621564
}
1563-
// FIXME: Should this do extra access control filtering?
1564-
FORWARD(getDisplayDecls, (Results));
1565+
}
15651566

1566-
#ifndef NDEBUG
1567+
void ModuleDecl::getDisplayDecls(SmallVectorImpl<Decl*> &Results, bool Recursive) const {
15671568
if (Recursive) {
1568-
llvm::DenseSet<Decl *> visited;
1569-
for (auto *D : Results) {
1570-
// decls synthesized from implicit clang decls may appear multiple times;
1571-
// e.g. if multiple modules with underlying clang modules are re-exported.
1572-
// including duplicates of these is harmless, so skip them when counting
1573-
// this assertion
1574-
if (const auto *CD = D->getClangDecl()) {
1575-
if (CD->isImplicit()) continue;
1576-
}
1569+
ImportCollector importCollector;
1570+
this->getDisplayDeclsRecursivelyAndImports(Results, importCollector);
1571+
} else {
1572+
// FIXME: Should this do extra access control filtering?
1573+
FORWARD(getDisplayDecls, (Results));
1574+
}
1575+
}
1576+
1577+
void ModuleDecl::getDisplayDeclsRecursivelyAndImports(
1578+
SmallVectorImpl<Decl *> &results, ImportCollector &importCollector) const {
1579+
this->getDisplayDecls(results, /*Recursive=*/false);
1580+
1581+
// Look up imports recursively.
1582+
collectExportedImports(this, importCollector);
1583+
for (const auto &QI : importCollector.qualifiedImports) {
1584+
auto Module = QI.getFirst();
1585+
if (importCollector.imports.contains(Module))
1586+
continue;
15771587

1578-
auto inserted = visited.insert(D).second;
1579-
assert(inserted && "there should be no duplicate decls");
1588+
auto &Decls = QI.getSecond();
1589+
results.append(Decls.begin(), Decls.end());
1590+
}
1591+
1592+
for (const ModuleDecl *import : importCollector.imports)
1593+
import->getDisplayDecls(results);
1594+
1595+
#ifndef NDEBUG
1596+
llvm::DenseSet<Decl *> visited;
1597+
for (auto *D : results) {
1598+
// decls synthesized from implicit clang decls may appear multiple times;
1599+
// e.g. if multiple modules with underlying clang modules are re-exported.
1600+
// including duplicates of these is harmless, so skip them when counting
1601+
// this assertion
1602+
if (const auto *CD = D->getClangDecl()) {
1603+
if (CD->isImplicit())
1604+
continue;
15801605
}
1606+
auto inserted = visited.insert(D).second;
1607+
assert(inserted && "there should be no duplicate decls");
15811608
}
15821609
#endif
15831610
}
@@ -2394,7 +2421,7 @@ ModuleDecl::getDeclaringModuleAndBystander() {
23942421
return *(declaringModuleAndBystander = {nullptr, Identifier()});
23952422
}
23962423

2397-
bool ModuleDecl::isClangOverlayOf(ModuleDecl *potentialUnderlying) {
2424+
bool ModuleDecl::isClangOverlayOf(ModuleDecl *potentialUnderlying) const {
23982425
return getUnderlyingModuleIfOverlay() == potentialUnderlying;
23992426
}
24002427

‎lib/DriverTool/swift_symbolgraph_extract_main.cpp‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,13 @@ int swift_symbolgraph_extract_main(ArrayRef<const char *> Args,
163163
}
164164
}
165165

166+
SmallVector<StringRef, 4> AllowedRexports;
167+
if (auto *A =
168+
ParsedArgs.getLastArg(OPT_experimental_allowed_reexported_modules)) {
169+
for (const auto *val : A->getValues())
170+
AllowedRexports.emplace_back(val);
171+
}
172+
166173
symbolgraphgen::SymbolGraphOptions Options;
167174
Options.OutputDir = OutputDir;
168175
Options.Target = Target;
@@ -175,6 +182,7 @@ int swift_symbolgraph_extract_main(ArrayRef<const char *> Args,
175182
Options.EmitExtensionBlockSymbols =
176183
ParsedArgs.hasFlag(OPT_emit_extension_block_symbols,
177184
OPT_omit_extension_block_symbols, /*default=*/false);
185+
Options.AllowedReexportedModules = AllowedRexports;
178186

179187
if (auto *A = ParsedArgs.getLastArg(OPT_minimum_access_level)) {
180188
Options.MinimumAccessLevel =

‎lib/IDE/IDETypeChecking.cpp‎

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@
1010
//
1111
//===----------------------------------------------------------------------===//
1212

13+
#include "swift/Sema/IDETypeChecking.h"
14+
#include "swift/AST/ASTContext.h"
1315
#include "swift/AST/ASTDemangler.h"
1416
#include "swift/AST/ASTPrinter.h"
15-
#include "swift/AST/ASTContext.h"
1617
#include "swift/AST/Attr.h"
1718
#include "swift/AST/Decl.h"
1819
#include "swift/AST/Expr.h"
@@ -25,20 +26,30 @@
2526
#include "swift/AST/Requirement.h"
2627
#include "swift/AST/SourceFile.h"
2728
#include "swift/AST/Types.h"
28-
#include "swift/Sema/IDETypeChecking.h"
29-
#include "swift/Sema/IDETypeCheckingRequests.h"
30-
#include "swift/IDE/SourceEntityWalker.h"
3129
#include "swift/IDE/IDERequests.h"
30+
#include "swift/IDE/SourceEntityWalker.h"
3231
#include "swift/Parse/Lexer.h"
32+
#include "swift/Sema/IDETypeCheckingRequests.h"
33+
#include "llvm/ADT/SmallVector.h"
3334

3435
using namespace swift;
3536

36-
void
37-
swift::getTopLevelDeclsForDisplay(ModuleDecl *M,
38-
SmallVectorImpl<Decl*> &Results,
39-
bool Recursive) {
37+
void swift::getTopLevelDeclsForDisplay(ModuleDecl *M,
38+
SmallVectorImpl<Decl *> &Results,
39+
bool Recursive) {
40+
auto getDisplayDeclsForModule =
41+
[Recursive](ModuleDecl *M, SmallVectorImpl<Decl *> &Results) {
42+
M->getDisplayDecls(Results, Recursive);
43+
};
44+
getTopLevelDeclsForDisplay(M, Results, std::move(getDisplayDeclsForModule));
45+
}
46+
47+
void swift::getTopLevelDeclsForDisplay(
48+
ModuleDecl *M, SmallVectorImpl<Decl *> &Results,
49+
llvm::function_ref<void(ModuleDecl *, SmallVectorImpl<Decl *> &)>
50+
getDisplayDeclsForModule) {
4051
auto startingSize = Results.size();
41-
M->getDisplayDecls(Results, Recursive);
52+
getDisplayDeclsForModule(M, Results);
4253

4354
// Force Sendable on all public types, which might synthesize some extensions.
4455
// FIXME: We can remove this if @_nonSendable stops creating extensions.
@@ -48,20 +59,20 @@ swift::getTopLevelDeclsForDisplay(ModuleDecl *M,
4859
// Restrict this logic to public and package types. Non-public types
4960
// may refer to implementation details and fail at deserialization.
5061
auto accessScope = NTD->getFormalAccessScope();
51-
if (!M->isMainModule() &&
52-
!accessScope.isPublic() && !accessScope.isPackage())
62+
if (!M->isMainModule() && !accessScope.isPublic() &&
63+
!accessScope.isPackage())
5364
continue;
5465

5566
auto proto = M->getASTContext().getProtocol(KnownProtocolKind::Sendable);
5667
if (proto)
57-
(void) M->lookupConformance(NTD->getDeclaredInterfaceType(), proto);
68+
(void)M->lookupConformance(NTD->getDeclaredInterfaceType(), proto);
5869
}
5970
}
6071

6172
// Remove what we fetched and fetch again, possibly now with additional
6273
// extensions.
6374
Results.resize(startingSize);
64-
M->getDisplayDecls(Results, Recursive);
75+
getDisplayDeclsForModule(M, Results);
6576
}
6677

6778
static bool shouldPrintAsFavorable(const Decl *D, const PrintOptions &Options) {

0 commit comments

Comments
 (0)