ptt_contention.1

linux下的多线程调试工具

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "PTT_CONTENTION 1"
.TH PTT_CONTENTION 1 "2006-05-22" "PTT 1.0" "PTT - POSIX Thread Trace Toolkit"
.SH "NAME"
ptt_contention \- PTT contention measurement tool
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
ptt_contention [options] input_file
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
Its primary function is to give some information
about traced applications contention.
This information is extracted from the binary data
collected by \fIptt_trace\fR\|(1).
.PP
It provides three kinds of information:
.IP "elapsed time: difference between the last and first trace point timestamps in the binary file" 4
.IX Item "elapsed time: difference between the last and first trace point timestamps in the binary file"
.PD 0
.IP "contention time per thread." 4
.IX Item "contention time per thread."
.IP "contention time per \s-1NPTL\s0 object (mutex, barrier, cond\-var, semaphore)." 4
.IX Item "contention time per NPTL object (mutex, barrier, cond-var, semaphore)."
.PD
.PP
Percentages displayed show the impact of each thread or \s-1NPTL\s0 object
in the contention.
For threads,
percentage of waiting time in relation to the elapsed time is also given.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-a alias_file\fR" 4
.IX Item "-a alias_file"
\&\fIalias_file\fR contains couples (address, name).
In \fIptt_contention\fR\|(1) output,
objects that have an address existing in \fIalias_file\fR
will be replaced by the corresponding name.
.Sp
See \fIptt_view\fR\|(1) for an example of
how to create an alias file.
.IP "\fB\-c\fR" 4
.IX Item "-c"
Display contention time per couple [thread \- \s-1NPTL\s0 object].
For each thread, waiting time on every object it uses is given.
.IP "\fB\-z start:end\fR" 4
.IX Item "-z start:end"
event filter.
This filter only displays \f(CW\*(C`end \- start\*(C'\fR events skipping \f(CW\*(C`start\*(C'\fR events.
The syntax \fB\-z :end\fR or \fB\-z start:\fR
is also supported and implies start=0 or end=infinity.
.Sp
\&\fIWarning\fR: the filter is applied to a group of events
for performance issue, so the count is not always exact.
You can have up to 3 more events than requested.
.IP "\fB\-Z start:end\fR" 4
.IX Item "-Z start:end"
time filter.
This filter only displays events that occurred
after \f(CW\*(C`start\*(C'\fR microseconds and before \f(CW\*(C`end\*(C'\fR microseconds.
The syntax \fB\-Z :end\fR or \fB\-Z start:\fR
is also supported and imply start=0 or end=infinity.
.SH "NOTE"
.IX Header "NOTE"
The global contention is the sum of each thread contention.
The sum of each \s-1NPTL\s0 object contention can be lower
than the global contention.
Indeed, some contention doesn't come from \s-1NPTL\s0 objects.
The more obvious example is with the use of pthread_join.
The main thread generally launches child threads
and wait for them to complete their job with pthread_join.
The waiting time is not due to \s-1NPTL\s0 objects here.
There is also some contention due to \s-1NPTL\s0 internal mechanisms.
.SH "LIMITATION"
.IX Header "LIMITATION"
Given information is accurate only if the binary input file
was generated by \fIptt_trace\fR\|(1) with the maximum level of trace
(\s-1LEVEL_ALL\s0) selected.
.PP
Note: if you are interested in contention due to
only one type of object,
you can trace
with the maximum level corresponding to this object
(\s-1LEVEL_MUTEX_ALL\s0 for mutexes, ...).
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIptt_trace\fR\|(1), \fIptt_view\fR\|(1), \fIptt_stat\fR\|(1)
.SH "AUTHOR"
.IX Header "AUTHOR"
Guillaume \s-1DURANCEAU\s0