riscv/cfi: Support ucontext under CFI

This patches only make the ucontext library work while CFI is enabled.
enabled. All security checks are skipped and should be implemented if
correspoding interface are landed into the kernel.
SSP is stored in the unused t3 slot in the sigcontext structure to avoid
breaking the current structure.

Co-authored-by: Nia Su <[email protected]>

Author: jaidTw

sysdeps/unix/sysv/linux/riscv/getcontext.S

@@ -17,11 +17,13 @@
    <https://www.gnu.org/licenses/>.  */
 
 #include "ucontext-macros.h"
+#include "tcb-offsets.h"
 
 /* int getcontext (ucontext_t *ucp) */
 
 	.text
 LEAF (__getcontext)
+	LPAD
 	SAVE_INT_REG (ra,   0, a0)
 	SAVE_INT_REG (ra,   1, a0)
 	SAVE_INT_REG (sp,   2, a0)
@@ -58,6 +60,28 @@ LEAF (__getcontext)
 	sw	a1, MCONTEXT_FSR(a0)
 #endif /* __riscv_float_abi_soft */
 
+#ifdef __riscv_shadow_stack
+	ssrdp	t0
+	beqz	t0, .Lskip_ss
+	/* Read ssp_base from TLS  */
+	ld	t1, SSP_BASE_OFFSET(tp)
+
+	bnez	t1, .Lbase_saved
+	/* if not found, use current ssp as the marker  */
+	mv	t1, t0
+	sd	t1, SSP_BASE_OFFSET(tp)
+
+.Lbase_saved:
+	/* Save caller's ssp and base marker to ucontext  */
+	REG_S	t1, UCONTEXT_SSP_BASE(a0)
+	REG_S	t0, UCONTEXT_SSP(a0)
+
+	/* clean up  */
+	xor	t0, t0, t0
+	xor	t1, t1, t1
+.Lskip_ss:
+#endif
+
 /* rt_sigprocmask (SIG_BLOCK, NULL, &ucp->uc_sigmask, _NSIG8) */
 	li	a3, _NSIG8
 	add     a2, a0, UCONTEXT_SIGMASK

sysdeps/unix/sysv/linux/riscv/makecontext.c

@@ -21,6 +21,7 @@
 #include <sys/ucontext.h>
 #include <stdarg.h>
 #include <assert.h>
+#include <sys/mman.h>
 
 void
 __makecontext (ucontext_t *ucp, void (*func) (void), int argc,
@@ -73,6 +74,23 @@ __makecontext (ucontext_t *ucp, void (*func) (void), int argc,
 
       va_end (vl);
     }
+#ifdef __riscv_shadow_stack
+  /* Allocate shadow stack for the new context  */
+  /* FIXME: we use user space as a temporary solution until
+     kernel provides such interface  */
+
+  unsigned long ss_size = ucp->uc_stack.ss_size >>
+			  STACK_SIZE_TO_SHADOW_STACK_SIZE_SHIFT;
+  unsigned long ss_page = (ss_size + 4096 - 1) / 4096 + 2;
+  ss_size = (ss_page - 2) * 4096;
+  void *ss_start = __mmap (NULL, ss_page * 4096, PROT_NONE,
+                           MAP_PRIVATE | MAP_ANONYMOUS, -1, 0);
+  ucp->uc_ssp_base = (unsigned long long) ss_start + 4096;
+  ucp->uc_ssp = ucp->uc_ssp_base + ss_size - sizeof (unsigned long long);
+  /* shadow stack token */
+  __mprotect ((void *) ucp->uc_ssp_base, ss_size, PROT_READ | PROT_WRITE);
+  *(unsigned long long *)ucp->uc_ssp = ucp->uc_ssp + sizeof(unsigned long long);
+#endif
 }
 
 weak_alias (__makecontext, makecontext)

sysdeps/unix/sysv/linux/riscv/setcontext.S

@@ -17,6 +17,7 @@
    <https://www.gnu.org/licenses/>.  */
 
 #include "ucontext-macros.h"
+#include "tcb-offsets.h"
 
 /*  int __setcontext (const ucontext_t *ucp)
 
@@ -29,6 +30,7 @@
 
 	.text
 LEAF (__setcontext)
+	LPAD
 
 	mv	t0, a0	/* Save ucp into t0.  */
 
