- Rename AnalysisUsage::preservesAll to getPreservesAll & preservesCFG to
[oota-llvm.git] / lib / CodeGen / MachineInstr.cpp
index 1db2d48fc9e9ec8295fdf24ad430806e9183c642..02c25fdd7fbc08382d029ddacbed5b7d41ad933b 100644 (file)
@@ -1,26 +1,11 @@
-// $Id$
-//***************************************************************************
-// File:
-//     MachineInstr.cpp
+//===-- MachineInstr.cpp --------------------------------------------------===//
 // 
-// Purpose:
-//     
-// 
-// Strategy:
-// 
-// History:
-//     7/2/01   -  Vikram Adve  -  Created
-//**************************************************************************/
-
+//===----------------------------------------------------------------------===//
 
 #include "llvm/CodeGen/MachineInstr.h"
-#include "llvm/Target/MachineRegInfo.h"
-#include "llvm/Method.h"
-#include "llvm/ConstPoolVals.h"
-#include "llvm/Instruction.h"
-
+#include "llvm/Value.h"
+using std::cerr;
 
-//************************ Class Implementations **************************/
 
 // Constructor for instructions with fixed #operands (nearly all)
 MachineInstr::MachineInstr(MachineOpCode _opCode,
@@ -42,345 +27,205 @@ MachineInstr::MachineInstr(MachineOpCode _opCode,
 {
 }
 
+// 
+// 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::SetMachineOperand(unsigned int i,
-                               MachineOperand::MachineOperandType operandType,
-                               Value* _val, bool isdef=false)
+MachineInstr::replace(MachineOpCode _opCode,
+                      unsigned     numOperands,
+                      OpCodeMask    _opCodeMask)
+{
+  opCode = _opCode;
+  opCodeMask = _opCodeMask;
+  operands.clear();
+  operands.resize(numOperands);
+}
+
+void
+MachineInstr::SetMachineOperandVal(unsigned int i,
+                                   MachineOperand::MachineOperandType opType,
+                                   Value* _val,
+                                   bool isdef,
+                                   bool isDefAndUse)
 {
   assert(i < operands.size());
-  operands[i].Initialize(operandType, _val);
-  operands[i].isDef = isdef ||
-    TargetInstrDescriptors[opCode].resultPos == (int) i;
+  operands[i].Initialize(opType, _val);
+  if (isdef || TargetInstrDescriptors[opCode].resultPos == (int) i)
+    operands[i].markDef();
+  if (isDefAndUse)
+    operands[i].markDefAndUse();
 }
 
 void
-MachineInstr::SetMachineOperand(unsigned int i,
+MachineInstr::SetMachineOperandConst(unsigned int i,
                                MachineOperand::MachineOperandType operandType,
-                               int64_t intValue, bool isdef=false)
+                                     int64_t intValue)
 {
   assert(i < operands.size());
+  assert(TargetInstrDescriptors[opCode].resultPos != (int) i &&
+         "immed. constant cannot be defined");
   operands[i].InitializeConst(operandType, intValue);
-  operands[i].isDef = isdef ||
-    TargetInstrDescriptors[opCode].resultPos == (int) i;
 }
 
 void
-MachineInstr::SetMachineOperand(unsigned int i,
-                               unsigned int regNum, bool isdef=false)
+MachineInstr::SetMachineOperandReg(unsigned int i,
+                                   int regNum,
+                                   bool isdef,
+                                   bool isDefAndUse,
+                                   bool isCCReg)
 {
   assert(i < operands.size());
-  operands[i].InitializeReg(regNum);
-  operands[i].isDef = isdef ||
-    TargetInstrDescriptors[opCode].resultPos == (int) i;
+  operands[i].InitializeReg(regNum, isCCReg);
+  if (isdef || TargetInstrDescriptors[opCode].resultPos == (int) i)
+    operands[i].markDef();
+  if (isDefAndUse)
+    operands[i].markDefAndUse();
+  regsUsed.insert(regNum);
 }
 
 void
-MachineInstr::dump(unsigned int indent) const 
+MachineInstr::SetRegForOperand(unsigned i, int regNum)
 {
-  for (unsigned i=0; i < indent; i++)
-    cout << "    ";
-  
-  cout << *this;
+  operands[i].setRegForValue(regNum);
+  regsUsed.insert(regNum);
 }
 
-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), " : ", ");
-    }
-  os << endl;
-#endif
-  
-  return os;
-}
 
