ccl_platforms.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_platforms.h"
#include "_ccl_defs.h"

struct ccl_platforms {

    CCLPlatform** platfs;

    cl_uint num_platfs;
};

CCL_EXPORT
CCLPlatforms* ccl_platforms_new(CCLErr **err) {

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

    /* Return status of OpenCL functions. */
    cl_int ocl_status;

    /* Object which represents the list of OpenCL platforms available
     * in the system. */
    CCLPlatforms* platforms = NULL;

    /* Size in bytes of array of platform IDs. */
    gsize platf_ids_size;

    /* Array of platform IDs. */
    cl_platform_id* platf_ids = NULL;

    /* Allocate memory for the CCLPlatforms object. */
    platforms = g_slice_new0(CCLPlatforms);

    /* Get number of platforms */
    ocl_status = clGetPlatformIDs(0, NULL, &platforms->num_platfs);
    ccl_if_err_create_goto(*err, CCL_ERROR,
        platforms->num_platfs == 0, CCL_ERROR_DEVICE_NOT_FOUND,
        error_handler, "%s: no OpenCL platforms found.", CCL_STRD);
    ccl_if_err_create_goto(*err, CCL_OCL_ERROR,
        CL_SUCCESS != ocl_status, ocl_status, error_handler,
        "%s: get number of platforms (OpenCL error %d: %s).",
        CCL_STRD, ocl_status, ccl_err(ocl_status));

    /* Determine size in bytes of array of platform IDs. */
    platf_ids_size = sizeof(cl_platform_id) * platforms->num_platfs;

    /* Allocate memory for array of platform IDs. */
    platf_ids = (cl_platform_id*) g_slice_alloc(platf_ids_size);

    /* Get existing platform IDs. */
    ocl_status = clGetPlatformIDs(
        platforms->num_platfs, platf_ids, NULL);
    ccl_if_err_create_goto(*err, CCL_OCL_ERROR,
        CL_SUCCESS != ocl_status, ocl_status, error_handler,
        "%s: get platforms IDs (OpenCL error %d: %s).",
        CCL_STRD, ocl_status, ccl_err(ocl_status));

    /* Allocate memory for array of platform wrapper objects. */
    platforms->platfs =
        g_slice_alloc(sizeof(CCLPlatform*) * platforms->num_platfs);

    /* Wrap platform IDs in platform wrapper objects. */
    for (guint i = 0; i < platforms->num_platfs; i++) {
        /* Add platform wrapper object to array of wrapper objects. */
        platforms->platfs[i] = ccl_platform_new_wrap(platf_ids[i]);
    }

    /* Free array of platform ids. */
    g_slice_free1(platf_ids_size, platf_ids);

    /* 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);

    /* Destroy the CCLPlatforms object, or what was possible to build
     * of it. */
    if (platforms) {
        ccl_platforms_destroy(platforms);
    }

    /* Set platforms to NULL, indicating an error occurred.*/
    platforms = NULL;

finish:

    /* Return the CCLPlatforms object. */
    return platforms;

}

CCL_EXPORT
void ccl_platforms_destroy(CCLPlatforms* platforms) {

    /* Platforms object can't be NULL. */
    g_return_if_fail(platforms != NULL);

    /* Destroy underlying platforms. */
    for (guint i = 0; i < platforms->num_platfs; i++) {
        ccl_platform_unref(platforms->platfs[i]);
    }

    /* Free underlying platforms array. */
    g_slice_free1(
        sizeof(CCLPlatform*) * platforms->num_platfs, platforms->platfs);

    /* Free CCLPlatforms object. */
    g_slice_free(CCLPlatforms, platforms);
}


CCL_EXPORT
cl_uint ccl_platforms_count(CCLPlatforms* platforms) {

    /* Platforms object can't be NULL. */
    g_return_val_if_fail(platforms != NULL, 0);

    /* Return number of OpenCL platforms. */
    return platforms->num_platfs;
}

CCL_EXPORT
CCLPlatform* ccl_platforms_get(
    CCLPlatforms* platforms, cl_uint index) {

    /* Platforms object can't be NULL. */
    g_return_val_if_fail(platforms != NULL, NULL);

    /* Index of platform to return must be smaller than the number of
     * available platforms. */
    g_return_val_if_fail(index < platforms->num_platfs, NULL);

    /* Return platform at given index. */
    return platforms->platfs[index];
}