Fix amd64 trap handling.
[dragonfly.git] / sys / cpu / amd64 / include / asmacros.h
CommitLineData
c8fe38ae 1/*
d7f50089 2 * Copyright (c) 1993 The Regents of the University of California.
c8fe38ae 3 * Copyright (c) 2008 The DragonFly Project.
d7f50089
YY
4 * All rights reserved.
5 *
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
8 * are met:
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * 4. Neither the name of the University nor the names of its contributors
15 * may be used to endorse or promote products derived from this software
16 * without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
19 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
22 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
23 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
24 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
25 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
27 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
28 * SUCH DAMAGE.
29 *
30 * $FreeBSD: src/sys/amd64/include/asmacros.h,v 1.32 2006/10/28 06:04:29 bde Exp $
c8fe38ae 31 * $DragonFly: src/sys/cpu/amd64/include/asmacros.h,v 1.2 2008/08/29 17:07:06 dillon Exp $
d7f50089
YY
32 */
33
34#ifndef _CPU_ASMACROS_H_
35#define _CPU_ASMACROS_H_
36
37#include <sys/cdefs.h>
38
39/* XXX too much duplication in various asm*.h's. */
40
41/*
42 * CNAME is used to manage the relationship between symbol names in C
43 * and the equivalent assembly language names. CNAME is given a name as
44 * it would be used in a C program. It expands to the equivalent assembly
45 * language name.
46 */
47#define CNAME(csym) csym
48
49#define ALIGN_DATA .p2align 3 /* 8 byte alignment, zero filled */
50#ifdef GPROF
51#define ALIGN_TEXT .p2align 4,0x90 /* 16-byte alignment, nop filled */
52#else
53#define ALIGN_TEXT .p2align 4,0x90 /* 16-byte alignment, nop filled */
54#endif
55#define SUPERALIGN_TEXT .p2align 4,0x90 /* 16-byte alignment, nop filled */
56
57#define GEN_ENTRY(name) ALIGN_TEXT; .globl CNAME(name); \
58 .type CNAME(name),@function; CNAME(name):
59#define NON_GPROF_ENTRY(name) GEN_ENTRY(name)
60#define NON_GPROF_RET .byte 0xc3 /* opcode for `ret' */
61
62#ifdef GPROF
63/*
64 * __mcount is like [.]mcount except that doesn't require its caller to set
65 * up a frame pointer. It must be called before pushing anything onto the
66 * stack. gcc should eventually generate code to call __mcount in most
67 * cases. This would make -pg in combination with -fomit-frame-pointer
68 * useful. gcc has a configuration variable PROFILE_BEFORE_PROLOGUE to
69 * allow profiling before setting up the frame pointer, but this is
70 * inadequate for good handling of special cases, e.g., -fpic works best
71 * with profiling after the prologue.
72 *
73 * [.]mexitcount is a new function to support non-statistical profiling if an
74 * accurate clock is available. For C sources, calls to it are generated
75 * by the FreeBSD extension `-mprofiler-epilogue' to gcc. It is best to
76 * call [.]mexitcount at the end of a function like the MEXITCOUNT macro does,
77 * but gcc currently generates calls to it at the start of the epilogue to
78 * avoid problems with -fpic.
79 *
80 * [.]mcount and __mcount may clobber the call-used registers and %ef.
81 * [.]mexitcount may clobber %ecx and %ef.
82 *
83 * Cross-jumping makes non-statistical profiling timing more complicated.
84 * It is handled in many cases by calling [.]mexitcount before jumping. It
85 * is handled for conditional jumps using CROSSJUMP() and CROSSJUMP_LABEL().
86 * It is handled for some fault-handling jumps by not sharing the exit
87 * routine.
88 *
89 * ALTENTRY() must be before a corresponding ENTRY() so that it can jump to
90 * the main entry point. Note that alt entries are counted twice. They
91 * have to be counted as ordinary entries for gprof to get the call times
92 * right for the ordinary entries.
93 *
94 * High local labels are used in macros to avoid clashes with local labels
95 * in functions.
96 *
97 * Ordinary `ret' is used instead of a macro `RET' because there are a lot
98 * of `ret's. 0xc3 is the opcode for `ret' (`#define ret ... ret' can't
99 * be used because this file is sometimes preprocessed in traditional mode).
100 * `ret' clobbers eflags but this doesn't matter.
101 */
102#define ALTENTRY(name) GEN_ENTRY(name) ; MCOUNT ; MEXITCOUNT ; jmp 9f
103#define CROSSJUMP(jtrue, label, jfalse) \
104 jfalse 8f; MEXITCOUNT; jmp __CONCAT(to,label); 8:
105#define CROSSJUMPTARGET(label) \
106 ALIGN_TEXT; __CONCAT(to,label): ; MCOUNT; jmp label
107#define ENTRY(name) GEN_ENTRY(name) ; 9: ; MCOUNT
108#define FAKE_MCOUNT(caller) pushq caller ; call __mcount ; popq %rcx
109#define MCOUNT call __mcount
110#define MCOUNT_LABEL(name) GEN_ENTRY(name) ; nop ; ALIGN_TEXT
111#ifdef GUPROF
112#define MEXITCOUNT call .mexitcount
113#define ret MEXITCOUNT ; NON_GPROF_RET
114#else
115#define MEXITCOUNT
116#endif
117
118#else /* !GPROF */
119/*
120 * ALTENTRY() has to align because it is before a corresponding ENTRY().
121 * ENTRY() has to align to because there may be no ALTENTRY() before it.
122 * If there is a previous ALTENTRY() then the alignment code for ENTRY()
123 * is empty.
124 */
125#define ALTENTRY(name) GEN_ENTRY(name)
126#define CROSSJUMP(jtrue, label, jfalse) jtrue label
127#define CROSSJUMPTARGET(label)
128#define ENTRY(name) GEN_ENTRY(name)
129#define FAKE_MCOUNT(caller)
130#define MCOUNT
131#define MCOUNT_LABEL(name)
132#define MEXITCOUNT
133#endif /* GPROF */
134
135#ifdef LOCORE
136/*
137 * Convenience macro for declaring interrupt entry points.
138 */
139#define IDTVEC(name) ALIGN_TEXT; .globl __CONCAT(X,name); \
140 .type __CONCAT(X,name),@function; __CONCAT(X,name):
141
142/*
143 * Macros to create and destroy a trap frame.
144 */
89ffa1cf
SS
145#define PUSH_FRAME_REGS \
146 movq %rdi,TF_RDI(%rsp) ; \
d7f50089
YY
147 movq %rsi,TF_RSI(%rsp) ; \
148 movq %rdx,TF_RDX(%rsp) ; \
149 movq %rcx,TF_RCX(%rsp) ; \
150 movq %r8,TF_R8(%rsp) ; \
151 movq %r9,TF_R9(%rsp) ; \
152 movq %rax,TF_RAX(%rsp) ; \
153 movq %rbx,TF_RBX(%rsp) ; \
154 movq %rbp,TF_RBP(%rsp) ; \
155 movq %r10,TF_R10(%rsp) ; \
156 movq %r11,TF_R11(%rsp) ; \
157 movq %r12,TF_R12(%rsp) ; \
158 movq %r13,TF_R13(%rsp) ; \
159 movq %r14,TF_R14(%rsp) ; \
160 movq %r15,TF_R15(%rsp)
161
89ffa1cf
SS
162#define PUSH_FRAME \
163 subq $TF_RIP,%rsp ; /* extend hardware frame to trapframe */ \
164 testb $SEL_RPL_MASK,TF_CS(%rsp) ; /* come from kernel? */ \
165 jz 1f ; /* Yes, dont swapgs again */ \
166 swapgs ; \
1671: \
168 PUSH_FRAME_REGS \
169
170#define PUSH_FRAME_NOSWAP \
171 subq $TF_RIP,%rsp ; /* extend hardware frame to trapframe */ \
172 PUSH_FRAME_REGS \
173
d7f50089
YY
174#define POP_FRAME \
175 movq TF_RDI(%rsp),%rdi ; \
176 movq TF_RSI(%rsp),%rsi ; \
177 movq TF_RDX(%rsp),%rdx ; \
178 movq TF_RCX(%rsp),%rcx ; \
179 movq TF_R8(%rsp),%r8 ; \
180 movq TF_R9(%rsp),%r9 ; \
181 movq TF_RAX(%rsp),%rax ; \
182 movq TF_RBX(%rsp),%rbx ; \
183 movq TF_RBP(%rsp),%rbp ; \
184 movq TF_R10(%rsp),%r10 ; \
185 movq TF_R11(%rsp),%r11 ; \
186 movq TF_R12(%rsp),%r12 ; \
187 movq TF_R13(%rsp),%r13 ; \
188 movq TF_R14(%rsp),%r14 ; \
189 movq TF_R15(%rsp),%r15 ; \
190 testb $SEL_RPL_MASK,TF_CS(%rsp) ; /* come from kernel? */ \
191 jz 1f ; /* keep kernel GS.base */ \
192 cli ; \
193 swapgs ; \
1941: addq $TF_RIP,%rsp /* skip over tf_err, tf_trapno */
195
196/*
197 * Access per-CPU data.
198 */
199#define PCPU(member) %gs:gd_ ## member
200#define PCPU_ADDR(member, reg) \
201 movq %gs:PC_PRVSPACE, reg ; \
202 addq $PC_ ## member, reg
203
204#endif /* LOCORE */
205
206#endif /* !_CPU_ASMACROS_H_ */