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