Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[sonar] Use unsigned char* for context stacks.
[simgrid.git] / src / simix / smx_global.cpp
index d61721f..2686185 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (c) 2007-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-2019. 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. */
@@ -16,7 +16,6 @@
 #include "src/kernel/activity/SynchroRaw.hpp"
 #include "src/mc/mc_record.hpp"
 #include "src/mc/mc_replay.hpp"
-#include "src/simix/smx_host_private.hpp"
 #include "src/simix/smx_private.hpp"
 #include "src/surf/StorageImpl.hpp"
 #include "src/surf/xml/platf.hpp"
 #include "src/mc/remote/Client.hpp"
 #endif
 
-#include <boost/heap/fibonacci_heap.hpp>
 
 XBT_LOG_NEW_CATEGORY(simix, "All SIMIX categories");
 XBT_LOG_NEW_DEFAULT_SUBCATEGORY(simix_kernel, simix, "Logging specific to SIMIX (kernel)");
 
 std::unique_ptr<simgrid::simix::Global> simix_global;
 
-namespace {
-typedef std::pair<double, smx_timer_t> TimerQelt;
-boost::heap::fibonacci_heap<TimerQelt, boost::heap::compare<simgrid::xbt::HeapComparator<TimerQelt>>> simix_timers;
-}
-
-/** @brief Timer datatype */
-class s_smx_timer_t {
-  double date = 0.0;
-
-public:
-  decltype(simix_timers)::handle_type handle_;
-  simgrid::xbt::Task<void()> callback;
-  double getDate() { return date; }
-  s_smx_timer_t(double date, simgrid::xbt::Task<void()> callback) : date(date), callback(std::move(callback)) {}
-};
-
 void (*SMPI_switch_data_segment)(simgrid::s4u::ActorPtr) = nullptr;
 
 bool _sg_do_verbose_exit = true;
@@ -95,7 +77,7 @@ static void segvhandler(int signum, siginfo_t* siginfo, void* /*context*/)
   std::raise(signum);
 }
 
-char sigsegv_stack[SIGSTKSZ];   /* alternate stack for SIGSEGV handler */
+unsigned char sigsegv_stack[SIGSTKSZ]; /* alternate stack for SIGSEGV handler */
 
 /**
  * Install signal handler for SIGSEGV.  Check that nobody has already installed
@@ -139,19 +121,56 @@ static void install_segvhandler()
 #endif /* _WIN32 */
 
 /********************************* SIMIX **************************************/
