ccl_device_query.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_QUERY_H_
#define _CCL_DEVICE_QUERY_H_

#include <string.h>
#include "ccl_common.h"
#include "ccl_device_wrapper.h"
#include "ccl_errors.h"
#include "ccl_oclversions.h"

typedef char* (*ccl_devquery_format)(CCLWrapperInfo* info, char* out,
    size_t size, const char* units);

typedef struct ccl_devquery_map {

    const char* const param_name;

    const cl_device_info device_info;

    const char* const description;

    const ccl_devquery_format format;

    const char* const units;

} CCLDevQueryMap;

CCL_EXPORT
extern const int ccl_devquery_info_map_size;

CCL_EXPORT
extern const CCLDevQueryMap ccl_devquery_info_map[];

/* Get a final device info prefix in the same format as
 * kept in the ccl_devquery_info_map. */
CCL_EXPORT
gchar* ccl_devquery_get_prefix_final(const char* prefix);

/* Return a cl_device_info object given its name. */
CCL_EXPORT
cl_device_info ccl_devquery_name(const char* name);

/* Get a list of device information parameters which have the
 * given prefix. */
CCL_EXPORT
const CCLDevQueryMap* ccl_devquery_prefix(const char* prefix, int* size);

/* Search for a device information parameter by matching part
 * of its name. This function is supposed to be used in a loop. */
CCL_EXPORT
const CCLDevQueryMap* ccl_devquery_match(const char* substr, int* idx);

#define ccl_devquery_type2str(type) \
    (((type) & CL_DEVICE_TYPE_CPU) ? "CPU" : \
        (((type) & CL_DEVICE_TYPE_GPU) ? "GPU" : \
            (((type) & CL_DEVICE_TYPE_ACCELERATOR) ? "Accelerator" : \
                (((type) & CL_DEVICE_TYPE_CUSTOM) ? "Custom" : \
                    "Unknown"))))

#endif