Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
a58cf342ec58b0e318e37ceb9ca0119d399ba558
[simgrid.git] / src / kernel / context / Context.hpp
1 /* Copyright (c) 2007-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 #ifndef SIMGRID_KERNEL_CONTEXT_CONTEXT_HPP
7 #define SIMGRID_KERNEL_CONTEXT_CONTEXT_HPP
8
9 #include "simgrid/forward.h"
10 #include "src/internal_config.h"
11 #include "src/kernel/activity/ActivityImpl.hpp"
12
13 #include <csignal>
14
15 /* Process creation/destruction callbacks */
16 typedef void (*void_pfn_smxprocess_t)(smx_actor_t);
17
18 namespace simgrid {
19 namespace kernel {
20 namespace context {
21
22 class XBT_PUBLIC ContextFactory {
23 private:
24   std::string name_;
25
26 public:
27   explicit ContextFactory(std::string name) : name_(std::move(name)) {}
28   virtual ~ContextFactory();
29   virtual Context* create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup, smx_actor_t process) = 0;
30
31   /** Turn the current thread into a simulation context */
32   virtual Context* attach(void_pfn_smxprocess_t cleanup_func, smx_actor_t process);
33   /** Turn the current thread into maestro (the old maestro becomes a regular actor) */
34   virtual Context* create_maestro(std::function<void()> code, smx_actor_t process);
35
36   virtual void run_all() = 0;
37   std::string const& name() const { return name_; }
38
39 protected:
40   template <class T, class... Args> T* new_context(Args&&... args)
41   {
42     T* context = new T(std::forward<Args>(args)...);
43     context->declare_context(sizeof(T));
44     return context;
45   }
46 };
47
48 class XBT_PUBLIC Context {
49   friend ContextFactory;
50
51 private:
52   std::function<void()> code_;
53   void_pfn_smxprocess_t cleanup_func_ = nullptr;
54   smx_actor_t actor_                  = nullptr;
55   void declare_context(std::size_t size);
56
57 public:
58   bool iwannadie = false;
59
60   Context(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process);
61   Context(const Context&) = delete;
62   Context& operator=(const Context&) = delete;
63   virtual ~Context();
64
65   void operator()() { code_(); }
66   bool has_code() const { return static_cast<bool>(code_); }
67   smx_actor_t process() { return this->actor_; }
68   void set_cleanup(void_pfn_smxprocess_t cleanup) { cleanup_func_ = cleanup; }
69
70   // Scheduling methods
71   virtual void stop();
72   virtual void suspend() = 0;
73
74   // Retrieving the self() context
75   /** @brief Retrives the current context of this thread */
76   static Context* self();
77   /** @brief Sets the current context of this thread */
78   static void set_current(Context* self);
79
80   class StopRequest {
81     /** @brief Exception launched to kill a process, in order to properly unwind its stack and release RAII stuff
82      *
83      * Nope, Sonar, this should not inherit of std::exception nor of simgrid::Exception.
84      * Otherwise, users may accidentally catch it with a try {} catch (std::exception)
85      */
86   public:
87     StopRequest() = default;
88     explicit StopRequest(std::string msg) : msg_(std::string("Actor killed (") + msg + std::string(").")) {}
89     virtual const char* what() const noexcept { return msg_.c_str(); }
90
91   private:
92     std::string msg_ = std::string("Actor killed.");
93   };
94 };
95
96 class XBT_PUBLIC AttachContext : public Context {
97 public:
98   AttachContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t actor)
99       : Context(std::move(code), cleanup_func, actor)
100   {
101   }
102
103   ~AttachContext() override;
104
105   /** Called by the context when it is ready to give control
106    *  to the maestro.
107    */
108   virtual void attach_start() = 0;
109
110   /** Called by the context when it has finished its job */
111   virtual void attach_stop() = 0;
112 };
113
114 /* This allows Java to hijack the context factory (Java induces factories of factory :) */
115 typedef ContextFactory* (*ContextFactoryInitializer)();
116 XBT_PUBLIC_DATA ContextFactoryInitializer factory_initializer;
117
118 XBT_PRIVATE ContextFactory* thread_factory();
119 XBT_PRIVATE ContextFactory* sysv_factory();
120 XBT_PRIVATE ContextFactory* raw_factory();
121 XBT_PRIVATE ContextFactory* boost_factory();
122
123 }}}
124
125 typedef simgrid::kernel::context::ContextFactory *smx_context_factory_t;
126
127 XBT_PRIVATE void SIMIX_context_mod_init();
128 XBT_PRIVATE void SIMIX_context_mod_exit();
129
130 XBT_PUBLIC smx_context_t SIMIX_context_new(std::function<void()> code, void_pfn_smxprocess_t cleanup_func,
131                                            smx_actor_t simix_process);
132
133 #ifndef WIN32
134 XBT_PUBLIC_DATA char sigsegv_stack[SIGSTKSZ];
135 #endif
136
137 /* We are using the bottom of the stack to save some information, like the
138  * valgrind_stack_id. Define smx_context_usable_stack_size to give the remaining
139  * size for the stack. Round its value to a multiple of 16 (asan wants the stacks to be aligned this way). */
140 #if HAVE_VALGRIND_H
141 #define smx_context_usable_stack_size                                                                                  \
142   ((smx_context_stack_size - sizeof(unsigned int)) & ~0xf) /* for valgrind_stack_id */
143 #else
144 #define smx_context_usable_stack_size (smx_context_stack_size & ~0xf)
145 #endif
146
147 /** @brief Executes all the processes to run (in parallel if possible). */
148 XBT_PRIVATE void SIMIX_context_runall();
149
150 XBT_PUBLIC int SIMIX_process_get_maxpid();
151
152 XBT_PRIVATE void SIMIX_post_create_environment();
153
154 XBT_PRIVATE simgrid::simix::ActorCodeFactory& SIMIX_get_actor_code_factory(std::string name);
155
156 #endif