Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
please sonar on rethrow
[simgrid.git] / src / kernel / context / ContextUnix.cpp
1 /* Copyright (c) 2009-2018. 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 /* \file UContext.cpp Context switching with ucontexts from System V        */
7
8 #include "context_private.hpp"
9
10 #include "mc/mc.h"
11 #include "simgrid/Exception.hpp"
12 #include "src/mc/mc_ignore.hpp"
13 #include "src/simix/ActorImpl.hpp"
14
15 #include "ContextUnix.hpp"
16
17 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
18
19 /** Many integers are needed to store a pointer
20  *
21  * Support up to two ints. */
22 constexpr int CTX_ADDR_LEN = 2;
23
24 static_assert(sizeof(simgrid::kernel::context::UContext*) <= CTX_ADDR_LEN * sizeof(int),
25               "Ucontexts are not supported on this arch yet");
26
27 namespace simgrid {
28 namespace kernel {
29 namespace context {
30
31 // UContextFactory
32
33 UContextFactory::UContextFactory() : ContextFactory("UContextFactory"), parallel_(SIMIX_context_is_parallel())
34 {
35   UContext::setMaestro(nullptr);
36   if (parallel_) {
37 #if HAVE_THREAD_CONTEXTS
38     ParallelUContext::initialize();
39 #else
40     xbt_die("No thread support for parallel context execution");
41 #endif
42   }
43 }
44
45 UContextFactory::~UContextFactory()
46 {
47 #if HAVE_THREAD_CONTEXTS
48   if (parallel_)
49     ParallelUContext::finalize();
50 #endif
51 }
52
53 Context* UContextFactory::create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t process)
54 {
55 #if HAVE_THREAD_CONTEXTS
56   if (parallel_)
57     return new_context<ParallelUContext>(std::move(code), cleanup, process);
58   else
59 #endif
60     return new_context<SerialUContext>(std::move(code), cleanup, process);
61 }
62
63 /* This function is called by maestro at the beginning of a scheduling round to get all working threads executing some
64  * stuff It is much easier to understand what happens if you see the working threads as bodies that swap their soul for
65  * the ones of the simulated processes that must run.
66  */
67 void UContextFactory::run_all()
68 {
69 #if HAVE_THREAD_CONTEXTS
70   if (parallel_)
71     ParallelUContext::run_all();
72   else
73 #endif
74     SerialUContext::run_all();
75 }
76
77 // UContext
78
79 UContext* UContext::maestro_context_ = nullptr;
80
81 UContext::UContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process)
82     : Context(std::move(code), cleanup_func, process)
83 {
84   /* if the user provided a function for the process then use it, otherwise it is the context for maestro */
85   if (has_code()) {
86     this->stack_ = SIMIX_context_stack_new();
87     getcontext(&this->uc_);
88     this->uc_.uc_link = nullptr;
89     this->uc_.uc_stack.ss_sp   = sg_makecontext_stack_addr(this->stack_);
90     this->uc_.uc_stack.ss_size = sg_makecontext_stack_size(smx_context_usable_stack_size);
91 #if PTH_STACKGROWTH == -1
92     ASAN_ONLY(this->asan_stack_ = static_cast<char*>(this->stack_) + smx_context_usable_stack_size);
93 #else
94     ASAN_ONLY(this->asan_stack_ = this->stack_);
95 #endif
96     UContext::make_ctx(&this->uc_, UContext::smx_ctx_sysv_wrapper, this);
97   } else {
98     if (process != nullptr && maestro_context_ == nullptr)
99       maestro_context_ = this;
100   }
101
102 #if SIMGRID_HAVE_MC
103   if (MC_is_active() && has_code()) {
104     MC_register_stack_area(this->stack_, process, &(this->uc_), smx_context_usable_stack_size);
105   }
106 #endif
107 }
108
109 UContext::~UContext()
110 {
111   SIMIX_context_stack_delete(this->stack_);
112 }
113
114 // The name of this function is currently hardcoded in the code (as string).
115 // Do not change it without fixing those references as well.
116 void UContext::smx_ctx_sysv_wrapper(int i1, int i2)
117 {
118   // Rebuild the Context* pointer from the integers:
119   int ctx_addr[CTX_ADDR_LEN] = {i1, i2};
120   simgrid::kernel::context::UContext* context;
121   memcpy(&context, ctx_addr, sizeof context);
122
123   ASAN_FINISH_SWITCH(nullptr, &context->asan_ctx_->asan_stack_, &context->asan_ctx_->asan_stack_size_);
124   try {
125     (*context)();
126   } catch (simgrid::kernel::context::Context::StopRequest const&) {
127     XBT_DEBUG("Caught a StopRequest");
128   } catch (simgrid::Exception const& e) {
129     XBT_INFO("Actor killed by an uncatched exception %s", simgrid::xbt::demangle(typeid(e).name()).get());
130     throw;
131   }
132   context->Context::stop();
133   ASAN_ONLY(context->asan_stop_ = true);
134   context->suspend();
135 }
136
137 /** A better makecontext
138  *
139  * Makecontext expects integer arguments, we the context variable is decomposed into a serie of integers and each
140  * integer is passed as argument to makecontext.
141  */
142 void UContext::make_ctx(ucontext_t* ucp, void (*func)(int, int), UContext* arg)
143 {
144   int ctx_addr[CTX_ADDR_LEN]{};
145   memcpy(ctx_addr, &arg, sizeof arg);
146   makecontext(ucp, (void (*)())func, 2, ctx_addr[0], ctx_addr[1]);
147 }
148
149 inline void UContext::swap(UContext* from, UContext* to)
150 {
151   ASAN_ONLY(void* fake_stack = nullptr);
152   ASAN_ONLY(to->asan_ctx_ = from);
153   ASAN_START_SWITCH(from->asan_stop_ ? nullptr : &fake_stack, to->asan_stack_, to->asan_stack_size_);
154   swapcontext(&from->uc_, &to->uc_);
155   ASAN_FINISH_SWITCH(fake_stack, &from->asan_ctx_->asan_stack_, &from->asan_ctx_->asan_stack_size_);
156 }
157
158 void UContext::stop()
159 {
160   Context::stop();
161   throw StopRequest();
162 }
163
164 // SerialUContext
165
166 unsigned long SerialUContext::process_index_; /* index of the next process to run in the list of runnable processes */
167
168 void SerialUContext::suspend()
169 {
170   /* determine the next context */
171   SerialUContext* next_context;
172   unsigned long int i = process_index_;
173   process_index_++;
174
175   if (i < simix_global->process_to_run.size()) {
176     /* execute the next process */
177     XBT_DEBUG("Run next process");
178     next_context = static_cast<SerialUContext*>(simix_global->process_to_run[i]->context_);
179   } else {
180     /* all processes were run, return to maestro */
181     XBT_DEBUG("No more process to run");
182     next_context = static_cast<SerialUContext*>(UContext::getMaestro());
183   }
184   SIMIX_context_set_current(next_context);
185   UContext::swap(this, next_context);
186 }
187
188 void SerialUContext::resume()
189 {
190   SIMIX_context_set_current(this);
191   UContext::swap(UContext::getMaestro(), this);
192 }
193
194 void SerialUContext::run_all()
195 {
196   if (simix_global->process_to_run.empty())
197     return;
198   smx_actor_t first_process = simix_global->process_to_run.front();
199   process_index_            = 1;
200   static_cast<SerialUContext*>(first_process->context_)->resume();
201 }
202
203 // ParallelUContext
204
205 #if HAVE_THREAD_CONTEXTS
206
207 simgrid::xbt::Parmap<smx_actor_t>* ParallelUContext::parmap_;
208 std::atomic<uintptr_t> ParallelUContext::threads_working_;         /* number of threads that have started their work */
209 thread_local uintptr_t ParallelUContext::worker_id_;               /* thread-specific storage for the thread id */
210 std::vector<ParallelUContext*> ParallelUContext::workers_context_; /* space to save the worker's context
211                                                                     * in each thread */
212
213 void ParallelUContext::initialize()
214 {
215   parmap_ = nullptr;
216   workers_context_.clear();
217   workers_context_.resize(SIMIX_context_get_nthreads(), nullptr);
218 }
219
220 void ParallelUContext::finalize()
221 {
222   delete parmap_;
223   parmap_ = nullptr;
224   workers_context_.clear();
225 }
226
227 void ParallelUContext::run_all()
228 {
229   threads_working_ = 0;
230   // Parmap_apply ensures that every working thread get an index in the process_to_run array (through an atomic
231   // fetch_and_add), and runs the ParallelUContext::resume function on that index
232
233   // We lazily create the parmap because the parmap creates context with simix_global->context_factory (which might not
234   // be initialized when bootstrapping):
235   if (parmap_ == nullptr)
236     parmap_ = new simgrid::xbt::Parmap<smx_actor_t>(SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
237   parmap_->apply(
238       [](smx_actor_t process) {
239         ParallelUContext* context = static_cast<ParallelUContext*>(process->context_);
240         context->resume();
241       },
242       simix_global->process_to_run);
243 }
244
245 /** Yield
246  *
247  * This function is called when a simulated process wants to yield back to the maestro in a blocking simcall. This
248  * naturally occurs within SIMIX_context_suspend(self->context), called from SIMIX_process_yield() Actually, it does not
249  * really yield back to maestro, but into the next process that must be executed. If no one is to be executed, then it
250  * yields to the initial soul that was in this working thread (that was saved in resume_parallel).
251  */
252 void ParallelUContext::suspend()
253 {
254   /* determine the next context */
255   // Get the next soul to embody now:
256   boost::optional<smx_actor_t> next_work = parmap_->next();
257   ParallelUContext* next_context;
258   if (next_work) {
259     // There is a next soul to embody (ie, a next process to resume)
260     XBT_DEBUG("Run next process");
261     next_context = static_cast<ParallelUContext*>(next_work.get()->context_);
262   } else {
263     // All processes were run, go to the barrier
264     XBT_DEBUG("No more processes to run");
265     // worker_id_ is the identity of my body, stored in thread_local when starting the scheduling round
266     // Deduce the initial soul of that body
267     next_context = workers_context_[worker_id_];
268     // When given that soul, the body will wait for the next scheduling round
269   }
270
271   SIMIX_context_set_current(next_context);
272   // Get the next soul to run, either simulated or initial minion's one:
273   UContext::swap(this, next_context);
274 }
275
276 /** Run one particular simulated process on the current thread. */
277 void ParallelUContext::resume()
278 {
279   // What is my containing body? Store its number in os-thread-specific area :
280   worker_id_ = threads_working_.fetch_add(1, std::memory_order_relaxed);
281   // Get my current soul:
282   ParallelUContext* worker_context = static_cast<ParallelUContext*>(SIMIX_context_self());
283   // Write down that this soul is hosted in that body (for now)
284   workers_context_[worker_id_] = worker_context;
285   // Write in simix that I switched my soul
286   SIMIX_context_set_current(this);
287   // Actually do that using the relevant library call:
288   UContext::swap(worker_context, this);
289   // No body runs that soul anymore at this point.  Instead the current body took the soul of simulated process The
290   // simulated process wakes back after the call to "SIMIX_context_suspend(self->context);" within
291   // smx_process.c::SIMIX_process_yield()
292
293   // From now on, the simulated processes will change their soul with the next soul to execute (in suspend_parallel,
294   // below).  When nobody is to be executed in this scheduling round, the last simulated process will take back the
295   // initial soul of the current working thread
296 }
297
298 #endif
299
300 XBT_PRIVATE ContextFactory* sysv_factory()
301 {
302   XBT_VERB("Activating SYSV context factory");
303   return new UContextFactory();
304 }
305 }}} // namespace simgrid::kernel::context