1 // SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0-only 2 /* 3 * Copyright (c) Meta Platforms, Inc. and affiliates. 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 /* ===== ZSTDERRORLIB_API : control library symbols visibility ===== */ 20 #ifndef ZSTDERRORLIB_VISIBLE 21 /* Backwards compatibility with old macro name */ 22 # ifdef ZSTDERRORLIB_VISIBILITY 23 # define ZSTDERRORLIB_VISIBLE ZSTDERRORLIB_VISIBILITY 24 # elif defined(__GNUC__) && (__GNUC__ >= 4) && !defined(__MINGW32__) 25 # define ZSTDERRORLIB_VISIBLE __attribute__ ((visibility ("default"))) 26 # else 27 # define ZSTDERRORLIB_VISIBLE 28 # endif 29 #endif 30 31 #ifndef ZSTDERRORLIB_HIDDEN 32 # if defined(__GNUC__) && (__GNUC__ >= 4) && !defined(__MINGW32__) 33 # define ZSTDERRORLIB_HIDDEN __attribute__ ((visibility ("hidden"))) 34 # else 35 # define ZSTDERRORLIB_HIDDEN 36 # endif 37 #endif 38 39 #if defined(ZSTD_DLL_EXPORT) && (ZSTD_DLL_EXPORT==1) 40 # define ZSTDERRORLIB_API __declspec(dllexport) ZSTDERRORLIB_VISIBLE 41 #elif defined(ZSTD_DLL_IMPORT) && (ZSTD_DLL_IMPORT==1) 42 # define ZSTDERRORLIB_API __declspec(dllimport) ZSTDERRORLIB_VISIBLE /* It isn't required but allows to generate better code, saving a function pointer load from the IAT and an indirect jump.*/ 43 #else 44 # define ZSTDERRORLIB_API ZSTDERRORLIB_VISIBLE 45 #endif 46 47 /*-********************************************* 48 * Error codes list 49 *-********************************************* 50 * Error codes _values_ are pinned down since v1.3.1 only. 51 * Therefore, don't rely on values if you may link to any version < v1.3.1. 52 * 53 * Only values < 100 are considered stable. 54 * 55 * note 1 : this API shall be used with static linking only. 56 * dynamic linking is not yet officially supported. 57 * note 2 : Prefer relying on the enum than on its value whenever possible 58 * This is the only supported way to use the error list < v1.3.1 59 * note 3 : ZSTD_isError() is always correct, whatever the library version. 60 **********************************************/ 61 typedef enum { 62 ZSTD_error_no_error = 0, 63 ZSTD_error_GENERIC = 1, 64 ZSTD_error_prefix_unknown = 10, 65 ZSTD_error_version_unsupported = 12, 66 ZSTD_error_frameParameter_unsupported = 14, 67 ZSTD_error_frameParameter_windowTooLarge = 16, 68 ZSTD_error_corruption_detected = 20, 69 ZSTD_error_checksum_wrong = 22, 70 ZSTD_error_literals_headerWrong = 24, 71 ZSTD_error_dictionary_corrupted = 30, 72 ZSTD_error_dictionary_wrong = 32, 73 ZSTD_error_dictionaryCreation_failed = 34, 74 ZSTD_error_parameter_unsupported = 40, 75 ZSTD_error_parameter_combination_unsupported = 41, 76 ZSTD_error_parameter_outOfBound = 42, 77 ZSTD_error_tableLog_tooLarge = 44, 78 ZSTD_error_maxSymbolValue_tooLarge = 46, 79 ZSTD_error_maxSymbolValue_tooSmall = 48, 80 ZSTD_error_cannotProduce_uncompressedBlock = 49, 81 ZSTD_error_stabilityCondition_notRespected = 50, 82 ZSTD_error_stage_wrong = 60, 83 ZSTD_error_init_missing = 62, 84 ZSTD_error_memory_allocation = 64, 85 ZSTD_error_workSpace_tooSmall= 66, 86 ZSTD_error_dstSize_tooSmall = 70, 87 ZSTD_error_srcSize_wrong = 72, 88 ZSTD_error_dstBuffer_null = 74, 89 ZSTD_error_noForwardProgress_destFull = 80, 90 ZSTD_error_noForwardProgress_inputEmpty = 82, 91 /* following error codes are __NOT STABLE__, they can be removed or changed in future versions */ 92 ZSTD_error_frameIndex_tooLarge = 100, 93 ZSTD_error_seekableIO = 102, 94 ZSTD_error_dstBuffer_wrong = 104, 95 ZSTD_error_srcBuffer_wrong = 105, 96 ZSTD_error_sequenceProducer_failed = 106, 97 ZSTD_error_externalSequences_invalid = 107, 98 ZSTD_error_maxCode = 120 /* never EVER use this value directly, it can change in future versions! Use ZSTD_isError() instead */ 99 } ZSTD_ErrorCode; 100 101 ZSTDERRORLIB_API const char* ZSTD_getErrorString(ZSTD_ErrorCode code); /**< Same as ZSTD_getErrorName, but using a `ZSTD_ErrorCode` enum argument */ 102 103 104 #if defined (__cplusplus) 105 } 106 #endif 107 108 #endif /* ZSTD_ERRORS_H_398273423 */ 109