LLVM 20.0.0git
Classes | Public Types | Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::sandboxir::BranchInst Class Reference

#include "llvm/SandboxIR/SandboxIR.h"

Inheritance diagram for llvm::sandboxir::BranchInst:
Inheritance graph
[legend]

Public Types

using sb_succ_op_iterator = mapped_iterator< llvm::BranchInst::succ_op_iterator, LLVMBBToSBBB >
 
using const_sb_succ_op_iterator = mapped_iterator< llvm::BranchInst::const_succ_op_iterator, ConstLLVMBBToSBBB >
 
- Public Types inherited from llvm::sandboxir::Instruction
enum class  Opcode { DEF_VALUE , DEF_USER , OP , DEF_INSTR }
 
- Public Types inherited from llvm::sandboxir::User
using op_iterator = OperandUseIterator
 
using const_op_iterator = OperandUseIterator
 
using op_range = iterator_range< op_iterator >
 
using const_op_range = iterator_range< const_op_iterator >
 
- Public Types inherited from llvm::sandboxir::Value
enum class  ClassID : unsigned { DEF_VALUE , DEF_USER , DEF_INSTR }
 
using use_iterator = UserUseIterator
 
using const_use_iterator = UserUseIterator
 
using user_iterator = mapped_iterator< sandboxir::UserUseIterator, UseToUser >
 
using const_user_iterator = user_iterator
 

Public Member Functions

unsigned getUseOperandNo (const Use &Use) const final
 \Returns the operand index of Use.
 
unsigned getNumOfIRInstrs () const final
 This is used by BasicBlock::iterator.
 
bool isUnconditional () const
 
bool isConditional () const
 
ValuegetCondition () const
 
void setCondition (Value *V)
 
unsigned getNumSuccessors () const
 
BasicBlockgetSuccessor (unsigned SuccIdx) const
 
void setSuccessor (unsigned Idx, BasicBlock *NewSucc)
 
void swapSuccessors ()
 
iterator_range< sb_succ_op_iteratorsuccessors ()
 
iterator_range< const_sb_succ_op_iteratorsuccessors () const
 
void verify () const final
 Should crash if there is something wrong with the instruction.
 
void dump (raw_ostream &OS) const override
 
LLVM_DUMP_METHOD void dump () const override
 
- Public Member Functions inherited from llvm::sandboxir::Instruction
virtual unsigned getNumOfIRInstrs () const =0
 This is used by BasicBlock::iterator.
 
BBIterator getIterator () const
 \Returns a BasicBlock::iterator for this Instruction.
 
InstructiongetNextNode () const
 \Returns the next sandboxir::Instruction in the block, or nullptr if at the end of the block.
 
InstructiongetPrevNode () const
 \Returns the previous sandboxir::Instruction in the block, or nullptr if at the beginning of the block.
 
Opcode getOpcode () const
 \Returns this Instruction's opcode.
 
void removeFromParent ()
 Detach this from its parent BasicBlock without deleting it.
 
void eraseFromParent ()
 Detach this Value from its parent and delete it.
 
void insertBefore (Instruction *BeforeI)
 Insert this detached instruction before BeforeI.
 
void insertAfter (Instruction *AfterI)
 Insert this detached instruction after AfterI.
 
void insertInto (BasicBlock *BB, const BBIterator &WhereIt)
 Insert this detached instruction into BB at WhereIt.
 
void moveBefore (BasicBlock &BB, const BBIterator &WhereIt)
 Move this instruction to WhereIt.
 
void moveBefore (Instruction *Before)
 Move this instruction before Before.
 
void moveAfter (Instruction *After)
 Move this instruction after After.
 
BasicBlockgetParent () const
 \Returns the BasicBlock containing this Instruction, or null if it is detached.
 
void dump (raw_ostream &OS) const override
 
LLVM_DUMP_METHOD void dump () const override
 
- Public Member Functions inherited from llvm::sandboxir::User
virtual op_iterator op_begin ()
 
virtual op_iterator op_end ()
 
virtual const_op_iterator op_begin () const
 
virtual const_op_iterator op_end () const
 
op_range operands ()
 
const_op_range operands () const
 
ValuegetOperand (unsigned OpIdx) const
 
Use getOperandUse (unsigned OpIdx) const
 \Returns the operand edge for OpIdx.
 
virtual unsigned getNumOperands () const
 
virtual void setOperand (unsigned OperandIdx, Value *Operand)
 
bool replaceUsesOfWith (Value *FromV, Value *ToV)
 Replaces any operands that match FromV with ToV.
 
void verify () const override
 Should crash if there is something wrong with the instruction.
 
void dumpCommonHeader (raw_ostream &OS) const final
 
void dump (raw_ostream &OS) const override
 
LLVM_DUMP_METHOD void dump () const override
 
