1 /* Copyright (c) 2010-2021. The SimGrid Team. All rights reserved. */
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. */
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"
17 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(smpi_comm, smpi, "Logging specific to SMPI (comm)");
19 simgrid::smpi::Comm mpi_MPI_COMM_UNINITIALIZED;
20 MPI_Comm MPI_COMM_UNINITIALIZED=&mpi_MPI_COMM_UNINITIALIZED;
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. */
28 std::unordered_map<int, smpi_key_elem> Comm::keyvals_;
29 int Comm::keyval_id_=0;
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)
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 ){
39 static int global_id_ = 0;
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
50 void Comm::destroy(Comm* comm)
52 if (comm == MPI_COMM_UNINITIALIZED){
53 Comm::destroy(smpi_process()->comm_world());
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());
64 auto* cp = new Group(this->group());
65 (*newcomm) = new Comm(cp, this->topo());
66 int ret = MPI_SUCCESS;
68 if (not attributes()->empty()) {
70 void* value_out=nullptr;
71 for (auto const& it : *attributes()) {
72 smpi_key_elem elem = keyvals_.at(it.first);
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);
82 if (ret != MPI_SUCCESS) {
83 Comm::destroy(*newcomm);
84 *newcomm = MPI_COMM_NULL;
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)){
90 (*newcomm)->attributes()->insert({it.first, it.second});
93 (*newcomm)->attributes()->insert({it.first, value_out});
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_);
106 int Comm::dup_with_info(MPI_Info info, MPI_Comm* newcomm){
107 int ret = dup(newcomm);
108 if(ret != MPI_SUCCESS)
110 if((*newcomm)->info_!=MPI_INFO_NULL){
111 simgrid::smpi::Info::unref((*newcomm)->info_);
112 (*newcomm)->info_=MPI_INFO_NULL;
114 if(info != MPI_INFO_NULL){
116 (*newcomm)->info_=info;
121 MPI_Group Comm::group()
123 if (this == MPI_COMM_UNINITIALIZED)
124 return smpi_process()->comm_world()->group();
128 int Comm::size() const
130 if (this == MPI_COMM_UNINITIALIZED)
131 return smpi_process()->comm_world()->size();
132 return group_->size();
135 int Comm::rank() const
137 if (this == MPI_COMM_UNINITIALIZED)
138 return smpi_process()->comm_world()->rank();
139 return group_->rank(s4u::Actor::self());
147 void Comm::get_name(char* name, int* len) const
149 if (this == MPI_COMM_UNINITIALIZED){
150 smpi_process()->comm_world()->get_name(name, len);
153 if(this == MPI_COMM_WORLD && name_.empty()) {
154 strncpy(name, "MPI_COMM_WORLD", 15);
156 } else if(this == MPI_COMM_SELF && name_.empty()) {
157 strncpy(name, "MPI_COMM_SELF", 14);
160 *len = snprintf(name, MPI_MAX_NAME_STRING+1, "%s", name_.c_str());
164 void Comm::set_name (const char* name)
166 if (this == MPI_COMM_UNINITIALIZED){
167 smpi_process()->comm_world()->set_name(name);
170 name_.replace (0, MPI_MAX_NAME_STRING+1, name);
174 void Comm::set_leaders_comm(MPI_Comm leaders){
175 if (this == MPI_COMM_UNINITIALIZED){
176 smpi_process()->comm_world()->set_leaders_comm(leaders);
179 leaders_comm_=leaders;
182 int* Comm::get_non_uniform_map() const
184 if (this == MPI_COMM_UNINITIALIZED)
185 return smpi_process()->comm_world()->get_non_uniform_map();
186 return non_uniform_map_;
189 int* Comm::get_leaders_map() const
191 if (this == MPI_COMM_UNINITIALIZED)
192 return smpi_process()->comm_world()->get_leaders_map();
196 MPI_Comm Comm::get_leaders_comm() const
198 if (this == MPI_COMM_UNINITIALIZED)
199 return smpi_process()->comm_world()->get_leaders_comm();
200 return leaders_comm_;
203 MPI_Comm Comm::get_intra_comm() const
205 if (this == MPI_COMM_UNINITIALIZED || this==MPI_COMM_WORLD)
206 return smpi_process()->comm_intra();
207 else return intra_comm_;
210 bool Comm::is_uniform() const
212 if (this == MPI_COMM_UNINITIALIZED)
213 return smpi_process()->comm_world()->is_uniform();
214 return is_uniform_ != 0;
217 bool Comm::is_blocked() const
219 if (this == MPI_COMM_UNINITIALIZED)
220 return smpi_process()->comm_world()->is_blocked();
221 return is_blocked_ != 0;
224 bool Comm::is_smp_comm() const
226 if (this == MPI_COMM_UNINITIALIZED)
227 return smpi_process()->comm_world()->is_smp_comm();
231 MPI_Comm Comm::split(int color, int key)
233 if (this == MPI_COMM_UNINITIALIZED)
234 return smpi_process()->comm_world()->split(color, key);
235 int system_tag = -123;
237 MPI_Group group_root = nullptr;
238 MPI_Group group_out = nullptr;
239 MPI_Group group = this->group();
240 int myrank = this->rank();
241 int size = this->size();
242 /* Gather all colors and keys on rank 0 */
243 const std::array<int, 2> sendbuf = {{color, key}};
244 std::vector<int> recvbuf;
246 recvbuf.resize(2 * size);
247 gather__default(sendbuf.data(), 2, MPI_INT, recvbuf.data(), 2, MPI_INT, 0, this);
248 /* Do the actual job */
250 std::vector<MPI_Group> group_snd(size);
251 std::vector<std::pair<int, int>> rankmap;
252 rankmap.reserve(size);
253 for (int i = 0; i < size; i++) {
254 if (recvbuf[2 * i] != MPI_UNDEFINED) {
256 for (int j = i + 1; j < size; j++) {
257 if(recvbuf[2 * i] == recvbuf[2 * j]) {
258 recvbuf[2 * j] = MPI_UNDEFINED;
259 rankmap.emplace_back(recvbuf[2 * j + 1], j);
262 /* Add self in the group */
263 recvbuf[2 * i] = MPI_UNDEFINED;
264 rankmap.emplace_back(recvbuf[2 * i + 1], i);
265 std::sort(begin(rankmap), end(rankmap));
266 group_out = new Group(rankmap.size());
268 group_root = group_out; /* Save root's group */
270 for (unsigned j = 0; j < rankmap.size(); j++) {
271 s4u::Actor* actor = group->actor(rankmap[j].second);
272 group_out->set_mapping(actor, j);
274 std::vector<MPI_Request> requests(rankmap.size());
276 for (auto const& rank : rankmap) {
277 if (rank.second != 0) {
278 group_snd[reqs]=new Group(group_out);
279 requests[reqs] = Request::isend(&(group_snd[reqs]), 1, MPI_PTR, rank.second, system_tag, this);
283 if(i != 0 && group_out != MPI_COMM_WORLD->group() && group_out != MPI_GROUP_EMPTY)
284 Group::unref(group_out);
286 Request::waitall(reqs, requests.data(), MPI_STATUS_IGNORE);
289 group_out = group_root; /* exit with root's group */
291 if(color != MPI_UNDEFINED) {
292 Request::recv(&group_out, 1, MPI_PTR, 0, system_tag, this, MPI_STATUS_IGNORE);
293 } /* otherwise, exit with group_out == nullptr */
295 return group_out!=nullptr ? new Comm(group_out, topo_) : MPI_COMM_NULL;
299 if (this == MPI_COMM_UNINITIALIZED){
300 smpi_process()->comm_world()->ref();
307 void Comm::cleanup_smp(){
308 if (intra_comm_ != MPI_COMM_NULL)
309 Comm::unref(intra_comm_);
310 if (leaders_comm_ != MPI_COMM_NULL)
311 Comm::unref(leaders_comm_);
312 xbt_free(non_uniform_map_);
313 delete[] leaders_map_;
316 void Comm::unref(Comm* comm){
317 if (comm == MPI_COMM_UNINITIALIZED){
318 Comm::unref(smpi_process()->comm_world());
322 Group::unref(comm->group_);
324 if(comm->refcount_==0){
326 comm->cleanup_attr<Comm>();
327 if (comm->info_ != MPI_INFO_NULL)
328 simgrid::smpi::Info::unref(comm->info_);
329 if (comm->errhandler_ != MPI_ERRHANDLER_NULL)
330 simgrid::smpi::Errhandler::unref(comm->errhandler_);
335 MPI_Comm Comm::find_intra_comm(int * leader){
336 //get the indices of all processes sharing the same simix host
337 auto& actor_list = sg_host_self()->pimpl_->actor_list_;
338 int intra_comm_size = 0;
339 int min_index = INT_MAX; // the minimum index will be the leader
340 for (auto& actor : actor_list) {
341 int index = actor.get_pid();
342 if (this->group()->rank(actor.get_ciface()) != MPI_UNDEFINED) { // Is this process in the current group?
344 if (index < min_index)
348 XBT_DEBUG("number of processes deployed on my node : %d", intra_comm_size);
349 auto* group_intra = new Group(intra_comm_size);
351 for (auto& actor : actor_list) {
352 if (this->group()->rank(actor.get_ciface()) != MPI_UNDEFINED) {
353 group_intra->set_mapping(actor.get_ciface(), i);
358 return new Comm(group_intra, nullptr, true);
361 void Comm::init_smp(){
364 if (this == MPI_COMM_UNINITIALIZED)
365 smpi_process()->comm_world()->init_smp();
367 int comm_size = this->size();
369 // If we are in replay - perform an ugly hack
370 // tell SimGrid we are not in replay for a while, because we need the buffers to be copied for the following calls
371 bool replaying = false; //cache data to set it back again after
372 if(smpi_process()->replaying()){
374 smpi_process()->set_replaying(false);
377 if (smpi_cfg_privatization() == SmpiPrivStrategies::MMAP) {
378 // we need to switch as the called function may silently touch global variables
379 smpi_switch_data_segment(s4u::Actor::self());
381 // identify neighbors in comm
382 MPI_Comm comm_intra = find_intra_comm(&leader);
384 auto* leaders_map = new int[comm_size];
385 auto* leader_list = new int[comm_size];
386 std::fill_n(leaders_map, comm_size, 0);
387 std::fill_n(leader_list, comm_size, -1);
389 allgather__ring(&leader, 1, MPI_INT , leaders_map, 1, MPI_INT, this);
391 if (smpi_cfg_privatization() == SmpiPrivStrategies::MMAP) {
392 // we need to switch as the called function may silently touch global variables
393 smpi_switch_data_segment(s4u::Actor::self());
396 if(leaders_map_==nullptr){
397 leaders_map_= leaders_map;
399 delete[] leaders_map;
401 int leader_group_size = 0;
402 for(i=0; i<comm_size; i++){
403 int already_done = 0;
404 for (int j = 0; j < leader_group_size; j++) {
405 if (leaders_map_[i] == leader_list[j]) {
409 if (already_done == 0) {
410 leader_list[leader_group_size] = leaders_map_[i];
414 xbt_assert(leader_group_size > 0);
415 std::sort(leader_list, leader_list + leader_group_size);
417 auto* leaders_group = new Group(leader_group_size);
419 MPI_Comm leader_comm = MPI_COMM_NULL;
420 if(MPI_COMM_WORLD!=MPI_COMM_UNINITIALIZED && this!=MPI_COMM_WORLD){
421 //create leader_communicator
422 for (i=0; i< leader_group_size;i++)
423 leaders_group->set_mapping(s4u::Actor::by_pid(leader_list[i]).get(), i);
424 leader_comm = new Comm(leaders_group, nullptr, true);
425 this->set_leaders_comm(leader_comm);
426 this->set_intra_comm(comm_intra);
428 // create intracommunicator
430 for (i=0; i< leader_group_size;i++)
431 leaders_group->set_mapping(s4u::Actor::by_pid(leader_list[i]).get(), i);
433 if(this->get_leaders_comm()==MPI_COMM_NULL){
434 leader_comm = new Comm(leaders_group, nullptr, true);
435 this->set_leaders_comm(leader_comm);
437 leader_comm=this->get_leaders_comm();
438 Group::unref(leaders_group);
440 smpi_process()->set_comm_intra(comm_intra);
443 // Are the nodes uniform ? = same number of process/node
444 int my_local_size=comm_intra->size();
445 if(comm_intra->rank()==0) {
447 int* non_uniform_map = xbt_new0(int,leader_group_size);
448 allgather__ring(&my_local_size, 1, MPI_INT,
449 non_uniform_map, 1, MPI_INT, leader_comm);
450 for(i=0; i < leader_group_size; i++) {
451 if(non_uniform_map[0] != non_uniform_map[i]) {
456 if (is_uniform == 0 && this->is_uniform()) {
457 non_uniform_map_ = non_uniform_map;
459 xbt_free(non_uniform_map);
461 is_uniform_=is_uniform;
463 bcast__scatter_LR_allgather(&(is_uniform_),1, MPI_INT, 0, comm_intra );
465 if (smpi_cfg_privatization() == SmpiPrivStrategies::MMAP) {
466 // we need to switch as the called function may silently touch global variables
467 smpi_switch_data_segment(s4u::Actor::self());
469 // Are the ranks blocked ? = allocated contiguously on the SMP nodes
471 int prev=this->group()->rank(comm_intra->group()->actor(0));
472 for (i = 1; i < my_local_size; i++) {
473 int that = this->group()->rank(comm_intra->group()->actor(i));
474 if (that != prev + 1) {
482 allreduce__default(&is_blocked, &(global_blocked), 1, MPI_INT, MPI_LAND, this);
484 if(MPI_COMM_WORLD==MPI_COMM_UNINITIALIZED || this==MPI_COMM_WORLD){
486 is_blocked_ = global_blocked;
489 is_blocked_=global_blocked;
491 delete[] leader_list;
494 smpi_process()->set_replaying(true);
497 MPI_Comm Comm::f2c(int id) {
499 return MPI_COMM_SELF;
501 return MPI_COMM_WORLD;
502 } else if (F2C::lookup() != nullptr && id >= 0) {
503 const auto& lookup = F2C::lookup();
504 auto comm = lookup->find(id);
505 return comm == lookup->end() ? MPI_COMM_NULL : static_cast<MPI_Comm>(comm->second);
507 return MPI_COMM_NULL;
511 void Comm::free_f(int id) {
512 F2C::lookup()->erase(id);
515 void Comm::add_rma_win(MPI_Win win){
516 rma_wins_.push_back(win);
519 void Comm::remove_rma_win(MPI_Win win){
520 rma_wins_.remove(win);
523 void Comm::finish_rma_calls() const
525 for (auto const& it : rma_wins_) {
526 if(it->rank()==this->rank()){//is it ours (for MPI_COMM_WORLD)?
527 int finished = it->finish_comms();
528 XBT_DEBUG("Barrier for rank %d - Finished %d RMA calls",this->rank(), finished);
533 MPI_Info Comm::info()
535 if (info_ == MPI_INFO_NULL)
541 void Comm::set_info(MPI_Info info)
543 if (info_ != MPI_INFO_NULL)
544 simgrid::smpi::Info::unref(info);
546 if (info_ != MPI_INFO_NULL)
550 MPI_Errhandler Comm::errhandler()
552 if (errhandler_ != MPI_ERRHANDLER_NULL)
557 void Comm::set_errhandler(MPI_Errhandler errhandler)
559 if (errhandler_ != MPI_ERRHANDLER_NULL)
560 simgrid::smpi::Errhandler::unref(errhandler_);
561 errhandler_ = errhandler;
562 if (errhandler_ != MPI_ERRHANDLER_NULL)
566 MPI_Comm Comm::split_type(int type, int /*key*/, const Info*)
568 //MPI_UNDEFINED can be given to some nodes... but we need them to still perform the smp part which is collective
569 if(type != MPI_COMM_TYPE_SHARED && type != MPI_UNDEFINED){
570 return MPI_COMM_NULL;
573 MPI_Comm res= this->find_intra_comm(&leader);
574 if(type != MPI_UNDEFINED)
577 xbt_assert(res->refcount_ == 1); // ensure the next call to Comm::destroy really frees the comm
579 return MPI_COMM_NULL;
584 } // namespace simgrid