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
validate_extra_context(struct extra_context * extra,char ** err,void ** extra_data,size_t * extra_size)9ff89a819SMark Brown bool validate_extra_context(struct extra_context *extra, char **err,
10ff89a819SMark Brown void **extra_data, size_t *extra_size)
11f96bf434SCristian Marussi {
12f96bf434SCristian Marussi struct _aarch64_ctx *term;
13f96bf434SCristian Marussi
14f96bf434SCristian Marussi if (!extra || !err)
15f96bf434SCristian Marussi return false;
16f96bf434SCristian Marussi
17f96bf434SCristian Marussi fprintf(stderr, "Validating EXTRA...\n");
185c152c2fSMark Brown term = GET_RESV_NEXT_HEAD(&extra->head);
19f96bf434SCristian Marussi if (!term || term->magic || term->size) {
20f96bf434SCristian Marussi *err = "Missing terminator after EXTRA context";
21f96bf434SCristian Marussi return false;
22f96bf434SCristian Marussi }
23f96bf434SCristian Marussi if (extra->datap & 0x0fUL)
24f96bf434SCristian Marussi *err = "Extra DATAP misaligned";
25f96bf434SCristian Marussi else if (extra->size & 0x0fUL)
26f96bf434SCristian Marussi *err = "Extra SIZE misaligned";
27b721c823SMark Brown else if (extra->datap != (uint64_t)term + 0x10UL)
2832667745SColin Ian King *err = "Extra DATAP misplaced (not contiguous)";
29f96bf434SCristian Marussi if (*err)
30f96bf434SCristian Marussi return false;
31f96bf434SCristian Marussi
32ff89a819SMark Brown *extra_data = (void *)extra->datap;
33ff89a819SMark Brown *extra_size = extra->size;
34ff89a819SMark Brown
35f96bf434SCristian Marussi return true;
36f96bf434SCristian Marussi }
37f96bf434SCristian Marussi
validate_sve_context(struct sve_context * sve,char ** err)38ace19b18SMark Brown bool validate_sve_context(struct sve_context *sve, char **err)
39ace19b18SMark Brown {
40ace19b18SMark Brown /* Size will be rounded up to a multiple of 16 bytes */
41ace19b18SMark Brown size_t regs_size
42ace19b18SMark Brown = ((SVE_SIG_CONTEXT_SIZE(sve_vq_from_vl(sve->vl)) + 15) / 16) * 16;
43ace19b18SMark Brown
44ace19b18SMark Brown if (!sve || !err)
45ace19b18SMark Brown return false;
46ace19b18SMark Brown
47ace19b18SMark Brown /* Either a bare sve_context or a sve_context followed by regs data */
48ace19b18SMark Brown if ((sve->head.size != sizeof(struct sve_context)) &&
49ace19b18SMark Brown (sve->head.size != regs_size)) {
50ace19b18SMark Brown *err = "bad size for SVE context";
51ace19b18SMark Brown return false;
52ace19b18SMark Brown }
53ace19b18SMark Brown
54ace19b18SMark Brown if (!sve_vl_valid(sve->vl)) {
55ace19b18SMark Brown *err = "SVE VL invalid";
56ace19b18SMark Brown
57ace19b18SMark Brown return false;
58ace19b18SMark Brown }
59ace19b18SMark Brown
60ace19b18SMark Brown return true;
61ace19b18SMark Brown }
62ace19b18SMark Brown
validate_za_context(struct za_context * za,char ** err)631a792b54SMark Brown bool validate_za_context(struct za_context *za, char **err)
641a792b54SMark Brown {
651a792b54SMark Brown /* Size will be rounded up to a multiple of 16 bytes */
661a792b54SMark Brown size_t regs_size
671a792b54SMark Brown = ((ZA_SIG_CONTEXT_SIZE(sve_vq_from_vl(za->vl)) + 15) / 16) * 16;
681a792b54SMark Brown
691a792b54SMark Brown if (!za || !err)
701a792b54SMark Brown return false;
711a792b54SMark Brown
721a792b54SMark Brown /* Either a bare za_context or a za_context followed by regs data */
731a792b54SMark Brown if ((za->head.size != sizeof(struct za_context)) &&
741a792b54SMark Brown (za->head.size != regs_size)) {
751a792b54SMark Brown *err = "bad size for ZA context";
761a792b54SMark Brown return false;
771a792b54SMark Brown }
781a792b54SMark Brown
791a792b54SMark Brown if (!sve_vl_valid(za->vl)) {
801a792b54SMark Brown *err = "SME VL in ZA context invalid";
811a792b54SMark Brown
821a792b54SMark Brown return false;
831a792b54SMark Brown }
841a792b54SMark Brown
851a792b54SMark Brown return true;
861a792b54SMark Brown }
871a792b54SMark Brown
validate_zt_context(struct zt_context * zt,char ** err)88afe6f182SMark Brown bool validate_zt_context(struct zt_context *zt, char **err)
89afe6f182SMark Brown {
90afe6f182SMark Brown if (!zt || !err)
91afe6f182SMark Brown return false;
92afe6f182SMark Brown
93afe6f182SMark Brown /* If the context is present there should be at least one register */
94afe6f182SMark Brown if (zt->nregs == 0) {
95afe6f182SMark Brown *err = "no registers";
96afe6f182SMark Brown return false;
97afe6f182SMark Brown }
98afe6f182SMark Brown
99afe6f182SMark Brown /* Size should agree with the number of registers */
100afe6f182SMark Brown if (zt->head.size != ZT_SIG_CONTEXT_SIZE(zt->nregs)) {
101afe6f182SMark Brown *err = "register count does not match size";
102afe6f182SMark Brown return false;
103afe6f182SMark Brown }
104afe6f182SMark Brown
105afe6f182SMark Brown return true;
106afe6f182SMark Brown }
107afe6f182SMark Brown
validate_reserved(ucontext_t * uc,size_t resv_sz,char ** err)108f96bf434SCristian Marussi bool validate_reserved(ucontext_t *uc, size_t resv_sz, char **err)
109f96bf434SCristian Marussi {
110f96bf434SCristian Marussi bool terminated = false;
111f96bf434SCristian Marussi size_t offs = 0;
112f96bf434SCristian Marussi int flags = 0;
1139b283888SMark Brown int new_flags, i;
114f96bf434SCristian Marussi struct extra_context *extra = NULL;
115ace19b18SMark Brown struct sve_context *sve = NULL;
1161a792b54SMark Brown struct za_context *za = NULL;
117afe6f182SMark Brown struct zt_context *zt = NULL;
118f96bf434SCristian Marussi struct _aarch64_ctx *head =
119f96bf434SCristian Marussi (struct _aarch64_ctx *)uc->uc_mcontext.__reserved;
120ff89a819SMark Brown void *extra_data = NULL;
121ff89a819SMark Brown size_t extra_sz = 0;
1229b283888SMark Brown char magic[4];
123f96bf434SCristian Marussi
124f96bf434SCristian Marussi if (!err)
125f96bf434SCristian Marussi return false;
126f96bf434SCristian Marussi /* Walk till the end terminator verifying __reserved contents */
127f96bf434SCristian Marussi while (head && !terminated && offs < resv_sz) {
128f96bf434SCristian Marussi if ((uint64_t)head & 0x0fUL) {
129f96bf434SCristian Marussi *err = "Misaligned HEAD";
130f96bf434SCristian Marussi return false;
131f96bf434SCristian Marussi }
132f96bf434SCristian Marussi
1331998c823SMark Brown new_flags = 0;
1341998c823SMark Brown
135f96bf434SCristian Marussi switch (head->magic) {
136f96bf434SCristian Marussi case 0:
137ff89a819SMark Brown if (head->size) {
138f96bf434SCristian Marussi *err = "Bad size for terminator";
139ff89a819SMark Brown } else if (extra_data) {
140ff89a819SMark Brown /* End of main data, walking the extra data */
141ff89a819SMark Brown head = extra_data;
142ff89a819SMark Brown resv_sz = extra_sz;
143ff89a819SMark Brown offs = 0;
144ff89a819SMark Brown
145ff89a819SMark Brown extra_data = NULL;
146ff89a819SMark Brown extra_sz = 0;
147ff89a819SMark Brown continue;
148ff89a819SMark Brown } else {
149f96bf434SCristian Marussi terminated = true;
150ff89a819SMark Brown }
151f96bf434SCristian Marussi break;
152f96bf434SCristian Marussi case FPSIMD_MAGIC:
153f96bf434SCristian Marussi if (flags & FPSIMD_CTX)
154f96bf434SCristian Marussi *err = "Multiple FPSIMD_MAGIC";
155f96bf434SCristian Marussi else if (head->size !=
156f96bf434SCristian Marussi sizeof(struct fpsimd_context))
157f96bf434SCristian Marussi *err = "Bad size for fpsimd_context";
1581998c823SMark Brown new_flags |= FPSIMD_CTX;
159f96bf434SCristian Marussi break;
160f96bf434SCristian Marussi case ESR_MAGIC:
161f96bf434SCristian Marussi if (head->size != sizeof(struct esr_context))
162f96bf434SCristian Marussi *err = "Bad size for esr_context";
163f96bf434SCristian Marussi break;
164*d3c6e5b1SJoey Gouly case POE_MAGIC:
165*d3c6e5b1SJoey Gouly if (head->size != sizeof(struct poe_context))
166*d3c6e5b1SJoey Gouly *err = "Bad size for poe_context";
167*d3c6e5b1SJoey Gouly break;
168bae393daSMark Brown case TPIDR2_MAGIC:
169bae393daSMark Brown if (head->size != sizeof(struct tpidr2_context))
170bae393daSMark Brown *err = "Bad size for tpidr2_context";
171bae393daSMark Brown break;
172f96bf434SCristian Marussi case SVE_MAGIC:
173f96bf434SCristian Marussi if (flags & SVE_CTX)
174f96bf434SCristian Marussi *err = "Multiple SVE_MAGIC";
175ace19b18SMark Brown /* Size is validated in validate_sve_context() */
176ace19b18SMark Brown sve = (struct sve_context *)head;
1771998c823SMark Brown new_flags |= SVE_CTX;
178f96bf434SCristian Marussi break;
1791a792b54SMark Brown case ZA_MAGIC:
1801a792b54SMark Brown if (flags & ZA_CTX)
1811a792b54SMark Brown *err = "Multiple ZA_MAGIC";
1821a792b54SMark Brown /* Size is validated in validate_za_context() */
1831a792b54SMark Brown za = (struct za_context *)head;
1841998c823SMark Brown new_flags |= ZA_CTX;
1851a792b54SMark Brown break;
186afe6f182SMark Brown case ZT_MAGIC:
187afe6f182SMark Brown if (flags & ZT_CTX)
188afe6f182SMark Brown *err = "Multiple ZT_MAGIC";
189afe6f182SMark Brown /* Size is validated in validate_za_context() */
190afe6f182SMark Brown zt = (struct zt_context *)head;
191afe6f182SMark Brown new_flags |= ZT_CTX;
192afe6f182SMark Brown break;
193f4dcccddSMark Brown case FPMR_MAGIC:
194f4dcccddSMark Brown if (flags & FPMR_CTX)
195f4dcccddSMark Brown *err = "Multiple FPMR_MAGIC";
196f4dcccddSMark Brown else if (head->size !=
197f4dcccddSMark Brown sizeof(struct fpmr_context))
198f4dcccddSMark Brown *err = "Bad size for fpmr_context";
199f4dcccddSMark Brown new_flags |= FPMR_CTX;
200f4dcccddSMark Brown break;
201f96bf434SCristian Marussi case EXTRA_MAGIC:
202f96bf434SCristian Marussi if (flags & EXTRA_CTX)
203f96bf434SCristian Marussi *err = "Multiple EXTRA_MAGIC";
204f96bf434SCristian Marussi else if (head->size !=
205f96bf434SCristian Marussi sizeof(struct extra_context))
206f96bf434SCristian Marussi *err = "Bad size for extra_context";
2071998c823SMark Brown new_flags |= EXTRA_CTX;
208f96bf434SCristian Marussi extra = (struct extra_context *)head;
209f96bf434SCristian Marussi break;
210f96bf434SCristian Marussi case KSFT_BAD_MAGIC:
211f96bf434SCristian Marussi /*
212f96bf434SCristian Marussi * This is a BAD magic header defined
213f96bf434SCristian Marussi * artificially by a testcase and surely
214f96bf434SCristian Marussi * unknown to the Kernel parse_user_sigframe().
215f96bf434SCristian Marussi * It MUST cause a Kernel induced SEGV
216f96bf434SCristian Marussi */
217f96bf434SCristian Marussi *err = "BAD MAGIC !";
218f96bf434SCristian Marussi break;
219f96bf434SCristian Marussi default:
220f96bf434SCristian Marussi /*
221f96bf434SCristian Marussi * A still unknown Magic: potentially freshly added
222f96bf434SCristian Marussi * to the Kernel code and still unknown to the
2239b283888SMark Brown * tests. Magic numbers are supposed to be allocated
2249b283888SMark Brown * as somewhat meaningful ASCII strings so try to
2259b283888SMark Brown * print as such as well as the raw number.
226f96bf434SCristian Marussi */
2279b283888SMark Brown memcpy(magic, &head->magic, sizeof(magic));
2289b283888SMark Brown for (i = 0; i < sizeof(magic); i++)
2299b283888SMark Brown if (!isalnum(magic[i]))
2309b283888SMark Brown magic[i] = '?';
2319b283888SMark Brown
232f96bf434SCristian Marussi fprintf(stdout,
2339b283888SMark Brown "SKIP Unknown MAGIC: 0x%X (%c%c%c%c) - Is KSFT arm64/signal up to date ?\n",
2349b283888SMark Brown head->magic,
2359b283888SMark Brown magic[3], magic[2], magic[1], magic[0]);
236f96bf434SCristian Marussi break;
237f96bf434SCristian Marussi }
238f96bf434SCristian Marussi
239f96bf434SCristian Marussi if (*err)
240f96bf434SCristian Marussi return false;
241f96bf434SCristian Marussi
242f96bf434SCristian Marussi offs += head->size;
243f96bf434SCristian Marussi if (resv_sz < offs + sizeof(*head)) {
244f96bf434SCristian Marussi *err = "HEAD Overrun";
245f96bf434SCristian Marussi return false;
246f96bf434SCristian Marussi }
247f96bf434SCristian Marussi
2481998c823SMark Brown if (new_flags & EXTRA_CTX)
249ff89a819SMark Brown if (!validate_extra_context(extra, err,
250ff89a819SMark Brown &extra_data, &extra_sz))
251f96bf434SCristian Marussi return false;
2521998c823SMark Brown if (new_flags & SVE_CTX)
253ace19b18SMark Brown if (!validate_sve_context(sve, err))
254ace19b18SMark Brown return false;
2551998c823SMark Brown if (new_flags & ZA_CTX)
2561a792b54SMark Brown if (!validate_za_context(za, err))
2571a792b54SMark Brown return false;
258afe6f182SMark Brown if (new_flags & ZT_CTX)
259afe6f182SMark Brown if (!validate_zt_context(zt, err))
260afe6f182SMark Brown return false;
261f96bf434SCristian Marussi
2621998c823SMark Brown flags |= new_flags;
2631998c823SMark Brown
264f96bf434SCristian Marussi head = GET_RESV_NEXT_HEAD(head);
265f96bf434SCristian Marussi }
266f96bf434SCristian Marussi
267f96bf434SCristian Marussi if (terminated && !(flags & FPSIMD_CTX)) {
268f96bf434SCristian Marussi *err = "Missing FPSIMD";
269f96bf434SCristian Marussi return false;
270f96bf434SCristian Marussi }
271f96bf434SCristian Marussi
272afe6f182SMark Brown if (terminated && (flags & ZT_CTX) && !(flags & ZA_CTX)) {
273afe6f182SMark Brown *err = "ZT context but no ZA context";
274afe6f182SMark Brown return false;
275afe6f182SMark Brown }
276afe6f182SMark Brown
277f96bf434SCristian Marussi return true;
278f96bf434SCristian Marussi }
2796c2aa428SCristian Marussi
2806c2aa428SCristian Marussi /*
2816c2aa428SCristian Marussi * This function walks through the records inside the provided reserved area
2826c2aa428SCristian Marussi * trying to find enough space to fit @need_sz bytes: if not enough space is
2836c2aa428SCristian Marussi * available and an extra_context record is present, it throws away the
2846c2aa428SCristian Marussi * extra_context record.
2856c2aa428SCristian Marussi *
2866c2aa428SCristian Marussi * It returns a pointer to a new header where it is possible to start storing
2876c2aa428SCristian Marussi * our need_sz bytes.
2886c2aa428SCristian Marussi *
2896c2aa428SCristian Marussi * @shead: points to the start of reserved area
2906c2aa428SCristian Marussi * @need_sz: needed bytes
2916c2aa428SCristian Marussi * @resv_sz: reserved area size in bytes
2926c2aa428SCristian Marussi * @offset: if not null, this will be filled with the offset of the return
2936c2aa428SCristian Marussi * head pointer from @shead
2946c2aa428SCristian Marussi *
2956c2aa428SCristian Marussi * @return: pointer to a new head where to start storing need_sz bytes, or
2966c2aa428SCristian Marussi * NULL if space could not be made available.
2976c2aa428SCristian Marussi */
get_starting_head(struct _aarch64_ctx * shead,size_t need_sz,size_t resv_sz,size_t * offset)2986c2aa428SCristian Marussi struct _aarch64_ctx *get_starting_head(struct _aarch64_ctx *shead,
2996c2aa428SCristian Marussi size_t need_sz, size_t resv_sz,
3006c2aa428SCristian Marussi size_t *offset)
3016c2aa428SCristian Marussi {
3026c2aa428SCristian Marussi size_t offs = 0;
3036c2aa428SCristian Marussi struct _aarch64_ctx *head;
3046c2aa428SCristian Marussi
3056c2aa428SCristian Marussi head = get_terminator(shead, resv_sz, &offs);
3066c2aa428SCristian Marussi /* not found a terminator...no need to update offset if any */
3076c2aa428SCristian Marussi if (!head)
3086c2aa428SCristian Marussi return head;
3096c2aa428SCristian Marussi if (resv_sz - offs < need_sz) {
3106c2aa428SCristian Marussi fprintf(stderr, "Low on space:%zd. Discarding extra_context.\n",
3116c2aa428SCristian Marussi resv_sz - offs);
3126c2aa428SCristian Marussi head = get_header(shead, EXTRA_MAGIC, resv_sz, &offs);
3136c2aa428SCristian Marussi if (!head || resv_sz - offs < need_sz) {
3146c2aa428SCristian Marussi fprintf(stderr,
3156c2aa428SCristian Marussi "Failed to reclaim space on sigframe.\n");
3166c2aa428SCristian Marussi return NULL;
3176c2aa428SCristian Marussi }
3186c2aa428SCristian Marussi }
3196c2aa428SCristian Marussi
3206c2aa428SCristian Marussi fprintf(stderr, "Available space:%zd\n", resv_sz - offs);
3216c2aa428SCristian Marussi if (offset)
3226c2aa428SCristian Marussi *offset = offs;
3236c2aa428SCristian Marussi return head;
3246c2aa428SCristian Marussi }
325