Mon Mar 17 10:54:47 1997 David Mosberger-Tang <davidm@azstarnet.com>
[external/binutils.git] / gprof / gmon.h
1 /*-
2  * Copyright (c) 1991 The Regents of the University of California.
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: This is wrong; bfd_vma need not correspond any
41        particular size on the target.  */
42     char low_pc[sizeof (bfd_vma)];      /* base pc address of sample buffer */
43     char high_pc[sizeof (bfd_vma)];     /* max pc address of sampled buffer */
44     char ncnt[4];               /* size of sample buffer (plus this header) */
45
46 #if defined (__alpha__) && defined (__osf__)
47     /*
48      * DEC's OSF v3.0 uses 4 bytes of padding to bring the header to
49      * a size that is a multiple of 8.
50      */
51     char pad[4];
52 #else
53 #ifdef BSD44_FORMAT
54     char version[4];                    /* version number */
55     char profrate[4];                   /* profiling clock rate */
56     char spare[3*4];                    /* reserved */
57 #endif
58 #endif
59   };
60
61 /*
62  * Histogram counters are unsigned shorts:
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.  The
73  * value of HASHFRACTION is based on the minimum number of bytes of
74  * 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 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 #define HASHFRACTION 1
94
95 /*
96  * Percent of text space to allocate for tostructs with a minimum:
97  */
98 #define ARCDENSITY      2
99 #define MINARCS         50
100
101 struct tostruct
102   {
103     char *selfpc;
104     int count;
105     unsigned short link;
106   };
107
108 /*
109  * A raw arc, with pointers to the calling site and the called site
110  * and a count.  Everything is defined in terms of characters so
111  * as to get a packed representation (otherwise, different compilers
112  * might introduce different padding):
113  */
114 struct raw_arc
115   {
116     char from_pc[sizeof (bfd_vma)];
117     char self_pc[sizeof (bfd_vma)];
118     char count[sizeof (long)];
119   };
120
121 /*
122  * General rounding functions:
123  */
124 #define ROUNDDOWN(x,y)  (((x)/(y))*(y))
125 #define ROUNDUP(x,y)    ((((x)+(y)-1)/(y))*(y))
126
127 #endif /* gmon_h */