1 /* 2 * Copyright (c) 2000-2018 Apple Inc. All rights reserved. 3 * 4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@ 5 * 6 * This file contains Original Code and/or Modifications of Original Code 7 * as defined in and that are subject to the Apple Public Source License 8 * Version 2.0 (the 'License'). You may not use this file except in 9 * compliance with the License. The rights granted to you under the License 10 * may not be used to create, or enable the creation or redistribution of, 11 * unlawful or unlicensed copies of an Apple operating system, or to 12 * circumvent, violate, or enable the circumvention or violation of, any 13 * terms of an Apple operating system software license agreement. 14 * 15 * Please obtain a copy of the License at 16 * http://www.opensource.apple.com/apsl/ and read it before using this file. 17 * 18 * The Original Code and all software distributed under the License are 19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER 20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES, 21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY, 22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT. 23 * Please see the License for the specific language governing rights and 24 * limitations under the License. 25 * 26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@ 27 */ 28 /* Copyright (c) 1995 NeXT Computer, Inc. All Rights Reserved */ 29 /*- 30 * Copyright (c) 1982, 1986, 1992, 1993 31 * The Regents of the University of California. All rights reserved. 32 * 33 * Redistribution and use in source and binary forms, with or without 34 * modification, are permitted provided that the following conditions 35 * are met: 36 * 1. Redistributions of source code must retain the above copyright 37 * notice, this list of conditions and the following disclaimer. 38 * 2. Redistributions in binary form must reproduce the above copyright 39 * notice, this list of conditions and the following disclaimer in the 40 * documentation and/or other materials provided with the distribution. 41 * 3. All advertising materials mentioning features or use of this software 42 * must display the following acknowledgement: 43 * This product includes software developed by the University of 44 * California, Berkeley and its contributors. 45 * 4. Neither the name of the University nor the names of its contributors 46 * may be used to endorse or promote products derived from this software 47 * without specific prior written permission. 48 * 49 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 50 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 51 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 52 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 53 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 54 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 55 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 56 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 57 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 58 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 59 * SUCH DAMAGE. 60 * 61 * @(#)gmon.h 8.2 (Berkeley) 1/4/94 62 */ 63 64 #ifndef _SYS_GMON_H_ 65 #define _SYS_GMON_H_ 66 #include <stdint.h> 67 #include <sys/types.h> 68 69 /* 70 * Structure prepended to gmon.out profiling data file. 71 */ 72 struct gmonhdr { 73 uint32_t lpc; /* base pc address of sample buffer */ 74 uint32_t hpc; /* max pc address of sampled buffer */ 75 uint32_t ncnt; /* size of sample buffer (plus this header) */ 76 int32_t version; /* version number */ 77 int32_t profrate; /* profiling clock rate */ 78 int32_t spare[3]; /* reserved */ 79 }; 80 #define GMONVERSION 0x00051879 81 82 struct gmonhdr_64 { 83 uint64_t lpc; /* base pc address of sample buffer */ 84 uint64_t hpc; /* max pc address of sampled buffer */ 85 uint32_t ncnt; /* size of sample buffer (plus this header) */ 86 int32_t version; /* version number */ 87 int32_t profrate; /* profiling clock rate */ 88 int32_t spare[3]; /* reserved */ 89 }; 90 91 typedef struct 92 #ifndef __LP64__ 93 gmonhdr 94 #else 95 gmonhdr_64 96 #endif 97 gmonhdr_t; 98 99 /* 100 * histogram counters are unsigned shorts (according to the kernel). 101 */ 102 #define HISTCOUNTER unsigned short 103 104 /* 105 * fraction of text space to allocate for histogram counters here, 1/2 106 */ 107 #define HISTFRACTION 2 108 109 /* 110 * Fraction of text space to allocate for from hash buckets. 111 * The value of HASHFRACTION is based on the minimum number of bytes 112 * of separation between two subroutine call points in the object code. 113 * Given MIN_SUBR_SEPARATION bytes of separation the value of 114 * HASHFRACTION is calculated as: 115 * 116 * HASHFRACTION = MIN_SUBR_SEPARATION / (2 * sizeof(short) - 1); 117 * 118 * For example, on the VAX, the shortest two call sequence is: 119 * 120 * calls $0,(r0) 121 * calls $0,(r0) 122 * 123 * which is separated by only three bytes, thus HASHFRACTION is 124 * calculated as: 125 * 126 * HASHFRACTION = 3 / (2 * 2 - 1) = 1 127 * 128 * Note that the division above rounds down, thus if MIN_SUBR_FRACTION 129 * is less than three, this algorithm will not work! 130 * 131 * In practice, however, call instructions are rarely at a minimal 132 * distance. Hence, we will define HASHFRACTION to be 2 across all 133 * architectures. This saves a reasonable amount of space for 134 * profiling data structures without (in practice) sacrificing 135 * any granularity. 136 */ 137 #define HASHFRACTION 2 138 139 /* 140 * percent of text space to allocate for tostructs with a minimum. 141 */ 142 #define ARCDENSITY 2 143 #define MINARCS 50 144 #define MAXARCS ((1 << (8 * sizeof(HISTCOUNTER))) - 2) 145 146 struct tostruct { 147 uint32_t selfpc; 148 int32_t count; 149 uint16_t link; 150 uint16_t order; 151 }; 152 153 struct tostruct_64 { 154 uint64_t selfpc; 155 int32_t count; 156 uint16_t link; 157 uint16_t order; 158 }; 159 160 typedef struct 161 #ifndef __LP64__ 162 tostruct 163 #else 164 tostruct_64 165 #endif 166 tostruct_t; 167 168 /* 169 * a raw arc, with pointers to the calling site and 170 * the called site and a count. 171 */ 172 struct rawarc { 173 uint32_t raw_frompc; 174 uint32_t raw_selfpc; 175 int32_t raw_count; 176 }; 177 178 struct rawarc_64 { 179 uint64_t raw_frompc; 180 uint64_t raw_selfpc; 181 int32_t raw_count; 182 }; 183 184 typedef struct 185 #ifndef __LP64__ 186 rawarc 187 #else 188 rawarc_64 189 #endif 190 rawarc_t; 191 192 /* 193 * general rounding functions. 194 */ 195 #define ROUNDDOWN(x, y) (((x)/(y))*(y)) 196 #define ROUNDUP(x, y) ((((x)+(y)-1)/(y))*(y)) 197 198 /* 199 * The profiling data structures are housed in this structure. 200 */ 201 struct gmonparam { 202 int state; 203 u_short *kcount; 204 u_long kcountsize; 205 u_short *froms; 206 u_long fromssize; 207 tostruct_t *tos; 208 u_long tossize; 209 long tolimit; 210 u_long lowpc; 211 u_long highpc; 212 u_long textsize; 213 u_long hashfraction; 214 }; 215 extern struct gmonparam _gmonparam; 216 217 /* 218 * Possible states of profiling. 219 */ 220 #define GMON_PROF_ON 0 221 #define GMON_PROF_BUSY 1 222 #define GMON_PROF_ERROR 2 223 #define GMON_PROF_OFF 3 224 225 /* 226 * In order to support more information than in the original mon.out and 227 * gmon.out files there is an alternate gmon.out file format. The alternate 228 * gmon.out file format starts with a magic number then separates the 229 * information with gmon_data_t's. 230 */ 231 #define GMON_MAGIC 0xbeefbabe 232 #define GMON_MAGIC_64 0xbeefbabf 233 typedef struct gmon_data { 234 uint32_t type; /* constant for type of data following this struct */ 235 uint32_t size; /* size in bytes of the data following this struct */ 236 } gmon_data_t; 237 238 /* 239 * The GMONTYPE_SAMPLES gmon_data.type is for the histogram counters described 240 * above and has a gmonhdr_t followed by the counters. 241 */ 242 #define GMONTYPE_SAMPLES 1 243 /* 244 * The GMONTYPE_RAWARCS gmon_data.type is for the raw arcs described above. 245 */ 246 #define GMONTYPE_RAWARCS 2 247 /* 248 * The GMONTYPE_ARCS_ORDERS gmon_data.type is for the raw arcs with a call 249 * order field. The order is the order is a sequence number for the order each 250 * call site was executed. Raw_order values start at 1 not zero. Other than 251 * the raw_order field this is the same information as in the rawarc_t. 252 */ 253 #define GMONTYPE_ARCS_ORDERS 3 254 struct rawarc_order { 255 uint32_t raw_frompc; 256 uint32_t raw_selfpc; 257 uint32_t raw_count; 258 uint32_t raw_order; 259 }; struct rawarc_order_64 { 260 uint64_t raw_frompc; 261 uint64_t raw_selfpc; 262 uint32_t raw_count; 263 uint32_t raw_order; 264 }; 265 266 typedef struct 267 #ifndef __LP64__ 268 rawarc_order 269 #else 270 rawarc_order_64 271 #endif 272 rawarc_order_t; 273 274 /* 275 * The GMONTYPE_DYLD_STATE gmon_data.type is for the dynamic link editor state 276 * of the program. 277 * The informations starts with an uint32_t with the count of states: 278 * image_count 279 * Then each state follows in the file. The state is made up of 280 * vmaddr_slide (the amount dyld slid this image from it's vmaddress) 281 * name (the file name dyld loaded this image from) 282 * The vmaddr_slide is a 32-bit value for 32-bit programs and 64-bit value for 283 * 64-bit programs. 284 */ 285 #define GMONTYPE_DYLD_STATE 4 286 287 /* 288 * The GMONTYPE_DYLD2_STATE gmon_data.type is for the dynamic link editor state 289 * of the program. 290 * The informations starts with an uint32_t with the count of states: 291 * image_count 292 * Then each state follows in the file. The state is made up of 293 * image_header (the address where dyld loaded this image) 294 * name (the file name dyld loaded this image from) 295 * The image_header is a 32-bit value for 32-bit programs and 64-bit value for 296 * 64-bit programs. 297 */ 298 #define GMONTYPE_DYLD2_STATE 5 299 300 #endif /* !_SYS_GMON_H_ */ 301