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