StarPU Handbook
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
Codelet And Tasks

This section describes the interface to manipulate codelets and tasks. More...

Data Structures

struct  starpu_codelet
struct  starpu_data_descr
struct  starpu_task

Macros

#define STARPU_NOWHERE
#define STARPU_CPU
#define STARPU_CUDA
#define STARPU_OPENCL
#define STARPU_MIC
#define STARPU_SCC
#define STARPU_MAIN_RAM
#define STARPU_MULTIPLE_CPU_IMPLEMENTATIONS
#define STARPU_MULTIPLE_CUDA_IMPLEMENTATIONS
#define STARPU_MULTIPLE_OPENCL_IMPLEMENTATIONS
#define STARPU_NMAXBUFS
#define STARPU_VARIABLE_NBUFFERS
#define STARPU_TASK_INITIALIZER
#define STARPU_TASK_GET_NBUFFERS(task)
#define STARPU_TASK_GET_HANDLE(task, i)
#define STARPU_TASK_SET_HANDLE(task, handle, i)
#define STARPU_CODELET_GET_MODE(codelet, i)
#define STARPU_CODELET_SET_MODE(codelet, mode, i)
#define STARPU_TASK_GET_MODE(task, i)
#define STARPU_TASK_SET_MODE(task, mode, i)
#define STARPU_TASK_INVALID

Typedefs

typedef void(* starpu_cpu_func_t )(void **, void *)
typedef void(* starpu_cuda_func_t )(void **, void *)
typedef void(* starpu_opencl_func_t )(void **, void *)
typedef starpu_mic_kernel_t(* starpu_mic_func_t )(void)
typedef starpu_scc_kernel_t(* starpu_scc_func_t )(void)
typedef void(* starpu_mic_kernel_t )(void **, void *)
typedef void(* starpu_scc_kernel_t )(void **, void *)

Enumerations

enum  starpu_codelet_type { STARPU_SEQ, STARPU_SPMD, STARPU_FORKJOIN }
enum  starpu_task_status {
  STARPU_TASK_INVALID, STARPU_TASK_INVALID, STARPU_TASK_BLOCKED, STARPU_TASK_READY,
  STARPU_TASK_RUNNING, STARPU_TASK_FINISHED, STARPU_TASK_BLOCKED_ON_TAG, STARPU_TASK_BLOCKED_ON_TASK,
  STARPU_TASK_BLOCKED_ON_DATA, STARPU_TASK_STOPPED
}

Functions

void starpu_codelet_init (struct starpu_codelet *cl)
void starpu_task_init (struct starpu_task *task)
struct starpu_taskstarpu_task_create (void) STARPU_ATTRIBUTE_MALLOC
struct starpu_taskstarpu_task_dup (struct starpu_task *task)
void starpu_task_clean (struct starpu_task *task)
void starpu_task_destroy (struct starpu_task *task)
int starpu_task_wait (struct starpu_task *task) STARPU_WARN_UNUSED_RESULT
int starpu_task_submit (struct starpu_task *task) STARPU_WARN_UNUSED_RESULT
int starpu_task_submit_to_ctx (struct starpu_task *task, unsigned sched_ctx_id)
int starpu_task_wait_for_all (void)
int starpu_task_wait_for_all_in_ctx (unsigned sched_ctx_id)
int starpu_task_wait_for_n_submitted (unsigned n)
int starpu_task_wait_for_n_submitted_in_ctx (unsigned sched_ctx_id, unsigned n)
int starpu_task_nready (void)
int starpu_task_nsubmitted (void)
struct starpu_taskstarpu_task_get_current (void)
const char * starpu_task_get_name (struct starpu_task *task)
const char * starpu_task_get_model_name (struct starpu_task *task)
void starpu_codelet_display_stats (struct starpu_codelet *cl)
int starpu_task_wait_for_no_ready (void)
void starpu_task_set_implementation (struct starpu_task *task, unsigned impl)
unsigned starpu_task_get_implementation (struct starpu_task *task)
void starpu_iteration_push (unsigned long iteration)
void starpu_iteration_pop (void)
void starpu_create_sync_task (starpu_tag_t sync_tag, unsigned ndeps, starpu_tag_t *deps, void(*callback)(void *), void *callback_arg)

Detailed Description

This section describes the interface to manipulate codelets and tasks.


Data Structure Documentation

struct starpu_codelet

The codelet structure describes a kernel that is possibly implemented on various targets. For compatibility, make sure to initialize the whole structure to zero, either by using explicit memset, or the function starpu_codelet_init(), or by letting the compiler implicitly do it in e.g. static storage case.

Data Fields

