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