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

/*
 * Copyright (c) 1983, 1991, 1993, 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. 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.
 */
#ifndef gmon_h
#define gmon_h

/* Size of the 4.4BSD gmon header */
#define GMON_HDRSIZE_BSD44_32 (4 + 4 + 4 + 4 + 4 + (3 * 4))
#define GMON_HDRSIZE_BSD44_64 (8 + 8 + 4 + 4 + 4 + (3 * 4))

#if 0 /* For documentation purposes only.  */
  struct raw_phdr
    {
      char low_pc[sizeof(void *)]; /* base pc address of sample buffer */
      char high_pc[sizeof(void *)];/* 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 */
    };
#endif

#define GMONVERSION     0x00051879

/* Size of the old BSD gmon header */
#define GMON_HDRSIZE_OLDBSD_32 (4 + 4 + 4) 

/* FIXME: Checking host compiler defines here means that we can't
   use a cross gprof alpha OSF.  */
#if defined(__alpha__) && defined (__osf__) 
#define GMON_HDRSIZE_OLDBSD_64 (8 + 8 + 4 + 4)
#else
#define GMON_HDRSIZE_OLDBSD_64 (8 + 8 + 4)
#endif

#if 0 /* For documentation purposes only.  */
  struct old_raw_phdr
    {
      char low_pc[sizeof(void *)]; /* base pc address of sample buffer */
      char high_pc[sizeof(void *)];/* max pc address of sampled buffer */
      char ncnt[4];		   /* size of sample buffer (plus this
				      header) */
#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
    };
#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):
 */
#if 0 /* For documentation purposes only.  */
  struct raw_arc
    {
      char from_pc[sizeof(void *)];
      char self_pc[sizeof(void *)];
      char count[sizeof(long)];
    };
#endif

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