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