fileio.h File Reference

#include "../lib/zstd.h"

Go to the source code of this file.

Macros
#define	ZSTD_STATIC_LINKING_ONLY   /* ZSTD_compressionParameters */
#define	stdinmark   "/*stdin*\\"
#define	stdoutmark   "/*stdout*\\"
#define	nulmark   "/dev/null"
#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"

Typedefs
typedef struct FIO_prefs_s	FIO_prefs_t
typedef struct FIO_ctx_s	FIO_ctx_t
typedef struct FIO_display_prefs_s	FIO_display_prefs_t

Enumerations
enum	FIO_compressionType_t {   FIO_zstdCompression , FIO_gzipCompression , FIO_xzCompression , FIO_lzmaCompression ,   FIO_lz4Compression }
enum	FIO_progressSetting_e { FIO_ps_auto , FIO_ps_never , FIO_ps_always }

Functions
FIO_prefs_t *	FIO_createPreferences (void)
void	FIO_freePreferences (FIO_prefs_t *const prefs)
FIO_ctx_t *	FIO_createContext (void)
void	FIO_freeContext (FIO_ctx_t *const fCtx)
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, unsigned 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, unsigned flag)
void	FIO_setSparseWrite (FIO_prefs_t *const prefs, unsigned sparse)
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_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)
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)
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)
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)
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)
int	FIO_checkFilenameCollisions (const char **filenameTable, unsigned nbFiles)
void	FIO_addAbortHandler (void)

Macro Definition Documentation

GZ_EXTENSION

#define GZ_EXTENSION   ".gz"

LZ4_EXTENSION

#define LZ4_EXTENSION   ".lz4"

LZMA_EXTENSION

#define LZMA_EXTENSION   ".lzma"

We test whether the extension we found starts with 't', and if so, we append ".tar" to the end of the output name.

nulmark

#define nulmark   "/dev/null"

stdinmark

#define stdinmark   "/*stdin*\\"

stdoutmark

#define stdoutmark   "/*stdout*\\"

TGZ_EXTENSION

#define TGZ_EXTENSION   ".tgz"

TLZ4_EXTENSION

#define TLZ4_EXTENSION   ".tlz4"

TXZ_EXTENSION

#define TXZ_EXTENSION   ".txz"

TZSTD_EXTENSION

#define TZSTD_EXTENSION   ".tzst"

XZ_EXTENSION

#define XZ_EXTENSION   ".xz"

ZSTD_ALT_EXTENSION

#define ZSTD_ALT_EXTENSION   ".zstd" /* allow decompression of .zstd files */

ZSTD_EXTENSION

#define ZSTD_EXTENSION   ".zst"

ZSTD_STATIC_LINKING_ONLY

#define ZSTD_STATIC_LINKING_ONLY   /* ZSTD_compressionParameters */

Typedef Documentation

FIO_ctx_t

typedef struct FIO_ctx_s FIO_ctx_t

FIO_display_prefs_t

typedef struct FIO_display_prefs_s FIO_display_prefs_t

FIO_prefs_t

typedef struct FIO_prefs_s FIO_prefs_t

Enumeration Type Documentation

FIO_compressionType_t

enum FIO_compressionType_t

Enumerator
FIO_zstdCompression
FIO_gzipCompression
FIO_xzCompression
FIO_lzmaCompression
FIO_lz4Compression

FIO_progressSetting_e

enum FIO_progressSetting_e

Enumerator
FIO_ps_auto
FIO_ps_never
FIO_ps_always

Function Documentation

FIO_addAbortHandler()

void FIO_addAbortHandler

(

void

)

FIO_checkFilenameCollisions()

int FIO_checkFilenameCollisions	(	const char **	filenameTable,
		unsigned	nbFiles )

FIO_compressFilename()

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_compressFilename() :

Returns

: 0 == ok; 1 == pb with src file.

FIO_compressMultipleFilenames()

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_compressMultipleFilenames() :

Returns

: nb of missing files

FIO_createContext()

FIO_ctx_t * FIO_createContext

(

void

)

FIO_createPreferences()

FIO_prefs_t * FIO_createPreferences

(

void

)

FIO_decompressFilename()

int FIO_decompressFilename	(	FIO_ctx_t *const	fCtx,
		FIO_prefs_t *const	prefs,
		const char *	outfilename,
		const char *	infilename,
		const char *	dictFileName )

FIO_decompressFilename() :

Returns

: 0 == ok; 1 == pb with src file.

FIO_decompressMultipleFilenames()

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_decompressMultipleFilenames() :

Returns

: nb of missing or skipped files

FIO_determineHasStdinInput()

void FIO_determineHasStdinInput	(	FIO_ctx_t *const	fCtx,
		const FileNamesTable *const	filenames )

FIO_displayCompressionParameters()

void FIO_displayCompressionParameters

(

const FIO_prefs_t *

prefs

)

FIO_freeContext()

void FIO_freeContext

(

FIO_ctx_t *const

fCtx

)

FIO_freePreferences()

void FIO_freePreferences

