#include "platform.h" /* PLATFORM_POSIX_VERSION */

#include "util.h" /* UTIL_HAS_CREATEFILELIST, UTIL_createFileList, UTIL_isConsole */

#include <stdlib.h> /* getenv */

#include <string.h> /* strcmp, strlen */

#include <stdio.h> /* fprintf(), stdin, stdout, stderr */

#include <assert.h> /* assert */

#include "fileio.h" /* stdinmark, stdoutmark, ZSTD_EXTENSION */

#ifndef ZSTD_NOBENCH

# include "benchzstd.h" /* BMK_benchFilesAdvanced */

#ifndef ZSTD_NODICT

# include "dibio.h" /* ZDICT_cover_params_t, DiB_trainFromFiles() */

#ifndef ZSTD_NOTRACE

# include "zstdcli_trace.h"

#include "../lib/zstd.h" /* ZSTD_VERSION_STRING, ZSTD_minCLevel, ZSTD_maxCLevel */

#include "fileio_asyncio.h"

#include "fileio_common.h"

#ifndef ZSTDCLI_CLEVEL_DEFAULT

# define ZSTDCLI_CLEVEL_DEFAULT 3

#ifndef ZSTDCLI_CLEVEL_MAX

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

#ifndef ZSTDCLI_NBTHREADS_DEFAULT

#define ZSTDCLI_NBTHREADS_DEFAULT MAX(1, MIN(4, UTIL_countLogicalCores() / 4))

#define COMPRESSOR_NAME "Zstandard CLI"

#ifndef ZSTD_VERSION

# define ZSTD_VERSION "v" ZSTD_VERSION_STRING

#define AUTHOR "Yann Collet"

#define WELCOME_MESSAGE "*** %s (%i-bit) %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

static const char* g_defaultDictName = "dictionary";

static const unsigned g_defaultMaxDictSize = 110 KB;

static const int g_defaultDictCLevel = 3;

static const unsigned g_defaultSelectivityLevel = 9;

static const unsigned g_defaultMaxWindowLog = 27;

#define OVERLAP_LOG_DEFAULT 9999

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

static U32 g_overlapLog = OVERLAP_LOG_DEFAULT;

static U32 g_ldmHashLog = 0;

static U32 g_ldmMinMatch = 0;

static U32 g_ldmHashRateLog = LDM_PARAM_DEFAULT;

static U32 g_ldmBucketSizeLog = LDM_PARAM_DEFAULT;

#define DEFAULT_ACCEL 1

typedef enum { cover, fastCover, legacy } dictType;

#undef DISPLAYLEVEL

#define DISPLAYLEVEL(l, ...) { if (g_displayLevel>=l) { DISPLAY(__VA_ARGS__); } }

static int g_displayLevel = DISPLAY_LEVEL_DEFAULT; /* 0 : no display, 1: errors, 2 : + result + interaction + warnings, 3 : + progression, 4 : + information */

static void checkLibVersion(void)

{

if (strcmp(ZSTD_VERSION_STRING, ZSTD_versionString())) {

DISPLAYLEVEL(1, "Error : incorrect library version (expecting : %s ; actual : %s ) \n",

ZSTD_VERSION_STRING, ZSTD_versionString());

DISPLAYLEVEL(1, "Please update library to version %s, or use stand-alone zstd binary \n",

ZSTD_VERSION_STRING);

exit(1);

}

}

static int exeNameMatch(const char* exeName, const char* test)

{

return !strncmp(exeName, test, strlen(test)) &&

(exeName[strlen(test)] == '\0' || exeName[strlen(test)] == '.');

}

static void usage(FILE* f, const char* programName)

{

DISPLAY_F(f, "Compress or decompress the INPUT file(s); reads from STDIN if INPUT is `-` or not provided.\n\n");

DISPLAY_F(f, "Usage: %s [OPTIONS...] [INPUT... | -] [-o OUTPUT]\n\n", programName);

DISPLAY_F(f, "Options:\n");

DISPLAY_F(f, " -o OUTPUT Write output to a single file, OUTPUT.\n");

DISPLAY_F(f, " -k, --keep Preserve INPUT file(s). [Default] \n");

DISPLAY_F(f, " --rm Remove INPUT file(s) after successful (de)compression.\n");

#ifdef ZSTD_GZCOMPRESS

if (exeNameMatch(programName, ZSTD_GZ)) { /* behave like gzip */

DISPLAY_F(f, " -n, --no-name Do not store original filename when compressing.\n\n");

}

DISPLAY_F(f, "\n");

#ifndef ZSTD_NOCOMPRESS

DISPLAY_F(f, " -# Desired compression level, where `#` is a number between 1 and %d;\n", ZSTDCLI_CLEVEL_MAX);

DISPLAY_F(f, " lower numbers provide faster compression, higher numbers yield\n");

DISPLAY_F(f, " better compression ratios. [Default: %d]\n\n", ZSTDCLI_CLEVEL_DEFAULT);

#ifndef ZSTD_NODECOMPRESS

DISPLAY_F(f, " -d, --decompress Perform decompression.\n");

DISPLAY_F(f, " -D DICT Use DICT as the dictionary for compression or decompression.\n\n");

DISPLAY_F(f, " -f, --force Disable input and output checks. Allows overwriting existing files,\n");

DISPLAY_F(f, " receiving input from the console, printing output to STDOUT, and\n");

DISPLAY_F(f, " operating on links, block devices, etc. Unrecognized formats will be\n");

DISPLAY_F(f, " passed-through through as-is.\n\n");

DISPLAY_F(f, " -h Display short usage and exit.\n");

DISPLAY_F(f, " -H, --help Display full help and exit.\n");

DISPLAY_F(f, " -V, --version Display the program version and exit.\n");

DISPLAY_F(f, "\n");

}

