Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
namespacify a global function of SIMIX
[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/kernel/activity/ActivityImpl.hpp"
11
12 #include <csignal>
13 #include <functional>
14
15 namespace simgrid {
16 namespace kernel {
17 namespace context {
18
19 class XBT_PUBLIC ContextFactory {
20 public:
21   explicit ContextFactory() {}
22   ContextFactory(const ContextFactory&) = delete;
23   ContextFactory& operator=(const ContextFactory&) = delete;
24   virtual ~ContextFactory();
25   virtual Context* create_context(std::function<void()>&& code, actor::ActorImpl* actor) = 0;
26
27   /** Turn the current thread into a simulation context */
28   virtual Context* attach(actor::ActorImpl* actor);
29   /** Turn the current thread into maestro (the old maestro becomes a regular actor) */
30   virtual Context* create_maestro(std::function<void()>&& code, actor::ActorImpl* actor);
31
32   virtual void run_all() = 0;
33
34 protected:
35   template <class T, class... Args> T* new_context(Args&&... args)
36   {
37     T* context = new T(std::forward<Args>(args)...);
38     context->declare_context(sizeof(T));
39     return context;
40   }
41 };
42
43 class XBT_PUBLIC Context {
44   friend ContextFactory;
45
46   std::function<void()> code_;
47   actor::ActorImpl* actor_ = nullptr;
48   void declare_context(std::size_t size);
49
50 public:
51   bool iwannadie = false;
52
53   Context(std::function<void()>&& code, actor::ActorImpl* actor);
54   Context(const Context&) = delete;
55   Context& operator=(const Context&) = delete;
56   virtual ~Context();
57
58   void operator()() { code_(); }
59   bool has_code() const { return static_cast<bool>(code_); }
60   actor::ActorImpl* get_actor() { return this->actor_; }
61
62   // Scheduling methods
63   virtual void stop();
64   virtual void suspend() = 0;
65
66   // Retrieving the self() context
67   /** @brief Retrives the current context of this thread */
68   static Context* self();
69   /** @brief Sets the current context of this thread */
70   static void set_current(Context* self);
71 };
72
73 class XBT_PUBLIC AttachContext : public Context {
74 public:
75   AttachContext(std::function<void()>&& code, actor::ActorImpl* actor) : Context(std::move(code), actor) {}
76   AttachContext(const AttachContext&) = delete;
77   AttachContext& operator=(const AttachContext&) = delete;
78   ~AttachContext() override;
79
80   /** Called by the context when it is ready to give control
81    *  to the maestro.
82    */
83   virtual void attach_start() = 0;
84
85   /** Called by the context when it has finished its job */
86   virtual void attach_stop() = 0;
87 };
88
89
90 /* This allows Java to hijack the context factory (Java induces factories of factory :) */
91 typedef ContextFactory* (*ContextFactoryInitializer)();
92 XBT_PUBLIC_DATA ContextFactoryInitializer factory_initializer;
93
94 XBT_PRIVATE ContextFactory* thread_factory();
95 XBT_PRIVATE ContextFactory* sysv_factory();
96 XBT_PRIVATE ContextFactory* raw_factory();
97 XBT_PRIVATE ContextFactory* boost_factory();
98
99 } // namespace context
100 } // namespace kernel
101 } // namespace simgrid
102
103 typedef simgrid::kernel::context::ContextFactory *smx_context_factory_t;
104
105 XBT_PRIVATE void SIMIX_context_mod_init();
106 XBT_PRIVATE void SIMIX_context_mod_exit();
107
108 #ifndef WIN32
109 XBT_PUBLIC_DATA unsigned char sigsegv_stack[SIGSTKSZ];
110 #endif
111
112 XBT_PRIVATE simgrid::simix::ActorCodeFactory& SIMIX_get_actor_code_factory(const std::string& name);
113
114 #endif