xref: /xnu-10063.141.1/tests/ktrace/ktrace_helpers.h (revision d8b80295118ef25ac3a784134bcf95cd8e88109f)
1*d8b80295SApple OSS Distributions #ifndef KTRACE_HELPERS_H
2*d8b80295SApple OSS Distributions #define KTRACE_HELPERS_H
3*d8b80295SApple OSS Distributions 
4*d8b80295SApple OSS Distributions #include <darwintest.h>
5*d8b80295SApple OSS Distributions #include <ktrace/ktrace.h>
6*d8b80295SApple OSS Distributions #include <libproc.h>
7*d8b80295SApple OSS Distributions #include <sys/sysctl.h>
8*d8b80295SApple OSS Distributions #include <sys/kdebug.h>
9*d8b80295SApple OSS Distributions 
10*d8b80295SApple OSS Distributions static inline void
reset_ktrace(void)11*d8b80295SApple OSS Distributions reset_ktrace(void)
12*d8b80295SApple OSS Distributions {
13*d8b80295SApple OSS Distributions 	(void)sysctl((int[]){ CTL_KERN, KERN_KDEBUG, KERN_KDREMOVE }, 3,
14*d8b80295SApple OSS Distributions 	    NULL, 0, NULL, 0);
15*d8b80295SApple OSS Distributions 	kperf_reset();
16*d8b80295SApple OSS Distributions }
17*d8b80295SApple OSS Distributions 
18*d8b80295SApple OSS Distributions static inline void
start_controlling_ktrace(void)19*d8b80295SApple OSS Distributions start_controlling_ktrace(void)
20*d8b80295SApple OSS Distributions {
21*d8b80295SApple OSS Distributions 	T_SETUPBEGIN;
22*d8b80295SApple OSS Distributions 
23*d8b80295SApple OSS Distributions 	int state = 0;
24*d8b80295SApple OSS Distributions 	size_t statesz = sizeof(state);
25*d8b80295SApple OSS Distributions 	int ret = sysctlbyname("ktrace.state", &state, &statesz, NULL, 0);
26*d8b80295SApple OSS Distributions 	T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "getting ktrace state");
27*d8b80295SApple OSS Distributions 
28*d8b80295SApple OSS Distributions 	if (state == 1) {
29*d8b80295SApple OSS Distributions 		int ownerpid = 0;
30*d8b80295SApple OSS Distributions 		size_t pidsz = sizeof(ownerpid);
31*d8b80295SApple OSS Distributions 		ret = sysctlbyname("ktrace.owning_pid", &ownerpid, &pidsz, NULL, 0);
32*d8b80295SApple OSS Distributions 		T_QUIET; T_ASSERT_POSIX_SUCCESS(ret, "getting owning pid");
33*d8b80295SApple OSS Distributions 
34*d8b80295SApple OSS Distributions 		if (ownerpid <= 0) {
35*d8b80295SApple OSS Distributions 			T_LOG("ktrace is in foreground, but no owner");
36*d8b80295SApple OSS Distributions 			goto out;
37*d8b80295SApple OSS Distributions 		}
38*d8b80295SApple OSS Distributions 
39*d8b80295SApple OSS Distributions 		char ownername[1024];
40*d8b80295SApple OSS Distributions 		ret = proc_name(ownerpid, ownername, sizeof(ownername));
41*d8b80295SApple OSS Distributions 		if (ret == 0) {
42*d8b80295SApple OSS Distributions 			T_LOG("ktrace is in foreground, but owner (%d) has no name", ownerpid);
43*d8b80295SApple OSS Distributions 			goto out;
44*d8b80295SApple OSS Distributions 		}
45*d8b80295SApple OSS Distributions 
46*d8b80295SApple OSS Distributions 		T_LOG("ktrace is in foreground, owned by %s, sending SIGKILL", ownername);
47*d8b80295SApple OSS Distributions 		kill(ownerpid, SIGKILL);
48*d8b80295SApple OSS Distributions 		usleep(500000);
49*d8b80295SApple OSS Distributions 
50*d8b80295SApple OSS Distributions 		ret = proc_name(ownerpid, ownername, sizeof(ownername));
51*d8b80295SApple OSS Distributions 		T_QUIET; T_ASSERT_EQ(ret, 0, "should have killed ktrace owner");
52*d8b80295SApple OSS Distributions 	}
53*d8b80295SApple OSS Distributions 
54*d8b80295SApple OSS Distributions out:
55*d8b80295SApple OSS Distributions 	reset_ktrace();
56*d8b80295SApple OSS Distributions 	T_ATEND(reset_ktrace);
57*d8b80295SApple OSS Distributions 	T_SETUPEND;
58*d8b80295SApple OSS Distributions }
59*d8b80295SApple OSS Distributions 
60*d8b80295SApple OSS Distributions static inline void
assert_kdebug_test(kdebug_test_t flavor,const char * msg)61*d8b80295SApple OSS Distributions assert_kdebug_test(kdebug_test_t flavor, const char *msg)
62*d8b80295SApple OSS Distributions {
63*d8b80295SApple OSS Distributions 	size_t size = flavor;
64*d8b80295SApple OSS Distributions 	int mib[] = { CTL_KERN, KERN_KDEBUG, KERN_KDTEST };
65*d8b80295SApple OSS Distributions 	T_ASSERT_POSIX_SUCCESS(sysctl(mib, sizeof(mib) / sizeof(mib[0]), NULL,
66*d8b80295SApple OSS Distributions 	    &size, NULL, 0), "KERN_KDTEST %d: %s", flavor, msg);
67*d8b80295SApple OSS Distributions }
68*d8b80295SApple OSS Distributions 
69*d8b80295SApple OSS Distributions static inline uint64_t
ns_from_abs(ktrace_session_t s,uint64_t abstime)70*d8b80295SApple OSS Distributions ns_from_abs(ktrace_session_t s, uint64_t abstime)
71*d8b80295SApple OSS Distributions {
72*d8b80295SApple OSS Distributions 	uint64_t ns = 0;
73*d8b80295SApple OSS Distributions 	int error = ktrace_convert_timestamp_to_nanoseconds(s, abstime, &ns);
74*d8b80295SApple OSS Distributions 	T_QUIET; T_ASSERT_POSIX_ZERO(error, "convert abstime to nanoseconds");
75*d8b80295SApple OSS Distributions 	return ns;
76*d8b80295SApple OSS Distributions }
77*d8b80295SApple OSS Distributions 
78*d8b80295SApple OSS Distributions static inline uint64_t
relns_from_abs(ktrace_session_t s,uint64_t abstime)79*d8b80295SApple OSS Distributions relns_from_abs(ktrace_session_t s, uint64_t abstime)
80*d8b80295SApple OSS Distributions {
81*d8b80295SApple OSS Distributions 	return ns_from_abs(s, abstime - ktrace_get_earliest_timestamp(s));
82*d8b80295SApple OSS Distributions }
83*d8b80295SApple OSS Distributions 
84*d8b80295SApple OSS Distributions #endif /* !defined(KTRACE_HELPERS_H) */
85