xref: /freebsd/sys/amd64/include/profile.h (revision 8a16b7a18f5d0b031f09832fd7752fba717e2a97)
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("pushq %0; call __mcount; popq %%rcx"		\
65 			 :						\
66 			 : "i" (label)					\
67 			 : "ax", "dx", "cx", "di", "si", "r8", "r9", "memory")
68 #define	MEXITCOUNT_OVERHEAD()						\
69 	__asm __volatile("call .mexitcount; 1:"				\
70 			 : :						\
71 			 : "ax", "dx", "cx", "di", "si", "r8", "r9", "memory")
72 #define	MEXITCOUNT_OVERHEAD_GETLABEL(labelp)				\
73 	__asm __volatile("movq $1b,%0" : "=rm" (labelp))
74 #elif defined(lint)
75 #define	MCOUNT_OVERHEAD(label)
76 #define	MEXITCOUNT_OVERHEAD()
77 #define	MEXITCOUNT_OVERHEAD_GETLABEL()
78 #else
79 #error this file needs to be ported to your compiler
80 #endif /* !__GNUCLIKE_ASM */
81 #else /* !GUPROF */
82 #define	MCOUNT_DECL(s)	register_t s;
83 #ifdef SMP
84 extern int	mcount_lock;
85 #define	MCOUNT_ENTER(s)	{ s = intr_disable(); \
86  			  while (!atomic_cmpset_acq_int(&mcount_lock, 0, 1)) \
87 			  	/* nothing */ ; }
88 #define	MCOUNT_EXIT(s)	{ atomic_store_rel_int(&mcount_lock, 0); \
89 			  intr_restore(s); }
90 #else
91 #define	MCOUNT_ENTER(s)	{ s = intr_disable(); }
92 #define	MCOUNT_EXIT(s)	(intr_restore(s))
93 #endif
94 #endif /* GUPROF */
95 
96 void bintr(void);
97 void btrap(void);
98 void eintr(void);
99 void user(void);
100 
101 #define	MCOUNT_FROMPC_USER(pc)					\
102 	((pc < (uintfptr_t)VM_MAXUSER_ADDRESS) ? (uintfptr_t)user : pc)
103 
104 #define	MCOUNT_FROMPC_INTR(pc)					\
105 	((pc >= (uintfptr_t)btrap && pc < (uintfptr_t)eintr) ?	\
106 	    ((pc >= (uintfptr_t)bintr) ? (uintfptr_t)bintr :	\
107 		(uintfptr_t)btrap) : ~0UL)
108 
109 #else /* !_KERNEL */
110 
111 #define	FUNCTION_ALIGNMENT	4
112 
113 #define	_MCOUNT_DECL \
114 static void _mcount(uintfptr_t frompc, uintfptr_t selfpc) __used; \
115 static void _mcount
116 
117 #ifdef __GNUCLIKE_ASM
118 #define	MCOUNT __asm("			\n\
119 	.text				\n\
120 	.p2align 4,0x90			\n\
121 	.globl	.mcount			\n\
122 	.type	.mcount,@function	\n\
123 .mcount:				\n\
124 	pushq	%rdi			\n\
125 	pushq	%rsi			\n\
126 	pushq	%rdx			\n\
127 	pushq	%rcx			\n\
128 	pushq	%r8			\n\
129 	pushq	%r9			\n\
130 	pushq	%rax			\n\
131 	movq	8(%rbp),%rdi		\n\
132 	movq	7*8(%rsp),%rsi		\n\
133 	call	_mcount			\n\
134 	popq	%rax			\n\
135 	popq	%r9			\n\
136 	popq	%r8			\n\
137 	popq	%rcx			\n\
138 	popq	%rdx			\n\
139 	popq	%rsi			\n\
140 	popq	%rdi			\n\
141 	ret				\n\
142 	.size	.mcount, . - .mcount");
143 #if 0
144 /*
145  * We could use this, except it doesn't preserve the registers that were
146  * being passed with arguments to the function that we were inserted
147  * into.  I've left it here as documentation of what the code above is
148  * supposed to do.
149  */
150 #define	MCOUNT								\
151 void									\
152 mcount()								\
153 {									\
154 	uintfptr_t selfpc, frompc;					\
155 	/*								\
156 	 * Find the return address for mcount,				\
157 	 * and the return address for mcount's caller.			\
158 	 *								\
159 	 * selfpc = pc pushed by call to mcount				\
160 	 */								\
161 	__asm("movq 8(%%rbp),%0" : "=r" (selfpc));			\
162 	/*								\
163 	 * frompc = pc pushed by call to mcount's caller.		\
164 	 * The caller's stack frame has already been built, so %rbp is	\
165 	 * the caller's frame pointer.  The caller's raddr is in the	\
166 	 * caller's frame following the caller's caller's frame pointer.\
167 	 */								\
168 	__asm("movq (%%rbp),%0" : "=r" (frompc));			\
169 	frompc = ((uintfptr_t *)frompc)[1];				\
170 	_mcount(frompc, selfpc);					\
171 }
172 #endif
173 #else /* !__GNUCLIKE_ASM */
174 #define	MCOUNT
175 #endif /* __GNUCLIKE_ASM */
176 
177 typedef	u_long	uintfptr_t;
178 
179 #endif /* _KERNEL */
180 
181 /*
182  * An unsigned integral type that can hold non-negative difference between
183  * function pointers.
184  */
185 typedef	u_long	fptrdiff_t;
186 
187 #ifdef _KERNEL
188 
189 void	mcount(uintfptr_t frompc, uintfptr_t selfpc);
190 
191 #else /* !_KERNEL */
192 
193 #include <sys/cdefs.h>
194 
195 __BEGIN_DECLS
196 #ifdef __GNUCLIKE_ASM
197 void	mcount(void) __asm(".mcount");
198 #endif
199 __END_DECLS
200 
201 #endif /* _KERNEL */
202 
203 #endif /* !_MACHINE_PROFILE_H_ */
204