uint32_t where
int(* can_execute )(unsigned workerid, struct starpu_task *task, unsigned nimpl)
enum starpu_codelet_type type
int max_parallelism
starpu_cpu_func_t cpu_func
starpu_cuda_func_t cuda_func
starpu_opencl_func_t opencl_func
starpu_cpu_func_t cpu_funcs [STARPU_MAXIMPLEMENTATIONS]
starpu_cuda_func_t cuda_funcs [STARPU_MAXIMPLEMENTATIONS]
char cuda_flags [STARPU_MAXIMPLEMENTATIONS]
starpu_opencl_func_t opencl_funcs [STARPU_MAXIMPLEMENTATIONS]
char opencl_flags [STARPU_MAXIMPLEMENTATIONS]
starpu_mic_func_t mic_funcs [STARPU_MAXIMPLEMENTATIONS]
starpu_scc_func_t scc_funcs [STARPU_MAXIMPLEMENTATIONS]
const char * cpu_funcs_name [STARPU_MAXIMPLEMENTATIONS]
int nbuffers
enum starpu_data_access_mode modes [STARPU_NMAXBUFS]
enum starpu_data_access_modedyn_modes
unsigned specific_nodes
int nodes [STARPU_NMAXBUFS]
int * dyn_nodes
struct starpu_perfmodelmodel
struct starpu_perfmodelenergy_model
unsigned long per_worker_stats [STARPU_NMAXWORKERS]
const char * name
int flags

Field Documentation

uint32_t starpu_codelet::where

Optional field to indicate which types of processing units are able to execute the codelet. The different values STARPU_CPU, STARPU_CUDA, STARPU_OPENCL can be combined to specify on which types of processing units the codelet can be executed. STARPU_CPU|STARPU_CUDA for instance indicates that the codelet is implemented for both CPU cores and CUDA devices while STARPU_OPENCL indicates that it is only available on OpenCL devices. If the field is unset, its value will be automatically set based on the availability of the XXX_funcs fields defined below. It can also be set to STARPU_NOWHERE to specify that no computation has to be actually done.

int(* starpu_codelet::can_execute)(unsigned workerid, struct starpu_task *task, unsigned nimpl)

Define a function which should return 1 if the worker designated by workerid can execute the nimplth implementation of the given task, 0 otherwise.

enum starpu_codelet_type starpu_codelet::type

