#include <Instructions.h>

Inheritance diagram for llvm::BranchInst:

Collaboration diagram for llvm::BranchInst:

Public Member Functions
	DECLARE_TRANSPARENT_OPERAND_ACCESSORS (Value)
	Transparently provide more efficient getOperand methods. More...

bool	isUnconditional () const

bool	isConditional () const

Value *	getCondition () const

void	setCondition (Value *V)

unsigned	getNumSuccessors () const

BasicBlock *	getSuccessor (unsigned i) const

void	setSuccessor (unsigned idx, BasicBlock *NewSucc)

void	swapSuccessors ()
	Swap the successors of this branch instruction. More...

Public Member Functions inherited from llvm::TerminatorInst
unsigned	getNumSuccessors () const

BasicBlock *	getSuccessor (unsigned idx) const

void	setSuccessor (unsigned idx, BasicBlock *B)

Public Member Functions inherited from llvm::Instruction
	~Instruction ()

Instruction *	use_back ()

const Instruction *	use_back () const

const BasicBlock *	getParent () const

BasicBlock *	getParent ()

void	removeFromParent ()

void	eraseFromParent ()

void	insertBefore (Instruction *InsertPos)

void	insertAfter (Instruction *InsertPos)

void	moveBefore (Instruction *MovePos)

unsigned	getOpcode () const
	getOpcode() returns a member of one of the enums like Instruction::Add. More...

const char *	getOpcodeName () const

bool	isTerminator () const

bool	isBinaryOp () const

bool	isShift ()

bool	isCast () const

bool	isLogicalShift () const

bool	isArithmeticShift () const
	isArithmeticShift - Return true if this is an arithmetic shift right. More...

bool	hasMetadata () const

bool	hasMetadataOtherThanDebugLoc () const

MDNode *	getMetadata (unsigned KindID) const

MDNode *	getMetadata (StringRef Kind) const

void	getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const

void	getAllMetadataOtherThanDebugLoc (SmallVectorImpl< std::pair< unsigned, MDNode * > > &MDs) const

void	setMetadata (unsigned KindID, MDNode *Node)

void	setMetadata (StringRef Kind, MDNode *Node)

void	setDebugLoc (const DebugLoc &Loc)
	setDebugLoc - Set the debug location information for this instruction. More...

const DebugLoc &	getDebugLoc () const
	getDebugLoc - Return the debug location for this node as a DebugLoc. More...

void	setHasUnsafeAlgebra (bool B)

void	setHasNoNaNs (bool B)

void	setHasNoInfs (bool B)

void	setHasNoSignedZeros (bool B)

void	setHasAllowReciprocal (bool B)

void	setFastMathFlags (FastMathFlags FMF)

bool	hasUnsafeAlgebra () const
	Determine whether the unsafe-algebra flag is set. More...

bool	hasNoNaNs () const
	Determine whether the no-NaNs flag is set. More...

bool	hasNoInfs () const
	Determine whether the no-infs flag is set. More...

bool	hasNoSignedZeros () const
	Determine whether the no-signed-zeros flag is set. More...

bool	hasAllowReciprocal () const
	Determine whether the allow-reciprocal flag is set. More...

FastMathFlags	getFastMathFlags () const

void	copyFastMathFlags (const Instruction *I)
	Copy I's fast-math flags. More...

bool	isAssociative () const

bool	isCommutative () const

bool	isIdempotent () const

bool	isNilpotent () const

bool	mayWriteToMemory () const

bool	mayReadFromMemory () const

bool	mayReadOrWriteMemory () const

bool	mayThrow () const

bool	mayReturn () const

bool	mayHaveSideEffects () const

Instruction *	clone () const

bool	isIdenticalTo (const Instruction *I) const

bool	isIdenticalToWhenDefined (const Instruction *I) const

bool	isSameOperationAs (const Instruction *I, unsigned flags=0) const
	Determine if one instruction is the same operation as another. More...

bool	isUsedOutsideOfBlock (const BasicBlock *BB) const

Public Member Functions inherited from llvm::User
	~User ()

void	operator delete (void *Usr)
	operator delete - free memory allocated for User and Use objects More...

void	operator delete (void *, unsigned)
	placement delete - required by std, but never called. More...

