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 / ContextBoost.cpp
index 8fe39e2..050267c 100644 (file)
@@ -1,22 +1,12 @@
-/* Copyright (c) 2015. The SimGrid Team. All rights reserved.               */
+/* Copyright (c) 2015-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 <cstdint>
-
-#include <functional>
-#include <utility>
-#include <vector>
-
-#include <boost/context/all.hpp>
-
-#include <xbt/log.h>
-#include <xbt/xbt_os_thread.h>
-
-#include "src/simix/smx_private.h"
-#include "src/internal_config.h"
-#include "src/kernel/context/ContextBoost.hpp"
+#include "ContextBoost.hpp"
+#include "context_private.hpp"
+#include "simgrid/Exception.hpp"
+#include "src/simix/smx_private.hpp"
 
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
 
@@ -24,272 +14,97 @@ namespace simgrid {
 namespace kernel {
 namespace context {
 
-class BoostSerialContext : public BoostContext {
-public:
-  BoostSerialContext(std::function<void()> code,
-      void_pfn_smxprocess_t cleanup_func,
-      smx_actor_t process)
-    : BoostContext(std::move(code), cleanup_func, process) {}
-  void stop() override;
-  void suspend() override;
-};
-
-#if HAVE_THREAD_CONTEXTS
-class BoostParallelContext : public BoostContext {
-public:
-  BoostParallelContext(std::function<void()> code,
-      void_pfn_smxprocess_t cleanup_func,
-      smx_actor_t process)
-    : BoostContext(std::move(code), cleanup_func, process) {}
-  void stop() override;
-  void suspend() override;
-  void resume() override;
-};
-#endif
-
 // BoostContextFactory
-
-bool                BoostContext::parallel_        = false;
-xbt_parmap_t        BoostContext::parmap_          = nullptr;
-uintptr_t           BoostContext::threads_working_ = 0;
-xbt_os_thread_key_t BoostContext::worker_id_key_;
-unsigned long       BoostContext::process_index_   = 0;
-BoostContext*       BoostContext::maestro_context_ = nullptr;
-std::vector<BoostContext*> BoostContext::workers_context_;
-
-BoostContextFactory::BoostContextFactory()
-  : ContextFactory("BoostContextFactory")
+smx_context_t BoostContextFactory::create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup_func,
+                                                  smx_actor_t process)
 {
-  BoostContext::parallel_ = SIMIX_context_is_parallel();
-  if (BoostContext::parallel_) {
-#if !HAVE_THREAD_CONTEXTS
-    xbt_die("No thread support for parallel context execution");
-#else
-    int nthreads = SIMIX_context_get_nthreads();
-    BoostContext::parmap_ = xbt_parmap_new(nthreads, SIMIX_context_get_parallel_mode());
-    BoostContext::workers_context_.clear();
-    BoostContext::workers_context_.resize(nthreads, nullptr);
-    BoostContext::maestro_context_ = nullptr;
-    xbt_os_thread_key_create(&BoostContext::worker_id_key_);
-#endif
-  }
-}
-
-BoostContextFactory::~BoostContextFactory()
-{
-#if HAVE_THREAD_CONTEXTS
-  if (BoostContext::parmap_) {
-    xbt_parmap_destroy(BoostContext::parmap_);
-    BoostContext::parmap_ = nullptr;
-  }
-  BoostContext::workers_context_.clear();
-#endif
+  return this->new_context<BoostContext>(std::move(code), cleanup_func, process, this);
 }
 
-smx_context_t BoostContextFactory::create_context(std::function<void()>  code,
-  void_pfn_smxprocess_t cleanup_func, smx_actor_t process)
-{
-  BoostContext* context = nullptr;
-  if (BoostContext::parallel_)
-#if HAVE_THREAD_CONTEXTS
-    context = this->new_context<BoostParallelContext>(
-      std::move(code), cleanup_func, process);
-#else
-    xbt_die("No support for parallel execution");
-#endif
-  else
-    context = this->new_context<BoostSerialContext>(
-      std::move(code), cleanup_func, process);
-  return context;
-}
-
-void BoostContextFactory::run_all()
-{
-#if HAVE_THREAD_CONTEXTS
-  if (BoostContext::parallel_) {
-    BoostContext::threads_working_ = 0;
-    xbt_parmap_apply(BoostContext::parmap_,
-      [](void* arg) {
-        smx_actor_t process = static_cast<smx_actor_t>(arg);
-        BoostContext* context  = static_cast<BoostContext*>(process->context);
-        return context->resume();
-      },
-      simix_global->process_to_run);
-  } else
-#endif
-  {
-    if (xbt_dynar_is_empty(simix_global->process_to_run))
-      return;
-    smx_actor_t first_process =
-        xbt_dynar_get_as(simix_global->process_to_run, 0, smx_actor_t);
-    BoostContext::process_index_ = 1;
-    /* execute the first process */
-    static_cast<BoostContext*>(first_process->context)->resume();
-  }
-}
-
-
 // BoostContext
 
