# Thread Pooling
### Introduction
线程池是一种多线程处理形式，处理过程中将任务添加到队列，然后在创建线程后自动启动这些任务。线程池线程都是后台线程。每个线程都使用默认的堆栈大小，以默认的优先级运行，并处于多线程单元中。
#### **线程池的组成部分：**
* 线程池管理器（ThreadPoolManager）：用于创建并管理线程池
* 工作线程（WorkThread）：线程池中线程
* 任务接口（Task）：每个任务必须实现的接口，以供工作线程调度任务的执行。
* 任务队列：用于存放没有处理的任务。提供一种缓冲机制。
**Idea****：管理一个任务队列，一个线程队列，然后每次取一个任务分配给一个线程去做，循环往复；**
**让每一个 thread 都去执行调度函数：循环获取一个 task，然后执行之。**
### 👉[`源码`](https://github.com/SleepyLGod/miscellaneous/blob/main/thread%20pooling)分析
#### **首先打基础：**
互斥到底是什么意思？为什么需要一个bool量来控制？条件变量condition又是什么？👇\
[**多线程的生产者与消费者模型**](https://segmentfault.com/a/1190000024444906)\
同时附上👉[**condition\_variable详解**](http://www.cnblogs.com/haippy/p/3252041.html)
这里来个生产者消费者的示例：
```cpp
#include // std::cout
#include // std::thread, std::this_thread::yield
#include // std::mutex, std::unique_lock
#include // std::condition_variable
std::mutex mtx;
std::condition_variable cv;
int cargo = 0;
bool shipment_available() {
return cargo != 0;
}
// 消费者线程
void consume(int n) {
for (int i = 0; i < n; ++i) {
std::unique_lock lck(mtx);
cv.wait(lck, shipment_available);
std::cout << cargo << '\n';
cargo = 0;
}
}
int main() {
std::thread consumer_thread(consume, 10); // 消费者线程.
// 主线程为生产者线程, 生产 10 个物品.
for (int i = 0; i < 10; ++i) {
while (shipment_available()) {
std::this_thread::yield();
}
std::unique_lock lck(mtx);
cargo = i + 1;
cv.notify_one();
}
consumer_thread.join();
return 0;
}
```
执行结果：
```
concurrency ) ./ConditionVariable-wait
1
2
3
4
5
6
7
8
9
10
```
通过新建一个线程池类，以类来管理资源。该类包含3个公有成员函数与5个私有成员：构造函数与析构函数即满足(RAII:Resource Acquisition Is Initialization)。
* 构造函数接受一个size\_t类型的数，表示连接数
* **`enqueue`**表示线程池部分中的任务管道，是一个模板函数
* **`workers_`**是一个成员为thread的vector，用来监视线程状态
* **`tasks_`**表示线程池部分中的任务队列，提供缓冲机制
* `queue_mutex_`表示互斥锁
* `condition_`表示条件变量(互斥锁，条件变量以及stop\_将在后面通过例子说明)
#### **奇淫技巧详解：**
< thread>: 是 C++ 11的新特性，主要包含了线程对象std::thread的构造。
< mutex>: C++ 11新特性，主要包含各种Mutex的类的构造，主要是std::mutex。
< condition\_variable>: C++ 11新特性， 包含多线程中常用的条件变量的声明，例如notify\_one、wait、wait\_for等等。
< future>: C++ 11新特性，**可以获取异步任务的结果，可用来实现同步**。包括std::sync和std::future。
< functional>: C++ 11增加了一些新特性，简单来说可以**实现函数到对象的绑定**，如bind()函数。
**构造函数ThreadPool(size\_t):**
```cpp
// the constructor just launches some amount of workers
inline ThreadPool::ThreadPool(size_t thread_number) : stop_(false) {
for(size_t i = 0; i < thread_number; ++i) {
workers_.emplace_back( // 压入
[this] { // lamda表达式获取参数值方式
for(;;) { // 无限循环作为线程
std::function< void() > task;
{ // 大括号作用：临时变量的生存期，即控制lock的时间
std::unique_lock lock(this->queue_mutex_);
this->condition_.wait(lock,
[this] {
// 当stop_==false(在运行/在消费) && tasks_.empty(),该线程被阻塞
return this->stop_ || !this->tasks_.empty();
});
if (this->stop_ && this->tasks_.empty()) {
return; // 如果线程池运行或者任务列表不为空则继续后续操作，否则退出函数
}
task = std::move(this->tasks_.front()); // 移动构造函数
this->tasks_.pop();
}
task(); // 执行任务
}
}
);
}
}
```
* 声明为inline，会建议编译器把函数以直接展开的形式放入目标代码而不是以入栈调用的形式
* 省略了参数
* **`emplace_back`**相当于**`push_back`**但比**`push_back`**更为高效（更适合用来传递对象，因为它可以**避免对象作为参数被传递时**在拷贝成员上的开销）
* wokers压入了一个 [**lamda表达式**](https://www.cnblogs.com/DswCnblog/p/5629165.html) (即一个匿名函数)，表示一个任务(线程)，使用for的无限循环，task表示函数对象，线程池中的函数接口在enqueue传入的参数之中，`condition.wait(lock, bool)`，当bool为false的时候，线程将会被堵塞挂起，被堵塞时需要`notify_one`来唤醒线程才能继续执行，详细说就是：
* `workers.emplace_back([this]{…});`在本代码中的lambda表达式是作为一个线程放入workers\[]中。 这个线程是个for(;;)循环。
* `for(;;)`里面: 每次循环首先声明一个`std::function< void()> task`，task是一个可以被封装成对象的函数，在此作为**最小任务单位**。然后用{}添加了一个作用域。
* 作用域里面: 在这个作用域中进行了一些线程上锁和线程状态的判断。
* `lock(this->queue_mutex)`: 声明上锁原语
* `condition.wait(lock, [this]{…})`: 使当前线程进入阻塞状态：
当第二个参数为false时，`wait()`会阻塞当前线程，为true时解除阻塞；
在本例中的条件就是，当线程池运行或者任务列表为空时，线程进入阻塞态。
然后判断，如果线程池运行或者任务列表非空则继续后续操作，否则退出这个`[this]{…}`线程函数。
`std::move()`是移动构造函数，相当于效率更高的拷贝构造函数。
最后将`tasks[]`任务队列的第一个任务出栈。
* 离开作用域: 然后执行task()，当前一轮循环结束。
**任务队列函数enqueue(F&& f, Args&&… args) 即 `template < class F, class… Args> auto enqueue(F&& f, Args&&… args) -> std::future< typename std::result_of< F(Args…)>::type>;`**
```cpp
// add new work item to the pool
template
auto ThreadPool::enqueue(F&& f, Args&&... args) // && 引用限定符，参数的右值引用， 此处表示参数传入一个函数
-> std::future::type> {
using return_type = typename std::result_of::type;
// packaged_task是对任务的一个抽象，我们可以给其传递一个函数来完成其构造。之后将任务投递给任何线程去完成，
// 通过packaged_task.get_future()方法获取的future来获取任务完成后的产出值
auto task = std::make_shared< std::packaged_task > ( // 指向F函数的智能指针
std::bind(std::forward(f), std::forward(args)...) // 传递函数进行构造
);
// future为期望，get_future获取任务完成后的产出值
std::future res = task->get_future(); // 获取future对象，如果task的状态不为ready，会阻塞当前调用者
{
std::unique_lock lock(this->queue_mutex_); // 保持互斥性，避免多个线程同时运行一个任务
// don't allow enqueueing after stopping the pool
if (this->stop_) {
throw std::runtime_error("enqueue on stopped ThreadPool");
}
this->tasks_.emplace([task](){
(*task)();
});
// 将task投递给线程去完成，vector尾部压入,
// std::packaged_task 重载了 operator()，重载后的operator()执行function。
// 因此可以(*task)()可以压入vector>
}
this->condition_.notify_one(); //选择一个wait状态的线程进行唤醒，并使他获得对象上的锁来完成任务(即其他线程无法访问对象)
return res;
} // notify_one不能保证获得锁的线程真正需要锁，并且因此可能产生死锁
```
* 这类多参数模板的格式就是如此首先，这是一个函数模板，而不是类模板
* template<> 部分: `template < class F, class… Args>` 其中 `class… Args`代表接受多个参数
* 返回类型: `auto`
* 函数名： `enqueue`
* 形参表： `(F&& f, Args&&… args)`。&&是C++ 11新特性，代表右值引用。
* 不明觉厉: `-> std::future< typename std::result_of< F(Args…)>::type>`
这个`->`符号其实用到了C++ 11中的 [**lamda表达式**](https://www.cnblogs.com/DswCnblog/p/5629165.html) ，后面的内容代表函数的返回类型。（-> 尾置限定符，语法就是如此，用来推断auto类型）
`result_of`用来得到返回类型的对象，它有一个成员`::type`
* 总的来说就是，这句话声明了一个名为`enqueue()`的函数模板，它的模板类型为`class F`以及多个其他类型`Args`，它的形参是一个F&&类型的f以及多个Args&&类型的args，最后这个函数返回类型是`std::future``<``typename std::result_of``<``F(Args…)``>``::type``>`。
对于这个冗长的返回类型，又可以继续分析： `std::future`在前面提到过了，它本身是一个模板，包含在 `< future>`中。通过`std::future`可以返回这个`A`类型的异步任务的结果。 `std::result_of::type`就是这段代码中的A类型。`result_of`获取了someTask的执行结果的类型。 `F(Args…)`就是这段代码的someTask，即函数`F(Args…)`。 所以最后这个模板函数`enqueue()`的返回值类型就是`F(Args…)`的异步执行结果类型。
* 推荐看看👉 [**typename与class的区别**](https://rookiedong.gitbook.io/notes/utils/typename-or-class)
* 看看函数体内：
* `using … = typename …;` 功能类似typedef。将`return_type`声明为一个`result_of< F(Args…)>::type`类型，即函数F(Args…)的返回值类型。
* `make_shared < packaged_task < >>(bind())`: 又是复杂的嵌套。
`make_shared` : 开辟()个类型为<>的内存
`packaged_task` : 把任务打包,这里打包的是return\_type
`bind` : 绑定函数f, 参数为args…
`forward` : 使()转化为<>相同类型的左值或右值引用
简单来说，这句话相当于把函数f和它的参数args…打包为一个模板内定义的task，便于后续操作。
* `res = task->get_future()`: 与模板函数的返回类型一致，是函数异步的执行结果。
* 新作用域: 先是一个加锁原语`lock()`。 然后是个异常处理，如果停止的话抛出一个运行时异常。 最后，向任务列表插入这个任务`task{(*task)();}`。
* `condition.notify_one()`: 解除一个正在等待唤醒的线程的阻塞态。
* 返回异步结果res
**析构函数\~ThreadPool()**
```cpp
// the distructor joins all threads
inline ThreadPool::~ThreadPool() {
{
std::unique_lock lock(queue_mutex_);
this->stop_ = true;
}
condition_.notify_all(); // 通知所有wait状态的线程竞争对象的控制权，唤醒所有线程执行
for (std::thread &worker: workers_) { // for-each循环
worker.join(); // 因为线程都开始竞争了，所以一定会执行完，join可等待线程执行完
}
}
```
* 通过`notify_all`可以唤醒线程竞争任务的执行，从而使所有任务不被遗漏
* 当所有线程执行完毕时返回主线程`worker.join()`
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://rookiedong.gitbook.io/notes/utils/thread-pooling.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.