GRASS GIS 8 Programmer's Manual  8.2.2dev(2023)-3d2c704037
lz4.c File Reference
#include "lz4.h"
#include <stdlib.h>
#include <string.h>
Include dependency graph for lz4.c:

Go to the source code of this file.

Macros

#define LZ4_HEAPMODE   0
 
#define ACCELERATION_DEFAULT   1
 
#define LZ4_STATIC_LINKING_ONLY
 
#define LZ4_DISABLE_DEPRECATE_WARNINGS   /* due to LZ4_decompress_safe_withPrefix64k */
 
#define LZ4_FORCE_INLINE   static
 
#define LZ4_FORCE_O2_GCC_PPC64LE
 
#define LZ4_FORCE_O2_INLINE_GCC_PPC64LE   static
 
#define expect(expr, value)   (expr)
 
#define likely(expr)   expect((expr) != 0, 1)
 
#define unlikely(expr)   expect((expr) != 0, 0)
 
#define ALLOC(s)   malloc(s)
 
#define ALLOC_AND_ZERO(s)   calloc(1,s)
 
#define FREEMEM(p)   free(p)
 
#define MEM_INIT(p, v, s)   memset((p),(v),(s))
 
#define MINMATCH   4
 
#define WILDCOPYLENGTH   8
 
#define LASTLITERALS   5
 
#define MFLIMIT   (WILDCOPYLENGTH+MINMATCH)
 
#define KB   *(1 <<10)
 
#define MB   *(1 <<20)
 
#define GB   *(1U<<30)
 
#define MAXD_LOG   16
 
#define MAX_DISTANCE   ((1 << MAXD_LOG) - 1)
 
#define ML_BITS   4
 
#define ML_MASK   ((1U<<ML_BITS)-1)
 
#define RUN_BITS   (8-ML_BITS)
 
#define RUN_MASK   ((1U<<RUN_BITS)-1)
 
#define assert(condition)   ((void)0)
 
#define LZ4_STATIC_ASSERT(c)   { enum { LZ4_static_assert = 1/(int)(!!(c)) }; } /* use after variable declarations */
 
#define DEBUGLOG(l, ...)   {} /* disabled */
 
#define STEPSIZE   sizeof(reg_t)
 
#define HASH_UNIT   sizeof(reg_t)
 
#define LZ4_decompress_safe_extDict   LZ4_decompress_safe_forceExtDict
 

Typedefs

typedef unsigned char BYTE
 
typedef unsigned short U16
 
typedef unsigned int U32
 
typedef signed int S32
 
typedef unsigned long long U64
 
typedef size_t uptrval
 
typedef size_t reg_t
 

Enumerations

enum  limitedOutput_directive { notLimited = 0, limitedOutput = 1, fillOutput = 2 }
 
enum  tableType_t { clearedTable = 0, byPtr, byU32, byU16 }
 
enum  dict_directive { noDict = 0, withPrefix64k, usingExtDict, usingDictCtx }
 
enum  dictIssue_directive { noDictIssue = 0, dictSmall }
 
enum  endCondition_directive { endOnOutputSize = 0, endOnInputSize = 1 }
 
enum  earlyEnd_directive { full = 0, partial = 1 }
 

Functions

LZ4_FORCE_O2_INLINE_GCC_PPC64LE void LZ4_wildCopy (void *dstPtr, const void *srcPtr, void *dstEnd)
 
LZ4_FORCE_INLINE unsigned LZ4_count (const BYTE *pIn, const BYTE *pMatch, const BYTE *pInLimit)
 
int LZ4_versionNumber (void)
 
const char * LZ4_versionString (void)
 
int LZ4_compressBound (int isize)
 
int LZ4_sizeofState ()
 
LZ4_FORCE_INLINE U32 LZ4_hashPosition (const void *const p, tableType_t const tableType)
 
LZ4_FORCE_INLINE void LZ4_putPosition (const BYTE *p, void *tableBase, tableType_t tableType, const BYTE *srcBase)
 
LZ4_FORCE_INLINE const BYTELZ4_getPosition (const BYTE *p, const void *tableBase, tableType_t tableType, const BYTE *srcBase)
 
LZ4_FORCE_INLINE void LZ4_prepareTable (LZ4_stream_t_internal *const cctx, const int inputSize, const tableType_t tableType)
 
LZ4_FORCE_INLINE int LZ4_compress_generic (LZ4_stream_t_internal *const cctx, const char *const source, char *const dest, const int inputSize, int *inputConsumed, const int maxOutputSize, const limitedOutput_directive outputLimited, const tableType_t tableType, const dict_directive dictDirective, const dictIssue_directive dictIssue, const U32 acceleration)
 
int LZ4_compress_fast_extState (void *state, const char *source, char *dest, int inputSize, int maxOutputSize, int acceleration)
 
int LZ4_compress_fast_extState_fastReset (void *state, const char *src, char *dst, int srcSize, int dstCapacity, int acceleration)
 
int LZ4_compress_fast (const char *source, char *dest, int inputSize, int maxOutputSize, int acceleration)
 
int LZ4_compress_default (const char *source, char *dest, int inputSize, int maxOutputSize)
 
int LZ4_compress_fast_force (const char *source, char *dest, int inputSize, int maxOutputSize, int acceleration)
 
int LZ4_compress_destSize (const char *src, char *dst, int *srcSizePtr, int targetDstSize)
 
LZ4_stream_tLZ4_createStream (void)
 
void LZ4_resetStream (LZ4_stream_t *LZ4_stream)
 
void LZ4_resetStream_fast (LZ4_stream_t *ctx)
 
int LZ4_freeStream (LZ4_stream_t *LZ4_stream)
 
int LZ4_loadDict (LZ4_stream_t *LZ4_dict, const char *dictionary, int dictSize)
 
void LZ4_attach_dictionary (LZ4_stream_t *working_stream, const LZ4_stream_t *dictionary_stream)
 
int LZ4_compress_fast_continue (LZ4_stream_t *LZ4_stream, const char *source, char *dest, int inputSize, int maxOutputSize, int acceleration)
 
