blob: 458d37f13c3e805d0705871d6f762c6bf4a5263d [file] [log] [blame]
Scott Bakere7144bc2019-10-01 14:16:47 -07001/*
2 * Copyright (c) 2016-present, Yann Collet, Facebook, Inc.
3 * All rights reserved.
4 *
5 * This source code is licensed under both the BSD-style license (found in the
6 * LICENSE file in the root directory of this source tree) and the GPLv2 (found
7 * in the COPYING file in the root directory of this source tree).
8 * You may select, at your option, one of the above-listed licenses.
9 */
10
11#ifndef POOL_H
12#define POOL_H
13
14#if defined (__cplusplus)
15extern "C" {
16#endif
17
18
19#include <stddef.h> /* size_t */
20#define ZSTD_STATIC_LINKING_ONLY /* ZSTD_customMem */
21#include "zstd.h"
22
23typedef struct POOL_ctx_s POOL_ctx;
24
25/*! POOL_create() :
26 * Create a thread pool with at most `numThreads` threads.
27 * `numThreads` must be at least 1.
28 * The maximum number of queued jobs before blocking is `queueSize`.
29 * @return : POOL_ctx pointer on success, else NULL.
30*/
31POOL_ctx* POOL_create(size_t numThreads, size_t queueSize);
32
Scott Bakerf579f132019-10-24 14:31:41 -070033POOL_ctx* POOL_create_advanced(size_t numThreads, size_t queueSize,
34 ZSTD_customMem customMem);
Scott Bakere7144bc2019-10-01 14:16:47 -070035
36/*! POOL_free() :
Scott Bakerf579f132019-10-24 14:31:41 -070037 * Free a thread pool returned by POOL_create().
38 */
Scott Bakere7144bc2019-10-01 14:16:47 -070039void POOL_free(POOL_ctx* ctx);
40
Scott Bakerf579f132019-10-24 14:31:41 -070041/*! POOL_resize() :
42 * Expands or shrinks pool's number of threads.
43 * This is more efficient than releasing + creating a new context,
44 * since it tries to preserve and re-use existing threads.
45 * `numThreads` must be at least 1.
46 * @return : 0 when resize was successful,
47 * !0 (typically 1) if there is an error.
48 * note : only numThreads can be resized, queueSize remains unchanged.
49 */
50int POOL_resize(POOL_ctx* ctx, size_t numThreads);
51
Scott Bakere7144bc2019-10-01 14:16:47 -070052/*! POOL_sizeof() :
Scott Bakerf579f132019-10-24 14:31:41 -070053 * @return threadpool memory usage
54 * note : compatible with NULL (returns 0 in this case)
55 */
Scott Bakere7144bc2019-10-01 14:16:47 -070056size_t POOL_sizeof(POOL_ctx* ctx);
57
58/*! POOL_function :
Scott Bakerf579f132019-10-24 14:31:41 -070059 * The function type that can be added to a thread pool.
60 */
Scott Bakere7144bc2019-10-01 14:16:47 -070061typedef void (*POOL_function)(void*);
Scott Bakere7144bc2019-10-01 14:16:47 -070062
63/*! POOL_add() :
Scott Bakerf579f132019-10-24 14:31:41 -070064 * Add the job `function(opaque)` to the thread pool. `ctx` must be valid.
65 * Possibly blocks until there is room in the queue.
66 * Note : The function may be executed asynchronously,
67 * therefore, `opaque` must live until function has been completed.
68 */
Scott Bakere7144bc2019-10-01 14:16:47 -070069void POOL_add(POOL_ctx* ctx, POOL_function function, void* opaque);
70
71
72/*! POOL_tryAdd() :
Scott Bakerf579f132019-10-24 14:31:41 -070073 * Add the job `function(opaque)` to thread pool _if_ a worker is available.
74 * Returns immediately even if not (does not block).
75 * @return : 1 if successful, 0 if not.
76 */
Scott Bakere7144bc2019-10-01 14:16:47 -070077int POOL_tryAdd(POOL_ctx* ctx, POOL_function function, void* opaque);
78
79
80#if defined (__cplusplus)
81}
82#endif
83
84#endif