tvm::PoolInfoNode Struct Reference

Describes a pool of memory accessible by one or more targets. More...

#include <memory_pools.h>

Inheritance diagram for tvm::PoolInfoNode:

Collaboration diagram for tvm::PoolInfoNode:

Public Member Functions
void	VisitAttrs (tvm::AttrVisitor *v)
bool	SEqualReduce (const PoolInfoNode *other, SEqualReducer equal) const
void	SHashReduce (SHashReducer hash_reduce) const
	TVM_DECLARE_BASE_OBJECT_INFO (PoolInfoNode, Object)
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
String	pool_name
	The name of the memory pool. More...
Integer	size_hint_bytes
	The expected size hint to be used by the allocator. The size_hint_bytes is set to kUnrestrictedPoolSizeHint to indicate the pool is not size restricted. More...
Integer	clock_frequency_hz
	The clock frequency of the memory in Hz. More...
Integer	read_bandwidth_bytes_per_cycle
	The read bandwidth in bytes/cycle. More...
Integer	write_bandwidth_bytes_per_cycle
	The write bandwidth in bytes/cycle. More...
Integer	read_latency_cycles
	The read latency in cycles. More...
Integer	write_latency_cycles
	The write latency in cycles. More...
Map< Target, Integer >	target_burst_bytes
	The burst length in bytes for each Target. More...
bool	is_internal = false
	Whether pool is internally generated. The internal pools will be generated as part of the entry point code generation of the executor. More...
Array< Target >	targets
	The targets linked to the pool. More...

Static Public Attributes
static constexpr const char *	_type_key = "ir.PoolInfo"
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

Describes a pool of memory accessible by one or more targets.

Member Function Documentation

SEqualReduce()

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

inline

SHashReduce()

void tvm::PoolInfoNode::SHashReduce ( SHashReducer  hash_reduce ) const

inline

TVM_DECLARE_BASE_OBJECT_INFO()

tvm::PoolInfoNode::TVM_DECLARE_BASE_OBJECT_INFO	(	PoolInfoNode	,
		Object
	)

VisitAttrs()

void tvm::PoolInfoNode::VisitAttrs ( tvm::AttrVisitor *  v )

inline

Member Data Documentation

_type_key

constexpr const char* tvm::PoolInfoNode::_type_key = "ir.PoolInfo"

staticconstexpr

clock_frequency_hz

Integer tvm::PoolInfoNode::clock_frequency_hz

The clock frequency of the memory in Hz.

is_internal

bool tvm::PoolInfoNode::is_internal = false

Whether pool is internally generated. The internal pools will be generated as part of the entry point code generation of the executor.

pool_name

String tvm::PoolInfoNode::pool_name

The name of the memory pool.

read_bandwidth_bytes_per_cycle

Integer tvm::PoolInfoNode::read_bandwidth_bytes_per_cycle

The read bandwidth in bytes/cycle.

read_latency_cycles

Integer tvm::PoolInfoNode::read_latency_cycles

The read latency in cycles.

size_hint_bytes

Integer tvm::PoolInfoNode::size_hint_bytes

The expected size hint to be used by the allocator. The size_hint_bytes is set to kUnrestrictedPoolSizeHint to indicate the pool is not size restricted.

target_burst_bytes

Map<Target, Integer> tvm::PoolInfoNode::target_burst_bytes

The burst length in bytes for each Target.

targets

Array<Target> tvm::PoolInfoNode::targets

The targets linked to the pool.

write_bandwidth_bytes_per_cycle

Integer tvm::PoolInfoNode::write_bandwidth_bytes_per_cycle

The write bandwidth in bytes/cycle.

write_latency_cycles

Integer tvm::PoolInfoNode::write_latency_cycles

The write latency in cycles.

---

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

• include/tvm/ir/memory_pools.h