Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
simix simplification: no need for a template here
[simgrid.git] / src / simix / libsmx.cpp
index 75ba0b5..e0629a1 100644 (file)
@@ -5,78 +5,32 @@
 /*                                                                            */
 /* This is somehow the "libc" of SimGrid                                      */
 
-/* Copyright (c) 2010-2020. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2010-2022. 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. */
 
 #include "mc/mc.h"
-#include "simgrid/simix/blocking_simcall.hpp"
+#include "src/kernel/EngineImpl.hpp"
 #include "src/kernel/activity/CommImpl.hpp"
 #include "src/kernel/activity/ConditionVariableImpl.hpp"
-#include "src/kernel/activity/ExecImpl.hpp"
-#include "src/kernel/activity/IoImpl.hpp"
-#include "src/kernel/activity/MailboxImpl.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 "src/plugins/vm/VirtualMachineImpl.hpp"
+#include "xbt/random.hpp"
+#include <simgrid/Exception.hpp>
+#include <simgrid/s4u/Activity.hpp>
 
-#include "popping_bodies.cpp"
+#if SIMGRID_HAVE_MC
+#include "src/mc/mc_forward.hpp"
+#endif
 
-/**
- * @ingroup simix_host_management
- * @brief Waits for the completion of an execution synchro and destroy it.
- *
- * @param execution The execution synchro
- */
-simgrid::kernel::activity::State simcall_execution_wait(simgrid::kernel::activity::ActivityImpl* execution,
-                                                        double timeout) // XBT_ATTRIB_DEPRECATED_v330
-{
-  simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
-  simgrid::kernel::actor::simcall_blocking<void>(
-      [execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
-  return simgrid::kernel::activity::State::DONE;
-}
-
-simgrid::kernel::activity::State simcall_execution_wait(const simgrid::kernel::activity::ActivityImplPtr& execution,
-                                                        double timeout) // XBT_ATTRIB_DEPRECATED_v330
-{
-  simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
-  simgrid::kernel::actor::simcall_blocking<void>(
-      [execution, issuer, timeout] { execution->wait_for(issuer, timeout); });
-  return simgrid::kernel::activity::State::DONE;
-}
-
-bool simcall_execution_test(simgrid::kernel::activity::ActivityImpl* execution) // XBT_ATTRIB_DEPRECATED_v330
-{
-  return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
-}
-
-bool simcall_execution_test(const simgrid::kernel::activity::ActivityImplPtr& execution) // XBT_ATTRIB_DEPRECATED_v330
-{
-  return simgrid::kernel::actor::simcall([execution] { return execution->test(); });
-}
-
-unsigned int simcall_execution_waitany_for(simgrid::kernel::activity::ExecImpl* execs[], size_t count, double timeout)
-{
-  return simcall_BODY_execution_waitany_for(execs, count, timeout);
-}
+#include <boost/core/demangle.hpp>
+#include <string>
+#include <typeinfo>
 
-void simcall_process_join(smx_actor_t process, double timeout) // XBT_ATTRIB_DEPRECATED_v328
-{
-  simgrid::kernel::actor::ActorImpl::self()->join(process, timeout);
-}
-
-void simcall_process_suspend(smx_actor_t process) // XBT_ATTRIB_DEPRECATED_v328
-{
-  process->get_iface()->suspend();
-}
-
-simgrid::kernel::activity::State simcall_process_sleep(double duration) // XBT_ATTRIB_DEPRECATED_v329
-{
-  simgrid::kernel::actor::ActorImpl::self()->sleep(duration);
-  return simgrid::kernel::activity::State::DONE;
-}
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix);
 
 /**
  * @ingroup simix_comm_management
@@ -94,17 +48,33 @@ void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size,
   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 */
-    simgrid::kernel::activity::ActivityImplPtr comm =
-        nullptr; /* MC needs the comm to be set to nullptr during the simcall */
-    comm = simcall_comm_isend(sender, mbox, task_size, rate, src_buff, src_buff_size, match_fun, nullptr, copy_data_fun,
-                              data, false);
-    simcall_comm_wait(comm.get(), timeout);
+    /* 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 {
-    simcall_BODY_comm_send(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
-                           match_fun, copy_data_fun, data, timeout);
+    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);
+    });
   }
 }
 
@@ -123,8 +93,10 @@ simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, dou
 
   xbt_assert(mbox, "No rendez-vous point defined for isend");
 
-  return simcall_BODY_comm_isend(sender, mbox, task_size, rate, static_cast<unsigned char*>(src_buff), src_buff_size,
-                                 match_fun, clean_fun, copy_data_fun, data, detached);
+  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); });
 }
 
 /**
@@ -139,17 +111,31 @@ void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
   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 */
-    simgrid::kernel::activity::ActivityImplPtr comm =
-        nullptr; /* MC needs the comm to be set to nullptr during the simcall */
-    comm = simcall_comm_irecv(receiver, mbox, dst_buff, dst_buff_size,
-                              match_fun, copy_data_fun, data, rate);
-    simcall_comm_wait(comm.get(), timeout);
+    /* 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 {
-    simcall_BODY_comm_recv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
-                           copy_data_fun, data, timeout, rate);
+    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);
+    });
   }
 }
 /**
@@ -162,59 +148,54 @@ simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, siz
 {
   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 
-  return simcall_BODY_comm_irecv(receiver, mbox, static_cast<unsigned char*>(dst_buff), dst_buff_size, match_fun,
-                                 copy_data_fun, data, rate);
+  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); });
 }
 
 /**
  * @ingroup simix_comm_management
  */
-simgrid::kernel::activity::ActivityImplPtr
-simcall_comm_iprobe(smx_mailbox_t mbox, int type, bool (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
-                    void* data) // XBT_ATTRIB_DEPRECATED_v330
+ssize_t simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
+                             double timeout) // XBT_ATTRIB_DEPRECATED_v335
 {
-  xbt_assert(mbox, "No rendez-vous point defined for iprobe");
-
-  return simgrid::kernel::actor::simcall([mbox, type, match_fun, data] { return mbox->iprobe(type, match_fun, data); });
-}
-
-/**
- * @ingroup simix_comm_management
- */
-unsigned int simcall_comm_waitany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count,
-                                  double timeout) // XBT_ATTRIB_DEPRECATED_v330
-{
-  auto rcomms = std::make_unique<simgrid::kernel::activity::CommImpl*[]>(count);
-  std::transform(comms, comms + count, rcomms.get(), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
-    return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
-  });
-  return simcall_BODY_comm_waitany(rcomms.get(), count, timeout);
-}
-
-unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count, double timeout)
-{
-  return simcall_BODY_comm_waitany(comms, count, timeout);
+  std::vector<simgrid::kernel::activity::ActivityImpl*> activities;
+  for (size_t i = 0; i < count; i++)
+    activities.push_back(static_cast<simgrid::kernel::activity::ActivityImpl*>(comms[i]));
+  simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
+  simgrid::kernel::actor::ActivityWaitanySimcall observer{issuer, activities, timeout};
+  ssize_t changed_pos = simgrid::kernel::actor::simcall_blocking(
+      [&observer] {
+        simgrid::kernel::activity::ActivityImpl::wait_any_for(observer.get_issuer(), observer.get_activities(),
+                                                              observer.get_timeout());
+      },
+      &observer);
+  if (changed_pos != -1)
+    activities.at(changed_pos)->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
+  return changed_pos;
 }
 
 /**
  * @ingroup simix_comm_management
  */
