Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
factorize where seq_runall and par_runall save maestro context
[simgrid.git] / src / kernel / context / ContextRaw.cpp
index 600e935..8d320a1 100644 (file)
@@ -1,98 +1,17 @@
-/* Copyright (c) 2009-2015. The SimGrid Team.
- * All rights reserved.                                                     */
+/* Copyright (c) 2009-2018. 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 <math.h>
-
-#include <utility>
-#include <functional>
-
-#include "src/internal_config.h" 
-
-#include "xbt/log.h"
-#include "xbt/parmap.h"
-#include "xbt/dynar.h"
-
-#include "src/simix/smx_private.h"
+#include "ContextRaw.hpp"
+#include "context_private.hpp"
 #include "mc/mc.h"
+#include "simgrid/Exception.hpp"
+#include "src/simix/smx_private.hpp"
 
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
 
-// ***** Class definitions
-
-namespace simgrid {
-namespace simix {
-
-class RawContext;
-class RawContextFactory;
-
-/** @brief Fast context switching inspired from SystemV ucontexts.
-  *
-  * The main difference to the System V context is that Raw Contexts are much faster because they don't 
-  * preserve the signal mask when switching. This saves a system call (at least on Linux) on each context switch.
-  */
-class RawContext : public Context {
-protected:
-  void* stack_ = nullptr; 
-  /** pointer to top the stack stack */
-  void* stack_top_ = nullptr;
-public:
-  friend class RawContextFactory;
-  RawContext(std::function<void()> code,
-          void_pfn_smxprocess_t cleanup_func,
-          smx_process_t process);
-  ~RawContext() override;
-public:
-  static void wrapper(void* arg);
-  void stop() override;
-  void suspend() override;
-  void resume();
-private:
-  void suspend_serial();
-  void suspend_parallel();
-  void resume_serial();
-  void resume_parallel();
-};
-
-class RawContextFactory : public ContextFactory {
-public:
-  RawContextFactory();
-  ~RawContextFactory() override;
-  RawContext* create_context(std::function<void()> code,
-    void_pfn_smxprocess_t cleanup, smx_process_t process) override;
-  void run_all() override;
-private:
-  void run_all_adaptative();
-  void run_all_serial();
-  void run_all_parallel();
-};
-
-ContextFactory* raw_factory()
-{
-  XBT_VERB("Using raw contexts. Because the glibc is just not good enough for us.");
-  return new RawContextFactory();
-}
-
-}
-}
-
-// ***** Loads of static stuff
-
-#if HAVE_THREAD_CONTEXTS
-static xbt_parmap_t raw_parmap;
-static simgrid::simix::RawContext** raw_workers_context;    /* space to save the worker context in each thread */
-static uintptr_t raw_threads_working;     /* number of threads that have started their work */
-static xbt_os_thread_key_t raw_worker_id_key; /* thread-specific storage for the thread id */
-#endif
-static unsigned long raw_process_index = 0;   /* index of the next process to run in the
-                                               * list of runnable processes */
-static simgrid::simix::RawContext* raw_maestro_context;
-
-static bool raw_context_parallel = false;
-
-// ***** Raw context routines
+// Raw context routines
 
 typedef void (*rawctx_entry_point_t)(void *);
 