static void usageAdvanced(const char* programName)

{

DISPLAYOUT(WELCOME_MESSAGE);

DISPLAYOUT("\n");

usage(stdout, programName);

DISPLAYOUT("Advanced options:\n");

DISPLAYOUT(" -c, --stdout Write to STDOUT (even if it is a console) and keep the INPUT file(s).\n\n");

DISPLAYOUT(" -v, --verbose Enable verbose output; pass multiple times to increase verbosity.\n");

DISPLAYOUT(" -q, --quiet Suppress warnings; pass twice to suppress errors.\n");

#ifndef ZSTD_NOTRACE

DISPLAYOUT(" --trace LOG Log tracing information to LOG.\n");

DISPLAYOUT("\n");

DISPLAYOUT(" --[no-]progress Forcibly show/hide the progress counter. NOTE: Any (de)compressed\n");

DISPLAYOUT(" output to terminal will mix with progress counter text.\n\n");

#ifdef UTIL_HAS_CREATEFILELIST

DISPLAYOUT(" -r Operate recursively on directories.\n");

DISPLAYOUT(" --filelist LIST Read a list of files to operate on from LIST.\n");

DISPLAYOUT(" --output-dir-flat DIR Store processed files in DIR.\n");

#ifdef UTIL_HAS_MIRRORFILELIST

DISPLAYOUT(" --output-dir-mirror DIR Store processed files in DIR, respecting original directory structure.\n");

if (AIO_supported())

DISPLAYOUT(" --[no-]asyncio Use asynchronous IO. [Default: Enabled]\n");

DISPLAYOUT("\n");

#ifndef ZSTD_NOCOMPRESS

DISPLAYOUT(" --[no-]check Add XXH64 integrity checksums during compression. [Default: Add, Validate]\n");

#ifndef ZSTD_NODECOMPRESS

DISPLAYOUT(" If `-d` is present, ignore/validate checksums during decompression.\n");

#ifdef ZSTD_NOCOMPRESS

DISPLAYOUT(" --[no-]check Ignore/validate checksums during decompression. [Default: Validate]");

#endif /* ZSTD_NOCOMPRESS */

DISPLAYOUT("\n");

DISPLAYOUT(" -- Treat remaining arguments after `--` as files.\n");

#ifndef ZSTD_NOCOMPRESS

DISPLAYOUT("\n");

DISPLAYOUT("Advanced compression options:\n");

DISPLAYOUT(" --ultra Enable levels beyond %i, up to %i; requires more memory.\n", ZSTDCLI_CLEVEL_MAX, ZSTD_maxCLevel());

DISPLAYOUT(" --fast[=#] Use to very fast compression levels. [Default: %u]\n", 1);

#ifdef ZSTD_GZCOMPRESS

if (exeNameMatch(programName, ZSTD_GZ)) { /* behave like gzip */

DISPLAYOUT(" --best Compatibility alias for `-9`.\n");

}

DISPLAYOUT(" --adapt Dynamically adapt compression level to I/O conditions.\n");

DISPLAYOUT(" --long[=#] Enable long distance matching with window log #. [Default: %u]\n", g_defaultMaxWindowLog);

DISPLAYOUT(" --patch-from=REF Use REF as the reference point for Zstandard's diff engine. \n\n");

# ifdef ZSTD_MULTITHREAD

DISPLAYOUT(" -T# Spawn # compression threads. [Default: 1; pass 0 for core count.]\n");

DISPLAYOUT(" --single-thread Share a single thread for I/O and compression (slightly different than `-T1`).\n");

DISPLAYOUT(" --auto-threads={physical|logical}\n");

DISPLAYOUT(" Use physical/logical cores when using `-T0`. [Default: Physical]\n\n");

DISPLAYOUT(" -B# Set job size to #. [Default: 0 (automatic)]\n");

DISPLAYOUT(" --rsyncable Compress using a rsync-friendly method (`-B` sets block size). \n");

DISPLAYOUT("\n");

DISPLAYOUT(" --exclude-compressed Only compress files that are not already compressed.\n\n");

DISPLAYOUT(" --stream-size=# Specify size of streaming input from STDIN.\n");

DISPLAYOUT(" --size-hint=# Optimize compression parameters for streaming input of approximately size #.\n");

DISPLAYOUT(" --target-compressed-block-size=#\n");

DISPLAYOUT(" Generate compressed blocks of approximately # size.\n\n");

DISPLAYOUT(" --no-dictID Don't write `dictID` into the header (dictionary compression only).\n");

DISPLAYOUT(" --[no-]compress-literals Force (un)compressed literals.\n");

DISPLAYOUT(" --[no-]row-match-finder Explicitly enable/disable the fast, row-based matchfinder for\n");

DISPLAYOUT(" the 'greedy', 'lazy', and 'lazy2' strategies.\n");

DISPLAYOUT("\n");

DISPLAYOUT(" --format=zstd Compress files to the `.zst` format. [Default]\n");

DISPLAYOUT(" --[no-]mmap-dict Memory-map dictionary file rather than mallocing and loading all at once\n");

#ifdef ZSTD_GZCOMPRESS

DISPLAYOUT(" --format=gzip Compress files to the `.gz` format.\n");

#ifdef ZSTD_LZMACOMPRESS

DISPLAYOUT(" --format=xz Compress files to the `.xz` format.\n");

DISPLAYOUT(" --format=lzma Compress files to the `.lzma` format.\n");

#ifdef ZSTD_LZ4COMPRESS

DISPLAYOUT( " --format=lz4 Compress files to the `.lz4` format.\n");

#endif /* !ZSTD_NOCOMPRESS */

#ifndef ZSTD_NODECOMPRESS

DISPLAYOUT("\n");

DISPLAYOUT("Advanced decompression options:\n");

DISPLAYOUT(" -l Print information about Zstandard-compressed files.\n");

DISPLAYOUT(" --test Test compressed file integrity.\n");

DISPLAYOUT(" -M# Set the memory usage limit to # megabytes.\n");

# if ZSTD_SPARSE_DEFAULT

DISPLAYOUT(" --[no-]sparse Enable sparse mode. [Default: Enabled for files, disabled for STDOUT.]\n");

DISPLAYOUT(" --[no-]sparse Enable sparse mode. [Default: Disabled]\n");

{

char const* passThroughDefault = "Disabled";

if (exeNameMatch(programName, ZSTD_CAT) ||

exeNameMatch(programName, ZSTD_ZCAT) ||

exeNameMatch(programName, ZSTD_GZCAT)) {

passThroughDefault = "Enabled";

}

DISPLAYOUT(" --[no-]pass-through Pass through uncompressed files as-is. [Default: %s]\n", passThroughDefault);

}

#endif /* ZSTD_NODECOMPRESS */

#ifndef ZSTD_NODICT

DISPLAYOUT("\n");

DISPLAYOUT("Dictionary builder:\n");

DISPLAYOUT(" --train Create a dictionary from a training set of files.\n\n");

DISPLAYOUT(" --train-cover[=k=#,d=#,steps=#,split=#,shrink[=#]]\n");

DISPLAYOUT(" Use the cover algorithm (with optional arguments).\n");

DISPLAYOUT(" --train-fastcover[=k=#,d=#,f=#,steps=#,split=#,accel=#,shrink[=#]]\n");

DISPLAYOUT(" Use the fast cover algorithm (with optional arguments).\n\n");

DISPLAYOUT(" --train-legacy[=s=#] Use the legacy algorithm with selectivity #. [Default: %u]\n", g_defaultSelectivityLevel);

DISPLAYOUT(" -o NAME Use NAME as dictionary name. [Default: %s]\n", g_defaultDictName);

DISPLAYOUT(" --maxdict=# Limit dictionary to specified size #. [Default: %u]\n", g_defaultMaxDictSize);

DISPLAYOUT(" --dictID=# Force dictionary ID to #. [Default: Random]\n");

#ifndef ZSTD_NOBENCH

DISPLAYOUT("\n");

DISPLAYOUT("Benchmark options:\n");

DISPLAYOUT(" -b# Perform benchmarking with compression level #. [Default: %d]\n", ZSTDCLI_CLEVEL_DEFAULT);

DISPLAYOUT(" -e# Test all compression levels up to #; starting level is `-b#`. [Default: 1]\n");

DISPLAYOUT(" -i# Set the minimum evaluation to time # seconds. [Default: 3]\n");

DISPLAYOUT(" -B# Cut file into independent chunks of size #. [Default: No chunking]\n");

DISPLAYOUT(" -S Output one benchmark result per input file. [Default: Consolidated result]\n");

DISPLAYOUT(" -D dictionary Benchmark using dictionary \n");

DISPLAYOUT(" --priority=rt Set process priority to real-time.\n");

}

