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/CodeGen/MachineMemOperand.h"
  21 #include <vector>
  22
  23 namespace llvm {
  24
  25 class TargetInstrDesc;
  26 class TargetInstrInfo;
  27 class TargetRegisterInfo;
  28
  29 template <typename T> struct ilist_traits;
  30 template <typename T> struct ilist;
  31
  32 //===----------------------------------------------------------------------===//
  33 /// MachineInstr - Representation of each machine instruction.
  34 ///
  35 class MachineInstr {
  36   const TargetInstrDesc *TID;           // Instruction descriptor.
  37   unsigned short NumImplicitOps;        // Number of implicit operands (which
  38                                         // are determined at construction time).
  39
  40   std::vector<MachineOperand> Operands; // the operands
  41   std::vector<MachineMemOperand> MemOperands;// information on memory references
  42   MachineInstr *Prev, *Next;            // Links for MBB's intrusive list.
  43   MachineBasicBlock *Parent;            // Pointer to the owning basic block.
  44
  45   // OperandComplete - Return true if it's illegal to add a new operand
  46   bool OperandsComplete() const;
  47
  48   MachineInstr(const MachineInstr&);
  49   void operator=(const MachineInstr&); // DO NOT IMPLEMENT
  50
  51   // Intrusive list support
  52   friend struct ilist_traits<MachineInstr>;
  53   friend struct ilist_traits<MachineBasicBlock>;
  54   void setParent(MachineBasicBlock *P) { Parent = P; }
  55 public:
  56   /// MachineInstr ctor - This constructor creates a dummy MachineInstr with
  57   /// TID NULL and no operands.
  58   MachineInstr();
  59
  60   /// MachineInstr ctor - This constructor create a MachineInstr and add the
  61   /// implicit operands.  It reserves space for number of operands specified by
  62   /// TargetInstrDesc.
  63   explicit MachineInstr(const TargetInstrDesc &TID, bool NoImp = false);
  64
  65   /// MachineInstr ctor - Work exactly the same as the ctor above, except that
  66   /// the MachineInstr is created and added to the end of the specified basic
  67   /// block.
  68   ///
  69   MachineInstr(MachineBasicBlock *MBB, const TargetInstrDesc &TID);
  70
  71   ~MachineInstr();
  72
  73   const MachineBasicBlock* getParent() const { return Parent; }
  74   MachineBasicBlock* getParent() { return Parent; }
  75
  76   /// getDesc - Returns the target instruction descriptor of this
  77   /// MachineInstr.
  78   const TargetInstrDesc &getDesc() const { return *TID; }
  79
  80   /// getOpcode - Returns the opcode of this MachineInstr.
  81   ///
  82   int getOpcode() const;
  83
  84   /// Access to explicit operands of the instruction.
  85   ///
  86   unsigned getNumOperands() const { return (unsigned)Operands.size(); }
  87
  88   const MachineOperand& getOperand(unsigned i) const {
  89     assert(i < getNumOperands() && "getOperand() out of range!");
  90     return Operands[i];
  91   }
  92   MachineOperand& getOperand(unsigned i) {
  93     assert(i < getNumOperands() && "getOperand() out of range!");
  94     return Operands[i];
  95   }
  96
  97   /// getNumExplicitOperands - Returns the number of non-implicit operands.
  98   ///
  99   unsigned getNumExplicitOperands() const;
 100
 101   /// Access to memory operands of the instruction
 102   unsigned getNumMemOperands() const { return (unsigned)MemOperands.size(); }
 103
 104   const MachineMemOperand& getMemOperand(unsigned i) const {
 105     assert(i < getNumMemOperands() && "getMemOperand() out of range!");
 106     return MemOperands[i];
 107   }
 108   MachineMemOperand& getMemOperand(unsigned i) {
 109     assert(i < getNumMemOperands() && "getMemOperand() out of range!");
 110     return MemOperands[i];
 111   }
 112
 113   /// isIdenticalTo - Return true if this instruction is identical to (same
 114   /// opcode and same operands as) the specified instruction.
 115   bool isIdenticalTo(const MachineInstr *Other) const {
 116     if (Other->getOpcode() != getOpcode() ||
 117         Other->getNumOperands() != getNumOperands())
 118       return false;
 119     for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 120       if (!getOperand(i).isIdenticalTo(Other->getOperand(i)))
 121         return false;
 122     return true;
 123   }
 124
 125   /// clone - Create a copy of 'this' instruction that is identical in
 126   /// all ways except the the instruction has no parent, prev, or next.
 127   MachineInstr* clone() const { return new MachineInstr(*this); }
 128
 129   /// removeFromParent - This method unlinks 'this' from the containing basic
 130   /// block, and returns it, but does not delete it.
 131   MachineInstr *removeFromParent();
 132
 133   /// eraseFromParent - This method unlinks 'this' from the containing basic
 134   /// block and deletes it.
 135   void eraseFromParent() {
 136     delete removeFromParent();
 137   }
 138
 139   /// isLabel - Returns true if the MachineInstr represents a label.
 140   ///
 141   bool isLabel() const;
 142
 143   /// isDebugLabel - Returns true if the MachineInstr represents a debug label.
 144   ///
 145   bool isDebugLabel() const;
 146
 147   /// readsRegister - Return true if the MachineInstr reads the specified
 148   /// register. If TargetRegisterInfo is passed, then it also checks if there
 149   /// is a read of a super-register.
 150   bool readsRegister(unsigned Reg, const TargetRegisterInfo *TRI = NULL) const {
 151     return findRegisterUseOperandIdx(Reg, false, TRI) != -1;
 152   }
 153
 154   /// killsRegister - Return true if the MachineInstr kills the specified
 155   /// register. If TargetRegisterInfo is passed, then it also checks if there is
 156   /// a kill of a super-register.
 157   bool killsRegister(unsigned Reg, const TargetRegisterInfo *TRI = NULL) const {
 158     return findRegisterUseOperandIdx(Reg, true, TRI) != -1;
 159   }
 160
 161   /// modifiesRegister - Return true if the MachineInstr modifies the
 162   /// specified register. If TargetRegisterInfo is passed, then it also checks
 163   /// if there is a def of a super-register.
 164   bool modifiesRegister(unsigned Reg,
 165                         const TargetRegisterInfo *TRI = NULL) const {
 166     return findRegisterDefOperandIdx(Reg, false, TRI) != -1;
 167   }
 168
 169   /// registerDefIsDead - Returns true if the register is dead in this machine
 170   /// instruction. If TargetRegisterInfo is passed, then it also checks
 171   /// if there is a dead def of a super-register.
 172   bool registerDefIsDead(unsigned Reg,
 173                          const TargetRegisterInfo *TRI = NULL) const {
 174     return findRegisterDefOperandIdx(Reg, true, TRI) != -1;
 175   }
 176
 177   /// findRegisterUseOperandIdx() - Returns the operand index that is a use of
 178   /// the specific register or -1 if it is not found. It further tightening
 179   /// the search criteria to a use that kills the register if isKill is true.
 180   int findRegisterUseOperandIdx(unsigned Reg, bool isKill = false,
 181                                 const TargetRegisterInfo *TRI = NULL) const;
 182
 183   /// findRegisterUseOperand - Wrapper for findRegisterUseOperandIdx, it returns
 184   /// a pointer to the MachineOperand rather than an index.
 185   MachineOperand *findRegisterUseOperand(unsigned Reg, bool isKill = false,
 186                                          const TargetRegisterInfo *TRI = NULL) {
 187     int Idx = findRegisterUseOperandIdx(Reg, isKill, TRI);
 188     return (Idx == -1) ? NULL : &getOperand(Idx);
 189   }
 190
 191   /// findRegisterDefOperandIdx() - Returns the operand index that is a def of
 192   /// the specified register or -1 if it is not found. If isDead is true, defs
 193   /// that are not dead are skipped. If TargetRegisterInfo is non-null, then it
 194   /// also checks if there is a def of a super-register.
 195   int findRegisterDefOperandIdx(unsigned Reg, bool isDead = false,
 196                                 const TargetRegisterInfo *TRI = NULL) const;
 197
 198   /// findRegisterDefOperand - Wrapper for findRegisterDefOperandIdx, it returns
 199   /// a pointer to the MachineOperand rather than an index.
 200   MachineOperand *findRegisterDefOperand(unsigned Reg,bool isDead = false,
 201                                          const TargetRegisterInfo *TRI = NULL) {
 202     int Idx = findRegisterDefOperandIdx(Reg, isDead, TRI);
 203     return (Idx == -1) ? NULL : &getOperand(Idx);
 204   }
 205
 206   /// findFirstPredOperandIdx() - Find the index of the first operand in the
 207   /// operand list that is used to represent the predicate. It returns -1 if
 208   /// none is found.
 209   int findFirstPredOperandIdx() const;
 210
 211   /// isRegReDefinedByTwoAddr - Returns true if the Reg re-definition is due
 212   /// to two addr elimination.
 213   bool isRegReDefinedByTwoAddr(unsigned Reg) const;
 214
 215   /// copyKillDeadInfo - Copies kill / dead operand properties from MI.
 216   ///
 217   void copyKillDeadInfo(const MachineInstr *MI);
 218
 219   /// copyPredicates - Copies predicate operand(s) from MI.
 220   void copyPredicates(const MachineInstr *MI);
 221
 222   /// addRegisterKilled - We have determined MI kills a register. Look for the
 223   /// operand that uses it and mark it as IsKill. If AddIfNotFound is true,
 224   /// add a implicit operand if it's not found. Returns true if the operand
 225   /// exists / is added.
 226   bool addRegisterKilled(unsigned IncomingReg,
 227                          const TargetRegisterInfo *RegInfo,
 228                          bool AddIfNotFound = false);
 229
 230   /// addRegisterDead - We have determined MI defined a register without a use.
 231   /// Look for the operand that defines it and mark it as IsDead. If
 232   /// AddIfNotFound is true, add a implicit operand if it's not found. Returns
 233   /// true if the operand exists / is added.
 234   bool addRegisterDead(unsigned IncomingReg, const TargetRegisterInfo *RegInfo,
 235                        bool AddIfNotFound = false);
 236
 237   /// isSafeToMove - Return true if it is safe to move this instruction. If
 238   /// SawStore is set to true, it means that there is a store (or call) between
 239   /// the instruction's location and its intended destination.
 240   bool isSafeToMove(const TargetInstrInfo *TII, bool &SawStore);
 241
 242   //
 243   // Debugging support
 244   //
 245   void print(std::ostream *OS, const TargetMachine *TM) const {
 246     if (OS) print(*OS, TM);
 247   }
 248   void print(std::ostream &OS, const TargetMachine *TM = 0) const;
 249   void print(std::ostream *OS) const { if (OS) print(*OS); }
 250   void dump() const;
 251
 252   //===--------------------------------------------------------------------===//
 253   // Accessors used to build up machine instructions.
 254
 255   /// addOperand - Add the specified operand to the instruction.  If it is an
 256   /// implicit operand, it is added to the end of the operand list.  If it is
 257   /// an explicit operand it is added at the end of the explicit operand list
 258   /// (before the first implicit operand).
 259   void addOperand(const MachineOperand &Op);
 260
 261   /// setDesc - Replace the instruction descriptor (thus opcode) of
 262   /// the current instruction with a new one.
 263   ///
 264   void setDesc(const TargetInstrDesc &tid) { TID = &tid; }
 265
 266   /// RemoveOperand - Erase an operand  from an instruction, leaving it with one
 267   /// fewer operand than it started with.
 268   ///
 269   void RemoveOperand(unsigned i);
 270
 271   /// addMemOperand - Add a MachineMemOperand to the machine instruction,
 272   /// referencing arbitrary storage.
 273   void addMemOperand(const MachineMemOperand &MO) {
 274     MemOperands.push_back(MO);
 275   }
 276
 277 private:
 278   /// getRegInfo - If this instruction is embedded into a MachineFunction,
 279   /// return the MachineRegisterInfo object for the current function, otherwise
 280   /// return null.
 281   MachineRegisterInfo *getRegInfo();
 282
 283   /// addImplicitDefUseOperands - Add all implicit def and use operands to
 284   /// this instruction.
 285   void addImplicitDefUseOperands();
 286
 287   /// RemoveRegOperandsFromUseLists - Unlink all of the register operands in
 288   /// this instruction from their respective use lists.  This requires that the
 289   /// operands already be on their use lists.
 290   void RemoveRegOperandsFromUseLists();
 291
 292   /// AddRegOperandsToUseLists - Add all of the register operands in
 293   /// this instruction from their respective use lists.  This requires that the
 294   /// operands not be on their use lists yet.
 295   void AddRegOperandsToUseLists(MachineRegisterInfo &RegInfo);
 296 };
 297
 298 //===----------------------------------------------------------------------===//
 299 // Debugging Support
 300
 301 inline std::ostream& operator<<(std::ostream &OS, const MachineInstr &MI) {
 302   MI.print(OS);
 303   return OS;
 304 }
 305
 306 } // End llvm namespace
 307
 308 #endif