asm_support_x86_64.S revision bfa5eb6e8d15ea73a36f8df449630f285a91e995 
1/*
2 * Copyright (C) 2013 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ART_RUNTIME_ARCH_X86_64_ASM_SUPPORT_X86_64_S_
18#define ART_RUNTIME_ARCH_X86_64_ASM_SUPPORT_X86_64_S_
19
20#include "asm_support_x86_64.h"
21
22#if defined(__APPLE__) || (defined(__clang__) && (__clang_major__ < 4) && (__clang_minor__ < 5))
23    // Clang's as(1) doesn't let you name macro parameters prior to 3.5.
24    #define MACRO0(macro_name) .macro macro_name
25    #define MACRO1(macro_name, macro_arg1) .macro macro_name
26    #define MACRO2(macro_name, macro_arg1, macro_args2) .macro macro_name
27    #define MACRO3(macro_name, macro_arg1, macro_args2, macro_args3) .macro macro_name
28    #define END_MACRO .endmacro
29
30    // Clang's as(1) uses $0, $1, and so on for macro arguments.
31    #define RAW_VAR(name,index) $index
32    #define VAR(name,index) SYMBOL($index)
33    #define PLT_VAR(name, index) PLT_SYMBOL($index)
34    #define REG_VAR(name,index) %$index
35    #define CALL_MACRO(name,index) $index
36
37    //  The use of $x for arguments mean that literals need to be represented with $$x in macros.
38    #define LITERAL(value) $value
39    #define MACRO_LITERAL(value) $$value
40#else
41    // Regular gas(1) lets you name macro parameters.
42    #define MACRO0(macro_name) .macro macro_name
43    #define MACRO1(macro_name, macro_arg1) .macro macro_name macro_arg1
44    #define MACRO2(macro_name, macro_arg1, macro_arg2) .macro macro_name macro_arg1, macro_arg2
45    #define MACRO3(macro_name, macro_arg1, macro_arg2, macro_arg3) .macro macro_name macro_arg1, macro_arg2, macro_arg3
46    #define END_MACRO .endm
47
48    // Regular gas(1) uses \argument_name for macro arguments.
49    // We need to turn on alternate macro syntax so we can use & instead or the preprocessor
50    // will screw us by inserting a space between the \ and the name. Even in this mode there's
51    // no special meaning to $, so literals are still just $x. The use of altmacro means % is a
52    // special character meaning care needs to be taken when passing registers as macro arguments.
53    .altmacro
54    #define RAW_VAR(name,index) name&
55    #define VAR(name,index) name&
56    #define PLT_VAR(name, index) name&@PLT
57    #define REG_VAR(name,index) %name
58    #define CALL_MACRO(name,index) name&
59
60    #define LITERAL(value) $value
61    #define MACRO_LITERAL(value) $value
62#endif
63
64#if defined(__APPLE__)
65    #define FUNCTION_TYPE(name,index)
66    #define SIZE(name,index)
67#elif defined(__clang__) && (__clang_major__ < 4) && (__clang_minor__ < 5)
68    #define FUNCTION_TYPE(name,index) .type $index, @function
69    #define SIZE(name,index) .size $index, .-$index
70#else
71    #define FUNCTION_TYPE(name,index) .type name&, @function
72    #define SIZE(name,index) .size name, .-name
73#endif
74
75    // CFI support.
76#if !defined(__APPLE__)
77    #define CFI_STARTPROC .cfi_startproc
78    #define CFI_ENDPROC .cfi_endproc
79    #define CFI_ADJUST_CFA_OFFSET(size) .cfi_adjust_cfa_offset size
80    #define CFI_DEF_CFA(reg,size) .cfi_def_cfa reg,size
81    #define CFI_DEF_CFA_REGISTER(reg) .cfi_def_cfa_register reg
82    #define CFI_RESTORE(reg) .cfi_restore reg
83    #define CFI_REL_OFFSET(reg,size) .cfi_rel_offset reg,size
84#else
85    // Mac OS' doesn't like cfi_* directives.
86    #define CFI_STARTPROC
87    #define CFI_ENDPROC
88    #define CFI_ADJUST_CFA_OFFSET(size)
89    #define CFI_DEF_CFA(reg,size)
90    #define CFI_DEF_CFA_REGISTER(reg)
91    #define CFI_RESTORE(reg)
92    #define CFI_REL_OFFSET(reg,size)
93#endif
94
95    // Symbols.
96#if !defined(__APPLE__)
97    #define SYMBOL(name) name
98    #if defined(__clang__) && (__clang_major__ < 4) && (__clang_minor__ < 5)
99        // TODO: Disabled for old clang 3.3, this leads to text relocations and there should be a
100        // better fix.
101        #define PLT_SYMBOL(name) name // ## @PLT
102    #else
103        #define PLT_SYMBOL(name) name ## @PLT
104    #endif
105#else
106    #define SYMBOL(name) _ ## name
107    #define PLT_SYMBOL(name) _ ## name
108#endif
109
110// Directive to hide a function symbol.
111#if defined(__APPLE__)
112    #define ASM_HIDDEN .private_extern
113#else
114    #define ASM_HIDDEN .hidden
115#endif
116
117    /* Cache alignment for function entry */
118MACRO0(ALIGN_FUNCTION_ENTRY)
119    .balign 16
120END_MACRO
121
122// TODO: we might need to use SYMBOL() here to add the underscore prefix
123// for mac builds.
124MACRO1(DEFINE_FUNCTION, c_name)
125    FUNCTION_TYPE(\c_name, 0)
126    ASM_HIDDEN VAR(c_name, 0)
127    .globl VAR(c_name, 0)
128    ALIGN_FUNCTION_ENTRY
129VAR(c_name, 0):
130    CFI_STARTPROC
131    // Ensure we get a sane starting CFA.
132    CFI_DEF_CFA(rsp, 8)
133END_MACRO
134
135MACRO1(END_FUNCTION, c_name)
136    CFI_ENDPROC
137    SIZE(\c_name, 0)
138END_MACRO
139
140MACRO1(PUSH, reg)
141    pushq REG_VAR(reg, 0)
142    CFI_ADJUST_CFA_OFFSET(8)
143    CFI_REL_OFFSET(REG_VAR(reg, 0), 0)
144END_MACRO
145
146MACRO1(POP, reg)
147    popq REG_VAR(reg,0)
148    CFI_ADJUST_CFA_OFFSET(-8)
149    CFI_RESTORE(REG_VAR(reg,0))
150END_MACRO
151
152MACRO1(UNIMPLEMENTED,name)
153    FUNCTION_TYPE(\name, 0)
154    ASM_HIDDEN VAR(c_name, 0)
155    .globl VAR(name, 0)
156    ALIGN_FUNCTION_ENTRY
157VAR(name, 0):
158    CFI_STARTPROC
159    int3
160    int3
161    CFI_ENDPROC
162    SIZE(\name, 0)
163END_MACRO
164
165MACRO0(UNREACHABLE)
166    int3
167END_MACRO
168
169MACRO0(UNTESTED)
170    int3
171END_MACRO
172
173// Macros to poison (negate) the reference for heap poisoning.
174MACRO1(POISON_HEAP_REF, rRef)
175#ifdef USE_HEAP_POISONING
176    negl REG_VAR(rRef, 0)
177#endif  // USE_HEAP_POISONING
178END_MACRO
179
180// Macros to unpoison (negate) the reference for heap poisoning.
181MACRO1(UNPOISON_HEAP_REF, rRef)
182#ifdef USE_HEAP_POISONING
183    negl REG_VAR(rRef, 0)
184#endif  // USE_HEAP_POISONING
185END_MACRO
186
187#endif  // ART_RUNTIME_ARCH_X86_64_ASM_SUPPORT_X86_64_S_
188