-static inline ostream&
-OutputOperand(ostream &os, const MachineOperand &mop)
-{
-  switch (mop.getOperandType())
-    {
-    case MachineOperand::MO_CCRegister:
-    case MachineOperand::MO_VirtualRegister:
-      return os << "(val " << mop.getVRegValue() << ")";
-    case MachineOperand::MO_MachineRegister:
-      return os << "("     << mop.getMachineRegNum() << ")";
-    default:
-      assert(0 && "Unknown operand type");
-      return os;
-    }
-}
-
-
-ostream&
-operator<<(ostream &os, const MachineOperand &mop)
+// 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)
 {
-  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:
-      return os << "%disp(label " << mop.getVRegValue() << ")";
-    default:
-      assert(0 && "Unrecognized operand type");
-      break;
-    }
-  
-  return os;
+  unsigned numSubst = 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;
+        }
+
+  // Subsitute implicit refs
+  for (unsigned i=0, N=implicitRefs.size(); i < N; ++i)
+    if (implicitRefs[i] == oldVal)
+      if (!defsOnly || implicitRefIsDefined(i))
+        {
+          implicitRefs[i] = newVal;
+          ++numSubst;
+        }
+
+  return numSubst;
 }
 
 
-//---------------------------------------------------------------------------
-// Target-independent utility routines for creating machine instructions
-//---------------------------------------------------------------------------
-
-
-//------------------------------------------------------------------------ 
-// Function Set2OperandsFromInstr
-// Function Set3OperandsFromInstr
-// 
-// For the common case of 2- and 3-operand arithmetic/logical instructions,
-// set the m/c instr. operands directly from the VM instruction's operands.
-// Check whether the first or second operand is 0 and can use a dedicated "0"
-// register.
-// Check whether the second operand should use an immediate field or register.
-// (First and third operands are never immediates for such instructions.)
-// 
-// Arguments:
-// canDiscardResult: Specifies that the result operand can be discarded
-//                  by using the dedicated "0"
-// 
-// op1position, op2position and resultPosition: Specify in which position
-//                  in the machine instruction the 3 operands (arg1, arg2
-//                  and result) should go.
-// 
-// RETURN VALUE: unsigned int flags, where
-//     flags & 0x01    => operand 1 is constant and needs a register
-//     flags & 0x02    => operand 2 is constant and needs a register
-//------------------------------------------------------------------------ 
-
 void
-Set2OperandsFromInstr(MachineInstr* minstr,
-                     InstructionNode* vmInstrNode,
-                     const TargetMachine& target,
-                     bool canDiscardResult,
-                     int op1Position,
-                     int resultPosition)
+MachineInstr::dump() const 
 {
-  Set3OperandsFromInstr(minstr, vmInstrNode, target,
-                       canDiscardResult, op1Position,
-                       /*op2Position*/ -1, resultPosition);
+  cerr << "  " << *this;
 }
 
