1f96bf434SCristian Marussi // SPDX-License-Identifier: GPL-2.0
2f96bf434SCristian Marussi /* Copyright (C) 2019 ARM Limited */
39b283888SMark Brown
49b283888SMark Brown #include <ctype.h>
59b283888SMark Brown #include <string.h>
69b283888SMark Brown
7f96bf434SCristian Marussi #include "testcases.h"
8f96bf434SCristian Marussi
get_header(struct _aarch64_ctx * head,uint32_t magic,size_t resv_sz,size_t * offset)9f96bf434SCristian Marussi struct _aarch64_ctx *get_header(struct _aarch64_ctx *head, uint32_t magic,
10f96bf434SCristian Marussi size_t resv_sz, size_t *offset)
11f96bf434SCristian Marussi {
12f96bf434SCristian Marussi size_t offs = 0;
13f96bf434SCristian Marussi struct _aarch64_ctx *found = NULL;
14f96bf434SCristian Marussi
15f96bf434SCristian Marussi if (!head || resv_sz < HDR_SZ)
16f96bf434SCristian Marussi return found;
17f96bf434SCristian Marussi
18f96bf434SCristian Marussi while (offs <= resv_sz - HDR_SZ &&
19f96bf434SCristian Marussi head->magic != magic && head->magic) {
20f96bf434SCristian Marussi offs += head->size;
21f96bf434SCristian Marussi head = GET_RESV_NEXT_HEAD(head);
22f96bf434SCristian Marussi }
23f96bf434SCristian Marussi if (head->magic == magic) {
24f96bf434SCristian Marussi found = head;
25f96bf434SCristian Marussi if (offset)
26f96bf434SCristian Marussi *offset = offs;
27f96bf434SCristian Marussi }
28f96bf434SCristian Marussi
29f96bf434SCristian Marussi return found;
30f96bf434SCristian Marussi }
31f96bf434SCristian Marussi
validate_extra_context(struct extra_context * extra,char ** err,void ** extra_data,size_t * extra_size)32ff89a819SMark Brown bool validate_extra_context(struct extra_context *extra, char **err,
33ff89a819SMark Brown void **extra_data, size_t *extra_size)
34f96bf434SCristian Marussi {
35f96bf434SCristian Marussi struct _aarch64_ctx *term;
36f96bf434SCristian Marussi
37f96bf434SCristian Marussi if (!extra || !err)
38f96bf434SCristian Marussi return false;
39f96bf434SCristian Marussi
40f96bf434SCristian Marussi fprintf(stderr, "Validating EXTRA...\n");
415c152c2fSMark Brown term = GET_RESV_NEXT_HEAD(&extra->head);
42f96bf434SCristian Marussi if (!term || term->magic || term->size) {
43f96bf434SCristian Marussi *err = "Missing terminator after EXTRA context";
44f96bf434SCristian Marussi return false;
45f96bf434SCristian Marussi }
46f96bf434SCristian Marussi if (extra->datap & 0x0fUL)
47f96bf434SCristian Marussi *err = "Extra DATAP misaligned";
48f96bf434SCristian Marussi else if (extra->size & 0x0fUL)
49f96bf434SCristian Marussi *err = "Extra SIZE misaligned";
50b721c823SMark Brown else if (extra->datap != (uint64_t)term + 0x10UL)
5132667745SColin Ian King *err = "Extra DATAP misplaced (not contiguous)";
52f96bf434SCristian Marussi if (*err)
53f96bf434SCristian Marussi return false;
54f96bf434SCristian Marussi
55ff89a819SMark Brown *extra_data = (void *)extra->datap;
56ff89a819SMark Brown *extra_size = extra->size;
57ff89a819SMark Brown
58f96bf434SCristian Marussi return true;
59f96bf434SCristian Marussi }
60f96bf434SCristian Marussi
validate_sve_context(struct sve_context * sve,char ** err)61ace19b18SMark Brown bool validate_sve_context(struct sve_context *sve, char **err)
62ace19b18SMark Brown {
63ace19b18SMark Brown /* Size will be rounded up to a multiple of 16 bytes */
64ace19b18SMark Brown size_t regs_size
65ace19b18SMark Brown = ((SVE_SIG_CONTEXT_SIZE(sve_vq_from_vl(sve->vl)) + 15) / 16) * 16;
66ace19b18SMark Brown
67ace19b18SMark Brown if (!sve || !err)
68ace19b18SMark Brown return false;
69ace19b18SMark Brown
70ace19b18SMark Brown /* Either a bare sve_context or a sve_context followed by regs data */
71ace19b18SMark Brown if ((sve->head.size != sizeof(struct sve_context)) &&
72ace19b18SMark Brown (sve->head.size != regs_size)) {
73ace19b18SMark Brown *err = "bad size for SVE context";
74ace19b18SMark Brown return false;
75ace19b18SMark Brown }
76ace19b18SMark Brown
77ace19b18SMark Brown if (!sve_vl_valid(sve->vl)) {
78ace19b18SMark Brown *err = "SVE VL invalid";
79ace19b18SMark Brown
80ace19b18SMark Brown return false;
81ace19b18SMark Brown }
82ace19b18SMark Brown
83ace19b18SMark Brown return true;
84ace19b18SMark Brown }
85ace19b18SMark Brown
validate_za_context(struct za_context * za,char ** err)861a792b54SMark Brown bool validate_za_context(struct za_context *za, char **err)
871a792b54SMark Brown {
881a792b54SMark Brown /* Size will be rounded up to a multiple of 16 bytes */
891a792b54SMark Brown size_t regs_size
901a792b54SMark Brown = ((ZA_SIG_CONTEXT_SIZE(sve_vq_from_vl(za->vl)) + 15) / 16) * 16;
911a792b54SMark Brown
921a792b54SMark Brown if (!za || !err)
931a792b54SMark Brown return false;
941a792b54SMark Brown
951a792b54SMark Brown /* Either a bare za_context or a za_context followed by regs data */
961a792b54SMark Brown if ((za->head.size != sizeof(struct za_context)) &&
971a792b54SMark Brown (za->head.size != regs_size)) {
981a792b54SMark Brown *err = "bad size for ZA context";
991a792b54SMark Brown return false;
1001a792b54SMark Brown }
1011a792b54SMark Brown
1021a792b54SMark Brown if (!sve_vl_valid(za->vl)) {
1031a792b54SMark Brown *err = "SME VL in ZA context invalid";
1041a792b54SMark Brown
1051a792b54SMark Brown return false;
1061a792b54SMark Brown }
1071a792b54SMark Brown
1081a792b54SMark Brown return true;
1091a792b54SMark Brown }
1101a792b54SMark Brown
validate_zt_context(struct zt_context * zt,char ** err)111f96bf434SCristian Marussi bool validate_zt_context(struct zt_context *zt, char **err)
112f96bf434SCristian Marussi {
113f96bf434SCristian Marussi if (!zt || !err)
114f96bf434SCristian Marussi return false;
115f96bf434SCristian Marussi
1169b283888SMark Brown /* If the context is present there should be at least one register */
117f96bf434SCristian Marussi if (zt->nregs == 0) {
118ace19b18SMark Brown *err = "no registers";
1191a792b54SMark Brown return false;
120f96bf434SCristian Marussi }
121f96bf434SCristian Marussi
122ff89a819SMark Brown /* Size should agree with the number of registers */
123ff89a819SMark Brown if (zt->head.size != ZT_SIG_CONTEXT_SIZE(zt->nregs)) {
1249b283888SMark Brown *err = "register count does not match size";
125f96bf434SCristian Marussi return false;
126f96bf434SCristian Marussi }
127f96bf434SCristian Marussi
128f96bf434SCristian Marussi return true;
129f96bf434SCristian Marussi }
130f96bf434SCristian Marussi
validate_reserved(ucontext_t * uc,size_t resv_sz,char ** err)131f96bf434SCristian Marussi bool validate_reserved(ucontext_t *uc, size_t resv_sz, char **err)
132f96bf434SCristian Marussi {
133f96bf434SCristian Marussi bool terminated = false;
134f96bf434SCristian Marussi size_t offs = 0;
1351998c823SMark Brown int flags = 0;
1361998c823SMark Brown int new_flags, i;
137f96bf434SCristian Marussi struct extra_context *extra = NULL;
138f96bf434SCristian Marussi struct sve_context *sve = NULL;
139ff89a819SMark Brown struct za_context *za = NULL;
140f96bf434SCristian Marussi struct zt_context *zt = NULL;
141ff89a819SMark Brown struct _aarch64_ctx *head =
142ff89a819SMark Brown (struct _aarch64_ctx *)uc->uc_mcontext.__reserved;
143ff89a819SMark Brown void *extra_data = NULL;
144ff89a819SMark Brown size_t extra_sz = 0;
145ff89a819SMark Brown char magic[4];
146ff89a819SMark Brown
147ff89a819SMark Brown if (!err)
148ff89a819SMark Brown return false;
149ff89a819SMark Brown /* Walk till the end terminator verifying __reserved contents */
150ff89a819SMark Brown while (head && !terminated && offs < resv_sz) {
151f96bf434SCristian Marussi if ((uint64_t)head & 0x0fUL) {
152ff89a819SMark Brown *err = "Misaligned HEAD";
153f96bf434SCristian Marussi return false;
154f96bf434SCristian Marussi }
155f96bf434SCristian Marussi
156f96bf434SCristian Marussi new_flags = 0;
157f96bf434SCristian Marussi
158f96bf434SCristian Marussi switch (head->magic) {
159f96bf434SCristian Marussi case 0:
1601998c823SMark Brown if (head->size) {
161f96bf434SCristian Marussi *err = "Bad size for terminator";
162f96bf434SCristian Marussi } else if (extra_data) {
163f96bf434SCristian Marussi /* End of main data, walking the extra data */
164f96bf434SCristian Marussi head = extra_data;
165f96bf434SCristian Marussi resv_sz = extra_sz;
166*bae393daSMark Brown offs = 0;
167*bae393daSMark Brown
168*bae393daSMark Brown extra_data = NULL;
169*bae393daSMark Brown extra_sz = 0;
170f96bf434SCristian Marussi continue;
171f96bf434SCristian Marussi } else {
172f96bf434SCristian Marussi terminated = true;
173ace19b18SMark Brown }
174ace19b18SMark Brown break;
1751998c823SMark Brown case FPSIMD_MAGIC:
176f96bf434SCristian Marussi if (flags & FPSIMD_CTX)
1771a792b54SMark Brown *err = "Multiple FPSIMD_MAGIC";
1781a792b54SMark Brown else if (head->size !=
1791a792b54SMark Brown sizeof(struct fpsimd_context))
1801a792b54SMark Brown *err = "Bad size for fpsimd_context";
1811a792b54SMark Brown new_flags |= FPSIMD_CTX;
1821998c823SMark Brown break;
1831a792b54SMark Brown case ESR_MAGIC:
184f96bf434SCristian Marussi if (head->size != sizeof(struct esr_context))
185f96bf434SCristian Marussi *err = "Bad size for esr_context";
186f96bf434SCristian Marussi break;
187f96bf434SCristian Marussi case TPIDR2_MAGIC:
188f96bf434SCristian Marussi if (head->size != sizeof(struct tpidr2_context))
189f96bf434SCristian Marussi *err = "Bad size for tpidr2_context";
1901998c823SMark Brown break;
191f96bf434SCristian Marussi case SVE_MAGIC:
192f96bf434SCristian Marussi if (flags & SVE_CTX)
193f96bf434SCristian Marussi *err = "Multiple SVE_MAGIC";
194f96bf434SCristian Marussi /* Size is validated in validate_sve_context() */
195f96bf434SCristian Marussi sve = (struct sve_context *)head;
196f96bf434SCristian Marussi new_flags |= SVE_CTX;
197f96bf434SCristian Marussi break;
198f96bf434SCristian Marussi case ZA_MAGIC:
199f96bf434SCristian Marussi if (flags & ZA_CTX)
200f96bf434SCristian Marussi *err = "Multiple ZA_MAGIC";
201f96bf434SCristian Marussi /* Size is validated in validate_za_context() */
202f96bf434SCristian Marussi za = (struct za_context *)head;
203f96bf434SCristian Marussi new_flags |= ZA_CTX;
204f96bf434SCristian Marussi break;
205f96bf434SCristian Marussi case ZT_MAGIC:
2069b283888SMark Brown if (flags & ZT_CTX)
2079b283888SMark Brown *err = "Multiple ZT_MAGIC";
2089b283888SMark Brown /* Size is validated in validate_za_context() */
209f96bf434SCristian Marussi zt = (struct zt_context *)head;
2109b283888SMark Brown new_flags |= ZT_CTX;
2119b283888SMark Brown break;
2129b283888SMark Brown case EXTRA_MAGIC:
2139b283888SMark Brown if (flags & EXTRA_CTX)
2149b283888SMark Brown *err = "Multiple EXTRA_MAGIC";
215f96bf434SCristian Marussi else if (head->size !=
2169b283888SMark Brown sizeof(struct extra_context))
2179b283888SMark Brown *err = "Bad size for extra_context";
2189b283888SMark Brown new_flags |= EXTRA_CTX;
219f96bf434SCristian Marussi extra = (struct extra_context *)head;
220f96bf434SCristian Marussi break;
221f96bf434SCristian Marussi case KSFT_BAD_MAGIC:
222f96bf434SCristian Marussi /*
223f96bf434SCristian Marussi * This is a BAD magic header defined
224f96bf434SCristian Marussi * artificially by a testcase and surely
225f96bf434SCristian Marussi * unknown to the Kernel parse_user_sigframe().
226f96bf434SCristian Marussi * It MUST cause a Kernel induced SEGV
227f96bf434SCristian Marussi */
228f96bf434SCristian Marussi *err = "BAD MAGIC !";
229f96bf434SCristian Marussi break;
230f96bf434SCristian Marussi default:
2311998c823SMark Brown /*
232ff89a819SMark Brown * A still unknown Magic: potentially freshly added
233ff89a819SMark Brown * to the Kernel code and still unknown to the
234f96bf434SCristian Marussi * tests. Magic numbers are supposed to be allocated
2351998c823SMark Brown * as somewhat meaningful ASCII strings so try to
236ace19b18SMark Brown * print as such as well as the raw number.
237ace19b18SMark Brown */
2381998c823SMark Brown memcpy(magic, &head->magic, sizeof(magic));
2391a792b54SMark Brown for (i = 0; i < sizeof(magic); i++)
2401a792b54SMark Brown if (!isalnum(magic[i]))
241f96bf434SCristian Marussi magic[i] = '?';
2421998c823SMark Brown
2431998c823SMark Brown fprintf(stdout,
244f96bf434SCristian Marussi "SKIP Unknown MAGIC: 0x%X (%c%c%c%c) - Is KSFT arm64/signal up to date ?\n",
245f96bf434SCristian Marussi head->magic,
246f96bf434SCristian Marussi magic[3], magic[2], magic[1], magic[0]);
247f96bf434SCristian Marussi break;
248f96bf434SCristian Marussi }
249f96bf434SCristian Marussi
250f96bf434SCristian Marussi if (*err)
251f96bf434SCristian Marussi return false;
252f96bf434SCristian Marussi
253f96bf434SCristian Marussi offs += head->size;
2546c2aa428SCristian Marussi if (resv_sz < offs + sizeof(*head)) {
2556c2aa428SCristian Marussi *err = "HEAD Overrun";
2566c2aa428SCristian Marussi return false;
2576c2aa428SCristian Marussi }
2586c2aa428SCristian Marussi
2596c2aa428SCristian Marussi if (new_flags & EXTRA_CTX)
2606c2aa428SCristian Marussi if (!validate_extra_context(extra, err,
2616c2aa428SCristian Marussi &extra_data, &extra_sz))
2626c2aa428SCristian Marussi return false;
2636c2aa428SCristian Marussi if (new_flags & SVE_CTX)
2646c2aa428SCristian Marussi if (!validate_sve_context(sve, err))
2656c2aa428SCristian Marussi return false;
2666c2aa428SCristian Marussi if (new_flags & ZA_CTX)
2676c2aa428SCristian Marussi if (!validate_za_context(za, err))
2686c2aa428SCristian Marussi return false;
2696c2aa428SCristian Marussi if (new_flags & ZT_CTX)
2706c2aa428SCristian Marussi if (!validate_zt_context(zt, err))
2716c2aa428SCristian Marussi return false;
2726c2aa428SCristian Marussi
2736c2aa428SCristian Marussi flags |= new_flags;
2746c2aa428SCristian Marussi
2756c2aa428SCristian Marussi head = GET_RESV_NEXT_HEAD(head);
2766c2aa428SCristian Marussi }
2776c2aa428SCristian Marussi
2786c2aa428SCristian Marussi if (terminated && !(flags & FPSIMD_CTX)) {
2796c2aa428SCristian Marussi *err = "Missing FPSIMD";
2806c2aa428SCristian Marussi return false;
2816c2aa428SCristian Marussi }
2826c2aa428SCristian Marussi
2836c2aa428SCristian Marussi if (terminated && (flags & ZT_CTX) && !(flags & ZA_CTX)) {
2846c2aa428SCristian Marussi *err = "ZT context but no ZA context";
2856c2aa428SCristian Marussi return false;
2866c2aa428SCristian Marussi }
2876c2aa428SCristian Marussi
2886c2aa428SCristian Marussi return true;
2896c2aa428SCristian Marussi }
2906c2aa428SCristian Marussi
2916c2aa428SCristian Marussi /*
2926c2aa428SCristian Marussi * This function walks through the records inside the provided reserved area
2936c2aa428SCristian Marussi * trying to find enough space to fit @need_sz bytes: if not enough space is
2946c2aa428SCristian Marussi * available and an extra_context record is present, it throws away the
2956c2aa428SCristian Marussi * extra_context record.
2966c2aa428SCristian Marussi *
2976c2aa428SCristian Marussi * It returns a pointer to a new header where it is possible to start storing
2986c2aa428SCristian Marussi * our need_sz bytes.
2996c2aa428SCristian Marussi *
300 * @shead: points to the start of reserved area
301 * @need_sz: needed bytes
302 * @resv_sz: reserved area size in bytes
303 * @offset: if not null, this will be filled with the offset of the return
304 * head pointer from @shead
305 *
306 * @return: pointer to a new head where to start storing need_sz bytes, or
307 * NULL if space could not be made available.
308 */
get_starting_head(struct _aarch64_ctx * shead,size_t need_sz,size_t resv_sz,size_t * offset)309 struct _aarch64_ctx *get_starting_head(struct _aarch64_ctx *shead,
310 size_t need_sz, size_t resv_sz,
311 size_t *offset)
312 {
313 size_t offs = 0;
314 struct _aarch64_ctx *head;
315
316 head = get_terminator(shead, resv_sz, &offs);
317 /* not found a terminator...no need to update offset if any */
318 if (!head)
319 return head;
320 if (resv_sz - offs < need_sz) {
321 fprintf(stderr, "Low on space:%zd. Discarding extra_context.\n",
322 resv_sz - offs);
323 head = get_header(shead, EXTRA_MAGIC, resv_sz, &offs);
324 if (!head || resv_sz - offs < need_sz) {
325 fprintf(stderr,
326 "Failed to reclaim space on sigframe.\n");
327 return NULL;
328 }
329 }
330
331 fprintf(stderr, "Available space:%zd\n", resv_sz - offs);
332 if (offset)
333 *offset = offs;
334 return head;
335 }
336