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
|
//===--- Evaluator.cpp - Request Evaluator Implementation -----------------===//
//
// 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
//
//===----------------------------------------------------------------------===//
//
// This file implements the Evaluator class that evaluates and caches
// requests.
//
//===----------------------------------------------------------------------===//
#include "swift/AST/Evaluator.h"
#include "swift/AST/DeclContext.h"
#include "swift/AST/DiagnosticEngine.h"
#include "swift/AST/TypeCheckRequests.h" // for ResolveMacroRequest
#include "swift/Basic/LangOptions.h"
#include "swift/Basic/Range.h"
#include "swift/Basic/SourceManager.h"
#include "llvm/ADT/StringExtras.h"
#include "llvm/Support/Debug.h"
#include "llvm/Support/SaveAndRestore.h"
#include <vector>
using namespace swift;
AbstractRequestFunction *
Evaluator::getAbstractRequestFunction(uint8_t zoneID, uint8_t requestID) const {
for (const auto &zone : requestFunctionsByZone) {
if (zone.first == zoneID) {
if (requestID < zone.second.size())
return zone.second[requestID];
return nullptr;
}
}
return nullptr;
}
void Evaluator::registerRequestFunctions(
Zone zone,
ArrayRef<AbstractRequestFunction *> functions) {
uint8_t zoneID = static_cast<uint8_t>(zone);
#ifndef NDEBUG
for (const auto &zone : requestFunctionsByZone) {
assert(zone.first != zoneID);
}
#endif
requestFunctionsByZone.push_back({zoneID, functions});
}
Evaluator::Evaluator(DiagnosticEngine &diags, const LangOptions &opts)
: diags(diags),
debugDumpCycles(opts.DebugDumpCycles),
recorder(opts.RecordRequestReferences) {}
SourceLoc Evaluator::getInnermostSourceLoc(
llvm::function_ref<bool(SourceLoc)> fn) {
for (auto request : llvm::reverse(activeRequests)) {
SourceLoc loc = request.getNearestLoc();
if (fn(loc))
return loc;
}
return SourceLoc();
}
bool Evaluator::checkDependency(const ActiveRequest &request) {
// Record this as an active request.
if (activeRequests.insert(request)) {
return false;
}
// Diagnose cycle.
diagnoseCycle(request);
return true;
}
void Evaluator::finishedRequest(const ActiveRequest &request) {
assert(activeRequests.back() == request);
activeRequests.pop_back();
}
void Evaluator::diagnoseCycle(const ActiveRequest &request) {
if (debugDumpCycles) {
const auto printIndent = [](llvm::raw_ostream &OS, unsigned indent) {
OS.indent(indent);
OS << "`--";
};
unsigned indent = 1;
auto &OS = llvm::errs();
OS << "===CYCLE DETECTED===\n";
for (const auto &step : activeRequests) {
printIndent(OS, indent);
if (step == request) {
OS.changeColor(llvm::raw_ostream::GREEN);
simple_display(OS, step);
OS.resetColor();
} else {
simple_display(OS, step);
}
OS << "\n";
indent += 4;
}
printIndent(OS, indent);
OS.changeColor(llvm::raw_ostream::GREEN);
simple_display(OS, request);
OS.changeColor(llvm::raw_ostream::RED);
OS << " (cyclic dependency)";
OS.resetColor();
OS << "\n";
}
request.diagnoseCycle(diags);
for (const auto &step : llvm::reverse(activeRequests)) {
if (step == request) return;
step.noteCycleStep(diags);
}
llvm_unreachable("Diagnosed a cycle but it wasn't represented in the stack");
}
void evaluator::DependencyRecorder::recordDependency(
const DependencyCollector::Reference &ref) {
if (activeRequestReferences.empty())
return;
activeRequestReferences.back().insert(ref);
}
evaluator::DependencyCollector::DependencyCollector(
evaluator::DependencyRecorder &parent) : parent(parent) {
#ifndef NDEBUG
assert(!parent.isRecording &&
"Probably not a good idea to allow nested recording");
parent.isRecording = true;
#endif
}
evaluator::DependencyCollector::~DependencyCollector() {
#ifndef NDEBUG
assert(parent.isRecording &&
"Should have been recording this whole time");
parent.isRecording = false;
#endif
}
void evaluator::DependencyCollector::addUsedMember(DeclContext *subject,
DeclBaseName name) {
assert(subject->isTypeContext());
return parent.recordDependency(Reference::usedMember(subject, name));
}
void evaluator::DependencyCollector::addPotentialMember(DeclContext *subject) {
assert(subject->isTypeContext());
return parent.recordDependency(Reference::potentialMember(subject));
}
void evaluator::DependencyCollector::addTopLevelName(DeclBaseName name) {
return parent.recordDependency(Reference::topLevel(name));
}
void evaluator::DependencyCollector::addDynamicLookupName(DeclBaseName name) {
return parent.recordDependency(Reference::dynamic(name));
}
void evaluator::DependencyRecorder::enumerateReferencesInFile(
const SourceFile *SF, ReferenceEnumerator f) const {
auto entry = fileReferences.find(SF);
if (entry == fileReferences.end()) {
return;
}
for (const auto &ref : entry->getSecond()) {
switch (ref.kind) {
case DependencyCollector::Reference::Kind::Empty:
case DependencyCollector::Reference::Kind::Tombstone:
llvm_unreachable("Cannot enumerate dead reference!");
case DependencyCollector::Reference::Kind::UsedMember:
case DependencyCollector::Reference::Kind::PotentialMember:
case DependencyCollector::Reference::Kind::TopLevel:
case DependencyCollector::Reference::Kind::Dynamic:
f(ref);
}
}
}
|
