- Rename AnalysisUsage::preservesAll to getPreservesAll & preservesCFG to
[oota-llvm.git] / lib / CodeGen / MachineInstr.cpp
index c43b022bb1d7cd08926dd4e60d8f840b66b71f0d..02c25fdd7fbc08382d029ddacbed5b7d41ad933b 100644 (file)
-// $Id$
-//***************************************************************************
-// File:
-//     MachineInstr.cpp
+//===-- MachineInstr.cpp --------------------------------------------------===//
 // 
-// Purpose:
-//     
-// 
-// Strategy:
-// 
-// History:
-//     7/2/01   -  Vikram Adve  -  Created
-//**************************************************************************/
+//===----------------------------------------------------------------------===//
 
 #include "llvm/CodeGen/MachineInstr.h"
-#include "llvm/ConstPoolVals.h"
-#include "llvm/Instruction.h"
-#include <strstream>
-
-//************************ Class Implementations **************************/
+#include "llvm/Value.h"
+using std::cerr;
 
 
-bool
-MachineInstrInfo::constantFitsInImmedField(int64_t intValue) const
+// Constructor for instructions with fixed #operands (nearly all)
+MachineInstr::MachineInstr(MachineOpCode _opCode,
+                          OpCodeMask    _opCodeMask)
+  : opCode(_opCode),
+    opCodeMask(_opCodeMask),
+    operands(TargetInstrDescriptors[_opCode].numOperands)
 {
-  // First, check if opCode has an immed field.
-  bool isSignExtended;
-  uint64_t maxImmedValue = this->maxImmedConstant(isSignExtended);
-  if (maxImmedValue != 0)
-    {
-      // Now check if the constant fits
-      if (intValue <= (int64_t) maxImmedValue &&
-         intValue >= -((int64_t) maxImmedValue+1))
-       return true;
-    }
-  
-  return false;
+  assert(TargetInstrDescriptors[_opCode].numOperands >= 0);
 }
 
+// Constructor for instructions with variable #operands
 MachineInstr::MachineInstr(MachineOpCode _opCode,
+                          unsigned      numOperands,
                           OpCodeMask    _opCodeMask)
   : opCode(_opCode),
     opCodeMask(_opCodeMask),
-    operands(TargetMachineInstrInfo[_opCode].numOperands)
+    operands(numOperands)
 {
 }
 
+// 
+// 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)
+MachineInstr::replace(MachineOpCode _opCode,
+                      unsigned     numOperands,
+                      OpCodeMask    _opCodeMask)
 {
-  assert(i < TargetMachineInstrInfo[opCode].numOperands);
-  operands[i].Initialize(operandType, _val);
+  opCode = _opCode;
+  opCodeMask = _opCodeMask;
+  operands.clear();
+  operands.resize(numOperands);
 }
 
 void
-MachineInstr::SetMachineOperand(unsigned int i,
-                               MachineOperand::MachineOperandType operandType,
-                               int64_t intValue)
+MachineInstr::SetMachineOperandVal(unsigned int i,
+                                   MachineOperand::MachineOperandType opType,
+                                   Value* _val,
+                                   bool isdef,
+                                   bool isDefAndUse)
 {
-  assert(i < TargetMachineInstrInfo[opCode].numOperands);
-  operands[i].InitializeConst(operandType, intValue);
+  assert(i < operands.size());
+  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,
-                               unsigned int regNum)
+MachineInstr::SetMachineOperandConst(unsigned int i,
+                               MachineOperand::MachineOperandType operandType,
+                                     int64_t intValue)
 {
-  assert(i < TargetMachineInstrInfo[opCode].numOperands);
-  operands[i].InitializeReg(regNum);
+  assert(i < operands.size());
+  assert(TargetInstrDescriptors[opCode].resultPos != (int) i &&
+         "immed. constant cannot be defined");
+  operands[i].InitializeConst(operandType, intValue);
 }
 
 void
-MachineInstr::dump(unsigned int indent)
+MachineInstr::SetMachineOperandReg(unsigned int i,
+                                   int regNum,
+                                   bool isdef,
+                                   bool isDefAndUse,
+                                   bool isCCReg)
 {
-  for (unsigned i=0; i < indent; i++)
-    cout << "    ";
-  
-  cout << *this;
+  assert(i < operands.size());
+  operands[i].InitializeReg(regNum, isCCReg);
+  if (isdef || TargetInstrDescriptors[opCode].resultPos == (int) i)
+    operands[i].markDef();
+  if (isDefAndUse)
+    operands[i].markDefAndUse();
+  regsUsed.insert(regNum);
 }
 
