src/smpi/mpi/smpi_comm.cpp

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