Logo AND Algorithmique Numérique Distribuée

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