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