Logo AND Algorithmique Numérique Distribuée

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