include/llvm/CodeGen/MachineInstr.h

   1 //===-- llvm/CodeGen/MachineInstr.h - MachineInstr class --------*- C++ -*-===//
   2 //
   3 //                     The LLVM Compiler Infrastructure
   4 //
   5 // This file was developed by the LLVM research group and is distributed under
   6 // the University of Illinois Open Source 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/Target/MRegisterInfo.h"
  20 #include "Support/Annotation.h"
  21 #include "Support/iterator"
  22
  23 namespace llvm {
  24
  25 class Value;
  26 class Function;
  27 class MachineBasicBlock;
  28 class TargetMachine;
  29 class GlobalValue;
  30
  31 typedef int MachineOpCode;
  32
  33 //===----------------------------------------------------------------------===//
  34 /// Special flags on instructions that modify the opcode.
  35 /// These flags are unused for now, but having them enforces that some
  36 /// changes will be needed if they are used.
  37 ///
  38 enum MachineOpCodeFlags {
  39   AnnulFlag,         /// 1 if annul bit is set on a branch
  40   PredTakenFlag,     /// 1 if branch should be predicted taken
  41   PredNotTakenFlag   /// 1 if branch should be predicted not taken
  42 };
  43
  44 //===----------------------------------------------------------------------===//
  45 /// MOTy - MachineOperandType - This namespace contains an enum that describes
  46 /// how the machine operand is used by the instruction: is it read, defined, or
  47 /// both?  Note that the MachineInstr/Operator class currently uses bool
  48 /// arguments to represent this information instead of an enum.  Eventually this
  49 /// should change over to use this _easier to read_ representation instead.
  50 ///
  51 namespace MOTy {
  52   enum UseType {
  53     Use,             /// This machine operand is only read by the instruction
  54     Def,             /// This machine operand is only written by the instruction
  55     UseAndDef        /// This machine operand is read AND written
  56   };
  57 }
  58
  59 //===----------------------------------------------------------------------===//
  60 // class MachineOperand
  61 //
  62 // Purpose:
  63 //   Representation of each machine instruction operand.
  64 //   This class is designed so that you can allocate a vector of operands
  65 //   first and initialize each one later.
  66 //
  67 //   E.g, for this VM instruction:
  68 //              ptr = alloca type, numElements
  69 //   we generate 2 machine instructions on the SPARC:
  70 //
  71 //              mul Constant, Numelements -> Reg
  72 //              add %sp, Reg -> Ptr
  73 //
  74 //   Each instruction has 3 operands, listed above.  Of those:
  75 //   -  Reg, NumElements, and Ptr are of operand type MO_Register.
  76 //   -  Constant is of operand type MO_SignExtendedImmed on the SPARC.
  77 //
  78 //   For the register operands, the virtual register type is as follows:
  79 //
  80 //   -  Reg will be of virtual register type MO_MInstrVirtualReg.  The field
  81 //      MachineInstr* minstr will point to the instruction that computes reg.
  82 //
  83 //   -  %sp will be of virtual register type MO_MachineReg.
  84 //      The field regNum identifies the machine register.
  85 //
  86 //   -  NumElements will be of virtual register type MO_VirtualReg.
  87 //      The field Value* value identifies the value.
  88 //
  89 //   -  Ptr will also be of virtual register type MO_VirtualReg.
  90 //      Again, the field Value* value identifies the value.
  91 //
  92 //===----------------------------------------------------------------------===//
  93
  94 struct MachineOperand {
  95   enum MachineOperandType {
  96     MO_VirtualRegister,         // virtual register for *value
  97     MO_MachineRegister,         // pre-assigned machine register `regNum'
  98     MO_CCRegister,
  99     MO_SignExtendedImmed,
 100     MO_UnextendedImmed,
 101     MO_PCRelativeDisp,
 102     MO_MachineBasicBlock,       // MachineBasicBlock reference
 103     MO_FrameIndex,              // Abstract Stack Frame Index
 104     MO_ConstantPoolIndex,       // Address of indexed Constant in Constant Pool
 105     MO_ExternalSymbol,          // Name of external global symbol
 106     MO_GlobalAddress,           // Address of a global value
 107   };
 108
 109 private:
 110   // Bit fields of the flags variable used for different operand properties
 111   enum {
 112     DEFFLAG     = 0x01,       // this is a def of the operand
 113     USEFLAG     = 0x02,       // this is a use of the operand
 114     HIFLAG32    = 0x04,       // operand is %hi32(value_or_immedVal)
 115     LOFLAG32    = 0x08,       // operand is %lo32(value_or_immedVal)
 116     HIFLAG64    = 0x10,       // operand is %hi64(value_or_immedVal)
 117     LOFLAG64    = 0x20,       // operand is %lo64(value_or_immedVal)
 118     PCRELATIVE  = 0x40,       // Operand is relative to PC, not a global address
 119   };
 120
 121 private:
 122   union {
 123     Value*      value;          // BasicBlockVal for a label operand.
 124                                 // ConstantVal for a non-address immediate.
 125                                 // Virtual register for an SSA operand,
 126                                 //   including hidden operands required for
 127                                 //   the generated machine code.
 128                                 // LLVM global for MO_GlobalAddress.
 129
 130     int64_t immedVal;           // Constant value for an explicit constant
 131
 132     MachineBasicBlock *MBB;     // For MO_MachineBasicBlock type
 133     std::string *SymbolName;    // For MO_ExternalSymbol type
 134   };
 135
 136   char flags;                   // see bit field definitions above
 137   MachineOperandType opType:8;  // Pack into 8 bits efficiently after flags.
 138   int regNum;                   // register number for an explicit register
 139                                 // will be set for a value after reg allocation
 140 private:
 141   MachineOperand()
 142     : immedVal(0),
 143       flags(0),
 144       opType(MO_VirtualRegister),
 145       regNum(-1) {}
 146
 147   MachineOperand(int64_t ImmVal, MachineOperandType OpTy)
 148     : immedVal(ImmVal),
 149       flags(0),
 150       opType(OpTy),
 151       regNum(-1) {}
 152
 153   MachineOperand(int Reg, MachineOperandType OpTy, MOTy::UseType UseTy)
 154     : immedVal(0),
 155       opType(OpTy),
 156       regNum(Reg) {
 157     switch (UseTy) {
 158     case MOTy::Use:       flags = USEFLAG; break;
 159     case MOTy::Def:       flags = DEFFLAG; break;
 160     case MOTy::UseAndDef: flags = DEFFLAG | USEFLAG; break;
 161     default: assert(0 && "Invalid value for UseTy!");
 162     }
 163   }
 164
 165   MachineOperand(Value *V, MachineOperandType OpTy, MOTy::UseType UseTy,
 166                  bool isPCRelative = false)
 167     : value(V), opType(OpTy), regNum(-1) {
 168     switch (UseTy) {
 169     case MOTy::Use:       flags = USEFLAG; break;
 170     case MOTy::Def:       flags = DEFFLAG; break;
 171     case MOTy::UseAndDef: flags = DEFFLAG | USEFLAG; break;
 172     default: assert(0 && "Invalid value for UseTy!");
 173     }
 174     if (isPCRelative) flags |= PCRELATIVE;
 175   }
 176
 177   MachineOperand(MachineBasicBlock *mbb)
 178     : MBB(mbb), flags(0), opType(MO_MachineBasicBlock), regNum(-1) {}
 179
 180   MachineOperand(const std::string &SymName, bool isPCRelative)
 181     : SymbolName(new std::string(SymName)), flags(isPCRelative ? PCRELATIVE :0),
 182       opType(MO_ExternalSymbol), regNum(-1) {}
 183
 184 public:
 185   MachineOperand(const MachineOperand &M) : immedVal(M.immedVal),
 186                                             flags(M.flags),
 187                                             opType(M.opType),
 188                                             regNum(M.regNum) {
 189     if (isExternalSymbol())
 190       SymbolName = new std::string(M.getSymbolName());
 191   }
 192
 193   ~MachineOperand() {
 194     if (isExternalSymbol())
 195       delete SymbolName;
 196   }
 197
 198   const MachineOperand &operator=(const MachineOperand &MO) {
 199     if (isExternalSymbol())             // if old operand had a symbol name,
 200       delete SymbolName;                // release old memory
 201     immedVal = MO.immedVal;
 202     flags    = MO.flags;
 203     opType   = MO.opType;
 204     regNum   = MO.regNum;
 205     if (isExternalSymbol())
 206       SymbolName = new std::string(MO.getSymbolName());
 207     return *this;
 208   }
 209
 210   // Accessor methods.  Caller is responsible for checking the
 211   // operand type before invoking the corresponding accessor.
 212   //
 213   MachineOperandType getType() const { return opType; }
 214
 215   /// isPCRelative - This returns the value of the PCRELATIVE flag, which
 216   /// indicates whether this operand should be emitted as a PC relative value
 217   /// instead of a global address.  This is used for operands of the forms:
 218   /// MachineBasicBlock, GlobalAddress, ExternalSymbol
 219   ///
 220   bool isPCRelative() const { return (flags & PCRELATIVE) != 0; }
 221
 222
 223   // This is to finally stop caring whether we have a virtual or machine
 224   // register -- an easier interface is to simply call both virtual and machine
 225   // registers essentially the same, yet be able to distinguish when
 226   // necessary. Thus the instruction selector can just add registers without
 227   // abandon, and the register allocator won't be confused.
 228   bool isVirtualRegister() const {
 229     return (opType == MO_VirtualRegister || opType == MO_MachineRegister)
 230       && regNum >= MRegisterInfo::FirstVirtualRegister;
 231   }
 232   bool isRegister() const {
 233     return opType == MO_VirtualRegister || opType == MO_MachineRegister;
 234   }
 235   bool isMachineRegister() const { return !isVirtualRegister(); }
 236   bool isMachineBasicBlock() const { return opType == MO_MachineBasicBlock; }
 237   bool isPCRelativeDisp() const { return opType == MO_PCRelativeDisp; }
 238   bool isImmediate() const {
 239     return opType == MO_SignExtendedImmed || opType == MO_UnextendedImmed;
 240   }
 241   bool isFrameIndex() const { return opType == MO_FrameIndex; }
 242   bool isConstantPoolIndex() const { return opType == MO_ConstantPoolIndex; }
 243   bool isGlobalAddress() const { return opType == MO_GlobalAddress; }
 244   bool isExternalSymbol() const { return opType == MO_ExternalSymbol; }
 245
 246   Value* getVRegValue() const {
 247     assert(opType == MO_VirtualRegister || opType == MO_CCRegister ||
 248            isPCRelativeDisp());
 249     return value;
 250   }
 251   Value* getVRegValueOrNull() const {
 252     return (opType == MO_VirtualRegister || opType == MO_CCRegister ||
 253             isPCRelativeDisp()) ? value : NULL;
 254   }
 255   int getMachineRegNum() const {
 256     assert(opType == MO_MachineRegister);
 257     return regNum;
 258   }
 259   int64_t getImmedValue() const { assert(isImmediate()); return immedVal; }
 260   void setImmedValue(int64_t ImmVal) { assert(isImmediate()); immedVal=ImmVal; }
 261
 262   MachineBasicBlock *getMachineBasicBlock() const {
 263     assert(isMachineBasicBlock() && "Can't get MBB in non-MBB operand!");
 264     return MBB;
 265   }
 266   int getFrameIndex() const { assert(isFrameIndex()); return immedVal; }
 267   unsigned getConstantPoolIndex() const {
 268     assert(isConstantPoolIndex());
 269     return immedVal;
 270   }
 271
 272   GlobalValue *getGlobal() const {
 273     assert(isGlobalAddress());
 274     return (GlobalValue*)value;
 275   }
 276
 277   const std::string &getSymbolName() const {
 278     assert(isExternalSymbol());
 279     return *SymbolName;
 280   }
 281
 282   bool            isUse           () const { return flags & USEFLAG; }
 283   MachineOperand& setUse          ()       { flags |= USEFLAG; return *this; }
 284   bool            isDef           () const { return flags & DEFFLAG; }
 285   MachineOperand& setDef          ()       { flags |= DEFFLAG; return *this; }
 286   bool            isHiBits32      () const { return flags & HIFLAG32; }
 287   bool            isLoBits32      () const { return flags & LOFLAG32; }
 288   bool            isHiBits64      () const { return flags & HIFLAG64; }
 289   bool            isLoBits64      () const { return flags & LOFLAG64; }
 290
 291   // used to check if a machine register has been allocated to this operand
 292   bool hasAllocatedReg() const {
 293     return (regNum >= 0 &&
 294             (opType == MO_VirtualRegister || opType == MO_CCRegister ||
 295              opType == MO_MachineRegister));
 296   }
 297
 298   // used to get the reg number if when one is allocated
 299   int getAllocatedRegNum() const {
 300     assert(hasAllocatedReg());
 301     return regNum;
 302   }
 303
 304   // ********** TODO: get rid of this duplicate code! ***********
 305   unsigned getReg() const {
 306     return getAllocatedRegNum();
 307   }
 308   void setReg(unsigned Reg) {
 309     assert(hasAllocatedReg() && "This operand cannot have a register number!");
 310     regNum = Reg;
 311   }
 312
 313   friend std::ostream& operator<<(std::ostream& os, const MachineOperand& mop);
 314
 315 private:
 316
 317   // Construction methods needed for fine-grain control.
 318   // These must be accessed via coresponding methods in MachineInstr.
 319   void markHi32()      { flags |= HIFLAG32; }
 320   void markLo32()      { flags |= LOFLAG32; }
 321   void markHi64()      { flags |= HIFLAG64; }
 322   void markLo64()      { flags |= LOFLAG64; }
 323
 324   // Replaces the Value with its corresponding physical register after
 325   // register allocation is complete
 326   void setRegForValue(int reg) {
 327     assert(opType == MO_VirtualRegister || opType == MO_CCRegister ||
 328            opType == MO_MachineRegister);
 329     regNum = reg;
 330   }
 331
 332   friend class MachineInstr;
 333 };
 334
 335
 336 //===----------------------------------------------------------------------===//
 337 // class MachineInstr
 338 //
 339 // Purpose:
 340 //   Representation of each machine instruction.
 341 //
 342 //   MachineOpCode must be an enum, defined separately for each target.
 343 //   E.g., It is defined in SparcInstructionSelection.h for the SPARC.
 344 //
 345 //  There are 2 kinds of operands:
 346 //
 347 //  (1) Explicit operands of the machine instruction in vector operands[]
 348 //
 349 //  (2) "Implicit operands" are values implicitly used or defined by the
 350 //      machine instruction, such as arguments to a CALL, return value of
 351 //      a CALL (if any), and return value of a RETURN.
 352 //===----------------------------------------------------------------------===//
 353
 354 class MachineInstr {
 355   int              opCode;              // the opcode
 356   unsigned         opCodeFlags;         // flags modifying instrn behavior
 357   std::vector<MachineOperand> operands; // the operands
 358   unsigned numImplicitRefs;             // number of implicit operands
 359
 360   // OperandComplete - Return true if it's illegal to add a new operand
 361   bool OperandsComplete() const;
 362
 363   MachineInstr(const MachineInstr &);  // DO NOT IMPLEMENT
 364   void operator=(const MachineInstr&); // DO NOT IMPLEMENT
 365 public:
 366   MachineInstr(int Opcode, unsigned numOperands);
 367
 368   /// MachineInstr ctor - This constructor only does a _reserve_ of the
 369   /// operands, not a resize for them.  It is expected that if you use this that
 370   /// you call add* methods below to fill up the operands, instead of the Set
 371   /// methods.  Eventually, the "resizing" ctors will be phased out.
 372   ///
 373   MachineInstr(int Opcode, unsigned numOperands, bool XX, bool YY);
 374
 375   /// MachineInstr ctor - Work exactly the same as the ctor above, except that
 376   /// the MachineInstr is created and added to the end of the specified basic
 377   /// block.
 378   ///
 379   MachineInstr(MachineBasicBlock *MBB, int Opcode, unsigned numOps);
 380
 381
 382   // The opcode.
 383   //
 384   const int getOpcode() const { return opCode; }
 385   const int getOpCode() const { return opCode; }
 386
 387   // Opcode flags.
 388   //
 389   unsigned       getOpCodeFlags() const { return opCodeFlags; }
 390
 391   //
 392   // Access to explicit operands of the instruction
 393   //
 394   unsigned getNumOperands() const { return operands.size() - numImplicitRefs; }
 395
 396   const MachineOperand& getOperand(unsigned i) const {
 397     assert(i < getNumOperands() && "getOperand() out of range!");
 398     return operands[i];
 399   }
 400   MachineOperand& getOperand(unsigned i) {
 401     assert(i < getNumOperands() && "getOperand() out of range!");
 402     return operands[i];
 403   }
 404
 405   //
 406   // Access to explicit or implicit operands of the instruction
 407   // This returns the i'th entry in the operand vector.
 408   // That represents the i'th explicit operand or the (i-N)'th implicit operand,
 409   // depending on whether i < N or i >= N.
 410   //
 411   const MachineOperand& getExplOrImplOperand(unsigned i) const {
 412     assert(i < operands.size() && "getExplOrImplOperand() out of range!");
 413     return (i < getNumOperands()? getOperand(i)
 414                                 : getImplicitOp(i - getNumOperands()));
 415   }
 416
 417   //
 418   // Access to implicit operands of the instruction
 419   //
 420   unsigned getNumImplicitRefs() const{ return numImplicitRefs; }
 421
 422   MachineOperand& getImplicitOp(unsigned i) {
 423     assert(i < numImplicitRefs && "implicit ref# out of range!");
 424     return operands[i + operands.size() - numImplicitRefs];
 425   }
 426   const MachineOperand& getImplicitOp(unsigned i) const {
 427     assert(i < numImplicitRefs && "implicit ref# out of range!");
 428     return operands[i + operands.size() - numImplicitRefs];
 429   }
 430
 431   Value* getImplicitRef(unsigned i) {
 432     return getImplicitOp(i).getVRegValue();
 433   }
 434   const Value* getImplicitRef(unsigned i) const {
 435     return getImplicitOp(i).getVRegValue();
 436   }
 437
 438   void addImplicitRef(Value* V, bool isDef = false, bool isDefAndUse = false) {
 439     ++numImplicitRefs;
 440     addRegOperand(V, isDef, isDefAndUse);
 441   }
 442   void setImplicitRef(unsigned i, Value* V) {
 443     assert(i < getNumImplicitRefs() && "setImplicitRef() out of range!");
 444     SetMachineOperandVal(i + getNumOperands(),
 445                          MachineOperand::MO_VirtualRegister, V);
 446   }
 447
 448   //
 449   // Debugging support
 450   //
 451   void print(std::ostream &OS, const TargetMachine &TM) const;
 452   void dump() const;
 453   friend std::ostream& operator<<(std::ostream& os, const MachineInstr& minstr);
 454
 455   //
 456   // Define iterators to access the Value operands of the Machine Instruction.
 457   // Note that these iterators only enumerate the explicit operands.
 458   // begin() and end() are defined to produce these iterators...
 459   //
 460   template<class _MI, class _V> class ValOpIterator;
 461   typedef ValOpIterator<const MachineInstr*,const Value*> const_val_op_iterator;
 462   typedef ValOpIterator<      MachineInstr*,      Value*> val_op_iterator;
 463
 464
 465   //===--------------------------------------------------------------------===//
 466   // Accessors to add operands when building up machine instructions
 467   //
 468
 469   /// addRegOperand - Add a MO_VirtualRegister operand to the end of the
 470   /// operands list...
 471   ///
 472   void addRegOperand(Value *V, bool isDef, bool isDefAndUse=false) {
 473     assert(!OperandsComplete() &&
 474            "Trying to add an operand to a machine instr that is already done!");
 475     operands.push_back(MachineOperand(V, MachineOperand::MO_VirtualRegister,
 476              !isDef ? MOTy::Use : (isDefAndUse ? MOTy::UseAndDef : MOTy::Def)));
 477   }
 478
 479   void addRegOperand(Value *V, MOTy::UseType UTy = MOTy::Use,
 480                      bool isPCRelative = false) {
 481     assert(!OperandsComplete() &&
 482            "Trying to add an operand to a machine instr that is already done!");
 483     operands.push_back(MachineOperand(V, MachineOperand::MO_VirtualRegister,
 484                                       UTy, isPCRelative));
 485   }
 486
 487   void addCCRegOperand(Value *V, MOTy::UseType UTy = MOTy::Use) {
 488     assert(!OperandsComplete() &&
 489            "Trying to add an operand to a machine instr that is already done!");
 490     operands.push_back(MachineOperand(V, MachineOperand::MO_CCRegister, UTy,
 491                                       false));
 492   }
 493
 494
 495   /// addRegOperand - Add a symbolic virtual register reference...
 496   ///
 497   void addRegOperand(int reg, bool isDef) {
 498     assert(!OperandsComplete() &&
 499            "Trying to add an operand to a machine instr that is already done!");
 500     operands.push_back(MachineOperand(reg, MachineOperand::MO_VirtualRegister,
 501                                       isDef ? MOTy::Def : MOTy::Use));
 502   }
 503
 504   /// addRegOperand - Add a symbolic virtual register reference...
 505   ///
 506   void addRegOperand(int reg, MOTy::UseType UTy = MOTy::Use) {
 507     assert(!OperandsComplete() &&
 508            "Trying to add an operand to a machine instr that is already done!");
 509     operands.push_back(MachineOperand(reg, MachineOperand::MO_VirtualRegister,
 510                                       UTy));
 511   }
 512
 513   /// addPCDispOperand - Add a PC relative displacement operand to the MI
 514   ///
 515   void addPCDispOperand(Value *V) {
 516     assert(!OperandsComplete() &&
 517            "Trying to add an operand to a machine instr that is already done!");
 518     operands.push_back(MachineOperand(V, MachineOperand::MO_PCRelativeDisp,
 519                                       MOTy::Use));
 520   }
 521
 522   /// addMachineRegOperand - Add a virtual register operand to this MachineInstr
 523   ///
 524   void addMachineRegOperand(int reg, bool isDef) {
 525     assert(!OperandsComplete() &&
 526            "Trying to add an operand to a machine instr that is already done!");
 527     operands.push_back(MachineOperand(reg, MachineOperand::MO_MachineRegister,
 528                                       isDef ? MOTy::Def : MOTy::Use));
 529   }
 530
 531   /// addMachineRegOperand - Add a virtual register operand to this MachineInstr
 532   ///
 533   void addMachineRegOperand(int reg, MOTy::UseType UTy = MOTy::Use) {
 534     assert(!OperandsComplete() &&
 535            "Trying to add an operand to a machine instr that is already done!");
 536     operands.push_back(MachineOperand(reg, MachineOperand::MO_MachineRegister,
 537                                       UTy));
 538   }
 539
 540   /// addZeroExtImmOperand - Add a zero extended constant argument to the
 541   /// machine instruction.
 542   ///
 543   void addZeroExtImmOperand(int64_t intValue) {
 544     assert(!OperandsComplete() &&
 545            "Trying to add an operand to a machine instr that is already done!");
 546     operands.push_back(MachineOperand(intValue,
 547                                       MachineOperand::MO_UnextendedImmed));
 548   }
 549
 550   /// addSignExtImmOperand - Add a zero extended constant argument to the
 551   /// machine instruction.
 552   ///
 553   void addSignExtImmOperand(int64_t intValue) {
 554     assert(!OperandsComplete() &&
 555            "Trying to add an operand to a machine instr that is already done!");
 556     operands.push_back(MachineOperand(intValue,
 557                                       MachineOperand::MO_SignExtendedImmed));
 558   }
 559
 560   void addMachineBasicBlockOperand(MachineBasicBlock *MBB) {
 561     assert(!OperandsComplete() &&
 562            "Trying to add an operand to a machine instr that is already done!");
 563     operands.push_back(MachineOperand(MBB));
 564   }
 565
 566   /// addFrameIndexOperand - Add an abstract frame index to the instruction
 567   ///
 568   void addFrameIndexOperand(unsigned Idx) {
 569     assert(!OperandsComplete() &&
 570            "Trying to add an operand to a machine instr that is already done!");
 571     operands.push_back(MachineOperand(Idx, MachineOperand::MO_FrameIndex));
 572   }
 573
 574   /// addConstantPoolndexOperand - Add a constant pool object index to the
 575   /// instruction.
 576   ///
 577   void addConstantPoolIndexOperand(unsigned I) {
 578     assert(!OperandsComplete() &&
 579            "Trying to add an operand to a machine instr that is already done!");
 580     operands.push_back(MachineOperand(I, MachineOperand::MO_ConstantPoolIndex));
 581   }
 582
 583   void addGlobalAddressOperand(GlobalValue *GV, bool isPCRelative) {
 584     assert(!OperandsComplete() &&
 585            "Trying to add an operand to a machine instr that is already done!");
 586     operands.push_back(MachineOperand((Value*)GV,
 587                                       MachineOperand::MO_GlobalAddress,
 588                                       MOTy::Use, isPCRelative));
 589   }
 590
 591   /// addExternalSymbolOperand - Add an external symbol operand to this instr
 592   ///
 593   void addExternalSymbolOperand(const std::string &SymName, bool isPCRelative) {
 594     operands.push_back(MachineOperand(SymName, isPCRelative));
 595   }
 596
 597   //===--------------------------------------------------------------------===//
 598   // Accessors used to modify instructions in place.
 599   //
 600   // FIXME: Move this stuff to MachineOperand itself!
 601
 602   /// replace - Support to rewrite a machine instruction in place: for now,
 603   /// simply replace() and then set new operands with Set.*Operand methods
 604   /// below.
 605   ///
 606   void replace(int Opcode, unsigned numOperands);
 607
 608   /// setOpcode - Replace the opcode of the current instruction with a new one.
 609   ///
 610   void setOpcode(unsigned Op) { opCode = Op; }
 611
 612   /// RemoveOperand - Erase an operand  from an instruction, leaving it with one
 613   /// fewer operand than it started with.
 614   ///
 615   void RemoveOperand(unsigned i) {
 616     operands.erase(operands.begin()+i);
 617   }
 618
 619   // Access to set the operands when building the machine instruction
 620   //
 621   void SetMachineOperandVal     (unsigned i,
 622                                  MachineOperand::MachineOperandType operandType,
 623                                  Value* V);
 624
 625   void SetMachineOperandConst   (unsigned i,
 626                                  MachineOperand::MachineOperandType operandType,
 627                                  int64_t intValue);
 628
 629   void SetMachineOperandReg(unsigned i, int regNum);
 630
 631
 632   unsigned substituteValue(const Value* oldVal, Value* newVal,
 633                            bool defsOnly, bool notDefsAndUses,
 634                            bool& someArgsWereIgnored);
 635
 636   void setOperandHi32(unsigned i) { operands[i].markHi32(); }
 637   void setOperandLo32(unsigned i) { operands[i].markLo32(); }
 638   void setOperandHi64(unsigned i) { operands[i].markHi64(); }
 639   void setOperandLo64(unsigned i) { operands[i].markLo64(); }
 640
 641
 642   // SetRegForOperand -
 643   // SetRegForImplicitRef -
 644   // Mark an explicit or implicit operand with its allocated physical register.
 645   //
 646   void SetRegForOperand(unsigned i, int regNum);
 647   void SetRegForImplicitRef(unsigned i, int regNum);
 648
 649   //
 650   // Iterator to enumerate machine operands.
 651   //
 652   template<class MITy, class VTy>
 653   class ValOpIterator : public forward_iterator<VTy, ptrdiff_t> {
 654     unsigned i;
 655     MITy MI;
 656
 657     void skipToNextVal() {
 658       while (i < MI->getNumOperands() &&
 659              !( (MI->getOperand(i).getType() == MachineOperand::MO_VirtualRegister ||
 660                  MI->getOperand(i).getType() == MachineOperand::MO_CCRegister)
 661                 && MI->getOperand(i).getVRegValue() != 0))
 662         ++i;
 663     }
 664
 665     inline ValOpIterator(MITy mi, unsigned I) : i(I), MI(mi) {
 666       skipToNextVal();
 667     }
 668
 669   public:
 670     typedef ValOpIterator<MITy, VTy> _Self;
 671
 672     inline VTy operator*() const {
 673       return MI->getOperand(i).getVRegValue();
 674     }
 675
 676     const MachineOperand &getMachineOperand() const { return MI->getOperand(i);}
 677           MachineOperand &getMachineOperand()       { return MI->getOperand(i);}
 678
 679     inline VTy operator->() const { return operator*(); }
 680
 681     inline bool isUse()   const { return MI->getOperand(i).isUse(); }
 682     inline bool isDef()   const { return MI->getOperand(i).isDef(); }
 683
 684     inline _Self& operator++() { i++; skipToNextVal(); return *this; }
 685     inline _Self  operator++(int) { _Self tmp = *this; ++*this; return tmp; }
 686
 687     inline bool operator==(const _Self &y) const {
 688       return i == y.i;
 689     }
 690     inline bool operator!=(const _Self &y) const {
 691       return !operator==(y);
 692     }
 693
 694     static _Self begin(MITy MI) {
 695       return _Self(MI, 0);
 696     }
 697     static _Self end(MITy MI) {
 698       return _Self(MI, MI->getNumOperands());
 699     }
 700   };
 701
 702   // define begin() and end()
 703   val_op_iterator begin() { return val_op_iterator::begin(this); }
 704   val_op_iterator end()   { return val_op_iterator::end(this); }
 705
 706   const_val_op_iterator begin() const {
 707     return const_val_op_iterator::begin(this);
 708   }
 709   const_val_op_iterator end() const {
 710     return const_val_op_iterator::end(this);
 711   }
 712 };
 713
 714
 715 //===----------------------------------------------------------------------===//
 716 // Debugging Support
 717
 718 std::ostream& operator<<(std::ostream &OS, const MachineInstr &MI);
 719 std::ostream& operator<<(std::ostream &OS, const MachineOperand &MO);
 720 void PrintMachineInstructions(const Function *F);
 721
 722 } // End llvm namespace
 723
 724 #endif