[newlib-cygwin.git] / winsup / cygwin / gmon.h

/*	$OpenBSD: gmon.h,v 1.3 1996/04/21 22:31:46 deraadt Exp $	*/
/*	$NetBSD: gmon.h,v 1.5 1996/04/09 20:55:30 cgd Exp $	*/

/*-
 * Copyright (c) 1982, 1986, 1992, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)gmon.h	8.2 (Berkeley) 1/4/94
 */

#ifndef _SYS_GMON_H_
#define _SYS_GMON_H_

#ifndef __P
#define __P(x) x
#endif

#include <profile.h>

/*
 * Structure prepended to gmon.out profiling data file.
 */
struct gmonhdr {
	u_long	lpc;		/* base pc address of sample buffer */
	u_long	hpc;		/* max pc address of sampled buffer */
	int	ncnt;		/* size of sample buffer (plus this header) */
	int	version;	/* version number */
	int	profrate;	/* profiling clock rate */
	int	spare[3];	/* reserved */
};
#define GMONVERSION	0x00051879

/*
 * histogram counters are unsigned shorts (according to the kernel).
 */
#define	HISTCOUNTER	unsigned short

/*
 * fraction of text space to allocate for histogram counters here, 1/2
 */
#define	HISTFRACTION	2

/*
 * Fraction of text space to allocate for from hash buckets.
 * The value of HASHFRACTION is based on the minimum number of bytes
 * of separation between two subroutine call points in the object code.
 * Given MIN_SUBR_SEPARATION bytes of separation the value of
 * HASHFRACTION is calculated as:
 *
 *	HASHFRACTION = MIN_SUBR_SEPARATION / (2 * sizeof(short) - 1);
 *
 * For example, on the VAX, the shortest two call sequence is:
 *
 *	calls	$0,(r0)
 *	calls	$0,(r0)
 *
 * which is separated by only three bytes, thus HASHFRACTION is
 * calculated as:
 *
 *	HASHFRACTION = 3 / (2 * 2 - 1) = 1
 *
 * Note that the division above rounds down, thus if MIN_SUBR_FRACTION
 * is less than three, this algorithm will not work!
 *
 * In practice, however, call instructions are rarely at a minimal
 * distance.  Hence, we will define HASHFRACTION to be 2 across all
 * architectures.  This saves a reasonable amount of space for
 * profiling data structures without (in practice) sacrificing
 * any granularity.
 */
#define	HASHFRACTION	2

/*
 * percent of text space to allocate for tostructs with a minimum.
 */
#define ARCDENSITY	2
#define MINARCS		50
#define MAXARCS		((1 << (8 * sizeof(HISTCOUNTER))) - 2)

struct tostruct {
	u_long	selfpc;
	long	count;
	u_short	link;
	u_short pad;
};

/*
 * a raw arc, with pointers to the calling site and
 * the called site and a count.
 */
struct rawarc {
	u_long	raw_frompc;
	u_long	raw_selfpc;
	long	raw_count;
};

/*
 * general rounding functions.
 */
#define ROUNDDOWN(x,y)	(((x)/(y))*(y))
#define ROUNDUP(x,y)	((((x)+(y)-1)/(y))*(y))

/*
 * The profiling data structures are housed in this structure.
 */
struct gmonparam {
	int		state;
	u_short		*kcount;
	u_long		kcountsize;
	u_short		*froms;
	u_long		fromssize;
	struct tostruct	*tos;
	u_long		tossize;
	long		tolimit;
	u_long		lowpc;
	u_long		highpc;
	u_long		textsize;
	u_long		hashfraction;
};
extern struct gmonparam _gmonparam;

/*
 * Possible states of profiling.
 */
#define	GMON_PROF_ON	0
#define	GMON_PROF_BUSY	1
#define	GMON_PROF_ERROR	2
#define	GMON_PROF_OFF	3

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