@@ -45,6 +47,46 @@ LEAF (__setcontext)
 
 	cfi_def_cfa (t0, 0)
 
+#ifdef __riscv_shadow_stack
+	/* Skip if shadow stack is not enabled  */
+	ssrdp	ra
+	beqz	ra, .Lfin
+	/* We are safe to adjust shadow stack after the sanity check  */
+	REG_L	t1, UCONTEXT_SSP_BASE(t0)
+	REG_L	a1, UCONTEXT_SSP(t0)
+	REG_L   a2, SSP_BASE_OFFSET(tp)
+	bne	t1, a2, .Lstack_switch
+
+.Lunwind:
+	bleu    a1, ra, .Lfin
+	/* increase ssp by at most a page size to ensure always run into
+	   a guard page before accidentally point to another legal shadow
+	   stack page  */
+	/* ra = (a1 - ra >= 4096) ? ra + 4096 : a1  */
+	lui     t2, 1
+	add     ra, ra, t2
+	bleu    ra, a1, 1f
+	mv      ra, a1
+1:
+	csrw    ssp, ra
+	/* Test if the location pointed by ssp is legal  */
+	sspush  ra
+	sspopchk ra
+	j .Lunwind
+
+.Lstack_switch:
+	/* Create restore token  */
+	sspush  ra
+	/* Validate target restore token  */
+	ssamoswap.d a3, x0, (a1)
+	addi    a1, a1, 8
+	bne     a3, a1, 99f
+	/* Switch stack: update ssp and base  */
+	csrw    ssp, a1
+	REG_S   t1, SSP_BASE_OFFSET(tp)
+	.Lfin:
+#endif
+
 #ifndef __riscv_float_abi_soft
 	lw	t1, MCONTEXT_FSR(t0)
 
@@ -66,7 +108,11 @@ LEAF (__setcontext)
 
 	/* Note the contents of argument registers will be random
 	   unless makecontext() has been called.  */
+#ifdef __riscv_landing_pad
+	RESTORE_INT_REG     (t2,   0, t0)
+#else
 	RESTORE_INT_REG     (t1,   0, t0)
+#endif
 	RESTORE_INT_REG_CFI (ra,   1, t0)
 	RESTORE_INT_REG     (sp,   2, t0)
 	RESTORE_INT_REG_CFI (s0,   8, t0)
@@ -90,7 +136,12 @@ LEAF (__setcontext)
 	RESTORE_INT_REG_CFI (s10, 26, t0)
 	RESTORE_INT_REG_CFI (s11, 27, t0)
 
+#ifdef __riscv_landing_pad
+	/* We need to use software-guared jump */
+	jr	t2
+#else
 	jr	t1
+#endif
 
 99:	tail	__syscall_error
 
@@ -99,12 +150,19 @@ libc_hidden_def (__setcontext)
 weak_alias (__setcontext, setcontext)
 
 LEAF (__start_context)
+	LPAD
 
 	/* Terminate call stack by noting ra == 0.  Happily, s0 == 0 here.  */
 	cfi_register (ra, s0)
 
 	/* Call the function passed to makecontext.  */
+#ifdef __riscv_landing_pad
+	/* We need to use software-guared jump */
+	mv	t2, s1
+	jalr	t2
+#else
 	jalr	s1
+#endif
 
 	/* Invoke subsequent context if present, else exit(0).  */
 	mv	a0, s2

sysdeps/unix/sysv/linux/riscv/swapcontext.S

@@ -17,10 +17,12 @@
    <https://www.gnu.org/licenses/>.  */
 
 #include "ucontext-macros.h"
+#include "tcb-offsets.h"
 
 /* int swapcontext (ucontext_t *oucp, const ucontext_t *ucp) */
 
 LEAF (__swapcontext)
+	LPAD
 	mv	t0, a1			/* Save ucp into t0.  */
 
 	SAVE_INT_REG (ra,   0, a0)
@@ -59,6 +61,10 @@ LEAF (__swapcontext)
 	sw	a1, MCONTEXT_FSR(a0)
 #endif /* __riscv_float_abi_soft */
 
