-/* Copyright (c) 2009-2017. 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 "src/internal_config.h"
-
-#include "xbt/parmap.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 kernel {
-namespace context {
-
-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_actor_t process);
- ~RawContext() override;
-
- 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_actor_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();
-}
-
-}}} // namespace
-
-// ***** Loads of static stuff
-
-#if HAVE_THREAD_CONTEXTS
-static xbt_parmap_t raw_parmap;
-static simgrid::kernel::context::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::kernel::context::RawContext* raw_maestro_context;
-
-static bool raw_context_parallel = false;
-
-// ***** Raw context routines
+// Raw context routines
typedef void (*rawctx_entry_point_t)(void *);
namespace kernel {
namespace context {
-RawContextFactory::RawContextFactory()
- : ContextFactory("RawContextFactory")
+// RawContextFactory
+
+RawContextFactory::RawContextFactory() : ContextFactory("RawContextFactory"), parallel_(SIMIX_context_is_parallel())
{
- 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
+ RawContext::set_maestro(nullptr);
+ if (parallel_) {
+ // TODO: choose dynamically when SIMIX_context_get_parallel_threshold() > 1
+ ParallelRawContext::initialize();
}
}
RawContextFactory::~RawContextFactory()
{
-#if HAVE_THREAD_CONTEXTS
- if (raw_parmap)
- xbt_parmap_destroy(raw_parmap);
- xbt_free(raw_workers_context);
-#endif
+ if (parallel_)
+ ParallelRawContext::finalize();
}
-RawContext* RawContextFactory::create_context(std::function<void()> code,
- void_pfn_smxprocess_t cleanup, smx_actor_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);
+ if (parallel_)
+ return this->new_context<ParallelRawContext>(std::move(code), cleanup_func, process);
+ return this->new_context<SerialRawContext>(std::move(code), cleanup_func, process);
}
-void RawContext::wrapper(void* arg)
+void RawContextFactory::run_all()
{
- RawContext* context = static_cast<RawContext*>(arg);
- (*context)();
- context->stop();
+ if (parallel_)
+ ParallelRawContext::run_all();
+ else
+ SerialRawContext::run_all();
}
-RawContext::RawContext(std::function<void()> code,
- void_pfn_smxprocess_t cleanup, smx_actor_t process)
- : Context(std::move(code), cleanup, process)
+// RawContext
+
+RawContext* RawContext::maestro_context_ = nullptr;
+
+RawContext::RawContext(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t process)
+ : Context(std::move(code), cleanup, process)
{
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;
+ if (process != nullptr && maestro_context_ == nullptr)
+ maestro_context_ = this;
if (MC_is_active())
- MC_ignore_heap(
- &raw_maestro_context->stack_top_,
- sizeof(raw_maestro_context->stack_top_));
+ MC_ignore_heap(&maestro_context_->stack_top_, sizeof(maestro_context_->stack_top_));
}
}
SIMIX_context_stack_delete(this->stack_);
}
-void RawContext::stop()
+void RawContext::wrapper(void* arg)
{
- Context::stop();
- this->suspend();
-}
+ 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;
+ }
+ context->Context::stop();
-void RawContextFactory::run_all()
-{
- if (raw_context_parallel)
- run_all_parallel();
- else
- run_all_serial();
+ ASAN_ONLY(context->asan_stop_ = true);
+ context->suspend();
}
-void RawContextFactory::run_all_serial()
+inline void RawContext::swap(RawContext* from, RawContext* to)
{
- 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);
- raw_process_index = 1;
- static_cast<RawContext*>(first_process->context)->resume_serial();
+ 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(&from->stack_top_, to->stack_top_);
+ ASAN_FINISH_SWITCH(fake_stack, &from->asan_ctx_->asan_stack_, &from->asan_ctx_->asan_stack_size_);
}
-void RawContextFactory::run_all_parallel()
+void RawContext::stop()
{
-#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_actor_t process = static_cast<smx_actor_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
+ Context::stop();
+ throw StopRequest();
}
-void RawContext::suspend()
-{
- if (raw_context_parallel)
- RawContext::suspend_parallel();
- else
- RawContext::suspend_serial();
-}
+// SerialRawContext
+
+unsigned long SerialRawContext::process_index_; /* index of the next process to run in the list of runnable processes */
-void RawContext::suspend_serial()
+void SerialRawContext::suspend()
{
/* determine the next context */
- RawContext* next_context = nullptr;
- unsigned long int i = raw_process_index;
- raw_process_index++;
- if (i < xbt_dynar_length(simix_global->process_to_run)) {
+ SerialRawContext* 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<RawContext*>(xbt_dynar_get_as(simix_global->process_to_run, i, smx_actor_t)->context);
+ next_context = static_cast<SerialRawContext*>(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<RawContext*>(raw_maestro_context);
+ next_context = static_cast<SerialRawContext*>(RawContext::get_maestro());
}
- SIMIX_context_set_current(next_context);
- raw_swapcontext(&this->stack_top_, next_context->stack_top_);
+ Context::set_current(next_context);
+ RawContext::swap(this, next_context);
}
-void RawContext::suspend_parallel()
+void SerialRawContext::resume()
{
-#if HAVE_THREAD_CONTEXTS
- /* determine the next context */
- smx_actor_t next_work = static_cast<smx_actor_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 = static_cast<RawContext*>(next_work->context);
- } 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 = static_cast<RawContext*>(raw_workers_context[worker_id]);
- XBT_DEBUG("Restoring worker stack %zu (working threads = %zu)",
- worker_id, raw_threads_working);
- }
+ RawContext* old = static_cast<RawContext*>(self());
+ Context::set_current(this);
+ RawContext::swap(old, this);
+}
- SIMIX_context_set_current(next_context);
- raw_swapcontext(&this->stack_top_, next_context->stack_top_);
-#endif
+void SerialRawContext::run_all()
+{
+ if (simix_global->process_to_run.empty())
+ return;
+ smx_actor_t first_process = simix_global->process_to_run.front();
+ process_index_ = 1;
+ static_cast<SerialRawContext*>(first_process->context_)->resume();
}
-void RawContext::resume()
+// ParallelRawContext
+
+simgrid::xbt::Parmap<smx_actor_t>* ParallelRawContext::parmap_;
+std::atomic<uintptr_t> ParallelRawContext::threads_working_; /* number of threads that have started their work */
+uintptr_t thread_local ParallelRawContext::worker_id_; /* thread-specific storage for the thread id */
+std::vector<ParallelRawContext*> ParallelRawContext::workers_context_; /* space to save the worker context
+ in each thread */
+
+void ParallelRawContext::initialize()
{
- if (raw_context_parallel)
- resume_parallel();
- else
- resume_serial();
+ parmap_ = nullptr;
+ workers_context_.clear();
+ workers_context_.resize(SIMIX_context_get_nthreads(), nullptr);
}
-void RawContext::resume_serial()
+void ParallelRawContext::finalize()
{
- SIMIX_context_set_current(this);
- raw_swapcontext(&raw_maestro_context->stack_top_, this->stack_top_);
+ delete parmap_;
+ parmap_ = nullptr;
+ workers_context_.clear();
}
-void RawContext::resume_parallel()
+void ParallelRawContext::run_all()
{
-#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 = static_cast<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
+ 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) {
+ ParallelRawContext* context = static_cast<ParallelRawContext*>(process->context_);
+ context->resume();
+ },
+ simix_global->process_to_run);
}
-/** @brief Resumes all processes ready to run. */
-void RawContextFactory::run_all_adaptative()
+void ParallelRawContext::suspend()
{
- unsigned long nb_processes = xbt_dynar_length(simix_global->process_to_run);
- if (SIMIX_context_is_parallel() &&
- static_cast<unsigned long>(SIMIX_context_get_parallel_threshold()) < nb_processes) {
- raw_context_parallel = true;
- XBT_DEBUG("Runall // %lu", nb_processes);
- this->run_all_parallel();
+ /* determine the next context */
+ boost::optional<smx_actor_t> next_work = parmap_->next();
+ ParallelRawContext* next_context;
+ if (next_work) {
+ /* there is a next process to resume */
+ XBT_DEBUG("Run next process");
+ next_context = static_cast<ParallelRawContext*>(next_work.get()->context_);
} else {
- XBT_DEBUG("Runall serial %lu", nb_processes);
- raw_context_parallel = false;
- this->run_all_serial();
+ /* all processes were run, go to the barrier */
+ XBT_DEBUG("No more processes to run");
+ next_context = workers_context_[worker_id_];
+ XBT_DEBUG("Restoring worker stack %zu (working threads = %zu)", worker_id_, threads_working_.load());
}
+
+ Context::set_current(next_context);
+ RawContext::swap(this, next_context);
+}
+
+void ParallelRawContext::resume()
+{
+ worker_id_ = threads_working_.fetch_add(1, std::memory_order_relaxed);
+ ParallelRawContext* worker_context = static_cast<ParallelRawContext*>(self());
+ workers_context_[worker_id_] = worker_context;
+ XBT_DEBUG("Saving worker stack %zu", worker_id_);
+ Context::set_current(this);
+ RawContext::swap(worker_context, this);
}
+ContextFactory* raw_factory()
+{
+ XBT_VERB("Using raw contexts. Because the glibc is just not good enough for us.");
+ return new RawContextFactory();
+}
}}}
