xref: /xnu-8020.121.3/tests/atm_diagnostic_flag_entitled.c (revision fdd8201d7b966f0c3ea610489d29bd841d358941)
1*fdd8201dSApple OSS Distributions #include <darwintest.h>
2*fdd8201dSApple OSS Distributions 
3*fdd8201dSApple OSS Distributions #include <mach/mach_error.h>
4*fdd8201dSApple OSS Distributions #include <mach/mach_host.h>
5*fdd8201dSApple OSS Distributions 
6*fdd8201dSApple OSS Distributions #include "drop_priv.h"
7*fdd8201dSApple OSS Distributions 
8*fdd8201dSApple OSS Distributions T_GLOBAL_META(T_META_NAMESPACE("xnu.debugging"));
9*fdd8201dSApple OSS Distributions 
10*fdd8201dSApple OSS Distributions /*
11*fdd8201dSApple OSS Distributions  * The low 8 bits may be in use, so modify one
12*fdd8201dSApple OSS Distributions  * of the upper 8 bits to ensure round-tripping.
13*fdd8201dSApple OSS Distributions  */
14*fdd8201dSApple OSS Distributions #define LIBTRACE_PRIVATE_DATA  0x01000000
15*fdd8201dSApple OSS Distributions 
16*fdd8201dSApple OSS Distributions static bool _needs_reset;
17*fdd8201dSApple OSS Distributions static uint32_t _original;
18*fdd8201dSApple OSS Distributions 
19*fdd8201dSApple OSS Distributions static uint32_t
_save_atm_diagnostic_flag(void)20*fdd8201dSApple OSS Distributions _save_atm_diagnostic_flag(void)
21*fdd8201dSApple OSS Distributions {
22*fdd8201dSApple OSS Distributions 	kern_return_t kr;
23*fdd8201dSApple OSS Distributions 	kr = host_get_atm_diagnostic_flag(mach_host_self(), &_original);
24*fdd8201dSApple OSS Distributions 	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "host_get_atm_diagnostic_flag()");
25*fdd8201dSApple OSS Distributions 	T_LOG("Original ATM diagnostic flag: 0x%08x", _original);
26*fdd8201dSApple OSS Distributions 	return _original;
27*fdd8201dSApple OSS Distributions }
28*fdd8201dSApple OSS Distributions 
29*fdd8201dSApple OSS Distributions static kern_return_t
_mutate_atm_diagnostic_flag(uint32_t v)30*fdd8201dSApple OSS Distributions _mutate_atm_diagnostic_flag(uint32_t v)
31*fdd8201dSApple OSS Distributions {
32*fdd8201dSApple OSS Distributions 	T_LOG("Try to set ATM diagnostic flag to: 0x%08x", v);
33*fdd8201dSApple OSS Distributions 	kern_return_t kr = host_set_atm_diagnostic_flag(mach_host_self(), v);
34*fdd8201dSApple OSS Distributions 	if (kr == KERN_SUCCESS) {
35*fdd8201dSApple OSS Distributions 		_needs_reset = true;
36*fdd8201dSApple OSS Distributions 	}
37*fdd8201dSApple OSS Distributions 	return kr;
38*fdd8201dSApple OSS Distributions }
39*fdd8201dSApple OSS Distributions 
40*fdd8201dSApple OSS Distributions static void
_reset_atm_diagnostic_flag(void)41*fdd8201dSApple OSS Distributions _reset_atm_diagnostic_flag(void)
42*fdd8201dSApple OSS Distributions {
43*fdd8201dSApple OSS Distributions 	if (!_needs_reset) {
44*fdd8201dSApple OSS Distributions 		return;
45*fdd8201dSApple OSS Distributions 	}
46*fdd8201dSApple OSS Distributions 	T_LOG("Reset ATM diagnostic flag to: 0x%08x", _original);
47*fdd8201dSApple OSS Distributions 	kern_return_t kr;
48*fdd8201dSApple OSS Distributions 	kr = host_set_atm_diagnostic_flag(mach_host_self(), _original);
49*fdd8201dSApple OSS Distributions 	if (kr != KERN_SUCCESS) {
50*fdd8201dSApple OSS Distributions 		T_ASSERT_FAIL("host_set_atm_diagnostic_flag() failed: %s",
51*fdd8201dSApple OSS Distributions 		    mach_error_string(kr));
52*fdd8201dSApple OSS Distributions 	}
53*fdd8201dSApple OSS Distributions }
54*fdd8201dSApple OSS Distributions 
55*fdd8201dSApple OSS Distributions static void
_toggle_atm_diagnostic_flag(void)56*fdd8201dSApple OSS Distributions _toggle_atm_diagnostic_flag(void)
57*fdd8201dSApple OSS Distributions {
58*fdd8201dSApple OSS Distributions 	T_ATEND(_reset_atm_diagnostic_flag);
59*fdd8201dSApple OSS Distributions 	uint32_t f = _save_atm_diagnostic_flag();
60*fdd8201dSApple OSS Distributions 	f ^= LIBTRACE_PRIVATE_DATA;
61*fdd8201dSApple OSS Distributions 	kern_return_t kr = _mutate_atm_diagnostic_flag(f);
62*fdd8201dSApple OSS Distributions 	if (kr == KERN_NOT_SUPPORTED) {
63*fdd8201dSApple OSS Distributions 		T_SKIP("Seems ATM is disabled on this platform. "
64*fdd8201dSApple OSS Distributions 		    "Ignoring host_set_atm_diagnostic_flag functionality. "
65*fdd8201dSApple OSS Distributions 		    "Bailing gracefully.");
66*fdd8201dSApple OSS Distributions 	}
67*fdd8201dSApple OSS Distributions 	T_EXPECT_MACH_SUCCESS(kr, "Set atm_diagnostic_flag");
68*fdd8201dSApple OSS Distributions }
69*fdd8201dSApple OSS Distributions 
70*fdd8201dSApple OSS Distributions T_DECL(atm_diagnostic_flag_entitled_privileged,
71*fdd8201dSApple OSS Distributions     "change the atm_diagnostic_flag (entitled, privileged)",
72*fdd8201dSApple OSS Distributions     T_META_ASROOT(true))
73*fdd8201dSApple OSS Distributions {
74*fdd8201dSApple OSS Distributions 	_toggle_atm_diagnostic_flag();
75*fdd8201dSApple OSS Distributions }
76*fdd8201dSApple OSS Distributions 
77*fdd8201dSApple OSS Distributions T_DECL(atm_diagnostic_flag_entitled_unprivileged,
78*fdd8201dSApple OSS Distributions     "change the atm_diagnostic_flag (entitled, unprivileged)",
79*fdd8201dSApple OSS Distributions     T_META_ASROOT(false))
80*fdd8201dSApple OSS Distributions {
81*fdd8201dSApple OSS Distributions 	drop_priv();
82*fdd8201dSApple OSS Distributions 	_toggle_atm_diagnostic_flag();
83*fdd8201dSApple OSS Distributions }
84