-int simcall_comm_testany(simgrid::kernel::activity::ActivityImplPtr comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v330
+ssize_t simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v335
 {
   if (count == 0)
     return -1;
-  auto rcomms = std::make_unique<simgrid::kernel::activity::CommImpl*[]>(count);
-  std::transform(comms, comms + count, rcomms.get(), [](const simgrid::kernel::activity::ActivityImplPtr& comm) {
-    return static_cast<simgrid::kernel::activity::CommImpl*>(comm.get());
-  });
-  return simcall_BODY_comm_testany(rcomms.get(), count);
-}
+  std::vector<simgrid::kernel::activity::ActivityImpl*> activities;
+  for (size_t i = 0; i < count; i++)
+    activities.push_back(static_cast<simgrid::kernel::activity::ActivityImpl*>(comms[i]));
 
-int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count)
-{
-  if (count == 0)
-    return -1;
-  return simcall_BODY_comm_testany(comms, count);
+  simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
+  simgrid::kernel::actor::ActivityTestanySimcall observer{issuer, activities};
+  ssize_t changed_pos = simgrid::kernel::actor::simcall_blocking(
+      [&observer] {
+        simgrid::kernel::activity::ActivityImpl::test_any(observer.get_issuer(), observer.get_activities());
+      },
+      &observer);
+  if (changed_pos != -1)
+    comms[changed_pos]->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
+  return changed_pos;
 }
 
 /**
@@ -223,153 +204,78 @@ int simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t co
 void simcall_comm_wait(simgrid::kernel::activity::ActivityImpl* comm, double timeout)
 {
   xbt_assert(std::isfinite(timeout), "timeout is not finite!");
-  simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm), timeout);
-}
-
-/**
- * @ingroup simix_comm_management
- *
- */
-bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm)
-{
-  return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm));
-}
-
-/**
- * @ingroup simix_synchro_management
- *
- */
-smx_mutex_t simcall_mutex_init() // XBT_ATTRIB_DEPRECATED_v330
-{
-  if (simix_global == nullptr) {
-    fprintf(stderr, "You must initialize the SimGrid engine before using it\n"); // We can't use xbt_die since we may
-                                                                                 // get there before the initialization
-    xbt_abort();
-  }
-  return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::MutexImpl(); });
-}
 
