Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Move check for MPI_BOTTOM one level up.
[simgrid.git] / src / smpi / mpi / smpi_datatype.cpp
1 /* smpi_datatype.cpp -- MPI primitives to handle datatypes                  */
2 /* Copyright (c) 2009-2017. The SimGrid Team.  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 #include "simgrid/modelchecker.h"
8 #include "private.hpp"
9 #include "smpi_datatype_derived.hpp"
10 #include "smpi_op.hpp"
11 #include "smpi_process.hpp"
12
13 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_datatype, smpi, "Logging specific to SMPI (datatype)");
14
15 #define CREATE_MPI_DATATYPE(name, type)               \
16   static simgrid::smpi::Datatype mpi_##name (         \
17     (char*) # name,                                   \
18     sizeof(type),   /* size */                        \
19     0,              /* lb */                          \
20     sizeof(type),   /* ub = lb + size */              \
21     DT_FLAG_BASIC  /* flags */                        \
22   );                                                  \
23 const MPI_Datatype name = &mpi_##name;
24
25 #define CREATE_MPI_DATATYPE_NULL(name)                \
26   static simgrid::smpi::Datatype mpi_##name (         \
27     (char*) # name,                                   \
28     0,              /* size */                        \
29     0,              /* lb */                          \
30     0,              /* ub = lb + size */              \
31     DT_FLAG_BASIC  /* flags */                       \
32   );                                                  \
33 const MPI_Datatype name = &mpi_##name;
34
35 // Predefined data types
36 CREATE_MPI_DATATYPE(MPI_CHAR, char);
37 CREATE_MPI_DATATYPE(MPI_SHORT, short);
38 CREATE_MPI_DATATYPE(MPI_INT, int);
39 CREATE_MPI_DATATYPE(MPI_LONG, long);
40 CREATE_MPI_DATATYPE(MPI_LONG_LONG, long long);
41 CREATE_MPI_DATATYPE(MPI_SIGNED_CHAR, signed char);
42 CREATE_MPI_DATATYPE(MPI_UNSIGNED_CHAR, unsigned char);
43 CREATE_MPI_DATATYPE(MPI_UNSIGNED_SHORT, unsigned short);
44 CREATE_MPI_DATATYPE(MPI_UNSIGNED, unsigned int);
45 CREATE_MPI_DATATYPE(MPI_UNSIGNED_LONG, unsigned long);
46 CREATE_MPI_DATATYPE(MPI_UNSIGNED_LONG_LONG, unsigned long long);
47 CREATE_MPI_DATATYPE(MPI_FLOAT, float);
48 CREATE_MPI_DATATYPE(MPI_DOUBLE, double);
49 CREATE_MPI_DATATYPE(MPI_LONG_DOUBLE, long double);
50 CREATE_MPI_DATATYPE(MPI_WCHAR, wchar_t);
51 CREATE_MPI_DATATYPE(MPI_C_BOOL, bool);
52 CREATE_MPI_DATATYPE(MPI_BYTE, int8_t);
53 CREATE_MPI_DATATYPE(MPI_INT8_T, int8_t);
54 CREATE_MPI_DATATYPE(MPI_INT16_T, int16_t);
55 CREATE_MPI_DATATYPE(MPI_INT32_T, int32_t);
56 CREATE_MPI_DATATYPE(MPI_INT64_T, int64_t);
57 CREATE_MPI_DATATYPE(MPI_UINT8_T, uint8_t);
58 CREATE_MPI_DATATYPE(MPI_UINT16_T, uint16_t);
59 CREATE_MPI_DATATYPE(MPI_UINT32_T, uint32_t);
60 CREATE_MPI_DATATYPE(MPI_UINT64_T, uint64_t);
61 CREATE_MPI_DATATYPE(MPI_C_FLOAT_COMPLEX, float _Complex);
62 CREATE_MPI_DATATYPE(MPI_C_DOUBLE_COMPLEX, double _Complex);
63 CREATE_MPI_DATATYPE(MPI_C_LONG_DOUBLE_COMPLEX, long double _Complex);
64 CREATE_MPI_DATATYPE(MPI_AINT, MPI_Aint);
65 CREATE_MPI_DATATYPE(MPI_OFFSET, MPI_Offset);
66
67 CREATE_MPI_DATATYPE(MPI_FLOAT_INT, float_int);
68 CREATE_MPI_DATATYPE(MPI_LONG_INT, long_int);
69 CREATE_MPI_DATATYPE(MPI_DOUBLE_INT, double_int);
70 CREATE_MPI_DATATYPE(MPI_SHORT_INT, short_int);
71 CREATE_MPI_DATATYPE(MPI_2INT, int_int);
72 CREATE_MPI_DATATYPE(MPI_2FLOAT, float_float);
73 CREATE_MPI_DATATYPE(MPI_2DOUBLE, double_double);
74 CREATE_MPI_DATATYPE(MPI_2LONG, long_long);
75
76 CREATE_MPI_DATATYPE(MPI_REAL, float);
77 CREATE_MPI_DATATYPE(MPI_REAL4, float);
78 CREATE_MPI_DATATYPE(MPI_REAL8, float);
79 CREATE_MPI_DATATYPE(MPI_REAL16, double);
80 CREATE_MPI_DATATYPE_NULL(MPI_COMPLEX8);
81 CREATE_MPI_DATATYPE_NULL(MPI_COMPLEX16);
82 CREATE_MPI_DATATYPE_NULL(MPI_COMPLEX32);
83 CREATE_MPI_DATATYPE(MPI_INTEGER1, int);
84 CREATE_MPI_DATATYPE(MPI_INTEGER2, int16_t);
85 CREATE_MPI_DATATYPE(MPI_INTEGER4, int32_t);
86 CREATE_MPI_DATATYPE(MPI_INTEGER8, int64_t);
87 CREATE_MPI_DATATYPE(MPI_INTEGER16, integer128_t);
88
89 CREATE_MPI_DATATYPE(MPI_LONG_DOUBLE_INT, long_double_int);
90
91 CREATE_MPI_DATATYPE_NULL(MPI_UB);
92 CREATE_MPI_DATATYPE_NULL(MPI_LB);
93 CREATE_MPI_DATATYPE(MPI_PACKED, char);
94 // Internal use only
95 CREATE_MPI_DATATYPE(MPI_PTR, void*);
96
97 namespace simgrid{
98 namespace smpi{
99
100 std::unordered_map<int, smpi_key_elem> Datatype::keyvals_;
101 int Datatype::keyval_id_=0;
102
103 Datatype::Datatype(int size,MPI_Aint lb, MPI_Aint ub, int flags) : name_(nullptr), size_(size), lb_(lb), ub_(ub), flags_(flags), refcount_(1){
104 #if SIMGRID_HAVE_MC
105   if(MC_is_active())
106     MC_ignore(&(refcount_), sizeof(refcount_));
107 #endif
108 }
109
110 //for predefined types, so in_use = 0.
111 Datatype::Datatype(char* name, int size,MPI_Aint lb, MPI_Aint ub, int flags) : name_(name), size_(size), lb_(lb), ub_(ub), flags_(flags), refcount_(0){
112 #if SIMGRID_HAVE_MC
113   if(MC_is_active())
114     MC_ignore(&(refcount_), sizeof(refcount_));
115 #endif
116 }
117
118 Datatype::Datatype(Datatype *datatype, int* ret) : name_(nullptr), lb_(datatype->lb_), ub_(datatype->ub_), flags_(datatype->flags_), refcount_(1)
119 {
120   flags_ &= ~DT_FLAG_PREDEFINED;
121   *ret = MPI_SUCCESS;
122   if(datatype->name_)
123     name_ = xbt_strdup(datatype->name_);
124
125   if (not datatype->attributes()->empty()) {
126     int flag;
127     void* value_out;
128     for(auto it = datatype->attributes()->begin(); it != datatype->attributes()->end(); it++){
129       smpi_key_elem elem = keyvals_.at((*it).first);
130
131       if (elem != nullptr && elem->copy_fn.type_copy_fn != MPI_NULL_COPY_FN) {
132         *ret = elem->copy_fn.type_copy_fn(datatype, (*it).first, nullptr, (*it).second, &value_out, &flag);
133         if (*ret != MPI_SUCCESS) {
134           break;
135         }
136         if (flag){
137           elem->refcount++;
138           attributes()->insert({(*it).first, value_out});
139         }
140       }
141     }
142   }
143 }
144
145 Datatype::~Datatype(){
146   xbt_assert(refcount_ >= 0);
147
148   if(flags_ & DT_FLAG_PREDEFINED)
149     return;
150
151   //if still used, mark for deletion
152   if(refcount_!=0){
153       flags_ |=DT_FLAG_DESTROYED;
154       return;
155   }
156
157   cleanup_attr<Datatype>();
158
159   xbt_free(name_);
160 }
161
162
163 void Datatype::ref(){
164
165   refcount_++;
166
167 #if SIMGRID_HAVE_MC
168   if(MC_is_active())
169     MC_ignore(&(refcount_), sizeof(refcount_));
170 #endif
171 }
172
173 void Datatype::unref(MPI_Datatype datatype)
174 {
175   if (datatype->refcount_ > 0)
176     datatype->refcount_--;
177
178   if (datatype->refcount_ == 0 && not(datatype->flags_ & DT_FLAG_PREDEFINED))
179     delete datatype;
180
181 #if SIMGRID_HAVE_MC
182   if(MC_is_active())
183     MC_ignore(&(datatype->refcount_), sizeof(datatype->refcount_));
184 #endif
185 }
186
187 void Datatype::commit()
188 {
189   flags_ |= DT_FLAG_COMMITED;
190 }
191
192 bool Datatype::is_valid(){
193   return (flags_ & DT_FLAG_COMMITED);
194 }
195
196 bool Datatype::is_basic()
197 {
198   return (flags_ & DT_FLAG_BASIC);
199 }
200
201 size_t Datatype::size(){
202   return size_;
203 }
204
205 int Datatype::flags(){
206   return flags_;
207 }
208
209 int Datatype::refcount(){
210   return refcount_;
211 }
212
213 void Datatype::addflag(int flag){
214   flags_ &= flag;
215 }
216
217 MPI_Aint Datatype::lb(){
218   return lb_;
219 }
220
221 MPI_Aint Datatype::ub(){
222   return ub_;
223 }
224
225 char* Datatype::name(){
226   return name_;
227 }
228
229
230 int Datatype::extent(MPI_Aint * lb, MPI_Aint * extent){
231   *lb = lb_;
232   *extent = ub_ - lb_;
233   return MPI_SUCCESS;
234 }
235
236 MPI_Aint Datatype::get_extent(){
237   return ub_ - lb_;
238 }
239
240 void Datatype::get_name(char* name, int* length){
241   *length = strlen(name_);
242   strncpy(name, name_, *length+1);
243 }
244
245 void Datatype::set_name(char* name){
246   if(name_!=nullptr &&  (flags_ & DT_FLAG_PREDEFINED) == 0)
247     xbt_free(name_);
248   name_ = xbt_strdup(name);
249 }
250
251 int Datatype::pack(void* inbuf, int incount, void* outbuf, int outcount, int* position,MPI_Comm comm){
252   if (outcount - *position < incount*static_cast<int>(size_))
253     return MPI_ERR_BUFFER;
254   Datatype::copy(inbuf, incount, this, static_cast<char*>(outbuf) + *position, outcount, MPI_CHAR);
255   *position += incount * size_;
256   return MPI_SUCCESS;
257 }
258
259 int Datatype::unpack(void* inbuf, int insize, int* position, void* outbuf, int outcount,MPI_Comm comm){
260   if (outcount*static_cast<int>(size_)> insize)
261     return MPI_ERR_BUFFER;
262   Datatype::copy(static_cast<char*>(inbuf) + *position, insize, MPI_CHAR, outbuf, outcount, this);
263   *position += outcount * size_;
264   return MPI_SUCCESS;
265 }
266
267
268 int Datatype::copy(void *sendbuf, int sendcount, MPI_Datatype sendtype,
269                        void *recvbuf, int recvcount, MPI_Datatype recvtype){
270
271 // FIXME Handle the case of a partial shared malloc.
272
273   if(smpi_privatize_global_variables == SMPI_PRIVATIZE_MMAP){
274     smpi_switch_data_segment(smpi_process()->index());
275   }
276   /* First check if we really have something to do */
277   if (recvcount > 0 && recvbuf != sendbuf) {
278     sendcount *= sendtype->size();
279     recvcount *= recvtype->size();
280     int count = sendcount < recvcount ? sendcount : recvcount;
281
282     if (not(sendtype->flags() & DT_FLAG_DERIVED) && not(recvtype->flags() & DT_FLAG_DERIVED)) {
283       if (not smpi_process()->replaying())
284         memcpy(recvbuf, sendbuf, count);
285     } else if (not(sendtype->flags() & DT_FLAG_DERIVED)) {
286       recvtype->unserialize(sendbuf, recvbuf, count / recvtype->size(), MPI_REPLACE);
287     } else if (not(recvtype->flags() & DT_FLAG_DERIVED)) {
288       sendtype->serialize(sendbuf, recvbuf, count / sendtype->size());
289     }else{
290
291       void * buf_tmp = xbt_malloc(count);
292
293       sendtype->serialize( sendbuf, buf_tmp,count/sendtype->size());
294       recvtype->unserialize( buf_tmp, recvbuf,count/recvtype->size(), MPI_REPLACE);
295
296       xbt_free(buf_tmp);
297     }
298   }
299
300   return sendcount > recvcount ? MPI_ERR_TRUNCATE : MPI_SUCCESS;
301 }
302
303 //Default serialization method : memcpy.
304 void Datatype::serialize( void* noncontiguous_buf, void *contiguous_buf, int count){
305   char* contiguous_buf_char = static_cast<char*>(contiguous_buf);
306   char* noncontiguous_buf_char = static_cast<char*>(noncontiguous_buf)+lb_;
307   memcpy(contiguous_buf_char, noncontiguous_buf_char, count*size_);
308
309 }
310
311 void Datatype::unserialize( void* contiguous_buf, void *noncontiguous_buf, int count, MPI_Op op){
312   char* contiguous_buf_char = static_cast<char*>(contiguous_buf);
313   char* noncontiguous_buf_char = static_cast<char*>(noncontiguous_buf)+lb_;
314   int n=count;
315   if(op!=MPI_OP_NULL)
316     op->apply( contiguous_buf_char, noncontiguous_buf_char, &n, this);
317 }
318
319 int Datatype::create_contiguous(int count, MPI_Datatype old_type, MPI_Aint lb, MPI_Datatype* new_type){
320   if(old_type->flags_ & DT_FLAG_DERIVED){
321     //handle this case as a hvector with stride equals to the extent of the datatype
322     return create_hvector(count, 1, old_type->get_extent(), old_type, new_type);
323   }
324   if(count>0)
325     *new_type = new Type_Contiguous(count * old_type->size(), lb, lb + count * old_type->size(),
326                                    DT_FLAG_DERIVED, count, old_type);
327   else
328     *new_type = new Datatype(count * old_type->size(), lb, lb + count * old_type->size(),0);
329   return MPI_SUCCESS;
330 }
331
332 int Datatype::create_vector(int count, int block_length, int stride, MPI_Datatype old_type, MPI_Datatype* new_type)
333 {
334   int retval;
335   if (block_length<0)
336     return MPI_ERR_ARG;
337   MPI_Aint lb = 0;
338   MPI_Aint ub = 0;
339   if(count>0){
340     lb=old_type->lb();
341     ub=((count-1)*stride+block_length-1)*old_type->get_extent()+old_type->ub();
342   }
343   if(old_type->flags() & DT_FLAG_DERIVED || stride != block_length){
344     *new_type = new Type_Vector(count * (block_length) * old_type->size(), lb, ub,
345                                    DT_FLAG_DERIVED, count, block_length, stride, old_type);
346     retval=MPI_SUCCESS;
347   }else{
348     /* in this situation the data are contiguous thus it's not required to serialize and unserialize it*/
349     *new_type = new Datatype(count * block_length * old_type->size(), 0, ((count -1) * stride + block_length)*
350                          old_type->size(), DT_FLAG_CONTIGUOUS);
351     retval=MPI_SUCCESS;
352   }
353   return retval;
354 }
355
356
357 int Datatype::create_hvector(int count, int block_length, MPI_Aint stride, MPI_Datatype old_type, MPI_Datatype* new_type)
358 {
359   int retval;
360   if (block_length<0)
361     return MPI_ERR_ARG;
362   MPI_Aint lb = 0;
363   MPI_Aint ub = 0;
364   if(count>0){
365     lb=old_type->lb();
366     ub=((count-1)*stride)+(block_length-1)*old_type->get_extent()+old_type->ub();
367   }
368   if(old_type->flags() & DT_FLAG_DERIVED || stride != block_length*old_type->get_extent()){
369     *new_type = new Type_Hvector(count * (block_length) * old_type->size(), lb, ub,
370                                    DT_FLAG_DERIVED, count, block_length, stride, old_type);
371     retval=MPI_SUCCESS;
372   }else{
373     /* in this situation the data are contiguous thus it's not required to serialize and unserialize it*/
374     *new_type = new Datatype(count * block_length * old_type->size(), 0, count * block_length * old_type->size(), DT_FLAG_CONTIGUOUS);
375     retval=MPI_SUCCESS;
376   }
377   return retval;
378 }
379
380 int Datatype::create_indexed(int count, int* block_lengths, int* indices, MPI_Datatype old_type, MPI_Datatype* new_type){
381   int size = 0;
382   bool contiguous=true;
383   MPI_Aint lb = 0;
384   MPI_Aint ub = 0;
385   if(count>0){
386     lb=indices[0]*old_type->get_extent();
387     ub=indices[0]*old_type->get_extent() + block_lengths[0]*old_type->ub();
388   }
389
390   for (int i = 0; i < count; i++) {
391     if (block_lengths[i] < 0)
392       return MPI_ERR_ARG;
393     size += block_lengths[i];
394
395     if(indices[i]*old_type->get_extent()+old_type->lb()<lb)
396       lb = indices[i]*old_type->get_extent()+old_type->lb();
397     if(indices[i]*old_type->get_extent()+block_lengths[i]*old_type->ub()>ub)
398       ub = indices[i]*old_type->get_extent()+block_lengths[i]*old_type->ub();
399
400     if ( (i< count -1) && (indices[i]+block_lengths[i] != indices[i+1]) )
401       contiguous=false;
402   }
403   if(old_type->flags_ & DT_FLAG_DERIVED)
404     contiguous=false;
405
406   if (not contiguous) {
407     *new_type = new Type_Indexed(size * old_type->size(),lb,ub,
408                                  DT_FLAG_DERIVED|DT_FLAG_DATA, count, block_lengths, indices, old_type);
409   }else{
410     Datatype::create_contiguous(size, old_type, lb, new_type);
411   }
412   return MPI_SUCCESS;
413 }
414
415 int Datatype::create_hindexed(int count, int* block_lengths, MPI_Aint* indices, MPI_Datatype old_type, MPI_Datatype* new_type){
416   int size = 0;
417   bool contiguous=true;
418   MPI_Aint lb = 0;
419   MPI_Aint ub = 0;
420   if(count>0){
421     lb=indices[0] + old_type->lb();
422     ub=indices[0] + block_lengths[0]*old_type->ub();
423   }
424   for (int i = 0; i < count; i++) {
425     if (block_lengths[i] < 0)
426       return MPI_ERR_ARG;
427     size += block_lengths[i];
428
429     if(indices[i]+old_type->lb()<lb)
430       lb = indices[i]+old_type->lb();
431     if(indices[i]+block_lengths[i]*old_type->ub()>ub)
432       ub = indices[i]+block_lengths[i]*old_type->ub();
433
434     if ( (i< count -1) && (indices[i]+block_lengths[i]*(static_cast<int>(old_type->size())) != indices[i+1]) )
435       contiguous=false;
436   }
437   if (old_type->flags_ & DT_FLAG_DERIVED || lb!=0)
438     contiguous=false;
439
440   if (not contiguous) {
441     *new_type = new Type_Hindexed(size * old_type->size(),lb,ub,
442                                    DT_FLAG_DERIVED|DT_FLAG_DATA, count, block_lengths, indices, old_type);
443   }else{
444     Datatype::create_contiguous(size, old_type, lb, new_type);
445   }
446   return MPI_SUCCESS;
447 }
448
449 int Datatype::create_struct(int count, int* block_lengths, MPI_Aint* indices, MPI_Datatype* old_types, MPI_Datatype* new_type){
450   size_t size = 0;
451   bool contiguous=true;
452   size = 0;
453   MPI_Aint lb = 0;
454   MPI_Aint ub = 0;
455   if(count>0){
456     lb=indices[0] + old_types[0]->lb();
457     ub=indices[0] + block_lengths[0]*old_types[0]->ub();
458   }
459   bool forced_lb=false;
460   bool forced_ub=false;
461   for (int i = 0; i < count; i++) {
462     if (block_lengths[i]<0)
463       return MPI_ERR_ARG;
464     if (old_types[i]->flags_ & DT_FLAG_DERIVED)
465       contiguous=false;
466
467     size += block_lengths[i]*old_types[i]->size();
468     if (old_types[i]==MPI_LB){
469       lb=indices[i];
470       forced_lb=true;
471     }
472     if (old_types[i]==MPI_UB){
473       ub=indices[i];
474       forced_ub=true;
475     }
476
477     if (not forced_lb && indices[i] + old_types[i]->lb() < lb)
478       lb = indices[i];
479     if (not forced_ub && indices[i] + block_lengths[i] * old_types[i]->ub() > ub)
480       ub = indices[i]+block_lengths[i]*old_types[i]->ub();
481
482     if ( (i< count -1) && (indices[i]+block_lengths[i]*static_cast<int>(old_types[i]->size()) != indices[i+1]) )
483       contiguous=false;
484   }
485   if (not contiguous) {
486     *new_type = new Type_Struct(size, lb,ub, DT_FLAG_DERIVED|DT_FLAG_DATA,
487                                 count, block_lengths, indices, old_types);
488   }else{
489     Datatype::create_contiguous(size, MPI_CHAR, lb, new_type);
490   }
491   return MPI_SUCCESS;
492 }
493
494 Datatype* Datatype::f2c(int id){
495   return static_cast<Datatype*>(F2C::f2c(id));
496 }
497
498
499 }
500 }
501