StarPU Handbook - StarPU Extensions
starpu_data.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2009-2023 Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
4  * Copyright (C) 2021 Federal University of Rio Grande do Sul (UFRGS)
5  *
6  * StarPU is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as published by
8  * the Free Software Foundation; either version 2.1 of the License, or (at
9  * your option) any later version.
10  *
11  * StarPU is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14  *
15  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
16  */
17 
18 #ifndef __STARPU_DATA_H__
19 #define __STARPU_DATA_H__
20 
21 #include <starpu.h>
22 
23 #ifdef __cplusplus
24 extern "C" {
25 #endif
26 
35 struct _starpu_data_state;
44 typedef struct _starpu_data_state *starpu_data_handle_t;
45 
55 {
57  STARPU_R = (1 << 0),
58  STARPU_W = (1 << 1),
60  STARPU_SCRATCH = (1 << 2),
87  STARPU_REDUX = (1 << 3),
101  STARPU_COMMUTE = (1 << 4),
113  STARPU_SSEND = (1 << 5),
118  STARPU_LOCALITY = (1 << 6),
132  STARPU_MPI_REDUX = (1 << 7),
143  STARPU_NOPLAN = (1 << 8),
146  STARPU_UNMAP = (1 << 9),
148  STARPU_NOFOOTPRINT = (1 << 10),
150  STARPU_ACCESS_MODE_MAX = (1 << 11)
152 };
153 
155 
161 
167 void starpu_data_set_coordinates_array(starpu_data_handle_t handle, unsigned dimensions, int dims[]);
168 
174 void starpu_data_set_coordinates(starpu_data_handle_t handle, unsigned dimensions, ...);
175 
183 unsigned starpu_data_get_coordinates_array(starpu_data_handle_t handle, unsigned dimensions, int dims[]);
184 
197 
204 
216 
224 
230 
235 void starpu_data_advise_as_important(starpu_data_handle_t handle, unsigned is_important);
236 
248 #define STARPU_ACQUIRE_NO_NODE -1
249 
255 #define STARPU_ACQUIRE_NO_NODE_LOCK_ALL -2
256 
277 
285 
298 int starpu_data_acquire_cb(starpu_data_handle_t handle, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg);
299 
307 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);
308 
323 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);
324 
332 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);
333 
347 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_acquired)(void *arg, int *node, enum starpu_data_access_mode mode), void (*callback)(void *arg), void *arg, int sequential_consistency, int quick, long *pre_sync_jobid, long *post_sync_jobid, int prio);
348 
359 
368 
369 #ifdef __GCC__
370 
379 #define STARPU_DATA_ACQUIRE_CB(handle, mode, code) \
380  do \
381  { \
382  void callback(void *arg) \
383  { \
384  code; \
385  starpu_data_release(handle); \
386  } \
387  starpu_data_acquire_cb(handle, mode, callback, NULL); \
388  } \
389  while (0)
390 #endif
391 
398 
406 
416 
424 
432 typedef struct starpu_arbiter *starpu_arbiter_t;
433 
439 
445 
452 
458 
467 {
476  STARPU_NFETCH
477 };
478 
488 int starpu_data_fetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
489 
499 int starpu_data_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
500 
504 int starpu_data_prefetch_on_node_prio(starpu_data_handle_t handle, unsigned node, unsigned async, int prio);
505 
514 int starpu_data_idle_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
515 
519 int starpu_data_idle_prefetch_on_node_prio(starpu_data_handle_t handle, unsigned node, unsigned async, int prio);
520 
525 unsigned starpu_data_is_on_node(starpu_data_handle_t handle, unsigned node);
526 
534 
545 
555 void starpu_data_set_wt_mask(starpu_data_handle_t handle, uint32_t wt_mask);
556 
579 
584 
589 
600 
607 void starpu_data_set_ooc_flag(starpu_data_handle_t handle, unsigned flag);
613 
624 void starpu_data_query_status2(starpu_data_handle_t handle, int memory_node, int *is_allocated, int *is_valid, int *is_loading, int *is_requested);
625 
629 void starpu_data_query_status(starpu_data_handle_t handle, int memory_node, int *is_allocated, int *is_valid, int *is_requested);
630 
631 struct starpu_codelet;
632 
643 
648 void starpu_data_set_reduction_methods_with_args(starpu_data_handle_t handle, struct starpu_codelet *redux_cl, void *redux_cl_arg, struct starpu_codelet *init_cl, void *init_cl_arg);
649 
650 struct starpu_data_interface_ops *starpu_data_get_interface_ops(starpu_data_handle_t handle);
651 
655 unsigned starpu_data_test_if_allocated_on_node(starpu_data_handle_t handle, unsigned memory_node);
656 
660 unsigned starpu_data_test_if_mapped_on_node(starpu_data_handle_t handle, unsigned memory_node);
661 
665 void starpu_memchunk_tidy(unsigned memory_node);
666 
674 void starpu_data_set_user_data(starpu_data_handle_t handle, void *user_data);
675 
681 
688 void starpu_data_set_sched_data(starpu_data_handle_t handle, void *sched_data);
689 
695 
699 int starpu_data_can_evict(starpu_data_handle_t handle, unsigned node, enum starpu_is_prefetch is_prefetch);
700 
703 #ifdef __cplusplus
704 }
705 #endif
706 
707 #endif /* __STARPU_DATA_H__ */
Definition: starpu_task.h:317
char * name
Definition: starpu_data_interfaces.h:686
Definition: starpu_data_interfaces.h:372
void starpu_data_set_user_data(starpu_data_handle_t handle, void *user_data)
void starpu_data_invalidate_submit(starpu_data_handle_t handle)
void starpu_data_set_default_sequential_consistency_flag(unsigned flag)
void starpu_data_set_reduction_methods(starpu_data_handle_t handle, struct starpu_codelet *redux_cl, struct starpu_codelet *init_cl)
starpu_data_access_mode
Definition: starpu_data.h:55
void starpu_data_set_sequential_consistency_flag(starpu_data_handle_t handle, unsigned flag)
unsigned starpu_data_test_if_allocated_on_node(starpu_data_handle_t handle, unsigned memory_node)
void starpu_arbiter_destroy(starpu_arbiter_t arbiter)
int starpu_data_acquire_cb(starpu_data_handle_t handle, enum starpu_data_access_mode mode, void(*callback)(void *), void *arg)
int starpu_data_acquire_on_node(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode)
void starpu_data_invalidate(starpu_data_handle_t handle)
void starpu_data_unregister_submit(starpu_data_handle_t handle)
void * starpu_data_get_sched_data(starpu_data_handle_t handle)
int starpu_data_idle_prefetch_on_node_prio(starpu_data_handle_t handle, unsigned node, unsigned async, int prio)
int starpu_data_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async)
void starpu_data_unregister(starpu_data_handle_t handle)
void starpu_data_release_on_node(starpu_data_handle_t handle, int node)
void starpu_data_set_sched_data(starpu_data_handle_t handle, void *sched_data)
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_acquired)(void *arg, int *node, enum starpu_data_access_mode mode), void(*callback)(void *arg), void *arg, int sequential_consistency, int quick, long *pre_sync_jobid, long *post_sync_jobid, int prio)
void starpu_data_query_status2(starpu_data_handle_t handle, int memory_node, int *is_allocated, int *is_valid, int *is_loading, int *is_requested)
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)
int starpu_data_acquire_on_node_try(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode)
void starpu_data_release_to(starpu_data_handle_t handle, enum starpu_data_access_mode down_to_mode)
starpu_is_prefetch
Definition: starpu_data.h:467
unsigned starpu_data_get_ooc_flag(starpu_data_handle_t handle)
starpu_arbiter_t starpu_arbiter_create(void) STARPU_ATTRIBUTE_MALLOC
unsigned starpu_data_get_coordinates_array(starpu_data_handle_t handle, unsigned dimensions, int dims[])
void starpu_data_set_ooc_flag(starpu_data_handle_t handle, unsigned flag)
unsigned starpu_data_is_on_node(starpu_data_handle_t handle, unsigned node)
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)
void starpu_data_release_to_on_node(starpu_data_handle_t handle, enum starpu_data_access_mode down_to_mode, int node)
int starpu_data_acquire_try(starpu_data_handle_t handle, enum starpu_data_access_mode mode)
void starpu_data_query_status(starpu_data_handle_t handle, int memory_node, int *is_allocated, int *is_valid, int *is_requested)
void starpu_data_assign_arbiter(starpu_data_handle_t handle, starpu_arbiter_t arbiter)
int starpu_data_fetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async)
void starpu_data_set_coordinates_array(starpu_data_handle_t handle, unsigned dimensions, int dims[])
void starpu_data_unregister_no_coherency(starpu_data_handle_t handle)
void starpu_data_set_name(starpu_data_handle_t handle, const char *name)
int starpu_data_evict_from_node(starpu_data_handle_t handle, unsigned node)
void starpu_data_set_coordinates(starpu_data_handle_t handle, unsigned dimensions,...)
void starpu_data_set_reduction_methods_with_args(starpu_data_handle_t handle, struct starpu_codelet *redux_cl, void *redux_cl_arg, struct starpu_codelet *init_cl, void *init_cl_arg)
struct starpu_arbiter * starpu_arbiter_t
Definition: starpu_data.h:432
int starpu_data_request_allocation(starpu_data_handle_t handle, unsigned node)
unsigned starpu_data_test_if_mapped_on_node(starpu_data_handle_t handle, unsigned memory_node)
unsigned starpu_data_get_sequential_consistency_flag(starpu_data_handle_t handle)
int starpu_data_idle_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async)
struct _starpu_data_state * starpu_data_handle_t
Definition: starpu_data.h:44
void starpu_data_release(starpu_data_handle_t handle)
void starpu_data_set_wt_mask(starpu_data_handle_t handle, uint32_t wt_mask)
int starpu_data_prefetch_on_node_prio(starpu_data_handle_t handle, unsigned node, unsigned async, int prio)
int starpu_data_acquire(starpu_data_handle_t handle, enum starpu_data_access_mode mode)
void * starpu_data_get_user_data(starpu_data_handle_t handle)
void starpu_data_advise_as_important(starpu_data_handle_t handle, unsigned is_important)
unsigned starpu_data_get_default_sequential_consistency_flag(void)
int starpu_data_can_evict(starpu_data_handle_t handle, unsigned node, enum starpu_is_prefetch is_prefetch)
void starpu_memchunk_tidy(unsigned memory_node)
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)
void starpu_data_wont_use(starpu_data_handle_t handle)
@ STARPU_NOFOOTPRINT
Definition: starpu_data.h:148
@ STARPU_MPI_REDUX
Definition: starpu_data.h:132
@ STARPU_SCRATCH
Definition: starpu_data.h:60
@ STARPU_ACCESS_MODE_MAX
Definition: starpu_data.h:150
@ STARPU_SSEND
Definition: starpu_data.h:113
@ STARPU_W
Definition: starpu_data.h:58
@ STARPU_RW
Definition: starpu_data.h:59
@ STARPU_REDUX
Definition: starpu_data.h:87
@ STARPU_R
Definition: starpu_data.h:57
@ STARPU_UNMAP
Definition: starpu_data.h:146
@ STARPU_COMMUTE
Definition: starpu_data.h:101
@ STARPU_LOCALITY
Definition: starpu_data.h:118
@ STARPU_NOPLAN
Definition: starpu_data.h:143
@ STARPU_NONE
Definition: starpu_data.h:56
@ STARPU_TASK_PREFETCH
Definition: starpu_data.h:471
@ STARPU_PREFETCH
Definition: starpu_data.h:473
@ STARPU_IDLEFETCH
Definition: starpu_data.h:475
@ STARPU_FETCH
Definition: starpu_data.h:469
#define STARPU_ATTRIBUTE_MALLOC
Definition: starpu_util.h:129