src/smpi/smpi_datatype.cpp

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