This commit was generated by cvs2svn to track changes on a CVS vendor
[platform/upstream/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: Checking a host compiler define means that we can't use
41        a cross gprof to the alpha.  */
42 #ifdef __alpha__
43     char low_pc[8];             /* base pc address of sample buffer */
44     char high_pc[8];            /* max pc address of sampled buffer */
45 #else
46     char low_pc[4];             /* base pc address of sample buffer */
47     char high_pc[4];            /* max pc address of sampled buffer */
48 #endif
49     char ncnt[4];               /* size of sample buffer (plus this header) */
50
51     char version[4];            /* version number */
52     char profrate[4];           /* profiling clock rate */
53     char spare[3*4];            /* reserved */
54   };
55
56 #define GMONVERSION     0x00051879
57
58 struct old_raw_phdr
59   {
60     /* FIXME: Checking a host compiler define means that we can't use
61        a cross gprof to the alpha.  */
62 #ifdef __alpha__
63     char low_pc[8];             /* base pc address of sample buffer */
64     char high_pc[8];            /* max pc address of sampled buffer */
65 #else
66     char low_pc[4];             /* base pc address of sample buffer */
67     char high_pc[4];            /* max pc address of sampled buffer */
68 #endif
69     char ncnt[4];               /* size of sample buffer (plus this header) */
70
71     /* FIXME: Checking host compiler defines here means that we can't
72        use a cross gprof alpha OSF.  */
73 #if defined (__alpha__) && defined (__osf__)
74     /*
75      * DEC's OSF v3.0 uses 4 bytes of padding to bring the header to
76      * a size that is a multiple of 8.
77      */
78     char pad[4];
79 #endif
80   };
81
82 /*
83  * Histogram counters are unsigned shorts:
84  */
85 #define HISTCOUNTER unsigned short
86
87 /*
88  * Fraction of text space to allocate for histogram counters here, 1/2:
89  */
90 #define HISTFRACTION    2
91
92 /*
93  * Fraction of text space to allocate for from hash buckets.  The
94  * value of HASHFRACTION is based on the minimum number of bytes of
95  * separation between two subroutine call points in the object code.
96  * Given MIN_SUBR_SEPARATION bytes of separation the value of
97  * HASHFRACTION is calculated as:
98  *
99  *      HASHFRACTION = MIN_SUBR_SEPARATION / (2 * sizeof(short) - 1);
100  *
101  * For the VAX, the shortest two call sequence is:
102  *
103  *      calls   $0,(r0)
104  *      calls   $0,(r0)
105  *
106  * which is separated by only three bytes, thus HASHFRACTION is 
107  * calculated as:
108  *
109  *      HASHFRACTION = 3 / (2 * 2 - 1) = 1
110  *
111  * Note that the division above rounds down, thus if MIN_SUBR_FRACTION
112  * is less than three, this algorithm will not work!
113  */
114 #define HASHFRACTION 1
115
116 /*
117  * Percent of text space to allocate for tostructs with a minimum:
118  */
119 #define ARCDENSITY      2
120 #define MINARCS         50
121
122 struct tostruct
123   {
124     char *selfpc;
125     int count;
126     unsigned short link;
127   };
128
129 /*
130  * A raw arc, with pointers to the calling site and the called site
131  * and a count.  Everything is defined in terms of characters so
132  * as to get a packed representation (otherwise, different compilers
133  * might introduce different padding):
134  */
135 struct raw_arc
136   {
137     /* FIXME: Checking a host compiler define means that we can't use
138        a cross gprof to the alpha.  */
139 #ifdef __alpha__
140     char from_pc[8];
141     char self_pc[8];
142     char count[8];
143 #else
144     char from_pc[4];
145     char self_pc[4];
146     char count[4];
147 #endif
148   };
149
150 /*
151  * General rounding functions:
152  */
153 #define ROUNDDOWN(x,y)  (((x)/(y))*(y))
154 #define ROUNDUP(x,y)    ((((x)+(y)-1)/(y))*(y))
155
156 #endif /* gmon_h */