StarPU Handbook
starpu_data.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2011-2013,2016 Inria
4  * Copyright (C) 2009-2017 Université de Bordeaux
5  * Copyright (C) 2010-2015 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 
29 struct _starpu_data_state;
30 typedef struct _starpu_data_state* starpu_data_handle_t;
31 
32 /* Note: when adding a flag here, update _starpu_detect_implicit_data_deps_with_handle */
34 {
36  STARPU_R=(1<<0),
37  STARPU_W=(1<<1),
40  STARPU_REDUX=(1<<3),
42  STARPU_SSEND=(1<<5),
44  STARPU_ACCESS_MODE_MAX=(1<<7)
45  /* Note: other STARPU_* values in include/starpu_task_util.h */
46 };
47 
49 {
50  starpu_data_handle_t handle;
52 };
53 
55 
56 void starpu_data_set_name(starpu_data_handle_t handle, const char *name);
57 void starpu_data_set_coordinates_array(starpu_data_handle_t handle, int dimensions, int dims[]);
58 void starpu_data_set_coordinates(starpu_data_handle_t handle, unsigned dimensions, ...);
59 
60 void starpu_data_unregister(starpu_data_handle_t handle);
61 void starpu_data_unregister_no_coherency(starpu_data_handle_t handle);
62 void starpu_data_unregister_submit(starpu_data_handle_t handle);
63 void starpu_data_invalidate(starpu_data_handle_t handle);
64 void starpu_data_invalidate_submit(starpu_data_handle_t handle);
65 
66 void starpu_data_advise_as_important(starpu_data_handle_t handle, unsigned is_important);
67 
68 #define STARPU_ACQUIRE_NO_NODE -1
69 #define STARPU_ACQUIRE_ALL_NODES -2
70 int starpu_data_acquire(starpu_data_handle_t handle, enum starpu_data_access_mode mode);
71 int starpu_data_acquire_on_node(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode);
72 int starpu_data_acquire_cb(starpu_data_handle_t handle, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg);
73 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);
74 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);
75 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);
76 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, long *pre_sync_jobid, long *post_sync_jobid);
77 
78 int starpu_data_acquire_try(starpu_data_handle_t handle, enum starpu_data_access_mode mode);
79 int starpu_data_acquire_on_node_try(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode);
80 
81 #ifdef __GCC__
82 # define STARPU_DATA_ACQUIRE_CB(handle, mode, code) do \
83  { \ \
84  void callback(void *arg) \
85  { \
86  code; \
87  starpu_data_release(handle); \
88  } \
89  starpu_data_acquire_cb(handle, mode, callback, NULL); \
90  } \
91  while(0)
92 #endif
93 
94 void starpu_data_release(starpu_data_handle_t handle);
95 void starpu_data_release_on_node(starpu_data_handle_t handle, int node);
96 
97 typedef struct starpu_arbiter *starpu_arbiter_t;
98 starpu_arbiter_t starpu_arbiter_create(void) STARPU_ATTRIBUTE_MALLOC;
99 void starpu_data_assign_arbiter(starpu_data_handle_t handle, starpu_arbiter_t arbiter);
100 void starpu_arbiter_destroy(starpu_arbiter_t arbiter);
101 
103 
104 #define starpu_data_malloc_pinned_if_possible starpu_malloc
105 #define starpu_data_free_pinned_if_possible starpu_free
106 
107 int starpu_data_request_allocation(starpu_data_handle_t handle, unsigned node);
108 
109 int starpu_data_fetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
110 int starpu_data_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
111 int starpu_data_idle_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
112 
113 void starpu_data_wont_use(starpu_data_handle_t handle);
114 
115 #define STARPU_MAIN_RAM 0
116 
118 {
123  STARPU_DISK_RAM = 0x04,
127 
128 };
129 
130 unsigned starpu_worker_get_memory_node(unsigned workerid);
131 unsigned starpu_memory_nodes_get_count(void);
132 enum starpu_node_kind starpu_node_get_kind(unsigned node);
133 
134 void starpu_data_set_wt_mask(starpu_data_handle_t handle, uint32_t wt_mask);
135 
136 void starpu_data_set_sequential_consistency_flag(starpu_data_handle_t handle, unsigned flag);
137 unsigned starpu_data_get_sequential_consistency_flag(starpu_data_handle_t handle);
140 
141 void starpu_data_query_status(starpu_data_handle_t handle, int memory_node, int *is_allocated, int *is_valid, int *is_requested);
142 
143 struct starpu_codelet;
144 
145 void starpu_data_set_reduction_methods(starpu_data_handle_t handle, struct starpu_codelet *redux_cl, struct starpu_codelet *init_cl);
146 
147 struct starpu_data_interface_ops* starpu_data_get_interface_ops(starpu_data_handle_t handle);
148 
149 unsigned starpu_data_test_if_allocated_on_node(starpu_data_handle_t handle, unsigned memory_node);
150 
151 void starpu_memchunk_tidy(unsigned memory_node);
152 
153 void starpu_data_set_user_data(starpu_data_handle_t handle, void* user_data);
154 void *starpu_data_get_user_data(starpu_data_handle_t handle);
155 
156 #ifdef __cplusplus
157 }
158 #endif
159 
160 #endif /* __STARPU_DATA_H__ */
enum starpu_node_kind starpu_node_get_kind(unsigned node)
Definition: starpu_data.h:120
Definition: starpu_task.h:89
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)
starpu_node_kind
Definition: starpu_data.h:117
void starpu_data_display_memory_stats()
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)
Definition: starpu_data.h:36
#define STARPU_ATTRIBUTE_MALLOC
Definition: starpu_util.h:62
Definition: starpu_data.h:119
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)
Definition: starpu_data.h:39
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)
Definition: starpu_data.h:126
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)
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)
unsigned starpu_data_get_sequential_consistency_flag(starpu_data_handle_t handle)
void starpu_data_release(starpu_data_handle_t handle)
void starpu_data_unregister_submit(starpu_data_handle_t handle)
Definition: starpu_data.h:121
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, long *pre_sync_jobid, long *post_sync_jobid)
Definition: starpu_data.h:41
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)
Definition: starpu_data.h:35
void starpu_data_assign_arbiter(starpu_data_handle_t handle, starpu_arbiter_t arbiter)
Definition: starpu_data.h:42
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)
struct starpu_data_interface_ops * starpu_data_get_interface_ops(starpu_data_handle_t handle)
int starpu_data_request_allocation(starpu_data_handle_t handle, unsigned node)
char * name
Definition: starpu_data_interfaces.h:134
Definition: starpu_data.h:37
void * starpu_data_get_user_data(starpu_data_handle_t handle)
void starpu_data_unregister_no_coherency(starpu_data_handle_t handle)
void starpu_data_set_coordinates(starpu_data_handle_t handle, unsigned dimensions,...)
Definition: starpu_data.h:43
starpu_arbiter_t starpu_arbiter_create(void) STARPU_ATTRIBUTE_MALLOC
int starpu_data_acquire(starpu_data_handle_t handle, enum starpu_data_access_mode mode)
Definition: starpu_data.h:122
int starpu_data_acquire_try(starpu_data_handle_t handle, enum starpu_data_access_mode mode)
Definition: starpu_data.h:40
Definition: starpu_data.h:124
void starpu_data_set_default_sequential_consistency_flag(unsigned flag)
Definition: starpu_data_interfaces.h:110
unsigned starpu_worker_get_memory_node(unsigned workerid)
void starpu_data_set_sequential_consistency_flag(starpu_data_handle_t handle, unsigned flag)
Definition: starpu_data.h:125
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:33
struct _starpu_data_state * starpu_data_handle_t
Definition: starpu_data.h:30
struct starpu_arbiter * starpu_arbiter_t
Definition: starpu_data.h:97
int starpu_data_fetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async)
Definition: starpu_data.h:48
enum starpu_data_access_mode mode
Definition: starpu_data.h:51
Definition: starpu_data.h:38
starpu_data_handle_t handle
Definition: starpu_data.h:50
void starpu_arbiter_destroy(starpu_arbiter_t arbiter)
unsigned starpu_data_get_default_sequential_consistency_flag(void)