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
261
262
263
264
265
266
|
/*========================== begin_copyright_notice ============================
Copyright (C) 2017-2024 Intel Corporation
SPDX-License-Identifier: MIT
============================= end_copyright_notice ===========================*/
/*========================== begin_copyright_notice ============================
This file is distributed under the University of Illinois Open Source License.
See LICENSE.TXT for details.
============================= end_copyright_notice ===========================*/
#pragma once
#include "Compiler/CISACodeGen/WIAnalysis.hpp"
#include "Compiler/CISACodeGen/IGCLivenessAnalysis.h"
#include "Compiler/CISACodeGen/TranslationTable.hpp"
#include "Compiler/MetaDataUtilsWrapper.h"
#include "Compiler/MetaDataApi/MetaDataApi.h"
#include "Compiler/CodeGenContextWrapper.hpp"
#include "common/LLVMWarningsPush.hpp"
#include <llvm/Analysis/PostDominators.h>
#include <llvm/Analysis/LoopInfo.h>
#include "common/LLVMWarningsPop.hpp"
namespace IGC {
class CodeSinking : public llvm::FunctionPass {
llvm::DominatorTree* DT = nullptr;
llvm::PostDominatorTree* PDT = nullptr;
llvm::LoopInfo* LI = nullptr;
const llvm::DataLayout* DL = nullptr; // to estimate register pressure
CodeGenContext* CTX = nullptr;
public:
static char ID; // Pass identification
CodeSinking();
virtual bool runOnFunction(llvm::Function& F) override;
virtual void getAnalysisUsage(llvm::AnalysisUsage& AU) const override {
AU.setPreservesCFG();
AU.addRequired<llvm::DominatorTreeWrapperPass>();
AU.addRequired<llvm::PostDominatorTreeWrapperPass>();
AU.addRequired<llvm::LoopInfoWrapperPass>();
AU.addRequired<MetaDataUtilsWrapper>();
AU.addRequired<CodeGenContextWrapper>();
AU.addPreserved<llvm::DominatorTreeWrapperPass>();
AU.addPreserved<llvm::PostDominatorTreeWrapperPass>();
AU.addPreserved<llvm::LoopInfoWrapperPass>();
}
private:
bool treeSink(llvm::Function& F);
bool processBlock(llvm::BasicBlock& blk);
bool sinkInstruction(llvm::Instruction* I,
llvm::SmallPtrSetImpl<llvm::Instruction*>& Stores);
bool allUsesDominatedByBlock(llvm::Instruction* inst,
llvm::BasicBlock* blk,
llvm::SmallPtrSetImpl<llvm::Instruction*>& usesInBlk) const;
bool isSafeToMove(llvm::Instruction* inst,
bool& reducePressure,
bool& hasAliasConcern,
SmallPtrSetImpl<Instruction*>& Stores);
bool localSink(BasicBlock* BB);
void rollbackSinking(BasicBlock* BB);
uint estimateLiveOutPressure(llvm::BasicBlock* blk, const llvm::DataLayout* DL);
/// data members for local-sinking
llvm::SmallPtrSet<llvm::BasicBlock*, 8> LocalBlkSet;
llvm::SmallPtrSet<llvm::Instruction*, 8> LocalInstSet;
/// data members for undo
std::vector<llvm::Instruction*> MovedInsts;
std::vector<llvm::Instruction*> UndoLocas;
/// counting the number of gradient/sample operation sinked into CF
unsigned totalGradientMoved = 0;
unsigned numGradientMovedOutBB = 0;
};
void initializeCodeSinkingPass(llvm::PassRegistry&);
typedef enum { NoSink=0, SinkWhileRegpressureIsHigh, FullSink } LoopSinkMode;
typedef enum { Unknown=0, MaybeSink, Sink, IntraLoopSink } LoopSinkWorthiness;
class CodeLoopSinking : public llvm::FunctionPass {
llvm::DominatorTree* DT = nullptr;
llvm::PostDominatorTree* PDT = nullptr;
llvm::LoopInfo* LI = nullptr;
llvm::AliasAnalysis* AA = nullptr;
WIAnalysisRunner WI;
IGCMD::MetaDataUtils* MDUtils = nullptr;
ModuleMetaData* ModMD = nullptr;
IGCLivenessAnalysis* RPE = nullptr;
IGCFunctionExternalRegPressureAnalysis* FRPE = nullptr;
CodeGenContext* CTX = nullptr;
TargetLibraryInfo* TLI = nullptr;
public:
static char ID; // Pass identification
CodeLoopSinking();
virtual bool runOnFunction(llvm::Function& F) override;
virtual void getAnalysisUsage(llvm::AnalysisUsage& AU) const override {
AU.setPreservesCFG();
AU.addRequired<llvm::DominatorTreeWrapperPass>();
AU.addRequired<llvm::PostDominatorTreeWrapperPass>();
AU.addRequired<llvm::LoopInfoWrapperPass>();
AU.addRequired<llvm::AAResultsWrapperPass>();
AU.addRequired<MetaDataUtilsWrapper>();
AU.addRequired<TranslationTable>();
AU.addRequired<IGCLivenessAnalysis>();
AU.addRequired<IGCFunctionExternalRegPressureAnalysis>();
AU.addRequired<TargetLibraryInfoWrapperPass>();
AU.addRequired<CodeGenContextWrapper>();
AU.addPreserved<llvm::DominatorTreeWrapperPass>();
AU.addPreserved<llvm::PostDominatorTreeWrapperPass>();
AU.addPreserved<llvm::LoopInfoWrapperPass>();
AU.addPreserved<llvm::AAResultsWrapperPass>();
AU.addPreservedID(TranslationTable::ID);
}
private:
typedef llvm::SmallPtrSet<llvm::Instruction*, 32> InstSet;
// Candidate for a sinking - POD structure to describe instructions to be sinked in a loop
// Instructions - list of instructions to be sinked in reverse order (from last to first)
// All instructions must be from the same basic block, not necessarily consecutive
// TgtBB - target basic block where instructions should be sinked
// Worthiness - worthiness of the candidate to be sinked
// Unknown - candidate is not checked yet
// MaybeSink - candidate is checked and can be sinked if it's beneficial
// (it depends on whether the other candidates that use it's operands are going to be sinked)
// Sink - candidate is checked and should be sinked
// IntraLoopSink - candidate is already in the loop, but might be sinked to another basic block
// or scheduled within the basic block
struct Candidate {
typedef llvm::SmallVector<llvm::Instruction*, 16> InstrVec;
Candidate(const InstrVec& Instructions, BasicBlock* TgtBB, LoopSinkWorthiness Worthiness, llvm::Instruction* UndoPos)
: Instructions(Instructions), TgtBB(TgtBB), Worthiness(Worthiness), UndoPos(UndoPos) {}
Candidate(llvm::Instruction* Instruction, BasicBlock* TgtBB, LoopSinkWorthiness Worthiness, llvm::Instruction* UndoPos)
: Instructions(InstrVec{Instruction}), TgtBB(TgtBB), Worthiness(Worthiness), UndoPos(UndoPos) {}
Candidate(const Candidate& Other)
: Instructions(Other.Instructions), TgtBB(Other.TgtBB), Worthiness(Other.Worthiness), UndoPos(Other.UndoPos) {}
Candidate& operator=(const Candidate&) = delete;
InstrVec Instructions;
BasicBlock *TgtBB;
LoopSinkWorthiness Worthiness = Unknown;
Instruction *UndoPos = nullptr;
// iterator of instructions
typedef llvm::SmallVector<llvm::Instruction*, 16>::iterator iterator;
iterator begin() { return Instructions.begin(); }
iterator end() { return Instructions.end(); }
// const iterator of instructions
typedef llvm::SmallVector<llvm::Instruction*, 16>::const_iterator const_iterator;
const_iterator begin() const { return Instructions.begin(); }
const_iterator end() const { return Instructions.end(); }
// first instruction - comes last in the BB but first in the list
Instruction *first() const { return Instructions.front(); }
size_t size() const { return Instructions.size(); }
void print(llvm::raw_ostream& OS) const {
auto worthinessToString = [](LoopSinkWorthiness Worthiness) {
switch (Worthiness) {
case Unknown: return "Unknown";
case MaybeSink: return "MaybeSink";
case Sink: return "Sink";
case IntraLoopSink: return "IntraLoopSink";
default: return "Unknown";
}
};
OS << "Candidate: Target BB: " << TgtBB->getName() << " Worthiness: " << worthinessToString(Worthiness) << " Instructions: \n";
for (auto I : Instructions) {
OS << *I << " ";
}
}
};
typedef llvm::SmallVector<std::unique_ptr<Candidate>, 64> CandidateVec;
typedef llvm::SmallVector<Candidate*, 64> CandidatePtrVec;
typedef llvm::DenseMap<Instruction*, Candidate*> InstToCandidateMap;
/// sinking
bool loopSink(llvm::Function& F);
bool loopSink(llvm::Loop* LoopWithPressure, LoopSinkMode Mode);
bool localSink(llvm::BasicBlock* BB, InstToCandidateMap& InstToCandidate);
/// candidates creation
bool tryCreateShufflePatternCandidates(
llvm::Loop* L,
InstSet& SkipInstructions,
CandidateVec& SinkCandidates
);
bool tryCreate2dBlockReadGroupSinkingCandidate(
llvm::Instruction *I,
llvm::Loop *L,
InstSet& SkipInstructions,
CandidateVec& SinkCandidates
);
CandidateVec refineLoopSinkCandidates(
CandidateVec& SinkCandidates,
InstSet& LoadChains,
llvm::Loop* L);
bool isSafeToLoopSinkLoad(llvm::Instruction* I, llvm::Loop* Loop);
bool isAlwaysSinkInstruction(llvm::Instruction* I);
bool allUsesAreInLoop(llvm::Instruction* I, llvm::Loop* L);
BasicBlock* findLowestLoopSinkTarget(llvm::Instruction* I, llvm::Loop* L);
/// load chain heuristic
bool isLoadChain(llvm::Instruction* I, InstSet& LoadChains, bool EnsureSingleUser=false);
void prepopulateLoadChains(llvm::Loop* I, InstSet& LoadChains);
/// data members for local-sinking
llvm::SmallPtrSet<llvm::BasicBlock*, 8> LocalBlkSet;
/// data members for undo
llvm::SmallPtrSet<llvm::BasicBlock*, 8> UndoBlkSet;
/// dumping
std::string Log;
llvm::raw_string_ostream LogStringStream;
llvm::raw_ostream *LogStream = nullptr;
void dumpToFile(const std::string& Log);
// memoize all possible stores for every loop that is a candidate for sinking
typedef llvm::SmallVector<llvm::Instruction*, 32> StoresVec;
llvm::DenseMap<llvm::Loop*, StoresVec> MemoizedStoresInLoops;
llvm::SmallPtrSet<llvm::Loop*, 8> BlacklistedLoops;
StoresVec getAllStoresInLoop(llvm::Loop* L);
/// checking if sinking in a particular loop is beneficial
llvm::DenseMap<llvm::BasicBlock*, uint> BBPressures;
bool mayBeLoopSinkCandidate(llvm::Instruction* I, llvm::Loop* L);
unsigned getMaxRegCountForLoop(llvm::Loop* L);
unsigned getMaxRegCountForFunction(llvm::Function* F);
LoopSinkMode needLoopSink(llvm::Loop* L);
};
void initializeCodeLoopSinkingPass(llvm::PassRegistry&);
}
|
