+/* Licensed under LGPL - see LICENSE file for details */
#ifndef CCAN_FAILTEST_H
#define CCAN_FAILTEST_H
#include "config.h"
+#if HAVE_FILE_OFFSET_BITS
+#define _FILE_OFFSET_BITS 64
+#endif
#include <sys/types.h>
#include <stdbool.h>
#include <fcntl.h>
#include <ccan/compiler/compiler.h>
+#include <ccan/tlist/tlist.h>
/**
* failtest_init - initialize the failtest module
* 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;
int error;
/* How do we clean this up? */
void (*cleanup)(void *u);
+ /* Backtrace of call chain. */
+ void **backtrace;
+ unsigned int backtrace_num;
/* The actual call data. */
union {
struct calloc_call calloc;
} u;
};
+/* This defines struct tlist_calls. */
+TLIST_TYPE(calls, struct failtest_call);
+
enum failtest_result {
/* Yes try failing this call. */
FAIL_OK,
/**
* 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).
* 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, struct failtest_call, 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
* 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 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);
/**
* failtest_timeout_ms - how long to wait before killing child.