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-2013 Université de Bordeaux 1
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 *cudaStream_t;
28 # else
29 # include <cuda_runtime.h>
30 # endif
31 #endif
32 
33 #ifdef __cplusplus
34 extern "C"
35 {
36 #endif
37 
39 {
40  int (*ram_to_ram)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
41  int (*ram_to_cuda)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
42  int (*ram_to_opencl)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
43 
44  int (*cuda_to_ram)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
45  int (*cuda_to_cuda)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
46  int (*cuda_to_opencl)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
47 
48  int (*opencl_to_ram)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
49  int (*opencl_to_cuda)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
50  int (*opencl_to_opencl)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node);
51 
52 #ifdef STARPU_USE_CUDA
53  int (*ram_to_cuda_async)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, cudaStream_t stream);
54  int (*cuda_to_ram_async)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, cudaStream_t stream);
55  int (*cuda_to_cuda_async)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, cudaStream_t stream);
56 #else
57 #ifdef STARPU_SIMGRID
59 #endif
60 #endif
61 
62 #if defined(STARPU_USE_OPENCL) && !defined(__CUDACC__)
63  int (*ram_to_opencl_async)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, cl_event *event);
64  int (*opencl_to_ram_async)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, cl_event *event);
65  int (*opencl_to_opencl_async)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, cl_event *event);
66 #endif
67 
68  int (*any_to_any)(void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, void *async_data);
69 };
70 
71 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);
72 uintptr_t starpu_malloc_on_node(unsigned dst_node, size_t size);
73 void starpu_free_on_node(unsigned dst_node, uintptr_t addr, size_t size);
74 
76 {
88 };
89 
91 {
93  unsigned home_node, void *data_interface);
94  starpu_ssize_t (*allocate_data_on_node)(void *data_interface, unsigned node);
95  void (*free_data_on_node)(void *data_interface, unsigned node);
97  void * (*handle_to_pointer)(starpu_data_handle_t handle, unsigned node);
98  size_t (*get_size)(starpu_data_handle_t handle);
99  uint32_t (*footprint)(starpu_data_handle_t handle);
100  int (*compare)(void *data_interface_a, void *data_interface_b);
101  void (*display)(starpu_data_handle_t handle, FILE *f);
104 
106  struct starpu_multiformat_data_interface_ops* (*get_mf_ops)(void *data_interface);
107 
108  int (*pack_data)(starpu_data_handle_t handle, unsigned node, void **ptr, starpu_ssize_t *count);
109  int (*unpack_data)(starpu_data_handle_t handle, unsigned node, void *ptr, size_t count);
110 };
111 
113 
114 void starpu_data_register(starpu_data_handle_t *handleptr, unsigned home_node, void *data_interface, struct starpu_data_interface_ops *ops);
116 
117 void *starpu_data_handle_to_pointer(starpu_data_handle_t handle, unsigned node);
119 
120 void *starpu_data_get_interface_on_node(starpu_data_handle_t handle, unsigned memory_node);
121 
122 extern struct starpu_data_interface_ops starpu_interface_matrix_ops;
123 
125 {
126  uintptr_t ptr;
127  uintptr_t dev_handle;
128  size_t offset;
129  uint32_t nx;
130  uint32_t ny;
131  uint32_t ld;
132  size_t elemsize;
133 };
134 
135 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);
141 
142 #define STARPU_MATRIX_GET_PTR(interface) (((struct starpu_matrix_interface *)(interface))->ptr)
143 #define STARPU_MATRIX_GET_DEV_HANDLE(interface) (((struct starpu_matrix_interface *)(interface))->dev_handle)
144 #define STARPU_MATRIX_GET_OFFSET(interface) (((struct starpu_matrix_interface *)(interface))->offset)
145 #define STARPU_MATRIX_GET_NX(interface) (((struct starpu_matrix_interface *)(interface))->nx)
146 #define STARPU_MATRIX_GET_NY(interface) (((struct starpu_matrix_interface *)(interface))->ny)
147 #define STARPU_MATRIX_GET_LD(interface) (((struct starpu_matrix_interface *)(interface))->ld)
148 #define STARPU_MATRIX_GET_ELEMSIZE(interface) (((struct starpu_matrix_interface *)(interface))->elemsize)
149 
151 {
152  uint32_t *columns;
153  uint32_t *rows;
154  uintptr_t values;
155  uint32_t nx;
156  uint32_t ny;
157  uint32_t n_values;
158  size_t elemsize;
159 };
160 
161 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);
162 
163 #define STARPU_COO_GET_COLUMNS(interface) \
164  (((struct starpu_coo_interface *)(interface))->columns)
165 #define STARPU_COO_GET_COLUMNS_DEV_HANDLE(interface) \
166  (((struct starpu_coo_interface *)(interface))->columns)
167 #define STARPU_COO_GET_ROWS(interface) \
168  (((struct starpu_coo_interface *)(interface))->rows)
169 #define STARPU_COO_GET_ROWS_DEV_HANDLE(interface) \
170  (((struct starpu_coo_interface *)(interface))->rows)
171 #define STARPU_COO_GET_VALUES(interface) \
172  (((struct starpu_coo_interface *)(interface))->values)
173 #define STARPU_COO_GET_VALUES_DEV_HANDLE(interface) \
174  (((struct starpu_coo_interface *)(interface))->values)
175 #define STARPU_COO_GET_OFFSET 0
176 #define STARPU_COO_GET_NX(interface) \
177  (((struct starpu_coo_interface *)(interface))->nx)
178 #define STARPU_COO_GET_NY(interface) \
179  (((struct starpu_coo_interface *)(interface))->ny)
180 #define STARPU_COO_GET_NVALUES(interface) \
181  (((struct starpu_coo_interface *)(interface))->n_values)
182 #define STARPU_COO_GET_ELEMSIZE(interface) \
183  (((struct starpu_coo_interface *)(interface))->elemsize)
184 
185 /* TODO: rename to 3dmatrix? */
187 {
188  uintptr_t ptr;
189  uintptr_t dev_handle;
190  size_t offset;
191  uint32_t nx;
192  uint32_t ny;
193  uint32_t nz;
194  uint32_t ldy;
195  uint32_t ldz;
196  size_t elemsize;
197 };
198 
199 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);
207 
208 #define STARPU_BLOCK_GET_PTR(interface) (((struct starpu_block_interface *)(interface))->ptr)
209 #define STARPU_BLOCK_GET_DEV_HANDLE(interface) (((struct starpu_block_interface *)(interface))->dev_handle)
210 #define STARPU_BLOCK_GET_OFFSET(interface) (((struct starpu_block_interface *)(interface))->offset)
211 #define STARPU_BLOCK_GET_NX(interface) (((struct starpu_block_interface *)(interface))->nx)
212 #define STARPU_BLOCK_GET_NY(interface) (((struct starpu_block_interface *)(interface))->ny)
213 #define STARPU_BLOCK_GET_NZ(interface) (((struct starpu_block_interface *)(interface))->nz)
214 #define STARPU_BLOCK_GET_LDY(interface) (((struct starpu_block_interface *)(interface))->ldy)
215 #define STARPU_BLOCK_GET_LDZ(interface) (((struct starpu_block_interface *)(interface))->ldz)
216 #define STARPU_BLOCK_GET_ELEMSIZE(interface) (((struct starpu_block_interface *)(interface))->elemsize)
217 
219 {
220  uintptr_t ptr;
221  uintptr_t dev_handle;
222  size_t offset;
223  uint32_t nx;
224  size_t elemsize;
225 };
226 
227 void starpu_vector_data_register(starpu_data_handle_t *handle, unsigned home_node, uintptr_t ptr, uint32_t nx, size_t elemsize);
231 
232 #define STARPU_VECTOR_GET_PTR(interface) (((struct starpu_vector_interface *)(interface))->ptr)
233 #define STARPU_VECTOR_GET_DEV_HANDLE(interface) (((struct starpu_vector_interface *)(interface))->dev_handle)
234 #define STARPU_VECTOR_GET_OFFSET(interface) (((struct starpu_vector_interface *)(interface))->offset)
235 #define STARPU_VECTOR_GET_NX(interface) (((struct starpu_vector_interface *)(interface))->nx)
236 #define STARPU_VECTOR_GET_ELEMSIZE(interface) (((struct starpu_vector_interface *)(interface))->elemsize)
237 
239 {
240  uintptr_t ptr;
241  size_t elemsize;
242  /* No dev_handle, since it can not be filtered, offset will always be zero */
243 };
244 
245 void starpu_variable_data_register(starpu_data_handle_t *handle, unsigned home_node, uintptr_t ptr, size_t size);
248 
249 #define STARPU_VARIABLE_GET_PTR(interface) (((struct starpu_variable_interface *)(interface))->ptr)
250 #define STARPU_VARIABLE_GET_ELEMSIZE(interface) (((struct starpu_variable_interface *)(interface))->elemsize)
251 #define STARPU_VARIABLE_GET_DEV_HANDLE(interface) \
252  (((struct starpu_variable_interface *)(interface))->ptr)
253 #define STARPU_VARIABLE_GET_OFFSET 0
254 
256 
258 {
259  uint32_t nnz;
260  uint32_t nrow;
261  uintptr_t nzval;
262  uint32_t *colind;
263  uint32_t *rowptr;
264 
265  uint32_t firstentry;
266 
267  size_t elemsize;
268 };
269 
270 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);
278 
279 #define STARPU_CSR_GET_NNZ(interface) (((struct starpu_csr_interface *)(interface))->nnz)
280 #define STARPU_CSR_GET_NROW(interface) (((struct starpu_csr_interface *)(interface))->nrow)
281 #define STARPU_CSR_GET_NZVAL(interface) (((struct starpu_csr_interface *)(interface))->nzval)
282 #define STARPU_CSR_GET_NZVAL_DEV_HANDLE(interface) \
283  (((struct starpu_csr_interface *)(interface))->nnz)
284 #define STARPU_CSR_GET_COLIND(interface) (((struct starpu_csr_interface *)(interface))->colind)
285 #define STARPU_CSR_GET_COLIND_DEV_HANDLE(interface) \
286  (((struct starpu_csr_interface *)(interface))->colind)
287 #define STARPU_CSR_GET_ROWPTR(interface) (((struct starpu_csr_interface *)(interface))->rowptr)
288 #define STARPU_CSR_GET_ROWPTR_DEV_HANDLE(interface) \
289  (((struct starpu_csr_interface *)(interface))->rowptr)
290 #define STARPU_CSR_GET_OFFSET 0
291 #define STARPU_CSR_GET_FIRSTENTRY(interface) (((struct starpu_csr_interface *)(interface))->firstentry)
292 #define STARPU_CSR_GET_ELEMSIZE(interface) (((struct starpu_csr_interface *)(interface))->elemsize)
293 
295 {
296  uint32_t nnz;
297  uint32_t nrow;
298 
299  uintptr_t nzval;
300  uint32_t *colind;
301  uint32_t *rowptr;
302 
303  uint32_t firstentry;
304 
305  uint32_t r;
306  uint32_t c;
307 
308  size_t elemsize;
309 };
310 
311 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);
312 
313 #define STARPU_BCSR_GET_NNZ(interface) (((struct starpu_bcsr_interface *)(interface))->nnz)
314 #define STARPU_BCSR_GET_NZVAL(interface) (((struct starpu_bcsr_interface *)(interface))->nzval)
315 #define STARPU_BCSR_GET_NZVAL_DEV_HANDLE(interface) \
316  (((struct starpu_bcsr_interface *)(interface))->nnz)
317 #define STARPU_BCSR_GET_COLIND(interface) (((struct starpu_bcsr_interface *)(interface))->colind)
318 #define STARPU_BCSR_GET_COLIND_DEV_HANDLE(interface) \
319  (((struct starpu_bcsr_interface *)(interface))->colind)
320 #define STARPU_BCSR_GET_ROWPTR(interface) (((struct starpu_bcsr_interface *)(interface))->rowptr)
321 #define STARPU_BCSR_GET_ROWPTR_DEV_HANDLE(interface) \
322  (((struct starpu_bcsr_interface *)(interface))->rowptr)
323 #define STARPU_BCSR_GET_OFFSET 0
330 uint32_t starpu_bcsr_get_r(starpu_data_handle_t handle);
331 uint32_t starpu_bcsr_get_c(starpu_data_handle_t handle);
333 
335 {
336  size_t cpu_elemsize;
343 };
344 
346 {
347  void *cpu_ptr;
348  void *cuda_ptr;
349  void *opencl_ptr;
350  uint32_t nx;
352 };
353 
354 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);
355 
356 #define STARPU_MULTIFORMAT_GET_CPU_PTR(interface) (((struct starpu_multiformat_interface *)(interface))->cpu_ptr)
357 #define STARPU_MULTIFORMAT_GET_CUDA_PTR(interface) (((struct starpu_multiformat_interface *)(interface))->cuda_ptr)
358 #define STARPU_MULTIFORMAT_GET_OPENCL_PTR(interface) (((struct starpu_multiformat_interface *)(interface))->opencl_ptr)
359 #define STARPU_MULTIFORMAT_GET_NX(interface) (((struct starpu_multiformat_interface *)(interface))->nx)
360 
362 
363 int starpu_data_pack(starpu_data_handle_t handle, void **ptr, starpu_ssize_t *count);
364 int starpu_data_unpack(starpu_data_handle_t handle, void *ptr, size_t count);
366 
368 
369 #ifdef __cplusplus
370 }
371 #endif
372 
373 #endif /* __STARPU_DATA_INTERFACES_H__ */