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_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_key_elem elem = keyvals_.at(atoi(key));
139 if (elem != nullptr && elem->copy_fn.type_copy_fn != MPI_NULL_COPY_FN) {
140 *ret = elem->copy_fn.type_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){
171 smpi_key_elem elem = keyvals_.at(atoi(key));
172 if(elem!=nullptr && elem->delete_fn.type_delete_fn!=nullptr)
173 elem->delete_fn.type_delete_fn(this,*key, value, &flag);
174 }catch(const std::out_of_range& oor) {
175 //already deleted, not a problem;
178 xbt_dict_free(&attributes_);
185 void Datatype::ref(){
191 MC_ignore(&(refcount_), sizeof(refcount_));
195 void Datatype::unref(MPI_Datatype datatype)
197 if (datatype->refcount_ > 0)
198 datatype->refcount_--;
200 if (datatype->refcount_ == 0 && !(datatype->flags_ & DT_FLAG_PREDEFINED))
205 MC_ignore(&(datatype->refcount_), sizeof(datatype->refcount_));
209 void Datatype::commit()
211 flags_ |= DT_FLAG_COMMITED;
215 bool Datatype::is_valid(){
216 return (flags_ & DT_FLAG_COMMITED);
219 size_t Datatype::size(){
223 int Datatype::flags(){
227 void Datatype::addflag(int flag){
231 MPI_Aint Datatype::lb(){
235 MPI_Aint Datatype::ub(){
239 char* Datatype::name(){
244 int Datatype::extent(MPI_Aint * lb, MPI_Aint * extent){
250 MPI_Aint Datatype::get_extent(){
254 void Datatype::get_name(char* name, int* length){
255 *length = strlen(name_);
256 strncpy(name, name_, *length+1);
259 void Datatype::set_name(char* name){
260 if(name_!=nullptr && (flags_ & DT_FLAG_PREDEFINED) == 0)
262 name_ = xbt_strdup(name);
265 int Datatype::attr_delete(int keyval){
266 smpi_key_elem elem = keyvals_.at(keyval);
269 if(elem->delete_fn.type_delete_fn!=MPI_NULL_DELETE_FN){
270 void * value = nullptr;
272 if(this->attr_get(keyval, &value, &flag)==MPI_SUCCESS){
273 int ret = elem->delete_fn.type_delete_fn(this, keyval, value, &flag);
278 if(attributes_==nullptr)
281 xbt_dict_remove_ext(attributes_, reinterpret_cast<const char*>(&keyval), sizeof(int));
286 int Datatype::attr_get(int keyval, void* attr_value, int* flag){
287 smpi_key_elem elem = keyvals_.at(keyval);
290 if(attributes_==nullptr){
295 *static_cast<void**>(attr_value) = xbt_dict_get_ext(attributes_, reinterpret_cast<const char*>(&keyval), sizeof(int));
304 int Datatype::attr_put(int keyval, void* attr_value){
305 smpi_key_elem elem = keyvals_.at(keyval);
309 void* value = nullptr;
310 this->attr_get(keyval, &value, &flag);
311 if(flag!=0 && elem->delete_fn.type_delete_fn!=MPI_NULL_DELETE_FN){
312 int ret = elem->delete_fn.type_delete_fn(this, keyval, value, &flag);
316 if(attributes_==nullptr)
317 attributes_ = xbt_dict_new_homogeneous(nullptr);
319 xbt_dict_set_ext(attributes_, reinterpret_cast<const char*>(&keyval), sizeof(int), attr_value, nullptr);
323 int Datatype::pack(void* inbuf, int incount, void* outbuf, int outcount, int* position,MPI_Comm comm){
324 if (outcount - *position < incount*static_cast<int>(size_))
325 return MPI_ERR_BUFFER;
326 Datatype::copy(inbuf, incount, this, static_cast<char*>(outbuf) + *position, outcount, MPI_CHAR);
327 *position += incount * size_;
331 int Datatype::unpack(void* inbuf, int insize, int* position, void* outbuf, int outcount,MPI_Comm comm){
332 if (outcount*(int)size_> insize)
333 return MPI_ERR_BUFFER;
334 Datatype::copy(static_cast<char*>(inbuf) + *position, insize, MPI_CHAR, outbuf, outcount, this);
335 *position += outcount * size_;
340 int Datatype::copy(void *sendbuf, int sendcount, MPI_Datatype sendtype,
341 void *recvbuf, int recvcount, MPI_Datatype recvtype){
343 if(smpi_privatize_global_variables){
344 smpi_switch_data_segment(smpi_process_index());
346 /* First check if we really have something to do */
347 if (recvcount > 0 && recvbuf != sendbuf) {
348 sendcount *= sendtype->size();
349 recvcount *= recvtype->size();
350 count = sendcount < recvcount ? sendcount : recvcount;
352 if(!(sendtype->flags() & DT_FLAG_DERIVED) && !(recvtype->flags() & DT_FLAG_DERIVED)) {
353 if(!smpi_process_get_replaying())
354 memcpy(recvbuf, sendbuf, count);
356 else if (!(sendtype->flags() & DT_FLAG_DERIVED))
358 recvtype->unserialize( sendbuf, recvbuf, recvcount/recvtype->size(), MPI_REPLACE);
360 else if (!(recvtype->flags() & DT_FLAG_DERIVED))
362 sendtype->serialize(sendbuf, recvbuf, sendcount/sendtype->size());
365 void * buf_tmp = xbt_malloc(count);
367 sendtype->serialize( sendbuf, buf_tmp,count/sendtype->size());
368 recvtype->unserialize( buf_tmp, recvbuf,count/recvtype->size(), MPI_REPLACE);
374 return sendcount > recvcount ? MPI_ERR_TRUNCATE : MPI_SUCCESS;
377 //Default serialization method : memcpy.
378 void Datatype::serialize( void* noncontiguous_buf, void *contiguous_buf, int count){
379 char* contiguous_buf_char = static_cast<char*>(contiguous_buf);
380 char* noncontiguous_buf_char = static_cast<char*>(noncontiguous_buf)+lb_;
381 memcpy(contiguous_buf_char, noncontiguous_buf_char, count*size_);
385 void Datatype::unserialize( void* contiguous_buf, void *noncontiguous_buf, int count, MPI_Op op){
386 char* contiguous_buf_char = static_cast<char*>(contiguous_buf);
387 char* noncontiguous_buf_char = static_cast<char*>(noncontiguous_buf)+lb_;
390 op->apply( contiguous_buf_char, noncontiguous_buf_char, &n, this);
393 int Datatype::create_contiguous(int count, MPI_Datatype old_type, MPI_Aint lb, MPI_Datatype* new_type){
394 if(old_type->flags_ & DT_FLAG_DERIVED){
395 //handle this case as a hvector with stride equals to the extent of the datatype
396 return create_hvector(count, 1, old_type->get_extent(), old_type, new_type);
399 *new_type = new Type_Contiguous(count * old_type->size(), lb, lb + count * old_type->size(),
400 DT_FLAG_DERIVED, count, old_type);
402 *new_type = new Datatype(count * old_type->size(), lb, lb + count * old_type->size(),0);
406 int Datatype::create_vector(int count, int block_length, int stride, MPI_Datatype old_type, MPI_Datatype* new_type)
415 ub=((count-1)*stride+block_length-1)*old_type->get_extent()+old_type->ub();
417 if(old_type->flags() & DT_FLAG_DERIVED || stride != block_length){
418 *new_type = new Type_Vector(count * (block_length) * old_type->size(), lb, ub,
419 DT_FLAG_DERIVED, count, block_length, stride, old_type);
422 /* in this situation the data are contiguous thus it's not required to serialize and unserialize it*/
423 *new_type = new Datatype(count * block_length * old_type->size(), 0, ((count -1) * stride + block_length)*
424 old_type->size(), DT_FLAG_CONTIGUOUS);
431 int Datatype::create_hvector(int count, int block_length, MPI_Aint stride, MPI_Datatype old_type, MPI_Datatype* new_type)
440 ub=((count-1)*stride)+(block_length-1)*old_type->get_extent()+old_type->ub();
442 if(old_type->flags() & DT_FLAG_DERIVED || stride != block_length*old_type->get_extent()){
443 *new_type = new Type_Hvector(count * (block_length) * old_type->size(), lb, ub,
444 DT_FLAG_DERIVED, count, block_length, stride, old_type);
447 /* in this situation the data are contiguous thus it's not required to serialize and unserialize it*/
448 *new_type = new Datatype(count * block_length * old_type->size(), 0, count * block_length * old_type->size(), DT_FLAG_CONTIGUOUS);
454 int Datatype::create_indexed(int count, int* block_lengths, int* indices, MPI_Datatype old_type, MPI_Datatype* new_type){
456 bool contiguous=true;
460 lb=indices[0]*old_type->get_extent();
461 ub=indices[0]*old_type->get_extent() + block_lengths[0]*old_type->ub();
464 for (int i = 0; i < count; i++) {
465 if (block_lengths[i] < 0)
467 size += block_lengths[i];
469 if(indices[i]*old_type->get_extent()+old_type->lb()<lb)
470 lb = indices[i]*old_type->get_extent()+old_type->lb();
471 if(indices[i]*old_type->get_extent()+block_lengths[i]*old_type->ub()>ub)
472 ub = indices[i]*old_type->get_extent()+block_lengths[i]*old_type->ub();
474 if ( (i< count -1) && (indices[i]+block_lengths[i] != indices[i+1]) )
477 if(old_type->flags_ & DT_FLAG_DERIVED)
481 *new_type = new Type_Indexed(size * old_type->size(),lb,ub,
482 DT_FLAG_DERIVED|DT_FLAG_DATA, count, block_lengths, indices, old_type);
484 Datatype::create_contiguous(size, old_type, lb, new_type);
489 int Datatype::create_hindexed(int count, int* block_lengths, MPI_Aint* indices, MPI_Datatype old_type, MPI_Datatype* new_type){
491 bool contiguous=true;
495 lb=indices[0] + old_type->lb();
496 ub=indices[0] + block_lengths[0]*old_type->ub();
498 for (int i = 0; i < count; i++) {
499 if (block_lengths[i] < 0)
501 size += block_lengths[i];
503 if(indices[i]+old_type->lb()<lb)
504 lb = indices[i]+old_type->lb();
505 if(indices[i]+block_lengths[i]*old_type->ub()>ub)
506 ub = indices[i]+block_lengths[i]*old_type->ub();
508 if ( (i< count -1) && (indices[i]+block_lengths[i]*(static_cast<int>(old_type->size())) != indices[i+1]) )
511 if (old_type->flags_ & DT_FLAG_DERIVED || lb!=0)
515 *new_type = new Type_Hindexed(size * old_type->size(),lb,ub,
516 DT_FLAG_DERIVED|DT_FLAG_DATA, count, block_lengths, indices, old_type);
518 Datatype::create_contiguous(size, old_type, lb, new_type);
523 int Datatype::create_struct(int count, int* block_lengths, MPI_Aint* indices, MPI_Datatype* old_types, MPI_Datatype* new_type){
525 bool contiguous=true;
530 lb=indices[0] + old_types[0]->lb();
531 ub=indices[0] + block_lengths[0]*old_types[0]->ub();
533 bool forced_lb=false;
534 bool forced_ub=false;
535 for (int i = 0; i < count; i++) {
536 if (block_lengths[i]<0)
538 if (old_types[i]->flags_ & DT_FLAG_DERIVED)
541 size += block_lengths[i]*old_types[i]->size();
542 if (old_types[i]==MPI_LB){
546 if (old_types[i]==MPI_UB){
551 if(!forced_lb && indices[i]+old_types[i]->lb()<lb)
553 if(!forced_ub && indices[i]+block_lengths[i]*old_types[i]->ub()>ub)
554 ub = indices[i]+block_lengths[i]*old_types[i]->ub();
556 if ( (i< count -1) && (indices[i]+block_lengths[i]*static_cast<int>(old_types[i]->size()) != indices[i+1]) )
560 *new_type = new Type_Struct(size, lb,ub, DT_FLAG_DERIVED|DT_FLAG_DATA,
561 count, block_lengths, indices, old_types);
563 Datatype::create_contiguous(size, MPI_CHAR, lb, new_type);
568 Datatype* Datatype::f2c(int id){
569 return static_cast<Datatype*>(F2C::f2c(id));