src/kernel/context/ContextThread.cpp

   1 /* Copyright (c) 2009-2022. The SimGrid Team. All rights reserved.          */
   2
   3 /* This program is free software; you can redistribute it and/or modify it
   4  * under the terms of the license (GNU LGPL) which comes with this package. */
   5
   6 #include "src/kernel/context/ContextThread.hpp"
   7
   8 #include "simgrid/Exception.hpp"
   9 #include "src/internal_config.h" /* loads context system definitions */
  10 #include "src/kernel/EngineImpl.hpp"
  11 #include "xbt/function_types.h"
  12 #include "xbt/xbt_modinter.h" /* prototype of os thread module's init/exit in XBT */
  13
  14 #include <boost/core/demangle.hpp>
  15 #include <functional>
  16 #include <typeinfo>
  17 #include <utility>
  18
  19 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(ker_context);
  20
  21 namespace simgrid {
  22 namespace kernel {
  23 namespace context {
  24
  25 // ThreadContextFactory
  26
  27 ThreadContextFactory::ThreadContextFactory() : ContextFactory()
  28 {
  29   if (stack_size != 8 * 1024 * 1024)
  30     XBT_INFO("Stack size modifications are ignored by thread factory.");
  31   if (is_parallel())
  32     ParallelThreadContext::initialize();
  33 }
  34
  35 ThreadContextFactory::~ThreadContextFactory()
  36 {
  37   if (is_parallel())
  38     ParallelThreadContext::finalize();
  39 }
  40
  41 ThreadContext* ThreadContextFactory::create_context(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro)
  42 {
  43   if (is_parallel())
  44     return this->new_context<ParallelThreadContext>(std::move(code), actor, maestro);
  45   else
  46     return this->new_context<SerialThreadContext>(std::move(code), actor, maestro);
  47 }
  48
  49 void ThreadContextFactory::run_all()
  50 {
  51   if (is_parallel()) {
  52     // Parallel execution
  53     ParallelThreadContext::run_all();
  54   } else {
  55     // Serial execution
  56     SerialThreadContext::run_all();
  57   }
  58 }
  59
  60 // ThreadContext
  61
  62 ThreadContext::ThreadContext(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro)
  63     : AttachContext(std::move(code), actor, maestro)
  64 {
  65   /* If the user provided a function for the actor then use it */
  66   if (has_code()) {
  67     /* create and start the actor */
  68     this->thread_ = new std::thread(ThreadContext::wrapper, this);
  69     /* wait the start of the newly created actor */
  70     this->end_.acquire();
  71   }
  72
  73   /* Otherwise, we attach to the current thread */
  74   else {
  75     Context::set_current(this);
  76   }
  77 }
  78
  79 ThreadContext::~ThreadContext()
  80 {
  81   if (this->thread_) { /* Maestro don't have any thread */
  82     thread_->join();
  83     delete thread_;
  84   }
  85 }
  86
  87 void ThreadContext::wrapper(ThreadContext* context)
  88 {
  89   Context::set_current(context);
  90
  91 #ifndef WIN32
  92   install_sigsegv_stack(nullptr, true);
  93 #endif
  94   // Tell the caller (normally the maestro) we are starting, and wait for its green light
  95   context->end_.release();
  96   context->start();
  97
  98   try {
  99     (*context)();
 100     if (not context->is_maestro()) // Just in case somebody detached maestro
 101       context->stop();
 102   } catch (ForcefulKillException const&) {
 103     XBT_DEBUG("Caught a ForcefulKillException in Thread::wrapper");
 104     xbt_assert(not context->is_maestro(), "Maestro shall not receive ForcefulKillExceptions, even when detached.");
 105   } catch (simgrid::Exception const& e) {
 106     XBT_INFO("Actor killed by an uncaught exception %s", boost::core::demangle(typeid(e).name()).c_str());
 107     throw;
 108   }
 109   // Signal to the caller (normally the maestro) that we have finished:
 110   context->yield();
 111
 112 #ifndef WIN32
 113   install_sigsegv_stack(nullptr, false);
 114 #endif
 115   XBT_DEBUG("Terminating");
 116   Context::set_current(nullptr);
 117 }
 118
 119 void ThreadContext::release()
 120 {
 121   this->begin_.release();
 122 }
 123
 124 void ThreadContext::wait()
 125 {
 126   this->end_.acquire();
 127 }
 128
 129 void ThreadContext::start()
 130 {
 131   this->begin_.acquire();
 132   this->start_hook();
 133 }
 134
 135 void ThreadContext::yield()
 136 {
 137   this->yield_hook();
 138   this->end_.release();
 139 }
 140
 141 void ThreadContext::suspend()
 142 {
 143   this->yield();
 144   this->start();
 145 }
 146
 147 void ThreadContext::attach_start()
 148 {
 149   // We're breaking the layers here by depending on the upper layer:
 150   auto* maestro = static_cast<ThreadContext*>(EngineImpl::get_instance()->get_maestro()->context_.get());
 151   maestro->begin_.release();
 152   xbt_assert(not this->is_maestro());
 153   this->start();
 154 }
 155
 156 void ThreadContext::attach_stop()
 157 {
 158   xbt_assert(not this->is_maestro());
 159   this->yield();
 160
 161   auto* maestro = static_cast<ThreadContext*>(EngineImpl::get_instance()->get_maestro()->context_.get());
 162   maestro->end_.acquire();
 163
 164   Context::set_current(nullptr);
 165 }
 166
 167 // SerialThreadContext
 168
 169 void SerialThreadContext::run_all()
 170 {
 171   const auto& to_run = EngineImpl::get_instance()->get_actors_to_run();
 172   for (smx_actor_t const& actor : to_run) {
 173     XBT_DEBUG("Handling %p", actor);
 174     auto* context = static_cast<ThreadContext*>(actor->context_.get());
 175     context->release();
 176     context->wait();
 177   }
 178 }
 179
 180 // ParallelThreadContext
 181
 182 xbt::OsSemaphore* ParallelThreadContext::thread_sem_ = nullptr;
 183
 184 void ParallelThreadContext::initialize()
 185 {
 186   thread_sem_ = new xbt::OsSemaphore(get_nthreads());
 187 }
 188
 189 void ParallelThreadContext::finalize()
 190 {
 191   delete thread_sem_;
 192   thread_sem_ = nullptr;
 193 }
 194
 195 void ParallelThreadContext::run_all()
 196 {
 197   const auto& to_release = EngineImpl::get_instance()->get_actors_to_run();
 198   for (smx_actor_t const& actor : to_release)
 199     static_cast<ThreadContext*>(actor->context_.get())->release();
 200   const auto& to_wait = EngineImpl::get_instance()->get_actors_to_run();
 201   for (smx_actor_t const& actor : to_wait)
 202     static_cast<ThreadContext*>(actor->context_.get())->wait();
 203 }
 204
 205 void ParallelThreadContext::start_hook()
 206 {
 207   if (not is_maestro()) /* parallel run */
 208     thread_sem_->acquire();
 209 }
 210
 211 void ParallelThreadContext::yield_hook()
 212 {
 213   if (not is_maestro()) /* parallel run */
 214     thread_sem_->release();
 215 }
 216
 217 XBT_PRIVATE ContextFactory* thread_factory()
 218 {
 219   XBT_VERB("Activating thread context factory");
 220   return new ThreadContextFactory();
 221 }
 222 } // namespace context
 223 } // namespace kernel
 224 } // namespace simgrid