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