Optional field to specify the type of the codelet. The default is STARPU_SEQ, i.e. usual sequential implementation. Other values (STARPU_SPMD or STARPU_FORKJOIN declare that a parallel implementation is also available. See Parallel Tasks for details.

int starpu_codelet::max_parallelism

Optional field. If a parallel implementation is available, this denotes the maximum combined worker size that StarPU will use to execute parallel tasks for this codelet.

starpu_cpu_func_t starpu_codelet::cpu_func
Deprecated:
Optional field which has been made deprecated. One should use instead the field starpu_codelet::cpu_funcs.
starpu_cuda_func_t starpu_codelet::cuda_func
Deprecated:
Optional field which has been made deprecated. One should use instead the starpu_codelet::cuda_funcs field.
starpu_opencl_func_t starpu_codelet::opencl_func
Deprecated:
Optional field which has been made deprecated. One should use instead the starpu_codelet::opencl_funcs field.
starpu_cpu_func_t starpu_codelet::cpu_funcs[STARPU_MAXIMPLEMENTATIONS]

Optional array of function pointers to the CPU implementations of the codelet. The functions prototype must be:

void cpu_func(void *buffers[], void *cl_arg)

The first argument being the array of data managed by the data management library, and the second argument is a pointer to the argument passed from the field starpu_task::cl_arg. If the field starpu_codelet::where is set, then the field starpu_codelet::cpu_funcs is ignored if STARPU_CPU does not appear in the field starpu_codelet::where, it must be non-null otherwise.

starpu_cuda_func_t starpu_codelet::cuda_funcs[STARPU_MAXIMPLEMENTATIONS]

Optional array of function pointers to the CUDA implementations of the codelet. The functions must be host-functions written in the CUDA runtime API. Their prototype must be:

void cuda_func(void *buffers[], void *cl_arg)

If the field starpu_codelet::where is set, then the field starpu_codelet::cuda_funcs is ignored if STARPU_CUDA does not appear in the field starpu_codelet::where, it must be non-null otherwise.

char starpu_codelet::cuda_flags[STARPU_MAXIMPLEMENTATIONS]

Optional array of flags for CUDA execution. They specify some semantic details about CUDA kernel execution, such as asynchronous execution.

starpu_opencl_func_t starpu_codelet::opencl_funcs[STARPU_MAXIMPLEMENTATIONS]

Optional array of function pointers to the OpenCL implementations of the codelet. The functions prototype must be:

void opencl_func(void *buffers[], void *cl_arg)

If the field starpu_codelet::where field is set, then the field starpu_codelet::opencl_funcs is ignored if STARPU_OPENCL does not appear in the field starpu_codelet::where, it must be non-null otherwise.

char starpu_codelet::opencl_flags[STARPU_MAXIMPLEMENTATIONS]

Optional array of flags for OpenCL execution. They specify some semantic details about OpenCL kernel execution, such as asynchronous execution.

starpu_mic_func_t starpu_codelet::mic_funcs[STARPU_MAXIMPLEMENTATIONS]

Optional array of function pointers to a function which returns the MIC implementation of the codelet. The functions prototype must be:

starpu_mic_kernel_t mic_func(struct starpu_codelet *cl, unsigned nimpl)

If the field starpu_codelet::where is set, then the field starpu_codelet::mic_funcs is ignored if STARPU_MIC does not appear in the field starpu_codelet::where. It can be null if starpu_codelet::cpu_funcs_name is non-NULL, in which case StarPU will simply make a symbol lookup to get the implementation.

starpu_scc_func_t starpu_codelet::scc_funcs[STARPU_MAXIMPLEMENTATIONS]

Optional array of function pointers to a function which returns the SCC implementation of the codelet. The functions prototype must be:

starpu_scc_kernel_t scc_func(struct starpu_codelet *cl, unsigned nimpl)

If the field starpu_codelet::where is set, then the field starpu_codelet::scc_funcs is ignored if STARPU_SCC does not appear in the field starpu_codelet::where. It can be null if starpu_codelet::cpu_funcs_name is non-NULL, in which case StarPU will simply make a symbol lookup to get the implementation.

char * starpu_codelet::cpu_funcs_name[STARPU_MAXIMPLEMENTATIONS]

Optional array of strings which provide the name of the CPU functions referenced in the array starpu_codelet::cpu_funcs. This can be used when running on MIC devices or the SCC platform, for StarPU to simply look up the MIC function implementation through its name.

int starpu_codelet::nbuffers

Specify the number of arguments taken by the codelet. These arguments are managed by the DSM and are accessed from the void *buffers[] array. The constant argument passed with the field starpu_task::cl_arg is not counted in this number. This value should not be above STARPU_NMAXBUFS. It may be set to STARPU_VARIABLE_NBUFFERS to specify that the number of buffers and their access modes will be set in starpu_task::nbuffers and starpu_task::modes or starpu_task::dyn_modes, which thus permits to define codelets with a varying number of data.

enum starpu_data_access_mode starpu_codelet::modes[STARPU_NMAXBUFS]

Is an array of starpu_data_access_mode. It describes the required access modes to the data neeeded by the codelet (e.g. STARPU_RW). The number of entries in this array must be specified in the field starpu_codelet::nbuffers, and should not exceed STARPU_NMAXBUFS. If unsufficient, this value can be set with the configure option --enable-maxbuffers.

enum starpu_data_access_mode * starpu_codelet::dyn_modes

Is an array of starpu_data_access_mode. It describes the required access modes to the data needed by the codelet (e.g. STARPU_RW). The number of entries in this array must be specified in the field starpu_codelet::nbuffers. This field should be used for codelets having a number of datas greater than STARPU_NMAXBUFS (see Setting Many Data Handles For a Task). When defining a codelet, one should either define this field or the field starpu_codelet::modes defined above.

unsigned starpu_codelet::specific_nodes

Default value is 0. If this flag is set, StarPU will not systematically send all data to the memory node where the task will be executing, it will read the starpu_codelet::nodes or starpu_codelet::dyn_nodes array to determine, for each data, whether to send it on the memory node where the task will be executing (-1), or on a specific node (!= -1).

int starpu_codelet::nodes[STARPU_NMAXBUFS]

Optional field. When starpu_codelet::specific_nodes is 1, this specifies the memory nodes where each data should be sent to for task execution. The number of entries in this array is starpu_codelet::nbuffers, and should not exceed STARPU_NMAXBUFS.

int * starpu_codelet::dyn_nodes

Optional field. When starpu_codelet::specific_nodes is 1, this specifies the memory nodes where each data should be sent to for task execution. The number of entries in this array is starpu_codelet::nbuffers. This field should be used for codelets having a number of datas greater than STARPU_NMAXBUFS (see Setting Many Data Handles For a Task). When defining a codelet, one should either define this field or the field starpu_codelet::nodes defined above.

struct starpu_perfmodel * starpu_codelet::model

Optional pointer to the task duration performance model associated to this codelet. This optional field is ignored when set to NULL or when its field starpu_perfmodel::symbol is not set.

struct starpu_perfmodel * starpu_codelet::energy_model

Optional pointer to the task energy consumption performance model associated to this codelet. This optional field is ignored when set to NULL or when its field starpu_perfmodel::field is not set. In the case of parallel codelets, this has to account for all processing units involved in the parallel execution.

unsigned long starpu_codelet::per_worker_stats[STARPU_NMAXWORKERS]

Optional array for statistics collected at runtime: this is filled by StarPU and should not be accessed directly, but for example by calling the function starpu_codelet_display_stats() (See starpu_codelet_display_stats() for details).

const char * starpu_codelet::name

Optional name of the codelet. This can be useful for debugging purposes.

const char * starpu_codelet::flags

Various flags for the codelet.

struct starpu_data_descr

This type is used to describe a data handle along with an access mode.

Data Fields
starpu_data_handle_t handle describes a data
enum starpu_data_access_mode mode describes its access mode
struct starpu_task

The structure describes a task that can be offloaded on the various processing units managed by StarPU. It instantiates a codelet. It can either be allocated dynamically with the function starpu_task_create(), or declared statically. In the latter case, the programmer has to zero the structure starpu_task and to fill the different fields properly. The indicated default values correspond to the configuration of a task allocated with starpu_task_create().

Data Fields

const char * name
struct starpu_codeletcl
int nbuffers
starpu_data_handle_t handles [STARPU_NMAXBUFS]
void * interfaces [STARPU_NMAXBUFS]
enum starpu_data_access_mode modes [STARPU_NMAXBUFS]
starpu_data_handle_tdyn_handles
void ** dyn_interfaces
enum starpu_data_access_modedyn_modes
void * cl_arg
size_t cl_arg_size
void(* callback_func )(void *)
void * callback_arg
void(* prologue_callback_func )(void *)
void * prologue_callback_arg
void(* prologue_callback_pop_func )(void *)
void * prologue_callback_pop_arg
starpu_tag_t tag_id
unsigned cl_arg_free:1
unsigned callback_arg_free:1
unsigned prologue_callback_arg_free:1
unsigned prologue_callback_pop_arg_free:1
unsigned use_tag:1
unsigned sequential_consistency:1
unsigned synchronous:1
unsigned execute_on_a_specific_worker:1
unsigned detach:1
unsigned destroy:1
unsigned regenerate:1
unsigned scheduled:1
unsigned int mf_skip:1
unsigned workerid
unsigned workerorder
int priority
enum starpu_task_status status
int magic
unsigned sched_ctx
int hypervisor_tag
unsigned possibly_parallel
starpu_task_bundle_t bundle
struct starpu_profiling_task_infoprofiling_info
double flops
double predicted
double predicted_transfer
struct starpu_taskprev
struct starpu_tasknext
void * starpu_private
unsigned prefetched
struct starpu_omp_task * omp_task

Field Documentation

const char * starpu_task::name

Optional name of the task. This can be useful for debugging purposes.

struct starpu_codelet * starpu_task::cl

Is a pointer to the corresponding structure starpu_codelet. This describes where the kernel should be executed, and supplies the appropriate implementations. When set to NULL, no code is executed during the tasks, such empty tasks can be useful for synchronization purposes. This field has been made deprecated. One should use instead the field starpu_task::handles to specify the data handles accessed by the task. The access modes are now defined in the field starpu_codelet::modes.

int starpu_task::nbuffers

Specifies the number of buffers. This is only used when starpu_codelet::nbuffers is STARPU_VARIABLE_NBUFFERS.

starpu_data_handle_t starpu_task::handles[STARPU_NMAXBUFS]

Is an array of starpu_data_handle_t. It specifies the handles to the different pieces of data accessed by the task. The number of entries in this array must be specified in the field starpu_codelet::nbuffers, and should not exceed STARPU_NMAXBUFS. If unsufficient, this value can be set with the configure option --enable-maxbuffers.

void * starpu_task::interfaces[STARPU_NMAXBUFS]

The actual data pointers to the memory node where execution will happen, managed by the DSM.

enum starpu_data_access_mode starpu_task::modes[STARPU_NMAXBUFS]

Is used only when starpu_codelet::nbuffers is STARPU_VARIABLE_NBUFFERS. It is an array of starpu_data_access_mode. It describes the required access modes to the data neeeded by the codelet (e.g. STARPU_RW). The number of entries in this array must be specified in the field starpu_task::nbuffers, and should not exceed STARPU_NMAXBUFS. If unsufficient, this value can be set with the configure option --enable-maxbuffers.

starpu_data_handle_t * starpu_task::dyn_handles

Is an array of starpu_data_handle_t. It specifies the handles to the different pieces of data accessed by the task. The number of entries in this array must be specified in the field starpu_codelet::nbuffers. This field should be used for tasks having a number of datas greater than STARPU_NMAXBUFS (see Setting Many Data Handles For a Task). When defining a task, one should either define this field or the field starpu_task::handles defined above.

void ** starpu_task::dyn_interfaces

The actual data pointers to the memory node where execution will happen, managed by the DSM. Is used when the field starpu_task::dyn_handles is defined.

enum starpu_data_access_mode * starpu_task::dyn_modes

Is used only when starpu_codelet::nbuffers is STARPU_VARIABLE_NBUFFERS. It is an array of starpu_data_access_mode. It describes the required access modes to the data needed by the codelet (e.g. STARPU_RW). The number of entries in this array must be specified in the field starpu_codelet::nbuffers. This field should be used for codelets having a number of datas greater than STARPU_NMAXBUFS (see Setting Many Data Handles For a Task). When defining a codelet, one should either define this field or the field starpu_task::modes defined above.

void * starpu_task::cl_arg

Optional pointer which is passed to the codelet through the second argument of the codelet implementation (e.g. starpu_codelet::cpu_func or starpu_codelet::cuda_func). The default value is NULL. starpu_codelet_pack_args() and starpu_codelet_unpack_args() are helpers that can can be used to respectively pack and unpack data into and from it, but the application can manage it any way, the only requirement is that the size of the data must be set in starpu_task:cl_arg_size .

size_t starpu_task::cl_arg_size

Optional field. For some specific drivers, the pointer starpu_task::cl_arg cannot not be directly given to the driver function. A buffer of size starpu_task::cl_arg_size needs to be allocated on the driver. This buffer is then filled with the starpu_task::cl_arg_size bytes starting at address starpu_task::cl_arg. In this case, the argument given to the codelet is therefore not the starpu_task::cl_arg pointer, but the address of the buffer in local store (LS) instead. This field is ignored for CPU, CUDA and OpenCL codelets, where the starpu_task::cl_arg pointer is given as such.

void(* starpu_task::callback_func)(void *)

Optional field, the default value is NULL. This is a function pointer of prototype void (*f)(void *) which specifies a possible callback. If this pointer is non-null, the callback function is executed on the host after the execution of the task. Tasks which depend on it might already be executing. The callback is passed the value contained in the starpu_task::callback_arg field. No callback is executed if the field is set to NULL.

void * starpu_task::callback_arg

Optional field, the default value is NULL. This is the pointer passed to the callback function. This field is ignored if the field starpu_task::callback_func is set to NULL.

void(* starpu_task::prologue_callback_func)(void *)

Optional field, the default value is NULL. This is a function pointer of prototype void (*f)(void *) which specifies a possible callback. If this pointer is non-null, the callback function is executed on the host when the task becomes ready for execution, before getting scheduled. The callback is passed the value contained in the starpu_task::prologue_callback_arg field. No callback is executed if the field is set to NULL.

void * starpu_task::prologue_callback_arg

Optional field, the default value is NULL. This is the pointer passed to the prologue callback function. This field is ignored if the field starpu_task::prologue_callback_func is set to NULL.

starpu_tag_t starpu_task::tag_id

This optional field contains the tag associated to the task if the field starpu_task::use_tag is set, it is ignored otherwise.

unsigned starpu_task::cl_arg_free

Optional field. In case starpu_task::cl_arg was allocated by the application through malloc(), setting starpu_task::cl_arg_free to 1 makes StarPU automatically call free(cl_arg) when destroying the task. This saves the user from defining a callback just for that. This is mostly useful when targetting MIC or SCC, where the codelet does not execute in the same memory space as the main thread.

unsigned starpu_task::callback_arg_free

Optional field. In case starpu_task::callback_arg was allocated by the application through malloc(), setting starpu_task::callback_arg_free to 1 makes StarPU automatically call free(callback_arg) when destroying the task.

unsigned starpu_task::prologue_callback_arg_free

Optional field. In case starpu_task::prologue_callback_arg was allocated by the application through malloc(), setting starpu_task::prologue_callback_arg_free to 1 makes StarPU automatically call free(prologue_callback_arg) when destroying the task.

unsigned starpu_task::use_tag

Optional field, the default value is 0. If set, this flag indicates that the task should be associated with the tag contained in the starpu_task::tag_id field. Tag allow the application to synchronize with the task and to express task dependencies easily.

unsigned starpu_task::sequential_consistency

If this flag is set (which is the default), sequential consistency is enforced for the data parameters of this task for which sequential consistency is enabled. Clearing this flag permits to disable sequential consistency for this task, even if data have it enabled.

unsigned starpu_task::synchronous

If this flag is set, the function starpu_task_submit() is blocking and returns only when the task has been executed (or if no worker is able to process the task). Otherwise, starpu_task_submit() returns immediately.

unsigned starpu_task::execute_on_a_specific_worker

Default value is 0. If this flag is set, StarPU will bypass the scheduler and directly affect this task to the worker specified by the field starpu_task::workerid.

unsigned starpu_task::detach

Optional field, default value is 1. If this flag is set, it is not possible to synchronize with the task by the means of starpu_task_wait() later on. Internal data structures are only guaranteed to be freed once starpu_task_wait() is called if the flag is not set.

unsigned starpu_task::destroy

Optional value. Default value is 0 for starpu_task_init(), and 1 for starpu_task_create(). If this flag is set, the task structure will automatically be freed, either after the execution of the callback if the task is detached, or during starpu_task_wait() otherwise. If this flag is not set, dynamically allocated data structures will not be freed until starpu_task_destroy() is called explicitly. Setting this flag for a statically allocated task structure will result in undefined behaviour. The flag is set to 1 when the task is created by calling starpu_task_create(). Note that starpu_task_wait_for_all() will not free any task.

unsigned starpu_task::regenerate

Optional field. If this flag is set, the task will be re-submitted to StarPU once it has been executed. This flag must not be set if the flag starpu_task::destroy is set. This flag must be set before making another task depend on this one.

unsigned starpu_task::scheduled

Whether the scheduler has pushed the task on some queue

unsigned int starpu_task::mf_skip

This is only used for tasks that use multiformat handle. This should only be used by StarPU.

unsigned starpu_task::workerid

Optional field. If the field starpu_task::execute_on_a_specific_worker is set, this field indicates the identifier of the worker that should process this task (as returned by starpu_worker_get_id()). This field is ignored if the field starpu_task::execute_on_a_specific_worker is set to 0.

unsigned starpu_task::workerorder

Optional field. If the field starpu_task::execute_on_a_specific_worker is set, this field indicates the per-worker consecutive order in which tasks should be executed on the worker. Tasks will be executed in consecutive starpu_task::workerorder values, thus ignoring the availability order or task priority. See Static Scheduling for more details. This field is ignored if the field starpu_task::execute_on_a_specific_worker is set to 0.

int starpu_task::priority

Optional field, the default value is STARPU_DEFAULT_PRIO. This field indicates a level of priority for the task. This is an integer value that must be set between the return values of the function starpu_sched_get_min_priority() for the least important tasks, and that of the function starpu_sched_get_max_priority() for the most important tasks (included). The STARPU_MIN_PRIO and STARPU_MAX_PRIO macros are provided for convenience and respectively returns the value of starpu_sched_get_min_priority() and starpu_sched_get_max_priority(). Default priority is STARPU_DEFAULT_PRIO, which is always defined as 0 in order to allow static task initialization. Scheduling strategies that take priorities into account can use this parameter to take better scheduling decisions, but the scheduling policy may also ignore it.

enum starpu_task_status starpu_task::status

Optional field. Current state of the task.

int starpu_task::magic

This field is set when initializing a task. The function starpu_task_submit() will fail if the field does not have the right value. This will hence avoid submitting tasks which have not been properly initialised.

unsigned starpu_task::sched_ctx

Scheduling context.

int starpu_task::hypervisor_tag

Helps the hypervisor monitor the execution of this task.

starpu_task_bundle_t starpu_task::bundle

Optional field. The bundle that includes this task. If no bundle is used, this should be NULL.

struct starpu_profiling_task_info * starpu_task::profiling_info

Optional field. Profiling information for the task.

double starpu_task::flops

This can be set to the number of floating points operations that the task will have to achieve. This is useful for easily getting GFlops curves from the tool starpu_perfmodel_plot, and for the hypervisor load balancing.

double starpu_task::predicted

Output field. Predicted duration of the task. This field is only set if the scheduling strategy uses performance models.

double starpu_task::predicted_transfer

Optional field. Predicted data transfer duration for the task in microseconds. This field is only valid if the scheduling strategy uses performance models.

struct starpu_task * starpu_task::prev

A pointer to the previous task. This should only be used by StarPU.

struct starpu_task * starpu_task::next

A pointer to the next task. This should only be used by StarPU.

void * starpu_task::starpu_private

This is private to StarPU, do not modify. If the task is allocated by hand (without starpu_task_create()), this field should be set to NULL.

Macro Definition Documentation

#define STARPU_NOWHERE

This macro is used when setting the field starpu_codelet::where to specify that the codelet has no computation part, and thus does not need to be scheduled, and data does not need to be actually loaded. This is thus essentially used for synchronization tasks.

#define STARPU_CPU

This macro is used when setting the field starpu_codelet::where to specify the codelet may be executed on a CPU processing unit.

#define STARPU_CUDA

This macro is used when setting the field starpu_codelet::where to specify the codelet may be executed on a CUDA processing unit.

#define STARPU_OPENCL

This macro is used when setting the field starpu_codelet::where to specify the codelet may be executed on a OpenCL processing unit.

#define STARPU_MIC

This macro is used when setting the field starpu_codelet::where to specify the codelet may be executed on a MIC processing unit.

#define STARPU_SCC

This macro is used when setting the field starpu_codelet::where to specify the codelet may be executed on an SCC processing unit.

#define STARPU_MAIN_RAM

This macro is used when the RAM memory node is specified.

#define STARPU_MULTIPLE_CPU_IMPLEMENTATIONS
Deprecated:
Setting the field starpu_codelet::cpu_func with this macro indicates the codelet will have several implementations. The use of this macro is deprecated. One should always only define the field starpu_codelet::cpu_funcs.
#define STARPU_MULTIPLE_CUDA_IMPLEMENTATIONS
Deprecated:
Setting the field starpu_codelet::cuda_func with this macro indicates the codelet will have several implementations. The use of this macro is deprecated. One should always only define the field starpu_codelet::cuda_funcs.
#define STARPU_MULTIPLE_OPENCL_IMPLEMENTATIONS
Deprecated:
Setting the field starpu_codelet::opencl_func with this macro indicates the codelet will have several implementations. The use of this macro is deprecated. One should always only define the field starpu_codelet::opencl_funcs.
#define STARPU_NMAXBUFS

Defines the maximum number of buffers that tasks will be able to take as parameters. The default value is 8, it can be changed by using the configure option --enable-maxbuffers.

#define STARPU_VARIABLE_NBUFFERS

Value to set in starpu_codelet::nbuffers to specify that the codelet can accept a variable number of buffers, specified in starpu_task::nbuffers.

#define STARPU_TASK_INITIALIZER

It is possible to initialize statically allocated tasks with this value. This is equivalent to initializing a structure starpu_task with the function starpu_task_init() function.

#define STARPU_TASK_GET_NBUFFERS (   task)

Return the number of buffers for this task, i.e. starpu_codelet::nbuffers, or starpu_task::nbuffers if the former is STARPU_VARIABLE_NBUFFERS.

#define STARPU_TASK_GET_HANDLE (   task,
 
)

