src/smpi/mpi/smpi_comm.cpp

   1 /* Copyright (c) 2010-2019. 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 "smpi_comm.hpp"
   7 #include "smpi_coll.hpp"
   8 #include "smpi_datatype.hpp"
   9 #include "smpi_request.hpp"
  10 #include "smpi_win.hpp"
  11 #include "smpi_info.hpp"
  12 #include "src/smpi/include/smpi_actor.hpp"
  13 #include "src/surf/HostImpl.hpp"
  14
  15 #include <climits>
  16
  17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_comm, smpi, "Logging specific to SMPI (comm)");
  18
  19 simgrid::smpi::Comm mpi_MPI_COMM_UNINITIALIZED;
  20 MPI_Comm MPI_COMM_UNINITIALIZED=&mpi_MPI_COMM_UNINITIALIZED;
  21
  22 /* Support for cartesian topology was added, but there are 2 other types of topology, graph et dist graph. In order to
  23  * support them, we have to add a field SMPI_Topo_type, and replace the MPI_Topology field by an union. */
  24
  25 namespace simgrid{
  26 namespace smpi{
  27
  28 std::unordered_map<int, smpi_key_elem> Comm::keyvals_;
  29 int Comm::keyval_id_=0;
  30
  31 Comm::Comm(MPI_Group group, MPI_Topology topo, int smp) : group_(group), topo_(topo),is_smp_comm_(smp)
  32 {
  33   refcount_        = 1;
  34   topoType_        = MPI_INVALID_TOPO;
  35   intra_comm_      = MPI_COMM_NULL;
  36   leaders_comm_    = MPI_COMM_NULL;
  37   is_uniform_      = 1;
  38   non_uniform_map_ = nullptr;
  39   leaders_map_     = nullptr;
  40   is_blocked_      = 0;
  41   info_            = MPI_INFO_NULL;
  42 }
  43
  44 void Comm::destroy(Comm* comm)
  45 {
  46   if (comm == MPI_COMM_UNINITIALIZED){
  47     Comm::destroy(smpi_process()->comm_world());
  48     return;
  49   }
  50   delete comm->topo_; // there's no use count on topos
  51   Comm::unref(comm);
  52 }
  53
  54 int Comm::dup(MPI_Comm* newcomm){
  55   if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP) {
  56     // we need to switch as the called function may silently touch global variables
  57     smpi_switch_data_segment(s4u::Actor::self());
  58   }
  59   MPI_Group cp = new  Group(this->group());
  60   (*newcomm)   = new  Comm(cp, this->topo());
  61   int ret      = MPI_SUCCESS;
  62
  63   if (not attributes()->empty()) {
  64     int flag=0;
  65     void* value_out=nullptr;
  66     for (auto const& it : *attributes()) {
  67       smpi_key_elem elem = keyvals_.at(it.first);
  68       if (elem != nullptr){
  69         if( elem->copy_fn.comm_copy_fn != MPI_NULL_COPY_FN &&
  70             elem->copy_fn.comm_copy_fn != MPI_COMM_DUP_FN)
  71           ret = elem->copy_fn.comm_copy_fn(this, it.first, elem->extra_state, it.second, &value_out, &flag);
  72         else if ( elem->copy_fn.comm_copy_fn_fort != MPI_NULL_COPY_FN &&
  73                   *(int*)*elem->copy_fn.comm_copy_fn_fort != 1){
  74           value_out=(int*)xbt_malloc(sizeof(int));
  75           elem->copy_fn.comm_copy_fn_fort(this, it.first, elem->extra_state, it.second, value_out, &flag,&ret);
  76         }
  77         if (ret != MPI_SUCCESS) {
  78           Comm::destroy(*newcomm);
  79           *newcomm = MPI_COMM_NULL;
  80           return ret;
  81         }
  82         if (elem->copy_fn.comm_copy_fn == MPI_COMM_DUP_FN ||
  83            ((elem->copy_fn.comm_copy_fn_fort != MPI_NULL_COPY_FN) && *(int*)*elem->copy_fn.comm_copy_fn_fort == 1)){
  84           elem->refcount++;
  85           (*newcomm)->attributes()->insert({it.first, it.second});
  86         }else if (flag){
  87           elem->refcount++;
  88           (*newcomm)->attributes()->insert({it.first, value_out});
  89         }
  90       }
  91     }
  92   }
  93   //duplicate info if present
  94   if(info_!=MPI_INFO_NULL)
  95     (*newcomm)->info_ = new simgrid::smpi::Info(info_);
  96   return ret;
  97 }
  98
  99 int Comm::dup_with_info(MPI_Info info, MPI_Comm* newcomm){
 100   int ret = dup(newcomm);
 101   if((*newcomm)->info_!=MPI_INFO_NULL){
 102     simgrid::smpi::Info::unref((*newcomm)->info_);
 103     (*newcomm)->info_=MPI_INFO_NULL;
 104   }
 105   if(info != MPI_INFO_NULL){
 106     (*newcomm)->info_=info;
 107   }
 108   return ret;
 109 }
 110
 111 MPI_Group Comm::group()
 112 {
 113   if (this == MPI_COMM_UNINITIALIZED)
 114     return smpi_process()->comm_world()->group();
 115   return group_;
 116 }
 117
 118 int Comm::size()
 119 {
 120   if (this == MPI_COMM_UNINITIALIZED)
 121     return smpi_process()->comm_world()->size();
 122   return group_->size();
 123 }
 124
 125 int Comm::rank()
 126 {
 127   if (this == MPI_COMM_UNINITIALIZED)
 128     return smpi_process()->comm_world()->rank();
 129   return group_->rank(s4u::Actor::self());
 130 }
 131
 132 void Comm::get_name (char* name, int* len)
 133 {
 134   if (this == MPI_COMM_UNINITIALIZED){
 135     smpi_process()->comm_world()->get_name(name, len);
 136     return;
 137   }
 138   if(this == MPI_COMM_WORLD && name_.empty()) {
 139     strncpy(name, "MPI_COMM_WORLD", 15);
 140     *len = 14;
 141   } else if(this == MPI_COMM_SELF && name_.empty()) {
 142     strncpy(name, "MPI_COMM_SELF", 14);
 143     *len = 13;
 144   } else {
 145     *len = snprintf(name, MPI_MAX_NAME_STRING+1, "%s", name_.c_str());
 146   }
 147 }
 148
 149 void Comm::set_name (const char* name)
 150 {
 151   if (this == MPI_COMM_UNINITIALIZED){
 152     smpi_process()->comm_world()->set_name(name);
 153     return;
 154   }
 155   name_.replace (0, MPI_MAX_NAME_STRING+1, name);
 156 }
 157
 158
 159 void Comm::set_leaders_comm(MPI_Comm leaders){
 160   if (this == MPI_COMM_UNINITIALIZED){
 161     smpi_process()->comm_world()->set_leaders_comm(leaders);
 162     return;
 163   }
 164   leaders_comm_=leaders;
 165 }
 166
 167 int* Comm::get_non_uniform_map(){
 168   if (this == MPI_COMM_UNINITIALIZED)
 169     return smpi_process()->comm_world()->get_non_uniform_map();
 170   return non_uniform_map_;
 171 }
 172
 173 int* Comm::get_leaders_map(){
 174   if (this == MPI_COMM_UNINITIALIZED)
 175     return smpi_process()->comm_world()->get_leaders_map();
 176   return leaders_map_;
 177 }
 178
 179 MPI_Comm Comm::get_leaders_comm(){
 180   if (this == MPI_COMM_UNINITIALIZED)
 181     return smpi_process()->comm_world()->get_leaders_comm();
 182   return leaders_comm_;
 183 }
 184
 185 MPI_Comm Comm::get_intra_comm(){
 186   if (this == MPI_COMM_UNINITIALIZED || this==MPI_COMM_WORLD)
 187     return smpi_process()->comm_intra();
 188   else return intra_comm_;
 189 }
 190
 191 int Comm::is_uniform(){
 192   if (this == MPI_COMM_UNINITIALIZED)
 193     return smpi_process()->comm_world()->is_uniform();
 194   return is_uniform_;
 195 }
 196
 197 int Comm::is_blocked(){
 198   if (this == MPI_COMM_UNINITIALIZED)
 199     return smpi_process()->comm_world()->is_blocked();
 200   return is_blocked_;
 201 }
 202
 203 int Comm::is_smp_comm(){
 204   if (this == MPI_COMM_UNINITIALIZED)
 205     return smpi_process()->comm_world()->is_smp_comm();
 206   return is_smp_comm_;
 207 }
 208
 209 MPI_Comm Comm::split(int color, int key)
 210 {
 211   if (this == MPI_COMM_UNINITIALIZED)
 212     return smpi_process()->comm_world()->split(color, key);
 213   int system_tag = 123;
 214   int* recvbuf;
 215
 216   MPI_Group group_root = nullptr;
 217   MPI_Group group_out  = nullptr;
 218   MPI_Group group      = this->group();
 219   int myrank           = this->rank();
 220   int size             = this->size();
 221   /* Gather all colors and keys on rank 0 */
 222   int* sendbuf = xbt_new(int, 2);
 223   sendbuf[0] = color;
 224   sendbuf[1] = key;
 225   if (myrank == 0) {
 226     recvbuf = xbt_new(int, 2 * size);
 227   } else {
 228     recvbuf = nullptr;
 229   }
 230   Coll_gather_default::gather(sendbuf, 2, MPI_INT, recvbuf, 2, MPI_INT, 0, this);
 231   xbt_free(sendbuf);
 232   /* Do the actual job */
 233   if (myrank == 0) {
 234     MPI_Group* group_snd = xbt_new(MPI_Group, size);
 235     std::vector<std::pair<int, int>> rankmap;
 236     rankmap.reserve(size);
 237     for (int i = 0; i < size; i++) {
 238       if (recvbuf[2 * i] != MPI_UNDEFINED) {
 239         rankmap.clear();
 240         for (int j = i + 1; j < size; j++) {
 241           if(recvbuf[2 * i] == recvbuf[2 * j]) {
 242             recvbuf[2 * j] = MPI_UNDEFINED;
 243             rankmap.push_back({recvbuf[2 * j + 1], j});
 244           }
 245         }
 246         /* Add self in the group */
 247         recvbuf[2 * i] = MPI_UNDEFINED;
 248         rankmap.push_back({recvbuf[2 * i + 1], i});
 249         std::sort(begin(rankmap), end(rankmap));
 250         group_out = new Group(rankmap.size());
 251         if (i == 0) {
 252           group_root = group_out; /* Save root's group */
 253         }
 254         for (unsigned j = 0; j < rankmap.size(); j++) {
 255           s4u::ActorPtr actor = group->actor(rankmap[j].second);
 256           group_out->set_mapping(actor, j);
 257         }
 258         MPI_Request* requests = xbt_new(MPI_Request, rankmap.size());
 259         int reqs              = 0;
 260         for (auto const& rank : rankmap) {
 261           if (rank.second != 0) {
 262             group_snd[reqs]=new  Group(group_out);
 263             requests[reqs] = Request::isend(&(group_snd[reqs]), 1, MPI_PTR, rank.second, system_tag, this);
 264             reqs++;
 265           }
 266         }
 267         if(i != 0 && group_out != MPI_COMM_WORLD->group() && group_out != MPI_GROUP_EMPTY)
 268           Group::unref(group_out);
 269
 270         Request::waitall(reqs, requests, MPI_STATUS_IGNORE);
 271         xbt_free(requests);
 272       }
 273     }
 274     xbt_free(recvbuf);
 275     xbt_free(group_snd);
 276     group_out = group_root; /* exit with root's group */
 277   } else {
 278     if(color != MPI_UNDEFINED) {
 279       Request::recv(&group_out, 1, MPI_PTR, 0, system_tag, this, MPI_STATUS_IGNORE);
 280     } /* otherwise, exit with group_out == nullptr */
 281   }
 282   return group_out!=nullptr ? new  Comm(group_out, nullptr) : MPI_COMM_NULL;
 283 }
 284
 285 void Comm::ref(){
 286   if (this == MPI_COMM_UNINITIALIZED){
 287     smpi_process()->comm_world()->ref();
 288     return;
 289   }
 290   group_->ref();
 291   refcount_++;
 292 }
 293
 294 void Comm::cleanup_smp(){
 295   if (intra_comm_ != MPI_COMM_NULL)
 296     Comm::unref(intra_comm_);
 297   if (leaders_comm_ != MPI_COMM_NULL)
 298     Comm::unref(leaders_comm_);
 299   xbt_free(non_uniform_map_);
 300   delete[] leaders_map_;
 301 }
 302
 303 void Comm::unref(Comm* comm){
 304   if (comm == MPI_COMM_UNINITIALIZED){
 305     Comm::unref(smpi_process()->comm_world());
 306     return;
 307   }
 308   comm->refcount_--;
 309   Group::unref(comm->group_);
 310
 311   if(comm->refcount_==0){
 312     comm->cleanup_smp();
 313     comm->cleanup_attr<Comm>();
 314     delete comm;
 315   }
 316 }
 317
 318 MPI_Comm Comm::find_intra_comm(int * leader){
 319   //get the indices of all processes sharing the same simix host
 320   auto& process_list      = sg_host_self()->pimpl_->process_list_;
 321   int intra_comm_size     = 0;
 322   int min_index           = INT_MAX; // the minimum index will be the leader
 323   for (auto& actor : process_list) {
 324     int index = actor.get_pid();
 325     if (this->group()->rank(actor.iface()) != MPI_UNDEFINED) { // Is this process in the current group?
 326       intra_comm_size++;
 327       if (index < min_index)
 328         min_index = index;
 329     }
 330   }
 331   XBT_DEBUG("number of processes deployed on my node : %d", intra_comm_size);
 332   MPI_Group group_intra = new  Group(intra_comm_size);
 333   int i = 0;
 334   for (auto& actor : process_list) {
 335     if (this->group()->rank(actor.iface()) != MPI_UNDEFINED) {
 336       group_intra->set_mapping(actor.iface(), i);
 337       i++;
 338     }
 339   }
 340   *leader=min_index;
 341   return new  Comm(group_intra, nullptr, 1);
 342 }
 343
 344 void Comm::init_smp(){
 345   int leader = -1;
 346   int i = 0;
 347   if (this == MPI_COMM_UNINITIALIZED)
 348     smpi_process()->comm_world()->init_smp();
 349
 350   int comm_size = this->size();
 351
 352   // If we are in replay - perform an ugly hack
 353   // tell SimGrid we are not in replay for a while, because we need the buffers to be copied for the following calls
 354   bool replaying = false; //cache data to set it back again after
 355   if(smpi_process()->replaying()){
 356     replaying = true;
 357     smpi_process()->set_replaying(false);
 358   }
 359
 360   if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP) {
 361     // we need to switch as the called function may silently touch global variables
 362     smpi_switch_data_segment(s4u::Actor::self());
 363   }
 364   //identify neighbours in comm
 365   MPI_Comm comm_intra = find_intra_comm(&leader);
 366
 367
 368   int* leaders_map = new int[comm_size];
 369   int* leader_list = new int[comm_size];
 370   std::fill_n(leaders_map, comm_size, 0);
 371   std::fill_n(leader_list, comm_size, -1);
 372
 373   Coll_allgather_ring::allgather(&leader, 1, MPI_INT , leaders_map, 1, MPI_INT, this);
 374
 375   if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP) {
 376     // we need to switch as the called function may silently touch global variables
 377     smpi_switch_data_segment(s4u::Actor::self());
 378   }
 379
 380   if(leaders_map_==nullptr){
 381     leaders_map_= leaders_map;
 382   }else{
 383     delete[] leaders_map;
 384   }
 385   int leader_group_size = 0;
 386   for(i=0; i<comm_size; i++){
 387     int already_done = 0;
 388     for (int j = 0; j < leader_group_size; j++) {
 389       if (leaders_map_[i] == leader_list[j]) {
 390         already_done = 1;
 391       }
 392     }
 393     if (already_done == 0) {
 394       leader_list[leader_group_size] = leaders_map_[i];
 395       leader_group_size++;
 396     }
 397   }
 398   std::sort(leader_list, leader_list + leader_group_size);
 399
 400   MPI_Group leaders_group = new  Group(leader_group_size);
 401
 402   MPI_Comm leader_comm = MPI_COMM_NULL;
 403   if(MPI_COMM_WORLD!=MPI_COMM_UNINITIALIZED && this!=MPI_COMM_WORLD){
 404     //create leader_communicator
 405     for (i=0; i< leader_group_size;i++)
 406       leaders_group->set_mapping(s4u::Actor::by_pid(leader_list[i]), i);
 407     leader_comm = new  Comm(leaders_group, nullptr,1);
 408     this->set_leaders_comm(leader_comm);
 409     this->set_intra_comm(comm_intra);
 410
 411     // create intracommunicator
 412   }else{
 413     for (i=0; i< leader_group_size;i++)
 414       leaders_group->set_mapping(s4u::Actor::by_pid(leader_list[i]), i);
 415
 416     if(this->get_leaders_comm()==MPI_COMM_NULL){
 417       leader_comm = new  Comm(leaders_group, nullptr,1);
 418       this->set_leaders_comm(leader_comm);
 419     }else{
 420       leader_comm=this->get_leaders_comm();
 421       Group::unref(leaders_group);
 422     }
 423     smpi_process()->set_comm_intra(comm_intra);
 424   }
 425
 426   // Are the nodes uniform ? = same number of process/node
 427   int my_local_size=comm_intra->size();
 428   if(comm_intra->rank()==0) {
 429     int is_uniform       = 1;
 430     int* non_uniform_map = xbt_new0(int,leader_group_size);
 431     Coll_allgather_ring::allgather(&my_local_size, 1, MPI_INT,
 432         non_uniform_map, 1, MPI_INT, leader_comm);
 433     for(i=0; i < leader_group_size; i++) {
 434       if(non_uniform_map[0] != non_uniform_map[i]) {
 435         is_uniform = 0;
 436         break;
 437       }
 438     }
 439     if(is_uniform==0 && this->is_uniform()!=0){
 440       non_uniform_map_ = non_uniform_map;
 441     }else{
 442       xbt_free(non_uniform_map);
 443     }
 444     is_uniform_=is_uniform;
 445   }
 446   Coll_bcast_scatter_LR_allgather::bcast(&(is_uniform_),1, MPI_INT, 0, comm_intra );
 447
 448   if (smpi_privatize_global_variables == SmpiPrivStrategies::MMAP) {
 449     // we need to switch as the called function may silently touch global variables
 450     smpi_switch_data_segment(s4u::Actor::self());
 451   }
 452   // Are the ranks blocked ? = allocated contiguously on the SMP nodes
 453   int is_blocked=1;
 454   int prev=this->group()->rank(comm_intra->group()->actor(0));
 455   for (i = 1; i < my_local_size; i++) {
 456     int that = this->group()->rank(comm_intra->group()->actor(i));
 457     if (that != prev + 1) {
 458       is_blocked = 0;
 459       break;
 460     }
 461     prev = that;
 462   }
 463
 464   int global_blocked;
 465   Coll_allreduce_default::allreduce(&is_blocked, &(global_blocked), 1, MPI_INT, MPI_LAND, this);
 466
 467   if(MPI_COMM_WORLD==MPI_COMM_UNINITIALIZED || this==MPI_COMM_WORLD){
 468     if(this->rank()==0){
 469       is_blocked_ = global_blocked;
 470     }
 471   }else{
 472     is_blocked_=global_blocked;
 473   }
 474   delete[] leader_list;
 475
 476   if(replaying)
 477     smpi_process()->set_replaying(true);
 478 }
 479
 480 MPI_Comm Comm::f2c(int id) {
 481   if(id == -2) {
 482     return MPI_COMM_SELF;
 483   } else if(id==0){
 484     return MPI_COMM_WORLD;
 485   } else if(F2C::f2c_lookup() != nullptr && id >= 0) {
 486     char key[KEY_SIZE];
 487     const auto& lookup = F2C::f2c_lookup();
 488     auto comm          = lookup->find(get_key_id(key, id));
 489     return comm == lookup->end() ? MPI_COMM_NULL : static_cast<MPI_Comm>(comm->second);
 490   } else {
 491     return MPI_COMM_NULL;
 492   }
 493 }
 494
 495 void Comm::free_f(int id) {
 496   char key[KEY_SIZE];
 497   F2C::f2c_lookup()->erase(id == 0 ? get_key(key, id) : get_key_id(key, id));
 498 }
 499
 500 int Comm::add_f() {
 501   if(F2C::f2c_lookup()==nullptr){
 502     F2C::set_f2c_lookup(new std::unordered_map<std::string, F2C*>);
 503   }
 504   char key[KEY_SIZE];
 505   (*(F2C::f2c_lookup()))[this == MPI_COMM_WORLD ? get_key(key, F2C::f2c_id()) : get_key_id(key, F2C::f2c_id())] = this;
 506   f2c_id_increment();
 507   return F2C::f2c_id()-1;
 508 }
 509
 510 void Comm::add_rma_win(MPI_Win win){
 511   rma_wins_.push_back(win);
 512 }
 513
 514 void Comm::remove_rma_win(MPI_Win win){
 515   rma_wins_.remove(win);
 516 }
 517
 518 void Comm::finish_rma_calls(){
 519   for (auto const& it : rma_wins_) {
 520     if(it->rank()==this->rank()){//is it ours (for MPI_COMM_WORLD)?
 521       int finished = it->finish_comms();
 522       XBT_DEBUG("Barrier for rank %d - Finished %d RMA calls",this->rank(), finished);
 523     }
 524   }
 525 }
 526
 527 MPI_Info Comm::info(){
 528   if(info_== MPI_INFO_NULL)
 529     info_ = new Info();
 530   info_->ref();
 531   return info_;
 532 }
 533
 534 void Comm::set_info(MPI_Info info){
 535   if(info_!= MPI_INFO_NULL)
 536     info->ref();
 537   info_=info;
 538 }
 539
 540 MPI_Comm Comm::split_type(int type, int /*key*/, MPI_Info)
 541 {
 542   //MPI_UNDEFINED can be given to some nodes... but we need them to still perform the smp part which is collective
 543   if(type != MPI_COMM_TYPE_SHARED && type != MPI_UNDEFINED){
 544     return MPI_COMM_NULL;
 545   }
 546   int leader=0;
 547   MPI_Comm res= this->find_intra_comm(&leader);
 548   if(type != MPI_UNDEFINED)
 549     return res;
 550   else{
 551     Comm::destroy(res);
 552     return MPI_COMM_NULL;
 553   }
 554 }
 555
 556 } // namespace smpi
 557 } // namespace simgrid