Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Kill a parameter that was always nullptr
[simgrid.git] / src / kernel / context / ContextThread.cpp
index 7362e84..c6901c9 100644 (file)
-/* Copyright (c) 2009-2018. The SimGrid Team. All rights reserved.          */
+/* Copyright (c) 2009-2023. 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 "src/kernel/EngineImpl.hpp"
 #include "xbt/function_types.h"
-#include "xbt/xbt_os_thread.h"
+#include "xbt/xbt_modinter.h" /* prototype of os thread module's init/exit in XBT */
 
-#include "src/kernel/context/ContextThread.hpp"
+#include <boost/core/demangle.hpp>
+#include <functional>
+#include <typeinfo>
+#include <utility>
 
-XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
+XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(ker_context);
 
-namespace simgrid {
-namespace kernel {
-namespace context {
+namespace simgrid::kernel::context {
 
 // ThreadContextFactory
 
-ThreadContextFactory::ThreadContextFactory()
-    : ContextFactory("ThreadContextFactory"), parallel_(SIMIX_context_is_parallel())
+ThreadContextFactory::ThreadContextFactory() : ContextFactory()
 {
-  if (parallel_)
+  if (stack_size != 8 * 1024 * 1024)
+    XBT_INFO("Stack size modifications are ignored by thread factory.");
+  if (is_parallel())
     ParallelThreadContext::initialize();
 }
 
 ThreadContextFactory::~ThreadContextFactory()
 {
-  if (parallel_)
+  if (is_parallel())
     ParallelThreadContext::finalize();
 }
 
-ThreadContext* ThreadContextFactory::create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup,
-                                                    smx_actor_t process, bool maestro)
+ThreadContext* ThreadContextFactory::create_context(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro)
 {
-  if (parallel_)
-    return this->new_context<ParallelThreadContext>(std::move(code), cleanup, process, maestro);
+  if (is_parallel())
+    return this->new_context<ParallelThreadContext>(std::move(code), actor, maestro);
   else
-    return this->new_context<SerialThreadContext>(std::move(code), cleanup, process, maestro);
+    return this->new_context<SerialThreadContext>(std::move(code), actor, maestro);
 }
 
-void ThreadContextFactory::run_all()
+void ThreadContextFactory::run_all(std::vector<actor::ActorImpl*> const& actors_list)
 {
-  if (parallel_) {
-    // Parallel execution
-    ParallelThreadContext::run_all();
-  } else {
-    // Serial execution
-    SerialThreadContext::run_all();
-  }
+  if (is_parallel())
+    ParallelThreadContext::run_all(actors_list);
+
+  else
+    SerialThreadContext::run_all(actors_list);
 }
 
 // ThreadContext
 
-ThreadContext::ThreadContext(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t process,
-                             bool maestro)
-    : AttachContext(std::move(code), cleanup, process), is_maestro_(maestro)
+ThreadContext::ThreadContext(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro)
+    : AttachContext(std::move(code), actor, 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, 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 start 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. */
-  stack_t stack;
-  stack.ss_sp = sigsegv_stack;
-  stack.ss_size = sizeof sigsegv_stack;
-  stack.ss_flags = 0;
-  sigaltstack(&stack, nullptr);
-#endif
+  install_sigsegv_stack(true);
   // Tell the caller (normally the maestro) we are starting, and wait for its green light
-  xbt_os_sem_release(context->end_);
+  context->end_.release();
   context->start();
 
   try {
     (*context)();
-    if (not context->isMaestro()) // really?
-      context->Context::stop();
-  } catch (StopRequest const&) {
-    XBT_DEBUG("Caught a StopRequest");
-    xbt_assert(not context->isMaestro(), "I'm not supposed to be maestro here.");
+    if (not context->is_maestro()) // Just in case somebody detached maestro
+      context->stop();
+  } 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 uncaught exception %s", boost::core::demangle(typeid(e).name()).c_str());
+    throw;
   }
-
   // 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;
+  install_sigsegv_stack(false);
+  XBT_DEBUG("Terminating");
+  Context::set_current(nullptr);
 }
 
 void ThreadContext::release()
 {
-  xbt_os_sem_release(this->begin_);
+  this->begin_.release();
 }
 
 void ThreadContext::wait()
 {
-  xbt_os_sem_acquire(this->end_);
+  this->end_.acquire();
 }
 
 void ThreadContext::start()
 {
-  xbt_os_sem_acquire(this->begin_);
+  this->begin_.acquire();
   this->start_hook();
 }
 
 void ThreadContext::yield()
 {
   this->yield_hook();
-  xbt_os_sem_release(this->end_);
-}
-
-void ThreadContext::stop()
-{
-  Context::stop();
-  throw StopRequest();
+  this->end_.release();
 }
 
 void ThreadContext::suspend()
@@ -169,30 +139,30 @@ void ThreadContext::suspend()
 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_);
-  xbt_assert(not this->isMaestro());
+  auto* maestro = static_cast<ThreadContext*>(EngineImpl::get_instance()->get_maestro()->context_.get());
+  maestro->begin_.release();
+  xbt_assert(not this->is_maestro());
   this->start();
 }
 
 void ThreadContext::attach_stop()
 {
-  xbt_assert(not this->isMaestro());
+  xbt_assert(not this->is_maestro());
   this->yield();
 
-  ThreadContext* maestro = (ThreadContext*)simix_global->maestro_process->context_;
-  xbt_os_sem_acquire(maestro->end_);
+  auto* maestro = static_cast<ThreadContext*>(EngineImpl::get_instance()->get_maestro()->context_.get());
+  maestro->end_.acquire();
 
-  xbt_os_thread_set_extra_data(nullptr);
+  Context::set_current(nullptr);
 }
 
 // SerialThreadContext
 
