src/simix/smx_network.cpp

   1 /* Copyright (c) 2009-2017. 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 <algorithm>
   7
   8 #include <boost/range/algorithm.hpp>
   9
  10 #include <xbt/ex.hpp>
  11
  12 #include "simgrid/s4u/Host.hpp"
  13
  14 #include "mc/mc.h"
  15 #include "simgrid/s4u/Mailbox.hpp"
  16 #include "src/mc/mc_replay.h"
  17 #include "src/simix/smx_private.h"
  18 #include "src/surf/cpu_interface.hpp"
  19 #include "src/surf/surf_interface.hpp"
  20
  21 #include "src/kernel/activity/SynchroComm.hpp"
  22 #include "src/surf/network_interface.hpp"
  23
  24 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_network, simix, "SIMIX network-related synchronization");
  25
  26 static void SIMIX_waitany_remove_simcall_from_actions(smx_simcall_t simcall);
  27 static void SIMIX_comm_copy_data(smx_activity_t comm);
  28 static void SIMIX_comm_start(smx_activity_t synchro);
  29 static simgrid::kernel::activity::Comm*
  30 _find_matching_comm(boost::circular_buffer_space_optimized<smx_activity_t>* deque, e_smx_comm_type_t type,
  31                     int (*match_fun)(void*, void*, smx_activity_t), void* user_data, smx_activity_t my_synchro,
  32                     bool remove_matching);
  33
  34 /**
  35  *  \brief Checks if there is a communication activity queued in a deque matching our needs
  36  *  \param type The type of communication we are looking for (comm_send, comm_recv)
  37  *  \return The communication activity if found, nullptr otherwise
  38  */
  39 static simgrid::kernel::activity::Comm*
  40 _find_matching_comm(boost::circular_buffer_space_optimized<smx_activity_t>* deque, e_smx_comm_type_t type,
  41                     int (*match_fun)(void*, void*, smx_activity_t), void* this_user_data, smx_activity_t my_synchro,
  42                     bool remove_matching)
  43 {
  44   void* other_user_data = nullptr;
  45
  46   for(auto it = deque->begin(); it != deque->end(); it++){
  47     smx_activity_t synchro = *it;
  48     simgrid::kernel::activity::Comm* comm = static_cast<simgrid::kernel::activity::Comm*>(synchro);
  49
  50     if (comm->type == SIMIX_COMM_SEND) {
  51       other_user_data = comm->src_data;
  52     } else if (comm->type == SIMIX_COMM_RECEIVE) {
  53       other_user_data = comm->dst_data;
  54     }
  55     if (comm->type == type && (!match_fun || match_fun(this_user_data, other_user_data, synchro)) &&
  56         (not comm->match_fun || comm->match_fun(other_user_data, this_user_data, my_synchro))) {
  57       XBT_DEBUG("Found a matching communication synchro %p", comm);
  58       if (remove_matching)
  59         deque->erase(it);
  60       comm = static_cast<simgrid::kernel::activity::Comm*>(SIMIX_comm_ref(comm));
  61 #if SIMGRID_HAVE_MC
  62       comm->mbox_cpy = comm->mbox;
  63 #endif
  64       comm->mbox = nullptr;
  65       return comm;
  66     }
  67     XBT_DEBUG("Sorry, communication synchro %p does not match our needs:"
  68               " its type is %d but we are looking for a comm of type %d (or maybe the filtering didn't match)",
  69               comm, (int)comm->type, (int)type);
  70   }
  71   XBT_DEBUG("No matching communication synchro found");
  72   return nullptr;
  73 }
  74
  75 /******************************************************************************/
  76 /*                          Communication synchros                            */
  77 /******************************************************************************/
  78 XBT_PRIVATE void simcall_HANDLER_comm_send(smx_simcall_t simcall, smx_actor_t src, smx_mailbox_t mbox,
  79                                   double task_size, double rate,
  80                                   void *src_buff, size_t src_buff_size,
  81                                   int (*match_fun)(void *, void *,smx_activity_t),
  82                                   void (*copy_data_fun)(smx_activity_t, void*, size_t),
  83           void *data, double timeout){
  84   smx_activity_t comm = simcall_HANDLER_comm_isend(simcall, src, mbox, task_size, rate,
  85                            src_buff, src_buff_size, match_fun, nullptr, copy_data_fun,
  86                data, 0);
  87   SIMCALL_SET_MC_VALUE(simcall, 0);
  88   simcall_HANDLER_comm_wait(simcall, comm, timeout);
  89 }
  90 XBT_PRIVATE smx_activity_t simcall_HANDLER_comm_isend(smx_simcall_t simcall, smx_actor_t src_proc, smx_mailbox_t mbox,
  91                                   double task_size, double rate,
  92                                   void *src_buff, size_t src_buff_size,
  93                                   int (*match_fun)(void *, void *,smx_activity_t),
  94                                   void (*clean_fun)(void *), // used to free the synchro in case of problem after a detached send
  95                                   void (*copy_data_fun)(smx_activity_t, void*, size_t),// used to copy data if not default one
  96                           void *data, int detached)
  97 {
  98   XBT_DEBUG("send from %p", mbox);
  99
 100   /* Prepare a synchro describing us, so that it gets passed to the user-provided filter of other side */
 101   simgrid::kernel::activity::Comm* this_comm = new simgrid::kernel::activity::Comm(SIMIX_COMM_SEND);
 102
 103   /* Look for communication synchro matching our needs. We also provide a description of
 104    * ourself so that the other side also gets a chance of choosing if it wants to match with us.
 105    *
 106    * If it is not found then push our communication into the rendez-vous point */
 107   simgrid::kernel::activity::Comm* other_comm =
 108       _find_matching_comm(&mbox->comm_queue, SIMIX_COMM_RECEIVE, match_fun, data, this_comm, /*remove_matching*/ true);
 109
 110   if (not other_comm) {
 111     other_comm = this_comm;
 112
 113     if (mbox->permanent_receiver!=nullptr){
 114       //this mailbox is for small messages, which have to be sent right now
 115       other_comm->state   = SIMIX_READY;
 116       other_comm->dst_proc=mbox->permanent_receiver.get();
 117       other_comm          = static_cast<simgrid::kernel::activity::Comm*>(SIMIX_comm_ref(other_comm));
 118       mbox->done_comm_queue.push_back(other_comm);
 119       XBT_DEBUG("pushing a message into the permanent receive list %p, comm %p", mbox, &(other_comm));
 120
 121     }else{
 122       mbox->push(this_comm);
 123     }
 124   } else {
 125     XBT_DEBUG("Receive already pushed");
 126     SIMIX_comm_unref(this_comm);
 127
 128     other_comm->state = SIMIX_READY;
 129     other_comm->type = SIMIX_COMM_READY;
 130
 131   }
 132   src_proc->comms.push_back(other_comm);
 133
 134   if (detached) {
 135     other_comm->detached = true;
 136     other_comm->clean_fun = clean_fun;
 137   } else {
 138     other_comm->clean_fun = nullptr;
 139   }
 140
 141   /* Setup the communication synchro */
 142   other_comm->src_proc = src_proc;
 143   other_comm->task_size = task_size;
 144   other_comm->rate = rate;
 145   other_comm->src_buff = src_buff;
 146   other_comm->src_buff_size = src_buff_size;
 147   other_comm->src_data = data;
 148
 149   other_comm->match_fun = match_fun;
 150   other_comm->copy_data_fun = copy_data_fun;
 151
 152
 153   if (MC_is_active() || MC_record_replay_is_active()) {
 154     other_comm->state = SIMIX_RUNNING;
 155     return (detached ? nullptr : other_comm);
 156   }
 157
 158   SIMIX_comm_start(other_comm);
 159   return (detached ? nullptr : other_comm);
 160 }
 161
 162 XBT_PRIVATE void simcall_HANDLER_comm_recv(smx_simcall_t simcall, smx_actor_t receiver, smx_mailbox_t mbox,
 163                          void *dst_buff, size_t *dst_buff_size,
 164                          int (*match_fun)(void *, void *, smx_activity_t),
 165                          void (*copy_data_fun)(smx_activity_t, void*, size_t),
 166                          void *data, double timeout, double rate)
 167 {
 168   smx_activity_t comm = SIMIX_comm_irecv(receiver, mbox, dst_buff, dst_buff_size, match_fun, copy_data_fun, data, rate);
 169   SIMCALL_SET_MC_VALUE(simcall, 0);
 170   simcall_HANDLER_comm_wait(simcall, comm, timeout);
 171 }
 172
 173 XBT_PRIVATE smx_activity_t simcall_HANDLER_comm_irecv(smx_simcall_t simcall, smx_actor_t receiver, smx_mailbox_t mbox,
 174     void *dst_buff, size_t *dst_buff_size,
 175     int (*match_fun)(void *, void *, smx_activity_t),
 176     void (*copy_data_fun)(smx_activity_t, void*, size_t),
 177     void *data, double rate)
 178 {
 179   return SIMIX_comm_irecv(receiver, mbox, dst_buff, dst_buff_size, match_fun, copy_data_fun, data, rate);
 180 }
 181
 182 smx_activity_t SIMIX_comm_irecv(smx_actor_t dst_proc, smx_mailbox_t mbox, void *dst_buff, size_t *dst_buff_size,
 183     int (*match_fun)(void *, void *, smx_activity_t),
 184     void (*copy_data_fun)(smx_activity_t, void*, size_t), // used to copy data if not default one
 185     void *data, double rate)
 186 {
 187   XBT_DEBUG("recv from %p %p", mbox, &mbox->comm_queue);
 188   simgrid::kernel::activity::Comm* this_synchro = new simgrid::kernel::activity::Comm(SIMIX_COMM_RECEIVE);
 189
 190   simgrid::kernel::activity::Comm* other_comm;
 191   //communication already done, get it inside the list of completed comms
 192   if (mbox->permanent_receiver != nullptr && not mbox->done_comm_queue.empty()) {
 193
 194     XBT_DEBUG("We have a comm that has probably already been received, trying to match it, to skip the communication");
 195     //find a match in the list of already received comms
 196     other_comm = _find_matching_comm(&mbox->done_comm_queue, SIMIX_COMM_SEND, match_fun, data, this_synchro,
 197                                      /*remove_matching*/ true);
 198     //if not found, assume the receiver came first, register it to the mailbox in the classical way
 199     if (not other_comm) {
 200       XBT_DEBUG("We have messages in the permanent receive list, but not the one we are looking for, pushing request into list");
 201       other_comm = this_synchro;
 202       mbox->push(this_synchro);
 203     } else {
 204       if(other_comm->surf_comm && other_comm->remains() < 1e-12) {
 205         XBT_DEBUG("comm %p has been already sent, and is finished, destroy it",other_comm);
 206         other_comm->state = SIMIX_DONE;
 207         other_comm->type = SIMIX_COMM_DONE;
 208         other_comm->mbox = nullptr;
 209       }
 210       SIMIX_comm_unref(other_comm);
 211       SIMIX_comm_unref(this_synchro);
 212     }
 213   } else {
 214     /* Prepare a comm describing us, so that it gets passed to the user-provided filter of other side */
 215
 216     /* Look for communication activity matching our needs. We also provide a description of
 217      * ourself so that the other side also gets a chance of choosing if it wants to match with us.
 218      *
 219      * If it is not found then push our communication into the rendez-vous point */
 220     other_comm = _find_matching_comm(&mbox->comm_queue, SIMIX_COMM_SEND, match_fun, data, this_synchro,
 221                                      /*remove_matching*/ true);
 222
 223     if (not other_comm) {
 224       XBT_DEBUG("Receive pushed first %zu", mbox->comm_queue.size());
 225       other_comm = this_synchro;
 226       mbox->push(this_synchro);
 227     } else {
 228       SIMIX_comm_unref(this_synchro);
 229       other_comm = static_cast<simgrid::kernel::activity::Comm*>(other_comm);
 230
 231       other_comm->state = SIMIX_READY;
 232       other_comm->type = SIMIX_COMM_READY;
 233     }
 234     dst_proc->comms.push_back(other_comm);
 235   }
 236
 237   /* Setup communication synchro */
 238   other_comm->dst_proc = dst_proc;
 239   other_comm->dst_buff = dst_buff;
 240   other_comm->dst_buff_size = dst_buff_size;
 241   other_comm->dst_data = data;
 242
 243   if (rate > -1.0 && (other_comm->rate < 0.0 || rate < other_comm->rate))
 244     other_comm->rate = rate;
 245
 246   other_comm->match_fun = match_fun;
 247   other_comm->copy_data_fun = copy_data_fun;
 248
 249   if (MC_is_active() || MC_record_replay_is_active()) {
 250     other_comm->state = SIMIX_RUNNING;
 251     return other_comm;
 252   }
 253
 254   SIMIX_comm_start(other_comm);
 255   return other_comm;
 256 }
 257
 258 smx_activity_t simcall_HANDLER_comm_iprobe(smx_simcall_t simcall, smx_mailbox_t mbox,
 259                                    int type, int src, int tag,
 260                                    int (*match_fun)(void *, void *, smx_activity_t),
 261                                    void *data){
 262   return SIMIX_comm_iprobe(simcall->issuer, mbox, type, src, tag, match_fun, data);
 263 }
 264
 265 smx_activity_t SIMIX_comm_iprobe(smx_actor_t dst_proc, smx_mailbox_t mbox, int type, int src,
 266                               int tag, int (*match_fun)(void *, void *, smx_activity_t), void *data)
 267 {
 268   XBT_DEBUG("iprobe from %p %p", mbox, &mbox->comm_queue);
 269   simgrid::kernel::activity::Comm* this_comm;
 270   int smx_type;
 271   if(type == 1){
 272     this_comm = new simgrid::kernel::activity::Comm(SIMIX_COMM_SEND);
 273     smx_type = SIMIX_COMM_RECEIVE;
 274   } else{
 275     this_comm = new simgrid::kernel::activity::Comm(SIMIX_COMM_RECEIVE);
 276     smx_type = SIMIX_COMM_SEND;
 277   }
 278   smx_activity_t other_synchro=nullptr;
 279   if (mbox->permanent_receiver != nullptr && not mbox->done_comm_queue.empty()) {
 280     XBT_DEBUG("first check in the permanent recv mailbox, to see if we already got something");
 281     other_synchro = _find_matching_comm(&mbox->done_comm_queue,
 282       (e_smx_comm_type_t) smx_type, match_fun, data, this_comm,/*remove_matching*/false);
 283   }
 284   if (not other_synchro) {
 285     XBT_DEBUG("check if we have more luck in the normal mailbox");
 286     other_synchro = _find_matching_comm(&mbox->comm_queue,
 287       (e_smx_comm_type_t) smx_type, match_fun, data, this_comm,/*remove_matching*/false);
 288   }
 289
 290   if(other_synchro)
 291     SIMIX_comm_unref(other_synchro);
 292
 293   SIMIX_comm_unref(this_comm);
 294   return other_synchro;
 295 }
 296
 297 void simcall_HANDLER_comm_wait(smx_simcall_t simcall, smx_activity_t synchro, double timeout)
 298 {
 299   /* Associate this simcall to the wait synchro */
 300   XBT_DEBUG("simcall_HANDLER_comm_wait, %p", synchro);
 301
 302   synchro->simcalls.push_back(simcall);
 303   simcall->issuer->waiting_synchro = synchro;
 304
 305   if (MC_is_active() || MC_record_replay_is_active()) {
 306     int idx = SIMCALL_GET_MC_VALUE(simcall);
 307     if (idx == 0) {
 308       synchro->state = SIMIX_DONE;
 309     } else {
 310       /* If we reached this point, the wait simcall must have a timeout */
 311       /* Otherwise it shouldn't be enabled and executed by the MC */
 312       if (timeout < 0.0)
 313         THROW_IMPOSSIBLE;
 314
 315       simgrid::kernel::activity::Comm *comm = static_cast<simgrid::kernel::activity::Comm*>(synchro);
 316       if (comm->src_proc == simcall->issuer)
 317         comm->state = SIMIX_SRC_TIMEOUT;
 318       else
 319         comm->state = SIMIX_DST_TIMEOUT;
 320     }
 321
 322     SIMIX_comm_finish(synchro);
 323     return;
 324   }
 325
 326   /* If the synchro has already finish perform the error handling, */
 327   /* otherwise set up a waiting timeout on the right side          */
 328   if (synchro->state != SIMIX_WAITING && synchro->state != SIMIX_RUNNING) {
 329     SIMIX_comm_finish(synchro);
 330   } else { /* if (timeout >= 0) { we need a surf sleep action even when there is no timeout, otherwise surf won't tell us when the host fails */
 331     surf_action_t sleep = simcall->issuer->host->pimpl_cpu->sleep(timeout);
 332     sleep->setData(synchro);
 333
 334     simgrid::kernel::activity::Comm *comm = static_cast<simgrid::kernel::activity::Comm*>(synchro);
 335     if (simcall->issuer == comm->src_proc)
 336       comm->src_timeout = sleep;
 337     else
 338       comm->dst_timeout = sleep;
 339   }
 340 }
 341
 342 void simcall_HANDLER_comm_test(smx_simcall_t simcall, smx_activity_t synchro)
 343 {
 344   simgrid::kernel::activity::Comm *comm = static_cast<simgrid::kernel::activity::Comm*>(synchro);
 345
 346   if (MC_is_active() || MC_record_replay_is_active()){
 347     simcall_comm_test__set__result(simcall, comm->src_proc && comm->dst_proc);
 348     if (simcall_comm_test__get__result(simcall)){
 349       synchro->state = SIMIX_DONE;
 350       synchro->simcalls.push_back(simcall);
 351       SIMIX_comm_finish(synchro);
 352     } else {
 353       SIMIX_simcall_answer(simcall);
 354     }
 355     return;
 356   }
 357
 358   simcall_comm_test__set__result(simcall, (synchro->state != SIMIX_WAITING && synchro->state != SIMIX_RUNNING));
 359   if (simcall_comm_test__get__result(simcall)) {
 360     synchro->simcalls.push_back(simcall);
 361     SIMIX_comm_finish(synchro);
 362   } else {
 363     SIMIX_simcall_answer(simcall);
 364   }
 365 }
 366
 367 void simcall_HANDLER_comm_testany(
 368   smx_simcall_t simcall, simgrid::kernel::activity::ActivityImpl* comms[], size_t count)
 369 {
 370   // The default result is -1 -- this means, "nothing is ready".
 371   // It can be changed below, but only if something matches.
 372   simcall_comm_testany__set__result(simcall, -1);
 373
 374   if (MC_is_active() || MC_record_replay_is_active()){
 375     int idx = SIMCALL_GET_MC_VALUE(simcall);
 376     if(idx == -1){
 377       SIMIX_simcall_answer(simcall);
 378     }else{
 379       simgrid::kernel::activity::ActivityImpl* synchro = comms[idx];
 380       simcall_comm_testany__set__result(simcall, idx);
 381       synchro->simcalls.push_back(simcall);
 382       synchro->state = SIMIX_DONE;
 383       SIMIX_comm_finish(synchro);
 384     }
 385     return;
 386   }
 387
 388   for (std::size_t i = 0; i != count; ++i) {
 389     simgrid::kernel::activity::ActivityImpl* synchro = comms[i];
 390     if (synchro->state != SIMIX_WAITING && synchro->state != SIMIX_RUNNING) {
 391       simcall_comm_testany__set__result(simcall, i);
 392       synchro->simcalls.push_back(simcall);
 393       SIMIX_comm_finish(synchro);
 394       return;
 395     }
 396   }
 397   SIMIX_simcall_answer(simcall);
 398 }
 399
 400 void simcall_HANDLER_comm_waitany(smx_simcall_t simcall, xbt_dynar_t synchros, double timeout)
 401 {
 402   smx_activity_t synchro;
 403   unsigned int cursor = 0;
 404
 405   if (MC_is_active() || MC_record_replay_is_active()){
 406     if (timeout > 0.0)
 407       xbt_die("Timeout not implemented for waitany in the model-checker");
 408     int idx = SIMCALL_GET_MC_VALUE(simcall);
 409     synchro = xbt_dynar_get_as(synchros, idx, smx_activity_t);
 410     synchro->simcalls.push_back(simcall);
 411     simcall_comm_waitany__set__result(simcall, idx);
 412     synchro->state = SIMIX_DONE;
 413     SIMIX_comm_finish(synchro);
 414     return;
 415   }
 416
 417   if (timeout < 0.0){
 418     simcall->timer = NULL;
 419   } else {
 420     simcall->timer = SIMIX_timer_set(SIMIX_get_clock() + timeout, [simcall]() {
 421       SIMIX_waitany_remove_simcall_from_actions(simcall);
 422       simcall_comm_waitany__set__result(simcall, -1);
 423       SIMIX_simcall_answer(simcall);
 424     });
 425   }
 426
 427   xbt_dynar_foreach(synchros, cursor, synchro){
 428     /* associate this simcall to the the synchro */
 429     synchro->simcalls.push_back(simcall);
 430
 431     /* see if the synchro is already finished */
 432     if (synchro->state != SIMIX_WAITING && synchro->state != SIMIX_RUNNING){
 433       SIMIX_comm_finish(synchro);
 434       break;
 435     }
 436   }
 437 }
 438
 439 void SIMIX_waitany_remove_simcall_from_actions(smx_simcall_t simcall)
 440 {
 441   smx_activity_t synchro;
 442   unsigned int cursor = 0;
 443   xbt_dynar_t synchros = simcall_comm_waitany__get__comms(simcall);
 444
 445   xbt_dynar_foreach(synchros, cursor, synchro) {
 446     // Remove the first occurence of simcall:
 447     auto i = boost::range::find(synchro->simcalls, simcall);
 448     if (i !=  synchro->simcalls.end())
 449       synchro->simcalls.erase(i);
 450   }
 451 }
 452
 453 /**
 454  *  \brief Starts the simulation of a communication synchro.
 455  *  \param synchro the communication synchro
 456  */
 457 static inline void SIMIX_comm_start(smx_activity_t synchro)
 458 {
 459   simgrid::kernel::activity::Comm *comm = static_cast<simgrid::kernel::activity::Comm*>(synchro);
 460
 461   /* If both the sender and the receiver are already there, start the communication */
 462   if (synchro->state == SIMIX_READY) {
 463
 464     simgrid::s4u::Host* sender   = comm->src_proc->host;
 465     simgrid::s4u::Host* receiver = comm->dst_proc->host;
 466
 467     XBT_DEBUG("Starting communication %p from '%s' to '%s'", synchro, sender->cname(), receiver->cname());
 468
 469     comm->surf_comm = surf_network_model->communicate(sender, receiver, comm->task_size, comm->rate);
 470     comm->surf_comm->setData(synchro);
 471     comm->state = SIMIX_RUNNING;
 472
 473     /* If a link is failed, detect it immediately */
 474     if (comm->surf_comm->getState() == simgrid::surf::Action::State::failed) {
 475       XBT_DEBUG("Communication from '%s' to '%s' failed to start because of a link failure", sender->cname(),
 476                 receiver->cname());
 477       comm->state = SIMIX_LINK_FAILURE;
 478       comm->cleanupSurf();
 479     }
 480
 481     /* If any of the process is suspend, create the synchro but stop its execution,
 482        it will be restarted when the sender process resume */
 483     if (SIMIX_process_is_suspended(comm->src_proc) || SIMIX_process_is_suspended(comm->dst_proc)) {
 484       if (SIMIX_process_is_suspended(comm->src_proc))
 485         XBT_DEBUG("The communication is suspended on startup because src (%s@%s) was suspended since it initiated the "
 486                   "communication",
 487                   comm->src_proc->cname(), comm->src_proc->host->cname());
 488       else
 489         XBT_DEBUG("The communication is suspended on startup because dst (%s@%s) was suspended since it initiated the "
 490                   "communication",
 491                   comm->dst_proc->cname(), comm->dst_proc->host->cname());
 492
 493       comm->surf_comm->suspend();
 494     }
 495   }
 496 }
 497
 498 /**
 499  * \brief Answers the SIMIX simcalls associated to a communication synchro.
 500  * \param synchro a finished communication synchro
 501  */
 502 void SIMIX_comm_finish(smx_activity_t synchro)
 503 {
 504   simgrid::kernel::activity::Comm *comm = static_cast<simgrid::kernel::activity::Comm*>(synchro);
 505
 506   while (not synchro->simcalls.empty()) {
 507     smx_simcall_t simcall = synchro->simcalls.front();
 508     synchro->simcalls.pop_front();
 509
 510     /* If a waitany simcall is waiting for this synchro to finish, then remove it from the other synchros in the waitany
 511      * list. Afterwards, get the position of the actual synchro in the waitany dynar and return it as the result of the
 512      * simcall */
 513
 514     if (simcall->call == SIMCALL_NONE) //FIXME: maybe a better way to handle this case
 515       continue; // if process handling comm is killed
 516     if (simcall->call == SIMCALL_COMM_WAITANY) {
 517       SIMIX_waitany_remove_simcall_from_actions(simcall);
 518       if (simcall->timer) {
 519         SIMIX_timer_remove(simcall->timer);
 520         simcall->timer = nullptr;
 521       }
 522       if (not MC_is_active() && not MC_record_replay_is_active())
 523         simcall_comm_waitany__set__result(simcall,
 524                                           xbt_dynar_search(simcall_comm_waitany__get__comms(simcall), &synchro));
 525     }
 526
 527     /* If the synchro is still in a rendez-vous point then remove from it */
 528     if (comm->mbox)
 529       comm->mbox->remove(synchro);
 530
 531     XBT_DEBUG("SIMIX_comm_finish: synchro state = %d", (int)synchro->state);
 532
 533     /* Check out for errors */
 534
 535     if (simcall->issuer->host->isOff()) {
 536       simcall->issuer->context->iwannadie = 1;
 537       SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
 538     } else {
 539       switch (synchro->state) {
 540
 541       case SIMIX_DONE:
 542         XBT_DEBUG("Communication %p complete!", synchro);
 543         SIMIX_comm_copy_data(synchro);
 544         break;
 545
 546       case SIMIX_SRC_TIMEOUT:
 547         SMX_EXCEPTION(simcall->issuer, timeout_error, 0, "Communication timeouted because of sender");
 548         break;
 549
 550       case SIMIX_DST_TIMEOUT:
 551         SMX_EXCEPTION(simcall->issuer, timeout_error, 0, "Communication timeouted because of receiver");
 552         break;
 553
 554       case SIMIX_SRC_HOST_FAILURE:
 555         if (simcall->issuer == comm->src_proc)
 556           simcall->issuer->context->iwannadie = 1;
 557   //          SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
 558         else
 559           SMX_EXCEPTION(simcall->issuer, network_error, 0, "Remote peer failed");
 560         break;
 561
 562       case SIMIX_DST_HOST_FAILURE:
 563         if (simcall->issuer == comm->dst_proc)
 564           simcall->issuer->context->iwannadie = 1;
 565   //          SMX_EXCEPTION(simcall->issuer, host_error, 0, "Host failed");
 566         else
 567           SMX_EXCEPTION(simcall->issuer, network_error, 0, "Remote peer failed");
 568         break;
 569
 570       case SIMIX_LINK_FAILURE:
 571
 572         XBT_DEBUG(
 573             "Link failure in synchro %p between '%s' and '%s': posting an exception to the issuer: %s (%p) detached:%d",
 574             synchro, comm->src_proc ? comm->src_proc->host->cname() : nullptr,
 575             comm->dst_proc ? comm->dst_proc->host->cname() : nullptr, simcall->issuer->cname(), simcall->issuer,
 576             comm->detached);
 577         if (comm->src_proc == simcall->issuer) {
 578           XBT_DEBUG("I'm source");
 579         } else if (comm->dst_proc == simcall->issuer) {
 580           XBT_DEBUG("I'm dest");
 581         } else {
 582           XBT_DEBUG("I'm neither source nor dest");
 583         }
 584         SMX_EXCEPTION(simcall->issuer, network_error, 0, "Link failure");
 585         break;
 586
 587       case SIMIX_CANCELED:
 588         if (simcall->issuer == comm->dst_proc)
 589           SMX_EXCEPTION(simcall->issuer, cancel_error, 0, "Communication canceled by the sender");
 590         else
 591           SMX_EXCEPTION(simcall->issuer, cancel_error, 0, "Communication canceled by the receiver");
 592         break;
 593
 594       default:
 595         xbt_die("Unexpected synchro state in SIMIX_comm_finish: %d", (int)synchro->state);
 596       }
 597     }
 598
 599     /* if there is an exception during a waitany or a testany, indicate the position of the failed communication */
 600     if (simcall->issuer->exception) {
 601       // In order to modify the exception we have to rethrow it:
 602       try {
 603         std::rethrow_exception(simcall->issuer->exception);
 604       }
 605       catch(xbt_ex& e) {
 606         if (simcall->call == SIMCALL_COMM_WAITANY) {
 607           e.value = xbt_dynar_search(simcall_comm_waitany__get__comms(simcall), &synchro);
 608         }
 609         else if (simcall->call == SIMCALL_COMM_TESTANY) {
 610           e.value = -1;
 611           auto comms = simcall_comm_testany__get__comms(simcall);
 612           auto count = simcall_comm_testany__get__count(simcall);
 613           auto element = std::find(comms, comms + count, synchro);
 614           if (element == comms + count)
 615             e.value = -1;
 616           else
 617             e.value = element - comms;
 618         }
 619         simcall->issuer->exception = std::make_exception_ptr(e);
 620       }
 621       catch(...) {
 622         // Nothing to do
 623       }
 624     }
 625
 626     if (simcall->issuer->host->isOff()) {
 627       simcall->issuer->context->iwannadie = 1;
 628     }
 629
 630     simcall->issuer->waiting_synchro = nullptr;
 631     simcall->issuer->comms.remove(synchro);
 632     if(comm->detached){
 633       if(simcall->issuer == comm->src_proc){
 634         if(comm->dst_proc)
 635           comm->dst_proc->comms.remove(synchro);
 636       }
 637       else if(simcall->issuer == comm->dst_proc){
 638         if(comm->src_proc)
 639           comm->src_proc->comms.remove(synchro);
 640       }
 641       else{
 642         comm->dst_proc->comms.remove(synchro);
 643         comm->src_proc->comms.remove(synchro);
 644       }
 645     }
 646
 647     SIMIX_simcall_answer(simcall);
 648   }
 649 }
 650
 651 /******************************************************************************/
 652 /*                    SIMIX_comm_copy_data callbacks                       */
 653 /******************************************************************************/
 654 static void (*SIMIX_comm_copy_data_callback) (smx_activity_t, void*, size_t) = &SIMIX_comm_copy_pointer_callback;
 655
 656 void SIMIX_comm_set_copy_data_callback(void (*callback) (smx_activity_t, void*, size_t))
 657 {
 658   SIMIX_comm_copy_data_callback = callback;
 659 }
 660
 661 void SIMIX_comm_copy_pointer_callback(smx_activity_t synchro, void* buff, size_t buff_size)
 662 {
 663   simgrid::kernel::activity::Comm *comm = static_cast<simgrid::kernel::activity::Comm*>(synchro);
 664
 665   xbt_assert((buff_size == sizeof(void *)), "Cannot copy %zu bytes: must be sizeof(void*)", buff_size);
 666   *(void **) (comm->dst_buff) = buff;
 667 }
 668
 669 void SIMIX_comm_copy_buffer_callback(smx_activity_t synchro, void* buff, size_t buff_size)
 670 {
 671   simgrid::kernel::activity::Comm *comm = static_cast<simgrid::kernel::activity::Comm*>(synchro);
 672
 673   XBT_DEBUG("Copy the data over");
 674   memcpy(comm->dst_buff, buff, buff_size);
 675   if (comm->detached) { // if this is a detached send, the source buffer was duplicated by SMPI sender to make the original buffer available to the application ASAP
 676     xbt_free(buff);
 677     comm->src_buff = nullptr;
 678   }
 679 }
 680
 681 /**
 682  *  @brief Copy the communication data from the sender's buffer to the receiver's one
 683  *  @param synchro The communication
 684  */
 685 void SIMIX_comm_copy_data(smx_activity_t synchro)
 686 {
 687   simgrid::kernel::activity::Comm *comm = static_cast<simgrid::kernel::activity::Comm*>(synchro);
 688
 689   size_t buff_size = comm->src_buff_size;
 690   /* If there is no data to copy then return */
 691   if (not comm->src_buff || not comm->dst_buff || comm->copied)
 692     return;
 693
 694   XBT_DEBUG("Copying comm %p data from %s (%p) -> %s (%p) (%zu bytes)", comm,
 695             comm->src_proc ? comm->src_proc->host->cname() : "a finished process", comm->src_buff,
 696             comm->dst_proc ? comm->dst_proc->host->cname() : "a finished process", comm->dst_buff, buff_size);
 697
 698   /* Copy at most dst_buff_size bytes of the message to receiver's buffer */
 699   if (comm->dst_buff_size)
 700     buff_size = MIN(buff_size, *(comm->dst_buff_size));
 701
 702   /* Update the receiver's buffer size to the copied amount */
 703   if (comm->dst_buff_size)
 704     *comm->dst_buff_size = buff_size;
 705
 706   if (buff_size > 0){
 707       if(comm->copy_data_fun)
 708         comm->copy_data_fun (comm, comm->src_buff, buff_size);
 709       else
 710         SIMIX_comm_copy_data_callback (comm, comm->src_buff, buff_size);
 711   }
 712
 713   /* Set the copied flag so we copy data only once */
 714   /* (this function might be called from both communication ends) */
 715   comm->copied = 1;
 716 }
 717
 718 /** Increase the refcount for this comm */
 719 smx_activity_t SIMIX_comm_ref(smx_activity_t comm)
 720 {
 721   if (comm != nullptr)
 722     intrusive_ptr_add_ref(comm);
 723   return comm;
 724 }
 725
 726 /** Decrease the refcount for this comm */
 727 void SIMIX_comm_unref(smx_activity_t comm)
 728 {
 729   if (comm != nullptr)
 730     intrusive_ptr_release(comm);
 731 }