src/kernel/activity/CommImpl.cpp

   1 /* Copyright (c) 2007-2022. 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 <simgrid/Exception.hpp>
   7 #include <simgrid/kernel/routing/NetPoint.hpp>
   8 #include <simgrid/modelchecker.h>
   9 #include <simgrid/s4u/Host.hpp>
  10
  11 #define SIMIX_H_NO_DEPRECATED_WARNING // avoid deprecation warning on include (remove with XBT_ATTRIB_DEPRECATED_v333)
  12 #include <simgrid/simix.h>
  13
  14 #include "src/kernel/activity/CommImpl.hpp"
  15 #include "src/kernel/activity/MailboxImpl.hpp"
  16 #include "src/kernel/actor/SimcallObserver.hpp"
  17 #include "src/kernel/resource/CpuImpl.hpp"
  18 #include "src/kernel/resource/NetworkModel.hpp"
  19 #include "src/kernel/resource/StandardLinkImpl.hpp"
  20 #include "src/mc/mc_replay.hpp"
  21
  22 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_network, kernel, "Kernel network-related synchronization");
  23
  24 /******************************************************************************/
  25 /*                    SIMIX_comm_copy_data callbacks                       */
  26 /******************************************************************************/
  27 // XBT_ATTRIB_DEPRECATED_v333
  28 void SIMIX_comm_set_copy_data_callback(void (*callback)(simgrid::kernel::activity::CommImpl*, void*, size_t))
  29 {
  30   simgrid::kernel::activity::CommImpl::set_copy_data_callback(callback);
  31 }
  32
  33 // XBT_ATTRIB_DEPRECATED_v333
  34 void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
  35 {
  36   simgrid::s4u::Comm::copy_buffer_callback(comm, buff, buff_size);
  37 }
  38
  39 // XBT_ATTRIB_DEPRECATED_v333
  40 void SIMIX_comm_copy_pointer_callback(simgrid::kernel::activity::CommImpl* comm, void* buff, size_t buff_size)
  41 {
  42   simgrid::s4u::Comm::copy_pointer_callback(comm, buff, buff_size);
  43 }
  44
  45 namespace simgrid::kernel::activity {
  46 xbt::signal<void(CommImpl const&)> CommImpl::on_start;
  47 xbt::signal<void(CommImpl const&)> CommImpl::on_completion;
  48
  49 std::function<void(CommImpl*, void*, size_t)> CommImpl::copy_data_callback_ = &s4u::Comm::copy_pointer_callback;
  50
  51 void CommImpl::set_copy_data_callback(const std::function<void(CommImpl*, void*, size_t)>& callback)
  52 {
  53   copy_data_callback_ = callback;
  54 }
  55
  56 CommImpl& CommImpl::set_type(CommImplType type)
  57 {
  58   type_ = type;
  59   return *this;
  60 }
  61
  62 CommImpl& CommImpl::set_source(s4u::Host* from)
  63 {
  64   from_ = from;
  65   return *this;
  66 }
  67
  68 CommImpl& CommImpl::set_destination(s4u::Host* to)
  69 {
  70   to_ = to;
  71   return *this;
  72 }
  73
  74 CommImpl& CommImpl::set_size(double size)
  75 {
  76   size_ = size;
  77   return *this;
  78 }
  79
  80 CommImpl& CommImpl::set_rate(double rate)
  81 {
  82   rate_ = rate;
  83   return *this;
  84 }
  85 CommImpl& CommImpl::set_mailbox(MailboxImpl* mbox)
  86 {
  87   if (mbox != nullptr)
  88     mbox_id_ = mbox->get_id();
  89   mbox_ = mbox;
  90   return *this;
  91 }
  92
  93 CommImpl& CommImpl::set_src_buff(unsigned char* buff, size_t size)
  94 {
  95   src_buff_      = buff;
  96   src_buff_size_ = size;
  97   return *this;
  98 }
  99
 100 CommImpl& CommImpl::set_dst_buff(unsigned char* buff, size_t* size)
 101 {
 102   dst_buff_      = buff;
 103   dst_buff_size_ = size;
 104   return *this;
 105 }
 106
 107 CommImpl& CommImpl::detach()
 108 {
 109   detached_ = true;
 110   return *this;
 111 }
 112
 113 CommImpl::~CommImpl()
 114 {
 115   XBT_DEBUG("Really free communication %p in state %s (detached = %d)", this, get_state_str(), detached_);
 116
 117   cleanup_surf();
 118
 119   if (detached_ && get_state() != State::DONE) {
 120     /* the communication has failed and was detached:
 121      * we have to free the buffer */
 122     if (clean_fun)
 123       clean_fun(src_buff_);
 124     src_buff_ = nullptr;
 125   } else if (mbox_) {
 126     mbox_->remove(this);
 127   }
 128 }
 129
 130 /**  @brief Starts the simulation of a communication synchro. */
 131 CommImpl* CommImpl::start()
 132 {
 133   /* If both the sender and the receiver are already there, start the communication */
 134   if (get_state() == State::READY) {
 135     from_ = from_ != nullptr ? from_ : src_actor_->get_host();
 136     xbt_assert(from_->is_on());
 137     to_   = to_ != nullptr ? to_ : dst_actor_->get_host();
 138     xbt_assert(to_->is_on());
 139
 140     /* Getting the network_model from the origin host
 141      * Valid while we have a single network model, otherwise we would need to change this function to first get the
 142      * routes and later create the respective surf actions */
 143     auto net_model = from_->get_netpoint()->get_englobing_zone()->get_network_model();
 144
 145     surf_action_ = net_model->communicate(from_, to_, size_, rate_);
 146     surf_action_->set_activity(this);
 147     surf_action_->set_category(get_tracing_category());
 148     set_start_time(surf_action_->get_start_time());
 149     set_state(State::RUNNING);
 150     on_start(*this);
 151
 152     XBT_DEBUG("Starting communication %p from '%s' to '%s' (surf_action: %p; state: %s)", this, from_->get_cname(),
 153               to_->get_cname(), surf_action_, get_state_str());
 154
 155     /* If a link is failed, detect it immediately */
 156     if (surf_action_->get_state() == resource::Action::State::FAILED) {
 157       XBT_DEBUG("Communication from '%s' to '%s' failed to start because of a link failure", from_->get_cname(),
 158                 to_->get_cname());
 159       set_state(State::LINK_FAILURE);
 160       post();
 161
 162     } else if ((src_actor_ != nullptr && src_actor_->is_suspended()) ||
 163                (dst_actor_ != nullptr && dst_actor_->is_suspended())) {
 164       /* If any of the actor is suspended, create the synchro but stop its execution,
 165          it will be restarted when the sender actor resume */
 166       if (src_actor_->is_suspended())
 167         XBT_DEBUG("The communication is suspended on startup because src (%s@%s) was suspended since it initiated the "
 168                   "communication",
 169                   src_actor_->get_cname(), src_actor_->get_host()->get_cname());
 170       else
 171         XBT_DEBUG("The communication is suspended on startup because dst (%s@%s) was suspended since it initiated the "
 172                   "communication",
 173                   dst_actor_->get_cname(), dst_actor_->get_host()->get_cname());
 174
 175       surf_action_->suspend();
 176     }
 177   }
 178
 179   return this;
 180 }
 181
 182 std::vector<s4u::Link*> CommImpl::get_traversed_links() const
 183 {
 184   xbt_assert(get_state() != State::WAITING, "You cannot use %s() if your communication is not ready (%s)", __FUNCTION__,
 185              get_state_str());
 186   std::vector<s4u::Link*> vlinks;
 187   XBT_ATTRIB_UNUSED double res = 0;
 188   from_->route_to(to_, vlinks, &res);
 189   return vlinks;
 190 }
 191
 192 /** @brief Copy the communication data from the sender's buffer to the receiver's one  */
 193 void CommImpl::copy_data()
 194 {
 195   size_t buff_size = src_buff_size_;
 196   /* If there is no data to copy then return */
 197   if (not src_buff_ || not dst_buff_ || copied_)
 198     return;
 199
 200   XBT_DEBUG("Copying comm %p data from %s (%p) -> %s (%p) (%zu bytes)", this,
 201             src_actor_ ? src_actor_->get_host()->get_cname() : "a finished actor", src_buff_,
 202             dst_actor_ ? dst_actor_->get_host()->get_cname() : "a finished actor", dst_buff_, buff_size);
 203
 204   /* Copy at most dst_buff_size bytes of the message to receiver's buffer */
 205   if (dst_buff_size_) {
 206     buff_size = std::min(buff_size, *dst_buff_size_);
 207
 208     /* Update the receiver's buffer size to the copied amount */
 209     *dst_buff_size_ = buff_size;
 210   }
 211
 212   if (buff_size > 0) {
 213     if (copy_data_fun)
 214       copy_data_fun(this, src_buff_, buff_size);
 215     else
 216       copy_data_callback_(this, src_buff_, buff_size);
 217   }
 218
 219   /* Set the copied flag so we copy data only once */
 220   /* (this function might be called from both communication ends) */
 221   copied_ = true;
 222 }
 223
 224 ActivityImplPtr CommImpl::isend(actor::CommIsendSimcall* observer)
 225 {
 226   auto* mbox = observer->get_mailbox();
 227   XBT_DEBUG("send from mailbox %p", mbox);
 228
 229   /* Prepare a synchro describing us, so that it gets passed to the user-provided filter of other side */
 230   CommImplPtr this_comm(new CommImpl());
 231   this_comm->set_type(CommImplType::SEND);
 232
 233   /* Look for communication synchro matching our needs. We also provide a description of
 234    * ourself so that the other side also gets a chance of choosing if it wants to match with us.
 235    *
 236    * If it is not found then push our communication into the rendez-vous point */
 237   CommImplPtr other_comm =
 238       mbox->find_matching_comm(CommImplType::RECEIVE, observer->get_match_fun(), observer->get_payload(), this_comm,
 239                                /*done*/ false, /*remove_matching*/ true);
 240
 241   if (not other_comm) {
 242     other_comm = std::move(this_comm);
 243
 244     if (mbox->is_permanent()) {
 245       // this mailbox is for small messages, which have to be sent right now
 246       other_comm->set_state(State::READY);
 247       other_comm->dst_actor_ = mbox->get_permanent_receiver().get();
 248       mbox->push_done(other_comm);
 249       XBT_DEBUG("pushing a message into the permanent receive list %p, comm %p", mbox, other_comm.get());
 250
 251     } else {
 252       mbox->push(other_comm);
 253     }
 254   } else {
 255     XBT_DEBUG("Receive already pushed");
 256
 257     other_comm->set_state(State::READY);
 258   }
 259   observer->set_comm(other_comm.get());
 260
 261   if (observer->is_detached()) {
 262     other_comm->detach();
 263     other_comm->clean_fun = observer->get_clean_fun();
 264   } else {
 265     other_comm->clean_fun = nullptr;
 266     observer->get_issuer()->activities_.emplace_back(other_comm);
 267   }
 268
 269   /* Setup the communication synchro */
 270   other_comm->src_actor_ = observer->get_issuer();
 271   other_comm->src_data_  = observer->get_payload();
 272   (*other_comm)
 273       .set_src_buff(observer->get_src_buff(), observer->get_src_buff_size())
 274       .set_size(observer->get_payload_size())
 275       .set_rate(observer->get_rate());
 276
 277   other_comm->match_fun     = observer->get_match_fun();
 278   other_comm->copy_data_fun = observer->get_copy_data_fun();
 279
 280   if (MC_is_active() || MC_record_replay_is_active())
 281     other_comm->set_state(simgrid::kernel::activity::State::RUNNING);
 282   else
 283     other_comm->start();
 284
 285   return (observer->is_detached() ? nullptr : other_comm);
 286 }
 287
 288 ActivityImplPtr CommImpl::irecv(actor::CommIrecvSimcall* observer)
 289 {
 290   CommImplPtr this_synchro(new CommImpl());
 291   this_synchro->set_type(CommImplType::RECEIVE);
 292
 293   auto* mbox = observer->get_mailbox();
 294   XBT_DEBUG("recv from mbox %p. this_synchro=%p", mbox, this_synchro.get());
 295
 296   CommImplPtr other_comm;
 297   // communication already done, get it inside the list of completed comms
 298   if (mbox->is_permanent() && mbox->has_some_done_comm()) {
 299     XBT_DEBUG("We have a comm that has probably already been received, trying to match it, to skip the communication");
 300     // find a match in the list of already received comms
 301     other_comm = mbox->find_matching_comm(CommImplType::SEND, observer->get_match_fun(), observer->get_payload(),
 302                                           this_synchro, /*done*/ true, /*remove_matching*/ true);
 303     // if not found, assume the receiver came first, register it to the mailbox in the classical way
 304     if (not other_comm) {
 305       XBT_DEBUG("We have messages in the permanent receive list, but not the one we are looking for, pushing request "
 306                 "into list");
 307       other_comm = std::move(this_synchro);
 308       mbox->push(other_comm);
 309     } else {
 310       if (other_comm->surf_action_ && other_comm->get_remaining() < 1e-12) {
 311         XBT_DEBUG("comm %p has been already sent, and is finished, destroy it", other_comm.get());
 312         other_comm->set_state(State::DONE);
 313         other_comm->set_mailbox(nullptr);
 314       }
 315     }
 316   } else {
 317     /* Prepare a comm describing us, so that it gets passed to the user-provided filter of other side */
 318
 319     /* Look for communication activity matching our needs. We also provide a description of
 320      * ourself so that the other side also gets a chance of choosing if it wants to match with us.
 321      *
 322      * If it is not found then push our communication into the rendez-vous point */
 323     other_comm = mbox->find_matching_comm(CommImplType::SEND, observer->get_match_fun(), observer->get_payload(),
 324                                           this_synchro, /*done*/ false, /*remove_matching*/ true);
 325
 326     if (other_comm == nullptr) {
 327       XBT_DEBUG("Receive pushed first (%zu comm enqueued so far)", mbox->size());
 328       other_comm = std::move(this_synchro);
 329       mbox->push(other_comm);
 330     } else {
 331       XBT_DEBUG("Match my %p with the existing %p", this_synchro.get(), other_comm.get());
 332
 333       other_comm->set_state(simgrid::kernel::activity::State::READY);
 334     }
 335     observer->get_issuer()->activities_.emplace_back(other_comm);
 336   }
 337   observer->set_comm(other_comm.get());
 338
 339   /* Setup communication synchro */
 340   other_comm->dst_actor_ = observer->get_issuer();
 341   other_comm->dst_data_  = observer->get_payload();
 342   other_comm->set_dst_buff(observer->get_dst_buff(), observer->get_dst_buff_size());
 343
 344   if (observer->get_rate() > -1.0 && (other_comm->get_rate() < 0.0 || observer->get_rate() < other_comm->get_rate()))
 345     other_comm->set_rate(observer->get_rate());
 346
 347   other_comm->match_fun     = observer->get_match_fun();
 348   other_comm->copy_data_fun = observer->get_copy_data_fun();
 349
 350   if (MC_is_active() || MC_record_replay_is_active()) {
 351     other_comm->set_state(State::RUNNING);
 352     return other_comm;
 353   }
 354   other_comm->start();
 355
 356   return other_comm;
 357 }
 358
 359 bool CommImpl::test(actor::ActorImpl* issuer)
 360 {
 361   if ((MC_is_active() || MC_record_replay_is_active()) && src_actor_ && dst_actor_)
 362     set_state(State::DONE);
 363   return ActivityImpl::test(issuer);
 364 }
 365
 366 void CommImpl::wait_for(actor::ActorImpl* issuer, double timeout)
 367 {
 368   XBT_DEBUG("CommImpl::wait_for(%g), %p, state %s", timeout, this, get_state_str());
 369
 370   /* Associate this simcall to the wait synchro */
 371   register_simcall(&issuer->simcall_);
 372   if (MC_is_active() || MC_record_replay_is_active()) {
 373     // FIXME: what about timeouts?
 374     set_state(State::DONE);
 375     finish();
 376     return;
 377   }
 378   ActivityImpl::wait_for(issuer, timeout);
 379 }
 380
 381 void CommImpl::wait_any_for(actor::ActorImpl* issuer, const std::vector<CommImpl*>& comms, double timeout)
 382 {
 383   std::vector<ActivityImpl*> activities(comms.begin(), comms.end());
 384   ActivityImpl::wait_any_for(issuer, activities, timeout);
 385 }
 386
 387 void CommImpl::suspend()
 388 {
 389   /* FIXME: shall we suspend also the timeout synchro? */
 390   if (surf_action_)
 391     surf_action_->suspend();
 392   /* if not created yet, the action will be suspended on creation, in CommImpl::start() */
 393 }
 394
 395 void CommImpl::resume()
 396 {
 397   /*FIXME: check what happen with the timeouts */
 398   if (surf_action_)
 399     surf_action_->resume();
 400   /* in the other case, the synchro were not really suspended yet, see CommImpl::suspend() and CommImpl::start() */
 401 }
 402
 403 void CommImpl::cancel()
 404 {
 405   /* if the synchro is a waiting state means that it is still in a mbox so remove from it and delete it */
 406   if (get_state() == State::WAITING) {
 407     if (not detached_) {
 408       mbox_->remove(this);
 409       set_state(State::CANCELED);
 410     }
 411   } else if (not MC_is_active() /* when running the MC there are no surf actions */
 412              && not MC_record_replay_is_active() && (get_state() == State::READY || get_state() == State::RUNNING)) {
 413     surf_action_->cancel();
 414   }
 415 }
 416
 417 /** @brief This is part of the cleanup process, probably an internal command */
 418 void CommImpl::cleanup_surf()
 419 {
 420   clean_action();
 421
 422   if (src_timeout_) {
 423     src_timeout_->unref();
 424     src_timeout_ = nullptr;
 425   }
 426
 427   if (dst_timeout_) {
 428     dst_timeout_->unref();
 429     dst_timeout_ = nullptr;
 430   }
 431 }
 432
 433 void CommImpl::post()
 434 {
 435   on_completion(*this);
 436
 437   /* Update synchro state */
 438   if (src_timeout_ && src_timeout_->get_state() == resource::Action::State::FINISHED)
 439     set_state(State::SRC_TIMEOUT);
 440   else if (dst_timeout_ && dst_timeout_->get_state() == resource::Action::State::FINISHED)
 441     set_state(State::DST_TIMEOUT);
 442   else if ((from_ && not from_->is_on()) || (src_timeout_ && src_timeout_->get_state() == resource::Action::State::FAILED))
 443     set_state(State::SRC_HOST_FAILURE);
 444   else if ((to_ && not to_->is_on()) || (dst_timeout_ && dst_timeout_->get_state() == resource::Action::State::FAILED))
 445     set_state(State::DST_HOST_FAILURE);
 446   else if (surf_action_ && surf_action_->get_state() == resource::Action::State::FAILED) {
 447     set_state(State::LINK_FAILURE);
 448   } else if (get_state() == State::RUNNING) {
 449     xbt_assert(from_ && from_->is_on());
 450     xbt_assert(to_ && to_->is_on());
 451     set_state(State::DONE);
 452   }
 453
 454   XBT_DEBUG("CommImpl::post(): comm %p, state %s, src_proc %p, dst_proc %p, detached: %d", this, get_state_str(),
 455             src_actor_.get(), dst_actor_.get(), detached_);
 456
 457   /* destroy the surf actions associated with the Simix communication */
 458   cleanup_surf();
 459
 460   /* Answer all simcalls associated with the synchro */
 461   finish();
 462 }
 463 void CommImpl::set_exception(actor::ActorImpl* issuer)
 464 {
 465   switch (get_state()) {
 466     case State::FAILED:
 467       issuer->exception_ = std::make_exception_ptr(NetworkFailureException(XBT_THROW_POINT, "Remote peer failed"));
 468       break;
 469     case State::SRC_TIMEOUT:
 470       issuer->exception_ =
 471           std::make_exception_ptr(TimeoutException(XBT_THROW_POINT, "Communication timeouted because of the sender"));
 472       break;
 473
 474     case State::DST_TIMEOUT:
 475       issuer->exception_ =
 476           std::make_exception_ptr(TimeoutException(XBT_THROW_POINT, "Communication timeouted because of the receiver"));
 477       break;
 478
 479     case State::SRC_HOST_FAILURE:
 480       if (issuer == src_actor_)
 481         issuer->set_wannadie();
 482       else {
 483         set_state(State::FAILED);
 484         issuer->exception_ = std::make_exception_ptr(NetworkFailureException(XBT_THROW_POINT, "Remote peer failed"));
 485       }
 486       break;
 487
 488     case State::DST_HOST_FAILURE:
 489       if (issuer == dst_actor_)
 490         issuer->set_wannadie();
 491       else {
 492         set_state(State::FAILED);
 493         issuer->exception_ = std::make_exception_ptr(NetworkFailureException(XBT_THROW_POINT, "Remote peer failed"));
 494       }
 495       break;
 496
 497     case State::LINK_FAILURE:
 498       XBT_DEBUG("Link failure in synchro %p between '%s' and '%s': posting an exception to the issuer: %s (%p) "
 499                 "detached:%d",
 500                 this, src_actor_ ? src_actor_->get_host()->get_cname() : nullptr,
 501                 dst_actor_ ? dst_actor_->get_host()->get_cname() : nullptr, issuer->get_cname(), issuer, detached_);
 502       if (src_actor_ == issuer) {
 503         XBT_DEBUG("I'm source");
 504       } else if (dst_actor_ == issuer) {
 505         XBT_DEBUG("I'm dest");
 506       } else {
 507         XBT_DEBUG("I'm neither source nor dest");
 508       }
 509       set_state(State::FAILED);
 510       issuer->throw_exception(std::make_exception_ptr(NetworkFailureException(XBT_THROW_POINT, "Link failure")));
 511       break;
 512
 513     case State::CANCELED:
 514       if (issuer == dst_actor_)
 515         issuer->exception_ =
 516             std::make_exception_ptr(CancelException(XBT_THROW_POINT, "Communication canceled by the sender"));
 517       else
 518         issuer->exception_ =
 519             std::make_exception_ptr(CancelException(XBT_THROW_POINT, "Communication canceled by the receiver"));
 520       break;
 521
 522     default:
 523       xbt_assert(get_state() == State::DONE, "Internal error in CommImpl::finish(): unexpected synchro state %s",
 524                  get_state_str());
 525   }
 526 }
 527
 528 void CommImpl::finish()
 529 {
 530   XBT_DEBUG("CommImpl::finish() in state %s", get_state_str());
 531   /* If the synchro is still in a rendez-vous point then remove from it */
 532   if (mbox_)
 533     mbox_->remove(this);
 534
 535   if (get_state() == State::DONE)
 536     copy_data();
 537
 538   while (not simcalls_.empty()) {
 539     actor::Simcall* simcall = simcalls_.front();
 540     simcalls_.pop_front();
 541
 542     /* If a waitany simcall is waiting for this synchro to finish, then remove it from the other synchros in the waitany
 543      * list. Afterwards, get the position of the actual synchro in the waitany list and return it as the result of the
 544      * simcall */
 545
 546     if (simcall->call_ == actor::Simcall::Type::NONE) // FIXME: maybe a better way to handle this case
 547       continue;                                       // if actor handling comm is killed
 548
 549     handle_activity_waitany(simcall);
 550
 551     /* Check out for errors */
 552
 553     if (not simcall->issuer_->get_host()->is_on()) {
 554       simcall->issuer_->set_wannadie();
 555     } else {
 556       // Do not answer to dying actors
 557       if (not simcall->issuer_->wannadie()) {
 558         set_exception(simcall->issuer_);
 559         simcall->issuer_->simcall_answer();
 560       }
 561     }
 562
 563     simcall->issuer_->waiting_synchro_ = nullptr;
 564     simcall->issuer_->activities_.remove(this);
 565     if (detached_) {
 566       if (simcall->issuer_ != dst_actor_ && dst_actor_ != nullptr)
 567         dst_actor_->activities_.remove(this);
 568       if (simcall->issuer_ != src_actor_ && src_actor_ != nullptr)
 569         src_actor_->activities_.remove(this);
 570     }
 571   }
 572 }
 573
 574 } // namespace simgrid::kernel::activity