1 //===-- llvm/CodeGen/MachineInstr.h - MachineInstr class ---------*- C++ -*--=//
3 // This file contains the declaration of the MachineInstr class, which is the
4 // basic representation for all target dependant machine instructions used by
7 //===----------------------------------------------------------------------===//
9 #ifndef LLVM_CODEGEN_MACHINEINSTR_H
10 #define LLVM_CODEGEN_MACHINEINSTR_H
12 #include "llvm/Annotation.h"
13 #include "Support/iterator"
14 #include "Support/NonCopyable.h"
18 class MachineBasicBlock;
21 typedef int MachineOpCode;
23 /// MOTy - MachineOperandType - This namespace contains an enum that describes
24 /// how the machine operand is used by the instruction: is it read, defined, or
25 /// both? Note that the MachineInstr/Operator class currently uses bool
26 /// arguments to represent this information instead of an enum. Eventually this
27 /// should change over to use this _easier to read_ representation instead.
31 Use, /// This machine operand is only read by the instruction
32 Def, /// This machine operand is only written by the instruction
33 UseAndDef /// This machine operand is read AND written
37 //---------------------------------------------------------------------------
38 // class MachineOperand
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.
45 // E.g, for this VM instruction:
46 // ptr = alloca type, numElements
47 // we generate 2 machine instructions on the SPARC:
49 // mul Constant, Numelements -> Reg
50 // add %sp, Reg -> Ptr
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.
56 // For the register operands, the virtual register type is as follows:
58 // - Reg will be of virtual register type MO_MInstrVirtualReg. The field
59 // MachineInstr* minstr will point to the instruction that computes reg.
61 // - %sp will be of virtual register type MO_MachineReg.
62 // The field regNum identifies the machine register.
64 // - NumElements will be of virtual register type MO_VirtualReg.
65 // The field Value* value identifies the value.
67 // - Ptr will also be of virtual register type MO_VirtualReg.
68 // Again, the field Value* value identifies the value.
70 //---------------------------------------------------------------------------
72 class MachineOperand {
74 enum MachineOperandType {
75 MO_VirtualRegister, // virtual register for *value
76 MO_MachineRegister, // pre-assigned machine register `regNum'
84 // Bit fields of the flags variable used for different operand properties
85 static const char DEFFLAG = 0x1; // this is a def of the operand
86 static const char DEFUSEFLAG = 0x2; // this is both a def and a use
87 static const char HIFLAG32 = 0x4; // operand is %hi32(value_or_immedVal)
88 static const char LOFLAG32 = 0x8; // operand is %lo32(value_or_immedVal)
89 static const char HIFLAG64 = 0x10; // operand is %hi64(value_or_immedVal)
90 static const char LOFLAG64 = 0x20; // operand is %lo64(value_or_immedVal)
94 Value* value; // BasicBlockVal for a label operand.
95 // ConstantVal for a non-address immediate.
96 // Virtual register for an SSA operand,
97 // including hidden operands required for
98 // the generated machine code.
99 int64_t immedVal; // constant value for an explicit constant
102 MachineOperandType opType:8; // Pack into 8 bits efficiently after flags.
103 char flags; // see bit field definitions above
104 int regNum; // register number for an explicit register
105 // will be set for a value after reg allocation
109 opType(MO_VirtualRegister),
113 MachineOperand(int64_t ImmVal, MachineOperandType OpTy)
119 MachineOperand(int Reg, MachineOperandType OpTy, MOTy::UseType UseTy)
124 case MOTy::Use: flags = 0; break;
125 case MOTy::Def: flags = DEFFLAG; break;
126 case MOTy::UseAndDef: flags = DEFUSEFLAG; break;
127 default: assert(0 && "Invalid value for UseTy!");
131 MachineOperand(Value *V, MachineOperandType OpTy, MOTy::UseType UseTy)
132 : value(V), opType(OpTy), regNum(-1) {
134 case MOTy::Use: flags = 0; break;
135 case MOTy::Def: flags = DEFFLAG; break;
136 case MOTy::UseAndDef: flags = DEFUSEFLAG; break;
137 default: assert(0 && "Invalid value for UseTy!");
142 MachineOperand(const MachineOperand &M)
143 : immedVal(M.immedVal),
150 // Accessor methods. Caller is responsible for checking the
151 // operand type before invoking the corresponding accessor.
153 MachineOperandType getType() const { return opType; }
155 inline Value* getVRegValue () const {
156 assert(opType == MO_VirtualRegister || opType == MO_CCRegister ||
157 opType == MO_PCRelativeDisp);
160 inline Value* getVRegValueOrNull() const {
161 return (opType == MO_VirtualRegister || opType == MO_CCRegister ||
162 opType == MO_PCRelativeDisp)? value : NULL;
164 inline int getMachineRegNum() const {
165 assert(opType == MO_MachineRegister);
168 inline int64_t getImmedValue () const {
169 assert(opType == MO_SignExtendedImmed || opType == MO_UnextendedImmed);
172 bool opIsDef () const { return flags & DEFFLAG; }
173 bool opIsDefAndUse () const { return flags & DEFUSEFLAG; }
174 bool opHiBits32 () const { return flags & HIFLAG32; }
175 bool opLoBits32 () const { return flags & LOFLAG32; }
176 bool opHiBits64 () const { return flags & HIFLAG64; }
177 bool opLoBits64 () const { return flags & LOFLAG64; }
179 // used to check if a machine register has been allocated to this operand
180 inline bool hasAllocatedReg() const {
181 return (regNum >= 0 &&
182 (opType == MO_VirtualRegister || opType == MO_CCRegister ||
183 opType == MO_MachineRegister));
186 // used to get the reg number if when one is allocated
187 inline int getAllocatedRegNum() const {
188 assert(opType == MO_VirtualRegister || opType == MO_CCRegister ||
189 opType == MO_MachineRegister);
194 friend std::ostream& operator<<(std::ostream& os, const MachineOperand& mop);
198 // Construction methods needed for fine-grain control.
199 // These must be accessed via coresponding methods in MachineInstr.
200 void markDef() { flags |= DEFFLAG; }
201 void markDefAndUse() { flags |= DEFUSEFLAG; }
202 void markHi32() { flags |= HIFLAG32; }
203 void markLo32() { flags |= LOFLAG32; }
204 void markHi64() { flags |= HIFLAG64; }
205 void markLo64() { flags |= LOFLAG64; }
207 // Replaces the Value with its corresponding physical register after
208 // register allocation is complete
209 void setRegForValue(int reg) {
210 assert(opType == MO_VirtualRegister || opType == MO_CCRegister ||
211 opType == MO_MachineRegister);
215 friend class MachineInstr;
219 //---------------------------------------------------------------------------
220 // class MachineInstr
223 // Representation of each machine instruction.
225 // MachineOpCode must be an enum, defined separately for each target.
226 // E.g., It is defined in SparcInstructionSelection.h for the SPARC.
228 // There are 2 kinds of operands:
230 // (1) Explicit operands of the machine instruction in vector operands[]
232 // (2) "Implicit operands" are values implicitly used or defined by the
233 // machine instruction, such as arguments to a CALL, return value of
234 // a CALL (if any), and return value of a RETURN.
235 //---------------------------------------------------------------------------
237 class MachineInstr: public NonCopyable { // Disable copy operations
239 MachineOpCode opCode; // the opcode
240 std::vector<MachineOperand> operands; // the operands
241 unsigned numImplicitRefs; // number of implicit operands
243 MachineOperand& getImplicitOp(unsigned i) {
244 assert(i < numImplicitRefs && "implicit ref# out of range!");
245 return operands[i + operands.size() - numImplicitRefs];
247 const MachineOperand& getImplicitOp(unsigned i) const {
248 assert(i < numImplicitRefs && "implicit ref# out of range!");
249 return operands[i + operands.size() - numImplicitRefs];
252 // regsUsed - all machine registers used for this instruction, including regs
253 // used to save values across the instruction. This is a bitset of registers.
254 std::vector<bool> regsUsed;
256 // OperandComplete - Return true if it's illegal to add a new operand
257 bool OperandsComplete() const;
260 MachineInstr(MachineOpCode Opcode);
261 MachineInstr(MachineOpCode Opcode, unsigned numOperands);
263 /// MachineInstr ctor - This constructor only does a _reserve_ of the
264 /// operands, not a resize for them. It is expected that if you use this that
265 /// you call add* methods below to fill up the operands, instead of the Set
266 /// methods. Eventually, the "resizing" ctors will be phased out.
268 MachineInstr(MachineOpCode Opcode, unsigned numOperands, bool XX, bool YY);
270 /// MachineInstr ctor - Work exactly the same as the ctor above, except that
271 /// the MachineInstr is created and added to the end of the specified basic
274 MachineInstr(MachineBasicBlock *MBB, MachineOpCode Opcode, unsigned numOps);
277 /// replace - Support to rewrite a machine instruction in place: for now,
278 /// simply replace() and then set new operands with Set.*Operand methods
281 void replace(MachineOpCode Opcode, unsigned numOperands);
285 const MachineOpCode getOpcode() const { return opCode; }
286 const MachineOpCode getOpCode() const { return opCode; }
289 // Information about explicit operands of the instruction
291 unsigned getNumOperands() const { return operands.size() - numImplicitRefs; }
293 const MachineOperand& getOperand(unsigned i) const {
294 assert(i < getNumOperands() && "getOperand() out of range!");
297 MachineOperand& getOperand(unsigned i) {
298 assert(i < getNumOperands() && "getOperand() out of range!");
302 MachineOperand::MachineOperandType getOperandType(unsigned i) const {
303 return getOperand(i).getType();
306 bool operandIsDefined(unsigned i) const {
307 return getOperand(i).opIsDef();
310 bool operandIsDefinedAndUsed(unsigned i) const {
311 return getOperand(i).opIsDefAndUse();
315 // Information about implicit operands of the instruction
317 unsigned getNumImplicitRefs() const{ return numImplicitRefs; }
319 const Value* getImplicitRef(unsigned i) const {
320 return getImplicitOp(i).getVRegValue();
322 Value* getImplicitRef(unsigned i) {
323 return getImplicitOp(i).getVRegValue();
326 bool implicitRefIsDefined(unsigned i) const {
327 return getImplicitOp(i).opIsDef();
329 bool implicitRefIsDefinedAndUsed(unsigned i) const {
330 return getImplicitOp(i).opIsDefAndUse();
332 inline void addImplicitRef (Value* V,
333 bool isDef=false,bool isDefAndUse=false);
334 inline void setImplicitRef (unsigned i, Value* V,
335 bool isDef=false, bool isDefAndUse=false);
338 // Information about registers used in this instruction
340 const std::vector<bool> &getRegsUsed() const { return regsUsed; }
342 // insertUsedReg - Add a register to the Used registers set...
343 void insertUsedReg(unsigned Reg) {
344 if (Reg >= regsUsed.size())
345 regsUsed.resize(Reg+1);
346 regsUsed[Reg] = true;
352 void print(std::ostream &OS, const TargetMachine &TM);
354 friend std::ostream& operator<<(std::ostream& os, const MachineInstr& minstr);
357 // Define iterators to access the Value operands of the Machine Instruction.
358 // Note that these iterators only enumerate the explicit operands.
359 // begin() and end() are defined to produce these iterators...
361 template<class _MI, class _V> class ValOpIterator;
362 typedef ValOpIterator<const MachineInstr*,const Value*> const_val_op_iterator;
363 typedef ValOpIterator< MachineInstr*, Value*> val_op_iterator;
365 // Access to set the operands when building the machine instruction
367 void SetMachineOperandVal (unsigned i,
368 MachineOperand::MachineOperandType operandType,
371 bool isDefAndUse=false);
373 void SetMachineOperandConst (unsigned i,
374 MachineOperand::MachineOperandType operandType,
377 void SetMachineOperandReg (unsigned i,
381 //===--------------------------------------------------------------------===//
382 // Accessors to add operands when building up machine instructions
385 /// addRegOperand - Add a MO_VirtualRegister operand to the end of the
388 void addRegOperand(Value *V, bool isDef=false, bool isDefAndUse=false) {
389 assert(!OperandsComplete() &&
390 "Trying to add an operand to a machine instr that is already done!");
391 operands.push_back(MachineOperand(V, MachineOperand::MO_VirtualRegister,
392 !isDef ? MOTy::Use : (isDefAndUse ? MOTy::UseAndDef : MOTy::Def)));
395 void addRegOperand(Value *V, MOTy::UseType UTy = MOTy::Use) {
396 assert(!OperandsComplete() &&
397 "Trying to add an operand to a machine instr that is already done!");
398 operands.push_back(MachineOperand(V, MachineOperand::MO_VirtualRegister,
402 /// addRegOperand - Add a symbolic virtual register reference...
404 void addRegOperand(int reg, bool isDef = false) {
405 assert(!OperandsComplete() &&
406 "Trying to add an operand to a machine instr that is already done!");
407 operands.push_back(MachineOperand(reg, MachineOperand::MO_VirtualRegister,
408 isDef ? MOTy::Def : MOTy::Use));
411 /// addPCDispOperand - Add a PC relative displacement operand to the MI
413 void addPCDispOperand(Value *V) {
414 assert(!OperandsComplete() &&
415 "Trying to add an operand to a machine instr that is already done!");
416 operands.push_back(MachineOperand(V, MachineOperand::MO_PCRelativeDisp,
420 /// addMachineRegOperand - Add a virtual register operand to this MachineInstr
422 void addMachineRegOperand(int reg, bool isDef=false) {
423 assert(!OperandsComplete() &&
424 "Trying to add an operand to a machine instr that is already done!");
425 operands.push_back(MachineOperand(reg, MachineOperand::MO_MachineRegister,
426 isDef ? MOTy::Def : MOTy::Use));
430 /// addZeroExtImmOperand - Add a zero extended constant argument to the
431 /// machine instruction.
433 void addZeroExtImmOperand(int64_t intValue) {
434 assert(!OperandsComplete() &&
435 "Trying to add an operand to a machine instr that is already done!");
436 operands.push_back(MachineOperand(intValue,
437 MachineOperand::MO_UnextendedImmed));
440 /// addSignExtImmOperand - Add a zero extended constant argument to the
441 /// machine instruction.
443 void addSignExtImmOperand(int64_t intValue) {
444 assert(!OperandsComplete() &&
445 "Trying to add an operand to a machine instr that is already done!");
446 operands.push_back(MachineOperand(intValue,
447 MachineOperand::MO_SignExtendedImmed));
451 unsigned substituteValue(const Value* oldVal, Value* newVal,
452 bool defsOnly = true);
454 void setOperandHi32(unsigned i) { operands[i].markHi32(); }
455 void setOperandLo32(unsigned i) { operands[i].markLo32(); }
456 void setOperandHi64(unsigned i) { operands[i].markHi64(); }
457 void setOperandLo64(unsigned i) { operands[i].markLo64(); }
460 // SetRegForOperand - Replaces the Value for the operand with its allocated
461 // physical register after register allocation is complete.
463 void SetRegForOperand(unsigned i, int regNum);
466 // Iterator to enumerate machine operands.
468 template<class MITy, class VTy>
469 class ValOpIterator : public forward_iterator<VTy, ptrdiff_t> {
473 void skipToNextVal() {
474 while (i < MI->getNumOperands() &&
475 !( (MI->getOperandType(i) == MachineOperand::MO_VirtualRegister ||
476 MI->getOperandType(i) == MachineOperand::MO_CCRegister)
477 && MI->getOperand(i).getVRegValue() != 0))
481 inline ValOpIterator(MITy mi, unsigned I) : i(I), MI(mi) {
486 typedef ValOpIterator<MITy, VTy> _Self;
488 inline VTy operator*() const {
489 return MI->getOperand(i).getVRegValue();
492 const MachineOperand &getMachineOperand() const { return MI->getOperand(i);}
493 MachineOperand &getMachineOperand() { return MI->getOperand(i);}
495 inline VTy operator->() const { return operator*(); }
497 inline bool isDef() const { return MI->getOperand(i).opIsDef(); }
498 inline bool isDefAndUse() const { return MI->getOperand(i).opIsDefAndUse();}
500 inline _Self& operator++() { i++; skipToNextVal(); return *this; }
501 inline _Self operator++(int) { _Self tmp = *this; ++*this; return tmp; }
503 inline bool operator==(const _Self &y) const {
506 inline bool operator!=(const _Self &y) const {
507 return !operator==(y);
510 static _Self begin(MITy MI) {
513 static _Self end(MITy MI) {
514 return _Self(MI, MI->getNumOperands());
518 // define begin() and end()
519 val_op_iterator begin() { return val_op_iterator::begin(this); }
520 val_op_iterator end() { return val_op_iterator::end(this); }
522 const_val_op_iterator begin() const {
523 return const_val_op_iterator::begin(this);
525 const_val_op_iterator end() const {
526 return const_val_op_iterator::end(this);
531 // Define here to enable inlining of the functions used.
533 void MachineInstr::addImplicitRef(Value* V,
538 addRegOperand(V, isDef, isDefAndUse);
541 void MachineInstr::setImplicitRef(unsigned i,
546 assert(i < getNumImplicitRefs() && "setImplicitRef() out of range!");
547 SetMachineOperandVal(i + getNumOperands(),
548 MachineOperand::MO_VirtualRegister,
549 V, isDef, isDefAndUse);
553 //---------------------------------------------------------------------------
555 //---------------------------------------------------------------------------
557 std::ostream& operator<< (std::ostream& os,
558 const MachineInstr& minstr);
560 std::ostream& operator<< (std::ostream& os,
561 const MachineOperand& mop);
563 void PrintMachineInstructions (const Function *F);