1 //===-- MachineInstr.cpp --------------------------------------------------===// 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 // Methods common to all machine instructions. 11 // 12 // FIXME: Now that MachineInstrs have parent pointers, they should always 13 // print themselves using their MachineFunction's TargetMachine. 14 // 15 //===----------------------------------------------------------------------===// 16 17 #include "llvm/CodeGen/MachineInstr.h" 18 #include "llvm/CodeGen/MachineFunction.h" 19 #include "llvm/Value.h" 20 #include "llvm/Target/TargetMachine.h" 21 #include "llvm/Target/TargetInstrInfo.h" 22 #include "llvm/Target/MRegisterInfo.h" 23 #include "llvm/Support/LeakDetector.h" 24 #include <iostream> 25 26 using namespace llvm; 27 28 // Global variable holding an array of descriptors for machine instructions. 29 // The actual object needs to be created separately for each target machine. 30 // This variable is initialized and reset by class TargetInstrInfo. 31 // 32 // FIXME: This should be a property of the target so that more than one target 33 // at a time can be active... 34 // 35 namespace llvm { 36 extern const TargetInstrDescriptor *TargetInstrDescriptors; 37 } 38 39 /// MachineInstr ctor - This constructor only does a _reserve_ of the operands, 40 /// not a resize for them. It is expected that if you use this that you call 41 /// add* methods below to fill up the operands, instead of the Set methods. 42 /// Eventually, the "resizing" ctors will be phased out. 43 /// 44 MachineInstr::MachineInstr(short opcode, unsigned numOperands, bool XX, bool YY) 45 : Opcode(opcode), parent(0) { 46 operands.reserve(numOperands); 47 // Make sure that we get added to a machine basicblock 48 LeakDetector::addGarbageObject(this); 49 } 50 51 /// MachineInstr ctor - Work exactly the same as the ctor above, except that the 52 /// MachineInstr is created and added to the end of the specified basic block. 53 /// 54 MachineInstr::MachineInstr(MachineBasicBlock *MBB, short opcode, 55 unsigned numOperands) 56 : Opcode(opcode), parent(0) { 57 assert(MBB && "Cannot use inserting ctor with null basic block!"); 58 operands.reserve(numOperands); 59 // Make sure that we get added to a machine basicblock 60 LeakDetector::addGarbageObject(this); 61 MBB->push_back(this); // Add instruction to end of basic block! 62 } 63 64 /// MachineInstr ctor - Copies MachineInstr arg exactly 65 /// 66 MachineInstr::MachineInstr(const MachineInstr &MI) { 67 Opcode = MI.getOpcode(); 68 operands.reserve(MI.getNumOperands()); 69 70 // Add operands 71 for (unsigned i = 0; i < MI.getNumOperands(); ++i) 72 operands.push_back(MachineOperand(MI.getOperand(i))); 73 74 // Set parent, next, and prev to null 75 parent = 0; 76 prev = 0; 77 next = 0; 78 } 79 80 81 MachineInstr::~MachineInstr() { 82 LeakDetector::removeGarbageObject(this); 83 } 84 85 /// clone - Create a copy of 'this' instruction that is identical in all ways 86 /// except the following: the new instruction has no parent and it has no name 87 /// 88 MachineInstr* MachineInstr::clone() const { 89 return new MachineInstr(*this); 90 } 91 92 /// removeFromParent - This method unlinks 'this' from the containing basic 93 /// block, and returns it, but does not delete it. 94 MachineInstr *MachineInstr::removeFromParent() { 95 assert(getParent() && "Not embedded in a basic block!"); 96 getParent()->remove(this); 97 return this; 98 } 99 100 101 /// OperandComplete - Return true if it's illegal to add a new operand 102 /// 103 bool MachineInstr::OperandsComplete() const { 104 int NumOperands = TargetInstrDescriptors[Opcode].numOperands; 105 if (NumOperands >= 0 && getNumOperands() >= (unsigned)NumOperands) 106 return true; // Broken: we have all the operands of this instruction! 107 return false; 108 } 109 110 void 111 MachineInstr::SetMachineOperandConst(unsigned i, 112 MachineOperand::MachineOperandType opTy, 113 int intValue) { 114 assert(i < getNumOperands()); 115 operands[i].opType = opTy; 116 operands[i].contents.immedVal = intValue; 117 operands[i].extra.regNum = -1; 118 operands[i].flags = 0; 119 } 120 121 void MachineInstr::SetMachineOperandReg(unsigned i, int regNum) { 122 assert(i < getNumOperands()); 123 124 operands[i].opType = MachineOperand::MO_VirtualRegister; 125 operands[i].contents.GV = NULL; 126 operands[i].extra.regNum = regNum; 127 } 128 129 void MachineInstr::dump() const { 130 std::cerr << " " << *this; 131 } 132 133 static inline std::ostream& OutputValue(std::ostream &os, const Value* val) { 134 os << "(val "; 135 os << (void*) val; // print address always 136 if (val && val->hasName()) 137 os << " " << val->getName(); // print name also, if available 138 os << ")"; 139 return os; 140 } 141 142 static inline void OutputReg(std::ostream &os, unsigned RegNo, 143 const MRegisterInfo *MRI = 0) { 144 if (!RegNo || MRegisterInfo::isPhysicalRegister(RegNo)) { 145 if (MRI) 146 os << "%" << MRI->get(RegNo).Name; 147 else 148 os << "%mreg(" << RegNo << ")"; 149 } else 150 os << "%reg" << RegNo; 151 } 152 153 static void print(const MachineOperand &MO, std::ostream &OS, 154 const TargetMachine *TM) { 155 const MRegisterInfo *MRI = 0; 156 157 if (TM) MRI = TM->getRegisterInfo(); 158 159 switch (MO.getType()) { 160 case MachineOperand::MO_VirtualRegister: 161 OutputReg(OS, MO.getReg(), MRI); 162 break; 163 case MachineOperand::MO_Immediate: 164 OS << (long)MO.getImmedValue(); 165 break; 166 case MachineOperand::MO_MachineBasicBlock: 167 OS << "mbb<" 168 << ((Value*)MO.getMachineBasicBlock()->getBasicBlock())->getName() 169 << "," << (void*)MO.getMachineBasicBlock() << ">"; 170 break; 171 case MachineOperand::MO_FrameIndex: 172 OS << "<fi#" << MO.getFrameIndex() << ">"; 173 break; 174 case MachineOperand::MO_ConstantPoolIndex: 175 OS << "<cp#" << MO.getConstantPoolIndex() << ">"; 176 break; 177 case MachineOperand::MO_JumpTableIndex: 178 OS << "<jt#" << MO.getJumpTableIndex() << ">"; 179 break; 180 case MachineOperand::MO_GlobalAddress: 181 OS << "<ga:" << ((Value*)MO.getGlobal())->getName(); 182 if (MO.getOffset()) OS << "+" << MO.getOffset(); 183 OS << ">"; 184 break; 185 case MachineOperand::MO_ExternalSymbol: 186 OS << "<es:" << MO.getSymbolName(); 187 if (MO.getOffset()) OS << "+" << MO.getOffset(); 188 OS << ">"; 189 break; 190 default: 191 assert(0 && "Unrecognized operand type"); 192 } 193 } 194 195 void MachineInstr::print(std::ostream &OS, const TargetMachine *TM) const { 196 unsigned StartOp = 0; 197 198 // Specialize printing if op#0 is definition 199 if (getNumOperands() && getOperand(0).isDef() && !getOperand(0).isUse()) { 200 ::print(getOperand(0), OS, TM); 201 OS << " = "; 202 ++StartOp; // Don't print this operand again! 203 } 204 205 // Must check if Target machine is not null because machine BB could not 206 // be attached to a Machine function yet 207 if (TM) 208 OS << TM->getInstrInfo()->getName(getOpcode()); 209 210 for (unsigned i = StartOp, e = getNumOperands(); i != e; ++i) { 211 const MachineOperand& mop = getOperand(i); 212 if (i != StartOp) 213 OS << ","; 214 OS << " "; 215 ::print(mop, OS, TM); 216 217 if (mop.isDef()) 218 if (mop.isUse()) 219 OS << "<def&use>"; 220 else 221 OS << "<def>"; 222 } 223 224 OS << "\n"; 225 } 226 227 std::ostream &llvm::operator<<(std::ostream &os, const MachineInstr &MI) { 228 // If the instruction is embedded into a basic block, we can find the target 229 // info for the instruction. 230 if (const MachineBasicBlock *MBB = MI.getParent()) { 231 const MachineFunction *MF = MBB->getParent(); 232 if (MF) 233 MI.print(os, &MF->getTarget()); 234 else 235 MI.print(os, 0); 236 return os; 237 } 238 239 // Otherwise, print it out in the "raw" format without symbolic register names 240 // and such. 241 os << TargetInstrDescriptors[MI.getOpcode()].Name; 242 243 for (unsigned i = 0, N = MI.getNumOperands(); i < N; i++) { 244 os << "\t" << MI.getOperand(i); 245 if (MI.getOperand(i).isDef()) 246 if (MI.getOperand(i).isUse()) 247 os << "<d&u>"; 248 else 249 os << "<d>"; 250 } 251 252 return os << "\n"; 253 } 254 255 std::ostream &llvm::operator<<(std::ostream &OS, const MachineOperand &MO) { 256 switch (MO.getType()) { 257 case MachineOperand::MO_VirtualRegister: 258 OutputReg(OS, MO.getReg()); 259 break; 260 case MachineOperand::MO_Immediate: 261 OS << (long)MO.getImmedValue(); 262 break; 263 case MachineOperand::MO_MachineBasicBlock: 264 OS << "<mbb:" 265 << ((Value*)MO.getMachineBasicBlock()->getBasicBlock())->getName() 266 << "@" << (void*)MO.getMachineBasicBlock() << ">"; 267 break; 268 case MachineOperand::MO_FrameIndex: 269 OS << "<fi#" << MO.getFrameIndex() << ">"; 270 break; 271 case MachineOperand::MO_ConstantPoolIndex: 272 OS << "<cp#" << MO.getConstantPoolIndex() << ">"; 273 break; 274 case MachineOperand::MO_JumpTableIndex: 275 OS << "<jt#" << MO.getJumpTableIndex() << ">"; 276 break; 277 case MachineOperand::MO_GlobalAddress: 278 OS << "<ga:" << ((Value*)MO.getGlobal())->getName() << ">"; 279 break; 280 case MachineOperand::MO_ExternalSymbol: 281 OS << "<es:" << MO.getSymbolName() << ">"; 282 break; 283 default: 284 assert(0 && "Unrecognized operand type"); 285 break; 286 } 287 288 return OS; 289 } 290