ccl_platform_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_PLATFORM_WRAPPER_H_
#define _CCL_PLATFORM_WRAPPER_H_

#include "ccl_common.h"
#include "ccl_device_wrapper.h"
#include "ccl_errors.h"

/* Get the platform wrapper for the given OpenCL platform. */
CCL_EXPORT
CCLPlatform* ccl_platform_new_wrap(cl_platform_id platform);

/* Get the platform wrapper for the given device wrapper. */
CCL_EXPORT
CCLPlatform* ccl_platform_new_from_device(CCLDevice* dev, CCLErr** err);

/* Decrements the reference count of the platform wrapper
 * object. If it reaches 0, the platform wrapper object is destroyed. */
CCL_EXPORT
void ccl_platform_destroy(CCLPlatform* platf);

/* Get integer OpenCL version of platform. */
CCL_EXPORT
cl_uint ccl_platform_get_opencl_version(
    CCLPlatform* platf, CCLErr** err);

#define ccl_platform_get_info(platf, param_name, err) \
    ccl_wrapper_get_info((CCLWrapper*) platf, NULL, param_name, 0, \
        CCL_INFO_PLATFORM, CL_FALSE, err)

#define ccl_platform_get_info_scalar(platf, param_name, param_type, err) \
    *((param_type*) ccl_wrapper_get_info_value((CCLWrapper*) platf, \
        NULL, param_name, sizeof(param_type), \
        CCL_INFO_PLATFORM, CL_FALSE, err))

#define ccl_platform_get_info_array(platf, param_name, param_type, err) \
    (param_type) ccl_wrapper_get_info_value((CCLWrapper*) platf, \
        NULL, param_name, sizeof(param_type), \
        CCL_INFO_PLATFORM, CL_FALSE, err)

#define ccl_platform_get_info_string(platf, param_name, err) \
    ccl_platform_get_info_array(platf, param_name, char*, err)

#define ccl_platform_ref(platform) \
    ccl_wrapper_ref((CCLWrapper*) platform)

#define ccl_platform_unref(platform) ccl_platform_destroy(platform)

#define ccl_platform_unwrap(platform) \
    ((cl_platform_id) ccl_wrapper_unwrap((CCLWrapper*) platform))

/* Get all device wrappers in platform. */
CCL_EXPORT
CCLDevice* const* ccl_platform_get_all_devices(
    CCLPlatform* platf, CCLErr** err);

/* Get ::CCLDevice wrapper at given index. */
CCL_EXPORT
CCLDevice* ccl_platform_get_device(
    CCLPlatform* platf, cl_uint index, CCLErr** err);

/* Return number of devices in platform. */
CCL_EXPORT
cl_uint ccl_platform_get_num_devices(CCLPlatform* platf, CCLErr** err);

#endif