-/**
- * @ingroup simix_synchro_management
- *
- */
-void simcall_mutex_lock(smx_mutex_t mutex)
-{
-  simcall_BODY_mutex_lock(mutex);
-}
-
-/**
- * @ingroup simix_synchro_management
- *
- */
-int simcall_mutex_trylock(smx_mutex_t mutex)
-{
-  return simcall_BODY_mutex_trylock(mutex);
-}
-
-/**
- * @ingroup simix_synchro_management
- *
- */
-void simcall_mutex_unlock(smx_mutex_t mutex)
-{
-  simcall_BODY_mutex_unlock(mutex);
-}
-
-/**
- * @ingroup simix_synchro_management
- *
- */
-smx_cond_t simcall_cond_init() // XBT_ATTRIB_DEPRECATED_v330
-{
-  return simgrid::kernel::actor::simcall([] { return new simgrid::kernel::activity::ConditionVariableImpl(); });
-}
-
-/**
- * @ingroup simix_synchro_management
- *
- */
-void simcall_cond_wait(smx_cond_t cond, smx_mutex_t mutex)
-{
-  simcall_BODY_cond_wait(cond, mutex);
-}
+  simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
 
-/**
- * @ingroup simix_synchro_management
- *
- */
-int simcall_cond_wait_timeout(smx_cond_t cond, smx_mutex_t mutex, double timeout)
-{
-  xbt_assert(std::isfinite(timeout), "timeout is not finite!");
-  return simcall_BODY_cond_wait_timeout(cond, mutex, timeout);
+  simgrid::kernel::actor::simcall_blocking([issuer, comm, timeout] { comm->wait_for(issuer, timeout); });
 }
 
 /**
- * @ingroup simix_synchro_management
- *
- */
-void simcall_sem_acquire(smx_sem_t sem)
-{
-  simcall_BODY_sem_acquire(sem);
-}
-
-/**
- * @ingroup simix_synchro_management
+ * @ingroup simix_comm_management
  *
  */
