lib/CodeGen/MachineInstr.cpp

   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 //===----------------------------------------------------------------------===//
  13
  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"
  20 #include "llvm/Support/Streams.h"
  21 #include <ostream>
  22 using namespace llvm;
  23
  24 /// MachineInstr ctor - This constructor creates a dummy MachineInstr with
  25 /// TID NULL and no operands.
  26 MachineInstr::MachineInstr()
  27   : TID(0), NumImplicitOps(0), parent(0) {
  28   // Make sure that we get added to a machine basicblock
  29   LeakDetector::addGarbageObject(this);
  30 }
  31
  32 void MachineInstr::addImplicitDefUseOperands() {
  33   if (TID->ImplicitDefs)
  34     for (const unsigned *ImpDefs = TID->ImplicitDefs; *ImpDefs; ++ImpDefs) {
  35       MachineOperand Op;
  36       Op.opType = MachineOperand::MO_Register;
  37       Op.IsDef = true;
  38       Op.IsImp = true;
  39       Op.IsKill = false;
  40       Op.IsDead = false;
  41       Op.contents.RegNo = *ImpDefs;
  42       Op.auxInfo.subReg = 0;
  43       Operands.push_back(Op);
  44     }
  45   if (TID->ImplicitUses)
  46     for (const unsigned *ImpUses = TID->ImplicitUses; *ImpUses; ++ImpUses) {
  47       MachineOperand Op;
  48       Op.opType = MachineOperand::MO_Register;
  49       Op.IsDef = false;
  50       Op.IsImp = true;
  51       Op.IsKill = false;
  52       Op.IsDead = false;
  53       Op.contents.RegNo = *ImpUses;
  54       Op.auxInfo.subReg = 0;
  55       Operands.push_back(Op);
  56     }
  57 }
  58
  59 /// MachineInstr ctor - This constructor create a MachineInstr and add the
  60 /// implicit operands. It reserves space for number of operands specified by
  61 /// TargetInstrDescriptor or the numOperands if it is not zero. (for
  62 /// instructions with variable number of operands).
  63 MachineInstr::MachineInstr(const TargetInstrDescriptor &tid)
  64   : TID(&tid), NumImplicitOps(0), parent(0) {
  65   if (TID->ImplicitDefs)
  66     for (const unsigned *ImpDefs = TID->ImplicitDefs; *ImpDefs; ++ImpDefs)
  67       NumImplicitOps++;
  68   if (TID->ImplicitUses)
  69     for (const unsigned *ImpUses = TID->ImplicitUses; *ImpUses; ++ImpUses)
  70       NumImplicitOps++;
  71   Operands.reserve(NumImplicitOps + TID->numOperands);
  72   addImplicitDefUseOperands();
  73   // Make sure that we get added to a machine basicblock
  74   LeakDetector::addGarbageObject(this);
  75 }
  76
  77 /// MachineInstr ctor - Work exactly the same as the ctor above, except that the
  78 /// MachineInstr is created and added to the end of the specified basic block.
  79 ///
  80 MachineInstr::MachineInstr(MachineBasicBlock *MBB,
  81                            const TargetInstrDescriptor &tid)
  82   : TID(&tid), NumImplicitOps(0), parent(0) {
  83   assert(MBB && "Cannot use inserting ctor with null basic block!");
  84   if (TID->ImplicitDefs)
  85     for (const unsigned *ImpDefs = TID->ImplicitDefs; *ImpDefs; ++ImpDefs)
  86       NumImplicitOps++;
  87   if (TID->ImplicitUses)
  88     for (const unsigned *ImpUses = TID->ImplicitUses; *ImpUses; ++ImpUses)
  89       NumImplicitOps++;
  90   Operands.reserve(NumImplicitOps + TID->numOperands);
  91   addImplicitDefUseOperands();
  92   // Make sure that we get added to a machine basicblock
  93   LeakDetector::addGarbageObject(this);
  94   MBB->push_back(this);  // Add instruction to end of basic block!
  95 }
  96
  97 /// MachineInstr ctor - Copies MachineInstr arg exactly
  98 ///
  99 MachineInstr::MachineInstr(const MachineInstr &MI) {
 100   TID = MI.getInstrDescriptor();
 101   NumImplicitOps = MI.NumImplicitOps;
 102   Operands.reserve(MI.getNumOperands());
 103
 104   // Add operands
 105   for (unsigned i = 0; i != MI.getNumOperands(); ++i)
 106     Operands.push_back(MI.getOperand(i));
 107
 108   // Set parent, next, and prev to null
 109   parent = 0;
 110   prev = 0;
 111   next = 0;
 112 }
 113
 114
 115 MachineInstr::~MachineInstr() {
 116   LeakDetector::removeGarbageObject(this);
 117 }
 118
 119 /// getOpcode - Returns the opcode of this MachineInstr.
 120 ///
 121 const int MachineInstr::getOpcode() const {
 122   return TID->Opcode;
 123 }
 124
 125 /// removeFromParent - This method unlinks 'this' from the containing basic
 126 /// block, and returns it, but does not delete it.
 127 MachineInstr *MachineInstr::removeFromParent() {
 128   assert(getParent() && "Not embedded in a basic block!");
 129   getParent()->remove(this);
 130   return this;
 131 }
 132
 133
 134 /// OperandComplete - Return true if it's illegal to add a new operand
 135 ///
 136 bool MachineInstr::OperandsComplete() const {
 137   unsigned short NumOperands = TID->numOperands;
 138   if ((TID->Flags & M_VARIABLE_OPS) == 0 &&
 139       getNumOperands()-NumImplicitOps >= NumOperands)
 140     return true;  // Broken: we have all the operands of this instruction!
 141   return false;
 142 }
 143
 144 /// getNumExplicitOperands - Returns the number of non-implicit operands.
 145 ///
 146 unsigned MachineInstr::getNumExplicitOperands() const {
 147   unsigned NumOperands = TID->numOperands;
 148   if ((TID->Flags & M_VARIABLE_OPS) == 0)
 149     return NumOperands;
 150
 151   for (unsigned e = getNumOperands(); NumOperands != e; ++NumOperands) {
 152     const MachineOperand &MO = getOperand(NumOperands);
 153     if (!MO.isRegister() || !MO.isImplicit())
 154       NumOperands++;
 155   }
 156   return NumOperands;
 157 }
 158
 159 /// isIdenticalTo - Return true if this operand is identical to the specified
 160 /// operand.
 161 bool MachineOperand::isIdenticalTo(const MachineOperand &Other) const {
 162   if (getType() != Other.getType()) return false;
 163
 164   switch (getType()) {
 165   default: assert(0 && "Unrecognized operand type");
 166   case MachineOperand::MO_Register:
 167     return getReg() == Other.getReg() && isDef() == Other.isDef();
 168   case MachineOperand::MO_Immediate:
 169     return getImm() == Other.getImm();
 170   case MachineOperand::MO_MachineBasicBlock:
 171     return getMBB() == Other.getMBB();
 172   case MachineOperand::MO_FrameIndex:
 173     return getFrameIndex() == Other.getFrameIndex();
 174   case MachineOperand::MO_ConstantPoolIndex:
 175     return getConstantPoolIndex() == Other.getConstantPoolIndex() &&
 176            getOffset() == Other.getOffset();
 177   case MachineOperand::MO_JumpTableIndex:
 178     return getJumpTableIndex() == Other.getJumpTableIndex();
 179   case MachineOperand::MO_GlobalAddress:
 180     return getGlobal() == Other.getGlobal() && getOffset() == Other.getOffset();
 181   case MachineOperand::MO_ExternalSymbol:
 182     return !strcmp(getSymbolName(), Other.getSymbolName()) &&
 183            getOffset() == Other.getOffset();
 184   }
 185 }
 186
 187 bool MachineInstr::isPredicable() const {
 188   return TID->Flags & M_PREDICABLE;
 189 }
 190
 191 /// findRegisterUseOperandIdx() - Returns the MachineOperand that is a use of
 192 /// the specific register or -1 if it is not found. It further tightening
 193 /// the search criteria to a use that kills the register if isKill is true.
 194 int MachineInstr::findRegisterUseOperandIdx(unsigned Reg, bool isKill) {
 195   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
 196     MachineOperand &MO = getOperand(i);
 197     if (MO.isReg() && MO.isUse() && MO.getReg() == Reg)
 198       if (!isKill || MO.isKill())
 199         return i;
 200   }
 201   return -1;
 202 }
 203
 204 /// findRegisterDefOperand() - Returns the MachineOperand that is a def of
 205 /// the specific register or NULL if it is not found.
 206 MachineOperand *MachineInstr::findRegisterDefOperand(unsigned Reg) {
 207   for (unsigned i = 0, e = getNumOperands(); i != e; ++i) {
 208     MachineOperand &MO = getOperand(i);
 209     if (MO.isReg() && MO.isDef() && MO.getReg() == Reg)
 210       return &MO;
 211   }
 212   return NULL;
 213 }
 214
 215 /// findFirstPredOperand() - Find the first operand in the operand list that
 216 // is used to represent the predicate.
 217 MachineOperand *MachineInstr::findFirstPredOperand() {
 218   const TargetInstrDescriptor *TID = getInstrDescriptor();
 219   if (TID->Flags & M_PREDICABLE) {
 220     for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
 221       if ((TID->OpInfo[i].Flags & M_PREDICATE_OPERAND))
 222         return &getOperand(i);
 223   }
 224
 225   return NULL;
 226 }
 227
 228 /// copyKillDeadInfo - Copies kill / dead operand properties from MI.
 229 ///
 230 void MachineInstr::copyKillDeadInfo(const MachineInstr *MI) {
 231   for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 232     const MachineOperand &MO = MI->getOperand(i);
 233     if (!MO.isReg() || (!MO.isKill() && !MO.isDead()))
 234       continue;
 235     for (unsigned j = 0, ee = getNumOperands(); j != ee; ++j) {
 236       MachineOperand &MOp = getOperand(j);
 237       if (!MOp.isIdenticalTo(MO))
 238         continue;
 239       if (MO.isKill())
 240         MOp.setIsKill();
 241       else
 242         MOp.setIsDead();
 243       break;
 244     }
 245   }
 246 }
 247
 248 /// copyPredicates - Copies predicate operand(s) from MI.
 249 void MachineInstr::copyPredicates(const MachineInstr *MI) {
 250   const TargetInstrDescriptor *TID = MI->getInstrDescriptor();
 251   if (TID->Flags & M_PREDICABLE) {
 252     for (unsigned i = 0, e = MI->getNumOperands(); i != e; ++i) {
 253       if ((TID->OpInfo[i].Flags & M_PREDICATE_OPERAND)) {
 254         const MachineOperand &MO = MI->getOperand(i);
 255         // Predicated operands must be last operands.
 256         if (MO.isReg())
 257           addRegOperand(MO.getReg(), false);
 258         else {
 259           addImmOperand(MO.getImm());
 260         }
 261       }
 262     }
 263   }
 264 }
 265
 266 void MachineInstr::dump() const {
 267   cerr << "  " << *this;
 268 }
 269
 270 static inline void OutputReg(std::ostream &os, unsigned RegNo,
 271                              const MRegisterInfo *MRI = 0) {
 272   if (!RegNo || MRegisterInfo::isPhysicalRegister(RegNo)) {
 273     if (MRI)
 274       os << "%" << MRI->get(RegNo).Name;
 275     else
 276       os << "%mreg(" << RegNo << ")";
 277   } else
 278     os << "%reg" << RegNo;
 279 }
 280
 281 static void print(const MachineOperand &MO, std::ostream &OS,
 282                   const TargetMachine *TM) {
 283   const MRegisterInfo *MRI = 0;
 284
 285   if (TM) MRI = TM->getRegisterInfo();
 286
 287   switch (MO.getType()) {
 288   case MachineOperand::MO_Register:
 289     OutputReg(OS, MO.getReg(), MRI);
 290     break;
 291   case MachineOperand::MO_Immediate:
 292     OS << MO.getImmedValue();
 293     break;
 294   case MachineOperand::MO_MachineBasicBlock:
 295     OS << "mbb<"
 296        << ((Value*)MO.getMachineBasicBlock()->getBasicBlock())->getName()
 297        << "," << (void*)MO.getMachineBasicBlock() << ">";
 298     break;
 299   case MachineOperand::MO_FrameIndex:
 300     OS << "<fi#" << MO.getFrameIndex() << ">";
 301     break;
 302   case MachineOperand::MO_ConstantPoolIndex:
 303     OS << "<cp#" << MO.getConstantPoolIndex() << ">";
 304     break;
 305   case MachineOperand::MO_JumpTableIndex:
 306     OS << "<jt#" << MO.getJumpTableIndex() << ">";
 307     break;
 308   case MachineOperand::MO_GlobalAddress:
 309     OS << "<ga:" << ((Value*)MO.getGlobal())->getName();
 310     if (MO.getOffset()) OS << "+" << MO.getOffset();
 311     OS << ">";
 312     break;
 313   case MachineOperand::MO_ExternalSymbol:
 314     OS << "<es:" << MO.getSymbolName();
 315     if (MO.getOffset()) OS << "+" << MO.getOffset();
 316     OS << ">";
 317     break;
 318   default:
 319     assert(0 && "Unrecognized operand type");
 320   }
 321 }
 322
 323 void MachineInstr::print(std::ostream &OS, const TargetMachine *TM) const {
 324   unsigned StartOp = 0;
 325
 326    // Specialize printing if op#0 is definition
 327   if (getNumOperands() && getOperand(0).isReg() && getOperand(0).isDef()) {
 328     ::print(getOperand(0), OS, TM);
 329     if (getOperand(0).isDead())
 330       OS << "<dead>";
 331     OS << " = ";
 332     ++StartOp;   // Don't print this operand again!
 333   }
 334
 335   if (TID)
 336     OS << TID->Name;
 337
 338   for (unsigned i = StartOp, e = getNumOperands(); i != e; ++i) {
 339     const MachineOperand& mop = getOperand(i);
 340     if (i != StartOp)
 341       OS << ",";
 342     OS << " ";
 343     ::print(mop, OS, TM);
 344
 345     if (mop.isReg()) {
 346       if (mop.isDef() || mop.isKill() || mop.isDead() || mop.isImplicit()) {
 347         OS << "<";
 348         bool NeedComma = false;
 349         if (mop.isImplicit()) {
 350           OS << (mop.isDef() ? "imp-def" : "imp-use");
 351           NeedComma = true;
 352         } else if (mop.isDef()) {
 353           OS << "def";
 354           NeedComma = true;
 355         }
 356         if (mop.isKill() || mop.isDead()) {
 357           if (NeedComma)
 358             OS << ",";
 359           if (mop.isKill())
 360             OS << "kill";
 361           if (mop.isDead())
 362             OS << "dead";
 363         }
 364         OS << ">";
 365       }
 366     }
 367   }
 368
 369   OS << "\n";
 370 }
 371
 372 void MachineInstr::print(std::ostream &os) const {
 373   // If the instruction is embedded into a basic block, we can find the target
 374   // info for the instruction.
 375   if (const MachineBasicBlock *MBB = getParent()) {
 376     const MachineFunction *MF = MBB->getParent();
 377     if (MF)
 378       print(os, &MF->getTarget());
 379     else
 380       print(os, 0);
 381   }
 382
 383   // Otherwise, print it out in the "raw" format without symbolic register names
 384   // and such.
 385   os << getInstrDescriptor()->Name;
 386
 387   for (unsigned i = 0, N = getNumOperands(); i < N; i++) {
 388     os << "\t" << getOperand(i);
 389     if (getOperand(i).isReg() && getOperand(i).isDef())
 390       os << "<d>";
 391   }
 392
 393   os << "\n";
 394 }
 395
 396 void MachineOperand::print(std::ostream &OS) const {
 397   switch (getType()) {
 398   case MO_Register:
 399     OutputReg(OS, getReg());
 400     break;
 401   case MO_Immediate:
 402     OS << (long)getImmedValue();
 403     break;
 404   case MO_MachineBasicBlock:
 405     OS << "<mbb:"
 406        << ((Value*)getMachineBasicBlock()->getBasicBlock())->getName()
 407        << "@" << (void*)getMachineBasicBlock() << ">";
 408     break;
 409   case MO_FrameIndex:
 410     OS << "<fi#" << getFrameIndex() << ">";
 411     break;
 412   case MO_ConstantPoolIndex:
 413     OS << "<cp#" << getConstantPoolIndex() << ">";
 414     break;
 415   case MO_JumpTableIndex:
 416     OS << "<jt#" << getJumpTableIndex() << ">";
 417     break;
 418   case MO_GlobalAddress:
 419     OS << "<ga:" << ((Value*)getGlobal())->getName() << ">";
 420     break;
 421   case MO_ExternalSymbol:
 422     OS << "<es:" << getSymbolName() << ">";
 423     break;
 424   default:
 425     assert(0 && "Unrecognized operand type");
 426     break;
 427   }
 428 }
 429