StarPU Handbook
starpu_task_util.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2012-2014 Inria
4  * Copyright (C) 2010-2019 CNRS
5  * Copyright (C) 2010-2015,2018-2019 Université de Bordeaux
6  *
7  * StarPU is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU Lesser General Public License as published by
9  * the Free Software Foundation; either version 2.1 of the License, or (at
10  * your option) any later version.
11  *
12  * StarPU is distributed in the hope that it will be useful, but
13  * WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
15  *
16  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
17  */
18 
19 #ifndef __STARPU_TASK_UTIL_H__
20 #define __STARPU_TASK_UTIL_H__
21 
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <assert.h>
26 #include <starpu.h>
27 
28 #ifdef __cplusplus
29 extern "C"
30 {
31 #endif
32 
38 /* NOTE: when adding a value here, please make sure to update both
39  * src/util/starpu_task_insert_utils.c (in two places) and
40  * mpi/src/starpu_mpi_task_insert.c and mpi/src/starpu_mpi_task_insert_fortran.c */
41 
42 #define STARPU_MODE_SHIFT 17
43 
48 #define STARPU_VALUE (1<<STARPU_MODE_SHIFT)
49 
54 #define STARPU_CALLBACK (2<<STARPU_MODE_SHIFT)
55 
62 #define STARPU_CALLBACK_WITH_ARG (3<<STARPU_MODE_SHIFT)
63 
68 #define STARPU_CALLBACK_ARG (4<<STARPU_MODE_SHIFT)
69 
74 #define STARPU_PRIORITY (5<<STARPU_MODE_SHIFT)
75 
82 #define STARPU_EXECUTE_ON_NODE (6<<STARPU_MODE_SHIFT)
83 
90 #define STARPU_EXECUTE_ON_DATA (7<<STARPU_MODE_SHIFT)
91 #define STARPU_DATA_ARRAY (8<<STARPU_MODE_SHIFT)
92 #define STARPU_DATA_MODE_ARRAY (9<<STARPU_MODE_SHIFT)
93 
97 #define STARPU_TAG (10<<STARPU_MODE_SHIFT)
98 
99 #define STARPU_HYPERVISOR_TAG (11<<STARPU_MODE_SHIFT)
100 
107 #define STARPU_FLOPS (12<<STARPU_MODE_SHIFT)
108 
113 #define STARPU_SCHED_CTX (13<<STARPU_MODE_SHIFT)
114 
119 #define STARPU_PROLOGUE_CALLBACK (14<<STARPU_MODE_SHIFT)
120 
126 #define STARPU_PROLOGUE_CALLBACK_ARG (15<<STARPU_MODE_SHIFT)
127 
132 #define STARPU_PROLOGUE_CALLBACK_POP (16<<STARPU_MODE_SHIFT)
133 
139 #define STARPU_PROLOGUE_CALLBACK_POP_ARG (17<<STARPU_MODE_SHIFT)
140 
146 #define STARPU_EXECUTE_ON_WORKER (18<<STARPU_MODE_SHIFT)
147 
153 #define STARPU_EXECUTE_WHERE (19<<STARPU_MODE_SHIFT)
154 
159 #define STARPU_TAG_ONLY (20<<STARPU_MODE_SHIFT)
160 
161 #define STARPU_POSSIBLY_PARALLEL (21<<STARPU_MODE_SHIFT)
162 
168 #define STARPU_WORKER_ORDER (22<<STARPU_MODE_SHIFT)
169 
176 #define STARPU_NODE_SELECTION_POLICY (23<<STARPU_MODE_SHIFT)
177 
182 #define STARPU_NAME (24<<STARPU_MODE_SHIFT)
183 
191 #define STARPU_CL_ARGS (25<<STARPU_MODE_SHIFT)
192 
201 #define STARPU_CL_ARGS_NFREE (26<<STARPU_MODE_SHIFT)
202 
209 #define STARPU_TASK_DEPS_ARRAY (27<<STARPU_MODE_SHIFT)
210 
215 #define STARPU_TASK_COLOR (28<<STARPU_MODE_SHIFT)
216 
222 #define STARPU_HANDLES_SEQUENTIAL_CONSISTENCY (29<<STARPU_MODE_SHIFT)
223 
228 #define STARPU_TASK_SYNCHRONOUS (30<<STARPU_MODE_SHIFT)
229 
236 #define STARPU_TASK_END_DEPS_ARRAY (31<<STARPU_MODE_SHIFT)
237 
242 #define STARPU_TASK_END_DEP (32<<STARPU_MODE_SHIFT)
243 
250 #define STARPU_TASK_WORKERIDS (33<<STARPU_MODE_SHIFT)
251 
257 #define STARPU_SEQUENTIAL_CONSISTENCY (34<<STARPU_MODE_SHIFT)
258 
263 #define STARPU_TASK_PROFILING_INFO (35<<STARPU_MODE_SHIFT)
264 
269 #define STARPU_TASK_NO_SUBMITORDER (36<<STARPU_MODE_SHIFT)
270 
277 #define STARPU_CALLBACK_ARG_NFREE (37<<STARPU_MODE_SHIFT)
278 
286 #define STARPU_CALLBACK_WITH_ARG_NFREE (38<<STARPU_MODE_SHIFT)
287 
295 #define STARPU_PROLOGUE_CALLBACK_ARG_NFREE (39<<STARPU_MODE_SHIFT)
296 
304 #define STARPU_PROLOGUE_CALLBACK_POP_ARG_NFREE (40<<STARPU_MODE_SHIFT)
305 
311 #define STARPU_TASK_SCHED_DATA (41<<STARPU_MODE_SHIFT)
312 
313 #define STARPU_SHIFTED_MODE_MAX (42<<STARPU_MODE_SHIFT)
314 
323 int starpu_task_set(struct starpu_task *task, struct starpu_codelet *cl, ...);
324 
333 struct starpu_task *starpu_task_build(struct starpu_codelet *cl, ...);
334 
371 int starpu_task_insert(struct starpu_codelet *cl, ...);
372 
376 int starpu_insert_task(struct starpu_codelet *cl, ...);
377 
390 void starpu_task_insert_data_make_room(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int current_buffer, int room);
391 
397 void starpu_task_insert_data_process_arg(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int *current_buffer, int arg_type, starpu_data_handle_t handle);
398 
403 void starpu_task_insert_data_process_array_arg(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int *current_buffer, int nb_handles, starpu_data_handle_t *handles);
404 
410 void starpu_task_insert_data_process_mode_array_arg(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int *current_buffer, int nb_descrs, struct starpu_data_descr *descrs);
411 
421 void starpu_codelet_pack_args(void **arg_buffer, size_t *arg_buffer_size, ...);
422 
424 {
425  char *arg_buffer;
426  size_t arg_buffer_size;
427  size_t current_offset;
428  int nargs;
429 };
430 
437 
446 void starpu_codelet_pack_arg(struct starpu_codelet_pack_arg_data *state, const void *ptr, size_t ptr_size);
447 
452 void starpu_codelet_pack_arg_fini(struct starpu_codelet_pack_arg_data *state, void **cl_arg, size_t *cl_arg_size);
453 
460 void starpu_codelet_unpack_args(void *cl_arg, ...);
461 
468 void starpu_codelet_unpack_args_and_copyleft(void *cl_arg, void *buffer, size_t buffer_size, ...);
469 
472 #ifdef __cplusplus
473 }
474 #endif
475 
476 #endif /* __STARPU_TASK_UTIL_H__ */
Definition: starpu_task.h:250
struct starpu_task * starpu_task_build(struct starpu_codelet *cl,...)
void starpu_codelet_pack_arg_fini(struct starpu_codelet_pack_arg_data *state, void **cl_arg, size_t *cl_arg_size)
Definition: starpu_task_util.h:423
int starpu_task_insert(struct starpu_codelet *cl,...)
int starpu_insert_task(struct starpu_codelet *cl,...)
int starpu_task_set(struct starpu_task *task, struct starpu_codelet *cl,...)
void starpu_codelet_unpack_args_and_copyleft(void *cl_arg, void *buffer, size_t buffer_size,...)
Definition: starpu_task.h:548
void starpu_codelet_pack_arg_init(struct starpu_codelet_pack_arg_data *state)
void starpu_codelet_unpack_args(void *cl_arg,...)
void starpu_codelet_pack_args(void **arg_buffer, size_t *arg_buffer_size,...)
void starpu_task_insert_data_make_room(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int current_buffer, int room)
void starpu_codelet_pack_arg(struct starpu_codelet_pack_arg_data *state, const void *ptr, size_t ptr_size)
void starpu_task_insert_data_process_array_arg(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int *current_buffer, int nb_handles, starpu_data_handle_t *handles)
struct _starpu_data_state * starpu_data_handle_t
Definition: starpu_data.h:46
starpu_data_handle_t handles[STARPU_NMAXBUFS]
Definition: starpu_task.h:643
void starpu_task_insert_data_process_mode_array_arg(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int *current_buffer, int nb_descrs, struct starpu_data_descr *descrs)
void starpu_task_insert_data_process_arg(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int *current_buffer, int arg_type, starpu_data_handle_t handle)
Definition: starpu_task.h:533
struct starpu_codelet * cl
Definition: starpu_task.h:566