src/kernel/activity/CommImpl.cpp

   1 /* Copyright (c) 2007-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 "src/kernel/activity/CommImpl.hpp"
   7 #include "simgrid/Exception.hpp"
   8 #include "simgrid/kernel/resource/Action.hpp"
   9 #include "simgrid/kernel/routing/NetPoint.hpp"
  10 #include "simgrid/modelchecker.h"
  11 #include "simgrid/s4u/Host.hpp"
  12 #include "src/kernel/activity/MailboxImpl.hpp"
  13 #include "src/kernel/context/Context.hpp"
  14 #include "src/mc/mc_replay.hpp"
  15 #include "src/surf/cpu_interface.hpp"
  16 #include "src/surf/network_interface.hpp"
  17 #include "src/surf/surf_interface.hpp"
  18
  19 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_network, simix, "SIMIX network-related synchronization");
  20
  21 XBT_PRIVATE void simcall_HANDLER_comm_send(smx_simcall_t simcall, smx_actor_t src, smx_mailbox_t mbox, double task_size,
  22                                            double rate, unsigned char* src_buff, size_t src_buff_size,
  23                                            bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  24                                            void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
  25                                            void* data, double timeout)
  26 {
  27   simgrid::kernel::activity::ActivityImplPtr comm = simcall_HANDLER_comm_isend(
  28       simcall, src, mbox, task_size, rate, src_buff, src_buff_size, match_fun, nullptr, copy_data_fun, data, false);
  29   simcall->mc_value_ = 0;
  30   simcall_HANDLER_comm_wait(simcall, static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()), timeout);
  31 }
  32
  33 XBT_PRIVATE simgrid::kernel::activity::ActivityImplPtr simcall_HANDLER_comm_isend(
  34     smx_simcall_t /*simcall*/, smx_actor_t src_proc, smx_mailbox_t mbox, double task_size, double rate,
  35     unsigned char* src_buff, size_t src_buff_size,
  36     bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
  37     void (*clean_fun)(void*), // used to free the synchro in case of problem after a detached send
  38     void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), // used to copy data if not default one
  39     void* data, bool detached)
  40 {
  41   XBT_DEBUG("send from mailbox %p", mbox);
  42
  43   /* Prepare a synchro describing us, so that it gets passed to the user-provided filter of other side */
  44   simgrid::kernel::activity::CommImplPtr this_comm(
  45       new simgrid::kernel::activity::CommImpl(simgrid::kernel::activity::CommImpl::Type::SEND));
  46
  47   /* Look for communication synchro matching our needs. We also provide a description of
  48    * ourself so that the other side also gets a chance of choosing if it wants to match with us.
  49    *
  50    * If it is not found then push our communication into the rendez-vous point */
  51   simgrid::kernel::activity::CommImplPtr other_comm =
  52       mbox->find_matching_comm(simgrid::kernel::activity::CommImpl::Type::RECEIVE, match_fun, data, this_comm,
  53                                /*done*/ false, /*remove_matching*/ true);
  54
  55   if (not other_comm) {
  56     other_comm = std::move(this_comm);
  57
  58     if (mbox->permanent_receiver_ != nullptr) {
  59       // this mailbox is for small messages, which have to be sent right now
  60       other_comm->state_     = simgrid::kernel::activity::State::READY;
  61       other_comm->dst_actor_ = mbox->permanent_receiver_.get();
  62       mbox->done_comm_queue_.push_back(other_comm);
  63       XBT_DEBUG("pushing a message into the permanent receive list %p, comm %p", mbox, other_comm.get());
  64
  65     } else {
  66       mbox->push(other_comm);
  67     }
  68   } else {
  69     XBT_DEBUG("Receive already pushed");
  70
  71     other_comm->state_ = simgrid::kernel::activity::State::READY;
  72   }
  73
  74   if (detached) {
  75     other_comm->detach();
  76     other_comm->clean_fun = clean_fun;
  77   } else {
  78     other_comm->clean_fun = nullptr;
  79     src_proc->activities_.emplace_back(other_comm);
  80   }
  81
  82   /* Setup the communication synchro */
  83   other_comm->src_actor_ = src_proc;
  84   other_comm->src_data_  = data;
  85   (*other_comm).set_src_buff(src_buff, src_buff_size).set_size(task_size).set_rate(rate);
  86
  87   other_comm->match_fun     = match_fun;
  88   other_comm->copy_data_fun = copy_data_fun;
  89
  90   if (MC_is_active() || MC_record_replay_is_active())
  91     other_comm->state_ = simgrid::kernel::activity::State::RUNNING;
  92   else
  93     other_comm->start();
  94
  95   return (detached ? nullptr : other_comm);
  96 }
  97
  98 XBT_PRIVATE void simcall_HANDLER_comm_recv(smx_simcall_t simcall, smx_actor_t receiver, smx_mailbox_t mbox,
  99                                            unsigned char* dst_buff, size_t* dst_buff_size,
 100                                            bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 101                                            void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
 102                                            void* data, double timeout, double rate)
 103 {
 104   simgrid::kernel::activity::ActivityImplPtr comm = simcall_HANDLER_comm_irecv(
 105       simcall, receiver, mbox, dst_buff, dst_buff_size, match_fun, copy_data_fun, data, rate);
 106   simcall->mc_value_ = 0;
 107   simcall_HANDLER_comm_wait(simcall, static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()), timeout);
 108 }
 109
 110 XBT_PRIVATE simgrid::kernel::activity::ActivityImplPtr
 111 simcall_HANDLER_comm_irecv(smx_simcall_t /*simcall*/, smx_actor_t receiver, smx_mailbox_t mbox, unsigned char* dst_buff,
 112                            size_t* dst_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
 113                            void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
 114                            double rate)
 115 {
 116   simgrid::kernel::activity::CommImplPtr this_synchro(
 117       new simgrid::kernel::activity::CommImpl(simgrid::kernel::activity::CommImpl::Type::RECEIVE));
 118   XBT_DEBUG("recv from mbox %p. this_synchro=%p", mbox, this_synchro.get());
 119
 120   simgrid::kernel::activity::CommImplPtr other_comm;
 121   // communication already done, get it inside the list of completed comms
 122   if (mbox->permanent_receiver_ != nullptr && not mbox->done_comm_queue_.empty()) {
 123     XBT_DEBUG("We have a comm that has probably already been received, trying to match it, to skip the communication");
 124     // find a match in the list of already received comms
 125     other_comm = mbox->find_matching_comm(simgrid::kernel::activity::CommImpl::Type::SEND, match_fun, data,
 126                                           this_synchro, /*done*/ true,
 127                                           /*remove_matching*/ true);
 128     // if not found, assume the receiver came first, register it to the mailbox in the classical way
 129     if (not other_comm) {
 130       XBT_DEBUG("We have messages in the permanent receive list, but not the one we are looking for, pushing request "
 131                 "into list");
 132       other_comm = std::move(this_synchro);
 133       mbox->push(other_comm);
 134     } else {
 135       if (other_comm->surf_action_ && other_comm->get_remaining() < 1e-12) {
 136         XBT_DEBUG("comm %p has been already sent, and is finished, destroy it", other_comm.get());
 137         other_comm->state_ = simgrid::kernel::activity::State::DONE;
 138         other_comm->set_mailbox(nullptr);
 139       }
 140     }
 141   } else {
 142     /* Prepare a comm describing us, so that it gets passed to the user-provided filter of other side */
 143
 144     /* Look for communication activity matching our needs. We also provide a description of
 145      * ourself so that the other side also gets a chance of choosing if it wants to match with us.
 146      *
 147      * If it is not found then push our communication into the rendez-vous point */
 148     other_comm = mbox->find_matching_comm(simgrid::kernel::activity::CommImpl::Type::SEND, match_fun, data,
 149                                           this_synchro, /*done*/ false,
 150                                           /*remove_matching*/ true);
 151
 152     if (other_comm == nullptr) {
 153       XBT_DEBUG("Receive pushed first (%zu comm enqueued so far)", mbox->comm_queue_.size());
 154       other_comm = std::move(this_synchro);
 155       mbox->push(other_comm);
 156     } else {
 157       XBT_DEBUG("Match my %p with the existing %p", this_synchro.get(), other_comm.get());
 158
 159       other_comm->state_ = simgrid::kernel::activity::State::READY;
 160     }
 161     receiver->activities_.emplace_back(other_comm);
 162   }
 163
 164   /* Setup communication synchro */
 165   other_comm->dst_actor_ = receiver;
 166   other_comm->dst_data_  = data;
 167   other_comm->set_dst_buff(dst_buff, dst_buff_size);
 168
 169   if (rate > -1.0 && (other_comm->get_rate() < 0.0 || rate < other_comm->get_rate()))
 170     other_comm->set_rate(rate);
 171
 172   other_comm->match_fun     = match_fun;
 173   other_comm->copy_data_fun = copy_data_fun;
 174
 175   if (MC_is_active() || MC_record_replay_is_active()) {
 176     other_comm->state_ = simgrid::kernel::activity::State::RUNNING;
 177     return other_comm;
 178   }
 179   other_comm->start();
 180   return other_comm;
 181 }
 182
 183 void simcall_HANDLER_comm_wait(smx_simcall_t simcall, simgrid::kernel::activity::CommImpl* comm, double timeout)
 184 {
 185   /* Associate this simcall to the wait synchro */
 186   XBT_DEBUG("simcall_HANDLER_comm_wait, %p", comm);
 187
 188   comm->register_simcall(simcall);
 189
 190   if (MC_is_active() || MC_record_replay_is_active()) {
 191     int idx = simcall->mc_value_;
 192     if (idx == 0) {
 193       comm->state_ = simgrid::kernel::activity::State::DONE;
 194     } else {
 195       /* If we reached this point, the wait simcall must have a timeout */
 196       /* Otherwise it shouldn't be enabled and executed by the MC */
 197       if (timeout < 0.0)
 198         THROW_IMPOSSIBLE;
 199
 200       if (comm->src_actor_ == simcall->issuer_)
 201         comm->state_ = simgrid::kernel::activity::State::SRC_TIMEOUT;
 202       else
 203         comm->state_ = simgrid::kernel::activity::State::DST_TIMEOUT;
 204     }
 205
 206     comm->finish();
 207     return;
 208   }
 209
 210   /* If the synchro has already finish perform the error handling, */
 211   /* otherwise set up a waiting timeout on the right side          */
 212   if (comm->state_ != simgrid::kernel::activity::State::WAITING &&
 213       comm->state_ != simgrid::kernel::activity::State::RUNNING) {
 214     comm->finish();
 215   } else { /* we need a sleep action (even when there is no timeout) to be notified of host failures */
 216     simgrid::kernel::resource::Action* sleep = simcall->issuer_->get_host()->pimpl_cpu->sleep(timeout);
 217     sleep->set_activity(comm);
 218
 219     if (simcall->issuer_ == comm->src_actor_)
 220       comm->src_timeout_ = sleep;
 221     else
 222       comm->dst_timeout_ = sleep;
 223   }
 224 }
 225
 226 bool simcall_HANDLER_comm_test(smx_simcall_t, simgrid::kernel::activity::CommImpl* comm)
 227 {
 228   return comm->test();
 229 }
 230
 231 int simcall_HANDLER_comm_testany(smx_simcall_t simcall, simgrid::kernel::activity::CommImpl* comms[], size_t count)
 232 {
 233   if (MC_is_active() || MC_record_replay_is_active()) {
 234     int idx = simcall->mc_value_;
 235     xbt_assert(idx == -1 || comms[idx]->test());
 236     return idx;
 237   }
 238
 239   for (std::size_t i = 0; i != count; ++i) {
 240     if (comms[i]->test())
 241       return i;
 242   }
 243   return -1;
 244 }
 245
 246 static void SIMIX_waitany_remove_simcall_from_actions(smx_simcall_t simcall)
 247 {
 248   simgrid::kernel::activity::CommImpl** comms = simcall_comm_waitany__get__comms(simcall);
 249   size_t count                                = simcall_comm_waitany__get__count(simcall);
 250
 251   for (size_t i = 0; i < count; i++)
 252     comms[i]->unregister_simcall(simcall);
 253 }
 254 void simcall_HANDLER_comm_waitany(smx_simcall_t simcall, simgrid::kernel::activity::CommImpl* comms[], size_t count,
 255                                   double timeout)
 256 {
 257   if (MC_is_active() || MC_record_replay_is_active()) {
 258     xbt_assert(timeout <= 0.0, "Timeout not implemented for waitany in the model-checker");
 259     int idx                 = simcall->mc_value_;
 260     auto* comm              = comms[idx];
 261     comm->simcalls_.push_back(simcall);
 262     simcall_comm_waitany__set__result(simcall, idx);
 263     comm->state_ = simgrid::kernel::activity::State::DONE;
 264     comm->finish();
 265     return;
 266   }
 267
 268   if (timeout < 0.0) {
 269     simcall->timeout_cb_ = nullptr;
 270   } else {
 271     simcall->timeout_cb_ = simgrid::simix::Timer::set(SIMIX_get_clock() + timeout, [simcall]() {
 272       simcall->timeout_cb_ = nullptr;
 273       SIMIX_waitany_remove_simcall_from_actions(simcall);
 274       simcall_comm_waitany__set__result(simcall, -1);
 275       simcall->issuer_->simcall_answer();
 276     });
 277   }
 278
 279   for (size_t i = 0; i < count; i++) {
 280     /* associate this simcall to the the synchro */
 281     auto* comm = comms[i];
 282     comm->simcalls_.push_back(simcall);
 283
 284     /* see if the synchro is already finished */
 285     if (comm->state_ != simgrid::kernel::activity::State::WAITING &&
 286         comm->state_ != simgrid::kernel::activity::State::RUNNING) {
 287       comm->finish();
 288       break;
 289     }
 290   }
 291 }
 292
 293 /******************************************************************************/
 294 /*                    SIMIX_comm_copy_data callbacks                       */
 295 /******************************************************************************/
 296 void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*, size_t))
 297 {
 298   simgrid::kernel::activity::CommImpl::set_copy_data_callback(callback);
 299 }
 300
 301 void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
 302 {
 303   XBT_DEBUG("Copy the data over");
 304   memcpy(comm->dst_buff_, buff, buff_size);
 305   if (comm->detached()) { // if this is a detached send, the source buffer was duplicated by SMPI sender to make the
 306                           // original buffer available to the application ASAP
 307     xbt_free(buff);
 308     comm->src_buff_ = nullptr;
 309   }
 310 }
 311
 312 void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
 313 {
 314   xbt_assert((buff_size == sizeof(void*)), "Cannot copy %zu bytes: must be sizeof(void*)", buff_size);
 315   *(void**)(comm->dst_buff_) = buff;
 316 }
 317
 318 namespace simgrid {
 319 namespace kernel {
 320 namespace activity {
 321
 322 void (*CommImpl::copy_data_callback_)(CommImpl*, void*, size_t) = &SIMIX_comm_copy_pointer_callback;
 323
 324 void CommImpl::set_copy_data_callback(void (*callback)(CommImpl*, void*, size_t))
 325 {
 326   copy_data_callback_ = callback;
 327 }
 328
 329 CommImpl& CommImpl::set_size(double size)
 330 {
 331   size_ = size;
 332   return *this;
 333 }
 334
 335 CommImpl& CommImpl::set_rate(double rate)
 336 {
 337   rate_ = rate;
 338   return *this;
 339 }
 340 CommImpl& CommImpl::set_mailbox(MailboxImpl* mbox)
 341 {
 342   mbox_ = mbox;
 343   return *this;
 344 }
 345
 346 CommImpl& CommImpl::set_src_buff(unsigned char* buff, size_t size)
 347 {
 348   src_buff_      = buff;
 349   src_buff_size_ = size;
 350   return *this;
 351 }
 352
 353 CommImpl& CommImpl::set_dst_buff(unsigned char* buff, size_t* size)
 354 {
 355   dst_buff_      = buff;
 356   dst_buff_size_ = size;
 357   return *this;
 358 }
 359
 360 CommImpl& CommImpl::detach()
 361 {
 362   detached_ = true;
 363   return *this;
 364 }
 365
 366 CommImpl::CommImpl(s4u::Host* from, s4u::Host* to, double bytes) : size_(bytes), detached_(true), from_(from), to_(to)
 367 {
 368   state_ = State::READY;
 369 }
 370
 371 CommImpl::~CommImpl()
 372 {
 373   XBT_DEBUG("Really free communication %p in state %s (detached = %d)", this, get_state_str(), detached_);
 374
 375   cleanup_surf();
 376
 377   if (detached_ && state_ != State::DONE) {
 378     /* the communication has failed and was detached:
 379      * we have to free the buffer */
 380     if (clean_fun)
 381       clean_fun(src_buff_);
 382     src_buff_ = nullptr;
 383   } else if (mbox_) {
 384     mbox_->remove(this);
 385   }
 386 }
 387
 388 /**  @brief Starts the simulation of a communication synchro. */
 389 CommImpl* CommImpl::start()
 390 {
 391   /* If both the sender and the receiver are already there, start the communication */
 392   if (state_ == State::READY) {
 393     from_ = from_ != nullptr ? from_ : src_actor_->get_host();
 394     to_   = to_ != nullptr ? to_ : dst_actor_->get_host();
 395
 396     /* FIXME[donassolo]: getting the network_model from the origin host
 397      * Soon we need to change this function to first get the routes and later
 398      * create the respective surf actions */
 399     auto net_model = from_->get_netpoint()->get_englobing_zone()->get_network_model();
 400
 401     surf_action_ = net_model->communicate(from_, to_, size_, rate_);
 402     surf_action_->set_activity(this);
 403     surf_action_->set_category(get_tracing_category());
 404     state_ = State::RUNNING;
 405
 406     XBT_DEBUG("Starting communication %p from '%s' to '%s' (surf_action: %p; state: %s)", this, from_->get_cname(),
 407               to_->get_cname(), surf_action_, get_state_str());
 408
 409     /* If a link is failed, detect it immediately */
 410     if (surf_action_->get_state() == resource::Action::State::FAILED) {
 411       XBT_DEBUG("Communication from '%s' to '%s' failed to start because of a link failure", from_->get_cname(),
 412                 to_->get_cname());
 413       state_ = State::LINK_FAILURE;
 414       post();
 415
 416     } else if ((src_actor_ != nullptr && src_actor_->is_suspended()) ||
 417                (dst_actor_ != nullptr && dst_actor_->is_suspended())) {
 418       /* If any of the process is suspended, create the synchro but stop its execution,
 419          it will be restarted when the sender process resume */
 420       if (src_actor_->is_suspended())
 421         XBT_DEBUG("The communication is suspended on startup because src (%s@%s) was suspended since it initiated the "
 422                   "communication",
 423                   src_actor_->get_cname(), src_actor_->get_host()->get_cname());
 424       else
 425         XBT_DEBUG("The communication is suspended on startup because dst (%s@%s) was suspended since it initiated the "
 426                   "communication",
 427                   dst_actor_->get_cname(), dst_actor_->get_host()->get_cname());
 428
 429       surf_action_->suspend();
 430     }
 431   }
 432
 433   return this;
 434 }
 435
 436 /** @brief Copy the communication data from the sender's buffer to the receiver's one  */
 437 void CommImpl::copy_data()
 438 {
 439   size_t buff_size = src_buff_size_;
 440   /* If there is no data to copy then return */
 441   if (not src_buff_ || not dst_buff_ || copied_)
 442     return;
 443
 444   XBT_DEBUG("Copying comm %p data from %s (%p) -> %s (%p) (%zu bytes)", this,
 445             src_actor_ ? src_actor_->get_host()->get_cname() : "a finished process", src_buff_,
 446             dst_actor_ ? dst_actor_->get_host()->get_cname() : "a finished process", dst_buff_, buff_size);
 447
 448   /* Copy at most dst_buff_size bytes of the message to receiver's buffer */
 449   if (dst_buff_size_) {
 450     buff_size = std::min(buff_size, *dst_buff_size_);
 451
 452     /* Update the receiver's buffer size to the copied amount */
 453     *dst_buff_size_ = buff_size;
 454   }
 455
 456   if (buff_size > 0) {
 457     if (copy_data_fun)
 458       copy_data_fun(this, src_buff_, buff_size);
 459     else
 460       copy_data_callback_(this, src_buff_, buff_size);
 461   }
 462
 463   /* Set the copied flag so we copy data only once */
 464   /* (this function might be called from both communication ends) */
 465   copied_ = true;
 466 }
 467
 468 bool CommImpl::test()
 469 {
 470   if ((MC_is_active() || MC_record_replay_is_active()) && src_actor_ && dst_actor_)
 471     state_ = State::DONE;
 472   return ActivityImpl::test();
 473 }
 474
 475 void CommImpl::suspend()
 476 {
 477   /* FIXME: shall we suspend also the timeout synchro? */
 478   if (surf_action_)
 479     surf_action_->suspend();
 480   /* if not created yet, the action will be suspended on creation, in CommImpl::start() */
 481 }
 482
 483 void CommImpl::resume()
 484 {
 485   /*FIXME: check what happen with the timeouts */
 486   if (surf_action_)
 487     surf_action_->resume();
 488   /* in the other case, the synchro were not really suspended yet, see CommImpl::suspend() and CommImpl::start() */
 489 }
 490
 491 void CommImpl::cancel()
 492 {
 493   /* if the synchro is a waiting state means that it is still in a mbox so remove from it and delete it */
 494   if (state_ == State::WAITING) {
 495     if (not detached_) {
 496       mbox_->remove(this);
 497       state_ = State::CANCELED;
 498     }
 499   } else if (not MC_is_active() /* when running the MC there are no surf actions */
 500              && not MC_record_replay_is_active() && (state_ == State::READY || state_ == State::RUNNING)) {
 501     surf_action_->cancel();
 502   }
 503 }
 504
 505 /** @brief This is part of the cleanup process, probably an internal command */
 506 void CommImpl::cleanup_surf()
 507 {
 508   clean_action();
 509
 510   if (src_timeout_) {
 511     src_timeout_->unref();
 512     src_timeout_ = nullptr;
 513   }
 514
 515   if (dst_timeout_) {
 516     dst_timeout_->unref();
 517     dst_timeout_ = nullptr;
 518   }
 519 }
 520
 521 void CommImpl::post()
 522 {
 523   /* Update synchro state */
 524   if (src_timeout_ && src_timeout_->get_state() == resource::Action::State::FINISHED)
 525     state_ = State::SRC_TIMEOUT;
 526   else if (dst_timeout_ && dst_timeout_->get_state() == resource::Action::State::FINISHED)
 527     state_ = State::DST_TIMEOUT;
 528   else if (src_timeout_ && src_timeout_->get_state() == resource::Action::State::FAILED)
 529     state_ = State::SRC_HOST_FAILURE;
 530   else if (dst_timeout_ && dst_timeout_->get_state() == resource::Action::State::FAILED)
 531     state_ = State::DST_HOST_FAILURE;
 532   else if (surf_action_ && surf_action_->get_state() == resource::Action::State::FAILED) {
 533     state_ = State::LINK_FAILURE;
 534   } else
 535     state_ = State::DONE;
 536
 537   XBT_DEBUG("CommImpl::post(): comm %p, state %s, src_proc %p, dst_proc %p, detached: %d", this, get_state_str(),
 538             src_actor_.get(), dst_actor_.get(), detached_);
 539
 540   /* destroy the surf actions associated with the Simix communication */
 541   cleanup_surf();
 542
 543   /* Answer all simcalls associated with the synchro */
 544   finish();
 545 }
 546
 547 void CommImpl::finish()
 548 {
 549   XBT_DEBUG("CommImpl::finish() in state %s", to_c_str(state_));
 550
 551   /* If the synchro is still in a rendez-vous point then remove from it */
 552   if (mbox_)
 553     mbox_->remove(this);
 554
 555   if (state_ == State::DONE)
 556     copy_data();
 557
 558   while (not simcalls_.empty()) {
 559     smx_simcall_t simcall = simcalls_.front();
 560     simcalls_.pop_front();
 561
 562     /* If a waitany simcall is waiting for this synchro to finish, then remove it from the other synchros in the waitany
 563      * list. Afterwards, get the position of the actual synchro in the waitany list and return it as the result of the
 564      * simcall */
 565
 566     if (simcall->call_ == simix::Simcall::NONE) // FIXME: maybe a better way to handle this case
 567       continue;                                 // if actor handling comm is killed
 568     if (simcall->call_ == simix::Simcall::COMM_WAITANY) {
 569       SIMIX_waitany_remove_simcall_from_actions(simcall);
 570       if (simcall->timeout_cb_) {
 571         simcall->timeout_cb_->remove();
 572         simcall->timeout_cb_ = nullptr;
 573       }
 574       if (not MC_is_active() && not MC_record_replay_is_active()) {
 575         CommImpl** comms   = simcall_comm_waitany__get__comms(simcall);
 576         size_t count       = simcall_comm_waitany__get__count(simcall);
 577         CommImpl** element = std::find(comms, comms + count, this);
 578         int rank           = (element != comms + count) ? element - comms : -1;
 579         simcall_comm_waitany__set__result(simcall, rank);
 580       }
 581     }
 582
 583     /* Check out for errors */
 584
 585     if (not simcall->issuer_->get_host()->is_on()) {
 586       simcall->issuer_->context_->set_wannadie();
 587     } else {
 588       switch (state_) {
 589         case State::SRC_TIMEOUT:
 590           simcall->issuer_->exception_ = std::make_exception_ptr(
 591               simgrid::TimeoutException(XBT_THROW_POINT, "Communication timeouted because of the sender"));
 592           break;
 593
 594         case State::DST_TIMEOUT:
 595           simcall->issuer_->exception_ = std::make_exception_ptr(
 596               simgrid::TimeoutException(XBT_THROW_POINT, "Communication timeouted because of the receiver"));
 597           break;
 598
 599         case State::SRC_HOST_FAILURE:
 600           if (simcall->issuer_ == src_actor_)
 601             simcall->issuer_->context_->set_wannadie();
 602           else
 603             simcall->issuer_->exception_ =
 604                 std::make_exception_ptr(simgrid::NetworkFailureException(XBT_THROW_POINT, "Remote peer failed"));
 605           break;
 606
 607         case State::DST_HOST_FAILURE:
 608           if (simcall->issuer_ == dst_actor_)
 609             simcall->issuer_->context_->set_wannadie();
 610           else
 611             simcall->issuer_->exception_ =
 612                 std::make_exception_ptr(simgrid::NetworkFailureException(XBT_THROW_POINT, "Remote peer failed"));
 613           break;
 614
 615         case State::LINK_FAILURE:
 616           XBT_DEBUG("Link failure in synchro %p between '%s' and '%s': posting an exception to the issuer: %s (%p) "
 617                     "detached:%d",
 618                     this, src_actor_ ? src_actor_->get_host()->get_cname() : nullptr,
 619                     dst_actor_ ? dst_actor_->get_host()->get_cname() : nullptr, simcall->issuer_->get_cname(),
 620                     simcall->issuer_, detached_);
 621           if (src_actor_ == simcall->issuer_) {
 622             XBT_DEBUG("I'm source");
 623           } else if (dst_actor_ == simcall->issuer_) {
 624             XBT_DEBUG("I'm dest");
 625           } else {
 626             XBT_DEBUG("I'm neither source nor dest");
 627           }
 628           simcall->issuer_->throw_exception(
 629               std::make_exception_ptr(simgrid::NetworkFailureException(XBT_THROW_POINT, "Link failure")));
 630           break;
 631
 632         case State::CANCELED:
 633           if (simcall->issuer_ == dst_actor_)
 634             simcall->issuer_->exception_ = std::make_exception_ptr(
 635                 simgrid::CancelException(XBT_THROW_POINT, "Communication canceled by the sender"));
 636           else
 637             simcall->issuer_->exception_ = std::make_exception_ptr(
 638                 simgrid::CancelException(XBT_THROW_POINT, "Communication canceled by the receiver"));
 639           break;
 640
 641         default:
 642           xbt_assert(state_ == State::DONE, "Internal error in CommImpl::finish(): unexpected synchro state %s",
 643                      to_c_str(state_));
 644       }
 645       simcall->issuer_->simcall_answer();
 646     }
 647     /* if there is an exception during a waitany or a testany, indicate the position of the failed communication */
 648     if (simcall->issuer_->exception_ &&
 649         (simcall->call_ == simix::Simcall::COMM_WAITANY || simcall->call_ == simix::Simcall::COMM_TESTANY)) {
 650       // First retrieve the rank of our failing synchro
 651       CommImpl** comms;
 652       size_t count;
 653       if (simcall->call_ == simix::Simcall::COMM_WAITANY) {
 654         comms = simcall_comm_waitany__get__comms(simcall);
 655         count = simcall_comm_waitany__get__count(simcall);
 656       } else {
 657         /* simcall->call_ == simix::Simcall::COMM_TESTANY */
 658         comms = simcall_comm_testany__get__comms(simcall);
 659         count = simcall_comm_testany__get__count(simcall);
 660       }
 661       CommImpl** element = std::find(comms, comms + count, this);
 662       int rank           = (element != comms + count) ? element - comms : -1;
 663       // In order to modify the exception we have to rethrow it:
 664       try {
 665         std::rethrow_exception(simcall->issuer_->exception_);
 666       } catch (simgrid::Exception& e) {
 667         e.set_value(rank);
 668       }
 669     }
 670
 671     simcall->issuer_->waiting_synchro_ = nullptr;
 672     simcall->issuer_->activities_.remove(this);
 673     if (detached_) {
 674       if (simcall->issuer_ != dst_actor_ && dst_actor_ != nullptr)
 675         dst_actor_->activities_.remove(this);
 676       if (simcall->issuer_ != src_actor_ && src_actor_ != nullptr)
 677         src_actor_->activities_.remove(this);
 678     }
 679   }
 680 }
 681
 682 } // namespace activity
 683 } // namespace kernel
 684 } // namespace simgrid