Return the i th data handle of the given task. If the task is defined with a static or dynamic number of handles, will either return the i th element of the field starpu_task::handles or the i th element of the field starpu_task::dyn_handles (see Setting Many Data Handles For a Task)

#define STARPU_TASK_SET_HANDLE (   task,
  handle,
 
)

Set the i th data handle of the given task with the given dat handle. If the task is defined with a static or dynamic number of handles, will either set the i th element of the field starpu_task::handles or the i th element of the field starpu_task::dyn_handles (see Setting Many Data Handles For a Task)

#define STARPU_CODELET_GET_MODE (   codelet,
 
)

Return the access mode of the i th data handle of the given codelet. If the codelet is defined with a static or dynamic number of handles, will either return the i th element of the field starpu_codelet::modes or the i th element of the field starpu_codelet::dyn_modes (see Setting Many Data Handles For a Task)

#define STARPU_CODELET_SET_MODE (   codelet,
  mode,
 
)

Set the access mode of the i th data handle of the given codelet. If the codelet is defined with a static or dynamic number of handles, will either set the i th element of the field starpu_codelet::modes or the i th element of the field starpu_codelet::dyn_modes (see Setting Many Data Handles For a Task)

#define STARPU_TASK_GET_MODE (   task,
 
)

Return the access mode of the i th data handle of the given task. If the task is defined with a static or dynamic number of handles, will either return the i th element of the field starpu_task::modes or the i th element of the field starpu_task::dyn_modes (see Setting Many Data Handles For a Task)

