xref: /freebsd/sys/i386/include/profile.h (revision 3e0f6b97b257a96f7275e4442204263e44b16686)
1 /*
2  * Copyright (c) 1992, 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  *	@(#)profile.h	8.1 (Berkeley) 6/11/93
34  * $FreeBSD$
35  */
36 
37 #ifndef _MACHINE_PROFILE_H_
38 #define	_MACHINE_PROFILE_H_
39 
40 #ifdef KERNEL
41 /*
42  * Config generates something to tell the compiler to align functions on 16
43  * byte boundaries.  A strict alignment is good for keeping the tables small.
44  */
45 #define	FUNCTION_ALIGNMENT	16
46 
47 /*
48  * The kernel uses assembler stubs instead of unportable inlines.
49  * This is mainly to save a little time when profiling is not enabled,
50  * which is the usual case for the kernel.
51  */
52 #define	_MCOUNT_DECL void mcount
53 #define	MCOUNT
54 
55 #ifdef GUPROF
56 #define	CALIB_SCALE	1000
57 #define	KCOUNT(p,index)	((p)->kcount[(index) \
58 			 / (HISTFRACTION * sizeof(HISTCOUNTER))])
59 #define	MCOUNT_DECL(s)
60 #define	MCOUNT_ENTER(s)
61 #define	MCOUNT_EXIT(s)
62 #define	PC_TO_I(p, pc)	((fptrint_t)(pc) - (fptrint_t)(p)->lowpc)
63 #else
64 #define	MCOUNT_DECL(s)	u_long s;
65 #define	MCOUNT_ENTER(s)	{ s = read_eflags(); disable_intr(); }
66 #define	MCOUNT_EXIT(s)	(write_eflags(s))
67 #endif /* GUPROF */
68 
69 #else /* !KERNEL */
70 
71 #define	FUNCTION_ALIGNMENT	4
72 
73 #define	_MCOUNT_DECL static __inline void _mcount
74 
75 #define	MCOUNT \
76 void \
77 mcount() \
78 { \
79 	fptrint_t selfpc, frompc; \
80 	/* \
81 	 * Find the return address for mcount, \
82 	 * and the return address for mcount's caller. \
83 	 * \
84 	 * selfpc = pc pushed by call to mcount \
85 	 */ \
86 	asm("movl 4(%%ebp),%0" : "=r" (selfpc)); \
87 	/* \
88 	 * frompc = pc pushed by call to mcount's caller. \
89 	 * The caller's stack frame has already been built, so %ebp is \
90 	 * the caller's frame pointer.  The caller's raddr is in the \
91 	 * caller's frame following the caller's caller's frame pointer. \
92 	 */ \
93 	asm("movl (%%ebp),%0" : "=r" (frompc)); \
94 	frompc = ((fptrint_t *)frompc)[1]; \
95 	_mcount(frompc, selfpc); \
96 }
97 #endif /* KERNEL */
98 
99 /* An unsigned integral type that can hold function pointers. */
100 typedef	u_int	fptrint_t;
101 
102 /*
103  * An unsigned integral type that can hold non-negative difference between
104  * function pointers.
105  */
106 typedef	int	fptrdiff_t;
107 
108 #ifdef KERNEL
109 
110 void	mcount __P((fptrint_t frompc, fptrint_t selfpc));
111 
112 #ifdef GUPROF
113 struct gmonparam;
114 
115 void	nullfunc_loop_profiled __P((void));
116 void	nullfunc_profiled __P((void));
117 void	startguprof __P((struct gmonparam *p));
118 void	stopguprof __P((struct gmonparam *p));
119 #else
120 #define	startguprof(p)
121 #define	stopguprof(p)
122 #endif /* GUPROF */
123 
124 #else /* !KERNEL */
125 
126 #include <sys/cdefs.h>
127 
128 __BEGIN_DECLS
129 void	mcount __P((void)) __asm("mcount");
130 static void	_mcount __P((fptrint_t frompc, fptrint_t selfpc));
131 __END_DECLS
132 
133 #endif /* KERNEL */
134 
135 #ifdef GUPROF
136 /* XXX doesn't quite work outside kernel yet. */
137 extern int	cputime_bias;
138 
139 __BEGIN_DECLS
140 int	cputime __P((void));
141 void	empty_loop __P((void));
142 void	mexitcount __P((fptrint_t selfpc));
143 void	nullfunc __P((void));
144 void	nullfunc_loop __P((void));
145 __END_DECLS
146 #endif
147 
148 #endif /* !_MACHINE_PROFILE_H_ */
149