Initial commit of OpenSPARC T2 architecture model.

[OpenSPARC-T2-SAM] / sam-t2 / devtools / v9 / man / man1 / dprofpp.1

.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" 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 "DPROFPP 1"
.TH DPROFPP 1 "2007-06-19" "perl v5.8.8" "Perl Programmers Reference Guide"
.SH "NAME"
dprofpp \- display perl profile data
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
dprofpp [\fB\-a\fR|\fB\-z\fR|\fB\-l\fR|\fB\-v\fR|\fB\-U\fR] [\fB\-d\fR] [\fB\-s\fR|\fB\-r\fR|\fB\-u\fR] [\fB\-q\fR] [\fB\-F\fR] [\fB\-I|\-E\fR] [\fB\-O cnt\fR] [\fB\-A\fR] [\fB\-R\fR] [\fB\-S\fR] [\fB\-g subroutine\fR] [\fB\-G\fR <regexp> [\fB\-P\fR]] [\fB\-f\fR <regexp>] [profile]
.PP
dprofpp \fB\-T\fR [\fB\-F\fR] [\fB\-g subroutine\fR] [profile]
.PP
dprofpp \fB\-t\fR [\fB\-F\fR] [\fB\-g subroutine\fR] [profile]
.PP
dprofpp \fB\-G\fR <regexp> [\fB\-P\fR] [profile]
.PP
dprofpp \fB\-p script\fR [\fB\-Q\fR] [other opts]
.PP
dprofpp \fB\-V\fR [profile]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fIdprofpp\fR command interprets profile data produced by a profiler, such
as the Devel::DProf profiler.  Dprofpp will read the file \fItmon.out\fR and
display the 15 subroutines which are using the most time.  By default
the times for each subroutine are given exclusive of the times of their
child subroutines.
.PP
To profile a Perl script run the perl interpreter with the \fB\-d\fR switch.  So
to profile script \fItest.pl\fR with Devel::DProf use the following:
.PP
.Vb 1
\&        $ perl5 -d:DProf test.pl
.Ve
.PP
Then run dprofpp to analyze the profile.  The output of dprofpp depends
on the flags to the program and the version of Perl you're using.
.PP
.Vb 9
\&        $ dprofpp -u
\&        Total Elapsed Time =    1.67 Seconds
\&                 User Time =    0.61 Seconds
\&        Exclusive Times
\&        %Time Seconds     #Calls sec/call Name
\&         52.4   0.320          2   0.1600 main::foo
\&         45.9   0.280        200   0.0014 main::bar
\&         0.00   0.000          1   0.0000 DynaLoader::import
\&         0.00   0.000          1   0.0000 main::baz
.Ve
.PP
The dprofpp tool can also run the profiler before analyzing the profile
data.  The above two commands can be executed with one dprofpp command.
.PP
.Vb 1
\&        $ dprofpp -u -p test.pl
.Ve
.PP
Consult \*(L"\s-1PROFILE\s0 \s-1FORMAT\s0\*(R" in Devel::DProf for a description of the raw profile.
.SH "OUTPUT"
.IX Header "OUTPUT"
Columns are:
.IP "%Time" 4
.IX Item "%Time"
Percentage of time spent in this routine.
.IP "#Calls" 4
.IX Item "#Calls"
Number of calls to this routine.
.IP "sec/call" 4
.IX Item "sec/call"
Average number of seconds per call to this routine.
.IP "Name" 4
.IX Item "Name"
Name of routine.
.IP "CumulS" 4
.IX Item "CumulS"
Time (in seconds) spent in this routine and routines called from it.
.IP "ExclSec" 4
.IX Item "ExclSec"
Time (in seconds) spent in this routine (not including those called
from it).
.IP "Csec/c" 4
.IX Item "Csec/c"
Average time (in seconds) spent in each call of this routine
(including those called from it).
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-a\fR" 5
.IX Item "-a"
Sort alphabetically by subroutine names.
.IP "\fB\-d\fR" 5
.IX Item "-d"
Reverse whatever sort is used
.IP "\fB\-A\fR" 5
.IX Item "-A"
Count timing for autoloaded subroutine as timing for \f(CW*::AUTOLOAD\fR.
Otherwise the time to autoload it is counted as time of the subroutine
itself (there is no way to separate autoload time from run time).
.Sp
This is going to be irrelevant with newer Perls.  They will inform
\&\f(CW\*(C`Devel::DProf\*(C'\fR \fIwhen\fR the \f(CW\*(C`AUTOLOAD\*(C'\fR switches to actual subroutine,
so a separate statistics for \f(CW\*(C`AUTOLOAD\*(C'\fR will be collected no matter
whether this option is set.
.IP "\fB\-R\fR" 5
.IX Item "-R"
Count anonymous subroutines defined in the same package separately.
.IP "\fB\-E\fR" 5
.IX Item "-E"
(default)  Display all subroutine times exclusive of child subroutine times.
.IP "\fB\-F\fR" 5
.IX Item "-F"
Force the generation of fake exit timestamps if dprofpp reports that the
profile is garbled.  This is only useful if dprofpp determines that the
profile is garbled due to missing exit timestamps.  You're on your own if
you do this.  Consult the \s-1BUGS\s0 section.
.IP "\fB\-I\fR" 5
.IX Item "-I"
Display all subroutine times inclusive of child subroutine times.
.IP "\fB\-l\fR" 5
.IX Item "-l"
Sort by number of calls to the subroutines.  This may help identify
candidates for inlining.
.IP "\fB\-O cnt\fR" 5
.IX Item "-O cnt"
Show only \fIcnt\fR subroutines.  The default is 15.
.IP "\fB\-p script\fR" 5
.IX Item "-p script"
Tells dprofpp that it should profile the given script and then interpret its
profile data.  See \fB\-Q\fR.
.IP "\fB\-Q\fR" 5
.IX Item "-Q"
Used with \fB\-p\fR to tell dprofpp to quit after profiling the script, without
interpreting the data.
.IP "\fB\-q\fR" 5
.IX Item "-q"
Do not display column headers.
.IP "\fB\-r\fR" 5
.IX Item "-r"
Display elapsed real times rather than user+system times.
.IP "\fB\-s\fR" 5
.IX Item "-s"
Display system times rather than user+system times.
.IP "\fB\-T\fR" 5
.IX Item "-T"
Display subroutine call tree to stdout.  Subroutine statistics are
not displayed.
.IP "\fB\-t\fR" 5
.IX Item "-t"
Display subroutine call tree to stdout.  Subroutine statistics are not
displayed.  When a function is called multiple consecutive times at the same
calling level then it is displayed once with a repeat count.
.IP "\fB\-S\fR" 5
.IX Item "-S"
Display \fImerged\fR subroutine call tree to stdout.  Statistics are
displayed for each branch of the tree.  
.Sp
When a function is called multiple (\fInot necessarily consecutive\fR)
times in the same branch then all these calls go into one branch of
the next level.  A repeat count is output together with combined
inclusive, exclusive and kids time.
.Sp
Branches are sorted with regard to inclusive time.
.IP "\fB\-U\fR" 5
.IX Item "-U"
Do not sort.  Display in the order found in the raw profile.
.IP "\fB\-u\fR" 5
.IX Item "-u"
Display user times rather than user+system times.
.IP "\fB\-V\fR" 5
.IX Item "-V"
Print dprofpp's version number and exit.  If a raw profile is found then its
\&\s-1XS_VERSION\s0 variable will be displayed, too.
.IP "\fB\-v\fR" 5
.IX Item "-v"
Sort by average time spent in subroutines during each call.  This may help
identify candidates for inlining. 
.IP "\fB\-z\fR" 5
.IX Item "-z"
(default) Sort by amount of user+system time used.  The first few lines
should show you which subroutines are using the most time.
.ie n .IP "\fB\-g\fR ""subroutine""" 5
.el .IP "\fB\-g\fR \f(CWsubroutine\fR" 5
.IX Item "-g subroutine"
Ignore subroutines except \f(CW\*(C`subroutine\*(C'\fR and whatever is called from it.
.IP "\fB\-G\fR <regexp>" 5
.IX Item "-G <regexp>"
Aggregate \*(L"Group\*(R" all calls matching the pattern together.
For example this can be used to group all calls of a set of packages
.Sp
.Vb 1
\&  -G "(package1::)|(package2::)|(package3::)"
.Ve
.Sp
or to group subroutines by name:
.Sp
.Vb 1
\&  -G "getNum"
.Ve
.IP "\fB\-P\fR" 5
.IX Item "-P"
Used with \-G to aggregate \*(L"Pull\*(R" together all calls that did not match \-G.
.IP "\fB\-f\fR <regexp>" 5
.IX Item "-f <regexp>"
Filter all calls matching the pattern.
.IP "\fB\-h\fR" 5
.IX Item "-h"
Display brief help and exit.
.IP "\fB\-H\fR" 5
.IX Item "-H"
Display long help and exit.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
The environment variable \fB\s-1DPROFPP_OPTS\s0\fR can be set to a string containing
options for dprofpp.  You might use this if you prefer \fB\-I\fR over \fB\-E\fR or
if you want \fB\-F\fR on all the time.
.PP
This was added fairly lazily, so there are some undesirable side effects.
Options on the commandline should override options in DPROFPP_OPTS\-\-but
don't count on that in this version.
.SH "BUGS"
.IX Header "BUGS"
Applications which call \fI_exit()\fR or \fIexec()\fR from within a subroutine
will leave an incomplete profile.  See the \fB\-F\fR option.
.PP
Any bugs in Devel::DProf, or any profiler generating the profile data, could
be visible here.  See \*(L"\s-1BUGS\s0\*(R" in Devel::DProf.
.PP
Mail bug reports and feature requests to the perl5\-porters mailing list at
\&\fI<perl5\-porters@perl.org>\fR.  Bug reports should include the
output of the \fB\-V\fR option.
.SH "FILES"
.IX Header "FILES"
.Vb 2
\&        dprofpp         - profile processor
\&        tmon.out        - raw profile
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl, Devel::DProf, \fItimes\fR\|(2)