gprof/gmon.h

   1 /*
   2  * Copyright (c) 1983, 1991, 1993, 2001
   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. Neither the name of the University nor the names of its contributors
  14  *    may be used to endorse or promote products derived from this software
  15  *    without specific prior written permission.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  27  * SUCH DAMAGE.
  28  */
  29 #ifndef gmon_h
  30 #define gmon_h
  31
  32 /* Size of the 4.4BSD gmon header */
  33 #define GMON_HDRSIZE_BSD44_32 (4 + 4 + 4 + 4 + 4 + (3 * 4))
  34 #define GMON_HDRSIZE_BSD44_64 (8 + 8 + 4 + 4 + 4 + (3 * 4))
  35
  36 #if 0 /* For documentation purposes only.  */
  37   struct raw_phdr
  38     {
  39       char low_pc[sizeof(void *)]; /* base pc address of sample buffer */
  40       char high_pc[sizeof(void *)];/* max pc address of sampled buffer */
  41       char ncnt[4];                /* size of sample buffer (plus this
  42                                       header) */
  43
  44       char version[4];             /* version number */
  45       char profrate[4];            /* profiling clock rate */
  46       char spare[3*4];             /* reserved */
  47     };
  48 #endif
  49
  50 #define GMONVERSION     0x00051879
  51
  52 /* Size of the old BSD gmon header */
  53 #define GMON_HDRSIZE_OLDBSD_32 (4 + 4 + 4)
  54
  55 /* FIXME: Checking host compiler defines here means that we can't
  56    use a cross gprof alpha OSF.  */
  57 #if defined(__alpha__) && defined (__osf__)
  58 #define GMON_HDRSIZE_OLDBSD_64 (8 + 8 + 4 + 4)
  59 #else
  60 #define GMON_HDRSIZE_OLDBSD_64 (8 + 8 + 4)
  61 #endif
  62
  63 #if 0 /* For documentation purposes only.  */
  64   struct old_raw_phdr
  65     {
  66       char low_pc[sizeof(void *)]; /* base pc address of sample buffer */
  67       char high_pc[sizeof(void *)];/* max pc address of sampled buffer */
  68       char ncnt[4];                /* size of sample buffer (plus this
  69                                       header) */
  70 #if defined (__alpha__) && defined (__osf__)
  71       /*
  72        * DEC's OSF v3.0 uses 4 bytes of padding to bring the header to
  73        * a size that is a multiple of 8.
  74        */
  75       char pad[4];
  76 #endif
  77     };
  78 #endif
  79
  80 /*
  81  * Histogram counters are unsigned shorts:
  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.  The
  92  * value of HASHFRACTION is based on the minimum number of bytes of
  93  * 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 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 #define HASHFRACTION 1
 113
 114 /*
 115  * Percent of text space to allocate for tostructs with a minimum:
 116  */
 117 #define ARCDENSITY      2
 118 #define MINARCS         50
 119
 120 struct tostruct
 121   {
 122     char *selfpc;
 123     int count;
 124     unsigned short link;
 125   };
 126
 127 /*
 128  * A raw arc, with pointers to the calling site and the called site
 129  * and a count.  Everything is defined in terms of characters so
 130  * as to get a packed representation (otherwise, different compilers
 131  * might introduce different padding):
 132  */
 133 #if 0 /* For documentation purposes only.  */
 134   struct raw_arc
 135     {
 136       char from_pc[sizeof(void *)];
 137       char self_pc[sizeof(void *)];
 138       char count[sizeof(long)];
 139     };
 140 #endif
 141
 142 /*
 143  * General rounding functions:
 144  */
 145 #define ROUNDDOWN(x,y)  (((x)/(y))*(y))
 146 #define ROUNDUP(x,y)    ((((x)+(y)-1)/(y))*(y))
 147
 148 #endif /* gmon_h */