summaryrefslogtreecommitdiff
path: root/static/netbsd/man1/gprofng-display-gmon.1
blob: 54af711096fb95b3b1742e0e33867e3cd032dd8c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.47)
.\"
.\" Standard preamble:
.\" ========================================================================
.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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" 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'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "GPROFNG-DISPLAY-GMON 1"
.TH GPROFNG-DISPLAY-GMON 1 2026-02-10 binutils-2.46.0 "User Commands"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
gprofng\-display\-gmon \- Convert a gmon profile data to a gprofng experiment
.SH SYNOPSIS
.IX Header "SYNOPSIS"
\&\fBgprofng display gmon\fR [\fIoption(s)\fR] [\fItarget\fR [\fIgmon\-file\fR]]
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Reads the \fIgmon.out\fR file and the profiled executable.  With the
executable, we can reconstruct information about the profiled symbols
and the memory map layout.  The \fIgmon.out\fR file provides details
about the execution duration for each symbol, as well as data used to
build the call graph.  The profile data is taken from the call graph
profile file (\fIgmon.out\fR default) which is created by programs
that are compiled with profile arches (i.e., the \fB\-pg\fR option of
\&\f(CW\*(C`cc\*(C'\fR).
.PP
For example, this command converts the profile data (\fIgmon.out\fR)
for an executable called \fBa.out\fR and stores the data collected in
an experiment directory with the name \fBexample.er\fR.
.PP
.Vb 1
\&        $ gprofng display gmon \-o example.er ./a.out gmon.out
.Ve
.SH OPTIONS
.IX Header "OPTIONS"
.IP \fB\-\-version\fR 4
.IX Item "--version"
Print the version number and exit.
.IP \fB\-\-help\fR 4
.IX Item "--help"
Print usage information and exit.
.IP "\fB\-o\fR \fI<exp_name>\fR" 4
.IX Item "-o <exp_name>"
Specify the name for the experiment directory.  The name has to end with
\&\fB.er\fR and may contain an absolute path (e.g. \fI/tmp/experiment.er\fR).
An existing experiment with the same name will not be overwritten.
.IP "\fB\-O\fR \fI<exp_name>\fR" 4
.IX Item "-O <exp_name>"
This is the same as the \fB\-o\fR option, but unlike this option, silently
overwrites an existing experiment directory with the same name.
.SH NOTES
.IX Header "NOTES"
Any executable in the ELF (Executable and Linkable Format) object
format can be used for profiling with gprofng.  If \fItarget\fR is
missing, the default executable name is \fIa.out\fR.  If
\&\fIgmon\-file\fR is missing, the default profile data file name is
\&\fIgmon.out\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBgprofng\fR\|(1),
\&\fBgprofng\-archive\fR\|(1),
\&\fBgprofng\-display\-html\fR\|(1),
\&\fBgprofng\-display\-src\fR\|(1),
\&\fBgprofng\-display\-text\fR\|(1)
.PP
The user guide for gprofng is maintained as a Texinfo manual.  If the
\&\fBinfo\fR and \fBgprofng\fR programs are correctly installed, the
command \fBinfo gprofng\fR should give access to this document.
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c) 2025\-2026 Free Software Foundation, Inc.
.PP
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".