Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
4c76ae2e38bf41a4e3db0fb59e8134550aab9295
[simgrid.git] / src / kernel / context / ContextThread.hpp
1 /* Copyright (c) 2009-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 /* \file ThreadContext.hpp Context switching with native threads */
7
8 #ifndef SIMGRID_SIMIX_THREAD_CONTEXT_HPP
9 #define SIMGRID_SIMIX_THREAD_CONTEXT_HPP
10
11 #include "simgrid/simix.hpp"
12 #include "src/kernel/context/Context.hpp"
13 #include "src/xbt/OsSemaphore.hpp"
14
15 #include <thread>
16
17 namespace simgrid {
18 namespace kernel {
19 namespace context {
20
21 class XBT_PUBLIC ThreadContext : public AttachContext {
22 public:
23   ThreadContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process, bool maestro);
24   ~ThreadContext() override;
25   void stop() override;
26   void suspend() override;
27   void attach_start() override;
28   void attach_stop() override;
29
30   bool is_maestro() const { return is_maestro_; }
31   void release(); // unblock context's start()
32   void wait();    // wait for context's yield()
33
34 private:
35   /** A portable thread */
36   std::thread* thread_ = nullptr;
37   /** Semaphore used to schedule/yield the process (not needed when the maestro is in main, but harmless then) */
38   xbt::OsSemaphore begin_{0};
39   /** Semaphore used to schedule/unschedule (not needed when the maestro is in main, but harmless then) */
40   xbt::OsSemaphore end_{0};
41   bool is_maestro_;
42
43   void start();                // match a call to release()
44   void yield();                // match a call to yield()
45   virtual void start_hook() { /* empty placeholder, called after start(). Used in parallel mode and Java */}
46   virtual void yield_hook() { /* empty placeholder, called before yield(). Used in parallel mode */}
47
48   static void* wrapper(void *param);
49 };
50
51 class XBT_PUBLIC SerialThreadContext : public ThreadContext {
52 public:
53   SerialThreadContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process, bool maestro)
54       : ThreadContext(std::move(code), cleanup_func, process, maestro)
55   {
56   }
57
58   static void run_all();
59 };
60
61 class ParallelThreadContext : public ThreadContext {
62 public:
63   ParallelThreadContext(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process,
64                         bool maestro)
65       : ThreadContext(std::move(code), cleanup_func, process, maestro)
66   {
67   }
68
69   static void initialize();
70   static void finalize();
71   static void run_all();
72
73 private:
74   static xbt::OsSemaphore* thread_sem_;
75
76   void start_hook() override;
77   void yield_hook() override;
78 };
79
80 class ThreadContextFactory : public ContextFactory {
81 public:
82   ThreadContextFactory();
83   ~ThreadContextFactory() override;
84   ThreadContext* create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup_func,
85                                 smx_actor_t process) override
86   {
87     bool maestro = not code;
88     return create_context(std::move(code), cleanup_func, process, maestro);
89   }
90   void run_all() override;
91
92   // Optional methods:
93   ThreadContext* attach(void_pfn_smxprocess_t cleanup_func, smx_actor_t process) override
94   {
95     return create_context(std::function<void()>(), cleanup_func, process, false);
96   }
97   ThreadContext* create_maestro(std::function<void()> code, smx_actor_t process) override
98   {
99     return create_context(std::move(code), nullptr, process, true);
100   }
101
102 private:
103   bool parallel_;
104
105   ThreadContext* create_context(std::function<void()> code, void_pfn_smxprocess_t cleanup_func, smx_actor_t process,
106                                 bool maestro);
107 };
108 }}} // namespace
109
110 #endif