(

FIO_prefs_t *const

prefs

)

FIO_listMultipleFiles()

int FIO_listMultipleFiles	(	unsigned	numFiles,
		const char **	filenameTable,
		int	displayLevel )

FIO_overwriteMode()

void FIO_overwriteMode

(

FIO_prefs_t *const

prefs

)

FIO_setAdaptiveMode()

void FIO_setAdaptiveMode	(	FIO_prefs_t *const	prefs,
		unsigned	adapt )

FIO_setAdaptMax()

void FIO_setAdaptMax	(	FIO_prefs_t *const	prefs,
		int	maxCLevel )

FIO_setAdaptMin()

void FIO_setAdaptMin	(	FIO_prefs_t *const	prefs,
		int	minCLevel )

FIO_setAllowBlockDevices()

void FIO_setAllowBlockDevices	(	FIO_prefs_t *const	prefs,
		int	allowBlockDevices )

FIO_setBlockSize()

void FIO_setBlockSize	(	FIO_prefs_t *const	prefs,
		int	blockSize )

FIO_setChecksumFlag()

void FIO_setChecksumFlag	(	FIO_prefs_t *const	prefs,
		int	checksumFlag )

FIO_setCompressionType()

void FIO_setCompressionType	(	FIO_prefs_t *const	prefs,
		FIO_compressionType_t	compressionType )

FIO_setContentSize()

void FIO_setContentSize	(	FIO_prefs_t *const	prefs,
		int	value )

FIO_setDictIDFlag()

void FIO_setDictIDFlag	(	FIO_prefs_t *const	prefs,
		int	dictIDFlag )

FIO_setExcludeCompressedFile()

void FIO_setExcludeCompressedFile	(	FIO_prefs_t *const	prefs,
		int	excludeCompressedFiles )

FIO_setHasStdoutOutput()

void FIO_setHasStdoutOutput	(	FIO_ctx_t *const	fCtx,
		int	value )

FIO_setLdmBucketSizeLog()

void FIO_setLdmBucketSizeLog	(	FIO_prefs_t *const	prefs,
		int	ldmBucketSizeLog )

FIO_setLdmFlag()

void FIO_setLdmFlag	(	FIO_prefs_t *const	prefs,
		unsigned	ldmFlag )

FIO_setLdmHashLog()

void FIO_setLdmHashLog	(	FIO_prefs_t *const	prefs,
		int	ldmHashLog )

FIO_setLdmHashRateLog()

void FIO_setLdmHashRateLog	(	FIO_prefs_t *const	prefs,
		int	ldmHashRateLog )

FIO_setLdmMinMatch()

void FIO_setLdmMinMatch	(	FIO_prefs_t *const	prefs,
		int	ldmMinMatch )

FIO_setLiteralCompressionMode()

void FIO_setLiteralCompressionMode	(	FIO_prefs_t *const	prefs,
		ZSTD_paramSwitch_e	mode )

FIO_setMemLimit()

void FIO_setMemLimit	(	FIO_prefs_t *const	prefs,
		unsigned	memLimit )

FIO_setNbFilesTotal()

void FIO_setNbFilesTotal	(	FIO_ctx_t *const	fCtx,
		int	value )

FIO_setNbWorkers()

void FIO_setNbWorkers	(	FIO_prefs_t *const	prefs,
		int	nbWorkers )

FIO_setNotificationLevel()

void FIO_setNotificationLevel

(

int

level

)

FIO_setOverlapLog()

void FIO_setOverlapLog	(	FIO_prefs_t *const	prefs,
		int	overlapLog )

FIO_setPatchFromMode()

void FIO_setPatchFromMode	(	FIO_prefs_t *const	prefs,
		int	value )

FIO_setProgressSetting()

void FIO_setProgressSetting

(

FIO_progressSetting_e

progressSetting

)

FIO_setRemoveSrcFile()

void FIO_setRemoveSrcFile	(	FIO_prefs_t *const	prefs,
		unsigned	flag )

FIO_setRsyncable()

void FIO_setRsyncable	(	FIO_prefs_t *const	prefs,
		int	rsyncable )

FIO_setSparseWrite()

void FIO_setSparseWrite	(	FIO_prefs_t *const	prefs,
		unsigned	sparse )

0: no sparse; 1: disable on stdout; 2: always enabled

FIO_setSrcSizeHint()

void FIO_setSrcSizeHint	(	FIO_prefs_t *const	prefs,
		size_t	srcSizeHint )

FIO_setStreamSrcSize()

void FIO_setStreamSrcSize	(	FIO_prefs_t *const	prefs,
		size_t	streamSrcSize )

FIO_setTargetCBlockSize()

void FIO_setTargetCBlockSize	(	FIO_prefs_t *const	prefs,
		size_t	targetCBlockSize )

FIO_setTestMode()

void FIO_setTestMode	(	FIO_prefs_t *const	prefs,
		int	testMode )

FIO_setUseRowMatchFinder()

void FIO_setUseRowMatchFinder	(	FIO_prefs_t *const	prefs,
		int	useRowMatchFinder )