src/kernel/context/ContextSwapped.cpp

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