LLVM  8.0.1
Classes | Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Friends | List of all members
llvm::SwitchInst Class Reference

Multiway switch. More...

#include "llvm/IR/Instructions.h"

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

Classes

class  CaseHandle
 
class  CaseHandleImpl
 A handle to a particular switch case. More...
 
class  CaseIteratorImpl
 

Public Types

using ConstCaseHandle = CaseHandleImpl< const SwitchInst, const ConstantInt, const BasicBlock >
 
using CaseIt = CaseIteratorImpl< CaseHandle >
 
using ConstCaseIt = CaseIteratorImpl< ConstCaseHandle >
 
- Public Types inherited from llvm::Instruction
enum  OperationEquivalenceFlags { CompareIgnoringAlignment = 1<<0, CompareUsingScalarTypes = 1<<1 }
 When checking for operation equivalence (using isSameOperationAs) it is sometimes useful to ignore certain attributes. More...
 
enum  TermOps
 
enum  UnaryOps
 
enum  BinaryOps
 
enum  MemoryOps
 
enum  CastOps
 
enum  FuncletPadOps
 
enum  OtherOps
 
- Public Types inherited from llvm::User
using op_iterator = Use *
 
using const_op_iterator = const Use *
 
using op_range = iterator_range< op_iterator >
 
using const_op_range = iterator_range< const_op_iterator >
 
- Public Types inherited from llvm::Value
enum  ValueTy
 Concrete subclass of this. More...
 
using use_iterator = use_iterator_impl< Use >
 
using const_use_iterator = use_iterator_impl< const Use >
 
using user_iterator = user_iterator_impl< User >
 
using const_user_iterator = user_iterator_impl< const User >
 

Public Member Functions

 DECLARE_TRANSPARENT_OPERAND_ACCESSORS (Value)
 Provide fast operand accessors. More...
 
ValuegetCondition () const
 
void setCondition (Value *V)
 
BasicBlockgetDefaultDest () const
 
void setDefaultDest (BasicBlock *DefaultCase)
 
unsigned getNumCases () const
 Return the number of 'cases' in this switch instruction, excluding the default case. More...
 
CaseIt case_begin ()
 Returns a read/write iterator that points to the first case in the SwitchInst. More...
 
ConstCaseIt case_begin () const
 Returns a read-only iterator that points to the first case in the SwitchInst. More...
 
CaseIt case_end ()
 Returns a read/write iterator that points one past the last in the SwitchInst. More...
 
ConstCaseIt case_end () const
 Returns a read-only iterator that points one past the last in the SwitchInst. More...
 
iterator_range< CaseItcases ()
 Iteration adapter for range-for loops. More...
 
iterator_range< ConstCaseItcases () const
 Constant iteration adapter for range-for loops. More...
 
CaseIt case_default ()
 Returns an iterator that points to the default case. More...
 
ConstCaseIt case_default () const
 
CaseIt findCaseValue (const ConstantInt *C)
 Search all of the case values for the specified constant. More...
 
ConstCaseIt findCaseValue (const ConstantInt *C) const
 
ConstantIntfindCaseDest (BasicBlock *BB)
 Finds the unique case value for a given successor. More...
 
void addCase (ConstantInt *OnVal, BasicBlock *Dest)
 Add an entry to the switch instruction. More...
 
CaseIt removeCase (CaseIt I)
 This method removes the specified case and its successor from the switch instruction. More...
 
unsigned getNumSuccessors () const
 
BasicBlockgetSuccessor (unsigned idx) const
 
void setSuccessor (unsigned idx, BasicBlock *NewSucc)
 
- Public Member Functions inherited from llvm::Instruction
 Instruction (const Instruction &)=delete
 
Instructionoperator= (const Instruction &)=delete
 
Instructionuser_back ()
 Specialize the methods defined in Value, as we know that an instruction can only be used by other instructions. More...
 
const Instructionuser_back () const
 
const BasicBlockgetParent () const
 
BasicBlockgetParent ()
 
const ModulegetModule () const
 Return the module owning the function this instruction belongs to or nullptr it the function does not have a module. More...
 
ModulegetModule ()
 
const FunctiongetFunction () const
 Return the function this instruction belongs to. More...
 
FunctiongetFunction ()
 
void removeFromParent ()
 This method unlinks 'this' from the containing basic block, but does not delete it. More...
 