-static void smx_ctx_boost_wrapper(std::intptr_t arg)
-{
-  BoostContext* context = (BoostContext*) arg;
-  (*context)();
-  context->stop();
-}
-
-BoostContext::BoostContext(std::function<void()> code,
-    void_pfn_smxprocess_t cleanup_func, smx_actor_t process)
-  : Context(std::move(code), cleanup_func, process)
+BoostContext::BoostContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process,
+                           SwappedContextFactory* factory)
+    : SwappedContext(std::move(code), cleanup_func, process, factory)
 {
 
-  /* if the user provided a function for the process then use it,
-     otherwise it is the context for maestro */
+  /* if the user provided a function for the process then use it, otherwise it is the context for maestro */
   if (has_code()) {
-    this->stack_ = SIMIX_context_stack_new();
-    // We need to pass the bottom of the stack to make_fcontext,
-    // depending on the stack direction it may be the lower or higher address:
-  #if PTH_STACKGROWTH == -1
-    void* stack = (char*) this->stack_ + smx_context_usable_stack_size - 1;
-  #else
+    /* We need to pass the bottom of the stack to make_fcontext,
+       depending on the stack direction it may be the lower or higher address: */
+#if PTH_STACKGROWTH == -1
+    void* stack = static_cast<char*>(this->stack_) + smx_context_usable_stack_size;
+#else
     void* stack = this->stack_;
-  #endif
-    this->fc_ = boost::context::make_fcontext(
-                      stack,
-                      smx_context_usable_stack_size,
-                      smx_ctx_boost_wrapper);
+#endif
+    ASAN_ONLY(this->asan_stack_ = stack);
+#if BOOST_VERSION < 106100
+    this->fc_ = boost::context::make_fcontext(stack, smx_context_usable_stack_size, BoostContext::wrapper);
+#else
+    this->fc_ = boost::context::detail::make_fcontext(stack, smx_context_usable_stack_size, BoostContext::wrapper);
+#endif
+
   } else {
-    #if HAVE_BOOST_CONTEXTS == 1
+    set_maestro(this); // save maestro for run_all()
+#if BOOST_VERSION < 105600
     this->fc_ = new boost::context::fcontext_t();
-    #endif
-    if (BoostContext::maestro_context_ == nullptr)
-      BoostContext::maestro_context_ = this;
+#endif
   }
 }
 
 BoostContext::~BoostContext()
 {
-#if HAVE_BOOST_CONTEXTS == 1
-  if (!this->stack_)
+#if BOOST_VERSION < 105600
+  if (not this->stack_)
     delete this->fc_;
 #endif
-  if (this == maestro_context_)
-    maestro_context_ = nullptr;
-  SIMIX_context_stack_delete(this->stack_);
 }
 
