PPL Logo

arch/util/lz4.c File Reference

Go to the source code of this file.

Data Structures

union  __attribute__

Typedefs

typedef uint8_t BYTE
typedef uint16_t U16
typedef uint32_t U32
typedef int32_t S32
typedef uint64_t U64
typedef uintptr_t uptrval
typedef U64 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 }
 This enum distinguishes several different modes of accessing previous content in the stream. More...
enum  dictIssue_directive { noDictIssue = 0, dictSmall }
enum  endCondition_directive { endOnOutputSize = 0, endOnInputSize = 1 }
enum  earlyEnd_directive { decode_full_block = 0, partial_decode = 1 }

Functions

static unsigned LZ4_isLittleEndian (void)
static U16 LZ4_read16 (const void *memPtr)
static U32 LZ4_read32 (const void *memPtr)
static reg_t LZ4_read_ARCH (const void *memPtr)
static void LZ4_write16 (void *memPtr, U16 value)
static void LZ4_write32 (void *memPtr, U32 value)
static U16 LZ4_readLE16 (const void *memPtr)
static void LZ4_writeLE16 (void *memPtr, U16 value)
LZ4_FORCE_O2_INLINE_GCC_PPC64LE
void 
LZ4_wildCopy (void *dstPtr, const void *srcPtr, void *dstEnd)
static unsigned LZ4_NbCommonBytes (reg_t val)
LZ4_FORCE_INLINE unsigned LZ4_count (const BYTE *pIn, const BYTE *pMatch, const BYTE *pInLimit)
int LZ4_versionNumber (void)
 library version number; useful to check dll version
const char * LZ4_versionString (void)
 library version string; unseful to check dll version
int LZ4_compressBound (int isize)
int LZ4_sizeofState ()
int LZ4_compress_forceExtDict (LZ4_stream_t *LZ4_stream, const char *source, char *dest, int inputSize)
int LZ4_decompress_safe_forceExtDict (const char *in, char *out, int inSize, int outSize, const void *dict, size_t dictSize)
static U32 LZ4_hash4 (U32 sequence, tableType_t const tableType)
static U32 LZ4_hash5 (U64 sequence, tableType_t const tableType)
LZ4_FORCE_INLINE U32 LZ4_hashPosition (const void *const p, tableType_t const tableType)
static void LZ4_putIndexOnHash (U32 idx, U32 h, void *tableBase, tableType_t const tableType)
static void LZ4_putPositionOnHash (const BYTE *p, U32 h, void *tableBase, tableType_t const tableType, const BYTE *srcBase)
LZ4_FORCE_INLINE void LZ4_putPosition (const BYTE *p, void *tableBase, tableType_t tableType, const BYTE *srcBase)
static U32 LZ4_getIndexOnHash (U32 h, const void *tableBase, tableType_t tableType)
static const BYTELZ4_getPositionOnHash (U32 h, const 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)
 LZ4_compress_generic() : inlined, to ensure branches are decided at compilation time.
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)
 LZ4_compress_fast_extState_fastReset() : A variant of LZ4_compress_fast_extState().
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)
static int LZ4_compress_destSize_extState (LZ4_stream_t *state, const char *src, char *dst, int *srcSizePtr, int targetDstSize)
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)
static void LZ4_renormDictT (LZ4_stream_t_internal *LZ4_dict, int nextSize)
int LZ4_compress_fast_continue (LZ4_stream_t *LZ4_stream, const char *source, char *dest, int inputSize, int maxOutputSize, int acceleration)
int LZ4_saveDict (LZ4_stream_t *LZ4_dict, char *safeBuffer, int dictSize)
LZ4_FORCE_INLINE int LZ4_decompress_generic (const char *const src, char *const dst, int srcSize, int outputSize, endCondition_directive endOnInput, earlyEnd_directive partialDecoding, dict_directive 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 *src, char *dst, int compressedSize, int targetOutputSize, int dstCapacity)
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)
static LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_safe_withSmallPrefix (const char *source, char *dest, int compressedSize, int maxOutputSize, size_t prefixSize)
static LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_fast_extDict (const char *source, char *dest, int originalSize, 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)

