ccl_device_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_DEVICE_WRAPPER_H_
#define _CCL_DEVICE_WRAPPER_H_

#include "ccl_common.h"
#include "ccl_abstract_wrapper.h"
#include "ccl_errors.h"
#include "ccl_oclversions.h"
#include <string.h>

/* Decrements the reference count of the device wrapper object.
 * If it reaches 0, the device wrapper object is destroyed. */
CCL_EXPORT
void ccl_device_destroy(CCLDevice* dev);

/* Get the device wrapper for the given OpenCL device. */
CCL_EXPORT
CCLDevice* ccl_device_new_wrap(cl_device_id device);

/* Get the OpenCL version supported by the device. */
CCL_EXPORT
cl_uint ccl_device_get_opencl_version(CCLDevice* dev, CCLErr** err);

/* Get the OpenCL version of the device. */
CCL_EXPORT
cl_uint ccl_device_get_opencl_c_version(CCLDevice* dev, CCLErr** err);

/* Creates an array of sub-devices that each reference a
 * non-intersecting set of compute units within the given device. */
CCL_EXPORT
CCLDevice* const* ccl_device_create_subdevices(CCLDevice* dev,
    const cl_device_partition_property *properties,
    cl_uint *num_devs_ret, CCLErr** err);

#define ccl_device_get_info(dev, param_name, err) \
    ccl_wrapper_get_info((CCLWrapper*) dev, NULL, param_name, 0, \
        CCL_INFO_DEVICE, CL_FALSE, err)

#define ccl_device_get_info_scalar(dev, param_name, param_type, err) \
    *((param_type*) ccl_wrapper_get_info_value((CCLWrapper*) dev, \
        NULL, param_name, sizeof(param_type), \
        CCL_INFO_DEVICE, CL_FALSE, err))

#define ccl_device_get_info_array(dev, param_name, param_type, err) \
    (param_type) ccl_wrapper_get_info_value((CCLWrapper*) dev, \
        NULL, param_name, sizeof(param_type), \
        CCL_INFO_DEVICE, CL_FALSE, err)

#define ccl_device_ref(dev) \
    ccl_wrapper_ref((CCLWrapper*) dev)

#define ccl_device_unref(dev) ccl_device_destroy(dev)

#define ccl_device_unwrap(dev) \
    ((cl_device_id) ccl_wrapper_unwrap((CCLWrapper*) dev))

#endif