Logo AND Algorithmique Numérique Distribuée

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