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. */
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"
15 #include "src/kernel/context/ContextThread.hpp"
17 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
23 // ThreadContextFactory
25 ThreadContextFactory::ThreadContextFactory()
26 : ContextFactory("ThreadContextFactory"), parallel_(SIMIX_context_is_parallel())
29 ParallelThreadContext::initialize();
32 ThreadContextFactory::~ThreadContextFactory()
35 ParallelThreadContext::finalize();
38 ThreadContext* ThreadContextFactory::create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup,
39 smx_actor_t process, bool maestro)
42 return this->new_context<ParallelThreadContext>(std::move(code), cleanup, process, maestro);
44 return this->new_context<SerialThreadContext>(std::move(code), cleanup, process, maestro);
47 void ThreadContextFactory::run_all()
51 ParallelThreadContext::run_all();
54 SerialThreadContext::run_all();
60 ThreadContext::ThreadContext(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t process,
62 : AttachContext(std::move(code), cleanup, process), is_maestro_(maestro)
64 // We do not need the semaphores when maestro is in main,
65 // but creating them anyway simplifies things when maestro is externalized
66 this->begin_ = xbt_os_sem_init(0);
67 this->end_ = xbt_os_sem_init(0);
69 /* If the user provided a function for the process then use it */
71 if (smx_context_stack_size_was_set)
72 xbt_os_thread_setstacksize(smx_context_stack_size);
73 if (smx_context_guard_size_was_set)
74 xbt_os_thread_setguardsize(smx_context_guard_size);
76 /* create and start the process */
77 /* NOTE: The first argument to xbt_os_thread_create used to be the process *
78 * name, but now the name is stored at SIMIX level, so we pass a null */
79 this->thread_ = xbt_os_thread_create(nullptr, ThreadContext::wrapper, this, this);
80 /* wait the starting of the newly created process */
81 xbt_os_sem_acquire(this->end_);
84 /* Otherwise, we attach to the current thread */
86 xbt_os_thread_set_extra_data(this);
90 ThreadContext::~ThreadContext()
92 if (this->thread_) /* If there is a thread (maestro don't have any), wait for its termination */
93 xbt_os_thread_join(this->thread_, nullptr);
95 /* destroy the synchronization objects */
96 xbt_os_sem_destroy(this->begin_);
97 xbt_os_sem_destroy(this->end_);
100 void *ThreadContext::wrapper(void *param)
102 ThreadContext* context = static_cast<ThreadContext*>(param);
105 /* Install alternate signal stack, for SIGSEGV handler. */
107 stack.ss_sp = sigsegv_stack;
108 stack.ss_size = sizeof sigsegv_stack;
110 sigaltstack(&stack, nullptr);
112 // Tell the caller (normally the maestro) we are starting, and wait for its green light
113 xbt_os_sem_release(context->end_);
118 if (not context->isMaestro()) // really?
119 context->Context::stop();
120 } catch (StopRequest const&) {
121 XBT_DEBUG("Caught a StopRequest");
122 xbt_assert(not context->isMaestro(), "I'm not supposed to be maestro here.");
125 // Signal to the caller (normally the maestro) that we have finished:
129 stack.ss_flags = SS_DISABLE;
130 sigaltstack(&stack, nullptr);
135 void ThreadContext::release()
137 xbt_os_sem_release(this->begin_);
140 void ThreadContext::wait()
142 xbt_os_sem_acquire(this->end_);
145 void ThreadContext::start()
147 xbt_os_sem_acquire(this->begin_);
151 void ThreadContext::yield()
154 xbt_os_sem_release(this->end_);
157 void ThreadContext::stop()
163 void ThreadContext::suspend()
169 void ThreadContext::attach_start()
171 // We're breaking the layers here by depending on the upper layer:
172 ThreadContext* maestro = (ThreadContext*) simix_global->maestro_process->context;
173 xbt_os_sem_release(maestro->begin_);
174 xbt_assert(not this->isMaestro());
178 void ThreadContext::attach_stop()
180 xbt_assert(not this->isMaestro());
183 ThreadContext* maestro = (ThreadContext*) simix_global->maestro_process->context;
184 xbt_os_sem_acquire(maestro->end_);
186 xbt_os_thread_set_extra_data(nullptr);
189 // SerialThreadContext
191 void SerialThreadContext::run_all()
193 for (smx_actor_t const& process : simix_global->process_to_run) {
194 XBT_DEBUG("Handling %p", process);
195 ThreadContext* context = static_cast<ThreadContext*>(process->context);
201 // ParallelThreadContext
203 xbt_os_sem_t ParallelThreadContext::thread_sem_ = nullptr;
205 void ParallelThreadContext::initialize()
207 thread_sem_ = xbt_os_sem_init(SIMIX_context_get_nthreads());
210 void ParallelThreadContext::finalize()
212 xbt_os_sem_destroy(thread_sem_);
213 thread_sem_ = nullptr;
216 void ParallelThreadContext::run_all()
218 for (smx_actor_t const& process : simix_global->process_to_run)
219 static_cast<ThreadContext*>(process->context)->release();
220 for (smx_actor_t const& process : simix_global->process_to_run)
221 static_cast<ThreadContext*>(process->context)->wait();
224 void ParallelThreadContext::start_hook()
226 if (not isMaestro()) /* parallel run */
227 xbt_os_sem_acquire(thread_sem_);
230 void ParallelThreadContext::yield_hook()
232 if (not isMaestro()) /* parallel run */
233 xbt_os_sem_release(thread_sem_);
236 XBT_PRIVATE ContextFactory* thread_factory()
238 XBT_VERB("Activating thread context factory");
239 return new ThreadContextFactory();