LLVM 19.0.0git
Public Member Functions | Static Public Member Functions | Friends | List of all members
llvm::sandboxir::OpaqueInst Class Reference

An LLLVM Instruction that has no SandboxIR equivalent class gets mapped to an OpaqueInstr. More...

#include "llvm/SandboxIR/SandboxIR.h"

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

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.
 
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
 
virtual unsigned getNumOfIRInstrs () const =0
 This is used by BasicBlock::iterator.
 
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
 
Value * getOperand (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_iterator > uses ()
 
iterator_range< const_use_iterator > uses () const
 
user_iterator user_begin ()
 
user_iterator user_end ()
 
const_user_iterator user_begin () const
 
const_user_iterator user_end () const
 
iterator_range< user_iterator > users ()
 
iterator_range< const_user_iterator > users () 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.
 
Type * getType () const
 
Context & getContext () const
 
void replaceUsesWithIf (Value *OtherV, llvm::function_ref< bool(const Use &)> ShouldReplace)
 
void replaceAllUsesWith (Value *Other)
 
virtual void verify () const =0
 Should crash if there is something wrong with the instruction.
 
std::string getName () const
 Returns the name 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 bool classof (const sandboxir::Value *From)
 
- Static Public Member Functions inherited from llvm::sandboxir::Instruction
static const char * getOpcodeName (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

class Context
 
raw_ostream & operator<< (raw_ostream &OS, const sandboxir::OpaqueInst &OI)
 

Additional Inherited Members

- 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
 
- Protected Member Functions inherited from llvm::sandboxir::Instruction
 Instruction (ClassID ID, Opcode Opc, llvm::Instruction *I, sandboxir::Context &SBCtx)
 
- 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
 
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 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 char * getSubclassIDStr (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::Value * Val = nullptr
 The LLVM Value that corresponds to this SandboxIR Value.
 
Context & Ctx
 All values point to the context.
 

Detailed Description

An LLLVM Instruction that has no SandboxIR equivalent class gets mapped to an OpaqueInstr.

Definition at line 537 of file SandboxIR.h.

Member Function Documentation

◆ classof()

static bool llvm::sandboxir::OpaqueInst::classof ( const sandboxir::Value *  From)
inlinestatic

Definition at line 548 of file SandboxIR.h.

References From.

◆ dump() [1/2]

void OpaqueInst::dump ( ) const
overridevirtual

Reimplemented from llvm::sandboxir::Instruction.

Definition at line 290 of file SandboxIR.cpp.

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

Referenced by dump().

◆ dump() [2/2]

void OpaqueInst::dump ( raw_ostream &  OS) const
overridevirtual

Reimplemented from llvm::sandboxir::Instruction.

Definition at line 285 of file SandboxIR.cpp.

References llvm::sandboxir::Value::dumpCommonPrefix(), llvm::sandboxir::Value::dumpCommonSuffix(), and OS.

◆ getNumOfIRInstrs()

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

This is used by BasicBlock::iterator.

Implements llvm::sandboxir::Instruction.

Definition at line 554 of file SandboxIR.h.

◆ getUseOperandNo()

unsigned llvm::sandboxir::OpaqueInst::getUseOperandNo ( const Use &  Use) const
inlinefinalvirtual

\Returns the operand index of Use.

Implements llvm::sandboxir::User.

Definition at line 551 of file SandboxIR.h.

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

◆ verify()

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

Should crash if there is something wrong with the instruction.

Reimplemented from llvm::sandboxir::User.

Definition at line 556 of file SandboxIR.h.

Friends And Related Function Documentation

◆ Context

friend class Context
friend

Definition at line 542 of file SandboxIR.h.

◆ operator<<

raw_ostream & operator<< ( raw_ostream &  OS,
const sandboxir::OpaqueInst &  OI 
)
friend

Definition at line 559 of file SandboxIR.h.

The documentation for this class was generated from the following files:
Generated on Mon Jul 15 2024 16:19:39 for LLVM by doxygen 1.9.6