zstd_errors.h 3.6 KB

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