StarPU Handbook
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Modules Pages
starpu_data.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2010-2014 Université de Bordeaux
4  * Copyright (C) 2010, 2011, 2012, 2013, 2014 Centre National de la Recherche Scientifique
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 {
26 #endif
27 
28 struct _starpu_data_state;
29 typedef struct _starpu_data_state* starpu_data_handle_t;
30 
32 {
34  STARPU_R=(1<<0),
35  STARPU_W=(1<<1),
38  STARPU_REDUX=(1<<3),
40  STARPU_SSEND=(1<<5)
41  /* Note: other STARPU_* values in include/starpu_task_util.h */
42 };
43 
45 {
46  starpu_data_handle_t handle;
48 };
49 
51 
52 void starpu_data_unregister(starpu_data_handle_t handle);
53 void starpu_data_unregister_no_coherency(starpu_data_handle_t handle);
54 void starpu_data_unregister_submit(starpu_data_handle_t handle);
55 void starpu_data_invalidate(starpu_data_handle_t handle);
56 void starpu_data_invalidate_submit(starpu_data_handle_t handle);
57 
58 void starpu_data_advise_as_important(starpu_data_handle_t handle, unsigned is_important);
59 
60 int starpu_data_acquire(starpu_data_handle_t handle, enum starpu_data_access_mode mode);
61 int starpu_data_acquire_on_node(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode);
62 int starpu_data_acquire_cb(starpu_data_handle_t handle, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg);
63 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);
64 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);
65 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);
66 
67 #ifdef __GCC__
68 # define STARPU_DATA_ACQUIRE_CB(handle, mode, code) do \
69  { \ \
70  void callback(void *arg) \
71  { \
72  code; \
73  starpu_data_release(handle); \
74  } \
75  starpu_data_acquire_cb(handle, mode, callback, NULL); \
76  } \
77  while(0)
78 #endif
79 
80 void starpu_data_release(starpu_data_handle_t handle);
81 void starpu_data_release_on_node(starpu_data_handle_t handle, int node);
82 
84 
85 #define starpu_data_malloc_pinned_if_possible starpu_malloc
86 #define starpu_data_free_pinned_if_possible starpu_free
87 
88 int starpu_data_request_allocation(starpu_data_handle_t handle, unsigned node);
89 
90 int starpu_data_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
91 
92 #define STARPU_MAIN_RAM 0
93 
95 {
96  STARPU_UNUSED = 0x00,
100  STARPU_DISK_RAM = 0x04,
104 
105 };
106 
107 unsigned starpu_worker_get_memory_node(unsigned workerid);
108 unsigned starpu_memory_nodes_get_count(void);
109 enum starpu_node_kind starpu_node_get_kind(unsigned node);
110 
111 void starpu_data_set_wt_mask(starpu_data_handle_t handle, uint32_t wt_mask);
112 
113 void starpu_data_set_sequential_consistency_flag(starpu_data_handle_t handle, unsigned flag);
114 unsigned starpu_data_get_sequential_consistency_flag(starpu_data_handle_t handle);
117 
118 void starpu_data_query_status(starpu_data_handle_t handle, int memory_node, int *is_allocated, int *is_valid, int *is_requested);
119 
120 struct starpu_codelet;
121 
122 void starpu_data_set_reduction_methods(starpu_data_handle_t handle, struct starpu_codelet *redux_cl, struct starpu_codelet *init_cl);
123 
124 int starpu_data_set_rank(starpu_data_handle_t handle, int rank);
125 int starpu_data_get_rank(starpu_data_handle_t handle);
126 
127 int starpu_data_set_tag(starpu_data_handle_t handle, int tag);
128 int starpu_data_get_tag(starpu_data_handle_t handle);
129 struct starpu_data_interface_ops* starpu_data_get_interface_ops(starpu_data_handle_t handle);
130 
131 unsigned starpu_data_test_if_allocated_on_node(starpu_data_handle_t handle, unsigned memory_node);
132 
133 void starpu_memchunk_tidy(unsigned memory_node);
134 
135 
136 #ifdef __cplusplus
137 }
138 #endif
139 
140 #endif /* __STARPU_DATA_H__ */
enum starpu_node_kind starpu_node_get_kind(unsigned node)
Definition: starpu_data.h:97
int starpu_data_set_rank(starpu_data_handle_t handle, int rank)
Definition: starpu_task.h:86
int starpu_data_get_rank(starpu_data_handle_t handle)
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:94
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:34
Definition: starpu_data.h:96
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:37
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:103
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)
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:98
Definition: starpu_data.h:39
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:33
int starpu_data_get_tag(starpu_data_handle_t handle)
Definition: starpu_data.h:40
void starpu_data_set_reduction_methods(starpu_data_handle_t handle, struct starpu_codelet *redux_cl, struct starpu_codelet *init_cl)
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)
Definition: starpu_data.h:35
void starpu_data_unregister_no_coherency(starpu_data_handle_t handle)
int starpu_data_acquire(starpu_data_handle_t handle, enum starpu_data_access_mode mode)
Definition: starpu_data.h:99
Definition: starpu_data.h:38
Definition: starpu_data.h:101
Definition: starpu_data_interfaces.h:107
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:102
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:31
struct _starpu_data_state * starpu_data_handle_t
Definition: starpu_data.h:29
void starpu_data_set_default_sequential_consistency_flag(unsigned flag)
Definition: starpu_data.h:44
enum starpu_data_access_mode mode
Definition: starpu_data.h:47
int starpu_data_set_tag(starpu_data_handle_t handle, int tag)
Definition: starpu_data.h:36
starpu_data_handle_t handle
Definition: starpu_data.h:46
unsigned starpu_data_get_default_sequential_consistency_flag(void)