#ifndef LLVM_INSTRUCTIONS_H
#define LLVM_INSTRUCTIONS_H
-#include "llvm/Instruction.h"
#include "llvm/InstrTypes.h"
namespace llvm {
class BasicBlock;
class ConstantInt;
class PointerType;
+class PackedType;
//===----------------------------------------------------------------------===//
// AllocationInst Class
/// AllocaInst.
///
class AllocationInst : public UnaryInstruction {
+ unsigned Alignment;
protected:
- AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy,
+ AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
const std::string &Name = "", Instruction *InsertBefore = 0);
- AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy,
+ AllocationInst(const Type *Ty, Value *ArraySize, unsigned iTy, unsigned Align,
const std::string &Name, BasicBlock *InsertAtEnd);
-
public:
+ // Out of line virtual method, so the vtable, etc has a home.
+ virtual ~AllocationInst();
/// isArrayAllocation - Return true if there is an allocation size parameter
/// to the allocation instruction that is not 1.
///
const Type *getAllocatedType() const;
+ /// getAlignment - Return the alignment of the memory that is being allocated
+ /// by the instruction.
+ ///
+ unsigned getAlignment() const { return Alignment; }
+ void setAlignment(unsigned Align) {
+ assert((Align & (Align-1)) == 0 && "Alignment is not a power of 2!");
+ Alignment = Align;
+ }
+
virtual Instruction *clone() const = 0;
// Methods for support type inquiry through isa, cast, and dyn_cast:
explicit MallocInst(const Type *Ty, Value *ArraySize = 0,
const std::string &Name = "",
Instruction *InsertBefore = 0)
- : AllocationInst(Ty, ArraySize, Malloc, Name, InsertBefore) {}
+ : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertBefore) {}
MallocInst(const Type *Ty, Value *ArraySize, const std::string &Name,
BasicBlock *InsertAtEnd)
- : AllocationInst(Ty, ArraySize, Malloc, Name, InsertAtEnd) {}
+ : AllocationInst(Ty, ArraySize, Malloc, 0, Name, InsertAtEnd) {}
+
+ MallocInst(const Type *Ty, const std::string &Name,
+ Instruction *InsertBefore = 0)
+ : AllocationInst(Ty, 0, Malloc, 0, Name, InsertBefore) {}
+ MallocInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
+ : AllocationInst(Ty, 0, Malloc, 0, Name, InsertAtEnd) {}
+
+ MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
+ const std::string &Name, BasicBlock *InsertAtEnd)
+ : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertAtEnd) {}
+ MallocInst(const Type *Ty, Value *ArraySize, unsigned Align,
+ const std::string &Name = "",
+ Instruction *InsertBefore = 0)
+ : AllocationInst(Ty, ArraySize, Malloc, Align, Name, InsertBefore) {}
virtual MallocInst *clone() const;
explicit AllocaInst(const Type *Ty, Value *ArraySize = 0,
const std::string &Name = "",
Instruction *InsertBefore = 0)
- : AllocationInst(Ty, ArraySize, Alloca, Name, InsertBefore) {}
+ : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertBefore) {}
AllocaInst(const Type *Ty, Value *ArraySize, const std::string &Name,
BasicBlock *InsertAtEnd)
- : AllocationInst(Ty, ArraySize, Alloca, Name, InsertAtEnd) {}
+ : AllocationInst(Ty, ArraySize, Alloca, 0, Name, InsertAtEnd) {}
+
+ AllocaInst(const Type *Ty, const std::string &Name,
+ Instruction *InsertBefore = 0)
+ : AllocationInst(Ty, 0, Alloca, 0, Name, InsertBefore) {}
+ AllocaInst(const Type *Ty, const std::string &Name, BasicBlock *InsertAtEnd)
+ : AllocationInst(Ty, 0, Alloca, 0, Name, InsertAtEnd) {}
+
+ AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
+ const std::string &Name = "", Instruction *InsertBefore = 0)
+ : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertBefore) {}
+ AllocaInst(const Type *Ty, Value *ArraySize, unsigned Align,
+ const std::string &Name, BasicBlock *InsertAtEnd)
+ : AllocationInst(Ty, ArraySize, Alloca, Align, Name, InsertAtEnd) {}
virtual AllocaInst *clone() const;
public:
LoadInst(Value *Ptr, const std::string &Name, Instruction *InsertBefore);
LoadInst(Value *Ptr, const std::string &Name, BasicBlock *InsertAtEnd);
- LoadInst(Value *Ptr, const std::string &Name = "", bool isVolatile = false,
- Instruction *InsertBefore = 0);
+ explicit LoadInst(Value *Ptr, const std::string &Name = "",
+ bool isVolatile = false, Instruction *InsertBefore = 0);
LoadInst(Value *Ptr, const std::string &Name, bool isVolatile,
BasicBlock *InsertAtEnd);
///
static BinaryOps getSwappedCondition(BinaryOps Opcode);
+ /// isEquality - Return true if this comparison is an ==/!= comparison.
+ ///
+ bool isEquality() const {
+ return getOpcode() == SetEQ || getOpcode() == SetNE;
+ }
+
+ /// isRelational - Return true if this comparison is a </>/<=/>= comparison.
+ ///
+ bool isRelational() const {
+ return !isEquality();
+ }
// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const SetCondInst *) { return true; }
: UnaryInstruction(Ty, Cast, S, Name, InsertAtEnd) {
}
+ /// isTruncIntCast - Return true if this is a truncating integer cast
+ /// instruction, e.g. a cast from long to uint.
+ bool isTruncIntCast() const;
+
+
virtual CastInst *clone() const;
// Methods for support type inquiry through isa, cast, and dyn_cast:
//===----------------------------------------------------------------------===//
/// CallInst - This class represents a function call, abstracting a target
-/// machine's calling convention. This class uses the SubClassData field to
-/// indicate whether or not this is a tail call.
+/// machine's calling convention. This class uses low bit of the SubClassData
+/// field to indicate whether or not this is a tail call. The rest of the bits
+/// hold the calling convention of the call.
///
class CallInst : public Instruction {
CallInst(const CallInst &CI);
BasicBlock *InsertAtEnd);
explicit CallInst(Value *F, const std::string &Name = "",
Instruction *InsertBefore = 0);
- explicit CallInst(Value *F, const std::string &Name,
- BasicBlock *InsertAtEnd);
+ CallInst(Value *F, const std::string &Name, BasicBlock *InsertAtEnd);
~CallInst();
virtual CallInst *clone() const;
bool mayWriteToMemory() const { return true; }
- bool isTailCall() const { return SubclassData; }
- void setTailCall(bool isTailCall) { SubclassData = isTailCall; }
+ bool isTailCall() const { return SubclassData & 1; }
+ void setTailCall(bool isTailCall = true) {
+ SubclassData = (SubclassData & ~1) | unsigned(isTailCall);
+ }
+
+ /// getCallingConv/setCallingConv - Get or set the calling convention of this
+ /// function call.
+ unsigned getCallingConv() const { return SubclassData >> 1; }
+ void setCallingConv(unsigned CC) {
+ SubclassData = (SubclassData & 1) | (CC << 1);
+ }
/// getCalledFunction - Return the function being called by this instruction
/// if it is a direct call. If it is a call through a function pointer,
/// return null.
Function *getCalledFunction() const {
- return (Function*)dyn_cast<Function>(getOperand(0));
+ return static_cast<Function*>(dyn_cast<Function>(getOperand(0)));
}
// getCalledValue - Get a pointer to a method that is invoked by this inst.
}
unsigned getNumOperands() const { return 2; }
+ /// isLogicalShift - Return true if this is a logical shift left or a logical
+ /// shift right.
+ bool isLogicalShift() const;
+
+ /// isArithmeticShift - Return true if this is a sign-extending shift right
+ /// operation.
+ bool isArithmeticShift() const {
+ return !isLogicalShift();
+ }
+
+
virtual ShiftInst *clone() const;
// Methods for support type inquiry through isa, cast, and dyn_cast:
}
};
+//===----------------------------------------------------------------------===//
+// VAArgInst Class
+//===----------------------------------------------------------------------===//
+
+/// VAArgInst - This class represents the va_arg llvm instruction, which returns
+/// an argument of the specified type given a va_list and increments that list
+///
+class VAArgInst : public UnaryInstruction {
+ VAArgInst(const VAArgInst &VAA)
+ : UnaryInstruction(VAA.getType(), VAArg, VAA.getOperand(0)) {}
+public:
+ VAArgInst(Value *List, const Type *Ty, const std::string &Name = "",
+ Instruction *InsertBefore = 0)
+ : UnaryInstruction(Ty, VAArg, List, Name, InsertBefore) {
+ }
+ VAArgInst(Value *List, const Type *Ty, const std::string &Name,
+ BasicBlock *InsertAtEnd)
+ : UnaryInstruction(Ty, VAArg, List, Name, InsertAtEnd) {
+ }
+
+ virtual VAArgInst *clone() const;
+ bool mayWriteToMemory() const { return true; }
+
+ // Methods for support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const VAArgInst *) { return true; }
+ static inline bool classof(const Instruction *I) {
+ return I->getOpcode() == VAArg;
+ }
+ static inline bool classof(const Value *V) {
+ return isa<Instruction>(V) && classof(cast<Instruction>(V));
+ }
+};
//===----------------------------------------------------------------------===//
-// VANextInst Class
+// ExtractElementInst Class
//===----------------------------------------------------------------------===//
-/// VANextInst - This class represents the va_next llvm instruction, which
-/// advances a vararg list passed an argument of the specified type, returning
-/// the resultant list.
+/// ExtractElementInst - This instruction extracts a single (scalar)
+/// element from a PackedType value
///
-class VANextInst : public UnaryInstruction {
- PATypeHolder ArgTy;
- VANextInst(const VANextInst &VAN)
- : UnaryInstruction(VAN.getType(), VANext, VAN.getOperand(0)),
- ArgTy(VAN.getArgType()) {
+class ExtractElementInst : public Instruction {
+ Use Ops[2];
+ ExtractElementInst(const ExtractElementInst &EE) :
+ Instruction(EE.getType(), ExtractElement, Ops, 2) {
+ Ops[0].init(EE.Ops[0], this);
+ Ops[1].init(EE.Ops[1], this);
}
public:
- VANextInst(Value *List, const Type *Ty, const std::string &Name = "",
- Instruction *InsertBefore = 0)
- : UnaryInstruction(List->getType(), VANext, List, Name, InsertBefore),
- ArgTy(Ty) {
+ ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name = "",
+ Instruction *InsertBefore = 0);
+ ExtractElementInst(Value *Vec, unsigned Idx, const std::string &Name = "",
+ Instruction *InsertBefore = 0);
+ ExtractElementInst(Value *Vec, Value *Idx, const std::string &Name,
+ BasicBlock *InsertAtEnd);
+ ExtractElementInst(Value *Vec, unsigned Idx, const std::string &Name,
+ BasicBlock *InsertAtEnd);
+
+ /// isValidOperands - Return true if an extractelement instruction can be
+ /// formed with the specified operands.
+ static bool isValidOperands(const Value *Vec, const Value *Idx);
+
+ virtual ExtractElementInst *clone() const;
+
+ virtual bool mayWriteToMemory() const { return false; }
+
+ /// Transparently provide more efficient getOperand methods.
+ Value *getOperand(unsigned i) const {
+ assert(i < 2 && "getOperand() out of range!");
+ return Ops[i];
}
- VANextInst(Value *List, const Type *Ty, const std::string &Name,
- BasicBlock *InsertAtEnd)
- : UnaryInstruction(List->getType(), VANext, List, Name, InsertAtEnd),
- ArgTy(Ty) {
+ void setOperand(unsigned i, Value *Val) {
+ assert(i < 2 && "setOperand() out of range!");
+ Ops[i] = Val;
}
+ unsigned getNumOperands() const { return 2; }
- const Type *getArgType() const { return ArgTy; }
+ // Methods for support type inquiry through isa, cast, and dyn_cast:
+ static inline bool classof(const ExtractElementInst *) { return true; }
+ static inline bool classof(const Instruction *I) {
+ return I->getOpcode() == Instruction::ExtractElement;
+ }
+ static inline bool classof(const Value *V) {
+ return isa<Instruction>(V) && classof(cast<Instruction>(V));
+ }
+};
- virtual VANextInst *clone() const;
+//===----------------------------------------------------------------------===//
+// InsertElementInst Class
+//===----------------------------------------------------------------------===//
+
+/// InsertElementInst - This instruction inserts a single (scalar)
+/// element into a PackedType value
+///
+class InsertElementInst : public Instruction {
+ Use Ops[3];
+ InsertElementInst(const InsertElementInst &IE);
+public:
+ InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
+ const std::string &Name = "",Instruction *InsertBefore = 0);
+ InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
+ const std::string &Name = "",Instruction *InsertBefore = 0);
+ InsertElementInst(Value *Vec, Value *NewElt, Value *Idx,
+ const std::string &Name, BasicBlock *InsertAtEnd);
+ InsertElementInst(Value *Vec, Value *NewElt, unsigned Idx,
+ const std::string &Name, BasicBlock *InsertAtEnd);
+
+ /// isValidOperands - Return true if an insertelement instruction can be
+ /// formed with the specified operands.
+ static bool isValidOperands(const Value *Vec, const Value *NewElt,
+ const Value *Idx);
+
+ virtual InsertElementInst *clone() const;
+
+ virtual bool mayWriteToMemory() const { return false; }
+
+ /// getType - Overload to return most specific packed type.
+ ///
+ inline const PackedType *getType() const {
+ return reinterpret_cast<const PackedType*>(Instruction::getType());
+ }
+
+ /// Transparently provide more efficient getOperand methods.
+ Value *getOperand(unsigned i) const {
+ assert(i < 3 && "getOperand() out of range!");
+ return Ops[i];
+ }
+ void setOperand(unsigned i, Value *Val) {
+ assert(i < 3 && "setOperand() out of range!");
+ Ops[i] = Val;
+ }
+ unsigned getNumOperands() const { return 3; }
// Methods for support type inquiry through isa, cast, and dyn_cast:
- static inline bool classof(const VANextInst *) { return true; }
+ static inline bool classof(const InsertElementInst *) { return true; }
static inline bool classof(const Instruction *I) {
- return I->getOpcode() == VANext;
+ return I->getOpcode() == Instruction::InsertElement;
}
static inline bool classof(const Value *V) {
return isa<Instruction>(V) && classof(cast<Instruction>(V));
}
};
-
//===----------------------------------------------------------------------===//
-// VAArgInst Class
+// ShuffleVectorInst Class
//===----------------------------------------------------------------------===//
-/// VAArgInst - This class represents the va_arg llvm instruction, which returns
-/// an argument of the specified type given a va_list.
+/// ShuffleVectorInst - This instruction constructs a fixed permutation of two
+/// input vectors.
///
-class VAArgInst : public UnaryInstruction {
- VAArgInst(const VAArgInst &VAA)
- : UnaryInstruction(VAA.getType(), VAArg, VAA.getOperand(0)) {}
+class ShuffleVectorInst : public Instruction {
+ Use Ops[3];
+ ShuffleVectorInst(const ShuffleVectorInst &IE);
public:
- VAArgInst(Value *List, const Type *Ty, const std::string &Name = "",
- Instruction *InsertBefore = 0)
- : UnaryInstruction(Ty, VAArg, List, Name, InsertBefore) {
- }
- VAArgInst(Value *List, const Type *Ty, const std::string &Name,
- BasicBlock *InsertAtEnd)
- : UnaryInstruction(Ty, VAArg, List, Name, InsertAtEnd) {
+ ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
+ const std::string &Name = "", Instruction *InsertBefor = 0);
+ ShuffleVectorInst(Value *V1, Value *V2, Value *Mask,
+ const std::string &Name, BasicBlock *InsertAtEnd);
+
+ /// isValidOperands - Return true if a shufflevector instruction can be
+ /// formed with the specified operands.
+ static bool isValidOperands(const Value *V1, const Value *V2,
+ const Value *Mask);
+
+ virtual ShuffleVectorInst *clone() const;
+
+ virtual bool mayWriteToMemory() const { return false; }
+
+ /// getType - Overload to return most specific packed type.
+ ///
+ inline const PackedType *getType() const {
+ return reinterpret_cast<const PackedType*>(Instruction::getType());
}
- virtual VAArgInst *clone() const;
+ /// Transparently provide more efficient getOperand methods.
+ Value *getOperand(unsigned i) const {
+ assert(i < 3 && "getOperand() out of range!");
+ return Ops[i];
+ }
+ void setOperand(unsigned i, Value *Val) {
+ assert(i < 3 && "setOperand() out of range!");
+ Ops[i] = Val;
+ }
+ unsigned getNumOperands() const { return 3; }
// Methods for support type inquiry through isa, cast, and dyn_cast:
- static inline bool classof(const VAArgInst *) { return true; }
+ static inline bool classof(const ShuffleVectorInst *) { return true; }
static inline bool classof(const Instruction *I) {
- return I->getOpcode() == VAArg;
+ return I->getOpcode() == Instruction::ShuffleVector;
}
static inline bool classof(const Value *V) {
return isa<Instruction>(V) && classof(cast<Instruction>(V));
}
};
+
//===----------------------------------------------------------------------===//
// PHINode Class
//===----------------------------------------------------------------------===//
unsigned ReservedSpace;
PHINode(const PHINode &PN);
public:
- PHINode(const Type *Ty, const std::string &Name = "",
- Instruction *InsertBefore = 0)
+ explicit PHINode(const Type *Ty, const std::string &Name = "",
+ Instruction *InsertBefore = 0)
: Instruction(Ty, Instruction::PHI, 0, 0, Name, InsertBefore),
ReservedSpace(0) {
}
///
unsigned getNumIncomingValues() const { return getNumOperands()/2; }
- /// getIncomingValue - Return incoming value #x
+ /// getIncomingValue - Return incoming value number x
///
Value *getIncomingValue(unsigned i) const {
assert(i*2 < getNumOperands() && "Invalid value number!");
return i*2;
}
- /// getIncomingBlock - Return incoming basic block #x
+ /// getIncomingBlock - Return incoming basic block number x
///
BasicBlock *getIncomingBlock(unsigned i) const {
return reinterpret_cast<BasicBlock*>(getOperand(i*2+1));
return getIncomingValue(getBasicBlockIndex(BB));
}
+ /// hasConstantValue - If the specified PHI node always merges together the
+ /// same value, return the value, otherwise return null.
+ ///
+ Value *hasConstantValue(bool AllowNonDominatingInstruction = false) const;
+
/// Methods for support type inquiry through isa, cast, and dyn_cast:
static inline bool classof(const PHINode *) { return true; }
static inline bool classof(const Instruction *I) {
//
// NOTE: If the Value* passed is of type void then the constructor behaves as
// if it was passed NULL.
- ReturnInst(Value *retVal = 0, Instruction *InsertBefore = 0)
+ explicit ReturnInst(Value *retVal = 0, Instruction *InsertBefore = 0)
: TerminatorInst(Instruction::Ret, &RetVal, 0, InsertBefore) {
init(retVal);
}
: TerminatorInst(Instruction::Ret, &RetVal, 0, InsertAtEnd) {
init(retVal);
}
- ReturnInst(BasicBlock *InsertAtEnd)
+ explicit ReturnInst(BasicBlock *InsertAtEnd)
: TerminatorInst(Instruction::Ret, &RetVal, 0, InsertAtEnd) {
}
// BranchInst(BB* T, BB *F, Value *C, Inst *I) - 'br C, T, F', insert before I
// BranchInst(BB* B, BB *I) - 'br B' insert at end
// BranchInst(BB* T, BB *F, Value *C, BB *I) - 'br C, T, F', insert at end
- BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0)
+ explicit BranchInst(BasicBlock *IfTrue, Instruction *InsertBefore = 0)
: TerminatorInst(Instruction::Br, Ops, 1, InsertBefore) {
assert(IfTrue != 0 && "Branch destination may not be null!");
Ops[0].init(reinterpret_cast<Value*>(IfTrue), this);
return 0;
}
+ /// findCaseDest - Finds the unique case value for a given successor. Returns
+ /// null if the successor is not found, not unique, or is the default case.
+ ConstantInt *findCaseDest(BasicBlock *BB) {
+ if (BB == getDefaultDest()) return NULL;
+
+ ConstantInt *CI = NULL;
+ for (unsigned i = 1, e = getNumCases(); i != e; ++i) {
+ if (getSuccessor(i) == BB) {
+ if (CI) return NULL; // Multiple cases lead to BB.
+ else CI = getCaseValue(i);
+ }
+ }
+ return CI;
+ }
+
/// addCase - Add an entry to the switch instruction...
///
void addCase(ConstantInt *OnVal, BasicBlock *Dest);
// successor.
inline ConstantInt *getSuccessorValue(unsigned idx) const {
assert(idx < getNumSuccessors() && "Successor # out of range!");
- return (ConstantInt*)getOperand(idx*2);
+ return reinterpret_cast<ConstantInt*>(getOperand(idx*2));
}
// Methods for support type inquiry through isa, cast, and dyn_cast:
//===----------------------------------------------------------------------===//
//===---------------------------------------------------------------------------
-/// InvokeInst - Invoke instruction
+
+/// InvokeInst - Invoke instruction. The SubclassData field is used to hold the
+/// calling convention of the call.
///
class InvokeInst : public TerminatorInst {
InvokeInst(const InvokeInst &BI);
bool mayWriteToMemory() const { return true; }
+ /// getCallingConv/setCallingConv - Get or set the calling convention of this
+ /// function call.
+ unsigned getCallingConv() const { return SubclassData; }
+ void setCallingConv(unsigned CC) {
+ SubclassData = CC;
+ }
+
/// getCalledFunction - Return the function called, or null if this is an
/// indirect function invocation.
///
///
class UnwindInst : public TerminatorInst {
public:
- UnwindInst(Instruction *InsertBefore = 0)
+ explicit UnwindInst(Instruction *InsertBefore = 0)
: TerminatorInst(Instruction::Unwind, 0, 0, InsertBefore) {
}
- UnwindInst(BasicBlock *InsertAtEnd)
+ explicit UnwindInst(BasicBlock *InsertAtEnd)
: TerminatorInst(Instruction::Unwind, 0, 0, InsertAtEnd) {
}
///
class UnreachableInst : public TerminatorInst {
public:
- UnreachableInst(Instruction *InsertBefore = 0)
+ explicit UnreachableInst(Instruction *InsertBefore = 0)
: TerminatorInst(Instruction::Unreachable, 0, 0, InsertBefore) {
}
- UnreachableInst(BasicBlock *InsertAtEnd)
+ explicit UnreachableInst(BasicBlock *InsertAtEnd)
: TerminatorInst(Instruction::Unreachable, 0, 0, InsertAtEnd) {
}