Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
mv ActorImpl where it belongs
[simgrid.git] / src / kernel / context / ContextUnix.cpp
index 2512da7..70a87d2 100644 (file)
-/* Copyright (c) 2009-2017. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2009-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. */
 
 /* \file UContext.cpp Context switching with ucontexts from System V        */
 
-#include <ucontext.h>           /* context relative declarations */
+#include "context_private.hpp"
 
 #include "mc/mc.h"
-#include "src/mc/mc_ignore.h"
-#include "src/simix/ActorImpl.hpp"
+#include "simgrid/Exception.hpp"
+#include "src/kernel/actor/ActorImpl.hpp"
+#include "src/mc/mc_ignore.hpp"
 #include "src/simix/smx_private.hpp"
-#include "xbt/parmap.hpp"
 
-/** Many integers are needed to store a pointer
- *
- * This is a bit paranoid about sizeof(smx_ctx_sysv_t) not being a multiple
- * of sizeof(int), but it doesn't harm. */
-#define CTX_ADDR_LEN                            \
-  (sizeof(void*) / sizeof(int) +       \
-   !!(sizeof(void*) % sizeof(int)))
-
-/** A better makecontext
- *
- * Makecontext expects integer arguments, we the context
- * variable is decomposed into a serie of integers and
- * each integer is passed as argument to makecontext. */
-static void simgrid_makecontext(ucontext_t* ucp, void (*func)(int first, ...), void* arg)
-{
-  int ctx_addr[CTX_ADDR_LEN];
-  memcpy(ctx_addr, &arg, sizeof(void*));
-  switch (CTX_ADDR_LEN) {
-  case 1:
-    makecontext(ucp, (void (*)())func, 1, ctx_addr[0]);
-    break;
-  case 2:
-    makecontext(ucp, (void (*)()) func, 2, ctx_addr[0], ctx_addr[1]);
-    break;
-  default:
-    xbt_die("Ucontexts are not supported on this arch yet (addr len = %zu/%zu = %zu)", sizeof(void*), sizeof(int), CTX_ADDR_LEN);
-  }
-}
+#include "ContextUnix.hpp"
 
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
 
