Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Introduce a Mailbox::get_async() with no payload parameter
[simgrid.git] / src / kernel / activity / CommImpl.cpp
index 70f560e..25a7661 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2022. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-2023. The SimGrid Team. All rights reserved.          */
 
 /* This program is free software; you can redistribute it and/or modify it
  * under the terms of the license (GNU LGPL) which comes with this package. */
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_network, kernel, "Kernel network-related synchronization");
 
 namespace simgrid::kernel::activity {
-xbt::signal<void(CommImpl const&)> CommImpl::on_start;
-xbt::signal<void(CommImpl const&)> CommImpl::on_completion;
 
-std::function<void(CommImpl*, void*, size_t)> CommImpl::copy_data_callback_ = &s4u::Comm::copy_pointer_callback;
+unsigned CommImpl::next_id_ = 0;
+
+/* In stateful MC, we need to ignore some private memory that is not relevant to the application state */
+void CommImpl::setup_mc()
+{
+  MC_ignore(&CommImpl::next_id_, sizeof(CommImpl::next_id_));
+}
+
+CommImpl::CommImpl()
+{
+  MC_ignore((void*)&id_, sizeof(id_));
+}
+
+std::function<void(CommImpl*, void*, size_t)> CommImpl::copy_data_callback_ = [](kernel::activity::CommImpl* comm,
+                                                                                 void* buff, size_t buff_size) {
+  xbt_assert((buff_size == sizeof(void*)), "Cannot copy %zu bytes: must be sizeof(void*)", buff_size);
+  if (comm->dst_buff_ != nullptr) // get_async provided a buffer
+    *(void**)(comm->dst_buff_) = buff;
+  comm->payload_ = buff; // Setup what will be retrieved by s4u::Comm::get_payload()
+};
 
 void CommImpl::set_copy_data_callback(const std::function<void(CommImpl*, void*, size_t)>& callback)
 {
@@ -88,7 +105,7 @@ CommImpl& CommImpl::set_dst_buff(unsigned char* buff, size_t* size)
 CommImpl& CommImpl::detach()
 {
   detached_ = true;
-  EngineImpl::get_instance()->get_maestro()->activities_.emplace_back(this);
+  EngineImpl::get_instance()->get_maestro()->activities_.insert(this);
   return *this;
 }
 
@@ -96,7 +113,7 @@ CommImpl::~CommImpl()
 {
   XBT_DEBUG("Really free communication %p in state %s (detached = %d)", this, get_state_str(), detached_);
 
-  cleanup_surf();
+  clean_action();
 
   if (detached_ && get_state() != State::DONE) {
     /* the communication has failed and was detached:
@@ -107,6 +124,8 @@ CommImpl::~CommImpl()
   } else if (mbox_) {
     mbox_->remove(this);
   }
+
+  MC_unignore((void*)&id_, sizeof(id_));
 }
 
 /**  @brief Starts the simulation of a communication synchro. */
@@ -121,25 +140,24 @@ CommImpl* CommImpl::start()
 
     /* Getting the network_model from the origin host
      * Valid while we have a single network model, otherwise we would need to change this function to first get the
-     * routes and later create the respective surf actions */
+     * routes and later create the respective model actions */
     auto net_model = from_->get_netpoint()->get_englobing_zone()->get_network_model();
 
-    surf_action_ = net_model->communicate(from_, to_, size_, rate_, false);
-    surf_action_->set_activity(this);
-    surf_action_->set_category(get_tracing_category());
-    set_start_time(surf_action_->get_start_time());
+    model_action_ = net_model->communicate(from_, to_, size_, rate_, false);
+    model_action_->set_activity(this);
+    model_action_->set_category(get_tracing_category());
+    set_start_time(model_action_->get_start_time());
     set_state(State::RUNNING);
-    on_start(*this);
 
-    XBT_DEBUG("Starting communication %p from '%s' to '%s' (surf_action: %p; state: %s)", this, from_->get_cname(),
-              to_->get_cname(), surf_action_, get_state_str());
+    XBT_DEBUG("Starting communication %p from '%s' to '%s' (model action: %p; state: %s)", this, from_->get_cname(),
+              to_->get_cname(), model_action_, get_state_str());
 
     /* If a link is failed, detect it immediately */
-    if (surf_action_->get_state() == resource::Action::State::FAILED) {
+    if (model_action_->get_state() == resource::Action::State::FAILED) {
       XBT_DEBUG("Communication from '%s' to '%s' failed to start because of a link failure", from_->get_cname(),
                 to_->get_cname());
       set_state(State::LINK_FAILURE);
-      post();
+      finish();
 
     } else if ((src_actor_ != nullptr && src_actor_->is_suspended()) ||
                (dst_actor_ != nullptr && dst_actor_->is_suspended())) {
@@ -154,7 +172,7 @@ CommImpl* CommImpl::start()
                   "communication",
                   dst_actor_->get_cname(), dst_actor_->get_host()->get_cname());
 
-      surf_action_->suspend();
+      model_action_->suspend();
     }
   }
 
@@ -176,7 +194,7 @@ void CommImpl::copy_data()
 {
   size_t buff_size = src_buff_size_;
   /* If there is no data to copy then return */
-  if (not src_buff_ || not dst_buff_ || copied_)
+  if (not src_buff_ || not dst_buff_size_ || copied_)
     return;
 
   XBT_DEBUG("Copying comm %p data from %s (%p) -> %s (%p) (%zu bytes)", this,
@@ -245,7 +263,7 @@ ActivityImplPtr CommImpl::isend(actor::CommIsendSimcall* observer)
     other_comm->clean_fun = observer->get_clean_fun();
   } else {
     other_comm->clean_fun = nullptr;
-    observer->get_issuer()->activities_.emplace_back(other_comm);
+    observer->get_issuer()->activities_.insert(other_comm);
   }
 
   /* Setup the communication synchro */
@@ -282,7 +300,7 @@ ActivityImplPtr CommImpl::irecv(actor::CommIrecvSimcall* observer)
     // find a match in the list of already received comms
     other_comm = mbox->find_matching_comm(CommImplType::SEND, observer->get_match_fun(), observer->get_payload(),
                                           this_synchro, /*done*/ true, /*remove_matching*/ true);
-    if (other_comm  && other_comm->surf_action_ && other_comm->get_remaining() < 1e-12) {
+    if (other_comm && other_comm->model_action_ && other_comm->get_remaining() < 1e-12) {
       XBT_DEBUG("comm %p has been already sent, and is finished, destroy it", other_comm.get());
       other_comm->set_state(State::DONE);
       other_comm->set_mailbox(nullptr);
@@ -294,7 +312,7 @@ ActivityImplPtr CommImpl::irecv(actor::CommIrecvSimcall* observer)
         other_comm = std::move(this_synchro);
         mbox->push(other_comm);
       }
-      observer->get_issuer()->activities_.emplace_back(other_comm);
+      observer->get_issuer()->activities_.insert(other_comm);
     }
   } else {
     /* Prepare a comm describing us, so that it gets passed to the user-provided filter of other side */
@@ -315,7 +333,7 @@ ActivityImplPtr CommImpl::irecv(actor::CommIrecvSimcall* observer)
 
       other_comm->set_state(simgrid::kernel::activity::State::READY);
     }
-    observer->get_issuer()->activities_.emplace_back(other_comm);
+    observer->get_issuer()->activities_.insert(other_comm);
   }
   observer->set_comm(other_comm.get());
 
@@ -370,16 +388,16 @@ void CommImpl::wait_any_for(actor::ActorImpl* issuer, const std::vector<CommImpl
 void CommImpl::suspend()
 {
   /* FIXME: shall we suspend also the timeout synchro? */
-  if (surf_action_)
-    surf_action_->suspend();
+  if (model_action_)
+    model_action_->suspend();
   /* if not created yet, the action will be suspended on creation, in CommImpl::start() */
 }
 
 void CommImpl::resume()
 {
   /*FIXME: check what happen with the timeouts */
-  if (surf_action_)
-    surf_action_->resume();
+  if (model_action_)
+    model_action_->resume();
   /* in the other case, the synchro were not really suspended yet, see CommImpl::suspend() and CommImpl::start() */
 }
 
@@ -391,58 +409,12 @@ void CommImpl::cancel()
       mbox_->remove(this);
       set_state(State::CANCELED);
     }
-  } else if (not MC_is_active() /* when running the MC there are no surf actions */
+  } else if (not MC_is_active() /* when running the MC there are no model actions */
              && not MC_record_replay_is_active() && (get_state() == State::READY || get_state() == State::RUNNING)) {
-    surf_action_->cancel();
-  }
-}
-
-/** @brief This is part of the cleanup process, probably an internal command */
-void CommImpl::cleanup_surf()
-{
-  clean_action();
-
-  if (src_timeout_) {
-    src_timeout_->unref();
-    src_timeout_ = nullptr;
-  }
-
-  if (dst_timeout_) {
-    dst_timeout_->unref();
-    dst_timeout_ = nullptr;
+    model_action_->cancel();
   }
 }
 