Variables

static const int LZ4_minLength = (MFLIMIT+1)
static int g_debuglog_enable = 1
static const int LZ4_64Klimit = ((64 KB) + (MFLIMIT-1))
static const U32 LZ4_skipTrigger = 6


Typedef Documentation

typedef unsigned char BYTE

Definition at line 177 of file lz4.c.

typedef unsigned short U16

Definition at line 178 of file lz4.c.

typedef unsigned int U32

Definition at line 179 of file lz4.c.

typedef signed int S32

Definition at line 180 of file lz4.c.

typedef unsigned long long U64

Definition at line 181 of file lz4.c.

typedef size_t uptrval

Definition at line 182 of file lz4.c.

typedef size_t reg_t

Definition at line 193 of file lz4.c.


Enumeration Type Documentation

Enumerator:
notLimited 
limitedOutput 
fillOutput 

Definition at line 458 of file lz4.c.

Enumerator:
clearedTable 
byPtr 
byU32 
byU16 

Definition at line 459 of file lz4.c.

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 484 of file lz4.c.

Enumerator:
noDictIssue 
dictSmall 

Definition at line 485 of file lz4.c.

Enumerator:
endOnOutputSize 
endOnInputSize 

Definition at line 1390 of file lz4.c.

Enumerator:
decode_full_block 
partial_decode 

Definition at line 1391 of file lz4.c.


Function Documentation

static unsigned LZ4_isLittleEndian ( void   )  [static]

Definition at line 201 of file lz4.c.

References c, and PUP::u.

Referenced by LZ4_hash5(), LZ4_NbCommonBytes(), LZ4_readLE16(), and LZ4_writeLE16().

Here is the caller graph for this function:

static U16 LZ4_read16 ( const void *  memPtr  )  [static]

Definition at line 211 of file lz4.c.

Referenced by LZ4_count(), and LZ4_readLE16().

Here is the caller graph for this function:

static U32 LZ4_read32 ( const void *  memPtr  )  [static]

Definition at line 212 of file lz4.c.

Referenced by LZ4_compress_generic(), LZ4_count(), and LZ4_hashPosition().

Here is the caller graph for this function:

static reg_t LZ4_read_ARCH ( const void *  memPtr  )  [static]

Definition at line 213 of file lz4.c.

Referenced by LZ4_count(), and LZ4_hashPosition().

Here is the caller graph for this function:

static void LZ4_write16 ( void *  memPtr,
U16  value 
) [static]

Definition at line 215 of file lz4.c.

Referenced by LZ4_writeLE16().

Here is the caller graph for this function:

static void LZ4_write32 ( void *  memPtr,
U32  value 
) [static]

Definition at line 216 of file lz4.c.

Referenced by LZ4_compress_generic(), and LZ4_decompress_generic().

Here is the caller graph for this function:

static U16 LZ4_readLE16 ( const void *  memPtr  )  [static]

Definition at line 261 of file lz4.c.

References LZ4_isLittleEndian(), LZ4_read16(), and p.

Referenced by LZ4_decompress_generic().

Here is the call graph for this function:

Here is the caller graph for this function:

static void LZ4_writeLE16 ( void *  memPtr,
U16  value 
) [static]

Definition at line 271 of file lz4.c.

References LZ4_isLittleEndian(), LZ4_write16(), and p.

Referenced by LZ4_compress_generic().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 284 of file lz4.c.

References PUP::d, and PUP::s.

Referenced by LZ4_compress_generic(), and LZ4_decompress_generic().

Here is the caller graph for this function:

static unsigned LZ4_NbCommonBytes ( reg_t  val  )  [static]

Definition at line 348 of file lz4.c.

References _BitScanForward(), _BitScanReverse(), LZ4_isLittleEndian(), and r.

