ran "indent -gnu"; have not fixed block comment style
[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     char low_pc[sizeof (bfd_vma)];      /* base pc address of sample buffer */
41     char high_pc[sizeof (bfd_vma)];     /* max pc address of sampled buffer */
42     char ncnt[4];               /* size of sample buffer (plus this header) */
43 #ifdef __osf__
44     /*
45      * DEC's OSF v3.0 uses 4 bytes of padding to bring the header to
46      * a size that is a multiple of 8.
47      */
48     char pad[4];
49 #endif
50   };
51
52 /*
53  * Histogram counters are unsigned shorts:
54  */
55 #define HISTCOUNTER unsigned short
56
57 /*
58  * Fraction of text space to allocate for histogram counters here, 1/2:
59  */
60 #define HISTFRACTION    2
61
62 /*
63  * Fraction of text space to allocate for from hash buckets.  The
64  * value of HASHFRACTION is based on the minimum number of bytes of
65  * separation between two subroutine call points in the object code.
66  * Given MIN_SUBR_SEPARATION bytes of separation the value of
67  * HASHFRACTION is calculated as:
68  *
69  *      HASHFRACTION = MIN_SUBR_SEPARATION / (2 * sizeof(short) - 1);
70  *
71  * For the VAX, the shortest two call sequence is:
72  *
73  *      calls   $0,(r0)
74  *      calls   $0,(r0)
75  *
76  * which is separated by only three bytes, thus HASHFRACTION is 
77  * calculated as:
78  *
79  *      HASHFRACTION = 3 / (2 * 2 - 1) = 1
80  *
81  * Note that the division above rounds down, thus if MIN_SUBR_FRACTION
82  * is less than three, this algorithm will not work!
83  */
84 #define HASHFRACTION 1
85
86 /*
87  * Percent of text space to allocate for tostructs with a minimum:
88  */
89 #define ARCDENSITY      2
90 #define MINARCS         50
91
92 struct tostruct
93   {
94     char *selfpc;
95     int count;
96     unsigned short link;
97   };
98
99 /*
100  * A raw arc, with pointers to the calling site and the called site
101  * and a count.  Everything is defined in terms of characters so
102  * as to get a packed representation (otherwise, different compilers
103  * might introduce different padding):
104  */
105 struct raw_arc
106   {
107     char from_pc[sizeof (bfd_vma)];
108     char self_pc[sizeof (bfd_vma)];
109     char count[sizeof (long)];
110   };
111
112 /*
113  * General rounding functions:
114  */
115 #define ROUNDDOWN(x,y)  (((x)/(y))*(y))
116 #define ROUNDUP(x,y)    ((((x)+(y)-1)/(y))*(y))
117
118 #endif /* gmon_h */