Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
Standard preamble:
========================================================================
..
.... \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.
If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.
Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF ========================================================================
Title "GP-DISPLAY-TEXT.1 1"
way too many mistakes in technical documents.
The input consists of one or more experiment directories. Through commands, the user controls the output.
There is a rich set of commands to control the display of the data. The \fBNOTES section lists the most common ones. The gprofng user guide lists all the commands supported.
Commands specified on the command line need to be prepended with the dash ('-') symbol.
In this example, a function overview will be shown, followed by the source code listing of function my-func, annotated with the performance metrics that have been recorded during the data collection and stored in experiment directory my-exp.er:
.Vb 1 $ gprofng display text -functions -source my-func my-exp.er .Ve
Instead of, or in addition to, specifying these commands on the command line, commands may also be included in a file called the script-file.
Note that the commands are processed and interpreted from left to right, \fIso the order matters.
If this tool is invoked without options, commands, or a script file, it starts in interpreter mode. The user can then issue the commands interactively. The session is terminated with the exit command in the interpreter.
There are many more commands. These are documented in the user guide. Item "callers-callees" In a callers-callees panel, it is shown which function(s) call the target function (the callers) and what functions it is calling (the \fIcallees). This command prints the callers-callees panel for each of the functions, in the order specified by the function sort metric. Item "calltree" Display the dynamic call graph from the experiment, showing the hierarchical metrics at each level. Item "compare {on | off | delta | ratio}" By default, the results for multiple experiments are aggregated. This command changes this to enable the comparison of experiments for certain views (e.g. the function view). The first experiment specified is defined to be the reference. The following options are supported:
Item "on" For each experiment specified on the command line, print the values for the metrics that have been activated for the experiment. Item "off" Disable the comparison of experiments. This is the default. Item "delta" Print the values for the reference experiment. The results for the other experiments are shown as a delta relative to the reference (current-reference). Item "ratio" Print the values for the reference experiment. The results for the other experiments are shown as a ratio relative to the reference (current/reference).
Item "user" Show the Java call stacks for Java threads, but do not show housekeeping threads. The function view includes a function called <JVM-System>. This represents the aggregated time from non-Java threads. In case the JVM software does not report a Java call stack, time is reported against the function <no Java callstack recorded>. Item "expert" Show the Java call stacks for Java threads when the user Java code is executed, and machine call stacks when JVM code is executed, or when the JVM software does not report a Java call stack. Show the machine call stacks for housekeeping threads. Item "machine" Show the actual native call stacks for all threads. This is the view mode for C, C++, and Fortran.
The user guide for gprofng is maintained as a Texinfo manual. If the \fBinfo and gprofng programs are correctly installed, the command info gprofng should give access to this document.
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, with no Front-Cover Texts, and with no Back-Cover Texts. A copy of the license is included in the section entitled "GNU Free Documentation License".