#define STARPU_TASK_SET_MODE (   task,
  mode,
 
)

Set the access mode of the i th data handle of the given task. If the task is defined with a static or dynamic number of handles, will either set the i th element of the field starpu_task::modes or the i th element of the field starpu_task::dyn_modes (see Setting Many Data Handles For a Task)

starpu_task_status::STARPU_TASK_INVALID

The task has just been initialized.

Typedef Documentation

starpu_cpu_func_t

CPU implementation of a codelet.

starpu_cuda_func_t

CUDA implementation of a codelet.

starpu_opencl_func_t

OpenCL implementation of a codelet.

starpu_mic_func_t

MIC implementation of a codelet.

starpu_scc_func_t

SCC implementation of a codelet.

starpu_mic_kernel_t

MIC kernel for a codelet

starpu_scc_kernel_t

SCC kernel for a codelet

Enumeration Type Documentation

Describes the type of parallel task. See Parallel Tasks for details.

Enumerator:
STARPU_SEQ 

(default) for classical sequential tasks.

STARPU_SPMD 

for a parallel task whose threads are handled by StarPU, the code has to use starpu_combined_worker_get_size() and starpu_combined_worker_get_rank() to distribute the work.

STARPU_FORKJOIN 

for a parallel task whose threads are started by the codelet function, which has to use starpu_combined_worker_get_size() to determine how many threads should be started.