static void badUsage(const char* programName, const char* parameter)

{

DISPLAYLEVEL(1, "Incorrect parameter: %s \n", parameter);

if (g_displayLevel >= 2) usage(stderr, programName);

}

static void waitEnter(void)

{

int unused;

DISPLAY("Press enter to continue... \n");

unused = getchar();

(void)unused;

}

static const char* lastNameFromPath(const char* path)

{

const char* name = path;

if (strrchr(name, '/')) name = strrchr(name, '/') + 1;

if (strrchr(name, '\\')) name = strrchr(name, '\\') + 1; /* windows */

return name;

}

static void errorOut(const char* msg)

{

DISPLAYLEVEL(1, "%s \n", msg); exit(1);

}

static int readU32FromCharChecked(const char** stringPtr, unsigned* value)

{

unsigned result = 0;

while ((**stringPtr >='0') && (**stringPtr <='9')) {

unsigned const max = ((unsigned)(-1)) / 10;

unsigned last = result;

if (result > max) return 1; /* overflow error */

result *= 10;

result += (unsigned)(**stringPtr - '0');

if (result < last) return 1; /* overflow error */

(*stringPtr)++ ;

}

if ((**stringPtr=='K') || (**stringPtr=='M')) {

unsigned const maxK = ((unsigned)(-1)) >> 10;

if (result > maxK) return 1; /* overflow error */

result <<= 10;

if (**stringPtr=='M') {

if (result > maxK) return 1; /* overflow error */

result <<= 10;

}

(*stringPtr)++; /* skip `K` or `M` */

if (**stringPtr=='i') (*stringPtr)++;

if (**stringPtr=='B') (*stringPtr)++;

}

*value = result;

return 0;

}

static unsigned readU32FromChar(const char** stringPtr) {

static const char errorMsg[] = "error: numeric value overflows 32-bit unsigned int";

unsigned result;

if (readU32FromCharChecked(stringPtr, &result)) { errorOut(errorMsg); }

return result;

}

static int readIntFromChar(const char** stringPtr) {

static const char errorMsg[] = "error: numeric value overflows 32-bit int";

int sign = 1;

unsigned result;

if (**stringPtr=='-') {

(*stringPtr)++;

sign = -1;

}

if (readU32FromCharChecked(stringPtr, &result)) { errorOut(errorMsg); }

return (int) result * sign;

}

