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
  12 #include "src/kernel/context/ContextSwapped.hpp"
  13
  14 #ifdef _WIN32
  15 #include <malloc.h>
  16 #include <windows.h>
  17 #else
  18 #include <sys/mman.h>
  19 #endif
  20
  21 #ifdef __MINGW32__
  22 #define _aligned_malloc __mingw_aligned_malloc
  23 #define _aligned_free __mingw_aligned_free
  24 #endif /*MINGW*/
  25
  26 #if HAVE_VALGRIND_H
  27 #include <valgrind/valgrind.h>
  28 #endif
  29
  30 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
  31
  32 namespace simgrid {
  33 namespace kernel {
  34 namespace context {
  35
  36 unsigned long SwappedContext::process_index_;
  37
  38 SwappedContext* SwappedContext::maestro_context_ = nullptr;
  39
  40 SwappedContext::SwappedContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process)
  41     : Context(std::move(code), cleanup_func, process)
  42 {
  43   if (has_code()) {
  44     if (smx_context_guard_size > 0 && not MC_is_active()) {
  45
  46 #if !defined(PTH_STACKGROWTH) || (PTH_STACKGROWTH != -1)
  47       xbt_die(
  48           "Stack overflow protection is known to be broken on your system: you stacks grow upwards (or detection is "
  49           "broken). "
  50           "Please disable stack guards with --cfg=contexts:guard-size:0");
  51       /* Current code for stack overflow protection assumes that stacks are growing downward (PTH_STACKGROWTH == -1).
  52        * Protected pages need to be put after the stack when PTH_STACKGROWTH == 1. */
  53 #endif
  54
  55       size_t size = smx_context_stack_size + smx_context_guard_size;
  56 #if SIMGRID_HAVE_MC
  57       /* Cannot use posix_memalign when SIMGRID_HAVE_MC. Align stack by hand, and save the
  58        * pointer returned by xbt_malloc0. */
  59       char* alloc           = (char*)xbt_malloc0(size + xbt_pagesize);
  60       stack_                = alloc - ((uintptr_t)alloc & (xbt_pagesize - 1)) + xbt_pagesize;
  61       *((void**)stack_ - 1) = alloc;
  62 #elif !defined(_WIN32)
  63       if (posix_memalign(&this->stack_, xbt_pagesize, size) != 0)
  64         xbt_die("Failed to allocate stack.");
  65 #else
  66       this->stack_ = _aligned_malloc(size, xbt_pagesize);
  67 #endif
  68
  69 #ifndef _WIN32
  70       if (mprotect(this->stack_, smx_context_guard_size, PROT_NONE) == -1) {
  71         xbt_die(
  72             "Failed to protect stack: %s.\n"
  73             "If you are running a lot of actors, you may be exceeding the amount of mappings allowed per process.\n"
  74             "On Linux systems, change this value with sudo sysctl -w vm.max_map_count=newvalue (default value: 65536)\n"
  75             "Please see http://simgrid.gforge.inria.fr/simgrid/latest/doc/html/options.html#options_virt for more "
  76             "info.",
  77             strerror(errno));
  78         /* This is fatal. We are going to fail at some point when we try reusing this. */
  79       }
  80 #endif
  81       this->stack_ = (char*)this->stack_ + smx_context_guard_size;
  82     } else {
  83       this->stack_ = xbt_malloc0(smx_context_stack_size);
  84     }
  85
  86 #if HAVE_VALGRIND_H
  87     unsigned int valgrind_stack_id =
  88         VALGRIND_STACK_REGISTER(this->stack_, (char*)this->stack_ + smx_context_stack_size);
  89     memcpy((char*)this->stack_ + smx_context_usable_stack_size, &valgrind_stack_id, sizeof valgrind_stack_id);
  90 #endif
  91   }
  92 }
  93
  94 SwappedContext::~SwappedContext()
  95 {
  96   if (stack_ == nullptr)
  97     return;
  98
  99 #if HAVE_VALGRIND_H
 100   unsigned int valgrind_stack_id;
 101   memcpy(&valgrind_stack_id, (char*)stack_ + smx_context_usable_stack_size, sizeof valgrind_stack_id);
 102   VALGRIND_STACK_DEREGISTER(valgrind_stack_id);
 103 #endif
 104
 105 #ifndef _WIN32
 106   if (smx_context_guard_size > 0 && not MC_is_active()) {
 107     stack_ = (char*)stack_ - smx_context_guard_size;
 108     if (mprotect(stack_, smx_context_guard_size, PROT_READ | PROT_WRITE) == -1) {
 109       XBT_WARN("Failed to remove page protection: %s", strerror(errno));
 110       /* try to pursue anyway */
 111     }
 112 #if SIMGRID_HAVE_MC
 113     /* Retrieve the saved pointer.  See SIMIX_context_stack_new above. */
 114     stack_ = *((void**)stack_ - 1);
 115 #endif
 116   }
 117 #endif /* not windows */
 118
 119   xbt_free(stack_);
 120 }
 121
 122 void SwappedContext::suspend()
 123 {
 124   /* determine the next context */
 125   SwappedContext* next_context;
 126   unsigned long int i = process_index_;
 127   process_index_++;
 128
 129   if (i < simix_global->process_to_run.size()) {
 130     /* execute the next process */
 131     XBT_DEBUG("Run next process");
 132     next_context = static_cast<SwappedContext*>(simix_global->process_to_run[i]->context_);
 133   } else {
 134     /* all processes were run, return to maestro */
 135     XBT_DEBUG("No more process to run");
 136     next_context = static_cast<SwappedContext*>(get_maestro());
 137   }
 138   Context::set_current(next_context);
 139   this->swap_into(next_context);
 140 }
 141
 142 void SwappedContext::resume()
 143 {
 144   SwappedContext* old = static_cast<SwappedContext*>(self());
 145   Context::set_current(this);
 146   old->swap_into(this);
 147 }
 148
 149 void SwappedContext::run_all()
 150 {
 151   if (simix_global->process_to_run.empty())
 152     return;
 153   smx_actor_t first_process = simix_global->process_to_run.front();
 154   process_index_            = 1;
 155   /* execute the first process */
 156   static_cast<SwappedContext*>(first_process->context_)->resume();
 157 }
 158 } // namespace context
 159 } // namespace kernel
 160 } // namespace simgrid