Sun Feb 25 22:36:10 1996 David Mosberger-Tang <davidm@azstarnet.com>
[kopensolaris-gnu/glibc.git] / gmon / sys / gmon.h
1 /*-
2  * Copyright (c) 1982, 1986, 1992, 1993
3  *      The Regents of the University of California.  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      8.2 (Berkeley) 1/4/94
34  */
35
36 #ifndef _SYS_GMON_H_
37 #define _SYS_GMON_H_
38
39 #include <sys/cdefs.h>
40
41 /*
42  * See gmon_out.h for gmon.out format.
43  */
44
45 /* structure emitted by "gcc -a".  This must match struct bb in
46    gcc/libgcc2.c.  It is OK for gcc to declare a longer structure as
47    long as the members below are present.  */
48 struct __bb
49 {
50   long                  zero_word;
51   const char            *filename;
52   long                  *counts;
53   long                  ncounts;
54   struct __bb           *next;
55   const unsigned long   *addresses;
56 };
57
58 extern struct __bb *__bb_head;
59
60 /*
61  * histogram counters are unsigned shorts (according to the kernel).
62  */
63 #define HISTCOUNTER     unsigned short
64
65 /*
66  * fraction of text space to allocate for histogram counters here, 1/2
67  */
68 #define HISTFRACTION    2
69
70 /*
71  * Fraction of text space to allocate for from hash buckets.
72  * The value of HASHFRACTION is based on the minimum number of bytes
73  * of separation between two subroutine call points in the object code.
74  * Given MIN_SUBR_SEPARATION bytes of separation the value of
75  * HASHFRACTION is calculated as:
76  *
77  *      HASHFRACTION = MIN_SUBR_SEPARATION / (2 * sizeof(short) - 1);
78  *
79  * For example, on the VAX, the shortest two call sequence is:
80  *
81  *      calls   $0,(r0)
82  *      calls   $0,(r0)
83  *
84  * which is separated by only three bytes, thus HASHFRACTION is
85  * calculated as:
86  *
87  *      HASHFRACTION = 3 / (2 * 2 - 1) = 1
88  *
89  * Note that the division above rounds down, thus if MIN_SUBR_FRACTION
90  * is less than three, this algorithm will not work!
91  *
92  * In practice, however, call instructions are rarely at a minimal
93  * distance.  Hence, we will define HASHFRACTION to be 2 across all
94  * architectures.  This saves a reasonable amount of space for
95  * profiling data structures without (in practice) sacrificing
96  * any granularity.
97  */
98 #define HASHFRACTION    2
99
100 /*
101  * percent of text space to allocate for tostructs with a minimum.
102  */
103 #define ARCDENSITY      2
104 #define MINARCS         50
105 #define MAXARCS         ((1 << (8 * sizeof(HISTCOUNTER))) - 2)
106
107 struct tostruct {
108         u_long  selfpc;
109         long    count;
110         u_short link;
111         u_short pad;
112 };
113
114 /*
115  * a raw arc, with pointers to the calling site and
116  * the called site and a count.
117  */
118 struct rawarc {
119         u_long  raw_frompc;
120         u_long  raw_selfpc;
121         long    raw_count;
122 };
123
124 /*
125  * general rounding functions.
126  */
127 #define ROUNDDOWN(x,y)  (((x)/(y))*(y))
128 #define ROUNDUP(x,y)    ((((x)+(y)-1)/(y))*(y))
129
130 /*
131  * The profiling data structures are housed in this structure.
132  */
133 struct gmonparam {
134         int             state;
135         u_short         *kcount;
136         u_long          kcountsize;
137         u_short         *froms;
138         u_long          fromssize;
139         struct tostruct *tos;
140         u_long          tossize;
141         long            tolimit;
142         u_long          lowpc;
143         u_long          highpc;
144         u_long          textsize;
145         u_long          hashfraction;
146         long            log_hashfraction;
147 };
148 extern struct gmonparam _gmonparam;
149
150 /*
151  * Possible states of profiling.
152  */
153 #define GMON_PROF_ON    0
154 #define GMON_PROF_BUSY  1
155 #define GMON_PROF_ERROR 2
156 #define GMON_PROF_OFF   3
157
158 /*
159  * Sysctl definitions for extracting profiling information from the kernel.
160  */
161 #define GPROF_STATE     0       /* int: profiling enabling variable */
162 #define GPROF_COUNT     1       /* struct: profile tick count buffer */
163 #define GPROF_FROMS     2       /* struct: from location hash bucket */
164 #define GPROF_TOS       3       /* struct: destination/count structure */
165 #define GPROF_GMONPARAM 4       /* struct: profiling parameters (see above) */
166
167 __BEGIN_DECLS
168
169 /* Set up data structures and start profiling.  */
170 void monstartup __P ((u_long lowpc, u_long highpc));
171
172 /* Clean up profiling and write out gmon.out.  */
173 void _mcleanup __P ((void));
174
175 __END_DECLS
176
177 #endif /* !_SYS_GMON_H_ */