xref: /freebsd/sys/i386/include/profile.h (revision ca27f0cef04fe67c812aae3568211798f52f28ee)
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  * 4. Neither the name of the University nor the names of its contributors
14  *    may be used to endorse or promote products derived from this software
15  *    without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
18  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
21  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27  * SUCH DAMAGE.
28  *
29  *	@(#)profile.h	8.1 (Berkeley) 6/11/93
30  * $FreeBSD$
31  */
32 
33 #ifndef _MACHINE_PROFILE_H_
34 #define	_MACHINE_PROFILE_H_
35 
36 #ifndef _SYS_CDEFS_H_
37 #error this file needs sys/cdefs.h as a prerequisite
38 #endif
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	MCOUNT_DECL(s)
58 #define	MCOUNT_ENTER(s)
59 #define	MCOUNT_EXIT(s)
60 #ifdef __GNUCLIKE_ASM
61 #define	MCOUNT_OVERHEAD(label)						\
62 	__asm __volatile("pushl %0; call __mcount; popl %%ecx"		\
63 			 :						\
64 			 : "i" (label)					\
65 			 : "ax", "dx", "cx", "memory")
66 #define	MEXITCOUNT_OVERHEAD()						\
67 	__asm __volatile("call .mexitcount; 1:"				\
68 			 : :						\
69 			 : "ax", "dx", "cx", "memory")
70 #define	MEXITCOUNT_OVERHEAD_GETLABEL(labelp)				\
71 	__asm __volatile("movl $1b,%0" : "=rm" (labelp))
72 #elif defined(lint)
73 #define	MCOUNT_OVERHEAD(label)
74 #define	MEXITCOUNT_OVERHEAD()
75 #define	MEXITCOUNT_OVERHEAD_GETLABEL()
76 #else
77 #error
78 #endif /* !__GNUCLIKE_ASM */
79 #else /* !GUPROF */
80 #define	MCOUNT_DECL(s)	register_t s;
81 #ifdef SMP
82 extern int	mcount_lock;
83 #define	MCOUNT_ENTER(s)	{ s = intr_disable(); \
84  			  while (!atomic_cmpset_acq_int(&mcount_lock, 0, 1)) \
85 			  	/* nothing */ ; }
86 #define	MCOUNT_EXIT(s)	{ atomic_store_rel_int(&mcount_lock, 0); \
87 			  intr_restore(s); }
88 #else
89 #define	MCOUNT_ENTER(s)	{ s = intr_disable(); }
90 #define	MCOUNT_EXIT(s)	(intr_restore(s))
91 #endif
92 #endif /* GUPROF */
93 
94 void bintr(void);
95 void btrap(void);
96 void eintr(void);
97 void user(void);
98 
99 #define	MCOUNT_FROMPC_USER(pc)					\
100 	((pc < (uintfptr_t)VM_MAXUSER_ADDRESS) ? (uintfptr_t)user : pc)
101 
102 #define	MCOUNT_FROMPC_INTR(pc)					\
103 	((pc >= (uintfptr_t)btrap && pc < (uintfptr_t)eintr) ?	\
104 	    ((pc >= (uintfptr_t)bintr) ? (uintfptr_t)bintr :	\
105 		(uintfptr_t)btrap) : ~0U)
106 
107 #else /* !_KERNEL */
108 
109 #define	FUNCTION_ALIGNMENT	4
110 
111 #define	_MCOUNT_DECL static __inline void _mcount
112 
113 #ifdef __GNUCLIKE_ASM
114 #define	MCOUNT								\
115 void									\
116 mcount()								\
117 {									\
118 	uintfptr_t selfpc, frompc, ecx;					\
119 	/*								\
120 	 * In gcc 4.2, ecx might be used in the caller as the arg	\
121 	 * pointer if the stack realignment option is set (-mstackrealign) \
122 	 * or if the caller has the force_align_arg_pointer attribute	\
123 	 * (stack realignment is ALWAYS on for main).  Preserve ecx	\
124 	 * here.							\
125 	 */								\
126 	__asm("" : "=c" (ecx));						\
127 	/*								\
128 	 * Find the return address for mcount,				\
129 	 * and the return address for mcount's caller.			\
130 	 *								\
131 	 * selfpc = pc pushed by call to mcount				\
132 	 */								\
133 	__asm("movl 4(%%ebp),%0" : "=r" (selfpc));			\
134 	/*								\
135 	 * frompc = pc pushed by call to mcount's caller.		\
136 	 * The caller's stack frame has already been built, so %ebp is	\
137 	 * the caller's frame pointer.  The caller's raddr is in the	\
138 	 * caller's frame following the caller's caller's frame pointer.\
139 	 */								\
140 	__asm("movl (%%ebp),%0" : "=r" (frompc));			\
141 	frompc = ((uintfptr_t *)frompc)[1];				\
142 	_mcount(frompc, selfpc);					\
143 	__asm("" : : "c" (ecx));					\
144 }
145 #else /* !__GNUCLIKE_ASM */
146 #define	MCOUNT
147 #endif /* __GNUCLIKE_ASM */
148 
149 typedef	u_int	uintfptr_t;
150 
151 #endif /* _KERNEL */
152 
153 /*
154  * An unsigned integral type that can hold non-negative difference between
155  * function pointers.
156  */
157 typedef	u_int	fptrdiff_t;
158 
159 #ifdef _KERNEL
160 
161 void	mcount(uintfptr_t frompc, uintfptr_t selfpc);
162 
163 #else /* !_KERNEL */
164 
165 #include <sys/cdefs.h>
166 
167 __BEGIN_DECLS
168 #ifdef __GNUCLIKE_ASM
169 void	mcount(void) __asm(".mcount");
170 #endif
171 __END_DECLS
172 
173 #endif /* _KERNEL */
174 
175 #endif /* !_MACHINE_PROFILE_H_ */
176