1 /* Copyright (c) 2009-2023. 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 #include "simgrid/Exception.hpp"
7 #include "simgrid/modelchecker.h"
8 #include "src/internal_config.h"
9 #include "src/kernel/EngineImpl.hpp"
10 #include "src/kernel/actor/ActorImpl.hpp"
11 #include "src/sthread/sthread.h"
12 #include "src/xbt/parmap.hpp"
14 #include "src/kernel/context/ContextSwapped.hpp"
16 #include <boost/core/demangle.hpp>
22 #include <valgrind/valgrind.h>
24 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
25 #include <sanitizer/asan_interface.h>
27 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
28 #include <sanitizer/tsan_interface.h>
31 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(ker_context);
33 // The name of this function is currently hardcoded in MC (as string).
34 // Do not change it without fixing those references as well.
35 void smx_ctx_wrapper(simgrid::kernel::context::SwappedContext* context)
37 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
38 __sanitizer_finish_switch_fiber(nullptr, &context->asan_ctx_->asan_stack_, &context->asan_ctx_->asan_stack_size_);
45 } catch (simgrid::ForcefulKillException const&) {
47 XBT_DEBUG("Caught a ForcefulKillException");
48 } catch (simgrid::Exception const& e) {
50 XBT_INFO("Actor killed by an uncaught exception %s", boost::core::demangle(typeid(e).name()).c_str());
53 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
54 context->asan_stop_ = true;
60 namespace simgrid::kernel::context {
62 /* thread-specific storage for the worker's context */
63 thread_local SwappedContext* SwappedContext::worker_context_ = nullptr;
65 SwappedContext::SwappedContext(std::function<void()>&& code, actor::ActorImpl* actor, SwappedContextFactory* factory)
66 : Context(std::move(code), actor, not code /* maestro if no code */), factory_(*factory)
68 // Save maestro (=first created context) in preparation for run_all
69 if (not is_parallel() && factory_.maestro_context_ == nullptr)
70 factory_.maestro_context_ = this;
73 xbt_assert((actor->get_stacksize() & 0xf) == 0, "Actor stack size should be multiple of 16");
74 if (guard_size > 0 && not MC_is_active()) {
75 #if PTH_STACKGROWTH != -1
77 "Stack overflow protection is known to be broken on your system: you stacks grow upwards (or detection is "
79 "Please disable stack guards with --cfg=contexts:guard-size:0");
80 /* Current code for stack overflow protection assumes that stacks are growing downward (PTH_STACKGROWTH == -1).
81 * Protected pages need to be put after the stack when PTH_STACKGROWTH == 1. */
84 size_t size = actor->get_stacksize() + guard_size;
86 /* Cannot use posix_memalign when SIMGRID_HAVE_MC. Align stack by hand, and save the
87 * pointer returned by xbt_malloc0. */
88 auto* alloc = static_cast<unsigned char*>(xbt_malloc0(size + xbt_pagesize));
89 stack_ = alloc - (reinterpret_cast<uintptr_t>(alloc) & (xbt_pagesize - 1)) + xbt_pagesize;
90 reinterpret_cast<unsigned char**>(stack_)[-1] = alloc;
93 xbt_assert(posix_memalign(&alloc, xbt_pagesize, size) == 0, "Failed to allocate stack.");
94 this->stack_ = static_cast<unsigned char*>(alloc);
97 /* This is fatal. We are going to fail at some point when we try reusing this. */
99 mprotect(this->stack_, guard_size, PROT_NONE) != -1,
100 "Failed to protect stack: %s.\n"
101 "If you are running a lot of actors, you may be exceeding the amount of mappings allowed per process.\n"
102 "On Linux systems, change this value with sudo sysctl -w vm.max_map_count=newvalue (default value: 65536)\n"
103 "Please see https://simgrid.org/doc/latest/Configuring_SimGrid.html#configuring-the-user-code-virtualization "
104 "for more information.",
107 this->stack_ = this->stack_ + guard_size;
109 this->stack_ = static_cast<unsigned char*>(xbt_malloc0(actor->get_stacksize()));
113 if (RUNNING_ON_VALGRIND)
114 this->valgrind_stack_id_ = VALGRIND_STACK_REGISTER(this->stack_, this->stack_ + actor->get_stacksize());
116 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
117 this->asan_stack_ = get_stack_bottom();
119 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
120 this->tsan_fiber_ = __tsan_create_fiber(0);
123 // not has_code(): in maestro context
124 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
125 this->tsan_fiber_ = __tsan_get_current_fiber();
130 SwappedContext::~SwappedContext()
132 if (stack_ == nullptr) // maestro has no extra stack
135 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
136 __tsan_destroy_fiber(tsan_fiber_);
139 if (valgrind_stack_id_ != 0)
140 VALGRIND_STACK_DEREGISTER(valgrind_stack_id_);
143 if (guard_size > 0 && not MC_is_active()) {
144 stack_ = stack_ - guard_size;
145 if (mprotect(stack_, guard_size, PROT_READ | PROT_WRITE) == -1) {
146 XBT_WARN("Failed to remove page protection: %s", strerror(errno));
147 /* try to pursue anyway */
150 /* Retrieve the saved pointer. See the initialization above. */
151 stack_ = reinterpret_cast<unsigned char**>(stack_)[-1];
158 unsigned char* SwappedContext::get_stack_bottom() const
160 // Depending on the stack direction, its bottom (that make_fcontext needs) may be the lower or higher end
161 #if PTH_STACKGROWTH == 1
164 return stack_ + get_actor()->get_stacksize();
168 void SwappedContext::swap_into(SwappedContext* to)
170 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
171 void* fake_stack = nullptr;
172 to->asan_ctx_ = this;
173 __sanitizer_start_switch_fiber(this->asan_stop_ ? nullptr : &fake_stack, to->asan_stack_, to->asan_stack_size_);
175 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
176 __tsan_switch_to_fiber(to->tsan_fiber_, 0);
179 swap_into_for_real(to);
181 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
182 __sanitizer_finish_switch_fiber(fake_stack, &this->asan_ctx_->asan_stack_, &this->asan_ctx_->asan_stack_size_);
186 /** Maestro wants to run all ready actors */
187 void SwappedContextFactory::run_all(std::vector<actor::ActorImpl*> const& actors_list)
189 const auto* engine = EngineImpl::get_instance();
190 /* This function is called by maestro at the beginning of a scheduling round to get all working threads executing some
191 * stuff It is much easier to understand what happens if you see the working threads as bodies that swap their soul
192 * for the ones of the simulated processes that must run.
194 if (Context::is_parallel()) {
195 // We lazily create the parmap so that all options are actually processed when doing so.
196 if (parmap_ == nullptr)
198 std::make_unique<simgrid::xbt::Parmap<actor::ActorImpl*>>(Context::get_nthreads(), Context::parallel_mode);
200 // Usually, Parmap::apply() executes the provided function on all elements of the array.
201 // Here, the executed function does not return the control to the parmap before all the array is processed:
202 // - suspend() should switch back to the worker_context (either maestro or one of its minions) to return
203 // the control to the parmap. Instead, it uses parmap_->next() to steal another work, and does it directly.
204 // It only yields back to worker_context when the work array is exhausted.
205 // - So, resume() is only launched from the parmap for the first job of each minion.
207 [](const actor::ActorImpl* actor) {
208 auto* context = static_cast<SwappedContext*>(actor->context_.get());
212 } else { // sequential execution
213 if (actors_list.empty())
216 /* maestro is already saved in the first slot of workers_context_ */
217 const actor::ActorImpl* first_actor = engine->get_first_actor_to_run();
219 /* execute the first actor; it will chain to the others when using suspend() */
220 static_cast<SwappedContext*>(first_actor->context_.get())->resume();
224 /** Maestro wants to yield back to a given actor, so awake it on the current thread
226 * In parallel, it is only applied to the N first elements of the parmap array,
227 * where N is the amount of worker threads in the parmap.
228 * See SwappedContextFactory::run_all for details.
230 void SwappedContext::resume()
232 auto* old = static_cast<SwappedContext*>(self());
234 // Save my current soul (either maestro, or one of the minions) in a thread-specific area
235 worker_context_ = old;
238 // Switch my soul and the actor's one
239 Context::set_current(this);
240 old->swap_into(this);
241 // No body runs that soul anymore at this point, but it is stored in a safe place.
242 // When the executed actor will do a blocking action, ActorImpl::yield() will call suspend(), below.
245 /** The actor wants to yield back to maestro, because it is blocked in a simcall (i.e., in ActorImpl::yield())
247 * Actually, it does not really yield back to maestro, but directly into the next executable actor.
249 * This makes the parmap::apply awkward (see SwappedContextFactory::run_all()) because it only apply regularly
250 * on the few first elements of the array, but it saves a lot of context switches back to maestro,
251 * and directly forth to the next executable actor.
253 void SwappedContext::suspend()
255 SwappedContext* next_context;
257 // Get some more work to directly swap into the next executable actor instead of yielding back to the parmap
258 boost::optional<actor::ActorImpl*> next_work = factory_.parmap_->next();
260 // There is a next soul to embody (ie, another executable actor)
261 XBT_DEBUG("Run next process");
262 next_context = static_cast<SwappedContext*>(next_work.get()->context_.get());
264 // All actors were run, go back to the parmap context
265 XBT_DEBUG("No more actors to run");
266 // worker_context_ is my own soul, stored in thread_local when starting the scheduling round
267 next_context = worker_context_;
268 // When given that soul, the body will wait for the next scheduling round
270 } else { // sequential execution
271 const auto* engine = EngineImpl::get_instance();
272 /* determine the next context */
273 unsigned long int i = factory_.process_index_;
274 factory_.process_index_++;
276 if (i < engine->get_actor_to_run_count()) {
277 /* Actually swap into the next actor directly without transiting to maestro */
278 XBT_DEBUG("Run next actor");
280 next_context = static_cast<SwappedContext*>(engine->get_actor_to_run_at(i)->context_.get());
282 /* all processes were run, actually return to maestro */
283 XBT_DEBUG("No more actors to run");
285 next_context = factory_.maestro_context_;
288 Context::set_current(next_context);
289 this->swap_into(next_context);
292 } // namespace simgrid::kernel::context