Referenced by LZ4_count().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 421 of file lz4.c.

References LZ4_NbCommonBytes(), LZ4_read16(), LZ4_read32(), and LZ4_read_ARCH().

Referenced by LZ4_compress_generic().

Here is the call graph for this function:

Here is the caller graph for this function:

int LZ4_versionNumber ( void   ) 

library version number; useful to check dll version

Definition at line 491 of file lz4.c.

const char* LZ4_versionString ( void   ) 

library version string; unseful to check dll version

Definition at line 492 of file lz4.c.

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 493 of file lz4.c.

Referenced by compressLz4(), CompressPersistentMsg(), LZ4_compress(), LZ4_compress_continue(), LZ4_compress_destSize_extState(), LZ4_compress_fast_extState(), LZ4_compress_fast_extState_fastReset(), and LZ4_compress_withState().

Here is the caller graph for this function:

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 this buffer as 'void* state' to compression function.

Definition at line 494 of file lz4.c.

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

LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_safe_forceExtDict ( const char *  in,
char *  out,
int  inSize,
int  outSize,
const void *  dict,
size_t  dictSize 
)

Definition at line 1703 of file lz4.c.

References decode_full_block, endOnInputSize, LZ4_decompress_generic(), and usingExtDict.

Referenced by LZ4_decompress_safe_continue(), and LZ4_decompress_safe_usingDict().

Here is the call graph for this function:

Here is the caller graph for this function:

static U32 LZ4_hash4 ( U32  sequence,
tableType_t const   tableType 
) [static]

Definition at line 515 of file lz4.c.

References byU16.

Referenced by LZ4_hashPosition().

Here is the caller graph for this function:

static U32 LZ4_hash5 ( U64  sequence,
tableType_t const   tableType 
) [static]

Definition at line 523 of file lz4.c.

References byU16, and LZ4_isLittleEndian().

Referenced by LZ4_hashPosition().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 534 of file lz4.c.

References byU16, LZ4_hash4(), LZ4_hash5(), LZ4_read32(), and LZ4_read_ARCH().

Referenced by LZ4_compress_generic(), LZ4_getPosition(), and LZ4_putPosition().

Here is the call graph for this function:

Here is the caller graph for this function:

static void LZ4_putIndexOnHash ( U32  idx,
U32  h,
void *  tableBase,
tableType_t const   tableType 
) [static]

Definition at line 540 of file lz4.c.

References assert, byPtr, byU16, byU32, and clearedTable.

Referenced by LZ4_compress_generic().

Here is the caller graph for this function:

static void LZ4_putPositionOnHash ( const BYTE p,
U32  h,
void *  tableBase,
tableType_t const   tableType,
const BYTE srcBase 
) [static]

Definition at line 552 of file lz4.c.

References assert, byPtr, byU16, byU32, and clearedTable.

Referenced by LZ4_compress_generic(), and LZ4_putPosition().

Here is the caller graph for this function:

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

Definition at line 565 of file lz4.c.

References h, LZ4_hashPosition(), and LZ4_putPositionOnHash().

Referenced by LZ4_compress_generic(), and LZ4_loadDict().

Here is the call graph for this function:

Here is the caller graph for this function:

static U32 LZ4_getIndexOnHash ( U32  h,
const void *  tableBase,
tableType_t  tableType 
) [static]

Definition at line 577 of file lz4.c.

References assert, byU16, and byU32.

Referenced by LZ4_compress_generic().

Here is the caller graph for this function:

static const BYTE* LZ4_getPositionOnHash ( U32  h,
const void *  tableBase,
tableType_t  tableType,
const BYTE srcBase 
) [static]

Definition at line 593 of file lz4.c.

References byPtr, and byU32.

Referenced by LZ4_compress_generic(), and LZ4_getPosition().

Here is the caller graph for this function:

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

Definition at line 600 of file lz4.c.

