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