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
|
//===--- TBD.cpp -- generates and validates TBD files ---------------------===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2017 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
//
//===----------------------------------------------------------------------===//
#include "TBD.h"
#include "swift/AST/ASTContext.h"
#include "swift/AST/Decl.h"
#include "swift/AST/DiagnosticEngine.h"
#include "swift/AST/DiagnosticsFrontend.h"
#include "swift/AST/FileSystem.h"
#include "swift/AST/FileUnit.h"
#include "swift/AST/Module.h"
#include "swift/AST/TBDGenRequests.h"
#include "swift/Basic/LLVM.h"
#include "swift/Demangling/Demangle.h"
#include "swift/Frontend/FrontendOptions.h"
#include "swift/IRGen/TBDGen.h"
#include "llvm/ADT/StringRef.h"
#include "llvm/ADT/StringSet.h"
#include "llvm/IR/Module.h"
#include "llvm/IR/Mangler.h"
#include "llvm/IR/ValueSymbolTable.h"
#include "llvm/Support/FileSystem.h"
#include "llvm/Support/VirtualOutputBackend.h"
#include <vector>
using namespace swift;
static std::vector<StringRef> sortSymbols(llvm::StringSet<> &symbols) {
std::vector<StringRef> sorted;
for (auto &symbol : symbols)
sorted.push_back(symbol.getKey());
std::sort(sorted.begin(), sorted.end());
return sorted;
}
bool swift::writeTBD(ModuleDecl *M, StringRef OutputFilename,
llvm::vfs::OutputBackend &Backend,
const TBDGenOptions &Opts) {
return withOutputPath(M->getDiags(), Backend, OutputFilename,
[&](raw_ostream &OS) -> bool {
writeTBDFile(M, OS, Opts);
return false;
});
}
static bool validateSymbols(DiagnosticEngine &diags,
const std::vector<std::string> &symbols,
const llvm::Module &IRModule,
bool diagnoseExtraSymbolsInTBD) {
llvm::StringSet<> symbolSet;
symbolSet.insert(symbols.begin(), symbols.end());
auto error = false;
// Diff the two sets of symbols, flagging anything outside their intersection.
// Delay the emission of errors for things in the IR but not TBD, so we can
// sort them to get a stable order.
std::vector<StringRef> irNotTBD;
for (auto &nameValue : IRModule.getValueSymbolTable()) {
// TBDGen inserts mangled names (usually with a leading '_') into its
// symbol table, so make sure to mangle IRGen names before comparing them
// with what TBDGen created.
auto unmangledName = nameValue.getKey();
SmallString<128> name;
llvm::Mangler::getNameWithPrefix(name, unmangledName,
IRModule.getDataLayout());
auto value = nameValue.getValue();
if (auto GV = dyn_cast<llvm::GlobalValue>(value)) {
// Is this a symbol that should be listed?
auto externallyVisible =
(GV->hasExternalLinkage() || GV->hasCommonLinkage())
&& !GV->hasHiddenVisibility();
if (!GV->isDeclaration() && externallyVisible) {
// Is it listed?
if (!symbolSet.erase(name))
// Note: Add the unmangled name to the irNotTBD list, which is owned
// by the IRModule, instead of the mangled name.
irNotTBD.push_back(unmangledName);
}
} else {
assert(!symbolSet.contains(name) &&
"non-global value in value symbol table");
}
}
std::sort(irNotTBD.begin(), irNotTBD.end());
for (auto &name : irNotTBD) {
diags.diagnose(SourceLoc(), diag::symbol_in_ir_not_in_tbd, name,
Demangle::demangleSymbolAsString(name));
error = true;
}
if (diagnoseExtraSymbolsInTBD) {
// Look for any extra symbols.
for (auto &name : sortSymbols(symbolSet)) {
diags.diagnose(SourceLoc(), diag::symbol_in_tbd_not_in_ir, name,
Demangle::demangleSymbolAsString(name));
error = true;
}
}
if (error) {
diags.diagnose(SourceLoc(), diag::tbd_validation_failure);
}
return error;
}
bool swift::validateTBD(ModuleDecl *M,
const llvm::Module &IRModule,
const TBDGenOptions &opts,
bool diagnoseExtraSymbolsInTBD) {
auto symbols = getPublicSymbols(TBDGenDescriptor::forModule(M, opts));
return validateSymbols(M->getASTContext().Diags, symbols, IRModule,
diagnoseExtraSymbolsInTBD);
}
bool swift::validateTBD(FileUnit *file,
const llvm::Module &IRModule,
const TBDGenOptions &opts,
bool diagnoseExtraSymbolsInTBD) {
auto symbols = getPublicSymbols(TBDGenDescriptor::forFile(file, opts));
return validateSymbols(file->getParentModule()->getASTContext().Diags,
symbols, IRModule, diagnoseExtraSymbolsInTBD);
}
|
