ccl_platform_wrapper.c

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/>.
 * */

#include "ccl_platform_wrapper.h"
#include "_ccl_abstract_wrapper.h"
#include "_ccl_abstract_dev_container_wrapper.h"
#include "_ccl_defs.h"

struct ccl_platform {

    CCLDevContainer base;

};

static CCLWrapperInfo* ccl_platform_get_cldevices(
    CCLDevContainer* devcon, CCLErr** err) {

    /* Make sure err is NULL or it is not set. */
    g_return_val_if_fail(err == NULL || *err == NULL, NULL);

    /* Make sure devcon is not NULL. */
    g_return_val_if_fail(devcon != NULL, NULL);

    CCLWrapperInfo* info = NULL;

    cl_int ocl_status;

    /* Determine number of devices. */
    ocl_status = clGetDeviceIDs(devcon->base.cl_object,
        CL_DEVICE_TYPE_ALL, 0, NULL, &devcon->num_devices);
    ccl_if_err_create_goto(*err, CCL_OCL_ERROR,
        CL_SUCCESS != ocl_status, ocl_status, error_handler,
        "%s: get number of devices (OpenCL error %d: %s).",
        CCL_STRD, ocl_status, ccl_err(ocl_status));

    /* Create info object with size in bytes of array of device IDs. */
    info = ccl_wrapper_info_new(
        sizeof(cl_device_id) * devcon->num_devices);

    /* Get existing device IDs. */
    ocl_status = clGetDeviceIDs(devcon->base.cl_object,
        CL_DEVICE_TYPE_ALL, devcon->num_devices, info->value, NULL);
    ccl_if_err_create_goto(*err, CCL_OCL_ERROR,
        CL_SUCCESS != ocl_status, ocl_status, error_handler,
        "%s: get device IDs (OpenCL error %d: %s).",
        CCL_STRD, ocl_status, ccl_err(ocl_status));

    /* Add device list to info table, so that it will be
     * automatically released. Because the cl_platform_id object
     * doesn't have a CL_PLATFORM_DEVICES parameter, we keep this info
     * referenced has CL_CONTEXT_DEVICES. */
    ccl_wrapper_add_info(
        (CCLWrapper*) devcon, CL_CONTEXT_DEVICES, info);

    /* If we got here, everything is OK. */
    g_assert(err == NULL || *err == NULL);
    goto finish;

error_handler:
    /* If we got here there was an error, verify that it is so. */
    g_assert(err == NULL || *err != NULL);

    /* Free info if it was created. */
    if (info != NULL) ccl_wrapper_info_destroy(info);

finish:

    /* Terminate function. */
    return info;
}

CCL_EXPORT
CCLPlatform* ccl_platform_new_wrap(cl_platform_id platform) {

    return (CCLPlatform*) ccl_wrapper_new(
        CCL_PLATFORM, (void*) platform, sizeof(CCLPlatform));

}

CCL_EXPORT
CCLPlatform* ccl_platform_new_from_device(CCLDevice* dev, CCLErr** err) {

    /* Make sure dev is not NULL. */
    g_return_val_if_fail(dev != NULL, NULL);
    /* Make sure err is NULL or it is not set. */
    g_return_val_if_fail(err == NULL || *err == NULL, NULL);

    /* The OpenCL platform_id object. */
    cl_platform_id platform_id;
    /* The platform wrapper to return. */
    CCLPlatform* platf = NULL;
    /* Internal error object. */
    CCLErr* err_internal = NULL;

    /* Get OpenCL platform_id object from device. */
    platform_id = ccl_device_get_info_scalar(
        dev, CL_DEVICE_PLATFORM, cl_platform_id, &err_internal);
    ccl_if_err_propagate_goto(err, err_internal, error_handler);

    /* Create/get the platform wrapper. */
    platf = ccl_platform_new_wrap(platform_id);

    /* If we got here, everything is OK. */
    g_assert(err == NULL || *err == NULL);
    goto finish;

error_handler:
    /* If we got here there was an error, verify that it is so. */
    g_assert(err == NULL || *err != NULL);

finish:

    /* Return the device platform wrapper. */
    return platf;

}

CCL_EXPORT
void ccl_platform_destroy(CCLPlatform* platf) {

    ccl_wrapper_unref((CCLWrapper*) platf, sizeof(CCLPlatform),
        (ccl_wrapper_release_fields) ccl_dev_container_release_devices,
        NULL, NULL);

}

CCL_EXPORT
cl_uint ccl_platform_get_opencl_version(
    CCLPlatform* platf, CCLErr** err) {

    /* Make sure platf is not NULL. */
    g_return_val_if_fail(platf != NULL, 0);
    /* Make sure err is NULL or it is not set. */
    g_return_val_if_fail(err == NULL || *err == NULL, 0);

    char* ver_str;
    cl_uint ver = 0;

    /* Get version string which has the format "OpenCL x.x ..." */
    ver_str = ccl_platform_get_info_string(
        platf, CL_PLATFORM_VERSION, err);

    if (ver_str != NULL) {
        ver = /* strlen("OpenCL ") == 7 */
            atoi(ver_str + 7) * 100 + /* Major version. */
            atoi(ver_str + 9) * 10; /* Minor version. */
    }
    return ver;
}

CCLDevice* const* ccl_platform_get_all_devices(
    CCLPlatform* platf, CCLErr** err) {

    return ccl_dev_container_get_all_devices(
        (CCLDevContainer*) platf, ccl_platform_get_cldevices, err);
}

CCL_EXPORT
CCLDevice* ccl_platform_get_device(
    CCLPlatform* platf, cl_uint index, CCLErr** err) {

    return ccl_dev_container_get_device((CCLDevContainer*) platf,
        ccl_platform_get_cldevices, index, err);

}

CCL_EXPORT
cl_uint ccl_platform_get_num_devices(CCLPlatform* platf, CCLErr** err) {

    return ccl_dev_container_get_num_devices((CCLDevContainer*) platf,
        ccl_platform_get_cldevices, err);

}