SymbolTableList< Instruction >::iterator eraseFromParent ()
 This method unlinks 'this' from the containing basic block and deletes it. More...
 
void insertBefore (Instruction *InsertPos)
 Insert an unlinked instruction into a basic block immediately before the specified instruction. More...
 
void insertAfter (Instruction *InsertPos)
 Insert an unlinked instruction into a basic block immediately after the specified instruction. More...
 
void moveBefore (Instruction *MovePos)
 Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right before MovePos. More...
 
void moveBefore (BasicBlock &BB, SymbolTableList< Instruction >::iterator I)
 Unlink this instruction and insert into BB before I. More...
 
void moveAfter (Instruction *MovePos)
 Unlink this instruction from its current basic block and insert it into the basic block that MovePos lives in, right after MovePos. More...
 
unsigned getOpcode () const
 Returns a member of one of the enums like Instruction::Add. More...
 
const chargetOpcodeName () const
 
bool isTerminator () const
 
bool isUnaryOp () const
 
bool isBinaryOp () const
 
bool isIntDivRem () const
 
bool isShift ()
 
bool isCast () const
 
bool isFuncletPad () const
 
bool isExceptionalTerminator () const
 
bool isLogicalShift () const
 Return true if this is a logical shift left or a logical shift right. More...
 
bool isArithmeticShift () const
 Return true if this is an arithmetic shift right. More...
 
bool isBitwiseLogicOp () const
 Return true if this is and/or/xor. More...
 
bool hasMetadata () const
 Return true if this instruction has any metadata attached to it. More...
 
bool hasMetadataOtherThanDebugLoc () const
 Return true if this instruction has metadata attached to it other than a debug location. More...
 
MDNodegetMetadata (unsigned KindID) const
 Get the metadata of given kind attached to this Instruction. More...
 
MDNodegetMetadata (StringRef Kind) const
 Get the metadata of given kind attached to this Instruction. More...
 
void getAllMetadata (SmallVectorImpl< std::pair< unsigned, MDNode *>> &MDs) const
 Get all metadata attached to this Instruction. More...
 
void getAllMetadataOtherThanDebugLoc (SmallVectorImpl< std::pair< unsigned, MDNode *>> &MDs) const
 This does the same thing as getAllMetadata, except that it filters out the debug location. More...
 
void getAAMetadata (AAMDNodes &N, bool Merge=false) const
 Fills the AAMDNodes structure with AA metadata from this instruction. More...
 
void setMetadata (unsigned KindID, MDNode *Node)
 Set the metadata of the specified kind to the specified node. More...
 
void setMetadata (StringRef Kind, MDNode *Node)
 
void copyMetadata (const Instruction &SrcInst, ArrayRef< unsigned > WL=ArrayRef< unsigned >())
 Copy metadata from SrcInst to this instruction. More...
 
void swapProfMetadata ()
 If the instruction has "branch_weights" MD_prof metadata and the MDNode has three operands (including name string), swap the order of the metadata. More...
 
void setAAMetadata (const AAMDNodes &N)
 Sets the metadata on this instruction from the AAMDNodes structure. More...
 
bool extractProfMetadata (uint64_t &TrueVal, uint64_t &FalseVal) const
 Retrieve the raw weight values of a conditional branch or select. More...
 
bool extractProfTotalWeight (uint64_t &TotalVal) const
 Retrieve total raw weight values of a branch. More...
 
void updateProfWeight (uint64_t S, uint64_t T)
 Updates branch_weights metadata by scaling it by S / T. More...
 
void setProfWeight (uint64_t W)
 Sets the branch_weights metadata to W for CallInst. More...
 
void setDebugLoc (DebugLoc Loc)
 Set the debug location information for this instruction. More...
 
const DebugLocgetDebugLoc () const
 Return the debug location for this node as a DebugLoc. More...
 
void setHasNoUnsignedWrap (bool b=true)
 Set or clear the nuw flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasNoSignedWrap (bool b=true)
 Set or clear the nsw flag on this instruction, which must be an operator which supports this flag. More...
 
void setIsExact (bool b=true)
 Set or clear the exact flag on this instruction, which must be an operator which supports this flag. More...
 
bool hasNoUnsignedWrap () const
 Determine whether the no unsigned wrap flag is set. More...
 
bool hasNoSignedWrap () const
 Determine whether the no signed wrap flag is set. More...
 