int LZ4_compress_forceExtDict (LZ4_stream_t *LZ4_dict, const char *source, char *dest, int srcSize)
 
int LZ4_saveDict (LZ4_stream_t *LZ4_dict, char *safeBuffer, int dictSize)
 
LZ4_FORCE_O2_GCC_PPC64LE LZ4_FORCE_INLINE int LZ4_decompress_generic (const char *const src, char *const dst, int srcSize, int outputSize, int endOnInput, int partialDecoding, int targetOutputSize, int dict, const BYTE *const lowPrefix, const BYTE *const dictStart, const size_t dictSize)
 
LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_safe (const char *source, char *dest, int compressedSize, int maxDecompressedSize)
 
LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_safe_partial (const char *source, char *dest, int compressedSize, int targetOutputSize, int maxDecompressedSize)
 
LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_fast (const char *source, char *dest, int originalSize)
 
LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_safe_withPrefix64k (const char *source, char *dest, int compressedSize, int maxOutputSize)
 
int LZ4_decompress_fast_withPrefix64k (const char *source, char *dest, int originalSize)
 
int LZ4_decompress_safe_extDict (const char *source, char *dest, int compressedSize, int maxOutputSize, const void *dictStart, size_t dictSize)
 
LZ4_FORCE_INLINE int LZ4_decompress_safe_doubleDict (const char *source, char *dest, int compressedSize, int maxOutputSize, size_t prefixSize, const void *dictStart, size_t dictSize)
 
LZ4_FORCE_INLINE int LZ4_decompress_fast_doubleDict (const char *source, char *dest, int originalSize, size_t prefixSize, const void *dictStart, size_t dictSize)
 
LZ4_streamDecode_tLZ4_createStreamDecode (void)
 
int LZ4_freeStreamDecode (LZ4_streamDecode_t *LZ4_stream)
 
int LZ4_setStreamDecode (LZ4_streamDecode_t *LZ4_streamDecode, const char *dictionary, int dictSize)
 
int LZ4_decoderRingBufferSize (int maxBlockSize)
 
LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_safe_continue (LZ4_streamDecode_t *LZ4_streamDecode, const char *source, char *dest, int compressedSize, int maxOutputSize)
 
LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_fast_continue (LZ4_streamDecode_t *LZ4_streamDecode, const char *source, char *dest, int originalSize)
 
int LZ4_decompress_safe_usingDict (const char *source, char *dest, int compressedSize, int maxOutputSize, const char *dictStart, int dictSize)
 
int LZ4_decompress_fast_usingDict (const char *source, char *dest, int originalSize, const char *dictStart, int dictSize)
 
int LZ4_compress_limitedOutput (const char *source, char *dest, int inputSize, int maxOutputSize)
 
int LZ4_compress (const char *source, char *dest, int inputSize)
 
int LZ4_compress_limitedOutput_withState (void *state, const char *src, char *dst, int srcSize, int dstSize)
 
int LZ4_compress_withState (void *state, const char *src, char *dst, int srcSize)
 
int LZ4_compress_limitedOutput_continue (LZ4_stream_t *LZ4_stream, const char *src, char *dst, int srcSize, int dstCapacity)
 
int LZ4_compress_continue (LZ4_stream_t *LZ4_stream, const char *source, char *dest, int inputSize)
 
int LZ4_uncompress (const char *source, char *dest, int outputSize)
 
int LZ4_uncompress_unknownOutputSize (const char *source, char *dest, int isize, int maxOutputSize)
 
int LZ4_sizeofStreamState ()
 
int LZ4_resetStreamState (void *state, char *inputBuffer)
 
void * LZ4_create (char *inputBuffer)
 
char * LZ4_slideInputBuffer (void *state)
 

Macro Definition Documentation

◆ ACCELERATION_DEFAULT

#define ACCELERATION_DEFAULT   1

Definition at line 52 of file lz4.c.

Referenced by LZ4_compress_fast_extState().

◆ ALLOC

#define ALLOC (   s)    malloc(s)

Definition at line 165 of file lz4.c.

Referenced by LZ4_compress_fast(), and LZ4_createStream().

◆ ALLOC_AND_ZERO

#define ALLOC_AND_ZERO (   s)    calloc(1,s)

Definition at line 166 of file lz4.c.

Referenced by LZ4_createStreamDecode().

◆ assert

#define assert (   condition)    ((void)0)

Definition at line 324 of file lz4.c.

