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   comm->wait_for(simcall->issuer_, 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   comm->wait_for(simcall->issuer_, 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   comm->wait_for(simcall->issuer_, timeout);
 186 }
 187
 188 bool simcall_HANDLER_comm_test(smx_simcall_t, simgrid::kernel::activity::CommImpl* comm)
 189 {
 190   return comm->test();
 191 }
 192
 193 int simcall_HANDLER_comm_testany(smx_simcall_t simcall, simgrid::kernel::activity::CommImpl* comms[], size_t count)
 194 {
 195   std::vector<simgrid::kernel::activity::CommImpl*> comms_vec(comms, comms + count);
 196   return simgrid::kernel::activity::CommImpl::test_any(simcall->issuer_, comms_vec);
 197 }
 198
 199 void simcall_HANDLER_comm_waitany(smx_simcall_t simcall, simgrid::kernel::activity::CommImpl* comms[], size_t count,
 200                                   double timeout)
 201 {
 202   std::vector<simgrid::kernel::activity::CommImpl*> comms_vec(comms, comms + count);
 203   simgrid::kernel::activity::CommImpl::wait_any_for(simcall->issuer_, comms_vec, timeout);
 204 }
 205
 206 /******************************************************************************/
 207 /*                    SIMIX_comm_copy_data callbacks                       */
 208 /******************************************************************************/
 209 void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*, size_t))
 210 {
 211   simgrid::kernel::activity::CommImpl::set_copy_data_callback(callback);
 212 }
 213
 214 void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
 215 {
 216   XBT_DEBUG("Copy the data over");
 217   memcpy(comm->dst_buff_, buff, buff_size);
 218   if (comm->detached()) { // if this is a detached send, the source buffer was duplicated by SMPI sender to make the
 219                           // original buffer available to the application ASAP
 220     xbt_free(buff);
 221     comm->src_buff_ = nullptr;
 222   }
 223 }
 224
 225 void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
 226 {
 227   xbt_assert((buff_size == sizeof(void*)), "Cannot copy %zu bytes: must be sizeof(void*)", buff_size);
 228   *(void**)(comm->dst_buff_) = buff;
 229 }
 230
 231 namespace simgrid {
 232 namespace kernel {
 233 namespace activity {
 234
 235 void (*CommImpl::copy_data_callback_)(CommImpl*, void*, size_t) = &SIMIX_comm_copy_pointer_callback;
 236
 237 void CommImpl::set_copy_data_callback(void (*callback)(CommImpl*, void*, size_t))
 238 {
 239   copy_data_callback_ = callback;
 240 }
 241
 242 CommImpl& CommImpl::set_size(double size)
 243 {
 244   size_ = size;
 245   return *this;
 246 }
 247
 248 CommImpl& CommImpl::set_rate(double rate)
 249 {
 250   rate_ = rate;
 251   return *this;
 252 }
 253 CommImpl& CommImpl::set_mailbox(MailboxImpl* mbox)
 254 {
 255   mbox_ = mbox;
 256   return *this;
 257 }
 258
 259 CommImpl& CommImpl::set_src_buff(unsigned char* buff, size_t size)
 260 {
 261   src_buff_      = buff;
 262   src_buff_size_ = size;
 263   return *this;
 264 }
 265
 266 CommImpl& CommImpl::set_dst_buff(unsigned char* buff, size_t* size)
 267 {
 268   dst_buff_      = buff;
 269   dst_buff_size_ = size;
 270   return *this;
 271 }
 272
 273 CommImpl& CommImpl::detach()
 274 {
 275   detached_ = true;
 276   return *this;
 277 }
 278
 279 CommImpl::CommImpl(s4u::Host* from, s4u::Host* to, double bytes) : size_(bytes), detached_(true), from_(from), to_(to)
 280 {
 281   state_ = State::READY;
 282 }
 283
 284 CommImpl::~CommImpl()
 285 {
 286   XBT_DEBUG("Really free communication %p in state %s (detached = %d)", this, get_state_str(), detached_);
 287
 288   cleanup_surf();
 289
 290   if (detached_ && state_ != State::DONE) {
 291     /* the communication has failed and was detached:
 292      * we have to free the buffer */
 293     if (clean_fun)
 294       clean_fun(src_buff_);
 295     src_buff_ = nullptr;
 296   } else if (mbox_) {
 297     mbox_->remove(this);
 298   }
 299 }
 300
 301 /**  @brief Starts the simulation of a communication synchro. */
 302 CommImpl* CommImpl::start()
 303 {
 304   /* If both the sender and the receiver are already there, start the communication */
 305   if (state_ == State::READY) {
 306     from_ = from_ != nullptr ? from_ : src_actor_->get_host();
 307     to_   = to_ != nullptr ? to_ : dst_actor_->get_host();
 308
 309     /* FIXME[donassolo]: getting the network_model from the origin host
 310      * Soon we need to change this function to first get the routes and later
 311      * create the respective surf actions */
 312     auto net_model = from_->get_netpoint()->get_englobing_zone()->get_network_model();
 313
 314     surf_action_ = net_model->communicate(from_, to_, size_, rate_);
 315     surf_action_->set_activity(this);
 316     surf_action_->set_category(get_tracing_category());
 317     state_ = State::RUNNING;
 318
 319     XBT_DEBUG("Starting communication %p from '%s' to '%s' (surf_action: %p; state: %s)", this, from_->get_cname(),
 320               to_->get_cname(), surf_action_, get_state_str());
 321
 322     /* If a link is failed, detect it immediately */
 323     if (surf_action_->get_state() == resource::Action::State::FAILED) {
 324       XBT_DEBUG("Communication from '%s' to '%s' failed to start because of a link failure", from_->get_cname(),
 325                 to_->get_cname());
 326       state_ = State::LINK_FAILURE;
 327       post();
 328
 329     } else if ((src_actor_ != nullptr && src_actor_->is_suspended()) ||
 330                (dst_actor_ != nullptr && dst_actor_->is_suspended())) {
 331       /* If any of the process is suspended, create the synchro but stop its execution,
 332          it will be restarted when the sender process resume */
 333       if (src_actor_->is_suspended())
 334         XBT_DEBUG("The communication is suspended on startup because src (%s@%s) was suspended since it initiated the "
 335                   "communication",
 336                   src_actor_->get_cname(), src_actor_->get_host()->get_cname());
 337       else
 338         XBT_DEBUG("The communication is suspended on startup because dst (%s@%s) was suspended since it initiated the "
 339                   "communication",
 340                   dst_actor_->get_cname(), dst_actor_->get_host()->get_cname());
 341
 342       surf_action_->suspend();
 343     }
 344   }
 345
 346   return this;
 347 }
 348
 349 /** @brief Copy the communication data from the sender's buffer to the receiver's one  */
 350 void CommImpl::copy_data()
 351 {
 352   size_t buff_size = src_buff_size_;
 353   /* If there is no data to copy then return */
 354   if (not src_buff_ || not dst_buff_ || copied_)
 355     return;
 356
 357   XBT_DEBUG("Copying comm %p data from %s (%p) -> %s (%p) (%zu bytes)", this,
 358             src_actor_ ? src_actor_->get_host()->get_cname() : "a finished process", src_buff_,
 359             dst_actor_ ? dst_actor_->get_host()->get_cname() : "a finished process", dst_buff_, buff_size);
 360
 361   /* Copy at most dst_buff_size bytes of the message to receiver's buffer */
 362   if (dst_buff_size_) {
 363     buff_size = std::min(buff_size, *dst_buff_size_);
 364
 365     /* Update the receiver's buffer size to the copied amount */
 366     *dst_buff_size_ = buff_size;
 367   }
 368
 369   if (buff_size > 0) {
 370     if (copy_data_fun)
 371       copy_data_fun(this, src_buff_, buff_size);
 372     else
 373       copy_data_callback_(this, src_buff_, buff_size);
 374   }
 375
 376   /* Set the copied flag so we copy data only once */
 377   /* (this function might be called from both communication ends) */
 378   copied_ = true;
 379 }
 380
 381 bool CommImpl::test()
 382 {
 383   if ((MC_is_active() || MC_record_replay_is_active()) && src_actor_ && dst_actor_)
 384     state_ = State::DONE;
 385   return ActivityImpl::test();
 386 }
 387
 388 void CommImpl::wait_for(actor::ActorImpl* issuer, double timeout)
 389 {
 390   XBT_DEBUG("CommImpl::wait_for(%g), %p, state %s", timeout, this, to_c_str(state_));
 391
 392   /* Associate this simcall to the wait synchro */
 393   register_simcall(&issuer->simcall_);
 394
 395   if (MC_is_active() || MC_record_replay_is_active()) {
 396     int idx = issuer->simcall_.mc_value_;
 397     if (idx == 0) {
 398       state_ = State::DONE;
 399     } else {
 400       /* If we reached this point, the wait simcall must have a timeout */
 401       /* Otherwise it shouldn't be enabled and executed by the MC */
 402       if (timeout < 0.0)
 403         THROW_IMPOSSIBLE;
 404       state_ = (issuer == src_actor_ ? State::SRC_TIMEOUT : State::DST_TIMEOUT);
 405     }
 406     finish();
 407     return;
 408   }
 409
 410   /* If the synchro has already finish perform the error handling, */
 411   /* otherwise set up a waiting timeout on the right side          */
 412   if (state_ != State::WAITING && state_ != State::RUNNING) {
 413     finish();
 414   } else { /* we need a sleep action (even when there is no timeout) to be notified of host failures */
 415     resource::Action* sleep = issuer->get_host()->pimpl_cpu->sleep(timeout);
 416     sleep->set_activity(this);
 417
 418     if (issuer == src_actor_)
 419       src_timeout_ = sleep;
 420     else
 421       dst_timeout_ = sleep;
 422   }
 423 }
 424
 425 int CommImpl::test_any(const actor::ActorImpl* issuer, const std::vector<CommImpl*>& comms)
 426 {
 427   if (MC_is_active() || MC_record_replay_is_active()) {
 428     int idx = issuer->simcall_.mc_value_;
 429     xbt_assert(idx == -1 || comms[idx]->test());
 430     return idx;
 431   }
 432
 433   for (std::size_t i = 0; i < comms.size(); ++i) {
 434     if (comms[i]->test())
 435       return i;
 436   }
 437   return -1;
 438 }
 439
 440 void CommImpl::wait_any_for(actor::ActorImpl* issuer, const std::vector<CommImpl*>& comms, double timeout)
 441 {
 442   if (MC_is_active() || MC_record_replay_is_active()) {
 443     xbt_assert(timeout <= 0.0, "Timeout not implemented for waitany in the model-checker");
 444     int idx    = issuer->simcall_.mc_value_;
 445     auto* comm = comms[idx];
 446     comm->simcalls_.push_back(&issuer->simcall_);
 447     simcall_comm_waitany__set__result(&issuer->simcall_, idx);
 448     comm->state_ = State::DONE;
 449     comm->finish();
 450     return;
 451   }
 452
 453   if (timeout < 0.0) {
 454     issuer->simcall_.timeout_cb_ = nullptr;
 455   } else {
 456     issuer->simcall_.timeout_cb_ = timer::Timer::set(SIMIX_get_clock() + timeout, [issuer, comms]() {
 457       // FIXME: Vector `comms' is copied here. Use a reference once its lifetime is extended (i.e. when the simcall is
 458       // modernized).
 459       issuer->simcall_.timeout_cb_ = nullptr;
 460       for (auto* comm : comms)
 461         comm->unregister_simcall(&issuer->simcall_);
 462       simcall_comm_waitany__set__result(&issuer->simcall_, -1);
 463       issuer->simcall_answer();
 464     });
 465   }
 466
 467   for (auto* comm : comms) {
 468     /* associate this simcall to the the synchro */
 469     comm->simcalls_.push_back(&issuer->simcall_);
 470
 471     /* see if the synchro is already finished */
 472     if (comm->state_ != State::WAITING && comm->state_ != State::RUNNING) {
 473       comm->finish();
 474       break;
 475     }
 476   }
 477 }
 478
 479 void CommImpl::suspend()
 480 {
 481   /* FIXME: shall we suspend also the timeout synchro? */
 482   if (surf_action_)
 483     surf_action_->suspend();
 484   /* if not created yet, the action will be suspended on creation, in CommImpl::start() */
 485 }
 486
 487 void CommImpl::resume()
 488 {
 489   /*FIXME: check what happen with the timeouts */
 490   if (surf_action_)
 491     surf_action_->resume();
 492   /* in the other case, the synchro were not really suspended yet, see CommImpl::suspend() and CommImpl::start() */
 493 }
 494
 495 void CommImpl::cancel()
 496 {
 497   /* if the synchro is a waiting state means that it is still in a mbox so remove from it and delete it */
 498   if (state_ == State::WAITING) {
 499     if (not detached_) {
 500       mbox_->remove(this);
 501       state_ = State::CANCELED;
 502     }
 503   } else if (not MC_is_active() /* when running the MC there are no surf actions */
 504              && not MC_record_replay_is_active() && (state_ == State::READY || state_ == State::RUNNING)) {
 505     surf_action_->cancel();
 506   }
 507 }
 508
 509 /** @brief This is part of the cleanup process, probably an internal command */
 510 void CommImpl::cleanup_surf()
 511 {
 512   clean_action();
 513
 514   if (src_timeout_) {
 515     src_timeout_->unref();
 516     src_timeout_ = nullptr;
 517   }
 518
 519   if (dst_timeout_) {
 520     dst_timeout_->unref();
 521     dst_timeout_ = nullptr;
 522   }
 523 }
 524
 525 void CommImpl::post()
 526 {
 527   /* Update synchro state */
 528   if (src_timeout_ && src_timeout_->get_state() == resource::Action::State::FINISHED)
 529     state_ = State::SRC_TIMEOUT;
 530   else if (dst_timeout_ && dst_timeout_->get_state() == resource::Action::State::FINISHED)
 531     state_ = State::DST_TIMEOUT;
 532   else if (src_timeout_ && src_timeout_->get_state() == resource::Action::State::FAILED)
 533     state_ = State::SRC_HOST_FAILURE;
 534   else if (dst_timeout_ && dst_timeout_->get_state() == resource::Action::State::FAILED)
 535     state_ = State::DST_HOST_FAILURE;
 536   else if (surf_action_ && surf_action_->get_state() == resource::Action::State::FAILED) {
 537     state_ = State::LINK_FAILURE;
 538   } else
 539     state_ = State::DONE;
 540
 541   XBT_DEBUG("CommImpl::post(): comm %p, state %s, src_proc %p, dst_proc %p, detached: %d", this, get_state_str(),
 542             src_actor_.get(), dst_actor_.get(), detached_);
 543
 544   /* destroy the surf actions associated with the Simix communication */
 545   cleanup_surf();
 546
 547   /* Answer all simcalls associated with the synchro */
 548   finish();
 549 }
 550
 551 void CommImpl::finish()
 552 {
 553   XBT_DEBUG("CommImpl::finish() in state %s", to_c_str(state_));
 554
 555   /* If the synchro is still in a rendez-vous point then remove from it */
 556   if (mbox_)
 557     mbox_->remove(this);
 558
 559   if (state_ == State::DONE)
 560     copy_data();
 561
 562   while (not simcalls_.empty()) {
 563     smx_simcall_t simcall = simcalls_.front();
 564     simcalls_.pop_front();
 565
 566     /* If a waitany simcall is waiting for this synchro to finish, then remove it from the other synchros in the waitany
 567      * list. Afterwards, get the position of the actual synchro in the waitany list and return it as the result of the
 568      * simcall */
 569
 570     if (simcall->call_ == simix::Simcall::NONE) // FIXME: maybe a better way to handle this case
 571       continue;                                 // if actor handling comm is killed
 572     if (simcall->call_ == simix::Simcall::COMM_WAITANY) {
 573       CommImpl** comms = simcall_comm_waitany__get__comms(simcall);
 574       size_t count     = simcall_comm_waitany__get__count(simcall);
 575       for (size_t i = 0; i < count; i++)
 576         comms[i]->unregister_simcall(simcall);
 577       if (simcall->timeout_cb_) {
 578         simcall->timeout_cb_->remove();
 579         simcall->timeout_cb_ = nullptr;
 580       }
 581       if (not MC_is_active() && not MC_record_replay_is_active()) {
 582         CommImpl** element = std::find(comms, comms + count, this);
 583         int rank           = (element != comms + count) ? element - comms : -1;
 584         simcall_comm_waitany__set__result(simcall, rank);
 585       }
 586     }
 587
 588     /* Check out for errors */
 589
 590     if (not simcall->issuer_->get_host()->is_on()) {
 591       simcall->issuer_->context_->set_wannadie();
 592     } else {
 593       switch (state_) {
 594         case State::SRC_TIMEOUT:
 595           simcall->issuer_->exception_ = std::make_exception_ptr(
 596               TimeoutException(XBT_THROW_POINT, "Communication timeouted because of the sender"));
 597           break;
 598
 599         case State::DST_TIMEOUT:
 600           simcall->issuer_->exception_ = std::make_exception_ptr(
 601               TimeoutException(XBT_THROW_POINT, "Communication timeouted because of the receiver"));
 602           break;
 603
 604         case State::SRC_HOST_FAILURE:
 605           if (simcall->issuer_ == src_actor_)
 606             simcall->issuer_->context_->set_wannadie();
 607           else
 608             simcall->issuer_->exception_ =
 609                 std::make_exception_ptr(NetworkFailureException(XBT_THROW_POINT, "Remote peer failed"));
 610           break;
 611
 612         case State::DST_HOST_FAILURE:
 613           if (simcall->issuer_ == dst_actor_)
 614             simcall->issuer_->context_->set_wannadie();
 615           else
 616             simcall->issuer_->exception_ =
 617                 std::make_exception_ptr(NetworkFailureException(XBT_THROW_POINT, "Remote peer failed"));
 618           break;
 619
 620         case State::LINK_FAILURE:
 621           XBT_DEBUG("Link failure in synchro %p between '%s' and '%s': posting an exception to the issuer: %s (%p) "
 622                     "detached:%d",
 623                     this, src_actor_ ? src_actor_->get_host()->get_cname() : nullptr,
 624                     dst_actor_ ? dst_actor_->get_host()->get_cname() : nullptr, simcall->issuer_->get_cname(),
 625                     simcall->issuer_, detached_);
 626           if (src_actor_ == simcall->issuer_) {
 627             XBT_DEBUG("I'm source");
 628           } else if (dst_actor_ == simcall->issuer_) {
 629             XBT_DEBUG("I'm dest");
 630           } else {
 631             XBT_DEBUG("I'm neither source nor dest");
 632           }
 633           simcall->issuer_->throw_exception(
 634               std::make_exception_ptr(NetworkFailureException(XBT_THROW_POINT, "Link failure")));
 635           break;
 636
 637         case State::CANCELED:
 638           if (simcall->issuer_ == dst_actor_)
 639             simcall->issuer_->exception_ =
 640                 std::make_exception_ptr(CancelException(XBT_THROW_POINT, "Communication canceled by the sender"));
 641           else
 642             simcall->issuer_->exception_ =
 643                 std::make_exception_ptr(CancelException(XBT_THROW_POINT, "Communication canceled by the receiver"));
 644           break;
 645
 646         default:
 647           xbt_assert(state_ == State::DONE, "Internal error in CommImpl::finish(): unexpected synchro state %s",
 648                      to_c_str(state_));
 649       }
 650       simcall->issuer_->simcall_answer();
 651     }
 652     /* if there is an exception during a waitany or a testany, indicate the position of the failed communication */
 653     if (simcall->issuer_->exception_ &&
 654         (simcall->call_ == simix::Simcall::COMM_WAITANY || simcall->call_ == simix::Simcall::COMM_TESTANY)) {
 655       // First retrieve the rank of our failing synchro
 656       CommImpl** comms;
 657       size_t count;
 658       if (simcall->call_ == simix::Simcall::COMM_WAITANY) {
 659         comms = simcall_comm_waitany__get__comms(simcall);
 660         count = simcall_comm_waitany__get__count(simcall);
 661       } else {
 662         /* simcall->call_ == simix::Simcall::COMM_TESTANY */
 663         comms = simcall_comm_testany__get__comms(simcall);
 664         count = simcall_comm_testany__get__count(simcall);
 665       }
 666       CommImpl** element = std::find(comms, comms + count, this);
 667       int rank           = (element != comms + count) ? element - comms : -1;
 668       // In order to modify the exception we have to rethrow it:
 669       try {
 670         std::rethrow_exception(simcall->issuer_->exception_);
 671       } catch (Exception& e) {
 672         e.set_value(rank);
 673       }
 674     }
 675
 676     simcall->issuer_->waiting_synchro_ = nullptr;
 677     simcall->issuer_->activities_.remove(this);
 678     if (detached_) {
 679       if (simcall->issuer_ != dst_actor_ && dst_actor_ != nullptr)
 680         dst_actor_->activities_.remove(this);
 681       if (simcall->issuer_ != src_actor_ && src_actor_ != nullptr)
 682         src_actor_->activities_.remove(this);
 683     }
 684   }
 685 }
 686
 687 } // namespace activity
 688 } // namespace kernel
 689 } // namespace simgrid