Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
MC: do not segfault when the logs are activated
[simgrid.git] / src / simix / libsmx.cpp
index 49d76b5..9914b02 100644 (file)
@@ -5,66 +5,32 @@
 /*                                                                            */
 /* This is somehow the "libc" of SimGrid                                      */
 
-/* Copyright (c) 2010-2019. 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/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 "popping_bodies.cpp"
 
-/**
- * @ingroup simix_host_management
- * @brief Waits for the completion of an execution synchro and destroy it.
- *
- * @param execution The execution synchro
- */
-e_smx_state_t simcall_execution_wait(const smx_activity_t& execution)
-{
-  return (e_smx_state_t)simcall_BODY_execution_wait(static_cast<simgrid::kernel::activity::ExecImpl*>(execution.get()));
-}
-
-bool simcall_execution_test(const smx_activity_t& execution)
-{
-  return simcall_BODY_execution_test(static_cast<simgrid::kernel::activity::ExecImpl*>(execution.get()));
-}
-
-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);
-}
-
-void simcall_process_join(smx_actor_t process, double timeout)
-{
-  SIMIX_process_self()->join(process, timeout);
-}
-
-void simcall_process_suspend(smx_actor_t process)
-{
-  process->iface()->suspend();
-}
-
-e_smx_state_t simcall_process_sleep(double duration)
-{
-  SIMIX_process_self()->sleep(duration);
-  return SIMIX_DONE;
-}
+#include <boost/core/demangle.hpp>
+#include <string>
+#include <typeinfo>
 
 /**
  * @ingroup simix_comm_management
  */
 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, int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
+                       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)
 {
@@ -76,11 +42,30 @@ 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 */
-    smx_activity_t 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, 0);
-    simcall_comm_wait(comm, 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_blocking(
+        [&send_observer] {
+          return simgrid::kernel::activity::CommImpl::isend(
+              send_observer.get_issuer(), send_observer.get_mailbox(), send_observer.get_payload_size(),
+              send_observer.get_rate(), send_observer.get_src_buff(), send_observer.get_src_buff_size(),
+              send_observer.match_fun_, send_observer.clean_fun_, send_observer.copy_data_fun_,
+              send_observer.get_payload(), send_observer.is_detached());
+        },
+        &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 {
@@ -92,12 +77,11 @@ void simcall_comm_send(smx_actor_t sender, smx_mailbox_t mbox, double task_size,
 /**
  * @ingroup simix_comm_management
  */
-smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double task_size, double rate, void* src_buff,
-                                  size_t src_buff_size,
-                                  int (*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)
+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)
 {
   /* checking for infinite values */
   xbt_assert(std::isfinite(task_size), "task_size is not finite!");
@@ -113,7 +97,7 @@ smx_activity_t simcall_comm_isend(smx_actor_t sender, smx_mailbox_t mbox, double
  * @ingroup simix_comm_management
  */
 void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
-                       int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
+                       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)
 {
@@ -121,11 +105,27 @@ 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 */
-    smx_activity_t 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, 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_blocking(
+        [&observer] {
+          return simgrid::kernel::activity::CommImpl::irecv(
+              observer.get_issuer(), observer.get_mailbox(), observer.get_dst_buff(), observer.get_dst_buff_size(),
+              observer.match_fun_, observer.copy_data_fun_, observer.get_payload(), observer.get_rate());
+        },
+        &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 {
@@ -136,10 +136,10 @@ void simcall_comm_recv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff,
 /**
  * @ingroup simix_comm_management
  */
-smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void* dst_buff, size_t* dst_buff_size,
-                                  int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*),
-                                  void (*copy_data_fun)(simgrid::kernel::activity::CommImpl*, void*, size_t),
-                                  void* data, double rate)
+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)
 {
   xbt_assert(mbox, "No rendez-vous point defined for irecv");
 
@@ -150,27 +150,8 @@ smx_activity_t simcall_comm_irecv(smx_actor_t receiver, smx_mailbox_t mbox, void
 /**
  * @ingroup simix_comm_management
  */
-smx_activity_t simcall_comm_iprobe(smx_mailbox_t mbox, int type,
-                                   int (*match_fun)(void*, void*, simgrid::kernel::activity::CommImpl*), void* data)
-{
-  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(smx_activity_t comms[], size_t count, double timeout)
-{
-  std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
-  std::transform(comms, comms + count, rcomms.get(), [](const smx_activity_t& 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)
+ssize_t simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[], size_t count,
+                             double timeout) // XBT_ATTRIB_DEPRECATED_v335
 {
   return simcall_BODY_comm_waitany(comms, count, timeout);
 }
@@ -178,156 +159,85 @@ unsigned int simcall_comm_waitany(simgrid::kernel::activity::CommImpl* comms[],
 /**
  * @ingroup simix_comm_management
  */
-int simcall_comm_testany(smx_activity_t comms[], size_t count)
+ssize_t simcall_comm_testany(simgrid::kernel::activity::CommImpl* comms[], size_t count) // XBT_ATTRIB_DEPRECATED_v335
 {
   if (count == 0)
     return -1;
-  std::unique_ptr<simgrid::kernel::activity::CommImpl* []> rcomms(new simgrid::kernel::activity::CommImpl*[count]);
-  std::transform(comms, comms + count, rcomms.get(), [](const smx_activity_t& 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;
 }
 
 /**
  * @ingroup simix_comm_management
  */
-void simcall_comm_wait(const smx_activity_t& comm, double timeout)
+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.get()), timeout);
+  simcall_BODY_comm_wait(static_cast<simgrid::kernel::activity::CommImpl*>(comm), timeout);
 }
 
 /**
  * @ingroup simix_comm_management
  *
  */
-bool simcall_comm_test(const smx_activity_t& comm)
-{
-  return simcall_BODY_comm_test(static_cast<simgrid::kernel::activity::CommImpl*>(comm.get()));
-}
-
-/**
- * @ingroup simix_synchro_management
- *
- */
-smx_mutex_t simcall_mutex_init()
+bool simcall_comm_test(simgrid::kernel::activity::ActivityImpl* comm) // XBT_ATTRIB_DEPRECATED_v335
 {
-  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();
+  simgrid::kernel::actor::ActorImpl* issuer = simgrid::kernel::actor::ActorImpl::self();
+  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 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()
-{
-  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);
-}
-
-/**
- * @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);
-}
-
-/**
- * @ingroup simix_synchro_management
- *
- */
-void simcall_sem_acquire(smx_sem_t sem)
-{
-  simcall_BODY_sem_acquire(sem);
-}
-
-/**
- * @ingroup simix_synchro_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);
+  return false;
 }
 
-e_smx_state_t simcall_io_wait(const smx_activity_t& io)
+void simcall_run_kernel(std::function<void()> const& code, simgrid::kernel::actor::SimcallObserver* observer)
 {
-  return (e_smx_state_t)simcall_BODY_io_wait(static_cast<simgrid::kernel::activity::IoImpl*>(io.get()));
-}
-
-void simcall_run_kernel(std::function<void()> const& code, simgrid::mc::SimcallInspector* t)
-{
-  SIMIX_process_self()->simcall.inspector_ = t;
+  simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
   simcall_BODY_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)
 {
-  SIMIX_process_self()->simcall.inspector_ = t;
+  simgrid::kernel::actor::ActorImpl::self()->simcall_.observer_ = observer;
   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_ = 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[static_cast<int>(simcall.call_)];
+  }
 }
 
 namespace simgrid {
@@ -335,7 +245,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