OLD | NEW |
| (Empty) |
1 // Copyright 2016 The Chromium Authors. All rights reserved. | |
2 // Use of this source code is governed by a BSD-style license that can be | |
3 // found in the LICENSE file. | |
4 | |
5 #ifndef BASE_TASK_SCHEDULER_SCHEDULER_THREAD_POOL_IMPL_H_ | |
6 #define BASE_TASK_SCHEDULER_SCHEDULER_THREAD_POOL_IMPL_H_ | |
7 | |
8 #include <stddef.h> | |
9 | |
10 #include <memory> | |
11 #include <string> | |
12 #include <vector> | |
13 | |
14 #include "base/base_export.h" | |
15 #include "base/callback.h" | |
16 #include "base/logging.h" | |
17 #include "base/macros.h" | |
18 #include "base/memory/ref_counted.h" | |
19 #include "base/strings/string_piece.h" | |
20 #include "base/synchronization/condition_variable.h" | |
21 #include "base/task_runner.h" | |
22 #include "base/task_scheduler/priority_queue.h" | |
23 #include "base/task_scheduler/scheduler_lock.h" | |
24 #include "base/task_scheduler/scheduler_thread_pool.h" | |
25 #include "base/task_scheduler/scheduler_worker_thread.h" | |
26 #include "base/task_scheduler/scheduler_worker_thread_stack.h" | |
27 #include "base/task_scheduler/sequence.h" | |
28 #include "base/task_scheduler/task.h" | |
29 #include "base/task_scheduler/task_traits.h" | |
30 #include "base/threading/platform_thread.h" | |
31 | |
32 namespace base { | |
33 namespace internal { | |
34 | |
35 class DelayedTaskManager; | |
36 class TaskTracker; | |
37 | |
38 // A pool of threads that run Tasks. This class is thread-safe. | |
39 class BASE_EXPORT SchedulerThreadPoolImpl : public SchedulerThreadPool { | |
40 public: | |
41 enum class IORestriction { | |
42 ALLOWED, | |
43 DISALLOWED, | |
44 }; | |
45 | |
46 // Callback invoked when a Sequence isn't empty after a worker thread pops a | |
47 // Task from it. | |
48 using ReEnqueueSequenceCallback = Callback<void(scoped_refptr<Sequence>)>; | |
49 | |
50 // Destroying a SchedulerThreadPool returned by CreateThreadPool() is not | |
51 // allowed in production; it is always leaked. In tests, it can only be | |
52 // destroyed after JoinForTesting() has returned. | |
53 ~SchedulerThreadPoolImpl() override; | |
54 | |
55 // Creates a SchedulerThreadPool labeled |name| with up to |max_threads| | |
56 // threads of priority |thread_priority|. |io_restriction| indicates whether | |
57 // Tasks on the constructed thread pool are allowed to make I/O calls. | |
58 // |re_enqueue_sequence_callback| will be invoked after a thread of this | |
59 // thread pool tries to run a Task. |task_tracker| is used to handle shutdown | |
60 // behavior of Tasks. |delayed_task_manager| handles Tasks posted with a | |
61 // delay. Returns nullptr on failure to create a thread pool with at least one | |
62 // thread. | |
63 static std::unique_ptr<SchedulerThreadPoolImpl> Create( | |
64 StringPiece name, | |
65 ThreadPriority thread_priority, | |
66 size_t max_threads, | |
67 IORestriction io_restriction, | |
68 const ReEnqueueSequenceCallback& re_enqueue_sequence_callback, | |
69 TaskTracker* task_tracker, | |
70 DelayedTaskManager* delayed_task_manager); | |
71 | |
72 // Waits until all threads are idle. | |
73 void WaitForAllWorkerThreadsIdleForTesting(); | |
74 | |
75 // Joins all threads of this thread pool. Tasks that are already running are | |
76 // allowed to complete their execution. This can only be called once. | |
77 void JoinForTesting(); | |
78 | |
79 // SchedulerThreadPool: | |
80 scoped_refptr<TaskRunner> CreateTaskRunnerWithTraits( | |
81 const TaskTraits& traits, | |
82 ExecutionMode execution_mode) override; | |
83 void ReEnqueueSequence(scoped_refptr<Sequence> sequence, | |
84 const SequenceSortKey& sequence_sort_key) override; | |
85 bool PostTaskWithSequence(std::unique_ptr<Task> task, | |
86 scoped_refptr<Sequence> sequence, | |
87 SchedulerWorkerThread* worker_thread) override; | |
88 void PostTaskWithSequenceNow(std::unique_ptr<Task> task, | |
89 scoped_refptr<Sequence> sequence, | |
90 SchedulerWorkerThread* worker_thread) override; | |
91 | |
92 private: | |
93 class SchedulerWorkerThreadDelegateImpl; | |
94 | |
95 SchedulerThreadPoolImpl(StringPiece name, | |
96 IORestriction io_restriction, | |
97 TaskTracker* task_tracker, | |
98 DelayedTaskManager* delayed_task_manager); | |
99 | |
100 bool Initialize( | |
101 ThreadPriority thread_priority, | |
102 size_t max_threads, | |
103 const ReEnqueueSequenceCallback& re_enqueue_sequence_callback); | |
104 | |
105 // Wakes up the last thread from this thread pool to go idle, if any. | |
106 void WakeUpOneThread(); | |
107 | |
108 // Adds |worker_thread| to |idle_worker_threads_stack_|. | |
109 void AddToIdleWorkerThreadsStack(SchedulerWorkerThread* worker_thread); | |
110 | |
111 // Removes |worker_thread| from |idle_worker_threads_stack_|. | |
112 void RemoveFromIdleWorkerThreadsStack(SchedulerWorkerThread* worker_thread); | |
113 | |
114 // The name of this thread pool, used to label its worker threads. | |
115 const std::string name_; | |
116 | |
117 // All worker threads owned by this thread pool. Only modified during | |
118 // initialization of the thread pool. | |
119 std::vector<std::unique_ptr<SchedulerWorkerThread>> worker_threads_; | |
120 | |
121 // Synchronizes access to |next_worker_thread_index_|. | |
122 SchedulerLock next_worker_thread_index_lock_; | |
123 | |
124 // Index of the worker thread that will be assigned to the next single- | |
125 // threaded TaskRunner returned by this pool. | |
126 size_t next_worker_thread_index_ = 0; | |
127 | |
128 // PriorityQueue from which all threads of this thread pool get work. | |
129 PriorityQueue shared_priority_queue_; | |
130 | |
131 // Indicates whether Tasks on this thread pool are allowed to make I/O calls. | |
132 const IORestriction io_restriction_; | |
133 | |
134 // Synchronizes access to |idle_worker_threads_stack_| and | |
135 // |idle_worker_threads_stack_cv_for_testing_|. Has |shared_priority_queue_|'s | |
136 // lock as its predecessor so that a thread can be pushed to | |
137 // |idle_worker_threads_stack_| within the scope of a Transaction (more | |
138 // details in GetWork()). | |
139 SchedulerLock idle_worker_threads_stack_lock_; | |
140 | |
141 // Stack of idle worker threads. | |
142 SchedulerWorkerThreadStack idle_worker_threads_stack_; | |
143 | |
144 // Signaled when all worker threads become idle. | |
145 std::unique_ptr<ConditionVariable> idle_worker_threads_stack_cv_for_testing_; | |
146 | |
147 // Signaled once JoinForTesting() has returned. | |
148 WaitableEvent join_for_testing_returned_; | |
149 | |
150 #if DCHECK_IS_ON() | |
151 // Signaled when all threads have been created. | |
152 WaitableEvent threads_created_; | |
153 #endif | |
154 | |
155 TaskTracker* const task_tracker_; | |
156 DelayedTaskManager* const delayed_task_manager_; | |
157 | |
158 DISALLOW_COPY_AND_ASSIGN(SchedulerThreadPoolImpl); | |
159 }; | |
160 | |
161 } // namespace internal | |
162 } // namespace base | |
163 | |
164 #endif // BASE_TASK_SCHEDULER_SCHEDULER_THREAD_POOL_IMPL_H_ | |
OLD | NEW |