Merge pull request #515 from svpv/refactorDec

lz4.c: refactor the decoding routines

ignore windows+msys artefacts

Merge pull request #520 from felixhandte/frame-dict-nits

Minor Fixes to Dictionary Preparation in LZ4 Frame

Merge pull request #519 from lz4/fdParser

Faster decoding speed

Avoid Possibly Redundant Table Clears When Loading HC Dict

Remove Redundant LZ4_resetStream() Call

Rename LZ4F_applyCDict() -> LZ4F_initStream()

ensure favorDecSpeed is properly initialized

also :
- fix a potential malloc error
- proper use of ALLOC macro inside lz4hc
- update html API doc

updated NEWS, in preparation for v1.8.2

lz4.c: fixed the LZ4_decompress_fast_continue case

The change is very similar to that of the LZ4_decompress_safe_continue
case.  The only reason a make this a separate change is to ensure that
the fuzzer, after it's been enhanced, can detect the flaw in
LZ4_decompress_fast_continue, and that the change indeed fixes the flaw.

fuzzer.c: enabled ring buffer tests for decompress_fast

Ring buffer tests were performed only with LZ4_decompress_safe_continue,
leaving my buggy changes to LZ4_decompress_safe_continue undetected.
The tests are now replicated and performed in a similar manner for both
LZ4_decompress_safe_continue and LZ4_decompress_safe_continue (except
for the small buffer case where only one function can be tested,
because part of the dictionary is overwritten with the output).

I also updated function names in the messages (changed them to the
actual ones).  The error was reported for LZ4_decompress_safe(),
which I found misleading.

fixed a number of minor cast warnings

Merge pull request #518 from felixhandte/fix-517-dict-size-truncation

Limit Dictionary Size During LZ4F Decompression

Merge pull request #516 from felixhandte/merge-dest-size

Merge _destSize Compress Variant into LZ4_compress_generic()

fasterDecSpeed can be triggered from cli with --favor-decSpeed

favorDecSpeed feature can be triggered from lz4frame

and lz4hc.

Merge _destSize Compress Variant into LZ4_compress_generic()

Add _destSize() to Fullbench

Limit Dictionary Size During LZ4F Decompression

Fixes lz4/lz4#517.

introduced ability to parse for decompression speed

triggered through an enum.

Now, it's still necessary to properly expose this capability
all the way up to the cli.

lz4.c: fixed the LZ4_decompress_safe_continue case

The previous change broke decoding with a ring buffer.  That's because
I didn't realize that the "double dictionary mode" was possible, i.e.
that the decoding routine can look both at the first part of the
dictionary passed as prefix and the second part passed via dictStart+dictSize.

So this change introduces the LZ4_decompress_safe_doubleDict helper,
which handles this "double dictionary" situation.  (This is a bit of
a misnomer, there is only one dictionary, but I can't think of a better
name, and perhaps the designation is not all too bad.)  The helper is
used only once, in LZ4_decompress_safe_continue, it should be inlined
with LZ4_FORCE_O2_GCC_PPC64LE attached to LZ4_decompress_safe_continue.

(Also, in the helper functions, I change the dictStart parameter type
to "const void*", to avoid a cast when calling helpers.  In the helpers,
the upcast to "BYTE*" is still required, for compatibility with C++.)

So this fixes the case of LZ4_decompress_safe_continue, and I'm
surprised by the fact that the fuzzer is now happy and does not detect
a similar problem with LZ4_decompress_fast_continue.  So before fixing
LZ4_decompress_fast_continue, the next logical step is to enhance
the fuzzer.

minor edit of block format

clarifying parsing restrictions near end of block.

Merge pull request #514 from svpv/clarifyBlockFormat

lz4_Block_format.md: clarify on short inputs and restrictions

lz4.c: refactor the decoding routines

