Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cosmetics in UCtx: hide one internal function and inline another
[simgrid.git] / src / kernel / context / ContextThread.cpp
1 /* Copyright (c) 2009-2019. 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 "src/kernel/context/ContextThread.hpp"
7
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
14 #include <functional>
15 #include <utility>
16
17 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
18
19 namespace simgrid {
20 namespace kernel {
21 namespace context {
22
23 // ThreadContextFactory
24
25 ThreadContextFactory::ThreadContextFactory() : ContextFactory(), parallel_(SIMIX_context_is_parallel())
26 {
27   if (parallel_)
28     ParallelThreadContext::initialize();
29 }
30
31 ThreadContextFactory::~ThreadContextFactory()
32 {
33   if (parallel_)
34     ParallelThreadContext::finalize();
35 }
36
37 ThreadContext* ThreadContextFactory::create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup,
38                                                     smx_actor_t actor, bool maestro)
39 {
40   if (parallel_)
41     return this->new_context<ParallelThreadContext>(std::move(code), cleanup, actor, maestro);
42   else
43     return this->new_context<SerialThreadContext>(std::move(code), cleanup, actor, maestro);
44 }
45
46 void ThreadContextFactory::run_all()
47 {
48   if (parallel_) {
49     // Parallel execution
50     ParallelThreadContext::run_all();
51   } else {
52     // Serial execution
53     SerialThreadContext::run_all();
54   }
55 }
56
57 // ThreadContext
58
59 ThreadContext::ThreadContext(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t actor, bool maestro)
60     : AttachContext(std::move(code), cleanup, actor), is_maestro_(maestro)
61 {
62   /* If the user provided a function for the actor then use it */
63   if (has_code()) {
64     /* create and start the actor */
65     this->thread_ = new std::thread(ThreadContext::wrapper, this);
66     /* wait the starting of the newly created actor */
67     this->end_.acquire();
68   }
69
70   /* Otherwise, we attach to the current thread */
71   else {
72     Context::set_current(this);
73   }
74 }
75
76 ThreadContext::~ThreadContext()
77 {
78   if (this->thread_) /* If there is a thread (maestro don't have any), wait for its termination */
79     thread_->join();
80   delete thread_;
81 }
82
83 void *ThreadContext::wrapper(void *param)
84 {
85   ThreadContext* context = static_cast<ThreadContext*>(param);
86   Context::set_current(context);
87
88 #ifndef WIN32
89   /* Install alternate signal stack, for SIGSEGV handler. */
90   stack_t stack;
91   stack.ss_sp = sigsegv_stack;
92   stack.ss_size = sizeof sigsegv_stack;
93   stack.ss_flags = 0;
94   sigaltstack(&stack, nullptr);
95 #endif
96   // Tell the caller (normally the maestro) we are starting, and wait for its green light
97   context->end_.release();
98   context->start();
99
100   try {
101     (*context)();
102   } catch (StopRequest const&) {
103     XBT_DEBUG("Caught a StopRequest");
104     xbt_assert(not context->is_maestro(), "Maestro shall not receive StopRequests, even when detached.");
105   } catch (simgrid::Exception const& e) {
106     XBT_INFO("Actor killed by an uncatched exception %s", simgrid::xbt::demangle(typeid(e).name()).get());
107     throw;
108   }
109   if (not context->is_maestro()) // Just in case somebody detached maestro
110     context->Context::stop();
111
112   // Signal to the caller (normally the maestro) that we have finished:
113   context->yield();
114
115 #ifndef WIN32
116   stack.ss_flags = SS_DISABLE;
117   sigaltstack(&stack, nullptr);
118 #endif
119   return nullptr;
120 }
121
122 void ThreadContext::release()
123 {
124   this->begin_.release();
125 }
126
127 void ThreadContext::wait()
128 {
129   this->end_.acquire();
130 }
131
132 void ThreadContext::start()
133 {
134   this->begin_.acquire();
135   this->start_hook();
136 }
137
138 void ThreadContext::yield()
139 {
140   this->yield_hook();
141   this->end_.release();
142 }
143
144 void ThreadContext::stop()
145 {
146   Context::stop();
147   throw StopRequest();
148 }
149
150 void ThreadContext::suspend()
151 {
152   this->yield();
153   this->start();
154 }
155
156 void ThreadContext::attach_start()
157 {
158   // We're breaking the layers here by depending on the upper layer:
159   ThreadContext* maestro = (ThreadContext*)simix_global->maestro_process->context_;
160   maestro->begin_.release();
161   xbt_assert(not this->is_maestro());
162   this->start();
163 }
164
165 void ThreadContext::attach_stop()
166 {
167   xbt_assert(not this->is_maestro());
168   this->yield();
169
170   ThreadContext* maestro = (ThreadContext*)simix_global->maestro_process->context_;
171   maestro->end_.acquire();
172
173   Context::set_current(nullptr);
174 }
175
176 // SerialThreadContext
177
178 void SerialThreadContext::run_all()
179 {
180   for (smx_actor_t const& actor : simix_global->process_to_run) {
181     XBT_DEBUG("Handling %p", actor);
182     ThreadContext* context = static_cast<ThreadContext*>(actor->context_);
183     context->release();
184     context->wait();
185   }
186 }
187
188 // ParallelThreadContext
189
190 xbt::OsSemaphore* ParallelThreadContext::thread_sem_ = nullptr;
191
192 void ParallelThreadContext::initialize()
193 {
194   thread_sem_ = new xbt::OsSemaphore(SIMIX_context_get_nthreads());
195 }
196
197 void ParallelThreadContext::finalize()
198 {
199   delete thread_sem_;
200   thread_sem_ = nullptr;
201 }
202
203 void ParallelThreadContext::run_all()
204 {
205   for (smx_actor_t const& actor : simix_global->process_to_run)
206     static_cast<ThreadContext*>(actor->context_)->release();
207   for (smx_actor_t const& actor : simix_global->process_to_run)
208     static_cast<ThreadContext*>(actor->context_)->wait();
209 }
210
211 void ParallelThreadContext::start_hook()
212 {
213   if (not is_maestro()) /* parallel run */
214     thread_sem_->acquire();
215 }
216
217 void ParallelThreadContext::yield_hook()
218 {
219   if (not is_maestro()) /* parallel run */
220     thread_sem_->release();
221 }
222
223 XBT_PRIVATE ContextFactory* thread_factory()
224 {
225   XBT_VERB("Activating thread context factory");
226   return new ThreadContextFactory();
227 }
228 }}} // namespace