1 /* Copyright (c) 2009-2018. 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/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 #include "xbt/xbt_os_thread.h"
18 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
24 // ThreadContextFactory
26 ThreadContextFactory::ThreadContextFactory()
27 : ContextFactory("ThreadContextFactory"), parallel_(SIMIX_context_is_parallel())
30 ParallelThreadContext::initialize();
33 ThreadContextFactory::~ThreadContextFactory()
36 ParallelThreadContext::finalize();
39 ThreadContext* ThreadContextFactory::create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup,
40 smx_actor_t process, bool maestro)
43 return this->new_context<ParallelThreadContext>(std::move(code), cleanup, process, maestro);
45 return this->new_context<SerialThreadContext>(std::move(code), cleanup, process, maestro);
48 void ThreadContextFactory::run_all()
52 ParallelThreadContext::run_all();
55 SerialThreadContext::run_all();
61 ThreadContext::ThreadContext(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t actor, bool maestro)
62 : AttachContext(std::move(code), cleanup, actor), is_maestro_(maestro)
64 /* If the user provided a function for the process then use it */
66 if (smx_context_stack_size_was_set)
67 xbt_os_thread_setstacksize(smx_context_stack_size);
68 if (smx_context_guard_size_was_set)
69 xbt_os_thread_setguardsize(smx_context_guard_size);
71 /* create and start the process */
72 /* NOTE: The first argument to xbt_os_thread_create used to be the process *
73 * name, but now the name is stored at SIMIX level, so we pass a null */
74 this->thread_ = xbt_os_thread_create(nullptr, ThreadContext::wrapper, this, this);
75 /* wait the starting of the newly created process */
79 /* Otherwise, we attach to the current thread */
81 SIMIX_context_set_current(this);
85 ThreadContext::~ThreadContext()
87 if (this->thread_) /* If there is a thread (maestro don't have any), wait for its termination */
88 xbt_os_thread_join(this->thread_, nullptr);
91 void *ThreadContext::wrapper(void *param)
93 ThreadContext* context = static_cast<ThreadContext*>(param);
94 SIMIX_context_set_current(context);
97 /* Install alternate signal stack, for SIGSEGV handler. */
99 stack.ss_sp = sigsegv_stack;
100 stack.ss_size = sizeof sigsegv_stack;
102 sigaltstack(&stack, nullptr);
104 // Tell the caller (normally the maestro) we are starting, and wait for its green light
105 context->end_.release();
110 } catch (StopRequest const&) {
111 XBT_DEBUG("Caught a StopRequest");
112 xbt_assert(not context->is_maestro(), "Maestro shall not receive StopRequests, even when detached.");
113 } catch (simgrid::Exception const& e) {
114 XBT_INFO("Actor killed by an uncatched exception %s", simgrid::xbt::demangle(typeid(e).name()).get());
117 if (not context->is_maestro()) // Just in case somebody detached maestro
118 context->Context::stop();
120 // Signal to the caller (normally the maestro) that we have finished:
124 stack.ss_flags = SS_DISABLE;
125 sigaltstack(&stack, nullptr);
130 void ThreadContext::release()
132 this->begin_.release();
135 void ThreadContext::wait()
137 this->end_.acquire();
140 void ThreadContext::start()
142 this->begin_.acquire();
146 void ThreadContext::yield()
149 this->end_.release();
152 void ThreadContext::stop()
158 void ThreadContext::suspend()
164 void ThreadContext::attach_start()
166 // We're breaking the layers here by depending on the upper layer:
167 ThreadContext* maestro = (ThreadContext*)simix_global->maestro_process->context_;
168 maestro->begin_.release();
169 xbt_assert(not this->is_maestro());
173 void ThreadContext::attach_stop()
175 xbt_assert(not this->is_maestro());
178 ThreadContext* maestro = (ThreadContext*)simix_global->maestro_process->context_;
179 maestro->end_.acquire();
181 SIMIX_context_set_current(nullptr);
184 // SerialThreadContext
186 void SerialThreadContext::run_all()
188 for (smx_actor_t const& process : simix_global->process_to_run) {
189 XBT_DEBUG("Handling %p", process);
190 ThreadContext* context = static_cast<ThreadContext*>(process->context_);
196 // ParallelThreadContext
198 xbt::OsSemaphore* ParallelThreadContext::thread_sem_ = nullptr;
200 void ParallelThreadContext::initialize()
202 thread_sem_ = new xbt::OsSemaphore(SIMIX_context_get_nthreads());
205 void ParallelThreadContext::finalize()
208 thread_sem_ = nullptr;
211 void ParallelThreadContext::run_all()
213 for (smx_actor_t const& process : simix_global->process_to_run)
214 static_cast<ThreadContext*>(process->context_)->release();
215 for (smx_actor_t const& process : simix_global->process_to_run)
216 static_cast<ThreadContext*>(process->context_)->wait();
219 void ParallelThreadContext::start_hook()
221 if (not is_maestro()) /* parallel run */
222 thread_sem_->acquire();
225 void ParallelThreadContext::yield_hook()
227 if (not is_maestro()) /* parallel run */
228 thread_sem_->release();
231 XBT_PRIVATE ContextFactory* thread_factory()
233 XBT_VERB("Activating thread context factory");
234 return new ThreadContextFactory();