gprof.h revision 129243
11590Srgrimes/* 21590Srgrimes * Copyright (c) 1983, 1993 31590Srgrimes * The Regents of the University of California. All rights reserved. 41590Srgrimes * 51590Srgrimes * Redistribution and use in source and binary forms, with or without 61590Srgrimes * modification, are permitted provided that the following conditions 71590Srgrimes * are met: 81590Srgrimes * 1. Redistributions of source code must retain the above copyright 91590Srgrimes * notice, this list of conditions and the following disclaimer. 101590Srgrimes * 2. Redistributions in binary form must reproduce the above copyright 111590Srgrimes * notice, this list of conditions and the following disclaimer in the 121590Srgrimes * documentation and/or other materials provided with the distribution. 131590Srgrimes * 3. All advertising materials mentioning features or use of this software 141590Srgrimes * must display the following acknowledgement: 151590Srgrimes * This product includes software developed by the University of 161590Srgrimes * California, Berkeley and its contributors. 171590Srgrimes * 4. Neither the name of the University nor the names of its contributors 181590Srgrimes * may be used to endorse or promote products derived from this software 191590Srgrimes * without specific prior written permission. 201590Srgrimes * 211590Srgrimes * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 221590Srgrimes * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 231590Srgrimes * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 241590Srgrimes * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 251590Srgrimes * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 261590Srgrimes * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 271590Srgrimes * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 281590Srgrimes * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 291590Srgrimes * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 301590Srgrimes * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 311590Srgrimes * SUCH DAMAGE. 321590Srgrimes * 331590Srgrimes * @(#)gprof.h 8.1 (Berkeley) 6/6/93 3485353Speter * $FreeBSD: head/usr.bin/gprof/gprof.h 129243 2004-05-14 21:05:35Z bde $ 351590Srgrimes */ 361590Srgrimes 371590Srgrimes#include <sys/types.h> 381590Srgrimes#include <sys/stat.h> 391590Srgrimes#include <sys/gmon.h> 401590Srgrimes 411590Srgrimes#include <stdio.h> 421590Srgrimes#include <stdlib.h> 431590Srgrimes 4448839Ssimokawa#if __alpha__ 4548839Ssimokawa# include "alpha.h" 4648839Ssimokawa#endif 47129243Sbde#if __arm__ 48129243Sbde# include "arm.h" 4991976Sjake#endif 50129243Sbde#if __i386__ 51129243Sbde# include "i386.h" 52129243Sbde#endif 53129243Sbde#if __ia64__ 54129243Sbde# include "ia64.h" 55129243Sbde#endif 56107718Sgrehan#if __powerpc__ 57107718Sgrehan# include "powerpc.h" 58107718Sgrehan#endif 59129243Sbde#if __sparc64__ 60129243Sbde# include "sparc64.h" 611590Srgrimes#endif 621590Srgrimes 631590Srgrimes /* 641590Srgrimes * booleans 651590Srgrimes */ 661590Srgrimestypedef int bool; 671590Srgrimes#define FALSE 0 681590Srgrimes#define TRUE 1 691590Srgrimes 701590Srgrimes /* 7191735Sbde * Historical scale factor in profil(2)'s algorithm for converting 7291735Sbde * pc addresses to bucket numbers. This now just complicates the 7391735Sbde * scaling and makes bucket:pc densities of more than 1/2 useless. 7491735Sbde */ 7591735Sbde#define HISTORICAL_SCALE_2 2 7691735Sbde 7791735Sbde /* 781590Srgrimes * ticks per second 791590Srgrimes */ 801590Srgrimeslong hz; 811590Srgrimes 8291738Sbdesize_t histcounter_size; 8391738Sbdeint histcounter_type; 8491010Sbde 851590Srgrimeschar *a_outname; 861590Srgrimes#define A_OUTNAME "a.out" 871590Srgrimes 881590Srgrimeschar *gmonname; 891590Srgrimes#define GMONSUM "gmon.sum" 901590Srgrimes 911590Srgrimes /* 921590Srgrimes * a constructed arc, 931590Srgrimes * with pointers to the namelist entry of the parent and the child, 941590Srgrimes * a count of how many times this arc was traversed, 951590Srgrimes * and pointers to the next parent of this child and 961590Srgrimes * the next child of this parent. 971590Srgrimes */ 981590Srgrimesstruct arcstruct { 991590Srgrimes struct nl *arc_parentp; /* pointer to parent's nl entry */ 1001590Srgrimes struct nl *arc_childp; /* pointer to child's nl entry */ 1011590Srgrimes long arc_count; /* num calls from parent to child */ 1021590Srgrimes double arc_time; /* time inherited along arc */ 1031590Srgrimes double arc_childtime; /* childtime inherited along arc */ 1041590Srgrimes struct arcstruct *arc_parentlist; /* parents-of-this-child list */ 1051590Srgrimes struct arcstruct *arc_childlist; /* children-of-this-parent list */ 1061590Srgrimes struct arcstruct *arc_next; /* list of arcs on cycle */ 1071590Srgrimes unsigned short arc_cyclecnt; /* num cycles involved in */ 1081590Srgrimes unsigned short arc_flags; /* see below */ 1091590Srgrimes}; 1101590Srgrimestypedef struct arcstruct arctype; 1111590Srgrimes 1121590Srgrimes /* 1131590Srgrimes * arc flags 1141590Srgrimes */ 1151590Srgrimes#define DEADARC 0x01 /* time should not propagate across the arc */ 1161590Srgrimes#define ONLIST 0x02 /* arc is on list of arcs in cycles */ 1171590Srgrimes 1181590Srgrimes /* 1191590Srgrimes * The symbol table; 1201590Srgrimes * for each external in the specified file we gather 121105243Scharnier * its address, the number of calls and compute its share of CPU time. 1221590Srgrimes */ 1231590Srgrimesstruct nl { 12438928Sjdp const char *name; /* the name */ 1251590Srgrimes unsigned long value; /* the pc entry point */ 1261590Srgrimes unsigned long svalue; /* entry point aligned to histograms */ 1271590Srgrimes double time; /* ticks in this routine */ 1281590Srgrimes double childtime; /* cumulative ticks in children */ 1291590Srgrimes long ncall; /* how many times called */ 1301590Srgrimes long npropcall; /* times called by live arcs */ 1311590Srgrimes long selfcalls; /* how many calls to self */ 1321590Srgrimes double propfraction; /* what % of time propagates */ 1331590Srgrimes double propself; /* how much self time propagates */ 1341590Srgrimes double propchild; /* how much child time propagates */ 1351590Srgrimes short printflag; /* should this be printed? */ 1361590Srgrimes short flags; /* see below */ 1371590Srgrimes int index; /* index in the graph list */ 1381590Srgrimes int toporder; /* graph call chain top-sort order */ 1391590Srgrimes int cycleno; /* internal number of cycle on */ 1401590Srgrimes int parentcnt; /* number of live parent arcs */ 1411590Srgrimes struct nl *cyclehead; /* pointer to head of cycle */ 1421590Srgrimes struct nl *cnext; /* pointer to next member of cycle */ 1431590Srgrimes arctype *parents; /* list of caller arcs */ 1441590Srgrimes arctype *children; /* list of callee arcs */ 1451590Srgrimes}; 1461590Srgrimestypedef struct nl nltype; 1471590Srgrimes 1481590Srgrimesnltype *nl; /* the whole namelist */ 1491590Srgrimesnltype *npe; /* the virtual end of the namelist */ 1501590Srgrimesint nname; /* the number of function names */ 1511590Srgrimes 1521590Srgrimes#define HASCYCLEXIT 0x08 /* node has arc exiting from cycle */ 1531590Srgrimes#define CYCLEHEAD 0x10 /* node marked as head of a cycle */ 1541590Srgrimes#define VISITED 0x20 /* node visited during a cycle */ 1551590Srgrimes 1561590Srgrimes /* 1571590Srgrimes * The cycle list. 1581590Srgrimes * for each subcycle within an identified cycle, we gather 1591590Srgrimes * its size and the list of included arcs. 1601590Srgrimes */ 1611590Srgrimesstruct cl { 1621590Srgrimes int size; /* length of cycle */ 1631590Srgrimes struct cl *next; /* next member of list */ 1641590Srgrimes arctype *list[1]; /* list of arcs in cycle */ 1651590Srgrimes /* actually longer */ 1661590Srgrimes}; 1671590Srgrimestypedef struct cl cltype; 1681590Srgrimes 1691590Srgrimesarctype *archead; /* the head of arcs in current cycle list */ 1701590Srgrimescltype *cyclehead; /* the head of the list */ 1711590Srgrimesint cyclecnt; /* the number of cycles found */ 1721590Srgrimes#define CYCLEMAX 100 /* maximum cycles before cutting one of them */ 1731590Srgrimes 1741590Srgrimes /* 1751590Srgrimes * flag which marks a nl entry as topologically ``busy'' 1761590Srgrimes * flag which marks a nl entry as topologically ``not_numbered'' 1771590Srgrimes */ 1781590Srgrimes#define DFN_BUSY -1 1791590Srgrimes#define DFN_NAN 0 1801590Srgrimes 1818874Srgrimes /* 1821590Srgrimes * namelist entries for cycle headers. 1831590Srgrimes * the number of discovered cycles. 1841590Srgrimes */ 1851590Srgrimesnltype *cyclenl; /* cycle header namelist */ 1861590Srgrimesint ncycle; /* number of cycles discovered */ 1871590Srgrimes 1881590Srgrimes /* 1891590Srgrimes * The header on the gmon.out file. 1901590Srgrimes * gmon.out consists of a struct phdr (defined in gmon.h) 1911590Srgrimes * and then an array of ncnt samples representing the 1921590Srgrimes * discretized program counter values. 1931590Srgrimes * 1941590Srgrimes * Backward compatible old style header 1951590Srgrimes */ 1961590Srgrimesstruct ophdr { 19791738Sbde u_short *lpc; 19891738Sbde u_short *hpc; 1991590Srgrimes int ncnt; 2001590Srgrimes}; 2011590Srgrimes 2021590Srgrimesint debug; 2031590Srgrimes 2041590Srgrimes /* 2051590Srgrimes * Each discretized pc sample has 2061590Srgrimes * a count of the number of samples in its range 2071590Srgrimes */ 20891738Sbdedouble *samples; 2091590Srgrimes 2101590Srgrimesunsigned long s_lowpc; /* lowpc from the profile file */ 2111590Srgrimesunsigned long s_highpc; /* highpc from the profile file */ 21291738Sbdeunsigned long lowpc, highpc; /* range profiled, in historical units */ 2131590Srgrimesunsigned sampbytes; /* number of bytes of samples */ 2141590Srgrimesint nsamples; /* number of samples */ 2151590Srgrimesdouble actime; /* accumulated time thus far for putprofline */ 2161590Srgrimesdouble totime; /* total time for all routines */ 2171590Srgrimesdouble printtime; /* total of time being printed */ 2181590Srgrimesdouble scale; /* scale factor converting samples to pc 2191590Srgrimes values: each sample covers scale bytes */ 2201590Srgrimesunsigned char *textspace; /* text space of a.out in core */ 2211590Srgrimesint cyclethreshold; /* with -C, minimum cycle size to ignore */ 2221590Srgrimes 2231590Srgrimes /* 2241590Srgrimes * option flags, from a to z. 2251590Srgrimes */ 2261590Srgrimesbool aflag; /* suppress static functions */ 2271590Srgrimesbool bflag; /* blurbs, too */ 2281590Srgrimesbool cflag; /* discovered call graph, too */ 2291590Srgrimesbool Cflag; /* find cut-set to eliminate cycles */ 2301590Srgrimesbool dflag; /* debugging options */ 2311590Srgrimesbool eflag; /* specific functions excluded */ 2321590Srgrimesbool Eflag; /* functions excluded with time */ 2331590Srgrimesbool fflag; /* specific functions requested */ 2341590Srgrimesbool Fflag; /* functions requested with time */ 2351590Srgrimesbool kflag; /* arcs to be deleted */ 23685739Sgreenbool Kflag; /* use the running kernel for symbols */ 2371590Srgrimesbool sflag; /* sum multiple gmon.out files */ 23838928Sjdpbool uflag; /* suppress symbols hidden from C */ 2391590Srgrimesbool zflag; /* zero time/called functions, too */ 2401590Srgrimes 2411590Srgrimes /* 2421590Srgrimes * structure for various string lists 2431590Srgrimes */ 2441590Srgrimesstruct stringlist { 2451590Srgrimes struct stringlist *next; 2461590Srgrimes char *string; 2471590Srgrimes}; 2481590Srgrimesstruct stringlist *elist; 2491590Srgrimesstruct stringlist *Elist; 2501590Srgrimesstruct stringlist *flist; 2511590Srgrimesstruct stringlist *Flist; 2521590Srgrimesstruct stringlist *kfromlist; 2531590Srgrimesstruct stringlist *ktolist; 2541590Srgrimes 2551590Srgrimes /* 2561590Srgrimes * function declarations 2571590Srgrimes */ 258105243Scharniervoid addarc(nltype *, nltype *, long); 259105243Scharnierbool addcycle(arctype **, arctype **); 260105243Scharniervoid addlist(struct stringlist *, char *); 261105243Scharniervoid alignentries(void); 26238928Sjdpint aout_getnfile(const char *, char ***); 2631590Srgrimesint arccmp(); 2641590Srgrimesarctype *arclookup(); 265105243Scharniervoid asgnsamples(void); 266105243Scharniervoid compresslist(void); 267105243Scharnierbool cycleanalyze(void); 268105243Scharniervoid cyclelink(void); 269105243Scharniervoid cycletime(void); 270105243Scharnierbool descend(nltype *, arctype **, arctype **); 271105243Scharniervoid dfn(nltype *); 2721590Srgrimesbool dfn_busy(); 273105243Scharniervoid dfn_findcycle(nltype *); 274105243Scharniervoid dfn_init(void); 2751590Srgrimesbool dfn_numbered(); 276105243Scharniervoid dfn_post_visit(nltype *); 277105243Scharniervoid dfn_pre_visit(nltype *); 278105243Scharniervoid dfn_self_cycle(nltype *); 2791590Srgrimesnltype **doarcs(); 280105243Scharniervoid doflags(void); 281105243Scharniervoid dotime(void); 282105243Scharniervoid dumpsum(char *); 28338928Sjdpint elf_getnfile(const char *, char ***); 28438928Sjdp/* 2851590Srgrimes findcalls(); 2861590Srgrimes*/ 287105243Scharniervoid flatprofheader(void); 288105243Scharniervoid flatprofline(nltype *); 289105243Scharniervoid getpfile(char *); 2901590Srgrimes/* 2911590Srgrimes gprofheader(); 2921590Srgrimes gprofline(); 29385739Sgreen*/ 294105243Scharniervoid inheritflags(nltype *); 29585739Sgreenint kernel_getnfile(const char *, char ***); 29685739Sgreen/* 2971590Srgrimes main(); 2981590Srgrimes*/ 2991590Srgrimesunsigned long max(); 3001590Srgrimesint membercmp(); 3011590Srgrimesunsigned long min(); 3021590Srgrimesnltype *nllookup(); 303105243Scharnierbool onlist(struct stringlist *, const char *); 3041590SrgrimesFILE *openpfile(); 3051590Srgrimeslong operandlength(); 3061590Srgrimesoperandenum operandmode(); 3071590Srgrimeschar *operandname(); 308105243Scharniervoid printblurb(char *); 309105243Scharniervoid printchildren(nltype *); 310105243Scharniervoid printcycle(nltype *); 311105243Scharniervoid printgprof(nltype **); 312105243Scharniervoid printindex(void); 313105243Scharniervoid printmembers(nltype *); 314105243Scharniervoid printname(nltype *); 315105243Scharniervoid printparents(nltype *); 316105243Scharniervoid printprof(void); 317105243Scharniervoid printsubcycle(cltype *); 318105243Scharniervoid readsamples(FILE *); 3191590Srgrimesunsigned long reladdr(); 320105243Scharniervoid sortchildren(nltype *); 321105243Scharniervoid sortmembers(nltype *); 322105243Scharniervoid sortparents(nltype *); 323105243Scharniervoid tally(struct rawarc *); 324105243Scharniervoid timepropagate(nltype *); 3251590Srgrimesint totalcmp(); 3261590Srgrimes 3271590Srgrimes#define LESSTHAN -1 3281590Srgrimes#define EQUALTO 0 3291590Srgrimes#define GREATERTHAN 1 3301590Srgrimes 3311590Srgrimes#define DFNDEBUG 1 3321590Srgrimes#define CYCLEDEBUG 2 3331590Srgrimes#define ARCDEBUG 4 3341590Srgrimes#define TALLYDEBUG 8 3351590Srgrimes#define TIMEDEBUG 16 3361590Srgrimes#define SAMPLEDEBUG 32 3371590Srgrimes#define AOUTDEBUG 64 3381590Srgrimes#define CALLDEBUG 128 3391590Srgrimes#define LOOKUPDEBUG 256 3401590Srgrimes#define PROPDEBUG 512 3411590Srgrimes#define BREAKCYCLE 1024 3421590Srgrimes#define SUBCYCLELIST 2048 3431590Srgrimes#define ANYDEBUG 4096 344