void dropPoisonGeneratingFlags ()
 Drops flags that may cause this instruction to evaluate to poison despite having non-poison inputs. More...
 
bool isExact () const
 Determine whether the exact flag is set. More...
 
void setFast (bool B)
 Set or clear all fast-math-flags on this instruction, which must be an operator which supports this flag. More...
 
void setHasAllowReassoc (bool B)
 Set or clear the reassociation flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasNoNaNs (bool B)
 Set or clear the no-nans flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasNoInfs (bool B)
 Set or clear the no-infs flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasNoSignedZeros (bool B)
 Set or clear the no-signed-zeros flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasAllowReciprocal (bool B)
 Set or clear the allow-reciprocal flag on this instruction, which must be an operator which supports this flag. More...
 
void setHasApproxFunc (bool B)
 Set or clear the approximate-math-functions flag on this instruction, which must be an operator which supports this flag. More...
 
void setFastMathFlags (FastMathFlags FMF)
 Convenience function for setting multiple fast-math flags on this instruction, which must be an operator which supports these flags. More...
 
void copyFastMathFlags (FastMathFlags FMF)
 Convenience function for transferring all fast-math flag values to this instruction, which must be an operator which supports these flags. More...
 
bool isFast () const
 Determine whether all fast-math-flags are set. More...
 
bool hasAllowReassoc () const
 Determine whether the allow-reassociation 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...
 
bool hasAllowContract () const
 Determine whether the allow-contract flag is set. More...
 
bool hasApproxFunc () const
 Determine whether the approximate-math-functions flag is set. More...
 
FastMathFlags getFastMathFlags () const
 Convenience function for getting all the fast-math flags, which must be an operator which supports these flags. More...
 
void copyFastMathFlags (const Instruction *I)
 Copy I's fast-math flags. More...
 
void copyIRFlags (const Value *V, bool IncludeWrapFlags=true)
 Convenience method to copy supported exact, fast-math, and (optionally) wrapping flags from V to this instruction. More...
 
void andIRFlags (const Value *V)
 Logical 'and' of any supported wrapping, exact, and fast-math flags of V and this instruction. More...
 
void applyMergedLocation (const DILocation *LocA, const DILocation *LocB)
 Merge 2 debug locations and apply it to the Instruction. More...
 
bool isAssociative () const LLVM_READONLY
 Return true if the instruction is associative: More...
 
bool isCommutative () const
 Return true if the instruction is commutative: More...
 
bool isIdempotent () const
 Return true if the instruction is idempotent: More...
 
bool isNilpotent () const
 Return true if the instruction is nilpotent: More...
 
bool mayWriteToMemory () const
 Return true if this instruction may modify memory. More...
 
bool mayReadFromMemory () const
 Return true if this instruction may read memory. More...
 
bool mayReadOrWriteMemory () const
 Return true if this instruction may read or write memory. More...
 
bool isAtomic () const
 Return true if this instruction has an AtomicOrdering of unordered or higher. More...
 
bool hasAtomicLoad () const
 Return true if this atomic instruction loads from memory. More...
 
bool hasAtomicStore () const
 Return true if this atomic instruction stores to memory. More...
 
bool mayThrow () const
 Return true if this instruction may throw an exception. More...
 
bool isFenceLike () const
 Return true if this instruction behaves like a memory fence: it can load or store to memory location without being given a memory location. More...
 
bool mayHaveSideEffects () const
 Return true if the instruction may have side effects. More...
 
bool isSafeToRemove () const
 Return true if the instruction can be removed if the result is unused. More...
 
bool isEHPad () const
 Return true if the instruction is a variety of EH-block. More...
 
bool isLifetimeStartOrEnd () const
 Return true if the instruction is a llvm.lifetime.start or llvm.lifetime.end marker. More...
 
const InstructiongetNextNonDebugInstruction () const
 Return a pointer to the next non-debug instruction in the same basic block as 'this', or nullptr if no such instruction exists. More...
 
InstructiongetNextNonDebugInstruction ()
 
const InstructiongetPrevNonDebugInstruction () const
 Return a pointer to the previous non-debug instruction in the same basic block as 'this', or nullptr if no such instruction exists. More...
 
InstructiongetPrevNonDebugInstruction ()
 
