]> git.saurik.com Git - apple/xnu.git/blame - bsd/sys/gmon.h
xnu-4903.241.1.tar.gz
[apple/xnu.git] / bsd / sys / gmon.h
CommitLineData
1c79356b 1/*
2d21ac55 2 * Copyright (c) 2000, 2007 Apple Inc. All rights reserved.
5d5c5d0d 3 *
2d21ac55 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b 5 *
2d21ac55
A
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
8f6c56a5 14 *
2d21ac55
A
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
8f6c56a5
A
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55
A
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
8f6c56a5 25 *
2d21ac55 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b
A
27 */
28/* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */
29/*-
30 * Copyright (c) 1982, 1986, 1992, 1993
31 * The Regents of the University of California. All rights reserved.
32 *
33 * Redistribution and use in source and binary forms, with or without
34 * modification, are permitted provided that the following conditions
35 * are met:
36 * 1. Redistributions of source code must retain the above copyright
37 * notice, this list of conditions and the following disclaimer.
38 * 2. Redistributions in binary form must reproduce the above copyright
39 * notice, this list of conditions and the following disclaimer in the
40 * documentation and/or other materials provided with the distribution.
41 * 3. All advertising materials mentioning features or use of this software
42 * must display the following acknowledgement:
43 * This product includes software developed by the University of
44 * California, Berkeley and its contributors.
45 * 4. Neither the name of the University nor the names of its contributors
46 * may be used to endorse or promote products derived from this software
47 * without specific prior written permission.
48 *
49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
52 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
59 * SUCH DAMAGE.
60 *
61 * @(#)gmon.h 8.2 (Berkeley) 1/4/94
62 */
63
64#ifndef _SYS_GMON_H_
65#define _SYS_GMON_H_
2d21ac55 66#include <stdint.h>
1c79356b
A
67
68/*
69 * Structure prepended to gmon.out profiling data file.
70 */
71struct gmonhdr {
2d21ac55
A
72 uint32_t lpc; /* base pc address of sample buffer */
73 uint32_t hpc; /* max pc address of sampled buffer */
74 uint32_t ncnt; /* size of sample buffer (plus this header) */
75 int32_t version; /* version number */
76 int32_t profrate; /* profiling clock rate */
77 int32_t spare[3]; /* reserved */
1c79356b
A
78};
79#define GMONVERSION 0x00051879
80
2d21ac55
A
81struct gmonhdr_64 {
82 uint64_t lpc; /* base pc address of sample buffer */
83 uint64_t hpc; /* max pc address of sampled buffer */
84 uint32_t ncnt; /* size of sample buffer (plus this header) */
85 int32_t version; /* version number */
86 int32_t profrate; /* profiling clock rate */
87 int32_t spare[3]; /* reserved */
88};
89
90typedef struct
91#ifndef __LP64__
92 gmonhdr
93#else
94 gmonhdr_64
95#endif
96gmonhdr_t;
97
1c79356b
A
98/*
99 * histogram counters are unsigned shorts (according to the kernel).
100 */
101#define HISTCOUNTER unsigned short
102
103/*
104 * fraction of text space to allocate for histogram counters here, 1/2
105 */
106#define HISTFRACTION 2
107
108/*
109 * Fraction of text space to allocate for from hash buckets.
110 * The value of HASHFRACTION is based on the minimum number of bytes
111 * of separation between two subroutine call points in the object code.
112 * Given MIN_SUBR_SEPARATION bytes of separation the value of
113 * HASHFRACTION is calculated as:
114 *
115 * HASHFRACTION = MIN_SUBR_SEPARATION / (2 * sizeof(short) - 1);
116 *
117 * For example, on the VAX, the shortest two call sequence is:
118 *
119 * calls $0,(r0)
120 * calls $0,(r0)
121 *
122 * which is separated by only three bytes, thus HASHFRACTION is
123 * calculated as:
124 *
125 * HASHFRACTION = 3 / (2 * 2 - 1) = 1
126 *
127 * Note that the division above rounds down, thus if MIN_SUBR_FRACTION
128 * is less than three, this algorithm will not work!
129 *
130 * In practice, however, call instructions are rarely at a minimal
131 * distance. Hence, we will define HASHFRACTION to be 2 across all
132 * architectures. This saves a reasonable amount of space for
133 * profiling data structures without (in practice) sacrificing
134 * any granularity.
135 */
136#define HASHFRACTION 2
137
138/*
139 * percent of text space to allocate for tostructs with a minimum.
140 */
141#define ARCDENSITY 2
142#define MINARCS 50
143#define MAXARCS ((1 << (8 * sizeof(HISTCOUNTER))) - 2)
144
145struct tostruct {
2d21ac55
A
146 uint32_t selfpc;
147 int32_t count;
148 uint16_t link;
149 uint16_t order;
1c79356b
A
150};
151
2d21ac55
A
152struct tostruct_64 {
153 uint64_t selfpc;
154 int32_t count;
155 uint16_t link;
156 uint16_t order;
157};
158
159typedef struct
160#ifndef __LP64__
161 tostruct
162#else
163 tostruct_64
164#endif
165tostruct_t;
166
1c79356b
A
167/*
168 * a raw arc, with pointers to the calling site and
169 * the called site and a count.
170 */
171struct rawarc {
2d21ac55
A
172 uint32_t raw_frompc;
173 uint32_t raw_selfpc;
174 int32_t raw_count;
175};
176
177struct rawarc_64 {
178 uint64_t raw_frompc;
179 uint64_t raw_selfpc;
180 int32_t raw_count;
1c79356b
A
181};
182
2d21ac55
A
183typedef struct
184#ifndef __LP64__
185 rawarc
186#else
187 rawarc_64
188#endif
189rawarc_t;
190
1c79356b
A
191/*
192 * general rounding functions.
193 */
194#define ROUNDDOWN(x,y) (((x)/(y))*(y))
195#define ROUNDUP(x,y) ((((x)+(y)-1)/(y))*(y))
196
197/*
198 * The profiling data structures are housed in this structure.
199 */
200struct gmonparam {
201 int state;
202 u_short *kcount;
203 u_long kcountsize;
204 u_short *froms;
205 u_long fromssize;
2d21ac55 206 tostruct_t *tos;
1c79356b
A
207 u_long tossize;
208 long tolimit;
209 u_long lowpc;
210 u_long highpc;
211 u_long textsize;
212 u_long hashfraction;
213};
214extern struct gmonparam _gmonparam;
215
216/*
217 * Possible states of profiling.
218 */
219#define GMON_PROF_ON 0
220#define GMON_PROF_BUSY 1
221#define GMON_PROF_ERROR 2
222#define GMON_PROF_OFF 3
223
224/*
225 * Sysctl definitions for extracting profiling information from the kernel.
226 */
227#define GPROF_STATE 0 /* int: profiling enabling variable */
228#define GPROF_COUNT 1 /* struct: profile tick count buffer */
229#define GPROF_FROMS 2 /* struct: from location hash bucket */
230#define GPROF_TOS 3 /* struct: destination/count structure */
231#define GPROF_GMONPARAM 4 /* struct: profiling parameters (see above) */
232
2d21ac55
A
233
234/*
235 * Declarations for various profiling related functions from
236 * bsd/kern/subr_prof.c
237 */
238#ifdef GPROF
239#ifdef XNU_KERNEL_PRIVATE
240
241void kmstartup(void);
242void cfreemem(caddr_t, int); /* Currently only a stub function. */
b0d623f7 243void mcount(uintptr_t, uintptr_t);
2d21ac55
A
244
245#endif /* XNU_KERNEL_PRIVATE */
246#endif /* GPROF */
247
248
1c79356b
A
249/*
250 * In order to support more information than in the original mon.out and
251 * gmon.out files there is an alternate gmon.out file format. The alternate
252 * gmon.out file format starts with a magic number then separates the
2d21ac55 253 * information with gmon_data_t's.
1c79356b
A
254 */
255#define GMON_MAGIC 0xbeefbabe
2d21ac55
A
256#define GMON_MAGIC_64 0xbeefbabf
257typedef struct gmon_data {
258 uint32_t type; /* constant for type of data following this struct */
259 uint32_t size; /* size in bytes of the data following this struct */
260} gmon_data_t;
1c79356b
A
261
262/*
263 * The GMONTYPE_SAMPLES gmon_data.type is for the histogram counters described
2d21ac55 264 * above and has a gmonhdr_t followed by the counters.
1c79356b
A
265 */
266#define GMONTYPE_SAMPLES 1
267/*
268 * The GMONTYPE_RAWARCS gmon_data.type is for the raw arcs described above.
269 */
270#define GMONTYPE_RAWARCS 2
271/*
272 * The GMONTYPE_ARCS_ORDERS gmon_data.type is for the raw arcs with a call
273 * order field. The order is the order is a sequence number for the order each
274 * call site was executed. Raw_order values start at 1 not zero. Other than
2d21ac55 275 * the raw_order field this is the same information as in the rawarc_t.
1c79356b
A
276 */
277#define GMONTYPE_ARCS_ORDERS 3
278struct rawarc_order {
2d21ac55
A
279 uint32_t raw_frompc;
280 uint32_t raw_selfpc;
281 uint32_t raw_count;
282 uint32_t raw_order;
283
284}; struct rawarc_order_64 {
285 uint64_t raw_frompc;
286 uint64_t raw_selfpc;
287 uint32_t raw_count;
288 uint32_t raw_order;
1c79356b 289};
2d21ac55
A
290
291typedef struct
292#ifndef __LP64__
293 rawarc_order
294#else
295 rawarc_order_64
296#endif
297rawarc_order_t;
298
1c79356b
A
299/*
300 * The GMONTYPE_DYLD_STATE gmon_data.type is for the dynamic link editor state
301 * of the program.
2d21ac55 302 * The informations starts with an uint32_t with the count of states:
1c79356b
A
303 * image_count
304 * Then each state follows in the file. The state is made up of
1c79356b
A
305 * vmaddr_slide (the amount dyld slid this image from it's vmaddress)
306 * name (the file name dyld loaded this image from)
2d21ac55
A
307 * The vmaddr_slide is a 32-bit value for 32-bit programs and 64-bit value for
308 * 64-bit programs.
1c79356b
A
309 */
310#define GMONTYPE_DYLD_STATE 4
2d21ac55
A
311
312/*
313 * The GMONTYPE_DYLD2_STATE gmon_data.type is for the dynamic link editor state
314 * of the program.
315 * The informations starts with an uint32_t with the count of states:
316 * image_count
317 * Then each state follows in the file. The state is made up of
318 * image_header (the address where dyld loaded this image)
319 * name (the file name dyld loaded this image from)
320 * The image_header is a 32-bit value for 32-bit programs and 64-bit value for
321 * 64-bit programs.
322 */
323#define GMONTYPE_DYLD2_STATE 5
324
1c79356b 325#endif /* !_SYS_GMON_H_ */