StarPU Handbook
starpu_data.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2009-2019 Université de Bordeaux
4  * Copyright (C) 2011-2013,2016,2017 Inria
5  * Copyright (C) 2010-2015,2017,2019 CNRS
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_DATA_H__
20 #define __STARPU_DATA_H__
21 
22 #include <starpu.h>
23 
24 #ifdef __cplusplus
25 extern "C"
26 {
27 #endif
28 
37 struct _starpu_data_state;
46 typedef struct _starpu_data_state* starpu_data_handle_t;
47 
57 {
59  STARPU_R=(1<<0),
60  STARPU_W=(1<<1),
62  STARPU_SCRATCH=(1<<2),
87  STARPU_REDUX=(1<<3),
88  STARPU_COMMUTE=(1<<4),
98  STARPU_SSEND=(1<<5),
116 };
117 
119 
121 void starpu_data_set_name(starpu_data_handle_t handle, const char *name);
122 
128 void starpu_data_set_coordinates_array(starpu_data_handle_t handle, int dimensions, int dims[]);
129 
135 void starpu_data_set_coordinates(starpu_data_handle_t handle, unsigned dimensions, ...);
136 
147 void starpu_data_unregister(starpu_data_handle_t handle);
148 
154 void starpu_data_unregister_no_coherency(starpu_data_handle_t handle);
155 
160 void starpu_data_unregister_submit(starpu_data_handle_t handle);
161 
168 void starpu_data_invalidate(starpu_data_handle_t handle);
169 
174 void starpu_data_invalidate_submit(starpu_data_handle_t handle);
175 
180 void starpu_data_advise_as_important(starpu_data_handle_t handle, unsigned is_important);
181 
193 #define STARPU_ACQUIRE_NO_NODE -1
194 
200 #define STARPU_ACQUIRE_NO_NODE_LOCK_ALL -2
201 
221 int starpu_data_acquire(starpu_data_handle_t handle, enum starpu_data_access_mode mode);
222 
229 int starpu_data_acquire_on_node(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode);
230 
243 int starpu_data_acquire_cb(starpu_data_handle_t handle, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg);
244 
252 int starpu_data_acquire_on_node_cb(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg);
253 
268 int starpu_data_acquire_cb_sequential_consistency(starpu_data_handle_t handle, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg, int sequential_consistency);
269 
277 int starpu_data_acquire_on_node_cb_sequential_consistency(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg, int sequential_consistency);
278 
279 int starpu_data_acquire_on_node_cb_sequential_consistency_quick(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg, int sequential_consistency, int quick);
280 
288 int starpu_data_acquire_on_node_cb_sequential_consistency_sync_jobids(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg, int sequential_consistency, int quick, long *pre_sync_jobid, long *post_sync_jobid);
289 
299 int starpu_data_acquire_try(starpu_data_handle_t handle, enum starpu_data_access_mode mode);
300 
308 int starpu_data_acquire_on_node_try(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode);
309 
310 #ifdef __GCC__
311 
320 # define STARPU_DATA_ACQUIRE_CB(handle, mode, code) do \
321  { \ \
322  void callback(void *arg) \
323  { \
324  code; \
325  starpu_data_release(handle); \
326  } \
327  starpu_data_acquire_cb(handle, mode, callback, NULL); \
328  } \
329  while(0)
330 #endif
331 
337 void starpu_data_release(starpu_data_handle_t handle);
338 
345 void starpu_data_release_on_node(starpu_data_handle_t handle, int node);
346 
354 typedef struct starpu_arbiter *starpu_arbiter_t;
355 
360 starpu_arbiter_t starpu_arbiter_create(void) STARPU_ATTRIBUTE_MALLOC;
361 
365 void starpu_data_assign_arbiter(starpu_data_handle_t handle, starpu_arbiter_t arbiter);
366 
371 void starpu_arbiter_destroy(starpu_arbiter_t arbiter);
372 
377 int starpu_data_request_allocation(starpu_data_handle_t handle, unsigned node);
378 
388 int starpu_data_fetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
389 
399 int starpu_data_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
400 
401 int starpu_data_prefetch_on_node_prio(starpu_data_handle_t handle, unsigned node, unsigned async, int prio);
402 
411 int starpu_data_idle_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
412 int starpu_data_idle_prefetch_on_node_prio(starpu_data_handle_t handle, unsigned node, unsigned async, int prio);
413 
418 unsigned starpu_data_is_on_node(starpu_data_handle_t handle, unsigned node);
419 
426 void starpu_data_wont_use(starpu_data_handle_t handle);
427 
437 void starpu_data_set_wt_mask(starpu_data_handle_t handle, uint32_t wt_mask);
438 
459 void starpu_data_set_sequential_consistency_flag(starpu_data_handle_t handle, unsigned flag);
460 
464 unsigned starpu_data_get_sequential_consistency_flag(starpu_data_handle_t handle);
465 
470 
481 
488 void starpu_data_set_ooc_flag(starpu_data_handle_t handle, unsigned flag);
493 unsigned starpu_data_get_ooc_flag(starpu_data_handle_t handle);
494 
498 void starpu_data_query_status(starpu_data_handle_t handle, int memory_node, int *is_allocated, int *is_valid, int *is_requested);
499 
500 struct starpu_codelet;
501 
508 void starpu_data_set_reduction_methods(starpu_data_handle_t handle, struct starpu_codelet *redux_cl, struct starpu_codelet *init_cl);
509 
510 struct starpu_data_interface_ops* starpu_data_get_interface_ops(starpu_data_handle_t handle);
511 
512 unsigned starpu_data_test_if_allocated_on_node(starpu_data_handle_t handle, unsigned memory_node);
513 
514 void starpu_memchunk_tidy(unsigned memory_node);
515 
522 void starpu_data_set_user_data(starpu_data_handle_t handle, void* user_data);
523 
527 void *starpu_data_get_user_data(starpu_data_handle_t handle);
528 
531 #ifdef __cplusplus
532 }
533 #endif
534 
535 #endif /* __STARPU_DATA_H__ */
void starpu_data_set_ooc_flag(starpu_data_handle_t handle, unsigned flag)
Definition: starpu_task.h:250
struct starpu_arbiter * starpu_arbiter_t
Definition: starpu_data.h:354
Definition: starpu_data.h:62
void starpu_data_advise_as_important(starpu_data_handle_t handle, unsigned is_important)
int starpu_data_acquire_on_node(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode)
Definition: starpu_data.h:59
unsigned starpu_data_get_ooc_flag(starpu_data_handle_t handle)
unsigned starpu_data_get_sequential_consistency_flag(starpu_data_handle_t handle)
int starpu_data_acquire_on_node_cb(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode, void(*callback)(void *), void *arg)
#define STARPU_ATTRIBUTE_MALLOC
Definition: starpu_util.h:114
void * starpu_data_get_user_data(starpu_data_handle_t handle)
unsigned starpu_data_get_default_sequential_consistency_flag(void)
void starpu_data_set_coordinates_array(starpu_data_handle_t handle, int dimensions, int dims[])
void starpu_data_release_on_node(starpu_data_handle_t handle, int node)
void starpu_data_invalidate(starpu_data_handle_t handle)
void starpu_data_invalidate_submit(starpu_data_handle_t handle)
int starpu_data_acquire_on_node_cb_sequential_consistency(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode, void(*callback)(void *), void *arg, int sequential_consistency)
int starpu_data_acquire_on_node_try(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode)
int starpu_data_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async)
Definition: starpu_data.h:98
void starpu_data_set_wt_mask(starpu_data_handle_t handle, uint32_t wt_mask)
void starpu_data_set_name(starpu_data_handle_t handle, const char *name)
Definition: starpu_data.h:103
void starpu_data_release(starpu_data_handle_t handle)
void starpu_data_unregister_submit(starpu_data_handle_t handle)
void starpu_data_set_sequential_consistency_flag(starpu_data_handle_t handle, unsigned flag)
Definition: starpu_data.h:60
int starpu_data_idle_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async)
int starpu_data_acquire_cb_sequential_consistency(starpu_data_handle_t handle, enum starpu_data_access_mode mode, void(*callback)(void *), void *arg, int sequential_consistency)
void starpu_data_unregister(starpu_data_handle_t handle)
void starpu_data_set_default_sequential_consistency_flag(unsigned flag)
void starpu_data_assign_arbiter(starpu_data_handle_t handle, starpu_arbiter_t arbiter)
Definition: starpu_data.h:87
void starpu_data_set_reduction_methods(starpu_data_handle_t handle, struct starpu_codelet *redux_cl, struct starpu_codelet *init_cl)
void starpu_data_wont_use(starpu_data_handle_t handle)
int starpu_data_request_allocation(starpu_data_handle_t handle, unsigned node)
Definition: starpu_data.h:58
void starpu_data_unregister_no_coherency(starpu_data_handle_t handle)
struct _starpu_data_state * starpu_data_handle_t
Definition: starpu_data.h:46
void starpu_data_set_coordinates(starpu_data_handle_t handle, unsigned dimensions,...)
starpu_arbiter_t starpu_arbiter_create(void) STARPU_ATTRIBUTE_MALLOC
Definition: starpu_data.h:61
int starpu_data_acquire_on_node_cb_sequential_consistency_sync_jobids(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode, void(*callback)(void *), void *arg, int sequential_consistency, int quick, long *pre_sync_jobid, long *post_sync_jobid)
Definition: starpu_data.h:88
char * name
Definition: starpu_data_interfaces.h:558
int starpu_data_acquire(starpu_data_handle_t handle, enum starpu_data_access_mode mode)
unsigned starpu_data_is_on_node(starpu_data_handle_t handle, unsigned node)
int starpu_data_acquire_try(starpu_data_handle_t handle, enum starpu_data_access_mode mode)
Definition: starpu_data_interfaces.h:367
void starpu_data_set_user_data(starpu_data_handle_t handle, void *user_data)
int starpu_data_acquire_cb(starpu_data_handle_t handle, enum starpu_data_access_mode mode, void(*callback)(void *), void *arg)
void starpu_data_query_status(starpu_data_handle_t handle, int memory_node, int *is_allocated, int *is_valid, int *is_requested)
starpu_data_access_mode
Definition: starpu_data.h:56
int starpu_data_fetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async)
Definition: starpu_data.h:115
void starpu_arbiter_destroy(starpu_arbiter_t arbiter)