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