This field no longer exists
[oota-llvm.git] / lib / CodeGen / MachineInstr.cpp
index 6371d8dbc7ee85195f372adefcdd6cae151109e9..973e3ec1e6ee0621e0235484078d9a2a341dae19 100644 (file)
 //===-- MachineInstr.cpp --------------------------------------------------===//
-// 
+//
+//                     The LLVM Compiler Infrastructure
+//
+// This file was developed by the LLVM research group and is distributed under
+// the University of Illinois Open Source License. See LICENSE.TXT for details.
+//
+//===----------------------------------------------------------------------===//
+//
+// Methods common to all machine instructions.
+//
+// FIXME: Now that MachineInstrs have parent pointers, they should always
+// print themselves using their MachineFunction's TargetMachine.
+//
 //===----------------------------------------------------------------------===//
 
 #include "llvm/CodeGen/MachineInstr.h"
+#include "llvm/CodeGen/MachineFunction.h"
 #include "llvm/Value.h"
-#include "llvm/Target/MachineInstrInfo.h"  // FIXME: shouldn't need this!
-using std::cerr;
+#include "llvm/Target/TargetMachine.h"
+#include "llvm/Target/TargetInstrInfo.h"
+#include "llvm/Target/MRegisterInfo.h"
+#include "llvm/Support/LeakDetector.h"
+#include <iostream>
 
+using namespace llvm;
 
