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