static int readSizeTFromCharChecked(const char** stringPtr, size_t* value)

{

size_t result = 0;

while ((**stringPtr >='0') && (**stringPtr <='9')) {

size_t const max = ((size_t)(-1)) / 10;

size_t last = result;

if (result > max) return 1; /* overflow error */

result *= 10;

result += (size_t)(**stringPtr - '0');

if (result < last) return 1; /* overflow error */

(*stringPtr)++ ;

}

if ((**stringPtr=='K') || (**stringPtr=='M')) {

size_t const maxK = ((size_t)(-1)) >> 10;

if (result > maxK) return 1; /* overflow error */

result <<= 10;

if (**stringPtr=='M') {

if (result > maxK) return 1; /* overflow error */

result <<= 10;

}

(*stringPtr)++; /* skip `K` or `M` */

if (**stringPtr=='i') (*stringPtr)++;

if (**stringPtr=='B') (*stringPtr)++;

}

*value = result;

return 0;

}

static size_t readSizeTFromChar(const char** stringPtr) {

static const char errorMsg[] = "error: numeric value overflows size_t";

size_t result;

if (readSizeTFromCharChecked(stringPtr, &result)) { errorOut(errorMsg); }

return result;

}

static int longCommandWArg(const char** stringPtr, const char* longCommand)

{

size_t const comSize = strlen(longCommand);

int const result = !strncmp(*stringPtr, longCommand, comSize);

if (result) *stringPtr += comSize;

return result;

}

#ifndef ZSTD_NODICT

static const unsigned kDefaultRegression = 1;

static unsigned parseCoverParameters(const char* stringPtr, ZDICT_cover_params_t* params)

{

memset(params, 0, sizeof(*params));

for (; ;) {

if (longCommandWArg(&stringPtr, "k=")) { params->k = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "d=")) { params->d = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "steps=")) { params->steps = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "split=")) {

unsigned splitPercentage = readU32FromChar(&stringPtr);

params->splitPoint = (double)splitPercentage / 100.0;

if (stringPtr[0]==',') { stringPtr++; continue; } else break;

}

if (longCommandWArg(&stringPtr, "shrink")) {

params->shrinkDictMaxRegression = kDefaultRegression;

params->shrinkDict = 1;

if (stringPtr[0]=='=') {

stringPtr++;

params->shrinkDictMaxRegression = readU32FromChar(&stringPtr);

}

if (stringPtr[0]==',') {

stringPtr++;

continue;

}

else break;

}

return 0;

}

if (stringPtr[0] != 0) return 0;

DISPLAYLEVEL(4, "cover: k=%u\nd=%u\nsteps=%u\nsplit=%u\nshrink%u\n", params->k, params->d, params->steps, (unsigned)(params->splitPoint * 100), params->shrinkDictMaxRegression);

return 1;

}

static unsigned parseFastCoverParameters(const char* stringPtr, ZDICT_fastCover_params_t* params)

{

memset(params, 0, sizeof(*params));

for (; ;) {

if (longCommandWArg(&stringPtr, "k=")) { params->k = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "d=")) { params->d = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "f=")) { params->f = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "steps=")) { params->steps = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "accel=")) { params->accel = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "split=")) {

unsigned splitPercentage = readU32FromChar(&stringPtr);

params->splitPoint = (double)splitPercentage / 100.0;

if (stringPtr[0]==',') { stringPtr++; continue; } else break;

}

if (longCommandWArg(&stringPtr, "shrink")) {

params->shrinkDictMaxRegression = kDefaultRegression;

params->shrinkDict = 1;

if (stringPtr[0]=='=') {

stringPtr++;

params->shrinkDictMaxRegression = readU32FromChar(&stringPtr);

}

if (stringPtr[0]==',') {

stringPtr++;

continue;

}

else break;

}

return 0;

}

if (stringPtr[0] != 0) return 0;

DISPLAYLEVEL(4, "cover: k=%u\nd=%u\nf=%u\nsteps=%u\nsplit=%u\naccel=%u\nshrink=%u\n", params->k, params->d, params->f, params->steps, (unsigned)(params->splitPoint * 100), params->accel, params->shrinkDictMaxRegression);

return 1;

}

static unsigned parseLegacyParameters(const char* stringPtr, unsigned* selectivity)

{

if (!longCommandWArg(&stringPtr, "s=") && !longCommandWArg(&stringPtr, "selectivity=")) { return 0; }

*selectivity = readU32FromChar(&stringPtr);

if (stringPtr[0] != 0) return 0;

DISPLAYLEVEL(4, "legacy: selectivity=%u\n", *selectivity);

return 1;

}

static ZDICT_cover_params_t defaultCoverParams(void)

{

ZDICT_cover_params_t params;

memset(&params, 0, sizeof(params));

params.d = 8;

params.steps = 4;

params.splitPoint = 1.0;

params.shrinkDict = 0;

params.shrinkDictMaxRegression = kDefaultRegression;

return params;

}

static ZDICT_fastCover_params_t defaultFastCoverParams(void)

{

ZDICT_fastCover_params_t params;

memset(&params, 0, sizeof(params));

params.d = 8;

params.f = 20;

params.steps = 4;

params.splitPoint = 0.75; /* different from default splitPoint of cover */

params.accel = DEFAULT_ACCEL;

params.shrinkDict = 0;

params.shrinkDictMaxRegression = kDefaultRegression;

return params;

}

static unsigned parseAdaptParameters(const char* stringPtr, int* adaptMinPtr, int* adaptMaxPtr)

