Node to represent a buffer. More...

#include <buffer.h>

Inheritance diagram for tvm::tir::BufferNode:

Collaboration diagram for tvm::tir::BufferNode:

Public Member Functions
	BufferNode ()
	constructor More...

void	VisitAttrs (AttrVisitor *v)

bool	SEqualReduce (const BufferNode *other, SEqualReducer equal) const

void	SHashReduce (SHashReducer hash_reduce) const

DataType	DefaultIndexType () const

Array< PrimExpr >	ElemOffset (Array< PrimExpr > index) const
	Determine the offset in the buffer of the given index. More...

	TVM_DECLARE_FINAL_OBJECT_INFO (BufferNode, Object)

	TVM_OBJECT_ENABLE_SCRIPT_PRINTER ()

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
Var	data
	The pointer to the head of the data. More...

DataType	dtype
	data type in the content of the tensor More...

Array< PrimExpr >	shape
	The type of the buffer prior to flattening. More...

Array< IntImm >	axis_separators
	Separators between input axes when generating flattened output axes. More...

Array< PrimExpr >	strides
	The strides of each dimension This can be an empty array, indicating array is contiguous. More...

PrimExpr	elem_offset
	The offset in terms of number of dtype elements (including lanes) More...

String	name
	optional name of the buffer More...

int	data_alignment
	Alignment requirement of data pointer in bytes. More...

int	offset_factor
	Factor of elem_offset field, elem_offset is guaranteed to be multiple of offset_factor. More...

BufferType	buffer_type
	buffer type More...

Span	span
	Span that points to the original source code. Reserved debug information. More...

Static Public Attributes
static constexpr const char *	_type_key = "tir.Buffer"

static constexpr const bool	_type_has_method_sequal_reduce = true

static constexpr const bool	_type_has_method_shash_reduce = true

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

Node to represent a buffer.

Constructor & Destructor Documentation

◆ BufferNode()

tvm::tir::BufferNode::BufferNode ( )

inline

constructor

Member Function Documentation

◆ DefaultIndexType()

DataType tvm::tir::BufferNode::DefaultIndexType ( ) const

inline

Returns: preferred index type for this buffer node

◆ ElemOffset()

Array<PrimExpr> tvm::tir::BufferNode::ElemOffset ( Array< PrimExpr > index ) const

Determine the offset in the buffer of the given index.

Returns the buffer offset, in number of elements of type dtype, without adjusting for number of lanes. (e.g. The number of float16x4 elements in a buffer of type float16x4.)

◆ SEqualReduce()

bool tvm::tir::BufferNode::SEqualReduce	(	const BufferNode *	other,
		SEqualReducer	equal
	)		const

inline

◆ SHashReduce()

void tvm::tir::BufferNode::SHashReduce ( SHashReducer hash_reduce ) const

inline

◆ TVM_DECLARE_FINAL_OBJECT_INFO()

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

◆ TVM_OBJECT_ENABLE_SCRIPT_PRINTER()

tvm::tir::BufferNode::TVM_OBJECT_ENABLE_SCRIPT_PRINTER ( )

◆ VisitAttrs()

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

inline

Member Data Documentation

◆ _type_has_method_sequal_reduce

constexpr const bool tvm::tir::BufferNode::_type_has_method_sequal_reduce = true

staticconstexpr

◆ _type_has_method_shash_reduce

constexpr const bool tvm::tir::BufferNode::_type_has_method_shash_reduce = true

staticconstexpr

◆ _type_key

constexpr const char* tvm::tir::BufferNode::_type_key = "tir.Buffer"

staticconstexpr

◆ axis_separators

Array<IntImm> tvm::tir::BufferNode::axis_separators

Separators between input axes when generating flattened output axes.

For buffers representing flat 1-d memory (e.g. any buffer in RAM), this should be an empty array. For buffers representing non-flat memory, each entry in axis_separators should be the first input axis that is part of a new flattened axis.

◆ buffer_type

BufferType tvm::tir::BufferNode::buffer_type

buffer type

◆ data

Var tvm::tir::BufferNode::data

The pointer to the head of the data.

See also: data_alignment The alignment of data in bytes.

◆ data_alignment

int tvm::tir::BufferNode::data_alignment

Alignment requirement of data pointer in bytes.

◆ dtype

DataType tvm::tir::BufferNode::dtype

data type in the content of the tensor

◆ elem_offset

PrimExpr tvm::tir::BufferNode::elem_offset

The offset in terms of number of dtype elements (including lanes)

◆ name

String tvm::tir::BufferNode::name

optional name of the buffer

◆ offset_factor

int tvm::tir::BufferNode::offset_factor

Factor of elem_offset field, elem_offset is guaranteed to be multiple of offset_factor.

◆ shape

Array<PrimExpr> tvm::tir::BufferNode::shape

The type of the buffer prior to flattening.

This contains the shape as it is accessed by BufferLoad/BufferStore nodes, and used by the low-level code generators.

◆ span

Span tvm::tir::BufferNode::span

mutable

Span that points to the original source code. Reserved debug information.

◆ strides

Array<PrimExpr> tvm::tir::BufferNode::strides

The strides of each dimension This can be an empty array, indicating array is contiguous.

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

include/tvm/tir/buffer.h

Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ BufferNode()

Member Function Documentation

◆ DefaultIndexType()

◆ ElemOffset()

◆ SEqualReduce()

◆ SHashReduce()

◆ TVM_DECLARE_FINAL_OBJECT_INFO()

◆ TVM_OBJECT_ENABLE_SCRIPT_PRINTER()

◆ VisitAttrs()

Member Data Documentation

◆ _type_has_method_sequal_reduce

◆ _type_has_method_shash_reduce

◆ _type_key

◆ axis_separators

◆ buffer_type

◆ data

◆ data_alignment

◆ dtype

◆ elem_offset

◆ name

◆ offset_factor

◆ shape

◆ span

◆ strides