roundTripTest.c File Reference

#include <stddef.h>
#include <stdlib.h>
#include <stdio.h>
#include <string.h>
#include <assert.h>
#include <sys/types.h>
#include <sys/stat.h>
#include "xxhash.h"
#include "lz4.h"
#include "lz4hc.h"

Go to the source code of this file.

Macros
#define	MIN_CLEVEL   (int)(-5)
#define	MIN(a, b)   ( (a) < (b) ? (a) : (b) )
#define	MSG(...)   fprintf(stderr, __VA_ARGS__)
#define	CONTROL_MSG(c, ...)

Typedefs
typedef int(*	compressFn) (const char *src, char *dst, int srcSize, int dstSize, int cLevel)

Functions
static size_t	checkBuffers (const void *buff1, const void *buff2, size_t buffSize)
static int	select_clevel (const void *refBuff, size_t refBuffSize)
static void	roundTripTest (void *resultBuff, size_t resultBuffCapacity, void *compressedBuff, size_t compressedBuffCapacity, const void *srcBuff, size_t srcSize, int clevel)
static void	roundTripCheck (const void *srcBuff, size_t srcSize, int clevel)
static size_t	getFileSize (const char *infilename)
static int	isDirectory (const char *infilename)
static void	loadFile (void *buffer, const char *fileName, size_t fileSize)
static void	fileCheck (const char *fileName, int clevel)
int	bad_usage (const char *exeName)
int	main (int argCount, const char **argv)

Macro Definition Documentation

CONTROL_MSG

#define CONTROL_MSG	(		c,
			...
	)

Value:

    {   \
    if ((c)) {                  \
        MSG(__VA_ARGS__);       \
        MSG(" \n");             \
        abort();                \
    }                           \
}

Definition at line 52 of file roundTripTest.c.

MIN

#define MIN	(		a,
			b
	)		( (a) < (b) ? (a) : (b) )

Definition at line 48 of file roundTripTest.c.

MIN_CLEVEL

#define MIN_CLEVEL   (int)(-5)

Definition at line 24 of file roundTripTest.c.

MSG

#define MSG

(

...

)

fprintf(stderr, __VA_ARGS__)

Definition at line 50 of file roundTripTest.c.

Typedef Documentation

compressFn

typedef int(* compressFn) (const char *src, char *dst, int srcSize, int dstSize, int cLevel)

Definition at line 90 of file roundTripTest.c.

Function Documentation

bad_usage()

int bad_usage

(

const char *

exeName

)

Definition at line 216 of file roundTripTest.c.

{
    MSG(" \n");
    MSG("bad usage: \n");
    MSG(" \n");
    MSG("%s [Options] fileName \n", exeName);
    MSG(" \n");
    MSG("Options: \n");
    MSG("-#     : use #=[0-9] compression level (default:0 == random) \n");
    return 1;
}

References MSG.

Referenced by main().

checkBuffers()

static size_t checkBuffers ( const void *  buff1, const void *  buff2, size_t  buffSize  )

static

Definition at line 61 of file roundTripTest.c.

{
    const char* const ip1 = (const char*)buff1;
    const char* const ip2 = (const char*)buff2;
    size_t pos;
 
    for (pos=0; pos<buffSize; pos++)
        if (ip1[pos]!=ip2[pos])
            break;
 
    return pos;
}

References pos.

Referenced by roundTripTest().

fileCheck()

static void fileCheck ( const char *  fileName, int  clevel  )

static

Definition at line 202 of file roundTripTest.c.

{
    size_t const fileSize = getFileSize(fileName);
    void* const buffer = malloc(fileSize + !fileSize /* avoid 0 */);
    if (!buffer) {
        MSG("not enough memory \n");
        exit(4);
    }
    loadFile(buffer, fileName, fileSize);
    roundTripCheck(buffer, fileSize, clevel);
    free (buffer);
}

References test-lz4-list::exit, test-lz4-speed::fileName, free(), getFileSize(), loadFile(), malloc(), MSG, and roundTripCheck().

Referenced by main().

getFileSize()

static size_t getFileSize ( const char *  infilename )

static

Definition at line 148 of file roundTripTest.c.

{
    int r;
#if defined(_MSC_VER)
    struct _stat64 statbuf;
    r = _stat64(infilename, &statbuf);
    if (r || !(statbuf.st_mode & S_IFREG)) return 0;   /* No good... */
#else
    struct stat statbuf;
    r = stat(infilename, &statbuf);
    if (r || !S_ISREG(statbuf.st_mode)) return 0;   /* No good... */
#endif
    return (size_t)statbuf.st_size;
}

References r, S_ISREG, and stat.

Referenced by fileCheck().

isDirectory()

static int isDirectory ( const char *  infilename )

static

Definition at line 164 of file roundTripTest.c.

{
    int r;
#if defined(_MSC_VER)
    struct _stat64 statbuf;
    r = _stat64(infilename, &statbuf);
    if (!r && (statbuf.st_mode & _S_IFDIR)) return 1;
#else
    struct stat statbuf;
    r = stat(infilename, &statbuf);
    if (!r && S_ISDIR(statbuf.st_mode)) return 1;
#endif
    return 0;
}

References r, S_ISDIR, and stat.

Referenced by loadFile().

loadFile()

