ccl_queue_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_QUEUE_WRAPPER_H_
#define _CCL_QUEUE_WRAPPER_H_

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

/* Get the command queue wrapper for the given OpenCL command
 * queue. */
CCL_EXPORT
CCLQueue* ccl_queue_new_wrap(cl_command_queue command_queue);

/* Create a new command queue wrapper object. */
CCL_EXPORT
CCLQueue* ccl_queue_new_full(CCLContext* ctx, CCLDevice* dev,
    const cl_queue_properties* prop_full, CCLErr** err);

/* Create a new command queue wrapper object. */
CCL_EXPORT
CCLQueue* ccl_queue_new(CCLContext* ctx, CCLDevice* dev,
    cl_command_queue_properties properties, CCLErr** err);

/* Decrements the reference count of the command queue wrapper
 * object. If it reaches 0, the command queue wrapper object is
 * destroyed. */
CCL_EXPORT
void ccl_queue_destroy(CCLQueue* cq);

/* Get the context associated with the given command queue wrapper
 * object. */
CCL_EXPORT
CCLContext* ccl_queue_get_context(CCLQueue* cq, CCLErr** err);

/* Get the device associated with the given command queue wrapper
 * object. */
CCL_EXPORT
CCLDevice* ccl_queue_get_device(CCLQueue* cq, CCLErr** err);

/* Create an event wrapper from a given OpenCL event object and
 * associate it with the command queue. */
CCL_EXPORT
CCLEvent* ccl_queue_produce_event(CCLQueue* cq, cl_event event);

/* Initialize an iterator for this command queue's list of event
 * wrappers. */
CCL_EXPORT
void ccl_queue_iter_event_init(CCLQueue* cq);

/* Get the next event wrapper associated with this queue. */
CCL_EXPORT
CCLEvent* ccl_queue_iter_event_next(CCLQueue* cq);

/* Issues all previously queued commands in a command queue to the
 * associated device. */
CCL_EXPORT
cl_bool ccl_queue_flush(CCLQueue* cq, CCLErr** err);

/* Blocks until all previously queued OpenCL commands in a command-queue
 * are issued to the associated device and have completed. */
CCL_EXPORT
cl_bool ccl_queue_finish(CCLQueue* cq, CCLErr** err);

/* Release all events associated with the command queue. */
CCL_EXPORT
void ccl_queue_gc(CCLQueue* cq);

/* Enqueues a barrier command on the given command queue. */
CCL_EXPORT
CCLEvent* ccl_enqueue_barrier(CCLQueue* cq,
    CCLEventWaitList* evt_wait_lst, CCLErr** err);

/* Enqueues a marker command on the given command queue. */
CCL_EXPORT
CCLEvent* ccl_enqueue_marker(CCLQueue* cq,
    CCLEventWaitList* evt_wait_lst, CCLErr** err);

#define ccl_queue_get_info(cq, param_name, err) \
    ccl_wrapper_get_info((CCLWrapper*) cq, NULL, param_name, 0, \
        CCL_INFO_QUEUE, CL_FALSE, err)

#define ccl_queue_get_info_scalar(cq, param_name, param_type, err) \
    *((param_type*) ccl_wrapper_get_info_value((CCLWrapper*) cq, \
        NULL, param_name, sizeof(param_type), CCL_INFO_QUEUE, CL_FALSE, err))

#define ccl_queue_get_info_array(cq, param_name, param_type, err) \
    (param_type) ccl_wrapper_get_info_value((CCLWrapper*) cq, \
        NULL, param_name, sizeof(param_type), CCL_INFO_QUEUE, CL_FALSE, err)

#define ccl_queue_ref(cq) \
    ccl_wrapper_ref((CCLWrapper*) cq)

#define ccl_queue_unref(cq) ccl_queue_destroy(cq)

#define ccl_queue_unwrap(cq) \
    ((cl_command_queue) ccl_wrapper_unwrap((CCLWrapper*) cq))

#endif