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...

DataType	DefaultIndexType () const

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

	TVM_FFI_DECLARE_OBJECT_INFO_FINAL ("tir.Buffer", BufferNode, Object)

	TVM_OBJECT_ENABLE_SCRIPT_PRINTER ()

Static Public Member Functions
static void	RegisterReflection ()

Public Attributes
Var	data
	The pointer to the head of the data. More...

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

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

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

ffi::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...

ffi::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 TVMFFISEqHashKind	_type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode

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()

ffi::Array<PrimExpr> tvm::tir::BufferNode::ElemOffset ( ffi::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.)

◆ RegisterReflection()

static void tvm::tir::BufferNode::RegisterReflection ( )

inlinestatic

◆ TVM_FFI_DECLARE_OBJECT_INFO_FINAL()

tvm::tir::BufferNode::TVM_FFI_DECLARE_OBJECT_INFO_FINAL	(	"tir.Buffer"	,
		BufferNode	,
		Object
	)

◆ TVM_OBJECT_ENABLE_SCRIPT_PRINTER()

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

Member Data Documentation

◆ _type_s_eq_hash_kind

constexpr TVMFFISEqHashKind tvm::tir::BufferNode::_type_s_eq_hash_kind = kTVMFFISEqHashKindTreeNode

staticconstexpr

◆ axis_separators

ffi::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

ffi::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

ffi::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

ffi::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

Static Public Member Functions

Public Attributes

Static Public Attributes