Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator Class Reference

Vulkan Memory Allocator class interface for managing large memory requests stored as contiguous blocks of memory, which are then sub-allocated into smaller regions of memory to avoid the excessive cost of vkAllocate and the limited number of available allocation calls through the API. More...

#include <vulkan_memory.h>

Public Member Functions
	VulkanMemoryAllocator (const VulkanMemoryAllocator &)=delete
VulkanMemoryAllocator &	operator= (const VulkanMemoryAllocator &)=delete
	VulkanMemoryAllocator ()=delete
	~VulkanMemoryAllocator ()=delete
MemoryRegion *	reserve (void *user_context, MemoryRequest &request)
int	release (void *user_context, MemoryRegion *region)
int	reclaim (void *user_context, MemoryRegion *region)
int	retain (void *user_context, MemoryRegion *region)
bool	collect (void *user_context)
int	release (void *user_context)
int	destroy (void *user_context)
void *	map (void *user_context, MemoryRegion *region)
int	unmap (void *user_context, MemoryRegion *region)
MemoryRegion *	create_crop (void *user_context, MemoryRegion *region, uint64_t offset)
int	destroy_crop (void *user_context, MemoryRegion *region)
MemoryRegion *	owner_of (void *user_context, MemoryRegion *region)
VkDevice	current_device () const
VkPhysicalDevice	current_physical_device () const
const VkAllocationCallbacks *	callbacks () const
size_t	bytes_allocated_for_blocks () const
size_t	blocks_allocated () const
size_t	bytes_allocated_for_regions () const
size_t	regions_allocated () const

Static Public Member Functions
static VulkanMemoryAllocator *	create (void *user_context, const VulkanMemoryConfig &config, VkDevice dev, VkPhysicalDevice phys_dev, const SystemMemoryAllocatorFns &system_allocator, const VkAllocationCallbacks *alloc_callbacks=nullptr)
static int	destroy (void *user_context, VulkanMemoryAllocator *allocator)
static const VulkanMemoryConfig &	default_config ()
static int	allocate_block (void *instance_ptr, MemoryBlock *block)
static int	deallocate_block (void *instance_ptr, MemoryBlock *block)
static int	allocate_region (void *instance_ptr, MemoryRegion *region)
static int	deallocate_region (void *instance_ptr, MemoryRegion *region)

Detailed Description

Vulkan Memory Allocator class interface for managing large memory requests stored as contiguous blocks of memory, which are then sub-allocated into smaller regions of memory to avoid the excessive cost of vkAllocate and the limited number of available allocation calls through the API.

Definition at line 42 of file vulkan_memory.h.

Constructor & Destructor Documentation

VulkanMemoryAllocator() [1/2]

Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::VulkanMemoryAllocator ( const VulkanMemoryAllocator & )

delete

References VulkanMemoryAllocator().

Referenced by allocate_block(), allocate_region(), create(), deallocate_block(), deallocate_region(), destroy(), operator=(), VulkanMemoryAllocator(), and ~VulkanMemoryAllocator().

VulkanMemoryAllocator() [2/2]

Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::VulkanMemoryAllocator ( )

delete

~VulkanMemoryAllocator()

Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::~VulkanMemoryAllocator ( )

delete

References VulkanMemoryAllocator().

Member Function Documentation

operator=()

VulkanMemoryAllocator & Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::operator= ( const VulkanMemoryAllocator & )

delete

References VulkanMemoryAllocator().

create()

VulkanMemoryAllocator * Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::create ( void * user_context, const VulkanMemoryConfig & config, VkDevice dev, VkPhysicalDevice phys_dev, const SystemMemoryAllocatorFns & system_allocator, const VkAllocationCallbacks * alloc_callbacks = nullptr )

static

Definition at line 129 of file vulkan_memory.h.

References Halide::Runtime::Internal::SystemMemoryAllocatorFns::allocate, and VulkanMemoryAllocator().

