]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - sys/i386/include/profile.h
Start to split out the really x86 specific NOTES from the global notes file.
[FreeBSD/FreeBSD.git] / sys / i386 / include / profile.h
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("pushl %0; call __mcount; popl %%ecx"          \
65                          :                                              \
66                          : "i" (label)                                  \
67                          : "ax", "dx", "cx", "memory")
68 #define MEXITCOUNT_OVERHEAD()                                           \
69         __asm __volatile("call .mexitcount; 1:"                         \
70                          : :                                            \
71                          : "cx", "memory")
72 #define MEXITCOUNT_OVERHEAD_GETLABEL(labelp)                            \
73         __asm __volatile("movl $1b,%0" : "=rm" (labelp))
74 #else
75 #error
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 #if 0
96 void end_exceptions(void);
97 void start_exceptions(void);
98 #else
99 #include <machine/pmc_mdep.h>           /* XXX */
100 #endif
101 void user(void);
102
103 #include <machine/md_var.h>             /* XXX for setidt_disp */
104
105 #define MCOUNT_DETRAMP(pc) do {                                 \
106         if ((pc) >= (uintfptr_t)start_exceptions + setidt_disp && \
107             (pc) < (uintfptr_t)end_exceptions + setidt_disp)    \
108                 (pc) -= setidt_disp;                            \
109 } while (0)
110
111 #define MCOUNT_FROMPC_INTR(pc)                                  \
112         ((pc >= (uintfptr_t)btrap && pc < (uintfptr_t)eintr) ?  \
113             ((pc >= (uintfptr_t)bintr) ? (uintfptr_t)bintr :    \
114                 (uintfptr_t)btrap) : ~0U)
115
116 #define MCOUNT_USERPC           ((uintfptr_t)user)
117
118 #else /* !_KERNEL */
119
120 #define FUNCTION_ALIGNMENT      4
121
122 #define _MCOUNT_DECL static __inline void _mcount
123
124 #ifdef __GNUCLIKE_ASM
125 #define MCOUNT                                                          \
126 void                                                                    \
127 mcount()                                                                \
128 {                                                                       \
129         uintfptr_t selfpc, frompc, ecx;                                 \
130         /*                                                              \
131          * In gcc 4.2, ecx might be used in the caller as the arg       \
132          * pointer if the stack realignment option is set (-mstackrealign) \
133          * or if the caller has the force_align_arg_pointer attribute   \
134          * (stack realignment is ALWAYS on for main).  Preserve ecx     \
135          * here.                                                        \
136          */                                                             \
137         __asm("" : "=c" (ecx));                                         \
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("movl 4(%%ebp),%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 %ebp 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("movl (%%ebp),%0" : "=r" (frompc));                       \
152         frompc = ((uintfptr_t *)frompc)[1];                             \
153         _mcount(frompc, selfpc);                                        \
154         __asm("" : : "c" (ecx));                                        \
155 }
156 #else /* !__GNUCLIKE_ASM */
157 #define MCOUNT
158 #endif /* __GNUCLIKE_ASM */
159
160 typedef u_int   uintfptr_t;
161
162 #endif /* _KERNEL */
163
164 /*
165  * An unsigned integral type that can hold non-negative difference between
166  * function pointers.
167  */
168 typedef u_int   fptrdiff_t;
169
170 #ifdef _KERNEL
171
172 void    mcount(uintfptr_t frompc, uintfptr_t selfpc);
173
174 #else /* !_KERNEL */
175
176 #include <sys/cdefs.h>
177
178 __BEGIN_DECLS
179 #ifdef __GNUCLIKE_ASM
180 void    mcount(void) __asm(".mcount");
181 #endif
182 __END_DECLS
183
184 #endif /* _KERNEL */
185
186 #endif /* !_MACHINE_PROFILE_H_ */