Base class for all the memory objects. More...

#include <memobject.h>

Inheritance diagram for Coal::MemObject:

Collaboration diagram for Coal::MemObject:

Public Types
enum	Type { Buffer, SubBuffer, Image2D, Image3D }
	Type of memory object. More...
Public Member Functions
	MemObject (Context ctx, cl_mem_flags flags, void host_ptr, cl_int *errcode_ret)
	Constructor.
	~MemObject ()
virtual cl_int	init ()
	Initialize the memory object.
virtual bool	allocate (DeviceInterface *device)
	Allocate this memory object on the given `device`.
virtual size_t	size () const =0
	Device-independent size of the memory object.
virtual Type	type () const =0
	Type of the memory object.
cl_mem_flags	flags () const
	Flags.
void *	host_ptr () const
	Host pointer.
DeviceBuffer *	deviceBuffer (DeviceInterface *device) const
	`Coal::DeviceBuffer` for the given `device`
void	deviceAllocated (DeviceBuffer *buffer)
	Is the `Coal::DeviceBuffer` for `buffer` allocated ?
void	setDestructorCallback (void(CL_CALLBACK pfn_notify)(cl_mem memobj, void user_data), void *user_data)
	Set a destructor callback for this memory object.
cl_int	info (cl_mem_info param_name, size_t param_value_size, void param_value, size_t param_value_size_ret) const
	Get information about this memory object.
Private Member Functions
	void (CL_CALLBACK *p_dtor_callback)(cl_mem memobj
Private Attributes
unsigned int	p_num_devices
unsigned int	p_devices_to_allocate
cl_mem_flags	p_flags
void *	p_host_ptr
DeviceBuffer **	p_devicebuffers
void *	user_data
void *	p_dtor_userdata

Detailed Description

Base class for all the memory objects.

Definition at line 50 of file memobject.h.

Member Enumeration Documentation

enum Coal::MemObject::Type

Type of memory object.

Enumerator:

Buffer
SubBuffer
Image2D
Image3D

Reimplemented from Coal::Object.

Definition at line 56 of file memobject.h.

Constructor & Destructor Documentation

MemObject::MemObject	(	Context *	ctx,
		cl_mem_flags	flags,
		void *	host_ptr,
		cl_int *	errcode_ret
	)

Constructor.

Parameters:

ctx	parent `Coal::Context`
flags	memory object flags
host_ptr	host pointer used by some flags (see the OpenCL spec)
errcode_ret	return value

Note:: Don't do any initialization here, but in init(). We only fill the private variables and check the values passed in argument.

See also:: init

Definition at line 48 of file memobject.cpp.

MemObject::~MemObject ( )

Definition at line 90 of file memobject.cpp.

References p_devicebuffers, p_dtor_userdata, and p_num_devices.

Member Function Documentation

bool MemObject::allocate ( DeviceInterface * device ) [virtual]

Allocate this memory object on the given device.

Reimplemented in Coal::SubBuffer.

Definition at line 202 of file memobject.cpp.

References Coal::DeviceBuffer::allocate(), Coal::DeviceBuffer::allocated(), and deviceBuffer().

Referenced by Coal::SubBuffer::allocate(), Coal::BufferEvent::BufferEvent(), Coal::CPUKernelWorkGroup::callArgs(), Coal::CopyBufferEvent::CopyBufferEvent(), Coal::CopyBufferRectEvent::CopyBufferRectEvent(), and init().

void MemObject::deviceAllocated ( DeviceBuffer * buffer )

Is the Coal::DeviceBuffer for buffer allocated ?

Definition at line 247 of file memobject.cpp.

References p_devices_to_allocate, p_flags, p_host_ptr, p_num_devices, and void().

Referenced by Coal::CPUBuffer::allocate().

DeviceBuffer * MemObject::deviceBuffer ( DeviceInterface * device ) const

Coal::DeviceBuffer for the given device

Definition at line 236 of file memobject.cpp.

References p_devicebuffers, and p_num_devices.

Referenced by allocate(), Coal::CPUKernelWorkGroup::callArgs(), Coal::CPUBuffer::CPUBuffer(), Coal::CPUKernelWorkGroup::getImageData(), Coal::CPUDevice::initEventDeviceData(), Coal::NativeKernelEvent::NativeKernelEvent(), and worker().

cl_mem_flags MemObject::flags ( ) const

Flags.

Definition at line 214 of file memobject.cpp.

References p_flags.

Referenced by Coal::CPUBuffer::allocate(), Coal::CPUBuffer::CPUBuffer(), and Coal::SubBuffer::SubBuffer().

void * MemObject::host_ptr ( ) const

Host pointer.

Definition at line 219 of file memobject.cpp.

References host_ptr(), Coal::SubBuffer::offset(), p_host_ptr, Coal::SubBuffer::parent(), and type().

Referenced by Coal::CPUBuffer::allocate(), Coal::CPUBuffer::CPUBuffer(), host_ptr(), and info().

cl_int MemObject::info	(	cl_mem_info	param_name,
		size_t	param_value_size,
		void *	param_value,
		size_t *	param_value_size_ret
	)		const

Get information about this memory object.

This function is used to retrieve information about an object. Sometimes, the size of the data retrieved is unknown (for example, a string). The application can call this function twice, the first time to get the size, then it allocates a buffer, and finally get the data.

 const char *string = 0;
 size_t len;

 object->info(FOO_PROPERTY_STRING, 0, 0, &len);
 string = std::malloc(len);
 object->info(FOO_PROPERTY_STRING, len, string, 0);

Parameters:

param_name	Name of the property to retrieve
param_value_size	Size of the application-allocated buffer in which to put the value.
param_value	Pointer to an application-allocated buffer where the property data will be stored. Ignored if NULL.
param_value_size_ret	Size of the value retrieved, ignored if NULL.

Returns:: CL_SUCCESS in case of success, otherwise a CL error code.

Definition at line 277 of file memobject.cpp.

References host_ptr(), Coal::SubBuffer::offset(), p_flags, Coal::SubBuffer::parent(), Coal::Object::parent(), Coal::Object::references(), SIMPLE_ASSIGN, size(), SubBuffer, and type().

Referenced by init().

cl_int MemObject::init ( ) [virtual]

Initialize the memory object.

Memory objects are device-independent classes. This function creates one Coal::DeviceBuffer per device present in the context by calling Coal::DeviceInterface::createDeviceBuffer().

If there is only one device, its Coal::DeviceBuffer is directly allocated. If there are more than one device, the allocation is deferred until a Coal::Event is pushed for this device.

Returns:: CL_SUCCESS if success, an error code otherwise

Definition at line 105 of file memobject.cpp.

References allocate(), Coal::DeviceInterface::createDeviceBuffer(), info(), p_devicebuffers, p_devices_to_allocate, p_flags, p_host_ptr, p_num_devices, Coal::Object::parent(), and size().

Referenced by clCreateBuffer(), clCreateImage2D(), clCreateImage3D(), and clCreateSubBuffer().

void MemObject::setDestructorCallback	(	void(CL_CALLBACK pfn_notify)(cl_mem memobj,void user_data)	,
		void *	user_data
	)

Set a destructor callback for this memory object.

This callback is called when this memory object is deleted. It is currently called from the destructor, so the memory object is already invalid, but as OpenCL objects are immutable, the callback cannot use its memobj parameter except in a pointer comparison, and there is no problem.

Parameters: