jmap: fix jmap_free, tests.
[ccan] / ccan / failtest / failtest.c
index ccc89b22f344bbdde2b193f6c33cb91c26f75692..91420dc699b9c7fdf7f40171b1e39d5fbb7d7ef3 100644 (file)
@@ -1,3 +1,5 @@
+/* Licensed under LGPL - see LICENSE file for details */
+#include "config.h"
 #include <stdarg.h>
 #include <string.h>
 #include <stdio.h>
 #include <sys/wait.h>
 #include <sys/stat.h>
 #include <sys/time.h>
+#include <signal.h>
 #include <assert.h>
 #include <ccan/read_write_all/read_write_all.h>
 #include <ccan/failtest/failtest_proto.h>
 #include <ccan/failtest/failtest.h>
 #include <ccan/build_assert/build_assert.h>
 
-bool (*failtest_hook)(struct failtest_call *history, unsigned num)
-= failtest_default_hook;
+enum failtest_result (*failtest_hook)(struct failtest_call *, unsigned);
 
 static int tracefd = -1;
 
@@ -48,6 +50,7 @@ static struct failtest_call *history = NULL;
 static unsigned int history_num = 0;
 static int control_fd = -1;
 static struct timeval start;
+static unsigned int probe_count = 0;
 
 static struct write_call *child_writes = NULL;
 static unsigned int child_writes_num = 0;
@@ -56,7 +59,9 @@ static pid_t lock_owner;
 static struct lock_info *locks = NULL;
 static unsigned int lock_num = 0;
 
-static const char info_to_arg[] = "mceoprwf";
+static pid_t orig_pid;
+
+static const char info_to_arg[] = "mceoxprwf";
 
 /* Dummy call used for failtest_undo wrappers. */
 static struct failtest_call unrecorded_call;
@@ -83,13 +88,9 @@ static struct failtest_call *add_history_(enum failtest_call_type type,
 #define add_history(type, file, line, elem) \
        add_history_((type), (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)), (clean))
-
-bool failtest_default_hook(struct failtest_call *history, unsigned num)
-{
-       return true;
-}
+       (call)->cleanup = (void *)((void)sizeof(clean((type *)NULL),1), (clean))
 
 static bool read_write_info(int fd)
 {
@@ -147,11 +148,23 @@ static void child_fail(const char *out, size_t outlen, const char *fmt, ...)
        exit(1);
 }
 
+static void trace(const char *fmt, ...)
+{
+       va_list ap;
+
+       if (tracefd == -1)
+               return;
+
+       va_start(ap, fmt);
+       vdprintf(tracefd, fmt, ap);
+       va_end(ap);
+}
+
 static pid_t child;
 
-static void hand_down(int signal)
+static void hand_down(int signum)
 {
-       kill(child, signal);
+       kill(child, signum);
 }
 
 static void release_locks(void)
@@ -220,18 +233,6 @@ static void get_locks(void)
        lock_owner = getpid();
 }
 
-static void trace_str(const char *str)
-{
-       ssize_t ret;
-
-       while ((ret = write(tracefd, str, strlen(str))) <= 0) {
-               str += ret;
-               if (!*str)
-                       return;
-       }
-       err(1, "Writing trace.");
-}
-
 struct saved_file {
        struct saved_file *next;
        int fd;
@@ -251,7 +252,8 @@ static struct saved_file *save_file(struct saved_file *next, int fd)
        s->len = lseek(fd, 0, SEEK_END);
        lseek(fd, 0, SEEK_SET);
        s->contents = malloc(s->len);
-       read(fd, s->contents, 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);
        return s;
 }
@@ -296,8 +298,11 @@ static void restore_files(struct saved_file *s)
                struct saved_file *next = s->next;
 
                lseek(s->fd, 0, SEEK_SET);
-               write(s->fd, s->contents, s->len);
-               ftruncate(s->fd, s->len);
+               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);
@@ -305,6 +310,48 @@ static void restore_files(struct saved_file *s)
        }
 }
 
