src/journal/test-compress.c

   1 /* SPDX-License-Identifier: LGPL-2.1+ */
   2 /***
   3   Copyright 2014 Ronny Chevalier
   4 ***/
   5
   6 #if HAVE_LZ4
   7 #include <lz4.h>
   8 #endif
   9
  10 #include "alloc-util.h"
  11 #include "compress.h"
  12 #include "fd-util.h"
  13 #include "fileio.h"
  14 #include "fs-util.h"
  15 #include "macro.h"
  16 #include "path-util.h"
  17 #include "random-util.h"
  18 #include "util.h"
  19
  20 #if HAVE_XZ
  21 # define XZ_OK 0
  22 #else
  23 # define XZ_OK -EPROTONOSUPPORT
  24 #endif
  25
  26 #if HAVE_LZ4
  27 # define LZ4_OK 0
  28 #else
  29 # define LZ4_OK -EPROTONOSUPPORT
  30 #endif
  31
  32 typedef int (compress_blob_t)(const void *src, uint64_t src_size,
  33                               void *dst, size_t dst_alloc_size, size_t *dst_size);
  34 typedef int (decompress_blob_t)(const void *src, uint64_t src_size,
  35                                 void **dst, size_t *dst_alloc_size,
  36                                 size_t* dst_size, size_t dst_max);
  37 typedef int (decompress_sw_t)(const void *src, uint64_t src_size,
  38                               void **buffer, size_t *buffer_size,
  39                               const void *prefix, size_t prefix_len,
  40                               uint8_t extra);
  41
  42 typedef int (compress_stream_t)(int fdf, int fdt, uint64_t max_bytes);
  43 typedef int (decompress_stream_t)(int fdf, int fdt, uint64_t max_size);
  44
  45 #if HAVE_XZ || HAVE_LZ4
  46 static void test_compress_decompress(int compression,
  47                                      compress_blob_t compress,
  48                                      decompress_blob_t decompress,
  49                                      const char *data,
  50                                      size_t data_len,
  51                                      bool may_fail) {
  52         char compressed[512];
  53         size_t csize, usize = 0;
  54         _cleanup_free_ char *decompressed = NULL;
  55         int r;
  56
  57         log_info("/* testing %s %s blob compression/decompression */",
  58                  object_compressed_to_string(compression), data);
  59
  60         r = compress(data, data_len, compressed, sizeof(compressed), &csize);
  61         if (r == -ENOBUFS) {
  62                 log_info_errno(r, "compression failed: %m");
  63                 assert_se(may_fail);
  64         } else {
  65                 assert_se(r == 0);
  66                 r = decompress(compressed, csize,
  67                                (void **) &decompressed, &usize, &csize, 0);
  68                 assert_se(r == 0);
  69                 assert_se(decompressed);
  70                 assert_se(memcmp(decompressed, data, data_len) == 0);
  71         }
  72
  73         r = decompress("garbage", 7,
  74                        (void **) &decompressed, &usize, &csize, 0);
  75         assert_se(r < 0);
  76
  77         /* make sure to have the minimal lz4 compressed size */
  78         r = decompress("00000000\1g", 9,
  79                        (void **) &decompressed, &usize, &csize, 0);
  80         assert_se(r < 0);
  81
  82         r = decompress("\100000000g", 9,
  83                        (void **) &decompressed, &usize, &csize, 0);
  84         assert_se(r < 0);
  85
  86         memzero(decompressed, usize);
  87 }
  88
  89 static void test_decompress_startswith(int compression,
  90                                        compress_blob_t compress,
  91                                        decompress_sw_t decompress_sw,
  92                                        const char *data,
  93                                        size_t data_len,
  94                                        bool may_fail) {
  95
  96         char *compressed;
  97         _cleanup_free_ char *compressed1 = NULL, *compressed2 = NULL, *decompressed = NULL;
  98         size_t csize, usize = 0, len;
  99         int r;
 100
 101         log_info("/* testing decompress_startswith with %s on %.20s text */",
 102                  object_compressed_to_string(compression), data);
 103
 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);
 110         if (r == -ENOBUFS) {
 111                 log_info_errno(r, "compression failed: %m");
 112                 assert_se(may_fail);
 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);
 118         }
 119         assert_se(r == 0);
 120
 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);
 135 }
 136
 137 static 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
 143         _cleanup_close_ int src = -1, dst = -1, dst2 = -1;
 144         _cleanup_(unlink_tempfilep) char
 145                 pattern[] = "/tmp/systemd-test.compressed.XXXXXX",
 146                 pattern2[] = "/tmp/systemd-test.compressed.XXXXXX";
 147         int r;
 148         _cleanup_free_ char *cmd = NULL, *cmd2 = NULL;
 149         struct stat st = {};
 150
 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
 157         log_debug("/* testing %s compression */",
 158                   object_compressed_to_string(compression));
 159
 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
 166         assert_se((dst = mkostemp_safe(pattern)) >= 0);
 167
 168         assert_se(compress(src, dst, -1) == 0);
 169
 170         if (cat) {
 171                 assert_se(asprintf(&cmd, "%s %s | diff %s -", cat, pattern, srcfile) > 0);
 172                 assert_se(system(cmd) == 0);
 173         }
 174
 175         log_debug("/* test decompression */");
 176
 177         assert_se((dst2 = mkostemp_safe(pattern2)) >= 0);
 178
 179         assert_se(stat(srcfile, &st) == 0);
 180
 181         assert_se(lseek(dst, 0, SEEK_SET) == 0);
 182         r = decompress(dst, dst2, st.st_size);
 183         assert_se(r == 0);
 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);
 191         r = decompress(dst, dst2, st.st_size);
 192         assert_se(IN_SET(r, 0, -EBADMSG));
 193
 194         assert_se(lseek(dst, 0, SEEK_SET) == 0);
 195         assert_se(lseek(dst2, 0, SEEK_SET) == 0);
 196         r = decompress(dst, dst2, st.st_size - 1);
 197         assert_se(r == -EFBIG);
 198 }
 199 #endif
 200
 201 #if HAVE_LZ4
 202 static void test_lz4_decompress_partial(void) {
 203         char buf[20000];
 204         size_t buf_size = sizeof(buf), compressed;
 205         int r;
 206         _cleanup_free_ char *huge = NULL;
 207
 208 #define HUGE_SIZE (4096*1024)
 209         huge = malloc(HUGE_SIZE);
 210         memset(huge, 'x', HUGE_SIZE);
 211         memcpy(huge, "HUGE=", 5);
 212
 213 #if LZ4_VERSION_NUMBER >= 10700
 214         r = LZ4_compress_default(huge, buf, HUGE_SIZE, buf_size);
 215 #else
 216         r = LZ4_compress_limitedOutput(huge, buf, HUGE_SIZE, buf_size);
 217 #endif
 218         assert_se(r >= 0);
 219         compressed = r;
 220         log_info("Compressed %i → %zu", HUGE_SIZE, compressed);
 221
 222         r = LZ4_decompress_safe(buf, huge, r, HUGE_SIZE);
 223         assert_se(r >= 0);
 224         log_info("Decompressed → %i", r);
 225
 226         r = LZ4_decompress_safe_partial(buf, huge,
 227                                         compressed,
 228                                         12, HUGE_SIZE);
 229         assert_se(r >= 0);
 230         log_info("Decompressed partial %i/%i → %i", 12, HUGE_SIZE, r);
 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,
 237                                         12, HUGE_SIZE-1);
 238         assert_se(r < 0);
 239         log_info("Decompressed partial %i/%i → %i", 12, HUGE_SIZE-1, r);
 240 }
 241 #endif
 242
 243 int main(int argc, char *argv[]) {
 244 #if HAVE_XZ || HAVE_LZ4
 245         const char text[] =
 246                 "text\0foofoofoofoo AAAA aaaaaaaaa ghost busters barbarbar FFF"
 247                 "foofoofoofoo AAAA aaaaaaaaa ghost busters barbarbar FFF";
 248
 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
 252         char data[512] = "random\0";
 253
 254         char huge[4096*1024];
 255         memset(huge, 'x', sizeof(huge));
 256         memcpy(huge, "HUGE=", 5);
 257         char_array_0(huge);
 258
 259         log_set_max_level(LOG_DEBUG);
 260
 261         random_bytes(data + 7, sizeof(data) - 7);
 262
 263 #if HAVE_XZ
 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);
 268
 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);
 275         test_decompress_startswith(OBJECT_COMPRESSED_XZ,
 276                                    compress_blob_xz, decompress_startswith_xz,
 277                                    huge, sizeof(huge), true);
 278
 279         test_compress_stream(OBJECT_COMPRESSED_XZ, "xzcat",
 280                              compress_stream_xz, decompress_stream_xz, srcfile);
 281 #else
 282         log_info("/* XZ test skipped */");
 283 #endif
 284
 285 #if HAVE_LZ4
 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);
 290
 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);
 297         test_decompress_startswith(OBJECT_COMPRESSED_LZ4,
 298                                    compress_blob_lz4, decompress_startswith_lz4,
 299                                    huge, sizeof(huge), true);
 300
 301         test_compress_stream(OBJECT_COMPRESSED_LZ4, "lz4cat",
 302                              compress_stream_lz4, decompress_stream_lz4, srcfile);
 303
 304         test_lz4_decompress_partial();
 305 #else
 306         log_info("/* LZ4 test skipped */");
 307 #endif
 308
 309         return 0;
 310 #else
 311         return EXIT_TEST_SKIP;
 312 #endif
 313 }