Referenced by ReplacementHeap< T, Compare >::addRun(), ReplacementHeapBlock< T, Compare >::addRun(), ami_single_temp_name(), avl_assert_delete(), avl_destroy(), avl_find(), avl_free(), avl_malloc(), avl_probe(), avl_t_cur(), avl_t_find(), avl_t_first(), avl_t_insert(), avl_t_last(), avl_t_next(), avl_t_prev(), avl_t_replace(), em_buffer< T, Key >::cleanup(), pqheap_t1< T >::delete_min_and_insert(), em_pqueue< T, Key >::delete_str_elt(), ReplacementHeap< T, Compare >::deleteRun(), ReplacementHeapBlock< T, Compare >::deleteRun(), BasicMinMaxHeap< T >::destructiveVerify(), em_buffer< T, Key >::em_buffer(), em_pqueue< T, Key >::em_pqueue(), em_pqueue< T, Key >::empty_buff(), em_pqueue< T, Key >::empty_buff_0(), MM_register::enforce_memory_limit(), queue< T >::enqueue(), BasicMinMaxHeap< T >::extract_max(), ReplacementHeap< T, Compare >::extract_min(), ReplacementHeapBlock< T, Compare >::extract_min(), BasicMinMaxHeap< T >::extract_min(), em_pqueue< T, Key >::extract_min(), MinMaxHeap< T >::fill(), em_pqueue< T, Key >::fillpq(), BasicMinMaxHeap< T >::get(), im_buffer< T >::get_item(), em_buffer< T, Key >::get_stream(), em_buffer< T, Key >::get_streams(), MinMaxHeap< T >::grow(), UnboundedMinMaxHeap< T >::grow(), im_buffer< T >::im_buffer(), em_buffer< T, Key >::incr_deleted(), ReplacementHeap< T, Compare >::init(), ReplacementHeapBlock< T, Compare >::init(), EMPQueueAdaptive< T, Key >::insert(), im_buffer< T >::insert(), em_pqueue< T, Key >::insert(), em_buffer< T, Key >::insert(), EMPQueueAdaptive< T, Key >::is_empty(), EMPQueueAdaptive< T, Key >::is_full(), LZ4_decompress_fast_continue(), LZ4_decompress_safe_continue(), EMPQueueAdaptive< T, Key >::makeExternal(), EMPQueueAdaptive< T, Key >::makeExternalDebug(), BasicMinMaxHeap< T >::max(), EMPQueueAdaptive< T, Key >::maxlen(), em_pqueue< T, Key >::merge_buffer(), em_pqueue< T, Key >::merge_bufs2pq(), em_pqueue< T, Key >::merge_streams(), BasicMinMaxHeap< T >::min(), pqheap_t1< T >::min(), em_pqueue< T, Key >::min(), MM_register::MM_register(), AMI_STREAM< T >::new_substream(), open_stream(), MM_register::operator delete(), MM_register::operator delete[](), pqheap_t1< T >::pqheap_t1(), em_buffer< T, Key >::print(), im_buffer< T >::print_range(), em_buffer< T, Key >::print_range(), em_pqueue< T, Key >::print_size(), em_buffer< T, Key >::put_stream(), em_buffer< T, Key >::put_streams(), rbtree_create(), rbtree_init_trav(), rbtree_traverse(), rbtree_traverse_backwd(), MEM_STREAM< T >::read_item(), AMI_STREAM< T >::read_item(), MM_register::register_deallocation(), ReplacementHeap< T, Compare >::ReplacementHeap(), ReplacementHeapBlock< T, Compare >::ReplacementHeapBlock(), BasicMinMaxHeap< T >::reset(), im_buffer< T >::reset(), em_buffer< T, Key >::reset(), rtree_search(), RTreeAddNodePos(), RTreeAllocBoundary(), RTreeAllocNode(), RTreeAllocRect(), RTreeCopyNode(), RTreeDeleteRect(), RTreeDestroyTree(), RTreeDisconnectBranch(), RTreeFreeBoundary(), RTreeFreeNode(), RTreeFreeRect(), RTreeInsertRect(), RTreeNodeChanged(), RTreePickBranch(), RTreeRectVolume(), RTreeSearch(), RTreeSearch2(), RTreeSetRect4D(), im_buffer< T >::save2str(), MEM_STREAM< T >::seek(), AMI_STREAM< T >::seek(), pqheap_t1< T >::set(), im_buffer< T >::set_item(), MM_register::set_memory_limit(), im_buffer< T >::shift_left(), SHPSetFastModeReadObject(), SHPWriteObject(), EMPQueueAdaptive< T, Key >::size(), BasicMinMaxHeap< T >::size(), im_buffer< T >::sort(), em_buffer< T, Key >::sort(), AMI_STREAM< T >::stream_len(), tavl_assert_delete(), tavl_copy(), tavl_find(), tavl_free(), tavl_malloc(), tavl_probe(), tavl_t_cur(), tavl_t_find(), tavl_t_first(), tavl_t_insert(), tavl_t_last(), tavl_t_next(), tavl_t_prev(), tavl_t_replace(), MEM_STREAM< T >::write_item(), AMI_STREAM< T >::write_item(), AMI_STREAM< T >::~AMI_STREAM(), em_buffer< T, Key >::~em_buffer(), and MM_register::~MM_register().

◆ DEBUGLOG

#define DEBUGLOG (   l,
  ... 
)    {} /* disabled */

◆ expect

#define expect (   expr,
  value 
)    (expr)

Definition at line 150 of file lz4.c.

◆ FREEMEM

#define FREEMEM (   p)    free(p)

Definition at line 167 of file lz4.c.

Referenced by LZ4_compress_fast(), LZ4_freeStream(), and LZ4_freeStreamDecode().

◆ GB

#define GB   *(1U<<30)

Definition at line 306 of file lz4.c.

Referenced by LZ4_prepareTable().

◆ HASH_UNIT

#define HASH_UNIT   sizeof(reg_t)

Definition at line 1176 of file lz4.c.

Referenced by LZ4_loadDict().

◆ KB

◆ LASTLITERALS

#define LASTLITERALS   5

Definition at line 300 of file lz4.c.

Referenced by LZ4_compress_generic().

◆ likely

#define likely (   expr)    expect((expr) != 0, 1)

Definition at line 154 of file lz4.c.

Referenced by LZ4_count().

◆ LZ4_decompress_safe_extDict

#define LZ4_decompress_safe_extDict   LZ4_decompress_safe_forceExtDict

Definition at line 1649 of file lz4.c.

◆ LZ4_DISABLE_DEPRECATE_WARNINGS

#define LZ4_DISABLE_DEPRECATE_WARNINGS   /* due to LZ4_decompress_safe_withPrefix64k */

Definition at line 95 of file lz4.c.

◆ LZ4_FORCE_INLINE

#define LZ4_FORCE_INLINE   static

Definition at line 120 of file lz4.c.

Referenced by LZ4_decompress_safe_doubleDict().

◆ LZ4_FORCE_O2_GCC_PPC64LE

◆ LZ4_FORCE_O2_INLINE_GCC_PPC64LE

#define LZ4_FORCE_O2_INLINE_GCC_PPC64LE   static

Definition at line 144 of file lz4.c.

◆ LZ4_HEAPMODE

#define LZ4_HEAPMODE   0

Definition at line 45 of file lz4.c.

◆ LZ4_STATIC_ASSERT

#define LZ4_STATIC_ASSERT (   c)    { enum { LZ4_static_assert = 1/(int)(!!(c)) }; } /* use after variable declarations */

Definition at line 328 of file lz4.c.

