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. */
6 /* \file UContext.cpp Context switching with ucontexts from System V */
8 #include "ContextUnix.hpp"
9 #include "context_private.hpp"
12 #include "src/mc/mc_ignore.hpp"
13 #include "src/simix/ActorImpl.hpp"
15 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
17 /** Many integers are needed to store a pointer
19 * Support up to two ints. */
20 constexpr int CTX_ADDR_LEN = 2;
22 static_assert(sizeof(simgrid::kernel::context::UContext*) <= CTX_ADDR_LEN * sizeof(int),
23 "Ucontexts are not supported on this arch yet");
31 UContextFactory::UContextFactory() : ContextFactory("UContextFactory"), parallel_(SIMIX_context_is_parallel())
33 UContext::setMaestro(nullptr);
35 #if HAVE_THREAD_CONTEXTS
36 ParallelUContext::initialize();
38 xbt_die("No thread support for parallel context execution");
43 UContextFactory::~UContextFactory()
45 #if HAVE_THREAD_CONTEXTS
47 ParallelUContext::finalize();
51 Context* UContextFactory::create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t process)
53 #if HAVE_THREAD_CONTEXTS
55 return new_context<ParallelUContext>(std::move(code), cleanup, process);
58 return new_context<SerialUContext>(std::move(code), cleanup, process);
61 /* This function is called by maestro at the beginning of a scheduling round to get all working threads executing some
62 * stuff It is much easier to understand what happens if you see the working threads as bodies that swap their soul for
63 * the ones of the simulated processes that must run.
65 void UContextFactory::run_all()
67 #if HAVE_THREAD_CONTEXTS
69 ParallelUContext::run_all();
72 SerialUContext::run_all();
77 UContext* UContext::maestro_context_ = nullptr;
79 UContext::UContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process)
80 : Context(std::move(code), cleanup_func, process)
82 /* if the user provided a function for the process then use it, otherwise it is the context for maestro */
84 this->stack_ = SIMIX_context_stack_new();
85 getcontext(&this->uc_);
86 this->uc_.uc_link = nullptr;
87 this->uc_.uc_stack.ss_sp = sg_makecontext_stack_addr(this->stack_);
88 this->uc_.uc_stack.ss_size = sg_makecontext_stack_size(smx_context_usable_stack_size);
89 #if PTH_STACKGROWTH == -1
90 ASAN_ONLY(this->asan_stack_ = static_cast<char*>(this->stack_) + smx_context_usable_stack_size);
92 ASAN_ONLY(this->asan_stack_ = this->stack_);
94 UContext::make_ctx(&this->uc_, UContext::smx_ctx_sysv_wrapper, this);
96 if (process != nullptr && maestro_context_ == nullptr)
97 maestro_context_ = this;
101 if (MC_is_active() && has_code()) {
102 MC_register_stack_area(this->stack_, process, &(this->uc_), smx_context_usable_stack_size);
107 UContext::~UContext()
109 SIMIX_context_stack_delete(this->stack_);
112 // The name of this function is currently hardcoded in the code (as string).
113 // Do not change it without fixing those references as well.
114 void UContext::smx_ctx_sysv_wrapper(int i1, int i2)
116 // Rebuild the Context* pointer from the integers:
117 int ctx_addr[CTX_ADDR_LEN] = {i1, i2};
118 simgrid::kernel::context::UContext* context;
119 memcpy(&context, ctx_addr, sizeof context);
121 ASAN_FINISH_SWITCH(nullptr, &context->asan_ctx_->asan_stack_, &context->asan_ctx_->asan_stack_size_);
124 context->Context::stop();
125 } catch (simgrid::kernel::context::Context::StopRequest const&) {
126 XBT_DEBUG("Caught a StopRequest");
128 ASAN_ONLY(context->asan_stop_ = true);
132 /** A better makecontext
134 * Makecontext expects integer arguments, we the context variable is decomposed into a serie of integers and each
135 * integer is passed as argument to makecontext.
137 void UContext::make_ctx(ucontext_t* ucp, void (*func)(int, int), UContext* arg)
139 int ctx_addr[CTX_ADDR_LEN]{};
140 memcpy(ctx_addr, &arg, sizeof arg);
141 makecontext(ucp, (void (*)())func, 2, ctx_addr[0], ctx_addr[1]);
144 inline void UContext::swap(UContext* from, UContext* to)
146 void* fake_stack = nullptr;
147 ASAN_ONLY(to->asan_ctx_ = from);
148 ASAN_START_SWITCH(from->asan_stop_ ? nullptr : &fake_stack, to->asan_stack_, to->asan_stack_size_);
149 swapcontext(&from->uc_, &to->uc_);
150 ASAN_FINISH_SWITCH(fake_stack, &from->asan_ctx_->asan_stack_, &from->asan_ctx_->asan_stack_size_);
153 void UContext::stop()
161 unsigned long SerialUContext::process_index_; /* index of the next process to run in the list of runnable processes */
163 void SerialUContext::suspend()
165 /* determine the next context */
166 SerialUContext* next_context;
167 unsigned long int i = process_index_;
170 if (i < simix_global->process_to_run.size()) {
171 /* execute the next process */
172 XBT_DEBUG("Run next process");
173 next_context = static_cast<SerialUContext*>(simix_global->process_to_run[i]->context);
175 /* all processes were run, return to maestro */
176 XBT_DEBUG("No more process to run");
177 next_context = static_cast<SerialUContext*>(UContext::getMaestro());
179 SIMIX_context_set_current(next_context);
180 UContext::swap(this, next_context);
183 void SerialUContext::resume()
185 SIMIX_context_set_current(this);
186 UContext::swap(UContext::getMaestro(), this);
189 void SerialUContext::run_all()
191 if (simix_global->process_to_run.empty())
193 smx_actor_t first_process = simix_global->process_to_run.front();
195 static_cast<SerialUContext*>(first_process->context)->resume();
200 #if HAVE_THREAD_CONTEXTS
202 simgrid::xbt::Parmap<smx_actor_t>* ParallelUContext::parmap_;
203 std::atomic<uintptr_t> ParallelUContext::threads_working_; /* number of threads that have started their work */
204 xbt_os_thread_key_t ParallelUContext::worker_id_key_; /* thread-specific storage for the thread id */
205 std::vector<ParallelUContext*> ParallelUContext::workers_context_; /* space to save the worker's context
208 void ParallelUContext::initialize()
211 workers_context_.clear();
212 workers_context_.resize(SIMIX_context_get_nthreads(), nullptr);
213 xbt_os_thread_key_create(&worker_id_key_);
216 void ParallelUContext::finalize()
220 workers_context_.clear();
221 xbt_os_thread_key_destroy(worker_id_key_);
224 void ParallelUContext::run_all()
226 threads_working_ = 0;
227 // Parmap_apply ensures that every working thread get an index in the process_to_run array (through an atomic
228 // fetch_and_add), and runs the ParallelUContext::resume function on that index
230 // We lazily create the parmap because the parmap creates context with simix_global->context_factory (which might not
231 // be initialized when bootstrapping):
232 if (parmap_ == nullptr)
233 parmap_ = new simgrid::xbt::Parmap<smx_actor_t>(SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
235 [](smx_actor_t process) {
236 ParallelUContext* context = static_cast<ParallelUContext*>(process->context);
239 simix_global->process_to_run);
244 * This function is called when a simulated process wants to yield back to the maestro in a blocking simcall. This
245 * naturally occurs within SIMIX_context_suspend(self->context), called from SIMIX_process_yield() Actually, it does not
246 * really yield back to maestro, but into the next process that must be executed. If no one is to be executed, then it
247 * yields to the initial soul that was in this working thread (that was saved in resume_parallel).
249 void ParallelUContext::suspend()
251 /* determine the next context */
252 // Get the next soul to embody now:
253 boost::optional<smx_actor_t> next_work = parmap_->next();
254 ParallelUContext* next_context;
256 // There is a next soul to embody (ie, a next process to resume)
257 XBT_DEBUG("Run next process");
258 next_context = static_cast<ParallelUContext*>(next_work.get()->context);
260 // All processes were run, go to the barrier
261 XBT_DEBUG("No more processes to run");
262 // Get back the identity of my body that was stored when starting the scheduling round
263 uintptr_t worker_id = reinterpret_cast<uintptr_t>(xbt_os_thread_get_specific(worker_id_key_));
264 // Deduce the initial soul of that body
265 next_context = workers_context_[worker_id];
266 // When given that soul, the body will wait for the next scheduling round
269 SIMIX_context_set_current(next_context);
270 // Get the next soul to run, either simulated or initial minion's one:
271 UContext::swap(this, next_context);
274 /** Run one particular simulated process on the current thread. */
275 void ParallelUContext::resume()
277 // What is my containing body?
278 uintptr_t worker_id = threads_working_.fetch_add(1, std::memory_order_relaxed);
279 // Store the number of my containing body in os-thread-specific area :
280 xbt_os_thread_set_specific(worker_id_key_, reinterpret_cast<void*>(worker_id));
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()
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
300 XBT_PRIVATE ContextFactory* sysv_factory()
302 XBT_VERB("Activating SYSV context factory");
303 return new UContextFactory();
305 }}} // namespace simgrid::kernel::context