StarPU Handbook
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
starpu_data_interfaces.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-2013 Centre National de la Recherche Scientifique
5  * Copyright (C) 2011-2012 Institut National de Recherche en Informatique et Automatique
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_INTERFACES_H__
20 #define __STARPU_DATA_INTERFACES_H__
21 
22 #include <starpu.h>
23 
24 #ifdef STARPU_USE_CUDA
25 /* to use CUDA streams */
26 # ifdef STARPU_DONT_INCLUDE_CUDA_HEADERS
27 typedef void *starpu_cudaStream_t;
28 # else
29 # include <cuda_runtime.h>
30 typedef cudaStream_t starpu_cudaStream_t;
31 # endif
32 #endif
33 
34 #ifdef __cplusplus
35 extern "C"
36 {
37 #endif
38 
40 {
41  int (*can_copy)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, unsigned handling_node);
42 
43  int (*ram_to_ram)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
44  int (*ram_to_cuda)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
45  int (*ram_to_opencl)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
46 
47  int (*cuda_to_ram)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
48  int (*cuda_to_cuda)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
49  int (*cuda_to_opencl)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
50 
51  int (*opencl_to_ram)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
52  int (*opencl_to_cuda)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
53  int (*opencl_to_opencl)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
54 
55 #ifdef STARPU_USE_CUDA
56  int (*ram_to_cuda_async)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, starpu_cudaStream_t stream);
57  int (*cuda_to_ram_async)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, starpu_cudaStream_t stream);
58  int (*cuda_to_cuda_async)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, starpu_cudaStream_t stream);
59 #else
60 #ifdef STARPU_SIMGRID
62 #endif
63 #endif
64 
65 #if defined(STARPU_USE_OPENCL) && !defined(__CUDACC__)
66  int (*ram_to_opencl_async)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, cl_event *event);
67  int (*opencl_to_ram_async)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, cl_event *event);
68  int (*opencl_to_opencl_async)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, cl_event *event);
69 #endif
70 
71  int (*any_to_any)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, void *async_data);
72 };
73 
74 int starpu_interface_copy(uintptr_t src, size_t src_offset, unsigned src_node, uintptr_t dst, size_t dst_offset, unsigned dst_node, size_t size, void *async_data);
75 uintptr_t starpu_malloc_on_node(unsigned dst_node, size_t size);
76 void starpu_free_on_node(unsigned dst_node, uintptr_t addr, size_t size);
77 
79 {
91 };
92 
94 {
96  unsigned home_node, void *data_interface);
97  starpu_ssize_t (*allocate_data_on_node)(void *data_interface, unsigned node);
98  void (*free_data_on_node)(void *data_interface, unsigned node);
100  void * (*handle_to_pointer)(starpu_data_handle_t handle, unsigned node);
101  size_t (*get_size)(starpu_data_handle_t handle);
102  uint32_t (*footprint)(starpu_data_handle_t handle);
103  int (*compare)(void *data_interface_a, void *data_interface_b);
104  void (*display)(starpu_data_handle_t handle, FILE *f);
107 
109  struct starpu_multiformat_data_interface_ops* (*get_mf_ops)(void *data_interface);
110 
111  int (*pack_data)(starpu_data_handle_t handle, unsigned node, void **ptr, starpu_ssize_t *count);
112  int (*unpack_data)(starpu_data_handle_t handle, unsigned node, void *ptr, size_t count);
113 };
114 
116 
117 void starpu_data_register(starpu_data_handle_t *handleptr, unsigned home_node, void *data_interface, struct starpu_data_interface_ops *ops);
118 void starpu_data_ptr_register(starpu_data_handle_t handle, unsigned node);
120 
121 void *starpu_data_handle_to_pointer(starpu_data_handle_t handle, unsigned node);
123 
124 void *starpu_data_get_interface_on_node(starpu_data_handle_t handle, unsigned memory_node);
125 
126 extern struct starpu_data_interface_ops starpu_interface_matrix_ops;
127 
129 {
130  uintptr_t ptr;
131  uintptr_t dev_handle;
132  size_t offset;
133  uint32_t nx;
134  uint32_t ny;
135  uint32_t ld;
136  size_t elemsize;
137 };
138 
139 void starpu_matrix_data_register(starpu_data_handle_t *handle, unsigned home_node, uintptr_t ptr, uint32_t ld, uint32_t nx, uint32_t ny, size_t elemsize);
140 void starpu_matrix_ptr_register(starpu_data_handle_t handle, unsigned node, uintptr_t ptr, uintptr_t dev_handle, size_t offset, uint32_t ld);
146 
147 #define STARPU_MATRIX_GET_PTR(interface) (((struct starpu_matrix_interface *)(interface))->ptr)
148 #define STARPU_MATRIX_GET_DEV_HANDLE(interface) (((struct starpu_matrix_interface *)(interface))->dev_handle)
149 #define STARPU_MATRIX_GET_OFFSET(interface) (((struct starpu_matrix_interface *)(interface))->offset)
150 #define STARPU_MATRIX_GET_NX(interface) (((struct starpu_matrix_interface *)(interface))->nx)
151 #define STARPU_MATRIX_GET_NY(interface) (((struct starpu_matrix_interface *)(interface))->ny)
152 #define STARPU_MATRIX_GET_LD(interface) (((struct starpu_matrix_interface *)(interface))->ld)
153 #define STARPU_MATRIX_GET_ELEMSIZE(interface) (((struct starpu_matrix_interface *)(interface))->elemsize)
154 
156 {
157  uint32_t *columns;
158  uint32_t *rows;
159  uintptr_t values;
160  uint32_t nx;
161  uint32_t ny;
162  uint32_t n_values;
163  size_t elemsize;
164 };
165 
166 void starpu_coo_data_register(starpu_data_handle_t *handleptr, unsigned home_node, uint32_t nx, uint32_t ny, uint32_t n_values, uint32_t *columns, uint32_t *rows, uintptr_t values, size_t elemsize);
167 
168 #define STARPU_COO_GET_COLUMNS(interface) \
169  (((struct starpu_coo_interface *)(interface))->columns)
170 #define STARPU_COO_GET_COLUMNS_DEV_HANDLE(interface) \
171  (((struct starpu_coo_interface *)(interface))->columns)
172 #define STARPU_COO_GET_ROWS(interface) \
173  (((struct starpu_coo_interface *)(interface))->rows)
174 #define STARPU_COO_GET_ROWS_DEV_HANDLE(interface) \
175  (((struct starpu_coo_interface *)(interface))->rows)
176 #define STARPU_COO_GET_VALUES(interface) \
177  (((struct starpu_coo_interface *)(interface))->values)
178 #define STARPU_COO_GET_VALUES_DEV_HANDLE(interface) \
179  (((struct starpu_coo_interface *)(interface))->values)
180 #define STARPU_COO_GET_OFFSET 0
181 #define STARPU_COO_GET_NX(interface) \
182  (((struct starpu_coo_interface *)(interface))->nx)
183 #define STARPU_COO_GET_NY(interface) \
184  (((struct starpu_coo_interface *)(interface))->ny)
185 #define STARPU_COO_GET_NVALUES(interface) \
186  (((struct starpu_coo_interface *)(interface))->n_values)
187 #define STARPU_COO_GET_ELEMSIZE(interface) \
188  (((struct starpu_coo_interface *)(interface))->elemsize)
189 
190 /* TODO: rename to 3dmatrix? */
192 {
193  uintptr_t ptr;
194  uintptr_t dev_handle;
195  size_t offset;
196  uint32_t nx;
197  uint32_t ny;
198  uint32_t nz;
199  uint32_t ldy;
200  uint32_t ldz;
201  size_t elemsize;
202 };
203 
204 void starpu_block_data_register(starpu_data_handle_t *handle, unsigned home_node, uintptr_t ptr, uint32_t ldy, uint32_t ldz, uint32_t nx, uint32_t ny, uint32_t nz, size_t elemsize);
205 void starpu_block_ptr_register(starpu_data_handle_t handle, unsigned node, uintptr_t ptr, uintptr_t dev_handle, size_t offset, uint32_t ldy, uint32_t ldz);
213 
214 #define STARPU_BLOCK_GET_PTR(interface) (((struct starpu_block_interface *)(interface))->ptr)
215 #define STARPU_BLOCK_GET_DEV_HANDLE(interface) (((struct starpu_block_interface *)(interface))->dev_handle)
216 #define STARPU_BLOCK_GET_OFFSET(interface) (((struct starpu_block_interface *)(interface))->offset)
217 #define STARPU_BLOCK_GET_NX(interface) (((struct starpu_block_interface *)(interface))->nx)
218 #define STARPU_BLOCK_GET_NY(interface) (((struct starpu_block_interface *)(interface))->ny)
219 #define STARPU_BLOCK_GET_NZ(interface) (((struct starpu_block_interface *)(interface))->nz)
220 #define STARPU_BLOCK_GET_LDY(interface) (((struct starpu_block_interface *)(interface))->ldy)
221 #define STARPU_BLOCK_GET_LDZ(interface) (((struct starpu_block_interface *)(interface))->ldz)
222 #define STARPU_BLOCK_GET_ELEMSIZE(interface) (((struct starpu_block_interface *)(interface))->elemsize)
223 
225 {
226  uintptr_t ptr;
227  uintptr_t dev_handle;
228  size_t offset;
229  uint32_t nx;
230  size_t elemsize;
231 };
232 
233 void starpu_vector_data_register(starpu_data_handle_t *handle, unsigned home_node, uintptr_t ptr, uint32_t nx, size_t elemsize);
234 void starpu_vector_ptr_register(starpu_data_handle_t handle, unsigned node, uintptr_t ptr, uintptr_t dev_handle, size_t offset);
238 
239 #define STARPU_VECTOR_GET_PTR(interface) (((struct starpu_vector_interface *)(interface))->ptr)
240 #define STARPU_VECTOR_GET_DEV_HANDLE(interface) (((struct starpu_vector_interface *)(interface))->dev_handle)
241 #define STARPU_VECTOR_GET_OFFSET(interface) (((struct starpu_vector_interface *)(interface))->offset)
242 #define STARPU_VECTOR_GET_NX(interface) (((struct starpu_vector_interface *)(interface))->nx)
243 #define STARPU_VECTOR_GET_ELEMSIZE(interface) (((struct starpu_vector_interface *)(interface))->elemsize)
244 
246 {
247  uintptr_t ptr;
248  size_t elemsize;
249  /* No dev_handle, since it can not be filtered, offset will always be zero */
250 };
251 
252 void starpu_variable_data_register(starpu_data_handle_t *handle, unsigned home_node, uintptr_t ptr, size_t size);
255 
256 #define STARPU_VARIABLE_GET_PTR(interface) (((struct starpu_variable_interface *)(interface))->ptr)
257 #define STARPU_VARIABLE_GET_ELEMSIZE(interface) (((struct starpu_variable_interface *)(interface))->elemsize)
258 #define STARPU_VARIABLE_GET_DEV_HANDLE(interface) \
259  (((struct starpu_variable_interface *)(interface))->ptr)
260 #define STARPU_VARIABLE_GET_OFFSET 0
261 
263 
265 {
266  uint32_t nnz;
267  uint32_t nrow;
268  uintptr_t nzval;
269  uint32_t *colind;
270  uint32_t *rowptr;
271 
272  uint32_t firstentry;
273 
274  size_t elemsize;
275 };
276 
277 void starpu_csr_data_register(starpu_data_handle_t *handle, unsigned home_node, uint32_t nnz, uint32_t nrow, uintptr_t nzval, uint32_t *colind, uint32_t *rowptr, uint32_t firstentry, size_t elemsize);
285 
286 #define STARPU_CSR_GET_NNZ(interface) (((struct starpu_csr_interface *)(interface))->nnz)
287 #define STARPU_CSR_GET_NROW(interface) (((struct starpu_csr_interface *)(interface))->nrow)
288 #define STARPU_CSR_GET_NZVAL(interface) (((struct starpu_csr_interface *)(interface))->nzval)
289 #define STARPU_CSR_GET_NZVAL_DEV_HANDLE(interface) \
290  (((struct starpu_csr_interface *)(interface))->nnz)
291 #define STARPU_CSR_GET_COLIND(interface) (((struct starpu_csr_interface *)(interface))->colind)
292 #define STARPU_CSR_GET_COLIND_DEV_HANDLE(interface) \
293  (((struct starpu_csr_interface *)(interface))->colind)
294 #define STARPU_CSR_GET_ROWPTR(interface) (((struct starpu_csr_interface *)(interface))->rowptr)
295 #define STARPU_CSR_GET_ROWPTR_DEV_HANDLE(interface) \
296  (((struct starpu_csr_interface *)(interface))->rowptr)
297 #define STARPU_CSR_GET_OFFSET 0
298 #define STARPU_CSR_GET_FIRSTENTRY(interface) (((struct starpu_csr_interface *)(interface))->firstentry)
299 #define STARPU_CSR_GET_ELEMSIZE(interface) (((struct starpu_csr_interface *)(interface))->elemsize)
300 
302 {
303  uint32_t nnz;
304  uint32_t nrow;
305 
306  uintptr_t nzval;
307  uint32_t *colind;
308  uint32_t *rowptr;
309 
310  uint32_t firstentry;
311 
312  uint32_t r;
313  uint32_t c;
314 
315  size_t elemsize;
316 };
317 
318 void starpu_bcsr_data_register(starpu_data_handle_t *handle, unsigned home_node, uint32_t nnz, uint32_t nrow, uintptr_t nzval, uint32_t *colind, uint32_t *rowptr, uint32_t firstentry, uint32_t r, uint32_t c, size_t elemsize);
319 
320 #define STARPU_BCSR_GET_NNZ(interface) (((struct starpu_bcsr_interface *)(interface))->nnz)
321 #define STARPU_BCSR_GET_NZVAL(interface) (((struct starpu_bcsr_interface *)(interface))->nzval)
322 #define STARPU_BCSR_GET_NZVAL_DEV_HANDLE(interface) \
323  (((struct starpu_bcsr_interface *)(interface))->nnz)
324 #define STARPU_BCSR_GET_COLIND(interface) (((struct starpu_bcsr_interface *)(interface))->colind)
325 #define STARPU_BCSR_GET_COLIND_DEV_HANDLE(interface) \
326  (((struct starpu_bcsr_interface *)(interface))->colind)
327 #define STARPU_BCSR_GET_ROWPTR(interface) (((struct starpu_bcsr_interface *)(interface))->rowptr)
328 #define STARPU_BCSR_GET_ROWPTR_DEV_HANDLE(interface) \
329  (((struct starpu_bcsr_interface *)(interface))->rowptr)
330 #define STARPU_BCSR_GET_OFFSET 0
337 uint32_t starpu_bcsr_get_r(starpu_data_handle_t handle);
338 uint32_t starpu_bcsr_get_c(starpu_data_handle_t handle);
340 
342 {
343  size_t cpu_elemsize;
350 };
351 
353 {
354  void *cpu_ptr;
355  void *cuda_ptr;
356  void *opencl_ptr;
357  uint32_t nx;
359 };
360 
361 void starpu_multiformat_data_register(starpu_data_handle_t *handle, unsigned home_node, void *ptr, uint32_t nobjects, struct starpu_multiformat_data_interface_ops *format_ops);
362 
363 #define STARPU_MULTIFORMAT_GET_CPU_PTR(interface) (((struct starpu_multiformat_interface *)(interface))->cpu_ptr)
364 #define STARPU_MULTIFORMAT_GET_CUDA_PTR(interface) (((struct starpu_multiformat_interface *)(interface))->cuda_ptr)
365 #define STARPU_MULTIFORMAT_GET_OPENCL_PTR(interface) (((struct starpu_multiformat_interface *)(interface))->opencl_ptr)
366 #define STARPU_MULTIFORMAT_GET_NX(interface) (((struct starpu_multiformat_interface *)(interface))->nx)
367 
369 
370 int starpu_data_pack(starpu_data_handle_t handle, void **ptr, starpu_ssize_t *count);
371 int starpu_data_unpack(starpu_data_handle_t handle, void *ptr, size_t count);
373 
375 
376 #ifdef __cplusplus
377 }
378 #endif
379 
380 #endif /* __STARPU_DATA_INTERFACES_H__ */