StarPU Handbook
starpu_data.h
Go to the documentation of this file.
1/* StarPU --- Runtime system for heterogeneous multicore architectures.
2 *
3 * Copyright (C) 2009-2022 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 __STARPU_DATA_H__
18#define __STARPU_DATA_H__
19
20#include <starpu.h>
21
22#ifdef __cplusplus
23extern "C"
24{
25#endif
26
35struct _starpu_data_state;
44typedef struct _starpu_data_state* starpu_data_handle_t;
45
55{
57 STARPU_R=(1<<0),
58 STARPU_W=(1<<1),
60 STARPU_SCRATCH=(1<<2),
85 STARPU_REDUX = (1 << 3),
99 STARPU_COMMUTE=(1<<4),
109 STARPU_SSEND=(1<<5),
114 STARPU_LOCALITY=(1<<6),
126 STARPU_NOPLAN=(1<<8),
131
133
138
144void starpu_data_set_coordinates_array(starpu_data_handle_t handle, unsigned dimensions, int dims[]);
145
151void starpu_data_set_coordinates(starpu_data_handle_t handle, unsigned dimensions, ...);
152
159unsigned starpu_data_get_coordinates_array(starpu_data_handle_t handle, unsigned dimensions, int dims[]);
160
172
179
191
199
205
210void starpu_data_advise_as_important(starpu_data_handle_t handle, unsigned is_important);
211
223#define STARPU_ACQUIRE_NO_NODE -1
224
230#define STARPU_ACQUIRE_NO_NODE_LOCK_ALL -2
231
252
260
273int starpu_data_acquire_cb(starpu_data_handle_t handle, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg);
274
282int starpu_data_acquire_on_node_cb(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg);
283
298int 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);
299
307int 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);
308
309int starpu_data_acquire_on_node_cb_sequential_consistency_quick(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode, void (*callback)(void *), void *arg, int sequential_consistency, int quick);
310
318int 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, int quick, long *pre_sync_jobid, long *post_sync_jobid);
319
330
339
340#ifdef __GCC__
341
350# define STARPU_DATA_ACQUIRE_CB(handle, mode, code) do \
351 { \ \
352 void callback(void *arg) \
353 { \
354 code; \
355 starpu_data_release(handle); \
356 } \
357 starpu_data_acquire_cb(handle, mode, callback, NULL); \
358 } \
359 while(0)
360#endif
361
368
376
384typedef struct starpu_arbiter *starpu_arbiter_t;
385
391
396
402
408
418int starpu_data_fetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
419
429int starpu_data_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
430
431int starpu_data_prefetch_on_node_prio(starpu_data_handle_t handle, unsigned node, unsigned async, int prio);
432
441int starpu_data_idle_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async);
442int starpu_data_idle_prefetch_on_node_prio(starpu_data_handle_t handle, unsigned node, unsigned async, int prio);
443
448unsigned starpu_data_is_on_node(starpu_data_handle_t handle, unsigned node);
449
457
467void starpu_data_set_wt_mask(starpu_data_handle_t handle, uint32_t wt_mask);
468
490
495
500
511
524
528void starpu_data_query_status(starpu_data_handle_t handle, int memory_node, int *is_allocated, int *is_valid, int *is_requested);
529
530struct starpu_codelet;
531
539
540struct starpu_data_interface_ops* starpu_data_get_interface_ops(starpu_data_handle_t handle);
541
542unsigned starpu_data_test_if_allocated_on_node(starpu_data_handle_t handle, unsigned memory_node);
543
544void starpu_memchunk_tidy(unsigned memory_node);
545
553
558
561#ifdef __cplusplus
562}
563#endif
564
565#endif /* __STARPU_DATA_H__ */
Definition: starpu_task.h:250
char * name
Definition: starpu_data_interfaces.h:568
Definition: starpu_data_interfaces.h:366
void starpu_data_set_user_data(starpu_data_handle_t handle, void *user_data)
void starpu_data_invalidate_submit(starpu_data_handle_t handle)
void starpu_data_set_default_sequential_consistency_flag(unsigned flag)
void starpu_data_set_reduction_methods(starpu_data_handle_t handle, struct starpu_codelet *redux_cl, struct starpu_codelet *init_cl)
starpu_data_access_mode
Definition: starpu_data.h:55
void starpu_data_set_sequential_consistency_flag(starpu_data_handle_t handle, unsigned flag)
void starpu_arbiter_destroy(starpu_arbiter_t arbiter)
int starpu_data_acquire_cb(starpu_data_handle_t handle, enum starpu_data_access_mode mode, void(*callback)(void *), void *arg)
int starpu_data_acquire_on_node(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode)
void starpu_data_invalidate(starpu_data_handle_t handle)
void starpu_data_unregister_submit(starpu_data_handle_t handle)
int starpu_data_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async)
void starpu_data_unregister(starpu_data_handle_t handle)
void starpu_data_release_on_node(starpu_data_handle_t handle, int node)
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)
int starpu_data_acquire_on_node_try(starpu_data_handle_t handle, int node, enum starpu_data_access_mode mode)
unsigned starpu_data_get_ooc_flag(starpu_data_handle_t handle)
starpu_arbiter_t starpu_arbiter_create(void) STARPU_ATTRIBUTE_MALLOC
unsigned starpu_data_get_coordinates_array(starpu_data_handle_t handle, unsigned dimensions, int dims[])
void starpu_data_set_ooc_flag(starpu_data_handle_t handle, unsigned flag)
unsigned starpu_data_is_on_node(starpu_data_handle_t handle, unsigned node)
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)
int starpu_data_acquire_try(starpu_data_handle_t handle, enum starpu_data_access_mode mode)
void starpu_data_query_status(starpu_data_handle_t handle, int memory_node, int *is_allocated, int *is_valid, int *is_requested)
void starpu_data_assign_arbiter(starpu_data_handle_t handle, starpu_arbiter_t arbiter)
int starpu_data_fetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async)
void starpu_data_set_coordinates_array(starpu_data_handle_t handle, unsigned dimensions, int dims[])
void starpu_data_unregister_no_coherency(starpu_data_handle_t handle)
void starpu_data_set_name(starpu_data_handle_t handle, const char *name)
void * starpu_data_get_user_data(starpu_data_handle_t handle)
void starpu_data_set_coordinates(starpu_data_handle_t handle, unsigned dimensions,...)
struct starpu_arbiter * starpu_arbiter_t
Definition: starpu_data.h:384
int starpu_data_request_allocation(starpu_data_handle_t handle, unsigned node)
unsigned starpu_data_get_sequential_consistency_flag(starpu_data_handle_t handle)
int starpu_data_idle_prefetch_on_node(starpu_data_handle_t handle, unsigned node, unsigned async)
struct _starpu_data_state * starpu_data_handle_t
Definition: starpu_data.h:44
void starpu_data_release(starpu_data_handle_t handle)
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, int quick, long *pre_sync_jobid, long *post_sync_jobid)
void starpu_data_set_wt_mask(starpu_data_handle_t handle, uint32_t wt_mask)
int starpu_data_acquire(starpu_data_handle_t handle, enum starpu_data_access_mode mode)
void starpu_data_advise_as_important(starpu_data_handle_t handle, unsigned is_important)
unsigned starpu_data_get_default_sequential_consistency_flag(void)
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)
void starpu_data_wont_use(starpu_data_handle_t handle)
@ STARPU_SCRATCH
Definition: starpu_data.h:60
@ STARPU_ACCESS_MODE_MAX
Definition: starpu_data.h:128
@ STARPU_SSEND
Definition: starpu_data.h:109
@ STARPU_W
Definition: starpu_data.h:58
@ STARPU_RW
Definition: starpu_data.h:59
@ STARPU_REDUX
Definition: starpu_data.h:85
@ STARPU_R
Definition: starpu_data.h:57
@ STARPU_COMMUTE
Definition: starpu_data.h:99
@ STARPU_LOCALITY
Definition: starpu_data.h:114
@ STARPU_NOPLAN
Definition: starpu_data.h:126
@ STARPU_NONE
Definition: starpu_data.h:56
#define STARPU_ATTRIBUTE_MALLOC
Definition: starpu_util.h:112