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