Logo AND Algorithmique Numérique Distribuée

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