-#undef REVERT_TO_EXPLICIT_CONSTANT_CHECKS
-#ifdef REVERT_TO_EXPLICIT_CONSTANT_CHECKS
-unsigned
-Set3OperandsFromInstrJUNK(MachineInstr* minstr,
-                         InstructionNode* vmInstrNode,
-                         const TargetMachine& target,
-                         bool canDiscardResult,
-                         int op1Position,
-                         int op2Position,
-                         int resultPosition)
+static inline std::ostream&
+OutputValue(std::ostream &os, const Value* val)
 {
-  assert(op1Position >= 0);
-  assert(resultPosition >= 0);
-  
-  unsigned returnFlags = 0x0;
-  
-  // Check if operand 1 is 0.  If so, try to use a hardwired 0 register.
-  Value* op1Value = vmInstrNode->leftChild()->getValue();
-  bool isValidConstant;
-  int64_t intValue = GetConstantValueAsSignedInt(op1Value, isValidConstant);
-  if (isValidConstant && intValue == 0 && target.zeroRegNum >= 0)
-    minstr->SetMachineOperand(op1Position, /*regNum*/ target.zeroRegNum);
+  os << "(val ";
+  if (val && val->hasName())
+    return os << val->getName() << ")";
   else
-    {
-      if (op1Value->isConstant())
-       {
-         // value is constant and must be loaded from constant pool
-         returnFlags = returnFlags | (1 << op1Position);
-       }
-      minstr->SetMachineOperand(op1Position, MachineOperand::MO_VirtualRegister,
-                               op1Value);
-    }
-  
-  // Check if operand 2 (if any) fits in the immed. field of the instruction,
-  // or if it is 0 and can use a dedicated machine register
-  if (op2Position >= 0)
-    {
-      Value* op2Value = vmInstrNode->rightChild()->getValue();
-      int64_t immedValue;
-      unsigned int machineRegNum;
-      
-      MachineOperand::MachineOperandType
-       op2type = ChooseRegOrImmed(op2Value, minstr->getOpCode(), target,
-                                  /*canUseImmed*/ true,
-                                  machineRegNum, immedValue);
-      
-      if (op2type == MachineOperand::MO_MachineRegister)
-       minstr->SetMachineOperand(op2Position, machineRegNum);
-      else if (op2type == MachineOperand::MO_VirtualRegister)
-       {
-         if (op2Value->isConstant())
-           {
-             // value is constant and must be loaded from constant pool
-             returnFlags = returnFlags | (1 << op2Position);
-           }
-         minstr->SetMachineOperand(op2Position, op2type, op2Value);
-       }
-      else
-       {
-         assert(op2type != MO_CCRegister);
-         minstr->SetMachineOperand(op2Position, op2type, immedValue);
-       }
-    }
-  
-  // If operand 3 (result) can be discarded, use a dead register if one exists
-  if (canDiscardResult && target.zeroRegNum >= 0)
-    minstr->SetMachineOperand(resultPosition, target.zeroRegNum);
-  else
-    minstr->SetMachineOperand(resultPosition, MachineOperand::MO_VirtualRegister, vmInstrNode->getValue());
-
-  return returnFlags;
+    return os << (void*) val << ")";              // print address only
 }
-#endif
 
-
-void
-Set3OperandsFromInstr(MachineInstr* minstr,
-                     InstructionNode* vmInstrNode,
-                     const TargetMachine& target,
-                     bool canDiscardResult,
-                     int op1Position,
-                     int op2Position,
-                     int resultPosition)
+static inline std::ostream&
+OutputReg(std::ostream &os, unsigned int regNum)
 {
-  assert(op1Position >= 0);
-  assert(resultPosition >= 0);
-  
-  // operand 1
-  minstr->SetMachineOperand(op1Position, MachineOperand::MO_VirtualRegister,
-                           vmInstrNode->leftChild()->getValue());   
-  
-  // operand 2 (if any)
-  if (op2Position >= 0)
-    minstr->SetMachineOperand(op2Position, MachineOperand::MO_VirtualRegister,
-                             vmInstrNode->rightChild()->getValue());   
-  
-  // result operand: if it can be discarded, use a dead register if one exists
-  if (canDiscardResult && target.getRegInfo().getZeroRegNum() >= 0)
-    minstr->SetMachineOperand(resultPosition,
-                             target.getRegInfo().getZeroRegNum());
-  else
-    minstr->SetMachineOperand(resultPosition,
-                             MachineOperand::MO_VirtualRegister, vmInstrNode->getValue());
+  return os << "%mreg(" << regNum << ")";
 }
 