Task status

Enumerator:
STARPU_TASK_BLOCKED 

The task has just been submitted, and its dependencies has not been checked yet.

STARPU_TASK_READY 

The task is ready for execution.

STARPU_TASK_RUNNING 

The task is running on some worker.

STARPU_TASK_FINISHED 

The task is finished executing.

STARPU_TASK_BLOCKED_ON_TAG 

The task is waiting for a tag.

STARPU_TASK_BLOCKED_ON_TASK 

The task is waiting for a task.

STARPU_TASK_BLOCKED_ON_DATA 

The task is waiting for some data.

Function Documentation

void starpu_codelet_init ( struct starpu_codelet cl)

Initialize cl with default values. Codelets should preferably be initialized statically as shown in Defining A Codelet. However such a initialisation is not always possible, e.g. when using C++.

void starpu_task_init ( struct starpu_task task)

Initialize task with default values. This function is implicitly called by starpu_task_create(). By default, tasks initialized with starpu_task_init() must be deinitialized explicitly with starpu_task_clean(). Tasks can also be initialized statically, using STARPU_TASK_INITIALIZER.

struct starpu_task * starpu_task_create ( void  )
read

Allocate a task structure and initialize it with default values. Tasks allocated dynamically with starpu_task_create() are automatically freed when the task is terminated. This means that the task pointer can not be used any more once the task is submitted, since it can be executed at any time (unless dependencies make it wait) and thus freed at any time. If the field starpu_task::destroy is explicitly unset, the resources used by the task have to be freed by calling starpu_task_destroy().