References h, LZ4_getPositionOnHash(), and LZ4_hashPosition().

Referenced by LZ4_compress_generic().

Here is the call graph for this function:

Here is the caller graph for this function:

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 
)

Definition at line 1010 of file lz4.c.

References byPtr, byU16, byU32, limitedOutput, LZ4_compress_generic(), LZ4_compressBound(), LZ4_resetStream(), noDict, noDictIssue, and notLimited.

Referenced by LZ4_compress_destSize_extState(), LZ4_compress_fast(), LZ4_compress_limitedOutput_withState(), and LZ4_compress_withState().

Here is the call graph for this function:

Here is the caller graph for this function:

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 1041 of file lz4.c.

References byPtr, byU16, byU32, LZ4_stream_t_internal::currentOffset, dictSmall, limitedOutput, LZ4_compress_generic(), LZ4_compressBound(), LZ4_prepareTable(), noDict, noDictIssue, and notLimited.

Here is the call graph for this function:

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 1078 of file lz4.c.

References LZ4_compress_fast_extState().

Referenced by LZ4_compress_default().

Here is the call graph for this function:

Here is the caller graph for this function:

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 1097 of file lz4.c.

References LZ4_compress_fast().

Referenced by compressLz4(), LZ4_compress(), and LZ4_compress_limitedOutput().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 1105 of file lz4.c.

References byPtr, byU16, byU32, LZ4_stream_u::internal_donotuse, limitedOutput, LZ4_compress_generic(), LZ4_resetStream(), noDict, and noDictIssue.

Here is the call graph for this function:

static int LZ4_compress_destSize_extState ( LZ4_stream_t state,
const char *  src,
char *  dst,
int srcSizePtr,
int  targetDstSize 
) [static]

Definition at line 1120 of file lz4.c.

References byPtr, byU16, byU32, fillOutput, LZ4_stream_u::internal_donotuse, LZ4_compress_fast_extState(), LZ4_compress_generic(), LZ4_compressBound(), LZ4_resetStream(), noDict, and noDictIssue.

Referenced by LZ4_compress_destSize().

Here is the call graph for this function:

Here is the caller graph for this function:

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'. note: acceleration parameter is fixed to "default".

*srcSizePtr : will be modified to indicate how many bytes where read from 'src' to fill 'dst'. New value is necessarily <= input value.

Returns:
: Nb bytes written into 'dst' (necessarily <= targetDestSize) or 0 if compression fails.

Definition at line 1136 of file lz4.c.

References LZ4_compress_destSize_extState().

Here is the call graph for this function:

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 1160 of file lz4.c.

References LZ4_resetStream().

Referenced by LZ4_create().

Here is the call graph for this function:

Here is the caller graph for this function:

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 1170 of file lz4.c.

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

Here is the caller graph for this function:

void LZ4_resetStream_fast ( LZ4_stream_t streamPtr  ) 

LZ4_resetStream_fast() : Use this, like LZ4_resetStream(), to prepare a context for a new chain of calls to a streaming API (e.g., LZ4_compress_fast_continue()).

Note: Using this in advance of a non- streaming-compression function is redundant, and potentially bad for performance, since they all perform their own custom reset internally.

Differences from LZ4_resetStream(): When an LZ4_stream_t is known to be in a internally coherent state, it can often be prepared for a new compression with almost no work, only sometimes falling back to the full, expensive reset that is always required when the stream is in an indeterminate state (i.e., the reset performed by LZ4_resetStream()).

LZ4_streams are guaranteed to be in a valid state when:

  • returned from LZ4_createStream()
  • reset by LZ4_resetStream()
  • memset(stream, 0, sizeof(LZ4_stream_t)), though this is discouraged
  • the stream was in a valid state and was reset by LZ4_resetStream_fast()
  • the stream was in a valid state and was then used in any compression call that returned success
  • the stream was in an indeterminate state and was used in a compression call that fully reset the state (e.g., LZ4_compress_fast_extState()) and that returned success

