bsd/sys/gmon.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, 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
  67 /*
  68  * Structure prepended to gmon.out profiling data file.
  69  */
  70 struct gmonhdr {
  71         u_long  lpc;            /* base pc address of sample buffer */
  72         u_long  hpc;            /* max pc address of sampled buffer */
  73         int     ncnt;           /* size of sample buffer (plus this header) */
  74         int     version;        /* version number */
  75         int     profrate;       /* profiling clock rate */
  76         int     spare[3];       /* reserved */
  77 };
  78 #define GMONVERSION     0x00051879
  79
  80 /*
  81  * histogram counters are unsigned shorts (according to the kernel).
  82  */
  83 #define HISTCOUNTER     unsigned short
  84
  85 /*
  86  * fraction of text space to allocate for histogram counters here, 1/2
  87  */
  88 #define HISTFRACTION    2
  89
  90 /*
  91  * Fraction of text space to allocate for from hash buckets.
  92  * The value of HASHFRACTION is based on the minimum number of bytes
  93  * of separation between two subroutine call points in the object code.
  94  * Given MIN_SUBR_SEPARATION bytes of separation the value of
  95  * HASHFRACTION is calculated as:
  96  *
  97  *      HASHFRACTION = MIN_SUBR_SEPARATION / (2 * sizeof(short) - 1);
  98  *
  99  * For example, on the VAX, the shortest two call sequence is:
 100  *
 101  *      calls   $0,(r0)
 102  *      calls   $0,(r0)
 103  *
 104  * which is separated by only three bytes, thus HASHFRACTION is
 105  * calculated as:
 106  *
 107  *      HASHFRACTION = 3 / (2 * 2 - 1) = 1
 108  *
 109  * Note that the division above rounds down, thus if MIN_SUBR_FRACTION
 110  * is less than three, this algorithm will not work!
 111  *
 112  * In practice, however, call instructions are rarely at a minimal
 113  * distance.  Hence, we will define HASHFRACTION to be 2 across all
 114  * architectures.  This saves a reasonable amount of space for
 115  * profiling data structures without (in practice) sacrificing
 116  * any granularity.
 117  */
 118 #define HASHFRACTION    2
 119
 120 /*
 121  * percent of text space to allocate for tostructs with a minimum.
 122  */
 123 #define ARCDENSITY      2
 124 #define MINARCS         50
 125 #define MAXARCS         ((1 << (8 * sizeof(HISTCOUNTER))) - 2)
 126
 127 struct tostruct {
 128         u_long  selfpc;
 129         long    count;
 130         u_short link;
 131         u_short order;
 132 };
 133
 134 /*
 135  * a raw arc, with pointers to the calling site and
 136  * the called site and a count.
 137  */
 138 struct rawarc {
 139         u_long  raw_frompc;
 140         u_long  raw_selfpc;
 141         long    raw_count;
 142 };
 143
 144 /*
 145  * general rounding functions.
 146  */
 147 #define ROUNDDOWN(x,y)  (((x)/(y))*(y))
 148 #define ROUNDUP(x,y)    ((((x)+(y)-1)/(y))*(y))
 149
 150 /*
 151  * The profiling data structures are housed in this structure.
 152  */
 153 struct gmonparam {
 154         int             state;
 155         u_short         *kcount;
 156         u_long          kcountsize;
 157         u_short         *froms;
 158         u_long          fromssize;
 159         struct tostruct *tos;
 160         u_long          tossize;
 161         long            tolimit;
 162         u_long          lowpc;
 163         u_long          highpc;
 164         u_long          textsize;
 165         u_long          hashfraction;
 166 };
 167 extern struct gmonparam _gmonparam;
 168
 169 /*
 170  * Possible states of profiling.
 171  */
 172 #define GMON_PROF_ON    0
 173 #define GMON_PROF_BUSY  1
 174 #define GMON_PROF_ERROR 2
 175 #define GMON_PROF_OFF   3
 176
 177 /*
 178  * Sysctl definitions for extracting profiling information from the kernel.
 179  */
 180 #define GPROF_STATE     0       /* int: profiling enabling variable */
 181 #define GPROF_COUNT     1       /* struct: profile tick count buffer */
 182 #define GPROF_FROMS     2       /* struct: from location hash bucket */
 183 #define GPROF_TOS       3       /* struct: destination/count structure */
 184 #define GPROF_GMONPARAM 4       /* struct: profiling parameters (see above) */
 185
 186 /*
 187  * In order to support more information than in the original mon.out and
 188  * gmon.out files there is an alternate gmon.out file format.  The alternate
 189  * gmon.out file format starts with a magic number then separates the
 190  * information with gmon_data structs.
 191  */
 192 #define GMON_MAGIC 0xbeefbabe
 193 struct gmon_data {
 194     unsigned long type; /* constant for type of data following this struct */
 195     unsigned long size; /* size in bytes of the data following this struct */
 196 };
 197
 198 /*
 199  * The GMONTYPE_SAMPLES gmon_data.type is for the histogram counters described
 200  * above and has a struct gmonhdr followed by the counters.
 201  */
 202 #define GMONTYPE_SAMPLES        1
 203 /*
 204  * The GMONTYPE_RAWARCS gmon_data.type is for the raw arcs described above.
 205  */
 206 #define GMONTYPE_RAWARCS        2
 207 /*
 208  * The GMONTYPE_ARCS_ORDERS gmon_data.type is for the raw arcs with a call
 209  * order field.  The order is the order is a sequence number for the order each
 210  * call site was executed.  Raw_order values start at 1 not zero.  Other than
 211  * the raw_order field this is the same information as in the struct rawarc.
 212  */
 213 #define GMONTYPE_ARCS_ORDERS    3
 214 struct rawarc_order {
 215     unsigned long       raw_frompc;
 216     unsigned long       raw_selfpc;
 217     unsigned long       raw_count;
 218     unsigned long       raw_order;
 219 };
 220 /*
 221  * The GMONTYPE_DYLD_STATE gmon_data.type is for the dynamic link editor state
 222  * of the program.
 223  * The informations starts with an unsigned long with the count of states:
 224  *      image_count
 225  * Then each state follows in the file.  The state is made up of
 226  *      image_header (the address where dyld loaded this image)
 227  *      vmaddr_slide (the amount dyld slid this image from it's vmaddress)
 228  *      name (the file name dyld loaded this image from)
 229  */
 230 #define GMONTYPE_DYLD_STATE     4
 231 #endif /* !_SYS_GMON_H_ */