Structs§
Constants§
- MCL_
ARG_ BUFFER - MCL_
ARG_ DONE - MCL_
ARG_ DYNAMIC - MCL_
ARG_ INPUT - MCL_
ARG_ INVALID - MCL_
ARG_ LOCAL - MCL_
ARG_ OUTPUT - MCL_
ARG_ RDONLY - MCL_
ARG_ RESIDENT - MCL_
ARG_ REWRITE - MCL_
ARG_ SCALAR - MCL_
ARG_ SHARED - MCL_
ARG_ WRONLY - MCL_
DEV_ ALLOCATED - MCL_
DEV_ DIMS - MCL_
DEV_ ERROR - MCL_
DEV_ FULL - MCL_
DEV_ NONE - MCL_
DEV_ READY - MCL_
ERR_ EXEC - MCL_
ERR_ INVARG - MCL_
ERR_ INVDEV - MCL_
ERR_ INVKER - MCL_
ERR_ INVPES - MCL_
ERR_ INVPRG - MCL_
ERR_ INVREQ - MCL_
ERR_ INVTSK - MCL_
ERR_ MEMALLOC - MCL_
ERR_ MEMCOPY - MCL_
ERR_ RESDATA - MCL_
ERR_ SRVCOMM - MCL_
FLAG_ NO_ RES - MCL_
HDL_ SHARED - MCL_
NULL - MCL_
PRG_ BIN - MCL_
PRG_ GRAPH - MCL_
PRG_ IR - MCL_
PRG_ MASK - MCL_
PRG_ NONE - MCL_
PRG_ SRC - MCL_
REQ_ ALLOCATED - MCL_
REQ_ COMPLETED - MCL_
REQ_ EXECUTING - MCL_
REQ_ FINISHING - MCL_
REQ_ INPROGRESS - MCL_
REQ_ PENDING - MCL_
RET_ ERROR - MCL_
RET_ SUCCESS - MCL_
RET_ UNDEFINED - MCL_
SET_ BIND_ WORKERS - MCL_
SHARED_ MEM_ DEL_ OLD - MCL_
SHARED_ MEM_ NEW - MCL_
START_ SCHED - MCL_
STOP_ SCHED - MCL_
TASK_ ANY - MCL_
TASK_ CPU - MCL_
TASK_ DFT_ FLAGS - MCL_
TASK_ FPGA - MCL_
TASK_ GPU - MCL_
TASK_ NAME_ LEN - MCL_
TASK_ NONE - MCL_
TASK_ TYPE_ MASK - MCL_
TIMEOUT
Functions§
- mcl_
exec ⚠ - @brief Execute a specified task
- mcl_
exec2 ⚠ - mcl_
exec2_ ⚠with_ dependencies - mcl_
exec_ ⚠with_ dependencies - mcl_
finit ⚠ - @brief Uninitialize MCL. @ingroup General
- mcl_
get_ ⚠dev - @brief Gets information about the specified device @ingroup DeviceStatus
- mcl_
get_ ⚠ndev - @brief Gets the number of available devices @ingroup DeviceStatus
- mcl_
hdl_ ⚠free - @brief Free MCL handle and associated task @pre Must be called after task has finished
- mcl_
init ⚠ - @brief Initialize MCL @ingroup General
- mcl_
invalidate_ ⚠buffer - @brief Invalidates device allocations @ingroup Args
- mcl_
null ⚠ - @brief Complete the task without executing (i.e. trigger dependencies) @ingroup General
- mcl_
prg_ ⚠load - @brief Load a program @ingroup General
- mcl_
register_ ⚠buffer - @brief Register a buffer for future use with MCL resident memory @ingroup Args
- mcl_
task_ ⚠create - @brief Create an empty MCL task @ingroup General
- mcl_
task_ ⚠create_ with_ props - @brief Create an empty MCL task @ingroup General
- mcl_
task_ ⚠init - @brief Creates a new task and initializes it with the specified kernel @ingroup General
- mcl_
task_ ⚠set_ arg - @brief Set up an argument associated with a task @ingroup Args
- mcl_
task_ ⚠set_ arg_ buffer - @brief Same as mcl task set arg, particularly for buffers @ingroup Args
- mcl_
task_ ⚠set_ kernel - @brief Initialize a task to run the specified kernel @ingroup General
- mcl_
test ⚠ - @brief Check the status of the handle
- mcl_
transfer_ ⚠create - @brief Create a transfer task. A transfer task executes no computation, but can be used to put or remove buffers from devices (i.e. if a an address needs to be invalidated because it might be reused later in the program for a different buffer)
- mcl_
transfer_ ⚠exec - @brief Executes a transfer. Asychronously moves data
- mcl_
transfer_ ⚠free - @brief Frees data associated with the transfer handle
- mcl_
transfer_ ⚠set_ arg - @brief Sets up an argument for a transfer handle. Same as mcl_task_set_arg but for a transfer.
- mcl_
transfer_ ⚠test - @brief Checks the status of a transfer
- mcl_
transfer_ ⚠wait - @brief Waits for transfers to complete
- mcl_
unregister_ ⚠buffer - @brief Unregisters a buffer from MCL Resident memory. @ingroup Args
- mcl_
wait ⚠ - @brief Block until the task associated with handle has finished
- mcl_
wait_ ⚠all - @brief Wait for all pending mcl tasks