xref: /freebsd/cddl/usr.sbin/plockstat/plockstat.1 (revision fa9896e082a1046ff4fbc75fcba4d18d1f2efc19)
18518caf2SRui Paulo.\"
28518caf2SRui Paulo.\" Copyright (c) 2010 The FreeBSD Foundation
38518caf2SRui Paulo.\" All rights reserved.
48518caf2SRui Paulo.\"
58518caf2SRui Paulo.\" This software was developed by Rui Paulo under sponsorship from the
68518caf2SRui Paulo.\" FreeBSD Foundation.
78518caf2SRui Paulo.\"
88518caf2SRui Paulo.\" Redistribution and use in source and binary forms, with or without
98518caf2SRui Paulo.\" modification, are permitted provided that the following conditions
108518caf2SRui Paulo.\" are met:
118518caf2SRui Paulo.\" 1. Redistributions of source code must retain the above copyright
128518caf2SRui Paulo.\"    notice, this list of conditions and the following disclaimer.
138518caf2SRui Paulo.\" 2. Redistributions in binary form must reproduce the above copyright
148518caf2SRui Paulo.\"    notice, this list of conditions and the following disclaimer in the
158518caf2SRui Paulo.\"    documentation and/or other materials provided with the distribution.
168518caf2SRui Paulo.\"
178518caf2SRui Paulo.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
188518caf2SRui Paulo.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
198518caf2SRui Paulo.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
208518caf2SRui Paulo.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
218518caf2SRui Paulo.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
228518caf2SRui Paulo.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
238518caf2SRui Paulo.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
248518caf2SRui Paulo.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
258518caf2SRui Paulo.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
268518caf2SRui Paulo.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
278518caf2SRui Paulo.\" SUCH DAMAGE.
288518caf2SRui Paulo.\"
298518caf2SRui Paulo.Dd September 13, 2010
308518caf2SRui Paulo.Dt PLOCKSTAT 1
318518caf2SRui Paulo.Os
328518caf2SRui Paulo.Sh NAME
338518caf2SRui Paulo.Nm plockstat
348518caf2SRui Paulo.Nd Trace pthread lock statistics using DTrace
358518caf2SRui Paulo.Sh SYNOPSIS
368518caf2SRui Paulo.Nm
378518caf2SRui Paulo.Op Fl vACHV
388518caf2SRui Paulo.Op Fl n Ar count
398518caf2SRui Paulo.Op Fl s Ar depth
408518caf2SRui Paulo.Op Fl e Ar secs
418518caf2SRui Paulo.Op Fl x Ar opt Ns = Ns Ar val
428518caf2SRui Paulo.Ar command
438518caf2SRui Paulo.Op arg...
448518caf2SRui Paulo.Nm
458518caf2SRui Paulo.Op Fl vACHV
468518caf2SRui Paulo.Op Fl n Ar count
478518caf2SRui Paulo.Op Fl s Ar depth
488518caf2SRui Paulo.Op Fl e Ar secs
498518caf2SRui Paulo.Op Fl x Ar opt Ns = Ns Ar val
508518caf2SRui Paulo.Fl p Ar pid
518518caf2SRui Paulo.Sh DESCRIPTION
528518caf2SRui PauloThe
538518caf2SRui Paulo.Nm
548518caf2SRui Pauloutility traces pthread locks (mutexes and rwlocks) and prints statistics about
558518caf2SRui Paulothem.
568518caf2SRui PauloYou can use
578518caf2SRui Paulo.Nm
588518caf2SRui Pauloto investigate bottlenecks in your software.
598518caf2SRui Paulo.Pp
608518caf2SRui PauloThe following options are available:
618518caf2SRui Paulo.Bl -tag -width indent
628518caf2SRui Paulo.It Fl v
638518caf2SRui PauloBe verbose.
648518caf2SRui Paulo.It Fl A
658518caf2SRui PauloPrint all statistics.
668518caf2SRui Paulo.It Fl C
678518caf2SRui PauloPrint commulative statistics (the default).
688518caf2SRui Paulo.It Fl H
69*bed6f184SChristian BruefferPrint a histogram.
708518caf2SRui Paulo.It Fl V
718518caf2SRui PauloPrint the DTrace script about to be used to stderr.
728518caf2SRui Paulo.It Fl n Ar count
738518caf2SRui PauloSet the aggregation count for the data set.
748518caf2SRui Paulo.It Fl s Ar depth
758518caf2SRui PauloSet the ustack (userland stack) caller depth.
768518caf2SRui Paulo.It Fl e Ar secs
778518caf2SRui PauloDoes nothing at the moment.
788518caf2SRui Paulo.It Fl x Ar opt Ns = Ns Ar val
798518caf2SRui PauloSpecify DTrace options.
808518caf2SRui PauloSee the
818518caf2SRui Paulo.Xr dtrace 1
828518caf2SRui Pauloman page for more details.
838518caf2SRui Paulo.El
848518caf2SRui Paulo.Sh EXIT STATUS
858518caf2SRui Paulo.Ex -std
868518caf2SRui Paulo.Sh SEE ALSO
878518caf2SRui Paulo.Xr dtrace 1 ,
888518caf2SRui Paulo.Xr pthread 3
898518caf2SRui Paulo.Sh HISTORY
908518caf2SRui PauloThe
918518caf2SRui Paulo.Nm
92*bed6f184SChristian Bruefferutility comes from OpenSolaris and was first imported into
938518caf2SRui Paulo.Fx 9.0 .
94