src/smpi/mpi/smpi_comm.cpp

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