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 {
100 * struct failtest_call - description of a call redirected to failtest module
101 * @type: the call type
102 * @file: the filename of the caller
103 * @line: the line number of the caller
104 * @fail: did this call fail
105 * @error: the errno (if any)
106 * @u: the union of call data
108 * This structure is used to represent the ordered history of calls.
111 * failtest_hook, failtest_exit_check
113 struct failtest_call {
114 enum failtest_call_type type;
115 /* Where we were called from. */
120 /* What we set errno to. */
122 /* The actual call data. */
124 struct calloc_call calloc;
125 struct malloc_call malloc;
126 struct realloc_call realloc;
127 struct open_call open;
128 struct pipe_call pipe;
129 struct read_call read;
130 struct write_call write;
131 struct fcntl_call fcntl;
136 * failtest_hook - whether a certain call should fail or not.
137 * @history: the ordered history of all failtest calls.
138 * @num: the number of elements in @history (greater than 0)
140 * The default value of this hook is failtest_default_hook(), which returns
141 * true (ie. yes, fail the call).
143 * You can override it, and avoid failing certain calls. The parameters
144 * of the call (but not the return value(s)) will be filled in for the last
148 * static bool dont_fail_allocations(struct failtest_call *history,
151 * return history[num-1].type != FAILTEST_MALLOC
152 * && history[num-1].type != FAILTEST_CALLOC
153 * && history[num-1].type != FAILTEST_REALLOC;
156 * failtest_hook = dont_fail_allocations;
158 extern bool (*failtest_hook)(struct failtest_call *history, unsigned num);
161 * failtest_exit_check - hook for additional checks on a failed child.
162 * @history: the ordered history of all failtest calls.
163 * @num: the number of elements in @history (greater than 0)
165 * Your program might have additional checks to do on failure, such as
166 * check that a file is not corrupted, or than an error message has been
169 * If this returns false, the path to this failure will be printed and the
170 * overall test will fail.
172 extern bool (*failtest_exit_check)(struct failtest_call *history,
175 /* This usually fails the call. */
176 bool failtest_default_hook(struct failtest_call *history, unsigned num);
179 * failtest_timeout_ms - how long to wait before killing child.
181 * Default is 20,000 (20 seconds).
183 extern unsigned int failtest_timeout_ms;
184 #endif /* CCAN_FAILTEST_H */