Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
[sonar] Use unsigned char* for context stacks.
[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, smx_actor_t actor, bool maestro);
24   ThreadContext(const ThreadContext&) = delete;
25   ThreadContext& operator=(const ThreadContext&) = delete;
26   ~ThreadContext() override;
27   void stop() override;
28   void suspend() override;
29   void attach_start() override;
30   void attach_stop() override;
31
32   bool is_maestro() const { return is_maestro_; }
33   void release(); // unblock context's start()
34   void wait();    // wait for context's yield()
35
36 private:
37   /** A portable thread */
38   std::thread* thread_ = nullptr;
39   /** Semaphore used to schedule/yield the actor (not needed when the maestro is in main, but harmless then) */
40   xbt::OsSemaphore begin_{0};
41   /** Semaphore used to schedule/unschedule (not needed when the maestro is in main, but harmless then) */
42   xbt::OsSemaphore end_{0};
43   bool is_maestro_;
44
45   void start();                // match a call to release()
46   void yield();                // match a call to yield()
47   virtual void start_hook() { /* empty placeholder, called after start(). Used in parallel mode and Java */}
48   virtual void yield_hook() { /* empty placeholder, called before yield(). Used in parallel mode */}
49   virtual void stop_hook() { /* empty placeholder, called at stop(). Used in Java */}
50
51   static void* wrapper(void *param);
52 };
53
54 class XBT_PUBLIC SerialThreadContext : public ThreadContext {
55 public:
56   SerialThreadContext(std::function<void()> code, smx_actor_t actor, bool maestro)
57       : ThreadContext(std::move(code), actor, maestro)
58   {
59   }
60
61   static void run_all();
62 };
63
64 class ParallelThreadContext : public ThreadContext {
65 public:
66   ParallelThreadContext(std::function<void()> code, smx_actor_t actor, bool maestro)
67       : ThreadContext(std::move(code), actor, maestro)
68   {
69   }
70
71   static void initialize();
72   static void finalize();
73   static void run_all();
74
75 private:
76   static xbt::OsSemaphore* thread_sem_;
77
78   void start_hook() override;
79   void yield_hook() override;
80 };
81
82 class ThreadContextFactory : public ContextFactory {
83 public:
84   ThreadContextFactory();
85   ThreadContextFactory(const ThreadContextFactory&) = delete;
86   ThreadContextFactory& operator=(const ThreadContextFactory&) = delete;
87   ~ThreadContextFactory() override;
88   ThreadContext* create_context(std::function<void()> code, smx_actor_t actor) override
89   {
90     bool maestro = not code;
91     return create_context(std::move(code), actor, maestro);
92   }
93   void run_all() override;
94
95   // Optional methods:
96   ThreadContext* attach(smx_actor_t actor) override { return create_context(std::function<void()>(), actor, false); }
97   ThreadContext* create_maestro(std::function<void()> code, smx_actor_t actor) override
98   {
99     return create_context(std::move(code), actor, true);
100   }
101
102 private:
103   bool parallel_;
104
105   ThreadContext* create_context(std::function<void()> code, smx_actor_t actor, bool maestro);
106 };
107 }}} // namespace
108
109 #endif