Referenced by LZ4_createStream().

◆ LZ4_STATIC_LINKING_ONLY

#define LZ4_STATIC_LINKING_ONLY

Definition at line 94 of file lz4.c.

◆ MAX_DISTANCE

#define MAX_DISTANCE   ((1 << MAXD_LOG) - 1)

Definition at line 309 of file lz4.c.

◆ MAXD_LOG

#define MAXD_LOG   16

Definition at line 308 of file lz4.c.

◆ MB

#define MB   *(1 <<20)

Definition at line 305 of file lz4.c.

◆ MEM_INIT

#define MEM_INIT (   p,
  v,
 
)    memset((p),(v),(s))

Definition at line 169 of file lz4.c.

Referenced by LZ4_prepareTable(), and LZ4_resetStream().

◆ MFLIMIT

#define MFLIMIT   (WILDCOPYLENGTH+MINMATCH)

Definition at line 301 of file lz4.c.

Referenced by LZ4_compress_generic().

◆ MINMATCH

#define MINMATCH   4

Definition at line 297 of file lz4.c.

◆ ML_BITS

#define ML_BITS   4

Definition at line 311 of file lz4.c.

◆ ML_MASK

#define ML_MASK   ((1U<<ML_BITS)-1)

Definition at line 312 of file lz4.c.

◆ RUN_BITS

#define RUN_BITS   (8-ML_BITS)

Definition at line 313 of file lz4.c.

◆ RUN_MASK

#define RUN_MASK   ((1U<<RUN_BITS)-1)

Definition at line 314 of file lz4.c.

◆ STEPSIZE

#define STEPSIZE   sizeof(reg_t)

Definition at line 418 of file lz4.c.

Referenced by LZ4_count().

◆ unlikely

#define unlikely (   expr)    expect((expr) != 0, 0)

Definition at line 157 of file lz4.c.

◆ WILDCOPYLENGTH

#define WILDCOPYLENGTH   8

Definition at line 299 of file lz4.c.

Typedef Documentation

◆ BYTE

typedef unsigned char BYTE

Definition at line 184 of file lz4.c.

◆ reg_t

typedef size_t reg_t

Definition at line 195 of file lz4.c.

◆ S32

typedef signed int S32

Definition at line 187 of file lz4.c.

◆ U16

typedef unsigned short U16

Definition at line 185 of file lz4.c.

◆ U32

typedef unsigned int U32

Definition at line 186 of file lz4.c.

◆ U64

typedef unsigned long long U64

Definition at line 188 of file lz4.c.

◆ uptrval

typedef size_t uptrval

Definition at line 189 of file lz4.c.

Enumeration Type Documentation

◆ dict_directive

This enum distinguishes several different modes of accessing previous content in the stream.

  • noDict : There is no preceding content.
  • withPrefix64k : Table entries up to ctx->dictSize before the current blob blob being compressed are valid and refer to the preceding content (of length ctx->dictSize), which is available contiguously preceding in memory the content currently being compressed.
  • usingExtDict : Like withPrefix64k, but the preceding content is somewhere else in memory, starting at ctx->dictionary with length ctx->dictSize.
  • usingDictCtx : Like usingExtDict, but everything concerning the preceding content is in a separate context, pointed to by ctx->dictCtx. ctx->dictionary, ctx->dictSize, and table entries in the current context that refer to positions preceding the beginning of the current compression are ignored. Instead, ctx->dictCtx->dictionary and ctx->dictCtx ->dictSize describe the location and size of the preceding content, and matches are found by looking in the ctx ->dictCtx->hashTable.
Enumerator
noDict 
withPrefix64k 
usingExtDict 
usingDictCtx 

Definition at line 483 of file lz4.c.

◆ dictIssue_directive

Enumerator
noDictIssue 
dictSmall 

Definition at line 484 of file lz4.c.

◆ earlyEnd_directive

Enumerator
full 
partial 

Definition at line 487 of file lz4.c.

◆ endCondition_directive

Enumerator
endOnOutputSize 
endOnInputSize 

Definition at line 486 of file lz4.c.

◆ limitedOutput_directive

Enumerator
notLimited 
limitedOutput 
fillOutput 

Definition at line 457 of file lz4.c.

◆ tableType_t

Enumerator
clearedTable 
byPtr 
byU32 
byU16 

Definition at line 458 of file lz4.c.

Function Documentation

◆ LZ4_attach_dictionary()

void LZ4_attach_dictionary ( LZ4_stream_t working_stream,
const LZ4_stream_t dictionary_stream 
)

◆ LZ4_compress()

int LZ4_compress ( const char *  source,
char *  dest,
int  inputSize 
)

Definition at line 1856 of file lz4.c.

References LZ4_compress_default(), and LZ4_compressBound().

◆ LZ4_compress_continue()

int LZ4_compress_continue ( LZ4_stream_t LZ4_stream,
const char *  source,
char *  dest,
int  inputSize 
)

Definition at line 1872 of file lz4.c.

References LZ4_compress_fast_continue(), and LZ4_compressBound().

◆ LZ4_compress_default()

int LZ4_compress_default ( const char *  src,
char *  dst,
int  srcSize,
int  dstCapacity 
)

LZ4_compress_default() : Compresses 'srcSize' bytes from buffer 'src' into already allocated 'dst' buffer of size 'dstCapacity'. Compression is guaranteed to succeed if 'dstCapacity' >= LZ4_compressBound(srcSize). It also runs faster, so it's a recommended setting. If the function cannot compress 'src' into a more limited 'dst' budget, compression stops immediately, and the function result is zero. Note : as a consequence, 'dst' content is not valid. Note 2 : This function is protected against buffer overflow scenarios (never writes outside 'dst' buffer, nor read outside 'source' buffer). srcSize : max supported value is LZ4_MAX_INPUT_SIZE. dstCapacity : size of buffer 'dst' (which must be already allocated) return : the number of bytes written into buffer 'dst' (necessarily <= dstCapacity) or 0 if compression fails

Definition at line 1084 of file lz4.c.

References LZ4_compress_fast().

