| Geant4 Cross Reference |
1 //
2 // MIT License
3 // Copyright (c) 2020 Jonathan R. Madsen
4 // Permission is hereby granted, free of charge, to any person obtaining a copy
5 // of this software and associated documentation files (the "Software"), to deal
6 // in the Software without restriction, including without limitation the rights
7 // to use, copy, modify, merge, publish, distribute, sublicense, and
8 // copies of the Software, and to permit persons to whom the Software is
9 // furnished to do so, subject to the following conditions:
10 // The above copyright notice and this permission notice shall be included in
11 // all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED
12 // "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
13 // LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
14 // PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
15 // HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
16 // ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
17 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
18 //
19 // class description:
20 // This is a class for run control in Tasking for multi-threaded runs
21 // It extends RunManager re-implementing multi-threaded behavior in
22 // key methods. See documentation for RunManager
23 // Users initializes an instance of this class instead of RunManager
24 // to start a multi-threaded simulation.
25
26 #pragma once
27
28 #include "PTL/ThreadPool.hh"
29
30 #include <cstddef>
31 #include <cstdint>
32 #include <thread>
33
34 namespace PTL
35 {
36 class TaskManager;
37 class VUserTaskQueue;
38
39 //======================================================================================//
40
41 class TaskRunManager
42 {
43 public:
44 using pointer = TaskRunManager*;
45
46 public:
47 // Parameters:
48 // m_task_queue: provide a custom task queue
49 // useTBB: only relevant if PTL_USE_TBB defined
50 // grainsize: 0 = auto
51 explicit TaskRunManager(bool useTBB = false);
52 virtual ~TaskRunManager();
53
54 public:
55 virtual int GetNumberOfThreads() const
56 {
57 return (m_thread_pool) ? (int)m_thread_pool->size() : 0;
58 }
59 virtual size_t GetNumberActiveThreads() const
60 {
61 return (m_thread_pool) ? m_thread_pool->size() : 0;
62 }
63
64 public:
65 // Inherited methods to re-implement for MT case
66 virtual void Initialize(uint64_t n = std::thread::hardware_concurrency());
67 virtual void Terminate();
68 ThreadPool* GetThreadPool() const { return m_thread_pool; }
69 TaskManager* GetTaskManager() const { return m_task_manager; }
70 bool IsInitialized() const { return m_is_initialized; }
71
72 public: // with description
73 // Singleton implementing master thread behavior
74 static TaskRunManager* GetInstance(bool useTBB = false);
75 static TaskRunManager* GetMasterRunManager(bool useTBB = false);
76
77 private:
78 static pointer& GetPrivateMasterRunManager();
79 static pointer& GetPrivateMasterRunManager(bool init, bool useTBB = false);
80
81 protected:
82 // Barriers: synch points between master and workers
83 bool m_is_initialized = false;
84 uint64_t m_workers = 0;
85 bool m_use_tbb = false;
86 VUserTaskQueue* m_task_queue = nullptr;
87 ThreadPool* m_thread_pool = nullptr;
88 TaskManager* m_task_manager = nullptr;
89 };
90
91 } // namespace PTL
92