Instructionclone () const
 Create a copy of 'this' instruction that is identical in all ways except the following: More...
 
bool isIdenticalTo (const Instruction *I) const
 Return true if the specified instruction is exactly identical to the current one. More...
 
bool isIdenticalToWhenDefined (const Instruction *I) const
 This is like isIdenticalTo, except that it ignores the SubclassOptionalData flags, which may specify conditions under which the instruction's result is undefined. More...
 
bool isSameOperationAs (const Instruction *I, unsigned flags=0) const
 This function determines if the specified instruction executes the same operation as the current one. More...
 
bool isUsedOutsideOfBlock (const BasicBlock *BB) const
 Return true if there are any uses of this instruction in blocks other than the specified block. More...
 
unsigned getNumSuccessors () const
 Return the number of successors that this instruction has. More...
 
BasicBlockgetSuccessor (unsigned Idx) const
 Return the specified successor. This instruction must be a terminator. More...
 
void setSuccessor (unsigned Idx, BasicBlock *BB)
 Update the specified successor to point at the provided block. More...
 
void dropUnknownNonDebugMetadata (ArrayRef< unsigned > KnownIDs)
 Drop all unknown metadata except for debug locations. More...
 
void dropUnknownNonDebugMetadata ()
 
void dropUnknownNonDebugMetadata (unsigned ID1)
 
void dropUnknownNonDebugMetadata (unsigned ID1, unsigned ID2)
 
- Public Member Functions inherited from llvm::User
 User (const User &)=delete
 
void operator delete (void *Usr)
 Free memory allocated for User and Use objects. More...
 
void operator delete (void *Usr, unsigned)
 Placement delete - required by std, called if the ctor throws. More...
 
void operator delete (void *Usr, unsigned, bool)
 Placement delete - required by std, called if the ctor throws. More...
 
const UsegetOperandList () const
 
UsegetOperandList ()
 
ValuegetOperand (unsigned i) const
 
void setOperand (unsigned i, Value *Val)
 
const UsegetOperandUse (unsigned i) const
 
UsegetOperandUse (unsigned i)
 
unsigned getNumOperands () const
 
ArrayRef< const uint8_t > getDescriptor () const
 Returns the descriptor co-allocated with this User instance. More...
 
MutableArrayRef< uint8_t > getDescriptor ()
 Returns the descriptor co-allocated with this User instance. More...
 
void setGlobalVariableNumOperands (unsigned NumOps)
 Set the number of operands on a GlobalVariable. More...
 
void setNumHungOffUseOperands (unsigned NumOps)
 Subclasses with hung off uses need to manage the operand count themselves. More...
 
op_iterator op_begin ()
 
const_op_iterator op_begin () const
 
op_iterator op_end ()
 
const_op_iterator op_end () const
 
op_range operands ()
 
const_op_range operands () const
 
value_op_iterator value_op_begin ()
 
value_op_iterator value_op_end ()
 
iterator_range< value_op_iteratoroperand_values ()
 
const_value_op_iterator value_op_begin () const
 
const_value_op_iterator value_op_end () const
 
iterator_range< const_value_op_iteratoroperand_values () const
 
void dropAllReferences ()
 Drop all references to operands. More...
 
void replaceUsesOfWith (Value *From, Value *To)
 Replace uses of one Value with another. More...
 
- Public Member Functions inherited from llvm::Value
 Value (const Value &)=delete
 
Valueoperator= (const Value &)=delete
 
void deleteValue ()
 Delete a pointer to a generic Value. More...
 
void dump () const
 Support for debugging, callable in GDB: V->dump() More...
 
TypegetType () const
 All values are typed, get the type of this value. More...
 
LLVMContextgetContext () const
 All values hold a context through their type. More...
 
bool hasName () const
 
ValueNamegetValueName () const
 
void setValueName (ValueName *VN)
 
StringRef getName () const
 Return a constant reference to the value's name. More...
 
void setName (const Twine &Name)
 Change the name of the value. More...
 
void takeName (Value *V)
 Transfer the name from V to this value. More...
 
void replaceAllUsesWith (Value *V)
 Change all uses of this to point to a new Value. More...
 
void replaceNonMetadataUsesWith (Value *V)
 Change non-metadata uses of this to point to a new Value. More...
 
void replaceUsesOutsideBlock (Value *V, BasicBlock *BB)
 replaceUsesOutsideBlock - Go through the uses list for this definition and make each use point to "V" instead of "this" when the use is outside the block. More...
 
