Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Use real pointer type for context wrappers.
[simgrid.git] / src / kernel / context / ContextThread.cpp
index 8e9ee72..17a3df7 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. */
 
-#include <utility>
-#include <functional>
+#include "src/kernel/context/ContextThread.hpp"
 
+#include "simgrid/Exception.hpp"
+#include "src/internal_config.h" /* loads context system definitions */
+#include "src/simix/smx_private.hpp"
+#include "src/xbt_modinter.h" /* prototype of os thread module's init/exit in XBT */
 #include "xbt/function_types.h"
-#include "src/simix/smx_private.h"
-#include "src/internal_config.h"           /* loads context system definitions */
-#include "xbt/swag.h"
-#include "xbt/xbt_os_thread.h"
-#include "src/xbt_modinter.h"       /* prototype of os thread module's init/exit in XBT */
 
-#include "src/kernel/context/ContextThread.hpp"
+#include <functional>
+#include <utility>
 
 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
 
-static xbt_os_sem_t smx_ctx_thread_sem = nullptr;
-
 namespace simgrid {
 namespace kernel {
 namespace context {
 
-XBT_PRIVATE ContextFactory* thread_factory()
-{
-  XBT_VERB("Activating thread context factory");
-  return new ThreadContextFactory();
-}
+// ThreadContextFactory
 
-ThreadContextFactory::ThreadContextFactory()
-  : ContextFactory("ThreadContextFactory")
+ThreadContextFactory::ThreadContextFactory() : ContextFactory(), parallel_(SIMIX_context_is_parallel())
 {
-  if (SIMIX_context_is_parallel()) {
-    smx_ctx_thread_sem = xbt_os_sem_init(SIMIX_context_get_nthreads());
-  } else {
-    smx_ctx_thread_sem = nullptr;
-  }
+  if (parallel_)
+    ParallelThreadContext::initialize();
 }
 
 ThreadContextFactory::~ThreadContextFactory()
 {
-  if (smx_ctx_thread_sem) {
-    xbt_os_sem_destroy(smx_ctx_thread_sem);
-    smx_ctx_thread_sem = nullptr;
-  }
+  if (parallel_)
+    ParallelThreadContext::finalize();
 }
 
-ThreadContext* ThreadContextFactory::create_context(
-    std::function<void()> code,
-    void_pfn_smxprocess_t cleanup, smx_actor_t process)
+ThreadContext* ThreadContextFactory::create_context(std::function<void()> code, smx_actor_t actor, bool maestro)
 {
-  return this->new_context<ThreadContext>(std::move(code), cleanup, process, not code);
+  if (parallel_)
+    return this->new_context<ParallelThreadContext>(std::move(code), actor, maestro);
+  else
+    return this->new_context<SerialThreadContext>(std::move(code), actor, maestro);
 }
 
 void ThreadContextFactory::run_all()
 {
-  if (smx_ctx_thread_sem == nullptr) {
-    // Serial execution
-    for (smx_actor_t const& process : simix_global->process_to_run) {
-      XBT_DEBUG("Handling %p",process);
-      ThreadContext* context = static_cast<ThreadContext*>(process->context);
-      xbt_os_sem_release(context->begin_);
-      xbt_os_sem_acquire(context->end_);
-    }
-  } else {
+  if (parallel_) {
     // Parallel execution
-    for (smx_actor_t const& process : simix_global->process_to_run)
-      xbt_os_sem_release(static_cast<ThreadContext*>(process->context)->begin_);
-    for (smx_actor_t const& process : simix_global->process_to_run)
-      xbt_os_sem_acquire(static_cast<ThreadContext*>(process->context)->end_);
+    ParallelThreadContext::run_all();
+  } else {
+    // Serial execution
+    SerialThreadContext::run_all();
   }
 }
 
-ThreadContext* ThreadContextFactory::self()
-{
-  return static_cast<ThreadContext*>(xbt_os_thread_get_extra_data());
-}
-
-ThreadContext* ThreadContextFactory::attach(void_pfn_smxprocess_t cleanup_func, smx_actor_t process)
-{
-  return this->new_context<ThreadContext>(
-    std::function<void()>(), cleanup_func, process, false);
-}
-
-ThreadContext* ThreadContextFactory::create_maestro(std::function<void()> code, smx_actor_t process)
-{
-    return this->new_context<ThreadContext>(std::move(code), nullptr, process, true);
-}
+// ThreadContext
 
-ThreadContext::ThreadContext(std::function<void()> code,
-    void_pfn_smxprocess_t cleanup, smx_actor_t process, bool maestro)
-  : AttachContext(std::move(code), cleanup, process)
+ThreadContext::ThreadContext(std::function<void()> code, smx_actor_t actor, bool maestro)
+    : AttachContext(std::move(code), actor), is_maestro_(maestro)
 {
-  // We do not need the semaphores when maestro is in main,
-  // but creating them anyway simplifies things when maestro is externalized
-  this->begin_ = xbt_os_sem_init(0);
-  this->end_ = xbt_os_sem_init(0);
-
-  /* If the user provided a function for the process then use it */
+  /* If the user provided a function for the actor then use it */
   if (has_code()) {
-    if (smx_context_stack_size_was_set)
-      xbt_os_thread_setstacksize(smx_context_stack_size);
-    if (smx_context_guard_size_was_set)
-      xbt_os_thread_setguardsize(smx_context_guard_size);
-
-    /* create and start the process */
-    /* NOTE: The first argument to xbt_os_thread_create used to be the process *
-    * name, but now the name is stored at SIMIX level, so we pass a null  */
-    this->thread_ =
-      xbt_os_thread_create(nullptr,
-        maestro ? &ThreadContext::maestro_wrapper : &ThreadContext::wrapper,
-        this, this);
-    /* wait the starting of the newly created process */
-    xbt_os_sem_acquire(this->end_);
+    /* create and start the actor */
+    this->thread_ = new std::thread(ThreadContext::wrapper, this);
+    /* wait the starting of the newly created actor */
+    this->end_.acquire();
   }
 
   /* Otherwise, we attach to the current thread */
   else {
-    xbt_os_thread_set_extra_data(this);
+    Context::set_current(this);
   }
 }
 
 ThreadContext::~ThreadContext()
 {
-  if (this->thread_) /* If there is a thread (maestro don't have any), wait for its termination */
-    xbt_os_thread_join(this->thread_, nullptr);
-
-  /* destroy the synchronization objects */
-  xbt_os_sem_destroy(this->begin_);
-  xbt_os_sem_destroy(this->end_);
+  if (this->thread_) { /* Maestro don't have any thread */
+    thread_->join();
+    delete thread_;
+  }
 }
 
-void *ThreadContext::wrapper(void *param)
+void ThreadContext::wrapper(ThreadContext* context)
 {
-  ThreadContext* context = static_cast<ThreadContext*>(param);
+  Context::set_current(context);
 
 #ifndef WIN32
   /* Install alternate signal stack, for SIGSEGV handler. */
@@ -144,102 +92,139 @@ void *ThreadContext::wrapper(void *param)
   stack.ss_flags = 0;
   sigaltstack(&stack, nullptr);
 #endif
-  /* Tell the maestro we are starting, and wait for its green light */
-  xbt_os_sem_release(context->end_);
-
-  xbt_os_sem_acquire(context->begin_);
-  if (smx_ctx_thread_sem)       /* parallel run */
-    xbt_os_sem_acquire(smx_ctx_thread_sem);
+  // Tell the caller (normally the maestro) we are starting, and wait for its green light
+  context->end_.release();
+  context->start();
 
   try {
     (*context)();
-    context->Context::stop();
-  } catch (StopRequest const&) {
-    XBT_DEBUG("Caught a StopRequest");
+    if (not context->is_maestro()) { // Just in case somebody detached maestro
+      context->Context::stop();
+      context->stop_hook();
+    }
+  } catch (ForcefulKillException const&) {
+    XBT_DEBUG("Caught a ForcefulKillException in Thread::wrapper");
+    xbt_assert(not context->is_maestro(), "Maestro shall not receive ForcefulKillExceptions, even when detached.");
+  } catch (simgrid::Exception const& e) {
+    XBT_INFO("Actor killed by an uncatched exception %s", simgrid::xbt::demangle(typeid(e).name()).get());
+    throw;
   }
-
-  if (smx_ctx_thread_sem)
-    xbt_os_sem_release(smx_ctx_thread_sem);
-  // Signal to the maestro that it has finished:
-  xbt_os_sem_release(context->end_);
+  // Signal to the caller (normally the maestro) that we have finished:
+  context->yield();
 
 #ifndef WIN32
   stack.ss_flags = SS_DISABLE;
   sigaltstack(&stack, nullptr);
 #endif
-  return nullptr;
+  XBT_DEBUG("Terminating");
+  Context::set_current(nullptr);
 }
 
-void *ThreadContext::maestro_wrapper(void *param)
+void ThreadContext::release()
 {
-  ThreadContext* context = static_cast<ThreadContext*>(param);
-
-#ifndef WIN32
-  /* Install alternate signal stack, for SIGSEGV handler. */
-  stack_t stack;
-  stack.ss_sp = sigsegv_stack;
-  stack.ss_size = sizeof sigsegv_stack;
-  stack.ss_flags = 0;
-  sigaltstack(&stack, nullptr);
-#endif
-  /* Tell the caller we are starting */
-  xbt_os_sem_release(context->end_);
-
-  // Wait for the caller to give control back to us:
-  xbt_os_sem_acquire(context->begin_);
-  (*context)();
-
-  // Tell main that we have finished:
-  xbt_os_sem_release(context->end_);
+  this->begin_.release();
+}
 
-#ifndef WIN32
-  stack.ss_flags = SS_DISABLE;
-  sigaltstack(&stack, nullptr);
-#endif
-  return nullptr;
+void ThreadContext::wait()
+{
+  this->end_.acquire();
 }
 
 void ThreadContext::start()
 {
-  xbt_os_sem_acquire(this->begin_);
-  if (smx_ctx_thread_sem)       /* parallel run */
-    xbt_os_sem_acquire(smx_ctx_thread_sem);
+  this->begin_.acquire();
+  this->start_hook();
+}
+
+void ThreadContext::yield()
+{
+  this->yield_hook();
+  this->end_.release();
 }
 
 void ThreadContext::stop()
 {
   Context::stop();
-  throw StopRequest();
+  stop_hook();
+  throw ForcefulKillException();
 }
 
 void ThreadContext::suspend()
 {
-  if (smx_ctx_thread_sem)
-    xbt_os_sem_release(smx_ctx_thread_sem);
-  xbt_os_sem_release(this->end_);
-  xbt_os_sem_acquire(this->begin_);
-  if (smx_ctx_thread_sem)
-    xbt_os_sem_acquire(smx_ctx_thread_sem);
+  this->yield();
+  this->start();
 }
 
 void ThreadContext::attach_start()
 {
   // We're breaking the layers here by depending on the upper layer:
-  ThreadContext* maestro = (ThreadContext*) simix_global->maestro_process->context;
-  xbt_os_sem_release(maestro->begin_);
+  ThreadContext* maestro = (ThreadContext*)simix_global->maestro_process->context_;
+  maestro->begin_.release();
+  xbt_assert(not this->is_maestro());
   this->start();
 }
 
 void ThreadContext::attach_stop()
 {
-  if (smx_ctx_thread_sem)
-    xbt_os_sem_release(smx_ctx_thread_sem);
-  xbt_os_sem_release(this->end_);
+  xbt_assert(not this->is_maestro());
+  this->yield();
+
+  ThreadContext* maestro = (ThreadContext*)simix_global->maestro_process->context_;
+  maestro->end_.acquire();
+
+  Context::set_current(nullptr);
+}
 
-  ThreadContext* maestro = (ThreadContext*) simix_global->maestro_process->context;
-  xbt_os_sem_acquire(maestro->end_);
+// SerialThreadContext
 
-  xbt_os_thread_set_extra_data(nullptr);
+void SerialThreadContext::run_all()
+{
+  for (smx_actor_t const& actor : simix_global->actors_to_run) {
+    XBT_DEBUG("Handling %p", actor);
+    ThreadContext* context = static_cast<ThreadContext*>(actor->context_);
+    context->release();
+    context->wait();
+  }
 }
 
+// ParallelThreadContext
+
+xbt::OsSemaphore* ParallelThreadContext::thread_sem_ = nullptr;
+
+void ParallelThreadContext::initialize()
+{
+  thread_sem_ = new xbt::OsSemaphore(SIMIX_context_get_nthreads());
+}
+
+void ParallelThreadContext::finalize()
+{
+  delete thread_sem_;
+  thread_sem_ = nullptr;
+}
+
+void ParallelThreadContext::run_all()
+{
+  for (smx_actor_t const& actor : simix_global->actors_to_run)
+    static_cast<ThreadContext*>(actor->context_)->release();
+  for (smx_actor_t const& actor : simix_global->actors_to_run)
+    static_cast<ThreadContext*>(actor->context_)->wait();
+}
+
+void ParallelThreadContext::start_hook()
+{
+  if (not is_maestro()) /* parallel run */
+    thread_sem_->acquire();
+}
+
+void ParallelThreadContext::yield_hook()
+{
+  if (not is_maestro()) /* parallel run */
+    thread_sem_->release();
+}
+
+XBT_PRIVATE ContextFactory* thread_factory()
+{
+  XBT_VERB("Activating thread context factory");
+  return new ThreadContextFactory();
+}
 }}} // namespace