src/kernel/context/ContextSwapped.cpp

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