1 /* This symbol is used at runtime to figure out the virtual address that the */
2 /* enclave is loaded at. */
7 .section ".note.x86_64-fortanix-unknown-sgx", "", @note
9 .long 1f - 0f /* name length (not including padding) */
10 .long 3f - 2f /* desc length (not including padding) */
11 .long 1 /* type = NT_VERSION */
12 0: .asciz "toolchain-version" /* name */
14 2: .long 0 /* desc - toolchain version number, 32-bit LE */
18 /* The XSAVE area needs to be a large chunk of readable memory, but since we are */
19 /* going to restore everything to its initial state (XSTATE_BV=0), only certain */
20 /* parts need to have a defined value. In particular: */
22 /* * MXCSR in the legacy area. This register is always restored if RFBM[1] or */
23 /* RFBM[2] is set, regardless of the value of XSTATE_BV */
31 /* We can store a bunch of data in the gap between MXCSR and the XSAVE header */
33 /* The following symbols point at read-only data that will be filled in by the */
36 /* When using this macro, don't forget to adjust the linker version script! */
37 .macro globvar name:req size:req
45 /* The base address (relative to enclave start) of the heap area */
47 /* The heap size in bytes */
49 /* Value of the RELA entry in the dynamic table */
51 /* Value of the RELACOUNT entry in the dynamic table */
53 /* The enclave size in bytes */
54 globvar ENCLAVE_SIZE 8
55 /* The base address (relative to enclave start) of the enclave configuration area */
56 globvar CFGDATA_BASE 8
57 /* Non-zero if debugging is enabled, zero otherwise */
59 /* The base address (relative to enclave start) of the enclave text section */
61 /* The size in bytes of enclacve text section */
63 /* The base address (relative to enclave start) of the enclave EH_FRM_HDR section */
64 globvar EH_FRM_HDR_BASE 8
65 /* The size in bytes of enclacve EH_FRM_HDR section */
66 globvar EH_FRM_HDR_SIZE 8
68 .org .Lxsave_clear+512
70 .int 0, 0 /* XSTATE_BV */
71 .int 0, 0 /* XCOMP_BV */
72 .org .+48 /* reserved bits */
78 /* TCS local storage section */
79 .equ tcsls_tos, 0x00 /* initialized by loader to *offset* from image base to TOS */
80 .equ tcsls_flags, 0x08 /* initialized by loader */
81 .equ tcsls_flag_secondary, 0 /* initialized by loader; 0 = standard TCS, 1 = secondary TCS */
82 .equ tcsls_flag_init_once, 1 /* initialized by loader to 0 */
84 .equ tcsls_user_fcw, 0x0a
85 .equ tcsls_user_mxcsr, 0x0c
86 .equ tcsls_last_rsp, 0x10 /* initialized by loader to 0 */
87 .equ tcsls_panic_last_rsp, 0x18 /* initialized by loader to 0 */
88 .equ tcsls_debug_panic_buf_ptr, 0x20 /* initialized by loader to 0 */
89 .equ tcsls_user_rsp, 0x28
90 .equ tcsls_user_retip, 0x30
91 .equ tcsls_user_rbp, 0x38
92 .equ tcsls_user_r12, 0x40
93 .equ tcsls_user_r13, 0x48
94 .equ tcsls_user_r14, 0x50
95 .equ tcsls_user_r15, 0x58
96 .equ tcsls_tls_ptr, 0x60
97 .equ tcsls_tcs_addr, 0x68
99 .macro load_tcsls_flag_secondary_bool reg:req comments:vararg
100 .ifne tcsls_flag_secondary /* to convert to a bool, must be the first bit */
103 mov $(1<<tcsls_flag_secondary),%e\reg
104 and %gs:tcsls_flags,%\reg
107 /* We place the ELF entry point in a separate section so it can be removed by
109 .section .text_no_sgx, "ax"
110 .Lelf_entry_error_msg:
111 .ascii "Error: This file is an SGX enclave which cannot be executed as a standard Linux binary.\nSee the installation guide at https://edp.fortanix.com/docs/installation/guide/ on how to use 'cargo run' or follow the steps at https://edp.fortanix.com/docs/tasks/deployment/ for manual deployment.\n"
112 .Lelf_entry_error_msg_end:
115 .type elf_entry,function
117 /* print error message */
118 movq $2,%rdi /* write to stderr (fd 2) */
119 lea .Lelf_entry_error_msg(%rip),%rsi
120 movq $.Lelf_entry_error_msg_end-.Lelf_entry_error_msg,%rdx
122 movq $1,%rax /* write() syscall */
125 jle .Lelf_exit /* exit on error */
127 sub %rax,%rdx /* all chars written? */
131 movq $60,%rax /* exit() syscall */
132 movq $1,%rdi /* exit code 1 */
134 ud2 /* should not be reached */
139 .type sgx_entry,function
141 /* save user registers */
142 mov %rcx,%gs:tcsls_user_retip
143 mov %rsp,%gs:tcsls_user_rsp
144 mov %rbp,%gs:tcsls_user_rbp
145 mov %r12,%gs:tcsls_user_r12
146 mov %r13,%gs:tcsls_user_r13
147 mov %r14,%gs:tcsls_user_r14
148 mov %r15,%gs:tcsls_user_r15
149 mov %rbx,%gs:tcsls_tcs_addr
150 stmxcsr %gs:tcsls_user_mxcsr
151 fnstcw %gs:tcsls_user_fcw
153 /* reset user state */
154 /* - DF flag: x86-64 ABI requires DF to be unset at function entry/exit */
155 /* - AC flag: AEX on misaligned memory accesses leaks side channel info */
157 andq $~0x40400, (%rsp)
160 /* check for debug buffer pointer */
161 testb $0xff,DEBUG(%rip)
163 mov %r10,%gs:tcsls_debug_panic_buf_ptr
165 /* check for abort */
166 bt $0,.Laborted(%rip)
168 /* check if returning from usercall */
169 mov %gs:tcsls_last_rsp,%r11
173 mov %gs:tcsls_tos,%rsp /* initially, RSP is not set to the correct value */
174 /* here. This is fixed below under "adjust stack". */
175 /* check for thread init */
176 bts $tcsls_flag_init_once,%gs:tcsls_flags
179 lea IMAGE_BASE(%rip),%rax
181 mov %rsp,%gs:tcsls_tos
183 /* store caller-saved registers in callee-saved registers */
189 load_tcsls_flag_secondary_bool di /* RDI = tcs_init() argument: secondary: bool */
191 /* reload caller-saved registers */
198 /* call into main entry point */
199 load_tcsls_flag_secondary_bool cx /* RCX = entry() argument: secondary: bool */
200 call entry /* RDI, RSI, RDX, R8, R9 passed in from userspace */
201 mov %rax,%rsi /* RSI = return value */
202 /* NOP: mov %rdx,%rdx */ /* RDX = return value */
203 xor %rdi,%rdi /* RDI = normal exit */
205 /* clear general purpose register state */
206 /* RAX overwritten by ENCLU */
208 /* RCX overwritten by ENCLU */
209 /* RDX contains return value */
212 /* RDI contains exit mode */
213 /* RSI contains return value */
218 /* R12 ~ R15 set by sgx_exit */
220 /* clear extended register state */
221 mov %rdx, %rcx /* save RDX */
224 xrstor .Lxsave_clear(%rip)
225 mov %rcx, %rdx /* restore RDX */
229 /* restore user registers */
230 mov %gs:tcsls_user_r12,%r12
231 mov %gs:tcsls_user_r13,%r13
232 mov %gs:tcsls_user_r14,%r14
233 mov %gs:tcsls_user_r15,%r15
234 mov %gs:tcsls_user_retip,%rbx
235 mov %gs:tcsls_user_rsp,%rsp
236 mov %gs:tcsls_user_rbp,%rbp
237 fldcw %gs:tcsls_user_fcw
238 ldmxcsr %gs:tcsls_user_mxcsr
240 mov $0x4,%eax /* EEXIT */
248 /* This *MUST* be called with 6 parameters, otherwise register information */
252 test %rcx,%rcx /* check `abort` function argument */
253 jnz .Lusercall_abort /* abort is set, jump to abort code (unlikely forward conditional) */
254 jmp .Lusercall_save_state /* non-aborting usercall */
256 /* set aborted bit */
257 movb $1,.Laborted(%rip)
258 /* save registers in DEBUG mode, so that debugger can reconstruct the stack */
259 testb $0xff,DEBUG(%rip)
260 jz .Lusercall_noreturn
261 .Lusercall_save_state:
262 /* save callee-saved state */
272 movq %rsp,%gs:tcsls_last_rsp
274 /* clear general purpose register state */
275 /* RAX overwritten by ENCLU */
276 /* RBX set by sgx_exit */
277 /* RCX overwritten by ENCLU */
278 /* RDX contains parameter */
279 /* RSP set by sgx_exit */
280 /* RBP set by sgx_exit */
281 /* RDI contains parameter */
282 /* RSI contains parameter */
283 /* R8 contains parameter */
284 /* R9 contains parameter */
287 /* R12 ~ R15 set by sgx_exit */
288 /* extended registers/flags cleared by sgx_exit */
292 movq $0,%gs:tcsls_last_rsp
293 /* restore callee-saved state, cf. "save" above */
305 mov %rsi,%rax /* RAX = return value */
306 /* NOP: mov %rdx,%rdx */ /* RDX = return value */
310 The following functions need to be defined externally:
312 // Called by entry code on re-entry after exit
313 extern "C" fn abort_reentry() -> !;
315 // Called once when a TCS is first entered
316 extern "C" fn tcs_init(secondary: bool);
318 // Standard TCS entrypoint
319 extern "C" fn entry(p1: u64, p2: u64, p3: u64, secondary: bool, p4: u64, p5: u64) -> (u64, u64);
325 mov %gs:tcsls_tcs_addr,%rax
330 mov %gs:tcsls_tls_ptr,%rax
335 mov %rdi,%gs:tcsls_tls_ptr
338 .global take_debug_panic_buf_ptr
339 take_debug_panic_buf_ptr:
341 xchg %gs:tcsls_debug_panic_buf_ptr,%rax