/* * Copyright (c) Meta Platforms, Inc. and affiliates. * All rights reserved. * * 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). * You may select, at your option, one of the above-listed licenses. */ #ifndef FILEIO_H_23981798732 #define FILEIO_H_23981798732 #include "fileio_types.h" #include "util.h" /* FileNamesTable */ #define ZSTD_STATIC_LINKING_ONLY /* ZSTD_compressionParameters */ #include "../lib/zstd.h" /* ZSTD_* */ #if defined (__cplusplus) extern "C" { #endif /* ************************************* * Special i/o constants **************************************/ #define stdinmark "/*stdin*\\" #define stdoutmark "/*stdout*\\" #ifdef _WIN32 # define nulmark "NUL" #else # define nulmark "/dev/null" #endif /** * We test whether the extension we found starts with 't', and if so, we append * ".tar" to the end of the output name. */ #define LZMA_EXTENSION ".lzma" #define XZ_EXTENSION ".xz" #define TXZ_EXTENSION ".txz" #define GZ_EXTENSION ".gz" #define TGZ_EXTENSION ".tgz" #define ZSTD_EXTENSION ".zst" #define TZSTD_EXTENSION ".tzst" #define ZSTD_ALT_EXTENSION ".zstd" /* allow decompression of .zstd files */ #define LZ4_EXTENSION ".lz4" #define TLZ4_EXTENSION ".tlz4" /*-************************************* * Types ***************************************/ FIO_prefs_t* FIO_createPreferences(void); void FIO_freePreferences(FIO_prefs_t* const prefs); /* Mutable struct containing relevant context and state regarding (de)compression with respect to file I/O */ typedef struct FIO_ctx_s FIO_ctx_t; FIO_ctx_t* FIO_createContext(void); void FIO_freeContext(FIO_ctx_t* const fCtx); /*-************************************* * Parameters ***************************************/ /* FIO_prefs_t functions */ void FIO_setCompressionType(FIO_prefs_t* const prefs, FIO_compressionType_t compressionType); void FIO_overwriteMode(FIO_prefs_t* const prefs); void FIO_setAdaptiveMode(FIO_prefs_t* const prefs, int adapt); void FIO_setAdaptMin(FIO_prefs_t* const prefs, int minCLevel); void FIO_setAdaptMax(FIO_prefs_t* const prefs, int maxCLevel); void FIO_setUseRowMatchFinder(FIO_prefs_t* const prefs, int useRowMatchFinder); void FIO_setBlockSize(FIO_prefs_t* const prefs, int blockSize); void FIO_setChecksumFlag(FIO_prefs_t* const prefs, int checksumFlag); void FIO_setDictIDFlag(FIO_prefs_t* const prefs, int dictIDFlag); void FIO_setLdmBucketSizeLog(FIO_prefs_t* const prefs, int ldmBucketSizeLog); void FIO_setLdmFlag(FIO_prefs_t* const prefs, unsigned ldmFlag); void FIO_setLdmHashRateLog(FIO_prefs_t* const prefs, int ldmHashRateLog); void FIO_setLdmHashLog(FIO_prefs_t* const prefs, int ldmHashLog); void FIO_setLdmMinMatch(FIO_prefs_t* const prefs, int ldmMinMatch); void FIO_setMemLimit(FIO_prefs_t* const prefs, unsigned memLimit); void FIO_setNbWorkers(FIO_prefs_t* const prefs, int nbWorkers); void FIO_setOverlapLog(FIO_prefs_t* const prefs, int overlapLog); void FIO_setRemoveSrcFile(FIO_prefs_t* const prefs, int flag); void FIO_setSparseWrite(FIO_prefs_t* const prefs, int sparse); /**< 0: no sparse; 1: disable on stdout; 2: always enabled */ void FIO_setRsyncable(FIO_prefs_t* const prefs, int rsyncable); void FIO_setStreamSrcSize(FIO_prefs_t* const prefs, size_t streamSrcSize); void FIO_setTargetCBlockSize(FIO_prefs_t* const prefs, size_t targetCBlockSize); void FIO_setSrcSizeHint(FIO_prefs_t* const prefs, size_t srcSizeHint); void FIO_setTestMode(FIO_prefs_t* const prefs, int testMode); void FIO_setLiteralCompressionMode( FIO_prefs_t* const prefs, ZSTD_paramSwitch_e mode); void FIO_setProgressSetting(FIO_progressSetting_e progressSetting); void FIO_setNotificationLevel(int level); void FIO_setExcludeCompressedFile(FIO_prefs_t* const prefs, int excludeCompressedFiles); void FIO_setAllowBlockDevices(FIO_prefs_t* const prefs, int allowBlockDevices); void FIO_setPatchFromMode(FIO_prefs_t* const prefs, int value); void FIO_setContentSize(FIO_prefs_t* const prefs, int value); void FIO_displayCompressionParameters(const FIO_prefs_t* prefs); void FIO_setAsyncIOFlag(FIO_prefs_t* const prefs, int value); void FIO_setPassThroughFlag(FIO_prefs_t* const prefs, int value); void FIO_setMMapDict(FIO_prefs_t* const prefs, ZSTD_paramSwitch_e value); /* FIO_ctx_t functions */ void FIO_setNbFilesTotal(FIO_ctx_t* const fCtx, int value); void FIO_setHasStdoutOutput(FIO_ctx_t* const fCtx, int value); void FIO_determineHasStdinInput(FIO_ctx_t* const fCtx, const FileNamesTable* const filenames); /*-************************************* * Single File functions ***************************************/ /** FIO_compressFilename() : * @return : 0 == ok; 1 == pb with src file. */ int FIO_compressFilename (FIO_ctx_t* const fCtx, FIO_prefs_t* const prefs, const char* outfilename, const char* infilename, const char* dictFileName, int compressionLevel, ZSTD_compressionParameters comprParams); /** FIO_decompressFilename() : * @return : 0 == ok; 1 == pb with src file. */ int FIO_decompressFilename (FIO_ctx_t* const fCtx, FIO_prefs_t* const prefs, const char* outfilename, const char* infilename, const char* dictFileName); int FIO_listMultipleFiles(unsigned numFiles, const char** filenameTable, int displayLevel); /*-************************************* * Multiple File functions ***************************************/ /** FIO_compressMultipleFilenames() : * @return : nb of missing files */ int FIO_compressMultipleFilenames(FIO_ctx_t* const fCtx, FIO_prefs_t* const prefs, const char** inFileNamesTable, const char* outMirroredDirName, const char* outDirName, const char* outFileName, const char* suffix, const char* dictFileName, int compressionLevel, ZSTD_compressionParameters comprParams); /** FIO_decompressMultipleFilenames() : * @return : nb of missing or skipped files */ int FIO_decompressMultipleFilenames(FIO_ctx_t* const fCtx, FIO_prefs_t* const prefs, const char** srcNamesTable, const char* outMirroredDirName, const char* outDirName, const char* outFileName, const char* dictFileName); /* FIO_checkFilenameCollisions() : * Checks for and warns if there are any files that would have the same output path */ int FIO_checkFilenameCollisions(const char** filenameTable, unsigned nbFiles); /*-************************************* * Advanced stuff (should actually be hosted elsewhere) ***************************************/ /* custom crash signal handler */ void FIO_addAbortHandler(void); char const* FIO_zlibVersion(void); char const* FIO_lz4Version(void); char const* FIO_lzmaVersion(void); #if defined (__cplusplus) } #endif #endif /* FILEIO_H_23981798732 */