Fix CodeGen/Alpha/2006-07-03-ASMFormalLowering.ll and PR818.
[oota-llvm.git] / lib / CodeGen / MachineInstr.cpp
index 4e1865dff1946d94d428452299a163717769c25d..480364a282196790a5b39779dd987db707b37489 100644 (file)
-// $Id$
-//***************************************************************************
-// File:
-//     MachineInstr.cpp
-// 
-// Purpose:
-//     
-// 
-// Strategy:
-// 
-// History:
-//     7/2/01   -  Vikram Adve  -  Created
-//**************************************************************************/
-
+//===-- 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.
+//
+//===----------------------------------------------------------------------===//
 
 #include "llvm/CodeGen/MachineInstr.h"
-#include "llvm/Target/MachineFrameInfo.h"
-#include "llvm/Target/MachineRegInfo.h"
-#include "llvm/Method.h"
-#include "llvm/iOther.h"
-#include "llvm/Instruction.h"
-
-AnnotationID MachineCodeForMethod::AID(
-                 AnnotationManager::getID("MachineCodeForMethodAnnotation"));
-
-
-//************************ Class Implementations **************************/
-
-// Constructor for instructions with fixed #operands (nearly all)
-MachineInstr::MachineInstr(MachineOpCode _opCode,
-                          OpCodeMask    _opCodeMask)
-  : opCode(_opCode),
-    opCodeMask(_opCodeMask),
-    operands(TargetInstrDescriptors[_opCode].numOperands)
-{
-  assert(TargetInstrDescriptors[_opCode].numOperands >= 0);
-}
-
-// Constructor for instructions with variable #operands
-MachineInstr::MachineInstr(MachineOpCode _opCode,
-                          unsigned      numOperands,
-                          OpCodeMask    _opCodeMask)
-  : opCode(_opCode),
-    opCodeMask(_opCodeMask),
-    operands(numOperands)
-{
-}
-
-void
-MachineInstr::SetMachineOperand(unsigned int i,
-                               MachineOperand::MachineOperandType operandType,
-                               Value* _val, bool isdef=false)
-{
-  assert(i < operands.size());
-  operands[i].Initialize(operandType, _val);
-  operands[i].isDef = isdef ||
-    TargetInstrDescriptors[opCode].resultPos == (int) i;
-}
-
-void
-MachineInstr::SetMachineOperand(unsigned int i,
-                               MachineOperand::MachineOperandType operandType,
-                               int64_t intValue, bool isdef=false)
-{
-  assert(i < operands.size());
-  operands[i].InitializeConst(operandType, intValue);
-  operands[i].isDef = isdef ||
-    TargetInstrDescriptors[opCode].resultPos == (int) i;
-}
+#include "llvm/CodeGen/MachineFunction.h"
+#include "llvm/Target/TargetMachine.h"
+#include "llvm/Target/TargetInstrInfo.h"
+#include "llvm/Target/MRegisterInfo.h"
+#include "llvm/Support/LeakDetector.h"
+#include <iostream>
 
-void
-MachineInstr::SetMachineOperand(unsigned int i,
-                               int regNum, bool isdef=false)
-{
-  assert(i < operands.size());
-  operands[i].InitializeReg(regNum);
-  operands[i].isDef = isdef ||
-    TargetInstrDescriptors[opCode].resultPos == (int) i;
-}
-
-void
-MachineInstr::dump(unsigned int indent) const 
-{
-  for (unsigned i=0; i < indent; i++)
-    cout << "    ";
-  
-  cout << *this;
+using namespace llvm;
+
+// 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;
+}
+
+/// 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)
+  : Opcode(opcode), parent(0) {
+  Operands.reserve(numOperands);
+  // Make sure that we get added to a machine basicblock
+  LeakDetector::addGarbageObject(this);
+}
+
+/// 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());
+
+  // Add operands
+  for (unsigned i = 0; i != MI.getNumOperands(); ++i)
+    Operands.push_back(MI.getOperand(i));
+
+  // Set parent, next, and prev to null
+  parent = 0;
+  prev = 0;
+  next = 0;
+}
+
+
+MachineInstr::~MachineInstr() {
+  LeakDetector::removeGarbageObject(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 ((TargetInstrDescriptors[Opcode].Flags & M_VARIABLE_OPS) == 0 &&
+      getNumOperands() >= (unsigned)NumOperands)
+    return true;  // Broken: we have all the operands of this instruction!
+  return false;
+}
+
+void MachineInstr::dump() const {
+  std::cerr << "  " << *this;
+}
+
+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;
+}
+
+static void print(const MachineOperand &MO, std::ostream &OS,
+                  const TargetMachine *TM) {
+  const MRegisterInfo *MRI = 0;
+
+  if (TM) MRI = TM->getRegisterInfo();
+
+  switch (MO.getType()) {
+  case MachineOperand::MO_Register:
+    OutputReg(OS, MO.getReg(), MRI);
+    break;
+  case MachineOperand::MO_Immediate:
+    OS << MO.getImmedValue();
+    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_JumpTableIndex:
+    OS << "<jt#" << MO.getJumpTableIndex() << ">";
+    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");
+  }
 }
 