+/* Free up memory, so valgrind doesn't report leaks. */
+static void free_everything(void)
+{
+       unsigned int i;
+
+       /* We don't do this in cleanup: needed even for failed opens. */
+       for (i = 0; i < history_num; i++) {
+               if (history[i].type == FAILTEST_OPEN)
+                       free((char *)history[i].u.open.pathname);
+       }
+       free(history);
+}
+
+static NORETURN void failtest_cleanup(bool forced_cleanup, int status)
+{
+       int i;
+
+       /* For children, we don't care if they "failed" the testing. */
+       if (control_fd != -1)
+               status = 0;
+
+       if (forced_cleanup)
+               history_num--;
+
+       /* Cleanup everything, in reverse order. */
+       for (i = history_num - 1; i >= 0; i--) {
+               if (!history[i].cleanup)
+                       continue;
+               if (!forced_cleanup) {
+                       printf("Leak at %s:%u: --failpath=%s\n",
+                              history[i].file, history[i].line,
+                              failpath_string());
+                       status = 1;
+               }
+               history[i].cleanup(&history[i].u);
+       }
+
+       free_everything();
+       tell_parent(SUCCESS);
+       exit(status);
+}
+
 static bool should_fail(struct failtest_call *call)
 {
        int status;
@@ -314,6 +361,10 @@ static bool should_fail(struct failtest_call *call)
        size_t outlen = 0;
        struct saved_file *files;
 
+       /* Are we probing? */
+       if (probe_count && --probe_count == 0 && control_fd != -1)
+               failtest_cleanup(true, 0);
+
        if (call == &unrecorded_call)
                return false;
 
@@ -321,11 +372,15 @@ static bool should_fail(struct failtest_call *call)
                /* + means continue after end, like normal. */
                if (*failpath == '+')
                        failpath = NULL;
-               else {
-                       if (tolower(*failpath) != info_to_arg[call->type])
+               else if (*failpath == '\0') {
+                       /* Continue, but don't inject errors. */
+                       return call->fail = false;
+               } else {
+                       if (tolower((unsigned char)*failpath)
+                           != info_to_arg[call->type])
                                errx(1, "Failpath expected '%c' got '%c'\n",
                                     info_to_arg[call->type], *failpath);
-                       call->fail = isupper(*(failpath++));
+                       call->fail = isupper((unsigned char)*(failpath++));
                        return call->fail;
                }
        }
@@ -335,7 +390,7 @@ static bool should_fail(struct failtest_call *call)
                unsigned int i;
 
                for (i = 0; i < history_num; i++) {
-                       char c = info_to_arg[history[i].type];
+                       unsigned char c = info_to_arg[history[i].type];
                        if (history[i].fail)
                                c = toupper(c);
                        if (c != debugpath[i])
@@ -348,14 +403,34 @@ static bool should_fail(struct failtest_call *call)
                        signal(SIGUSR1, SIG_IGN);
                        sprintf(str, "xterm -e gdb /proc/%d/exe %d &",
                                getpid(), getpid());
-                       system(str);
-                       sleep(5);
+                       if (system(str) == 0)
+                               sleep(5);
                }
        }
 
