mirror of
https://github.com/torvalds/linux
synced 2024-10-16 16:29:20 +00:00
9849bb2715
The SGX2 page removal flow was introduced in previous patch and is as follows: 1) Change the type of the pages to be removed to SGX_PAGE_TYPE_TRIM using the ioctl() SGX_IOC_ENCLAVE_MODIFY_TYPES introduced in previous patch. 2) Approve the page removal by running ENCLU[EACCEPT] from within the enclave. 3) Initiate actual page removal using the ioctl() SGX_IOC_ENCLAVE_REMOVE_PAGES introduced here. Support the final step of the SGX2 page removal flow with ioctl() SGX_IOC_ENCLAVE_REMOVE_PAGES. With this ioctl() the user specifies a page range that should be removed. All pages in the provided range should have the SGX_PAGE_TYPE_TRIM page type and the request will fail with EPERM (Operation not permitted) if a page that does not have the correct type is encountered. Page removal can fail on any page within the provided range. Support partial success by returning the number of pages that were successfully removed. Since actual page removal will succeed even if ENCLU[EACCEPT] was not run from within the enclave the ENCLU[EMODPR] instruction with RWX permissions is used as a no-op mechanism to ensure ENCLU[EACCEPT] was successfully run from within the enclave before the enclave page is removed. If the user omits running SGX_IOC_ENCLAVE_REMOVE_PAGES the pages will still be removed when the enclave is unloaded. Signed-off-by: Reinette Chatre <reinette.chatre@intel.com> Signed-off-by: Dave Hansen <dave.hansen@linux.intel.com> Reviewed-by: Jarkko Sakkinen <jarkko@kernel.org> Tested-by: Haitao Huang <haitao.huang@intel.com> Tested-by: Vijay Dhanraj <vijay.dhanraj@intel.com> Tested-by: Jarkko Sakkinen <jarkko@kernel.org> Link: https://lkml.kernel.org/r/b75ee93e96774e38bb44a24b8e9bbfb67b08b51b.1652137848.git.reinette.chatre@intel.com
233 lines
8.2 KiB
C
233 lines
8.2 KiB
C
/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
|
|
/*
|
|
* Copyright(c) 2016-20 Intel Corporation.
|
|
*/
|
|
#ifndef _UAPI_ASM_X86_SGX_H
|
|
#define _UAPI_ASM_X86_SGX_H
|
|
|
|
#include <linux/types.h>
|
|
#include <linux/ioctl.h>
|
|
|
|
/**
|
|
* enum sgx_page_flags - page control flags
|
|
* %SGX_PAGE_MEASURE: Measure the page contents with a sequence of
|
|
* ENCLS[EEXTEND] operations.
|
|
*/
|
|
enum sgx_page_flags {
|
|
SGX_PAGE_MEASURE = 0x01,
|
|
};
|
|
|
|
#define SGX_MAGIC 0xA4
|
|
|
|
#define SGX_IOC_ENCLAVE_CREATE \
|
|
_IOW(SGX_MAGIC, 0x00, struct sgx_enclave_create)
|
|
#define SGX_IOC_ENCLAVE_ADD_PAGES \
|
|
_IOWR(SGX_MAGIC, 0x01, struct sgx_enclave_add_pages)
|
|
#define SGX_IOC_ENCLAVE_INIT \
|
|
_IOW(SGX_MAGIC, 0x02, struct sgx_enclave_init)
|
|
#define SGX_IOC_ENCLAVE_PROVISION \
|
|
_IOW(SGX_MAGIC, 0x03, struct sgx_enclave_provision)
|
|
#define SGX_IOC_VEPC_REMOVE_ALL \
|
|
_IO(SGX_MAGIC, 0x04)
|
|
#define SGX_IOC_ENCLAVE_RESTRICT_PERMISSIONS \
|
|
_IOWR(SGX_MAGIC, 0x05, struct sgx_enclave_restrict_permissions)
|
|
#define SGX_IOC_ENCLAVE_MODIFY_TYPES \
|
|
_IOWR(SGX_MAGIC, 0x06, struct sgx_enclave_modify_types)
|
|
#define SGX_IOC_ENCLAVE_REMOVE_PAGES \
|
|
_IOWR(SGX_MAGIC, 0x07, struct sgx_enclave_remove_pages)
|
|
|
|
/**
|
|
* struct sgx_enclave_create - parameter structure for the
|
|
* %SGX_IOC_ENCLAVE_CREATE ioctl
|
|
* @src: address for the SECS page data
|
|
*/
|
|
struct sgx_enclave_create {
|
|
__u64 src;
|
|
};
|
|
|
|
/**
|
|
* struct sgx_enclave_add_pages - parameter structure for the
|
|
* %SGX_IOC_ENCLAVE_ADD_PAGE ioctl
|
|
* @src: start address for the page data
|
|
* @offset: starting page offset
|
|
* @length: length of the data (multiple of the page size)
|
|
* @secinfo: address for the SECINFO data
|
|
* @flags: page control flags
|
|
* @count: number of bytes added (multiple of the page size)
|
|
*/
|
|
struct sgx_enclave_add_pages {
|
|
__u64 src;
|
|
__u64 offset;
|
|
__u64 length;
|
|
__u64 secinfo;
|
|
__u64 flags;
|
|
__u64 count;
|
|
};
|
|
|
|
/**
|
|
* struct sgx_enclave_init - parameter structure for the
|
|
* %SGX_IOC_ENCLAVE_INIT ioctl
|
|
* @sigstruct: address for the SIGSTRUCT data
|
|
*/
|
|
struct sgx_enclave_init {
|
|
__u64 sigstruct;
|
|
};
|
|
|
|
/**
|
|
* struct sgx_enclave_provision - parameter structure for the
|
|
* %SGX_IOC_ENCLAVE_PROVISION ioctl
|
|
* @fd: file handle of /dev/sgx_provision
|
|
*/
|
|
struct sgx_enclave_provision {
|
|
__u64 fd;
|
|
};
|
|
|
|
/**
|
|
* struct sgx_enclave_restrict_permissions - parameters for ioctl
|
|
* %SGX_IOC_ENCLAVE_RESTRICT_PERMISSIONS
|
|
* @offset: starting page offset (page aligned relative to enclave base
|
|
* address defined in SECS)
|
|
* @length: length of memory (multiple of the page size)
|
|
* @permissions:new permission bits for pages in range described by @offset
|
|
* and @length
|
|
* @result: (output) SGX result code of ENCLS[EMODPR] function
|
|
* @count: (output) bytes successfully changed (multiple of page size)
|
|
*/
|
|
struct sgx_enclave_restrict_permissions {
|
|
__u64 offset;
|
|
__u64 length;
|
|
__u64 permissions;
|
|
__u64 result;
|
|
__u64 count;
|
|
};
|
|
|
|
/**
|
|
* struct sgx_enclave_modify_types - parameters for ioctl
|
|
* %SGX_IOC_ENCLAVE_MODIFY_TYPES
|
|
* @offset: starting page offset (page aligned relative to enclave base
|
|
* address defined in SECS)
|
|
* @length: length of memory (multiple of the page size)
|
|
* @page_type: new type for pages in range described by @offset and @length
|
|
* @result: (output) SGX result code of ENCLS[EMODT] function
|
|
* @count: (output) bytes successfully changed (multiple of page size)
|
|
*/
|
|
struct sgx_enclave_modify_types {
|
|
__u64 offset;
|
|
__u64 length;
|
|
__u64 page_type;
|
|
__u64 result;
|
|
__u64 count;
|
|
};
|
|
|
|
/**
|
|
* struct sgx_enclave_remove_pages - %SGX_IOC_ENCLAVE_REMOVE_PAGES parameters
|
|
* @offset: starting page offset (page aligned relative to enclave base
|
|
* address defined in SECS)
|
|
* @length: length of memory (multiple of the page size)
|
|
* @count: (output) bytes successfully changed (multiple of page size)
|
|
*
|
|
* Regular (PT_REG) or TCS (PT_TCS) can be removed from an initialized
|
|
* enclave if the system supports SGX2. First, the %SGX_IOC_ENCLAVE_MODIFY_TYPES
|
|
* ioctl() should be used to change the page type to PT_TRIM. After that
|
|
* succeeds ENCLU[EACCEPT] should be run from within the enclave and then
|
|
* %SGX_IOC_ENCLAVE_REMOVE_PAGES can be used to complete the page removal.
|
|
*/
|
|
struct sgx_enclave_remove_pages {
|
|
__u64 offset;
|
|
__u64 length;
|
|
__u64 count;
|
|
};
|
|
|
|
struct sgx_enclave_run;
|
|
|
|
/**
|
|
* typedef sgx_enclave_user_handler_t - Exit handler function accepted by
|
|
* __vdso_sgx_enter_enclave()
|
|
* @run: The run instance given by the caller
|
|
*
|
|
* The register parameters contain the snapshot of their values at enclave
|
|
* exit. An invalid ENCLU function number will cause -EINVAL to be returned
|
|
* to the caller.
|
|
*
|
|
* Return:
|
|
* - <= 0: The given value is returned back to the caller.
|
|
* - > 0: ENCLU function to invoke, either EENTER or ERESUME.
|
|
*/
|
|
typedef int (*sgx_enclave_user_handler_t)(long rdi, long rsi, long rdx,
|
|
long rsp, long r8, long r9,
|
|
struct sgx_enclave_run *run);
|
|
|
|
/**
|
|
* struct sgx_enclave_run - the execution context of __vdso_sgx_enter_enclave()
|
|
* @tcs: TCS used to enter the enclave
|
|
* @function: The last seen ENCLU function (EENTER, ERESUME or EEXIT)
|
|
* @exception_vector: The interrupt vector of the exception
|
|
* @exception_error_code: The exception error code pulled out of the stack
|
|
* @exception_addr: The address that triggered the exception
|
|
* @user_handler: User provided callback run on exception
|
|
* @user_data: Data passed to the user handler
|
|
* @reserved Reserved for future extensions
|
|
*
|
|
* If @user_handler is provided, the handler will be invoked on all return paths
|
|
* of the normal flow. The user handler may transfer control, e.g. via a
|
|
* longjmp() call or a C++ exception, without returning to
|
|
* __vdso_sgx_enter_enclave().
|
|
*/
|
|
struct sgx_enclave_run {
|
|
__u64 tcs;
|
|
__u32 function;
|
|
__u16 exception_vector;
|
|
__u16 exception_error_code;
|
|
__u64 exception_addr;
|
|
__u64 user_handler;
|
|
__u64 user_data;
|
|
__u8 reserved[216];
|
|
};
|
|
|
|
/**
|
|
* typedef vdso_sgx_enter_enclave_t - Prototype for __vdso_sgx_enter_enclave(),
|
|
* a vDSO function to enter an SGX enclave.
|
|
* @rdi: Pass-through value for RDI
|
|
* @rsi: Pass-through value for RSI
|
|
* @rdx: Pass-through value for RDX
|
|
* @function: ENCLU function, must be EENTER or ERESUME
|
|
* @r8: Pass-through value for R8
|
|
* @r9: Pass-through value for R9
|
|
* @run: struct sgx_enclave_run, must be non-NULL
|
|
*
|
|
* NOTE: __vdso_sgx_enter_enclave() does not ensure full compliance with the
|
|
* x86-64 ABI, e.g. doesn't handle XSAVE state. Except for non-volatile
|
|
* general purpose registers, EFLAGS.DF, and RSP alignment, preserving/setting
|
|
* state in accordance with the x86-64 ABI is the responsibility of the enclave
|
|
* and its runtime, i.e. __vdso_sgx_enter_enclave() cannot be called from C
|
|
* code without careful consideration by both the enclave and its runtime.
|
|
*
|
|
* All general purpose registers except RAX, RBX and RCX are passed as-is to the
|
|
* enclave. RAX, RBX and RCX are consumed by EENTER and ERESUME and are loaded
|
|
* with @function, asynchronous exit pointer, and @run.tcs respectively.
|
|
*
|
|
* RBP and the stack are used to anchor __vdso_sgx_enter_enclave() to the
|
|
* pre-enclave state, e.g. to retrieve @run.exception and @run.user_handler
|
|
* after an enclave exit. All other registers are available for use by the
|
|
* enclave and its runtime, e.g. an enclave can push additional data onto the
|
|
* stack (and modify RSP) to pass information to the optional user handler (see
|
|
* below).
|
|
*
|
|
* Most exceptions reported on ENCLU, including those that occur within the
|
|
* enclave, are fixed up and reported synchronously instead of being delivered
|
|
* via a standard signal. Debug Exceptions (#DB) and Breakpoints (#BP) are
|
|
* never fixed up and are always delivered via standard signals. On synchronously
|
|
* reported exceptions, -EFAULT is returned and details about the exception are
|
|
* recorded in @run.exception, the optional sgx_enclave_exception struct.
|
|
*
|
|
* Return:
|
|
* - 0: ENCLU function was successfully executed.
|
|
* - -EINVAL: Invalid ENCL number (neither EENTER nor ERESUME).
|
|
*/
|
|
typedef int (*vdso_sgx_enter_enclave_t)(unsigned long rdi, unsigned long rsi,
|
|
unsigned long rdx, unsigned int function,
|
|
unsigned long r8, unsigned long r9,
|
|
struct sgx_enclave_run *run);
|
|
|
|
#endif /* _UAPI_ASM_X86_SGX_H */
|