src/kernel/context/ContextSwapped.cpp

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