destroy() [1/2]

int Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::destroy ( void * user_context, VulkanMemoryAllocator * allocator )

static

Definition at line 151 of file vulkan_memory.h.

References Halide::Runtime::Internal::BlockAllocator::current_allocators(), Halide::Runtime::Internal::SystemMemoryAllocatorFns::deallocate, Halide::Runtime::Internal::BlockAllocator::destroy(), destroy(), halide_error_code_internal_error, halide_error_code_success, Halide::Runtime::Internal::BlockAllocator::MemoryAllocators::system, and VulkanMemoryAllocator().

Referenced by destroy().

reserve()

MemoryRegion * Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::reserve	(	void *	user_context,
		MemoryRequest &	request )

Definition at line 205 of file vulkan_memory.h.

References Halide::Runtime::Internal::MemoryRequest::size.

release() [1/2]

int Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::release	(	void *	user_context,
		MemoryRegion *	region )

Definition at line 424 of file vulkan_memory.h.

References halide_error_code_generic_error, Halide::Runtime::Internal::MemoryRegion::offset, and Halide::Runtime::Internal::MemoryRegion::size.

reclaim()

int Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::reclaim	(	void *	user_context,
		MemoryRegion *	region )

Definition at line 443 of file vulkan_memory.h.

References halide_error_code_generic_error, Halide::Runtime::Internal::MemoryRegion::offset, and Halide::Runtime::Internal::MemoryRegion::size.

retain()

int Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::retain	(	void *	user_context,
		MemoryRegion *	region )

Definition at line 462 of file vulkan_memory.h.

References halide_error_code_generic_error, Halide::Runtime::Internal::MemoryRegion::offset, and Halide::Runtime::Internal::MemoryRegion::size.

collect()

bool Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::collect

(

void *

user_context

)

Definition at line 481 of file vulkan_memory.h.

release() [2/2]

int Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::release

(

void *

user_context

)

Definition at line 492 of file vulkan_memory.h.

References halide_error_code_generic_error.

destroy() [2/2]

int Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::destroy

(

void *

user_context

)

Definition at line 509 of file vulkan_memory.h.

References halide_error_code_success.

map()

void * Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::map	(	void *	user_context,
		MemoryRegion *	region )

Definition at line 228 of file vulkan_memory.h.

References Halide::Runtime::Internal::RegionAllocator::block_resource(), Halide::Runtime::Internal::RegionAllocator::find_allocator(), Halide::Runtime::Internal::MemoryBlock::handle, Halide::Runtime::Internal::MemoryRange::head_offset, Halide::Runtime::Internal::BlockResource::memory, Halide::Runtime::Internal::MemoryRegion::offset, owner_of(), Halide::Runtime::Internal::MemoryRegion::range, Halide::Runtime::Internal::MemoryRegion::size, Halide::Runtime::Internal::MemoryRange::tail_offset, VK_SUCCESS, and vkMapMemory().

unmap()

int Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::unmap	(	void *	user_context,
		MemoryRegion *	region )

Definition at line 293 of file vulkan_memory.h.

References Halide::Runtime::Internal::RegionAllocator::block_resource(), Halide::Runtime::Internal::RegionAllocator::find_allocator(), halide_error_code_generic_error, halide_error_code_internal_error, halide_error_code_success, Halide::Runtime::Internal::MemoryBlock::handle, Halide::Runtime::Internal::MemoryRange::head_offset, Halide::Runtime::Internal::BlockResource::memory, Halide::Runtime::Internal::MemoryRegion::offset, owner_of(), Halide::Runtime::Internal::MemoryRegion::range, Halide::Runtime::Internal::MemoryRegion::size, and vkUnmapMemory().

create_crop()

MemoryRegion * Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::create_crop	(	void *	user_context,
		MemoryRegion *	region,
		uint64_t	offset )

Definition at line 332 of file vulkan_memory.h.

