Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Make sthread_inside_simgrid static into libsthread in the (vain) hope that it'll...
[simgrid.git] / src / kernel / context / Context.cpp
index c28bf7b..6827ff9 100644 (file)
-/* Copyright (c) 2007-2019. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2007-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/Exception.hpp"
 #include "simgrid/s4u/Host.hpp"
 #include "src/kernel/activity/CommImpl.hpp"
 #include "src/kernel/context/Context.hpp"
-#include "src/simix/smx_private.hpp"
+#include "src/sthread/sthread.h"
 #include "src/surf/surf_interface.hpp"
 
-XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
+#include <vector>
+
+XBT_LOG_NEW_DEFAULT_SUBCATEGORY(ker_context, kernel, "Context switching mechanism");
+
+namespace simgrid::kernel::context {
+
+std::function<ContextFactory*(void)> ContextFactory::initializer;
+
+static e_xbt_parmap_mode_t parallel_synchronization_mode = XBT_PARMAP_DEFAULT;
+static int parallel_contexts                             = 1;
+unsigned stack_size;
+unsigned guard_size;
+
+/** @brief Returns whether some parallel threads are used for the user contexts. */
+bool is_parallel()
+{
+  return parallel_contexts > 1;
+}
 
 /**
- * @brief creates a new context for a user level process
- * @param code a main function
- * @param cleanup_func the function to call when the context stops
- * @param simix_process
+ * @brief Returns the number of parallel threads used for the user contexts.
+ * @return the number of threads (1 means no parallelism)
  */
-smx_context_t SIMIX_context_new(
-  std::function<void()> code,
-  void_pfn_smxprocess_t cleanup_func,
-  smx_actor_t simix_process)
+int get_nthreads()
 {
-  return simix_global->context_factory->create_context(
-    std::move(code), cleanup_func, simix_process);
+  return parallel_contexts;
 }
 
