Gh0st
/
linux
mirror of https://github.com/torvalds/linux.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

x86/sgx: Add kernel-doc descriptions for params passed to vDSO user handler 

Add kernel-doc markup for the register parameters passed by the vDSO blob
to the user handler to suppress build warnings, e.g.

  WARNING: arch/x86/include/uapi/asm/sgx.h:157 function parameter 'r8' not
           described in 'sgx_enclave_user_handler_t'

Call out that except for RSP, the registers are undefined on asynchronous
exits as far as the vDSO ABI is concerned.  E.g. the vDSO's exception
handler clobbers RDX, RDI, and RSI, and the kernel doesn't guarantee that
R8 or R9 will be zero (the synthetic value loaded by the CPU).

Closes: https://lore.kernel.org/all/20251106145506.145fc620@canb.auug.org.au
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Sean Christopherson <seanjc@google.com>
Signed-off-by: Dave Hansen <dave.hansen@linux.intel.com>
Reviewed-by: Kai Huang <kai.huang@intel.com>
Link: https://patch.msgid.link/20251112160708.1343355-3-seanjc%40google.com
This commit is contained in:
Sean Christopherson 2025-11-12 08:07:05 -08:00 committed by Dave Hansen
parent 75801ca620
commit 243ea511fe
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
arch/x86/include/uapi/asm/sgx.h
View File

@ -143,6 +143,12 @@ struct sgx_enclave_run;
/** /**
* typedef sgx_enclave_user_handler_t - Exit handler function accepted by * typedef sgx_enclave_user_handler_t - Exit handler function accepted by
* __vdso_sgx_enter_enclave() * __vdso_sgx_enter_enclave()
* @rdi: RDI at the time of EEXIT, undefined on AEX
* @rsi: RSI at the time of EEXIT, undefined on AEX
* @rdx: RDX at the time of EEXIT, undefined on AEX
* @rsp: RSP (untrusted) at the time of EEXIT or AEX
* @r8: R8 at the time of EEXIT, undefined on AEX
* @r9: R9 at the time of EEXIT, undefined on AEX
* @run: The run instance given by the caller * @run: The run instance given by the caller
* *
* The register parameters contain the snapshot of their values at enclave * The register parameters contain the snapshot of their values at enclave