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