X-Git-Url: https://git.ozlabs.org/?p=ccan;a=blobdiff_plain;f=ccan%2Ffailtest%2Ffailtest.h;h=9af5669678f2295edccb5cbea4cb777016f40b8f;hp=0cc8f60c51ba15aa48e207c6088bfe4d39b70050;hb=HEAD;hpb=0a379f773681c7b3e53866b9a6e9cd0006012c1a

diff --git a/ccan/failtest/failtest.h b/ccan/failtest/failtest.h
index 0cc8f60c..9af56696 100644
--- a/ccan/failtest/failtest.h
+++ b/ccan/failtest/failtest.h
@@ -9,6 +9,7 @@
 #include <stdbool.h>
 #include <fcntl.h>
 #include <ccan/compiler/compiler.h>
+#include <ccan/tlist/tlist.h>
 
 /**
  * failtest_init - initialize the failtest module
@@ -46,6 +47,8 @@ enum failtest_call_type {
 	FAILTEST_READ,
 	FAILTEST_WRITE,
 	FAILTEST_FCNTL,
+	FAILTEST_MMAP,
+	FAILTEST_LSEEK
 };
 
 struct calloc_call {
@@ -70,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 {
@@ -96,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 {
@@ -109,6 +119,26 @@ struct fcntl_call {
 	} arg;
 };
 
+struct mmap_call {
+	void *ret;
+	void *addr;
+	size_t length;
+	int prot;
+	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;
+};
+
 /**
  * struct failtest_call - description of a call redirected to failtest module
  * @type: the call type
@@ -124,6 +154,8 @@ struct fcntl_call {
  *	failtest_hook, failtest_exit_check
  */
 struct failtest_call {
+	/* We're in the history list. */
+	struct list_node list;
 	enum failtest_call_type type;
 	/* Where we were called from. */
 	const char *file;
@@ -133,7 +165,12 @@ 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;
 	/* The actual call data. */
 	union {
 		struct calloc_call calloc;
@@ -145,9 +182,14 @@ struct failtest_call {
 		struct read_call read;
 		struct write_call write;
 		struct fcntl_call fcntl;
+		struct mmap_call mmap;
+		struct lseek_call lseek;
 	} u;
 };
 
+/* This defines struct tlist_calls. */
+TLIST_TYPE(calls, struct failtest_call);
+
 enum failtest_result {
 	/* Yes try failing this call. */
 	FAIL_OK,
@@ -160,7 +202,6 @@ enum failtest_result {
 /**
  * failtest_hook - whether a certain call should fail or not.
  * @history: the ordered history of all failtest calls.
- * @num: the number of elements in @history (greater than 0)
  *
  * The default value of this hook is failtest_default_hook(), which returns
  * FAIL_OK (ie. yes, fail the call).
@@ -170,25 +211,24 @@ enum failtest_result {
  * call.
  *
  * Example:
- *	static enum failtest_result dont_fail_alloc(struct failtest_call *hist,
- *						    unsigned num)
+ *	static enum failtest_result dont_fail_alloc(struct tlist_calls *history)
  *	{
- *		if (hist[num-1].type == FAILTEST_MALLOC
- *			|| hist[num-1].type == FAILTEST_CALLOC
- *			|| hist[num-1].type == FAILTEST_REALLOC)
+ *		struct failtest_call *call;
+ *		call = tlist_tail(history, list);
+ *		if (call->type == FAILTEST_MALLOC
+ *			|| call->type == FAILTEST_CALLOC
+ *			|| call->type == FAILTEST_REALLOC)
  *			return FAIL_DONT_FAIL;
  *		return FAIL_OK;
  *	}
  *	...
  *		failtest_hook = dont_fail_alloc;
  */
-extern enum failtest_result
-(*failtest_hook)(struct failtest_call *history, unsigned num);
+extern enum failtest_result (*failtest_hook)(struct tlist_calls *history);
 
 /**
  * failtest_exit_check - hook for additional checks on a failed child.
  * @history: the ordered history of all failtest calls.
- * @num: the number of elements in @history (greater than 0)
  *
  * Your program might have additional checks to do on failure, such as
  * check that a file is not corrupted, or than an error message has been
@@ -197,16 +237,15 @@ extern enum failtest_result
  * If this returns false, the path to this failure will be printed and the
  * overall test will fail.
  */
-extern bool (*failtest_exit_check)(struct failtest_call *history,
-				   unsigned num);
+extern bool (*failtest_exit_check)(struct tlist_calls *history);
 
 /**
  * failtest_has_failed - determine if a failure has occurred.
  *
- * Sometimes you want to exit immediately if you've experienced a failure.
- * This is useful when you have four separate tests in your test suite,
- * and you don't want to do the next one if you've had a failure in a
- * previous one.
+ * Sometimes you want to exit immediately if you've experienced an
+ * injected failure.  This is useful when you have four separate tests
+ * in your test suite, and you don't want to do the next one if you've
+ * had a failure in a previous one.
  */
 extern bool failtest_has_failed(void);