{

for ( ; ;) {

if (longCommandWArg(&stringPtr, "min=")) { *adaptMinPtr = readIntFromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "max=")) { *adaptMaxPtr = readIntFromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

DISPLAYLEVEL(4, "invalid compression parameter \n");

return 0;

}

if (stringPtr[0] != 0) return 0; /* check the end of string */

if (*adaptMinPtr > *adaptMaxPtr) {

DISPLAYLEVEL(4, "incoherent adaptation limits \n");

return 0;

}

return 1;

}

static unsigned parseCompressionParameters(const char* stringPtr, ZSTD_compressionParameters* params)

{

for ( ; ;) {

if (longCommandWArg(&stringPtr, "windowLog=") || longCommandWArg(&stringPtr, "wlog=")) { params->windowLog = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "chainLog=") || longCommandWArg(&stringPtr, "clog=")) { params->chainLog = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "hashLog=") || longCommandWArg(&stringPtr, "hlog=")) { params->hashLog = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "searchLog=") || longCommandWArg(&stringPtr, "slog=")) { params->searchLog = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "minMatch=") || longCommandWArg(&stringPtr, "mml=")) { params->minMatch = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "targetLength=") || longCommandWArg(&stringPtr, "tlen=")) { params->targetLength = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "strategy=") || longCommandWArg(&stringPtr, "strat=")) { params->strategy = (ZSTD_strategy)(readU32FromChar(&stringPtr)); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "overlapLog=") || longCommandWArg(&stringPtr, "ovlog=")) { g_overlapLog = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "ldmHashLog=") || longCommandWArg(&stringPtr, "lhlog=")) { g_ldmHashLog = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "ldmMinMatch=") || longCommandWArg(&stringPtr, "lmml=")) { g_ldmMinMatch = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "ldmBucketSizeLog=") || longCommandWArg(&stringPtr, "lblog=")) { g_ldmBucketSizeLog = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

if (longCommandWArg(&stringPtr, "ldmHashRateLog=") || longCommandWArg(&stringPtr, "lhrlog=")) { g_ldmHashRateLog = readU32FromChar(&stringPtr); if (stringPtr[0]==',') { stringPtr++; continue; } else break; }

DISPLAYLEVEL(4, "invalid compression parameter \n");

return 0;

}

if (stringPtr[0] != 0) return 0; /* check the end of string */

return 1;

}

static void setMaxCompression(ZSTD_compressionParameters* params)

{

params->windowLog = ZSTD_WINDOWLOG_MAX;

params->chainLog = ZSTD_CHAINLOG_MAX;

params->hashLog = ZSTD_HASHLOG_MAX;

params->searchLog = ZSTD_SEARCHLOG_MAX;

params->minMatch = ZSTD_MINMATCH_MIN;

params->targetLength = ZSTD_TARGETLENGTH_MAX;

params->strategy = ZSTD_STRATEGY_MAX;

g_overlapLog = ZSTD_OVERLAPLOG_MAX;

g_ldmHashLog = ZSTD_LDM_HASHLOG_MAX;

g_ldmHashRateLog = 0; /* automatically derived */

g_ldmMinMatch = 16; /* heuristic */

g_ldmBucketSizeLog = ZSTD_LDM_BUCKETSIZELOG_MAX;

}

static void printVersion(void)

{

if (g_displayLevel < DISPLAY_LEVEL_DEFAULT) {

DISPLAYOUT("%s\n", ZSTD_VERSION_STRING);

return;

}

DISPLAYOUT(WELCOME_MESSAGE);

if (g_displayLevel >= 3) {

/* format support */

DISPLAYOUT("*** supports: zstd");

#if defined(ZSTD_LEGACY_SUPPORT) && (ZSTD_LEGACY_SUPPORT>0) && (ZSTD_LEGACY_SUPPORT<8)

DISPLAYOUT(", zstd legacy v0.%d+", ZSTD_LEGACY_SUPPORT);

#endif

#ifdef ZSTD_GZCOMPRESS

DISPLAYOUT(", gzip");

#endif

#ifdef ZSTD_LZ4COMPRESS

DISPLAYOUT(", lz4");

#endif

#ifdef ZSTD_LZMACOMPRESS

DISPLAYOUT(", lzma, xz ");

#endif

DISPLAYOUT("\n");

if (g_displayLevel >= 4) {

/* library versions */

DISPLAYOUT("zlib version %s\n", FIO_zlibVersion());

DISPLAYOUT("lz4 version %s\n", FIO_lz4Version());

DISPLAYOUT("lzma version %s\n", FIO_lzmaVersion());

/* posix support */

#ifdef _POSIX_C_SOURCE

DISPLAYOUT("_POSIX_C_SOURCE defined: %ldL\n", (long) _POSIX_C_SOURCE);

#endif

#ifdef _POSIX_VERSION

DISPLAYOUT("_POSIX_VERSION defined: %ldL \n", (long) _POSIX_VERSION);

#endif

#ifdef PLATFORM_POSIX_VERSION

DISPLAYOUT("PLATFORM_POSIX_VERSION defined: %ldL\n", (long) PLATFORM_POSIX_VERSION);

#endif

} }

}

#define ZSTD_NB_STRATEGIES 9

static const char* ZSTD_strategyMap[ZSTD_NB_STRATEGIES + 1] = { "", "ZSTD_fast",

"ZSTD_dfast", "ZSTD_greedy", "ZSTD_lazy", "ZSTD_lazy2", "ZSTD_btlazy2",

"ZSTD_btopt", "ZSTD_btultra", "ZSTD_btultra2"};

#ifndef ZSTD_NOCOMPRESS