I noticed that LZ4_decompress_generic is sometimes instantiated with
identical set of parameters, or (what's worse) with a subtly different
sets of parameters.  For example, LZ4_decompress_fast_withPrefix64k is
instantiated as follows:

    return LZ4_decompress_generic(source, dest, 0, originalSize, endOnOutputSize,
full, 0, withPrefix64k, (BYTE*)dest - 64 KB, NULL, 64 KB);

while the equivalent withPrefix64k call in LZ4_decompress_usingDict_generic
passes 0 for the last argument instead of 64 KB.  It turns out that there
is no difference in this case: if you change 64 KB to 0 KB in
LZ4_decompress_fast_withPrefix64k, you get the same binary code.

Moreover, because it's been clarified that LZ4_decompress_fast doesn't
check match offsets, it is now obvious that both of these fast/withPrefix64k
instantiations are simply redundant.  Exactly because LZ4_decompress_fast
doesn't check offsets, it serves well with any prefixed dictionary.

There's a difference, though, with LZ4_decompress_safe_withPrefix64k.
It also passes 64 KB as the last argument, and if you change that to 0,
as in LZ4_decompress_usingDict_generic, you get a completely different
binary code.  It seems that passing 0 enables offset checking:

    const int checkOffset = ((safeDecode) && (dictSize < (int)(64 KB)));

However, the resulting code seems to run a bit faster.  How come
enabling extra checks can make the code run faster?  Curiouser and
curiouser!  This needs extra study.  Currently I take the view that
the dictSize should be set to non-zero when nothing else will do,
i.e. when passing the external dictionary via dictStart.  Otherwise,
lowPrefix betrays just enough information about the dictionary.

    * * *

Anyway, with this change, I instantiate all the necessary cases as
functions with distinctive names, which also take fewer arguments and
are therefore less error-prone.  I also make the functions non-inline.
(The compiler won't inline the functions because they are used more than
once.  Hence I attach LZ4_FORCE_O2_GCC_PPC64LE to the instances while
removing from the callers.)  The number of instances is now is reduced
from 18 (safe+fast+partial+4*continue+4*prefix+4*dict+2*prefix64+forceExtDict)
down to 7 (safe+fast+partial+2*prefix+2*dict).  The size of the code is
not the only issue here.  Separate helper function are much more
amenable to profile-guided optimization: it is enough to profile only
a few basic functions, while the other less-often used functions, such
as LZ4_decompress_*_continue, will benefit automatically.

This is the list of LZ4_decompress* functions in liblz4.so, sorted by size.
Exported functions are marked with a capital T.

$ nm -S lib/liblz4.so |grep -wi T |grep LZ4_decompress |sort -k2
0000000000016260 0000000000000005 T LZ4_decompress_fast_withPrefix64k
0000000000016dc0 0000000000000025 T LZ4_decompress_fast_usingDict
0000000000016d80 0000000000000040 T LZ4_decompress_safe_usingDict
0000000000016d10 000000000000006b T LZ4_decompress_fast_continue
0000000000016c70 000000000000009f T LZ4_decompress_safe_continue
00000000000156c0 000000000000059c T LZ4_decompress_fast
0000000000014a90 00000000000005fa T LZ4_decompress_safe
0000000000015c60 00000000000005fa T LZ4_decompress_safe_withPrefix64k
0000000000002280 00000000000005fa t LZ4_decompress_safe_withSmallPrefix
0000000000015090 000000000000062f T LZ4_decompress_safe_partial
0000000000002880 00000000000008ea t LZ4_decompress_fast_extDict
0000000000016270 0000000000000993 t LZ4_decompress_safe_forceExtDict

Merge pull request #513 from felixhandte/integrate-static-frame-functions

Integrate Contents of `lz4frame_static.h` into `lz4frame.h`

lz4_Block_format.md: clarify on short inputs and restrictions

It occurred to me that the formula "The last 5 bytes are always
literals", on the list of "assumptions made by the decoder", is
remarkably ambiguous.  Suppose the decoder is presented with 5 bytes.
Are they literals?  It may seem that the decoder degenerates
to memcpy on short inputs.  But of course the answer is no,
so the formula needs some clarification.

Parsing restrictions should be explained as well, otherwise they look
like arbitrary numbers.  The 5-byte restriction has been mentioned
recently in connection with the shortcut in LZ4_decompress_generic,
so I add that.  The second restriction is left to be explained
by the author.

I also took the liberty to explain that empty inputs "are either
unrepresentable or can be represented with a null byte".  This wording
may actually have some merit: it leaves for the implementation,
as opposed to the spec, to decide whether the encoder can compress
empty inputs, and whether the decoder can produce an empty output
(which the implementation should further clarify).

Multiply-Include Header to Check Guard Macro Correctness

Change Over Includes in the Project

Integrate lz4frame_static.h Declarations into lz4frame.h

Merge pull request #512 from lz4/HC_dict

In-place unmutable dictionaries for LZ4HC

Merge pull request #511 from lz4/decFast

Fixed performance issue with LZ4_decompress_fast()

Merge pull request #488 from felixhandte/hc-dict-ctx

Use Dictionary In-Place in HC Mode

Remove Debug Log Statements

Remove the Framebench Tool

Revert Stream Size Const to Correct Value

Merge pull request #504 from baruchsiach/static-only-support

lib: allow to disable shared libraries

re-ordered parenthesis

to avoid mixing && and &
as suggested by @terrelln

Merge pull request #507 from lz4/clangPerf

fixed lz4_fast clang performance

fixed minor declaration issue with clang on msys

disable shortcut for LZ4_decompress_fast()

improving speed

fullbench compiled without assert()

to better reflect release speed

Merge pull request #510 from terrelln/bug-fix

Fix input size validation edge cases

Fix compilation error and assert.

Fix input size validation edge cases

The bug is a read up to 2 bytes past the end of the buffer.
There are three cases for this bug, one for each test case added.

* An empty input causes `token = *ip++` to read one byte too far.
* A one byte input with `(token >> ML_BITS) == RUN_MASK` causes
  one extra byte to be read without validation. This could be
  combined with the first bug to cause 2 extra bytes to be read.
* The case pointed out in issue #508, where `ip == iend` at the
  beginning of the loop after taking the shortcut.

Benchmarks show no regressions on clang or gcc-7 on both my mac
and devserver.

Fixes #508.

Merge pull request #509 from svpv/clarifyFastRisks

lz4.h: clarify the risks of using LZ4_decompress_fast()

lz4.h: clarify the risks of using LZ4_decompress_fast()

The notes about "security guarantee" and "malicious inputs" seemed
a bit non-technical to me, so I took the liberty to tone them down
and instead describe the actual risks in technical terms.  Namely,
the function never writes past the end of the output buffer, so
a direct hostile takeover (resulting in arbitrary code execution
soon after the return from the function) is not possible.  However,
the application can crash because of reads from unmapped pages.

I also took the liberty to describe what I believe is the only sensible
usage scenario for the function: "This function is only usable if the
originalSize of uncompressed data is known in advance," etc.

fixed incorrect comment

fixed clang performance in lz4_fast

The simple change from
`matchIndex+MAX_DISTANCE < current`
towards
`current - matchIndex > MAX_DISTANCE`

is enough to generate a 10% performance drop under clang.
Quite massive.
(I missed as my eyes were concentrated on gcc performance at that time).

The second version is more robust, because it also survives a situation where
`matchIndex > current`
due to overflows.

The first version requires matchIndex to not overflow.
Hence were added `assert()` conditions.

The only case where this can happen is with dictCtx compression,
in the case where the dictionary context is not initialized before loading the dictionary.
So it's enough to always initialize the context while loading the dictionary.

Change vLimit Calculation

Remove Redundant Static Assert

Simpler loadDict() Reset

Tolerate Base Pointer Underflow

Don't Segfault on Malloc Failure

Sign-Extend -1 to Pointer Width

Fix Constant Value

Handle Index Underflows Safely

Consts and Asserts and Other Minor Nits

Add Some Simple Fuzzer Tests

Add Comments on New Public APIs

Add API for Attaching Dictionaries

Also Reset the Chain Table

Remove inputBuffer from Context, Work Around its Absence

Remove Commented Out Support for Match Continuation over Segment Boundary

Fix Signedness of Comparison

Don't Clear the Dictionary Context Until No Longer Useful

Copy DictCtx into Working Context on Inputs Larger than 4 KB

Force Inline on HashChain

Split DictCtx-using Code Into Separate Inlining Chain

Use Fast Reset in LZ4F Again

Use Fast Reset API in LZ4F

Add Fast Reset Paths

Remove Match Upper Bounds Check

Fix Some Cast/Conversion Warnings

Fix Offset Math

Reset Stream in LZ4_compress_HC

Don't Bother Clearing Chain Table for Working Contexts

Push Previous Compression Offsets into the Past

Shift Dict Limit Checks out of the Loop

Clear Tables on Dict Load

Only Perform Dict Lookup if Attempts Remain

Avoid Resetting Chain Table

Avoid Resetting Hash Table

Perform Lookups into the Dictionary Context

Call LZ4F_applyCDict Even on NULL CDict

Set dictCtx Rather than memcpy'ing Ctx

Fully Bounds Check Hash Table Reads

Add a Dictionary Context Pointer to the HC Context

Add Debug Log Statements to HC

Fix Framebench Output Buffer Sizing

Fix Cast

Print Failure Message in Framebench

Switch to Unaligned Samples to Compress Different Blobs Each Time

Fix Framebench Statistics

Add Run Name to Frame Bench Output

Auto-Calculate Appropriate Repetition Count

Print More Detailed Results Inside bench(), Add Compression Levels

Check Compressed Buffer is Correct in Frame Bench

Add HC Calls to Framebench

Restore Framebench Tool

This reverts commit 70f14823a46719e81e808d9ed9df90f478bcfd3f.

Merge pull request #505 from lz4/dev

update to `dev`