-namespace simgrid {
-namespace kernel {
-namespace context {
-  class UContext;
-  class SerialUContext;
-  class ParallelUContext;
-  class UContextFactory;
-}}}
-
-#if HAVE_THREAD_CONTEXTS
-static simgrid::xbt::Parmap<smx_actor_t>* sysv_parmap;
-static simgrid::kernel::context::UContext** sysv_workers_context; /* space to save the worker's context
-                                                                   * in each thread */
-static uintptr_t sysv_threads_working;     /* number of threads that have started their work */
-static xbt_os_thread_key_t sysv_worker_id_key; /* thread-specific storage for the thread id */
-#endif
-static unsigned long sysv_process_index = 0;   /* index of the next process to run in the
-                                                * list of runnable processes */
-static simgrid::kernel::context::UContext* sysv_maestro_context;
-static bool sysv_parallel;
-
-// The name of this function is currently hardcoded in the code (as string).
-// Do not change it without fixing those references as well.
-static void smx_ctx_sysv_wrapper(int first, ...);
-
-namespace simgrid {
-namespace kernel {
-namespace context {
-
-class UContext : public Context {
-private:
-  ucontext_t uc_;         /* the ucontext that executes the code */
-  char *stack_ = nullptr; /* the thread stack */
-public:
-  friend UContextFactory;
-  UContext(std::function<void()>  code,
-    void_pfn_smxprocess_t cleanup_func, smx_actor_t process);
-  ~UContext() override;
-  void stop() override;
-  static void swap(UContext* from, UContext* to) { swapcontext(&from->uc_, &to->uc_); }
-};
-
-class SerialUContext : public UContext {
-public:
-  SerialUContext(std::function<void()>  code,
-      void_pfn_smxprocess_t cleanup_func, smx_actor_t process)
-    : UContext(std::move(code), cleanup_func, process)
-  {}
-  void suspend() override;
-  void resume();
-};
+/** Up to two integers may be needed to store a pointer on the system we target */
+constexpr int CTX_ADDR_LEN = 2;
 
-class ParallelUContext : public UContext {
-public:
-  ParallelUContext(std::function<void()>  code,
-      void_pfn_smxprocess_t cleanup_func, smx_actor_t process)
-    : UContext(std::move(code), cleanup_func, process)
-  {}
-  void suspend() override;
-  void resume();
-};
+static_assert(sizeof(simgrid::kernel::context::UContext*) <= CTX_ADDR_LEN * sizeof(int),
+              "Ucontexts are not supported on this arch yet. Please increase CTX_ADDR_LEN.");
 
-class UContextFactory : public ContextFactory {
-public:
-  friend UContext;
-  friend SerialUContext;
-  friend ParallelUContext;
-
-  UContextFactory();
-  ~UContextFactory() override;
-  Context* create_context(std::function<void()> code,
-    void_pfn_smxprocess_t cleanup, smx_actor_t process) override;
-  void run_all() override;
-};
-
-XBT_PRIVATE ContextFactory* sysv_factory()
-{
-  XBT_VERB("Activating SYSV context factory");
-  return new UContextFactory();
-}
-
-UContextFactory::UContextFactory() : ContextFactory("UContextFactory")
-{
-  if (SIMIX_context_is_parallel()) {
-    sysv_parallel = true;
-#if HAVE_THREAD_CONTEXTS  /* To use parallel ucontexts a thread pool is needed */
-    int nthreads = SIMIX_context_get_nthreads();
-    sysv_parmap = nullptr;
-    sysv_workers_context = new UContext*[nthreads];
-    sysv_maestro_context = nullptr;
-    xbt_os_thread_key_create(&sysv_worker_id_key);
-#else
-    THROWF(arg_error, 0, "No thread support for parallel context execution");
-#endif
-  } else {
-    sysv_parallel = false;
-  }
-}
-
-UContextFactory::~UContextFactory()
-{
-#if HAVE_THREAD_CONTEXTS
-  delete sysv_parmap;
-  delete[] sysv_workers_context;
-#endif
-}
-
-/* This function is called by maestro at the beginning of a scheduling round to get all working threads executing some stuff
- * It is much easier to understand what happens if you see the working threads as bodies that swap their soul for the
- *    ones of the simulated processes that must run.
- */
-void UContextFactory::run_all()
-{
-  if (sysv_parallel) {
-#if HAVE_THREAD_CONTEXTS
-      sysv_threads_working = 0;
-      // Parmap_apply ensures that every working thread get an index in the
-      // process_to_run array (through an atomic fetch_and_add),
-      //  and runs the smx_ctx_sysv_resume_parallel function on that index
-
-      // We lazily create the parmap because the parmap creates context
-      // with simix_global->context_factory (which might not be initialized
-      // when bootstrapping):
-      if (sysv_parmap == nullptr)
-        sysv_parmap =
-            new simgrid::xbt::Parmap<smx_actor_t>(SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
-
-      sysv_parmap->apply(
-          [](smx_actor_t process) {
-            ParallelUContext* context = static_cast<ParallelUContext*>(process->context);
-            context->resume();
-          },
-          simix_global->process_to_run);
-#else
-      xbt_die("You asked for a parallel execution, but you don't have any threads.");
-#endif
-  } else {
-    // Serial:
-    if (simix_global->process_to_run.empty())
-      return;
-
-    smx_actor_t first_process = simix_global->process_to_run.front();
-    sysv_process_index = 1;
-    SerialUContext* context = static_cast<SerialUContext*>(first_process->context);
-    context->resume();
-  }
-}
-
-Context* UContextFactory::create_context(std::function<void()> code,
-  void_pfn_smxprocess_t cleanup, smx_actor_t process)
-{
-  if (sysv_parallel)
-    return new_context<ParallelUContext>(std::move(code), cleanup, process);
-  else
-    return new_context<SerialUContext>(std::move(code), cleanup, process);
+/* Make sure that this symbol is easy to recognize by name, even on exotic platforms */
+extern "C" {
+static void smx_ctx_wrapper(int i1, int i2);
 }
 
-UContext::UContext(std::function<void()> code,
-    void_pfn_smxprocess_t cleanup_func, smx_actor_t process)
-  : Context(std::move(code), cleanup_func, process)
-{
-  /* if the user provided a function for the process then use it, otherwise it is the context for maestro */
-  if (has_code()) {
-    this->stack_ = (char*) SIMIX_context_stack_new();
-    getcontext(&this->uc_);
-    this->uc_.uc_link = nullptr;
-    this->uc_.uc_stack.ss_sp   = sg_makecontext_stack_addr(this->stack_);
-    this->uc_.uc_stack.ss_size = sg_makecontext_stack_size(smx_context_usable_stack_size);
-    simgrid_makecontext(&this->uc_, smx_ctx_sysv_wrapper, this);
-  } else {
-    if (process != nullptr && sysv_maestro_context == nullptr)
-      sysv_maestro_context = this;
-  }
-
-#if SIMGRID_HAVE_MC
-  if (MC_is_active() && has_code()) {
-    MC_register_stack_area(this->stack_, process,
-                      &(this->uc_), smx_context_usable_stack_size);
-  }
-#endif
-}
-
-UContext::~UContext()
-{
-  SIMIX_context_stack_delete(this->stack_);
-}
-
-void UContext::stop()
-{
-  Context::stop();
-  throw StopRequest();
-}
-}}} // namespace simgrid::kernel::context
-
-static void smx_ctx_sysv_wrapper(int first, ...)
+// The name of this function is currently hardcoded in MC (as string).
+// Do not change it without fixing those references as well.
+static void smx_ctx_wrapper(int i1, int i2)
 {
   // Rebuild the Context* pointer from the integers:
-  int ctx_addr[CTX_ADDR_LEN];
+  int ctx_addr[CTX_ADDR_LEN] = {i1, i2};
   simgrid::kernel::context::UContext* context;
-  ctx_addr[0] = first;
-  if (CTX_ADDR_LEN > 1) {
-    va_list ap;
-    va_start(ap, first);
-    for (unsigned i = 1; i < CTX_ADDR_LEN; i++)
-      ctx_addr[i] = va_arg(ap, int);
-    va_end(ap);
-  }
-  memcpy(&context, ctx_addr, sizeof(simgrid::kernel::context::UContext*));
+  memcpy(&context, ctx_addr, sizeof context);
 
+  ASAN_FINISH_SWITCH(nullptr, &context->asan_ctx_->asan_stack_, &context->asan_ctx_->asan_stack_size_);
   try {
     (*context)();
     context->Context::stop();
-  } catch (simgrid::kernel::context::Context::StopRequest const&) {
-    XBT_DEBUG("Caught a StopRequest");
+  } catch (simgrid::ForcefulKillException const&) {
+    XBT_DEBUG("Caught a ForcefulKillException");
+  } catch (simgrid::Exception const& e) {
+    XBT_INFO("Actor killed by an uncatched exception %s", simgrid::xbt::demangle(typeid(e).name()).get());
+    throw;
   }
+  ASAN_ONLY(context->asan_stop_ = true);
   context->suspend();
 }
 
@@ -266,101 +55,54 @@ namespace simgrid {
 namespace kernel {
 namespace context {
 
-void SerialUContext::suspend()
+// UContextFactory
+Context* UContextFactory::create_context(std::function<void()>&& code, smx_actor_t actor)
 {
-  /* determine the next context */
-  UContext* next_context = nullptr;
-  unsigned long int i = sysv_process_index++;
-
-  if (i < simix_global->process_to_run.size()) {
-    /* execute the next process */
-    XBT_DEBUG("Run next process");
-    next_context = static_cast<UContext*>(simix_global->process_to_run[i]->context);
-  } else {
-    /* all processes were run, return to maestro */
-    XBT_DEBUG("No more process to run");
-    next_context = sysv_maestro_context;
-  }
-  SIMIX_context_set_current(next_context);
-  UContext::swap(this, next_context);
+  return new_context<UContext>(std::move(code), actor, this);
 }
 
-// UContextSerial
 
-void SerialUContext::resume()
-{
-  SIMIX_context_set_current(this);
-  UContext::swap(sysv_maestro_context, this);
-}
+// UContext
 
-/** Run one particular simulated process on the current thread. */
-void ParallelUContext::resume()
+UContext::UContext(std::function<void()>&& code, smx_actor_t actor, SwappedContextFactory* factory)
+    : SwappedContext(std::move(code), actor, factory)
 {
-#if HAVE_THREAD_CONTEXTS
-  // What is my containing body?
-  uintptr_t worker_id = __sync_fetch_and_add(&sysv_threads_working, 1);
-  // Store the number of my containing body in os-thread-specific area :
-  xbt_os_thread_set_specific(sysv_worker_id_key, (void*) worker_id);
-  // Get my current soul:
-  UContext* worker_context = static_cast<UContext*>(SIMIX_context_self());
-  // Write down that this soul is hosted in that body (for now)
-  sysv_workers_context[worker_id] = worker_context;
-  // Write in simix that I switched my soul
-  SIMIX_context_set_current(this);
-   // Actually do that using the relevant library call:
-  UContext::swap(worker_context, this);
-  // No body runs that soul anymore at this point.
-  // Instead the current body took the soul of simulated process
-  // The simulated process wakes back after the call to
-  // "SIMIX_context_suspend(self->context);" within
-  // smx_process.c::SIMIX_process_yield()
+  /* if the user provided a function for the actor then use it. If not, nothing to do for maestro. */
+  if (has_code()) {
+    getcontext(&this->uc_);
+    this->uc_.uc_link = nullptr;
+    this->uc_.uc_stack.ss_sp   = sg_makecontext_stack_addr(get_stack());
+    this->uc_.uc_stack.ss_size = sg_makecontext_stack_size(smx_context_usable_stack_size);
+    // Makecontext expects integer arguments; we want to pass a pointer.
+    // This context address is decomposed into a serie of integers, which are passed as arguments to makecontext.
+
+    int ctx_addr[CTX_ADDR_LEN]{};
+    UContext* arg = this;
+    memcpy(ctx_addr, &arg, sizeof this);
+    makecontext(&this->uc_, (void (*)())smx_ctx_wrapper, 2, ctx_addr[0], ctx_addr[1]);
 
-  // From now on, the simulated processes will change their
-  // soul with the next soul to execute (in suspend_parallel, below).
-  // When nobody is to be executed in this scheduling round,
-  // the last simulated process will take back the initial
-  // soul of the current working thread
+#if SIMGRID_HAVE_MC
+    if (MC_is_active()) {
+      MC_register_stack_area(get_stack(), actor, &(this->uc_), smx_context_usable_stack_size);
+    }
 #endif
+  }
 }
 
-/** Yield
- *
- * This function is called when a simulated process wants to yield back
- * to the maestro in a blocking simcall. This naturally occurs within
- * SIMIX_context_suspend(self->context), called from SIMIX_process_yield()
- * Actually, it does not really yield back to maestro, but into the next
- * process that must be executed. If no one is to be executed, then it
- * yields to the initial soul that was in this working thread (that was
- * saved in resume_parallel).
- */
-void ParallelUContext::suspend()
+void UContext::swap_into(SwappedContext* to_)
 {
-#if HAVE_THREAD_CONTEXTS
-  /* determine the next context */
-  // Get the next soul to embody now:
-  boost::optional<smx_actor_t> next_work = sysv_parmap->next();
-  UContext* next_context;
-  if (next_work) {
-    // There is a next soul to embody (ie, a next process to resume)
-    XBT_DEBUG("Run next process");
-    next_context = static_cast<UContext*>(next_work.get()->context);
-  } else {
-    // All processes were run, go to the barrier
-    XBT_DEBUG("No more processes to run");
-    // Get back the identity of my body that was stored when starting
-    // the scheduling round
-    uintptr_t worker_id =
-        (uintptr_t) xbt_os_thread_get_specific(sysv_worker_id_key);
-    // Deduce the initial soul of that body
-    next_context = sysv_workers_context[worker_id];
-    // When given that soul, the body will wait for the next scheduling round
-  }
-
-  SIMIX_context_set_current(next_context);
-  // Get the next soul to run, either simulated or initial minion's one:
-  UContext::swap(this, next_context);
-#endif
+  UContext* to = static_cast<UContext*>(to_);
+  ASAN_ONLY(void* fake_stack = nullptr);
+  ASAN_ONLY(to->asan_ctx_ = this);
+  ASAN_START_SWITCH(this->asan_stop_ ? nullptr : &fake_stack, to->asan_stack_, to->asan_stack_size_);
+  swapcontext(&this->uc_, &to->uc_);
+  ASAN_FINISH_SWITCH(fake_stack, &this->asan_ctx_->asan_stack_, &this->asan_ctx_->asan_stack_size_);
 }
 
-}}} // namespace simgrid::kernel::context
 
+XBT_PRIVATE ContextFactory* sysv_factory()
+{
+  XBT_VERB("Activating SYSV context factory");
+  return new UContextFactory();
+}
+}}} // namespace simgrid::kernel::context