zstd_common.c File Reference

#include <stdlib.h>
#include <string.h>
#include "error_private.h"
#include "zstd_internal.h"

Include dependency graph for zstd_common.c:

Go to the source code of this file.

Functions
unsigned	ZSTD_versionNumber (void)
const char *	ZSTD_versionString (void)
unsigned	ZSTD_isError (size_t code)
const char *	ZSTD_getErrorName (size_t code)
ZSTD_ErrorCode	ZSTD_getErrorCode (size_t code)
const char *	ZSTD_getErrorString (ZSTD_ErrorCode code)
void *	ZSTD_malloc (size_t size, ZSTD_customMem customMem)
void *	ZSTD_calloc (size_t size, ZSTD_customMem customMem)
void	ZSTD_free (void *ptr, ZSTD_customMem customMem)

Function Documentation

ZSTD_calloc()

void * ZSTD_calloc	(	size_t	size,
		ZSTD_customMem	customMem
	)

Definition at line 61 of file zstd_common.c.

{
    /* calloc implemented as malloc+memset;
        * not as efficient as calloc, but next best guess for custom malloc */
    void* const ptr = customMem.customAlloc(customMem.opaque, size);
    memset(ptr, 0, size);
    return ptr;
}

Referenced by ZSTD_createCCtxParams_advanced().

ZSTD_free()

void ZSTD_free	(	void *	ptr,
		ZSTD_customMem	customMem
	)

Definition at line 70 of file zstd_common.c.

{
    if (ptr!=NULL)
        customMem.customFree(customMem.opaque, ptr);
}

Referenced by ZSTD_clearAllDicts(), ZSTD_createCDict_advanced(), ZSTD_cwksp_free(), ZSTD_decompressStream(), ZSTD_freeCCtx(), ZSTD_freeCCtxParams(), ZSTD_freeCDict(), ZSTD_freeDCtx(), ZSTD_freeDDict(), and ZSTD_getSequences().

ZSTD_getErrorCode()

ZSTD_ErrorCode ZSTD_getErrorCode

(

size_t

code

)

ZSTD_getError() : convert a size_t function result into a proper ZSTD_errorCode enum

Definition at line 45 of file zstd_common.c.

{ return ERR_getErrorCode(code); }

Referenced by ZSTD_decompressMultiFrame().

ZSTD_getErrorName()

const char * ZSTD_getErrorName

(

size_t

code

)

ZSTD_getErrorName() : provides error code string from function result (useful for debugging)

Definition at line 41 of file zstd_common.c.

{ return ERR_getErrorName(code); }

Referenced by zstd_compress(), ZSTD_compressSubBlock_literal(), and zstd_decompress().

ZSTD_getErrorString()

const char * ZSTD_getErrorString

(

ZSTD_ErrorCode

code

)

ZSTD_getErrorString() : provides error code string from enum

Definition at line 49 of file zstd_common.c.

{ return ERR_getErrorString(code); }

ZSTD_isError()

unsigned ZSTD_isError

(

size_t

code

)

ZSTD_isError() : tells if a return value is an error code symbol is required for external callers

Definition at line 37 of file zstd_common.c.

{ return ERR_isError(code); }

ZSTD_malloc()

void * ZSTD_malloc	(	size_t	size,
		ZSTD_customMem	customMem
	)

Definition at line 56 of file zstd_common.c.

{
    return customMem.customAlloc(customMem.opaque, size);
}

Referenced by ZSTD_CCtx_loadDictionary_advanced(), ZSTD_createCCtx_advanced(), ZSTD_createCDict_advanced(), ZSTD_createDCtx_advanced(), ZSTD_createDDict_advanced(), ZSTD_cwksp_create(), ZSTD_decompressStream(), ZSTD_getSequences(), and ZSTD_initDDict_internal().

ZSTD_versionNumber()

unsigned ZSTD_versionNumber

(

void

)

to check runtime library version

Definition at line 25 of file zstd_common.c.

{ return ZSTD_VERSION_NUMBER; }

ZSTD_versionString()

const char * ZSTD_versionString

(

void

)

Definition at line 27 of file zstd_common.c.

{ return ZSTD_VERSION_STRING; }