This is the driver for the GPROFNG tools suite to gather and analyze performance data.
The driver executes the action specified. An example of an action is @code{collect}
to collect performance data. Depending on the action, a qualifier may be needed to
define the command. Several qualifiers support options. The last item on the command
is the target the command applies to.
For example, to collect performance data for an application called @code{a.out} and
store the results in experiment directory @code{mydata.er}, the following command may
be used:
@smallexample
$ gprofng collect app -o mydata.er a.out
@end smallexample
In this example, the action is @code{collect}, the qualifier is @code{app}, the single
argument is @code{-o mydata.er} and the target is @code{a.out}.
If gprofng is executed without any additional option, action, or target, a usage
overview is printed.
@c man end
@c man begin OPTIONS
@table @gcctabopt
@item @var{--version}
print the version number and exit.
@item @var{--help}
print usage information and exit.
@end table
@c man end
@c man begin NOTES
The gprofng driver supports the following commands.
@c The man pages for the commands below can be viewed using the command name with "gprofng" replaced by "gp" and the spaces replaced by a dash ("-"). For example the man page
@c name for "gprofng collect app" is "gp-collect-app".
Collect performance data:
@table @code
@item gprofng collect app
collect application performance data.
@end table
Display the performance results:
@table @code
@item gprofng display text
display the performance data in ASCII format.
@item gprofng display html
generate an HTML file from one or more experiments.
@end table
Miscellaneous commands:
@table @code
@item gprofng display src
display source or disassembly with compiler annotations.
@item gprofng archive
include binaries and source code in an experiment directory.
@end table
It is also possible to invoke the lower level commands directly, but since
these are subject to change, in particular the options, we recommend to
use the driver.
@c man end
@c man begin ENVIRONMENT
The following environment variables are supported:
@table @code
@item @env{GPROFNG_MAX_CALL_STACK_DEPTH}
set the depth of the call stack (default is 256).
@item @env{GPROFNG_USE_JAVA_OPTIONS}
may be set when profiling a C/C++ application that uses dlopen() to execute Java code.
@item @env{GPROFNG_SSH_REMOTE_DISPLAY}
use this variable to define the ssh command executed by the remote display tool.
@item @env{GPROFNG_SKIP_VALIDATION}
set this variable to disable checking hardware, system, and Java versions.
@item @env{GPROFNG_ALLOW_CORE_DUMP}
set this variable to allow a core file to be generated; otherwise an error report is created on /tmp.
@item @env{GPROFNG_ARCHIVE}
use this variable to define the settings for automatic archiving upon experiment recording completion.
@item @env{GPROFNG_ARCHIVE_COMMON_DIR}
set this variable to the location of the common archive.
@item @env{GPROFNG_JAVA_MAX_CALL_STACK_DEPTH}
set the depth of the Java call stack; the default is 256; set to 0 to disable capturing of call stacks.
set the depth of the Java native call stack; the default is 256; set to 0 to disable capturing of call stacks (JNI and assembly call stacks are not captured).
@end table
@c man end
@c man begin SEEALSO
The man pages for the various gprofng commands are not available yet, but
the @option{--help} option supported on each of the commands lists the options
and provides more information.
For example this displays the options supported on the @command{gprofng collect app}
command:
@smallexample
$ gprofng collect app --help
@end smallexample
The user guide is available as an Info entry for @file{gprofng}.
@c man end
@end ifset
@c man begin DESCRIPTION
@c man end
@c -- A new node --------------------------------------------------------------
Vladimir Mezentsev
4 years ago