1 /* Copyright (c) 2009-2021. The SimGrid Team. All rights reserved. */
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. */
6 #include "src/kernel/context/ContextThread.hpp"
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 */
14 #include <boost/core/demangle.hpp>
19 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(ker_context);
25 // ThreadContextFactory
27 ThreadContextFactory::ThreadContextFactory() : ContextFactory()
29 if (stack_size != 8 * 1024 * 1024)
30 XBT_INFO("Stack size modifications are ignored by thread factory.");
32 ParallelThreadContext::initialize();
35 ThreadContextFactory::~ThreadContextFactory()
38 ParallelThreadContext::finalize();
41 ThreadContext* ThreadContextFactory::create_context(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro)
44 return this->new_context<ParallelThreadContext>(std::move(code), actor, maestro);
46 return this->new_context<SerialThreadContext>(std::move(code), actor, maestro);
49 void ThreadContextFactory::run_all()
53 ParallelThreadContext::run_all();
56 SerialThreadContext::run_all();
62 ThreadContext::ThreadContext(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro)
63 : AttachContext(std::move(code), actor), is_maestro_(maestro)
65 /* If the user provided a function for the actor then use it */
67 /* create and start the actor */
68 this->thread_ = new std::thread(ThreadContext::wrapper, this);
69 /* wait the starting of the newly created actor */
73 /* Otherwise, we attach to the current thread */
75 Context::set_current(this);
79 ThreadContext::~ThreadContext()
81 if (this->thread_) { /* Maestro don't have any thread */
87 void ThreadContext::wrapper(ThreadContext* context)
89 Context::set_current(context);
92 install_sigsegv_stack(nullptr, true);
94 // Tell the caller (normally the maestro) we are starting, and wait for its green light
95 context->end_.release();
100 if (not context->is_maestro()) { // Just in case somebody detached maestro
101 context->Context::stop();
102 context->stop_hook();
104 } catch (ForcefulKillException const&) {
105 XBT_DEBUG("Caught a ForcefulKillException in Thread::wrapper");
106 xbt_assert(not context->is_maestro(), "Maestro shall not receive ForcefulKillExceptions, even when detached.");
107 } catch (simgrid::Exception const& e) {
108 XBT_INFO("Actor killed by an uncaught exception %s", boost::core::demangle(typeid(e).name()).c_str());
111 // Signal to the caller (normally the maestro) that we have finished:
115 install_sigsegv_stack(nullptr, false);
117 XBT_DEBUG("Terminating");
118 Context::set_current(nullptr);
121 void ThreadContext::release()
123 this->begin_.release();
126 void ThreadContext::wait()
128 this->end_.acquire();
131 void ThreadContext::start()
133 this->begin_.acquire();
137 void ThreadContext::yield()
140 this->end_.release();
143 void ThreadContext::stop()
147 throw ForcefulKillException();
150 void ThreadContext::suspend()
156 void ThreadContext::attach_start()
158 // We're breaking the layers here by depending on the upper layer:
159 auto* maestro = static_cast<ThreadContext*>(EngineImpl::get_instance()->get_maestro()->context_.get());
160 maestro->begin_.release();
161 xbt_assert(not this->is_maestro());
165 void ThreadContext::attach_stop()
167 xbt_assert(not this->is_maestro());
170 auto* maestro = static_cast<ThreadContext*>(EngineImpl::get_instance()->get_maestro()->context_.get());
171 maestro->end_.acquire();
173 Context::set_current(nullptr);
176 // SerialThreadContext
178 void SerialThreadContext::run_all()
180 const auto& to_run = EngineImpl::get_instance()->get_actors_to_run();
181 for (smx_actor_t const& actor : to_run) {
182 XBT_DEBUG("Handling %p", actor);
183 auto* context = static_cast<ThreadContext*>(actor->context_.get());
189 // ParallelThreadContext
191 xbt::OsSemaphore* ParallelThreadContext::thread_sem_ = nullptr;
193 void ParallelThreadContext::initialize()
195 thread_sem_ = new xbt::OsSemaphore(get_nthreads());
198 void ParallelThreadContext::finalize()
201 thread_sem_ = nullptr;
204 void ParallelThreadContext::run_all()
206 const auto& to_release = EngineImpl::get_instance()->get_actors_to_run();
207 for (smx_actor_t const& actor : to_release)
208 static_cast<ThreadContext*>(actor->context_.get())->release();
209 const auto& to_wait = EngineImpl::get_instance()->get_actors_to_run();
210 for (smx_actor_t const& actor : to_wait)
211 static_cast<ThreadContext*>(actor->context_.get())->wait();
214 void ParallelThreadContext::start_hook()
216 if (not is_maestro()) /* parallel run */
217 thread_sem_->acquire();
220 void ParallelThreadContext::yield_hook()
222 if (not is_maestro()) /* parallel run */
223 thread_sem_->release();
226 XBT_PRIVATE ContextFactory* thread_factory()
228 XBT_VERB("Activating thread context factory");
229 return new ThreadContextFactory();
231 } // namespace context
232 } // namespace kernel
233 } // namespace simgrid