1 //===-- llvm/CodeGen/MachineInstr.h - MachineInstr class --------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 // This file contains the declaration of the MachineInstr class, which is the
11 // basic representation for all target dependent machine instructions used by
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_CODEGEN_MACHINEINSTR_H
17 #define LLVM_CODEGEN_MACHINEINSTR_H
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"
31 template <typename T> class SmallVectorImpl;
33 class TargetInstrDesc;
34 class TargetInstrInfo;
35 class TargetRegisterInfo;
36 class MachineFunction;
37 class MachineMemOperand;
39 //===----------------------------------------------------------------------===//
40 /// MachineInstr - Representation of each machine instruction.
42 class MachineInstr : public ilist_node<MachineInstr> {
44 typedef MachineMemOperand **mmo_iterator;
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.
55 const TargetInstrDesc *TID; // Instruction descriptor.
56 unsigned short NumImplicitOps; // Number of implicit operands (which
57 // are determined at construction time).
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.
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.
72 // OperandComplete - Return true if it's illegal to add a new operand
73 bool OperandsComplete() const;
75 MachineInstr(const MachineInstr&); // DO NOT IMPLEMENT
76 void operator=(const MachineInstr&); // DO NOT IMPLEMENT
78 // Intrusive list support
79 friend struct ilist_traits<MachineInstr>;
80 friend struct ilist_traits<MachineBasicBlock>;
81 void setParent(MachineBasicBlock *P) { Parent = P; }
83 /// MachineInstr ctor - This constructor creates a copy of the given
84 /// MachineInstr in the given MachineFunction.
85 MachineInstr(MachineFunction &, const MachineInstr &);
87 /// MachineInstr ctor - This constructor creates a dummy MachineInstr with
88 /// TID NULL and no operands.
91 // The next two constructors have DebugLoc and non-DebugLoc versions;
92 // over time, the non-DebugLoc versions should be phased out and eventually
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);
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);
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,
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
114 MachineInstr(MachineBasicBlock *MBB, const DebugLoc dl,
115 const TargetInstrDesc &TID);
119 // MachineInstrs are pool-allocated and owned by MachineFunction.
120 friend class MachineFunction;
123 const MachineBasicBlock* getParent() const { return Parent; }
124 MachineBasicBlock* getParent() { return Parent; }
126 /// getAsmPrinterFlags - Return the asm printer flags bitvector.
128 unsigned short getAsmPrinterFlags() const { return AsmPrinterFlags; }
130 /// getAsmPrinterFlag - Return whether an AsmPrinter flag is set.
132 bool getAsmPrinterFlag(CommentFlag Flag) const {
133 return AsmPrinterFlags & Flag;
136 /// setAsmPrinterFlag - Set a flag for the AsmPrinter.
138 void setAsmPrinterFlag(CommentFlag Flag) {
139 AsmPrinterFlags |= (unsigned short)Flag;
142 /// getDebugLoc - Returns the debug location id of this MachineInstr.
144 DebugLoc getDebugLoc() const { return debugLoc; }
146 /// getDesc - Returns the target instruction descriptor of this
148 const TargetInstrDesc &getDesc() const { return *TID; }
150 /// getOpcode - Returns the opcode of this MachineInstr.
152 int getOpcode() const { return TID->Opcode; }
154 /// Access to explicit operands of the instruction.
156 unsigned getNumOperands() const { return (unsigned)Operands.size(); }
158 const MachineOperand& getOperand(unsigned i) const {
159 assert(i < getNumOperands() && "getOperand() out of range!");
162 MachineOperand& getOperand(unsigned i) {
163 assert(i < getNumOperands() && "getOperand() out of range!");
167 /// getNumExplicitOperands - Returns the number of non-implicit operands.
169 unsigned getNumExplicitOperands() const;
171 /// Access to memory operands of the instruction
172 mmo_iterator memoperands_begin() const { return MemRefs; }
173 mmo_iterator memoperands_end() const { return MemRefsEnd; }
174 bool memoperands_empty() const { return MemRefsEnd == MemRefs; }
176 /// hasOneMemOperand - Return true if this instruction has exactly one
177 /// MachineMemOperand.
178 bool hasOneMemOperand() const {
179 return MemRefsEnd - MemRefs == 1;
183 CheckDefs, // Check all operands for equality
184 IgnoreDefs, // Ignore all definitions
185 IgnoreVRegDefs // Ignore virtual register definitions
188 /// isIdenticalTo - Return true if this instruction is identical to (same
189 /// opcode and same operands as) the specified instruction.
190 bool isIdenticalTo(const MachineInstr *Other,
191 MICheckType Check = CheckDefs) const;
193 /// removeFromParent - This method unlinks 'this' from the containing basic
194 /// block, and returns it, but does not delete it.
195 MachineInstr *removeFromParent();
197 /// eraseFromParent - This method unlinks 'this' from the containing basic
198 /// block and deletes it.
199 void eraseFromParent();
201 /// isLabel - Returns true if the MachineInstr represents a label.
203 bool isLabel() const {
204 return getOpcode() == TargetOpcode::DBG_LABEL ||
205 getOpcode() == TargetOpcode::EH_LABEL ||
206 getOpcode() == TargetOpcode::GC_LABEL;
209 bool isDebugLabel() const { return getOpcode() == TargetOpcode::DBG_LABEL; }
210 bool isEHLabel() const { return getOpcode() == TargetOpcode::EH_LABEL; }
211 bool isGCLabel() const { return getOpcode() == TargetOpcode::GC_LABEL; }
212 bool isDebugValue() const { return getOpcode() == TargetOpcode::DBG_VALUE; }
214 bool isPHI() const { return getOpcode() == TargetOpcode::PHI; }
215 bool isKill() const { return getOpcode() == TargetOpcode::KILL; }
216 bool isImplicitDef() const { return getOpcode()==TargetOpcode::IMPLICIT_DEF; }
217 bool isInlineAsm() const { return getOpcode() == TargetOpcode::INLINEASM; }
218 bool isExtractSubreg() const {
219 return getOpcode() == TargetOpcode::EXTRACT_SUBREG;
221 bool isInsertSubreg() const {
222 return getOpcode() == TargetOpcode::INSERT_SUBREG;
224 bool isSubregToReg() const {
225 return getOpcode() == TargetOpcode::SUBREG_TO_REG;
227 bool isRegSequence() const {
228 return getOpcode() == TargetOpcode::REG_SEQUENCE;
231 /// readsRegister - Return true if the MachineInstr reads the specified
232 /// register. If TargetRegisterInfo is passed, then it also checks if there
233 /// is a read of a super-register.
234 /// This does not count partial redefines of virtual registers as reads:
236 bool readsRegister(unsigned Reg, const TargetRegisterInfo *TRI = NULL) const {
237 return findRegisterUseOperandIdx(Reg, false, TRI) != -1;
240 /// readsVirtualRegister - Return true if the MachineInstr reads the specified
241 /// virtual register. Take into account that a partial define is a
242 /// read-modify-write operation.
243 bool readsVirtualRegister(unsigned Reg) const {
244 return readsWritesVirtualRegister(Reg).first;
247 /// readsWritesVirtualRegister - Return a pair of bools (reads, writes)
248 /// indicating if this instruction reads or writes Reg. This also considers
250 /// If Ops is not null, all operand indices for Reg are added.
251 std::pair<bool,bool> readsWritesVirtualRegister(unsigned Reg,
252 SmallVectorImpl<unsigned> *Ops = 0) const;
254 /// killsRegister - Return true if the MachineInstr kills the specified
255 /// register. If TargetRegisterInfo is passed, then it also checks if there is
256 /// a kill of a super-register.
257 bool killsRegister(unsigned Reg, const TargetRegisterInfo *TRI = NULL) const {
258 return findRegisterUseOperandIdx(Reg, true, TRI) != -1;
261 /// definesRegister - Return true if the MachineInstr fully defines the
262 /// specified register. If TargetRegisterInfo is passed, then it also checks
263 /// if there is a def of a super-register.
264 /// NOTE: It's ignoring subreg indices on virtual registers.
265 bool definesRegister(unsigned Reg, const TargetRegisterInfo *TRI=NULL) const {
266 return findRegisterDefOperandIdx(Reg, false, false, TRI) != -1;
269 /// modifiesRegister - Return true if the MachineInstr modifies (fully define
270 /// or partially define) the specified register.
271 /// NOTE: It's ignoring subreg indices on virtual registers.
272 bool modifiesRegister(unsigned Reg, const TargetRegisterInfo *TRI) const {
273 return findRegisterDefOperandIdx(Reg, false, true, TRI) != -1;
276 /// registerDefIsDead - Returns true if the register is dead in this machine
277 /// instruction. If TargetRegisterInfo is passed, then it also checks
278 /// if there is a dead def of a super-register.
279 bool registerDefIsDead(unsigned Reg,
280 const TargetRegisterInfo *TRI = NULL) const {
281 return findRegisterDefOperandIdx(Reg, true, false, TRI) != -1;
284 /// findRegisterUseOperandIdx() - Returns the operand index that is a use of
285 /// the specific register or -1 if it is not found. It further tightens
286 /// the search criteria to a use that kills the register if isKill is true.
287 int findRegisterUseOperandIdx(unsigned Reg, bool isKill = false,
288 const TargetRegisterInfo *TRI = NULL) const;
290 /// findRegisterUseOperand - Wrapper for findRegisterUseOperandIdx, it returns
291 /// a pointer to the MachineOperand rather than an index.
292 MachineOperand *findRegisterUseOperand(unsigned Reg, bool isKill = false,
293 const TargetRegisterInfo *TRI = NULL) {
294 int Idx = findRegisterUseOperandIdx(Reg, isKill, TRI);
295 return (Idx == -1) ? NULL : &getOperand(Idx);
298 /// findRegisterDefOperandIdx() - Returns the operand index that is a def of
299 /// the specified register or -1 if it is not found. If isDead is true, defs
300 /// that are not dead are skipped. If Overlap is true, then it also looks for
301 /// defs that merely overlap the specified register. If TargetRegisterInfo is
302 /// non-null, then it also checks if there is a def of a super-register.
303 int findRegisterDefOperandIdx(unsigned Reg,
304 bool isDead = false, bool Overlap = false,
305 const TargetRegisterInfo *TRI = NULL) const;
307 /// findRegisterDefOperand - Wrapper for findRegisterDefOperandIdx, it returns
308 /// a pointer to the MachineOperand rather than an index.
309 MachineOperand *findRegisterDefOperand(unsigned Reg, bool isDead = false,
310 const TargetRegisterInfo *TRI = NULL) {
311 int Idx = findRegisterDefOperandIdx(Reg, isDead, false, TRI);
312 return (Idx == -1) ? NULL : &getOperand(Idx);
315 /// findFirstPredOperandIdx() - Find the index of the first operand in the
316 /// operand list that is used to represent the predicate. It returns -1 if
318 int findFirstPredOperandIdx() const;
320 /// isRegTiedToUseOperand - Given the index of a register def operand,
321 /// check if the register def is tied to a source operand, due to either
322 /// two-address elimination or inline assembly constraints. Returns the
323 /// first tied use operand index by reference is UseOpIdx is not null.
324 bool isRegTiedToUseOperand(unsigned DefOpIdx, unsigned *UseOpIdx = 0) const;
326 /// isRegTiedToDefOperand - Return true if the use operand of the specified
327 /// index is tied to an def operand. It also returns the def operand index by
328 /// reference if DefOpIdx is not null.
329 bool isRegTiedToDefOperand(unsigned UseOpIdx, unsigned *DefOpIdx = 0) const;
331 /// clearKillInfo - Clears kill flags on all operands.
333 void clearKillInfo();
335 /// copyKillDeadInfo - Copies kill / dead operand properties from MI.
337 void copyKillDeadInfo(const MachineInstr *MI);
339 /// copyPredicates - Copies predicate operand(s) from MI.
340 void copyPredicates(const MachineInstr *MI);
342 /// substituteRegister - Replace all occurrences of FromReg with ToReg:SubIdx,
343 /// properly composing subreg indices where necessary.
344 void substituteRegister(unsigned FromReg, unsigned ToReg, unsigned SubIdx,
345 const TargetRegisterInfo &RegInfo);
347 /// addRegisterKilled - We have determined MI kills a register. Look for the
348 /// operand that uses it and mark it as IsKill. If AddIfNotFound is true,
349 /// add a implicit operand if it's not found. Returns true if the operand
350 /// exists / is added.
351 bool addRegisterKilled(unsigned IncomingReg,
352 const TargetRegisterInfo *RegInfo,
353 bool AddIfNotFound = false);
355 /// addRegisterDead - We have determined MI defined a register without a use.
356 /// Look for the operand that defines it and mark it as IsDead. If
357 /// AddIfNotFound is true, add a implicit operand if it's not found. Returns
358 /// true if the operand exists / is added.
359 bool addRegisterDead(unsigned IncomingReg, const TargetRegisterInfo *RegInfo,
360 bool AddIfNotFound = false);
362 /// addRegisterDefined - We have determined MI defines a register. Make sure
363 /// there is an operand defining Reg.
364 void addRegisterDefined(unsigned IncomingReg,
365 const TargetRegisterInfo *RegInfo = 0);
367 /// isSafeToMove - Return true if it is safe to move this instruction. If
368 /// SawStore is set to true, it means that there is a store (or call) between
369 /// the instruction's location and its intended destination.
370 bool isSafeToMove(const TargetInstrInfo *TII, AliasAnalysis *AA,
371 bool &SawStore) const;
373 /// isSafeToReMat - Return true if it's safe to rematerialize the specified
374 /// instruction which defined the specified register instead of copying it.
375 bool isSafeToReMat(const TargetInstrInfo *TII, AliasAnalysis *AA,
376 unsigned DstReg) const;
378 /// hasVolatileMemoryRef - Return true if this instruction may have a
379 /// volatile memory reference, or if the information describing the
380 /// memory reference is not available. Return false if it is known to
381 /// have no volatile memory references.
382 bool hasVolatileMemoryRef() const;
384 /// isInvariantLoad - Return true if this instruction is loading from a
385 /// location whose value is invariant across the function. For example,
386 /// loading a value from the constant pool or from the argument area of
387 /// a function if it does not change. This should only return true of *all*
388 /// loads the instruction does are invariant (if it does multiple loads).
389 bool isInvariantLoad(AliasAnalysis *AA) const;
391 /// isConstantValuePHI - If the specified instruction is a PHI that always
392 /// merges together the same virtual register, return the register, otherwise
394 unsigned isConstantValuePHI() const;
396 /// allDefsAreDead - Return true if all the defs of this instruction are dead.
398 bool allDefsAreDead() const;
403 void print(raw_ostream &OS, const TargetMachine *TM = 0) const;
406 //===--------------------------------------------------------------------===//
407 // Accessors used to build up machine instructions.
409 /// addOperand - Add the specified operand to the instruction. If it is an
410 /// implicit operand, it is added to the end of the operand list. If it is
411 /// an explicit operand it is added at the end of the explicit operand list
412 /// (before the first implicit operand).
413 void addOperand(const MachineOperand &Op);
415 /// setDesc - Replace the instruction descriptor (thus opcode) of
416 /// the current instruction with a new one.
418 void setDesc(const TargetInstrDesc &tid) { TID = &tid; }
420 /// setDebugLoc - Replace current source information with new such.
421 /// Avoid using this, the constructor argument is preferable.
423 void setDebugLoc(const DebugLoc dl) { debugLoc = dl; }
425 /// RemoveOperand - Erase an operand from an instruction, leaving it with one
426 /// fewer operand than it started with.
428 void RemoveOperand(unsigned i);
430 /// addMemOperand - Add a MachineMemOperand to the machine instruction.
431 /// This function should be used only occasionally. The setMemRefs function
432 /// is the primary method for setting up a MachineInstr's MemRefs list.
433 void addMemOperand(MachineFunction &MF, MachineMemOperand *MO);
435 /// setMemRefs - Assign this MachineInstr's memory reference descriptor
436 /// list. This does not transfer ownership.
437 void setMemRefs(mmo_iterator NewMemRefs, mmo_iterator NewMemRefsEnd) {
438 MemRefs = NewMemRefs;
439 MemRefsEnd = NewMemRefsEnd;
443 /// getRegInfo - If this instruction is embedded into a MachineFunction,
444 /// return the MachineRegisterInfo object for the current function, otherwise
446 MachineRegisterInfo *getRegInfo();
448 /// addImplicitDefUseOperands - Add all implicit def and use operands to
449 /// this instruction.
450 void addImplicitDefUseOperands();
452 /// RemoveRegOperandsFromUseLists - Unlink all of the register operands in
453 /// this instruction from their respective use lists. This requires that the
454 /// operands already be on their use lists.
455 void RemoveRegOperandsFromUseLists();
457 /// AddRegOperandsToUseLists - Add all of the register operands in
458 /// this instruction from their respective use lists. This requires that the
459 /// operands not be on their use lists yet.
460 void AddRegOperandsToUseLists(MachineRegisterInfo &RegInfo);
463 /// MachineInstrExpressionTrait - Special DenseMapInfo traits to compare
464 /// MachineInstr* by *value* of the instruction rather than by pointer value.
465 /// The hashing and equality testing functions ignore definitions so this is
466 /// useful for CSE, etc.
467 struct MachineInstrExpressionTrait : DenseMapInfo<MachineInstr*> {
468 static inline MachineInstr *getEmptyKey() {
472 static inline MachineInstr *getTombstoneKey() {
473 return reinterpret_cast<MachineInstr*>(-1);
476 static unsigned getHashValue(const MachineInstr* const &MI);
478 static bool isEqual(const MachineInstr* const &LHS,
479 const MachineInstr* const &RHS) {
480 if (RHS == getEmptyKey() || RHS == getTombstoneKey() ||
481 LHS == getEmptyKey() || LHS == getTombstoneKey())
483 return LHS->isIdenticalTo(RHS, MachineInstr::IgnoreVRegDefs);
487 //===----------------------------------------------------------------------===//
490 inline raw_ostream& operator<<(raw_ostream &OS, const MachineInstr &MI) {
495 } // End llvm namespace