1 /* smpi_datatype.cpp -- MPI primitives to handle datatypes */
2 /* Copyright (c) 2009-2019. The SimGrid Team. All rights reserved. */
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. */
8 #include "simgrid/modelchecker.h"
9 #include "smpi_datatype_derived.hpp"
10 #include "smpi_op.hpp"
11 #include "src/instr/instr_private.hpp"
12 #include "src/smpi/include/smpi_actor.hpp"
16 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_datatype, smpi, "Logging specific to SMPI (datatype)");
18 static std::unordered_map<std::string, simgrid::smpi::Datatype*> id2type_lookup;
20 #define CREATE_MPI_DATATYPE(name, id, type) \
21 static simgrid::smpi::Datatype mpi_##name((char*)#name, id, sizeof(type), /* size */ \
23 sizeof(type), /* ub = lb + size */ \
24 DT_FLAG_BASIC /* flags */ \
26 const MPI_Datatype name = &mpi_##name;
28 #define CREATE_MPI_DATATYPE_NULL(name, id) \
29 static simgrid::smpi::Datatype mpi_##name((char*)#name, id, 0, /* size */ \
31 0, /* ub = lb + size */ \
32 DT_FLAG_BASIC /* flags */ \
34 const MPI_Datatype name = &mpi_##name;
36 // Predefined data types
37 CREATE_MPI_DATATYPE(MPI_CHAR, 2, char);
38 CREATE_MPI_DATATYPE(MPI_SHORT, 3, short);
39 CREATE_MPI_DATATYPE(MPI_INT, 1, int);
40 CREATE_MPI_DATATYPE(MPI_LONG, 4, long);
41 CREATE_MPI_DATATYPE(MPI_LONG_LONG, 7, long long);
42 CREATE_MPI_DATATYPE(MPI_SIGNED_CHAR, 8, signed char);
43 CREATE_MPI_DATATYPE(MPI_UNSIGNED_CHAR, 9, unsigned char);
44 CREATE_MPI_DATATYPE(MPI_UNSIGNED_SHORT, 10, unsigned short);
45 CREATE_MPI_DATATYPE(MPI_UNSIGNED, 11, unsigned int);
46 CREATE_MPI_DATATYPE(MPI_UNSIGNED_LONG, 12, unsigned long);
47 CREATE_MPI_DATATYPE(MPI_UNSIGNED_LONG_LONG, 13, unsigned long long);
48 CREATE_MPI_DATATYPE(MPI_FLOAT, 5, float);
49 CREATE_MPI_DATATYPE(MPI_DOUBLE, 0, double);
50 CREATE_MPI_DATATYPE(MPI_LONG_DOUBLE, 14, long double);
51 CREATE_MPI_DATATYPE(MPI_WCHAR, 15, wchar_t);
52 CREATE_MPI_DATATYPE(MPI_C_BOOL, 16, bool);
53 CREATE_MPI_DATATYPE(MPI_BYTE, 6, int8_t);
54 CREATE_MPI_DATATYPE(MPI_INT8_T, 17, int8_t);
55 CREATE_MPI_DATATYPE(MPI_INT16_T, 18, int16_t);
56 CREATE_MPI_DATATYPE(MPI_INT32_T, 19, int32_t);
57 CREATE_MPI_DATATYPE(MPI_INT64_T, 20, int64_t);
58 CREATE_MPI_DATATYPE(MPI_UINT8_T, 21, uint8_t);
59 CREATE_MPI_DATATYPE(MPI_UINT16_T, 22, uint16_t);
60 CREATE_MPI_DATATYPE(MPI_UINT32_T, 23, uint32_t);
61 CREATE_MPI_DATATYPE(MPI_UINT64_T, 24, uint64_t);
62 CREATE_MPI_DATATYPE(MPI_C_FLOAT_COMPLEX, 25, float _Complex);
63 CREATE_MPI_DATATYPE(MPI_C_DOUBLE_COMPLEX, 26, double _Complex);
64 CREATE_MPI_DATATYPE(MPI_C_LONG_DOUBLE_COMPLEX, 27, long double _Complex);
65 CREATE_MPI_DATATYPE(MPI_AINT, 28, MPI_Aint);
66 CREATE_MPI_DATATYPE(MPI_OFFSET, 29, MPI_Offset);
68 CREATE_MPI_DATATYPE(MPI_FLOAT_INT, 30, float_int);
69 CREATE_MPI_DATATYPE(MPI_LONG_INT, 31, long_int);
70 CREATE_MPI_DATATYPE(MPI_DOUBLE_INT, 32, double_int);
71 CREATE_MPI_DATATYPE(MPI_SHORT_INT, 33, short_int);
72 CREATE_MPI_DATATYPE(MPI_2INT, 34, int_int);
73 CREATE_MPI_DATATYPE(MPI_2FLOAT, 35, float_float);
74 CREATE_MPI_DATATYPE(MPI_2DOUBLE, 36, double_double);
75 CREATE_MPI_DATATYPE(MPI_2LONG, 37, long_long);
77 CREATE_MPI_DATATYPE(MPI_REAL, 38, float);
78 CREATE_MPI_DATATYPE(MPI_REAL4, 39, float);
79 CREATE_MPI_DATATYPE(MPI_REAL8, 40, double);
80 CREATE_MPI_DATATYPE(MPI_REAL16, 41, long double);
81 CREATE_MPI_DATATYPE_NULL(MPI_DATATYPE_NULL, -1);
82 CREATE_MPI_DATATYPE_NULL(MPI_COMPLEX8, 42);
83 CREATE_MPI_DATATYPE_NULL(MPI_COMPLEX16, 43);
84 CREATE_MPI_DATATYPE_NULL(MPI_COMPLEX32, 44);
85 CREATE_MPI_DATATYPE(MPI_INTEGER1, 45, int);
86 CREATE_MPI_DATATYPE(MPI_INTEGER2, 46, int16_t);
87 CREATE_MPI_DATATYPE(MPI_INTEGER4, 47, int32_t);
88 CREATE_MPI_DATATYPE(MPI_INTEGER8, 48, int64_t);
89 CREATE_MPI_DATATYPE(MPI_INTEGER16, 49, integer128_t);
91 CREATE_MPI_DATATYPE(MPI_LONG_DOUBLE_INT, 50, long_double_int);
93 CREATE_MPI_DATATYPE_NULL(MPI_UB, 51);
94 CREATE_MPI_DATATYPE_NULL(MPI_LB, 52);
95 CREATE_MPI_DATATYPE(MPI_PACKED, 53, char);
97 CREATE_MPI_DATATYPE(MPI_PTR, 54, void*);
102 std::unordered_map<int, smpi_key_elem> Datatype::keyvals_; // required by the Keyval class implementation
103 int Datatype::keyval_id_=0; // required by the Keyval class implementation
104 Datatype::Datatype(int ident, int size, MPI_Aint lb, MPI_Aint ub, int flags) : Datatype(size, lb, ub, flags)
106 id = std::to_string(ident);
108 Datatype::Datatype(int size,MPI_Aint lb, MPI_Aint ub, int flags) : name_(nullptr), size_(size), lb_(lb), ub_(ub), flags_(flags), refcount_(1){
111 MC_ignore(&(refcount_), sizeof(refcount_));
115 //for predefined types, so in_use = 0.
116 Datatype::Datatype(char* name, int ident, int size, MPI_Aint lb, MPI_Aint ub, int flags)
117 : name_(name), id(std::to_string(ident)), size_(size), lb_(lb), ub_(ub), flags_(flags), refcount_(0)
119 id2type_lookup.insert({id, this});
122 MC_ignore(&(refcount_), sizeof(refcount_));
126 Datatype::Datatype(Datatype *datatype, int* ret) : name_(nullptr), lb_(datatype->lb_), ub_(datatype->ub_), flags_(datatype->flags_), refcount_(1)
128 flags_ &= ~DT_FLAG_PREDEFINED;
131 name_ = xbt_strdup(datatype->name_);
133 if (not datatype->attributes()->empty()) {
136 for (auto const& it : *(datatype->attributes())) {
137 smpi_key_elem elem = keyvals_.at(it.first);
138 if (elem != nullptr){
139 if( elem->copy_fn.type_copy_fn != MPI_NULL_COPY_FN &&
140 elem->copy_fn.type_copy_fn != MPI_TYPE_DUP_FN)
141 *ret = elem->copy_fn.type_copy_fn(datatype, it.first, elem->extra_state, it.second, &value_out, &flag);
142 else if ( elem->copy_fn.type_copy_fn_fort != MPI_NULL_COPY_FN &&
143 (*(int*)*elem->copy_fn.type_copy_fn_fort) != 1){
144 value_out=(int*)xbt_malloc(sizeof(int));
145 elem->copy_fn.type_copy_fn_fort(datatype, it.first, elem->extra_state, it.second, value_out, &flag,ret);
147 if (*ret != MPI_SUCCESS) {
150 if(elem->copy_fn.type_copy_fn == MPI_TYPE_DUP_FN ||
151 ((elem->copy_fn.type_copy_fn_fort != MPI_NULL_COPY_FN) && (*(int*)*elem->copy_fn.type_copy_fn_fort == 1))){
153 attributes()->insert({it.first, it.second});
156 attributes()->insert({it.first, value_out});
163 Datatype::~Datatype(){
164 xbt_assert(refcount_ >= 0);
166 if(flags_ & DT_FLAG_PREDEFINED)
169 //if still used, mark for deletion
171 flags_ |=DT_FLAG_DESTROYED;
175 cleanup_attr<Datatype>();
181 void Datatype::ref(){
187 MC_ignore(&(refcount_), sizeof(refcount_));
191 void Datatype::unref(MPI_Datatype datatype)
193 if (datatype->refcount_ > 0)
194 datatype->refcount_--;
196 if (datatype->refcount_ == 0 && not(datatype->flags_ & DT_FLAG_PREDEFINED))
201 MC_ignore(&(datatype->refcount_), sizeof(datatype->refcount_));
205 void Datatype::commit()
207 flags_ |= DT_FLAG_COMMITED;
210 bool Datatype::is_valid(){
211 return (flags_ & DT_FLAG_COMMITED);
214 bool Datatype::is_basic()
216 return (flags_ & DT_FLAG_BASIC);
219 const char* Datatype::encode(MPI_Datatype dt)
221 return dt->id.c_str();
224 MPI_Datatype Datatype::decode(const std::string& datatype_id)
226 return id2type_lookup.find(datatype_id)->second;
229 bool Datatype::is_replayable()
231 return (simgrid::instr::trace_format == simgrid::instr::TraceFormat::Ti) &&
232 ((this == MPI_BYTE) || (this == MPI_DOUBLE) || (this == MPI_INT) || (this == MPI_CHAR) ||
233 (this == MPI_SHORT) || (this == MPI_LONG) || (this == MPI_FLOAT));
236 size_t Datatype::size(){
240 int Datatype::flags(){
244 int Datatype::refcount(){
248 void Datatype::addflag(int flag){
252 MPI_Aint Datatype::lb(){
256 MPI_Aint Datatype::ub(){
260 char* Datatype::name(){
265 int Datatype::extent(MPI_Aint * lb, MPI_Aint * extent){
271 MPI_Aint Datatype::get_extent(){
275 void Datatype::get_name(char* name, int* length){
276 *length = strlen(name_);
277 strncpy(name, name_, *length+1);
280 void Datatype::set_name(char* name){
281 if(name_!=nullptr && (flags_ & DT_FLAG_PREDEFINED) == 0)
283 name_ = xbt_strdup(name);
286 int Datatype::pack(void* inbuf, int incount, void* outbuf, int outcount, int* position,MPI_Comm comm){
287 if (outcount - *position < incount*static_cast<int>(size_))
288 return MPI_ERR_BUFFER;
289 Datatype::copy(inbuf, incount, this, static_cast<char*>(outbuf) + *position, outcount, MPI_CHAR);
290 *position += incount * size_;
294 int Datatype::unpack(void* inbuf, int insize, int* position, void* outbuf, int outcount,MPI_Comm comm){
295 if (outcount*static_cast<int>(size_)> insize)
296 return MPI_ERR_BUFFER;
297 Datatype::copy(static_cast<char*>(inbuf) + *position, insize, MPI_CHAR, outbuf, outcount, this);
298 *position += outcount * size_;
303 int Datatype::copy(void *sendbuf, int sendcount, MPI_Datatype sendtype,
304 void *recvbuf, int recvcount, MPI_Datatype recvtype){
306 // FIXME Handle the case of a partial shared malloc.
308 if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP) {
309 smpi_switch_data_segment(simgrid::s4u::Actor::self());
311 /* First check if we really have something to do */
312 if (recvcount > 0 && recvbuf != sendbuf) {
313 sendcount *= sendtype->size();
314 recvcount *= recvtype->size();
315 int count = sendcount < recvcount ? sendcount : recvcount;
317 if (not(sendtype->flags() & DT_FLAG_DERIVED) && not(recvtype->flags() & DT_FLAG_DERIVED)) {
318 if (not smpi_process()->replaying())
319 memcpy(recvbuf, sendbuf, count);
320 } else if (not(sendtype->flags() & DT_FLAG_DERIVED)) {
321 recvtype->unserialize(sendbuf, recvbuf, count / recvtype->size(), MPI_REPLACE);
322 } else if (not(recvtype->flags() & DT_FLAG_DERIVED)) {
323 sendtype->serialize(sendbuf, recvbuf, count / sendtype->size());
326 void * buf_tmp = xbt_malloc(count);
328 sendtype->serialize( sendbuf, buf_tmp,count/sendtype->size());
329 recvtype->unserialize( buf_tmp, recvbuf,count/recvtype->size(), MPI_REPLACE);
335 return sendcount > recvcount ? MPI_ERR_TRUNCATE : MPI_SUCCESS;
338 //Default serialization method : memcpy.
339 void Datatype::serialize( void* noncontiguous_buf, void *contiguous_buf, int count){
340 char* contiguous_buf_char = static_cast<char*>(contiguous_buf);
341 char* noncontiguous_buf_char = static_cast<char*>(noncontiguous_buf)+lb_;
342 memcpy(contiguous_buf_char, noncontiguous_buf_char, count*size_);
346 void Datatype::unserialize( void* contiguous_buf, void *noncontiguous_buf, int count, MPI_Op op){
347 char* contiguous_buf_char = static_cast<char*>(contiguous_buf);
348 char* noncontiguous_buf_char = static_cast<char*>(noncontiguous_buf)+lb_;
351 op->apply( contiguous_buf_char, noncontiguous_buf_char, &n, this);
354 int Datatype::create_contiguous(int count, MPI_Datatype old_type, MPI_Aint lb, MPI_Datatype* new_type){
355 if(old_type->flags_ & DT_FLAG_DERIVED){
356 //handle this case as a hvector with stride equals to the extent of the datatype
357 return create_hvector(count, 1, old_type->get_extent(), old_type, new_type);
360 *new_type = new Type_Contiguous(count * old_type->size(), lb, lb + count * old_type->size(),
361 DT_FLAG_DERIVED, count, old_type);
363 *new_type = new Datatype(count * old_type->size(), lb, lb + count * old_type->size(),0);
367 int Datatype::create_vector(int count, int block_length, int stride, MPI_Datatype old_type, MPI_Datatype* new_type)
376 ub=((count-1)*stride+block_length-1)*old_type->get_extent()+old_type->ub();
378 if(old_type->flags() & DT_FLAG_DERIVED || stride != block_length){
379 *new_type = new Type_Vector(count * (block_length) * old_type->size(), lb, ub,
380 DT_FLAG_DERIVED, count, block_length, stride, old_type);
383 /* in this situation the data are contiguous thus it's not required to serialize and unserialize it*/
384 *new_type = new Datatype(count * block_length * old_type->size(), 0, ((count -1) * stride + block_length)*
385 old_type->size(), DT_FLAG_CONTIGUOUS);
392 int Datatype::create_hvector(int count, int block_length, MPI_Aint stride, MPI_Datatype old_type, MPI_Datatype* new_type)
401 ub=((count-1)*stride)+(block_length-1)*old_type->get_extent()+old_type->ub();
403 if(old_type->flags() & DT_FLAG_DERIVED || stride != block_length*old_type->get_extent()){
404 *new_type = new Type_Hvector(count * (block_length) * old_type->size(), lb, ub,
405 DT_FLAG_DERIVED, count, block_length, stride, old_type);
408 /* in this situation the data are contiguous thus it's not required to serialize and unserialize it*/
409 *new_type = new Datatype(count * block_length * old_type->size(), 0, count * block_length * old_type->size(), DT_FLAG_CONTIGUOUS);
415 int Datatype::create_indexed(int count, int* block_lengths, int* indices, MPI_Datatype old_type, MPI_Datatype* new_type){
417 bool contiguous=true;
421 lb=indices[0]*old_type->get_extent();
422 ub=indices[0]*old_type->get_extent() + block_lengths[0]*old_type->ub();
425 for (int i = 0; i < count; i++) {
426 if (block_lengths[i] < 0)
428 size += block_lengths[i];
430 if(indices[i]*old_type->get_extent()+old_type->lb()<lb)
431 lb = indices[i]*old_type->get_extent()+old_type->lb();
432 if(indices[i]*old_type->get_extent()+block_lengths[i]*old_type->ub()>ub)
433 ub = indices[i]*old_type->get_extent()+block_lengths[i]*old_type->ub();
435 if ( (i< count -1) && (indices[i]+block_lengths[i] != indices[i+1]) )
438 if(old_type->flags_ & DT_FLAG_DERIVED)
441 if (not contiguous) {
442 *new_type = new Type_Indexed(size * old_type->size(),lb,ub,
443 DT_FLAG_DERIVED|DT_FLAG_DATA, count, block_lengths, indices, old_type);
445 Datatype::create_contiguous(size, old_type, lb, new_type);
450 int Datatype::create_hindexed(int count, int* block_lengths, MPI_Aint* indices, MPI_Datatype old_type, MPI_Datatype* new_type){
452 bool contiguous=true;
456 lb=indices[0] + old_type->lb();
457 ub=indices[0] + block_lengths[0]*old_type->ub();
459 for (int i = 0; i < count; i++) {
460 if (block_lengths[i] < 0)
462 size += block_lengths[i];
464 if(indices[i]+old_type->lb()<lb)
465 lb = indices[i]+old_type->lb();
466 if(indices[i]+block_lengths[i]*old_type->ub()>ub)
467 ub = indices[i]+block_lengths[i]*old_type->ub();
469 if ( (i< count -1) && (indices[i]+block_lengths[i]*(static_cast<int>(old_type->size())) != indices[i+1]) )
472 if (old_type->flags_ & DT_FLAG_DERIVED || lb!=0)
475 if (not contiguous) {
476 *new_type = new Type_Hindexed(size * old_type->size(),lb,ub,
477 DT_FLAG_DERIVED|DT_FLAG_DATA, count, block_lengths, indices, old_type);
479 Datatype::create_contiguous(size, old_type, lb, new_type);
484 int Datatype::create_struct(int count, int* block_lengths, MPI_Aint* indices, MPI_Datatype* old_types, MPI_Datatype* new_type){
486 bool contiguous=true;
491 lb=indices[0] + old_types[0]->lb();
492 ub=indices[0] + block_lengths[0]*old_types[0]->ub();
494 bool forced_lb=false;
495 bool forced_ub=false;
496 for (int i = 0; i < count; i++) {
497 if (block_lengths[i]<0)
499 if (old_types[i]->flags_ & DT_FLAG_DERIVED)
502 size += block_lengths[i]*old_types[i]->size();
503 if (old_types[i]==MPI_LB){
507 if (old_types[i]==MPI_UB){
512 if (not forced_lb && indices[i] + old_types[i]->lb() < lb)
514 if (not forced_ub && indices[i] + block_lengths[i] * old_types[i]->ub() > ub)
515 ub = indices[i]+block_lengths[i]*old_types[i]->ub();
517 if ( (i< count -1) && (indices[i]+block_lengths[i]*static_cast<int>(old_types[i]->size()) != indices[i+1]) )
520 if (not contiguous) {
521 *new_type = new Type_Struct(size, lb,ub, DT_FLAG_DERIVED|DT_FLAG_DATA,
522 count, block_lengths, indices, old_types);
524 Datatype::create_contiguous(size, MPI_CHAR, lb, new_type);
529 int Datatype::create_subarray(int ndims, int* array_of_sizes,
530 int* array_of_subsizes, int* array_of_starts,
531 int order, MPI_Datatype oldtype, MPI_Datatype *newtype){
534 for (int i = 0; i < ndims; i++) {
535 if (array_of_subsizes[i] > array_of_sizes[i]){
536 XBT_WARN("subarray : array_of_subsizes > array_of_sizes for dim %d",i);
539 if (array_of_starts[i] + array_of_subsizes[i] > array_of_sizes[i]){
540 XBT_WARN("subarray : array_of_starts + array_of_subsizes > array_of_sizes for dim %d",i);
545 MPI_Aint extent = oldtype->get_extent();
550 if( order==MPI_ORDER_C ) {
560 MPI_Aint size = (MPI_Aint)array_of_sizes[i] * (MPI_Aint)array_of_sizes[i+step];
561 MPI_Aint lb = (MPI_Aint)array_of_starts[i] + (MPI_Aint)array_of_starts[i+step] *(MPI_Aint)array_of_sizes[i];
563 create_vector( array_of_subsizes[i+step], array_of_subsizes[i], array_of_sizes[i],
568 for( i += 2 * step; i != end; i += step ) {
569 create_hvector( array_of_subsizes[i], 1, size * extent,
572 lb += size * array_of_starts[i];
573 size *= array_of_sizes[i];
577 MPI_Aint lbs[1] = {lb * extent};
579 //handle LB and UB with a resized call
580 create_hindexed( 1, sizes, lbs, tmp, newtype);
584 create_resized(tmp, 0, extent, newtype);
590 int Datatype::create_resized(MPI_Datatype oldtype,MPI_Aint lb, MPI_Aint extent, MPI_Datatype *newtype){
591 int blocks[3] = {1, 1, 1};
592 MPI_Aint disps[3] = {lb, 0, lb + extent};
593 MPI_Datatype types[3] = {MPI_LB, oldtype, MPI_UB};
595 *newtype = new simgrid::smpi::Type_Struct(oldtype->size(), lb, lb + extent, DT_FLAG_DERIVED, 3, blocks, disps, types);
597 (*newtype)->addflag(~DT_FLAG_COMMITED);
601 Datatype* Datatype::f2c(int id){
602 return static_cast<Datatype*>(F2C::f2c(id));