struct starpu_task * starpu_task_dup ( struct starpu_task task)
read

Allocate a task structure which is the exact duplicate of the given task.

void starpu_task_clean ( struct starpu_task task)

Release all the structures automatically allocated to execute task, but not the task structure itself and values set by the user remain unchanged. It is thus useful for statically allocated tasks for instance. It is also useful when users want to execute the same operation several times with as least overhead as possible. It is called automatically by starpu_task_destroy(). It has to be called only after explicitly waiting for the task or after starpu_shutdown() (waiting for the callback is not enough, since StarPU still manipulates the task after calling the callback).

void starpu_task_destroy ( struct starpu_task task)

Free the resource allocated during starpu_task_create() and associated with task. This function is already called automatically after the execution of a task when the field starpu_task::destroy is set, which is the default for tasks created by starpu_task_create(). Calling this function on a statically allocated task results in an undefined behaviour.

int starpu_task_wait ( struct starpu_task task)

This function blocks until task has been executed. It is not possible to synchronize with a task more than once. It is not possible to wait for synchronous or detached tasks. Upon successful completion, this function returns 0. Otherwise, -EINVAL indicates that the specified task was either synchronous or detached.

int starpu_task_submit ( struct starpu_task task)

This function submits task to StarPU. Calling this function does not mean that the task will be executed immediately as there can be data or task (tag) dependencies that are not fulfilled yet: StarPU will take care of scheduling this task with respect to such dependencies. This function returns immediately if the field starpu_task::synchronous is set to 0, and block until the termination of the task otherwise. It is also possible to synchronize the application with asynchronous tasks by the means of tags, using the function starpu_tag_wait() function for instance. In case of success, this function returns 0, a return value of -ENODEV means that there is no worker able to process this task (e.g. there is no GPU available and this task is only implemented for CUDA devices). starpu_task_submit() can be called from anywhere, including codelet functions and callbacks, provided that the field starpu_task::synchronous is set to 0.

