1 /* smpi_datatype.cpp -- MPI primitives to handle datatypes */
2 /* Copyright (c) 2009-2015. The SimGrid Team.
3 * All rights reserved. */
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. */
10 #include "simgrid/modelchecker.h"
16 #include <unordered_map>
19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_datatype, smpi, "Logging specific to SMPI (datatype)");
21 #define CREATE_MPI_DATATYPE(name, type) \
22 static Datatype mpi_##name ( \
24 sizeof(type), /* size */ \
26 sizeof(type), /* ub = lb + size */ \
27 DT_FLAG_BASIC /* flags */ \
29 const MPI_Datatype name = &mpi_##name;
31 #define CREATE_MPI_DATATYPE_NULL(name) \
32 static Datatype mpi_##name ( \
36 0, /* ub = lb + size */ \
37 DT_FLAG_BASIC /* flags */ \
39 const MPI_Datatype name = &mpi_##name;
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);
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);
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);
95 CREATE_MPI_DATATYPE(MPI_LONG_DOUBLE_INT, long_double_int);
97 CREATE_MPI_DATATYPE_NULL(MPI_UB);
98 CREATE_MPI_DATATYPE_NULL(MPI_LB);
99 CREATE_MPI_DATATYPE(MPI_PACKED, char);
101 CREATE_MPI_DATATYPE(MPI_PTR, void*);
106 std::unordered_map<int, smpi_type_key_elem> Datatype::keyvals_;
107 int Datatype::keyval_id_=0;
109 Datatype::Datatype(int size,MPI_Aint lb, MPI_Aint ub, int flags) : name_(nullptr), size_(size), lb_(lb), ub_(ub), flags_(flags), attributes_(nullptr), refcount_(1){
112 MC_ignore(&(refcount_), sizeof(refcount_));
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), attributes_(nullptr), refcount_(0){
120 MC_ignore(&(refcount_), sizeof(refcount_));
124 Datatype::Datatype(Datatype *datatype, int* ret) : name_(nullptr), lb_(datatype->lb_), ub_(datatype->ub_), flags_(datatype->flags_), attributes_(nullptr), refcount_(1)
126 flags_ &= ~DT_FLAG_PREDEFINED;
129 name_ = xbt_strdup(datatype->name_);
130 if(datatype->attributes_ !=nullptr){
131 attributes_ = xbt_dict_new_homogeneous(nullptr);
132 xbt_dict_cursor_t cursor = nullptr;
137 xbt_dict_foreach (datatype->attributes_, cursor, key, value_in) {
138 smpi_type_key_elem elem = keyvals_.at(atoi(key));
139 if (elem != nullptr && elem->copy_fn != MPI_NULL_COPY_FN) {
140 *ret = elem->copy_fn(datatype, atoi(key), nullptr, value_in, &value_out, &flag);
141 if (*ret != MPI_SUCCESS) {
142 xbt_dict_cursor_free(&cursor);
146 xbt_dict_set_ext(attributes_, key, sizeof(int), value_out, nullptr);
152 Datatype::~Datatype(){
153 xbt_assert(refcount_ >= 0);
155 if(flags_ & DT_FLAG_PREDEFINED)
158 //if still used, mark for deletion
160 flags_ |=DT_FLAG_DESTROYED;
164 if(attributes_ !=nullptr){
165 xbt_dict_cursor_t cursor = nullptr;
169 xbt_dict_foreach(attributes_, cursor, key, value){
170 smpi_type_key_elem elem = keyvals_.at(atoi(key));
171 if(elem!=nullptr && elem->delete_fn!=nullptr)
172 elem->delete_fn(this,*key, value, &flag);
174 xbt_dict_free(&attributes_);
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 && !(datatype->flags_ & DT_FLAG_PREDEFINED))
201 MC_ignore(&(datatype->refcount_), sizeof(datatype->refcount_));
205 void Datatype::commit()
207 flags_ |= DT_FLAG_COMMITED;
211 bool Datatype::is_valid(){
212 return (flags_ & DT_FLAG_COMMITED);
215 size_t Datatype::size(){
219 int Datatype::flags(){
223 void Datatype::addflag(int flag){
227 MPI_Aint Datatype::lb(){
231 MPI_Aint Datatype::ub(){
235 char* Datatype::name(){
240 int Datatype::extent(MPI_Aint * lb, MPI_Aint * extent){
246 MPI_Aint Datatype::get_extent(){
250 void Datatype::get_name(char* name, int* length){
251 *length = strlen(name_);
252 strncpy(name, name_, *length+1);
255 void Datatype::set_name(char* name){
256 if(name_!=nullptr && (flags_ & DT_FLAG_PREDEFINED) == 0)
258 name_ = xbt_strdup(name);
261 int Datatype::attr_delete(int keyval){
262 smpi_type_key_elem elem = keyvals_.at(keyval);
265 if(elem->delete_fn!=MPI_NULL_DELETE_FN){
266 void * value = nullptr;
268 if(this->attr_get(keyval, &value, &flag)==MPI_SUCCESS){
269 int ret = elem->delete_fn(this, keyval, value, &flag);
274 if(attributes_==nullptr)
277 xbt_dict_remove_ext(attributes_, reinterpret_cast<const char*>(&keyval), sizeof(int));
282 int Datatype::attr_get(int keyval, void* attr_value, int* flag){
283 smpi_type_key_elem elem = keyvals_.at(keyval);
286 if(attributes_==nullptr){
291 *static_cast<void**>(attr_value) = xbt_dict_get_ext(attributes_, reinterpret_cast<const char*>(&keyval), sizeof(int));
300 int Datatype::attr_put(int keyval, void* attr_value){
301 smpi_type_key_elem elem = keyvals_.at(keyval);
305 void* value = nullptr;
306 this->attr_get(keyval, &value, &flag);
307 if(flag!=0 && elem->delete_fn!=MPI_NULL_DELETE_FN){
308 int ret = elem->delete_fn(this, keyval, value, &flag);
312 if(attributes_==nullptr)
313 attributes_ = xbt_dict_new_homogeneous(nullptr);
315 xbt_dict_set_ext(attributes_, reinterpret_cast<const char*>(&keyval), sizeof(int), attr_value, nullptr);
319 int Datatype::keyval_create(MPI_Type_copy_attr_function* copy_fn, MPI_Type_delete_attr_function* delete_fn, int* keyval, void* extra_state){
321 smpi_type_key_elem value = (smpi_type_key_elem) xbt_new0(s_smpi_mpi_type_key_elem_t,1);
323 value->copy_fn=copy_fn;
324 value->delete_fn=delete_fn;
326 *keyval = keyval_id_;
327 keyvals_.insert({*keyval, value});
332 int Datatype::keyval_free(int* keyval){
333 smpi_type_key_elem elem = keyvals_.at(*keyval);
337 keyvals_.erase(*keyval);
343 int Datatype::pack(void* inbuf, int incount, void* outbuf, int outcount, int* position,MPI_Comm comm){
344 if (outcount - *position < incount*static_cast<int>(size_))
345 return MPI_ERR_BUFFER;
346 Datatype::copy(inbuf, incount, this, static_cast<char*>(outbuf) + *position, outcount, MPI_CHAR);
347 *position += incount * size_;
351 int Datatype::unpack(void* inbuf, int insize, int* position, void* outbuf, int outcount,MPI_Comm comm){
352 if (outcount*(int)size_> insize)
353 return MPI_ERR_BUFFER;
354 Datatype::copy(static_cast<char*>(inbuf) + *position, insize, MPI_CHAR, outbuf, outcount, this);
355 *position += outcount * size_;
360 int Datatype::copy(void *sendbuf, int sendcount, MPI_Datatype sendtype,
361 void *recvbuf, int recvcount, MPI_Datatype recvtype){
363 if(smpi_privatize_global_variables){
364 smpi_switch_data_segment(smpi_process_index());
366 /* First check if we really have something to do */
367 if (recvcount > 0 && recvbuf != sendbuf) {
368 sendcount *= sendtype->size();
369 recvcount *= recvtype->size();
370 count = sendcount < recvcount ? sendcount : recvcount;
372 if(!(sendtype->flags() & DT_FLAG_DERIVED) && !(recvtype->flags() & DT_FLAG_DERIVED)) {
373 if(!smpi_process_get_replaying())
374 memcpy(recvbuf, sendbuf, count);
376 else if (!(sendtype->flags() & DT_FLAG_DERIVED))
378 recvtype->unserialize( sendbuf, recvbuf, recvcount/recvtype->size(), MPI_REPLACE);
380 else if (!(recvtype->flags() & DT_FLAG_DERIVED))
382 sendtype->serialize(sendbuf, recvbuf, sendcount/sendtype->size());
385 void * buf_tmp = xbt_malloc(count);
387 sendtype->serialize( sendbuf, buf_tmp,count/sendtype->size());
388 recvtype->unserialize( buf_tmp, recvbuf,count/recvtype->size(), MPI_REPLACE);
394 return sendcount > recvcount ? MPI_ERR_TRUNCATE : MPI_SUCCESS;
397 //Default serialization method : memcpy.
398 void Datatype::serialize( void* noncontiguous_buf, void *contiguous_buf, int count){
399 char* contiguous_buf_char = static_cast<char*>(contiguous_buf);
400 char* noncontiguous_buf_char = static_cast<char*>(noncontiguous_buf)+lb_;
401 memcpy(contiguous_buf_char, noncontiguous_buf_char, count*size_);
405 void Datatype::unserialize( void* contiguous_buf, void *noncontiguous_buf, int count, MPI_Op op){
406 char* contiguous_buf_char = static_cast<char*>(contiguous_buf);
407 char* noncontiguous_buf_char = static_cast<char*>(noncontiguous_buf)+lb_;
410 op->apply( contiguous_buf_char, noncontiguous_buf_char, &n, this);
413 int Datatype::create_contiguous(int count, MPI_Datatype old_type, MPI_Aint lb, MPI_Datatype* new_type){
414 if(old_type->flags_ & DT_FLAG_DERIVED){
415 //handle this case as a hvector with stride equals to the extent of the datatype
416 return create_hvector(count, 1, old_type->get_extent(), old_type, new_type);
419 *new_type = new Type_Contiguous(count * old_type->size(), lb, lb + count * old_type->size(),
420 DT_FLAG_DERIVED, count, old_type);
422 *new_type = new Datatype(count * old_type->size(), lb, lb + count * old_type->size(),0);
426 int Datatype::create_vector(int count, int block_length, int stride, MPI_Datatype old_type, MPI_Datatype* new_type)
435 ub=((count-1)*stride+block_length-1)*old_type->get_extent()+old_type->ub();
437 if(old_type->flags() & DT_FLAG_DERIVED || stride != block_length){
438 *new_type = new Type_Vector(count * (block_length) * old_type->size(), lb, ub,
439 DT_FLAG_DERIVED, count, block_length, stride, old_type);
442 /* in this situation the data are contiguous thus it's not required to serialize and unserialize it*/
443 *new_type = new Datatype(count * block_length * old_type->size(), 0, ((count -1) * stride + block_length)*
444 old_type->size(), DT_FLAG_CONTIGUOUS);
451 int Datatype::create_hvector(int count, int block_length, MPI_Aint stride, MPI_Datatype old_type, MPI_Datatype* new_type)
460 ub=((count-1)*stride)+(block_length-1)*old_type->get_extent()+old_type->ub();
462 if(old_type->flags() & DT_FLAG_DERIVED || stride != block_length*old_type->get_extent()){
463 *new_type = new Type_Hvector(count * (block_length) * old_type->size(), lb, ub,
464 DT_FLAG_DERIVED, count, block_length, stride, old_type);
467 /* in this situation the data are contiguous thus it's not required to serialize and unserialize it*/
468 *new_type = new Datatype(count * block_length * old_type->size(), 0, count * block_length * old_type->size(), DT_FLAG_CONTIGUOUS);
474 int Datatype::create_indexed(int count, int* block_lengths, int* indices, MPI_Datatype old_type, MPI_Datatype* new_type){
476 bool contiguous=true;
480 lb=indices[0]*old_type->get_extent();
481 ub=indices[0]*old_type->get_extent() + block_lengths[0]*old_type->ub();
484 for (int i = 0; i < count; i++) {
485 if (block_lengths[i] < 0)
487 size += block_lengths[i];
489 if(indices[i]*old_type->get_extent()+old_type->lb()<lb)
490 lb = indices[i]*old_type->get_extent()+old_type->lb();
491 if(indices[i]*old_type->get_extent()+block_lengths[i]*old_type->ub()>ub)
492 ub = indices[i]*old_type->get_extent()+block_lengths[i]*old_type->ub();
494 if ( (i< count -1) && (indices[i]+block_lengths[i] != indices[i+1]) )
497 if(old_type->flags_ & DT_FLAG_DERIVED)
501 *new_type = new Type_Indexed(size * old_type->size(),lb,ub,
502 DT_FLAG_DERIVED|DT_FLAG_DATA, count, block_lengths, indices, old_type);
504 Datatype::create_contiguous(size, old_type, lb, new_type);
509 int Datatype::create_hindexed(int count, int* block_lengths, MPI_Aint* indices, MPI_Datatype old_type, MPI_Datatype* new_type){
511 bool contiguous=true;
515 lb=indices[0] + old_type->lb();
516 ub=indices[0] + block_lengths[0]*old_type->ub();
518 for (int i = 0; i < count; i++) {
519 if (block_lengths[i] < 0)
521 size += block_lengths[i];
523 if(indices[i]+old_type->lb()<lb)
524 lb = indices[i]+old_type->lb();
525 if(indices[i]+block_lengths[i]*old_type->ub()>ub)
526 ub = indices[i]+block_lengths[i]*old_type->ub();
528 if ( (i< count -1) && (indices[i]+block_lengths[i]*(static_cast<int>(old_type->size())) != indices[i+1]) )
531 if (old_type->flags_ & DT_FLAG_DERIVED || lb!=0)
535 *new_type = new Type_Hindexed(size * old_type->size(),lb,ub,
536 DT_FLAG_DERIVED|DT_FLAG_DATA, count, block_lengths, indices, old_type);
538 Datatype::create_contiguous(size, old_type, lb, new_type);
543 int Datatype::create_struct(int count, int* block_lengths, MPI_Aint* indices, MPI_Datatype* old_types, MPI_Datatype* new_type){
545 bool contiguous=true;
550 lb=indices[0] + old_types[0]->lb();
551 ub=indices[0] + block_lengths[0]*old_types[0]->ub();
553 bool forced_lb=false;
554 bool forced_ub=false;
555 for (int i = 0; i < count; i++) {
556 if (block_lengths[i]<0)
558 if (old_types[i]->flags_ & DT_FLAG_DERIVED)
561 size += block_lengths[i]*old_types[i]->size();
562 if (old_types[i]==MPI_LB){
566 if (old_types[i]==MPI_UB){
571 if(!forced_lb && indices[i]+old_types[i]->lb()<lb)
573 if(!forced_ub && indices[i]+block_lengths[i]*old_types[i]->ub()>ub)
574 ub = indices[i]+block_lengths[i]*old_types[i]->ub();
576 if ( (i< count -1) && (indices[i]+block_lengths[i]*static_cast<int>(old_types[i]->size()) != indices[i+1]) )
580 *new_type = new Type_Struct(size, lb,ub, DT_FLAG_DERIVED|DT_FLAG_DATA,
581 count, block_lengths, indices, old_types);
583 Datatype::create_contiguous(size, MPI_CHAR, lb, new_type);
588 Datatype* Datatype::f2c(int id){
589 return static_cast<Datatype*>(F2C::f2c(id));