-// BoostSerialContext
-
-void BoostContext::resume()
+void BoostContext::wrapper(BoostContext::arg_type arg)
 {
-  SIMIX_context_set_current(this);
-#if HAVE_BOOST_CONTEXTS == 1
-  boost::context::jump_fcontext(
-    maestro_context_->fc_, this->fc_,
-    (intptr_t) this);
+#if BOOST_VERSION < 106100
+  BoostContext* context = reinterpret_cast<BoostContext*>(arg);
 #else
-  boost::context::jump_fcontext(
-    &maestro_context_->fc_, this->fc_,
-    (intptr_t) this);
+  BoostContext* context = static_cast<BoostContext**>(arg.data)[1];
+  ASAN_ONLY(xbt_assert(context->asan_ctx_ == static_cast<BoostContext**>(arg.data)[0]));
+  ASAN_FINISH_SWITCH(nullptr, &context->asan_ctx_->asan_stack_, &context->asan_ctx_->asan_stack_size_);
+  static_cast<BoostContext**>(arg.data)[0]->fc_ = arg.fctx;
 #endif
-}
-
-void BoostSerialContext::suspend()
-{
-  /* determine the next context */
-  BoostSerialContext* next_context = nullptr;
-  unsigned long int i = process_index_++;
-
-  if (i < xbt_dynar_length(simix_global->process_to_run)) {
-    /* execute the next process */
-    XBT_DEBUG("Run next process");
-    next_context = static_cast<BoostSerialContext*>(xbt_dynar_get_as(
-        simix_global->process_to_run, i, smx_actor_t)->context);
-  }
-  else {
-    /* all processes were run, return to maestro */
-    XBT_DEBUG("No more process to run");
-    next_context = static_cast<BoostSerialContext*>(
-      maestro_context_);
-  }
-  SIMIX_context_set_current((smx_context_t) next_context);
-  #if HAVE_BOOST_CONTEXTS == 1
-  boost::context::jump_fcontext(
-    this->fc_, next_context->fc_, (intptr_t) next_context);
-  #else
-  boost::context::jump_fcontext(
-    &this->fc_, next_context->fc_, (intptr_t) next_context);
-  #endif
-}
-
-void BoostSerialContext::stop()
-{
-  BoostContext::stop();
-  this->suspend();
-}
-
-// BoostParallelContext
-
-#if HAVE_THREAD_CONTEXTS
-
-void BoostParallelContext::suspend()
-{
-  smx_actor_t next_work = (smx_actor_t) xbt_parmap_next(parmap_);
-  BoostParallelContext* next_context = nullptr;
-
-  if (next_work != nullptr) {
-    XBT_DEBUG("Run next process");
-    next_context = static_cast<BoostParallelContext*>(next_work->context);
+  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 {
-    XBT_DEBUG("No more processes to run");
-    uintptr_t worker_id =
-      (uintptr_t) xbt_os_thread_get_specific(worker_id_key_);
-    next_context = static_cast<BoostParallelContext*>(
-      workers_context_[worker_id]);
-  }
-
-  SIMIX_context_set_current((smx_context_t) next_context);
-#if HAVE_BOOST_CONTEXTS == 1
-  boost::context::jump_fcontext(
-    this->fc_, next_context->fc_, (intptr_t)next_context);
-#else
-  boost::context::jump_fcontext(
-    &this->fc_, next_context->fc_, (intptr_t)next_context);
-#endif
+  context->Context::stop();
+  ASAN_ONLY(context->asan_stop_ = true);
+  context->suspend();
 }
 
-void BoostParallelContext::stop()
+void BoostContext::swap_into(SwappedContext* to_)
 {
-  BoostContext::stop();
-  this->suspend();
-}
-
-void BoostParallelContext::resume()
-{
-  uintptr_t worker_id = __sync_fetch_and_add(&threads_working_, 1);
-  xbt_os_thread_set_specific(worker_id_key_, (void*) worker_id);
-
-  BoostParallelContext* worker_context =
-    static_cast<BoostParallelContext*>(SIMIX_context_self());
-  workers_context_[worker_id] = worker_context;
-
-  SIMIX_context_set_current(this);
-#if HAVE_BOOST_CONTEXTS == 1
-  boost::context::jump_fcontext(
-    worker_context->fc_, this->fc_, (intptr_t) this);
+  BoostContext* to = static_cast<BoostContext*>(to_);
+#if BOOST_VERSION < 105600
+  boost::context::jump_fcontext(this->fc_, to->fc_, reinterpret_cast<intptr_t>(to));
+#elif BOOST_VERSION < 106100
+  boost::context::jump_fcontext(&this->fc_, to->fc_, reinterpret_cast<intptr_t>(to));
 #else
-  boost::context::jump_fcontext(
-    &worker_context->fc_, this->fc_, (intptr_t) this);
+  BoostContext* ctx[2] = {this, 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_);
+  boost::context::detail::transfer_t arg = boost::context::detail::jump_fcontext(to->fc_, ctx);
+  ASAN_ONLY(xbt_assert(from->asan_ctx_ == static_cast<BoostContext**>(arg.data)[0]));
+  ASAN_FINISH_SWITCH(fake_stack, &from->asan_ctx_->asan_stack_, &from->asan_ctx_->asan_stack_size_);
+  static_cast<BoostContext**>(arg.data)[0]->fc_ = arg.fctx;
 #endif
 }
 
-#endif
-
 XBT_PRIVATE ContextFactory* boost_factory()
 {
   XBT_VERB("Using Boost contexts. Welcome to the 21th century.");
   return new BoostContextFactory();
 }
-
 }}} // namespace