Referenced by LZ4_compress(), and LZ4_compress_limitedOutput().

◆ LZ4_compress_destSize()

int LZ4_compress_destSize ( const char *  src,
char *  dst,
int *  srcSizePtr,
int  targetDstSize 
)

LZ4_compress_destSize() : Reverse the logic : compresses as much data as possible from 'src' buffer into already allocated buffer 'dst' of size 'targetDestSize'. This function either compresses the entire 'src' content into 'dst' if it's large enough, or fill 'dst' buffer completely with as much data as possible from 'src'. srcSizePtr : will be modified to indicate how many bytes where read from 'src' to fill 'dst'. New value is necessarily <= old value. return : Nb bytes written into 'dst' (necessarily <= targetDestSize) or 0 if compression fails

Definition at line 1123 of file lz4.c.

◆ LZ4_compress_fast()

int LZ4_compress_fast ( const char *  src,
char *  dst,
int  srcSize,
int  dstCapacity,
int  acceleration 
)

LZ4_compress_fast() : Same as LZ4_compress_default(), but allows selection of "acceleration" factor. The larger the acceleration value, the faster the algorithm, but also the lesser the compression. It's a trade-off. It can be fine tuned, with each successive value providing roughly +~3% to speed. An acceleration value of "1" is the same as regular LZ4_compress_default() Values <= 0 will be replaced by ACCELERATION_DEFAULT (currently == 1, see lz4.c).

Definition at line 1065 of file lz4.c.

References ALLOC, FREEMEM, LZ4_compress_fast_extState(), and NULL.

Referenced by LZ4_compress_default().

◆ LZ4_compress_fast_continue()

int LZ4_compress_fast_continue ( LZ4_stream_t streamPtr,
const char *  src,
char *  dst,
int  srcSize,
int  dstCapacity,
int  acceleration 
)

LZ4_compress_fast_continue() : Compress 'src' content using data from previously compressed blocks, for better compression ratio. 'dst' buffer must be already allocated. If dstCapacity >= LZ4_compressBound(srcSize), compression is guaranteed to succeed, and runs faster.

Important : The previous 64KB of compressed data is assumed to remain present and unmodified in memory!

Special 1 : When input is a double-buffer, they can have any size, including < 64 KB. Make sure that buffers are separated by at least one byte. This way, each block only depends on previous block. Special 2 : If input buffer is a ring-buffer, it can have any size, including < 64 KB.

Returns
: size of compressed block or 0 if there is an error (typically, cannot fit into 'dst'). After an error, the stream status is invalid, it can only be reset or freed.

Definition at line 1255 of file lz4.c.

References byU32, DEBUGLOG, LZ4_stream_t_internal::dictionary, LZ4_stream_t_internal::dictSize, LZ4_stream_t_internal::initCheck, and LZ4_stream_u::internal_donotuse.

Referenced by LZ4_compress_continue().

◆ LZ4_compress_fast_extState()

int LZ4_compress_fast_extState ( void *  state,
const char *  source,
char *  dest,
int  inputSize,
int  maxOutputSize,
int  acceleration 
)

Definition at line 997 of file lz4.c.

References ACCELERATION_DEFAULT, LZ4_compressBound(), and LZ4_resetStream().

Referenced by LZ4_compress_fast().

◆ LZ4_compress_fast_extState_fastReset()

int LZ4_compress_fast_extState_fastReset ( void *  state,
const char *  src,
char *  dst,
int  srcSize,
int  dstCapacity,
int  acceleration 
)

LZ4_compress_fast_extState_fastReset() : A variant of LZ4_compress_fast_extState().

Using this variant avoids an expensive initialization step. It is only safe to call if the state buffer is known to be correctly initialized already (see comment in lz4.h on LZ4_resetStream_fast() for a definition of "correctly initialized").

Definition at line 1028 of file lz4.c.

◆ LZ4_compress_fast_force()

int LZ4_compress_fast_force ( const char *  source,
char *  dest,
int  inputSize,
int  maxOutputSize,
int  acceleration 
)

Definition at line 1092 of file lz4.c.

References LZ4_resetStream().

◆ LZ4_compress_forceExtDict()

int LZ4_compress_forceExtDict ( LZ4_stream_t LZ4_dict,
const char *  source,
char *  dest,
int  srcSize 
)

Definition at line 1328 of file lz4.c.

References LZ4_stream_u::internal_donotuse.

◆ LZ4_compress_generic()

LZ4_FORCE_INLINE int LZ4_compress_generic ( LZ4_stream_t_internal *const  cctx,
const char *const  source,
char *const  dest,
const int  inputSize,
int *  inputConsumed,
const int  maxOutputSize,
const limitedOutput_directive  outputLimited,
const tableType_t  tableType,
const dict_directive  dictDirective,
const dictIssue_directive  dictIssue,
const U32  acceleration 
)

◆ LZ4_compress_limitedOutput()

int LZ4_compress_limitedOutput ( const char *  source,
char *  dest,
int  inputSize,
int  maxOutputSize 
)

Definition at line 1852 of file lz4.c.

References LZ4_compress_default().

◆ LZ4_compress_limitedOutput_continue()

int LZ4_compress_limitedOutput_continue ( LZ4_stream_t LZ4_stream,
const char *  src,
char *  dst,
int  srcSize,
int  dstCapacity 
)

Definition at line 1868 of file lz4.c.

◆ LZ4_compress_limitedOutput_withState()

int LZ4_compress_limitedOutput_withState ( void *  state,
const char *  src,
char *  dst,
int  srcSize,
int  dstSize 
)

Definition at line 1860 of file lz4.c.

◆ LZ4_compress_withState()

int LZ4_compress_withState ( void *  state,
const char *  src,
char *  dst,
int  srcSize 
)

Definition at line 1864 of file lz4.c.

◆ LZ4_compressBound()

int LZ4_compressBound ( int  inputSize)

