Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
factoring with an ActivityImpl::clean_action() method
[simgrid.git] / src / kernel / activity / CommImpl.cpp
index 59c9f69..8aa5747 100644 (file)
@@ -27,7 +27,7 @@ XBT_PRIVATE void simcall_HANDLER_comm_send(smx_simcall_t simcall, smx_actor_t sr
   smx_activity_t comm = simcall_HANDLER_comm_isend(simcall, src, mbox, task_size, rate, src_buff, src_buff_size,
                                                    match_fun, nullptr, copy_data_fun, data, 0);
   SIMCALL_SET_MC_VALUE(simcall, 0);
-  simcall_HANDLER_comm_wait(simcall, comm, timeout);
+  simcall_HANDLER_comm_wait(simcall, static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()), timeout);
 }
 
 XBT_PRIVATE smx_activity_t simcall_HANDLER_comm_isend(
@@ -35,13 +35,14 @@ XBT_PRIVATE smx_activity_t simcall_HANDLER_comm_isend(
     size_t src_buff_size, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
     void (*clean_fun)(void*), // used to free the synchro in case of problem after a detached send
     void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), // used to copy data if not default one
-    void* data, int detached)
+    void* data, bool detached)
 {
   XBT_DEBUG("send from mailbox %p", mbox);
 
   /* Prepare a synchro describing us, so that it gets passed to the user-provided filter of other side */
-  simgrid::kernel::activity::CommImplPtr this_comm = simgrid::kernel::activity::CommImplPtr(
-      new simgrid::kernel::activity::CommImpl(simgrid::kernel::activity::CommImpl::Type::SEND));
+  simgrid::kernel::activity::CommImplPtr this_comm =
+      simgrid::kernel::activity::CommImplPtr(new simgrid::kernel::activity::CommImpl());
+  this_comm->set_type(simgrid::kernel::activity::CommImpl::Type::SEND);
 
   /* Look for communication synchro matching our needs. We also provide a description of
    * ourself so that the other side also gets a chance of choosing if it wants to match with us.
@@ -68,34 +69,29 @@ XBT_PRIVATE smx_activity_t simcall_HANDLER_comm_isend(
     XBT_DEBUG("Receive already pushed");
 
     other_comm->state_ = SIMIX_READY;
-    other_comm->type   = simgrid::kernel::activity::CommImpl::Type::READY;
+    other_comm->set_type(simgrid::kernel::activity::CommImpl::Type::READY);
   }
-  src_proc->comms.push_back(other_comm);
 
   if (detached) {
-    other_comm->detached  = true;
+    other_comm->detached_ = true;
     other_comm->clean_fun = clean_fun;
   } else {
     other_comm->clean_fun = nullptr;
+    src_proc->comms.push_back(other_comm);
   }
 
   /* Setup the communication synchro */
   other_comm->src_actor_     = src_proc;
-  other_comm->task_size_     = task_size;
-  other_comm->rate_          = rate;
-  other_comm->src_buff_      = src_buff;
-  other_comm->src_buff_size_ = src_buff_size;
   other_comm->src_data_      = data;
+  (*other_comm).set_src_buff(src_buff, src_buff_size).set_size(task_size).set_rate(rate);
 
   other_comm->match_fun     = match_fun;
   other_comm->copy_data_fun = copy_data_fun;
 
-  if (MC_is_active() || MC_record_replay_is_active()) {
+  if (MC_is_active() || MC_record_replay_is_active())
     other_comm->state_ = SIMIX_RUNNING;
-    return (detached ? nullptr : other_comm);
-  }
-
-  other_comm->start();
+  else
+    other_comm->start();
 
   return (detached ? nullptr : other_comm);
 }