References Halide::Runtime::Internal::SystemMemoryAllocatorFns::allocate, Halide::Runtime::Internal::RegionAllocator::find_allocator(), halide_error_code_success, Halide::Runtime::Internal::MemoryRegion::handle, Halide::Runtime::Internal::MemoryRange::head_offset, Halide::Runtime::Internal::MemoryRegion::is_owner, memcpy(), Halide::Runtime::Internal::MemoryRegion::offset, owner_of(), Halide::Runtime::Internal::MemoryRegion::range, Halide::Runtime::Internal::RegionAllocator::retain(), Halide::Runtime::Internal::MemoryRegion::size, and Halide::Runtime::Internal::BlockAllocator::MemoryAllocators::system.

destroy_crop()

int Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::destroy_crop	(	void *	user_context,
		MemoryRegion *	region )

Definition at line 385 of file vulkan_memory.h.

References Halide::Runtime::Internal::SystemMemoryAllocatorFns::deallocate, Halide::Runtime::Internal::RegionAllocator::find_allocator(), halide_error_code_generic_error, halide_error_code_internal_error, halide_error_code_success, owner_of(), Halide::Runtime::Internal::RegionAllocator::release(), and Halide::Runtime::Internal::BlockAllocator::MemoryAllocators::system.

owner_of()

MemoryRegion * Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::owner_of	(	void *	user_context,
		MemoryRegion *	region )

Definition at line 415 of file vulkan_memory.h.

References Halide::Runtime::Internal::MemoryRegion::handle, and Halide::Runtime::Internal::MemoryRegion::is_owner.

Referenced by create_crop(), destroy_crop(), map(), and unmap().

current_device()

VkDevice Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::current_device ( ) const

inline

Definition at line 75 of file vulkan_memory.h.

current_physical_device()

VkPhysicalDevice Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::current_physical_device ( ) const

inline

Definition at line 78 of file vulkan_memory.h.

callbacks()

const VkAllocationCallbacks * Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::callbacks ( ) const

inline

Definition at line 81 of file vulkan_memory.h.

default_config()

const VulkanMemoryConfig & Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::default_config ( )

static

Definition at line 525 of file vulkan_memory.h.

allocate_block()

int Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::allocate_block ( void * instance_ptr, MemoryBlock * block )

static

Definition at line 532 of file vulkan_memory.h.

References Halide::Runtime::Internal::MemoryProperties::alignment, VkMemoryRequirements::alignment, Halide::Runtime::Internal::MemoryProperties::caching, Halide::Runtime::Internal::MemoryBlock::dedicated, halide_error_code_device_malloc_failed, halide_error_code_generic_error, halide_error_code_internal_error, halide_error_code_out_of_memory, halide_error_code_success, halide_memory_caching_name(), halide_memory_usage_name(), halide_memory_visibility_name(), Halide::Runtime::Internal::MemoryBlock::handle, VkPhysicalDeviceLimits::minStorageBufferOffsetAlignment, VkPhysicalDeviceLimits::minUniformBufferOffsetAlignment, Halide::Runtime::Internal::MemoryBlock::properties, Halide::Runtime::Internal::MemoryBlock::size, Halide::Runtime::Internal::MemoryProperties::usage, Halide::Runtime::Internal::MemoryProperties::visibility, VK_BUFFER_USAGE_STORAGE_BUFFER_BIT, VK_BUFFER_USAGE_UNIFORM_BUFFER_BIT, VK_SHARING_MODE_EXCLUSIVE, VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO, VK_STRUCTURE_TYPE_MEMORY_ALLOCATE_INFO, VK_SUCCESS, VK_SYSTEM_ALLOCATION_SCOPE_OBJECT, vkAllocateMemory(), vkCreateBuffer(), vkDestroyBuffer(), vkGetBufferMemoryRequirements(), and VulkanMemoryAllocator().

deallocate_block()

int Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::deallocate_block ( void * instance_ptr, MemoryBlock * block )