LZ4_compressBound() : Provides the maximum size that LZ4 compression may output in a "worst case" scenario (input data not compressible) This function is primarily useful for memory allocation purposes (destination buffer size). Macro LZ4_COMPRESSBOUND() is also provided for compilation-time evaluation (stack memory allocation for example). Note that LZ4_compress_default() compresses faster when dstCapacity is >= LZ4_compressBound(srcSize) inputSize : max supported value is LZ4_MAX_INPUT_SIZE return : maximum output size in a "worst case" scenario or 0, if input size is incorrect (too large or negative)

Definition at line 495 of file lz4.c.

References LZ4_COMPRESSBOUND.

Referenced by G_lz4_compress_bound(), LZ4_compress(), LZ4_compress_continue(), and LZ4_compress_fast_extState().

◆ LZ4_count()

LZ4_FORCE_INLINE unsigned LZ4_count ( const BYTE pIn,
const BYTE pMatch,
const BYTE pInLimit 
)

Definition at line 420 of file lz4.c.

References likely, and STEPSIZE.

◆ LZ4_create()

void* LZ4_create ( char *  inputBuffer)

Definition at line 1903 of file lz4.c.

References LZ4_createStream().

◆ LZ4_createStream()

LZ4_stream_t* LZ4_createStream ( void  )

LZ4_createStream() and LZ4_freeStream() : LZ4_createStream() will allocate and initialize an LZ4_stream_t structure. LZ4_freeStream() releases its memory.

Definition at line 1147 of file lz4.c.

References ALLOC, DEBUGLOG, LZ4_resetStream(), LZ4_STATIC_ASSERT, LZ4_STREAMSIZE, and NULL.

Referenced by LZ4_create().

◆ LZ4_createStreamDecode()

LZ4_streamDecode_t* LZ4_createStreamDecode ( void  )

LZ4_createStreamDecode() and LZ4_freeStreamDecode() : creation / destruction of streaming decompression tracking context. A tracking context can be re-used multiple times.

Definition at line 1691 of file lz4.c.

References ALLOC_AND_ZERO.

◆ LZ4_decoderRingBufferSize()

int LZ4_decoderRingBufferSize ( int  maxBlockSize)

LZ4_decoderRingBufferSize() : when setting a ring buffer for streaming decompression (optional scenario), provides the minimum size of this ring buffer to be compatible with any source respecting maxBlockSize condition. Note : in a ring buffer scenario, blocks are presumed decompressed next to each other. When not enough space remains for next block (remainingSize < maxBlockSize), decoding resumes from beginning of ring buffer.

Returns
: minimum ring buffer size, or 0 if there is an error (invalid maxBlockSize).

Definition at line 1731 of file lz4.c.

References LZ4_DECODER_RING_BUFFER_SIZE, LZ4_FORCE_O2_GCC_PPC64LE, and LZ4_MAX_INPUT_SIZE.

◆ LZ4_decompress_fast()

LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_fast ( const char *  src,
char *  dst,
int  originalSize 
)

LZ4_decompress_fast() : unsafe! This function is a bit faster than LZ4_decompress_safe(), but it may misbehave on malformed input because it doesn't perform full validation of compressed data. originalSize : is the uncompressed size to regenerate Destination buffer must be already allocated, and its size must be >= 'originalSize' bytes. return : number of bytes read from source buffer (== compressed size). If the source stream is detected malformed, the function stops decoding and return a negative result. note : This function is only usable if the originalSize of uncompressed data is known in advance. The caller should also check that all the compressed input has been consumed properly, i.e. that the return value matches the size of the buffer with compressed input. The function never writes past the output buffer. However, since it doesn't know its 'src' size, it may read past the intended input. Also, because match offsets are not validated during decoding, reads from 'src' may underflow. Use this function in trusted environment only.

Definition at line 1614 of file lz4.c.

References endOnOutputSize, full, KB, LZ4_decompress_generic(), LZ4_FORCE_O2_GCC_PPC64LE, NULL, and withPrefix64k.

Referenced by LZ4_decompress_fast_continue(), LZ4_decompress_fast_usingDict(), LZ4_decompress_fast_withPrefix64k(), and LZ4_uncompress().

◆ LZ4_decompress_fast_continue()

◆ LZ4_decompress_fast_doubleDict()

LZ4_FORCE_INLINE int LZ4_decompress_fast_doubleDict ( const char *  source,
char *  dest,
int  originalSize,
size_t  prefixSize,
const void *  dictStart,
size_t  dictSize 
)

Definition at line 1681 of file lz4.c.

References endOnOutputSize, full, LZ4_decompress_generic(), and usingExtDict.

Referenced by LZ4_decompress_fast_continue().

◆ LZ4_decompress_fast_usingDict()

int LZ4_decompress_fast_usingDict ( const char *  source,
char *  dest,
int  originalSize,
const char *  dictStart,
int  dictSize 
)

Definition at line 1840 of file lz4.c.

References LZ4_decompress_fast().

◆ LZ4_decompress_fast_withPrefix64k()

int LZ4_decompress_fast_withPrefix64k ( const char *  source,
char *  dest,
int  originalSize 
)

Definition at line 1632 of file lz4.c.

References LZ4_decompress_fast(), and LZ4_FORCE_O2_GCC_PPC64LE.

◆ LZ4_decompress_generic()

LZ4_FORCE_O2_GCC_PPC64LE LZ4_FORCE_INLINE int LZ4_decompress_generic ( const char *const  src,
char *const  dst,
int  srcSize,
int  outputSize,
int  endOnInput,
int  partialDecoding,
int  targetOutputSize,
int  dict,
const BYTE *const  lowPrefix,
const BYTE *const  dictStart,
const size_t  dictSize 
)

LZ4_decompress_generic() : This generic decompression function covers all use cases. It shall be instantiated several times, using different sets of directives. Note that it is important for performance that this function really get inlined, in order to remove useless branches during compilation optimization.

Definition at line 1383 of file lz4.c.

Referenced by LZ4_decompress_fast(), LZ4_decompress_fast_doubleDict(), LZ4_decompress_safe(), LZ4_decompress_safe_doubleDict(), LZ4_decompress_safe_extDict(), LZ4_decompress_safe_partial(), and LZ4_decompress_safe_withPrefix64k().

