xref: /freebsd/sys/contrib/openzfs/module/zstd/lib/common/error_private.c (revision 61145dc2b94f12f6a47344fb9aac702321880e43)
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 /* The purpose of this file is to have a single list of error strings embedded in binary */
13 
14 #include "error_private.h"
15 
ERR_getErrorString(ERR_enum code)16 const char* ERR_getErrorString(ERR_enum code)
17 {
18 #ifdef ZSTD_STRIP_ERROR_STRINGS
19     (void)code;
20     return "Error strings stripped";
21 #else
22     static const char* const notErrorCode = "Unspecified error code";
23     switch( code )
24     {
25     case PREFIX(no_error): return "No error detected";
26     case PREFIX(GENERIC):  return "Error (generic)";
27     case PREFIX(prefix_unknown): return "Unknown frame descriptor";
28     case PREFIX(version_unsupported): return "Version not supported";
29     case PREFIX(frameParameter_unsupported): return "Unsupported frame parameter";
30     case PREFIX(frameParameter_windowTooLarge): return "Frame requires too much memory for decoding";
31     case PREFIX(corruption_detected): return "Corrupted block detected";
32     case PREFIX(checksum_wrong): return "Restored data doesn't match checksum";
33     case PREFIX(parameter_unsupported): return "Unsupported parameter";
34     case PREFIX(parameter_outOfBound): return "Parameter is out of bound";
35     case PREFIX(init_missing): return "Context should be init first";
36     case PREFIX(memory_allocation): return "Allocation error : not enough memory";
37     case PREFIX(workSpace_tooSmall): return "workSpace buffer is not large enough";
38     case PREFIX(stage_wrong): return "Operation not authorized at current processing stage";
39     case PREFIX(tableLog_tooLarge): return "tableLog requires too much memory : unsupported";
40     case PREFIX(maxSymbolValue_tooLarge): return "Unsupported max Symbol Value : too large";
41     case PREFIX(maxSymbolValue_tooSmall): return "Specified maxSymbolValue is too small";
42     case PREFIX(dictionary_corrupted): return "Dictionary is corrupted";
43     case PREFIX(dictionary_wrong): return "Dictionary mismatch";
44     case PREFIX(dictionaryCreation_failed): return "Cannot create Dictionary from provided samples";
45     case PREFIX(dstSize_tooSmall): return "Destination buffer is too small";
46     case PREFIX(srcSize_wrong): return "Src size is incorrect";
47     case PREFIX(dstBuffer_null): return "Operation on NULL destination buffer";
48         /* following error codes are not stable and may be removed or changed in a future version */
49     case PREFIX(frameIndex_tooLarge): return "Frame index is too large";
50     case PREFIX(seekableIO): return "An I/O error occurred when reading/seeking";
51     case PREFIX(dstBuffer_wrong): return "Destination buffer is wrong";
52     case PREFIX(maxCode):
53     default: return notErrorCode;
54     }
55 #endif
56 }
57