Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
model-checker : fix index of dynar in get_location
[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/smpif.h"
15 #include "smpi/smpi_cocci.h"
16 #include "instr/instr_private.h"
17
18 struct s_smpi_process_data;
19 typedef struct s_smpi_process_data *smpi_process_data_t;
20
21 #define PERSISTENT     0x1
22 #define NON_PERSISTENT 0x2
23 #define SEND           0x4
24 #define RECV           0x8
25 #define RECV_DELETE     0x10
26
27 // this struct is here to handle the problem of non-contignous data
28 // for each such structure these function should be implemented (vector
29 // index hvector hindex struct)
30 typedef struct s_smpi_subtype{
31   void (*serialize)(const void * input, void *output, size_t count, void* subtype);
32   void (*unserialize)(const void * input, void *output, size_t count, void* subtype);
33   void (*subtype_free)(MPI_Datatype* type);
34 } s_smpi_subtype_t;
35
36 typedef struct s_smpi_mpi_datatype{
37   size_t size;
38   /* this let us know if a serialization is required*/
39   size_t has_subtype;
40   MPI_Aint lb;
41   MPI_Aint ub;
42   int flags;
43   /* this let us know how to serialize and unserialize*/
44   void *substruct;
45   int in_use;
46 } s_smpi_mpi_datatype_t;
47
48 //*****************************************************************************************
49
50 typedef struct s_smpi_mpi_request {
51   void *buf;
52   /* in the case of non-contignous memory the user address shoud be keep
53    * to unserialize the data inside the user memory*/
54   void *old_buf;
55   /* this let us know how tounserialize at the end of
56    * the communication*/
57   MPI_Datatype old_type;
58   size_t size;
59   int src;
60   int dst;
61   int tag;
62   //to handle cases where we have an unknown sender
63   //We can't override src, tag, and size, because the request may be reused later
64   int real_src;
65   int real_tag;
66   int truncated;
67   size_t real_size;
68   MPI_Comm comm;
69   smx_action_t action;
70   unsigned flags;
71   int detached;
72   MPI_Request detached_sender;
73   int refcount;
74 #ifdef HAVE_TRACING
75   int send;
76   int recv;
77 #endif
78 } s_smpi_mpi_request_t;
79
80 void smpi_process_init(int *argc, char ***argv);
81 void smpi_process_destroy(void);
82 void smpi_process_finalize(void);
83
84 smpi_process_data_t smpi_process_data(void);
85 smpi_process_data_t smpi_process_remote_data(int index);
86 void smpi_process_set_user_data(void *);
87 void* smpi_process_get_user_data(void);
88 int smpi_process_count(void);
89 smx_rdv_t smpi_process_mailbox(void);
90 smx_rdv_t smpi_process_remote_mailbox(int index);
91 smx_rdv_t smpi_process_mailbox_small(void);
92 smx_rdv_t smpi_process_remote_mailbox_small(int index);
93 xbt_os_timer_t smpi_process_timer(void);
94 void smpi_process_simulated_start(void);
95 double smpi_process_simulated_elapsed(void);
96
97 void print_request(const char *message, MPI_Request request);
98
99 void smpi_global_init(void);
100 void smpi_global_destroy(void);
101
102 size_t smpi_datatype_size(MPI_Datatype datatype);
103 MPI_Aint smpi_datatype_lb(MPI_Datatype datatype);
104 MPI_Aint smpi_datatype_ub(MPI_Datatype datatype);
105 int smpi_datatype_extent(MPI_Datatype datatype, MPI_Aint * lb,
106                          MPI_Aint * extent);
107 MPI_Aint smpi_datatype_get_extent(MPI_Datatype datatype);
108 int smpi_datatype_copy(void *sendbuf, int sendcount, MPI_Datatype sendtype,
109                        void *recvbuf, int recvcount,
110                        MPI_Datatype recvtype);
111 void smpi_datatype_use(MPI_Datatype type);
112 void smpi_datatype_unuse(MPI_Datatype type);
113
114 int smpi_datatype_contiguous(int count, MPI_Datatype old_type,
115                        MPI_Datatype* new_type);
116 int smpi_datatype_vector(int count, int blocklen, int stride,
117                       MPI_Datatype old_type, MPI_Datatype* new_type);
118
119 int smpi_datatype_hvector(int count, int blocklen, MPI_Aint stride,
120                       MPI_Datatype old_type, MPI_Datatype* new_type);
121 int smpi_datatype_indexed(int count, int* blocklens, int* indices,
122                      MPI_Datatype old_type, MPI_Datatype* new_type);
123 int smpi_datatype_hindexed(int count, int* blocklens, MPI_Aint* indices,
124                      MPI_Datatype old_type, MPI_Datatype* new_type);
125 int smpi_datatype_struct(int count, int* blocklens, MPI_Aint* indices,
126                     MPI_Datatype* old_types, MPI_Datatype* new_type);
127
128 void smpi_datatype_create(MPI_Datatype* new_type, int size,int lb, int ub, int has_subtype, void *struct_type, int flags);
129
130
131 void smpi_datatype_free(MPI_Datatype* type);
132 void smpi_datatype_commit(MPI_Datatype* datatype);
133
134 void smpi_empty_status(MPI_Status * status);
135 MPI_Op smpi_op_new(MPI_User_function * function, int commute);
136 void smpi_op_destroy(MPI_Op op);
137 void smpi_op_apply(MPI_Op op, void *invec, void *inoutvec, int *len,
138                    MPI_Datatype * datatype);
139
140 MPI_Group smpi_group_new(int size);
141 void smpi_group_destroy(MPI_Group group);
142 void smpi_group_set_mapping(MPI_Group group, int index, int rank);
143 int smpi_group_index(MPI_Group group, int rank);
144 int smpi_group_rank(MPI_Group group, int index);
145 int smpi_group_use(MPI_Group group);
146 int smpi_group_unuse(MPI_Group group);
147 int smpi_group_size(MPI_Group group);
148 int smpi_group_compare(MPI_Group group1, MPI_Group group2);
149
150 MPI_Comm smpi_comm_new(MPI_Group group);
151 void smpi_comm_destroy(MPI_Comm comm);
152 MPI_Group smpi_comm_group(MPI_Comm comm);
153 int smpi_comm_size(MPI_Comm comm);
154 void smpi_comm_get_name(MPI_Comm comm, char* name, int* len);
155 int smpi_comm_rank(MPI_Comm comm);
156 MPI_Comm smpi_comm_split(MPI_Comm comm, int color, int key);
157
158 MPI_Request smpi_mpi_send_init(void *buf, int count, MPI_Datatype datatype,
159                                int dst, int tag, MPI_Comm comm);
160 MPI_Request smpi_mpi_recv_init(void *buf, int count, MPI_Datatype datatype,
161                                int src, int tag, MPI_Comm comm);
162 void smpi_mpi_start(MPI_Request request);
163 void smpi_mpi_startall(int count, MPI_Request * requests);
164 void smpi_mpi_request_free(MPI_Request * request);
165 MPI_Request smpi_isend_init(void *buf, int count, MPI_Datatype datatype,
166                             int dst, int tag, MPI_Comm comm);
167 MPI_Request smpi_mpi_isend(void *buf, int count, MPI_Datatype datatype,
168                            int dst, int tag, MPI_Comm comm);
169 MPI_Request smpi_irecv_init(void *buf, int count, MPI_Datatype datatype,
170                             int src, int tag, MPI_Comm comm);
171 MPI_Request smpi_mpi_irecv(void *buf, int count, MPI_Datatype datatype,
172                            int src, int tag, MPI_Comm comm);
173 void smpi_mpi_recv(void *buf, int count, MPI_Datatype datatype, int src,
174                    int tag, MPI_Comm comm, MPI_Status * status);
175 void smpi_mpi_send(void *buf, int count, MPI_Datatype datatype, int dst,
176                    int tag, MPI_Comm comm);
177 void smpi_mpi_sendrecv(void *sendbuf, int sendcount, MPI_Datatype sendtype,
178                        int dst, int sendtag, void *recvbuf, int recvcount,
179                        MPI_Datatype recvtype, int src, int recvtag,
180                        MPI_Comm comm, MPI_Status * status);
181 int smpi_mpi_test(MPI_Request * request, MPI_Status * status);
182 int smpi_mpi_testany(int count, MPI_Request requests[], int *index,
183                      MPI_Status * status);
184 int smpi_mpi_testall(int count, MPI_Request requests[],
185                      MPI_Status status[]);
186 void smpi_mpi_probe(int source, int tag, MPI_Comm comm, MPI_Status* status);
187 void smpi_mpi_iprobe(int source, int tag, MPI_Comm comm, int* flag,
188                     MPI_Status* status);
189 int smpi_mpi_get_count(MPI_Status * status, MPI_Datatype datatype);
190 void smpi_mpi_wait(MPI_Request * request, MPI_Status * status);
191 int smpi_mpi_waitany(int count, MPI_Request requests[],
192                      MPI_Status * status);
193 int smpi_mpi_waitall(int count, MPI_Request requests[],
194                       MPI_Status status[]);
195 int smpi_mpi_waitsome(int incount, MPI_Request requests[], int *indices,
196                       MPI_Status status[]);
197 int smpi_mpi_testsome(int incount, MPI_Request requests[], int *indices,
198                       MPI_Status status[]);
199 void smpi_mpi_bcast(void *buf, int count, MPI_Datatype datatype, int root,
200                     MPI_Comm comm);
201 void smpi_mpi_barrier(MPI_Comm comm);
202 void smpi_mpi_gather(void *sendbuf, int sendcount, MPI_Datatype sendtype,
203                      void *recvbuf, int recvcount, MPI_Datatype recvtype,
204                      int root, MPI_Comm comm);
205 void smpi_mpi_gatherv(void *sendbuf, int sendcount, MPI_Datatype sendtype,
206                       void *recvbuf, int *recvcounts, int *displs,
207                       MPI_Datatype recvtype, int root, MPI_Comm comm);
208 void smpi_mpi_allgather(void *sendbuf, int sendcount,
209                         MPI_Datatype sendtype, void *recvbuf,
210                         int recvcount, MPI_Datatype recvtype,
211                         MPI_Comm comm);
212 void smpi_mpi_allgatherv(void *sendbuf, int sendcount,
213                          MPI_Datatype sendtype, void *recvbuf,
214                          int *recvcounts, int *displs,
215                          MPI_Datatype recvtype, MPI_Comm comm);
216 void smpi_mpi_scatter(void *sendbuf, int sendcount, MPI_Datatype sendtype,
217                       void *recvbuf, int recvcount, MPI_Datatype recvtype,
218                       int root, MPI_Comm comm);
219 void smpi_mpi_scatterv(void *sendbuf, int *sendcounts, int *displs,
220                        MPI_Datatype sendtype, void *recvbuf, int recvcount,
221                        MPI_Datatype recvtype, int root, MPI_Comm comm);
222 void smpi_mpi_reduce(void *sendbuf, void *recvbuf, int count,
223                      MPI_Datatype datatype, MPI_Op op, int root,
224                      MPI_Comm comm);
225 void smpi_mpi_allreduce(void *sendbuf, void *recvbuf, int count,
226                         MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
227 void smpi_mpi_scan(void *sendbuf, void *recvbuf, int count,
228                    MPI_Datatype datatype, MPI_Op op, MPI_Comm comm);
229
230 void nary_tree_bcast(void *buf, int count, MPI_Datatype datatype, int root,
231                      MPI_Comm comm, int arity);
232 void nary_tree_barrier(MPI_Comm comm, int arity);
233
234 int smpi_coll_tuned_alltoall_bruck(void *sendbuf, int sendcount,
235                                    MPI_Datatype sendtype, void *recvbuf,
236                                    int recvcount, MPI_Datatype recvtype,
237                                    MPI_Comm comm);
238 int smpi_coll_tuned_alltoall_basic_linear(void *sendbuf, int sendcount,
239                                           MPI_Datatype sendtype,
240                                           void *recvbuf, int recvcount,
241                                           MPI_Datatype recvtype,
242                                           MPI_Comm comm);
243 int smpi_coll_tuned_alltoall_pairwise(void *sendbuf, int sendcount,
244                                       MPI_Datatype sendtype, void *recvbuf,
245                                       int recvcount, MPI_Datatype recvtype,
246                                       MPI_Comm comm);
247 int smpi_coll_basic_alltoallv(void *sendbuf, int *sendcounts,
248                               int *senddisps, MPI_Datatype sendtype,
249                               void *recvbuf, int *recvcounts,
250                               int *recvdisps, MPI_Datatype recvtype,
251                               MPI_Comm comm);
252
253 // utilities
254 void smpi_bench_destroy(void);
255 void smpi_bench_begin(void);
256 void smpi_bench_end(void);
257 void smpi_execute_flops(double flops);
258
259 // f77 wrappers
260 void mpi_init__(int*);
261 void mpi_finalize__(int*);
262 void mpi_abort__(int* comm, int* errorcode, int* ierr);
263 void mpi_comm_rank__(int* comm, int* rank, int* ierr);
264 void mpi_comm_size__(int* comm, int* size, int* ierr);
265 double mpi_wtime__(void);
266 double mpi_wtick__(void);
267 void mpi_initialized__(int* flag, int* ierr);
268
269 void mpi_comm_dup__(int* comm, int* newcomm, int* ierr);
270 void mpi_comm_create__(int* comm, int* group, int* newcomm, int* ierr);
271 void mpi_comm_free__(int* comm, int* ierr);
272 void mpi_comm_split__(int* comm, int* color, int* key, int* comm_out, int* ierr);
273 void mpi_group_incl__(int* group, int* n, int* key, int* group_out, int* ierr) ;
274 void mpi_comm_group__(int* comm, int* group_out,  int* ierr);
275 void mpi_send_init__(void *buf, int* count, int* datatype, int* dst, int* tag,
276                      int* comm, int* request, int* ierr);
277 void mpi_isend__(void *buf, int* count, int* datatype, int* dst,
278                  int* tag, int* comm, int* request, int* ierr);
279 void mpi_irsend__(void *buf, int* count, int* datatype, int* dst,
280                  int* tag, int* comm, int* request, int* ierr);
281 void mpi_send__(void* buf, int* count, int* datatype, int* dst,
282                 int* tag, int* comm, int* ierr);
283 void mpi_rsend__(void* buf, int* count, int* datatype, int* dst,
284                 int* tag, int* comm, int* ierr);
285 void mpi_recv_init__(void *buf, int* count, int* datatype, int* src, int* tag,
286                      int* comm, int* request, int* ierr);
287 void mpi_irecv__(void *buf, int* count, int* datatype, int* src, int* tag,
288                  int* comm, int* request, int* ierr);
289 void mpi_recv__(void* buf, int* count, int* datatype, int* src,
290                 int* tag, int* comm, MPI_Status* status, int* ierr);
291 void mpi_start__(int* request, int* ierr);
292 void mpi_startall__(int* count, int* requests, int* ierr);
293 void mpi_wait__(int* request, MPI_Status* status, int* ierr);
294 void mpi_waitany__(int* count, int* requests, int* index, MPI_Status* status, int* ierr);
295 void mpi_waitall__(int* count, int* requests, MPI_Status* status, int* ierr);
296
297 void mpi_barrier__(int* comm, int* ierr);
298 void mpi_bcast__(void* buf, int* count, int* datatype, int* root, int* comm, int* ierr);
299 void mpi_reduce__(void* sendbuf, void* recvbuf, int* count,
300                   int* datatype, int* op, int* root, int* comm, int* ierr);
301 void mpi_allreduce__(void* sendbuf, void* recvbuf, int* count, int* datatype,
302                      int* op, int* comm, int* ierr);
303 void mpi_reduce_scatter__(void* sendbuf, void* recvbuf, int* recvcounts, int* datatype,
304                      int* op, int* comm, int* ierr) ;
305 void mpi_scatter__(void* sendbuf, int* sendcount, int* sendtype,
306                    void* recvbuf, int* recvcount, int* recvtype,
307                    int* root, int* comm, int* ierr);
308 void mpi_scatterv__(void* sendbuf, int* sendcounts, int* displs, int* sendtype,
309                    void* recvbuf, int* recvcount, int* recvtype,
310                    int* root, int* comm, int* ierr);
311 void mpi_gather__(void* sendbuf, int* sendcount, int* sendtype,
312                   void* recvbuf, int* recvcount, int* recvtype,
313                   int* root, int* comm, int* ierr);
314 void mpi_gatherv__(void* sendbuf, int* sendcount, int* sendtype,
315                   void* recvbuf, int* recvcounts, int* displs, int* recvtype,
316                   int* root, int* comm, int* ierr);
317 void mpi_allgather__(void* sendbuf, int* sendcount, int* sendtype,
318                      void* recvbuf, int* recvcount, int* recvtype,
319                      int* comm, int* ierr);
320 void mpi_allgatherv__(void* sendbuf, int* sendcount, int* sendtype,
321                      void* recvbuf, int* recvcount,int* displs, int* recvtype,
322                      int* comm, int* ierr) ;
323 void mpi_type_size__(int* datatype, int *size, int* ierr);
324
325 void mpi_scan__(void* sendbuf, void* recvbuf, int* count, int* datatype,
326                 int* op, int* comm, int* ierr);
327 void mpi_alltoall__(void* sendbuf, int* sendcount, int* sendtype,
328                     void* recvbuf, int* recvcount, int* recvtype, int* comm, int* ierr);
329 void mpi_alltoallv__(void* sendbuf, int* sendcounts, int* senddisps, int* sendtype,
330                     void* recvbuf, int* recvcounts, int* recvdisps, int* recvtype, int* comm, int* ierr);
331 void mpi_get_processor_name__(char *name, int *resultlen, int* ierr);
332 void mpi_test__ (int * request, int *flag, MPI_Status * status, int* ierr);
333 void mpi_get_count__(MPI_Status * status, int* datatype, int *count, int* ierr);
334 void mpi_type_extent__(int* datatype, MPI_Aint * extent, int* ierr);
335 void mpi_attr_get__(int* comm, int* keyval, void* attr_value, int* flag, int* ierr );
336 void mpi_type_lb__(int* datatype, MPI_Aint * extent, int* ierr);
337 void mpi_type_ub__(int* datatype, MPI_Aint * extent, int* ierr);
338 void mpi_error_string__(int* errorcode, char* string, int* resultlen, int* ierr);
339 void mpi_sendrecv__(void* sendbuf, int* sendcount, int* sendtype, int* dst,
340                 int* sendtag, void *recvbuf, int* recvcount,
341                 int* recvtype, int* src, int* recvtag,
342                 int* comm, MPI_Status* status, int* ierr);
343
344 /********** Tracing **********/
345 /* from smpi_instr.c */
346 void TRACE_internal_smpi_set_category (const char *category);
347 const char *TRACE_internal_smpi_get_category (void);
348 void TRACE_smpi_collective_in(int rank, int root, const char *operation);
349 void TRACE_smpi_collective_out(int rank, int root, const char *operation);
350 void TRACE_smpi_computing_init(int rank);
351 void TRACE_smpi_computing_out(int rank);
352 void TRACE_smpi_computing_in(int rank);
353
354 #endif