@@ -109,7 +105,7 @@ XBT_PRIVATE void simcall_HANDLER_comm_recv(smx_simcall_t simcall, smx_actor_t re
   smx_activity_t comm = simcall_HANDLER_comm_irecv(simcall, receiver, mbox, dst_buff, dst_buff_size, match_fun,
                                                    copy_data_fun, data, rate);
   SIMCALL_SET_MC_VALUE(simcall, 0);
-  simcall_HANDLER_comm_wait(simcall, comm, timeout);
+  simcall_HANDLER_comm_wait(simcall, static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()), timeout);
 }
 
 XBT_PRIVATE smx_activity_t simcall_HANDLER_comm_irecv(
@@ -117,8 +113,9 @@ XBT_PRIVATE smx_activity_t simcall_HANDLER_comm_irecv(
     simix_match_func_t match_fun, void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
     void* data, double rate)
 {
-  simgrid::kernel::activity::CommImplPtr this_synchro = simgrid::kernel::activity::CommImplPtr(
-      new simgrid::kernel::activity::CommImpl(simgrid::kernel::activity::CommImpl::Type::RECEIVE));
+  simgrid::kernel::activity::CommImplPtr this_synchro =
+      simgrid::kernel::activity::CommImplPtr(new simgrid::kernel::activity::CommImpl());
+  this_synchro->set_type(simgrid::kernel::activity::CommImpl::Type::RECEIVE);
   XBT_DEBUG("recv from mbox %p. this_synchro=%p", mbox, this_synchro.get());
 
   simgrid::kernel::activity::CommImplPtr other_comm;
@@ -137,10 +134,10 @@ XBT_PRIVATE smx_activity_t simcall_HANDLER_comm_irecv(
       other_comm = std::move(this_synchro);
       mbox->push(other_comm);
     } else {
-      if (other_comm->surf_action_ && other_comm->remains() < 1e-12) {
+      if (other_comm->surf_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->state_ = SIMIX_DONE;
-        other_comm->type   = simgrid::kernel::activity::CommImpl::Type::DONE;
+        other_comm->set_type(simgrid::kernel::activity::CommImpl::Type::DONE);
         other_comm->mbox   = nullptr;
       }
     }
@@ -163,19 +160,18 @@ XBT_PRIVATE smx_activity_t simcall_HANDLER_comm_irecv(
       XBT_DEBUG("Match my %p with the existing %p", this_synchro.get(), other_comm.get());
 
       other_comm->state_ = SIMIX_READY;
-      other_comm->type   = simgrid::kernel::activity::CommImpl::Type::READY;
+      other_comm->set_type(simgrid::kernel::activity::CommImpl::Type::READY);
     }
     receiver->comms.push_back(other_comm);
   }
 
   /* Setup communication synchro */
   other_comm->dst_actor_     = receiver;
-  other_comm->dst_buff_      = dst_buff;
-  other_comm->dst_buff_size_ = dst_buff_size;
   other_comm->dst_data_      = data;
+  other_comm->set_dst_buff(dst_buff, dst_buff_size);
 
-  if (rate > -1.0 && (other_comm->rate_ < 0.0 || rate < other_comm->rate_))
-    other_comm->rate_ = rate;
+  if (rate > -1.0 && (other_comm->get_rate() < 0.0 || rate < other_comm->get_rate()))
+    other_comm->set_rate(rate);
 
   other_comm->match_fun     = match_fun;
   other_comm->copy_data_fun = copy_data_fun;
@@ -188,46 +184,42 @@ XBT_PRIVATE smx_activity_t simcall_HANDLER_comm_irecv(
   return other_comm;
 }
 
-void simcall_HANDLER_comm_wait(smx_simcall_t simcall, smx_activity_t synchro, double timeout)
+void simcall_HANDLER_comm_wait(smx_simcall_t simcall, simgrid::kernel::activity::CommImpl* comm, double timeout)
 {
   /* Associate this simcall to the wait synchro */
-  XBT_DEBUG("simcall_HANDLER_comm_wait, %p", synchro.get());
+  XBT_DEBUG("simcall_HANDLER_comm_wait, %p", comm);
 
-  synchro->simcalls_.push_back(simcall);
-  simcall->issuer->waiting_synchro = synchro;
+  comm->simcalls_.push_back(simcall);
+  simcall->issuer->waiting_synchro = comm;
 
   if (MC_is_active() || MC_record_replay_is_active()) {
     int idx = SIMCALL_GET_MC_VALUE(simcall);
     if (idx == 0) {
-      synchro->state_ = SIMIX_DONE;
+      comm->state_ = SIMIX_DONE;
     } else {
       /* If we reached this point, the wait simcall must have a timeout */
       /* Otherwise it shouldn't be enabled and executed by the MC */
       if (timeout < 0.0)
         THROW_IMPOSSIBLE;
 
-      simgrid::kernel::activity::CommImplPtr comm =
-          boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
       if (comm->src_actor_ == simcall->issuer)
         comm->state_ = SIMIX_SRC_TIMEOUT;
       else
         comm->state_ = SIMIX_DST_TIMEOUT;
     }
 
-    boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro)->finish();
+    comm->finish();
     return;
   }
 
   /* If the synchro has already finish perform the error handling, */
   /* otherwise set up a waiting timeout on the right side          */
-  if (synchro->state_ != SIMIX_WAITING && synchro->state_ != SIMIX_RUNNING) {
-    boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro)->finish();
+  if (comm->state_ != SIMIX_WAITING && comm->state_ != SIMIX_RUNNING) {
+    comm->finish();
   } else { /* we need a sleep action (even when there is no timeout) to be notified of host failures */
     simgrid::kernel::resource::Action* sleep = simcall->issuer->get_host()->pimpl_cpu->sleep(timeout);
-    sleep->set_data(synchro.get());
+    sleep->set_activity(comm);
 
-    simgrid::kernel::activity::CommImplPtr comm =
-        boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
     if (simcall->issuer == comm->src_actor_)
       comm->src_timeout_ = sleep;
     else
@@ -235,32 +227,28 @@ void simcall_HANDLER_comm_wait(smx_simcall_t simcall, smx_activity_t synchro, do
   }
 }
 
-void simcall_HANDLER_comm_test(smx_simcall_t simcall, smx_activity_t synchro)
+void simcall_HANDLER_comm_test(smx_simcall_t simcall, simgrid::kernel::activity::CommImpl* comm)
 {
-  simgrid::kernel::activity::CommImplPtr comm =
-      boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro);
-
   int res;
 
   if (MC_is_active() || MC_record_replay_is_active()) {
     res = comm->src_actor_ && comm->dst_actor_;
     if (res)
-      synchro->state_ = SIMIX_DONE;
+      comm->state_ = SIMIX_DONE;
   } else {
-    res = synchro->state_ != SIMIX_WAITING && synchro->state_ != SIMIX_RUNNING;
+    res = comm->state_ != SIMIX_WAITING && comm->state_ != SIMIX_RUNNING;
   }
 
   simcall_comm_test__set__result(simcall, res);
   if (simcall_comm_test__get__result(simcall)) {
-    synchro->simcalls_.push_back(simcall);
-    boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro)->finish();
+    comm->simcalls_.push_back(simcall);
+    comm->finish();
   } else {
     SIMIX_simcall_answer(simcall);
   }
 }
 