-void CommImpl::post()
-{
-  on_completion(*this);
-
-  /* Update synchro state */
-  if (src_timeout_ && src_timeout_->get_state() == resource::Action::State::FINISHED)
-    set_state(State::SRC_TIMEOUT);
-  else if (dst_timeout_ && dst_timeout_->get_state() == resource::Action::State::FINISHED)
-    set_state(State::DST_TIMEOUT);
-  else if ((from_ && not from_->is_on()) || (src_timeout_ && src_timeout_->get_state() == resource::Action::State::FAILED))
-    set_state(State::SRC_HOST_FAILURE);
-  else if ((to_ && not to_->is_on()) || (dst_timeout_ && dst_timeout_->get_state() == resource::Action::State::FAILED))
-    set_state(State::DST_HOST_FAILURE);
-  else if (surf_action_ && surf_action_->get_state() == resource::Action::State::FAILED) {
-    set_state(State::LINK_FAILURE);
-  } else if (get_state() == State::RUNNING) {
-    xbt_assert(from_ && from_->is_on());
-    xbt_assert(to_ && to_->is_on());
-    set_state(State::DONE);
-  }
-
-  XBT_DEBUG("CommImpl::post(): comm %p, state %s, src_proc %p, dst_proc %p, detached: %d", this, get_state_str(),
-            src_actor_.get(), dst_actor_.get(), detached_);
-
-  /* destroy the surf actions associated with the Simix communication */
-  cleanup_surf();
-
-  /* Answer all simcalls associated with the synchro */
-  finish();
-}
 void CommImpl::set_exception(actor::ActorImpl* issuer)
 {
   switch (get_state()) {
@@ -510,7 +482,39 @@ void CommImpl::set_exception(actor::ActorImpl* issuer)
 
 void CommImpl::finish()
 {
-  XBT_DEBUG("CommImpl::finish() in state %s", get_state_str());
+  XBT_DEBUG("CommImpl::finish() comm %p, state %s, src_proc %p, dst_proc %p, detached: %d", this, get_state_str(),
+            src_actor_.get(), dst_actor_.get(), detached_);
+
+  if (get_iface()) {
+    const auto& piface = static_cast<const s4u::Comm&>(*get_iface());
+    set_iface(nullptr); // reset iface to protect against multiple trigger of the on_completion signals
+    piface.fire_on_completion_for_real();
+    piface.fire_on_this_completion_for_real();
+  }
+
+  /* Update synchro state */
+  if (src_timeout_ && src_timeout_->get_state() == resource::Action::State::FINISHED)
+    set_state(State::SRC_TIMEOUT);
+  else if (dst_timeout_ && dst_timeout_->get_state() == resource::Action::State::FINISHED)
+    set_state(State::DST_TIMEOUT);
+  else if ((from_ && not from_->is_on()) ||
+           (src_timeout_ && src_timeout_->get_state() == resource::Action::State::FAILED))
+    set_state(State::SRC_HOST_FAILURE);
+  else if ((to_ && not to_->is_on()) || (dst_timeout_ && dst_timeout_->get_state() == resource::Action::State::FAILED))
+    set_state(State::DST_HOST_FAILURE);
+  else if (model_action_ && model_action_->get_state() == resource::Action::State::FAILED) {
+    set_state(State::LINK_FAILURE);
+  } else if (get_state() == State::RUNNING) {
+    xbt_assert(from_ && from_->is_on());
+    xbt_assert(to_ && to_->is_on());
+    set_state(State::DONE);
+  }
+  src_timeout_ = nullptr;
+  dst_timeout_ = nullptr;
+
+  /* destroy the model actions associated with the communication activity */
+  clean_action();
+
   /* If the synchro is still in a rendez-vous point then remove from it */
   if (mbox_)
     mbox_->remove(this);
@@ -519,7 +523,7 @@ void CommImpl::finish()
     copy_data();
 
   if (detached_)
-    EngineImpl::get_instance()->get_maestro()->activities_.remove(this);
+    EngineImpl::get_instance()->get_maestro()->activities_.erase(this);
 
   while (not simcalls_.empty()) {
     actor::Simcall* simcall = simcalls_.front();
@@ -547,12 +551,12 @@ void CommImpl::finish()
     }
 
     simcall->issuer_->waiting_synchro_ = nullptr;
-    simcall->issuer_->activities_.remove(this);
+    simcall->issuer_->activities_.erase(this);
     if (detached_) {
       if (simcall->issuer_ != dst_actor_ && dst_actor_ != nullptr)
-        dst_actor_->activities_.remove(this);
+        dst_actor_->activities_.erase(this);
       if (simcall->issuer_ != src_actor_ && src_actor_ != nullptr)
-        src_actor_->activities_.remove(this);
+        src_actor_->activities_.erase(this);
     }
   }
 }