1/* $OpenBSD: gmon.h,v 1.12 2025/07/16 16:22:58 deraadt Exp $ */
2/* $NetBSD: gmon.h,v 1.5 1996/04/09 20:55:30 cgd Exp $ */
3
4/*-
5 * Copyright (c) 1982, 1986, 1992, 1993
6 * The Regents of the University of California. All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
16 * 3. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 * SUCH DAMAGE.
31 *
32 * @(#)gmon.h 8.2 (Berkeley) 1/4/94
33 */
34
35#ifndef _SYS_GMON_H_
36#define _SYS_GMON_H_
37
38#include <sys/queue.h>
39#include <machine/profile.h>
40
41/*
42 * Structure prepended to gmon.out profiling data file.
43 */
44struct gmonhdr {
45 u_long lpc; /* base pc address of sample buffer */
46 u_long hpc; /* max pc address of sampled buffer */
47 int ncnt; /* size of sample buffer (plus this header) */
48 int version; /* version number */
49 int profrate; /* profiling clock rate */
50 int totarc; /* space used by arcs */
51 int spare[2]; /* reserved */
52};
53#define GMONVERSION 0x00051879
54
55/*
56 * histogram counters are unsigned shorts (according to the kernel).
57 */
58#define HISTCOUNTER unsigned short
59
60/*
61 * fraction of text space to allocate for histogram counters here, 1/2
62 */
63#define HISTFRACTION 2
64
65/*
66 * Fraction of text space to allocate for from hash buckets.
67 * The value of HASHFRACTION is based on the minimum number of bytes
68 * of separation between two subroutine call points in the object code.
69 * Given MIN_SUBR_SEPARATION bytes of separation the value of
70 * HASHFRACTION is calculated as:
71 *
72 * HASHFRACTION = MIN_SUBR_SEPARATION / (2 * sizeof(short) - 1);
73 *
74 * For example, on the VAX, the shortest two call sequence is:
75 *
76 * calls $0,(r0)
77 * calls $0,(r0)
78 *
79 * which is separated by only three bytes, thus HASHFRACTION is
80 * calculated as:
81 *
82 * HASHFRACTION = 3 / (2 * 2 - 1) = 1
83 *
84 * Note that the division above rounds down, thus if MIN_SUBR_FRACTION
85 * is less than three, this algorithm will not work!
86 *
87 * In practice, however, call instructions are rarely at a minimal
88 * distance. Hence, we will define HASHFRACTION to be 2 across all
89 * architectures. This saves a reasonable amount of space for
90 * profiling data structures without (in practice) sacrificing
91 * any granularity.
92 */
93#define HASHFRACTION 2
94
95/*
96 * percent of text space to allocate for tostructs with a minimum.
97 */
98#define ARCDENSITY 2
99#define MINARCS 50
100#define MAXARCS ((1 << (8 * sizeof(HISTCOUNTER))) - 2)
101
102struct tostruct {
103 u_long selfpc;
104 long count;
105 u_short link;
106 u_short pad;
107};
108
109/*
110 * a raw arc, with pointers to the calling site and
111 * the called site and a count.
112 */
113struct rawarc {
114 u_long raw_frompc;
115 u_long raw_selfpc;
116 long raw_count;
117};
118
119/*
120 * general rounding functions.
121 */
122#define ROUNDDOWN(x,y) (((x)/(y))*(y))
123#define ROUNDUP(x,y) ((((x)+(y)-1)/(y))*(y))
124
125/*
126 * The profiling data structures are housed in this structure.
127 */
128struct gmonparam {
129 int state;
130 u_short *kcount;
131 u_long kcountsize;
132 u_short *froms;
133 u_long fromssize;
134 struct tostruct *tos;
135 u_long tossize;
136 long tolimit;
137 u_long lowpc;
138 u_long highpc;
139 u_long textsize;
140 u_long hashfraction;
141 void *outbuf;
142 size_t outbuflen;
143 void *rawarcs;
144 int dirfd;
145 SLIST_ENTRY(gmonparam) list;
146};
147
148/*
149 * Possible states of profiling.
150 */
151#define GMON_PROF_ON 0
152#define GMON_PROF_BUSY 1
153#define GMON_PROF_ERROR 2
154#define GMON_PROF_OFF 3
155
156/*
157 * Sysctl definitions for extracting profiling information from the kernel.
158 */
159#define GPROF_STATE 0 /* int: profiling enabling variable */
160#define GPROF_COUNT 1 /* struct: profile tick count buffer */
161#define GPROF_FROMS 2 /* struct: from location hash bucket */
162#define GPROF_TOS 3 /* struct: destination/count structure */
163#define GPROF_GMONPARAM 4 /* struct: profiling parameters (see above) */
164
165#ifdef _KERNEL
166extern int gmoninit; /* Is the kernel ready for being profiled? */
167
168#else /* !_KERNEL */
169
170#include <sys/cdefs.h>
171
172__BEGIN_DECLS
173extern struct gmonparam _gmonparam;
174void _mcleanup(void);
175void _monstartup(u_long, u_long);
176void moncontrol(int);
177struct gmonparam *_gmon_alloc(void);
178__END_DECLS
179
180#endif /* !_KERNEL */
181
182#endif /* !_SYS_GMON_H_ */