ccl_event_wrapper.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_EVENT_WRAPPER_H_
#define _CCL_EVENT_WRAPPER_H_

#include <glib.h>
#include "ccl_oclversions.h"
#include "ccl_abstract_wrapper.h"
#include "ccl_context_wrapper.h"

typedef void (CL_CALLBACK *ccl_event_callback)(cl_event event,
    cl_int event_command_exec_status, void *user_data);

/* Get the event wrapper for the given OpenCL event. */
CCL_EXPORT
CCLEvent* ccl_event_new_wrap(cl_event event);

/* Decrements the reference count of the event wrapper object. */
CCL_EXPORT
void ccl_event_destroy(CCLEvent* evt);

/* Set event name for profiling purposes. */
CCL_EXPORT
void ccl_event_set_name(CCLEvent* evt, const char* name);

/* Get the event name for profiling purposes. */
CCL_EXPORT
const char* ccl_event_get_name(CCLEvent* evt);

/* Get the final event name for profiling purposes. */
CCL_EXPORT
const char* ccl_event_get_final_name(CCLEvent* evt);

/* Get the command type which fired the given event. */
CCL_EXPORT
cl_command_type ccl_event_get_command_type(
    CCLEvent* evt, CCLErr** err);

/* Get the OpenCL version of the platform associated with this event
 * object. */
CCL_EXPORT
cl_uint ccl_event_get_opencl_version(CCLEvent* evt, CCLErr** err);

/* Wrapper for OpenCL clSetEventCallback() function. */
CCL_EXPORT
cl_bool ccl_event_set_callback(CCLEvent* evt,
    cl_int command_exec_callback_type, ccl_event_callback pfn_notify,
    void *user_data, CCLErr** err);

/* Create a new user event. */
CCL_EXPORT
CCLEvent* ccl_user_event_new(CCLContext* ctx, CCLErr** err);

/* Sets the execution status of a user event object. */
CCL_EXPORT
cl_bool ccl_user_event_set_status(
    CCLEvent* evt, cl_int execution_status, CCLErr** err);

#define ccl_event_get_info(evt, param_name, err) \
    ccl_wrapper_get_info((CCLWrapper*) evt, NULL, param_name, 0, \
        CCL_INFO_EVENT, CL_FALSE, err)

#define ccl_event_get_info_scalar(evt, param_name, param_type, err) \
    *((param_type*) ccl_wrapper_get_info_value((CCLWrapper*) evt, \
        NULL, param_name, sizeof(param_type), CCL_INFO_EVENT, CL_FALSE, err))

#define ccl_event_get_info_array(evt, param_name, param_type, err) \
    (param_type) ccl_wrapper_get_info_value((CCLWrapper*) evt, \
        NULL, param_name, sizeof(param_type), CCL_INFO_EVENT, CL_FALSE, err)

#define ccl_event_get_profiling_info(evt, param_name, err) \
    ccl_wrapper_get_info((CCLWrapper*) evt, NULL, param_name, 0, \
        CCL_INFO_EVENT_PROFILING, CL_FALSE, err)

#define ccl_event_get_profiling_info_scalar(evt, param_name, param_type, err) \
    *((param_type*) ccl_wrapper_get_info_value((CCLWrapper*) evt, \
        NULL, param_name, sizeof(param_type), \
        CCL_INFO_EVENT_PROFILING, CL_FALSE, err))

#define ccl_event_get_profiling_info_array(evt, param_name, param_type, err) \
    (param_type) ccl_wrapper_get_info_value((CCLWrapper*) evt, \
        NULL, param_name, sizeof(param_type), \
        CCL_INFO_EVENT_PROFILING, CL_FALSE, err)

#define ccl_event_ref(evt) \
    ccl_wrapper_ref((CCLWrapper*) evt)

#define ccl_event_unref(evt) ccl_event_destroy(evt)

#define ccl_event_unwrap(evt) \
    ((cl_event) ccl_wrapper_unwrap((CCLWrapper*) evt))

typedef GPtrArray* CCLEventWaitList;

#define ccl_ewl ccl_event_wait_list_add

/* Add event wrapper objects to an event wait list (variable argument
 * list version). */
CCL_EXPORT
CCLEventWaitList* ccl_event_wait_list_add(
    CCLEventWaitList* evt_wait_lst, ...) G_GNUC_NULL_TERMINATED;

/* Add event wrapper objects to an event wait list (array version). */
CCL_EXPORT
CCLEventWaitList* ccl_event_wait_list_add_v(
    CCLEventWaitList* evt_wait_lst, CCLEvent** evt);

/* Clears an event wait list. */
CCL_EXPORT
void ccl_event_wait_list_clear(CCLEventWaitList* evt_wait_lst);

#define ccl_event_wait_list_get_num_events(evt_wait_lst) \
    ((((evt_wait_lst) != NULL) && (*(evt_wait_lst) != NULL)) \
    ? (*(evt_wait_lst))->len \
    : 0)

#define ccl_event_wait_list_get_clevents(evt_wait_lst) \
    ((((evt_wait_lst) != NULL) && (*(evt_wait_lst) != NULL)) \
        ? (const cl_event*) (*(evt_wait_lst))->pdata \
        : NULL)

/* Waits on the host thread for commands identified by events in the
 * wait list to complete. */
CCL_EXPORT
cl_bool ccl_event_wait(CCLEventWaitList* evt_wait_lst, CCLErr** err);

#endif