gprof/gmon.h

   1 /*-
   2  * Copyright (c) 1991, 2001 The Regents of the University of California.
   3  * 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      5.2 (Berkeley) 5/6/91
  34  */
  35 #ifndef gmon_h
  36 #define gmon_h
  37
  38 /* Size of the 4.4BSD gmon header */
  39 #define GMON_HDRSIZE_BSD44_32 (4 + 4 + 4 + 4 + 4 + (3 * 4))
  40 #define GMON_HDRSIZE_BSD44_64 (8 + 8 + 4 + 4 + 4 + (3 * 4))
  41
  42 #if 0 /* For documentation purposes only.  */
  43   struct raw_phdr
  44     {
  45       char low_pc[sizeof(void *)]; /* base pc address of sample buffer */
  46       char high_pc[sizeof(void *)];/* max pc address of sampled buffer */
  47       char ncnt[4];                /* size of sample buffer (plus this
  48                                       header) */
  49
  50       char version[4];             /* version number */
  51       char profrate[4];            /* profiling clock rate */
  52       char spare[3*4];             /* reserved */
  53     };
  54 #endif
  55
  56 #define GMONVERSION     0x00051879
  57
  58 /* Size of the old BSD gmon header */
  59 #define GMON_HDRSIZE_OLDBSD_32 (4 + 4 + 4)
  60
  61 /* FIXME: Checking host compiler defines here means that we can't
  62    use a cross gprof alpha OSF.  */
  63 #if defined(__alpha__) && defined (__osf__)
  64 #define GMON_HDRSIZE_OLDBSD_64 (8 + 8 + 4 + 4)
  65 #else
  66 #define GMON_HDRSIZE_OLDBSD_64 (8 + 8 + 4)
  67 #endif
  68
  69 #if 0 /* For documentation purposes only.  */
  70   struct old_raw_phdr
  71     {
  72       char low_pc[sizeof(void *)]; /* base pc address of sample buffer */
  73       char high_pc[sizeof(void *)];/* max pc address of sampled buffer */
  74       char ncnt[4];                /* size of sample buffer (plus this
  75                                       header) */
  76 #if defined (__alpha__) && defined (__osf__)
  77       /*
  78        * DEC's OSF v3.0 uses 4 bytes of padding to bring the header to
  79        * a size that is a multiple of 8.
  80        */
  81       char pad[4];
  82 #endif
  83     };
  84 #endif
  85
  86 /*
  87  * Histogram counters are unsigned shorts:
  88  */
  89 #define HISTCOUNTER unsigned short
  90
  91 /*
  92  * Fraction of text space to allocate for histogram counters here, 1/2:
  93  */
  94 #define HISTFRACTION    2
  95
  96 /*
  97  * Fraction of text space to allocate for from hash buckets.  The
  98  * value of HASHFRACTION is based on the minimum number of bytes of
  99  * separation between two subroutine call points in the object code.
 100  * Given MIN_SUBR_SEPARATION bytes of separation the value of
 101  * HASHFRACTION is calculated as:
 102  *
 103  *      HASHFRACTION = MIN_SUBR_SEPARATION / (2 * sizeof(short) - 1);
 104  *
 105  * For the VAX, the shortest two call sequence is:
 106  *
 107  *      calls   $0,(r0)
 108  *      calls   $0,(r0)
 109  *
 110  * which is separated by only three bytes, thus HASHFRACTION is
 111  * calculated as:
 112  *
 113  *      HASHFRACTION = 3 / (2 * 2 - 1) = 1
 114  *
 115  * Note that the division above rounds down, thus if MIN_SUBR_FRACTION
 116  * is less than three, this algorithm will not work!
 117  */
 118 #define HASHFRACTION 1
 119
 120 /*
 121  * Percent of text space to allocate for tostructs with a minimum:
 122  */
 123 #define ARCDENSITY      2
 124 #define MINARCS         50
 125
 126 struct tostruct
 127   {
 128     char *selfpc;
 129     int count;
 130     unsigned short link;
 131   };
 132
 133 /*
 134  * A raw arc, with pointers to the calling site and the called site
 135  * and a count.  Everything is defined in terms of characters so
 136  * as to get a packed representation (otherwise, different compilers
 137  * might introduce different padding):
 138  */
 139 #if 0 /* For documentation purposes only.  */
 140   struct raw_arc
 141     {
 142       char from_pc[sizeof(void *)];
 143       char self_pc[sizeof(void *)];
 144       char count[sizeof(long)];
 145     };
 146 #endif
 147
 148 /*
 149  * General rounding functions:
 150  */
 151 #define ROUNDDOWN(x,y)  (((x)/(y))*(y))
 152 #define ROUNDUP(x,y)    ((((x)+(y)-1)/(y))*(y))
 153
 154 #endif /* gmon_h */