bsd/sys/gmon.h

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