StarPU Handbook
starpu_mpi.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2013,2016 Inria
4  * Copyright (C) 2010-2019 CNRS
5  * Copyright (C) 2009-2012,2014-2018 Université de Bordeaux
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 #include <stdint.h>
28 
29 #ifdef __cplusplus
30 extern "C"
31 {
32 #endif
33 
52 int starpu_mpi_init_conf(int *argc, char ***argv, int initialize_mpi, MPI_Comm comm, struct starpu_conf *conf);
53 
59 int starpu_mpi_init_comm(int *argc, char ***argv, int initialize_mpi, MPI_Comm comm);
60 
64 int starpu_mpi_init(int *argc, char ***argv, int initialize_mpi);
65 
72 int starpu_mpi_initialize(void) STARPU_DEPRECATED;
73 
81 int starpu_mpi_initialize_extended(int *rank, int *world_size) STARPU_DEPRECATED;
82 
89 int starpu_mpi_shutdown(void);
90 
97 void starpu_mpi_comm_amounts_retrieve(size_t *comm_amounts);
98 
102 int starpu_mpi_comm_size(MPI_Comm comm, int *size);
103 
108 int starpu_mpi_comm_rank(MPI_Comm comm, int *rank);
109 
114 int starpu_mpi_world_rank(void);
115 
119 int starpu_mpi_world_size(void);
120 
125 #define STARPU_MPI_TAG_UB MPI_TAG_UB
126 
135 int starpu_mpi_comm_get_attr(MPI_Comm comm, int keyval, void *attribute_val, int *flag);
136 
137 int starpu_mpi_get_communication_tag(void);
138 void starpu_mpi_set_communication_tag(int tag);
139 
151 typedef void *starpu_mpi_req;
152 
156 typedef int64_t starpu_mpi_tag_t;
157 
165 int starpu_mpi_isend(starpu_data_handle_t data_handle, starpu_mpi_req *req, int dest, starpu_mpi_tag_t data_tag, MPI_Comm comm);
166 
170 int starpu_mpi_isend_prio(starpu_data_handle_t data_handle, starpu_mpi_req *req, int dest, starpu_mpi_tag_t data_tag, int prio, MPI_Comm comm);
171 
178 int starpu_mpi_irecv(starpu_data_handle_t data_handle, starpu_mpi_req *req, int source, starpu_mpi_tag_t data_tag, MPI_Comm comm);
179 
185 int starpu_mpi_send(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, MPI_Comm comm);
186 
190 int starpu_mpi_send_prio(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, int prio, MPI_Comm comm);
191 
197 int starpu_mpi_recv(starpu_data_handle_t data_handle, int source, starpu_mpi_tag_t data_tag, MPI_Comm comm, MPI_Status *status);
198 
209 int starpu_mpi_isend_detached(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, MPI_Comm comm, void (*callback)(void *), void *arg);
210 
214 int starpu_mpi_isend_detached_prio(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, int prio, MPI_Comm comm, void (*callback)(void *), void *arg);
215 
226 int starpu_mpi_irecv_detached(starpu_data_handle_t data_handle, int source, starpu_mpi_tag_t data_tag, MPI_Comm comm, void (*callback)(void *), void *arg);
227 
243 int starpu_mpi_irecv_detached_sequential_consistency(starpu_data_handle_t data_handle, int source, starpu_mpi_tag_t data_tag, MPI_Comm comm, void (*callback)(void *), void *arg, int sequential_consistency);
244 
250 int starpu_mpi_issend(starpu_data_handle_t data_handle, starpu_mpi_req *req, int dest, starpu_mpi_tag_t data_tag, MPI_Comm comm);
251 
255 int starpu_mpi_issend_prio(starpu_data_handle_t data_handle, starpu_mpi_req *req, int dest, starpu_mpi_tag_t data_tag, int prio, MPI_Comm comm);
256 
267 int starpu_mpi_issend_detached(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, MPI_Comm comm, void (*callback)(void *), void *arg);
268 
272 int starpu_mpi_issend_detached_prio(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, int prio, MPI_Comm comm, void (*callback)(void *), void *arg);
273 
277 int starpu_mpi_wait(starpu_mpi_req *req, MPI_Status *status);
278 
284 int starpu_mpi_test(starpu_mpi_req *req, int *flag, MPI_Status *status);
285 
290 int starpu_mpi_barrier(MPI_Comm comm);
291 
296 int starpu_mpi_wait_for_all(MPI_Comm comm);
297 
303 int starpu_mpi_isend_detached_unlock_tag(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, MPI_Comm comm, starpu_tag_t tag);
304 
309 int starpu_mpi_isend_detached_unlock_tag_prio(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, int prio, MPI_Comm comm, starpu_tag_t tag);
310 
316 int starpu_mpi_irecv_detached_unlock_tag(starpu_data_handle_t data_handle, int source, starpu_mpi_tag_t data_tag, MPI_Comm comm, starpu_tag_t tag);
317 
325 int starpu_mpi_isend_array_detached_unlock_tag(unsigned array_size, starpu_data_handle_t *data_handle, int *dest, starpu_mpi_tag_t *data_tag, MPI_Comm *comm, starpu_tag_t tag);
326 
331 int starpu_mpi_isend_array_detached_unlock_tag_prio(unsigned array_size, starpu_data_handle_t *data_handle, int *dest, starpu_mpi_tag_t *data_tag, int *prio, MPI_Comm *comm, starpu_tag_t tag);
332 
340 int starpu_mpi_irecv_array_detached_unlock_tag(unsigned array_size, starpu_data_handle_t *data_handle, int *source, starpu_mpi_tag_t *data_tag, MPI_Comm *comm, starpu_tag_t tag);
341 
342 typedef void (*starpu_mpi_datatype_allocate_func_t)(starpu_data_handle_t, MPI_Datatype *);
343 typedef void (*starpu_mpi_datatype_free_func_t)(MPI_Datatype *);
344 
352 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);
353 
359 
371 
376 int starpu_mpi_cache_set(int enabled);
377 
385 void starpu_mpi_cache_flush(MPI_Comm comm, starpu_data_handle_t data_handle);
386 
394 void starpu_mpi_cache_flush_all_data(MPI_Comm comm);
395 
402 
408 int starpu_mpi_cached_send(starpu_data_handle_t data_handle, int dest);
409 
425 #define STARPU_MPI_PER_NODE -2
426 
432 void starpu_mpi_data_register_comm(starpu_data_handle_t data_handle, starpu_mpi_tag_t data_tag, int rank, MPI_Comm comm);
433 
440 #define starpu_mpi_data_register(data_handle, data_tag, rank) starpu_mpi_data_register_comm(data_handle, data_tag, rank, MPI_COMM_WORLD)
441 
449 
453 #define starpu_data_set_tag starpu_mpi_data_set_tag
454 
461 void starpu_mpi_data_set_rank_comm(starpu_data_handle_t handle, int rank, MPI_Comm comm);
462 
469 #define starpu_mpi_data_set_rank(handle, rank) starpu_mpi_data_set_rank_comm(handle, rank, MPI_COMM_WORLD)
470 
474 #define starpu_data_set_rank starpu_mpi_data_set_rank
475 
480 
484 #define starpu_data_get_rank starpu_mpi_data_get_rank
485 
490 
494 #define starpu_data_get_tag starpu_mpi_data_get_tag
495 
550 int starpu_mpi_task_insert(MPI_Comm comm, struct starpu_codelet *codelet, ...);
551 
555 int starpu_mpi_insert_task(MPI_Comm comm, struct starpu_codelet *codelet, ...);
556 
570 struct starpu_task *starpu_mpi_task_build(MPI_Comm comm, struct starpu_codelet *codelet, ...);
571 
577 int starpu_mpi_task_post_build(MPI_Comm comm, struct starpu_codelet *codelet, ...);
578 
584 void starpu_mpi_get_data_on_node(MPI_Comm comm, starpu_data_handle_t data_handle, int node);
585 
592 void starpu_mpi_get_data_on_node_detached(MPI_Comm comm, starpu_data_handle_t data_handle, int node, void (*callback)(void*), void *arg);
593 
598 void starpu_mpi_get_data_on_all_nodes_detached(MPI_Comm comm, starpu_data_handle_t data_handle);
599 
610 void starpu_mpi_data_migrate(MPI_Comm comm, starpu_data_handle_t handle, int new_rank);
611 
620 #define STARPU_MPI_NODE_SELECTION_CURRENT_POLICY -1
621 #define STARPU_MPI_NODE_SELECTION_MOST_R_DATA 0
622 
623 typedef int (*starpu_mpi_select_node_policy_func_t)(int me, int nb_nodes, struct starpu_data_descr *descr, int nb_data);
624 
655 int starpu_mpi_node_selection_register_policy(starpu_mpi_select_node_policy_func_t policy_func);
656 
661 
667 
675 
688 void starpu_mpi_redux_data(MPI_Comm comm, starpu_data_handle_t data_handle);
689 
693 void starpu_mpi_redux_data_prio(MPI_Comm comm, starpu_data_handle_t data_handle, int prio);
694 
705 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);
706 
717 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);
718 
721 int starpu_mpi_pre_submit_hook_register(void (*f)(struct starpu_task *));
722 int starpu_mpi_pre_submit_hook_unregister();
723 
726 #ifdef __cplusplus
727 }
728 #endif
729 
730 #endif // STARPU_USE_MPI
731 #endif // __STARPU_MPI_H__
starpu_mpi_node_selection_register_policy
int starpu_mpi_node_selection_register_policy(starpu_mpi_select_node_policy_func_t policy_func)
starpu_mpi_init
int starpu_mpi_init(int *argc, char ***argv, int initialize_mpi)
starpu_mpi_isend_prio
int starpu_mpi_isend_prio(starpu_data_handle_t data_handle, starpu_mpi_req *req, int dest, starpu_mpi_tag_t data_tag, int prio, MPI_Comm comm)
starpu_mpi_comm_rank
int starpu_mpi_comm_rank(MPI_Comm comm, int *rank)
starpu_conf
Definition: starpu.h:104
starpu_mpi_issend_prio
int starpu_mpi_issend_prio(starpu_data_handle_t data_handle, starpu_mpi_req *req, int dest, starpu_mpi_tag_t data_tag, int prio, MPI_Comm comm)
starpu_mpi_issend
int starpu_mpi_issend(starpu_data_handle_t data_handle, starpu_mpi_req *req, int dest, starpu_mpi_tag_t data_tag, MPI_Comm comm)
starpu_mpi_data_get_rank
int starpu_mpi_data_get_rank(starpu_data_handle_t handle)
starpu_mpi_get_data_on_node
void starpu_mpi_get_data_on_node(MPI_Comm comm, starpu_data_handle_t data_handle, int node)
starpu_mpi_irecv_detached_unlock_tag
int starpu_mpi_irecv_detached_unlock_tag(starpu_data_handle_t data_handle, int source, starpu_mpi_tag_t data_tag, MPI_Comm comm, starpu_tag_t tag)
starpu_mpi_tag_t
int64_t starpu_mpi_tag_t
Definition: starpu_mpi.h:156
starpu_mpi_send
int starpu_mpi_send(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, MPI_Comm comm)
starpu_tag_t
uint64_t starpu_tag_t
Definition: starpu_task_dep.h:129
starpu_mpi_irecv_detached_sequential_consistency
int starpu_mpi_irecv_detached_sequential_consistency(starpu_data_handle_t data_handle, int source, starpu_mpi_tag_t data_tag, MPI_Comm comm, void(*callback)(void *), void *arg, int sequential_consistency)
starpu_mpi_comm_size
int starpu_mpi_comm_size(MPI_Comm comm, int *size)
starpu_mpi_initialize_extended
int starpu_mpi_initialize_extended(int *rank, int *world_size)
starpu_mpi_node_selection_set_current_policy
int starpu_mpi_node_selection_set_current_policy(int policy)
starpu_mpi_isend_detached
int starpu_mpi_isend_detached(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, MPI_Comm comm, void(*callback)(void *), void *arg)
starpu_mpi_data_set_rank_comm
void starpu_mpi_data_set_rank_comm(starpu_data_handle_t handle, int rank, MPI_Comm comm)
starpu_mpi_test
int starpu_mpi_test(starpu_mpi_req *req, int *flag, MPI_Status *status)
starpu_mpi_req
void * starpu_mpi_req
Definition: starpu_mpi.h:151
starpu_mpi_issend_detached
int starpu_mpi_issend_detached(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, MPI_Comm comm, void(*callback)(void *), void *arg)
starpu_codelet
Definition: starpu_task.h:250
starpu_mpi_data_set_tag
void starpu_mpi_data_set_tag(starpu_data_handle_t handle, starpu_mpi_tag_t data_tag)
starpu_mpi_comm_amounts_retrieve
void starpu_mpi_comm_amounts_retrieve(size_t *comm_amounts)
starpu_mpi_comm_get_attr
int starpu_mpi_comm_get_attr(MPI_Comm comm, int keyval, void *attribute_val, int *flag)
starpu_mpi_data_get_tag
starpu_mpi_tag_t starpu_mpi_data_get_tag(starpu_data_handle_t handle)
starpu_mpi_cached_send
int starpu_mpi_cached_send(starpu_data_handle_t data_handle, int dest)
starpu_mpi_recv
int starpu_mpi_recv(starpu_data_handle_t data_handle, int source, starpu_mpi_tag_t data_tag, MPI_Comm comm, MPI_Status *status)
starpu_mpi_datatype_register
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)
starpu_mpi_task_insert
int starpu_mpi_task_insert(MPI_Comm comm, struct starpu_codelet *codelet,...)
starpu_mpi_data_register_comm
void starpu_mpi_data_register_comm(starpu_data_handle_t data_handle, starpu_mpi_tag_t data_tag, int rank, MPI_Comm comm)
starpu_mpi_send_prio
int starpu_mpi_send_prio(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, int prio, MPI_Comm comm)
starpu_mpi_get_data_on_all_nodes_detached
void starpu_mpi_get_data_on_all_nodes_detached(MPI_Comm comm, starpu_data_handle_t data_handle)
starpu_data_handle_t
struct _starpu_data_state * starpu_data_handle_t
Definition: starpu_data.h:46
starpu_mpi_wait_for_all
int starpu_mpi_wait_for_all(MPI_Comm comm)
starpu_mpi_isend_array_detached_unlock_tag_prio
int starpu_mpi_isend_array_detached_unlock_tag_prio(unsigned array_size, starpu_data_handle_t *data_handle, int *dest, starpu_mpi_tag_t *data_tag, int *prio, MPI_Comm *comm, starpu_tag_t tag)
starpu_mpi_node_selection_get_current_policy
int starpu_mpi_node_selection_get_current_policy()
starpu.h
starpu_mpi_redux_data
void starpu_mpi_redux_data(MPI_Comm comm, starpu_data_handle_t data_handle)
starpu_mpi_initialize
int starpu_mpi_initialize(void)
starpu_mpi_isend_array_detached_unlock_tag
int starpu_mpi_isend_array_detached_unlock_tag(unsigned array_size, starpu_data_handle_t *data_handle, int *dest, starpu_mpi_tag_t *data_tag, MPI_Comm *comm, starpu_tag_t tag)
starpu_mpi_cache_set
int starpu_mpi_cache_set(int enabled)
starpu_task
Definition: starpu_task.h:548
starpu_mpi_cache_flush_all_data
void starpu_mpi_cache_flush_all_data(MPI_Comm comm)
starpu_mpi_cache_flush
void starpu_mpi_cache_flush(MPI_Comm comm, starpu_data_handle_t data_handle)
starpu_mpi_world_size
int starpu_mpi_world_size(void)
starpu_mpi_irecv_array_detached_unlock_tag
int starpu_mpi_irecv_array_detached_unlock_tag(unsigned array_size, starpu_data_handle_t *data_handle, int *source, starpu_mpi_tag_t *data_tag, MPI_Comm *comm, starpu_tag_t tag)
starpu_mpi_isend_detached_unlock_tag_prio
int starpu_mpi_isend_detached_unlock_tag_prio(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, int prio, MPI_Comm comm, starpu_tag_t tag)
starpu_mpi_node_selection_unregister_policy
int starpu_mpi_node_selection_unregister_policy(int policy)
starpu_mpi_scatter_detached
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)
starpu_mpi_redux_data_prio
void starpu_mpi_redux_data_prio(MPI_Comm comm, starpu_data_handle_t data_handle, int prio)
starpu_mpi_get_data_on_node_detached
void starpu_mpi_get_data_on_node_detached(MPI_Comm comm, starpu_data_handle_t data_handle, int node, void(*callback)(void *), void *arg)
starpu_mpi_insert_task
int starpu_mpi_insert_task(MPI_Comm comm, struct starpu_codelet *codelet,...)
starpu_mpi_task_post_build
int starpu_mpi_task_post_build(MPI_Comm comm, struct starpu_codelet *codelet,...)
starpu_mpi_barrier
int starpu_mpi_barrier(MPI_Comm comm)
starpu_mpi_issend_detached_prio
int starpu_mpi_issend_detached_prio(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, int prio, MPI_Comm comm, void(*callback)(void *), void *arg)
starpu_mpi_data_migrate
void starpu_mpi_data_migrate(MPI_Comm comm, starpu_data_handle_t handle, int new_rank)
starpu_mpi_irecv_detached
int starpu_mpi_irecv_detached(starpu_data_handle_t data_handle, int source, starpu_mpi_tag_t data_tag, MPI_Comm comm, void(*callback)(void *), void *arg)
starpu_mpi_cache_is_enabled
int starpu_mpi_cache_is_enabled()
starpu_mpi_task_build
struct starpu_task * starpu_mpi_task_build(MPI_Comm comm, struct starpu_codelet *codelet,...)
starpu_mpi_shutdown
int starpu_mpi_shutdown(void)
starpu_mpi_isend_detached_unlock_tag
int starpu_mpi_isend_detached_unlock_tag(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, MPI_Comm comm, starpu_tag_t tag)
starpu_mpi_irecv
int starpu_mpi_irecv(starpu_data_handle_t data_handle, starpu_mpi_req *req, int source, starpu_mpi_tag_t data_tag, MPI_Comm comm)
starpu_mpi_isend
int starpu_mpi_isend(starpu_data_handle_t data_handle, starpu_mpi_req *req, int dest, starpu_mpi_tag_t data_tag, MPI_Comm comm)
starpu_mpi_wait
int starpu_mpi_wait(starpu_mpi_req *req, MPI_Status *status)
starpu_mpi_init_comm
int starpu_mpi_init_comm(int *argc, char ***argv, int initialize_mpi, MPI_Comm comm)
starpu_mpi_init_conf
int starpu_mpi_init_conf(int *argc, char ***argv, int initialize_mpi, MPI_Comm comm, struct starpu_conf *conf)
starpu_mpi_cached_receive
int starpu_mpi_cached_receive(starpu_data_handle_t data_handle)
starpu_mpi_datatype_unregister
int starpu_mpi_datatype_unregister(starpu_data_handle_t handle)
starpu_data_descr
Definition: starpu_task.h:533
starpu_mpi_isend_detached_prio
int starpu_mpi_isend_detached_prio(starpu_data_handle_t data_handle, int dest, starpu_mpi_tag_t data_tag, int prio, MPI_Comm comm, void(*callback)(void *), void *arg)
starpu_mpi_world_rank
int starpu_mpi_world_rank(void)
starpu_mpi_gather_detached
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)