1 /*- 2 * Copyright (c) 2017 Sean Purcell 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer 10 * in this position and unchanged. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR 16 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 17 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 18 * IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT, 19 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 20 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 21 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 22 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 24 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 */ 26 27 #include "test.h" 28 __FBSDID("$FreeBSD$"); 29 30 DEFINE_TEST(test_write_filter_zstd) 31 { 32 struct archive_entry *ae; 33 struct archive *a; 34 char *buff, *data; 35 size_t buffsize, datasize; 36 char path[16]; 37 size_t used1, used2, used3; 38 int i, r; 39 40 buffsize = 2000000; 41 assert(NULL != (buff = (char *)malloc(buffsize))); 42 if (buff == NULL) 43 return; 44 45 datasize = 10000; 46 assert(NULL != (data = (char *)malloc(datasize))); 47 if (data == NULL) { 48 free(buff); 49 return; 50 } 51 memset(data, 0, datasize); 52 53 /* 54 * Write a 100 files and read them all back. 55 */ 56 assert((a = archive_write_new()) != NULL); 57 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a)); 58 r = archive_write_add_filter_zstd(a); 59 if (r != ARCHIVE_OK) { 60 skipping("zstd writing not supported on this platform"); 61 assertEqualInt(ARCHIVE_OK, archive_write_free(a)); 62 free(buff); 63 free(data); 64 return; 65 } 66 assertEqualIntA(a, ARCHIVE_OK, 67 archive_write_set_bytes_per_block(a, 10)); 68 assertEqualInt(ARCHIVE_FILTER_ZSTD, archive_filter_code(a, 0)); 69 assertEqualString("zstd", archive_filter_name(a, 0)); 70 assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used1)); 71 assertEqualInt(ARCHIVE_FILTER_ZSTD, archive_filter_code(a, 0)); 72 assertEqualString("zstd", archive_filter_name(a, 0)); 73 assert((ae = archive_entry_new()) != NULL); 74 archive_entry_set_filetype(ae, AE_IFREG); 75 archive_entry_set_size(ae, datasize); 76 for (i = 0; i < 100; i++) { 77 snprintf(path, sizeof(path), "file%03d", i); 78 archive_entry_copy_pathname(ae, path); 79 assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae)); 80 assertA(datasize 81 == (size_t)archive_write_data(a, data, datasize)); 82 } 83 archive_entry_free(ae); 84 assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a)); 85 assertEqualInt(ARCHIVE_OK, archive_write_free(a)); 86 87 assert((a = archive_read_new()) != NULL); 88 assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a)); 89 r = archive_read_support_filter_zstd(a); 90 if (r == ARCHIVE_WARN) { 91 skipping("Can't verify zstd writing by reading back;" 92 " zstd reading not fully supported on this platform"); 93 } else { 94 assertEqualIntA(a, ARCHIVE_OK, 95 archive_read_support_filter_all(a)); 96 assertEqualIntA(a, ARCHIVE_OK, 97 archive_read_open_memory(a, buff, used1)); 98 for (i = 0; i < 100; i++) { 99 snprintf(path, sizeof(path), "file%03d", i); 100 if (!assertEqualInt(ARCHIVE_OK, 101 archive_read_next_header(a, &ae))) 102 break; 103 assertEqualString(path, archive_entry_pathname(ae)); 104 assertEqualInt((int)datasize, archive_entry_size(ae)); 105 } 106 assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a)); 107 } 108 assertEqualInt(ARCHIVE_OK, archive_read_free(a)); 109 110 /* 111 * Repeat the cycle again, this time setting some compression 112 * options. 113 */ 114 assert((a = archive_write_new()) != NULL); 115 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a)); 116 assertEqualIntA(a, ARCHIVE_OK, 117 archive_write_set_bytes_per_block(a, 10)); 118 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a)); 119 assertEqualIntA(a, ARCHIVE_FAILED, 120 archive_write_set_filter_option(a, NULL, "nonexistent-option", "0")); 121 assertEqualIntA(a, ARCHIVE_FAILED, 122 archive_write_set_filter_option(a, NULL, "compression-level", "abc")); 123 assertEqualIntA(a, ARCHIVE_FAILED, 124 archive_write_set_filter_option(a, NULL, "compression-level", "25")); /* too big */ 125 assertEqualIntA(a, ARCHIVE_OK, 126 archive_write_set_filter_option(a, NULL, "compression-level", "9")); 127 /* Following is disabled as it will fail on library versions < 1.3.4 */ 128 /* assertEqualIntA(a, ARCHIVE_OK, 129 archive_write_set_filter_option(a, NULL, "compression-level", "-1")); */ 130 assertEqualIntA(a, ARCHIVE_OK, 131 archive_write_set_filter_option(a, NULL, "compression-level", "7")); 132 assertEqualIntA(a, ARCHIVE_FAILED, 133 archive_write_set_filter_option(a, NULL, "threads", "-1")); /* negative */ 134 assertEqualIntA(a, ARCHIVE_OK, 135 archive_write_set_filter_option(a, NULL, "threads", "4")); 136 #if HAVE_ZSTD_H && HAVE_LIBZSTD_COMPRESSOR 137 /* frame-per-file: boolean */ 138 assertEqualIntA(a, ARCHIVE_OK, 139 archive_write_set_filter_option(a, NULL, "frame-per-file", "")); 140 /* min-frame-size: >= 0 */ 141 assertEqualIntA(a, ARCHIVE_FAILED, 142 archive_write_set_filter_option(a, NULL, "min-frame-size", "")); 143 assertEqualIntA(a, ARCHIVE_FAILED, 144 archive_write_set_filter_option(a, NULL, "min-frame-size", "-1")); 145 assertEqualIntA(a, ARCHIVE_OK, 146 archive_write_set_filter_option(a, NULL, "min-frame-size", "0")); 147 assertEqualIntA(a, ARCHIVE_OK, 148 archive_write_set_filter_option(a, NULL, "min-frame-size", "1048576")); 149 /* max-frame-size: >= 1024 */ 150 assertEqualIntA(a, ARCHIVE_FAILED, 151 archive_write_set_filter_option(a, NULL, "max-frame-size", "")); 152 assertEqualIntA(a, ARCHIVE_FAILED, 153 archive_write_set_filter_option(a, NULL, "max-frame-size", "-1")); 154 assertEqualIntA(a, ARCHIVE_FAILED, 155 archive_write_set_filter_option(a, NULL, "max-frame-size", "0")); 156 assertEqualIntA(a, ARCHIVE_FAILED, 157 archive_write_set_filter_option(a, NULL, "max-frame-size", "1023")); 158 assertEqualIntA(a, ARCHIVE_OK, 159 archive_write_set_filter_option(a, NULL, "max-frame-size", "1024")); 160 assertEqualIntA(a, ARCHIVE_OK, 161 archive_write_set_filter_option(a, NULL, "max-frame-size", "1048576")); 162 #endif 163 assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used2)); 164 for (i = 0; i < 100; i++) { 165 snprintf(path, sizeof(path), "file%03d", i); 166 assert((ae = archive_entry_new()) != NULL); 167 archive_entry_copy_pathname(ae, path); 168 archive_entry_set_size(ae, datasize); 169 archive_entry_set_filetype(ae, AE_IFREG); 170 assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae)); 171 assertA(datasize == (size_t)archive_write_data(a, data, datasize)); 172 archive_entry_free(ae); 173 } 174 assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a)); 175 assertEqualInt(ARCHIVE_OK, archive_write_free(a)); 176 177 assert((a = archive_read_new()) != NULL); 178 assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a)); 179 r = archive_read_support_filter_zstd(a); 180 if (r == ARCHIVE_WARN) { 181 skipping("zstd reading not fully supported on this platform"); 182 } else { 183 assertEqualIntA(a, ARCHIVE_OK, 184 archive_read_support_filter_all(a)); 185 assertEqualIntA(a, ARCHIVE_OK, 186 archive_read_open_memory(a, buff, used2)); 187 for (i = 0; i < 100; i++) { 188 snprintf(path, sizeof(path), "file%03d", i); 189 failure("Trying to read %s", path); 190 if (!assertEqualIntA(a, ARCHIVE_OK, 191 archive_read_next_header(a, &ae))) 192 break; 193 assertEqualString(path, archive_entry_pathname(ae)); 194 assertEqualInt((int)datasize, archive_entry_size(ae)); 195 } 196 assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a)); 197 } 198 assertEqualInt(ARCHIVE_OK, archive_read_free(a)); 199 200 /* 201 * One more time at level 1 202 */ 203 assert((a = archive_write_new()) != NULL); 204 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a)); 205 assertEqualIntA(a, ARCHIVE_OK, 206 archive_write_set_bytes_per_block(a, 10)); 207 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a)); 208 assertEqualIntA(a, ARCHIVE_OK, 209 archive_write_set_filter_option(a, NULL, "compression-level", "1")); 210 assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used3)); 211 assert((ae = archive_entry_new()) != NULL); 212 archive_entry_set_filetype(ae, AE_IFREG); 213 archive_entry_set_size(ae, datasize); 214 for (i = 0; i < 100; i++) { 215 snprintf(path, sizeof(path), "file%03d", i); 216 archive_entry_copy_pathname(ae, path); 217 assertEqualIntA(a, ARCHIVE_OK, archive_write_header(a, ae)); 218 assertA(datasize == (size_t)archive_write_data(a, data, datasize)); 219 } 220 archive_entry_free(ae); 221 assertEqualIntA(a, ARCHIVE_OK, archive_write_close(a)); 222 assertEqualInt(ARCHIVE_OK, archive_write_free(a)); 223 224 assert((a = archive_read_new()) != NULL); 225 assertEqualIntA(a, ARCHIVE_OK, archive_read_support_format_all(a)); 226 r = archive_read_support_filter_zstd(a); 227 if (r == ARCHIVE_WARN) { 228 skipping("zstd reading not fully supported on this platform"); 229 } else { 230 assertEqualIntA(a, ARCHIVE_OK, 231 archive_read_support_filter_all(a)); 232 assertEqualIntA(a, ARCHIVE_OK, 233 archive_read_open_memory(a, buff, used3)); 234 for (i = 0; i < 100; i++) { 235 snprintf(path, sizeof(path), "file%03d", i); 236 failure("Trying to read %s", path); 237 if (!assertEqualIntA(a, ARCHIVE_OK, 238 archive_read_next_header(a, &ae))) 239 break; 240 assertEqualString(path, archive_entry_pathname(ae)); 241 assertEqualInt((int)datasize, archive_entry_size(ae)); 242 } 243 assertEqualIntA(a, ARCHIVE_OK, archive_read_close(a)); 244 } 245 assertEqualInt(ARCHIVE_OK, archive_read_free(a)); 246 247 /* 248 * Check output sizes for various compression levels, expectation 249 * is that archive size for level=7 < default < level=1 250 */ 251 failure("compression-level=7 wrote %d bytes, default wrote %d bytes", 252 (int)used2, (int)used1); 253 assert(used2 < used1); 254 failure("compression-level=1 wrote %d bytes, default wrote %d bytes", 255 (int)used3, (int)used1); 256 assert(used1 < used3); 257 258 /* 259 * Test various premature shutdown scenarios to make sure we 260 * don't crash or leak memory. 261 */ 262 assert((a = archive_write_new()) != NULL); 263 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a)); 264 assertEqualInt(ARCHIVE_OK, archive_write_free(a)); 265 266 assert((a = archive_write_new()) != NULL); 267 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a)); 268 assertEqualInt(ARCHIVE_OK, archive_write_close(a)); 269 assertEqualInt(ARCHIVE_OK, archive_write_free(a)); 270 271 assert((a = archive_write_new()) != NULL); 272 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a)); 273 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a)); 274 assertEqualInt(ARCHIVE_OK, archive_write_close(a)); 275 assertEqualInt(ARCHIVE_OK, archive_write_free(a)); 276 277 assert((a = archive_write_new()) != NULL); 278 assertEqualIntA(a, ARCHIVE_OK, archive_write_set_format_ustar(a)); 279 assertEqualIntA(a, ARCHIVE_OK, archive_write_add_filter_zstd(a)); 280 assertEqualIntA(a, ARCHIVE_OK, archive_write_open_memory(a, buff, buffsize, &used2)); 281 assertEqualInt(ARCHIVE_OK, archive_write_close(a)); 282 assertEqualInt(ARCHIVE_OK, archive_write_free(a)); 283 284 /* 285 * Clean up. 286 */ 287 free(data); 288 free(buff); 289 } 290