-ostream&
-operator<< (ostream& os, const MachineInstr& minstr)
+void
+MachineInstr::SetRegForOperand(unsigned i, int regNum)
 {
-  os << TargetMachineInstrInfo[minstr.opCode].opCodeString;
-  
-  for (unsigned i=0, N=minstr.getNumOperands(); i < N; i++)
-    os << "\t" << minstr.getOperand(i);
-  
-  return os;
+  operands[i].setRegForValue(regNum);
+  regsUsed.insert(regNum);
 }
 
-ostream&
-operator<< (ostream& os, const MachineOperand& mop)
-{
-  strstream regInfo;
-  if (mop.machineOperandType == MachineOperand::MO_Register)
-    {
-      if (mop.vregType == MachineOperand::MO_VirtualReg)
-       regInfo << "(val " << mop.value << ")" << ends;
-      else
-       regInfo << "("       << mop.regNum << ")" << ends;
-    }
-  else if (mop.machineOperandType == MachineOperand::MO_CCRegister)
-    regInfo << "(val " << mop.value << ")" << ends;
-  
-  switch(mop.machineOperandType)
-    {
-    case MachineOperand::MO_Register:
-      os << "%reg" << regInfo.str();
-      free(regInfo.str());
-      break;
-      
-    case MachineOperand::MO_CCRegister:
-      os << "%ccreg" << regInfo.str();
-      free(regInfo.str());
-      break;
-
-    case MachineOperand::MO_SignExtendedImmed:
-      os << mop.immedVal;
-      break;
 
-    case MachineOperand::MO_UnextendedImmed:
-      os << mop.immedVal;
-      break;
-
-    case MachineOperand::MO_PCRelativeDisp:
-      os << "%disp(label " << mop.value << ")";
-      break;
-
-    default:
-      assert(0 && "Unrecognized operand type");
-      break;
-    }
-
-  return os;
+// 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;
+
+  // 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& targetMachine,
-                     bool canDiscardResult,
-                     int op1Position,
-                     int resultPosition)
+MachineInstr::dump() const 
 {
-  Set3OperandsFromInstr(minstr, vmInstrNode, targetMachine,
-                       canDiscardResult, op1Position,
-                       /*op2Position*/ -1, resultPosition);
+  cerr << "  " << *this;
 }
 
-
-unsigned
-Set3OperandsFromInstrJUNK(MachineInstr* minstr,
-                     InstructionNode* vmInstrNode,
-                     const TargetMachine& targetMachine,
-                     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 and if so, try to use the register that gives 0, if any.
-  Value* op1Value = vmInstrNode->leftChild()->getValue();
-  bool isValidConstant;
-  int64_t intValue = GetConstantValueAsSignedInt(op1Value, isValidConstant);
-  if (isValidConstant && intValue == 0 && targetMachine.zeroRegNum >= 0)
-    minstr->SetMachineOperand(op1Position, /*regNum*/ targetMachine.zeroRegNum);
+  os << "(val ";
+  if (val && val->hasName())
+    return os << val->getName() << ")";
   else
-    {
-      if (op1Value->getValueType() == Value::ConstantVal)
-       {// value is constant and must be loaded from constant pool
-         returnFlags = returnFlags | (1 << op1Position);
-       }
-      minstr->SetMachineOperand(op1Position, MachineOperand::MO_Register,
-                                            op1Value);
-    }
-  
-  // Check if operand 2 (if any) fits in the immediate field of the instruction,
-  // of if it is 0 and can use a dedicated machine register
-  if (op2Position >= 0)
-    {
-      Value* op2Value = vmInstrNode->rightChild()->getValue();
-      int64_t immedValue;
-      MachineOperand::VirtualRegisterType vregType;
-      unsigned int machineRegNum;
-      
-      MachineOperand::MachineOperandType
-       op2type = ChooseRegOrImmed(op2Value, minstr->getOpCode(),targetMachine,
-                                  /*canUseImmed*/ true,
-                                  vregType, machineRegNum, immedValue);
-      
-      if (op2type == MachineOperand::MO_Register)
-       {
-         if (vregType == MachineOperand::MO_MachineReg)
-           minstr->SetMachineOperand(op2Position, machineRegNum);
-         else
-           {
-             if (op2Value->getValueType() == Value::ConstantVal)
-               {// value is constant and must be loaded from constant pool
-                 returnFlags = returnFlags | (1 << op2Position);
-               }
-             minstr->SetMachineOperand(op2Position, op2type, op2Value);
-           }
-       }
-      else
-       minstr->SetMachineOperand(op2Position, op2type, immedValue);
-    }
-  
-  // If operand 3 (result) can be discarded, use a dead register if one exists
-  if (canDiscardResult && targetMachine.zeroRegNum >= 0)
-    minstr->SetMachineOperand(resultPosition, targetMachine.zeroRegNum);
-  else
-    minstr->SetMachineOperand(resultPosition, MachineOperand::MO_Register,
-                                             vmInstrNode->getValue());
-
-  return returnFlags;
+    return os << (void*) val << ")";              // print address only
 }
 
