profile.h revision 163729
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: head/sys/amd64/include/profile.h 163729 2006-10-28 07:59:11Z bde $
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)	u_long s;
81#ifdef SMP
82extern int	mcount_lock;
83#define	MCOUNT_ENTER(s)	{ s = read_rflags(); disable_intr(); \
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			  write_rflags(s); }
88#else
89#define	MCOUNT_ENTER(s)	{ s = read_rflags(); disable_intr(); }
90#define	MCOUNT_EXIT(s)	(write_rflags(s))
91#endif
92#endif /* GUPROF */
93
94void bintr(void);
95void btrap(void);
96void eintr(void);
97void 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 \
112static void _mcount(uintfptr_t frompc, uintfptr_t selfpc) __used; \
113static void _mcount
114
115#ifdef __GNUCLIKE_ASM
116#define	MCOUNT __asm("			\n\
117	.globl	.mcount			\n\
118	.type	.mcount @function	\n\
119.mcount:				\n\
120	pushq	%rbp			\n\
121	movq	%rsp,%rbp		\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),%rsi		\n\
130	movq	(%rbp),%rdi		\n\
131	movq	8(%rdi),%rdi		\n\
132	call	_mcount			\n\
133	popq	%rax			\n\
134	popq	%r9			\n\
135	popq	%r8			\n\
136	popq	%rcx			\n\
137	popq	%rdx			\n\
138	popq	%rsi			\n\
139	popq	%rdi			\n\
140	leave				\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								\
151void									\
152mcount()								\
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								\
175void									\
176mcount()								\
177{									\
178}
179#endif /* __GNUCLIKE_ASM */
180
181typedef	u_long	uintfptr_t;
182
183#endif /* _KERNEL */
184
185/*
186 * An unsigned integral type that can hold non-negative difference between
187 * function pointers.
188 */
189typedef	u_long	fptrdiff_t;
190
191#ifdef _KERNEL
192
193void	mcount(uintfptr_t frompc, uintfptr_t selfpc);
194
195#else /* !_KERNEL */
196
197#include <sys/cdefs.h>
198
199__BEGIN_DECLS
200#ifdef __GNUCLIKE_ASM
201void	mcount(void) __asm(".mcount");
202#endif
203__END_DECLS
204
205#endif /* _KERNEL */
206
207#endif /* !_MACHINE_PROFILE_H_ */
208