Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
9f402179b9615d6d4cb71d868b9ada43b20105b9
[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/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       char* alloc           = (char*)xbt_malloc0(size + xbt_pagesize);
75       stack_                = alloc - ((uintptr_t)alloc & (xbt_pagesize - 1)) + xbt_pagesize;
76       *((void**)stack_ - 1) = alloc;
77 #elif !defined(_WIN32)
78       if (posix_memalign(&this->stack_, xbt_pagesize, size) != 0)
79         xbt_die("Failed to allocate stack.");
80 #else
81       this->stack_ = _aligned_malloc(size, xbt_pagesize);
82 #endif
83
84 #ifndef _WIN32
85       if (mprotect(this->stack_, smx_context_guard_size, PROT_NONE) == -1) {
86         xbt_die(
87             "Failed to protect stack: %s.\n"
88             "If you are running a lot of actors, you may be exceeding the amount of mappings allowed per process.\n"
89             "On Linux systems, change this value with sudo sysctl -w vm.max_map_count=newvalue (default value: 65536)\n"
90             "Please see http://simgrid.gforge.inria.fr/simgrid/latest/doc/html/options.html#options_virt for more "
91             "info.",
92             strerror(errno));
93         /* This is fatal. We are going to fail at some point when we try reusing this. */
94       }
95 #endif
96       this->stack_ = (char*)this->stack_ + smx_context_guard_size;
97     } else {
98       this->stack_ = xbt_malloc0(smx_context_stack_size);
99     }
100
101 #if PTH_STACKGROWTH == -1
102     ASAN_ONLY(this->asan_stack_ = static_cast<char*>(this->stack_) + smx_context_usable_stack_size);
103 #else
104     ASAN_ONLY(this->asan_stack_ = this->stack_);
105 #endif
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::get_stack()
143 {
144   return stack_;
145 }
146
147 void SwappedContext::stop()
148 {
149   Context::stop();
150   /* We must cut the actor execution using an exception to properly free the C++ RAII variables */
151   throw ForcefulKillException();
152 }
153
154 /** Maestro wants to run all ready actors */
155 void SwappedContextFactory::run_all()
156 {
157   /* This function is called by maestro at the beginning of a scheduling round to get all working threads executing some
158    * stuff It is much easier to understand what happens if you see the working threads as bodies that swap their soul
159    * for the ones of the simulated processes that must run.
160    */
161   if (parallel_) {
162     threads_working_ = 0;
163
164     // We lazily create the parmap so that all options are actually processed when doing so.
165     if (parmap_ == nullptr)
166       parmap_ = new simgrid::xbt::Parmap<smx_actor_t>(SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
167
168     // Usually, Parmap::apply() executes the provided function on all elements of the array.
169     // Here, the executed function does not return the control to the parmap before all the array is processed:
170     //   - suspend() should switch back to the worker_context (either maestro or one of its minions) to return
171     //     the control to the parmap. Instead, it uses parmap_->next() to steal another work, and does it directly.
172     //     It only yields back to worker_context when the work array is exhausted.
173     //   - So, resume() is only launched from the parmap for the first job of each minion.
174     parmap_->apply(
175         [](smx_actor_t process) {
176           SwappedContext* context = static_cast<SwappedContext*>(process->context_);
177           context->resume();
178         },
179         simix_global->actors_to_run);
180   } else { // sequential execution
181     if (simix_global->actors_to_run.empty())
182       return;
183
184     /* maestro is already saved in the first slot of workers_context_ */
185     smx_actor_t first_actor = simix_global->actors_to_run.front();
186     process_index_          = 1;
187     /* execute the first actor; it will chain to the others when using suspend() */
188     static_cast<SwappedContext*>(first_actor->context_)->resume();
189   }
190 }
191
192 /** Maestro wants to yield back to a given actor, so awake it on the current thread
193  *
194  * In parallel, it is only applied to the N first elements of the parmap array,
195  * where N is the amount of worker threads in the parmap.
196  * See SwappedContextFactory::run_all for details.
197  */
198 void SwappedContext::resume()
199 {
200   if (factory_->parallel_) {
201     // Save the thread number (my body) in an os-thread-specific area
202     worker_id_ = factory_->threads_working_.fetch_add(1, std::memory_order_relaxed);
203     // Save my current soul (either maestro, or one of the minions) in a permanent area
204     SwappedContext* worker_context = static_cast<SwappedContext*>(self());
205     factory_->workers_context_[worker_id_] = worker_context;
206     // Switch my soul and the actor's one
207     Context::set_current(this);
208     worker_context->swap_into(this);
209     // No body runs that soul anymore at this point, but it is stored in a safe place.
210     // When the executed actor will do a blocking action, ActorImpl::yield() will call suspend(), below.
211   } else { // sequential execution
212     SwappedContext* old = static_cast<SwappedContext*>(self());
213     Context::set_current(this);
214     old->swap_into(this);
215   }
216 }
217
218 /** The actor wants to yield back to maestro, because it is blocked in a simcall (i.e., in ActorImpl::yield())
219  *
220  * Actually, it does not really yield back to maestro, but directly into the next executable actor.
221  *
222  * This makes the parmap::apply awkward (see ParallelUContext::run_all()) because it only apply regularly
223  * on the few first elements of the array, but it saves a lot of context switches back to maestro,
224  * and directly forth to the next executable actor.
225  */
226 void SwappedContext::suspend()
227 {
228   if (factory_->parallel_) {
229     // Get some more work to directly swap into the next executable actor instead of yielding back to the parmap
230     boost::optional<smx_actor_t> next_work = factory_->parmap_->next();
231     SwappedContext* next_context;
232     if (next_work) {
233       // There is a next soul to embody (ie, another executable actor)
234       XBT_DEBUG("Run next process");
235       next_context = static_cast<SwappedContext*>(next_work.get()->context_);
236     } else {
237       // All actors were run, go back to the parmap context
238       XBT_DEBUG("No more actors to run");
239       // worker_id_ is the identity of my body, stored in thread_local when starting the scheduling round
240       next_context = factory_->workers_context_[worker_id_];
241       // When given that soul, the body will wait for the next scheduling round
242     }
243
244     // Get the next soul to run, either from another actor or the initial minion's one
245     Context::set_current(next_context);
246     this->swap_into(next_context);
247
248   } else { // sequential execution
249     /* determine the next context */
250     SwappedContext* next_context;
251     unsigned long int i = factory_->process_index_;
252     factory_->process_index_++;
253
254     if (i < simix_global->actors_to_run.size()) {
255       /* Actually swap into the next actor directly without transiting to maestro */
256       XBT_DEBUG("Run next actor");
257       next_context = static_cast<SwappedContext*>(simix_global->actors_to_run[i]->context_);
258     } else {
259       /* all processes were run, actually return to maestro */
260       XBT_DEBUG("No more actors to run");
261       next_context = factory_->workers_context_[0];
262     }
263     Context::set_current(next_context);
264     this->swap_into(next_context);
265   }
266 }
267
268 } // namespace context
269 } // namespace kernel
270 } // namespace simgrid