-double SIMIX_timer_next()
+namespace simgrid {
+namespace simix {
+
+Timer* Timer::set(double date, void (*callback)(void*), void* arg)
 {
-  return simix_timers.empty() ? -1.0 : simix_timers.top().first;
+  Timer* timer   = new Timer(date, simgrid::xbt::make_task([callback, arg]() { callback(arg); }));
+  timer->handle_ = simix_timers.emplace(std::make_pair(date, timer));
+  return timer;
 }
 
-static void kill_process(smx_actor_t process)
+Timer* Timer::set(double date, simgrid::xbt::Task<void()> callback)
 {
-  SIMIX_process_kill(process, nullptr);
+  Timer* timer   = new Timer(date, std::move(callback));
+  timer->handle_ = simix_timers.emplace(std::make_pair(date, timer));
+  return timer;
 }
 
+/** @brief cancels a timer that was added earlier */
+void Timer::remove()
+{
+  simgrid::simix::simix_timers.erase(handle_);
+  delete this;
+}
 
-namespace simgrid {
-namespace simix {
+void Global::empty_trash()
+{
+  while (not actors_to_destroy.empty()) {
+    smx_actor_t actor = &actors_to_destroy.front();
+    actors_to_destroy.pop_front();
+    XBT_DEBUG("Getting rid of %p", actor);
+    intrusive_ptr_release(actor);
+  }
+#if SIMGRID_HAVE_MC
+  xbt_dynar_reset(simix_global->dead_actors_vector);
+#endif
+}
+/**
+ * @brief Executes the actors in simix_global->actors_to_run.
+ *
+ * The actors in simix_global->actors_to_run are run (in parallel if  possible). On exit, simix_global->actors_to_run
+ * is empty, and simix_global->actors_that_ran contains the list of actors that just ran.
+ * The two lists are swapped so, be careful when using them before and after a call to this function.
+ */
+void Global::run_all_actors()
+{
+  SIMIX_context_runall();
+
+  simix_global->actors_to_run.swap(simix_global->actors_that_ran);
+  simix_global->actors_to_run.clear();
+}
 
 simgrid::config::Flag<double> breakpoint{"simix/breakpoint",
                                          "When non-negative, raise a SIGTRAP after given (simulated) time", -1.0};
@@ -179,12 +198,9 @@ void SIMIX_global_init(int *argc, char **argv)
   simgrid::mc::Client::initialize();
 #endif
 
-  if (not simix_global) {
+  if (simix_global == nullptr) {
     simix_global = std::unique_ptr<simgrid::simix::Global>(new simgrid::simix::Global());
     simix_global->maestro_process = nullptr;
-    simix_global->create_process_function = &SIMIX_process_create;
-    simix_global->kill_process_function = &kill_process;
-    simix_global->cleanup_process_function = &SIMIX_process_cleanup;
 
     surf_init(argc, argv);      /* Initialize SURF structures */
     SIMIX_context_mod_init();
@@ -201,10 +217,10 @@ void SIMIX_global_init(int *argc, char **argv)
 #endif
     /* register a function to be called by SURF after the environment creation */
     sg_platf_init();
-    simgrid::s4u::on_platform_created.connect(SIMIX_post_create_environment);
+    simgrid::s4u::on_platform_created.connect(surf_presolve);
 
     simgrid::s4u::Storage::on_creation.connect([](simgrid::s4u::Storage& storage) {
-      sg_storage_t s = simgrid::s4u::Storage::by_name(storage.get_cname());
+      sg_storage_t s = simgrid::s4u::Storage::by_name(storage.get_name());
       xbt_assert(s != nullptr, "Storage not found for name %s", storage.get_cname());
     });
   }
@@ -230,7 +246,7 @@ void SIMIX_clean()
 
   smx_cleaned = 1;
   XBT_DEBUG("SIMIX_clean called. Simulation's over.");
-  if (not simix_global->process_to_run.empty() && SIMIX_get_clock() <= 0.0) {
+  if (not simix_global->actors_to_run.empty() && SIMIX_get_clock() <= 0.0) {
     XBT_CRITICAL("   ");
     XBT_CRITICAL("The time is still 0, and you still have processes ready to run.");
     XBT_CRITICAL("It seems that you forgot to run the simulation that you setup.");
@@ -249,21 +265,21 @@ void SIMIX_clean()
 #endif
 
   /* Kill all processes (but maestro) */
-  SIMIX_process_killall(simix_global->maestro_process);
+  simix_global->maestro_process->kill_all();
   SIMIX_context_runall();
-  SIMIX_process_empty_trash();
+  simix_global->empty_trash();
 
   /* Exit the SIMIX network module */
   SIMIX_mailbox_exit();
 
-  while (not simix_timers.empty()) {
-    delete simix_timers.top().second;
-    simix_timers.pop();
+  while (not simgrid::simix::simix_timers.empty()) {
+    delete simgrid::simix::simix_timers.top().second;
+    simgrid::simix::simix_timers.pop();
   }
   /* Free the remaining data structures */
-  simix_global->process_to_run.clear();
-  simix_global->process_that_ran.clear();
-  simix_global->process_to_destroy.clear();
+  simix_global->actors_to_run.clear();
+  simix_global->actors_that_ran.clear();
+  simix_global->actors_to_destroy.clear();
   simix_global->process_list.clear();
 
 #if SIMGRID_HAVE_MC
@@ -326,12 +342,11 @@ static void SIMIX_wake_processes()
 static bool SIMIX_execute_timers()
 {
   bool result = false;
-  while (not simix_timers.empty() && SIMIX_get_clock() >= simix_timers.top().first) {
+  while (not simgrid::simix::simix_timers.empty() && SIMIX_get_clock() >= simgrid::simix::simix_timers.top().first) {
     result = true;
-    // FIXME: make the timers being real callbacks
-    // (i.e. provide dispatchers that read and expand the args)
-    smx_timer_t timer = simix_timers.top().second;
-    simix_timers.pop();
+    // FIXME: make the timers being real callbacks (i.e. provide dispatchers that read and expand the args)
+    smx_timer_t timer = simgrid::simix::simix_timers.top().second;
+    simgrid::simix::simix_timers.pop();
     try {
       timer->callback();
     } catch (...) {
@@ -353,10 +368,9 @@ static bool SIMIX_execute_tasks()
   if (simix_global->tasks.empty())
     return false;
 
-  using std::swap;
   do {
     // We don't want the callbacks to modify the vector we are iterating over:
-    swap(simix_global->tasks, simix_global->tasksTemp);
+    simix_global->tasks.swap(simix_global->tasksTemp);
 
     // Execute all the queued tasks:
     for (auto& task : simix_global->tasksTemp)
@@ -382,7 +396,7 @@ void SIMIX_run()
   double time = 0;
 
   do {
-    XBT_DEBUG("New Schedule Round; size(queue)=%zu", simix_global->process_to_run.size());
+    XBT_DEBUG("New Schedule Round; size(queue)=%zu", simix_global->actors_to_run.size());
 
     if (simgrid::simix::breakpoint >= 0.0 && surf_get_clock() >= simgrid::simix::breakpoint) {
       XBT_DEBUG("Breakpoint reached (%g)", simgrid::simix::breakpoint.get());
@@ -396,11 +410,11 @@ void SIMIX_run()
 
     SIMIX_execute_tasks();
 
-    while (not simix_global->process_to_run.empty()) {
-      XBT_DEBUG("New Sub-Schedule Round; size(queue)=%zu", simix_global->process_to_run.size());
+    while (not simix_global->actors_to_run.empty()) {
+      XBT_DEBUG("New Sub-Schedule Round; size(queue)=%zu", simix_global->actors_to_run.size());
 
       /* Run all processes that are ready to run, possibly in parallel */
-      SIMIX_process_runall();
+      simix_global->run_all_actors();
 
       /* answer sequentially and in a fixed arbitrary order all the simcalls that were issued during that sub-round */
 
@@ -408,21 +422,21 @@ void SIMIX_run()
 
       /* Here, the order is ok because:
        *
-       *   Short proof: only maestro adds stuff to the process_to_run array, so the execution order of user contexts do
+       *   Short proof: only maestro adds stuff to the actors_to_run array, so the execution order of user contexts do
        *   not impact its order.
        *
        *   Long proof: processes remain sorted through an arbitrary (implicit, complex but fixed) order in all cases.
        *
        *   - if there is no kill during the simulation, processes remain sorted according by their PID.
        *     Rationale: This can be proved inductively.
-       *        Assume that process_to_run is sorted at a beginning of one round (it is at round 0: the deployment file
+       *        Assume that actors_to_run is sorted at a beginning of one round (it is at round 0: the deployment file
        *        is parsed linearly).
        *        Let's show that it is still so at the end of this round.
        *        - if a process is added when being created, that's from maestro. It can be either at startup
        *          time (and then in PID order), or in response to a process_create simcall. Since simcalls are handled
        *          in arbitrary order (inductive hypothesis), we are fine.
        *        - If a process is added because it's getting killed, its subsequent actions shouldn't matter
-       *        - If a process gets added to process_to_run because one of their blocking action constituting the meat
+       *        - If a process gets added to actors_to_run because one of their blocking action constituting the meat
        *          of a simcall terminates, we're still good. Proof:
        *          - You are added from SIMIX_simcall_answer() only. When this function is called depends on the resource
        *            kind (network, cpu, disk, whatever), but the same arguments hold. Let's take communications as an
@@ -448,7 +462,7 @@ void SIMIX_run()
        *              and the argument is very similar to the previous one.
        *            So, in any case, the orders of calls to SIMIX_comm_finish() do not depend on the order in which user
        *            processes are executed.
-       *          So, in any cases, the orders of processes within process_to_run do not depend on the order in which
+       *          So, in any cases, the orders of processes within actors_to_run do not depend on the order in which
        *          user processes were executed previously.
        *     So, if there is no killing in the simulation, the simulation reproducibility is not jeopardized.
        *   - If there is some process killings, the order is changed by this decision that comes from user-land
@@ -458,13 +472,13 @@ void SIMIX_run()
        *
        *   So science works, bitches [http://xkcd.com/54/].
        *
-       *   We could sort the process_that_ran array completely so that we can describe the order in which simcalls are
+       *   We could sort the actors_that_ran array completely so that we can describe the order in which simcalls are
        *   handled (like "according to the PID of issuer"), but it's not mandatory (order is fixed already even if
        *   unfriendly).
        *   That would thus be a pure waste of time.
        */
 
-      for (smx_actor_t const& process : simix_global->process_that_ran) {
+      for (smx_actor_t const& process : simix_global->actors_that_ran) {
         if (process->simcall.call != SIMCALL_NONE) {
           SIMIX_simcall_handle(&process->simcall, 0);
         }
@@ -479,11 +493,11 @@ void SIMIX_run()
       if (simix_global->process_list.size() == simix_global->daemons.size())
         for (auto const& dmon : simix_global->daemons) {
           XBT_DEBUG("Kill %s", dmon->get_cname());
-          SIMIX_process_kill(dmon, simix_global->maestro_process);
+          simix_global->maestro_process->kill(dmon);
         }
     }
 
-    time = SIMIX_timer_next();
+    time = simgrid::simix::Timer::next();
     if (time > -1.0 || not simix_global->process_list.empty()) {
       XBT_DEBUG("Calling surf_solve");
       time = surf_solve(time);
@@ -503,13 +517,13 @@ void SIMIX_run()
       SIMIX_wake_processes();
     } while (again);
 
-    /* Clean processes to destroy */
-    SIMIX_process_empty_trash();
+    /* Clean actors to destroy */
+    simix_global->empty_trash();
 
     XBT_DEBUG("### time %f, #processes %zu, #to_run %zu", time, simix_global->process_list.size(),
-              simix_global->process_to_run.size());
+              simix_global->actors_to_run.size());
 
-  } while (time > -1.0 || not simix_global->process_to_run.empty());
+  } while (time > -1.0 || not simix_global->actors_to_run.empty());
 
   if (not simix_global->process_list.empty()) {
 
@@ -526,79 +540,33 @@ void SIMIX_run()
   simgrid::s4u::on_simulation_end();
 }
 
-/**
- *   @brief Set the date to execute a function
- *
- * Set the date to execute the function on the surf.
- *   @param date Date to execute function
- *   @param callback Function to be executed
- *   @param arg Parameters of the function
- *
- */
+double SIMIX_timer_next()
+{
+  return simgrid::simix::Timer::next();
+}
+
 smx_timer_t SIMIX_timer_set(double date, void (*callback)(void*), void *arg)
 {
-  smx_timer_t timer = new s_smx_timer_t(date, simgrid::xbt::make_task([callback, arg]() { callback(arg); }));
-  timer->handle_    = simix_timers.emplace(std::make_pair(date, timer));
-  return timer;
+  return simgrid::simix::Timer::set(date, callback, arg);
 }
 
 smx_timer_t SIMIX_timer_set(double date, simgrid::xbt::Task<void()> callback)
 {
-  smx_timer_t timer = new s_smx_timer_t(date, std::move(callback));
-  timer->handle_    = simix_timers.emplace(std::make_pair(date, timer));
+  smx_timer_t timer = new simgrid::simix::Timer(date, std::move(callback));
+  timer->handle_    = simgrid::simix::simix_timers.emplace(std::make_pair(date, timer));
   return timer;
 }
 
 /** @brief cancels a timer that was added earlier */
 void SIMIX_timer_remove(smx_timer_t timer) {
-  simix_timers.erase(timer->handle_);
-  delete timer;
+  timer->remove();
 }
 
 /** @brief Returns the date at which the timer will trigger (or 0 if nullptr timer) */
 double SIMIX_timer_get_date(smx_timer_t timer) {
-  return timer ? timer->getDate() : 0;
-}
-
-/**
- * @brief Registers a function to create a process.
- *
- * This function registers a function to be called
- * when a new process is created. The function has
- * to call SIMIX_process_create().
- * @param function create process function
- */
-void SIMIX_function_register_process_create(smx_creation_func_t function)
-{
-  simix_global->create_process_function = function;
-}
-
-/**
- * @brief Registers a function to kill a process.
- *
- * This function registers a function to be called when a process is killed. The function has to call the
- * SIMIX_process_kill().
- *
- * @param function Kill process function
- */
-void SIMIX_function_register_process_kill(void_pfn_smxprocess_t function)
-{
-  simix_global->kill_process_function = function;
-}
-
-/**
- * @brief Registers a function to cleanup a process.
- *
- * This function registers a user function to be called when a process ends properly.
- *
- * @param function cleanup process function
- */
-void SIMIX_function_register_process_cleanup(void_pfn_smxprocess_t function)
-{
-  simix_global->cleanup_process_function = function;
+  return timer ? timer->get_date() : 0;
 }
 
-
 void SIMIX_display_process_status()
 {
   int nbprocess = simix_global->process_list.size();
@@ -628,12 +596,13 @@ void SIMIX_display_process_status()
       if (boost::dynamic_pointer_cast<simgrid::kernel::activity::IoImpl>(process->waiting_synchro) != nullptr)
         synchro_description = "I/O";
 
-      XBT_INFO("Process %ld (%s@%s): waiting for %s synchro %p (%s) in state %d to finish", process->pid_,
-               process->get_cname(), process->host_->get_cname(), synchro_description, process->waiting_synchro.get(),
-               process->waiting_synchro->name_.c_str(), (int)process->waiting_synchro->state_);
+      XBT_INFO("Process %ld (%s@%s): waiting for %s synchro %p (%s) in state %d to finish", process->get_pid(),
+               process->get_cname(), process->get_host()->get_cname(), synchro_description,
+               process->waiting_synchro.get(), process->waiting_synchro->get_cname(),
+               (int)process->waiting_synchro->state_);
     }
     else {
-      XBT_INFO("Process %ld (%s@%s)", process->pid_, process->get_cname(), process->host_->get_cname());
+      XBT_INFO("Process %ld (%s@%s)", process->get_pid(), process->get_cname(), process->get_host()->get_cname());
     }
   }
 }