xref: /llvm-project/llvm/lib/CodeGen/MachineUniformityAnalysis.cpp (revision ad3996c1fcefb403e4a303fb2ca975db20986962)
1 //===- MachineUniformityAnalysis.cpp --------------------------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 
9 #include "llvm/CodeGen/MachineUniformityAnalysis.h"
10 #include "llvm/ADT/GenericUniformityImpl.h"
11 #include "llvm/CodeGen/MachineCycleAnalysis.h"
12 #include "llvm/CodeGen/MachineDominators.h"
13 #include "llvm/CodeGen/MachineRegisterInfo.h"
14 #include "llvm/CodeGen/MachineSSAContext.h"
15 #include "llvm/CodeGen/TargetInstrInfo.h"
16 #include "llvm/InitializePasses.h"
17 
18 using namespace llvm;
19 
20 template <>
21 bool llvm::GenericUniformityAnalysisImpl<MachineSSAContext>::hasDivergentDefs(
22     const MachineInstr &I) const {
23   for (auto &op : I.operands()) {
24     if (!op.isReg() || !op.isDef())
25       continue;
26     if (isDivergent(op.getReg()))
27       return true;
28   }
29   return false;
30 }
31 
32 template <>
33 bool llvm::GenericUniformityAnalysisImpl<MachineSSAContext>::markDefsDivergent(
34     const MachineInstr &Instr, bool AllDefsDivergent) {
35   bool insertedDivergent = false;
36   const auto &MRI = F.getRegInfo();
37   const auto &TRI = *MRI.getTargetRegisterInfo();
38   for (auto &op : Instr.operands()) {
39     if (!op.isReg() || !op.isDef())
40       continue;
41     if (!op.getReg().isVirtual())
42       continue;
43     assert(!op.getSubReg());
44     if (!AllDefsDivergent) {
45       auto *RC = MRI.getRegClassOrNull(op.getReg());
46       if (RC && !TRI.isDivergentRegClass(RC))
47         continue;
48     }
49     insertedDivergent |= markDivergent(op.getReg());
50   }
51   return insertedDivergent;
52 }
53 
54 template <>
55 void llvm::GenericUniformityAnalysisImpl<MachineSSAContext>::initialize() {
56   const auto &InstrInfo = *F.getSubtarget().getInstrInfo();
57 
58   for (const MachineBasicBlock &block : F) {
59     for (const MachineInstr &instr : block) {
60       auto uniformity = InstrInfo.getInstructionUniformity(instr);
61       if (uniformity == InstructionUniformity::AlwaysUniform) {
62         addUniformOverride(instr);
63         continue;
64       }
65 
66       if (uniformity == InstructionUniformity::NeverUniform) {
67         markDefsDivergent(instr, /* AllDefsDivergent = */ false);
68       }
69     }
70   }
71 }
72 
73 template <>
74 void llvm::GenericUniformityAnalysisImpl<MachineSSAContext>::pushUsers(
75     Register Reg) {
76   const auto &RegInfo = F.getRegInfo();
77   for (MachineInstr &UserInstr : RegInfo.use_instructions(Reg)) {
78     if (isAlwaysUniform(UserInstr))
79       continue;
80     if (markDivergent(UserInstr))
81       Worklist.push_back(&UserInstr);
82   }
83 }
84 
85 template <>
86 void llvm::GenericUniformityAnalysisImpl<MachineSSAContext>::pushUsers(
87     const MachineInstr &Instr) {
88   assert(!isAlwaysUniform(Instr));
89   if (Instr.isTerminator())
90     return;
91   for (const MachineOperand &op : Instr.operands()) {
92     if (op.isReg() && op.isDef() && op.getReg().isVirtual())
93       pushUsers(op.getReg());
94   }
95 }
96 
97 template <>
98 bool llvm::GenericUniformityAnalysisImpl<MachineSSAContext>::usesValueFromCycle(
99     const MachineInstr &I, const MachineCycle &DefCycle) const {
100   assert(!isAlwaysUniform(I));
101   for (auto &Op : I.operands()) {
102     if (!Op.isReg() || !Op.readsReg())
103       continue;
104     auto Reg = Op.getReg();
105     assert(Reg.isVirtual());
106     auto *Def = F.getRegInfo().getVRegDef(Reg);
107     if (DefCycle.contains(Def->getParent()))
108       return true;
109   }
110   return false;
111 }
112 
113 // This ensures explicit instantiation of
114 // GenericUniformityAnalysisImpl::ImplDeleter::operator()
115 template class llvm::GenericUniformityInfo<MachineSSAContext>;
116 
117 MachineUniformityInfo
118 llvm::computeMachineUniformityInfo(MachineFunction &F,
119                                    const MachineCycleInfo &cycleInfo,
120                                    const MachineDomTree &domTree) {
121   assert(F.getRegInfo().isSSA() && "Expected to be run on SSA form!");
122   return MachineUniformityInfo(F, domTree, cycleInfo);
123 }
124 
125 namespace {
126 
127 /// Legacy analysis pass which computes a \ref MachineUniformityInfo.
128 class MachineUniformityAnalysisPass : public MachineFunctionPass {
129   MachineUniformityInfo UI;
130 
131 public:
132   static char ID;
133 
134   MachineUniformityAnalysisPass();
135 
136   MachineUniformityInfo &getUniformityInfo() { return UI; }
137   const MachineUniformityInfo &getUniformityInfo() const { return UI; }
138 
139   bool runOnMachineFunction(MachineFunction &F) override;
140   void getAnalysisUsage(AnalysisUsage &AU) const override;
141   void print(raw_ostream &OS, const Module *M = nullptr) const override;
142 
143   // TODO: verify analysis
144 };
145 
146 class MachineUniformityInfoPrinterPass : public MachineFunctionPass {
147 public:
148   static char ID;
149 
150   MachineUniformityInfoPrinterPass();
151 
152   bool runOnMachineFunction(MachineFunction &F) override;
153   void getAnalysisUsage(AnalysisUsage &AU) const override;
154 };
155 
156 } // namespace
157 
158 char MachineUniformityAnalysisPass::ID = 0;
159 
160 MachineUniformityAnalysisPass::MachineUniformityAnalysisPass()
161     : MachineFunctionPass(ID) {
162   initializeMachineUniformityAnalysisPassPass(*PassRegistry::getPassRegistry());
163 }
164 
165 INITIALIZE_PASS_BEGIN(MachineUniformityAnalysisPass, "machine-uniformity",
166                       "Machine Uniformity Info Analysis", true, true)
167 INITIALIZE_PASS_DEPENDENCY(MachineCycleInfoWrapperPass)
168 INITIALIZE_PASS_DEPENDENCY(MachineDominatorTree)
169 INITIALIZE_PASS_END(MachineUniformityAnalysisPass, "machine-uniformity",
170                     "Machine Uniformity Info Analysis", true, true)
171 
172 void MachineUniformityAnalysisPass::getAnalysisUsage(AnalysisUsage &AU) const {
173   AU.setPreservesAll();
174   AU.addRequired<MachineCycleInfoWrapperPass>();
175   AU.addRequired<MachineDominatorTree>();
176   MachineFunctionPass::getAnalysisUsage(AU);
177 }
178 
179 bool MachineUniformityAnalysisPass::runOnMachineFunction(MachineFunction &MF) {
180   auto &DomTree = getAnalysis<MachineDominatorTree>().getBase();
181   auto &CI = getAnalysis<MachineCycleInfoWrapperPass>().getCycleInfo();
182   UI = computeMachineUniformityInfo(MF, CI, DomTree);
183   return false;
184 }
185 
186 void MachineUniformityAnalysisPass::print(raw_ostream &OS,
187                                           const Module *) const {
188   OS << "MachineUniformityInfo for function: " << UI.getFunction().getName()
189      << "\n";
190   UI.print(OS);
191 }
192 
193 char MachineUniformityInfoPrinterPass::ID = 0;
194 
195 MachineUniformityInfoPrinterPass::MachineUniformityInfoPrinterPass()
196     : MachineFunctionPass(ID) {
197   initializeMachineUniformityInfoPrinterPassPass(
198       *PassRegistry::getPassRegistry());
199 }
200 
201 INITIALIZE_PASS_BEGIN(MachineUniformityInfoPrinterPass,
202                       "print-machine-uniformity",
203                       "Print Machine Uniformity Info Analysis", true, true)
204 INITIALIZE_PASS_DEPENDENCY(MachineUniformityAnalysisPass)
205 INITIALIZE_PASS_END(MachineUniformityInfoPrinterPass,
206                     "print-machine-uniformity",
207                     "Print Machine Uniformity Info Analysis", true, true)
208 
209 void MachineUniformityInfoPrinterPass::getAnalysisUsage(
210     AnalysisUsage &AU) const {
211   AU.setPreservesAll();
212   AU.addRequired<MachineUniformityAnalysisPass>();
213   MachineFunctionPass::getAnalysisUsage(AU);
214 }
215 
216 bool MachineUniformityInfoPrinterPass::runOnMachineFunction(
217     MachineFunction &F) {
218   auto &UI = getAnalysis<MachineUniformityAnalysisPass>();
219   UI.print(errs());
220   return false;
221 }
222