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