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 * $FreeBSD: src/sys/sys/gmon.h,v 1.15 1999/08/28 00:51:45 peter Exp $ 35 * $DragonFly: src/sys/sys/gmon.h,v 1.2 2003/06/17 04:28:58 dillon Exp $ 36 */ 37 38 #ifndef _SYS_GMON_H_ 39 #define _SYS_GMON_H_ 40 41 #include <machine/profile.h> 42 43 /* 44 * Structure prepended to gmon.out profiling data file. 45 */ 46 struct gmonhdr { 47 u_long lpc; /* base pc address of sample buffer */ 48 u_long hpc; /* max pc address of sampled buffer */ 49 int ncnt; /* size of sample buffer (plus this header) */ 50 int version; /* version number */ 51 int profrate; /* profiling clock rate */ 52 int spare[3]; /* reserved */ 53 /* XXX should record counter size and density */ 54 }; 55 #define GMONVERSION 0x00051879 56 57 /* 58 * Type of histogram counters used in the kernel. 59 */ 60 #ifdef GPROF4 61 #define HISTCOUNTER int64_t 62 #else 63 #define HISTCOUNTER unsigned short 64 #endif 65 66 /* 67 * Fraction of text space to allocate for histogram counters. 68 * We allocate counters at the same or higher density as function 69 * addresses, so that each counter belongs to a unique function. 70 * A lower density of counters would give less resolution but a 71 * higher density would be wasted. 72 */ 73 #define HISTFRACTION (FUNCTION_ALIGNMENT / sizeof(HISTCOUNTER) == 0 \ 74 ? 1 : FUNCTION_ALIGNMENT / sizeof(HISTCOUNTER)) 75 76 /* 77 * Fraction of text space to allocate for from hash buckets. 78 * The value of HASHFRACTION is based on the minimum number of bytes 79 * of separation between two subroutine call points in the object code. 80 * Given MIN_SUBR_SEPARATION bytes of separation the value of 81 * HASHFRACTION is calculated as: 82 * 83 * HASHFRACTION = MIN_SUBR_SEPARATION / (2 * sizeof(short) - 1); 84 * 85 * For example, on the VAX, the shortest two call sequence is: 86 * 87 * calls $0,(r0) 88 * calls $0,(r0) 89 * 90 * which is separated by only three bytes, thus HASHFRACTION is 91 * calculated as: 92 * 93 * HASHFRACTION = 3 / (2 * 2 - 1) = 1 94 * 95 * Note that the division above rounds down, thus if MIN_SUBR_FRACTION 96 * is less than three, this algorithm will not work! 97 * 98 * In practice, however, call instructions are rarely at a minimal 99 * distance. Hence, we will define HASHFRACTION to be 2 across all 100 * architectures. This saves a reasonable amount of space for 101 * profiling data structures without (in practice) sacrificing 102 * any granularity. 103 */ 104 /* 105 * XXX I think the above analysis completely misses the point. I think 106 * the point is that addresses in different functions must hash to 107 * different values. Since the hash is essentially division by 108 * sizeof(unsigned short), the correct formula is: 109 * 110 * HASHFRACTION = MIN_FUNCTION_ALIGNMENT / sizeof(unsigned short) 111 * 112 * Note that he unsigned short here has nothing to do with the one for 113 * HISTFRACTION. 114 * 115 * Hash collisions from a two call sequence don't matter. They get 116 * handled like collisions for calls to different addresses from the 117 * same address through a function pointer. 118 */ 119 #define HASHFRACTION (FUNCTION_ALIGNMENT / sizeof(unsigned short) == 0 \ 120 ? 1 : FUNCTION_ALIGNMENT / sizeof(unsigned short)) 121 122 /* 123 * percent of text space to allocate for tostructs with a minimum. 124 */ 125 #define ARCDENSITY 2 126 #define MINARCS 50 127 128 /* 129 * Limit on the number of arcs to so that arc numbers can be stored in 130 * `*froms' and stored and incremented without overflow in links. 131 */ 132 #define MAXARCS (((u_long)1 << (8 * sizeof(u_short))) - 2) 133 134 struct tostruct { 135 u_long selfpc; 136 long count; 137 u_short link; 138 u_short pad; 139 }; 140 141 /* 142 * a raw arc, with pointers to the calling site and 143 * the called site and a count. 144 */ 145 struct rawarc { 146 u_long raw_frompc; 147 u_long raw_selfpc; 148 long raw_count; 149 }; 150 151 /* 152 * general rounding functions. 153 */ 154 #define ROUNDDOWN(x,y) rounddown(x,y) 155 #define ROUNDUP(x,y) roundup(x,y) 156 157 /* 158 * The profiling data structures are housed in this structure. 159 */ 160 struct gmonparam { 161 int state; 162 HISTCOUNTER *kcount; 163 u_long kcountsize; 164 u_short *froms; 165 u_long fromssize; 166 struct tostruct *tos; 167 u_long tossize; 168 long tolimit; 169 uintfptr_t lowpc; 170 uintfptr_t highpc; 171 u_long textsize; 172 u_long hashfraction; 173 int profrate; /* XXX wrong type to match gmonhdr */ 174 HISTCOUNTER *cputime_count; 175 int cputime_overhead; 176 HISTCOUNTER *mcount_count; 177 int mcount_overhead; 178 int mcount_post_overhead; 179 int mcount_pre_overhead; 180 HISTCOUNTER *mexitcount_count; 181 int mexitcount_overhead; 182 int mexitcount_post_overhead; 183 int mexitcount_pre_overhead; 184 }; 185 extern struct gmonparam _gmonparam; 186 187 /* 188 * Possible states of profiling. 189 */ 190 #define GMON_PROF_ON 0 191 #define GMON_PROF_BUSY 1 192 #define GMON_PROF_ERROR 2 193 #define GMON_PROF_OFF 3 194 #define GMON_PROF_HIRES 4 195 196 /* 197 * Sysctl definitions for extracting profiling information from the kernel. 198 */ 199 #define GPROF_STATE 0 /* int: profiling enabling variable */ 200 #define GPROF_COUNT 1 /* struct: profile tick count buffer */ 201 #define GPROF_FROMS 2 /* struct: from location hash bucket */ 202 #define GPROF_TOS 3 /* struct: destination/count structure */ 203 #define GPROF_GMONPARAM 4 /* struct: profiling parameters (see above) */ 204 205 #endif /* !_SYS_GMON_H_ */ 206