◆ LZ4_decompress_safe()

LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_safe ( const char *  src,
char *  dst,
int  compressedSize,
int  dstCapacity 
)

LZ4_decompress_safe() : compressedSize : is the exact complete size of the compressed block. dstCapacity : is the size of destination buffer, which must be already allocated. return : the number of bytes decompressed into destination buffer (necessarily <= dstCapacity) If destination buffer is not large enough, decoding will stop and output an error code (negative value). If the source stream is detected malformed, the function will stop decoding and return a negative result. This function is protected against malicious data packets.

Definition at line 1598 of file lz4.c.

References endOnInputSize, full, LZ4_decompress_generic(), LZ4_FORCE_O2_GCC_PPC64LE, noDict, and NULL.

Referenced by LZ4_decompress_safe_continue(), LZ4_decompress_safe_usingDict(), and LZ4_uncompress_unknownOutputSize().

◆ LZ4_decompress_safe_continue()

LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_safe_continue ( LZ4_streamDecode_t LZ4_streamDecode,
const char *  src,
char *  dst,
int  srcSize,
int  dstCapacity 
)

LZ4_decompress_*_continue() : These decoding functions allow decompression of consecutive blocks in "streaming" mode. A block is an unsplittable entity, it must be presented entirely to a decompression function. Decompression functions only accepts one block at a time. The last 64KB of previously decoded data must remain available and unmodified at the memory position where they were decoded. If less than 64KB of data has been decoded, all the data must be present.

Special : if decompression side sets a ring buffer, it must respect one of the following conditions :

  • Decompression buffer size is at least LZ4_decoderRingBufferSize(maxBlockSize). maxBlockSize is the maximum size of any single block. It can have any value > 16 bytes. In which case, encoding and decoding buffers do not need to be synchronized. Actually, data can be produced by any source compliant with LZ4 format specification, and respecting maxBlockSize.
  • Synchronized mode : Decompression buffer size is exactly the same as compression buffer size, and follows exactly same update rule (block boundaries at same positions), and decoding function is provided with exact decompressed size of each block (exception for last block of the stream), then decoding & encoding ring buffer can have any size, including small ones ( < 64 KB).
  • Decompression buffer is larger than encoding buffer, by a minimum of maxBlockSize more bytes. In which case, encoding and decoding buffers do not need to be synchronized, and encoding ring buffer can have any size, including small ones ( < 64 KB).

Whenever these conditions are not possible, save the last 64KB of decoded data into a safe buffer where it can't be modified during decompression, then indicate where this data is saved using LZ4_setStreamDecode(), before decompressing next block.

Definition at line 1747 of file lz4.c.

References assert, dest, LZ4_streamDecode_t_internal::extDictSize, LZ4_streamDecode_u::internal_donotuse, KB, LZ4_decompress_safe(), LZ4_decompress_safe_withPrefix64k(), LZ4_streamDecode_t_internal::prefixEnd, and LZ4_streamDecode_t_internal::prefixSize.

◆ LZ4_decompress_safe_doubleDict()

LZ4_FORCE_INLINE int LZ4_decompress_safe_doubleDict ( const char *  source,
char *  dest,
int  compressedSize,
int  maxOutputSize,
size_t  prefixSize,
const void *  dictStart,
size_t  dictSize 
)

Definition at line 1672 of file lz4.c.

References endOnInputSize, full, LZ4_decompress_generic(), LZ4_FORCE_INLINE, and usingExtDict.

◆ LZ4_decompress_safe_extDict()

int LZ4_decompress_safe_extDict ( const char *  source,
char *  dest,
int  compressedSize,
int  maxOutputSize,
const void *  dictStart,
size_t  dictSize 
)

◆ LZ4_decompress_safe_partial()

LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_safe_partial ( const char *  src,
char *  dst,
int  srcSize,
int  targetOutputSize,
int  dstCapacity 
)

LZ4_decompress_safe_partial() : This function decompress a compressed block of size 'srcSize' at position 'src' into destination buffer 'dst' of size 'dstCapacity'. The function will decompress a minimum of 'targetOutputSize' bytes, and stop after that. However, it's not accurate, and may write more than 'targetOutputSize' (but always <= dstCapacity).

Returns
: the number of bytes decoded in the destination buffer (necessarily <= dstCapacity) Note : this number can also be < targetOutputSize, if compressed block contains less data. Therefore, always control how many bytes were decoded. If source stream is detected malformed, function returns a negative result. This function is protected against malicious data packets.

Definition at line 1606 of file lz4.c.

References endOnInputSize, LZ4_decompress_generic(), LZ4_FORCE_O2_GCC_PPC64LE, noDict, NULL, and partial.

◆ LZ4_decompress_safe_usingDict()

int LZ4_decompress_safe_usingDict ( const char *  src,
char *  dst,
int  srcSize,
int  dstCapcity,
const char *  dictStart,
int  dictSize 
)

LZ4_decompress_*_usingDict() : These decoding functions work the same as a combination of LZ4_setStreamDecode() followed by LZ4_decompress_*_continue() They are stand-alone, and don't need an LZ4_streamDecode_t structure. Dictionary is presumed stable : it must remain accessible and unmodified during next decompression.

Definition at line 1828 of file lz4.c.

References KB, LZ4_decompress_safe(), and LZ4_decompress_safe_withPrefix64k().

◆ LZ4_decompress_safe_withPrefix64k()

LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_safe_withPrefix64k ( const char *  source,
char *  dest,
int  compressedSize,
int  maxOutputSize 
)

◆ LZ4_freeStream()

int LZ4_freeStream ( LZ4_stream_t LZ4_stream)

Definition at line 1167 of file lz4.c.

References DEBUGLOG, and FREEMEM.

◆ LZ4_freeStreamDecode()

int LZ4_freeStreamDecode ( LZ4_streamDecode_t LZ4_stream)

Definition at line 1697 of file lz4.c.

References FREEMEM.

◆ LZ4_getPosition()

