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