int starpu_task_submit_to_ctx ( struct starpu_task task,
unsigned  sched_ctx_id 
)

This function submits a task to StarPU to the context sched_ctx_id . By default starpu_task_submit submits the task to a global context that is created automatically by StarPU.

int starpu_task_wait_for_all ( void  )

This function blocks until all the tasks that were submitted (to the current context or the global one if there aren't any) are terminated. It does not destroy these tasks.

int starpu_task_wait_for_all_in_ctx ( unsigned  sched_ctx_id)

This function waits until all the tasks that were already submitted to the context sched_ctx_id have been executed.

int starpu_task_wait_for_n_submitted ( unsigned  n)

This function blocks until there are n submitted tasks left (to the current context or the global one if there aren't any) to be executed. It does not destroy these tasks.

int starpu_task_wait_for_n_submitted_in_ctx ( unsigned  sched_ctx_id,
unsigned  n 
)

This function waits until there are n tasks submitted left to be executed that were already submitted to the context sched_ctx_id .

int starpu_task_nready ( void  )

TODO

Return the number of submitted tasks which are ready for execution are already executing. It thus does not include tasks waiting for dependencies.

int starpu_task_nsubmitted ( void  )

Return the number of submitted tasks which have not completed yet.

struct starpu_task * starpu_task_get_current ( void  )
read

This function returns the task currently executed by the worker, or NULL if it is called either from a thread that is not a task or simply because there is no task being executed at the moment.

const char * starpu_task_get_name ( struct starpu_task task)

This function returns the name of task, i.e. either its task->name field, or the name of the corresponding performance model.

const char * starpu_task_get_model_name ( struct starpu_task task)

This function returns the name of the performance model of task.

void starpu_codelet_display_stats ( struct starpu_codelet cl)

Output on stderr some statistics on the codelet cl.

int starpu_task_wait_for_no_ready ( void  )

This function waits until there is no more ready task.

void starpu_task_set_implementation ( struct starpu_task task,
unsigned  impl 
)

This function should be called by schedulers to specify the codelet implementation to be executed when executing the task.

unsigned starpu_task_get_implementation ( struct starpu_task task)

This function return the codelet implementation to be executed when executing the task.

void starpu_iteration_push ( unsigned long  iteration)

Sets the iteration number for all the tasks to be submitted after this call. This is typically called at the beginning of a task submission loop. This number will then show up in tracing tools. A corresponding starpu_iteration_pop() call must be made to match the call to starpu_iteration_push(), at the end of the same task submission loop, typically.

Nested calls to starpu_iteration_push and starpu_iteration_pop are allowed, to describe a loop nest for instance, provided that they match properly.

void starpu_iteration_pop ( void  )

Drops the iteration number for submitted tasks. This must match a previous call to starpu_iteration_push(), and is typically called at the end of a task submission loop.

void starpu_create_sync_task ( starpu_tag_t  sync_tag,
unsigned  ndeps,
starpu_tag_t deps,
void(*)(void *)  callback,
void *  callback_arg 
)

This creates (and submits) an empty task that unlocks a tag once all its dependencies are fulfilled.