void	operator delete (void *, unsigned, bool)
	placement delete - required by std, but never called. More...

Value *	getOperand (unsigned i) const

void	setOperand (unsigned i, Value *Val)

const Use &	getOperandUse (unsigned i) const

Use &	getOperandUse (unsigned i)

unsigned	getNumOperands () const

op_iterator	op_begin ()

const_op_iterator	op_begin () const

op_iterator	op_end ()

const_op_iterator	op_end () const

value_op_iterator	value_op_begin ()

value_op_iterator	value_op_end ()

void	dropAllReferences ()

void	replaceUsesOfWith (Value From, Value To)

Public Member Functions inherited from llvm::Value
virtual	~Value ()

void	dump () const
	dump - Support for debugging, callable in GDB: V->dump() More...

void	print (raw_ostream &O, AssemblyAnnotationWriter *AAW=0) const

Type *	getType () const

LLVMContext &	getContext () const
	All values hold a context through their type. More...

bool	hasName () const

ValueName *	getValueName () const

void	setValueName (ValueName *VN)

StringRef	getName () const

void	setName (const Twine &Name)

void	takeName (Value *V)

void	replaceAllUsesWith (Value *V)

bool	use_empty () const

use_iterator	use_begin ()

const_use_iterator	use_begin () const

use_iterator	use_end ()

const_use_iterator	use_end () const

User *	use_back ()

const User *	use_back () const

bool	hasOneUse () const

bool	hasNUses (unsigned N) const

bool	hasNUsesOrMore (unsigned N) const

bool	isUsedInBasicBlock (const BasicBlock *BB) const

unsigned	getNumUses () const

void	addUse (Use &U)

unsigned	getValueID () const

unsigned	getRawSubclassOptionalData () const

void	clearSubclassOptionalData ()

bool	hasSameSubclassOptionalData (const Value *V) const

void	intersectOptionalDataWith (const Value *V)

bool	hasValueHandle () const

Value *	stripPointerCasts ()
	Strips off any unneeded pointer casts, all-zero GEPs and aliases from the specified value, returning the original uncasted value. More...

const Value *	stripPointerCasts () const

Value *	stripPointerCastsNoFollowAliases ()
	Strips off any unneeded pointer casts and all-zero GEPs from the specified value, returning the original uncasted value. More...

const Value *	stripPointerCastsNoFollowAliases () const

Value *	stripInBoundsConstantOffsets ()
	Strips off unneeded pointer casts and all-constant GEPs from the specified value, returning the original pointer value. More...

const Value *	stripInBoundsConstantOffsets () const

Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
	Strips like `stripInBoundsConstantOffsets` but also accumulates the constant offset stripped. More...

const Value *	stripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const

Value *	stripInBoundsOffsets ()
	Strips off unneeded pointer casts and any in-bounds offsets from the specified value, returning the original pointer value. More...

const Value *	stripInBoundsOffsets () const

bool	isDereferenceablePointer () const

Value *	DoPHITranslation (const BasicBlock CurBB, const BasicBlock PredBB)

const Value *	DoPHITranslation (const BasicBlock CurBB, const BasicBlock PredBB) const

void	mutateType (Type *Ty)

Public Member Functions inherited from llvm::ilist_node< Instruction >
Instruction *	getPrevNode ()
	Get the previous node, or 0 for the list head. More...

const Instruction *	getPrevNode () const
	Get the previous node, or 0 for the list head. More...

Instruction *	getNextNode ()
	Get the next node, or 0 for the list tail. More...

const Instruction *	getNextNode () const
	Get the next node, or 0 for the list tail. More...

Static Public Member Functions
static BranchInst *	Create (BasicBlock IfTrue, Instruction InsertBefore=0)

static BranchInst *	Create (BasicBlock IfTrue, BasicBlock IfFalse, Value Cond, Instruction InsertBefore=0)

static BranchInst *	Create (BasicBlock IfTrue, BasicBlock InsertAtEnd)

static BranchInst *	Create (BasicBlock IfTrue, BasicBlock IfFalse, Value Cond, BasicBlock InsertAtEnd)

static bool	classof (const Instruction *I)

static bool	classof (const Value *V)

