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) 2013-2014 Inria
4  * Copyright (C) 2010-2018 CNRS
5  * Copyright (C) 2010-2015, 2018 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 
33 void starpu_create_sync_task(starpu_tag_t sync_tag, unsigned ndeps, starpu_tag_t *deps, void (*callback)(void *), void *callback_arg);
34 
35 /* NOTE: when adding a value here, please make sure to update both
36  * src/util/starpu_task_insert_utils.c (in two places) and
37  * mpi/src/starpu_mpi_task_insert.c */
38 #define STARPU_MODE_SHIFT 17
39 #define STARPU_VALUE (1<<STARPU_MODE_SHIFT)
40 #define STARPU_CALLBACK (2<<STARPU_MODE_SHIFT)
41 #define STARPU_CALLBACK_WITH_ARG (3<<STARPU_MODE_SHIFT)
42 #define STARPU_CALLBACK_ARG (4<<STARPU_MODE_SHIFT)
43 #define STARPU_PRIORITY (5<<STARPU_MODE_SHIFT)
44 #define STARPU_EXECUTE_ON_NODE (6<<STARPU_MODE_SHIFT)
45 #define STARPU_EXECUTE_ON_DATA (7<<STARPU_MODE_SHIFT)
46 #define STARPU_DATA_ARRAY (8<<STARPU_MODE_SHIFT)
47 #define STARPU_DATA_MODE_ARRAY (9<<STARPU_MODE_SHIFT)
48 #define STARPU_TAG (10<<STARPU_MODE_SHIFT)
49 #define STARPU_HYPERVISOR_TAG (11<<STARPU_MODE_SHIFT)
50 #define STARPU_FLOPS (12<<STARPU_MODE_SHIFT)
51 #define STARPU_SCHED_CTX (13<<STARPU_MODE_SHIFT)
52 #define STARPU_PROLOGUE_CALLBACK (14<<STARPU_MODE_SHIFT)
53 #define STARPU_PROLOGUE_CALLBACK_ARG (15<<STARPU_MODE_SHIFT)
54 #define STARPU_PROLOGUE_CALLBACK_POP (16<<STARPU_MODE_SHIFT)
55 #define STARPU_PROLOGUE_CALLBACK_POP_ARG (17<<STARPU_MODE_SHIFT)
56 #define STARPU_EXECUTE_ON_WORKER (18<<STARPU_MODE_SHIFT)
57 #define STARPU_TAG_ONLY (19<<STARPU_MODE_SHIFT)
58 #define STARPU_POSSIBLY_PARALLEL (20<<STARPU_MODE_SHIFT)
59 #define STARPU_WORKER_ORDER (21<<STARPU_MODE_SHIFT)
60 #define STARPU_NODE_SELECTION_POLICY (22<<STARPU_MODE_SHIFT)
61 #define STARPU_NAME (23<<STARPU_MODE_SHIFT)
62 #define STARPU_CL_ARGS (24<<STARPU_MODE_SHIFT)
63 #define STARPU_TASK_COLOR (25<<STARPU_MODE_SHIFT)
64 #define STARPU_SHIFTED_MODE_MAX (26<<STARPU_MODE_SHIFT)
65 
66 struct starpu_task *starpu_task_build(struct starpu_codelet *cl, ...);
67 int starpu_task_insert(struct starpu_codelet *cl, ...);
68 /* the function starpu_insert_task has the same semantics as starpu_task_insert, it is kept to avoid breaking old codes */
69 int starpu_insert_task(struct starpu_codelet *cl, ...);
70 
71 void starpu_task_insert_data_make_room(struct starpu_codelet *cl, struct starpu_task *task, int *allocated_buffers, int current_buffer, int room);
72 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);
73 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);
74 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);
75 
76 void starpu_codelet_pack_args(void **arg_buffer, size_t *arg_buffer_size, ...);
77 
79 {
80  char *arg_buffer;
81  size_t arg_buffer_size;
82  size_t current_offset;
83  int nargs;
84 };
85 
87 void starpu_codelet_pack_arg(struct starpu_codelet_pack_arg_data *state, const void *ptr, size_t ptr_size);
88 void starpu_codelet_pack_arg_fini(struct starpu_codelet_pack_arg_data *state, void **cl_arg, size_t *cl_arg_size);
89 
90 void starpu_codelet_unpack_args(void *cl_arg, ...);
91 void starpu_codelet_unpack_args_and_copyleft(void *cl_arg, void *buffer, size_t buffer_size, ...);
92 
93 #ifdef __cplusplus
94 }
95 #endif
96 
97 #endif /* __STARPU_TASK_UTIL_H__ */
Definition: starpu_task.h:89
struct starpu_codelet * cl
Definition: starpu_task.h:133
void starpu_codelet_pack_arg_fini(struct starpu_codelet_pack_arg_data *state, void **cl_arg, size_t *cl_arg_size)
void * callback_arg
Definition: starpu_task.h:149
struct starpu_task * starpu_task_build(struct starpu_codelet *cl,...)
int starpu_task_insert(struct starpu_codelet *cl,...)
int starpu_insert_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:129
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)
uint64_t starpu_tag_t
Definition: starpu_task.h:71
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)
Definition: starpu_task_util.h:78
starpu_data_handle_t handles[STARPU_NMAXBUFS]
Definition: starpu_task.h:137
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)
struct _starpu_data_state * starpu_data_handle_t
Definition: starpu_data.h:30
void starpu_create_sync_task(starpu_tag_t sync_tag, unsigned ndeps, starpu_tag_t *deps, void(*callback)(void *), void *callback_arg)
Definition: starpu_data.h:48