Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
ContextThread: define {Serial,Parallel}ThreadContext, and reorganize.
[simgrid.git] / src / kernel / context / ContextThread.cpp
1 /* Copyright (c) 2009-2017. 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 <utility>
7 #include <functional>
8
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/swag.h"
14 #include "xbt/xbt_os_thread.h"
15
16 #include "src/kernel/context/ContextThread.hpp"
17
18 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
19
20 namespace simgrid {
21 namespace kernel {
22 namespace context {
23
24 // ThreadContextFactory
25
26 ThreadContextFactory::ThreadContextFactory()
27     : ContextFactory("ThreadContextFactory"), parallel_(SIMIX_context_is_parallel())
28 {
29   if (parallel_)
30     ParallelThreadContext::initialize();
31 }
32
33 ThreadContextFactory::~ThreadContextFactory()
34 {
35   if (parallel_)
36     ParallelThreadContext::finalize();
37 }
38
39 ThreadContext* ThreadContextFactory::create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup,
40                                                     smx_actor_t process, bool maestro)
41 {
42   if (parallel_)
43     return this->new_context<ParallelThreadContext>(std::move(code), cleanup, process, maestro);
44   else
45     return this->new_context<SerialThreadContext>(std::move(code), cleanup, process, maestro);
46 }
47
48 void ThreadContextFactory::run_all()
49 {
50   if (parallel_) {
51     // Parallel execution
52     ParallelThreadContext::run_all();
53   } else {
54     // Serial execution
55     SerialThreadContext::run_all();
56   }
57 }
58
59 // ThreadContext
60
61 ThreadContext::ThreadContext(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t process,
62                              bool maestro)
63     : AttachContext(std::move(code), cleanup, process), is_maestro_(maestro)
64 {
65   // We do not need the semaphores when maestro is in main,
66   // but creating them anyway simplifies things when maestro is externalized
67   this->begin_ = xbt_os_sem_init(0);
68   this->end_ = xbt_os_sem_init(0);
69
70   /* If the user provided a function for the process then use it */
71   if (has_code()) {
72     if (smx_context_stack_size_was_set)
73       xbt_os_thread_setstacksize(smx_context_stack_size);
74     if (smx_context_guard_size_was_set)
75       xbt_os_thread_setguardsize(smx_context_guard_size);
76
77     /* create and start the process */
78     /* NOTE: The first argument to xbt_os_thread_create used to be the process *
79     * name, but now the name is stored at SIMIX level, so we pass a null  */
80     this->thread_ = xbt_os_thread_create(nullptr, ThreadContext::wrapper, this, this);
81     /* wait the starting of the newly created process */
82     xbt_os_sem_acquire(this->end_);
83   }
84
85   /* Otherwise, we attach to the current thread */
86   else {
87     xbt_os_thread_set_extra_data(this);
88   }
89 }
90
91 ThreadContext::~ThreadContext()
92 {
93   if (this->thread_) /* If there is a thread (maestro don't have any), wait for its termination */
94     xbt_os_thread_join(this->thread_, nullptr);
95
96   /* destroy the synchronization objects */
97   xbt_os_sem_destroy(this->begin_);
98   xbt_os_sem_destroy(this->end_);
99 }
100
101 void *ThreadContext::wrapper(void *param)
102 {
103   ThreadContext* context = static_cast<ThreadContext*>(param);
104
105 #ifndef WIN32
106   /* Install alternate signal stack, for SIGSEGV handler. */
107   stack_t stack;
108   stack.ss_sp = sigsegv_stack;
109   stack.ss_size = sizeof sigsegv_stack;
110   stack.ss_flags = 0;
111   sigaltstack(&stack, nullptr);
112 #endif
113   // Tell the caller (normally the maestro) we are starting, and wait for its green light
114   xbt_os_sem_release(context->end_);
115   context->start();
116
117   try {
118     (*context)();
119     if (not context->isMaestro()) // really?
120       context->Context::stop();
121   } catch (StopRequest const&) {
122     XBT_DEBUG("Caught a StopRequest");
123     xbt_assert(not context->isMaestro(), "I'm not supposed to be maestro here.");
124   }
125
126   // Signal to the caller (normally the maestro) that we have finished:
127   context->yield();
128
129 #ifndef WIN32
130   stack.ss_flags = SS_DISABLE;
131   sigaltstack(&stack, nullptr);
132 #endif
133   return nullptr;
134 }
135
136 void ThreadContext::release()
137 {
138   xbt_os_sem_release(this->begin_);
139 }
140
141 void ThreadContext::wait()
142 {
143   xbt_os_sem_acquire(this->end_);
144 }
145
146 void ThreadContext::start()
147 {
148   xbt_os_sem_acquire(this->begin_);
149   this->start_hook();
150 }
151
152 void ThreadContext::yield()
153 {
154   this->yield_hook();
155   xbt_os_sem_release(this->end_);
156 }
157
158 void ThreadContext::stop()
159 {
160   Context::stop();
161   throw StopRequest();
162 }
163
164 void ThreadContext::suspend()
165 {
166   this->yield();
167   this->start();
168 }
169
170 void ThreadContext::attach_start()
171 {
172   // We're breaking the layers here by depending on the upper layer:
173   ThreadContext* maestro = (ThreadContext*) simix_global->maestro_process->context;
174   xbt_os_sem_release(maestro->begin_);
175   xbt_assert(not this->isMaestro());
176   this->start();
177 }
178
179 void ThreadContext::attach_stop()
180 {
181   xbt_assert(not this->isMaestro());
182   this->yield();
183
184   ThreadContext* maestro = (ThreadContext*) simix_global->maestro_process->context;
185   xbt_os_sem_acquire(maestro->end_);
186
187   xbt_os_thread_set_extra_data(nullptr);
188 }
189
190 // SerialThreadContext
191
192 void SerialThreadContext::run_all()
193 {
194   for (smx_actor_t const& process : simix_global->process_to_run) {
195     XBT_DEBUG("Handling %p", process);
196     ThreadContext* context = static_cast<ThreadContext*>(process->context);
197     context->release();
198     context->wait();
199   }
200 }
201
202 // ParallelThreadContext
203
204 xbt_os_sem_t ParallelThreadContext::thread_sem_ = nullptr;
205
206 void ParallelThreadContext::initialize()
207 {
208   thread_sem_ = xbt_os_sem_init(SIMIX_context_get_nthreads());
209 }
210
211 void ParallelThreadContext::finalize()
212 {
213   xbt_os_sem_destroy(thread_sem_);
214   thread_sem_ = nullptr;
215 }
216
217 void ParallelThreadContext::run_all()
218 {
219   for (smx_actor_t const& process : simix_global->process_to_run)
220     static_cast<ThreadContext*>(process->context)->release();
221   for (smx_actor_t const& process : simix_global->process_to_run)
222     static_cast<ThreadContext*>(process->context)->wait();
223 }
224
225 void ParallelThreadContext::start_hook()
226 {
227   if (not isMaestro()) /* parallel run */
228     xbt_os_sem_acquire(thread_sem_);
229 }
230
231 void ParallelThreadContext::yield_hook()
232 {
233   if (not isMaestro()) /* parallel run */
234     xbt_os_sem_release(thread_sem_);
235 }
236
237 XBT_PRIVATE ContextFactory* thread_factory()
238 {
239   XBT_VERB("Activating thread context factory");
240   return new ThreadContextFactory();
241 }
242 }}} // namespace