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