1 /* Copyright (c) 2007-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_CONTEXT_HPP
7 #define SIMGRID_KERNEL_CONTEXT_CONTEXT_HPP
9 #include <simgrid/forward.h>
10 #include <xbt/parmap.h>
12 #include "src/kernel/activity/ActivityImpl.hpp"
17 namespace simgrid::kernel::context {
18 extern unsigned stack_size;
19 extern unsigned guard_size;
21 class XBT_PUBLIC ContextFactory {
23 explicit ContextFactory() = default;
24 ContextFactory(const ContextFactory&) = delete;
25 ContextFactory& operator=(const ContextFactory&) = delete;
26 virtual ~ContextFactory();
27 virtual Context* create_context(std::function<void()>&& code, actor::ActorImpl* actor) = 0;
29 /** Turn the current thread into a simulation context */
30 virtual Context* attach(actor::ActorImpl* actor);
31 /** Turn the current thread into maestro (the old maestro becomes a regular actor) */
32 virtual Context* create_maestro(std::function<void()>&& code, actor::ActorImpl* actor);
34 virtual void run_all(std::vector<actor::ActorImpl*> const& actors_list) = 0;
37 template <class T, class... Args> T* new_context(Args&&... args)
39 auto* context = new T(std::forward<Args>(args)...);
40 context->declare_context(sizeof(T));
45 class XBT_PUBLIC Context {
46 friend ContextFactory;
48 static thread_local Context* current_context_;
50 std::function<void()> code_;
51 actor::ActorImpl* actor_ = nullptr;
53 void declare_context(std::size_t size);
56 static int install_sigsegv_stack(stack_t* old_stack, bool enable);
58 Context(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro);
59 Context(const Context&) = delete;
60 Context& operator=(const Context&) = delete;
63 bool is_maestro() const { return is_maestro_; }
64 void operator()() const { code_(); }
65 bool has_code() const { return static_cast<bool>(code_); }
66 actor::ActorImpl* get_actor() const { return this->actor_; }
70 virtual void suspend() = 0;
72 // Retrieving the self() context
73 /** @brief Retrieves the current context of this thread */
74 static Context* self();
75 /** @brief Sets the current context of this thread */
76 static void set_current(Context* self);
79 class XBT_PUBLIC AttachContext : public Context {
81 AttachContext(std::function<void()>&& code, actor::ActorImpl* actor, bool maestro)
82 : Context(std::move(code), actor, maestro)
85 AttachContext(const AttachContext&) = delete;
86 AttachContext& operator=(const AttachContext&) = delete;
87 ~AttachContext() override;
89 /** Called by the context when it is ready to give control to the maestro */
90 virtual void attach_start() = 0;
92 /** Called by the context when it has finished its job */
93 virtual void attach_stop() = 0;
96 XBT_PRIVATE ContextFactory* thread_factory();
97 XBT_PRIVATE ContextFactory* sysv_factory();
98 XBT_PRIVATE ContextFactory* raw_factory();
99 XBT_PRIVATE ContextFactory* boost_factory();
101 XBT_PUBLIC bool is_parallel();
102 XBT_PUBLIC int get_nthreads();
103 XBT_PUBLIC void set_nthreads(int nb_threads);
104 XBT_PUBLIC void set_parallel_mode(e_xbt_parmap_mode_t mode);
105 XBT_PUBLIC e_xbt_parmap_mode_t get_parallel_mode();
106 } // namespace simgrid::kernel::context