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