static void printDefaultCParams(const char* filename, const char* dictFileName, int cLevel) {

unsigned long long fileSize = UTIL_getFileSize(filename);

const size_t dictSize = dictFileName != NULL ? (size_t)UTIL_getFileSize(dictFileName) : 0;

const ZSTD_compressionParameters cParams = ZSTD_getCParams(cLevel, fileSize, dictSize);

if (fileSize != UTIL_FILESIZE_UNKNOWN) DISPLAY("%s (%llu bytes)\n", filename, fileSize);

else DISPLAY("%s (src size unknown)\n", filename);

DISPLAY(" - windowLog : %u\n", cParams.windowLog);

DISPLAY(" - chainLog : %u\n", cParams.chainLog);

DISPLAY(" - hashLog : %u\n", cParams.hashLog);

DISPLAY(" - searchLog : %u\n", cParams.searchLog);

DISPLAY(" - minMatch : %u\n", cParams.minMatch);

DISPLAY(" - targetLength : %u\n", cParams.targetLength);

assert(cParams.strategy < ZSTD_NB_STRATEGIES + 1);

DISPLAY(" - strategy : %s (%u)\n", ZSTD_strategyMap[(int)cParams.strategy], (unsigned)cParams.strategy);

}

static void printActualCParams(const char* filename, const char* dictFileName, int cLevel, const ZSTD_compressionParameters* cParams) {

unsigned long long fileSize = UTIL_getFileSize(filename);

const size_t dictSize = dictFileName != NULL ? (size_t)UTIL_getFileSize(dictFileName) : 0;

ZSTD_compressionParameters actualCParams = ZSTD_getCParams(cLevel, fileSize, dictSize);

assert(g_displayLevel >= 4);

actualCParams.windowLog = cParams->windowLog == 0 ? actualCParams.windowLog : cParams->windowLog;

actualCParams.chainLog = cParams->chainLog == 0 ? actualCParams.chainLog : cParams->chainLog;

actualCParams.hashLog = cParams->hashLog == 0 ? actualCParams.hashLog : cParams->hashLog;

actualCParams.searchLog = cParams->searchLog == 0 ? actualCParams.searchLog : cParams->searchLog;

actualCParams.minMatch = cParams->minMatch == 0 ? actualCParams.minMatch : cParams->minMatch;

actualCParams.targetLength = cParams->targetLength == 0 ? actualCParams.targetLength : cParams->targetLength;

actualCParams.strategy = cParams->strategy == 0 ? actualCParams.strategy : cParams->strategy;

DISPLAY("--zstd=wlog=%d,clog=%d,hlog=%d,slog=%d,mml=%d,tlen=%d,strat=%d\n",

actualCParams.windowLog, actualCParams.chainLog, actualCParams.hashLog, actualCParams.searchLog,

actualCParams.minMatch, actualCParams.targetLength, actualCParams.strategy);

}

#define ENV_CLEVEL "ZSTD_CLEVEL"

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

static int init_cLevel(void) {

const char* const env = getenv(ENV_CLEVEL);

if (env != NULL) {

const char* ptr = env;

int sign = 1;

if (*ptr == '-') {

sign = -1;

ptr++;

} else if (*ptr == '+') {

ptr++;

}

if ((*ptr>='0') && (*ptr<='9')) {

unsigned absLevel;

if (readU32FromCharChecked(&ptr, &absLevel)) {

DISPLAYLEVEL(2, "Ignore environment variable setting %s=%s: numeric value too large \n", ENV_CLEVEL, env);

return ZSTDCLI_CLEVEL_DEFAULT;

} else if (*ptr == 0) {

return sign * (int)absLevel;

} }

DISPLAYLEVEL(2, "Ignore environment variable setting %s=%s: not a valid integer value \n", ENV_CLEVEL, env);

}

return ZSTDCLI_CLEVEL_DEFAULT;

}

#ifdef ZSTD_MULTITHREAD

static unsigned default_nbThreads(void) {

const char* const env = getenv(ENV_NBTHREADS);

if (env != NULL) {

const char* ptr = env;

if ((*ptr>='0') && (*ptr<='9')) {

unsigned nbThreads;

if (readU32FromCharChecked(&ptr, &nbThreads)) {

DISPLAYLEVEL(2, "Ignore environment variable setting %s=%s: numeric value too large \n", ENV_NBTHREADS, env);

return ZSTDCLI_NBTHREADS_DEFAULT;

} else if (*ptr == 0) {

return nbThreads;

}

}

DISPLAYLEVEL(2, "Ignore environment variable setting %s=%s: not a valid unsigned value \n", ENV_NBTHREADS, env);

}

return ZSTDCLI_NBTHREADS_DEFAULT;

}

#define NEXT_FIELD(ptr) { \

if (*argument == '=') { \

ptr = ++argument; \

argument += strlen(ptr); \

} else { \

argNb++; \

if (argNb >= argCount) { \

DISPLAYLEVEL(1, "error: missing command argument \n"); \

CLEAN_RETURN(1); \

} \

ptr = argv[argNb]; \

assert(ptr != NULL); \

if (ptr[0]=='-') { \

DISPLAYLEVEL(1, "error: command cannot be separated from its argument by another command \n"); \

CLEAN_RETURN(1); \

} } }

#define NEXT_UINT32(val32) { \

const char* __nb; \

NEXT_FIELD(__nb); \

val32 = readU32FromChar(&__nb); \

if(*__nb != 0) { \

errorOut("error: only numeric values with optional suffixes K, KB, KiB, M, MB, MiB are allowed"); \

} \

}

#define NEXT_TSIZE(valTsize) { \

const char* __nb; \

NEXT_FIELD(__nb); \

valTsize = readSizeTFromChar(&__nb); \

