zstdcli.c File Reference

#include "platform.h"
#include "util.h"
#include <stdlib.h>
#include <string.h>
#include <stdio.h>
#include <errno.h>
#include <assert.h>
#include "fileio.h"
#include "benchzstd.h"
#include "dibio.h"
#include "zstdcli_trace.h"
#include "../lib/zstd.h"

Macros
#define	ZSTDCLI_CLEVEL_DEFAULT   3
#define	ZSTDCLI_CLEVEL_MAX   19 /* without using --ultra */
#define	ZSTDCLI_NBTHREADS_DEFAULT   1
#define	COMPRESSOR_NAME   "zstd command line interface"
#define	ZSTD_VERSION   "v" ZSTD_VERSION_STRING
#define	AUTHOR   "Yann Collet"
#define	WELCOME_MESSAGE   "*** %s %i-bits %s, by %s ***\n", COMPRESSOR_NAME, (int)(sizeof(size_t)*8), ZSTD_VERSION, AUTHOR
#define	ZSTD_ZSTDMT   "zstdmt"
#define	ZSTD_UNZSTD   "unzstd"
#define	ZSTD_CAT   "zstdcat"
#define	ZSTD_ZCAT   "zcat"
#define	ZSTD_GZ   "gzip"
#define	ZSTD_GUNZIP   "gunzip"
#define	ZSTD_GZCAT   "gzcat"
#define	ZSTD_LZMA   "lzma"
#define	ZSTD_UNLZMA   "unlzma"
#define	ZSTD_XZ   "xz"
#define	ZSTD_UNXZ   "unxz"
#define	ZSTD_LZ4   "lz4"
#define	ZSTD_UNLZ4   "unlz4"
#define	KB   *(1 <<10)
#define	MB   *(1 <<20)
#define	GB   *(1U<<30)
#define	DISPLAY_LEVEL_DEFAULT   2
#define	OVERLAP_LOG_DEFAULT   9999
#define	LDM_PARAM_DEFAULT   9999 /* Default for parameters where 0 is valid */
#define	DEFAULT_ACCEL   1
#define	DISPLAY_F(f, ...)
#define	DISPLAYOUT(...)
#define	DISPLAY(...)
#define	DISPLAYLEVEL(l, ...)
#define	ZSTD_NB_STRATEGIES   9
#define	ENV_CLEVEL   "ZSTD_CLEVEL"
#define	ENV_NBTHREADS   "ZSTD_NBTHREADS" /* takes lower precedence than directly specifying -T# in the CLI */
#define	NEXT_FIELD(ptr)
#define	NEXT_UINT32(val32)
#define	CLEAN_RETURN(i)
#define	MINCLEVEL   ZSTD_minCLevel()
#define	MAXCLEVEL   ZSTD_maxCLevel()

Enumerations
enum	dictType { cover , fastCover , legacy }
enum	zstd_operation_mode {   zom_compress , zom_decompress , zom_test , zom_bench ,   zom_train , zom_list }

Functions
int	main_8 (int argCount, const char *argv[])

Macro Definition Documentation

AUTHOR

#define AUTHOR   "Yann Collet"

CLEAN_RETURN

#define CLEAN_RETURN

(

i

)

Value:

{ operationResult = (i); goto _end; }

COMPRESSOR_NAME

#define COMPRESSOR_NAME   "zstd command line interface"

DEFAULT_ACCEL

#define DEFAULT_ACCEL   1

DISPLAY

#define DISPLAY

(

...

)

Value:

DISPLAY_F(stderr, __VA_ARGS__)

DISPLAY_F

#define DISPLAY_F	(		f,
			... )

Value:

fprintf((f), __VA_ARGS__)

DISPLAY_LEVEL_DEFAULT

#define DISPLAY_LEVEL_DEFAULT   2

DISPLAYLEVEL

#define DISPLAYLEVEL	(		l,
			... )

Value:

{ if (g_displayLevel>=l) { DISPLAY(__VA_ARGS__); } }

DISPLAYOUT

#define DISPLAYOUT

