winsup/cygwin/local_includes/gmon.h

   1 /*      $OpenBSD: gmon.h,v 1.3 1996/04/21 22:31:46 deraadt Exp $        */
   2 /*      $NetBSD: gmon.h,v 1.5 1996/04/09 20:55:30 cgd Exp $     */
   3
   4 /*-
   5  * Copyright (c) 1982, 1986, 1992, 1993
   6  *      The Regents of the University of California.  All rights reserved.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 4. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      @(#)gmon.h      8.2 (Berkeley) 1/4/94
  33  */
  34
  35 /*
  36  * This file is taken from Cygwin distribution. Please keep it in sync.
  37  * The differences should be within __MINGW32__ guard.
  38  */
  39
  40 #ifndef _SYS_GMON_H_
  41 #define _SYS_GMON_H_
  42
  43 #ifndef __P
  44 #define __P(x) x
  45 #endif
  46
  47 /* On POSIX systems, profile.h is a KRB5 header.  To avoid collisions, just
  48    pull in profile.h's content here.  The profile.h header won't be provided
  49    by Mingw-w64 anymore at one point. */
  50 #if 0
  51 #include <profile.h>
  52 #else
  53 #define _MCOUNT_CALL
  54 extern void mcount(void);
  55 #define _MCOUNT_DECL __attribute__((gnu_inline)) __inline__ \
  56    void _MCOUNT_CALL _mcount_private
  57 #define MCOUNT
  58 #endif
  59
  60 #ifdef __MINGW32__
  61 #include <_bsd_types.h>
  62 #endif /* __MINGW32__*/
  63 #ifdef __CYGWIN__
  64 #include <winsup.h>
  65 #endif
  66
  67 /*
  68  * Structure prepended to gmon.out profiling data file.
  69  */
  70 struct gmonhdr {
  71         size_t  lpc;            /* base pc address of sample buffer */
  72         size_t  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         size_t          selfpc;
 129         long            count;
 130         u_int16_t       link;
 131         u_int16_t       pad;
 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         size_t  raw_frompc;
 140         size_t  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         volatile LONG   state;
 155         u_int16_t       *kcount;
 156         size_t          kcountsize;
 157         u_int16_t       *froms;
 158         size_t          fromssize;
 159         struct tostruct *tos;
 160         size_t          tossize;
 161         long            tolimit;
 162         size_t          lowpc;
 163         size_t          highpc;
 164         size_t          textsize;
 165         size_t          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 #endif /* !_SYS_GMONH_ */