-namespace simgrid {
-namespace kernel {
-namespace context {
+/**
+ * @brief Sets the number of parallel threads to use  for the user contexts.
+ *
+ * This function should be called before initializing SIMIX.
+ * A value of 1 means no parallelism (1 thread only).
+ * If the value is greater than 1, the thread support must be enabled.
+ *
+ * @param nb_threads the number of threads to use
+ */
+void set_nthreads(int nb_threads)
+{
+  if (nb_threads <= 0) {
+    nb_threads = std::thread::hardware_concurrency();
+    XBT_INFO("Auto-setting contexts/nthreads to %d", nb_threads);
+  }
+  parallel_contexts = nb_threads;
+}
 
-ContextFactoryInitializer factory_initializer = nullptr;
+/**
+ * @brief Sets the synchronization mode to use when actors are run in parallel.
+ * @param mode how to synchronize threads if actors are run in parallel
+ */
+void set_parallel_mode(e_xbt_parmap_mode_t mode)
+{
+  parallel_synchronization_mode = mode;
+}
+
+/**
+ * @brief Returns the synchronization mode used when actors are run in parallel.
+ * @return how threads are synchronized if actors are run in parallel
+ */
+e_xbt_parmap_mode_t get_parallel_mode()
+{
+  return parallel_synchronization_mode;
+}
 
 ContextFactory::~ContextFactory() = default;
 
-static thread_local smx_context_t smx_current_context = nullptr;
+thread_local Context* Context::current_context_ = nullptr;
+
+#ifndef WIN32
+/* Install or disable alternate signal stack, for SIGSEGV handler. */
+int Context::install_sigsegv_stack(stack_t* old_stack, bool enable)
+{
+  static std::vector<unsigned char> sigsegv_stack(SIGSTKSZ);
+  stack_t stack;
+  stack.ss_sp    = sigsegv_stack.data();
+  stack.ss_size  = sigsegv_stack.size();
+  stack.ss_flags = enable ? 0 : SS_DISABLE;
+  return sigaltstack(&stack, old_stack);
+}
+#endif
+
 Context* Context::self()
 {
-  return smx_current_context;
+  return current_context_;
 }
 void Context::set_current(Context* self)
 {
-  smx_current_context = self;
+  current_context_ = self;
 }
 
 void Context::declare_context(std::size_t size)
@@ -55,24 +111,23 @@ void Context::declare_context(std::size_t size)
 #endif
 }
 
-Context* ContextFactory::attach(void_pfn_smxprocess_t, smx_actor_t)
+Context* ContextFactory::attach(actor::ActorImpl*)
 {
   xbt_die("Cannot attach with this ContextFactory.\n"
     "Try using --cfg=contexts/factory:thread instead.\n");
 }
 
-Context* ContextFactory::create_maestro(std::function<void()>, smx_actor_t)
+Context* ContextFactory::create_maestro(std::function<void()>&&, actor::ActorImpl*)
 {
   xbt_die("Cannot create_maestro with this ContextFactory.\n"
     "Try using --cfg=contexts/factory:thread instead.\n");
 }
 
-Context::Context(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t actor)
-    : code_(std::move(code)), cleanup_func_(cleanup_func), actor_(actor)
+Context::Context(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro)
+    : code_(std::move(code)), actor_(actor), is_maestro_(maestro)
 {
-  /* If no function was provided, this is the context for maestro
-   * and we should set it as the current context */
-  if (not has_code())
+  /* If we are creating maestro, we should set it as the current context */
+  if (maestro)
     set_current(this);
 }
 
@@ -84,68 +139,10 @@ Context::~Context()
 
 void Context::stop()
 {
-  actor_->finished_ = true;
-
-  if (actor_->auto_restart_ && actor_->host_->is_off()) {
-    XBT_DEBUG("Insert host %s to watched_hosts because it's off and %s needs to restart", actor_->host_->get_cname(),
-              actor_->get_cname());
-    watched_hosts.insert(actor_->host_->get_cname());
-  }
-
-  actor_->finished_ = true;
-
-  // Execute the termination callbacks
-  smx_process_exit_status_t exit_status = (actor_->context_->iwannadie) ? SMX_EXIT_FAILURE : SMX_EXIT_SUCCESS;
-  while (not actor_->on_exit.empty()) {
-    s_smx_process_exit_fun_t exit_fun = actor_->on_exit.back();
-    actor_->on_exit.pop_back();
-    (exit_fun.fun)(exit_status, exit_fun.arg);
-  }
-
-  /* cancel non-blocking activities */
-  for (auto activity : actor_->comms)
-    boost::static_pointer_cast<activity::CommImpl>(activity)->cancel();
-  actor_->comms.clear();
-
-  XBT_DEBUG("%s@%s(%ld) should not run anymore", actor_->get_cname(), actor_->iface()->get_host()->get_cname(),
-            actor_->pid_);
-
-  if (this->cleanup_func_)
-    this->cleanup_func_(this->actor_);
-
-  this->iwannadie = false; // don't let the simcall's yield() do a Context::stop(), because that's me
-  simgrid::simix::simcall([this] {
-    simgrid::s4u::Actor::on_destruction(actor_->iface());
-    SIMIX_process_cleanup(actor_);
-  });
-  this->iwannadie = true;
+  this->actor_->cleanup_from_self();
+  sthread_disable();
+  throw ForcefulKillException(); // clean RAII variables with the dedicated exception
 }
-
 AttachContext::~AttachContext() = default;
 
-StopRequest::~StopRequest() = default;
-
-void StopRequest::do_throw()
-{
-  throw StopRequest();
-}
-
-bool StopRequest::try_n_catch(std::function<void(void)> try_block)
-{
-  bool res;
-  try {
-    try_block();
-    res = true;
-  } catch (StopRequest const&) {
-    XBT_DEBUG("Caught a StopRequest");
-    res = false;
-  }
-  return res;
-}
-}}}
-
-/** @brief Executes all the processes to run (in parallel if possible). */
-void SIMIX_context_runall()
-{
-  simix_global->context_factory->run_all();
-}
+} // namespace simgrid::kernel::context