1 //===-- llvm/CodeGen/MachineInstr.h - MachineInstr class --------*- C++ -*-===//
3 // The LLVM Compiler Infrastructure
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.
8 //===----------------------------------------------------------------------===//
10 // This file contains the declaration of the MachineInstr class, which is the
11 // basic representation for all target dependent machine instructions used by
14 //===----------------------------------------------------------------------===//
16 #ifndef LLVM_CODEGEN_MACHINEINSTR_H
17 #define LLVM_CODEGEN_MACHINEINSTR_H
19 #include "llvm/ADT/iterator"
20 #include "llvm/Support/DataTypes.h"
21 #include "llvm/Support/Streams.h"
30 class MachineBasicBlock;
31 class TargetInstrDescriptor;
35 template <typename T> struct ilist_traits;
36 template <typename T> struct ilist;
38 //===----------------------------------------------------------------------===//
39 // class MachineOperand
41 // Representation of each machine instruction operand.
43 struct MachineOperand {
44 enum MachineOperandType {
45 MO_Register, // Register operand.
46 MO_Immediate, // Immediate Operand
47 MO_MachineBasicBlock, // MachineBasicBlock reference
48 MO_FrameIndex, // Abstract Stack Frame Index
49 MO_ConstantPoolIndex, // Address of indexed Constant in Constant Pool
50 MO_JumpTableIndex, // Address of indexed Jump Table for switch
51 MO_ExternalSymbol, // Name of external global symbol
52 MO_GlobalAddress // Address of a global value
57 GlobalValue *GV; // For MO_GlobalAddress.
58 MachineBasicBlock *MBB; // For MO_MachineBasicBlock.
59 const char *SymbolName; // For MO_ExternalSymbol.
60 unsigned RegNo; // For MO_Register.
61 int64_t immedVal; // For MO_Immediate and MO_*Index.
64 MachineOperandType opType:8; // Discriminate the union.
65 bool IsDef : 1; // True if this is a def, false if this is a use.
66 bool IsImp : 1; // True if this is an implicit def or use.
68 bool IsKill : 1; // True if this is a reg use and the reg is dead
69 // immediately after the read.
70 bool IsDead : 1; // True if this is a reg def and the reg is dead
71 // immediately after the write. i.e. A register
72 // that is defined but never used.
74 /// auxInfo - auxiliary information used by the MachineOperand
76 /// offset - Offset to address of global or external, only valid for
77 /// MO_GlobalAddress, MO_ExternalSym and MO_ConstantPoolIndex
83 void print(std::ostream &os) const;
84 void print(std::ostream *os) const { if (os) print(*os); }
87 MachineOperand(const MachineOperand &M) {
93 static MachineOperand CreateImm(int64_t Val) {
95 Op.opType = MachineOperand::MO_Immediate;
96 Op.contents.immedVal = Val;
101 Op.auxInfo.offset = 0;
105 static MachineOperand CreateFrameIndex(unsigned Idx) {
107 Op.opType = MachineOperand::MO_FrameIndex;
108 Op.contents.immedVal = Idx;
113 Op.auxInfo.offset = 0;
117 const MachineOperand &operator=(const MachineOperand &MO) {
118 contents = MO.contents;
124 auxInfo = MO.auxInfo;
128 /// getType - Returns the MachineOperandType for this operand.
130 MachineOperandType getType() const { return opType; }
132 /// Accessors that tell you what kind of MachineOperand you're looking at.
134 bool isRegister() const { return opType == MO_Register; }
135 bool isImmediate() const { return opType == MO_Immediate; }
136 bool isMachineBasicBlock() const { return opType == MO_MachineBasicBlock; }
137 bool isFrameIndex() const { return opType == MO_FrameIndex; }
138 bool isConstantPoolIndex() const { return opType == MO_ConstantPoolIndex; }
139 bool isJumpTableIndex() const { return opType == MO_JumpTableIndex; }
140 bool isGlobalAddress() const { return opType == MO_GlobalAddress; }
141 bool isExternalSymbol() const { return opType == MO_ExternalSymbol; }
143 int64_t getImm() const {
144 assert(isImmediate() && "Wrong MachineOperand accessor");
145 return contents.immedVal;
148 int64_t getImmedValue() const {
149 assert(isImmediate() && "Wrong MachineOperand accessor");
150 return contents.immedVal;
152 MachineBasicBlock *getMBB() const {
153 assert(isMachineBasicBlock() && "Wrong MachineOperand accessor");
156 MachineBasicBlock *getMachineBasicBlock() const {
157 assert(isMachineBasicBlock() && "Wrong MachineOperand accessor");
160 void setMachineBasicBlock(MachineBasicBlock *MBB) {
161 assert(isMachineBasicBlock() && "Wrong MachineOperand accessor");
164 int getFrameIndex() const {
165 assert(isFrameIndex() && "Wrong MachineOperand accessor");
166 return (int)contents.immedVal;
168 unsigned getConstantPoolIndex() const {
169 assert(isConstantPoolIndex() && "Wrong MachineOperand accessor");
170 return (unsigned)contents.immedVal;
172 unsigned getJumpTableIndex() const {
173 assert(isJumpTableIndex() && "Wrong MachineOperand accessor");
174 return (unsigned)contents.immedVal;
176 GlobalValue *getGlobal() const {
177 assert(isGlobalAddress() && "Wrong MachineOperand accessor");
180 int getOffset() const {
181 assert((isGlobalAddress() || isExternalSymbol() || isConstantPoolIndex()) &&
182 "Wrong MachineOperand accessor");
183 return auxInfo.offset;
185 const char *getSymbolName() const {
186 assert(isExternalSymbol() && "Wrong MachineOperand accessor");
187 return contents.SymbolName;
191 assert(isRegister() && "Wrong MachineOperand accessor");
195 assert(isRegister() && "Wrong MachineOperand accessor");
199 assert(isRegister() && "Wrong MachineOperand accessor");
203 assert(isRegister() && "Wrong MachineOperand accessor");
207 bool isImplicit() const {
208 assert(isRegister() && "Wrong MachineOperand accessor");
212 assert(isRegister() && "Wrong MachineOperand accessor");
216 bool isKill() const {
217 assert(isRegister() && "Wrong MachineOperand accessor");
220 bool isDead() const {
221 assert(isRegister() && "Wrong MachineOperand accessor");
225 assert(isRegister() && !IsDef && "Wrong MachineOperand accessor");
229 assert(isRegister() && IsDef && "Wrong MachineOperand accessor");
233 assert(isRegister() && !IsDef && "Wrong MachineOperand accessor");
237 assert(isRegister() && IsDef && "Wrong MachineOperand accessor");
241 /// getReg - Returns the register number.
243 unsigned getReg() const {
244 assert(isRegister() && "This is not a register operand!");
245 return contents.RegNo;
248 /// MachineOperand mutators.
250 void setReg(unsigned Reg) {
251 assert(isRegister() && "This is not a register operand!");
252 contents.RegNo = Reg;
255 void setImmedValue(int64_t immVal) {
256 assert(isImmediate() && "Wrong MachineOperand mutator");
257 contents.immedVal = immVal;
259 void setImm(int64_t immVal) {
260 assert(isImmediate() && "Wrong MachineOperand mutator");
261 contents.immedVal = immVal;
264 void setOffset(int Offset) {
265 assert((isGlobalAddress() || isExternalSymbol() || isConstantPoolIndex() ||
266 isJumpTableIndex()) &&
267 "Wrong MachineOperand accessor");
268 auxInfo.offset = Offset;
270 void setConstantPoolIndex(unsigned Idx) {
271 assert(isConstantPoolIndex() && "Wrong MachineOperand accessor");
272 contents.immedVal = Idx;
274 void setJumpTableIndex(unsigned Idx) {
275 assert(isJumpTableIndex() && "Wrong MachineOperand accessor");
276 contents.immedVal = Idx;
279 /// isIdenticalTo - Return true if this operand is identical to the specified
280 /// operand. Note: This method ignores isKill and isDead properties.
281 bool isIdenticalTo(const MachineOperand &Other) const;
283 /// ChangeToImmediate - Replace this operand with a new immediate operand of
284 /// the specified value. If an operand is known to be an immediate already,
285 /// the setImmedValue method should be used.
286 void ChangeToImmediate(int64_t ImmVal) {
287 opType = MO_Immediate;
288 contents.immedVal = ImmVal;
291 /// ChangeToRegister - Replace this operand with a new register operand of
292 /// the specified value. If an operand is known to be an register already,
293 /// the setReg method should be used.
294 void ChangeToRegister(unsigned Reg, bool isDef, bool isImp = false,
295 bool isKill = false, bool isDead = false) {
296 opType = MO_Register;
297 contents.RegNo = Reg;
304 friend std::ostream& operator<<(std::ostream& os, const MachineOperand& mop) {
309 friend class MachineInstr;
313 //===----------------------------------------------------------------------===//
314 /// MachineInstr - Representation of each machine instruction.
317 const TargetInstrDescriptor *TID; // Instruction descriptor.
318 unsigned short NumImplicitOps; // Number of implicit operands (which
319 // are determined at construction time).
321 std::vector<MachineOperand> Operands; // the operands
322 MachineInstr* prev, *next; // links for our intrusive list
323 MachineBasicBlock* parent; // pointer to the owning basic block
325 // OperandComplete - Return true if it's illegal to add a new operand
326 bool OperandsComplete() const;
328 MachineInstr(const MachineInstr&);
329 void operator=(const MachineInstr&); // DO NOT IMPLEMENT
331 // Intrusive list support
333 friend struct ilist_traits<MachineInstr>;
336 /// MachineInstr ctor - This constructor creates a dummy MachineInstr with
337 /// TID NULL and no operands.
340 /// MachineInstr ctor - This constructor create a MachineInstr and add the
341 /// implicit operands. It reserves space for number of operands specified by
342 /// TargetInstrDescriptor.
343 explicit MachineInstr(const TargetInstrDescriptor &TID);
345 /// MachineInstr ctor - Work exactly the same as the ctor above, except that
346 /// the MachineInstr is created and added to the end of the specified basic
349 MachineInstr(MachineBasicBlock *MBB, const TargetInstrDescriptor &TID);
353 const MachineBasicBlock* getParent() const { return parent; }
354 MachineBasicBlock* getParent() { return parent; }
356 /// getInstrDescriptor - Returns the target instruction descriptor of this
358 const TargetInstrDescriptor *getInstrDescriptor() const { return TID; }
360 /// getOpcode - Returns the opcode of this MachineInstr.
362 int getOpcode() const;
364 /// Access to explicit operands of the instruction.
366 unsigned getNumOperands() const { return Operands.size(); }
368 const MachineOperand& getOperand(unsigned i) const {
369 assert(i < getNumOperands() && "getOperand() out of range!");
372 MachineOperand& getOperand(unsigned i) {
373 assert(i < getNumOperands() && "getOperand() out of range!");
377 /// getNumExplicitOperands - Returns the number of non-implicit operands.
379 unsigned getNumExplicitOperands() const;
381 /// isIdenticalTo - Return true if this instruction is identical to (same
382 /// opcode and same operands as) the specified instruction.
383 bool isIdenticalTo(const MachineInstr *Other) const {
384 if (Other->getOpcode() != getOpcode() ||
385 Other->getNumOperands() != getNumOperands())
387 for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
388 if (!getOperand(i).isIdenticalTo(Other->getOperand(i)))
393 /// clone - Create a copy of 'this' instruction that is identical in
394 /// all ways except the the instruction has no parent, prev, or next.
395 MachineInstr* clone() const { return new MachineInstr(*this); }
397 /// removeFromParent - This method unlinks 'this' from the containing basic
398 /// block, and returns it, but does not delete it.
399 MachineInstr *removeFromParent();
401 /// eraseFromParent - This method unlinks 'this' from the containing basic
402 /// block and deletes it.
403 void eraseFromParent() {
404 delete removeFromParent();
407 /// findRegisterUseOperandIdx() - Returns the operand index that is a use of
408 /// the specific register or -1 if it is not found. It further tightening
409 /// the search criteria to a use that kills the register if isKill is true.
410 int findRegisterUseOperandIdx(unsigned Reg, bool isKill = false) const;
412 /// findRegisterDefOperand() - Returns the MachineOperand that is a def of
413 /// the specific register or NULL if it is not found.
414 MachineOperand *findRegisterDefOperand(unsigned Reg);
416 /// findFirstPredOperandIdx() - Find the index of the first operand in the
417 /// operand list that is used to represent the predicate. It returns -1 if
419 int findFirstPredOperandIdx() const;
421 /// copyKillDeadInfo - Copies kill / dead operand properties from MI.
423 void copyKillDeadInfo(const MachineInstr *MI);
425 /// copyPredicates - Copies predicate operand(s) from MI.
426 void copyPredicates(const MachineInstr *MI);
431 void print(std::ostream *OS, const TargetMachine *TM) const {
432 if (OS) print(*OS, TM);
434 void print(std::ostream &OS, const TargetMachine *TM) const;
435 void print(std::ostream &OS) const;
436 void print(std::ostream *OS) const { if (OS) print(*OS); }
438 friend std::ostream& operator<<(std::ostream& os, const MachineInstr& minstr){
443 //===--------------------------------------------------------------------===//
444 // Accessors to add operands when building up machine instructions.
447 /// addRegOperand - Add a register operand.
449 void addRegOperand(unsigned Reg, bool IsDef, bool IsImp = false,
450 bool IsKill = false, bool IsDead = false) {
451 MachineOperand &Op = AddNewOperand(IsImp);
452 Op.opType = MachineOperand::MO_Register;
457 Op.contents.RegNo = Reg;
460 /// addImmOperand - Add a zero extended constant argument to the
461 /// machine instruction.
463 void addImmOperand(int64_t Val) {
464 MachineOperand &Op = AddNewOperand();
465 Op.opType = MachineOperand::MO_Immediate;
466 Op.contents.immedVal = Val;
467 Op.auxInfo.offset = 0;
470 void addMachineBasicBlockOperand(MachineBasicBlock *MBB) {
471 MachineOperand &Op = AddNewOperand();
472 Op.opType = MachineOperand::MO_MachineBasicBlock;
473 Op.contents.MBB = MBB;
474 Op.auxInfo.offset = 0;
477 /// addFrameIndexOperand - Add an abstract frame index to the instruction
479 void addFrameIndexOperand(unsigned Idx) {
480 MachineOperand &Op = AddNewOperand();
481 Op.opType = MachineOperand::MO_FrameIndex;
482 Op.contents.immedVal = Idx;
483 Op.auxInfo.offset = 0;
486 /// addConstantPoolndexOperand - Add a constant pool object index to the
489 void addConstantPoolIndexOperand(unsigned Idx, int Offset) {
490 MachineOperand &Op = AddNewOperand();
491 Op.opType = MachineOperand::MO_ConstantPoolIndex;
492 Op.contents.immedVal = Idx;
493 Op.auxInfo.offset = Offset;
496 /// addJumpTableIndexOperand - Add a jump table object index to the
499 void addJumpTableIndexOperand(unsigned Idx) {
500 MachineOperand &Op = AddNewOperand();
501 Op.opType = MachineOperand::MO_JumpTableIndex;
502 Op.contents.immedVal = Idx;
503 Op.auxInfo.offset = 0;
506 void addGlobalAddressOperand(GlobalValue *GV, int Offset) {
507 MachineOperand &Op = AddNewOperand();
508 Op.opType = MachineOperand::MO_GlobalAddress;
510 Op.auxInfo.offset = Offset;
513 /// addExternalSymbolOperand - Add an external symbol operand to this instr
515 void addExternalSymbolOperand(const char *SymName) {
516 MachineOperand &Op = AddNewOperand();
517 Op.opType = MachineOperand::MO_ExternalSymbol;
518 Op.contents.SymbolName = SymName;
519 Op.auxInfo.offset = 0;
522 //===--------------------------------------------------------------------===//
523 // Accessors used to modify instructions in place.
526 /// setInstrDescriptor - Replace the instruction descriptor (thus opcode) of
527 /// the current instruction with a new one.
529 void setInstrDescriptor(const TargetInstrDescriptor &tid) { TID = &tid; }
531 /// RemoveOperand - Erase an operand from an instruction, leaving it with one
532 /// fewer operand than it started with.
534 void RemoveOperand(unsigned i) {
535 Operands.erase(Operands.begin()+i);
538 MachineOperand &AddNewOperand(bool IsImp = false) {
539 assert((IsImp || !OperandsComplete()) &&
540 "Trying to add an operand to a machine instr that is already done!");
541 if (IsImp || NumImplicitOps == 0) { // This is true most of the time.
542 Operands.push_back(MachineOperand());
543 return Operands.back();
545 return *Operands.insert(Operands.begin()+Operands.size()-NumImplicitOps,
549 /// addImplicitDefUseOperands - Add all implicit def and use operands to
550 /// this instruction.
551 void addImplicitDefUseOperands();
554 //===----------------------------------------------------------------------===//
557 std::ostream& operator<<(std::ostream &OS, const MachineInstr &MI);
558 std::ostream& operator<<(std::ostream &OS, const MachineOperand &MO);
560 } // End llvm namespace