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
|
// SPDX-License-Identifier: GPL-3.0-or-later
#include "Target/TestTarget.h"
#include "rcc/CodeGen/GenericOpcodes.h"
#include "rcc/CodeGen/MachineFunction.h"
#include "rcc/CodeGen/MachineFunctionAnalysisManager.h"
#include <atomic>
#include <cstddef>
#include <cstdint>
#include <iostream>
#include <string_view>
#include <utility>
#include <vector>
namespace {
class TestContext final {
public:
void expect(bool Condition, std::string_view Message) {
if (Condition)
return;
std::cerr << Message << '\n';
++Failures;
}
[[nodiscard]] int result() const noexcept {
return Failures == 0 ? 0 : 1;
}
private:
int Failures = 0;
};
[[nodiscard]] rcc::Expected<rcc::TargetDescription> createTarget() {
std::vector<rcc::InstructionDescriptor> Descriptors;
std::vector<rcc::ImmediatePredicate> Predicates;
auto Appended = rcc::appendGenericInstructionInfo(Descriptors, Predicates);
if (!Appended)
return std::unexpected(Appended.error());
auto Instructions = rcc::InstructionSet::create(std::move(Descriptors), std::move(Predicates));
if (!Instructions)
return std::unexpected(Instructions.error());
return rcc::test::createTestTargetDescription(std::move(*Instructions));
}
class BlockCountAnalysis final {
public:
struct Result final {
std::size_t Count = 0;
};
[[nodiscard]] static constexpr std::string_view name() noexcept {
return "BlockCount";
}
[[nodiscard]] static rcc::Expected<Result> run(rcc::MachineFunction &Function,
const rcc::TargetDescription &,
rcc::MachineFunctionAnalysisManager &) {
++Runs;
return Result{Function.blockCount()};
}
static inline std::atomic<std::uint32_t> Runs = 0;
};
class DependentAnalysis final {
public:
struct Result final {
std::size_t Count = 0;
};
[[nodiscard]] static constexpr std::string_view name() noexcept {
return "Dependent";
}
[[nodiscard]] static rcc::Expected<Result> run(rcc::MachineFunction &Function,
const rcc::TargetDescription &Target,
rcc::MachineFunctionAnalysisManager &Analyses) {
auto Blocks = Analyses.getResult<BlockCountAnalysis>(Function, Target);
if (!Blocks)
return std::unexpected(Blocks.error());
return Result{(*Blocks)->Count};
}
};
class StickyAnalysis final {
public:
struct Result final {
[[nodiscard]] bool invalidate(const rcc::MachineFunction &,
const rcc::PreservedAnalyses &) noexcept {
return false;
}
};
[[nodiscard]] static constexpr std::string_view name() noexcept {
return "Sticky";
}
[[nodiscard]] static rcc::Expected<Result> run(rcc::MachineFunction &,
const rcc::TargetDescription &,
rcc::MachineFunctionAnalysisManager &) {
return Result{};
}
};
class ExpiringAnalysis final {
public:
struct Result final {
[[nodiscard]] bool invalidate(const rcc::MachineFunction &,
const rcc::PreservedAnalyses &) noexcept {
return true;
}
};
[[nodiscard]] static constexpr std::string_view name() noexcept {
return "Expiring";
}
[[nodiscard]] static rcc::Expected<Result> run(rcc::MachineFunction &,
const rcc::TargetDescription &,
rcc::MachineFunctionAnalysisManager &) {
return Result{};
}
};
class CycleA final {
public:
struct Result final {};
[[nodiscard]] static constexpr std::string_view name() noexcept {
return "CycleA";
}
[[nodiscard]] static rcc::Expected<Result> run(rcc::MachineFunction &,
const rcc::TargetDescription &,
rcc::MachineFunctionAnalysisManager &) {
return Result{};
}
};
class CycleB final {
public:
struct Result final {};
[[nodiscard]] static constexpr std::string_view name() noexcept {
return "CycleB";
}
[[nodiscard]] static rcc::Expected<Result> run(rcc::MachineFunction &,
const rcc::TargetDescription &,
rcc::MachineFunctionAnalysisManager &) {
return Result{};
}
};
void testAnalysisManager(TestContext &Context, const rcc::TargetDescription &Target) {
auto Function =
rcc::MachineFunction::create("analysis", rcc::MachineFunctionStableID::fromValue(1));
Context.expect(Function.has_value(), "analysis function creation must succeed");
if (!Function)
return;
rcc::MachineFunctionAnalysisManager Analyses;
Context.expect(Analyses
.registerAnalysis<BlockCountAnalysis>({
.Name = "BlockCount",
.Dependencies = {},
.InvalidatedBy = {rcc::MachinePassChange::CFG},
})
.has_value(),
"base analysis registration must succeed");
Context.expect(Analyses
.registerAnalysis<DependentAnalysis>({
.Name = "Dependent",
.Dependencies =
{
rcc::MachineFunctionAnalysisManager::id<BlockCountAnalysis>(),
},
.InvalidatedBy = {rcc::MachinePassChange::Operands},
})
.has_value(),
"dependent analysis registration must succeed");
BlockCountAnalysis::Runs = 0;
auto First = Analyses.getResult<DependentAnalysis>(**Function, Target);
auto Second = Analyses.getResult<DependentAnalysis>(**Function, Target);
Context.expect(First && Second && *First == *Second && BlockCountAnalysis::Runs == 1,
"analysis dependencies must materialize once and then use the cache");
Analyses.invalidate(**Function, rcc::PreservedAnalyses::none(),
{rcc::MachinePassChange::Registers});
Context.expect(Analyses.cachedResultCount(**Function) == 2,
"unrelated changes must preserve cached analyses precisely");
Analyses.invalidate(**Function, rcc::PreservedAnalyses::none(), {rcc::MachinePassChange::CFG});
Context.expect(Analyses.cachedResultCount(**Function) == 0,
"invalidating a dependency must invalidate its dependent analysis");
rcc::MachineFunctionAnalysisManager Cyclic;
Context.expect(
Cyclic.registerAnalysis<CycleA>({
.Name = "CycleA",
.Dependencies =
{
rcc::MachineFunctionAnalysisManager::id<CycleB>(),
},
})
.has_value() &&
Cyclic
.registerAnalysis<CycleB>({
.Name = "CycleB",
.Dependencies =
{
rcc::MachineFunctionAnalysisManager::id<CycleA>(),
},
})
.has_value(),
"cyclic analysis registrations must be accepted until requested");
Context.expect(!Cyclic.getResult<CycleA>(**Function, Target),
"analysis dependency cycles must produce a structured error");
rcc::MachineFunctionAnalysisManager CustomInvalidation;
Context.expect(CustomInvalidation
.registerAnalysis<StickyAnalysis>({
.Name = "Sticky",
.Dependencies = {},
.InvalidatedBy = {rcc::MachinePassChange::CFG},
})
.has_value() &&
CustomInvalidation
.registerAnalysis<ExpiringAnalysis>({
.Name = "Expiring",
.Dependencies = {},
.InvalidatedBy = {rcc::MachinePassChange::CFG},
})
.has_value() &&
CustomInvalidation.getResult<StickyAnalysis>(**Function, Target) &&
CustomInvalidation.getResult<ExpiringAnalysis>(**Function, Target),
"custom invalidation analyses must materialize");
CustomInvalidation.invalidate(**Function, rcc::PreservedAnalyses::none(),
{rcc::MachinePassChange::CFG});
Context.expect(CustomInvalidation.hasCached(
**Function, rcc::MachineFunctionAnalysisManager::id<StickyAnalysis>()) &&
!CustomInvalidation.hasCached(
**Function, rcc::MachineFunctionAnalysisManager::id<ExpiringAnalysis>()),
"analysis invalidate() must return false to preserve and true to invalidate");
}
} // namespace
int main() {
TestContext Context;
auto Target = createTarget();
Context.expect(Target.has_value(), "pass manager tests require a valid target description");
if (!Target)
return Context.result();
testAnalysisManager(Context, *Target);
return Context.result();
}
|