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