1 #ifndef CCAN_FAILTEST_H
2 #define CCAN_FAILTEST_H
6 #include <ccan/compiler/compiler.h>
9 * failtest_init - initialize the failtest module
10 * @argc: the number of commandline arguments
11 * @argv: the commandline argument array
13 * This initializes the module, and in particular if argv[1] is "--failpath="
14 * then it ensures that failures follow that pattern. This allows easy
15 * debugging of complex failure paths.
17 void failtest_init(int argc, char *argv[]);
20 * failtest_exit - clean up and exit the test
21 * @status: the status (usually exit_status() from ccan/tap).
23 * This cleans up and changes to files made in this child, and exits the test.
24 * It also calls your failtest_default_hook, if any.
26 * A child which does not exit via failtest_exit() will cause the overall test
29 void NORETURN failtest_exit(int status);
32 * enum failtest_call_type - discriminator for failtest_call.u
34 enum failtest_call_type {
103 * struct failtest_call - description of a call redirected to failtest module
104 * @type: the call type
105 * @file: the filename of the caller
106 * @line: the line number of the caller
107 * @fail: did this call fail
108 * @error: the errno (if any)
109 * @u: the union of call data
111 * This structure is used to represent the ordered history of calls.
114 * failtest_hook, failtest_exit_check
116 struct failtest_call {
117 enum failtest_call_type type;
118 /* Where we were called from. */
123 /* What we set errno to. */
125 /* How do we clean this up? */
126 void (*cleanup)(void *u);
127 /* The actual call data. */
129 struct calloc_call calloc;
130 struct malloc_call malloc;
131 struct realloc_call realloc;
132 struct open_call open;
133 struct pipe_call pipe;
134 struct read_call read;
135 struct write_call write;
136 struct fcntl_call fcntl;
141 * failtest_hook - whether a certain call should fail or not.
142 * @history: the ordered history of all failtest calls.
143 * @num: the number of elements in @history (greater than 0)
145 * The default value of this hook is failtest_default_hook(), which returns
146 * true (ie. yes, fail the call).
148 * You can override it, and avoid failing certain calls. The parameters
149 * of the call (but not the return value(s)) will be filled in for the last
153 * static bool dont_fail_allocations(struct failtest_call *history,
156 * return history[num-1].type != FAILTEST_MALLOC
157 * && history[num-1].type != FAILTEST_CALLOC
158 * && history[num-1].type != FAILTEST_REALLOC;
161 * failtest_hook = dont_fail_allocations;
163 extern bool (*failtest_hook)(struct failtest_call *history, unsigned num);
166 * failtest_exit_check - hook for additional checks on a failed child.
167 * @history: the ordered history of all failtest calls.
168 * @num: the number of elements in @history (greater than 0)
170 * Your program might have additional checks to do on failure, such as
171 * check that a file is not corrupted, or than an error message has been
174 * If this returns false, the path to this failure will be printed and the
175 * overall test will fail.
177 extern bool (*failtest_exit_check)(struct failtest_call *history,
180 /* This usually fails the call. */
181 bool failtest_default_hook(struct failtest_call *history, unsigned num);
184 * failtest_timeout_ms - how long to wait before killing child.
186 * Default is 20,000 (20 seconds).
188 extern unsigned int failtest_timeout_ms;
189 #endif /* CCAN_FAILTEST_H */