void assertModuleIsMaterializedImpl () const
 
void assertModuleIsMaterialized () const
 
bool use_empty () const
 
bool materialized_use_empty () const
 
use_iterator materialized_use_begin ()
 
const_use_iterator materialized_use_begin () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
iterator_range< use_iteratormaterialized_uses ()
 
iterator_range< const_use_iteratormaterialized_uses () const
 
iterator_range< use_iteratoruses ()
 
iterator_range< const_use_iteratoruses () const
 
bool user_empty () const
 
user_iterator materialized_user_begin ()
 
const_user_iterator materialized_user_begin () const
 
user_iterator user_begin ()
 
const_user_iterator user_begin () const
 
user_iterator user_end ()
 
const_user_iterator user_end () const
 
Useruser_back ()
 
const Useruser_back () const
 
iterator_range< user_iteratormaterialized_users ()
 
iterator_range< const_user_iteratormaterialized_users () const
 
iterator_range< user_iteratorusers ()
 
iterator_range< const_user_iteratorusers () const
 
bool hasOneUse () const
 Return true if there is exactly one user of this value. More...
 
bool hasNUses (unsigned N) const
 Return true if this Value has exactly N users. More...
 
bool hasNUsesOrMore (unsigned N) const
 Return true if this value has N users or more. More...
 
bool isUsedInBasicBlock (const BasicBlock *BB) const
 Check if this value is used in the specified basic block. More...
 
unsigned getNumUses () const
 This method computes the number of uses of this Value. More...
 
void addUse (Use &U)
 This method should only be used by the Use class. More...
 
unsigned getValueID () const
 Return an ID for the concrete type of this object. More...
 
unsigned getRawSubclassOptionalData () const
 Return the raw optional flags value contained in this value. More...
 
void clearSubclassOptionalData ()
 Clear the optional flags contained in this value. More...
 
bool hasSameSubclassOptionalData (const Value *V) const
 Check the optional flags for equality. More...
 
bool hasValueHandle () const
 Return true if there is a value handle associated with this value. More...
 
bool isUsedByMetadata () const
 Return true if there is metadata referencing this value. More...
 
bool isSwiftError () const
 Return true if this value is a swifterror value. More...
 
const ValuestripPointerCasts () const
 Strip off pointer casts, all-zero GEPs, and aliases. More...
 
ValuestripPointerCasts ()
 
const ValuestripPointerCastsAndInvariantGroups () const
 Strip off pointer casts, all-zero GEPs, aliases and invariant group info. More...
 
ValuestripPointerCastsAndInvariantGroups ()
 
const ValuestripPointerCastsNoFollowAliases () const
 Strip off pointer casts and all-zero GEPs. More...
 
ValuestripPointerCastsNoFollowAliases ()
 
const ValuestripInBoundsConstantOffsets () const
 Strip off pointer casts and all-constant inbounds GEPs. More...
 
ValuestripInBoundsConstantOffsets ()
 
const ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset) const
 Accumulate offsets from stripInBoundsConstantOffsets(). More...
 
ValuestripAndAccumulateInBoundsConstantOffsets (const DataLayout &DL, APInt &Offset)
 
const ValuestripInBoundsOffsets () const
 Strip off pointer casts and inbounds GEPs. More...
 
ValuestripInBoundsOffsets ()
 
uint64_t getPointerDereferenceableBytes (const DataLayout &DL, bool &CanBeNull) const
 Returns the number of bytes known to be dereferenceable for the pointer value. More...
 
unsigned getPointerAlignment (const DataLayout &DL) const
 Returns an alignment of the pointer value. More...
 
const ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB) const
 Translate PHI node to its predecessor from the given basic block. More...
 
ValueDoPHITranslation (const BasicBlock *CurBB, const BasicBlock *PredBB)
 
void mutateType (Type *Ty)
 Mutate the type of this Value to be of the specified type. More...
 
template<class Compare >
void sortUseList (Compare Cmp)
 Sort the use-list. More...
 
void reverseUseList ()
 Reverse the use-list. More...
 
void print (raw_ostream &O, bool IsForDebug=false) const
 Implement operator<< on Value. More...
 
void print (raw_ostream &O, ModuleSlotTracker &MST, bool IsForDebug=false) const
 
