-// $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.
+//
+// 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/TargetMachine.h"
+#include "llvm/Target/TargetInstrInfo.h"
+#include "llvm/Target/MRegisterInfo.h"
+#include "llvm/Support/LeakDetector.h"
#include <iostream>
-using std::cerr;
+using namespace llvm;
-//************************ 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);
+// 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,
- OpCodeMask _opCodeMask)
- : opCode(_opCode),
- opCodeMask(_opCodeMask),
- operands(numOperands)
-{
+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);
}
-void
-MachineInstr::SetMachineOperandVal(unsigned int i,
- MachineOperand::MachineOperandType opType,
- Value* _val,
- bool isdef=false,
- bool isDefAndUse=false)
-{
- assert(i < operands.size());
- operands[i].Initialize(opType, _val);
- operands[i].isDef = isdef ||
- TargetInstrDescriptors[opCode].resultPos == (int) i;
- operands[i].isDefAndUse = isDefAndUse;
+/// 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);
}
-void
-MachineInstr::SetMachineOperandConst(unsigned int i,
- MachineOperand::MachineOperandType operandType,
- 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 = false;
- operands[i].isDefAndUse = 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!
}
-void
-MachineInstr::SetMachineOperandReg(unsigned int i,
- int regNum,
- bool isdef=false,
- bool isDefAndUse=false,
- bool isCCReg=false)
-{
- assert(i < operands.size());
- operands[i].InitializeReg(regNum, isCCReg);
- operands[i].isDef = isdef ||
- TargetInstrDescriptors[opCode].resultPos == (int) i;
- operands[i].isDefAndUse = isDefAndUse;
- regsUsed.insert(regNum);
+/// 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(MachineOperand(MI.getOperand(i)));
+
+ // Set parent, next, and prev to null
+ parent = 0;
+ prev = 0;
+ next = 0;
}
-void
-MachineInstr::SetRegForOperand(unsigned i, int regNum)
-{
- operands[i].setRegForValue(regNum);
- regsUsed.insert(regNum);
+
+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::dump() const
-{
- cerr << " " << *this;
+MachineInstr::SetMachineOperandConst(unsigned i,
+ 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) {
+ assert(i < getNumOperands()); // must be explicit op
+
+ operands[i].opType = MachineOperand::MO_MachineRegister;
+ operands[i].contents.value = NULL;
+ operands[i].extra.regNum = regNum;
+}
+
+void MachineInstr::dump() const {
+ std::cerr << " " << *this;
}
-static inline std::ostream &OutputValue(std::ostream &os,
- const Value* val)
-{
+static inline std::ostream& OutputValue(std::ostream &os, const Value* val) {
os << "(val ";
+ os << (void*) val; // print address always
if (val && val->hasName())
- return os << val->getName();
- else
- return os << (void*) val; // print address only
+ os << " " << val->getName(); // print name also, if available
os << ")";
+ return os;
}
-std::ostream &operator<<(std::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);
- 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";
+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();
+
+ 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;
+
+ 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;
+
+ // 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!
}
-
+
+ // 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>";
+ }
+
+ OS << "\n";
+}
+
+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;
+ }
+
+ // 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";
}
-static inline std::ostream &OutputOperand(std::ostream &os,
- const MachineOperand &mop)
-{
- Value* val;
- switch (mop.getOperandType())
- {
- case MachineOperand::MO_CCRegister:
- case MachineOperand::MO_VirtualRegister:
- return OutputValue(os, mop.getVRegValue());
- case MachineOperand::MO_MachineRegister:
- return os << "(" << mop.getMachineRegNum() << ")";
- default:
- assert(0 && "Unknown operand type");
- return os;
+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());
}
+ 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;
}
-std::ostream &operator<<(std::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 << (long)mop.immedVal;
- case MachineOperand::MO_UnextendedImmed:
- return os << (long)mop.immedVal;
- 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;
- return os << ")";
- }
- default:
- assert(0 && "Unrecognized operand type");
- break;
- }
-
- return os;
}