-int simcall_sem_acquire_timeout(smx_sem_t sem, double timeout)
-{
-  xbt_assert(std::isfinite(timeout), "timeout is not finite!");
-  return simcall_BODY_sem_acquire_timeout(sem, timeout);
-}
-
-simgrid::kernel::activity::State simcall_io_wait(simgrid::kernel::activity::ActivityImpl* io,
-                                                 double timeout) // XBT_ATTRIB_DEPRECATED_v330
+bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm) // XBT_ATTRIB_DEPRECATED_v335
 {
   simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
-  simgrid::kernel::actor::simcall_blocking<void>([io, issuer, timeout] { io->wait_for(issuer, timeout); });
-  return simgrid::kernel::activity::State::DONE;
-}
-
-simgrid::kernel::activity::State simcall_io_wait(const simgrid::kernel::activity::ActivityImplPtr& io,
-                                                 double timeout) // XBT_ATTRIB_DEPRECATED_v330
-{
-  simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
-  simgrid::kernel::actor::simcall_blocking<void>([io, issuer, timeout] { io->wait_for(issuer, timeout); });
-  return simgrid::kernel::activity::State::DONE;
-}
-
-bool simcall_io_test(simgrid::kernel::activity::ActivityImpl* io) // XBT_ATTRIB_DEPRECATED_v330
-{
-  return simgrid::kernel::actor::simcall([io] { return io->test(); });
+  simgrid::kernel::actor::ActivityTestSimcall observer{issuer, comm};
+  if (simgrid::kernel::actor::simcall_blocking([&observer] { observer.get_activity()->test(observer.get_issuer()); },
+                                               &observer)) {
+    comm->get_iface()->complete(simgrid::s4u::Activity::State::FINISHED);
+    return true;
+  }
+  return false;
 }
 
-bool simcall_io_test(const simgrid::kernel::activity::ActivityImplPtr& io) // XBT_ATTRIB_DEPRECATD_v330
+static void simcall(simgrid::simix::Simcall call, std::function<void()> const& code)
 {
-  return simgrid::kernel::actor::simcall([io] { return io->test(); });
+  auto self = simgrid::kernel::actor::ActorImpl::self();
+  simgrid::simix::marshal(&self->simcall_, call, &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_));
+    self->yield();
+  } else {
+    self->simcall_handle(0);
+  }
 }
 
-void simcall_run_kernel(std::function<void()> const& code, simgrid::mc::SimcallInspector* t)
+void simcall_run_kernel(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 {
-  simgrid::kernel::actor::ActorImpl::self()->simcall_.inspector_ = t;
-  simcall_BODY_run_kernel(&code);
+  simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
+  // 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::simix::Simcall::RUN_KERNEL, code);
+  simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 }
 
-void simcall_run_blocking(std::function<void()> const& code, simgrid::mc::SimcallInspector* t = nullptr)
+void simcall_run_blocking(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 {
-  simgrid::kernel::actor::ActorImpl::self()->simcall_.inspector_ = t;
-  simcall_BODY_run_blocking(&code);
-}
-
-int simcall_mc_random(int min, int max) {
-  return simcall_BODY_mc_random(min, max);
+  simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
+  // 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::simix::Simcall::RUN_BLOCKING, code);
+  simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = nullptr;
 }
 
 /* ************************************************************************** */
 
 /** @brief returns a printable string representing a simcall */
-const char *SIMIX_simcall_name(e_smx_simcall_t kind) {
-  return simcall_names[kind];
+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 {
@@ -377,7 +283,7 @@ namespace simix {
 
 void unblock(smx_actor_t actor)
 {
-  xbt_assert(SIMIX_is_maestro());
+  xbt_assert(s4u::Actor::is_maestro());
   actor->simcall_answer();
 }
 } // namespace simix