tvm
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
tvm::tir::usmp::BufferInfoNode Struct Reference

Describes an abstract memory buffer that will get allocated inside a pool. The actual memory buffer in represented by PoolAllocationNode after static memory planning. More...

#include <utils.h>

Inheritance diagram for tvm::tir::usmp::BufferInfoNode:
Collaboration diagram for tvm::tir::usmp::BufferInfoNode:

Public Member Functions

void VisitAttrs (tvm::AttrVisitor *v)
 
bool SEqualReduce (const BufferInfoNode *other, SEqualReducer equal) const
 
void SHashReduce (SHashReducer hash_reduce) const
 
void SetConflicts (Array< ObjectRef > conflicting_buffer_info_objs)
 Set the liveness conflicts of this BufferInfo. More...
 
 TVM_DECLARE_FINAL_OBJECT_INFO (BufferInfoNode, 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)
 
Objectoperator= (const Object &other)
 
Objectoperator= (Object &&other)
 

Public Attributes

String name_hint
 The name of the buffer var. More...
 
Integer size_bytes
 The size in terms of bytes. More...
 
Array< PoolInfopool_candidates
 The pool candidates that this buffer can get pooled to. More...
 
Integer alignment
 The byte alignment required for buffers that will placed within the pool. More...
 
Array< ObjectRefconflicts
 The liveness conflicting other buffer info objects. More...
 
BufferInfoKind kind
 Whether BufferInfo object retains info about IO tensors or intermediaries. More...
 

Static Public Attributes

static constexpr const char * _type_key = "tir.usmp.BufferInfo"
 
- 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 an abstract memory buffer that will get allocated inside a pool. The actual memory buffer in represented by PoolAllocationNode after static memory planning.

See also for relay-level counterparts: relay::StorageToken (graph_plan_memory.cc) relay::backend::StorageInfoNode (relay/backend/utils.h) Region (python/tvm/relay/transform/memory_plan.py)

Member Function Documentation

◆ SEqualReduce()

bool tvm::tir::usmp::BufferInfoNode::SEqualReduce ( const BufferInfoNode other,
SEqualReducer  equal 
) const
inline

◆ SetConflicts()

void tvm::tir::usmp::BufferInfoNode::SetConflicts ( Array< ObjectRef conflicting_buffer_info_objs)

Set the liveness conflicts of this BufferInfo.

Parameters
conflicting_buffer_info_objsAn array of BufferInfo that conflicts in liveness

◆ SHashReduce()

void tvm::tir::usmp::BufferInfoNode::SHashReduce ( SHashReducer  hash_reduce) const
inline

◆ TVM_DECLARE_FINAL_OBJECT_INFO()

tvm::tir::usmp::BufferInfoNode::TVM_DECLARE_FINAL_OBJECT_INFO ( BufferInfoNode  ,
Object   
)

◆ VisitAttrs()

void tvm::tir::usmp::BufferInfoNode::VisitAttrs ( tvm::AttrVisitor v)
inline

Member Data Documentation

◆ _type_key

constexpr const char* tvm::tir::usmp::BufferInfoNode::_type_key = "tir.usmp.BufferInfo"
staticconstexpr

◆ alignment

Integer tvm::tir::usmp::BufferInfoNode::alignment

The byte alignment required for buffers that will placed within the pool.

◆ conflicts

Array<ObjectRef> tvm::tir::usmp::BufferInfoNode::conflicts

The liveness conflicting other buffer info objects.

◆ kind

BufferInfoKind tvm::tir::usmp::BufferInfoNode::kind

Whether BufferInfo object retains info about IO tensors or intermediaries.

◆ name_hint

String tvm::tir::usmp::BufferInfoNode::name_hint

The name of the buffer var.

◆ pool_candidates

Array<PoolInfo> tvm::tir::usmp::BufferInfoNode::pool_candidates

The pool candidates that this buffer can get pooled to.

◆ size_bytes

Integer tvm::tir::usmp::BufferInfoNode::size_bytes

The size in terms of bytes.


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