Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
fc4e0873e75a105668018ef91154acb9327d0a53
[simgrid.git] / include / smpi / smpi.h
1 /* Copyright (c) 2007, 2008, 2009, 2010. The SimGrid Team.
2  * All rights reserved.                                                     */
3
4 /* This program is free software; you can redistribute it and/or modify it
5  * under the terms of the license (GNU LGPL) which comes with this package. */
6
7 #ifndef SMPI_H
8 #define SMPI_H
9
10 #include <stddef.h>
11 #include <sys/time.h>
12 #include <xbt/misc.h>
13 #include <xbt/function_types.h>
14
15 SG_BEGIN_DECL()
16 #define MPI_THREAD_SINGLE     0
17 #define MPI_THREAD_FUNNELED   1
18 #define MPI_THREAD_SERIALIZED 2
19 #define MPI_THREAD_MULTIPLE   3
20
21 //FIXME: check values
22 #define MPI_MAX_PROCESSOR_NAME 100
23 #define MPI_MAX_ERROR_STRING   100
24 #define MPI_MAX_DATAREP_STRIN  100
25 #define MPI_MAX_INFO_KEY       100
26 #define MPI_MAX_INFO_VAL       100
27 #define MPI_MAX_OBJECT_NAME    100
28 #define MPI_MAX_PORT_NAME      100
29
30 #define SMPI_RAND_SEED 5
31 #define MPI_ANY_SOURCE -1
32 #define MPI_PROC_NULL -2
33 #define MPI_ANY_TAG -1
34 #define MPI_UNDEFINED -1
35
36 // errorcodes
37 #define MPI_SUCCESS       0
38 #define MPI_ERR_COMM      1
39 #define MPI_ERR_ARG       2
40 #define MPI_ERR_TYPE      3
41 #define MPI_ERR_REQUEST   4
42 #define MPI_ERR_INTERN    5
43 #define MPI_ERR_COUNT     6
44 #define MPI_ERR_RANK      7
45 #define MPI_ERR_TAG       8
46 #define MPI_ERR_TRUNCATE  9
47 #define MPI_ERR_GROUP    10
48 #define MPI_ERR_OP       11
49
50 #define MPI_IDENT     0
51 #define MPI_SIMILAR   1
52 #define MPI_UNEQUAL   2
53 #define MPI_CONGRUENT 3
54
55 #define MPI_WTIME_IS_GLOBAL 1
56
57 typedef ptrdiff_t MPI_Aint;
58 typedef long long MPI_Offset;
59
60 struct s_smpi_mpi_datatype;
61 typedef struct s_smpi_mpi_datatype* MPI_Datatype;
62
63 typedef struct {
64   int MPI_SOURCE;
65   int MPI_TAG;
66   int MPI_ERROR;
67   int count;
68 } MPI_Status;
69
70 #define MPI_STATUS_IGNORE NULL
71
72 #define MPI_DATATYPE_NULL NULL
73 extern MPI_Datatype MPI_CHAR;
74 extern MPI_Datatype MPI_SHORT;
75 extern MPI_Datatype MPI_INT;
76 extern MPI_Datatype MPI_LONG;
77 extern MPI_Datatype MPI_LONG_LONG;
78 #define MPI_LONG_LONG_INT MPI_LONG_LONG
79 extern MPI_Datatype MPI_SIGNED_CHAR;
80 extern MPI_Datatype MPI_UNSIGNED_CHAR;
81 extern MPI_Datatype MPI_UNSIGNED_SHORT;
82 extern MPI_Datatype MPI_UNSIGNED;
83 extern MPI_Datatype MPI_UNSIGNED_LONG;
84 extern MPI_Datatype MPI_UNSIGNED_LONG_LONG;
85 extern MPI_Datatype MPI_FLOAT;
86 extern MPI_Datatype MPI_DOUBLE;
87 extern MPI_Datatype MPI_LONG_DOUBLE;
88 extern MPI_Datatype MPI_WCHAR;
89 extern MPI_Datatype MPI_C_BOOL;
90 extern MPI_Datatype MPI_INT8_T;
91 extern MPI_Datatype MPI_INT16_T;
92 extern MPI_Datatype MPI_INT32_T;
93 extern MPI_Datatype MPI_INT64_T;
94 extern MPI_Datatype MPI_UINT8_T;
95 #define MPI_BYTE MPI_UINT8_T
96 extern MPI_Datatype MPI_UINT16_T;
97 extern MPI_Datatype MPI_UINT32_T;
98 extern MPI_Datatype MPI_UINT64_T;
99 extern MPI_Datatype MPI_C_FLOAT_COMPLEX;
100 #define MPI_C_COMPLEX MPI_C_FLOAT_COMPLEX
101 extern MPI_Datatype MPI_C_DOUBLE_COMPLEX;
102 extern MPI_Datatype MPI_C_LONG_DOUBLE_COMPLEX;
103 extern MPI_Datatype MPI_AINT;
104 extern MPI_Datatype MPI_OFFSET;
105
106 //The following are datatypes for the MPI functions MPI_MAXLOC  and MPI_MINLOC.
107 extern MPI_Datatype MPI_FLOAT_INT;
108 extern MPI_Datatype MPI_LONG_INT;
109 extern MPI_Datatype MPI_DOUBLE_INT;
110 extern MPI_Datatype MPI_SHORT_INT;
111 extern MPI_Datatype MPI_2INT;
112 extern MPI_Datatype MPI_LONG_DOUBLE_INT;
113
114
115 typedef void MPI_User_function(void* invec, void* inoutvec, int* len, MPI_Datatype* datatype);
116 struct s_smpi_mpi_op;
117 typedef struct s_smpi_mpi_op* MPI_Op;
118
119 #define MPI_OP_NULL NULL
120 extern MPI_Op MPI_MAX;
121 extern MPI_Op MPI_MIN;
122 extern MPI_Op MPI_MAXLOC;
123 extern MPI_Op MPI_MINLOC;
124 extern MPI_Op MPI_SUM;
125 extern MPI_Op MPI_PROD;
126 extern MPI_Op MPI_LAND;
127 extern MPI_Op MPI_LOR;
128 extern MPI_Op MPI_LXOR;
129 extern MPI_Op MPI_BAND;
130 extern MPI_Op MPI_BOR;
131 extern MPI_Op MPI_BXOR;
132
133 struct s_smpi_mpi_group;
134 typedef struct s_smpi_mpi_group* MPI_Group;
135
136 #define MPI_GROUP_NULL NULL
137
138 extern MPI_Group MPI_GROUP_EMPTY;
139
140 struct s_smpi_mpi_communicator;
141 typedef struct s_smpi_mpi_communicator* MPI_Comm;
142
143 #define MPI_COMM_NULL NULL
144 extern MPI_Comm MPI_COMM_WORLD;
145 #define MPI_COMM_SELF smpi_process_comm_self()
146
147 struct s_smpi_mpi_request;
148 typedef struct s_smpi_mpi_request* MPI_Request;
149
150 #define MPI_REQUEST_NULL NULL
151
152 XBT_PUBLIC(int) MPI_Init(int* argc, char*** argv);
153 XBT_PUBLIC(int) MPI_Finalize(void);
154 XBT_PUBLIC(int) MPI_Init_thread(int* argc, char*** argv, int required, int* provided);
155 XBT_PUBLIC(int) MPI_Query_thread(int* provided);
156 XBT_PUBLIC(int) MPI_Is_thread_main(int* flag);
157 XBT_PUBLIC(int) MPI_Abort(MPI_Comm comm, int errorcode);
158 XBT_PUBLIC(double) MPI_Wtime(void);
159
160 XBT_PUBLIC(int) MPI_Address(void *location, MPI_Aint *address);
161
162 XBT_PUBLIC(int) MPI_Type_free(MPI_Datatype* datatype);
163 XBT_PUBLIC(int) MPI_Type_size(MPI_Datatype datatype, int* size);
164 XBT_PUBLIC(int) MPI_Type_get_extent(MPI_Datatype datatype, MPI_Aint* lb, MPI_Aint* extent);
165 XBT_PUBLIC(int) MPI_Type_extent(MPI_Datatype datatype, MPI_Aint* extent);
166 XBT_PUBLIC(int) MPI_Type_lb(MPI_Datatype datatype, MPI_Aint* disp);
167 XBT_PUBLIC(int) MPI_Type_ub(MPI_Datatype datatype, MPI_Aint* disp);
168
169 XBT_PUBLIC(int) MPI_Op_create(MPI_User_function* function, int commute, MPI_Op* op);
170 XBT_PUBLIC(int) MPI_Op_free(MPI_Op* op);
171
172 XBT_PUBLIC(int) MPI_Group_free(MPI_Group *group);
173 XBT_PUBLIC(int) MPI_Group_size(MPI_Group group, int* size);
174 XBT_PUBLIC(int) MPI_Group_rank(MPI_Group group, int* rank);
175 XBT_PUBLIC(int) MPI_Group_translate_ranks (MPI_Group group1, int n, int* ranks1, MPI_Group group2, int* ranks2);
176 XBT_PUBLIC(int) MPI_Group_compare(MPI_Group group1, MPI_Group group2, int* result);
177 XBT_PUBLIC(int) MPI_Group_union(MPI_Group group1, MPI_Group group2, MPI_Group* newgroup);
178 XBT_PUBLIC(int) MPI_Group_intersection(MPI_Group group1, MPI_Group group2, MPI_Group* newgroup);
179 XBT_PUBLIC(int) MPI_Group_difference(MPI_Group group1, MPI_Group group2, MPI_Group* newgroup);
180 XBT_PUBLIC(int) MPI_Group_incl(MPI_Group group, int n, int* ranks, MPI_Group* newgroup);
181 XBT_PUBLIC(int) MPI_Group_excl(MPI_Group group, int n, int* ranks, MPI_Group* newgroup);
182 XBT_PUBLIC(int) MPI_Group_range_incl(MPI_Group group, int n, int ranges[][3], MPI_Group* newgroup);
183 XBT_PUBLIC(int) MPI_Group_range_excl(MPI_Group group, int n, int ranges[][3], MPI_Group* newgroup);
184
185 XBT_PUBLIC(int) MPI_Comm_rank(MPI_Comm comm, int* rank);
186 XBT_PUBLIC(int) MPI_Comm_size(MPI_Comm comm, int* size);
187 XBT_PUBLIC(int) MPI_Get_processor_name(char *name, int *resultlen);
188 XBT_PUBLIC(int) MPI_Get_count(MPI_Status* status, MPI_Datatype datatype, int* count);
189            
190 XBT_PUBLIC(int) MPI_Comm_group(MPI_Comm comm, MPI_Group* group);
191 XBT_PUBLIC(int) MPI_Comm_compare(MPI_Comm comm1, MPI_Comm comm2, int* result);
192 XBT_PUBLIC(int) MPI_Comm_dup(MPI_Comm comm, MPI_Comm* newcomm);
193 XBT_PUBLIC(int) MPI_Comm_create(MPI_Comm comm, MPI_Group group, MPI_Comm* newcomm);
194 XBT_PUBLIC(int) MPI_Comm_free(MPI_Comm* comm);
195
196 XBT_PUBLIC(int) MPI_Send_init(void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm, MPI_Request* request);
197 XBT_PUBLIC(int) MPI_Recv_init(void* buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm, MPI_Request* request);
198 XBT_PUBLIC(int) MPI_Start(MPI_Request* request);
199 XBT_PUBLIC(int) MPI_Startall(int count, MPI_Request* requests);
200 XBT_PUBLIC(int) MPI_Request_free(MPI_Request* request);
201 XBT_PUBLIC(int) MPI_Irecv(void* buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm, MPI_Request* request);
202 XBT_PUBLIC(int) MPI_Isend(void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm, MPI_Request* request);
203 XBT_PUBLIC(int) MPI_Recv(void* buf, int count, MPI_Datatype datatype, int src, int tag, MPI_Comm comm, MPI_Status* status);
204 XBT_PUBLIC(int) MPI_Send(void* buf, int count, MPI_Datatype datatype, int dst, int tag, MPI_Comm comm);
205 XBT_PUBLIC(int) MPI_Sendrecv(void* sendbuf, int sendcount, MPI_Datatype sendtype, int dst, int sendtag, void* recvbuf, int recvcount, MPI_Datatype recvtype, int src, int recvtag, MPI_Comm comm, MPI_Status* status);
206 XBT_PUBLIC(int) MPI_Sendrecv_replace(void* buf, int count, MPI_Datatype datatype, int dst, int sendtag, int src, int recvtag, MPI_Comm comm, MPI_Status* status);
207
208
209 XBT_PUBLIC(int) MPI_Test(MPI_Request* request, int* flag, MPI_Status* status);
210 XBT_PUBLIC(int) MPI_Testany(int count, MPI_Request requests[], int* index, int* flag, MPI_Status* status);
211 XBT_PUBLIC(int) MPI_Wait(MPI_Request* request, MPI_Status* status);
212 XBT_PUBLIC(int) MPI_Waitany(int count, MPI_Request requests[], int* index, MPI_Status* status); 
213 XBT_PUBLIC(int) MPI_Waitall(int count, MPI_Request requests[], MPI_Status status[]);
214 XBT_PUBLIC(int) MPI_Waitsome(int incount, MPI_Request requests[], int* outcount, int* indices, MPI_Status status[]);
215
216 XBT_PUBLIC(int) MPI_Bcast(void* buf, int count, MPI_Datatype datatype, int root, MPI_Comm comm);
217 XBT_PUBLIC(int) MPI_Barrier(MPI_Comm comm);
218 XBT_PUBLIC(int) MPI_Gather(void* sendbuf, int sendcount, MPI_Datatype sendtype, void* recvbuf, int recvcount, MPI_Datatype recvtype, int root, MPI_Comm comm);
219 XBT_PUBLIC(int) MPI_Gatherv(void* sendbuf, int sendcount, MPI_Datatype sendtype, void* recvbuf, int* recvcounts, int* displs, MPI_Datatype recvtype, int root, MPI_Comm comm);
220 XBT_PUBLIC(int) MPI_Allgather(void* sendbuf, int sendcount, MPI_Datatype sendtype, void* recvbuf, int recvcount, MPI_Datatype recvtype, MPI_Comm comm);
221 XBT_PUBLIC(int) MPI_Allgatherv(void* sendbuf, int sendcount, MPI_Datatype sendtype, void* recvbuf, int* recvcounts, int* displs, MPI_Datatype recvtype, MPI_Comm comm);
222 XBT_PUBLIC(int) MPI_Scatter(void* sendbuf, int sendcount, MPI_Datatype sendtype, void* recvbuf, int recvcount, MPI_Datatype recvtype, int root, MPI_Comm comm);
223 XBT_PUBLIC(int) MPI_Scatterv(void* sendbuf, int* sendcounts, int* displs, MPI_Datatype sendtype, void* recvbuf, int recvcount, MPI_Datatype recvtype, int root, MPI_Comm comm);
224 XBT_PUBLIC(int) MPI_Reduce(void* sendbuf, void* recvbuf, int count, MPI_Datatype datatype, MPI_Op op, int root, MPI_Comm comm);
225 XBT_PUBLIC(int) MPI_Allreduce(void* sendbuf, void* recvbuf, int count, MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
226 XBT_PUBLIC(int) MPI_Scan(void* sendbuf, void* recvbuf, int count, MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
227 XBT_PUBLIC(int) MPI_Reduce_scatter(void* sendbuf, void* recvbuf, int* recvcounts, MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
228 XBT_PUBLIC(int) MPI_Alltoall(void* sendbuf, int sendcount, MPI_Datatype sendtype, void* recvbuf, int recvcount, MPI_Datatype recvtype, MPI_Comm comm);
229 XBT_PUBLIC(int) MPI_Alltoallv(void* sendbuf, int* sendcounts, int* senddisps, MPI_Datatype sendtype, void* recvbuf, int *recvcounts, int* recvdisps, MPI_Datatype recvtype, MPI_Comm comm);
230
231 /*
232 TODO
233 XBT_PUBLIC(int) MPI_Comm_split(MPI_Comm comm, int color, int key,
234                                MPI_Comm* comm_out);
235 */
236 // smpi functions
237 XBT_IMPORT_NO_EXPORT(int) smpi_simulated_main(int argc, char** argv);
238 XBT_PUBLIC(MPI_Comm) smpi_process_comm_self(void);
239 /*
240 XBT_PUBLIC(unsigned int) smpi_sleep(unsigned int);
241 XBT_PUBLIC(void) smpi_exit(int);
242 XBT_PUBLIC(int) smpi_gettimeofday(struct timeval* tv, struct timezone* tz);
243 */
244
245 /*
246 TODO
247 XBT_PUBLIC(void) smpi_do_once_1(const char* file, int line);
248 XBT_PUBLIC(int) smpi_do_once_2(void);
249 XBT_PUBLIC(void) smpi_do_once_3(void);
250
251 #define SMPI_DO_ONCE for (smpi_do_once_1(__FILE__, __LINE__); smpi_do_once_2(); smpi_do_once_3())
252 */
253
254 XBT_PUBLIC(void*) smpi_shared_malloc(size_t size, const char* file, int line);
255 #define SMPI_SHARED_MALLOC(size) smpi_shared_malloc(size, __FILE__, __LINE__)
256
257 XBT_PUBLIC(void) smpi_shared_free(void* data);
258 #define SMPI_SHARED_FREE(data) smpi_shared_free(data)
259
260 SG_END_DECL()
261 #endif