summaryrefslogtreecommitdiffstats
path: root/share/man/man9/mutex.9
diff options
context:
space:
mode:
authorjkoshy <jkoshy@FreeBSD.org>2004-01-01 05:16:35 +0000
committerjkoshy <jkoshy@FreeBSD.org>2004-01-01 05:16:35 +0000
commiteb1c647689df17cbf6752dd1df21a8f6beedba6a (patch)
tree4b4c139c00788bfee94649246f0c5425ff351173 /share/man/man9/mutex.9
parenta4ef00f2a300b8a76ad2a9a6b5426f7d00d68780 (diff)
downloadFreeBSD-src-eb1c647689df17cbf6752dd1df21a8f6beedba6a.zip
FreeBSD-src-eb1c647689df17cbf6752dd1df21a8f6beedba6a.tar.gz
Add "options INVARIANTS" and "options INVARIANT_SUPPORT" to the
synopsis, with supporting text in the body of the manual page. Add a cross-reference to panic(9) for completeness. Reviewed by: ru (synopsis changes)
Diffstat (limited to 'share/man/man9/mutex.9')
-rw-r--r--share/man/man9/mutex.914
1 files changed, 11 insertions, 3 deletions
diff --git a/share/man/man9/mutex.9 b/share/man/man9/mutex.9
index dafdefb..df8e3d2 100644
--- a/share/man/man9/mutex.9
+++ b/share/man/man9/mutex.9
@@ -85,6 +85,9 @@
.Fn mtx_owned "struct mtx *mutex"
.Ft int
.Fn mtx_recursed "struct mtx *mutex"
+.Pp
+.Cd "options INVARIANTS"
+.Cd "options INVARIANT_SUPPORT"
.Ft void
.Fn mtx_assert "struct mtx *mutex" "int what"
.In sys/kernel.h
@@ -330,11 +333,15 @@ This check should only be made if the running thread already owns
.Pp
The
.Fn mtx_assert
-function allows assertions to be made about
+function allows assertions specified in
+.Ar what
+to be made about
.Fa mutex .
If the assertions are not true and the kernel is compiled with
-.Dv INVARIANTS
-then the kernel will panic.
+.Cd "options INVARIANTS"
+and
+.Cd "options INVARIANT_SUPPORT" ,
+the kernel will panic.
Currently the following assertions are supported:
.Bl -tag -width MA_NOTRECURSED
.It Dv MA_OWNED
@@ -493,6 +500,7 @@ No locks are needed when calling these functions.
.Xr condvar 9 ,
.Xr msleep 9 ,
.Xr mtx_pool 9 ,
+.Xr panic 9 ,
.Xr sema 9 ,
.Xr sx 9
.Sh HISTORY
OpenPOWER on IntegriCloud