src/kernel/activity/CommImpl.cpp

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