src/smpi/bindings/smpi_pmpi_type.cpp

   1 /* Copyright (c) 2007-2021. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "private.hpp"
   7 #include "smpi_datatype_derived.hpp"
   8
   9 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(smpi_pmpi);
  10
  11 /* PMPI User level calls */
  12
  13 int PMPI_Type_free(MPI_Datatype * datatype)
  14 {
  15   /* Free a predefined datatype is an error according to the standard, and should be checked for */
  16   if (*datatype == MPI_DATATYPE_NULL || (*datatype)->flags() & DT_FLAG_PREDEFINED) {
  17     return MPI_ERR_TYPE;
  18   } else {
  19     simgrid::smpi::Datatype::unref(*datatype);
  20     *datatype=MPI_DATATYPE_NULL;
  21     return MPI_SUCCESS;
  22   }
  23 }
  24
  25 int PMPI_Type_size(MPI_Datatype datatype, int *size)
  26 {
  27   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
  28   CHECK_NULL(2, MPI_ERR_ARG, size)
  29   *size = static_cast<int>(datatype->size());
  30   return MPI_SUCCESS;
  31 }
  32
  33 int PMPI_Type_size_x(MPI_Datatype datatype, MPI_Count *size)
  34 {
  35   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
  36   CHECK_NULL(2, MPI_ERR_ARG, size)
  37   *size = static_cast<MPI_Count>(datatype->size());
  38   return MPI_SUCCESS;
  39 }
  40
  41 int PMPI_Type_get_extent(MPI_Datatype datatype, MPI_Aint * lb, MPI_Aint * extent)
  42 {
  43   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
  44   CHECK_NULL(2, MPI_ERR_ARG, lb)
  45   CHECK_NULL(3, MPI_ERR_ARG, extent)
  46   return datatype->extent(lb, extent);
  47 }
  48
  49 int PMPI_Type_get_extent_x(MPI_Datatype datatype, MPI_Count * lb, MPI_Count * extent)
  50 {
  51   MPI_Aint tmplb, tmpext;
  52   int ret = PMPI_Type_get_extent(datatype, &tmplb, &tmpext);
  53   *lb = static_cast<MPI_Count>(tmplb);
  54   *extent = static_cast<MPI_Count>(tmpext);
  55   return ret;
  56 }
  57
  58 int PMPI_Type_get_true_extent(MPI_Datatype datatype, MPI_Aint * lb, MPI_Aint * extent)
  59 {
  60   return PMPI_Type_get_extent(datatype, lb, extent);
  61 }
  62
  63 int PMPI_Type_get_true_extent_x(MPI_Datatype datatype, MPI_Count * lb, MPI_Count * extent)
  64 {
  65   return PMPI_Type_get_extent_x(datatype, lb, extent);
  66 }
  67
  68 int PMPI_Type_extent(MPI_Datatype datatype, MPI_Aint * extent)
  69 {
  70   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
  71   CHECK_NULL(2, MPI_ERR_ARG, extent)
  72   *extent = datatype->get_extent();
  73   return MPI_SUCCESS;
  74 }
  75
  76 int PMPI_Type_lb(MPI_Datatype datatype, MPI_Aint * disp)
  77 {
  78   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
  79   CHECK_NULL(2, MPI_ERR_ARG, disp)
  80   *disp = datatype->lb();
  81   return MPI_SUCCESS;
  82 }
  83
  84 int PMPI_Type_ub(MPI_Datatype datatype, MPI_Aint * disp)
  85 {
  86   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
  87   CHECK_NULL(2, MPI_ERR_ARG, disp)
  88   *disp = datatype->ub();
  89   return MPI_SUCCESS;
  90 }
  91
  92 int PMPI_Type_dup(MPI_Datatype datatype, MPI_Datatype *newtype){
  93   int retval = MPI_SUCCESS;
  94   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
  95   retval = datatype->clone(newtype);
  96   //error when duplicating, free the new datatype
  97   if(retval!=MPI_SUCCESS){
  98     simgrid::smpi::Datatype::unref(*newtype);
  99     *newtype = MPI_DATATYPE_NULL;
 100   }
 101   return retval;
 102 }
 103
 104 int PMPI_Type_contiguous(int count, MPI_Datatype old_type, MPI_Datatype* new_type) {
 105   CHECK_COUNT(1, count)
 106   CHECK_MPI_NULL(2, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
 107   CHECK_NULL(3, MPI_ERR_ARG, new_type)
 108   return simgrid::smpi::Datatype::create_contiguous(count, old_type, 0, new_type);
 109 }
 110
 111 int PMPI_Type_commit(MPI_Datatype* datatype) {
 112   CHECK_NULL(1, MPI_ERR_ARG, datatype)
 113   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, (*datatype))
 114   (*datatype)->commit();
 115   return MPI_SUCCESS;
 116 }
 117
 118 int PMPI_Type_vector(int count, int blocklen, int stride, MPI_Datatype old_type, MPI_Datatype* new_type) {
 119   CHECK_COUNT(1, count)
 120   CHECK_NEGATIVE(2, MPI_ERR_ARG, blocklen)
 121   CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
 122   return simgrid::smpi::Datatype::create_vector(count, blocklen, stride, old_type, new_type);
 123 }
 124
 125 int PMPI_Type_hvector(int count, int blocklen, MPI_Aint stride, MPI_Datatype old_type, MPI_Datatype* new_type) {
 126   CHECK_COUNT(1, count)
 127   CHECK_NEGATIVE(2, MPI_ERR_ARG, blocklen)
 128   CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
 129   return simgrid::smpi::Datatype::create_hvector(count, blocklen, stride, old_type, new_type);
 130 }
 131
 132 int PMPI_Type_create_hvector(int count, int blocklen, MPI_Aint stride, MPI_Datatype old_type, MPI_Datatype* new_type) {
 133   return MPI_Type_hvector(count, blocklen, stride, old_type, new_type);
 134 }
 135
 136 int PMPI_Type_indexed(int count, const int* blocklens, const int* indices, MPI_Datatype old_type, MPI_Datatype* new_type) {
 137   CHECK_COUNT(1, count)
 138   CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
 139   return simgrid::smpi::Datatype::create_indexed(count, blocklens, indices, old_type, new_type);
 140 }
 141
 142 int PMPI_Type_create_indexed(int count, const int* blocklens, const int* indices, MPI_Datatype old_type, MPI_Datatype* new_type) {
 143   CHECK_COUNT(1, count)
 144   CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
 145   return simgrid::smpi::Datatype::create_indexed(count, blocklens, indices, old_type, new_type);
 146 }
 147
 148 int PMPI_Type_create_indexed_block(int count, int blocklength, const int* indices, MPI_Datatype old_type,
 149                                    MPI_Datatype* new_type)
 150 {
 151   CHECK_COUNT(1, count)
 152   CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
 153   auto* blocklens = static_cast<int*>(xbt_malloc(blocklength * count * sizeof(int)));
 154   for (int i    = 0; i < count; i++)
 155     blocklens[i]=blocklength;
 156   int retval    = simgrid::smpi::Datatype::create_indexed(count, blocklens, indices, old_type, new_type);
 157   xbt_free(blocklens);
 158   return retval;
 159 }
 160
 161 int PMPI_Type_hindexed(int count, const int* blocklens, const MPI_Aint* indices, MPI_Datatype old_type,
 162                        MPI_Datatype* new_type)
 163 {
 164   CHECK_COUNT(1, count)
 165   CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
 166   return simgrid::smpi::Datatype::create_hindexed(count, blocklens, indices, old_type, new_type);
 167 }
 168
 169 int PMPI_Type_create_hindexed(int count, const int* blocklens, const MPI_Aint* indices, MPI_Datatype old_type,
 170                               MPI_Datatype* new_type) {
 171   return PMPI_Type_hindexed(count, blocklens, indices, old_type, new_type);
 172 }
 173
 174 int PMPI_Type_create_hindexed_block(int count, int blocklength, const MPI_Aint* indices, MPI_Datatype old_type,
 175                                     MPI_Datatype* new_type) {
 176   CHECK_COUNT(1, count)
 177   CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_type)
 178   auto* blocklens = static_cast<int*>(xbt_malloc(blocklength * count * sizeof(int)));
 179   for (int i     = 0; i < count; i++)
 180     blocklens[i] = blocklength;
 181   int retval     = simgrid::smpi::Datatype::create_hindexed(count, blocklens, indices, old_type, new_type);
 182   xbt_free(blocklens);
 183   return retval;
 184 }
 185
 186 int PMPI_Type_struct(int count, const int* blocklens, const MPI_Aint* indices, const MPI_Datatype* old_types,
 187                      MPI_Datatype* new_type)
 188 {
 189   CHECK_COUNT(1, count)
 190   for(int i=0; i<count; i++)
 191     CHECK_MPI_NULL(4, MPI_DATATYPE_NULL, MPI_ERR_TYPE, old_types[i])
 192   return simgrid::smpi::Datatype::create_struct(count, blocklens, indices, old_types, new_type);
 193 }
 194
 195 int PMPI_Type_create_struct(int count, const int* blocklens, const MPI_Aint* indices, const MPI_Datatype* old_types,
 196                             MPI_Datatype* new_type) {
 197   return PMPI_Type_struct(count, blocklens, indices, old_types, new_type);
 198 }
 199
 200
 201 int PMPI_Type_create_subarray(int ndims, const int* array_of_sizes,
 202                              const int* array_of_subsizes, const int* array_of_starts,
 203                              int order, MPI_Datatype oldtype, MPI_Datatype *newtype) {
 204   CHECK_NEGATIVE(1, MPI_ERR_COUNT, ndims)
 205   if (ndims==0){
 206     *newtype = MPI_DATATYPE_NULL;
 207     return MPI_SUCCESS;
 208   } else if (ndims==1){
 209     simgrid::smpi::Datatype::create_contiguous( array_of_subsizes[0], oldtype, array_of_starts[0]*oldtype->get_extent(), newtype);
 210     return MPI_SUCCESS;
 211   } else if (oldtype == MPI_DATATYPE_NULL || not oldtype->is_valid() ) {
 212     return MPI_ERR_TYPE;
 213   } else if (order != MPI_ORDER_FORTRAN && order != MPI_ORDER_C){
 214     return MPI_ERR_ARG;
 215   } else {
 216     return simgrid::smpi::Datatype::create_subarray(ndims, array_of_sizes, array_of_subsizes, array_of_starts, order, oldtype, newtype);
 217   }
 218 }
 219
 220 int PMPI_Type_create_resized(MPI_Datatype oldtype,MPI_Aint lb, MPI_Aint extent, MPI_Datatype *newtype){
 221   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, oldtype)
 222   return simgrid::smpi::Datatype::create_resized(oldtype, lb, extent, newtype);
 223 }
 224
 225
 226 int PMPI_Type_set_name(MPI_Datatype  datatype, const char * name)
 227 {
 228   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
 229   CHECK_NULL(2, MPI_ERR_ARG, name)
 230   datatype->set_name(name);
 231   return MPI_SUCCESS;
 232 }
 233
 234 int PMPI_Type_get_name(MPI_Datatype  datatype, char * name, int* len)
 235 {
 236   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, datatype)
 237   CHECK_NULL(2, MPI_ERR_ARG, name)
 238   datatype->get_name(name, len);
 239   return MPI_SUCCESS;
 240 }
 241
 242 MPI_Datatype PMPI_Type_f2c(MPI_Fint datatype){
 243   if(datatype==-1)
 244     return MPI_DATATYPE_NULL;
 245   return static_cast<MPI_Datatype>(simgrid::smpi::F2C::f2c(datatype));
 246 }
 247
 248 MPI_Fint PMPI_Type_c2f(MPI_Datatype datatype){
 249   if(datatype==MPI_DATATYPE_NULL)
 250     return -1;
 251   return datatype->c2f();
 252 }
 253
 254 int PMPI_Type_get_attr (MPI_Datatype type, int type_keyval, void *attribute_val, int* flag)
 255 {
 256   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, type)
 257   return type->attr_get<simgrid::smpi::Datatype>(type_keyval, attribute_val, flag);
 258 }
 259
 260 int PMPI_Type_set_attr (MPI_Datatype type, int type_keyval, void *attribute_val)
 261 {
 262   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, type)
 263   return type->attr_put<simgrid::smpi::Datatype>(type_keyval, attribute_val);
 264 }
 265
 266 int PMPI_Type_get_contents (MPI_Datatype type, int max_integers, int max_addresses,
 267                             int max_datatypes, int* array_of_integers, MPI_Aint* array_of_addresses,
 268                             MPI_Datatype *array_of_datatypes)
 269 {
 270   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, type)
 271   CHECK_NEGATIVE(2, MPI_ERR_COUNT, max_integers)
 272   CHECK_NEGATIVE(3, MPI_ERR_COUNT, max_addresses)
 273   CHECK_NEGATIVE(4, MPI_ERR_COUNT, max_datatypes)
 274   if(max_integers>0)
 275     CHECK_NULL(5, MPI_ERR_ARG, array_of_integers)
 276   if(max_addresses!=0)
 277     CHECK_NULL(6, MPI_ERR_ARG, array_of_addresses)
 278   if(max_datatypes!=0)
 279     CHECK_NULL(7, MPI_ERR_ARG, array_of_datatypes)
 280   return type->get_contents(max_integers, max_addresses, max_datatypes,
 281                             array_of_integers, array_of_addresses, array_of_datatypes);
 282 }
 283
 284 int PMPI_Type_get_envelope (MPI_Datatype type, int *num_integers, int *num_addresses,
 285                             int *num_datatypes, int *combiner)
 286 {
 287   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, type)
 288   CHECK_NULL(2, MPI_ERR_ARG, num_integers)
 289   CHECK_NULL(3, MPI_ERR_ARG, num_addresses)
 290   CHECK_NULL(4, MPI_ERR_ARG, num_datatypes)
 291   CHECK_NULL(5, MPI_ERR_ARG, combiner)
 292   return type->get_envelope(num_integers, num_addresses, num_datatypes, combiner);
 293 }
 294
 295 int PMPI_Type_delete_attr (MPI_Datatype type, int type_keyval)
 296 {
 297   CHECK_MPI_NULL(1, MPI_DATATYPE_NULL, MPI_ERR_TYPE, type)
 298   return type->attr_delete<simgrid::smpi::Datatype>(type_keyval);
 299 }
 300
 301 int PMPI_Type_create_keyval(MPI_Type_copy_attr_function* copy_fn, MPI_Type_delete_attr_function* delete_fn, int* keyval,
 302                             void* extra_state)
 303 {
 304   smpi_copy_fn _copy_fn={nullptr,copy_fn,nullptr,nullptr,nullptr,nullptr};
 305   smpi_delete_fn _delete_fn={nullptr,delete_fn,nullptr,nullptr,nullptr,nullptr};
 306   return simgrid::smpi::Keyval::keyval_create<simgrid::smpi::Datatype>(_copy_fn, _delete_fn, keyval, extra_state);
 307 }
 308
 309 int PMPI_Type_free_keyval(int* keyval) {
 310   return simgrid::smpi::Keyval::keyval_free<simgrid::smpi::Datatype>(keyval);
 311 }
 312
 313 int PMPI_Unpack(const void* inbuf, int incount, int* position, void* outbuf, int outcount, MPI_Datatype type, MPI_Comm comm) {
 314   CHECK_NEGATIVE(2, MPI_ERR_COUNT, incount)
 315   CHECK_NEGATIVE(5, MPI_ERR_COUNT, outcount)
 316   CHECK_BUFFER(1, inbuf, incount)
 317   CHECK_BUFFER(4, outbuf, outcount)
 318   CHECK_TYPE(6, type)
 319   CHECK_COMM(7)
 320   return type->unpack(inbuf, incount, position, outbuf,outcount, comm);
 321 }
 322
 323 int PMPI_Pack(const void* inbuf, int incount, MPI_Datatype type, void* outbuf, int outcount, int* position, MPI_Comm comm) {
 324   CHECK_NEGATIVE(2, MPI_ERR_COUNT, incount)
 325   CHECK_NEGATIVE(5, MPI_ERR_COUNT, outcount)
 326   CHECK_BUFFER(1, inbuf, incount)
 327   CHECK_BUFFER(4, outbuf, outcount)
 328   CHECK_TYPE(6, type)
 329   CHECK_COMM(7)
 330   return type->pack(inbuf == MPI_BOTTOM ? nullptr : inbuf, incount, outbuf, outcount, position, comm);
 331 }
 332
 333 int PMPI_Pack_size(int incount, MPI_Datatype datatype, MPI_Comm comm, int* size) {
 334   CHECK_NEGATIVE(1, MPI_ERR_COUNT, incount)
 335   CHECK_TYPE(2, datatype)
 336   CHECK_COMM(3)
 337   *size=incount*datatype->size();
 338   return MPI_SUCCESS;
 339 }