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