]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/journal/test-compress.c
license: LGPL-2.1+ -> LGPL-2.1-or-later
[thirdparty/systemd.git] / src / journal / test-compress.c
CommitLineData
db9ecf05 1/* SPDX-License-Identifier: LGPL-2.1-or-later */
843fecc0 2
ca78ad1d
ZJS
3#include <sys/stat.h>
4
349cc4a5 5#if HAVE_LZ4
e3cc7fc4
ZJS
6#include <lz4.h>
7#endif
8
b5efdb8a 9#include "alloc-util.h"
843fecc0 10#include "compress.h"
3ffd4af2 11#include "fd-util.h"
627d2bac 12#include "fs-util.h"
843fecc0 13#include "macro.h"
0a970718 14#include "memory-util.h"
69847060 15#include "path-util.h"
3df3e884 16#include "random-util.h"
6d7c4033 17#include "tests.h"
e4de7287 18#include "tmpfile-util.h"
843fecc0 19
349cc4a5 20#if HAVE_XZ
d89c8fdf
ZJS
21# define XZ_OK 0
22#else
23# define XZ_OK -EPROTONOSUPPORT
24#endif
25
349cc4a5 26#if HAVE_LZ4
d89c8fdf
ZJS
27# define LZ4_OK 0
28#else
29# define LZ4_OK -EPROTONOSUPPORT
30#endif
31
2e408606
MK
32#define HUGE_SIZE (4096*1024)
33
d89c8fdf 34typedef int (compress_blob_t)(const void *src, uint64_t src_size,
5d6f46b6 35 void *dst, size_t dst_alloc_size, size_t *dst_size);
d89c8fdf 36typedef int (decompress_blob_t)(const void *src, uint64_t src_size,
fa1c4b51
ZJS
37 void **dst, size_t *dst_alloc_size,
38 size_t* dst_size, size_t dst_max);
d89c8fdf 39typedef int (decompress_sw_t)(const void *src, uint64_t src_size,
fa1c4b51
ZJS
40 void **buffer, size_t *buffer_size,
41 const void *prefix, size_t prefix_len,
d89c8fdf
ZJS
42 uint8_t extra);
43
59f448cf
LP
44typedef int (compress_stream_t)(int fdf, int fdt, uint64_t max_bytes);
45typedef int (decompress_stream_t)(int fdf, int fdt, uint64_t max_size);
d89c8fdf 46
d80b051c 47#if HAVE_COMPRESSION
ef5924aa
NL
48_unused_ static void test_compress_decompress(const char *compression,
49 compress_blob_t compress,
50 decompress_blob_t decompress,
51 const char *data,
52 size_t data_len,
53 bool may_fail) {
843fecc0 54 char compressed[512];
5d6f46b6 55 size_t csize, usize = 0;
d89c8fdf
ZJS
56 _cleanup_free_ char *decompressed = NULL;
57 int r;
58
c552d602 59 log_info("/* testing %s %s blob compression/decompression */",
ef5924aa 60 compression, data);
c552d602 61
5d6f46b6 62 r = compress(data, data_len, compressed, sizeof(compressed), &csize);
c552d602 63 if (r == -ENOBUFS) {
da927ba9 64 log_info_errno(r, "compression failed: %m");
787784c4 65 assert_se(may_fail);
c552d602 66 } else {
787784c4 67 assert_se(r == 0);
c552d602
ZJS
68 r = decompress(compressed, csize,
69 (void **) &decompressed, &usize, &csize, 0);
787784c4 70 assert_se(r == 0);
c552d602
ZJS
71 assert_se(decompressed);
72 assert_se(memcmp(decompressed, data, data_len) == 0);
73 }
d89c8fdf
ZJS
74
75 r = decompress("garbage", 7,
76 (void **) &decompressed, &usize, &csize, 0);
787784c4 77 assert_se(r < 0);
d89c8fdf
ZJS
78
79 /* make sure to have the minimal lz4 compressed size */
80 r = decompress("00000000\1g", 9,
81 (void **) &decompressed, &usize, &csize, 0);
787784c4 82 assert_se(r < 0);
d89c8fdf
ZJS
83
84 r = decompress("\100000000g", 9,
85 (void **) &decompressed, &usize, &csize, 0);
787784c4 86 assert_se(r < 0);
d89c8fdf
ZJS
87
88 memzero(decompressed, usize);
843fecc0
RC
89}
90
ef5924aa
NL
91_unused_ static void test_decompress_startswith(const char *compression,
92 compress_blob_t compress,
93 decompress_sw_t decompress_sw,
94 const char *data,
95 size_t data_len,
96 bool may_fail) {
d89c8fdf 97
ae5e1b19
ZJS
98 char *compressed;
99 _cleanup_free_ char *compressed1 = NULL, *compressed2 = NULL, *decompressed = NULL;
100 size_t csize, usize = 0, len;
c552d602 101 int r;
d89c8fdf 102
13e785f7 103 log_info("/* testing decompress_startswith with %s on %.20s text */",
ef5924aa 104 compression, data);
c552d602 105
ae5e1b19
ZJS
106#define BUFSIZE_1 512
107#define BUFSIZE_2 20000
108
109 compressed = compressed1 = malloc(BUFSIZE_1);
110 assert_se(compressed1);
111 r = compress(data, data_len, compressed, BUFSIZE_1, &csize);
c552d602 112 if (r == -ENOBUFS) {
da927ba9 113 log_info_errno(r, "compression failed: %m");
787784c4 114 assert_se(may_fail);
ae5e1b19
ZJS
115
116 compressed = compressed2 = malloc(BUFSIZE_2);
117 assert_se(compressed2);
118 r = compress(data, data_len, compressed, BUFSIZE_2, &csize);
119 assert(r == 0);
c552d602 120 }
787784c4 121 assert_se(r == 0);
d89c8fdf 122
ae5e1b19
ZJS
123 len = strlen(data);
124
125 r = decompress_sw(compressed, csize, (void **) &decompressed, &usize, data, len, '\0');
126 assert_se(r > 0);
127 r = decompress_sw(compressed, csize, (void **) &decompressed, &usize, data, len, 'w');
128 assert_se(r == 0);
129 r = decompress_sw(compressed, csize, (void **) &decompressed, &usize, "barbarbar", 9, ' ');
130 assert_se(r == 0);
131 r = decompress_sw(compressed, csize, (void **) &decompressed, &usize, data, len - 1, data[len-1]);
132 assert_se(r > 0);
133 r = decompress_sw(compressed, csize, (void **) &decompressed, &usize, data, len - 1, 'w');
134 assert_se(r == 0);
135 r = decompress_sw(compressed, csize, (void **) &decompressed, &usize, data, len, '\0');
136 assert_se(r > 0);
843fecc0
RC
137}
138
ef5924aa
NL
139_unused_ static void test_decompress_startswith_short(const char *compression,
140 compress_blob_t compress,
141 decompress_sw_t decompress_sw) {
ba17efce
ZJS
142
143#define TEXT "HUGE=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
144
145 char buf[1024];
146 size_t i, csize;
147 int r;
148
ef5924aa 149 log_info("/* %s with %s */", __func__, compression);
ba17efce
ZJS
150
151 r = compress(TEXT, sizeof TEXT, buf, sizeof buf, &csize);
152 assert_se(r == 0);
153
154 for (i = 1; i < strlen(TEXT); i++) {
155 size_t alloc_size = i;
156 _cleanup_free_ void *buf2 = NULL;
157
158 assert_se(buf2 = malloc(i));
159
160 assert_se(decompress_sw(buf, csize, &buf2, &alloc_size, TEXT, i, TEXT[i]) == 1);
161 assert_se(decompress_sw(buf, csize, &buf2, &alloc_size, TEXT, i, 'y') == 0);
162 }
163}
164
ef5924aa
NL
165_unused_ static void test_compress_stream(const char *compression,
166 const char *cat,
167 compress_stream_t compress,
168 decompress_stream_t decompress,
169 const char *srcfile) {
d89c8fdf 170
355b59e2 171 _cleanup_close_ int src = -1, dst = -1, dst2 = -1;
627d2bac
ZJS
172 _cleanup_(unlink_tempfilep) char
173 pattern[] = "/tmp/systemd-test.compressed.XXXXXX",
174 pattern2[] = "/tmp/systemd-test.compressed.XXXXXX";
355b59e2 175 int r;
69847060 176 _cleanup_free_ char *cmd = NULL, *cmd2 = NULL;
355b59e2
ZJS
177 struct stat st = {};
178
f7bc0c32 179 r = find_executable(cat, NULL);
69847060
LP
180 if (r < 0) {
181 log_error_errno(r, "Skipping %s, could not find %s binary: %m", __func__, cat);
182 return;
183 }
184
ef5924aa 185 log_debug("/* testing %s compression */", compression);
d89c8fdf 186
355b59e2
ZJS
187 log_debug("/* create source from %s */", srcfile);
188
189 assert_se((src = open(srcfile, O_RDONLY|O_CLOEXEC)) >= 0);
190
191 log_debug("/* test compression */");
192
646853bd 193 assert_se((dst = mkostemp_safe(pattern)) >= 0);
355b59e2 194
52754725 195 assert_se(compress(src, dst, -1) == 0);
355b59e2 196
d89c8fdf
ZJS
197 if (cat) {
198 assert_se(asprintf(&cmd, "%s %s | diff %s -", cat, pattern, srcfile) > 0);
52754725 199 assert_se(system(cmd) == 0);
d89c8fdf 200 }
355b59e2
ZJS
201
202 log_debug("/* test decompression */");
203
646853bd 204 assert_se((dst2 = mkostemp_safe(pattern2)) >= 0);
355b59e2
ZJS
205
206 assert_se(stat(srcfile, &st) == 0);
207
208 assert_se(lseek(dst, 0, SEEK_SET) == 0);
d89c8fdf 209 r = decompress(dst, dst2, st.st_size);
0c0cdb06 210 assert_se(r == 0);
355b59e2
ZJS
211
212 assert_se(asprintf(&cmd2, "diff %s %s", srcfile, pattern2) > 0);
213 assert_se(system(cmd2) == 0);
214
215 log_debug("/* test faulty decompression */");
216
217 assert_se(lseek(dst, 1, SEEK_SET) == 1);
d89c8fdf 218 r = decompress(dst, dst2, st.st_size);
4c701096 219 assert_se(IN_SET(r, 0, -EBADMSG));
355b59e2
ZJS
220
221 assert_se(lseek(dst, 0, SEEK_SET) == 0);
222 assert_se(lseek(dst2, 0, SEEK_SET) == 0);
d89c8fdf 223 r = decompress(dst, dst2, st.st_size - 1);
0c0cdb06 224 assert_se(r == -EFBIG);
355b59e2 225}
ccc717fa 226#endif
355b59e2 227
349cc4a5 228#if HAVE_LZ4
e3cc7fc4 229static void test_lz4_decompress_partial(void) {
e41ef6fd 230 char buf[20000], buf2[100];
e3cc7fc4
ZJS
231 size_t buf_size = sizeof(buf), compressed;
232 int r;
ae5e1b19 233 _cleanup_free_ char *huge = NULL;
e3cc7fc4 234
e4a321fc
ZJS
235 log_debug("/* %s */", __func__);
236
e41ef6fd 237 assert_se(huge = malloc(HUGE_SIZE));
3c14dc61
TM
238 memcpy(huge, "HUGE=", STRLEN("HUGE="));
239 memset(&huge[STRLEN("HUGE=")], 'x', HUGE_SIZE - STRLEN("HUGE=") - 1);
240 huge[HUGE_SIZE - 1] = '\0';
e3cc7fc4 241
777fe71f 242 r = LZ4_compress_default(huge, buf, HUGE_SIZE, buf_size);
e3cc7fc4
ZJS
243 assert_se(r >= 0);
244 compressed = r;
ae5e1b19 245 log_info("Compressed %i → %zu", HUGE_SIZE, compressed);
e3cc7fc4 246
ae5e1b19 247 r = LZ4_decompress_safe(buf, huge, r, HUGE_SIZE);
e3cc7fc4
ZJS
248 assert_se(r >= 0);
249 log_info("Decompressed → %i", r);
250
251 r = LZ4_decompress_safe_partial(buf, huge,
252 compressed,
ae5e1b19 253 12, HUGE_SIZE);
e3cc7fc4 254 assert_se(r >= 0);
ae5e1b19 255 log_info("Decompressed partial %i/%i → %i", 12, HUGE_SIZE, r);
e3cc7fc4 256
e41ef6fd
ZJS
257 for (size_t size = 1; size < sizeof(buf2); size++) {
258 /* This failed in older lz4s but works in newer ones. */
259 r = LZ4_decompress_safe_partial(buf, buf2, compressed, size, size);
260 log_info("Decompressed partial %zu/%zu → %i (%s)", size, size, r,
261 r < 0 ? "bad" : "good");
262 if (r >= 0 && LZ4_versionNumber() >= 10803)
263 /* lz4 <= 1.8.2 should fail that test, let's only check for newer ones */
264 assert_se(memcmp(buf2, huge, r) == 0);
265 }
e3cc7fc4
ZJS
266}
267#endif
268
843fecc0 269int main(int argc, char *argv[]) {
d80b051c 270#if HAVE_COMPRESSION
ef5924aa 271 _unused_ const char text[] =
c552d602
ZJS
272 "text\0foofoofoofoo AAAA aaaaaaaaa ghost busters barbarbar FFF"
273 "foofoofoofoo AAAA aaaaaaaaa ghost busters barbarbar FFF";
274
3e216115
ZJS
275 /* The file to test compression on can be specified as the first argument */
276 const char *srcfile = argc > 1 ? argv[1] : argv[0];
277
c552d602 278 char data[512] = "random\0";
355b59e2 279
3c14dc61
TM
280 _cleanup_free_ char *huge = NULL;
281
282 assert_se(huge = malloc(HUGE_SIZE));
283 memcpy(huge, "HUGE=", STRLEN("HUGE="));
284 memset(&huge[STRLEN("HUGE=")], 'x', HUGE_SIZE - STRLEN("HUGE=") - 1);
285 huge[HUGE_SIZE - 1] = '\0';
ae5e1b19 286
6d7c4033 287 test_setup_logging(LOG_DEBUG);
355b59e2 288
c552d602
ZJS
289 random_bytes(data + 7, sizeof(data) - 7);
290
349cc4a5 291#if HAVE_XZ
ef5924aa 292 test_compress_decompress("XZ", compress_blob_xz, decompress_blob_xz,
c552d602 293 text, sizeof(text), false);
ef5924aa 294 test_compress_decompress("XZ", compress_blob_xz, decompress_blob_xz,
c552d602 295 data, sizeof(data), true);
ae5e1b19 296
ef5924aa 297 test_decompress_startswith("XZ",
c552d602
ZJS
298 compress_blob_xz, decompress_startswith_xz,
299 text, sizeof(text), false);
ef5924aa 300 test_decompress_startswith("XZ",
c552d602
ZJS
301 compress_blob_xz, decompress_startswith_xz,
302 data, sizeof(data), true);
ef5924aa 303 test_decompress_startswith("XZ",
ae5e1b19 304 compress_blob_xz, decompress_startswith_xz,
3c14dc61 305 huge, HUGE_SIZE, true);
ae5e1b19 306
ef5924aa 307 test_compress_stream("XZ", "xzcat",
3e216115 308 compress_stream_xz, decompress_stream_xz, srcfile);
ba17efce 309
ef5924aa 310 test_decompress_startswith_short("XZ", compress_blob_xz, decompress_startswith_xz);
ba17efce 311
d89c8fdf
ZJS
312#else
313 log_info("/* XZ test skipped */");
314#endif
c552d602 315
349cc4a5 316#if HAVE_LZ4
ef5924aa 317 test_compress_decompress("LZ4", compress_blob_lz4, decompress_blob_lz4,
c552d602 318 text, sizeof(text), false);
ef5924aa 319 test_compress_decompress("LZ4", compress_blob_lz4, decompress_blob_lz4,
c552d602 320 data, sizeof(data), true);
ae5e1b19 321
ef5924aa 322 test_decompress_startswith("LZ4",
c552d602
ZJS
323 compress_blob_lz4, decompress_startswith_lz4,
324 text, sizeof(text), false);
ef5924aa 325 test_decompress_startswith("LZ4",
c552d602
ZJS
326 compress_blob_lz4, decompress_startswith_lz4,
327 data, sizeof(data), true);
ef5924aa 328 test_decompress_startswith("LZ4",
ae5e1b19 329 compress_blob_lz4, decompress_startswith_lz4,
3c14dc61 330 huge, HUGE_SIZE, true);
d89c8fdf 331
ef5924aa 332 test_compress_stream("LZ4", "lz4cat",
3e216115 333 compress_stream_lz4, decompress_stream_lz4, srcfile);
e3cc7fc4
ZJS
334
335 test_lz4_decompress_partial();
ba17efce 336
ef5924aa 337 test_decompress_startswith_short("LZ4", compress_blob_lz4, decompress_startswith_lz4);
ba17efce 338
d89c8fdf
ZJS
339#else
340 log_info("/* LZ4 test skipped */");
341#endif
843fecc0 342
ef5924aa 343#if HAVE_ZSTD
8653185a
LP
344 test_compress_decompress("ZSTD", compress_blob_zstd, decompress_blob_zstd,
345 text, sizeof(text), false);
346 test_compress_decompress("ZSTD", compress_blob_zstd, decompress_blob_zstd,
347 data, sizeof(data), true);
348
349 test_decompress_startswith("ZSTD",
350 compress_blob_zstd, decompress_startswith_zstd,
351 text, sizeof(text), false);
352 test_decompress_startswith("ZSTD",
353 compress_blob_zstd, decompress_startswith_zstd,
354 data, sizeof(data), true);
355 test_decompress_startswith("ZSTD",
356 compress_blob_zstd, decompress_startswith_zstd,
357 huge, HUGE_SIZE, true);
358
ef5924aa
NL
359 test_compress_stream("ZSTD", "zstdcat",
360 compress_stream_zstd, decompress_stream_zstd, srcfile);
8653185a
LP
361
362 test_decompress_startswith_short("ZSTD", compress_blob_zstd, decompress_startswith_zstd);
ef5924aa
NL
363#else
364 log_info("/* ZSTD test skipped */");
365#endif
366
843fecc0 367 return 0;
ccc717fa 368#else
ef5924aa 369 log_info("/* XZ, LZ4 and ZSTD tests skipped */");
ccc717fa
ZJS
370 return EXIT_TEST_SKIP;
371#endif
843fecc0 372}