cb85ca897871d9791c2641d529b04a96c0a300f8
[opencl/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 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_CODEGEN_MACHINEINSTR_H
17 #define LLVM_CODEGEN_MACHINEINSTR_H
19 #include "llvm/ADT/ArrayRef.h"
20 #include "llvm/ADT/DenseMapInfo.h"
21 #include "llvm/ADT/STLExtras.h"
22 #include "llvm/ADT/StringRef.h"
23 #include "llvm/ADT/ilist.h"
24 #include "llvm/ADT/ilist_node.h"
25 #include "llvm/ADT/iterator_range.h"
26 #include "llvm/CodeGen/MachineOperand.h"
27 #include "llvm/IR/DebugInfo.h"
28 #include "llvm/IR/DebugLoc.h"
29 #include "llvm/IR/InlineAsm.h"
30 #include "llvm/MC/MCInstrDesc.h"
31 #include "llvm/Support/ArrayRecycler.h"
32 #include "llvm/Target/TargetOpcodes.h"
34 namespace llvm {
36 template <typename T> class SmallVectorImpl;
37 class AliasAnalysis;
38 class TargetInstrInfo;
39 class TargetRegisterClass;
40 class TargetRegisterInfo;
41 class MachineFunction;
42 class MachineMemOperand;
44 //===----------------------------------------------------------------------===//
45 /// MachineInstr - Representation of each machine instruction.
46 ///
47 /// This class isn't a POD type, but it must have a trivial destructor. When a
48 /// MachineFunction is deleted, all the contained MachineInstrs are deallocated
49 /// without having their destructor called.
50 ///
51 class MachineInstr : public ilist_node<MachineInstr> {
52 public:
53   typedef MachineMemOperand **mmo_iterator;
55   /// Flags to specify different kinds of comments to output in
56   /// assembly code.  These flags carry semantic information not
57   /// otherwise easily derivable from the IR text.
58   ///
59   enum CommentFlag {
60     ReloadReuse = 0x1
61   };
63   enum MIFlag {
64     NoFlags      = 0,
65     FrameSetup   = 1 << 0,              // Instruction is used as a part of
66                                         // function frame setup code.
67     BundledPred  = 1 << 1,              // Instruction has bundled predecessors.
68     BundledSucc  = 1 << 2               // Instruction has bundled successors.
69   };
70 private:
71   const MCInstrDesc *MCID;              // Instruction descriptor.
72   MachineBasicBlock *Parent;            // Pointer to the owning basic block.
74   // Operands are allocated by an ArrayRecycler.
75   MachineOperand *Operands;             // Pointer to the first operand.
76   unsigned NumOperands;                 // Number of operands on instruction.
77   typedef ArrayRecycler<MachineOperand>::Capacity OperandCapacity;
78   OperandCapacity CapOperands;          // Capacity of the Operands array.
80   uint8_t Flags;                        // Various bits of additional
81                                         // information about machine
82                                         // instruction.
84   uint8_t AsmPrinterFlags;              // Various bits of information used by
85                                         // the AsmPrinter to emit helpful
86                                         // comments.  This is *not* semantic
87                                         // information.  Do not use this for
88                                         // anything other than to convey comment
89                                         // information to AsmPrinter.
91   uint8_t NumMemRefs;                   // Information on memory references.
92   mmo_iterator MemRefs;
94   DebugLoc debugLoc;                    // Source line information.
96   MachineInstr(const MachineInstr&) LLVM_DELETED_FUNCTION;
97   void operator=(const MachineInstr&) LLVM_DELETED_FUNCTION;
98   // Use MachineFunction::DeleteMachineInstr() instead.
99   ~MachineInstr() LLVM_DELETED_FUNCTION;
101   // Intrusive list support
102   friend struct ilist_traits<MachineInstr>;
103   friend struct ilist_traits<MachineBasicBlock>;
104   void setParent(MachineBasicBlock *P) { Parent = P; }
106   /// MachineInstr ctor - This constructor creates a copy of the given
107   /// MachineInstr in the given MachineFunction.
108   MachineInstr(MachineFunction &, const MachineInstr &);
110   /// MachineInstr ctor - This constructor create a MachineInstr and add the
111   /// implicit operands.  It reserves space for number of operands specified by
112   /// MCInstrDesc.  An explicit DebugLoc is supplied.
113   MachineInstr(MachineFunction&, const MCInstrDesc &MCID,
114                const DebugLoc dl, bool NoImp = false);
116   // MachineInstrs are pool-allocated and owned by MachineFunction.
117   friend class MachineFunction;
119 public:
120   const MachineBasicBlock* getParent() const { return Parent; }
121   MachineBasicBlock* getParent() { return Parent; }
123   /// getAsmPrinterFlags - Return the asm printer flags bitvector.
124   ///
125   uint8_t getAsmPrinterFlags() const { return AsmPrinterFlags; }
127   /// clearAsmPrinterFlags - clear the AsmPrinter bitvector
128   ///
129   void clearAsmPrinterFlags() { AsmPrinterFlags = 0; }
131   /// getAsmPrinterFlag - Return whether an AsmPrinter flag is set.
132   ///
133   bool getAsmPrinterFlag(CommentFlag Flag) const {
134     return AsmPrinterFlags & Flag;
135   }
137   /// setAsmPrinterFlag - Set a flag for the AsmPrinter.
138   ///
139   void setAsmPrinterFlag(CommentFlag Flag) {
140     AsmPrinterFlags |= (uint8_t)Flag;
141   }
143   /// clearAsmPrinterFlag - clear specific AsmPrinter flags
144   ///
145   void clearAsmPrinterFlag(CommentFlag Flag) {
146     AsmPrinterFlags &= ~Flag;
147   }
149   /// getFlags - Return the MI flags bitvector.
150   uint8_t getFlags() const {
151     return Flags;
152   }
154   /// getFlag - Return whether an MI flag is set.
155   bool getFlag(MIFlag Flag) const {
156     return Flags & Flag;
157   }
159   /// setFlag - Set a MI flag.
160   void setFlag(MIFlag Flag) {
161     Flags |= (uint8_t)Flag;
162   }
164   void setFlags(unsigned flags) {
165     // Filter out the automatically maintained flags.
166     unsigned Mask = BundledPred | BundledSucc;
167     Flags = (Flags & Mask) | (flags & ~Mask);
168   }
170   /// clearFlag - Clear a MI flag.
171   void clearFlag(MIFlag Flag) {
172     Flags &= ~((uint8_t)Flag);
173   }
175   /// isInsideBundle - Return true if MI is in a bundle (but not the first MI
176   /// in a bundle).
177   ///
178   /// A bundle looks like this before it's finalized:
179   ///   ----------------
180   ///   |      MI      |
181   ///   ----------------
182   ///          |
183   ///   ----------------
184   ///   |      MI    * |
185   ///   ----------------
186   ///          |
187   ///   ----------------
188   ///   |      MI    * |
189   ///   ----------------
190   /// In this case, the first MI starts a bundle but is not inside a bundle, the
191   /// next 2 MIs are considered "inside" the bundle.
192   ///
193   /// After a bundle is finalized, it looks like this:
194   ///   ----------------
195   ///   |    Bundle    |
196   ///   ----------------
197   ///          |
198   ///   ----------------
199   ///   |      MI    * |
200   ///   ----------------
201   ///          |
202   ///   ----------------
203   ///   |      MI    * |
204   ///   ----------------
205   ///          |
206   ///   ----------------
207   ///   |      MI    * |
208   ///   ----------------
209   /// The first instruction has the special opcode "BUNDLE". It's not "inside"
210   /// a bundle, but the next three MIs are.
211   bool isInsideBundle() const {
212     return getFlag(BundledPred);
213   }
215   /// isBundled - Return true if this instruction part of a bundle. This is true
216   /// if either itself or its following instruction is marked "InsideBundle".
217   bool isBundled() const {
218     return isBundledWithPred() || isBundledWithSucc();
219   }
221   /// Return true if this instruction is part of a bundle, and it is not the
222   /// first instruction in the bundle.
223   bool isBundledWithPred() const { return getFlag(BundledPred); }
225   /// Return true if this instruction is part of a bundle, and it is not the
226   /// last instruction in the bundle.
227   bool isBundledWithSucc() const { return getFlag(BundledSucc); }
229   /// Bundle this instruction with its predecessor. This can be an unbundled
230   /// instruction, or it can be the first instruction in a bundle.
231   void bundleWithPred();
233   /// Bundle this instruction with its successor. This can be an unbundled
234   /// instruction, or it can be the last instruction in a bundle.
235   void bundleWithSucc();
237   /// Break bundle above this instruction.
238   void unbundleFromPred();
240   /// Break bundle below this instruction.
241   void unbundleFromSucc();
243   /// getDebugLoc - Returns the debug location id of this MachineInstr.
244   ///
245   DebugLoc getDebugLoc() const { return debugLoc; }
247   /// getDebugVariable() - Return the debug variable referenced by
248   /// this DBG_VALUE instruction.
249   const MDNode *getDebugVariable() const {
250     assert(isDebugValue() && "not a DBG_VALUE");
251     return getOperand(getNumOperands() - 1).getMetadata();
252   }
254   /// emitError - Emit an error referring to the source location of this
255   /// instruction. This should only be used for inline assembly that is somehow
256   /// impossible to compile. Other errors should have been handled much
257   /// earlier.
258   ///
259   /// If this method returns, the caller should try to recover from the error.
260   ///
261   void emitError(StringRef Msg) const;
263   /// getDesc - Returns the target instruction descriptor of this
264   /// MachineInstr.
265   const MCInstrDesc &getDesc() const { return *MCID; }
267   /// getOpcode - Returns the opcode of this MachineInstr.
268   ///
269   int getOpcode() const { return MCID->Opcode; }
271   /// Access to explicit operands of the instruction.
272   ///
273   unsigned getNumOperands() const { return NumOperands; }
275   const MachineOperand& getOperand(unsigned i) const {
276     assert(i < getNumOperands() && "getOperand() out of range!");
277     return Operands[i];
278   }
279   MachineOperand& getOperand(unsigned i) {
280     assert(i < getNumOperands() && "getOperand() out of range!");
281     return Operands[i];
282   }
284   /// getNumExplicitOperands - Returns the number of non-implicit operands.
285   ///
286   unsigned getNumExplicitOperands() const;
288   /// iterator/begin/end - Iterate over all operands of a machine instruction.
289   typedef MachineOperand *mop_iterator;
290   typedef const MachineOperand *const_mop_iterator;
292   mop_iterator operands_begin() { return Operands; }
293   mop_iterator operands_end() { return Operands + NumOperands; }
295   const_mop_iterator operands_begin() const { return Operands; }
296   const_mop_iterator operands_end() const { return Operands + NumOperands; }
298   iterator_range<mop_iterator> operands() {
299     return iterator_range<mop_iterator>(operands_begin(), operands_end());
300   }
301   iterator_range<const_mop_iterator> operands() const {
302     return iterator_range<const_mop_iterator>(operands_begin(), operands_end());
303   }
304   iterator_range<mop_iterator> explicit_operands() {
305     return iterator_range<mop_iterator>(
306         operands_begin(), operands_begin() + getNumExplicitOperands());
307   }
308   iterator_range<const_mop_iterator> explicit_operands() const {
309     return iterator_range<const_mop_iterator>(
310         operands_begin(), operands_begin() + getNumExplicitOperands());
311   }
312   iterator_range<mop_iterator> implicit_operands() {
313     return iterator_range<mop_iterator>(explicit_operands().end(),
314                                         operands_end());
315   }
316   iterator_range<const_mop_iterator> implicit_operands() const {
317     return iterator_range<const_mop_iterator>(explicit_operands().end(),
318                                               operands_end());
319   }
321   /// Access to memory operands of the instruction
322   mmo_iterator memoperands_begin() const { return MemRefs; }
323   mmo_iterator memoperands_end() const { return MemRefs + NumMemRefs; }
324   bool memoperands_empty() const { return NumMemRefs == 0; }
326   iterator_range<mmo_iterator>  memoperands() {
327     return iterator_range<mmo_iterator>(memoperands_begin(), memoperands_end());
328   }
329   iterator_range<mmo_iterator> memoperands() const {
330     return iterator_range<mmo_iterator>(memoperands_begin(), memoperands_end());
331   }
333   /// hasOneMemOperand - Return true if this instruction has exactly one
334   /// MachineMemOperand.
335   bool hasOneMemOperand() const {
336     return NumMemRefs == 1;
337   }
339   /// API for querying MachineInstr properties. They are the same as MCInstrDesc
340   /// queries but they are bundle aware.
342   enum QueryType {
343     IgnoreBundle,    // Ignore bundles
344     AnyInBundle,     // Return true if any instruction in bundle has property
345     AllInBundle      // Return true if all instructions in bundle have property
346   };
348   /// hasProperty - Return true if the instruction (or in the case of a bundle,
349   /// the instructions inside the bundle) has the specified property.
350   /// The first argument is the property being queried.
351   /// The second argument indicates whether the query should look inside
352   /// instruction bundles.
353   bool hasProperty(unsigned MCFlag, QueryType Type = AnyInBundle) const {
354     // Inline the fast path for unbundled or bundle-internal instructions.
355     if (Type == IgnoreBundle || !isBundled() || isBundledWithPred())
356       return getDesc().getFlags() & (1 << MCFlag);
358     // If this is the first instruction in a bundle, take the slow path.
359     return hasPropertyInBundle(1 << MCFlag, Type);
360   }
362   /// isVariadic - Return true if this instruction can have a variable number of
363   /// operands.  In this case, the variable operands will be after the normal
364   /// operands but before the implicit definitions and uses (if any are
365   /// present).
366   bool isVariadic(QueryType Type = IgnoreBundle) const {
367     return hasProperty(MCID::Variadic, Type);
368   }
370   /// hasOptionalDef - Set if this instruction has an optional definition, e.g.
371   /// ARM instructions which can set condition code if 's' bit is set.
372   bool hasOptionalDef(QueryType Type = IgnoreBundle) const {
373     return hasProperty(MCID::HasOptionalDef, Type);
374   }
376   /// isPseudo - Return true if this is a pseudo instruction that doesn't
377   /// correspond to a real machine instruction.
378   ///
379   bool isPseudo(QueryType Type = IgnoreBundle) const {
380     return hasProperty(MCID::Pseudo, Type);
381   }
383   bool isReturn(QueryType Type = AnyInBundle) const {
384     return hasProperty(MCID::Return, Type);
385   }
387   bool isCall(QueryType Type = AnyInBundle) const {
388     return hasProperty(MCID::Call, Type);
389   }
391   /// isBarrier - Returns true if the specified instruction stops control flow
392   /// from executing the instruction immediately following it.  Examples include
393   /// unconditional branches and return instructions.
394   bool isBarrier(QueryType Type = AnyInBundle) const {
395     return hasProperty(MCID::Barrier, Type);
396   }
398   /// isTerminator - Returns true if this instruction part of the terminator for
399   /// a basic block.  Typically this is things like return and branch
400   /// instructions.
401   ///
402   /// Various passes use this to insert code into the bottom of a basic block,
403   /// but before control flow occurs.
404   bool isTerminator(QueryType Type = AnyInBundle) const {
405     return hasProperty(MCID::Terminator, Type);
406   }
408   /// isBranch - Returns true if this is a conditional, unconditional, or
409   /// indirect branch.  Predicates below can be used to discriminate between
410   /// these cases, and the TargetInstrInfo::AnalyzeBranch method can be used to
411   /// get more information.
412   bool isBranch(QueryType Type = AnyInBundle) const {
413     return hasProperty(MCID::Branch, Type);
414   }
416   /// isIndirectBranch - Return true if this is an indirect branch, such as a
417   /// branch through a register.
418   bool isIndirectBranch(QueryType Type = AnyInBundle) const {
419     return hasProperty(MCID::IndirectBranch, Type);
420   }
422   /// isConditionalBranch - Return true if this is a branch which may fall
423   /// through to the next instruction or may transfer control flow to some other
424   /// block.  The TargetInstrInfo::AnalyzeBranch method can be used to get more
425   /// information about this branch.
426   bool isConditionalBranch(QueryType Type = AnyInBundle) const {
427     return isBranch(Type) & !isBarrier(Type) & !isIndirectBranch(Type);
428   }
430   /// isUnconditionalBranch - Return true if this is a branch which always
431   /// transfers control flow to some other block.  The
432   /// TargetInstrInfo::AnalyzeBranch method can be used to get more information
433   /// about this branch.
434   bool isUnconditionalBranch(QueryType Type = AnyInBundle) const {
435     return isBranch(Type) & isBarrier(Type) & !isIndirectBranch(Type);
436   }
438   /// Return true if this instruction has a predicate operand that
439   /// controls execution.  It may be set to 'always', or may be set to other
440   /// values.   There are various methods in TargetInstrInfo that can be used to
441   /// control and modify the predicate in this instruction.
442   bool isPredicable(QueryType Type = AllInBundle) const {
443     // If it's a bundle than all bundled instructions must be predicable for this
444     // to return true.
445     return hasProperty(MCID::Predicable, Type);
446   }
448   /// isCompare - Return true if this instruction is a comparison.
449   bool isCompare(QueryType Type = IgnoreBundle) const {
450     return hasProperty(MCID::Compare, Type);
451   }
453   /// isMoveImmediate - Return true if this instruction is a move immediate
454   /// (including conditional moves) instruction.
455   bool isMoveImmediate(QueryType Type = IgnoreBundle) const {
456     return hasProperty(MCID::MoveImm, Type);
457   }
459   /// isBitcast - Return true if this instruction is a bitcast instruction.
460   ///
461   bool isBitcast(QueryType Type = IgnoreBundle) const {
462     return hasProperty(MCID::Bitcast, Type);
463   }
465   /// isSelect - Return true if this instruction is a select instruction.
466   ///
467   bool isSelect(QueryType Type = IgnoreBundle) const {
468     return hasProperty(MCID::Select, Type);
469   }
471   /// isNotDuplicable - Return true if this instruction cannot be safely
472   /// duplicated.  For example, if the instruction has a unique labels attached
473   /// to it, duplicating it would cause multiple definition errors.
474   bool isNotDuplicable(QueryType Type = AnyInBundle) const {
475     return hasProperty(MCID::NotDuplicable, Type);
476   }
478   /// hasDelaySlot - Returns true if the specified instruction has a delay slot
479   /// which must be filled by the code generator.
480   bool hasDelaySlot(QueryType Type = AnyInBundle) const {
481     return hasProperty(MCID::DelaySlot, Type);
482   }
484   /// canFoldAsLoad - Return true for instructions that can be folded as
485   /// memory operands in other instructions. The most common use for this
486   /// is instructions that are simple loads from memory that don't modify
487   /// the loaded value in any way, but it can also be used for instructions
488   /// that can be expressed as constant-pool loads, such as V_SETALLONES
489   /// on x86, to allow them to be folded when it is beneficial.
490   /// This should only be set on instructions that return a value in their
491   /// only virtual register definition.
492   bool canFoldAsLoad(QueryType Type = IgnoreBundle) const {
493     return hasProperty(MCID::FoldableAsLoad, Type);
494   }
496   //===--------------------------------------------------------------------===//
497   // Side Effect Analysis
498   //===--------------------------------------------------------------------===//
500   /// mayLoad - Return true if this instruction could possibly read memory.
501   /// Instructions with this flag set are not necessarily simple load
502   /// instructions, they may load a value and modify it, for example.
503   bool mayLoad(QueryType Type = AnyInBundle) const {
504     if (isInlineAsm()) {
505       unsigned ExtraInfo = getOperand(InlineAsm::MIOp_ExtraInfo).getImm();
506       if (ExtraInfo & InlineAsm::Extra_MayLoad)
507         return true;
508     }
509     return hasProperty(MCID::MayLoad, Type);
510   }
513   /// mayStore - Return true if this instruction could possibly modify memory.
514   /// Instructions with this flag set are not necessarily simple store
515   /// instructions, they may store a modified value based on their operands, or
516   /// may not actually modify anything, for example.
517   bool mayStore(QueryType Type = AnyInBundle) const {
518     if (isInlineAsm()) {
519       unsigned ExtraInfo = getOperand(InlineAsm::MIOp_ExtraInfo).getImm();
520       if (ExtraInfo & InlineAsm::Extra_MayStore)
521         return true;
522     }
523     return hasProperty(MCID::MayStore, Type);
524   }
526   //===--------------------------------------------------------------------===//
527   // Flags that indicate whether an instruction can be modified by a method.
528   //===--------------------------------------------------------------------===//
530   /// isCommutable - Return true if this may be a 2- or 3-address
531   /// instruction (of the form "X = op Y, Z, ..."), which produces the same
532   /// result if Y and Z are exchanged.  If this flag is set, then the
533   /// TargetInstrInfo::commuteInstruction method may be used to hack on the
534   /// instruction.
535   ///
536   /// Note that this flag may be set on instructions that are only commutable
537   /// sometimes.  In these cases, the call to commuteInstruction will fail.
538   /// Also note that some instructions require non-trivial modification to
539   /// commute them.
540   bool isCommutable(QueryType Type = IgnoreBundle) const {
541     return hasProperty(MCID::Commutable, Type);
542   }
544   /// isConvertibleTo3Addr - Return true if this is a 2-address instruction
545   /// which can be changed into a 3-address instruction if needed.  Doing this
546   /// transformation can be profitable in the register allocator, because it
547   /// means that the instruction can use a 2-address form if possible, but
548   /// degrade into a less efficient form if the source and dest register cannot
549   /// be assigned to the same register.  For example, this allows the x86
550   /// backend to turn a "shl reg, 3" instruction into an LEA instruction, which
551   /// is the same speed as the shift but has bigger code size.
552   ///
553   /// If this returns true, then the target must implement the
554   /// TargetInstrInfo::convertToThreeAddress method for this instruction, which
555   /// is allowed to fail if the transformation isn't valid for this specific
556   /// instruction (e.g. shl reg, 4 on x86).
557   ///
558   bool isConvertibleTo3Addr(QueryType Type = IgnoreBundle) const {
559     return hasProperty(MCID::ConvertibleTo3Addr, Type);
560   }
562   /// usesCustomInsertionHook - Return true if this instruction requires
563   /// custom insertion support when the DAG scheduler is inserting it into a
564   /// machine basic block.  If this is true for the instruction, it basically
565   /// means that it is a pseudo instruction used at SelectionDAG time that is
566   /// expanded out into magic code by the target when MachineInstrs are formed.
567   ///
568   /// If this is true, the TargetLoweringInfo::InsertAtEndOfBasicBlock method
569   /// is used to insert this into the MachineBasicBlock.
570   bool usesCustomInsertionHook(QueryType Type = IgnoreBundle) const {
571     return hasProperty(MCID::UsesCustomInserter, Type);
572   }
574   /// hasPostISelHook - Return true if this instruction requires *adjustment*
575   /// after instruction selection by calling a target hook. For example, this
576   /// can be used to fill in ARM 's' optional operand depending on whether
577   /// the conditional flag register is used.
578   bool hasPostISelHook(QueryType Type = IgnoreBundle) const {
579     return hasProperty(MCID::HasPostISelHook, Type);
580   }
582   /// isRematerializable - Returns true if this instruction is a candidate for
583   /// remat.  This flag is deprecated, please don't use it anymore.  If this
584   /// flag is set, the isReallyTriviallyReMaterializable() method is called to
585   /// verify the instruction is really rematable.
586   bool isRematerializable(QueryType Type = AllInBundle) const {
587     // It's only possible to re-mat a bundle if all bundled instructions are
588     // re-materializable.
589     return hasProperty(MCID::Rematerializable, Type);
590   }
592   /// isAsCheapAsAMove - Returns true if this instruction has the same cost (or
593   /// less) than a move instruction. This is useful during certain types of
594   /// optimizations (e.g., remat during two-address conversion or machine licm)
595   /// where we would like to remat or hoist the instruction, but not if it costs
596   /// more than moving the instruction into the appropriate register. Note, we
597   /// are not marking copies from and to the same register class with this flag.
598   bool isAsCheapAsAMove(QueryType Type = AllInBundle) const {
599     // Only returns true for a bundle if all bundled instructions are cheap.
600     // FIXME: This probably requires a target hook.
601     return hasProperty(MCID::CheapAsAMove, Type);
602   }
604   /// hasExtraSrcRegAllocReq - Returns true if this instruction source operands
605   /// have special register allocation requirements that are not captured by the
606   /// operand register classes. e.g. ARM::STRD's two source registers must be an
607   /// even / odd pair, ARM::STM registers have to be in ascending order.
608   /// Post-register allocation passes should not attempt to change allocations
609   /// for sources of instructions with this flag.
610   bool hasExtraSrcRegAllocReq(QueryType Type = AnyInBundle) const {
611     return hasProperty(MCID::ExtraSrcRegAllocReq, Type);
612   }
614   /// hasExtraDefRegAllocReq - Returns true if this instruction def operands
615   /// have special register allocation requirements that are not captured by the
616   /// operand register classes. e.g. ARM::LDRD's two def registers must be an
617   /// even / odd pair, ARM::LDM registers have to be in ascending order.
618   /// Post-register allocation passes should not attempt to change allocations
619   /// for definitions of instructions with this flag.
620   bool hasExtraDefRegAllocReq(QueryType Type = AnyInBundle) const {
621     return hasProperty(MCID::ExtraDefRegAllocReq, Type);
622   }
625   enum MICheckType {
626     CheckDefs,      // Check all operands for equality
627     CheckKillDead,  // Check all operands including kill / dead markers
628     IgnoreDefs,     // Ignore all definitions
629     IgnoreVRegDefs  // Ignore virtual register definitions
630   };
632   /// isIdenticalTo - Return true if this instruction is identical to (same
633   /// opcode and same operands as) the specified instruction.
634   bool isIdenticalTo(const MachineInstr *Other,
635                      MICheckType Check = CheckDefs) const;
637   /// Unlink 'this' from the containing basic block, and return it without
638   /// deleting it.
639   ///
640   /// This function can not be used on bundled instructions, use
641   /// removeFromBundle() to remove individual instructions from a bundle.
642   MachineInstr *removeFromParent();
644   /// Unlink this instruction from its basic block and return it without
645   /// deleting it.
646   ///
647   /// If the instruction is part of a bundle, the other instructions in the
648   /// bundle remain bundled.
649   MachineInstr *removeFromBundle();
651   /// Unlink 'this' from the containing basic block and delete it.
652   ///
653   /// If this instruction is the header of a bundle, the whole bundle is erased.
654   /// This function can not be used for instructions inside a bundle, use
655   /// eraseFromBundle() to erase individual bundled instructions.
656   void eraseFromParent();
658   /// Unlink 'this' form its basic block and delete it.
659   ///
660   /// If the instruction is part of a bundle, the other instructions in the
661   /// bundle remain bundled.
662   void eraseFromBundle();
664   bool isEHLabel() const { return getOpcode() == TargetOpcode::EH_LABEL; }
665   bool isGCLabel() const { return getOpcode() == TargetOpcode::GC_LABEL; }
667   /// isLabel - Returns true if the MachineInstr represents a label.
668   ///
669   bool isLabel() const { return isEHLabel() || isGCLabel(); }
670   bool isCFIInstruction() const {
671     return getOpcode() == TargetOpcode::CFI_INSTRUCTION;
672   }
674   // True if the instruction represents a position in the function.
675   bool isPosition() const { return isLabel() || isCFIInstruction(); }
677   bool isDebugValue() const { return getOpcode() == TargetOpcode::DBG_VALUE; }
678   /// A DBG_VALUE is indirect iff the first operand is a register and
679   /// the second operand is an immediate.
680   bool isIndirectDebugValue() const {
681     return isDebugValue()
682       && getOperand(0).isReg()
683       && getOperand(1).isImm();
684   }
686   bool isPHI() const { return getOpcode() == TargetOpcode::PHI; }
687   bool isKill() const { return getOpcode() == TargetOpcode::KILL; }
688   bool isImplicitDef() const { return getOpcode()==TargetOpcode::IMPLICIT_DEF; }
689   bool isInlineAsm() const { return getOpcode() == TargetOpcode::INLINEASM; }
690   bool isMSInlineAsm() const { 
691     return getOpcode() == TargetOpcode::INLINEASM && getInlineAsmDialect();
692   }
693   bool isStackAligningInlineAsm() const;
694   InlineAsm::AsmDialect getInlineAsmDialect() const;
695   bool isInsertSubreg() const {
696     return getOpcode() == TargetOpcode::INSERT_SUBREG;
697   }
698   bool isSubregToReg() const {
699     return getOpcode() == TargetOpcode::SUBREG_TO_REG;
700   }
701   bool isRegSequence() const {
702     return getOpcode() == TargetOpcode::REG_SEQUENCE;
703   }
704   bool isBundle() const {
705     return getOpcode() == TargetOpcode::BUNDLE;
706   }
707   bool isCopy() const {
708     return getOpcode() == TargetOpcode::COPY;
709   }
710   bool isFullCopy() const {
711     return isCopy() && !getOperand(0).getSubReg() && !getOperand(1).getSubReg();
712   }
714   /// isCopyLike - Return true if the instruction behaves like a copy.
715   /// This does not include native copy instructions.
716   bool isCopyLike() const {
717     return isCopy() || isSubregToReg();
718   }
720   /// isIdentityCopy - Return true is the instruction is an identity copy.
721   bool isIdentityCopy() const {
722     return isCopy() && getOperand(0).getReg() == getOperand(1).getReg() &&
723       getOperand(0).getSubReg() == getOperand(1).getSubReg();
724   }
726   /// isTransient - Return true if this is a transient instruction that is
727   /// either very likely to be eliminated during register allocation (such as
728   /// copy-like instructions), or if this instruction doesn't have an
729   /// execution-time cost.
730   bool isTransient() const {
731     switch(getOpcode()) {
732     default: return false;
733     // Copy-like instructions are usually eliminated during register allocation.
734     case TargetOpcode::PHI:
735     case TargetOpcode::COPY:
736     case TargetOpcode::INSERT_SUBREG:
737     case TargetOpcode::SUBREG_TO_REG:
738     case TargetOpcode::REG_SEQUENCE:
739     // Pseudo-instructions that don't produce any real output.
740     case TargetOpcode::IMPLICIT_DEF:
741     case TargetOpcode::KILL:
742     case TargetOpcode::CFI_INSTRUCTION:
743     case TargetOpcode::EH_LABEL:
744     case TargetOpcode::GC_LABEL:
745     case TargetOpcode::DBG_VALUE:
746       return true;
747     }
748   }
750   /// Return the number of instructions inside the MI bundle, excluding the
751   /// bundle header.
752   ///
753   /// This is the number of instructions that MachineBasicBlock::iterator
754   /// skips, 0 for unbundled instructions.
755   unsigned getBundleSize() const;
757   /// readsRegister - Return true if the MachineInstr reads the specified
758   /// register. If TargetRegisterInfo is passed, then it also checks if there
759   /// is a read of a super-register.
760   /// This does not count partial redefines of virtual registers as reads:
761   ///   %reg1024:6 = OP.
762   bool readsRegister(unsigned Reg, const TargetRegisterInfo *TRI = NULL) const {
763     return findRegisterUseOperandIdx(Reg, false, TRI) != -1;
764   }
766   /// readsVirtualRegister - Return true if the MachineInstr reads the specified
767   /// virtual register. Take into account that a partial define is a
768   /// read-modify-write operation.
769   bool readsVirtualRegister(unsigned Reg) const {
770     return readsWritesVirtualRegister(Reg).first;
771   }
773   /// readsWritesVirtualRegister - Return a pair of bools (reads, writes)
774   /// indicating if this instruction reads or writes Reg. This also considers
775   /// partial defines.
776   /// If Ops is not null, all operand indices for Reg are added.
777   std::pair<bool,bool> readsWritesVirtualRegister(unsigned Reg,
778                                       SmallVectorImpl<unsigned> *Ops = 0) const;
780   /// killsRegister - Return true if the MachineInstr kills the specified
781   /// register. If TargetRegisterInfo is passed, then it also checks if there is
782   /// a kill of a super-register.
783   bool killsRegister(unsigned Reg, const TargetRegisterInfo *TRI = NULL) const {
784     return findRegisterUseOperandIdx(Reg, true, TRI) != -1;
785   }
787   /// definesRegister - Return true if the MachineInstr fully defines the
788   /// specified register. If TargetRegisterInfo is passed, then it also checks
789   /// if there is a def of a super-register.
790   /// NOTE: It's ignoring subreg indices on virtual registers.
791   bool definesRegister(unsigned Reg, const TargetRegisterInfo *TRI=NULL) const {
792     return findRegisterDefOperandIdx(Reg, false, false, TRI) != -1;
793   }
795   /// modifiesRegister - Return true if the MachineInstr modifies (fully define
796   /// or partially define) the specified register.
797   /// NOTE: It's ignoring subreg indices on virtual registers.
798   bool modifiesRegister(unsigned Reg, const TargetRegisterInfo *TRI) const {
799     return findRegisterDefOperandIdx(Reg, false, true, TRI) != -1;
800   }
802   /// registerDefIsDead - Returns true if the register is dead in this machine
803   /// instruction. If TargetRegisterInfo is passed, then it also checks
804   /// if there is a dead def of a super-register.
805   bool registerDefIsDead(unsigned Reg,
806                          const TargetRegisterInfo *TRI = NULL) const {
807     return findRegisterDefOperandIdx(Reg, true, false, TRI) != -1;
808   }
810   /// findRegisterUseOperandIdx() - Returns the operand index that is a use of
811   /// the specific register or -1 if it is not found. It further tightens
812   /// the search criteria to a use that kills the register if isKill is true.
813   int findRegisterUseOperandIdx(unsigned Reg, bool isKill = false,
814                                 const TargetRegisterInfo *TRI = NULL) const;
816   /// findRegisterUseOperand - Wrapper for findRegisterUseOperandIdx, it returns
817   /// a pointer to the MachineOperand rather than an index.
818   MachineOperand *findRegisterUseOperand(unsigned Reg, bool isKill = false,
819                                          const TargetRegisterInfo *TRI = NULL) {
820     int Idx = findRegisterUseOperandIdx(Reg, isKill, TRI);
821     return (Idx == -1) ? NULL : &getOperand(Idx);
822   }
824   /// findRegisterDefOperandIdx() - Returns the operand index that is a def of
825   /// the specified register or -1 if it is not found. If isDead is true, defs
826   /// that are not dead are skipped. If Overlap is true, then it also looks for
827   /// defs that merely overlap the specified register. If TargetRegisterInfo is
828   /// non-null, then it also checks if there is a def of a super-register.
829   /// This may also return a register mask operand when Overlap is true.
830   int findRegisterDefOperandIdx(unsigned Reg,
831                                 bool isDead = false, bool Overlap = false,
832                                 const TargetRegisterInfo *TRI = NULL) const;
834   /// findRegisterDefOperand - Wrapper for findRegisterDefOperandIdx, it returns
835   /// a pointer to the MachineOperand rather than an index.
836   MachineOperand *findRegisterDefOperand(unsigned Reg, bool isDead = false,
837                                          const TargetRegisterInfo *TRI = NULL) {
838     int Idx = findRegisterDefOperandIdx(Reg, isDead, false, TRI);
839     return (Idx == -1) ? NULL : &getOperand(Idx);
840   }
842   /// findFirstPredOperandIdx() - Find the index of the first operand in the
843   /// operand list that is used to represent the predicate. It returns -1 if
844   /// none is found.
845   int findFirstPredOperandIdx() const;
847   /// findInlineAsmFlagIdx() - Find the index of the flag word operand that
848   /// corresponds to operand OpIdx on an inline asm instruction.  Returns -1 if
849   /// getOperand(OpIdx) does not belong to an inline asm operand group.
850   ///
851   /// If GroupNo is not NULL, it will receive the number of the operand group
852   /// containing OpIdx.
853   ///
854   /// The flag operand is an immediate that can be decoded with methods like
855   /// InlineAsm::hasRegClassConstraint().
856   ///
857   int findInlineAsmFlagIdx(unsigned OpIdx, unsigned *GroupNo = 0) const;
859   /// getRegClassConstraint - Compute the static register class constraint for
860   /// operand OpIdx.  For normal instructions, this is derived from the
861   /// MCInstrDesc.  For inline assembly it is derived from the flag words.
862   ///
863   /// Returns NULL if the static register classs constraint cannot be
864   /// determined.
865   ///
866   const TargetRegisterClass*
867   getRegClassConstraint(unsigned OpIdx,
868                         const TargetInstrInfo *TII,
869                         const TargetRegisterInfo *TRI) const;
871   /// \brief Applies the constraints (def/use) implied by this MI on \p Reg to
872   /// the given \p CurRC.
873   /// If \p ExploreBundle is set and MI is part of a bundle, all the
874   /// instructions inside the bundle will be taken into account. In other words,
875   /// this method accumulates all the constrains of the operand of this MI and
876   /// the related bundle if MI is a bundle or inside a bundle.
877   ///
878   /// Returns the register class that statisfies both \p CurRC and the
879   /// constraints set by MI. Returns NULL if such a register class does not
880   /// exist.
881   ///
882   /// \pre CurRC must not be NULL.
883   const TargetRegisterClass *getRegClassConstraintEffectForVReg(
884       unsigned Reg, const TargetRegisterClass *CurRC,
885       const TargetInstrInfo *TII, const TargetRegisterInfo *TRI,
886       bool ExploreBundle = false) const;
888   /// \brief Applies the constraints (def/use) implied by the \p OpIdx operand
889   /// to the given \p CurRC.
890   ///
891   /// Returns the register class that statisfies both \p CurRC and the
892   /// constraints set by \p OpIdx MI. Returns NULL if such a register class
893   /// does not exist.
894   ///
895   /// \pre CurRC must not be NULL.
896   /// \pre The operand at \p OpIdx must be a register.
897   const TargetRegisterClass *
898   getRegClassConstraintEffect(unsigned OpIdx, const TargetRegisterClass *CurRC,
899                               const TargetInstrInfo *TII,
900                               const TargetRegisterInfo *TRI) const;
902   /// tieOperands - Add a tie between the register operands at DefIdx and
903   /// UseIdx. The tie will cause the register allocator to ensure that the two
904   /// operands are assigned the same physical register.
905   ///
906   /// Tied operands are managed automatically for explicit operands in the
907   /// MCInstrDesc. This method is for exceptional cases like inline asm.
908   void tieOperands(unsigned DefIdx, unsigned UseIdx);
910   /// findTiedOperandIdx - Given the index of a tied register operand, find the
911   /// operand it is tied to. Defs are tied to uses and vice versa. Returns the
912   /// index of the tied operand which must exist.
913   unsigned findTiedOperandIdx(unsigned OpIdx) const;
915   /// isRegTiedToUseOperand - Given the index of a register def operand,
916   /// check if the register def is tied to a source operand, due to either
917   /// two-address elimination or inline assembly constraints. Returns the
918   /// first tied use operand index by reference if UseOpIdx is not null.
919   bool isRegTiedToUseOperand(unsigned DefOpIdx, unsigned *UseOpIdx = 0) const {
920     const MachineOperand &MO = getOperand(DefOpIdx);
921     if (!MO.isReg() || !MO.isDef() || !MO.isTied())
922       return false;
923     if (UseOpIdx)
924       *UseOpIdx = findTiedOperandIdx(DefOpIdx);
925     return true;
926   }
928   /// isRegTiedToDefOperand - Return true if the use operand of the specified
929   /// index is tied to an def operand. It also returns the def operand index by
930   /// reference if DefOpIdx is not null.
931   bool isRegTiedToDefOperand(unsigned UseOpIdx, unsigned *DefOpIdx = 0) const {
932     const MachineOperand &MO = getOperand(UseOpIdx);
933     if (!MO.isReg() || !MO.isUse() || !MO.isTied())
934       return false;
935     if (DefOpIdx)
936       *DefOpIdx = findTiedOperandIdx(UseOpIdx);
937     return true;
938   }
940   /// clearKillInfo - Clears kill flags on all operands.
941   ///
942   void clearKillInfo();
944   /// substituteRegister - Replace all occurrences of FromReg with ToReg:SubIdx,
945   /// properly composing subreg indices where necessary.
946   void substituteRegister(unsigned FromReg, unsigned ToReg, unsigned SubIdx,
947                           const TargetRegisterInfo &RegInfo);
949   /// addRegisterKilled - We have determined MI kills a register. Look for the
950   /// operand that uses it and mark it as IsKill. If AddIfNotFound is true,
951   /// add a implicit operand if it's not found. Returns true if the operand
952   /// exists / is added.
953   bool addRegisterKilled(unsigned IncomingReg,
954                          const TargetRegisterInfo *RegInfo,
955                          bool AddIfNotFound = false);
957   /// clearRegisterKills - Clear all kill flags affecting Reg.  If RegInfo is
958   /// provided, this includes super-register kills.
959   void clearRegisterKills(unsigned Reg, const TargetRegisterInfo *RegInfo);
961   /// addRegisterDead - We have determined MI defined a register without a use.
962   /// Look for the operand that defines it and mark it as IsDead. If
963   /// AddIfNotFound is true, add a implicit operand if it's not found. Returns
964   /// true if the operand exists / is added.
965   bool addRegisterDead(unsigned Reg, const TargetRegisterInfo *RegInfo,
966                        bool AddIfNotFound = false);
968   /// addRegisterDefined - We have determined MI defines a register. Make sure
969   /// there is an operand defining Reg.
970   void addRegisterDefined(unsigned Reg, const TargetRegisterInfo *RegInfo = 0);
972   /// setPhysRegsDeadExcept - Mark every physreg used by this instruction as
973   /// dead except those in the UsedRegs list.
974   ///
975   /// On instructions with register mask operands, also add implicit-def
976   /// operands for all registers in UsedRegs.
977   void setPhysRegsDeadExcept(ArrayRef<unsigned> UsedRegs,
978                              const TargetRegisterInfo &TRI);
980   /// isSafeToMove - Return true if it is safe to move this instruction. If
981   /// SawStore is set to true, it means that there is a store (or call) between
982   /// the instruction's location and its intended destination.
983   bool isSafeToMove(const TargetInstrInfo *TII, AliasAnalysis *AA,
984                     bool &SawStore) const;
986   /// hasOrderedMemoryRef - Return true if this instruction may have an ordered
987   /// or volatile memory reference, or if the information describing the memory
988   /// reference is not available. Return false if it is known to have no
989   /// ordered or volatile memory references.
990   bool hasOrderedMemoryRef() const;
992   /// isInvariantLoad - Return true if this instruction is loading from a
993   /// location whose value is invariant across the function.  For example,
994   /// loading a value from the constant pool or from the argument area of
995   /// a function if it does not change.  This should only return true of *all*
996   /// loads the instruction does are invariant (if it does multiple loads).
997   bool isInvariantLoad(AliasAnalysis *AA) const;
999   /// isConstantValuePHI - If the specified instruction is a PHI that always
1000   /// merges together the same virtual register, return the register, otherwise
1001   /// return 0.
1002   unsigned isConstantValuePHI() const;
1004   /// hasUnmodeledSideEffects - Return true if this instruction has side
1005   /// effects that are not modeled by mayLoad / mayStore, etc.
1006   /// For all instructions, the property is encoded in MCInstrDesc::Flags
1007   /// (see MCInstrDesc::hasUnmodeledSideEffects(). The only exception is
1008   /// INLINEASM instruction, in which case the side effect property is encoded
1009   /// in one of its operands (see InlineAsm::Extra_HasSideEffect).
1010   ///
1011   bool hasUnmodeledSideEffects() const;
1013   /// allDefsAreDead - Return true if all the defs of this instruction are dead.
1014   ///
1015   bool allDefsAreDead() const;
1017   /// copyImplicitOps - Copy implicit register operands from specified
1018   /// instruction to this instruction.
1019   void copyImplicitOps(MachineFunction &MF, const MachineInstr *MI);
1021   //
1022   // Debugging support
1023   //
1024   void print(raw_ostream &OS, const TargetMachine *TM = 0,
1025              bool SkipOpers = false) const;
1026   void dump() const;
1028   //===--------------------------------------------------------------------===//
1029   // Accessors used to build up machine instructions.
1031   /// Add the specified operand to the instruction.  If it is an implicit
1032   /// operand, it is added to the end of the operand list.  If it is an
1033   /// explicit operand it is added at the end of the explicit operand list
1034   /// (before the first implicit operand).
1035   ///
1036   /// MF must be the machine function that was used to allocate this
1037   /// instruction.
1038   ///
1039   /// MachineInstrBuilder provides a more convenient interface for creating
1040   /// instructions and adding operands.
1041   void addOperand(MachineFunction &MF, const MachineOperand &Op);
1043   /// Add an operand without providing an MF reference. This only works for
1044   /// instructions that are inserted in a basic block.
1045   ///
1046   /// MachineInstrBuilder and the two-argument addOperand(MF, MO) should be
1047   /// preferred.
1048   void addOperand(const MachineOperand &Op);
1050   /// setDesc - Replace the instruction descriptor (thus opcode) of
1051   /// the current instruction with a new one.
1052   ///
1053   void setDesc(const MCInstrDesc &tid) { MCID = &tid; }
1055   /// setDebugLoc - Replace current source information with new such.
1056   /// Avoid using this, the constructor argument is preferable.
1057   ///
1058   void setDebugLoc(const DebugLoc dl) { debugLoc = dl; }
1060   /// RemoveOperand - Erase an operand  from an instruction, leaving it with one
1061   /// fewer operand than it started with.
1062   ///
1063   void RemoveOperand(unsigned i);
1065   /// addMemOperand - Add a MachineMemOperand to the machine instruction.
1066   /// This function should be used only occasionally. The setMemRefs function
1067   /// is the primary method for setting up a MachineInstr's MemRefs list.
1068   void addMemOperand(MachineFunction &MF, MachineMemOperand *MO);
1070   /// setMemRefs - Assign this MachineInstr's memory reference descriptor
1071   /// list. This does not transfer ownership.
1072   void setMemRefs(mmo_iterator NewMemRefs, mmo_iterator NewMemRefsEnd) {
1073     MemRefs = NewMemRefs;
1074     NumMemRefs = uint8_t(NewMemRefsEnd - NewMemRefs);
1075     assert(NumMemRefs == NewMemRefsEnd - NewMemRefs && "Too many memrefs");
1076   }
1078 private:
1079   /// getRegInfo - If this instruction is embedded into a MachineFunction,
1080   /// return the MachineRegisterInfo object for the current function, otherwise
1081   /// return null.
1082   MachineRegisterInfo *getRegInfo();
1084   /// untieRegOperand - Break any tie involving OpIdx.
1085   void untieRegOperand(unsigned OpIdx) {
1086     MachineOperand &MO = getOperand(OpIdx);
1087     if (MO.isReg() && MO.isTied()) {
1088       getOperand(findTiedOperandIdx(OpIdx)).TiedTo = 0;
1089       MO.TiedTo = 0;
1090     }
1091   }
1093   /// addImplicitDefUseOperands - Add all implicit def and use operands to
1094   /// this instruction.
1095   void addImplicitDefUseOperands(MachineFunction &MF);
1097   /// RemoveRegOperandsFromUseLists - Unlink all of the register operands in
1098   /// this instruction from their respective use lists.  This requires that the
1099   /// operands already be on their use lists.
1100   void RemoveRegOperandsFromUseLists(MachineRegisterInfo&);
1102   /// AddRegOperandsToUseLists - Add all of the register operands in
1103   /// this instruction from their respective use lists.  This requires that the
1104   /// operands not be on their use lists yet.
1105   void AddRegOperandsToUseLists(MachineRegisterInfo&);
1107   /// hasPropertyInBundle - Slow path for hasProperty when we're dealing with a
1108   /// bundle.
1109   bool hasPropertyInBundle(unsigned Mask, QueryType Type) const;
1111   /// \brief Implements the logic of getRegClassConstraintEffectForVReg for the
1112   /// this MI and the given operand index \p OpIdx.
1113   /// If the related operand does not constrained Reg, this returns CurRC.
1114   const TargetRegisterClass *getRegClassConstraintEffectForVRegImpl(
1115       unsigned OpIdx, unsigned Reg, const TargetRegisterClass *CurRC,
1116       const TargetInstrInfo *TII, const TargetRegisterInfo *TRI) const;
1117 };
1119 /// MachineInstrExpressionTrait - Special DenseMapInfo traits to compare
1120 /// MachineInstr* by *value* of the instruction rather than by pointer value.
1121 /// The hashing and equality testing functions ignore definitions so this is
1122 /// useful for CSE, etc.
1123 struct MachineInstrExpressionTrait : DenseMapInfo<MachineInstr*> {
1124   static inline MachineInstr *getEmptyKey() {
1125     return 0;
1126   }
1128   static inline MachineInstr *getTombstoneKey() {
1129     return reinterpret_cast<MachineInstr*>(-1);
1130   }
1132   static unsigned getHashValue(const MachineInstr* const &MI);
1134   static bool isEqual(const MachineInstr* const &LHS,
1135                       const MachineInstr* const &RHS) {
1136     if (RHS == getEmptyKey() || RHS == getTombstoneKey() ||
1137         LHS == getEmptyKey() || LHS == getTombstoneKey())
1138       return LHS == RHS;
1139     return LHS->isIdenticalTo(RHS, MachineInstr::IgnoreVRegDefs);
1140   }
1141 };
1143 //===----------------------------------------------------------------------===//
1144 // Debugging Support
1146 inline raw_ostream& operator<<(raw_ostream &OS, const MachineInstr &MI) {
1147   MI.print(OS);
1148   return OS;
1151 } // End llvm namespace
1153 #endif