LZ4_FORCE_INLINE const BYTE* LZ4_getPosition ( const BYTE p,
const void *  tableBase,
tableType_t  tableType,
const BYTE srcBase 
)

Definition at line 587 of file lz4.c.

◆ LZ4_hashPosition()

LZ4_FORCE_INLINE U32 LZ4_hashPosition ( const void *const  p,
tableType_t const  tableType 
)

Definition at line 521 of file lz4.c.

References byU16.

◆ LZ4_loadDict()

int LZ4_loadDict ( LZ4_stream_t streamPtr,
const char *  dictionary,
int  dictSize 
)

LZ4_loadDict() : Use this function to load a static dictionary into LZ4_stream_t. Any previous data will be forgotten, only 'dictionary' will remain in memory. Loading a size of 0 is allowed, and is the same as reset.

Returns
: dictionary size, in bytes (necessarily <= 64 KB)

Definition at line 1177 of file lz4.c.

References byU32, LZ4_stream_t_internal::currentOffset, DEBUGLOG, LZ4_stream_t_internal::dictionary, LZ4_stream_t_internal::dictSize, HASH_UNIT, LZ4_stream_t_internal::hashTable, LZ4_stream_u::internal_donotuse, KB, LZ4_putPosition(), LZ4_resetStream(), and LZ4_stream_t_internal::tableType.

◆ LZ4_prepareTable()

◆ LZ4_putPosition()

LZ4_FORCE_INLINE void LZ4_putPosition ( const BYTE p,
void *  tableBase,
tableType_t  tableType,
const BYTE srcBase 
)

Definition at line 552 of file lz4.c.

Referenced by LZ4_loadDict().

◆ LZ4_resetStream()

void LZ4_resetStream ( LZ4_stream_t streamPtr)

LZ4_resetStream() : An LZ4_stream_t structure can be allocated once and re-used multiple times. Use this function to start compressing a new stream.

Definition at line 1157 of file lz4.c.

References DEBUGLOG, and MEM_INIT.

Referenced by LZ4_compress_fast_extState(), LZ4_compress_fast_force(), LZ4_createStream(), LZ4_loadDict(), and LZ4_resetStreamState().

◆ LZ4_resetStream_fast()

void LZ4_resetStream_fast ( LZ4_stream_t ctx)

Definition at line 1163 of file lz4.c.

References byU32, LZ4_stream_u::internal_donotuse, and LZ4_prepareTable().

◆ LZ4_resetStreamState()

int LZ4_resetStreamState ( void *  state,
char *  inputBuffer 
)

Definition at line 1896 of file lz4.c.

References LZ4_resetStream().

◆ LZ4_saveDict()

int LZ4_saveDict ( LZ4_stream_t LZ4_dict,
char *  safeBuffer,
int  dictSize 
)

LZ4_saveDict() : If previously compressed data block is not guaranteed to remain available at its memory location, save it into a safer place (char* safeBuffer). Note : you don't need to call LZ4_loadDict() afterwards, dictionary is immediately usable, you can therefore call LZ4_compress_fast_continue(). Return : saved dictionary size in bytes (necessarily <= dictSize), or 0 if error.

Definition at line 1355 of file lz4.c.

References LZ4_stream_t_internal::dictionary, LZ4_stream_t_internal::dictSize, LZ4_stream_u::internal_donotuse, KB, and LZ4_FORCE_O2_GCC_PPC64LE.

◆ LZ4_setStreamDecode()

int LZ4_setStreamDecode ( LZ4_streamDecode_t LZ4_streamDecode,
const char *  dictionary,
int  dictSize 
)

LZ4_setStreamDecode() : Use this function to instruct where to find the dictionary. This function is not necessary if previous data is still available where it was decoded. Loading a size of 0 is allowed (same effect as no dictionary).

Returns
: 1 if OK, 0 if error

Definition at line 1710 of file lz4.c.

References LZ4_streamDecode_t_internal::extDictSize, LZ4_streamDecode_t_internal::externalDict, LZ4_streamDecode_u::internal_donotuse, NULL, LZ4_streamDecode_t_internal::prefixEnd, and LZ4_streamDecode_t_internal::prefixSize.

◆ LZ4_sizeofState()

int LZ4_sizeofState ( void  )

LZ4_compress_fast_extState() : Same compression function, just using an externally allocated memory space to store compression state. Use LZ4_sizeofState() to know how much memory must be allocated, and allocate it on 8-bytes boundaries (using malloc() typically). Then, provide it as 'void* state' to compression function.

Definition at line 496 of file lz4.c.

References LZ4_STREAMSIZE.

◆ LZ4_sizeofStreamState()

int LZ4_sizeofStreamState ( )

Definition at line 1894 of file lz4.c.

References LZ4_STREAMSIZE.

◆ LZ4_slideInputBuffer()

char* LZ4_slideInputBuffer ( void *  state)

Definition at line 1909 of file lz4.c.

References state.

◆ LZ4_uncompress()

int LZ4_uncompress ( const char *  source,
char *  dest,
int  outputSize 
)

Definition at line 1883 of file lz4.c.

References LZ4_decompress_fast().

◆ LZ4_uncompress_unknownOutputSize()

int LZ4_uncompress_unknownOutputSize ( const char *  source,
char *  dest,
int  isize,
int  maxOutputSize 
)

Definition at line 1887 of file lz4.c.

References LZ4_decompress_safe().

◆ LZ4_versionNumber()

int LZ4_versionNumber ( void  )

library version number; useful to check dll version

Definition at line 493 of file lz4.c.

References LZ4_VERSION_NUMBER.

◆ LZ4_versionString()

const char* LZ4_versionString ( void  )

library version string; unseful to check dll version

Definition at line 494 of file lz4.c.

References LZ4_VERSION_STRING.

◆ LZ4_wildCopy()

LZ4_FORCE_O2_INLINE_GCC_PPC64LE void LZ4_wildCopy ( void *  dstPtr,
const void *  srcPtr,
void *  dstEnd 
)

Definition at line 284 of file lz4.c.