2 * Copyright (c) 2009 Isilon Inc http://www.isilon.com/
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
7 * 1. Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
13 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * @ingroup failpoint_private
33 * @defgroup failpoint fail(9) Facility
35 * Failpoints allow for injecting fake errors into running code on the fly,
36 * without modifying code or recompiling with flags. Failpoints are always
37 * present, and are very efficient when disabled. Failpoints are described
41 * @defgroup failpoint_private Private fail(9) Implementation functions
43 * Private implementations for the actual failpoint code.
48 * @addtogroup failpoint_private
52 #include <sys/cdefs.h>
53 __FBSDID("$FreeBSD$");
55 #include <sys/ctype.h>
56 #include <sys/errno.h>
58 #include <sys/kernel.h>
59 #include <sys/libkern.h>
61 #include <sys/malloc.h>
62 #include <sys/mutex.h>
66 #include <machine/stdarg.h>
68 #ifdef ILOG_DEFINE_FOR_FILE
69 ILOG_DEFINE_FOR_FILE(L_ISI_FAIL_POINT, L_ILOG, fail_point);
72 static MALLOC_DEFINE(M_FAIL_POINT, "Fail Points", "fail points system");
73 #define fp_free(ptr) free(ptr, M_FAIL_POINT)
74 #define fp_malloc(size, flags) malloc((size), M_FAIL_POINT, (flags))
76 static struct mtx g_fp_mtx;
77 MTX_SYSINIT(g_fp_mtx, &g_fp_mtx, "fail point mtx", MTX_DEF);
78 #define FP_LOCK() mtx_lock(&g_fp_mtx)
79 #define FP_UNLOCK() mtx_unlock(&g_fp_mtx)
83 * Don't change these without changing fail_type_strings in fail.c.
84 * @ingroup failpoint_private
87 FAIL_POINT_OFF, /**< don't fail */
88 FAIL_POINT_PANIC, /**< panic */
89 FAIL_POINT_RETURN, /**< return an errorcode */
90 FAIL_POINT_BREAK, /**< break into the debugger */
91 FAIL_POINT_PRINT, /**< print a message */
92 FAIL_POINT_SLEEP, /**< sleep for some msecs */
99 } fail_type_strings[] = {
100 #define FP_TYPE_NM_LEN(s) { s, sizeof(s) - 1 }
101 [FAIL_POINT_OFF] = FP_TYPE_NM_LEN("off"),
102 [FAIL_POINT_PANIC] = FP_TYPE_NM_LEN("panic"),
103 [FAIL_POINT_RETURN] = FP_TYPE_NM_LEN("return"),
104 [FAIL_POINT_BREAK] = FP_TYPE_NM_LEN("break"),
105 [FAIL_POINT_PRINT] = FP_TYPE_NM_LEN("print"),
106 [FAIL_POINT_SLEEP] = FP_TYPE_NM_LEN("sleep"),
110 * Internal structure tracking a single term of a complete failpoint.
111 * @ingroup failpoint_private
113 struct fail_point_entry {
114 enum fail_point_t fe_type; /**< type of entry */
115 int fe_arg; /**< argument to type (e.g. return value) */
116 int fe_prob; /**< likelihood of firing in millionths */
117 int fe_count; /**< number of times to fire, 0 means always */
118 pid_t fe_pid; /**< only fail for this process */
119 TAILQ_ENTRY(fail_point_entry) fe_entries; /**< next entry in fail point */
123 fail_point_sleep(struct fail_point *fp, struct fail_point_entry *ent,
124 int msecs, enum fail_point_return_code *pret)
126 /* convert from millisecs to ticks, rounding up */
127 int timo = ((msecs * hz) + 999) / 1000;
130 if (fp->fp_sleep_fn == NULL) {
131 msleep(fp, &g_fp_mtx, PWAIT, "failpt", timo);
133 timeout(fp->fp_sleep_fn, fp->fp_sleep_arg, timo);
134 *pret = FAIL_POINT_RC_QUEUED;
141 * Defines stating the equivalent of probablilty one (100%)
144 PROB_MAX = 1000000, /* probability between zero and this number */
145 PROB_DIGITS = 6, /* number of zero's in above number */
148 static char *parse_fail_point(struct fail_point_entries *, char *);
149 static char *parse_term(struct fail_point_entries *, char *);
150 static char *parse_number(int *out_units, int *out_decimal, char *);
151 static char *parse_type(struct fail_point_entry *, char *);
152 static void free_entry(struct fail_point_entries *, struct fail_point_entry *);
153 static void clear_entries(struct fail_point_entries *);
156 * Initialize a fail_point. The name is formed in a printf-like fashion
157 * from "fmt" and subsequent arguments. This function is generally used
158 * for custom failpoints located at odd places in the sysctl tree, and is
159 * not explicitly needed for standard in-line-declared failpoints.
164 fail_point_init(struct fail_point *fp, const char *fmt, ...)
170 TAILQ_INIT(&fp->fp_entries);
173 /* Figure out the size of the name. */
175 n = vsnprintf(NULL, 0, fmt, ap);
178 /* Allocate the name and fill it in. */
179 name = fp_malloc(n + 1, M_WAITOK);
182 vsnprintf(name, n + 1, fmt, ap);
186 fp->fp_location = "";
187 fp->fp_flags |= FAIL_POINT_DYNAMIC_NAME;
188 fp->fp_sleep_fn = NULL;
189 fp->fp_sleep_arg = NULL;
193 * Free the resources held by a fail_point.
198 fail_point_destroy(struct fail_point *fp)
201 if ((fp->fp_flags & FAIL_POINT_DYNAMIC_NAME) != 0) {
202 fp_free(__DECONST(void *, fp->fp_name));
206 clear_entries(&fp->fp_entries);
210 * This does the real work of evaluating a fail point. If the fail point tells
211 * us to return a value, this function returns 1 and fills in 'return_value'
212 * (return_value is allowed to be null). If the fail point tells us to panic,
213 * we never return. Otherwise we just return 0 after doing some work, which
214 * means "keep going".
216 enum fail_point_return_code
217 fail_point_eval_nontrivial(struct fail_point *fp, int *return_value)
219 enum fail_point_return_code ret = FAIL_POINT_RC_CONTINUE;
220 struct fail_point_entry *ent, *next;
225 TAILQ_FOREACH_SAFE(ent, &fp->fp_entries, fe_entries, next) {
226 int cont = 0; /* don't continue by default */
228 if (ent->fe_prob < PROB_MAX &&
229 ent->fe_prob < random() % PROB_MAX)
231 if (ent->fe_pid != NO_PID && ent->fe_pid != curproc->p_pid)
234 switch (ent->fe_type) {
235 case FAIL_POINT_PANIC:
236 panic("fail point %s panicking", fp->fp_name);
239 case FAIL_POINT_RETURN:
240 if (return_value != NULL)
241 *return_value = ent->fe_arg;
242 ret = FAIL_POINT_RC_RETURN;
245 case FAIL_POINT_BREAK:
246 printf("fail point %s breaking to debugger\n",
251 case FAIL_POINT_PRINT:
252 printf("fail point %s executing\n", fp->fp_name);
256 case FAIL_POINT_SLEEP:
258 * Free the entry now if necessary, since
259 * we're about to drop the mutex and sleep.
262 if (ent->fe_count > 0 && --ent->fe_count == 0) {
263 free_entry(&fp->fp_entries, ent);
268 fail_point_sleep(fp, ent, msecs, &ret);
275 if (ent != NULL && ent->fe_count > 0 && --ent->fe_count == 0)
276 free_entry(&fp->fp_entries, ent);
281 /* Get rid of "off"s at the end. */
282 while ((ent = TAILQ_LAST(&fp->fp_entries, fail_point_entries)) &&
283 ent->fe_type == FAIL_POINT_OFF)
284 free_entry(&fp->fp_entries, ent);
292 * Translate internal fail_point structure into human-readable text.
295 fail_point_get(struct fail_point *fp, struct sbuf *sb)
297 struct fail_point_entry *ent;
301 TAILQ_FOREACH(ent, &fp->fp_entries, fe_entries) {
302 if (ent->fe_prob < PROB_MAX) {
303 int decimal = ent->fe_prob % (PROB_MAX / 100);
304 int units = ent->fe_prob / (PROB_MAX / 100);
305 sbuf_printf(sb, "%d", units);
307 int digits = PROB_DIGITS - 2;
308 while (!(decimal % 10)) {
312 sbuf_printf(sb, ".%0*d", digits, decimal);
314 sbuf_printf(sb, "%%");
316 if (ent->fe_count > 0)
317 sbuf_printf(sb, "%d*", ent->fe_count);
318 sbuf_printf(sb, "%s", fail_type_strings[ent->fe_type].name);
320 sbuf_printf(sb, "(%d)", ent->fe_arg);
321 if (ent->fe_pid != NO_PID)
322 sbuf_printf(sb, "[pid %d]", ent->fe_pid);
323 if (TAILQ_NEXT(ent, fe_entries))
324 sbuf_printf(sb, "->");
326 if (TAILQ_EMPTY(&fp->fp_entries))
327 sbuf_printf(sb, "off");
333 * Set an internal fail_point structure from a human-readable failpoint string
334 * in a lock-safe manner.
337 fail_point_set(struct fail_point *fp, char *buf)
340 struct fail_point_entry *ent, *ent_next;
341 struct fail_point_entries new_entries;
343 /* Parse new entries. */
344 TAILQ_INIT(&new_entries);
345 if (!parse_fail_point(&new_entries, buf)) {
346 clear_entries(&new_entries);
353 /* Move new entries in. */
354 TAILQ_SWAP(&fp->fp_entries, &new_entries, fail_point_entry, fe_entries);
355 clear_entries(&new_entries);
357 /* Get rid of useless zero probability entries. */
358 TAILQ_FOREACH_SAFE(ent, &fp->fp_entries, fe_entries, ent_next) {
359 if (ent->fe_prob == 0)
360 free_entry(&fp->fp_entries, ent);
363 /* Get rid of "off"s at the end. */
364 while ((ent = TAILQ_LAST(&fp->fp_entries, fail_point_entries)) &&
365 ent->fe_type == FAIL_POINT_OFF)
366 free_entry(&fp->fp_entries, ent);
373 IWARNING("Failed to set %s %s to %s",
374 fp->fp_name, fp->fp_location, buf);
376 INOTICE("Set %s %s to %s",
377 fp->fp_name, fp->fp_location, buf);
378 #endif /* IWARNING */
383 #define MAX_FAIL_POINT_BUF 1023
386 * Handle kernel failpoint set/get.
389 fail_point_sysctl(SYSCTL_HANDLER_ARGS)
391 struct fail_point *fp = arg1;
397 sbuf_new(&sb, NULL, 128, SBUF_AUTOEXTEND);
398 fail_point_get(fp, &sb);
401 error = SYSCTL_OUT(req, sbuf_data(&sb), sbuf_len(&sb));
405 if (!error && req->newptr) {
406 if (req->newlen > MAX_FAIL_POINT_BUF) {
411 buf = fp_malloc(req->newlen + 1, M_WAITOK);
413 error = SYSCTL_IN(req, buf, req->newlen);
416 buf[req->newlen] = '\0';
418 error = fail_point_set(fp, buf);
427 * Internal helper function to translate a human-readable failpoint string
428 * into a internally-parsable fail_point structure.
431 parse_fail_point(struct fail_point_entries *ents, char *p)
434 * <term> ( "->" <term> )*
436 p = parse_term(ents, p);
440 if (p[0] != '-' || p[1] != '>')
442 p = parse_term(ents, p + 2);
450 * Internal helper function to parse an individual term from a failpoint.
453 parse_term(struct fail_point_entries *ents, char *p)
455 struct fail_point_entry *ent;
457 ent = fp_malloc(sizeof *ent, M_WAITOK | M_ZERO);
458 ent->fe_prob = PROB_MAX;
459 ent->fe_pid = NO_PID;
460 TAILQ_INSERT_TAIL(ents, ent, fe_entries);
464 * ( (<float> "%") | (<integer> "*" ) )*
466 * [ "(" <integer> ")" ]
467 * [ "[pid " <integer> "]" ]
470 /* ( (<float> "%") | (<integer> "*" ) )* */
471 while (isdigit(*p) || *p == '.') {
474 p = parse_number(&units, &decimal, p);
479 if (units > 100) /* prevent overflow early */
481 ent->fe_prob = units * (PROB_MAX / 100) + decimal;
482 if (ent->fe_prob > PROB_MAX)
483 ent->fe_prob = PROB_MAX;
484 } else if (*p == '*') {
485 if (!units || decimal)
487 ent->fe_count = units;
494 p = parse_type(ent, p);
500 /* [ "(" <integer> ")" ] */
504 if (!isdigit(*p) && *p != '-')
506 ent->fe_arg = strtol(p, &p, 0);
510 /* [ "[pid " <integer> "]" ] */
511 #define PID_STRING "[pid "
512 if (strncmp(p, PID_STRING, sizeof(PID_STRING) - 1) != 0)
514 p += sizeof(PID_STRING) - 1;
517 ent->fe_pid = strtol(p, &p, 0);
525 * Internal helper function to parse a numeric for a failpoint term.
528 parse_number(int *out_units, int *out_decimal, char *p)
534 * <integer> [ "." <integer> ] |
540 *out_units = strtol(p, &p, 10);
541 if (p == old_p && *p != '.')
544 /* fractional part */
549 while (isdigit(*p)) {
550 int digit = *p - '0';
551 if (digits < PROB_DIGITS - 2)
552 *out_decimal = *out_decimal * 10 + digit;
553 else if (digits == PROB_DIGITS - 2 && digit >= 5)
558 if (!digits) /* need at least one digit after '.' */
560 while (digits++ < PROB_DIGITS - 2) /* add implicit zeros */
564 return (p); /* success */
568 * Internal helper function to parse an individual type for a failpoint term.
571 parse_type(struct fail_point_entry *ent, char *beg)
573 enum fail_point_t type;
576 for (type = FAIL_POINT_OFF; type < FAIL_POINT_NUMTYPES; type++) {
577 len = fail_type_strings[type].nmlen;
578 if (strncmp(fail_type_strings[type].name, beg, len) == 0) {
587 * Internal helper function to free an individual failpoint term.
590 free_entry(struct fail_point_entries *ents, struct fail_point_entry *ent)
592 TAILQ_REMOVE(ents, ent, fe_entries);
597 * Internal helper function to clear out all failpoint terms for a single
601 clear_entries(struct fail_point_entries *ents)
603 struct fail_point_entry *ent, *ent_next;
605 TAILQ_FOREACH_SAFE(ent, ents, fe_entries, ent_next)
610 /* The fail point sysctl tree. */
611 SYSCTL_NODE(_debug, OID_AUTO, fail_point, CTLFLAG_RW, 0, "fail points");