ccl_memobj_wrapper.h

Go to the documentation of this file.

/*
 * This file is part of cf4ocl (C Framework for OpenCL).
 *
 * cf4ocl is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * cf4ocl is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with cf4ocl. If not, see
 * <http://www.gnu.org/licenses/>.
 * */

#ifndef _CCL_MEMOBJ_WRAPPER_H_
#define _CCL_MEMOBJ_WRAPPER_H_

#include "ccl_oclversions.h"
#include "ccl_abstract_wrapper.h"
#include "ccl_event_wrapper.h"
#include "ccl_queue_wrapper.h"

typedef void (CL_CALLBACK *ccl_memobj_destructor_callback)(
    cl_mem memobj, void *user_data);

/* Get the OpenCL version of the platform associated with this memory
 * object. */
CCL_EXPORT
cl_uint ccl_memobj_get_opencl_version(CCLMemObj* mo, CCLErr** err);

/* Enqueues a command to unmap a previously mapped region of a memory
 * object. */
CCL_EXPORT
CCLEvent* ccl_memobj_enqueue_unmap(CCLMemObj* mo, CCLQueue* cq,
    void* mapped_ptr, CCLEventWaitList* evt_wait_lst, CCLErr** err);

/* Wrapper for OpenCL clSetMemObjectDestructorCallback() function. */
CCL_EXPORT
cl_bool ccl_memobj_set_destructor_callback(CCLMemObj* mo,
    ccl_memobj_destructor_callback pfn_notify,
    void *user_data, CCLErr** err);

/* Enqueues a command to indicate which device a set of memory objects
 * should be associated with. */
CCL_EXPORT
CCLEvent* ccl_memobj_enqueue_migrate(CCLMemObj** mos, cl_uint num_mos,
    CCLQueue* cq, cl_mem_migration_flags flags,
    CCLEventWaitList* evt_wait_lst, CCLErr** err);

#define ccl_memobj_get_info(mo, param_name, err) \
    ccl_wrapper_get_info((CCLWrapper*) mo, NULL, param_name, 0, \
        CCL_INFO_MEMOBJ, CL_FALSE, err)

#define ccl_memobj_get_info_scalar(mo, param_name, param_type, err) \
    *((param_type*) ccl_wrapper_get_info_value((CCLWrapper*) mo, \
        NULL, param_name, sizeof(param_type), CCL_INFO_MEMOBJ, CL_FALSE, err))

#define ccl_memobj_get_info_array(mo, param_name, param_type, err) \
    (param_type) ccl_wrapper_get_info_value((CCLWrapper*) mo, \
        NULL, param_name, sizeof(param_type), CCL_INFO_MEMOBJ, CL_FALSE, err)

#define ccl_memobj_ref(mo) \
    ccl_wrapper_ref((CCLWrapper*) mo)

#define ccl_memobj_unwrap(mo) \
    ((cl_mem) ccl_wrapper_unwrap((CCLWrapper*) mo))

#endif