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/* Copyright (C) 2019 ARM Limited */
3
4#ifndef __TEST_SIGNALS_H__
5#define __TEST_SIGNALS_H__
6
7#include <signal.h>
8#include <stdbool.h>
9#include <ucontext.h>
10
11/*
12 * Using ARCH specific and sanitized Kernel headers from the tree.
13 */
14#include <asm/ptrace.h>
15#include <asm/hwcap.h>
16
17#define __stringify_1(x...) #x
18#define __stringify(x...) __stringify_1(x)
19
20#define get_regval(regname, out) \
21{ \
22 asm volatile("mrs %0, " __stringify(regname) \
23 : "=r" (out) \
24 : \
25 : "memory"); \
26}
27
28/*
29 * Feature flags used in tdescr.feats_required to specify
30 * any feature by the test
31 */
32enum {
33 FSSBS_BIT,
34 FSVE_BIT,
35 FSME_BIT,
36 FSME_FA64_BIT,
37 FMAX_END
38};
39
40#define FEAT_SSBS (1UL << FSSBS_BIT)
41#define FEAT_SVE (1UL << FSVE_BIT)
42#define FEAT_SME (1UL << FSME_BIT)
43#define FEAT_SME_FA64 (1UL << FSME_FA64_BIT)
44
45/*
46 * A descriptor used to describe and configure a test case.
47 * Fields with a non-trivial meaning are described inline in the following.
48 */
49struct tdescr {
50 /* KEEP THIS FIELD FIRST for easier lookup from assembly */
51 void *token;
52 /* when disabled token based sanity checking is skipped in handler */
53 bool sanity_disabled;
54 /* just a name for the test-case; manadatory field */
55 char *name;
56 char *descr;
57 unsigned long feats_required;
58 unsigned long feats_incompatible;
59 /* bitmask of effectively supported feats: populated at run-time */
60 unsigned long feats_supported;
61 bool initialized;
62 unsigned int minsigstksz;
63 /* signum used as a test trigger. Zero if no trigger-signal is used */
64 int sig_trig;
65 /*
66 * signum considered as a successful test completion.
67 * Zero when no signal is expected on success
68 */
69 int sig_ok;
70 /* signum expected on unsupported CPU features. */
71 int sig_unsupp;
72 /* a timeout in second for test completion */
73 unsigned int timeout;
74 bool triggered;
75 bool pass;
76 unsigned int result;
77 /* optional sa_flags for the installed handler */
78 int sa_flags;
79 ucontext_t saved_uc;
80 /* used by get_current_ctx() */
81 size_t live_sz;
82 ucontext_t *live_uc;
83 volatile sig_atomic_t live_uc_valid;
84 /* optional test private data */
85 void *priv;
86
87 /* a custom setup: called alternatively to default_setup */
88 int (*setup)(struct tdescr *td);
89 /* a custom init: called by default test init after test_setup */
90 bool (*init)(struct tdescr *td);
91 /* a custom cleanup function called before test exits */
92 void (*cleanup)(struct tdescr *td);
93 /* an optional function to be used as a trigger for starting test */
94 int (*trigger)(struct tdescr *td);
95 /*
96 * the actual test-core: invoked differently depending on the
97 * presence of the trigger function above; this is mandatory
98 */
99 int (*run)(struct tdescr *td, siginfo_t *si, ucontext_t *uc);
100 /* an optional function for custom results' processing */
101 void (*check_result)(struct tdescr *td);
102};
103
104extern struct tdescr tde;
105#endif