When a stream isn't known to be in a valid state, it is not safe to pass to any fastReset or streaming function. It must first be cleansed by the full LZ4_resetStream().

Definition at line 1176 of file lz4.c.

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

Here is the call graph for this function:

int LZ4_freeStream ( LZ4_stream_t LZ4_stream  ) 

Definition at line 1180 of file lz4.c.

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 1190 of file lz4.c.

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

Here is the call graph for this function:

void LZ4_attach_dictionary ( LZ4_stream_t working_stream,
const LZ4_stream_t dictionary_stream 
)

LZ4_attach_dictionary() : This is an experimental API that allows for the efficient use of a static dictionary many times.

Rather than re-loading the dictionary buffer into a working context before each compression, or copying a pre-loaded dictionary's LZ4_stream_t into a working LZ4_stream_t, this function introduces a no-copy setup mechanism, in which the working stream references the dictionary stream in-place.

Several assumptions are made about the state of the dictionary stream. Currently, only streams which have been prepared by LZ4_loadDict() should be expected to work.

Alternatively, the provided dictionary stream pointer may be NULL, in which case any existing dictionary stream is unset.

If a dictionary is provided, it replaces any pre-existing stream history. The dictionary contents are the only history that can be referenced and logically immediately precede the data compressed in the first subsequent compression call.

The dictionary will only remain attached to the working stream through the first compression call, at the end of which it is cleared. The dictionary stream (and source buffer) must remain in-place / accessible / unchanged through the completion of the first compression call on the stream.

Definition at line 1232 of file lz4.c.

References LZ4_stream_t_internal::currentOffset, LZ4_stream_t_internal::dictCtx, and LZ4_stream_u::internal_donotuse.

static void LZ4_renormDictT ( LZ4_stream_t_internal LZ4_dict,
int  nextSize 
) [static]

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.

Returns:
: size of compressed block or 0 if there is an error (typically, cannot fit into 'dst').
Note 1 : Each invocation to LZ4_compress_fast_continue() generates a new block. Each block has precise boundaries. It's not possible to append blocks together and expect a single invocation of LZ4_decompress_*() to decompress them together. Each block must be decompressed separately, calling LZ4_decompress_*() with associated metadata.

Note 2 : The previous 64KB of source data is __assumed__ to remain present, unmodified, at same address in memory!

Note 3 : When input is structured as a double-buffer, each buffer can have any size, including < 64 KB. Make sure that buffers are separated, by at least one byte. This construction ensures that each block only depends on previous block.

Note 4 : If input buffer is a ring-buffer, it can have any size, including < 64 KB.

Note 5 : After an error, the stream status is invalid, it can only be reset or freed.

Definition at line 1268 of file lz4.c.

References byU32, LZ4_stream_t_internal::currentOffset, LZ4_stream_t_internal::dictCtx, LZ4_stream_t_internal::dictionary, LZ4_stream_t_internal::dictSize, dictSmall, LZ4_stream_t_internal::initCheck, LZ4_stream_u::internal_donotuse, limitedOutput, LZ4_compress_generic(), LZ4_renormDictT(), noDictIssue, usingDictCtx, usingExtDict, and withPrefix64k.

Referenced by LZ4_compress_continue(), and LZ4_compress_limitedOutput_continue().

Here is the call graph for this function:

Here is the caller graph for this function:

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 1368 of file lz4.c.

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

