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