(

...

)

Value:

DISPLAY_F(stdout, __VA_ARGS__)

ENV_CLEVEL

#define ENV_CLEVEL   "ZSTD_CLEVEL"

ENV_NBTHREADS

#define ENV_NBTHREADS   "ZSTD_NBTHREADS" /* takes lower precedence than directly specifying -T# in the CLI */

GB

#define GB   *(1U<<30)

KB

#define KB   *(1 <<10)

LDM_PARAM_DEFAULT

#define LDM_PARAM_DEFAULT   9999 /* Default for parameters where 0 is valid */

MAXCLEVEL

#define MAXCLEVEL   ZSTD_maxCLevel()

MB

#define MB   *(1 <<20)

MINCLEVEL

#define MINCLEVEL   ZSTD_minCLevel()

NEXT_FIELD

#define NEXT_FIELD

(

ptr

)

Value:

    {         \
    if (*argument == '=') {       \
        ptr = ++argument;         \
        argument += strlen(ptr);  \
    } else {                      \
        argNb++;                  \
        if (argNb >= argCount) {  \
            DISPLAY("error: missing command argument \n"); \
            CLEAN_RETURN(1);      \
        }                         \
        ptr = argv[argNb];        \
        assert(ptr != NULL);      \
        if (ptr[0]=='-') {        \
            DISPLAY("error: command cannot be separated from its argument by another command \n"); \
            CLEAN_RETURN(1);      \
}   }   }

NEXT_UINT32

#define NEXT_UINT32

(

val32

)

Value:

    {      \
    const char* __nb;             \
    NEXT_FIELD(__nb);             \
    val32 = readU32FromChar(&__nb); \
}

OVERLAP_LOG_DEFAULT

#define OVERLAP_LOG_DEFAULT   9999

WELCOME_MESSAGE

#define WELCOME_MESSAGE   "*** %s %i-bits %s, by %s ***\n", COMPRESSOR_NAME, (int)(sizeof(size_t)*8), ZSTD_VERSION, AUTHOR

ZSTD_CAT

#define ZSTD_CAT   "zstdcat"

ZSTD_GUNZIP

#define ZSTD_GUNZIP   "gunzip"

ZSTD_GZ

#define ZSTD_GZ   "gzip"

ZSTD_GZCAT

#define ZSTD_GZCAT   "gzcat"

ZSTD_LZ4

#define ZSTD_LZ4   "lz4"

ZSTD_LZMA

#define ZSTD_LZMA   "lzma"

ZSTD_NB_STRATEGIES

#define ZSTD_NB_STRATEGIES   9

ZSTD_UNLZ4

#define ZSTD_UNLZ4   "unlz4"

ZSTD_UNLZMA

#define ZSTD_UNLZMA   "unlzma"

ZSTD_UNXZ

#define ZSTD_UNXZ   "unxz"

ZSTD_UNZSTD

#define ZSTD_UNZSTD   "unzstd"

ZSTD_VERSION

#define ZSTD_VERSION   "v" ZSTD_VERSION_STRING

ZSTD_XZ

#define ZSTD_XZ   "xz"

ZSTD_ZCAT

#define ZSTD_ZCAT   "zcat"

ZSTD_ZSTDMT

#define ZSTD_ZSTDMT   "zstdmt"

ZSTDCLI_CLEVEL_DEFAULT

#define ZSTDCLI_CLEVEL_DEFAULT   3

ZSTDCLI_CLEVEL_MAX

#define ZSTDCLI_CLEVEL_MAX   19 /* without using --ultra */

ZSTDCLI_NBTHREADS_DEFAULT

#define ZSTDCLI_NBTHREADS_DEFAULT   1

Enumeration Type Documentation

dictType

enum dictType

Enumerator
cover
fastCover
legacy

zstd_operation_mode

enum zstd_operation_mode

Enumerator
zom_compress
zom_decompress
zom_test
zom_bench
zom_train
zom_list

Function Documentation

main_8()

int main_8	(	int	argCount,
		const char *	argv[] )