xref: /xnu-12377.41.6/tests/x18_entitled.c (revision bbb1b6f9e71b8cdde6e5cd6f4841f207dee3d828) !
1*bbb1b6f9SApple OSS Distributions /*
2*bbb1b6f9SApple OSS Distributions  * Copyright (c) 2019-2022 Apple Inc. All rights reserved.
3*bbb1b6f9SApple OSS Distributions  *
4*bbb1b6f9SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*bbb1b6f9SApple OSS Distributions  *
6*bbb1b6f9SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*bbb1b6f9SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*bbb1b6f9SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*bbb1b6f9SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*bbb1b6f9SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*bbb1b6f9SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*bbb1b6f9SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*bbb1b6f9SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*bbb1b6f9SApple OSS Distributions  *
15*bbb1b6f9SApple OSS Distributions  * Please obtain a copy of the License at
16*bbb1b6f9SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*bbb1b6f9SApple OSS Distributions  *
18*bbb1b6f9SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*bbb1b6f9SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*bbb1b6f9SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*bbb1b6f9SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*bbb1b6f9SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*bbb1b6f9SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*bbb1b6f9SApple OSS Distributions  * limitations under the License.
25*bbb1b6f9SApple OSS Distributions  *
26*bbb1b6f9SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*bbb1b6f9SApple OSS Distributions  */
28*bbb1b6f9SApple OSS Distributions 
29*bbb1b6f9SApple OSS Distributions #include "context_helpers.h"
30*bbb1b6f9SApple OSS Distributions #include <darwintest.h>
31*bbb1b6f9SApple OSS Distributions #include <sys/types.h>
32*bbb1b6f9SApple OSS Distributions #include <sys/sysctl.h>
33*bbb1b6f9SApple OSS Distributions #include <stdbool.h>
34*bbb1b6f9SApple OSS Distributions #include <unistd.h>
35*bbb1b6f9SApple OSS Distributions 
36*bbb1b6f9SApple OSS Distributions T_GLOBAL_META(
37*bbb1b6f9SApple OSS Distributions 	T_META_NAMESPACE("xnu.arm"),
38*bbb1b6f9SApple OSS Distributions 	T_META_RADAR_COMPONENT_NAME("xnu"),
39*bbb1b6f9SApple OSS Distributions 	T_META_RADAR_COMPONENT_VERSION("arm"),
40*bbb1b6f9SApple OSS Distributions 	T_META_OWNER("joster"),
41*bbb1b6f9SApple OSS Distributions 	T_META_REQUIRES_SYSCTL_EQ("hw.optional.arm_kernel_protect", 0), // entitlement will crash on arm_kernel_protect devices
42*bbb1b6f9SApple OSS Distributions 	T_META_RUN_CONCURRENTLY(true),
43*bbb1b6f9SApple OSS Distributions 	T_META_TAG_VM_PREFERRED);
44*bbb1b6f9SApple OSS Distributions 
45*bbb1b6f9SApple OSS Distributions T_DECL(x18_entitled,
46*bbb1b6f9SApple OSS Distributions     "Test that x18 is preserved on hardware that supports it, if entitled.")
47*bbb1b6f9SApple OSS Distributions {
48*bbb1b6f9SApple OSS Distributions #ifndef __arm64__
49*bbb1b6f9SApple OSS Distributions 	T_SKIP("Running on non-arm64 target, skipping...");
50*bbb1b6f9SApple OSS Distributions #else
51*bbb1b6f9SApple OSS Distributions 	bool did_csw = false;
52*bbb1b6f9SApple OSS Distributions 	uint64_t x18_val;
53*bbb1b6f9SApple OSS Distributions 
54*bbb1b6f9SApple OSS Distributions 	for (uint64_t i = 0xFEEDB0B000000000ULL; i < 0xFEEDB0B000000000ULL + 10000; ++i) {
55*bbb1b6f9SApple OSS Distributions 		asm volatile ("mov x18, %0" : : "r"(i));
56*bbb1b6f9SApple OSS Distributions 		int32_t const nr_csw = get_csw_count();
57*bbb1b6f9SApple OSS Distributions 		int const rc = usleep(10);
58*bbb1b6f9SApple OSS Distributions 		int32_t const nr_csw_after = get_csw_count();
59*bbb1b6f9SApple OSS Distributions 
60*bbb1b6f9SApple OSS Distributions 		// There isn't any guarantee usleep() will actually context switch so this is a best effort way
61*bbb1b6f9SApple OSS Distributions 		// to see if we've switched at least once in all these iterations.
62*bbb1b6f9SApple OSS Distributions 		did_csw = did_csw || (nr_csw_after > nr_csw);
63*bbb1b6f9SApple OSS Distributions 		T_QUIET; T_ASSERT_EQ(0, rc, "usleep");
64*bbb1b6f9SApple OSS Distributions 		asm volatile ("mov %0, x18" : "=r"(x18_val));
65*bbb1b6f9SApple OSS Distributions 		T_QUIET; T_ASSERT_EQ(x18_val, i, "check that x18 reads back correctly after yield");
66*bbb1b6f9SApple OSS Distributions 	}
67*bbb1b6f9SApple OSS Distributions 
68*bbb1b6f9SApple OSS Distributions 	T_QUIET; T_ASSERT_TRUE(did_csw, "did not context switch, but should have.");
69*bbb1b6f9SApple OSS Distributions #endif
70*bbb1b6f9SApple OSS Distributions }
71