1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef _PKEYS_HELPER_H 3 #define _PKEYS_HELPER_H 4 #define _GNU_SOURCE 5 #include <string.h> 6 #include <stdarg.h> 7 #include <stdio.h> 8 #include <stdint.h> 9 #include <stdbool.h> 10 #include <signal.h> 11 #include <assert.h> 12 #include <stdlib.h> 13 #include <ucontext.h> 14 #include <sys/mman.h> 15 16 #include <linux/mman.h> 17 #include <linux/types.h> 18 19 #include "kselftest.h" 20 21 /* Define some kernel-like types */ 22 typedef __u8 u8; 23 typedef __u16 u16; 24 typedef __u32 u32; 25 typedef __u64 u64; 26 27 #define PTR_ERR_ENOTSUP ((void *)-ENOTSUP) 28 29 #ifndef DEBUG_LEVEL 30 #define DEBUG_LEVEL 0 31 #endif 32 extern int dprint_in_signal; 33 34 extern int test_nr; 35 extern int iteration_nr; 36 37 #ifdef __GNUC__ 38 __printf(1, 2) 39 #endif 40 static inline void sigsafe_printf(const char *format, ...) 41 { 42 va_list ap; 43 44 if (!dprint_in_signal) { 45 va_start(ap, format); 46 vprintf(format, ap); 47 va_end(ap); 48 } else { 49 int ret; 50 /* 51 * No printf() functions are signal-safe. 52 * They deadlock easily. Write the format 53 * string to get some output, even if 54 * incomplete. 55 */ 56 ret = write(1, format, strlen(format)); 57 if (ret < 0) 58 exit(1); 59 } 60 } 61 #define dprintf_level(level, args...) do { \ 62 if (level <= DEBUG_LEVEL) \ 63 sigsafe_printf(args); \ 64 } while (0) 65 #define dprintf0(args...) dprintf_level(0, args) 66 #define dprintf1(args...) dprintf_level(1, args) 67 #define dprintf2(args...) dprintf_level(2, args) 68 #define dprintf3(args...) dprintf_level(3, args) 69 #define dprintf4(args...) dprintf_level(4, args) 70 71 void tracing_on(void); 72 void tracing_off(void); 73 void abort_hooks(void); 74 #define pkey_assert(condition) do { \ 75 if (!(condition)) { \ 76 dprintf0("# assert() at %s::%d test_nr: %d iteration: %d\n", \ 77 __FILE__, __LINE__, \ 78 test_nr, iteration_nr); \ 79 dprintf0("# errno at assert: %d\n", errno); \ 80 abort_hooks(); \ 81 ksft_exit_fail_msg("test %d (iteration %d)\n", \ 82 test_nr, iteration_nr); \ 83 } \ 84 } while (0) 85 86 #define barrier() __asm__ __volatile__("": : :"memory") 87 #ifndef noinline 88 # define noinline __attribute__((noinline)) 89 #endif 90 91 int sys_pkey_alloc(unsigned long flags, unsigned long init_val); 92 int sys_pkey_free(unsigned long pkey); 93 int sys_mprotect_pkey(void *ptr, size_t size, unsigned long orig_prot, 94 unsigned long pkey); 95 96 /* For functions called from protection_keys.c only */ 97 noinline int read_ptr(int *ptr); 98 void expected_pkey_fault(int pkey); 99 int mprotect_pkey(void *ptr, size_t size, unsigned long orig_prot, 100 unsigned long pkey); 101 void record_pkey_malloc(void *ptr, long size, int prot); 102 103 #if defined(__i386__) || defined(__x86_64__) /* arch */ 104 #include "pkey-x86.h" 105 #elif defined(__powerpc64__) /* arch */ 106 #include "pkey-powerpc.h" 107 #elif defined(__aarch64__) /* arch */ 108 #include "pkey-arm64.h" 109 #else /* arch */ 110 #error Architecture not supported 111 #endif /* arch */ 112 113 #ifndef PKEY_MASK 114 #define PKEY_MASK (PKEY_DISABLE_ACCESS | PKEY_DISABLE_WRITE) 115 #endif 116 117 #ifndef set_pkey_bits 118 static inline u64 set_pkey_bits(u64 reg, int pkey, u64 flags) 119 { 120 u32 shift = pkey_bit_position(pkey); 121 /* mask out bits from pkey in old value */ 122 reg &= ~((u64)PKEY_MASK << shift); 123 /* OR in new bits for pkey */ 124 reg |= (flags & PKEY_MASK) << shift; 125 return reg; 126 } 127 #endif 128 129 #ifndef get_pkey_bits 130 static inline u64 get_pkey_bits(u64 reg, int pkey) 131 { 132 u32 shift = pkey_bit_position(pkey); 133 /* 134 * shift down the relevant bits to the lowest two, then 135 * mask off all the other higher bits 136 */ 137 return ((reg >> shift) & PKEY_MASK); 138 } 139 #endif 140 141 extern u64 shadow_pkey_reg; 142 143 static inline u64 _read_pkey_reg(int line) 144 { 145 u64 pkey_reg = __read_pkey_reg(); 146 147 dprintf4("read_pkey_reg(line=%d) pkey_reg: %016llx" 148 " shadow: %016llx\n", 149 line, pkey_reg, shadow_pkey_reg); 150 assert(pkey_reg == shadow_pkey_reg); 151 152 return pkey_reg; 153 } 154 155 #define read_pkey_reg() _read_pkey_reg(__LINE__) 156 157 static inline void write_pkey_reg(u64 pkey_reg) 158 { 159 dprintf4("%s() changing %016llx to %016llx\n", __func__, 160 __read_pkey_reg(), pkey_reg); 161 /* will do the shadow check for us: */ 162 read_pkey_reg(); 163 __write_pkey_reg(pkey_reg); 164 shadow_pkey_reg = pkey_reg; 165 dprintf4("%s(%016llx) pkey_reg: %016llx\n", __func__, 166 pkey_reg, __read_pkey_reg()); 167 } 168 169 #define ALIGN_UP(x, align_to) (((x) + ((align_to)-1)) & ~((align_to)-1)) 170 #define ALIGN_DOWN(x, align_to) ((x) & ~((align_to)-1)) 171 #define ALIGN_PTR_UP(p, ptr_align_to) \ 172 ((typeof(p))ALIGN_UP((unsigned long)(p), ptr_align_to)) 173 #define ALIGN_PTR_DOWN(p, ptr_align_to) \ 174 ((typeof(p))ALIGN_DOWN((unsigned long)(p), ptr_align_to)) 175 #define __stringify_1(x...) #x 176 #define __stringify(x...) __stringify_1(x) 177 178 static inline u32 *siginfo_get_pkey_ptr(siginfo_t *si) 179 { 180 #ifdef si_pkey 181 return &si->si_pkey; 182 #else 183 return (u32 *)(((u8 *)si) + si_pkey_offset); 184 #endif 185 } 186 187 static inline int kernel_has_pkeys(void) 188 { 189 /* try allocating a key and see if it succeeds */ 190 int ret = sys_pkey_alloc(0, PKEY_UNRESTRICTED); 191 if (ret <= 0) { 192 return 0; 193 } 194 sys_pkey_free(ret); 195 return 1; 196 } 197 198 static inline int is_pkeys_supported(void) 199 { 200 /* check if the cpu supports pkeys */ 201 if (!cpu_has_pkeys()) { 202 dprintf1("SKIP: %s: no CPU support\n", __func__); 203 return 0; 204 } 205 206 /* check if the kernel supports pkeys */ 207 if (!kernel_has_pkeys()) { 208 dprintf1("SKIP: %s: no kernel support\n", __func__); 209 return 0; 210 } 211 212 return 1; 213 } 214 215 #endif /* _PKEYS_HELPER_H */ 216