xref: /freebsd/sys/amd64/include/profile.h (revision 6fd05b64b5b65dd4ba9b86482a0634a5f0b96c29)
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 #ifdef _KERNEL
37 
38 /*
39  * Config generates something to tell the compiler to align functions on 16
40  * byte boundaries.  A strict alignment is good for keeping the tables small.
41  */
42 #define	FUNCTION_ALIGNMENT	16
43 
44 /*
45  * The kernel uses assembler stubs instead of unportable inlines.
46  * This is mainly to save a little time when profiling is not enabled,
47  * which is the usual case for the kernel.
48  */
49 #define	_MCOUNT_DECL void mcount
50 #define	MCOUNT
51 
52 #ifdef GUPROF
53 #define	MCOUNT_DECL(s)
54 #define	MCOUNT_ENTER(s)
55 #define	MCOUNT_EXIT(s)
56 #ifdef __GNUC__
57 #define	MCOUNT_OVERHEAD(label)						\
58 	__asm __volatile("pushq %0; call __mcount; popq %%rcx"		\
59 			 :						\
60 			 : "i" (profil)					\
61 			 : "ax", "dx", "cx", "di", "si", "r8", "r9", "memory")
62 #define	MEXITCOUNT_OVERHEAD()						\
63 	__asm __volatile("call .mexitcount; 1:"				\
64 			 : :						\
65 			 : "ax", "dx", "cx", "di", "si", "r8", "r9", "memory")
66 #define	MEXITCOUNT_OVERHEAD_GETLABEL(labelp)				\
67 	__asm __volatile("movq $1b,%0" : "=rm" (labelp))
68 #elif defined(lint)
69 #define	MCOUNT_OVERHEAD(label)
70 #define	MEXITCOUNT_OVERHEAD()
71 #define	MEXITCOUNT_OVERHEAD_GETLABEL()
72 #else
73 #error
74 #endif /* __GNUC */
75 #else /* !GUPROF */
76 #define	MCOUNT_DECL(s)	u_long s;
77 #ifdef SMP
78 extern int	mcount_lock;
79 #define	MCOUNT_ENTER(s)	{ s = read_rflags(); disable_intr(); \
80  			  while (!atomic_cmpset_acq_int(&mcount_lock, 0, 1)) \
81 			  	/* nothing */ ; }
82 #define	MCOUNT_EXIT(s)	{ atomic_store_rel_int(&mcount_lock, 0); \
83 			  write_rflags(s); }
84 #else
85 #define	MCOUNT_ENTER(s)	{ s = read_rflags(); disable_intr(); }
86 #define	MCOUNT_EXIT(s)	(write_rflags(s))
87 #endif
88 #endif /* GUPROF */
89 
90 #else /* !_KERNEL */
91 
92 #define	FUNCTION_ALIGNMENT	4
93 
94 #define	_MCOUNT_DECL \
95 static void _mcount(uintfptr_t frompc, uintfptr_t selfpc) __unused; \
96 static void _mcount
97 
98 #ifdef	__GNUC__
99 #define	MCOUNT __asm("			\n\
100 	.globl	.mcount			\n\
101 	.type	.mcount @function	\n\
102 .mcount:				\n\
103 	pushq	%rbp			\n\
104 	movq	%rsp,%rbp		\n\
105 	pushq	%rdi			\n\
106 	pushq	%rsi			\n\
107 	pushq	%rdx			\n\
108 	pushq	%rcx			\n\
109 	pushq	%r8			\n\
110 	pushq	%r9			\n\
111 	pushq	%rax			\n\
112 	movq	8(%rbp),%rsi		\n\
113 	movq	(%rbp),%rdi		\n\
114 	movq	8(%rdi),%rdi		\n\
115 	call	_mcount			\n\
116 	popq	%rax			\n\
117 	popq	%r9			\n\
118 	popq	%r8			\n\
119 	popq	%rcx			\n\
120 	popq	%rdx			\n\
121 	popq	%rsi			\n\
122 	popq	%rdi			\n\
123 	leave				\n\
124 	ret				\n\
125 	.size	.mcount, . - .mcount");
126 #if 0
127 /*
128  * We could use this, except it doesn't preserve the registers that were
129  * being passed with arguments to the function that we were inserted
130  * into.  I've left it here as documentation of what the code above is
131  * supposed to do.
132  */
133 #define	MCOUNT								\
134 void									\
135 mcount()								\
136 {									\
137 	uintfptr_t selfpc, frompc;					\
138 	/*								\
139 	 * Find the return address for mcount,				\
140 	 * and the return address for mcount's caller.			\
141 	 *								\
142 	 * selfpc = pc pushed by call to mcount				\
143 	 */								\
144 	__asm("movq 8(%%rbp),%0" : "=r" (selfpc));			\
145 	/*								\
146 	 * frompc = pc pushed by call to mcount's caller.		\
147 	 * The caller's stack frame has already been built, so %rbp is	\
148 	 * the caller's frame pointer.  The caller's raddr is in the	\
149 	 * caller's frame following the caller's caller's frame pointer.\
150 	 */								\
151 	__asm("movq (%%rbp),%0" : "=r" (frompc));			\
152 	frompc = ((uintfptr_t *)frompc)[1];				\
153 	_mcount(frompc, selfpc);					\
154 }
155 #endif
156 #else /* !__GNUC__ */
157 #define	MCOUNT								\
158 void									\
159 mcount()								\
160 {									\
161 }
162 #endif /* __GNUC__ */
163 
164 typedef	u_long	uintfptr_t;
165 
166 #endif /* _KERNEL */
167 
168 /*
169  * An unsigned integral type that can hold non-negative difference between
170  * function pointers.
171  */
172 typedef	u_long	fptrdiff_t;
173 
174 #ifdef _KERNEL
175 
176 void	mcount(uintfptr_t frompc, uintfptr_t selfpc);
177 
178 #else /* !_KERNEL */
179 
180 #include <sys/cdefs.h>
181 
182 __BEGIN_DECLS
183 #ifdef __GNUC__
184 void	mcount(void) __asm(".mcount");
185 #endif
186 __END_DECLS
187 
188 #endif /* _KERNEL */
189 
190 #endif /* !_MACHINE_PROFILE_H_ */
191