Static Public Member Functions inherited from llvm::TerminatorInst
static bool	classof (const Instruction *I)

static bool	classof (const Value *V)

Static Public Member Functions inherited from llvm::Instruction
static const char *	getOpcodeName (unsigned OpCode)

static bool	isTerminator (unsigned OpCode)

static bool	isBinaryOp (unsigned Opcode)

static bool	isShift (unsigned Opcode)
	Determine if the Opcode is one of the shift instructions. More...

static bool	isCast (unsigned OpCode)
	Determine if the OpCode is one of the CastInst instructions. More...

static bool	isAssociative (unsigned op)

static bool	isCommutative (unsigned op)

static bool	isIdempotent (unsigned op)

static bool	isNilpotent (unsigned op)

static bool	classof (const Value *V)
	Methods for support type inquiry through isa, cast, and dyn_cast: More...

Static Public Member Functions inherited from llvm::User
static bool	classof (const Value *V)

Protected Member Functions
virtual BranchInst *	clone_impl () const

Protected Member Functions inherited from llvm::TerminatorInst
	TerminatorInst (Type Ty, Instruction::TermOps iType, Use Ops, unsigned NumOps, Instruction *InsertBefore=0)

	TerminatorInst (Type Ty, Instruction::TermOps iType, Use Ops, unsigned NumOps, BasicBlock *InsertAtEnd)

	~TerminatorInst ()

Protected Member Functions inherited from llvm::Instruction
void	setInstructionSubclassData (unsigned short D)

unsigned	getSubclassDataFromInstruction () const

	Instruction (Type Ty, unsigned iType, Use Ops, unsigned NumOps, Instruction *InsertBefore=0)

	Instruction (Type Ty, unsigned iType, Use Ops, unsigned NumOps, BasicBlock *InsertAtEnd)

Protected Member Functions inherited from llvm::User
void *	operator new (size_t s, unsigned Us)

	User (Type ty, unsigned vty, Use OpList, unsigned NumOps)

Use *	allocHungoffUses (unsigned) const

void	dropHungoffUses ()

template<int Idx>
Use &	Op ()

template<int Idx>
const Use &	Op () const

Protected Member Functions inherited from llvm::Value
virtual void	printCustom (raw_ostream &O) const

	Value (Type *Ty, unsigned scid)

unsigned short	getSubclassDataFromValue () const

void	setValueSubclassData (unsigned short D)

Protected Member Functions inherited from llvm::ilist_node< Instruction >
	ilist_node ()

Additional Inherited Members
Public Types inherited from llvm::Instruction
enum	OperationEquivalenceFlags { CompareIgnoringAlignment = 1<<0, CompareUsingScalarTypes = 1<<1 }

enum	TermOps

enum	BinaryOps

enum	MemoryOps

enum	CastOps

enum	OtherOps

Public Types inherited from llvm::User
typedef Use *	op_iterator

typedef const Use *	const_op_iterator

Public Types inherited from llvm::Value
enum	ValueTy { ArgumentVal, BasicBlockVal, FunctionVal, GlobalAliasVal, GlobalVariableVal, UndefValueVal, BlockAddressVal, ConstantExprVal, ConstantAggregateZeroVal, ConstantDataArrayVal, ConstantDataVectorVal, ConstantIntVal, ConstantFPVal, ConstantArrayVal, ConstantStructVal, ConstantVectorVal, ConstantPointerNullVal, MDNodeVal, MDStringVal, InlineAsmVal, PseudoSourceValueVal, FixedStackPseudoSourceValueVal, InstructionVal, ConstantFirstVal = FunctionVal, ConstantLastVal = ConstantPointerNullVal }

typedef value_use_iterator< User >	use_iterator

typedef value_use_iterator < const User >	const_use_iterator

Static Public Attributes inherited from llvm::Value
static const unsigned	MaximumAlignment = 1u << 29

Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static Use &	OpFrom (const U *that)

Protected Attributes inherited from llvm::User
Use *	OperandList

unsigned	NumOperands

Protected Attributes inherited from llvm::Value
unsigned char	SubclassOptionalData: 7

Detailed Description

BranchInst - Conditional or Unconditional Branch instruction.

Definition at line 2350 of file Instructions.h.

