quick_entrypoints_arm64.S revision fbc75db230ff393ea1d0f2dcacd7a6fb71556cce
1/*
2 * Copyright (C) 2014 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#include "asm_support_arm64.S"
18
19#include "arch/quick_alloc_entrypoints.S"
20
21
22.macro INCREASE_FRAME frame_adjustment
23    sub sp, sp, #(\frame_adjustment)
24    .cfi_adjust_cfa_offset (\frame_adjustment)
25.endm
26
27.macro DECREASE_FRAME frame_adjustment
28    add sp, sp, #(\frame_adjustment)
29    .cfi_adjust_cfa_offset -(\frame_adjustment)
30.endm
31
32.macro SAVE_REG reg, offset
33    str \reg, [sp, #(\offset)]
34    .cfi_rel_offset \reg, (\offset)
35.endm
36
37.macro RESTORE_REG reg, offset
38    ldr \reg, [sp, #(\offset)]
39    .cfi_restore \reg
40.endm
41
42.macro SAVE_TWO_REGS reg1, reg2, offset
43    stp \reg1, \reg2, [sp, #(\offset)]
44    .cfi_rel_offset \reg1, (\offset)
45    .cfi_rel_offset \reg2, (\offset) + 8
46.endm
47
48.macro RESTORE_TWO_REGS reg1, reg2, offset
49    ldp \reg1, \reg2, [sp, #(\offset)]
50    .cfi_restore \reg1
51    .cfi_restore \reg2
52.endm
53
54.macro SAVE_TWO_REGS_INCREASE_FRAME reg1, reg2, frame_adjustment
55    stp \reg1, \reg2, [sp, #-(\frame_adjustment)]!
56    .cfi_adjust_cfa_offset (\frame_adjustment)
57    .cfi_rel_offset \reg1, 0
58    .cfi_rel_offset \reg2, 8
59.endm
60
61.macro RESTORE_TWO_REGS_DECREASE_FRAME reg1, reg2, frame_adjustment
62    ldp \reg1, \reg2, [sp], #(\frame_adjustment)
63    .cfi_restore \reg1
64    .cfi_restore \reg2
65    .cfi_adjust_cfa_offset -(\frame_adjustment)
66.endm
67
68    /*
69     * Macro that sets up the callee save frame to conform with
70     * Runtime::CreateCalleeSaveMethod(kSaveAllCalleeSaves)
71     */
72.macro SETUP_SAVE_ALL_CALLEE_SAVES_FRAME
73    // art::Runtime** xIP0 = &art::Runtime::instance_
74    adrp xIP0, :got:_ZN3art7Runtime9instance_E
75    ldr xIP0, [xIP0, #:got_lo12:_ZN3art7Runtime9instance_E]
76
77    // Our registers aren't intermixed - just spill in order.
78    ldr xIP0, [xIP0]  // art::Runtime* xIP0 = art::Runtime::instance_;
79
80    // ArtMethod* xIP0 = Runtime::instance_->callee_save_methods_[kSaveAllCalleeSaves];
81    ldr xIP0, [xIP0, RUNTIME_SAVE_ALL_CALLEE_SAVES_METHOD_OFFSET]
82
83    INCREASE_FRAME 176
84
85    // Ugly compile-time check, but we only have the preprocessor.
86#if (FRAME_SIZE_SAVE_ALL_CALLEE_SAVES != 176)
87#error "FRAME_SIZE_SAVE_ALL_CALLEE_SAVES(ARM64) size not as expected."
88#endif
89
90    // Stack alignment filler [sp, #8].
91    // FP callee-saves.
92    stp d8, d9,   [sp, #16]
93    stp d10, d11, [sp, #32]
94    stp d12, d13, [sp, #48]
95    stp d14, d15, [sp, #64]
96
97    // GP callee-saves
98    SAVE_TWO_REGS x19, x20, 80
99    SAVE_TWO_REGS x21, x22, 96
100    SAVE_TWO_REGS x23, x24, 112
101    SAVE_TWO_REGS x25, x26, 128
102    SAVE_TWO_REGS x27, x28, 144
103    SAVE_TWO_REGS x29, xLR, 160
104
105    // Store ArtMethod* Runtime::callee_save_methods_[kSaveAllCalleeSaves].
106    str xIP0, [sp]
107    // Place sp in Thread::Current()->top_quick_frame.
108    mov xIP0, sp
109    str xIP0, [xSELF, # THREAD_TOP_QUICK_FRAME_OFFSET]
110.endm
111
112    /*
113     * Macro that sets up the callee save frame to conform with
114     * Runtime::CreateCalleeSaveMethod(kSaveRefsOnly).
115     */
116.macro SETUP_SAVE_REFS_ONLY_FRAME
117    // art::Runtime** xIP0 = &art::Runtime::instance_
118    adrp xIP0, :got:_ZN3art7Runtime9instance_E
119    ldr xIP0, [xIP0, #:got_lo12:_ZN3art7Runtime9instance_E]
120
121    // Our registers aren't intermixed - just spill in order.
122    ldr xIP0, [xIP0]  // art::Runtime* xIP0 = art::Runtime::instance_;
123
124    // ArtMethod* xIP0 = Runtime::instance_->callee_save_methods_[kSaveRefOnly];
125    ldr xIP0, [xIP0, RUNTIME_SAVE_REFS_ONLY_METHOD_OFFSET]
126
127    INCREASE_FRAME 96
128
129    // Ugly compile-time check, but we only have the preprocessor.
130#if (FRAME_SIZE_SAVE_REFS_ONLY != 96)
131#error "FRAME_SIZE_SAVE_REFS_ONLY(ARM64) size not as expected."
132#endif
133
134    // GP callee-saves.
135    // x20 paired with ArtMethod* - see below.
136    SAVE_TWO_REGS x21, x22, 16
137    SAVE_TWO_REGS x23, x24, 32
138    SAVE_TWO_REGS x25, x26, 48
139    SAVE_TWO_REGS x27, x28, 64
140    SAVE_TWO_REGS x29, xLR, 80
141
142    // Store ArtMethod* Runtime::callee_save_methods_[kSaveRefsOnly].
143    stp xIP0, x20, [sp]
144    .cfi_rel_offset x20, 8
145
146    // Place sp in Thread::Current()->top_quick_frame.
147    mov xIP0, sp
148    str xIP0, [xSELF, # THREAD_TOP_QUICK_FRAME_OFFSET]
149.endm
150
151// TODO: Probably no need to restore registers preserved by aapcs64.
152.macro RESTORE_SAVE_REFS_ONLY_FRAME
153    // Callee-saves.
154    RESTORE_REG x20, 8
155    RESTORE_TWO_REGS x21, x22, 16
156    RESTORE_TWO_REGS x23, x24, 32
157    RESTORE_TWO_REGS x25, x26, 48
158    RESTORE_TWO_REGS x27, x28, 64
159    RESTORE_TWO_REGS x29, xLR, 80
160
161    DECREASE_FRAME 96
162.endm
163
164.macro POP_SAVE_REFS_ONLY_FRAME
165    DECREASE_FRAME 96
166.endm
167
168.macro RESTORE_SAVE_REFS_ONLY_FRAME_AND_RETURN
169    RESTORE_SAVE_REFS_ONLY_FRAME
170    ret
171.endm
172
173
174.macro SETUP_SAVE_REFS_AND_ARGS_FRAME_INTERNAL
175    INCREASE_FRAME 224
176
177    // Ugly compile-time check, but we only have the preprocessor.
178#if (FRAME_SIZE_SAVE_REFS_AND_ARGS != 224)
179#error "FRAME_SIZE_SAVE_REFS_AND_ARGS(ARM64) size not as expected."
180#endif
181
182    // Stack alignment filler [sp, #8].
183    // FP args.
184    stp d0, d1, [sp, #16]
185    stp d2, d3, [sp, #32]
186    stp d4, d5, [sp, #48]
187    stp d6, d7, [sp, #64]
188
189    // Core args.
190    SAVE_TWO_REGS x1, x2, 80
191    SAVE_TWO_REGS x3, x4, 96
192    SAVE_TWO_REGS x5, x6, 112
193
194    // x7, Callee-saves.
195    SAVE_TWO_REGS x7, x20, 128
196    SAVE_TWO_REGS x21, x22, 144
197    SAVE_TWO_REGS x23, x24, 160
198    SAVE_TWO_REGS x25, x26, 176
199    SAVE_TWO_REGS x27, x28, 192
200
201    // x29(callee-save) and LR.
202    SAVE_TWO_REGS x29, xLR, 208
203
204.endm
205
206    /*
207     * Macro that sets up the callee save frame to conform with
208     * Runtime::CreateCalleeSaveMethod(kSaveRefsAndArgs).
209     *
210     * TODO This is probably too conservative - saving FP & LR.
211     */
212.macro SETUP_SAVE_REFS_AND_ARGS_FRAME
213    // art::Runtime** xIP0 = &art::Runtime::instance_
214    adrp xIP0, :got:_ZN3art7Runtime9instance_E
215    ldr xIP0, [xIP0, #:got_lo12:_ZN3art7Runtime9instance_E]
216
217    // Our registers aren't intermixed - just spill in order.
218    ldr xIP0, [xIP0]  // art::Runtime* xIP0 = art::Runtime::instance_;
219
220    // ArtMethod* xIP0 = Runtime::instance_->callee_save_methods_[kSaveRefAndArgs];
221    ldr xIP0, [xIP0, RUNTIME_SAVE_REFS_AND_ARGS_METHOD_OFFSET]
222
223    SETUP_SAVE_REFS_AND_ARGS_FRAME_INTERNAL
224
225    str xIP0, [sp]    // Store ArtMethod* Runtime::callee_save_methods_[kSaveRefsAndArgs].
226    // Place sp in Thread::Current()->top_quick_frame.
227    mov xIP0, sp
228    str xIP0, [xSELF, # THREAD_TOP_QUICK_FRAME_OFFSET]
229.endm
230
231.macro SETUP_SAVE_REFS_AND_ARGS_FRAME_WITH_METHOD_IN_X0
232    SETUP_SAVE_REFS_AND_ARGS_FRAME_INTERNAL
233    str x0, [sp, #0]  // Store ArtMethod* to bottom of stack.
234    // Place sp in Thread::Current()->top_quick_frame.
235    mov xIP0, sp
236    str xIP0, [xSELF, # THREAD_TOP_QUICK_FRAME_OFFSET]
237.endm
238
239// TODO: Probably no need to restore registers preserved by aapcs64.
240.macro RESTORE_SAVE_REFS_AND_ARGS_FRAME
241    // FP args.
242    ldp d0, d1, [sp, #16]
243    ldp d2, d3, [sp, #32]
244    ldp d4, d5, [sp, #48]
245    ldp d6, d7, [sp, #64]
246
247    // Core args.
248    RESTORE_TWO_REGS x1, x2, 80
249    RESTORE_TWO_REGS x3, x4, 96
250    RESTORE_TWO_REGS x5, x6, 112
251
252    // x7, Callee-saves.
253    RESTORE_TWO_REGS x7, x20, 128
254    RESTORE_TWO_REGS x21, x22, 144
255    RESTORE_TWO_REGS x23, x24, 160
256    RESTORE_TWO_REGS x25, x26, 176
257    RESTORE_TWO_REGS x27, x28, 192
258
259    // x29(callee-save) and LR.
260    RESTORE_TWO_REGS x29, xLR, 208
261
262    DECREASE_FRAME 224
263.endm
264
265    /*
266     * Macro that sets up the callee save frame to conform with
267     * Runtime::CreateCalleeSaveMethod(kSaveEverything)
268     * when the SP has already been decremented by FRAME_SIZE_SAVE_EVERYTHING
269     * and saving registers x29 and LR is handled elsewhere.
270     */
271.macro SETUP_SAVE_EVERYTHING_FRAME_DECREMENTED_SP_SKIP_X29_LR
272    // Ugly compile-time check, but we only have the preprocessor.
273#if (FRAME_SIZE_SAVE_EVERYTHING != 512)
274#error "FRAME_SIZE_SAVE_EVERYTHING(ARM64) size not as expected."
275#endif
276
277    // Save FP registers.
278    // For better performance, store d0 and d31 separately, so that all STPs are 16-byte aligned.
279    str d0,       [sp, #8]
280    stp d1, d2,   [sp, #16]
281    stp d3, d4,   [sp, #32]
282    stp d5, d6,   [sp, #48]
283    stp d7, d8,   [sp, #64]
284    stp d9, d10,  [sp, #80]
285    stp d11, d12, [sp, #96]
286    stp d13, d14, [sp, #112]
287    stp d15, d16, [sp, #128]
288    stp d17, d18, [sp, #144]
289    stp d19, d20, [sp, #160]
290    stp d21, d22, [sp, #176]
291    stp d23, d24, [sp, #192]
292    stp d25, d26, [sp, #208]
293    stp d27, d28, [sp, #224]
294    stp d29, d30, [sp, #240]
295    str d31,      [sp, #256]
296
297    // Save core registers.
298    SAVE_REG            x0, 264
299    SAVE_TWO_REGS  x1,  x2, 272
300    SAVE_TWO_REGS  x3,  x4, 288
301    SAVE_TWO_REGS  x5,  x6, 304
302    SAVE_TWO_REGS  x7,  x8, 320
303    SAVE_TWO_REGS  x9, x10, 336
304    SAVE_TWO_REGS x11, x12, 352
305    SAVE_TWO_REGS x13, x14, 368
306    SAVE_TWO_REGS x15, x16, 384
307    SAVE_TWO_REGS x17, x18, 400
308    SAVE_TWO_REGS x19, x20, 416
309    SAVE_TWO_REGS x21, x22, 432
310    SAVE_TWO_REGS x23, x24, 448
311    SAVE_TWO_REGS x25, x26, 464
312    SAVE_TWO_REGS x27, x28, 480
313
314    // art::Runtime** xIP0 = &art::Runtime::instance_
315    adrp xIP0, :got:_ZN3art7Runtime9instance_E
316    ldr xIP0, [xIP0, #:got_lo12:_ZN3art7Runtime9instance_E]
317
318    ldr xIP0, [xIP0]  // art::Runtime* xIP0 = art::Runtime::instance_;
319
320    // ArtMethod* xIP0 = Runtime::instance_->callee_save_methods_[kSaveEverything];
321    ldr xIP0, [xIP0, RUNTIME_SAVE_EVERYTHING_METHOD_OFFSET]
322
323    // Store ArtMethod* Runtime::callee_save_methods_[kSaveEverything].
324    str xIP0, [sp]
325    // Place sp in Thread::Current()->top_quick_frame.
326    mov xIP0, sp
327    str xIP0, [xSELF, # THREAD_TOP_QUICK_FRAME_OFFSET]
328.endm
329
330    /*
331     * Macro that sets up the callee save frame to conform with
332     * Runtime::CreateCalleeSaveMethod(kSaveEverything)
333     */
334.macro SETUP_SAVE_EVERYTHING_FRAME
335    INCREASE_FRAME 512
336    SAVE_TWO_REGS x29, xLR, 496
337    SETUP_SAVE_EVERYTHING_FRAME_DECREMENTED_SP_SKIP_X29_LR
338.endm
339
340.macro RESTORE_SAVE_EVERYTHING_FRAME_KEEP_X0
341    // Restore FP registers.
342    // For better performance, load d0 and d31 separately, so that all LDPs are 16-byte aligned.
343    ldr d0,       [sp, #8]
344    ldp d1, d2,   [sp, #16]
345    ldp d3, d4,   [sp, #32]
346    ldp d5, d6,   [sp, #48]
347    ldp d7, d8,   [sp, #64]
348    ldp d9, d10,  [sp, #80]
349    ldp d11, d12, [sp, #96]
350    ldp d13, d14, [sp, #112]
351    ldp d15, d16, [sp, #128]
352    ldp d17, d18, [sp, #144]
353    ldp d19, d20, [sp, #160]
354    ldp d21, d22, [sp, #176]
355    ldp d23, d24, [sp, #192]
356    ldp d25, d26, [sp, #208]
357    ldp d27, d28, [sp, #224]
358    ldp d29, d30, [sp, #240]
359    ldr d31,      [sp, #256]
360
361    // Restore core registers.
362    RESTORE_TWO_REGS  x1,  x2, 272
363    RESTORE_TWO_REGS  x3,  x4, 288
364    RESTORE_TWO_REGS  x5,  x6, 304
365    RESTORE_TWO_REGS  x7,  x8, 320
366    RESTORE_TWO_REGS  x9, x10, 336
367    RESTORE_TWO_REGS x11, x12, 352
368    RESTORE_TWO_REGS x13, x14, 368
369    RESTORE_TWO_REGS x15, x16, 384
370    RESTORE_TWO_REGS x17, x18, 400
371    RESTORE_TWO_REGS x19, x20, 416
372    RESTORE_TWO_REGS x21, x22, 432
373    RESTORE_TWO_REGS x23, x24, 448
374    RESTORE_TWO_REGS x25, x26, 464
375    RESTORE_TWO_REGS x27, x28, 480
376    RESTORE_TWO_REGS x29, xLR, 496
377
378    DECREASE_FRAME 512
379.endm
380
381.macro RESTORE_SAVE_EVERYTHING_FRAME
382    RESTORE_REG            x0, 264
383    RESTORE_SAVE_EVERYTHING_FRAME_KEEP_X0
384.endm
385
386.macro RETURN_IF_RESULT_IS_ZERO
387    cbnz x0, 1f                // result non-zero branch over
388    ret                        // return
3891:
390.endm
391
392.macro RETURN_IF_RESULT_IS_NON_ZERO
393    cbz x0, 1f                 // result zero branch over
394    ret                        // return
3951:
396.endm
397
398    /*
399     * Macro that calls through to artDeliverPendingExceptionFromCode, where the pending
400     * exception is Thread::Current()->exception_ when the runtime method frame is ready.
401     */
402.macro DELIVER_PENDING_EXCEPTION_FRAME_READY
403    mov x0, xSELF
404
405    // Point of no return.
406    bl artDeliverPendingExceptionFromCode  // artDeliverPendingExceptionFromCode(Thread*)
407    brk 0  // Unreached
408.endm
409
410    /*
411     * Macro that calls through to artDeliverPendingExceptionFromCode, where the pending
412     * exception is Thread::Current()->exception_.
413     */
414.macro DELIVER_PENDING_EXCEPTION
415    SETUP_SAVE_ALL_CALLEE_SAVES_FRAME
416    DELIVER_PENDING_EXCEPTION_FRAME_READY
417.endm
418
419.macro RETURN_OR_DELIVER_PENDING_EXCEPTION_REG reg
420    ldr \reg, [xSELF, # THREAD_EXCEPTION_OFFSET]   // Get exception field.
421    cbnz \reg, 1f
422    ret
4231:
424    DELIVER_PENDING_EXCEPTION
425.endm
426
427.macro RETURN_OR_DELIVER_PENDING_EXCEPTION
428    RETURN_OR_DELIVER_PENDING_EXCEPTION_REG xIP0
429.endm
430
431// Same as above with x1. This is helpful in stubs that want to avoid clobbering another register.
432.macro RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
433    RETURN_OR_DELIVER_PENDING_EXCEPTION_REG x1
434.endm
435
436.macro RETURN_IF_W0_IS_ZERO_OR_DELIVER
437    cbnz w0, 1f                // result non-zero branch over
438    ret                        // return
4391:
440    DELIVER_PENDING_EXCEPTION
441.endm
442
443.macro NO_ARG_RUNTIME_EXCEPTION c_name, cxx_name
444    .extern \cxx_name
445ENTRY \c_name
446    SETUP_SAVE_ALL_CALLEE_SAVES_FRAME // save all registers as basis for long jump context
447    mov x0, xSELF                     // pass Thread::Current
448    bl  \cxx_name                     // \cxx_name(Thread*)
449    brk 0
450END \c_name
451.endm
452
453.macro NO_ARG_RUNTIME_EXCEPTION_SAVE_EVERYTHING c_name, cxx_name
454    .extern \cxx_name
455ENTRY \c_name
456    SETUP_SAVE_EVERYTHING_FRAME       // save all registers as basis for long jump context
457    mov x0, xSELF                     // pass Thread::Current
458    bl  \cxx_name                     // \cxx_name(Thread*)
459    brk 0
460END \c_name
461.endm
462
463.macro ONE_ARG_RUNTIME_EXCEPTION c_name, cxx_name
464    .extern \cxx_name
465ENTRY \c_name
466    SETUP_SAVE_ALL_CALLEE_SAVES_FRAME // save all registers as basis for long jump context.
467    mov x1, xSELF                     // pass Thread::Current.
468    bl  \cxx_name                     // \cxx_name(arg, Thread*).
469    brk 0
470END \c_name
471.endm
472
473.macro TWO_ARG_RUNTIME_EXCEPTION_SAVE_EVERYTHING c_name, cxx_name
474    .extern \cxx_name
475ENTRY \c_name
476    SETUP_SAVE_EVERYTHING_FRAME       // save all registers as basis for long jump context
477    mov x2, xSELF                     // pass Thread::Current
478    bl  \cxx_name                     // \cxx_name(arg1, arg2, Thread*)
479    brk 0
480END \c_name
481.endm
482
483    /*
484     * Called by managed code, saves callee saves and then calls artThrowException
485     * that will place a mock Method* at the bottom of the stack. Arg1 holds the exception.
486     */
487ONE_ARG_RUNTIME_EXCEPTION art_quick_deliver_exception, artDeliverExceptionFromCode
488
489    /*
490     * Called by managed code to create and deliver a NullPointerException.
491     */
492NO_ARG_RUNTIME_EXCEPTION_SAVE_EVERYTHING art_quick_throw_null_pointer_exception, artThrowNullPointerExceptionFromCode
493
494    /*
495     * Call installed by a signal handler to create and deliver a NullPointerException.
496     */
497    .extern art_quick_throw_null_pointer_exception_from_signal
498ENTRY art_quick_throw_null_pointer_exception_from_signal
499    // The fault handler pushes the gc map address, i.e. "return address", to stack
500    // and passes the fault address in LR. So we need to set up the CFI info accordingly.
501    .cfi_def_cfa_offset __SIZEOF_POINTER__
502    .cfi_rel_offset lr, 0
503    // Save all registers as basis for long jump context.
504    INCREASE_FRAME (FRAME_SIZE_SAVE_EVERYTHING - __SIZEOF_POINTER__)
505    SAVE_REG x29, (FRAME_SIZE_SAVE_EVERYTHING - 2 * __SIZEOF_POINTER__)  // LR already saved.
506    SETUP_SAVE_EVERYTHING_FRAME_DECREMENTED_SP_SKIP_X29_LR
507    mov x0, lr                        // pass the fault address stored in LR by the fault handler.
508    mov x1, xSELF                     // pass Thread::Current.
509    bl  artThrowNullPointerExceptionFromSignal  // (arg, Thread*).
510    brk 0
511END art_quick_throw_null_pointer_exception_from_signal
512
513    /*
514     * Called by managed code to create and deliver an ArithmeticException.
515     */
516NO_ARG_RUNTIME_EXCEPTION_SAVE_EVERYTHING art_quick_throw_div_zero, artThrowDivZeroFromCode
517
518    /*
519     * Called by managed code to create and deliver an ArrayIndexOutOfBoundsException. Arg1 holds
520     * index, arg2 holds limit.
521     */
522TWO_ARG_RUNTIME_EXCEPTION_SAVE_EVERYTHING art_quick_throw_array_bounds, artThrowArrayBoundsFromCode
523
524    /*
525     * Called by managed code to create and deliver a StringIndexOutOfBoundsException
526     * as if thrown from a call to String.charAt(). Arg1 holds index, arg2 holds limit.
527     */
528TWO_ARG_RUNTIME_EXCEPTION_SAVE_EVERYTHING art_quick_throw_string_bounds, artThrowStringBoundsFromCode
529
530    /*
531     * Called by managed code to create and deliver a StackOverflowError.
532     */
533NO_ARG_RUNTIME_EXCEPTION art_quick_throw_stack_overflow, artThrowStackOverflowFromCode
534
535    /*
536     * All generated callsites for interface invokes and invocation slow paths will load arguments
537     * as usual - except instead of loading arg0/x0 with the target Method*, arg0/x0 will contain
538     * the method_idx.  This wrapper will save arg1-arg3, and call the appropriate C helper.
539     * NOTE: "this" is first visible argument of the target, and so can be found in arg1/x1.
540     *
541     * The helper will attempt to locate the target and return a 128-bit result in x0/x1 consisting
542     * of the target Method* in x0 and method->code_ in x1.
543     *
544     * If unsuccessful, the helper will return null/????. There will be a pending exception in the
545     * thread and we branch to another stub to deliver it.
546     *
547     * On success this wrapper will restore arguments and *jump* to the target, leaving the lr
548     * pointing back to the original caller.
549     *
550     * Adapted from ARM32 code.
551     *
552     * Clobbers xIP0.
553     */
554.macro INVOKE_TRAMPOLINE_BODY cxx_name
555    .extern \cxx_name
556    SETUP_SAVE_REFS_AND_ARGS_FRAME        // save callee saves in case allocation triggers GC
557    // Helper signature is always
558    // (method_idx, *this_object, *caller_method, *self, sp)
559
560    mov    x2, xSELF                      // pass Thread::Current
561    mov    x3, sp
562    bl     \cxx_name                      // (method_idx, this, Thread*, SP)
563    mov    xIP0, x1                       // save Method*->code_
564    RESTORE_SAVE_REFS_AND_ARGS_FRAME
565    cbz    x0, 1f                         // did we find the target? if not go to exception delivery
566    br     xIP0                           // tail call to target
5671:
568    DELIVER_PENDING_EXCEPTION
569.endm
570.macro INVOKE_TRAMPOLINE c_name, cxx_name
571ENTRY \c_name
572    INVOKE_TRAMPOLINE_BODY \cxx_name
573END \c_name
574.endm
575
576INVOKE_TRAMPOLINE art_quick_invoke_interface_trampoline_with_access_check, artInvokeInterfaceTrampolineWithAccessCheck
577
578INVOKE_TRAMPOLINE art_quick_invoke_static_trampoline_with_access_check, artInvokeStaticTrampolineWithAccessCheck
579INVOKE_TRAMPOLINE art_quick_invoke_direct_trampoline_with_access_check, artInvokeDirectTrampolineWithAccessCheck
580INVOKE_TRAMPOLINE art_quick_invoke_super_trampoline_with_access_check, artInvokeSuperTrampolineWithAccessCheck
581INVOKE_TRAMPOLINE art_quick_invoke_virtual_trampoline_with_access_check, artInvokeVirtualTrampolineWithAccessCheck
582
583
584.macro INVOKE_STUB_CREATE_FRAME
585
586SAVE_SIZE=15*8   // x4, x5, x19, x20, x21, x22, x23, x24, x25, x26, x27, x28, SP, LR, FP saved.
587SAVE_SIZE_AND_METHOD=SAVE_SIZE+8
588
589
590    mov x9, sp                             // Save stack pointer.
591    .cfi_register sp,x9
592
593    add x10, x2, # SAVE_SIZE_AND_METHOD    // calculate size of frame.
594    sub x10, sp, x10                       // Calculate SP position - saves + ArtMethod* + args
595    and x10, x10, # ~0xf                   // Enforce 16 byte stack alignment.
596    mov sp, x10                            // Set new SP.
597
598    sub x10, x9, #SAVE_SIZE                // Calculate new FP (later). Done here as we must move SP
599    .cfi_def_cfa_register x10              // before this.
600    .cfi_adjust_cfa_offset SAVE_SIZE
601
602    str x28, [x10, #112]
603    .cfi_rel_offset x28, 112
604
605    stp x26, x27, [x10, #96]
606    .cfi_rel_offset x26, 96
607    .cfi_rel_offset x27, 104
608
609    stp x24, x25, [x10, #80]
610    .cfi_rel_offset x24, 80
611    .cfi_rel_offset x25, 88
612
613    stp x22, x23, [x10, #64]
614    .cfi_rel_offset x22, 64
615    .cfi_rel_offset x23, 72
616
617    stp x20, x21, [x10, #48]
618    .cfi_rel_offset x20, 48
619    .cfi_rel_offset x21, 56
620
621    stp x9, x19, [x10, #32]                // Save old stack pointer and x19.
622    .cfi_rel_offset sp, 32
623    .cfi_rel_offset x19, 40
624
625    stp x4, x5, [x10, #16]                 // Save result and shorty addresses.
626    .cfi_rel_offset x4, 16
627    .cfi_rel_offset x5, 24
628
629    stp xFP, xLR, [x10]                    // Store LR & FP.
630    .cfi_rel_offset x29, 0
631    .cfi_rel_offset x30, 8
632
633    mov xFP, x10                           // Use xFP now, as it's callee-saved.
634    .cfi_def_cfa_register x29
635    mov xSELF, x3                          // Move thread pointer into SELF register.
636
637    // Copy arguments into stack frame.
638    // Use simple copy routine for now.
639    // 4 bytes per slot.
640    // X1 - source address
641    // W2 - args length
642    // X9 - destination address.
643    // W10 - temporary
644    add x9, sp, #8                         // Destination address is bottom of stack + null.
645
646    // Copy parameters into the stack. Use numeric label as this is a macro and Clang's assembler
647    // does not have unique-id variables.
6481:
649    cmp w2, #0
650    beq 2f
651    sub w2, w2, #4      // Need 65536 bytes of range.
652    ldr w10, [x1, x2]
653    str w10, [x9, x2]
654
655    b 1b
656
6572:
658    // Store null into ArtMethod* at bottom of frame.
659    str xzr, [sp]
660.endm
661
662.macro INVOKE_STUB_CALL_AND_RETURN
663
664    // load method-> METHOD_QUICK_CODE_OFFSET
665    ldr x9, [x0, #ART_METHOD_QUICK_CODE_OFFSET_64]
666    // Branch to method.
667    blr x9
668
669    // Restore return value address and shorty address.
670    ldp x4,x5, [xFP, #16]
671    .cfi_restore x4
672    .cfi_restore x5
673
674    ldr x28, [xFP, #112]
675    .cfi_restore x28
676
677    ldp x26, x27, [xFP, #96]
678    .cfi_restore x26
679    .cfi_restore x27
680
681    ldp x24, x25, [xFP, #80]
682    .cfi_restore x24
683    .cfi_restore x25
684
685    ldp x22, x23, [xFP, #64]
686    .cfi_restore x22
687    .cfi_restore x23
688
689    ldp x20, x21, [xFP, #48]
690    .cfi_restore x20
691    .cfi_restore x21
692
693    // Store result (w0/x0/s0/d0) appropriately, depending on resultType.
694    ldrb w10, [x5]
695
696    // Check the return type and store the correct register into the jvalue in memory.
697    // Use numeric label as this is a macro and Clang's assembler does not have unique-id variables.
698
699    // Don't set anything for a void type.
700    cmp w10, #'V'
701    beq 3f
702
703    // Is it a double?
704    cmp w10, #'D'
705    bne 1f
706    str d0, [x4]
707    b 3f
708
7091:  // Is it a float?
710    cmp w10, #'F'
711    bne 2f
712    str s0, [x4]
713    b 3f
714
7152:  // Just store x0. Doesn't matter if it is 64 or 32 bits.
716    str x0, [x4]
717
7183:  // Finish up.
719    ldp x2, x19, [xFP, #32]   // Restore stack pointer and x19.
720    .cfi_restore x19
721    mov sp, x2
722    .cfi_restore sp
723
724    ldp xFP, xLR, [xFP]    // Restore old frame pointer and link register.
725    .cfi_restore x29
726    .cfi_restore x30
727
728    ret
729
730.endm
731
732
733/*
734 *  extern"C" void art_quick_invoke_stub(ArtMethod *method,   x0
735 *                                       uint32_t  *args,     x1
736 *                                       uint32_t argsize,    w2
737 *                                       Thread *self,        x3
738 *                                       JValue *result,      x4
739 *                                       char   *shorty);     x5
740 *  +----------------------+
741 *  |                      |
742 *  |  C/C++ frame         |
743 *  |       LR''           |
744 *  |       FP''           | <- SP'
745 *  +----------------------+
746 *  +----------------------+
747 *  |        x28           | <- TODO: Remove callee-saves.
748 *  |         :            |
749 *  |        x19           |
750 *  |        SP'           |
751 *  |        X5            |
752 *  |        X4            |        Saved registers
753 *  |        LR'           |
754 *  |        FP'           | <- FP
755 *  +----------------------+
756 *  | uint32_t out[n-1]    |
757 *  |    :      :          |        Outs
758 *  | uint32_t out[0]      |
759 *  | ArtMethod*           | <- SP  value=null
760 *  +----------------------+
761 *
762 * Outgoing registers:
763 *  x0    - Method*
764 *  x1-x7 - integer parameters.
765 *  d0-d7 - Floating point parameters.
766 *  xSELF = self
767 *  SP = & of ArtMethod*
768 *  x1 = "this" pointer.
769 *
770 */
771ENTRY art_quick_invoke_stub
772    // Spill registers as per AACPS64 calling convention.
773    INVOKE_STUB_CREATE_FRAME
774
775    // Fill registers x/w1 to x/w7 and s/d0 to s/d7 with parameters.
776    // Parse the passed shorty to determine which register to load.
777    // Load addresses for routines that load WXSD registers.
778    adr  x11, .LstoreW2
779    adr  x12, .LstoreX2
780    adr  x13, .LstoreS0
781    adr  x14, .LstoreD0
782
783    // Initialize routine offsets to 0 for integers and floats.
784    // x8 for integers, x15 for floating point.
785    mov x8, #0
786    mov x15, #0
787
788    add x10, x5, #1         // Load shorty address, plus one to skip return value.
789    ldr w1, [x9],#4         // Load "this" parameter, and increment arg pointer.
790
791    // Loop to fill registers.
792.LfillRegisters:
793    ldrb w17, [x10], #1       // Load next character in signature, and increment.
794    cbz w17, .LcallFunction   // Exit at end of signature. Shorty 0 terminated.
795
796    cmp  w17, #'F' // is this a float?
797    bne .LisDouble
798
799    cmp x15, # 8*12         // Skip this load if all registers full.
800    beq .Ladvance4
801
802    add x17, x13, x15       // Calculate subroutine to jump to.
803    br  x17
804
805.LisDouble:
806    cmp w17, #'D'           // is this a double?
807    bne .LisLong
808
809    cmp x15, # 8*12         // Skip this load if all registers full.
810    beq .Ladvance8
811
812    add x17, x14, x15       // Calculate subroutine to jump to.
813    br x17
814
815.LisLong:
816    cmp w17, #'J'           // is this a long?
817    bne .LisOther
818
819    cmp x8, # 6*12          // Skip this load if all registers full.
820    beq .Ladvance8
821
822    add x17, x12, x8        // Calculate subroutine to jump to.
823    br x17
824
825.LisOther:                  // Everything else takes one vReg.
826    cmp x8, # 6*12          // Skip this load if all registers full.
827    beq .Ladvance4
828
829    add x17, x11, x8        // Calculate subroutine to jump to.
830    br x17
831
832.Ladvance4:
833    add x9, x9, #4
834    b .LfillRegisters
835
836.Ladvance8:
837    add x9, x9, #8
838    b .LfillRegisters
839
840// Macro for loading a parameter into a register.
841//  counter - the register with offset into these tables
842//  size - the size of the register - 4 or 8 bytes.
843//  register - the name of the register to be loaded.
844.macro LOADREG counter size register return
845    ldr \register , [x9], #\size
846    add \counter, \counter, 12
847    b \return
848.endm
849
850// Store ints.
851.LstoreW2:
852    LOADREG x8 4 w2 .LfillRegisters
853    LOADREG x8 4 w3 .LfillRegisters
854    LOADREG x8 4 w4 .LfillRegisters
855    LOADREG x8 4 w5 .LfillRegisters
856    LOADREG x8 4 w6 .LfillRegisters
857    LOADREG x8 4 w7 .LfillRegisters
858
859// Store longs.
860.LstoreX2:
861    LOADREG x8 8 x2 .LfillRegisters
862    LOADREG x8 8 x3 .LfillRegisters
863    LOADREG x8 8 x4 .LfillRegisters
864    LOADREG x8 8 x5 .LfillRegisters
865    LOADREG x8 8 x6 .LfillRegisters
866    LOADREG x8 8 x7 .LfillRegisters
867
868// Store singles.
869.LstoreS0:
870    LOADREG x15 4 s0 .LfillRegisters
871    LOADREG x15 4 s1 .LfillRegisters
872    LOADREG x15 4 s2 .LfillRegisters
873    LOADREG x15 4 s3 .LfillRegisters
874    LOADREG x15 4 s4 .LfillRegisters
875    LOADREG x15 4 s5 .LfillRegisters
876    LOADREG x15 4 s6 .LfillRegisters
877    LOADREG x15 4 s7 .LfillRegisters
878
879// Store doubles.
880.LstoreD0:
881    LOADREG x15 8 d0 .LfillRegisters
882    LOADREG x15 8 d1 .LfillRegisters
883    LOADREG x15 8 d2 .LfillRegisters
884    LOADREG x15 8 d3 .LfillRegisters
885    LOADREG x15 8 d4 .LfillRegisters
886    LOADREG x15 8 d5 .LfillRegisters
887    LOADREG x15 8 d6 .LfillRegisters
888    LOADREG x15 8 d7 .LfillRegisters
889
890
891.LcallFunction:
892
893    INVOKE_STUB_CALL_AND_RETURN
894
895END art_quick_invoke_stub
896
897/*  extern"C"
898 *     void art_quick_invoke_static_stub(ArtMethod *method,   x0
899 *                                       uint32_t  *args,     x1
900 *                                       uint32_t argsize,    w2
901 *                                       Thread *self,        x3
902 *                                       JValue *result,      x4
903 *                                       char   *shorty);     x5
904 */
905ENTRY art_quick_invoke_static_stub
906    // Spill registers as per AACPS64 calling convention.
907    INVOKE_STUB_CREATE_FRAME
908
909    // Fill registers x/w1 to x/w7 and s/d0 to s/d7 with parameters.
910    // Parse the passed shorty to determine which register to load.
911    // Load addresses for routines that load WXSD registers.
912    adr  x11, .LstoreW1_2
913    adr  x12, .LstoreX1_2
914    adr  x13, .LstoreS0_2
915    adr  x14, .LstoreD0_2
916
917    // Initialize routine offsets to 0 for integers and floats.
918    // x8 for integers, x15 for floating point.
919    mov x8, #0
920    mov x15, #0
921
922    add x10, x5, #1     // Load shorty address, plus one to skip return value.
923
924    // Loop to fill registers.
925.LfillRegisters2:
926    ldrb w17, [x10], #1         // Load next character in signature, and increment.
927    cbz w17, .LcallFunction2    // Exit at end of signature. Shorty 0 terminated.
928
929    cmp  w17, #'F'          // is this a float?
930    bne .LisDouble2
931
932    cmp x15, # 8*12         // Skip this load if all registers full.
933    beq .Ladvance4_2
934
935    add x17, x13, x15       // Calculate subroutine to jump to.
936    br  x17
937
938.LisDouble2:
939    cmp w17, #'D'           // is this a double?
940    bne .LisLong2
941
942    cmp x15, # 8*12         // Skip this load if all registers full.
943    beq .Ladvance8_2
944
945    add x17, x14, x15       // Calculate subroutine to jump to.
946    br x17
947
948.LisLong2:
949    cmp w17, #'J'           // is this a long?
950    bne .LisOther2
951
952    cmp x8, # 7*12          // Skip this load if all registers full.
953    beq .Ladvance8_2
954
955    add x17, x12, x8        // Calculate subroutine to jump to.
956    br x17
957
958.LisOther2:                 // Everything else takes one vReg.
959    cmp x8, # 7*12          // Skip this load if all registers full.
960    beq .Ladvance4_2
961
962    add x17, x11, x8        // Calculate subroutine to jump to.
963    br x17
964
965.Ladvance4_2:
966    add x9, x9, #4
967    b .LfillRegisters2
968
969.Ladvance8_2:
970    add x9, x9, #8
971    b .LfillRegisters2
972
973// Store ints.
974.LstoreW1_2:
975    LOADREG x8 4 w1 .LfillRegisters2
976    LOADREG x8 4 w2 .LfillRegisters2
977    LOADREG x8 4 w3 .LfillRegisters2
978    LOADREG x8 4 w4 .LfillRegisters2
979    LOADREG x8 4 w5 .LfillRegisters2
980    LOADREG x8 4 w6 .LfillRegisters2
981    LOADREG x8 4 w7 .LfillRegisters2
982
983// Store longs.
984.LstoreX1_2:
985    LOADREG x8 8 x1 .LfillRegisters2
986    LOADREG x8 8 x2 .LfillRegisters2
987    LOADREG x8 8 x3 .LfillRegisters2
988    LOADREG x8 8 x4 .LfillRegisters2
989    LOADREG x8 8 x5 .LfillRegisters2
990    LOADREG x8 8 x6 .LfillRegisters2
991    LOADREG x8 8 x7 .LfillRegisters2
992
993// Store singles.
994.LstoreS0_2:
995    LOADREG x15 4 s0 .LfillRegisters2
996    LOADREG x15 4 s1 .LfillRegisters2
997    LOADREG x15 4 s2 .LfillRegisters2
998    LOADREG x15 4 s3 .LfillRegisters2
999    LOADREG x15 4 s4 .LfillRegisters2
1000    LOADREG x15 4 s5 .LfillRegisters2
1001    LOADREG x15 4 s6 .LfillRegisters2
1002    LOADREG x15 4 s7 .LfillRegisters2
1003
1004// Store doubles.
1005.LstoreD0_2:
1006    LOADREG x15 8 d0 .LfillRegisters2
1007    LOADREG x15 8 d1 .LfillRegisters2
1008    LOADREG x15 8 d2 .LfillRegisters2
1009    LOADREG x15 8 d3 .LfillRegisters2
1010    LOADREG x15 8 d4 .LfillRegisters2
1011    LOADREG x15 8 d5 .LfillRegisters2
1012    LOADREG x15 8 d6 .LfillRegisters2
1013    LOADREG x15 8 d7 .LfillRegisters2
1014
1015
1016.LcallFunction2:
1017
1018    INVOKE_STUB_CALL_AND_RETURN
1019
1020END art_quick_invoke_static_stub
1021
1022
1023
1024/*  extern"C" void art_quick_osr_stub(void** stack,                x0
1025 *                                    size_t stack_size_in_bytes,  x1
1026 *                                    const uin8_t* native_pc,     x2
1027 *                                    JValue *result,              x3
1028 *                                    char   *shorty,              x4
1029 *                                    Thread *self)                x5
1030 */
1031ENTRY art_quick_osr_stub
1032SAVE_SIZE=15*8   // x3, x4, x19, x20, x21, x22, x23, x24, x25, x26, x27, x28, SP, LR, FP saved.
1033    mov x9, sp                             // Save stack pointer.
1034    .cfi_register sp,x9
1035
1036    sub x10, sp, # SAVE_SIZE
1037    and x10, x10, # ~0xf                   // Enforce 16 byte stack alignment.
1038    mov sp, x10                            // Set new SP.
1039
1040    str x28, [sp, #112]
1041    stp x26, x27, [sp, #96]
1042    stp x24, x25, [sp, #80]
1043    stp x22, x23, [sp, #64]
1044    stp x20, x21, [sp, #48]
1045    stp x9, x19, [sp, #32]                // Save old stack pointer and x19.
1046    stp x3, x4, [sp, #16]                 // Save result and shorty addresses.
1047    stp xFP, xLR, [sp]                    // Store LR & FP.
1048    mov xSELF, x5                         // Move thread pointer into SELF register.
1049
1050    sub sp, sp, #16
1051    str xzr, [sp]                         // Store null for ArtMethod* slot
1052    // Branch to stub.
1053    bl .Losr_entry
1054    add sp, sp, #16
1055
1056    // Restore return value address and shorty address.
1057    ldp x3,x4, [sp, #16]
1058    ldr x28, [sp, #112]
1059    ldp x26, x27, [sp, #96]
1060    ldp x24, x25, [sp, #80]
1061    ldp x22, x23, [sp, #64]
1062    ldp x20, x21, [sp, #48]
1063
1064    // Store result (w0/x0/s0/d0) appropriately, depending on resultType.
1065    ldrb w10, [x4]
1066
1067    // Check the return type and store the correct register into the jvalue in memory.
1068
1069    // Don't set anything for a void type.
1070    cmp w10, #'V'
1071    beq .Losr_exit
1072
1073    // Is it a double?
1074    cmp w10, #'D'
1075    bne .Lno_double
1076    str d0, [x3]
1077    b .Losr_exit
1078
1079.Lno_double:  // Is it a float?
1080    cmp w10, #'F'
1081    bne .Lno_float
1082    str s0, [x3]
1083    b .Losr_exit
1084
1085.Lno_float:  // Just store x0. Doesn't matter if it is 64 or 32 bits.
1086    str x0, [x3]
1087
1088.Losr_exit:  // Finish up.
1089    ldp x2, x19, [sp, #32]   // Restore stack pointer and x19.
1090    ldp xFP, xLR, [sp]    // Restore old frame pointer and link register.
1091    mov sp, x2
1092    ret
1093
1094.Losr_entry:
1095    // Update stack pointer for the callee
1096    sub sp, sp, x1
1097
1098    // Update link register slot expected by the callee.
1099    sub w1, w1, #8
1100    str lr, [sp, x1]
1101
1102    // Copy arguments into stack frame.
1103    // Use simple copy routine for now.
1104    // 4 bytes per slot.
1105    // X0 - source address
1106    // W1 - args length
1107    // SP - destination address.
1108    // W10 - temporary
1109.Losr_loop_entry:
1110    cmp w1, #0
1111    beq .Losr_loop_exit
1112    sub w1, w1, #4
1113    ldr w10, [x0, x1]
1114    str w10, [sp, x1]
1115    b .Losr_loop_entry
1116
1117.Losr_loop_exit:
1118    // Branch to the OSR entry point.
1119    br x2
1120
1121END art_quick_osr_stub
1122
1123    /*
1124     * On entry x0 is uintptr_t* gprs_ and x1 is uint64_t* fprs_
1125     */
1126
1127ENTRY art_quick_do_long_jump
1128    // Load FPRs
1129    ldp d0, d1, [x1], #16
1130    ldp d2, d3, [x1], #16
1131    ldp d4, d5, [x1], #16
1132    ldp d6, d7, [x1], #16
1133    ldp d8, d9, [x1], #16
1134    ldp d10, d11, [x1], #16
1135    ldp d12, d13, [x1], #16
1136    ldp d14, d15, [x1], #16
1137    ldp d16, d17, [x1], #16
1138    ldp d18, d19, [x1], #16
1139    ldp d20, d21, [x1], #16
1140    ldp d22, d23, [x1], #16
1141    ldp d24, d25, [x1], #16
1142    ldp d26, d27, [x1], #16
1143    ldp d28, d29, [x1], #16
1144    ldp d30, d31, [x1]
1145
1146    // Load GPRs
1147    // TODO: lots of those are smashed, could optimize.
1148    add x0, x0, #30*8
1149    ldp x30, x1, [x0], #-16          // LR & SP
1150    ldp x28, x29, [x0], #-16
1151    ldp x26, x27, [x0], #-16
1152    ldp x24, x25, [x0], #-16
1153    ldp x22, x23, [x0], #-16
1154    ldp x20, x21, [x0], #-16
1155    ldp x18, x19, [x0], #-16
1156    ldp x16, x17, [x0], #-16
1157    ldp x14, x15, [x0], #-16
1158    ldp x12, x13, [x0], #-16
1159    ldp x10, x11, [x0], #-16
1160    ldp x8, x9, [x0], #-16
1161    ldp x6, x7, [x0], #-16
1162    ldp x4, x5, [x0], #-16
1163    ldp x2, x3, [x0], #-16
1164    mov sp, x1
1165
1166    // Need to load PC, it's at the end (after the space for the unused XZR). Use x1.
1167    ldr x1, [x0, #33*8]
1168    // And the value of x0.
1169    ldr x0, [x0]
1170
1171    br  x1
1172END art_quick_do_long_jump
1173
1174    /*
1175     * Entry from managed code that calls artLockObjectFromCode, may block for GC. x0 holds the
1176     * possibly null object to lock.
1177     *
1178     * Derived from arm32 code.
1179     */
1180    .extern artLockObjectFromCode
1181ENTRY art_quick_lock_object
1182    cbz    w0, .Lslow_lock
1183    add    x4, x0, #MIRROR_OBJECT_LOCK_WORD_OFFSET  // exclusive load/store has no immediate anymore
1184.Lretry_lock:
1185    ldr    w2, [xSELF, #THREAD_ID_OFFSET] // TODO: Can the thread ID really change during the loop?
1186    ldxr   w1, [x4]
1187    mov    x3, x1
1188    and    w3, w3, #LOCK_WORD_GC_STATE_MASK_SHIFTED_TOGGLED  // zero the gc bits
1189    cbnz   w3, .Lnot_unlocked         // already thin locked
1190    // unlocked case - x1: original lock word that's zero except for the read barrier bits.
1191    orr    x2, x1, x2                 // x2 holds thread id with count of 0 with preserved read barrier bits
1192    stxr   w3, w2, [x4]
1193    cbnz   w3, .Llock_stxr_fail       // store failed, retry
1194    dmb    ishld                      // full (LoadLoad|LoadStore) memory barrier
1195    ret
1196.Lnot_unlocked:  // x1: original lock word
1197    lsr    w3, w1, LOCK_WORD_STATE_SHIFT
1198    cbnz   w3, .Lslow_lock            // if either of the top two bits are set, go slow path
1199    eor    w2, w1, w2                 // lock_word.ThreadId() ^ self->ThreadId()
1200    uxth   w2, w2                     // zero top 16 bits
1201    cbnz   w2, .Lslow_lock            // lock word and self thread id's match -> recursive lock
1202                                      // else contention, go to slow path
1203    mov    x3, x1                     // copy the lock word to check count overflow.
1204    and    w3, w3, #LOCK_WORD_GC_STATE_MASK_SHIFTED_TOGGLED  // zero the gc bits.
1205    add    w2, w3, #LOCK_WORD_THIN_LOCK_COUNT_ONE  // increment count in lock word placing in w2 to check overflow
1206    lsr    w3, w2, #LOCK_WORD_GC_STATE_SHIFT     // if the first gc state bit is set, we overflowed.
1207    cbnz   w3, .Lslow_lock            // if we overflow the count go slow path
1208    add    w2, w1, #LOCK_WORD_THIN_LOCK_COUNT_ONE  // increment count for real
1209    stxr   w3, w2, [x4]
1210    cbnz   w3, .Llock_stxr_fail       // store failed, retry
1211    ret
1212.Llock_stxr_fail:
1213    b      .Lretry_lock               // retry
1214.Lslow_lock:
1215    SETUP_SAVE_REFS_ONLY_FRAME        // save callee saves in case we block
1216    mov    x1, xSELF                  // pass Thread::Current
1217    bl     artLockObjectFromCode      // (Object* obj, Thread*)
1218    RESTORE_SAVE_REFS_ONLY_FRAME
1219    RETURN_IF_W0_IS_ZERO_OR_DELIVER
1220END art_quick_lock_object
1221
1222ENTRY art_quick_lock_object_no_inline
1223    SETUP_SAVE_REFS_ONLY_FRAME        // save callee saves in case we block
1224    mov    x1, xSELF                  // pass Thread::Current
1225    bl     artLockObjectFromCode      // (Object* obj, Thread*)
1226    RESTORE_SAVE_REFS_ONLY_FRAME
1227    RETURN_IF_W0_IS_ZERO_OR_DELIVER
1228END art_quick_lock_object_no_inline
1229
1230    /*
1231     * Entry from managed code that calls artUnlockObjectFromCode and delivers exception on failure.
1232     * x0 holds the possibly null object to lock.
1233     *
1234     * Derived from arm32 code.
1235     */
1236    .extern artUnlockObjectFromCode
1237ENTRY art_quick_unlock_object
1238    cbz    x0, .Lslow_unlock
1239    add    x4, x0, #MIRROR_OBJECT_LOCK_WORD_OFFSET  // exclusive load/store has no immediate anymore
1240.Lretry_unlock:
1241#ifndef USE_READ_BARRIER
1242    ldr    w1, [x4]
1243#else
1244    ldxr   w1, [x4]                   // Need to use atomic instructions for read barrier
1245#endif
1246    lsr    w2, w1, LOCK_WORD_STATE_SHIFT
1247    cbnz   w2, .Lslow_unlock          // if either of the top two bits are set, go slow path
1248    ldr    w2, [xSELF, #THREAD_ID_OFFSET]
1249    mov    x3, x1                     // copy lock word to check thread id equality
1250    and    w3, w3, #LOCK_WORD_GC_STATE_MASK_SHIFTED_TOGGLED  // zero the gc bits
1251    eor    w3, w3, w2                 // lock_word.ThreadId() ^ self->ThreadId()
1252    uxth   w3, w3                     // zero top 16 bits
1253    cbnz   w3, .Lslow_unlock          // do lock word and self thread id's match?
1254    mov    x3, x1                     // copy lock word to detect transition to unlocked
1255    and    w3, w3, #LOCK_WORD_GC_STATE_MASK_SHIFTED_TOGGLED  // zero the gc bits
1256    cmp    w3, #LOCK_WORD_THIN_LOCK_COUNT_ONE
1257    bpl    .Lrecursive_thin_unlock
1258    // transition to unlocked
1259    mov    x3, x1
1260    and    w3, w3, #LOCK_WORD_GC_STATE_MASK_SHIFTED  // w3: zero except for the preserved read barrier bits
1261    dmb    ish                        // full (LoadStore|StoreStore) memory barrier
1262#ifndef USE_READ_BARRIER
1263    str    w3, [x4]
1264#else
1265    stxr   w2, w3, [x4]               // Need to use atomic instructions for read barrier
1266    cbnz   w2, .Lunlock_stxr_fail     // store failed, retry
1267#endif
1268    ret
1269.Lrecursive_thin_unlock:  // w1: original lock word
1270    sub    w1, w1, #LOCK_WORD_THIN_LOCK_COUNT_ONE  // decrement count
1271#ifndef USE_READ_BARRIER
1272    str    w1, [x4]
1273#else
1274    stxr   w2, w1, [x4]               // Need to use atomic instructions for read barrier
1275    cbnz   w2, .Lunlock_stxr_fail     // store failed, retry
1276#endif
1277    ret
1278.Lunlock_stxr_fail:
1279    b      .Lretry_unlock               // retry
1280.Lslow_unlock:
1281    SETUP_SAVE_REFS_ONLY_FRAME        // save callee saves in case exception allocation triggers GC
1282    mov    x1, xSELF                  // pass Thread::Current
1283    bl     artUnlockObjectFromCode    // (Object* obj, Thread*)
1284    RESTORE_SAVE_REFS_ONLY_FRAME
1285    RETURN_IF_W0_IS_ZERO_OR_DELIVER
1286END art_quick_unlock_object
1287
1288ENTRY art_quick_unlock_object_no_inline
1289    SETUP_SAVE_REFS_ONLY_FRAME        // save callee saves in case exception allocation triggers GC
1290    mov    x1, xSELF                  // pass Thread::Current
1291    bl     artUnlockObjectFromCode    // (Object* obj, Thread*)
1292    RESTORE_SAVE_REFS_ONLY_FRAME
1293    RETURN_IF_W0_IS_ZERO_OR_DELIVER
1294END art_quick_unlock_object_no_inline
1295
1296    /*
1297     * Entry from managed code that calls artInstanceOfFromCode and on failure calls
1298     * artThrowClassCastExceptionForObject.
1299     */
1300    .extern artInstanceOfFromCode
1301    .extern artThrowClassCastExceptionForObject
1302ENTRY art_quick_check_instance_of
1303    // Store arguments and link register
1304    // Stack needs to be 16B aligned on calls.
1305    SAVE_TWO_REGS_INCREASE_FRAME x0, x1, 32
1306    SAVE_REG xLR, 24
1307
1308    // Call runtime code
1309    bl artInstanceOfFromCode
1310
1311    // Check for exception
1312    cbz x0, .Lthrow_class_cast_exception
1313
1314    // Restore and return
1315    .cfi_remember_state
1316    RESTORE_REG xLR, 24
1317    RESTORE_TWO_REGS_DECREASE_FRAME x0, x1, 32
1318    ret
1319    .cfi_restore_state                // Reset unwind info so following code unwinds.
1320
1321.Lthrow_class_cast_exception:
1322    // Restore
1323    RESTORE_REG xLR, 24
1324    RESTORE_TWO_REGS_DECREASE_FRAME x0, x1, 32
1325
1326    SETUP_SAVE_ALL_CALLEE_SAVES_FRAME // save all registers as basis for long jump context
1327    mov x2, xSELF                     // pass Thread::Current
1328    bl artThrowClassCastExceptionForObject     // (Object*, Class*, Thread*)
1329    brk 0                             // We should not return here...
1330END art_quick_check_instance_of
1331
1332// Restore xReg's value from [sp, #offset] if xReg is not the same as xExclude.
1333.macro POP_REG_NE xReg, offset, xExclude
1334    .ifnc \xReg, \xExclude
1335        ldr \xReg, [sp, #\offset]     // restore xReg
1336        .cfi_restore \xReg
1337    .endif
1338.endm
1339
1340// Restore xReg1's value from [sp, #offset] if xReg1 is not the same as xExclude.
1341// Restore xReg2's value from [sp, #(offset + 8)] if xReg2 is not the same as xExclude.
1342.macro POP_REGS_NE xReg1, xReg2, offset, xExclude
1343    .ifc \xReg1, \xExclude
1344        ldr \xReg2, [sp, #(\offset + 8)]        // restore xReg2
1345    .else
1346        .ifc \xReg2, \xExclude
1347            ldr \xReg1, [sp, #\offset]          // restore xReg1
1348        .else
1349            ldp \xReg1, \xReg2, [sp, #\offset]  // restore xReg1 and xReg2
1350        .endif
1351    .endif
1352    .cfi_restore \xReg1
1353    .cfi_restore \xReg2
1354.endm
1355
1356    /*
1357     * Macro to insert read barrier, only used in art_quick_aput_obj.
1358     * xDest, wDest and xObj are registers, offset is a defined literal such as
1359     * MIRROR_OBJECT_CLASS_OFFSET. Dest needs both x and w versions of the same register to handle
1360     * name mismatch between instructions. This macro uses the lower 32b of register when possible.
1361     * TODO: When read barrier has a fast path, add heap unpoisoning support for the fast path.
1362     */
1363.macro READ_BARRIER xDest, wDest, xObj, xTemp, wTemp, offset, number
1364#ifdef USE_READ_BARRIER
1365#ifdef USE_BAKER_READ_BARRIER
1366    ldr \wTemp, [\xObj, #MIRROR_OBJECT_LOCK_WORD_OFFSET]
1367    tbnz \wTemp, #LOCK_WORD_READ_BARRIER_STATE_SHIFT, .Lrb_slowpath\number
1368    // False dependency to avoid needing load/load fence.
1369    add \xObj, \xObj, \xTemp, lsr #32
1370    ldr \wDest, [\xObj, #\offset]   // Heap reference = 32b. This also zero-extends to \xDest.
1371    UNPOISON_HEAP_REF \wDest
1372    b .Lrb_exit\number
1373#endif
1374.Lrb_slowpath\number:
1375    // Store registers used in art_quick_aput_obj (x0-x4, LR), stack is 16B aligned.
1376    SAVE_TWO_REGS_INCREASE_FRAME x0, x1, 48
1377    SAVE_TWO_REGS x2, x3, 16
1378    SAVE_TWO_REGS x4, xLR, 32
1379
1380    // mov x0, \xRef                // pass ref in x0 (no-op for now since parameter ref is unused)
1381    .ifnc \xObj, x1
1382        mov x1, \xObj               // pass xObj
1383    .endif
1384    mov w2, #\offset                // pass offset
1385    bl artReadBarrierSlow           // artReadBarrierSlow(ref, xObj, offset)
1386    // No need to unpoison return value in w0, artReadBarrierSlow() would do the unpoisoning.
1387    .ifnc \wDest, w0
1388        mov \wDest, w0              // save return value in wDest
1389    .endif
1390
1391    // Conditionally restore saved registers
1392    POP_REG_NE x0, 0, \xDest
1393    POP_REG_NE x1, 8, \xDest
1394    POP_REG_NE x2, 16, \xDest
1395    POP_REG_NE x3, 24, \xDest
1396    POP_REG_NE x4, 32, \xDest
1397    RESTORE_REG xLR, 40
1398    DECREASE_FRAME 48
1399.Lrb_exit\number:
1400#else
1401    ldr \wDest, [\xObj, #\offset]   // Heap reference = 32b. This also zero-extends to \xDest.
1402    UNPOISON_HEAP_REF \wDest
1403#endif  // USE_READ_BARRIER
1404.endm
1405
1406    /*
1407     * Entry from managed code for array put operations of objects where the value being stored
1408     * needs to be checked for compatibility.
1409     * x0 = array, x1 = index, x2 = value
1410     *
1411     * Currently all values should fit into w0/w1/w2, and w1 always will as indices are 32b. We
1412     * assume, though, that the upper 32b are zeroed out. At least for x1/w1 we can do better by
1413     * using index-zero-extension in load/stores.
1414     *
1415     * Temporaries: x3, x4
1416     * TODO: x4 OK? ip seems wrong here.
1417     */
1418ENTRY art_quick_aput_obj_with_null_and_bound_check
1419    tst x0, x0
1420    bne art_quick_aput_obj_with_bound_check
1421    b art_quick_throw_null_pointer_exception
1422END art_quick_aput_obj_with_null_and_bound_check
1423
1424ENTRY art_quick_aput_obj_with_bound_check
1425    ldr w3, [x0, #MIRROR_ARRAY_LENGTH_OFFSET]
1426    cmp w3, w1
1427    bhi art_quick_aput_obj
1428    mov x0, x1
1429    mov x1, x3
1430    b art_quick_throw_array_bounds
1431END art_quick_aput_obj_with_bound_check
1432
1433#ifdef USE_READ_BARRIER
1434    .extern artReadBarrierSlow
1435#endif
1436ENTRY art_quick_aput_obj
1437    cbz x2, .Ldo_aput_null
1438    READ_BARRIER x3, w3, x0, x3, w3, MIRROR_OBJECT_CLASS_OFFSET, 0  // Heap reference = 32b
1439                                                                    // This also zero-extends to x3
1440    READ_BARRIER x3, w3, x3, x4, w4, MIRROR_CLASS_COMPONENT_TYPE_OFFSET, 1 // Heap reference = 32b
1441    // This also zero-extends to x3
1442    READ_BARRIER x4, w4, x2, x4, w4, MIRROR_OBJECT_CLASS_OFFSET, 2  // Heap reference = 32b
1443                                                                    // This also zero-extends to x4
1444    cmp w3, w4  // value's type == array's component type - trivial assignability
1445    bne .Lcheck_assignability
1446.Ldo_aput:
1447    add x3, x0, #MIRROR_OBJECT_ARRAY_DATA_OFFSET
1448                                                         // "Compress" = do nothing
1449    POISON_HEAP_REF w2
1450    str w2, [x3, x1, lsl #2]                             // Heap reference = 32b
1451    ldr x3, [xSELF, #THREAD_CARD_TABLE_OFFSET]
1452    lsr x0, x0, #7
1453    strb w3, [x3, x0]
1454    ret
1455.Ldo_aput_null:
1456    add x3, x0, #MIRROR_OBJECT_ARRAY_DATA_OFFSET
1457                                                         // "Compress" = do nothing
1458    str w2, [x3, x1, lsl #2]                             // Heap reference = 32b
1459    ret
1460.Lcheck_assignability:
1461    // Store arguments and link register
1462    SAVE_TWO_REGS_INCREASE_FRAME x0, x1, 32
1463    SAVE_TWO_REGS x2, xLR, 16
1464
1465    // Call runtime code
1466    mov x0, x3              // Heap reference, 32b, "uncompress" = do nothing, already zero-extended
1467    mov x1, x4              // Heap reference, 32b, "uncompress" = do nothing, already zero-extended
1468    bl artIsAssignableFromCode
1469
1470    // Check for exception
1471    cbz x0, .Lthrow_array_store_exception
1472
1473    // Restore
1474    .cfi_remember_state
1475    RESTORE_TWO_REGS x2, xLR, 16
1476    RESTORE_TWO_REGS_DECREASE_FRAME x0, x1, 32
1477
1478    add x3, x0, #MIRROR_OBJECT_ARRAY_DATA_OFFSET
1479                                                          // "Compress" = do nothing
1480    POISON_HEAP_REF w2
1481    str w2, [x3, x1, lsl #2]                              // Heap reference = 32b
1482    ldr x3, [xSELF, #THREAD_CARD_TABLE_OFFSET]
1483    lsr x0, x0, #7
1484    strb w3, [x3, x0]
1485    ret
1486    .cfi_restore_state            // Reset unwind info so following code unwinds.
1487.Lthrow_array_store_exception:
1488    RESTORE_TWO_REGS x2, xLR, 16
1489    RESTORE_TWO_REGS_DECREASE_FRAME x0, x1, 32
1490
1491    SETUP_SAVE_ALL_CALLEE_SAVES_FRAME
1492    mov x1, x2                      // Pass value.
1493    mov x2, xSELF                   // Pass Thread::Current.
1494    bl artThrowArrayStoreException  // (Object*, Object*, Thread*).
1495    brk 0                           // Unreached.
1496END art_quick_aput_obj
1497
1498// Macro to facilitate adding new allocation entrypoints.
1499.macro ONE_ARG_DOWNCALL name, entrypoint, return
1500    .extern \entrypoint
1501ENTRY \name
1502    SETUP_SAVE_REFS_ONLY_FRAME        // save callee saves in case of GC
1503    mov    x1, xSELF                  // pass Thread::Current
1504    bl     \entrypoint                // (uint32_t type_idx, Method* method, Thread*)
1505    RESTORE_SAVE_REFS_ONLY_FRAME
1506    \return
1507END \name
1508.endm
1509
1510// Macro to facilitate adding new allocation entrypoints.
1511.macro TWO_ARG_DOWNCALL name, entrypoint, return
1512    .extern \entrypoint
1513ENTRY \name
1514    SETUP_SAVE_REFS_ONLY_FRAME        // save callee saves in case of GC
1515    mov    x2, xSELF                  // pass Thread::Current
1516    bl     \entrypoint                // (uint32_t type_idx, Method* method, Thread*)
1517    RESTORE_SAVE_REFS_ONLY_FRAME
1518    \return
1519END \name
1520.endm
1521
1522// Macro to facilitate adding new allocation entrypoints.
1523.macro THREE_ARG_DOWNCALL name, entrypoint, return
1524    .extern \entrypoint
1525ENTRY \name
1526    SETUP_SAVE_REFS_ONLY_FRAME        // save callee saves in case of GC
1527    mov    x3, xSELF                  // pass Thread::Current
1528    bl     \entrypoint
1529    RESTORE_SAVE_REFS_ONLY_FRAME
1530    \return
1531END \name
1532.endm
1533
1534// Macro to facilitate adding new allocation entrypoints.
1535.macro FOUR_ARG_DOWNCALL name, entrypoint, return
1536    .extern \entrypoint
1537ENTRY \name
1538    SETUP_SAVE_REFS_ONLY_FRAME        // save callee saves in case of GC
1539    mov    x4, xSELF                  // pass Thread::Current
1540    bl     \entrypoint                //
1541    RESTORE_SAVE_REFS_ONLY_FRAME
1542    \return
1543    DELIVER_PENDING_EXCEPTION
1544END \name
1545.endm
1546
1547// Macros taking opportunity of code similarities for downcalls with referrer.
1548.macro ONE_ARG_REF_DOWNCALL name, entrypoint, return
1549    .extern \entrypoint
1550ENTRY \name
1551    SETUP_SAVE_REFS_ONLY_FRAME        // save callee saves in case of GC
1552    ldr    x1, [sp, #FRAME_SIZE_SAVE_REFS_ONLY] // Load referrer
1553    mov    x2, xSELF                  // pass Thread::Current
1554    bl     \entrypoint                // (uint32_t type_idx, Method* method, Thread*, SP)
1555    RESTORE_SAVE_REFS_ONLY_FRAME
1556    \return
1557END \name
1558.endm
1559
1560.macro TWO_ARG_REF_DOWNCALL name, entrypoint, return
1561    .extern \entrypoint
1562ENTRY \name
1563    SETUP_SAVE_REFS_ONLY_FRAME        // save callee saves in case of GC
1564    ldr    x2, [sp, #FRAME_SIZE_SAVE_REFS_ONLY] // Load referrer
1565    mov    x3, xSELF                  // pass Thread::Current
1566    bl     \entrypoint
1567    RESTORE_SAVE_REFS_ONLY_FRAME
1568    \return
1569END \name
1570.endm
1571
1572.macro THREE_ARG_REF_DOWNCALL name, entrypoint, return
1573    .extern \entrypoint
1574ENTRY \name
1575    SETUP_SAVE_REFS_ONLY_FRAME        // save callee saves in case of GC
1576    ldr    x3, [sp, #FRAME_SIZE_SAVE_REFS_ONLY] // Load referrer
1577    mov    x4, xSELF                  // pass Thread::Current
1578    bl     \entrypoint
1579    RESTORE_SAVE_REFS_ONLY_FRAME
1580    \return
1581END \name
1582.endm
1583
1584.macro RETURN_IF_RESULT_IS_NON_ZERO_OR_DELIVER
1585    cbz w0, 1f                 // result zero branch over
1586    ret                        // return
15871:
1588    DELIVER_PENDING_EXCEPTION
1589.endm
1590
1591    /*
1592     * Entry from managed code that calls artHandleFillArrayDataFromCode and delivers exception on
1593     * failure.
1594     */
1595TWO_ARG_REF_DOWNCALL art_quick_handle_fill_data, artHandleFillArrayDataFromCode, RETURN_IF_W0_IS_ZERO_OR_DELIVER
1596
1597    /*
1598     * Entry from managed code when uninitialized static storage, this stub will run the class
1599     * initializer and deliver the exception on error. On success the static storage base is
1600     * returned.
1601     */
1602ONE_ARG_DOWNCALL art_quick_initialize_static_storage, artInitializeStaticStorageFromCode, RETURN_IF_RESULT_IS_NON_ZERO_OR_DELIVER
1603
1604ONE_ARG_DOWNCALL art_quick_initialize_type, artInitializeTypeFromCode, RETURN_IF_RESULT_IS_NON_ZERO_OR_DELIVER
1605ONE_ARG_DOWNCALL art_quick_initialize_type_and_verify_access, artInitializeTypeAndVerifyAccessFromCode, RETURN_IF_RESULT_IS_NON_ZERO_OR_DELIVER
1606
1607ONE_ARG_REF_DOWNCALL art_quick_get_boolean_static, artGetBooleanStaticFromCode, RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
1608ONE_ARG_REF_DOWNCALL art_quick_get_byte_static, artGetByteStaticFromCode, RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
1609ONE_ARG_REF_DOWNCALL art_quick_get_char_static, artGetCharStaticFromCode, RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
1610ONE_ARG_REF_DOWNCALL art_quick_get_short_static, artGetShortStaticFromCode, RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
1611ONE_ARG_REF_DOWNCALL art_quick_get32_static, artGet32StaticFromCode, RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
1612ONE_ARG_REF_DOWNCALL art_quick_get64_static, artGet64StaticFromCode, RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
1613ONE_ARG_REF_DOWNCALL art_quick_get_obj_static, artGetObjStaticFromCode, RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
1614
1615TWO_ARG_REF_DOWNCALL art_quick_get_boolean_instance, artGetBooleanInstanceFromCode, RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
1616TWO_ARG_REF_DOWNCALL art_quick_get_byte_instance, artGetByteInstanceFromCode, RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
1617TWO_ARG_REF_DOWNCALL art_quick_get_char_instance, artGetCharInstanceFromCode, RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
1618TWO_ARG_REF_DOWNCALL art_quick_get_short_instance, artGetShortInstanceFromCode, RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
1619TWO_ARG_REF_DOWNCALL art_quick_get32_instance, artGet32InstanceFromCode, RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
1620TWO_ARG_REF_DOWNCALL art_quick_get64_instance, artGet64InstanceFromCode, RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
1621TWO_ARG_REF_DOWNCALL art_quick_get_obj_instance, artGetObjInstanceFromCode, RETURN_OR_DELIVER_PENDING_EXCEPTION_X1
1622
1623TWO_ARG_REF_DOWNCALL art_quick_set8_static, artSet8StaticFromCode, RETURN_IF_W0_IS_ZERO_OR_DELIVER
1624TWO_ARG_REF_DOWNCALL art_quick_set16_static, artSet16StaticFromCode, RETURN_IF_W0_IS_ZERO_OR_DELIVER
1625TWO_ARG_REF_DOWNCALL art_quick_set32_static, artSet32StaticFromCode, RETURN_IF_W0_IS_ZERO_OR_DELIVER
1626TWO_ARG_REF_DOWNCALL art_quick_set_obj_static, artSetObjStaticFromCode, RETURN_IF_W0_IS_ZERO_OR_DELIVER
1627
1628THREE_ARG_REF_DOWNCALL art_quick_set8_instance, artSet8InstanceFromCode, RETURN_IF_W0_IS_ZERO_OR_DELIVER
1629THREE_ARG_REF_DOWNCALL art_quick_set16_instance, artSet16InstanceFromCode, RETURN_IF_W0_IS_ZERO_OR_DELIVER
1630THREE_ARG_REF_DOWNCALL art_quick_set32_instance, artSet32InstanceFromCode, RETURN_IF_W0_IS_ZERO_OR_DELIVER
1631THREE_ARG_REF_DOWNCALL art_quick_set64_instance, artSet64InstanceFromCode, RETURN_IF_W0_IS_ZERO_OR_DELIVER
1632THREE_ARG_REF_DOWNCALL art_quick_set_obj_instance, artSetObjInstanceFromCode, RETURN_IF_W0_IS_ZERO_OR_DELIVER
1633
1634// This is separated out as the argument order is different.
1635    .extern artSet64StaticFromCode
1636ENTRY art_quick_set64_static
1637    SETUP_SAVE_REFS_ONLY_FRAME        // save callee saves in case of GC
1638    ldr    x1, [sp, #FRAME_SIZE_SAVE_REFS_ONLY] // Load referrer
1639                                      // x2 contains the parameter
1640    mov    x3, xSELF                  // pass Thread::Current
1641    bl     artSet64StaticFromCode
1642    RESTORE_SAVE_REFS_ONLY_FRAME
1643    RETURN_IF_W0_IS_ZERO_OR_DELIVER
1644END art_quick_set64_static
1645
1646    /*
1647     * Entry from managed code to resolve a string, this stub will
1648     * check the dex cache for a matching string (the fast path), and if not found,
1649     * it will allocate a String and deliver an exception on error.
1650     * On success the String is returned. R0 holds the string index.
1651     */
1652
1653ENTRY art_quick_resolve_string
1654    SETUP_SAVE_EVERYTHING_FRAME                     // save everything for stack crawl
1655    mov   x1, xSELF                                 // pass Thread::Current
1656    bl    artResolveStringFromCode                  // (int32_t string_idx, Thread* self)
1657    cbz   w0, 1f                                    // If result is null, deliver the OOME.
1658    .cfi_remember_state
1659    RESTORE_SAVE_EVERYTHING_FRAME_KEEP_X0
1660    ret                        // return
1661    .cfi_restore_state
1662    .cfi_def_cfa_offset FRAME_SIZE_SAVE_EVERYTHING  // workaround for clang bug: 31975598
16631:
1664    DELIVER_PENDING_EXCEPTION_FRAME_READY
1665END art_quick_resolve_string
1666
1667// Generate the allocation entrypoints for each allocator.
1668GENERATE_ALLOC_ENTRYPOINTS_FOR_NON_REGION_TLAB_ALLOCATORS
1669// Comment out allocators that have arm64 specific asm.
1670// GENERATE_ALLOC_ENTRYPOINTS_ALLOC_OBJECT(_region_tlab, RegionTLAB) implemented in asm
1671// GENERATE_ALLOC_ENTRYPOINTS_ALLOC_OBJECT_RESOLVED(_region_tlab, RegionTLAB)
1672// GENERATE_ALLOC_ENTRYPOINTS_ALLOC_OBJECT_INITIALIZED(_region_tlab, RegionTLAB)
1673GENERATE_ALLOC_ENTRYPOINTS_ALLOC_OBJECT_WITH_ACCESS_CHECK(_region_tlab, RegionTLAB)
1674// GENERATE_ALLOC_ENTRYPOINTS_ALLOC_ARRAY(_region_tlab, RegionTLAB) implemented in asm
1675// GENERATE_ALLOC_ENTRYPOINTS_ALLOC_ARRAY_RESOLVED(_region_tlab, RegionTLAB)
1676GENERATE_ALLOC_ENTRYPOINTS_ALLOC_ARRAY_WITH_ACCESS_CHECK(_region_tlab, RegionTLAB)
1677GENERATE_ALLOC_ENTRYPOINTS_CHECK_AND_ALLOC_ARRAY(_region_tlab, RegionTLAB)
1678GENERATE_ALLOC_ENTRYPOINTS_CHECK_AND_ALLOC_ARRAY_WITH_ACCESS_CHECK(_region_tlab, RegionTLAB)
1679GENERATE_ALLOC_ENTRYPOINTS_ALLOC_STRING_FROM_BYTES(_region_tlab, RegionTLAB)
1680GENERATE_ALLOC_ENTRYPOINTS_ALLOC_STRING_FROM_CHARS(_region_tlab, RegionTLAB)
1681GENERATE_ALLOC_ENTRYPOINTS_ALLOC_STRING_FROM_STRING(_region_tlab, RegionTLAB)
1682
1683// A hand-written override for GENERATE_ALLOC_ENTRYPOINTS_ALLOC_OBJECT(_rosalloc, RosAlloc).
1684ENTRY art_quick_alloc_object_rosalloc
1685    // Fast path rosalloc allocation.
1686    // x0: type_idx/return value, x1: ArtMethod*, xSELF(x19): Thread::Current
1687    // x2-x7: free.
1688    ldr    x2, [x1, #ART_METHOD_DEX_CACHE_TYPES_OFFSET_64]    // Load dex cache resolved types array
1689                                                              // Load the class (x2)
1690    ldr    w2, [x2, x0, lsl #COMPRESSED_REFERENCE_SIZE_SHIFT]
1691    cbz    x2, .Lart_quick_alloc_object_rosalloc_slow_path    // Check null class
1692    ldr    x3, [xSELF, #THREAD_LOCAL_ALLOC_STACK_TOP_OFFSET]  // Check if the thread local
1693                                                              // allocation stack has room.
1694                                                              // ldp won't work due to large offset.
1695    ldr    x4, [xSELF, #THREAD_LOCAL_ALLOC_STACK_END_OFFSET]
1696    cmp    x3, x4
1697    bhs    .Lart_quick_alloc_object_rosalloc_slow_path
1698    ldr    w3, [x2, #MIRROR_CLASS_OBJECT_SIZE_ALLOC_FAST_PATH_OFFSET]  // Load the object size (x3)
1699    cmp    x3, #ROSALLOC_MAX_THREAD_LOCAL_BRACKET_SIZE        // Check if the size is for a thread
1700                                                              // local allocation. Also does the
1701                                                              // finalizable and initialization
1702                                                              // checks.
1703    bhs    .Lart_quick_alloc_object_rosalloc_slow_path
1704                                                              // Compute the rosalloc bracket index
1705                                                              // from the size. Since the size is
1706                                                              // already aligned we can combine the
1707                                                              // two shifts together.
1708    add    x4, xSELF, x3, lsr #(ROSALLOC_BRACKET_QUANTUM_SIZE_SHIFT - POINTER_SIZE_SHIFT)
1709                                                              // Subtract pointer size since ther
1710                                                              // are no runs for 0 byte allocations
1711                                                              // and the size is already aligned.
1712    ldr    x4, [x4, #(THREAD_ROSALLOC_RUNS_OFFSET - __SIZEOF_POINTER__)]
1713                                                              // Load the free list head (x3). This
1714                                                              // will be the return val.
1715    ldr    x3, [x4, #(ROSALLOC_RUN_FREE_LIST_OFFSET + ROSALLOC_RUN_FREE_LIST_HEAD_OFFSET)]
1716    cbz    x3, .Lart_quick_alloc_object_rosalloc_slow_path
1717    // "Point of no slow path". Won't go to the slow path from here on. OK to clobber x0 and x1.
1718    ldr    x1, [x3, #ROSALLOC_SLOT_NEXT_OFFSET]               // Load the next pointer of the head
1719                                                              // and update the list head with the
1720                                                              // next pointer.
1721    str    x1, [x4, #(ROSALLOC_RUN_FREE_LIST_OFFSET + ROSALLOC_RUN_FREE_LIST_HEAD_OFFSET)]
1722                                                              // Store the class pointer in the
1723                                                              // header. This also overwrites the
1724                                                              // next pointer. The offsets are
1725                                                              // asserted to match.
1726#if ROSALLOC_SLOT_NEXT_OFFSET != MIRROR_OBJECT_CLASS_OFFSET
1727#error "Class pointer needs to overwrite next pointer."
1728#endif
1729    POISON_HEAP_REF w2
1730    str    w2, [x3, #MIRROR_OBJECT_CLASS_OFFSET]
1731                                                              // Fence. This is "ish" not "ishst" so
1732                                                              // that it also ensures ordering of
1733                                                              // the object size load with respect
1734                                                              // to later accesses to the class
1735                                                              // object. Alternatively we could use
1736                                                              // "ishst" if we use load-acquire for
1737                                                              // the class status load.
1738                                                              // Needs to be done before pushing on
1739                                                              // allocation since Heap::VisitObjects
1740                                                              // relies on seeing the class pointer.
1741                                                              // b/28790624
1742    dmb    ish
1743                                                              // Push the new object onto the thread
1744                                                              // local allocation stack and
1745                                                              // increment the thread local
1746                                                              // allocation stack top.
1747    ldr    x1, [xSELF, #THREAD_LOCAL_ALLOC_STACK_TOP_OFFSET]
1748    str    w3, [x1], #COMPRESSED_REFERENCE_SIZE               // (Increment x1 as a side effect.)
1749    str    x1, [xSELF, #THREAD_LOCAL_ALLOC_STACK_TOP_OFFSET]
1750                                                              // Decrement the size of the free list
1751    ldr    w1, [x4, #(ROSALLOC_RUN_FREE_LIST_OFFSET + ROSALLOC_RUN_FREE_LIST_SIZE_OFFSET)]
1752    sub    x1, x1, #1
1753                                                              // TODO: consider combining this store
1754                                                              // and the list head store above using
1755                                                              // strd.
1756    str    w1, [x4, #(ROSALLOC_RUN_FREE_LIST_OFFSET + ROSALLOC_RUN_FREE_LIST_SIZE_OFFSET)]
1757
1758    mov    x0, x3                                             // Set the return value and return.
1759    ret
1760.Lart_quick_alloc_object_rosalloc_slow_path:
1761    SETUP_SAVE_REFS_ONLY_FRAME             // save callee saves in case of GC
1762    mov    x2, xSELF                       // pass Thread::Current
1763    bl     artAllocObjectFromCodeRosAlloc  // (uint32_t type_idx, Method* method, Thread*)
1764    RESTORE_SAVE_REFS_ONLY_FRAME
1765    RETURN_IF_RESULT_IS_NON_ZERO_OR_DELIVER
1766END art_quick_alloc_object_rosalloc
1767
1768
1769// The common fast path code for art_quick_alloc_array_region_tlab.
1770.macro ALLOC_ARRAY_TLAB_FAST_PATH slowPathLabel, xClass, wClass, xCount, wCount, xTemp0, wTemp0, xTemp1, wTemp1, xTemp2, wTemp2
1771    // Check null class
1772    cbz    \wClass, \slowPathLabel
1773    ALLOC_ARRAY_TLAB_FAST_PATH_RESOLVED \slowPathLabel, \xClass, \wClass, \xCount, \wCount, \xTemp0, \wTemp0, \xTemp1, \wTemp1, \xTemp2, \wTemp2
1774.endm
1775
1776// The common fast path code for art_quick_alloc_array_region_tlab.
1777.macro ALLOC_ARRAY_TLAB_FAST_PATH_RESOLVED slowPathLabel, xClass, wClass, xCount, wCount, xTemp0, wTemp0, xTemp1, wTemp1, xTemp2, wTemp2
1778    // Array classes are never finalizable or uninitialized, no need to check.
1779    ldr    \wTemp0, [\xClass, #MIRROR_CLASS_COMPONENT_TYPE_OFFSET] // Load component type
1780    UNPOISON_HEAP_REF \wTemp0
1781    ldr    \wTemp0, [\xTemp0, #MIRROR_CLASS_OBJECT_PRIMITIVE_TYPE_OFFSET]
1782    lsr    \xTemp0, \xTemp0, #PRIMITIVE_TYPE_SIZE_SHIFT_SHIFT // Component size shift is in high 16
1783                                                              // bits.
1784                                                              // xCount is holding a 32 bit value,
1785                                                              // it can not overflow.
1786    lsl    \xTemp1, \xCount, \xTemp0                          // Calculate data size
1787    // Add array data offset and alignment.
1788    add    \xTemp1, \xTemp1, #(MIRROR_INT_ARRAY_DATA_OFFSET + OBJECT_ALIGNMENT_MASK)
1789#if MIRROR_LONG_ARRAY_DATA_OFFSET != MIRROR_INT_ARRAY_DATA_OFFSET + 4
1790#error Long array data offset must be 4 greater than int array data offset.
1791#endif
1792
1793    add    \xTemp0, \xTemp0, #1                               // Add 4 to the length only if the
1794                                                              // component size shift is 3
1795                                                              // (for 64 bit alignment).
1796    and    \xTemp0, \xTemp0, #4
1797    add    \xTemp1, \xTemp1, \xTemp0
1798    and    \xTemp1, \xTemp1, #OBJECT_ALIGNMENT_MASK_TOGGLED64 // Apply alignemnt mask
1799                                                              // (addr + 7) & ~7. The mask must
1800                                                              // be 64 bits to keep high bits in
1801                                                              // case of overflow.
1802    // Negative sized arrays are handled here since xCount holds a zero extended 32 bit value.
1803    // Negative ints become large 64 bit unsigned ints which will always be larger than max signed
1804    // 32 bit int. Since the max shift for arrays is 3, it can not become a negative 64 bit int.
1805    cmp    \xTemp1, #MIN_LARGE_OBJECT_THRESHOLD               // Possibly a large object, go slow
1806    bhs    \slowPathLabel                                     // path.
1807
1808    ldr    \xTemp0, [xSELF, #THREAD_LOCAL_POS_OFFSET]         // Check tlab for space, note that
1809                                                              // we use (end - begin) to handle
1810                                                              // negative size arrays. It is
1811                                                              // assumed that a negative size will
1812                                                              // always be greater unsigned than
1813                                                              // region size.
1814    ldr    \xTemp2, [xSELF, #THREAD_LOCAL_END_OFFSET]
1815    sub    \xTemp2, \xTemp2, \xTemp0
1816    cmp    \xTemp1, \xTemp2
1817    bhi    \slowPathLabel
1818    // "Point of no slow path". Won't go to the slow path from here on. OK to clobber x0 and x1.
1819                                                              // Move old thread_local_pos to x0
1820                                                              // for the return value.
1821    mov    x0, \xTemp0
1822    add    \xTemp0, \xTemp0, \xTemp1
1823    str    \xTemp0, [xSELF, #THREAD_LOCAL_POS_OFFSET]         // Store new thread_local_pos.
1824    ldr    \xTemp0, [xSELF, #THREAD_LOCAL_OBJECTS_OFFSET]     // Increment thread_local_objects.
1825    add    \xTemp0, \xTemp0, #1
1826    str    \xTemp0, [xSELF, #THREAD_LOCAL_OBJECTS_OFFSET]
1827    POISON_HEAP_REF \wClass
1828    str    \wClass, [x0, #MIRROR_OBJECT_CLASS_OFFSET]         // Store the class pointer.
1829    str    \wCount, [x0, #MIRROR_ARRAY_LENGTH_OFFSET]         // Store the array length.
1830                                                              // Fence.
1831    dmb    ishst
1832    ret
1833.endm
1834
1835// The common fast path code for art_quick_alloc_object_tlab and art_quick_alloc_object_region_tlab.
1836//
1837// x0: type_idx/return value, x1: ArtMethod*, x2: Class*, xSELF(x19): Thread::Current
1838// x3-x7: free.
1839// Need to preserve x0 and x1 to the slow path.
1840.macro ALLOC_OBJECT_TLAB_FAST_PATH slowPathLabel
1841    cbz    x2, \slowPathLabel                                 // Check null class
1842    ALLOC_OBJECT_TLAB_FAST_PATH_RESOLVED \slowPathLabel
1843.endm
1844
1845// TODO: delete ALLOC_OBJECT_TLAB_FAST_PATH_RESOLVED since it is the same as
1846// ALLOC_OBJECT_TLAB_FAST_PATH_INITIALIZED.
1847.macro ALLOC_OBJECT_TLAB_FAST_PATH_RESOLVED slowPathLabel
1848    ALLOC_OBJECT_TLAB_FAST_PATH_INITIALIZED \slowPathLabel
1849.endm
1850
1851.macro ALLOC_OBJECT_TLAB_FAST_PATH_INITIALIZED slowPathLabel
1852    ldr    x4, [xSELF, #THREAD_LOCAL_POS_OFFSET]
1853    ldr    x5, [xSELF, #THREAD_LOCAL_END_OFFSET]
1854    ldr    w7, [x2, #MIRROR_CLASS_OBJECT_SIZE_ALLOC_FAST_PATH_OFFSET]  // Load the object size (x7).
1855    add    x6, x4, x7                                         // Add object size to tlab pos.
1856    cmp    x6, x5                                             // Check if it fits, overflow works
1857                                                              // since the tlab pos and end are 32
1858                                                              // bit values.
1859    bhi    \slowPathLabel
1860    // "Point of no slow path". Won't go to the slow path from here on. OK to clobber x0 and x1.
1861    mov    x0, x4
1862    str    x6, [xSELF, #THREAD_LOCAL_POS_OFFSET]              // Store new thread_local_pos.
1863    ldr    x5, [xSELF, #THREAD_LOCAL_OBJECTS_OFFSET]          // Increment thread_local_objects.
1864    add    x5, x5, #1
1865    str    x5, [xSELF, #THREAD_LOCAL_OBJECTS_OFFSET]
1866    POISON_HEAP_REF w2
1867    str    w2, [x0, #MIRROR_OBJECT_CLASS_OFFSET]              // Store the class pointer.
1868                                                              // Fence. This is "ish" not "ishst" so
1869                                                              // that the code after this allocation
1870                                                              // site will see the right values in
1871                                                              // the fields of the class.
1872                                                              // Alternatively we could use "ishst"
1873                                                              // if we use load-acquire for the
1874                                                              // object size load.)
1875    dmb    ish
1876    ret
1877.endm
1878
1879// A hand-written override for GENERATE_ALLOC_ENTRYPOINTS_ALLOC_OBJECT(_tlab, TLAB).
1880ENTRY art_quick_alloc_object_tlab
1881    // Fast path tlab allocation.
1882    // x0: type_idx/return value, x1: ArtMethod*, xSELF(x19): Thread::Current
1883    // x2-x7: free.
1884#if defined(USE_READ_BARRIER)
1885    mvn    x0, xzr                                            // Read barrier not supported here.
1886    ret                                                       // Return -1.
1887#endif
1888    ldr    x2, [x1, #ART_METHOD_DEX_CACHE_TYPES_OFFSET_64]    // Load dex cache resolved types array
1889                                                              // Load the class (x2)
1890    ldr    w2, [x2, x0, lsl #COMPRESSED_REFERENCE_SIZE_SHIFT]
1891    ALLOC_OBJECT_TLAB_FAST_PATH .Lart_quick_alloc_object_tlab_slow_path
1892.Lart_quick_alloc_object_tlab_slow_path:
1893    SETUP_SAVE_REFS_ONLY_FRAME           // Save callee saves in case of GC.
1894    mov    x2, xSELF                     // Pass Thread::Current.
1895    bl     artAllocObjectFromCodeTLAB    // (uint32_t type_idx, Method* method, Thread*)
1896    RESTORE_SAVE_REFS_ONLY_FRAME
1897    RETURN_IF_RESULT_IS_NON_ZERO_OR_DELIVER
1898END art_quick_alloc_object_tlab
1899
1900// The common code for art_quick_alloc_object_*region_tlab
1901.macro GENERATE_ALLOC_OBJECT_REGION_TLAB name, entrypoint, fast_path, is_resolved, read_barrier
1902ENTRY \name
1903    // Fast path region tlab allocation.
1904    // x0: type_idx/resolved class/return value, x1: ArtMethod*, xSELF(x19): Thread::Current
1905    // If is_resolved is 1 then x0 is the resolved type, otherwise it is the index.
1906    // x2-x7: free.
1907#if !defined(USE_READ_BARRIER)
1908    mvn    x0, xzr                                            // Read barrier must be enabled here.
1909    ret                                                       // Return -1.
1910#endif
1911.if \is_resolved
1912    mov    x2, x0 // class is actually stored in x0 already
1913.else
1914    ldr    x2, [x1, #ART_METHOD_DEX_CACHE_TYPES_OFFSET_64]    // Load dex cache resolved types array
1915                                                              // Load the class (x2)
1916    ldr    w2, [x2, x0, lsl #COMPRESSED_REFERENCE_SIZE_SHIFT]
1917    // If the class is null, go slow path. The check is required to read the lock word.
1918    cbz    w2, .Lslow_path\name
1919.endif
1920.if \read_barrier
1921    // Most common case: GC is not marking.
1922    ldr    w3, [xSELF, #THREAD_IS_GC_MARKING_OFFSET]
1923    cbnz   x3, .Lmarking\name
1924.endif
1925.Ldo_allocation\name:
1926    \fast_path .Lslow_path\name
1927.Lmarking\name:
1928.if \read_barrier
1929    // GC is marking, check the lock word of the class for the mark bit.
1930    // Class is not null, check mark bit in lock word.
1931    ldr    w3, [x2, #MIRROR_OBJECT_LOCK_WORD_OFFSET]
1932    // If the bit is not zero, do the allocation.
1933    tbnz    w3, #LOCK_WORD_MARK_BIT_SHIFT, .Ldo_allocation\name
1934                                                              // The read barrier slow path. Mark
1935                                                              // the class.
1936    SAVE_TWO_REGS_INCREASE_FRAME x0, x1, 32                   // Save registers (x0, x1, lr).
1937    SAVE_REG xLR, 24                                          // Align sp by 16 bytes.
1938    mov    x0, x2                                             // Pass the class as the first param.
1939    bl     artReadBarrierMark
1940    mov    x2, x0                                             // Get the (marked) class back.
1941    RESTORE_REG xLR, 24
1942    RESTORE_TWO_REGS_DECREASE_FRAME x0, x1, 32                // Restore registers.
1943    b      .Ldo_allocation\name
1944.endif
1945.Lslow_path\name:
1946    SETUP_SAVE_REFS_ONLY_FRAME                 // Save callee saves in case of GC.
1947    mov    x2, xSELF                           // Pass Thread::Current.
1948    bl     \entrypoint                         // (uint32_t type_idx, Method* method, Thread*)
1949    RESTORE_SAVE_REFS_ONLY_FRAME
1950    RETURN_IF_RESULT_IS_NON_ZERO_OR_DELIVER
1951END \name
1952.endm
1953
1954// Use ALLOC_OBJECT_TLAB_FAST_PATH_RESOLVED since the null check is already done in GENERATE_ALLOC_OBJECT_TLAB.
1955GENERATE_ALLOC_OBJECT_REGION_TLAB art_quick_alloc_object_region_tlab, artAllocObjectFromCodeRegionTLAB, ALLOC_OBJECT_TLAB_FAST_PATH_RESOLVED, 0, 1
1956// No read barrier for the resolved or initialized cases since the caller is responsible for the
1957// read barrier due to the to-space invariant.
1958GENERATE_ALLOC_OBJECT_REGION_TLAB art_quick_alloc_object_resolved_region_tlab, artAllocObjectFromCodeResolvedRegionTLAB, ALLOC_OBJECT_TLAB_FAST_PATH_RESOLVED, 1, 0
1959GENERATE_ALLOC_OBJECT_REGION_TLAB art_quick_alloc_object_initialized_region_tlab, artAllocObjectFromCodeInitializedRegionTLAB, ALLOC_OBJECT_TLAB_FAST_PATH_INITIALIZED, 1, 0
1960
1961// TODO: We could use this macro for the normal tlab allocator too.
1962
1963// The common code for art_quick_alloc_array_*region_tlab
1964.macro GENERATE_ALLOC_ARRAY_REGION_TLAB name, entrypoint, fast_path, is_resolved
1965ENTRY \name
1966    // Fast path array allocation for region tlab allocation.
1967    // x0: uint32_t type_idx
1968    // x1: int32_t component_count
1969    // x2: ArtMethod* method
1970    // x3-x7: free.
1971#if !defined(USE_READ_BARRIER)
1972    mvn    x0, xzr                                            // Read barrier must be enabled here.
1973    ret                                                       // Return -1.
1974#endif
1975.if \is_resolved
1976    mov    x3, x0
1977    // If already resolved, class is stored in x0
1978.else
1979    ldr    x3, [x2, #ART_METHOD_DEX_CACHE_TYPES_OFFSET_64]    // Load dex cache resolved types array
1980                                                              // Load the class (x2)
1981    ldr    w3, [x3, x0, lsl #COMPRESSED_REFERENCE_SIZE_SHIFT]
1982.endif
1983    // Most common case: GC is not marking.
1984    ldr    w4, [xSELF, #THREAD_IS_GC_MARKING_OFFSET]
1985    cbnz   x4, .Lmarking\name
1986.Ldo_allocation\name:
1987    \fast_path .Lslow_path\name, x3, w3, x1, w1, x4, w4, x5, w5, x6, w6
1988.Lmarking\name:
1989    // GC is marking, check the lock word of the class for the mark bit.
1990    // If the class is null, go slow path. The check is required to read the lock word.
1991    cbz    w3, .Lslow_path\name
1992    // Class is not null, check mark bit in lock word.
1993    ldr    w4, [x3, #MIRROR_OBJECT_LOCK_WORD_OFFSET]
1994    // If the bit is not zero, do the allocation.
1995    tbnz   w4, #LOCK_WORD_MARK_BIT_SHIFT, .Ldo_allocation\name
1996                                                              // The read barrier slow path. Mark
1997                                                              // the class.
1998    stp    x0, x1, [sp, #-32]!                                // Save registers (x0, x1, x2, lr).
1999    stp    x2, xLR, [sp, #16]
2000    mov    x0, x3                                             // Pass the class as the first param.
2001    bl     artReadBarrierMark
2002    mov    x3, x0                                             // Get the (marked) class back.
2003    ldp    x2, xLR, [sp, #16]
2004    ldp    x0, x1, [sp], #32                                  // Restore registers.
2005    b      .Ldo_allocation\name
2006.Lslow_path\name:
2007    // x0: uint32_t type_idx / mirror::Class* klass (if resolved)
2008    // x1: int32_t component_count
2009    // x2: ArtMethod* method
2010    // x3: Thread* self
2011    SETUP_SAVE_REFS_ONLY_FRAME        // save callee saves in case of GC
2012    mov    x3, xSELF                  // pass Thread::Current
2013    bl     \entrypoint
2014    RESTORE_SAVE_REFS_ONLY_FRAME
2015    RETURN_IF_RESULT_IS_NON_ZERO_OR_DELIVER
2016END \name
2017.endm
2018
2019GENERATE_ALLOC_ARRAY_REGION_TLAB art_quick_alloc_array_region_tlab, artAllocArrayFromCodeRegionTLAB, ALLOC_ARRAY_TLAB_FAST_PATH, 0
2020// TODO: art_quick_alloc_array_resolved_region_tlab seems to not get called. Investigate compiler.
2021GENERATE_ALLOC_ARRAY_REGION_TLAB art_quick_alloc_array_resolved_region_tlab, artAllocArrayFromCodeResolvedRegionTLAB, ALLOC_ARRAY_TLAB_FAST_PATH_RESOLVED, 1
2022
2023    /*
2024     * Called by managed code when the thread has been asked to suspend.
2025     */
2026    .extern artTestSuspendFromCode
2027ENTRY art_quick_test_suspend
2028    SETUP_SAVE_EVERYTHING_FRAME               // save callee saves for stack crawl
2029    mov    x0, xSELF
2030    bl     artTestSuspendFromCode             // (Thread*)
2031    RESTORE_SAVE_EVERYTHING_FRAME
2032    ret
2033END art_quick_test_suspend
2034
2035ENTRY art_quick_implicit_suspend
2036    mov    x0, xSELF
2037    SETUP_SAVE_REFS_ONLY_FRAME                // save callee saves for stack crawl
2038    bl     artTestSuspendFromCode             // (Thread*)
2039    RESTORE_SAVE_REFS_ONLY_FRAME_AND_RETURN
2040END art_quick_implicit_suspend
2041
2042     /*
2043     * Called by managed code that is attempting to call a method on a proxy class. On entry
2044     * x0 holds the proxy method and x1 holds the receiver; The frame size of the invoked proxy
2045     * method agrees with a ref and args callee save frame.
2046     */
2047     .extern artQuickProxyInvokeHandler
2048ENTRY art_quick_proxy_invoke_handler
2049    SETUP_SAVE_REFS_AND_ARGS_FRAME_WITH_METHOD_IN_X0
2050    mov     x2, xSELF                   // pass Thread::Current
2051    mov     x3, sp                      // pass SP
2052    bl      artQuickProxyInvokeHandler  // (Method* proxy method, receiver, Thread*, SP)
2053    ldr     x2, [xSELF, THREAD_EXCEPTION_OFFSET]
2054    cbnz    x2, .Lexception_in_proxy    // success if no exception is pending
2055    RESTORE_SAVE_REFS_AND_ARGS_FRAME    // Restore frame
2056    fmov    d0, x0                      // Store result in d0 in case it was float or double
2057    ret                                 // return on success
2058.Lexception_in_proxy:
2059    RESTORE_SAVE_REFS_AND_ARGS_FRAME
2060    DELIVER_PENDING_EXCEPTION
2061END art_quick_proxy_invoke_handler
2062
2063    /*
2064     * Called to resolve an imt conflict.
2065     * x0 is the conflict ArtMethod.
2066     * xIP1 is a hidden argument that holds the target interface method's dex method index.
2067     *
2068     * Note that this stub writes to xIP0, xIP1, and x0.
2069     */
2070    .extern artInvokeInterfaceTrampoline
2071ENTRY art_quick_imt_conflict_trampoline
2072    ldr xIP0, [sp, #0]  // Load referrer
2073    ldr xIP0, [xIP0, #ART_METHOD_DEX_CACHE_METHODS_OFFSET_64]   // Load dex cache methods array
2074    ldr xIP0, [xIP0, xIP1, lsl #POINTER_SIZE_SHIFT]  // Load interface method
2075    ldr xIP1, [x0, #ART_METHOD_JNI_OFFSET_64]  // Load ImtConflictTable
2076    ldr x0, [xIP1]  // Load first entry in ImtConflictTable.
2077.Limt_table_iterate:
2078    cmp x0, xIP0
2079    // Branch if found. Benchmarks have shown doing a branch here is better.
2080    beq .Limt_table_found
2081    // If the entry is null, the interface method is not in the ImtConflictTable.
2082    cbz x0, .Lconflict_trampoline
2083    // Iterate over the entries of the ImtConflictTable.
2084    ldr x0, [xIP1, #(2 * __SIZEOF_POINTER__)]!
2085    b .Limt_table_iterate
2086.Limt_table_found:
2087    // We successfully hit an entry in the table. Load the target method
2088    // and jump to it.
2089    ldr x0, [xIP1, #__SIZEOF_POINTER__]
2090    ldr xIP0, [x0, #ART_METHOD_QUICK_CODE_OFFSET_64]
2091    br xIP0
2092.Lconflict_trampoline:
2093    // Call the runtime stub to populate the ImtConflictTable and jump to the
2094    // resolved method.
2095    INVOKE_TRAMPOLINE_BODY artInvokeInterfaceTrampoline
2096END art_quick_imt_conflict_trampoline
2097
2098ENTRY art_quick_resolution_trampoline
2099    SETUP_SAVE_REFS_AND_ARGS_FRAME
2100    mov x2, xSELF
2101    mov x3, sp
2102    bl artQuickResolutionTrampoline  // (called, receiver, Thread*, SP)
2103    cbz x0, 1f
2104    mov xIP0, x0            // Remember returned code pointer in xIP0.
2105    ldr x0, [sp, #0]        // artQuickResolutionTrampoline puts called method in *SP.
2106    RESTORE_SAVE_REFS_AND_ARGS_FRAME
2107    br xIP0
21081:
2109    RESTORE_SAVE_REFS_AND_ARGS_FRAME
2110    DELIVER_PENDING_EXCEPTION
2111END art_quick_resolution_trampoline
2112
2113/*
2114 * Generic JNI frame layout:
2115 *
2116 * #-------------------#
2117 * |                   |
2118 * | caller method...  |
2119 * #-------------------#    <--- SP on entry
2120 * | Return X30/LR     |
2121 * | X29/FP            |    callee save
2122 * | X28               |    callee save
2123 * | X27               |    callee save
2124 * | X26               |    callee save
2125 * | X25               |    callee save
2126 * | X24               |    callee save
2127 * | X23               |    callee save
2128 * | X22               |    callee save
2129 * | X21               |    callee save
2130 * | X20               |    callee save
2131 * | X19               |    callee save
2132 * | X7                |    arg7
2133 * | X6                |    arg6
2134 * | X5                |    arg5
2135 * | X4                |    arg4
2136 * | X3                |    arg3
2137 * | X2                |    arg2
2138 * | X1                |    arg1
2139 * | D7                |    float arg 8
2140 * | D6                |    float arg 7
2141 * | D5                |    float arg 6
2142 * | D4                |    float arg 5
2143 * | D3                |    float arg 4
2144 * | D2                |    float arg 3
2145 * | D1                |    float arg 2
2146 * | D0                |    float arg 1
2147 * | Method*           | <- X0
2148 * #-------------------#
2149 * | local ref cookie  | // 4B
2150 * | handle scope size | // 4B
2151 * #-------------------#
2152 * | JNI Call Stack    |
2153 * #-------------------#    <--- SP on native call
2154 * |                   |
2155 * | Stack for Regs    |    The trampoline assembly will pop these values
2156 * |                   |    into registers for native call
2157 * #-------------------#
2158 * | Native code ptr   |
2159 * #-------------------#
2160 * | Free scratch      |
2161 * #-------------------#
2162 * | Ptr to (1)        |    <--- SP
2163 * #-------------------#
2164 */
2165    /*
2166     * Called to do a generic JNI down-call
2167     */
2168ENTRY art_quick_generic_jni_trampoline
2169    SETUP_SAVE_REFS_AND_ARGS_FRAME_WITH_METHOD_IN_X0
2170
2171    // Save SP , so we can have static CFI info.
2172    mov x28, sp
2173    .cfi_def_cfa_register x28
2174
2175    // This looks the same, but is different: this will be updated to point to the bottom
2176    // of the frame when the handle scope is inserted.
2177    mov xFP, sp
2178
2179    mov xIP0, #5120
2180    sub sp, sp, xIP0
2181
2182    // prepare for artQuickGenericJniTrampoline call
2183    // (Thread*,  SP)
2184    //    x0      x1   <= C calling convention
2185    //   xSELF    xFP  <= where they are
2186
2187    mov x0, xSELF   // Thread*
2188    mov x1, xFP
2189    bl artQuickGenericJniTrampoline  // (Thread*, sp)
2190
2191    // The C call will have registered the complete save-frame on success.
2192    // The result of the call is:
2193    // x0: pointer to native code, 0 on error.
2194    // x1: pointer to the bottom of the used area of the alloca, can restore stack till there.
2195
2196    // Check for error = 0.
2197    cbz x0, .Lexception_in_native
2198
2199    // Release part of the alloca.
2200    mov sp, x1
2201
2202    // Save the code pointer
2203    mov xIP0, x0
2204
2205    // Load parameters from frame into registers.
2206    // TODO Check with artQuickGenericJniTrampoline.
2207    //      Also, check again APPCS64 - the stack arguments are interleaved.
2208    ldp x0, x1, [sp]
2209    ldp x2, x3, [sp, #16]
2210    ldp x4, x5, [sp, #32]
2211    ldp x6, x7, [sp, #48]
2212
2213    ldp d0, d1, [sp, #64]
2214    ldp d2, d3, [sp, #80]
2215    ldp d4, d5, [sp, #96]
2216    ldp d6, d7, [sp, #112]
2217
2218    add sp, sp, #128
2219
2220    blr xIP0        // native call.
2221
2222    // result sign extension is handled in C code
2223    // prepare for artQuickGenericJniEndTrampoline call
2224    // (Thread*, result, result_f)
2225    //    x0       x1       x2        <= C calling convention
2226    mov x1, x0      // Result (from saved).
2227    mov x0, xSELF   // Thread register.
2228    fmov x2, d0     // d0 will contain floating point result, but needs to go into x2
2229
2230    bl artQuickGenericJniEndTrampoline
2231
2232    // Pending exceptions possible.
2233    ldr x2, [xSELF, THREAD_EXCEPTION_OFFSET]
2234    cbnz x2, .Lexception_in_native
2235
2236    // Tear down the alloca.
2237    mov sp, x28
2238    .cfi_def_cfa_register sp
2239
2240    // Tear down the callee-save frame.
2241    RESTORE_SAVE_REFS_AND_ARGS_FRAME
2242
2243    // store into fpr, for when it's a fpr return...
2244    fmov d0, x0
2245    ret
2246
2247.Lexception_in_native:
2248    // Move to x1 then sp to please assembler.
2249    ldr x1, [xSELF, # THREAD_TOP_QUICK_FRAME_OFFSET]
2250    mov sp, x1
2251    .cfi_def_cfa_register sp
2252    # This will create a new save-all frame, required by the runtime.
2253    DELIVER_PENDING_EXCEPTION
2254END art_quick_generic_jni_trampoline
2255
2256/*
2257 * Called to bridge from the quick to interpreter ABI. On entry the arguments match those
2258 * of a quick call:
2259 * x0 = method being called/to bridge to.
2260 * x1..x7, d0..d7 = arguments to that method.
2261 */
2262ENTRY art_quick_to_interpreter_bridge
2263    SETUP_SAVE_REFS_AND_ARGS_FRAME         // Set up frame and save arguments.
2264
2265    //  x0 will contain mirror::ArtMethod* method.
2266    mov x1, xSELF                          // How to get Thread::Current() ???
2267    mov x2, sp
2268
2269    // uint64_t artQuickToInterpreterBridge(mirror::ArtMethod* method, Thread* self,
2270    //                                      mirror::ArtMethod** sp)
2271    bl   artQuickToInterpreterBridge
2272
2273    RESTORE_SAVE_REFS_AND_ARGS_FRAME       // TODO: no need to restore arguments in this case.
2274
2275    fmov d0, x0
2276
2277    RETURN_OR_DELIVER_PENDING_EXCEPTION
2278END art_quick_to_interpreter_bridge
2279
2280
2281//
2282// Instrumentation-related stubs
2283//
2284    .extern artInstrumentationMethodEntryFromCode
2285ENTRY art_quick_instrumentation_entry
2286    SETUP_SAVE_REFS_AND_ARGS_FRAME
2287
2288    mov   x20, x0             // Preserve method reference in a callee-save.
2289
2290    mov   x2, xSELF
2291    mov   x3, xLR
2292    bl    artInstrumentationMethodEntryFromCode  // (Method*, Object*, Thread*, LR)
2293
2294    mov   xIP0, x0            // x0 = result of call.
2295    mov   x0, x20             // Reload method reference.
2296
2297    RESTORE_SAVE_REFS_AND_ARGS_FRAME  // Note: will restore xSELF
2298    adr   xLR, art_quick_instrumentation_exit
2299    br    xIP0                // Tail-call method with lr set to art_quick_instrumentation_exit.
2300END art_quick_instrumentation_entry
2301
2302    .extern artInstrumentationMethodExitFromCode
2303ENTRY art_quick_instrumentation_exit
2304    mov   xLR, #0             // Clobber LR for later checks.
2305
2306    SETUP_SAVE_REFS_ONLY_FRAME
2307
2308    // We need to save x0 and d0. We could use a callee-save from SETUP_REF_ONLY, but then
2309    // we would need to fully restore it. As there are a lot of callee-save registers, it seems
2310    // easier to have an extra small stack area.
2311
2312    str x0, [sp, #-16]!       // Save integer result.
2313    .cfi_adjust_cfa_offset 16
2314    str d0,  [sp, #8]         // Save floating-point result.
2315
2316    add   x1, sp, #16         // Pass SP.
2317    mov   x2, x0              // Pass integer result.
2318    fmov  x3, d0              // Pass floating-point result.
2319    mov   x0, xSELF           // Pass Thread.
2320    bl   artInstrumentationMethodExitFromCode    // (Thread*, SP, gpr_res, fpr_res)
2321
2322    mov   xIP0, x0            // Return address from instrumentation call.
2323    mov   xLR, x1             // r1 is holding link register if we're to bounce to deoptimize
2324
2325    ldr   d0, [sp, #8]        // Restore floating-point result.
2326    ldr   x0, [sp], #16       // Restore integer result, and drop stack area.
2327    .cfi_adjust_cfa_offset 16
2328
2329    POP_SAVE_REFS_ONLY_FRAME
2330
2331    br    xIP0                // Tail-call out.
2332END art_quick_instrumentation_exit
2333
2334    /*
2335     * Instrumentation has requested that we deoptimize into the interpreter. The deoptimization
2336     * will long jump to the upcall with a special exception of -1.
2337     */
2338    .extern artDeoptimize
2339ENTRY art_quick_deoptimize
2340    SETUP_SAVE_ALL_CALLEE_SAVES_FRAME
2341    mov    x0, xSELF          // Pass thread.
2342    bl     artDeoptimize      // artDeoptimize(Thread*)
2343    brk 0
2344END art_quick_deoptimize
2345
2346    /*
2347     * Compiled code has requested that we deoptimize into the interpreter. The deoptimization
2348     * will long jump to the upcall with a special exception of -1.
2349     */
2350    .extern artDeoptimizeFromCompiledCode
2351ENTRY art_quick_deoptimize_from_compiled_code
2352    SETUP_SAVE_EVERYTHING_FRAME
2353    mov    x0, xSELF                      // Pass thread.
2354    bl     artDeoptimizeFromCompiledCode  // artDeoptimizeFromCompiledCode(Thread*)
2355    brk 0
2356END art_quick_deoptimize_from_compiled_code
2357
2358
2359    /*
2360     * String's indexOf.
2361     *
2362     * TODO: Not very optimized.
2363     * On entry:
2364     *    x0:   string object (known non-null)
2365     *    w1:   char to match (known <= 0xFFFF)
2366     *    w2:   Starting offset in string data
2367     */
2368ENTRY art_quick_indexof
2369    ldr   w3, [x0, #MIRROR_STRING_COUNT_OFFSET]
2370    add   x0, x0, #MIRROR_STRING_VALUE_OFFSET
2371#if (STRING_COMPRESSION_FEATURE)
2372    /* w4 holds count (with flag) and w3 holds actual length */
2373    mov   w4, w3
2374    and   w3, w3, #2147483647
2375#endif
2376    /* Clamp start to [0..count] */
2377    cmp   w2, #0
2378    csel  w2, wzr, w2, lt
2379    cmp   w2, w3
2380    csel  w2, w3, w2, gt
2381
2382    /* Save a copy to compute result */
2383    mov   x5, x0
2384
2385#if (STRING_COMPRESSION_FEATURE)
2386    tbnz  w4, #31, .Lstring_indexof_compressed
2387#endif
2388    /* Build pointer to start of data to compare and pre-bias */
2389    add   x0, x0, x2, lsl #1
2390    sub   x0, x0, #2
2391    /* Compute iteration count */
2392    sub   w2, w3, w2
2393
2394    /*
2395     * At this point we have:
2396     *  x0: start of the data to test
2397     *  w1: char to compare
2398     *  w2: iteration count
2399     *  x5: original start of string data
2400     */
2401
2402    subs  w2, w2, #4
2403    b.lt  .Lindexof_remainder
2404
2405.Lindexof_loop4:
2406    ldrh  w6, [x0, #2]!
2407    ldrh  w7, [x0, #2]!
2408    ldrh  wIP0, [x0, #2]!
2409    ldrh  wIP1, [x0, #2]!
2410    cmp   w6, w1
2411    b.eq  .Lmatch_0
2412    cmp   w7, w1
2413    b.eq  .Lmatch_1
2414    cmp   wIP0, w1
2415    b.eq  .Lmatch_2
2416    cmp   wIP1, w1
2417    b.eq  .Lmatch_3
2418    subs  w2, w2, #4
2419    b.ge  .Lindexof_loop4
2420
2421.Lindexof_remainder:
2422    adds  w2, w2, #4
2423    b.eq  .Lindexof_nomatch
2424
2425.Lindexof_loop1:
2426    ldrh  w6, [x0, #2]!
2427    cmp   w6, w1
2428    b.eq  .Lmatch_3
2429    subs  w2, w2, #1
2430    b.ne  .Lindexof_loop1
2431
2432.Lindexof_nomatch:
2433    mov   x0, #-1
2434    ret
2435
2436.Lmatch_0:
2437    sub   x0, x0, #6
2438    sub   x0, x0, x5
2439    asr   x0, x0, #1
2440    ret
2441.Lmatch_1:
2442    sub   x0, x0, #4
2443    sub   x0, x0, x5
2444    asr   x0, x0, #1
2445    ret
2446.Lmatch_2:
2447    sub   x0, x0, #2
2448    sub   x0, x0, x5
2449    asr   x0, x0, #1
2450    ret
2451.Lmatch_3:
2452    sub   x0, x0, x5
2453    asr   x0, x0, #1
2454    ret
2455#if (STRING_COMPRESSION_FEATURE)
2456   /*
2457    * Comparing compressed string character-per-character with
2458    * input character
2459    */
2460.Lstring_indexof_compressed:
2461    add   x0, x0, x2
2462    sub   x0, x0, #1
2463    sub   w2, w3, w2
2464.Lstring_indexof_compressed_loop:
2465    subs  w2, w2, #1
2466    b.lt  .Lindexof_nomatch
2467    ldrb  w6, [x0, #1]!
2468    cmp   w6, w1
2469    b.eq  .Lstring_indexof_compressed_matched
2470    b     .Lstring_indexof_compressed_loop
2471.Lstring_indexof_compressed_matched:
2472    sub   x0, x0, x5
2473    ret
2474#endif
2475END art_quick_indexof
2476
2477    /*
2478     * Create a function `name` calling the ReadBarrier::Mark routine,
2479     * getting its argument and returning its result through W register
2480     * `wreg` (corresponding to X register `xreg`), saving and restoring
2481     * all caller-save registers.
2482     *
2483     * If `wreg` is different from `w0`, the generated function follows a
2484     * non-standard runtime calling convention:
2485     * - register `wreg` is used to pass the (sole) argument of this
2486     *   function (instead of W0);
2487     * - register `wreg` is used to return the result of this function
2488     *   (instead of W0);
2489     * - W0 is treated like a normal (non-argument) caller-save register;
2490     * - everything else is the same as in the standard runtime calling
2491     *   convention (e.g. standard callee-save registers are preserved).
2492     */
2493.macro READ_BARRIER_MARK_REG name, wreg, xreg
2494ENTRY \name
2495    // Reference is null, no work to do at all.
2496    cbz \wreg, .Lret_rb_\name
2497    /*
2498     * Allocate 46 stack slots * 8 = 368 bytes:
2499     * - 20 slots for core registers X0-X19
2500     * - 24 slots for floating-point registers D0-D7 and D16-D31
2501     * -  1 slot for return address register XLR
2502     * -  1 padding slot for 16-byte stack alignment
2503     */
2504    // Use wIP0 as temp and check the mark bit of the reference. wIP0 is not used by the compiler.
2505    ldr   wIP0, [\xreg, #MIRROR_OBJECT_LOCK_WORD_OFFSET]
2506    tbz   wIP0, #LOCK_WORD_MARK_BIT_SHIFT, .Lnot_marked_rb_\name
2507.Lret_rb_\name:
2508    ret
2509.Lnot_marked_rb_\name:
2510    // Check if the top two bits are one, if this is the case it is a forwarding address.
2511    mvn wIP0, wIP0
2512    cmp wzr, wIP0, lsr #30
2513    beq .Lret_forwarding_address\name
2514.Lslow_rb_\name:
2515    // We must not clobber IP0 since art_quick_resolve_string makes a tail call here and relies on
2516    // IP0 being restored.
2517    // Save all potentially live caller-save core registers.
2518    SAVE_TWO_REGS_INCREASE_FRAME x0, x1, 368
2519    SAVE_TWO_REGS  x2,  x3, 16
2520    SAVE_TWO_REGS  x4,  x5, 32
2521    SAVE_TWO_REGS  x6,  x7, 48
2522    SAVE_TWO_REGS  x8,  x9, 64
2523    SAVE_TWO_REGS x10, x11, 80
2524    SAVE_TWO_REGS x12, x13, 96
2525    SAVE_TWO_REGS x14, x15, 112
2526    SAVE_TWO_REGS x16, x17, 128
2527    SAVE_TWO_REGS x18, x19, 144
2528    // Save all potentially live caller-save floating-point registers.
2529    stp   d0, d1,   [sp, #160]
2530    stp   d2, d3,   [sp, #176]
2531    stp   d4, d5,   [sp, #192]
2532    stp   d6, d7,   [sp, #208]
2533    stp   d16, d17, [sp, #224]
2534    stp   d18, d19, [sp, #240]
2535    stp   d20, d21, [sp, #256]
2536    stp   d22, d23, [sp, #272]
2537    stp   d24, d25, [sp, #288]
2538    stp   d26, d27, [sp, #304]
2539    stp   d28, d29, [sp, #320]
2540    stp   d30, d31, [sp, #336]
2541    // Save return address.
2542    // (sp + #352 is a padding slot)
2543    SAVE_REG xLR, 360
2544
2545    .ifnc \wreg, w0
2546      mov   w0, \wreg                   // Pass arg1 - obj from `wreg`
2547    .endif
2548    bl    artReadBarrierMark            // artReadBarrierMark(obj)
2549    .ifnc \wreg, w0
2550      mov   \wreg, w0                   // Return result into `wreg`
2551    .endif
2552
2553    // Restore core regs, except `xreg`, as `wreg` is used to return the
2554    // result of this function (simply remove it from the stack instead).
2555    POP_REGS_NE x0, x1,   0,   \xreg
2556    POP_REGS_NE x2, x3,   16,  \xreg
2557    POP_REGS_NE x4, x5,   32,  \xreg
2558    POP_REGS_NE x6, x7,   48,  \xreg
2559    POP_REGS_NE x8, x9,   64,  \xreg
2560    POP_REGS_NE x10, x11, 80,  \xreg
2561    POP_REGS_NE x12, x13, 96,  \xreg
2562    POP_REGS_NE x14, x15, 112, \xreg
2563    POP_REGS_NE x16, x17, 128, \xreg
2564    POP_REGS_NE x18, x19, 144, \xreg
2565    // Restore floating-point registers.
2566    ldp   d0, d1,   [sp, #160]
2567    ldp   d2, d3,   [sp, #176]
2568    ldp   d4, d5,   [sp, #192]
2569    ldp   d6, d7,   [sp, #208]
2570    ldp   d16, d17, [sp, #224]
2571    ldp   d18, d19, [sp, #240]
2572    ldp   d20, d21, [sp, #256]
2573    ldp   d22, d23, [sp, #272]
2574    ldp   d24, d25, [sp, #288]
2575    ldp   d26, d27, [sp, #304]
2576    ldp   d28, d29, [sp, #320]
2577    ldp   d30, d31, [sp, #336]
2578    // Restore return address and remove padding.
2579    RESTORE_REG xLR, 360
2580    DECREASE_FRAME 368
2581    ret
2582.Lret_forwarding_address\name:
2583    mvn wIP0, wIP0
2584    // Shift left by the forwarding address shift. This clears out the state bits since they are
2585    // in the top 2 bits of the lock word.
2586    lsl \wreg, wIP0, #LOCK_WORD_STATE_FORWARDING_ADDRESS_SHIFT
2587    ret
2588END \name
2589.endm
2590
2591READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg00, w0,  x0
2592READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg01, w1,  x1
2593READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg02, w2,  x2
2594READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg03, w3,  x3
2595READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg04, w4,  x4
2596READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg05, w5,  x5
2597READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg06, w6,  x6
2598READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg07, w7,  x7
2599READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg08, w8,  x8
2600READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg09, w9,  x9
2601READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg10, w10, x10
2602READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg11, w11, x11
2603READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg12, w12, x12
2604READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg13, w13, x13
2605READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg14, w14, x14
2606READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg15, w15, x15
2607// READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg16, w16, x16 ip0 is blocked
2608READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg17, w17, x17
2609READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg18, w18, x18
2610READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg19, w19, x19
2611READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg20, w20, x20
2612READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg21, w21, x21
2613READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg22, w22, x22
2614READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg23, w23, x23
2615READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg24, w24, x24
2616READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg25, w25, x25
2617READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg26, w26, x26
2618READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg27, w27, x27
2619READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg28, w28, x28
2620READ_BARRIER_MARK_REG art_quick_read_barrier_mark_reg29, w29, x29
2621