void printAsOperand (raw_ostream &O, bool PrintType=true, const Module *M=nullptr) const
 Print the name of this Value out to the specified raw_ostream. More...
 
void printAsOperand (raw_ostream &O, bool PrintType, ModuleSlotTracker &MST) const
 
- Public Member Functions inherited from llvm::ilist_node_with_parent< Instruction, BasicBlock >
InstructiongetPrevNode ()
 
const InstructiongetPrevNode () const
 Get the previous node, or nullptr for the list head. More...
 
InstructiongetNextNode ()
 Get the next node, or nullptr for the list tail. More...
 
const InstructiongetNextNode () const
 Get the next node, or nullptr for the list tail. More...
 
- Public Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Instruction, Options... >::type >
self_iterator getIterator ()
 
const_self_iterator getIterator () const
 
reverse_self_iterator getReverseIterator ()
 
const_reverse_self_iterator getReverseIterator () const
 
bool isSentinel () const
 Check whether this is the sentinel node. More...
 

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)
 
- Static Public Member Functions inherited from llvm::Instruction
static const chargetOpcodeName (unsigned OpCode)
 
static bool isTerminator (unsigned OpCode)
 
static bool isUnaryOp (unsigned Opcode)
 
static bool isBinaryOp (unsigned Opcode)
 
static bool isIntDivRem (unsigned Opcode)
 
static bool isShift (unsigned Opcode)
 Determine if the Opcode is one of the shift instructions. More...
 
static bool isBitwiseLogicOp (unsigned Opcode)
 Determine if the Opcode is and/or/xor. More...
 
static bool isCast (unsigned OpCode)
 Determine if the OpCode is one of the CastInst instructions. More...
 
static bool isFuncletPad (unsigned OpCode)
 Determine if the OpCode is one of the FuncletPadInst instructions. More...
 
static bool isExceptionalTerminator (unsigned OpCode)
 Returns true if the OpCode is a terminator related to exception handling. More...
 
static bool isAssociative (unsigned Opcode)
 
static bool isCommutative (unsigned Opcode)
 
static bool isIdempotent (unsigned Opcode)
 
static bool isNilpotent (unsigned Opcode)
 
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)
 

Static Public Attributes

static const unsigned DefaultPseudoIndex = static_cast<unsigned>(~0L-1)
 
- Static Public Attributes inherited from llvm::Value
static const unsigned MaxAlignmentExponent = 29
 The maximum alignment for instructions. More...
 
static const unsigned MaximumAlignment = 1u << MaxAlignmentExponent
 

Protected Member Functions

SwitchInstcloneImpl () const
 
- Protected Member Functions inherited from llvm::Instruction
 ~Instruction ()
 
void setInstructionSubclassData (unsigned short D)
 
unsigned getSubclassDataFromInstruction () const
 
 Instruction (Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, Instruction *InsertBefore=nullptr)
 
 Instruction (Type *Ty, unsigned iType, Use *Ops, unsigned NumOps, BasicBlock *InsertAtEnd)
 
- Protected Member Functions inherited from llvm::User
void * operator new (size_t Size)
 Allocate a User with an operand pointer co-allocated. More...
 
void * operator new (size_t Size, unsigned Us)
 Allocate a User with the operands co-allocated. More...
 
void * operator new (size_t Size, unsigned Us, unsigned DescBytes)
 Allocate a User with the operands co-allocated. More...
 
 User (Type *ty, unsigned vty, Use *, unsigned NumOps)
 
void allocHungoffUses (unsigned N, bool IsPhi=false)
 Allocate the array of Uses, followed by a pointer (with bottom bit set) to the User. More...
 
void growHungoffUses (unsigned N, bool IsPhi=false)
 Grow the number of hung off uses. More...
 
 ~User ()=default
 
template<int Idx>
UseOp ()
 
template<int Idx>
const UseOp () const
 
- Protected Member Functions inherited from llvm::Value
 Value (Type *Ty, unsigned scid)
 
 ~Value ()
 Value's destructor should be virtual by design, but that would require that Value and all of its subclasses have a vtable that effectively duplicates the information in the value ID. More...
 
unsigned short getSubclassDataFromValue () const
 
void setValueSubclassData (unsigned short D)
 
- Protected Member Functions inherited from llvm::ilist_node_with_parent< Instruction, BasicBlock >
 ilist_node_with_parent ()=default
 
