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