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