| 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 // ---------------------------------------------------------------
20 // Tasking class header
21 // Class Description:
22 // Abstract base class for creating a task queue used by
23 // ThreadPool
24 // ---------------------------------------------------------------
25 // Author: Jonathan Madsen
26 // ---------------------------------------------------------------
27
28 #pragma once
29
30 #include "PTL/Macros.hh"
31 #include "PTL/Types.hh"
32
33 #include <atomic>
34 #include <cstdint>
35 #include <functional>
36 #include <memory>
37 #include <set>
38
39 namespace PTL
40 {
41 class VTask;
42 class ThreadPool;
43 class ThreadData;
44
45 class VUserTaskQueue
46 {
47 public:
48 using task_pointer = std::shared_ptr<VTask>;
49 using AtomicInt = std::atomic<intmax_t>;
50 using size_type = uintmax_t;
51 using function_type = std::function<void()>;
52 using ThreadIdSet = std::set<ThreadId>;
53
54 public:
55 // Constructor - accepting the number of workers
56 explicit VUserTaskQueue(intmax_t nworkers = -1);
57 // Virtual destructors are required by abstract classes
58 // so add it by default, just in case
59 virtual ~VUserTaskQueue() = default;
60
61 public:
62 // Virtual function for getting a task from the queue
63 // parameters:
64 // 1. int - get from specific sub-queue
65 // 2. int - number of iterations
66 // returns:
67 // VTask* - a task or nullptr
68 virtual task_pointer GetTask(intmax_t subq = -1, intmax_t nitr = -1) = 0;
69
70 // Virtual function for inserting a task into the queue
71 // parameters:
72 // 1. VTask* - task to insert
73 // 2. int - sub-queue to inserting into
74 // return:
75 // int - subqueue inserted into
76 virtual intmax_t InsertTask(task_pointer&&, ThreadData* = nullptr,
77 intmax_t subq = -1) PTL_NO_SANITIZE_THREAD = 0;
78
79 // Overload this function to hold threads
80 virtual void Wait() = 0;
81 virtual intmax_t GetThreadBin() const = 0;
82
83 virtual void resize(intmax_t) = 0;
84
85 // these are used for stanard checking
86 virtual size_type size() const = 0;
87 virtual bool empty() const = 0;
88
89 virtual size_type bin_size(size_type bin) const = 0;
90 virtual bool bin_empty(size_type bin) const = 0;
91
92 // these are for slower checking, default to returning normal size()/empty
93 virtual size_type true_size() const { return size(); }
94 virtual bool true_empty() const { return empty(); }
95
96 // a method of executing a specific function on all threads
97 virtual void ExecuteOnAllThreads(ThreadPool* tp, function_type f) = 0;
98
99 virtual void ExecuteOnSpecificThreads(ThreadIdSet tid_set, ThreadPool* tp,
100 function_type f) = 0;
101
102 intmax_t workers() const { return m_workers; }
103
104 virtual VUserTaskQueue* clone() = 0;
105
106 protected:
107 intmax_t m_workers = 0;
108 };
109
110 } // namespace PTL
111