Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Move Simcall from namespace simix to kernel::actor.
[simgrid.git] / src / simix / libsmx.cpp
index 1a00a73..402d188 100644 (file)
 /* 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. */
 
-#include "mc/mc.h"
 #include "src/kernel/EngineImpl.hpp"
 #include "src/kernel/activity/CommImpl.hpp"
-#include "src/kernel/activity/ConditionVariableImpl.hpp"
-#include "src/kernel/activity/MutexImpl.hpp"
-#include "src/kernel/activity/SemaphoreImpl.hpp"
 #include "src/kernel/actor/SimcallObserver.hpp"
-#include "src/mc/mc_replay.hpp"
-#include "xbt/random.hpp"
-#include <simgrid/Exception.hpp>
 #include <simgrid/s4u/Activity.hpp>
 
-#if SIMGRID_HAVE_MC
-#include "src/mc/mc_forward.hpp"
-#endif
+#define SIMIX_H_NO_DEPRECATED_WARNING // avoid deprecation warning on include (remove with XBT_ATTRIB_DEPRECATED_v335)
+#include <simgrid/simix.h>
 
-#include <boost/core/demangle.hpp>
-#include <string>
-#include <typeinfo>
-
-XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(ker_simcall);
 
 /**
  * @ingroup simix_comm_management
@@ -38,44 +26,11 @@ XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
 void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
                        size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
-                       double timeout)
+                       double timeout) // XBT_ATTRIB_DEPRECATED_v335
 {
-  /* checking for infinite values */
-  xbt_assert(std::isfinite(task_size), "task_size is not finite!");
-  xbt_assert(std::isfinite(rate), "rate is not finite!");
-  xbt_assert(std::isfinite(timeout), "timeout is not finite!");
-
   xbt_assert(mbox, "No rendez-vous point defined for send");
-
-  if (MC_is_active() || MC_record_replay_is_active()) {
-    /* the model-checker wants two separate simcalls, and wants comm to be nullptr during the simcall */
-    simgrid::kernel::activity::ActivityImplPtr comm = nullptr;
-
-    simgrid::kernel::actor::CommIsendSimcall send_observer{
-        sender,  mbox,          task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
-        nullptr, copy_data_fun, data,      false};
-    comm = simgrid::kernel::actor::simcall(
-        [&send_observer] { return simgrid::kernel::activity::CommImpl::isend(&send_observer); }, &send_observer);
-
-    simgrid::kernel::actor::ActivityWaitSimcall wait_observer{sender, comm.get(), timeout};
-    if (simgrid::kernel::actor::simcall_blocking(
-            [&wait_observer] {
-              wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
-            },
-            &wait_observer)) {
-      throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
-    }
-    comm = nullptr;
-  }
-  else {
-    simgrid::kernel::actor::CommIsendSimcall observer(sender, mbox, task_size, rate,
-                                                      static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
-                                                      nullptr, copy_data_fun, data, false);
-    simgrid::kernel::actor::simcall_blocking([&observer, timeout] {
-      simgrid::kernel::activity::ActivityImplPtr comm = simgrid::kernel::activity::CommImpl::isend(&observer);
-      comm->wait_for(observer.get_issuer(), timeout);
-    });
-  }
+  simgrid::s4u::Comm::send(sender, mbox->get_iface(), task_size, rate, src_buff, src_buff_size, match_fun,
+                           copy_data_fun, data, timeout);
 }
 
 /**
@@ -85,7 +40,7 @@ simgrid::kernel::activity::ActivityImplPtr
 simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
                    size_t src_buff_size, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
                    void (*clean_fun)(void*), void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
-                   void* data, bool detached)
+                   void* data, bool detached) // XBT_ATTRIB_DEPRECATED_v335
 {
   /* checking for infinite values */
   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
@@ -96,7 +51,8 @@ simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, dou
   simgrid::kernel::actor::CommIsendSimcall observer(sender, mbox, task_size, rate,
                                                     static_cast<unsigned char*>(src_buff), src_buff_size, match_fun,
                                                     clean_fun, copy_data_fun, data, detached);
-  return simgrid::kernel::actor::simcall([&observer] { return simgrid::kernel::activity::CommImpl::isend(&observer); });
+  return simgrid::kernel::actor::simcall_answered(
+      [&observer] { return simgrid::kernel::activity::CommImpl::isend(&observer); });
 }
 
 /**
@@ -105,52 +61,28 @@ simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, dou
 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
                        bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
                        void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
-                       double timeout, double rate)
+                       double timeout, double rate) // XBT_ATTRIB_DEPRECATED_v335
 {
-  xbt_assert(std::isfinite(timeout), "timeout is not finite!");
   xbt_assert(mbox, "No rendez-vous point defined for recv");
-
-  if (MC_is_active() || MC_record_replay_is_active()) {
-    /* the model-checker wants two separate simcalls, and wants comm to be nullptr during the simcall */
-    simgrid::kernel::activity::ActivityImplPtr comm = nullptr;
-
-    simgrid::kernel::actor::CommIrecvSimcall observer{
-        receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun, copy_data_fun, data, rate};
-    comm = simgrid::kernel::actor::simcall(
-        [&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); }, &observer);
-
-    simgrid::kernel::actor::ActivityWaitSimcall wait_observer{receiver, comm.get(), timeout};
-    if (simgrid::kernel::actor::simcall_blocking(
-            [&wait_observer] {
-              wait_observer.get_activity()->wait_for(wait_observer.get_issuer(), wait_observer.get_timeout());
-            },
-            &wait_observer)) {
-      throw simgrid::TimeoutException(XBT_THROW_POINT, "Timeouted");
-    }
-    comm = nullptr;
-  }
-  else {
-    simgrid::kernel::actor::CommIrecvSimcall observer(receiver, mbox, static_cast<unsigned char*>(dst_buff),
-                                                      dst_buff_size, match_fun, copy_data_fun, data, rate);
-    simgrid::kernel::actor::simcall_blocking([&observer, timeout] {
-      simgrid::kernel::activity::ActivityImplPtr comm = simgrid::kernel::activity::CommImpl::irecv(&observer);
-      comm->wait_for(observer.get_issuer(), timeout);
-    });
-  }
+  simgrid::s4u::Comm::recv(receiver, mbox->get_iface(), dst_buff, dst_buff_size, match_fun, copy_data_fun, data,
+                           timeout, rate);
 }
