add dedicated error code for special case

ZSTD_compressSequencesAndLiterals() cannot produce an uncompressed block
facebook · Dec 19, 2024 · 625bba9 · 625bba9
1 parent 5e5bf2b
commit 625bba9
Show file tree

Hide file tree

Showing 4 changed files with 3 additions and 2 deletions.
diff --git a/doc/zstd_manual.html b/doc/zstd_manual.html
@@ -1431,7 +1431,6 @@ <h3>Streaming decompression functions</h3><pre></pre><b><pre></pre></b><BR>
  but it also features the following limitations:
  - Only supports explicit delimiter mode
  - Not compatible with frame checksum, which must disabled
- - Does not write the content size in frame header
  - If any block is incompressible, will fail and return an error
  - @litSize must be == sum of all @.litLength fields in @inSeqs. Any discrepancy will generate an error.
  - the buffer @literals must be larger than @litSize by at least 8 bytes.

diff --git a/lib/common/error_private.c b/lib/common/error_private.c
@@ -40,6 +40,7 @@ const char* ERR_getErrorString(ERR_enum code)
     case PREFIX(tableLog_tooLarge): return "tableLog requires too much memory : unsupported";
     case PREFIX(maxSymbolValue_tooLarge): return "Unsupported max Symbol Value : too large";
     case PREFIX(maxSymbolValue_tooSmall): return "Specified maxSymbolValue is too small";
+    case PREFIX(cannotProduce_uncompressedBlock): return "This mode cannot generate an uncompressed block";
     case PREFIX(stabilityCondition_notRespected): return "pledged buffer stability condition is not respected";
     case PREFIX(dictionary_corrupted): return "Dictionary is corrupted";
     case PREFIX(dictionary_wrong): return "Dictionary mismatch";

diff --git a/lib/compress/zstd_compress.c b/lib/compress/zstd_compress.c
@@ -7254,7 +7254,7 @@ ZSTD_compressSequencesAndLiterals_internal(ZSTD_CCtx* cctx,
              * but it's complex, and memory hungry, killing the purpose of this variant.
              * Current outcome: generate an error code.
              */
-            RETURN_ERROR(dstSize_tooSmall, "Data is not compressible"); /* note: error code could be clearer */
+            RETURN_ERROR(cannotProduce_uncompressedBlock, "ZSTD_compressSequencesAndLiterals cannot generate an uncompressed block");
         } else {
             U32 cBlockHeader;
             assert(compressedSeqsSize > 1); /* no RLE */

diff --git a/lib/zstd_errors.h b/lib/zstd_errors.h
@@ -76,6 +76,7 @@ typedef enum {
   ZSTD_error_tableLog_tooLarge       = 44,
   ZSTD_error_maxSymbolValue_tooLarge = 46,
   ZSTD_error_maxSymbolValue_tooSmall = 48,
+  ZSTD_error_cannotProduce_uncompressedBlock = 49,
   ZSTD_error_stabilityCondition_notRespected = 50,
   ZSTD_error_stage_wrong       = 60,
   ZSTD_error_init_missing      = 62,