src/smpi/smpi_comm.cpp

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