StarPU Handbook
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
starpu_task.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2010-2014 Université de Bordeaux
4  * Copyright (C) 2010, 2011, 2012, 2013, 2014 Centre National de la Recherche Scientifique
5  * Copyright (C) 2011 Télécom-SudParis
6  * Copyright (C) 2011, 2014 INRIA
7  *
8  * StarPU is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU Lesser General Public License as published by
10  * the Free Software Foundation; either version 2.1 of the License, or (at
11  * your option) any later version.
12  *
13  * StarPU is distributed in the hope that it will be useful, but
14  * WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
16  *
17  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
18  */
19 
20 #ifndef __STARPU_TASK_H__
21 #define __STARPU_TASK_H__
22 
23 #include <starpu.h>
24 #include <starpu_data.h>
25 #include <starpu_util.h>
26 #include <starpu_task_bundle.h>
27 #include <errno.h>
28 
29 #if defined STARPU_USE_CUDA && !defined STARPU_DONT_INCLUDE_CUDA_HEADERS
30 # include <cuda.h>
31 #endif
32 
33 #ifdef __cplusplus
34 extern "C"
35 {
36 #endif
37 
38 #define STARPU_CPU ((1ULL)<<1)
39 #define STARPU_CUDA ((1ULL)<<3)
40 #define STARPU_OPENCL ((1ULL)<<6)
41 #define STARPU_MIC ((1ULL)<<7)
42 #define STARPU_SCC ((1ULL)<<8)
43 
44 #define STARPU_CUDA_ASYNC (1<<0)
45 #define STARPU_OPENCL_ASYNC (1<<0)
46 
48 {
52 };
53 
55 {
57 #define STARPU_TASK_INVALID 0
65  STARPU_TASK_STOPPED
66 };
67 
68 typedef uint64_t starpu_tag_t;
69 
70 typedef void (*starpu_cpu_func_t)(void **, void*);
71 typedef void (*starpu_cuda_func_t)(void **, void*);
72 typedef void (*starpu_opencl_func_t)(void **, void*);
73 typedef void (*starpu_mic_kernel_t)(void **, void*);
74 typedef void (*starpu_scc_kernel_t)(void **, void*);
75 
78 
79 #define STARPU_MULTIPLE_CPU_IMPLEMENTATIONS ((starpu_cpu_func_t) -1)
80 #define STARPU_MULTIPLE_CUDA_IMPLEMENTATIONS ((starpu_cuda_func_t) -1)
81 #define STARPU_MULTIPLE_OPENCL_IMPLEMENTATIONS ((starpu_opencl_func_t) -1)
82 
83 #define STARPU_VARIABLE_NBUFFERS (-1)
84 
85 struct starpu_task;
87 {
88  uint32_t where;
89  int (*can_execute)(unsigned workerid, struct starpu_task *task, unsigned nimpl);
92 
93  starpu_cpu_func_t cpu_func STARPU_DEPRECATED;
94  starpu_cuda_func_t cuda_func STARPU_DEPRECATED;
95  starpu_opencl_func_t opencl_func STARPU_DEPRECATED;
96 
97  starpu_cpu_func_t cpu_funcs[STARPU_MAXIMPLEMENTATIONS];
98  starpu_cuda_func_t cuda_funcs[STARPU_MAXIMPLEMENTATIONS];
99  char cuda_flags[STARPU_MAXIMPLEMENTATIONS];
100  starpu_opencl_func_t opencl_funcs[STARPU_MAXIMPLEMENTATIONS];
101  char opencl_flags[STARPU_MAXIMPLEMENTATIONS];
102  starpu_mic_func_t mic_funcs[STARPU_MAXIMPLEMENTATIONS];
103  starpu_scc_func_t scc_funcs[STARPU_MAXIMPLEMENTATIONS];
104 
105  char *cpu_funcs_name[STARPU_MAXIMPLEMENTATIONS];
106 
107  int nbuffers;
110 
111  unsigned specific_nodes;
113  int *dyn_nodes;
114 
117 
119 
120  const char *name;
121 };
122 
124 {
125  const char *name;
126 
128 
129  int nbuffers;
130 
134 
138 
139  void *cl_arg;
140  size_t cl_arg_size;
141 
142  void (*callback_func)(void *);
144  /* must StarPU release callback_arg ? - 0 by default */
145 
146  void (*prologue_callback_func)(void *);
148 
149  void (*prologue_callback_pop_func)(void *);
150  void *prologue_callback_pop_arg;
151 
152  starpu_tag_t tag_id;
153 
154  unsigned cl_arg_free:1;
155  unsigned callback_arg_free:1;
156  /* must StarPU release prologue_callback_arg ? - 0 by default */
158  /* must StarPU release prologue_callback_pop_arg ? - 0 by default */
159  unsigned prologue_callback_pop_arg_free:1;
160 
161  unsigned use_tag:1;
163  unsigned synchronous:1;
165 
166  unsigned detach:1;
167  unsigned destroy:1;
168  unsigned regenerate:1;
169 
170  unsigned workerid;
171  unsigned workerorder;
172 
173  unsigned scheduled:1;
174 
175  unsigned int mf_skip:1;
176 
177  int priority;
178 
180 
181  int magic;
182 
183  unsigned sched_ctx;
185  unsigned possibly_parallel;
186 
188 
190 
191  double flops;
192  double predicted;
194 
195  struct starpu_task *prev;
196  struct starpu_task *next;
198  unsigned prefetched;
199 #ifdef STARPU_OPENMP
200  struct starpu_omp_task *omp_task;
201 #else
202  void *omp_task;
203 #endif
204 };
205 
206 #define STARPU_TASK_INITIALIZER \
207 { \
208  .cl = NULL, \
209  .cl_arg = NULL, \
210  .cl_arg_size = 0, \
211  .callback_func = NULL, \
212  .callback_arg = NULL, \
213  .priority = STARPU_DEFAULT_PRIO, \
214  .use_tag = 0, \
215  .synchronous = 0, \
216  .execute_on_a_specific_worker = 0, \
217  .workerorder = 0, \
218  .bundle = NULL, \
219  .detach = 1, \
220  .destroy = 0, \
221  .regenerate = 0, \
222  .status = STARPU_TASK_INVALID, \
223  .profiling_info = NULL, \
224  .predicted = -1.0, \
225  .predicted_transfer = -1.0, \
226  .starpu_private = NULL, \
227  .magic = 42, \
228  .sched_ctx = 0, \
229  .hypervisor_tag = 0, \
230  .flops = 0.0, \
231  .scheduled = 0, \
232  .prefetched = 0, \
233  .dyn_handles = NULL, \
234  .dyn_interfaces = NULL, \
235  .dyn_modes = NULL, \
236  .name = NULL, \
237  .possibly_parallel = 0 \
238 }
239 
240 #define STARPU_TASK_GET_NBUFFERS(task) ((unsigned)((task)->cl->nbuffers == STARPU_VARIABLE_NBUFFERS ? ((task)->nbuffers) : ((task)->cl->nbuffers)))
241 
242 #define STARPU_TASK_GET_HANDLE(task, i) (((task)->dyn_handles) ? (task)->dyn_handles[i] : (task)->handles[i])
243 #define STARPU_TASK_SET_HANDLE(task, handle, i) do { if ((task)->dyn_handles) (task)->dyn_handles[i] = handle; else (task)->handles[i] = handle; } while(0)
244 
245 #define STARPU_CODELET_GET_MODE(codelet, i) (((codelet)->dyn_modes) ? (codelet)->dyn_modes[i] : (codelet)->modes[i])
246 #define STARPU_CODELET_SET_MODE(codelet, mode, i) do { if ((codelet)->dyn_modes) (codelet)->dyn_modes[i] = mode; else (codelet)->modes[i] = mode; } while(0)
247 
248 #define STARPU_TASK_GET_MODE(task, i) ((task)->cl->nbuffers == STARPU_VARIABLE_NBUFFERS || (task)->dyn_modes ? \
249  (((task)->dyn_modes) ? (task)->dyn_modes[i] : (task)->modes[i]) : \
250  STARPU_CODELET_GET_MODE((task)->cl, i) )
251 #define STARPU_TASK_SET_MODE(task, mode, i) do { \
252  if ((task)->cl->nbuffers == STARPU_VARIABLE_NBUFFERS) \
253  if ((task)->dyn_modes) (task)->dyn_modes[i] = mode; else (task)->modes[i] = mode; \
254  else \
255  STARPU_CODELET_SET_MODE((task)->cl, mode, i); \
256  } while(0)
257 
258 #define STARPU_CODELET_GET_NODE(codelet, i) (((codelet)->dyn_nodes) ? (codelet)->dyn_nodes[i] : (codelet)->nodes[i])
259 #define STARPU_CODELET_SET_NODE(codelet, __node, i) do { if ((codelet)->dyn_nodes) (codelet)->dyn_nodes[i] = __node; else (codelet)->nodes[i] = __node; } while(0)
260 
261 void starpu_tag_declare_deps(starpu_tag_t id, unsigned ndeps, ...);
262 void starpu_tag_declare_deps_array(starpu_tag_t id, unsigned ndeps, starpu_tag_t *array);
263 
264 void starpu_task_declare_deps_array(struct starpu_task *task, unsigned ndeps, struct starpu_task *task_array[]);
265 
266 int starpu_tag_wait(starpu_tag_t id);
267 int starpu_tag_wait_array(unsigned ntags, starpu_tag_t *id);
268 
269 void starpu_tag_notify_from_apps(starpu_tag_t id);
270 
271 void starpu_tag_restart(starpu_tag_t id);
272 
273 void starpu_tag_remove(starpu_tag_t id);
274 
275 void starpu_task_init(struct starpu_task *task);
276 void starpu_task_clean(struct starpu_task *task);
277 
278 struct starpu_task *starpu_task_create(void);
279 
280 void starpu_task_destroy(struct starpu_task *task);
282 int starpu_task_submit_to_ctx(struct starpu_task *task, unsigned sched_ctx_id);
283 
284 int starpu_task_finished(struct starpu_task *task) STARPU_WARN_UNUSED_RESULT;
285 
287 
288 int starpu_task_wait_for_all(void);
289 
290 int starpu_task_wait_for_all_in_ctx(unsigned sched_ctx_id);
291 
293 
294 int starpu_task_nready(void);
295 int starpu_task_nsubmitted(void);
296 
298 
300 
302 
304 void starpu_parallel_task_barrier_init_n(struct starpu_task *task, int worker_size);
305 
306 struct starpu_task *starpu_task_dup(struct starpu_task *task);
307 
308 void starpu_task_set_implementation(struct starpu_task *task, unsigned impl);
309 unsigned starpu_task_get_implementation(struct starpu_task *task);
310 
311 #ifdef __cplusplus
312 }
313 #endif
314 
315 #endif /* __STARPU_TASK_H__ */
Definition: starpu_task.h:62
unsigned use_tag
Definition: starpu_task.h:161
enum starpu_task_status status
Definition: starpu_task.h:179
void * prologue_callback_arg
Definition: starpu_task.h:147
starpu_opencl_func_t opencl_func
Definition: starpu_task.h:95
char cuda_flags[STARPU_MAXIMPLEMENTATIONS]
Definition: starpu_task.h:99
Definition: starpu_task.h:86
starpu_opencl_func_t opencl_funcs[STARPU_MAXIMPLEMENTATIONS]
Definition: starpu_task.h:100
starpu_scc_func_t scc_funcs[STARPU_MAXIMPLEMENTATIONS]
Definition: starpu_task.h:103
Definition: starpu_profiling.h:34
enum starpu_data_access_mode modes[STARPU_NMAXBUFS]
Definition: starpu_task.h:108
int nbuffers
Definition: starpu_task.h:129
void(* starpu_mic_kernel_t)(void **, void *)
Definition: starpu_task.h:73
unsigned regenerate
Definition: starpu_task.h:168
int max_parallelism
Definition: starpu_task.h:91
starpu_mic_kernel_t(* starpu_mic_func_t)(void)
Definition: starpu_task.h:76
void ** dyn_interfaces
Definition: starpu_task.h:136
int starpu_task_submit_to_ctx(struct starpu_task *task, unsigned sched_ctx_id)
struct starpu_profiling_task_info * profiling_info
Definition: starpu_task.h:189
enum starpu_data_access_mode * dyn_modes
Definition: starpu_task.h:137
unsigned execute_on_a_specific_worker
Definition: starpu_task.h:164
int * dyn_nodes
Definition: starpu_task.h:113
int starpu_task_nready(void)
#define STARPU_TASK_INVALID
Definition: starpu_task.h:57
struct starpu_task * starpu_task_create(void)
struct starpu_codelet * cl
Definition: starpu_task.h:127
void starpu_tag_declare_deps(starpu_tag_t id, unsigned ndeps,...)
double predicted
Definition: starpu_task.h:192
starpu_mic_func_t mic_funcs[STARPU_MAXIMPLEMENTATIONS]
Definition: starpu_task.h:102
struct starpu_perfmodel * model
Definition: starpu_task.h:115
struct starpu_task * prev
Definition: starpu_task.h:195
Definition: starpu_task.h:58
int priority
Definition: starpu_task.h:177
void(* starpu_scc_kernel_t)(void **, void *)
Definition: starpu_task.h:74
void * callback_arg
Definition: starpu_task.h:143
int starpu_task_submit(struct starpu_task *task) STARPU_WARN_UNUSED_RESULT
char opencl_flags[STARPU_MAXIMPLEMENTATIONS]
Definition: starpu_task.h:101
int starpu_task_nsubmitted(void)
unsigned sequential_consistency
Definition: starpu_task.h:162
unsigned workerid
Definition: starpu_task.h:170
void starpu_tag_restart(starpu_tag_t id)
Definition: starpu_task.h:51
Definition: starpu_task.h:50
size_t cl_arg_size
Definition: starpu_task.h:140
unsigned detach
Definition: starpu_task.h:166
int nodes[STARPU_NMAXBUFS]
Definition: starpu_task.h:112
int magic
Definition: starpu_task.h:181
void starpu_task_clean(struct starpu_task *task)
unsigned sched_ctx
Definition: starpu_task.h:183
void starpu_task_destroy(struct starpu_task *task)
void(* starpu_cuda_func_t)(void **, void *)
Definition: starpu_task.h:71
int starpu_task_wait_for_all(void)
starpu_cpu_func_t cpu_func
Definition: starpu_task.h:93
unsigned specific_nodes
Definition: starpu_task.h:111
uint32_t where
Definition: starpu_task.h:88
enum starpu_data_access_mode modes[STARPU_NMAXBUFS]
Definition: starpu_task.h:133
Definition: starpu_task.h:49
const char * name
Definition: starpu_task.h:120
Definition: starpu_task.h:59
enum starpu_codelet_type type
Definition: starpu_task.h:90
starpu_cuda_func_t cuda_funcs[STARPU_MAXIMPLEMENTATIONS]
Definition: starpu_task.h:98
void * cl_arg
Definition: starpu_task.h:139
struct _starpu_task_bundle * starpu_task_bundle_t
Definition: starpu_task_bundle.h:29
starpu_data_handle_t * dyn_handles
Definition: starpu_task.h:135
void starpu_parallel_task_barrier_init(struct starpu_task *task, int workerid)
int starpu_task_wait_for_all_in_ctx(unsigned sched_ctx_id)
void * interfaces[STARPU_NMAXBUFS]
Definition: starpu_task.h:132
Definition: starpu_task.h:123
int(* can_execute)(unsigned workerid, struct starpu_task *task, unsigned nimpl)
Definition: starpu_task.h:89
starpu_task_status
Definition: starpu_task.h:54
starpu_scc_kernel_t(* starpu_scc_func_t)(void)
Definition: starpu_task.h:77
starpu_tag_t tag_id
Definition: starpu_task.h:152
unsigned synchronous
Definition: starpu_task.h:163
void starpu_task_set_implementation(struct starpu_task *task, unsigned impl)
int starpu_tag_wait(starpu_tag_t id)
unsigned starpu_task_get_implementation(struct starpu_task *task)
void starpu_tag_remove(starpu_tag_t id)
struct starpu_task * next
Definition: starpu_task.h:196
uint64_t starpu_tag_t
Definition: starpu_task.h:68
int starpu_task_wait(struct starpu_task *task) STARPU_WARN_UNUSED_RESULT
void(* starpu_cpu_func_t)(void **, void *)
Definition: starpu_task.h:70
#define STARPU_NMAXWORKERS
Definition: starpu_config.h:90
void(* prologue_callback_func)(void *)
Definition: starpu_task.h:146
void starpu_parallel_task_barrier_init_n(struct starpu_task *task, int worker_size)
void starpu_task_init(struct starpu_task *task)
double predicted_transfer
Definition: starpu_task.h:193
char * cpu_funcs_name[STARPU_MAXIMPLEMENTATIONS]
Definition: starpu_task.h:105
unsigned cl_arg_free
Definition: starpu_task.h:154
void starpu_codelet_init(struct starpu_codelet *cl)
struct starpu_task * starpu_task_get_current(void)
starpu_data_handle_t handles[STARPU_NMAXBUFS]
Definition: starpu_task.h:131
Definition: starpu_perfmodel.h:125
unsigned long per_worker_stats[STARPU_NMAXWORKERS]
Definition: starpu_task.h:118
int starpu_tag_wait_array(unsigned ntags, starpu_tag_t *id)
int nbuffers
Definition: starpu_task.h:107
struct starpu_task * starpu_task_dup(struct starpu_task *task)
Definition: starpu_task.h:61
unsigned int mf_skip
Definition: starpu_task.h:175
void starpu_task_declare_deps_array(struct starpu_task *task, unsigned ndeps, struct starpu_task *task_array[])
void starpu_tag_declare_deps_array(starpu_tag_t id, unsigned ndeps, starpu_tag_t *array)
#define STARPU_WARN_UNUSED_RESULT
Definition: starpu_util.h:79
starpu_data_access_mode
Definition: starpu_data.h:31
double flops
Definition: starpu_task.h:191
struct starpu_perfmodel * power_model
Definition: starpu_task.h:116
Definition: starpu_task.h:63
struct _starpu_data_state * starpu_data_handle_t
Definition: starpu_data.h:29
unsigned destroy
Definition: starpu_task.h:167
void starpu_codelet_display_stats(struct starpu_codelet *cl)
starpu_task_bundle_t bundle
Definition: starpu_task.h:187
unsigned callback_arg_free
Definition: starpu_task.h:155
void(* starpu_opencl_func_t)(void **, void *)
Definition: starpu_task.h:72
starpu_codelet_type
Definition: starpu_task.h:47
void starpu_tag_notify_from_apps(starpu_tag_t id)
#define STARPU_NMAXBUFS
Definition: starpu_config.h:84
Definition: starpu_task.h:60
Definition: starpu_task.h:64
starpu_cuda_func_t cuda_func
Definition: starpu_task.h:94
unsigned workerorder
Definition: starpu_task.h:171
const char * name
Definition: starpu_task.h:125
unsigned prologue_callback_arg_free
Definition: starpu_task.h:157
starpu_cpu_func_t cpu_funcs[STARPU_MAXIMPLEMENTATIONS]
Definition: starpu_task.h:97
enum starpu_data_access_mode * dyn_modes
Definition: starpu_task.h:109
void(* callback_func)(void *)
Definition: starpu_task.h:142
void * starpu_private
Definition: starpu_task.h:197
unsigned scheduled
Definition: starpu_task.h:173
int hypervisor_tag
Definition: starpu_task.h:184
int starpu_task_wait_for_no_ready(void)