xref: /linux/lib/zstd/common/error_private.c (revision e61f33273ca755b3e2ebee4520a76097199dc7a8)
1 // SPDX-License-Identifier: GPL-2.0+ OR BSD-3-Clause
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 /* 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 "Data corruption detected";
32     case PREFIX(checksum_wrong): return "Restored data doesn't match checksum";
33     case PREFIX(literals_headerWrong): return "Header of Literals' block doesn't respect format specification";
34     case PREFIX(parameter_unsupported): return "Unsupported parameter";
35     case PREFIX(parameter_combination_unsupported): return "Unsupported combination of parameters";
36     case PREFIX(parameter_outOfBound): return "Parameter is out of bound";
37     case PREFIX(init_missing): return "Context should be init first";
38     case PREFIX(memory_allocation): return "Allocation error : not enough memory";
39     case PREFIX(workSpace_tooSmall): return "workSpace buffer is not large enough";
40     case PREFIX(stage_wrong): return "Operation not authorized at current processing stage";
41     case PREFIX(tableLog_tooLarge): return "tableLog requires too much memory : unsupported";
42     case PREFIX(maxSymbolValue_tooLarge): return "Unsupported max Symbol Value : too large";
43     case PREFIX(maxSymbolValue_tooSmall): return "Specified maxSymbolValue is too small";
44     case PREFIX(cannotProduce_uncompressedBlock): return "This mode cannot generate an uncompressed block";
45     case PREFIX(stabilityCondition_notRespected): return "pledged buffer stability condition is not respected";
46     case PREFIX(dictionary_corrupted): return "Dictionary is corrupted";
47     case PREFIX(dictionary_wrong): return "Dictionary mismatch";
48     case PREFIX(dictionaryCreation_failed): return "Cannot create Dictionary from provided samples";
49     case PREFIX(dstSize_tooSmall): return "Destination buffer is too small";
50     case PREFIX(srcSize_wrong): return "Src size is incorrect";
51     case PREFIX(dstBuffer_null): return "Operation on NULL destination buffer";
52     case PREFIX(noForwardProgress_destFull): return "Operation made no progress over multiple calls, due to output buffer being full";
53     case PREFIX(noForwardProgress_inputEmpty): return "Operation made no progress over multiple calls, due to input being empty";
54         /* following error codes are not stable and may be removed or changed in a future version */
55     case PREFIX(frameIndex_tooLarge): return "Frame index is too large";
56     case PREFIX(seekableIO): return "An I/O error occurred when reading/seeking";
57     case PREFIX(dstBuffer_wrong): return "Destination buffer is wrong";
58     case PREFIX(srcBuffer_wrong): return "Source buffer is wrong";
59     case PREFIX(sequenceProducer_failed): return "Block-level external sequence producer returned an error code";
60     case PREFIX(externalSequences_invalid): return "External sequences are not valid";
61     case PREFIX(maxCode):
62     default: return notErrorCode;
63     }
64 #endif
65 }
66