src/kernel/context/ContextSwapped.cpp

   1 /* Copyright (c) 2009-2023. 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 "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"
  13
  14 #include "src/kernel/context/ContextSwapped.hpp"
  15
  16 #include <boost/core/demangle.hpp>
  17 #include <memory>
  18 #include <sys/mman.h>
  19 #include <typeinfo>
  20
  21 #if HAVE_VALGRIND_H
  22 #include <valgrind/valgrind.h>
  23 #endif
  24 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
  25 #include <sanitizer/asan_interface.h>
  26 #endif
  27 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
  28 #include <sanitizer/tsan_interface.h>
  29 #endif
  30
  31 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(ker_context);
  32
  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)
  36 {
  37 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
  38   __sanitizer_finish_switch_fiber(nullptr, &context->asan_ctx_->asan_stack_, &context->asan_ctx_->asan_stack_size_);
  39 #endif
  40   try {
  41     const SThreadGuard sthread_guard;
  42     (*context)();
  43     context->stop();
  44   } catch (simgrid::ForcefulKillException const&) {
  45     XBT_DEBUG("Caught a ForcefulKillException");
  46   } catch (simgrid::Exception const& e) {
  47     XBT_INFO("Actor killed by an uncaught exception %s", boost::core::demangle(typeid(e).name()).c_str());
  48     throw;
  49   }
  50 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
  51   context->asan_stop_ = true;
  52 #endif
  53   context->suspend();
  54   THROW_IMPOSSIBLE;
  55 }
  56
  57 namespace simgrid::kernel::context {
  58
  59 /* thread-specific storage for the worker's context */
  60 thread_local SwappedContext* SwappedContext::worker_context_ = nullptr;
  61
  62 SwappedContext::SwappedContext(std::function<void()>&& code, actor::ActorImpl* actor, SwappedContextFactory* factory)
  63     : Context(std::move(code), actor, not code /* maestro if no code */), factory_(*factory)
  64 {
  65   // Save maestro (=first created context) in preparation for run_all
  66   if (not is_parallel() && factory_.maestro_context_ == nullptr)
  67     factory_.maestro_context_ = this;
  68
  69   if (has_code()) {
  70     xbt_assert((actor->get_stacksize() & 0xf) == 0, "Actor stack size should be multiple of 16");
  71     if (guard_size > 0 && not MC_is_active()) {
  72 #if PTH_STACKGROWTH != -1
  73       xbt_die(
  74           "Stack overflow protection is known to be broken on your system: you stacks grow upwards (or detection is "
  75           "broken). "
  76           "Please disable stack guards with --cfg=contexts:guard-size:0");
  77       /* Current code for stack overflow protection assumes that stacks are growing downward (PTH_STACKGROWTH == -1).
  78        * Protected pages need to be put after the stack when PTH_STACKGROWTH == 1. */
  79 #endif
  80
  81       size_t size = actor->get_stacksize() + guard_size;
  82       void* alloc;
  83       xbt_assert(posix_memalign(&alloc, xbt_pagesize, size) == 0, "Failed to allocate stack.");
  84       this->stack_ = static_cast<unsigned char*>(alloc);
  85
  86       /* This is fatal. We are going to fail at some point when we try reusing this. */
  87       xbt_assert(
  88           mprotect(this->stack_, guard_size, PROT_NONE) != -1,
  89           "Failed to protect stack: %s.\n"
  90           "If you are running a lot of actors, you may be exceeding the amount of mappings allowed per process.\n"
  91           "On Linux systems, change this value with sudo sysctl -w vm.max_map_count=newvalue (default value: 65536)\n"
  92           "Please see https://simgrid.org/doc/latest/Configuring_SimGrid.html#configuring-the-user-code-virtualization "
  93           "for more information.",
  94           strerror(errno));
  95
  96       this->stack_ = this->stack_ + guard_size;
  97     } else {
  98       this->stack_ = static_cast<unsigned char*>(xbt_malloc0(actor->get_stacksize()));
  99     }
 100
 101 #if HAVE_VALGRIND_H
 102     if (RUNNING_ON_VALGRIND)
 103       this->valgrind_stack_id_ = VALGRIND_STACK_REGISTER(this->stack_, this->stack_ + actor->get_stacksize());
 104 #endif
 105 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
 106     this->asan_stack_ = get_stack_bottom();
 107 #endif
 108 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
 109     this->tsan_fiber_ = __tsan_create_fiber(0);
 110 #endif
 111   } else {
 112     // not has_code(): in maestro context
 113 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
 114     this->tsan_fiber_ = __tsan_get_current_fiber();
 115 #endif
 116   }
 117 }
 118
 119 SwappedContext::~SwappedContext()
 120 {
 121   if (stack_ == nullptr) // maestro has no extra stack
 122     return;
 123
 124 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
 125   __tsan_destroy_fiber(tsan_fiber_);
 126 #endif
 127 #if HAVE_VALGRIND_H
 128   if (valgrind_stack_id_ != 0)
 129     VALGRIND_STACK_DEREGISTER(valgrind_stack_id_);
 130 #endif
 131
 132   if (guard_size > 0 && not MC_is_active()) {
 133     stack_ = stack_ - guard_size;
 134     if (mprotect(stack_, guard_size, PROT_READ | PROT_WRITE) == -1) {
 135       XBT_WARN("Failed to remove page protection: %s", strerror(errno));
 136       /* try to pursue anyway */
 137     }
 138   }
 139
 140   xbt_free(stack_);
 141 }
 142
 143 unsigned char* SwappedContext::get_stack_bottom() const
 144 {
 145   // Depending on the stack direction, its bottom (that make_fcontext needs) may be the lower or higher end
 146 #if PTH_STACKGROWTH == 1
 147   return stack_;
 148 #else
 149   return stack_ + get_actor()->get_stacksize();
 150 #endif
 151 }
 152
 153 void SwappedContext::swap_into(SwappedContext* to)
 154 {
 155 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
 156   void* fake_stack = nullptr;
 157   to->asan_ctx_    = this;
 158   __sanitizer_start_switch_fiber(this->asan_stop_ ? nullptr : &fake_stack, to->asan_stack_, to->asan_stack_size_);
 159 #endif
 160 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
 161   __tsan_switch_to_fiber(to->tsan_fiber_, 0);
 162 #endif
 163
 164   swap_into_for_real(to);
 165
 166 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
 167   __sanitizer_finish_switch_fiber(fake_stack, &this->asan_ctx_->asan_stack_, &this->asan_ctx_->asan_stack_size_);
 168 #endif
 169 }
 170
 171 /** Maestro wants to run all ready actors */
 172 void SwappedContextFactory::run_all(std::vector<actor::ActorImpl*> const& actors_list)
 173 {
 174   const SThreadGuard sthread_guard;
 175   const auto* engine = EngineImpl::get_instance();
 176   /* This function is called by maestro at the beginning of a scheduling round to get all working threads executing some
 177    * stuff It is much easier to understand what happens if you see the working threads as bodies that swap their soul
 178    * for the ones of the simulated processes that must run.
 179    */
 180   if (Context::is_parallel()) {
 181     // We lazily create the parmap so that all options are actually processed when doing so.
 182     if (parmap_ == nullptr)
 183       parmap_ =
 184           std::make_unique<simgrid::xbt::Parmap<actor::ActorImpl*>>(Context::get_nthreads(), Context::parallel_mode);
 185
 186     // Usually, Parmap::apply() executes the provided function on all elements of the array.
 187     // Here, the executed function does not return the control to the parmap before all the array is processed:
 188     //   - suspend() should switch back to the worker_context (either maestro or one of its minions) to return
 189     //     the control to the parmap. Instead, it uses parmap_->next() to steal another work, and does it directly.
 190     //     It only yields back to worker_context when the work array is exhausted.
 191     //   - So, resume() is only launched from the parmap for the first job of each minion.
 192     parmap_->apply(
 193         [](const actor::ActorImpl* actor) {
 194           auto* context = static_cast<SwappedContext*>(actor->context_.get());
 195           context->resume();
 196         },
 197         actors_list);
 198   } else { // sequential execution
 199     if (actors_list.empty())
 200       return;
 201
 202     /* maestro is already saved in the first slot of workers_context_ */
 203     const actor::ActorImpl* first_actor = engine->get_first_actor_to_run();
 204     process_index_          = 1;
 205     /* execute the first actor; it will chain to the others when using suspend() */
 206     static_cast<SwappedContext*>(first_actor->context_.get())->resume();
 207   }
 208 }
 209
 210 /** Maestro wants to yield back to a given actor, so awake it on the current thread
 211  *
 212  * In parallel, it is only applied to the N first elements of the parmap array,
 213  * where N is the amount of worker threads in the parmap.
 214  * See SwappedContextFactory::run_all for details.
 215  */
 216 void SwappedContext::resume()
 217 {
 218   auto* old = static_cast<SwappedContext*>(self());
 219   if (is_parallel()) {
 220     // Save my current soul (either maestro, or one of the minions) in a thread-specific area
 221     worker_context_ = old;
 222   }
 223   // Switch my soul and the actor's one
 224   Context::set_current(this);
 225   old->swap_into(this);
 226   // No body runs that soul anymore at this point, but it is stored in a safe place.
 227   // When the executed actor will do a blocking action, ActorImpl::yield() will call suspend(), below.
 228 }
 229
 230 /** The actor wants to yield back to maestro, because it is blocked in a simcall (i.e., in ActorImpl::yield())
 231  *
 232  * Actually, it does not really yield back to maestro, but directly into the next executable actor.
 233  *
 234  * This makes the parmap::apply awkward (see SwappedContextFactory::run_all()) because it only apply regularly
 235  * on the few first elements of the array, but it saves a lot of context switches back to maestro,
 236  * and directly forth to the next executable actor.
 237  */
 238 void SwappedContext::suspend()
 239 {
 240   SwappedContext* next_context;
 241   if (is_parallel()) {
 242     // Get some more work to directly swap into the next executable actor instead of yielding back to the parmap
 243     boost::optional<actor::ActorImpl*> next_work = factory_.parmap_->next();
 244     if (next_work) {
 245       // There is a next soul to embody (ie, another executable actor)
 246       XBT_DEBUG("Run next process");
 247       next_context = static_cast<SwappedContext*>(next_work.get()->context_.get());
 248     } else {
 249       // All actors were run, go back to the parmap context
 250       XBT_DEBUG("No more actors to run");
 251       // worker_context_ is my own soul, stored in thread_local when starting the scheduling round
 252       next_context = worker_context_;
 253       // When given that soul, the body will wait for the next scheduling round
 254     }
 255   } else { // sequential execution
 256     const auto* engine = EngineImpl::get_instance();
 257     /* determine the next context */
 258     unsigned long int i = factory_.process_index_;
 259     factory_.process_index_++;
 260
 261     if (i < engine->get_actor_to_run_count()) {
 262       /* Actually swap into the next actor directly without transiting to maestro */
 263       XBT_DEBUG("Run next actor");
 264       next_context = static_cast<SwappedContext*>(engine->get_actor_to_run_at(i)->context_.get());
 265     } else {
 266       /* all processes were run, actually return to maestro */
 267       XBT_DEBUG("No more actors to run");
 268       next_context = factory_.maestro_context_;
 269     }
 270   }
 271   Context::set_current(next_context);
 272   this->swap_into(next_context);
 273 }
 274
 275 } // namespace simgrid::kernel::context