xref: /xnu-8019.80.24/tests/stackshot_tests.m (revision a325d9c4a84054e40bbe985afedcb50ab80993ea)
1*a325d9c4SApple OSS Distributions#include <darwintest.h>
2*a325d9c4SApple OSS Distributions#include <darwintest_utils.h>
3*a325d9c4SApple OSS Distributions#include <darwintest_multiprocess.h>
4*a325d9c4SApple OSS Distributions#include <kern/debug.h>
5*a325d9c4SApple OSS Distributions#include <kern/kern_cdata.h>
6*a325d9c4SApple OSS Distributions#include <kern/block_hint.h>
7*a325d9c4SApple OSS Distributions#include <kdd.h>
8*a325d9c4SApple OSS Distributions#include <libproc.h>
9*a325d9c4SApple OSS Distributions#include <mach-o/dyld.h>
10*a325d9c4SApple OSS Distributions#include <mach-o/dyld_images.h>
11*a325d9c4SApple OSS Distributions#include <mach-o/dyld_priv.h>
12*a325d9c4SApple OSS Distributions#include <sys/syscall.h>
13*a325d9c4SApple OSS Distributions#include <sys/stackshot.h>
14*a325d9c4SApple OSS Distributions#include <uuid/uuid.h>
15*a325d9c4SApple OSS Distributions#include <servers/bootstrap.h>
16*a325d9c4SApple OSS Distributions#include <pthread/workqueue_private.h>
17*a325d9c4SApple OSS Distributions#include <dispatch/private.h>
18*a325d9c4SApple OSS Distributions#include <stdalign.h>
19*a325d9c4SApple OSS Distributions#import <zlib.h>
20*a325d9c4SApple OSS Distributions
21*a325d9c4SApple OSS DistributionsT_GLOBAL_META(
22*a325d9c4SApple OSS Distributions		T_META_NAMESPACE("xnu.stackshot"),
23*a325d9c4SApple OSS Distributions		T_META_RADAR_COMPONENT_NAME("xnu"),
24*a325d9c4SApple OSS Distributions		T_META_RADAR_COMPONENT_VERSION("stackshot"),
25*a325d9c4SApple OSS Distributions		T_META_OWNER("jonathan_w_adams"),
26*a325d9c4SApple OSS Distributions		T_META_CHECK_LEAKS(false),
27*a325d9c4SApple OSS Distributions		T_META_ASROOT(true)
28*a325d9c4SApple OSS Distributions		);
29*a325d9c4SApple OSS Distributions
30*a325d9c4SApple OSS Distributionsstatic const char *current_process_name(void);
31*a325d9c4SApple OSS Distributionsstatic void verify_stackshot_sharedcache_layout(struct dyld_uuid_info_64 *uuids, uint32_t uuid_count);
32*a325d9c4SApple OSS Distributionsstatic void parse_stackshot(uint64_t stackshot_parsing_flags, void *ssbuf, size_t sslen, NSDictionary *extra);
33*a325d9c4SApple OSS Distributionsstatic void parse_thread_group_stackshot(void **sbuf, size_t sslen);
34*a325d9c4SApple OSS Distributionsstatic uint64_t stackshot_timestamp(void *ssbuf, size_t sslen);
35*a325d9c4SApple OSS Distributionsstatic void initialize_thread(void);
36*a325d9c4SApple OSS Distributions
37*a325d9c4SApple OSS Distributionsstatic uint64_t global_flags = 0;
38*a325d9c4SApple OSS Distributions
39*a325d9c4SApple OSS Distributions#define DEFAULT_STACKSHOT_BUFFER_SIZE (1024 * 1024)
40*a325d9c4SApple OSS Distributions#define MAX_STACKSHOT_BUFFER_SIZE     (6 * 1024 * 1024)
41*a325d9c4SApple OSS Distributions
42*a325d9c4SApple OSS Distributions#define SRP_SERVICE_NAME "com.apple.xnu.test.stackshot.special_reply_port"
43*a325d9c4SApple OSS Distributions
44*a325d9c4SApple OSS Distributions/* bit flags for parse_stackshot */
45*a325d9c4SApple OSS Distributions#define PARSE_STACKSHOT_DELTA                0x01
46*a325d9c4SApple OSS Distributions#define PARSE_STACKSHOT_ZOMBIE               0x02
47*a325d9c4SApple OSS Distributions#define PARSE_STACKSHOT_SHAREDCACHE_LAYOUT   0x04
48*a325d9c4SApple OSS Distributions#define PARSE_STACKSHOT_DISPATCH_QUEUE_LABEL 0x08
49*a325d9c4SApple OSS Distributions#define PARSE_STACKSHOT_TURNSTILEINFO        0x10
50*a325d9c4SApple OSS Distributions#define PARSE_STACKSHOT_POSTEXEC             0x20
51*a325d9c4SApple OSS Distributions#define PARSE_STACKSHOT_WAITINFO_CSEG        0x40
52*a325d9c4SApple OSS Distributions#define PARSE_STACKSHOT_WAITINFO_SRP         0x80
53*a325d9c4SApple OSS Distributions#define PARSE_STACKSHOT_TRANSLATED           0x100
54*a325d9c4SApple OSS Distributions#define PARSE_STACKSHOT_SHAREDCACHE_FLAGS    0x200
55*a325d9c4SApple OSS Distributions#define PARSE_STACKSHOT_EXEC_INPROGRESS      0x400
56*a325d9c4SApple OSS Distributions#define PARSE_STACKSHOT_TRANSITIONING        0x800
57*a325d9c4SApple OSS Distributions#define PARSE_STACKSHOT_ASYNCSTACK           0x1000
58*a325d9c4SApple OSS Distributions
59*a325d9c4SApple OSS Distributions/* keys for 'extra' dictionary for parse_stackshot */
60*a325d9c4SApple OSS Distributionsstatic const NSString* zombie_child_pid_key = @"zombie_child_pid"; // -> @(pid), required for PARSE_STACKSHOT_ZOMBIE
61*a325d9c4SApple OSS Distributionsstatic const NSString* postexec_child_unique_pid_key = @"postexec_child_unique_pid";  // -> @(unique_pid), required for PARSE_STACKSHOT_POSTEXEC
62*a325d9c4SApple OSS Distributionsstatic const NSString* cseg_expected_threadid_key = @"cseg_expected_threadid"; // -> @(tid), required for PARSE_STACKSHOT_WAITINFO_CSEG
63*a325d9c4SApple OSS Distributionsstatic const NSString* srp_expected_threadid_key = @"srp_expected_threadid"; // -> @(tid), this or ..._pid required for PARSE_STACKSHOT_WAITINFO_SRP
64*a325d9c4SApple OSS Distributionsstatic const NSString* srp_expected_pid_key = @"srp_expected_pid"; // -> @(pid), this or ..._threadid required for PARSE_STACKSHOT_WAITINFO_SRP
65*a325d9c4SApple OSS Distributionsstatic const NSString* translated_child_pid_key = @"translated_child_pid"; // -> @(pid), required for PARSE_STACKSHOT_TRANSLATED
66*a325d9c4SApple OSS Distributionsstatic const NSString* sharedcache_child_pid_key = @"sharedcache_child_pid"; // @(pid), required for PARSE_STACKSHOT_SHAREDCACHE_FLAGS
67*a325d9c4SApple OSS Distributionsstatic const NSString* sharedcache_child_sameaddr_key = @"sharedcache_child_sameaddr"; // @(0 or 1), required for PARSE_STACKSHOT_SHAREDCACHE_FLAGS
68*a325d9c4SApple OSS Distributionsstatic const NSString* exec_inprogress_pid_key = @"exec_inprogress_pid";
69*a325d9c4SApple OSS Distributionsstatic const NSString* exec_inprogress_found_key = @"exec_inprogress_found";  // callback when inprogress is found
70*a325d9c4SApple OSS Distributionsstatic const NSString* transitioning_pid_key = @"transitioning_task_pid"; // -> @(pid), required for PARSE_STACKSHOT_TRANSITIONING
71*a325d9c4SApple OSS Distributionsstatic const NSString* asyncstack_expected_threadid_key = @"asyncstack_expected_threadid"; // -> @(tid), required for PARSE_STACKSHOT_ASYNCSTACK
72*a325d9c4SApple OSS Distributionsstatic const NSString* asyncstack_expected_stack_key = @"asyncstack_expected_stack"; // -> @[pc...]), expected PCs for asyncstack
73*a325d9c4SApple OSS Distributions
74*a325d9c4SApple OSS Distributions#define TEST_STACKSHOT_QUEUE_LABEL        "houston.we.had.a.problem"
75*a325d9c4SApple OSS Distributions#define TEST_STACKSHOT_QUEUE_LABEL_LENGTH sizeof(TEST_STACKSHOT_QUEUE_LABEL)
76*a325d9c4SApple OSS Distributions
77*a325d9c4SApple OSS DistributionsT_DECL(microstackshots, "test the microstackshot syscall")
78*a325d9c4SApple OSS Distributions{
79*a325d9c4SApple OSS Distributions	void *buf = NULL;
80*a325d9c4SApple OSS Distributions	unsigned int size = DEFAULT_STACKSHOT_BUFFER_SIZE;
81*a325d9c4SApple OSS Distributions
82*a325d9c4SApple OSS Distributions	while (1) {
83*a325d9c4SApple OSS Distributions		buf = malloc(size);
84*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_NOTNULL(buf, "allocated stackshot buffer");
85*a325d9c4SApple OSS Distributions
86*a325d9c4SApple OSS Distributions#pragma clang diagnostic push
87*a325d9c4SApple OSS Distributions#pragma clang diagnostic ignored "-Wdeprecated-declarations"
88*a325d9c4SApple OSS Distributions		int len = syscall(SYS_microstackshot, buf, size,
89*a325d9c4SApple OSS Distributions				(uint32_t) STACKSHOT_GET_MICROSTACKSHOT);
90*a325d9c4SApple OSS Distributions#pragma clang diagnostic pop
91*a325d9c4SApple OSS Distributions		if (len == ENOSYS) {
92*a325d9c4SApple OSS Distributions			T_SKIP("microstackshot syscall failed, likely not compiled with CONFIG_TELEMETRY");
93*a325d9c4SApple OSS Distributions		}
94*a325d9c4SApple OSS Distributions		if (len == -1 && errno == ENOSPC) {
95*a325d9c4SApple OSS Distributions			/* syscall failed because buffer wasn't large enough, try again */
96*a325d9c4SApple OSS Distributions			free(buf);
97*a325d9c4SApple OSS Distributions			buf = NULL;
98*a325d9c4SApple OSS Distributions			size *= 2;
99*a325d9c4SApple OSS Distributions			T_ASSERT_LE(size, (unsigned int)MAX_STACKSHOT_BUFFER_SIZE,
100*a325d9c4SApple OSS Distributions					"growing stackshot buffer to sane size");
101*a325d9c4SApple OSS Distributions			continue;
102*a325d9c4SApple OSS Distributions		}
103*a325d9c4SApple OSS Distributions		T_ASSERT_POSIX_SUCCESS(len, "called microstackshot syscall");
104*a325d9c4SApple OSS Distributions		break;
105*a325d9c4SApple OSS Distributions    }
106*a325d9c4SApple OSS Distributions
107*a325d9c4SApple OSS Distributions	T_EXPECT_EQ(*(uint32_t *)buf,
108*a325d9c4SApple OSS Distributions			(uint32_t)STACKSHOT_MICRO_SNAPSHOT_MAGIC,
109*a325d9c4SApple OSS Distributions			"magic value for microstackshot matches");
110*a325d9c4SApple OSS Distributions
111*a325d9c4SApple OSS Distributions	free(buf);
112*a325d9c4SApple OSS Distributions}
113*a325d9c4SApple OSS Distributions
114*a325d9c4SApple OSS Distributionsstruct scenario {
115*a325d9c4SApple OSS Distributions	const char *name;
116*a325d9c4SApple OSS Distributions	uint64_t flags;
117*a325d9c4SApple OSS Distributions	bool quiet;
118*a325d9c4SApple OSS Distributions	bool should_fail;
119*a325d9c4SApple OSS Distributions	bool maybe_unsupported;
120*a325d9c4SApple OSS Distributions	pid_t target_pid;
121*a325d9c4SApple OSS Distributions	uint64_t since_timestamp;
122*a325d9c4SApple OSS Distributions	uint32_t size_hint;
123*a325d9c4SApple OSS Distributions	dt_stat_time_t timer;
124*a325d9c4SApple OSS Distributions};
125*a325d9c4SApple OSS Distributions
126*a325d9c4SApple OSS Distributionsstatic void
127*a325d9c4SApple OSS Distributionsquiet(struct scenario *scenario)
128*a325d9c4SApple OSS Distributions{
129*a325d9c4SApple OSS Distributions	if (scenario->timer || scenario->quiet) {
130*a325d9c4SApple OSS Distributions		T_QUIET;
131*a325d9c4SApple OSS Distributions	}
132*a325d9c4SApple OSS Distributions}
133*a325d9c4SApple OSS Distributions
134*a325d9c4SApple OSS Distributionsstatic void
135*a325d9c4SApple OSS Distributionstake_stackshot(struct scenario *scenario, bool compress_ok, void (^cb)(void *buf, size_t size))
136*a325d9c4SApple OSS Distributions{
137*a325d9c4SApple OSS Distributionsstart:
138*a325d9c4SApple OSS Distributions	initialize_thread();
139*a325d9c4SApple OSS Distributions
140*a325d9c4SApple OSS Distributions	void *config = stackshot_config_create();
141*a325d9c4SApple OSS Distributions	quiet(scenario);
142*a325d9c4SApple OSS Distributions	T_ASSERT_NOTNULL(config, "created stackshot config");
143*a325d9c4SApple OSS Distributions
144*a325d9c4SApple OSS Distributions	int ret = stackshot_config_set_flags(config, scenario->flags | global_flags);
145*a325d9c4SApple OSS Distributions	quiet(scenario);
146*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_ZERO(ret, "set flags %#llx on stackshot config", scenario->flags);
147*a325d9c4SApple OSS Distributions
148*a325d9c4SApple OSS Distributions	if (scenario->size_hint > 0) {
149*a325d9c4SApple OSS Distributions		ret = stackshot_config_set_size_hint(config, scenario->size_hint);
150*a325d9c4SApple OSS Distributions		quiet(scenario);
151*a325d9c4SApple OSS Distributions		T_ASSERT_POSIX_ZERO(ret, "set size hint %" PRIu32 " on stackshot config",
152*a325d9c4SApple OSS Distributions				scenario->size_hint);
153*a325d9c4SApple OSS Distributions	}
154*a325d9c4SApple OSS Distributions
155*a325d9c4SApple OSS Distributions	if (scenario->target_pid > 0) {
156*a325d9c4SApple OSS Distributions		ret = stackshot_config_set_pid(config, scenario->target_pid);
157*a325d9c4SApple OSS Distributions		quiet(scenario);
158*a325d9c4SApple OSS Distributions		T_ASSERT_POSIX_ZERO(ret, "set target pid %d on stackshot config",
159*a325d9c4SApple OSS Distributions				scenario->target_pid);
160*a325d9c4SApple OSS Distributions	}
161*a325d9c4SApple OSS Distributions
162*a325d9c4SApple OSS Distributions	if (scenario->since_timestamp > 0) {
163*a325d9c4SApple OSS Distributions		ret = stackshot_config_set_delta_timestamp(config, scenario->since_timestamp);
164*a325d9c4SApple OSS Distributions		quiet(scenario);
165*a325d9c4SApple OSS Distributions		T_ASSERT_POSIX_ZERO(ret, "set since timestamp %" PRIu64 " on stackshot config",
166*a325d9c4SApple OSS Distributions				scenario->since_timestamp);
167*a325d9c4SApple OSS Distributions	}
168*a325d9c4SApple OSS Distributions
169*a325d9c4SApple OSS Distributions	int retries_remaining = 5;
170*a325d9c4SApple OSS Distributions
171*a325d9c4SApple OSS Distributionsretry: ;
172*a325d9c4SApple OSS Distributions	uint64_t start_time = mach_absolute_time();
173*a325d9c4SApple OSS Distributions	ret = stackshot_capture_with_config(config);
174*a325d9c4SApple OSS Distributions	uint64_t end_time = mach_absolute_time();
175*a325d9c4SApple OSS Distributions
176*a325d9c4SApple OSS Distributions	if (scenario->should_fail) {
177*a325d9c4SApple OSS Distributions		T_EXPECTFAIL;
178*a325d9c4SApple OSS Distributions		T_ASSERT_POSIX_ZERO(ret, "called stackshot_capture_with_config");
179*a325d9c4SApple OSS Distributions		return;
180*a325d9c4SApple OSS Distributions	}
181*a325d9c4SApple OSS Distributions
182*a325d9c4SApple OSS Distributions	if (ret == EBUSY || ret == ETIMEDOUT) {
183*a325d9c4SApple OSS Distributions		if (retries_remaining > 0) {
184*a325d9c4SApple OSS Distributions			if (!scenario->timer) {
185*a325d9c4SApple OSS Distributions				T_LOG("stackshot_capture_with_config failed with %s (%d), retrying",
186*a325d9c4SApple OSS Distributions						strerror(ret), ret);
187*a325d9c4SApple OSS Distributions			}
188*a325d9c4SApple OSS Distributions
189*a325d9c4SApple OSS Distributions			retries_remaining--;
190*a325d9c4SApple OSS Distributions			goto retry;
191*a325d9c4SApple OSS Distributions		} else {
192*a325d9c4SApple OSS Distributions			T_ASSERT_POSIX_ZERO(ret,
193*a325d9c4SApple OSS Distributions					"called stackshot_capture_with_config (no retries remaining)");
194*a325d9c4SApple OSS Distributions		}
195*a325d9c4SApple OSS Distributions	} else if ((ret == ENOTSUP) && scenario->maybe_unsupported) {
196*a325d9c4SApple OSS Distributions		T_SKIP("kernel indicated this stackshot configuration is not supported");
197*a325d9c4SApple OSS Distributions	} else {
198*a325d9c4SApple OSS Distributions		quiet(scenario);
199*a325d9c4SApple OSS Distributions		T_ASSERT_POSIX_ZERO(ret, "called stackshot_capture_with_config");
200*a325d9c4SApple OSS Distributions	}
201*a325d9c4SApple OSS Distributions
202*a325d9c4SApple OSS Distributions	if (scenario->timer) {
203*a325d9c4SApple OSS Distributions		dt_stat_mach_time_add(scenario->timer, end_time - start_time);
204*a325d9c4SApple OSS Distributions	}
205*a325d9c4SApple OSS Distributions	void *buf = stackshot_config_get_stackshot_buffer(config);
206*a325d9c4SApple OSS Distributions	size_t size = stackshot_config_get_stackshot_size(config);
207*a325d9c4SApple OSS Distributions	if (scenario->name) {
208*a325d9c4SApple OSS Distributions		char sspath[MAXPATHLEN];
209*a325d9c4SApple OSS Distributions		strlcpy(sspath, scenario->name, sizeof(sspath));
210*a325d9c4SApple OSS Distributions		strlcat(sspath, ".kcdata", sizeof(sspath));
211*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_POSIX_ZERO(dt_resultfile(sspath, sizeof(sspath)),
212*a325d9c4SApple OSS Distributions				"create result file path");
213*a325d9c4SApple OSS Distributions
214*a325d9c4SApple OSS Distributions		if (!scenario->quiet) {
215*a325d9c4SApple OSS Distributions			T_LOG("writing stackshot to %s", sspath);
216*a325d9c4SApple OSS Distributions		}
217*a325d9c4SApple OSS Distributions
218*a325d9c4SApple OSS Distributions		FILE *f = fopen(sspath, "w");
219*a325d9c4SApple OSS Distributions		T_WITH_ERRNO; T_QUIET; T_ASSERT_NOTNULL(f,
220*a325d9c4SApple OSS Distributions				"open stackshot output file");
221*a325d9c4SApple OSS Distributions
222*a325d9c4SApple OSS Distributions		size_t written = fwrite(buf, size, 1, f);
223*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_POSIX_SUCCESS(written, "wrote stackshot to file");
224*a325d9c4SApple OSS Distributions
225*a325d9c4SApple OSS Distributions		fclose(f);
226*a325d9c4SApple OSS Distributions	}
227*a325d9c4SApple OSS Distributions	cb(buf, size);
228*a325d9c4SApple OSS Distributions	if (compress_ok) {
229*a325d9c4SApple OSS Distributions		if (global_flags == 0) {
230*a325d9c4SApple OSS Distributions			T_LOG("Restarting test with compression");
231*a325d9c4SApple OSS Distributions			global_flags |= STACKSHOT_DO_COMPRESS;
232*a325d9c4SApple OSS Distributions			goto start;
233*a325d9c4SApple OSS Distributions		} else {
234*a325d9c4SApple OSS Distributions			global_flags = 0;
235*a325d9c4SApple OSS Distributions		}
236*a325d9c4SApple OSS Distributions	}
237*a325d9c4SApple OSS Distributions
238*a325d9c4SApple OSS Distributions	ret = stackshot_config_dealloc(config);
239*a325d9c4SApple OSS Distributions	T_QUIET; T_EXPECT_POSIX_ZERO(ret, "deallocated stackshot config");
240*a325d9c4SApple OSS Distributions}
241*a325d9c4SApple OSS Distributions
242*a325d9c4SApple OSS DistributionsT_DECL(simple_compressed, "take a simple compressed stackshot")
243*a325d9c4SApple OSS Distributions{
244*a325d9c4SApple OSS Distributions	struct scenario scenario = {
245*a325d9c4SApple OSS Distributions		.name = "kcdata_compressed",
246*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_DO_COMPRESS | STACKSHOT_SAVE_LOADINFO | STACKSHOT_THREAD_WAITINFO | STACKSHOT_GET_GLOBAL_MEM_STATS |
247*a325d9c4SApple OSS Distributions				STACKSHOT_SAVE_IMP_DONATION_PIDS | STACKSHOT_KCDATA_FORMAT),
248*a325d9c4SApple OSS Distributions	};
249*a325d9c4SApple OSS Distributions
250*a325d9c4SApple OSS Distributions	T_LOG("taking compressed kcdata stackshot");
251*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, true, ^(void *ssbuf, size_t sslen) {
252*a325d9c4SApple OSS Distributions		parse_stackshot(0, ssbuf, sslen, nil);
253*a325d9c4SApple OSS Distributions	});
254*a325d9c4SApple OSS Distributions}
255*a325d9c4SApple OSS Distributions
256*a325d9c4SApple OSS DistributionsT_DECL(panic_compressed, "take a compressed stackshot with the same flags as a panic stackshot")
257*a325d9c4SApple OSS Distributions{
258*a325d9c4SApple OSS Distributions	uint64_t stackshot_flags = (STACKSHOT_SAVE_KEXT_LOADINFO |
259*a325d9c4SApple OSS Distributions			STACKSHOT_SAVE_LOADINFO |
260*a325d9c4SApple OSS Distributions			STACKSHOT_KCDATA_FORMAT |
261*a325d9c4SApple OSS Distributions			STACKSHOT_ENABLE_BT_FAULTING |
262*a325d9c4SApple OSS Distributions			STACKSHOT_ENABLE_UUID_FAULTING |
263*a325d9c4SApple OSS Distributions			STACKSHOT_DO_COMPRESS |
264*a325d9c4SApple OSS Distributions			STACKSHOT_NO_IO_STATS |
265*a325d9c4SApple OSS Distributions			STACKSHOT_THREAD_WAITINFO |
266*a325d9c4SApple OSS Distributions#if TARGET_OS_MAC
267*a325d9c4SApple OSS Distributions			STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT |
268*a325d9c4SApple OSS Distributions#endif
269*a325d9c4SApple OSS Distributions			STACKSHOT_DISABLE_LATENCY_INFO);
270*a325d9c4SApple OSS Distributions
271*a325d9c4SApple OSS Distributions	struct scenario scenario = {
272*a325d9c4SApple OSS Distributions		.name = "kcdata_panic_compressed",
273*a325d9c4SApple OSS Distributions		.flags = stackshot_flags,
274*a325d9c4SApple OSS Distributions	};
275*a325d9c4SApple OSS Distributions
276*a325d9c4SApple OSS Distributions	T_LOG("taking compressed kcdata stackshot with panic flags");
277*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, true, ^(void *ssbuf, size_t sslen) {
278*a325d9c4SApple OSS Distributions		parse_stackshot(0, ssbuf, sslen, nil);
279*a325d9c4SApple OSS Distributions	});
280*a325d9c4SApple OSS Distributions}
281*a325d9c4SApple OSS Distributions
282*a325d9c4SApple OSS DistributionsT_DECL(kcdata, "test that kcdata stackshots can be taken and parsed")
283*a325d9c4SApple OSS Distributions{
284*a325d9c4SApple OSS Distributions	struct scenario scenario = {
285*a325d9c4SApple OSS Distributions		.name = "kcdata",
286*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_GET_GLOBAL_MEM_STATS |
287*a325d9c4SApple OSS Distributions				STACKSHOT_SAVE_IMP_DONATION_PIDS | STACKSHOT_KCDATA_FORMAT),
288*a325d9c4SApple OSS Distributions	};
289*a325d9c4SApple OSS Distributions
290*a325d9c4SApple OSS Distributions	T_LOG("taking kcdata stackshot");
291*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, true, ^(void *ssbuf, size_t sslen) {
292*a325d9c4SApple OSS Distributions		parse_stackshot(0, ssbuf, sslen, nil);
293*a325d9c4SApple OSS Distributions	});
294*a325d9c4SApple OSS Distributions}
295*a325d9c4SApple OSS Distributions
296*a325d9c4SApple OSS DistributionsT_DECL(kcdata_faulting, "test that kcdata stackshots while faulting can be taken and parsed")
297*a325d9c4SApple OSS Distributions{
298*a325d9c4SApple OSS Distributions	struct scenario scenario = {
299*a325d9c4SApple OSS Distributions		.name = "faulting",
300*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_GET_GLOBAL_MEM_STATS
301*a325d9c4SApple OSS Distributions				| STACKSHOT_SAVE_IMP_DONATION_PIDS | STACKSHOT_KCDATA_FORMAT
302*a325d9c4SApple OSS Distributions				| STACKSHOT_ENABLE_BT_FAULTING | STACKSHOT_ENABLE_UUID_FAULTING),
303*a325d9c4SApple OSS Distributions	};
304*a325d9c4SApple OSS Distributions
305*a325d9c4SApple OSS Distributions	T_LOG("taking faulting stackshot");
306*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, true, ^(void *ssbuf, size_t sslen) {
307*a325d9c4SApple OSS Distributions		parse_stackshot(0, ssbuf, sslen, nil);
308*a325d9c4SApple OSS Distributions	});
309*a325d9c4SApple OSS Distributions}
310*a325d9c4SApple OSS Distributions
311*a325d9c4SApple OSS DistributionsT_DECL(bad_flags, "test a poorly-formed stackshot syscall")
312*a325d9c4SApple OSS Distributions{
313*a325d9c4SApple OSS Distributions	struct scenario scenario = {
314*a325d9c4SApple OSS Distributions		.flags = STACKSHOT_SAVE_IN_KERNEL_BUFFER /* not allowed from user space */,
315*a325d9c4SApple OSS Distributions		.should_fail = true,
316*a325d9c4SApple OSS Distributions	};
317*a325d9c4SApple OSS Distributions
318*a325d9c4SApple OSS Distributions	T_LOG("attempting to take stackshot with kernel-only flag");
319*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, true, ^(__unused void *ssbuf, __unused size_t sslen) {
320*a325d9c4SApple OSS Distributions		T_ASSERT_FAIL("stackshot data callback called");
321*a325d9c4SApple OSS Distributions	});
322*a325d9c4SApple OSS Distributions}
323*a325d9c4SApple OSS Distributions
324*a325d9c4SApple OSS DistributionsT_DECL(delta, "test delta stackshots")
325*a325d9c4SApple OSS Distributions{
326*a325d9c4SApple OSS Distributions	struct scenario scenario = {
327*a325d9c4SApple OSS Distributions		.name = "delta",
328*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_GET_GLOBAL_MEM_STATS
329*a325d9c4SApple OSS Distributions				| STACKSHOT_SAVE_IMP_DONATION_PIDS | STACKSHOT_KCDATA_FORMAT),
330*a325d9c4SApple OSS Distributions	};
331*a325d9c4SApple OSS Distributions
332*a325d9c4SApple OSS Distributions	T_LOG("taking full stackshot");
333*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, false, ^(void *ssbuf, size_t sslen) {
334*a325d9c4SApple OSS Distributions		uint64_t stackshot_time = stackshot_timestamp(ssbuf, sslen);
335*a325d9c4SApple OSS Distributions
336*a325d9c4SApple OSS Distributions		T_LOG("taking delta stackshot since time %" PRIu64, stackshot_time);
337*a325d9c4SApple OSS Distributions
338*a325d9c4SApple OSS Distributions		parse_stackshot(0, ssbuf, sslen, nil);
339*a325d9c4SApple OSS Distributions
340*a325d9c4SApple OSS Distributions		struct scenario delta_scenario = {
341*a325d9c4SApple OSS Distributions			.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_GET_GLOBAL_MEM_STATS
342*a325d9c4SApple OSS Distributions					| STACKSHOT_SAVE_IMP_DONATION_PIDS | STACKSHOT_KCDATA_FORMAT
343*a325d9c4SApple OSS Distributions					| STACKSHOT_COLLECT_DELTA_SNAPSHOT),
344*a325d9c4SApple OSS Distributions			.since_timestamp = stackshot_time
345*a325d9c4SApple OSS Distributions		};
346*a325d9c4SApple OSS Distributions
347*a325d9c4SApple OSS Distributions		take_stackshot(&delta_scenario, false, ^(void *dssbuf, size_t dsslen) {
348*a325d9c4SApple OSS Distributions			parse_stackshot(PARSE_STACKSHOT_DELTA, dssbuf, dsslen, nil);
349*a325d9c4SApple OSS Distributions		});
350*a325d9c4SApple OSS Distributions	});
351*a325d9c4SApple OSS Distributions}
352*a325d9c4SApple OSS Distributions
353*a325d9c4SApple OSS DistributionsT_DECL(shared_cache_layout, "test stackshot inclusion of shared cache layout")
354*a325d9c4SApple OSS Distributions{
355*a325d9c4SApple OSS Distributions	struct scenario scenario = {
356*a325d9c4SApple OSS Distributions		.name = "shared_cache_layout",
357*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_GET_GLOBAL_MEM_STATS
358*a325d9c4SApple OSS Distributions				| STACKSHOT_SAVE_IMP_DONATION_PIDS | STACKSHOT_KCDATA_FORMAT |
359*a325d9c4SApple OSS Distributions				STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT),
360*a325d9c4SApple OSS Distributions	};
361*a325d9c4SApple OSS Distributions
362*a325d9c4SApple OSS Distributions	size_t shared_cache_length;
363*a325d9c4SApple OSS Distributions	const void *cache_header = _dyld_get_shared_cache_range(&shared_cache_length);
364*a325d9c4SApple OSS Distributions	if (cache_header == NULL) {
365*a325d9c4SApple OSS Distributions		T_SKIP("Device not running with shared cache, skipping test...");
366*a325d9c4SApple OSS Distributions	}
367*a325d9c4SApple OSS Distributions
368*a325d9c4SApple OSS Distributions	if (shared_cache_length == 0) {
369*a325d9c4SApple OSS Distributions		T_SKIP("dyld reports that currently running shared cache has zero length");
370*a325d9c4SApple OSS Distributions	}
371*a325d9c4SApple OSS Distributions
372*a325d9c4SApple OSS Distributions	T_LOG("taking stackshot with STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT set");
373*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, true, ^(void *ssbuf, size_t sslen) {
374*a325d9c4SApple OSS Distributions		parse_stackshot(PARSE_STACKSHOT_SHAREDCACHE_LAYOUT, ssbuf, sslen, nil);
375*a325d9c4SApple OSS Distributions	});
376*a325d9c4SApple OSS Distributions}
377*a325d9c4SApple OSS Distributions
378*a325d9c4SApple OSS DistributionsT_DECL(stress, "test that taking stackshots for 60 seconds doesn't crash the system")
379*a325d9c4SApple OSS Distributions{
380*a325d9c4SApple OSS Distributions	uint64_t max_diff_time = 60ULL /* seconds */ * 1000000000ULL;
381*a325d9c4SApple OSS Distributions	uint64_t start_time;
382*a325d9c4SApple OSS Distributions
383*a325d9c4SApple OSS Distributions	struct scenario scenario = {
384*a325d9c4SApple OSS Distributions		.name = "stress",
385*a325d9c4SApple OSS Distributions		.quiet = true,
386*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_KCDATA_FORMAT |
387*a325d9c4SApple OSS Distributions				STACKSHOT_THREAD_WAITINFO |
388*a325d9c4SApple OSS Distributions				STACKSHOT_SAVE_LOADINFO |
389*a325d9c4SApple OSS Distributions				STACKSHOT_SAVE_KEXT_LOADINFO |
390*a325d9c4SApple OSS Distributions				STACKSHOT_GET_GLOBAL_MEM_STATS |
391*a325d9c4SApple OSS Distributions				STACKSHOT_SAVE_IMP_DONATION_PIDS |
392*a325d9c4SApple OSS Distributions				STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT |
393*a325d9c4SApple OSS Distributions				STACKSHOT_THREAD_GROUP |
394*a325d9c4SApple OSS Distributions				STACKSHOT_SAVE_JETSAM_COALITIONS |
395*a325d9c4SApple OSS Distributions				STACKSHOT_ASID |
396*a325d9c4SApple OSS Distributions				0),
397*a325d9c4SApple OSS Distributions	};
398*a325d9c4SApple OSS Distributions
399*a325d9c4SApple OSS Distributions	start_time = clock_gettime_nsec_np(CLOCK_MONOTONIC);
400*a325d9c4SApple OSS Distributions	while (clock_gettime_nsec_np(CLOCK_MONOTONIC) - start_time < max_diff_time) {
401*a325d9c4SApple OSS Distributions		take_stackshot(&scenario, false, ^(void * __unused ssbuf,
402*a325d9c4SApple OSS Distributions				size_t __unused sslen) {
403*a325d9c4SApple OSS Distributions			printf(".");
404*a325d9c4SApple OSS Distributions			fflush(stdout);
405*a325d9c4SApple OSS Distributions		});
406*a325d9c4SApple OSS Distributions
407*a325d9c4SApple OSS Distributions		/* Leave some time for the testing infrastructure to catch up */
408*a325d9c4SApple OSS Distributions		usleep(10000);
409*a325d9c4SApple OSS Distributions
410*a325d9c4SApple OSS Distributions	}
411*a325d9c4SApple OSS Distributions	printf("\n");
412*a325d9c4SApple OSS Distributions}
413*a325d9c4SApple OSS Distributions
414*a325d9c4SApple OSS DistributionsT_DECL(dispatch_queue_label, "test that kcdata stackshots contain libdispatch queue labels")
415*a325d9c4SApple OSS Distributions{
416*a325d9c4SApple OSS Distributions	struct scenario scenario = {
417*a325d9c4SApple OSS Distributions		.name = "kcdata",
418*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_GET_DQ | STACKSHOT_KCDATA_FORMAT),
419*a325d9c4SApple OSS Distributions	};
420*a325d9c4SApple OSS Distributions	dispatch_semaphore_t child_ready_sem, parent_done_sem;
421*a325d9c4SApple OSS Distributions	dispatch_queue_t dq;
422*a325d9c4SApple OSS Distributions
423*a325d9c4SApple OSS Distributions#if TARGET_OS_WATCH
424*a325d9c4SApple OSS Distributions	T_SKIP("This test is flaky on watches: 51663346");
425*a325d9c4SApple OSS Distributions#endif
426*a325d9c4SApple OSS Distributions
427*a325d9c4SApple OSS Distributions	child_ready_sem = dispatch_semaphore_create(0);
428*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(child_ready_sem, "dqlabel child semaphore");
429*a325d9c4SApple OSS Distributions
430*a325d9c4SApple OSS Distributions	parent_done_sem = dispatch_semaphore_create(0);
431*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(parent_done_sem, "dqlabel parent semaphore");
432*a325d9c4SApple OSS Distributions
433*a325d9c4SApple OSS Distributions	dq = dispatch_queue_create(TEST_STACKSHOT_QUEUE_LABEL, NULL);
434*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(dq, "dispatch queue");
435*a325d9c4SApple OSS Distributions
436*a325d9c4SApple OSS Distributions	/* start the helper thread */
437*a325d9c4SApple OSS Distributions	dispatch_async(dq, ^{
438*a325d9c4SApple OSS Distributions			dispatch_semaphore_signal(child_ready_sem);
439*a325d9c4SApple OSS Distributions
440*a325d9c4SApple OSS Distributions			dispatch_semaphore_wait(parent_done_sem, DISPATCH_TIME_FOREVER);
441*a325d9c4SApple OSS Distributions	});
442*a325d9c4SApple OSS Distributions
443*a325d9c4SApple OSS Distributions	/* block behind the child starting up */
444*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(child_ready_sem, DISPATCH_TIME_FOREVER);
445*a325d9c4SApple OSS Distributions
446*a325d9c4SApple OSS Distributions	T_LOG("taking kcdata stackshot with libdispatch queue labels");
447*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, true, ^(void *ssbuf, size_t sslen) {
448*a325d9c4SApple OSS Distributions		parse_stackshot(PARSE_STACKSHOT_DISPATCH_QUEUE_LABEL, ssbuf, sslen, nil);
449*a325d9c4SApple OSS Distributions	});
450*a325d9c4SApple OSS Distributions
451*a325d9c4SApple OSS Distributions	dispatch_semaphore_signal(parent_done_sem);
452*a325d9c4SApple OSS Distributions}
453*a325d9c4SApple OSS Distributions
454*a325d9c4SApple OSS Distributions#define CACHEADDR_ENV "STACKSHOT_TEST_DYLDADDR"
455*a325d9c4SApple OSS DistributionsT_HELPER_DECL(spawn_reslide_child, "child process to spawn with alternate slide")
456*a325d9c4SApple OSS Distributions{
457*a325d9c4SApple OSS Distributions	size_t shared_cache_len;
458*a325d9c4SApple OSS Distributions	const void *addr, *prevaddr;
459*a325d9c4SApple OSS Distributions	uintmax_t v;
460*a325d9c4SApple OSS Distributions	char *endptr;
461*a325d9c4SApple OSS Distributions
462*a325d9c4SApple OSS Distributions	const char *cacheaddr_env = getenv(CACHEADDR_ENV);
463*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(cacheaddr_env, "getenv("CACHEADDR_ENV")");
464*a325d9c4SApple OSS Distributions	errno = 0;
465*a325d9c4SApple OSS Distributions	endptr = NULL;
466*a325d9c4SApple OSS Distributions	v = strtoumax(cacheaddr_env, &endptr, 16);	/* read hex value */
467*a325d9c4SApple OSS Distributions	T_WITH_ERRNO; T_QUIET; T_ASSERT_NE(v, 0l, "getenv(%s) = \"%s\" should be a non-zero hex number", CACHEADDR_ENV, cacheaddr_env);
468*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_EQ(*endptr, 0, "getenv(%s) = \"%s\" endptr \"%s\" should be empty", CACHEADDR_ENV, cacheaddr_env, endptr);
469*a325d9c4SApple OSS Distributions
470*a325d9c4SApple OSS Distributions	prevaddr = (const void *)v;
471*a325d9c4SApple OSS Distributions	addr = _dyld_get_shared_cache_range(&shared_cache_len);
472*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(addr, "shared cache address");
473*a325d9c4SApple OSS Distributions
474*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_SUCCESS(kill(getppid(), (addr == prevaddr) ? SIGUSR2 : SIGUSR1), "signaled parent to take stackshot");
475*a325d9c4SApple OSS Distributions	for (;;) {
476*a325d9c4SApple OSS Distributions		(void) pause();		/* parent will kill -9 us */
477*a325d9c4SApple OSS Distributions	}
478*a325d9c4SApple OSS Distributions}
479*a325d9c4SApple OSS Distributions
480*a325d9c4SApple OSS DistributionsT_DECL(shared_cache_flags, "tests stackshot's task_ss_flags for the shared cache")
481*a325d9c4SApple OSS Distributions{
482*a325d9c4SApple OSS Distributions	posix_spawnattr_t		attr;
483*a325d9c4SApple OSS Distributions	char *env_addr;
484*a325d9c4SApple OSS Distributions	char path[PATH_MAX];
485*a325d9c4SApple OSS Distributions	__block bool child_same_addr = false;
486*a325d9c4SApple OSS Distributions
487*a325d9c4SApple OSS Distributions	uint32_t path_size = sizeof(path);
488*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_ZERO(_NSGetExecutablePath(path, &path_size), "_NSGetExecutablePath");
489*a325d9c4SApple OSS Distributions	char *args[] = { path, "-n", "spawn_reslide_child", NULL };
490*a325d9c4SApple OSS Distributions	pid_t pid;
491*a325d9c4SApple OSS Distributions	size_t shared_cache_len;
492*a325d9c4SApple OSS Distributions	const void *addr;
493*a325d9c4SApple OSS Distributions
494*a325d9c4SApple OSS Distributions	dispatch_source_t child_diffsig_src, child_samesig_src;
495*a325d9c4SApple OSS Distributions	dispatch_semaphore_t child_ready_sem = dispatch_semaphore_create(0);
496*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(child_ready_sem, "shared_cache child semaphore");
497*a325d9c4SApple OSS Distributions
498*a325d9c4SApple OSS Distributions	dispatch_queue_t signal_processing_q = dispatch_queue_create("signal processing queue", NULL);
499*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(signal_processing_q, "signal processing queue");
500*a325d9c4SApple OSS Distributions
501*a325d9c4SApple OSS Distributions	signal(SIGUSR1, SIG_IGN);
502*a325d9c4SApple OSS Distributions	signal(SIGUSR2, SIG_IGN);
503*a325d9c4SApple OSS Distributions	child_samesig_src = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGUSR1, 0, signal_processing_q);
504*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(child_samesig_src, "dispatch_source_create (child_samesig_src)");
505*a325d9c4SApple OSS Distributions	child_diffsig_src = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGUSR2, 0, signal_processing_q);
506*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(child_diffsig_src, "dispatch_source_create (child_diffsig_src)");
507*a325d9c4SApple OSS Distributions
508*a325d9c4SApple OSS Distributions	/* child will signal us depending on if their addr is the same or different */
509*a325d9c4SApple OSS Distributions	dispatch_source_set_event_handler(child_samesig_src, ^{ child_same_addr = false; dispatch_semaphore_signal(child_ready_sem); });
510*a325d9c4SApple OSS Distributions	dispatch_source_set_event_handler(child_diffsig_src, ^{ child_same_addr = true; dispatch_semaphore_signal(child_ready_sem); });
511*a325d9c4SApple OSS Distributions	dispatch_activate(child_samesig_src);
512*a325d9c4SApple OSS Distributions	dispatch_activate(child_diffsig_src);
513*a325d9c4SApple OSS Distributions
514*a325d9c4SApple OSS Distributions	addr = _dyld_get_shared_cache_range(&shared_cache_len);
515*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(addr, "shared cache address");
516*a325d9c4SApple OSS Distributions
517*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_SUCCESS(asprintf(&env_addr, "%p", addr), "asprintf of env_addr succeeded");
518*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_SUCCESS(setenv(CACHEADDR_ENV, env_addr, true), "setting "CACHEADDR_ENV" to %s", env_addr);
519*a325d9c4SApple OSS Distributions
520*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_ZERO(posix_spawnattr_init(&attr), "posix_spawnattr_init");
521*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_ZERO(posix_spawnattr_setflags(&attr, _POSIX_SPAWN_RESLIDE), "posix_spawnattr_setflags");
522*a325d9c4SApple OSS Distributions	int sp_ret = posix_spawn(&pid, path, NULL, &attr, args, environ);
523*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_ZERO(sp_ret, "spawned process '%s' with PID %d", args[0], pid);
524*a325d9c4SApple OSS Distributions
525*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(child_ready_sem, DISPATCH_TIME_FOREVER);
526*a325d9c4SApple OSS Distributions	T_LOG("received signal from child (%s), capturing stackshot", child_same_addr ? "same shared cache addr" : "different shared cache addr");
527*a325d9c4SApple OSS Distributions
528*a325d9c4SApple OSS Distributions	struct scenario scenario = {
529*a325d9c4SApple OSS Distributions		.name = "shared_cache_flags",
530*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_GET_GLOBAL_MEM_STATS
531*a325d9c4SApple OSS Distributions				| STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT
532*a325d9c4SApple OSS Distributions				| STACKSHOT_SAVE_IMP_DONATION_PIDS | STACKSHOT_KCDATA_FORMAT),
533*a325d9c4SApple OSS Distributions	};
534*a325d9c4SApple OSS Distributions
535*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, false, ^( void *ssbuf, size_t sslen) {
536*a325d9c4SApple OSS Distributions		int status;
537*a325d9c4SApple OSS Distributions		/* First kill the child so we can reap it */
538*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_POSIX_SUCCESS(kill(pid, SIGKILL), "killing spawned process");
539*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_POSIX_SUCCESS(waitpid(pid, &status, 0), "waitpid on spawned child");
540*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_EQ(!!WIFSIGNALED(status), 1, "waitpid status should be signalled");
541*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_EQ(WTERMSIG(status), SIGKILL, "waitpid status should be SIGKILLed");
542*a325d9c4SApple OSS Distributions
543*a325d9c4SApple OSS Distributions		parse_stackshot(PARSE_STACKSHOT_SHAREDCACHE_FLAGS, ssbuf, sslen,
544*a325d9c4SApple OSS Distributions			@{sharedcache_child_pid_key: @(pid), sharedcache_child_sameaddr_key: @(child_same_addr ? 1 : 0)});
545*a325d9c4SApple OSS Distributions	});
546*a325d9c4SApple OSS Distributions}
547*a325d9c4SApple OSS Distributions
548*a325d9c4SApple OSS DistributionsT_DECL(transitioning_tasks, "test that stackshot contains transitioning task info", T_META_BOOTARGS_SET("enable_proc_exit_lpexit_spin=1"))
549*a325d9c4SApple OSS Distributions{
550*a325d9c4SApple OSS Distributions    int32_t sysctlValue = -1, numAttempts =0;
551*a325d9c4SApple OSS Distributions    char path[PATH_MAX];
552*a325d9c4SApple OSS Distributions    uint32_t path_size = sizeof(path);
553*a325d9c4SApple OSS Distributions    T_QUIET; T_ASSERT_POSIX_ZERO(_NSGetExecutablePath(path, &path_size), "_NSGetExecutablePath");
554*a325d9c4SApple OSS Distributions    char *args[] = { path, "-n", "exec_child_preexec", NULL };
555*a325d9c4SApple OSS Distributions
556*a325d9c4SApple OSS Distributions    dispatch_source_t child_sig_src;
557*a325d9c4SApple OSS Distributions    dispatch_semaphore_t child_ready_sem = dispatch_semaphore_create(0);
558*a325d9c4SApple OSS Distributions    T_QUIET; T_ASSERT_NOTNULL(child_ready_sem, "exec child semaphore");
559*a325d9c4SApple OSS Distributions
560*a325d9c4SApple OSS Distributions    dispatch_queue_t signal_processing_q = dispatch_queue_create("signal processing queue", NULL);
561*a325d9c4SApple OSS Distributions    T_QUIET; T_ASSERT_NOTNULL(signal_processing_q, "signal processing queue");
562*a325d9c4SApple OSS Distributions
563*a325d9c4SApple OSS Distributions    pid_t pid;
564*a325d9c4SApple OSS Distributions
565*a325d9c4SApple OSS Distributions    signal(SIGUSR1, SIG_IGN);
566*a325d9c4SApple OSS Distributions    child_sig_src = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGUSR1, 0, signal_processing_q);
567*a325d9c4SApple OSS Distributions    T_QUIET; T_ASSERT_NOTNULL(child_sig_src, "dispatch_source_create (child_sig_src)");
568*a325d9c4SApple OSS Distributions
569*a325d9c4SApple OSS Distributions    dispatch_source_set_event_handler(child_sig_src, ^{ dispatch_semaphore_signal(child_ready_sem); });
570*a325d9c4SApple OSS Distributions    dispatch_activate(child_sig_src);
571*a325d9c4SApple OSS Distributions
572*a325d9c4SApple OSS Distributions    T_ASSERT_POSIX_SUCCESS(sysctlbyname("debug.proc_exit_lpexit_spin_pid", NULL, NULL, &sysctlValue, sizeof(sysctlValue)), "set debug.proc_exit_lpexit_spin_pid=-1");
573*a325d9c4SApple OSS Distributions
574*a325d9c4SApple OSS Distributions    int proc_exit_spin_pos = 0 ;
575*a325d9c4SApple OSS Distributions
576*a325d9c4SApple OSS Distributions    while (0 == sysctlbyname("debug.proc_exit_lpexit_spin_pos", NULL, NULL, &proc_exit_spin_pos, sizeof(proc_exit_spin_pos))) {
577*a325d9c4SApple OSS Distributions
578*a325d9c4SApple OSS Distributions        T_LOG(" ##### Testing while spinning in proc_exit at position %d ##### ", proc_exit_spin_pos);
579*a325d9c4SApple OSS Distributions
580*a325d9c4SApple OSS Distributions        int sp_ret = posix_spawn(&pid, args[0], NULL, NULL, args, NULL);
581*a325d9c4SApple OSS Distributions        T_ASSERT_POSIX_ZERO(sp_ret, "spawned process '%s' with PID %d", args[0], pid);
582*a325d9c4SApple OSS Distributions
583*a325d9c4SApple OSS Distributions        dispatch_semaphore_wait(child_ready_sem, DISPATCH_TIME_FOREVER);
584*a325d9c4SApple OSS Distributions
585*a325d9c4SApple OSS Distributions        struct proc_uniqidentifierinfo proc_info_data = { };
586*a325d9c4SApple OSS Distributions        int retval = proc_pidinfo(getpid(), PROC_PIDUNIQIDENTIFIERINFO, 0, &proc_info_data, sizeof(proc_info_data));
587*a325d9c4SApple OSS Distributions        T_QUIET; T_EXPECT_POSIX_SUCCESS(retval, "proc_pidinfo PROC_PIDUNIQIDENTIFIERINFO");
588*a325d9c4SApple OSS Distributions        T_QUIET; T_ASSERT_EQ_INT(retval, (int) sizeof(proc_info_data), "proc_pidinfo PROC_PIDUNIQIDENTIFIERINFO returned data");
589*a325d9c4SApple OSS Distributions
590*a325d9c4SApple OSS Distributions        T_ASSERT_POSIX_SUCCESS(kill(pid, SIGUSR1), "signaled pre-exec child to exec");
591*a325d9c4SApple OSS Distributions
592*a325d9c4SApple OSS Distributions        dispatch_semaphore_wait(child_ready_sem, DISPATCH_TIME_FOREVER);
593*a325d9c4SApple OSS Distributions
594*a325d9c4SApple OSS Distributions        T_ASSERT_POSIX_SUCCESS(sysctlbyname("debug.proc_exit_lpexit_spin_pid", NULL, NULL, &pid, sizeof(pid)), "set debug.proc_exit_lpexit_spin_pid =  %d, ", pid);
595*a325d9c4SApple OSS Distributions
596*a325d9c4SApple OSS Distributions        T_ASSERT_POSIX_SUCCESS(kill(pid, SIGKILL), "kill post-exec child %d", pid);
597*a325d9c4SApple OSS Distributions
598*a325d9c4SApple OSS Distributions        sysctlValue = 0;
599*a325d9c4SApple OSS Distributions        size_t len = sizeof(sysctlValue);
600*a325d9c4SApple OSS Distributions        while (numAttempts < 5) {
601*a325d9c4SApple OSS Distributions            T_ASSERT_POSIX_SUCCESS(sysctlbyname("debug.proc_exit_lpexit_spinning", &sysctlValue, &len, NULL, 0), "retrieve debug.proc_exit_lpexit_spinning");
602*a325d9c4SApple OSS Distributions            if (sysctlValue != 1) numAttempts++;
603*a325d9c4SApple OSS Distributions            else break;
604*a325d9c4SApple OSS Distributions            sleep(1);
605*a325d9c4SApple OSS Distributions        }
606*a325d9c4SApple OSS Distributions
607*a325d9c4SApple OSS Distributions        T_ASSERT_EQ_UINT(sysctlValue, 1, "find spinning task in proc_exit()");
608*a325d9c4SApple OSS Distributions
609*a325d9c4SApple OSS Distributions        struct scenario scenario = {
610*a325d9c4SApple OSS Distributions            .name = "transitioning_tasks",
611*a325d9c4SApple OSS Distributions            .flags = (STACKSHOT_KCDATA_FORMAT)
612*a325d9c4SApple OSS Distributions        };
613*a325d9c4SApple OSS Distributions
614*a325d9c4SApple OSS Distributions        take_stackshot(&scenario, false, ^( void *ssbuf, size_t sslen) {
615*a325d9c4SApple OSS Distributions            parse_stackshot(PARSE_STACKSHOT_TRANSITIONING, ssbuf, sslen, @{transitioning_pid_key: @(pid)});
616*a325d9c4SApple OSS Distributions
617*a325d9c4SApple OSS Distributions            // Kill the child
618*a325d9c4SApple OSS Distributions            int sysctlValueB = -1;
619*a325d9c4SApple OSS Distributions            T_ASSERT_POSIX_SUCCESS(sysctlbyname("debug.proc_exit_lpexit_spin_pid", NULL, NULL, &sysctlValueB, sizeof(sysctlValueB)), "set debug.proc_exit_lpexit_spin_pid=-1");
620*a325d9c4SApple OSS Distributions            sleep(1);
621*a325d9c4SApple OSS Distributions            size_t blen = sizeof(sysctlValueB);
622*a325d9c4SApple OSS Distributions            T_ASSERT_POSIX_SUCCESS(sysctlbyname("debug.proc_exit_lpexit_spinning", &sysctlValueB, &blen, NULL, 0), "retrieve debug.proc_exit_lpexit_spinning");
623*a325d9c4SApple OSS Distributions            T_ASSERT_EQ_UINT(sysctlValueB, 0, "make sure nothing is spining in proc_exit()");
624*a325d9c4SApple OSS Distributions            int status;
625*a325d9c4SApple OSS Distributions            T_ASSERT_POSIX_SUCCESS(waitpid(pid, &status, 0), "waitpid on post-exec child");
626*a325d9c4SApple OSS Distributions        });
627*a325d9c4SApple OSS Distributions
628*a325d9c4SApple OSS Distributions        proc_exit_spin_pos++;
629*a325d9c4SApple OSS Distributions    }
630*a325d9c4SApple OSS Distributions
631*a325d9c4SApple OSS Distributions}
632*a325d9c4SApple OSS Distributions
633*a325d9c4SApple OSS Distributionsstatic void *stuck_sysctl_thread(void *arg) {
634*a325d9c4SApple OSS Distributions	int val = 1;
635*a325d9c4SApple OSS Distributions	dispatch_semaphore_t child_thread_started = *(dispatch_semaphore_t *)arg;
636*a325d9c4SApple OSS Distributions
637*a325d9c4SApple OSS Distributions	dispatch_semaphore_signal(child_thread_started);
638*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_SUCCESS(sysctlbyname("kern.wedge_thread", NULL, NULL, &val, sizeof(val)), "wedge child thread");
639*a325d9c4SApple OSS Distributions
640*a325d9c4SApple OSS Distributions	return NULL;
641*a325d9c4SApple OSS Distributions}
642*a325d9c4SApple OSS Distributions
643*a325d9c4SApple OSS DistributionsT_HELPER_DECL(zombie_child, "child process to sample as a zombie")
644*a325d9c4SApple OSS Distributions{
645*a325d9c4SApple OSS Distributions	pthread_t pthread;
646*a325d9c4SApple OSS Distributions	dispatch_semaphore_t child_thread_started = dispatch_semaphore_create(0);
647*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(child_thread_started, "zombie child thread semaphore");
648*a325d9c4SApple OSS Distributions
649*a325d9c4SApple OSS Distributions	/* spawn another thread to get stuck in the kernel, then call exit() to become a zombie */
650*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_SUCCESS(pthread_create(&pthread, NULL, stuck_sysctl_thread, &child_thread_started), "pthread_create");
651*a325d9c4SApple OSS Distributions
652*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(child_thread_started, DISPATCH_TIME_FOREVER);
653*a325d9c4SApple OSS Distributions
654*a325d9c4SApple OSS Distributions	/* sleep for a bit in the hope of ensuring that the other thread has called the sysctl before we signal the parent */
655*a325d9c4SApple OSS Distributions	usleep(100);
656*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_SUCCESS(kill(getppid(), SIGUSR1), "signaled parent to take stackshot");
657*a325d9c4SApple OSS Distributions
658*a325d9c4SApple OSS Distributions	exit(0);
659*a325d9c4SApple OSS Distributions}
660*a325d9c4SApple OSS Distributions
661*a325d9c4SApple OSS DistributionsT_DECL(zombie, "tests a stackshot of a zombie task with a thread stuck in the kernel")
662*a325d9c4SApple OSS Distributions{
663*a325d9c4SApple OSS Distributions	char path[PATH_MAX];
664*a325d9c4SApple OSS Distributions	uint32_t path_size = sizeof(path);
665*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_ZERO(_NSGetExecutablePath(path, &path_size), "_NSGetExecutablePath");
666*a325d9c4SApple OSS Distributions	char *args[] = { path, "-n", "zombie_child", NULL };
667*a325d9c4SApple OSS Distributions
668*a325d9c4SApple OSS Distributions	dispatch_source_t child_sig_src;
669*a325d9c4SApple OSS Distributions	dispatch_semaphore_t child_ready_sem = dispatch_semaphore_create(0);
670*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(child_ready_sem, "zombie child semaphore");
671*a325d9c4SApple OSS Distributions
672*a325d9c4SApple OSS Distributions	dispatch_queue_t signal_processing_q = dispatch_queue_create("signal processing queue", NULL);
673*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(signal_processing_q, "signal processing queue");
674*a325d9c4SApple OSS Distributions
675*a325d9c4SApple OSS Distributions	pid_t pid;
676*a325d9c4SApple OSS Distributions
677*a325d9c4SApple OSS Distributions	T_LOG("spawning a child");
678*a325d9c4SApple OSS Distributions
679*a325d9c4SApple OSS Distributions	signal(SIGUSR1, SIG_IGN);
680*a325d9c4SApple OSS Distributions	child_sig_src = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGUSR1, 0, signal_processing_q);
681*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(child_sig_src, "dispatch_source_create (child_sig_src)");
682*a325d9c4SApple OSS Distributions
683*a325d9c4SApple OSS Distributions	dispatch_source_set_event_handler(child_sig_src, ^{ dispatch_semaphore_signal(child_ready_sem); });
684*a325d9c4SApple OSS Distributions	dispatch_activate(child_sig_src);
685*a325d9c4SApple OSS Distributions
686*a325d9c4SApple OSS Distributions	int sp_ret = posix_spawn(&pid, args[0], NULL, NULL, args, NULL);
687*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_ZERO(sp_ret, "spawned process '%s' with PID %d", args[0], pid);
688*a325d9c4SApple OSS Distributions
689*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(child_ready_sem, DISPATCH_TIME_FOREVER);
690*a325d9c4SApple OSS Distributions
691*a325d9c4SApple OSS Distributions	T_LOG("received signal from child, capturing stackshot");
692*a325d9c4SApple OSS Distributions
693*a325d9c4SApple OSS Distributions	struct proc_bsdshortinfo bsdshortinfo;
694*a325d9c4SApple OSS Distributions	int retval, iterations_to_wait = 10;
695*a325d9c4SApple OSS Distributions
696*a325d9c4SApple OSS Distributions	while (iterations_to_wait > 0) {
697*a325d9c4SApple OSS Distributions		retval = proc_pidinfo(pid, PROC_PIDT_SHORTBSDINFO, 0, &bsdshortinfo, sizeof(bsdshortinfo));
698*a325d9c4SApple OSS Distributions		if ((retval == 0) && errno == ESRCH) {
699*a325d9c4SApple OSS Distributions			T_LOG("unable to find child using proc_pidinfo, assuming zombie");
700*a325d9c4SApple OSS Distributions			break;
701*a325d9c4SApple OSS Distributions		}
702*a325d9c4SApple OSS Distributions
703*a325d9c4SApple OSS Distributions		T_QUIET; T_WITH_ERRNO; T_ASSERT_GT(retval, 0, "proc_pidinfo(PROC_PIDT_SHORTBSDINFO) returned a value > 0");
704*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_EQ(retval, (int)sizeof(bsdshortinfo), "proc_pidinfo call for PROC_PIDT_SHORTBSDINFO returned expected size");
705*a325d9c4SApple OSS Distributions
706*a325d9c4SApple OSS Distributions		if (bsdshortinfo.pbsi_flags & PROC_FLAG_INEXIT) {
707*a325d9c4SApple OSS Distributions			T_LOG("child proc info marked as in exit");
708*a325d9c4SApple OSS Distributions			break;
709*a325d9c4SApple OSS Distributions		}
710*a325d9c4SApple OSS Distributions
711*a325d9c4SApple OSS Distributions		iterations_to_wait--;
712*a325d9c4SApple OSS Distributions		if (iterations_to_wait == 0) {
713*a325d9c4SApple OSS Distributions			/*
714*a325d9c4SApple OSS Distributions			 * This will mark the test as failed but let it continue so we
715*a325d9c4SApple OSS Distributions			 * don't leave a process stuck in the kernel.
716*a325d9c4SApple OSS Distributions			 */
717*a325d9c4SApple OSS Distributions			T_FAIL("unable to discover that child is marked as exiting");
718*a325d9c4SApple OSS Distributions		}
719*a325d9c4SApple OSS Distributions
720*a325d9c4SApple OSS Distributions		/* Give the child a few more seconds to make it to exit */
721*a325d9c4SApple OSS Distributions		sleep(5);
722*a325d9c4SApple OSS Distributions	}
723*a325d9c4SApple OSS Distributions
724*a325d9c4SApple OSS Distributions	/* Give the child some more time to make it through exit */
725*a325d9c4SApple OSS Distributions	sleep(10);
726*a325d9c4SApple OSS Distributions
727*a325d9c4SApple OSS Distributions	struct scenario scenario = {
728*a325d9c4SApple OSS Distributions		.name = "zombie",
729*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_GET_GLOBAL_MEM_STATS
730*a325d9c4SApple OSS Distributions				| STACKSHOT_SAVE_IMP_DONATION_PIDS | STACKSHOT_KCDATA_FORMAT),
731*a325d9c4SApple OSS Distributions	};
732*a325d9c4SApple OSS Distributions
733*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, false, ^( void *ssbuf, size_t sslen) {
734*a325d9c4SApple OSS Distributions		/* First unwedge the child so we can reap it */
735*a325d9c4SApple OSS Distributions		int val = 1, status;
736*a325d9c4SApple OSS Distributions		T_ASSERT_POSIX_SUCCESS(sysctlbyname("kern.unwedge_thread", NULL, NULL, &val, sizeof(val)), "unwedge child");
737*a325d9c4SApple OSS Distributions
738*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_POSIX_SUCCESS(waitpid(pid, &status, 0), "waitpid on zombie child");
739*a325d9c4SApple OSS Distributions
740*a325d9c4SApple OSS Distributions		parse_stackshot(PARSE_STACKSHOT_ZOMBIE, ssbuf, sslen, @{zombie_child_pid_key: @(pid)});
741*a325d9c4SApple OSS Distributions	});
742*a325d9c4SApple OSS Distributions}
743*a325d9c4SApple OSS Distributions
744*a325d9c4SApple OSS DistributionsT_HELPER_DECL(exec_child_preexec, "child process pre-exec")
745*a325d9c4SApple OSS Distributions{
746*a325d9c4SApple OSS Distributions	dispatch_queue_t signal_processing_q = dispatch_queue_create("signal processing queue", NULL);
747*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(signal_processing_q, "signal processing queue");
748*a325d9c4SApple OSS Distributions
749*a325d9c4SApple OSS Distributions	signal(SIGUSR1, SIG_IGN);
750*a325d9c4SApple OSS Distributions	dispatch_source_t parent_sig_src = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGUSR1, 0, signal_processing_q);
751*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(parent_sig_src, "dispatch_source_create (child_sig_src)");
752*a325d9c4SApple OSS Distributions	dispatch_source_set_event_handler(parent_sig_src, ^{
753*a325d9c4SApple OSS Distributions
754*a325d9c4SApple OSS Distributions		// Parent took a timestamp then signaled us: exec into the next process
755*a325d9c4SApple OSS Distributions
756*a325d9c4SApple OSS Distributions		char path[PATH_MAX];
757*a325d9c4SApple OSS Distributions		uint32_t path_size = sizeof(path);
758*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_POSIX_ZERO(_NSGetExecutablePath(path, &path_size), "_NSGetExecutablePath");
759*a325d9c4SApple OSS Distributions		char *args[] = { path, "-n", "exec_child_postexec", NULL };
760*a325d9c4SApple OSS Distributions
761*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_POSIX_ZERO(execve(args[0], args, NULL), "execing into exec_child_postexec");
762*a325d9c4SApple OSS Distributions	});
763*a325d9c4SApple OSS Distributions	dispatch_activate(parent_sig_src);
764*a325d9c4SApple OSS Distributions
765*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_SUCCESS(kill(getppid(), SIGUSR1), "signaled parent to take timestamp");
766*a325d9c4SApple OSS Distributions
767*a325d9c4SApple OSS Distributions	sleep(100);
768*a325d9c4SApple OSS Distributions	// Should never get here
769*a325d9c4SApple OSS Distributions	T_FAIL("Received signal to exec from parent");
770*a325d9c4SApple OSS Distributions}
771*a325d9c4SApple OSS Distributions
772*a325d9c4SApple OSS DistributionsT_HELPER_DECL(exec_child_postexec, "child process post-exec to sample")
773*a325d9c4SApple OSS Distributions{
774*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_SUCCESS(kill(getppid(), SIGUSR1), "signaled parent to take stackshot");
775*a325d9c4SApple OSS Distributions	sleep(100);
776*a325d9c4SApple OSS Distributions	// Should never get here
777*a325d9c4SApple OSS Distributions	T_FAIL("Killed by parent");
778*a325d9c4SApple OSS Distributions}
779*a325d9c4SApple OSS Distributions
780*a325d9c4SApple OSS DistributionsT_DECL(exec, "test getting full task snapshots for a task that execs")
781*a325d9c4SApple OSS Distributions{
782*a325d9c4SApple OSS Distributions	char path[PATH_MAX];
783*a325d9c4SApple OSS Distributions	uint32_t path_size = sizeof(path);
784*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_ZERO(_NSGetExecutablePath(path, &path_size), "_NSGetExecutablePath");
785*a325d9c4SApple OSS Distributions	char *args[] = { path, "-n", "exec_child_preexec", NULL };
786*a325d9c4SApple OSS Distributions
787*a325d9c4SApple OSS Distributions	dispatch_source_t child_sig_src;
788*a325d9c4SApple OSS Distributions	dispatch_semaphore_t child_ready_sem = dispatch_semaphore_create(0);
789*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(child_ready_sem, "exec child semaphore");
790*a325d9c4SApple OSS Distributions
791*a325d9c4SApple OSS Distributions	dispatch_queue_t signal_processing_q = dispatch_queue_create("signal processing queue", NULL);
792*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(signal_processing_q, "signal processing queue");
793*a325d9c4SApple OSS Distributions
794*a325d9c4SApple OSS Distributions	pid_t pid;
795*a325d9c4SApple OSS Distributions
796*a325d9c4SApple OSS Distributions	T_LOG("spawning a child");
797*a325d9c4SApple OSS Distributions
798*a325d9c4SApple OSS Distributions	signal(SIGUSR1, SIG_IGN);
799*a325d9c4SApple OSS Distributions	child_sig_src = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGUSR1, 0, signal_processing_q);
800*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(child_sig_src, "dispatch_source_create (child_sig_src)");
801*a325d9c4SApple OSS Distributions
802*a325d9c4SApple OSS Distributions	dispatch_source_set_event_handler(child_sig_src, ^{ dispatch_semaphore_signal(child_ready_sem); });
803*a325d9c4SApple OSS Distributions	dispatch_activate(child_sig_src);
804*a325d9c4SApple OSS Distributions
805*a325d9c4SApple OSS Distributions	int sp_ret = posix_spawn(&pid, args[0], NULL, NULL, args, NULL);
806*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_ZERO(sp_ret, "spawned process '%s' with PID %d", args[0], pid);
807*a325d9c4SApple OSS Distributions
808*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(child_ready_sem, DISPATCH_TIME_FOREVER);
809*a325d9c4SApple OSS Distributions	uint64_t start_time = mach_absolute_time();
810*a325d9c4SApple OSS Distributions
811*a325d9c4SApple OSS Distributions	struct proc_uniqidentifierinfo proc_info_data = { };
812*a325d9c4SApple OSS Distributions	int retval = proc_pidinfo(getpid(), PROC_PIDUNIQIDENTIFIERINFO, 0, &proc_info_data, sizeof(proc_info_data));
813*a325d9c4SApple OSS Distributions	T_QUIET; T_EXPECT_POSIX_SUCCESS(retval, "proc_pidinfo PROC_PIDUNIQIDENTIFIERINFO");
814*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_EQ_INT(retval, (int) sizeof(proc_info_data), "proc_pidinfo PROC_PIDUNIQIDENTIFIERINFO returned data");
815*a325d9c4SApple OSS Distributions	uint64_t unique_pid = proc_info_data.p_uniqueid;
816*a325d9c4SApple OSS Distributions
817*a325d9c4SApple OSS Distributions	T_LOG("received signal from pre-exec child, unique_pid is %llu, timestamp is %llu", unique_pid, start_time);
818*a325d9c4SApple OSS Distributions
819*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_SUCCESS(kill(pid, SIGUSR1), "signaled pre-exec child to exec");
820*a325d9c4SApple OSS Distributions
821*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(child_ready_sem, DISPATCH_TIME_FOREVER);
822*a325d9c4SApple OSS Distributions
823*a325d9c4SApple OSS Distributions	T_LOG("received signal from post-exec child, capturing stackshot");
824*a325d9c4SApple OSS Distributions
825*a325d9c4SApple OSS Distributions	struct scenario scenario = {
826*a325d9c4SApple OSS Distributions		.name = "exec",
827*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_GET_GLOBAL_MEM_STATS
828*a325d9c4SApple OSS Distributions				  | STACKSHOT_SAVE_IMP_DONATION_PIDS | STACKSHOT_KCDATA_FORMAT
829*a325d9c4SApple OSS Distributions				  | STACKSHOT_COLLECT_DELTA_SNAPSHOT),
830*a325d9c4SApple OSS Distributions		.since_timestamp = start_time
831*a325d9c4SApple OSS Distributions	};
832*a325d9c4SApple OSS Distributions
833*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, false, ^( void *ssbuf, size_t sslen) {
834*a325d9c4SApple OSS Distributions		// Kill the child
835*a325d9c4SApple OSS Distributions		int status;
836*a325d9c4SApple OSS Distributions		T_ASSERT_POSIX_SUCCESS(kill(pid, SIGKILL), "kill post-exec child %d", pid);
837*a325d9c4SApple OSS Distributions		T_ASSERT_POSIX_SUCCESS(waitpid(pid, &status, 0), "waitpid on post-exec child");
838*a325d9c4SApple OSS Distributions
839*a325d9c4SApple OSS Distributions		parse_stackshot(PARSE_STACKSHOT_POSTEXEC | PARSE_STACKSHOT_DELTA, ssbuf, sslen, @{postexec_child_unique_pid_key: @(unique_pid)});
840*a325d9c4SApple OSS Distributions	});
841*a325d9c4SApple OSS Distributions}
842*a325d9c4SApple OSS Distributions
843*a325d9c4SApple OSS DistributionsT_DECL(exec_inprogress, "test stackshots of processes in the middle of exec")
844*a325d9c4SApple OSS Distributions{
845*a325d9c4SApple OSS Distributions	pid_t pid;
846*a325d9c4SApple OSS Distributions	/* a BASH quine which execs itself as long as the parent doesn't exit */
847*a325d9c4SApple OSS Distributions        char *bash_prog = "[[ $PPID -ne 1 ]] && exec /bin/bash -c \"$0\" \"$0\"";
848*a325d9c4SApple OSS Distributions	char *args[] = { "/bin/bash", "-c", bash_prog, bash_prog, NULL };
849*a325d9c4SApple OSS Distributions
850*a325d9c4SApple OSS Distributions	posix_spawnattr_t sattr;
851*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_ZERO(posix_spawnattr_init(&sattr), "posix_spawnattr_init");
852*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_ZERO(posix_spawn(&pid, args[0], NULL, &sattr, args, NULL), "spawn exec_inprogress_child");
853*a325d9c4SApple OSS Distributions
854*a325d9c4SApple OSS Distributions	struct scenario scenario = {
855*a325d9c4SApple OSS Distributions		.name = "exec_inprogress",
856*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_KCDATA_FORMAT),
857*a325d9c4SApple OSS Distributions		.target_pid = pid,
858*a325d9c4SApple OSS Distributions	};
859*a325d9c4SApple OSS Distributions
860*a325d9c4SApple OSS Distributions	int tries = 0;
861*a325d9c4SApple OSS Distributions	int tries_limit = 30;
862*a325d9c4SApple OSS Distributions	__block bool found = false;
863*a325d9c4SApple OSS Distributions	__block uint64_t cid1 = 0, cid2 = 0;
864*a325d9c4SApple OSS Distributions
865*a325d9c4SApple OSS Distributions	for (tries = 0; !found && tries < tries_limit; tries++) {
866*a325d9c4SApple OSS Distributions		take_stackshot(&scenario, false,
867*a325d9c4SApple OSS Distributions		    ^( void *ssbuf, size_t sslen) {
868*a325d9c4SApple OSS Distributions			parse_stackshot(PARSE_STACKSHOT_EXEC_INPROGRESS,
869*a325d9c4SApple OSS Distributions			    ssbuf, sslen, @{
870*a325d9c4SApple OSS Distributions				exec_inprogress_pid_key: @(pid),
871*a325d9c4SApple OSS Distributions				exec_inprogress_found_key: ^(uint64_t id1, uint64_t id2) { found = true; cid1 = id1; cid2 = id2; }});
872*a325d9c4SApple OSS Distributions		});
873*a325d9c4SApple OSS Distributions	}
874*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_SUCCESS(kill(pid, SIGKILL), "killing exec loop");
875*a325d9c4SApple OSS Distributions	T_ASSERT_TRUE(found, "able to find our execing process mid-exec in %d tries", tries);
876*a325d9c4SApple OSS Distributions	T_ASSERT_NE(cid1, cid2, "container IDs for in-progress exec are unique");
877*a325d9c4SApple OSS Distributions	T_PASS("found mid-exec process in %d tries", tries);
878*a325d9c4SApple OSS Distributions}
879*a325d9c4SApple OSS Distributions
880*a325d9c4SApple OSS Distributions#ifdef _LP64
881*a325d9c4SApple OSS Distributions#if __has_feature(ptrauth_calls)
882*a325d9c4SApple OSS Distributions#define __ptrauth_swift_async_context_parent \
883*a325d9c4SApple OSS Distributions  __ptrauth(ptrauth_key_process_independent_data, 1, 0xbda2)
884*a325d9c4SApple OSS Distributions#define __ptrauth_swift_async_context_resume \
885*a325d9c4SApple OSS Distributions  __ptrauth(ptrauth_key_function_pointer, 1, 0xd707)
886*a325d9c4SApple OSS Distributions#else
887*a325d9c4SApple OSS Distributions#define __ptrauth_swift_async_context_parent
888*a325d9c4SApple OSS Distributions#define __ptrauth_swift_async_context_resume
889*a325d9c4SApple OSS Distributions#endif
890*a325d9c4SApple OSS Distributions// Add 1 to match the symbolication aid added by the stackshot backtracer.
891*a325d9c4SApple OSS Distributions#define asyncstack_frame(x) ((uintptr_t)(void *)ptrauth_strip((void *)(x), ptrauth_key_function_pointer) + 1)
892*a325d9c4SApple OSS Distributions
893*a325d9c4SApple OSS Distributions// This struct fakes the Swift AsyncContext struct which is used by
894*a325d9c4SApple OSS Distributions// the Swift concurrency runtime. We only care about the first 2 fields.
895*a325d9c4SApple OSS Distributionsstruct fake_async_context {
896*a325d9c4SApple OSS Distributions	struct fake_async_context* __ptrauth_swift_async_context_parent next;
897*a325d9c4SApple OSS Distributions	void(*__ptrauth_swift_async_context_resume resume_pc)(void);
898*a325d9c4SApple OSS Distributions};
899*a325d9c4SApple OSS Distributions
900*a325d9c4SApple OSS Distributionsstatic void
901*a325d9c4SApple OSS Distributionslevel1_func()
902*a325d9c4SApple OSS Distributions{
903*a325d9c4SApple OSS Distributions}
904*a325d9c4SApple OSS Distributionsstatic void
905*a325d9c4SApple OSS Distributionslevel2_func()
906*a325d9c4SApple OSS Distributions{
907*a325d9c4SApple OSS Distributions}
908*a325d9c4SApple OSS Distributions
909*a325d9c4SApple OSS Distributions// Create a chain of fake async contexts; sync with asyncstack_expected_stack below
910*a325d9c4SApple OSS Distributionsstatic alignas(16) struct fake_async_context level1 = { 0, level1_func };
911*a325d9c4SApple OSS Distributionsstatic alignas(16) struct fake_async_context level2 = { &level1, level2_func };
912*a325d9c4SApple OSS Distributions
913*a325d9c4SApple OSS Distributionsstruct async_test_semaphores {
914*a325d9c4SApple OSS Distributions	dispatch_semaphore_t child_ready_sem;	/* signal parent we're ready */
915*a325d9c4SApple OSS Distributions	dispatch_semaphore_t child_exit_sem;	/* parent tells us to go away */
916*a325d9c4SApple OSS Distributions};
917*a325d9c4SApple OSS Distributions
918*a325d9c4SApple OSS Distributions#define	ASYNCSTACK_THREAD_NAME "asyncstack_thread"
919*a325d9c4SApple OSS Distributions
920*a325d9c4SApple OSS Distributionsstatic void __attribute__((noinline, not_tail_called))
921*a325d9c4SApple OSS Distributionsexpect_asyncstack(void *arg)
922*a325d9c4SApple OSS Distributions{
923*a325d9c4SApple OSS Distributions	struct async_test_semaphores *async_ts = arg;
924*a325d9c4SApple OSS Distributions
925*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_ZERO(pthread_setname_np(ASYNCSTACK_THREAD_NAME),
926*a325d9c4SApple OSS Distributions	     "set thread name to %s", ASYNCSTACK_THREAD_NAME);
927*a325d9c4SApple OSS Distributions
928*a325d9c4SApple OSS Distributions	/* Tell the main thread we're all set up, then wait for permission to exit */
929*a325d9c4SApple OSS Distributions	dispatch_semaphore_signal(async_ts->child_ready_sem);
930*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(async_ts->child_exit_sem, DISPATCH_TIME_FOREVER);
931*a325d9c4SApple OSS Distributions	usleep(1);	/* make sure we don't tailcall semaphore_wait */
932*a325d9c4SApple OSS Distributions}
933*a325d9c4SApple OSS Distributions
934*a325d9c4SApple OSS Distributionsstatic void *
935*a325d9c4SApple OSS Distributionsasyncstack_thread(void *arg)
936*a325d9c4SApple OSS Distributions{
937*a325d9c4SApple OSS Distributions	uint64_t *fp = __builtin_frame_address(0);
938*a325d9c4SApple OSS Distributions	// We cannot use a variable of pointer type, because this ABI is valid
939*a325d9c4SApple OSS Distributions	// on arm64_32 where pointers are 32bits, but the context pointer will
940*a325d9c4SApple OSS Distributions	// still be stored in a 64bits slot on the stack.
941*a325d9c4SApple OSS Distributions#if __has_feature(ptrauth_calls)
942*a325d9c4SApple OSS Distributions#define __stack_context_auth __ptrauth(ptrauth_key_process_dependent_data, 1, \
943*a325d9c4SApple OSS Distributions	        0xc31a)
944*a325d9c4SApple OSS Distributions	struct fake_async_context * __stack_context_auth ctx = &level2;
945*a325d9c4SApple OSS Distributions#else // __has_feature(ptrauth_calls)
946*a325d9c4SApple OSS Distributions	/* struct fake_async_context * */uint64_t ctx  = (uintptr_t)&level2;
947*a325d9c4SApple OSS Distributions#endif // !__has_feature(ptrauth_calls)
948*a325d9c4SApple OSS Distributions
949*a325d9c4SApple OSS Distributions	// The signature of an async frame on the OS stack is:
950*a325d9c4SApple OSS Distributions	// [ <AsyncContext address>, <Saved FP | (1<<60)>, <return address> ]
951*a325d9c4SApple OSS Distributions	// The Async context must be right before the saved FP on the stack. This
952*a325d9c4SApple OSS Distributions	// should happen naturally in an optimized build as it is the only
953*a325d9c4SApple OSS Distributions	// variable on the stack.
954*a325d9c4SApple OSS Distributions	// This function cannot use T_ASSERT_* becuse it changes the stack
955*a325d9c4SApple OSS Distributions	// layout.
956*a325d9c4SApple OSS Distributions	assert((uintptr_t)fp - (uintptr_t)&ctx == 8);
957*a325d9c4SApple OSS Distributions
958*a325d9c4SApple OSS Distributions	// Modify the saved FP on the stack to include the async frame marker
959*a325d9c4SApple OSS Distributions	*fp |= (0x1ULL << 60);
960*a325d9c4SApple OSS Distributions	expect_asyncstack(arg);
961*a325d9c4SApple OSS Distributions	return NULL;
962*a325d9c4SApple OSS Distributions}
963*a325d9c4SApple OSS Distributions
964*a325d9c4SApple OSS DistributionsT_DECL(asyncstack, "test swift async stack entries")
965*a325d9c4SApple OSS Distributions{
966*a325d9c4SApple OSS Distributions	struct scenario scenario = {
967*a325d9c4SApple OSS Distributions		.name = "asyncstack",
968*a325d9c4SApple OSS Distributions		.flags = STACKSHOT_KCDATA_FORMAT | STACKSHOT_SAVE_LOADINFO,
969*a325d9c4SApple OSS Distributions	};
970*a325d9c4SApple OSS Distributions	struct async_test_semaphores async_ts = {
971*a325d9c4SApple OSS Distributions	    .child_ready_sem = dispatch_semaphore_create(0),
972*a325d9c4SApple OSS Distributions	    .child_exit_sem = dispatch_semaphore_create(0),
973*a325d9c4SApple OSS Distributions	};
974*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(async_ts.child_ready_sem, "child_ready_sem alloc");
975*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(async_ts.child_exit_sem, "child_exit_sem alloc");
976*a325d9c4SApple OSS Distributions
977*a325d9c4SApple OSS Distributions	pthread_t pthread;
978*a325d9c4SApple OSS Distributions	__block uint64_t threadid = 0;
979*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_ZERO(pthread_create(&pthread, NULL, asyncstack_thread, &async_ts), "pthread_create");
980*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_ZERO(pthread_threadid_np(pthread, &threadid), "pthread_threadid_np");
981*a325d9c4SApple OSS Distributions
982*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(async_ts.child_ready_sem, DISPATCH_TIME_FOREVER);
983*a325d9c4SApple OSS Distributions
984*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, true, ^( void *ssbuf, size_t sslen) {
985*a325d9c4SApple OSS Distributions		parse_stackshot(PARSE_STACKSHOT_ASYNCSTACK, ssbuf, sslen, @{
986*a325d9c4SApple OSS Distributions		    asyncstack_expected_threadid_key: @(threadid),
987*a325d9c4SApple OSS Distributions		       asyncstack_expected_stack_key: @[ @(asyncstack_frame(level2_func)), @(asyncstack_frame(level1_func)) ],
988*a325d9c4SApple OSS Distributions		});
989*a325d9c4SApple OSS Distributions	});
990*a325d9c4SApple OSS Distributions
991*a325d9c4SApple OSS Distributions	dispatch_semaphore_signal(async_ts.child_exit_sem);
992*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_ZERO(pthread_join(pthread, NULL), "wait for thread");
993*a325d9c4SApple OSS Distributions
994*a325d9c4SApple OSS Distributions}
995*a325d9c4SApple OSS Distributions#endif
996*a325d9c4SApple OSS Distributions
997*a325d9c4SApple OSS Distributionsstatic uint32_t
998*a325d9c4SApple OSS Distributionsget_user_promotion_basepri(void)
999*a325d9c4SApple OSS Distributions{
1000*a325d9c4SApple OSS Distributions	mach_msg_type_number_t count = THREAD_POLICY_STATE_COUNT;
1001*a325d9c4SApple OSS Distributions	struct thread_policy_state thread_policy;
1002*a325d9c4SApple OSS Distributions	boolean_t get_default = FALSE;
1003*a325d9c4SApple OSS Distributions	mach_port_t thread_port = pthread_mach_thread_np(pthread_self());
1004*a325d9c4SApple OSS Distributions
1005*a325d9c4SApple OSS Distributions	kern_return_t kr = thread_policy_get(thread_port, THREAD_POLICY_STATE,
1006*a325d9c4SApple OSS Distributions	    (thread_policy_t)&thread_policy, &count, &get_default);
1007*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "thread_policy_get");
1008*a325d9c4SApple OSS Distributions	return thread_policy.thps_user_promotion_basepri;
1009*a325d9c4SApple OSS Distributions}
1010*a325d9c4SApple OSS Distributions
1011*a325d9c4SApple OSS Distributionsstatic int
1012*a325d9c4SApple OSS Distributionsget_pri(thread_t thread_port)
1013*a325d9c4SApple OSS Distributions{
1014*a325d9c4SApple OSS Distributions	kern_return_t kr;
1015*a325d9c4SApple OSS Distributions
1016*a325d9c4SApple OSS Distributions	thread_extended_info_data_t extended_info;
1017*a325d9c4SApple OSS Distributions	mach_msg_type_number_t count = THREAD_EXTENDED_INFO_COUNT;
1018*a325d9c4SApple OSS Distributions	kr = thread_info(thread_port, THREAD_EXTENDED_INFO,
1019*a325d9c4SApple OSS Distributions	    (thread_info_t)&extended_info, &count);
1020*a325d9c4SApple OSS Distributions
1021*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "thread_info");
1022*a325d9c4SApple OSS Distributions
1023*a325d9c4SApple OSS Distributions	return extended_info.pth_curpri;
1024*a325d9c4SApple OSS Distributions}
1025*a325d9c4SApple OSS Distributions
1026*a325d9c4SApple OSS Distributions
1027*a325d9c4SApple OSS DistributionsT_DECL(turnstile_singlehop, "turnstile single hop test")
1028*a325d9c4SApple OSS Distributions{
1029*a325d9c4SApple OSS Distributions	dispatch_queue_t dq1, dq2;
1030*a325d9c4SApple OSS Distributions	dispatch_semaphore_t sema_x;
1031*a325d9c4SApple OSS Distributions	dispatch_queue_attr_t dq1_attr, dq2_attr;
1032*a325d9c4SApple OSS Distributions	__block qos_class_t main_qos = 0;
1033*a325d9c4SApple OSS Distributions	__block int main_relpri = 0, main_relpri2 = 0, main_afterpri = 0;
1034*a325d9c4SApple OSS Distributions	struct scenario scenario = {
1035*a325d9c4SApple OSS Distributions		.name = "turnstile_singlehop",
1036*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_THREAD_WAITINFO | STACKSHOT_KCDATA_FORMAT),
1037*a325d9c4SApple OSS Distributions	};
1038*a325d9c4SApple OSS Distributions	dq1_attr = dispatch_queue_attr_make_with_qos_class(DISPATCH_QUEUE_SERIAL, QOS_CLASS_UTILITY, 0);
1039*a325d9c4SApple OSS Distributions	dq2_attr = dispatch_queue_attr_make_with_qos_class(DISPATCH_QUEUE_SERIAL, QOS_CLASS_USER_INITIATED, 0);
1040*a325d9c4SApple OSS Distributions	pthread_mutex_t lock_a = PTHREAD_MUTEX_INITIALIZER;
1041*a325d9c4SApple OSS Distributions	pthread_mutex_t lock_b = PTHREAD_MUTEX_INITIALIZER;
1042*a325d9c4SApple OSS Distributions
1043*a325d9c4SApple OSS Distributions	pthread_mutex_t *lockap = &lock_a, *lockbp = &lock_b;
1044*a325d9c4SApple OSS Distributions
1045*a325d9c4SApple OSS Distributions	dq1 = dispatch_queue_create("q1", dq1_attr);
1046*a325d9c4SApple OSS Distributions	dq2 = dispatch_queue_create("q2", dq2_attr);
1047*a325d9c4SApple OSS Distributions	sema_x = dispatch_semaphore_create(0);
1048*a325d9c4SApple OSS Distributions
1049*a325d9c4SApple OSS Distributions	pthread_mutex_lock(lockap);
1050*a325d9c4SApple OSS Distributions	dispatch_async(dq1, ^{
1051*a325d9c4SApple OSS Distributions		pthread_mutex_lock(lockbp);
1052*a325d9c4SApple OSS Distributions		T_ASSERT_POSIX_SUCCESS(pthread_get_qos_class_np(pthread_self(), &main_qos, &main_relpri), "get qos class");
1053*a325d9c4SApple OSS Distributions		T_LOG("The priority of q1 is %d\n", get_pri(mach_thread_self()));
1054*a325d9c4SApple OSS Distributions		dispatch_semaphore_signal(sema_x);
1055*a325d9c4SApple OSS Distributions		pthread_mutex_lock(lockap);
1056*a325d9c4SApple OSS Distributions	});
1057*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(sema_x, DISPATCH_TIME_FOREVER);
1058*a325d9c4SApple OSS Distributions
1059*a325d9c4SApple OSS Distributions	T_LOG("Async1 completed");
1060*a325d9c4SApple OSS Distributions
1061*a325d9c4SApple OSS Distributions	pthread_set_qos_class_self_np(QOS_CLASS_UTILITY, 0);
1062*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_SUCCESS(pthread_get_qos_class_np(pthread_self(), &main_qos, &main_relpri), "get qos class");
1063*a325d9c4SApple OSS Distributions	T_LOG("The priority of main is %d\n", get_pri(mach_thread_self()));
1064*a325d9c4SApple OSS Distributions	main_relpri = get_pri(mach_thread_self());
1065*a325d9c4SApple OSS Distributions
1066*a325d9c4SApple OSS Distributions	dispatch_async(dq2, ^{
1067*a325d9c4SApple OSS Distributions		T_ASSERT_POSIX_SUCCESS(pthread_get_qos_class_np(pthread_self(), &main_qos, &main_relpri2), "get qos class");
1068*a325d9c4SApple OSS Distributions		T_LOG("The priority of q2 is %d\n", get_pri(mach_thread_self()));
1069*a325d9c4SApple OSS Distributions		dispatch_semaphore_signal(sema_x);
1070*a325d9c4SApple OSS Distributions		pthread_mutex_lock(lockbp);
1071*a325d9c4SApple OSS Distributions	});
1072*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(sema_x, DISPATCH_TIME_FOREVER);
1073*a325d9c4SApple OSS Distributions
1074*a325d9c4SApple OSS Distributions	T_LOG("Async2 completed");
1075*a325d9c4SApple OSS Distributions
1076*a325d9c4SApple OSS Distributions	while (1) {
1077*a325d9c4SApple OSS Distributions		main_afterpri = (int) get_user_promotion_basepri();
1078*a325d9c4SApple OSS Distributions		if (main_relpri != main_afterpri) {
1079*a325d9c4SApple OSS Distributions			T_LOG("Success with promotion pri is %d", main_afterpri);
1080*a325d9c4SApple OSS Distributions			break;
1081*a325d9c4SApple OSS Distributions		}
1082*a325d9c4SApple OSS Distributions
1083*a325d9c4SApple OSS Distributions		usleep(100);
1084*a325d9c4SApple OSS Distributions	}
1085*a325d9c4SApple OSS Distributions
1086*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, true, ^( void *ssbuf, size_t sslen) {
1087*a325d9c4SApple OSS Distributions		parse_stackshot(PARSE_STACKSHOT_TURNSTILEINFO, ssbuf, sslen, nil);
1088*a325d9c4SApple OSS Distributions	});
1089*a325d9c4SApple OSS Distributions}
1090*a325d9c4SApple OSS Distributions
1091*a325d9c4SApple OSS Distributions
1092*a325d9c4SApple OSS Distributionsstatic void
1093*a325d9c4SApple OSS Distributionsexpect_instrs_cycles_in_stackshot(void *ssbuf, size_t sslen)
1094*a325d9c4SApple OSS Distributions{
1095*a325d9c4SApple OSS Distributions	kcdata_iter_t iter = kcdata_iter(ssbuf, sslen);
1096*a325d9c4SApple OSS Distributions
1097*a325d9c4SApple OSS Distributions	bool in_task = false;
1098*a325d9c4SApple OSS Distributions	bool in_thread = false;
1099*a325d9c4SApple OSS Distributions	bool saw_instrs_cycles = false;
1100*a325d9c4SApple OSS Distributions	iter = kcdata_iter_next(iter);
1101*a325d9c4SApple OSS Distributions
1102*a325d9c4SApple OSS Distributions	KCDATA_ITER_FOREACH(iter) {
1103*a325d9c4SApple OSS Distributions		switch (kcdata_iter_type(iter)) {
1104*a325d9c4SApple OSS Distributions		case KCDATA_TYPE_CONTAINER_BEGIN:
1105*a325d9c4SApple OSS Distributions			switch (kcdata_iter_container_type(iter)) {
1106*a325d9c4SApple OSS Distributions			case STACKSHOT_KCCONTAINER_TASK:
1107*a325d9c4SApple OSS Distributions				in_task = true;
1108*a325d9c4SApple OSS Distributions				saw_instrs_cycles = false;
1109*a325d9c4SApple OSS Distributions				break;
1110*a325d9c4SApple OSS Distributions
1111*a325d9c4SApple OSS Distributions			case STACKSHOT_KCCONTAINER_THREAD:
1112*a325d9c4SApple OSS Distributions				in_thread = true;
1113*a325d9c4SApple OSS Distributions				saw_instrs_cycles = false;
1114*a325d9c4SApple OSS Distributions				break;
1115*a325d9c4SApple OSS Distributions
1116*a325d9c4SApple OSS Distributions			default:
1117*a325d9c4SApple OSS Distributions				break;
1118*a325d9c4SApple OSS Distributions			}
1119*a325d9c4SApple OSS Distributions			break;
1120*a325d9c4SApple OSS Distributions
1121*a325d9c4SApple OSS Distributions		case STACKSHOT_KCTYPE_INSTRS_CYCLES:
1122*a325d9c4SApple OSS Distributions			saw_instrs_cycles = true;
1123*a325d9c4SApple OSS Distributions			break;
1124*a325d9c4SApple OSS Distributions
1125*a325d9c4SApple OSS Distributions		case KCDATA_TYPE_CONTAINER_END:
1126*a325d9c4SApple OSS Distributions			if (in_thread) {
1127*a325d9c4SApple OSS Distributions				T_QUIET; T_EXPECT_TRUE(saw_instrs_cycles,
1128*a325d9c4SApple OSS Distributions						"saw instructions and cycles in thread");
1129*a325d9c4SApple OSS Distributions				in_thread = false;
1130*a325d9c4SApple OSS Distributions			} else if (in_task) {
1131*a325d9c4SApple OSS Distributions				T_QUIET; T_EXPECT_TRUE(saw_instrs_cycles,
1132*a325d9c4SApple OSS Distributions						"saw instructions and cycles in task");
1133*a325d9c4SApple OSS Distributions				in_task = false;
1134*a325d9c4SApple OSS Distributions			}
1135*a325d9c4SApple OSS Distributions
1136*a325d9c4SApple OSS Distributions		default:
1137*a325d9c4SApple OSS Distributions			break;
1138*a325d9c4SApple OSS Distributions		}
1139*a325d9c4SApple OSS Distributions	}
1140*a325d9c4SApple OSS Distributions}
1141*a325d9c4SApple OSS Distributions
1142*a325d9c4SApple OSS Distributionsstatic void
1143*a325d9c4SApple OSS Distributionsskip_if_monotonic_unsupported(void)
1144*a325d9c4SApple OSS Distributions{
1145*a325d9c4SApple OSS Distributions	int supported = 0;
1146*a325d9c4SApple OSS Distributions	size_t supported_size = sizeof(supported);
1147*a325d9c4SApple OSS Distributions	int ret = sysctlbyname("kern.monotonic.supported", &supported,
1148*a325d9c4SApple OSS Distributions			&supported_size, 0, 0);
1149*a325d9c4SApple OSS Distributions	if (ret < 0 || !supported) {
1150*a325d9c4SApple OSS Distributions		T_SKIP("monotonic is unsupported");
1151*a325d9c4SApple OSS Distributions	}
1152*a325d9c4SApple OSS Distributions}
1153*a325d9c4SApple OSS Distributions
1154*a325d9c4SApple OSS DistributionsT_DECL(instrs_cycles, "test a getting instructions and cycles in stackshot")
1155*a325d9c4SApple OSS Distributions{
1156*a325d9c4SApple OSS Distributions	skip_if_monotonic_unsupported();
1157*a325d9c4SApple OSS Distributions
1158*a325d9c4SApple OSS Distributions	struct scenario scenario = {
1159*a325d9c4SApple OSS Distributions		.name = "instrs-cycles",
1160*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_INSTRS_CYCLES
1161*a325d9c4SApple OSS Distributions				| STACKSHOT_KCDATA_FORMAT),
1162*a325d9c4SApple OSS Distributions	};
1163*a325d9c4SApple OSS Distributions
1164*a325d9c4SApple OSS Distributions	T_LOG("attempting to take stackshot with instructions and cycles");
1165*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, false, ^(void *ssbuf, size_t sslen) {
1166*a325d9c4SApple OSS Distributions		parse_stackshot(0, ssbuf, sslen, nil);
1167*a325d9c4SApple OSS Distributions		expect_instrs_cycles_in_stackshot(ssbuf, sslen);
1168*a325d9c4SApple OSS Distributions	});
1169*a325d9c4SApple OSS Distributions}
1170*a325d9c4SApple OSS Distributions
1171*a325d9c4SApple OSS DistributionsT_DECL(delta_instrs_cycles,
1172*a325d9c4SApple OSS Distributions		"test delta stackshots with instructions and cycles")
1173*a325d9c4SApple OSS Distributions{
1174*a325d9c4SApple OSS Distributions	skip_if_monotonic_unsupported();
1175*a325d9c4SApple OSS Distributions
1176*a325d9c4SApple OSS Distributions	struct scenario scenario = {
1177*a325d9c4SApple OSS Distributions		.name = "delta-instrs-cycles",
1178*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_INSTRS_CYCLES
1179*a325d9c4SApple OSS Distributions				| STACKSHOT_KCDATA_FORMAT),
1180*a325d9c4SApple OSS Distributions	};
1181*a325d9c4SApple OSS Distributions
1182*a325d9c4SApple OSS Distributions	T_LOG("taking full stackshot");
1183*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, false, ^(void *ssbuf, size_t sslen) {
1184*a325d9c4SApple OSS Distributions		uint64_t stackshot_time = stackshot_timestamp(ssbuf, sslen);
1185*a325d9c4SApple OSS Distributions
1186*a325d9c4SApple OSS Distributions		T_LOG("taking delta stackshot since time %" PRIu64, stackshot_time);
1187*a325d9c4SApple OSS Distributions
1188*a325d9c4SApple OSS Distributions		parse_stackshot(0, ssbuf, sslen, nil);
1189*a325d9c4SApple OSS Distributions		expect_instrs_cycles_in_stackshot(ssbuf, sslen);
1190*a325d9c4SApple OSS Distributions
1191*a325d9c4SApple OSS Distributions		struct scenario delta_scenario = {
1192*a325d9c4SApple OSS Distributions			.name = "delta-instrs-cycles-next",
1193*a325d9c4SApple OSS Distributions			.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_INSTRS_CYCLES
1194*a325d9c4SApple OSS Distributions					| STACKSHOT_KCDATA_FORMAT
1195*a325d9c4SApple OSS Distributions					| STACKSHOT_COLLECT_DELTA_SNAPSHOT),
1196*a325d9c4SApple OSS Distributions			.since_timestamp = stackshot_time,
1197*a325d9c4SApple OSS Distributions		};
1198*a325d9c4SApple OSS Distributions
1199*a325d9c4SApple OSS Distributions		take_stackshot(&delta_scenario, false, ^(void *dssbuf, size_t dsslen) {
1200*a325d9c4SApple OSS Distributions			parse_stackshot(PARSE_STACKSHOT_DELTA, dssbuf, dsslen, nil);
1201*a325d9c4SApple OSS Distributions			expect_instrs_cycles_in_stackshot(dssbuf, dsslen);
1202*a325d9c4SApple OSS Distributions		});
1203*a325d9c4SApple OSS Distributions	});
1204*a325d9c4SApple OSS Distributions}
1205*a325d9c4SApple OSS Distributions
1206*a325d9c4SApple OSS Distributionsstatic void
1207*a325d9c4SApple OSS Distributionscheck_thread_groups_supported()
1208*a325d9c4SApple OSS Distributions{
1209*a325d9c4SApple OSS Distributions	int err;
1210*a325d9c4SApple OSS Distributions	int supported = 0;
1211*a325d9c4SApple OSS Distributions	size_t supported_size = sizeof(supported);
1212*a325d9c4SApple OSS Distributions	err = sysctlbyname("kern.thread_groups_supported", &supported, &supported_size, NULL, 0);
1213*a325d9c4SApple OSS Distributions
1214*a325d9c4SApple OSS Distributions	if (err || !supported)
1215*a325d9c4SApple OSS Distributions		T_SKIP("thread groups not supported on this system");
1216*a325d9c4SApple OSS Distributions}
1217*a325d9c4SApple OSS Distributions
1218*a325d9c4SApple OSS DistributionsT_DECL(thread_groups, "test getting thread groups in stackshot")
1219*a325d9c4SApple OSS Distributions{
1220*a325d9c4SApple OSS Distributions	check_thread_groups_supported();
1221*a325d9c4SApple OSS Distributions
1222*a325d9c4SApple OSS Distributions	struct scenario scenario = {
1223*a325d9c4SApple OSS Distributions		.name = "thread-groups",
1224*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_THREAD_GROUP
1225*a325d9c4SApple OSS Distributions				| STACKSHOT_KCDATA_FORMAT),
1226*a325d9c4SApple OSS Distributions	};
1227*a325d9c4SApple OSS Distributions
1228*a325d9c4SApple OSS Distributions	T_LOG("attempting to take stackshot with thread group flag");
1229*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, false, ^(void *ssbuf, size_t sslen) {
1230*a325d9c4SApple OSS Distributions		parse_thread_group_stackshot(ssbuf, sslen);
1231*a325d9c4SApple OSS Distributions	});
1232*a325d9c4SApple OSS Distributions}
1233*a325d9c4SApple OSS Distributions
1234*a325d9c4SApple OSS Distributionsstatic void
1235*a325d9c4SApple OSS Distributionsparse_page_table_asid_stackshot(void **ssbuf, size_t sslen)
1236*a325d9c4SApple OSS Distributions{
1237*a325d9c4SApple OSS Distributions	bool seen_asid = false;
1238*a325d9c4SApple OSS Distributions	bool seen_page_table_snapshot = false;
1239*a325d9c4SApple OSS Distributions	kcdata_iter_t iter = kcdata_iter(ssbuf, sslen);
1240*a325d9c4SApple OSS Distributions	T_ASSERT_EQ(kcdata_iter_type(iter), KCDATA_BUFFER_BEGIN_STACKSHOT,
1241*a325d9c4SApple OSS Distributions			"buffer provided is a stackshot");
1242*a325d9c4SApple OSS Distributions
1243*a325d9c4SApple OSS Distributions	iter = kcdata_iter_next(iter);
1244*a325d9c4SApple OSS Distributions	KCDATA_ITER_FOREACH(iter) {
1245*a325d9c4SApple OSS Distributions		switch (kcdata_iter_type(iter)) {
1246*a325d9c4SApple OSS Distributions		case KCDATA_TYPE_ARRAY: {
1247*a325d9c4SApple OSS Distributions			T_QUIET;
1248*a325d9c4SApple OSS Distributions			T_ASSERT_TRUE(kcdata_iter_array_valid(iter),
1249*a325d9c4SApple OSS Distributions					"checked that array is valid");
1250*a325d9c4SApple OSS Distributions
1251*a325d9c4SApple OSS Distributions			if (kcdata_iter_array_elem_type(iter) != STACKSHOT_KCTYPE_PAGE_TABLES) {
1252*a325d9c4SApple OSS Distributions				continue;
1253*a325d9c4SApple OSS Distributions			}
1254*a325d9c4SApple OSS Distributions
1255*a325d9c4SApple OSS Distributions			T_ASSERT_FALSE(seen_page_table_snapshot, "check that we haven't yet seen a page table snapshot");
1256*a325d9c4SApple OSS Distributions			seen_page_table_snapshot = true;
1257*a325d9c4SApple OSS Distributions
1258*a325d9c4SApple OSS Distributions			T_ASSERT_EQ((size_t) kcdata_iter_array_elem_size(iter), sizeof(uint64_t),
1259*a325d9c4SApple OSS Distributions				"check that each element of the pagetable dump is the expected size");
1260*a325d9c4SApple OSS Distributions
1261*a325d9c4SApple OSS Distributions			uint64_t *pt_array = kcdata_iter_payload(iter);
1262*a325d9c4SApple OSS Distributions			uint32_t elem_count = kcdata_iter_array_elem_count(iter);
1263*a325d9c4SApple OSS Distributions			uint32_t j;
1264*a325d9c4SApple OSS Distributions			bool nonzero_tte = false;
1265*a325d9c4SApple OSS Distributions			for (j = 0; j < elem_count;) {
1266*a325d9c4SApple OSS Distributions				T_QUIET; T_ASSERT_LE(j + 4, elem_count, "check for valid page table segment header");
1267*a325d9c4SApple OSS Distributions				uint64_t pa = pt_array[j];
1268*a325d9c4SApple OSS Distributions				uint64_t num_entries = pt_array[j + 1];
1269*a325d9c4SApple OSS Distributions				uint64_t start_va = pt_array[j + 2];
1270*a325d9c4SApple OSS Distributions				uint64_t end_va = pt_array[j + 3];
1271*a325d9c4SApple OSS Distributions
1272*a325d9c4SApple OSS Distributions				T_QUIET; T_ASSERT_NE(pa, (uint64_t) 0, "check that the pagetable physical address is non-zero");
1273*a325d9c4SApple OSS Distributions				T_QUIET; T_ASSERT_EQ(pa % (num_entries * sizeof(uint64_t)), (uint64_t) 0, "check that the pagetable physical address is correctly aligned");
1274*a325d9c4SApple OSS Distributions				T_QUIET; T_ASSERT_NE(num_entries, (uint64_t) 0, "check that a pagetable region has more than 0 entries");
1275*a325d9c4SApple OSS Distributions				T_QUIET; T_ASSERT_LE(j + 4 + num_entries, (uint64_t) elem_count, "check for sufficient space in page table array");
1276*a325d9c4SApple OSS Distributions				T_QUIET; T_ASSERT_GT(end_va, start_va, "check for valid VA bounds in page table segment header");
1277*a325d9c4SApple OSS Distributions
1278*a325d9c4SApple OSS Distributions				for (uint32_t k = j + 4; k < (j + 4 + num_entries); ++k) {
1279*a325d9c4SApple OSS Distributions					if (pt_array[k] != 0) {
1280*a325d9c4SApple OSS Distributions						nonzero_tte = true;
1281*a325d9c4SApple OSS Distributions						T_QUIET; T_ASSERT_EQ((pt_array[k] >> 48) & 0xf, (uint64_t) 0, "check that bits[48:51] of arm64 TTE are clear");
1282*a325d9c4SApple OSS Distributions						// L0-L2 table and non-compressed L3 block entries should always have bit 1 set; assumes L0-L2 blocks will not be used outside the kernel
1283*a325d9c4SApple OSS Distributions						bool table = ((pt_array[k] & 0x2) != 0);
1284*a325d9c4SApple OSS Distributions						if (table) {
1285*a325d9c4SApple OSS Distributions							T_QUIET; T_ASSERT_NE(pt_array[k] & ((1ULL << 48) - 1) & ~((1ULL << 12) - 1), (uint64_t) 0, "check that arm64 TTE physical address is non-zero");
1286*a325d9c4SApple OSS Distributions						} else { // should be a compressed PTE
1287*a325d9c4SApple OSS Distributions							T_QUIET; T_ASSERT_NE(pt_array[k] & 0xC000000000000000ULL, (uint64_t) 0, "check that compressed PTE has at least one of bits [63:62] set");
1288*a325d9c4SApple OSS Distributions							T_QUIET; T_ASSERT_EQ(pt_array[k] & ~0xC000000000000000ULL, (uint64_t) 0, "check that compressed PTE has no other bits besides [63:62] set");
1289*a325d9c4SApple OSS Distributions						}
1290*a325d9c4SApple OSS Distributions					}
1291*a325d9c4SApple OSS Distributions				}
1292*a325d9c4SApple OSS Distributions
1293*a325d9c4SApple OSS Distributions				j += (4 + num_entries);
1294*a325d9c4SApple OSS Distributions			}
1295*a325d9c4SApple OSS Distributions			T_ASSERT_TRUE(nonzero_tte, "check that we saw at least one non-empty TTE");
1296*a325d9c4SApple OSS Distributions			T_ASSERT_EQ(j, elem_count, "check that page table dump size matches extent of last header");
1297*a325d9c4SApple OSS Distributions			break;
1298*a325d9c4SApple OSS Distributions		}
1299*a325d9c4SApple OSS Distributions		case STACKSHOT_KCTYPE_ASID: {
1300*a325d9c4SApple OSS Distributions			T_ASSERT_FALSE(seen_asid, "check that we haven't yet seen an ASID");
1301*a325d9c4SApple OSS Distributions			seen_asid = true;
1302*a325d9c4SApple OSS Distributions		}
1303*a325d9c4SApple OSS Distributions		}
1304*a325d9c4SApple OSS Distributions	}
1305*a325d9c4SApple OSS Distributions	T_ASSERT_TRUE(seen_page_table_snapshot, "check that we have seen a page table snapshot");
1306*a325d9c4SApple OSS Distributions	T_ASSERT_TRUE(seen_asid, "check that we have seen an ASID");
1307*a325d9c4SApple OSS Distributions}
1308*a325d9c4SApple OSS Distributions
1309*a325d9c4SApple OSS DistributionsT_DECL(dump_page_tables, "test stackshot page table dumping support")
1310*a325d9c4SApple OSS Distributions{
1311*a325d9c4SApple OSS Distributions	struct scenario scenario = {
1312*a325d9c4SApple OSS Distributions		.name = "asid-page-tables",
1313*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_KCDATA_FORMAT | STACKSHOT_ASID | STACKSHOT_PAGE_TABLES),
1314*a325d9c4SApple OSS Distributions		.size_hint = (1ULL << 23), // 8 MB
1315*a325d9c4SApple OSS Distributions		.target_pid = getpid(),
1316*a325d9c4SApple OSS Distributions		.maybe_unsupported = true,
1317*a325d9c4SApple OSS Distributions	};
1318*a325d9c4SApple OSS Distributions
1319*a325d9c4SApple OSS Distributions	T_LOG("attempting to take stackshot with ASID and page table flags");
1320*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, false, ^(void *ssbuf, size_t sslen) {
1321*a325d9c4SApple OSS Distributions		parse_page_table_asid_stackshot(ssbuf, sslen);
1322*a325d9c4SApple OSS Distributions	});
1323*a325d9c4SApple OSS Distributions}
1324*a325d9c4SApple OSS Distributions
1325*a325d9c4SApple OSS Distributionsstatic void stackshot_verify_current_proc_uuid_info(void **ssbuf, size_t sslen, uint64_t expected_offset, const struct proc_uniqidentifierinfo *proc_info_data)
1326*a325d9c4SApple OSS Distributions{
1327*a325d9c4SApple OSS Distributions	const uuid_t *current_uuid = (const uuid_t *)(&proc_info_data->p_uuid);
1328*a325d9c4SApple OSS Distributions
1329*a325d9c4SApple OSS Distributions	kcdata_iter_t iter = kcdata_iter(ssbuf, sslen);
1330*a325d9c4SApple OSS Distributions	T_ASSERT_EQ(kcdata_iter_type(iter), KCDATA_BUFFER_BEGIN_STACKSHOT, "buffer provided is a stackshot");
1331*a325d9c4SApple OSS Distributions
1332*a325d9c4SApple OSS Distributions	iter = kcdata_iter_next(iter);
1333*a325d9c4SApple OSS Distributions
1334*a325d9c4SApple OSS Distributions	KCDATA_ITER_FOREACH(iter) {
1335*a325d9c4SApple OSS Distributions		switch (kcdata_iter_type(iter)) {
1336*a325d9c4SApple OSS Distributions			case KCDATA_TYPE_ARRAY: {
1337*a325d9c4SApple OSS Distributions				T_QUIET; T_ASSERT_TRUE(kcdata_iter_array_valid(iter), "checked that array is valid");
1338*a325d9c4SApple OSS Distributions				if (kcdata_iter_array_elem_type(iter) == KCDATA_TYPE_LIBRARY_LOADINFO64) {
1339*a325d9c4SApple OSS Distributions					struct user64_dyld_uuid_info *info = (struct user64_dyld_uuid_info *) kcdata_iter_payload(iter);
1340*a325d9c4SApple OSS Distributions					if (uuid_compare(*current_uuid, info->imageUUID) == 0) {
1341*a325d9c4SApple OSS Distributions						T_ASSERT_EQ(expected_offset, info->imageLoadAddress, "found matching UUID with matching binary offset");
1342*a325d9c4SApple OSS Distributions						return;
1343*a325d9c4SApple OSS Distributions					}
1344*a325d9c4SApple OSS Distributions				} else if (kcdata_iter_array_elem_type(iter) == KCDATA_TYPE_LIBRARY_LOADINFO) {
1345*a325d9c4SApple OSS Distributions					struct user32_dyld_uuid_info *info = (struct user32_dyld_uuid_info *) kcdata_iter_payload(iter);
1346*a325d9c4SApple OSS Distributions					if (uuid_compare(*current_uuid, info->imageUUID) == 0) {
1347*a325d9c4SApple OSS Distributions						T_ASSERT_EQ(expected_offset, ((uint64_t) info->imageLoadAddress),  "found matching UUID with matching binary offset");
1348*a325d9c4SApple OSS Distributions						return;
1349*a325d9c4SApple OSS Distributions					}
1350*a325d9c4SApple OSS Distributions				}
1351*a325d9c4SApple OSS Distributions				break;
1352*a325d9c4SApple OSS Distributions			}
1353*a325d9c4SApple OSS Distributions			default:
1354*a325d9c4SApple OSS Distributions				break;
1355*a325d9c4SApple OSS Distributions		}
1356*a325d9c4SApple OSS Distributions	}
1357*a325d9c4SApple OSS Distributions
1358*a325d9c4SApple OSS Distributions	T_FAIL("failed to find matching UUID in stackshot data");
1359*a325d9c4SApple OSS Distributions}
1360*a325d9c4SApple OSS Distributions
1361*a325d9c4SApple OSS DistributionsT_DECL(translated, "tests translated bit is set correctly")
1362*a325d9c4SApple OSS Distributions{
1363*a325d9c4SApple OSS Distributions#if !(TARGET_OS_OSX && TARGET_CPU_ARM64)
1364*a325d9c4SApple OSS Distributions	T_SKIP("Only valid on Apple silicon Macs")
1365*a325d9c4SApple OSS Distributions#endif
1366*a325d9c4SApple OSS Distributions	// Get path of stackshot_translated_child helper binary
1367*a325d9c4SApple OSS Distributions	char path[PATH_MAX];
1368*a325d9c4SApple OSS Distributions	uint32_t path_size = sizeof(path);
1369*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_ZERO(_NSGetExecutablePath(path, &path_size), "_NSGetExecutablePath");
1370*a325d9c4SApple OSS Distributions	char* binary_name = strrchr(path, '/');
1371*a325d9c4SApple OSS Distributions	if (binary_name) binary_name++;
1372*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(binary_name, "Find basename in path '%s'", path);
1373*a325d9c4SApple OSS Distributions	strlcpy(binary_name, "stackshot_translated_child", path_size - (binary_name - path));
1374*a325d9c4SApple OSS Distributions	char *args[] = { path, NULL };
1375*a325d9c4SApple OSS Distributions
1376*a325d9c4SApple OSS Distributions	dispatch_source_t child_sig_src;
1377*a325d9c4SApple OSS Distributions	dispatch_semaphore_t child_ready_sem = dispatch_semaphore_create(0);
1378*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(child_ready_sem, "exec child semaphore");
1379*a325d9c4SApple OSS Distributions
1380*a325d9c4SApple OSS Distributions	dispatch_queue_t signal_processing_q = dispatch_queue_create("signal processing queue", NULL);
1381*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(signal_processing_q, "signal processing queue");
1382*a325d9c4SApple OSS Distributions
1383*a325d9c4SApple OSS Distributions	signal(SIGUSR1, SIG_IGN);
1384*a325d9c4SApple OSS Distributions	child_sig_src = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGUSR1, 0, signal_processing_q);
1385*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_NOTNULL(child_sig_src, "dispatch_source_create (child_sig_src)");
1386*a325d9c4SApple OSS Distributions
1387*a325d9c4SApple OSS Distributions	dispatch_source_set_event_handler(child_sig_src, ^{ dispatch_semaphore_signal(child_ready_sem); });
1388*a325d9c4SApple OSS Distributions	dispatch_activate(child_sig_src);
1389*a325d9c4SApple OSS Distributions
1390*a325d9c4SApple OSS Distributions	// Spawn child
1391*a325d9c4SApple OSS Distributions	pid_t pid;
1392*a325d9c4SApple OSS Distributions	T_LOG("spawning translated child");
1393*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_ZERO(posix_spawn(&pid, args[0], NULL, NULL, args, NULL), "spawned process '%s' with PID %d", args[0], pid);
1394*a325d9c4SApple OSS Distributions
1395*a325d9c4SApple OSS Distributions	// Wait for the the child to spawn up
1396*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(child_ready_sem, DISPATCH_TIME_FOREVER);
1397*a325d9c4SApple OSS Distributions
1398*a325d9c4SApple OSS Distributions	// Make sure the child is running and is translated
1399*a325d9c4SApple OSS Distributions	int mib[] = { CTL_KERN, KERN_PROC, KERN_PROC_PID, pid };
1400*a325d9c4SApple OSS Distributions	struct kinfo_proc process_info;
1401*a325d9c4SApple OSS Distributions	size_t bufsize = sizeof(process_info);
1402*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_SUCCESS(sysctl(mib, (unsigned)(sizeof(mib)/sizeof(int)), &process_info, &bufsize, NULL, 0), "get translated child process info");
1403*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_GT(bufsize, (size_t)0, "process info is not empty");
1404*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_TRUE((process_info.kp_proc.p_flag & P_TRANSLATED), "KERN_PROC_PID reports child is translated");
1405*a325d9c4SApple OSS Distributions
1406*a325d9c4SApple OSS Distributions	T_LOG("capturing stackshot");
1407*a325d9c4SApple OSS Distributions
1408*a325d9c4SApple OSS Distributions	struct scenario scenario = {
1409*a325d9c4SApple OSS Distributions		.name = "translated",
1410*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_GET_GLOBAL_MEM_STATS
1411*a325d9c4SApple OSS Distributions				  | STACKSHOT_SAVE_IMP_DONATION_PIDS | STACKSHOT_KCDATA_FORMAT),
1412*a325d9c4SApple OSS Distributions	};
1413*a325d9c4SApple OSS Distributions
1414*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, true, ^( void *ssbuf, size_t sslen) {
1415*a325d9c4SApple OSS Distributions		parse_stackshot(PARSE_STACKSHOT_TRANSLATED, ssbuf, sslen, @{translated_child_pid_key: @(pid)});
1416*a325d9c4SApple OSS Distributions	});
1417*a325d9c4SApple OSS Distributions
1418*a325d9c4SApple OSS Distributions    // Kill the child
1419*a325d9c4SApple OSS Distributions    int status;
1420*a325d9c4SApple OSS Distributions    T_QUIET; T_ASSERT_POSIX_SUCCESS(kill(pid, SIGTERM), "kill translated child");
1421*a325d9c4SApple OSS Distributions    T_QUIET; T_ASSERT_POSIX_SUCCESS(waitpid(pid, &status, 0), "waitpid on translated child");
1422*a325d9c4SApple OSS Distributions
1423*a325d9c4SApple OSS Distributions}
1424*a325d9c4SApple OSS Distributions
1425*a325d9c4SApple OSS DistributionsT_DECL(proc_uuid_info, "tests that the main binary UUID for a proc is always populated")
1426*a325d9c4SApple OSS Distributions{
1427*a325d9c4SApple OSS Distributions	struct proc_uniqidentifierinfo proc_info_data = { };
1428*a325d9c4SApple OSS Distributions	mach_msg_type_number_t      count;
1429*a325d9c4SApple OSS Distributions	kern_return_t               kernel_status;
1430*a325d9c4SApple OSS Distributions	task_dyld_info_data_t       task_dyld_info;
1431*a325d9c4SApple OSS Distributions	struct dyld_all_image_infos *target_infos;
1432*a325d9c4SApple OSS Distributions	int retval;
1433*a325d9c4SApple OSS Distributions	bool found_image_in_image_infos = false;
1434*a325d9c4SApple OSS Distributions	uint64_t expected_mach_header_offset = 0;
1435*a325d9c4SApple OSS Distributions
1436*a325d9c4SApple OSS Distributions	/* Find the UUID of our main binary */
1437*a325d9c4SApple OSS Distributions	retval = proc_pidinfo(getpid(), PROC_PIDUNIQIDENTIFIERINFO, 0, &proc_info_data, sizeof(proc_info_data));
1438*a325d9c4SApple OSS Distributions	T_QUIET; T_EXPECT_POSIX_SUCCESS(retval, "proc_pidinfo PROC_PIDUNIQIDENTIFIERINFO");
1439*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_EQ_INT(retval, (int) sizeof(proc_info_data), "proc_pidinfo PROC_PIDUNIQIDENTIFIERINFO returned data");
1440*a325d9c4SApple OSS Distributions
1441*a325d9c4SApple OSS Distributions	uuid_string_t str = {};
1442*a325d9c4SApple OSS Distributions	uuid_unparse(*(uuid_t*)&proc_info_data.p_uuid, str);
1443*a325d9c4SApple OSS Distributions	T_LOG("Found current UUID is %s", str);
1444*a325d9c4SApple OSS Distributions
1445*a325d9c4SApple OSS Distributions	/* Find the location of the dyld image info metadata */
1446*a325d9c4SApple OSS Distributions	count = TASK_DYLD_INFO_COUNT;
1447*a325d9c4SApple OSS Distributions	kernel_status = task_info(mach_task_self(), TASK_DYLD_INFO, (task_info_t)&task_dyld_info, &count);
1448*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_EQ(kernel_status, KERN_SUCCESS, "retrieve task_info for TASK_DYLD_INFO");
1449*a325d9c4SApple OSS Distributions
1450*a325d9c4SApple OSS Distributions	target_infos = (struct dyld_all_image_infos *)task_dyld_info.all_image_info_addr;
1451*a325d9c4SApple OSS Distributions
1452*a325d9c4SApple OSS Distributions	/* Find our binary in the dyld image info array */
1453*a325d9c4SApple OSS Distributions	for (int i = 0; i < (int) target_infos->uuidArrayCount; i++) {
1454*a325d9c4SApple OSS Distributions		if (uuid_compare(target_infos->uuidArray[i].imageUUID, *(uuid_t*)&proc_info_data.p_uuid) == 0) {
1455*a325d9c4SApple OSS Distributions			expected_mach_header_offset = (uint64_t) target_infos->uuidArray[i].imageLoadAddress;
1456*a325d9c4SApple OSS Distributions			found_image_in_image_infos = true;
1457*a325d9c4SApple OSS Distributions		}
1458*a325d9c4SApple OSS Distributions	}
1459*a325d9c4SApple OSS Distributions
1460*a325d9c4SApple OSS Distributions	T_ASSERT_TRUE(found_image_in_image_infos, "found binary image in dyld image info list");
1461*a325d9c4SApple OSS Distributions
1462*a325d9c4SApple OSS Distributions	/* Overwrite the dyld image info data so the kernel has to fallback to the UUID stored in the proc structure */
1463*a325d9c4SApple OSS Distributions	target_infos->uuidArrayCount = 0;
1464*a325d9c4SApple OSS Distributions
1465*a325d9c4SApple OSS Distributions	struct scenario scenario = {
1466*a325d9c4SApple OSS Distributions		.name = "proc_uuid_info",
1467*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_KCDATA_FORMAT),
1468*a325d9c4SApple OSS Distributions		.target_pid = getpid(),
1469*a325d9c4SApple OSS Distributions	};
1470*a325d9c4SApple OSS Distributions
1471*a325d9c4SApple OSS Distributions	T_LOG("attempting to take stackshot for current PID");
1472*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, false, ^(void *ssbuf, size_t sslen) {
1473*a325d9c4SApple OSS Distributions		stackshot_verify_current_proc_uuid_info(ssbuf, sslen, expected_mach_header_offset, &proc_info_data);
1474*a325d9c4SApple OSS Distributions	});
1475*a325d9c4SApple OSS Distributions}
1476*a325d9c4SApple OSS Distributions
1477*a325d9c4SApple OSS DistributionsT_DECL(cseg_waitinfo, "test that threads stuck in the compressor report correct waitinfo")
1478*a325d9c4SApple OSS Distributions{
1479*a325d9c4SApple OSS Distributions	struct scenario scenario = {
1480*a325d9c4SApple OSS Distributions		.name = "cseg_waitinfo",
1481*a325d9c4SApple OSS Distributions		.quiet = false,
1482*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_THREAD_WAITINFO | STACKSHOT_KCDATA_FORMAT),
1483*a325d9c4SApple OSS Distributions	};
1484*a325d9c4SApple OSS Distributions	__block uint64_t thread_id = 0;
1485*a325d9c4SApple OSS Distributions
1486*a325d9c4SApple OSS Distributions	dispatch_queue_t dq = dispatch_queue_create("com.apple.stackshot.cseg_waitinfo", NULL);
1487*a325d9c4SApple OSS Distributions	dispatch_semaphore_t child_ok = dispatch_semaphore_create(0);
1488*a325d9c4SApple OSS Distributions
1489*a325d9c4SApple OSS Distributions	dispatch_async(dq, ^{
1490*a325d9c4SApple OSS Distributions		pthread_threadid_np(NULL, &thread_id);
1491*a325d9c4SApple OSS Distributions		dispatch_semaphore_signal(child_ok);
1492*a325d9c4SApple OSS Distributions		int val = 1;
1493*a325d9c4SApple OSS Distributions		T_ASSERT_POSIX_SUCCESS(sysctlbyname("kern.cseg_wedge_thread", NULL, NULL, &val, sizeof(val)), "wedge child thread");
1494*a325d9c4SApple OSS Distributions	});
1495*a325d9c4SApple OSS Distributions
1496*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(child_ok, DISPATCH_TIME_FOREVER);
1497*a325d9c4SApple OSS Distributions	sleep(1);
1498*a325d9c4SApple OSS Distributions
1499*a325d9c4SApple OSS Distributions	T_LOG("taking stackshot");
1500*a325d9c4SApple OSS Distributions	take_stackshot(&scenario, false, ^(void *ssbuf, size_t sslen) {
1501*a325d9c4SApple OSS Distributions		int val = 1;
1502*a325d9c4SApple OSS Distributions		T_ASSERT_POSIX_SUCCESS(sysctlbyname("kern.cseg_unwedge_thread", NULL, NULL, &val, sizeof(val)), "unwedge child thread");
1503*a325d9c4SApple OSS Distributions		parse_stackshot(PARSE_STACKSHOT_WAITINFO_CSEG, ssbuf, sslen, @{cseg_expected_threadid_key: @(thread_id)});
1504*a325d9c4SApple OSS Distributions	});
1505*a325d9c4SApple OSS Distributions}
1506*a325d9c4SApple OSS Distributions
1507*a325d9c4SApple OSS Distributionsstatic void
1508*a325d9c4SApple OSS Distributionssrp_send(
1509*a325d9c4SApple OSS Distributions	mach_port_t send_port,
1510*a325d9c4SApple OSS Distributions	mach_port_t reply_port,
1511*a325d9c4SApple OSS Distributions	mach_port_t msg_port)
1512*a325d9c4SApple OSS Distributions{
1513*a325d9c4SApple OSS Distributions	kern_return_t ret = 0;
1514*a325d9c4SApple OSS Distributions
1515*a325d9c4SApple OSS Distributions	struct test_msg {
1516*a325d9c4SApple OSS Distributions		mach_msg_header_t header;
1517*a325d9c4SApple OSS Distributions		mach_msg_body_t body;
1518*a325d9c4SApple OSS Distributions		mach_msg_port_descriptor_t port_descriptor;
1519*a325d9c4SApple OSS Distributions	};
1520*a325d9c4SApple OSS Distributions	struct test_msg send_msg = {
1521*a325d9c4SApple OSS Distributions		.header = {
1522*a325d9c4SApple OSS Distributions			.msgh_remote_port = send_port,
1523*a325d9c4SApple OSS Distributions			.msgh_local_port  = reply_port,
1524*a325d9c4SApple OSS Distributions			.msgh_bits        = MACH_MSGH_BITS_SET(MACH_MSG_TYPE_COPY_SEND,
1525*a325d9c4SApple OSS Distributions	    reply_port ? MACH_MSG_TYPE_MAKE_SEND_ONCE : 0,
1526*a325d9c4SApple OSS Distributions	    MACH_MSG_TYPE_MOVE_SEND,
1527*a325d9c4SApple OSS Distributions	    MACH_MSGH_BITS_COMPLEX),
1528*a325d9c4SApple OSS Distributions			.msgh_id          = 0x100,
1529*a325d9c4SApple OSS Distributions			.msgh_size        = sizeof(send_msg),
1530*a325d9c4SApple OSS Distributions		},
1531*a325d9c4SApple OSS Distributions		.body = {
1532*a325d9c4SApple OSS Distributions			.msgh_descriptor_count = 1,
1533*a325d9c4SApple OSS Distributions		},
1534*a325d9c4SApple OSS Distributions		.port_descriptor = {
1535*a325d9c4SApple OSS Distributions			.name        = msg_port,
1536*a325d9c4SApple OSS Distributions			.disposition = MACH_MSG_TYPE_MOVE_RECEIVE,
1537*a325d9c4SApple OSS Distributions			.type        = MACH_MSG_PORT_DESCRIPTOR,
1538*a325d9c4SApple OSS Distributions		},
1539*a325d9c4SApple OSS Distributions	};
1540*a325d9c4SApple OSS Distributions
1541*a325d9c4SApple OSS Distributions	if (msg_port == MACH_PORT_NULL) {
1542*a325d9c4SApple OSS Distributions		send_msg.body.msgh_descriptor_count = 0;
1543*a325d9c4SApple OSS Distributions	}
1544*a325d9c4SApple OSS Distributions
1545*a325d9c4SApple OSS Distributions	ret = mach_msg(&(send_msg.header),
1546*a325d9c4SApple OSS Distributions	    MACH_SEND_MSG |
1547*a325d9c4SApple OSS Distributions	    MACH_SEND_TIMEOUT |
1548*a325d9c4SApple OSS Distributions	    MACH_SEND_OVERRIDE,
1549*a325d9c4SApple OSS Distributions	    send_msg.header.msgh_size,
1550*a325d9c4SApple OSS Distributions	    0,
1551*a325d9c4SApple OSS Distributions	    MACH_PORT_NULL,
1552*a325d9c4SApple OSS Distributions	    10000,
1553*a325d9c4SApple OSS Distributions	    0);
1554*a325d9c4SApple OSS Distributions
1555*a325d9c4SApple OSS Distributions	T_ASSERT_MACH_SUCCESS(ret, "client mach_msg");
1556*a325d9c4SApple OSS Distributions}
1557*a325d9c4SApple OSS Distributions
1558*a325d9c4SApple OSS DistributionsT_HELPER_DECL(srp_client,
1559*a325d9c4SApple OSS Distributions    "Client used for the special_reply_port test")
1560*a325d9c4SApple OSS Distributions{
1561*a325d9c4SApple OSS Distributions	pid_t ppid = getppid();
1562*a325d9c4SApple OSS Distributions	dispatch_semaphore_t can_continue  = dispatch_semaphore_create(0);
1563*a325d9c4SApple OSS Distributions	dispatch_queue_t dq = dispatch_queue_create("client_signalqueue", NULL);
1564*a325d9c4SApple OSS Distributions	dispatch_source_t sig_src;
1565*a325d9c4SApple OSS Distributions
1566*a325d9c4SApple OSS Distributions	mach_msg_return_t mr;
1567*a325d9c4SApple OSS Distributions	mach_port_t service_port;
1568*a325d9c4SApple OSS Distributions	mach_port_t conn_port;
1569*a325d9c4SApple OSS Distributions	mach_port_t special_reply_port;
1570*a325d9c4SApple OSS Distributions	mach_port_options_t opts = {
1571*a325d9c4SApple OSS Distributions		.flags = MPO_INSERT_SEND_RIGHT,
1572*a325d9c4SApple OSS Distributions	};
1573*a325d9c4SApple OSS Distributions
1574*a325d9c4SApple OSS Distributions	signal(SIGUSR1, SIG_IGN);
1575*a325d9c4SApple OSS Distributions	sig_src = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGUSR1, 0, dq);
1576*a325d9c4SApple OSS Distributions
1577*a325d9c4SApple OSS Distributions	dispatch_source_set_event_handler(sig_src, ^{
1578*a325d9c4SApple OSS Distributions			dispatch_semaphore_signal(can_continue);
1579*a325d9c4SApple OSS Distributions	});
1580*a325d9c4SApple OSS Distributions	dispatch_activate(sig_src);
1581*a325d9c4SApple OSS Distributions
1582*a325d9c4SApple OSS Distributions	/* lookup the mach service port for the parent */
1583*a325d9c4SApple OSS Distributions	kern_return_t kr = bootstrap_look_up(bootstrap_port,
1584*a325d9c4SApple OSS Distributions	    SRP_SERVICE_NAME, &service_port);
1585*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "client bootstrap_look_up");
1586*a325d9c4SApple OSS Distributions
1587*a325d9c4SApple OSS Distributions	/* create the send-once right (special reply port) and message to send to the server */
1588*a325d9c4SApple OSS Distributions	kr = mach_port_construct(mach_task_self(), &opts, 0ull, &conn_port);
1589*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_MACH_SUCCESS(kr, "mach_port_construct");
1590*a325d9c4SApple OSS Distributions
1591*a325d9c4SApple OSS Distributions	special_reply_port = thread_get_special_reply_port();
1592*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_TRUE(MACH_PORT_VALID(special_reply_port), "get_thread_special_reply_port");
1593*a325d9c4SApple OSS Distributions
1594*a325d9c4SApple OSS Distributions	/* send the message with the special reply port */
1595*a325d9c4SApple OSS Distributions	srp_send(service_port, special_reply_port, conn_port);
1596*a325d9c4SApple OSS Distributions
1597*a325d9c4SApple OSS Distributions	/* signal the parent to continue */
1598*a325d9c4SApple OSS Distributions	kill(ppid, SIGUSR1);
1599*a325d9c4SApple OSS Distributions
1600*a325d9c4SApple OSS Distributions	struct {
1601*a325d9c4SApple OSS Distributions		mach_msg_header_t header;
1602*a325d9c4SApple OSS Distributions		mach_msg_body_t body;
1603*a325d9c4SApple OSS Distributions		mach_msg_port_descriptor_t port_descriptor;
1604*a325d9c4SApple OSS Distributions	} rcv_msg = {
1605*a325d9c4SApple OSS Distributions		.header =
1606*a325d9c4SApple OSS Distributions		{
1607*a325d9c4SApple OSS Distributions			.msgh_remote_port = MACH_PORT_NULL,
1608*a325d9c4SApple OSS Distributions			.msgh_local_port  = special_reply_port,
1609*a325d9c4SApple OSS Distributions			.msgh_size        = sizeof(rcv_msg),
1610*a325d9c4SApple OSS Distributions		},
1611*a325d9c4SApple OSS Distributions	};
1612*a325d9c4SApple OSS Distributions
1613*a325d9c4SApple OSS Distributions	/* wait on the reply from the parent (that we will never receive) */
1614*a325d9c4SApple OSS Distributions	mr = mach_msg(&(rcv_msg.header),
1615*a325d9c4SApple OSS Distributions			(MACH_RCV_MSG | MACH_RCV_SYNC_WAIT),
1616*a325d9c4SApple OSS Distributions			0,
1617*a325d9c4SApple OSS Distributions			rcv_msg.header.msgh_size,
1618*a325d9c4SApple OSS Distributions			special_reply_port,
1619*a325d9c4SApple OSS Distributions			MACH_MSG_TIMEOUT_NONE,
1620*a325d9c4SApple OSS Distributions			service_port);
1621*a325d9c4SApple OSS Distributions
1622*a325d9c4SApple OSS Distributions	/* not expected to execute as parent will SIGKILL client... */
1623*a325d9c4SApple OSS Distributions	T_LOG("client process exiting after sending message to parent (server)");
1624*a325d9c4SApple OSS Distributions}
1625*a325d9c4SApple OSS Distributions
1626*a325d9c4SApple OSS Distributionsenum srp_test_type {
1627*a325d9c4SApple OSS Distributions	SRP_TEST_THREAD,	/* expect waiter on current thread */
1628*a325d9c4SApple OSS Distributions	SRP_TEST_PID,		/* expect waiter on current PID */
1629*a325d9c4SApple OSS Distributions	SRP_TEST_EITHER,	/* waiter could be on either */
1630*a325d9c4SApple OSS Distributions};
1631*a325d9c4SApple OSS Distributions
1632*a325d9c4SApple OSS Distributionsstatic void
1633*a325d9c4SApple OSS Distributionscheck_srp_test(const char *name, enum srp_test_type ty)
1634*a325d9c4SApple OSS Distributions{
1635*a325d9c4SApple OSS Distributions	struct scenario scenario = {
1636*a325d9c4SApple OSS Distributions		.name = name,
1637*a325d9c4SApple OSS Distributions		.quiet = false,
1638*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_THREAD_WAITINFO | STACKSHOT_KCDATA_FORMAT),
1639*a325d9c4SApple OSS Distributions	};
1640*a325d9c4SApple OSS Distributions	uint64_t thread_id = 0;
1641*a325d9c4SApple OSS Distributions	pthread_threadid_np(NULL, &thread_id);
1642*a325d9c4SApple OSS Distributions	if (ty == SRP_TEST_THREAD) {
1643*a325d9c4SApple OSS Distributions		take_stackshot(&scenario, false, ^(void *ssbuf, size_t sslen) {
1644*a325d9c4SApple OSS Distributions			parse_stackshot(PARSE_STACKSHOT_WAITINFO_SRP, ssbuf, sslen,
1645*a325d9c4SApple OSS Distributions					@{srp_expected_threadid_key: @(thread_id)});
1646*a325d9c4SApple OSS Distributions		});
1647*a325d9c4SApple OSS Distributions	} else if (ty == SRP_TEST_PID) {
1648*a325d9c4SApple OSS Distributions		take_stackshot(&scenario, false, ^(void *ssbuf, size_t sslen) {
1649*a325d9c4SApple OSS Distributions			parse_stackshot(PARSE_STACKSHOT_WAITINFO_SRP, ssbuf, sslen,
1650*a325d9c4SApple OSS Distributions					@{srp_expected_pid_key: @(getpid())});
1651*a325d9c4SApple OSS Distributions		});
1652*a325d9c4SApple OSS Distributions	} else {
1653*a325d9c4SApple OSS Distributions		take_stackshot(&scenario, false, ^(void *ssbuf, size_t sslen) {
1654*a325d9c4SApple OSS Distributions			parse_stackshot(PARSE_STACKSHOT_WAITINFO_SRP, ssbuf, sslen,
1655*a325d9c4SApple OSS Distributions					@{srp_expected_pid_key: @(getpid()), srp_expected_threadid_key: @(thread_id)});
1656*a325d9c4SApple OSS Distributions		});
1657*a325d9c4SApple OSS Distributions	}
1658*a325d9c4SApple OSS Distributions
1659*a325d9c4SApple OSS Distributions}
1660*a325d9c4SApple OSS Distributions
1661*a325d9c4SApple OSS Distributions
1662*a325d9c4SApple OSS Distributions/*
1663*a325d9c4SApple OSS Distributions * Tests the stackshot wait info plumbing for synchronous IPC that doesn't use kevent on the server.
1664*a325d9c4SApple OSS Distributions *
1665*a325d9c4SApple OSS Distributions * (part 1): tests the scenario where a client sends a request that includes a special reply port
1666*a325d9c4SApple OSS Distributions *           to a server that doesn't receive the message and doesn't copy the send-once right
1667*a325d9c4SApple OSS Distributions *           into its address space as a result. for this case the special reply port is enqueued
1668*a325d9c4SApple OSS Distributions *           in a port and we check which task has that receive right and use that info. (rdar://60440338)
1669*a325d9c4SApple OSS Distributions * (part 2): tests the scenario where a client sends a request that includes a special reply port
1670*a325d9c4SApple OSS Distributions *           to a server that receives the message and copies in the send-once right, but doesn't
1671*a325d9c4SApple OSS Distributions *           reply to the client. for this case the special reply port is copied out and the kernel
1672*a325d9c4SApple OSS Distributions *           stashes the info about which task copied out the send once right. (rdar://60440592)
1673*a325d9c4SApple OSS Distributions * (part 3): tests the same as part 2, but uses kevents, which allow for
1674*a325d9c4SApple OSS Distributions *           priority inheritance
1675*a325d9c4SApple OSS Distributions */
1676*a325d9c4SApple OSS DistributionsT_DECL(special_reply_port, "test that tasks using special reply ports have correct waitinfo")
1677*a325d9c4SApple OSS Distributions{
1678*a325d9c4SApple OSS Distributions	dispatch_semaphore_t can_continue  = dispatch_semaphore_create(0);
1679*a325d9c4SApple OSS Distributions	dispatch_queue_t dq = dispatch_queue_create("signalqueue", NULL);
1680*a325d9c4SApple OSS Distributions	dispatch_queue_t machdq = dispatch_queue_create("machqueue", NULL);
1681*a325d9c4SApple OSS Distributions	dispatch_source_t sig_src;
1682*a325d9c4SApple OSS Distributions	char path[PATH_MAX];
1683*a325d9c4SApple OSS Distributions	uint32_t path_size = sizeof(path);
1684*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_ZERO(_NSGetExecutablePath(path, &path_size), "_NSGetExecutablePath");
1685*a325d9c4SApple OSS Distributions	char *client_args[] = { path, "-n", "srp_client", NULL };
1686*a325d9c4SApple OSS Distributions	pid_t client_pid;
1687*a325d9c4SApple OSS Distributions	int sp_ret;
1688*a325d9c4SApple OSS Distributions	kern_return_t kr;
1689*a325d9c4SApple OSS Distributions	mach_port_t port;
1690*a325d9c4SApple OSS Distributions
1691*a325d9c4SApple OSS Distributions	/* setup the signal handler in the parent (server) */
1692*a325d9c4SApple OSS Distributions	T_LOG("setup sig handlers");
1693*a325d9c4SApple OSS Distributions	signal(SIGUSR1, SIG_IGN);
1694*a325d9c4SApple OSS Distributions	sig_src = dispatch_source_create(DISPATCH_SOURCE_TYPE_SIGNAL, SIGUSR1, 0, dq);
1695*a325d9c4SApple OSS Distributions
1696*a325d9c4SApple OSS Distributions	dispatch_source_set_event_handler(sig_src, ^{
1697*a325d9c4SApple OSS Distributions			dispatch_semaphore_signal(can_continue);
1698*a325d9c4SApple OSS Distributions	});
1699*a325d9c4SApple OSS Distributions	dispatch_activate(sig_src);
1700*a325d9c4SApple OSS Distributions
1701*a325d9c4SApple OSS Distributions	/* register with the mach service name so the client can lookup and send a message to the parent (server) */
1702*a325d9c4SApple OSS Distributions	T_LOG("Server about to check in");
1703*a325d9c4SApple OSS Distributions	kr = bootstrap_check_in(bootstrap_port, SRP_SERVICE_NAME, &port);
1704*a325d9c4SApple OSS Distributions	T_ASSERT_MACH_SUCCESS(kr, "server bootstrap_check_in");
1705*a325d9c4SApple OSS Distributions
1706*a325d9c4SApple OSS Distributions	T_LOG("Launching client");
1707*a325d9c4SApple OSS Distributions	sp_ret = posix_spawn(&client_pid, client_args[0], NULL, NULL, client_args, NULL);
1708*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_ZERO(sp_ret, "spawned process '%s' with PID %d", client_args[0], client_pid);
1709*a325d9c4SApple OSS Distributions	T_LOG("Spawned client as PID %d", client_pid);
1710*a325d9c4SApple OSS Distributions
1711*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(can_continue, DISPATCH_TIME_FOREVER);
1712*a325d9c4SApple OSS Distributions	T_LOG("Ready to take stackshot, but waiting 1s for the coast to clear");
1713*a325d9c4SApple OSS Distributions
1714*a325d9c4SApple OSS Distributions	/*
1715*a325d9c4SApple OSS Distributions	 * can_continue indicates the client has signaled us, but we want to make
1716*a325d9c4SApple OSS Distributions	 * sure they've actually blocked sending their mach message.  It's cheesy, but
1717*a325d9c4SApple OSS Distributions	 * sleep() works for this.
1718*a325d9c4SApple OSS Distributions	 */
1719*a325d9c4SApple OSS Distributions	sleep(1);
1720*a325d9c4SApple OSS Distributions
1721*a325d9c4SApple OSS Distributions	/*
1722*a325d9c4SApple OSS Distributions	 * take the stackshot without calling receive to verify that the stackshot wait
1723*a325d9c4SApple OSS Distributions	 * info shows our (the server) thread for the scenario where the server has yet to
1724*a325d9c4SApple OSS Distributions	 * receive the message.
1725*a325d9c4SApple OSS Distributions	 */
1726*a325d9c4SApple OSS Distributions	T_LOG("Taking stackshot for part 1 coverage");
1727*a325d9c4SApple OSS Distributions	check_srp_test("srp", SRP_TEST_THREAD);
1728*a325d9c4SApple OSS Distributions
1729*a325d9c4SApple OSS Distributions	/*
1730*a325d9c4SApple OSS Distributions	 * receive the message from the client (which should copy the send once right into
1731*a325d9c4SApple OSS Distributions	 * our address space).
1732*a325d9c4SApple OSS Distributions	 */
1733*a325d9c4SApple OSS Distributions	struct {
1734*a325d9c4SApple OSS Distributions		mach_msg_header_t header;
1735*a325d9c4SApple OSS Distributions		mach_msg_body_t body;
1736*a325d9c4SApple OSS Distributions		mach_msg_port_descriptor_t port_descriptor;
1737*a325d9c4SApple OSS Distributions	} rcv_msg = {
1738*a325d9c4SApple OSS Distributions		.header =
1739*a325d9c4SApple OSS Distributions		{
1740*a325d9c4SApple OSS Distributions			.msgh_remote_port = MACH_PORT_NULL,
1741*a325d9c4SApple OSS Distributions			.msgh_local_port  = port,
1742*a325d9c4SApple OSS Distributions			.msgh_size        = sizeof(rcv_msg),
1743*a325d9c4SApple OSS Distributions		},
1744*a325d9c4SApple OSS Distributions	};
1745*a325d9c4SApple OSS Distributions
1746*a325d9c4SApple OSS Distributions	T_LOG("server: starting sync receive\n");
1747*a325d9c4SApple OSS Distributions
1748*a325d9c4SApple OSS Distributions	mach_msg_return_t mr;
1749*a325d9c4SApple OSS Distributions	mr = mach_msg(&(rcv_msg.header),
1750*a325d9c4SApple OSS Distributions			(MACH_RCV_MSG | MACH_RCV_TIMEOUT),
1751*a325d9c4SApple OSS Distributions			0,
1752*a325d9c4SApple OSS Distributions			4096,
1753*a325d9c4SApple OSS Distributions			port,
1754*a325d9c4SApple OSS Distributions			10000,
1755*a325d9c4SApple OSS Distributions			MACH_PORT_NULL);
1756*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_MACH_SUCCESS(mr, "mach_msg() recieve of message from client");
1757*a325d9c4SApple OSS Distributions
1758*a325d9c4SApple OSS Distributions	/*
1759*a325d9c4SApple OSS Distributions	 * take the stackshot to verify that the stackshot wait info shows our (the server) PID
1760*a325d9c4SApple OSS Distributions	 * for the scenario where the server has received the message and copied in the send-once right.
1761*a325d9c4SApple OSS Distributions	 */
1762*a325d9c4SApple OSS Distributions	T_LOG("Taking stackshot for part 2 coverage");
1763*a325d9c4SApple OSS Distributions	check_srp_test("srp", SRP_TEST_PID);
1764*a325d9c4SApple OSS Distributions
1765*a325d9c4SApple OSS Distributions	/* cleanup - kill the client */
1766*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_SUCCESS(kill(client_pid, SIGKILL), "killing client");
1767*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_SUCCESS(waitpid(client_pid, NULL, 0), "waiting for the client to exit");
1768*a325d9c4SApple OSS Distributions
1769*a325d9c4SApple OSS Distributions	// do it again, but using kevents
1770*a325d9c4SApple OSS Distributions	T_LOG("Launching client");
1771*a325d9c4SApple OSS Distributions	sp_ret = posix_spawn(&client_pid, client_args[0], NULL, NULL, client_args, NULL);
1772*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_POSIX_ZERO(sp_ret, "spawned process '%s' with PID %d", client_args[0], client_pid);
1773*a325d9c4SApple OSS Distributions	T_LOG("Spawned client as PID %d", client_pid);
1774*a325d9c4SApple OSS Distributions
1775*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(can_continue, DISPATCH_TIME_FOREVER);
1776*a325d9c4SApple OSS Distributions	T_LOG("Ready to take stackshot, but waiting 1s for the coast to clear");
1777*a325d9c4SApple OSS Distributions
1778*a325d9c4SApple OSS Distributions	/*
1779*a325d9c4SApple OSS Distributions	 * can_continue indicates the client has signaled us, but we want to make
1780*a325d9c4SApple OSS Distributions	 * sure they've actually blocked sending their mach message.  It's cheesy, but
1781*a325d9c4SApple OSS Distributions	 * sleep() works for this.
1782*a325d9c4SApple OSS Distributions	 */
1783*a325d9c4SApple OSS Distributions	sleep(1);
1784*a325d9c4SApple OSS Distributions
1785*a325d9c4SApple OSS Distributions	dispatch_mach_t dispatch_mach = dispatch_mach_create(SRP_SERVICE_NAME, machdq,
1786*a325d9c4SApple OSS Distributions	    ^(dispatch_mach_reason_t reason,
1787*a325d9c4SApple OSS Distributions	      dispatch_mach_msg_t message,
1788*a325d9c4SApple OSS Distributions	      mach_error_t error __unused) {
1789*a325d9c4SApple OSS Distributions		switch (reason) {
1790*a325d9c4SApple OSS Distributions		case DISPATCH_MACH_MESSAGE_RECEIVED: {
1791*a325d9c4SApple OSS Distributions			size_t size = 0;
1792*a325d9c4SApple OSS Distributions			mach_msg_header_t *msg __unused = dispatch_mach_msg_get_msg(message, &size);
1793*a325d9c4SApple OSS Distributions			T_LOG("server: recieved %ld byte message", size);
1794*a325d9c4SApple OSS Distributions			check_srp_test("turnstile_port_thread", SRP_TEST_THREAD);
1795*a325d9c4SApple OSS Distributions			T_LOG("server: letting client go");
1796*a325d9c4SApple OSS Distributions			// drop the message on the ground, we'll kill the client later
1797*a325d9c4SApple OSS Distributions			dispatch_semaphore_signal(can_continue);
1798*a325d9c4SApple OSS Distributions			break;
1799*a325d9c4SApple OSS Distributions		}
1800*a325d9c4SApple OSS Distributions		default:
1801*a325d9c4SApple OSS Distributions			break;
1802*a325d9c4SApple OSS Distributions		}
1803*a325d9c4SApple OSS Distributions	});
1804*a325d9c4SApple OSS Distributions
1805*a325d9c4SApple OSS Distributions	dispatch_mach_connect(dispatch_mach, port, MACH_PORT_NULL, NULL);
1806*a325d9c4SApple OSS Distributions
1807*a325d9c4SApple OSS Distributions	dispatch_semaphore_wait(can_continue, DISPATCH_TIME_FOREVER);
1808*a325d9c4SApple OSS Distributions
1809*a325d9c4SApple OSS Distributions	/* cleanup - kill the client */
1810*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_SUCCESS(kill(client_pid, SIGKILL), "killing client");
1811*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_SUCCESS(waitpid(client_pid, NULL, 0), "waiting for the client to exit");
1812*a325d9c4SApple OSS Distributions}
1813*a325d9c4SApple OSS Distributions
1814*a325d9c4SApple OSS Distributions#pragma mark performance tests
1815*a325d9c4SApple OSS Distributions
1816*a325d9c4SApple OSS Distributions#define SHOULD_REUSE_SIZE_HINT 0x01
1817*a325d9c4SApple OSS Distributions#define SHOULD_USE_DELTA       0x02
1818*a325d9c4SApple OSS Distributions#define SHOULD_TARGET_SELF     0x04
1819*a325d9c4SApple OSS Distributions
1820*a325d9c4SApple OSS Distributionsstatic void
1821*a325d9c4SApple OSS Distributionsstackshot_perf(unsigned int options)
1822*a325d9c4SApple OSS Distributions{
1823*a325d9c4SApple OSS Distributions	struct scenario scenario = {
1824*a325d9c4SApple OSS Distributions		.flags = (STACKSHOT_SAVE_LOADINFO | STACKSHOT_GET_GLOBAL_MEM_STATS
1825*a325d9c4SApple OSS Distributions			| STACKSHOT_SAVE_IMP_DONATION_PIDS | STACKSHOT_KCDATA_FORMAT),
1826*a325d9c4SApple OSS Distributions	};
1827*a325d9c4SApple OSS Distributions
1828*a325d9c4SApple OSS Distributions	dt_stat_t size = dt_stat_create("bytes", "size");
1829*a325d9c4SApple OSS Distributions	dt_stat_time_t duration = dt_stat_time_create("duration");
1830*a325d9c4SApple OSS Distributions	scenario.timer = duration;
1831*a325d9c4SApple OSS Distributions
1832*a325d9c4SApple OSS Distributions	if (options & SHOULD_TARGET_SELF) {
1833*a325d9c4SApple OSS Distributions		scenario.target_pid = getpid();
1834*a325d9c4SApple OSS Distributions	}
1835*a325d9c4SApple OSS Distributions
1836*a325d9c4SApple OSS Distributions	while (!dt_stat_stable(duration) || !dt_stat_stable(size)) {
1837*a325d9c4SApple OSS Distributions		__block uint64_t last_time = 0;
1838*a325d9c4SApple OSS Distributions		__block uint32_t size_hint = 0;
1839*a325d9c4SApple OSS Distributions		take_stackshot(&scenario, false, ^(void *ssbuf, size_t sslen) {
1840*a325d9c4SApple OSS Distributions			dt_stat_add(size, (double)sslen);
1841*a325d9c4SApple OSS Distributions			last_time = stackshot_timestamp(ssbuf, sslen);
1842*a325d9c4SApple OSS Distributions			size_hint = (uint32_t)sslen;
1843*a325d9c4SApple OSS Distributions		});
1844*a325d9c4SApple OSS Distributions		if (options & SHOULD_USE_DELTA) {
1845*a325d9c4SApple OSS Distributions			scenario.since_timestamp = last_time;
1846*a325d9c4SApple OSS Distributions			scenario.flags |= STACKSHOT_COLLECT_DELTA_SNAPSHOT;
1847*a325d9c4SApple OSS Distributions		}
1848*a325d9c4SApple OSS Distributions		if (options & SHOULD_REUSE_SIZE_HINT) {
1849*a325d9c4SApple OSS Distributions			scenario.size_hint = size_hint;
1850*a325d9c4SApple OSS Distributions		}
1851*a325d9c4SApple OSS Distributions	}
1852*a325d9c4SApple OSS Distributions
1853*a325d9c4SApple OSS Distributions	dt_stat_finalize(duration);
1854*a325d9c4SApple OSS Distributions	dt_stat_finalize(size);
1855*a325d9c4SApple OSS Distributions}
1856*a325d9c4SApple OSS Distributions
1857*a325d9c4SApple OSS Distributionsstatic void
1858*a325d9c4SApple OSS Distributionsstackshot_flag_perf_noclobber(uint64_t flag, char *flagname)
1859*a325d9c4SApple OSS Distributions{
1860*a325d9c4SApple OSS Distributions	struct scenario scenario = {
1861*a325d9c4SApple OSS Distributions		.quiet = true,
1862*a325d9c4SApple OSS Distributions		.flags = (flag | STACKSHOT_KCDATA_FORMAT),
1863*a325d9c4SApple OSS Distributions	};
1864*a325d9c4SApple OSS Distributions
1865*a325d9c4SApple OSS Distributions	dt_stat_t duration = dt_stat_create("nanoseconds per thread", "%s_duration", flagname);
1866*a325d9c4SApple OSS Distributions	dt_stat_t size = dt_stat_create("bytes per thread", "%s_size", flagname);
1867*a325d9c4SApple OSS Distributions	T_LOG("Testing \"%s\" = 0x%" PRIx64, flagname, flag);
1868*a325d9c4SApple OSS Distributions
1869*a325d9c4SApple OSS Distributions	while (!dt_stat_stable(duration) || !dt_stat_stable(size)) {
1870*a325d9c4SApple OSS Distributions		take_stackshot(&scenario, false, ^(void *ssbuf, size_t sslen) {
1871*a325d9c4SApple OSS Distributions			kcdata_iter_t iter = kcdata_iter(ssbuf, sslen);
1872*a325d9c4SApple OSS Distributions			unsigned long no_threads = 0;
1873*a325d9c4SApple OSS Distributions			mach_timebase_info_data_t timebase = {0, 0};
1874*a325d9c4SApple OSS Distributions			uint64_t stackshot_duration = 0;
1875*a325d9c4SApple OSS Distributions			int found = 0;
1876*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_EQ(kcdata_iter_type(iter), KCDATA_BUFFER_BEGIN_STACKSHOT, "stackshot buffer");
1877*a325d9c4SApple OSS Distributions
1878*a325d9c4SApple OSS Distributions			KCDATA_ITER_FOREACH(iter) {
1879*a325d9c4SApple OSS Distributions				switch(kcdata_iter_type(iter)) {
1880*a325d9c4SApple OSS Distributions					case STACKSHOT_KCTYPE_THREAD_SNAPSHOT: {
1881*a325d9c4SApple OSS Distributions						found |= 1;
1882*a325d9c4SApple OSS Distributions						no_threads ++;
1883*a325d9c4SApple OSS Distributions						break;
1884*a325d9c4SApple OSS Distributions					}
1885*a325d9c4SApple OSS Distributions					case STACKSHOT_KCTYPE_STACKSHOT_DURATION: {
1886*a325d9c4SApple OSS Distributions						struct stackshot_duration *ssd = kcdata_iter_payload(iter);
1887*a325d9c4SApple OSS Distributions						stackshot_duration = ssd->stackshot_duration;
1888*a325d9c4SApple OSS Distributions						found |= 2;
1889*a325d9c4SApple OSS Distributions						break;
1890*a325d9c4SApple OSS Distributions					}
1891*a325d9c4SApple OSS Distributions					case KCDATA_TYPE_TIMEBASE: {
1892*a325d9c4SApple OSS Distributions						found |= 4;
1893*a325d9c4SApple OSS Distributions						mach_timebase_info_data_t *tb = kcdata_iter_payload(iter);
1894*a325d9c4SApple OSS Distributions						memcpy(&timebase, tb, sizeof(timebase));
1895*a325d9c4SApple OSS Distributions						break;
1896*a325d9c4SApple OSS Distributions					}
1897*a325d9c4SApple OSS Distributions				}
1898*a325d9c4SApple OSS Distributions			}
1899*a325d9c4SApple OSS Distributions
1900*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_EQ(found, 0x7, "found everything needed");
1901*a325d9c4SApple OSS Distributions
1902*a325d9c4SApple OSS Distributions			uint64_t ns = (stackshot_duration * timebase.numer) / timebase.denom;
1903*a325d9c4SApple OSS Distributions			uint64_t per_thread_ns = ns / no_threads;
1904*a325d9c4SApple OSS Distributions			uint64_t per_thread_size = sslen / no_threads;
1905*a325d9c4SApple OSS Distributions
1906*a325d9c4SApple OSS Distributions			dt_stat_add(duration, per_thread_ns);
1907*a325d9c4SApple OSS Distributions			dt_stat_add(size, per_thread_size);
1908*a325d9c4SApple OSS Distributions		});
1909*a325d9c4SApple OSS Distributions	}
1910*a325d9c4SApple OSS Distributions
1911*a325d9c4SApple OSS Distributions	dt_stat_finalize(duration);
1912*a325d9c4SApple OSS Distributions	dt_stat_finalize(size);
1913*a325d9c4SApple OSS Distributions}
1914*a325d9c4SApple OSS Distributions
1915*a325d9c4SApple OSS Distributionsstatic void
1916*a325d9c4SApple OSS Distributionsstackshot_flag_perf(uint64_t flag, char *flagname)
1917*a325d9c4SApple OSS Distributions{
1918*a325d9c4SApple OSS Distributions	/*
1919*a325d9c4SApple OSS Distributions	 * STACKSHOT_NO_IO_STATS disables data collection, so set it for
1920*a325d9c4SApple OSS Distributions	 * more accurate perfdata collection.
1921*a325d9c4SApple OSS Distributions	 */
1922*a325d9c4SApple OSS Distributions	flag |= STACKSHOT_NO_IO_STATS;
1923*a325d9c4SApple OSS Distributions
1924*a325d9c4SApple OSS Distributions	stackshot_flag_perf_noclobber(flag, flagname);
1925*a325d9c4SApple OSS Distributions}
1926*a325d9c4SApple OSS Distributions
1927*a325d9c4SApple OSS Distributions
1928*a325d9c4SApple OSS DistributionsT_DECL(flag_perf, "test stackshot performance with different flags set", T_META_TAG_PERF)
1929*a325d9c4SApple OSS Distributions{
1930*a325d9c4SApple OSS Distributions	stackshot_flag_perf_noclobber(STACKSHOT_NO_IO_STATS, "baseline");
1931*a325d9c4SApple OSS Distributions	stackshot_flag_perf_noclobber(0, "io_stats");
1932*a325d9c4SApple OSS Distributions
1933*a325d9c4SApple OSS Distributions	stackshot_flag_perf(STACKSHOT_THREAD_WAITINFO, "thread_waitinfo");
1934*a325d9c4SApple OSS Distributions	stackshot_flag_perf(STACKSHOT_GET_DQ, "get_dq");
1935*a325d9c4SApple OSS Distributions	stackshot_flag_perf(STACKSHOT_SAVE_LOADINFO, "save_loadinfo");
1936*a325d9c4SApple OSS Distributions	stackshot_flag_perf(STACKSHOT_GET_GLOBAL_MEM_STATS, "get_global_mem_stats");
1937*a325d9c4SApple OSS Distributions	stackshot_flag_perf(STACKSHOT_SAVE_KEXT_LOADINFO, "save_kext_loadinfo");
1938*a325d9c4SApple OSS Distributions	stackshot_flag_perf(STACKSHOT_SAVE_IMP_DONATION_PIDS, "save_imp_donation_pids");
1939*a325d9c4SApple OSS Distributions	stackshot_flag_perf(STACKSHOT_ENABLE_BT_FAULTING, "enable_bt_faulting");
1940*a325d9c4SApple OSS Distributions	stackshot_flag_perf(STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT, "collect_sharedcache_layout");
1941*a325d9c4SApple OSS Distributions	stackshot_flag_perf(STACKSHOT_ENABLE_UUID_FAULTING, "enable_uuid_faulting");
1942*a325d9c4SApple OSS Distributions	stackshot_flag_perf(STACKSHOT_THREAD_GROUP, "thread_group");
1943*a325d9c4SApple OSS Distributions	stackshot_flag_perf(STACKSHOT_SAVE_JETSAM_COALITIONS, "save_jetsam_coalitions");
1944*a325d9c4SApple OSS Distributions	stackshot_flag_perf(STACKSHOT_INSTRS_CYCLES, "instrs_cycles");
1945*a325d9c4SApple OSS Distributions	stackshot_flag_perf(STACKSHOT_ASID, "asid");
1946*a325d9c4SApple OSS Distributions}
1947*a325d9c4SApple OSS Distributions
1948*a325d9c4SApple OSS DistributionsT_DECL(perf_no_size_hint, "test stackshot performance with no size hint",
1949*a325d9c4SApple OSS Distributions		T_META_TAG_PERF)
1950*a325d9c4SApple OSS Distributions{
1951*a325d9c4SApple OSS Distributions	stackshot_perf(0);
1952*a325d9c4SApple OSS Distributions}
1953*a325d9c4SApple OSS Distributions
1954*a325d9c4SApple OSS DistributionsT_DECL(perf_size_hint, "test stackshot performance with size hint",
1955*a325d9c4SApple OSS Distributions		T_META_TAG_PERF)
1956*a325d9c4SApple OSS Distributions{
1957*a325d9c4SApple OSS Distributions	stackshot_perf(SHOULD_REUSE_SIZE_HINT);
1958*a325d9c4SApple OSS Distributions}
1959*a325d9c4SApple OSS Distributions
1960*a325d9c4SApple OSS DistributionsT_DECL(perf_process, "test stackshot performance targeted at process",
1961*a325d9c4SApple OSS Distributions		T_META_TAG_PERF)
1962*a325d9c4SApple OSS Distributions{
1963*a325d9c4SApple OSS Distributions	stackshot_perf(SHOULD_REUSE_SIZE_HINT | SHOULD_TARGET_SELF);
1964*a325d9c4SApple OSS Distributions}
1965*a325d9c4SApple OSS Distributions
1966*a325d9c4SApple OSS DistributionsT_DECL(perf_delta, "test delta stackshot performance",
1967*a325d9c4SApple OSS Distributions		T_META_TAG_PERF)
1968*a325d9c4SApple OSS Distributions{
1969*a325d9c4SApple OSS Distributions	stackshot_perf(SHOULD_REUSE_SIZE_HINT | SHOULD_USE_DELTA);
1970*a325d9c4SApple OSS Distributions}
1971*a325d9c4SApple OSS Distributions
1972*a325d9c4SApple OSS DistributionsT_DECL(perf_delta_process, "test delta stackshot performance targeted at a process",
1973*a325d9c4SApple OSS Distributions		T_META_TAG_PERF)
1974*a325d9c4SApple OSS Distributions{
1975*a325d9c4SApple OSS Distributions	stackshot_perf(SHOULD_REUSE_SIZE_HINT | SHOULD_USE_DELTA | SHOULD_TARGET_SELF);
1976*a325d9c4SApple OSS Distributions}
1977*a325d9c4SApple OSS Distributions
1978*a325d9c4SApple OSS Distributionsstatic uint64_t
1979*a325d9c4SApple OSS Distributionsstackshot_timestamp(void *ssbuf, size_t sslen)
1980*a325d9c4SApple OSS Distributions{
1981*a325d9c4SApple OSS Distributions	kcdata_iter_t iter = kcdata_iter(ssbuf, sslen);
1982*a325d9c4SApple OSS Distributions
1983*a325d9c4SApple OSS Distributions	uint32_t type = kcdata_iter_type(iter);
1984*a325d9c4SApple OSS Distributions	if (type != KCDATA_BUFFER_BEGIN_STACKSHOT && type != KCDATA_BUFFER_BEGIN_DELTA_STACKSHOT) {
1985*a325d9c4SApple OSS Distributions		T_ASSERT_FAIL("invalid kcdata type %u", kcdata_iter_type(iter));
1986*a325d9c4SApple OSS Distributions	}
1987*a325d9c4SApple OSS Distributions
1988*a325d9c4SApple OSS Distributions	iter = kcdata_iter_find_type(iter, KCDATA_TYPE_MACH_ABSOLUTE_TIME);
1989*a325d9c4SApple OSS Distributions	T_QUIET;
1990*a325d9c4SApple OSS Distributions	T_ASSERT_TRUE(kcdata_iter_valid(iter), "timestamp found in stackshot");
1991*a325d9c4SApple OSS Distributions
1992*a325d9c4SApple OSS Distributions	return *(uint64_t *)kcdata_iter_payload(iter);
1993*a325d9c4SApple OSS Distributions}
1994*a325d9c4SApple OSS Distributions
1995*a325d9c4SApple OSS Distributions#define TEST_THREAD_NAME "stackshot_test_thread"
1996*a325d9c4SApple OSS Distributions
1997*a325d9c4SApple OSS Distributionsstatic void
1998*a325d9c4SApple OSS Distributionsparse_thread_group_stackshot(void **ssbuf, size_t sslen)
1999*a325d9c4SApple OSS Distributions{
2000*a325d9c4SApple OSS Distributions	bool seen_thread_group_snapshot = false;
2001*a325d9c4SApple OSS Distributions	kcdata_iter_t iter = kcdata_iter(ssbuf, sslen);
2002*a325d9c4SApple OSS Distributions	T_ASSERT_EQ(kcdata_iter_type(iter), KCDATA_BUFFER_BEGIN_STACKSHOT,
2003*a325d9c4SApple OSS Distributions			"buffer provided is a stackshot");
2004*a325d9c4SApple OSS Distributions
2005*a325d9c4SApple OSS Distributions	NSMutableSet *thread_groups = [[NSMutableSet alloc] init];
2006*a325d9c4SApple OSS Distributions
2007*a325d9c4SApple OSS Distributions	iter = kcdata_iter_next(iter);
2008*a325d9c4SApple OSS Distributions	KCDATA_ITER_FOREACH(iter) {
2009*a325d9c4SApple OSS Distributions		switch (kcdata_iter_type(iter)) {
2010*a325d9c4SApple OSS Distributions		case KCDATA_TYPE_ARRAY: {
2011*a325d9c4SApple OSS Distributions			T_QUIET;
2012*a325d9c4SApple OSS Distributions			T_ASSERT_TRUE(kcdata_iter_array_valid(iter),
2013*a325d9c4SApple OSS Distributions					"checked that array is valid");
2014*a325d9c4SApple OSS Distributions
2015*a325d9c4SApple OSS Distributions			if (kcdata_iter_array_elem_type(iter) != STACKSHOT_KCTYPE_THREAD_GROUP_SNAPSHOT) {
2016*a325d9c4SApple OSS Distributions				continue;
2017*a325d9c4SApple OSS Distributions			}
2018*a325d9c4SApple OSS Distributions
2019*a325d9c4SApple OSS Distributions			seen_thread_group_snapshot = true;
2020*a325d9c4SApple OSS Distributions
2021*a325d9c4SApple OSS Distributions			if (kcdata_iter_array_elem_size(iter) >= sizeof(struct thread_group_snapshot_v2)) {
2022*a325d9c4SApple OSS Distributions				struct thread_group_snapshot_v2 *tgs_array = kcdata_iter_payload(iter);
2023*a325d9c4SApple OSS Distributions				for (uint32_t j = 0; j < kcdata_iter_array_elem_count(iter); j++) {
2024*a325d9c4SApple OSS Distributions					struct thread_group_snapshot_v2 *tgs = tgs_array + j;
2025*a325d9c4SApple OSS Distributions					[thread_groups addObject:@(tgs->tgs_id)];
2026*a325d9c4SApple OSS Distributions				}
2027*a325d9c4SApple OSS Distributions
2028*a325d9c4SApple OSS Distributions			}
2029*a325d9c4SApple OSS Distributions			else {
2030*a325d9c4SApple OSS Distributions				struct thread_group_snapshot *tgs_array = kcdata_iter_payload(iter);
2031*a325d9c4SApple OSS Distributions				for (uint32_t j = 0; j < kcdata_iter_array_elem_count(iter); j++) {
2032*a325d9c4SApple OSS Distributions					struct thread_group_snapshot *tgs = tgs_array + j;
2033*a325d9c4SApple OSS Distributions					[thread_groups addObject:@(tgs->tgs_id)];
2034*a325d9c4SApple OSS Distributions				}
2035*a325d9c4SApple OSS Distributions			}
2036*a325d9c4SApple OSS Distributions			break;
2037*a325d9c4SApple OSS Distributions		}
2038*a325d9c4SApple OSS Distributions		}
2039*a325d9c4SApple OSS Distributions	}
2040*a325d9c4SApple OSS Distributions	KCDATA_ITER_FOREACH(iter) {
2041*a325d9c4SApple OSS Distributions		NSError *error = nil;
2042*a325d9c4SApple OSS Distributions
2043*a325d9c4SApple OSS Distributions		switch (kcdata_iter_type(iter)) {
2044*a325d9c4SApple OSS Distributions
2045*a325d9c4SApple OSS Distributions		case KCDATA_TYPE_CONTAINER_BEGIN: {
2046*a325d9c4SApple OSS Distributions			T_QUIET;
2047*a325d9c4SApple OSS Distributions			T_ASSERT_TRUE(kcdata_iter_container_valid(iter),
2048*a325d9c4SApple OSS Distributions					"checked that container is valid");
2049*a325d9c4SApple OSS Distributions
2050*a325d9c4SApple OSS Distributions			if (kcdata_iter_container_type(iter) != STACKSHOT_KCCONTAINER_THREAD) {
2051*a325d9c4SApple OSS Distributions				break;
2052*a325d9c4SApple OSS Distributions			}
2053*a325d9c4SApple OSS Distributions
2054*a325d9c4SApple OSS Distributions			NSDictionary *container = parseKCDataContainer(&iter, &error);
2055*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_NOTNULL(container, "parsed container from stackshot");
2056*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_NULL(error, "error unset after parsing container");
2057*a325d9c4SApple OSS Distributions
2058*a325d9c4SApple OSS Distributions			int tg = [container[@"thread_snapshots"][@"thread_group"] intValue];
2059*a325d9c4SApple OSS Distributions
2060*a325d9c4SApple OSS Distributions			T_ASSERT_TRUE([thread_groups containsObject:@(tg)], "check that the thread group the thread is in exists");
2061*a325d9c4SApple OSS Distributions
2062*a325d9c4SApple OSS Distributions			break;
2063*a325d9c4SApple OSS Distributions		};
2064*a325d9c4SApple OSS Distributions
2065*a325d9c4SApple OSS Distributions		}
2066*a325d9c4SApple OSS Distributions	}
2067*a325d9c4SApple OSS Distributions	T_ASSERT_TRUE(seen_thread_group_snapshot, "check that we have seen a thread group snapshot");
2068*a325d9c4SApple OSS Distributions}
2069*a325d9c4SApple OSS Distributions
2070*a325d9c4SApple OSS Distributionsstatic void
2071*a325d9c4SApple OSS Distributionsverify_stackshot_sharedcache_layout(struct dyld_uuid_info_64 *uuids, uint32_t uuid_count)
2072*a325d9c4SApple OSS Distributions{
2073*a325d9c4SApple OSS Distributions	uuid_t cur_shared_cache_uuid;
2074*a325d9c4SApple OSS Distributions	__block uint32_t lib_index = 0, libs_found = 0;
2075*a325d9c4SApple OSS Distributions
2076*a325d9c4SApple OSS Distributions	_dyld_get_shared_cache_uuid(cur_shared_cache_uuid);
2077*a325d9c4SApple OSS Distributions	int result = dyld_shared_cache_iterate_text(cur_shared_cache_uuid, ^(const dyld_shared_cache_dylib_text_info* info) {
2078*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_LT(lib_index, uuid_count, "dyld_shared_cache_iterate_text exceeded number of libraries returned by kernel");
2079*a325d9c4SApple OSS Distributions
2080*a325d9c4SApple OSS Distributions			libs_found++;
2081*a325d9c4SApple OSS Distributions			struct dyld_uuid_info_64 *cur_stackshot_uuid_entry = &uuids[lib_index];
2082*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_EQ(memcmp(info->dylibUuid, cur_stackshot_uuid_entry->imageUUID, sizeof(info->dylibUuid)), 0,
2083*a325d9c4SApple OSS Distributions					"dyld returned UUID doesn't match kernel returned UUID");
2084*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_EQ(info->loadAddressUnslid, cur_stackshot_uuid_entry->imageLoadAddress,
2085*a325d9c4SApple OSS Distributions					"dyld returned load address doesn't match kernel returned load address");
2086*a325d9c4SApple OSS Distributions			lib_index++;
2087*a325d9c4SApple OSS Distributions		});
2088*a325d9c4SApple OSS Distributions
2089*a325d9c4SApple OSS Distributions	T_ASSERT_EQ(result, 0, "iterate shared cache layout");
2090*a325d9c4SApple OSS Distributions	T_ASSERT_EQ(libs_found, uuid_count, "dyld iterator returned same number of libraries as kernel");
2091*a325d9c4SApple OSS Distributions
2092*a325d9c4SApple OSS Distributions	T_LOG("verified %d libraries from dyld shared cache", libs_found);
2093*a325d9c4SApple OSS Distributions}
2094*a325d9c4SApple OSS Distributions
2095*a325d9c4SApple OSS Distributionsstatic void
2096*a325d9c4SApple OSS Distributionscheck_shared_cache_uuid(uuid_t imageUUID)
2097*a325d9c4SApple OSS Distributions{
2098*a325d9c4SApple OSS Distributions	static uuid_t shared_cache_uuid;
2099*a325d9c4SApple OSS Distributions	static dispatch_once_t read_shared_cache_uuid;
2100*a325d9c4SApple OSS Distributions
2101*a325d9c4SApple OSS Distributions	dispatch_once(&read_shared_cache_uuid, ^{
2102*a325d9c4SApple OSS Distributions		T_QUIET;
2103*a325d9c4SApple OSS Distributions		T_ASSERT_TRUE(_dyld_get_shared_cache_uuid(shared_cache_uuid), "retrieve current shared cache UUID");
2104*a325d9c4SApple OSS Distributions	});
2105*a325d9c4SApple OSS Distributions	T_QUIET; T_ASSERT_EQ(uuid_compare(shared_cache_uuid, imageUUID), 0,
2106*a325d9c4SApple OSS Distributions			"dyld returned UUID doesn't match kernel returned UUID for system shared cache");
2107*a325d9c4SApple OSS Distributions}
2108*a325d9c4SApple OSS Distributions
2109*a325d9c4SApple OSS Distributions/*
2110*a325d9c4SApple OSS Distributions * extra dictionary contains data relevant for the given flags:
2111*a325d9c4SApple OSS Distributions * PARSE_STACKSHOT_ZOMBIE:   zombie_child_pid_key -> @(pid)
2112*a325d9c4SApple OSS Distributions * PARSE_STACKSHOT_POSTEXEC: postexec_child_unique_pid_key -> @(unique_pid)
2113*a325d9c4SApple OSS Distributions */
2114*a325d9c4SApple OSS Distributionsstatic void
2115*a325d9c4SApple OSS Distributionsparse_stackshot(uint64_t stackshot_parsing_flags, void *ssbuf, size_t sslen, NSDictionary *extra)
2116*a325d9c4SApple OSS Distributions{
2117*a325d9c4SApple OSS Distributions	bool delta = (stackshot_parsing_flags & PARSE_STACKSHOT_DELTA);
2118*a325d9c4SApple OSS Distributions	bool expect_sharedcache_child = (stackshot_parsing_flags & PARSE_STACKSHOT_SHAREDCACHE_FLAGS);
2119*a325d9c4SApple OSS Distributions	bool expect_zombie_child = (stackshot_parsing_flags & PARSE_STACKSHOT_ZOMBIE);
2120*a325d9c4SApple OSS Distributions	bool expect_postexec_child = (stackshot_parsing_flags & PARSE_STACKSHOT_POSTEXEC);
2121*a325d9c4SApple OSS Distributions	bool expect_cseg_waitinfo = (stackshot_parsing_flags & PARSE_STACKSHOT_WAITINFO_CSEG);
2122*a325d9c4SApple OSS Distributions	bool expect_translated_child = (stackshot_parsing_flags & PARSE_STACKSHOT_TRANSLATED);
2123*a325d9c4SApple OSS Distributions	bool expect_shared_cache_layout = false;
2124*a325d9c4SApple OSS Distributions	bool expect_shared_cache_uuid = !delta;
2125*a325d9c4SApple OSS Distributions	bool expect_dispatch_queue_label = (stackshot_parsing_flags & PARSE_STACKSHOT_DISPATCH_QUEUE_LABEL);
2126*a325d9c4SApple OSS Distributions	bool expect_turnstile_lock = (stackshot_parsing_flags & PARSE_STACKSHOT_TURNSTILEINFO);
2127*a325d9c4SApple OSS Distributions	bool expect_srp_waitinfo = (stackshot_parsing_flags & PARSE_STACKSHOT_WAITINFO_SRP);
2128*a325d9c4SApple OSS Distributions	bool expect_exec_inprogress = (stackshot_parsing_flags & PARSE_STACKSHOT_EXEC_INPROGRESS);
2129*a325d9c4SApple OSS Distributions	bool expect_transitioning_task = (stackshot_parsing_flags & PARSE_STACKSHOT_TRANSITIONING);
2130*a325d9c4SApple OSS Distributions	bool expect_asyncstack = (stackshot_parsing_flags & PARSE_STACKSHOT_ASYNCSTACK);
2131*a325d9c4SApple OSS Distributions	bool found_zombie_child = false, found_postexec_child = false, found_shared_cache_layout = false, found_shared_cache_uuid = false;
2132*a325d9c4SApple OSS Distributions	bool found_translated_child = false, found_transitioning_task = false;
2133*a325d9c4SApple OSS Distributions	bool found_dispatch_queue_label = false, found_turnstile_lock = false;
2134*a325d9c4SApple OSS Distributions	bool found_cseg_waitinfo = false, found_srp_waitinfo = false;
2135*a325d9c4SApple OSS Distributions	bool found_sharedcache_child = false, found_sharedcache_badflags = false, found_sharedcache_self = false;
2136*a325d9c4SApple OSS Distributions	bool found_asyncstack = false;
2137*a325d9c4SApple OSS Distributions	uint64_t srp_expected_threadid = 0;
2138*a325d9c4SApple OSS Distributions	pid_t zombie_child_pid = -1, srp_expected_pid = -1, sharedcache_child_pid = -1;
2139*a325d9c4SApple OSS Distributions	pid_t translated_child_pid = -1, transistioning_task_pid = -1;
2140*a325d9c4SApple OSS Distributions	bool sharedcache_child_sameaddr = false;
2141*a325d9c4SApple OSS Distributions	uint64_t postexec_child_unique_pid = 0, cseg_expected_threadid = 0;
2142*a325d9c4SApple OSS Distributions	uint64_t sharedcache_child_flags = 0, sharedcache_self_flags = 0;
2143*a325d9c4SApple OSS Distributions	uint64_t asyncstack_threadid = 0;
2144*a325d9c4SApple OSS Distributions	NSArray *asyncstack_stack = nil;
2145*a325d9c4SApple OSS Distributions	char *inflatedBufferBase = NULL;
2146*a325d9c4SApple OSS Distributions	pid_t exec_inprogress_pid = -1;
2147*a325d9c4SApple OSS Distributions	void (^exec_inprogress_cb)(uint64_t, uint64_t) = NULL;
2148*a325d9c4SApple OSS Distributions	int exec_inprogress_found = 0;
2149*a325d9c4SApple OSS Distributions	uint64_t exec_inprogress_containerid = 0;
2150*a325d9c4SApple OSS Distributions
2151*a325d9c4SApple OSS Distributions	if (expect_shared_cache_uuid) {
2152*a325d9c4SApple OSS Distributions		uuid_t shared_cache_uuid;
2153*a325d9c4SApple OSS Distributions		if (!_dyld_get_shared_cache_uuid(shared_cache_uuid)) {
2154*a325d9c4SApple OSS Distributions			T_LOG("Skipping verifying shared cache UUID in stackshot data because not running with a shared cache");
2155*a325d9c4SApple OSS Distributions			expect_shared_cache_uuid = false;
2156*a325d9c4SApple OSS Distributions		}
2157*a325d9c4SApple OSS Distributions	}
2158*a325d9c4SApple OSS Distributions
2159*a325d9c4SApple OSS Distributions	if (stackshot_parsing_flags & PARSE_STACKSHOT_SHAREDCACHE_LAYOUT) {
2160*a325d9c4SApple OSS Distributions		size_t shared_cache_length = 0;
2161*a325d9c4SApple OSS Distributions		const void *cache_header = _dyld_get_shared_cache_range(&shared_cache_length);
2162*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_NOTNULL(cache_header, "current process running with shared cache");
2163*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_GT(shared_cache_length, sizeof(struct _dyld_cache_header), "valid shared cache length populated by _dyld_get_shared_cache_range");
2164*a325d9c4SApple OSS Distributions
2165*a325d9c4SApple OSS Distributions		if (_dyld_shared_cache_is_locally_built()) {
2166*a325d9c4SApple OSS Distributions			T_LOG("device running with locally built shared cache, expect shared cache layout");
2167*a325d9c4SApple OSS Distributions			expect_shared_cache_layout = true;
2168*a325d9c4SApple OSS Distributions		} else {
2169*a325d9c4SApple OSS Distributions			T_LOG("device running with B&I built shared-cache, no shared cache layout expected");
2170*a325d9c4SApple OSS Distributions		}
2171*a325d9c4SApple OSS Distributions	}
2172*a325d9c4SApple OSS Distributions
2173*a325d9c4SApple OSS Distributions	if (expect_sharedcache_child) {
2174*a325d9c4SApple OSS Distributions		NSNumber* pid_num = extra[sharedcache_child_pid_key];
2175*a325d9c4SApple OSS Distributions		NSNumber* sameaddr_num = extra[sharedcache_child_sameaddr_key];
2176*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_NOTNULL(pid_num, "sharedcache child pid provided");
2177*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_NOTNULL(sameaddr_num, "sharedcache child addrsame provided");
2178*a325d9c4SApple OSS Distributions		sharedcache_child_pid = [pid_num intValue];
2179*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_GT(sharedcache_child_pid, 0, "sharedcache child pid greater than zero");
2180*a325d9c4SApple OSS Distributions		sharedcache_child_sameaddr = [sameaddr_num intValue];
2181*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_GE([sameaddr_num intValue], 0, "sharedcache child sameaddr is boolean (0 or 1)");
2182*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_LE([sameaddr_num intValue], 1, "sharedcache child sameaddr is boolean (0 or 1)");
2183*a325d9c4SApple OSS Distributions	}
2184*a325d9c4SApple OSS Distributions
2185*a325d9c4SApple OSS Distributions    if (expect_transitioning_task) {
2186*a325d9c4SApple OSS Distributions        NSNumber* pid_num = extra[transitioning_pid_key];
2187*a325d9c4SApple OSS Distributions        T_ASSERT_NOTNULL(pid_num, "transitioning task pid provided");
2188*a325d9c4SApple OSS Distributions        transistioning_task_pid = [pid_num intValue];
2189*a325d9c4SApple OSS Distributions    }
2190*a325d9c4SApple OSS Distributions
2191*a325d9c4SApple OSS Distributions	if (expect_zombie_child) {
2192*a325d9c4SApple OSS Distributions		NSNumber* pid_num = extra[zombie_child_pid_key];
2193*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_NOTNULL(pid_num, "zombie child pid provided");
2194*a325d9c4SApple OSS Distributions		zombie_child_pid = [pid_num intValue];
2195*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_GT(zombie_child_pid, 0, "zombie child pid greater than zero");
2196*a325d9c4SApple OSS Distributions	}
2197*a325d9c4SApple OSS Distributions
2198*a325d9c4SApple OSS Distributions	if (expect_postexec_child) {
2199*a325d9c4SApple OSS Distributions		NSNumber* unique_pid_num = extra[postexec_child_unique_pid_key];
2200*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_NOTNULL(unique_pid_num, "postexec child unique pid provided");
2201*a325d9c4SApple OSS Distributions		postexec_child_unique_pid = [unique_pid_num unsignedLongLongValue];
2202*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_GT(postexec_child_unique_pid, 0ull, "postexec child unique pid greater than zero");
2203*a325d9c4SApple OSS Distributions	}
2204*a325d9c4SApple OSS Distributions
2205*a325d9c4SApple OSS Distributions	if (expect_cseg_waitinfo) {
2206*a325d9c4SApple OSS Distributions		NSNumber* tid_num = extra[cseg_expected_threadid_key];
2207*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_NOTNULL(tid_num, "cseg's expected thread id provided");
2208*a325d9c4SApple OSS Distributions		cseg_expected_threadid = tid_num.unsignedLongValue;
2209*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_GT(cseg_expected_threadid, UINT64_C(0), "compressor segment thread is present");
2210*a325d9c4SApple OSS Distributions	}
2211*a325d9c4SApple OSS Distributions
2212*a325d9c4SApple OSS Distributions	if (expect_srp_waitinfo) {
2213*a325d9c4SApple OSS Distributions		NSNumber* threadid_num = extra[srp_expected_threadid_key];
2214*a325d9c4SApple OSS Distributions		NSNumber* pid_num = extra[srp_expected_pid_key];
2215*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_TRUE(threadid_num != nil || pid_num != nil, "expected SRP threadid or pid");
2216*a325d9c4SApple OSS Distributions		if (threadid_num != nil) {
2217*a325d9c4SApple OSS Distributions			srp_expected_threadid = [threadid_num unsignedLongLongValue];
2218*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_GT(srp_expected_threadid, 0ull, "srp_expected_threadid greater than zero");
2219*a325d9c4SApple OSS Distributions		}
2220*a325d9c4SApple OSS Distributions		if (pid_num != nil) {
2221*a325d9c4SApple OSS Distributions			srp_expected_pid = [pid_num intValue];
2222*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_GT(srp_expected_pid, 0, "srp_expected_pid greater than zero");
2223*a325d9c4SApple OSS Distributions		}
2224*a325d9c4SApple OSS Distributions		T_LOG("looking for SRP pid: %d threadid: %llu", srp_expected_pid, srp_expected_threadid);
2225*a325d9c4SApple OSS Distributions	}
2226*a325d9c4SApple OSS Distributions
2227*a325d9c4SApple OSS Distributions	if (expect_translated_child) {
2228*a325d9c4SApple OSS Distributions		NSNumber* pid_num = extra[translated_child_pid_key];
2229*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_NOTNULL(pid_num, "translated child pid provided");
2230*a325d9c4SApple OSS Distributions		translated_child_pid = [pid_num intValue];
2231*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_GT(translated_child_pid, 0, "translated child pid greater than zero");
2232*a325d9c4SApple OSS Distributions	}
2233*a325d9c4SApple OSS Distributions	if (expect_exec_inprogress) {
2234*a325d9c4SApple OSS Distributions		NSNumber* pid_num = extra[exec_inprogress_pid_key];
2235*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_NOTNULL(pid_num, "exec inprogress pid provided");
2236*a325d9c4SApple OSS Distributions		exec_inprogress_pid = [pid_num intValue];
2237*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_GT(exec_inprogress_pid, 0, "exec inprogress pid greater than zero");
2238*a325d9c4SApple OSS Distributions
2239*a325d9c4SApple OSS Distributions		exec_inprogress_cb = extra[exec_inprogress_found_key];
2240*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_NOTNULL(exec_inprogress_cb, "exec inprogress found callback provided");
2241*a325d9c4SApple OSS Distributions	}
2242*a325d9c4SApple OSS Distributions
2243*a325d9c4SApple OSS Distributions	if (expect_asyncstack) {
2244*a325d9c4SApple OSS Distributions		NSNumber* threadid_id = extra[asyncstack_expected_threadid_key];
2245*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_NOTNULL(threadid_id, "asyncstack threadid provided");
2246*a325d9c4SApple OSS Distributions		asyncstack_threadid = [threadid_id unsignedLongLongValue];
2247*a325d9c4SApple OSS Distributions		asyncstack_stack = extra[asyncstack_expected_stack_key];
2248*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_NOTNULL(asyncstack_stack, "asyncstack expected stack provided");
2249*a325d9c4SApple OSS Distributions	}
2250*a325d9c4SApple OSS Distributions
2251*a325d9c4SApple OSS Distributions	kcdata_iter_t iter = kcdata_iter(ssbuf, sslen);
2252*a325d9c4SApple OSS Distributions	if (delta) {
2253*a325d9c4SApple OSS Distributions		T_ASSERT_EQ(kcdata_iter_type(iter), KCDATA_BUFFER_BEGIN_DELTA_STACKSHOT,
2254*a325d9c4SApple OSS Distributions				"buffer provided is a delta stackshot");
2255*a325d9c4SApple OSS Distributions
2256*a325d9c4SApple OSS Distributions			iter = kcdata_iter_next(iter);
2257*a325d9c4SApple OSS Distributions	} else {
2258*a325d9c4SApple OSS Distributions		if (kcdata_iter_type(iter) != KCDATA_BUFFER_BEGIN_COMPRESSED) {
2259*a325d9c4SApple OSS Distributions			T_ASSERT_EQ(kcdata_iter_type(iter), KCDATA_BUFFER_BEGIN_STACKSHOT,
2260*a325d9c4SApple OSS Distributions					"buffer provided is a stackshot");
2261*a325d9c4SApple OSS Distributions
2262*a325d9c4SApple OSS Distributions			iter = kcdata_iter_next(iter);
2263*a325d9c4SApple OSS Distributions		} else {
2264*a325d9c4SApple OSS Distributions			/* we are dealing with a compressed buffer */
2265*a325d9c4SApple OSS Distributions			iter = kcdata_iter_next(iter);
2266*a325d9c4SApple OSS Distributions			uint64_t compression_type = 0, totalout = 0, totalin = 0;
2267*a325d9c4SApple OSS Distributions
2268*a325d9c4SApple OSS Distributions			uint64_t *data;
2269*a325d9c4SApple OSS Distributions			char *desc;
2270*a325d9c4SApple OSS Distributions			for (int i = 0; i < 3; i ++) {
2271*a325d9c4SApple OSS Distributions				kcdata_iter_get_data_with_desc(iter, &desc, (void **)&data, NULL);
2272*a325d9c4SApple OSS Distributions				if (strcmp(desc, "kcd_c_type") == 0) {
2273*a325d9c4SApple OSS Distributions					compression_type = *data;
2274*a325d9c4SApple OSS Distributions				} else if (strcmp(desc, "kcd_c_totalout") == 0){
2275*a325d9c4SApple OSS Distributions					totalout = *data;
2276*a325d9c4SApple OSS Distributions				} else if (strcmp(desc, "kcd_c_totalin") == 0){
2277*a325d9c4SApple OSS Distributions					totalin = *data;
2278*a325d9c4SApple OSS Distributions				}
2279*a325d9c4SApple OSS Distributions
2280*a325d9c4SApple OSS Distributions				iter = kcdata_iter_next(iter);
2281*a325d9c4SApple OSS Distributions			}
2282*a325d9c4SApple OSS Distributions
2283*a325d9c4SApple OSS Distributions			T_ASSERT_EQ(compression_type, UINT64_C(1), "zlib compression is used");
2284*a325d9c4SApple OSS Distributions			T_ASSERT_GT(totalout, UINT64_C(0), "successfully gathered how long the compressed buffer is");
2285*a325d9c4SApple OSS Distributions			T_ASSERT_GT(totalin, UINT64_C(0), "successfully gathered how long the uncompressed buffer will be at least");
2286*a325d9c4SApple OSS Distributions
2287*a325d9c4SApple OSS Distributions			/* progress to the next kcdata item */
2288*a325d9c4SApple OSS Distributions			T_ASSERT_EQ(kcdata_iter_type(iter), KCDATA_BUFFER_BEGIN_STACKSHOT, "compressed stackshot found");
2289*a325d9c4SApple OSS Distributions
2290*a325d9c4SApple OSS Distributions			char *bufferBase = kcdata_iter_payload(iter);
2291*a325d9c4SApple OSS Distributions
2292*a325d9c4SApple OSS Distributions			/*
2293*a325d9c4SApple OSS Distributions			 * zlib is used, allocate a buffer based on the metadata, plus
2294*a325d9c4SApple OSS Distributions			 * extra scratch space (+12.5%) in case totalin was inconsistent
2295*a325d9c4SApple OSS Distributions			 */
2296*a325d9c4SApple OSS Distributions			size_t inflatedBufferSize = totalin + (totalin >> 3);
2297*a325d9c4SApple OSS Distributions			inflatedBufferBase = malloc(inflatedBufferSize);
2298*a325d9c4SApple OSS Distributions			T_QUIET; T_WITH_ERRNO; T_ASSERT_NOTNULL(inflatedBufferBase, "allocated temporary output buffer");
2299*a325d9c4SApple OSS Distributions
2300*a325d9c4SApple OSS Distributions			z_stream zs;
2301*a325d9c4SApple OSS Distributions			memset(&zs, 0, sizeof(zs));
2302*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_EQ(inflateInit(&zs), Z_OK, "inflateInit OK");
2303*a325d9c4SApple OSS Distributions			zs.next_in = (unsigned char *)bufferBase;
2304*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_LE(totalout, (uint64_t)UINT_MAX, "stackshot is not too large");
2305*a325d9c4SApple OSS Distributions			zs.avail_in = (uInt)totalout;
2306*a325d9c4SApple OSS Distributions			zs.next_out = (unsigned char *)inflatedBufferBase;
2307*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_LE(inflatedBufferSize, (size_t)UINT_MAX, "output region is not too large");
2308*a325d9c4SApple OSS Distributions			zs.avail_out = (uInt)inflatedBufferSize;
2309*a325d9c4SApple OSS Distributions			T_ASSERT_EQ(inflate(&zs, Z_FINISH), Z_STREAM_END, "inflated buffer");
2310*a325d9c4SApple OSS Distributions			inflateEnd(&zs);
2311*a325d9c4SApple OSS Distributions
2312*a325d9c4SApple OSS Distributions			T_ASSERT_EQ((uint64_t)zs.total_out, totalin, "expected number of bytes inflated");
2313*a325d9c4SApple OSS Distributions
2314*a325d9c4SApple OSS Distributions			/* copy the data after the compressed area */
2315*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_GE((void *)bufferBase, ssbuf,
2316*a325d9c4SApple OSS Distributions					"base of compressed stackshot is after the returned stackshot buffer");
2317*a325d9c4SApple OSS Distributions			size_t header_size = (size_t)(bufferBase - (char *)ssbuf);
2318*a325d9c4SApple OSS Distributions			size_t data_after_compressed_size = sslen - totalout - header_size;
2319*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_LE(data_after_compressed_size,
2320*a325d9c4SApple OSS Distributions					inflatedBufferSize - zs.total_out,
2321*a325d9c4SApple OSS Distributions					"footer fits in the buffer");
2322*a325d9c4SApple OSS Distributions			memcpy(inflatedBufferBase + zs.total_out,
2323*a325d9c4SApple OSS Distributions					bufferBase + totalout,
2324*a325d9c4SApple OSS Distributions					data_after_compressed_size);
2325*a325d9c4SApple OSS Distributions
2326*a325d9c4SApple OSS Distributions			iter = kcdata_iter(inflatedBufferBase, inflatedBufferSize);
2327*a325d9c4SApple OSS Distributions		}
2328*a325d9c4SApple OSS Distributions	}
2329*a325d9c4SApple OSS Distributions
2330*a325d9c4SApple OSS Distributions	KCDATA_ITER_FOREACH(iter) {
2331*a325d9c4SApple OSS Distributions		NSError *error = nil;
2332*a325d9c4SApple OSS Distributions
2333*a325d9c4SApple OSS Distributions		switch (kcdata_iter_type(iter)) {
2334*a325d9c4SApple OSS Distributions		case KCDATA_TYPE_ARRAY: {
2335*a325d9c4SApple OSS Distributions			T_QUIET;
2336*a325d9c4SApple OSS Distributions			T_ASSERT_TRUE(kcdata_iter_array_valid(iter),
2337*a325d9c4SApple OSS Distributions					"checked that array is valid");
2338*a325d9c4SApple OSS Distributions
2339*a325d9c4SApple OSS Distributions			NSMutableDictionary *array = parseKCDataArray(iter, &error);
2340*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_NOTNULL(array, "parsed array from stackshot");
2341*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_NULL(error, "error unset after parsing array");
2342*a325d9c4SApple OSS Distributions
2343*a325d9c4SApple OSS Distributions			if (kcdata_iter_array_elem_type(iter) == STACKSHOT_KCTYPE_SYS_SHAREDCACHE_LAYOUT) {
2344*a325d9c4SApple OSS Distributions				struct dyld_uuid_info_64 *shared_cache_uuids = kcdata_iter_payload(iter);
2345*a325d9c4SApple OSS Distributions				uint32_t uuid_count = kcdata_iter_array_elem_count(iter);
2346*a325d9c4SApple OSS Distributions				T_ASSERT_NOTNULL(shared_cache_uuids, "parsed shared cache layout array");
2347*a325d9c4SApple OSS Distributions				T_ASSERT_GT(uuid_count, 0, "returned valid number of UUIDs from shared cache");
2348*a325d9c4SApple OSS Distributions				verify_stackshot_sharedcache_layout(shared_cache_uuids, uuid_count);
2349*a325d9c4SApple OSS Distributions				found_shared_cache_layout = true;
2350*a325d9c4SApple OSS Distributions			}
2351*a325d9c4SApple OSS Distributions
2352*a325d9c4SApple OSS Distributions			break;
2353*a325d9c4SApple OSS Distributions		}
2354*a325d9c4SApple OSS Distributions
2355*a325d9c4SApple OSS Distributions		case KCDATA_TYPE_CONTAINER_BEGIN: {
2356*a325d9c4SApple OSS Distributions			T_QUIET;
2357*a325d9c4SApple OSS Distributions			T_ASSERT_TRUE(kcdata_iter_container_valid(iter),
2358*a325d9c4SApple OSS Distributions					"checked that container is valid");
2359*a325d9c4SApple OSS Distributions
2360*a325d9c4SApple OSS Distributions			uint64_t containerid = kcdata_iter_container_id(iter);
2361*a325d9c4SApple OSS Distributions			uint32_t container_type = kcdata_iter_container_type(iter) ;
2362*a325d9c4SApple OSS Distributions
2363*a325d9c4SApple OSS Distributions			/*
2364*a325d9c4SApple OSS Distributions			 * treat containers other than tasks/transitioning_tasks
2365*a325d9c4SApple OSS Distributions			 * as expanded in-line.
2366*a325d9c4SApple OSS Distributions			 */
2367*a325d9c4SApple OSS Distributions			if (container_type != STACKSHOT_KCCONTAINER_TASK &&
2368*a325d9c4SApple OSS Distributions			    container_type != STACKSHOT_KCCONTAINER_TRANSITIONING_TASK) {
2369*a325d9c4SApple OSS Distributions				break;
2370*a325d9c4SApple OSS Distributions			}
2371*a325d9c4SApple OSS Distributions			NSDictionary *container = parseKCDataContainer(&iter, &error);
2372*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_NOTNULL(container, "parsed container from stackshot");
2373*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_NULL(error, "error unset after parsing container");
2374*a325d9c4SApple OSS Distributions
2375*a325d9c4SApple OSS Distributions			NSDictionary* task_snapshot = container[@"task_snapshots"][@"task_snapshot"];
2376*a325d9c4SApple OSS Distributions			NSDictionary* task_delta_snapshot = container[@"task_snapshots"][@"task_delta_snapshot"];
2377*a325d9c4SApple OSS Distributions			NSDictionary* transitioning_task_snapshot = container[@"transitioning_task_snapshots"][@"transitioning_task_snapshot"];
2378*a325d9c4SApple OSS Distributions
2379*a325d9c4SApple OSS Distributions			/*
2380*a325d9c4SApple OSS Distributions			 * Having processed the container, we now only check it
2381*a325d9c4SApple OSS Distributions			 * if it's the correct type.
2382*a325d9c4SApple OSS Distributions			 */
2383*a325d9c4SApple OSS Distributions			if ((!expect_transitioning_task && (container_type != STACKSHOT_KCCONTAINER_TASK)) ||
2384*a325d9c4SApple OSS Distributions			    (expect_transitioning_task && (container_type != STACKSHOT_KCCONTAINER_TRANSITIONING_TASK))) {
2385*a325d9c4SApple OSS Distributions				break;
2386*a325d9c4SApple OSS Distributions			}
2387*a325d9c4SApple OSS Distributions			if (!expect_transitioning_task) {
2388*a325d9c4SApple OSS Distributions			    	T_QUIET; T_ASSERT_TRUE(!!task_snapshot != !!task_delta_snapshot, "Either task_snapshot xor task_delta_snapshot provided");
2389*a325d9c4SApple OSS Distributions			}
2390*a325d9c4SApple OSS Distributions
2391*a325d9c4SApple OSS Distributions			if (expect_dispatch_queue_label && !found_dispatch_queue_label) {
2392*a325d9c4SApple OSS Distributions				for (id thread_key in container[@"task_snapshots"][@"thread_snapshots"]) {
2393*a325d9c4SApple OSS Distributions					NSMutableDictionary *thread = container[@"task_snapshots"][@"thread_snapshots"][thread_key];
2394*a325d9c4SApple OSS Distributions					NSString *dql = thread[@"dispatch_queue_label"];
2395*a325d9c4SApple OSS Distributions
2396*a325d9c4SApple OSS Distributions					if ([dql isEqualToString:@TEST_STACKSHOT_QUEUE_LABEL]) {
2397*a325d9c4SApple OSS Distributions						found_dispatch_queue_label = true;
2398*a325d9c4SApple OSS Distributions						break;
2399*a325d9c4SApple OSS Distributions					}
2400*a325d9c4SApple OSS Distributions				}
2401*a325d9c4SApple OSS Distributions			}
2402*a325d9c4SApple OSS Distributions
2403*a325d9c4SApple OSS Distributions			if (expect_transitioning_task && !found_transitioning_task) {
2404*a325d9c4SApple OSS Distributions				if (transitioning_task_snapshot) {
2405*a325d9c4SApple OSS Distributions					uint64_t the_pid = [transitioning_task_snapshot[@"tts_pid"] unsignedLongLongValue];
2406*a325d9c4SApple OSS Distributions					if (the_pid == (uint64_t)transistioning_task_pid) {
2407*a325d9c4SApple OSS Distributions					    found_transitioning_task = true;
2408*a325d9c4SApple OSS Distributions					    T_PASS("FOUND Transitioning task %llu has a transitioning task snapshot", (uint64_t) transistioning_task_pid);
2409*a325d9c4SApple OSS Distributions					    break;
2410*a325d9c4SApple OSS Distributions					}
2411*a325d9c4SApple OSS Distributions				}
2412*a325d9c4SApple OSS Distributions			}
2413*a325d9c4SApple OSS Distributions
2414*a325d9c4SApple OSS Distributions			if (expect_postexec_child && !found_postexec_child) {
2415*a325d9c4SApple OSS Distributions				if (task_snapshot) {
2416*a325d9c4SApple OSS Distributions					uint64_t unique_pid = [task_snapshot[@"ts_unique_pid"] unsignedLongLongValue];
2417*a325d9c4SApple OSS Distributions					if (unique_pid == postexec_child_unique_pid) {
2418*a325d9c4SApple OSS Distributions						found_postexec_child = true;
2419*a325d9c4SApple OSS Distributions
2420*a325d9c4SApple OSS Distributions						T_PASS("post-exec child %llu has a task snapshot", postexec_child_unique_pid);
2421*a325d9c4SApple OSS Distributions
2422*a325d9c4SApple OSS Distributions						break;
2423*a325d9c4SApple OSS Distributions					}
2424*a325d9c4SApple OSS Distributions				}
2425*a325d9c4SApple OSS Distributions
2426*a325d9c4SApple OSS Distributions				if (task_delta_snapshot) {
2427*a325d9c4SApple OSS Distributions					uint64_t unique_pid = [task_delta_snapshot[@"tds_unique_pid"] unsignedLongLongValue];
2428*a325d9c4SApple OSS Distributions					if (unique_pid == postexec_child_unique_pid) {
2429*a325d9c4SApple OSS Distributions						found_postexec_child = true;
2430*a325d9c4SApple OSS Distributions
2431*a325d9c4SApple OSS Distributions						T_FAIL("post-exec child %llu shouldn't have a delta task snapshot", postexec_child_unique_pid);
2432*a325d9c4SApple OSS Distributions
2433*a325d9c4SApple OSS Distributions						break;
2434*a325d9c4SApple OSS Distributions					}
2435*a325d9c4SApple OSS Distributions				}
2436*a325d9c4SApple OSS Distributions			}
2437*a325d9c4SApple OSS Distributions
2438*a325d9c4SApple OSS Distributions			if (!task_snapshot) {
2439*a325d9c4SApple OSS Distributions				break;
2440*a325d9c4SApple OSS Distributions			}
2441*a325d9c4SApple OSS Distributions
2442*a325d9c4SApple OSS Distributions			int pid = [task_snapshot[@"ts_pid"] intValue];
2443*a325d9c4SApple OSS Distributions
2444*a325d9c4SApple OSS Distributions			if (pid && expect_shared_cache_uuid && !found_shared_cache_uuid) {
2445*a325d9c4SApple OSS Distributions				id ptr = container[@"task_snapshots"][@"shared_cache_dyld_load_info"];
2446*a325d9c4SApple OSS Distributions				if (ptr) {
2447*a325d9c4SApple OSS Distributions					id uuid = ptr[@"imageUUID"];
2448*a325d9c4SApple OSS Distributions
2449*a325d9c4SApple OSS Distributions					uint8_t uuid_p[16];
2450*a325d9c4SApple OSS Distributions					for (unsigned int i = 0; i < 16; i ++) {
2451*a325d9c4SApple OSS Distributions						NSNumber *uuidByte = uuid[i];
2452*a325d9c4SApple OSS Distributions						uuid_p[i] = (uint8_t)uuidByte.charValue;
2453*a325d9c4SApple OSS Distributions					}
2454*a325d9c4SApple OSS Distributions
2455*a325d9c4SApple OSS Distributions					check_shared_cache_uuid(uuid_p);
2456*a325d9c4SApple OSS Distributions
2457*a325d9c4SApple OSS Distributions					uint64_t baseAddress = (uint64_t)((NSNumber *)ptr[@"imageSlidBaseAddress"]).longLongValue;
2458*a325d9c4SApple OSS Distributions					uint64_t firstMapping = (uint64_t)((NSNumber *)ptr[@"sharedCacheSlidFirstMapping"]).longLongValue;
2459*a325d9c4SApple OSS Distributions
2460*a325d9c4SApple OSS Distributions					T_EXPECT_LE(baseAddress, firstMapping,
2461*a325d9c4SApple OSS Distributions						"in per-task shared_cache_dyld_load_info, "
2462*a325d9c4SApple OSS Distributions						"baseAddress <= firstMapping");
2463*a325d9c4SApple OSS Distributions					T_EXPECT_GE(baseAddress + (7ull << 32) + (1ull << 29),
2464*a325d9c4SApple OSS Distributions						firstMapping,
2465*a325d9c4SApple OSS Distributions						"in per-task shared_cache_dyld_load_info, "
2466*a325d9c4SApple OSS Distributions						"baseAddress + 28.5gig >= firstMapping");
2467*a325d9c4SApple OSS Distributions
2468*a325d9c4SApple OSS Distributions					size_t shared_cache_len;
2469*a325d9c4SApple OSS Distributions					const void *addr = _dyld_get_shared_cache_range(&shared_cache_len);
2470*a325d9c4SApple OSS Distributions					T_EXPECT_EQ((uint64_t)addr, firstMapping,
2471*a325d9c4SApple OSS Distributions							"SlidFirstMapping should match shared_cache_range");
2472*a325d9c4SApple OSS Distributions
2473*a325d9c4SApple OSS Distributions					/*
2474*a325d9c4SApple OSS Distributions					 * check_shared_cache_uuid() will assert on failure, so if
2475*a325d9c4SApple OSS Distributions					 * we get here, then we have found the shared cache UUID
2476*a325d9c4SApple OSS Distributions					 * and it's correct
2477*a325d9c4SApple OSS Distributions					 */
2478*a325d9c4SApple OSS Distributions					found_shared_cache_uuid = true;
2479*a325d9c4SApple OSS Distributions				}
2480*a325d9c4SApple OSS Distributions			}
2481*a325d9c4SApple OSS Distributions
2482*a325d9c4SApple OSS Distributions			if (expect_sharedcache_child) {
2483*a325d9c4SApple OSS Distributions				uint64_t task_flags = [task_snapshot[@"ts_ss_flags"] unsignedLongLongValue];
2484*a325d9c4SApple OSS Distributions				uint64_t sharedregion_flags = (task_flags & (kTaskSharedRegionNone | kTaskSharedRegionSystem | kTaskSharedRegionOther));
2485*a325d9c4SApple OSS Distributions				id sharedregion_info = container[@"task_snapshots"][@"shared_cache_dyld_load_info"];
2486*a325d9c4SApple OSS Distributions				if (!found_sharedcache_badflags) {
2487*a325d9c4SApple OSS Distributions					T_QUIET; T_ASSERT_NE(sharedregion_flags, 0ll, "one of the kTaskSharedRegion flags should be set on all tasks");
2488*a325d9c4SApple OSS Distributions					bool multiple = (sharedregion_flags & (sharedregion_flags - 1)) != 0;
2489*a325d9c4SApple OSS Distributions					T_QUIET; T_ASSERT_FALSE(multiple, "only one kTaskSharedRegion flag should be set on each task");
2490*a325d9c4SApple OSS Distributions					found_sharedcache_badflags = (sharedregion_flags == 0 || multiple);
2491*a325d9c4SApple OSS Distributions				}
2492*a325d9c4SApple OSS Distributions				if (pid == 0) {
2493*a325d9c4SApple OSS Distributions					T_ASSERT_EQ(sharedregion_flags, (uint64_t)kTaskSharedRegionNone, "Kernel proc (pid 0) should have no shared region");
2494*a325d9c4SApple OSS Distributions				} else if (pid == sharedcache_child_pid) {
2495*a325d9c4SApple OSS Distributions					found_sharedcache_child = true;
2496*a325d9c4SApple OSS Distributions					sharedcache_child_flags = sharedregion_flags;
2497*a325d9c4SApple OSS Distributions				} else if (pid == getpid()) {
2498*a325d9c4SApple OSS Distributions					found_sharedcache_self = true;
2499*a325d9c4SApple OSS Distributions					sharedcache_self_flags = sharedregion_flags;
2500*a325d9c4SApple OSS Distributions				}
2501*a325d9c4SApple OSS Distributions				if (sharedregion_flags == kTaskSharedRegionOther && !(task_flags & kTaskSharedRegionInfoUnavailable)) {
2502*a325d9c4SApple OSS Distributions					T_QUIET; T_ASSERT_NOTNULL(sharedregion_info, "kTaskSharedRegionOther should have a shared_cache_dyld_load_info struct");
2503*a325d9c4SApple OSS Distributions				} else {
2504*a325d9c4SApple OSS Distributions					T_QUIET; T_ASSERT_NULL(sharedregion_info, "expect no shared_cache_dyld_load_info struct");
2505*a325d9c4SApple OSS Distributions				}
2506*a325d9c4SApple OSS Distributions			}
2507*a325d9c4SApple OSS Distributions
2508*a325d9c4SApple OSS Distributions			if (expect_zombie_child && (pid == zombie_child_pid)) {
2509*a325d9c4SApple OSS Distributions				found_zombie_child = true;
2510*a325d9c4SApple OSS Distributions
2511*a325d9c4SApple OSS Distributions				uint64_t task_flags = [task_snapshot[@"ts_ss_flags"] unsignedLongLongValue];
2512*a325d9c4SApple OSS Distributions				T_ASSERT_TRUE((task_flags & kTerminatedSnapshot) == kTerminatedSnapshot, "child zombie marked as terminated");
2513*a325d9c4SApple OSS Distributions
2514*a325d9c4SApple OSS Distributions				continue;
2515*a325d9c4SApple OSS Distributions			}
2516*a325d9c4SApple OSS Distributions
2517*a325d9c4SApple OSS Distributions			if (expect_translated_child && (pid == translated_child_pid)) {
2518*a325d9c4SApple OSS Distributions				found_translated_child = true;
2519*a325d9c4SApple OSS Distributions
2520*a325d9c4SApple OSS Distributions				uint64_t task_flags = [task_snapshot[@"ts_ss_flags"] unsignedLongLongValue];
2521*a325d9c4SApple OSS Distributions				T_EXPECT_BITS_SET(task_flags, kTaskIsTranslated, "child marked as translated");
2522*a325d9c4SApple OSS Distributions
2523*a325d9c4SApple OSS Distributions				continue;
2524*a325d9c4SApple OSS Distributions			}
2525*a325d9c4SApple OSS Distributions			if (expect_exec_inprogress && (pid == exec_inprogress_pid || pid == -exec_inprogress_pid)) {
2526*a325d9c4SApple OSS Distributions				exec_inprogress_found++;
2527*a325d9c4SApple OSS Distributions				T_LOG("found exec task with pid %d, instance %d", pid, exec_inprogress_found);
2528*a325d9c4SApple OSS Distributions				T_QUIET; T_ASSERT_LE(exec_inprogress_found, 2, "no more than two with the expected pid");
2529*a325d9c4SApple OSS Distributions				if (exec_inprogress_found == 2) {
2530*a325d9c4SApple OSS Distributions					T_LOG("found 2 tasks with pid %d", exec_inprogress_pid);
2531*a325d9c4SApple OSS Distributions					exec_inprogress_cb(containerid, exec_inprogress_containerid);
2532*a325d9c4SApple OSS Distributions				} else {
2533*a325d9c4SApple OSS Distributions					exec_inprogress_containerid = containerid;
2534*a325d9c4SApple OSS Distributions				}
2535*a325d9c4SApple OSS Distributions			}
2536*a325d9c4SApple OSS Distributions			if (expect_cseg_waitinfo) {
2537*a325d9c4SApple OSS Distributions				NSArray *winfos = container[@"task_snapshots"][@"thread_waitinfo"];
2538*a325d9c4SApple OSS Distributions
2539*a325d9c4SApple OSS Distributions				for (id i in winfos) {
2540*a325d9c4SApple OSS Distributions					NSNumber *waitType = i[@"wait_type"];
2541*a325d9c4SApple OSS Distributions					NSNumber *owner = i[@"owner"];
2542*a325d9c4SApple OSS Distributions					if (waitType.intValue == kThreadWaitCompressor &&
2543*a325d9c4SApple OSS Distributions							owner.unsignedLongValue == cseg_expected_threadid) {
2544*a325d9c4SApple OSS Distributions						found_cseg_waitinfo = true;
2545*a325d9c4SApple OSS Distributions						break;
2546*a325d9c4SApple OSS Distributions					}
2547*a325d9c4SApple OSS Distributions				}
2548*a325d9c4SApple OSS Distributions			}
2549*a325d9c4SApple OSS Distributions
2550*a325d9c4SApple OSS Distributions			if (expect_srp_waitinfo) {
2551*a325d9c4SApple OSS Distributions				NSArray *tinfos = container[@"task_snapshots"][@"thread_turnstileinfo"];
2552*a325d9c4SApple OSS Distributions				NSArray *winfos = container[@"task_snapshots"][@"thread_waitinfo"];
2553*a325d9c4SApple OSS Distributions				for (id i in tinfos) {
2554*a325d9c4SApple OSS Distributions					if (!found_srp_waitinfo) {
2555*a325d9c4SApple OSS Distributions						bool found_thread = false;
2556*a325d9c4SApple OSS Distributions						bool found_pid = false;
2557*a325d9c4SApple OSS Distributions						if (([i[@"turnstile_flags"] intValue] & STACKSHOT_TURNSTILE_STATUS_THREAD) &&
2558*a325d9c4SApple OSS Distributions						    [i[@"turnstile_context"] unsignedLongLongValue] == srp_expected_threadid &&
2559*a325d9c4SApple OSS Distributions						    srp_expected_threadid != 0) {
2560*a325d9c4SApple OSS Distributions							found_thread = true;
2561*a325d9c4SApple OSS Distributions						}
2562*a325d9c4SApple OSS Distributions						if (([i[@"turnstile_flags"] intValue] & STACKSHOT_TURNSTILE_STATUS_BLOCKED_ON_TASK) &&
2563*a325d9c4SApple OSS Distributions						    [i[@"turnstile_context"] intValue] == srp_expected_pid &&
2564*a325d9c4SApple OSS Distributions						    srp_expected_pid != -1) {
2565*a325d9c4SApple OSS Distributions							found_pid = true;
2566*a325d9c4SApple OSS Distributions						}
2567*a325d9c4SApple OSS Distributions						if (found_pid || found_thread) {
2568*a325d9c4SApple OSS Distributions							T_LOG("found SRP %s %lld waiter: %d", (found_thread ? "thread" : "pid"),
2569*a325d9c4SApple OSS Distributions							    [i[@"turnstile_context"] unsignedLongLongValue], [i[@"waiter"] intValue]);
2570*a325d9c4SApple OSS Distributions							/* we found something that is blocking the correct threadid */
2571*a325d9c4SApple OSS Distributions							for (id j in winfos) {
2572*a325d9c4SApple OSS Distributions								if ([j[@"waiter"] intValue] == [i[@"waiter"] intValue] &&
2573*a325d9c4SApple OSS Distributions								    [j[@"wait_type"] intValue] == kThreadWaitPortReceive) {
2574*a325d9c4SApple OSS Distributions									found_srp_waitinfo = true;
2575*a325d9c4SApple OSS Distributions									break;
2576*a325d9c4SApple OSS Distributions								}
2577*a325d9c4SApple OSS Distributions							}
2578*a325d9c4SApple OSS Distributions
2579*a325d9c4SApple OSS Distributions							if (found_srp_waitinfo) {
2580*a325d9c4SApple OSS Distributions								break;
2581*a325d9c4SApple OSS Distributions							}
2582*a325d9c4SApple OSS Distributions						}
2583*a325d9c4SApple OSS Distributions					}
2584*a325d9c4SApple OSS Distributions				}
2585*a325d9c4SApple OSS Distributions			}
2586*a325d9c4SApple OSS Distributions
2587*a325d9c4SApple OSS Distributions			if (pid != getpid()) {
2588*a325d9c4SApple OSS Distributions				break;
2589*a325d9c4SApple OSS Distributions			}
2590*a325d9c4SApple OSS Distributions
2591*a325d9c4SApple OSS Distributions			T_EXPECT_EQ_STR(current_process_name(),
2592*a325d9c4SApple OSS Distributions					[task_snapshot[@"ts_p_comm"] UTF8String],
2593*a325d9c4SApple OSS Distributions					"current process name matches in stackshot");
2594*a325d9c4SApple OSS Distributions
2595*a325d9c4SApple OSS Distributions			uint64_t task_flags = [task_snapshot[@"ts_ss_flags"] unsignedLongLongValue];
2596*a325d9c4SApple OSS Distributions			T_ASSERT_BITS_NOTSET(task_flags, kTerminatedSnapshot, "current process not marked as terminated");
2597*a325d9c4SApple OSS Distributions			T_ASSERT_BITS_NOTSET(task_flags, kTaskIsTranslated, "current process not marked as translated");
2598*a325d9c4SApple OSS Distributions
2599*a325d9c4SApple OSS Distributions			T_QUIET;
2600*a325d9c4SApple OSS Distributions			T_EXPECT_LE(pid, [task_snapshot[@"ts_unique_pid"] intValue],
2601*a325d9c4SApple OSS Distributions					"unique pid is greater than pid");
2602*a325d9c4SApple OSS Distributions
2603*a325d9c4SApple OSS Distributions			NSDictionary* task_cpu_architecture = container[@"task_snapshots"][@"task_cpu_architecture"];
2604*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_NOTNULL(task_cpu_architecture[@"cputype"], "have cputype");
2605*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_NOTNULL(task_cpu_architecture[@"cpusubtype"], "have cputype");
2606*a325d9c4SApple OSS Distributions			int cputype = [task_cpu_architecture[@"cputype"] intValue];
2607*a325d9c4SApple OSS Distributions			int cpusubtype = [task_cpu_architecture[@"cpusubtype"] intValue];
2608*a325d9c4SApple OSS Distributions
2609*a325d9c4SApple OSS Distributions			struct proc_archinfo archinfo;
2610*a325d9c4SApple OSS Distributions			int retval = proc_pidinfo(pid, PROC_PIDARCHINFO, 0, &archinfo, sizeof(archinfo));
2611*a325d9c4SApple OSS Distributions			T_QUIET; T_WITH_ERRNO; T_ASSERT_GT(retval, 0, "proc_pidinfo(PROC_PIDARCHINFO) returned a value > 0");
2612*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_EQ(retval, (int)sizeof(struct proc_archinfo), "proc_pidinfo call for PROC_PIDARCHINFO returned expected size");
2613*a325d9c4SApple OSS Distributions			T_QUIET; T_EXPECT_EQ(cputype, archinfo.p_cputype, "cpu type is correct");
2614*a325d9c4SApple OSS Distributions			T_QUIET; T_EXPECT_EQ(cpusubtype, archinfo.p_cpusubtype, "cpu subtype is correct");
2615*a325d9c4SApple OSS Distributions
2616*a325d9c4SApple OSS Distributions			bool found_main_thread = false;
2617*a325d9c4SApple OSS Distributions			uint64_t main_thread_id = -1ULL;
2618*a325d9c4SApple OSS Distributions			bool found_null_kernel_frame = false;
2619*a325d9c4SApple OSS Distributions			for (id thread_key in container[@"task_snapshots"][@"thread_snapshots"]) {
2620*a325d9c4SApple OSS Distributions				NSMutableDictionary *thread = container[@"task_snapshots"][@"thread_snapshots"][thread_key];
2621*a325d9c4SApple OSS Distributions				NSDictionary *thread_snap = thread[@"thread_snapshot"];
2622*a325d9c4SApple OSS Distributions
2623*a325d9c4SApple OSS Distributions				T_QUIET; T_EXPECT_GT([thread_snap[@"ths_thread_id"] intValue], 0,
2624*a325d9c4SApple OSS Distributions						"thread ID of thread in current task is valid");
2625*a325d9c4SApple OSS Distributions				T_QUIET; T_EXPECT_GT([thread_snap[@"ths_base_priority"] intValue], 0,
2626*a325d9c4SApple OSS Distributions						"base priority of thread in current task is valid");
2627*a325d9c4SApple OSS Distributions				T_QUIET; T_EXPECT_GT([thread_snap[@"ths_sched_priority"] intValue], 0,
2628*a325d9c4SApple OSS Distributions						"scheduling priority of thread in current task is valid");
2629*a325d9c4SApple OSS Distributions
2630*a325d9c4SApple OSS Distributions				NSString *pth_name = thread[@"pth_name"];
2631*a325d9c4SApple OSS Distributions				if (pth_name != nil && [pth_name isEqualToString:@TEST_THREAD_NAME]) {
2632*a325d9c4SApple OSS Distributions					found_main_thread = true;
2633*a325d9c4SApple OSS Distributions					main_thread_id = [thread_snap[@"ths_thread_id"] unsignedLongLongValue];
2634*a325d9c4SApple OSS Distributions
2635*a325d9c4SApple OSS Distributions					T_QUIET; T_EXPECT_GT([thread_snap[@"ths_total_syscalls"] intValue], 0,
2636*a325d9c4SApple OSS Distributions							"total syscalls of current thread is valid");
2637*a325d9c4SApple OSS Distributions
2638*a325d9c4SApple OSS Distributions					NSDictionary *cpu_times = thread[@"cpu_times"];
2639*a325d9c4SApple OSS Distributions					T_EXPECT_GE([cpu_times[@"runnable_time"] intValue],
2640*a325d9c4SApple OSS Distributions							[cpu_times[@"system_time"] intValue] +
2641*a325d9c4SApple OSS Distributions							[cpu_times[@"user_time"] intValue],
2642*a325d9c4SApple OSS Distributions							"runnable time of current thread is valid");
2643*a325d9c4SApple OSS Distributions				}
2644*a325d9c4SApple OSS Distributions				if (!found_null_kernel_frame) {
2645*a325d9c4SApple OSS Distributions					for (NSNumber *frame in thread[@"kernel_frames"]) {
2646*a325d9c4SApple OSS Distributions						if (frame.unsignedLongValue == 0) {
2647*a325d9c4SApple OSS Distributions							found_null_kernel_frame = true;
2648*a325d9c4SApple OSS Distributions							break;
2649*a325d9c4SApple OSS Distributions						}
2650*a325d9c4SApple OSS Distributions					}
2651*a325d9c4SApple OSS Distributions				}
2652*a325d9c4SApple OSS Distributions				if (expect_asyncstack && !found_asyncstack &&
2653*a325d9c4SApple OSS Distributions				    asyncstack_threadid == [thread_snap[@"ths_thread_id"] unsignedLongLongValue]) {
2654*a325d9c4SApple OSS Distributions					found_asyncstack = true;
2655*a325d9c4SApple OSS Distributions					NSArray* async_stack = thread[@"user_async_stack_frames"];
2656*a325d9c4SApple OSS Distributions					NSNumber* start_idx = thread[@"user_async_start_index"];
2657*a325d9c4SApple OSS Distributions					NSArray* user_stack = thread[@"user_stack_frames"];
2658*a325d9c4SApple OSS Distributions					T_QUIET; T_ASSERT_NOTNULL(async_stack, "async thread %#llx has user_async_stack_frames", asyncstack_threadid);
2659*a325d9c4SApple OSS Distributions					T_QUIET; T_ASSERT_NOTNULL(start_idx, "async thread %#llx has user_async_start_index", asyncstack_threadid);
2660*a325d9c4SApple OSS Distributions					T_QUIET; T_ASSERT_NOTNULL(user_stack, "async thread %#llx has user_stack_frames", asyncstack_threadid);
2661*a325d9c4SApple OSS Distributions					T_QUIET; T_ASSERT_EQ(async_stack.count, asyncstack_stack.count,
2662*a325d9c4SApple OSS Distributions						"actual async_stack count == expected async_stack count");
2663*a325d9c4SApple OSS Distributions					for (size_t i = 0; i < async_stack.count; i++) {
2664*a325d9c4SApple OSS Distributions						T_EXPECT_EQ([async_stack[i][@"lr"] unsignedLongLongValue],
2665*a325d9c4SApple OSS Distributions							[asyncstack_stack[i] unsignedLongLongValue], "frame %zu matches", i);
2666*a325d9c4SApple OSS Distributions					}
2667*a325d9c4SApple OSS Distributions				}
2668*a325d9c4SApple OSS Distributions			}
2669*a325d9c4SApple OSS Distributions			T_EXPECT_TRUE(found_main_thread, "found main thread for current task in stackshot");
2670*a325d9c4SApple OSS Distributions			T_EXPECT_FALSE(found_null_kernel_frame, "should not see any NULL kernel frames");
2671*a325d9c4SApple OSS Distributions
2672*a325d9c4SApple OSS Distributions			if (expect_turnstile_lock && !found_turnstile_lock) {
2673*a325d9c4SApple OSS Distributions				NSArray *tsinfos = container[@"task_snapshots"][@"thread_turnstileinfo"];
2674*a325d9c4SApple OSS Distributions
2675*a325d9c4SApple OSS Distributions				for (id i in tsinfos) {
2676*a325d9c4SApple OSS Distributions					if ([i[@"turnstile_context"] unsignedLongLongValue] == main_thread_id) {
2677*a325d9c4SApple OSS Distributions						found_turnstile_lock = true;
2678*a325d9c4SApple OSS Distributions						break;
2679*a325d9c4SApple OSS Distributions					}
2680*a325d9c4SApple OSS Distributions				}
2681*a325d9c4SApple OSS Distributions			}
2682*a325d9c4SApple OSS Distributions			break;
2683*a325d9c4SApple OSS Distributions		}
2684*a325d9c4SApple OSS Distributions		case STACKSHOT_KCTYPE_SHAREDCACHE_LOADINFO: {
2685*a325d9c4SApple OSS Distributions			struct dyld_shared_cache_loadinfo *payload = kcdata_iter_payload(iter);
2686*a325d9c4SApple OSS Distributions			T_ASSERT_EQ((size_t)kcdata_iter_size(iter), sizeof(*payload), "valid dyld_shared_cache_loadinfo struct");
2687*a325d9c4SApple OSS Distributions
2688*a325d9c4SApple OSS Distributions			check_shared_cache_uuid(payload->sharedCacheUUID);
2689*a325d9c4SApple OSS Distributions
2690*a325d9c4SApple OSS Distributions			T_EXPECT_LE(payload->sharedCacheUnreliableSlidBaseAddress,
2691*a325d9c4SApple OSS Distributions				payload->sharedCacheSlidFirstMapping,
2692*a325d9c4SApple OSS Distributions				"SlidBaseAddress <= SlidFirstMapping");
2693*a325d9c4SApple OSS Distributions			T_EXPECT_GE(payload->sharedCacheUnreliableSlidBaseAddress + (7ull << 32) + (1ull << 29),
2694*a325d9c4SApple OSS Distributions				payload->sharedCacheSlidFirstMapping,
2695*a325d9c4SApple OSS Distributions				"SlidFirstMapping should be within 28.5gigs of SlidBaseAddress");
2696*a325d9c4SApple OSS Distributions
2697*a325d9c4SApple OSS Distributions			size_t shared_cache_len;
2698*a325d9c4SApple OSS Distributions			const void *addr = _dyld_get_shared_cache_range(&shared_cache_len);
2699*a325d9c4SApple OSS Distributions			T_EXPECT_EQ((uint64_t)addr, payload->sharedCacheSlidFirstMapping,
2700*a325d9c4SApple OSS Distributions			    "SlidFirstMapping should match shared_cache_range");
2701*a325d9c4SApple OSS Distributions
2702*a325d9c4SApple OSS Distributions			/*
2703*a325d9c4SApple OSS Distributions			 * check_shared_cache_uuid() asserts on failure, so we must have
2704*a325d9c4SApple OSS Distributions			 * found the shared cache UUID to be correct.
2705*a325d9c4SApple OSS Distributions			 */
2706*a325d9c4SApple OSS Distributions			found_shared_cache_uuid = true;
2707*a325d9c4SApple OSS Distributions			break;
2708*a325d9c4SApple OSS Distributions		}
2709*a325d9c4SApple OSS Distributions		}
2710*a325d9c4SApple OSS Distributions	}
2711*a325d9c4SApple OSS Distributions
2712*a325d9c4SApple OSS Distributions	if (expect_sharedcache_child) {
2713*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_TRUE(found_sharedcache_child, "found sharedcache child in kcdata");
2714*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_TRUE(found_sharedcache_self, "found self in kcdata");
2715*a325d9c4SApple OSS Distributions		if (found_sharedcache_child && found_sharedcache_self) {
2716*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_NE(sharedcache_child_flags, (uint64_t)kTaskSharedRegionNone, "sharedcache child should have shared region");
2717*a325d9c4SApple OSS Distributions			T_QUIET; T_ASSERT_NE(sharedcache_self_flags, (uint64_t)kTaskSharedRegionNone, "sharedcache: self should have shared region");
2718*a325d9c4SApple OSS Distributions			if (sharedcache_self_flags == kTaskSharedRegionSystem && !sharedcache_child_sameaddr) {
2719*a325d9c4SApple OSS Distributions				/* If we're in the system shared region, and the child has a different address, child must have an Other shared region */
2720*a325d9c4SApple OSS Distributions				T_ASSERT_EQ(sharedcache_child_flags, (uint64_t)kTaskSharedRegionOther,
2721*a325d9c4SApple OSS Distributions				    "sharedcache child should have Other shared region");
2722*a325d9c4SApple OSS Distributions			}
2723*a325d9c4SApple OSS Distributions		}
2724*a325d9c4SApple OSS Distributions	}
2725*a325d9c4SApple OSS Distributions
2726*a325d9c4SApple OSS Distributions	if (expect_transitioning_task) {
2727*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_TRUE(found_transitioning_task, "found transitioning_task child in kcdata");
2728*a325d9c4SApple OSS Distributions	}
2729*a325d9c4SApple OSS Distributions
2730*a325d9c4SApple OSS Distributions	if (expect_exec_inprogress) {
2731*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_GT(exec_inprogress_found, 0, "found at least 1 task for execing process");
2732*a325d9c4SApple OSS Distributions	}
2733*a325d9c4SApple OSS Distributions
2734*a325d9c4SApple OSS Distributions	if (expect_zombie_child) {
2735*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_TRUE(found_zombie_child, "found zombie child in kcdata");
2736*a325d9c4SApple OSS Distributions	}
2737*a325d9c4SApple OSS Distributions
2738*a325d9c4SApple OSS Distributions	if (expect_postexec_child) {
2739*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_TRUE(found_postexec_child, "found post-exec child in kcdata");
2740*a325d9c4SApple OSS Distributions	}
2741*a325d9c4SApple OSS Distributions
2742*a325d9c4SApple OSS Distributions	if (expect_translated_child) {
2743*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_TRUE(found_translated_child, "found translated child in kcdata");
2744*a325d9c4SApple OSS Distributions	}
2745*a325d9c4SApple OSS Distributions
2746*a325d9c4SApple OSS Distributions	if (expect_shared_cache_layout) {
2747*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_TRUE(found_shared_cache_layout, "shared cache layout found in kcdata");
2748*a325d9c4SApple OSS Distributions	}
2749*a325d9c4SApple OSS Distributions
2750*a325d9c4SApple OSS Distributions	if (expect_shared_cache_uuid) {
2751*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_TRUE(found_shared_cache_uuid, "shared cache UUID found in kcdata");
2752*a325d9c4SApple OSS Distributions	}
2753*a325d9c4SApple OSS Distributions
2754*a325d9c4SApple OSS Distributions	if (expect_dispatch_queue_label) {
2755*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_TRUE(found_dispatch_queue_label, "dispatch queue label found in kcdata");
2756*a325d9c4SApple OSS Distributions	}
2757*a325d9c4SApple OSS Distributions
2758*a325d9c4SApple OSS Distributions	if (expect_turnstile_lock) {
2759*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_TRUE(found_turnstile_lock, "found expected deadlock");
2760*a325d9c4SApple OSS Distributions	}
2761*a325d9c4SApple OSS Distributions
2762*a325d9c4SApple OSS Distributions	if (expect_cseg_waitinfo) {
2763*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_TRUE(found_cseg_waitinfo, "found c_seg waitinfo");
2764*a325d9c4SApple OSS Distributions	}
2765*a325d9c4SApple OSS Distributions
2766*a325d9c4SApple OSS Distributions	if (expect_srp_waitinfo) {
2767*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_TRUE(found_srp_waitinfo, "found special reply port waitinfo");
2768*a325d9c4SApple OSS Distributions	}
2769*a325d9c4SApple OSS Distributions
2770*a325d9c4SApple OSS Distributions	if (expect_asyncstack) {
2771*a325d9c4SApple OSS Distributions		T_QUIET; T_ASSERT_TRUE(found_asyncstack, "found async stack threadid");
2772*a325d9c4SApple OSS Distributions	}
2773*a325d9c4SApple OSS Distributions
2774*a325d9c4SApple OSS Distributions	T_ASSERT_FALSE(KCDATA_ITER_FOREACH_FAILED(iter), "successfully iterated kcdata");
2775*a325d9c4SApple OSS Distributions
2776*a325d9c4SApple OSS Distributions	free(inflatedBufferBase);
2777*a325d9c4SApple OSS Distributions}
2778*a325d9c4SApple OSS Distributions
2779*a325d9c4SApple OSS Distributionsstatic const char *
2780*a325d9c4SApple OSS Distributionscurrent_process_name(void)
2781*a325d9c4SApple OSS Distributions{
2782*a325d9c4SApple OSS Distributions	static char name[64];
2783*a325d9c4SApple OSS Distributions
2784*a325d9c4SApple OSS Distributions	if (!name[0]) {
2785*a325d9c4SApple OSS Distributions		int ret = proc_name(getpid(), name, sizeof(name));
2786*a325d9c4SApple OSS Distributions		T_QUIET;
2787*a325d9c4SApple OSS Distributions		T_ASSERT_POSIX_SUCCESS(ret, "proc_name failed for current process");
2788*a325d9c4SApple OSS Distributions	}
2789*a325d9c4SApple OSS Distributions
2790*a325d9c4SApple OSS Distributions	return name;
2791*a325d9c4SApple OSS Distributions}
2792*a325d9c4SApple OSS Distributions
2793*a325d9c4SApple OSS Distributionsstatic void
2794*a325d9c4SApple OSS Distributionsinitialize_thread(void)
2795*a325d9c4SApple OSS Distributions{
2796*a325d9c4SApple OSS Distributions	int ret = pthread_setname_np(TEST_THREAD_NAME);
2797*a325d9c4SApple OSS Distributions	T_QUIET;
2798*a325d9c4SApple OSS Distributions	T_ASSERT_POSIX_ZERO(ret, "set thread name to %s", TEST_THREAD_NAME);
2799*a325d9c4SApple OSS Distributions}
2800