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