1 /* 2 * Copyright (c) Meta Platforms, Inc. and affiliates. 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) 15 extern "C" { 16 #endif 17 18 19 #include "zstd_deps.h" 20 #define ZSTD_STATIC_LINKING_ONLY /* ZSTD_customMem */ 21 #include "../zstd.h" 22 23 typedef 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 */ 31 POOL_ctx* POOL_create(size_t numThreads, size_t queueSize); 32 33 POOL_ctx* POOL_create_advanced(size_t numThreads, size_t queueSize, 34 ZSTD_customMem customMem); 35 36 /*! POOL_free() : 37 * Free a thread pool returned by POOL_create(). 38 */ 39 void POOL_free(POOL_ctx* ctx); 40 41 42 /*! POOL_joinJobs() : 43 * Waits for all queued jobs to finish executing. 44 */ 45 void POOL_joinJobs(POOL_ctx* ctx); 46 47 /*! POOL_resize() : 48 * Expands or shrinks pool's number of threads. 49 * This is more efficient than releasing + creating a new context, 50 * since it tries to preserve and reuse existing threads. 51 * `numThreads` must be at least 1. 52 * @return : 0 when resize was successful, 53 * !0 (typically 1) if there is an error. 54 * note : only numThreads can be resized, queueSize remains unchanged. 55 */ 56 int POOL_resize(POOL_ctx* ctx, size_t numThreads); 57 58 /*! POOL_sizeof() : 59 * @return threadpool memory usage 60 * note : compatible with NULL (returns 0 in this case) 61 */ 62 size_t POOL_sizeof(const POOL_ctx* ctx); 63 64 /*! POOL_function : 65 * The function type that can be added to a thread pool. 66 */ 67 typedef void (*POOL_function)(void*); 68 69 /*! POOL_add() : 70 * Add the job `function(opaque)` to the thread pool. `ctx` must be valid. 71 * Possibly blocks until there is room in the queue. 72 * Note : The function may be executed asynchronously, 73 * therefore, `opaque` must live until function has been completed. 74 */ 75 void POOL_add(POOL_ctx* ctx, POOL_function function, void* opaque); 76 77 78 /*! POOL_tryAdd() : 79 * Add the job `function(opaque)` to thread pool _if_ a queue slot is available. 80 * Returns immediately even if not (does not block). 81 * @return : 1 if successful, 0 if not. 82 */ 83 int POOL_tryAdd(POOL_ctx* ctx, POOL_function function, void* opaque); 84 85 86 #if defined (__cplusplus) 87 } 88 #endif 89 90 #endif 91