1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0-only 2 /* 3 * Copyright (c) 2016-2020, Yann Collet, Facebook, Inc. 4 * All rights reserved. 5 * 6 * This source code is licensed under both the BSD-style license (found in the 7 * LICENSE file in the root directory of this source tree) and the GPLv2 (found 8 * in the COPYING file in the root directory of this source tree). 9 * You may select, at your option, one of the above-listed licenses. 10 */ 11 12 #ifndef ZSTD_ERRORS_H_398273423 13 #define ZSTD_ERRORS_H_398273423 14 15 #if defined (__cplusplus) 16 extern "C" { 17 #endif 18 19 /*===== dependency =====*/ 20 #include <stddef.h> /* size_t */ 21 22 23 /* ===== ZSTDERRORLIB_API : control library symbols visibility ===== */ 24 #ifndef ZSTDERRORLIB_VISIBILITY 25 # if defined(__GNUC__) && (__GNUC__ >= 4) 26 # define ZSTDERRORLIB_VISIBILITY __attribute__ ((visibility ("default"))) 27 # else 28 # define ZSTDERRORLIB_VISIBILITY 29 # endif 30 #endif 31 #if defined(ZSTD_DLL_EXPORT) && (ZSTD_DLL_EXPORT==1) 32 # define ZSTDERRORLIB_API __declspec(dllexport) ZSTDERRORLIB_VISIBILITY 33 #elif defined(ZSTD_DLL_IMPORT) && (ZSTD_DLL_IMPORT==1) 34 # define ZSTDERRORLIB_API __declspec(dllimport) ZSTDERRORLIB_VISIBILITY /* It isn't required but allows to generate better code, saving a function pointer load from the IAT and an indirect jump.*/ 35 #else 36 # define ZSTDERRORLIB_API ZSTDERRORLIB_VISIBILITY 37 #endif 38 39 /*-********************************************* 40 * Error codes list 41 *-********************************************* 42 * Error codes _values_ are pinned down since v1.3.1 only. 43 * Therefore, don't rely on values if you may link to any version < v1.3.1. 44 * 45 * Only values < 100 are considered stable. 46 * 47 * note 1 : this API shall be used with static linking only. 48 * dynamic linking is not yet officially supported. 49 * note 2 : Prefer relying on the enum than on its value whenever possible 50 * This is the only supported way to use the error list < v1.3.1 51 * note 3 : ZSTD_isError() is always correct, whatever the library version. 52 **********************************************/ 53 typedef enum { 54 ZSTD_error_no_error = 0, 55 ZSTD_error_GENERIC = 1, 56 ZSTD_error_prefix_unknown = 10, 57 ZSTD_error_version_unsupported = 12, 58 ZSTD_error_frameParameter_unsupported = 14, 59 ZSTD_error_frameParameter_windowTooLarge = 16, 60 ZSTD_error_corruption_detected = 20, 61 ZSTD_error_checksum_wrong = 22, 62 ZSTD_error_dictionary_corrupted = 30, 63 ZSTD_error_dictionary_wrong = 32, 64 ZSTD_error_dictionaryCreation_failed = 34, 65 ZSTD_error_parameter_unsupported = 40, 66 ZSTD_error_parameter_outOfBound = 42, 67 ZSTD_error_tableLog_tooLarge = 44, 68 ZSTD_error_maxSymbolValue_tooLarge = 46, 69 ZSTD_error_maxSymbolValue_tooSmall = 48, 70 ZSTD_error_stage_wrong = 60, 71 ZSTD_error_init_missing = 62, 72 ZSTD_error_memory_allocation = 64, 73 ZSTD_error_workSpace_tooSmall= 66, 74 ZSTD_error_dstSize_tooSmall = 70, 75 ZSTD_error_srcSize_wrong = 72, 76 ZSTD_error_dstBuffer_null = 74, 77 /* following error codes are __NOT STABLE__, they can be removed or changed in future versions */ 78 ZSTD_error_frameIndex_tooLarge = 100, 79 ZSTD_error_seekableIO = 102, 80 ZSTD_error_dstBuffer_wrong = 104, 81 ZSTD_error_maxCode = 120 /* never EVER use this value directly, it can change in future versions! Use ZSTD_isError() instead */ 82 } ZSTD_ErrorCode; 83 84 /*! ZSTD_getErrorCode() : 85 convert a `size_t` function result into a `ZSTD_ErrorCode` enum type, 86 which can be used to compare with enum list published above */ 87 ZSTDERRORLIB_API ZSTD_ErrorCode ZSTD_getErrorCode(size_t functionResult); 88 ZSTDERRORLIB_API const char* ZSTD_getErrorString(ZSTD_ErrorCode code); /**< Same as ZSTD_getErrorName, but using a `ZSTD_ErrorCode` enum argument */ 89 90 91 #if defined (__cplusplus) 92 } 93 #endif 94 95 #endif /* ZSTD_ERRORS_H_398273423 */ 96