Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
cb2f31487d6ff573bd6e953740343cd095a5e69d
[simgrid.git] / 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   parmap_ = nullptr; // will be created lazily with the right parameters if needed (ie, in parallel)
44   workers_context_.clear();
45   workers_context_.resize(parallel_ ? SIMIX_context_get_nthreads() : 1, nullptr);
46 }
47 SwappedContextFactory::~SwappedContextFactory()
48 {
49   delete parmap_;
50   parmap_ = nullptr;
51   workers_context_.clear();
52 }
53
54 SwappedContext::SwappedContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process,
55                                SwappedContextFactory* factory)
56     : Context(std::move(code), cleanup_func, process), factory_(factory)
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 HAVE_VALGRIND_H
102     unsigned int valgrind_stack_id =
103         VALGRIND_STACK_REGISTER(this->stack_, (char*)this->stack_ + smx_context_stack_size);
104     memcpy((char*)this->stack_ + smx_context_usable_stack_size, &valgrind_stack_id, sizeof valgrind_stack_id);
105 #endif
106   }
107 }
108
109 SwappedContext::~SwappedContext()
110 {
111   if (stack_ == nullptr) // maestro has no extra stack
112     return;
113
114 #if HAVE_VALGRIND_H
115   unsigned int valgrind_stack_id;
116   memcpy(&valgrind_stack_id, (char*)stack_ + smx_context_usable_stack_size, sizeof valgrind_stack_id);
117   VALGRIND_STACK_DEREGISTER(valgrind_stack_id);
118 #endif
119
120 #ifndef _WIN32
121   if (smx_context_guard_size > 0 && not MC_is_active()) {
122     stack_ = (char*)stack_ - smx_context_guard_size;
123     if (mprotect(stack_, smx_context_guard_size, PROT_READ | PROT_WRITE) == -1) {
124       XBT_WARN("Failed to remove page protection: %s", strerror(errno));
125       /* try to pursue anyway */
126     }
127 #if SIMGRID_HAVE_MC
128     /* Retrieve the saved pointer.  See SIMIX_context_stack_new above. */
129     stack_ = *((void**)stack_ - 1);
130 #endif
131   }
132 #endif /* not windows */
133
134   xbt_free(stack_);
135 }
136
137 void SwappedContext::stop()
138 {
139   Context::stop();
140   throw StopRequest();
141 }
142
143 /** Maestro wants to run all ready actors */
144 void SwappedContextFactory::run_all()
145 {
146   /* This function is called by maestro at the beginning of a scheduling round to get all working threads executing some
147    * stuff It is much easier to understand what happens if you see the working threads as bodies that swap their soul
148    * for the ones of the simulated processes that must run.
149    */
150   if (parallel_) {
151     threads_working_ = 0;
152
153     // We lazily create the parmap so that all options are actually processed when doing so.
154     if (parmap_ == nullptr)
155       parmap_ = new simgrid::xbt::Parmap<smx_actor_t>(SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
156
157     // Usually, Parmap::apply() executes the provided function on all elements of the array.
158     // Here, the executed function does not return the control to the parmap before all the array is processed:
159     //   - suspend() should switch back to the worker_context (either maestro or one of its minions) to return
160     //     the control to the parmap. Instead, it uses parmap_->next() to steal another work, and does it directly.
161     //     It only yields back to worker_context when the work array is exhausted.
162     //   - So, resume() is only launched from the parmap for the first job of each minion.
163     parmap_->apply(
164         [](smx_actor_t process) {
165           SwappedContext* context = static_cast<SwappedContext*>(process->context_);
166           context->resume();
167         },
168         simix_global->process_to_run);
169   } else { // sequential execution
170     if (simix_global->process_to_run.empty())
171       return;
172
173     /* maestro is already saved in the first slot of workers_context_ */
174     smx_actor_t first_actor = simix_global->process_to_run.front();
175     process_index_          = 1;
176     /* execute the first actor; it will chain to the others when using suspend() */
177     static_cast<SwappedContext*>(first_actor->context_)->resume();
178   }
179 }
180
181 /** Maestro wants to yield back to a given actor, so awake it on the current thread
182  *
183  * In parallel, it is only applied to the N first elements of the parmap array,
184  * where N is the amount of worker threads in the parmap.
185  * See SwappedContextFactory::run_all for details.
186  */
187 void SwappedContext::resume()
188 {
189   if (factory_->parallel_) {
190     // Save the thread number (my body) in an os-thread-specific area
191     worker_id_ = factory_->threads_working_.fetch_add(1, std::memory_order_relaxed);
192     // Save my current soul (either maestro, or one of the minions) in a permanent area
193     SwappedContext* worker_context = static_cast<SwappedContext*>(self());
194     factory_->workers_context_[worker_id_] = worker_context;
195     // Switch my soul and the actor's one
196     Context::set_current(this);
197     worker_context->swap_into(this);
198     // No body runs that soul anymore at this point, but it is stored in a safe place.
199     // When the executed actor will do a blocking action, SIMIX_process_yield() will call suspend(), below.
200   } else { // sequential execution
201     SwappedContext* old = static_cast<SwappedContext*>(self());
202     Context::set_current(this);
203     old->swap_into(this);
204   }
205 }
206
207 /** The actor wants to yield back to maestro, because it is blocked in a simcall (ie in SIMIX_process_yield())
208  *
209  * Actually, it does not really yield back to maestro, but directly into the next executable actor.
210  *
211  * This makes the parmap::apply awkward (see ParallelUContext::run_all()) because it only apply regularly
212  * on the few first elements of the array, but it saves a lot of context switches back to maestro,
213  * and directly forth to the next executable actor.
214  */
215 void SwappedContext::suspend()
216 {
217   if (factory_->parallel_) {
218     // Get some more work to directly swap into the next executable actor instead of yielding back to the parmap
219     boost::optional<smx_actor_t> next_work = factory_->parmap_->next();
220     SwappedContext* next_context;
221     if (next_work) {
222       // There is a next soul to embody (ie, another executable actor)
223       XBT_DEBUG("Run next process");
224       next_context = static_cast<SwappedContext*>(next_work.get()->context_);
225     } else {
226       // All actors were run, go back to the parmap context
227       XBT_DEBUG("No more actors to run");
228       // worker_id_ is the identity of my body, stored in thread_local when starting the scheduling round
229       next_context = factory_->workers_context_[worker_id_];
230       // When given that soul, the body will wait for the next scheduling round
231     }
232
233     // Get the next soul to run, either from another actor or the initial minion's one
234     Context::set_current(next_context);
235     this->swap_into(next_context);
236
237   } else { // sequential execution
238     /* determine the next context */
239     SwappedContext* next_context;
240     unsigned long int i = factory_->process_index_;
241     factory_->process_index_++;
242
243     if (i < simix_global->process_to_run.size()) {
244       /* Actually swap into the next actor directly without transiting to maestro */
245       XBT_DEBUG("Run next actor");
246       next_context = static_cast<SwappedContext*>(simix_global->process_to_run[i]->context_);
247     } else {
248       /* all processes were run, actually return to maestro */
249       XBT_DEBUG("No more actors to run");
250       next_context = factory_->workers_context_[0];
251     }
252     Context::set_current(next_context);
253     this->swap_into(next_context);
254   }
255 }
256
257 } // namespace context
258 } // namespace kernel
259 } // namespace simgrid