xref: /optee_os/core/arch/arm/kernel/thread.c (revision 997ff82731597ddcf8d6ad0fb3301adca8c0c6a8)
1 // SPDX-License-Identifier: BSD-2-Clause
2 /*
3  * Copyright (c) 2016-2021, Linaro Limited
4  * Copyright (c) 2014, STMicroelectronics International N.V.
5  * Copyright (c) 2020-2021, Arm Limited
6  */
7 
8 #include <platform_config.h>
9 
10 #include <arm.h>
11 #include <assert.h>
12 #include <config.h>
13 #include <io.h>
14 #include <keep.h>
15 #include <kernel/asan.h>
16 #include <kernel/boot.h>
17 #include <kernel/linker.h>
18 #include <kernel/lockdep.h>
19 #include <kernel/misc.h>
20 #include <kernel/panic.h>
21 #include <kernel/spinlock.h>
22 #include <kernel/spmc_sp_handler.h>
23 #include <kernel/tee_ta_manager.h>
24 #include <kernel/thread.h>
25 #include <kernel/thread_private.h>
26 #include <kernel/user_mode_ctx_struct.h>
27 #include <kernel/virtualization.h>
28 #include <mm/core_memprot.h>
29 #include <mm/mobj.h>
30 #include <mm/tee_mm.h>
31 #include <mm/tee_pager.h>
32 #include <mm/vm.h>
33 #include <smccc.h>
34 #include <sm/sm.h>
35 #include <trace.h>
36 #include <util.h>
37 
38 #ifdef CFG_CORE_UNMAP_CORE_AT_EL0
39 static vaddr_t thread_user_kcode_va __nex_bss;
40 long thread_user_kcode_offset __nex_bss;
41 static size_t thread_user_kcode_size __nex_bss;
42 #endif
43 
44 #if defined(CFG_CORE_UNMAP_CORE_AT_EL0) && \
45 	defined(CFG_CORE_WORKAROUND_SPECTRE_BP_SEC) && defined(ARM64)
46 long thread_user_kdata_sp_offset __nex_bss;
47 static uint8_t thread_user_kdata_page[
48 	ROUNDUP(sizeof(struct thread_core_local) * CFG_TEE_CORE_NB_CORE,
49 		SMALL_PAGE_SIZE)]
50 	__aligned(SMALL_PAGE_SIZE)
51 #ifndef CFG_VIRTUALIZATION
52 	__section(".nozi.kdata_page");
53 #else
54 	__section(".nex_nozi.kdata_page");
55 #endif
56 #endif
57 
58 #ifdef ARM32
59 uint32_t __nostackcheck thread_get_exceptions(void)
60 {
61 	uint32_t cpsr = read_cpsr();
62 
63 	return (cpsr >> CPSR_F_SHIFT) & THREAD_EXCP_ALL;
64 }
65 
66 void __nostackcheck thread_set_exceptions(uint32_t exceptions)
67 {
68 	uint32_t cpsr = read_cpsr();
69 
70 	/* Foreign interrupts must not be unmasked while holding a spinlock */
71 	if (!(exceptions & THREAD_EXCP_FOREIGN_INTR))
72 		assert_have_no_spinlock();
73 
74 	cpsr &= ~(THREAD_EXCP_ALL << CPSR_F_SHIFT);
75 	cpsr |= ((exceptions & THREAD_EXCP_ALL) << CPSR_F_SHIFT);
76 
77 	barrier();
78 	write_cpsr(cpsr);
79 	barrier();
80 }
81 #endif /*ARM32*/
82 
83 #ifdef ARM64
84 uint32_t __nostackcheck thread_get_exceptions(void)
85 {
86 	uint32_t daif = read_daif();
87 
88 	return (daif >> DAIF_F_SHIFT) & THREAD_EXCP_ALL;
89 }
90 
91 void __nostackcheck thread_set_exceptions(uint32_t exceptions)
92 {
93 	uint32_t daif = read_daif();
94 
95 	/* Foreign interrupts must not be unmasked while holding a spinlock */
96 	if (!(exceptions & THREAD_EXCP_FOREIGN_INTR))
97 		assert_have_no_spinlock();
98 
99 	daif &= ~(THREAD_EXCP_ALL << DAIF_F_SHIFT);
100 	daif |= ((exceptions & THREAD_EXCP_ALL) << DAIF_F_SHIFT);
101 
102 	barrier();
103 	write_daif(daif);
104 	barrier();
105 }
106 #endif /*ARM64*/
107 
108 uint32_t __nostackcheck thread_mask_exceptions(uint32_t exceptions)
109 {
110 	uint32_t state = thread_get_exceptions();
111 
112 	thread_set_exceptions(state | (exceptions & THREAD_EXCP_ALL));
113 	return state;
114 }
115 
116 void __nostackcheck thread_unmask_exceptions(uint32_t state)
117 {
118 	thread_set_exceptions(state & THREAD_EXCP_ALL);
119 }
120 
121 static void thread_lazy_save_ns_vfp(void)
122 {
123 #ifdef CFG_WITH_VFP
124 	struct thread_ctx *thr = threads + thread_get_id();
125 
126 	thr->vfp_state.ns_saved = false;
127 	vfp_lazy_save_state_init(&thr->vfp_state.ns);
128 #endif /*CFG_WITH_VFP*/
129 }
130 
131 static void thread_lazy_restore_ns_vfp(void)
132 {
133 #ifdef CFG_WITH_VFP
134 	struct thread_ctx *thr = threads + thread_get_id();
135 	struct thread_user_vfp_state *tuv = thr->vfp_state.uvfp;
136 
137 	assert(!thr->vfp_state.sec_lazy_saved && !thr->vfp_state.sec_saved);
138 
139 	if (tuv && tuv->lazy_saved && !tuv->saved) {
140 		vfp_lazy_save_state_final(&tuv->vfp, false /*!force_save*/);
141 		tuv->saved = true;
142 	}
143 
144 	vfp_lazy_restore_state(&thr->vfp_state.ns, thr->vfp_state.ns_saved);
145 	thr->vfp_state.ns_saved = false;
146 #endif /*CFG_WITH_VFP*/
147 }
148 
149 #ifdef ARM32
150 static void init_regs(struct thread_ctx *thread, uint32_t a0, uint32_t a1,
151 		      uint32_t a2, uint32_t a3, uint32_t a4, uint32_t a5,
152 		      uint32_t a6, uint32_t a7, void *pc)
153 {
154 	thread->regs.pc = (uint32_t)pc;
155 
156 	/*
157 	 * Stdcalls starts in SVC mode with masked foreign interrupts, masked
158 	 * Asynchronous abort and unmasked native interrupts.
159 	 */
160 	thread->regs.cpsr = read_cpsr() & ARM32_CPSR_E;
161 	thread->regs.cpsr |= CPSR_MODE_SVC | CPSR_A |
162 			(THREAD_EXCP_FOREIGN_INTR << ARM32_CPSR_F_SHIFT);
163 	/* Enable thumb mode if it's a thumb instruction */
164 	if (thread->regs.pc & 1)
165 		thread->regs.cpsr |= CPSR_T;
166 	/* Reinitialize stack pointer */
167 	thread->regs.svc_sp = thread->stack_va_end;
168 
169 	/*
170 	 * Copy arguments into context. This will make the
171 	 * arguments appear in r0-r7 when thread is started.
172 	 */
173 	thread->regs.r0 = a0;
174 	thread->regs.r1 = a1;
175 	thread->regs.r2 = a2;
176 	thread->regs.r3 = a3;
177 	thread->regs.r4 = a4;
178 	thread->regs.r5 = a5;
179 	thread->regs.r6 = a6;
180 	thread->regs.r7 = a7;
181 }
182 #endif /*ARM32*/
183 
184 #ifdef ARM64
185 static void init_regs(struct thread_ctx *thread, uint32_t a0, uint32_t a1,
186 		      uint32_t a2, uint32_t a3, uint32_t a4, uint32_t a5,
187 		      uint32_t a6, uint32_t a7, void *pc)
188 {
189 	thread->regs.pc = (uint64_t)pc;
190 
191 	/*
192 	 * Stdcalls starts in SVC mode with masked foreign interrupts, masked
193 	 * Asynchronous abort and unmasked native interrupts.
194 	 */
195 	thread->regs.cpsr = SPSR_64(SPSR_64_MODE_EL1, SPSR_64_MODE_SP_EL0,
196 				THREAD_EXCP_FOREIGN_INTR | DAIFBIT_ABT);
197 	/* Reinitialize stack pointer */
198 	thread->regs.sp = thread->stack_va_end;
199 
200 	/*
201 	 * Copy arguments into context. This will make the
202 	 * arguments appear in x0-x7 when thread is started.
203 	 */
204 	thread->regs.x[0] = a0;
205 	thread->regs.x[1] = a1;
206 	thread->regs.x[2] = a2;
207 	thread->regs.x[3] = a3;
208 	thread->regs.x[4] = a4;
209 	thread->regs.x[5] = a5;
210 	thread->regs.x[6] = a6;
211 	thread->regs.x[7] = a7;
212 
213 	/* Set up frame pointer as per the Aarch64 AAPCS */
214 	thread->regs.x[29] = 0;
215 }
216 #endif /*ARM64*/
217 
218 static void __thread_alloc_and_run(uint32_t a0, uint32_t a1, uint32_t a2,
219 				   uint32_t a3, uint32_t a4, uint32_t a5,
220 				   uint32_t a6, uint32_t a7,
221 				   void *pc)
222 {
223 	size_t n;
224 	struct thread_core_local *l = thread_get_core_local();
225 	bool found_thread = false;
226 
227 	assert(l->curr_thread == THREAD_ID_INVALID);
228 
229 	thread_lock_global();
230 
231 	for (n = 0; n < CFG_NUM_THREADS; n++) {
232 		if (threads[n].state == THREAD_STATE_FREE) {
233 			threads[n].state = THREAD_STATE_ACTIVE;
234 			found_thread = true;
235 			break;
236 		}
237 	}
238 
239 	thread_unlock_global();
240 
241 	if (!found_thread)
242 		return;
243 
244 	l->curr_thread = n;
245 
246 	threads[n].flags = 0;
247 	init_regs(threads + n, a0, a1, a2, a3, a4, a5, a6, a7, pc);
248 
249 	thread_lazy_save_ns_vfp();
250 
251 	l->flags &= ~THREAD_CLF_TMP;
252 	thread_resume(&threads[n].regs);
253 	/*NOTREACHED*/
254 	panic();
255 }
256 
257 void thread_alloc_and_run(uint32_t a0, uint32_t a1, uint32_t a2, uint32_t a3,
258 			  uint32_t a4, uint32_t a5)
259 {
260 	__thread_alloc_and_run(a0, a1, a2, a3, a4, a5, 0, 0,
261 			       thread_std_smc_entry);
262 }
263 
264 #ifdef CFG_SECURE_PARTITION
265 void thread_sp_alloc_and_run(struct thread_smc_args *args __maybe_unused)
266 {
267 	__thread_alloc_and_run(args->a0, args->a1, args->a2, args->a3, args->a4,
268 			       args->a5, args->a6, args->a7,
269 			       spmc_sp_thread_entry);
270 }
271 #endif
272 
273 #ifdef ARM32
274 static void copy_a0_to_a3(struct thread_ctx_regs *regs, uint32_t a0,
275 			  uint32_t a1, uint32_t a2, uint32_t a3)
276 {
277 	/*
278 	 * Update returned values from RPC, values will appear in
279 	 * r0-r3 when thread is resumed.
280 	 */
281 	regs->r0 = a0;
282 	regs->r1 = a1;
283 	regs->r2 = a2;
284 	regs->r3 = a3;
285 }
286 #endif /*ARM32*/
287 
288 #ifdef ARM64
289 static void copy_a0_to_a3(struct thread_ctx_regs *regs, uint32_t a0,
290 			  uint32_t a1, uint32_t a2, uint32_t a3)
291 {
292 	/*
293 	 * Update returned values from RPC, values will appear in
294 	 * x0-x3 when thread is resumed.
295 	 */
296 	regs->x[0] = a0;
297 	regs->x[1] = a1;
298 	regs->x[2] = a2;
299 	regs->x[3] = a3;
300 }
301 #endif /*ARM64*/
302 
303 #ifdef ARM32
304 static bool is_from_user(uint32_t cpsr)
305 {
306 	return (cpsr & ARM32_CPSR_MODE_MASK) == ARM32_CPSR_MODE_USR;
307 }
308 #endif
309 
310 #ifdef ARM64
311 static bool is_from_user(uint32_t cpsr)
312 {
313 	if (cpsr & (SPSR_MODE_RW_32 << SPSR_MODE_RW_SHIFT))
314 		return true;
315 	if (((cpsr >> SPSR_64_MODE_EL_SHIFT) & SPSR_64_MODE_EL_MASK) ==
316 	     SPSR_64_MODE_EL0)
317 		return true;
318 	return false;
319 }
320 #endif
321 
322 #ifdef CFG_SYSCALL_FTRACE
323 static void __noprof ftrace_suspend(void)
324 {
325 	struct ts_session *s = TAILQ_FIRST(&thread_get_tsd()->sess_stack);
326 
327 	if (s && s->fbuf)
328 		s->fbuf->syscall_trace_suspended = true;
329 }
330 
331 static void __noprof ftrace_resume(void)
332 {
333 	struct ts_session *s = TAILQ_FIRST(&thread_get_tsd()->sess_stack);
334 
335 	if (s && s->fbuf)
336 		s->fbuf->syscall_trace_suspended = false;
337 }
338 #else
339 static void __noprof ftrace_suspend(void)
340 {
341 }
342 
343 static void __noprof ftrace_resume(void)
344 {
345 }
346 #endif
347 
348 static bool is_user_mode(struct thread_ctx_regs *regs)
349 {
350 	return is_from_user((uint32_t)regs->cpsr);
351 }
352 
353 void thread_resume_from_rpc(uint32_t thread_id, uint32_t a0, uint32_t a1,
354 			    uint32_t a2, uint32_t a3)
355 {
356 	size_t n = thread_id;
357 	struct thread_core_local *l = thread_get_core_local();
358 	bool found_thread = false;
359 
360 	assert(l->curr_thread == THREAD_ID_INVALID);
361 
362 	thread_lock_global();
363 
364 	if (n < CFG_NUM_THREADS && threads[n].state == THREAD_STATE_SUSPENDED) {
365 		threads[n].state = THREAD_STATE_ACTIVE;
366 		found_thread = true;
367 	}
368 
369 	thread_unlock_global();
370 
371 	if (!found_thread)
372 		return;
373 
374 	l->curr_thread = n;
375 
376 	if (threads[n].have_user_map) {
377 		core_mmu_set_user_map(&threads[n].user_map);
378 		if (threads[n].flags & THREAD_FLAGS_EXIT_ON_FOREIGN_INTR)
379 			tee_ta_ftrace_update_times_resume();
380 	}
381 
382 	if (is_user_mode(&threads[n].regs))
383 		tee_ta_update_session_utime_resume();
384 
385 	/*
386 	 * Return from RPC to request service of a foreign interrupt must not
387 	 * get parameters from non-secure world.
388 	 */
389 	if (threads[n].flags & THREAD_FLAGS_COPY_ARGS_ON_RETURN) {
390 		copy_a0_to_a3(&threads[n].regs, a0, a1, a2, a3);
391 		threads[n].flags &= ~THREAD_FLAGS_COPY_ARGS_ON_RETURN;
392 	}
393 
394 	thread_lazy_save_ns_vfp();
395 
396 	if (threads[n].have_user_map)
397 		ftrace_resume();
398 
399 	l->flags &= ~THREAD_CLF_TMP;
400 	thread_resume(&threads[n].regs);
401 	/*NOTREACHED*/
402 	panic();
403 }
404 
405 #ifdef ARM64
406 vaddr_t thread_get_saved_thread_sp(void)
407 {
408 	struct thread_core_local *l = thread_get_core_local();
409 	int ct = l->curr_thread;
410 
411 	assert(ct != THREAD_ID_INVALID);
412 	return threads[ct].kern_sp;
413 }
414 #endif /*ARM64*/
415 
416 #ifdef ARM32
417 bool thread_is_in_normal_mode(void)
418 {
419 	return (read_cpsr() & ARM32_CPSR_MODE_MASK) == ARM32_CPSR_MODE_SVC;
420 }
421 #endif
422 
423 void thread_state_free(void)
424 {
425 	struct thread_core_local *l = thread_get_core_local();
426 	int ct = l->curr_thread;
427 
428 	assert(ct != THREAD_ID_INVALID);
429 
430 	thread_lazy_restore_ns_vfp();
431 	tee_pager_release_phys(
432 		(void *)(threads[ct].stack_va_end - STACK_THREAD_SIZE),
433 		STACK_THREAD_SIZE);
434 
435 	thread_lock_global();
436 
437 	assert(threads[ct].state == THREAD_STATE_ACTIVE);
438 	threads[ct].state = THREAD_STATE_FREE;
439 	threads[ct].flags = 0;
440 	l->curr_thread = THREAD_ID_INVALID;
441 
442 	if (IS_ENABLED(CFG_VIRTUALIZATION))
443 		virt_unset_guest();
444 	thread_unlock_global();
445 }
446 
447 #ifdef CFG_WITH_PAGER
448 static void release_unused_kernel_stack(struct thread_ctx *thr,
449 					uint32_t cpsr __maybe_unused)
450 {
451 #ifdef ARM64
452 	/*
453 	 * If we're from user mode then thr->regs.sp is the saved user
454 	 * stack pointer and thr->kern_sp holds the last kernel stack
455 	 * pointer. But if we're from kernel mode then thr->kern_sp isn't
456 	 * up to date so we need to read from thr->regs.sp instead.
457 	 */
458 	vaddr_t sp = is_from_user(cpsr) ?  thr->kern_sp : thr->regs.sp;
459 #else
460 	vaddr_t sp = thr->regs.svc_sp;
461 #endif
462 	vaddr_t base = thr->stack_va_end - STACK_THREAD_SIZE;
463 	size_t len = sp - base;
464 
465 	tee_pager_release_phys((void *)base, len);
466 }
467 #else
468 static void release_unused_kernel_stack(struct thread_ctx *thr __unused,
469 					uint32_t cpsr __unused)
470 {
471 }
472 #endif
473 
474 int thread_state_suspend(uint32_t flags, uint32_t cpsr, vaddr_t pc)
475 {
476 	struct thread_core_local *l = thread_get_core_local();
477 	int ct = l->curr_thread;
478 
479 	assert(ct != THREAD_ID_INVALID);
480 
481 	if (core_mmu_user_mapping_is_active())
482 		ftrace_suspend();
483 
484 	thread_check_canaries();
485 
486 	release_unused_kernel_stack(threads + ct, cpsr);
487 
488 	if (is_from_user(cpsr)) {
489 		thread_user_save_vfp();
490 		tee_ta_update_session_utime_suspend();
491 		tee_ta_gprof_sample_pc(pc);
492 	}
493 	thread_lazy_restore_ns_vfp();
494 
495 	thread_lock_global();
496 
497 	assert(threads[ct].state == THREAD_STATE_ACTIVE);
498 	threads[ct].flags |= flags;
499 	threads[ct].regs.cpsr = cpsr;
500 	threads[ct].regs.pc = pc;
501 	threads[ct].state = THREAD_STATE_SUSPENDED;
502 
503 	threads[ct].have_user_map = core_mmu_user_mapping_is_active();
504 	if (threads[ct].have_user_map) {
505 		if (threads[ct].flags & THREAD_FLAGS_EXIT_ON_FOREIGN_INTR)
506 			tee_ta_ftrace_update_times_suspend();
507 		core_mmu_get_user_map(&threads[ct].user_map);
508 		core_mmu_set_user_map(NULL);
509 	}
510 
511 	l->curr_thread = THREAD_ID_INVALID;
512 
513 	if (IS_ENABLED(CFG_VIRTUALIZATION))
514 		virt_unset_guest();
515 
516 	thread_unlock_global();
517 
518 	return ct;
519 }
520 
521 bool thread_init_stack(uint32_t thread_id, vaddr_t sp)
522 {
523 	if (thread_id >= CFG_NUM_THREADS)
524 		return false;
525 	threads[thread_id].stack_va_end = sp;
526 	return true;
527 }
528 
529 static void init_user_kcode(void)
530 {
531 #ifdef CFG_CORE_UNMAP_CORE_AT_EL0
532 	vaddr_t v = (vaddr_t)thread_excp_vect;
533 	vaddr_t ve = (vaddr_t)thread_excp_vect_end;
534 
535 	thread_user_kcode_va = ROUNDDOWN(v, CORE_MMU_USER_CODE_SIZE);
536 	ve = ROUNDUP(ve, CORE_MMU_USER_CODE_SIZE);
537 	thread_user_kcode_size = ve - thread_user_kcode_va;
538 
539 	core_mmu_get_user_va_range(&v, NULL);
540 	thread_user_kcode_offset = thread_user_kcode_va - v;
541 
542 #if defined(CFG_CORE_WORKAROUND_SPECTRE_BP_SEC) && defined(ARM64)
543 	/*
544 	 * When transitioning to EL0 subtract SP with this much to point to
545 	 * this special kdata page instead. SP is restored by add this much
546 	 * while transitioning back to EL1.
547 	 */
548 	v += thread_user_kcode_size;
549 	thread_user_kdata_sp_offset = (vaddr_t)thread_core_local - v;
550 #endif
551 #endif /*CFG_CORE_UNMAP_CORE_AT_EL0*/
552 }
553 
554 void thread_init_primary(void)
555 {
556 	/* Initialize canaries around the stacks */
557 	thread_init_canaries();
558 
559 	init_user_kcode();
560 }
561 
562 static uint32_t __maybe_unused get_midr_implementer(uint32_t midr)
563 {
564 	return (midr >> MIDR_IMPLEMENTER_SHIFT) & MIDR_IMPLEMENTER_MASK;
565 }
566 
567 static uint32_t __maybe_unused get_midr_primary_part(uint32_t midr)
568 {
569 	return (midr >> MIDR_PRIMARY_PART_NUM_SHIFT) &
570 	       MIDR_PRIMARY_PART_NUM_MASK;
571 }
572 
573 #ifdef ARM64
574 static bool probe_workaround_available(void)
575 {
576 	int32_t r;
577 
578 	r = thread_smc(SMCCC_VERSION, 0, 0, 0);
579 	if (r < 0)
580 		return false;
581 	if (r < 0x10001)	/* compare with version 1.1 */
582 		return false;
583 
584 	/* Version >= 1.1, so SMCCC_ARCH_FEATURES is available */
585 	r = thread_smc(SMCCC_ARCH_FEATURES, SMCCC_ARCH_WORKAROUND_1, 0, 0);
586 	return r >= 0;
587 }
588 
589 static vaddr_t __maybe_unused select_vector(vaddr_t a)
590 {
591 	if (probe_workaround_available()) {
592 		DMSG("SMCCC_ARCH_WORKAROUND_1 (%#08" PRIx32 ") available",
593 		     SMCCC_ARCH_WORKAROUND_1);
594 		DMSG("SMC Workaround for CVE-2017-5715 used");
595 		return a;
596 	}
597 
598 	DMSG("SMCCC_ARCH_WORKAROUND_1 (%#08" PRIx32 ") unavailable",
599 	     SMCCC_ARCH_WORKAROUND_1);
600 	DMSG("SMC Workaround for CVE-2017-5715 not needed (if ARM-TF is up to date)");
601 	return (vaddr_t)thread_excp_vect;
602 }
603 #else
604 static vaddr_t __maybe_unused select_vector(vaddr_t a)
605 {
606 	return a;
607 }
608 #endif
609 
610 static vaddr_t get_excp_vect(void)
611 {
612 #ifdef CFG_CORE_WORKAROUND_SPECTRE_BP_SEC
613 	uint32_t midr = read_midr();
614 
615 	if (get_midr_implementer(midr) != MIDR_IMPLEMENTER_ARM)
616 		return (vaddr_t)thread_excp_vect;
617 
618 	switch (get_midr_primary_part(midr)) {
619 #ifdef ARM32
620 	case CORTEX_A8_PART_NUM:
621 	case CORTEX_A9_PART_NUM:
622 	case CORTEX_A17_PART_NUM:
623 #endif
624 	case CORTEX_A57_PART_NUM:
625 	case CORTEX_A72_PART_NUM:
626 	case CORTEX_A73_PART_NUM:
627 	case CORTEX_A75_PART_NUM:
628 		return select_vector((vaddr_t)thread_excp_vect_workaround);
629 #ifdef ARM32
630 	case CORTEX_A15_PART_NUM:
631 		return select_vector((vaddr_t)thread_excp_vect_workaround_a15);
632 #endif
633 	default:
634 		return (vaddr_t)thread_excp_vect;
635 	}
636 #endif /*CFG_CORE_WORKAROUND_SPECTRE_BP_SEC*/
637 
638 	return (vaddr_t)thread_excp_vect;
639 }
640 
641 void thread_init_per_cpu(void)
642 {
643 #ifdef ARM32
644 	struct thread_core_local *l = thread_get_core_local();
645 
646 #if !defined(CFG_WITH_ARM_TRUSTED_FW)
647 	/* Initialize secure monitor */
648 	sm_init(l->tmp_stack_va_end + STACK_TMP_OFFS);
649 #endif
650 	thread_set_irq_sp(l->tmp_stack_va_end);
651 	thread_set_fiq_sp(l->tmp_stack_va_end);
652 	thread_set_abt_sp((vaddr_t)l);
653 	thread_set_und_sp((vaddr_t)l);
654 #endif
655 
656 	thread_init_vbar(get_excp_vect());
657 
658 #ifdef CFG_FTRACE_SUPPORT
659 	/*
660 	 * Enable accesses to frequency register and physical counter
661 	 * register in EL0/PL0 required for timestamping during
662 	 * function tracing.
663 	 */
664 	write_cntkctl(read_cntkctl() | CNTKCTL_PL0PCTEN);
665 #endif
666 }
667 
668 #ifdef CFG_WITH_VFP
669 uint32_t thread_kernel_enable_vfp(void)
670 {
671 	uint32_t exceptions = thread_mask_exceptions(THREAD_EXCP_FOREIGN_INTR);
672 	struct thread_ctx *thr = threads + thread_get_id();
673 	struct thread_user_vfp_state *tuv = thr->vfp_state.uvfp;
674 
675 	assert(!vfp_is_enabled());
676 
677 	if (!thr->vfp_state.ns_saved) {
678 		vfp_lazy_save_state_final(&thr->vfp_state.ns,
679 					  true /*force_save*/);
680 		thr->vfp_state.ns_saved = true;
681 	} else if (thr->vfp_state.sec_lazy_saved &&
682 		   !thr->vfp_state.sec_saved) {
683 		/*
684 		 * This happens when we're handling an abort while the
685 		 * thread was using the VFP state.
686 		 */
687 		vfp_lazy_save_state_final(&thr->vfp_state.sec,
688 					  false /*!force_save*/);
689 		thr->vfp_state.sec_saved = true;
690 	} else if (tuv && tuv->lazy_saved && !tuv->saved) {
691 		/*
692 		 * This can happen either during syscall or abort
693 		 * processing (while processing a syscall).
694 		 */
695 		vfp_lazy_save_state_final(&tuv->vfp, false /*!force_save*/);
696 		tuv->saved = true;
697 	}
698 
699 	vfp_enable();
700 	return exceptions;
701 }
702 
703 void thread_kernel_disable_vfp(uint32_t state)
704 {
705 	uint32_t exceptions;
706 
707 	assert(vfp_is_enabled());
708 
709 	vfp_disable();
710 	exceptions = thread_get_exceptions();
711 	assert(exceptions & THREAD_EXCP_FOREIGN_INTR);
712 	exceptions &= ~THREAD_EXCP_FOREIGN_INTR;
713 	exceptions |= state & THREAD_EXCP_FOREIGN_INTR;
714 	thread_set_exceptions(exceptions);
715 }
716 
717 void thread_kernel_save_vfp(void)
718 {
719 	struct thread_ctx *thr = threads + thread_get_id();
720 
721 	assert(thread_get_exceptions() & THREAD_EXCP_FOREIGN_INTR);
722 	if (vfp_is_enabled()) {
723 		vfp_lazy_save_state_init(&thr->vfp_state.sec);
724 		thr->vfp_state.sec_lazy_saved = true;
725 	}
726 }
727 
728 void thread_kernel_restore_vfp(void)
729 {
730 	struct thread_ctx *thr = threads + thread_get_id();
731 
732 	assert(thread_get_exceptions() & THREAD_EXCP_FOREIGN_INTR);
733 	assert(!vfp_is_enabled());
734 	if (thr->vfp_state.sec_lazy_saved) {
735 		vfp_lazy_restore_state(&thr->vfp_state.sec,
736 				       thr->vfp_state.sec_saved);
737 		thr->vfp_state.sec_saved = false;
738 		thr->vfp_state.sec_lazy_saved = false;
739 	}
740 }
741 
742 void thread_user_enable_vfp(struct thread_user_vfp_state *uvfp)
743 {
744 	struct thread_ctx *thr = threads + thread_get_id();
745 	struct thread_user_vfp_state *tuv = thr->vfp_state.uvfp;
746 
747 	assert(thread_get_exceptions() & THREAD_EXCP_FOREIGN_INTR);
748 	assert(!vfp_is_enabled());
749 
750 	if (!thr->vfp_state.ns_saved) {
751 		vfp_lazy_save_state_final(&thr->vfp_state.ns,
752 					  true /*force_save*/);
753 		thr->vfp_state.ns_saved = true;
754 	} else if (tuv && uvfp != tuv) {
755 		if (tuv->lazy_saved && !tuv->saved) {
756 			vfp_lazy_save_state_final(&tuv->vfp,
757 						  false /*!force_save*/);
758 			tuv->saved = true;
759 		}
760 	}
761 
762 	if (uvfp->lazy_saved)
763 		vfp_lazy_restore_state(&uvfp->vfp, uvfp->saved);
764 	uvfp->lazy_saved = false;
765 	uvfp->saved = false;
766 
767 	thr->vfp_state.uvfp = uvfp;
768 	vfp_enable();
769 }
770 
771 void thread_user_save_vfp(void)
772 {
773 	struct thread_ctx *thr = threads + thread_get_id();
774 	struct thread_user_vfp_state *tuv = thr->vfp_state.uvfp;
775 
776 	assert(thread_get_exceptions() & THREAD_EXCP_FOREIGN_INTR);
777 	if (!vfp_is_enabled())
778 		return;
779 
780 	assert(tuv && !tuv->lazy_saved && !tuv->saved);
781 	vfp_lazy_save_state_init(&tuv->vfp);
782 	tuv->lazy_saved = true;
783 }
784 
785 void thread_user_clear_vfp(struct user_mode_ctx *uctx)
786 {
787 	struct thread_user_vfp_state *uvfp = &uctx->vfp;
788 	struct thread_ctx *thr = threads + thread_get_id();
789 
790 	if (uvfp == thr->vfp_state.uvfp)
791 		thr->vfp_state.uvfp = NULL;
792 	uvfp->lazy_saved = false;
793 	uvfp->saved = false;
794 }
795 #endif /*CFG_WITH_VFP*/
796 
797 #ifdef ARM32
798 static bool get_spsr(bool is_32bit, unsigned long entry_func, uint32_t *spsr)
799 {
800 	uint32_t s;
801 
802 	if (!is_32bit)
803 		return false;
804 
805 	s = read_cpsr();
806 	s &= ~(CPSR_MODE_MASK | CPSR_T | CPSR_IT_MASK1 | CPSR_IT_MASK2);
807 	s |= CPSR_MODE_USR;
808 	if (entry_func & 1)
809 		s |= CPSR_T;
810 	*spsr = s;
811 	return true;
812 }
813 #endif
814 
815 #ifdef ARM64
816 static bool get_spsr(bool is_32bit, unsigned long entry_func, uint32_t *spsr)
817 {
818 	uint32_t s;
819 
820 	if (is_32bit) {
821 		s = read_daif() & (SPSR_32_AIF_MASK << SPSR_32_AIF_SHIFT);
822 		s |= SPSR_MODE_RW_32 << SPSR_MODE_RW_SHIFT;
823 		s |= (entry_func & SPSR_32_T_MASK) << SPSR_32_T_SHIFT;
824 	} else {
825 		s = read_daif() & (SPSR_64_DAIF_MASK << SPSR_64_DAIF_SHIFT);
826 	}
827 
828 	*spsr = s;
829 	return true;
830 }
831 #endif
832 
833 static void set_ctx_regs(struct thread_ctx_regs *regs, unsigned long a0,
834 			 unsigned long a1, unsigned long a2, unsigned long a3,
835 			 unsigned long user_sp, unsigned long entry_func,
836 			 uint32_t spsr,
837 			 struct thread_pauth_keys *keys __maybe_unused)
838 {
839 	/*
840 	 * First clear all registers to avoid leaking information from
841 	 * other TAs or even the Core itself.
842 	 */
843 	*regs = (struct thread_ctx_regs){ };
844 #ifdef ARM32
845 	regs->r0 = a0;
846 	regs->r1 = a1;
847 	regs->r2 = a2;
848 	regs->r3 = a3;
849 	regs->usr_sp = user_sp;
850 	regs->pc = entry_func;
851 	regs->cpsr = spsr;
852 #endif
853 #ifdef ARM64
854 	regs->x[0] = a0;
855 	regs->x[1] = a1;
856 	regs->x[2] = a2;
857 	regs->x[3] = a3;
858 	regs->sp = user_sp;
859 	regs->pc = entry_func;
860 	regs->cpsr = spsr;
861 	regs->x[13] = user_sp;	/* Used when running TA in Aarch32 */
862 	regs->sp = user_sp;	/* Used when running TA in Aarch64 */
863 #ifdef CFG_TA_PAUTH
864 	assert(keys);
865 	regs->apiakey_hi = keys->hi;
866 	regs->apiakey_lo = keys->lo;
867 #endif
868 	/* Set frame pointer (user stack can't be unwound past this point) */
869 	regs->x[29] = 0;
870 #endif
871 }
872 
873 static struct thread_pauth_keys *thread_get_pauth_keys(void)
874 {
875 #if defined(CFG_TA_PAUTH)
876 	struct ts_session *s = ts_get_current_session();
877 	/* Only user TA's support the PAUTH keys */
878 	struct user_ta_ctx *utc = to_user_ta_ctx(s->ctx);
879 
880 	return &utc->uctx.keys;
881 #else
882 	return NULL;
883 #endif
884 }
885 
886 uint32_t thread_enter_user_mode(unsigned long a0, unsigned long a1,
887 		unsigned long a2, unsigned long a3, unsigned long user_sp,
888 		unsigned long entry_func, bool is_32bit,
889 		uint32_t *exit_status0, uint32_t *exit_status1)
890 {
891 	uint32_t spsr = 0;
892 	uint32_t exceptions = 0;
893 	uint32_t rc = 0;
894 	struct thread_ctx_regs *regs = NULL;
895 	struct thread_pauth_keys *keys = NULL;
896 
897 	tee_ta_update_session_utime_resume();
898 
899 	keys = thread_get_pauth_keys();
900 
901 	/* Derive SPSR from current CPSR/PSTATE readout. */
902 	if (!get_spsr(is_32bit, entry_func, &spsr)) {
903 		*exit_status0 = 1; /* panic */
904 		*exit_status1 = 0xbadbadba;
905 		return 0;
906 	}
907 
908 	exceptions = thread_mask_exceptions(THREAD_EXCP_ALL);
909 	/*
910 	 * We're using the per thread location of saved context registers
911 	 * for temporary storage. Now that exceptions are masked they will
912 	 * not be used for any thing else until they are eventually
913 	 * unmasked when user mode has been entered.
914 	 */
915 	regs = thread_get_ctx_regs();
916 	set_ctx_regs(regs, a0, a1, a2, a3, user_sp, entry_func, spsr, keys);
917 	rc = __thread_enter_user_mode(regs, exit_status0, exit_status1);
918 	thread_unmask_exceptions(exceptions);
919 	return rc;
920 }
921 
922 #ifdef CFG_CORE_UNMAP_CORE_AT_EL0
923 void thread_get_user_kcode(struct mobj **mobj, size_t *offset,
924 			   vaddr_t *va, size_t *sz)
925 {
926 	core_mmu_get_user_va_range(va, NULL);
927 	*mobj = mobj_tee_ram_rx;
928 	*sz = thread_user_kcode_size;
929 	*offset = thread_user_kcode_va - (vaddr_t)mobj_get_va(*mobj, 0, *sz);
930 }
931 #endif
932 
933 #if defined(CFG_CORE_UNMAP_CORE_AT_EL0) && \
934 	defined(CFG_CORE_WORKAROUND_SPECTRE_BP_SEC) && defined(ARM64)
935 void thread_get_user_kdata(struct mobj **mobj, size_t *offset,
936 			   vaddr_t *va, size_t *sz)
937 {
938 	vaddr_t v;
939 
940 	core_mmu_get_user_va_range(&v, NULL);
941 	*va = v + thread_user_kcode_size;
942 	*mobj = mobj_tee_ram_rw;
943 	*sz = sizeof(thread_user_kdata_page);
944 	*offset = (vaddr_t)thread_user_kdata_page -
945 		  (vaddr_t)mobj_get_va(*mobj, 0, *sz);
946 }
947 #endif
948 
949 static void setup_unwind_user_mode(struct thread_svc_regs *regs)
950 {
951 #ifdef ARM32
952 	regs->lr = (uintptr_t)thread_unwind_user_mode;
953 	regs->spsr = read_cpsr();
954 #endif
955 #ifdef ARM64
956 	regs->elr = (uintptr_t)thread_unwind_user_mode;
957 	regs->spsr = SPSR_64(SPSR_64_MODE_EL1, SPSR_64_MODE_SP_EL0, 0);
958 	regs->spsr |= read_daif();
959 	/*
960 	 * Regs is the value of stack pointer before calling the SVC
961 	 * handler.  By the addition matches for the reserved space at the
962 	 * beginning of el0_sync_svc(). This prepares the stack when
963 	 * returning to thread_unwind_user_mode instead of a normal
964 	 * exception return.
965 	 */
966 	regs->sp_el0 = (uint64_t)(regs + 1);
967 #endif
968 }
969 
970 static void gprof_set_status(struct ts_session *s __maybe_unused,
971 			     enum ts_gprof_status status __maybe_unused)
972 {
973 #ifdef CFG_TA_GPROF_SUPPORT
974 	if (s->ctx->ops->gprof_set_status)
975 		s->ctx->ops->gprof_set_status(status);
976 #endif
977 }
978 
979 /*
980  * Note: this function is weak just to make it possible to exclude it from
981  * the unpaged area.
982  */
983 void __weak thread_svc_handler(struct thread_svc_regs *regs)
984 {
985 	struct ts_session *sess = NULL;
986 	uint32_t state = 0;
987 
988 	/* Enable native interrupts */
989 	state = thread_get_exceptions();
990 	thread_unmask_exceptions(state & ~THREAD_EXCP_NATIVE_INTR);
991 
992 	thread_user_save_vfp();
993 
994 	sess = ts_get_current_session();
995 	/*
996 	 * User mode service has just entered kernel mode, suspend gprof
997 	 * collection until we're about to switch back again.
998 	 */
999 	gprof_set_status(sess, TS_GPROF_SUSPEND);
1000 
1001 	/* Restore foreign interrupts which are disabled on exception entry */
1002 	thread_restore_foreign_intr();
1003 
1004 	assert(sess && sess->handle_svc);
1005 	if (sess->handle_svc(regs)) {
1006 		/* We're about to switch back to user mode */
1007 		gprof_set_status(sess, TS_GPROF_RESUME);
1008 	} else {
1009 		/* We're returning from __thread_enter_user_mode() */
1010 		setup_unwind_user_mode(regs);
1011 	}
1012 }
1013 
1014 #ifdef CFG_WITH_ARM_TRUSTED_FW
1015 /*
1016  * These five functions are __weak to allow platforms to override them if
1017  * needed.
1018  */
1019 unsigned long __weak thread_cpu_off_handler(unsigned long a0 __unused,
1020 					    unsigned long a1 __unused)
1021 {
1022 	return 0;
1023 }
1024 DECLARE_KEEP_PAGER(thread_cpu_off_handler);
1025 
1026 unsigned long __weak thread_cpu_suspend_handler(unsigned long a0 __unused,
1027 						unsigned long a1 __unused)
1028 {
1029 	return 0;
1030 }
1031 DECLARE_KEEP_PAGER(thread_cpu_suspend_handler);
1032 
1033 unsigned long __weak thread_cpu_resume_handler(unsigned long a0 __unused,
1034 					       unsigned long a1 __unused)
1035 {
1036 	return 0;
1037 }
1038 DECLARE_KEEP_PAGER(thread_cpu_resume_handler);
1039 
1040 unsigned long __weak thread_system_off_handler(unsigned long a0 __unused,
1041 					       unsigned long a1 __unused)
1042 {
1043 	return 0;
1044 }
1045 DECLARE_KEEP_PAGER(thread_system_off_handler);
1046 
1047 unsigned long __weak thread_system_reset_handler(unsigned long a0 __unused,
1048 						 unsigned long a1 __unused)
1049 {
1050 	return 0;
1051 }
1052 DECLARE_KEEP_PAGER(thread_system_reset_handler);
1053 #endif /*CFG_WITH_ARM_TRUSTED_FW*/
1054