benchzstd.h File Reference

#include <stddef.h>
#include "../lib/zstd.h"

Go to the source code of this file.

Data Structures
struct	BMK_benchResult_t
struct	BMK_advancedParams_t

Macros
#define	BENCH_ZSTD_H_3242387
#define	ZSTD_STATIC_LINKING_ONLY   /* ZSTD_compressionParameters */
#define	MB_UNIT   1000000
#define	VARIANT_ERROR_RESULT(baseType, variantName)

Enumerations
enum	BMK_mode_t { BMK_both = 0 , BMK_decodeOnly = 1 , BMK_compressOnly = 2 }

Functions
	VARIANT_ERROR_RESULT (BMK_benchResult_t, BMK_benchOutcome_t)
int	BMK_isSuccessful_benchOutcome (BMK_benchOutcome_t outcome)
BMK_benchResult_t	BMK_extract_benchResult (BMK_benchOutcome_t outcome)
int	BMK_benchFiles (const char *const *fileNamesTable, unsigned nbFiles, const char *dictFileName, int cLevel, const ZSTD_compressionParameters *compressionParams, int displayLevel)
BMK_advancedParams_t	BMK_initAdvancedParams (void)
int	BMK_benchFilesAdvanced (const char *const *fileNamesTable, unsigned nbFiles, const char *dictFileName, int cLevel, const ZSTD_compressionParameters *compressionParams, int displayLevel, const BMK_advancedParams_t *adv)
int	BMK_syntheticTest (int cLevel, double compressibility, const ZSTD_compressionParameters *compressionParams, int displayLevel, const BMK_advancedParams_t *adv)
BMK_benchOutcome_t	BMK_benchMem (const void *srcBuffer, size_t srcSize, const size_t *fileSizes, unsigned nbFiles, int cLevel, const ZSTD_compressionParameters *comprParams, const void *dictBuffer, size_t dictBufferSize, int displayLevel, const char *displayName)
BMK_benchOutcome_t	BMK_benchMemAdvanced (const void *srcBuffer, size_t srcSize, void *dstBuffer, size_t dstCapacity, const size_t *fileSizes, unsigned nbFiles, int cLevel, const ZSTD_compressionParameters *comprParams, const void *dictBuffer, size_t dictBufferSize, int displayLevel, const char *displayName, const BMK_advancedParams_t *adv)

Macro Definition Documentation

BENCH_ZSTD_H_3242387

#define BENCH_ZSTD_H_3242387

MB_UNIT

#define MB_UNIT   1000000

VARIANT_ERROR_RESULT

#define VARIANT_ERROR_RESULT	(		baseType,
			variantName )

Value:

                                             \
typedef struct {                             \
    baseType internal_never_use_directly;    \
    int tag;                                 \
} variantName

ZSTD_STATIC_LINKING_ONLY

#define ZSTD_STATIC_LINKING_ONLY   /* ZSTD_compressionParameters */

Enumeration Type Documentation

BMK_mode_t

enum BMK_mode_t

Enumerator
BMK_both
BMK_decodeOnly
BMK_compressOnly

Function Documentation

BMK_benchFiles()

int BMK_benchFiles	(	const char *const *	fileNamesTable,
		unsigned	nbFiles,
		const char *	dictFileName,
		int	cLevel,
		const ZSTD_compressionParameters *	compressionParams,
		int	displayLevel )

BMK_benchFiles() – called by zstdcli

BMK_benchFilesAdvanced()

int BMK_benchFilesAdvanced	(	const char *const *	fileNamesTable,
		unsigned	nbFiles,
		const char *	dictFileName,
		int	cLevel,
		const ZSTD_compressionParameters *	compressionParams,
		int	displayLevel,
		const BMK_advancedParams_t *	adv )

BMK_benchFilesAdvanced(): Same as BMK_benchFiles(), with more controls, provided through advancedParams_t structure

BMK_benchMem()

BMK_benchOutcome_t BMK_benchMem	(	const void *	srcBuffer,
		size_t	srcSize,
		const size_t *	fileSizes,
		unsigned	nbFiles,
		int	cLevel,
		const ZSTD_compressionParameters *	comprParams,
		const void *	dictBuffer,
		size_t	dictBufferSize,
		int	displayLevel,
		const char *	displayName )

BMK_benchMem() – core benchmarking function, called in paramgrill applies ZSTD_compress_generic() and ZSTD_decompress_generic() on data in srcBuffer with specific compression parameters provided by other arguments using benchFunction (cLevel, comprParams + adv in advanced Mode)

BMK_benchMemAdvanced()

BMK_benchOutcome_t BMK_benchMemAdvanced	(	const void *	srcBuffer,
		size_t	srcSize,
		void *	dstBuffer,
		size_t	dstCapacity,
		const size_t *	fileSizes,
		unsigned	nbFiles,
		int	cLevel,
		const ZSTD_compressionParameters *	comprParams,
		const void *	dictBuffer,
		size_t	dictBufferSize,
		int	displayLevel,
		const char *	displayName,
		const BMK_advancedParams_t *	adv )

BMK_extract_benchResult()

BMK_benchResult_t BMK_extract_benchResult

(

BMK_benchOutcome_t

outcome

)

BMK_initAdvancedParams()

BMK_advancedParams_t BMK_initAdvancedParams

(

void

)

BMK_isSuccessful_benchOutcome()

int BMK_isSuccessful_benchOutcome

(

BMK_benchOutcome_t

outcome

)

BMK_syntheticTest()

int BMK_syntheticTest	(	int	cLevel,
		double	compressibility,
		const ZSTD_compressionParameters *	compressionParams,
		int	displayLevel,
		const BMK_advancedParams_t *	adv )

BMK_syntheticTest() – called from zstdcli

VARIANT_ERROR_RESULT()

VARIANT_ERROR_RESULT	(	BMK_benchResult_t	,
		BMK_benchOutcome_t	)