8346775: Improve os::current_stack_pointer

[TheShermanTanker]

os::current_stack_pointer has many varying implementations, some of which are erroneous. Additionally, this does not play well with Link Time Optimization, which often inlines the method into the caller, causing various issues such as the method return the frame pointer of the caller rather than the stack pointer, or the address of a dummy local, for instance. Improve os::current_stack_pointer to work correctly with Link Time Optimization and be more robust to errors, so that it returns the accurate value of the stack pointer, documented below

Current ways used to load the stack pointer:
BSD/Zero:

address os::current_stack_pointer() {
  address dummy = (address) &dummy;
  return dummy;
}

BSD/x86:

address os::current_stack_pointer() {
#if defined(__clang__) || defined(__llvm__)
  void *esp;
  __asm__("mov %%" SPELL_REG_SP ", %0":"=r"(esp));
  return (address) esp;
#else
  register void *esp __asm__ (SPELL_REG_SP);
  return (address) esp;
#endif
}

BSD/ARM64:

address os::current_stack_pointer() {
#if defined(__clang__) || defined(__llvm__)
  void *sp;
  __asm__("mov %0, " SPELL_REG_SP : "=r"(sp));
  return (address) sp;
#else
  register void *sp __asm__ (SPELL_REG_SP);
  return (address) sp;
#endif
}

AIX/PPC:

address os::current_stack_pointer() {
  return (address)__builtin_frame_address(0);
}

Windows/ARM64:

PRAGMA_DISABLE_MSVC_WARNING(4172)
// Returns an estimate of the current stack pointer. Result must be guaranteed
// to point into the calling threads stack, and be no lower than the current
// stack pointer.
address os::current_stack_pointer() {
  int dummy;
  address sp = (address)&dummy;
  return sp;
}

Windows/x86:

// Returns the current stack pointer. Accurate value needed for
// os::verify_stack_alignment().
address os::current_stack_pointer() {
  typedef address get_sp_func();
  get_sp_func* func = CAST_TO_FN_PTR(get_sp_func*,
                                     StubRoutines::x86::get_previous_sp_entry());
  return (*func)();
}

Linux/Zero:

address os::current_stack_pointer() {
  // return the address of the current function
  return (address)__builtin_frame_address(0);
}

Linux/x86:

address os::current_stack_pointer() {
  return (address)__builtin_frame_address(0);
}

Linux/ARM64:

NOINLINE address os::current_stack_pointer() {
  return (address)__builtin_frame_address(0);
}

Linux/ARM:

address os::current_stack_pointer() {
  register address sp __asm__ (SPELL_REG_SP);
  return sp;
}

Linux/RISC-V:

NOINLINE address os::current_stack_pointer() {
  return (address)__builtin_frame_address(0);
}

Linux/s390x:

address os::current_stack_pointer() {
  intptr_t* csp;

  // Inline assembly for `z_lgr regno(csp), Z_SP' (Z_SP = Z_R15):
  __asm__ __volatile__ ("lgr %0, 15":"=r"(csp):);

  assert(((uint64_t)csp & (frame::alignment_in_bytes-1)) == 0, "SP must be aligned");
  return (address) csp;
}

Linux/PPC:

address os::current_stack_pointer() {
  return (address)__builtin_frame_address(0);
}

The assembly below indicates how to load the stack pointer in assembly for each supported architecture (Created via __builtin_stack_address with gcc):

void *current_stack_pointer() noexcept {
    return reinterpret_cast<void *>(reinterpret_cast<uintptr_t>(__builtin_stack_address()) + sizeof (void *));
}

x64:

lea     rax, [rsp+8]

mov     rax, rsp
ret

x86:

lea     eax, [esp+4]

mov     eax, esp
ret

ARM64:

add     x0, sp, 8

mov     x0, sp
ret

ARM:

add     r0, sp, #4

mov     r0, sp
bx      lr

RISC-V:

addi    a0,sp,8

mv      a0,sp
ret

s390x:

la      %r2,8(%r15)

lgr     %r2,%r15
br      %r14

PPC:

addi 3,1,8

mr 3,1
blr

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue

Issue

• JDK-8346775: Improve os::current_stack_pointer (Enhancement - P4)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/22864/head:pull/22864
$ git checkout pull/22864

Update a local copy of the PR:
$ git checkout pull/22864
$ git pull https://git.openjdk.org/jdk.git pull/22864/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 22864

View PR using the GUI difftool:
$ git pr show -t 22864

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/22864.diff

[bridgekeeper]

👋 Welcome back jwaters! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

❗ This change is not yet ready to be integrated.
See the Progress checklist in the description for automated requirements.

[openjdk]

@TheShermanTanker The following label will be automatically applied to this pull request:

• hotspot

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.