线程池库用户文档
======
一、概述
-----
线程池库是一个用于管理线程的集合，以实现并发执行任务的库。它允许用户动态地创建、分配和管理线程，以执行指定的任务。该库的设计目标是提供一种高效且方便的方式来处理并发任务，以提升应用程序的性能和响应速度。
二、头文件
------
头文件`thrd_pool.h`包含了线程池库的函数声明和数据类型定义。在使用线程池库之前，请确保已包含此头文件。
三、数据类型
------
### 1. `task_func_t`
此类型定义了可以作为任务执行的函数。它接受一个`task_arg_t`类型的参数，并返回`void`。
### 2. `task_arg_t`
此类型定义了任务的参数。它的类型为`void *`。
### 3. `thrd_pool_t`
此类型定义了线程池的结构。它是线程池库的主要组成部分，用于管理线程和执行任务。
四、函数声明
-------
### 1. `int thrd_pool_init(thrd_pool_t **thpool, int size);`
初始化一个线程池，并指定其最大线程数。如果成功，将创建一个新的线程池并将其地址存储在`thpool`所指向的地址中。返回0表示成功，-1表示错误。
### 2. `int thrd_pool_delete(thrd_pool_t *thpool);`
删除一个已初始化的线程池，并释放相关资源。返回0表示成功，-1表示错误。如果线程池的任务未完成，则不会有任何行为。
### 3. `int thrd_pool_add_task(thrd_pool_t *thpool, task_func_t tafunc, task_arg_t targ);`
将一个任务添加到线程池中以供执行。`tafunc`是要执行的函数，`targ`是函数的参数。返回0表示成功，-1表示错误。
### 4. `int thrd_pool_is_empty(thrd_pool_t *thpool);`
检查线程池的任务队列是否为空（即没有任何任务待执行）。返回非零值表示线程池不为空，零表示线程池为空。
### 5. `int thrd_pool_is_finish(thrd_pool_t *thpool);`
检查线程池是否已完成所有任务的执行。返回非零值表示线程池仍在执行任务，零表示线程池已完成所有任务的执行。
### 6. `void thrd_pool_wait(thrd_pool_t *thpool);`
等待线程池中的所有任务完成执行（任务队列为空且线程池已完成所有任务的执行）。在此函数调用期间，调用线程将被阻塞，直到所有任务执行完毕为止。
五、注意
-------
1.本库采用threads线程库编写。使用前需确保编译器支持threads线程库，并未定义`__STDC_NO_THREADS__`宏。如果编译器不支持，则运行时会出错
2.本库不支持POSIX的线程操作，如需在线程执行函数中进行上锁等操作，必须使用threads线程库
3.本库的执行函数在运行时不会上锁，因此需要注意并发时多线程访问一块地址的问题。
4.使用未经初始化或已删除的线程池，可能会导致段错误。
六、配套文件
-------
本库的头文件为`thrd_pool.h`，动态库为`libthpool.so`. 此外，还有`README.md`作为本库的操作文档。
七、举例
-------
以下代码展示了本库的基本操作：
```c
#include "thrd_pool.h"
#include <stdio.h>
#include <unistd.h>
void t1(void *arg){
sleep(1);
printf("%s", (char *)arg);
return;
}
int main(void){
thrd_pool_t *tp;
int err = thrd_pool_init(&tp, 4);
printf("thrd_pool_init: %d\n", err);
err = thrd_pool_add_task(tp, t1, (void *)"Hello World\n");
printf("thrd_pool_add_task: %d\n", err);
thrd_pool_wait(tp);
err = thrd_pool_delete(tp);
printf("thrd_pool_delete: %d\n", err);
return 0;
}
```
八、建议
-------
由于部分系统中的gcc无法编译threads库，以及这个库本身鲜有人知，这里附上我写的介绍threads库的文章：
<https://blog.csdn.net/wozuishuai_/article/details/134907960>
