forked from enlightenment/efl
lz4: fix possible security issue.
See : - http://fastcompression.blogspot.fr/2014/06/lets-move-on.html - http://www.openwall.com/lists/oss-security/2014/06/26/25 @fix
This commit is contained in:
Cedric BAIL
parent
201d9b567d
commit
2c97212736
File diff suppressed because it is too large
Load Diff
|
|
@ -1,128 +1,306 @@
|
||||||
/*
|
/*
|
||||||
LZ4 - Fast LZ compression algorithm
|
LZ4 - Fast LZ compression algorithm
|
||||||
Header File
|
Header File
|
||||||
Copyright (C) 2011-2012, Yann Collet.
|
Copyright (C) 2011-2014, Yann Collet.
|
||||||
BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
|
BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
Redistribution and use in source and binary forms, with or without
|
||||||
modification, are permitted provided that the following conditions are
|
modification, are permitted provided that the following conditions are
|
||||||
met:
|
met:
|
||||||
|
|
||||||
* Redistributions of source code must retain the above copyright
|
* Redistributions of source code must retain the above copyright
|
||||||
notice, this list of conditions and the following disclaimer.
|
notice, this list of conditions and the following disclaimer.
|
||||||
* Redistributions in binary form must reproduce the above
|
* Redistributions in binary form must reproduce the above
|
||||||
copyright notice, this list of conditions and the following disclaimer
|
copyright notice, this list of conditions and the following disclaimer
|
||||||
in the documentation and/or other materials provided with the
|
in the documentation and/or other materials provided with the
|
||||||
distribution.
|
distribution.
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
You can contact the author at :
|
You can contact the author at :
|
||||||
- LZ4 homepage : http://fastcompression.blogspot.com/p/lz4.html
|
- LZ4 source repository : http://code.google.com/p/lz4/
|
||||||
- LZ4 source repository : http://code.google.com/p/lz4/
|
- LZ4 public forum : https://groups.google.com/forum/#!forum/lz4c
|
||||||
*/
|
*/
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
#if defined (__cplusplus)
|
#if defined (__cplusplus)
|
||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
|
||||||
//**************************************
|
/**************************************
|
||||||
// Compiler Options
|
Version
|
||||||
//**************************************
|
**************************************/
|
||||||
#ifdef _MSC_VER // Visual Studio
|
#define LZ4_VERSION_MAJOR 1 /* for major interface/format changes */
|
||||||
# define inline __inline // Visual is not C99, but supports some kind of inline
|
#define LZ4_VERSION_MINOR 2 /* for minor interface/format changes */
|
||||||
#endif
|
#define LZ4_VERSION_RELEASE 0 /* for tweaks, bug-fixes, or development */
|
||||||
|
|
||||||
|
|
||||||
//****************************
|
/**************************************
|
||||||
// Simple Functions
|
Tuning parameter
|
||||||
//****************************
|
**************************************/
|
||||||
|
/*
|
||||||
int LZ4_compress (const char* source, char* dest, int isize);
|
* LZ4_MEMORY_USAGE :
|
||||||
int LZ4_uncompress (const char* source, char* dest, int osize);
|
* Memory usage formula : N->2^N Bytes (examples : 10 -> 1KB; 12 -> 4KB ; 16 -> 64KB; 20 -> 1MB; etc.)
|
||||||
|
* Increasing memory usage improves compression ratio
|
||||||
/*
|
* Reduced memory usage can improve speed, due to cache effect
|
||||||
LZ4_compress() :
|
* Default value is 14, for 16KB, which nicely fits into Intel x86 L1 cache
|
||||||
Compresses 'isize' bytes from 'source' into 'dest'.
|
*/
|
||||||
Destination buffer must be already allocated,
|
#define LZ4_MEMORY_USAGE 14
|
||||||
and must be sized to handle worst cases situations (input data not compressible)
|
|
||||||
Worst case size evaluation is provided by function LZ4_compressBound()
|
|
||||||
|
/**************************************
|
||||||
isize : is the input size. Max supported value is ~1.9GB
|
Simple Functions
|
||||||
return : the number of bytes written in buffer dest
|
**************************************/
|
||||||
|
|
||||||
|
int LZ4_compress (const char* source, char* dest, int inputSize);
|
||||||
LZ4_uncompress() :
|
int LZ4_decompress_safe (const char* source, char* dest, int compressedSize, int maxOutputSize);
|
||||||
osize : is the output size, therefore the original size
|
|
||||||
return : the number of bytes read in the source buffer
|
/*
|
||||||
If the source stream is malformed, the function will stop decoding and return a negative result, indicating the byte position of the faulty instruction
|
LZ4_compress() :
|
||||||
This function never writes outside of provided buffers, and never modifies input buffer.
|
Compresses 'inputSize' bytes from 'source' into 'dest'.
|
||||||
note : destination buffer must be already allocated.
|
Destination buffer must be already allocated,
|
||||||
its size must be a minimum of 'osize' bytes.
|
and must be sized to handle worst cases situations (input data not compressible)
|
||||||
*/
|
Worst case size evaluation is provided by function LZ4_compressBound()
|
||||||
|
inputSize : Max supported value is LZ4_MAX_INPUT_VALUE
|
||||||
|
return : the number of bytes written in buffer dest
|
||||||
//****************************
|
or 0 if the compression fails
|
||||||
// Advanced Functions
|
|
||||||
//****************************
|
LZ4_decompress_safe() :
|
||||||
|
compressedSize : is obviously the source size
|
||||||
static inline int LZ4_compressBound(int isize) { return ((isize) + ((isize)/255) + 16); }
|
maxOutputSize : is the size of the destination buffer, which must be already allocated.
|
||||||
#define LZ4_COMPRESSBOUND( isize) ((isize) + ((isize)/255) + 16)
|
return : the number of bytes decoded in the destination buffer (necessarily <= maxOutputSize)
|
||||||
|
If the destination buffer is not large enough, decoding will stop and output an error code (<0).
|
||||||
/*
|
If the source stream is detected malformed, the function will stop decoding and return a negative result.
|
||||||
LZ4_compressBound() :
|
This function is protected against buffer overflow exploits :
|
||||||
Provides the maximum size that LZ4 may output in a "worst case" scenario (input data not compressible)
|
it never writes outside of output buffer, and never reads outside of input buffer.
|
||||||
primarily useful for memory allocation of output buffer.
|
Therefore, it is protected against malicious data packets.
|
||||||
inline function is recommended for the general case,
|
*/
|
||||||
but macro is also provided when results need to be evaluated at compile time (such as table size allocation).
|
|
||||||
|
|
||||||
isize : is the input size. Max supported value is ~1.9GB
|
/*
|
||||||
return : maximum output size in a "worst case" scenario
|
Note :
|
||||||
note : this function is limited by "int" range (2^31-1)
|
Should you prefer to explicitly allocate compression-table memory using your own allocation method,
|
||||||
*/
|
use the streaming functions provided below, simply reset the memory area between each call to LZ4_compress_continue()
|
||||||
|
*/
|
||||||
|
|
||||||
int LZ4_compress_limitedOutput (const char* source, char* dest, int isize, int maxOutputSize);
|
|
||||||
|
/**************************************
|
||||||
/*
|
Advanced Functions
|
||||||
LZ4_compress_limitedOutput() :
|
**************************************/
|
||||||
Compress 'isize' bytes from 'source' into an output buffer 'dest' of maximum size 'maxOutputSize'.
|
#define LZ4_MAX_INPUT_SIZE 0x7E000000 /* 2 113 929 216 bytes */
|
||||||
If it cannot achieve it, compression will stop, and result of the function will be zero.
|
#define LZ4_COMPRESSBOUND(isize) ((unsigned int)(isize) > (unsigned int)LZ4_MAX_INPUT_SIZE ? 0 : (isize) + ((isize)/255) + 16)
|
||||||
This function never writes outside of provided output buffer.
|
|
||||||
|
/*
|
||||||
isize : is the input size. Max supported value is ~1.9GB
|
LZ4_compressBound() :
|
||||||
maxOutputSize : is the size of the destination buffer (which must be already allocated)
|
Provides the maximum size that LZ4 may output in a "worst case" scenario (input data not compressible)
|
||||||
return : the number of bytes written in buffer 'dest'
|
primarily useful for memory allocation of output buffer.
|
||||||
or 0 if the compression fails
|
macro is also provided when result needs to be evaluated at compilation (such as stack memory allocation).
|
||||||
*/
|
|
||||||
|
isize : is the input size. Max supported value is LZ4_MAX_INPUT_SIZE
|
||||||
|
return : maximum output size in a "worst case" scenario
|
||||||
int LZ4_uncompress_unknownOutputSize (const char* source, char* dest, int isize, int maxOutputSize);
|
or 0, if input size is too large ( > LZ4_MAX_INPUT_SIZE)
|
||||||
|
*/
|
||||||
/*
|
int LZ4_compressBound(int isize);
|
||||||
LZ4_uncompress_unknownOutputSize() :
|
|
||||||
isize : is the input size, therefore the compressed size
|
|
||||||
maxOutputSize : is the size of the destination buffer (which must be already allocated)
|
/*
|
||||||
return : the number of bytes decoded in the destination buffer (necessarily <= maxOutputSize)
|
LZ4_compress_limitedOutput() :
|
||||||
If the source stream is malformed, the function will stop decoding and return a negative result, indicating the byte position of the faulty instruction
|
Compress 'inputSize' bytes from 'source' into an output buffer 'dest' of maximum size 'maxOutputSize'.
|
||||||
This function never writes beyond dest + maxOutputSize, and is therefore protected against malicious data packets
|
If it cannot achieve it, compression will stop, and result of the function will be zero.
|
||||||
note : Destination buffer must be already allocated.
|
This function never writes outside of provided output buffer.
|
||||||
This version is slightly slower than LZ4_uncompress()
|
|
||||||
*/
|
inputSize : Max supported value is LZ4_MAX_INPUT_VALUE
|
||||||
|
maxOutputSize : is the size of the destination buffer (which must be already allocated)
|
||||||
|
return : the number of bytes written in buffer 'dest'
|
||||||
#if defined (__cplusplus)
|
or 0 if the compression fails
|
||||||
}
|
*/
|
||||||
#endif
|
int LZ4_compress_limitedOutput (const char* source, char* dest, int inputSize, int maxOutputSize);
|
||||||
|
|
||||||
|
|
||||||
|
/*
|
||||||
|
LZ4_decompress_fast() :
|
||||||
|
originalSize : is the original and therefore uncompressed size
|
||||||
|
return : the number of bytes read from the source buffer (in other words, the compressed size)
|
||||||
|
If the source stream is malformed, the function will stop decoding and return a negative result.
|
||||||
|
Destination buffer must be already allocated. Its size must be a minimum of 'originalSize' bytes.
|
||||||
|
note : This function is a bit faster than LZ4_decompress_safe()
|
||||||
|
It provides fast decompression and fully respect memory boundaries for properly formed compressed data.
|
||||||
|
It does not provide full protection against intentionnally modified data stream.
|
||||||
|
Use this function in a trusted environment (data to decode comes from a trusted source).
|
||||||
|
*/
|
||||||
|
int LZ4_decompress_fast (const char* source, char* dest, int originalSize);
|
||||||
|
|
||||||
|
|
||||||
|
/*
|
||||||
|
LZ4_decompress_safe_partial() :
|
||||||
|
This function decompress a compressed block of size 'compressedSize' at position 'source'
|
||||||
|
into output buffer 'dest' of size 'maxOutputSize'.
|
||||||
|
The function tries to stop decompressing operation as soon as 'targetOutputSize' has been reached,
|
||||||
|
reducing decompression time.
|
||||||
|
return : the number of bytes decoded in the destination buffer (necessarily <= maxOutputSize)
|
||||||
|
Note : this number can be < 'targetOutputSize' should the compressed block to decode be smaller.
|
||||||
|
Always control how many bytes were decoded.
|
||||||
|
If the source stream is detected malformed, the function will stop decoding and return a negative result.
|
||||||
|
This function never writes outside of output buffer, and never reads outside of input buffer. It is therefore protected against malicious data packets
|
||||||
|
*/
|
||||||
|
int LZ4_decompress_safe_partial (const char* source, char* dest, int compressedSize, int targetOutputSize, int maxOutputSize);
|
||||||
|
|
||||||
|
|
||||||
|
/***********************************************
|
||||||
|
Experimental Streaming Compression Functions
|
||||||
|
***********************************************/
|
||||||
|
|
||||||
|
#define LZ4_STREAMSIZE_U32 ((1 << (LZ4_MEMORY_USAGE-2)) + 8)
|
||||||
|
#define LZ4_STREAMSIZE (LZ4_STREAMSIZE_U32 * sizeof(unsigned int))
|
||||||
|
/*
|
||||||
|
* LZ4_stream_t
|
||||||
|
* information structure to track an LZ4 stream.
|
||||||
|
* important : set this structure content to zero before first use !
|
||||||
|
*/
|
||||||
|
typedef struct { unsigned int table[LZ4_STREAMSIZE_U32]; } LZ4_stream_t;
|
||||||
|
|
||||||
|
/*
|
||||||
|
* If you prefer dynamic allocation methods,
|
||||||
|
* LZ4_createStream
|
||||||
|
* provides a pointer (void*) towards an initialized LZ4_stream_t structure.
|
||||||
|
* LZ4_free just frees it.
|
||||||
|
*/
|
||||||
|
void* LZ4_createStream();
|
||||||
|
int LZ4_free (void* LZ4_stream);
|
||||||
|
|
||||||
|
|
||||||
|
/*
|
||||||
|
* LZ4_loadDict
|
||||||
|
* Use this function to load a static dictionary into LZ4_stream.
|
||||||
|
* Any previous data will be forgotten, only 'dictionary' will remain in memory.
|
||||||
|
* Loading a size of 0 is allowed (same effect as init).
|
||||||
|
* Return : 1 if OK, 0 if error
|
||||||
|
*/
|
||||||
|
int LZ4_loadDict (void* LZ4_stream, const char* dictionary, int dictSize);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* LZ4_compress_continue
|
||||||
|
* Compress data block 'source', using blocks compressed before as dictionary to improve compression ratio
|
||||||
|
* Previous data blocks are assumed to still be present at their previous location.
|
||||||
|
*/
|
||||||
|
int LZ4_compress_continue (void* LZ4_stream, const char* source, char* dest, int inputSize);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* LZ4_compress_limitedOutput_continue
|
||||||
|
* Same as before, but also specify a maximum target compressed size (maxOutputSize)
|
||||||
|
* If objective cannot be met, compression exits, and returns a zero.
|
||||||
|
*/
|
||||||
|
int LZ4_compress_limitedOutput_continue (void* LZ4_stream, const char* source, char* dest, int inputSize, int maxOutputSize);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* LZ4_saveDict
|
||||||
|
* If previously compressed data block is not guaranteed to remain at its previous memory location
|
||||||
|
* save it into a safe place (char* safeBuffer)
|
||||||
|
* Note : you don't need to call LZ4_loadDict() afterwards,
|
||||||
|
* dictionary is immediately usable, you can therefore call again LZ4_compress_continue()
|
||||||
|
* Return : 1 if OK, 0 if error
|
||||||
|
* Note : any dictSize > 64 KB will be interpreted as 64KB.
|
||||||
|
*/
|
||||||
|
int LZ4_saveDict (void* LZ4_stream, char* safeBuffer, int dictSize);
|
||||||
|
|
||||||
|
|
||||||
|
/************************************************
|
||||||
|
Experimental Streaming Decompression Functions
|
||||||
|
************************************************/
|
||||||
|
|
||||||
|
#define LZ4_STREAMDECODESIZE_U32 4
|
||||||
|
#define LZ4_STREAMDECODESIZE (LZ4_STREAMDECODESIZE_U32 * sizeof(unsigned int))
|
||||||
|
/*
|
||||||
|
* LZ4_streamDecode_t
|
||||||
|
* information structure to track an LZ4 stream.
|
||||||
|
* important : set this structure content to zero before first use !
|
||||||
|
*/
|
||||||
|
typedef struct { unsigned int table[LZ4_STREAMDECODESIZE_U32]; } LZ4_streamDecode_t;
|
||||||
|
|
||||||
|
/*
|
||||||
|
* If you prefer dynamic allocation methods,
|
||||||
|
* LZ4_createStreamDecode()
|
||||||
|
* provides a pointer (void*) towards an initialized LZ4_streamDecode_t structure.
|
||||||
|
* LZ4_free just frees it.
|
||||||
|
*/
|
||||||
|
void* LZ4_createStreamDecode();
|
||||||
|
int LZ4_free (void* LZ4_stream); /* yes, it's the same one as for compression */
|
||||||
|
|
||||||
|
/*
|
||||||
|
*_continue() :
|
||||||
|
These decoding functions allow decompression of multiple blocks in "streaming" mode.
|
||||||
|
Previously decoded blocks must still be available at the memory position where they were decoded.
|
||||||
|
If it's not possible, save the relevant part of decoded data into a safe buffer,
|
||||||
|
and indicate where it stands using LZ4_setDictDecode()
|
||||||
|
*/
|
||||||
|
int LZ4_decompress_safe_continue (void* LZ4_streamDecode, const char* source, char* dest, int compressedSize, int maxOutputSize);
|
||||||
|
int LZ4_decompress_fast_continue (void* LZ4_streamDecode, const char* source, char* dest, int originalSize);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* LZ4_setDictDecode
|
||||||
|
* Use this function to instruct where to find the dictionary.
|
||||||
|
* This function can be used to specify a static dictionary,
|
||||||
|
* or to instruct where to find some previously decoded data saved into a different memory space.
|
||||||
|
* Setting a size of 0 is allowed (same effect as no dictionary).
|
||||||
|
* Return : 1 if OK, 0 if error
|
||||||
|
*/
|
||||||
|
int LZ4_setDictDecode (void* LZ4_streamDecode, const char* dictionary, int dictSize);
|
||||||
|
|
||||||
|
|
||||||
|
/*
|
||||||
|
Advanced decoding functions :
|
||||||
|
*_usingDict() :
|
||||||
|
These decoding functions work the same as
|
||||||
|
a combination of LZ4_setDictDecode() followed by LZ4_decompress_x_continue()
|
||||||
|
all together into a single function call.
|
||||||
|
It doesn't use nor update an LZ4_streamDecode_t structure.
|
||||||
|
*/
|
||||||
|
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);
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
/**************************************
|
||||||
|
Obsolete Functions
|
||||||
|
**************************************/
|
||||||
|
/*
|
||||||
|
Obsolete decompression functions
|
||||||
|
These function names are deprecated and should no longer be used.
|
||||||
|
They are only provided here for compatibility with older user programs.
|
||||||
|
- LZ4_uncompress is the same as LZ4_decompress_fast
|
||||||
|
- LZ4_uncompress_unknownOutputSize is the same as LZ4_decompress_safe
|
||||||
|
*/
|
||||||
|
int LZ4_uncompress (const char* source, char* dest, int outputSize);
|
||||||
|
int LZ4_uncompress_unknownOutputSize (const char* source, char* dest, int isize, int maxOutputSize);
|
||||||
|
|
||||||
|
/* Obsolete functions for externally allocated state; use streaming interface instead */
|
||||||
|
int LZ4_sizeofState(void);
|
||||||
|
int LZ4_compress_withState (void* state, const char* source, char* dest, int inputSize);
|
||||||
|
int LZ4_compress_limitedOutput_withState (void* state, const char* source, char* dest, int inputSize, int maxOutputSize);
|
||||||
|
|
||||||
|
/* Obsolete streaming functions; use new streaming interface whenever possible */
|
||||||
|
void* LZ4_create (const char* inputBuffer);
|
||||||
|
int LZ4_sizeofStreamState(void);
|
||||||
|
int LZ4_resetStreamState(void* state, const char* inputBuffer);
|
||||||
|
char* LZ4_slideInputBuffer (void* state);
|
||||||
|
|
||||||
|
/* Obsolete streaming decoding functions */
|
||||||
|
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);
|
||||||
|
|
||||||
|
|
||||||
|
#if defined (__cplusplus)
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
|
||||||
File diff suppressed because it is too large
Load Diff
|
|
@ -1,60 +1,173 @@
|
||||||
/*
|
/*
|
||||||
LZ4 HC - High Compression Mode of LZ4
|
LZ4 HC - High Compression Mode of LZ4
|
||||||
Header File
|
Header File
|
||||||
Copyright (C) 2011-2012, Yann Collet.
|
Copyright (C) 2011-2014, Yann Collet.
|
||||||
BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
|
BSD 2-Clause License (http://www.opensource.org/licenses/bsd-license.php)
|
||||||
|
|
||||||
Redistribution and use in source and binary forms, with or without
|
Redistribution and use in source and binary forms, with or without
|
||||||
modification, are permitted provided that the following conditions are
|
modification, are permitted provided that the following conditions are
|
||||||
met:
|
met:
|
||||||
|
|
||||||
* Redistributions of source code must retain the above copyright
|
* Redistributions of source code must retain the above copyright
|
||||||
notice, this list of conditions and the following disclaimer.
|
notice, this list of conditions and the following disclaimer.
|
||||||
* Redistributions in binary form must reproduce the above
|
* Redistributions in binary form must reproduce the above
|
||||||
copyright notice, this list of conditions and the following disclaimer
|
copyright notice, this list of conditions and the following disclaimer
|
||||||
in the documentation and/or other materials provided with the
|
in the documentation and/or other materials provided with the
|
||||||
distribution.
|
distribution.
|
||||||
|
|
||||||
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||||||
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||||
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||||||
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||||||
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||||||
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||||||
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||||||
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||||||
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||||||
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||||
|
|
||||||
You can contact the author at :
|
You can contact the author at :
|
||||||
- LZ4 homepage : http://fastcompression.blogspot.com/p/lz4.html
|
- LZ4 homepage : http://fastcompression.blogspot.com/p/lz4.html
|
||||||
- LZ4 source repository : http://code.google.com/p/lz4/
|
- LZ4 source repository : http://code.google.com/p/lz4/
|
||||||
*/
|
*/
|
||||||
#pragma once
|
#pragma once
|
||||||
|
|
||||||
|
|
||||||
#if defined (__cplusplus)
|
#if defined (__cplusplus)
|
||||||
extern "C" {
|
extern "C" {
|
||||||
#endif
|
#endif
|
||||||
|
|
||||||
|
|
||||||
int LZ4_compressHC (const char* source, char* dest, int isize);
|
int LZ4_compressHC (const char* source, char* dest, int inputSize);
|
||||||
|
/*
|
||||||
/*
|
LZ4_compressHC :
|
||||||
LZ4_compressHC :
|
return : the number of bytes in compressed buffer dest
|
||||||
return : the number of bytes in compressed buffer dest
|
or 0 if compression fails.
|
||||||
note : destination buffer must be already allocated.
|
note : destination buffer must be already allocated.
|
||||||
To avoid any problem, size it to handle worst cases situations (input data not compressible)
|
To avoid any problem, size it to handle worst cases situations (input data not compressible)
|
||||||
Worst case size evaluation is provided by function LZ4_compressBound() (see "lz4.h")
|
Worst case size evaluation is provided by function LZ4_compressBound() (see "lz4.h")
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
int LZ4_compressHC_limitedOutput (const char* source, char* dest, int inputSize, int maxOutputSize);
|
||||||
/* Note :
|
/*
|
||||||
Decompression functions are provided within regular LZ4 source code (see "lz4.h") (BSD license)
|
LZ4_compress_limitedOutput() :
|
||||||
*/
|
Compress 'inputSize' bytes from 'source' into an output buffer 'dest' of maximum size 'maxOutputSize'.
|
||||||
|
If it cannot achieve it, compression will stop, and result of the function will be zero.
|
||||||
|
This function never writes outside of provided output buffer.
|
||||||
#if defined (__cplusplus)
|
|
||||||
}
|
inputSize : Max supported value is 1 GB
|
||||||
#endif
|
maxOutputSize : is maximum allowed size into the destination buffer (which must be already allocated)
|
||||||
|
return : the number of output bytes written in buffer 'dest'
|
||||||
|
or 0 if compression fails.
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
int LZ4_compressHC2 (const char* source, char* dest, int inputSize, int compressionLevel);
|
||||||
|
int LZ4_compressHC2_limitedOutput (const char* source, char* dest, int inputSize, int maxOutputSize, int compressionLevel);
|
||||||
|
/*
|
||||||
|
Same functions as above, but with programmable 'compressionLevel'.
|
||||||
|
Recommended values are between 4 and 9, although any value between 0 and 16 will work.
|
||||||
|
'compressionLevel'==0 means use default 'compressionLevel' value.
|
||||||
|
Values above 16 behave the same as 16.
|
||||||
|
Equivalent variants exist for all other compression functions below.
|
||||||
|
*/
|
||||||
|
|
||||||
|
/* Note :
|
||||||
|
Decompression functions are provided within LZ4 source code (see "lz4.h") (BSD license)
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
/**************************************
|
||||||
|
Using an external allocation
|
||||||
|
**************************************/
|
||||||
|
int LZ4_sizeofStateHC(void);
|
||||||
|
int LZ4_compressHC_withStateHC (void* state, const char* source, char* dest, int inputSize);
|
||||||
|
int LZ4_compressHC_limitedOutput_withStateHC (void* state, const char* source, char* dest, int inputSize, int maxOutputSize);
|
||||||
|
|
||||||
|
int LZ4_compressHC2_withStateHC (void* state, const char* source, char* dest, int inputSize, int compressionLevel);
|
||||||
|
int LZ4_compressHC2_limitedOutput_withStateHC(void* state, const char* source, char* dest, int inputSize, int maxOutputSize, int compressionLevel);
|
||||||
|
|
||||||
|
/*
|
||||||
|
These functions are provided should you prefer to allocate memory for compression tables with your own allocation methods.
|
||||||
|
To know how much memory must be allocated for the compression tables, use :
|
||||||
|
int LZ4_sizeofStateHC();
|
||||||
|
|
||||||
|
Note that tables must be aligned for pointer (32 or 64 bits), otherwise compression will fail (return code 0).
|
||||||
|
|
||||||
|
The allocated memory can be provided to the compressions functions using 'void* state' parameter.
|
||||||
|
LZ4_compress_withStateHC() and LZ4_compress_limitedOutput_withStateHC() are equivalent to previously described functions.
|
||||||
|
They just use the externally allocated memory area instead of allocating their own (on stack, or on heap).
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
/**************************************
|
||||||
|
Streaming Functions
|
||||||
|
**************************************/
|
||||||
|
/* Note : these streaming functions still follows the older model */
|
||||||
|
void* LZ4_createHC (const char* inputBuffer);
|
||||||
|
int LZ4_compressHC_continue (void* LZ4HC_Data, const char* source, char* dest, int inputSize);
|
||||||
|
int LZ4_compressHC_limitedOutput_continue (void* LZ4HC_Data, const char* source, char* dest, int inputSize, int maxOutputSize);
|
||||||
|
char* LZ4_slideInputBufferHC (void* LZ4HC_Data);
|
||||||
|
int LZ4_freeHC (void* LZ4HC_Data);
|
||||||
|
|
||||||
|
int LZ4_compressHC2_continue (void* LZ4HC_Data, const char* source, char* dest, int inputSize, int compressionLevel);
|
||||||
|
int LZ4_compressHC2_limitedOutput_continue (void* LZ4HC_Data, const char* source, char* dest, int inputSize, int maxOutputSize, int compressionLevel);
|
||||||
|
|
||||||
|
/*
|
||||||
|
These functions allow the compression of dependent blocks, where each block benefits from prior 64 KB within preceding blocks.
|
||||||
|
In order to achieve this, it is necessary to start creating the LZ4HC Data Structure, thanks to the function :
|
||||||
|
|
||||||
|
void* LZ4_createHC (const char* inputBuffer);
|
||||||
|
The result of the function is the (void*) pointer on the LZ4HC Data Structure.
|
||||||
|
This pointer will be needed in all other functions.
|
||||||
|
If the pointer returned is NULL, then the allocation has failed, and compression must be aborted.
|
||||||
|
The only parameter 'const char* inputBuffer' must, obviously, point at the beginning of input buffer.
|
||||||
|
The input buffer must be already allocated, and size at least 192KB.
|
||||||
|
'inputBuffer' will also be the 'const char* source' of the first block.
|
||||||
|
|
||||||
|
All blocks are expected to lay next to each other within the input buffer, starting from 'inputBuffer'.
|
||||||
|
To compress each block, use either LZ4_compressHC_continue() or LZ4_compressHC_limitedOutput_continue().
|
||||||
|
Their behavior are identical to LZ4_compressHC() or LZ4_compressHC_limitedOutput(),
|
||||||
|
but require the LZ4HC Data Structure as their first argument, and check that each block starts right after the previous one.
|
||||||
|
If next block does not begin immediately after the previous one, the compression will fail (return 0).
|
||||||
|
|
||||||
|
When it's no longer possible to lay the next block after the previous one (not enough space left into input buffer), a call to :
|
||||||
|
char* LZ4_slideInputBufferHC(void* LZ4HC_Data);
|
||||||
|
must be performed. It will typically copy the latest 64KB of input at the beginning of input buffer.
|
||||||
|
Note that, for this function to work properly, minimum size of an input buffer must be 192KB.
|
||||||
|
==> The memory position where the next input data block must start is provided as the result of the function.
|
||||||
|
|
||||||
|
Compression can then resume, using LZ4_compressHC_continue() or LZ4_compressHC_limitedOutput_continue(), as usual.
|
||||||
|
|
||||||
|
When compression is completed, a call to LZ4_freeHC() will release the memory used by the LZ4HC Data Structure.
|
||||||
|
*/
|
||||||
|
|
||||||
|
int LZ4_sizeofStreamStateHC(void);
|
||||||
|
int LZ4_resetStreamStateHC(void* state, const char* inputBuffer);
|
||||||
|
|
||||||
|
/*
|
||||||
|
These functions achieve the same result as :
|
||||||
|
void* LZ4_createHC (const char* inputBuffer);
|
||||||
|
|
||||||
|
They are provided here to allow the user program to allocate memory using its own routines.
|
||||||
|
|
||||||
|
To know how much space must be allocated, use LZ4_sizeofStreamStateHC();
|
||||||
|
Note also that space must be aligned for pointers (32 or 64 bits).
|
||||||
|
|
||||||
|
Once space is allocated, you must initialize it using : LZ4_resetStreamStateHC(void* state, const char* inputBuffer);
|
||||||
|
void* state is a pointer to the space allocated.
|
||||||
|
It must be aligned for pointers (32 or 64 bits), and be large enough.
|
||||||
|
The parameter 'const char* inputBuffer' must, obviously, point at the beginning of input buffer.
|
||||||
|
The input buffer must be already allocated, and size at least 192KB.
|
||||||
|
'inputBuffer' will also be the 'const char* source' of the first block.
|
||||||
|
|
||||||
|
The same space can be re-used multiple times, just by initializing it each time with LZ4_resetStreamState().
|
||||||
|
return value of LZ4_resetStreamStateHC() must be 0 is OK.
|
||||||
|
Any other value means there was an error (typically, state is not aligned for pointers (32 or 64 bits)).
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
#if defined (__cplusplus)
|
||||||
|
}
|
||||||
|
#endif
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue