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