aboutsummaryrefslogtreecommitdiff
path: root/share/man
diff options
context:
space:
mode:
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man4/dtrace_lockstat.4136
1 files changed, 65 insertions, 71 deletions
diff --git a/share/man/man4/dtrace_lockstat.4 b/share/man/man4/dtrace_lockstat.4
index fc8bf7785ef1..8ed2af14f811 100644
--- a/share/man/man4/dtrace_lockstat.4
+++ b/share/man/man4/dtrace_lockstat.4
@@ -24,7 +24,7 @@
.\"
.\" $FreeBSD$
.\"
-.Dd March 2, 2018
+.Dd August 20, 2019
.Dt DTRACE_LOCKSTAT 4
.Os
.Sh NAME
@@ -50,6 +50,12 @@
.Fn lockstat:::sx-spin "struct sx *" "uint64_t"
.Fn lockstat:::sx-upgrade "struct sx *"
.Fn lockstat:::sx-downgrade "struct sx *"
+.Fn lockstat:::lockmgr-acquire "struct lock *" "int"
+.Fn lockstat:::lockmgr-release "struct lock *" "int"
+.Fn lockstat:::lockmgr-disown "struct lock *" "int"
+.Fn lockstat:::lockmgr-block "struct lock *" "uint64_t" "int" "int" "int"
+.Fn lockstat:::lockmgr-upgrade "struct lock *"
+.Fn lockstat:::lockmgr-downgrade "struct lock *"
.Fn lockstat:::thread-spin "struct mtx *" "uint64"
.Sh DESCRIPTION
The DTrace
@@ -62,6 +68,7 @@ The
provider contains DTrace probes for inspecting kernel lock
state transitions.
Probes exist for the
+.Xr lockmgr 9 ,
.Xr mutex 9 ,
.Xr rwlock 9 ,
and
@@ -159,76 +166,50 @@ The second argument is
if the lock is being acquired or released as a writer, and
.Dv 1
if it is being acquired or released as a reader.
-.Pp
-The
-.Fn lockstat:::rw-block
-probe fires when a thread removes itself from the CPU while
-waiting to acquire a
-.Xr rwlock 9 .
-The
-.Fn lockstat:::rw-spin
-probe fires when a thread spins while waiting to acquire a
-.Xr rwlock 9 .
-Both probes take the same set of arguments.
-The first argument is a pointer to the lock structure that describes
-the lock.
-The second argument is the length of time, in nanoseconds,
-that the waiting thread was off the CPU or spinning for the lock.
-The third argument is
-.Dv 0
-if the thread is attempting to acquire the lock as a writer, and
-.Dv 1
-if the thread is attempting to acquire the lock as a reader.
-The fourth argument is
-.Dv 0
-if the thread is waiting for a writer to release the lock, and
-.Dv 1
-if the thread is waiting for a reader to release the lock.
-The fifth argument is the number of readers that held the lock when
-the thread first attempted to acquire the lock.
-This argument will be
-.Dv 0
-if the fourth argument is
-.Dv 0 .
-.Pp
-The
-.Fn lockstat:::rw-upgrade
-probe fires when a thread successfully upgrades a held
-.Xr rwlock 9
-read lock to a write lock.
-The
-.Fn lockstat:::rw-downgrade
-probe fires when a thread downgrades a held
-.Xr rwlock 9
-write lock to a read lock.
-The only argument is a pointer to the structure which describes
-the lock being acquired.
-.Pp
The
.Fn lockstat:::sx-acquire
and
-.Fn lockstat:::sx-release
-probes fire when a
+.Fn lockstat:::sx-release ,
+and
+.Fn lockstat:::lockmgr-acquire
+and
+.Fn lockstat:::lockmgr-release
+probes fire upon the corresponding events for
.Xr sx 9
-is acquired or released, respectively.
+and
+.Xr lockmgr 9
+locks, respectively.
+The
+.Fn lockstat:::lockmgr-disown
+probe fires when a
+.Xr lockmgr 9
+exclusive lock is disowned.
+In this state, the lock remains exclusively held, but may be
+released by a different thread.
+The
+.Fn lockstat:::lockmgr-release
+probe does not fire when releasing a disowned lock.
The first argument is a pointer to the structure which describes
-the lock being acquired.
+the lock being disowned.
The second argument is
-.Dv 0
-if the shared lock is being acquired or released, and
-.Dv 1
-if the exclusive lock is being acquired or released.
+.Dv 0 ,
+for compatibility with
+.Fn lockstat:::lockmgr-release .
.Pp
The
-.Fn lockstat:::sx-block
-probe fires when a thread takes itself off the CPU while
-waiting to acquire a
-.Xr sx 9 .
+.Fn lockstat:::rw-block ,
+.Fn lockstat:::sx-block ,
+and
+.Fn lockstat:::lockmgr-block
+probes fire when a thread removes itself from the CPU while
+waiting to acquire a lock of the corresponding type.
The
+.Fn lockstat:::rw-spin
+and
.Fn lockstat:::sx-spin
-probe fires when a thread spins while waiting to acquire a
-.Xr sx 9 .
-Both probes take the same set of arguments.
+probes fire when a thread spins while waiting to acquire a lock
+of the corresponding type.
+All probes take the same set of arguments.
The first argument is a pointer to the lock structure that describes
the lock.
The second argument is the length of time, in nanoseconds,
@@ -240,28 +221,40 @@ if the thread is attempting to acquire the lock as a writer, and
if the thread is attempting to acquire the lock as a reader.
The fourth argument is
.Dv 0
-if the thread is waiting for a writer to release the lock, and
+if the thread is waiting for a reader to release the lock, and
.Dv 1
-if the thread is waiting for a reader to release the lock.
+if the thread is waiting for a writer to release the lock.
The fifth argument is the number of readers that held the lock when
the thread first attempted to acquire the lock.
This argument will be
.Dv 0
if the fourth argument is
-.Dv 0 .
+.Dv 1 .
.Pp
The
+.Fn lockstat:::lockmgr-upgrade ,
+.Fn lockstat:::rw-upgrade ,
+and
.Fn lockstat:::sx-upgrade
-probe fires when a thread successfully upgrades a held
+probes fire when a thread successfully upgrades a held
+.Xr lockmgr 9 ,
+.Xr rwlock 9 ,
+or
.Xr sx 9
-shared lock to an exclusive lock.
+shared/reader lock to an exclusive/writer lock.
The only argument is a pointer to the structure which describes
the lock being acquired.
The
+.Fn lockstat:::lockmgr-downgrade ,
+.Fn lockstat:::rw-downgrade ,
+and
.Fn lockstat:::sx-downgrade
-probe fires when a thread downgrades a held
+probes fire when a thread downgrades a held
+.Xr lockmgr 9 ,
+.Xr rwlock 9 ,
+or
.Xr sx 9
-exclusive lock to a shared lock.
+exclusive/writer lock to a shared/reader lock.
.Pp
The
.Fn lockstat:::thread-spin
@@ -291,10 +284,11 @@ provider first appeared in
.Fx 9 .
.Sh AUTHORS
This manual page was written by
-.An George V. Neville-Neil Aq Mt gnn@FreeBSD.org .
+.An George V. Neville-Neil Aq Mt gnn@FreeBSD.org
+and
+.An -nosplit
+.An Mark Johnston Aq Mt markj@FreeBSD.org .
.Sh BUGS
Probes for
-.Xr lockmgr 9
-and
.Xr rmlock 9
locks have not yet been added.