Inst Class Reference

#include <core/inst.h>

Inheritance diagram for Inst:

Collaboration diagram for Inst:

Public Types
enum	Kind : uint8_t { GET_INST }
Public Types inherited from User
using	op_iterator = Use *
using	const_op_iterator = const Use *
using	op_range = llvm::iterator_range< op_iterator >
using	const_op_range = llvm::iterator_range< const_op_iterator >
using	value_op_range = llvm::iterator_range< value_op_iterator >
using	const_value_op_range = llvm::iterator_range< const_value_op_iterator >
template<typename T >
using	conv_op_range = llvm::iterator_range< conv_op_iterator< T > >
template<typename T >
using	const_conv_op_range = llvm::iterator_range< const_conv_op_iterator< T > >
template<typename T >
using	unref_range = llvm::iterator_range< unref_iterator< T > >
template<typename T >
using	const_unref_range = llvm::iterator_range< const_unref_iterator< T > >
Public Types inherited from Value
enum	Kind { INST, GLOBAL, EXPR, CONST }
	Enumeration of value types.
template<typename T >
using	forward_it = std::iterator< std::forward_iterator_tag, T >
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
virtual	~Inst ()
	Destroys an instruction.
unsigned	GetOrder () const
	Returns a unique, stable identifier for the instruction.
void	removeFromParent ()
	Removes an instruction from the parent.
void	eraseFromParent ()
	Removes an instruction from the parent and deletes it.
Kind	GetKind () const
	Returns the instruction kind.
bool	Is (Kind kind) const
	Checks if the instruction is of a specific kind.
Block *	getParent () const
	Returns the parent node.
virtual unsigned	GetNumRets () const
	Returns the number of returned values.
virtual Type	GetType (unsigned i) const
	Returns the type of the ith return value.
bool	IsVoid () const
	Checks if the instruction is void.
virtual bool	IsReturn () const
	Checks if the instruction returns from the function.
virtual bool	IsConstant () const
	Checks if the instruction is constant.
virtual bool	IsTerminator () const
	Checks if the instruction is a terminator.
virtual bool	HasSideEffects () const
	Checks if the instruction has side effects.
template<typename T >
bool	HasAnnot () const
	Checks if a flag is set.
template<typename T >
bool	ClearAnnot ()
	Removes an annotation.
template<typename T >
const T *	GetAnnot () const
	Returns an annotation.
template<typename T , typename... Args>
bool	SetAnnot (Args &&... args)
	Sets an annotation.
bool	AddAnnot (const Annot &annot)
	Adds an annotation.
const AnnotSet &	GetAnnots () const
	Returns the instruction's annotation.
size_t	annot_size () const
	Returns the number of annotations.
bool	annot_empty () const
	Checks if any flags are set.
llvm::iterator_range< AnnotSet::const_iterator >	annots () const
	Iterator over annotations.
Ref< Inst >	GetSubValue (unsigned i)
	Returns the ith sub-value.
ConstRef< Inst >	GetSubValue (unsigned i) const
	Returns the ith sub-value.
void	replaceAllUsesWith (Value *v) override
	Replaces all uses of this value.
void	replaceAllUsesWith (llvm::ArrayRef< Ref< Inst >> v)
	Replaces all uses of a multi-type value.
template<typename T >
std::enable_if< std::is_base_of< Inst, T >::value >::type	replaceAllUsesWith (llvm::ArrayRef< Ref< T >> insts)
	Replaces all uses of a multi-type value.
void	dump (llvm::raw_ostream &os=llvm::errs()) const
	Dumps the textual representation of the instruction.
Public Member Functions inherited from User
	User (Kind kind, unsigned numOps)
	Creates a new user.
virtual	~User ()
	Cleans up after the use.
size_t	size () const
op_iterator	op_begin ()
op_iterator	op_end ()
op_range	operands ()
const_op_iterator	op_begin () const
const_op_iterator	op_end () const
const_op_range	operands () const
value_op_iterator	value_op_begin ()
value_op_iterator	value_op_end ()
value_op_range	operand_values ()
const_value_op_iterator	value_op_begin () const
const_value_op_iterator	value_op_end () const
const_value_op_range	operand_values () const
Public Member Functions inherited from Value
	Value (Kind kind)
	Constructs a new value.
	Value (const Value &)=delete
	Do not allow copying.
	Value (Value &&)=delete
	Do not allow moving.
virtual	~Value ()
	Destroy the value.
Kind	GetKind () const
	Returns the value kind.
bool	Is (Kind kind) const
	Checks if the value is of a specific kind.
bool	IsConstant () const
	Checks whether the value is a compile-time constant.
virtual void	replaceAllUsesWith (Ref< Value > v)
	Replaces all uses of this with a refernce.
size_t	use_size () const
bool	use_empty () const
use_iterator	use_begin ()
const_use_iterator	use_begin () const
use_iterator	use_end ()
const_use_iterator	use_end () const
llvm::iterator_range< use_iterator >	uses ()
llvm::iterator_range< const_use_iterator >	uses () const
bool	user_empty () const
user_iterator	user_begin ()
const_user_iterator	user_begin () const
user_iterator	user_end ()
const_user_iterator	user_end () const
llvm::iterator_range< user_iterator >	users ()
llvm::iterator_range< const_user_iterator >	users () const
void	operator= (const Value &)=delete
	Do not allow assignments.
void	operator= (Value &&)=delete
	Do not allow move assignments.

Static Public Attributes
static constexpr Value::Kind	kValueKind = Value::Kind::INST
	Kind of the instruction.

Protected Member Functions
	Inst (Kind kind, unsigned numOps, AnnotSet &&annot)
	Constructs an instruction of a given type.
	Inst (Kind kind, unsigned numOps, const AnnotSet &annot)
	Constructs an instruction of a given type.
Protected Member Functions inherited from User
template<int I>
void	Set (Ref< Value > val)
	Setter for an operand.
void	Set (int i, Ref< Value > val)
	Setter for an operand.
template<int I>
Ref< Value >	Get ()
	Accessor for an operand.
Ref< Value >	Get (int i)
	Accessor for an operand.
template<int I>
ConstRef< Value >	Get () const
	Accessor for an operand.
ConstRef< Value >	Get (int i) const
	Accessor for an operand.
void	resizeUses (unsigned n)
	Grows the operand list.

Protected Attributes
Block *	parent_
	Parent node.
unsigned	order_
	Unique number for stable ordering.
Protected Attributes inherited from User
unsigned	numOps_
	Number of operands.
Use *	uses_
	Head of the use list.

Friends
struct	llvm::ilist_traits< Inst >

Detailed Description

Basic instruction.

Member Enumeration Documentation

Kind

enum Inst::Kind : uint8_t

strong

Enumeration of instruction types.

---

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

• core/inst.h
• core/inst.cpp