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
94
95
96
97
98
99
100
101
102
103
104
105
106
#ifndef HEADER_CURL_THRDPOOL_H
#define HEADER_CURL_THRDPOOL_H
/***************************************************************************
* _ _ ____ _
* Project ___| | | | _ \| |
* / __| | | | |_) | |
* | (__| |_| | _ <| |___
* \___|\___/|_| \_\_____|
*
* Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
*
* This software is licensed as described in the file COPYING, which
* you should have received as part of this distribution. The terms
* are also available at https://curl.se/docs/copyright.html.
*
* You may opt to use, copy, modify, merge, publish, distribute and/or sell
* copies of the Software, and permit persons to whom the Software is
* furnished to do so, under the terms of the COPYING file.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
* SPDX-License-Identifier: curl
*
***************************************************************************/
#include "curl_setup.h"
#include "curlx/timediff.h"
#ifdef USE_THREADS
struct curl_thrdpool;
struct Curl_easy;
/* Invoked under thread pool lock to get an "item" to work on. Must
* return NULL if there is nothing to do.
* Caller might return a descriptive string about the "item", where
* available. The string needs to have the same lifetime as the
* item itself. */
typedef void *Curl_thrdpool_take_item_cb(void *user_data,
const char **pdescription,
timediff_t *ptimeout_ms);
/* Invoked outside thread pool lock to process the item taken. */
typedef void Curl_thrdpool_process_item_cb(void *item);
/* Invoked under thread pool lock to return a processed item back
* to the producer.
* If the thread pool has been destroyed, `user_data` will be NULL
* and the callback is responsible to release all `item` resources. */
typedef void Curl_thrdpool_return_item_cb(void *item, void *user_data);
/* Create a new thread pool.
* @param name name of pool for tracing purposes
* @param min_threads minimum number of threads to have always running
* @param max_threads maximum number of threads running, ever.
* @param idle_time_ms maximum time a thread should wait for tasks to
* process before shutting down (unless the pool is
* already at minimum thread count), use 0 for
* infinite wait.
* @param fn_take take the next item to process
* @param fn_process process the item taken
* @param fn_return return the processed item
* @param user_data parameter passed to take/return callbacks
*/
CURLcode Curl_thrdpool_create(struct curl_thrdpool **ptpool,
const char *name,
uint32_t min_threads,
uint32_t max_threads,
uint32_t idle_time_ms,
Curl_thrdpool_take_item_cb *fn_take,
Curl_thrdpool_process_item_cb *fn_process,
Curl_thrdpool_return_item_cb *fn_return,
void *user_data);
/* Destroy the thread pool, release its resources.
* With `join` being TRUE, the call will wait for all threads to finish
* processing before returning. On FALSE, it will detach all threads
* running. Ongoing item processing will continue to run and
* `fn_return` will be invoked with NULL user_data before the thread exits.
*/
void Curl_thrdpool_destroy(struct curl_thrdpool *tpool, bool join);
/* Signal the pool to wake up `nthreads` idle worker threads, possible
* creating new threads up to the max limit. The number should reflect
* the items that can actually be taken for processing right away, e.g.
* the producers "queue" length of outstanding items.
*/
CURLcode Curl_thrdpool_signal(struct curl_thrdpool *tpool, uint32_t nthreads);
CURLcode Curl_thrdpool_await_idle(struct curl_thrdpool *tpool,
uint32_t timeout_ms);
/* Change the properties of a threadpool. */
CURLcode Curl_thrdpool_set_props(struct curl_thrdpool *tpool,
uint32_t min_threads,
uint32_t max_threads,
uint32_t idle_time_ms);
#ifdef CURLVERBOSE
void Curl_thrdpool_trace(struct curl_thrdpool *tpool,
struct Curl_easy *data);
#endif
#endif /* USE_THREADS */
#endif /* HEADER_CURL_THRDPOOL_H */