mirror of
https://github.com/curl/curl.git
synced 2026-04-11 12:01:42 +08:00
6f9f4b3cb7
- new source files for thread pool and queue - test cases 3217 and 3218 for them - internal documentation Closes #20916
103 lines
4.3 KiB
C
103 lines
4.3 KiB
C
#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;
|
|
struct curl_trc_feat;
|
|
|
|
/* 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);
|
|
|
|
#ifdef CURLVERBOSE
|
|
void Curl_thrdpool_trace(struct curl_thrdpool *tpool,
|
|
struct Curl_easy *data,
|
|
struct curl_trc_feat *feat);
|
|
#endif
|
|
|
|
#endif /* USE_THREADS */
|
|
|
|
#endif /* HEADER_CURL_THRDPOOL_H */
|