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
|
//===- Region.cpp ---------------------------------------------------------===//
//
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
// See https://llvm.org/LICENSE.txt for license information.
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
//
//===----------------------------------------------------------------------===//
#include "llvm/SandboxIR/Region.h"
#include "llvm/SandboxIR/Function.h"
namespace llvm::sandboxir {
InstructionCost ScoreBoard::getCost(Instruction *I) const {
auto *LLVMI = cast<llvm::Instruction>(I->Val);
SmallVector<const llvm::Value *> Operands(LLVMI->operands());
return TTI.getInstructionCost(LLVMI, Operands, CostKind);
}
void ScoreBoard::remove(Instruction *I) {
auto Cost = getCost(I);
if (Rgn.contains(I))
// If `I` is one the newly added ones, then we should adjust `AfterCost`
AfterCost -= Cost;
else
// If `I` is one of the original instructions (outside the region) then it
// is part of the original code, so adjust `BeforeCost`.
BeforeCost += Cost;
}
#ifndef NDEBUG
void ScoreBoard::dump() const { dump(dbgs()); }
#endif
Region::Region(Context &Ctx, TargetTransformInfo &TTI)
: Ctx(Ctx), Scoreboard(*this, TTI) {
LLVMContext &LLVMCtx = Ctx.LLVMCtx;
auto *RegionStrMD = MDString::get(LLVMCtx, RegionStr);
RegionMDN = MDNode::getDistinct(LLVMCtx, {RegionStrMD});
CreateInstCB = Ctx.registerCreateInstrCallback(
[this](Instruction *NewInst) { add(NewInst); });
EraseInstCB = Ctx.registerEraseInstrCallback([this](Instruction *ErasedInst) {
remove(ErasedInst);
removeFromAux(ErasedInst);
});
}
Region::~Region() {
Ctx.unregisterCreateInstrCallback(CreateInstCB);
Ctx.unregisterEraseInstrCallback(EraseInstCB);
}
void Region::addImpl(Instruction *I, bool IgnoreCost) {
Insts.insert(I);
// TODO: Consider tagging instructions lazily.
cast<llvm::Instruction>(I->Val)->setMetadata(MDKind, RegionMDN);
if (!IgnoreCost)
// Keep track of the instruction cost.
Scoreboard.add(I);
}
void Region::setAux(ArrayRef<Instruction *> Aux) {
this->Aux = SmallVector<Instruction *>(Aux);
auto &LLVMCtx = Ctx.LLVMCtx;
for (auto [Idx, I] : enumerate(Aux)) {
llvm::ConstantInt *IdxC =
llvm::ConstantInt::get(llvm::Type::getInt32Ty(LLVMCtx), Idx, false);
assert(cast<llvm::Instruction>(I->Val)->getMetadata(AuxMDKind) == nullptr &&
"Instruction already in Aux!");
cast<llvm::Instruction>(I->Val)->setMetadata(
AuxMDKind, MDNode::get(LLVMCtx, ConstantAsMetadata::get(IdxC)));
// Aux instrs should always be in a region.
addImpl(I, /*DontTrackCost=*/true);
}
}
void Region::setAux(unsigned Idx, Instruction *I) {
assert((Idx >= Aux.size() || Aux[Idx] == nullptr) &&
"There is already an Instruction at Idx in Aux!");
unsigned ExpectedSz = Idx + 1;
if (Aux.size() < ExpectedSz) {
auto SzBefore = Aux.size();
Aux.resize(ExpectedSz);
// Initialize the gap with nullptr.
for (unsigned Idx = SzBefore; Idx + 1 < ExpectedSz; ++Idx)
Aux[Idx] = nullptr;
}
Aux[Idx] = I;
// Aux instrs should always be in a region.
addImpl(I, /*DontTrackCost=*/true);
}
void Region::dropAuxMetadata(Instruction *I) {
auto *LLVMI = cast<llvm::Instruction>(I->Val);
LLVMI->setMetadata(AuxMDKind, nullptr);
}
void Region::removeFromAux(Instruction *I) {
auto It = find(Aux, I);
if (It == Aux.end())
return;
dropAuxMetadata(I);
Aux.erase(It);
}
void Region::clearAux() {
for (unsigned Idx : seq<unsigned>(0, Aux.size()))
dropAuxMetadata(Aux[Idx]);
Aux.clear();
}
void Region::remove(Instruction *I) {
// Keep track of the instruction cost. This need to be done *before* we remove
// `I` from the region.
Scoreboard.remove(I);
Insts.remove(I);
cast<llvm::Instruction>(I->Val)->setMetadata(MDKind, nullptr);
}
#ifndef NDEBUG
bool Region::operator==(const Region &Other) const {
if (Insts.size() != Other.Insts.size())
return false;
if (!std::is_permutation(Insts.begin(), Insts.end(), Other.Insts.begin()))
return false;
return true;
}
void Region::dump(raw_ostream &OS) const {
for (auto *I : Insts)
OS << *I << "\n";
if (!Aux.empty()) {
OS << "\nAux:\n";
for (auto *I : Aux) {
if (I == nullptr)
OS << "NULL\n";
else
OS << *I << "\n";
}
}
}
void Region::dump() const {
dump(dbgs());
dbgs() << "\n";
}
#endif // NDEBUG
SmallVector<std::unique_ptr<Region>>
Region::createRegionsFromMD(Function &F, TargetTransformInfo &TTI) {
SmallVector<std::unique_ptr<Region>> Regions;
DenseMap<MDNode *, Region *> MDNToRegion;
auto &Ctx = F.getContext();
for (BasicBlock &BB : F) {
for (Instruction &Inst : BB) {
auto *LLVMI = cast<llvm::Instruction>(Inst.Val);
Region *R = nullptr;
if (auto *MDN = LLVMI->getMetadata(MDKind)) {
auto [It, Inserted] = MDNToRegion.try_emplace(MDN);
if (Inserted) {
Regions.push_back(std::make_unique<Region>(Ctx, TTI));
R = Regions.back().get();
It->second = R;
} else {
R = It->second;
}
R->addImpl(&Inst, /*IgnoreCost=*/true);
}
if (auto *AuxMDN = LLVMI->getMetadata(AuxMDKind)) {
llvm::Constant *IdxC =
dyn_cast<ConstantAsMetadata>(AuxMDN->getOperand(0))->getValue();
auto Idx = cast<llvm::ConstantInt>(IdxC)->getSExtValue();
if (R == nullptr) {
errs() << "No region specified for Aux: '" << *LLVMI << "'\n";
exit(1);
}
R->setAux(Idx, &Inst);
}
}
}
#ifndef NDEBUG
// Check that there are no gaps in the Aux vector.
for (auto &RPtr : Regions)
for (auto *I : RPtr->getAux())
assert(I != nullptr && "Gap in Aux!");
#endif
return Regions;
}
} // namespace llvm::sandboxir
|
