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