+
 /**
  * @ingroup simix_comm_management
  */
 simgrid::kernel::activity::ActivityImplPtr
 simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
                    bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
-                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data, double rate)
+                   void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t), void* data,
+                   double rate) // XBT_ATTRIB_DEPRECATED_v335
 {
   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 
   simgrid::kernel::actor::CommIrecvSimcall observer(receiver, mbox, static_cast<unsigned char*>(dst_buff),
                                                     dst_buff_size, match_fun, copy_data_fun, data, rate);
-  return simgrid::kernel::actor::simcall([&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); });
+  return simgrid::kernel::actor::simcall_answered(
+      [&observer] { return simgrid::kernel::activity::CommImpl::irecv(&observer); });
 }
 
 /**
@@ -201,12 +133,10 @@ ssize_t simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_
 /**
  * @ingroup simix_comm_management
  */
-void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
+void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout) // XBT_ATTRIB_DEPRECATED_v335
 {
   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
-
   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
-
   simgrid::kernel::actor::simcall_blocking([issuer, comm, timeout] { comm->wait_for(issuer, timeout); });
 }
 
@@ -226,66 +156,33 @@ bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm) // XBT_ATT
   return false;
 }
 
-template <class R, class... T> static R simcall(simgrid::simix::Simcall call, T const&... t)
+static void simcall(simgrid::kernel::actor::Simcall::Type call, std::function<void()> const& code)
 {
   auto self = simgrid::kernel::actor::ActorImpl::self();
-  simgrid::simix::marshal(&self->simcall_, call, t...);
+  self->simcall_.call_ = call;
+  self->simcall_.code_ = &code;
   if (not simgrid::kernel::EngineImpl::get_instance()->is_maestro(self)) {
-    XBT_DEBUG("Yield process '%s' on simcall %s", self->get_cname(), SIMIX_simcall_name(self->simcall_));
+    XBT_DEBUG("Yield process '%s' on simcall %s", self->get_cname(), self->simcall_.get_cname());
     self->yield();
   } else {
     self->simcall_handle(0);
   }
-  return simgrid::simix::unmarshal<R>(self->simcall_.result_);
 }
 
-void simcall_run_kernel(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
+void simcall_run_answered(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 {
   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
-  if (false) /* Go to that function to follow the code flow through the simcall barrier */
-    SIMIX_run_kernel(&code);
-  simcall<void, std::function<void()> const*>(simgrid::simix::Simcall::RUN_KERNEL, &code);
+  // The function `code` is called in kernel mode (either because we are already in maestor or after a context switch)
+  // and simcall_answer() is called
+  simcall(simgrid::kernel::actor::Simcall::Type::RUN_ANSWERED, code);
   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 }
 
 void simcall_run_blocking(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 {
   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
-  if (false) /* Go to that function to follow the code flow through the simcall barrier */
-    SIMIX_run_kernel(&code);
-  simcall<void, std::function<void()> const*>(simgrid::simix::Simcall::RUN_BLOCKING, &code);
+  // The function `code` is called in kernel mode (either because we are already in maestor or after a context switch)
+  // BUT simcall_answer IS NOT CALLED
+  simcall(simgrid::kernel::actor::Simcall::Type::RUN_BLOCKING, code);
   simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 }
-
-/* ************************************************************************** */
-
-/** @brief returns a printable string representing a simcall */
-const char* SIMIX_simcall_name(const s_smx_simcall& simcall)
-{
-  if (simcall.observer_ != nullptr) {
-#if SIMGRID_HAVE_MC
-    if (mc_model_checker != nullptr) // Do not try to use the observer from the MCer
-      return "(remotely observed)";
-#endif
-
-    static std::string name;
-    name              = boost::core::demangle(typeid(*simcall.observer_).name());
-    const char* cname = name.c_str();
-    if (name.rfind("simgrid::kernel::", 0) == 0)
-      cname += 17; // strip prefix "simgrid::kernel::"
-    return cname;
-  } else {
-    return simcall_names.at(static_cast<int>(simcall.call_));
-  }
-}
-
-namespace simgrid {
-namespace simix {
-
-void unblock(smx_actor_t actor)
-{
-  xbt_assert(s4u::Actor::is_maestro());
-  actor->simcall_answer();
-}
-} // namespace simix
-} // namespace simgrid