1*4882a593Smuzhiyun /* SPDX-License-Identifier: GPL-2.0 */
2*4882a593Smuzhiyun /* Copyright (C) 2019 ARM Limited */
3*4882a593Smuzhiyun #ifndef __TESTCASES_H__
4*4882a593Smuzhiyun #define __TESTCASES_H__
5*4882a593Smuzhiyun
6*4882a593Smuzhiyun #include <stddef.h>
7*4882a593Smuzhiyun #include <stdio.h>
8*4882a593Smuzhiyun #include <stdbool.h>
9*4882a593Smuzhiyun #include <stdint.h>
10*4882a593Smuzhiyun #include <stdlib.h>
11*4882a593Smuzhiyun #include <ucontext.h>
12*4882a593Smuzhiyun #include <signal.h>
13*4882a593Smuzhiyun
14*4882a593Smuzhiyun /* Architecture specific sigframe definitions */
15*4882a593Smuzhiyun #include <asm/sigcontext.h>
16*4882a593Smuzhiyun
17*4882a593Smuzhiyun #define FPSIMD_CTX (1 << 0)
18*4882a593Smuzhiyun #define SVE_CTX (1 << 1)
19*4882a593Smuzhiyun #define EXTRA_CTX (1 << 2)
20*4882a593Smuzhiyun
21*4882a593Smuzhiyun #define KSFT_BAD_MAGIC 0xdeadbeef
22*4882a593Smuzhiyun
23*4882a593Smuzhiyun #define HDR_SZ \
24*4882a593Smuzhiyun sizeof(struct _aarch64_ctx)
25*4882a593Smuzhiyun
26*4882a593Smuzhiyun #define GET_SF_RESV_HEAD(sf) \
27*4882a593Smuzhiyun (struct _aarch64_ctx *)(&(sf).uc.uc_mcontext.__reserved)
28*4882a593Smuzhiyun
29*4882a593Smuzhiyun #define GET_SF_RESV_SIZE(sf) \
30*4882a593Smuzhiyun sizeof((sf).uc.uc_mcontext.__reserved)
31*4882a593Smuzhiyun
32*4882a593Smuzhiyun #define GET_UCP_RESV_SIZE(ucp) \
33*4882a593Smuzhiyun sizeof((ucp)->uc_mcontext.__reserved)
34*4882a593Smuzhiyun
35*4882a593Smuzhiyun #define ASSERT_BAD_CONTEXT(uc) do { \
36*4882a593Smuzhiyun char *err = NULL; \
37*4882a593Smuzhiyun if (!validate_reserved((uc), GET_UCP_RESV_SIZE((uc)), &err)) { \
38*4882a593Smuzhiyun if (err) \
39*4882a593Smuzhiyun fprintf(stderr, \
40*4882a593Smuzhiyun "Using badly built context - ERR: %s\n",\
41*4882a593Smuzhiyun err); \
42*4882a593Smuzhiyun } else { \
43*4882a593Smuzhiyun abort(); \
44*4882a593Smuzhiyun } \
45*4882a593Smuzhiyun } while (0)
46*4882a593Smuzhiyun
47*4882a593Smuzhiyun #define ASSERT_GOOD_CONTEXT(uc) do { \
48*4882a593Smuzhiyun char *err = NULL; \
49*4882a593Smuzhiyun if (!validate_reserved((uc), GET_UCP_RESV_SIZE((uc)), &err)) { \
50*4882a593Smuzhiyun if (err) \
51*4882a593Smuzhiyun fprintf(stderr, \
52*4882a593Smuzhiyun "Detected BAD context - ERR: %s\n", err);\
53*4882a593Smuzhiyun abort(); \
54*4882a593Smuzhiyun } else { \
55*4882a593Smuzhiyun fprintf(stderr, "uc context validated.\n"); \
56*4882a593Smuzhiyun } \
57*4882a593Smuzhiyun } while (0)
58*4882a593Smuzhiyun
59*4882a593Smuzhiyun /*
60*4882a593Smuzhiyun * A simple record-walker for __reserved area: it walks through assuming
61*4882a593Smuzhiyun * only to find a proper struct __aarch64_ctx header descriptor.
62*4882a593Smuzhiyun *
63*4882a593Smuzhiyun * Instead it makes no assumptions on the content and ordering of the
64*4882a593Smuzhiyun * records, any needed bounds checking must be enforced by the caller
65*4882a593Smuzhiyun * if wanted: this way can be used by caller on any maliciously built bad
66*4882a593Smuzhiyun * contexts.
67*4882a593Smuzhiyun *
68*4882a593Smuzhiyun * head->size accounts both for payload and header _aarch64_ctx size !
69*4882a593Smuzhiyun */
70*4882a593Smuzhiyun #define GET_RESV_NEXT_HEAD(h) \
71*4882a593Smuzhiyun (struct _aarch64_ctx *)((char *)(h) + (h)->size)
72*4882a593Smuzhiyun
73*4882a593Smuzhiyun struct fake_sigframe {
74*4882a593Smuzhiyun siginfo_t info;
75*4882a593Smuzhiyun ucontext_t uc;
76*4882a593Smuzhiyun };
77*4882a593Smuzhiyun
78*4882a593Smuzhiyun
79*4882a593Smuzhiyun bool validate_reserved(ucontext_t *uc, size_t resv_sz, char **err);
80*4882a593Smuzhiyun
81*4882a593Smuzhiyun bool validate_extra_context(struct extra_context *extra, char **err);
82*4882a593Smuzhiyun
83*4882a593Smuzhiyun struct _aarch64_ctx *get_header(struct _aarch64_ctx *head, uint32_t magic,
84*4882a593Smuzhiyun size_t resv_sz, size_t *offset);
85*4882a593Smuzhiyun
get_terminator(struct _aarch64_ctx * head,size_t resv_sz,size_t * offset)86*4882a593Smuzhiyun static inline struct _aarch64_ctx *get_terminator(struct _aarch64_ctx *head,
87*4882a593Smuzhiyun size_t resv_sz,
88*4882a593Smuzhiyun size_t *offset)
89*4882a593Smuzhiyun {
90*4882a593Smuzhiyun return get_header(head, 0, resv_sz, offset);
91*4882a593Smuzhiyun }
92*4882a593Smuzhiyun
write_terminator_record(struct _aarch64_ctx * tail)93*4882a593Smuzhiyun static inline void write_terminator_record(struct _aarch64_ctx *tail)
94*4882a593Smuzhiyun {
95*4882a593Smuzhiyun if (tail) {
96*4882a593Smuzhiyun tail->magic = 0;
97*4882a593Smuzhiyun tail->size = 0;
98*4882a593Smuzhiyun }
99*4882a593Smuzhiyun }
100*4882a593Smuzhiyun
101*4882a593Smuzhiyun struct _aarch64_ctx *get_starting_head(struct _aarch64_ctx *shead,
102*4882a593Smuzhiyun size_t need_sz, size_t resv_sz,
103*4882a593Smuzhiyun size_t *offset);
104*4882a593Smuzhiyun #endif
105