]> git.ipfire.org Git - thirdparty/systemd.git/blame - src/journal/test-compress.c
tree-wide: beautify remaining copyright statements
[thirdparty/systemd.git] / src / journal / test-compress.c
CommitLineData
53e1b683 1/* SPDX-License-Identifier: LGPL-2.1+ */
843fecc0 2/***
96b2fb93 3 Copyright © 2014 Ronny Chevalier
843fecc0
RC
4***/
5
349cc4a5 6#if HAVE_LZ4
e3cc7fc4
ZJS
7#include <lz4.h>
8#endif
9
b5efdb8a 10#include "alloc-util.h"
843fecc0 11#include "compress.h"
3ffd4af2 12#include "fd-util.h"
0d39fa9c 13#include "fileio.h"
627d2bac 14#include "fs-util.h"
843fecc0 15#include "macro.h"
69847060 16#include "path-util.h"
3df3e884 17#include "random-util.h"
3ffd4af2 18#include "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
d89c8fdf
ZJS
137static void test_compress_stream(int compression,
138 const char* cat,
139 compress_stream_t compress,
140 decompress_stream_t decompress,
141 const char *srcfile) {
142
355b59e2 143 _cleanup_close_ int src = -1, dst = -1, dst2 = -1;
627d2bac
ZJS
144 _cleanup_(unlink_tempfilep) char
145 pattern[] = "/tmp/systemd-test.compressed.XXXXXX",
146 pattern2[] = "/tmp/systemd-test.compressed.XXXXXX";
355b59e2 147 int r;
69847060 148 _cleanup_free_ char *cmd = NULL, *cmd2 = NULL;
355b59e2
ZJS
149 struct stat st = {};
150
69847060
LP
151 r = find_binary(cat, NULL);
152 if (r < 0) {
153 log_error_errno(r, "Skipping %s, could not find %s binary: %m", __func__, cat);
154 return;
155 }
156
d89c8fdf
ZJS
157 log_debug("/* testing %s compression */",
158 object_compressed_to_string(compression));
159
355b59e2
ZJS
160 log_debug("/* create source from %s */", srcfile);
161
162 assert_se((src = open(srcfile, O_RDONLY|O_CLOEXEC)) >= 0);
163
164 log_debug("/* test compression */");
165
646853bd 166 assert_se((dst = mkostemp_safe(pattern)) >= 0);
355b59e2 167
52754725 168 assert_se(compress(src, dst, -1) == 0);
355b59e2 169
d89c8fdf
ZJS
170 if (cat) {
171 assert_se(asprintf(&cmd, "%s %s | diff %s -", cat, pattern, srcfile) > 0);
52754725 172 assert_se(system(cmd) == 0);
d89c8fdf 173 }
355b59e2
ZJS
174
175 log_debug("/* test decompression */");
176
646853bd 177 assert_se((dst2 = mkostemp_safe(pattern2)) >= 0);
355b59e2
ZJS
178
179 assert_se(stat(srcfile, &st) == 0);
180
181 assert_se(lseek(dst, 0, SEEK_SET) == 0);
d89c8fdf 182 r = decompress(dst, dst2, st.st_size);
0c0cdb06 183 assert_se(r == 0);
355b59e2
ZJS
184
185 assert_se(asprintf(&cmd2, "diff %s %s", srcfile, pattern2) > 0);
186 assert_se(system(cmd2) == 0);
187
188 log_debug("/* test faulty decompression */");
189
190 assert_se(lseek(dst, 1, SEEK_SET) == 1);
d89c8fdf 191 r = decompress(dst, dst2, st.st_size);
4c701096 192 assert_se(IN_SET(r, 0, -EBADMSG));
355b59e2
ZJS
193
194 assert_se(lseek(dst, 0, SEEK_SET) == 0);
195 assert_se(lseek(dst2, 0, SEEK_SET) == 0);
d89c8fdf 196 r = decompress(dst, dst2, st.st_size - 1);
0c0cdb06 197 assert_se(r == -EFBIG);
355b59e2 198}
ccc717fa 199#endif
355b59e2 200
349cc4a5 201#if HAVE_LZ4
e3cc7fc4
ZJS
202static void test_lz4_decompress_partial(void) {
203 char buf[20000];
204 size_t buf_size = sizeof(buf), compressed;
205 int r;
ae5e1b19 206 _cleanup_free_ char *huge = NULL;
e3cc7fc4 207
ae5e1b19
ZJS
208#define HUGE_SIZE (4096*1024)
209 huge = malloc(HUGE_SIZE);
210 memset(huge, 'x', HUGE_SIZE);
e3cc7fc4
ZJS
211 memcpy(huge, "HUGE=", 5);
212
777fe71f
ZJS
213#if LZ4_VERSION_NUMBER >= 10700
214 r = LZ4_compress_default(huge, buf, HUGE_SIZE, buf_size);
215#else
ae5e1b19 216 r = LZ4_compress_limitedOutput(huge, buf, HUGE_SIZE, buf_size);
777fe71f 217#endif
e3cc7fc4
ZJS
218 assert_se(r >= 0);
219 compressed = r;
ae5e1b19 220 log_info("Compressed %i → %zu", HUGE_SIZE, compressed);
e3cc7fc4 221
ae5e1b19 222 r = LZ4_decompress_safe(buf, huge, r, HUGE_SIZE);
e3cc7fc4
ZJS
223 assert_se(r >= 0);
224 log_info("Decompressed → %i", r);
225
226 r = LZ4_decompress_safe_partial(buf, huge,
227 compressed,
ae5e1b19 228 12, HUGE_SIZE);
e3cc7fc4 229 assert_se(r >= 0);
ae5e1b19 230 log_info("Decompressed partial %i/%i → %i", 12, HUGE_SIZE, r);
e3cc7fc4
ZJS
231
232 /* We expect this to fail, because that's how current lz4 works. If this
233 * call succeeds, then lz4 has been fixed, and we need to change our code.
234 */
235 r = LZ4_decompress_safe_partial(buf, huge,
236 compressed,
ae5e1b19 237 12, HUGE_SIZE-1);
e3cc7fc4 238 assert_se(r < 0);
ae5e1b19 239 log_info("Decompressed partial %i/%i → %i", 12, HUGE_SIZE-1, r);
e3cc7fc4
ZJS
240}
241#endif
242
843fecc0 243int main(int argc, char *argv[]) {
349cc4a5 244#if HAVE_XZ || HAVE_LZ4
c552d602
ZJS
245 const char text[] =
246 "text\0foofoofoofoo AAAA aaaaaaaaa ghost busters barbarbar FFF"
247 "foofoofoofoo AAAA aaaaaaaaa ghost busters barbarbar FFF";
248
3e216115
ZJS
249 /* The file to test compression on can be specified as the first argument */
250 const char *srcfile = argc > 1 ? argv[1] : argv[0];
251
c552d602 252 char data[512] = "random\0";
355b59e2 253
ae5e1b19
ZJS
254 char huge[4096*1024];
255 memset(huge, 'x', sizeof(huge));
256 memcpy(huge, "HUGE=", 5);
257 char_array_0(huge);
258
355b59e2
ZJS
259 log_set_max_level(LOG_DEBUG);
260
c552d602
ZJS
261 random_bytes(data + 7, sizeof(data) - 7);
262
349cc4a5 263#if HAVE_XZ
c552d602
ZJS
264 test_compress_decompress(OBJECT_COMPRESSED_XZ, compress_blob_xz, decompress_blob_xz,
265 text, sizeof(text), false);
266 test_compress_decompress(OBJECT_COMPRESSED_XZ, compress_blob_xz, decompress_blob_xz,
267 data, sizeof(data), true);
ae5e1b19 268
c552d602
ZJS
269 test_decompress_startswith(OBJECT_COMPRESSED_XZ,
270 compress_blob_xz, decompress_startswith_xz,
271 text, sizeof(text), false);
272 test_decompress_startswith(OBJECT_COMPRESSED_XZ,
273 compress_blob_xz, decompress_startswith_xz,
274 data, sizeof(data), true);
ae5e1b19
ZJS
275 test_decompress_startswith(OBJECT_COMPRESSED_XZ,
276 compress_blob_xz, decompress_startswith_xz,
277 huge, sizeof(huge), true);
278
d89c8fdf 279 test_compress_stream(OBJECT_COMPRESSED_XZ, "xzcat",
3e216115 280 compress_stream_xz, decompress_stream_xz, srcfile);
d89c8fdf
ZJS
281#else
282 log_info("/* XZ test skipped */");
283#endif
c552d602 284
349cc4a5 285#if HAVE_LZ4
c552d602
ZJS
286 test_compress_decompress(OBJECT_COMPRESSED_LZ4, compress_blob_lz4, decompress_blob_lz4,
287 text, sizeof(text), false);
288 test_compress_decompress(OBJECT_COMPRESSED_LZ4, compress_blob_lz4, decompress_blob_lz4,
289 data, sizeof(data), true);
ae5e1b19 290
c552d602
ZJS
291 test_decompress_startswith(OBJECT_COMPRESSED_LZ4,
292 compress_blob_lz4, decompress_startswith_lz4,
293 text, sizeof(text), false);
294 test_decompress_startswith(OBJECT_COMPRESSED_LZ4,
295 compress_blob_lz4, decompress_startswith_lz4,
296 data, sizeof(data), true);
ae5e1b19
ZJS
297 test_decompress_startswith(OBJECT_COMPRESSED_LZ4,
298 compress_blob_lz4, decompress_startswith_lz4,
299 huge, sizeof(huge), true);
d89c8fdf 300
4b5bc539 301 test_compress_stream(OBJECT_COMPRESSED_LZ4, "lz4cat",
3e216115 302 compress_stream_lz4, decompress_stream_lz4, srcfile);
e3cc7fc4
ZJS
303
304 test_lz4_decompress_partial();
d89c8fdf
ZJS
305#else
306 log_info("/* LZ4 test skipped */");
307#endif
843fecc0
RC
308
309 return 0;
ccc717fa
ZJS
310#else
311 return EXIT_TEST_SKIP;
312#endif
843fecc0 313}