-// Constructor for instructions with fixed #operands (nearly all)
-MachineInstr::MachineInstr(MachineOpCode _opCode)
-  : opCode(_opCode),
-    operands(TargetInstrDescriptors[_opCode].numOperands, MachineOperand()) {
-  assert(TargetInstrDescriptors[_opCode].numOperands >= 0);
+// Global variable holding an array of descriptors for machine instructions.
+// The actual object needs to be created separately for each target machine.
+// This variable is initialized and reset by class TargetInstrInfo.
+//
+// FIXME: This should be a property of the target so that more than one target
+// at a time can be active...
+//
+namespace llvm {
+  extern const TargetInstrDescriptor *TargetInstrDescriptors;
 }
 
 // Constructor for instructions with variable #operands
-MachineInstr::MachineInstr(MachineOpCode OpCode, unsigned  numOperands)
-  : opCode(OpCode), operands(numOperands, MachineOperand()) {
+MachineInstr::MachineInstr(short opcode, unsigned numOperands)
+  : Opcode(opcode),
+    operands(numOperands, MachineOperand()),
+    parent(0) {
+  // Make sure that we get added to a machine basicblock
+  LeakDetector::addGarbageObject(this);
 }
 
-MachineInstr::MachineInstr(MachineOpCode Opcode, unsigned numOperands,
-                           bool XX, bool YY) : opCode(Opcode) {
+/// MachineInstr ctor - This constructor only does a _reserve_ of the operands,
+/// not a resize for them.  It is expected that if you use this that you call
+/// add* methods below to fill up the operands, instead of the Set methods.
+/// Eventually, the "resizing" ctors will be phased out.
+///
+MachineInstr::MachineInstr(short opcode, unsigned numOperands, bool XX, bool YY)
+  : Opcode(opcode), parent(0) {
   operands.reserve(numOperands);
+  // Make sure that we get added to a machine basicblock
+  LeakDetector::addGarbageObject(this);
 }
 
-// OperandComplete - Return true if it's illegal to add a new operand
-bool MachineInstr::OperandsComplete() const {
-  int NumOperands = TargetInstrDescriptors[opCode].numOperands;
-  if (NumOperands >= 0 && operands.size() >= (unsigned)NumOperands)
-    return true;  // Broken!
-  return false;
+/// MachineInstr ctor - Work exactly the same as the ctor above, except that the
+/// MachineInstr is created and added to the end of the specified basic block.
+///
+MachineInstr::MachineInstr(MachineBasicBlock *MBB, short opcode,
+                           unsigned numOperands)
+  : Opcode(opcode), parent(0) {
+  assert(MBB && "Cannot use inserting ctor with null basic block!");
+  operands.reserve(numOperands);
+  // Make sure that we get added to a machine basicblock
+  LeakDetector::addGarbageObject(this);
+  MBB->push_back(this);  // Add instruction to end of basic block!
 }
 
+/// MachineInstr ctor - Copies MachineInstr arg exactly
+///
+MachineInstr::MachineInstr(const MachineInstr &MI) {
+  Opcode = MI.getOpcode();
+  operands.reserve(MI.getNumOperands());
 
-// 
-// Support for replacing opcode and operands of a MachineInstr in place.
-// This only resets the size of the operand vector and initializes it.
-// The new operands must be set explicitly later.
-// 
-void MachineInstr::replace(MachineOpCode Opcode, unsigned numOperands) {
-  opCode = Opcode;
-  operands.clear();
-  operands.resize(numOperands, MachineOperand());
+  // Add operands
+  for (unsigned i = 0; i < MI.getNumOperands(); ++i)
+    operands.push_back(MachineOperand(MI.getOperand(i)));
+
+  // Set parent, next, and prev to null
+  parent = 0;
+  prev = 0;
+  next = 0;
 }
 
-void
-MachineInstr::SetMachineOperandVal(unsigned i,
-                                   MachineOperand::MachineOperandType opType,
-                                   Value* V,
-                                   bool isdef,
-                                   bool isDefAndUse)
-{
-  assert(i < operands.size());
-  operands[i].opType = opType;
-  operands[i].value = V;
-  operands[i].regNum = -1;
-  operands[i].flags = 0;
 
-  if (isdef || TargetInstrDescriptors[opCode].resultPos == (int) i)
-    operands[i].markDef();
-  if (isDefAndUse)
-    operands[i].markDefAndUse();
+MachineInstr::~MachineInstr() {
+  LeakDetector::removeGarbageObject(this);
+}
+
+/// clone - Create a copy of 'this' instruction that is identical in all ways
+/// except the following: the new instruction has no parent and it has no name
+///
+MachineInstr* MachineInstr::clone() const {
+  return new MachineInstr(*this);
+}
+
+/// removeFromParent - This method unlinks 'this' from the containing basic
+/// block, and returns it, but does not delete it.
+MachineInstr *MachineInstr::removeFromParent() {
+  assert(getParent() && "Not embedded in a basic block!");
+  getParent()->remove(this);
+  return this;
+}
+
+
+/// OperandComplete - Return true if it's illegal to add a new operand
+///
+bool MachineInstr::OperandsComplete() const {
+  int NumOperands = TargetInstrDescriptors[Opcode].numOperands;
+  if (NumOperands >= 0 && getNumOperands() >= (unsigned)NumOperands)
+    return true;  // Broken: we have all the operands of this instruction!
+  return false;
+}
+
+void MachineInstr::SetMachineOperandVal(unsigned i,
+                                        MachineOperand::MachineOperandType opTy,
+                                        Value* V) {
+  assert(i < operands.size());          // may be explicit or implicit op
+  operands[i].opType = opTy;
+  operands[i].contents.value = V;
+  operands[i].extra.regNum = -1;
 }
 
 void
 MachineInstr::SetMachineOperandConst(unsigned i,
-                               MachineOperand::MachineOperandType operandType,
-                                     int64_t intValue)
-{
-  assert(i < operands.size());
-  assert(TargetInstrDescriptors[opCode].resultPos != (int) i &&
-         "immed. constant cannot be defined");
-
-  operands[i].opType = operandType;
-  operands[i].value = NULL;
-  operands[i].immedVal = intValue;
-  operands[i].regNum = -1;
+                                     MachineOperand::MachineOperandType opTy,
+                                     int intValue) {
+  assert(i < getNumOperands());          // must be explicit op
+
+  operands[i].opType = opTy;
+  operands[i].contents.value = NULL;
+  operands[i].contents.immedVal = intValue;
+  operands[i].extra.regNum = -1;
   operands[i].flags = 0;
 }
 
-void
-MachineInstr::SetMachineOperandReg(unsigned i,
-                                   int regNum,
-                                   bool isdef) {
-  assert(i < operands.size());
+void MachineInstr::SetMachineOperandReg(unsigned i, int regNum) {
+  assert(i < getNumOperands());          // must be explicit op
 
   operands[i].opType = MachineOperand::MO_MachineRegister;
-  operands[i].value = NULL;
-  operands[i].regNum = regNum;
-  operands[i].flags = 0;
+  operands[i].contents.value = NULL;
+  operands[i].extra.regNum = regNum;
+}
 
-  if (isdef || TargetInstrDescriptors[opCode].resultPos == (int) i)
-    operands[i].markDef();
-  insertUsedReg(regNum);
+void MachineInstr::dump() const {
+  std::cerr << "  " << *this;
 }
 
-void
-MachineInstr::SetRegForOperand(unsigned i, int regNum)
-{
-  operands[i].setRegForValue(regNum);
-  insertUsedReg(regNum);
+static inline std::ostream& OutputValue(std::ostream &os, const Value* val) {
+  os << "(val ";
+  os << (void*) val;                // print address always
+  if (val && val->hasName())
+    os << " " << val->getName();    // print name also, if available
+  os << ")";
+  return os;
 }
 
+static inline void OutputReg(std::ostream &os, unsigned RegNo,
+                             const MRegisterInfo *MRI = 0) {
+  if (!RegNo || MRegisterInfo::isPhysicalRegister(RegNo)) {
+    if (MRI)
+      os << "%" << MRI->get(RegNo).Name;
+    else
+      os << "%mreg(" << RegNo << ")";
+  } else
+    os << "%reg" << RegNo;
+}
 
-// Subsitute all occurrences of Value* oldVal with newVal in all operands
-// and all implicit refs.  If defsOnly == true, substitute defs only.
-unsigned
-MachineInstr::substituteValue(const Value* oldVal, Value* newVal, bool defsOnly)
-{
-  unsigned numSubst = 0;
+static void print(const MachineOperand &MO, std::ostream &OS,
+                  const TargetMachine *TM) {
+  const MRegisterInfo *MRI = 0;
 
-  // Subsitute operands
-  for (MachineInstr::val_op_iterator O = begin(), E = end(); O != E; ++O)
-    if (*O == oldVal)
-      if (!defsOnly || O.isDef())
-        {
-          O.getMachineOperand().value = newVal;
-          ++numSubst;
-        }
+  if (TM) MRI = TM->getRegisterInfo();
 
-  // Subsitute implicit refs
-  for (unsigned i=0, N=implicitRefs.size(); i < N; ++i)
-    if (getImplicitRef(i) == oldVal)
-      if (!defsOnly || implicitRefIsDefined(i))
-        {
-          implicitRefs[i].Val = newVal;
-          ++numSubst;
-        }
+  bool CloseParen = true;
+  if (MO.isHiBits32())
+    OS << "%lm(";
+  else if (MO.isLoBits32())
+    OS << "%lo(";
+  else if (MO.isHiBits64())
+    OS << "%hh(";
+  else if (MO.isLoBits64())
+    OS << "%hm(";
+  else
+    CloseParen = false;
 
-  return numSubst;
+  switch (MO.getType()) {
+  case MachineOperand::MO_VirtualRegister:
+    if (MO.getVRegValue()) {
+      OS << "%reg";
+      OutputValue(OS, MO.getVRegValue());
+      if (MO.hasAllocatedReg())
+        OS << "==";
+    }
+    if (MO.hasAllocatedReg())
+      OutputReg(OS, MO.getReg(), MRI);
+    break;
+  case MachineOperand::MO_CCRegister:
+    OS << "%ccreg";
+    OutputValue(OS, MO.getVRegValue());
+    if (MO.hasAllocatedReg()) {
+      OS << "==";
+      OutputReg(OS, MO.getReg(), MRI);
+    }
+    break;
+  case MachineOperand::MO_MachineRegister:
+    OutputReg(OS, MO.getMachineRegNum(), MRI);
+    break;
+  case MachineOperand::MO_SignExtendedImmed:
+    OS << (long)MO.getImmedValue();
+    break;
+  case MachineOperand::MO_UnextendedImmed:
+    OS << (long)MO.getImmedValue();
+    break;
+  case MachineOperand::MO_PCRelativeDisp: {
+    const Value* opVal = MO.getVRegValue();
+    bool isLabel = isa<Function>(opVal) || isa<BasicBlock>(opVal);
+    OS << "%disp(" << (isLabel? "label " : "addr-of-val ");
+    if (opVal->hasName())
+      OS << opVal->getName();
+    else
+      OS << (const void*) opVal;
+    OS << ")";
+    break;
+  }
+  case MachineOperand::MO_MachineBasicBlock:
+    OS << "mbb<"
+       << ((Value*)MO.getMachineBasicBlock()->getBasicBlock())->getName()
+       << "," << (void*)MO.getMachineBasicBlock() << ">";
+    break;
+  case MachineOperand::MO_FrameIndex:
+    OS << "<fi#" << MO.getFrameIndex() << ">";
+    break;
+  case MachineOperand::MO_ConstantPoolIndex:
+    OS << "<cp#" << MO.getConstantPoolIndex() << ">";
+    break;
+  case MachineOperand::MO_GlobalAddress:
+    OS << "<ga:" << ((Value*)MO.getGlobal())->getName();
+    if (MO.getOffset()) OS << "+" << MO.getOffset();
+    OS << ">";
+    break;
+  case MachineOperand::MO_ExternalSymbol:
+    OS << "<es:" << MO.getSymbolName();
+    if (MO.getOffset()) OS << "+" << MO.getOffset();
+    OS << ">";
+    break;
+  default:
+    assert(0 && "Unrecognized operand type");
+  }
+
+  if (CloseParen)
+    OS << ")";
 }
 
+void MachineInstr::print(std::ostream &OS, const TargetMachine *TM) const {
+  unsigned StartOp = 0;
 
-void
-MachineInstr::dump() const 
-{
-  cerr << "  " << *this;
-}
+   // Specialize printing if op#0 is definition
+  if (getNumOperands() && getOperand(0).isDef() && !getOperand(0).isUse()) {
+    ::print(getOperand(0), OS, TM);
+    OS << " = ";
+    ++StartOp;   // Don't print this operand again!
+  }
 
-static inline std::ostream&
-OutputValue(std::ostream &os, const Value* val)
-{
-  os << "(val ";
-  if (val && val->hasName())
-    return os << val->getName() << ")";
-  else
-    return os << (void*) val << ")";              // print address only
-}
+  // Must check if Target machine is not null because machine BB could not
+  // be attached to a Machine function yet
+  if (TM)
+    OS << TM->getInstrInfo()->getName(getOpcode());
+
+  for (unsigned i = StartOp, e = getNumOperands(); i != e; ++i) {
+    const MachineOperand& mop = getOperand(i);
+    if (i != StartOp)
+      OS << ",";
+    OS << " ";
+    ::print(mop, OS, TM);
+
+    if (mop.isDef())
+      if (mop.isUse())
+        OS << "<def&use>";
+      else
+        OS << "<def>";
+  }
 
-static inline std::ostream&
-OutputReg(std::ostream &os, unsigned int regNum)
-{
-  return os << "%mreg(" << regNum << ")";
+  OS << "\n";
 }
 
-std::ostream &operator<<(std::ostream& os, const MachineInstr& minstr)
-{
-  os << TargetInstrDescriptors[minstr.opCode].Name;
-  
-  for (unsigned i=0, N=minstr.getNumOperands(); i < N; i++) {
-    os << "\t" << minstr.getOperand(i);
-    if( minstr.operandIsDefined(i) ) 
-      os << "*";
-    if( minstr.operandIsDefinedAndUsed(i) ) 
-      os << "*";
+namespace llvm {
+std::ostream &operator<<(std::ostream &os, const MachineInstr &MI) {
+  // If the instruction is embedded into a basic block, we can find the target
+  // info for the instruction.
+  if (const MachineBasicBlock *MBB = MI.getParent()) {
+    const MachineFunction *MF = MBB->getParent();
+    if (MF)
+      MI.print(os, &MF->getTarget());
+    else
+      MI.print(os, 0);
+    return os;
   }
-  
-  // code for printing implict references
-  unsigned NumOfImpRefs =  minstr.getNumImplicitRefs();
-  if(  NumOfImpRefs > 0 ) {
-    os << "\tImplicit: ";
-    for(unsigned z=0; z < NumOfImpRefs; z++) {
-      OutputValue(os, minstr.getImplicitRef(z)); 
-      if( minstr.implicitRefIsDefined(z)) os << "*";
-      if( minstr.implicitRefIsDefinedAndUsed(z)) os << "*";
-      os << "\t";
-    }
+
+  // Otherwise, print it out in the "raw" format without symbolic register names
+  // and such.
+  os << TargetInstrDescriptors[MI.getOpcode()].Name;
+
+  for (unsigned i = 0, N = MI.getNumOperands(); i < N; i++) {
+    os << "\t" << MI.getOperand(i);
+    if (MI.getOperand(i).isDef())
+      if (MI.getOperand(i).isUse())
+        os << "<d&u>";
+      else
+        os << "<d>";
   }
-  
+
   return os << "\n";
 }
 
-std::ostream &operator<<(std::ostream &os, const MachineOperand &mop)
-{
-  if (mop.opHiBits32())
-    os << "%lm(";
-  else if (mop.opLoBits32())
-    os << "%lo(";
-  else if (mop.opHiBits64())
-    os << "%hh(";
-  else if (mop.opLoBits64())
-    os << "%hm(";
-  
-  switch(mop.opType)
-    {
-    case MachineOperand::MO_VirtualRegister:
-      os << "%reg";
-      OutputValue(os, mop.getVRegValue());
-      if (mop.hasAllocatedReg())
-        os << "==" << OutputReg(os, mop.getAllocatedRegNum());
-      break;
-    case MachineOperand::MO_CCRegister:
-      os << "%ccreg";
-      OutputValue(os, mop.getVRegValue());
-      if (mop.hasAllocatedReg())
-        os << "==" << OutputReg(os, mop.getAllocatedRegNum());
-      break;
-    case MachineOperand::MO_MachineRegister:
-      OutputReg(os, mop.getMachineRegNum());
-      break;
-    case MachineOperand::MO_SignExtendedImmed:
-      os << (long)mop.immedVal;
-      break;
-    case MachineOperand::MO_UnextendedImmed:
-      os << (long)mop.immedVal;
-      break;
-    case MachineOperand::MO_PCRelativeDisp:
-      {
-        const Value* opVal = mop.getVRegValue();
-        bool isLabel = isa<Function>(opVal) || isa<BasicBlock>(opVal);
-        os << "%disp(" << (isLabel? "label " : "addr-of-val ");
-        if (opVal->hasName())
-          os << opVal->getName();
-        else
-          os << (const void*) opVal;
-        os << ")";
-        break;
-      }
-    default:
-      assert(0 && "Unrecognized operand type");
-      break;
+std::ostream &operator<<(std::ostream &OS, const MachineOperand &MO) {
+  if (MO.isHiBits32())
+    OS << "%lm(";
+  else if (MO.isLoBits32())
+    OS << "%lo(";
+  else if (MO.isHiBits64())
+    OS << "%hh(";
+  else if (MO.isLoBits64())
+    OS << "%hm(";
+
+  switch (MO.getType()) {
+  case MachineOperand::MO_VirtualRegister:
+    if (MO.hasAllocatedReg())
+      OutputReg(OS, MO.getReg());
+
+    if (MO.getVRegValue()) {
+      if (MO.hasAllocatedReg()) OS << "==";
+      OS << "%vreg";
+      OutputValue(OS, MO.getVRegValue());
     }
-  
-  if (mop.flags &
-      (MachineOperand::HIFLAG32 | MachineOperand::LOFLAG32 | 
-       MachineOperand::HIFLAG64 | MachineOperand::LOFLAG64))
-    os << ")";
-  
-  return os;
+    break;
+  case MachineOperand::MO_CCRegister:
+    OS << "%ccreg";
+    OutputValue(OS, MO.getVRegValue());
+    if (MO.hasAllocatedReg()) {
+      OS << "==";
+      OutputReg(OS, MO.getReg());
+    }
+    break;
+  case MachineOperand::MO_MachineRegister:
+    OutputReg(OS, MO.getMachineRegNum());
+    break;
+  case MachineOperand::MO_SignExtendedImmed:
+    OS << (long)MO.getImmedValue();
+    break;
+  case MachineOperand::MO_UnextendedImmed:
+    OS << (long)MO.getImmedValue();
+    break;
+  case MachineOperand::MO_PCRelativeDisp: {
+    const Value* opVal = MO.getVRegValue();
+    bool isLabel = isa<Function>(opVal) || isa<BasicBlock>(opVal);
+    OS << "%disp(" << (isLabel? "label " : "addr-of-val ");
+    if (opVal->hasName())
+      OS << opVal->getName();
+    else
+      OS << (const void*) opVal;
+    OS << ")";
+    break;
+  }
+  case MachineOperand::MO_MachineBasicBlock:
+    OS << "<mbb:"
+       << ((Value*)MO.getMachineBasicBlock()->getBasicBlock())->getName()
+       << "@" << (void*)MO.getMachineBasicBlock() << ">";
+    break;
+  case MachineOperand::MO_FrameIndex:
+    OS << "<fi#" << MO.getFrameIndex() << ">";
+    break;
+  case MachineOperand::MO_ConstantPoolIndex:
+    OS << "<cp#" << MO.getConstantPoolIndex() << ">";
+    break;
+  case MachineOperand::MO_GlobalAddress:
+    OS << "<ga:" << ((Value*)MO.getGlobal())->getName() << ">";
+    break;
+  case MachineOperand::MO_ExternalSymbol:
+    OS << "<es:" << MO.getSymbolName() << ">";
+    break;
+  default:
+    assert(0 && "Unrecognized operand type");
+    break;
+  }
+
+  if (MO.isHiBits32() || MO.isLoBits32() || MO.isHiBits64() || MO.isLoBits64())
+    OS << ")";
+
+  return OS;
+}
+
 }