StarPU Internal Handbook
node_ops.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2008-2023 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 __NODE_OPS_H__
18 #define __NODE_OPS_H__
19 
22 #include <starpu.h>
23 #include <common/config.h>
24 #include <datawizard/copy_driver.h>
25 
26 #pragma GCC visibility push(hidden)
27 
39 typedef int (*copy_interface_func_t)(starpu_data_handle_t handle, void *src_interface, unsigned src_node,
40  void *dst_interface, unsigned dst_node,
41  struct _starpu_data_request *req);
42 
49 typedef int (*copy_data_t)(uintptr_t src_ptr, size_t src_offset, unsigned src_node,
50  uintptr_t dst_ptr, size_t dst_offset, unsigned dst_node,
51  size_t ssize, struct _starpu_async_channel *async_channel);
52 
57 typedef int (*copy2d_data_t)(uintptr_t src_ptr, size_t src_offset, unsigned src_node,
58  uintptr_t dst_ptr, size_t dst_offset, unsigned dst_node,
59  size_t blocksize,
60  size_t numblocks, size_t ld_src, size_t ld_dst,
61  struct _starpu_async_channel *async_channel);
62 
72 typedef int (*copy3d_data_t)(uintptr_t src_ptr, size_t src_offset, unsigned src_node,
73  uintptr_t dst_ptr, size_t dst_offset, unsigned dst_node,
74  size_t blocksize,
75  size_t numblocks_1, size_t ld1_src, size_t ld1_dst,
76  size_t numblocks_2, size_t ld2_src, size_t ld2_dst,
77  struct _starpu_async_channel *async_channel);
78 
81 typedef uintptr_t (*map_t)(uintptr_t src, size_t src_offset, unsigned src_node, unsigned dst_node, size_t size, int *ret);
84 typedef int (*unmap_t)(uintptr_t src, size_t src_offset, unsigned src_node, uintptr_t dst, unsigned dst_node, size_t size);
87 typedef int (*update_map_t)(uintptr_t src, size_t src_offset, unsigned src_node, uintptr_t dst, size_t dst_offset, unsigned dst_node, size_t size);
88 
92 {
96 
100 
104 
108 
113 
118 
123 
128 
130  void (*wait_request_completion)(struct _starpu_async_channel *async_channel);
132  unsigned (*test_request_completion)(struct _starpu_async_channel *async_channel);
133 
143  int (*is_direct_access_supported)(unsigned node, unsigned handling_node);
144 
147  uintptr_t (*malloc_on_node)(unsigned dst_node, size_t size, int flags);
150  void (*free_on_node)(unsigned dst_node, uintptr_t addr, size_t size, int flags);
151 
155 
159 
164 
166  char *name;
167 };
168 
169 const char* _starpu_node_get_prefix(enum starpu_node_kind kind);
170 
171 #pragma GCC visibility pop
172 
173 #endif // __NODE_OPS_H__
Definition: copy_driver.h:71
starpu_node_kind
Definition: starpu_worker.h:44
@ STARPU_MAX_RAM
Definition: starpu_worker.h:54
int(* copy2d_data_t)(uintptr_t src_ptr, size_t src_offset, unsigned src_node, uintptr_t dst_ptr, size_t dst_offset, unsigned dst_node, size_t blocksize, size_t numblocks, size_t ld_src, size_t ld_dst, struct _starpu_async_channel *async_channel)
Definition: node_ops.h:57
int(* copy3d_data_t)(uintptr_t src_ptr, size_t src_offset, unsigned src_node, uintptr_t dst_ptr, size_t dst_offset, unsigned dst_node, size_t blocksize, size_t numblocks_1, size_t ld1_src, size_t ld1_dst, size_t numblocks_2, size_t ld2_src, size_t ld2_dst, struct _starpu_async_channel *async_channel)
Definition: node_ops.h:72
uintptr_t(* map_t)(uintptr_t src, size_t src_offset, unsigned src_node, unsigned dst_node, size_t size, int *ret)
Definition: node_ops.h:81
int(* copy_data_t)(uintptr_t src_ptr, size_t src_offset, unsigned src_node, uintptr_t dst_ptr, size_t dst_offset, unsigned dst_node, size_t ssize, struct _starpu_async_channel *async_channel)
Definition: node_ops.h:49
int(* update_map_t)(uintptr_t src, size_t src_offset, unsigned src_node, uintptr_t dst, size_t dst_offset, unsigned dst_node, size_t size)
Definition: node_ops.h:87
int(* copy_interface_func_t)(starpu_data_handle_t handle, void *src_interface, unsigned src_node, void *dst_interface, unsigned dst_node, struct _starpu_data_request *req)
Definition: node_ops.h:39
int(* unmap_t)(uintptr_t src, size_t src_offset, unsigned src_node, uintptr_t dst, unsigned dst_node, size_t size)
Definition: node_ops.h:84
Definition: node_ops.h:92
void(* free_on_node)(unsigned dst_node, uintptr_t addr, size_t size, int flags)
Definition: node_ops.h:150
copy2d_data_t copy2d_data_to[STARPU_MAX_RAM+1]
Definition: node_ops.h:112
copy_data_t copy_data_from[STARPU_MAX_RAM+1]
Definition: node_ops.h:107
copy_interface_func_t copy_interface_from[STARPU_MAX_RAM+1]
Definition: node_ops.h:99
copy3d_data_t copy3d_data_from[STARPU_MAX_RAM+1]
Definition: node_ops.h:127
int(* is_direct_access_supported)(unsigned node, unsigned handling_node)
Definition: node_ops.h:143
unsigned(* test_request_completion)(struct _starpu_async_channel *async_channel)
Definition: node_ops.h:132
map_t map[STARPU_MAX_RAM+1]
Definition: node_ops.h:154
unmap_t unmap[STARPU_MAX_RAM+1]
Definition: node_ops.h:158
update_map_t update_map[STARPU_MAX_RAM+1]
Definition: node_ops.h:163
copy2d_data_t copy2d_data_from[STARPU_MAX_RAM+1]
Definition: node_ops.h:117
copy_data_t copy_data_to[STARPU_MAX_RAM+1]
Definition: node_ops.h:103
void(* wait_request_completion)(struct _starpu_async_channel *async_channel)
Definition: node_ops.h:130
char * name
Definition: node_ops.h:166
copy3d_data_t copy3d_data_to[STARPU_MAX_RAM+1]
Definition: node_ops.h:122
copy_interface_func_t copy_interface_to[STARPU_MAX_RAM+1]
Definition: node_ops.h:95
uintptr_t(* malloc_on_node)(unsigned dst_node, size_t size, int flags)
Definition: node_ops.h:147