- Protected Member Functions inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Instruction, Options... >::type >
 ilist_node_impl ()=default
 

Friends

class Instruction
 

Additional Inherited Members

- Protected Types inherited from llvm::Value
enum  : unsigned { NumUserOperandsBits = 28 }
 The number of operands in the subclass. More...
 
- Protected Types inherited from llvm::ilist_node_impl< ilist_detail::compute_node_options< Instruction, Options... >::type >
using self_iterator = ilist_iterator< ilist_detail::compute_node_options< Instruction, Options... >::type, false, false >
 
using const_self_iterator = ilist_iterator< ilist_detail::compute_node_options< Instruction, Options... >::type, false, true >
 
using reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< Instruction, Options... >::type, true, false >
 
using const_reverse_self_iterator = ilist_iterator< ilist_detail::compute_node_options< Instruction, Options... >::type, true, true >
 
- Static Protected Member Functions inherited from llvm::User
template<int Idx, typename U >
static UseOpFrom (const U *that)
 
- Protected Attributes inherited from llvm::Value
unsigned char SubclassOptionalData: 7
 Hold subclass data that can be dropped. More...
 
unsigned NumUserOperands: NumUserOperandsBits
 
unsigned IsUsedByMD: 1
 
unsigned HasName: 1
 
unsigned HasHungOffUses: 1
 
unsigned HasDescriptor: 1
 

Detailed Description

Multiway switch.

Definition at line 3109 of file Instructions.h.

Member Typedef Documentation

◆ CaseIt

Definition at line 3296 of file Instructions.h.

◆ ConstCaseHandle

Definition at line 3207 of file Instructions.h.

◆ ConstCaseIt

Definition at line 3297 of file Instructions.h.

Member Function Documentation

◆ addCase()

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

Add an entry to the switch instruction.

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

Note: This action invalidates case_end(). Old case_end() iterator will point to the added case.

Definition at line 3669 of file Instructions.cpp.

References assert(), llvm::User::getNumOperands(), llvm::User::setNumHungOffUseOperands(), llvm::SwitchInst::CaseHandle::setSuccessor(), and llvm::SwitchInst::CaseHandle::setValue().

Referenced by llvm::CodeExtractor::findInputsOutputs(), FitWeights(), FunctionNumber(), getSignature(), SimplifyBranchOnICmpChain(), and SimplifyIndirectBrOnSelect().

◆ case_begin() [1/2]

CaseIt llvm::SwitchInst::case_begin ( )
inline

Returns a read/write iterator that points to the first case in the SwitchInst.

Definition at line 3333 of file Instructions.h.

Referenced by llvm::BasicTTIImplBase< AMDGPUTTIImpl >::getEstimatedNumberOfCaseClusters(), processSwitch(), setBranchWeights(), SwitchToLookupTable(), and unswitchTrivialSwitch().

◆ case_begin() [2/2]

ConstCaseIt llvm::SwitchInst::case_begin ( ) const
inline

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

Definition at line 3339 of file Instructions.h.

◆ case_default() [1/2]

CaseIt llvm::SwitchInst::case_default ( )
inline

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 3370 of file Instructions.h.

Referenced by eliminateDeadSwitchCases(), handleSwitchExpect(), ReplaceUsesOfWith(), and SimplifyIndirectBrOnSelect().

◆ case_default() [2/2]

ConstCaseIt llvm::SwitchInst::case_default ( ) const
inline

Definition at line 3373 of file Instructions.h.

◆ case_end() [1/2]

CaseIt llvm::SwitchInst::case_end ( )
inline

Returns a read/write iterator that points one past the last in the SwitchInst.

Definition at line 3345 of file Instructions.h.

Referenced by handleFinalSuspend(), processSwitch(), setBranchWeights(), SwitchToLookupTable(), and unswitchTrivialSwitch().

◆ case_end() [2/2]

ConstCaseIt llvm::SwitchInst::case_end ( ) const
inline

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

Definition at line 3351 of file Instructions.h.

◆ cases() [1/2]

iterator_range<CaseIt> llvm::SwitchInst::cases ( )
inline

◆ cases() [2/2]

iterator_range<ConstCaseIt> llvm::SwitchInst::cases ( ) const
inline

Constant iteration adapter for range-for loops.

Definition at line 3361 of file Instructions.h.

