1 /* Copyright (c) 2009-2023. 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. */
6 #ifndef SIMGRID_KERNEL_CONTEXT_SWAPPED_CONTEXT_HPP
7 #define SIMGRID_KERNEL_CONTEXT_SWAPPED_CONTEXT_HPP
9 #include "src/internal_config.h" // HAVE_SANITIZER_*
10 #include "src/kernel/context/Context.hpp"
11 #include "src/xbt/parmap.hpp"
15 namespace simgrid::kernel::context {
17 } // namespace simgrid::kernel::context
19 /* Use extern "C" to make sure that this symbol is easy to recognize by name, even on exotic platforms */
20 extern "C" XBT_ATTRIB_NORETURN void smx_ctx_wrapper(simgrid::kernel::context::SwappedContext* context);
22 namespace simgrid::kernel::context {
24 class SwappedContextFactory : public ContextFactory {
25 friend SwappedContext; // Reads whether we are in parallel mode
27 SwappedContextFactory() = default;
28 SwappedContextFactory(const SwappedContextFactory&) = delete;
29 SwappedContextFactory& operator=(const SwappedContextFactory&) = delete;
30 void run_all(std::vector<actor::ActorImpl*> const& actors) override;
33 /* For the sequential execution */
34 unsigned long process_index_ = 0; // next actor to execute
35 SwappedContext* maestro_context_ = nullptr; // save maestro's context
37 /* For the parallel execution, will be created lazily with the right parameters if needed (ie, in parallel) */
38 std::unique_ptr<simgrid::xbt::Parmap<actor::ActorImpl*>> parmap_{nullptr};
41 class SwappedContext : public Context {
42 friend void ::smx_ctx_wrapper(simgrid::kernel::context::SwappedContext*);
45 SwappedContext(std::function<void()>&& code, actor::ActorImpl* get_actor, SwappedContextFactory* factory);
46 SwappedContext(const SwappedContext&) = delete;
47 SwappedContext& operator=(const SwappedContext&) = delete;
48 ~SwappedContext() override;
50 void suspend() override;
51 virtual void resume();
53 void swap_into(SwappedContext* to);
56 unsigned char* get_stack() const { return stack_; }
57 unsigned char* get_stack_bottom() const; // Depending on the stack direction, its bottom (that Boost::make_fcontext
58 // needs) may be the lower or higher end
60 // With ASan, after a context switch, check that the originating context is the expected one (see BoostContext)
61 void verify_previous_context(const SwappedContext* context) const;
64 static thread_local SwappedContext* worker_context_;
66 unsigned char* stack_ = nullptr; // the thread stack
67 SwappedContextFactory& factory_; // for sequential and parallel run_all()
70 unsigned int valgrind_stack_id_ = 0;
72 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
73 const void* asan_stack_ = nullptr;
74 size_t asan_stack_size_ = 0;
75 SwappedContext* asan_ctx_ = nullptr;
76 bool asan_stop_ = false;
78 #if HAVE_SANITIZER_THREAD_FIBER_SUPPORT
82 virtual void swap_into_for_real(SwappedContext* to) = 0; // Defined in Raw, Boost and UContext subclasses
85 inline void SwappedContext::verify_previous_context(XBT_ATTRIB_UNUSED const SwappedContext* context) const
87 #if HAVE_SANITIZER_ADDRESS_FIBER_SUPPORT
88 xbt_assert(this->asan_ctx_ == context);
92 } // namespace simgrid::kernel::context