2 * Copyright (c) 1993 The Regents of the University of California.
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
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.
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
32 #ifndef _MACHINE_ASMACROS_H_
33 #define _MACHINE_ASMACROS_H_
35 #include <sys/cdefs.h>
38 /* XXX too much duplication in various asm*.h's. */
41 * CNAME and HIDENAME manage the relationship between symbol names in C
42 * and the equivalent assembly language names. CNAME is given a name as
43 * it would be used in a C program. It expands to the equivalent assembly
44 * language name. HIDENAME is given an assembly-language name, and expands
45 * to a possibly-modified form that will be invisible to C programs.
47 #define CNAME(csym) csym
48 #define HIDENAME(asmsym) .asmsym
50 #define ALIGN_DATA .p2align 3 /* 8 byte alignment, zero filled */
52 #define ALIGN_TEXT .p2align 4,0x90 /* 16-byte alignment, nop filled */
54 #define ALIGN_TEXT .p2align 4,0x90 /* 16-byte alignment, nop filled */
56 #define SUPERALIGN_TEXT .p2align 4,0x90 /* 16-byte alignment, nop filled */
58 #define GEN_ENTRY(name) ALIGN_TEXT; .globl CNAME(name); \
59 .type CNAME(name),@function; CNAME(name):
60 #define NON_GPROF_ENTRY(name) GEN_ENTRY(name)
61 #define NON_GPROF_RET .byte 0xc3 /* opcode for `ret' */
65 * __mcount is like [.]mcount except that doesn't require its caller to set
66 * up a frame pointer. It must be called before pushing anything onto the
67 * stack. gcc should eventually generate code to call __mcount in most
68 * cases. This would make -pg in combination with -fomit-frame-pointer
69 * useful. gcc has a configuration variable PROFILE_BEFORE_PROLOGUE to
70 * allow profiling before setting up the frame pointer, but this is
71 * inadequate for good handling of special cases, e.g., -fpic works best
72 * with profiling after the prologue.
74 * [.]mexitcount is a new function to support non-statistical profiling if an
75 * accurate clock is available. For C sources, calls to it are generated
76 * by the FreeBSD extension `-mprofiler-epilogue' to gcc. It is best to
77 * call [.]mexitcount at the end of a function like the MEXITCOUNT macro does,
78 * but gcc currently generates calls to it at the start of the epilogue to
79 * avoid problems with -fpic.
81 * [.]mcount and __mcount may clobber the call-used registers and %ef.
82 * [.]mexitcount may clobber %ecx and %ef.
84 * Cross-jumping makes non-statistical profiling timing more complicated.
85 * It is handled in many cases by calling [.]mexitcount before jumping. It
86 * is handled for conditional jumps using CROSSJUMP() and CROSSJUMP_LABEL().
87 * It is handled for some fault-handling jumps by not sharing the exit
90 * ALTENTRY() must be before a corresponding ENTRY() so that it can jump to
91 * the main entry point. Note that alt entries are counted twice. They
92 * have to be counted as ordinary entries for gprof to get the call times
93 * right for the ordinary entries.
95 * High local labels are used in macros to avoid clashes with local labels
98 * Ordinary `ret' is used instead of a macro `RET' because there are a lot
99 * of `ret's. 0xc3 is the opcode for `ret' (`#define ret ... ret' can't
100 * be used because this file is sometimes preprocessed in traditional mode).
101 * `ret' clobbers eflags but this doesn't matter.
103 #define ALTENTRY(name) GEN_ENTRY(name) ; MCOUNT ; MEXITCOUNT ; jmp 9f
104 #define CROSSJUMP(jtrue, label, jfalse) \
105 jfalse 8f; MEXITCOUNT; jmp __CONCAT(to,label); 8:
106 #define CROSSJUMPTARGET(label) \
107 ALIGN_TEXT; __CONCAT(to,label): ; MCOUNT; jmp label
108 #define ENTRY(name) GEN_ENTRY(name) ; 9: ; MCOUNT
109 #define FAKE_MCOUNT(caller) pushq caller ; call __mcount ; popq %rcx
110 #define MCOUNT call __mcount
111 #define MCOUNT_LABEL(name) GEN_ENTRY(name) ; nop ; ALIGN_TEXT
112 #define MEXITCOUNT call HIDENAME(mexitcount)
113 #define ret MEXITCOUNT ; NON_GPROF_RET
117 * ALTENTRY() has to align because it is before a corresponding ENTRY().
118 * ENTRY() has to align to because there may be no ALTENTRY() before it.
119 * If there is a previous ALTENTRY() then the alignment code for ENTRY()
122 #define ALTENTRY(name) GEN_ENTRY(name)
123 #define CROSSJUMP(jtrue, label, jfalse) jtrue label
124 #define CROSSJUMPTARGET(label)
125 #define ENTRY(name) GEN_ENTRY(name)
126 #define FAKE_MCOUNT(caller)
128 #define MCOUNT_LABEL(name)
134 * Convenience macro for declaring interrupt entry points.
136 #define IDTVEC(name) ALIGN_TEXT; .globl __CONCAT(X,name); \
137 .type __CONCAT(X,name),@function; __CONCAT(X,name):
140 * Macros to create and destroy a trap frame.
143 subq $TF_RIP,%rsp ; /* skip dummy tf_err and tf_trapno */ \
144 testb $SEL_RPL_MASK,TF_CS(%rsp) ; /* come from kernel? */ \
145 jz 1f ; /* Yes, dont swapgs again */ \
147 1: movq %rdi,TF_RDI(%rsp) ; \
148 movq %rsi,TF_RSI(%rsp) ; \
149 movq %rdx,TF_RDX(%rsp) ; \
150 movq %rcx,TF_RCX(%rsp) ; \
151 movq %r8,TF_R8(%rsp) ; \
152 movq %r9,TF_R9(%rsp) ; \
153 movq %rax,TF_RAX(%rsp) ; \
154 movq %rbx,TF_RBX(%rsp) ; \
155 movq %rbp,TF_RBP(%rsp) ; \
156 movq %r10,TF_R10(%rsp) ; \
157 movq %r11,TF_R11(%rsp) ; \
158 movq %r12,TF_R12(%rsp) ; \
159 movq %r13,TF_R13(%rsp) ; \
160 movq %r14,TF_R14(%rsp) ; \
161 movq %r15,TF_R15(%rsp)
164 movq TF_RDI(%rsp),%rdi ; \
165 movq TF_RSI(%rsp),%rsi ; \
166 movq TF_RDX(%rsp),%rdx ; \
167 movq TF_RCX(%rsp),%rcx ; \
168 movq TF_R8(%rsp),%r8 ; \
169 movq TF_R9(%rsp),%r9 ; \
170 movq TF_RAX(%rsp),%rax ; \
171 movq TF_RBX(%rsp),%rbx ; \
172 movq TF_RBP(%rsp),%rbp ; \
173 movq TF_R10(%rsp),%r10 ; \
174 movq TF_R11(%rsp),%r11 ; \
175 movq TF_R12(%rsp),%r12 ; \
176 movq TF_R13(%rsp),%r13 ; \
177 movq TF_R14(%rsp),%r14 ; \
178 movq TF_R15(%rsp),%r15 ; \
179 testb $SEL_RPL_MASK,TF_CS(%rsp) ; /* come from kernel? */ \
180 jz 1f ; /* keep kernel GS.base */ \
183 1: addq $TF_RIP,%rsp /* skip over tf_err, tf_trapno */
186 * Access per-CPU data.
188 #define PCPU(member) %gs:PC_ ## member
189 #define PCPU_ADDR(member, reg) \
190 movq %gs:PC_PRVSPACE, reg ; \
191 addq $PC_ ## member, reg
195 #endif /* !_MACHINE_ASMACROS_H_ */