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