LZ4_FORCE_INLINE int LZ4_decompress_generic ( const char *const   src,
char *const   dst,
int  srcSize,
int  outputSize,
endCondition_directive  endOnInput,
earlyEnd_directive  partialDecoding,
dict_directive  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 1403 of file lz4.c.

References assert, endOnInputSize, length, LZ4_readLE16(), LZ4_wildCopy(), LZ4_write32(), match(), offset, op, PUP::s, size_t, usingExtDict, and withPrefix64k.

Referenced by LZ4_decompress_fast(), LZ4_decompress_fast_doubleDict(), LZ4_decompress_fast_extDict(), LZ4_decompress_safe(), LZ4_decompress_safe_doubleDict(), LZ4_decompress_safe_forceExtDict(), LZ4_decompress_safe_partial(), LZ4_decompress_safe_withPrefix64k(), and LZ4_decompress_safe_withSmallPrefix().

Here is the call graph for this function:

Here is the caller graph for this function:

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 1651 of file lz4.c.

References decode_full_block, endOnInputSize, LZ4_decompress_generic(), and noDict.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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() : Decompress an LZ4 compressed block, of size 'srcSize' at position 'src', into destination buffer 'dst' of size 'dstCapacity'. Up to 'targetOutputSize' bytes will be decoded. The function stops decoding on reaching this objective, which can boost performance when only the beginning of a block is required.

Returns:
: the number of bytes decoded in `dst` (necessarily <= dstCapacity) If source stream is detected malformed, function returns a negative result.
Note :
Returns:
can be < targetOutputSize, if compressed block contains less data.
Note 2 : this function features 2 parameters, targetOutputSize and dstCapacity, and expects targetOutputSize <= dstCapacity. It effectively stops decoding on reaching targetOutputSize, so dstCapacity is kind of redundant. This is because in a previous version of this function, decoding operation would not "break" a sequence in the middle. As a consequence, there was no guarantee that decoding would stop at exactly targetOutputSize, it could write more bytes, though only up to dstCapacity. Some "margin" used to be required for this operation to work properly. This is no longer necessary. The function nonetheless keeps its signature, in an effort to not break API.

Definition at line 1659 of file lz4.c.

References endOnInputSize, LZ4_decompress_generic(), noDict, and partial_decode.

Here is the call graph for this function:

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

LZ4_decompress_fast() : **unsafe!** This function used to be a bit faster than LZ4_decompress_safe(), though situation has changed in recent versions, and now `LZ4_decompress_safe()` can be as fast and sometimes faster than `LZ4_decompress_fast()`. Moreover, LZ4_decompress_fast() is not protected vs malformed input, as it doesn't perform full validation of compressed data. As a consequence, this function is no longer recommended, and may be deprecated in future versions. It's only remaining specificity is that it can decompress data without knowing its compressed size.

originalSize : is the uncompressed size to regenerate. `dst` must be already allocated, its size must be >= 'originalSize' bytes.

Returns:
: number of bytes read from source buffer (== compressed size). If the source stream is detected malformed, the function stops decoding and returns a negative result. note : This function requires uncompressed originalSize to be known in advance. 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 1668 of file lz4.c.

References decode_full_block, endOnOutputSize, LZ4_decompress_generic(), and withPrefix64k.

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 1678 of file lz4.c.

References decode_full_block, endOnInputSize, LZ4_decompress_generic(), and withPrefix64k.

Referenced by LZ4_decompress_safe_continue(), and LZ4_decompress_safe_usingDict().

Here is the call graph for this function:

Here is the caller graph for this function:

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

Definition at line 1686 of file lz4.c.

References LZ4_decompress_fast().

Here is the call graph for this function:

static LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_safe_withSmallPrefix ( const char *  source,
char *  dest,
int  compressedSize,
int  maxOutputSize,
size_t  prefixSize 
) [static]

Definition at line 1694 of file lz4.c.

References decode_full_block, endOnInputSize, LZ4_decompress_generic(), and noDict.

Referenced by LZ4_decompress_safe_continue(), and LZ4_decompress_safe_usingDict().

Here is the call graph for this function:

Here is the caller graph for this function:

static LZ4_FORCE_O2_GCC_PPC64LE int LZ4_decompress_fast_extDict ( const char *  source,
char *  dest,
int  originalSize,
const void *  dictStart,
size_t  dictSize 
) [static]

Definition at line 1713 of file lz4.c.

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

Referenced by LZ4_decompress_fast_continue(), and LZ4_decompress_fast_usingDict().

Here is the call graph for this function:

Here is the caller graph for this function:

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 1726 of file lz4.c.

References decode_full_block, endOnInputSize, LZ4_decompress_generic(), and usingExtDict.

Referenced by LZ4_decompress_safe_continue().

Here is the call graph for this function:

Here is the caller graph for this function:

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 1735 of file lz4.c.

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

Referenced by LZ4_decompress_fast_continue().

Here is the call graph for this function:

Here is the caller graph for this function:

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 1745 of file lz4.c.

int LZ4_freeStreamDecode ( LZ4_streamDecode_t LZ4_stream  ) 

Definition at line 1751 of file lz4.c.

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 1764 of file lz4.c.

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

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 1785 of file lz4.c.

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 1801 of file lz4.c.

References assert, LZ4_streamDecode_t_internal::extDictSize, LZ4_streamDecode_t_internal::externalDict, LZ4_streamDecode_u::internal_donotuse, LZ4_decompress_safe(), LZ4_decompress_safe_doubleDict(), LZ4_decompress_safe_forceExtDict(), LZ4_decompress_safe_withPrefix64k(), LZ4_decompress_safe_withSmallPrefix(), LZ4_streamDecode_t_internal::prefixEnd, and LZ4_streamDecode_t_internal::prefixSize.

Here is the call graph for this function:

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 *  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 1882 of file lz4.c.

References LZ4_decompress_safe(), LZ4_decompress_safe_forceExtDict(), LZ4_decompress_safe_withPrefix64k(), and LZ4_decompress_safe_withSmallPrefix().

Here is the call graph for this function:

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

Definition at line 1894 of file lz4.c.

References LZ4_decompress_fast(), and LZ4_decompress_fast_extDict().

Here is the call graph for this function:

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

Definition at line 1906 of file lz4.c.

References LZ4_compress_default().

Here is the call graph for this function:

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

Definition at line 1910 of file lz4.c.

References LZ4_compress_default(), and LZ4_compressBound().

Here is the call graph for this function:

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

Definition at line 1914 of file lz4.c.

References LZ4_compress_fast_extState().

Here is the call graph for this function:

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

Definition at line 1918 of file lz4.c.

References LZ4_compress_fast_extState(), and LZ4_compressBound().

Here is the call graph for this function:

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

Definition at line 1922 of file lz4.c.

References LZ4_compress_fast_continue().

Here is the call graph for this function:

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

Definition at line 1926 of file lz4.c.

References LZ4_compress_fast_continue(), and LZ4_compressBound().

Here is the call graph for this function:

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

Definition at line 1937 of file lz4.c.

References LZ4_decompress_fast().

Here is the call graph for this function:

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

Definition at line 1941 of file lz4.c.

References LZ4_decompress_safe().

Here is the call graph for this function:

int LZ4_sizeofStreamState (  ) 

Definition at line 1948 of file lz4.c.

int LZ4_resetStreamState ( void *  state,
char *  inputBuffer 
)

Definition at line 1950 of file lz4.c.

References LZ4_resetStream().

Here is the call graph for this function:

void* LZ4_create ( char *  inputBuffer  ) 

Definition at line 1957 of file lz4.c.

References LZ4_createStream().

Here is the call graph for this function:

char* LZ4_slideInputBuffer ( void *  state  ) 

Definition at line 1963 of file lz4.c.


Variable Documentation

const int LZ4_minLength = (MFLIMIT+1) [static]

Definition at line 303 of file lz4.c.

int g_debuglog_enable = 1 [static]

Definition at line 333 of file lz4.c.

const int LZ4_64Klimit = ((64 KB) + (MFLIMIT-1)) [static]

Definition at line 451 of file lz4.c.

const U32 LZ4_skipTrigger = 6 [static]

Definition at line 452 of file lz4.c.


Generated on Mon Sep 21 07:56:14 2020 for Charm++ by  doxygen 1.5.5