Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Declare fake_stack only with ASan.
[simgrid.git] / src / kernel / context / ContextBoost.cpp
index 2b0bc63..5673295 100644 (file)
@@ -1,22 +1,11 @@
-/* Copyright (c) 2015-2017. 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 "src/simix/smx_private.hpp"
 
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
 
@@ -24,51 +13,15 @@ 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;
-simgrid::xbt::Parmap<smx_actor_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")
+    : ContextFactory("BoostContextFactory"), parallel_(SIMIX_context_is_parallel())
 {
-  BoostContext::parallel_ = SIMIX_context_is_parallel();
-  if (BoostContext::parallel_) {
+  BoostContext::setMaestro(nullptr);
+  if (parallel_) {
 #if HAVE_THREAD_CONTEXTS
-    int nthreads = SIMIX_context_get_nthreads();
-    BoostContext::parmap_ = new simgrid::xbt::Parmap<smx_actor_t>(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_);
+    ParallelBoostContext::initialize();
 #else
     xbt_die("No thread support for parallel context execution");
 #endif
@@ -78,83 +31,58 @@ BoostContextFactory::BoostContextFactory()
 BoostContextFactory::~BoostContextFactory()
 {
 #if HAVE_THREAD_CONTEXTS
-  if (BoostContext::parmap_) {
-    delete BoostContext::parmap_;
-    BoostContext::parmap_ = nullptr;
-  }
-  BoostContext::workers_context_.clear();
+  if (parallel_)
+    ParallelBoostContext::finalize();
 #endif
 }
 
 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");
+  if (parallel_)
+    return this->new_context<ParallelBoostContext>(std::move(code), cleanup_func, process);
 #endif
-  else
-    context = this->new_context<BoostSerialContext>(std::move(code), cleanup_func, process);
-  return context;
+
+  return this->new_context<SerialBoostContext>(std::move(code), cleanup_func, process);
 }
 
 void BoostContextFactory::run_all()
 {
 #if HAVE_THREAD_CONTEXTS
-  if (BoostContext::parallel_) {
-    BoostContext::threads_working_ = 0;
-    BoostContext::parmap_->apply(
-        [](smx_actor_t process) {
-          BoostContext* context = static_cast<BoostContext*>(process->context);
-          return context->resume();
-        },
-        simix_global->process_to_run);
-  } else
+  if (parallel_)
+    ParallelBoostContext::run_all();
+  else
 #endif
-  {
-    if (simix_global->process_to_run.empty())
-      return;
-    smx_actor_t first_process    = simix_global->process_to_run.front();
-    BoostContext::process_index_ = 1;
-    /* execute the first process */
-    static_cast<BoostContext*>(first_process->context)->resume();
-  }
+    SerialBoostContext::run_all();
 }
 
-
 // BoostContext
 
-static void smx_ctx_boost_wrapper(std::intptr_t arg)
-{
-  BoostContext* context = reinterpret_cast<BoostContext*>(arg);
-  (*context)();
-  context->stop();
-}
+BoostContext* BoostContext::maestro_context_ = nullptr;
 
-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)
+    : 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_ = 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:
+    /* 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 - 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);
+    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
+#if BOOST_VERSION < 105600
     this->fc_ = new boost::context::fcontext_t();
 #endif
     if (BoostContext::maestro_context_ == nullptr)
@@ -164,7 +92,7 @@ BoostContext::BoostContext(std::function<void()> code,
 
 BoostContext::~BoostContext()
 {
-#if HAVE_BOOST_CONTEXTS == 1
+#if BOOST_VERSION < 105600
   if (not this->stack_)
     delete this->fc_;
 #endif
@@ -173,93 +101,155 @@ BoostContext::~BoostContext()
   SIMIX_context_stack_delete(this->stack_);
 }
 
-// BoostSerialContext
+void BoostContext::wrapper(BoostContext::arg_type arg)
+{
+#if BOOST_VERSION < 106100
+  BoostContext* context = reinterpret_cast<BoostContext*>(arg);
+#else
+  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
+  try {
+    (*context)();
+    context->Context::stop();
+  } catch (StopRequest const&) {
+    XBT_DEBUG("Caught a StopRequest");
+  }
+  ASAN_ONLY(context->asan_stop_ = true);
+  context->suspend();
+}
 
-void BoostContext::resume()
+inline void BoostContext::swap(BoostContext* from, BoostContext* to)
 {
-  SIMIX_context_set_current(this);
-#if HAVE_BOOST_CONTEXTS == 1
-  boost::context::jump_fcontext(maestro_context_->fc_, this->fc_, reinterpret_cast<intptr_t>(this));
+#if BOOST_VERSION < 105600
+  boost::context::jump_fcontext(from->fc_, to->fc_, reinterpret_cast<intptr_t>(to));
+#elif BOOST_VERSION < 106100
+  boost::context::jump_fcontext(&from->fc_, to->fc_, reinterpret_cast<intptr_t>(to));
 #else
-  boost::context::jump_fcontext(&maestro_context_->fc_, this->fc_, reinterpret_cast<intptr_t>(this));
+  BoostContext* ctx[2] = {from, 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
 }
 
-void BoostSerialContext::suspend()
+void BoostContext::stop()
+{
+  Context::stop();
+  throw StopRequest();
+}
+
+// SerialBoostContext
+
+unsigned long SerialBoostContext::process_index_;
+
+void SerialBoostContext::suspend()
 {
   /* determine the next context */
