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-2015 Université de Bordeaux
4  * Copyright (C) 2010, 2011, 2012, 2013, 2014, 2015 CNRS
5  *
6  * StarPU is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU Lesser General Public License as published by
8  * the Free Software Foundation; either version 2.1 of the License, or (at
9  * your option) any later version.
10  *
11  * StarPU is distributed in the hope that it will be useful, but
12  * WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
14  *
15  * See the GNU Lesser General Public License in COPYING.LGPL for more details.
16  */
17 
18 #ifndef __STARPU_MPI_H__
19 #define __STARPU_MPI_H__
20 
21 #include <starpu.h>
22 
23 #if defined(STARPU_USE_MPI)
24 
25 #include <mpi.h>
26 
27 #ifdef __cplusplus
28 extern "C" {
29 #endif
30 
31 typedef void *starpu_mpi_req;
32 
33 int starpu_mpi_isend(starpu_data_handle_t data_handle, starpu_mpi_req *req, int dest, int mpi_tag, MPI_Comm comm);
34 int starpu_mpi_irecv(starpu_data_handle_t data_handle, starpu_mpi_req *req, int source, int mpi_tag, MPI_Comm comm);
35 int starpu_mpi_send(starpu_data_handle_t data_handle, int dest, int mpi_tag, MPI_Comm comm);
36 int starpu_mpi_recv(starpu_data_handle_t data_handle, int source, int mpi_tag, MPI_Comm comm, MPI_Status *status);
37 int starpu_mpi_isend_detached(starpu_data_handle_t data_handle, int dest, int mpi_tag, MPI_Comm comm, void (*callback)(void *), void *arg);
38 int starpu_mpi_irecv_detached(starpu_data_handle_t data_handle, int source, int mpi_tag, MPI_Comm comm, void (*callback)(void *), void *arg);
39 int starpu_mpi_issend(starpu_data_handle_t data_handle, starpu_mpi_req *req, int dest, int mpi_tag, MPI_Comm comm);
40 int starpu_mpi_issend_detached(starpu_data_handle_t data_handle, int dest, int mpi_tag, MPI_Comm comm, void (*callback)(void *), void *arg);
41 int starpu_mpi_wait(starpu_mpi_req *req, MPI_Status *status);
42 int starpu_mpi_test(starpu_mpi_req *req, int *flag, MPI_Status *status);
43 int starpu_mpi_barrier(MPI_Comm comm);
44 
45 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);
46 
47 int starpu_mpi_init_comm(int *argc, char ***argv, int initialize_mpi, MPI_Comm comm);
48 int starpu_mpi_init(int *argc, char ***argv, int initialize_mpi);
49 int starpu_mpi_initialize(void) STARPU_DEPRECATED;
50 int starpu_mpi_initialize_extended(int *rank, int *world_size) STARPU_DEPRECATED;
51 int starpu_mpi_shutdown(void);
52 
53 struct starpu_task *starpu_mpi_task_build(MPI_Comm comm, struct starpu_codelet *codelet, ...);
54 int starpu_mpi_task_post_build(MPI_Comm comm, struct starpu_codelet *codelet, ...);
55 int starpu_mpi_task_insert(MPI_Comm comm, struct starpu_codelet *codelet, ...);
56 /* the function starpu_mpi_insert_task has the same semantics as starpu_mpi_task_insert, it is kept to avoid breaking old codes */
57 int starpu_mpi_insert_task(MPI_Comm comm, struct starpu_codelet *codelet, ...);
58 
59 void starpu_mpi_get_data_on_node(MPI_Comm comm, starpu_data_handle_t data_handle, int node);
60 void starpu_mpi_get_data_on_node_detached(MPI_Comm comm, starpu_data_handle_t data_handle, int node, void (*callback)(void*), void *arg);
61 void starpu_mpi_redux_data(MPI_Comm comm, starpu_data_handle_t data_handle);
62 
63 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);
64 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);
65 
66 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);
67 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);
68 
69 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);
70 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);
71 
72 void starpu_mpi_comm_amounts_retrieve(size_t *comm_amounts);
73 
74 void starpu_mpi_cache_flush(MPI_Comm comm, starpu_data_handle_t data_handle);
75 void starpu_mpi_cache_flush_all_data(MPI_Comm comm);
76 
77 int starpu_mpi_comm_size(MPI_Comm comm, int *size);
78 int starpu_mpi_comm_rank(MPI_Comm comm, int *rank);
79 int starpu_mpi_world_rank(void);
80 
83 
84 void starpu_mpi_data_register_comm(starpu_data_handle_t data_handle, int tag, int rank, MPI_Comm comm);
85 #define starpu_mpi_data_register(data_handle, tag, rank) starpu_mpi_data_register_comm(data_handle, tag, rank, MPI_COMM_WORLD)
86 
87 void starpu_mpi_data_set_rank_comm(starpu_data_handle_t handle, int rank, MPI_Comm comm);
88 #define starpu_mpi_data_set_rank(handle, rank) starpu_mpi_data_set_rank_comm(handle, rank, MPI_COMM_WORLD)
89 void starpu_mpi_data_set_tag(starpu_data_handle_t handle, int tag);
90 #define starpu_data_set_rank starpu_mpi_data_set_rank
91 #define starpu_data_set_tag starpu_mpi_data_set_tag
92 
95 #define starpu_data_get_rank starpu_mpi_data_get_rank
96 #define starpu_data_get_tag starpu_mpi_data_get_tag
97 
98 #define STARPU_MPI_NODE_SELECTION_CURRENT_POLICY -1
99 #define STARPU_MPI_NODE_SELECTION_MOST_R_DATA 0
100 
101 typedef int (*starpu_mpi_select_node_policy_func_t)(int me, int nb_nodes, struct starpu_data_descr *descr, int nb_data);
102 int starpu_mpi_node_selection_register_policy(starpu_mpi_select_node_policy_func_t policy_func);
104 
107 
109 int starpu_mpi_cache_set(int enabled);
110 
111 #ifdef __cplusplus
112 }
113 #endif
114 
115 #endif // STARPU_USE_MPI
116 #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:86
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)
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)
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)
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:123
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_node_selection_unregister_policy(int policy)
void starpu_mpi_data_set_rank_comm(starpu_data_handle_t handle, int rank, MPI_Comm comm)
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:68
int starpu_mpi_init_comm(int *argc, char ***argv, int initialize_mpi, MPI_Comm comm)
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_cache_is_enabled()
int starpu_mpi_cache_set(int enabled)
struct _starpu_data_state * starpu_data_handle_t
Definition: starpu_data.h:29
void starpu_mpi_redux_data(MPI_Comm comm, 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:45
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)
int starpu_mpi_shutdown(void)
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)