+static inline std::ostream&
+OutputReg(std::ostream &os, unsigned int regNum)
+{
+  return os << "%mreg(" << regNum << ")";
+}
 
-void
-Set3OperandsFromInstr(MachineInstr* minstr,
-                     InstructionNode* vmInstrNode,
-                     const TargetMachine& targetMachine,
-                     bool canDiscardResult,
-                     int op1Position,
-                     int op2Position,
-                     int resultPosition)
+std::ostream &operator<<(std::ostream& os, const MachineInstr& minstr)
 {
-  assert(op1Position >= 0);
-  assert(resultPosition >= 0);
-  
-  // operand 1
-  minstr->SetMachineOperand(op1Position, MachineOperand::MO_Register,
-                           vmInstrNode->leftChild()->getValue());   
+  os << TargetInstrDescriptors[minstr.opCode].opCodeString;
   
-  // operand 2 (if any)
-  if (op2Position >= 0)
-    minstr->SetMachineOperand(op2Position, MachineOperand::MO_Register,
-                             vmInstrNode->rightChild()->getValue());   
+  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";
+    }
+  }
   
-  // result operand: if it can be discarded, use a dead register if one exists
-  if (canDiscardResult && targetMachine.zeroRegNum >= 0)
-    minstr->SetMachineOperand(resultPosition, targetMachine.zeroRegNum);
-  else
-    minstr->SetMachineOperand(resultPosition, MachineOperand::MO_Register,
-                                             vmInstrNode->getValue());
+  return os << "\n";
 }
 
-
-MachineOperand::MachineOperandType
-ChooseRegOrImmed(Value* val,
-                MachineOpCode opCode,
-                const TargetMachine& targetMachine,
-                bool canUseImmed,
-                MachineOperand::VirtualRegisterType& getVRegType,
-                unsigned int& getMachineRegNum,
-                int64_t& getImmedValue)
+std::ostream &operator<<(std::ostream &os, const MachineOperand &mop)
 {
-  MachineOperand::MachineOperandType opType = MachineOperand::MO_Register;
-  getVRegType = MachineOperand::MO_VirtualReg;
-  getMachineRegNum = 0;
-  getImmedValue = 0;
-  
-  // Check for the common case first: argument is not constant
-  // 
-  if (val->getValueType() != Value::ConstantVal)
-    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).
-  // 
-  bool isValidConstant;
-  int64_t intValue = GetConstantValueAsSignedInt(val, isValidConstant);
-  
-  if (isValidConstant)
+  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)
     {
-      if (intValue == 0 && targetMachine.zeroRegNum >= 0)
-       {
-         getVRegType = MachineOperand::MO_MachineReg;
-         getMachineRegNum = targetMachine.zeroRegNum;
-       }
-      else if (canUseImmed &&
-              targetMachine.machineInstrInfo[opCode].constantFitsInImmedField(intValue))
-       {
-         opType = MachineOperand::MO_SignExtendedImmed;
-         getImmedValue = intValue;
-       }
+    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;
     }
   
-  return opType;
+  if (mop.flags &
+      (MachineOperand::HIFLAG32 | MachineOperand::LOFLAG32 | 
+       MachineOperand::HIFLAG64 | MachineOperand::LOFLAG64))
+    os << ")";
+  
+  return os;
 }