-void simcall_HANDLER_comm_testany(smx_simcall_t simcall, simgrid::kernel::activity::ActivityImplPtr comms[],
-                                  size_t count)
+void simcall_HANDLER_comm_testany(smx_simcall_t simcall, simgrid::kernel::activity::CommImpl* comms[], size_t count)
 {
   // The default result is -1 -- this means, "nothing is ready".
   // It can be changed below, but only if something matches.
@@ -271,21 +259,21 @@ void simcall_HANDLER_comm_testany(smx_simcall_t simcall, simgrid::kernel::activi
     if (idx == -1) {
       SIMIX_simcall_answer(simcall);
     } else {
-      simgrid::kernel::activity::ActivityImplPtr synchro = comms[idx];
+      simgrid::kernel::activity::CommImpl* comm = comms[idx];
       simcall_comm_testany__set__result(simcall, idx);
-      synchro->simcalls_.push_back(simcall);
-      synchro->state_ = SIMIX_DONE;
-      boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro)->finish();
+      comm->simcalls_.push_back(simcall);
+      comm->state_ = SIMIX_DONE;
+      comm->finish();
     }
     return;
   }
 
   for (std::size_t i = 0; i != count; ++i) {
-    simgrid::kernel::activity::ActivityImplPtr synchro = comms[i];
-    if (synchro->state_ != SIMIX_WAITING && synchro->state_ != SIMIX_RUNNING) {
+    simgrid::kernel::activity::CommImpl* comm = comms[i];
+    if (comm->state_ != SIMIX_WAITING && comm->state_ != SIMIX_RUNNING) {
       simcall_comm_testany__set__result(simcall, i);
-      synchro->simcalls_.push_back(simcall);
-      boost::static_pointer_cast<simgrid::kernel::activity::CommImpl>(synchro)->finish();
+      comm->simcalls_.push_back(simcall);
+      comm->finish();
       return;
     }
   }
@@ -294,28 +282,29 @@ void simcall_HANDLER_comm_testany(smx_simcall_t simcall, simgrid::kernel::activi
 
 static void SIMIX_waitany_remove_simcall_from_actions(smx_simcall_t simcall)
 {
-  smx_activity_t* synchros = simcall_comm_waitany__get__comms(simcall);
-  size_t count             = simcall_comm_waitany__get__count(simcall);
+  simgrid::kernel::activity::CommImpl** comms = simcall_comm_waitany__get__comms(simcall);
+  size_t count                                = simcall_comm_waitany__get__count(simcall);
 
   for (size_t i = 0; i < count; i++) {
     // Remove the first occurence of simcall:
-    smx_activity_t& synchro = synchros[i];
-    auto j                  = boost::range::find(synchro->simcalls_, simcall);
-    if (j != synchro->simcalls_.end())
-      synchro->simcalls_.erase(j);
+    auto* comm = comms[i];
+    auto j     = boost::range::find(comm->simcalls_, simcall);
+    if (j != comm->simcalls_.end())
+      comm->simcalls_.erase(j);
   }
 }
-void simcall_HANDLER_comm_waitany(smx_simcall_t simcall, smx_activity_t* synchros, size_t count, double timeout)
+void simcall_HANDLER_comm_waitany(smx_simcall_t simcall, simgrid::kernel::activity::CommImpl* comms[], size_t count,
+                                  double timeout)
 {
   if (MC_is_active() || MC_record_replay_is_active()) {
     if (timeout > 0.0)
       xbt_die("Timeout not implemented for waitany in the model-checker");
     int idx                 = SIMCALL_GET_MC_VALUE(simcall);
-    smx_activity_t& synchro = synchros[idx];
-    synchro->simcalls_.push_back(simcall);
+    auto* comm              = comms[idx];
+    comm->simcalls_.push_back(simcall);
     simcall_comm_waitany__set__result(simcall, idx);
-    synchro->state_ = SIMIX_DONE;
-    synchro->finish();
+    comm->state_ = SIMIX_DONE;
+    comm->finish();
     return;
   }
 
@@ -331,12 +320,12 @@ void simcall_HANDLER_comm_waitany(smx_simcall_t simcall, smx_activity_t* synchro
 
   for (size_t i = 0; i < count; i++) {
     /* associate this simcall to the the synchro */
-    smx_activity_t& synchro = synchros[i];
-    synchro->simcalls_.push_back(simcall);
+    auto* comm = comms[i];
+    comm->simcalls_.push_back(simcall);
 
     /* see if the synchro is already finished */
-    if (synchro->state_ != SIMIX_WAITING && synchro->state_ != SIMIX_RUNNING) {
-      synchro->finish();
+    if (comm->state_ != SIMIX_WAITING && comm->state_ != SIMIX_RUNNING) {
+      comm->finish();
       break;
     }
   }
@@ -352,7 +341,7 @@ void SIMIX_comm_copy_buffer_callback(simgrid::kernel::activity::CommImpl* comm,
 {
   XBT_DEBUG("Copy the data over");
   memcpy(comm->dst_buff_, buff, buff_size);
-  if (comm->detached) { // if this is a detached send, the source buffer was duplicated by SMPI sender to make the
+  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
     xbt_free(buff);
     comm->src_buff_ = nullptr;
@@ -374,34 +363,57 @@ namespace simgrid {
 namespace kernel {
 namespace activity {
 
-CommImpl::CommImpl(CommImpl::Type type) : type(type)
+CommImpl& CommImpl::set_type(CommImpl::Type type)
+{
+  type_ = type;
+  return *this;
+}
+
+CommImpl& CommImpl::set_size(double size)
+{
+  size_ = size;
+  return *this;
+}
+
+CommImpl& CommImpl::set_rate(double rate)
+{
+  rate_ = rate;
+  return *this;
+}
+
+CommImpl& CommImpl::set_src_buff(void* buff, size_t size)
 {
-  state_   = SIMIX_WAITING;
-  src_data_ = nullptr;
-  dst_data_ = nullptr;
-  XBT_DEBUG("Create comm activity %p", this);
+  src_buff_      = buff;
+  src_buff_size_ = size;
+  return *this;
+}
+
+CommImpl& CommImpl::set_dst_buff(void* buff, size_t* size)
+{
+  dst_buff_      = buff;
+  dst_buff_size_ = size;
+  return *this;
 }
 
 CommImpl::~CommImpl()
 {
-  XBT_DEBUG("Really free communication %p", this);
+  XBT_DEBUG("Really free communication %p in state %d (detached = %d)", this, static_cast<int>(state_), detached_);
 
   cleanupSurf();
 
-  if (detached && state_ != SIMIX_DONE) {
+  if (detached_ && state_ != SIMIX_DONE) {
     /* the communication has failed and was detached:
      * we have to free the buffer */
     if (clean_fun)
       clean_fun(src_buff_);
     src_buff_ = nullptr;
-  }
-
-  if (mbox)
+  } else if (mbox) {
     mbox->remove(this);
+  }
 }
 
 /**  @brief Starts the simulation of a communication synchro. */
-void CommImpl::start()
+CommImpl* CommImpl::start()
 {
   /* If both the sender and the receiver are already there, start the communication */
   if (state_ == SIMIX_READY) {
@@ -409,8 +421,9 @@ void CommImpl::start()
     s4u::Host* sender   = src_actor_->get_host();
     s4u::Host* receiver = dst_actor_->get_host();
 
-    surf_action_ = surf_network_model->communicate(sender, receiver, task_size_, rate_);
-    surf_action_->set_data(this);
+    surf_action_ = surf_network_model->communicate(sender, receiver, size_, rate_);
+    surf_action_->set_activity(this);
+    surf_action_->set_category(get_tracing_category());
     state_ = SIMIX_RUNNING;
 
     XBT_DEBUG("Starting communication %p from '%s' to '%s' (surf_action: %p)", this, sender->get_cname(),
@@ -438,6 +451,8 @@ void CommImpl::start()
       surf_action_->suspend();
     }
   }
+
+  return this;
 }
 
 /** @brief Copy the communication data from the sender's buffer to the receiver's one  */
@@ -492,27 +507,20 @@ void CommImpl::cancel()
 {
   /* if the synchro is a waiting state means that it is still in a mbox so remove from it and delete it */
   if (state_ == SIMIX_WAITING) {
-    mbox->remove(this);
-    state_ = SIMIX_CANCELED;
+    if (not detached_) {
+      mbox->remove(this);
+      state_ = SIMIX_CANCELED;
+    }
   } else if (not MC_is_active() /* when running the MC there are no surf actions */
              && not MC_record_replay_is_active() && (state_ == SIMIX_READY || state_ == SIMIX_RUNNING)) {
     surf_action_->cancel();
   }
 }
 
-/**  @brief get the amount remaining from the communication */
-double CommImpl::remains()
-{
-  return surf_action_->get_remains();
-}
-
 /** @brief This is part of the cleanup process, probably an internal command */
 void CommImpl::cleanupSurf()
 {
-  if (surf_action_) {
-    surf_action_->unref();
-    surf_action_ = nullptr;
-  }
+  clean_action();
 
   if (src_timeout_) {
     src_timeout_->unref();
@@ -542,7 +550,7 @@ void CommImpl::post()
     state_ = SIMIX_DONE;
 
   XBT_DEBUG("SIMIX_post_comm: comm %p, state %d, src_proc %p, dst_proc %p, detached: %d", this, (int)state_,
-            src_actor_.get(), dst_actor_.get(), detached);
+            src_actor_.get(), dst_actor_.get(), detached_);
 
   /* destroy the surf actions associated with the Simix communication */
   cleanupSurf();
@@ -590,8 +598,6 @@ void CommImpl::finish()
 
     if (not simcall->issuer->get_host()->is_on()) {
       simcall->issuer->context_->iwannadie = true;
-      simcall->issuer->exception_ =
-          std::make_exception_ptr(simgrid::HostFailureException(XBT_THROW_POINT, "Host failed"));
     } else {
       switch (state_) {
 
@@ -631,7 +637,7 @@ void CommImpl::finish()
                     "detached:%d",
                     this, src_actor_ ? src_actor_->get_host()->get_cname() : nullptr,
                     dst_actor_ ? dst_actor_->get_host()->get_cname() : nullptr, simcall->issuer->get_cname(),
-                    simcall->issuer, detached);
+                    simcall->issuer, detached_);
           if (src_actor_ == simcall->issuer) {
             XBT_DEBUG("I'm source");
           } else if (dst_actor_ == simcall->issuer) {
@@ -690,7 +696,7 @@ void CommImpl::finish()
 
     simcall->issuer->waiting_synchro = nullptr;
     simcall->issuer->comms.remove(this);
-    if (detached) {
+    if (detached_) {
       if (simcall->issuer == src_actor_) {
         if (dst_actor_)
           dst_actor_->comms.remove(this);