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