-void SerialThreadContext::run_all()
+void SerialThreadContext::run_all(std::vector<actor::ActorImpl*> const& actors_list)
 {
-  for (smx_actor_t const& process : simix_global->process_to_run) {
-    XBT_DEBUG("Handling %p", process);
-    ThreadContext* context = static_cast<ThreadContext*>(process->context_);
+  for (auto const* actor : actors_list) {
+    XBT_DEBUG("Handling %p", actor);
+    auto* context = static_cast<ThreadContext*>(actor->context_.get());
     context->release();
     context->wait();
   }
@@ -200,37 +170,38 @@ void SerialThreadContext::run_all()
 
 // ParallelThreadContext
 
-xbt_os_sem_t ParallelThreadContext::thread_sem_ = nullptr;
+xbt::OsSemaphore* ParallelThreadContext::thread_sem_ = nullptr;
 
 void ParallelThreadContext::initialize()
 {
-  thread_sem_ = xbt_os_sem_init(SIMIX_context_get_nthreads());
+  thread_sem_ = new xbt::OsSemaphore(get_nthreads());
 }
 
 void ParallelThreadContext::finalize()
 {
-  xbt_os_sem_destroy(thread_sem_);
+  delete thread_sem_;
   thread_sem_ = nullptr;
 }
 
-void ParallelThreadContext::run_all()
+void ParallelThreadContext::run_all(std::vector<actor::ActorImpl*> const& actors_list)
 {
-  for (smx_actor_t const& process : simix_global->process_to_run)
-    static_cast<ThreadContext*>(process->context_)->release();
-  for (smx_actor_t const& process : simix_global->process_to_run)
-    static_cast<ThreadContext*>(process->context_)->wait();
+  for (auto const* actor : actors_list)
+    static_cast<ThreadContext*>(actor->context_.get())->release();
+
+  for (auto const* actor : actors_list)
+    static_cast<ThreadContext*>(actor->context_.get())->wait();
 }
 
 void ParallelThreadContext::start_hook()
 {
-  if (not isMaestro()) /* parallel run */
-    xbt_os_sem_acquire(thread_sem_);
+  if (not is_maestro()) /* parallel run */
+    thread_sem_->acquire();
 }
 
 void ParallelThreadContext::yield_hook()
 {
-  if (not isMaestro()) /* parallel run */
-    xbt_os_sem_release(thread_sem_);
+  if (not is_maestro()) /* parallel run */
+    thread_sem_->release();
 }
 
 XBT_PRIVATE ContextFactory* thread_factory()
@@ -238,4 +209,4 @@ XBT_PRIVATE ContextFactory* thread_factory()
   XBT_VERB("Activating thread context factory");
   return new ThreadContextFactory();
 }
-}}} // namespace
+} // namespace simgrid::kernel::context