tvm::tir::StmtSRefNode Class Reference

An object that refers to schedulable elements (block/for-loop) in TensorIR, aka "sref". More...

#include <block_scope.h>

Inheritance diagram for tvm::tir::StmtSRefNode:

Collaboration diagram for tvm::tir::StmtSRefNode:

Public Member Functions
void	VisitAttrs (AttrVisitor *v)
	TVM_DECLARE_FINAL_OBJECT_INFO (StmtSRefNode, Object)
void	Reset ()
	Reset the object inplace to the invalid state. More...
template<typename StmtType >
const StmtType *	StmtAs () const
	Get the referenced statement with proper type checking. It serves the same purpose as ObjectRef::as, but does not acquire strong reference to stmt More...
Public Member Functions inherited from tvm::runtime::Object
uint32_t	type_index () const
std::string	GetTypeKey () const
size_t	GetTypeKeyHash () const
template<typename TargetType >
bool	IsInstance () const
bool	unique () const
	Object ()
	Object (const Object &other)
	Object (Object &&other)
Object &	operator= (const Object &other)
Object &	operator= (Object &&other)

Public Attributes
const StmtNode *	stmt
	The block or for stmt the object refers to. More...
StmtSRefNode *	parent
	The parent sref. More...
int64_t	seq_index
	If the statement the sref points to is an element of a SeqStmt in the AST, then seq_index is set to its index; otherwise seq_index is -1. More...

Static Public Attributes
static constexpr const char *	_type_key = "tir.StmtSRef"
Static Public Attributes inherited from tvm::runtime::Object
static constexpr const char *	_type_key = "runtime.Object"
static constexpr bool	_type_final = false
static constexpr uint32_t	_type_child_slots = 0
static constexpr bool	_type_child_slots_can_overflow = true
static constexpr bool	_type_has_method_visit_attrs = true
static constexpr bool	_type_has_method_sequal_reduce = false
static constexpr bool	_type_has_method_shash_reduce = false
static constexpr uint32_t	_type_index = TypeIndex::kDynamic

Additional Inherited Members
Public Types inherited from tvm::runtime::Object
typedef void(*	FDeleter) (Object *self)
	Object deleter. More...
using	RefCounterType = std::atomic< int32_t >
Static Public Member Functions inherited from tvm::runtime::Object
static std::string	TypeIndex2Key (uint32_t tindex)
	Get the type key of the corresponding index from runtime. More...
static size_t	TypeIndex2KeyHash (uint32_t tindex)
	Get the type key hash of the corresponding index from runtime. More...
static uint32_t	TypeKey2Index (const std::string &key)
	Get the type index of the corresponding key from runtime. More...
static uint32_t	_GetOrAllocRuntimeTypeIndex ()
static uint32_t	RuntimeTypeIndex ()
Protected Member Functions inherited from tvm::runtime::Object
void	IncRef ()
	developer function, increases reference counter. More...
void	DecRef ()
	developer function, decrease reference counter. More...
Static Protected Member Functions inherited from tvm::runtime::Object
static uint32_t	GetOrAllocRuntimeTypeIndex (const std::string &key, uint32_t static_tindex, uint32_t parent_tindex, uint32_t type_child_slots, bool type_child_slots_can_overflow)
	Get the type index using type key. More...
Protected Attributes inherited from tvm::runtime::Object
uint32_t	type_index_ {0}
	Type index(tag) that indicates the type of the object. More...
RefCounterType	ref_counter_ {0}
	The internal reference counter. More...
FDeleter	deleter_ = nullptr
	deleter of this object to enable customized allocation. If the deleter is nullptr, no deletion will be performed. The creator of the object must always set the deleter field properly. More...

Detailed Description

An object that refers to schedulable elements (block/for-loop) in TensorIR, aka "sref".

Glossary

• Block sref: A StmtSRef that points to a TensorIR block.
• Loop sref: A StmtSRef that points to a TensorIR for loop.
• Parent sref: The parent reference of an sref is the block or loop reference to the closest schedulable statement. We define closest to be the nearest schedulable statement of an ancestor in the AST. schedulable statement of its ancestors on the TensorIR AST.
• Root sref: Sref to the root block. Every sref has exactly one parent sref except for root sref.
• Sref tree: The parent-children-relationship of srefs that forms a tree, uniquely determined by the TensorIR AST.

Member Function Documentation

Reset()

void tvm::tir::StmtSRefNode::Reset ( )

inline

Reset the object inplace to the invalid state.

StmtAs()

template<typename StmtType >

const StmtType* tvm::tir::StmtSRefNode::StmtAs ( ) const

inline

Get the referenced statement with proper type checking. It serves the same purpose as ObjectRef::as, but does not acquire strong reference to stmt

Template Parameters

StmtType

The type that this->stmt to be downcasted to. Presumably tvm::tir::BlockNode or tvm::tir::ForNode

Returns

nullptr if type check fails, otherwise the casted result for this->stmt

TVM_DECLARE_FINAL_OBJECT_INFO()

tvm::tir::StmtSRefNode::TVM_DECLARE_FINAL_OBJECT_INFO	(	StmtSRefNode	,
		Object
	)

VisitAttrs()

void tvm::tir::StmtSRefNode::VisitAttrs ( AttrVisitor *  v )

inline

Member Data Documentation

_type_key

constexpr const char* tvm::tir::StmtSRefNode::_type_key = "tir.StmtSRef"

staticconstexpr

parent

StmtSRefNode* tvm::tir::StmtSRefNode::parent

The parent sref.

seq_index

int64_t tvm::tir::StmtSRefNode::seq_index

If the statement the sref points to is an element of a SeqStmt in the AST, then seq_index is set to its index; otherwise seq_index is -1.

stmt

const StmtNode* tvm::tir::StmtSRefNode::stmt

The block or for stmt the object refers to.

Note

Non-owned reference (raw pointer) is used here, so that we can perform copy-on-write optimization on statements when possible. The strong reference is held in the ScheduleState.

---

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

• include/tvm/tir/block_scope.h