An object representing a storage allocation. More...

#include <memory_manager.h>

Inheritance diagram for tvm::runtime::memory::StorageObj:

Collaboration diagram for tvm::runtime::memory::StorageObj:

Public Member Functions
NDArray	AllocNDArray (int64_t offset, ShapeTuple shape, DLDataType dtype)
	Allocate an NDArray from a given piece of storage. More...

NDArray	AllocNDArrayScoped (int64_t offset, ShapeTuple shape, DLDataType dtype, String scope="global")
	Allocate an NDArray with memory scope from a given piece of storage. More...

	~StorageObj ()

	TVM_DECLARE_FINAL_OBJECT_INFO (StorageObj, 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)

Static Public Member Functions
static void	ScopedDeleter (Object *ptr)
	The deleter for an NDArray when allocated from underlying storage. More...

static void	Deleter (Object *ptr)
	The deleter for an NDArray when allocated from underlying storage. More...

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

Public Attributes
Buffer	buffer
	The index into the VM function table. More...

Allocator *	allocator = nullptr
	The allocator where the storage buffer is allocated from. More...

Static Public Attributes
static constexpr const uint32_t	_type_index = TypeIndex::kDynamic

static constexpr const char *	_type_key = "vm.Storage"

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 >

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 representing a storage allocation.

Constructor & Destructor Documentation

◆ ~StorageObj()

tvm::runtime::memory::StorageObj::~StorageObj ( )

inline

Member Function Documentation

◆ AllocNDArray()

NDArray tvm::runtime::memory::StorageObj::AllocNDArray	(	int64_t	offset,
		ShapeTuple	shape,
		DLDataType	dtype
	)

Allocate an NDArray from a given piece of storage.

◆ AllocNDArrayScoped()

NDArray tvm::runtime::memory::StorageObj::AllocNDArrayScoped	(	int64_t	offset,
		ShapeTuple	shape,
		DLDataType	dtype,
		String	scope = `"global"`
	)

Allocate an NDArray with memory scope from a given piece of storage.

◆ Deleter()

static void tvm::runtime::memory::StorageObj::Deleter ( Object * ptr )

static

The deleter for an NDArray when allocated from underlying storage.

◆ ScopedDeleter()

static void tvm::runtime::memory::StorageObj::ScopedDeleter ( Object * ptr )

static

The deleter for an NDArray when allocated from underlying storage.

◆ TVM_DECLARE_FINAL_OBJECT_INFO()

tvm::runtime::memory::StorageObj::TVM_DECLARE_FINAL_OBJECT_INFO	(	StorageObj	,
		Object
	)

Member Data Documentation

◆ _type_index

constexpr const uint32_t tvm::runtime::memory::StorageObj::_type_index = TypeIndex::kDynamic

staticconstexpr

◆ _type_key

constexpr const char* tvm::runtime::memory::StorageObj::_type_key = "vm.Storage"

staticconstexpr

◆ allocator

Allocator* tvm::runtime::memory::StorageObj::allocator = nullptr

The allocator where the storage buffer is allocated from.

◆ buffer

Buffer tvm::runtime::memory::StorageObj::buffer

The index into the VM function table.

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

include/tvm/runtime/memory/memory_manager.h

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Additional Inherited Members