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 // Constructor for instructions with variable #operands 40 MachineInstr::MachineInstr(short opcode, unsigned numOperands) 41 : Opcode(opcode), 42 operands(numOperands, MachineOperand()), 43 parent(0) { 44 // Make sure that we get added to a machine basicblock 45 LeakDetector::addGarbageObject(this); 46 } 47 48 /// MachineInstr ctor - This constructor only does a _reserve_ of the operands, 49 /// not a resize for them. It is expected that if you use this that you call 50 /// add* methods below to fill up the operands, instead of the Set methods. 51 /// Eventually, the "resizing" ctors will be phased out. 52 /// 53 MachineInstr::MachineInstr(short opcode, unsigned numOperands, bool XX, bool YY) 54 : Opcode(opcode), parent(0) { 55 operands.reserve(numOperands); 56 // Make sure that we get added to a machine basicblock 57 LeakDetector::addGarbageObject(this); 58 } 59 60 /// MachineInstr ctor - Work exactly the same as the ctor above, except that the 61 /// MachineInstr is created and added to the end of the specified basic block. 62 /// 63 MachineInstr::MachineInstr(MachineBasicBlock *MBB, short opcode, 64 unsigned numOperands) 65 : Opcode(opcode), parent(0) { 66 assert(MBB && "Cannot use inserting ctor with null basic block!"); 67 operands.reserve(numOperands); 68 // Make sure that we get added to a machine basicblock 69 LeakDetector::addGarbageObject(this); 70 MBB->push_back(this); // Add instruction to end of basic block! 71 } 72 73 /// MachineInstr ctor - Copies MachineInstr arg exactly 74 /// 75 MachineInstr::MachineInstr(const MachineInstr &MI) { 76 Opcode = MI.getOpcode(); 77 operands.reserve(MI.getNumOperands()); 78 79 // Add operands 80 for (unsigned i = 0; i < MI.getNumOperands(); ++i) 81 operands.push_back(MachineOperand(MI.getOperand(i))); 82 83 // Set parent, next, and prev to null 84 parent = 0; 85 prev = 0; 86 next = 0; 87 } 88 89 90 MachineInstr::~MachineInstr() { 91 LeakDetector::removeGarbageObject(this); 92 } 93 94 /// clone - Create a copy of 'this' instruction that is identical in all ways 95 /// except the following: the new instruction has no parent and it has no name 96 /// 97 MachineInstr* MachineInstr::clone() const { 98 return new MachineInstr(*this); 99 } 100 101 /// removeFromParent - This method unlinks 'this' from the containing basic 102 /// block, and returns it, but does not delete it. 103 MachineInstr *MachineInstr::removeFromParent() { 104 assert(getParent() && "Not embedded in a basic block!"); 105 getParent()->remove(this); 106 return this; 107 } 108 109 110 /// OperandComplete - Return true if it's illegal to add a new operand 111 /// 112 bool MachineInstr::OperandsComplete() const { 113 int NumOperands = TargetInstrDescriptors[Opcode].numOperands; 114 if (NumOperands >= 0 && getNumOperands() >= (unsigned)NumOperands) 115 return true; // Broken: we have all the operands of this instruction! 116 return false; 117 } 118 119 void MachineInstr::SetMachineOperandVal(unsigned i, 120 MachineOperand::MachineOperandType opTy, 121 Value* V) { 122 assert(i < operands.size()); // may be explicit or implicit op 123 operands[i].opType = opTy; 124 operands[i].contents.value = V; 125 operands[i].extra.regNum = -1; 126 } 127 128 void 129 MachineInstr::SetMachineOperandConst(unsigned i, 130 MachineOperand::MachineOperandType opTy, 131 int intValue) { 132 assert(i < getNumOperands()); // must be explicit op 133 134 operands[i].opType = opTy; 135 operands[i].contents.value = NULL; 136 operands[i].contents.immedVal = intValue; 137 operands[i].extra.regNum = -1; 138 operands[i].flags = 0; 139 } 140 141 void MachineInstr::SetMachineOperandReg(unsigned i, int regNum) { 142 assert(i < getNumOperands()); // must be explicit op 143 144 operands[i].opType = MachineOperand::MO_MachineRegister; 145 operands[i].contents.value = NULL; 146 operands[i].extra.regNum = regNum; 147 } 148 149 void MachineInstr::dump() const { 150 std::cerr << " " << *this; 151 } 152 153 static inline std::ostream& OutputValue(std::ostream &os, const Value* val) { 154 os << "(val "; 155 os << (void*) val; // print address always 156 if (val && val->hasName()) 157 os << " " << val->getName(); // print name also, if available 158 os << ")"; 159 return os; 160 } 161 162 static inline void OutputReg(std::ostream &os, unsigned RegNo, 163 const MRegisterInfo *MRI = 0) { 164 if (!RegNo || MRegisterInfo::isPhysicalRegister(RegNo)) { 165 if (MRI) 166 os << "%" << MRI->get(RegNo).Name; 167 else 168 os << "%mreg(" << RegNo << ")"; 169 } else 170 os << "%reg" << RegNo; 171 } 172 173 static void print(const MachineOperand &MO, std::ostream &OS, 174 const TargetMachine *TM) { 175 const MRegisterInfo *MRI = 0; 176 177 if (TM) MRI = TM->getRegisterInfo(); 178 179 switch (MO.getType()) { 180 case MachineOperand::MO_VirtualRegister: 181 if (MO.getVRegValue()) { 182 OS << "%reg"; 183 OutputValue(OS, MO.getVRegValue()); 184 if (MO.hasAllocatedReg()) 185 OS << "=="; 186 } 187 if (MO.hasAllocatedReg()) 188 OutputReg(OS, MO.getReg(), MRI); 189 break; 190 case MachineOperand::MO_MachineRegister: 191 OutputReg(OS, MO.getMachineRegNum(), MRI); 192 break; 193 case MachineOperand::MO_SignExtendedImmed: 194 OS << (long)MO.getImmedValue(); 195 break; 196 case MachineOperand::MO_UnextendedImmed: 197 OS << (long)MO.getImmedValue(); 198 break; 199 case MachineOperand::MO_MachineBasicBlock: 200 OS << "mbb<" 201 << ((Value*)MO.getMachineBasicBlock()->getBasicBlock())->getName() 202 << "," << (void*)MO.getMachineBasicBlock() << ">"; 203 break; 204 case MachineOperand::MO_FrameIndex: 205 OS << "<fi#" << MO.getFrameIndex() << ">"; 206 break; 207 case MachineOperand::MO_ConstantPoolIndex: 208 OS << "<cp#" << MO.getConstantPoolIndex() << ">"; 209 break; 210 case MachineOperand::MO_JumpTableIndex: 211 OS << "<jt#" << MO.getJumpTableIndex() << ">"; 212 break; 213 case MachineOperand::MO_GlobalAddress: 214 OS << "<ga:" << ((Value*)MO.getGlobal())->getName(); 215 if (MO.getOffset()) OS << "+" << MO.getOffset(); 216 OS << ">"; 217 break; 218 case MachineOperand::MO_ExternalSymbol: 219 OS << "<es:" << MO.getSymbolName(); 220 if (MO.getOffset()) OS << "+" << MO.getOffset(); 221 OS << ">"; 222 break; 223 default: 224 assert(0 && "Unrecognized operand type"); 225 } 226 } 227 228 void MachineInstr::print(std::ostream &OS, const TargetMachine *TM) const { 229 unsigned StartOp = 0; 230 231 // Specialize printing if op#0 is definition 232 if (getNumOperands() && getOperand(0).isDef() && !getOperand(0).isUse()) { 233 ::print(getOperand(0), OS, TM); 234 OS << " = "; 235 ++StartOp; // Don't print this operand again! 236 } 237 238 // Must check if Target machine is not null because machine BB could not 239 // be attached to a Machine function yet 240 if (TM) 241 OS << TM->getInstrInfo()->getName(getOpcode()); 242 243 for (unsigned i = StartOp, e = getNumOperands(); i != e; ++i) { 244 const MachineOperand& mop = getOperand(i); 245 if (i != StartOp) 246 OS << ","; 247 OS << " "; 248 ::print(mop, OS, TM); 249 250 if (mop.isDef()) 251 if (mop.isUse()) 252 OS << "<def&use>"; 253 else 254 OS << "<def>"; 255 } 256 257 OS << "\n"; 258 } 259 260 std::ostream &llvm::operator<<(std::ostream &os, const MachineInstr &MI) { 261 // If the instruction is embedded into a basic block, we can find the target 262 // info for the instruction. 263 if (const MachineBasicBlock *MBB = MI.getParent()) { 264 const MachineFunction *MF = MBB->getParent(); 265 if (MF) 266 MI.print(os, &MF->getTarget()); 267 else 268 MI.print(os, 0); 269 return os; 270 } 271 272 // Otherwise, print it out in the "raw" format without symbolic register names 273 // and such. 274 os << TargetInstrDescriptors[MI.getOpcode()].Name; 275 276 for (unsigned i = 0, N = MI.getNumOperands(); i < N; i++) { 277 os << "\t" << MI.getOperand(i); 278 if (MI.getOperand(i).isDef()) 279 if (MI.getOperand(i).isUse()) 280 os << "<d&u>"; 281 else 282 os << "<d>"; 283 } 284 285 return os << "\n"; 286 } 287 288 std::ostream &llvm::operator<<(std::ostream &OS, const MachineOperand &MO) { 289 switch (MO.getType()) { 290 case MachineOperand::MO_VirtualRegister: 291 if (MO.hasAllocatedReg()) 292 OutputReg(OS, MO.getReg()); 293 294 if (MO.getVRegValue()) { 295 if (MO.hasAllocatedReg()) OS << "=="; 296 OS << "%vreg"; 297 OutputValue(OS, MO.getVRegValue()); 298 } 299 break; 300 case MachineOperand::MO_MachineRegister: 301 OutputReg(OS, MO.getMachineRegNum()); 302 break; 303 case MachineOperand::MO_SignExtendedImmed: 304 OS << (long)MO.getImmedValue(); 305 break; 306 case MachineOperand::MO_UnextendedImmed: 307 OS << (long)MO.getImmedValue(); 308 break; 309 case MachineOperand::MO_MachineBasicBlock: 310 OS << "<mbb:" 311 << ((Value*)MO.getMachineBasicBlock()->getBasicBlock())->getName() 312 << "@" << (void*)MO.getMachineBasicBlock() << ">"; 313 break; 314 case MachineOperand::MO_FrameIndex: 315 OS << "<fi#" << MO.getFrameIndex() << ">"; 316 break; 317 case MachineOperand::MO_ConstantPoolIndex: 318 OS << "<cp#" << MO.getConstantPoolIndex() << ">"; 319 break; 320 case MachineOperand::MO_JumpTableIndex: 321 OS << "<jt#" << MO.getJumpTableIndex() << ">"; 322 break; 323 case MachineOperand::MO_GlobalAddress: 324 OS << "<ga:" << ((Value*)MO.getGlobal())->getName() << ">"; 325 break; 326 case MachineOperand::MO_ExternalSymbol: 327 OS << "<es:" << MO.getSymbolName() << ">"; 328 break; 329 default: 330 assert(0 && "Unrecognized operand type"); 331 break; 332 } 333 334 return OS; 335 } 336