xref: /freebsd/sys/amd64/include/profile.h (revision 0957b409)
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 			 : "cx", "r10", "r11", "memory")
68 #define	MEXITCOUNT_OVERHEAD()						\
69 	__asm __volatile("call .mexitcount; 1:"				\
70 			 : :						\
71 			 : "r10", "r11", "memory")
72 #define	MEXITCOUNT_OVERHEAD_GETLABEL(labelp)				\
73 	__asm __volatile("movq $1b,%0" : "=rm" (labelp))
74 #else
75 #error this file needs to be ported to your compiler
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) : ~0UL)
104 
105 #else /* !_KERNEL */
106 
107 #define	FUNCTION_ALIGNMENT	4
108 
109 #define	_MCOUNT_DECL \
110 static void _mcount(uintfptr_t frompc, uintfptr_t selfpc) __used; \
111 static void _mcount
112 
113 #ifdef __GNUCLIKE_ASM
114 #define	MCOUNT __asm("			\n\
115 	.text				\n\
116 	.p2align 4,0x90			\n\
117 	.globl	.mcount			\n\
118 	.type	.mcount,@function	\n\
119 .mcount:				\n\
120 	pushq	%rdi			\n\
121 	pushq	%rsi			\n\
122 	pushq	%rdx			\n\
123 	pushq	%rcx			\n\
124 	pushq	%r8			\n\
125 	pushq	%r9			\n\
126 	pushq	%rax			\n\
127 	movq	8(%rbp),%rdi		\n\
128 	movq	7*8(%rsp),%rsi		\n\
129 	call	_mcount			\n\
130 	popq	%rax			\n\
131 	popq	%r9			\n\
132 	popq	%r8			\n\
133 	popq	%rcx			\n\
134 	popq	%rdx			\n\
135 	popq	%rsi			\n\
136 	popq	%rdi			\n\
137 	ret				\n\
138 	.size	.mcount, . - .mcount");
139 #if 0
140 /*
141  * We could use this, except it doesn't preserve the registers that were
142  * being passed with arguments to the function that we were inserted
143  * into.  I've left it here as documentation of what the code above is
144  * supposed to do.
145  */
146 #define	MCOUNT								\
147 void									\
148 mcount()								\
149 {									\
150 	uintfptr_t selfpc, frompc;					\
151 	/*								\
152 	 * Find the return address for mcount,				\
153 	 * and the return address for mcount's caller.			\
154 	 *								\
155 	 * selfpc = pc pushed by call to mcount				\
156 	 */								\
157 	__asm("movq 8(%%rbp),%0" : "=r" (selfpc));			\
158 	/*								\
159 	 * frompc = pc pushed by call to mcount's caller.		\
160 	 * The caller's stack frame has already been built, so %rbp is	\
161 	 * the caller's frame pointer.  The caller's raddr is in the	\
162 	 * caller's frame following the caller's caller's frame pointer.\
163 	 */								\
164 	__asm("movq (%%rbp),%0" : "=r" (frompc));			\
165 	frompc = ((uintfptr_t *)frompc)[1];				\
166 	_mcount(frompc, selfpc);					\
167 }
168 #endif
169 #else /* !__GNUCLIKE_ASM */
170 #define	MCOUNT
171 #endif /* __GNUCLIKE_ASM */
172 
173 typedef	u_long	uintfptr_t;
174 
175 #endif /* _KERNEL */
176 
177 /*
178  * An unsigned integral type that can hold non-negative difference between
179  * function pointers.
180  */
181 typedef	u_long	fptrdiff_t;
182 
183 #ifdef _KERNEL
184 
185 void	mcount(uintfptr_t frompc, uintfptr_t selfpc);
186 
187 #else /* !_KERNEL */
188 
189 #include <sys/cdefs.h>
190 
191 __BEGIN_DECLS
192 #ifdef __GNUCLIKE_ASM
193 void	mcount(void) __asm(".mcount");
194 #endif
195 __END_DECLS
196 
197 #endif /* _KERNEL */
198 
199 #endif /* !_MACHINE_PROFILE_H_ */
200