1 /* Copyright (c) 2009-2022. 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(std::vector<actor::ActorImpl*> const& actors_list)
52 ParallelThreadContext::run_all(actors_list);
55 SerialThreadContext::run_all(actors_list);
60 ThreadContext::ThreadContext(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro)
61 : AttachContext(std::move(code), actor, maestro)
63 /* If the user provided a function for the actor then use it */
65 /* create and start the actor */
66 this->thread_ = new std::thread(ThreadContext::wrapper, this);
67 /* wait the start of the newly created actor */
71 /* Otherwise, we attach to the current thread */
73 Context::set_current(this);
77 ThreadContext::~ThreadContext()
79 if (this->thread_) { /* Maestro don't have any thread */
85 void ThreadContext::wrapper(ThreadContext* context)
87 Context::set_current(context);
90 install_sigsegv_stack(nullptr, true);
92 // Tell the caller (normally the maestro) we are starting, and wait for its green light
93 context->end_.release();
98 if (not context->is_maestro()) // Just in case somebody detached maestro
100 } catch (ForcefulKillException const&) {
101 XBT_DEBUG("Caught a ForcefulKillException in Thread::wrapper");
102 xbt_assert(not context->is_maestro(), "Maestro shall not receive ForcefulKillExceptions, even when detached.");
103 } catch (simgrid::Exception const& e) {
104 XBT_INFO("Actor killed by an uncaught exception %s", boost::core::demangle(typeid(e).name()).c_str());
107 // Signal to the caller (normally the maestro) that we have finished:
111 install_sigsegv_stack(nullptr, false);
113 XBT_DEBUG("Terminating");
114 Context::set_current(nullptr);
117 void ThreadContext::release()
119 this->begin_.release();
122 void ThreadContext::wait()
124 this->end_.acquire();
127 void ThreadContext::start()
129 this->begin_.acquire();
133 void ThreadContext::yield()
136 this->end_.release();
139 void ThreadContext::suspend()
145 void ThreadContext::attach_start()
147 // We're breaking the layers here by depending on the upper layer:
148 auto* maestro = static_cast<ThreadContext*>(EngineImpl::get_instance()->get_maestro()->context_.get());
149 maestro->begin_.release();
150 xbt_assert(not this->is_maestro());
154 void ThreadContext::attach_stop()
156 xbt_assert(not this->is_maestro());
159 auto* maestro = static_cast<ThreadContext*>(EngineImpl::get_instance()->get_maestro()->context_.get());
160 maestro->end_.acquire();
162 Context::set_current(nullptr);
165 // SerialThreadContext
167 void SerialThreadContext::run_all(std::vector<actor::ActorImpl*> const& actors_list)
169 for (smx_actor_t const& actor : actors_list) {
170 XBT_DEBUG("Handling %p", actor);
171 auto* context = static_cast<ThreadContext*>(actor->context_.get());
177 // ParallelThreadContext
179 xbt::OsSemaphore* ParallelThreadContext::thread_sem_ = nullptr;
181 void ParallelThreadContext::initialize()
183 thread_sem_ = new xbt::OsSemaphore(get_nthreads());
186 void ParallelThreadContext::finalize()
189 thread_sem_ = nullptr;
192 void ParallelThreadContext::run_all(std::vector<actor::ActorImpl*> const& actors_list)
194 for (smx_actor_t const& actor : actors_list)
195 static_cast<ThreadContext*>(actor->context_.get())->release();
197 for (smx_actor_t const& actor : actors_list)
198 static_cast<ThreadContext*>(actor->context_.get())->wait();
201 void ParallelThreadContext::start_hook()
203 if (not is_maestro()) /* parallel run */
204 thread_sem_->acquire();
207 void ParallelThreadContext::yield_hook()
209 if (not is_maestro()) /* parallel run */
210 thread_sem_->release();
213 XBT_PRIVATE ContextFactory* thread_factory()
215 XBT_VERB("Activating thread context factory");
216 return new ThreadContextFactory();
218 } // namespace context
219 } // namespace kernel
220 } // namespace simgrid