1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374 |
- /*
- * Copyright (c) 2016-present, Yann Collet, Facebook, Inc.
- * All rights reserved.
- *
- * This source code is licensed under both the BSD-style license (found in the
- * LICENSE file in the root directory of this source tree) and the GPLv2 (found
- * in the COPYING file in the root directory of this source tree).
- * You may select, at your option, one of the above-listed licenses.
- */
- #ifndef POOL_H
- #define POOL_H
- #if defined (__cplusplus)
- extern "C" {
- #endif
- #include <stddef.h> /* size_t */
- #define ZSTD_STATIC_LINKING_ONLY /* ZSTD_customMem */
- #include "zstd.h"
- typedef struct POOL_ctx_s POOL_ctx;
- /*! POOL_create() :
- * Create a thread pool with at most `numThreads` threads.
- * `numThreads` must be at least 1.
- * The maximum number of queued jobs before blocking is `queueSize`.
- * @return : POOL_ctx pointer on success, else NULL.
- */
- POOL_ctx* POOL_create(size_t numThreads, size_t queueSize);
- POOL_ctx* POOL_create_advanced(size_t numThreads, size_t queueSize, ZSTD_customMem customMem);
- /*! POOL_free() :
- Free a thread pool returned by POOL_create().
- */
- void POOL_free(POOL_ctx* ctx);
- /*! POOL_sizeof() :
- return memory usage of pool returned by POOL_create().
- */
- size_t POOL_sizeof(POOL_ctx* ctx);
- /*! POOL_function :
- The function type that can be added to a thread pool.
- */
- typedef void (*POOL_function)(void*);
- /*! POOL_add_function :
- The function type for a generic thread pool add function.
- */
- typedef void (*POOL_add_function)(void*, POOL_function, void*);
- /*! POOL_add() :
- Add the job `function(opaque)` to the thread pool. `ctx` must be valid.
- Possibly blocks until there is room in the queue.
- Note : The function may be executed asynchronously, so `opaque` must live until the function has been completed.
- */
- void POOL_add(POOL_ctx* ctx, POOL_function function, void* opaque);
- /*! POOL_tryAdd() :
- Add the job `function(opaque)` to the thread pool if a worker is available.
- return immediately otherwise.
- @return : 1 if successful, 0 if not.
- */
- int POOL_tryAdd(POOL_ctx* ctx, POOL_function function, void* opaque);
- #if defined (__cplusplus)
- }
- #endif
- #endif
|