- Public Member Functions inherited from llvm::sandboxir::Value
virtual ~Value ()=default
 
ClassID getSubclassID () const
 
use_iterator use_begin ()
 
const_use_iterator use_begin () const
 
use_iterator use_end ()
 
const_use_iterator use_end () const
 
iterator_range< use_iteratoruses ()
 
iterator_range< const_use_iteratoruses () const
 
user_iterator user_begin ()
 
user_iterator user_end ()
 
const_user_iterator user_begin () const
 
const_user_iterator user_end () const
 
iterator_range< user_iteratorusers ()
 
iterator_range< const_user_iteratorusers () const
 
unsigned getNumUses () const
 \Returns the number of user edges (not necessarily to unique users).
 
bool hasNUsesOrMore (unsigned Num) const
 Return true if this value has N uses or more.
 
bool hasNUses (unsigned Num) const
 Return true if this Value has exactly N uses.
 
TypegetType () const
 
ContextgetContext () const
 
void replaceUsesWithIf (Value *OtherV, llvm::function_ref< bool(const Use &)> ShouldReplace)
 
void replaceAllUsesWith (Value *Other)
 
StringRef getName () const
 \Returns the LLVM IR name of the bottom-most LLVM value.
 
virtual void verify () const =0
 Should crash if there is something wrong with the instruction.
 
std::string getUid () const
 Returns the unique id in the form 'SB<number>.' like 'SB1.'.
 
virtual void dumpCommonHeader (raw_ostream &OS) const
 
void dumpCommonFooter (raw_ostream &OS) const
 
void dumpCommonPrefix (raw_ostream &OS) const
 
void dumpCommonSuffix (raw_ostream &OS) const
 
void printAsOperandCommon (raw_ostream &OS) const
 
virtual void dump (raw_ostream &OS) const =0
 
virtual LLVM_DUMP_METHOD void dump () const =0
 

Static Public Member Functions

static BranchInstcreate (BasicBlock *IfTrue, Instruction *InsertBefore, Context &Ctx)
 
static BranchInstcreate (BasicBlock *IfTrue, BasicBlock *InsertAtEnd, Context &Ctx)
 
static BranchInstcreate (BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond, Instruction *InsertBefore, Context &Ctx)
 
static BranchInstcreate (BasicBlock *IfTrue, BasicBlock *IfFalse, Value *Cond, BasicBlock *InsertAtEnd, Context &Ctx)
 
static bool classof (const Value *From)
 For isa/dyn_cast.
 
- Static Public Member Functions inherited from llvm::sandboxir::Instruction
static const chargetOpcodeName (Opcode Opc)
 
static bool classof (const sandboxir::Value *From)
 For isa/dyn_cast.
 
- Static Public Member Functions inherited from llvm::sandboxir::User
static bool classof (const Value *From)
 For isa/dyn_cast.
 

Friends

raw_ostreamoperator<< (raw_ostream &OS, const BranchInst &BI)
 

Additional Inherited Members

- Protected Member Functions inherited from llvm::sandboxir::Instruction
 Instruction (ClassID ID, Opcode Opc, llvm::Instruction *I, sandboxir::Context &SBCtx)
 
llvm::InstructiongetTopmostLLVMInstruction () const
 A SandboxIR Instruction may map to multiple LLVM IR Instruction.
 
virtual SmallVector< llvm::Instruction *, 1 > getLLVMInstrs () const =0
 \Returns the LLVM IR Instructions that this SandboxIR maps to in program order.
 
- Protected Member Functions inherited from llvm::sandboxir::User
 User (ClassID ID, llvm::Value *V, Context &Ctx)
 
Use getOperandUseDefault (unsigned OpIdx, bool Verify) const
 \Returns the Use edge that corresponds to OpIdx.
 
virtual Use getOperandUseInternal (unsigned OpIdx, bool Verify) const =0
 \Returns the Use for the OpIdx'th operand.
 
unsigned getUseOperandNoDefault (const Use &Use) const
 The default implementation works only for single-LLVMIR-instruction Users and only if they match exactly the LLVM instruction.
 
virtual unsigned getUseOperandNo (const Use &Use) const =0
 \Returns the operand index of Use.
 
void swapOperandsInternal (unsigned OpIdxA, unsigned OpIdxB)
 
void verifyUserOfLLVMUse (const llvm::Use &Use) const
 
- Protected Member Functions inherited from llvm::sandboxir::Value
void clearValue ()
 
 Value (ClassID SubclassID, llvm::Value *Val, Context &Ctx)
 
- Static Protected Member Functions inherited from llvm::sandboxir::Value
static const chargetSubclassIDStr (ClassID ID)
 
- Protected Attributes inherited from llvm::sandboxir::Instruction
Opcode Opc
 