-ostream&
-operator<< (ostream& os, const MachineInstr& minstr)
-{
-  os << TargetInstrDescriptors[minstr.opCode].opCodeString;
-  
-  for (unsigned i=0, N=minstr.getNumOperands(); i < N; i++)
-    os << "\t" << minstr.getOperand(i);
-  
-#undef DEBUG_VAL_OP_ITERATOR
-#ifdef DEBUG_VAL_OP_ITERATOR
-  os << endl << "\tValue operands are: ";
-  for (MachineInstr::val_op_const_iterator vo(&minstr); ! vo.done(); ++vo)
-    {
-      const Value* val = *vo;
-      os << val << (vo.isDef()? "(def), " : ", ");
-    }
-#endif
-  
+void MachineInstr::print(std::ostream &OS, const TargetMachine *TM) const {
+  unsigned StartOp = 0;
 
-#if 1
-  // code for printing implict references
-
-  unsigned NumOfImpRefs =  minstr.getNumImplicitRefs();
-  if(  NumOfImpRefs > 0 ) {
-       
-    os << "\tImplicit:";
-
-    for(unsigned z=0; z < NumOfImpRefs; z++) {
-      os << minstr.getImplicitRef(z);
-         cout << "\t";
-    }
+   // 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!
   }
 
-#endif
-
-
-  os << endl;
-  
-  return os;
-}
-
-static inline ostream&
-OutputOperand(ostream &os, const MachineOperand &mop)
-{
-  Value* val;
-  switch (mop.getOperandType())
-    {
-    case MachineOperand::MO_CCRegister:
-    case MachineOperand::MO_VirtualRegister:
-      val = mop.getVRegValue();
-      os << "(val ";
-      if (val && val->hasName())
-        os << val->getName().c_str();
+  // 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 << val;
-      return os << ")";
-    case MachineOperand::MO_MachineRegister:
-      return os << "("     << mop.getMachineRegNum() << ")";
-    default:
-      assert(0 && "Unknown operand type");
-      return os;
-    }
-}
-
-
-ostream&
-operator<<(ostream &os, const MachineOperand &mop)
-{
-  switch(mop.opType)
-    {
-    case MachineOperand::MO_VirtualRegister:
-    case MachineOperand::MO_MachineRegister:
-      os << "%reg";
-      return OutputOperand(os, mop);
-    case MachineOperand::MO_CCRegister:
-      os << "%ccreg";
-      return OutputOperand(os, mop);
-    case MachineOperand::MO_SignExtendedImmed:
-      return os << mop.immedVal;
-    case MachineOperand::MO_UnextendedImmed:
-      return os << mop.immedVal;
-    case MachineOperand::MO_PCRelativeDisp:
-      {
-        const Value* opVal = mop.getVRegValue();
-        bool isLabel = isa<Method>(opVal) || isa<BasicBlock>(opVal);
-        os << "%disp(" << (isLabel? "label " : "addr-of-val ");
-        if (opVal->hasName())
-          os << opVal->getName().c_str();
-        else
-          os << opVal;
-        return os << ")";
-      }
-    default:
-      assert(0 && "Unrecognized operand type");
-      break;
-    }
-  
-  return os;
-}
-
-static unsigned int
-ComputeMaxOptionalArgsSize(const TargetMachine& target, const Method* method)
-{
-  const MachineFrameInfo& frameInfo = target.getFrameInfo();
-  
-  unsigned int maxSize = 0;
-  
-  for (Method::inst_const_iterator I=method->inst_begin(),E=method->inst_end();
-       I != E; ++I)
-    if ((*I)->getOpcode() == Instruction::Call)
-      {
-        CallInst* callInst = cast<CallInst>(*I);
-        unsigned int numOperands = callInst->getNumOperands() - 1;
-        int numExtra = (int) numOperands - frameInfo.getNumFixedOutgoingArgs();
-        if (numExtra <= 0)
-          continue;
-        
-        unsigned int sizeForThisCall;
-        if (frameInfo.argsOnStackHaveFixedSize())
-          {
-            int argSize = frameInfo.getSizeOfEachArgOnStack(); 
-            sizeForThisCall = numExtra * (unsigned) argSize;
-          }
-        else
-          {
-            assert(0 && "UNTESTED CODE: Size per stack argument is not fixed on this architecture: use actual arg sizes to compute MaxOptionalArgsSize");
-            sizeForThisCall = 0;
-            for (unsigned i=0; i < numOperands; ++i)
-              sizeForThisCall += target.findOptimalStorageSize(callInst->
-                                                    getOperand(i)->getType());
-          }
-        
-        if (maxSize < sizeForThisCall)
-          maxSize = sizeForThisCall;
-      }
-  
-  return maxSize;
-}
-
-
-/*ctor*/
-MachineCodeForMethod::MachineCodeForMethod(const Method* _M,
-                                           const TargetMachine& target)
-  : Annotation(AID),
-    method(_M), compiledAsLeaf(false), staticStackSize(0),
-    automaticVarsSize(0), regSpillsSize(0),
-    currentOptionalArgsSize(0), maxOptionalArgsSize(0),
-    currentTmpValuesSize(0)
-{
-  maxOptionalArgsSize = ComputeMaxOptionalArgsSize(target, method);
-  staticStackSize = maxOptionalArgsSize +
-                    target.getFrameInfo().getMinStackFrameSize();
-}
-
-int
-MachineCodeForMethod::allocateLocalVar(const TargetMachine& target,
-                                       const Value* val)
-{
-  // Check if we've allocated a stack slot for this value already
-  // 
-  int offset = getOffset(val);
-  if (offset == INVALID_FRAME_OFFSET)
-    {
-      unsigned int  size  = target.findOptimalStorageSize(val->getType());
-      unsigned char align = target.DataLayout.getTypeAlignment(val->getType());
-      
-      offset = getAutomaticVarsSize();
-      if (unsigned int mod = offset % align)
-        {
-          offset += align - mod;
-          size   += align - mod;
-        }
-      
-      bool growUp;
-      int firstOffset =target.getFrameInfo().getFirstAutomaticVarOffset(*this,
-                                                                       growUp);
-      offset = growUp? firstOffset + offset
-                     : firstOffset - offset - size;
-      
-      offsets[val] = offset;
-      
-      incrementAutomaticVarsSize(size);
-    }
-  return offset;
-}
-
-int
-MachineCodeForMethod::allocateSpilledValue(const TargetMachine& target,
-                                           const Type* type)
-{
-  unsigned int size  = target.findOptimalStorageSize(type);
-  unsigned char align = target.DataLayout.getTypeAlignment(type);
-  
-  int offset = getRegSpillsSize();
-  if (unsigned int mod = offset % align)
-    {
-      offset += align - mod;
-      size   += align - mod;
-    }
-  
-  bool growUp;
-  int firstOffset = target.getFrameInfo().getRegSpillAreaOffset(*this, growUp);
-  offset = growUp? firstOffset + offset
-                 : firstOffset - offset - size;
-  
-  incrementRegSpillsSize(size);
-  
-  return offset;
-}
-  
-int
-MachineCodeForMethod::allocateOptionalArg(const TargetMachine& target,
-                                          const Type* type)
-{
-  const MachineFrameInfo& frameInfo = target.getFrameInfo();
-
-  int size = MAXINT;
-  if (frameInfo.argsOnStackHaveFixedSize())
-    size = frameInfo.getSizeOfEachArgOnStack(); 
-  else
-    {
-      size = target.findOptimalStorageSize(type);
-      assert(0 && "UNTESTED CODE: Size per stack argument is not fixed on this architecture: use actual argument sizes for computing optional arg offsets");
-    }
-  unsigned char align = target.DataLayout.getTypeAlignment(type);
-  
-  int offset = getCurrentOptionalArgsSize();
-  if (unsigned int mod = offset % align)
-    {
-      offset += align - mod;
-      size   += align - mod;
-    }
-  
-  bool growUp;
-  int firstOffset = frameInfo.getFirstOptionalOutgoingArgOffset(*this, growUp);
-  offset = growUp? firstOffset + offset
-                 : firstOffset - offset - size;
-  
-  incrementCurrentOptionalArgsSize(size);
-  
-  return offset;
-}
-
-void
-MachineCodeForMethod::resetOptionalArgs(const TargetMachine& target)
-{
-  currentOptionalArgsSize = 0;
-}
-
-int
-MachineCodeForMethod::pushTempValue(const TargetMachine& target,
-                                    unsigned int size)
-{
-  // Compute a power-of-2 alignment according to the possible sizes,
-  // but not greater than the alignment of the largest type we support
-  // (currently a double word -- see class TargetData).
-  unsigned char align = 1;
-  for (; align < size && align < target.DataLayout.getDoubleAlignment();
-         align = 2*align)
-    ;
-  
-  int offset = currentTmpValuesSize;
-  if (unsigned int mod = offset % align)
-    {
-      offset += align - mod;
-      size   += align - mod;
-    }
-  
-  bool growUp;
-  int firstTmpOffset = target.getFrameInfo().getTmpAreaOffset(*this, growUp);
-  offset = growUp? firstTmpOffset + offset
-                 : firstTmpOffset - offset - size;
-  
-  currentTmpValuesSize += size;
-  return offset;
-}
+        OS << "<def>";
+  }
 
