CLBufferMemoryRegion Class Reference

OpenCL buffer memory region implementation. More...

#include <CLMemoryRegion.h>

Collaboration diagram for CLBufferMemoryRegion:

Public Member Functions
	CLBufferMemoryRegion (cl_mem_flags flags, size_t size)
	Constructor. More...
	CLBufferMemoryRegion (const cl::Buffer &buffer)
	Constructor. More...
virtual	~CLBufferMemoryRegion () override
void *	ptr () final
	Host/SVM pointer accessor. More...
void *	map (cl::CommandQueue &q, bool blocking) final
	Enqueue a map operation of the allocated buffer on the given queue. More...
void	unmap (cl::CommandQueue &q) final
	Enqueue an unmap operation of the allocated buffer on the given queue. More...
Public Member Functions inherited from ICLMemoryRegion
	ICLMemoryRegion (size_t size)
	Constructor. More...
virtual	~ICLMemoryRegion ()=default
	Default Destructor. More...
	ICLMemoryRegion (const ICLMemoryRegion &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...
	ICLMemoryRegion (ICLMemoryRegion &&)=default
	Default move constructor. More...
ICLMemoryRegion &	operator= (const ICLMemoryRegion &)=delete
	Prevent instances of this class from being copied (As this class contains pointers) More...
ICLMemoryRegion &	operator= (ICLMemoryRegion &&)=default
	Default move assignment operator. More...
const cl::Buffer &	cl_data () const
	Returns the underlying CL buffer. More...
void *	buffer () override
	Returns the pointer to the allocated data. More...
const void *	buffer () const override
	Returns the pointer to the allocated data. More...
std::unique_ptr< IMemoryRegion >	extract_subregion (size_t offset, size_t size) override
	Extract a sub-region from the memory. More...
Public Member Functions inherited from IMemoryRegion
	IMemoryRegion (size_t size)
	Default constructor. More...
virtual	~IMemoryRegion ()=default
	Virtual Destructor. More...
size_t	size () const
	Memory region size accessor. More...
void	set_size (size_t size)
	Sets size of region. More...

Detailed Description

OpenCL buffer memory region implementation.

Definition at line 94 of file CLMemoryRegion.h.

Constructor & Destructor Documentation

CLBufferMemoryRegion() [1/2]

CLBufferMemoryRegion	(	cl_mem_flags	flags,
		size_t	size
	)

Constructor.

Parameters

[in]	flags	Memory flags
[in]	size	Region size

Definition at line 60 of file CLMemoryRegion.cpp.

    : ICLMemoryRegion(size)
{
    if(_size != 0)
    {
        _mem = cl::Buffer(CLScheduler::get().context(), flags, _size);
    }
}

References arm_compute::test::validation::context, and CLScheduler::get().

CLBufferMemoryRegion() [2/2]

CLBufferMemoryRegion

(

const cl::Buffer &

buffer

)

Constructor.

Parameters

[in]

buffer

Buffer to be used as a memory region

Definition at line 69 of file CLMemoryRegion.cpp.

    : ICLMemoryRegion(buffer.getInfo<CL_MEM_SIZE>())
{
    _mem = buffer;
}

References ICLMemoryRegion::buffer().

~CLBufferMemoryRegion()

~CLBufferMemoryRegion ( )

overridevirtual

Definition at line 75 of file CLMemoryRegion.cpp.

{
    // Flush the command queue to ensure all commands that may use this memory buffer are scheduled to be finished before
    // this buffer is freed
    // Do not call finish as it is a blocking call which affects the performance
    CLScheduler::get().queue().flush();
}

References CLScheduler::get(), and CLScheduler::queue().

Member Function Documentation

map()

void * map ( cl::CommandQueue &  q, bool  blocking  )

finalvirtual

Enqueue a map operation of the allocated buffer on the given queue.

Parameters

[in,out]	q	The CL command queue to use for the mapping operation.
[in]	blocking	If true, then the mapping will be ready to use by the time this method returns, else it is the caller's responsibility to flush the queue and wait for the mapping operation to have completed before using the returned mapping pointer.

Returns

The mapping address.

Implements ICLMemoryRegion.

Definition at line 88 of file CLMemoryRegion.cpp.

{
    ARM_COMPUTE_ERROR_ON(_mem.get() == nullptr);
    _mapping = q.enqueueMapBuffer(_mem, blocking ? CL_TRUE : CL_FALSE, CL_MAP_READ | CL_MAP_WRITE, 0, _size);
    return _mapping;
}

References ARM_COMPUTE_ERROR_ON.

ptr()

void * ptr ( )

finalvirtual

Host/SVM pointer accessor.

Returns

Host/SVM pointer base

Implements ICLMemoryRegion.

Definition at line 83 of file CLMemoryRegion.cpp.

{
    return nullptr;
}

unmap()

void unmap ( cl::CommandQueue &  q )

finalvirtual

Enqueue an unmap operation of the allocated buffer on the given queue.

Note

This method simply enqueue the unmap operation, it is the caller's responsibility to flush the queue and make sure the unmap is finished before the memory is accessed by the device.

Parameters

[in,out]

q

The CL command queue to use for the mapping operation.

Implements ICLMemoryRegion.

Definition at line 95 of file CLMemoryRegion.cpp.

{
    ARM_COMPUTE_ERROR_ON(_mem.get() == nullptr);
    q.enqueueUnmapMemObject(_mem, _mapping);
    _mapping = nullptr;
}

References ARM_COMPUTE_ERROR_ON.

---

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

• arm_compute/runtime/CL/CLMemoryRegion.h
• src/runtime/CL/CLMemoryRegion.cpp