blob: f843ea7f20b04c58068b3ee8bfce54a8d943cb89 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
/* Copyright (C) 2021 CZ.NIC, z.s.p.o. <knot-dns@labs.nic.cz>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
#pragma once
#include <stdbool.h>
#include "knot/worker/queue.h"
struct worker_pool;
typedef struct worker_pool worker_pool_t;
typedef void(*wait_callback_t)(worker_pool_t *);
/*!
* \brief Initialize worker pool.
*
* \param threads Number of threads to be created.
*
* \return Thread pool or NULL in case of error.
*/
worker_pool_t *worker_pool_create(unsigned threads);
/*!
* \brief Destroy the worker pool.
*/
void worker_pool_destroy(worker_pool_t *pool);
/*!
* \brief Start all threads in the worker pool.
*/
void worker_pool_start(worker_pool_t *pool);
/*!
* \brief Stop processing of new tasks, start stopping worker threads when possible.
*/
void worker_pool_stop(worker_pool_t *pool);
/*!
* \brief Temporarily suspend the execution of worker pool.
*/
void worker_pool_suspend(worker_pool_t *pool);
/*!
* \brief Resume the execution of worker pool.
*/
void worker_pool_resume(worker_pool_t *pool);
/*!
* \brief Wait for all threads to terminate.
*/
void worker_pool_join(worker_pool_t *pool);
/*!
* \brief Wait till the number of pending tasks is zero.
*/
void worker_pool_wait(worker_pool_t *pool);
/*!
* \brief Wait till the number of pending tasks is zero. Callback emitted on
* thread wakeup can be specified.
*/
void worker_pool_wait_cb(worker_pool_t *pool, wait_callback_t cb);
/*!
* \brief Assign a task to be performed by a worker in the pool.
*/
void worker_pool_assign(worker_pool_t *pool, struct task *task);
/*!
* \brief Clear all tasks enqueued in pool processing queue.
*/
void worker_pool_clear(worker_pool_t *pool);
/*!
* \brief Obtain info regarding how the pool is busy.
*
* \note Locked means if the mutex `pool->lock` is locked.
*/
void worker_pool_status(worker_pool_t *pool, bool locked, int *running, int *queued);
|
