Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Make internal collective flags negative (incorrect in MPI), to avoid confusion with...
[simgrid.git] / src / smpi / private.h
1 /* Copyright (c) 2007, 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_PRIVATE_H
8 #define SMPI_PRIVATE_H
9
10 #include "xbt.h"
11 #include "xbt/xbt_os_time.h"
12 #include "simgrid/simix.h"
13 #include "smpi/smpi_interface.h"
14 #include "smpi/smpi.h"
15 #include "smpi/smpif.h"
16 #include "smpi/smpi_cocci.h"
17 #include "instr/instr_private.h"
18
19 struct s_smpi_process_data;
20 typedef struct s_smpi_process_data *smpi_process_data_t;
21
22 #define PERSISTENT     0x1
23 #define NON_PERSISTENT 0x2
24 #define SEND           0x4
25 #define RECV           0x8
26 #define RECV_DELETE    0x10
27 #define ISEND          0x20
28 #define SSEND          0x40
29 // this struct is here to handle the problem of non-contignous data
30 // for each such structure these function should be implemented (vector
31 // index hvector hindex struct)
32 typedef struct s_smpi_subtype{
33   void (*serialize)(const void * input, void *output, size_t count, void* subtype);
34   void (*unserialize)(const void * input, void *output, size_t count, void* subtype);
35   void (*subtype_free)(MPI_Datatype* type);
36 } s_smpi_subtype_t;
37
38 typedef struct s_smpi_mpi_datatype{
39   size_t size;
40   /* this let us know if a serialization is required*/
41   size_t has_subtype;
42   MPI_Aint lb;
43   MPI_Aint ub;
44   int flags;
45   /* this let us know how to serialize and unserialize*/
46   void *substruct;
47   int in_use;
48 } s_smpi_mpi_datatype_t;
49
50
51 #define COLL_TAG_REDUCE -112
52 #define COLL_TAG_SCATTER -223
53 #define COLL_TAG_SCATTERV -334
54 #define COLL_TAG_GATHER -445
55 #define COLL_TAG_ALLGATHER -556
56 #define COLL_TAG_ALLGATHERV -667
57 #define COLL_TAG_BARRIER -778
58 #define COLL_TAG_REDUCE_SCATTER -889
59 #define COLL_TAG_ALLTOALLV -1000
60 #define COLL_TAG_ALLTOALL -1112
61 #define COLL_TAG_GATHERV -2223
62 #define COLL_TAG_BCAST -3334
63 #define COLL_TAG_ALLREDUCE -4445
64 //*****************************************************************************************
65
66 typedef struct s_smpi_mpi_request {
67   void *buf;
68   /* in the case of non-contignous memory the user address shoud be keep
69    * to unserialize the data inside the user memory*/
70   void *old_buf;
71   /* this let us know how tounserialize at the end of
72    * the communication*/
73   MPI_Datatype old_type;
74   size_t size;
75   int src;
76   int dst;
77   int tag;
78   //to handle cases where we have an unknown sender
79   //We can't override src, tag, and size, because the request may be reused later
80   int real_src;
81   int real_tag;
82   int truncated;
83   size_t real_size;
84   MPI_Comm comm;
85   smx_action_t action;
86   unsigned flags;
87   int detached;
88   MPI_Request detached_sender;
89   int refcount;
90 #ifdef HAVE_TRACING
91   int send;
92   int recv;
93 #endif
94 } s_smpi_mpi_request_t;
95
96 void smpi_process_init(int *argc, char ***argv);
97 void smpi_process_destroy(void);
98 void smpi_process_finalize(void);
99 int smpi_process_finalized(void);
100
101 smpi_process_data_t smpi_process_data(void);
102 smpi_process_data_t smpi_process_remote_data(int index);
103 void smpi_process_set_user_data(void *);
104 void* smpi_process_get_user_data(void);
105 int smpi_process_count(void);
106 smx_rdv_t smpi_process_mailbox(void);
107 smx_rdv_t smpi_process_remote_mailbox(int index);
108 smx_rdv_t smpi_process_mailbox_small(void);
109 smx_rdv_t smpi_process_remote_mailbox_small(int index);
110 xbt_os_timer_t smpi_process_timer(void);
111 void smpi_process_simulated_start(void);
112 double smpi_process_simulated_elapsed(void);
113
114 void print_request(const char *message, MPI_Request request);
115
116 void smpi_global_init(void);
117 void smpi_global_destroy(void);
118
119 size_t smpi_datatype_size(MPI_Datatype datatype);
120 MPI_Aint smpi_datatype_lb(MPI_Datatype datatype);
121 MPI_Aint smpi_datatype_ub(MPI_Datatype datatype);
122 int smpi_datatype_extent(MPI_Datatype datatype, MPI_Aint * lb,
123                          MPI_Aint * extent);
124 MPI_Aint smpi_datatype_get_extent(MPI_Datatype datatype);
125 int smpi_datatype_copy(void *sendbuf, int sendcount, MPI_Datatype sendtype,
126                        void *recvbuf, int recvcount,
127                        MPI_Datatype recvtype);
128 void smpi_datatype_use(MPI_Datatype type);
129 void smpi_datatype_unuse(MPI_Datatype type);
130
131 int smpi_datatype_contiguous(int count, MPI_Datatype old_type,
132                        MPI_Datatype* new_type, MPI_Aint lb);
133 int smpi_datatype_vector(int count, int blocklen, int stride,
134                       MPI_Datatype old_type, MPI_Datatype* new_type);
135
136 int smpi_datatype_hvector(int count, int blocklen, MPI_Aint stride,
137                       MPI_Datatype old_type, MPI_Datatype* new_type);
138 int smpi_datatype_indexed(int count, int* blocklens, int* indices,
139                      MPI_Datatype old_type, MPI_Datatype* new_type);
140 int smpi_datatype_hindexed(int count, int* blocklens, MPI_Aint* indices,
141                      MPI_Datatype old_type, MPI_Datatype* new_type);
142 int smpi_datatype_struct(int count, int* blocklens, MPI_Aint* indices,
143                     MPI_Datatype* old_types, MPI_Datatype* new_type);
144
145 void smpi_datatype_create(MPI_Datatype* new_type, int size,int lb, int ub, int has_subtype, void *struct_type, int flags);
146
147
148 void smpi_datatype_free(MPI_Datatype* type);
149 void smpi_datatype_commit(MPI_Datatype* datatype);
150
151 void smpi_empty_status(MPI_Status * status);
152 MPI_Op smpi_op_new(MPI_User_function * function, int commute);
153 int smpi_op_is_commute(MPI_Op op);
154 void smpi_op_destroy(MPI_Op op);
155 void smpi_op_apply(MPI_Op op, void *invec, void *inoutvec, int *len,
156                    MPI_Datatype * datatype);
157
158 MPI_Group smpi_group_new(int size);
159 void smpi_group_destroy(MPI_Group group);
160 void smpi_group_set_mapping(MPI_Group group, int index, int rank);
161 int smpi_group_index(MPI_Group group, int rank);
162 int smpi_group_rank(MPI_Group group, int index);
163 int smpi_group_use(MPI_Group group);
164 int smpi_group_unuse(MPI_Group group);
165 int smpi_group_size(MPI_Group group);
166 int smpi_group_compare(MPI_Group group1, MPI_Group group2);
167
168 MPI_Comm smpi_comm_new(MPI_Group group);
169 void smpi_comm_destroy(MPI_Comm comm);
170 MPI_Group smpi_comm_group(MPI_Comm comm);
171 int smpi_comm_size(MPI_Comm comm);
172 void smpi_comm_get_name(MPI_Comm comm, char* name, int* len);
173 int smpi_comm_rank(MPI_Comm comm);
174 MPI_Comm smpi_comm_split(MPI_Comm comm, int color, int key);
175
176 MPI_Request smpi_mpi_send_init(void *buf, int count, MPI_Datatype datatype,
177                                int dst, int tag, MPI_Comm comm);
178 MPI_Request smpi_mpi_recv_init(void *buf, int count, MPI_Datatype datatype,
179                                int src, int tag, MPI_Comm comm);
180 MPI_Request smpi_mpi_ssend_init(void *buf, int count, MPI_Datatype datatype,
181                                int dst, int tag, MPI_Comm comm);
182 void smpi_mpi_start(MPI_Request request);
183 void smpi_mpi_startall(int count, MPI_Request * requests);
184 void smpi_mpi_request_free(MPI_Request * request);
185 MPI_Request smpi_isend_init(void *buf, int count, MPI_Datatype datatype,
186                             int dst, int tag, MPI_Comm comm);
187 MPI_Request smpi_mpi_isend(void *buf, int count, MPI_Datatype datatype,
188                            int dst, int tag, MPI_Comm comm);
189 MPI_Request smpi_mpi_issend(void *buf, int count, MPI_Datatype datatype,
190                            int dst, int tag, MPI_Comm comm);
191 MPI_Request smpi_irecv_init(void *buf, int count, MPI_Datatype datatype,
192                             int src, int tag, MPI_Comm comm);
193 MPI_Request smpi_mpi_irecv(void *buf, int count, MPI_Datatype datatype,
194                            int src, int tag, MPI_Comm comm);
195 void smpi_mpi_recv(void *buf, int count, MPI_Datatype datatype, int src,
196                    int tag, MPI_Comm comm, MPI_Status * status);
197 void smpi_mpi_send(void *buf, int count, MPI_Datatype datatype, int dst,
198                    int tag, MPI_Comm comm);
199 void smpi_mpi_ssend(void *buf, int count, MPI_Datatype datatype, int dst,
200                    int tag, MPI_Comm comm);
201 void smpi_mpi_sendrecv(void *sendbuf, int sendcount, MPI_Datatype sendtype,
202                        int dst, int sendtag, void *recvbuf, int recvcount,
203                        MPI_Datatype recvtype, int src, int recvtag,
204                        MPI_Comm comm, MPI_Status * status);
205 int smpi_mpi_test(MPI_Request * request, MPI_Status * status);
206 int smpi_mpi_testany(int count, MPI_Request requests[], int *index,
207                      MPI_Status * status);
208 int smpi_mpi_testall(int count, MPI_Request requests[],
209                      MPI_Status status[]);
210 void smpi_mpi_probe(int source, int tag, MPI_Comm comm, MPI_Status* status);
211 void smpi_mpi_iprobe(int source, int tag, MPI_Comm comm, int* flag,
212                     MPI_Status* status);
213 int smpi_mpi_get_count(MPI_Status * status, MPI_Datatype datatype);
214 void smpi_mpi_wait(MPI_Request * request, MPI_Status * status);
215 int smpi_mpi_waitany(int count, MPI_Request requests[],
216                      MPI_Status * status);
217 int smpi_mpi_waitall(int count, MPI_Request requests[],
218                       MPI_Status status[]);
219 int smpi_mpi_waitsome(int incount, MPI_Request requests[], int *indices,
220                       MPI_Status status[]);
221 int smpi_mpi_testsome(int incount, MPI_Request requests[], int *indices,
222                       MPI_Status status[]);
223 void smpi_mpi_bcast(void *buf, int count, MPI_Datatype datatype, int root,
224                     MPI_Comm comm);
225 void smpi_mpi_barrier(MPI_Comm comm);
226 void smpi_mpi_gather(void *sendbuf, int sendcount, MPI_Datatype sendtype,
227                      void *recvbuf, int recvcount, MPI_Datatype recvtype,
228                      int root, MPI_Comm comm);
229 void smpi_mpi_reduce_scatter(void *sendbuf, void *recvbuf, int *recvcounts,
230                        MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
231 void smpi_mpi_gatherv(void *sendbuf, int sendcount, MPI_Datatype sendtype,
232                       void *recvbuf, int *recvcounts, int *displs,
233                       MPI_Datatype recvtype, int root, MPI_Comm comm);
234 void smpi_mpi_allgather(void *sendbuf, int sendcount,
235                         MPI_Datatype sendtype, void *recvbuf,
236                         int recvcount, MPI_Datatype recvtype,
237                         MPI_Comm comm);
238 void smpi_mpi_allgatherv(void *sendbuf, int sendcount,
239                          MPI_Datatype sendtype, void *recvbuf,
240                          int *recvcounts, int *displs,
241                          MPI_Datatype recvtype, MPI_Comm comm);
242 void smpi_mpi_scatter(void *sendbuf, int sendcount, MPI_Datatype sendtype,
243                       void *recvbuf, int recvcount, MPI_Datatype recvtype,
244                       int root, MPI_Comm comm);
245 void smpi_mpi_scatterv(void *sendbuf, int *sendcounts, int *displs,
246                        MPI_Datatype sendtype, void *recvbuf, int recvcount,
247                        MPI_Datatype recvtype, int root, MPI_Comm comm);
248 void smpi_mpi_reduce(void *sendbuf, void *recvbuf, int count,
249                      MPI_Datatype datatype, MPI_Op op, int root,
250                      MPI_Comm comm);
251 void smpi_mpi_allreduce(void *sendbuf, void *recvbuf, int count,
252                         MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
253 void smpi_mpi_scan(void *sendbuf, void *recvbuf, int count,
254                    MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
255
256 void nary_tree_bcast(void *buf, int count, MPI_Datatype datatype, int root,
257                      MPI_Comm comm, int arity);
258 void nary_tree_barrier(MPI_Comm comm, int arity);
259
260 int smpi_coll_tuned_alltoall_ompi2(void *sendbuf, int sendcount,
261                                       MPI_Datatype sendtype, void *recvbuf,
262                                       int recvcount, MPI_Datatype recvtype,
263                                       MPI_Comm comm);
264 int smpi_coll_tuned_alltoall_bruck(void *sendbuf, int sendcount,
265                                    MPI_Datatype sendtype, void *recvbuf,
266                                    int recvcount, MPI_Datatype recvtype,
267                                    MPI_Comm comm);
268 int smpi_coll_tuned_alltoall_basic_linear(void *sendbuf, int sendcount,
269                                           MPI_Datatype sendtype,
270                                           void *recvbuf, int recvcount,
271                                           MPI_Datatype recvtype,
272                                           MPI_Comm comm);
273 int smpi_coll_basic_alltoallv(void *sendbuf, int *sendcounts,
274                               int *senddisps, MPI_Datatype sendtype,
275                               void *recvbuf, int *recvcounts,
276                               int *recvdisps, MPI_Datatype recvtype,
277                               MPI_Comm comm);
278
279 // utilities
280 void smpi_bench_destroy(void);
281 void smpi_bench_begin(void);
282 void smpi_bench_end(void);
283 void smpi_execute_flops(double flops);
284
285 // f77 wrappers
286 void mpi_init_(int*);
287 void mpi_finalize_(int*);
288 void mpi_abort_(int* comm, int* errorcode, int* ierr);
289 void mpi_comm_rank_(int* comm, int* rank, int* ierr);
290 void mpi_comm_size_(int* comm, int* size, int* ierr);
291 double mpi_wtime_(void);
292 double mpi_wtick_(void);
293 void mpi_initialized_(int* flag, int* ierr);
294
295 void mpi_comm_dup_(int* comm, int* newcomm, int* ierr);
296 void mpi_comm_create_(int* comm, int* group, int* newcomm, int* ierr);
297 void mpi_comm_free_(int* comm, int* ierr);
298 void mpi_comm_split_(int* comm, int* color, int* key, int* comm_out, int* ierr);
299 void mpi_group_incl_(int* group, int* n, int* key, int* group_out, int* ierr) ;
300 void mpi_comm_group_(int* comm, int* group_out,  int* ierr);
301 void mpi_send_init_(void *buf, int* count, int* datatype, int* dst, int* tag,
302                      int* comm, int* request, int* ierr);
303 void mpi_isend_(void *buf, int* count, int* datatype, int* dst,
304                  int* tag, int* comm, int* request, int* ierr);
305 void mpi_irsend_(void *buf, int* count, int* datatype, int* dst,
306                  int* tag, int* comm, int* request, int* ierr);
307 void mpi_send_(void* buf, int* count, int* datatype, int* dst,
308                 int* tag, int* comm, int* ierr);
309 void mpi_rsend_(void* buf, int* count, int* datatype, int* dst,
310                 int* tag, int* comm, int* ierr);
311 void mpi_recv_init_(void *buf, int* count, int* datatype, int* src, int* tag,
312                      int* comm, int* request, int* ierr);
313 void mpi_irecv_(void *buf, int* count, int* datatype, int* src, int* tag,
314                  int* comm, int* request, int* ierr);
315 void mpi_recv_(void* buf, int* count, int* datatype, int* src,
316                 int* tag, int* comm, MPI_Status* status, int* ierr);
317 void mpi_start_(int* request, int* ierr);
318 void mpi_startall_(int* count, int* requests, int* ierr);
319 void mpi_wait_(int* request, MPI_Status* status, int* ierr);
320 void mpi_waitany_(int* count, int* requests, int* index, MPI_Status* status, int* ierr);
321 void mpi_waitall_(int* count, int* requests, MPI_Status* status, int* ierr);
322
323 void mpi_barrier_(int* comm, int* ierr);
324 void mpi_bcast_(void* buf, int* count, int* datatype, int* root, int* comm, int* ierr);
325 void mpi_reduce_(void* sendbuf, void* recvbuf, int* count,
326                   int* datatype, int* op, int* root, int* comm, int* ierr);
327 void mpi_allreduce_(void* sendbuf, void* recvbuf, int* count, int* datatype,
328                      int* op, int* comm, int* ierr);
329 void mpi_reduce_scatter_(void* sendbuf, void* recvbuf, int* recvcounts, int* datatype,
330                      int* op, int* comm, int* ierr) ;
331 void mpi_scatter_(void* sendbuf, int* sendcount, int* sendtype,
332                    void* recvbuf, int* recvcount, int* recvtype,
333                    int* root, int* comm, int* ierr);
334 void mpi_scatterv_(void* sendbuf, int* sendcounts, int* displs, int* sendtype,
335                    void* recvbuf, int* recvcount, int* recvtype,
336                    int* root, int* comm, int* ierr);
337 void mpi_gather_(void* sendbuf, int* sendcount, int* sendtype,
338                   void* recvbuf, int* recvcount, int* recvtype,
339                   int* root, int* comm, int* ierr);
340 void mpi_gatherv_(void* sendbuf, int* sendcount, int* sendtype,
341                   void* recvbuf, int* recvcounts, int* displs, int* recvtype,
342                   int* root, int* comm, int* ierr);
343 void mpi_allgather_(void* sendbuf, int* sendcount, int* sendtype,
344                      void* recvbuf, int* recvcount, int* recvtype,
345                      int* comm, int* ierr);
346 void mpi_allgatherv_(void* sendbuf, int* sendcount, int* sendtype,
347                      void* recvbuf, int* recvcount,int* displs, int* recvtype,
348                      int* comm, int* ierr) ;
349 void mpi_type_size_(int* datatype, int *size, int* ierr);
350
351 void mpi_scan_(void* sendbuf, void* recvbuf, int* count, int* datatype,
352                 int* op, int* comm, int* ierr);
353 void mpi_alltoall_(void* sendbuf, int* sendcount, int* sendtype,
354                     void* recvbuf, int* recvcount, int* recvtype, int* comm, int* ierr);
355 void mpi_alltoallv_(void* sendbuf, int* sendcounts, int* senddisps, int* sendtype,
356                     void* recvbuf, int* recvcounts, int* recvdisps, int* recvtype, int* comm, int* ierr);
357 void mpi_get_processor_name_(char *name, int *resultlen, int* ierr);
358 void mpi_test_ (int * request, int *flag, MPI_Status * status, int* ierr);
359 void mpi_testall_ (int* count, int * requests,  int *flag, MPI_Status * statuses, int* ierr);
360 void mpi_get_count_(MPI_Status * status, int* datatype, int *count, int* ierr);
361 void mpi_type_extent_(int* datatype, MPI_Aint * extent, int* ierr);
362 void mpi_attr_get_(int* comm, int* keyval, void* attr_value, int* flag, int* ierr );
363 void mpi_type_commit_(int* datatype,  int* ierr);
364 void mpi_type_vector_(int* count, int* blocklen, int* stride, int* old_type, int* newtype,  int* ierr);
365 void mpi_type_create_vector_(int* count, int* blocklen, int* stride, int* old_type, int* newtype,  int* ierr);
366 void mpi_type_hvector_(int* count, int* blocklen, MPI_Aint* stride, int* old_type, int* newtype,  int* ierr);
367 void mpi_type_create_hvector_(int* count, int* blocklen, MPI_Aint* stride, int* old_type, int* newtype,  int* ierr);
368 void mpi_type_free_(int* datatype, int* ierr);
369 void mpi_type_lb_(int* datatype, MPI_Aint * extent, int* ierr);
370 void mpi_type_ub_(int* datatype, MPI_Aint * extent, int* ierr);
371 void mpi_win_fence_( int* assert,  int* win, int* ierr);
372 void mpi_win_free_( int* win, int* ierr);
373 void mpi_win_create_( int *base, MPI_Aint* size, int* disp_unit, int* info, int* comm, int *win, int* ierr);
374 void mpi_info_create_( int *info, int* ierr);
375 void mpi_info_set_( int *info, char *key, char *value, int* ierr);
376 void mpi_info_free_(int* info, int* ierr);
377 void mpi_get_( int *origin_addr, int* origin_count, int* origin_datatype, int* target_rank,
378     MPI_Aint* target_disp, int* target_count, int* target_datatype, int* win, int* ierr);
379 void mpi_error_string_(int* errorcode, char* string, int* resultlen, int* ierr);
380 void mpi_sendrecv_(void* sendbuf, int* sendcount, int* sendtype, int* dst,
381                 int* sendtag, void *recvbuf, int* recvcount,
382                 int* recvtype, int* src, int* recvtag,
383                 int* comm, MPI_Status* status, int* ierr);
384
385 /********** Tracing **********/
386 /* from smpi_instr.c */
387 void TRACE_internal_smpi_set_category (const char *category);
388 const char *TRACE_internal_smpi_get_category (void);
389 void TRACE_smpi_collective_in(int rank, int root, const char *operation);
390 void TRACE_smpi_collective_out(int rank, int root, const char *operation);
391 void TRACE_smpi_computing_init(int rank);
392 void TRACE_smpi_computing_out(int rank);
393 void TRACE_smpi_computing_in(int rank);
394
395 #endif