References llvm::make_range().

◆ classof() [1/2]

static bool llvm::SwitchInst::classof ( const Instruction I)
inlinestatic

Definition at line 3445 of file Instructions.h.

References llvm::Instruction::getOpcode().

◆ classof() [2/2]

static bool llvm::SwitchInst::classof ( const Value V)
inlinestatic

Definition at line 3448 of file Instructions.h.

References llvm::AllocaInst::classof().

◆ cloneImpl()

SwitchInst * SwitchInst::cloneImpl ( ) const
protected

Definition at line 3967 of file Instructions.cpp.

◆ Create() [1/2]

static SwitchInst* llvm::SwitchInst::Create ( Value Value,
BasicBlock Default,
unsigned  NumCases,
Instruction InsertBefore = nullptr 
)
inlinestatic

◆ Create() [2/2]

static SwitchInst* llvm::SwitchInst::Create ( Value Value,
BasicBlock Default,
unsigned  NumCases,
BasicBlock InsertAtEnd 
)
inlinestatic

◆ DECLARE_TRANSPARENT_OPERAND_ACCESSORS()

llvm::SwitchInst::DECLARE_TRANSPARENT_OPERAND_ACCESSORS ( Value  )

Provide fast operand accessors.

◆ findCaseDest()

ConstantInt* llvm::SwitchInst::findCaseDest ( BasicBlock BB)
inline

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 3401 of file Instructions.h.

References I.

Referenced by llvm::ScalarEvolution::forgetValue(), ReplaceUsesOfWith(), and SimplifyIndirectBrOnSelect().

◆ findCaseValue() [1/2]

CaseIt llvm::SwitchInst::findCaseValue ( const ConstantInt C)
inline

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 3381 of file Instructions.h.

References C, llvm::find_if(), llvm::SwitchInst::CaseHandleImpl< SwitchInstT, ConstantIntT, BasicBlockT >::getCaseValue(), and I.

Referenced by CloneLoop(), eliminateDeadSwitchCases(), handleSwitchExpect(), llvm::SparseSolver< LatticeKey, LatticeVal, KeyInfo >::MarkBlockExecutable(), ReplaceUsesOfWith(), SimplifyIndirectBrOnSelect(), and SimplifySwitchOnSelect().

◆ findCaseValue() [2/2]

ConstCaseIt llvm::SwitchInst::findCaseValue ( const ConstantInt C) const
inline

◆ getCondition()

Value* llvm::SwitchInst::getCondition ( ) const
inline

◆ getDefaultDest()

BasicBlock* llvm::SwitchInst::getDefaultDest ( ) const
inline

◆ getNumCases()

unsigned llvm::SwitchInst::getNumCases ( ) const
inline

◆ getNumSuccessors()

unsigned llvm::SwitchInst::getNumSuccessors ( ) const
inline

◆ getSuccessor()

BasicBlock* llvm::SwitchInst::getSuccessor ( unsigned  idx) const
inline

◆ removeCase()

SwitchInst::CaseIt SwitchInst::removeCase ( CaseIt  I)

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

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. It returns an iterator for the next case.

Definition at line 3684 of file Instructions.cpp.

References llvm::Address, llvm::User::allocHungoffUses(), assert(), E, llvm::Value::getContext(), llvm::User::getNumOperands(), llvm::User::getOperandList(), llvm::Value::getType(), llvm::Type::getVoidTy(), llvm::User::growHungoffUses(), llvm::cl::init(), llvm::Instruction::Instruction(), llvm::Type::isPointerTy(), llvm::Use::set(), llvm::User::setNumHungOffUseOperands(), and llvm::Value::SubclassOptionalData.

Referenced by eliminateDeadSwitchCases(), llvm::CodeExtractor::findInputsOutputs(), handleFinalSuspend(), processSwitch(), setBranchWeights(), and unswitchTrivialSwitch().

◆ setCondition()

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

◆ setDefaultDest()

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

◆ setSuccessor()

void llvm::SwitchInst::setSuccessor ( unsigned  idx,
BasicBlock NewSucc 
)
inline

Friends And Related Function Documentation

◆ Instruction

friend class Instruction
friend

Definition at line 3142 of file Instructions.h.

Member Data Documentation

◆ DefaultPseudoIndex

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

Definition at line 3148 of file Instructions.h.


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