if(*__nb != 0) { \

errorOut("error: only numeric values with optional suffixes K, KB, KiB, M, MB, MiB are allowed"); \

} \

}

typedef enum { zom_compress, zom_decompress, zom_test, zom_bench, zom_train, zom_list } zstd_operation_mode;

#define CLEAN_RETURN(i) { operationResult = (i); goto _end; }

#ifdef ZSTD_NOCOMPRESS

# define MINCLEVEL -99

# define MAXCLEVEL 22

# define MINCLEVEL ZSTD_minCLevel()

# define MAXCLEVEL ZSTD_maxCLevel()

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

{

int argNb,

followLinks = 0,

allowBlockDevices = 0,

forceStdin = 0,

forceStdout = 0,

hasStdout = 0,

ldmFlag = 0,

main_pause = 0,

adapt = 0,

adaptMin = MINCLEVEL,

adaptMax = MAXCLEVEL,

rsyncable = 0,

nextArgumentsAreFiles = 0,

operationResult = 0,

separateFiles = 0,

setRealTimePrio = 0,

singleThread = 0,

defaultLogicalCores = 0,

showDefaultCParams = 0,

ultra=0,

contentSize=1,

removeSrcFile=0;

ZSTD_ParamSwitch_e mmapDict=ZSTD_ps_auto;

ZSTD_ParamSwitch_e useRowMatchFinder = ZSTD_ps_auto;

FIO_compressionType_t cType = FIO_zstdCompression;

int nbWorkers = -1; /* -1 means unset */

double compressibility = -1.0; /* lorem ipsum generator */

unsigned bench_nbSeconds = 3; /* would be better if this value was synchronized from bench */

size_t blockSize = 0;

FIO_prefs_t* const prefs = FIO_createPreferences();

FIO_ctx_t* const fCtx = FIO_createContext();

FIO_progressSetting_e progress = FIO_ps_auto;

zstd_operation_mode operation = zom_compress;

ZSTD_compressionParameters compressionParams;

int cLevel = init_cLevel();

int cLevelLast = MINCLEVEL - 1; /* lower than minimum */

unsigned recursive = 0;

unsigned memLimit = 0;

FileNamesTable* filenames = UTIL_allocateFileNamesTable((size_t)argCount); /* argCount >= 1 */

FileNamesTable* file_of_names = UTIL_allocateFileNamesTable((size_t)argCount); /* argCount >= 1 */

const char* programName = argv[0];

const char* outFileName = NULL;

const char* outDirName = NULL;

const char* outMirroredDirName = NULL;

const char* dictFileName = NULL;

const char* patchFromDictFileName = NULL;

const char* suffix = ZSTD_EXTENSION;

unsigned maxDictSize = g_defaultMaxDictSize;

unsigned dictID = 0;

size_t streamSrcSize = 0;

size_t targetCBlockSize = 0;

size_t srcSizeHint = 0;

size_t nbInputFileNames = 0;

int dictCLevel = g_defaultDictCLevel;

unsigned dictSelect = g_defaultSelectivityLevel;

#ifndef ZSTD_NODICT

ZDICT_cover_params_t coverParams = defaultCoverParams();

ZDICT_fastCover_params_t fastCoverParams = defaultFastCoverParams();

dictType dict = fastCover;

#ifndef ZSTD_NOBENCH

BMK_advancedParams_t benchParams = BMK_initAdvancedParams();

ZSTD_ParamSwitch_e literalCompressionMode = ZSTD_ps_auto;

/* init */

checkLibVersion();

(void)recursive; (void)cLevelLast; /* not used when ZSTD_NOBENCH set */

(void)memLimit;

assert(argCount >= 1);

if ((filenames==NULL) || (file_of_names==NULL)) { DISPLAYLEVEL(1, "zstd: allocation error \n"); exit(1); }

programName = lastNameFromPath(programName);

/* preset behaviors */

if (exeNameMatch(programName, ZSTD_ZSTDMT)) nbWorkers=0, singleThread=0;

if (exeNameMatch(programName, ZSTD_UNZSTD)) operation=zom_decompress;

if (exeNameMatch(programName, ZSTD_CAT)) { operation=zom_decompress; FIO_overwriteMode(prefs); forceStdout=1; followLinks=1; FIO_setPassThroughFlag(prefs, 1); outFileName=stdoutmark; g_displayLevel=1; } /* supports multiple formats */

if (exeNameMatch(programName, ZSTD_ZCAT)) { operation=zom_decompress; FIO_overwriteMode(prefs); forceStdout=1; followLinks=1; FIO_setPassThroughFlag(prefs, 1); outFileName=stdoutmark; g_displayLevel=1; } /* behave like zcat, also supports multiple formats */

if (exeNameMatch(programName, ZSTD_GZ)) { /* behave like gzip */

suffix = GZ_EXTENSION; cType = FIO_gzipCompression; removeSrcFile=1;

dictCLevel = cLevel = 6; /* gzip default is -6 */

}

if (exeNameMatch(programName, ZSTD_GUNZIP)) { operation=zom_decompress; removeSrcFile=1; } /* behave like gunzip, also supports multiple formats */

if (exeNameMatch(programName, ZSTD_GZCAT)) { operation=zom_decompress; FIO_overwriteMode(prefs); forceStdout=1; followLinks=1; FIO_setPassThroughFlag(prefs, 1); outFileName=stdoutmark; g_displayLevel=1; } /* behave like gzcat, also supports multiple formats */

if (exeNameMatch(programName, ZSTD_LZMA)) { suffix = LZMA_EXTENSION; cType = FIO_lzmaCompression; removeSrcFile=1; } /* behave like lzma */

if (exeNameMatch(programName, ZSTD_UNLZMA)) { operation=zom_decompress; cType = FIO_lzmaCompression; removeSrcFile=1; } /* behave like unlzma, also supports multiple formats */

if (exeNameMatch(programName, ZSTD_XZ)) { suffix = XZ_EXTENSION; cType = FIO_xzCompression; removeSrcFile=1; } /* behave like xz */

if (exeNameMatch(programName, ZSTD_UNXZ)) { operation=zom_decompress; cType = FIO_xzCompression; removeSrcFile=1; } /* behave like unxz, also supports multiple formats */

if (exeNameMatch(programName, ZSTD_LZ4)) { suffix = LZ4_EXTENSION; cType = FIO_lz4Compression; } /* behave like lz4 */

if (exeNameMatch(programName, ZSTD_UNLZ4)) { operation=zom_decompress; cType = FIO_lz4Compression; } /* behave like unlz4, also supports multiple formats */

memset(&compressionParams, 0, sizeof(compressionParams));

/* init crash handler */

FIO_addAbortHandler();

/* command switches */

for (argNb=1; argNb<argCount; argNb++) {

const char* argument = argv[argNb];

const char* const originalArgument = argument;

if (!argument) continue; /* Protection if argument empty */

if (nextArgumentsAreFiles) {

UTIL_refFilename(filenames, argument);

continue;

}

/* "-" means stdin/stdout */

if (!strcmp(argument, "-")){

UTIL_refFilename(filenames, stdinmark);

continue;

}

/* Decode commands (note : aggregated commands are allowed) */

if (argument[0]=='-') {

if (argument[1]=='-') {

/* long commands (--long-word) */

if (!strcmp(argument, "--")) { nextArgumentsAreFiles=1; continue; } /* only file names allowed from now on */

if (!strcmp(argument, "--list")) { operation=zom_list; continue; }

if (!strcmp(argument, "--compress")) { operation=zom_compress; continue; }

if (!strcmp(argument, "--decompress")) { operation=zom_decompress; continue; }

if (!strcmp(argument, "--uncompress")) { operation=zom_decompress; continue; }

if (!strcmp(argument, "--force")) { FIO_overwriteMode(prefs); forceStdin=1; forceStdout=1; followLinks=1; allowBlockDevices=1; continue; }

if (!strcmp(argument, "--version")) { printVersion(); CLEAN_RETURN(0); }

if (!strcmp(argument, "--help")) { usageAdvanced(programName); CLEAN_RETURN(0); }

if (!strcmp(argument, "--verbose")) { g_displayLevel++; continue; }

if (!strcmp(argument, "--quiet")) { g_displayLevel--; continue; }

if (!strcmp(argument, "--stdout")) { forceStdout=1; outFileName=stdoutmark; continue; }

if (!strcmp(argument, "--ultra")) { ultra=1; continue; }

if (!strcmp(argument, "--check")) { FIO_setChecksumFlag(prefs, 2); continue; }

if (!strcmp(argument, "--no-check")) { FIO_setChecksumFlag(prefs, 0); continue; }

if (!strcmp(argument, "--sparse")) { FIO_setSparseWrite(prefs, 2); continue; }

if (!strcmp(argument, "--no-sparse")) { FIO_setSparseWrite(prefs, 0); continue; }

if (!strcmp(argument, "--pass-through")) { FIO_setPassThroughFlag(prefs, 1); continue; }

if (!strcmp(argument, "--no-pass-through")) { FIO_setPassThroughFlag(prefs, 0); continue; }

if (!strcmp(argument, "--test")) { operation=zom_test; continue; }

if (!strcmp(argument, "--asyncio")) { FIO_setAsyncIOFlag(prefs, 1); continue;}

if (!strcmp(argument, "--no-asyncio")) { FIO_setAsyncIOFlag(prefs, 0); continue;}

if (!strcmp(argument, "--train")) { operation=zom_train; if (outFileName==NULL) outFileName=g_defaultDictName; continue; }

if (!strcmp(argument, "--no-dictID")) { FIO_setDictIDFlag(prefs, 0); continue; }

if (!strcmp(argument, "--keep")) { removeSrcFile=0; continue; }

if (!strcmp(argument, "--rm")) { removeSrcFile=1; continue; }

if (!strcmp(argument, "--priority=rt")) { setRealTimePrio = 1; continue; }

if (!strcmp(argument, "--show-default-cparams")) { showDefaultCParams = 1; continue; }

if (!strcmp(argument, "--content-size")) { contentSize = 1; continue; }

if (!strcmp(argument, "--no-content-size")) { contentSize = 0; continue; }

if (!strcmp(argument, "--adapt")) { adapt = 1; continue; }

if (!strcmp(argument, "--no-row-match-finder")) { useRowMatchFinder = ZSTD_ps_disable; continue; }

if (!strcmp(argument, "--row-match-finder")) { useRowMatchFinder = ZSTD_ps_enable; continue; }

if (longCommandWArg(&argument, "--adapt=")) { adapt = 1; if (!parseAdaptParameters(argument, &adaptMin, &adaptMax)) { badUsage(programName, originalArgument); CLEAN_RETURN(1); } continue; }

if (!strcmp(argument, "--single-thread")) { nbWorkers = 0; singleThread = 1; continue; }

if (!strcmp(argument, "--format=zstd")) { suffix = ZSTD_EXTENSION; cType = FIO_zstdCompression; continue; }

if (!strcmp(argument, "--mmap-dict")) { mmapDict = ZSTD_ps_enable; continue; }

if (!strcmp(argument, "--no-mmap-dict")) { mmapDict = ZSTD_ps_disable; continue; }