tjh.dev
Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
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 */
22typedef __u8 u8;
23typedef __u16 u16;
24typedef __u32 u32;
25typedef __u64 u64;
26
27#define PTR_ERR_ENOTSUP ((void *)-ENOTSUP)
28
29#ifndef DEBUG_LEVEL
30#define DEBUG_LEVEL 0
31#endif
32extern int dprint_in_signal;
33
34extern int test_nr;
35extern int iteration_nr;
36
37#ifdef __GNUC__
38__printf(1, 2)
39#endif
40static 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
71extern void abort_hooks(void);
72#define pkey_assert(condition) do { \
73 if (!(condition)) { \
74 dprintf0("assert() at %s::%d test_nr: %d iteration: %d\n", \
75 __FILE__, __LINE__, \
76 test_nr, iteration_nr); \
77 dprintf0("errno at assert: %d", errno); \
78 abort_hooks(); \
79 exit(__LINE__); \
80 } \
81} while (0)
82
83#define barrier() __asm__ __volatile__("": : :"memory")
84#ifndef noinline
85# define noinline __attribute__((noinline))
86#endif
87#ifndef __maybe_unused
88# define __maybe_unused __attribute__((__unused__))
89#endif
90
91int sys_pkey_alloc(unsigned long flags, unsigned long init_val);
92int sys_pkey_free(unsigned long pkey);
93int 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 */
97noinline int read_ptr(int *ptr);
98void expected_pkey_fault(int pkey);
99int mprotect_pkey(void *ptr, size_t size, unsigned long orig_prot,
100 unsigned long pkey);
101void 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/*
118 * FIXME: Remove once the generic PKEY_UNRESTRICTED definition is merged.
119 */
120#ifndef PKEY_UNRESTRICTED
121#define PKEY_UNRESTRICTED 0x0
122#endif
123
124#ifndef set_pkey_bits
125static inline u64 set_pkey_bits(u64 reg, int pkey, u64 flags)
126{
127 u32 shift = pkey_bit_position(pkey);
128 /* mask out bits from pkey in old value */
129 reg &= ~((u64)PKEY_MASK << shift);
130 /* OR in new bits for pkey */
131 reg |= (flags & PKEY_MASK) << shift;
132 return reg;
133}
134#endif
135
136#ifndef get_pkey_bits
137static inline u64 get_pkey_bits(u64 reg, int pkey)
138{
139 u32 shift = pkey_bit_position(pkey);
140 /*
141 * shift down the relevant bits to the lowest two, then
142 * mask off all the other higher bits
143 */
144 return ((reg >> shift) & PKEY_MASK);
145}
146#endif
147
148extern u64 shadow_pkey_reg;
149
150static inline u64 _read_pkey_reg(int line)
151{
152 u64 pkey_reg = __read_pkey_reg();
153
154 dprintf4("read_pkey_reg(line=%d) pkey_reg: %016llx"
155 " shadow: %016llx\n",
156 line, pkey_reg, shadow_pkey_reg);
157 assert(pkey_reg == shadow_pkey_reg);
158
159 return pkey_reg;
160}
161
162#define read_pkey_reg() _read_pkey_reg(__LINE__)
163
164static inline void write_pkey_reg(u64 pkey_reg)
165{
166 dprintf4("%s() changing %016llx to %016llx\n", __func__,
167 __read_pkey_reg(), pkey_reg);
168 /* will do the shadow check for us: */
169 read_pkey_reg();
170 __write_pkey_reg(pkey_reg);
171 shadow_pkey_reg = pkey_reg;
172 dprintf4("%s(%016llx) pkey_reg: %016llx\n", __func__,
173 pkey_reg, __read_pkey_reg());
174}
175
176#define ALIGN_UP(x, align_to) (((x) + ((align_to)-1)) & ~((align_to)-1))
177#define ALIGN_DOWN(x, align_to) ((x) & ~((align_to)-1))
178#define ALIGN_PTR_UP(p, ptr_align_to) \
179 ((typeof(p))ALIGN_UP((unsigned long)(p), ptr_align_to))
180#define ALIGN_PTR_DOWN(p, ptr_align_to) \
181 ((typeof(p))ALIGN_DOWN((unsigned long)(p), ptr_align_to))
182#define __stringify_1(x...) #x
183#define __stringify(x...) __stringify_1(x)
184
185static inline u32 *siginfo_get_pkey_ptr(siginfo_t *si)
186{
187#ifdef si_pkey
188 return &si->si_pkey;
189#else
190 return (u32 *)(((u8 *)si) + si_pkey_offset);
191#endif
192}
193
194static inline int kernel_has_pkeys(void)
195{
196 /* try allocating a key and see if it succeeds */
197 int ret = sys_pkey_alloc(0, PKEY_UNRESTRICTED);
198 if (ret <= 0) {
199 return 0;
200 }
201 sys_pkey_free(ret);
202 return 1;
203}
204
205static inline int is_pkeys_supported(void)
206{
207 /* check if the cpu supports pkeys */
208 if (!cpu_has_pkeys()) {
209 dprintf1("SKIP: %s: no CPU support\n", __func__);
210 return 0;
211 }
212
213 /* check if the kernel supports pkeys */
214 if (!kernel_has_pkeys()) {
215 dprintf1("SKIP: %s: no kernel support\n", __func__);
216 return 0;
217 }
218
219 return 1;
220}
221
222#endif /* _PKEYS_HELPER_H */