1 //===-- MachineInstr.cpp --------------------------------------------------===//
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 // Methods common to all machine instructions.
12 //===----------------------------------------------------------------------===//
14 #include "llvm/CodeGen/MachineInstr.h"
15 #include "llvm/CodeGen/MachineFunction.h"
16 #include "llvm/Target/TargetMachine.h"
17 #include "llvm/Target/TargetInstrInfo.h"
18 #include "llvm/Target/MRegisterInfo.h"
19 #include "llvm/Support/LeakDetector.h"
24 // Global variable holding an array of descriptors for machine instructions.
25 // The actual object needs to be created separately for each target machine.
26 // This variable is initialized and reset by class TargetInstrInfo.
28 // FIXME: This should be a property of the target so that more than one target
29 // at a time can be active...
32 extern const TargetInstrDescriptor *TargetInstrDescriptors;
35 /// MachineInstr ctor - This constructor only does a _reserve_ of the operands,
36 /// not a resize for them. It is expected that if you use this that you call
37 /// add* methods below to fill up the operands, instead of the Set methods.
38 /// Eventually, the "resizing" ctors will be phased out.
40 MachineInstr::MachineInstr(short opcode, unsigned numOperands)
41 : Opcode(opcode), parent(0) {
42 Operands.reserve(numOperands);
43 // Make sure that we get added to a machine basicblock
44 LeakDetector::addGarbageObject(this);
47 /// MachineInstr ctor - Work exactly the same as the ctor above, except that the
48 /// MachineInstr is created and added to the end of the specified basic block.
50 MachineInstr::MachineInstr(MachineBasicBlock *MBB, short opcode,
52 : Opcode(opcode), parent(0) {
53 assert(MBB && "Cannot use inserting ctor with null basic block!");
54 Operands.reserve(numOperands);
55 // Make sure that we get added to a machine basicblock
56 LeakDetector::addGarbageObject(this);
57 MBB->push_back(this); // Add instruction to end of basic block!
60 /// MachineInstr ctor - Copies MachineInstr arg exactly
62 MachineInstr::MachineInstr(const MachineInstr &MI) {
63 Opcode = MI.getOpcode();
64 Operands.reserve(MI.getNumOperands());
67 for (unsigned i = 0; i != MI.getNumOperands(); ++i)
68 Operands.push_back(MI.getOperand(i));
70 // Set parent, next, and prev to null
77 MachineInstr::~MachineInstr() {
78 LeakDetector::removeGarbageObject(this);
81 /// removeFromParent - This method unlinks 'this' from the containing basic
82 /// block, and returns it, but does not delete it.
83 MachineInstr *MachineInstr::removeFromParent() {
84 assert(getParent() && "Not embedded in a basic block!");
85 getParent()->remove(this);
90 /// OperandComplete - Return true if it's illegal to add a new operand
92 bool MachineInstr::OperandsComplete() const {
93 int NumOperands = TargetInstrDescriptors[Opcode].numOperands;
94 if ((TargetInstrDescriptors[Opcode].Flags & M_VARIABLE_OPS) == 0 &&
95 getNumOperands() >= (unsigned)NumOperands)
96 return true; // Broken: we have all the operands of this instruction!
100 /// isIdenticalTo - Return true if this operand is identical to the specified
102 bool MachineOperand::isIdenticalTo(const MachineOperand &Other) const {
103 if (getType() != Other.getType()) return false;
106 default: assert(0 && "Unrecognized operand type");
107 case MachineOperand::MO_Register:
108 return getReg() == Other.getReg() && isDef() == Other.isDef();
109 case MachineOperand::MO_Immediate:
110 return getImm() == Other.getImm();
111 case MachineOperand::MO_MachineBasicBlock:
112 return getMBB() == Other.getMBB();
113 case MachineOperand::MO_FrameIndex:
114 return getFrameIndex() == Other.getFrameIndex();
115 case MachineOperand::MO_ConstantPoolIndex:
116 return getConstantPoolIndex() == Other.getConstantPoolIndex() &&
117 getOffset() == Other.getOffset();
118 case MachineOperand::MO_JumpTableIndex:
119 return getJumpTableIndex() == Other.getJumpTableIndex();
120 case MachineOperand::MO_GlobalAddress:
121 return getGlobal() == Other.getGlobal() && getOffset() == Other.getOffset();
122 case MachineOperand::MO_ExternalSymbol:
123 return getSymbolName() == Other.getSymbolName() &&
124 getOffset() == Other.getOffset();
129 void MachineInstr::dump() const {
130 std::cerr << " " << *this;
133 static inline void OutputReg(std::ostream &os, unsigned RegNo,
134 const MRegisterInfo *MRI = 0) {
135 if (!RegNo || MRegisterInfo::isPhysicalRegister(RegNo)) {
137 os << "%" << MRI->get(RegNo).Name;
139 os << "%mreg(" << RegNo << ")";
141 os << "%reg" << RegNo;
144 static void print(const MachineOperand &MO, std::ostream &OS,
145 const TargetMachine *TM) {
146 const MRegisterInfo *MRI = 0;
148 if (TM) MRI = TM->getRegisterInfo();
150 switch (MO.getType()) {
151 case MachineOperand::MO_Register:
152 OutputReg(OS, MO.getReg(), MRI);
154 case MachineOperand::MO_Immediate:
155 OS << MO.getImmedValue();
157 case MachineOperand::MO_MachineBasicBlock:
159 << ((Value*)MO.getMachineBasicBlock()->getBasicBlock())->getName()
160 << "," << (void*)MO.getMachineBasicBlock() << ">";
162 case MachineOperand::MO_FrameIndex:
163 OS << "<fi#" << MO.getFrameIndex() << ">";
165 case MachineOperand::MO_ConstantPoolIndex:
166 OS << "<cp#" << MO.getConstantPoolIndex() << ">";
168 case MachineOperand::MO_JumpTableIndex:
169 OS << "<jt#" << MO.getJumpTableIndex() << ">";
171 case MachineOperand::MO_GlobalAddress:
172 OS << "<ga:" << ((Value*)MO.getGlobal())->getName();
173 if (MO.getOffset()) OS << "+" << MO.getOffset();
176 case MachineOperand::MO_ExternalSymbol:
177 OS << "<es:" << MO.getSymbolName();
178 if (MO.getOffset()) OS << "+" << MO.getOffset();
182 assert(0 && "Unrecognized operand type");
186 void MachineInstr::print(std::ostream &OS, const TargetMachine *TM) const {
187 unsigned StartOp = 0;
189 // Specialize printing if op#0 is definition
190 if (getNumOperands() && getOperand(0).isReg() && getOperand(0).isDef()) {
191 ::print(getOperand(0), OS, TM);
193 ++StartOp; // Don't print this operand again!
196 // Must check if Target machine is not null because machine BB could not
197 // be attached to a Machine function yet
199 OS << TM->getInstrInfo()->getName(getOpcode());
201 for (unsigned i = StartOp, e = getNumOperands(); i != e; ++i) {
202 const MachineOperand& mop = getOperand(i);
206 ::print(mop, OS, TM);
208 if (mop.isReg() && mop.isDef())
215 std::ostream &llvm::operator<<(std::ostream &os, const MachineInstr &MI) {
216 // If the instruction is embedded into a basic block, we can find the target
217 // info for the instruction.
218 if (const MachineBasicBlock *MBB = MI.getParent()) {
219 const MachineFunction *MF = MBB->getParent();
221 MI.print(os, &MF->getTarget());
227 // Otherwise, print it out in the "raw" format without symbolic register names
229 os << TargetInstrDescriptors[MI.getOpcode()].Name;
231 for (unsigned i = 0, N = MI.getNumOperands(); i < N; i++) {
232 os << "\t" << MI.getOperand(i);
233 if (MI.getOperand(i).isReg() && MI.getOperand(i).isDef())
240 std::ostream &llvm::operator<<(std::ostream &OS, const MachineOperand &MO) {
241 switch (MO.getType()) {
242 case MachineOperand::MO_Register:
243 OutputReg(OS, MO.getReg());
245 case MachineOperand::MO_Immediate:
246 OS << (long)MO.getImmedValue();
248 case MachineOperand::MO_MachineBasicBlock:
250 << ((Value*)MO.getMachineBasicBlock()->getBasicBlock())->getName()
251 << "@" << (void*)MO.getMachineBasicBlock() << ">";
253 case MachineOperand::MO_FrameIndex:
254 OS << "<fi#" << MO.getFrameIndex() << ">";
256 case MachineOperand::MO_ConstantPoolIndex:
257 OS << "<cp#" << MO.getConstantPoolIndex() << ">";
259 case MachineOperand::MO_JumpTableIndex:
260 OS << "<jt#" << MO.getJumpTableIndex() << ">";
262 case MachineOperand::MO_GlobalAddress:
263 OS << "<ga:" << ((Value*)MO.getGlobal())->getName() << ">";
265 case MachineOperand::MO_ExternalSymbol:
266 OS << "<es:" << MO.getSymbolName() << ">";
269 assert(0 && "Unrecognized operand type");