// Copyright 2017 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

//! This module defines the `__rust_probestack` intrinsic which is used in the
//! implementation of "stack probes" on certain platforms.
//!
//! The purpose of a stack probe is to provide a static guarantee that if a
//! thread has a guard page then a stack overflow is guaranteed to hit that
//! guard page. If a function did not have a stack probe then there's a risk of
//! having a stack frame *larger* than the guard page, so a function call could
//! skip over the guard page entirely and then later hit maybe the heap or
//! another thread, possibly leading to security vulnerabilities such as [The
//! Stack Clash], for example.
//!
//! [The Stack Clash]: https://blog.qualys.com/securitylabs/2017/06/19/the-stack-clash
//!
//! The `__rust_probestack` is called in the prologue of functions whose stack
//! size is larger than the guard page, for example larger than 4096 bytes on
//! x86. This function is then responsible for "touching" all pages relevant to
//! the stack to ensure that that if any of them are the guard page we'll hit
//! them guaranteed.
//!
//! The precise ABI for how this function operates is defined by LLVM. There's
//! no real documentation as to what this is, so you'd basically need to read
//! the LLVM source code for reference. Often though the test cases can be
//! illuminating as to the ABI that's generated, or just looking at the output
//! of `llc`.
//!
//! Note that `#[naked]` is typically used here for the stack probe because the
//! ABI corresponds to no actual ABI.
//!
//! Finally it's worth noting that at the time of this writing LLVM only has
//! support for stack probes on x86 and x86_64. There's no support for stack
//! probes on any other architecture like ARM or PowerPC64. LLVM I'm sure would
//! be more than welcome to accept such a change!

#![cfg(not(feature = "mangled-names"))]
// Windows and Cygwin already has builtins to do this.
#![cfg(not(any(windows, target_os = "cygwin")))]
// We only define stack probing for these architectures today.
#![cfg(any(target_arch = "x86_64", target_arch = "x86"))]

// Our goal here is to touch each page between `rsp+8` and `rsp+8-rax`,
// ensuring that if any pages are unmapped we'll make a page fault.
//
// The ABI here is that the stack frame size is located in `rax`. Upon
// return we're not supposed to modify `rsp` or `rax`.
#[cfg(target_arch = "x86_64")]
#[unsafe(naked)]
#[rustc_std_internal_symbol]
pub unsafe extern "custom" fn __rust_probestack() {
    core::arch::naked_asm!(
        "
            .cfi_startproc
            push  rbp
            .cfi_adjust_cfa_offset 8
            .cfi_offset rbp, -16
            mov   rbp, rsp
            .cfi_def_cfa_register rbp

            mov    r11, rax        // duplicate rax as we're clobbering r11

            // Main loop, taken in one page increments. We're decrementing rsp by
            // a page each time until there's less than a page remaining. We're
            // guaranteed that this function isn't called unless there's more than a
            // page needed.
            //
            // Note that we're also testing against `[rsp + 8]` to account for the 8
            // bytes pushed on the stack originally with our return address. Using
            // `[rsp + 8]` simulates us testing the stack pointer in the caller's
            // context.

            // It's usually called when rax >= 0x1000, but that's not always true.
            // Dynamic stack allocation, which is needed to implement unsized
            // rvalues, triggers stackprobe even if rax < 0x1000.
            // Thus we have to check r11 first to avoid segfault.
            cmp    r11, 0x1000
            jna    3f
        2:
            sub    rsp, 0x1000
            test   qword ptr [rsp + 8], rsp
            sub    r11, 0x1000
            cmp    r11, 0x1000
            ja     2b

        3:
            // Finish up the last remaining stack space requested, getting the last
            // bits out of r11
            sub    rsp, r11
            test   qword ptr [rsp + 8], rsp

            // Restore the stack pointer to what it previously was when entering
            // this function. The caller will readjust the stack pointer after we
            // return.
            add    rsp, rax

            leave
            .cfi_def_cfa_register rsp
            .cfi_adjust_cfa_offset -8
    ",
    #[cfg(not(all(target_env = "sgx", target_vendor = "fortanix")))]
    "       ret",
    #[cfg(all(target_env = "sgx", target_vendor = "fortanix"))]
    "
            // for this target, [manually patch for LVI].
            //
            // [manually patch for LVI]: https://software.intel.com/security-software-guidance/insights/deep-dive-load-value-injection#specialinstructions
            pop r11
            lfence
            jmp r11
    ",
    "
            .cfi_endproc
    ",
    )
}

#[cfg(all(target_arch = "x86", not(target_os = "uefi")))]
// This is the same as x86_64 above, only translated for 32-bit sizes. Note
// that on Unix we're expected to restore everything as it was, this
// function basically can't tamper with anything.
//
// The ABI here is the same as x86_64, except everything is 32-bits large.
#[unsafe(naked)]
#[rustc_std_internal_symbol]
pub unsafe extern "custom" fn __rust_probestack() {
    core::arch::naked_asm!(
        "
            .cfi_startproc
            push   ebp
            .cfi_adjust_cfa_offset 4
            .cfi_offset ebp, -8
            mov    ebp, esp
            .cfi_def_cfa_register ebp
            push   ecx
            mov    ecx, eax

            cmp    ecx, 0x1000
            jna    3f
        2:
            sub    esp, 0x1000
            test   dword ptr [esp + 8], esp
            sub    ecx, 0x1000
            cmp    ecx, 0x1000
            ja     2b

        3:
            sub    esp, ecx
            test   dword ptr [esp + 8], esp

            add    esp, eax
            pop    ecx
            leave
            .cfi_def_cfa_register esp
            .cfi_adjust_cfa_offset -4
            ret
            .cfi_endproc
        ",
    )
}

#[cfg(all(target_arch = "x86", target_os = "uefi"))]
// UEFI target is windows like target. LLVM will do _chkstk things like windows.
// probestack function will also do things like _chkstk in MSVC.
// So we need to sub %ax %sp in probestack when arch is x86.
//
// REF: Rust commit(74e80468347)
// rust\src\llvm-project\llvm\lib\Target\X86\X86FrameLowering.cpp: 805
// Comments in LLVM:
//   MSVC x32's _chkstk and cygwin/mingw's _alloca adjust esp themselves.
//   MSVC x64's __chkstk and cygwin/mingw's ___chkstk_ms do not adjust `rsp`
//   themselves.
#[unsafe(naked)]
#[rustc_std_internal_symbol]
pub unsafe extern "custom" fn __rust_probestack() {
    core::arch::naked_asm!(
        "
            .cfi_startproc
            push   ebp
            .cfi_adjust_cfa_offset 4
            .cfi_offset ebp, -8
            mov    ebp, esp
            .cfi_def_cfa_register ebp
            push   ecx
            push   edx
            mov    ecx, eax

            cmp    ecx, 0x1000
            jna    3f
        2:
            sub    esp, 0x1000
            test   dword ptr [esp + 8], esp
            sub    ecx, 0x1000
            cmp    ecx, 0x1000
            ja     2b

        3:
            sub    esp, ecx
            test   dword ptr [esp + 8], esp
            mov    edx, dword ptr [ebp + 4]
            mov    dword ptr [esp + 12], edx
            add    esp, eax
            pop    edx
            pop    ecx
            leave

            sub   esp, eax
            .cfi_def_cfa_register esp
            .cfi_adjust_cfa_offset -4
            ret
            .cfi_endproc
        ",
    )
}
