freebsd-src/lib/libarchive/test/test_write_disk_sparse.c
Tim Kientzle 7376ba1329 Fix ARCHIVE_EXTRACT_SPARSE handling in libarchive.
Add a test to exercise this feature.
This should fix --sparse/-S support in tar.

Thanks to:      Daichi GOTO
MFC after:	1 week
2009-01-26 05:44:40 +00:00

279 lines
8.5 KiB
C

/*-
* Copyright (c) 2003-2007 Tim Kientzle
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR(S) ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#include "test.h"
__FBSDID("$FreeBSD$");
/*
* Write a file using archive_write_data call, read the file
* back and verify the contents. The data written includes large
* blocks of nulls, so it should exercise the sparsification logic
* if ARCHIVE_EXTRACT_SPARSE is enabled.
*/
static void
verify_write_data(struct archive *a, int sparse)
{
static const char data[]="abcdefghijklmnopqrstuvwxyz";
struct stat st;
struct archive_entry *ae;
size_t buff_size = 64 * 1024;
char *buff, *p;
const char *msg = sparse ? "sparse" : "non-sparse";
int fd;
buff = malloc(buff_size);
assert(buff != NULL);
ae = archive_entry_new();
assert(ae != NULL);
archive_entry_set_size(ae, 8 * buff_size);
archive_entry_set_pathname(ae, "test_write_data");
archive_entry_set_mode(ae, AE_IFREG | 0755);
assertEqualIntA(a, 0, archive_write_header(a, ae));
/* Use archive_write_data() to write three relatively sparse blocks. */
/* First has non-null data at beginning. */
memset(buff, 0, buff_size);
memcpy(buff, data, sizeof(data));
failure("%s", msg);
assertEqualInt(buff_size, archive_write_data(a, buff, buff_size));
/* Second has non-null data in the middle. */
memset(buff, 0, buff_size);
memcpy(buff + buff_size / 2 - 3, data, sizeof(data));
failure("%s", msg);
assertEqualInt(buff_size, archive_write_data(a, buff, buff_size));
/* Third has non-null data at the end. */
memset(buff, 0, buff_size);
memcpy(buff + buff_size - sizeof(data), data, sizeof(data));
failure("%s", msg);
assertEqualInt(buff_size, archive_write_data(a, buff, buff_size));
failure("%s", msg);
assertEqualIntA(a, 0, archive_write_finish_entry(a));
/* Test the entry on disk. */
assert(0 == stat(archive_entry_pathname(ae), &st));
assertEqualInt(st.st_size, 8 * buff_size);
fd = open(archive_entry_pathname(ae), O_RDONLY);
if (!assert(fd >= 0))
return;
/* Check first block. */
assertEqualInt(buff_size, read(fd, buff, buff_size));
failure("%s", msg);
assertEqualMem(buff, data, sizeof(data));
for (p = buff + sizeof(data); p < buff + buff_size; ++p) {
failure("offset: %d, %s", (int)(p - buff), msg);
if (!assertEqualInt(0, *p))
break;
}
/* Check second block. */
assertEqualInt(buff_size, read(fd, buff, buff_size));
for (p = buff; p < buff + buff_size; ++p) {
failure("offset: %d, %s", (int)(p - buff), msg);
if (p == buff + buff_size / 2 - 3) {
assertEqualMem(p, data, sizeof(data));
p += sizeof(data);
} else if (!assertEqualInt(0, *p))
break;
}
/* Check third block. */
assertEqualInt(buff_size, read(fd, buff, buff_size));
for (p = buff; p < buff + buff_size - sizeof(data); ++p) {
failure("offset: %d, %s", (int)(p - buff), msg);
if (!assertEqualInt(0, *p))
break;
}
failure("%s", msg);
assertEqualMem(buff + buff_size - sizeof(data), data, sizeof(data));
/* XXX more XXX */
assertEqualInt(0, close(fd));
free(buff);
}
/*
* As above, but using the archive_write_data_block() call.
*/
static void
verify_write_data_block(struct archive *a, int sparse)
{
static const char data[]="abcdefghijklmnopqrstuvwxyz";
struct stat st;
struct archive_entry *ae;
size_t buff_size = 64 * 1024;
char *buff, *p;
const char *msg = sparse ? "sparse" : "non-sparse";
int fd;
buff = malloc(buff_size);
assert(buff != NULL);
ae = archive_entry_new();
assert(ae != NULL);
archive_entry_set_size(ae, 8 * buff_size);
archive_entry_set_pathname(ae, "test_write_data_block");
archive_entry_set_mode(ae, AE_IFREG | 0755);
assertEqualIntA(a, 0, archive_write_header(a, ae));
/* Use archive_write_data_block() to write three
relatively sparse blocks. */
/* First has non-null data at beginning. */
memset(buff, 0, buff_size);
memcpy(buff, data, sizeof(data));
failure("%s", msg);
assertEqualInt(ARCHIVE_OK,
archive_write_data_block(a, buff, buff_size, 100));
/* Second has non-null data in the middle. */
memset(buff, 0, buff_size);
memcpy(buff + buff_size / 2 - 3, data, sizeof(data));
failure("%s", msg);
assertEqualInt(ARCHIVE_OK,
archive_write_data_block(a, buff, buff_size, buff_size + 200));
/* Third has non-null data at the end. */
memset(buff, 0, buff_size);
memcpy(buff + buff_size - sizeof(data), data, sizeof(data));
failure("%s", msg);
assertEqualInt(ARCHIVE_OK,
archive_write_data_block(a, buff, buff_size, buff_size * 2 + 300));
failure("%s", msg);
assertEqualIntA(a, 0, archive_write_finish_entry(a));
/* Test the entry on disk. */
assert(0 == stat(archive_entry_pathname(ae), &st));
assertEqualInt(st.st_size, 8 * buff_size);
fd = open(archive_entry_pathname(ae), O_RDONLY);
if (!assert(fd >= 0))
return;
/* Check 100-byte gap at beginning */
assertEqualInt(100, read(fd, buff, 100));
failure("%s", msg);
for (p = buff; p < buff + 100; ++p) {
failure("offset: %d, %s", (int)(p - buff), msg);
if (!assertEqualInt(0, *p))
break;
}
/* Check first block. */
assertEqualInt(buff_size, read(fd, buff, buff_size));
failure("%s", msg);
assertEqualMem(buff, data, sizeof(data));
for (p = buff + sizeof(data); p < buff + buff_size; ++p) {
failure("offset: %d, %s", (int)(p - buff), msg);
if (!assertEqualInt(0, *p))
break;
}
/* Check 100-byte gap */
assertEqualInt(100, read(fd, buff, 100));
failure("%s", msg);
for (p = buff; p < buff + 100; ++p) {
failure("offset: %d, %s", (int)(p - buff), msg);
if (!assertEqualInt(0, *p))
break;
}
/* Check second block. */
assertEqualInt(buff_size, read(fd, buff, buff_size));
for (p = buff; p < buff + buff_size; ++p) {
failure("offset: %d, %s", (int)(p - buff), msg);
if (p == buff + buff_size / 2 - 3) {
assertEqualMem(p, data, sizeof(data));
p += sizeof(data);
} else if (!assertEqualInt(0, *p))
break;
}
/* Check 100-byte gap */
assertEqualInt(100, read(fd, buff, 100));
failure("%s", msg);
for (p = buff; p < buff + 100; ++p) {
failure("offset: %d, %s", (int)(p - buff), msg);
if (!assertEqualInt(0, *p))
break;
}
/* Check third block. */
assertEqualInt(buff_size, read(fd, buff, buff_size));
for (p = buff; p < buff + buff_size - sizeof(data); ++p) {
failure("offset: %d, %s", (int)(p - buff), msg);
if (!assertEqualInt(0, *p))
break;
}
failure("%s", msg);
assertEqualMem(buff + buff_size - sizeof(data), data, sizeof(data));
/* Check another block size beyond last we wrote. */
assertEqualInt(buff_size, read(fd, buff, buff_size));
failure("%s", msg);
for (p = buff; p < buff + buff_size; ++p) {
failure("offset: %d, %s", (int)(p - buff), msg);
if (!assertEqualInt(0, *p))
break;
}
/* XXX more XXX */
assertEqualInt(0, close(fd));
free(buff);
}
DEFINE_TEST(test_write_disk_sparse)
{
struct archive *ad;
/*
* The return values, etc, of the write data functions
* shouldn't change regardless of whether we've requested
* sparsification. (The performance and pattern of actual
* write calls to the disk should vary, of course, but the
* client program shouldn't see any difference.)
*/
assert((ad = archive_write_disk_new()) != NULL);
archive_write_disk_set_options(ad, 0);
verify_write_data(ad, 0);
verify_write_data_block(ad, 0);
assertEqualInt(0, archive_write_finish(ad));
assert((ad = archive_write_disk_new()) != NULL);
archive_write_disk_set_options(ad, ARCHIVE_EXTRACT_SPARSE);
verify_write_data(ad, 1);
verify_write_data_block(ad, 1);
assertEqualInt(0, archive_write_finish(ad));
}