ccl_device_selector.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_SELECTOR_H_
#define _CCL_DEVICE_SELECTOR_H_

#include <glib.h>
#include "ccl_oclversions.h"
#include "ccl_device_wrapper.h"
#include "ccl_platforms.h"

typedef enum ccl_devsel_filter_type {

    CCL_DEVSEL_INDEP,
    CCL_DEVSEL_DEP

} CCLDevSelFilterType;

typedef GPtrArray* CCLDevSelDevices;

typedef cl_bool (*ccl_devsel_indep)(
    CCLDevice* device, void *data, CCLErr **err);

typedef CCLDevSelDevices (*ccl_devsel_dep)(
    CCLDevSelDevices devices, void *data, CCLErr **err);

typedef GPtrArray* CCLDevSelFilters;

/* Create and return an object with device wrappers for all OpenCL devices
 * present in the system. */
CCL_EXPORT
CCLDevSelDevices ccl_devsel_devices_new(CCLErr **err);

/* Destroy an object containing device wrappers. */
CCL_EXPORT
void ccl_devsel_devices_destroy(CCLDevSelDevices devices);

/* Returns a NULL-terminated array of strings, each one containing the name and
 * vendor of each device in the system. */
CCL_EXPORT
gchar** ccl_devsel_get_device_strings(CCLErr** err);

/* Print to stdout a device description string for each device in the system. */
CCL_EXPORT
void ccl_devsel_print_device_strings(CCLErr** err);

/* Add a independent device filter to the filter set. */
CCL_EXPORT
void ccl_devsel_add_indep_filter(
    CCLDevSelFilters* filters, ccl_devsel_indep filter, void* data);

/* Add a dependent device filter to the filter set. */
CCL_EXPORT
void ccl_devsel_add_dep_filter(
    CCLDevSelFilters* filters, ccl_devsel_dep filter, void* data);

/* Select one or more OpenCL devices based on the provided filters.  */
CCL_EXPORT
CCLDevSelDevices ccl_devsel_select(
    CCLDevSelFilters* filters, CCLErr **err);

/* Independent filter function which accepts devices of the type
 * given in the data parameter. */
CCL_EXPORT
cl_bool ccl_devsel_indep_type(
    CCLDevice* dev, void* data, CCLErr **err);

/* Independent filter function which only accepts GPU devices. */
CCL_EXPORT
cl_bool ccl_devsel_indep_type_gpu(
    CCLDevice* dev, void *data, CCLErr **err);

/* Independent filter function which only accepts CPU devices. */
CCL_EXPORT
cl_bool ccl_devsel_indep_type_cpu(
    CCLDevice* dev, void *data, CCLErr **err);

/* Independent filter function which only accepts accelerator
 * devices. */
CCL_EXPORT
cl_bool ccl_devsel_indep_type_accel(
    CCLDevice* dev, void *data, CCLErr **err);

/* Independent filter which selects devices based on device
 * name, device vendor and/or platform name. */
CCL_EXPORT
cl_bool ccl_devsel_indep_string(
    CCLDevice* dev, void *data, CCLErr **err);

/* Independent filter function which only accepts devices of a
 * specified platform. */
CCL_EXPORT
cl_bool ccl_devsel_indep_platform(
    CCLDevice* device, void *data, CCLErr **err);

/* Dependent filter function which only accepts devices of the
 * same platform (the platform to which the first device belong to). */
CCL_EXPORT
CCLDevSelDevices ccl_devsel_dep_platform(
    CCLDevSelDevices devices, void *data, CCLErr **err);

/* Dependent filter function which presents a menu to the user
 * allowing him to select the desired device. */
CCL_EXPORT
CCLDevSelDevices ccl_devsel_dep_menu(
    CCLDevSelDevices devices, void *data, CCLErr **err);

/* Dependent filter function which selects the device at the specified
 * index, failing if no device is found at that index. */
CCL_EXPORT
CCLDevSelDevices ccl_devsel_dep_index(
    CCLDevSelDevices devices, void *data, CCLErr **err);

#endif