-       if (!failtest_hook(history, history_num)) {
-               call->fail = false;
-               return false;
+       if (failtest_hook) {
+               switch (failtest_hook(history, history_num)) {
+               case FAIL_OK:
+                       break;
+               case FAIL_PROBE:
+                       /* Already down probe path?  Stop now. */
+                       if (!probe_count) {
+                               /* FIXME: We should run *parent* and
+                                * run probe until calls match up again. */
+                               probe_count = 3;
+                               break;
+                       } else {
+                               /* Child should give up now. */
+                               if (control_fd != -1)
+                                       failtest_cleanup(true, 0);
+                               /* Parent, don't fail again. */
+                       }
+               case FAIL_DONT_FAIL:
+                       call->fail = false;
+                       return false;
+               default:
+                       abort();
+               }
        }
 
        files = save_files();
@@ -374,7 +449,7 @@ static bool should_fail(struct failtest_call *call)
        if (child == 0) {
                if (tracefd != -1) {
                        struct timeval now;
-                       char str[50], *p;
+                       const char *p;
                        gettimeofday(&now, NULL);
                        if (now.tv_usec < start.tv_usec) {
                                now.tv_sec--;
@@ -382,20 +457,16 @@ static bool should_fail(struct failtest_call *call)
                        }
                        now.tv_usec -= start.tv_usec;
                        now.tv_sec -= start.tv_sec;
-                       sprintf(str, "%u (%u.%02u): ", getpid(),
-                               (int)now.tv_sec, (int)now.tv_usec / 10000);
-                       trace_str(str);
                        p = failpath_string();
-                       trace_str(p);
-                       free(p);
-                       trace_str("(");
-                       p = strchr(history[history_num-1].file, '/');
+                       trace("%u->%u (%u.%02u): %s (", getppid(), getpid(),
+                             (int)now.tv_sec, (int)now.tv_usec / 10000, p);
+                       free((char *)p);
+                       p = strrchr(history[history_num-1].file, '/');
                        if (p)
-                               trace_str(p+1);
+                               trace("%s", p+1);
                        else
-                               trace_str(history[history_num-1].file);
-                       sprintf(str, ":%u)\n", history[history_num-1].line);
-                       trace_str(str);
+                               trace("%s", history[history_num-1].file);
+                       trace(":%u)\n", history[history_num-1].line);
                }
                close(control[0]);
                close(output[0]);
@@ -428,8 +499,13 @@ static bool should_fail(struct failtest_call *call)
                else
                        ret = poll(pfd, 2, failtest_timeout_ms);
 
-               if (ret <= 0)
+               if (ret == 0)
                        hand_down(SIGUSR1);
+               if (ret < 0) {
+                       if (errno == EINTR)
+                               continue;
+                       err(1, "Poll returned %i", ret);
+               }
 
                if (pfd[0].revents & POLLIN) {
                        ssize_t len;
@@ -609,7 +685,7 @@ int failtest_open(const char *pathname,
        va_start(ap, line);
        call.flags = va_arg(ap, int);
        if (call.flags & O_CREAT) {
-               call.mode = va_arg(ap, mode_t);
+               call.mode = va_arg(ap, int);
                va_end(ap);
        }
        p = add_history(FAILTEST_OPEN, file, line, &call);
@@ -825,9 +901,20 @@ 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)
+int failtest_close(int fd, const char *file, unsigned line)
 {
        int i;
+       struct close_call call;
+       struct failtest_call *p;
+
+       call.fd = fd;
+       p = add_history(FAILTEST_CLOSE, file, line, &call);
+       p->fail = false;
+
+       /* Consume close from failpath. */
+       if (failpath)
+               if (should_fail(p))
+                       abort();
 
        if (fd < 0)
                return close(fd);
@@ -917,7 +1004,6 @@ int failtest_fcntl(int fd, const char *file, unsigned line, int cmd, ...)
        }
 
        p = add_history(FAILTEST_FCNTL, file, line, &call);
-       get_locks();
 
        if (should_fail(p)) {
                p->u.fcntl.ret = -1;
@@ -926,6 +1012,7 @@ int failtest_fcntl(int fd, const char *file, unsigned line, int cmd, ...)
                else
                        p->error = EDEADLK;
        } else {
+               get_locks();
                p->u.fcntl.ret = fcntl(p->u.fcntl.fd, p->u.fcntl.cmd,
                                       &p->u.fcntl.arg.fl);
                if (p->u.fcntl.ret == -1)
@@ -945,10 +1032,19 @@ int failtest_fcntl(int fd, const char *file, unsigned line, int cmd, ...)
        return p->u.fcntl.ret;
 }
 
+pid_t failtest_getpid(const char *file, unsigned line)
+{
+       /* You must call failtest_init first! */
+       assert(orig_pid);
+       return orig_pid;
+}
+       
 void failtest_init(int argc, char *argv[])
 {
        unsigned int i;
 
+       orig_pid = getpid();
+               
        for (i = 1; i < argc; i++) {
                if (!strncmp(argv[i], "--failpath=", strlen("--failpath="))) {
                        failpath = argv[i] + strlen("--failpath=");
@@ -963,39 +1059,17 @@ void failtest_init(int argc, char *argv[])
        gettimeofday(&start, NULL);
 }
 
-/* Free up memory, so valgrind doesn't report leaks. */
-static void free_everything(void)
+bool failtest_has_failed(void)
 {
-       unsigned int i;
-
-       /* We don't do this in cleanup: needed even for failed opens. */
-       for (i = 0; i < history_num; i++) {
-               if (history[i].type == FAILTEST_OPEN)
-                       free((char *)history[i].u.open.pathname);
-       }
-       free(history);
+       return control_fd != -1;
 }
 
 void failtest_exit(int status)
 {
-       int i;
-
        if (failtest_exit_check) {
                if (!failtest_exit_check(history, history_num))
                        child_fail(NULL, 0, "failtest_exit_check failed\n");
        }
 
-       if (control_fd == -1) {
-               free_everything();
-               exit(status);
-       }
-
-       /* Cleanup everything, in reverse order. */
-       for (i = history_num - 1; i >= 0; i--)
-               if (history[i].cleanup)
-                       history[i].cleanup(&history[i].u);
-
-       free_everything();
-       tell_parent(SUCCESS);
-       exit(0);
+       failtest_cleanup(false, status);
 }