static

Definition at line 639 of file vulkan_memory.h.

References Halide::Runtime::Internal::MemoryProperties::caching, Halide::Runtime::Internal::MemoryBlock::dedicated, halide_error_code_internal_error, halide_error_code_success, halide_memory_caching_name(), halide_memory_usage_name(), halide_memory_visibility_name(), Halide::Runtime::Internal::MemoryBlock::handle, Halide::Runtime::Internal::MemoryBlock::properties, Halide::Runtime::Internal::MemoryBlock::size, Halide::Runtime::Internal::MemoryProperties::usage, Halide::Runtime::Internal::MemoryProperties::visibility, vkFreeMemory(), and VulkanMemoryAllocator().

allocate_region()

int Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::allocate_region ( void * instance_ptr, MemoryRegion * region )

static

Definition at line 813 of file vulkan_memory.h.

References Halide::Runtime::Internal::RegionAllocator::block_resource(), Halide::Runtime::Internal::MemoryProperties::caching, Halide::Runtime::Internal::MemoryRegion::dedicated, Halide::Runtime::Internal::RegionAllocator::find_allocator(), halide_error_code_device_malloc_failed, halide_error_code_generic_error, halide_error_code_internal_error, halide_error_code_out_of_memory, halide_error_code_success, halide_memory_caching_name(), halide_memory_usage_name(), halide_memory_visibility_name(), Halide::Runtime::Internal::MemoryBlock::handle, Halide::Runtime::Internal::MemoryRegion::handle, Halide::Runtime::Internal::MemoryRegion::is_owner, Halide::Runtime::Internal::BlockResource::memory, Halide::Runtime::Internal::MemoryRegion::offset, Halide::Runtime::Internal::MemoryRegion::properties, Halide::Runtime::Internal::MemoryRegion::size, Halide::Runtime::Internal::MemoryProperties::usage, Halide::Runtime::Internal::MemoryProperties::visibility, VK_SHARING_MODE_EXCLUSIVE, VK_STRUCTURE_TYPE_BUFFER_CREATE_INFO, VK_SUCCESS, VK_SYSTEM_ALLOCATION_SCOPE_OBJECT, vkBindBufferMemory(), vkCreateBuffer(), and VulkanMemoryAllocator().

deallocate_region()

int Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::deallocate_region ( void * instance_ptr, MemoryRegion * region )

static

Definition at line 907 of file vulkan_memory.h.

References Halide::Runtime::Internal::MemoryProperties::caching, Halide::Runtime::Internal::MemoryRegion::dedicated, halide_error_code_internal_error, halide_error_code_success, halide_memory_caching_name(), halide_memory_usage_name(), halide_memory_visibility_name(), Halide::Runtime::Internal::MemoryRegion::handle, Halide::Runtime::Internal::MemoryRegion::offset, Halide::Runtime::Internal::MemoryRegion::properties, Halide::Runtime::Internal::MemoryRegion::size, Halide::Runtime::Internal::MemoryProperties::usage, Halide::Runtime::Internal::MemoryProperties::visibility, vkDestroyBuffer(), and VulkanMemoryAllocator().

bytes_allocated_for_blocks()

size_t Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::bytes_allocated_for_blocks

(

)

const

Definition at line 711 of file vulkan_memory.h.

blocks_allocated()

size_t Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::blocks_allocated

(

)

const

Definition at line 707 of file vulkan_memory.h.

bytes_allocated_for_regions()

size_t Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::bytes_allocated_for_regions

(

)

const

Definition at line 980 of file vulkan_memory.h.

regions_allocated()

size_t Halide::Runtime::Internal::Vulkan::VulkanMemoryAllocator::regions_allocated

(

)

const

Definition at line 976 of file vulkan_memory.h.

---

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

• /home/abuild/rpmbuild/BUILD/halide16-16.0.0-build/halide-16.0.0/src/runtime/vulkan_memory.h