StarPU Handbook
starpu_mpi.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2009-2012,2014-2017 Université de Bordeaux
4  * Copyright (C) 2010-2018 CNRS
5  * Copyright (C) 2016 Inria
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_MPI_H__
20 #define __STARPU_MPI_H__
21 
22 #include <starpu.h>
23 
24 #if defined(STARPU_USE_MPI)
25 
26 #include <mpi.h>
27 
28 #ifdef __cplusplus
29 extern "C"
30 {
31 #endif
32 
33 typedef void *starpu_mpi_req;
34 
35 int starpu_mpi_isend(starpu_data_handle_t data_handle, starpu_mpi_req *req, int dest, int mpi_tag, MPI_Comm comm);
36 int starpu_mpi_irecv(starpu_data_handle_t data_handle, starpu_mpi_req *req, int source, int mpi_tag, MPI_Comm comm);
37 int starpu_mpi_send(starpu_data_handle_t data_handle, int dest, int mpi_tag, MPI_Comm comm);
38 int starpu_mpi_recv(starpu_data_handle_t data_handle, int source, int mpi_tag, MPI_Comm comm, MPI_Status *status);
39 int starpu_mpi_isend_detached(starpu_data_handle_t data_handle, int dest, int mpi_tag, MPI_Comm comm, void (*callback)(void *), void *arg);
40 int starpu_mpi_irecv_detached(starpu_data_handle_t data_handle, int source, int mpi_tag, MPI_Comm comm, void (*callback)(void *), void *arg);
41 int starpu_mpi_issend(starpu_data_handle_t data_handle, starpu_mpi_req *req, int dest, int mpi_tag, MPI_Comm comm);
42 int starpu_mpi_issend_detached(starpu_data_handle_t data_handle, int dest, int mpi_tag, MPI_Comm comm, void (*callback)(void *), void *arg);
43 int starpu_mpi_wait(starpu_mpi_req *req, MPI_Status *status);
44 int starpu_mpi_test(starpu_mpi_req *req, int *flag, MPI_Status *status);
45 int starpu_mpi_barrier(MPI_Comm comm);
46 
47 int starpu_mpi_irecv_detached_sequential_consistency(starpu_data_handle_t data_handle, int source, int mpi_tag, MPI_Comm comm, void (*callback)(void *), void *arg, int sequential_consistency);
48 
49 int starpu_mpi_init_comm(int *argc, char ***argv, int initialize_mpi, MPI_Comm comm);
50 int starpu_mpi_init(int *argc, char ***argv, int initialize_mpi);
51 int starpu_mpi_initialize(void) STARPU_DEPRECATED;
52 int starpu_mpi_initialize_extended(int *rank, int *world_size) STARPU_DEPRECATED;
53 int starpu_mpi_shutdown(void);
54 
55 struct starpu_task *starpu_mpi_task_build(MPI_Comm comm, struct starpu_codelet *codelet, ...);
56 int starpu_mpi_task_post_build(MPI_Comm comm, struct starpu_codelet *codelet, ...);
57 int starpu_mpi_task_insert(MPI_Comm comm, struct starpu_codelet *codelet, ...);
58 /* the function starpu_mpi_insert_task has the same semantics as starpu_mpi_task_insert, it is kept to avoid breaking old codes */
59 int starpu_mpi_insert_task(MPI_Comm comm, struct starpu_codelet *codelet, ...);
60 
61 void starpu_mpi_get_data_on_node(MPI_Comm comm, starpu_data_handle_t data_handle, int node);
62 void starpu_mpi_get_data_on_node_detached(MPI_Comm comm, starpu_data_handle_t data_handle, int node, void (*callback)(void*), void *arg);
64 void starpu_mpi_redux_data(MPI_Comm comm, starpu_data_handle_t data_handle);
65 
66 int starpu_mpi_scatter_detached(starpu_data_handle_t *data_handles, int count, int root, MPI_Comm comm, void (*scallback)(void *), void *sarg, void (*rcallback)(void *), void *rarg);
67 int starpu_mpi_gather_detached(starpu_data_handle_t *data_handles, int count, int root, MPI_Comm comm, void (*scallback)(void *), void *sarg, void (*rcallback)(void *), void *rarg);
68 
69 int starpu_mpi_isend_detached_unlock_tag(starpu_data_handle_t data_handle, int dest, int mpi_tag, MPI_Comm comm, starpu_tag_t tag);
70 int starpu_mpi_irecv_detached_unlock_tag(starpu_data_handle_t data_handle, int source, int mpi_tag, MPI_Comm comm, starpu_tag_t tag);
71 
72 int starpu_mpi_isend_array_detached_unlock_tag(unsigned array_size, starpu_data_handle_t *data_handle, int *dest, int *mpi_tag, MPI_Comm *comm, starpu_tag_t tag);
73 int starpu_mpi_irecv_array_detached_unlock_tag(unsigned array_size, starpu_data_handle_t *data_handle, int *source, int *mpi_tag, MPI_Comm *comm, starpu_tag_t tag);
74 
75 void starpu_mpi_comm_amounts_retrieve(size_t *comm_amounts);
76 
77 void starpu_mpi_cache_flush(MPI_Comm comm, starpu_data_handle_t data_handle);
78 void starpu_mpi_cache_flush_all_data(MPI_Comm comm);
79 
81 int starpu_mpi_cached_send(starpu_data_handle_t data_handle, int dest);
82 
83 int starpu_mpi_comm_size(MPI_Comm comm, int *size);
84 int starpu_mpi_comm_rank(MPI_Comm comm, int *rank);
85 int starpu_mpi_world_rank(void);
86 int starpu_mpi_world_size(void);
87 
90 
91 void starpu_mpi_data_register_comm(starpu_data_handle_t data_handle, int tag, int rank, MPI_Comm comm);
92 #define starpu_mpi_data_register(data_handle, tag, rank) starpu_mpi_data_register_comm(data_handle, tag, rank, MPI_COMM_WORLD)
93 
94 #define STARPU_MPI_PER_NODE -2
95 
96 void starpu_mpi_data_set_rank_comm(starpu_data_handle_t handle, int rank, MPI_Comm comm);
97 #define starpu_mpi_data_set_rank(handle, rank) starpu_mpi_data_set_rank_comm(handle, rank, MPI_COMM_WORLD)
98 void starpu_mpi_data_set_tag(starpu_data_handle_t handle, int tag);
99 #define starpu_data_set_rank starpu_mpi_data_set_rank
100 #define starpu_data_set_tag starpu_mpi_data_set_tag
101 
104 #define starpu_data_get_rank starpu_mpi_data_get_rank
105 #define starpu_data_get_tag starpu_mpi_data_get_tag
106 
107 void starpu_mpi_data_migrate(MPI_Comm comm, starpu_data_handle_t handle, int new_rank);
108 
109 #define STARPU_MPI_NODE_SELECTION_CURRENT_POLICY -1
110 #define STARPU_MPI_NODE_SELECTION_MOST_R_DATA 0
111 
112 typedef int (*starpu_mpi_select_node_policy_func_t)(int me, int nb_nodes, struct starpu_data_descr *descr, int nb_data);
113 int starpu_mpi_node_selection_register_policy(starpu_mpi_select_node_policy_func_t policy_func);
115 
118 
120 int starpu_mpi_cache_set(int enabled);
121 
122 int starpu_mpi_wait_for_all(MPI_Comm comm);
123 
124 typedef void (*starpu_mpi_datatype_allocate_func_t)(starpu_data_handle_t, MPI_Datatype *);
125 typedef void (*starpu_mpi_datatype_free_func_t)(MPI_Datatype *);
126 int starpu_mpi_datatype_register(starpu_data_handle_t handle, starpu_mpi_datatype_allocate_func_t allocate_datatype_func, starpu_mpi_datatype_free_func_t free_datatype_func);
127 int starpu_mpi_datatype_unregister(starpu_data_handle_t handle);
128 
129 #define STARPU_MPI_TAG_UB MPI_TAG_UB
130 int starpu_mpi_comm_get_attr(MPI_Comm comm, int keyval, void *attribute_val, int *flag);
131 
132 #ifdef __cplusplus
133 }
134 #endif
135 
136 #endif // STARPU_USE_MPI
137 #endif // __STARPU_MPI_H__
int starpu_mpi_node_selection_get_current_policy()
int starpu_mpi_irecv_detached(starpu_data_handle_t data_handle, int source, int mpi_tag, MPI_Comm comm, void(*callback)(void *), void *arg)
Definition: starpu_task.h:89
int starpu_mpi_task_post_build(MPI_Comm comm, struct starpu_codelet *codelet,...)
void starpu_mpi_get_data_on_node(MPI_Comm comm, starpu_data_handle_t data_handle, int node)
int starpu_mpi_node_selection_register_policy(starpu_mpi_select_node_policy_func_t policy_func)
int starpu_mpi_world_size(void)
void starpu_mpi_data_set_tag(starpu_data_handle_t handle, int tag)
int starpu_mpi_data_get_tag(starpu_data_handle_t handle)
int starpu_mpi_init(int *argc, char ***argv, int initialize_mpi)
int starpu_mpi_isend_detached(starpu_data_handle_t data_handle, int dest, int mpi_tag, MPI_Comm comm, void(*callback)(void *), void *arg)
int starpu_mpi_cached_send(starpu_data_handle_t data_handle, int dest)
struct starpu_task * starpu_mpi_task_build(MPI_Comm comm, struct starpu_codelet *codelet,...)
int starpu_mpi_isend_detached_unlock_tag(starpu_data_handle_t data_handle, int dest, int mpi_tag, MPI_Comm comm, starpu_tag_t tag)
int starpu_mpi_initialize(void)
int starpu_mpi_send(starpu_data_handle_t data_handle, int dest, int mpi_tag, MPI_Comm comm)
void starpu_mpi_get_data_on_all_nodes_detached(MPI_Comm comm, starpu_data_handle_t data_handle)
int starpu_mpi_issend_detached(starpu_data_handle_t data_handle, int dest, int mpi_tag, MPI_Comm comm, void(*callback)(void *), void *arg)
int starpu_mpi_world_rank(void)
int starpu_mpi_issend(starpu_data_handle_t data_handle, starpu_mpi_req *req, int dest, int mpi_tag, MPI_Comm comm)
void starpu_mpi_comm_amounts_retrieve(size_t *comm_amounts)
int starpu_mpi_isend_array_detached_unlock_tag(unsigned array_size, starpu_data_handle_t *data_handle, int *dest, int *mpi_tag, MPI_Comm *comm, starpu_tag_t tag)
void starpu_mpi_get_data_on_node_detached(MPI_Comm comm, starpu_data_handle_t data_handle, int node, void(*callback)(void *), void *arg)
int starpu_mpi_irecv_detached_sequential_consistency(starpu_data_handle_t data_handle, int source, int mpi_tag, MPI_Comm comm, void(*callback)(void *), void *arg, int sequential_consistency)
int starpu_mpi_task_insert(MPI_Comm comm, struct starpu_codelet *codelet,...)
int starpu_mpi_initialize_extended(int *rank, int *world_size)
void starpu_mpi_set_communication_tag(int tag)
int starpu_mpi_scatter_detached(starpu_data_handle_t *data_handles, int count, int root, MPI_Comm comm, void(*scallback)(void *), void *sarg, void(*rcallback)(void *), void *rarg)
Definition: starpu_task.h:129
int starpu_mpi_irecv(starpu_data_handle_t data_handle, starpu_mpi_req *req, int source, int mpi_tag, MPI_Comm comm)
int starpu_mpi_comm_size(MPI_Comm comm, int *size)
int starpu_mpi_node_selection_unregister_policy(int policy)
void starpu_mpi_data_set_rank_comm(starpu_data_handle_t handle, int rank, MPI_Comm comm)
int starpu_mpi_datatype_register(starpu_data_handle_t handle, starpu_mpi_datatype_allocate_func_t allocate_datatype_func, starpu_mpi_datatype_free_func_t free_datatype_func)
void starpu_mpi_data_register_comm(starpu_data_handle_t data_handle, int tag, int rank, MPI_Comm comm)
int starpu_mpi_get_communication_tag(void)
int starpu_mpi_data_get_rank(starpu_data_handle_t handle)
void starpu_mpi_cache_flush_all_data(MPI_Comm comm)
uint64_t starpu_tag_t
Definition: starpu_task.h:71
int starpu_mpi_init_comm(int *argc, char ***argv, int initialize_mpi, MPI_Comm comm)
int starpu_mpi_wait_for_all(MPI_Comm comm)
int starpu_mpi_comm_get_attr(MPI_Comm comm, int keyval, void *attribute_val, int *flag)
int starpu_mpi_barrier(MPI_Comm comm)
int starpu_mpi_irecv_array_detached_unlock_tag(unsigned array_size, starpu_data_handle_t *data_handle, int *source, int *mpi_tag, MPI_Comm *comm, starpu_tag_t tag)
int starpu_mpi_node_selection_set_current_policy(int policy)
int starpu_mpi_datatype_unregister(starpu_data_handle_t handle)
int starpu_mpi_cache_is_enabled()
int starpu_mpi_cache_set(int enabled)
int starpu_mpi_comm_rank(MPI_Comm comm, int *rank)
struct _starpu_data_state * starpu_data_handle_t
Definition: starpu_data.h:30
void starpu_mpi_redux_data(MPI_Comm comm, starpu_data_handle_t data_handle)
int starpu_mpi_cached_receive(starpu_data_handle_t data_handle)
int starpu_mpi_isend(starpu_data_handle_t data_handle, starpu_mpi_req *req, int dest, int mpi_tag, MPI_Comm comm)
Definition: starpu_data.h:48
int starpu_mpi_test(starpu_mpi_req *req, int *flag, MPI_Status *status)
int starpu_mpi_irecv_detached_unlock_tag(starpu_data_handle_t data_handle, int source, int mpi_tag, MPI_Comm comm, starpu_tag_t tag)
starpu_data_handle_t handle
Definition: starpu_data.h:50
int starpu_mpi_shutdown(void)
void starpu_mpi_data_migrate(MPI_Comm comm, starpu_data_handle_t handle, int new_rank)
int starpu_mpi_recv(starpu_data_handle_t data_handle, int source, int mpi_tag, MPI_Comm comm, MPI_Status *status)
int starpu_mpi_wait(starpu_mpi_req *req, MPI_Status *status)
int starpu_mpi_insert_task(MPI_Comm comm, struct starpu_codelet *codelet,...)
void starpu_mpi_cache_flush(MPI_Comm comm, starpu_data_handle_t data_handle)
int starpu_mpi_gather_detached(starpu_data_handle_t *data_handles, int count, int root, MPI_Comm comm, void(*scallback)(void *), void *sarg, void(*rcallback)(void *), void *rarg)