Skip to content

C
ccan
Commit 67bbee53 authored by Rusty Russell's avatar Rusty Russell
Browse files
Options

failtest: save and restore file state inside child (on-demand) 

We currently save all files in the parent, and restore them once
the child is gone.  That doesn't work in a case where the child
manipulates a file the parent doesn't currently have open, so
switch to a model where the child cleans itself up, using the
already-existing cleanup callbacks.

This means that we need to undo much more, especially restoring
file offsets.  We also need to handle the case where we've already
closed the file, and now we're cleaning up.  As a bonus, we now
handle open() with O_TRUNC properly.

The cleanup function now has two modes: one simply frees (so valgrind
doesn't complain about failtest leaking so the user can see real leaks
in their programs), the other restores things so the parent sees no
changes.
parent 4f2f6f1e
Show whitespace changes
Inline Side-by-side
Showing with 573 additions and 184 deletions
ccan/failtest/failtest.c
View file @ 67bbee53
......@@ -82,26 +82,53 @@ HTABLE_DEFINE_TYPE(struct failtest_call, (struct failtest_call *), hash_call,
bool (*failtest_exit_check)(struct tlist_calls *history);
/* The entire history of all calls. */
static struct tlist_calls history = TLIST_INIT(history);
/* If we're a child, the fd two write control info to the parent. */
static int control_fd = -1;
/* If we're a child, this is the first call we did ourselves. */
static struct failtest_call *our_history_start = NULL;
/* For printing runtime with --tracepath. */
static struct timeval start;
/* Set when failtest_hook returns FAIL_PROBE */
static bool probing = false;
/* Table to track duplicates. */
static struct failtable failtable;
/* Array of writes which our child did. We report them on failure. */
static struct write_call *child_writes = NULL;
static unsigned int child_writes_num = 0;
/* fcntl locking info. */
static pid_t lock_owner;
static struct lock_info *locks = NULL;
static unsigned int lock_num = 0;
/* Our original pid, which we return to anyone who asks. */
static pid_t orig_pid;
static const char info_to_arg[] = "mceoxprwfa";
/* Mapping from failtest_type to char. */
static const char info_to_arg[] = "mceoxprwfal";
/* Dummy call used for failtest_undo wrappers. */
static struct failtest_call unrecorded_call;
struct contents_saved {
size_t count;
off_t off;
off_t old_len;
char contents[1];
};
/* File contents, saved in this child only. */
struct saved_mmapped_file {
struct saved_mmapped_file *next;
struct failtest_call *opener;
struct contents_saved *s;
};
static struct saved_mmapped_file *saved_mmapped_files;
#if HAVE_BACKTRACE
#include <execinfo.h>
......@@ -131,6 +158,7 @@ static void **get_backtrace(unsigned int *num)
#endif /* HAVE_BACKTRACE */
static struct failtest_call *add_history_(enum failtest_call_type type,
bool can_leak,
const char *file,
unsigned int line,
const void *elem,
......@@ -144,6 +172,7 @@ static struct failtest_call *add_history_(enum failtest_call_type type,
call = malloc(sizeof *call);
call->type = type;
call->can_leak = can_leak;
call->file = file;
call->line = line;
call->cleanup = NULL;
......@@ -153,13 +182,12 @@ static struct failtest_call *add_history_(enum failtest_call_type type,
return call;
}
#define add_history(type, file, line, elem) \
add_history_((type), (file), (line), (elem), sizeof(*(elem)))
#define add_history(type, can_leak, file, line, elem) \
add_history_((type), (can_leak), (file), (line), (elem), sizeof(*(elem)))
/* We do a fake call inside a sizeof(), to check types. */
#define set_cleanup(call, clean, type) \
(call)->cleanup = (void *)((void)sizeof(clean((type *)NULL),1), (clean))
(call)->cleanup = (void *)((void)sizeof(clean((type *)NULL, false),1), (clean))
/* Dup the fd to a high value (out of the way I hope!), and close the old fd. */
static int move_fd_to_high(int fd)
......@@ -353,91 +381,145 @@ static void get_locks(void)
lock_owner = getpid();
}
struct saved_file {
struct saved_file *next;
int fd;
void *contents;
off_t off, len;
};
static struct saved_file *save_file(struct saved_file *next, int fd)
static struct contents_saved *save_contents(int fd, size_t count, off_t off)
{
struct saved_file *s = malloc(sizeof(*s));
s->next = next;
s->fd = fd;
s->off = lseek(fd, 0, SEEK_CUR);
/* Special file? Erk... */
assert(s->off != -1);
s->len = lseek(fd, 0, SEEK_END);
lseek(fd, 0, SEEK_SET);
s->contents = malloc(s->len);
if (read(fd, s->contents, s->len) != s->len)
err(1, "Failed to save %zu bytes", (size_t)s->len);
lseek(fd, s->off, SEEK_SET);
struct contents_saved *s = malloc(sizeof(*s) + count);
ssize_t ret;
s->off = off;
ret = pread(fd, s->contents, count, off);
if (ret < 0) {
fwarn("failtest_write: failed to save old contents!");
s->count = 0;
} else
s->count = ret;
/* Use lseek to get the size of file, but we have to restore
* file offset */
off = lseek(fd, 0, SEEK_CUR);
s->old_len = lseek(fd, 0, SEEK_END);
lseek(fd, off, SEEK_SET);
return s;
}
/* We have little choice but to save and restore open files: mmap means we
* can really intercept changes in the child.
*
* We could do non-mmap'ed files on demand, however. */
static struct saved_file *save_files(void)
static void restore_contents(struct failtest_call *opener,
struct contents_saved *s,
bool restore_offset,
const char *caller)
{
int fd;
/* The top parent doesn't need to restore. */
if (control_fd == -1)
return;
/* Has the fd been closed? */
if (opener->u.open.closed) {
/* Reopen, replace fd, close silently as we clean up. */
fd = open(opener->u.open.pathname, O_RDWR);
if (fd < 0) {
fwarn("failtest: could not reopen %s to clean up %s!",
opener->u.open.pathname, caller);
return;
}
/* Make it clearly distinguisable from a "normal" fd. */
opener->u.open.ret = move_fd_to_high(fd);
opener->u.open.closed = false;
}
fd = opener->u.open.ret;
if (pwrite(fd, s->contents, s->count, s->off) != s->count) {
fwarn("failtest: write failed cleaning up %s for %s!",
opener->u.open.pathname, caller);
}
if (ftruncate(fd, s->old_len) != 0) {
fwarn("failtest_write: truncate failed cleaning up %s for %s!",
opener->u.open.pathname, caller);
}
if (restore_offset)
lseek(fd, s->off, SEEK_SET);
}
/* We save/restore most things on demand, but always do mmaped files. */
static void save_mmapped_files(void)
{
struct saved_file *files = NULL;
struct failtest_call *i;
/* Figure out the set of live fds. */
tlist_for_each_rev(&history, i, list) {
if (i->type == FAILTEST_OPEN) {
int fd = i->u.open.ret;
/* Only do successful, writable fds. */
if (fd < 0)
struct mmap_call *m = &i->u.mmap;
struct saved_mmapped_file *s;
if (i->type != FAILTEST_MMAP)
continue;
/* If it was closed, cleanup == NULL. */
if (!i->cleanup)
/* FIXME: We only handle mmapped files where fd is still open. */
if (m->opener->u.open.closed)
continue;
if ((i->u.open.flags & O_RDWR) == O_RDWR) {
files = save_file(files, fd);
} else if ((i->u.open.flags & O_WRONLY)
== O_WRONLY) {
/* FIXME: Handle O_WRONLY. Open with O_RDWR? */
abort();
}
s = malloc(sizeof *s);
s->s = save_contents(m->fd, m->length, m->offset);
s->opener = m->opener;
s->next = saved_mmapped_files;
saved_mmapped_files = s;
}
}
return files;
}
static void restore_files(struct saved_file *s)
static void free_mmapped_files(bool restore)
{
while (s) {
struct saved_file *next = s->next;
lseek(s->fd, 0, SEEK_SET);
if (write(s->fd, s->contents, s->len) != s->len)
err(1, "Failed to restore %zu bytes", (size_t)s->len);
if (ftruncate(s->fd, s->len) != 0)
err(1, "Failed to trim file to length %zu",
(size_t)s->len);
free(s->contents);
lseek(s->fd, s->off, SEEK_SET);
free(s);
s = next;
while (saved_mmapped_files) {
struct saved_mmapped_file *next = saved_mmapped_files->next;
if (restore)
restore_contents(saved_mmapped_files->opener,
saved_mmapped_files->s, false,
"saved mmap");
free(saved_mmapped_files->s);
free(saved_mmapped_files);
saved_mmapped_files = next;
}
}
static void free_files(struct saved_file *s)
/* Returns a FAILTEST_OPEN, FAILTEST_PIPE or NULL. */
static struct failtest_call *opener_of(int fd)
{
while (s) {
struct saved_file *next = s->next;
free(s->contents);
free(s);
s = next;
struct failtest_call *i;
/* Don't get confused and match genuinely failed opens. */
if (fd < 0)
return NULL;
/* Figure out the set of live fds. */
tlist_for_each_rev(&history, i, list) {
if (i->fail)
continue;
switch (i->type) {
case FAILTEST_CLOSE:
if (i->u.close.fd == fd) {
return NULL;
}
break;
case FAILTEST_OPEN:
if (i->u.open.ret == fd) {
if (i->u.open.closed)
return NULL;
return i;
}
break;
case FAILTEST_PIPE:
if (i->u.pipe.fds[0] == fd || i->u.pipe.fds[1] == fd) {
return i;
}
break;
default:
break;
}
}
/* FIXME: socket, dup, etc are untracked! */
return NULL;
}
static void free_call(struct failtest_call *call)
......@@ -464,29 +546,38 @@ static void free_everything(void)
static NORETURN void failtest_cleanup(bool forced_cleanup, int status)
{
struct failtest_call *i;
bool restore = true;
/* For children, we don't care if they "failed" the testing. */
if (control_fd != -1)
status = 0;
if (forced_cleanup) {
/* We didn't actually do final operation: remove it. */
i = tlist_tail(&history, struct failtest_call, list);
free_call(i);
}
else
/* We don't restore contents for original parent. */
restore = false;
/* Cleanup everything, in reverse order. */
tlist_for_each_rev(&history, i, list) {
if (!i->cleanup)
/* Don't restore things our parent did. */
if (i == our_history_start)
restore = false;
if (i->fail)
continue;
if (!forced_cleanup) {
if (i->cleanup)
i->cleanup(&i->u, restore);
/* But their program shouldn't leak, even on failure. */
if (!forced_cleanup && i->can_leak) {
printf("Leak at %s:%u: --failpath=%s\n",
i->file, i->line, failpath_string());
status = 1;
}
i->cleanup(&i->u);
}
/* Put back mmaped files the way our parent (if any) expects. */
free_mmapped_files(true);
free_everything();
if (status == 0)
tell_parent(SUCCESS);
......@@ -518,6 +609,8 @@ static bool follow_path(struct failtest_call *call)
errx(1, "Failpath expected '%s' got '%c'\n",
failpath, info_to_arg[call->type]);
call->fail = cisupper(*(failpath++));
if (call->fail)
call->can_leak = false;
return call->fail;
}
......@@ -528,7 +621,6 @@ static bool should_fail(struct failtest_call *call)
enum info_type type = UNEXPECTED;
char *out = NULL;
size_t outlen = 0;
struct saved_file *files;
struct failtest_call *dup;
if (call == &unrecorded_call)
......@@ -594,13 +686,17 @@ static bool should_fail(struct failtest_call *call)
/* Add it to our table of calls. */
failtable_add(&failtable, call);
files = save_files();
/* We're going to fail in the child. */
call->fail = true;
if (pipe(control) != 0 || pipe(output) != 0)
err(1, "opening pipe");
/* Move out the way, to high fds. */
control[0] = move_fd_to_high(control[0]);
control[1] = move_fd_to_high(control[1]);
output[0] = move_fd_to_high(output[0]);
output[1] = move_fd_to_high(output[1]);
/* Prevent double-printing (in child and parent) */
fflush(stdout);
child = fork();
......@@ -628,6 +724,9 @@ static bool should_fail(struct failtest_call *call)
trace("%s", c->file);
trace(":%u)\n", c->line);
}
/* From here on, we have to clean up! */
our_history_start = tlist_tail(&history, struct failtest_call,
list);
close(control[0]);
close(output[0]);
dup2(output[1], STDOUT_FILENO);
......@@ -635,8 +734,16 @@ static bool should_fail(struct failtest_call *call)
if (output[1] != STDOUT_FILENO && output[1] != STDERR_FILENO)
close(output[1]);
control_fd = move_fd_to_high(control[1]);
/* Valgrind spots the leak if we don't free these. */
free_files(files);
/* Forget any of our parent's saved files. */
free_mmapped_files(false);
/* Now, save any files we need to. */
save_mmapped_files();
/* Failed calls can't leak. */
call->can_leak = false;
return true;
}
......@@ -713,8 +820,6 @@ static bool should_fail(struct failtest_call *call)
free(out);
signal(SIGUSR1, SIG_DFL);
restore_files(files);
/* Only child does probe. */
probing = false;
......@@ -723,7 +828,7 @@ static bool should_fail(struct failtest_call *call)
return false;
}
static void cleanup_calloc(struct calloc_call *call)
static void cleanup_calloc(struct calloc_call *call, bool restore)
{
free(call->ret);
}
......@@ -735,7 +840,7 @@ void *failtest_calloc(size_t nmemb, size_t size,
struct calloc_call call;
call.nmemb = nmemb;
call.size = size;
p = add_history(FAILTEST_CALLOC, file, line, &call);
p = add_history(FAILTEST_CALLOC, true, file, line, &call);
if (should_fail(p)) {
p->u.calloc.ret = NULL;
......@@ -748,7 +853,7 @@ void *failtest_calloc(size_t nmemb, size_t size,
return p->u.calloc.ret;
}
static void cleanup_malloc(struct malloc_call *call)
static void cleanup_malloc(struct malloc_call *call, bool restore)
{
free(call->ret);
}
......@@ -759,7 +864,7 @@ void *failtest_malloc(size_t size, const char *file, unsigned line)
struct malloc_call call;
call.size = size;
p = add_history(FAILTEST_MALLOC, file, line, &call);
p = add_history(FAILTEST_MALLOC, true, file, line, &call);
if (should_fail(p)) {
p->u.malloc.ret = NULL;
p->error = ENOMEM;
......@@ -771,7 +876,7 @@ void *failtest_malloc(size_t size, const char *file, unsigned line)
return p->u.malloc.ret;
}
static void cleanup_realloc(struct realloc_call *call)
static void cleanup_realloc(struct realloc_call *call, bool restore)
{
free(call->ret);
}
......@@ -787,18 +892,21 @@ static void fixup_ptr_history(void *ptr)
case FAILTEST_REALLOC:
if (i->u.realloc.ret == ptr) {
i->cleanup = NULL;
i->can_leak = false;
return;
}
break;
case FAILTEST_MALLOC:
if (i->u.malloc.ret == ptr) {
i->cleanup = NULL;
i->can_leak = false;
return;
}
break;
case FAILTEST_CALLOC:
if (i->u.calloc.ret == ptr) {
i->cleanup = NULL;
i->can_leak = false;
return;
}
break;
......@@ -813,7 +921,7 @@ void *failtest_realloc(void *ptr, size_t size, const char *file, unsigned line)
struct failtest_call *p;
struct realloc_call call;
call.size = size;
p = add_history(FAILTEST_REALLOC, file, line, &call);
p = add_history(FAILTEST_REALLOC, true, file, line, &call);
/* FIXME: Try one child moving allocation, one not. */
if (should_fail(p)) {
......@@ -839,9 +947,51 @@ void failtest_free(void *ptr)
free(ptr);
}
static void cleanup_open(struct open_call *call)
static struct contents_saved *save_file(const char *pathname)
{
int fd;
struct contents_saved *s;
fd = open(pathname, O_RDONLY);
if (fd < 0)
return NULL;
s = save_contents(fd, lseek(fd, 0, SEEK_END), 0);
close(fd);
return s;
}
/* Optimization: don't create a child for an open which *we know*
* would fail anyway. */
static bool open_would_fail(const char *pathname, int flags)
{
if ((flags & O_ACCMODE) == O_RDONLY)
return access(pathname, R_OK) != 0;
if (!(flags & O_CREAT)) {
if ((flags & O_ACCMODE) == O_WRONLY)
return access(pathname, W_OK) != 0;
if ((flags & O_ACCMODE) == O_RDWR)
return access(pathname, W_OK) != 0
|| access(pathname, R_OK) != 0;
}
/* FIXME: We could check if it exists, for O_CREAT|O_EXCL */
return false;
}
static void cleanup_open(struct open_call *call, bool restore)
{
if (restore && call->saved)
restore_contents(container_of(call, struct failtest_call,
u.open),
call->saved, false, "open with O_TRUNC");
if (!call->closed) {
trace("Cleaning up open %s by closing fd %i\n",
call->pathname, call->ret);
close(call->ret);
call->closed = true;
}
free(call->saved);
}
int failtest_open(const char *pathname,
......@@ -854,33 +1004,49 @@ int failtest_open(const char *pathname,
call.pathname = strdup(pathname);
va_start(ap, line);
call.flags = va_arg(ap, int);
call.always_save = false;
call.closed = false;
if (call.flags & O_CREAT) {
call.mode = va_arg(ap, int);
va_end(ap);
}
p = add_history(FAILTEST_OPEN, file, line, &call);
p = add_history(FAILTEST_OPEN, true, file, line, &call);
/* Avoid memory leak! */
if (p == &unrecorded_call)
free((char *)call.pathname);
p->u.open.ret = open(pathname, call.flags, call.mode);
if (p->u.open.ret == -1) {
if (following_path())
follow_path(p);
p->fail = false;
p->error = errno;
} else if (should_fail(p)) {
close(p->u.open.ret);
if (should_fail(p)) {
/* Don't bother inserting failures that would happen anyway. */
if (open_would_fail(pathname, call.flags))
failtest_cleanup(true, 0);
p->u.open.ret = -1;
/* FIXME: Play with error codes? */
p->error = EACCES;
} else {
/* Save the old version if they're truncating it. */
if (call.flags & O_TRUNC)
p->u.open.saved = save_file(pathname);
else
p->u.open.saved = NULL;
p->u.open.ret = open(pathname, call.flags, call.mode);
if (p->u.open.ret == -1) {
p->u.open.closed = true;
p->can_leak = false;
} else {
set_cleanup(p, cleanup_open, struct open_call);
}
}
errno = p->error;
return p->u.open.ret;
}
static void cleanup_mmap(struct mmap_call *mmap, bool restore)
{
if (restore)
restore_contents(mmap->opener, mmap->saved, false, "mmap");
free(mmap->saved);
}
void *failtest_mmap(void *addr, size_t length, int prot, int flags,
int fd, off_t offset, const char *file, unsigned line)
{
......@@ -893,19 +1059,36 @@ void *failtest_mmap(void *addr, size_t length, int prot, int flags,
call.flags = flags;
call.offset = offset;
call.fd = fd;
call.opener = opener_of(fd);
p = add_history(FAILTEST_MMAP, file, line, &call);
/* If we don't know what file it was, don't fail. */
if (!call.opener) {
if (fd != -1) {
fwarnx("failtest_mmap: couldn't figure out source for"
" fd %i at %s:%u", fd, file, line);
}
return mmap(addr, length, prot, flags, fd, offset);
}
p = add_history(FAILTEST_MMAP, false, file, line, &call);
if (should_fail(p)) {
p->u.mmap.ret = MAP_FAILED;
p->error = ENOMEM;
} else {
p->u.mmap.ret = mmap(addr, length, prot, flags, fd, offset);
/* Save contents if we're writing to a normal file */
if (p->u.mmap.ret != MAP_FAILED
&& (prot & PROT_WRITE)
&& call.opener->type == FAILTEST_OPEN) {
p->u.mmap.saved = save_contents(fd, length, offset);
set_cleanup(p, cleanup_mmap, struct mmap_call);
}
}
errno = p->error;
return p->u.mmap.ret;
}
static void cleanup_pipe(struct pipe_call *call)
static void cleanup_pipe(struct pipe_call *call, bool restore)
{
if (!call->closed[0])
close(call->fds[0]);
......@@ -918,7 +1101,7 @@ int failtest_pipe(int pipefd[2], const char *file, unsigned line)
struct failtest_call *p;
struct pipe_call call;
p = add_history(FAILTEST_PIPE, file, line, &call);
p = add_history(FAILTEST_PIPE, true, file, line, &call);
if (should_fail(p)) {
p->u.open.ret = -1;
/* FIXME: Play with error codes? */
......@@ -934,8 +1117,18 @@ int failtest_pipe(int pipefd[2], const char *file, unsigned line)
return p->u.pipe.ret;
}
ssize_t failtest_pread(int fd, void *buf, size_t count, off_t off,
const char *file, unsigned line)
static void cleanup_read(struct read_call *call, bool restore)
{
if (restore) {
/* Read (not readv!) moves file offset! */
if (lseek(call->fd, call->off, SEEK_SET) != call->off) {
fwarn("Restoring lseek pointer failed (read)");
}
}
}
static ssize_t failtest_add_read(int fd, void *buf, size_t count, off_t off,
bool is_pread, const char *file, unsigned line)
{
struct failtest_call *p;
struct read_call call;
......@@ -943,20 +1136,36 @@ ssize_t failtest_pread(int fd, void *buf, size_t count, off_t off,
call.buf = buf;
call.count = count;
call.off = off;
p = add_history(FAILTEST_READ, file, line, &call);
p = add_history(FAILTEST_READ, false, file, line, &call);
/* FIXME: Try partial read returns. */
if (should_fail(p)) {
p->u.read.ret = -1;
p->error = EIO;
} else {
if (is_pread)
p->u.read.ret = pread(fd, buf, count, off);
else {
p->u.read.ret = read(fd, buf, count);
if (p->u.read.ret != -1)
set_cleanup(p, cleanup_read, struct read_call);
}
}
errno = p->error;
return p->u.read.ret;
}
ssize_t failtest_pwrite(int fd, const void *buf, size_t count, off_t off,
static void cleanup_write(struct write_call *write, bool restore)
{
if (restore)
restore_contents(write->opener, write->saved, !write->is_pwrite,
"write");
free(write->saved);
}
static ssize_t failtest_add_write(int fd, const void *buf,
size_t count, off_t off,
bool is_pwrite,
const char *file, unsigned line)
{
struct failtest_call *p;
......@@ -966,7 +1175,9 @@ ssize_t failtest_pwrite(int fd, const void *buf, size_t count, off_t off,
call.buf = buf;
call.count = count;
call.off = off;
p = add_history(FAILTEST_WRITE, file, line, &call);
call.is_pwrite = is_pwrite;
call.opener = opener_of(fd);
p = add_history(FAILTEST_WRITE, false, file, line, &call);
/* If we're a child, we need to make sure we write the same thing
* to non-files as the parent does, so tell it. */
......@@ -983,8 +1194,19 @@ ssize_t failtest_pwrite(int fd, const void *buf, size_t count, off_t off,
p->u.write.ret = -1;
p->error = EIO;
} else {
bool is_file;
assert(call.opener == p->u.write.opener);
if (p->u.write.opener) {
is_file = (p->u.write.opener->type == FAILTEST_OPEN);
} else {
/* We can't unwind it, so at least check same
* in parent and child. */
is_file = false;
}
/* FIXME: We assume same write order in parent and child */
if (off == (off_t)-1 && child_writes_num != 0) {
if (!is_file && child_writes_num != 0) {
if (child_writes[0].fd != fd)
errx(1, "Child wrote to fd %u, not %u?",
child_writes[0].fd, fd);
......@@ -1005,31 +1227,51 @@ ssize_t failtest_pwrite(int fd, const void *buf, size_t count, off_t off,
memmove(&child_writes[0], &child_writes[1],
sizeof(child_writes[0]) * child_writes_num);
/* Is this is a socket or pipe, child wrote it
already. */
if (p->u.write.off == (off_t)-1) {
/* Child wrote it already. */
p->u.write.ret = count;
errno = p->error;
return p->u.write.ret;
}
if (is_file) {
p->u.write.saved = save_contents(fd, count, off);
set_cleanup(p, cleanup_write, struct write_call);
}
/* Though off is current seek ptr for write case, we need to
* move it. write() does that for us. */
if (p->u.write.is_pwrite)
p->u.write.ret = pwrite(fd, buf, count, off);
else
p->u.write.ret = write(fd, buf, count);
}
errno = p->error;
return p->u.write.ret;
}
ssize_t failtest_read(int fd, void *buf, size_t count,
ssize_t failtest_pwrite(int fd, const void *buf, size_t count, off_t offset,
const char *file, unsigned line)
{
return failtest_pread(fd, buf, count, lseek(fd, 0, SEEK_CUR),
file, line);
return failtest_add_write(fd, buf, count, offset, true, file, line);
}
ssize_t failtest_write(int fd, const void *buf, size_t count,
const char *file, unsigned line)
{
return failtest_pwrite(fd, buf, count, lseek(fd, 0, SEEK_CUR),
return failtest_add_write(fd, buf, count, lseek(fd, 0, SEEK_CUR), false,
file, line);
}
ssize_t failtest_pread(int fd, void *buf, size_t count, off_t off,
const char *file, unsigned line)
{
return failtest_add_read(fd, buf, count, off, true, file, line);
}
ssize_t failtest_read(int fd, void *buf, size_t count,
const char *file, unsigned line)
{
return failtest_add_read(fd, buf, count, lseek(fd, 0, SEEK_CUR), false,
file, line);
}
......@@ -1099,12 +1341,14 @@ add_lock(struct lock_info *locks, int fd, off_t start, off_t end, int type)
/* We trap this so we can record it: we don't fail it. */
int failtest_close(int fd, const char *file, unsigned line)
{
struct failtest_call *i;
struct close_call call;
struct failtest_call *p;
struct failtest_call *p, *opener;
/* Do this before we add ourselves to history! */
opener = opener_of(fd);
call.fd = fd;
p = add_history(FAILTEST_CLOSE, file, line, &call);
p = add_history(FAILTEST_CLOSE, false, file, line, &call);
p->fail = false;
/* Consume close from failpath (shouldn't tell us to fail). */
......@@ -1116,40 +1360,61 @@ int failtest_close(int fd, const char *file, unsigned line)
if (fd < 0)
return close(fd);
/* Trace history to find source of fd. */
tlist_for_each_rev(&history, i, list) {
switch (i->type) {
case FAILTEST_PIPE:
/* Mark opener as not leaking, remove its cleanup function. */
if (opener) {
if (opener->type == FAILTEST_PIPE) {
/* From a pipe? */
if (i->u.pipe.fds[0] == fd) {
assert(!i->u.pipe.closed[0]);
i->u.pipe.closed[0] = true;
if (i->u.pipe.closed[1])
i->cleanup = NULL;
goto out;
}
if (i->u.pipe.fds[1] == fd) {
assert(!i->u.pipe.closed[1]);
i->u.pipe.closed[1] = true;
if (i->u.pipe.closed[0])
i->cleanup = NULL;
goto out;
if (opener->u.pipe.fds[0] == fd) {
assert(!opener->u.pipe.closed[0]);
opener->u.pipe.closed[0] = true;
} else if (opener->u.pipe.fds[1] == fd) {
assert(!opener->u.pipe.closed[1]);
opener->u.pipe.closed[1] = true;
} else
abort();
opener->can_leak = (!opener->u.pipe.closed[0]
|| !opener->u.pipe.closed[1]);
} else if (opener->type == FAILTEST_OPEN) {
opener->u.open.closed = true;
opener->can_leak = false;
} else
abort();
}
/* Restore offset now, in case parent shared (can't do after close!). */
if (control_fd != -1) {
struct failtest_call *i;
tlist_for_each_rev(&history, i, list) {
if (i == our_history_start)
break;
case FAILTEST_OPEN:
if (i->u.open.ret == fd) {
assert((void *)i->cleanup
== (void *)cleanup_open);
if (i == opener)
break;
if (i->type == FAILTEST_LSEEK && i->u.lseek.fd == fd) {
/* This seeks back. */
i->cleanup(&i->u, true);
i->cleanup = NULL;
} else if (i->type == FAILTEST_WRITE
&& i->u.write.fd == fd
&& !i->u.write.is_pwrite) {
/* Write (not pwrite!) moves file offset! */
if (lseek(fd, i->u.write.off, SEEK_SET)
!= i->u.write.off) {
fwarn("Restoring lseek pointer failed (write)");
}
} else if (i->type == FAILTEST_READ
&& i->u.read.fd == fd) {
/* preads don't *have* cleanups */
if (i->cleanup) {
/* This seeks back. */
i->cleanup(&i->u, true);
i->cleanup = NULL;
goto out;
}
break;
default:
break;
}
}
}
out:
/* Close unlocks everything. */
locks = add_lock(locks, fd, 0, off_max(), F_UNLCK);
return close(fd);
}
......@@ -1200,7 +1465,7 @@ int failtest_fcntl(int fd, const char *file, unsigned line, int cmd, ...)
err(1, "failtest: unknown fcntl %u", cmd);
}
p = add_history(FAILTEST_FCNTL, file, line, &call);
p = add_history(FAILTEST_FCNTL, false, file, line, &call);
if (should_fail(p)) {
p->u.fcntl.ret = -1;
......@@ -1229,6 +1494,41 @@ int failtest_fcntl(int fd, const char *file, unsigned line, int cmd, ...)
return p->u.fcntl.ret;
}
static void cleanup_lseek(struct lseek_call *call, bool restore)
{
if (restore) {
if (lseek(call->fd, call->old_off, SEEK_SET) != call->old_off)
fwarn("Restoring lseek pointer failed");
}
}
/* We trap this so we can undo it: we don't fail it. */
off_t failtest_lseek(int fd, off_t offset, int whence, const char *file,
unsigned int line)
{
struct failtest_call *p;
struct lseek_call call;
call.fd = fd;
call.offset = offset;
call.whence = whence;
call.old_off = lseek(fd, 0, SEEK_CUR);
p = add_history(FAILTEST_LSEEK, false, file, line, &call);
p->fail = false;
/* Consume lseek from failpath. */
if (failpath)
if (should_fail(p))
abort();
p->u.lseek.ret = lseek(fd, offset, whence);
if (p->u.lseek.ret != (off_t)-1)
set_cleanup(p, cleanup_lseek, struct lseek_call);
return p->u.lseek.ret;
}
pid_t failtest_getpid(const char *file, unsigned line)
{
/* You must call failtest_init first! */
......
ccan/failtest/failtest.h
View file @ 67bbee53
......@@ -48,6 +48,7 @@ enum failtest_call_type {
FAILTEST_WRITE,
FAILTEST_FCNTL,
FAILTEST_MMAP,
FAILTEST_LSEEK
};
struct calloc_call {
......@@ -72,6 +73,10 @@ struct open_call {
const char *pathname;
int flags;
mode_t mode;
bool always_save;
bool closed;
/* This is used for O_TRUNC opens on existing files. */
struct contents_saved *saved;
};
struct close_call {
......@@ -98,6 +103,9 @@ struct write_call {
const void *buf;
size_t count;
off_t off;
bool is_pwrite;
struct failtest_call *opener;
struct contents_saved *saved;
};
struct fcntl_call {
......@@ -119,6 +127,16 @@ struct mmap_call {
int flags;
int fd;
off_t offset;
struct failtest_call *opener;
struct contents_saved *saved;
};
struct lseek_call {
ssize_t ret;
int fd;
off_t offset;
int whence;
off_t old_off;
};
/**
......@@ -147,7 +165,9 @@ struct failtest_call {
/* What we set errno to. */
int error;
/* How do we clean this up? */
void (*cleanup)(void *u);
void (*cleanup)(void *u, bool restore);
/* Should their program have cleaned up? */
bool can_leak;
/* Backtrace of call chain. */
void **backtrace;
unsigned int backtrace_num;
......@@ -163,6 +183,7 @@ struct failtest_call {
struct write_call write;
struct fcntl_call fcntl;
struct mmap_call mmap;
struct lseek_call lseek;
} u;
};
......
ccan/failtest/failtest_override.h
View file @ 67bbee53
......@@ -68,6 +68,10 @@
failtest_mmap((addr), (length), (prot), (flags), (fd), (offset), \
__FILE__, __LINE__)
#undef lseek
#define lseek(fd, offset, whence) \
failtest_lseek((fd), (offset), (whence), __FILE__, __LINE__)
/* Replacement of getpid (since failtest will fork). */
#undef getpid
#define getpid() failtest_getpid(__FILE__, __LINE__)
......
ccan/failtest/failtest_proto.h
View file @ 67bbee53
......@@ -23,6 +23,8 @@ ssize_t failtest_pwrite(int fd, const void *buf, size_t count, off_t offset,
const char *file, unsigned line);
void *failtest_mmap(void *addr, size_t length, int prot, int flags,
int fd, off_t offset, const char *file, unsigned line);
off_t failtest_lseek(int fd, off_t offset, int whence,
const char *file, unsigned line);
int failtest_close(int fd, const char *file, unsigned line);
int failtest_fcntl(int fd, const char *file, unsigned line, int cmd, ...);
pid_t failtest_getpid(const char *file, unsigned line);
......
ccan/failtest/failtest_undo.h
View file @ 67bbee53
......@@ -35,6 +35,10 @@
#define mmap(addr, length, prot, flags, fd, offset) \
failtest_mmap((addr), (length), (prot), (flags), (fd), (offset), NULL, 0)
#undef lseek
#define lseek(fd, off, whence) \
failtest_lseek((fd), (off), (whence), NULL, 0)
#undef close
#define close(fd) failtest_close(fd)
......
ccan/failtest/test/run-failpath.c
View file @ 67bbee53
#include <ccan/failtest/failtest.c>
#include <stdlib.h>
#include <setjmp.h>
#include <stdio.h>
#include <stdarg.h>
#include <ccan/tap/tap.h>
#include <ccan/failtest/failtest.c>
int main(void)
{
......
ccan/failtest/test/run-history.c
View file @ 67bbee53
/* Include the C files directly. */
#include <ccan/failtest/failtest.c>
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <ccan/tap/tap.h>
/* Include the C files directly. */
#include <ccan/failtest/failtest.c>
int main(void)
{
......@@ -15,18 +15,23 @@ int main(void)
struct pipe_call pipe_call;
struct read_call read_call;
struct write_call write_call;
struct mmap_call mmap_call;
char buf[20];
unsigned int i;
char *path;
/* This is how many tests you plan to run */
plan_tests(47);
plan_tests(69);
calloc_call.ret = calloc(1, 2);
calloc_call.nmemb = 1;
calloc_call.size = 2;
call = add_history(FAILTEST_CALLOC, "run-history.c", 1, &calloc_call);
call = add_history(FAILTEST_CALLOC, true,
"run-history.c", 1, &calloc_call);
/* Normally should_fail would set this. */
call->fail = false;
ok1(call->type == FAILTEST_CALLOC);
ok1(call->can_leak == true);
ok1(strcmp(call->file, "run-history.c") == 0);
ok1(call->line == 1);
ok1(call->u.calloc.ret == calloc_call.ret);
......@@ -35,8 +40,12 @@ int main(void)
malloc_call.ret = malloc(2);
malloc_call.size = 2;
call = add_history(FAILTEST_MALLOC, "run-history.c", 2, &malloc_call);
call = add_history(FAILTEST_MALLOC, true,
"run-history.c", 2, &malloc_call);
/* Normally should_fail would set this. */
call->fail = false;
ok1(call->type == FAILTEST_MALLOC);
ok1(call->can_leak == true);
ok1(strcmp(call->file, "run-history.c") == 0);
ok1(call->line == 2);
ok1(call->u.malloc.ret == malloc_call.ret);
......@@ -45,9 +54,12 @@ int main(void)
realloc_call.ret = realloc(malloc_call.ret, 3);
realloc_call.ptr = malloc_call.ret;
realloc_call.size = 3;
call = add_history(FAILTEST_REALLOC, "run-history.c", 3,
call = add_history(FAILTEST_REALLOC, true, "run-history.c", 3,
&realloc_call);
/* Normally should_fail would set this. */
call->fail = false;
ok1(call->type == FAILTEST_REALLOC);
ok1(call->can_leak == true);
ok1(strcmp(call->file, "run-history.c") == 0);
ok1(call->line == 3);
ok1(call->u.realloc.ret == realloc_call.ret);
......@@ -58,8 +70,12 @@ int main(void)
open_call.pathname = "test/run-history.c";
open_call.flags = O_RDONLY;
open_call.mode = 0;
call = add_history(FAILTEST_OPEN, "run-history.c", 4, &open_call);
open_call.closed = false;
call = add_history(FAILTEST_OPEN, true, "run-history.c", 4, &open_call);
/* Normally should_fail would set this. */
call->fail = false;
ok1(call->type == FAILTEST_OPEN);
ok1(call->can_leak == true);
ok1(strcmp(call->file, "run-history.c") == 0);
ok1(call->line == 4);
ok1(call->u.open.ret == open_call.ret);
......@@ -68,9 +84,12 @@ int main(void)
ok1(call->u.open.mode == open_call.mode);
pipe_call.ret = pipe(pipe_call.fds);
call = add_history(FAILTEST_PIPE, "run-history.c", 5, &pipe_call);
call = add_history(FAILTEST_PIPE, true, "run-history.c", 5, &pipe_call);
/* Normally should_fail would set this. */
call->fail = false;
ok1(call->type == FAILTEST_PIPE);
ok1(strcmp(call->file, "run-history.c") == 0);
ok1(call->can_leak == true);
ok1(call->line == 5);
ok1(call->u.pipe.ret == pipe_call.ret);
ok1(call->u.pipe.fds[0] == pipe_call.fds[0]);
......@@ -80,8 +99,11 @@ int main(void)
read_call.buf = buf;
read_call.fd = open_call.ret;
read_call.count = 20;
call = add_history(FAILTEST_READ, "run-history.c", 6, &read_call);
call = add_history(FAILTEST_READ, false, "run-history.c", 6, &read_call);
/* Normally should_fail would set this. */
call->fail = false;
ok1(call->type == FAILTEST_READ);
ok1(call->can_leak == false);
ok1(strcmp(call->file, "run-history.c") == 0);
ok1(call->line == 6);
ok1(call->u.read.ret == read_call.ret);
......@@ -93,33 +115,68 @@ int main(void)
write_call.buf = buf;
write_call.fd = open_call.ret;
write_call.count = 20;
call = add_history(FAILTEST_WRITE, "run-history.c", 7, &write_call);
write_call.opener = NULL;
call = add_history(FAILTEST_WRITE, false, "run-history.c", 7,
&write_call);
/* Normally should_fail would set this. */
call->fail = false;
ok1(call->type == FAILTEST_WRITE);
ok1(call->can_leak == false);
ok1(strcmp(call->file, "run-history.c") == 0);
ok1(call->line == 7);
ok1(call->u.write.ret == write_call.ret);
ok1(call->u.write.buf == write_call.buf);
ok1(call->u.write.fd == write_call.fd);
ok1(call->u.write.count == write_call.count);
ok1(call->u.write.opener == write_call.opener);
mmap_call.ret = &mmap_call;
mmap_call.addr = NULL;
mmap_call.length = 4096;
mmap_call.prot = PROT_READ;
mmap_call.flags = 0;
mmap_call.fd = open_call.ret;
mmap_call.offset = 0;
mmap_call.opener = opener_of(open_call.ret);
ok1(mmap_call.opener->type == FAILTEST_OPEN);
mmap_call.saved = NULL;
call = add_history(FAILTEST_MMAP, false, "run-history.c", 8,
&mmap_call);
/* Normally should_fail would set this. */
call->fail = false;
ok1(call->type == FAILTEST_MMAP);
ok1(call->can_leak == false);
ok1(strcmp(call->file, "run-history.c") == 0);
ok1(call->line == 8);
ok1(call->u.mmap.ret == mmap_call.ret);
ok1(call->u.mmap.addr == mmap_call.addr);
ok1(call->u.mmap.length == mmap_call.length);
ok1(call->u.mmap.prot == mmap_call.prot);
ok1(call->u.mmap.flags == mmap_call.flags);
ok1(call->u.mmap.fd == mmap_call.fd);
ok1(call->u.mmap.offset == mmap_call.offset);
ok1(call->u.mmap.opener == mmap_call.opener);
ok1(call->u.mmap.saved == mmap_call.saved);
i = 0;
tlist_for_each(&history, call, list)
i++;
ok1(i == 7);
ok1(i == 8);
tlist_for_each(&history, call, list)
call->fail = false;
path = failpath_string();
ok1(streq(path, "cmeoprw"));
ok1(streq(path, "cmeoprwa"));
free(path);
tlist_for_each(&history, call, list)
call->fail = true;
path = failpath_string();
ok1(streq(path, "CMEOPRW"));
ok1(streq(path, "CMEOPRWA"));
free(path);
return exit_status();
......
ccan/failtest/test/run-locking.c
View file @ 67bbee53
/* Include the C files directly. */
#include <ccan/failtest/failtest.c>
#include <stdlib.h>
#include <setjmp.h>
#include <stdio.h>
#include <stdarg.h>
#include <assert.h>
#include <ccan/tap/tap.h>
/* Include the C files directly. */
#include <ccan/failtest/failtest.c>
#define SIZE 8
......
ccan/failtest/test/run-malloc.c
View file @ 67bbee53
#include "config.h"
#include <stdlib.h>
#include <setjmp.h>
#include <stdio.h>
......
ccan/failtest/test/run-open.c
View file @ 67bbee53
/* Include the C files directly. */
#include <ccan/failtest/failtest.c>
#include <stdlib.h>
#include <setjmp.h>
#include <stdio.h>
#include <stdarg.h>
#include <assert.h>
#include <ccan/tap/tap.h>
/* Include the C files directly. */
#include <ccan/failtest/failtest.c>
int main(void)
{
......
ccan/failtest/test/run-write.c
View file @ 67bbee53
/* Include the C files directly. */
#include <ccan/failtest/failtest.c>
#include <stdlib.h>
#include <setjmp.h>
#include <stdio.h>
#include <stdarg.h>
#include <assert.h>
#include <ccan/tap/tap.h>
/* Include the C files directly. */
#include <ccan/failtest/failtest.c>
int main(int argc, char *argv[])
{
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment
GitLab Nexedi Edition | About GitLab | About Nexedi | 沪ICP备2021021310号-2 | 沪ICP备2021021310号-7