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