Member Function Documentation

static bool llvm::BranchInst::classof ( const Instruction * I )

inlinestatic

Definition at line 2424 of file Instructions.h.

References llvm::Instruction::getOpcode().

static bool llvm::BranchInst::classof ( const Value * V )

inlinestatic

Definition at line 2427 of file Instructions.h.

BranchInst * BranchInst::clone_impl ( ) const

protectedvirtual

Implements llvm::TerminatorInst.

Definition at line 3660 of file Instructions.cpp.

References llvm::User::getNumOperands().

static BranchInst* llvm::BranchInst::Create	(	BasicBlock *	IfTrue,
		Instruction *	InsertBefore = `0`
	)

inlinestatic

static BranchInst* llvm::BranchInst::Create	(	BasicBlock *	IfTrue,
		BasicBlock *	IfFalse,
		Value *	Cond,
		Instruction *	InsertBefore = `0`
	)

inlinestatic

Definition at line 2376 of file Instructions.h.

static BranchInst* llvm::BranchInst::Create	(	BasicBlock *	IfTrue,
		BasicBlock *	InsertAtEnd
	)

inlinestatic

Definition at line 2380 of file Instructions.h.

static BranchInst* llvm::BranchInst::Create	(	BasicBlock *	IfTrue,
		BasicBlock *	IfFalse,
		Value *	Cond,
		BasicBlock *	InsertAtEnd
	)

inlinestatic

Definition at line 2383 of file Instructions.h.

llvm::BranchInst::DECLARE_TRANSPARENT_OPERAND_ACCESSORS ( Value )

Transparently provide more efficient getOperand methods.

unsigned llvm::BranchInst::getNumSuccessors ( ) const

inline

Definition at line 2404 of file Instructions.h.

BasicBlock* llvm::BranchInst::getSuccessor ( unsigned i ) const

inline

bool llvm::BranchInst::isConditional ( ) const

inline

Definition at line 2392 of file Instructions.h.

Referenced by AddReachableCodeToWorklist(), llvm::CloneAndPruneFunctionInto(), DominatesMergePoint(), ExtractBranchMetadata(), llvm::FoldBranchToCommonDest(), llvm::GetIfCondition(), isProfitableToFoldUnconditional(), SimplifyCondBranchToCondBranch(), SimplifyCondBranchToTwoReturns(), swapSuccessors(), and WriteInstruction().

bool llvm::BranchInst::isUnconditional ( ) const

inline

Definition at line 2391 of file Instructions.h.

Referenced by FindPHIForConditionForwarding(), llvm::FoldBranchToCommonDest(), llvm::ScalarEvolution::isLoopBackedgeGuardedByCond(), llvm::ScalarEvolution::isLoopEntryGuardedByCond(), isProfitableToFoldUnconditional(), removeUndefIntroducingPredecessor(), llvm::FastISel::SelectOperator(), SinkThenElseCodeToEnd(), llvm::UnrollLoop(), and llvm::Interpreter::visitBranchInst().

void llvm::BranchInst::setCondition ( Value * V )

inline

Definition at line 2399 of file Instructions.h.

Referenced by llvm::FoldBranchToCommonDest(), SimplifyCondBranchToCondBranch(), and llvm::InstCombiner::visitBranchInst().

void llvm::BranchInst::setSuccessor	(	unsigned	idx,
		BasicBlock *	NewSucc
	)

inline

Definition at line 2411 of file Instructions.h.

Referenced by llvm::FoldBranchToCommonDest(), SimplifyCondBranchToCondBranch(), and llvm::UnrollLoop().

void BranchInst::swapSuccessors ( )

Swap the successors of this branch instruction.

Swaps the successors of the branch instruction. This also swaps any branch weight metadata associated with the instruction so that it continues to map correctly to each operand.

Definition at line 786 of file Instructions.cpp.

References llvm::MDNode::get(), llvm::Instruction::getMetadata(), isConditional(), llvm::LLVMContext::MD_prof, llvm::User::Op(), llvm::Instruction::setMetadata(), and llvm::swap().

Referenced by llvm::FoldBranchToCommonDest(), and llvm::InstCombiner::visitBranchInst().

The documentation for this class was generated from the following files:

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation