summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authormarkj <markj@FreeBSD.org>2017-11-28 01:15:53 +0000
committermarkj <markj@FreeBSD.org>2017-11-28 01:15:53 +0000
commit7c0a4b882cc085021028de6771f4b5752f279833 (patch)
tree5c73c715882bf016a540bcae318a391c8dd4f0dc /share/man
parent332a8c368c824313c1bcac21a4ad1c73666818ae (diff)
downloadFreeBSD-src-7c0a4b882cc085021028de6771f4b5752f279833.zip
FreeBSD-src-7c0a4b882cc085021028de6771f4b5752f279833.tar.gz
MFC r326060:
Clean up the SYSINIT_FLAGS definitions for rwlock(9) and rmlock(9).
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man9/Makefile3
-rw-r--r--share/man/man9/rmlock.98
-rw-r--r--share/man/man9/rwlock.96
-rw-r--r--share/man/man9/sx.914
4 files changed, 23 insertions, 8 deletions
diff --git a/share/man/man9/Makefile b/share/man/man9/Makefile
index 7b26d1d..720ab98 100644
--- a/share/man/man9/Makefile
+++ b/share/man/man9/Makefile
@@ -1446,6 +1446,7 @@ MLINKS+=rmlock.9 rm_assert.9 \
rmlock.9 rm_runlock.9 \
rmlock.9 rm_sleep.9 \
rmlock.9 RM_SYSINIT.9 \
+ rmlock.9 RM_SYSINIT_FLAGS.9 \
rmlock.9 rm_try_rlock.9 \
rmlock.9 rm_wlock.9 \
rmlock.9 rm_wowned.9 \
@@ -1478,6 +1479,7 @@ MLINKS+=rwlock.9 rw_assert.9 \
rwlock.9 rw_unlock.9 \
rwlock.9 rw_sleep.9 \
rwlock.9 RW_SYSINIT.9 \
+ rwlock.9 RW_SYSINIT_FLAGS.9 \
rwlock.9 rw_try_rlock.9 \
rwlock.9 rw_try_upgrade.9 \
rwlock.9 rw_try_wlock.9 \
@@ -1685,6 +1687,7 @@ MLINKS+=sx.9 sx_assert.9 \
sx.9 sx_slock_sig.9 \
sx.9 sx_sunlock.9 \
sx.9 SX_SYSINIT.9 \
+ sx.9 SX_SYSINIT_FLAGS.9 \
sx.9 sx_try_slock.9 \
sx.9 sx_try_upgrade.9 \
sx.9 sx_try_xlock.9 \
diff --git a/share/man/man9/rmlock.9 b/share/man/man9/rmlock.9
index ee033a6..d56d97c 100644
--- a/share/man/man9/rmlock.9
+++ b/share/man/man9/rmlock.9
@@ -26,7 +26,7 @@
.\" $FreeBSD$
.\"
.\" Based on rwlock.9 man page
-.Dd December 13, 2014
+.Dd November 11, 2017
.Dt RMLOCK 9
.Os
.Sh NAME
@@ -42,7 +42,8 @@
.Nm rm_wowned ,
.Nm rm_sleep ,
.Nm rm_assert ,
-.Nm RM_SYSINIT
+.Nm RM_SYSINIT ,
+.Nm RM_SYSINIT_FLAGS
.Nd kernel reader/writer lock optimized for read-mostly access patterns
.Sh SYNOPSIS
.In sys/param.h
@@ -74,7 +75,8 @@
.Ft void
.Fn rm_assert "struct rmlock *rm" "int what"
.In sys/kernel.h
-.Fn RM_SYSINIT "name" "struct rmlock *rm" "const char *desc" "int opts"
+.Fn RM_SYSINIT "name" "struct rmlock *rm" "const char *desc"
+.Fn RM_SYSINIT_FLAGS "name" "struct rmlock *rm" "const char *desc" "int flags"
.Sh DESCRIPTION
Read-mostly locks allow shared access to protected data by multiple threads,
or exclusive access by a single thread.
diff --git a/share/man/man9/rwlock.9 b/share/man/man9/rwlock.9
index 9ee16fc..a23b44b 100644
--- a/share/man/man9/rwlock.9
+++ b/share/man/man9/rwlock.9
@@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd March 28, 2016
+.Dd November 11, 2017
.Dt RWLOCK 9
.Os
.Sh NAME
@@ -45,7 +45,8 @@
.Nm rw_initialized ,
.Nm rw_wowned ,
.Nm rw_assert ,
-.Nm RW_SYSINIT
+.Nm RW_SYSINIT ,
+.Nm RW_SYSINIT_FLAGS
.Nd kernel reader/writer lock
.Sh SYNOPSIS
.In sys/param.h
@@ -88,6 +89,7 @@
.Fn rw_assert "const struct rwlock *rw" "int what"
.In sys/kernel.h
.Fn RW_SYSINIT "name" "struct rwlock *rw" "const char *desc"
+.Fn RW_SYSINIT_FLAGS "name" "struct rwlock *rw" "const char *desc" "int flags"
.Sh DESCRIPTION
Reader/writer locks allow shared access to protected data by multiple threads,
or exclusive access by a single thread.
diff --git a/share/man/man9/sx.9 b/share/man/man9/sx.9
index f09584a..a911e07 100644
--- a/share/man/man9/sx.9
+++ b/share/man/man9/sx.9
@@ -26,7 +26,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd March 28, 2016
+.Dd November 11, 2017
.Dt SX 9
.Os
.Sh NAME
@@ -49,7 +49,8 @@
.Nm sx_xholder ,
.Nm sx_xlocked ,
.Nm sx_assert ,
-.Nm SX_SYSINIT
+.Nm SX_SYSINIT ,
+.Nm SX_SYSINIT_FLAGS
.Nd kernel shared/exclusive lock
.Sh SYNOPSIS
.In sys/param.h
@@ -95,7 +96,8 @@
.Ft void
.Fn sx_assert "const struct sx *sx" "int what"
.In sys/kernel.h
-.Fn SX_SYSINIT "name" "struct sx *sx" "const char *description"
+.Fn SX_SYSINIT "name" "struct sx *sx" "const char *desc"
+.Fn SX_SYSINIT_FLAGS "name" "struct sx *sx" "const char *desc" "int flags"
.Sh DESCRIPTION
Shared/exclusive locks are used to protect data that are read far more often
than they are written.
@@ -295,6 +297,12 @@ but with an additional argument,
.Fa name ,
that is used in generating unique variable names for the related
structures associated with the lock and the sysinit routine.
+The
+.Fn SX_SYSINIT_FLAGS
+macro can similarly be used to initialize a given
+.Fa sx
+lock using
+.Fn sx_init_flags .
.Pp
A thread may not hold both a shared lock and an exclusive lock on the same
lock simultaneously;
OpenPOWER on IntegriCloud