-
-MachineOperand::MachineOperandType
-ChooseRegOrImmed(Value* val,
-                MachineOpCode opCode,
-                const TargetMachine& target,
-                bool canUseImmed,
-                unsigned int& getMachineRegNum,
-                int64_t& getImmedValue)
+std::ostream &operator<<(std::ostream& os, const MachineInstr& minstr)
 {
-  MachineOperand::MachineOperandType opType =
-    MachineOperand::MO_VirtualRegister;
-  getMachineRegNum = 0;
-  getImmedValue = 0;
-  
-  // Check for the common case first: argument is not constant
-  // 
-  ConstPoolVal *CPV = val->castConstant();
-  if (!CPV) return opType;
-
-  if (CPV->getType() == Type::BoolTy)
-    {
-      ConstPoolBool *CPB = (ConstPoolBool*)CPV;
-      if (!CPB->getValue() && target.getRegInfo().getZeroRegNum() >= 0)
-       {
-         getMachineRegNum = target.getRegInfo().getZeroRegNum();
-         return MachineOperand::MO_MachineRegister;
-       }
-
-      getImmedValue = 1;
-      return MachineOperand::MO_SignExtendedImmed;
-    }
+  os << TargetInstrDescriptors[minstr.opCode].opCodeString;
   
-  if (!CPV->getType()->isIntegral()) return opType;
-
-  // Now get the constant value and check if it fits in the IMMED field.
-  // Take advantage of the fact that the max unsigned value will rarely
-  // fit into any IMMED field and ignore that case (i.e., cast smaller
-  // unsigned constants to signed).
-  // 
-  int64_t intValue;
-  if (CPV->getType()->isSigned())
-    {
-      intValue = ((ConstPoolSInt*)CPV)->getValue();
-    }
-  else
-    {
-      uint64_t V = ((ConstPoolUInt*)CPV)->getValue();
-      if (V >= INT64_MAX) return opType;
-      intValue = (int64_t)V;
-    }
-
-  if (intValue == 0 && target.getRegInfo().getZeroRegNum() >= 0)
-    {
-      opType = MachineOperand::MO_MachineRegister;
-      getMachineRegNum = target.getRegInfo().getZeroRegNum();
-    }
-  else if (canUseImmed &&
-          target.getInstrInfo().constantFitsInImmedField(opCode, intValue))
-    {
-      opType = MachineOperand::MO_SignExtendedImmed;
-      getImmedValue = intValue;
+  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 << "*";
+  }
+  
+  // 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";
     }
+  }
   
-  return opType;
+  return os << "\n";
 }
 
-
-void
-PrintMachineInstructions(const Method *const method)
+std::ostream &operator<<(std::ostream &os, const MachineOperand &mop)
 {
-  cout << "\n" << method->getReturnType()
-       << " \"" << method->getName() << "\"" << endl;
+  if (mop.opHiBits32())
+    os << "%lm(";
+  else if (mop.opLoBits32())
+    os << "%lo(";
+  else if (mop.opHiBits64())
+    os << "%hh(";
+  else if (mop.opLoBits64())
+    os << "%hm(";
   
-  for (Method::const_iterator BI = method->begin(); BI != method->end(); ++BI)
+  switch(mop.opType)
     {
-      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] << endl;
-    } 
-  cout << endl << "End method \"" << method->getName() << "\""
-       << endl << endl;
+    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;
+    }
+  
+  if (mop.flags &
+      (MachineOperand::HIFLAG32 | MachineOperand::LOFLAG32 | 
+       MachineOperand::HIFLAG64 | MachineOperand::LOFLAG64))
+    os << ")";
+  
+  return os;
 }