1 //===---------------------- ProcessImplicitDefs.cpp -----------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #define DEBUG_TYPE "processimplicitdefs"
11 
12 #include "llvm/CodeGen/ProcessImplicitDefs.h"
13 
14 #include "llvm/ADT/DepthFirstIterator.h"
15 #include "llvm/ADT/SmallSet.h"
16 #include "llvm/Analysis/AliasAnalysis.h"
17 #include "llvm/CodeGen/LiveVariables.h"
18 #include "llvm/CodeGen/MachineInstr.h"
19 #include "llvm/CodeGen/MachineRegisterInfo.h"
20 #include "llvm/CodeGen/Passes.h"
21 #include "llvm/Support/Debug.h"
22 #include "llvm/Target/TargetInstrInfo.h"
23 #include "llvm/Target/TargetRegisterInfo.h"
24 
25 
26 using namespace llvm;
27 
28 char ProcessImplicitDefs::ID = 0;
29 static RegisterPass<ProcessImplicitDefs> X("processimpdefs",
30                                            "Process Implicit Definitions.");
31 
32 void ProcessImplicitDefs::getAnalysisUsage(AnalysisUsage &AU) const {
33   AU.setPreservesCFG();
34   AU.addPreserved<AliasAnalysis>();
35   AU.addPreserved<LiveVariables>();
36   AU.addRequired<LiveVariables>();
37   AU.addPreservedID(MachineLoopInfoID);
38   AU.addPreservedID(MachineDominatorsID);
39   AU.addPreservedID(TwoAddressInstructionPassID);
40   AU.addPreservedID(PHIEliminationID);
41   MachineFunctionPass::getAnalysisUsage(AU);
42 }
43 
44 bool ProcessImplicitDefs::CanTurnIntoImplicitDef(MachineInstr *MI,
45                                                  unsigned Reg, unsigned OpIdx,
46                                                  const TargetInstrInfo *tii_) {
47   unsigned SrcReg, DstReg, SrcSubReg, DstSubReg;
48   if (tii_->isMoveInstr(*MI, SrcReg, DstReg, SrcSubReg, DstSubReg) &&
49       Reg == SrcReg && DstSubReg == 0)
50     return true;
51 
52   switch(OpIdx) {
53     case 1: return (MI->isExtractSubreg() || MI->isCopy()) &&
54                    MI->getOperand(0).getSubReg() == 0;
55     case 2: return MI->isSubregToReg() && MI->getOperand(0).getSubReg() == 0;
56     default: return false;
57   }
58 }
59 
60 /// processImplicitDefs - Process IMPLICIT_DEF instructions and make sure
61 /// there is one implicit_def for each use. Add isUndef marker to
62 /// implicit_def defs and their uses.
63 bool ProcessImplicitDefs::runOnMachineFunction(MachineFunction &fn) {
64 
65   DEBUG(dbgs() << "********** PROCESS IMPLICIT DEFS **********\n"
66                << "********** Function: "
67                << ((Value*)fn.getFunction())->getName() << '\n');
68 
69   bool Changed = false;
70 
71   const TargetInstrInfo *tii_ = fn.getTarget().getInstrInfo();
72   const TargetRegisterInfo *tri_ = fn.getTarget().getRegisterInfo();
73   MachineRegisterInfo *mri_ = &fn.getRegInfo();
74 
75   LiveVariables *lv_ = &getAnalysis<LiveVariables>();
76 
77   SmallSet<unsigned, 8> ImpDefRegs;
78   SmallVector<MachineInstr*, 8> ImpDefMIs;
79   SmallVector<MachineInstr*, 4> RUses;
80   SmallPtrSet<MachineBasicBlock*,16> Visited;
81   SmallPtrSet<MachineInstr*, 8> ModInsts;
82 
83   MachineBasicBlock *Entry = fn.begin();
84   for (df_ext_iterator<MachineBasicBlock*, SmallPtrSet<MachineBasicBlock*,16> >
85          DFI = df_ext_begin(Entry, Visited), E = df_ext_end(Entry, Visited);
86        DFI != E; ++DFI) {
87     MachineBasicBlock *MBB = *DFI;
88     for (MachineBasicBlock::iterator I = MBB->begin(), E = MBB->end();
89          I != E; ) {
90       MachineInstr *MI = &*I;
91       ++I;
92       if (MI->isImplicitDef()) {
93         if (MI->getOperand(0).getSubReg())
94           continue;
95         unsigned Reg = MI->getOperand(0).getReg();
96         ImpDefRegs.insert(Reg);
97         if (TargetRegisterInfo::isPhysicalRegister(Reg)) {
98           for (const unsigned *SS = tri_->getSubRegisters(Reg); *SS; ++SS)
99             ImpDefRegs.insert(*SS);
100         }
101         ImpDefMIs.push_back(MI);
102         continue;
103       }
104 
105       if (MI->isInsertSubreg()) {
106         MachineOperand &MO = MI->getOperand(2);
107         if (ImpDefRegs.count(MO.getReg())) {
108           // %reg1032<def> = INSERT_SUBREG %reg1032, undef, 2
109           // This is an identity copy, eliminate it now.
110           if (MO.isKill()) {
111             LiveVariables::VarInfo& vi = lv_->getVarInfo(MO.getReg());
112             vi.removeKill(MI);
113           }
114           MI->eraseFromParent();
115           Changed = true;
116           continue;
117         }
118       }
119 
120       // Eliminate %reg1032:sub<def> = COPY undef.
121       if (MI->isCopy() && MI->getOperand(0).getSubReg()) {
122         MachineOperand &MO = MI->getOperand(1);
123         if (ImpDefRegs.count(MO.getReg())) {
124           if (MO.isKill()) {
125             LiveVariables::VarInfo& vi = lv_->getVarInfo(MO.getReg());
126             vi.removeKill(MI);
127           }
128           MI->eraseFromParent();
129           Changed = true;
130           continue;
131         }
132       }
133 
134       bool ChangedToImpDef = false;
135       for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
136         MachineOperand& MO = MI->getOperand(i);
137         if (!MO.isReg() || (MO.isDef() && !MO.getSubReg()) || MO.isUndef())
138           continue;
139         unsigned Reg = MO.getReg();
140         if (!Reg)
141           continue;
142         if (!ImpDefRegs.count(Reg))
143           continue;
144         // Use is a copy, just turn it into an implicit_def.
145         if (CanTurnIntoImplicitDef(MI, Reg, i, tii_)) {
146           bool isKill = MO.isKill();
147           MI->setDesc(tii_->get(TargetOpcode::IMPLICIT_DEF));
148           for (int j = MI->getNumOperands() - 1, ee = 0; j > ee; --j)
149             MI->RemoveOperand(j);
150           if (isKill) {
151             ImpDefRegs.erase(Reg);
152             LiveVariables::VarInfo& vi = lv_->getVarInfo(Reg);
153             vi.removeKill(MI);
154           }
155           ChangedToImpDef = true;
156           Changed = true;
157           break;
158         }
159 
160         Changed = true;
161         MO.setIsUndef();
162         // This is a partial register redef of an implicit def.
163         // Make sure the whole register is defined by the instruction.
164         if (MO.isDef()) {
165           MI->addRegisterDefined(Reg);
166           continue;
167         }
168         if (MO.isKill() || MI->isRegTiedToDefOperand(i)) {
169           // Make sure other uses of
170           for (unsigned j = i+1; j != e; ++j) {
171             MachineOperand &MOJ = MI->getOperand(j);
172             if (MOJ.isReg() && MOJ.isUse() && MOJ.getReg() == Reg)
173               MOJ.setIsUndef();
174           }
175           ImpDefRegs.erase(Reg);
176         }
177       }
178 
179       if (ChangedToImpDef) {
180         // Backtrack to process this new implicit_def.
181         --I;
182       } else {
183         for (unsigned i = 0; i != MI->getNumOperands(); ++i) {
184           MachineOperand& MO = MI->getOperand(i);
185           if (!MO.isReg() || !MO.isDef())
186             continue;
187           ImpDefRegs.erase(MO.getReg());
188         }
189       }
190     }
191 
192     // Any outstanding liveout implicit_def's?
193     for (unsigned i = 0, e = ImpDefMIs.size(); i != e; ++i) {
194       MachineInstr *MI = ImpDefMIs[i];
195       unsigned Reg = MI->getOperand(0).getReg();
196       if (TargetRegisterInfo::isPhysicalRegister(Reg) ||
197           !ImpDefRegs.count(Reg)) {
198         // Delete all "local" implicit_def's. That include those which define
199         // physical registers since they cannot be liveout.
200         MI->eraseFromParent();
201         Changed = true;
202         continue;
203       }
204 
205       // If there are multiple defs of the same register and at least one
206       // is not an implicit_def, do not insert implicit_def's before the
207       // uses.
208       bool Skip = false;
209       SmallVector<MachineInstr*, 4> DeadImpDefs;
210       for (MachineRegisterInfo::def_iterator DI = mri_->def_begin(Reg),
211              DE = mri_->def_end(); DI != DE; ++DI) {
212         MachineInstr *DeadImpDef = &*DI;
213         if (!DeadImpDef->isImplicitDef()) {
214           Skip = true;
215           break;
216         }
217         DeadImpDefs.push_back(DeadImpDef);
218       }
219       if (Skip)
220         continue;
221 
222       // The only implicit_def which we want to keep are those that are live
223       // out of its block.
224       for (unsigned j = 0, ee = DeadImpDefs.size(); j != ee; ++j)
225         DeadImpDefs[j]->eraseFromParent();
226       Changed = true;
227 
228       // Process each use instruction once.
229       for (MachineRegisterInfo::use_iterator UI = mri_->use_begin(Reg),
230              UE = mri_->use_end(); UI != UE; ++UI) {
231         if (UI.getOperand().isUndef())
232           continue;
233         MachineInstr *RMI = &*UI;
234         if (ModInsts.insert(RMI))
235           RUses.push_back(RMI);
236       }
237 
238       for (unsigned i = 0, e = RUses.size(); i != e; ++i) {
239         MachineInstr *RMI = RUses[i];
240 
241         // Turn a copy use into an implicit_def.
242         unsigned SrcReg, DstReg, SrcSubReg, DstSubReg;
243         if ((RMI->isCopy() && RMI->getOperand(1).getReg() == Reg &&
244              RMI->getOperand(0).getSubReg() == 0) ||
245             (tii_->isMoveInstr(*RMI, SrcReg, DstReg, SrcSubReg, DstSubReg) &&
246              Reg == SrcReg && DstSubReg == 0)) {
247           RMI->setDesc(tii_->get(TargetOpcode::IMPLICIT_DEF));
248 
249           bool isKill = false;
250           SmallVector<unsigned, 4> Ops;
251           for (unsigned j = 0, ee = RMI->getNumOperands(); j != ee; ++j) {
252             MachineOperand &RRMO = RMI->getOperand(j);
253             if (RRMO.isReg() && RRMO.getReg() == Reg) {
254               Ops.push_back(j);
255               if (RRMO.isKill())
256                 isKill = true;
257             }
258           }
259           // Leave the other operands along.
260           for (unsigned j = 0, ee = Ops.size(); j != ee; ++j) {
261             unsigned OpIdx = Ops[j];
262             RMI->RemoveOperand(OpIdx-j);
263           }
264 
265           // Update LiveVariables varinfo if the instruction is a kill.
266           if (isKill) {
267             LiveVariables::VarInfo& vi = lv_->getVarInfo(Reg);
268             vi.removeKill(RMI);
269           }
270           continue;
271         }
272 
273         // Replace Reg with a new vreg that's marked implicit.
274         const TargetRegisterClass* RC = mri_->getRegClass(Reg);
275         unsigned NewVReg = mri_->createVirtualRegister(RC);
276         bool isKill = true;
277         for (unsigned j = 0, ee = RMI->getNumOperands(); j != ee; ++j) {
278           MachineOperand &RRMO = RMI->getOperand(j);
279           if (RRMO.isReg() && RRMO.getReg() == Reg) {
280             RRMO.setReg(NewVReg);
281             RRMO.setIsUndef();
282             if (isKill) {
283               // Only the first operand of NewVReg is marked kill.
284               RRMO.setIsKill();
285               isKill = false;
286             }
287           }
288         }
289       }
290       RUses.clear();
291       ModInsts.clear();
292     }
293     ImpDefRegs.clear();
294     ImpDefMIs.clear();
295   }
296 
297   return Changed;
298 }
299 
300