mirror of
https://github.com/RPCS3/llvm-mirror.git
synced 2024-11-25 20:23:11 +01:00
7f6a73eb5c
rework the hacks that had us passing OStream in. We pass in std::ostream* instead, check for null, and then dispatch to the correct print() method. llvm-svn: 32636
537 lines
17 KiB
C++
537 lines
17 KiB
C++
//===-- llvm/CodeGen/MachineInstr.h - MachineInstr class --------*- C++ -*-===//
|
|
//
|
|
// 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.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
//
|
|
// This file contains the declaration of the MachineInstr class, which is the
|
|
// basic representation for all target dependent machine instructions used by
|
|
// the back end.
|
|
//
|
|
//===----------------------------------------------------------------------===//
|
|
|
|
#ifndef LLVM_CODEGEN_MACHINEINSTR_H
|
|
#define LLVM_CODEGEN_MACHINEINSTR_H
|
|
|
|
#include "llvm/ADT/iterator"
|
|
#include "llvm/Support/DataTypes.h"
|
|
#include "llvm/Support/Streams.h"
|
|
#include <vector>
|
|
#include <cassert>
|
|
#include <iosfwd>
|
|
|
|
namespace llvm {
|
|
|
|
class Value;
|
|
class Function;
|
|
class MachineBasicBlock;
|
|
class TargetInstrDescriptor;
|
|
class TargetMachine;
|
|
class GlobalValue;
|
|
|
|
template <typename T> struct ilist_traits;
|
|
template <typename T> struct ilist;
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// class MachineOperand
|
|
//
|
|
// Representation of each machine instruction operand.
|
|
//
|
|
struct MachineOperand {
|
|
enum MachineOperandType {
|
|
MO_Register, // Register operand.
|
|
MO_Immediate, // Immediate Operand
|
|
MO_MachineBasicBlock, // MachineBasicBlock reference
|
|
MO_FrameIndex, // Abstract Stack Frame Index
|
|
MO_ConstantPoolIndex, // Address of indexed Constant in Constant Pool
|
|
MO_JumpTableIndex, // Address of indexed Jump Table for switch
|
|
MO_ExternalSymbol, // Name of external global symbol
|
|
MO_GlobalAddress // Address of a global value
|
|
};
|
|
|
|
private:
|
|
union {
|
|
GlobalValue *GV; // For MO_GlobalAddress.
|
|
MachineBasicBlock *MBB; // For MO_MachineBasicBlock.
|
|
const char *SymbolName; // For MO_ExternalSymbol.
|
|
unsigned RegNo; // For MO_Register.
|
|
int64_t immedVal; // For MO_Immediate and MO_*Index.
|
|
} contents;
|
|
|
|
MachineOperandType opType:8; // Discriminate the union.
|
|
bool IsDef : 1; // True if this is a def, false if this is a use.
|
|
bool IsImp : 1; // True if this is an implicit def or use.
|
|
|
|
bool IsKill : 1; // True if this is a reg use and the reg is dead
|
|
// immediately after the read.
|
|
bool IsDead : 1; // True if this is a reg def and the reg is dead
|
|
// immediately after the write. i.e. A register
|
|
// that is defined but never used.
|
|
|
|
/// offset - Offset to address of global or external, only valid for
|
|
/// MO_GlobalAddress, MO_ExternalSym and MO_ConstantPoolIndex
|
|
int offset;
|
|
|
|
MachineOperand() {}
|
|
|
|
void print(std::ostream &os) const;
|
|
void print(std::ostream *os) const { if (os) print(*os); }
|
|
|
|
public:
|
|
MachineOperand(const MachineOperand &M) {
|
|
*this = M;
|
|
}
|
|
|
|
~MachineOperand() {}
|
|
|
|
static MachineOperand CreateImm(int64_t Val) {
|
|
MachineOperand Op;
|
|
Op.opType = MachineOperand::MO_Immediate;
|
|
Op.contents.immedVal = Val;
|
|
Op.IsDef = false;
|
|
Op.IsImp = false;
|
|
Op.IsKill = false;
|
|
Op.IsDead = false;
|
|
Op.offset = 0;
|
|
return Op;
|
|
}
|
|
|
|
const MachineOperand &operator=(const MachineOperand &MO) {
|
|
contents = MO.contents;
|
|
IsDef = MO.IsDef;
|
|
IsImp = MO.IsImp;
|
|
IsKill = MO.IsKill;
|
|
IsDead = MO.IsDead;
|
|
opType = MO.opType;
|
|
offset = MO.offset;
|
|
return *this;
|
|
}
|
|
|
|
/// getType - Returns the MachineOperandType for this operand.
|
|
///
|
|
MachineOperandType getType() const { return opType; }
|
|
|
|
/// Accessors that tell you what kind of MachineOperand you're looking at.
|
|
///
|
|
bool isReg() const { return opType == MO_Register; }
|
|
bool isImm() const { return opType == MO_Immediate; }
|
|
bool isMBB() const { return opType == MO_MachineBasicBlock; }
|
|
|
|
bool isRegister() const { return opType == MO_Register; }
|
|
bool isImmediate() const { return opType == MO_Immediate; }
|
|
bool isMachineBasicBlock() const { return opType == MO_MachineBasicBlock; }
|
|
bool isFrameIndex() const { return opType == MO_FrameIndex; }
|
|
bool isConstantPoolIndex() const { return opType == MO_ConstantPoolIndex; }
|
|
bool isJumpTableIndex() const { return opType == MO_JumpTableIndex; }
|
|
bool isGlobalAddress() const { return opType == MO_GlobalAddress; }
|
|
bool isExternalSymbol() const { return opType == MO_ExternalSymbol; }
|
|
|
|
int64_t getImm() const {
|
|
assert(isImm() && "Wrong MachineOperand accessor");
|
|
return contents.immedVal;
|
|
}
|
|
|
|
int64_t getImmedValue() const {
|
|
assert(isImm() && "Wrong MachineOperand accessor");
|
|
return contents.immedVal;
|
|
}
|
|
MachineBasicBlock *getMBB() const {
|
|
assert(isMachineBasicBlock() && "Wrong MachineOperand accessor");
|
|
return contents.MBB;
|
|
}
|
|
MachineBasicBlock *getMachineBasicBlock() const {
|
|
assert(isMachineBasicBlock() && "Wrong MachineOperand accessor");
|
|
return contents.MBB;
|
|
}
|
|
void setMachineBasicBlock(MachineBasicBlock *MBB) {
|
|
assert(isMachineBasicBlock() && "Wrong MachineOperand accessor");
|
|
contents.MBB = MBB;
|
|
}
|
|
int getFrameIndex() const {
|
|
assert(isFrameIndex() && "Wrong MachineOperand accessor");
|
|
return (int)contents.immedVal;
|
|
}
|
|
unsigned getConstantPoolIndex() const {
|
|
assert(isConstantPoolIndex() && "Wrong MachineOperand accessor");
|
|
return (unsigned)contents.immedVal;
|
|
}
|
|
unsigned getJumpTableIndex() const {
|
|
assert(isJumpTableIndex() && "Wrong MachineOperand accessor");
|
|
return (unsigned)contents.immedVal;
|
|
}
|
|
GlobalValue *getGlobal() const {
|
|
assert(isGlobalAddress() && "Wrong MachineOperand accessor");
|
|
return contents.GV;
|
|
}
|
|
int getOffset() const {
|
|
assert((isGlobalAddress() || isExternalSymbol() || isConstantPoolIndex()) &&
|
|
"Wrong MachineOperand accessor");
|
|
return offset;
|
|
}
|
|
const char *getSymbolName() const {
|
|
assert(isExternalSymbol() && "Wrong MachineOperand accessor");
|
|
return contents.SymbolName;
|
|
}
|
|
|
|
bool isUse() const {
|
|
assert(isRegister() && "Wrong MachineOperand accessor");
|
|
return !IsDef;
|
|
}
|
|
bool isDef() const {
|
|
assert(isRegister() && "Wrong MachineOperand accessor");
|
|
return IsDef;
|
|
}
|
|
void setIsUse() {
|
|
assert(isRegister() && "Wrong MachineOperand accessor");
|
|
IsDef = false;
|
|
}
|
|
void setIsDef() {
|
|
assert(isRegister() && "Wrong MachineOperand accessor");
|
|
IsDef = true;
|
|
}
|
|
|
|
bool isImplicit() const {
|
|
assert(isRegister() && "Wrong MachineOperand accessor");
|
|
return IsImp;
|
|
}
|
|
void setImplicit() {
|
|
assert(isRegister() && "Wrong MachineOperand accessor");
|
|
IsImp = true;
|
|
}
|
|
|
|
bool isKill() const {
|
|
assert(isRegister() && "Wrong MachineOperand accessor");
|
|
return IsKill;
|
|
}
|
|
bool isDead() const {
|
|
assert(isRegister() && "Wrong MachineOperand accessor");
|
|
return IsDead;
|
|
}
|
|
void setIsKill() {
|
|
assert(isRegister() && !IsDef && "Wrong MachineOperand accessor");
|
|
IsKill = true;
|
|
}
|
|
void setIsDead() {
|
|
assert(isRegister() && IsDef && "Wrong MachineOperand accessor");
|
|
IsDead = true;
|
|
}
|
|
void unsetIsKill() {
|
|
assert(isRegister() && !IsDef && "Wrong MachineOperand accessor");
|
|
IsKill = false;
|
|
}
|
|
void unsetIsDead() {
|
|
assert(isRegister() && IsDef && "Wrong MachineOperand accessor");
|
|
IsDead = false;
|
|
}
|
|
|
|
/// getReg - Returns the register number.
|
|
///
|
|
unsigned getReg() const {
|
|
assert(isRegister() && "This is not a register operand!");
|
|
return contents.RegNo;
|
|
}
|
|
|
|
/// MachineOperand mutators.
|
|
///
|
|
void setReg(unsigned Reg) {
|
|
assert(isRegister() && "This is not a register operand!");
|
|
contents.RegNo = Reg;
|
|
}
|
|
|
|
void setImmedValue(int64_t immVal) {
|
|
assert(isImm() && "Wrong MachineOperand mutator");
|
|
contents.immedVal = immVal;
|
|
}
|
|
void setImm(int64_t immVal) {
|
|
assert(isImm() && "Wrong MachineOperand mutator");
|
|
contents.immedVal = immVal;
|
|
}
|
|
|
|
void setOffset(int Offset) {
|
|
assert((isGlobalAddress() || isExternalSymbol() || isConstantPoolIndex() ||
|
|
isJumpTableIndex()) &&
|
|
"Wrong MachineOperand accessor");
|
|
offset = Offset;
|
|
}
|
|
void setConstantPoolIndex(unsigned Idx) {
|
|
assert(isConstantPoolIndex() && "Wrong MachineOperand accessor");
|
|
contents.immedVal = Idx;
|
|
}
|
|
void setJumpTableIndex(unsigned Idx) {
|
|
assert(isJumpTableIndex() && "Wrong MachineOperand accessor");
|
|
contents.immedVal = Idx;
|
|
}
|
|
|
|
/// isIdenticalTo - Return true if this operand is identical to the specified
|
|
/// operand. Note: This method ignores isKill and isDead properties.
|
|
bool isIdenticalTo(const MachineOperand &Other) const;
|
|
|
|
/// ChangeToImmediate - Replace this operand with a new immediate operand of
|
|
/// the specified value. If an operand is known to be an immediate already,
|
|
/// the setImmedValue method should be used.
|
|
void ChangeToImmediate(int64_t ImmVal) {
|
|
opType = MO_Immediate;
|
|
contents.immedVal = ImmVal;
|
|
}
|
|
|
|
/// ChangeToRegister - Replace this operand with a new register operand of
|
|
/// the specified value. If an operand is known to be an register already,
|
|
/// the setReg method should be used.
|
|
void ChangeToRegister(unsigned Reg, bool isDef) {
|
|
opType = MO_Register;
|
|
contents.RegNo = Reg;
|
|
IsDef = isDef;
|
|
IsImp = false;
|
|
IsKill = false;
|
|
IsDead = false;
|
|
}
|
|
|
|
friend std::ostream& operator<<(std::ostream& os, const MachineOperand& mop) {
|
|
mop.print(os);
|
|
return os;
|
|
}
|
|
|
|
friend class MachineInstr;
|
|
};
|
|
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
/// MachineInstr - Representation of each machine instruction.
|
|
///
|
|
class MachineInstr {
|
|
const TargetInstrDescriptor *TID; // Instruction descriptor.
|
|
unsigned short NumImplicitOps; // Number of implicit operands (which
|
|
// are determined at construction time).
|
|
|
|
std::vector<MachineOperand> Operands; // the operands
|
|
MachineInstr* prev, *next; // links for our intrusive list
|
|
MachineBasicBlock* parent; // pointer to the owning basic block
|
|
|
|
// OperandComplete - Return true if it's illegal to add a new operand
|
|
bool OperandsComplete() const;
|
|
|
|
MachineInstr(const MachineInstr&);
|
|
void operator=(const MachineInstr&); // DO NOT IMPLEMENT
|
|
|
|
// Intrusive list support
|
|
//
|
|
friend struct ilist_traits<MachineInstr>;
|
|
|
|
public:
|
|
/// MachineInstr ctor - This constructor creates a dummy MachineInstr with
|
|
/// TID NULL and no operands.
|
|
MachineInstr();
|
|
|
|
/// MachineInstr ctor - This constructor create a MachineInstr and add the
|
|
/// implicit operands. It reserves space for number of operands specified by
|
|
/// TargetInstrDescriptor.
|
|
MachineInstr(const TargetInstrDescriptor &TID);
|
|
|
|
/// 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(MachineBasicBlock *MBB, const TargetInstrDescriptor &TID);
|
|
|
|
~MachineInstr();
|
|
|
|
const MachineBasicBlock* getParent() const { return parent; }
|
|
MachineBasicBlock* getParent() { return parent; }
|
|
|
|
/// getInstrDescriptor - Returns the target instruction descriptor of this
|
|
/// MachineInstr.
|
|
const TargetInstrDescriptor *getInstrDescriptor() const { return TID; }
|
|
|
|
/// getOpcode - Returns the opcode of this MachineInstr.
|
|
///
|
|
const int getOpcode() const;
|
|
|
|
/// Access to explicit operands of the instruction.
|
|
///
|
|
unsigned getNumOperands() const { return Operands.size(); }
|
|
|
|
const MachineOperand& getOperand(unsigned i) const {
|
|
assert(i < getNumOperands() && "getOperand() out of range!");
|
|
return Operands[i];
|
|
}
|
|
MachineOperand& getOperand(unsigned i) {
|
|
assert(i < getNumOperands() && "getOperand() out of range!");
|
|
return Operands[i];
|
|
}
|
|
|
|
|
|
/// isIdenticalTo - Return true if this instruction is identical to (same
|
|
/// opcode and same operands as) the specified instruction.
|
|
bool isIdenticalTo(const MachineInstr *Other) const {
|
|
if (Other->getOpcode() != getOpcode() ||
|
|
Other->getNumOperands() != getNumOperands())
|
|
return false;
|
|
for (unsigned i = 0, e = getNumOperands(); i != e; ++i)
|
|
if (!getOperand(i).isIdenticalTo(Other->getOperand(i)))
|
|
return false;
|
|
return true;
|
|
}
|
|
|
|
/// clone - Create a copy of 'this' instruction that is identical in
|
|
/// all ways except the the instruction has no parent, prev, or next.
|
|
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 *removeFromParent();
|
|
|
|
/// eraseFromParent - This method unlinks 'this' from the containing basic
|
|
/// block and deletes it.
|
|
void eraseFromParent() {
|
|
delete removeFromParent();
|
|
}
|
|
|
|
/// findRegisterUseOperand() - Returns the MachineOperand that is a use of
|
|
/// the specific register or NULL if it is not found.
|
|
MachineOperand *findRegisterUseOperand(unsigned Reg);
|
|
|
|
/// copyKillDeadInfo - Copies kill / dead operand properties from MI.
|
|
///
|
|
void copyKillDeadInfo(const MachineInstr *MI);
|
|
|
|
//
|
|
// Debugging support
|
|
//
|
|
void print(std::ostream *OS, const TargetMachine *TM) const {
|
|
if (OS) print(*OS, TM);
|
|
}
|
|
void print(std::ostream &OS, const TargetMachine *TM) const;
|
|
void print(std::ostream &OS) const;
|
|
void print(std::ostream *OS) const { if (OS) print(*OS); }
|
|
void dump() const;
|
|
friend std::ostream& operator<<(std::ostream& os, const MachineInstr& minstr){
|
|
minstr.print(os);
|
|
return os;
|
|
}
|
|
|
|
//===--------------------------------------------------------------------===//
|
|
// Accessors to add operands when building up machine instructions.
|
|
//
|
|
|
|
/// addRegOperand - Add a register operand.
|
|
///
|
|
void addRegOperand(unsigned Reg, bool IsDef, bool IsImp = false,
|
|
bool IsKill = false, bool IsDead = false) {
|
|
MachineOperand &Op = AddNewOperand(IsImp);
|
|
Op.opType = MachineOperand::MO_Register;
|
|
Op.IsDef = IsDef;
|
|
Op.IsImp = IsImp;
|
|
Op.IsKill = IsKill;
|
|
Op.IsDead = IsDead;
|
|
Op.contents.RegNo = Reg;
|
|
Op.offset = 0;
|
|
}
|
|
|
|
/// addImmOperand - Add a zero extended constant argument to the
|
|
/// machine instruction.
|
|
///
|
|
void addImmOperand(int64_t Val) {
|
|
MachineOperand &Op = AddNewOperand();
|
|
Op.opType = MachineOperand::MO_Immediate;
|
|
Op.contents.immedVal = Val;
|
|
Op.offset = 0;
|
|
}
|
|
|
|
void addMachineBasicBlockOperand(MachineBasicBlock *MBB) {
|
|
MachineOperand &Op = AddNewOperand();
|
|
Op.opType = MachineOperand::MO_MachineBasicBlock;
|
|
Op.contents.MBB = MBB;
|
|
Op.offset = 0;
|
|
}
|
|
|
|
/// addFrameIndexOperand - Add an abstract frame index to the instruction
|
|
///
|
|
void addFrameIndexOperand(unsigned Idx) {
|
|
MachineOperand &Op = AddNewOperand();
|
|
Op.opType = MachineOperand::MO_FrameIndex;
|
|
Op.contents.immedVal = Idx;
|
|
Op.offset = 0;
|
|
}
|
|
|
|
/// addConstantPoolndexOperand - Add a constant pool object index to the
|
|
/// instruction.
|
|
///
|
|
void addConstantPoolIndexOperand(unsigned Idx, int Offset) {
|
|
MachineOperand &Op = AddNewOperand();
|
|
Op.opType = MachineOperand::MO_ConstantPoolIndex;
|
|
Op.contents.immedVal = Idx;
|
|
Op.offset = Offset;
|
|
}
|
|
|
|
/// addJumpTableIndexOperand - Add a jump table object index to the
|
|
/// instruction.
|
|
///
|
|
void addJumpTableIndexOperand(unsigned Idx) {
|
|
MachineOperand &Op = AddNewOperand();
|
|
Op.opType = MachineOperand::MO_JumpTableIndex;
|
|
Op.contents.immedVal = Idx;
|
|
Op.offset = 0;
|
|
}
|
|
|
|
void addGlobalAddressOperand(GlobalValue *GV, int Offset) {
|
|
MachineOperand &Op = AddNewOperand();
|
|
Op.opType = MachineOperand::MO_GlobalAddress;
|
|
Op.contents.GV = GV;
|
|
Op.offset = Offset;
|
|
}
|
|
|
|
/// addExternalSymbolOperand - Add an external symbol operand to this instr
|
|
///
|
|
void addExternalSymbolOperand(const char *SymName) {
|
|
MachineOperand &Op = AddNewOperand();
|
|
Op.opType = MachineOperand::MO_ExternalSymbol;
|
|
Op.contents.SymbolName = SymName;
|
|
Op.offset = 0;
|
|
}
|
|
|
|
//===--------------------------------------------------------------------===//
|
|
// Accessors used to modify instructions in place.
|
|
//
|
|
|
|
/// setInstrDescriptor - Replace the instruction descriptor (thus opcode) of
|
|
/// the current instruction with a new one.
|
|
///
|
|
void setInstrDescriptor(const TargetInstrDescriptor &tid) { TID = &tid; }
|
|
|
|
/// RemoveOperand - Erase an operand from an instruction, leaving it with one
|
|
/// fewer operand than it started with.
|
|
///
|
|
void RemoveOperand(unsigned i) {
|
|
Operands.erase(Operands.begin()+i);
|
|
}
|
|
private:
|
|
MachineOperand &AddNewOperand(bool IsImp = false) {
|
|
assert((IsImp || !OperandsComplete()) &&
|
|
"Trying to add an operand to a machine instr that is already done!");
|
|
if (NumImplicitOps == 0) { // This is true most of the time.
|
|
Operands.push_back(MachineOperand());
|
|
return Operands.back();
|
|
} else {
|
|
return *Operands.insert(Operands.begin()+Operands.size()-NumImplicitOps,
|
|
MachineOperand());
|
|
}
|
|
}
|
|
|
|
/// addImplicitDefUseOperands - Add all implicit def and use operands to
|
|
/// this instruction.
|
|
void addImplicitDefUseOperands();
|
|
};
|
|
|
|
//===----------------------------------------------------------------------===//
|
|
// Debugging Support
|
|
|
|
std::ostream& operator<<(std::ostream &OS, const MachineInstr &MI);
|
|
std::ostream& operator<<(std::ostream &OS, const MachineOperand &MO);
|
|
|
|
} // End llvm namespace
|
|
|
|
#endif
|