1*01826a49SYabin Cui /*
2*01826a49SYabin Cui * Copyright (c) Meta Platforms, Inc. and affiliates.
3*01826a49SYabin Cui * All rights reserved.
4*01826a49SYabin Cui *
5*01826a49SYabin Cui * This source code is licensed under both the BSD-style license (found in the
6*01826a49SYabin Cui * LICENSE file in the root directory of this source tree) and the GPLv2 (found
7*01826a49SYabin Cui * in the COPYING file in the root directory of this source tree).
8*01826a49SYabin Cui * You may select, at your option, one of the above-listed licenses.
9*01826a49SYabin Cui */
10*01826a49SYabin Cui
11*01826a49SYabin Cui /*
12*01826a49SYabin Cui This program uses hard-coded data compressed with Zstd legacy versions
13*01826a49SYabin Cui and tests that the API decompresses them correctly
14*01826a49SYabin Cui */
15*01826a49SYabin Cui
16*01826a49SYabin Cui /*===========================================
17*01826a49SYabin Cui * Dependencies
18*01826a49SYabin Cui *==========================================*/
19*01826a49SYabin Cui #include <stddef.h> /* size_t */
20*01826a49SYabin Cui #include <stdlib.h> /* malloc, free */
21*01826a49SYabin Cui #include <stdio.h> /* fprintf */
22*01826a49SYabin Cui #include <string.h> /* strlen */
23*01826a49SYabin Cui #define ZSTD_STATIC_LINKING_ONLY /* ZSTD_decompressBound */
24*01826a49SYabin Cui #include "zstd.h"
25*01826a49SYabin Cui #include "zstd_errors.h"
26*01826a49SYabin Cui
27*01826a49SYabin Cui /*===========================================
28*01826a49SYabin Cui * Macros
29*01826a49SYabin Cui *==========================================*/
30*01826a49SYabin Cui #define DISPLAY(...) fprintf(stderr, __VA_ARGS__)
31*01826a49SYabin Cui
32*01826a49SYabin Cui /*===========================================
33*01826a49SYabin Cui * Precompressed frames
34*01826a49SYabin Cui *==========================================*/
35*01826a49SYabin Cui const char* const COMPRESSED; /* content is at end of file */
36*01826a49SYabin Cui size_t const COMPRESSED_SIZE = 917;
37*01826a49SYabin Cui const char* const EXPECTED; /* content is at end of file */
38*01826a49SYabin Cui
39*01826a49SYabin Cui
testSimpleAPI(void)40*01826a49SYabin Cui static int testSimpleAPI(void)
41*01826a49SYabin Cui {
42*01826a49SYabin Cui size_t const size = strlen(EXPECTED);
43*01826a49SYabin Cui char* const output = malloc(size);
44*01826a49SYabin Cui
45*01826a49SYabin Cui if (!output) {
46*01826a49SYabin Cui DISPLAY("ERROR: Not enough memory!\n");
47*01826a49SYabin Cui return 1;
48*01826a49SYabin Cui }
49*01826a49SYabin Cui
50*01826a49SYabin Cui {
51*01826a49SYabin Cui size_t const ret = ZSTD_decompress(output, size, COMPRESSED, COMPRESSED_SIZE);
52*01826a49SYabin Cui if (ZSTD_isError(ret)) {
53*01826a49SYabin Cui if (ret == ZSTD_error_prefix_unknown) {
54*01826a49SYabin Cui DISPLAY("ERROR: Invalid frame magic number, was this compiled "
55*01826a49SYabin Cui "without legacy support?\n");
56*01826a49SYabin Cui } else {
57*01826a49SYabin Cui DISPLAY("ERROR: %s\n", ZSTD_getErrorName(ret));
58*01826a49SYabin Cui }
59*01826a49SYabin Cui return 1;
60*01826a49SYabin Cui }
61*01826a49SYabin Cui if (ret != size) {
62*01826a49SYabin Cui DISPLAY("ERROR: Wrong decoded size\n");
63*01826a49SYabin Cui }
64*01826a49SYabin Cui }
65*01826a49SYabin Cui if (memcmp(EXPECTED, output, size) != 0) {
66*01826a49SYabin Cui DISPLAY("ERROR: Wrong decoded output produced\n");
67*01826a49SYabin Cui return 1;
68*01826a49SYabin Cui }
69*01826a49SYabin Cui
70*01826a49SYabin Cui free(output);
71*01826a49SYabin Cui DISPLAY("Simple API OK\n");
72*01826a49SYabin Cui return 0;
73*01826a49SYabin Cui }
74*01826a49SYabin Cui
75*01826a49SYabin Cui
testStreamingAPI(void)76*01826a49SYabin Cui static int testStreamingAPI(void)
77*01826a49SYabin Cui {
78*01826a49SYabin Cui int error_code = 0;
79*01826a49SYabin Cui size_t const outBuffSize = ZSTD_DStreamOutSize();
80*01826a49SYabin Cui char* const outBuff = malloc(outBuffSize);
81*01826a49SYabin Cui ZSTD_DStream* const stream = ZSTD_createDStream();
82*01826a49SYabin Cui ZSTD_inBuffer input = { COMPRESSED, COMPRESSED_SIZE, 0 };
83*01826a49SYabin Cui size_t outputPos = 0;
84*01826a49SYabin Cui int needsInit = 1;
85*01826a49SYabin Cui
86*01826a49SYabin Cui if (outBuff == NULL) {
87*01826a49SYabin Cui DISPLAY("ERROR: Could not allocate memory\n");
88*01826a49SYabin Cui return 1;
89*01826a49SYabin Cui }
90*01826a49SYabin Cui if (stream == NULL) {
91*01826a49SYabin Cui DISPLAY("ERROR: Could not create dstream\n");
92*01826a49SYabin Cui free(outBuff);
93*01826a49SYabin Cui return 1;
94*01826a49SYabin Cui }
95*01826a49SYabin Cui
96*01826a49SYabin Cui while (1) {
97*01826a49SYabin Cui ZSTD_outBuffer output = {outBuff, outBuffSize, 0};
98*01826a49SYabin Cui if (needsInit) {
99*01826a49SYabin Cui size_t const ret = ZSTD_initDStream(stream);
100*01826a49SYabin Cui if (ZSTD_isError(ret)) {
101*01826a49SYabin Cui DISPLAY("ERROR: ZSTD_initDStream: %s\n", ZSTD_getErrorName(ret));
102*01826a49SYabin Cui error_code = 1;
103*01826a49SYabin Cui break;
104*01826a49SYabin Cui } }
105*01826a49SYabin Cui
106*01826a49SYabin Cui { size_t const ret = ZSTD_decompressStream(stream, &output, &input);
107*01826a49SYabin Cui if (ZSTD_isError(ret)) {
108*01826a49SYabin Cui DISPLAY("ERROR: ZSTD_decompressStream: %s\n", ZSTD_getErrorName(ret));
109*01826a49SYabin Cui error_code = 1;
110*01826a49SYabin Cui break;
111*01826a49SYabin Cui }
112*01826a49SYabin Cui
113*01826a49SYabin Cui if (ret == 0) {
114*01826a49SYabin Cui needsInit = 1;
115*01826a49SYabin Cui } }
116*01826a49SYabin Cui
117*01826a49SYabin Cui if (memcmp(outBuff, EXPECTED + outputPos, output.pos) != 0) {
118*01826a49SYabin Cui DISPLAY("ERROR: Wrong decoded output produced\n");
119*01826a49SYabin Cui error_code = 1;
120*01826a49SYabin Cui break;
121*01826a49SYabin Cui }
122*01826a49SYabin Cui outputPos += output.pos;
123*01826a49SYabin Cui if (input.pos == input.size && output.pos < output.size) {
124*01826a49SYabin Cui break;
125*01826a49SYabin Cui }
126*01826a49SYabin Cui }
127*01826a49SYabin Cui
128*01826a49SYabin Cui free(outBuff);
129*01826a49SYabin Cui ZSTD_freeDStream(stream);
130*01826a49SYabin Cui if (error_code == 0) DISPLAY("Streaming API OK\n");
131*01826a49SYabin Cui return error_code;
132*01826a49SYabin Cui }
133*01826a49SYabin Cui
testFrameDecoding(void)134*01826a49SYabin Cui static int testFrameDecoding(void)
135*01826a49SYabin Cui {
136*01826a49SYabin Cui if (strlen(EXPECTED) > ZSTD_decompressBound(COMPRESSED, COMPRESSED_SIZE)) {
137*01826a49SYabin Cui DISPLAY("ERROR: ZSTD_decompressBound: decompressed bound too small\n");
138*01826a49SYabin Cui return 1;
139*01826a49SYabin Cui }
140*01826a49SYabin Cui { const char* ip = COMPRESSED;
141*01826a49SYabin Cui size_t remainingSize = COMPRESSED_SIZE;
142*01826a49SYabin Cui while (1) {
143*01826a49SYabin Cui size_t frameSize = ZSTD_findFrameCompressedSize(ip, remainingSize);
144*01826a49SYabin Cui if (ZSTD_isError(frameSize)) {
145*01826a49SYabin Cui DISPLAY("ERROR: ZSTD_findFrameCompressedSize: %s\n", ZSTD_getErrorName(frameSize));
146*01826a49SYabin Cui return 1;
147*01826a49SYabin Cui }
148*01826a49SYabin Cui if (frameSize > remainingSize) {
149*01826a49SYabin Cui DISPLAY("ERROR: ZSTD_findFrameCompressedSize: expected frameSize to align with src buffer");
150*01826a49SYabin Cui return 1;
151*01826a49SYabin Cui }
152*01826a49SYabin Cui ip += frameSize;
153*01826a49SYabin Cui remainingSize -= frameSize;
154*01826a49SYabin Cui if (remainingSize == 0) break;
155*01826a49SYabin Cui }
156*01826a49SYabin Cui }
157*01826a49SYabin Cui DISPLAY("Frame Decoding OK\n");
158*01826a49SYabin Cui return 0;
159*01826a49SYabin Cui }
160*01826a49SYabin Cui
main(void)161*01826a49SYabin Cui int main(void)
162*01826a49SYabin Cui {
163*01826a49SYabin Cui { int const ret = testSimpleAPI();
164*01826a49SYabin Cui if (ret) return ret; }
165*01826a49SYabin Cui { int const ret = testStreamingAPI();
166*01826a49SYabin Cui if (ret) return ret; }
167*01826a49SYabin Cui { int const ret = testFrameDecoding();
168*01826a49SYabin Cui if (ret) return ret; }
169*01826a49SYabin Cui
170*01826a49SYabin Cui DISPLAY("OK\n");
171*01826a49SYabin Cui return 0;
172*01826a49SYabin Cui }
173*01826a49SYabin Cui
174*01826a49SYabin Cui /* Consists of the "EXPECTED" string compressed with default settings on
175*01826a49SYabin Cui - v0.4.3
176*01826a49SYabin Cui - v0.5.0
177*01826a49SYabin Cui - v0.6.0
178*01826a49SYabin Cui - v0.7.0
179*01826a49SYabin Cui - v0.8.0
180*01826a49SYabin Cui */
181*01826a49SYabin Cui const char* const COMPRESSED =
182*01826a49SYabin Cui "\x24\xB5\x2F\xFD\x00\x00\x00\xBB\xB0\x02\xC0\x10\x00\x1E\xB0\x01"
183*01826a49SYabin Cui "\x02\x00\x00\x80\x00\xE8\x92\x34\x12\x97\xC8\xDF\xE9\xF3\xEF\x53"
184*01826a49SYabin Cui "\xEA\x1D\x27\x4F\x0C\x44\x90\x0C\x8D\xF1\xB4\x89\x17\x00\x18\x00"
185*01826a49SYabin Cui "\x18\x00\x3F\xE6\xE2\xE3\x74\xD6\xEC\xC9\x4A\xE0\x71\x71\x42\x3E"
186*01826a49SYabin Cui "\x64\x4F\x6A\x45\x4E\x78\xEC\x49\x03\x3F\xC6\x80\xAB\x8F\x75\x5E"
187*01826a49SYabin Cui "\x6F\x2E\x3E\x7E\xC6\xDC\x45\x69\x6C\xC5\xFD\xC7\x40\xB8\x84\x8A"
188*01826a49SYabin Cui "\x01\xEB\xA8\xD1\x40\x39\x90\x4C\x64\xF8\xEB\x53\xE6\x18\x0B\x67"
189*01826a49SYabin Cui "\x12\xAD\xB8\x99\xB3\x5A\x6F\x8A\x19\x03\x01\x50\x67\x56\xF5\x9F"
190*01826a49SYabin Cui "\x35\x84\x60\xA0\x60\x91\xC9\x0A\xDC\xAB\xAB\xE0\xE2\x81\xFA\xCF"
191*01826a49SYabin Cui "\xC6\xBA\x01\x0E\x00\x54\x00\x00\x19\x00\x00\x54\x14\x00\x24\x24"
192*01826a49SYabin Cui "\x04\xFE\x04\x84\x4E\x41\x00\x27\xE2\x02\xC4\xB1\x00\xD2\x51\x00"
193*01826a49SYabin Cui "\x79\x58\x41\x28\x00\xE0\x0C\x01\x68\x65\x00\x04\x13\x0C\xDA\x0C"
194*01826a49SYabin Cui "\x80\x22\x06\xC0\x00\x00\x25\xB5\x2F\xFD\x00\x00\x00\xAD\x12\xB0"
195*01826a49SYabin Cui "\x7D\x1E\xB0\x01\x02\x00\x00\x80\x00\xE8\x92\x34\x12\x97\xC8\xDF"
196*01826a49SYabin Cui "\xE9\xF3\xEF\x53\xEA\x1D\x27\x4F\x0C\x44\x90\x0C\x8D\xF1\xB4\x89"
197*01826a49SYabin Cui "\x03\x01\x50\x67\x56\xF5\x9F\x35\x84\x60\xA0\x60\x91\xC9\x0A\xDC"
198*01826a49SYabin Cui "\xAB\xAB\xE0\xE2\x81\xFA\xCF\xC6\xBA\xEB\xA8\xD1\x40\x39\x90\x4C"
199*01826a49SYabin Cui "\x64\xF8\xEB\x53\xE6\x18\x0B\x67\x12\xAD\xB8\x99\xB3\x5A\x6F\x8A"
200*01826a49SYabin Cui "\xF9\x63\x0C\xB8\xFA\x58\xE7\xF5\xE6\xE2\xE3\x67\xCC\x5D\x94\xC6"
201*01826a49SYabin Cui "\x56\xDC\x7F\x0C\x84\x4B\xA8\xF8\x63\x2E\x3E\x4E\x67\xCD\x9E\xAC"
202*01826a49SYabin Cui "\x04\x1E\x17\x27\xE4\x43\xF6\xA4\x56\xE4\x84\xC7\x9E\x34\x0E\x00"
203*01826a49SYabin Cui "\x00\x32\x40\x80\xA8\x00\x01\x49\x81\xE0\x3C\x01\x29\x1D\x00\x87"
204*01826a49SYabin Cui "\xCE\x80\x75\x08\x80\x72\x24\x00\x7B\x52\x00\x94\x00\x20\xCC\x01"
205*01826a49SYabin Cui "\x86\xD2\x00\x81\x09\x83\xC1\x34\xA0\x88\x01\xC0\x00\x00\x26\xB5"
206*01826a49SYabin Cui "\x2F\xFD\x42\xEF\x00\x00\xA6\x12\xB0\x7D\x1E\xB0\x01\x02\x00\x00"
207*01826a49SYabin Cui "\x54\xA0\xBA\x24\x8D\xC4\x25\xF2\x77\xFA\xFC\xFB\x94\x7A\xC7\xC9"
208*01826a49SYabin Cui "\x13\x03\x11\x24\x43\x63\x3C\x6D\x22\x03\x01\x50\x67\x56\xF5\x9F"
209*01826a49SYabin Cui "\x35\x84\x60\xA0\x60\x91\xC9\x0A\xDC\xAB\xAB\xE0\xE2\x81\xFA\xCF"
210*01826a49SYabin Cui "\xC6\xBA\xEB\xA8\xD1\x40\x39\x90\x4C\x64\xF8\xEB\x53\xE6\x18\x0B"
211*01826a49SYabin Cui "\x67\x12\xAD\xB8\x99\xB3\x5A\x6F\x8A\xF9\x63\x0C\xB8\xFA\x58\xE7"
212*01826a49SYabin Cui "\xF5\xE6\xE2\xE3\x67\xCC\x5D\x94\xC6\x56\xDC\x7F\x0C\x84\x4B\xA8"
213*01826a49SYabin Cui "\xF8\x63\x2E\x3E\x4E\x67\xCD\x9E\xAC\x04\x1E\x17\x27\xE4\x43\xF6"
214*01826a49SYabin Cui "\xA4\x56\xE4\x84\xC7\x9E\x34\x0E\x00\x35\x0B\x71\xB5\xC0\x2A\x5C"
215*01826a49SYabin Cui "\x26\x94\x22\x20\x8B\x4C\x8D\x13\x47\x58\x67\x15\x6C\xF1\x1C\x4B"
216*01826a49SYabin Cui "\x54\x10\x9D\x31\x50\x85\x4B\x54\x0E\x01\x4B\x3D\x01\xC0\x00\x00"
217*01826a49SYabin Cui "\x27\xB5\x2F\xFD\x20\xEF\x00\x00\xA6\x12\xE4\x84\x1F\xB0\x01\x10"
218*01826a49SYabin Cui "\x00\x00\x00\x35\x59\xA6\xE7\xA1\xEF\x7C\xFC\xBD\x3F\xFF\x9F\xEF"
219*01826a49SYabin Cui "\xEE\xEF\x61\xC3\xAA\x31\x1D\x34\x38\x22\x22\x04\x44\x21\x80\x32"
220*01826a49SYabin Cui "\xAD\x28\xF3\xD6\x28\x0C\x0A\x0E\xD6\x5C\xAC\x19\x8D\x20\x5F\x45"
221*01826a49SYabin Cui "\x02\x2E\x17\x50\x66\x6D\xAC\x8B\x9C\x6E\x07\x73\x46\xBB\x44\x14"
222*01826a49SYabin Cui "\xE7\x98\xC3\xB9\x17\x32\x6E\x33\x7C\x0E\x21\xB1\xDB\xCB\x89\x51"
223*01826a49SYabin Cui "\x23\x34\xAB\x9D\xBC\x6D\x20\xF5\x03\xA9\x91\x4C\x2E\x1F\x59\xDB"
224*01826a49SYabin Cui "\xD9\x35\x67\x4B\x0C\x95\x79\x10\x00\x85\xA6\x96\x95\x2E\xDF\x78"
225*01826a49SYabin Cui "\x7B\x4A\x5C\x09\x76\x97\xD1\x5C\x96\x12\x75\x35\xA3\x55\x4A\xD4"
226*01826a49SYabin Cui "\x0B\x00\x35\x0B\x71\xB5\xC0\x2A\x5C\xE6\x08\x45\xF1\x39\x43\xF1"
227*01826a49SYabin Cui "\x1C\x4B\x54\x10\x9D\x31\x50\x85\x4B\x54\x0E\x01\x4B\x3D\x01\xC0"
228*01826a49SYabin Cui "\x00\x00\x28\xB5\x2F\xFD\x24\xEF\x35\x05\x00\x92\x0B\x21\x1F\xB0"
229*01826a49SYabin Cui "\x01\x10\x00\x00\x00\x35\x59\xA6\xE7\xA1\xEF\x7C\xFC\xBD\x3F\xFF"
230*01826a49SYabin Cui "\x9F\xEF\xEE\xEF\x61\xC3\xAA\x31\x1D\x34\x38\x22\x22\x04\x44\x21"
231*01826a49SYabin Cui "\x80\x32\xAD\x28\xF3\xD6\x28\x0C\x0A\x0E\xD6\x5C\xAC\x19\x8D\x20"
232*01826a49SYabin Cui "\x5F\x45\x02\x2E\x17\x50\x66\x6D\xAC\x8B\x9C\x6E\x07\x73\x46\xBB"
233*01826a49SYabin Cui "\x44\x14\xE7\x98\xC3\xB9\x17\x32\x6E\x33\x7C\x0E\x21\xB1\xDB\xCB"
234*01826a49SYabin Cui "\x89\x51\x23\x34\xAB\x9D\xBC\x6D\x20\xF5\x03\xA9\x91\x4C\x2E\x1F"
235*01826a49SYabin Cui "\x59\xDB\xD9\x35\x67\x4B\x0C\x95\x79\x10\x00\x85\xA6\x96\x95\x2E"
236*01826a49SYabin Cui "\xDF\x78\x7B\x4A\x5C\x09\x76\x97\xD1\x5C\x96\x12\x75\x35\xA3\x55"
237*01826a49SYabin Cui "\x4A\xD4\x0B\x00\x35\x0B\x71\xB5\xC0\x2A\x5C\xE6\x08\x45\xF1\x39"
238*01826a49SYabin Cui "\x43\xF1\x1C\x4B\x54\x10\x9D\x31\x50\x85\x4B\x54\x0E\x01\x4B\x3D"
239*01826a49SYabin Cui "\x01\xD2\x2F\x21\x80";
240*01826a49SYabin Cui
241*01826a49SYabin Cui const char* const EXPECTED =
242*01826a49SYabin Cui "snowden is snowed in / he's now then in his snow den / when does the snow end?\n"
243*01826a49SYabin Cui "goodbye little dog / you dug some holes in your day / they'll be hard to fill.\n"
244*01826a49SYabin Cui "when life shuts a door, / just open it. it’s a door. / that is how doors work.\n"
245*01826a49SYabin Cui
246*01826a49SYabin Cui "snowden is snowed in / he's now then in his snow den / when does the snow end?\n"
247*01826a49SYabin Cui "goodbye little dog / you dug some holes in your day / they'll be hard to fill.\n"
248*01826a49SYabin Cui "when life shuts a door, / just open it. it’s a door. / that is how doors work.\n"
249*01826a49SYabin Cui
250*01826a49SYabin Cui "snowden is snowed in / he's now then in his snow den / when does the snow end?\n"
251*01826a49SYabin Cui "goodbye little dog / you dug some holes in your day / they'll be hard to fill.\n"
252*01826a49SYabin Cui "when life shuts a door, / just open it. it’s a door. / that is how doors work.\n"
253*01826a49SYabin Cui
254*01826a49SYabin Cui "snowden is snowed in / he's now then in his snow den / when does the snow end?\n"
255*01826a49SYabin Cui "goodbye little dog / you dug some holes in your day / they'll be hard to fill.\n"
256*01826a49SYabin Cui "when life shuts a door, / just open it. it’s a door. / that is how doors work.\n"
257*01826a49SYabin Cui
258*01826a49SYabin Cui "snowden is snowed in / he's now then in his snow den / when does the snow end?\n"
259*01826a49SYabin Cui "goodbye little dog / you dug some holes in your day / they'll be hard to fill.\n"
260*01826a49SYabin Cui "when life shuts a door, / just open it. it’s a door. / that is how doors work.\n";
261