[deliverable/binutils-gdb.git] / gprof / gmon.h

/*-
 * Copyright (c) 1991, 2001 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	5.2 (Berkeley) 5/6/91
 */
#ifndef gmon_h
#define gmon_h

struct raw_phdr
  {
    /* FIXME: Checking a host compiler define means that we can't use
       a cross gprof to the alpha.  */
    char low_pc[GMON_PTR_SIZE];	/* base pc address of sample buffer */
    char high_pc[GMON_PTR_SIZE];/* max pc address of sampled buffer */
    char ncnt[4];		/* size of sample buffer (plus this header) */

    char version[4];		/* version number */
    char profrate[4];		/* profiling clock rate */
    char spare[3*4];		/* reserved */
  };

#define GMONVERSION     0x00051879

struct old_raw_phdr
  {
    char low_pc[GMON_PTR_SIZE];	/* base pc address of sample buffer */
    char high_pc[GMON_PTR_SIZE];/* max pc address of sampled buffer */
    char ncnt[4];		/* size of sample buffer (plus this header) */

    /* FIXME: Checking host compiler defines here means that we can't
       use a cross gprof alpha OSF.  */
#if defined (__alpha__) && defined (__osf__)
    /*
     * DEC's OSF v3.0 uses 4 bytes of padding to bring the header to
     * a size that is a multiple of 8.
     */
    char pad[4];
#endif
  };

/*
 * Histogram counters are unsigned shorts:
 */
#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 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!
 */
#define	HASHFRACTION 1

/*
 * Percent of text space to allocate for tostructs with a minimum:
 */
#define ARCDENSITY	2
#define MINARCS		50

struct tostruct
  {
    char *selfpc;
    int count;
    unsigned short link;
  };

/*
 * A raw arc, with pointers to the calling site and the called site
 * and a count.  Everything is defined in terms of characters so
 * as to get a packed representation (otherwise, different compilers
 * might introduce different padding):
 */
struct raw_arc
  {
    char from_pc[GMON_PTR_SIZE];
    char self_pc[GMON_PTR_SIZE];
    char count[4];
  };

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

#endif /* gmon_h */
Commit	Line	Data
252b5132	1	/*-
0eee5820	2	* Copyright (c) 1991, 2001 The Regents of the University of California.
252b5132 RH	3	* All rights reserved.
	4	*
	5	* Redistribution and use in source and binary forms, with or without
	6	* modification, are permitted provided that the following conditions
	7	* are met:
	8	* 1. Redistributions of source code must retain the above copyright
	9	* notice, this list of conditions and the following disclaimer.
	10	* 2. Redistributions in binary form must reproduce the above copyright
	11	* notice, this list of conditions and the following disclaimer in the
	12	* documentation and/or other materials provided with the distribution.
	13	* 3. All advertising materials mentioning features or use of this software
	14	* must display the following acknowledgement:
	15	* This product includes software developed by the University of
	16	* California, Berkeley and its contributors.
	17	* 4. Neither the name of the University nor the names of its contributors
	18	* may be used to endorse or promote products derived from this software
	19	* without specific prior written permission.
	20	*
	21	* THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
	22	* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
	23	* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
	24	* ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
	25	* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
	26	* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
	27	* OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
	28	* HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
	29	* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
	30	* OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
	31	* SUCH DAMAGE.
	32	*
	33	* @(#)gmon.h 5.2 (Berkeley) 5/6/91
	34	*/
	35	#ifndef gmon_h
	36	#define gmon_h
	37
	38	struct raw_phdr
	39	{
	40	/* FIXME: Checking a host compiler define means that we can't use
	41	a cross gprof to the alpha. */
0eee5820 AM	42	char low_pc[GMON_PTR_SIZE]; /* base pc address of sample buffer */
0eee5820 AM	43	char high_pc[GMON_PTR_SIZE];/* max pc address of sampled buffer */
252b5132 RH	44	char ncnt[4]; /* size of sample buffer (plus this header) */
	45
	46	char version[4]; /* version number */
	47	char profrate[4]; /* profiling clock rate */
	48	char spare[34]; / reserved */
	49	};
	50
	51	#define GMONVERSION 0x00051879
	52
	53	struct old_raw_phdr
	54	{
0eee5820 AM	55	char low_pc[GMON_PTR_SIZE]; /* base pc address of sample buffer */
0eee5820 AM	56	char high_pc[GMON_PTR_SIZE];/* max pc address of sampled buffer */
252b5132 RH	57	char ncnt[4]; /* size of sample buffer (plus this header) */
	58
	59	/* FIXME: Checking host compiler defines here means that we can't
	60	use a cross gprof alpha OSF. */
	61	#if defined (__alpha__) && defined (__osf__)
	62	/*
	63	* DEC's OSF v3.0 uses 4 bytes of padding to bring the header to
	64	* a size that is a multiple of 8.
	65	*/
	66	char pad[4];
	67	#endif
	68	};
	69
	70	/*
	71	* Histogram counters are unsigned shorts:
	72	*/
	73	#define HISTCOUNTER unsigned short
	74
	75	/*
	76	* Fraction of text space to allocate for histogram counters here, 1/2:
	77	*/
	78	#define HISTFRACTION 2
	79
	80	/*
	81	* Fraction of text space to allocate for from hash buckets. The
	82	* value of HASHFRACTION is based on the minimum number of bytes of
	83	* separation between two subroutine call points in the object code.
	84	* Given MIN_SUBR_SEPARATION bytes of separation the value of
	85	* HASHFRACTION is calculated as:
	86	*
	87	* HASHFRACTION = MIN_SUBR_SEPARATION / (2 * sizeof(short) - 1);
	88	*
	89	* For the VAX, the shortest two call sequence is:
	90	*
	91	* calls $0,(r0)
	92	* calls $0,(r0)
	93	*
0eee5820	94	* which is separated by only three bytes, thus HASHFRACTION is
252b5132 RH	95	* calculated as:
	96	*
	97	* HASHFRACTION = 3 / (2 * 2 - 1) = 1
	98	*
	99	* Note that the division above rounds down, thus if MIN_SUBR_FRACTION
	100	* is less than three, this algorithm will not work!
	101	*/
	102	#define HASHFRACTION 1
	103
	104	/*
	105	* Percent of text space to allocate for tostructs with a minimum:
	106	*/
	107	#define ARCDENSITY 2
	108	#define MINARCS 50
	109
	110	struct tostruct
	111	{
	112	char *selfpc;
	113	int count;
	114	unsigned short link;
	115	};
	116
	117	/*
	118	* A raw arc, with pointers to the calling site and the called site
	119	* and a count. Everything is defined in terms of characters so
	120	* as to get a packed representation (otherwise, different compilers
	121	* might introduce different padding):
	122	*/
	123	struct raw_arc
	124	{
0eee5820 AM	125	char from_pc[GMON_PTR_SIZE];
0eee5820 AM	126	char self_pc[GMON_PTR_SIZE];
252b5132	127	char count[4];
252b5132 RH	128	};
	129
	130	/*
	131	* General rounding functions:
	132	*/
	133	#define ROUNDDOWN(x,y) (((x)/(y))*(y))
	134	#define ROUNDUP(x,y) ((((x)+(y)-1)/(y))*(y))
	135
	136	#endif /* gmon_h */