+#ifdef __riscv_shadow_stack
+	mv	t1, a0			/* Save oucp into t1.  */
+#endif
+
 /* rt_sigprocmask (SIG_SETMASK, &ucp->uc_sigmask, &oucp->uc_sigmask, _NSIG8) */
 	li	a3, _NSIG8
 	add	a2, a0, UCONTEXT_SIGMASK
@@ -70,6 +76,64 @@ LEAF (__swapcontext)
 
 	bltz	a0, 99f
 
+#ifdef __riscv_shadow_stack
+	/* Skip if shadow stack is not enabled */
+	ssrdp	ra
+	beqz	ra, .Lfin
+
+	/* Read ssp_base from TLS  */
+	ld	t2, SSP_BASE_OFFSET(tp)
+	bnez	t2, .Lbase_saved
+
+	/* if not found, use current ssp as the marker  */
+	mv	t2, ra
+	sd	t2, SSP_BASE_OFFSET(tp)
+
+.Lbase_saved:
+	/* Save caller's ssp and base marker to oucp  */
+	REG_S	t2, UCONTEXT_SSP_BASE(t1)
+
+	/* Load ss information from ucp  */
+	REG_L	a0, UCONTEXT_SSP_BASE(t0)
+	REG_L	a1, UCONTEXT_SSP(t0)
+	REG_L   a2, SSP_BASE_OFFSET(tp)
+	bne	a0, a2, .Lstack_switch
+
+.Lunwind:
+	/* Save ssp to oucp  */
+	REG_S	ra, UCONTEXT_SSP(t1)
+	bleu    a1, ra, .Lfin
+	/* increase ssp by at most a page size to ensure always run into
+	   a guard page before accidentally point to another legal shadow
+	   stack page  */
+	/* ra = (a1 - ra >= 4096) ? ra + 4096 : a1  */
+	lui     t2, 1
+	add     ra, ra, t2
+	bleu    ra, a1, 1f
+	mv      ra, a1
+1:
+	csrw    ssp, ra
+	/* Test if the location pointed by ssp is legal  */
+	sspush  ra
+	sspopchk ra
+	j .Lunwind
+
+.Lstack_switch:
+	/* Create restore token  */
+	sspush  ra
+	/* Reload and save ssp to oucp after adjustion  */
+	ssrdp   ra
+	REG_S	ra, UCONTEXT_SSP(t1)
+	/* Validate target restore token  */
+	ssamoswap.d a3, x0, (a1)
+	addi    a1, a1, 8
+	bne     a3, a1, 99f
+	/* Switch stack: update ssp and base  */
+	csrw    ssp, a1
+	REG_S   a0, SSP_BASE_OFFSET(tp)
+.Lfin:
+#endif
+
 #ifndef __riscv_float_abi_soft
 	lw	t1, MCONTEXT_FSR(t0)
 
@@ -91,7 +155,11 @@ LEAF (__swapcontext)
 
 	/* Note the contents of argument registers will be random
 	   unless makecontext() has been called.  */
+#ifdef __riscv_landing_pad
+	RESTORE_INT_REG (t2,   0, t0)
+#else
 	RESTORE_INT_REG (t1,   0, t0)
+#endif
 	RESTORE_INT_REG (ra,   1, t0)
 	RESTORE_INT_REG (sp,   2, t0)
 	RESTORE_INT_REG (s0,   8, t0)
@@ -115,8 +183,12 @@ LEAF (__swapcontext)
 	RESTORE_INT_REG (s10, 26, t0)
 	RESTORE_INT_REG (s11, 27, t0)
 
+#ifdef __riscv_landing_pad
+	/* We need to use software-guared jump */
+	jr	t2
+#else
 	jr	t1
-
+#endif
 
 99:	tail	__syscall_error
 

sysdeps/unix/sysv/linux/riscv/sysdep.h

@@ -207,6 +207,8 @@ GNU_PROPERTY (FEATURE_1_AND, __VALUE_FOR_FEATURE_1_AND)
 
 #else /* !__ASSEMBLER__ */
 
+# define STACK_SIZE_TO_SHADOW_STACK_SIZE_SHIFT 5
+
 # if __WORDSIZE == 64
 #  define VDSO_NAME	"LINUX_4.15"
 #  define VDSO_HASH	182943605