ddidderr
a15bf1d375
The multithreaded compressor already uses Rust-owned buffer and CCtx pools, but zstdmt_compress.c still allocated and freed its job table directly. Move the raw table storage and power-of-two sizing behind Rust's custom allocator ABI. Keep descriptor field access and platform mutex/condition initialization in C because those layouts remain private and platform-specific. The C wrapper initializes and destroys synchronization primitives around the Rust storage calls, preserving failure cleanup while leaving worker job setup, scheduling, and stream entry points in C as the fallback implementation. Keep the Rust storage-only ABI free of MT-only C references so single-threaded archives can omit zstdmt_compress.c without acquiring new unresolved symbols. Test Plan: - `cargo test --manifest-path rust/Cargo.toml --no-default-features --features compression zstdmt_compress --lib` -- passed (5 tests). - `make -B -C lib lib-mt` -- passed. - `make -B -C tests -j2 fullbench zstreamtest poolTests` -- passed. - `./poolTests` -- passed. - `./fullbench -i1 -B1000 README.md` -- passed, including -T2 scenarios. - Rebuilt `programs/zstd` and ran a `-T2` compress/decompress `cmp` round-trip -- passed. - `rustfmt` and `cargo +nightly fmt --manifest-path rust/Cargo.toml --all -- --check` -- passed. - Full `cargo clippy -D warnings` remains blocked by unrelated warnings in the concurrent `rust/src/fileio_asyncio.rs` worktree changes. - `./zstreamtest -T5s` reaches an unrelated single-thread maxBlockSize assertion at `tests/zstreamtest.c:2157`; MT fullbench and CLI smoke pass.
114 lines
5.1 KiB
C
114 lines
5.1 KiB
C
/*
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
* 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 ZSTDMT_COMPRESS_H
|
|
#define ZSTDMT_COMPRESS_H
|
|
|
|
/* === Dependencies === */
|
|
#include "../common/zstd_deps.h" /* size_t */
|
|
#define ZSTD_STATIC_LINKING_ONLY /* ZSTD_parameters */
|
|
#include "../zstd.h" /* ZSTD_inBuffer, ZSTD_outBuffer, ZSTDLIB_API */
|
|
|
|
/* Note : This is an internal API.
|
|
* These APIs used to be exposed with ZSTDLIB_API,
|
|
* because it used to be the only way to invoke MT compression.
|
|
* Now, you must use ZSTD_compress2 and ZSTD_compressStream2() instead.
|
|
*
|
|
* This API requires ZSTD_MULTITHREAD to be defined during compilation,
|
|
* otherwise ZSTDMT_createCCtx*() will fail.
|
|
*/
|
|
|
|
/* === Constants === */
|
|
#ifndef ZSTDMT_NBWORKERS_MAX /* a different value can be selected at compile time */
|
|
# define ZSTDMT_NBWORKERS_MAX ((sizeof(void*)==4) /*32-bit*/ ? 64 : 256)
|
|
#endif
|
|
#ifndef ZSTDMT_JOBSIZE_MIN /* a different value can be selected at compile time */
|
|
# define ZSTDMT_JOBSIZE_MIN (512 KB)
|
|
#endif
|
|
#define ZSTDMT_JOBLOG_MAX (MEM_32bits() ? 29 : 30)
|
|
#define ZSTDMT_JOBSIZE_MAX (MEM_32bits() ? (512 MB) : (1024 MB))
|
|
|
|
|
|
/* ========================================================
|
|
* === Private interface, for use by ZSTD_compress.c ===
|
|
* === Not exposed in libzstd. Never invoke directly ===
|
|
* ======================================================== */
|
|
|
|
/* === Memory management === */
|
|
typedef struct ZSTDMT_CCtx_s ZSTDMT_CCtx;
|
|
|
|
/* The Rust adapter owns job-table storage and custom allocator cleanup. The
|
|
* descriptor layout and platform synchronization primitives remain in C, so
|
|
* these callbacks are the explicit C fallback seam for job initialization. */
|
|
void* ZSTDMT_rust_job_table_create(unsigned* nbJobsPtr, size_t jobSize,
|
|
ZSTD_customMem cMem);
|
|
void ZSTDMT_rust_job_table_free(void* jobTable, unsigned nbJobs,
|
|
size_t jobSize, ZSTD_customMem cMem);
|
|
int ZSTDMT_job_table_init_sync(void* jobTable, unsigned nbJobs, size_t jobSize);
|
|
void ZSTDMT_job_table_destroy_sync(void* jobTable, unsigned nbJobs, size_t jobSize);
|
|
|
|
/* Requires ZSTD_MULTITHREAD to be defined during compilation, otherwise it will return NULL. */
|
|
ZSTDMT_CCtx* ZSTDMT_createCCtx_advanced(unsigned nbWorkers,
|
|
ZSTD_customMem cMem,
|
|
ZSTD_threadPool *pool);
|
|
size_t ZSTDMT_freeCCtx(ZSTDMT_CCtx* mtctx);
|
|
|
|
size_t ZSTDMT_sizeof_CCtx(ZSTDMT_CCtx* mtctx);
|
|
|
|
/* === Streaming functions === */
|
|
|
|
size_t ZSTDMT_nextInputSizeHint(const ZSTDMT_CCtx* mtctx);
|
|
|
|
/*! ZSTDMT_initCStream_internal() :
|
|
* Private use only. Init streaming operation.
|
|
* expects params to be valid.
|
|
* must receive dict, or cdict, or none, but not both.
|
|
* mtctx can be freshly constructed or reused from a prior compression.
|
|
* If mtctx is reused, memory allocations from the prior compression may not be freed,
|
|
* even if they are not needed for the current compression.
|
|
* @return : 0, or an error code */
|
|
size_t ZSTDMT_initCStream_internal(ZSTDMT_CCtx* mtctx,
|
|
const void* dict, size_t dictSize, ZSTD_dictContentType_e dictContentType,
|
|
const ZSTD_CDict* cdict,
|
|
ZSTD_CCtx_params params, unsigned long long pledgedSrcSize);
|
|
|
|
/*! ZSTDMT_compressStream_generic() :
|
|
* Combines ZSTDMT_compressStream() with optional ZSTDMT_flushStream() or ZSTDMT_endStream()
|
|
* depending on flush directive.
|
|
* @return : minimum amount of data still to be flushed
|
|
* 0 if fully flushed
|
|
* or an error code
|
|
* note : needs to be init using any ZSTD_initCStream*() variant */
|
|
size_t ZSTDMT_compressStream_generic(ZSTDMT_CCtx* mtctx,
|
|
ZSTD_outBuffer* output,
|
|
ZSTD_inBuffer* input,
|
|
ZSTD_EndDirective endOp);
|
|
|
|
/*! ZSTDMT_toFlushNow()
|
|
* Tell how many bytes are ready to be flushed immediately.
|
|
* Probe the oldest active job (not yet entirely flushed) and check its output buffer.
|
|
* If return 0, it means there is no active job,
|
|
* or, it means oldest job is still active, but everything produced has been flushed so far,
|
|
* therefore flushing is limited by speed of oldest job. */
|
|
size_t ZSTDMT_toFlushNow(ZSTDMT_CCtx* mtctx);
|
|
|
|
/*! ZSTDMT_updateCParams_whileCompressing() :
|
|
* Updates only a selected set of compression parameters, to remain compatible with current frame.
|
|
* New parameters will be applied to next compression job. */
|
|
void ZSTDMT_updateCParams_whileCompressing(ZSTDMT_CCtx* mtctx, const ZSTD_CCtx_params* cctxParams);
|
|
|
|
/*! ZSTDMT_getFrameProgression():
|
|
* tells how much data has been consumed (input) and produced (output) for current frame.
|
|
* able to count progression inside worker threads.
|
|
*/
|
|
ZSTD_frameProgression ZSTDMT_getFrameProgression(ZSTDMT_CCtx* mtctx);
|
|
|
|
#endif /* ZSTDMT_COMPRESS_H */
|