ccl_context_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_CONTEXT_WRAPPER_H_
#define _CCL_CONTEXT_WRAPPER_H_

#include "ccl_oclversions.h"
#include "ccl_device_selector.h"
#include "ccl_common.h"
#include "ccl_errors.h"
#include "ccl_device_wrapper.h"
#include "ccl_platform_wrapper.h"

typedef void (CL_CALLBACK* ccl_context_callback)(
    const char* errinfo, const void* private_info, size_t cb,
    void* user_data);

/* Get the context wrapper for the given OpenCL context. */
CCL_EXPORT
CCLContext* ccl_context_new_wrap(cl_context context);

#define ccl_context_new_from_filters(filters, err) \
    ccl_context_new_from_filters_full( \
        NULL, (filters), NULL, NULL, (err))

#define ccl_context_new_from_devices(num_devices, devices, err) \
    ccl_context_new_from_devices_full( \
        NULL, (num_devices), (devices), NULL, NULL, (err))

#define ccl_context_new_cpu(err) \
    ccl_context_new_from_indep_filter( \
        ccl_devsel_indep_type_cpu, NULL, (err))

#define ccl_context_new_gpu(err) \
    ccl_context_new_from_indep_filter( \
        ccl_devsel_indep_type_gpu, NULL, (err))

#define ccl_context_new_accel(err) \
    ccl_context_new_from_indep_filter( \
        ccl_devsel_indep_type_accel, NULL, (err))

#define ccl_context_new_any(err) \
    ccl_context_new_from_indep_filter(NULL, NULL, (err))

#define ccl_context_new_from_indep_filter(filter, data, err) \
    ccl_context_new_from_filter(CCL_DEVSEL_INDEP, (filter), (data), (err))

#define ccl_context_new_from_dep_filter(filter, data, err) \
    ccl_context_new_from_filter(CCL_DEVSEL_DEP, (filter), (data), (err))

#define ccl_context_new_from_device_index(data, err) \
    ccl_context_new_from_dep_filter(ccl_devsel_dep_index, (data), (err))

#define ccl_context_new_from_menu_full(data, err) \
    ccl_context_new_from_dep_filter(ccl_devsel_dep_menu, (data), (err))

#define ccl_context_new_from_menu(err) \
    ccl_context_new_from_dep_filter(ccl_devsel_dep_menu, NULL, (err))

/* Create a new context wrapper object selecting devices using the given set of
 * filters. */
CCL_EXPORT
CCLContext* ccl_context_new_from_filters_full(
    const cl_context_properties* properties, CCLDevSelFilters* filters,
    ccl_context_callback pfn_notify, void* user_data, CCLErr **err);

/* Creates a context wrapper given an array of ::CCLDevice wrappers and the
 * remaining parameters required by the clCreateContext() function. */
CCL_EXPORT
CCLContext* ccl_context_new_from_devices_full(
    const cl_context_properties* properties, cl_uint num_devices,
    CCLDevice* const* devices, ccl_context_callback pfn_notify,
    void* user_data, CCLErr** err);

/* Creates a context wrapper using one device filter specified in the function
 * parameters. */
CCL_EXPORT
CCLContext* ccl_context_new_from_filter(CCLDevSelFilterType ftype,
    void* filter, void* data, CCLErr** err);

/* Decrements the reference count of the context wrapper object.
 * If it reaches 0, the context wrapper object is destroyed. */
CCL_EXPORT
void ccl_context_destroy(CCLContext* ctx);

/* Get the OpenCL version of the platform associated with this context. */
CCL_EXPORT
cl_uint ccl_context_get_opencl_version(CCLContext* ctx, CCLErr** err);

/* Get the platform associated with the context devices. */
CCL_EXPORT
CCLPlatform* ccl_context_get_platform(CCLContext* ctx, CCLErr** err);

/* Get the list of image formats supported by a given context. */
CCL_EXPORT
const cl_image_format* ccl_context_get_supported_image_formats(
    CCLContext* ctx, cl_mem_flags flags, cl_mem_object_type image_type,
    cl_uint* num_image_formats, CCLErr** err);

/* Get ::CCLDevice wrapper at given index. */
CCL_EXPORT
CCLDevice* ccl_context_get_device(
    CCLContext* ctx, cl_uint index, CCLErr** err);

/* Return number of devices in context. */
CCL_EXPORT
cl_uint ccl_context_get_num_devices(CCLContext* ctx, CCLErr** err);

/* Get all device wrappers in context. */
CCL_EXPORT
CCLDevice* const* ccl_context_get_all_devices(CCLContext* ctx,
    CCLErr** err);

#define ccl_context_get_info(ctx, param_name, err) \
    ccl_wrapper_get_info((CCLWrapper*) ctx, NULL, param_name, 0, \
        CCL_INFO_CONTEXT, CL_FALSE, err)

#define ccl_context_get_info_scalar(ctx, param_name, param_type, err) \
    *((param_type*) ccl_wrapper_get_info_value((CCLWrapper*) ctx, \
        NULL, param_name, sizeof(param_type), \
        CCL_INFO_CONTEXT, CL_FALSE, err))

#define ccl_context_get_info_array(ctx, param_name, param_type, err) \
    (param_type) ccl_wrapper_get_info_value((CCLWrapper*) ctx, \
        NULL, param_name, sizeof(param_type), \
        CCL_INFO_CONTEXT, CL_FALSE, err)

#define ccl_context_ref(ctx) \
    ccl_wrapper_ref((CCLWrapper*) ctx)

#define ccl_context_unref(ctx) \
    ccl_context_destroy(ctx)

#define ccl_context_unwrap(ctx) \
    ((cl_context) ccl_wrapper_unwrap((CCLWrapper*) ctx))

#endif