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