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