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