xref: /xnu-12377.61.12/tests/ssbs.c (revision 4d495c6e23c53686cf65f45067f79024cf5dcee8)
1 /*
2  * Copyright (c) 2021 Apple Computer, Inc. All rights reserved.
3  *
4  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5  *
6  * This file contains Original Code and/or Modifications of Original Code
7  * as defined in and that are subject to the Apple Public Source License
8  * Version 2.0 (the 'License'). You may not use this file except in
9  * compliance with the License. The rights granted to you under the License
10  * may not be used to create, or enable the creation or redistribution of,
11  * unlawful or unlicensed copies of an Apple operating system, or to
12  * circumvent, violate, or enable the circumvention or violation of, any
13  * terms of an Apple operating system software license agreement.
14  *
15  * Please obtain a copy of the License at
16  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17  *
18  * The Original Code and all software distributed under the License are
19  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23  * Please see the License for the specific language governing rights and
24  * limitations under the License.
25  *
26  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27  */
28 /**
29  * On devices that support it, this test ensures that PSTATE.SSBS is set by
30  * default and is writeable by userspace.
31  */
32 #include <darwintest.h>
33 #include <stdbool.h>
34 #include <stdint.h>
35 #include <stdio.h>
36 #include <stdlib.h>
37 #include <mach/mach.h>
38 #include <mach/thread_status.h>
39 #include <sys/sysctl.h>
40 #include <inttypes.h>
41 
42 
43 T_GLOBAL_META(
44 	T_META_RADAR_COMPONENT_NAME("xnu"),
45 	T_META_RADAR_COMPONENT_VERSION("arm"),
46 	T_META_OWNER("dmitry_grinberg"),
47 	T_META_RUN_CONCURRENTLY(true));
48 
49 
50 #define PSR64_SSBS              (0x1000)
51 #define REG_SSBS                "S3_3_C4_C2_6" /* clang will not emit MRS/MSR to "SSBS" itself since it doesnt always exist */
52 
53 T_DECL(armv85_ssbs,
54     "Test that ARMv8.5 SSBS is off by default (PSTATE.SSBS==1, don't ask!) and can be enabled by userspace.", T_META_TAG_VM_NOT_ELIGIBLE)
55 {
56 #ifndef __arm64__
57 	T_SKIP("Running on non-arm64 target, skipping...");
58 #else
59 	uint32_t ssbs_support = 19180;
60 	size_t ssbs_support_len = sizeof(ssbs_support);
61 	if (sysctlbyname("hw.optional.arm.FEAT_SSBS", &ssbs_support, &ssbs_support_len, NULL, 0)) {
62 		T_SKIP("Could not get SSBS support sysctl, skipping...");
63 	} else if (!ssbs_support) {
64 		T_SKIP("HW has no SSBS support, skipping...");
65 	} else if (ssbs_support != 1) {
66 		T_FAIL("SSBS support sysctl contains garbage: %u!", ssbs_support);
67 	} else {
68 		uint64_t ssbs_state = __builtin_arm_rsr64(REG_SSBS);
69 
70 		if (!(ssbs_state & PSR64_SSBS)) {
71 			T_FAIL("SSBS does not default to off (value seen: 0x%" PRIx64 ")!", ssbs_state);
72 		}
73 
74 		__builtin_arm_wsr64(REG_SSBS, 0);
75 		ssbs_state = __builtin_arm_rsr64(REG_SSBS);
76 
77 		if (ssbs_state & PSR64_SSBS) {
78 			T_FAIL("SSBS did not turn on (value seen: 0x%" PRIx64 ")!", ssbs_state);
79 		}
80 
81 		__builtin_arm_wsr64(REG_SSBS, PSR64_SSBS);
82 		ssbs_state = __builtin_arm_rsr64(REG_SSBS);
83 
84 		if (!(ssbs_state & PSR64_SSBS)) {
85 			T_FAIL("SSBS did not turn off (value seen: 0x%" PRIx64 ")!", ssbs_state);
86 		}
87 
88 		T_PASS("SSBS test passes");
89 	}
90 #endif /* __arm64__ */
91 }
92