#include "llvm/SandboxIR/SandboxIR.h"

Inheritance diagram for llvm::sandboxir::Function:

[legend]

Public Types
using	iterator = mapped_iterator< llvm::Function::iterator, LLVMBBToBB >

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
Argument *	getArg (unsigned Idx) const

size_t	arg_size () const

bool	arg_empty () const

iterator	begin () const

iterator	end () const

FunctionType *	getFunctionType () const

void	verify () const final
	Should crash if there is something wrong with the instruction.

void	dumpNameAndArgs (raw_ostream &OS) const

void	dumpOS (raw_ostream &OS) const final

Public Member Functions inherited from llvm::sandboxir::Constant
sandboxir::Context &	getParent () const

unsigned	getUseOperandNo (const Use &Use) const override
	\Returns the operand index of `Use`.

void	verify () const override
	Should crash if there is something wrong with the instruction.

void	dumpOS (raw_ostream &OS) 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	dumpOS (raw_ostream &OS) 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)

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	dumpOS (raw_ostream &OS) const =0

LLVM_DUMP_METHOD void	dump () const

Static Public Member Functions
static bool	classof (const sandboxir::Value *From)
	For isa/dyn_cast.

Static Public Member Functions inherited from llvm::sandboxir::Constant
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

Additional Inherited Members
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)

	Value (const Value &)=delete
	Disable copies.

Value &	operator= (const Value &)=delete

Static Protected Member Functions inherited from llvm::sandboxir::Value
static const char *	getSubclassIDStr (ClassID ID)

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

Definition at line 2249 of file SandboxIR.h.

Member Typedef Documentation

◆ iterator

using llvm::sandboxir::Function::iterator = mapped_iterator<llvm::Function::iterator, LLVMBBToBB>

Definition at line 2277 of file SandboxIR.h.

Member Function Documentation

◆ arg_empty()

bool llvm::sandboxir::Function::arg_empty ( ) const

inline

Definition at line 2275 of file SandboxIR.h.

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

◆ arg_size()

size_t llvm::sandboxir::Function::arg_size ( ) const

inline

Definition at line 2274 of file SandboxIR.h.

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

◆ begin()

iterator llvm::sandboxir::Function::begin ( ) const

inline

Definition at line 2278 of file SandboxIR.h.

References begin(), llvm::sandboxir::Value::Ctx, and llvm::sandboxir::Value::Val.

Referenced by begin().

◆ classof()

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

inlinestatic

For isa/dyn_cast.

Definition at line 2265 of file SandboxIR.h.

References From.

◆ dumpNameAndArgs()

void Function::dumpNameAndArgs ( raw_ostream & OS ) const

Definition at line 1790 of file SandboxIR.cpp.

References F, llvm::interleave(), OS, and llvm::sandboxir::Value::Val.

Referenced by dumpOS().

◆ dumpOS()

void Function::dumpOS ( raw_ostream & OS ) const

finalvirtual

Reimplemented from llvm::sandboxir::Constant.

Definition at line 1805 of file SandboxIR.cpp.

References llvm::sandboxir::Value::Ctx, dumpNameAndArgs(), llvm::sandboxir::Context::getValue(), llvm::interleave(), OS, and llvm::sandboxir::Value::Val.

◆ end()

iterator llvm::sandboxir::Function::end ( ) const

inline

Definition at line 2282 of file SandboxIR.h.

References llvm::sandboxir::Value::Ctx, end(), and llvm::sandboxir::Value::Val.

Referenced by end().

◆ getArg()

Argument * llvm::sandboxir::Function::getArg ( unsigned Idx ) const

inline

Definition at line 2269 of file SandboxIR.h.

References llvm::sandboxir::Value::Ctx, llvm::sandboxir::Context::getValue(), Idx, and llvm::sandboxir::Value::Val.

◆ getFunctionType()

FunctionType * llvm::sandboxir::Function::getFunctionType ( ) const

inline

Definition at line 2286 of file SandboxIR.h.

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

◆ verify()

void llvm::sandboxir::Function::verify ( ) const

inlinefinalvirtual

Should crash if there is something wrong with the instruction.

Reimplemented from llvm::sandboxir::Constant.

Definition at line 2291 of file SandboxIR.h.

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

Friends And Related Function Documentation

◆ Context

friend class Context

friend

Definition at line 2261 of file SandboxIR.h.

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

include/llvm/SandboxIR/SandboxIR.h
lib/SandboxIR/SandboxIR.cpp

Public Types

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ iterator

Member Function Documentation

◆ arg_empty()

◆ arg_size()

◆ begin()

◆ classof()

◆ dumpNameAndArgs()

◆ dumpOS()

◆ end()

◆ getArg()

◆ getFunctionType()

◆ verify()

Friends And Related Function Documentation

◆ Context