ccl_common.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_COMMON_H_
#define _CCL_COMMON_H_

#include <stdio.h>
#include <stdlib.h>
#include <glib.h>
#include <glib/gprintf.h>
#include "ccl_oclversions.h"
#include "ccl_export.h"

#define CCL_VERSION_MAJOR 2

#define CCL_VERSION_MINOR 1

#define CCL_VERSION_PATCH 0

#define CCL_VERSION_TWEAK ""

#define CCL_VERSION_STRING "v2.1.0"

#define CCL_VERSION_STRING_FULL "v2.1.0+1.0000000"

#define CCL_VERSION_STRING_FINAL "v2.1.0"

#if defined CL_VERSION_2_2
    #define CCL_OPENCL_VERSION "2.2"
#elif defined CL_VERSION_2_1
    #define CCL_OPENCL_VERSION "2.1"
#elif defined CL_VERSION_2_0
    #define CCL_OPENCL_VERSION "2.0"
#elif defined CL_VERSION_1_2
    #define CCL_OPENCL_VERSION "1.2"
#elif defined CL_VERSION_1_1
    #define CCL_OPENCL_VERSION "1.1"
#elif defined CL_VERSION_1_0
    #define CCL_OPENCL_VERSION "1.0"
#else
    #error "OpenCL version is not defined"
#endif

#define CCL_COMPILER "GNU"

#define CCL_UNUSED(x) (void)(x)

typedef enum ccl_class {

    CCL_BUFFER    = 0,
    CCL_CONTEXT   = 1,
    CCL_DEVICE    = 2,
    CCL_EVENT     = 3,
    CCL_IMAGE     = 4,
    CCL_KERNEL    = 5,
    CCL_PLATFORM  = 6,
    CCL_PROGRAM   = 7,
    CCL_SAMPLER   = 8,
    CCL_QUEUE     = 9,
    CCL_NONE      = 10

} CCLClass;

typedef enum ccl_info {

    CCL_INFO_CONTEXT          = 0,
    CCL_INFO_DEVICE           = 1,
    CCL_INFO_EVENT            = 2,
    CCL_INFO_EVENT_PROFILING  = 3,
    CCL_INFO_IMAGE            = 4,
    CCL_INFO_KERNEL           = 5,
    CCL_INFO_KERNEL_ARG       = 6,
    CCL_INFO_KERNEL_WORKGROUP = 7,
    CCL_INFO_KERNEL_SUBGROUP  = 8,
    CCL_INFO_MEMOBJ           = 9,
    CCL_INFO_PLATFORM         = 10,
    CCL_INFO_PROGRAM          = 11,
    CCL_INFO_PROGRAM_BUILD    = 12,
    CCL_INFO_SAMPLER          = 13,
    CCL_INFO_QUEUE            = 14,
    CCL_INFO_PIPE             = 15,
    CCL_INFO_END              = 16

} CCLInfo;

typedef struct ccl_wrapper CCLWrapper;

typedef struct ccl_dev_container CCLDevContainer;

typedef struct ccl_memobj CCLMemObj;

typedef struct ccl_buffer CCLBuffer;

typedef struct ccl_context CCLContext;

typedef struct ccl_device CCLDevice;

typedef struct ccl_event CCLEvent;

typedef struct ccl_image CCLImage;

typedef struct ccl_kernel CCLKernel;

typedef struct ccl_platform CCLPlatform;

typedef struct ccl_program CCLProgram;

typedef struct ccl_sampler CCLSampler;

typedef struct ccl_queue CCLQueue;

typedef struct ccl_platforms CCLPlatforms;

typedef GError CCLErr;

typedef enum ccl_error_code {
    CCL_SUCCESS                    = 0,
    CCL_ERROR_OPENFILE             = 1,
    CCL_ERROR_ARGS                 = 2,
    CCL_ERROR_INVALID_DATA         = 3,
    CCL_ERROR_STREAM_WRITE         = 4,
    CCL_ERROR_DEVICE_NOT_FOUND     = 5,
    CCL_ERROR_UNSUPPORTED_OCL      = 6,
    CCL_ERROR_INFO_UNAVAILABLE_OCL = 7,
    CCL_ERROR_OTHER                = 15
} CCLErrorCode;

#define CCL_ERROR ccl_error_quark()

#define CCL_OCL_ERROR ccl_ocl_error_quark()

/* Print executable version. */
CCL_EXPORT
void ccl_common_version_print(const char* exec_name);

/* Frees a `NULL`-terminated array of strings, as well as each string it
 * contains. */
CCL_EXPORT
void ccl_strv_clear(char** str_array);

/* If `err` or `*err` is `NULL`, does nothing. Otherwise, releases memory
 * occupied by `*err` and sets `*err` to `NULL`. */
CCL_EXPORT
void ccl_err_clear(CCLErr** err);

/* Resolves to error category identifying string, in this case an error in
 * _cf4ocl_. */
CCL_EXPORT
GQuark ccl_error_quark(void);

/* Resolves to error category identifying string, in this case an error in the
 * OpenCL library. */
CCL_EXPORT
GQuark ccl_ocl_error_quark(void);

#endif