#include <stddef.h>
#include "zstd_errors.h"

Include dependency graph for error_private.h:

This graph shows which files directly or indirectly include this file:

Macros
#define	ERR_STATIC static /* this version may generate warnings for unused static functions; disable the relevant warning */

#define	PREFIX(name) ZSTD_error_##name

#define	ERROR(name) ZSTD_ERROR(name)

#define	ZSTD_ERROR(name) ((size_t)-PREFIX(name))

#define	CHECK_V_F(e, f) size_t const e = f; if (ERR_isError(e)) return e

#define	CHECK_F(f) { CHECK_V_F(_var_err__, f); }

Typedefs
typedef ZSTD_ErrorCode	ERR_enum

Functions
ERR_STATIC unsigned	ERR_isError (size_t code)

ERR_STATIC ERR_enum	ERR_getErrorCode (size_t code)

const char *	ERR_getErrorString (ERR_enum code)

ERR_STATIC const char *	ERR_getErrorName (size_t code)

Macro Definition Documentation

◆ CHECK_F

#define CHECK_F ( f ) { CHECK_V_F(_var_err__, f); }

Definition at line 62 of file error_private.h.

◆ CHECK_V_F

#define CHECK_V_F	(	e,
		f
	)	size_t const e = f; if (ERR_isError(e)) return e

Definition at line 61 of file error_private.h.

◆ ERR_STATIC

#define ERR_STATIC static /* this version may generate warnings for unused static functions; disable the relevant warning */

Definition at line 38 of file error_private.h.

◆ ERROR

#define ERROR ( name ) ZSTD_ERROR(name)

Definition at line 53 of file error_private.h.

◆ PREFIX

#define PREFIX ( name ) ZSTD_error_##name

Definition at line 46 of file error_private.h.

◆ ZSTD_ERROR

#define ZSTD_ERROR ( name ) ((size_t)-PREFIX(name))

Definition at line 54 of file error_private.h.

Typedef Documentation

◆ ERR_enum

typedef ZSTD_ErrorCode ERR_enum

Definition at line 45 of file error_private.h.

Function Documentation

◆ ERR_getErrorCode()

ERR_STATIC ERR_enum ERR_getErrorCode ( size_t code )

Definition at line 58 of file error_private.h.

58{ if (!ERR_isError(code)) return (ERR_enum)0; return (ERR_enum) (0-code); }

ERR_isError

ERR_STATIC unsigned ERR_isError(size_t code)

Definition: error_private.h:56

code

Definition: inflate.c:139

ZSTD_ErrorCode

Definition: zstd_errors.h:52

Referenced by ERR_getErrorName(), and ZSTD_getErrorCode().

◆ ERR_getErrorName()

ERR_STATIC const char * ERR_getErrorName ( size_t code )

Definition at line 71 of file error_private.h.

{
    return ERR_getErrorString(ERR_getErrorCode(code));
}

Referenced by FSE_getErrorName(), HUF_getErrorName(), and ZSTD_getErrorName().

◆ ERR_getErrorString()

const char * ERR_getErrorString ( ERR_enum code )

Definition at line 15 of file error_private.c.

{
#ifdef ZSTD_STRIP_ERROR_STRINGS
    (void)code;
    return "Error strings stripped";
#else
    static const char* const notErrorCode = "Unspecified error code";
    switch( code )
    {
    case PREFIX(no_error): return "No error detected";
    case PREFIX(GENERIC):  return "Error (generic)";
    case PREFIX(prefix_unknown): return "Unknown frame descriptor";
    case PREFIX(version_unsupported): return "Version not supported";
    case PREFIX(frameParameter_unsupported): return "Unsupported frame parameter";
    case PREFIX(frameParameter_windowTooLarge): return "Frame requires too much memory for decoding";
    case PREFIX(corruption_detected): return "Corrupted block detected";
    case PREFIX(checksum_wrong): return "Restored data doesn't match checksum";
    case PREFIX(parameter_unsupported): return "Unsupported parameter";
    case PREFIX(parameter_outOfBound): return "Parameter is out of bound";
    case PREFIX(init_missing): return "Context should be init first";
    case PREFIX(memory_allocation): return "Allocation error : not enough memory";
    case PREFIX(workSpace_tooSmall): return "workSpace buffer is not large enough";
    case PREFIX(stage_wrong): return "Operation not authorized at current processing stage";
    case PREFIX(tableLog_tooLarge): return "tableLog requires too much memory : unsupported";
    case PREFIX(maxSymbolValue_tooLarge): return "Unsupported max Symbol Value : too large";
    case PREFIX(maxSymbolValue_tooSmall): return "Specified maxSymbolValue is too small";
    case PREFIX(dictionary_corrupted): return "Dictionary is corrupted";
    case PREFIX(dictionary_wrong): return "Dictionary mismatch";
    case PREFIX(dictionaryCreation_failed): return "Cannot create Dictionary from provided samples";
    case PREFIX(dstSize_tooSmall): return "Destination buffer is too small";
    case PREFIX(srcSize_wrong): return "Src size is incorrect";
    case PREFIX(dstBuffer_null): return "Operation on NULL destination buffer";
        /* following error codes are not stable and may be removed or changed in a future version */
    case PREFIX(frameIndex_tooLarge): return "Frame index is too large";
    case PREFIX(seekableIO): return "An I/O error occurred when reading/seeking";
    case PREFIX(dstBuffer_wrong): return "Destination buffer is wrong";
    case PREFIX(maxCode):
    default: return notErrorCode;
    }
#endif
}