lib/compress/zstdmt_compress.h

   1 /*
   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 ZSTDMT_COMPRESS_H
  12  #define ZSTDMT_COMPRESS_H
  13
  14  #if defined (__cplusplus)
  15  extern "C" {
  16  #endif
  17
  18
  19 /* Note : This is an internal API.
  20  *        Some methods are still exposed (ZSTDLIB_API),
  21  *        because it used to be the only way to invoke MT compression.
  22  *        Now, it's recommended to use ZSTD_compress_generic() instead.
  23  *        These methods will stop being exposed in a future version */
  24
  25 /* ===   Dependencies   === */
  26 #include <stddef.h>                /* size_t */
  27 #define ZSTD_STATIC_LINKING_ONLY   /* ZSTD_parameters */
  28 #include "zstd.h"            /* ZSTD_inBuffer, ZSTD_outBuffer, ZSTDLIB_API */
  29
  30
  31 /* ===   Memory management   === */
  32 typedef struct ZSTDMT_CCtx_s ZSTDMT_CCtx;
  33 ZSTDLIB_API ZSTDMT_CCtx* ZSTDMT_createCCtx(unsigned nbWorkers);
  34 ZSTDLIB_API ZSTDMT_CCtx* ZSTDMT_createCCtx_advanced(unsigned nbWorkers,
  35                                                     ZSTD_customMem cMem);
  36 ZSTDLIB_API size_t ZSTDMT_freeCCtx(ZSTDMT_CCtx* mtctx);
  37
  38 ZSTDLIB_API size_t ZSTDMT_sizeof_CCtx(ZSTDMT_CCtx* mtctx);
  39
  40
  41 /* ===   Simple one-pass compression function   === */
  42
  43 ZSTDLIB_API size_t ZSTDMT_compressCCtx(ZSTDMT_CCtx* mtctx,
  44                                        void* dst, size_t dstCapacity,
  45                                  const void* src, size_t srcSize,
  46                                        int compressionLevel);
  47
  48
  49
  50 /* ===   Streaming functions   === */
  51
  52 ZSTDLIB_API size_t ZSTDMT_initCStream(ZSTDMT_CCtx* mtctx, int compressionLevel);
  53 ZSTDLIB_API size_t ZSTDMT_resetCStream(ZSTDMT_CCtx* mtctx, unsigned long long pledgedSrcSize);  /**< if srcSize is not known at reset time, use ZSTD_CONTENTSIZE_UNKNOWN. Note: for compatibility with older programs, 0 means the same as ZSTD_CONTENTSIZE_UNKNOWN, but it will change in the future to mean "empty" */
  54
  55 ZSTDLIB_API size_t ZSTDMT_compressStream(ZSTDMT_CCtx* mtctx, ZSTD_outBuffer* output, ZSTD_inBuffer* input);
  56
  57 ZSTDLIB_API size_t ZSTDMT_flushStream(ZSTDMT_CCtx* mtctx, ZSTD_outBuffer* output);   /**< @return : 0 == all flushed; >0 : still some data to be flushed; or an error code (ZSTD_isError()) */
  58 ZSTDLIB_API size_t ZSTDMT_endStream(ZSTDMT_CCtx* mtctx, ZSTD_outBuffer* output);     /**< @return : 0 == all flushed; >0 : still some data to be flushed; or an error code (ZSTD_isError()) */
  59
  60
  61 /* ===   Advanced functions and parameters  === */
  62
  63 #ifndef ZSTDMT_JOBSIZE_MIN
  64 #  define ZSTDMT_JOBSIZE_MIN (1U << 20)   /* 1 MB - Minimum size of each compression job */
  65 #endif
  66
  67 ZSTDLIB_API size_t ZSTDMT_compress_advanced(ZSTDMT_CCtx* mtctx,
  68                                            void* dst, size_t dstCapacity,
  69                                      const void* src, size_t srcSize,
  70                                      const ZSTD_CDict* cdict,
  71                                            ZSTD_parameters params,
  72                                            unsigned overlapLog);
  73
  74 ZSTDLIB_API size_t ZSTDMT_initCStream_advanced(ZSTDMT_CCtx* mtctx,
  75                                         const void* dict, size_t dictSize,   /* dict can be released after init, a local copy is preserved within zcs */
  76                                         ZSTD_parameters params,
  77                                         unsigned long long pledgedSrcSize);  /* pledgedSrcSize is optional and can be zero == unknown */
  78
  79 ZSTDLIB_API size_t ZSTDMT_initCStream_usingCDict(ZSTDMT_CCtx* mtctx,
  80                                         const ZSTD_CDict* cdict,
  81                                         ZSTD_frameParameters fparams,
  82                                         unsigned long long pledgedSrcSize);  /* note : zero means empty */
  83
  84 /* ZSTDMT_parameter :
  85  * List of parameters that can be set using ZSTDMT_setMTCtxParameter() */
  86 typedef enum {
  87     ZSTDMT_p_jobSize,           /* Each job is compressed in parallel. By default, this value is dynamically determined depending on compression parameters. Can be set explicitly here. */
  88     ZSTDMT_p_overlapSectionLog  /* Each job may reload a part of previous job to enhance compressionr ratio; 0 == no overlap, 6(default) == use 1/8th of window, >=9 == use full window. This is a "sticky" parameter : its value will be re-used on next compression job */
  89 } ZSTDMT_parameter;
  90
  91 /* ZSTDMT_setMTCtxParameter() :
  92  * allow setting individual parameters, one at a time, among a list of enums defined in ZSTDMT_parameter.
  93  * The function must be called typically after ZSTD_createCCtx() but __before ZSTDMT_init*() !__
  94  * Parameters not explicitly reset by ZSTDMT_init*() remain the same in consecutive compression sessions.
  95  * @return : 0, or an error code (which can be tested using ZSTD_isError()) */
  96 ZSTDLIB_API size_t ZSTDMT_setMTCtxParameter(ZSTDMT_CCtx* mtctx, ZSTDMT_parameter parameter, unsigned value);
  97
  98 /* ZSTDMT_getMTCtxParameter() :
  99  * Query the ZSTDMT_CCtx for a parameter value.
 100  * @return : 0, or an error code (which can be tested using ZSTD_isError()) */
 101 ZSTDLIB_API size_t ZSTDMT_getMTCtxParameter(ZSTDMT_CCtx* mtctx, ZSTDMT_parameter parameter, unsigned* value);
 102
 103
 104 /*! ZSTDMT_compressStream_generic() :
 105  *  Combines ZSTDMT_compressStream() with optional ZSTDMT_flushStream() or ZSTDMT_endStream()
 106  *  depending on flush directive.
 107  * @return : minimum amount of data still to be flushed
 108  *           0 if fully flushed
 109  *           or an error code
 110  *  note : needs to be init using any ZSTD_initCStream*() variant */
 111 ZSTDLIB_API size_t ZSTDMT_compressStream_generic(ZSTDMT_CCtx* mtctx,
 112                                                 ZSTD_outBuffer* output,
 113                                                 ZSTD_inBuffer* input,
 114                                                 ZSTD_EndDirective endOp);
 115
 116
 117 /* ========================================================
 118  * ===  Private interface, for use by ZSTD_compress.c   ===
 119  * ===  Not exposed in libzstd. Never invoke directly   ===
 120  * ======================================================== */
 121
 122  /*! ZSTDMT_toFlushNow()
 123   *  Tell how many bytes are ready to be flushed immediately.
 124   *  Probe the oldest active job (not yet entirely flushed) and check its output buffer.
 125   *  If return 0, it means there is no active job,
 126   *  or, it means oldest job is still active, but everything produced has been flushed so far,
 127   *  therefore flushing is limited by speed of oldest job. */
 128 size_t ZSTDMT_toFlushNow(ZSTDMT_CCtx* mtctx);
 129
 130 /*! ZSTDMT_CCtxParam_setMTCtxParameter()
 131  *  like ZSTDMT_setMTCtxParameter(), but into a ZSTD_CCtx_Params */
 132 size_t ZSTDMT_CCtxParam_setMTCtxParameter(ZSTD_CCtx_params* params, ZSTDMT_parameter parameter, unsigned value);
 133
 134 /*! ZSTDMT_CCtxParam_setNbWorkers()
 135  *  Set nbWorkers, and clamp it.
 136  *  Also reset jobSize and overlapLog */
 137 size_t ZSTDMT_CCtxParam_setNbWorkers(ZSTD_CCtx_params* params, unsigned nbWorkers);
 138
 139 /*! ZSTDMT_updateCParams_whileCompressing() :
 140  *  Updates only a selected set of compression parameters, to remain compatible with current frame.
 141  *  New parameters will be applied to next compression job. */
 142 void ZSTDMT_updateCParams_whileCompressing(ZSTDMT_CCtx* mtctx, const ZSTD_CCtx_params* cctxParams);
 143
 144 /*! ZSTDMT_getFrameProgression():
 145  *  tells how much data has been consumed (input) and produced (output) for current frame.
 146  *  able to count progression inside worker threads.
 147  */
 148 ZSTD_frameProgression ZSTDMT_getFrameProgression(ZSTDMT_CCtx* mtctx);
 149
 150
 151 /*! ZSTDMT_initCStream_internal() :
 152  *  Private use only. Init streaming operation.
 153  *  expects params to be valid.
 154  *  must receive dict, or cdict, or none, but not both.
 155  *  @return : 0, or an error code */
 156 size_t ZSTDMT_initCStream_internal(ZSTDMT_CCtx* zcs,
 157                     const void* dict, size_t dictSize, ZSTD_dictContentType_e dictContentType,
 158                     const ZSTD_CDict* cdict,
 159                     ZSTD_CCtx_params params, unsigned long long pledgedSrcSize);
 160
 161
 162 #if defined (__cplusplus)
 163 }
 164 #endif
 165
 166 #endif   /* ZSTDMT_COMPRESS_H */