1 /* Copyright (c) 2015-2017. The SimGrid Team. All rights reserved. */
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. */
12 #include <boost/context/all.hpp>
15 #include <xbt/xbt_os_thread.h>
17 #include "src/simix/smx_private.h"
18 #include "src/internal_config.h"
19 #include "src/kernel/context/ContextBoost.hpp"
21 XBT_LOG_EXTERNAL_DEFAULT_CATEGORY(simix_context);
27 class BoostSerialContext : public BoostContext {
29 BoostSerialContext(std::function<void()> code,
30 void_pfn_smxprocess_t cleanup_func,
32 : BoostContext(std::move(code), cleanup_func, process) {}
34 void suspend() override;
37 #if HAVE_THREAD_CONTEXTS
38 class BoostParallelContext : public BoostContext {
40 BoostParallelContext(std::function<void()> code,
41 void_pfn_smxprocess_t cleanup_func,
43 : BoostContext(std::move(code), cleanup_func, process) {}
45 void suspend() override;
46 void resume() override;
50 // BoostContextFactory
52 bool BoostContext::parallel_ = false;
53 simgrid::xbt::Parmap<smx_actor_t>* BoostContext::parmap_ = nullptr;
54 uintptr_t BoostContext::threads_working_ = 0;
55 xbt_os_thread_key_t BoostContext::worker_id_key_;
56 unsigned long BoostContext::process_index_ = 0;
57 BoostContext* BoostContext::maestro_context_ = nullptr;
58 std::vector<BoostContext*> BoostContext::workers_context_;
60 BoostContextFactory::BoostContextFactory()
61 : ContextFactory("BoostContextFactory")
63 BoostContext::parallel_ = SIMIX_context_is_parallel();
64 if (BoostContext::parallel_) {
65 #if HAVE_THREAD_CONTEXTS
66 BoostContext::parmap_ = nullptr;
67 BoostContext::workers_context_.clear();
68 BoostContext::workers_context_.resize(SIMIX_context_get_nthreads(), nullptr);
69 BoostContext::maestro_context_ = nullptr;
70 xbt_os_thread_key_create(&BoostContext::worker_id_key_);
72 xbt_die("No thread support for parallel context execution");
77 BoostContextFactory::~BoostContextFactory()
79 #if HAVE_THREAD_CONTEXTS
80 delete BoostContext::parmap_;
81 BoostContext::parmap_ = nullptr;
82 BoostContext::workers_context_.clear();
86 smx_context_t BoostContextFactory::create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup_func,
89 BoostContext* context = nullptr;
90 if (BoostContext::parallel_)
91 #if HAVE_THREAD_CONTEXTS
92 context = this->new_context<BoostParallelContext>(std::move(code), cleanup_func, process);
94 xbt_die("No support for parallel execution");
97 context = this->new_context<BoostSerialContext>(std::move(code), cleanup_func, process);
101 void BoostContextFactory::run_all()
103 #if HAVE_THREAD_CONTEXTS
104 if (BoostContext::parallel_) {
105 BoostContext::threads_working_ = 0;
106 if (not BoostContext::parmap_)
107 BoostContext::parmap_ =
108 new simgrid::xbt::Parmap<smx_actor_t>(SIMIX_context_get_nthreads(), SIMIX_context_get_parallel_mode());
109 BoostContext::parmap_->apply(
110 [](smx_actor_t process) {
111 BoostContext* context = static_cast<BoostContext*>(process->context);
112 return context->resume();
114 simix_global->process_to_run);
118 if (simix_global->process_to_run.empty())
120 smx_actor_t first_process = simix_global->process_to_run.front();
121 BoostContext::process_index_ = 1;
122 /* execute the first process */
123 static_cast<BoostContext*>(first_process->context)->resume();
130 void BoostContext::smx_ctx_boost_wrapper(BoostContext::ctx_arg_type arg)
132 #if BOOST_VERSION < 106100
133 BoostContext* context = reinterpret_cast<BoostContext*>(arg);
135 static_cast<BoostContext**>(arg.data)[0]->fc_ = arg.fctx;
136 BoostContext* context = static_cast<BoostContext**>(arg.data)[1];
141 } catch (StopRequest) {
142 XBT_DEBUG("Caught a StopRequest");
147 inline void BoostContext::smx_ctx_boost_jump_fcontext(BoostContext* from, BoostContext* to)
149 #if BOOST_VERSION < 105600
150 boost::context::jump_fcontext(from->fc_, to->fc_, reinterpret_cast<intptr_t>(to));
151 #elif BOOST_VERSION < 106100
152 boost::context::jump_fcontext(&from->fc_, to->fc_, reinterpret_cast<intptr_t>(to));
154 BoostContext* ctx[2] = {from, to};
155 boost::context::detail::transfer_t arg = boost::context::detail::jump_fcontext(to->fc_, ctx);
156 static_cast<BoostContext**>(arg.data)[0]->fc_ = arg.fctx;
160 BoostContext::BoostContext(std::function<void()> code,
161 void_pfn_smxprocess_t cleanup_func, smx_actor_t process)
162 : Context(std::move(code), cleanup_func, process)
165 /* if the user provided a function for the process then use it, otherwise it is the context for maestro */
167 this->stack_ = SIMIX_context_stack_new();
168 // We need to pass the bottom of the stack to make_fcontext, depending on the stack direction it may be the lower
169 // or higher address:
170 #if PTH_STACKGROWTH == -1
171 void* stack = static_cast<char*>(this->stack_) + smx_context_usable_stack_size - 1;
173 void* stack = this->stack_;
175 #if BOOST_VERSION < 106100
176 this->fc_ = boost::context::make_fcontext(stack, smx_context_usable_stack_size, smx_ctx_boost_wrapper);
178 this->fc_ = boost::context::detail::make_fcontext(stack, smx_context_usable_stack_size, smx_ctx_boost_wrapper);
181 #if BOOST_VERSION < 105600
182 this->fc_ = new boost::context::fcontext_t();
184 if (BoostContext::maestro_context_ == nullptr)
185 BoostContext::maestro_context_ = this;
189 BoostContext::~BoostContext()
191 #if BOOST_VERSION < 105600
192 if (not this->stack_)
195 if (this == maestro_context_)
196 maestro_context_ = nullptr;
197 SIMIX_context_stack_delete(this->stack_);
200 // BoostSerialContext
202 void BoostContext::resume()
204 SIMIX_context_set_current(this);
205 smx_ctx_boost_jump_fcontext(maestro_context_, this);
208 void BoostSerialContext::suspend()
210 /* determine the next context */
211 BoostSerialContext* next_context;
212 unsigned long int i = process_index_;
215 if (i < simix_global->process_to_run.size()) {
216 /* execute the next process */
217 XBT_DEBUG("Run next process");
218 next_context = static_cast<BoostSerialContext*>(simix_global->process_to_run[i]->context);
220 /* all processes were run, return to maestro */
221 XBT_DEBUG("No more process to run");
222 next_context = static_cast<BoostSerialContext*>(maestro_context_);
224 SIMIX_context_set_current(static_cast<smx_context_t>(next_context));
225 smx_ctx_boost_jump_fcontext(this, next_context);
228 void BoostSerialContext::stop()
230 BoostContext::stop();
234 // BoostParallelContext
236 #if HAVE_THREAD_CONTEXTS
238 void BoostParallelContext::suspend()
240 boost::optional<smx_actor_t> next_work = parmap_->next();
241 BoostParallelContext* next_context;
243 XBT_DEBUG("Run next process");
244 next_context = static_cast<BoostParallelContext*>(next_work.get()->context);
246 XBT_DEBUG("No more processes to run");
247 uintptr_t worker_id = reinterpret_cast<uintptr_t>(xbt_os_thread_get_specific(worker_id_key_));
248 next_context = static_cast<BoostParallelContext*>(workers_context_[worker_id]);
251 SIMIX_context_set_current(static_cast<smx_context_t>(next_context));
252 smx_ctx_boost_jump_fcontext(this, next_context);
255 void BoostParallelContext::stop()
257 BoostContext::stop();
261 void BoostParallelContext::resume()
263 uintptr_t worker_id = __sync_fetch_and_add(&threads_working_, 1);
264 xbt_os_thread_set_specific(worker_id_key_, reinterpret_cast<void*>(worker_id));
266 BoostParallelContext* worker_context = static_cast<BoostParallelContext*>(SIMIX_context_self());
267 workers_context_[worker_id] = worker_context;
269 SIMIX_context_set_current(this);
270 smx_ctx_boost_jump_fcontext(worker_context, this);
275 XBT_PRIVATE ContextFactory* boost_factory()
277 XBT_VERB("Using Boost contexts. Welcome to the 21th century.");
278 return new BoostContextFactory();