LLVM API Documentation

Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions
llvm::SwitchInst Class Reference

#include <Instructions.h>

Inheritance diagram for llvm::SwitchInst:
Inheritance graph
[legend]
Collaboration diagram for llvm::SwitchInst:
Collaboration graph
[legend]

List of all members.

Classes

class  CaseIt
class  CaseIteratorT

Public Types

typedef CaseIteratorT< const
SwitchInst, const ConstantInt,
const BasicBlock
ConstCaseIt

Public Member Functions

 ~SwitchInst ()
 DECLARE_TRANSPARENT_OPERAND_ACCESSORS (Value)
 Provide fast operand accessors.
ValuegetCondition () const
void setCondition (Value *V)
BasicBlockgetDefaultDest () const
void setDefaultDest (BasicBlock *DefaultCase)
unsigned getNumCases () const
CaseIt case_begin ()
ConstCaseIt case_begin () const
CaseIt case_end ()
ConstCaseIt case_end () const
CaseIt case_default ()
ConstCaseIt case_default () const
CaseIt findCaseValue (const ConstantInt *C)
ConstCaseIt findCaseValue (const ConstantInt *C) const
ConstantIntfindCaseDest (BasicBlock *BB)
void addCase (ConstantInt *OnVal, BasicBlock *Dest)
void removeCase (CaseIt i)
unsigned getNumSuccessors () const
BasicBlockgetSuccessor (unsigned idx) const
void setSuccessor (unsigned idx, BasicBlock *NewSucc)

Static Public Member Functions

static SwitchInstCreate (Value *Value, BasicBlock *Default, unsigned NumCases, Instruction *InsertBefore=nullptr)
static SwitchInstCreate (Value *Value, BasicBlock *Default, unsigned NumCases, BasicBlock *InsertAtEnd)
static bool classof (const Instruction *I)
static bool classof (const Value *V)
 Methods for support type inquiry through isa, cast, and dyn_cast:

Static Public Attributes

static const unsigned DefaultPseudoIndex = static_cast<unsigned>(~0L-1)

Protected Member Functions

SwitchInstclone_impl () const override

Detailed Description

SwitchInst - Multiway switch

Definition at line 2518 of file Instructions.h.


Member Typedef Documentation

Definition at line 2641 of file Instructions.h.


Constructor & Destructor Documentation

Definition at line 3391 of file Instructions.cpp.

References llvm::User::dropHungoffUses().


Member Function Documentation

void SwitchInst::addCase ( ConstantInt OnVal,
BasicBlock Dest 
)

addCase - Add an entry to the switch instruction... Note: This action invalidates case_end(). Old case_end() iterator will point to the added case.

addCase - Add an entry to the switch instruction...

Definition at line 3398 of file Instructions.cpp.

References getNumCases(), llvm::User::NumOperands, llvm::SwitchInst::CaseIt::setSuccessor(), and llvm::SwitchInst::CaseIt::setValue().

Referenced by SimplifyBranchOnICmpChain(), and TryToSimplifyUncondBranchWithICmpInIt().

Returns a read-only iterator that points to the first case in the SwitchInst.

Definition at line 2704 of file Instructions.h.

Returns an iterator that points to the default case. Note: this iterator allows to resolve successor only. Attempt to resolve case value causes an assertion. Also note, that increment and decrement also causes an assertion and makes iterator invalid.

Definition at line 2723 of file Instructions.h.

Referenced by EliminateDeadSwitchCases(), and TryToSimplifyUncondBranchWithICmpInIt().

Definition at line 2726 of file Instructions.h.

Returns a read-only iterator that points one past the last in the SwitchInst.

Definition at line 2715 of file Instructions.h.

static bool llvm::SwitchInst::classof ( const Instruction I) [inline, static]

Reimplemented from llvm::TerminatorInst.

Definition at line 2787 of file Instructions.h.

References llvm::Instruction::getOpcode().

static bool llvm::SwitchInst::classof ( const Value V) [inline, static]

Methods for support type inquiry through isa, cast, and dyn_cast:

Reimplemented from llvm::TerminatorInst.

Definition at line 2790 of file Instructions.h.

SwitchInst * SwitchInst::clone_impl ( ) const [override, protected, virtual]

Implements llvm::TerminatorInst.

Definition at line 3719 of file Instructions.cpp.

static SwitchInst* llvm::SwitchInst::Create ( Value Value,
BasicBlock Default,
unsigned  NumCases,
Instruction InsertBefore = nullptr 
) [inline, static]
static SwitchInst* llvm::SwitchInst::Create ( Value Value,
BasicBlock Default,
unsigned  NumCases,
BasicBlock InsertAtEnd 
) [inline, static]

Definition at line 2669 of file Instructions.h.

Provide fast operand accessors.

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.

Definition at line 2749 of file Instructions.h.

Referenced by TryToSimplifyUncondBranchWithICmpInIt().

findCaseValue - Search all of the case values for the specified constant. If it is explicitly handled, return the case iterator of it, otherwise return default case iterator to indicate that it is handled by the default handler.

Definition at line 2734 of file Instructions.h.

References llvm::CallingConv::C.

Referenced by EliminateDeadSwitchCases(), SimplifySwitchOnSelect(), and TryToSimplifyUncondBranchWithICmpInIt().

Definition at line 2740 of file Instructions.h.

References llvm::CallingConv::C.

getNumSuccessors - Return the number of successors that this terminator has.

Reimplemented from llvm::TerminatorInst.

Definition at line 2776 of file Instructions.h.

Referenced by SwitchToLookupTable().

getSuccessor - Return the specified successor.

Reimplemented from llvm::TerminatorInst.

Definition at line 2777 of file Instructions.h.

Referenced by llvm::SwitchInst::CaseIteratorT< SwitchInst, ConstantInt, BasicBlock >::getCaseSuccessor(), and SwitchToLookupTable().

removeCase - This method removes the specified case and its successor from the switch instruction. Note that this operation may reorder the remaining cases at index idx and above. Note: This action invalidates iterators for all cases following the one removed, including the case_end() iterator.

removeCase - This method removes the specified case and its successor from the switch instruction.

Definition at line 3413 of file Instructions.cpp.

References llvm::SwitchInst::CaseIteratorT< SwitchInstTy, ConstantIntTy, BasicBlockTy >::getCaseIndex(), llvm::User::getNumOperands(), llvm::User::OperandList, and llvm::Use::set().

Referenced by EliminateDeadSwitchCases().

void llvm::SwitchInst::setCondition ( Value V) [inline]

Definition at line 2681 of file Instructions.h.

Referenced by llvm::InstCombiner::visitSwitchInst().

void llvm::SwitchInst::setDefaultDest ( BasicBlock DefaultCase) [inline]

Definition at line 2687 of file Instructions.h.

void llvm::SwitchInst::setSuccessor ( unsigned  idx,
BasicBlock B 
) [inline]

setSuccessor - Update the specified successor to point at the provided block.

Reimplemented from llvm::TerminatorInst.

Definition at line 2781 of file Instructions.h.

Referenced by llvm::SwitchInst::CaseIt::setSuccessor().


Member Data Documentation

Definition at line 2550 of file Instructions.h.


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