Allow fail points to have separate declarations, definitions, and evals
Submitted by: Matthew Bryan <matthew.bryan@isilon.com> Reviewed by: cem Sponsored by: Dell EMC Isilon Differential Revision: https://reviews.freebsd.org/D20546
This commit is contained in:
parent
31927bd4ad
commit
3cf556f05e
Notes:
svn2git
2020-12-20 02:59:44 +00:00
svn path=/head/; revision=348770
@ -1,5 +1,5 @@
|
||||
.\"
|
||||
.\" Copyright (c) 2009 Isilon Inc http://www.isilon.com/
|
||||
.\" Copyright (c) 2009-2019 Dell EMC Isilon http://www.isilon.com/
|
||||
.\"
|
||||
.\" Redistribution and use in source and binary forms, with or without
|
||||
.\" modification, are permitted provided that the following conditions
|
||||
@ -26,30 +26,36 @@
|
||||
.\"
|
||||
.\" $FreeBSD$
|
||||
.\"
|
||||
.Dd March 15, 2016
|
||||
.Dd June 6, 2019
|
||||
.Dt FAIL 9
|
||||
.Os
|
||||
.Sh NAME
|
||||
.Nm DEBUG_FP ,
|
||||
.Nm KFAIL_POINT_CODE ,
|
||||
.Nm KFAIL_POINT_CODE_FLAGS ,
|
||||
.Nm KFAIL_POINT_CODE_COND ,
|
||||
.Nm KFAIL_POINT_ERROR ,
|
||||
.Nm KFAIL_POINT_EVAL ,
|
||||
.Nm KFAIL_POINT_DECLARE ,
|
||||
.Nm KFAIL_POINT_DEFINE ,
|
||||
.Nm KFAIL_POINT_GOTO ,
|
||||
.Nm KFAIL_POINT_RETURN ,
|
||||
.Nm KFAIL_POINT_RETURN_VOID ,
|
||||
.Nm KFAIL_POINT_ERROR ,
|
||||
.Nm KFAIL_POINT_GOTO ,
|
||||
.Nm KFAIL_POINT_SLEEP_CALLBACKS ,
|
||||
.Nm fail_point ,
|
||||
.Nm DEBUG_FP
|
||||
.Nm fail_point
|
||||
.Nd fail points
|
||||
.Sh SYNOPSIS
|
||||
.In sys/fail.h
|
||||
.Fn KFAIL_POINT_CODE "parent" "name" "code"
|
||||
.Fn KFAIL_POINT_CODE_FLAGS "parent" "name" "flags" "code"
|
||||
.Fn KFAIL_POINT_CODE_COND "parent" "name" "cond" "flags" "code"
|
||||
.Fn KFAIL_POINT_ERROR "parent" "name" "error_var"
|
||||
.Fn KFAIL_POINT_EVAL "name" "code"
|
||||
.Fn KFAIL_POINT_DECLARE "name"
|
||||
.Fn KFAIL_POINT_DEFINE "parent" "name" "flags"
|
||||
.Fn KFAIL_POINT_GOTO "parent" "name" "error_var" "label"
|
||||
.Fn KFAIL_POINT_RETURN "parent" "name"
|
||||
.Fn KFAIL_POINT_RETURN_VOID "parent" "name"
|
||||
.Fn KFAIL_POINT_ERROR "parent" "name" "error_var"
|
||||
.Fn KFAIL_POINT_GOTO "parent" "name" "error_var" "label"
|
||||
.Fn KFAIL_POINT_SLEEP_CALLBACKS "parent" "name" "pre_func" "pre_arg" "post_func" "post_arg" "code"
|
||||
.Sh DESCRIPTION
|
||||
Fail points are used to add code points where errors may be injected
|
||||
@ -140,6 +146,22 @@ is the equivalent of
|
||||
is the equivalent of
|
||||
.Sy KFAIL_POINT_CODE(..., { error_var = RETURN_VALUE; goto label;})
|
||||
.El
|
||||
.Pp
|
||||
You can also introduce fail points by separating the declaration,
|
||||
definition, and evaluation portions.
|
||||
.Bl -inset
|
||||
.It Fn KFAIL_POINT_DECLARE name
|
||||
is used to declare the
|
||||
.Sy fail_point
|
||||
struct.
|
||||
.It Fn KFAIL_POINT_DEFINE parent name flags
|
||||
defines and initializes the
|
||||
.Sy fail_point
|
||||
and sets up its
|
||||
.Xr sysctl 9 .
|
||||
.It Fn KFAIL_POINT_EVAL name code
|
||||
is used at the point that the fail point is executed.
|
||||
.El
|
||||
.Sh SYSCTL VARIABLES
|
||||
The
|
||||
.Fn KFAIL_POINT_*
|
||||
|
@ -1,7 +1,7 @@
|
||||
/*-
|
||||
* SPDX-License-Identifier: BSD-2-Clause-FreeBSD
|
||||
*
|
||||
* Copyright (c) 2009 Isilon Inc http://www.isilon.com/
|
||||
* Copyright (c) 2009-2019 Dell EMC Isilon http://www.isilon.com/
|
||||
*
|
||||
* Redistribution and use in source and binary forms, with or without
|
||||
* modification, are permitted provided that the following conditions
|
||||
@ -191,10 +191,12 @@ fail_point_eval(struct fail_point *fp, int *ret)
|
||||
__END_DECLS
|
||||
|
||||
/* Declare a fail_point and its sysctl in a function. */
|
||||
#define KFAIL_POINT_DECLARE(name) \
|
||||
extern struct fail_point _FAIL_POINT_NAME(name)
|
||||
#define _FAIL_POINT_NAME(name) _fail_point_##name
|
||||
#define _FAIL_POINT_LOCATION() "(" __FILE__ ":" __XSTRING(__LINE__) ")"
|
||||
#define _FAIL_POINT_INIT(parent, name, flags) \
|
||||
static struct fail_point _FAIL_POINT_NAME(name) = { \
|
||||
#define KFAIL_POINT_DEFINE(parent, name, flags) \
|
||||
struct fail_point _FAIL_POINT_NAME(name) = { \
|
||||
.fp_name = #name, \
|
||||
.fp_location = _FAIL_POINT_LOCATION(), \
|
||||
.fp_ref_cnt = 0, \
|
||||
@ -213,6 +215,9 @@ __END_DECLS
|
||||
CTLTYPE_STRING | CTLFLAG_RD | CTLFLAG_MPSAFE, \
|
||||
&_FAIL_POINT_NAME(name), 0, \
|
||||
fail_point_sysctl_status, "A", "");
|
||||
|
||||
#define _FAIL_POINT_INIT(parent, name, flags) \
|
||||
static KFAIL_POINT_DEFINE(parent, name, flags)
|
||||
#define _FAIL_POINT_EVAL(name, cond, code...) \
|
||||
int RETURN_VALUE; \
|
||||
\
|
||||
@ -222,7 +227,8 @@ __END_DECLS
|
||||
code; \
|
||||
\
|
||||
}
|
||||
|
||||
#define KFAIL_POINT_EVAL(name, code...) \
|
||||
_FAIL_POINT_EVAL(name, true, code)
|
||||
|
||||
/**
|
||||
* Instantiate a failpoint which returns "RETURN_VALUE" from the function
|
||||
|
Loading…
Reference in New Issue
Block a user