add operand iterator apis to MachineInstr, patch by ether zhhb.
[oota-llvm.git] / include / llvm / CodeGen / MachineInstr.h
1 //===-- llvm/CodeGen/MachineInstr.h - MachineInstr class --------*- C++ -*-===//
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 // This file contains the declaration of the MachineInstr class, which is the
11 // basic representation for all target dependent machine instructions used by
12 // the back end.
13 //
14 //===----------------------------------------------------------------------===//
15
16 #ifndef LLVM_CODEGEN_MACHINEINSTR_H
17 #define LLVM_CODEGEN_MACHINEINSTR_H
18
19 #include "llvm/CodeGen/MachineOperand.h"
20 #include "llvm/Target/TargetInstrDesc.h"
21 #include "llvm/Target/TargetOpcodes.h"
22 #include "llvm/ADT/ilist.h"
23 #include "llvm/ADT/ilist_node.h"
24 #include "llvm/ADT/STLExtras.h"
25 #include "llvm/ADT/DenseMapInfo.h"
26 #include "llvm/Support/DebugLoc.h"
27 #include <vector>
28
29 namespace llvm {
30
31 template <typename T> class SmallVectorImpl;
32 class AliasAnalysis;
33 class TargetInstrDesc;
34 class TargetInstrInfo;
35 class TargetRegisterInfo;
36 class MachineFunction;
37 class MachineMemOperand;
38
39 //===----------------------------------------------------------------------===//
40 /// MachineInstr - Representation of each machine instruction.
41 ///
42 class MachineInstr : public ilist_node<MachineInstr> {
43 public:
44   typedef MachineMemOperand **mmo_iterator;
45
46   /// Flags to specify different kinds of comments to output in
47   /// assembly code.  These flags carry semantic information not
48   /// otherwise easily derivable from the IR text.
49   ///
50   enum CommentFlag {
51     ReloadReuse = 0x1
52   };
53   
54 private:
55   const TargetInstrDesc *TID;           // Instruction descriptor.
56   unsigned short NumImplicitOps;        // Number of implicit operands (which
57                                         // are determined at construction time).
58
59   unsigned short AsmPrinterFlags;       // Various bits of information used by
60                                         // the AsmPrinter to emit helpful
61                                         // comments.  This is *not* semantic
62                                         // information.  Do not use this for
63                                         // anything other than to convey comment
64                                         // information to AsmPrinter.
65
66   std::vector<MachineOperand> Operands; // the operands
67   mmo_iterator MemRefs;                 // information on memory references
68   mmo_iterator MemRefsEnd;
69   MachineBasicBlock *Parent;            // Pointer to the owning basic block.
70   DebugLoc debugLoc;                    // Source line information.
71
72   // OperandComplete - Return true if it's illegal to add a new operand
73   bool OperandsComplete() const;
74
75   MachineInstr(const MachineInstr&);   // DO NOT IMPLEMENT
76   void operator=(const MachineInstr&); // DO NOT IMPLEMENT
77
78   // Intrusive list support
79   friend struct ilist_traits<MachineInstr>;
80   friend struct ilist_traits<MachineBasicBlock>;
81   void setParent(MachineBasicBlock *P) { Parent = P; }
82
83   /// MachineInstr ctor - This constructor creates a copy of the given
84   /// MachineInstr in the given MachineFunction.
85   MachineInstr(MachineFunction &, const MachineInstr &);
86
87   /// MachineInstr ctor - This constructor creates a dummy MachineInstr with
88   /// TID NULL and no operands.
89   MachineInstr();
90
91   // The next two constructors have DebugLoc and non-DebugLoc versions;
92   // over time, the non-DebugLoc versions should be phased out and eventually
93   // removed.
94
95   /// MachineInstr ctor - This constructor creates a MachineInstr and adds the
96   /// implicit operands.  It reserves space for the number of operands specified
97   /// by the TargetInstrDesc.  The version with a DebugLoc should be preferred.
98   explicit MachineInstr(const TargetInstrDesc &TID, bool NoImp = false);
99
100   /// MachineInstr ctor - Work exactly the same as the ctor above, except that
101   /// the MachineInstr is created and added to the end of the specified basic
102   /// block.  The version with a DebugLoc should be preferred.
103   MachineInstr(MachineBasicBlock *MBB, const TargetInstrDesc &TID);
104
105   /// MachineInstr ctor - This constructor create a MachineInstr and add the
106   /// implicit operands.  It reserves space for number of operands specified by
107   /// TargetInstrDesc.  An explicit DebugLoc is supplied.
108   explicit MachineInstr(const TargetInstrDesc &TID, const DebugLoc dl, 
109                         bool NoImp = false);
110
111   /// MachineInstr ctor - Work exactly the same as the ctor above, except that
112   /// the MachineInstr is created and added to the end of the specified basic
113   /// block.
114   MachineInstr(MachineBasicBlock *MBB, const DebugLoc dl, 
115                const TargetInstrDesc &TID);
116
117   ~MachineInstr();
118
119   // MachineInstrs are pool-allocated and owned by MachineFunction.
120   friend class MachineFunction;
121
122 public:
123   const MachineBasicBlock* getParent() const { return Parent; }
124   MachineBasicBlock* getParent() { return Parent; }
125
126   /// getAsmPrinterFlags - Return the asm printer flags bitvector.
127   ///
128   unsigned short getAsmPrinterFlags() const { return AsmPrinterFlags; }
129
130   /// getAsmPrinterFlag - Return whether an AsmPrinter flag is set.
131   ///
132   bool getAsmPrinterFlag(CommentFlag Flag) const {
133     return AsmPrinterFlags & Flag;
134   }
135
136   /// setAsmPrinterFlag - Set a flag for the AsmPrinter.
137   ///
138   void setAsmPrinterFlag(CommentFlag Flag) {
139     AsmPrinterFlags |= (unsigned short)Flag;
140   }
141
142   /// getDebugLoc - Returns the debug location id of this MachineInstr.
143   ///
144   DebugLoc getDebugLoc() const { return debugLoc; }
145   
146   /// getDesc - Returns the target instruction descriptor of this
147   /// MachineInstr.
148   const TargetInstrDesc &getDesc() const { return *TID; }
149
150   /// getOpcode - Returns the opcode of this MachineInstr.
151   ///
152   int getOpcode() const { return TID->Opcode; }
153
154   /// Access to explicit operands of the instruction.
155   ///
156   unsigned getNumOperands() const { return (unsigned)Operands.size(); }
157
158   const MachineOperand& getOperand(unsigned i) const {
159     assert(i < getNumOperands() && "getOperand() out of range!");
160     return Operands[i];
161   }
162   MachineOperand& getOperand(unsigned i) {
163     assert(i < getNumOperands() && "getOperand() out of range!");
164     return Operands[i];
165   }
166
167   /// getNumExplicitOperands - Returns the number of non-implicit operands.
168   ///
169   unsigned getNumExplicitOperands() const;
170
171   /// iterator/begin/end - Iterate over all operands of a machine instruction.
172   typedef std::vector<MachineOperand>::iterator mop_iterator;
173   typedef std::vector<MachineOperand>::const_iterator const_mop_iterator;
174
175   mop_iterator operands_begin() { return Operands.begin(); }
176   mop_iterator operands_end() { return Operands.end(); }
177
178   const_mop_iterator operands_begin() const { return Operands.begin(); }
179   const_mop_iterator operands_end() const { return Operands.end(); }
180
181   /// Access to memory operands of the instruction
182   mmo_iterator memoperands_begin() const { return MemRefs; }
183   mmo_iterator memoperands_end() const { return MemRefsEnd; }
184   bool memoperands_empty() const { return MemRefsEnd == MemRefs; }
185
186   /// hasOneMemOperand - Return true if this instruction has exactly one
187   /// MachineMemOperand.
188   bool hasOneMemOperand() const {
189     return MemRefsEnd - MemRefs == 1;
190   }
191
192   enum MICheckType {
193     CheckDefs,      // Check all operands for equality
194     IgnoreDefs,     // Ignore all definitions
195     IgnoreVRegDefs  // Ignore virtual register definitions
196   };
197
198   /// isIdenticalTo - Return true if this instruction is identical to (same
199   /// opcode and same operands as) the specified instruction.
200   bool isIdenticalTo(const MachineInstr *Other,
201                      MICheckType Check = CheckDefs) const;
202
203   /// removeFromParent - This method unlinks 'this' from the containing basic
204   /// block, and returns it, but does not delete it.
205   MachineInstr *removeFromParent();
206   
207   /// eraseFromParent - This method unlinks 'this' from the containing basic
208   /// block and deletes it.
209   void eraseFromParent();
210
211   /// isLabel - Returns true if the MachineInstr represents a label.
212   ///
213   bool isLabel() const {
214     return getOpcode() == TargetOpcode::PROLOG_LABEL ||
215            getOpcode() == TargetOpcode::EH_LABEL ||
216            getOpcode() == TargetOpcode::GC_LABEL;
217   }
218   
219   bool isPrologLabel() const {
220     return getOpcode() == TargetOpcode::PROLOG_LABEL;
221   }
222   bool isEHLabel() const { return getOpcode() == TargetOpcode::EH_LABEL; }
223   bool isGCLabel() const { return getOpcode() == TargetOpcode::GC_LABEL; }
224   bool isDebugValue() const { return getOpcode() == TargetOpcode::DBG_VALUE; }
225   
226   bool isPHI() const { return getOpcode() == TargetOpcode::PHI; }
227   bool isKill() const { return getOpcode() == TargetOpcode::KILL; }
228   bool isImplicitDef() const { return getOpcode()==TargetOpcode::IMPLICIT_DEF; }
229   bool isInlineAsm() const { return getOpcode() == TargetOpcode::INLINEASM; }
230   bool isInsertSubreg() const {
231     return getOpcode() == TargetOpcode::INSERT_SUBREG;
232   }
233   bool isSubregToReg() const {
234     return getOpcode() == TargetOpcode::SUBREG_TO_REG;
235   }
236   bool isRegSequence() const {
237     return getOpcode() == TargetOpcode::REG_SEQUENCE;
238   }
239   bool isCopy() const {
240     return getOpcode() == TargetOpcode::COPY;
241   }
242
243   /// isCopyLike - Return true if the instruction behaves like a copy.
244   /// This does not include native copy instructions.
245   bool isCopyLike() const {
246     return isCopy() || isSubregToReg();
247   }
248
249   /// isIdentityCopy - Return true is the instruction is an identity copy.
250   bool isIdentityCopy() const {
251     return isCopy() && getOperand(0).getReg() == getOperand(1).getReg() &&
252       getOperand(0).getSubReg() == getOperand(1).getSubReg();
253   }
254
255   /// readsRegister - Return true if the MachineInstr reads the specified
256   /// register. If TargetRegisterInfo is passed, then it also checks if there
257   /// is a read of a super-register.
258   /// This does not count partial redefines of virtual registers as reads:
259   ///   %reg1024:6 = OP.
260   bool readsRegister(unsigned Reg, const TargetRegisterInfo *TRI = NULL) const {
261     return findRegisterUseOperandIdx(Reg, false, TRI) != -1;
262   }
263
264   /// readsVirtualRegister - Return true if the MachineInstr reads the specified
265   /// virtual register. Take into account that a partial define is a
266   /// read-modify-write operation.
267   bool readsVirtualRegister(unsigned Reg) const {
268     return readsWritesVirtualRegister(Reg).first;
269   }
270
271   /// readsWritesVirtualRegister - Return a pair of bools (reads, writes)
272   /// indicating if this instruction reads or writes Reg. This also considers
273   /// partial defines.
274   /// If Ops is not null, all operand indices for Reg are added.
275   std::pair<bool,bool> readsWritesVirtualRegister(unsigned Reg,
276                                       SmallVectorImpl<unsigned> *Ops = 0) const;
277
278   /// killsRegister - Return true if the MachineInstr kills the specified
279   /// register. If TargetRegisterInfo is passed, then it also checks if there is
280   /// a kill of a super-register.
281   bool killsRegister(unsigned Reg, const TargetRegisterInfo *TRI = NULL) const {
282     return findRegisterUseOperandIdx(Reg, true, TRI) != -1;
283   }
284
285   /// definesRegister - Return true if the MachineInstr fully defines the
286   /// specified register. If TargetRegisterInfo is passed, then it also checks
287   /// if there is a def of a super-register.
288   /// NOTE: It's ignoring subreg indices on virtual registers.
289   bool definesRegister(unsigned Reg, const TargetRegisterInfo *TRI=NULL) const {
290     return findRegisterDefOperandIdx(Reg, false, false, TRI) != -1;
291   }
292
293   /// modifiesRegister - Return true if the MachineInstr modifies (fully define
294   /// or partially define) the specified register.
295   /// NOTE: It's ignoring subreg indices on virtual registers.
296   bool modifiesRegister(unsigned Reg, const TargetRegisterInfo *TRI) const {
297     return findRegisterDefOperandIdx(Reg, false, true, TRI) != -1;
298   }
299
300   /// registerDefIsDead - Returns true if the register is dead in this machine
301   /// instruction. If TargetRegisterInfo is passed, then it also checks
302   /// if there is a dead def of a super-register.
303   bool registerDefIsDead(unsigned Reg,
304                          const TargetRegisterInfo *TRI = NULL) const {
305     return findRegisterDefOperandIdx(Reg, true, false, TRI) != -1;
306   }
307
308   /// findRegisterUseOperandIdx() - Returns the operand index that is a use of
309   /// the specific register or -1 if it is not found. It further tightens
310   /// the search criteria to a use that kills the register if isKill is true.
311   int findRegisterUseOperandIdx(unsigned Reg, bool isKill = false,
312                                 const TargetRegisterInfo *TRI = NULL) const;
313
314   /// findRegisterUseOperand - Wrapper for findRegisterUseOperandIdx, it returns
315   /// a pointer to the MachineOperand rather than an index.
316   MachineOperand *findRegisterUseOperand(unsigned Reg, bool isKill = false,
317                                          const TargetRegisterInfo *TRI = NULL) {
318     int Idx = findRegisterUseOperandIdx(Reg, isKill, TRI);
319     return (Idx == -1) ? NULL : &getOperand(Idx);
320   }
321   
322   /// findRegisterDefOperandIdx() - Returns the operand index that is a def of
323   /// the specified register or -1 if it is not found. If isDead is true, defs
324   /// that are not dead are skipped. If Overlap is true, then it also looks for
325   /// defs that merely overlap the specified register. If TargetRegisterInfo is
326   /// non-null, then it also checks if there is a def of a super-register.
327   int findRegisterDefOperandIdx(unsigned Reg,
328                                 bool isDead = false, bool Overlap = false,
329                                 const TargetRegisterInfo *TRI = NULL) const;
330
331   /// findRegisterDefOperand - Wrapper for findRegisterDefOperandIdx, it returns
332   /// a pointer to the MachineOperand rather than an index.
333   MachineOperand *findRegisterDefOperand(unsigned Reg, bool isDead = false,
334                                          const TargetRegisterInfo *TRI = NULL) {
335     int Idx = findRegisterDefOperandIdx(Reg, isDead, false, TRI);
336     return (Idx == -1) ? NULL : &getOperand(Idx);
337   }
338
339   /// findFirstPredOperandIdx() - Find the index of the first operand in the
340   /// operand list that is used to represent the predicate. It returns -1 if
341   /// none is found.
342   int findFirstPredOperandIdx() const;
343   
344   /// isRegTiedToUseOperand - Given the index of a register def operand,
345   /// check if the register def is tied to a source operand, due to either
346   /// two-address elimination or inline assembly constraints. Returns the
347   /// first tied use operand index by reference is UseOpIdx is not null.
348   bool isRegTiedToUseOperand(unsigned DefOpIdx, unsigned *UseOpIdx = 0) const;
349
350   /// isRegTiedToDefOperand - Return true if the use operand of the specified
351   /// index is tied to an def operand. It also returns the def operand index by
352   /// reference if DefOpIdx is not null.
353   bool isRegTiedToDefOperand(unsigned UseOpIdx, unsigned *DefOpIdx = 0) const;
354
355   /// clearKillInfo - Clears kill flags on all operands.
356   ///
357   void clearKillInfo();
358
359   /// copyKillDeadInfo - Copies kill / dead operand properties from MI.
360   ///
361   void copyKillDeadInfo(const MachineInstr *MI);
362
363   /// copyPredicates - Copies predicate operand(s) from MI.
364   void copyPredicates(const MachineInstr *MI);
365
366   /// substituteRegister - Replace all occurrences of FromReg with ToReg:SubIdx,
367   /// properly composing subreg indices where necessary.
368   void substituteRegister(unsigned FromReg, unsigned ToReg, unsigned SubIdx,
369                           const TargetRegisterInfo &RegInfo);
370
371   /// addRegisterKilled - We have determined MI kills a register. Look for the
372   /// operand that uses it and mark it as IsKill. If AddIfNotFound is true,
373   /// add a implicit operand if it's not found. Returns true if the operand
374   /// exists / is added.
375   bool addRegisterKilled(unsigned IncomingReg,
376                          const TargetRegisterInfo *RegInfo,
377                          bool AddIfNotFound = false);
378
379   /// addRegisterDead - We have determined MI defined a register without a use.
380   /// Look for the operand that defines it and mark it as IsDead. If
381   /// AddIfNotFound is true, add a implicit operand if it's not found. Returns
382   /// true if the operand exists / is added.
383   bool addRegisterDead(unsigned IncomingReg, const TargetRegisterInfo *RegInfo,
384                        bool AddIfNotFound = false);
385
386   /// addRegisterDefined - We have determined MI defines a register. Make sure
387   /// there is an operand defining Reg.
388   void addRegisterDefined(unsigned IncomingReg,
389                           const TargetRegisterInfo *RegInfo = 0);
390
391   /// setPhysRegsDeadExcept - Mark every physreg used by this instruction as dead
392   /// except those in the UsedRegs list.
393   void setPhysRegsDeadExcept(const SmallVectorImpl<unsigned> &UsedRegs,
394                              const TargetRegisterInfo &TRI);
395
396   /// isSafeToMove - Return true if it is safe to move this instruction. If
397   /// SawStore is set to true, it means that there is a store (or call) between
398   /// the instruction's location and its intended destination.
399   bool isSafeToMove(const TargetInstrInfo *TII, AliasAnalysis *AA,
400                     bool &SawStore) const;
401
402   /// isSafeToReMat - Return true if it's safe to rematerialize the specified
403   /// instruction which defined the specified register instead of copying it.
404   bool isSafeToReMat(const TargetInstrInfo *TII, AliasAnalysis *AA,
405                      unsigned DstReg) const;
406
407   /// hasVolatileMemoryRef - Return true if this instruction may have a
408   /// volatile memory reference, or if the information describing the
409   /// memory reference is not available. Return false if it is known to
410   /// have no volatile memory references.
411   bool hasVolatileMemoryRef() const;
412
413   /// isInvariantLoad - Return true if this instruction is loading from a
414   /// location whose value is invariant across the function.  For example,
415   /// loading a value from the constant pool or from the argument area of
416   /// a function if it does not change.  This should only return true of *all*
417   /// loads the instruction does are invariant (if it does multiple loads).
418   bool isInvariantLoad(AliasAnalysis *AA) const;
419
420   /// isConstantValuePHI - If the specified instruction is a PHI that always
421   /// merges together the same virtual register, return the register, otherwise
422   /// return 0.
423   unsigned isConstantValuePHI() const;
424
425   /// allDefsAreDead - Return true if all the defs of this instruction are dead.
426   ///
427   bool allDefsAreDead() const;
428
429   /// copyImplicitOps - Copy implicit register operands from specified
430   /// instruction to this instruction.
431   void copyImplicitOps(const MachineInstr *MI);
432
433   //
434   // Debugging support
435   //
436   void print(raw_ostream &OS, const TargetMachine *TM = 0) const;
437   void dump() const;
438
439   //===--------------------------------------------------------------------===//
440   // Accessors used to build up machine instructions.
441
442   /// addOperand - Add the specified operand to the instruction.  If it is an
443   /// implicit operand, it is added to the end of the operand list.  If it is
444   /// an explicit operand it is added at the end of the explicit operand list
445   /// (before the first implicit operand). 
446   void addOperand(const MachineOperand &Op);
447   
448   /// setDesc - Replace the instruction descriptor (thus opcode) of
449   /// the current instruction with a new one.
450   ///
451   void setDesc(const TargetInstrDesc &tid) { TID = &tid; }
452
453   /// setDebugLoc - Replace current source information with new such.
454   /// Avoid using this, the constructor argument is preferable.
455   ///
456   void setDebugLoc(const DebugLoc dl) { debugLoc = dl; }
457
458   /// RemoveOperand - Erase an operand  from an instruction, leaving it with one
459   /// fewer operand than it started with.
460   ///
461   void RemoveOperand(unsigned i);
462
463   /// addMemOperand - Add a MachineMemOperand to the machine instruction.
464   /// This function should be used only occasionally. The setMemRefs function
465   /// is the primary method for setting up a MachineInstr's MemRefs list.
466   void addMemOperand(MachineFunction &MF, MachineMemOperand *MO);
467
468   /// setMemRefs - Assign this MachineInstr's memory reference descriptor
469   /// list. This does not transfer ownership.
470   void setMemRefs(mmo_iterator NewMemRefs, mmo_iterator NewMemRefsEnd) {
471     MemRefs = NewMemRefs;
472     MemRefsEnd = NewMemRefsEnd;
473   }
474
475 private:
476   /// getRegInfo - If this instruction is embedded into a MachineFunction,
477   /// return the MachineRegisterInfo object for the current function, otherwise
478   /// return null.
479   MachineRegisterInfo *getRegInfo();
480
481   /// addImplicitDefUseOperands - Add all implicit def and use operands to
482   /// this instruction.
483   void addImplicitDefUseOperands();
484   
485   /// RemoveRegOperandsFromUseLists - Unlink all of the register operands in
486   /// this instruction from their respective use lists.  This requires that the
487   /// operands already be on their use lists.
488   void RemoveRegOperandsFromUseLists();
489   
490   /// AddRegOperandsToUseLists - Add all of the register operands in
491   /// this instruction from their respective use lists.  This requires that the
492   /// operands not be on their use lists yet.
493   void AddRegOperandsToUseLists(MachineRegisterInfo &RegInfo);
494 };
495
496 /// MachineInstrExpressionTrait - Special DenseMapInfo traits to compare
497 /// MachineInstr* by *value* of the instruction rather than by pointer value.
498 /// The hashing and equality testing functions ignore definitions so this is
499 /// useful for CSE, etc.
500 struct MachineInstrExpressionTrait : DenseMapInfo<MachineInstr*> {
501   static inline MachineInstr *getEmptyKey() {
502     return 0;
503   }
504
505   static inline MachineInstr *getTombstoneKey() {
506     return reinterpret_cast<MachineInstr*>(-1);
507   }
508
509   static unsigned getHashValue(const MachineInstr* const &MI);
510
511   static bool isEqual(const MachineInstr* const &LHS,
512                       const MachineInstr* const &RHS) {
513     if (RHS == getEmptyKey() || RHS == getTombstoneKey() ||
514         LHS == getEmptyKey() || LHS == getTombstoneKey())
515       return LHS == RHS;
516     return LHS->isIdenticalTo(RHS, MachineInstr::IgnoreVRegDefs);
517   }
518 };
519
520 //===----------------------------------------------------------------------===//
521 // Debugging Support
522
523 inline raw_ostream& operator<<(raw_ostream &OS, const MachineInstr &MI) {
524   MI.print(OS);
525   return OS;
526 }
527
528 } // End llvm namespace
529
530 #endif