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-2020 Université de Bordeaux, CNRS (LaBRI UMR 5800), Inria
4  *
5  * StarPU is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU Lesser General Public License as published by
7  * the Free Software Foundation; either version 2.1 of the License, or (at
8  * your option) any later version.
9  *
10  * StarPU is distributed in the hope that it will be useful, but
11  * WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
13  *
14  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
15  */
16 
17 #ifndef __STARPU_DATA_H__
18 #define __STARPU_DATA_H__
19 
20 #include <starpu.h>
21 
22 #ifdef __cplusplus
23 extern "C"
24 {
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),
85  STARPU_REDUX=(1<<3),
86  STARPU_COMMUTE=(1<<4),
96  STARPU_SSEND=(1<<5),
101  STARPU_LOCALITY=(1<<6),
113  STARPU_ACCESS_MODE_MAX=(1<<7)
114 };
115 
117 
120 
126 void starpu_data_set_coordinates_array(starpu_data_handle_t handle, unsigned dimensions, int dims[]);
127 
133 void starpu_data_set_coordinates(starpu_data_handle_t handle, unsigned dimensions, ...);
134 
141 unsigned starpu_data_get_coordinates_array(starpu_data_handle_t handle, unsigned dimensions, int dims[]);
142 
154 
161 
173 
181 
187 
192 void starpu_data_advise_as_important(starpu_data_handle_t handle, unsigned is_important);
193 
205 #define STARPU_ACQUIRE_NO_NODE -1
206 
212 #define STARPU_ACQUIRE_NO_NODE_LOCK_ALL -2
213 
234 
242 
255 int starpu_data_acquire_cb(starpu_data_handle_t handle, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg);
256 
264 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);
265 
280 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);
281 
289 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);
290 
291 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);
292 
300 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);
301 
312 
321 
322 #ifdef __GCC__
323 
332 # define STARPU_DATA_ACQUIRE_CB(handle, mode, code) do \
333  { \ \
334  void callback(void *arg) \
335  { \
336  code; \
337  starpu_data_release(handle); \
338  } \
339  starpu_data_acquire_cb(handle, mode, callback, NULL); \
340  } \
341  while(0)
342 #endif
343 
350 
358 
366 typedef struct starpu_arbiter *starpu_arbiter_t;
367 
373 
378 
384 
390 
400 int starpu_data_fetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
401 
411 int starpu_data_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
412 
413 int starpu_data_prefetch_on_node_prio(starpu_data_handle_t handle, unsigned node, unsigned async, int prio);
414 
423 int starpu_data_idle_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
424 int starpu_data_idle_prefetch_on_node_prio(starpu_data_handle_t handle, unsigned node, unsigned async, int prio);
425 
430 unsigned starpu_data_is_on_node(starpu_data_handle_t handle, unsigned node);
431 
439 
449 void starpu_data_set_wt_mask(starpu_data_handle_t handle, uint32_t wt_mask);
450 
472 
477 
482 
493 
500 void starpu_data_set_ooc_flag(starpu_data_handle_t handle, unsigned flag);
506 
510 void starpu_data_query_status(starpu_data_handle_t handle, int memory_node, int *is_allocated, int *is_valid, int *is_requested);
511 
512 struct starpu_codelet;
513 
521 
522 struct starpu_data_interface_ops* starpu_data_get_interface_ops(starpu_data_handle_t handle);
523 
524 unsigned starpu_data_test_if_allocated_on_node(starpu_data_handle_t handle, unsigned memory_node);
525 
526 void starpu_memchunk_tidy(unsigned memory_node);
527 
534 void starpu_data_set_user_data(starpu_data_handle_t handle, void* user_data);
535 
540 
543 #ifdef __cplusplus
544 }
545 #endif
546 
547 #endif /* __STARPU_DATA_H__ */
starpu_data_unregister_no_coherency
void starpu_data_unregister_no_coherency(starpu_data_handle_t handle)
starpu_data_set_name
void starpu_data_set_name(starpu_data_handle_t handle, const char *name)
starpu_data_acquire
int starpu_data_acquire(starpu_data_handle_t handle, enum starpu_data_access_mode mode)
starpu_data_acquire_cb
int starpu_data_acquire_cb(starpu_data_handle_t handle, enum starpu_data_access_mode mode, void(*callback)(void *), void *arg)
STARPU_W
@ STARPU_W
Definition: starpu_data.h:58
starpu_data_request_allocation
int starpu_data_request_allocation(starpu_data_handle_t handle, unsigned node)
starpu_data_acquire_on_node_cb
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)
starpu_data_acquire_on_node_cb_sequential_consistency_sync_jobids
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)
STARPU_REDUX
@ STARPU_REDUX
Definition: starpu_data.h:85
starpu_data_invalidate
void starpu_data_invalidate(starpu_data_handle_t handle)
starpu_data_access_mode
starpu_data_access_mode
Definition: starpu_data.h:55
STARPU_COMMUTE
@ STARPU_COMMUTE
Definition: starpu_data.h:86
starpu_data_set_ooc_flag
void starpu_data_set_ooc_flag(starpu_data_handle_t handle, unsigned flag)
STARPU_SSEND
@ STARPU_SSEND
Definition: starpu_data.h:96
starpu_data_advise_as_important
void starpu_data_advise_as_important(starpu_data_handle_t handle, unsigned is_important)
starpu_arbiter_t
struct starpu_arbiter * starpu_arbiter_t
Definition: starpu_data.h:366
STARPU_R
@ STARPU_R
Definition: starpu_data.h:57
starpu_data_interface_ops
Definition: starpu_data_interfaces.h:366
starpu_codelet
Definition: starpu_task.h:250
starpu_arbiter_destroy
void starpu_arbiter_destroy(starpu_arbiter_t arbiter)
starpu_arbiter_create
starpu_arbiter_t starpu_arbiter_create(void) STARPU_ATTRIBUTE_MALLOC
starpu_data_set_coordinates_array
void starpu_data_set_coordinates_array(starpu_data_handle_t handle, unsigned dimensions, int dims[])
starpu_data_acquire_try
int starpu_data_acquire_try(starpu_data_handle_t handle, enum starpu_data_access_mode mode)
STARPU_LOCALITY
@ STARPU_LOCALITY
Definition: starpu_data.h:101
starpu_data_get_user_data
void * starpu_data_get_user_data(starpu_data_handle_t handle)
starpu_data_handle_t
struct _starpu_data_state * starpu_data_handle_t
Definition: starpu_data.h:44
starpu.h
starpu_data_set_coordinates
void starpu_data_set_coordinates(starpu_data_handle_t handle, unsigned dimensions,...)
starpu_data_get_coordinates_array
unsigned starpu_data_get_coordinates_array(starpu_data_handle_t handle, unsigned dimensions, int dims[])
starpu_data_interface_ops::name
char * name
Definition: starpu_data_interfaces.h:556
starpu_data_fetch_on_node
int starpu_data_fetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async)
starpu_data_unregister_submit
void starpu_data_unregister_submit(starpu_data_handle_t handle)
starpu_data_set_wt_mask
void starpu_data_set_wt_mask(starpu_data_handle_t handle, uint32_t wt_mask)
starpu_data_acquire_on_node_cb_sequential_consistency
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)
starpu_data_idle_prefetch_on_node
int starpu_data_idle_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async)
starpu_data_wont_use
void starpu_data_wont_use(starpu_data_handle_t handle)
starpu_data_acquire_on_node
int starpu_data_acquire_on_node(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode)
starpu_data_is_on_node
unsigned starpu_data_is_on_node(starpu_data_handle_t handle, unsigned node)
starpu_data_unregister
void starpu_data_unregister(starpu_data_handle_t handle)
STARPU_ACCESS_MODE_MAX
@ STARPU_ACCESS_MODE_MAX
Definition: starpu_data.h:113
starpu_data_set_reduction_methods
void starpu_data_set_reduction_methods(starpu_data_handle_t handle, struct starpu_codelet *redux_cl, struct starpu_codelet *init_cl)
starpu_data_prefetch_on_node
int starpu_data_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async)
starpu_data_get_default_sequential_consistency_flag
unsigned starpu_data_get_default_sequential_consistency_flag(void)
starpu_data_get_ooc_flag
unsigned starpu_data_get_ooc_flag(starpu_data_handle_t handle)
starpu_data_release
void starpu_data_release(starpu_data_handle_t handle)
starpu_data_set_default_sequential_consistency_flag
void starpu_data_set_default_sequential_consistency_flag(unsigned flag)
starpu_data_release_on_node
void starpu_data_release_on_node(starpu_data_handle_t handle, int node)
starpu_data_set_user_data
void starpu_data_set_user_data(starpu_data_handle_t handle, void *user_data)
STARPU_SCRATCH
@ STARPU_SCRATCH
Definition: starpu_data.h:60
STARPU_NONE
@ STARPU_NONE
Definition: starpu_data.h:56
starpu_data_assign_arbiter
void starpu_data_assign_arbiter(starpu_data_handle_t handle, starpu_arbiter_t arbiter)
starpu_data_query_status
void starpu_data_query_status(starpu_data_handle_t handle, int memory_node, int *is_allocated, int *is_valid, int *is_requested)
STARPU_RW
@ STARPU_RW
Definition: starpu_data.h:59
starpu_data_invalidate_submit
void starpu_data_invalidate_submit(starpu_data_handle_t handle)
starpu_data_acquire_cb_sequential_consistency
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)
starpu_data_get_sequential_consistency_flag
unsigned starpu_data_get_sequential_consistency_flag(starpu_data_handle_t handle)
starpu_data_acquire_on_node_try
int starpu_data_acquire_on_node_try(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode)
starpu_data_set_sequential_consistency_flag
void starpu_data_set_sequential_consistency_flag(starpu_data_handle_t handle, unsigned flag)
STARPU_ATTRIBUTE_MALLOC
#define STARPU_ATTRIBUTE_MALLOC
Definition: starpu_util.h:112