Logo AND Algorithmique Numérique Distribuée

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