gprof.h revision 91735
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 91735 2002-03-06 09:47:36Z 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 4485353Speter#if __ia64__ 4585353Speter# include "ia64.h" 4685353Speter#endif 4748839Ssimokawa#if __alpha__ 4848839Ssimokawa# include "alpha.h" 4948839Ssimokawa#endif 501590Srgrimes#if vax 511590Srgrimes# include "vax.h" 521590Srgrimes#endif 531590Srgrimes#if sparc 541590Srgrimes# include "sparc.h" 551590Srgrimes#endif 561590Srgrimes#if tahoe 571590Srgrimes# include "tahoe.h" 581590Srgrimes#endif 591590Srgrimes#if hp300 601590Srgrimes# include "hp300.h" 611590Srgrimes#endif 621590Srgrimes#if luna68k 631590Srgrimes# include "luna68k.h" 641590Srgrimes#endif 651590Srgrimes#if i386 661590Srgrimes# include "i386.h" 671590Srgrimes#endif 681590Srgrimes#if mips 691590Srgrimes# include "mips.h" 701590Srgrimes#endif 711590Srgrimes 721590Srgrimes 731590Srgrimes /* 741590Srgrimes * booleans 751590Srgrimes */ 761590Srgrimestypedef int bool; 771590Srgrimes#define FALSE 0 781590Srgrimes#define TRUE 1 791590Srgrimes 801590Srgrimes /* 8191735Sbde * Historical scale factor in profil(2)'s algorithm for converting 8291735Sbde * pc addresses to bucket numbers. This now just complicates the 8391735Sbde * scaling and makes bucket:pc densities of more than 1/2 useless. 8491735Sbde */ 8591735Sbde#define HISTORICAL_SCALE_2 2 8691735Sbde 8791735Sbde /* 881590Srgrimes * ticks per second 891590Srgrimes */ 901590Srgrimeslong hz; 911590Srgrimes 9213108Sbde#ifdef GPROF4 9327379Sbdetypedef int64_t UNIT; 9413108Sbde#else 951590Srgrimestypedef u_short UNIT; /* unit of profiling */ 9613108Sbde#endif 9791010Sbde 981590Srgrimeschar *a_outname; 991590Srgrimes#define A_OUTNAME "a.out" 1001590Srgrimes 1011590Srgrimeschar *gmonname; 1021590Srgrimes#define GMONSUM "gmon.sum" 1031590Srgrimes 1041590Srgrimes /* 1051590Srgrimes * a constructed arc, 1061590Srgrimes * with pointers to the namelist entry of the parent and the child, 1071590Srgrimes * a count of how many times this arc was traversed, 1081590Srgrimes * and pointers to the next parent of this child and 1091590Srgrimes * the next child of this parent. 1101590Srgrimes */ 1111590Srgrimesstruct arcstruct { 1121590Srgrimes struct nl *arc_parentp; /* pointer to parent's nl entry */ 1131590Srgrimes struct nl *arc_childp; /* pointer to child's nl entry */ 1141590Srgrimes long arc_count; /* num calls from parent to child */ 1151590Srgrimes double arc_time; /* time inherited along arc */ 1161590Srgrimes double arc_childtime; /* childtime inherited along arc */ 1171590Srgrimes struct arcstruct *arc_parentlist; /* parents-of-this-child list */ 1181590Srgrimes struct arcstruct *arc_childlist; /* children-of-this-parent list */ 1191590Srgrimes struct arcstruct *arc_next; /* list of arcs on cycle */ 1201590Srgrimes unsigned short arc_cyclecnt; /* num cycles involved in */ 1211590Srgrimes unsigned short arc_flags; /* see below */ 1221590Srgrimes}; 1231590Srgrimestypedef struct arcstruct arctype; 1241590Srgrimes 1251590Srgrimes /* 1261590Srgrimes * arc flags 1271590Srgrimes */ 1281590Srgrimes#define DEADARC 0x01 /* time should not propagate across the arc */ 1291590Srgrimes#define ONLIST 0x02 /* arc is on list of arcs in cycles */ 1301590Srgrimes 1311590Srgrimes /* 1321590Srgrimes * The symbol table; 1331590Srgrimes * for each external in the specified file we gather 1341590Srgrimes * its address, the number of calls and compute its share of cpu time. 1351590Srgrimes */ 1361590Srgrimesstruct nl { 13738928Sjdp const char *name; /* the name */ 1381590Srgrimes unsigned long value; /* the pc entry point */ 1391590Srgrimes unsigned long svalue; /* entry point aligned to histograms */ 1401590Srgrimes double time; /* ticks in this routine */ 1411590Srgrimes double childtime; /* cumulative ticks in children */ 1421590Srgrimes long ncall; /* how many times called */ 1431590Srgrimes long npropcall; /* times called by live arcs */ 1441590Srgrimes long selfcalls; /* how many calls to self */ 1451590Srgrimes double propfraction; /* what % of time propagates */ 1461590Srgrimes double propself; /* how much self time propagates */ 1471590Srgrimes double propchild; /* how much child time propagates */ 1481590Srgrimes short printflag; /* should this be printed? */ 1491590Srgrimes short flags; /* see below */ 1501590Srgrimes int index; /* index in the graph list */ 1511590Srgrimes int toporder; /* graph call chain top-sort order */ 1521590Srgrimes int cycleno; /* internal number of cycle on */ 1531590Srgrimes int parentcnt; /* number of live parent arcs */ 1541590Srgrimes struct nl *cyclehead; /* pointer to head of cycle */ 1551590Srgrimes struct nl *cnext; /* pointer to next member of cycle */ 1561590Srgrimes arctype *parents; /* list of caller arcs */ 1571590Srgrimes arctype *children; /* list of callee arcs */ 1581590Srgrimes}; 1591590Srgrimestypedef struct nl nltype; 1601590Srgrimes 1611590Srgrimesnltype *nl; /* the whole namelist */ 1621590Srgrimesnltype *npe; /* the virtual end of the namelist */ 1631590Srgrimesint nname; /* the number of function names */ 1641590Srgrimes 1651590Srgrimes#define HASCYCLEXIT 0x08 /* node has arc exiting from cycle */ 1661590Srgrimes#define CYCLEHEAD 0x10 /* node marked as head of a cycle */ 1671590Srgrimes#define VISITED 0x20 /* node visited during a cycle */ 1681590Srgrimes 1691590Srgrimes /* 1701590Srgrimes * The cycle list. 1711590Srgrimes * for each subcycle within an identified cycle, we gather 1721590Srgrimes * its size and the list of included arcs. 1731590Srgrimes */ 1741590Srgrimesstruct cl { 1751590Srgrimes int size; /* length of cycle */ 1761590Srgrimes struct cl *next; /* next member of list */ 1771590Srgrimes arctype *list[1]; /* list of arcs in cycle */ 1781590Srgrimes /* actually longer */ 1791590Srgrimes}; 1801590Srgrimestypedef struct cl cltype; 1811590Srgrimes 1821590Srgrimesarctype *archead; /* the head of arcs in current cycle list */ 1831590Srgrimescltype *cyclehead; /* the head of the list */ 1841590Srgrimesint cyclecnt; /* the number of cycles found */ 1851590Srgrimes#define CYCLEMAX 100 /* maximum cycles before cutting one of them */ 1861590Srgrimes 1871590Srgrimes /* 1881590Srgrimes * flag which marks a nl entry as topologically ``busy'' 1891590Srgrimes * flag which marks a nl entry as topologically ``not_numbered'' 1901590Srgrimes */ 1911590Srgrimes#define DFN_BUSY -1 1921590Srgrimes#define DFN_NAN 0 1931590Srgrimes 1948874Srgrimes /* 1951590Srgrimes * namelist entries for cycle headers. 1961590Srgrimes * the number of discovered cycles. 1971590Srgrimes */ 1981590Srgrimesnltype *cyclenl; /* cycle header namelist */ 1991590Srgrimesint ncycle; /* number of cycles discovered */ 2001590Srgrimes 2011590Srgrimes /* 2021590Srgrimes * The header on the gmon.out file. 2031590Srgrimes * gmon.out consists of a struct phdr (defined in gmon.h) 2041590Srgrimes * and then an array of ncnt samples representing the 2051590Srgrimes * discretized program counter values. 2061590Srgrimes * 2071590Srgrimes * Backward compatible old style header 2081590Srgrimes */ 2091590Srgrimesstruct ophdr { 2101590Srgrimes UNIT *lpc; 2111590Srgrimes UNIT *hpc; 2121590Srgrimes int ncnt; 2131590Srgrimes}; 2141590Srgrimes 2151590Srgrimesint debug; 2161590Srgrimes 2171590Srgrimes /* 2181590Srgrimes * Each discretized pc sample has 2191590Srgrimes * a count of the number of samples in its range 2201590Srgrimes */ 2211590SrgrimesUNIT *samples; 2221590Srgrimes 2231590Srgrimesunsigned long s_lowpc; /* lowpc from the profile file */ 2241590Srgrimesunsigned long s_highpc; /* highpc from the profile file */ 22548839Ssimokawaunsigned long lowpc, highpc; /* range profiled, in UNIT's */ 2261590Srgrimesunsigned sampbytes; /* number of bytes of samples */ 2271590Srgrimesint nsamples; /* number of samples */ 2281590Srgrimesdouble actime; /* accumulated time thus far for putprofline */ 2291590Srgrimesdouble totime; /* total time for all routines */ 2301590Srgrimesdouble printtime; /* total of time being printed */ 2311590Srgrimesdouble scale; /* scale factor converting samples to pc 2321590Srgrimes values: each sample covers scale bytes */ 2331590Srgrimesunsigned char *textspace; /* text space of a.out in core */ 2341590Srgrimesint cyclethreshold; /* with -C, minimum cycle size to ignore */ 2351590Srgrimes 2361590Srgrimes /* 2371590Srgrimes * option flags, from a to z. 2381590Srgrimes */ 2391590Srgrimesbool aflag; /* suppress static functions */ 2401590Srgrimesbool bflag; /* blurbs, too */ 2411590Srgrimesbool cflag; /* discovered call graph, too */ 2421590Srgrimesbool Cflag; /* find cut-set to eliminate cycles */ 2431590Srgrimesbool dflag; /* debugging options */ 2441590Srgrimesbool eflag; /* specific functions excluded */ 2451590Srgrimesbool Eflag; /* functions excluded with time */ 2461590Srgrimesbool fflag; /* specific functions requested */ 2471590Srgrimesbool Fflag; /* functions requested with time */ 2481590Srgrimesbool kflag; /* arcs to be deleted */ 24985739Sgreenbool Kflag; /* use the running kernel for symbols */ 2501590Srgrimesbool sflag; /* sum multiple gmon.out files */ 25138928Sjdpbool uflag; /* suppress symbols hidden from C */ 2521590Srgrimesbool zflag; /* zero time/called functions, too */ 2531590Srgrimes 2541590Srgrimes /* 2551590Srgrimes * structure for various string lists 2561590Srgrimes */ 2571590Srgrimesstruct stringlist { 2581590Srgrimes struct stringlist *next; 2591590Srgrimes char *string; 2601590Srgrimes}; 2611590Srgrimesstruct stringlist *elist; 2621590Srgrimesstruct stringlist *Elist; 2631590Srgrimesstruct stringlist *flist; 2641590Srgrimesstruct stringlist *Flist; 2651590Srgrimesstruct stringlist *kfromlist; 2661590Srgrimesstruct stringlist *ktolist; 2671590Srgrimes 2681590Srgrimes /* 2691590Srgrimes * function declarations 2701590Srgrimes */ 2711590Srgrimes/* 2721590Srgrimes addarc(); 2731590Srgrimes*/ 27438928Sjdpint aout_getnfile(const char *, char ***); 2751590Srgrimesint arccmp(); 2761590Srgrimesarctype *arclookup(); 2771590Srgrimes/* 2781590Srgrimes asgnsamples(); 2791590Srgrimes printblurb(); 2801590Srgrimes cyclelink(); 2811590Srgrimes dfn(); 2821590Srgrimes*/ 2831590Srgrimesbool dfn_busy(); 2841590Srgrimes/* 2851590Srgrimes dfn_findcycle(); 2861590Srgrimes*/ 2871590Srgrimesbool dfn_numbered(); 2881590Srgrimes/* 2891590Srgrimes dfn_post_visit(); 2901590Srgrimes dfn_pre_visit(); 2911590Srgrimes dfn_self_cycle(); 2921590Srgrimes*/ 2931590Srgrimesnltype **doarcs(); 2941590Srgrimes/* 2951590Srgrimes done(); 29638928Sjdp*/ 29738928Sjdpint elf_getnfile(const char *, char ***); 29838928Sjdp/* 2991590Srgrimes findcalls(); 3001590Srgrimes flatprofheader(); 3011590Srgrimes flatprofline(); 3021590Srgrimes*/ 3031590Srgrimes/* 3041590Srgrimes getpfile(); 3051590Srgrimes gprofheader(); 3061590Srgrimes gprofline(); 30785739Sgreen*/ 30885739Sgreenint kernel_getnfile(const char *, char ***); 30985739Sgreen/* 3101590Srgrimes main(); 3111590Srgrimes*/ 3121590Srgrimesunsigned long max(); 3131590Srgrimesint membercmp(); 3141590Srgrimesunsigned long min(); 3151590Srgrimesnltype *nllookup(); 3161590SrgrimesFILE *openpfile(); 3171590Srgrimeslong operandlength(); 3181590Srgrimesoperandenum operandmode(); 3191590Srgrimeschar *operandname(); 3201590Srgrimes/* 3211590Srgrimes printchildren(); 3221590Srgrimes printcycle(); 3231590Srgrimes printgprof(); 3241590Srgrimes printmembers(); 3251590Srgrimes printname(); 3261590Srgrimes printparents(); 3271590Srgrimes printprof(); 3281590Srgrimes readsamples(); 3291590Srgrimes*/ 3301590Srgrimesunsigned long reladdr(); 3311590Srgrimes/* 3321590Srgrimes sortchildren(); 3331590Srgrimes sortmembers(); 3341590Srgrimes sortparents(); 3351590Srgrimes tally(); 3361590Srgrimes timecmp(); 3371590Srgrimes topcmp(); 3381590Srgrimes*/ 3391590Srgrimesint totalcmp(); 3401590Srgrimes/* 3411590Srgrimes valcmp(); 3421590Srgrimes*/ 3431590Srgrimes 3441590Srgrimes#define LESSTHAN -1 3451590Srgrimes#define EQUALTO 0 3461590Srgrimes#define GREATERTHAN 1 3471590Srgrimes 3481590Srgrimes#define DFNDEBUG 1 3491590Srgrimes#define CYCLEDEBUG 2 3501590Srgrimes#define ARCDEBUG 4 3511590Srgrimes#define TALLYDEBUG 8 3521590Srgrimes#define TIMEDEBUG 16 3531590Srgrimes#define SAMPLEDEBUG 32 3541590Srgrimes#define AOUTDEBUG 64 3551590Srgrimes#define CALLDEBUG 128 3561590Srgrimes#define LOOKUPDEBUG 256 3571590Srgrimes#define PROPDEBUG 512 3581590Srgrimes#define BREAKCYCLE 1024 3591590Srgrimes#define SUBCYCLELIST 2048 3601590Srgrimes#define ANYDEBUG 4096 361