-  BoostSerialContext* next_context = nullptr;
-  unsigned long int i              = process_index_;
+  SerialBoostContext* next_context;
+  unsigned long int i = process_index_;
   process_index_++;
 
   if (i < simix_global->process_to_run.size()) {
     /* execute the next process */
     XBT_DEBUG("Run next process");
-    next_context = static_cast<BoostSerialContext*>(simix_global->process_to_run[i]->context);
+    next_context = static_cast<SerialBoostContext*>(simix_global->process_to_run[i]->context);
   } else {
     /* all processes were run, return to maestro */
     XBT_DEBUG("No more process to run");
-    next_context = static_cast<BoostSerialContext*>(maestro_context_);
+    next_context = static_cast<SerialBoostContext*>(BoostContext::getMaestro());
   }
-  SIMIX_context_set_current(static_cast<smx_context_t>(next_context));
-#if HAVE_BOOST_CONTEXTS == 1
-  boost::context::jump_fcontext(this->fc_, next_context->fc_, reinterpret_cast<pintptr_t>(next_context));
-#else
-  boost::context::jump_fcontext(&this->fc_, next_context->fc_, reinterpret_cast<intptr_t>(next_context));
-#endif
+  SIMIX_context_set_current(next_context);
+  BoostContext::swap(this, next_context);
 }
 
-void BoostSerialContext::stop()
+void SerialBoostContext::resume()
 {
-  BoostContext::stop();
-  this->suspend();
+  SIMIX_context_set_current(this);
+  BoostContext::swap(BoostContext::getMaestro(), this);
 }
 
-// BoostParallelContext
+void SerialBoostContext::run_all()
+{
+  if (simix_global->process_to_run.empty())
+    return;
+  smx_actor_t first_process = simix_global->process_to_run.front();
+  process_index_            = 1;
+  /* execute the first process */
+  static_cast<SerialBoostContext*>(first_process->context)->resume();
+}
+
+// ParallelBoostContext
 
 #if HAVE_THREAD_CONTEXTS
 
-void BoostParallelContext::suspend()
+simgrid::xbt::Parmap<smx_actor_t>* ParallelBoostContext::parmap_;
+std::atomic<uintptr_t> ParallelBoostContext::threads_working_;
+xbt_os_thread_key_t ParallelBoostContext::worker_id_key_;
+std::vector<ParallelBoostContext*> ParallelBoostContext::workers_context_;
+
+void ParallelBoostContext::initialize()
+{
+  parmap_ = nullptr;
+  workers_context_.clear();
+  workers_context_.resize(SIMIX_context_get_nthreads(), nullptr);
+  xbt_os_thread_key_create(&worker_id_key_);
+}
+
+void ParallelBoostContext::finalize()
+{
+  delete parmap_;
+  parmap_ = nullptr;
+  workers_context_.clear();
+  xbt_os_thread_key_destroy(worker_id_key_);
+}
+
+void ParallelBoostContext::run_all()
+{
+  threads_working_ = 0;
+  if (parmap_ == nullptr)
+    parmap_ = new simgrid::xbt::Parmap<smx_actor_t>(SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
+  parmap_->apply(
+      [](smx_actor_t process) {
+        ParallelBoostContext* context = static_cast<ParallelBoostContext*>(process->context);
+        context->resume();
+      },
+      simix_global->process_to_run);
+}
+
+void ParallelBoostContext::suspend()
 {
   boost::optional<smx_actor_t> next_work = parmap_->next();
-  BoostParallelContext* next_context;
+  ParallelBoostContext* next_context;
   if (next_work) {
     XBT_DEBUG("Run next process");
-    next_context = static_cast<BoostParallelContext*>(next_work.get()->context);
+    next_context = static_cast<ParallelBoostContext*>(next_work.get()->context);
   } else {
     XBT_DEBUG("No more processes to run");
     uintptr_t worker_id = reinterpret_cast<uintptr_t>(xbt_os_thread_get_specific(worker_id_key_));
-    next_context = static_cast<BoostParallelContext*>(workers_context_[worker_id]);
+    next_context        = workers_context_[worker_id];
   }
 
-  SIMIX_context_set_current(static_cast<smx_context_t>(next_context));
-#if HAVE_BOOST_CONTEXTS == 1
-  boost::context::jump_fcontext(this->fc_, next_context->fc_, reinterpret_cast<intptr_t>(next_context));
-#else
-  boost::context::jump_fcontext(&this->fc_, next_context->fc_, reinterpret_cast<intptr_t>(next_context));
-#endif
-}
-
-void BoostParallelContext::stop()
-{
-  BoostContext::stop();
-  this->suspend();
+  SIMIX_context_set_current(next_context);
+  BoostContext::swap(this, next_context);
 }
 
-void BoostParallelContext::resume()
+void ParallelBoostContext::resume()
 {
-  uintptr_t worker_id = __sync_fetch_and_add(&threads_working_, 1);
+  uintptr_t worker_id = threads_working_.fetch_add(1, std::memory_order_relaxed);
   xbt_os_thread_set_specific(worker_id_key_, reinterpret_cast<void*>(worker_id));
 
-  BoostParallelContext* worker_context = static_cast<BoostParallelContext*>(SIMIX_context_self());
-  workers_context_[worker_id] = worker_context;
+  ParallelBoostContext* worker_context = static_cast<ParallelBoostContext*>(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_, reinterpret_cast<intptr_t>(this));
-#else
-  boost::context::jump_fcontext(&worker_context->fc_, this->fc_, reinterpret_cast<intptr_t>(this));
-#endif
+  BoostContext::swap(worker_context, this);
 }
 
 #endif
@@ -269,5 +259,4 @@ XBT_PRIVATE ContextFactory* boost_factory()
   XBT_VERB("Using Boost contexts. Welcome to the 21th century.");
   return new BoostContextFactory();
 }
-
 }}} // namespace