1 /* 2 * Copyright (c) 1983, 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 * @(#)gprof.h 8.1 (Berkeley) 6/6/93 34 * $FreeBSD$ 35 */ 36 37 #include <sys/types.h> 38 #include <sys/stat.h> 39 #include <sys/gmon.h> 40 41 #include <stdio.h> 42 #include <stdlib.h> 43 44 #if __ia64__ 45 # include "ia64.h" 46 #endif 47 #if __alpha__ 48 # include "alpha.h" 49 #endif 50 #if __sparc64__ 51 # include "sparc64.h" 52 #endif 53 #if __powerpc__ 54 # include "powerpc.h" 55 #endif 56 #if vax 57 # include "vax.h" 58 #endif 59 #if sparc 60 # include "sparc.h" 61 #endif 62 #if tahoe 63 # include "tahoe.h" 64 #endif 65 #if hp300 66 # include "hp300.h" 67 #endif 68 #if luna68k 69 # include "luna68k.h" 70 #endif 71 #if __i386__ 72 # include "i386.h" 73 #endif 74 #if mips 75 # include "mips.h" 76 #endif 77 78 79 /* 80 * booleans 81 */ 82 typedef int bool; 83 #define FALSE 0 84 #define TRUE 1 85 86 /* 87 * Historical scale factor in profil(2)'s algorithm for converting 88 * pc addresses to bucket numbers. This now just complicates the 89 * scaling and makes bucket:pc densities of more than 1/2 useless. 90 */ 91 #define HISTORICAL_SCALE_2 2 92 93 /* 94 * ticks per second 95 */ 96 long hz; 97 98 size_t histcounter_size; 99 int histcounter_type; 100 101 char *a_outname; 102 #define A_OUTNAME "a.out" 103 104 char *gmonname; 105 #define GMONSUM "gmon.sum" 106 107 /* 108 * a constructed arc, 109 * with pointers to the namelist entry of the parent and the child, 110 * a count of how many times this arc was traversed, 111 * and pointers to the next parent of this child and 112 * the next child of this parent. 113 */ 114 struct arcstruct { 115 struct nl *arc_parentp; /* pointer to parent's nl entry */ 116 struct nl *arc_childp; /* pointer to child's nl entry */ 117 long arc_count; /* num calls from parent to child */ 118 double arc_time; /* time inherited along arc */ 119 double arc_childtime; /* childtime inherited along arc */ 120 struct arcstruct *arc_parentlist; /* parents-of-this-child list */ 121 struct arcstruct *arc_childlist; /* children-of-this-parent list */ 122 struct arcstruct *arc_next; /* list of arcs on cycle */ 123 unsigned short arc_cyclecnt; /* num cycles involved in */ 124 unsigned short arc_flags; /* see below */ 125 }; 126 typedef struct arcstruct arctype; 127 128 /* 129 * arc flags 130 */ 131 #define DEADARC 0x01 /* time should not propagate across the arc */ 132 #define ONLIST 0x02 /* arc is on list of arcs in cycles */ 133 134 /* 135 * The symbol table; 136 * for each external in the specified file we gather 137 * its address, the number of calls and compute its share of CPU time. 138 */ 139 struct nl { 140 const char *name; /* the name */ 141 unsigned long value; /* the pc entry point */ 142 unsigned long svalue; /* entry point aligned to histograms */ 143 double time; /* ticks in this routine */ 144 double childtime; /* cumulative ticks in children */ 145 long ncall; /* how many times called */ 146 long npropcall; /* times called by live arcs */ 147 long selfcalls; /* how many calls to self */ 148 double propfraction; /* what % of time propagates */ 149 double propself; /* how much self time propagates */ 150 double propchild; /* how much child time propagates */ 151 short printflag; /* should this be printed? */ 152 short flags; /* see below */ 153 int index; /* index in the graph list */ 154 int toporder; /* graph call chain top-sort order */ 155 int cycleno; /* internal number of cycle on */ 156 int parentcnt; /* number of live parent arcs */ 157 struct nl *cyclehead; /* pointer to head of cycle */ 158 struct nl *cnext; /* pointer to next member of cycle */ 159 arctype *parents; /* list of caller arcs */ 160 arctype *children; /* list of callee arcs */ 161 }; 162 typedef struct nl nltype; 163 164 nltype *nl; /* the whole namelist */ 165 nltype *npe; /* the virtual end of the namelist */ 166 int nname; /* the number of function names */ 167 168 #define HASCYCLEXIT 0x08 /* node has arc exiting from cycle */ 169 #define CYCLEHEAD 0x10 /* node marked as head of a cycle */ 170 #define VISITED 0x20 /* node visited during a cycle */ 171 172 /* 173 * The cycle list. 174 * for each subcycle within an identified cycle, we gather 175 * its size and the list of included arcs. 176 */ 177 struct cl { 178 int size; /* length of cycle */ 179 struct cl *next; /* next member of list */ 180 arctype *list[1]; /* list of arcs in cycle */ 181 /* actually longer */ 182 }; 183 typedef struct cl cltype; 184 185 arctype *archead; /* the head of arcs in current cycle list */ 186 cltype *cyclehead; /* the head of the list */ 187 int cyclecnt; /* the number of cycles found */ 188 #define CYCLEMAX 100 /* maximum cycles before cutting one of them */ 189 190 /* 191 * flag which marks a nl entry as topologically ``busy'' 192 * flag which marks a nl entry as topologically ``not_numbered'' 193 */ 194 #define DFN_BUSY -1 195 #define DFN_NAN 0 196 197 /* 198 * namelist entries for cycle headers. 199 * the number of discovered cycles. 200 */ 201 nltype *cyclenl; /* cycle header namelist */ 202 int ncycle; /* number of cycles discovered */ 203 204 /* 205 * The header on the gmon.out file. 206 * gmon.out consists of a struct phdr (defined in gmon.h) 207 * and then an array of ncnt samples representing the 208 * discretized program counter values. 209 * 210 * Backward compatible old style header 211 */ 212 struct ophdr { 213 u_short *lpc; 214 u_short *hpc; 215 int ncnt; 216 }; 217 218 int debug; 219 220 /* 221 * Each discretized pc sample has 222 * a count of the number of samples in its range 223 */ 224 double *samples; 225 226 unsigned long s_lowpc; /* lowpc from the profile file */ 227 unsigned long s_highpc; /* highpc from the profile file */ 228 unsigned long lowpc, highpc; /* range profiled, in historical units */ 229 unsigned sampbytes; /* number of bytes of samples */ 230 int nsamples; /* number of samples */ 231 double actime; /* accumulated time thus far for putprofline */ 232 double totime; /* total time for all routines */ 233 double printtime; /* total of time being printed */ 234 double scale; /* scale factor converting samples to pc 235 values: each sample covers scale bytes */ 236 unsigned char *textspace; /* text space of a.out in core */ 237 int cyclethreshold; /* with -C, minimum cycle size to ignore */ 238 239 /* 240 * option flags, from a to z. 241 */ 242 bool aflag; /* suppress static functions */ 243 bool bflag; /* blurbs, too */ 244 bool cflag; /* discovered call graph, too */ 245 bool Cflag; /* find cut-set to eliminate cycles */ 246 bool dflag; /* debugging options */ 247 bool eflag; /* specific functions excluded */ 248 bool Eflag; /* functions excluded with time */ 249 bool fflag; /* specific functions requested */ 250 bool Fflag; /* functions requested with time */ 251 bool kflag; /* arcs to be deleted */ 252 bool Kflag; /* use the running kernel for symbols */ 253 bool sflag; /* sum multiple gmon.out files */ 254 bool uflag; /* suppress symbols hidden from C */ 255 bool zflag; /* zero time/called functions, too */ 256 257 /* 258 * structure for various string lists 259 */ 260 struct stringlist { 261 struct stringlist *next; 262 char *string; 263 }; 264 struct stringlist *elist; 265 struct stringlist *Elist; 266 struct stringlist *flist; 267 struct stringlist *Flist; 268 struct stringlist *kfromlist; 269 struct stringlist *ktolist; 270 271 /* 272 * function declarations 273 */ 274 void addarc(nltype *, nltype *, long); 275 bool addcycle(arctype **, arctype **); 276 void addlist(struct stringlist *, char *); 277 void alignentries(void); 278 int aout_getnfile(const char *, char ***); 279 int arccmp(); 280 arctype *arclookup(); 281 void asgnsamples(void); 282 void compresslist(void); 283 bool cycleanalyze(void); 284 void cyclelink(void); 285 void cycletime(void); 286 bool descend(nltype *, arctype **, arctype **); 287 void dfn(nltype *); 288 bool dfn_busy(); 289 void dfn_findcycle(nltype *); 290 void dfn_init(void); 291 bool dfn_numbered(); 292 void dfn_post_visit(nltype *); 293 void dfn_pre_visit(nltype *); 294 void dfn_self_cycle(nltype *); 295 nltype **doarcs(); 296 void doflags(void); 297 void dotime(void); 298 void dumpsum(char *); 299 int elf_getnfile(const char *, char ***); 300 /* 301 findcalls(); 302 */ 303 void flatprofheader(void); 304 void flatprofline(nltype *); 305 void getpfile(char *); 306 /* 307 gprofheader(); 308 gprofline(); 309 */ 310 void inheritflags(nltype *); 311 int kernel_getnfile(const char *, char ***); 312 /* 313 main(); 314 */ 315 unsigned long max(); 316 int membercmp(); 317 unsigned long min(); 318 nltype *nllookup(); 319 bool onlist(struct stringlist *, const char *); 320 FILE *openpfile(); 321 long operandlength(); 322 operandenum operandmode(); 323 char *operandname(); 324 void printblurb(char *); 325 void printchildren(nltype *); 326 void printcycle(nltype *); 327 void printgprof(nltype **); 328 void printindex(void); 329 void printmembers(nltype *); 330 void printname(nltype *); 331 void printparents(nltype *); 332 void printprof(void); 333 void printsubcycle(cltype *); 334 void readsamples(FILE *); 335 unsigned long reladdr(); 336 void sortchildren(nltype *); 337 void sortmembers(nltype *); 338 void sortparents(nltype *); 339 void tally(struct rawarc *); 340 void timepropagate(nltype *); 341 int totalcmp(); 342 343 #define LESSTHAN -1 344 #define EQUALTO 0 345 #define GREATERTHAN 1 346 347 #define DFNDEBUG 1 348 #define CYCLEDEBUG 2 349 #define ARCDEBUG 4 350 #define TALLYDEBUG 8 351 #define TIMEDEBUG 16 352 #define SAMPLEDEBUG 32 353 #define AOUTDEBUG 64 354 #define CALLDEBUG 128 355 #define LOOKUPDEBUG 256 356 #define PROPDEBUG 512 357 #define BREAKCYCLE 1024 358 #define SUBCYCLELIST 2048 359 #define ANYDEBUG 4096 360