src/kernel/context/ContextThread.cpp

   1 /* Copyright (c) 2009-2019. 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/simix/smx_private.hpp"
  11 #include "src/xbt_modinter.h" /* prototype of os thread module's init/exit in XBT */
  12 #include "xbt/function_types.h"
  13
  14 #include <functional>
  15 #include <utility>
  16
  17 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
  18
  19 namespace simgrid {
  20 namespace kernel {
  21 namespace context {
  22
  23 // ThreadContextFactory
  24
  25 ThreadContextFactory::ThreadContextFactory() : ContextFactory(), parallel_(SIMIX_context_is_parallel())
  26 {
  27   if (parallel_)
  28     ParallelThreadContext::initialize();
  29 }
  30
  31 ThreadContextFactory::~ThreadContextFactory()
  32 {
  33   if (parallel_)
  34     ParallelThreadContext::finalize();
  35 }
  36
  37 ThreadContext* ThreadContextFactory::create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup,
  38                                                     smx_actor_t actor, bool maestro)
  39 {
  40   if (parallel_)
  41     return this->new_context<ParallelThreadContext>(std::move(code), cleanup, actor, maestro);
  42   else
  43     return this->new_context<SerialThreadContext>(std::move(code), cleanup, actor, maestro);
  44 }
  45
  46 void ThreadContextFactory::run_all()
  47 {
  48   if (parallel_) {
  49     // Parallel execution
  50     ParallelThreadContext::run_all();
  51   } else {
  52     // Serial execution
  53     SerialThreadContext::run_all();
  54   }
  55 }
  56
  57 // ThreadContext
  58
  59 ThreadContext::ThreadContext(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t actor, bool maestro)
  60     : AttachContext(std::move(code), cleanup, actor), is_maestro_(maestro)
  61 {
  62   /* If the user provided a function for the actor then use it */
  63   if (has_code()) {
  64     /* create and start the actor */
  65     this->thread_ = new std::thread(ThreadContext::wrapper, this);
  66     /* wait the starting of the newly created actor */
  67     this->end_.acquire();
  68   }
  69
  70   /* Otherwise, we attach to the current thread */
  71   else {
  72     Context::set_current(this);
  73   }
  74 }
  75
  76 ThreadContext::~ThreadContext()
  77 {
  78   if (this->thread_) { /* Maestro don't have any thread */
  79     thread_->join();
  80     delete thread_;
  81   }
  82 }
  83
  84 void *ThreadContext::wrapper(void *param)
  85 {
  86   ThreadContext* context = static_cast<ThreadContext*>(param);
  87   Context::set_current(context);
  88
  89 #ifndef WIN32
  90   /* Install alternate signal stack, for SIGSEGV handler. */
  91   stack_t stack;
  92   stack.ss_sp = sigsegv_stack;
  93   stack.ss_size = sizeof sigsegv_stack;
  94   stack.ss_flags = 0;
  95   sigaltstack(&stack, nullptr);
  96 #endif
  97   // Tell the caller (normally the maestro) we are starting, and wait for its green light
  98   context->end_.release();
  99   context->start();
 100
 101   try {
 102     (*context)();
 103     if (not context->is_maestro()) // Just in case somebody detached maestro
 104       context->Context::stop();
 105   } catch (StopRequest const&) {
 106     XBT_DEBUG("Caught a StopRequest in Thread::wrapper");
 107     xbt_assert(not context->is_maestro(), "Maestro shall not receive StopRequests, even when detached.");
 108   } catch (simgrid::Exception const& e) {
 109     XBT_INFO("Actor killed by an uncatched exception %s", simgrid::xbt::demangle(typeid(e).name()).get());
 110     throw;
 111   }
 112   // Signal to the caller (normally the maestro) that we have finished:
 113   context->yield();
 114
 115 #ifndef WIN32
 116   stack.ss_flags = SS_DISABLE;
 117   sigaltstack(&stack, nullptr);
 118 #endif
 119   XBT_DEBUG("Terminating");
 120   Context::set_current(nullptr);
 121   return nullptr;
 122 }
 123
 124 void ThreadContext::release()
 125 {
 126   this->begin_.release();
 127 }
 128
 129 void ThreadContext::wait()
 130 {
 131   this->end_.acquire();
 132 }
 133
 134 void ThreadContext::start()
 135 {
 136   this->begin_.acquire();
 137   this->start_hook();
 138 }
 139
 140 void ThreadContext::yield()
 141 {
 142   this->yield_hook();
 143   this->end_.release();
 144 }
 145
 146 void ThreadContext::stop()
 147 {
 148   Context::stop();
 149   throw StopRequest();
 150 }
 151
 152 void ThreadContext::suspend()
 153 {
 154   this->yield();
 155   this->start();
 156 }
 157
 158 void ThreadContext::attach_start()
 159 {
 160   // We're breaking the layers here by depending on the upper layer:
 161   ThreadContext* maestro = (ThreadContext*)simix_global->maestro_process->context_;
 162   maestro->begin_.release();
 163   xbt_assert(not this->is_maestro());
 164   this->start();
 165 }
 166
 167 void ThreadContext::attach_stop()
 168 {
 169   xbt_assert(not this->is_maestro());
 170   this->yield();
 171
 172   ThreadContext* maestro = (ThreadContext*)simix_global->maestro_process->context_;
 173   maestro->end_.acquire();
 174
 175   Context::set_current(nullptr);
 176 }
 177
 178 // SerialThreadContext
 179
 180 void SerialThreadContext::run_all()
 181 {
 182   for (smx_actor_t const& actor : simix_global->process_to_run) {
 183     XBT_DEBUG("Handling %p", actor);
 184     ThreadContext* context = static_cast<ThreadContext*>(actor->context_);
 185     context->release();
 186     context->wait();
 187   }
 188 }
 189
 190 // ParallelThreadContext
 191
 192 xbt::OsSemaphore* ParallelThreadContext::thread_sem_ = nullptr;
 193
 194 void ParallelThreadContext::initialize()
 195 {
 196   thread_sem_ = new xbt::OsSemaphore(SIMIX_context_get_nthreads());
 197 }
 198
 199 void ParallelThreadContext::finalize()
 200 {
 201   delete thread_sem_;
 202   thread_sem_ = nullptr;
 203 }
 204
 205 void ParallelThreadContext::run_all()
 206 {
 207   for (smx_actor_t const& actor : simix_global->process_to_run)
 208     static_cast<ThreadContext*>(actor->context_)->release();
 209   for (smx_actor_t const& actor : simix_global->process_to_run)
 210     static_cast<ThreadContext*>(actor->context_)->wait();
 211 }
 212
 213 void ParallelThreadContext::start_hook()
 214 {
 215   if (not is_maestro()) /* parallel run */
 216     thread_sem_->acquire();
 217 }
 218
 219 void ParallelThreadContext::yield_hook()
 220 {
 221   if (not is_maestro()) /* parallel run */
 222     thread_sem_->release();
 223 }
 224
 225 XBT_PRIVATE ContextFactory* thread_factory()
 226 {
 227   XBT_VERB("Activating thread context factory");
 228   return new ThreadContextFactory();
 229 }
 230 }}} // namespace