Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2012 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 17 | #ifndef ART_RUNTIME_THREAD_POOL_H_ |
| 18 | #define ART_RUNTIME_THREAD_POOL_H_ |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 19 | |
| 20 | #include <deque> |
| 21 | #include <vector> |
| 22 | |
Mathieu Chartier | 35883cc | 2012-11-13 14:08:12 -0800 | [diff] [blame] | 23 | #include "barrier.h" |
Elliott Hughes | 76b6167 | 2012-12-12 17:47:30 -0800 | [diff] [blame] | 24 | #include "base/mutex.h" |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 25 | #include "closure.h" |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 26 | #include "locks.h" |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 27 | |
| 28 | namespace art { |
| 29 | |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 30 | class ThreadPool; |
| 31 | |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 32 | class Task : public Closure { |
Brian Carlstrom | 02c8cc6 | 2013-07-18 15:54:44 -0700 | [diff] [blame^] | 33 | public: |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 34 | // Called when references reaches 0. |
| 35 | virtual void Finalize() { } |
| 36 | }; |
| 37 | |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 38 | class ThreadPoolWorker { |
| 39 | public: |
| 40 | static const size_t kDefaultStackSize = 1 * MB; |
| 41 | |
| 42 | size_t GetStackSize() const { |
| 43 | return stack_size_; |
| 44 | } |
| 45 | |
| 46 | virtual ~ThreadPoolWorker(); |
| 47 | |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 48 | protected: |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 49 | ThreadPoolWorker(ThreadPool* thread_pool, const std::string& name, size_t stack_size); |
| 50 | static void* Callback(void* arg) LOCKS_EXCLUDED(Locks::mutator_lock_); |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 51 | virtual void Run(); |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 52 | |
Ian Rogers | d914eb2 | 2013-04-18 16:11:15 -0700 | [diff] [blame] | 53 | ThreadPool* const thread_pool_; |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 54 | const std::string name_; |
| 55 | const size_t stack_size_; |
| 56 | pthread_t pthread_; |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 57 | |
| 58 | friend class ThreadPool; |
| 59 | DISALLOW_COPY_AND_ASSIGN(ThreadPoolWorker); |
| 60 | }; |
| 61 | |
| 62 | class ThreadPool { |
| 63 | public: |
| 64 | // Returns the number of threads in the thread pool. |
| 65 | size_t GetThreadCount() const { |
| 66 | return threads_.size(); |
| 67 | } |
| 68 | |
| 69 | // Broadcast to the workers and tell them to empty out the work queue. |
| 70 | void StartWorkers(Thread* self); |
| 71 | |
| 72 | // Do not allow workers to grab any new tasks. |
| 73 | void StopWorkers(Thread* self); |
| 74 | |
| 75 | // Add a new task, the first available started worker will process it. Does not delete the task |
| 76 | // after running it, it is the caller's responsibility. |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 77 | void AddTask(Thread* self, Task* task); |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 78 | |
Brian Carlstrom | 93ba893 | 2013-07-17 21:31:49 -0700 | [diff] [blame] | 79 | explicit ThreadPool(size_t num_threads); |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 80 | virtual ~ThreadPool(); |
| 81 | |
| 82 | // Wait for all tasks currently on queue to get completed. |
Ian Rogers | 1d54e73 | 2013-05-02 21:10:01 -0700 | [diff] [blame] | 83 | void Wait(Thread* self, bool do_work, bool may_hold_locks); |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 84 | |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 85 | size_t GetTaskCount(Thread* self); |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 86 | |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 87 | // Returns the total amount of workers waited for tasks. |
| 88 | uint64_t GetWaitTime() const { |
| 89 | return total_wait_time_; |
| 90 | } |
| 91 | |
| 92 | protected: |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 93 | // Get a task to run, blocks if there are no tasks left |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 94 | virtual Task* GetTask(Thread* self); |
| 95 | |
| 96 | // Try to get a task, returning NULL if there is none available. |
| 97 | Task* TryGetTask(Thread* self); |
| 98 | Task* TryGetTaskLocked(Thread* self) EXCLUSIVE_LOCKS_REQUIRED(task_queue_lock_); |
| 99 | |
| 100 | // Are we shutting down? |
| 101 | bool IsShuttingDown() const EXCLUSIVE_LOCKS_REQUIRED(task_queue_lock_) { |
| 102 | return shutting_down_; |
| 103 | } |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 104 | |
| 105 | Mutex task_queue_lock_; |
| 106 | ConditionVariable task_queue_condition_ GUARDED_BY(task_queue_lock_); |
| 107 | ConditionVariable completion_condition_ GUARDED_BY(task_queue_lock_); |
| 108 | volatile bool started_ GUARDED_BY(task_queue_lock_); |
| 109 | volatile bool shutting_down_ GUARDED_BY(task_queue_lock_); |
| 110 | // How many worker threads are waiting on the condition. |
| 111 | volatile size_t waiting_count_ GUARDED_BY(task_queue_lock_); |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 112 | std::deque<Task*> tasks_ GUARDED_BY(task_queue_lock_); |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 113 | // TODO: make this immutable/const? |
| 114 | std::vector<ThreadPoolWorker*> threads_; |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 115 | // Work balance detection. |
| 116 | uint64_t start_time_ GUARDED_BY(task_queue_lock_); |
| 117 | uint64_t total_wait_time_; |
Mathieu Chartier | 35883cc | 2012-11-13 14:08:12 -0800 | [diff] [blame] | 118 | Barrier creation_barier_; |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 119 | |
| 120 | friend class ThreadPoolWorker; |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 121 | friend class WorkStealingWorker; |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 122 | DISALLOW_COPY_AND_ASSIGN(ThreadPool); |
| 123 | }; |
| 124 | |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 125 | class WorkStealingTask : public Task { |
| 126 | public: |
Brian Carlstrom | 0cd7ec2 | 2013-07-17 23:40:20 -0700 | [diff] [blame] | 127 | WorkStealingTask() : ref_count_(0) {} |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 128 | |
| 129 | size_t GetRefCount() const { |
| 130 | return ref_count_; |
| 131 | } |
| 132 | |
| 133 | virtual void StealFrom(Thread* self, WorkStealingTask* source) = 0; |
| 134 | |
| 135 | private: |
| 136 | // How many people are referencing this task. |
| 137 | size_t ref_count_; |
| 138 | |
| 139 | friend class WorkStealingWorker; |
| 140 | }; |
| 141 | |
| 142 | class WorkStealingWorker : public ThreadPoolWorker { |
| 143 | public: |
| 144 | virtual ~WorkStealingWorker(); |
| 145 | |
| 146 | bool IsRunningTask() const { |
| 147 | return task_ != NULL; |
| 148 | } |
| 149 | |
| 150 | protected: |
| 151 | WorkStealingTask* task_; |
| 152 | |
| 153 | WorkStealingWorker(ThreadPool* thread_pool, const std::string& name, size_t stack_size); |
| 154 | virtual void Run(); |
| 155 | |
| 156 | friend class WorkStealingThreadPool; |
| 157 | DISALLOW_COPY_AND_ASSIGN(WorkStealingWorker); |
| 158 | }; |
| 159 | |
| 160 | class WorkStealingThreadPool : public ThreadPool { |
| 161 | public: |
Brian Carlstrom | 93ba893 | 2013-07-17 21:31:49 -0700 | [diff] [blame] | 162 | explicit WorkStealingThreadPool(size_t num_threads); |
Mathieu Chartier | 02b6a78 | 2012-10-26 13:51:26 -0700 | [diff] [blame] | 163 | virtual ~WorkStealingThreadPool(); |
| 164 | |
| 165 | private: |
| 166 | Mutex work_steal_lock_; |
| 167 | // Which thread we are stealing from (round robin). |
| 168 | size_t steal_index_; |
| 169 | |
| 170 | // Find a task to steal from |
| 171 | WorkStealingTask* FindTaskToStealFrom(Thread* self) EXCLUSIVE_LOCKS_REQUIRED(work_steal_lock_); |
| 172 | |
| 173 | friend class WorkStealingWorker; |
| 174 | }; |
| 175 | |
Mathieu Chartier | 0e4627e | 2012-10-23 16:13:36 -0700 | [diff] [blame] | 176 | } // namespace art |
| 177 | |
Brian Carlstrom | fc0e321 | 2013-07-17 14:40:12 -0700 | [diff] [blame] | 178 | #endif // ART_RUNTIME_THREAD_POOL_H_ |