exception.h

Go to the documentation of this file.

// Copyright (c) Open Enclave SDK contributors.
// Licensed under the MIT License.
 
#ifndef _OE_BITS_EXCEPTION_H
#define _OE_BITS_EXCEPTION_H
 
#include <openenclave/bits/defs.h>
#include <openenclave/bits/types.h>
 
OE_EXTERNC_BEGIN
 
#define OE_EXCEPTION_CONTINUE_SEARCH 0x0
 
#define OE_EXCEPTION_CONTINUE_EXECUTION 0xFFFFFFFF
 
#define OE_EXCEPTION_ABORT_EXECUTION 0xFFFFFFF0
 
#define OE_EXCEPTION_DIVIDE_BY_ZERO 0x0
 
#define OE_EXCEPTION_BREAKPOINT 0x1
 
#define OE_EXCEPTION_BOUND_OUT_OF_RANGE 0x2
 
#define OE_EXCEPTION_ILLEGAL_INSTRUCTION 0x3
 
#define OE_EXCEPTION_ACCESS_VIOLATION 0x4
 
#define OE_EXCEPTION_PAGE_FAULT 0x5
 
#define OE_EXCEPTION_X87_FLOAT_POINT 0x6
 
#define OE_EXCEPTION_MISALIGNMENT 0x7
 
#define OE_EXCEPTION_SIMD_FLOAT_POINT 0x8
 
#define OE_EXCEPTION_UNKNOWN 0xFFFFFFFF
 
#define OE_EXCEPTION_FLAGS_HARDWARE 0x1
 
#define OE_EXCEPTION_FLAGS_SOFTWARE 0x2
 
#define OE_SGX_PAGE_FAULT_P_FLAG 0x1
 
#define OE_SGX_PAGE_FAULT_WR_FLAG 0x2
 
#define OE_SGX_PAGE_FAULT_US_FLAG 0x4
 
#define OE_SGX_PAGE_FAULT_RSVD 0x8
 
#define OE_SGX_PAGE_FAULT_ID_FLAG 0x10
 
#define OE_SGX_PAGE_FAULT_PK_FLAG 0x20
 
#define OE_SGX_PAGE_FAULT_SGX_FLAG 0x8000
 
typedef struct _oe_basic_xstate
{
    uint8_t blob[512]; 
} OE_ALIGNED(16) oe_basic_xstate_t;
typedef struct _oe_context
{
    uint64_t flags;
 
    uint64_t rax; 
    uint64_t rbx; 
    uint64_t rcx; 
    uint64_t rdx; 
    uint64_t rbp; 
    uint64_t rsp; 
    uint64_t rdi; 
    uint64_t rsi; 
    uint64_t r8; 
    uint64_t r9; 
    uint64_t r10; 
    uint64_t r11; 
    uint64_t r12; 
    uint64_t r13; 
    uint64_t r14; 
    uint64_t r15; 
    uint64_t rip; 
    // Don't need to manipulate the segment registers directly.
    // Ignore them: CS, DS, ES, SS, GS, and FS.
 
    uint32_t mxcsr; 
    oe_basic_xstate_t basic_xstate; 
    // Don't need to manipulate other XSTATE (AVX etc.).
} oe_context_t;
typedef struct _oe_exception_record
{
    uint32_t code; 
    uint32_t flags; 
    uint64_t address; 
    /* Information for PF/GP exceptions, which are only available
     * for SGX2 and requires application opt-in (set CapturePFGPExceptions=1).
     */
    uint64_t faulting_address;
    uint32_t error_code;
 
    /* The signal number passed by the host. Some applications might
     * want to implement special exception handling logic based
     * on this information. However, please use with caution as the
     * host-passed information is untrusted in the SGX threat model. */
    uint16_t host_signal_number;
 
    oe_context_t* context; 
} oe_exception_record_t;
typedef uint64_t (*oe_vectored_exception_handler_t)(
    oe_exception_record_t* exception_context);
 
OE_EXTERNC_END
 
#endif /* _OE_BITS_EXCEPTION_H */