@@ -262,214 +181,68 @@ void raw_swapcontext(raw_stack_t* old, raw_stack_t new_context) {
 // ***** Method definitions
 
 namespace simgrid {
-namespace simix {
-
-RawContextFactory::RawContextFactory()
-  : ContextFactory("RawContextFactory")
-{
-  raw_context_parallel = SIMIX_context_is_parallel();
-  if (raw_context_parallel) {
-#if HAVE_THREAD_CONTEXTS
-    int nthreads = SIMIX_context_get_nthreads();
-    xbt_os_thread_key_create(&raw_worker_id_key);
-    // TODO, lazily init
-    raw_parmap = nullptr;
-    raw_workers_context = xbt_new(RawContext*, nthreads);
-    raw_maestro_context = nullptr;
-#endif
-    // TODO, if(SIMIX_context_get_parallel_threshold() > 1) => choose dynamically
-  }
-}
+namespace kernel {
+namespace context {
 
-RawContextFactory::~RawContextFactory()
-{
-#if HAVE_THREAD_CONTEXTS
-  if (raw_parmap)
-    xbt_parmap_destroy(raw_parmap);
-  xbt_free(raw_workers_context);
-#endif
-}
+// RawContextFactory
 
-RawContext* RawContextFactory::create_context(std::function<void()> code,
-    void_pfn_smxprocess_t cleanup, smx_process_t process)
+Context* RawContextFactory::create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup_func,
+                                           smx_actor_t process)
 {
-  return this->new_context<RawContext>(std::move(code),
-    cleanup, process);
+  return this->new_context<RawContext>(std::move(code), cleanup_func, process, this);
 }
 
-void RawContext::wrapper(void* arg)
-{
-  RawContext* context = (RawContext*) arg;
-  (*context)();
-  context->stop();
-}
+// RawContext
 
-RawContext::RawContext(std::function<void()> code,
-    void_pfn_smxprocess_t cleanup, smx_process_t process)
-  : Context(std::move(code), cleanup, process)
+RawContext::RawContext(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t process,
+                       SwappedContextFactory* factory)
+    : SwappedContext(std::move(code), cleanup, process, factory)
 {
    if (has_code()) {
-     this->stack_ = SIMIX_context_stack_new();
-     this->stack_top_ = raw_makecontext(this->stack_,
-                         smx_context_usable_stack_size,
-                         RawContext::wrapper,
-                         this);
+#if PTH_STACKGROWTH == -1
+     ASAN_ONLY(this->asan_stack_ = static_cast<char*>(this->stack_) + smx_context_usable_stack_size);
+#else
+     ASAN_ONLY(this->asan_stack_ = this->stack_);
+#endif
+     this->stack_top_ = raw_makecontext(this->stack_, smx_context_usable_stack_size, RawContext::wrapper, this);
    } else {
-     if(process != nullptr && raw_maestro_context == nullptr)
-       raw_maestro_context = this;
+     set_maestro(this); // save maestro for run_all()
      if (MC_is_active())
-       MC_ignore_heap(
-         &raw_maestro_context->stack_top_,
-         sizeof(raw_maestro_context->stack_top_));
+       MC_ignore_heap(&stack_top_, sizeof(stack_top_));
    }
 }
 
-RawContext::~RawContext()
-{
-  SIMIX_context_stack_delete(this->stack_);
-}
-
-void RawContext::stop()
-{
-  Context::stop();
-  this->suspend();
-}
-
-void RawContextFactory::run_all()
-{
-  if (raw_context_parallel)
-    run_all_parallel();
-  else
-    run_all_serial();
-}
-
-void RawContextFactory::run_all_serial()
-{
-  smx_process_t first_process =
-      xbt_dynar_get_as(simix_global->process_to_run, 0, smx_process_t);
-  raw_process_index = 1;
-  static_cast<RawContext*>(first_process->context)->resume_serial();
-}
-
-void RawContextFactory::run_all_parallel()
-{
-#if HAVE_THREAD_CONTEXTS
-  raw_threads_working = 0;
-  if (raw_parmap == nullptr)
-    raw_parmap = xbt_parmap_new(
-      SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
-  xbt_parmap_apply(raw_parmap,
-      [](void* arg) {
-        smx_process_t process = static_cast<smx_process_t>(arg);
-        RawContext* context = static_cast<RawContext*>(process->context);
-        context->resume_parallel();
-      },
-      simix_global->process_to_run);
-#else
-  xbt_die("You asked for a parallel execution, but you don't have any threads.");
-#endif
-}
-
-void RawContext::suspend()
-{
-  if (raw_context_parallel)
-    RawContext::suspend_parallel();
-  else
-    RawContext::suspend_serial();
-}
-
-void RawContext::suspend_serial()
-{
-  /* determine the next context */
-  RawContext* next_context = nullptr;
-  unsigned long int i;
-  i = raw_process_index++;
-  if (i < xbt_dynar_length(simix_global->process_to_run)) {
-    /* execute the next process */
-    XBT_DEBUG("Run next process");
-    next_context = (RawContext*) xbt_dynar_get_as(
-        simix_global->process_to_run, i, smx_process_t)->context;
-  }
-  else {
-    /* all processes were run, return to maestro */
-    XBT_DEBUG("No more process to run");
-    next_context = (RawContext*) raw_maestro_context;
-  }
-  SIMIX_context_set_current(next_context);
-  raw_swapcontext(&this->stack_top_, next_context->stack_top_);
-}
-
-void RawContext::suspend_parallel()
+void RawContext::wrapper(void* arg)
 {
-#if HAVE_THREAD_CONTEXTS
-  /* determine the next context */
-  smx_process_t next_work = (smx_process_t) xbt_parmap_next(raw_parmap);
-  RawContext* next_context = nullptr;
-
-  if (next_work != nullptr) {
-    /* there is a next process to resume */
-    XBT_DEBUG("Run next process");
-    next_context = (RawContext*) next_work->context;
+  RawContext* context = static_cast<RawContext*>(arg);
+  ASAN_FINISH_SWITCH(nullptr, &context->asan_ctx_->asan_stack_, &context->asan_ctx_->asan_stack_size_);
+  try {
+    (*context)();
+  } catch (StopRequest const&) {
+    XBT_DEBUG("Caught a StopRequest");
+  } catch (simgrid::Exception const& e) {
+    XBT_INFO("Actor killed by an uncatched exception %s", simgrid::xbt::demangle(typeid(e).name()).get());
+    throw;
   }
-  else {
-    /* all processes were run, go to the barrier */
-    XBT_DEBUG("No more processes to run");
-    uintptr_t worker_id = (uintptr_t)
-      xbt_os_thread_get_specific(raw_worker_id_key);
-    next_context = (RawContext*) raw_workers_context[worker_id];
-    XBT_DEBUG("Restoring worker stack %zu (working threads = %zu)",
-        worker_id, raw_threads_working);
-  }
-
-  SIMIX_context_set_current(next_context);
-  raw_swapcontext(&this->stack_top_, next_context->stack_top_);
-#endif
-}
+  context->Context::stop();
 
-void RawContext::resume()
-{
-  if (raw_context_parallel)
-    resume_parallel();
-  else
-    resume_serial();
+  ASAN_ONLY(context->asan_stop_ = true);
+  context->suspend();
 }
 
-void RawContext::resume_serial()
+void RawContext::swap_into(SwappedContext* to_)
 {
-  SIMIX_context_set_current(this);
-  raw_swapcontext(&raw_maestro_context->stack_top_, this->stack_top_);
+  RawContext* to = static_cast<RawContext*>(to_);
+  ASAN_ONLY(void* fake_stack = nullptr);
+  ASAN_ONLY(to->asan_ctx_ = from);
+  ASAN_START_SWITCH(from->asan_stop_ ? nullptr : &fake_stack, to->asan_stack_, to->asan_stack_size_);
+  raw_swapcontext(&this->stack_top_, to->stack_top_);
+  ASAN_FINISH_SWITCH(fake_stack, &from->asan_ctx_->asan_stack_, &from->asan_ctx_->asan_stack_size_);
 }
 
-void RawContext::resume_parallel()
-{
-#if HAVE_THREAD_CONTEXTS
-  uintptr_t worker_id = __sync_fetch_and_add(&raw_threads_working, 1);
-  xbt_os_thread_set_specific(raw_worker_id_key, (void*) worker_id);
-  RawContext* worker_context = (RawContext*) SIMIX_context_self();
-  raw_workers_context[worker_id] = worker_context;
-  XBT_DEBUG("Saving worker stack %zu", worker_id);
-  SIMIX_context_set_current(this);
-  raw_swapcontext(&worker_context->stack_top_, this->stack_top_);
-#else
-  xbt_die("Parallel execution disabled");
-#endif
-}
-
-/** @brief Resumes all processes ready to run. */
-void RawContextFactory::run_all_adaptative()
+ContextFactory* raw_factory()
 {
-  unsigned long nb_processes = xbt_dynar_length(simix_global->process_to_run);
-  if (SIMIX_context_is_parallel()
-    && (unsigned long) SIMIX_context_get_parallel_threshold() < nb_processes) {
-        raw_context_parallel = true;
-        XBT_DEBUG("Runall // %lu", nb_processes);
-        this->run_all_parallel();
-    } else {
-        XBT_DEBUG("Runall serial %lu", nb_processes);
-        raw_context_parallel = false;
-        this->run_all_serial();
-    }
-}
-
-}
+  XBT_VERB("Using raw contexts. Because the glibc is just not good enough for us.");
+  return new RawContextFactory();
 }
+}}}