static void loadFile ( void *  buffer, const char *  fileName, size_t  fileSize  )

static

loadFile() : requirement : buffer size >= fileSize

Definition at line 182 of file roundTripTest.c.

{
    FILE* const f = fopen(fileName, "rb");
    if (isDirectory(fileName)) {
        MSG("Ignoring %s directory \n", fileName);
        exit(2);
    }
    if (f==NULL) {
        MSG("Impossible to open %s \n", fileName);
        exit(3);
    }
    {   size_t const readSize = fread(buffer, 1, fileSize, f);
        if (readSize != fileSize) {
            MSG("Error reading %s \n", fileName);
            exit(5);
    }   }
    fclose(f);
}

References test-lz4-list::exit, f, benchmark::FILE, test-lz4-speed::fileName, isDirectory(), MSG, and NULL.

Referenced by fileCheck().

main()

int main	(	int	argCount,
		const char **	argv
	)

Definition at line 229 of file roundTripTest.c.

{
    const char* const exeName = argv[0];
    int argNb = 1;
    int clevel = 0;
 
    assert(argCount >= 1);
    if (argCount < 2) return bad_usage(exeName);
 
    if (argv[1][0] == '-') {
        clevel = argv[1][1] - '0';
        argNb = 2;
    }
 
    if (argNb >= argCount) return bad_usage(exeName);
 
    fileCheck(argv[argNb], clevel);
    MSG("no pb detected \n");
    return 0;
}

References argv, assert(), bad_usage(), fileCheck(), and MSG.

roundTripCheck()

static void roundTripCheck ( const void *  srcBuff, size_t  srcSize, int  clevel  )

static

Definition at line 127 of file roundTripTest.c.

{
    size_t const cBuffSize = LZ4_compressBound((int)srcSize);
    void* const cBuff = malloc(cBuffSize);
    void* const rBuff = malloc(cBuffSize);
 
    if (!cBuff || !rBuff) {
        fprintf(stderr, "not enough memory ! \n");
        exit(1);
    }
 
    roundTripTest(rBuff, cBuffSize,
                  cBuff, cBuffSize,
                  srcBuff, srcSize,
                  clevel);
 
    free(rBuff);
    free(cBuff);
}

References test-lz4-list::exit, free(), LZ4_compressBound(), malloc(), roundTripTest(), and srcSize.

Referenced by fileCheck().

roundTripTest()

static void roundTripTest ( void *  resultBuff, size_t  resultBuffCapacity, void *  compressedBuff, size_t  compressedBuffCapacity, const void *  srcBuff, size_t  srcSize, int  clevel  )

static

roundTripTest() : Compresses srcBuff into compressedBuff, then decompresses compressedBuff into resultBuff. If clevel==0, compression level is derived from srcBuff's content head bytes. This function abort() if it detects any round-trip error. Therefore, if it returns, round trip is considered successfully validated. Note : compressedBuffCapacity should be >= LZ4_compressBound(srcSize) for compression to be guaranteed to work

Definition at line 101 of file roundTripTest.c.

{
    int const proposed_clevel = clevel ? clevel : select_clevel(srcBuff, srcSize);
    int const selected_clevel = proposed_clevel < 0 ? -proposed_clevel : proposed_clevel;   /* if level < 0, it becomes an accelearion value */
    compressFn compress = selected_clevel >= LZ4HC_CLEVEL_MIN ? LZ4_compress_HC : LZ4_compress_fast;
    int const cSize = compress((const char*)srcBuff, (char*)compressedBuff, (int)srcSize, (int)compressedBuffCapacity, selected_clevel);
    CONTROL_MSG(cSize == 0, "Compression error !");
 
    {   int const dSize = LZ4_decompress_safe((const char*)compressedBuff, (char*)resultBuff, cSize, (int)resultBuffCapacity);
        CONTROL_MSG(dSize < 0, "Decompression detected an error !");
        CONTROL_MSG(dSize != (int)srcSize, "Decompression corruption error : wrong decompressed size !");
    }
 
    /* check potential content corruption error */
    assert(resultBuffCapacity >= srcSize);
    {   size_t const errorPos = checkBuffers(srcBuff, resultBuff, srcSize);
        CONTROL_MSG(errorPos != srcSize,
                    "Silent decoding corruption, at pos %u !!!",
                    (unsigned)errorPos);
    }
 
}

References assert(), checkBuffers(), compress(), CONTROL_MSG, LZ4_compress_fast(), LZ4_compress_HC(), LZ4_decompress_safe(), LZ4HC_CLEVEL_MIN, select_clevel(), and srcSize.

Referenced by roundTripCheck().

select_clevel()

static int select_clevel ( const void *  refBuff, size_t  refBuffSize  )

static

Definition at line 77 of file roundTripTest.c.

{
    const int minCLevel = MIN_CLEVEL;
    const int maxClevel = LZ4HC_CLEVEL_MAX;
    const int cLevelSpan = maxClevel - minCLevel;
    size_t const hashLength = MIN(16, refBuffSize);
    unsigned const h32 = XXH32(refBuff, hashLength, 0);
    int const randL = h32 % (cLevelSpan+1);
 
    return minCLevel + randL;
}

References LZ4HC_CLEVEL_MAX, MIN, MIN_CLEVEL, and XXH32().

Referenced by roundTripTest().