2017-08-18 23:52:05 +00:00
/*
2020-03-26 22:19:05 +00:00
* Copyright ( c ) 2016 - 2020 , Yann Collet , Facebook , Inc .
2016-08-30 17:04:33 +00:00
* All rights reserved .
*
2017-08-18 23:52:05 +00:00
* This source code is licensed under both the BSD - style license ( found in the
* LICENSE file in the root directory of this source tree ) and the GPLv2 ( found
* in the COPYING file in the root directory of this source tree ) .
2017-09-08 07:09:23 +00:00
* You may select , at your option , one of the above - listed licenses .
2016-08-30 17:04:33 +00:00
*/
2016-08-12 14:48:02 +00:00
/*-************************************
2018-06-19 02:20:37 +00:00
* Compiler specific
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2016-08-12 14:48:02 +00:00
# ifdef _MSC_VER /* Visual Studio */
2017-05-12 23:29:19 +00:00
# define _CRT_SECURE_NO_WARNINGS /* fgets */
# pragma warning(disable : 4127) /* disable: C4127: conditional expression is constant */
# pragma warning(disable : 4146) /* disable: C4146: minus unsigned expression */
2016-08-12 14:48:02 +00:00
# endif
/*-************************************
2018-06-19 02:20:37 +00:00
* Includes
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2016-08-12 14:48:02 +00:00
# include <stdlib.h> /* free */
# include <stdio.h> /* fgets, sscanf */
# include <string.h> /* strcmp */
2017-06-17 00:56:41 +00:00
# include <assert.h> /* assert */
2019-04-12 14:28:17 +00:00
# include "timefn.h" /* UTIL_time_t, UTIL_getTime */
2016-08-12 14:48:02 +00:00
# include "mem.h"
2017-05-12 23:29:19 +00:00
# define ZSTD_STATIC_LINKING_ONLY /* ZSTD_maxCLevel, ZSTD_customMem, ZSTD_getDictID_fromFrame */
2016-08-12 14:48:02 +00:00
# include "zstd.h" /* ZSTD_compressBound */
2016-12-13 15:39:36 +00:00
# include "zstd_errors.h" /* ZSTD_error_srcSize_wrong */
2017-01-17 03:46:22 +00:00
# include "zdict.h" /* ZDICT_trainFromBuffer */
2016-08-12 14:48:02 +00:00
# include "datagen.h" /* RDG_genBuffer */
2016-09-01 23:44:48 +00:00
# define XXH_STATIC_LINKING_ONLY /* XXH64_state_t */
2016-08-12 14:48:02 +00:00
# include "xxhash.h" /* XXH64_* */
2017-10-17 00:18:43 +00:00
# include "seqgen.h"
2017-11-30 03:11:12 +00:00
# include "util.h"
2019-04-10 19:37:03 +00:00
# include "timefn.h" /* UTIL_time_t, UTIL_clockSpanMicro, UTIL_getTime */
2016-08-12 14:48:02 +00:00
/*-************************************
2018-06-19 02:20:37 +00:00
* Constants
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2016-08-12 14:48:02 +00:00
# define KB *(1U<<10)
# define MB *(1U<<20)
# define GB *(1U<<30)
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
static const int nbTestsDefault = 10000 ;
2017-06-22 06:35:58 +00:00
static const U32 g_cLevelMax_smallTests = 10 ;
2016-08-12 14:48:02 +00:00
# define COMPRESSIBLE_NOISE_LENGTH (10 MB)
# define FUZ_COMPRESSIBILITY_DEFAULT 50
2017-01-17 03:46:22 +00:00
static const U32 prime32 = 2654435761U ;
2016-08-12 14:48:02 +00:00
/*-************************************
2018-06-19 02:20:37 +00:00
* Display Macros
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2016-08-12 14:48:02 +00:00
# define DISPLAY(...) fprintf(stderr, __VA_ARGS__)
2017-05-08 23:08:01 +00:00
# define DISPLAYLEVEL(l, ...) if (g_displayLevel>=l) { \
DISPLAY ( __VA_ARGS__ ) ; \
if ( g_displayLevel > = 4 ) fflush ( stderr ) ; }
2016-08-12 14:48:02 +00:00
static U32 g_displayLevel = 2 ;
2017-11-30 03:11:12 +00:00
static const U64 g_refreshRate = SEC_TO_MICRO / 6 ;
static UTIL_time_t g_displayClock = UTIL_TIME_INITIALIZER ;
2016-08-12 14:48:02 +00:00
# define DISPLAYUPDATE(l, ...) if (g_displayLevel>=l) { \
2017-11-30 03:11:12 +00:00
if ( ( UTIL_clockSpanMicro ( g_displayClock ) > g_refreshRate ) | | ( g_displayLevel > = 4 ) ) \
{ g_displayClock = UTIL_getTime ( ) ; DISPLAY ( __VA_ARGS__ ) ; \
if ( g_displayLevel > = 4 ) fflush ( stderr ) ; } }
2016-08-12 14:48:02 +00:00
2017-11-30 03:11:12 +00:00
static U64 g_clockTime = 0 ;
2016-08-12 14:48:02 +00:00
/*-*******************************************************
2018-06-19 02:20:37 +00:00
* Check macros
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2017-11-30 03:11:12 +00:00
# undef MIN
# undef MAX
# define MIN(a,b) ((a)<(b)?(a):(b))
2016-08-12 14:48:02 +00:00
# define MAX(a,b) ((a)>(b)?(a):(b))
/*! FUZ_rand() :
@ return : a 27 bits random value , from a 32 - bits ` seed ` .
` seed ` is also modified */
2016-10-25 23:19:52 +00:00
# define FUZ_rotl32(x,r) ((x << r) | (x >> (32 - r)))
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
static U32 FUZ_rand ( U32 * seedPtr )
2016-08-12 14:48:02 +00:00
{
2017-01-17 03:46:22 +00:00
static const U32 prime2 = 2246822519U ;
2016-08-12 14:48:02 +00:00
U32 rand32 = * seedPtr ;
2017-01-17 03:46:22 +00:00
rand32 * = prime32 ;
2016-08-12 14:48:02 +00:00
rand32 + = prime2 ;
rand32 = FUZ_rotl32 ( rand32 , 13 ) ;
* seedPtr = rand32 ;
return rand32 > > 5 ;
}
2017-10-17 00:18:43 +00:00
# define CHECK(cond, ...) { \
if ( cond ) { \
DISPLAY ( " Error => " ) ; \
DISPLAY ( __VA_ARGS__ ) ; \
2018-01-23 21:12:40 +00:00
DISPLAY ( " (seed %u, test nb %u, line %u) \n " , \
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
( unsigned ) seed , testNb , __LINE__ ) ; \
2017-09-28 09:14:48 +00:00
goto _output_error ; \
} }
2017-10-17 00:18:43 +00:00
# define CHECK_Z(f) { \
size_t const err = f ; \
CHECK ( ZSTD_isError ( err ) , " %s : %s " , \
# f, ZSTD_getErrorName(err)); \
}
2018-04-25 23:32:29 +00:00
# define CHECK_RET(ret, cond, ...) { \
if ( cond ) { \
DISPLAY ( " Error %llu => " , ( unsigned long long ) ret ) ; \
DISPLAY ( __VA_ARGS__ ) ; \
DISPLAY ( " (line %u) \n " , __LINE__ ) ; \
return ret ; \
} }
# define CHECK_RET_Z(f) { \
size_t const err = f ; \
CHECK_RET ( err , ZSTD_isError ( err ) , " %s : %s " , \
# f, ZSTD_getErrorName(err)); \
}
2016-08-22 22:30:31 +00:00
/*======================================================
2018-06-19 02:20:37 +00:00
* Basic Unit tests
* = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = = */
2016-08-22 22:30:31 +00:00
2017-01-17 03:46:22 +00:00
typedef struct {
void * start ;
size_t size ;
size_t filled ;
} buffer_t ;
2018-09-13 19:29:52 +00:00
static const buffer_t kBuffNull = { NULL , 0 , 0 } ;
static void FUZ_freeDictionary ( buffer_t dict )
{
free ( dict . start ) ;
}
2017-01-17 03:46:22 +00:00
static buffer_t FUZ_createDictionary ( const void * src , size_t srcSize , size_t blockSize , size_t requestedDictSize )
{
2018-09-13 19:29:52 +00:00
buffer_t dict = kBuffNull ;
2017-01-17 03:46:22 +00:00
size_t const nbBlocks = ( srcSize + ( blockSize - 1 ) ) / blockSize ;
2018-09-13 19:29:52 +00:00
size_t * const blockSizes = ( size_t * ) malloc ( nbBlocks * sizeof ( size_t ) ) ;
if ( ! blockSizes ) return kBuffNull ;
2017-01-17 03:46:22 +00:00
dict . start = malloc ( requestedDictSize ) ;
2018-09-13 19:29:52 +00:00
if ( ! dict . start ) { free ( blockSizes ) ; return kBuffNull ; }
2017-01-17 03:46:22 +00:00
{ size_t nb ;
for ( nb = 0 ; nb < nbBlocks - 1 ; nb + + ) blockSizes [ nb ] = blockSize ;
blockSizes [ nbBlocks - 1 ] = srcSize - ( blockSize * ( nbBlocks - 1 ) ) ;
}
{ size_t const dictSize = ZDICT_trainFromBuffer ( dict . start , requestedDictSize , src , blockSizes , ( unsigned ) nbBlocks ) ;
free ( blockSizes ) ;
2018-09-13 19:29:52 +00:00
if ( ZDICT_isError ( dictSize ) ) { FUZ_freeDictionary ( dict ) ; return kBuffNull ; }
2017-01-17 03:46:22 +00:00
dict . size = requestedDictSize ;
dict . filled = dictSize ;
2018-09-13 19:29:52 +00:00
return dict ;
2017-01-17 03:46:22 +00:00
}
}
2017-10-17 00:18:43 +00:00
/* Round trips data and updates xxh with the decompressed data produced */
static size_t SEQ_roundTrip ( ZSTD_CCtx * cctx , ZSTD_DCtx * dctx ,
XXH64_state_t * xxh , void * data , size_t size ,
ZSTD_EndDirective endOp )
{
static BYTE compressed [ 1024 ] ;
static BYTE uncompressed [ 1024 ] ;
ZSTD_inBuffer cin = { data , size , 0 } ;
size_t cret ;
do {
2018-11-30 19:16:26 +00:00
ZSTD_outBuffer cout = { compressed , sizeof ( compressed ) , 0 } ;
ZSTD_inBuffer din = { compressed , 0 , 0 } ;
ZSTD_outBuffer dout = { uncompressed , 0 , 0 } ;
2017-10-17 00:18:43 +00:00
2018-11-30 19:16:26 +00:00
cret = ZSTD_compressStream2 ( cctx , & cout , & cin , endOp ) ;
2017-10-17 00:18:43 +00:00
if ( ZSTD_isError ( cret ) )
return cret ;
din . size = cout . pos ;
while ( din . pos < din . size | | ( endOp = = ZSTD_e_end & & cret = = 0 ) ) {
size_t dret ;
dout . pos = 0 ;
dout . size = sizeof ( uncompressed ) ;
dret = ZSTD_decompressStream ( dctx , & dout , & din ) ;
if ( ZSTD_isError ( dret ) )
return dret ;
XXH64_update ( xxh , dout . dst , dout . pos ) ;
if ( dret = = 0 )
break ;
}
} while ( cin . pos < cin . size | | ( endOp ! = ZSTD_e_continue & & cret ! = 0 ) ) ;
return 0 ;
}
/* Generates some data and round trips it */
static size_t SEQ_generateRoundTrip ( ZSTD_CCtx * cctx , ZSTD_DCtx * dctx ,
XXH64_state_t * xxh , SEQ_stream * seq ,
SEQ_gen_type type , unsigned value )
{
static BYTE data [ 1024 ] ;
size_t gen ;
do {
SEQ_outBuffer sout = { data , sizeof ( data ) , 0 } ;
size_t ret ;
gen = SEQ_gen ( seq , type , value , & sout ) ;
ret = SEQ_roundTrip ( cctx , dctx , xxh , sout . dst , sout . pos , ZSTD_e_continue ) ;
if ( ZSTD_isError ( ret ) )
return ret ;
} while ( gen ! = 0 ) ;
return 0 ;
}
2017-01-17 03:46:22 +00:00
2018-04-25 23:32:29 +00:00
static size_t getCCtxParams ( ZSTD_CCtx * zc , ZSTD_parameters * savedParams )
{
2018-11-21 23:37:26 +00:00
int value ;
2018-12-06 01:26:02 +00:00
CHECK_RET_Z ( ZSTD_CCtx_getParameter ( zc , ZSTD_c_windowLog , ( int * ) & savedParams - > cParams . windowLog ) ) ;
CHECK_RET_Z ( ZSTD_CCtx_getParameter ( zc , ZSTD_c_hashLog , ( int * ) & savedParams - > cParams . hashLog ) ) ;
CHECK_RET_Z ( ZSTD_CCtx_getParameter ( zc , ZSTD_c_chainLog , ( int * ) & savedParams - > cParams . chainLog ) ) ;
CHECK_RET_Z ( ZSTD_CCtx_getParameter ( zc , ZSTD_c_searchLog , ( int * ) & savedParams - > cParams . searchLog ) ) ;
CHECK_RET_Z ( ZSTD_CCtx_getParameter ( zc , ZSTD_c_minMatch , ( int * ) & savedParams - > cParams . minMatch ) ) ;
CHECK_RET_Z ( ZSTD_CCtx_getParameter ( zc , ZSTD_c_targetLength , ( int * ) & savedParams - > cParams . targetLength ) ) ;
2018-12-06 23:00:52 +00:00
CHECK_RET_Z ( ZSTD_CCtx_getParameter ( zc , ZSTD_c_strategy , & value ) ) ;
2018-04-25 23:32:29 +00:00
savedParams - > cParams . strategy = value ;
2018-12-06 01:26:02 +00:00
CHECK_RET_Z ( ZSTD_CCtx_getParameter ( zc , ZSTD_c_checksumFlag , & savedParams - > fParams . checksumFlag ) ) ;
CHECK_RET_Z ( ZSTD_CCtx_getParameter ( zc , ZSTD_c_contentSizeFlag , & savedParams - > fParams . contentSizeFlag ) ) ;
CHECK_RET_Z ( ZSTD_CCtx_getParameter ( zc , ZSTD_c_dictIDFlag , & value ) ) ;
2018-04-25 23:32:29 +00:00
savedParams - > fParams . noDictIDFlag = ! value ;
return 0 ;
}
static U32 badParameters ( ZSTD_CCtx * zc , ZSTD_parameters const savedParams )
{
ZSTD_parameters params ;
if ( ZSTD_isError ( getCCtxParams ( zc , & params ) ) ) return 10 ;
CHECK_RET ( 1 , params . cParams . windowLog ! = savedParams . cParams . windowLog , " windowLog " ) ;
CHECK_RET ( 2 , params . cParams . hashLog ! = savedParams . cParams . hashLog , " hashLog " ) ;
CHECK_RET ( 3 , params . cParams . chainLog ! = savedParams . cParams . chainLog , " chainLog " ) ;
CHECK_RET ( 4 , params . cParams . searchLog ! = savedParams . cParams . searchLog , " searchLog " ) ;
2018-11-20 22:56:07 +00:00
CHECK_RET ( 5 , params . cParams . minMatch ! = savedParams . cParams . minMatch , " minMatch " ) ;
2018-04-25 23:32:29 +00:00
CHECK_RET ( 6 , params . cParams . targetLength ! = savedParams . cParams . targetLength , " targetLength " ) ;
CHECK_RET ( 7 , params . fParams . checksumFlag ! = savedParams . fParams . checksumFlag , " checksumFlag " ) ;
CHECK_RET ( 8 , params . fParams . contentSizeFlag ! = savedParams . fParams . contentSizeFlag , " contentSizeFlag " ) ;
CHECK_RET ( 9 , params . fParams . noDictIDFlag ! = savedParams . fParams . noDictIDFlag , " noDictIDFlag " ) ;
return 0 ;
}
2017-11-27 20:15:23 +00:00
static int basicUnitTests ( U32 seed , double compressibility )
2016-08-12 14:48:02 +00:00
{
2016-09-09 14:44:16 +00:00
size_t const CNBufferSize = COMPRESSIBLE_NOISE_LENGTH ;
2016-08-12 14:48:02 +00:00
void * CNBuffer = malloc ( CNBufferSize ) ;
2017-11-01 20:10:03 +00:00
size_t const skippableFrameSize = 200 KB ;
2016-08-12 14:48:02 +00:00
size_t const compressedBufferSize = ( 8 + skippableFrameSize ) + ZSTD_compressBound ( COMPRESSIBLE_NOISE_LENGTH ) ;
void * compressedBuffer = malloc ( compressedBufferSize ) ;
size_t const decodedBufferSize = CNBufferSize ;
void * decodedBuffer = malloc ( decodedBufferSize ) ;
size_t cSize ;
2016-09-09 14:44:16 +00:00
int testResult = 0 ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
int testNb = 1 ;
2018-01-20 06:11:11 +00:00
U32 coreSeed = 0 ; /* this name to conform with CHECK_Z macro display */
2017-11-27 20:15:23 +00:00
ZSTD_CStream * zc = ZSTD_createCStream ( ) ;
ZSTD_DStream * zd = ZSTD_createDStream ( ) ;
2020-10-02 01:47:54 +00:00
ZSTD_CCtx * mtctx = ZSTD_createCCtx ( ) ;
2017-08-30 21:36:54 +00:00
2016-12-03 02:37:38 +00:00
ZSTD_inBuffer inBuff , inBuff2 ;
2016-08-16 23:39:22 +00:00
ZSTD_outBuffer outBuff ;
2018-09-13 19:29:52 +00:00
buffer_t dictionary = kBuffNull ;
2017-05-10 18:30:19 +00:00
size_t const dictSize = 128 KB ;
2017-01-17 03:46:22 +00:00
unsigned dictID = 0 ;
2016-08-12 14:48:02 +00:00
/* Create compressible test buffer */
2020-10-02 01:47:54 +00:00
if ( ! CNBuffer | | ! compressedBuffer | | ! decodedBuffer | | ! zc | | ! zd | | ! mtctx ) {
2017-01-17 03:46:22 +00:00
DISPLAY ( " Not enough memory, aborting \n " ) ;
2016-08-12 14:48:02 +00:00
goto _output_error ;
}
RDG_genBuffer ( CNBuffer , CNBufferSize , compressibility , 0. , seed ) ;
2020-10-02 01:47:54 +00:00
CHECK_Z ( ZSTD_CCtx_setParameter ( mtctx , ZSTD_c_nbWorkers , 2 ) ) ;
2017-01-17 03:46:22 +00:00
/* Create dictionary */
2017-09-29 01:34:38 +00:00
DISPLAYLEVEL ( 3 , " creating dictionary for unit tests \n " ) ;
2018-03-20 23:18:48 +00:00
dictionary = FUZ_createDictionary ( CNBuffer , CNBufferSize / 3 , 16 KB , 48 KB ) ;
2017-01-17 03:46:22 +00:00
if ( ! dictionary . start ) {
DISPLAY ( " Error creating dictionary, aborting \n " ) ;
goto _output_error ;
}
dictID = ZDICT_getDictID ( dictionary . start , dictionary . filled ) ;
2017-12-07 08:06:01 +00:00
/* Basic compression test */
DISPLAYLEVEL ( 3 , " test%3i : compress %u bytes : " , testNb + + , COMPRESSIBLE_NOISE_LENGTH ) ;
CHECK_Z ( ZSTD_initCStream ( zc , 1 /* cLevel */ ) ) ;
outBuff . dst = ( char * ) ( compressedBuffer ) ;
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
inBuff . src = CNBuffer ;
inBuff . size = CNBufferSize ;
inBuff . pos = 0 ;
CHECK_Z ( ZSTD_compressStream ( zc , & outBuff , & inBuff ) ) ;
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* entire input should be consumed */
{ size_t const r = ZSTD_endStream ( zc , & outBuff ) ;
if ( r ! = 0 ) goto _output_error ; } /* error, or some data not flushed */
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 3 , " OK (%u bytes) \n " , ( unsigned ) outBuff . pos ) ;
2017-12-07 08:06:01 +00:00
2016-08-12 14:48:02 +00:00
/* generate skippable frame */
MEM_writeLE32 ( compressedBuffer , ZSTD_MAGIC_SKIPPABLE_START ) ;
MEM_writeLE32 ( ( ( char * ) compressedBuffer ) + 4 , ( U32 ) skippableFrameSize ) ;
cSize = skippableFrameSize + 8 ;
2017-12-07 08:06:01 +00:00
/* Basic compression test using dict */
DISPLAYLEVEL ( 3 , " test%3i : skipframe + compress %u bytes : " , testNb + + , COMPRESSIBLE_NOISE_LENGTH ) ;
2017-10-14 01:32:06 +00:00
CHECK_Z ( ZSTD_initCStream_usingDict ( zc , CNBuffer , dictSize , 1 /* cLevel */ ) ) ;
2016-08-16 23:39:22 +00:00
outBuff . dst = ( char * ) ( compressedBuffer ) + cSize ;
2017-10-14 01:32:06 +00:00
assert ( compressedBufferSize > cSize ) ;
outBuff . size = compressedBufferSize - cSize ;
2016-08-16 23:39:22 +00:00
outBuff . pos = 0 ;
inBuff . src = CNBuffer ;
inBuff . size = CNBufferSize ;
inBuff . pos = 0 ;
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_compressStream ( zc , & outBuff , & inBuff ) ) ;
2016-08-16 23:39:22 +00:00
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* entire input should be consumed */
{ size_t const r = ZSTD_endStream ( zc , & outBuff ) ;
2016-08-26 07:05:06 +00:00
if ( r ! = 0 ) goto _output_error ; } /* error, or some data not flushed */
2016-08-16 23:39:22 +00:00
cSize + = outBuff . pos ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 3 , " OK (%u bytes : %.2f%%) \n " ,
( unsigned ) cSize , ( double ) cSize / COMPRESSIBLE_NOISE_LENGTH * 100 ) ;
2016-08-12 14:48:02 +00:00
2017-05-10 18:30:19 +00:00
/* context size functions */
DISPLAYLEVEL ( 3 , " test%3i : estimate CStream size : " , testNb + + ) ;
{ ZSTD_compressionParameters const cParams = ZSTD_getCParams ( 1 , CNBufferSize , dictSize ) ;
2017-09-24 23:47:02 +00:00
size_t const cstreamSize = ZSTD_estimateCStreamSize_usingCParams ( cParams ) ;
size_t const cdictSize = ZSTD_estimateCDictSize_advanced ( dictSize , cParams , ZSTD_dlm_byCopy ) ; /* uses ZSTD_initCStream_usingDict() */
if ( ZSTD_isError ( cstreamSize ) ) goto _output_error ;
if ( ZSTD_isError ( cdictSize ) ) goto _output_error ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 3 , " OK (%u bytes) \n " , ( unsigned ) ( cstreamSize + cdictSize ) ) ;
2017-05-10 18:30:19 +00:00
}
2019-04-02 00:51:28 +00:00
/* context size functions */
DISPLAYLEVEL ( 3 , " test%3i : estimate CStream size using CCtxParams : " , testNb + + ) ;
{ ZSTD_CCtx_params * const params = ZSTD_createCCtxParams ( ) ;
size_t cstreamSize , cctxSize ;
CHECK_Z ( ZSTD_CCtxParams_setParameter ( params , ZSTD_c_compressionLevel , 19 ) ) ;
cstreamSize = ZSTD_estimateCStreamSize_usingCCtxParams ( params ) ;
CHECK_Z ( cstreamSize ) ;
cctxSize = ZSTD_estimateCCtxSize_usingCCtxParams ( params ) ;
CHECK_Z ( cctxSize ) ;
if ( cstreamSize < = cctxSize + 2 * ZSTD_BLOCKSIZE_MAX ) goto _output_error ;
ZSTD_freeCCtxParams ( params ) ;
DISPLAYLEVEL ( 3 , " OK \n " ) ;
}
2017-05-10 18:30:19 +00:00
DISPLAYLEVEL ( 3 , " test%3i : check actual CStream size : " , testNb + + ) ;
2017-06-21 22:53:42 +00:00
{ size_t const s = ZSTD_sizeof_CStream ( zc ) ;
if ( ZSTD_isError ( s ) ) goto _output_error ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 3 , " OK (%u bytes) \n " , ( unsigned ) s ) ;
2016-08-22 22:30:31 +00:00
}
2017-04-11 00:50:44 +00:00
/* Attempt bad compression parameters */
DISPLAYLEVEL ( 3 , " test%3i : use bad compression parameters : " , testNb + + ) ;
{ size_t r ;
ZSTD_parameters params = ZSTD_getParams ( 1 , 0 , 0 ) ;
2018-11-20 22:56:07 +00:00
params . cParams . minMatch = 2 ;
2017-04-11 00:50:44 +00:00
r = ZSTD_initCStream_advanced ( zc , NULL , 0 , params , 0 ) ;
if ( ! ZSTD_isError ( r ) ) goto _output_error ;
DISPLAYLEVEL ( 3 , " init error : %s \n " , ZSTD_getErrorName ( r ) ) ;
}
2016-08-12 14:48:02 +00:00
/* skippable frame test */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " test%3i : decompress skippable frame : " , testNb + + ) ;
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_initDStream_usingDict ( zd , CNBuffer , dictSize ) ) ;
2016-08-16 23:39:22 +00:00
inBuff . src = compressedBuffer ;
inBuff . size = cSize ;
inBuff . pos = 0 ;
outBuff . dst = decodedBuffer ;
outBuff . size = CNBufferSize ;
outBuff . pos = 0 ;
2017-06-21 22:53:42 +00:00
{ size_t const r = ZSTD_decompressStream ( zd , & outBuff , & inBuff ) ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 5 , " ( ZSTD_decompressStream => %u ) " , ( unsigned ) r ) ;
2017-06-21 22:53:42 +00:00
if ( r ! = 0 ) goto _output_error ;
}
2017-02-28 09:15:28 +00:00
if ( outBuff . pos ! = 0 ) goto _output_error ; /* skippable frame output len is 0 */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2016-08-12 14:48:02 +00:00
/* Basic decompression test */
2016-12-03 02:37:38 +00:00
inBuff2 = inBuff ;
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " test%3i : decompress %u bytes : " , testNb + + , COMPRESSIBLE_NOISE_LENGTH ) ;
2017-05-10 18:30:19 +00:00
ZSTD_initDStream_usingDict ( zd , CNBuffer , dictSize ) ;
2018-12-05 01:30:58 +00:00
CHECK_Z ( ZSTD_DCtx_setParameter ( zd , ZSTD_d_windowLogMax , ZSTD_WINDOWLOG_LIMIT_DEFAULT + 1 ) ) ; /* large limit */
2016-12-03 02:37:38 +00:00
{ size_t const remaining = ZSTD_decompressStream ( zd , & outBuff , & inBuff ) ;
if ( remaining ! = 0 ) goto _output_error ; } /* should reach end of frame == 0; otherwise, some data left, or an error */
if ( outBuff . pos ! = CNBufferSize ) goto _output_error ; /* should regenerate the same amount */
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* should have read the entire frame */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2016-12-03 02:37:38 +00:00
/* Re-use without init */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " test%3i : decompress again without init (re-use previous settings): " , testNb + + ) ;
2016-12-03 02:37:38 +00:00
outBuff . pos = 0 ;
{ size_t const remaining = ZSTD_decompressStream ( zd , & outBuff , & inBuff2 ) ;
if ( remaining ! = 0 ) goto _output_error ; } /* should reach end of frame == 0; otherwise, some data left, or an error */
2016-08-16 23:39:22 +00:00
if ( outBuff . pos ! = CNBufferSize ) goto _output_error ; /* should regenerate the same amount */
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* should have read the entire frame */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2016-08-12 14:48:02 +00:00
/* check regenerated data is byte exact */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " test%3i : check decompressed result : " , testNb + + ) ;
2016-08-12 14:48:02 +00:00
{ size_t i ;
for ( i = 0 ; i < CNBufferSize ; i + + ) {
if ( ( ( BYTE * ) decodedBuffer ) [ i ] ! = ( ( BYTE * ) CNBuffer ) [ i ] ) goto _output_error ;
} }
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2016-08-12 14:48:02 +00:00
2017-05-09 23:18:17 +00:00
/* context size functions */
DISPLAYLEVEL ( 3 , " test%3i : estimate DStream size : " , testNb + + ) ;
{ ZSTD_frameHeader fhi ;
const void * cStart = ( char * ) compressedBuffer + ( skippableFrameSize + 8 ) ;
size_t const gfhError = ZSTD_getFrameHeader ( & fhi , cStart , cSize ) ;
if ( gfhError ! = 0 ) goto _output_error ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 5 , " (windowSize : %u) " , ( unsigned ) fhi . windowSize ) ;
2017-06-27 00:44:26 +00:00
{ size_t const s = ZSTD_estimateDStreamSize ( fhi . windowSize )
2017-05-25 22:07:37 +00:00
/* uses ZSTD_initDStream_usingDict() */
2017-08-29 18:55:02 +00:00
+ ZSTD_estimateDDictSize ( dictSize , ZSTD_dlm_byCopy ) ;
2017-05-09 23:18:17 +00:00
if ( ZSTD_isError ( s ) ) goto _output_error ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 3 , " OK (%u bytes) \n " , ( unsigned ) s ) ;
2017-05-09 23:18:17 +00:00
} }
DISPLAYLEVEL ( 3 , " test%3i : check actual DStream size : " , testNb + + ) ;
2016-08-22 23:18:06 +00:00
{ size_t const s = ZSTD_sizeof_DStream ( zd ) ;
2016-08-22 22:30:31 +00:00
if ( ZSTD_isError ( s ) ) goto _output_error ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 3 , " OK (%u bytes) \n " , ( unsigned ) s ) ;
2016-08-22 22:30:31 +00:00
}
2018-01-20 06:11:11 +00:00
/* Decompression by small increment */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " test%3i : decompress byte-by-byte : " , testNb + + ) ;
2016-09-14 15:26:59 +00:00
{ /* skippable frame */
size_t r = 1 ;
2017-05-10 18:30:19 +00:00
ZSTD_initDStream_usingDict ( zd , CNBuffer , dictSize ) ;
2016-08-16 23:39:22 +00:00
inBuff . src = compressedBuffer ;
outBuff . dst = decodedBuffer ;
inBuff . pos = 0 ;
outBuff . pos = 0 ;
2016-08-12 14:48:02 +00:00
while ( r ) { /* skippable frame */
error on no forward progress
streaming decoders, such as ZSTD_decompressStream() or ZSTD_decompress_generic(),
may end up making no forward progress,
(aka no byte read from input __and__ no byte written to output),
due to unusual parameters conditions,
such as providing an output buffer already full.
In such case, the caller may be caught in an infinite loop,
calling the streaming decompression function again and again,
without making any progress.
This version detects such situation, and generates an error instead :
ZSTD_error_dstSize_tooSmall when output buffer is full,
ZSTD_error_srcSize_wrong when input buffer is empty.
The detection tolerates a number of attempts before triggering an error,
controlled by ZSTD_NO_FORWARD_PROGRESS_MAX macro constant,
which is set to 16 by default, and can be re-defined at compilation time.
This behavior tolerates potentially existing implementations
where such cases happen sporadically, like once or twice,
which is not dangerous (only infinite loops are),
without generating an error, hence without breaking these implementations.
2018-06-23 00:58:21 +00:00
size_t const inSize = ( FUZ_rand ( & coreSeed ) & 15 ) + 1 ;
size_t const outSize = ( FUZ_rand ( & coreSeed ) & 15 ) + 1 ;
2018-01-20 06:11:11 +00:00
inBuff . size = inBuff . pos + inSize ;
outBuff . size = outBuff . pos + outSize ;
2016-08-16 23:39:22 +00:00
r = ZSTD_decompressStream ( zd , & outBuff , & inBuff ) ;
error on no forward progress
streaming decoders, such as ZSTD_decompressStream() or ZSTD_decompress_generic(),
may end up making no forward progress,
(aka no byte read from input __and__ no byte written to output),
due to unusual parameters conditions,
such as providing an output buffer already full.
In such case, the caller may be caught in an infinite loop,
calling the streaming decompression function again and again,
without making any progress.
This version detects such situation, and generates an error instead :
ZSTD_error_dstSize_tooSmall when output buffer is full,
ZSTD_error_srcSize_wrong when input buffer is empty.
The detection tolerates a number of attempts before triggering an error,
controlled by ZSTD_NO_FORWARD_PROGRESS_MAX macro constant,
which is set to 16 by default, and can be re-defined at compilation time.
This behavior tolerates potentially existing implementations
where such cases happen sporadically, like once or twice,
which is not dangerous (only infinite loops are),
without generating an error, hence without breaking these implementations.
2018-06-23 00:58:21 +00:00
if ( ZSTD_isError ( r ) ) DISPLAYLEVEL ( 4 , " ZSTD_decompressStream on skippable frame error : %s \n " , ZSTD_getErrorName ( r ) ) ;
2016-08-12 14:48:02 +00:00
if ( ZSTD_isError ( r ) ) goto _output_error ;
}
2016-09-14 15:26:59 +00:00
/* normal frame */
2017-05-10 18:30:19 +00:00
ZSTD_initDStream_usingDict ( zd , CNBuffer , dictSize ) ;
2016-08-12 14:48:02 +00:00
r = 1 ;
2016-09-14 15:26:59 +00:00
while ( r ) {
2018-01-20 06:11:11 +00:00
size_t const inSize = FUZ_rand ( & coreSeed ) & 15 ;
error on no forward progress
streaming decoders, such as ZSTD_decompressStream() or ZSTD_decompress_generic(),
may end up making no forward progress,
(aka no byte read from input __and__ no byte written to output),
due to unusual parameters conditions,
such as providing an output buffer already full.
In such case, the caller may be caught in an infinite loop,
calling the streaming decompression function again and again,
without making any progress.
This version detects such situation, and generates an error instead :
ZSTD_error_dstSize_tooSmall when output buffer is full,
ZSTD_error_srcSize_wrong when input buffer is empty.
The detection tolerates a number of attempts before triggering an error,
controlled by ZSTD_NO_FORWARD_PROGRESS_MAX macro constant,
which is set to 16 by default, and can be re-defined at compilation time.
This behavior tolerates potentially existing implementations
where such cases happen sporadically, like once or twice,
which is not dangerous (only infinite loops are),
without generating an error, hence without breaking these implementations.
2018-06-23 00:58:21 +00:00
size_t const outSize = ( FUZ_rand ( & coreSeed ) & 15 ) + ( ! inSize ) ; /* avoid having both sizes at 0 => would trigger a no_forward_progress error */
2018-01-20 06:11:11 +00:00
inBuff . size = inBuff . pos + inSize ;
outBuff . size = outBuff . pos + outSize ;
2016-08-16 23:39:22 +00:00
r = ZSTD_decompressStream ( zd , & outBuff , & inBuff ) ;
error on no forward progress
streaming decoders, such as ZSTD_decompressStream() or ZSTD_decompress_generic(),
may end up making no forward progress,
(aka no byte read from input __and__ no byte written to output),
due to unusual parameters conditions,
such as providing an output buffer already full.
In such case, the caller may be caught in an infinite loop,
calling the streaming decompression function again and again,
without making any progress.
This version detects such situation, and generates an error instead :
ZSTD_error_dstSize_tooSmall when output buffer is full,
ZSTD_error_srcSize_wrong when input buffer is empty.
The detection tolerates a number of attempts before triggering an error,
controlled by ZSTD_NO_FORWARD_PROGRESS_MAX macro constant,
which is set to 16 by default, and can be re-defined at compilation time.
This behavior tolerates potentially existing implementations
where such cases happen sporadically, like once or twice,
which is not dangerous (only infinite loops are),
without generating an error, hence without breaking these implementations.
2018-06-23 00:58:21 +00:00
if ( ZSTD_isError ( r ) ) DISPLAYLEVEL ( 4 , " ZSTD_decompressStream error : %s \n " , ZSTD_getErrorName ( r ) ) ;
2016-08-12 14:48:02 +00:00
if ( ZSTD_isError ( r ) ) goto _output_error ;
}
}
error on no forward progress
streaming decoders, such as ZSTD_decompressStream() or ZSTD_decompress_generic(),
may end up making no forward progress,
(aka no byte read from input __and__ no byte written to output),
due to unusual parameters conditions,
such as providing an output buffer already full.
In such case, the caller may be caught in an infinite loop,
calling the streaming decompression function again and again,
without making any progress.
This version detects such situation, and generates an error instead :
ZSTD_error_dstSize_tooSmall when output buffer is full,
ZSTD_error_srcSize_wrong when input buffer is empty.
The detection tolerates a number of attempts before triggering an error,
controlled by ZSTD_NO_FORWARD_PROGRESS_MAX macro constant,
which is set to 16 by default, and can be re-defined at compilation time.
This behavior tolerates potentially existing implementations
where such cases happen sporadically, like once or twice,
which is not dangerous (only infinite loops are),
without generating an error, hence without breaking these implementations.
2018-06-23 00:58:21 +00:00
if ( outBuff . pos ! = CNBufferSize ) DISPLAYLEVEL ( 4 , " outBuff.pos != CNBufferSize : should have regenerated same amount ! \n " ) ;
2016-08-16 23:39:22 +00:00
if ( outBuff . pos ! = CNBufferSize ) goto _output_error ; /* should regenerate the same amount */
error on no forward progress
streaming decoders, such as ZSTD_decompressStream() or ZSTD_decompress_generic(),
may end up making no forward progress,
(aka no byte read from input __and__ no byte written to output),
due to unusual parameters conditions,
such as providing an output buffer already full.
In such case, the caller may be caught in an infinite loop,
calling the streaming decompression function again and again,
without making any progress.
This version detects such situation, and generates an error instead :
ZSTD_error_dstSize_tooSmall when output buffer is full,
ZSTD_error_srcSize_wrong when input buffer is empty.
The detection tolerates a number of attempts before triggering an error,
controlled by ZSTD_NO_FORWARD_PROGRESS_MAX macro constant,
which is set to 16 by default, and can be re-defined at compilation time.
This behavior tolerates potentially existing implementations
where such cases happen sporadically, like once or twice,
which is not dangerous (only infinite loops are),
without generating an error, hence without breaking these implementations.
2018-06-23 00:58:21 +00:00
if ( inBuff . pos ! = cSize ) DISPLAYLEVEL ( 4 , " inBuff.pos != cSize : should have real all input ! \n " ) ;
2016-08-16 23:39:22 +00:00
if ( inBuff . pos ! = cSize ) goto _output_error ; /* should have read the entire frame */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2016-08-12 14:48:02 +00:00
/* check regenerated data is byte exact */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " test%3i : check decompressed result : " , testNb + + ) ;
2016-08-12 14:48:02 +00:00
{ size_t i ;
for ( i = 0 ; i < CNBufferSize ; i + + ) {
2019-08-16 01:17:06 +00:00
if ( ( ( BYTE * ) decodedBuffer ) [ i ] ! = ( ( BYTE * ) CNBuffer ) [ i ] ) goto _output_error ;
2016-08-12 14:48:02 +00:00
} }
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2016-08-12 14:48:02 +00:00
error on no forward progress
streaming decoders, such as ZSTD_decompressStream() or ZSTD_decompress_generic(),
may end up making no forward progress,
(aka no byte read from input __and__ no byte written to output),
due to unusual parameters conditions,
such as providing an output buffer already full.
In such case, the caller may be caught in an infinite loop,
calling the streaming decompression function again and again,
without making any progress.
This version detects such situation, and generates an error instead :
ZSTD_error_dstSize_tooSmall when output buffer is full,
ZSTD_error_srcSize_wrong when input buffer is empty.
The detection tolerates a number of attempts before triggering an error,
controlled by ZSTD_NO_FORWARD_PROGRESS_MAX macro constant,
which is set to 16 by default, and can be re-defined at compilation time.
This behavior tolerates potentially existing implementations
where such cases happen sporadically, like once or twice,
which is not dangerous (only infinite loops are),
without generating an error, hence without breaking these implementations.
2018-06-23 00:58:21 +00:00
/* Decompression forward progress */
DISPLAYLEVEL ( 3 , " test%3i : generate error when ZSTD_decompressStream() doesn't progress : " , testNb + + ) ;
{ /* skippable frame */
size_t r = 0 ;
int decNb = 0 ;
int const maxDec = 100 ;
inBuff . src = compressedBuffer ;
inBuff . size = cSize ;
inBuff . pos = 0 ;
outBuff . dst = decodedBuffer ;
outBuff . pos = 0 ;
outBuff . size = CNBufferSize - 1 ; /* 1 byte missing */
for ( decNb = 0 ; decNb < maxDec ; decNb + + ) {
if ( r = = 0 ) ZSTD_initDStream_usingDict ( zd , CNBuffer , dictSize ) ;
r = ZSTD_decompressStream ( zd , & outBuff , & inBuff ) ;
if ( ZSTD_isError ( r ) ) break ;
}
if ( ! ZSTD_isError ( r ) ) DISPLAYLEVEL ( 4 , " ZSTD_decompressStream should have triggered a no_forward_progress error \n " ) ;
if ( ! ZSTD_isError ( r ) ) goto _output_error ; /* should have triggered no_forward_progress error */
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2019-11-21 02:21:51 +00:00
DISPLAYLEVEL ( 3 , " test%3i : NULL buffers : " , testNb + + ) ;
inBuff . src = NULL ;
inBuff . size = 0 ;
inBuff . pos = 0 ;
outBuff . dst = NULL ;
outBuff . size = 0 ;
outBuff . pos = 0 ;
CHECK_Z ( ZSTD_compressStream ( zc , & outBuff , & inBuff ) ) ;
CHECK ( inBuff . pos ! = inBuff . size , " Entire input should be consumed " ) ;
CHECK_Z ( ZSTD_endStream ( zc , & outBuff ) ) ;
outBuff . dst = ( char * ) ( compressedBuffer ) ;
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
{ size_t const r = ZSTD_endStream ( zc , & outBuff ) ;
CHECK ( r ! = 0 , " Error or some data not flushed (ret=%zu) " , r ) ;
}
inBuff . src = outBuff . dst ;
inBuff . size = outBuff . pos ;
inBuff . pos = 0 ;
outBuff . dst = NULL ;
outBuff . size = 0 ;
outBuff . pos = 0 ;
CHECK_Z ( ZSTD_initDStream ( zd ) ) ;
{ size_t const ret = ZSTD_decompressStream ( zd , & outBuff , & inBuff ) ;
if ( ret ! = 0 ) goto _output_error ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2016-12-13 15:39:36 +00:00
/* _srcSize compression test */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " test%3i : compress_srcSize %u bytes : " , testNb + + , COMPRESSIBLE_NOISE_LENGTH ) ;
2019-03-13 21:05:18 +00:00
CHECK_Z ( ZSTD_initCStream_srcSize ( zc , 1 , CNBufferSize ) ) ;
2016-12-18 20:39:15 +00:00
outBuff . dst = ( char * ) ( compressedBuffer ) ;
2016-12-13 15:39:36 +00:00
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
inBuff . src = CNBuffer ;
inBuff . size = CNBufferSize ;
inBuff . pos = 0 ;
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_compressStream ( zc , & outBuff , & inBuff ) ) ;
2019-03-13 21:05:18 +00:00
CHECK ( inBuff . pos ! = inBuff . size , " Entire input should be consumed " ) ;
{ size_t const r = ZSTD_endStream ( zc , & outBuff ) ;
CHECK ( r ! = 0 , " Error or some data not flushed (ret=%zu) " , r ) ;
}
{ unsigned long long origSize = ZSTD_findDecompressedSize ( outBuff . dst , outBuff . pos ) ;
CHECK ( origSize = = ZSTD_CONTENTSIZE_UNKNOWN , " Unknown! " ) ;
CHECK ( ( size_t ) origSize ! = CNBufferSize , " Exact original size must be present (got %llu) " , origSize ) ;
}
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 3 , " OK (%u bytes : %.2f%%) \n " , ( unsigned ) cSize , ( double ) cSize / COMPRESSIBLE_NOISE_LENGTH * 100 ) ;
2016-12-13 15:39:36 +00:00
/* wrong _srcSize compression test */
2018-02-01 20:04:05 +00:00
DISPLAYLEVEL ( 3 , " test%3i : too large srcSize : %u bytes : " , testNb + + , COMPRESSIBLE_NOISE_LENGTH - 1 ) ;
ZSTD_initCStream_srcSize ( zc , 1 , CNBufferSize + 1 ) ;
2016-12-18 20:39:15 +00:00
outBuff . dst = ( char * ) ( compressedBuffer ) ;
2016-12-13 15:39:36 +00:00
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
inBuff . src = CNBuffer ;
inBuff . size = CNBufferSize ;
inBuff . pos = 0 ;
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_compressStream ( zc , & outBuff , & inBuff ) ) ;
2016-12-13 15:39:36 +00:00
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* entire input should be consumed */
{ size_t const r = ZSTD_endStream ( zc , & outBuff ) ;
if ( ZSTD_getErrorCode ( r ) ! = ZSTD_error_srcSize_wrong ) goto _output_error ; /* must fail : wrong srcSize */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " OK (error detected : %s) \n " , ZSTD_getErrorName ( r ) ) ; }
2016-12-13 15:39:36 +00:00
2018-02-01 20:04:05 +00:00
/* wrong _srcSize compression test */
DISPLAYLEVEL ( 3 , " test%3i : too small srcSize : %u bytes : " , testNb + + , COMPRESSIBLE_NOISE_LENGTH - 1 ) ;
ZSTD_initCStream_srcSize ( zc , 1 , CNBufferSize - 1 ) ;
outBuff . dst = ( char * ) ( compressedBuffer ) ;
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
inBuff . src = CNBuffer ;
inBuff . size = CNBufferSize ;
inBuff . pos = 0 ;
{ size_t const r = ZSTD_compressStream ( zc , & outBuff , & inBuff ) ;
if ( ZSTD_getErrorCode ( r ) ! = ZSTD_error_srcSize_wrong ) goto _output_error ; /* must fail : wrong srcSize */
DISPLAYLEVEL ( 3 , " OK (error detected : %s) \n " , ZSTD_getErrorName ( r ) ) ;
}
2018-04-12 23:02:03 +00:00
DISPLAYLEVEL ( 3 , " test%3i : wrong srcSize !contentSizeFlag : %u bytes : " , testNb + + , COMPRESSIBLE_NOISE_LENGTH - 1 ) ;
{ ZSTD_parameters params = ZSTD_getParams ( 1 , CNBufferSize , 0 ) ;
params . fParams . contentSizeFlag = 0 ;
CHECK_Z ( ZSTD_initCStream_advanced ( zc , NULL , 0 , params , CNBufferSize - MIN ( CNBufferSize , 200 KB ) ) ) ;
outBuff . dst = ( char * ) compressedBuffer ;
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
inBuff . src = CNBuffer ;
inBuff . size = CNBufferSize ;
inBuff . pos = 0 ;
{ size_t const r = ZSTD_compressStream ( zc , & outBuff , & inBuff ) ;
if ( ZSTD_getErrorCode ( r ) ! = ZSTD_error_srcSize_wrong ) goto _output_error ; /* must fail : wrong srcSize */
DISPLAYLEVEL ( 3 , " OK (error detected : %s) \n " , ZSTD_getErrorName ( r ) ) ;
} }
2016-09-06 13:01:51 +00:00
/* Complex context re-use scenario */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " test%3i : context re-use : " , testNb + + ) ;
2016-09-06 13:01:51 +00:00
ZSTD_freeCStream ( zc ) ;
2017-11-27 20:15:23 +00:00
zc = ZSTD_createCStream ( ) ;
2016-09-06 13:01:51 +00:00
if ( zc = = NULL ) goto _output_error ; /* memory allocation issue */
/* use 1 */
{ size_t const inSize = 513 ;
2017-05-08 23:08:01 +00:00
DISPLAYLEVEL ( 5 , " use1 " ) ;
2016-09-06 13:01:51 +00:00
ZSTD_initCStream_advanced ( zc , NULL , 0 , ZSTD_getParams ( 19 , inSize , 0 ) , inSize ) ; /* needs btopt + search3 to trigger hashLog3 */
inBuff . src = CNBuffer ;
inBuff . size = inSize ;
inBuff . pos = 0 ;
outBuff . dst = ( char * ) ( compressedBuffer ) + cSize ;
outBuff . size = ZSTD_compressBound ( inSize ) ;
outBuff . pos = 0 ;
2017-05-08 23:08:01 +00:00
DISPLAYLEVEL ( 5 , " compress1 " ) ;
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_compressStream ( zc , & outBuff , & inBuff ) ) ;
2016-09-06 13:01:51 +00:00
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* entire input should be consumed */
2017-05-08 23:08:01 +00:00
DISPLAYLEVEL ( 5 , " end1 " ) ;
2016-09-06 13:01:51 +00:00
{ size_t const r = ZSTD_endStream ( zc , & outBuff ) ;
if ( r ! = 0 ) goto _output_error ; } /* error, or some data not flushed */
}
/* use 2 */
{ size_t const inSize = 1025 ; /* will not continue, because tables auto-adjust and are therefore different size */
2017-05-08 23:08:01 +00:00
DISPLAYLEVEL ( 5 , " use2 " ) ;
2016-09-06 13:01:51 +00:00
ZSTD_initCStream_advanced ( zc , NULL , 0 , ZSTD_getParams ( 19 , inSize , 0 ) , inSize ) ; /* needs btopt + search3 to trigger hashLog3 */
inBuff . src = CNBuffer ;
inBuff . size = inSize ;
inBuff . pos = 0 ;
outBuff . dst = ( char * ) ( compressedBuffer ) + cSize ;
outBuff . size = ZSTD_compressBound ( inSize ) ;
outBuff . pos = 0 ;
2017-05-08 23:08:01 +00:00
DISPLAYLEVEL ( 5 , " compress2 " ) ;
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_compressStream ( zc , & outBuff , & inBuff ) ) ;
2016-09-06 13:01:51 +00:00
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* entire input should be consumed */
2017-05-08 23:08:01 +00:00
DISPLAYLEVEL ( 5 , " end2 " ) ;
2016-09-06 13:01:51 +00:00
{ size_t const r = ZSTD_endStream ( zc , & outBuff ) ;
if ( r ! = 0 ) goto _output_error ; } /* error, or some data not flushed */
}
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2016-09-06 13:01:51 +00:00
2020-04-28 01:10:45 +00:00
/* Decompression single pass with empty frame */
cSize = ZSTD_compress ( compressedBuffer , compressedBufferSize , NULL , 0 , 1 ) ;
CHECK_Z ( cSize ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_decompressStream() single pass on empty frame : " , testNb + + ) ;
{ ZSTD_DCtx * dctx = ZSTD_createDCtx ( ) ;
size_t const dctxSize = ZSTD_sizeof_DCtx ( dctx ) ;
CHECK_Z ( ZSTD_DCtx_setParameter ( dctx , ZSTD_d_stableOutBuffer , 1 ) ) ;
outBuff . dst = decodedBuffer ;
outBuff . pos = 0 ;
outBuff . size = CNBufferSize ;
inBuff . src = compressedBuffer ;
inBuff . size = cSize ;
inBuff . pos = 0 ;
{ size_t const r = ZSTD_decompressStream ( dctx , & outBuff , & inBuff ) ;
CHECK_Z ( r ) ;
CHECK ( r ! = 0 , " Entire frame must be decompressed " ) ;
CHECK ( outBuff . pos ! = 0 , " Wrong size! " ) ;
CHECK ( memcmp ( CNBuffer , outBuff . dst , CNBufferSize ) ! = 0 , " Corruption! " ) ;
}
CHECK ( dctxSize ! = ZSTD_sizeof_DCtx ( dctx ) , " No buffers allocated " ) ;
ZSTD_freeDCtx ( dctx ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2020-04-28 00:42:03 +00:00
/* Decompression with ZSTD_d_stableOutBuffer */
cSize = ZSTD_compress ( compressedBuffer , compressedBufferSize , CNBuffer , CNBufferSize , 1 ) ;
CHECK_Z ( cSize ) ;
{ ZSTD_DCtx * dctx = ZSTD_createDCtx ( ) ;
size_t const dctxSize0 = ZSTD_sizeof_DCtx ( dctx ) ;
size_t dctxSize1 ;
CHECK_Z ( ZSTD_DCtx_setParameter ( dctx , ZSTD_d_stableOutBuffer , 1 ) ) ;
outBuff . dst = decodedBuffer ;
outBuff . pos = 0 ;
outBuff . size = CNBufferSize ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_decompressStream() single pass : " , testNb + + ) ;
inBuff . src = compressedBuffer ;
inBuff . size = cSize ;
inBuff . pos = 0 ;
{ size_t const r = ZSTD_decompressStream ( dctx , & outBuff , & inBuff ) ;
CHECK_Z ( r ) ;
CHECK ( r ! = 0 , " Entire frame must be decompressed " ) ;
CHECK ( outBuff . pos ! = CNBufferSize , " Wrong size! " ) ;
CHECK ( memcmp ( CNBuffer , outBuff . dst , CNBufferSize ) ! = 0 , " Corruption! " ) ;
}
CHECK ( dctxSize0 ! = ZSTD_sizeof_DCtx ( dctx ) , " No buffers allocated " ) ;
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_decompressStream() stable out buffer : " , testNb + + ) ;
outBuff . pos = 0 ;
inBuff . pos = 0 ;
inBuff . size = 0 ;
while ( inBuff . pos < cSize ) {
inBuff . size + = MIN ( cSize - inBuff . pos , 1 + ( FUZ_rand ( & coreSeed ) & 15 ) ) ;
CHECK_Z ( ZSTD_decompressStream ( dctx , & outBuff , & inBuff ) ) ;
}
CHECK ( outBuff . pos ! = CNBufferSize , " Wrong size! " ) ;
CHECK ( memcmp ( CNBuffer , outBuff . dst , CNBufferSize ) ! = 0 , " Corruption! " ) ;
dctxSize1 = ZSTD_sizeof_DCtx ( dctx ) ;
CHECK ( ! ( dctxSize0 < dctxSize1 ) , " Input buffer allocated " ) ;
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_decompressStream() stable out buffer too small : " , testNb + + ) ;
ZSTD_DCtx_reset ( dctx , ZSTD_reset_session_only ) ;
CHECK_Z ( ZSTD_DCtx_setParameter ( dctx , ZSTD_d_stableOutBuffer , 1 ) ) ;
inBuff . src = compressedBuffer ;
inBuff . size = cSize ;
inBuff . pos = 0 ;
outBuff . pos = 0 ;
outBuff . size = CNBufferSize - 1 ;
{ size_t const r = ZSTD_decompressStream ( dctx , & outBuff , & inBuff ) ;
CHECK ( ZSTD_getErrorCode ( r ) ! = ZSTD_error_dstSize_tooSmall , " Must error but got %s " , ZSTD_getErrorName ( r ) ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_decompressStream() stable out buffer modified : " , testNb + + ) ;
ZSTD_DCtx_reset ( dctx , ZSTD_reset_session_only ) ;
CHECK_Z ( ZSTD_DCtx_setParameter ( dctx , ZSTD_d_stableOutBuffer , 1 ) ) ;
inBuff . src = compressedBuffer ;
inBuff . size = cSize - 1 ;
inBuff . pos = 0 ;
outBuff . pos = 0 ;
outBuff . size = CNBufferSize ;
CHECK_Z ( ZSTD_decompressStream ( dctx , & outBuff , & inBuff ) ) ;
+ + inBuff . size ;
outBuff . pos = 0 ;
{ size_t const r = ZSTD_decompressStream ( dctx , & outBuff , & inBuff ) ;
CHECK ( ZSTD_getErrorCode ( r ) ! = ZSTD_error_dstBuffer_wrong , " Must error but got %s " , ZSTD_getErrorName ( r ) ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_decompressStream() buffered output : " , testNb + + ) ;
ZSTD_DCtx_reset ( dctx , ZSTD_reset_session_only ) ;
CHECK_Z ( ZSTD_DCtx_setParameter ( dctx , ZSTD_d_stableOutBuffer , 0 ) ) ;
outBuff . pos = 0 ;
inBuff . pos = 0 ;
inBuff . size = 0 ;
while ( inBuff . pos < cSize ) {
inBuff . size + = MIN ( cSize - inBuff . pos , 1 + ( FUZ_rand ( & coreSeed ) & 15 ) ) ;
CHECK_Z ( ZSTD_decompressStream ( dctx , & outBuff , & inBuff ) ) ;
}
CHECK ( outBuff . pos ! = CNBufferSize , " Wrong size! " ) ;
CHECK ( memcmp ( CNBuffer , outBuff . dst , CNBufferSize ) ! = 0 , " Corruption! " ) ;
CHECK ( ! ( dctxSize1 < ZSTD_sizeof_DCtx ( dctx ) ) , " Output buffer allocated " ) ;
DISPLAYLEVEL ( 3 , " OK \n " ) ;
ZSTD_freeDCtx ( dctx ) ;
2020-10-13 01:40:14 +00:00
}
/* Compression with ZSTD_c_stable{In,Out}Buffer */
{ ZSTD_CCtx * cctx = ZSTD_createCCtx ( ) ;
ZSTD_inBuffer in ;
ZSTD_outBuffer out ;
size_t cctxSize1 ;
size_t cctxSize2 ;
in . src = CNBuffer ;
in . size = CNBufferSize ;
out . dst = compressedBuffer ;
out . size = compressedBufferSize ;
CHECK_Z ( ZSTD_CCtx_setParameter ( cctx , ZSTD_c_checksumFlag , 1 ) ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_compress2() uses stable input and output : " , testNb + + ) ;
CHECK_Z ( cSize = ZSTD_compress2 ( cctx , compressedBuffer , compressedBufferSize , CNBuffer , CNBufferSize ) ) ;
CHECK ( ! ( cSize < ZSTD_compressBound ( CNBufferSize ) ) , " cSize too large for test " ) ;
CHECK_Z ( cSize = ZSTD_compress2 ( cctx , compressedBuffer , cSize + 4 , CNBuffer , CNBufferSize ) ) ;
CHECK_Z ( cctxSize1 = ZSTD_sizeof_CCtx ( cctx ) ) ;
{ ZSTD_CCtx * cctx2 = ZSTD_createCCtx ( ) ;
in . pos = out . pos = 0 ;
CHECK_Z ( ZSTD_compressStream2 ( cctx2 , & out , & in , ZSTD_e_continue ) ) ;
CHECK ( ! ( ZSTD_compressStream2 ( cctx2 , & out , & in , ZSTD_e_end ) = = 0 ) , " Not finished " ) ;
CHECK_Z ( cctxSize2 = ZSTD_sizeof_CCtx ( cctx2 ) ) ;
ZSTD_freeCCtx ( cctx2 ) ;
}
{ ZSTD_CCtx * cctx3 = ZSTD_createCCtx ( ) ;
ZSTD_parameters params = ZSTD_getParams ( 0 , CNBufferSize , 0 ) ;
size_t cSize3 ;
params . fParams . checksumFlag = 1 ;
cSize3 = ZSTD_compress_advanced ( cctx3 , compressedBuffer , compressedBufferSize , CNBuffer , CNBufferSize , NULL , 0 , params ) ;
CHECK_Z ( cSize3 ) ;
CHECK ( ! ( cSize = = cSize3 ) , " Must be same compressed size " ) ;
CHECK ( ! ( cctxSize1 = = ZSTD_sizeof_CCtx ( cctx3 ) ) , " Must be same CCtx size " ) ;
ZSTD_freeCCtx ( cctx3 ) ;
}
CHECK ( ! ( cctxSize1 < cctxSize2 ) , " Stable buffers means less allocated size " ) ;
CHECK_Z ( ZSTD_decompress ( decodedBuffer , CNBufferSize , compressedBuffer , cSize ) ) ;
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_compress2() doesn't modify user parameters : " , testNb + + ) ;
{
int stableInBuffer ;
int stableOutBuffer ;
CHECK_Z ( ZSTD_CCtx_getParameter ( cctx , ZSTD_c_stableInBuffer , & stableInBuffer ) ) ;
CHECK_Z ( ZSTD_CCtx_getParameter ( cctx , ZSTD_c_stableOutBuffer , & stableOutBuffer ) ) ;
CHECK ( ! ( stableInBuffer = = 0 ) , " Modified " ) ;
CHECK ( ! ( stableOutBuffer = = 0 ) , " Modified " ) ;
CHECK_Z ( ZSTD_CCtx_setParameter ( cctx , ZSTD_c_stableInBuffer , 1 ) ) ;
CHECK_Z ( ZSTD_CCtx_setParameter ( cctx , ZSTD_c_stableOutBuffer , 1 ) ) ;
CHECK_Z ( cSize = ZSTD_compress2 ( cctx , compressedBuffer , compressedBufferSize , CNBuffer , CNBufferSize ) ) ;
CHECK_Z ( ZSTD_CCtx_getParameter ( cctx , ZSTD_c_stableInBuffer , & stableInBuffer ) ) ;
CHECK_Z ( ZSTD_CCtx_getParameter ( cctx , ZSTD_c_stableOutBuffer , & stableOutBuffer ) ) ;
CHECK ( ! ( stableInBuffer = = 1 ) , " Modified " ) ;
CHECK ( ! ( stableOutBuffer = = 1 ) , " Modified " ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_compressStream2() with ZSTD_c_stableInBuffer and ZSTD_c_stableOutBuffer : " , testNb + + ) ;
CHECK_Z ( ZSTD_CCtx_reset ( cctx , ZSTD_reset_session_and_parameters ) ) ;
CHECK_Z ( ZSTD_CCtx_setParameter ( cctx , ZSTD_c_checksumFlag , 1 ) ) ;
CHECK_Z ( ZSTD_CCtx_setParameter ( cctx , ZSTD_c_stableInBuffer , 1 ) ) ;
CHECK_Z ( ZSTD_CCtx_setParameter ( cctx , ZSTD_c_stableOutBuffer , 1 ) ) ;
in . pos = out . pos = 0 ;
CHECK ( ! ( ZSTD_compressStream2 ( cctx , & out , & in , ZSTD_e_end ) = = 0 ) , " Not finished " ) ;
CHECK_Z ( ZSTD_decompress ( decodedBuffer , CNBufferSize , compressedBuffer , cSize ) ) ;
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_compressStream2() ZSTD_c_stableInBuffer and ZSTD_c_stableOutBuffer allocated size : " , testNb + + ) ;
{ size_t const cctxSize = ZSTD_sizeof_CCtx ( cctx ) ;
CHECK ( ! ( cctxSize1 = = cctxSize ) , " Must be the same size as single pass " ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_compressStream2() with ZSTD_c_stableInBuffer only : " , testNb + + ) ;
CHECK_Z ( ZSTD_CCtx_reset ( cctx , ZSTD_reset_session_and_parameters ) ) ;
CHECK_Z ( ZSTD_CCtx_setParameter ( cctx , ZSTD_c_checksumFlag , 1 ) ) ;
CHECK_Z ( ZSTD_CCtx_setParameter ( cctx , ZSTD_c_stableInBuffer , 1 ) ) ;
in . pos = out . pos = 0 ;
out . size = cSize / 4 ;
for ( ; ; ) {
size_t const ret = ZSTD_compressStream2 ( cctx , & out , & in , ZSTD_e_end ) ;
CHECK_Z ( ret ) ;
if ( ret = = 0 )
break ;
out . size = MIN ( out . size + cSize / 4 , compressedBufferSize ) ;
}
CHECK_Z ( ZSTD_decompress ( decodedBuffer , CNBufferSize , compressedBuffer , cSize ) ) ;
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_compressStream2() ZSTD_c_stableInBuffer modify buffer : " , testNb + + ) ;
in . pos = out . pos = 0 ;
out . size = cSize / 4 ;
CHECK_Z ( ZSTD_compressStream2 ( cctx , & out , & in , ZSTD_e_end ) ) ;
in . src = ( char const * ) in . src + in . pos ;
in . size - = in . pos ;
in . pos = 0 ;
{ size_t const ret = ZSTD_compressStream2 ( cctx , & out , & in , ZSTD_e_end ) ;
CHECK ( ! ZSTD_isError ( ret ) , " Must error " ) ;
CHECK ( ! ( ZSTD_getErrorCode ( ret ) = = ZSTD_error_srcBuffer_wrong ) , " Must be this error " ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_compressStream2() ZSTD_c_stableInBuffer with continue and flush : " , testNb + + ) ;
in . src = CNBuffer ;
in . size = CNBufferSize ;
in . pos = 0 ;
out . pos = 0 ;
out . size = compressedBufferSize ;
CHECK_Z ( ZSTD_CCtx_reset ( cctx , ZSTD_reset_session_only ) ) ;
{ size_t const ret = ZSTD_compressStream2 ( cctx , & out , & in , ZSTD_e_continue ) ;
CHECK ( ! ZSTD_isError ( ret ) , " Must error " ) ;
CHECK ( ! ( ZSTD_getErrorCode ( ret ) = = ZSTD_error_srcBuffer_wrong ) , " Must be this error " ) ;
}
CHECK_Z ( ZSTD_CCtx_reset ( cctx , ZSTD_reset_session_only ) ) ;
{ size_t const ret = ZSTD_compressStream2 ( cctx , & out , & in , ZSTD_e_flush ) ;
CHECK ( ! ZSTD_isError ( ret ) , " Must error " ) ;
CHECK ( ! ( ZSTD_getErrorCode ( ret ) = = ZSTD_error_srcBuffer_wrong ) , " Must be this error " ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_compressStream2() ZSTD_c_stableInBuffer allocated size : " , testNb + + ) ;
{ size_t const cctxSize = ZSTD_sizeof_CCtx ( cctx ) ;
CHECK ( ! ( cctxSize1 < cctxSize ) , " Must be bigger than single-pass " ) ;
CHECK ( ! ( cctxSize < cctxSize2 ) , " Must be smaller than streaming " ) ;
cctxSize1 = cctxSize ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_compressStream2() with ZSTD_c_stableOutBuffer only : " , testNb + + ) ;
CHECK_Z ( ZSTD_CCtx_reset ( cctx , ZSTD_reset_session_and_parameters ) ) ;
CHECK_Z ( ZSTD_CCtx_setParameter ( cctx , ZSTD_c_checksumFlag , 1 ) ) ;
CHECK_Z ( ZSTD_CCtx_setParameter ( cctx , ZSTD_c_stableOutBuffer , 1 ) ) ;
in . pos = out . pos = 0 ;
in . size = MIN ( CNBufferSize , 10 ) ;
CHECK_Z ( ZSTD_compressStream2 ( cctx , & out , & in , ZSTD_e_flush ) ) ;
in . pos = 0 ;
in . size = CNBufferSize - in . size ;
CHECK ( ! ( ZSTD_compressStream2 ( cctx , & out , & in , ZSTD_e_end ) = = 0 ) , " Not finished " ) ;
CHECK_Z ( ZSTD_decompress ( decodedBuffer , CNBufferSize , compressedBuffer , cSize ) ) ;
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_compressStream2() ZSTD_c_stableOutBuffer modify buffer : " , testNb + + ) ;
in . pos = out . pos = 0 ;
in . size = CNBufferSize ;
CHECK_Z ( ZSTD_compressStream2 ( cctx , & out , & in , ZSTD_e_continue ) ) ;
in . pos = out . pos = 0 ;
{ size_t const ret = ZSTD_compressStream2 ( cctx , & out , & in , ZSTD_e_continue ) ;
CHECK ( ! ZSTD_isError ( ret ) , " Must have errored " ) ;
CHECK ( ! ( ZSTD_getErrorCode ( ret ) = = ZSTD_error_dstBuffer_wrong ) , " Must be this error " ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_compressStream2() ZSTD_c_stableOutBuffer allocated size : " , testNb + + ) ;
{ size_t const cctxSize = ZSTD_sizeof_CCtx ( cctx ) ;
CHECK ( ! ( cctxSize1 < cctxSize ) , " Must be bigger than single-pass and stableInBuffer " ) ;
CHECK ( ! ( cctxSize < cctxSize2 ) , " Must be smaller than streaming " ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
ZSTD_freeCCtx ( cctx ) ;
2020-04-28 00:42:03 +00:00
}
2016-10-25 23:19:52 +00:00
/* CDict scenario */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " test%3i : digested dictionary : " , testNb + + ) ;
2017-06-28 00:09:12 +00:00
{ ZSTD_CDict * const cdict = ZSTD_createCDict ( dictionary . start , dictionary . filled , 1 /*byRef*/ ) ;
2016-10-25 23:19:52 +00:00
size_t const initError = ZSTD_initCStream_usingCDict ( zc , cdict ) ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 5 , " ZSTD_initCStream_usingCDict result : %u " , ( unsigned ) initError ) ;
2016-10-25 23:19:52 +00:00
if ( ZSTD_isError ( initError ) ) goto _output_error ;
outBuff . dst = compressedBuffer ;
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
inBuff . src = CNBuffer ;
inBuff . size = CNBufferSize ;
inBuff . pos = 0 ;
2017-11-16 23:02:28 +00:00
DISPLAYLEVEL ( 5 , " - starting ZSTD_compressStream " ) ;
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_compressStream ( zc , & outBuff , & inBuff ) ) ;
2016-10-25 23:19:52 +00:00
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* entire input should be consumed */
2017-11-16 23:02:28 +00:00
{ size_t const r = ZSTD_endStream ( zc , & outBuff ) ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 5 , " - ZSTD_endStream result : %u " , ( unsigned ) r ) ;
2017-11-16 23:02:28 +00:00
if ( r ! = 0 ) goto _output_error ; /* error, or some data not flushed */
}
2016-10-25 23:19:52 +00:00
cSize = outBuff . pos ;
ZSTD_freeCDict ( cdict ) ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 3 , " OK (%u bytes : %.2f%%) \n " , ( unsigned ) cSize , ( double ) cSize / CNBufferSize * 100 ) ;
2016-10-25 23:19:52 +00:00
}
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " test%3i : check CStream size : " , testNb + + ) ;
2016-09-06 13:01:51 +00:00
{ size_t const s = ZSTD_sizeof_CStream ( zc ) ;
if ( ZSTD_isError ( s ) ) goto _output_error ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 3 , " OK (%u bytes) \n " , ( unsigned ) s ) ;
2016-09-06 13:01:51 +00:00
}
2017-01-17 03:46:22 +00:00
DISPLAYLEVEL ( 4 , " test%3i : check Dictionary ID : " , testNb + + ) ;
{ unsigned const dID = ZSTD_getDictID_fromFrame ( compressedBuffer , cSize ) ;
if ( dID ! = dictID ) goto _output_error ;
DISPLAYLEVEL ( 4 , " OK (%u) \n " , dID ) ;
}
2016-10-26 00:47:02 +00:00
/* DDict scenario */
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 3 , " test%3i : decompress %u bytes with digested dictionary : " , testNb + + , ( unsigned ) CNBufferSize ) ;
2017-01-17 03:46:22 +00:00
{ ZSTD_DDict * const ddict = ZSTD_createDDict ( dictionary . start , dictionary . filled ) ;
2016-10-26 00:47:02 +00:00
size_t const initError = ZSTD_initDStream_usingDDict ( zd , ddict ) ;
if ( ZSTD_isError ( initError ) ) goto _output_error ;
2017-12-12 20:51:49 +00:00
outBuff . dst = decodedBuffer ;
outBuff . size = CNBufferSize ;
outBuff . pos = 0 ;
2017-12-12 22:01:54 +00:00
inBuff . src = compressedBuffer ;
inBuff . size = cSize ;
inBuff . pos = 0 ;
2016-10-26 00:47:02 +00:00
{ size_t const r = ZSTD_decompressStream ( zd , & outBuff , & inBuff ) ;
if ( r ! = 0 ) goto _output_error ; } /* should reach end of frame == 0; otherwise, some data left, or an error */
if ( outBuff . pos ! = CNBufferSize ) goto _output_error ; /* should regenerate the same amount */
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* should have read the entire frame */
ZSTD_freeDDict ( ddict ) ;
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2016-10-26 00:47:02 +00:00
}
2016-08-23 14:58:10 +00:00
/* Memory restriction */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " test%3i : maxWindowSize < frame requirement : " , testNb + + ) ;
2017-05-10 18:30:19 +00:00
ZSTD_initDStream_usingDict ( zd , CNBuffer , dictSize ) ;
2018-12-05 01:30:58 +00:00
CHECK_Z ( ZSTD_DCtx_setParameter ( zd , ZSTD_d_windowLogMax , 10 ) ) ; /* too small limit */
2017-12-12 20:51:49 +00:00
outBuff . dst = decodedBuffer ;
outBuff . size = CNBufferSize ;
outBuff . pos = 0 ;
2017-12-12 22:01:54 +00:00
inBuff . src = compressedBuffer ;
inBuff . size = cSize ;
inBuff . pos = 0 ;
2016-08-23 14:58:10 +00:00
{ size_t const r = ZSTD_decompressStream ( zd , & outBuff , & inBuff ) ;
if ( ! ZSTD_isError ( r ) ) goto _output_error ; /* must fail : frame requires > 100 bytes */
2017-01-19 20:12:50 +00:00
DISPLAYLEVEL ( 3 , " OK (%s) \n " , ZSTD_getErrorName ( r ) ) ; }
2018-11-16 00:12:39 +00:00
ZSTD_DCtx_reset ( zd , ZSTD_reset_session_and_parameters ) ; /* leave zd in good shape for next tests */
2016-08-23 14:58:10 +00:00
2018-01-30 21:30:30 +00:00
DISPLAYLEVEL ( 3 , " test%3i : dictionary source size and level : " , testNb + + ) ;
{ ZSTD_DCtx * const dctx = ZSTD_createDCtx ( ) ;
2018-03-20 23:16:13 +00:00
int const maxLevel = 16 ; /* first level with zstd_opt */
2018-01-30 21:30:30 +00:00
int level ;
2018-03-20 22:59:25 +00:00
assert ( maxLevel < ZSTD_maxCLevel ( ) ) ;
CHECK_Z ( ZSTD_DCtx_loadDictionary_byReference ( dctx , dictionary . start , dictionary . filled ) ) ;
2018-01-30 21:30:30 +00:00
for ( level = 1 ; level < = maxLevel ; + + level ) {
ZSTD_CDict * const cdict = ZSTD_createCDict ( dictionary . start , dictionary . filled , level ) ;
2018-03-20 22:59:25 +00:00
size_t const maxSize = MIN ( 1 MB , CNBufferSize ) ;
size_t size ;
2018-01-30 21:30:30 +00:00
for ( size = 512 ; size < = maxSize ; size < < = 1 ) {
2018-03-20 22:59:25 +00:00
U64 const crcOrig = XXH64 ( CNBuffer , size , 0 ) ;
2018-01-30 21:30:30 +00:00
ZSTD_CCtx * const cctx = ZSTD_createCCtx ( ) ;
2018-04-25 23:32:29 +00:00
ZSTD_parameters savedParams ;
getCCtxParams ( cctx , & savedParams ) ;
2018-01-30 21:30:30 +00:00
outBuff . dst = compressedBuffer ;
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
inBuff . src = CNBuffer ;
inBuff . size = size ;
inBuff . pos = 0 ;
CHECK_Z ( ZSTD_CCtx_refCDict ( cctx , cdict ) ) ;
2018-11-30 19:16:26 +00:00
CHECK_Z ( ZSTD_compressStream2 ( cctx , & outBuff , & inBuff , ZSTD_e_end ) ) ;
2018-04-25 23:32:29 +00:00
CHECK ( badParameters ( cctx , savedParams ) , " Bad CCtx params " ) ;
2018-01-30 21:30:30 +00:00
if ( inBuff . pos ! = inBuff . size ) goto _output_error ;
2018-03-20 22:59:25 +00:00
{ ZSTD_outBuffer decOut = { decodedBuffer , size , 0 } ;
ZSTD_inBuffer decIn = { outBuff . dst , outBuff . pos , 0 } ;
2018-12-04 18:28:36 +00:00
CHECK_Z ( ZSTD_decompressStream ( dctx , & decOut , & decIn ) ) ;
2018-03-20 22:59:25 +00:00
if ( decIn . pos ! = decIn . size ) goto _output_error ;
if ( decOut . pos ! = size ) goto _output_error ;
{ U64 const crcDec = XXH64 ( decOut . dst , decOut . pos , 0 ) ;
if ( crcDec ! = crcOrig ) goto _output_error ;
} }
2018-01-30 21:30:30 +00:00
ZSTD_freeCCtx ( cctx ) ;
}
ZSTD_freeCDict ( cdict ) ;
}
ZSTD_freeDCtx ( dctx ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2019-04-10 19:34:21 +00:00
ZSTD_CCtx_reset ( zc , ZSTD_reset_session_and_parameters ) ;
CHECK_Z ( ZSTD_CCtx_loadDictionary ( zc , dictionary . start , dictionary . filled ) ) ;
cSize = ZSTD_compress2 ( zc , compressedBuffer , compressedBufferSize , CNBuffer , MIN ( CNBufferSize , 100 KB ) ) ;
CHECK_Z ( cSize ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_decompressStream() with dictionary : " , testNb + + ) ;
{
ZSTD_DCtx * dctx = ZSTD_createDCtx ( ) ;
/* We should fail to decompress without a dictionary. */
ZSTD_DCtx_reset ( dctx , ZSTD_reset_session_and_parameters ) ;
{ ZSTD_outBuffer out = { decodedBuffer , decodedBufferSize , 0 } ;
ZSTD_inBuffer in = { compressedBuffer , cSize , 0 } ;
size_t const ret = ZSTD_decompressStream ( dctx , & out , & in ) ;
if ( ! ZSTD_isError ( ret ) ) goto _output_error ;
}
/* We should succeed to decompress with the dictionary. */
ZSTD_DCtx_reset ( dctx , ZSTD_reset_session_and_parameters ) ;
CHECK_Z ( ZSTD_DCtx_loadDictionary ( dctx , dictionary . start , dictionary . filled ) ) ;
{ ZSTD_outBuffer out = { decodedBuffer , decodedBufferSize , 0 } ;
ZSTD_inBuffer in = { compressedBuffer , cSize , 0 } ;
if ( ZSTD_decompressStream ( dctx , & out , & in ) ! = 0 ) goto _output_error ;
if ( in . pos ! = in . size ) goto _output_error ;
}
/* The dictionary should presist across calls. */
{ ZSTD_outBuffer out = { decodedBuffer , decodedBufferSize , 0 } ;
ZSTD_inBuffer in = { compressedBuffer , cSize , 0 } ;
if ( ZSTD_decompressStream ( dctx , & out , & in ) ! = 0 ) goto _output_error ;
if ( in . pos ! = in . size ) goto _output_error ;
}
/* The dictionary should not be cleared by ZSTD_reset_session_only. */
ZSTD_DCtx_reset ( dctx , ZSTD_reset_session_only ) ;
{ ZSTD_outBuffer out = { decodedBuffer , decodedBufferSize , 0 } ;
ZSTD_inBuffer in = { compressedBuffer , cSize , 0 } ;
if ( ZSTD_decompressStream ( dctx , & out , & in ) ! = 0 ) goto _output_error ;
if ( in . pos ! = in . size ) goto _output_error ;
}
/* When we reset the context the dictionary is cleared. */
ZSTD_DCtx_reset ( dctx , ZSTD_reset_session_and_parameters ) ;
{ ZSTD_outBuffer out = { decodedBuffer , decodedBufferSize , 0 } ;
ZSTD_inBuffer in = { compressedBuffer , cSize , 0 } ;
size_t const ret = ZSTD_decompressStream ( dctx , & out , & in ) ;
if ( ! ZSTD_isError ( ret ) ) goto _output_error ;
}
ZSTD_freeDCtx ( dctx ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2019-04-12 18:18:11 +00:00
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_resetDStream() with dictionary : " , testNb + + ) ;
2019-04-10 19:34:21 +00:00
{
ZSTD_DCtx * dctx = ZSTD_createDCtx ( ) ;
/* We should succeed to decompress with the dictionary. */
ZSTD_resetDStream ( dctx ) ;
CHECK_Z ( ZSTD_DCtx_loadDictionary ( dctx , dictionary . start , dictionary . filled ) ) ;
{ ZSTD_outBuffer out = { decodedBuffer , decodedBufferSize , 0 } ;
ZSTD_inBuffer in = { compressedBuffer , cSize , 0 } ;
if ( ZSTD_decompressStream ( dctx , & out , & in ) ! = 0 ) goto _output_error ;
if ( in . pos ! = in . size ) goto _output_error ;
}
/* The dictionary should not be cleared by ZSTD_resetDStream(). */
ZSTD_resetDStream ( dctx ) ;
{ ZSTD_outBuffer out = { decodedBuffer , decodedBufferSize , 0 } ;
ZSTD_inBuffer in = { compressedBuffer , cSize , 0 } ;
if ( ZSTD_decompressStream ( dctx , & out , & in ) ! = 0 ) goto _output_error ;
if ( in . pos ! = in . size ) goto _output_error ;
}
/* The dictionary should be cleared by ZSTD_initDStream(). */
CHECK_Z ( ZSTD_initDStream ( dctx ) ) ;
{ ZSTD_outBuffer out = { decodedBuffer , decodedBufferSize , 0 } ;
ZSTD_inBuffer in = { compressedBuffer , cSize , 0 } ;
size_t const ret = ZSTD_decompressStream ( dctx , & out , & in ) ;
if ( ! ZSTD_isError ( ret ) ) goto _output_error ;
}
ZSTD_freeDCtx ( dctx ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_decompressStream() with ddict : " , testNb + + ) ;
{
ZSTD_DCtx * dctx = ZSTD_createDCtx ( ) ;
ZSTD_DDict * ddict = ZSTD_createDDict ( dictionary . start , dictionary . filled ) ;
/* We should succeed to decompress with the ddict. */
ZSTD_DCtx_reset ( dctx , ZSTD_reset_session_and_parameters ) ;
CHECK_Z ( ZSTD_DCtx_refDDict ( dctx , ddict ) ) ;
{ ZSTD_outBuffer out = { decodedBuffer , decodedBufferSize , 0 } ;
ZSTD_inBuffer in = { compressedBuffer , cSize , 0 } ;
if ( ZSTD_decompressStream ( dctx , & out , & in ) ! = 0 ) goto _output_error ;
if ( in . pos ! = in . size ) goto _output_error ;
}
/* The ddict should presist across calls. */
{ ZSTD_outBuffer out = { decodedBuffer , decodedBufferSize , 0 } ;
ZSTD_inBuffer in = { compressedBuffer , cSize , 0 } ;
if ( ZSTD_decompressStream ( dctx , & out , & in ) ! = 0 ) goto _output_error ;
if ( in . pos ! = in . size ) goto _output_error ;
}
/* When we reset the context the ddict is cleared. */
ZSTD_DCtx_reset ( dctx , ZSTD_reset_session_and_parameters ) ;
{ ZSTD_outBuffer out = { decodedBuffer , decodedBufferSize , 0 } ;
ZSTD_inBuffer in = { compressedBuffer , cSize , 0 } ;
size_t const ret = ZSTD_decompressStream ( dctx , & out , & in ) ;
if ( ! ZSTD_isError ( ret ) ) goto _output_error ;
}
ZSTD_freeDCtx ( dctx ) ;
ZSTD_freeDDict ( ddict ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_decompressDCtx() with prefix : " , testNb + + ) ;
{
ZSTD_DCtx * dctx = ZSTD_createDCtx ( ) ;
/* We should succeed to decompress with the prefix. */
ZSTD_DCtx_reset ( dctx , ZSTD_reset_session_and_parameters ) ;
CHECK_Z ( ZSTD_DCtx_refPrefix_advanced ( dctx , dictionary . start , dictionary . filled , ZSTD_dct_auto ) ) ;
{ ZSTD_outBuffer out = { decodedBuffer , decodedBufferSize , 0 } ;
ZSTD_inBuffer in = { compressedBuffer , cSize , 0 } ;
if ( ZSTD_decompressStream ( dctx , & out , & in ) ! = 0 ) goto _output_error ;
if ( in . pos ! = in . size ) goto _output_error ;
}
/* The prefix should be cleared after the first compression. */
{ ZSTD_outBuffer out = { decodedBuffer , decodedBufferSize , 0 } ;
ZSTD_inBuffer in = { compressedBuffer , cSize , 0 } ;
size_t const ret = ZSTD_decompressStream ( dctx , & out , & in ) ;
if ( ! ZSTD_isError ( ret ) ) goto _output_error ;
}
ZSTD_freeDCtx ( dctx ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_initDStream*() with dictionary : " , testNb + + ) ;
{
ZSTD_DCtx * dctx = ZSTD_createDCtx ( ) ;
ZSTD_DDict * ddict = ZSTD_createDDict ( dictionary . start , dictionary . filled ) ;
size_t ret ;
/* We should succeed to decompress with the dictionary. */
CHECK_Z ( ZSTD_initDStream_usingDict ( dctx , dictionary . start , dictionary . filled ) ) ;
CHECK_Z ( ZSTD_decompressDCtx ( dctx , decodedBuffer , decodedBufferSize , compressedBuffer , cSize ) ) ;
/* The dictionary should presist across calls. */
CHECK_Z ( ZSTD_decompressDCtx ( dctx , decodedBuffer , decodedBufferSize , compressedBuffer , cSize ) ) ;
/* We should succeed to decompress with the ddict. */
CHECK_Z ( ZSTD_initDStream_usingDDict ( dctx , ddict ) ) ;
CHECK_Z ( ZSTD_decompressDCtx ( dctx , decodedBuffer , decodedBufferSize , compressedBuffer , cSize ) ) ;
/* The ddict should presist across calls. */
CHECK_Z ( ZSTD_decompressDCtx ( dctx , decodedBuffer , decodedBufferSize , compressedBuffer , cSize ) ) ;
/* When we reset the context the ddict is cleared. */
CHECK_Z ( ZSTD_initDStream ( dctx ) ) ;
ret = ZSTD_decompressDCtx ( dctx , decodedBuffer , decodedBufferSize , compressedBuffer , cSize ) ;
if ( ! ZSTD_isError ( ret ) ) goto _output_error ;
ZSTD_freeDCtx ( dctx ) ;
ZSTD_freeDDict ( ddict ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2017-04-27 21:48:34 +00:00
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_initCStream_usingCDict_advanced with masked dictID : " , testNb + + ) ;
{ ZSTD_compressionParameters const cParams = ZSTD_getCParams ( 1 , CNBufferSize , dictionary . filled ) ;
ZSTD_frameParameters const fParams = { 1 /* contentSize */ , 1 /* checksum */ , 1 /* noDictID */ } ;
2018-03-20 22:13:14 +00:00
ZSTD_CDict * const cdict = ZSTD_createCDict_advanced ( dictionary . start , dictionary . filled , ZSTD_dlm_byRef , ZSTD_dct_auto , cParams , ZSTD_defaultCMem ) ;
2017-06-03 08:15:02 +00:00
size_t const initError = ZSTD_initCStream_usingCDict_advanced ( zc , cdict , fParams , CNBufferSize ) ;
2017-04-27 21:48:34 +00:00
if ( ZSTD_isError ( initError ) ) goto _output_error ;
2017-04-04 03:56:39 +00:00
outBuff . dst = compressedBuffer ;
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
inBuff . src = CNBuffer ;
inBuff . size = CNBufferSize ;
inBuff . pos = 0 ;
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_compressStream ( zc , & outBuff , & inBuff ) ) ;
2017-06-03 08:15:02 +00:00
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* entire input should be consumed */
2017-04-04 03:56:39 +00:00
{ size_t const r = ZSTD_endStream ( zc , & outBuff ) ;
if ( r ! = 0 ) goto _output_error ; } /* error, or some data not flushed */
cSize = outBuff . pos ;
ZSTD_freeCDict ( cdict ) ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 3 , " OK (%u bytes : %.2f%%) \n " , ( unsigned ) cSize , ( double ) cSize / CNBufferSize * 100 ) ;
2017-04-11 18:59:44 +00:00
}
2017-04-04 03:56:39 +00:00
2017-04-27 22:08:56 +00:00
DISPLAYLEVEL ( 3 , " test%3i : try retrieving dictID from frame : " , testNb + + ) ;
{ U32 const did = ZSTD_getDictID_fromFrame ( compressedBuffer , cSize ) ;
if ( did ! = 0 ) goto _output_error ;
}
DISPLAYLEVEL ( 3 , " OK (not detected) \n " ) ;
2017-04-11 18:59:44 +00:00
DISPLAYLEVEL ( 3 , " test%3i : decompress without dictionary : " , testNb + + ) ;
{ size_t const r = ZSTD_decompress ( decodedBuffer , CNBufferSize , compressedBuffer , cSize ) ;
if ( ! ZSTD_isError ( r ) ) goto _output_error ; /* must fail : dictionary not used */
DISPLAYLEVEL ( 3 , " OK (%s) \n " , ZSTD_getErrorName ( r ) ) ;
2017-04-04 03:56:39 +00:00
}
2017-06-28 23:25:13 +00:00
DISPLAYLEVEL ( 3 , " test%3i : compress with ZSTD_CCtx_refPrefix : " , testNb + + ) ;
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_CCtx_refPrefix ( zc , dictionary . start , dictionary . filled ) ) ;
2017-06-28 23:25:13 +00:00
outBuff . dst = compressedBuffer ;
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
inBuff . src = CNBuffer ;
inBuff . size = CNBufferSize ;
inBuff . pos = 0 ;
2018-11-30 19:16:26 +00:00
CHECK_Z ( ZSTD_compressStream2 ( zc , & outBuff , & inBuff , ZSTD_e_end ) ) ;
2017-06-28 23:25:13 +00:00
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* entire input should be consumed */
cSize = outBuff . pos ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 3 , " OK (%u bytes : %.2f%%) \n " , ( unsigned ) cSize , ( double ) cSize / CNBufferSize * 100 ) ;
2017-06-28 23:25:13 +00:00
2018-03-20 23:16:13 +00:00
DISPLAYLEVEL ( 3 , " test%3i : decompress with ZSTD_DCtx_refPrefix : " , testNb + + ) ;
CHECK_Z ( ZSTD_DCtx_refPrefix ( zd , dictionary . start , dictionary . filled ) ) ;
outBuff . dst = decodedBuffer ;
outBuff . size = CNBufferSize ;
outBuff . pos = 0 ;
inBuff . src = compressedBuffer ;
inBuff . size = cSize ;
inBuff . pos = 0 ;
2018-12-04 18:28:36 +00:00
CHECK_Z ( ZSTD_decompressStream ( zd , & outBuff , & inBuff ) ) ;
2018-03-20 23:16:13 +00:00
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* entire input should be consumed */
if ( outBuff . pos ! = CNBufferSize ) goto _output_error ; /* must regenerate whole input */
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2017-06-28 23:25:13 +00:00
DISPLAYLEVEL ( 3 , " test%3i : decompress without dictionary (should fail): " , testNb + + ) ;
{ size_t const r = ZSTD_decompress ( decodedBuffer , CNBufferSize , compressedBuffer , cSize ) ;
if ( ! ZSTD_isError ( r ) ) goto _output_error ; /* must fail : dictionary not used */
DISPLAYLEVEL ( 3 , " OK (%s) \n " , ZSTD_getErrorName ( r ) ) ;
}
2018-11-30 19:16:26 +00:00
DISPLAYLEVEL ( 3 , " test%3i : compress again with ZSTD_compressStream2 : " , testNb + + ) ;
2017-06-28 23:25:13 +00:00
outBuff . dst = compressedBuffer ;
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
inBuff . src = CNBuffer ;
inBuff . size = CNBufferSize ;
inBuff . pos = 0 ;
2018-11-30 19:16:26 +00:00
CHECK_Z ( ZSTD_compressStream2 ( zc , & outBuff , & inBuff , ZSTD_e_end ) ) ;
2017-06-28 23:25:13 +00:00
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* entire input should be consumed */
cSize = outBuff . pos ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 3 , " OK (%u bytes : %.2f%%) \n " , ( unsigned ) cSize , ( double ) cSize / CNBufferSize * 100 ) ;
2017-06-28 23:25:13 +00:00
DISPLAYLEVEL ( 3 , " test%3i : decompress without dictionary (should work): " , testNb + + ) ;
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_decompress ( decodedBuffer , CNBufferSize , compressedBuffer , cSize ) ) ;
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2017-06-28 23:25:13 +00:00
2017-04-18 22:08:52 +00:00
/* Empty srcSize */
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_initCStream_advanced with pledgedSrcSize=0 and dict : " , testNb + + ) ;
{ ZSTD_parameters params = ZSTD_getParams ( 5 , 0 , 0 ) ;
params . fParams . contentSizeFlag = 1 ;
2017-10-14 02:01:58 +00:00
CHECK_Z ( ZSTD_initCStream_advanced ( zc , dictionary . start , dictionary . filled , params , 0 /* pledgedSrcSize==0 means "empty" when params.fParams.contentSizeFlag is set */ ) ) ;
2017-04-18 22:08:52 +00:00
} /* cstream advanced shall write content size = 0 */
2017-12-12 20:51:49 +00:00
outBuff . dst = compressedBuffer ;
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
2017-12-12 22:01:54 +00:00
inBuff . src = CNBuffer ;
inBuff . size = 0 ;
inBuff . pos = 0 ;
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_compressStream ( zc , & outBuff , & inBuff ) ) ;
2017-04-18 22:08:52 +00:00
if ( ZSTD_endStream ( zc , & outBuff ) ! = 0 ) goto _output_error ;
cSize = outBuff . pos ;
if ( ZSTD_findDecompressedSize ( compressedBuffer , cSize ) ! = 0 ) goto _output_error ;
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2017-02-09 18:50:43 +00:00
DISPLAYLEVEL ( 3 , " test%3i : pledgedSrcSize == 0 behaves properly : " , testNb + + ) ;
{ ZSTD_parameters params = ZSTD_getParams ( 5 , 0 , 0 ) ;
params . fParams . contentSizeFlag = 1 ;
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_initCStream_advanced ( zc , NULL , 0 , params , 0 ) ) ;
2017-04-11 18:59:44 +00:00
} /* cstream advanced shall write content size = 0 */
2017-02-09 18:50:43 +00:00
inBuff . src = CNBuffer ;
inBuff . size = 0 ;
inBuff . pos = 0 ;
outBuff . dst = compressedBuffer ;
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_compressStream ( zc , & outBuff , & inBuff ) ) ;
2017-02-09 18:50:43 +00:00
if ( ZSTD_endStream ( zc , & outBuff ) ! = 0 ) goto _output_error ;
cSize = outBuff . pos ;
if ( ZSTD_findDecompressedSize ( compressedBuffer , cSize ) ! = 0 ) goto _output_error ;
ZSTD_resetCStream ( zc , 0 ) ; /* resetCStream should treat 0 as unknown */
2017-12-12 20:51:49 +00:00
outBuff . dst = compressedBuffer ;
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
2017-12-12 22:01:54 +00:00
inBuff . src = CNBuffer ;
inBuff . size = 0 ;
inBuff . pos = 0 ;
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_compressStream ( zc , & outBuff , & inBuff ) ) ;
2017-02-09 18:50:43 +00:00
if ( ZSTD_endStream ( zc , & outBuff ) ! = 0 ) goto _output_error ;
cSize = outBuff . pos ;
if ( ZSTD_findDecompressedSize ( compressedBuffer , cSize ) ! = ZSTD_CONTENTSIZE_UNKNOWN ) goto _output_error ;
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2016-08-23 14:58:10 +00:00
2017-08-30 21:36:54 +00:00
/* Basic multithreading compression test */
DISPLAYLEVEL ( 3 , " test%3i : compress %u bytes with multiple threads : " , testNb + + , COMPRESSIBLE_NOISE_LENGTH ) ;
2020-10-02 01:47:54 +00:00
{ int jobSize ;
CHECK_Z ( ZSTD_CCtx_getParameter ( mtctx , ZSTD_c_jobSize , & jobSize ) ) ;
2018-06-25 22:21:08 +00:00
CHECK ( jobSize ! = 0 , " job size non-zero " ) ;
2020-10-02 01:47:54 +00:00
CHECK_Z ( ZSTD_CCtx_getParameter ( mtctx , ZSTD_c_jobSize , & jobSize ) ) ;
2018-06-25 22:21:08 +00:00
CHECK ( jobSize ! = 0 , " job size non-zero " ) ;
2017-09-28 09:14:48 +00:00
}
2017-12-12 22:01:54 +00:00
outBuff . dst = compressedBuffer ;
2017-08-30 21:36:54 +00:00
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
inBuff . src = CNBuffer ;
inBuff . size = CNBufferSize ;
inBuff . pos = 0 ;
2020-10-02 01:47:54 +00:00
{ size_t const compressResult = ZSTD_compressStream2 ( mtctx , & outBuff , & inBuff , ZSTD_e_end ) ;
2018-01-20 06:11:11 +00:00
if ( compressResult ! = 0 ) goto _output_error ; /* compression must be completed in a single round */
}
2017-08-30 21:36:54 +00:00
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* entire input should be consumed */
2018-01-20 06:11:11 +00:00
{ size_t const compressedSize = ZSTD_findFrameCompressedSize ( compressedBuffer , outBuff . pos ) ;
if ( compressedSize ! = outBuff . pos ) goto _output_error ; /* must be a full valid frame */
}
2017-08-30 21:36:54 +00:00
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2017-12-12 22:01:54 +00:00
/* Complex multithreading + dictionary test */
2018-02-02 03:29:30 +00:00
{ U32 const nbWorkers = 2 ;
2017-12-12 22:01:54 +00:00
size_t const jobSize = 4 * 1 MB ;
2018-02-02 03:29:30 +00:00
size_t const srcSize = jobSize * nbWorkers ; /* we want each job to have predictable size */
2017-12-12 22:01:54 +00:00
size_t const segLength = 2 KB ;
size_t const offset = 600 KB ; /* must be larger than window defined in cdict */
size_t const start = jobSize + ( offset - 1 ) ;
const BYTE * const srcToCopy = ( const BYTE * ) CNBuffer + start ;
BYTE * const dst = ( BYTE * ) CNBuffer + start - offset ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 3 , " test%3i : compress %u bytes with multiple threads + dictionary : " , testNb + + , ( unsigned ) srcSize ) ;
2018-12-06 01:26:02 +00:00
CHECK_Z ( ZSTD_CCtx_setParameter ( zc , ZSTD_c_compressionLevel , 3 ) ) ;
CHECK_Z ( ZSTD_CCtx_setParameter ( zc , ZSTD_c_nbWorkers , nbWorkers ) ) ;
CHECK_Z ( ZSTD_CCtx_setParameter ( zc , ZSTD_c_jobSize , jobSize ) ) ;
2017-12-12 22:01:54 +00:00
assert ( start > offset ) ;
assert ( start + segLength < COMPRESSIBLE_NOISE_LENGTH ) ;
memcpy ( dst , srcToCopy , segLength ) ; /* create a long repetition at long distance for job 2 */
outBuff . dst = compressedBuffer ;
outBuff . size = compressedBufferSize ;
outBuff . pos = 0 ;
inBuff . src = CNBuffer ;
inBuff . size = srcSize ; assert ( srcSize < COMPRESSIBLE_NOISE_LENGTH ) ;
inBuff . pos = 0 ;
}
2019-04-12 18:18:11 +00:00
{ ZSTD_compressionParameters const cParams = ZSTD_getCParams ( 1 , 4 KB , dictionary . filled ) ; /* intentionally lies on estimatedSrcSize, to push cdict into targeting a small window size */
2018-03-20 22:13:14 +00:00
ZSTD_CDict * const cdict = ZSTD_createCDict_advanced ( dictionary . start , dictionary . filled , ZSTD_dlm_byRef , ZSTD_dct_fullDict , cParams , ZSTD_defaultCMem ) ;
2017-12-12 22:01:54 +00:00
DISPLAYLEVEL ( 5 , " cParams.windowLog = %u : " , cParams . windowLog ) ;
2017-12-13 23:35:49 +00:00
CHECK_Z ( ZSTD_CCtx_refCDict ( zc , cdict ) ) ;
2018-11-30 19:16:26 +00:00
CHECK_Z ( ZSTD_compressStream2 ( zc , & outBuff , & inBuff , ZSTD_e_end ) ) ;
2017-12-13 23:35:49 +00:00
CHECK_Z ( ZSTD_CCtx_refCDict ( zc , NULL ) ) ; /* do not keep a reference to cdict, as its lifetime ends */
2017-12-12 22:01:54 +00:00
ZSTD_freeCDict ( cdict ) ;
}
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* entire input should be consumed */
cSize = outBuff . pos ;
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : decompress large frame created from multiple threads + dictionary : " , testNb + + ) ;
{ ZSTD_DStream * const dstream = ZSTD_createDCtx ( ) ;
ZSTD_frameHeader zfh ;
ZSTD_getFrameHeader ( & zfh , compressedBuffer , cSize ) ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 5 , " frame windowsize = %u : " , ( unsigned ) zfh . windowSize ) ;
2017-12-12 22:01:54 +00:00
outBuff . dst = decodedBuffer ;
outBuff . size = CNBufferSize ;
outBuff . pos = 0 ;
inBuff . src = compressedBuffer ;
inBuff . pos = 0 ;
CHECK_Z ( ZSTD_initDStream_usingDict ( dstream , dictionary . start , dictionary . filled ) ) ;
inBuff . size = 1 ; /* avoid shortcut to single-pass mode */
CHECK_Z ( ZSTD_decompressStream ( dstream , & outBuff , & inBuff ) ) ;
inBuff . size = cSize ;
CHECK_Z ( ZSTD_decompressStream ( dstream , & outBuff , & inBuff ) ) ;
if ( inBuff . pos ! = inBuff . size ) goto _output_error ; /* entire input should be consumed */
ZSTD_freeDStream ( dstream ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2017-10-17 00:18:43 +00:00
DISPLAYLEVEL ( 3 , " test%3i : check dictionary FSE tables can represent every code : " , testNb + + ) ;
{ unsigned const kMaxWindowLog = 24 ;
unsigned value ;
ZSTD_compressionParameters cParams = ZSTD_getCParams ( 3 , 1U < < kMaxWindowLog , 1024 ) ;
ZSTD_CDict * cdict ;
ZSTD_DDict * ddict ;
SEQ_stream seq = SEQ_initStream ( 0x87654321 ) ;
SEQ_gen_type type ;
XXH64_state_t xxh ;
XXH64_reset ( & xxh , 0 ) ;
cParams . windowLog = kMaxWindowLog ;
2018-03-20 22:13:14 +00:00
cdict = ZSTD_createCDict_advanced ( dictionary . start , dictionary . filled , ZSTD_dlm_byRef , ZSTD_dct_fullDict , cParams , ZSTD_defaultCMem ) ;
2017-10-17 00:18:43 +00:00
ddict = ZSTD_createDDict ( dictionary . start , dictionary . filled ) ;
if ( ! cdict | | ! ddict ) goto _output_error ;
2018-11-16 00:12:39 +00:00
ZSTD_CCtx_reset ( zc , ZSTD_reset_session_only ) ;
2017-10-17 00:18:43 +00:00
ZSTD_resetDStream ( zd ) ;
CHECK_Z ( ZSTD_CCtx_refCDict ( zc , cdict ) ) ;
CHECK_Z ( ZSTD_initDStream_usingDDict ( zd , ddict ) ) ;
2018-12-05 01:30:58 +00:00
CHECK_Z ( ZSTD_DCtx_setParameter ( zd , ZSTD_d_windowLogMax , kMaxWindowLog ) ) ;
2017-10-17 00:18:43 +00:00
/* Test all values < 300 */
for ( value = 0 ; value < 300 ; + + value ) {
for ( type = ( SEQ_gen_type ) 0 ; type < SEQ_gen_max ; + + type ) {
CHECK_Z ( SEQ_generateRoundTrip ( zc , zd , & xxh , & seq , type , value ) ) ;
}
}
/* Test values 2^8 to 2^17 */
for ( value = ( 1 < < 8 ) ; value < ( 1 < < 17 ) ; value < < = 1 ) {
for ( type = ( SEQ_gen_type ) 0 ; type < SEQ_gen_max ; + + type ) {
CHECK_Z ( SEQ_generateRoundTrip ( zc , zd , & xxh , & seq , type , value ) ) ;
CHECK_Z ( SEQ_generateRoundTrip ( zc , zd , & xxh , & seq , type , value + ( value > > 2 ) ) ) ;
}
}
/* Test offset values up to the max window log */
for ( value = 8 ; value < = kMaxWindowLog ; + + value ) {
CHECK_Z ( SEQ_generateRoundTrip ( zc , zd , & xxh , & seq , SEQ_gen_of , ( 1U < < value ) - 1 ) ) ;
}
CHECK_Z ( SEQ_roundTrip ( zc , zd , & xxh , NULL , 0 , ZSTD_e_end ) ) ;
CHECK ( SEQ_digest ( & seq ) ! = XXH64_digest ( & xxh ) , " SEQ XXH64 does not match " ) ;
ZSTD_freeCDict ( cdict ) ;
ZSTD_freeDDict ( ddict ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2017-08-30 21:36:54 +00:00
2018-07-13 00:56:58 +00:00
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_initCStream_srcSize sets requestedParams : " , testNb + + ) ;
2018-11-21 23:37:26 +00:00
{ int level ;
2018-07-13 00:56:58 +00:00
CHECK_Z ( ZSTD_initCStream_srcSize ( zc , 11 , ZSTD_CONTENTSIZE_UNKNOWN ) ) ;
2018-12-06 01:26:02 +00:00
CHECK_Z ( ZSTD_CCtx_getParameter ( zc , ZSTD_c_compressionLevel , & level ) ) ;
2018-07-13 00:56:58 +00:00
CHECK ( level ! = 11 , " Compression level does not match " ) ;
ZSTD_resetCStream ( zc , ZSTD_CONTENTSIZE_UNKNOWN ) ;
2018-12-06 01:26:02 +00:00
CHECK_Z ( ZSTD_CCtx_getParameter ( zc , ZSTD_c_compressionLevel , & level ) ) ;
2018-07-13 00:56:58 +00:00
CHECK ( level ! = 11 , " Compression level does not match " ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_initCStream_advanced sets requestedParams : " , testNb + + ) ;
{ ZSTD_parameters const params = ZSTD_getParams ( 9 , 0 , 0 ) ;
CHECK_Z ( ZSTD_initCStream_advanced ( zc , NULL , 0 , params , ZSTD_CONTENTSIZE_UNKNOWN ) ) ;
CHECK ( badParameters ( zc , params ) , " Compression parameters do not match " ) ;
ZSTD_resetCStream ( zc , ZSTD_CONTENTSIZE_UNKNOWN ) ;
CHECK ( badParameters ( zc , params ) , " Compression parameters do not match " ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2019-09-18 18:05:08 +00:00
DISPLAYLEVEL ( 3 , " test%3i : ZSTD_c_srcSizeHint bounds : " , testNb + + ) ;
ZSTD_CCtx_reset ( zc , ZSTD_reset_session_and_parameters ) ;
CHECK_Z ( ZSTD_CCtx_setParameter ( zc , ZSTD_c_srcSizeHint , INT_MAX ) ) ;
{ int srcSizeHint ;
CHECK_Z ( ZSTD_CCtx_getParameter ( zc , ZSTD_c_srcSizeHint , & srcSizeHint ) ) ;
CHECK ( ! ( srcSizeHint = = INT_MAX ) , " srcSizeHint doesn't match " ) ;
}
CHECK ( ! ZSTD_isError ( ZSTD_CCtx_setParameter ( zc , ZSTD_c_srcSizeHint , - 1 ) ) , " Out of range doesn't error " ) ;
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2017-02-16 00:43:45 +00:00
/* Overlen overwriting window data bug */
DISPLAYLEVEL ( 3 , " test%3i : wildcopy doesn't overwrite potential match data : " , testNb + + ) ;
2017-02-16 21:29:47 +00:00
{ /* This test has a window size of 1024 bytes and consists of 3 blocks:
1. ' a ' repeated 517 times
2. ' b ' repeated 516 times
3. a compressed block with no literals and 3 sequence commands :
litlength = 0 , offset = 24 , match length = 24
litlength = 0 , offset = 24 , match length = 3 ( this one creates an overlength write of length 2 * WILDCOPY_OVERLENGTH - 3 )
litlength = 0 , offset = 1021 , match length = 3 ( this one will try to read from overwritten data if the buffer is too small ) */
const char * testCase =
" \x28 \xB5 \x2F \xFD \x04 \x00 \x4C \x00 \x00 \x10 \x61 \x61 \x01 \x00 \x00 \x2A "
" \x80 \x05 \x44 \x00 \x00 \x08 \x62 \x01 \x00 \x00 \x2A \x20 \x04 \x5D \x00 \x00 "
" \x00 \x03 \x40 \x00 \x00 \x64 \x60 \x27 \xB0 \xE0 \x0C \x67 \x62 \xCE \xE0 " ;
2017-09-28 09:14:48 +00:00
ZSTD_DStream * const zds = ZSTD_createDStream ( ) ;
if ( zds = = NULL ) goto _output_error ;
2017-02-16 00:43:45 +00:00
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_initDStream ( zds ) ) ;
2017-02-16 00:43:45 +00:00
inBuff . src = testCase ;
2017-02-16 21:29:47 +00:00
inBuff . size = 47 ;
2017-02-16 00:43:45 +00:00
inBuff . pos = 0 ;
outBuff . dst = decodedBuffer ;
outBuff . size = CNBufferSize ;
outBuff . pos = 0 ;
while ( inBuff . pos < inBuff . size ) {
2017-09-28 09:14:48 +00:00
CHECK_Z ( ZSTD_decompressStream ( zds , & outBuff , & inBuff ) ) ;
2017-02-16 00:43:45 +00:00
}
2017-02-21 17:17:24 +00:00
ZSTD_freeDStream ( zds ) ;
2017-02-16 00:43:45 +00:00
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2019-06-28 00:27:29 +00:00
/* Small Sequence Section bug */
DISPLAYLEVEL ( 3 , " test%3i : decompress blocks with small sequences section : " , testNb + + ) ;
{ /* This test consists of 3 blocks. Each block has one sequence.
The sequence has literal length of 10 , match length of 10 and offset of 10.
The sequence value and compression mode for the blocks are following :
The order of values are ll , ml , of .
- First block : ( 10 , 7 , 13 ) ( rle , rle , rle )
- size of sequences section : 6 bytes ( 1 byte for nbSeq , 1 byte for encoding mode , 3 bytes for rle , 1 byte bitstream )
- Second block : ( 10 , 7 , 1 ) ( repeat , repeat , rle )
- size of sequences section : 4 bytes ( 1 byte for nbSeq , 1 byte for encoding mode , 1 bytes for rle , 1 byte bitstream )
- Third block : ( 10 , 7 , 1 ) ( repeat , repeat , repeat )
- size of sequences section : 3 bytes ( 1 byte for nbSeq , 1 byte for encoding mode , 1 byte bitstream ) */
unsigned char compressed [ ] = {
0x28 , 0xb5 , 0x2f , 0xfd , 0x24 , 0x3c , 0x35 , 0x01 , 0x00 , 0xf0 , 0x85 , 0x08 ,
0xc2 , 0xc4 , 0x70 , 0xcf , 0xd7 , 0xc0 , 0x96 , 0x7e , 0x4c , 0x6b , 0xa9 , 0x8b ,
0xbc , 0xc5 , 0xb6 , 0xd9 , 0x7f , 0x4c , 0xf1 , 0x05 , 0xa6 , 0x54 , 0xef , 0xac ,
0x69 , 0x94 , 0x89 , 0x1c , 0x03 , 0x44 , 0x0a , 0x07 , 0x00 , 0xb4 , 0x04 , 0x80 ,
0x40 , 0x0a , 0xa4
} ;
unsigned int compressedSize = 51 ;
unsigned char decompressed [ ] = {
0x85 , 0x08 , 0xc2 , 0xc4 , 0x70 , 0xcf , 0xd7 , 0xc0 , 0x96 , 0x7e , 0x85 , 0x08 ,
0xc2 , 0xc4 , 0x70 , 0xcf , 0xd7 , 0xc0 , 0x96 , 0x7e , 0x4c , 0x6b , 0xa9 , 0x8b ,
0xbc , 0xc5 , 0xb6 , 0xd9 , 0x7f , 0x4c , 0x4c , 0x6b , 0xa9 , 0x8b , 0xbc , 0xc5 ,
0xb6 , 0xd9 , 0x7f , 0x4c , 0xf1 , 0x05 , 0xa6 , 0x54 , 0xef , 0xac , 0x69 , 0x94 ,
0x89 , 0x1c , 0xf1 , 0x05 , 0xa6 , 0x54 , 0xef , 0xac , 0x69 , 0x94 , 0x89 , 0x1c
} ;
unsigned int decompressedSize = 60 ;
ZSTD_DStream * const zds = ZSTD_createDStream ( ) ;
if ( zds = = NULL ) goto _output_error ;
CHECK_Z ( ZSTD_initDStream ( zds ) ) ;
inBuff . src = compressed ;
inBuff . size = compressedSize ;
inBuff . pos = 0 ;
outBuff . dst = decodedBuffer ;
outBuff . size = CNBufferSize ;
outBuff . pos = 0 ;
2019-07-01 17:17:30 +00:00
CHECK ( ZSTD_decompressStream ( zds , & outBuff , & inBuff ) ! = 0 ,
" Decompress did not reach the end of frame " ) ;
CHECK ( inBuff . pos ! = inBuff . size , " Decompress did not fully consume input " ) ;
CHECK ( outBuff . pos ! = decompressedSize , " Decompressed size does not match " ) ;
CHECK ( memcmp ( outBuff . dst , decompressed , decompressedSize ) ! = 0 ,
" Decompressed data does not match " ) ;
2019-06-28 00:27:29 +00:00
ZSTD_freeDStream ( zds ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2020-01-11 02:02:11 +00:00
DISPLAYLEVEL ( 3 , " test%3i : raw block can be streamed: " , testNb + + ) ;
{ size_t const inputSize = 10000 ;
size_t const compCapacity = ZSTD_compressBound ( inputSize ) ;
BYTE * const input = ( BYTE * ) malloc ( inputSize ) ;
BYTE * const comp = ( BYTE * ) malloc ( compCapacity ) ;
BYTE * const decomp = ( BYTE * ) malloc ( inputSize ) ;
CHECK ( input = = NULL | | comp = = NULL | | decomp = = NULL , " failed to alloc buffers " ) ;
RDG_genBuffer ( input , inputSize , 0.0 , 0.0 , seed ) ;
{ size_t const compSize = ZSTD_compress ( comp , compCapacity , input , inputSize , - ( int ) inputSize ) ;
ZSTD_inBuffer in = { comp , 0 , 0 } ;
ZSTD_outBuffer out = { decomp , 0 , 0 } ;
CHECK_Z ( compSize ) ;
CHECK_Z ( ZSTD_DCtx_reset ( zd , ZSTD_reset_session_and_parameters ) ) ;
while ( in . size < compSize ) {
in . size = MIN ( in . size + 100 , compSize ) ;
while ( in . pos < in . size ) {
size_t const outPos = out . pos ;
if ( out . pos = = out . size ) {
out . size = MIN ( out . size + 10 , inputSize ) ;
}
CHECK_Z ( ZSTD_decompressStream ( zd , & out , & in ) ) ;
CHECK ( ! ( out . pos > outPos ) , " We are not streaming (no output generated) " ) ;
}
}
CHECK ( in . pos ! = compSize , " Not all input consumed! " ) ;
CHECK ( out . pos ! = inputSize , " Not all output produced! " ) ;
}
CHECK ( memcmp ( input , decomp , inputSize ) , " round trip failed! " ) ;
free ( input ) ;
free ( comp ) ;
free ( decomp ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2018-08-24 21:30:21 +00:00
DISPLAYLEVEL ( 3 , " test%3i : dictionary + uncompressible block + reusing tables checks offset table validity: " , testNb + + ) ;
{ ZSTD_CDict * const cdict = ZSTD_createCDict_advanced (
dictionary . start , dictionary . filled ,
ZSTD_dlm_byRef , ZSTD_dct_fullDict ,
ZSTD_getCParams ( 3 , 0 , dictionary . filled ) ,
ZSTD_defaultCMem ) ;
const size_t inbufsize = 2 * 128 * 1024 ; /* 2 blocks */
const size_t outbufsize = ZSTD_compressBound ( inbufsize ) ;
size_t inbufpos = 0 ;
size_t cursegmentlen ;
BYTE * inbuf = ( BYTE * ) malloc ( inbufsize ) ;
BYTE * outbuf = ( BYTE * ) malloc ( outbufsize ) ;
BYTE * checkbuf = ( BYTE * ) malloc ( inbufsize ) ;
size_t ret ;
CHECK ( cdict = = NULL , " failed to alloc cdict " ) ;
CHECK ( inbuf = = NULL , " failed to alloc input buffer " ) ;
2018-09-13 19:29:52 +00:00
2018-08-24 21:30:21 +00:00
/* first block is uncompressible */
cursegmentlen = 128 * 1024 ;
RDG_genBuffer ( inbuf + inbufpos , cursegmentlen , 0. , 0. , seed ) ;
inbufpos + = cursegmentlen ;
/* second block is compressible */
cursegmentlen = 128 * 1024 - 256 ;
RDG_genBuffer ( inbuf + inbufpos , cursegmentlen , 0.05 , 0. , seed ) ;
inbufpos + = cursegmentlen ;
/* and includes a very long backref */
cursegmentlen = 128 ;
2020-05-01 16:24:51 +00:00
memcpy ( inbuf + inbufpos , ( BYTE * ) dictionary . start + 256 , cursegmentlen ) ;
2018-08-24 21:30:21 +00:00
inbufpos + = cursegmentlen ;
/* and includes a very long backref */
cursegmentlen = 128 ;
2020-05-01 16:24:51 +00:00
memcpy ( inbuf + inbufpos , ( BYTE * ) dictionary . start + 128 , cursegmentlen ) ;
2018-08-24 21:30:21 +00:00
inbufpos + = cursegmentlen ;
ret = ZSTD_compress_usingCDict ( zc , outbuf , outbufsize , inbuf , inbufpos , cdict ) ;
CHECK_Z ( ret ) ;
ret = ZSTD_decompress_usingDict ( zd , checkbuf , inbufsize , outbuf , ret , dictionary . start , dictionary . filled ) ;
CHECK_Z ( ret ) ;
CHECK ( memcmp ( inbuf , checkbuf , inbufpos ) , " start and finish buffers don't match " ) ;
ZSTD_freeCDict ( cdict ) ;
free ( inbuf ) ;
free ( outbuf ) ;
free ( checkbuf ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2018-09-28 19:09:14 +00:00
DISPLAYLEVEL ( 3 , " test%3i : dictionary + small blocks + reusing tables checks offset table validity: " , testNb + + ) ;
{ ZSTD_CDict * const cdict = ZSTD_createCDict_advanced (
dictionary . start , dictionary . filled ,
ZSTD_dlm_byRef , ZSTD_dct_fullDict ,
ZSTD_getCParams ( 3 , 0 , dictionary . filled ) ,
ZSTD_defaultCMem ) ;
ZSTD_outBuffer out = { compressedBuffer , compressedBufferSize , 0 } ;
int remainingInput = 256 * 1024 ;
2018-09-28 21:24:38 +00:00
int offset ;
2018-09-28 19:09:14 +00:00
2018-11-16 00:12:39 +00:00
CHECK_Z ( ZSTD_CCtx_reset ( zc , ZSTD_reset_session_and_parameters ) ) ;
2018-09-28 19:09:14 +00:00
CHECK_Z ( ZSTD_CCtx_refCDict ( zc , cdict ) ) ;
2018-12-06 01:26:02 +00:00
CHECK_Z ( ZSTD_CCtx_setParameter ( zc , ZSTD_c_checksumFlag , 1 ) ) ;
2018-09-28 19:09:14 +00:00
/* Write a bunch of 6 byte blocks */
while ( remainingInput > 0 ) {
2018-09-28 19:14:24 +00:00
char testBuffer [ 6 ] = " \xAA \xAA \xAA \xAA \xAA \xAA " ;
const size_t kSmallBlockSize = sizeof ( testBuffer ) ;
2018-09-28 19:09:14 +00:00
ZSTD_inBuffer in = { testBuffer , kSmallBlockSize , 0 } ;
2018-11-30 19:16:26 +00:00
CHECK_Z ( ZSTD_compressStream2 ( zc , & out , & in , ZSTD_e_flush ) ) ;
2018-09-28 19:09:14 +00:00
CHECK ( in . pos ! = in . size , " input not fully consumed " ) ;
remainingInput - = kSmallBlockSize ;
}
/* Write several very long offset matches into the dictionary */
2018-09-28 21:24:38 +00:00
for ( offset = 1024 ; offset > = 0 ; offset - = 128 ) {
2020-05-01 16:24:51 +00:00
ZSTD_inBuffer in = { ( BYTE * ) dictionary . start + offset , 128 , 0 } ;
2018-09-28 19:09:14 +00:00
ZSTD_EndDirective flush = offset > 0 ? ZSTD_e_continue : ZSTD_e_end ;
2018-11-30 19:16:26 +00:00
CHECK_Z ( ZSTD_compressStream2 ( zc , & out , & in , flush ) ) ;
2018-09-28 19:09:14 +00:00
CHECK ( in . pos ! = in . size , " input not fully consumed " ) ;
}
/* Ensure decompression works */
CHECK_Z ( ZSTD_decompress_usingDict ( zd , decodedBuffer , CNBufferSize , out . dst , out . pos , dictionary . start , dictionary . filled ) ) ;
ZSTD_freeCDict ( cdict ) ;
}
DISPLAYLEVEL ( 3 , " OK \n " ) ;
2016-08-12 14:48:02 +00:00
_end :
2017-01-17 03:46:22 +00:00
FUZ_freeDictionary ( dictionary ) ;
2016-08-12 14:48:02 +00:00
ZSTD_freeCStream ( zc ) ;
ZSTD_freeDStream ( zd ) ;
2020-10-02 01:47:54 +00:00
ZSTD_freeCCtx ( mtctx ) ;
2016-08-12 14:48:02 +00:00
free ( CNBuffer ) ;
free ( compressedBuffer ) ;
free ( decodedBuffer ) ;
return testResult ;
_output_error :
testResult = 1 ;
DISPLAY ( " Error detected in Unit tests ! \n " ) ;
goto _end ;
}
2016-09-14 15:26:59 +00:00
/* ====== Fuzzer tests ====== */
2016-08-12 14:48:02 +00:00
static size_t findDiff ( const void * buf1 , const void * buf2 , size_t max )
{
const BYTE * b1 = ( const BYTE * ) buf1 ;
const BYTE * b2 = ( const BYTE * ) buf2 ;
size_t u ;
for ( u = 0 ; u < max ; u + + ) {
if ( b1 [ u ] ! = b2 [ u ] ) break ;
}
2018-01-19 21:19:59 +00:00
if ( u = = max ) {
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAY ( " => No difference detected within %u bytes \n " , ( unsigned ) max ) ;
2018-01-19 21:19:59 +00:00
return u ;
}
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAY ( " Error at position %u / %u \n " , ( unsigned ) u , ( unsigned ) max ) ;
2018-01-19 20:41:56 +00:00
if ( u > = 3 )
DISPLAY ( " %02X %02X %02X " ,
b1 [ u - 3 ] , b1 [ u - 2 ] , b1 [ u - 1 ] ) ;
DISPLAY ( " :%02X: %02X %02X %02X %02X %02X \n " ,
b1 [ u ] , b1 [ u + 1 ] , b1 [ u + 2 ] , b1 [ u + 3 ] , b1 [ u + 4 ] , b1 [ u + 5 ] ) ;
if ( u > = 3 )
DISPLAY ( " %02X %02X %02X " ,
b2 [ u - 3 ] , b2 [ u - 2 ] , b2 [ u - 1 ] ) ;
DISPLAY ( " :%02X: %02X %02X %02X %02X %02X \n " ,
b2 [ u ] , b2 [ u + 1 ] , b2 [ u + 2 ] , b2 [ u + 3 ] , b2 [ u + 4 ] , b2 [ u + 5 ] ) ;
2016-08-12 14:48:02 +00:00
return u ;
}
static size_t FUZ_rLogLength ( U32 * seed , U32 logLength )
{
size_t const lengthMask = ( ( size_t ) 1 < < logLength ) - 1 ;
return ( lengthMask + 1 ) + ( FUZ_rand ( seed ) & lengthMask ) ;
}
static size_t FUZ_randomLength ( U32 * seed , U32 maxLog )
{
U32 const logLength = FUZ_rand ( seed ) % maxLog ;
return FUZ_rLogLength ( seed , logLength ) ;
}
2017-09-06 15:39:46 +00:00
/* Return value in range minVal <= v <= maxVal */
static U32 FUZ_randomClampedLength ( U32 * seed , U32 minVal , U32 maxVal )
{
U32 const mod = maxVal < minVal ? 1 : ( maxVal + 1 ) - minVal ;
return ( U32 ) ( ( FUZ_rand ( seed ) % mod ) + minVal ) ;
}
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
static int fuzzerTests ( U32 seed , unsigned nbTests , unsigned startTest , double compressibility , int bigTests )
2016-08-12 14:48:02 +00:00
{
2017-06-22 06:35:58 +00:00
U32 const maxSrcLog = bigTests ? 24 : 22 ;
2016-08-12 14:48:02 +00:00
static const U32 maxSampleLog = 19 ;
2016-09-24 23:34:03 +00:00
size_t const srcBufferSize = ( size_t ) 1 < < maxSrcLog ;
2016-08-12 14:48:02 +00:00
BYTE * cNoiseBuffer [ 5 ] ;
2017-09-28 00:27:38 +00:00
size_t const copyBufferSize = srcBufferSize + ( 1 < < maxSampleLog ) ;
2016-09-24 23:34:03 +00:00
BYTE * const copyBuffer = ( BYTE * ) malloc ( copyBufferSize ) ;
2017-09-28 00:27:38 +00:00
size_t const cBufferSize = ZSTD_compressBound ( srcBufferSize ) ;
2016-09-24 23:34:03 +00:00
BYTE * const cBuffer = ( BYTE * ) malloc ( cBufferSize ) ;
size_t const dstBufferSize = srcBufferSize ;
BYTE * const dstBuffer = ( BYTE * ) malloc ( dstBufferSize ) ;
2016-08-12 14:48:02 +00:00
U32 result = 0 ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
unsigned testNb = 0 ;
2016-08-12 14:48:02 +00:00
U32 coreSeed = seed ;
2017-09-28 00:27:38 +00:00
ZSTD_CStream * zc = ZSTD_createCStream ( ) ; /* will be re-created sometimes */
ZSTD_DStream * zd = ZSTD_createDStream ( ) ; /* will be re-created sometimes */
2016-09-24 23:34:03 +00:00
ZSTD_DStream * const zd_noise = ZSTD_createDStream ( ) ;
2017-11-30 03:11:12 +00:00
UTIL_time_t const startClock = UTIL_getTime ( ) ;
2017-09-28 00:27:38 +00:00
const BYTE * dict = NULL ; /* can keep same dict on 2 consecutive tests */
2016-09-26 14:41:05 +00:00
size_t dictSize = 0 ;
U32 oldTestLog = 0 ;
2017-06-22 01:43:39 +00:00
U32 const cLevelMax = bigTests ? ( U32 ) ZSTD_maxCLevel ( ) : g_cLevelMax_smallTests ;
2016-08-12 14:48:02 +00:00
/* allocations */
cNoiseBuffer [ 0 ] = ( BYTE * ) malloc ( srcBufferSize ) ;
cNoiseBuffer [ 1 ] = ( BYTE * ) malloc ( srcBufferSize ) ;
cNoiseBuffer [ 2 ] = ( BYTE * ) malloc ( srcBufferSize ) ;
cNoiseBuffer [ 3 ] = ( BYTE * ) malloc ( srcBufferSize ) ;
cNoiseBuffer [ 4 ] = ( BYTE * ) malloc ( srcBufferSize ) ;
CHECK ( ! cNoiseBuffer [ 0 ] | | ! cNoiseBuffer [ 1 ] | | ! cNoiseBuffer [ 2 ] | | ! cNoiseBuffer [ 3 ] | | ! cNoiseBuffer [ 4 ] | |
2016-09-24 23:34:03 +00:00
! copyBuffer | | ! dstBuffer | | ! cBuffer | | ! zc | | ! zd | | ! zd_noise ,
2016-08-12 14:48:02 +00:00
" Not enough memory, fuzzer tests cancelled " ) ;
/* Create initial samples */
RDG_genBuffer ( cNoiseBuffer [ 0 ] , srcBufferSize , 0.00 , 0. , coreSeed ) ; /* pure noise */
RDG_genBuffer ( cNoiseBuffer [ 1 ] , srcBufferSize , 0.05 , 0. , coreSeed ) ; /* barely compressible */
RDG_genBuffer ( cNoiseBuffer [ 2 ] , srcBufferSize , compressibility , 0. , coreSeed ) ;
RDG_genBuffer ( cNoiseBuffer [ 3 ] , srcBufferSize , 0.95 , 0. , coreSeed ) ; /* highly compressible */
RDG_genBuffer ( cNoiseBuffer [ 4 ] , srcBufferSize , 1.00 , 0. , coreSeed ) ; /* sparse content */
memset ( copyBuffer , 0x65 , copyBufferSize ) ; /* make copyBuffer considered initialized */
2016-09-24 23:34:03 +00:00
ZSTD_initDStream_usingDict ( zd , NULL , 0 ) ; /* ensure at least one init */
2016-08-12 14:48:02 +00:00
/* catch up testNb */
for ( testNb = 1 ; testNb < startTest ; testNb + + )
FUZ_rand ( & coreSeed ) ;
/* test loop */
2017-11-30 03:11:12 +00:00
for ( ; ( testNb < = nbTests ) | | ( UTIL_clockSpanMicro ( startClock ) < g_clockTime ) ; testNb + + ) {
2016-08-12 14:48:02 +00:00
U32 lseed ;
const BYTE * srcBuffer ;
2016-09-24 23:34:03 +00:00
size_t totalTestSize , totalGenSize , cSize ;
2016-08-12 14:48:02 +00:00
XXH64_state_t xxhState ;
U64 crcOrig ;
2016-09-24 23:34:03 +00:00
U32 resetAllowed = 1 ;
2016-09-26 14:41:05 +00:00
size_t maxTestSize ;
2016-08-12 14:48:02 +00:00
/* init */
FUZ_rand ( & coreSeed ) ;
2017-01-17 03:46:22 +00:00
lseed = coreSeed ^ prime32 ;
2018-01-20 01:35:08 +00:00
if ( nbTests > = testNb ) {
2018-01-27 01:48:33 +00:00
DISPLAYUPDATE ( 2 , " \r %6u/%6u " , testNb , nbTests ) ;
2018-01-20 01:35:08 +00:00
} else {
2018-01-27 01:48:33 +00:00
DISPLAYUPDATE ( 2 , " \r %6u " , testNb ) ;
2018-01-20 01:35:08 +00:00
}
2016-08-12 14:48:02 +00:00
2016-09-14 15:26:59 +00:00
/* states full reset (deliberately not synchronized) */
/* some issues can only happen when reusing states */
2017-06-19 18:07:33 +00:00
if ( ( FUZ_rand ( & lseed ) & 0xFF ) = = 131 ) {
ZSTD_freeCStream ( zc ) ;
zc = ZSTD_createCStream ( ) ;
2017-06-21 22:53:42 +00:00
CHECK ( zc = = NULL , " ZSTD_createCStream : allocation error " ) ;
2017-06-19 18:07:33 +00:00
resetAllowed = 0 ;
}
if ( ( FUZ_rand ( & lseed ) & 0xFF ) = = 132 ) {
ZSTD_freeDStream ( zd ) ;
zd = ZSTD_createDStream ( ) ;
2017-06-21 22:53:42 +00:00
CHECK ( zd = = NULL , " ZSTD_createDStream : allocation error " ) ;
CHECK_Z ( ZSTD_initDStream_usingDict ( zd , NULL , 0 ) ) ; /* ensure at least one init */
2017-06-19 18:07:33 +00:00
}
2016-08-12 14:48:02 +00:00
/* srcBuffer selection [0-4] */
{ U32 buffNb = FUZ_rand ( & lseed ) & 0x7F ;
if ( buffNb & 7 ) buffNb = 2 ; /* most common : compressible (P) */
else {
buffNb > > = 3 ;
if ( buffNb & 7 ) {
const U32 tnb [ 2 ] = { 1 , 3 } ; /* barely/highly compressible */
buffNb = tnb [ buffNb > > 3 ] ;
} else {
const U32 tnb [ 2 ] = { 0 , 4 } ; /* not compressible / sparse */
buffNb = tnb [ buffNb > > 3 ] ;
} }
srcBuffer = cNoiseBuffer [ buffNb ] ;
}
/* compression init */
2016-09-26 14:41:05 +00:00
if ( ( FUZ_rand ( & lseed ) & 1 ) /* at beginning, to keep same nb of rand */
& & oldTestLog /* at least one test happened */ & & resetAllowed ) {
maxTestSize = FUZ_randomLength ( & lseed , oldTestLog + 2 ) ;
2017-09-28 00:27:38 +00:00
maxTestSize = MIN ( maxTestSize , srcBufferSize - 16 ) ;
2016-09-26 14:41:05 +00:00
{ U64 const pledgedSrcSize = ( FUZ_rand ( & lseed ) & 3 ) ? 0 : maxTestSize ;
2017-06-17 00:56:41 +00:00
CHECK_Z ( ZSTD_resetCStream ( zc , pledgedSrcSize ) ) ;
2016-09-26 14:41:05 +00:00
}
2016-09-24 23:34:03 +00:00
} else {
U32 const testLog = FUZ_rand ( & lseed ) % maxSrcLog ;
2017-03-15 22:04:54 +00:00
U32 const dictLog = FUZ_rand ( & lseed ) % maxSrcLog ;
2017-06-22 00:57:14 +00:00
U32 const cLevelCandidate = ( FUZ_rand ( & lseed ) %
2017-03-20 18:25:00 +00:00
( ZSTD_maxCLevel ( ) -
2017-06-22 00:57:14 +00:00
( MAX ( testLog , dictLog ) / 3 ) ) )
2017-04-05 23:34:09 +00:00
+ 1 ;
2017-06-22 00:57:14 +00:00
U32 const cLevel = MIN ( cLevelCandidate , cLevelMax ) ;
2016-08-12 14:48:02 +00:00
maxTestSize = FUZ_rLogLength ( & lseed , testLog ) ;
2016-09-26 14:41:05 +00:00
oldTestLog = testLog ;
2016-08-12 14:48:02 +00:00
/* random dictionary selection */
2017-06-22 06:35:58 +00:00
dictSize = ( ( FUZ_rand ( & lseed ) & 7 ) = = 1 ) ? FUZ_rLogLength ( & lseed , dictLog ) : 0 ;
2016-08-12 14:48:02 +00:00
{ size_t const dictStart = FUZ_rand ( & lseed ) % ( srcBufferSize - dictSize ) ;
dict = srcBuffer + dictStart ;
}
2017-10-14 02:01:58 +00:00
{ U64 const pledgedSrcSize = ( FUZ_rand ( & lseed ) & 3 ) ? ZSTD_CONTENTSIZE_UNKNOWN : maxTestSize ;
2016-09-26 14:41:05 +00:00
ZSTD_parameters params = ZSTD_getParams ( cLevel , pledgedSrcSize , dictSize ) ;
2016-08-12 14:48:02 +00:00
params . fParams . checksumFlag = FUZ_rand ( & lseed ) & 1 ;
params . fParams . noDictIDFlag = FUZ_rand ( & lseed ) & 1 ;
2017-10-14 02:01:58 +00:00
params . fParams . contentSizeFlag = FUZ_rand ( & lseed ) & 1 ;
2017-06-17 00:56:41 +00:00
CHECK_Z ( ZSTD_initCStream_advanced ( zc , dict , dictSize , params , pledgedSrcSize ) ) ;
} }
2016-08-12 14:48:02 +00:00
/* multi-segments compression test */
XXH64_reset ( & xxhState , 0 ) ;
2016-09-26 12:06:08 +00:00
{ ZSTD_outBuffer outBuff = { cBuffer , cBufferSize , 0 } ;
2016-09-24 23:34:03 +00:00
U32 n ;
2016-09-26 12:06:08 +00:00
for ( n = 0 , cSize = 0 , totalTestSize = 0 ; totalTestSize < maxTestSize ; n + + ) {
2016-12-13 15:39:36 +00:00
/* compress random chunks into randomly sized dst buffers */
2016-09-26 12:06:08 +00:00
{ size_t const randomSrcSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
2017-11-01 23:57:48 +00:00
size_t const srcSize = MIN ( maxTestSize - totalTestSize , randomSrcSize ) ;
2016-09-26 12:06:08 +00:00
size_t const srcStart = FUZ_rand ( & lseed ) % ( srcBufferSize - srcSize ) ;
2016-08-12 14:48:02 +00:00
size_t const randomDstSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
size_t const dstBuffSize = MIN ( cBufferSize - cSize , randomDstSize ) ;
2016-09-26 12:06:08 +00:00
ZSTD_inBuffer inBuff = { srcBuffer + srcStart , srcSize , 0 } ;
2016-08-16 23:39:22 +00:00
outBuff . size = outBuff . pos + dstBuffSize ;
2016-08-12 14:48:02 +00:00
2017-06-19 18:07:33 +00:00
CHECK_Z ( ZSTD_compressStream ( zc , & outBuff , & inBuff ) ) ;
2016-08-12 14:48:02 +00:00
2016-08-16 23:39:22 +00:00
XXH64_update ( & xxhState , srcBuffer + srcStart , inBuff . pos ) ;
memcpy ( copyBuffer + totalTestSize , srcBuffer + srcStart , inBuff . pos ) ;
totalTestSize + = inBuff . pos ;
2016-08-12 14:48:02 +00:00
}
/* random flush operation, to mess around */
if ( ( FUZ_rand ( & lseed ) & 15 ) = = 0 ) {
size_t const randomDstSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
2016-08-16 23:39:22 +00:00
size_t const adjustedDstSize = MIN ( cBufferSize - cSize , randomDstSize ) ;
outBuff . size = outBuff . pos + adjustedDstSize ;
2017-06-19 18:07:33 +00:00
CHECK_Z ( ZSTD_flushStream ( zc , & outBuff ) ) ;
} }
2016-08-12 14:48:02 +00:00
/* final frame epilogue */
{ size_t remainingToFlush = ( size_t ) ( - 1 ) ;
while ( remainingToFlush ) {
size_t const randomDstSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
size_t const adjustedDstSize = MIN ( cBufferSize - cSize , randomDstSize ) ;
2016-08-16 23:39:22 +00:00
outBuff . size = outBuff . pos + adjustedDstSize ;
remainingToFlush = ZSTD_endStream ( zc , & outBuff ) ;
2017-05-19 17:17:59 +00:00
CHECK ( ZSTD_isError ( remainingToFlush ) , " end error : %s " , ZSTD_getErrorName ( remainingToFlush ) ) ;
2016-08-12 14:48:02 +00:00
} }
crcOrig = XXH64_digest ( & xxhState ) ;
2016-08-16 23:39:22 +00:00
cSize = outBuff . pos ;
2016-08-12 14:48:02 +00:00
}
/* multi - fragments decompression test */
2016-09-24 23:34:03 +00:00
if ( ! dictSize /* don't reset if dictionary : could be different */ & & ( FUZ_rand ( & lseed ) & 1 ) ) {
2017-06-21 22:53:42 +00:00
CHECK_Z ( ZSTD_resetDStream ( zd ) ) ;
2016-12-03 02:37:38 +00:00
} else {
2017-06-21 22:53:42 +00:00
CHECK_Z ( ZSTD_initDStream_usingDict ( zd , dict , dictSize ) ) ;
2016-12-03 02:37:38 +00:00
}
2016-08-12 14:48:02 +00:00
{ size_t decompressionResult = 1 ;
2016-08-16 23:39:22 +00:00
ZSTD_inBuffer inBuff = { cBuffer , cSize , 0 } ;
ZSTD_outBuffer outBuff = { dstBuffer , dstBufferSize , 0 } ;
for ( totalGenSize = 0 ; decompressionResult ; ) {
2016-08-12 14:48:02 +00:00
size_t const readCSrcSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
size_t const randomDstSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
size_t const dstBuffSize = MIN ( dstBufferSize - totalGenSize , randomDstSize ) ;
2016-08-16 23:39:22 +00:00
inBuff . size = inBuff . pos + readCSrcSize ;
2017-09-27 07:39:41 +00:00
outBuff . size = outBuff . pos + dstBuffSize ;
2016-08-16 23:39:22 +00:00
decompressionResult = ZSTD_decompressStream ( zd , & outBuff , & inBuff ) ;
2017-09-09 21:37:28 +00:00
if ( ZSTD_getErrorCode ( decompressionResult ) = = ZSTD_error_checksum_wrong ) {
DISPLAY ( " checksum error : \n " ) ;
findDiff ( copyBuffer , dstBuffer , totalTestSize ) ;
}
CHECK ( ZSTD_isError ( decompressionResult ) , " decompression error : %s " ,
ZSTD_getErrorName ( decompressionResult ) ) ;
2016-08-12 14:48:02 +00:00
}
CHECK ( decompressionResult ! = 0 , " frame not fully decoded " ) ;
2017-09-09 21:37:28 +00:00
CHECK ( outBuff . pos ! = totalTestSize , " decompressed data : wrong size (%u != %u) " ,
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
( unsigned ) outBuff . pos , ( unsigned ) totalTestSize ) ;
2016-08-16 23:39:22 +00:00
CHECK ( inBuff . pos ! = cSize , " compressed data should be fully read " )
2016-08-12 14:48:02 +00:00
{ U64 const crcDest = XXH64 ( dstBuffer , totalTestSize , 0 ) ;
if ( crcDest ! = crcOrig ) findDiff ( copyBuffer , dstBuffer , totalTestSize ) ;
CHECK ( crcDest ! = crcOrig , " decompressed data corrupted " ) ;
} }
/*===== noisy/erroneous src decompression test =====*/
/* add some noise */
{ U32 const nbNoiseChunks = ( FUZ_rand ( & lseed ) & 7 ) + 2 ;
U32 nn ; for ( nn = 0 ; nn < nbNoiseChunks ; nn + + ) {
size_t const randomNoiseSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
size_t const noiseSize = MIN ( ( cSize / 3 ) , randomNoiseSize ) ;
size_t const noiseStart = FUZ_rand ( & lseed ) % ( srcBufferSize - noiseSize ) ;
size_t const cStart = FUZ_rand ( & lseed ) % ( cSize - noiseSize ) ;
memcpy ( cBuffer + cStart , srcBuffer + noiseStart , noiseSize ) ;
} }
/* try decompression on noisy data */
2017-06-21 22:53:42 +00:00
CHECK_Z ( ZSTD_initDStream ( zd_noise ) ) ; /* note : no dictionary */
2016-08-16 23:39:22 +00:00
{ ZSTD_inBuffer inBuff = { cBuffer , cSize , 0 } ;
ZSTD_outBuffer outBuff = { dstBuffer , dstBufferSize , 0 } ;
while ( outBuff . pos < dstBufferSize ) {
2016-08-12 14:48:02 +00:00
size_t const randomCSrcSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
size_t const randomDstSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
2016-08-16 23:39:22 +00:00
size_t const adjustedDstSize = MIN ( dstBufferSize - outBuff . pos , randomDstSize ) ;
2017-01-28 01:25:07 +00:00
size_t const adjustedCSrcSize = MIN ( cSize - inBuff . pos , randomCSrcSize ) ;
2016-08-16 23:39:22 +00:00
outBuff . size = outBuff . pos + adjustedDstSize ;
2017-01-28 01:25:07 +00:00
inBuff . size = inBuff . pos + adjustedCSrcSize ;
2016-08-16 23:39:22 +00:00
{ size_t const decompressError = ZSTD_decompressStream ( zd , & outBuff , & inBuff ) ;
2016-08-12 14:48:02 +00:00
if ( ZSTD_isError ( decompressError ) ) break ; /* error correctly detected */
2017-01-28 01:25:07 +00:00
/* No forward progress possible */
if ( outBuff . pos < outBuff . size & & inBuff . pos = = cSize ) break ;
2016-08-12 14:48:02 +00:00
} } } }
DISPLAY ( " \r %u fuzzer tests completed \n " , testNb ) ;
_cleanup :
ZSTD_freeCStream ( zc ) ;
ZSTD_freeDStream ( zd ) ;
2016-09-24 23:34:03 +00:00
ZSTD_freeDStream ( zd_noise ) ;
2016-08-12 14:48:02 +00:00
free ( cNoiseBuffer [ 0 ] ) ;
free ( cNoiseBuffer [ 1 ] ) ;
free ( cNoiseBuffer [ 2 ] ) ;
free ( cNoiseBuffer [ 3 ] ) ;
free ( cNoiseBuffer [ 4 ] ) ;
free ( copyBuffer ) ;
free ( cBuffer ) ;
free ( dstBuffer ) ;
return result ;
_output_error :
result = 1 ;
goto _cleanup ;
}
2017-08-21 19:41:19 +00:00
/** If useOpaqueAPI, sets param in cctxParams.
* Otherwise , sets the param in zc . */
static size_t setCCtxParameter ( ZSTD_CCtx * zc , ZSTD_CCtx_params * cctxParams ,
ZSTD_cParameter param , unsigned value ,
2018-06-19 02:20:37 +00:00
int useOpaqueAPI )
2017-08-21 19:41:19 +00:00
{
if ( useOpaqueAPI ) {
2019-02-20 01:41:56 +00:00
return ZSTD_CCtxParams_setParameter ( cctxParams , param , value ) ;
2017-08-21 19:41:19 +00:00
} else {
return ZSTD_CCtx_setParameter ( zc , param , value ) ;
}
}
2017-01-19 20:12:50 +00:00
2017-06-19 18:53:01 +00:00
/* Tests for ZSTD_compress_generic() API */
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
static int fuzzerTests_newAPI ( U32 seed , int nbTests , int startTest ,
2018-06-19 02:20:37 +00:00
double compressibility , int bigTests )
2017-06-17 00:56:41 +00:00
{
2017-06-22 06:35:58 +00:00
U32 const maxSrcLog = bigTests ? 24 : 22 ;
2017-06-17 00:56:41 +00:00
static const U32 maxSampleLog = 19 ;
size_t const srcBufferSize = ( size_t ) 1 < < maxSrcLog ;
BYTE * cNoiseBuffer [ 5 ] ;
size_t const copyBufferSize = srcBufferSize + ( 1 < < maxSampleLog ) ;
BYTE * const copyBuffer = ( BYTE * ) malloc ( copyBufferSize ) ;
size_t const cBufferSize = ZSTD_compressBound ( srcBufferSize ) ;
BYTE * const cBuffer = ( BYTE * ) malloc ( cBufferSize ) ;
size_t const dstBufferSize = srcBufferSize ;
BYTE * const dstBuffer = ( BYTE * ) malloc ( dstBufferSize ) ;
U32 result = 0 ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
int testNb = 0 ;
2017-06-17 00:56:41 +00:00
U32 coreSeed = seed ;
ZSTD_CCtx * zc = ZSTD_createCCtx ( ) ; /* will be reset sometimes */
ZSTD_DStream * zd = ZSTD_createDStream ( ) ; /* will be reset sometimes */
ZSTD_DStream * const zd_noise = ZSTD_createDStream ( ) ;
2017-11-30 03:11:12 +00:00
UTIL_time_t const startClock = UTIL_getTime ( ) ;
2017-06-19 18:53:01 +00:00
const BYTE * dict = NULL ; /* can keep same dict on 2 consecutive tests */
2017-06-17 00:56:41 +00:00
size_t dictSize = 0 ;
U32 oldTestLog = 0 ;
2017-09-28 01:00:15 +00:00
U32 windowLogMalus = 0 ; /* can survive between 2 loops */
U32 const cLevelMax = bigTests ? ( U32 ) ZSTD_maxCLevel ( ) - 1 : g_cLevelMax_smallTests ;
U32 const nbThreadsMax = bigTests ? 4 : 2 ;
2017-08-21 05:55:07 +00:00
ZSTD_CCtx_params * cctxParams = ZSTD_createCCtxParams ( ) ;
2017-06-17 00:56:41 +00:00
/* allocations */
cNoiseBuffer [ 0 ] = ( BYTE * ) malloc ( srcBufferSize ) ;
cNoiseBuffer [ 1 ] = ( BYTE * ) malloc ( srcBufferSize ) ;
cNoiseBuffer [ 2 ] = ( BYTE * ) malloc ( srcBufferSize ) ;
cNoiseBuffer [ 3 ] = ( BYTE * ) malloc ( srcBufferSize ) ;
cNoiseBuffer [ 4 ] = ( BYTE * ) malloc ( srcBufferSize ) ;
CHECK ( ! cNoiseBuffer [ 0 ] | | ! cNoiseBuffer [ 1 ] | | ! cNoiseBuffer [ 2 ] | | ! cNoiseBuffer [ 3 ] | | ! cNoiseBuffer [ 4 ] | |
! copyBuffer | | ! dstBuffer | | ! cBuffer | | ! zc | | ! zd | | ! zd_noise ,
" Not enough memory, fuzzer tests cancelled " ) ;
/* Create initial samples */
RDG_genBuffer ( cNoiseBuffer [ 0 ] , srcBufferSize , 0.00 , 0. , coreSeed ) ; /* pure noise */
RDG_genBuffer ( cNoiseBuffer [ 1 ] , srcBufferSize , 0.05 , 0. , coreSeed ) ; /* barely compressible */
RDG_genBuffer ( cNoiseBuffer [ 2 ] , srcBufferSize , compressibility , 0. , coreSeed ) ;
RDG_genBuffer ( cNoiseBuffer [ 3 ] , srcBufferSize , 0.95 , 0. , coreSeed ) ; /* highly compressible */
RDG_genBuffer ( cNoiseBuffer [ 4 ] , srcBufferSize , 1.00 , 0. , coreSeed ) ; /* sparse content */
memset ( copyBuffer , 0x65 , copyBufferSize ) ; /* make copyBuffer considered initialized */
2017-06-21 22:53:42 +00:00
CHECK_Z ( ZSTD_initDStream_usingDict ( zd , NULL , 0 ) ) ; /* ensure at least one init */
2017-06-17 00:56:41 +00:00
/* catch up testNb */
for ( testNb = 1 ; testNb < startTest ; testNb + + )
FUZ_rand ( & coreSeed ) ;
/* test loop */
2017-11-30 03:11:12 +00:00
for ( ; ( testNb < = nbTests ) | | ( UTIL_clockSpanMicro ( startClock ) < g_clockTime ) ; testNb + + ) {
2017-06-17 00:56:41 +00:00
U32 lseed ;
2018-06-19 02:20:37 +00:00
int opaqueAPI ;
2017-06-17 00:56:41 +00:00
const BYTE * srcBuffer ;
size_t totalTestSize , totalGenSize , cSize ;
XXH64_state_t xxhState ;
U64 crcOrig ;
U32 resetAllowed = 1 ;
size_t maxTestSize ;
2018-04-25 23:32:29 +00:00
ZSTD_parameters savedParams ;
2020-10-01 22:02:15 +00:00
int isRefPrefix = 0 ;
U64 pledgedSrcSize = ZSTD_CONTENTSIZE_UNKNOWN ;
2017-06-17 00:56:41 +00:00
/* init */
if ( nbTests > = testNb ) { DISPLAYUPDATE ( 2 , " \r %6u/%6u " , testNb , nbTests ) ; }
else { DISPLAYUPDATE ( 2 , " \r %6u " , testNb ) ; }
FUZ_rand ( & coreSeed ) ;
lseed = coreSeed ^ prime32 ;
2017-09-28 08:25:40 +00:00
DISPLAYLEVEL ( 5 , " *** Test %u *** \n " , testNb ) ;
2018-06-19 02:20:37 +00:00
opaqueAPI = FUZ_rand ( & lseed ) & 1 ;
2017-06-17 00:56:41 +00:00
/* states full reset (deliberately not synchronized) */
/* some issues can only happen when reusing states */
if ( ( FUZ_rand ( & lseed ) & 0xFF ) = = 131 ) {
DISPLAYLEVEL ( 5 , " Creating new context \n " ) ;
ZSTD_freeCCtx ( zc ) ;
zc = ZSTD_createCCtx ( ) ;
2018-06-20 03:14:03 +00:00
CHECK ( zc = = NULL , " ZSTD_createCCtx allocation error " ) ;
resetAllowed = 0 ;
2017-06-17 00:56:41 +00:00
}
if ( ( FUZ_rand ( & lseed ) & 0xFF ) = = 132 ) {
ZSTD_freeDStream ( zd ) ;
zd = ZSTD_createDStream ( ) ;
2018-06-20 03:14:03 +00:00
CHECK ( zd = = NULL , " ZSTD_createDStream allocation error " ) ;
2017-06-17 00:56:41 +00:00
ZSTD_initDStream_usingDict ( zd , NULL , 0 ) ; /* ensure at least one init */
}
/* srcBuffer selection [0-4] */
{ U32 buffNb = FUZ_rand ( & lseed ) & 0x7F ;
if ( buffNb & 7 ) buffNb = 2 ; /* most common : compressible (P) */
else {
buffNb > > = 3 ;
if ( buffNb & 7 ) {
const U32 tnb [ 2 ] = { 1 , 3 } ; /* barely/highly compressible */
buffNb = tnb [ buffNb > > 3 ] ;
} else {
const U32 tnb [ 2 ] = { 0 , 4 } ; /* not compressible / sparse */
buffNb = tnb [ buffNb > > 3 ] ;
} }
srcBuffer = cNoiseBuffer [ buffNb ] ;
}
/* compression init */
2017-06-27 22:49:12 +00:00
CHECK_Z ( ZSTD_CCtx_loadDictionary ( zc , NULL , 0 ) ) ; /* cancel previous dict /*/
2017-06-17 00:56:41 +00:00
if ( ( FUZ_rand ( & lseed ) & 1 ) /* at beginning, to keep same nb of rand */
2018-06-01 22:18:32 +00:00
& & oldTestLog /* at least one test happened */
& & resetAllowed ) {
/* just set a compression level */
2017-06-17 00:56:41 +00:00
maxTestSize = FUZ_randomLength ( & lseed , oldTestLog + 2 ) ;
if ( maxTestSize > = srcBufferSize ) maxTestSize = srcBufferSize - 1 ;
{ int const compressionLevel = ( FUZ_rand ( & lseed ) % 5 ) + 1 ;
2018-06-01 22:18:32 +00:00
DISPLAYLEVEL ( 5 , " t%u : compression level : %i \n " , testNb , compressionLevel ) ;
2018-12-06 01:26:02 +00:00
CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_compressionLevel , compressionLevel , opaqueAPI ) ) ;
2017-06-17 00:56:41 +00:00
}
} else {
U32 const testLog = FUZ_rand ( & lseed ) % maxSrcLog ;
U32 const dictLog = FUZ_rand ( & lseed ) % maxSrcLog ;
2017-06-22 00:57:14 +00:00
U32 const cLevelCandidate = ( FUZ_rand ( & lseed ) %
2017-06-17 00:56:41 +00:00
( ZSTD_maxCLevel ( ) -
2017-09-28 08:42:06 +00:00
( MAX ( testLog , dictLog ) / 2 ) ) ) +
2017-06-17 00:56:41 +00:00
1 ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
int const cLevel = MIN ( cLevelCandidate , cLevelMax ) ;
DISPLAYLEVEL ( 5 , " t%i: base cLevel : %u \n " , testNb , cLevel ) ;
2017-06-17 00:56:41 +00:00
maxTestSize = FUZ_rLogLength ( & lseed , testLog ) ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 5 , " t%i: maxTestSize : %u \n " , testNb , ( unsigned ) maxTestSize ) ;
2017-06-17 00:56:41 +00:00
oldTestLog = testLog ;
/* random dictionary selection */
dictSize = ( ( FUZ_rand ( & lseed ) & 63 ) = = 1 ) ? FUZ_rLogLength ( & lseed , dictLog ) : 0 ;
{ size_t const dictStart = FUZ_rand ( & lseed ) % ( srcBufferSize - dictSize ) ;
dict = srcBuffer + dictStart ;
2017-06-19 18:53:01 +00:00
if ( ! dictSize ) dict = NULL ;
2017-06-17 00:56:41 +00:00
}
2020-10-01 22:02:15 +00:00
pledgedSrcSize = ( FUZ_rand ( & lseed ) & 3 ) ? ZSTD_CONTENTSIZE_UNKNOWN : maxTestSize ;
{ ZSTD_compressionParameters cParams = ZSTD_getCParams ( cLevel , pledgedSrcSize , dictSize ) ;
2018-09-27 20:55:24 +00:00
const U32 windowLogMax = bigTests ? 24 : 20 ;
const U32 searchLogMax = bigTests ? 15 : 13 ;
2018-06-01 22:18:32 +00:00
if ( dictSize )
DISPLAYLEVEL ( 5 , " t%u: with dictionary of size : %zu \n " , testNb , dictSize ) ;
2017-06-17 00:56:41 +00:00
/* mess with compression parameters */
cParams . windowLog + = ( FUZ_rand ( & lseed ) & 3 ) - 1 ;
2017-09-22 21:04:39 +00:00
cParams . windowLog = MIN ( windowLogMax , cParams . windowLog ) ;
2017-06-17 00:56:41 +00:00
cParams . hashLog + = ( FUZ_rand ( & lseed ) & 3 ) - 1 ;
cParams . chainLog + = ( FUZ_rand ( & lseed ) & 3 ) - 1 ;
cParams . searchLog + = ( FUZ_rand ( & lseed ) & 3 ) - 1 ;
2018-09-27 20:55:24 +00:00
cParams . searchLog = MIN ( searchLogMax , cParams . searchLog ) ;
2018-11-20 22:56:07 +00:00
cParams . minMatch + = ( FUZ_rand ( & lseed ) & 3 ) - 1 ;
2017-09-28 01:00:15 +00:00
cParams . targetLength = ( U32 ) ( ( cParams . targetLength + 1 ) * ( 0.5 + ( ( double ) ( FUZ_rand ( & lseed ) & 127 ) / 128 ) ) ) ;
2018-06-01 22:18:32 +00:00
cParams = ZSTD_adjustCParams ( cParams , pledgedSrcSize , dictSize ) ;
2017-06-17 00:56:41 +00:00
2017-09-28 01:00:15 +00:00
if ( FUZ_rand ( & lseed ) & 1 ) {
2017-11-30 00:42:20 +00:00
DISPLAYLEVEL ( 5 , " t%u: windowLog : %u \n " , testNb , cParams . windowLog ) ;
2018-12-06 01:26:02 +00:00
CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_windowLog , cParams . windowLog , opaqueAPI ) ) ;
2017-09-28 01:00:15 +00:00
assert ( cParams . windowLog > = ZSTD_WINDOWLOG_MIN ) ; /* guaranteed by ZSTD_adjustCParams() */
windowLogMalus = ( cParams . windowLog - ZSTD_WINDOWLOG_MIN ) / 5 ;
2017-09-28 08:25:40 +00:00
}
if ( FUZ_rand ( & lseed ) & 1 ) {
DISPLAYLEVEL ( 5 , " t%u: hashLog : %u \n " , testNb , cParams . hashLog ) ;
2018-12-06 01:26:02 +00:00
CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_hashLog , cParams . hashLog , opaqueAPI ) ) ;
2017-09-28 08:25:40 +00:00
}
if ( FUZ_rand ( & lseed ) & 1 ) {
DISPLAYLEVEL ( 5 , " t%u: chainLog : %u \n " , testNb , cParams . chainLog ) ;
2018-12-06 01:26:02 +00:00
CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_chainLog , cParams . chainLog , opaqueAPI ) ) ;
2017-09-28 01:00:15 +00:00
}
2018-12-06 01:26:02 +00:00
if ( FUZ_rand ( & lseed ) & 1 ) CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_searchLog , cParams . searchLog , opaqueAPI ) ) ;
if ( FUZ_rand ( & lseed ) & 1 ) CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_minMatch , cParams . minMatch , opaqueAPI ) ) ;
if ( FUZ_rand ( & lseed ) & 1 ) CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_targetLength , cParams . targetLength , opaqueAPI ) ) ;
2017-06-17 00:56:41 +00:00
2017-09-06 15:39:46 +00:00
/* mess with long distance matching parameters */
2017-11-30 00:42:20 +00:00
if ( bigTests ) {
2018-12-06 01:26:02 +00:00
if ( FUZ_rand ( & lseed ) & 1 ) CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_enableLongDistanceMatching , FUZ_rand ( & lseed ) & 63 , opaqueAPI ) ) ;
if ( FUZ_rand ( & lseed ) & 3 ) CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_ldmHashLog , FUZ_randomClampedLength ( & lseed , ZSTD_HASHLOG_MIN , 23 ) , opaqueAPI ) ) ;
if ( FUZ_rand ( & lseed ) & 3 ) CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_ldmMinMatch , FUZ_randomClampedLength ( & lseed , ZSTD_LDM_MINMATCH_MIN , ZSTD_LDM_MINMATCH_MAX ) , opaqueAPI ) ) ;
if ( FUZ_rand ( & lseed ) & 3 ) CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_ldmBucketSizeLog , FUZ_randomClampedLength ( & lseed , ZSTD_LDM_BUCKETSIZELOG_MIN , ZSTD_LDM_BUCKETSIZELOG_MAX ) , opaqueAPI ) ) ;
if ( FUZ_rand ( & lseed ) & 3 ) CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_ldmHashRateLog , FUZ_randomClampedLength ( & lseed , ZSTD_LDM_HASHRATELOG_MIN , ZSTD_LDM_HASHRATELOG_MAX ) , opaqueAPI ) ) ;
2019-08-20 20:06:15 +00:00
if ( FUZ_rand ( & lseed ) & 3 ) CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_srcSizeHint , FUZ_randomClampedLength ( & lseed , ZSTD_SRCSIZEHINT_MIN , ZSTD_SRCSIZEHINT_MAX ) , opaqueAPI ) ) ;
2017-11-30 00:42:20 +00:00
}
2017-07-28 22:51:33 +00:00
2017-06-17 00:56:41 +00:00
/* mess with frame parameters */
2018-01-23 21:12:40 +00:00
if ( FUZ_rand ( & lseed ) & 1 ) {
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
int const checksumFlag = FUZ_rand ( & lseed ) & 1 ;
2018-01-23 21:12:40 +00:00
DISPLAYLEVEL ( 5 , " t%u: frame checksum : %u \n " , testNb , checksumFlag ) ;
2018-12-06 01:26:02 +00:00
CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_checksumFlag , checksumFlag , opaqueAPI ) ) ;
2018-01-23 21:12:40 +00:00
}
2018-12-06 01:26:02 +00:00
if ( FUZ_rand ( & lseed ) & 1 ) CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_dictIDFlag , FUZ_rand ( & lseed ) & 1 , opaqueAPI ) ) ;
if ( FUZ_rand ( & lseed ) & 1 ) CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_contentSizeFlag , FUZ_rand ( & lseed ) & 1 , opaqueAPI ) ) ;
2017-11-30 00:42:20 +00:00
if ( FUZ_rand ( & lseed ) & 1 ) {
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 5 , " t%u: pledgedSrcSize : %u \n " , testNb , ( unsigned ) pledgedSrcSize ) ;
2017-11-30 00:42:20 +00:00
CHECK_Z ( ZSTD_CCtx_setPledgedSrcSize ( zc , pledgedSrcSize ) ) ;
2020-10-01 22:02:15 +00:00
} else {
pledgedSrcSize = ZSTD_CONTENTSIZE_UNKNOWN ;
2017-11-30 00:42:20 +00:00
}
2017-06-17 00:56:41 +00:00
2019-04-12 18:18:11 +00:00
/* multi-threading parameters. Only adjust occasionally for small tests. */
2018-09-27 22:49:31 +00:00
if ( bigTests | | ( FUZ_rand ( & lseed ) & 0xF ) = = 0xF ) {
U32 const nbThreadsCandidate = ( FUZ_rand ( & lseed ) & 4 ) + 1 ;
2017-09-28 01:00:15 +00:00
U32 const nbThreadsAdjusted = ( windowLogMalus < nbThreadsCandidate ) ? nbThreadsCandidate - windowLogMalus : 1 ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
int const nbThreads = MIN ( nbThreadsAdjusted , nbThreadsMax ) ;
DISPLAYLEVEL ( 5 , " t%i: nbThreads : %u \n " , testNb , nbThreads ) ;
2018-12-06 01:26:02 +00:00
CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_nbWorkers , nbThreads , opaqueAPI ) ) ;
2017-06-17 00:56:41 +00:00
if ( nbThreads > 1 ) {
2017-06-19 18:07:33 +00:00
U32 const jobLog = FUZ_rand ( & lseed ) % ( testLog + 1 ) ;
2018-12-12 00:55:33 +00:00
CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_overlapLog , FUZ_rand ( & lseed ) % 10 , opaqueAPI ) ) ;
2018-12-06 01:26:02 +00:00
CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_jobSize , ( U32 ) FUZ_rLogLength ( & lseed , jobLog ) , opaqueAPI ) ) ;
2017-08-21 05:55:07 +00:00
}
}
2018-11-14 21:53:14 +00:00
/* Enable rsyncable mode 1 in 4 times. */
2020-10-06 00:37:19 +00:00
{
int const rsyncable = ( FUZ_rand ( & lseed ) % 4 = = 0 ) ;
DISPLAYLEVEL ( 5 , " t%u: rsyncable : %d \n " , testNb , rsyncable ) ;
setCCtxParameter ( zc , cctxParams , ZSTD_c_rsyncable , rsyncable , opaqueAPI ) ;
}
2017-08-21 05:55:07 +00:00
2018-12-06 01:26:02 +00:00
if ( FUZ_rand ( & lseed ) & 1 ) CHECK_Z ( setCCtxParameter ( zc , cctxParams , ZSTD_c_forceMaxWindow , FUZ_rand ( & lseed ) & 1 , opaqueAPI ) ) ;
2017-08-21 05:55:07 +00:00
/* Apply parameters */
2018-06-19 02:20:37 +00:00
if ( opaqueAPI ) {
2018-06-01 22:18:32 +00:00
DISPLAYLEVEL ( 5 , " t%u: applying CCtxParams \n " , testNb ) ;
2017-08-30 01:03:06 +00:00
CHECK_Z ( ZSTD_CCtx_setParametersUsingCCtxParams ( zc , cctxParams ) ) ;
2017-08-21 19:41:19 +00:00
}
2017-08-21 05:55:07 +00:00
if ( FUZ_rand ( & lseed ) & 1 ) {
2017-08-25 17:48:07 +00:00
if ( FUZ_rand ( & lseed ) & 1 ) {
CHECK_Z ( ZSTD_CCtx_loadDictionary ( zc , dict , dictSize ) ) ;
} else {
CHECK_Z ( ZSTD_CCtx_loadDictionary_byReference ( zc , dict , dictSize ) ) ;
}
2017-08-21 19:41:19 +00:00
} else {
2020-10-01 22:02:15 +00:00
isRefPrefix = 1 ;
2017-08-21 05:55:07 +00:00
CHECK_Z ( ZSTD_CCtx_refPrefix ( zc , dict , dictSize ) ) ;
}
} }
2017-06-17 00:56:41 +00:00
2018-04-25 23:32:29 +00:00
CHECK_Z ( getCCtxParams ( zc , & savedParams ) ) ;
2017-06-17 00:56:41 +00:00
/* multi-segments compression test */
2020-10-01 22:02:15 +00:00
{ int iter ;
int const startSeed = lseed ;
XXH64_hash_t compressedCrcs [ 2 ] ;
for ( iter = 0 ; iter < 2 ; + + iter , lseed = startSeed ) {
ZSTD_outBuffer outBuff = { cBuffer , cBufferSize , 0 } ;
int const singlePass = ( FUZ_rand ( & lseed ) & 3 ) = = 0 ;
int nbWorkers ;
XXH64_reset ( & xxhState , 0 ) ;
CHECK_Z ( ZSTD_CCtx_setPledgedSrcSize ( zc , pledgedSrcSize ) ) ;
if ( isRefPrefix ) {
DISPLAYLEVEL ( 6 , " t%u: Reloading prefix \n " , testNb ) ;
/* Need to reload the prefix because it gets dropped after one compression */
CHECK_Z ( ZSTD_CCtx_refPrefix ( zc , dict , dictSize ) ) ;
}
2017-06-19 18:07:33 +00:00
2020-10-01 22:02:15 +00:00
/* Adjust number of workers occassionally - result must be deterministic independent of nbWorkers */
CHECK_Z ( ZSTD_CCtx_getParameter ( zc , ZSTD_c_nbWorkers , & nbWorkers ) ) ;
if ( nbWorkers > 0 & & ( FUZ_rand ( & lseed ) & 7 ) = = 0 ) {
DISPLAYLEVEL ( 6 , " t%u: Modify nbWorkers: %d -> %d \n " , testNb , nbWorkers , nbWorkers + iter ) ;
CHECK_Z ( ZSTD_CCtx_setParameter ( zc , ZSTD_c_nbWorkers , nbWorkers + iter ) ) ;
}
2017-06-19 18:07:33 +00:00
2020-10-01 22:02:15 +00:00
if ( singlePass ) {
ZSTD_inBuffer inBuff = { srcBuffer , maxTestSize , 0 } ;
CHECK_Z ( ZSTD_compressStream2 ( zc , & outBuff , & inBuff , ZSTD_e_end ) ) ;
DISPLAYLEVEL ( 6 , " t%u: Single pass compression: consumed %u bytes ; produced %u bytes \n " ,
testNb , ( unsigned ) inBuff . pos , ( unsigned ) outBuff . pos ) ;
CHECK ( inBuff . pos ! = inBuff . size , " Input not consumed! " ) ;
crcOrig = XXH64 ( srcBuffer , maxTestSize , 0 ) ;
totalTestSize = maxTestSize ;
} else {
outBuff . size = 0 ;
for ( totalTestSize = 0 ; ( totalTestSize < maxTestSize ) ; ) {
/* compress random chunks into randomly sized dst buffers */
size_t const randomSrcSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
size_t const srcSize = MIN ( maxTestSize - totalTestSize , randomSrcSize ) ;
size_t const srcStart = FUZ_rand ( & lseed ) % ( srcBufferSize - srcSize ) ;
ZSTD_EndDirective const flush = ( FUZ_rand ( & lseed ) & 15 ) ? ZSTD_e_continue : ZSTD_e_flush ;
ZSTD_inBuffer inBuff = { srcBuffer + srcStart , srcSize , 0 } ;
int forwardProgress ;
do {
size_t const ipos = inBuff . pos ;
size_t const opos = outBuff . pos ;
size_t ret ;
if ( outBuff . pos = = outBuff . size ) {
size_t const randomDstSize = FUZ_randomLength ( & lseed , maxSampleLog + 1 ) ;
size_t const dstBuffSize = MIN ( cBufferSize - outBuff . pos , randomDstSize ) ;
outBuff . size = outBuff . pos + dstBuffSize ;
}
CHECK_Z ( ret = ZSTD_compressStream2 ( zc , & outBuff , & inBuff , flush ) ) ;
DISPLAYLEVEL ( 6 , " t%u: compress consumed %u bytes (total : %u) ; flush: %u (total : %u) \n " ,
testNb , ( unsigned ) inBuff . pos , ( unsigned ) ( totalTestSize + inBuff . pos ) , ( unsigned ) flush , ( unsigned ) outBuff . pos ) ;
/* We've completed the flush */
if ( flush = = ZSTD_e_flush & & ret = = 0 )
break ;
/* Ensure maximal forward progress for determinism */
forwardProgress = ( inBuff . pos ! = ipos ) | | ( outBuff . pos ! = opos ) ;
} while ( forwardProgress ) ;
XXH64_update ( & xxhState , srcBuffer + srcStart , inBuff . pos ) ;
memcpy ( copyBuffer + totalTestSize , srcBuffer + srcStart , inBuff . pos ) ;
totalTestSize + = inBuff . pos ;
}
2017-06-17 00:56:41 +00:00
2020-10-01 22:02:15 +00:00
/* final frame epilogue */
{ size_t remainingToFlush = 1 ;
while ( remainingToFlush ) {
ZSTD_inBuffer inBuff = { NULL , 0 , 0 } ;
size_t const randomDstSize = FUZ_randomLength ( & lseed , maxSampleLog + 1 ) ;
size_t const adjustedDstSize = MIN ( cBufferSize - outBuff . pos , randomDstSize ) ;
outBuff . size = outBuff . pos + adjustedDstSize ;
DISPLAYLEVEL ( 6 , " t%u: End-flush into dst buffer of size %u \n " , testNb , ( unsigned ) adjustedDstSize ) ;
/* ZSTD_e_end guarantees maximal forward progress */
remainingToFlush = ZSTD_compressStream2 ( zc , & outBuff , & inBuff , ZSTD_e_end ) ;
DISPLAYLEVEL ( 6 , " t%u: Total flushed so far : %u bytes \n " , testNb , ( unsigned ) outBuff . pos ) ;
CHECK ( ZSTD_isError ( remainingToFlush ) ,
" ZSTD_compressStream2 w/ ZSTD_e_end error : %s " ,
ZSTD_getErrorName ( remainingToFlush ) ) ;
} }
crcOrig = XXH64_digest ( & xxhState ) ;
}
cSize = outBuff . pos ;
compressedCrcs [ iter ] = XXH64 ( cBuffer , cSize , 0 ) ;
DISPLAYLEVEL ( 5 , " Frame completed : %zu bytes \n " , cSize ) ;
}
CHECK ( ! ( compressedCrcs [ 0 ] = = compressedCrcs [ 1 ] ) , " Compression is not deterministic! " ) ;
2017-06-17 00:56:41 +00:00
}
2018-04-25 23:32:29 +00:00
CHECK ( badParameters ( zc , savedParams ) , " CCtx params are wrong " ) ;
2017-06-17 00:56:41 +00:00
/* multi - fragments decompression test */
if ( ! dictSize /* don't reset if dictionary : could be different */ & & ( FUZ_rand ( & lseed ) & 1 ) ) {
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAYLEVEL ( 5 , " resetting DCtx (dict:%p) \n " , dict ) ;
2017-06-21 22:53:42 +00:00
CHECK_Z ( ZSTD_resetDStream ( zd ) ) ;
2017-06-17 00:56:41 +00:00
} else {
2018-06-01 22:18:32 +00:00
if ( dictSize )
DISPLAYLEVEL ( 5 , " using dictionary of size %zu \n " , dictSize ) ;
2017-06-21 22:53:42 +00:00
CHECK_Z ( ZSTD_initDStream_usingDict ( zd , dict , dictSize ) ) ;
2017-06-17 00:56:41 +00:00
}
{ size_t decompressionResult = 1 ;
ZSTD_inBuffer inBuff = { cBuffer , cSize , 0 } ;
ZSTD_outBuffer outBuff = { dstBuffer , dstBufferSize , 0 } ;
for ( totalGenSize = 0 ; decompressionResult ; ) {
size_t const readCSrcSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
size_t const randomDstSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
size_t const dstBuffSize = MIN ( dstBufferSize - totalGenSize , randomDstSize ) ;
inBuff . size = inBuff . pos + readCSrcSize ;
2017-09-27 08:01:11 +00:00
outBuff . size = outBuff . pos + dstBuffSize ;
2018-01-24 02:00:51 +00:00
DISPLAYLEVEL ( 6 , " decompression presented %u new bytes (pos:%u/%u) \n " ,
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
( unsigned ) readCSrcSize , ( unsigned ) inBuff . pos , ( unsigned ) cSize ) ;
2017-06-17 00:56:41 +00:00
decompressionResult = ZSTD_decompressStream ( zd , & outBuff , & inBuff ) ;
2018-01-24 02:00:51 +00:00
DISPLAYLEVEL ( 6 , " so far: consumed = %u, produced = %u \n " ,
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
( unsigned ) inBuff . pos , ( unsigned ) outBuff . pos ) ;
2018-01-23 21:12:40 +00:00
if ( ZSTD_isError ( decompressionResult ) ) {
DISPLAY ( " ZSTD_decompressStream error : %s \n " , ZSTD_getErrorName ( decompressionResult ) ) ;
findDiff ( copyBuffer , dstBuffer , totalTestSize ) ;
}
2017-06-17 00:56:41 +00:00
CHECK ( ZSTD_isError ( decompressionResult ) , " decompression error : %s " , ZSTD_getErrorName ( decompressionResult ) ) ;
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
CHECK ( inBuff . pos > cSize , " ZSTD_decompressStream consumes too much input : %u > %u " , ( unsigned ) inBuff . pos , ( unsigned ) cSize ) ;
2017-06-17 00:56:41 +00:00
}
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
CHECK ( inBuff . pos ! = cSize , " compressed data should be fully read (%u != %u) " , ( unsigned ) inBuff . pos , ( unsigned ) cSize ) ;
CHECK ( outBuff . pos ! = totalTestSize , " decompressed data : wrong size (%u != %u) " , ( unsigned ) outBuff . pos , ( unsigned ) totalTestSize ) ;
2017-06-17 00:56:41 +00:00
{ U64 const crcDest = XXH64 ( dstBuffer , totalTestSize , 0 ) ;
if ( crcDest ! = crcOrig ) findDiff ( copyBuffer , dstBuffer , totalTestSize ) ;
CHECK ( crcDest ! = crcOrig , " decompressed data corrupted " ) ;
} }
/*===== noisy/erroneous src decompression test =====*/
/* add some noise */
{ U32 const nbNoiseChunks = ( FUZ_rand ( & lseed ) & 7 ) + 2 ;
U32 nn ; for ( nn = 0 ; nn < nbNoiseChunks ; nn + + ) {
size_t const randomNoiseSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
size_t const noiseSize = MIN ( ( cSize / 3 ) , randomNoiseSize ) ;
size_t const noiseStart = FUZ_rand ( & lseed ) % ( srcBufferSize - noiseSize ) ;
size_t const cStart = FUZ_rand ( & lseed ) % ( cSize - noiseSize ) ;
memcpy ( cBuffer + cStart , srcBuffer + noiseStart , noiseSize ) ;
} }
/* try decompression on noisy data */
2017-06-21 22:53:42 +00:00
CHECK_Z ( ZSTD_initDStream ( zd_noise ) ) ; /* note : no dictionary */
2017-06-17 00:56:41 +00:00
{ ZSTD_inBuffer inBuff = { cBuffer , cSize , 0 } ;
ZSTD_outBuffer outBuff = { dstBuffer , dstBufferSize , 0 } ;
while ( outBuff . pos < dstBufferSize ) {
size_t const randomCSrcSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
size_t const randomDstSize = FUZ_randomLength ( & lseed , maxSampleLog ) ;
size_t const adjustedDstSize = MIN ( dstBufferSize - outBuff . pos , randomDstSize ) ;
size_t const adjustedCSrcSize = MIN ( cSize - inBuff . pos , randomCSrcSize ) ;
outBuff . size = outBuff . pos + adjustedDstSize ;
inBuff . size = inBuff . pos + adjustedCSrcSize ;
{ size_t const decompressError = ZSTD_decompressStream ( zd , & outBuff , & inBuff ) ;
if ( ZSTD_isError ( decompressError ) ) break ; /* error correctly detected */
2017-06-19 18:07:33 +00:00
/* Good so far, but no more progress possible */
2017-06-17 00:56:41 +00:00
if ( outBuff . pos < outBuff . size & & inBuff . pos = = cSize ) break ;
} } } }
2017-06-19 06:25:15 +00:00
DISPLAY ( " \r %u fuzzer tests completed \n " , testNb - 1 ) ;
2017-06-17 00:56:41 +00:00
_cleanup :
ZSTD_freeCCtx ( zc ) ;
ZSTD_freeDStream ( zd ) ;
ZSTD_freeDStream ( zd_noise ) ;
2017-08-21 05:55:07 +00:00
ZSTD_freeCCtxParams ( cctxParams ) ;
2017-06-17 00:56:41 +00:00
free ( cNoiseBuffer [ 0 ] ) ;
free ( cNoiseBuffer [ 1 ] ) ;
free ( cNoiseBuffer [ 2 ] ) ;
free ( cNoiseBuffer [ 3 ] ) ;
free ( cNoiseBuffer [ 4 ] ) ;
free ( copyBuffer ) ;
free ( cBuffer ) ;
free ( dstBuffer ) ;
return result ;
_output_error :
result = 1 ;
goto _cleanup ;
}
2016-08-12 14:48:02 +00:00
/*-*******************************************************
* Command line
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
2018-09-27 22:13:43 +00:00
static int FUZ_usage ( const char * programName )
2016-08-12 14:48:02 +00:00
{
DISPLAY ( " Usage : \n " ) ;
DISPLAY ( " %s [args] \n " , programName ) ;
DISPLAY ( " \n " ) ;
DISPLAY ( " Arguments : \n " ) ;
2020-03-23 21:46:56 +00:00
DISPLAY ( " -i# : Number of tests (default:%u) \n " , nbTestsDefault ) ;
DISPLAY ( " -T# : Max duration to run for. Overrides number of tests. (e.g. -T1m or -T60s for one minute) \n " ) ;
2016-08-12 14:48:02 +00:00
DISPLAY ( " -s# : Select seed (default:prompt user) \n " ) ;
DISPLAY ( " -t# : Select starting test number (default:0) \n " ) ;
DISPLAY ( " -P# : Select compressibility in %% (default:%i%%) \n " , FUZ_COMPRESSIBILITY_DEFAULT ) ;
DISPLAY ( " -v : verbose \n " ) ;
DISPLAY ( " -p : pause at the end \n " ) ;
DISPLAY ( " -h : display help and exit \n " ) ;
return 0 ;
}
2020-10-02 01:47:54 +00:00
typedef enum { simple_api , advanced_api } e_api ;
2016-08-12 14:48:02 +00:00
int main ( int argc , const char * * argv )
{
2017-11-27 20:15:23 +00:00
U32 seed = 0 ;
int seedset = 0 ;
2016-08-12 14:48:02 +00:00
int nbTests = nbTestsDefault ;
int testNb = 0 ;
int proba = FUZ_COMPRESSIBILITY_DEFAULT ;
2017-11-27 20:15:23 +00:00
int result = 0 ;
2017-01-19 23:32:07 +00:00
int mainPause = 0 ;
2017-06-30 01:19:09 +00:00
int bigTests = ( sizeof ( size_t ) = = 8 ) ;
2017-06-17 00:56:41 +00:00
e_api selected_api = simple_api ;
2017-01-19 23:32:07 +00:00
const char * const programName = argv [ 0 ] ;
2017-11-27 20:15:23 +00:00
int argNb ;
2016-08-12 14:48:02 +00:00
/* Check command line */
for ( argNb = 1 ; argNb < argc ; argNb + + ) {
const char * argument = argv [ argNb ] ;
2017-11-27 20:15:23 +00:00
assert ( argument ! = NULL ) ;
2016-08-12 14:48:02 +00:00
/* Parsing commands. Aggregated commands are allowed */
if ( argument [ 0 ] = = ' - ' ) {
2017-09-29 01:27:22 +00:00
if ( ! strcmp ( argument , " --newapi " ) ) { selected_api = advanced_api ; testNb + = ! testNb ; continue ; }
2017-03-20 18:25:00 +00:00
if ( ! strcmp ( argument , " --no-big-tests " ) ) { bigTests = 0 ; continue ; }
2017-01-19 23:32:07 +00:00
argument + + ;
2016-08-12 14:48:02 +00:00
while ( * argument ! = 0 ) {
switch ( * argument )
{
case ' h ' :
return FUZ_usage ( programName ) ;
2017-01-19 20:12:50 +00:00
2016-08-12 14:48:02 +00:00
case ' v ' :
argument + + ;
2017-01-19 20:12:50 +00:00
g_displayLevel + + ;
2016-08-12 14:48:02 +00:00
break ;
2017-01-19 20:12:50 +00:00
2016-08-12 14:48:02 +00:00
case ' q ' :
argument + + ;
g_displayLevel - - ;
break ;
2017-01-19 20:12:50 +00:00
2016-08-12 14:48:02 +00:00
case ' p ' : /* pause at the end */
argument + + ;
mainPause = 1 ;
break ;
2017-01-19 20:12:50 +00:00
case ' i ' : /* limit tests by nb of iterations (default) */
2016-08-12 14:48:02 +00:00
argument + + ;
2016-09-01 23:44:48 +00:00
nbTests = 0 ; g_clockTime = 0 ;
2016-08-12 14:48:02 +00:00
while ( ( * argument > = ' 0 ' ) & & ( * argument < = ' 9 ' ) ) {
nbTests * = 10 ;
nbTests + = * argument - ' 0 ' ;
argument + + ;
}
break ;
2017-01-19 20:12:50 +00:00
case ' T ' : /* limit tests by time */
2016-08-12 14:48:02 +00:00
argument + + ;
2016-09-01 23:44:48 +00:00
nbTests = 0 ; g_clockTime = 0 ;
2016-08-12 14:48:02 +00:00
while ( ( * argument > = ' 0 ' ) & & ( * argument < = ' 9 ' ) ) {
2016-09-01 23:44:48 +00:00
g_clockTime * = 10 ;
g_clockTime + = * argument - ' 0 ' ;
2016-08-12 14:48:02 +00:00
argument + + ;
}
2017-11-27 20:15:23 +00:00
if ( * argument = = ' m ' ) { /* -T1m == -T60 */
g_clockTime * = 60 , argument + + ;
if ( * argument = = ' n ' ) argument + + ; /* -T1mn == -T60 */
} else if ( * argument = = ' s ' ) argument + + ; /* -T10s == -T10 */
2017-11-30 03:11:12 +00:00
g_clockTime * = SEC_TO_MICRO ;
2016-08-12 14:48:02 +00:00
break ;
2017-01-19 20:12:50 +00:00
case ' s ' : /* manually select seed */
2016-08-12 14:48:02 +00:00
argument + + ;
seedset = 1 ;
2017-11-27 20:15:23 +00:00
seed = 0 ;
2016-08-12 14:48:02 +00:00
while ( ( * argument > = ' 0 ' ) & & ( * argument < = ' 9 ' ) ) {
seed * = 10 ;
seed + = * argument - ' 0 ' ;
argument + + ;
}
break ;
2017-01-19 20:12:50 +00:00
case ' t ' : /* select starting test number */
2016-08-12 14:48:02 +00:00
argument + + ;
testNb = 0 ;
while ( ( * argument > = ' 0 ' ) & & ( * argument < = ' 9 ' ) ) {
testNb * = 10 ;
testNb + = * argument - ' 0 ' ;
argument + + ;
}
break ;
case ' P ' : /* compressibility % */
argument + + ;
proba = 0 ;
while ( ( * argument > = ' 0 ' ) & & ( * argument < = ' 9 ' ) ) {
proba * = 10 ;
proba + = * argument - ' 0 ' ;
argument + + ;
}
if ( proba < 0 ) proba = 0 ;
if ( proba > 100 ) proba = 100 ;
break ;
default :
return FUZ_usage ( programName ) ;
}
} } } /* for(argNb=1; argNb<argc; argNb++) */
/* Get Seed */
2016-08-25 17:11:11 +00:00
DISPLAY ( " Starting zstream tester (%i-bits, %s) \n " , ( int ) ( sizeof ( size_t ) * 8 ) , ZSTD_VERSION_STRING ) ;
2016-08-12 14:48:02 +00:00
2016-09-01 23:44:48 +00:00
if ( ! seedset ) {
time_t const t = time ( NULL ) ;
U32 const h = XXH32 ( & t , sizeof ( t ) , 1 ) ;
seed = h % 10000 ;
}
fix confusion between unsigned <-> U32
as suggested in #1441.
generally U32 and unsigned are the same thing,
except when they are not ...
case : 32-bit compilation for MIPS (uint32_t == unsigned long)
A vast majority of transformation consists in transforming U32 into unsigned.
In rare cases, it's the other way around (typically for internal code, such as seeds).
Among a few issues this patches solves :
- some parameters were declared with type `unsigned` in *.h,
but with type `U32` in their implementation *.c .
- some parameters have type unsigned*,
but the caller user a pointer to U32 instead.
These fixes are useful.
However, the bulk of changes is about %u formating,
which requires unsigned type,
but generally receives U32 values instead,
often just for brevity (U32 is shorter than unsigned).
These changes are generally minor, or even annoying.
As a consequence, the amount of code changed is larger than I would expect for such a patch.
Testing is also a pain :
it requires manually modifying `mem.h`,
in order to lie about `U32`
and force it to be an `unsigned long` typically.
On a 64-bit system, this will break the equivalence unsigned == U32.
Unfortunately, it will also break a few static_assert(), controlling structure sizes.
So it also requires modifying `debug.h` to make `static_assert()` a noop.
And then reverting these changes.
So it's inconvenient, and as a consequence,
this property is currently not checked during CI tests.
Therefore, these problems can emerge again in the future.
I wonder if it is worth ensuring proper distinction of U32 != unsigned in CI tests.
It's another restriction for coding, adding more frustration during merge tests,
since most platforms don't need this distinction (hence contributor will not see it),
and while this can matter in theory, the number of platforms impacted seems minimal.
Thoughts ?
2018-12-22 00:19:44 +00:00
DISPLAY ( " Seed = %u \n " , ( unsigned ) seed ) ;
2016-08-12 14:48:02 +00:00
if ( proba ! = FUZ_COMPRESSIBILITY_DEFAULT ) DISPLAY ( " Compressibility : %i%% \n " , proba ) ;
if ( nbTests < = 0 ) nbTests = 1 ;
if ( testNb = = 0 ) {
2017-11-27 20:15:23 +00:00
result = basicUnitTests ( 0 , ( ( double ) proba ) / 100 ) ; /* constant seed for predictability */
2017-07-11 00:16:41 +00:00
}
2016-08-12 14:48:02 +00:00
2017-06-17 00:56:41 +00:00
if ( ! result ) {
switch ( selected_api )
{
case simple_api :
result = fuzzerTests ( seed , nbTests , testNb , ( ( double ) proba ) / 100 , bigTests ) ;
break ;
case advanced_api :
2018-06-19 02:20:37 +00:00
result = fuzzerTests_newAPI ( seed , nbTests , testNb , ( ( double ) proba ) / 100 , bigTests ) ;
2017-06-17 00:56:41 +00:00
break ;
default :
assert ( 0 ) ; /* impossible */
}
}
2016-08-12 14:48:02 +00:00
if ( mainPause ) {
int unused ;
DISPLAY ( " Press Enter \n " ) ;
unused = getchar ( ) ;
( void ) unused ;
}
return result ;
}
