Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

spring runtime assembly cleaning #13033

Merged
merged 1 commit into from
May 15, 2024
Merged

spring runtime assembly cleaning #13033

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
67 changes: 29 additions & 38 deletions runtime/arm64.S
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -154,6 +154,21 @@ G(name):

#include "../runtime/caml/asm.h"

/* Function prologue and epilogue */

.macro ENTER_FUNCTION
CFI_OFFSET(29, -16)
CFI_OFFSET(30, -8)
stp x29, x30, [sp, -16]!
CFI_ADJUST(16)
add x29, sp, #0
.endm

.macro LEAVE_FUNCTION
ldp x29, x30, [sp], 16
CFI_ADJUST(-16)
.endm

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

On the ordering of CFI directives, should they be before or after the instruction they relate to? When I compile C code to get the assembly, I get the instruction first and then the CFI directive. For compiled OCaml code and runtime assembly there is a mix of before and after. Does it matter? For example on entry to a main function:

_main:                                  ; @main
	.cfi_startproc
; %bb.0:
	sub	sp, sp, #64
	.cfi_def_cfa_offset 64
	stp	x29, x30, [sp, #48]             ; 16-byte Folded Spill
	add	x29, sp, #48
	.cfi_def_cfa w29, 16
	.cfi_offset w30, -8
	.cfi_offset w29, -16
   ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My understanding is that CFI annotations must appear after the instruction which causes the changes they refer to.

/* Stack switching operations */

/* struct stack_info */
Expand Down Expand Up @@ -420,11 +435,7 @@ G(caml_system__code_begin):
FUNCTION(caml_call_realloc_stack)
CFI_STARTPROC
/* Save return address and frame pointer */
CFI_OFFSET(29, -16)
CFI_OFFSET(30, -8)
stp x29, x30, [sp, -16]!
CFI_ADJUST(16)
add x29, sp, #0
ENTER_FUNCTION
/* Save all registers (including ALLOC_PTR & TRAP_PTR) */
SAVE_ALL_REGS
ldr C_ARG_1, [sp, 16] /* argument */
Expand All @@ -434,11 +445,11 @@ FUNCTION(caml_call_realloc_stack)
cbz x0, 1f
RESTORE_ALL_REGS
/* Free stack space and return to caller */
ldp x29, x30, [sp], 16
LEAVE_FUNCTION
ret
1: RESTORE_ALL_REGS
/* Raise the Stack_overflow exception */
ldp x29, x30, [sp], 16
LEAVE_FUNCTION
add sp, sp, 16 /* pop argument */
ADDRGLOBAL(x0, caml_exn_Stack_overflow)
b G(caml_raise_exn)
Expand All @@ -449,11 +460,7 @@ FUNCTION(caml_call_gc)
CFI_STARTPROC
L(caml_call_gc):
/* Save return address and frame pointer */
CFI_OFFSET(29, -16)
CFI_OFFSET(30, -8)
stp x29, x30, [sp, -16]!
CFI_ADJUST(16)
add x29, sp, #0
ENTER_FUNCTION
/* Store all registers (including ALLOC_PTR & TRAP_PTR) */
SAVE_ALL_REGS
TSAN_ENTER_FUNCTION
Expand All @@ -464,7 +471,7 @@ L(caml_call_gc):
TSAN_EXIT_FUNCTION
RESTORE_ALL_REGS
/* Free stack space and return to caller */
ldp x29, x30, [sp], 16
LEAVE_FUNCTION
ret
CFI_ENDPROC
END_FUNCTION(caml_call_gc)
Expand Down Expand Up @@ -523,11 +530,7 @@ FUNCTION(caml_allocN)

FUNCTION(caml_c_call)
CFI_STARTPROC
CFI_OFFSET(29, -16)
CFI_OFFSET(30, -8)
stp x29, x30, [sp, -16]!
CFI_ADJUST(16)
add x29, sp, #0
ENTER_FUNCTION
TSAN_SAVE_CALLER_REGS
TSAN_ENTER_FUNCTION
TSAN_RESTORE_CALLER_REGS
Expand Down Expand Up @@ -558,7 +561,7 @@ FUNCTION(caml_c_call)
CFI_ADJUST(-16)
#endif
/* Return */
ldp x29, x30, [sp], 16
LEAVE_FUNCTION
RET_FROM_C_CALL
CFI_ENDPROC
END_FUNCTION(caml_c_call)
Expand All @@ -570,11 +573,7 @@ FUNCTION(caml_c_call_stack_args)
C function : ADDITIONAL_ARG
C stack args : begin=STACK_ARG_BEGIN
end=STACK_ARG_END */
CFI_OFFSET(29, -16)
CFI_OFFSET(30, -8)
stp x29, x30, [sp, -16]!
CFI_ADJUST(16)
add x29, sp, #0
ENTER_FUNCTION
/* Switch from OCaml to C */
SWITCH_OCAML_TO_C
/* Make the exception handler alloc ptr available to the C code */
Expand All @@ -599,7 +598,7 @@ FUNCTION(caml_c_call_stack_args)
/* Switch from C to OCaml */
SWITCH_C_TO_OCAML
/* Return */
ldp x29, x30, [sp], 16
LEAVE_FUNCTION
RET_FROM_C_CALL
CFI_ENDPROC
END_FUNCTION(caml_c_call_stack_args)
Expand Down Expand Up @@ -852,7 +851,7 @@ FUNCTION(caml_raise_exception)
CFI_ADJUST(-16)
#endif
/* Restore frame and link on return to OCaml */
ldp x29, x30, [sp], 16
LEAVE_FUNCTION
b G(caml_raise_exn)
CFI_ENDPROC
END_FUNCTION(caml_raise_exception)
Expand Down Expand Up @@ -943,9 +942,7 @@ FUNCTION(caml_callback3_asm)
Preserves old_stack and new_stack registers */
.macro SWITCH_OCAML_STACKS old_stack, new_stack
/* Save frame pointer and return address for old_stack */
stp x29, x30, [sp, -16]!
CFI_ADJUST(16)
add x29, sp, #0
ENTER_FUNCTION
/* Save OCaml SP and exn_handler in the stack info */
mov TMP, sp
str TMP, Stack_sp(\old_stack)
Expand All @@ -957,8 +954,7 @@ FUNCTION(caml_callback3_asm)
/* restore exn_handler for new stack */
ldr TRAP_PTR, Stack_exception(\new_stack)
/* Restore frame pointer and return address for new_stack */
ldp x29, x30, [sp], 16
CFI_ADJUST(-16)
LEAVE_FUNCTION
.endm


Expand Down Expand Up @@ -1129,11 +1125,7 @@ CFI_STARTPROC
/* x0: fiber
x1: fun
x2: arg */
CFI_OFFSET(29, -16)
CFI_OFFSET(30, -8)
stp x29, x30, [sp, -16]!
CFI_ADJUST(16)
add x29, sp, #0
ENTER_FUNCTION
sub x0, x0, 1 /* x0 := Ptr_val(x0) */
ldr x3, [x1] /* code pointer */
/* save old stack pointer and exception handler */
Expand Down Expand Up @@ -1201,8 +1193,7 @@ L(frame_runstack):
mov x1, x19
ldr TMP, [x19] /* code pointer */
/* Invoke handle_value (or handle_exn) */
ldp x29, x30, [sp], 16
CFI_ADJUST(-16)
LEAVE_FUNCTION
br TMP
L(fiber_exn_handler):
add x8, sp, 16 /* x8 := stack_handler */
Expand Down
51 changes: 25 additions & 26 deletions runtime/power.S
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,20 @@ caml_hot.code_end:
.size \name, . - \name
.endm

/* Function prologue and epilogue */

.macro ENTER_FUNCTION
/* Save return address in caller's frame. */
mflr 0
std 0, LR_SAVE(SP)
.endm

.macro LEAVE_FUNCTION
/* Restore return address. */
ld 0, LR_SAVE(SP)
mtlr 0
.endm

/* Accessing global variables. */

#define LSYMB(glob) .L##glob
Expand Down Expand Up @@ -260,9 +274,7 @@ caml_hot.code_end:
#if defined(WITH_THREAD_SANITIZER) /* { */

.macro TSAN_SETUP_C_CALL size
/* Save return address in caller's frame. */
mflr 0
std 0, LR_SAVE(SP)
ENTER_FUNCTION
/* Setup new frame for a function call and possibly some register saves. */
addi SP, SP, -(RESERVED_STACK + \size)
std 2, TOC_SAVE(SP)
Expand All @@ -271,9 +283,7 @@ caml_hot.code_end:
.macro TSAN_CLEANUP_AFTER_C_CALL size
/* Undo call frame. */
addi SP, SP, (RESERVED_STACK + \size)
/* Restore return address. */
ld 0, LR_SAVE(SP)
mtlr 0
LEAVE_FUNCTION
.endm

.macro TSAN_ENTER_FUNCTION
Expand Down Expand Up @@ -381,9 +391,7 @@ caml_system__code_begin:
/* Desired size is passed in register TMP2. */

FUNCTION caml_call_realloc_stack
/* Save return address in caller's frame. */
mflr 0
std 0, LR_SAVE(SP)
ENTER_FUNCTION
/* Save all registers, as well as ALLOC_PTR and TRAP_PTR */
SAVE_ALL_REGS /* TMP2 is preserved */
/* Recover desired size, to be passed in r3 */
Expand All @@ -395,8 +403,7 @@ FUNCTION caml_call_realloc_stack
cmpdi 3, 0
/* Restore all registers, and also return address */
RESTORE_ALL_REGS
ld 0, LR_SAVE(SP)
mtlr 0
LEAVE_FUNCTION
/* Check status */
beq 1f
/* Reallocation successful: return to caller */
Expand All @@ -409,9 +416,7 @@ ENDFUNCTION caml_call_realloc_stack
/* Invoke the garbage collector. */

FUNCTION caml_call_gc
/* Save return address in caller's frame */
mflr 0
std 0, LR_SAVE(SP)
ENTER_FUNCTION
/* Save all registers, as well as ALLOC_PTR and TRAP_PTR */
SAVE_ALL_REGS
TSAN_ENTER_FUNCTION
Expand All @@ -427,8 +432,7 @@ FUNCTION caml_call_gc
SWITCH_C_TO_OCAML
/* Restore registers and return to caller */
RESTORE_ALL_REGS
ld 0, LR_SAVE(SP)
mtlr 0
LEAVE_FUNCTION
ld 2, TOC_SAVE(SP)
blr
ENDFUNCTION caml_call_gc
Expand Down Expand Up @@ -604,8 +608,7 @@ FUNCTION caml_raise_exception
ld TMP, Caml_state(current_stack)
ld SP, Stack_sp(TMP)
/* Reload return address from caller's frame (for the backtrace) */
ld 0, LR_SAVE(SP)
mtlr 0
LEAVE_FUNCTION
#if defined(WITH_THREAD_SANITIZER)
/* Call __tsan_func_exit for every OCaml stack frame exited due to the
exception */
Expand Down Expand Up @@ -893,8 +896,7 @@ ENDFUNCTION caml_callback3_asm
Preserves old_stack and new_stack registers */
.macro SWITCH_OCAML_STACKS old_stack, new_stack
/* Save return address for old_stack */
mflr 0
std 0, LR_SAVE(SP)
ENTER_FUNCTION
/* Save OCaml SP and exn_handler in the stack info */
std SP, Stack_sp(\old_stack)
std TRAP_PTR, Stack_exception(\old_stack)
Expand All @@ -904,8 +906,7 @@ ENDFUNCTION caml_callback3_asm
/* restore exn_handler for new stack */
ld TRAP_PTR, Stack_exception(\new_stack)
/* Restore return address for new_stack */
ld 0, LR_SAVE(SP)
mtlr 0
LEAVE_FUNCTION
.endm

/*
Expand Down Expand Up @@ -1090,8 +1091,7 @@ FUNCTION caml_runstack
r4: fun
r5: arg */
/* save return address and TOC on old stack */
mflr 0
std 0, LR_SAVE(SP)
ENTER_FUNCTION
std 2, TOC_SAVE_PARENT(SP)
addi 3, 3, -1 /* r3 := Ptr_val(r3) */
ld 12, 0(4) /* r12 := code pointer */
Expand Down Expand Up @@ -1158,8 +1158,7 @@ FUNCTION caml_runstack
ld 12, 0(4) /* code pointer */
mtctr 12 /* code pointer */
/* Invoke handle_value (or handle_exn) */
ld 0, LR_SAVE(SP)
mtlr 0
LEAVE_FUNCTION
bctr
.Lfiber_exn_handler:
addi 8, SP, (RESERVED_STACK + 16) /* r8 := stack_handler */
Expand Down