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