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