- Protected Attributes inherited from llvm::sandboxir::Value
ClassID SubclassID
 For isa/dyn_cast.
 
unsigned UID
 A unique ID used for forming the name (used for debugging).
 
llvm::ValueVal = nullptr
 The LLVM Value that corresponds to this SandboxIR Value.
 
ContextCtx
 All values point to the context.
 

Detailed Description

Definition at line 631 of file SandboxIR.h.

Member Typedef Documentation

◆ const_sb_succ_op_iterator

Definition at line 697 of file SandboxIR.h.

◆ sb_succ_op_iterator

Definition at line 686 of file SandboxIR.h.

Member Function Documentation

◆ classof()

bool BranchInst::classof ( const Value From)
static

For isa/dyn_cast.

Definition at line 550 of file SandboxIR.cpp.

References From.

◆ create() [1/4]

BranchInst * BranchInst::create ( BasicBlock IfTrue,
BasicBlock IfFalse,
Value Cond,
BasicBlock InsertAtEnd,
Context Ctx 
)
static

◆ create() [2/4]

BranchInst * BranchInst::create ( BasicBlock IfTrue,
BasicBlock IfFalse,
Value Cond,
Instruction InsertBefore,
Context Ctx 
)
static

◆ create() [3/4]

BranchInst * BranchInst::create ( BasicBlock IfTrue,
BasicBlock InsertAtEnd,
Context Ctx 
)
static

◆ create() [4/4]

BranchInst * BranchInst::create ( BasicBlock IfTrue,
Instruction InsertBefore,
Context Ctx 
)
static

◆ dump() [1/2]

void BranchInst::dump ( ) const
overridevirtual

Reimplemented from llvm::sandboxir::Instruction.

Definition at line 583 of file SandboxIR.cpp.

References llvm::dbgs(), and dump().

Referenced by dump().

◆ dump() [2/2]

void BranchInst::dump ( raw_ostream OS) const
overridevirtual

◆ getCondition()

Value * BranchInst::getCondition ( ) const

◆ getNumOfIRInstrs()

unsigned llvm::sandboxir::BranchInst::getNumOfIRInstrs ( ) const
inlinefinalvirtual

This is used by BasicBlock::iterator.

Implements llvm::sandboxir::Instruction.

Definition at line 647 of file SandboxIR.h.

◆ getNumSuccessors()

unsigned llvm::sandboxir::BranchInst::getNumSuccessors ( ) const
inline

Definition at line 667 of file SandboxIR.h.

References isConditional().

Referenced by getSuccessor().

◆ getSuccessor()

BasicBlock * BranchInst::getSuccessor ( unsigned  SuccIdx) const

◆ getUseOperandNo()

unsigned llvm::sandboxir::BranchInst::getUseOperandNo ( const Use Use) const
inlinefinalvirtual

\Returns the operand index of Use.

Implements llvm::sandboxir::User.

Definition at line 644 of file SandboxIR.h.

References llvm::sandboxir::User::getUseOperandNoDefault().

◆ isConditional()

bool llvm::sandboxir::BranchInst::isConditional ( ) const
inline

Definition at line 662 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

Referenced by getCondition(), and getNumSuccessors().

◆ isUnconditional()

bool llvm::sandboxir::BranchInst::isUnconditional ( ) const
inline

Definition at line 659 of file SandboxIR.h.

References llvm::sandboxir::Value::Val.

◆ setCondition()

void llvm::sandboxir::BranchInst::setCondition ( Value V)
inline

Definition at line 666 of file SandboxIR.h.

References llvm::sandboxir::User::setOperand().

◆ setSuccessor()

void BranchInst::setSuccessor ( unsigned  Idx,
BasicBlock NewSucc 
)

Definition at line 566 of file SandboxIR.cpp.

References assert(), Idx, and llvm::sandboxir::User::setOperand().

◆ successors() [1/2]

iterator_range< sb_succ_op_iterator > llvm::sandboxir::BranchInst::successors ( )
inline

◆ successors() [2/2]

iterator_range< const_sb_succ_op_iterator > llvm::sandboxir::BranchInst::successors ( ) const
inline

◆ swapSuccessors()

void llvm::sandboxir::BranchInst::swapSuccessors ( )
inline

Definition at line 670 of file SandboxIR.h.

References llvm::sandboxir::User::swapOperandsInternal().

◆ verify()

void llvm::sandboxir::BranchInst::verify ( ) const
inlinefinalvirtual

Should crash if there is something wrong with the instruction.

Reimplemented from llvm::sandboxir::User.

Definition at line 713 of file SandboxIR.h.

References assert(), and llvm::sandboxir::Value::Val.

Friends And Related Function Documentation

◆ operator<<

raw_ostream & operator<< ( raw_ostream OS,
const BranchInst BI 
)
friend

Definition at line 716 of file SandboxIR.h.


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