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 "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     sthread_enable();
  42     (*context)();
  43     sthread_disable();
  44     context->stop();
  45   } catch (simgrid::ForcefulKillException const&) {
  46     sthread_disable();
  47     XBT_DEBUG("Caught a ForcefulKillException");
  48   } catch (simgrid::Exception const& e) {
  49     sthread_disable();
  50     XBT_INFO("Actor killed by an uncaught exception %s", boost::core::demangle(typeid(e).name()).c_str());
  51     throw;
  52   }
  53 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
  54   context->asan_stop_ = true;
  55 #endif
  56   context->suspend();
  57   THROW_IMPOSSIBLE;
  58 }
  59
  60 namespace simgrid::kernel::context {
  61
  62 /* thread-specific storage for the worker's context */
  63 thread_local SwappedContext* SwappedContext::worker_context_ = nullptr;
  64
  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)
  67 {
  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;
  71
  72   if (has_code()) {
  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
  76       xbt_die(
  77           "Stack overflow protection is known to be broken on your system: you stacks grow upwards (or detection is "
  78           "broken). "
  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. */
  82 #endif
  83
  84       size_t size = actor->get_stacksize() + guard_size;
  85 #if SIMGRID_HAVE_MC
  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;
  91 #else
  92       void* alloc;
  93       xbt_assert(posix_memalign(&alloc, xbt_pagesize, size) == 0, "Failed to allocate stack.");
  94       this->stack_ = static_cast<unsigned char*>(alloc);
  95 #endif
  96
  97       /* This is fatal. We are going to fail at some point when we try reusing this. */
  98       xbt_assert(
  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.",
 105           strerror(errno));
 106
 107       this->stack_ = this->stack_ + guard_size;
 108     } else {
 109       this->stack_ = static_cast<unsigned char*>(xbt_malloc0(actor->get_stacksize()));
 110     }
 111
 112 #if HAVE_VALGRIND_H
 113     if (RUNNING_ON_VALGRIND)
 114       this->valgrind_stack_id_ = VALGRIND_STACK_REGISTER(this->stack_, this->stack_ + actor->get_stacksize());
 115 #endif
 116 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
 117     this->asan_stack_ = get_stack_bottom();
 118 #endif
 119 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
 120     this->tsan_fiber_ = __tsan_create_fiber(0);
 121 #endif
 122   } else {
 123     // not has_code(): in maestro context
 124 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
 125     this->tsan_fiber_ = __tsan_get_current_fiber();
 126 #endif
 127   }
 128 }
 129
 130 SwappedContext::~SwappedContext()
 131 {
 132   if (stack_ == nullptr) // maestro has no extra stack
 133     return;
 134
 135 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
 136   __tsan_destroy_fiber(tsan_fiber_);
 137 #endif
 138 #if HAVE_VALGRIND_H
 139   if (valgrind_stack_id_ != 0)
 140     VALGRIND_STACK_DEREGISTER(valgrind_stack_id_);
 141 #endif
 142
 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 */
 148     }
 149 #if SIMGRID_HAVE_MC
 150     /* Retrieve the saved pointer.  See the initialization above. */
 151     stack_ = reinterpret_cast<unsigned char**>(stack_)[-1];
 152 #endif
 153   }
 154
 155   xbt_free(stack_);
 156 }
 157
 158 unsigned char* SwappedContext::get_stack_bottom() const
 159 {
 160   // Depending on the stack direction, its bottom (that make_fcontext needs) may be the lower or higher end
 161 #if PTH_STACKGROWTH == 1
 162   return stack_;
 163 #else
 164   return stack_ + get_actor()->get_stacksize();
 165 #endif
 166 }
 167
 168 void SwappedContext::swap_into(SwappedContext* to)
 169 {
 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_);
 174 #endif
 175 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
 176   __tsan_switch_to_fiber(to->tsan_fiber_, 0);
 177 #endif
 178
 179   swap_into_for_real(to);
 180
 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_);
 183 #endif
 184 }
 185
 186 /** Maestro wants to run all ready actors */
 187 void SwappedContextFactory::run_all(std::vector<actor::ActorImpl*> const& actors_list)
 188 {
 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.
 193    */
 194   if (is_parallel()) {
 195     // We lazily create the parmap so that all options are actually processed when doing so.
 196     if (parmap_ == nullptr)
 197       parmap_ = std::make_unique<simgrid::xbt::Parmap<actor::ActorImpl*>>(get_nthreads(), get_parallel_mode());
 198
 199     // Usually, Parmap::apply() executes the provided function on all elements of the array.
 200     // Here, the executed function does not return the control to the parmap before all the array is processed:
 201     //   - suspend() should switch back to the worker_context (either maestro or one of its minions) to return
 202     //     the control to the parmap. Instead, it uses parmap_->next() to steal another work, and does it directly.
 203     //     It only yields back to worker_context when the work array is exhausted.
 204     //   - So, resume() is only launched from the parmap for the first job of each minion.
 205     parmap_->apply(
 206         [](const actor::ActorImpl* actor) {
 207           auto* context = static_cast<SwappedContext*>(actor->context_.get());
 208           context->resume();
 209         },
 210         actors_list);
 211   } else { // sequential execution
 212     if (actors_list.empty())
 213       return;
 214
 215     /* maestro is already saved in the first slot of workers_context_ */
 216     const actor::ActorImpl* first_actor = engine->get_first_actor_to_run();
 217     process_index_          = 1;
 218     /* execute the first actor; it will chain to the others when using suspend() */
 219     static_cast<SwappedContext*>(first_actor->context_.get())->resume();
 220   }
 221 }
 222
 223 /** Maestro wants to yield back to a given actor, so awake it on the current thread
 224  *
 225  * In parallel, it is only applied to the N first elements of the parmap array,
 226  * where N is the amount of worker threads in the parmap.
 227  * See SwappedContextFactory::run_all for details.
 228  */
 229 void SwappedContext::resume()
 230 {
 231   auto* old = static_cast<SwappedContext*>(self());
 232   if (is_parallel()) {
 233     // Save my current soul (either maestro, or one of the minions) in a thread-specific area
 234     worker_context_ = old;
 235   }
 236   sthread_enable();
 237   // Switch my soul and the actor's one
 238   Context::set_current(this);
 239   old->swap_into(this);
 240   // No body runs that soul anymore at this point, but it is stored in a safe place.
 241   // When the executed actor will do a blocking action, ActorImpl::yield() will call suspend(), below.
 242 }
 243
 244 /** The actor wants to yield back to maestro, because it is blocked in a simcall (i.e., in ActorImpl::yield())
 245  *
 246  * Actually, it does not really yield back to maestro, but directly into the next executable actor.
 247  *
 248  * This makes the parmap::apply awkward (see SwappedContextFactory::run_all()) because it only apply regularly
 249  * on the few first elements of the array, but it saves a lot of context switches back to maestro,
 250  * and directly forth to the next executable actor.
 251  */
 252 void SwappedContext::suspend()
 253 {
 254   SwappedContext* next_context;
 255   if (is_parallel()) {
 256     // Get some more work to directly swap into the next executable actor instead of yielding back to the parmap
 257     boost::optional<actor::ActorImpl*> next_work = factory_.parmap_->next();
 258     if (next_work) {
 259       // There is a next soul to embody (ie, another executable actor)
 260       XBT_DEBUG("Run next process");
 261       next_context = static_cast<SwappedContext*>(next_work.get()->context_.get());
 262     } else {
 263       // All actors were run, go back to the parmap context
 264       XBT_DEBUG("No more actors to run");
 265       // worker_context_ is my own soul, stored in thread_local when starting the scheduling round
 266       next_context = worker_context_;
 267       // When given that soul, the body will wait for the next scheduling round
 268     }
 269   } else { // sequential execution
 270     const auto* engine = EngineImpl::get_instance();
 271     /* determine the next context */
 272     unsigned long int i = factory_.process_index_;
 273     factory_.process_index_++;
 274
 275     if (i < engine->get_actor_to_run_count()) {
 276       /* Actually swap into the next actor directly without transiting to maestro */
 277       XBT_DEBUG("Run next actor");
 278       sthread_enable();
 279       next_context = static_cast<SwappedContext*>(engine->get_actor_to_run_at(i)->context_.get());
 280     } else {
 281       /* all processes were run, actually return to maestro */
 282       XBT_DEBUG("No more actors to run");
 283       sthread_disable();
 284       next_context = factory_.maestro_context_;
 285     }
 286   }
 287   Context::set_current(next_context);
 288   this->swap_into(next_context);
 289 }
 290
 291 } // namespace simgrid::kernel::context