xref: /freebsd/sys/i386/include/profile.h (revision f5147e312f43a9050468de539aeafa072caa1a60)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
3  *
4  * Copyright (c) 1992, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. Neither the name of the University nor the names of its contributors
16  *    may be used to endorse or promote products derived from this software
17  *    without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
20  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
23  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
24  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
25  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
26  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
27  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
28  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29  * SUCH DAMAGE.
30  *
31  *	@(#)profile.h	8.1 (Berkeley) 6/11/93
32  * $FreeBSD$
33  */
34 
35 #ifndef _MACHINE_PROFILE_H_
36 #define	_MACHINE_PROFILE_H_
37 
38 #ifndef _SYS_CDEFS_H_
39 #error this file needs sys/cdefs.h as a prerequisite
40 #endif
41 
42 #ifdef _KERNEL
43 
44 /*
45  * Config generates something to tell the compiler to align functions on 16
46  * byte boundaries.  A strict alignment is good for keeping the tables small.
47  */
48 #define	FUNCTION_ALIGNMENT	16
49 
50 /*
51  * The kernel uses assembler stubs instead of unportable inlines.
52  * This is mainly to save a little time when profiling is not enabled,
53  * which is the usual case for the kernel.
54  */
55 #define	_MCOUNT_DECL void mcount
56 #define	MCOUNT
57 
58 #ifdef GUPROF
59 #define	MCOUNT_DECL(s)
60 #define	MCOUNT_ENTER(s)
61 #define	MCOUNT_EXIT(s)
62 #ifdef __GNUCLIKE_ASM
63 #define	MCOUNT_OVERHEAD(label)						\
64 	__asm __volatile("pushl %0; call __mcount; popl %%ecx"		\
65 			 :						\
66 			 : "i" (label)					\
67 			 : "ax", "dx", "cx", "memory")
68 #define	MEXITCOUNT_OVERHEAD()						\
69 	__asm __volatile("call .mexitcount; 1:"				\
70 			 : :						\
71 			 : "ax", "dx", "cx", "memory")
72 #define	MEXITCOUNT_OVERHEAD_GETLABEL(labelp)				\
73 	__asm __volatile("movl $1b,%0" : "=rm" (labelp))
74 #else
75 #error
76 #endif /* !__GNUCLIKE_ASM */
77 #else /* !GUPROF */
78 #define	MCOUNT_DECL(s)	register_t s;
79 #ifdef SMP
80 extern int	mcount_lock;
81 #define	MCOUNT_ENTER(s)	{ s = intr_disable(); \
82  			  while (!atomic_cmpset_acq_int(&mcount_lock, 0, 1)) \
83 			  	/* nothing */ ; }
84 #define	MCOUNT_EXIT(s)	{ atomic_store_rel_int(&mcount_lock, 0); \
85 			  intr_restore(s); }
86 #else
87 #define	MCOUNT_ENTER(s)	{ s = intr_disable(); }
88 #define	MCOUNT_EXIT(s)	(intr_restore(s))
89 #endif
90 #endif /* GUPROF */
91 
92 void bintr(void);
93 void btrap(void);
94 void eintr(void);
95 void user(void);
96 
97 #define	MCOUNT_FROMPC_USER(pc)					\
98 	((pc < (uintfptr_t)VM_MAXUSER_ADDRESS) ? (uintfptr_t)user : pc)
99 
100 #define	MCOUNT_FROMPC_INTR(pc)					\
101 	((pc >= (uintfptr_t)btrap && pc < (uintfptr_t)eintr) ?	\
102 	    ((pc >= (uintfptr_t)bintr) ? (uintfptr_t)bintr :	\
103 		(uintfptr_t)btrap) : ~0U)
104 
105 #else /* !_KERNEL */
106 
107 #define	FUNCTION_ALIGNMENT	4
108 
109 #define	_MCOUNT_DECL static __inline void _mcount
110 
111 #ifdef __GNUCLIKE_ASM
112 #define	MCOUNT								\
113 void									\
114 mcount()								\
115 {									\
116 	uintfptr_t selfpc, frompc, ecx;					\
117 	/*								\
118 	 * In gcc 4.2, ecx might be used in the caller as the arg	\
119 	 * pointer if the stack realignment option is set (-mstackrealign) \
120 	 * or if the caller has the force_align_arg_pointer attribute	\
121 	 * (stack realignment is ALWAYS on for main).  Preserve ecx	\
122 	 * here.							\
123 	 */								\
124 	__asm("" : "=c" (ecx));						\
125 	/*								\
126 	 * Find the return address for mcount,				\
127 	 * and the return address for mcount's caller.			\
128 	 *								\
129 	 * selfpc = pc pushed by call to mcount				\
130 	 */								\
131 	__asm("movl 4(%%ebp),%0" : "=r" (selfpc));			\
132 	/*								\
133 	 * frompc = pc pushed by call to mcount's caller.		\
134 	 * The caller's stack frame has already been built, so %ebp is	\
135 	 * the caller's frame pointer.  The caller's raddr is in the	\
136 	 * caller's frame following the caller's caller's frame pointer.\
137 	 */								\
138 	__asm("movl (%%ebp),%0" : "=r" (frompc));			\
139 	frompc = ((uintfptr_t *)frompc)[1];				\
140 	_mcount(frompc, selfpc);					\
141 	__asm("" : : "c" (ecx));					\
142 }
143 #else /* !__GNUCLIKE_ASM */
144 #define	MCOUNT
145 #endif /* __GNUCLIKE_ASM */
146 
147 typedef	u_int	uintfptr_t;
148 
149 #endif /* _KERNEL */
150 
151 /*
152  * An unsigned integral type that can hold non-negative difference between
153  * function pointers.
154  */
155 typedef	u_int	fptrdiff_t;
156 
157 #ifdef _KERNEL
158 
159 void	mcount(uintfptr_t frompc, uintfptr_t selfpc);
160 
161 #else /* !_KERNEL */
162 
163 #include <sys/cdefs.h>
164 
165 __BEGIN_DECLS
166 #ifdef __GNUCLIKE_ASM
167 void	mcount(void) __asm(".mcount");
168 #endif
169 __END_DECLS
170 
171 #endif /* _KERNEL */
172 
173 #endif /* !_MACHINE_PROFILE_H_ */
174