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