Logo AND Algorithmique Numérique Distribuée

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