StarPU Handbook
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Groups Pages
starpu_mpi.h
Go to the documentation of this file.
1 /* StarPU --- Runtime system for heterogeneous multicore architectures.
2  *
3  * Copyright (C) 2009-2012 Université de Bordeaux
4  * Copyright (C) 2010, 2011, 2012, 2013, 2014, 2015 Centre National de la Recherche Scientifique
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_init(int *argc, char ***argv, int initialize_mpi);
46 int starpu_mpi_initialize(void) STARPU_DEPRECATED;
47 int starpu_mpi_initialize_extended(int *rank, int *world_size) STARPU_DEPRECATED;
48 int starpu_mpi_shutdown(void);
49 
50 int starpu_mpi_insert_task(MPI_Comm comm, struct starpu_codelet *codelet, ...);
51 void starpu_mpi_get_data_on_node(MPI_Comm comm, starpu_data_handle_t data_handle, int node);
52 void starpu_mpi_get_data_on_node_detached(MPI_Comm comm, starpu_data_handle_t data_handle, int node, void (*callback)(void*), void *arg);
53 void starpu_mpi_redux_data(MPI_Comm comm, starpu_data_handle_t data_handle);
54 
55 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);
56 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);
57 
58 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);
59 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);
60 
61 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);
62 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);
63 
64 void starpu_mpi_comm_amounts_retrieve(size_t *comm_amounts);
65 
66 void starpu_mpi_cache_flush(MPI_Comm comm, starpu_data_handle_t data_handle);
67 void starpu_mpi_cache_flush_all_data(MPI_Comm comm);
68 
69 void starpu_mpi_data_register_comm(starpu_data_handle_t data_handle,int tag, int rank, MPI_Comm comm);
70 #define starpu_mpi_data_register(data_handle, tag, rank) starpu_mpi_data_register_comm(data_handle, tag, rank, MPI_COMM_WORLD)
71 
73 int starpu_mpi_cache_set(int enabled);
74 
75 int starpu_mpi_data_set_rank_comm(starpu_data_handle_t handle, int rank, MPI_Comm comm);
76 #define starpu_mpi_data_set_rank(handle, rank) starpu_mpi_data_set_rank_comm(handle, rank, MPI_COMM_WORLD)
77 int starpu_mpi_data_set_tag(starpu_data_handle_t handle, int tag);
78 #define starpu_data_set_rank starpu_mpi_data_set_rank
79 #define starpu_data_set_tag starpu_mpi_data_set_tag
80 
83 #define starpu_data_get_rank starpu_mpi_data_get_rank
84 #define starpu_data_get_tag starpu_mpi_data_get_tag
85 
86 #ifdef __cplusplus
87 }
88 #endif
89 
90 #endif // STARPU_USE_MPI
91 #endif // __STARPU_MPI_H__