gprof/gprof.h

   1 /*
   2  * Copyright (c) 1983 Regents of the University of California.
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms are permitted
   6  * provided that: (1) source distributions retain this entire copyright
   7  * notice and comment, and (2) distributions including binaries display
   8  * the following acknowledgement:  ``This product includes software
   9  * developed by the University of California, Berkeley and its contributors''
  10  * in the documentation or other materials provided with the distribution
  11  * and in all advertising materials mentioning features or use of this
  12  * software. Neither the name of the University nor the names of its
  13  * contributors may be used to endorse or promote products derived
  14  * from this software without specific prior written permission.
  15  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  16  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  17  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  18  *
  19  *      @(#)gprof.h     5.9 (Berkeley) 6/1/90
  20  */
  21
  22 #include <sys/types.h>
  23 #include <sys/stat.h>
  24 #include <a.out.h>
  25 #include <stdio.h>
  26 #include "gmon.h"
  27
  28 #ifdef  MACHINE_H
  29 #       include MACHINE_H
  30 #else
  31 #       if vax
  32 #          include "vax.h"
  33 #       endif
  34 #       if sun
  35 #               include "sun.h"
  36 #       endif
  37 #       if tahoe
  38 #               include "tahoe.h"
  39 #       endif
  40 #endif
  41
  42
  43     /*
  44      *  who am i, for error messages.
  45      */
  46 char    *whoami;
  47
  48     /*
  49      * booleans
  50      */
  51 typedef int     bool;
  52 #define FALSE   0
  53 #define TRUE    1
  54
  55     /*
  56      *  ticks per second
  57      */
  58 long    hz;
  59
  60 typedef u_short UNIT;           /* unit of profiling */
  61 char    *a_outname;
  62 #define A_OUTNAME               "a.out"
  63
  64 char    *gmonname;
  65 #define GMONNAME                "gmon.out"
  66 #define GMONSUM                 "gmon.sum"
  67
  68     /*
  69      *  a constructed arc,
  70      *      with pointers to the namelist entry of the parent and the child,
  71      *      a count of how many times this arc was traversed,
  72      *      and pointers to the next parent of this child and
  73      *          the next child of this parent.
  74      */
  75 struct arcstruct {
  76     struct nl           *arc_parentp;   /* pointer to parent's nl entry */
  77     struct nl           *arc_childp;    /* pointer to child's nl entry */
  78     long                arc_count;      /* how calls from parent to child */
  79     double              arc_time;       /* time inherited along arc */
  80     double              arc_childtime;  /* childtime inherited along arc */
  81     struct arcstruct    *arc_parentlist; /* parents-of-this-child list */
  82     struct arcstruct    *arc_childlist; /* children-of-this-parent list */
  83 };
  84 typedef struct arcstruct        arctype;
  85
  86     /*
  87      * The symbol table;
  88      * for each external in the specified file we gather
  89      * its address, the number of calls and compute its share of cpu time.
  90      */
  91 struct nl {
  92     char                *name;          /* the name */
  93     unsigned long       value;          /* the pc entry point */
  94     unsigned long       svalue;         /* entry point aligned to histograms */
  95     double              time;           /* ticks in this routine */
  96     double              childtime;      /* cumulative ticks in children */
  97     long                ncall;          /* how many times called */
  98     long                selfcalls;      /* how many calls to self */
  99     double              propfraction;   /* what % of time propagates */
 100     double              propself;       /* how much self time propagates */
 101     double              propchild;      /* how much child time propagates */
 102     bool                printflag;      /* should this be printed? */
 103     int                 index;          /* index in the graph list */
 104     int                 toporder;       /* graph call chain top-sort order */
 105     int                 cycleno;        /* internal number of cycle on */
 106     struct nl           *cyclehead;     /* pointer to head of cycle */
 107     struct nl           *cnext;         /* pointer to next member of cycle */
 108     arctype             *parents;       /* list of caller arcs */
 109     arctype             *children;      /* list of callee arcs */
 110 };
 111 typedef struct nl       nltype;
 112
 113 nltype  *nl;                    /* the whole namelist */
 114 nltype  *npe;                   /* the virtual end of the namelist */
 115 int     nname;                  /* the number of function names */
 116
 117     /*
 118      *  flag which marks a nl entry as topologically ``busy''
 119      *  flag which marks a nl entry as topologically ``not_numbered''
 120      */
 121 #define DFN_BUSY        -1
 122 #define DFN_NAN         0
 123
 124     /*
 125      *  namelist entries for cycle headers.
 126      *  the number of discovered cycles.
 127      */
 128 nltype  *cyclenl;               /* cycle header namelist */
 129 int     ncycle;                 /* number of cycles discovered */
 130
 131     /*
 132      * The header on the gmon.out file.
 133      * gmon.out consists of one of these headers,
 134      * and then an array of ncnt samples
 135      * representing the discretized program counter values.
 136      *  this should be a struct phdr, but since everything is done
 137      *  as UNITs, this is in UNITs too.
 138      */
 139 struct hdr {
 140     UNIT        *lowpc;
 141     UNIT        *highpc;
 142     int ncnt;
 143 };
 144
 145 struct hdr      h;
 146
 147 int     debug;
 148
 149     /*
 150      * Each discretized pc sample has
 151      * a count of the number of samples in its range
 152      */
 153 UNIT    *samples;
 154
 155 unsigned long   s_lowpc;        /* lowpc from the profile file */
 156 unsigned long   s_highpc;       /* highpc from the profile file */
 157 unsigned lowpc, highpc;         /* range profiled, in UNIT's */
 158 unsigned sampbytes;             /* number of bytes of samples */
 159 int     nsamples;               /* number of samples */
 160 double  actime;                 /* accumulated time thus far for putprofline */
 161 double  totime;                 /* total time for all routines */
 162 double  printtime;              /* total of time being printed */
 163 double  scale;                  /* scale factor converting samples to pc
 164                                    values: each sample covers scale bytes */
 165 char    *strtab;                /* string table in core */
 166 off_t   ssiz;                   /* size of the string table */
 167 struct  exec xbuf;              /* exec header of a.out */
 168 unsigned char   *textspace;             /* text space of a.out in core */
 169
 170     /*
 171      *  option flags, from a to z.
 172      */
 173 bool    aflag;                          /* suppress static functions */
 174 bool    bflag;                          /* blurbs, too */
 175 bool    cflag;                          /* discovered call graph, too */
 176 bool    dflag;                          /* debugging options */
 177 bool    eflag;                          /* specific functions excluded */
 178 bool    Eflag;                          /* functions excluded with time */
 179 bool    fflag;                          /* specific functions requested */
 180 bool    Fflag;                          /* functions requested with time */
 181 bool    kflag;                          /* arcs to be deleted */
 182 bool    sflag;                          /* sum multiple gmon.out files */
 183 bool    zflag;                          /* zero time/called functions, too */
 184
 185     /*
 186      *  structure for various string lists
 187      */
 188 struct stringlist {
 189     struct stringlist   *next;
 190     char                *string;
 191 };
 192 struct stringlist       *elist;
 193 struct stringlist       *Elist;
 194 struct stringlist       *flist;
 195 struct stringlist       *Flist;
 196 struct stringlist       *kfromlist;
 197 struct stringlist       *ktolist;
 198
 199     /*
 200      *  function declarations
 201      */
 202 /*
 203                 addarc();
 204 */
 205 int             arccmp();
 206 arctype         *arclookup();
 207 /*
 208                 asgnsamples();
 209                 printblurb();
 210                 cyclelink();
 211                 dfn();
 212 */
 213 bool            dfn_busy();
 214 /*
 215                 dfn_findcycle();
 216 */
 217 bool            dfn_numbered();
 218 /*
 219                 dfn_post_visit();
 220                 dfn_pre_visit();
 221                 dfn_self_cycle();
 222 */
 223 nltype          **doarcs();
 224 /*
 225                 done();
 226                 findcalls();
 227                 flatprofheader();
 228                 flatprofline();
 229 */
 230 bool            funcsymbol();
 231 /*
 232                 getnfile();
 233                 getpfile();
 234                 getstrtab();
 235                 getsymtab();
 236                 gettextspace();
 237                 gprofheader();
 238                 gprofline();
 239                 main();
 240 */
 241 unsigned long   max();
 242 int             membercmp();
 243 unsigned long   min();
 244 nltype          *nllookup();
 245 FILE            *openpfile();
 246 /*
 247                 printchildren();
 248                 printcycle();
 249                 printgprof();
 250                 printmembers();
 251                 printname();
 252                 printparents();
 253                 printprof();
 254                 readsamples();
 255 */
 256 unsigned long   reladdr();
 257 /*
 258                 sortchildren();
 259                 sortmembers();
 260                 sortparents();
 261                 tally();
 262                 timecmp();
 263                 topcmp();
 264 */
 265 int             totalcmp();
 266 /*
 267                 valcmp();
 268 */
 269
 270 #define LESSTHAN        -1
 271 #define EQUALTO         0
 272 #define GREATERTHAN     1
 273
 274 #define DFNDEBUG        1
 275 #define CYCLEDEBUG      2
 276 #define ARCDEBUG        4
 277 #define TALLYDEBUG      8
 278 #define TIMEDEBUG       16
 279 #define SAMPLEDEBUG     32
 280 #define AOUTDEBUG       64
 281 #define CALLDEBUG       128
 282 #define LOOKUPDEBUG     256
 283 #define PROPDEBUG       512
 284 #define ANYDEBUG        1024