-void
-MachineCodeForMethod::popAllTempValues(const TargetMachine& target)
-{
-  currentTmpValuesSize = 0;
+  OS << "\n";
 }
 
+std::ostream &llvm::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;
+  }
 
-// void
-// MachineCodeForMethod::putLocalVarAtOffsetFromSP(const Value* local,
-//                                                 int offset,
-//                                                 unsigned int size)
-// {
-//   offsetsFromSP[local] = offset;
-//   incrementAutomaticVarsSize(size);
-// }
-// 
-
-int
-MachineCodeForMethod::getOffset(const Value* val) const
-{
-  hash_map<const Value*, int>::const_iterator pair = offsets.find(val);
-  return (pair == offsets.end())? INVALID_FRAME_OFFSET : (*pair).second;
-}
-
+  // Otherwise, print it out in the "raw" format without symbolic register names
+  // and such.
+  os << TargetInstrDescriptors[MI.getOpcode()].Name;
 
-// int
-// MachineCodeForMethod::getOffsetFromSP(const Value* local) const
-// {
-//   hash_map<const Value*, int>::const_iterator pair = offsetsFromSP.find(local);
-//   return (pair == offsetsFromSP.end())? INVALID_FRAME_OFFSET : (*pair).second;
-// }
+  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 &llvm::operator<<(std::ostream &OS, const MachineOperand &MO) {
+  switch (MO.getType()) {
+  case MachineOperand::MO_Register:
+    OutputReg(OS, MO.getReg());
+    break;
+  case MachineOperand::MO_Immediate:
+    OS << (long)MO.getImmedValue();
+    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_JumpTableIndex:
+    OS << "<jt#" << MO.getJumpTableIndex() << ">";
+    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;
+  }
 
-void
-MachineCodeForMethod::dump() const
-{
-  cout << "\n" << method->getReturnType()
-       << " \"" << method->getName() << "\"" << endl;
-  
-  for (Method::const_iterator BI = method->begin(); BI != method->end(); ++BI)
-    {
-      BasicBlock* bb = *BI;
-      cout << "\n"
-          << (bb->hasName()? bb->getName() : "Label")
-          << " (" << bb << ")" << ":"
-          << endl;
-      
-      MachineCodeForBasicBlock& mvec = bb->getMachineInstrVec();
-      for (unsigned i=0; i < mvec.size(); i++)
-       cout << "\t" << *mvec[i];
-    } 
-  cout << endl << "End method \"" << method->getName() << "\""
-       << endl << endl;
+  return OS;
 }