1 /*
2 * Copyright (c) 2013-2020 Apple Inc. All rights reserved.
3 *
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5 *
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. The rights granted to you under the License
10 * may not be used to create, or enable the creation or redistribution of,
11 * unlawful or unlicensed copies of an Apple operating system, or to
12 * circumvent, violate, or enable the circumvention or violation of, any
13 * terms of an Apple operating system software license agreement.
14 *
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
17 *
18 * The Original Code and all software distributed under the License are
19 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23 * Please see the License for the specific language governing rights and
24 * limitations under the License.
25 *
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27 */
28
29 #include <mach/mach_types.h>
30 #include <mach/vm_param.h>
31 #include <mach/mach_vm.h>
32 #include <mach/clock_types.h>
33 #include <sys/errno.h>
34 #include <sys/stackshot.h>
35 #ifdef IMPORTANCE_INHERITANCE
36 #include <ipc/ipc_importance.h>
37 #endif
38 #include <sys/appleapiopts.h>
39 #include <kern/debug.h>
40 #include <kern/block_hint.h>
41 #include <uuid/uuid.h>
42
43 #include <kdp/kdp_dyld.h>
44 #include <kdp/kdp_en_debugger.h>
45 #include <kdp/processor_core.h>
46 #include <kdp/kdp_common.h>
47
48 #include <libsa/types.h>
49 #include <libkern/version.h>
50 #include <libkern/section_keywords.h>
51
52 #include <string.h> /* bcopy */
53
54 #include <kern/backtrace.h>
55 #include <kern/coalition.h>
56 #include <kern/processor.h>
57 #include <kern/host_statistics.h>
58 #include <kern/counter.h>
59 #include <kern/thread.h>
60 #include <kern/thread_group.h>
61 #include <kern/task.h>
62 #include <kern/telemetry.h>
63 #include <kern/clock.h>
64 #include <kern/policy_internal.h>
65 #include <kern/socd_client.h>
66 #include <vm/vm_map.h>
67 #include <vm/vm_kern.h>
68 #include <vm/vm_pageout.h>
69 #include <vm/vm_fault.h>
70 #include <vm/vm_shared_region.h>
71 #include <vm/vm_compressor.h>
72 #include <libkern/OSKextLibPrivate.h>
73 #include <os/log.h>
74
75 #if defined(__x86_64__)
76 #include <i386/mp.h>
77 #include <i386/cpu_threads.h>
78 #endif
79
80 #include <pexpert/pexpert.h>
81
82 #if CONFIG_PERVASIVE_CPI
83 #include <kern/monotonic.h>
84 #endif /* CONFIG_PERVASIVE_CPI */
85
86 #include <san/kasan.h>
87
88 #if DEBUG || DEVELOPMENT
89 # define STACKSHOT_COLLECTS_LATENCY_INFO 1
90 #else
91 # define STACKSHOT_COLLECTS_LATENCY_INFO 0
92 #endif /* DEBUG || DEVELOPMENT */
93
94 extern unsigned int not_in_kdp;
95
96 /* indicate to the compiler that some accesses are unaligned */
97 typedef uint64_t unaligned_u64 __attribute__((aligned(1)));
98
99 int kdp_snapshot = 0;
100 static kern_return_t stack_snapshot_ret = 0;
101 static uint32_t stack_snapshot_bytes_traced = 0;
102 static uint32_t stack_snapshot_bytes_uncompressed = 0;
103
104 #if STACKSHOT_COLLECTS_LATENCY_INFO
105 static bool collect_latency_info = true;
106 #endif
107 static kcdata_descriptor_t stackshot_kcdata_p = NULL;
108 static void *stack_snapshot_buf;
109 static uint32_t stack_snapshot_bufsize;
110 int stack_snapshot_pid;
111 static uint64_t stack_snapshot_flags;
112 static uint64_t stack_snapshot_delta_since_timestamp;
113 static uint32_t stack_snapshot_pagetable_mask;
114 static boolean_t panic_stackshot;
115
116 static boolean_t stack_enable_faulting = FALSE;
117 static struct stackshot_fault_stats fault_stats;
118
119 static uint64_t stackshot_last_abs_start; /* start time of last stackshot */
120 static uint64_t stackshot_last_abs_end; /* end time of last stackshot */
121 static uint64_t stackshots_taken; /* total stackshots taken since boot */
122 static uint64_t stackshots_duration; /* total abs time spent in stackshot_trap() since boot */
123
124 /*
125 * Experimentally, our current estimates are 20% short 96% of the time; 40 gets
126 * us into 99.9%+ territory. In the longer run, we need to make stackshot
127 * estimates use a better approach (rdar://78880038); this is intended to be a
128 * short-term fix.
129 */
130 uint32_t stackshot_estimate_adj = 40; /* experiment factor: 0-100, adjust our estimate up by this amount */
131
132 static uint32_t stackshot_initial_estimate;
133 static uint32_t stackshot_initial_estimate_adj;
134 static uint64_t stackshot_duration_prior_abs; /* prior attempts, abs */
135 static unaligned_u64 * stackshot_duration_outer;
136 static uint64_t stackshot_microsecs;
137
138 void * kernel_stackshot_buf = NULL; /* Pointer to buffer for stackshots triggered from the kernel and retrieved later */
139 int kernel_stackshot_buf_size = 0;
140
141 void * stackshot_snapbuf = NULL; /* Used by stack_snapshot2 (to be removed) */
142
143 __private_extern__ void stackshot_init( void );
144 static boolean_t memory_iszero(void *addr, size_t size);
145 uint32_t get_stackshot_estsize(uint32_t prev_size_hint, uint32_t adj);
146 kern_return_t kern_stack_snapshot_internal(int stackshot_config_version, void *stackshot_config,
147 size_t stackshot_config_size, boolean_t stackshot_from_user);
148 kern_return_t do_stackshot(void *);
149 void kdp_snapshot_preflight(int pid, void * tracebuf, uint32_t tracebuf_size, uint64_t flags, kcdata_descriptor_t data_p, uint64_t since_timestamp, uint32_t pagetable_mask);
150 boolean_t stackshot_thread_is_idle_worker_unsafe(thread_t thread);
151 static int kdp_stackshot_kcdata_format(int pid, uint64_t trace_flags, uint32_t *pBytesTraced, uint32_t *pBytesUncompressed);
152 uint32_t kdp_stack_snapshot_bytes_traced(void);
153 uint32_t kdp_stack_snapshot_bytes_uncompressed(void);
154 static void kdp_mem_and_io_snapshot(struct mem_and_io_snapshot *memio_snap);
155 static vm_offset_t stackshot_find_phys(vm_map_t map, vm_offset_t target_addr, kdp_fault_flags_t fault_flags, uint32_t *kdp_fault_result_flags);
156 static boolean_t stackshot_copyin(vm_map_t map, uint64_t uaddr, void *dest, size_t size, boolean_t try_fault, uint32_t *kdp_fault_result);
157 static int stackshot_copyin_string(task_t task, uint64_t addr, char *buf, int buf_sz, boolean_t try_fault, uint32_t *kdp_fault_results);
158 static boolean_t stackshot_copyin_word(task_t task, uint64_t addr, uint64_t *result, boolean_t try_fault, uint32_t *kdp_fault_results);
159 static uint64_t proc_was_throttled_from_task(task_t task);
160 static void stackshot_thread_wait_owner_info(thread_t thread, thread_waitinfo_v2_t * waitinfo);
161 static int stackshot_thread_has_valid_waitinfo(thread_t thread);
162 static void stackshot_thread_turnstileinfo(thread_t thread, thread_turnstileinfo_v2_t *tsinfo);
163 static int stackshot_thread_has_valid_turnstileinfo(thread_t thread);
164
165 #if CONFIG_COALITIONS
166 static void stackshot_coalition_jetsam_count(void *arg, int i, coalition_t coal);
167 static void stackshot_coalition_jetsam_snapshot(void *arg, int i, coalition_t coal);
168 #endif /* CONFIG_COALITIONS */
169
170 #if CONFIG_THREAD_GROUPS
171 static void stackshot_thread_group_count(void *arg, int i, struct thread_group *tg);
172 static void stackshot_thread_group_snapshot(void *arg, int i, struct thread_group *tg);
173 #endif /* CONFIG_THREAD_GROUPS */
174
175 extern uint32_t workqueue_get_pwq_state_kdp(void *proc);
176
177 struct proc;
178 extern int proc_pid(struct proc *p);
179 extern uint64_t proc_uniqueid(void *p);
180 extern uint64_t proc_was_throttled(void *p);
181 extern uint64_t proc_did_throttle(void *p);
182 extern int proc_exiting(void *p);
183 extern int proc_in_teardown(void *p);
184 static uint64_t proc_did_throttle_from_task(task_t task);
185 extern void proc_name_kdp(struct proc *p, char * buf, int size);
186 extern int proc_threadname_kdp(void * uth, char * buf, size_t size);
187 extern void proc_starttime_kdp(void * p, uint64_t * tv_sec, uint64_t * tv_usec, uint64_t * abstime);
188 extern void proc_archinfo_kdp(void* p, cpu_type_t* cputype, cpu_subtype_t* cpusubtype);
189 extern boolean_t proc_binary_uuid_kdp(task_t task, uuid_t uuid);
190 extern int memorystatus_get_pressure_status_kdp(void);
191 extern void memorystatus_proc_flags_unsafe(void * v, boolean_t *is_dirty, boolean_t *is_dirty_tracked, boolean_t *allow_idle_exit);
192
193 extern int count_busy_buffers(void); /* must track with declaration in bsd/sys/buf_internal.h */
194
195 #if CONFIG_TELEMETRY
196 extern kern_return_t stack_microstackshot(user_addr_t tracebuf, uint32_t tracebuf_size, uint32_t flags, int32_t *retval);
197 #endif /* CONFIG_TELEMETRY */
198
199 extern kern_return_t kern_stack_snapshot_with_reason(char* reason);
200 extern kern_return_t kern_stack_snapshot_internal(int stackshot_config_version, void *stackshot_config, size_t stackshot_config_size, boolean_t stackshot_from_user);
201
202 static size_t stackshot_plh_est_size(void);
203
204 /*
205 * Validates that the given address for a word is both a valid page and has
206 * default caching attributes for the current map.
207 */
208 bool machine_trace_thread_validate_kva(vm_offset_t);
209 /*
210 * Validates a region that stackshot will potentially inspect.
211 */
212 static bool _stackshot_validate_kva(vm_offset_t, size_t);
213 /*
214 * Must be called whenever stackshot is re-driven.
215 */
216 static void _stackshot_validation_reset(void);
217 /*
218 * A kdp-safe strlen() call. Returns:
219 * -1 if we reach maxlen or a bad address before the end of the string, or
220 * strlen(s)
221 */
222 static long _stackshot_strlen(const char *s, size_t maxlen);
223
224 #define MAX_FRAMES 1000
225 #define MAX_LOADINFOS 500
226 #define MAX_DYLD_COMPACTINFO (20 * 1024) // max bytes of compactinfo to include per proc/shared region
227 #define TASK_IMP_WALK_LIMIT 20
228
229 typedef struct thread_snapshot *thread_snapshot_t;
230 typedef struct task_snapshot *task_snapshot_t;
231
232 #if CONFIG_KDP_INTERACTIVE_DEBUGGING
233 extern kdp_send_t kdp_en_send_pkt;
234 #endif
235
236 /*
237 * Stackshot locking and other defines.
238 */
239 static LCK_GRP_DECLARE(stackshot_subsys_lck_grp, "stackshot_subsys_lock");
240 static LCK_MTX_DECLARE(stackshot_subsys_mutex, &stackshot_subsys_lck_grp);
241
242 #define STACKSHOT_SUBSYS_LOCK() lck_mtx_lock(&stackshot_subsys_mutex)
243 #define STACKSHOT_SUBSYS_TRY_LOCK() lck_mtx_try_lock(&stackshot_subsys_mutex)
244 #define STACKSHOT_SUBSYS_UNLOCK() lck_mtx_unlock(&stackshot_subsys_mutex)
245
246 #define SANE_BOOTPROFILE_TRACEBUF_SIZE (64ULL * 1024ULL * 1024ULL)
247 #define SANE_TRACEBUF_SIZE (8ULL * 1024ULL * 1024ULL)
248
249 #define TRACEBUF_SIZE_PER_GB (1024ULL * 1024ULL)
250 #define GIGABYTES (1024ULL * 1024ULL * 1024ULL)
251
252 SECURITY_READ_ONLY_LATE(static uint32_t) max_tracebuf_size = SANE_TRACEBUF_SIZE;
253
254 /*
255 * We currently set a ceiling of 3 milliseconds spent in the kdp fault path
256 * for non-panic stackshots where faulting is requested.
257 */
258 #define KDP_FAULT_PATH_MAX_TIME_PER_STACKSHOT_NSECS (3 * NSEC_PER_MSEC)
259
260 #define STACKSHOT_SUPP_SIZE (16 * 1024) /* Minimum stackshot size */
261 #define TASK_UUID_AVG_SIZE (16 * sizeof(uuid_t)) /* Average space consumed by UUIDs/task */
262
263 #ifndef ROUNDUP
264 #define ROUNDUP(x, y) ((((x)+(y)-1)/(y))*(y))
265 #endif
266
267 #define STACKSHOT_QUEUE_LABEL_MAXSIZE 64
268
269 /*
270 * Initialize the mutex governing access to the stack snapshot subsystem
271 * and other stackshot related bits.
272 */
273 __private_extern__ void
stackshot_init(void)274 stackshot_init( void )
275 {
276 mach_timebase_info_data_t timebase;
277
278 clock_timebase_info(&timebase);
279 fault_stats.sfs_system_max_fault_time = ((KDP_FAULT_PATH_MAX_TIME_PER_STACKSHOT_NSECS * timebase.denom) / timebase.numer);
280
281 max_tracebuf_size = MAX(max_tracebuf_size, ((ROUNDUP(max_mem, GIGABYTES) / GIGABYTES) * TRACEBUF_SIZE_PER_GB));
282
283 PE_parse_boot_argn("stackshot_maxsz", &max_tracebuf_size, sizeof(max_tracebuf_size));
284 }
285
286 /*
287 * Called with interrupts disabled after stackshot context has been
288 * initialized. Updates stack_snapshot_ret.
289 */
290 static kern_return_t
stackshot_trap(void)291 stackshot_trap(void)
292 {
293 kern_return_t rv;
294
295 #if defined(__x86_64__)
296 /*
297 * Since mp_rendezvous and stackshot both attempt to capture cpus then perform an
298 * operation, it's essential to apply mutual exclusion to the other when one
299 * mechanism is in operation, lest there be a deadlock as the mechanisms race to
300 * capture CPUs.
301 *
302 * Further, we assert that invoking stackshot from mp_rendezvous*() is not
303 * allowed, so we check to ensure there there is no rendezvous in progress before
304 * trying to grab the lock (if there is, a deadlock will occur when we try to
305 * grab the lock). This is accomplished by setting cpu_rendezvous_in_progress to
306 * TRUE in the mp rendezvous action function. If stackshot_trap() is called by
307 * a subordinate of the call chain within the mp rendezvous action, this flag will
308 * be set and can be used to detect the inevitable deadlock that would occur
309 * if this thread tried to grab the rendezvous lock.
310 */
311
312 if (current_cpu_datap()->cpu_rendezvous_in_progress == TRUE) {
313 panic("Calling stackshot from a rendezvous is not allowed!");
314 }
315
316 mp_rendezvous_lock();
317 #endif
318
319 stackshot_last_abs_start = mach_absolute_time();
320 stackshot_last_abs_end = 0;
321
322 rv = DebuggerTrapWithState(DBOP_STACKSHOT, NULL, NULL, NULL, 0, NULL, FALSE, 0);
323
324 stackshot_last_abs_end = mach_absolute_time();
325 stackshots_taken++;
326 stackshots_duration += (stackshot_last_abs_end - stackshot_last_abs_start);
327
328 #if defined(__x86_64__)
329 mp_rendezvous_unlock();
330 #endif
331 return rv;
332 }
333
334 extern void stackshot_get_timing(uint64_t *last_abs_start, uint64_t *last_abs_end, uint64_t *count, uint64_t *total_duration);
335 void
stackshot_get_timing(uint64_t * last_abs_start,uint64_t * last_abs_end,uint64_t * count,uint64_t * total_duration)336 stackshot_get_timing(uint64_t *last_abs_start, uint64_t *last_abs_end, uint64_t *count, uint64_t *total_duration)
337 {
338 STACKSHOT_SUBSYS_LOCK();
339 *last_abs_start = stackshot_last_abs_start;
340 *last_abs_end = stackshot_last_abs_end;
341 *count = stackshots_taken;
342 *total_duration = stackshots_duration;
343 STACKSHOT_SUBSYS_UNLOCK();
344 }
345
346 kern_return_t
stack_snapshot_from_kernel(int pid,void * buf,uint32_t size,uint64_t flags,uint64_t delta_since_timestamp,uint32_t pagetable_mask,unsigned * bytes_traced)347 stack_snapshot_from_kernel(int pid, void *buf, uint32_t size, uint64_t flags, uint64_t delta_since_timestamp, uint32_t pagetable_mask, unsigned *bytes_traced)
348 {
349 kern_return_t error = KERN_SUCCESS;
350 boolean_t istate;
351
352 #if DEVELOPMENT || DEBUG
353 if (kern_feature_override(KF_STACKSHOT_OVRD) == TRUE) {
354 return KERN_NOT_SUPPORTED;
355 }
356 #endif
357 if ((buf == NULL) || (size <= 0) || (bytes_traced == NULL)) {
358 return KERN_INVALID_ARGUMENT;
359 }
360
361 /* cap in individual stackshot to max_tracebuf_size */
362 if (size > max_tracebuf_size) {
363 size = max_tracebuf_size;
364 }
365
366 /* Serialize tracing */
367 if (flags & STACKSHOT_TRYLOCK) {
368 if (!STACKSHOT_SUBSYS_TRY_LOCK()) {
369 return KERN_LOCK_OWNED;
370 }
371 } else {
372 STACKSHOT_SUBSYS_LOCK();
373 }
374
375 struct kcdata_descriptor kcdata;
376 uint32_t hdr_tag = (flags & STACKSHOT_COLLECT_DELTA_SNAPSHOT) ?
377 KCDATA_BUFFER_BEGIN_DELTA_STACKSHOT : KCDATA_BUFFER_BEGIN_STACKSHOT;
378
379 error = kcdata_memory_static_init(&kcdata, (mach_vm_address_t)buf, hdr_tag, size,
380 KCFLAG_USE_MEMCOPY | KCFLAG_NO_AUTO_ENDBUFFER);
381 if (error) {
382 goto out;
383 }
384
385 stackshot_initial_estimate = 0;
386 stackshot_duration_prior_abs = 0;
387 stackshot_duration_outer = NULL;
388
389 KDBG_RELEASE(MACHDBG_CODE(DBG_MACH_STACKSHOT, STACKSHOT_KERN_RECORD) | DBG_FUNC_START,
390 flags, size, pid, delta_since_timestamp);
391
392 istate = ml_set_interrupts_enabled(FALSE);
393 uint64_t time_start = mach_absolute_time();
394
395 /* Emit a SOCD tracepoint that we are initiating a stackshot */
396 SOCD_TRACE_XNU_START(STACKSHOT);
397
398 /* Preload trace parameters*/
399 kdp_snapshot_preflight(pid, buf, size, flags, &kcdata,
400 delta_since_timestamp, pagetable_mask);
401
402 /*
403 * Trap to the debugger to obtain a coherent stack snapshot; this populates
404 * the trace buffer
405 */
406 error = stackshot_trap();
407
408 uint64_t time_end = mach_absolute_time();
409
410 /* Emit a SOCD tracepoint that we have completed the stackshot */
411 SOCD_TRACE_XNU_END(STACKSHOT);
412
413 ml_set_interrupts_enabled(istate);
414
415 if (stackshot_duration_outer) {
416 *stackshot_duration_outer = time_end - time_start;
417 }
418 *bytes_traced = kdp_stack_snapshot_bytes_traced();
419
420 KDBG_RELEASE(MACHDBG_CODE(DBG_MACH_STACKSHOT, STACKSHOT_KERN_RECORD) | DBG_FUNC_END,
421 error, (time_end - time_start), size, *bytes_traced);
422 out:
423 stackshot_kcdata_p = NULL;
424 STACKSHOT_SUBSYS_UNLOCK();
425 return error;
426 }
427
428 #if CONFIG_TELEMETRY
429 kern_return_t
stack_microstackshot(user_addr_t tracebuf,uint32_t tracebuf_size,uint32_t flags,int32_t * retval)430 stack_microstackshot(user_addr_t tracebuf, uint32_t tracebuf_size, uint32_t flags, int32_t *retval)
431 {
432 int error = KERN_SUCCESS;
433 uint32_t bytes_traced = 0;
434
435 *retval = -1;
436
437 /*
438 * Control related operations
439 */
440 if (flags & STACKSHOT_GLOBAL_MICROSTACKSHOT_ENABLE) {
441 telemetry_global_ctl(1);
442 *retval = 0;
443 goto exit;
444 } else if (flags & STACKSHOT_GLOBAL_MICROSTACKSHOT_DISABLE) {
445 telemetry_global_ctl(0);
446 *retval = 0;
447 goto exit;
448 }
449
450 /*
451 * Data related operations
452 */
453 *retval = -1;
454
455 if ((((void*)tracebuf) == NULL) || (tracebuf_size == 0)) {
456 error = KERN_INVALID_ARGUMENT;
457 goto exit;
458 }
459
460 STACKSHOT_SUBSYS_LOCK();
461
462 if (flags & STACKSHOT_GET_MICROSTACKSHOT) {
463 if (tracebuf_size > max_tracebuf_size) {
464 error = KERN_INVALID_ARGUMENT;
465 goto unlock_exit;
466 }
467
468 bytes_traced = tracebuf_size;
469 error = telemetry_gather(tracebuf, &bytes_traced,
470 (flags & STACKSHOT_SET_MICROSTACKSHOT_MARK) ? true : false);
471 *retval = (int)bytes_traced;
472 goto unlock_exit;
473 }
474
475 unlock_exit:
476 STACKSHOT_SUBSYS_UNLOCK();
477 exit:
478 return error;
479 }
480 #endif /* CONFIG_TELEMETRY */
481
482 /*
483 * Return the estimated size of a stackshot based on the
484 * number of currently running threads and tasks.
485 *
486 * adj is an adjustment in units of percentage
487 *
488 * This function is mostly unhinged from reality; struct thread_snapshot and
489 * struct task_stackshot are legacy, much larger versions of the structures we
490 * actually use, and there's no accounting for how we actually generate
491 * task & thread information. rdar://78880038 intends to replace this all.
492 */
493 uint32_t
get_stackshot_estsize(uint32_t prev_size_hint,uint32_t adj)494 get_stackshot_estsize(uint32_t prev_size_hint, uint32_t adj)
495 {
496 vm_size_t thread_total;
497 vm_size_t task_total;
498 uint64_t size;
499 uint32_t estimated_size;
500 size_t est_thread_size = sizeof(struct thread_snapshot);
501 size_t est_task_size = sizeof(struct task_snapshot) + TASK_UUID_AVG_SIZE;
502
503 adj = MIN(adj, 100u); /* no more than double our estimate */
504
505 #if STACKSHOT_COLLECTS_LATENCY_INFO
506 if (collect_latency_info) {
507 est_thread_size += sizeof(struct stackshot_latency_thread);
508 est_task_size += sizeof(struct stackshot_latency_task);
509 }
510 #endif
511
512 thread_total = (threads_count * est_thread_size);
513 task_total = (tasks_count * est_task_size);
514
515 size = thread_total + task_total + STACKSHOT_SUPP_SIZE; /* estimate */
516 size += (size * adj) / 100; /* add adj */
517 size = MAX(size, prev_size_hint); /* allow hint to increase */
518 size += stackshot_plh_est_size(); /* add space for the port label hash */
519 size = MIN(size, VM_MAP_TRUNC_PAGE(UINT32_MAX, PAGE_MASK)); /* avoid overflow */
520 estimated_size = (uint32_t) VM_MAP_ROUND_PAGE(size, PAGE_MASK); /* round to pagesize */
521
522 return estimated_size;
523 }
524
525 /*
526 * stackshot_remap_buffer: Utility function to remap bytes_traced bytes starting at stackshotbuf
527 * into the current task's user space and subsequently copy out the address
528 * at which the buffer has been mapped in user space to out_buffer_addr.
529 *
530 * Inputs: stackshotbuf - pointer to the original buffer in the kernel's address space
531 * bytes_traced - length of the buffer to remap starting from stackshotbuf
532 * out_buffer_addr - pointer to placeholder where newly mapped buffer will be mapped.
533 * out_size_addr - pointer to be filled in with the size of the buffer
534 *
535 * Outputs: ENOSPC if there is not enough free space in the task's address space to remap the buffer
536 * EINVAL for all other errors returned by task_remap_buffer/mach_vm_remap
537 * an error from copyout
538 */
539 static kern_return_t
stackshot_remap_buffer(void * stackshotbuf,uint32_t bytes_traced,uint64_t out_buffer_addr,uint64_t out_size_addr)540 stackshot_remap_buffer(void *stackshotbuf, uint32_t bytes_traced, uint64_t out_buffer_addr, uint64_t out_size_addr)
541 {
542 int error = 0;
543 mach_vm_offset_t stackshotbuf_user_addr = (mach_vm_offset_t)NULL;
544 vm_prot_t cur_prot, max_prot;
545
546 error = mach_vm_remap_kernel(get_task_map(current_task()), &stackshotbuf_user_addr, bytes_traced, 0,
547 VM_FLAGS_ANYWHERE, VM_KERN_MEMORY_NONE, kernel_map, (mach_vm_offset_t)stackshotbuf, FALSE, &cur_prot, &max_prot, VM_INHERIT_DEFAULT);
548 /*
549 * If the call to mach_vm_remap fails, we return the appropriate converted error
550 */
551 if (error == KERN_SUCCESS) {
552 /*
553 * If we fail to copy out the address or size of the new buffer, we remove the buffer mapping that
554 * we just made in the task's user space.
555 */
556 error = copyout(CAST_DOWN(void *, &stackshotbuf_user_addr), (user_addr_t)out_buffer_addr, sizeof(stackshotbuf_user_addr));
557 if (error != KERN_SUCCESS) {
558 mach_vm_deallocate(get_task_map(current_task()), stackshotbuf_user_addr, (mach_vm_size_t)bytes_traced);
559 return error;
560 }
561 error = copyout(&bytes_traced, (user_addr_t)out_size_addr, sizeof(bytes_traced));
562 if (error != KERN_SUCCESS) {
563 mach_vm_deallocate(get_task_map(current_task()), stackshotbuf_user_addr, (mach_vm_size_t)bytes_traced);
564 return error;
565 }
566 }
567 return error;
568 }
569
570 kern_return_t
kern_stack_snapshot_internal(int stackshot_config_version,void * stackshot_config,size_t stackshot_config_size,boolean_t stackshot_from_user)571 kern_stack_snapshot_internal(int stackshot_config_version, void *stackshot_config, size_t stackshot_config_size, boolean_t stackshot_from_user)
572 {
573 int error = 0;
574 boolean_t prev_interrupt_state;
575 uint32_t bytes_traced = 0;
576 uint32_t stackshot_estimate = 0;
577 uint32_t stackshotbuf_size = 0;
578 void * stackshotbuf = NULL;
579 kcdata_descriptor_t kcdata_p = NULL;
580
581 void * buf_to_free = NULL;
582 int size_to_free = 0;
583 bool is_traced = false; /* has FUNC_START tracepoint fired? */
584 uint64_t tot_interrupts_off_abs = 0; /* sum(time with interrupts off) */
585
586 /* Parsed arguments */
587 uint64_t out_buffer_addr;
588 uint64_t out_size_addr;
589 int pid = -1;
590 uint64_t flags;
591 uint64_t since_timestamp;
592 uint32_t size_hint = 0;
593 uint32_t pagetable_mask = STACKSHOT_PAGETABLES_MASK_ALL;
594
595 if (stackshot_config == NULL) {
596 return KERN_INVALID_ARGUMENT;
597 }
598 #if DEVELOPMENT || DEBUG
599 /* TBD: ask stackshot clients to avoid issuing stackshots in this
600 * configuration in lieu of the kernel feature override.
601 */
602 if (kern_feature_override(KF_STACKSHOT_OVRD) == TRUE) {
603 return KERN_NOT_SUPPORTED;
604 }
605 #endif
606
607 switch (stackshot_config_version) {
608 case STACKSHOT_CONFIG_TYPE:
609 if (stackshot_config_size != sizeof(stackshot_config_t)) {
610 return KERN_INVALID_ARGUMENT;
611 }
612 stackshot_config_t *config = (stackshot_config_t *) stackshot_config;
613 out_buffer_addr = config->sc_out_buffer_addr;
614 out_size_addr = config->sc_out_size_addr;
615 pid = config->sc_pid;
616 flags = config->sc_flags;
617 since_timestamp = config->sc_delta_timestamp;
618 if (config->sc_size <= max_tracebuf_size) {
619 size_hint = config->sc_size;
620 }
621 /*
622 * Retain the pre-sc_pagetable_mask behavior of STACKSHOT_PAGE_TABLES,
623 * dump every level if the pagetable_mask is not set
624 */
625 if (flags & STACKSHOT_PAGE_TABLES && config->sc_pagetable_mask) {
626 pagetable_mask = config->sc_pagetable_mask;
627 }
628 break;
629 default:
630 return KERN_NOT_SUPPORTED;
631 }
632
633 /*
634 * Currently saving a kernel buffer and trylock are only supported from the
635 * internal/KEXT API.
636 */
637 if (stackshot_from_user) {
638 if (flags & (STACKSHOT_TRYLOCK | STACKSHOT_SAVE_IN_KERNEL_BUFFER | STACKSHOT_FROM_PANIC)) {
639 return KERN_NO_ACCESS;
640 }
641 #if !DEVELOPMENT && !DEBUG
642 if (flags & (STACKSHOT_DO_COMPRESS)) {
643 return KERN_NO_ACCESS;
644 }
645 #endif
646 } else {
647 if (!(flags & STACKSHOT_SAVE_IN_KERNEL_BUFFER)) {
648 return KERN_NOT_SUPPORTED;
649 }
650 }
651
652 if (!((flags & STACKSHOT_KCDATA_FORMAT) || (flags & STACKSHOT_RETRIEVE_EXISTING_BUFFER))) {
653 return KERN_NOT_SUPPORTED;
654 }
655
656 /* Compresssed delta stackshots or page dumps are not yet supported */
657 if (((flags & STACKSHOT_COLLECT_DELTA_SNAPSHOT) || (flags & STACKSHOT_PAGE_TABLES))
658 && (flags & STACKSHOT_DO_COMPRESS)) {
659 return KERN_NOT_SUPPORTED;
660 }
661
662 /*
663 * If we're not saving the buffer in the kernel pointer, we need a place to copy into.
664 */
665 if ((!out_buffer_addr || !out_size_addr) && !(flags & STACKSHOT_SAVE_IN_KERNEL_BUFFER)) {
666 return KERN_INVALID_ARGUMENT;
667 }
668
669 if (since_timestamp != 0 && ((flags & STACKSHOT_COLLECT_DELTA_SNAPSHOT) == 0)) {
670 return KERN_INVALID_ARGUMENT;
671 }
672
673 #if CONFIG_PERVASIVE_CPI && MONOTONIC
674 if (!mt_core_supported) {
675 flags &= ~STACKSHOT_INSTRS_CYCLES;
676 }
677 #else /* CONFIG_PERVASIVE_CPI && MONOTONIC */
678 flags &= ~STACKSHOT_INSTRS_CYCLES;
679 #endif /* !CONFIG_PERVASIVE_CPI || !MONOTONIC */
680
681 STACKSHOT_SUBSYS_LOCK();
682
683 if (flags & STACKSHOT_SAVE_IN_KERNEL_BUFFER) {
684 /*
685 * Don't overwrite an existing stackshot
686 */
687 if (kernel_stackshot_buf != NULL) {
688 error = KERN_MEMORY_PRESENT;
689 goto error_exit;
690 }
691 } else if (flags & STACKSHOT_RETRIEVE_EXISTING_BUFFER) {
692 if ((kernel_stackshot_buf == NULL) || (kernel_stackshot_buf_size <= 0)) {
693 error = KERN_NOT_IN_SET;
694 goto error_exit;
695 }
696 error = stackshot_remap_buffer(kernel_stackshot_buf, kernel_stackshot_buf_size,
697 out_buffer_addr, out_size_addr);
698 /*
699 * If we successfully remapped the buffer into the user's address space, we
700 * set buf_to_free and size_to_free so the prior kernel mapping will be removed
701 * and then clear the kernel stackshot pointer and associated size.
702 */
703 if (error == KERN_SUCCESS) {
704 buf_to_free = kernel_stackshot_buf;
705 size_to_free = (int) VM_MAP_ROUND_PAGE(kernel_stackshot_buf_size, PAGE_MASK);
706 kernel_stackshot_buf = NULL;
707 kernel_stackshot_buf_size = 0;
708 }
709
710 goto error_exit;
711 }
712
713 if (flags & STACKSHOT_GET_BOOT_PROFILE) {
714 void *bootprofile = NULL;
715 uint32_t len = 0;
716 #if CONFIG_TELEMETRY
717 bootprofile_get(&bootprofile, &len);
718 #endif
719 if (!bootprofile || !len) {
720 error = KERN_NOT_IN_SET;
721 goto error_exit;
722 }
723 error = stackshot_remap_buffer(bootprofile, len, out_buffer_addr, out_size_addr);
724 goto error_exit;
725 }
726
727 stackshot_duration_prior_abs = 0;
728 stackshot_initial_estimate_adj = os_atomic_load(&stackshot_estimate_adj, relaxed);
729 stackshotbuf_size = stackshot_estimate =
730 get_stackshot_estsize(size_hint, stackshot_initial_estimate_adj);
731 stackshot_initial_estimate = stackshot_estimate;
732
733 KDBG_RELEASE(MACHDBG_CODE(DBG_MACH_STACKSHOT, STACKSHOT_RECORD) | DBG_FUNC_START,
734 flags, stackshotbuf_size, pid, since_timestamp);
735 is_traced = true;
736
737 for (; stackshotbuf_size <= max_tracebuf_size; stackshotbuf_size <<= 1) {
738 if (kmem_alloc(kernel_map, (vm_offset_t *)&stackshotbuf, stackshotbuf_size,
739 KMA_ZERO | KMA_DATA, VM_KERN_MEMORY_DIAG) != KERN_SUCCESS) {
740 error = KERN_RESOURCE_SHORTAGE;
741 goto error_exit;
742 }
743
744
745 uint32_t hdr_tag = (flags & STACKSHOT_COLLECT_DELTA_SNAPSHOT) ? KCDATA_BUFFER_BEGIN_DELTA_STACKSHOT
746 : (flags & STACKSHOT_DO_COMPRESS) ? KCDATA_BUFFER_BEGIN_COMPRESSED
747 : KCDATA_BUFFER_BEGIN_STACKSHOT;
748 kcdata_p = kcdata_memory_alloc_init((mach_vm_address_t)stackshotbuf, hdr_tag, stackshotbuf_size,
749 KCFLAG_USE_MEMCOPY | KCFLAG_NO_AUTO_ENDBUFFER);
750
751 stackshot_duration_outer = NULL;
752
753 /* if compression was requested, allocate the extra zlib scratch area */
754 if (flags & STACKSHOT_DO_COMPRESS) {
755 hdr_tag = (flags & STACKSHOT_COLLECT_DELTA_SNAPSHOT) ? KCDATA_BUFFER_BEGIN_DELTA_STACKSHOT
756 : KCDATA_BUFFER_BEGIN_STACKSHOT;
757 error = kcdata_init_compress(kcdata_p, hdr_tag, kdp_memcpy, KCDCT_ZLIB);
758 if (error != KERN_SUCCESS) {
759 os_log(OS_LOG_DEFAULT, "failed to initialize compression: %d!\n",
760 (int) error);
761 goto error_exit;
762 }
763 }
764
765 /*
766 * Disable interrupts and save the current interrupt state.
767 */
768 prev_interrupt_state = ml_set_interrupts_enabled(FALSE);
769 uint64_t time_start = mach_absolute_time();
770
771 /* Emit a SOCD tracepoint that we are initiating a stackshot */
772 SOCD_TRACE_XNU_START(STACKSHOT);
773
774 /*
775 * Load stackshot parameters.
776 */
777 kdp_snapshot_preflight(pid, stackshotbuf, stackshotbuf_size, flags, kcdata_p, since_timestamp,
778 pagetable_mask);
779
780 error = stackshot_trap();
781
782 /* record the duration that interupts were disabled */
783 uint64_t time_end = mach_absolute_time();
784
785 /* Emit a SOCD tracepoint that we have completed the stackshot */
786 SOCD_TRACE_XNU_END(STACKSHOT);
787 ml_set_interrupts_enabled(prev_interrupt_state);
788
789 if (stackshot_duration_outer) {
790 *stackshot_duration_outer = time_end - time_start;
791 }
792 tot_interrupts_off_abs += time_end - time_start;
793
794 if (error != KERN_SUCCESS) {
795 if (kcdata_p != NULL) {
796 kcdata_memory_destroy(kcdata_p);
797 kcdata_p = NULL;
798 stackshot_kcdata_p = NULL;
799 }
800 kmem_free(kernel_map, (vm_offset_t)stackshotbuf, stackshotbuf_size);
801 stackshotbuf = NULL;
802 if (error == KERN_INSUFFICIENT_BUFFER_SIZE) {
803 /*
804 * If we didn't allocate a big enough buffer, deallocate and try again.
805 */
806 KDBG_RELEASE(MACHDBG_CODE(DBG_MACH_STACKSHOT, STACKSHOT_RECORD_SHORT) | DBG_FUNC_NONE,
807 time_end - time_start, stackshot_estimate, stackshotbuf_size);
808 stackshot_duration_prior_abs += (time_end - time_start);
809 continue;
810 } else {
811 goto error_exit;
812 }
813 }
814
815 bytes_traced = kdp_stack_snapshot_bytes_traced();
816 if (bytes_traced <= 0) {
817 error = KERN_ABORTED;
818 goto error_exit;
819 }
820
821 assert(bytes_traced <= stackshotbuf_size);
822 if (!(flags & STACKSHOT_SAVE_IN_KERNEL_BUFFER)) {
823 error = stackshot_remap_buffer(stackshotbuf, bytes_traced, out_buffer_addr, out_size_addr);
824 goto error_exit;
825 }
826
827 /*
828 * Save the stackshot in the kernel buffer.
829 */
830 kernel_stackshot_buf = stackshotbuf;
831 kernel_stackshot_buf_size = bytes_traced;
832 /*
833 * Figure out if we didn't use all the pages in the buffer. If so, we set buf_to_free to the beginning of
834 * the next page after the end of the stackshot in the buffer so that the kmem_free clips the buffer and
835 * update size_to_free for kmem_free accordingly.
836 */
837 size_to_free = stackshotbuf_size - (int) VM_MAP_ROUND_PAGE(bytes_traced, PAGE_MASK);
838
839 assert(size_to_free >= 0);
840
841 if (size_to_free != 0) {
842 buf_to_free = (void *)((uint64_t)stackshotbuf + stackshotbuf_size - size_to_free);
843 }
844
845 stackshotbuf = NULL;
846 stackshotbuf_size = 0;
847 goto error_exit;
848 }
849
850 if (stackshotbuf_size > max_tracebuf_size) {
851 error = KERN_RESOURCE_SHORTAGE;
852 }
853
854 error_exit:
855 if (is_traced) {
856 KDBG_RELEASE(MACHDBG_CODE(DBG_MACH_STACKSHOT, STACKSHOT_RECORD) | DBG_FUNC_END,
857 error, tot_interrupts_off_abs, stackshotbuf_size, bytes_traced);
858 }
859 if (kcdata_p != NULL) {
860 kcdata_memory_destroy(kcdata_p);
861 kcdata_p = NULL;
862 stackshot_kcdata_p = NULL;
863 }
864
865 if (stackshotbuf != NULL) {
866 kmem_free(kernel_map, (vm_offset_t)stackshotbuf, stackshotbuf_size);
867 }
868 if (buf_to_free != NULL) {
869 kmem_free(kernel_map, (vm_offset_t)buf_to_free, size_to_free);
870 }
871 STACKSHOT_SUBSYS_UNLOCK();
872 return error;
873 }
874
875 /*
876 * Cache stack snapshot parameters in preparation for a trace.
877 */
878 void
kdp_snapshot_preflight(int pid,void * tracebuf,uint32_t tracebuf_size,uint64_t flags,kcdata_descriptor_t data_p,uint64_t since_timestamp,uint32_t pagetable_mask)879 kdp_snapshot_preflight(int pid, void * tracebuf, uint32_t tracebuf_size, uint64_t flags,
880 kcdata_descriptor_t data_p, uint64_t since_timestamp, uint32_t pagetable_mask)
881 {
882 uint64_t microsecs = 0, secs = 0;
883 clock_get_calendar_microtime((clock_sec_t *)&secs, (clock_usec_t *)µsecs);
884
885 stackshot_microsecs = microsecs + (secs * USEC_PER_SEC);
886 stack_snapshot_pid = pid;
887 stack_snapshot_buf = tracebuf;
888 stack_snapshot_bufsize = tracebuf_size;
889 stack_snapshot_flags = flags;
890 stack_snapshot_delta_since_timestamp = since_timestamp;
891 stack_snapshot_pagetable_mask = pagetable_mask;
892
893 panic_stackshot = ((flags & STACKSHOT_FROM_PANIC) != 0);
894
895 assert(data_p != NULL);
896 assert(stackshot_kcdata_p == NULL);
897 stackshot_kcdata_p = data_p;
898
899 stack_snapshot_bytes_traced = 0;
900 stack_snapshot_bytes_uncompressed = 0;
901 }
902
903 void
panic_stackshot_reset_state(void)904 panic_stackshot_reset_state(void)
905 {
906 stackshot_kcdata_p = NULL;
907 }
908
909 boolean_t
stackshot_active(void)910 stackshot_active(void)
911 {
912 return stackshot_kcdata_p != NULL;
913 }
914
915 uint32_t
kdp_stack_snapshot_bytes_traced(void)916 kdp_stack_snapshot_bytes_traced(void)
917 {
918 return stack_snapshot_bytes_traced;
919 }
920
921 uint32_t
kdp_stack_snapshot_bytes_uncompressed(void)922 kdp_stack_snapshot_bytes_uncompressed(void)
923 {
924 return stack_snapshot_bytes_uncompressed;
925 }
926
927 static boolean_t
memory_iszero(void * addr,size_t size)928 memory_iszero(void *addr, size_t size)
929 {
930 char *data = (char *)addr;
931 for (size_t i = 0; i < size; i++) {
932 if (data[i] != 0) {
933 return FALSE;
934 }
935 }
936 return TRUE;
937 }
938
939 /*
940 * Keep a simple cache of the most recent validation done at a page granularity
941 * to avoid the expensive software KVA-to-phys translation in the VM.
942 */
943
944 struct _stackshot_validation_state {
945 vm_offset_t last_valid_page_kva;
946 size_t last_valid_size;
947 } g_validation_state;
948
949 static void
_stackshot_validation_reset(void)950 _stackshot_validation_reset(void)
951 {
952 g_validation_state.last_valid_page_kva = -1;
953 g_validation_state.last_valid_size = 0;
954 }
955
956 static bool
_stackshot_validate_kva(vm_offset_t addr,size_t size)957 _stackshot_validate_kva(vm_offset_t addr, size_t size)
958 {
959 vm_offset_t page_addr = atop_kernel(addr);
960 if (g_validation_state.last_valid_page_kva == page_addr &&
961 g_validation_state.last_valid_size <= size) {
962 return true;
963 }
964
965 if (ml_validate_nofault(addr, size)) {
966 g_validation_state.last_valid_page_kva = page_addr;
967 g_validation_state.last_valid_size = size;
968 return true;
969 }
970 return false;
971 }
972
973 static long
_stackshot_strlen(const char * s,size_t maxlen)974 _stackshot_strlen(const char *s, size_t maxlen)
975 {
976 size_t len = 0;
977 for (len = 0; _stackshot_validate_kva((vm_offset_t)s, 1); len++, s++) {
978 if (*s == 0) {
979 return len;
980 }
981 if (len >= maxlen) {
982 return -1;
983 }
984 }
985 return -1; /* failed before end of string */
986 }
987
988 #define kcd_end_address(kcd) ((void *)((uint64_t)((kcd)->kcd_addr_begin) + kcdata_memory_get_used_bytes((kcd))))
989 #define kcd_max_address(kcd) ((void *)((kcd)->kcd_addr_begin + (kcd)->kcd_length))
990 /*
991 * Use of the kcd_exit_on_error(action) macro requires a local
992 * 'kern_return_t error' variable and 'error_exit' label.
993 */
994 #define kcd_exit_on_error(action) \
995 do { \
996 if (KERN_SUCCESS != (error = (action))) { \
997 if (error == KERN_RESOURCE_SHORTAGE) { \
998 error = KERN_INSUFFICIENT_BUFFER_SIZE; \
999 } \
1000 goto error_exit; \
1001 } \
1002 } while (0); /* end kcd_exit_on_error */
1003
1004
1005 /*
1006 * For port labels, we have a small hash table we use to track the
1007 * struct ipc_service_port_label pointers we see along the way.
1008 * This structure encapsulates the global state.
1009 *
1010 * The hash table is insert-only, similar to "intern"ing strings. It's
1011 * only used an manipulated in during the stackshot collection. We use
1012 * seperate chaining, with the hash elements and chains being int16_ts
1013 * indexes into the parallel arrays, with -1 ending the chain. Array indices are
1014 * allocated using a bump allocator.
1015 *
1016 * The parallel arrays contain:
1017 * - plh_array[idx] the pointer entered
1018 * - plh_chains[idx] the hash chain
1019 * - plh_gen[idx] the last 'generation #' seen
1020 *
1021 * Generation IDs are used to track entries looked up in the current
1022 * task; 0 is never used, and the plh_gen array is cleared to 0 on
1023 * rollover.
1024 *
1025 * The portlabel_ids we report externally are just the index in the array,
1026 * plus 1 to avoid 0 as a value. 0 is NONE, -1 is UNKNOWN (e.g. there is
1027 * one, but we ran out of space)
1028 */
1029 struct port_label_hash {
1030 uint16_t plh_size; /* size of allocations; 0 disables tracking */
1031 uint16_t plh_count; /* count of used entries in plh_array */
1032 struct ipc_service_port_label **plh_array; /* _size allocated, _count used */
1033 int16_t *plh_chains; /* _size allocated */
1034 uint8_t *plh_gen; /* last 'gen #' seen in */
1035 int16_t *plh_hash; /* (1 << STACKSHOT_PLH_SHIFT) entry hash table: hash(ptr) -> array index */
1036 int16_t plh_curgen_min; /* min idx seen for this gen */
1037 int16_t plh_curgen_max; /* max idx seen for this gen */
1038 uint8_t plh_curgen; /* current gen */
1039 #if DEVELOPMENT || DEBUG
1040 /* statistics */
1041 uint32_t plh_lookups; /* # lookups or inserts */
1042 uint32_t plh_found;
1043 uint32_t plh_found_depth;
1044 uint32_t plh_insert;
1045 uint32_t plh_insert_depth;
1046 uint32_t plh_bad;
1047 uint32_t plh_bad_depth;
1048 uint32_t plh_lookup_send;
1049 uint32_t plh_lookup_receive;
1050 #define PLH_STAT_OP(...) (void)(__VA_ARGS__)
1051 #else /* DEVELOPMENT || DEBUG */
1052 #define PLH_STAT_OP(...) (void)(0)
1053 #endif /* DEVELOPMENT || DEBUG */
1054 } port_label_hash;
1055
1056 #define STACKSHOT_PLH_SHIFT 7
1057 #define STACKSHOT_PLH_SIZE_MAX ((kdp_ipc_have_splabel)? 1024 : 0)
1058 size_t stackshot_port_label_size = (2 * (1u << STACKSHOT_PLH_SHIFT));
1059 #define STASKSHOT_PLH_SIZE(x) MIN((x), STACKSHOT_PLH_SIZE_MAX)
1060
1061 static size_t
stackshot_plh_est_size(void)1062 stackshot_plh_est_size(void)
1063 {
1064 struct port_label_hash *plh = &port_label_hash;
1065 size_t size = STASKSHOT_PLH_SIZE(stackshot_port_label_size);
1066
1067 if (size == 0) {
1068 return 0;
1069 }
1070 #define SIZE_EST(x) ROUNDUP((x), sizeof (uintptr_t))
1071 return SIZE_EST(size * sizeof(*plh->plh_array)) +
1072 SIZE_EST(size * sizeof(*plh->plh_chains)) +
1073 SIZE_EST(size * sizeof(*plh->plh_gen)) +
1074 SIZE_EST((1ul << STACKSHOT_PLH_SHIFT) * sizeof(*plh->plh_hash));
1075 #undef SIZE_EST
1076 }
1077
1078 static void
stackshot_plh_reset(void)1079 stackshot_plh_reset(void)
1080 {
1081 port_label_hash = (struct port_label_hash){.plh_size = 0}; /* structure assignment */
1082 }
1083
1084 static void
stackshot_plh_setup(kcdata_descriptor_t data)1085 stackshot_plh_setup(kcdata_descriptor_t data)
1086 {
1087 struct port_label_hash plh = {
1088 .plh_size = STASKSHOT_PLH_SIZE(stackshot_port_label_size),
1089 .plh_count = 0,
1090 .plh_curgen = 1,
1091 .plh_curgen_min = STACKSHOT_PLH_SIZE_MAX,
1092 .plh_curgen_max = 0,
1093 };
1094 stackshot_plh_reset();
1095 size_t size = plh.plh_size;
1096 if (size == 0) {
1097 return;
1098 }
1099 plh.plh_array = kcdata_endalloc(data, size * sizeof(*plh.plh_array));
1100 plh.plh_chains = kcdata_endalloc(data, size * sizeof(*plh.plh_chains));
1101 plh.plh_gen = kcdata_endalloc(data, size * sizeof(*plh.plh_gen));
1102 plh.plh_hash = kcdata_endalloc(data, (1ul << STACKSHOT_PLH_SHIFT) * sizeof(*plh.plh_hash));
1103 if (plh.plh_array == NULL || plh.plh_chains == NULL || plh.plh_gen == NULL || plh.plh_hash == NULL) {
1104 PLH_STAT_OP(port_label_hash.plh_bad++);
1105 return;
1106 }
1107 for (int x = 0; x < size; x++) {
1108 plh.plh_array[x] = NULL;
1109 plh.plh_chains[x] = -1;
1110 plh.plh_gen[x] = 0;
1111 }
1112 for (int x = 0; x < (1ul << STACKSHOT_PLH_SHIFT); x++) {
1113 plh.plh_hash[x] = -1;
1114 }
1115 port_label_hash = plh; /* structure assignment */
1116 }
1117
1118 static int16_t
stackshot_plh_hash(struct ipc_service_port_label * ispl)1119 stackshot_plh_hash(struct ipc_service_port_label *ispl)
1120 {
1121 uintptr_t ptr = (uintptr_t)ispl;
1122 static_assert(STACKSHOT_PLH_SHIFT < 16, "plh_hash must fit in 15 bits");
1123 #define PLH_HASH_STEP(ptr, x) \
1124 ((((x) * STACKSHOT_PLH_SHIFT) < (sizeof(ispl) * CHAR_BIT)) ? ((ptr) >> ((x) * STACKSHOT_PLH_SHIFT)) : 0)
1125 ptr ^= PLH_HASH_STEP(ptr, 16);
1126 ptr ^= PLH_HASH_STEP(ptr, 8);
1127 ptr ^= PLH_HASH_STEP(ptr, 4);
1128 ptr ^= PLH_HASH_STEP(ptr, 2);
1129 ptr ^= PLH_HASH_STEP(ptr, 1);
1130 #undef PLH_HASH_STEP
1131 return (int16_t)(ptr & ((1ul << STACKSHOT_PLH_SHIFT) - 1));
1132 }
1133
1134 enum stackshot_plh_lookup_type {
1135 STACKSHOT_PLH_LOOKUP_UNKNOWN,
1136 STACKSHOT_PLH_LOOKUP_SEND,
1137 STACKSHOT_PLH_LOOKUP_RECEIVE,
1138 };
1139
1140 static void
stackshot_plh_resetgen(void)1141 stackshot_plh_resetgen(void)
1142 {
1143 struct port_label_hash *plh = &port_label_hash;
1144 if (plh->plh_curgen_min == STACKSHOT_PLH_SIZE_MAX && plh->plh_curgen_max == 0) {
1145 return; // no lookups, nothing using the current generation
1146 }
1147 plh->plh_curgen++;
1148 plh->plh_curgen_min = STACKSHOT_PLH_SIZE_MAX;
1149 plh->plh_curgen_max = 0;
1150 if (plh->plh_curgen == 0) { // wrapped, zero the array and increment the generation
1151 for (int x = 0; x < plh->plh_size; x++) {
1152 plh->plh_gen[x] = 0;
1153 }
1154 plh->plh_curgen = 1;
1155 }
1156 }
1157
1158 static int16_t
stackshot_plh_lookup(struct ipc_service_port_label * ispl,enum stackshot_plh_lookup_type type)1159 stackshot_plh_lookup(struct ipc_service_port_label *ispl, enum stackshot_plh_lookup_type type)
1160 {
1161 struct port_label_hash *plh = &port_label_hash;
1162 int depth;
1163 int16_t cur;
1164 if (ispl == NULL) {
1165 return STACKSHOT_PORTLABELID_NONE;
1166 }
1167 switch (type) {
1168 case STACKSHOT_PLH_LOOKUP_SEND:
1169 PLH_STAT_OP(plh->plh_lookup_send++);
1170 break;
1171 case STACKSHOT_PLH_LOOKUP_RECEIVE:
1172 PLH_STAT_OP(plh->plh_lookup_receive++);
1173 break;
1174 default:
1175 break;
1176 }
1177 PLH_STAT_OP(plh->plh_lookups++);
1178 if (plh->plh_size == 0) {
1179 return STACKSHOT_PORTLABELID_MISSING;
1180 }
1181 int16_t hash = stackshot_plh_hash(ispl);
1182 assert(hash >= 0 && hash < (1ul << STACKSHOT_PLH_SHIFT));
1183 depth = 0;
1184 for (cur = plh->plh_hash[hash]; cur >= 0; cur = plh->plh_chains[cur]) {
1185 /* cur must be in-range, and chain depth can never be above our # allocated */
1186 if (cur >= plh->plh_count || depth > plh->plh_count || depth > plh->plh_size) {
1187 PLH_STAT_OP((plh->plh_bad++), (plh->plh_bad_depth += depth));
1188 return STACKSHOT_PORTLABELID_MISSING;
1189 }
1190 assert(cur < plh->plh_count);
1191 if (plh->plh_array[cur] == ispl) {
1192 PLH_STAT_OP((plh->plh_found++), (plh->plh_found_depth += depth));
1193 goto found;
1194 }
1195 depth++;
1196 }
1197 /* not found in hash table, so alloc and insert it */
1198 if (cur != -1) {
1199 PLH_STAT_OP((plh->plh_bad++), (plh->plh_bad_depth += depth));
1200 return STACKSHOT_PORTLABELID_MISSING; /* bad end of chain */
1201 }
1202 PLH_STAT_OP((plh->plh_insert++), (plh->plh_insert_depth += depth));
1203 if (plh->plh_count >= plh->plh_size) {
1204 return STACKSHOT_PORTLABELID_MISSING; /* no space */
1205 }
1206 cur = plh->plh_count;
1207 plh->plh_count++;
1208 plh->plh_array[cur] = ispl;
1209 plh->plh_chains[cur] = plh->plh_hash[hash];
1210 plh->plh_hash[hash] = cur;
1211 found:
1212 plh->plh_gen[cur] = plh->plh_curgen;
1213 if (plh->plh_curgen_min > cur) {
1214 plh->plh_curgen_min = cur;
1215 }
1216 if (plh->plh_curgen_max < cur) {
1217 plh->plh_curgen_max = cur;
1218 }
1219 return cur + 1; /* offset to avoid 0 */
1220 }
1221
1222 // record any PLH referenced since the last stackshot_plh_resetgen() call
1223 static kern_return_t
kdp_stackshot_plh_record(void)1224 kdp_stackshot_plh_record(void)
1225 {
1226 kern_return_t error = KERN_SUCCESS;
1227 struct port_label_hash *plh = &port_label_hash;
1228 uint16_t count = plh->plh_count;
1229 uint8_t curgen = plh->plh_curgen;
1230 int16_t curgen_min = plh->plh_curgen_min;
1231 int16_t curgen_max = plh->plh_curgen_max;
1232 if (curgen_min <= curgen_max && curgen_max < count &&
1233 count <= plh->plh_size && plh->plh_size <= STACKSHOT_PLH_SIZE_MAX) {
1234 struct ipc_service_port_label **arr = plh->plh_array;
1235 size_t ispl_size, max_namelen;
1236 kdp_ipc_splabel_size(&ispl_size, &max_namelen);
1237 for (int idx = curgen_min; idx <= curgen_max; idx++) {
1238 struct ipc_service_port_label *ispl = arr[idx];
1239 struct portlabel_info spl = {
1240 .portlabel_id = (idx + 1),
1241 };
1242 const char *name = NULL;
1243 long name_sz = 0;
1244 if (plh->plh_gen[idx] != curgen) {
1245 continue;
1246 }
1247 if (_stackshot_validate_kva((vm_offset_t)ispl, ispl_size)) {
1248 kdp_ipc_fill_splabel(ispl, &spl, &name);
1249 }
1250 kcd_exit_on_error(kcdata_add_container_marker(stackshot_kcdata_p, KCDATA_TYPE_CONTAINER_BEGIN,
1251 STACKSHOT_KCCONTAINER_PORTLABEL, idx + 1));
1252 if (name != NULL && (name_sz = _stackshot_strlen(name, max_namelen)) > 0) { /* validates the kva */
1253 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_PORTLABEL_NAME, name_sz + 1, name));
1254 } else {
1255 spl.portlabel_flags |= STACKSHOT_PORTLABEL_READFAILED;
1256 }
1257 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_PORTLABEL, sizeof(spl), &spl));
1258 kcd_exit_on_error(kcdata_add_container_marker(stackshot_kcdata_p, KCDATA_TYPE_CONTAINER_END,
1259 STACKSHOT_KCCONTAINER_PORTLABEL, idx + 1));
1260 }
1261 }
1262
1263 error_exit:
1264 return error;
1265 }
1266
1267 #if DEVELOPMENT || DEBUG
1268 static kern_return_t
kdp_stackshot_plh_stats(void)1269 kdp_stackshot_plh_stats(void)
1270 {
1271 kern_return_t error = KERN_SUCCESS;
1272 struct port_label_hash *plh = &port_label_hash;
1273
1274 #define PLH_STAT(x) do { if (plh->x != 0) { \
1275 kcd_exit_on_error(kcdata_add_uint32_with_description(stackshot_kcdata_p, plh->x, "stackshot_" #x)); \
1276 } } while (0)
1277 PLH_STAT(plh_size);
1278 PLH_STAT(plh_lookups);
1279 PLH_STAT(plh_found);
1280 PLH_STAT(plh_found_depth);
1281 PLH_STAT(plh_insert);
1282 PLH_STAT(plh_insert_depth);
1283 PLH_STAT(plh_bad);
1284 PLH_STAT(plh_bad_depth);
1285 PLH_STAT(plh_lookup_send);
1286 PLH_STAT(plh_lookup_receive);
1287 #undef PLH_STAT
1288
1289 error_exit:
1290 return error;
1291 }
1292 #endif /* DEVELOPMENT || DEBUG */
1293
1294 static uint64_t
kcdata_get_task_ss_flags(task_t task)1295 kcdata_get_task_ss_flags(task_t task)
1296 {
1297 uint64_t ss_flags = 0;
1298 boolean_t task_64bit_addr = task_has_64Bit_addr(task);
1299 void *bsd_info = get_bsdtask_info(task);
1300
1301 if (task_64bit_addr) {
1302 ss_flags |= kUser64_p;
1303 }
1304 if (!task->active || task_is_a_corpse(task) || proc_exiting(bsd_info)) {
1305 ss_flags |= kTerminatedSnapshot;
1306 }
1307 if (task->pidsuspended) {
1308 ss_flags |= kPidSuspended;
1309 }
1310 if (task->frozen) {
1311 ss_flags |= kFrozen;
1312 }
1313 if (task->effective_policy.tep_darwinbg == 1) {
1314 ss_flags |= kTaskDarwinBG;
1315 }
1316 if (task->requested_policy.trp_role == TASK_FOREGROUND_APPLICATION) {
1317 ss_flags |= kTaskIsForeground;
1318 }
1319 if (task->requested_policy.trp_boosted == 1) {
1320 ss_flags |= kTaskIsBoosted;
1321 }
1322 if (task->effective_policy.tep_sup_active == 1) {
1323 ss_flags |= kTaskIsSuppressed;
1324 }
1325 #if CONFIG_MEMORYSTATUS
1326
1327 boolean_t dirty = FALSE, dirty_tracked = FALSE, allow_idle_exit = FALSE;
1328 memorystatus_proc_flags_unsafe(bsd_info, &dirty, &dirty_tracked, &allow_idle_exit);
1329 if (dirty) {
1330 ss_flags |= kTaskIsDirty;
1331 }
1332 if (dirty_tracked) {
1333 ss_flags |= kTaskIsDirtyTracked;
1334 }
1335 if (allow_idle_exit) {
1336 ss_flags |= kTaskAllowIdleExit;
1337 }
1338
1339 #endif
1340 if (task->effective_policy.tep_tal_engaged) {
1341 ss_flags |= kTaskTALEngaged;
1342 }
1343
1344 ss_flags |= (0x7 & workqueue_get_pwq_state_kdp(bsd_info)) << 17;
1345
1346 #if IMPORTANCE_INHERITANCE
1347 if (task->task_imp_base) {
1348 if (task->task_imp_base->iit_donor) {
1349 ss_flags |= kTaskIsImpDonor;
1350 }
1351 if (task->task_imp_base->iit_live_donor) {
1352 ss_flags |= kTaskIsLiveImpDonor;
1353 }
1354 }
1355 #endif
1356 return ss_flags;
1357 }
1358
1359 static kern_return_t
kcdata_record_shared_cache_info(kcdata_descriptor_t kcd,task_t task,unaligned_u64 * task_snap_ss_flags)1360 kcdata_record_shared_cache_info(kcdata_descriptor_t kcd, task_t task, unaligned_u64 *task_snap_ss_flags)
1361 {
1362 kern_return_t error = KERN_SUCCESS;
1363
1364 uint64_t shared_cache_slide = 0;
1365 uint64_t shared_cache_first_mapping = 0;
1366 uint32_t kdp_fault_results = 0;
1367 uint32_t shared_cache_id = 0;
1368 struct dyld_shared_cache_loadinfo shared_cache_data = {0};
1369
1370
1371 assert(task_snap_ss_flags != NULL);
1372
1373 /* Get basic info about the shared region pointer, regardless of any failures */
1374 if (task->shared_region == NULL) {
1375 *task_snap_ss_flags |= kTaskSharedRegionNone;
1376 } else if (task->shared_region == primary_system_shared_region) {
1377 *task_snap_ss_flags |= kTaskSharedRegionSystem;
1378 } else {
1379 *task_snap_ss_flags |= kTaskSharedRegionOther;
1380 }
1381
1382 if (task->shared_region && _stackshot_validate_kva((vm_offset_t)task->shared_region, sizeof(struct vm_shared_region))) {
1383 struct vm_shared_region *sr = task->shared_region;
1384 shared_cache_first_mapping = sr->sr_base_address + sr->sr_first_mapping;
1385
1386 shared_cache_id = sr->sr_id;
1387 } else {
1388 *task_snap_ss_flags |= kTaskSharedRegionInfoUnavailable;
1389 goto error_exit;
1390 }
1391
1392 /* We haven't copied in the shared region UUID yet as part of setup */
1393 if (!shared_cache_first_mapping || !task->shared_region->sr_uuid_copied) {
1394 goto error_exit;
1395 }
1396
1397
1398 /*
1399 * No refcounting here, but we are in debugger context, so that should be safe.
1400 */
1401 shared_cache_slide = task->shared_region->sr_slide;
1402
1403 if (task->shared_region == primary_system_shared_region) {
1404 /* skip adding shared cache info -- it's the same as the system level one */
1405 goto error_exit;
1406 }
1407 /*
1408 * New-style shared cache reference: for non-primary shared regions,
1409 * just include the ID of the shared cache we're attached to. Consumers
1410 * should use the following info from the task's ts_ss_flags as well:
1411 *
1412 * kTaskSharedRegionNone - task is not attached to a shared region
1413 * kTaskSharedRegionSystem - task is attached to the shared region
1414 * with kSharedCacheSystemPrimary set in sharedCacheFlags.
1415 * kTaskSharedRegionOther - task is attached to the shared region with
1416 * sharedCacheID matching the STACKSHOT_KCTYPE_SHAREDCACHE_ID entry.
1417 */
1418 kcd_exit_on_error(kcdata_push_data(kcd, STACKSHOT_KCTYPE_SHAREDCACHE_ID, sizeof(shared_cache_id), &shared_cache_id));
1419
1420 /*
1421 * For backwards compatibility; this should eventually be removed.
1422 *
1423 * Historically, this data was in a dyld_uuid_info_64 structure, but the
1424 * naming of both the structure and fields for this use wasn't great. The
1425 * dyld_shared_cache_loadinfo structure has better names, but the same
1426 * layout and content as the original.
1427 *
1428 * The imageSlidBaseAddress/sharedCacheUnreliableSlidBaseAddress field
1429 * has been used inconsistently for STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT
1430 * entries; here, it's the slid first mapping, and we leave it that way
1431 * for backwards compatibility.
1432 */
1433 shared_cache_data.sharedCacheSlide = shared_cache_slide;
1434 kdp_memcpy(&shared_cache_data.sharedCacheUUID, task->shared_region->sr_uuid, sizeof(task->shared_region->sr_uuid));
1435 shared_cache_data.sharedCacheUnreliableSlidBaseAddress = shared_cache_first_mapping;
1436 shared_cache_data.sharedCacheSlidFirstMapping = shared_cache_first_mapping;
1437 kcd_exit_on_error(kcdata_push_data(kcd, STACKSHOT_KCTYPE_SHAREDCACHE_LOADINFO, sizeof(shared_cache_data), &shared_cache_data));
1438
1439 error_exit:
1440 if (kdp_fault_results & KDP_FAULT_RESULT_PAGED_OUT) {
1441 *task_snap_ss_flags |= kTaskUUIDInfoMissing;
1442 }
1443
1444 if (kdp_fault_results & KDP_FAULT_RESULT_TRIED_FAULT) {
1445 *task_snap_ss_flags |= kTaskUUIDInfoTriedFault;
1446 }
1447
1448 if (kdp_fault_results & KDP_FAULT_RESULT_FAULTED_IN) {
1449 *task_snap_ss_flags |= kTaskUUIDInfoFaultedIn;
1450 }
1451
1452 return error;
1453 }
1454
1455 static kern_return_t
kcdata_record_uuid_info(kcdata_descriptor_t kcd,task_t task,uint64_t trace_flags,boolean_t have_pmap,unaligned_u64 * task_snap_ss_flags)1456 kcdata_record_uuid_info(kcdata_descriptor_t kcd, task_t task, uint64_t trace_flags, boolean_t have_pmap, unaligned_u64 *task_snap_ss_flags)
1457 {
1458 bool save_loadinfo_p = ((trace_flags & STACKSHOT_SAVE_LOADINFO) != 0);
1459 bool save_kextloadinfo_p = ((trace_flags & STACKSHOT_SAVE_KEXT_LOADINFO) != 0);
1460 bool save_compactinfo_p = ((trace_flags & STACKSHOT_SAVE_DYLD_COMPACTINFO) != 0);
1461 bool should_fault = (trace_flags & STACKSHOT_ENABLE_UUID_FAULTING);
1462
1463 kern_return_t error = KERN_SUCCESS;
1464 mach_vm_address_t out_addr = 0;
1465
1466 mach_vm_address_t dyld_compactinfo_addr = 0;
1467 uint32_t dyld_compactinfo_size = 0;
1468
1469 uint32_t uuid_info_count = 0;
1470 mach_vm_address_t uuid_info_addr = 0;
1471 uint64_t uuid_info_timestamp = 0;
1472 kdp_fault_result_flags_t kdp_fault_results = 0;
1473
1474
1475 assert(task_snap_ss_flags != NULL);
1476
1477 int task_pid = pid_from_task(task);
1478 boolean_t task_64bit_addr = task_has_64Bit_addr(task);
1479
1480 if ((save_loadinfo_p || save_compactinfo_p) && have_pmap && task->active && task_pid > 0) {
1481 /* Read the dyld_all_image_infos struct from the task memory to get UUID array count and location */
1482 if (task_64bit_addr) {
1483 struct user64_dyld_all_image_infos task_image_infos;
1484 if (stackshot_copyin(task->map, task->all_image_info_addr, &task_image_infos,
1485 sizeof(struct user64_dyld_all_image_infos), should_fault, &kdp_fault_results)) {
1486 uuid_info_count = (uint32_t)task_image_infos.uuidArrayCount;
1487 uuid_info_addr = task_image_infos.uuidArray;
1488 if (task_image_infos.version >= DYLD_ALL_IMAGE_INFOS_TIMESTAMP_MINIMUM_VERSION) {
1489 uuid_info_timestamp = task_image_infos.timestamp;
1490 }
1491 if (task_image_infos.version >= DYLD_ALL_IMAGE_INFOS_COMPACTINFO_MINIMUM_VERSION) {
1492 dyld_compactinfo_addr = task_image_infos.compact_dyld_image_info_addr;
1493 dyld_compactinfo_size = task_image_infos.compact_dyld_image_info_size;
1494 }
1495
1496 }
1497 } else {
1498 struct user32_dyld_all_image_infos task_image_infos;
1499 if (stackshot_copyin(task->map, task->all_image_info_addr, &task_image_infos,
1500 sizeof(struct user32_dyld_all_image_infos), should_fault, &kdp_fault_results)) {
1501 uuid_info_count = task_image_infos.uuidArrayCount;
1502 uuid_info_addr = task_image_infos.uuidArray;
1503 if (task_image_infos.version >= DYLD_ALL_IMAGE_INFOS_TIMESTAMP_MINIMUM_VERSION) {
1504 uuid_info_timestamp = task_image_infos.timestamp;
1505 }
1506 if (task_image_infos.version >= DYLD_ALL_IMAGE_INFOS_COMPACTINFO_MINIMUM_VERSION) {
1507 dyld_compactinfo_addr = task_image_infos.compact_dyld_image_info_addr;
1508 dyld_compactinfo_size = task_image_infos.compact_dyld_image_info_size;
1509 }
1510 }
1511 }
1512
1513 /*
1514 * If we get a NULL uuid_info_addr (which can happen when we catch dyld in the middle of updating
1515 * this data structure), we zero the uuid_info_count so that we won't even try to save load info
1516 * for this task.
1517 */
1518 if (!uuid_info_addr) {
1519 uuid_info_count = 0;
1520 }
1521
1522 if (!dyld_compactinfo_addr) {
1523 dyld_compactinfo_size = 0;
1524 }
1525
1526 }
1527
1528 if (have_pmap && task_pid == 0) {
1529 if (save_kextloadinfo_p && _stackshot_validate_kva((vm_offset_t)(gLoadedKextSummaries), sizeof(OSKextLoadedKextSummaryHeader))) {
1530 uuid_info_count = gLoadedKextSummaries->numSummaries + 1; /* include main kernel UUID */
1531 } else {
1532 uuid_info_count = 1; /* include kernelcache UUID (embedded) or kernel UUID (desktop) */
1533 }
1534 }
1535
1536 if (save_compactinfo_p && task_pid > 0) {
1537 if (dyld_compactinfo_size == 0) {
1538 *task_snap_ss_flags |= kTaskDyldCompactInfoNone;
1539 } else if (dyld_compactinfo_size > MAX_DYLD_COMPACTINFO) {
1540 *task_snap_ss_flags |= kTaskDyldCompactInfoTooBig;
1541 } else {
1542 kdp_fault_result_flags_t ci_kdp_fault_results = 0;
1543
1544 /* Open a compression window to avoid overflowing the stack */
1545 kcdata_compression_window_open(kcd);
1546 kcd_exit_on_error(kcdata_get_memory_addr(kcd, STACKSHOT_KCTYPE_DYLD_COMPACTINFO,
1547 dyld_compactinfo_size, &out_addr));
1548
1549 if (!stackshot_copyin(task->map, dyld_compactinfo_addr, (void *)out_addr,
1550 dyld_compactinfo_size, should_fault, &ci_kdp_fault_results)) {
1551 bzero((void *)out_addr, dyld_compactinfo_size);
1552 }
1553 if (ci_kdp_fault_results & KDP_FAULT_RESULT_PAGED_OUT) {
1554 *task_snap_ss_flags |= kTaskDyldCompactInfoMissing;
1555 }
1556
1557 if (ci_kdp_fault_results & KDP_FAULT_RESULT_TRIED_FAULT) {
1558 *task_snap_ss_flags |= kTaskDyldCompactInfoTriedFault;
1559 }
1560
1561 if (ci_kdp_fault_results & KDP_FAULT_RESULT_FAULTED_IN) {
1562 *task_snap_ss_flags |= kTaskDyldCompactInfoFaultedIn;
1563 }
1564
1565 kcd_exit_on_error(kcdata_compression_window_close(kcd));
1566 }
1567 }
1568 if (save_loadinfo_p && task_pid > 0 && (uuid_info_count < MAX_LOADINFOS)) {
1569 uint32_t copied_uuid_count = 0;
1570 uint32_t uuid_info_size = (uint32_t)(task_64bit_addr ? sizeof(struct user64_dyld_uuid_info) : sizeof(struct user32_dyld_uuid_info));
1571 uint32_t uuid_info_array_size = 0;
1572
1573 /* Open a compression window to avoid overflowing the stack */
1574 kcdata_compression_window_open(kcd);
1575
1576 /* If we found some UUID information, first try to copy it in -- this will only be non-zero if we had a pmap above */
1577 if (uuid_info_count > 0) {
1578 uuid_info_array_size = uuid_info_count * uuid_info_size;
1579
1580 kcd_exit_on_error(kcdata_get_memory_addr_for_array(kcd, (task_64bit_addr ? KCDATA_TYPE_LIBRARY_LOADINFO64 : KCDATA_TYPE_LIBRARY_LOADINFO),
1581 uuid_info_size, uuid_info_count, &out_addr));
1582
1583 if (!stackshot_copyin(task->map, uuid_info_addr, (void *)out_addr, uuid_info_array_size, should_fault, &kdp_fault_results)) {
1584 bzero((void *)out_addr, uuid_info_array_size);
1585 } else {
1586 copied_uuid_count = uuid_info_count;
1587 }
1588 }
1589
1590 uuid_t binary_uuid;
1591 if (!copied_uuid_count && proc_binary_uuid_kdp(task, binary_uuid)) {
1592 /* We failed to copyin the UUID information, try to store the UUID of the main binary we have in the proc */
1593 if (uuid_info_array_size == 0) {
1594 /* We just need to store one UUID */
1595 uuid_info_array_size = uuid_info_size;
1596 kcd_exit_on_error(kcdata_get_memory_addr_for_array(kcd, (task_64bit_addr ? KCDATA_TYPE_LIBRARY_LOADINFO64 : KCDATA_TYPE_LIBRARY_LOADINFO),
1597 uuid_info_size, 1, &out_addr));
1598 }
1599
1600 if (task_64bit_addr) {
1601 struct user64_dyld_uuid_info *uuid_info = (struct user64_dyld_uuid_info *)out_addr;
1602 uint64_t image_load_address = task->mach_header_vm_address;
1603
1604 kdp_memcpy(&uuid_info->imageUUID, binary_uuid, sizeof(uuid_t));
1605 kdp_memcpy(&uuid_info->imageLoadAddress, &image_load_address, sizeof(image_load_address));
1606 } else {
1607 struct user32_dyld_uuid_info *uuid_info = (struct user32_dyld_uuid_info *)out_addr;
1608 uint32_t image_load_address = (uint32_t) task->mach_header_vm_address;
1609
1610 kdp_memcpy(&uuid_info->imageUUID, binary_uuid, sizeof(uuid_t));
1611 kdp_memcpy(&uuid_info->imageLoadAddress, &image_load_address, sizeof(image_load_address));
1612 }
1613 }
1614
1615 kcd_exit_on_error(kcdata_compression_window_close(kcd));
1616 } else if (task_pid == 0 && uuid_info_count > 0 && uuid_info_count < MAX_LOADINFOS) {
1617 uintptr_t image_load_address;
1618
1619 do {
1620 #if defined(__arm64__)
1621 if (kernelcache_uuid_valid && !save_kextloadinfo_p) {
1622 struct dyld_uuid_info_64 kc_uuid = {0};
1623 kc_uuid.imageLoadAddress = VM_MIN_KERNEL_AND_KEXT_ADDRESS;
1624 kdp_memcpy(&kc_uuid.imageUUID, &kernelcache_uuid, sizeof(uuid_t));
1625 kcd_exit_on_error(kcdata_push_data(kcd, STACKSHOT_KCTYPE_KERNELCACHE_LOADINFO, sizeof(struct dyld_uuid_info_64), &kc_uuid));
1626 break;
1627 }
1628 #endif /* defined(__arm64__) */
1629
1630 if (!kernel_uuid || !_stackshot_validate_kva((vm_offset_t)kernel_uuid, sizeof(uuid_t))) {
1631 /* Kernel UUID not found or inaccessible */
1632 break;
1633 }
1634
1635 uint32_t uuid_type = KCDATA_TYPE_LIBRARY_LOADINFO;
1636 if ((sizeof(kernel_uuid_info) == sizeof(struct user64_dyld_uuid_info))) {
1637 uuid_type = KCDATA_TYPE_LIBRARY_LOADINFO64;
1638 #if defined(__arm64__)
1639 kc_format_t primary_kc_type = KCFormatUnknown;
1640 if (PE_get_primary_kc_format(&primary_kc_type) && (primary_kc_type == KCFormatFileset)) {
1641 /* return TEXT_EXEC based load information on arm devices running with fileset kernelcaches */
1642 uuid_type = STACKSHOT_KCTYPE_LOADINFO64_TEXT_EXEC;
1643 }
1644 #endif
1645 }
1646
1647 /*
1648 * The element count of the array can vary - avoid overflowing the
1649 * stack by opening a window.
1650 */
1651 kcdata_compression_window_open(kcd);
1652 kcd_exit_on_error(kcdata_get_memory_addr_for_array(kcd, uuid_type,
1653 sizeof(kernel_uuid_info), uuid_info_count, &out_addr));
1654 kernel_uuid_info *uuid_info_array = (kernel_uuid_info *)out_addr;
1655
1656 image_load_address = (uintptr_t)VM_KERNEL_UNSLIDE(vm_kernel_stext);
1657 #if defined(__arm64__)
1658 if (uuid_type == STACKSHOT_KCTYPE_LOADINFO64_TEXT_EXEC) {
1659 /* If we're reporting TEXT_EXEC load info, populate the TEXT_EXEC base instead */
1660 extern vm_offset_t segTEXTEXECB;
1661 image_load_address = (uintptr_t)VM_KERNEL_UNSLIDE(segTEXTEXECB);
1662 }
1663 #endif
1664 uuid_info_array[0].imageLoadAddress = image_load_address;
1665 kdp_memcpy(&uuid_info_array[0].imageUUID, kernel_uuid, sizeof(uuid_t));
1666
1667 if (save_kextloadinfo_p &&
1668 _stackshot_validate_kva((vm_offset_t)(gLoadedKextSummaries), sizeof(OSKextLoadedKextSummaryHeader)) &&
1669 _stackshot_validate_kva((vm_offset_t)(&gLoadedKextSummaries->summaries[0]),
1670 gLoadedKextSummaries->entry_size * gLoadedKextSummaries->numSummaries)) {
1671 uint32_t kexti;
1672 for (kexti = 0; kexti < gLoadedKextSummaries->numSummaries; kexti++) {
1673 image_load_address = (uintptr_t)VM_KERNEL_UNSLIDE(gLoadedKextSummaries->summaries[kexti].address);
1674 #if defined(__arm64__)
1675 if (uuid_type == STACKSHOT_KCTYPE_LOADINFO64_TEXT_EXEC) {
1676 /* If we're reporting TEXT_EXEC load info, populate the TEXT_EXEC base instead */
1677 image_load_address = (uintptr_t)VM_KERNEL_UNSLIDE(gLoadedKextSummaries->summaries[kexti].text_exec_address);
1678 }
1679 #endif
1680 uuid_info_array[kexti + 1].imageLoadAddress = image_load_address;
1681 kdp_memcpy(&uuid_info_array[kexti + 1].imageUUID, &gLoadedKextSummaries->summaries[kexti].uuid, sizeof(uuid_t));
1682 }
1683 }
1684 kcd_exit_on_error(kcdata_compression_window_close(kcd));
1685 } while (0);
1686 }
1687
1688 error_exit:
1689 if (kdp_fault_results & KDP_FAULT_RESULT_PAGED_OUT) {
1690 *task_snap_ss_flags |= kTaskUUIDInfoMissing;
1691 }
1692
1693 if (kdp_fault_results & KDP_FAULT_RESULT_TRIED_FAULT) {
1694 *task_snap_ss_flags |= kTaskUUIDInfoTriedFault;
1695 }
1696
1697 if (kdp_fault_results & KDP_FAULT_RESULT_FAULTED_IN) {
1698 *task_snap_ss_flags |= kTaskUUIDInfoFaultedIn;
1699 }
1700
1701 return error;
1702 }
1703
1704 static kern_return_t
kcdata_record_task_iostats(kcdata_descriptor_t kcd,task_t task)1705 kcdata_record_task_iostats(kcdata_descriptor_t kcd, task_t task)
1706 {
1707 kern_return_t error = KERN_SUCCESS;
1708 mach_vm_address_t out_addr = 0;
1709
1710 /* I/O Statistics if any counters are non zero */
1711 assert(IO_NUM_PRIORITIES == STACKSHOT_IO_NUM_PRIORITIES);
1712 if (task->task_io_stats && !memory_iszero(task->task_io_stats, sizeof(struct io_stat_info))) {
1713 /* struct io_stats_snapshot is quite large - avoid overflowing the stack. */
1714 kcdata_compression_window_open(kcd);
1715 kcd_exit_on_error(kcdata_get_memory_addr(kcd, STACKSHOT_KCTYPE_IOSTATS, sizeof(struct io_stats_snapshot), &out_addr));
1716 struct io_stats_snapshot *_iostat = (struct io_stats_snapshot *)out_addr;
1717 _iostat->ss_disk_reads_count = task->task_io_stats->disk_reads.count;
1718 _iostat->ss_disk_reads_size = task->task_io_stats->disk_reads.size;
1719 _iostat->ss_disk_writes_count = (task->task_io_stats->total_io.count - task->task_io_stats->disk_reads.count);
1720 _iostat->ss_disk_writes_size = (task->task_io_stats->total_io.size - task->task_io_stats->disk_reads.size);
1721 _iostat->ss_paging_count = task->task_io_stats->paging.count;
1722 _iostat->ss_paging_size = task->task_io_stats->paging.size;
1723 _iostat->ss_non_paging_count = (task->task_io_stats->total_io.count - task->task_io_stats->paging.count);
1724 _iostat->ss_non_paging_size = (task->task_io_stats->total_io.size - task->task_io_stats->paging.size);
1725 _iostat->ss_metadata_count = task->task_io_stats->metadata.count;
1726 _iostat->ss_metadata_size = task->task_io_stats->metadata.size;
1727 _iostat->ss_data_count = (task->task_io_stats->total_io.count - task->task_io_stats->metadata.count);
1728 _iostat->ss_data_size = (task->task_io_stats->total_io.size - task->task_io_stats->metadata.size);
1729 for (int i = 0; i < IO_NUM_PRIORITIES; i++) {
1730 _iostat->ss_io_priority_count[i] = task->task_io_stats->io_priority[i].count;
1731 _iostat->ss_io_priority_size[i] = task->task_io_stats->io_priority[i].size;
1732 }
1733 kcd_exit_on_error(kcdata_compression_window_close(kcd));
1734 }
1735
1736
1737 error_exit:
1738 return error;
1739 }
1740
1741 #if CONFIG_PERVASIVE_CPI
1742 static kern_return_t
kcdata_record_task_instrs_cycles(kcdata_descriptor_t kcd,task_t task)1743 kcdata_record_task_instrs_cycles(kcdata_descriptor_t kcd, task_t task)
1744 {
1745 struct instrs_cycles_snapshot_v2 instrs_cycles = { 0 };
1746 struct recount_usage usage = { 0 };
1747 struct recount_usage perf_only = { 0 };
1748 recount_task_terminated_usage_perf_only(task, &usage, &perf_only);
1749 instrs_cycles.ics_instructions = usage.ru_instructions;
1750 instrs_cycles.ics_cycles = usage.ru_cycles;
1751 instrs_cycles.ics_p_instructions = perf_only.ru_instructions;
1752 instrs_cycles.ics_p_cycles = perf_only.ru_cycles;
1753
1754 return kcdata_push_data(kcd, STACKSHOT_KCTYPE_INSTRS_CYCLES, sizeof(instrs_cycles), &instrs_cycles);
1755 }
1756 #endif /* CONFIG_PERVASIVE_CPI */
1757
1758 static kern_return_t
kcdata_record_task_cpu_architecture(kcdata_descriptor_t kcd,task_t task)1759 kcdata_record_task_cpu_architecture(kcdata_descriptor_t kcd, task_t task)
1760 {
1761 struct stackshot_cpu_architecture cpu_architecture = {0};
1762 int32_t cputype;
1763 int32_t cpusubtype;
1764
1765 proc_archinfo_kdp(get_bsdtask_info(task), &cputype, &cpusubtype);
1766 cpu_architecture.cputype = cputype;
1767 cpu_architecture.cpusubtype = cpusubtype;
1768
1769 return kcdata_push_data(kcd, STACKSHOT_KCTYPE_TASK_CPU_ARCHITECTURE, sizeof(struct stackshot_cpu_architecture), &cpu_architecture);
1770 }
1771
1772 static kern_return_t
kcdata_record_transitioning_task_snapshot(kcdata_descriptor_t kcd,task_t task,unaligned_u64 task_snap_ss_flags,uint64_t transition_type)1773 kcdata_record_transitioning_task_snapshot(kcdata_descriptor_t kcd, task_t task, unaligned_u64 task_snap_ss_flags, uint64_t transition_type)
1774 {
1775 kern_return_t error = KERN_SUCCESS;
1776 mach_vm_address_t out_addr = 0;
1777 struct transitioning_task_snapshot * cur_tsnap = NULL;
1778
1779 int task_pid = pid_from_task(task);
1780 /* Is returning -1 ok for terminating task ok ??? */
1781 uint64_t task_uniqueid = get_task_uniqueid(task);
1782
1783 if (task_pid && (task_did_exec_internal(task) || task_is_exec_copy_internal(task))) {
1784 /*
1785 * if this task is a transit task from another one, show the pid as
1786 * negative
1787 */
1788 task_pid = 0 - task_pid;
1789 }
1790
1791 /* the task_snapshot_v2 struct is large - avoid overflowing the stack */
1792 kcdata_compression_window_open(kcd);
1793 kcd_exit_on_error(kcdata_get_memory_addr(kcd, STACKSHOT_KCTYPE_TRANSITIONING_TASK_SNAPSHOT, sizeof(struct transitioning_task_snapshot), &out_addr));
1794 cur_tsnap = (struct transitioning_task_snapshot *)out_addr;
1795 bzero(cur_tsnap, sizeof(*cur_tsnap));
1796
1797 cur_tsnap->tts_unique_pid = task_uniqueid;
1798 cur_tsnap->tts_ss_flags = kcdata_get_task_ss_flags(task);
1799 cur_tsnap->tts_ss_flags |= task_snap_ss_flags;
1800 cur_tsnap->tts_transition_type = transition_type;
1801 cur_tsnap->tts_pid = task_pid;
1802
1803 /* Add the BSD process identifiers */
1804 if (task_pid != -1 && get_bsdtask_info(task) != NULL) {
1805 proc_name_kdp(get_bsdtask_info(task), cur_tsnap->tts_p_comm, sizeof(cur_tsnap->tts_p_comm));
1806 } else {
1807 cur_tsnap->tts_p_comm[0] = '\0';
1808 }
1809
1810 kcd_exit_on_error(kcdata_compression_window_close(kcd));
1811
1812 error_exit:
1813 return error;
1814 }
1815
1816 static kern_return_t
1817 #if STACKSHOT_COLLECTS_LATENCY_INFO
kcdata_record_task_snapshot(kcdata_descriptor_t kcd,task_t task,uint64_t trace_flags,boolean_t have_pmap,unaligned_u64 task_snap_ss_flags,struct stackshot_latency_task * latency_info)1818 kcdata_record_task_snapshot(kcdata_descriptor_t kcd, task_t task, uint64_t trace_flags, boolean_t have_pmap, unaligned_u64 task_snap_ss_flags, struct stackshot_latency_task *latency_info)
1819 #else
1820 kcdata_record_task_snapshot(kcdata_descriptor_t kcd, task_t task, uint64_t trace_flags, boolean_t have_pmap, unaligned_u64 task_snap_ss_flags)
1821 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
1822 {
1823 boolean_t collect_delta_stackshot = ((trace_flags & STACKSHOT_COLLECT_DELTA_SNAPSHOT) != 0);
1824 boolean_t collect_iostats = !collect_delta_stackshot && !(trace_flags & STACKSHOT_NO_IO_STATS);
1825 #if CONFIG_PERVASIVE_CPI
1826 boolean_t collect_instrs_cycles = ((trace_flags & STACKSHOT_INSTRS_CYCLES) != 0);
1827 #endif /* CONFIG_PERVASIVE_CPI */
1828 #if __arm64__
1829 boolean_t collect_asid = ((trace_flags & STACKSHOT_ASID) != 0);
1830 #endif
1831 boolean_t collect_pagetables = ((trace_flags & STACKSHOT_PAGE_TABLES) != 0);
1832
1833
1834 kern_return_t error = KERN_SUCCESS;
1835 mach_vm_address_t out_addr = 0;
1836 struct task_snapshot_v2 * cur_tsnap = NULL;
1837 #if STACKSHOT_COLLECTS_LATENCY_INFO
1838 latency_info->cur_tsnap_latency = mach_absolute_time();
1839 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
1840
1841 int task_pid = pid_from_task(task);
1842 uint64_t task_uniqueid = get_task_uniqueid(task);
1843 void *bsd_info = get_bsdtask_info(task);
1844 uint64_t proc_starttime_secs = 0;
1845
1846 if (task_pid && (task_did_exec_internal(task) || task_is_exec_copy_internal(task))) {
1847 /*
1848 * if this task is a transit task from another one, show the pid as
1849 * negative
1850 */
1851 task_pid = 0 - task_pid;
1852 }
1853
1854 /* the task_snapshot_v2 struct is large - avoid overflowing the stack */
1855 kcdata_compression_window_open(kcd);
1856 kcd_exit_on_error(kcdata_get_memory_addr(kcd, STACKSHOT_KCTYPE_TASK_SNAPSHOT, sizeof(struct task_snapshot_v2), &out_addr));
1857 cur_tsnap = (struct task_snapshot_v2 *)out_addr;
1858 bzero(cur_tsnap, sizeof(*cur_tsnap));
1859
1860 cur_tsnap->ts_unique_pid = task_uniqueid;
1861 cur_tsnap->ts_ss_flags = kcdata_get_task_ss_flags(task);
1862 cur_tsnap->ts_ss_flags |= task_snap_ss_flags;
1863
1864 struct recount_usage term_usage = { 0 };
1865 recount_task_terminated_usage(task, &term_usage);
1866 cur_tsnap->ts_user_time_in_terminated_threads =
1867 term_usage.ru_user_time_mach;
1868 cur_tsnap->ts_system_time_in_terminated_threads =
1869 term_usage.ru_system_time_mach;
1870
1871 proc_starttime_kdp(bsd_info, &proc_starttime_secs, NULL, NULL);
1872 cur_tsnap->ts_p_start_sec = proc_starttime_secs;
1873 cur_tsnap->ts_task_size = have_pmap ? get_task_phys_footprint(task) : 0;
1874 cur_tsnap->ts_max_resident_size = get_task_resident_max(task);
1875 cur_tsnap->ts_was_throttled = (uint32_t) proc_was_throttled_from_task(task);
1876 cur_tsnap->ts_did_throttle = (uint32_t) proc_did_throttle_from_task(task);
1877
1878 cur_tsnap->ts_suspend_count = task->suspend_count;
1879 cur_tsnap->ts_faults = counter_load(&task->faults);
1880 cur_tsnap->ts_pageins = counter_load(&task->pageins);
1881 cur_tsnap->ts_cow_faults = counter_load(&task->cow_faults);
1882 cur_tsnap->ts_latency_qos = (task->effective_policy.tep_latency_qos == LATENCY_QOS_TIER_UNSPECIFIED) ?
1883 LATENCY_QOS_TIER_UNSPECIFIED : ((0xFF << 16) | task->effective_policy.tep_latency_qos);
1884 cur_tsnap->ts_pid = task_pid;
1885
1886 /* Add the BSD process identifiers */
1887 if (task_pid != -1 && bsd_info != NULL) {
1888 proc_name_kdp(bsd_info, cur_tsnap->ts_p_comm, sizeof(cur_tsnap->ts_p_comm));
1889 } else {
1890 cur_tsnap->ts_p_comm[0] = '\0';
1891 #if IMPORTANCE_INHERITANCE && (DEVELOPMENT || DEBUG)
1892 if (task->task_imp_base != NULL) {
1893 kdp_strlcpy(cur_tsnap->ts_p_comm, &task->task_imp_base->iit_procname[0],
1894 MIN((int)sizeof(task->task_imp_base->iit_procname), (int)sizeof(cur_tsnap->ts_p_comm)));
1895 }
1896 #endif /* IMPORTANCE_INHERITANCE && (DEVELOPMENT || DEBUG) */
1897 }
1898
1899 kcd_exit_on_error(kcdata_compression_window_close(kcd));
1900
1901 #if CONFIG_COALITIONS
1902 if (task_pid != -1 && bsd_info != NULL &&
1903 ((trace_flags & STACKSHOT_SAVE_JETSAM_COALITIONS) && (task->coalition[COALITION_TYPE_JETSAM] != NULL))) {
1904 uint64_t jetsam_coal_id = coalition_id(task->coalition[COALITION_TYPE_JETSAM]);
1905 kcd_exit_on_error(kcdata_push_data(kcd, STACKSHOT_KCTYPE_JETSAM_COALITION, sizeof(jetsam_coal_id), &jetsam_coal_id));
1906 }
1907 #endif /* CONFIG_COALITIONS */
1908
1909 #if __arm64__
1910 if (collect_asid && have_pmap) {
1911 uint32_t asid = PMAP_VASID(task->map->pmap);
1912 kcd_exit_on_error(kcdata_push_data(kcd, STACKSHOT_KCTYPE_ASID, sizeof(asid), &asid));
1913 }
1914 #endif
1915
1916 #if STACKSHOT_COLLECTS_LATENCY_INFO
1917 latency_info->cur_tsnap_latency = mach_absolute_time() - latency_info->cur_tsnap_latency;
1918 latency_info->pmap_latency = mach_absolute_time();
1919 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
1920
1921 if (collect_pagetables && have_pmap) {
1922 #if SCHED_HYGIENE_DEBUG
1923 // pagetable dumps can be large; reset the interrupt timeout to avoid a panic
1924 ml_spin_debug_clear_self();
1925 #endif
1926 size_t bytes_dumped = 0;
1927 error = pmap_dump_page_tables(task->map->pmap, kcd_end_address(kcd), kcd_max_address(kcd), stack_snapshot_pagetable_mask, &bytes_dumped);
1928 if (error != KERN_SUCCESS) {
1929 goto error_exit;
1930 } else {
1931 /* Variable size array - better not have it on the stack. */
1932 kcdata_compression_window_open(kcd);
1933 kcd_exit_on_error(kcdata_get_memory_addr_for_array(kcd, STACKSHOT_KCTYPE_PAGE_TABLES,
1934 sizeof(uint64_t), (uint32_t)(bytes_dumped / sizeof(uint64_t)), &out_addr));
1935 kcd_exit_on_error(kcdata_compression_window_close(kcd));
1936 }
1937 }
1938
1939 #if STACKSHOT_COLLECTS_LATENCY_INFO
1940 latency_info->pmap_latency = mach_absolute_time() - latency_info->pmap_latency;
1941 latency_info->bsd_proc_ids_latency = mach_absolute_time();
1942 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
1943
1944 #if STACKSHOT_COLLECTS_LATENCY_INFO
1945 latency_info->bsd_proc_ids_latency = mach_absolute_time() - latency_info->bsd_proc_ids_latency;
1946 latency_info->end_latency = mach_absolute_time();
1947 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
1948
1949 if (collect_iostats) {
1950 kcd_exit_on_error(kcdata_record_task_iostats(kcd, task));
1951 }
1952
1953 #if CONFIG_PERVASIVE_CPI
1954 if (collect_instrs_cycles) {
1955 kcd_exit_on_error(kcdata_record_task_instrs_cycles(kcd, task));
1956 }
1957 #endif /* CONFIG_PERVASIVE_CPI */
1958
1959 kcd_exit_on_error(kcdata_record_task_cpu_architecture(kcd, task));
1960
1961 #if STACKSHOT_COLLECTS_LATENCY_INFO
1962 latency_info->end_latency = mach_absolute_time() - latency_info->end_latency;
1963 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
1964
1965 error_exit:
1966 return error;
1967 }
1968
1969 static kern_return_t
kcdata_record_task_delta_snapshot(kcdata_descriptor_t kcd,task_t task,uint64_t trace_flags,boolean_t have_pmap,unaligned_u64 task_snap_ss_flags)1970 kcdata_record_task_delta_snapshot(kcdata_descriptor_t kcd, task_t task, uint64_t trace_flags, boolean_t have_pmap, unaligned_u64 task_snap_ss_flags)
1971 {
1972 #if !CONFIG_PERVASIVE_CPI
1973 #pragma unused(trace_flags)
1974 #endif /* !CONFIG_PERVASIVE_CPI */
1975 kern_return_t error = KERN_SUCCESS;
1976 struct task_delta_snapshot_v2 * cur_tsnap = NULL;
1977 mach_vm_address_t out_addr = 0;
1978 (void) trace_flags;
1979 #if __arm64__
1980 boolean_t collect_asid = ((trace_flags & STACKSHOT_ASID) != 0);
1981 #endif
1982 #if CONFIG_PERVASIVE_CPI
1983 boolean_t collect_instrs_cycles = ((trace_flags & STACKSHOT_INSTRS_CYCLES) != 0);
1984 #endif /* CONFIG_PERVASIVE_CPI */
1985
1986 uint64_t task_uniqueid = get_task_uniqueid(task);
1987
1988 kcd_exit_on_error(kcdata_get_memory_addr(kcd, STACKSHOT_KCTYPE_TASK_DELTA_SNAPSHOT, sizeof(struct task_delta_snapshot_v2), &out_addr));
1989
1990 cur_tsnap = (struct task_delta_snapshot_v2 *)out_addr;
1991
1992 cur_tsnap->tds_unique_pid = task_uniqueid;
1993 cur_tsnap->tds_ss_flags = kcdata_get_task_ss_flags(task);
1994 cur_tsnap->tds_ss_flags |= task_snap_ss_flags;
1995
1996 struct recount_usage usage = { 0 };
1997 recount_task_terminated_usage(task, &usage);
1998
1999 cur_tsnap->tds_user_time_in_terminated_threads = usage.ru_user_time_mach;
2000 cur_tsnap->tds_system_time_in_terminated_threads =
2001 usage.ru_system_time_mach;
2002
2003 cur_tsnap->tds_task_size = have_pmap ? get_task_phys_footprint(task) : 0;
2004
2005 cur_tsnap->tds_max_resident_size = get_task_resident_max(task);
2006 cur_tsnap->tds_suspend_count = task->suspend_count;
2007 cur_tsnap->tds_faults = counter_load(&task->faults);
2008 cur_tsnap->tds_pageins = counter_load(&task->pageins);
2009 cur_tsnap->tds_cow_faults = counter_load(&task->cow_faults);
2010 cur_tsnap->tds_was_throttled = (uint32_t)proc_was_throttled_from_task(task);
2011 cur_tsnap->tds_did_throttle = (uint32_t)proc_did_throttle_from_task(task);
2012 cur_tsnap->tds_latency_qos = (task->effective_policy.tep_latency_qos == LATENCY_QOS_TIER_UNSPECIFIED)
2013 ? LATENCY_QOS_TIER_UNSPECIFIED
2014 : ((0xFF << 16) | task->effective_policy.tep_latency_qos);
2015
2016 #if __arm64__
2017 if (collect_asid && have_pmap) {
2018 uint32_t asid = PMAP_VASID(task->map->pmap);
2019 kcd_exit_on_error(kcdata_get_memory_addr(kcd, STACKSHOT_KCTYPE_ASID, sizeof(uint32_t), &out_addr));
2020 kdp_memcpy((void*)out_addr, &asid, sizeof(asid));
2021 }
2022 #endif
2023
2024 #if CONFIG_PERVASIVE_CPI
2025 if (collect_instrs_cycles) {
2026 kcd_exit_on_error(kcdata_record_task_instrs_cycles(kcd, task));
2027 }
2028 #endif /* CONFIG_PERVASIVE_CPI */
2029
2030 error_exit:
2031 return error;
2032 }
2033
2034 static kern_return_t
kcdata_record_thread_iostats(kcdata_descriptor_t kcd,thread_t thread)2035 kcdata_record_thread_iostats(kcdata_descriptor_t kcd, thread_t thread)
2036 {
2037 kern_return_t error = KERN_SUCCESS;
2038 mach_vm_address_t out_addr = 0;
2039
2040 /* I/O Statistics */
2041 assert(IO_NUM_PRIORITIES == STACKSHOT_IO_NUM_PRIORITIES);
2042 if (thread->thread_io_stats && !memory_iszero(thread->thread_io_stats, sizeof(struct io_stat_info))) {
2043 kcd_exit_on_error(kcdata_get_memory_addr(kcd, STACKSHOT_KCTYPE_IOSTATS, sizeof(struct io_stats_snapshot), &out_addr));
2044 struct io_stats_snapshot *_iostat = (struct io_stats_snapshot *)out_addr;
2045 _iostat->ss_disk_reads_count = thread->thread_io_stats->disk_reads.count;
2046 _iostat->ss_disk_reads_size = thread->thread_io_stats->disk_reads.size;
2047 _iostat->ss_disk_writes_count = (thread->thread_io_stats->total_io.count - thread->thread_io_stats->disk_reads.count);
2048 _iostat->ss_disk_writes_size = (thread->thread_io_stats->total_io.size - thread->thread_io_stats->disk_reads.size);
2049 _iostat->ss_paging_count = thread->thread_io_stats->paging.count;
2050 _iostat->ss_paging_size = thread->thread_io_stats->paging.size;
2051 _iostat->ss_non_paging_count = (thread->thread_io_stats->total_io.count - thread->thread_io_stats->paging.count);
2052 _iostat->ss_non_paging_size = (thread->thread_io_stats->total_io.size - thread->thread_io_stats->paging.size);
2053 _iostat->ss_metadata_count = thread->thread_io_stats->metadata.count;
2054 _iostat->ss_metadata_size = thread->thread_io_stats->metadata.size;
2055 _iostat->ss_data_count = (thread->thread_io_stats->total_io.count - thread->thread_io_stats->metadata.count);
2056 _iostat->ss_data_size = (thread->thread_io_stats->total_io.size - thread->thread_io_stats->metadata.size);
2057 for (int i = 0; i < IO_NUM_PRIORITIES; i++) {
2058 _iostat->ss_io_priority_count[i] = thread->thread_io_stats->io_priority[i].count;
2059 _iostat->ss_io_priority_size[i] = thread->thread_io_stats->io_priority[i].size;
2060 }
2061 }
2062
2063 error_exit:
2064 return error;
2065 }
2066
2067 bool
machine_trace_thread_validate_kva(vm_offset_t addr)2068 machine_trace_thread_validate_kva(vm_offset_t addr)
2069 {
2070 return _stackshot_validate_kva(addr, sizeof(uintptr_t));
2071 }
2072
2073 struct _stackshot_backtrace_context {
2074 vm_map_t sbc_map;
2075 vm_offset_t sbc_prev_page;
2076 vm_offset_t sbc_prev_kva;
2077 uint32_t sbc_flags;
2078 bool sbc_allow_faulting;
2079 };
2080
2081 static errno_t
_stackshot_backtrace_copy(void * vctx,void * dst,user_addr_t src,size_t size)2082 _stackshot_backtrace_copy(void *vctx, void *dst, user_addr_t src, size_t size)
2083 {
2084 struct _stackshot_backtrace_context *ctx = vctx;
2085 size_t map_page_mask = 0;
2086 size_t __assert_only map_page_size = kdp_vm_map_get_page_size(ctx->sbc_map,
2087 &map_page_mask);
2088 assert(size < map_page_size);
2089 if (src & (size - 1)) {
2090 // The source should be aligned to the size passed in, like a stack
2091 // frame or word.
2092 return EINVAL;
2093 }
2094
2095 vm_offset_t src_page = src & ~map_page_mask;
2096 vm_offset_t src_kva = 0;
2097
2098 if (src_page != ctx->sbc_prev_page) {
2099 uint32_t res = 0;
2100 uint32_t flags = 0;
2101 vm_offset_t src_pa = stackshot_find_phys(ctx->sbc_map, src,
2102 ctx->sbc_allow_faulting, &res);
2103
2104 flags |= (res & KDP_FAULT_RESULT_PAGED_OUT) ? kThreadTruncatedBT : 0;
2105 flags |= (res & KDP_FAULT_RESULT_TRIED_FAULT) ? kThreadTriedFaultBT : 0;
2106 flags |= (res & KDP_FAULT_RESULT_FAULTED_IN) ? kThreadFaultedBT : 0;
2107 ctx->sbc_flags |= flags;
2108 if (src_pa == 0) {
2109 return EFAULT;
2110 }
2111
2112 src_kva = phystokv(src_pa);
2113 ctx->sbc_prev_page = src_page;
2114 ctx->sbc_prev_kva = (src_kva & ~map_page_mask);
2115 } else {
2116 src_kva = ctx->sbc_prev_kva + (src & map_page_mask);
2117 }
2118
2119 #if KASAN
2120 /*
2121 * KASan does not monitor accesses to userspace pages. Therefore, it is
2122 * pointless to maintain a shadow map for them. Instead, they are all
2123 * mapped to a single, always valid shadow map page. This approach saves
2124 * a considerable amount of shadow map pages which are limited and
2125 * precious.
2126 */
2127 kasan_notify_address_nopoison(src_kva, size);
2128 #endif
2129 memcpy(dst, (const void *)src_kva, size);
2130
2131 return 0;
2132 }
2133
2134 static kern_return_t
kcdata_record_thread_snapshot(kcdata_descriptor_t kcd,thread_t thread,task_t task,uint64_t trace_flags,boolean_t have_pmap,boolean_t thread_on_core)2135 kcdata_record_thread_snapshot(
2136 kcdata_descriptor_t kcd, thread_t thread, task_t task, uint64_t trace_flags, boolean_t have_pmap, boolean_t thread_on_core)
2137 {
2138 boolean_t dispatch_p = ((trace_flags & STACKSHOT_GET_DQ) != 0);
2139 boolean_t active_kthreads_only_p = ((trace_flags & STACKSHOT_ACTIVE_KERNEL_THREADS_ONLY) != 0);
2140 boolean_t collect_delta_stackshot = ((trace_flags & STACKSHOT_COLLECT_DELTA_SNAPSHOT) != 0);
2141 boolean_t collect_iostats = !collect_delta_stackshot && !(trace_flags & STACKSHOT_NO_IO_STATS);
2142 #if CONFIG_PERVASIVE_CPI
2143 boolean_t collect_instrs_cycles = ((trace_flags & STACKSHOT_INSTRS_CYCLES) != 0);
2144 #endif /* CONFIG_PERVASIVE_CPI */
2145 kern_return_t error = KERN_SUCCESS;
2146
2147 #if STACKSHOT_COLLECTS_LATENCY_INFO
2148 struct stackshot_latency_thread latency_info;
2149 latency_info.cur_thsnap1_latency = mach_absolute_time();
2150 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2151
2152 mach_vm_address_t out_addr = 0;
2153 int saved_count = 0;
2154
2155 struct thread_snapshot_v4 * cur_thread_snap = NULL;
2156 char cur_thread_name[STACKSHOT_MAX_THREAD_NAME_SIZE];
2157
2158 kcd_exit_on_error(kcdata_get_memory_addr(kcd, STACKSHOT_KCTYPE_THREAD_SNAPSHOT, sizeof(struct thread_snapshot_v4), &out_addr));
2159 cur_thread_snap = (struct thread_snapshot_v4 *)out_addr;
2160
2161 /* Populate the thread snapshot header */
2162 cur_thread_snap->ths_ss_flags = 0;
2163 cur_thread_snap->ths_thread_id = thread_tid(thread);
2164 cur_thread_snap->ths_wait_event = VM_KERNEL_UNSLIDE_OR_PERM(thread->wait_event);
2165 cur_thread_snap->ths_continuation = VM_KERNEL_UNSLIDE(thread->continuation);
2166 cur_thread_snap->ths_total_syscalls = thread->syscalls_mach + thread->syscalls_unix;
2167
2168 if (IPC_VOUCHER_NULL != thread->ith_voucher) {
2169 cur_thread_snap->ths_voucher_identifier = VM_KERNEL_ADDRPERM(thread->ith_voucher);
2170 } else {
2171 cur_thread_snap->ths_voucher_identifier = 0;
2172 }
2173
2174 #if STACKSHOT_COLLECTS_LATENCY_INFO
2175 latency_info.cur_thsnap1_latency = mach_absolute_time() - latency_info.cur_thsnap1_latency;
2176 latency_info.dispatch_serial_latency = mach_absolute_time();
2177 latency_info.dispatch_label_latency = 0;
2178 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2179
2180 cur_thread_snap->ths_dqserialnum = 0;
2181 if (dispatch_p && (task != kernel_task) && (task->active) && have_pmap) {
2182 uint64_t dqkeyaddr = thread_dispatchqaddr(thread);
2183 if (dqkeyaddr != 0) {
2184 uint64_t dqaddr = 0;
2185 boolean_t copyin_ok = stackshot_copyin_word(task, dqkeyaddr, &dqaddr, FALSE, NULL);
2186 if (copyin_ok && dqaddr != 0) {
2187 uint64_t dqserialnumaddr = dqaddr + get_task_dispatchqueue_serialno_offset(task);
2188 uint64_t dqserialnum = 0;
2189 copyin_ok = stackshot_copyin_word(task, dqserialnumaddr, &dqserialnum, FALSE, NULL);
2190 if (copyin_ok) {
2191 cur_thread_snap->ths_ss_flags |= kHasDispatchSerial;
2192 cur_thread_snap->ths_dqserialnum = dqserialnum;
2193 }
2194
2195 #if STACKSHOT_COLLECTS_LATENCY_INFO
2196 latency_info.dispatch_serial_latency = mach_absolute_time() - latency_info.dispatch_serial_latency;
2197 latency_info.dispatch_label_latency = mach_absolute_time();
2198 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2199
2200 /* try copying in the queue label */
2201 uint64_t label_offs = get_task_dispatchqueue_label_offset(task);
2202 if (label_offs) {
2203 uint64_t dqlabeladdr = dqaddr + label_offs;
2204 uint64_t actual_dqlabeladdr = 0;
2205
2206 copyin_ok = stackshot_copyin_word(task, dqlabeladdr, &actual_dqlabeladdr, FALSE, NULL);
2207 if (copyin_ok && actual_dqlabeladdr != 0) {
2208 char label_buf[STACKSHOT_QUEUE_LABEL_MAXSIZE];
2209 int len;
2210
2211 bzero(label_buf, STACKSHOT_QUEUE_LABEL_MAXSIZE * sizeof(char));
2212 len = stackshot_copyin_string(task, actual_dqlabeladdr, label_buf, STACKSHOT_QUEUE_LABEL_MAXSIZE, FALSE, NULL);
2213 if (len > 0) {
2214 mach_vm_address_t label_addr = 0;
2215 kcd_exit_on_error(kcdata_get_memory_addr(kcd, STACKSHOT_KCTYPE_THREAD_DISPATCH_QUEUE_LABEL, len, &label_addr));
2216 kdp_strlcpy((char*)label_addr, &label_buf[0], len);
2217 }
2218 }
2219 }
2220 #if STACKSHOT_COLLECTS_LATENCY_INFO
2221 latency_info.dispatch_label_latency = mach_absolute_time() - latency_info.dispatch_label_latency;
2222 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2223 }
2224 }
2225 }
2226
2227 #if STACKSHOT_COLLECTS_LATENCY_INFO
2228 if ((cur_thread_snap->ths_ss_flags & kHasDispatchSerial) == 0) {
2229 latency_info.dispatch_serial_latency = 0;
2230 }
2231 latency_info.cur_thsnap2_latency = mach_absolute_time();
2232 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2233
2234 struct recount_times_mach times = recount_thread_times(thread);
2235 cur_thread_snap->ths_user_time = times.rtm_user;
2236 cur_thread_snap->ths_sys_time = times.rtm_system;
2237
2238 if (thread->thread_tag & THREAD_TAG_MAINTHREAD) {
2239 cur_thread_snap->ths_ss_flags |= kThreadMain;
2240 }
2241 if (thread->effective_policy.thep_darwinbg) {
2242 cur_thread_snap->ths_ss_flags |= kThreadDarwinBG;
2243 }
2244 if (proc_get_effective_thread_policy(thread, TASK_POLICY_PASSIVE_IO)) {
2245 cur_thread_snap->ths_ss_flags |= kThreadIOPassive;
2246 }
2247 if (thread->suspend_count > 0) {
2248 cur_thread_snap->ths_ss_flags |= kThreadSuspended;
2249 }
2250 if (thread->options & TH_OPT_GLOBAL_FORCED_IDLE) {
2251 cur_thread_snap->ths_ss_flags |= kGlobalForcedIdle;
2252 }
2253 if (thread_on_core) {
2254 cur_thread_snap->ths_ss_flags |= kThreadOnCore;
2255 }
2256 if (stackshot_thread_is_idle_worker_unsafe(thread)) {
2257 cur_thread_snap->ths_ss_flags |= kThreadIdleWorker;
2258 }
2259
2260 /* make sure state flags defined in kcdata.h still match internal flags */
2261 static_assert(SS_TH_WAIT == TH_WAIT);
2262 static_assert(SS_TH_SUSP == TH_SUSP);
2263 static_assert(SS_TH_RUN == TH_RUN);
2264 static_assert(SS_TH_UNINT == TH_UNINT);
2265 static_assert(SS_TH_TERMINATE == TH_TERMINATE);
2266 static_assert(SS_TH_TERMINATE2 == TH_TERMINATE2);
2267 static_assert(SS_TH_IDLE == TH_IDLE);
2268
2269 cur_thread_snap->ths_last_run_time = thread->last_run_time;
2270 cur_thread_snap->ths_last_made_runnable_time = thread->last_made_runnable_time;
2271 cur_thread_snap->ths_state = thread->state;
2272 cur_thread_snap->ths_sched_flags = thread->sched_flags;
2273 cur_thread_snap->ths_base_priority = thread->base_pri;
2274 cur_thread_snap->ths_sched_priority = thread->sched_pri;
2275 cur_thread_snap->ths_eqos = thread->effective_policy.thep_qos;
2276 cur_thread_snap->ths_rqos = thread->requested_policy.thrp_qos;
2277 cur_thread_snap->ths_rqos_override = MAX(thread->requested_policy.thrp_qos_override,
2278 thread->requested_policy.thrp_qos_workq_override);
2279 cur_thread_snap->ths_io_tier = (uint8_t) proc_get_effective_thread_policy(thread, TASK_POLICY_IO);
2280 cur_thread_snap->ths_thread_t = VM_KERNEL_UNSLIDE_OR_PERM(thread);
2281
2282 static_assert(sizeof(thread->effective_policy) == sizeof(uint64_t));
2283 static_assert(sizeof(thread->requested_policy) == sizeof(uint64_t));
2284 cur_thread_snap->ths_requested_policy = *(unaligned_u64 *) &thread->requested_policy;
2285 cur_thread_snap->ths_effective_policy = *(unaligned_u64 *) &thread->effective_policy;
2286
2287 #if STACKSHOT_COLLECTS_LATENCY_INFO
2288 latency_info.cur_thsnap2_latency = mach_absolute_time() - latency_info.cur_thsnap2_latency;
2289 latency_info.thread_name_latency = mach_absolute_time();
2290 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2291
2292 /* if there is thread name then add to buffer */
2293 cur_thread_name[0] = '\0';
2294 proc_threadname_kdp(get_bsdthread_info(thread), cur_thread_name, STACKSHOT_MAX_THREAD_NAME_SIZE);
2295 if (strnlen(cur_thread_name, STACKSHOT_MAX_THREAD_NAME_SIZE) > 0) {
2296 kcd_exit_on_error(kcdata_get_memory_addr(kcd, STACKSHOT_KCTYPE_THREAD_NAME, sizeof(cur_thread_name), &out_addr));
2297 kdp_memcpy((void *)out_addr, (void *)cur_thread_name, sizeof(cur_thread_name));
2298 }
2299
2300 #if STACKSHOT_COLLECTS_LATENCY_INFO
2301 latency_info.thread_name_latency = mach_absolute_time() - latency_info.thread_name_latency;
2302 latency_info.sur_times_latency = mach_absolute_time();
2303 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2304
2305 /* record system, user, and runnable times */
2306 time_value_t runnable_time;
2307 thread_read_times(thread, NULL, NULL, &runnable_time);
2308 clock_sec_t user_sec = 0, system_sec = 0;
2309 clock_usec_t user_usec = 0, system_usec = 0;
2310 absolutetime_to_microtime(times.rtm_user, &user_sec, &user_usec);
2311 absolutetime_to_microtime(times.rtm_system, &system_sec, &system_usec);
2312
2313 kcd_exit_on_error(kcdata_get_memory_addr(kcd, STACKSHOT_KCTYPE_CPU_TIMES, sizeof(struct stackshot_cpu_times_v2), &out_addr));
2314 struct stackshot_cpu_times_v2 *stackshot_cpu_times = (struct stackshot_cpu_times_v2 *)out_addr;
2315 *stackshot_cpu_times = (struct stackshot_cpu_times_v2){
2316 .user_usec = user_sec * USEC_PER_SEC + user_usec,
2317 .system_usec = system_sec * USEC_PER_SEC + system_usec,
2318 .runnable_usec = (uint64_t)runnable_time.seconds * USEC_PER_SEC + runnable_time.microseconds,
2319 };
2320
2321 #if STACKSHOT_COLLECTS_LATENCY_INFO
2322 latency_info.sur_times_latency = mach_absolute_time() - latency_info.sur_times_latency;
2323 latency_info.user_stack_latency = mach_absolute_time();
2324 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2325
2326 /* Trace user stack, if any */
2327 if (!active_kthreads_only_p && task->active && task->map != kernel_map) {
2328 uint32_t user_ths_ss_flags = 0;
2329
2330 /*
2331 * This relies on knowing the "end" address points to the start of the
2332 * next elements data and, in the case of arrays, the elements.
2333 */
2334 out_addr = (mach_vm_address_t)kcd_end_address(kcd);
2335 mach_vm_address_t max_addr = (mach_vm_address_t)kcd_max_address(kcd);
2336 assert(out_addr <= max_addr);
2337 size_t avail_frames = (max_addr - out_addr) / sizeof(uintptr_t);
2338 size_t max_frames = MIN(avail_frames, MAX_FRAMES);
2339 if (max_frames == 0) {
2340 error = KERN_RESOURCE_SHORTAGE;
2341 goto error_exit;
2342 }
2343 struct _stackshot_backtrace_context ctx = {
2344 .sbc_map = task->map,
2345 .sbc_allow_faulting = stack_enable_faulting,
2346 .sbc_prev_page = -1,
2347 .sbc_prev_kva = -1,
2348 };
2349 struct backtrace_control ctl = {
2350 .btc_user_thread = thread,
2351 .btc_user_copy = _stackshot_backtrace_copy,
2352 .btc_user_copy_context = &ctx,
2353 };
2354 struct backtrace_user_info info = BTUINFO_INIT;
2355
2356 saved_count = backtrace_user((uintptr_t *)out_addr, max_frames, &ctl,
2357 &info);
2358 if (saved_count > 0) {
2359 #if __LP64__
2360 #define STACKLR_WORDS STACKSHOT_KCTYPE_USER_STACKLR64
2361 #else // __LP64__
2362 #define STACKLR_WORDS STACKSHOT_KCTYPE_USER_STACKLR
2363 #endif // !__LP64__
2364 mach_vm_address_t out_addr_array;
2365 kcd_exit_on_error(kcdata_get_memory_addr_for_array(kcd,
2366 STACKLR_WORDS, sizeof(uintptr_t), saved_count,
2367 &out_addr_array));
2368 /*
2369 * Ensure the kcd_end_address (above) trick worked.
2370 */
2371 assert(out_addr == out_addr_array);
2372 if (info.btui_info & BTI_64_BIT) {
2373 user_ths_ss_flags |= kUser64_p;
2374 }
2375 if ((info.btui_info & BTI_TRUNCATED) ||
2376 (ctx.sbc_flags & kThreadTruncatedBT)) {
2377 user_ths_ss_flags |= kThreadTruncatedBT;
2378 user_ths_ss_flags |= kThreadTruncUserBT;
2379 }
2380 user_ths_ss_flags |= ctx.sbc_flags;
2381 ctx.sbc_flags = 0;
2382 #if __LP64__
2383 /* We only support async stacks on 64-bit kernels */
2384 if (info.btui_async_frame_addr != 0) {
2385 uint32_t async_start_offset = info.btui_async_start_index;
2386 kcd_exit_on_error(kcdata_push_data(kcd, STACKSHOT_KCTYPE_USER_ASYNC_START_INDEX,
2387 sizeof(async_start_offset), &async_start_offset));
2388 out_addr = (mach_vm_address_t)kcd_end_address(kcd);
2389 assert(out_addr <= max_addr);
2390
2391 avail_frames = (max_addr - out_addr) / sizeof(uintptr_t);
2392 max_frames = MIN(avail_frames, MAX_FRAMES);
2393 if (max_frames == 0) {
2394 error = KERN_RESOURCE_SHORTAGE;
2395 goto error_exit;
2396 }
2397 ctl.btc_frame_addr = info.btui_async_frame_addr;
2398 ctl.btc_addr_offset = BTCTL_ASYNC_ADDR_OFFSET;
2399 info = BTUINFO_INIT;
2400 unsigned int async_count = backtrace_user((uintptr_t *)out_addr, max_frames, &ctl,
2401 &info);
2402 if (async_count > 0) {
2403 mach_vm_address_t async_out_addr;
2404 kcd_exit_on_error(kcdata_get_memory_addr_for_array(kcd,
2405 STACKSHOT_KCTYPE_USER_ASYNC_STACKLR64, sizeof(uintptr_t), async_count,
2406 &async_out_addr));
2407 /*
2408 * Ensure the kcd_end_address (above) trick worked.
2409 */
2410 assert(out_addr == async_out_addr);
2411 if ((info.btui_info & BTI_TRUNCATED) ||
2412 (ctx.sbc_flags & kThreadTruncatedBT)) {
2413 user_ths_ss_flags |= kThreadTruncatedBT;
2414 user_ths_ss_flags |= kThreadTruncUserAsyncBT;
2415 }
2416 user_ths_ss_flags |= ctx.sbc_flags;
2417 }
2418 }
2419 #endif /* _LP64 */
2420 }
2421 if (user_ths_ss_flags != 0) {
2422 cur_thread_snap->ths_ss_flags |= user_ths_ss_flags;
2423 }
2424 }
2425
2426 #if STACKSHOT_COLLECTS_LATENCY_INFO
2427 latency_info.user_stack_latency = mach_absolute_time() - latency_info.user_stack_latency;
2428 latency_info.kernel_stack_latency = mach_absolute_time();
2429 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2430
2431 /* Call through to the machine specific trace routines
2432 * Frames are added past the snapshot header.
2433 */
2434 if (thread->kernel_stack != 0) {
2435 uint32_t kern_ths_ss_flags = 0;
2436 out_addr = (mach_vm_address_t)kcd_end_address(kcd);
2437 #if defined(__LP64__)
2438 uint32_t stack_kcdata_type = STACKSHOT_KCTYPE_KERN_STACKLR64;
2439 extern int machine_trace_thread64(thread_t thread, char *tracepos,
2440 char *tracebound, int nframes, uint32_t *thread_trace_flags);
2441 saved_count = machine_trace_thread64(
2442 #else
2443 uint32_t stack_kcdata_type = STACKSHOT_KCTYPE_KERN_STACKLR;
2444 extern int machine_trace_thread(thread_t thread, char *tracepos,
2445 char *tracebound, int nframes, uint32_t *thread_trace_flags);
2446 saved_count = machine_trace_thread(
2447 #endif
2448 thread, (char *)out_addr, (char *)kcd_max_address(kcd), MAX_FRAMES,
2449 &kern_ths_ss_flags);
2450 if (saved_count > 0) {
2451 int frame_size = sizeof(uintptr_t);
2452 #if defined(__LP64__)
2453 cur_thread_snap->ths_ss_flags |= kKernel64_p;
2454 #endif
2455 kcd_exit_on_error(kcdata_get_memory_addr_for_array(kcd, stack_kcdata_type,
2456 frame_size, saved_count / frame_size, &out_addr));
2457 }
2458 if (kern_ths_ss_flags & kThreadTruncatedBT) {
2459 kern_ths_ss_flags |= kThreadTruncKernBT;
2460 }
2461 if (kern_ths_ss_flags != 0) {
2462 cur_thread_snap->ths_ss_flags |= kern_ths_ss_flags;
2463 }
2464 }
2465
2466 #if STACKSHOT_COLLECTS_LATENCY_INFO
2467 latency_info.kernel_stack_latency = mach_absolute_time() - latency_info.kernel_stack_latency;
2468 latency_info.misc_latency = mach_absolute_time();
2469 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2470
2471 #if CONFIG_THREAD_GROUPS
2472 if (trace_flags & STACKSHOT_THREAD_GROUP) {
2473 uint64_t thread_group_id = thread->thread_group ? thread_group_get_id(thread->thread_group) : 0;
2474 kcd_exit_on_error(kcdata_get_memory_addr(kcd, STACKSHOT_KCTYPE_THREAD_GROUP, sizeof(thread_group_id), &out_addr));
2475 kdp_memcpy((void*)out_addr, &thread_group_id, sizeof(uint64_t));
2476 }
2477 #endif /* CONFIG_THREAD_GROUPS */
2478
2479 if (collect_iostats) {
2480 kcd_exit_on_error(kcdata_record_thread_iostats(kcd, thread));
2481 }
2482
2483 #if CONFIG_PERVASIVE_CPI
2484 if (collect_instrs_cycles) {
2485 struct recount_usage usage = { 0 };
2486 recount_sum_unsafe(&recount_thread_plan, thread->th_recount.rth_lifetime,
2487 &usage);
2488
2489 kcd_exit_on_error(kcdata_get_memory_addr(kcd, STACKSHOT_KCTYPE_INSTRS_CYCLES, sizeof(struct instrs_cycles_snapshot), &out_addr));
2490 struct instrs_cycles_snapshot *instrs_cycles = (struct instrs_cycles_snapshot *)out_addr;
2491 instrs_cycles->ics_instructions = usage.ru_instructions;
2492 instrs_cycles->ics_cycles = usage.ru_cycles;
2493 }
2494 #endif /* CONFIG_PERVASIVE_CPI */
2495
2496 #if STACKSHOT_COLLECTS_LATENCY_INFO
2497 latency_info.misc_latency = mach_absolute_time() - latency_info.misc_latency;
2498 if (collect_latency_info) {
2499 kcd_exit_on_error(kcdata_push_data(kcd, STACKSHOT_KCTYPE_LATENCY_INFO_THREAD, sizeof(latency_info), &latency_info));
2500 }
2501 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2502
2503 error_exit:
2504 return error;
2505 }
2506
2507 static int
kcdata_record_thread_delta_snapshot(struct thread_delta_snapshot_v3 * cur_thread_snap,thread_t thread,boolean_t thread_on_core)2508 kcdata_record_thread_delta_snapshot(struct thread_delta_snapshot_v3 * cur_thread_snap, thread_t thread, boolean_t thread_on_core)
2509 {
2510 cur_thread_snap->tds_thread_id = thread_tid(thread);
2511 if (IPC_VOUCHER_NULL != thread->ith_voucher) {
2512 cur_thread_snap->tds_voucher_identifier = VM_KERNEL_ADDRPERM(thread->ith_voucher);
2513 } else {
2514 cur_thread_snap->tds_voucher_identifier = 0;
2515 }
2516
2517 cur_thread_snap->tds_ss_flags = 0;
2518 if (thread->effective_policy.thep_darwinbg) {
2519 cur_thread_snap->tds_ss_flags |= kThreadDarwinBG;
2520 }
2521 if (proc_get_effective_thread_policy(thread, TASK_POLICY_PASSIVE_IO)) {
2522 cur_thread_snap->tds_ss_flags |= kThreadIOPassive;
2523 }
2524 if (thread->suspend_count > 0) {
2525 cur_thread_snap->tds_ss_flags |= kThreadSuspended;
2526 }
2527 if (thread->options & TH_OPT_GLOBAL_FORCED_IDLE) {
2528 cur_thread_snap->tds_ss_flags |= kGlobalForcedIdle;
2529 }
2530 if (thread_on_core) {
2531 cur_thread_snap->tds_ss_flags |= kThreadOnCore;
2532 }
2533 if (stackshot_thread_is_idle_worker_unsafe(thread)) {
2534 cur_thread_snap->tds_ss_flags |= kThreadIdleWorker;
2535 }
2536
2537 cur_thread_snap->tds_last_made_runnable_time = thread->last_made_runnable_time;
2538 cur_thread_snap->tds_state = thread->state;
2539 cur_thread_snap->tds_sched_flags = thread->sched_flags;
2540 cur_thread_snap->tds_base_priority = thread->base_pri;
2541 cur_thread_snap->tds_sched_priority = thread->sched_pri;
2542 cur_thread_snap->tds_eqos = thread->effective_policy.thep_qos;
2543 cur_thread_snap->tds_rqos = thread->requested_policy.thrp_qos;
2544 cur_thread_snap->tds_rqos_override = MAX(thread->requested_policy.thrp_qos_override,
2545 thread->requested_policy.thrp_qos_workq_override);
2546 cur_thread_snap->tds_io_tier = (uint8_t) proc_get_effective_thread_policy(thread, TASK_POLICY_IO);
2547
2548 static_assert(sizeof(thread->effective_policy) == sizeof(uint64_t));
2549 static_assert(sizeof(thread->requested_policy) == sizeof(uint64_t));
2550 cur_thread_snap->tds_requested_policy = *(unaligned_u64 *) &thread->requested_policy;
2551 cur_thread_snap->tds_effective_policy = *(unaligned_u64 *) &thread->effective_policy;
2552
2553 return 0;
2554 }
2555
2556 /*
2557 * Why 12? 12 strikes a decent balance between allocating a large array on
2558 * the stack and having large kcdata item overheads for recording nonrunable
2559 * tasks.
2560 */
2561 #define UNIQUEIDSPERFLUSH 12
2562
2563 struct saved_uniqueids {
2564 uint64_t ids[UNIQUEIDSPERFLUSH];
2565 unsigned count;
2566 };
2567
2568 enum thread_classification {
2569 tc_full_snapshot, /* take a full snapshot */
2570 tc_delta_snapshot, /* take a delta snapshot */
2571 };
2572
2573 static enum thread_classification
classify_thread(thread_t thread,boolean_t * thread_on_core_p,boolean_t collect_delta_stackshot)2574 classify_thread(thread_t thread, boolean_t * thread_on_core_p, boolean_t collect_delta_stackshot)
2575 {
2576 processor_t last_processor = thread->last_processor;
2577
2578 boolean_t thread_on_core = FALSE;
2579 if (last_processor != PROCESSOR_NULL) {
2580 /* Idle threads are always treated as on-core, since the processor state can change while they are running. */
2581 thread_on_core = (thread == last_processor->idle_thread) ||
2582 ((last_processor->state == PROCESSOR_SHUTDOWN || last_processor->state == PROCESSOR_RUNNING) &&
2583 last_processor->active_thread == thread);
2584 }
2585
2586 *thread_on_core_p = thread_on_core;
2587
2588 /* Capture the full thread snapshot if this is not a delta stackshot or if the thread has run subsequent to the
2589 * previous full stackshot */
2590 if (!collect_delta_stackshot || thread_on_core || (thread->last_run_time > stack_snapshot_delta_since_timestamp)) {
2591 return tc_full_snapshot;
2592 } else {
2593 return tc_delta_snapshot;
2594 }
2595 }
2596
2597 struct stackshot_context {
2598 int pid;
2599 uint64_t trace_flags;
2600 bool include_drivers;
2601 };
2602
2603 static kern_return_t
kdp_stackshot_record_task(struct stackshot_context * ctx,task_t task)2604 kdp_stackshot_record_task(struct stackshot_context *ctx, task_t task)
2605 {
2606 boolean_t active_kthreads_only_p = ((ctx->trace_flags & STACKSHOT_ACTIVE_KERNEL_THREADS_ONLY) != 0);
2607 boolean_t save_donating_pids_p = ((ctx->trace_flags & STACKSHOT_SAVE_IMP_DONATION_PIDS) != 0);
2608 boolean_t collect_delta_stackshot = ((ctx->trace_flags & STACKSHOT_COLLECT_DELTA_SNAPSHOT) != 0);
2609 boolean_t save_owner_info = ((ctx->trace_flags & STACKSHOT_THREAD_WAITINFO) != 0);
2610
2611 kern_return_t error = KERN_SUCCESS;
2612 mach_vm_address_t out_addr = 0;
2613 int saved_count = 0;
2614
2615 int task_pid = 0;
2616 uint64_t task_uniqueid = 0;
2617 int num_delta_thread_snapshots = 0;
2618 int num_waitinfo_threads = 0;
2619 int num_turnstileinfo_threads = 0;
2620
2621 uint64_t task_start_abstime = 0;
2622 boolean_t have_map = FALSE, have_pmap = FALSE;
2623 boolean_t some_thread_ran = FALSE;
2624 unaligned_u64 task_snap_ss_flags = 0;
2625
2626 #if STACKSHOT_COLLECTS_LATENCY_INFO
2627 struct stackshot_latency_task latency_info;
2628 latency_info.setup_latency = mach_absolute_time();
2629 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2630
2631 #if SCHED_HYGIENE_DEBUG && CONFIG_PERVASIVE_CPI
2632 uint64_t task_begin_cpu_cycle_count = 0;
2633 if (!panic_stackshot) {
2634 task_begin_cpu_cycle_count = mt_cur_cpu_cycles();
2635 }
2636 #endif
2637
2638 if ((task == NULL) || !_stackshot_validate_kva((vm_offset_t)task, sizeof(struct task))) {
2639 error = KERN_FAILURE;
2640 goto error_exit;
2641 }
2642
2643 void *bsd_info = get_bsdtask_info(task);
2644 boolean_t task_in_teardown = (bsd_info == NULL) || proc_in_teardown(bsd_info);// has P_LPEXIT set during proc_exit()
2645 boolean_t task_in_transition = task_in_teardown; // here we can add other types of transition.
2646 uint32_t container_type = (task_in_transition) ? STACKSHOT_KCCONTAINER_TRANSITIONING_TASK : STACKSHOT_KCCONTAINER_TASK;
2647 uint32_t transition_type = (task_in_teardown) ? kTaskIsTerminated : 0;
2648
2649 if (task_in_transition) {
2650 collect_delta_stackshot = FALSE;
2651 }
2652
2653 have_map = (task->map != NULL) && (_stackshot_validate_kva((vm_offset_t)(task->map), sizeof(struct _vm_map)));
2654 have_pmap = have_map && (task->map->pmap != NULL) && (_stackshot_validate_kva((vm_offset_t)(task->map->pmap), sizeof(struct pmap)));
2655
2656 task_pid = pid_from_task(task);
2657 /* Is returning -1 ok for terminating task ok ??? */
2658 task_uniqueid = get_task_uniqueid(task);
2659
2660 if (!task->active || task_is_a_corpse(task) || task_is_a_corpse_fork(task)) {
2661 /*
2662 * Not interested in terminated tasks without threads.
2663 */
2664 if (queue_empty(&task->threads) || task_pid == -1) {
2665 return KERN_SUCCESS;
2666 }
2667 }
2668
2669 /* All PIDs should have the MSB unset */
2670 assert((task_pid & (1ULL << 31)) == 0);
2671
2672 #if STACKSHOT_COLLECTS_LATENCY_INFO
2673 latency_info.setup_latency = mach_absolute_time() - latency_info.setup_latency;
2674 latency_info.task_uniqueid = task_uniqueid;
2675 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2676
2677 /* Trace everything, unless a process was specified. Add in driver tasks if requested. */
2678 if ((ctx->pid == -1) || (ctx->pid == task_pid) || (ctx->include_drivers && task_is_driver(task))) {
2679 /* add task snapshot marker */
2680 kcd_exit_on_error(kcdata_add_container_marker(stackshot_kcdata_p, KCDATA_TYPE_CONTAINER_BEGIN,
2681 container_type, task_uniqueid));
2682
2683 if (collect_delta_stackshot) {
2684 /*
2685 * For delta stackshots we need to know if a thread from this task has run since the
2686 * previous timestamp to decide whether we're going to record a full snapshot and UUID info.
2687 */
2688 thread_t thread = THREAD_NULL;
2689 queue_iterate(&task->threads, thread, thread_t, task_threads)
2690 {
2691 if ((thread == NULL) || !_stackshot_validate_kva((vm_offset_t)thread, sizeof(struct thread))) {
2692 error = KERN_FAILURE;
2693 goto error_exit;
2694 }
2695
2696 if (active_kthreads_only_p && thread->kernel_stack == 0) {
2697 continue;
2698 }
2699
2700 boolean_t thread_on_core;
2701 enum thread_classification thread_classification = classify_thread(thread, &thread_on_core, collect_delta_stackshot);
2702
2703 switch (thread_classification) {
2704 case tc_full_snapshot:
2705 some_thread_ran = TRUE;
2706 break;
2707 case tc_delta_snapshot:
2708 num_delta_thread_snapshots++;
2709 break;
2710 }
2711 }
2712 }
2713
2714 if (collect_delta_stackshot) {
2715 proc_starttime_kdp(get_bsdtask_info(task), NULL, NULL, &task_start_abstime);
2716 }
2717
2718 /* Next record any relevant UUID info and store the task snapshot */
2719 if (task_in_transition ||
2720 !collect_delta_stackshot ||
2721 (task_start_abstime == 0) ||
2722 (task_start_abstime > stack_snapshot_delta_since_timestamp) ||
2723 some_thread_ran) {
2724 /*
2725 * Collect full task information in these scenarios:
2726 *
2727 * 1) a full stackshot or the task is in transition
2728 * 2) a delta stackshot where the task started after the previous full stackshot
2729 * 3) a delta stackshot where any thread from the task has run since the previous full stackshot
2730 *
2731 * because the task may have exec'ed, changing its name, architecture, load info, etc
2732 */
2733
2734 kcd_exit_on_error(kcdata_record_shared_cache_info(stackshot_kcdata_p, task, &task_snap_ss_flags));
2735 kcd_exit_on_error(kcdata_record_uuid_info(stackshot_kcdata_p, task, ctx->trace_flags, have_pmap, &task_snap_ss_flags));
2736 #if STACKSHOT_COLLECTS_LATENCY_INFO
2737 if (!task_in_transition) {
2738 kcd_exit_on_error(kcdata_record_task_snapshot(stackshot_kcdata_p, task, ctx->trace_flags, have_pmap, task_snap_ss_flags, &latency_info));
2739 } else {
2740 kcd_exit_on_error(kcdata_record_transitioning_task_snapshot(stackshot_kcdata_p, task, task_snap_ss_flags, transition_type));
2741 }
2742 #else
2743 if (!task_in_transition) {
2744 kcd_exit_on_error(kcdata_record_task_snapshot(stackshot_kcdata_p, task, ctx->trace_flags, have_pmap, task_snap_ss_flags));
2745 } else {
2746 kcd_exit_on_error(kcdata_record_transitioning_task_snapshot(stackshot_kcdata_p, task, task_snap_ss_flags, transition_type));
2747 }
2748 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2749 } else {
2750 kcd_exit_on_error(kcdata_record_task_delta_snapshot(stackshot_kcdata_p, task, ctx->trace_flags, have_pmap, task_snap_ss_flags));
2751 }
2752
2753 #if STACKSHOT_COLLECTS_LATENCY_INFO
2754 latency_info.misc_latency = mach_absolute_time();
2755 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2756
2757 struct thread_delta_snapshot_v3 * delta_snapshots = NULL;
2758 int current_delta_snapshot_index = 0;
2759 if (num_delta_thread_snapshots > 0) {
2760 kcd_exit_on_error(kcdata_get_memory_addr_for_array(stackshot_kcdata_p, STACKSHOT_KCTYPE_THREAD_DELTA_SNAPSHOT,
2761 sizeof(struct thread_delta_snapshot_v3),
2762 num_delta_thread_snapshots, &out_addr));
2763 delta_snapshots = (struct thread_delta_snapshot_v3 *)out_addr;
2764 }
2765
2766
2767 #if STACKSHOT_COLLECTS_LATENCY_INFO
2768 latency_info.task_thread_count_loop_latency = mach_absolute_time();
2769 #endif
2770 /*
2771 * Iterate over the task threads to save thread snapshots and determine
2772 * how much space we need for waitinfo and turnstile info
2773 */
2774 thread_t thread = THREAD_NULL;
2775 queue_iterate(&task->threads, thread, thread_t, task_threads)
2776 {
2777 if ((thread == NULL) || !_stackshot_validate_kva((vm_offset_t)thread, sizeof(struct thread))) {
2778 error = KERN_FAILURE;
2779 goto error_exit;
2780 }
2781
2782 uint64_t thread_uniqueid;
2783 if (active_kthreads_only_p && thread->kernel_stack == 0) {
2784 continue;
2785 }
2786 thread_uniqueid = thread_tid(thread);
2787
2788 boolean_t thread_on_core;
2789 enum thread_classification thread_classification = classify_thread(thread, &thread_on_core, collect_delta_stackshot);
2790
2791 switch (thread_classification) {
2792 case tc_full_snapshot:
2793 /* add thread marker */
2794 kcd_exit_on_error(kcdata_add_container_marker(stackshot_kcdata_p, KCDATA_TYPE_CONTAINER_BEGIN,
2795 STACKSHOT_KCCONTAINER_THREAD, thread_uniqueid));
2796
2797 /* thread snapshot can be large, including strings, avoid overflowing the stack. */
2798 kcdata_compression_window_open(stackshot_kcdata_p);
2799
2800 kcd_exit_on_error(kcdata_record_thread_snapshot(stackshot_kcdata_p, thread, task, ctx->trace_flags, have_pmap, thread_on_core));
2801
2802 kcd_exit_on_error(kcdata_compression_window_close(stackshot_kcdata_p));
2803
2804 /* mark end of thread snapshot data */
2805 kcd_exit_on_error(kcdata_add_container_marker(stackshot_kcdata_p, KCDATA_TYPE_CONTAINER_END,
2806 STACKSHOT_KCCONTAINER_THREAD, thread_uniqueid));
2807 break;
2808 case tc_delta_snapshot:
2809 kcd_exit_on_error(kcdata_record_thread_delta_snapshot(&delta_snapshots[current_delta_snapshot_index++], thread, thread_on_core));
2810 break;
2811 }
2812
2813 /*
2814 * We want to report owner information regardless of whether a thread
2815 * has changed since the last delta, whether it's a normal stackshot,
2816 * or whether it's nonrunnable
2817 */
2818 if (save_owner_info) {
2819 if (stackshot_thread_has_valid_waitinfo(thread)) {
2820 num_waitinfo_threads++;
2821 }
2822
2823 if (stackshot_thread_has_valid_turnstileinfo(thread)) {
2824 num_turnstileinfo_threads++;
2825 }
2826 }
2827 }
2828 #if STACKSHOT_COLLECTS_LATENCY_INFO
2829 latency_info.task_thread_count_loop_latency = mach_absolute_time() - latency_info.task_thread_count_loop_latency;
2830 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2831
2832
2833 thread_waitinfo_v2_t *thread_waitinfo = NULL;
2834 thread_turnstileinfo_v2_t *thread_turnstileinfo = NULL;
2835 int current_waitinfo_index = 0;
2836 int current_turnstileinfo_index = 0;
2837 /* allocate space for the wait and turnstil info */
2838 if (num_waitinfo_threads > 0 || num_turnstileinfo_threads > 0) {
2839 /* thread waitinfo and turnstileinfo can be quite large, avoid overflowing the stack */
2840 kcdata_compression_window_open(stackshot_kcdata_p);
2841
2842 if (num_waitinfo_threads > 0) {
2843 kcd_exit_on_error(kcdata_get_memory_addr_for_array(stackshot_kcdata_p, STACKSHOT_KCTYPE_THREAD_WAITINFO,
2844 sizeof(thread_waitinfo_v2_t), num_waitinfo_threads, &out_addr));
2845 thread_waitinfo = (thread_waitinfo_v2_t *)out_addr;
2846 }
2847
2848 if (num_turnstileinfo_threads > 0) {
2849 /* get space for the turnstile info */
2850 kcd_exit_on_error(kcdata_get_memory_addr_for_array(stackshot_kcdata_p, STACKSHOT_KCTYPE_THREAD_TURNSTILEINFO,
2851 sizeof(thread_turnstileinfo_v2_t), num_turnstileinfo_threads, &out_addr));
2852 thread_turnstileinfo = (thread_turnstileinfo_v2_t *)out_addr;
2853 }
2854
2855 stackshot_plh_resetgen(); // so we know which portlabel_ids are referenced
2856 }
2857
2858 #if STACKSHOT_COLLECTS_LATENCY_INFO
2859 latency_info.misc_latency = mach_absolute_time() - latency_info.misc_latency;
2860 latency_info.task_thread_data_loop_latency = mach_absolute_time();
2861 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2862
2863 /* Iterate over the task's threads to save the wait and turnstile info */
2864 queue_iterate(&task->threads, thread, thread_t, task_threads)
2865 {
2866 uint64_t thread_uniqueid;
2867
2868 if (active_kthreads_only_p && thread->kernel_stack == 0) {
2869 continue;
2870 }
2871
2872 thread_uniqueid = thread_tid(thread);
2873
2874 /* If we want owner info, we should capture it regardless of its classification */
2875 if (save_owner_info) {
2876 if (stackshot_thread_has_valid_waitinfo(thread)) {
2877 stackshot_thread_wait_owner_info(
2878 thread,
2879 &thread_waitinfo[current_waitinfo_index++]);
2880 }
2881
2882 if (stackshot_thread_has_valid_turnstileinfo(thread)) {
2883 stackshot_thread_turnstileinfo(
2884 thread,
2885 &thread_turnstileinfo[current_turnstileinfo_index++]);
2886 }
2887 }
2888 }
2889
2890 #if STACKSHOT_COLLECTS_LATENCY_INFO
2891 latency_info.task_thread_data_loop_latency = mach_absolute_time() - latency_info.task_thread_data_loop_latency;
2892 latency_info.misc2_latency = mach_absolute_time();
2893 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2894
2895 #if DEBUG || DEVELOPMENT
2896 if (current_delta_snapshot_index != num_delta_thread_snapshots) {
2897 panic("delta thread snapshot count mismatch while capturing snapshots for task %p. expected %d, found %d", task,
2898 num_delta_thread_snapshots, current_delta_snapshot_index);
2899 }
2900 if (current_waitinfo_index != num_waitinfo_threads) {
2901 panic("thread wait info count mismatch while capturing snapshots for task %p. expected %d, found %d", task,
2902 num_waitinfo_threads, current_waitinfo_index);
2903 }
2904 #endif
2905
2906 if (num_waitinfo_threads > 0 || num_turnstileinfo_threads > 0) {
2907 kcd_exit_on_error(kcdata_compression_window_close(stackshot_kcdata_p));
2908 // now, record the portlabel hashes.
2909 kcd_exit_on_error(kdp_stackshot_plh_record());
2910 }
2911
2912 #if IMPORTANCE_INHERITANCE
2913 if (save_donating_pids_p) {
2914 kcd_exit_on_error(
2915 ((((mach_vm_address_t)kcd_end_address(stackshot_kcdata_p) + (TASK_IMP_WALK_LIMIT * sizeof(int32_t))) <
2916 (mach_vm_address_t)kcd_max_address(stackshot_kcdata_p))
2917 ? KERN_SUCCESS
2918 : KERN_RESOURCE_SHORTAGE));
2919 saved_count = task_importance_list_pids(task, TASK_IMP_LIST_DONATING_PIDS,
2920 (void *)kcd_end_address(stackshot_kcdata_p), TASK_IMP_WALK_LIMIT);
2921 if (saved_count > 0) {
2922 /* Variable size array - better not have it on the stack. */
2923 kcdata_compression_window_open(stackshot_kcdata_p);
2924 kcd_exit_on_error(kcdata_get_memory_addr_for_array(stackshot_kcdata_p, STACKSHOT_KCTYPE_DONATING_PIDS,
2925 sizeof(int32_t), saved_count, &out_addr));
2926 kcd_exit_on_error(kcdata_compression_window_close(stackshot_kcdata_p));
2927 }
2928 }
2929 #endif
2930
2931 #if SCHED_HYGIENE_DEBUG && CONFIG_PERVASIVE_CPI
2932 if (!panic_stackshot) {
2933 kcd_exit_on_error(kcdata_add_uint64_with_description(stackshot_kcdata_p, (mt_cur_cpu_cycles() - task_begin_cpu_cycle_count),
2934 "task_cpu_cycle_count"));
2935 }
2936 #endif
2937
2938 #if STACKSHOT_COLLECTS_LATENCY_INFO
2939 latency_info.misc2_latency = mach_absolute_time() - latency_info.misc2_latency;
2940 if (collect_latency_info) {
2941 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_LATENCY_INFO_TASK, sizeof(latency_info), &latency_info));
2942 }
2943 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
2944
2945 /* mark end of task snapshot data */
2946 kcd_exit_on_error(kcdata_add_container_marker(stackshot_kcdata_p, KCDATA_TYPE_CONTAINER_END, container_type,
2947 task_uniqueid));
2948 }
2949
2950
2951 error_exit:
2952 return error;
2953 }
2954
2955 /* Record global shared regions */
2956 static kern_return_t
kdp_stackshot_shared_regions(uint64_t trace_flags)2957 kdp_stackshot_shared_regions(uint64_t trace_flags)
2958 {
2959 kern_return_t error = KERN_SUCCESS;
2960
2961 boolean_t collect_delta_stackshot = ((trace_flags & STACKSHOT_COLLECT_DELTA_SNAPSHOT) != 0);
2962 extern queue_head_t vm_shared_region_queue;
2963 vm_shared_region_t sr;
2964
2965 extern queue_head_t vm_shared_region_queue;
2966 queue_iterate(&vm_shared_region_queue,
2967 sr,
2968 vm_shared_region_t,
2969 sr_q) {
2970 struct dyld_shared_cache_loadinfo_v2 scinfo = {0};
2971 if (!_stackshot_validate_kva((vm_offset_t)sr, sizeof(*sr))) {
2972 break;
2973 }
2974 if (collect_delta_stackshot && sr->sr_install_time < stack_snapshot_delta_since_timestamp) {
2975 continue; // only include new shared caches in delta stackshots
2976 }
2977 uint32_t sharedCacheFlags = ((sr == primary_system_shared_region) ? kSharedCacheSystemPrimary : 0) |
2978 (sr->sr_driverkit ? kSharedCacheDriverkit : 0);
2979 kcd_exit_on_error(kcdata_add_container_marker(stackshot_kcdata_p, KCDATA_TYPE_CONTAINER_BEGIN,
2980 STACKSHOT_KCCONTAINER_SHAREDCACHE, sr->sr_id));
2981 kdp_memcpy(scinfo.sharedCacheUUID, sr->sr_uuid, sizeof(sr->sr_uuid));
2982 scinfo.sharedCacheSlide = sr->sr_slide;
2983 scinfo.sharedCacheUnreliableSlidBaseAddress = sr->sr_base_address + sr->sr_first_mapping;
2984 scinfo.sharedCacheSlidFirstMapping = sr->sr_base_address + sr->sr_first_mapping;
2985 scinfo.sharedCacheID = sr->sr_id;
2986 scinfo.sharedCacheFlags = sharedCacheFlags;
2987
2988 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_SHAREDCACHE_INFO,
2989 sizeof(scinfo), &scinfo));
2990
2991 if ((trace_flags & STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT) && sr->sr_images != NULL &&
2992 _stackshot_validate_kva((vm_offset_t)sr->sr_images, sr->sr_images_count * sizeof(struct dyld_uuid_info_64))) {
2993 assert(sr->sr_images_count != 0);
2994 kcd_exit_on_error(kcdata_push_array(stackshot_kcdata_p, STACKSHOT_KCTYPE_SYS_SHAREDCACHE_LAYOUT, sizeof(struct dyld_uuid_info_64), sr->sr_images_count, sr->sr_images));
2995 }
2996 kcd_exit_on_error(kcdata_add_container_marker(stackshot_kcdata_p, KCDATA_TYPE_CONTAINER_END,
2997 STACKSHOT_KCCONTAINER_SHAREDCACHE, sr->sr_id));
2998 }
2999
3000 /*
3001 * For backwards compatibility; this will eventually be removed.
3002 * Another copy of the Primary System Shared Region, for older readers.
3003 */
3004 sr = primary_system_shared_region;
3005 /* record system level shared cache load info (if available) */
3006 if (!collect_delta_stackshot && sr &&
3007 _stackshot_validate_kva((vm_offset_t)sr, sizeof(struct vm_shared_region))) {
3008 struct dyld_shared_cache_loadinfo scinfo = {0};
3009
3010 /*
3011 * Historically, this data was in a dyld_uuid_info_64 structure, but the
3012 * naming of both the structure and fields for this use isn't great. The
3013 * dyld_shared_cache_loadinfo structure has better names, but the same
3014 * layout and content as the original.
3015 *
3016 * The imageSlidBaseAddress/sharedCacheUnreliableSlidBaseAddress field
3017 * has been used inconsistently for STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT
3018 * entries; here, it's the slid base address, and we leave it that way
3019 * for backwards compatibility.
3020 */
3021 kdp_memcpy(scinfo.sharedCacheUUID, &sr->sr_uuid, sizeof(sr->sr_uuid));
3022 scinfo.sharedCacheSlide = sr->sr_slide;
3023 scinfo.sharedCacheUnreliableSlidBaseAddress = sr->sr_slide + sr->sr_base_address;
3024 scinfo.sharedCacheSlidFirstMapping = sr->sr_base_address + sr->sr_first_mapping;
3025
3026 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_SHAREDCACHE_LOADINFO,
3027 sizeof(scinfo), &scinfo));
3028
3029 if (trace_flags & STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT) {
3030 /*
3031 * Include a map of the system shared cache layout if it has been populated
3032 * (which is only when the system is using a custom shared cache).
3033 */
3034 if (sr->sr_images && _stackshot_validate_kva((vm_offset_t)sr->sr_images,
3035 (sr->sr_images_count * sizeof(struct dyld_uuid_info_64)))) {
3036 assert(sr->sr_images_count != 0);
3037 kcd_exit_on_error(kcdata_push_array(stackshot_kcdata_p, STACKSHOT_KCTYPE_SYS_SHAREDCACHE_LAYOUT, sizeof(struct dyld_uuid_info_64), sr->sr_images_count, sr->sr_images));
3038 }
3039 }
3040 }
3041
3042 error_exit:
3043 return error;
3044 }
3045
3046 static kern_return_t
kdp_stackshot_kcdata_format(int pid,uint64_t trace_flags,uint32_t * pBytesTraced,uint32_t * pBytesUncompressed)3047 kdp_stackshot_kcdata_format(int pid, uint64_t trace_flags, uint32_t * pBytesTraced, uint32_t * pBytesUncompressed)
3048 {
3049 kern_return_t error = KERN_SUCCESS;
3050 mach_vm_address_t out_addr = 0;
3051 uint64_t abs_time = 0, abs_time_end = 0;
3052 uint64_t system_state_flags = 0;
3053 task_t task = TASK_NULL;
3054 mach_timebase_info_data_t timebase = {0, 0};
3055 uint32_t length_to_copy = 0, tmp32 = 0;
3056 abs_time = mach_absolute_time();
3057 uint64_t last_task_start_time = 0;
3058
3059 #if STACKSHOT_COLLECTS_LATENCY_INFO
3060 struct stackshot_latency_collection latency_info;
3061 #endif
3062
3063 #if SCHED_HYGIENE_DEBUG && CONFIG_PERVASIVE_CPI
3064 uint64_t stackshot_begin_cpu_cycle_count = 0;
3065
3066 if (!panic_stackshot) {
3067 stackshot_begin_cpu_cycle_count = mt_cur_cpu_cycles();
3068 }
3069 #endif
3070
3071 #if STACKSHOT_COLLECTS_LATENCY_INFO
3072 collect_latency_info = trace_flags & STACKSHOT_DISABLE_LATENCY_INFO ? false : true;
3073 #endif
3074
3075 /* process the flags */
3076 bool collect_delta_stackshot = ((trace_flags & STACKSHOT_COLLECT_DELTA_SNAPSHOT) != 0);
3077 bool use_fault_path = ((trace_flags & (STACKSHOT_ENABLE_UUID_FAULTING | STACKSHOT_ENABLE_BT_FAULTING)) != 0);
3078 stack_enable_faulting = (trace_flags & (STACKSHOT_ENABLE_BT_FAULTING));
3079
3080 /* Currently we only support returning explicit KEXT load info on fileset kernels */
3081 kc_format_t primary_kc_type = KCFormatUnknown;
3082 if (PE_get_primary_kc_format(&primary_kc_type) && (primary_kc_type != KCFormatFileset)) {
3083 trace_flags &= ~(STACKSHOT_SAVE_KEXT_LOADINFO);
3084 }
3085
3086 struct stackshot_context ctx = {};
3087 ctx.trace_flags = trace_flags;
3088 ctx.pid = pid;
3089 ctx.include_drivers = (pid == 0 && (trace_flags & STACKSHOT_INCLUDE_DRIVER_THREADS_IN_KERNEL) != 0);
3090
3091 if (use_fault_path) {
3092 fault_stats.sfs_pages_faulted_in = 0;
3093 fault_stats.sfs_time_spent_faulting = 0;
3094 fault_stats.sfs_stopped_faulting = (uint8_t) FALSE;
3095 }
3096
3097 if (sizeof(void *) == 8) {
3098 system_state_flags |= kKernel64_p;
3099 }
3100
3101 if (stackshot_kcdata_p == NULL || pBytesTraced == NULL) {
3102 error = KERN_INVALID_ARGUMENT;
3103 goto error_exit;
3104 }
3105
3106 _stackshot_validation_reset();
3107 stackshot_plh_setup(stackshot_kcdata_p); /* set up port label hash */
3108
3109 /* setup mach_absolute_time and timebase info -- copy out in some cases and needed to convert since_timestamp to seconds for proc start time */
3110 clock_timebase_info(&timebase);
3111
3112 /* begin saving data into the buffer */
3113 *pBytesTraced = 0;
3114 if (pBytesUncompressed) {
3115 *pBytesUncompressed = 0;
3116 }
3117 kcd_exit_on_error(kcdata_add_uint64_with_description(stackshot_kcdata_p, trace_flags, "stackshot_in_flags"));
3118 kcd_exit_on_error(kcdata_add_uint32_with_description(stackshot_kcdata_p, (uint32_t)pid, "stackshot_in_pid"));
3119 kcd_exit_on_error(kcdata_add_uint64_with_description(stackshot_kcdata_p, system_state_flags, "system_state_flags"));
3120 if (trace_flags & STACKSHOT_PAGE_TABLES) {
3121 kcd_exit_on_error(kcdata_add_uint32_with_description(stackshot_kcdata_p, stack_snapshot_pagetable_mask, "stackshot_pagetable_mask"));
3122 }
3123 if (stackshot_initial_estimate != 0) {
3124 kcd_exit_on_error(kcdata_add_uint32_with_description(stackshot_kcdata_p, stackshot_initial_estimate, "stackshot_size_estimate"));
3125 kcd_exit_on_error(kcdata_add_uint32_with_description(stackshot_kcdata_p, stackshot_initial_estimate_adj, "stackshot_size_estimate_adj"));
3126 }
3127
3128 #if STACKSHOT_COLLECTS_LATENCY_INFO
3129 latency_info.setup_latency = mach_absolute_time();
3130 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
3131
3132 #if CONFIG_JETSAM
3133 tmp32 = memorystatus_get_pressure_status_kdp();
3134 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_JETSAM_LEVEL, sizeof(uint32_t), &tmp32));
3135 #endif
3136
3137 if (!collect_delta_stackshot) {
3138 tmp32 = THREAD_POLICY_INTERNAL_STRUCT_VERSION;
3139 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_THREAD_POLICY_VERSION, sizeof(uint32_t), &tmp32));
3140
3141 tmp32 = PAGE_SIZE;
3142 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_KERN_PAGE_SIZE, sizeof(uint32_t), &tmp32));
3143
3144 /* save boot-args and osversion string */
3145 length_to_copy = MIN((uint32_t)(strlen(version) + 1), OSVERSIZE);
3146 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_OSVERSION, length_to_copy, (const void *)version));
3147
3148
3149 length_to_copy = MIN((uint32_t)(strlen(PE_boot_args()) + 1), BOOT_LINE_LENGTH);
3150 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_BOOTARGS, length_to_copy, PE_boot_args()));
3151
3152 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, KCDATA_TYPE_TIMEBASE, sizeof(timebase), &timebase));
3153 } else {
3154 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_DELTA_SINCE_TIMESTAMP, sizeof(uint64_t), &stack_snapshot_delta_since_timestamp));
3155 }
3156
3157 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, KCDATA_TYPE_MACH_ABSOLUTE_TIME, sizeof(uint64_t), &abs_time));
3158
3159 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, KCDATA_TYPE_USECS_SINCE_EPOCH, sizeof(uint64_t), &stackshot_microsecs));
3160
3161 kcd_exit_on_error(kdp_stackshot_shared_regions(trace_flags));
3162
3163 /* Add requested information first */
3164 if (trace_flags & STACKSHOT_GET_GLOBAL_MEM_STATS) {
3165 struct mem_and_io_snapshot mais = {0};
3166 kdp_mem_and_io_snapshot(&mais);
3167 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_GLOBAL_MEM_STATS, sizeof(mais), &mais));
3168 }
3169
3170 #if CONFIG_THREAD_GROUPS
3171 struct thread_group_snapshot_v3 *thread_groups = NULL;
3172 int num_thread_groups = 0;
3173
3174 #if SCHED_HYGIENE_DEBUG && CONFIG_PERVASIVE_CPI
3175 uint64_t thread_group_begin_cpu_cycle_count = 0;
3176
3177 if (!panic_stackshot && (trace_flags & STACKSHOT_THREAD_GROUP)) {
3178 thread_group_begin_cpu_cycle_count = mt_cur_cpu_cycles();
3179 }
3180 #endif
3181
3182
3183 /* Iterate over thread group names */
3184 if (trace_flags & STACKSHOT_THREAD_GROUP) {
3185 /* Variable size array - better not have it on the stack. */
3186 kcdata_compression_window_open(stackshot_kcdata_p);
3187
3188 if (thread_group_iterate_stackshot(stackshot_thread_group_count, &num_thread_groups) != KERN_SUCCESS) {
3189 trace_flags &= ~(STACKSHOT_THREAD_GROUP);
3190 }
3191
3192 if (num_thread_groups > 0) {
3193 kcd_exit_on_error(kcdata_get_memory_addr_for_array(stackshot_kcdata_p, STACKSHOT_KCTYPE_THREAD_GROUP_SNAPSHOT, sizeof(struct thread_group_snapshot_v3), num_thread_groups, &out_addr));
3194 thread_groups = (struct thread_group_snapshot_v3 *)out_addr;
3195 }
3196
3197 if (thread_group_iterate_stackshot(stackshot_thread_group_snapshot, thread_groups) != KERN_SUCCESS) {
3198 error = KERN_FAILURE;
3199 goto error_exit;
3200 }
3201
3202 kcd_exit_on_error(kcdata_compression_window_close(stackshot_kcdata_p));
3203 }
3204
3205 #if SCHED_HYGIENE_DEBUG && CONFIG_PERVASIVE_CPI
3206 if (!panic_stackshot && (thread_group_begin_cpu_cycle_count != 0)) {
3207 kcd_exit_on_error(kcdata_add_uint64_with_description(stackshot_kcdata_p, (mt_cur_cpu_cycles() - thread_group_begin_cpu_cycle_count),
3208 "thread_groups_cpu_cycle_count"));
3209 }
3210 #endif
3211 #else
3212 trace_flags &= ~(STACKSHOT_THREAD_GROUP);
3213 #endif /* CONFIG_THREAD_GROUPS */
3214
3215
3216 #if STACKSHOT_COLLECTS_LATENCY_INFO
3217 latency_info.setup_latency = mach_absolute_time() - latency_info.setup_latency;
3218 latency_info.total_task_iteration_latency = mach_absolute_time();
3219 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
3220
3221 /* Iterate over tasks */
3222 queue_iterate(&tasks, task, task_t, tasks)
3223 {
3224 if (collect_delta_stackshot) {
3225 uint64_t abstime;
3226 proc_starttime_kdp(get_bsdtask_info(task), NULL, NULL, &abstime);
3227
3228 if (abstime > last_task_start_time) {
3229 last_task_start_time = abstime;
3230 }
3231 }
3232
3233 error = kdp_stackshot_record_task(&ctx, task);
3234 if (error) {
3235 goto error_exit;
3236 }
3237 }
3238
3239
3240 #if STACKSHOT_COLLECTS_LATENCY_INFO
3241 latency_info.total_task_iteration_latency = mach_absolute_time() - latency_info.total_task_iteration_latency;
3242 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
3243
3244 #if CONFIG_COALITIONS
3245 /* Don't collect jetsam coalition data in delta stakshots - these don't change */
3246 if (!collect_delta_stackshot || (last_task_start_time > stack_snapshot_delta_since_timestamp)) {
3247 int num_coalitions = 0;
3248 struct jetsam_coalition_snapshot *coalitions = NULL;
3249
3250 #if SCHED_HYGIENE_DEBUG && CONFIG_PERVASIVE_CPI
3251 uint64_t coalition_begin_cpu_cycle_count = 0;
3252
3253 if (!panic_stackshot && (trace_flags & STACKSHOT_SAVE_JETSAM_COALITIONS)) {
3254 coalition_begin_cpu_cycle_count = mt_cur_cpu_cycles();
3255 }
3256 #endif /* SCHED_HYGIENE_DEBUG && CONFIG_PERVASIVE_CPI */
3257
3258 /* Iterate over coalitions */
3259 if (trace_flags & STACKSHOT_SAVE_JETSAM_COALITIONS) {
3260 if (coalition_iterate_stackshot(stackshot_coalition_jetsam_count, &num_coalitions, COALITION_TYPE_JETSAM) != KERN_SUCCESS) {
3261 trace_flags &= ~(STACKSHOT_SAVE_JETSAM_COALITIONS);
3262 }
3263 }
3264 if (trace_flags & STACKSHOT_SAVE_JETSAM_COALITIONS) {
3265 if (num_coalitions > 0) {
3266 /* Variable size array - better not have it on the stack. */
3267 kcdata_compression_window_open(stackshot_kcdata_p);
3268 kcd_exit_on_error(kcdata_get_memory_addr_for_array(stackshot_kcdata_p, STACKSHOT_KCTYPE_JETSAM_COALITION_SNAPSHOT, sizeof(struct jetsam_coalition_snapshot), num_coalitions, &out_addr));
3269 coalitions = (struct jetsam_coalition_snapshot*)out_addr;
3270
3271 if (coalition_iterate_stackshot(stackshot_coalition_jetsam_snapshot, coalitions, COALITION_TYPE_JETSAM) != KERN_SUCCESS) {
3272 error = KERN_FAILURE;
3273 goto error_exit;
3274 }
3275
3276 kcd_exit_on_error(kcdata_compression_window_close(stackshot_kcdata_p));
3277 }
3278 }
3279 #if SCHED_HYGIENE_DEBUG && CONFIG_PERVASIVE_CPI
3280 if (!panic_stackshot && (coalition_begin_cpu_cycle_count != 0)) {
3281 kcd_exit_on_error(kcdata_add_uint64_with_description(stackshot_kcdata_p, (mt_cur_cpu_cycles() - coalition_begin_cpu_cycle_count),
3282 "coalitions_cpu_cycle_count"));
3283 }
3284 #endif /* SCHED_HYGIENE_DEBUG && CONFIG_PERVASIVE_CPI */
3285 }
3286 #else
3287 trace_flags &= ~(STACKSHOT_SAVE_JETSAM_COALITIONS);
3288 #endif /* CONFIG_COALITIONS */
3289
3290 #if STACKSHOT_COLLECTS_LATENCY_INFO
3291 latency_info.total_terminated_task_iteration_latency = mach_absolute_time();
3292 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
3293
3294 /*
3295 * Iterate over the tasks in the terminated tasks list. We only inspect
3296 * tasks that have a valid bsd_info pointer. The check for task transition
3297 * like past P_LPEXIT during proc_exit() is now checked for inside the
3298 * kdp_stackshot_record_task(), and then a safer and minimal
3299 * transitioning_task_snapshot struct is collected via
3300 * kcdata_record_transitioning_task_snapshot()
3301 */
3302 queue_iterate(&terminated_tasks, task, task_t, tasks)
3303 {
3304 error = kdp_stackshot_record_task(&ctx, task);
3305 if (error) {
3306 goto error_exit;
3307 }
3308 }
3309 #if DEVELOPMENT || DEBUG
3310 kcd_exit_on_error(kdp_stackshot_plh_stats());
3311 #endif /* DEVELOPMENT || DEBUG */
3312
3313 #if STACKSHOT_COLLECTS_LATENCY_INFO
3314 latency_info.total_terminated_task_iteration_latency = mach_absolute_time() - latency_info.total_terminated_task_iteration_latency;
3315 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
3316
3317 if (use_fault_path) {
3318 kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_STACKSHOT_FAULT_STATS,
3319 sizeof(struct stackshot_fault_stats), &fault_stats);
3320 }
3321
3322 #if STACKSHOT_COLLECTS_LATENCY_INFO
3323 if (collect_latency_info) {
3324 latency_info.latency_version = 1;
3325 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_LATENCY_INFO, sizeof(latency_info), &latency_info));
3326 }
3327 #endif /* STACKSHOT_COLLECTS_LATENCY_INFO */
3328
3329 /* update timestamp of the stackshot */
3330 abs_time_end = mach_absolute_time();
3331 struct stackshot_duration_v2 stackshot_duration = {
3332 .stackshot_duration = (abs_time_end - abs_time),
3333 .stackshot_duration_outer = 0,
3334 .stackshot_duration_prior = stackshot_duration_prior_abs,
3335 };
3336
3337 if ((trace_flags & STACKSHOT_DO_COMPRESS) == 0) {
3338 kcd_exit_on_error(kcdata_get_memory_addr(stackshot_kcdata_p, STACKSHOT_KCTYPE_STACKSHOT_DURATION,
3339 sizeof(struct stackshot_duration_v2), &out_addr));
3340 struct stackshot_duration_v2 *duration_p = (void *) out_addr;
3341 kdp_memcpy(duration_p, &stackshot_duration, sizeof(*duration_p));
3342 stackshot_duration_outer = (unaligned_u64 *)&duration_p->stackshot_duration_outer;
3343 } else {
3344 kcd_exit_on_error(kcdata_push_data(stackshot_kcdata_p, STACKSHOT_KCTYPE_STACKSHOT_DURATION, sizeof(stackshot_duration), &stackshot_duration));
3345 stackshot_duration_outer = NULL;
3346 }
3347
3348 #if SCHED_HYGIENE_DEBUG && CONFIG_PERVASIVE_CPI
3349 if (!panic_stackshot) {
3350 kcd_exit_on_error(kcdata_add_uint64_with_description(stackshot_kcdata_p, (mt_cur_cpu_cycles() - stackshot_begin_cpu_cycle_count),
3351 "stackshot_total_cpu_cycle_cnt"));
3352 }
3353 #endif
3354
3355 kcd_finalize_compression(stackshot_kcdata_p);
3356 kcd_exit_on_error(kcdata_add_uint64_with_description(stackshot_kcdata_p, trace_flags, "stackshot_out_flags"));
3357
3358 kcd_exit_on_error(kcdata_write_buffer_end(stackshot_kcdata_p));
3359
3360 /* === END of populating stackshot data === */
3361
3362 *pBytesTraced = (uint32_t) kcdata_memory_get_used_bytes(stackshot_kcdata_p);
3363 *pBytesUncompressed = (uint32_t) kcdata_memory_get_uncompressed_bytes(stackshot_kcdata_p);
3364
3365 error_exit:;
3366
3367 #if SCHED_HYGIENE_DEBUG
3368 bool disable_interrupts_masked_check = kern_feature_override(
3369 KF_INTERRUPT_MASKED_DEBUG_STACKSHOT_OVRD) ||
3370 (trace_flags & STACKSHOT_DO_COMPRESS) != 0;
3371
3372 #if STACKSHOT_INTERRUPTS_MASKED_CHECK_DISABLED
3373 disable_interrupts_masked_check = true;
3374 #endif /* STACKSHOT_INTERRUPTS_MASKED_CHECK_DISABLED */
3375
3376 if (disable_interrupts_masked_check) {
3377 ml_spin_debug_clear_self();
3378 }
3379
3380 if (!panic_stackshot && interrupt_masked_debug_mode) {
3381 /*
3382 * Try to catch instances where stackshot takes too long BEFORE returning from
3383 * the debugger
3384 */
3385 ml_handle_stackshot_interrupt_disabled_duration(current_thread());
3386 }
3387 #endif /* SCHED_HYGIENE_DEBUG */
3388 stackshot_plh_reset();
3389 stack_enable_faulting = FALSE;
3390
3391 return error;
3392 }
3393
3394 static uint64_t
proc_was_throttled_from_task(task_t task)3395 proc_was_throttled_from_task(task_t task)
3396 {
3397 uint64_t was_throttled = 0;
3398 void *bsd_info = get_bsdtask_info(task);
3399
3400 if (bsd_info) {
3401 was_throttled = proc_was_throttled(bsd_info);
3402 }
3403
3404 return was_throttled;
3405 }
3406
3407 static uint64_t
proc_did_throttle_from_task(task_t task)3408 proc_did_throttle_from_task(task_t task)
3409 {
3410 uint64_t did_throttle = 0;
3411 void *bsd_info = get_bsdtask_info(task);
3412
3413 if (bsd_info) {
3414 did_throttle = proc_did_throttle(bsd_info);
3415 }
3416
3417 return did_throttle;
3418 }
3419
3420 static void
kdp_mem_and_io_snapshot(struct mem_and_io_snapshot * memio_snap)3421 kdp_mem_and_io_snapshot(struct mem_and_io_snapshot *memio_snap)
3422 {
3423 unsigned int pages_reclaimed;
3424 unsigned int pages_wanted;
3425 kern_return_t kErr;
3426
3427 uint64_t compressions = 0;
3428 uint64_t decompressions = 0;
3429
3430 compressions = counter_load(&vm_statistics_compressions);
3431 decompressions = counter_load(&vm_statistics_decompressions);
3432
3433 memio_snap->snapshot_magic = STACKSHOT_MEM_AND_IO_SNAPSHOT_MAGIC;
3434 memio_snap->free_pages = vm_page_free_count;
3435 memio_snap->active_pages = vm_page_active_count;
3436 memio_snap->inactive_pages = vm_page_inactive_count;
3437 memio_snap->purgeable_pages = vm_page_purgeable_count;
3438 memio_snap->wired_pages = vm_page_wire_count;
3439 memio_snap->speculative_pages = vm_page_speculative_count;
3440 memio_snap->throttled_pages = vm_page_throttled_count;
3441 memio_snap->busy_buffer_count = count_busy_buffers();
3442 memio_snap->filebacked_pages = vm_page_pageable_external_count;
3443 memio_snap->compressions = (uint32_t)compressions;
3444 memio_snap->decompressions = (uint32_t)decompressions;
3445 memio_snap->compressor_size = VM_PAGE_COMPRESSOR_COUNT;
3446 kErr = mach_vm_pressure_monitor(FALSE, VM_PRESSURE_TIME_WINDOW, &pages_reclaimed, &pages_wanted);
3447
3448 if (!kErr) {
3449 memio_snap->pages_wanted = (uint32_t)pages_wanted;
3450 memio_snap->pages_reclaimed = (uint32_t)pages_reclaimed;
3451 memio_snap->pages_wanted_reclaimed_valid = 1;
3452 } else {
3453 memio_snap->pages_wanted = 0;
3454 memio_snap->pages_reclaimed = 0;
3455 memio_snap->pages_wanted_reclaimed_valid = 0;
3456 }
3457 }
3458
3459 static vm_offset_t
stackshot_find_phys(vm_map_t map,vm_offset_t target_addr,kdp_fault_flags_t fault_flags,uint32_t * kdp_fault_result_flags)3460 stackshot_find_phys(vm_map_t map, vm_offset_t target_addr, kdp_fault_flags_t fault_flags, uint32_t *kdp_fault_result_flags)
3461 {
3462 vm_offset_t result;
3463 struct kdp_fault_result fault_results = {0};
3464 if (fault_stats.sfs_stopped_faulting) {
3465 fault_flags &= ~KDP_FAULT_FLAGS_ENABLE_FAULTING;
3466 }
3467
3468 result = kdp_find_phys(map, target_addr, fault_flags, &fault_results);
3469
3470 if ((fault_results.flags & KDP_FAULT_RESULT_TRIED_FAULT) || (fault_results.flags & KDP_FAULT_RESULT_FAULTED_IN)) {
3471 fault_stats.sfs_time_spent_faulting += fault_results.time_spent_faulting;
3472
3473 if ((fault_stats.sfs_time_spent_faulting >= fault_stats.sfs_system_max_fault_time) && !panic_stackshot) {
3474 fault_stats.sfs_stopped_faulting = (uint8_t) TRUE;
3475 }
3476 }
3477
3478 if (fault_results.flags & KDP_FAULT_RESULT_FAULTED_IN) {
3479 fault_stats.sfs_pages_faulted_in++;
3480 }
3481
3482 if (kdp_fault_result_flags) {
3483 *kdp_fault_result_flags = fault_results.flags;
3484 }
3485
3486 return result;
3487 }
3488
3489 /*
3490 * Wrappers around kdp_generic_copyin, kdp_generic_copyin_word, kdp_generic_copyin_string that use stackshot_find_phys
3491 * in order to:
3492 * 1. collect statistics on the number of pages faulted in
3493 * 2. stop faulting if the time spent faulting has exceeded the limit.
3494 */
3495 static boolean_t
stackshot_copyin(vm_map_t map,uint64_t uaddr,void * dest,size_t size,boolean_t try_fault,kdp_fault_result_flags_t * kdp_fault_result_flags)3496 stackshot_copyin(vm_map_t map, uint64_t uaddr, void *dest, size_t size, boolean_t try_fault, kdp_fault_result_flags_t *kdp_fault_result_flags)
3497 {
3498 kdp_fault_flags_t fault_flags = KDP_FAULT_FLAGS_NONE;
3499 if (try_fault) {
3500 fault_flags |= KDP_FAULT_FLAGS_ENABLE_FAULTING;
3501 }
3502 return kdp_generic_copyin(map, uaddr, dest, size, fault_flags, (find_phys_fn_t)stackshot_find_phys, kdp_fault_result_flags) == KERN_SUCCESS;
3503 }
3504 static boolean_t
stackshot_copyin_word(task_t task,uint64_t addr,uint64_t * result,boolean_t try_fault,kdp_fault_result_flags_t * kdp_fault_result_flags)3505 stackshot_copyin_word(task_t task, uint64_t addr, uint64_t *result, boolean_t try_fault, kdp_fault_result_flags_t *kdp_fault_result_flags)
3506 {
3507 kdp_fault_flags_t fault_flags = KDP_FAULT_FLAGS_NONE;
3508 if (try_fault) {
3509 fault_flags |= KDP_FAULT_FLAGS_ENABLE_FAULTING;
3510 }
3511 return kdp_generic_copyin_word(task, addr, result, fault_flags, (find_phys_fn_t)stackshot_find_phys, kdp_fault_result_flags) == KERN_SUCCESS;
3512 }
3513 static int
stackshot_copyin_string(task_t task,uint64_t addr,char * buf,int buf_sz,boolean_t try_fault,kdp_fault_result_flags_t * kdp_fault_result_flags)3514 stackshot_copyin_string(task_t task, uint64_t addr, char *buf, int buf_sz, boolean_t try_fault, kdp_fault_result_flags_t *kdp_fault_result_flags)
3515 {
3516 kdp_fault_flags_t fault_flags = KDP_FAULT_FLAGS_NONE;
3517 if (try_fault) {
3518 fault_flags |= KDP_FAULT_FLAGS_ENABLE_FAULTING;
3519 }
3520 return kdp_generic_copyin_string(task, addr, buf, buf_sz, fault_flags, (find_phys_fn_t)stackshot_find_phys, kdp_fault_result_flags);
3521 }
3522
3523 kern_return_t
do_stackshot(void * context)3524 do_stackshot(void *context)
3525 {
3526 #pragma unused(context)
3527 kdp_snapshot++;
3528
3529 stack_snapshot_ret = kdp_stackshot_kcdata_format(stack_snapshot_pid,
3530 stack_snapshot_flags,
3531 &stack_snapshot_bytes_traced,
3532 &stack_snapshot_bytes_uncompressed);
3533
3534 if (stack_snapshot_ret == KERN_SUCCESS) {
3535 /* releases and zeros and kcdata_end_alloc()s done */
3536 kcdata_finish(stackshot_kcdata_p);
3537 }
3538
3539 kdp_snapshot--;
3540 return stack_snapshot_ret;
3541 }
3542
3543 boolean_t
stackshot_thread_is_idle_worker_unsafe(thread_t thread)3544 stackshot_thread_is_idle_worker_unsafe(thread_t thread)
3545 {
3546 /* When the pthread kext puts a worker thread to sleep, it will
3547 * set kThreadWaitParkedWorkQueue in the block_hint of the thread
3548 * struct. See parkit() in kern/kern_support.c in libpthread.
3549 */
3550 return (thread->state & TH_WAIT) &&
3551 (thread->block_hint == kThreadWaitParkedWorkQueue);
3552 }
3553
3554 #if CONFIG_COALITIONS
3555 static void
stackshot_coalition_jetsam_count(void * arg,int i,coalition_t coal)3556 stackshot_coalition_jetsam_count(void *arg, int i, coalition_t coal)
3557 {
3558 #pragma unused(i, coal)
3559 unsigned int *coalition_count = (unsigned int*)arg;
3560 (*coalition_count)++;
3561 }
3562
3563 static void
stackshot_coalition_jetsam_snapshot(void * arg,int i,coalition_t coal)3564 stackshot_coalition_jetsam_snapshot(void *arg, int i, coalition_t coal)
3565 {
3566 if (coalition_type(coal) != COALITION_TYPE_JETSAM) {
3567 return;
3568 }
3569
3570 struct jetsam_coalition_snapshot *coalitions = (struct jetsam_coalition_snapshot*)arg;
3571 struct jetsam_coalition_snapshot *jcs = &coalitions[i];
3572 task_t leader = TASK_NULL;
3573 jcs->jcs_id = coalition_id(coal);
3574 jcs->jcs_flags = 0;
3575 jcs->jcs_thread_group = 0;
3576
3577 if (coalition_term_requested(coal)) {
3578 jcs->jcs_flags |= kCoalitionTermRequested;
3579 }
3580 if (coalition_is_terminated(coal)) {
3581 jcs->jcs_flags |= kCoalitionTerminated;
3582 }
3583 if (coalition_is_reaped(coal)) {
3584 jcs->jcs_flags |= kCoalitionReaped;
3585 }
3586 if (coalition_is_privileged(coal)) {
3587 jcs->jcs_flags |= kCoalitionPrivileged;
3588 }
3589
3590 #if CONFIG_THREAD_GROUPS
3591 struct thread_group *thread_group = kdp_coalition_get_thread_group(coal);
3592 if (thread_group) {
3593 jcs->jcs_thread_group = thread_group_get_id(thread_group);
3594 }
3595 #endif /* CONFIG_THREAD_GROUPS */
3596
3597 leader = kdp_coalition_get_leader(coal);
3598 if (leader) {
3599 jcs->jcs_leader_task_uniqueid = get_task_uniqueid(leader);
3600 } else {
3601 jcs->jcs_leader_task_uniqueid = 0;
3602 }
3603 }
3604 #endif /* CONFIG_COALITIONS */
3605
3606 #if CONFIG_THREAD_GROUPS
3607 static void
stackshot_thread_group_count(void * arg,int i,struct thread_group * tg)3608 stackshot_thread_group_count(void *arg, int i, struct thread_group *tg)
3609 {
3610 #pragma unused(i, tg)
3611 unsigned int *n = (unsigned int*)arg;
3612 (*n)++;
3613 }
3614
3615 static void
stackshot_thread_group_snapshot(void * arg,int i,struct thread_group * tg)3616 stackshot_thread_group_snapshot(void *arg, int i, struct thread_group *tg)
3617 {
3618 struct thread_group_snapshot_v3 *thread_groups = arg;
3619 struct thread_group_snapshot_v3 *tgs = &thread_groups[i];
3620 const char *name = thread_group_get_name(tg);
3621 uint32_t flags = thread_group_get_flags(tg);
3622 tgs->tgs_id = thread_group_get_id(tg);
3623 static_assert(THREAD_GROUP_MAXNAME > sizeof(tgs->tgs_name));
3624 kdp_memcpy(tgs->tgs_name, name, sizeof(tgs->tgs_name));
3625 kdp_memcpy(tgs->tgs_name_cont, name + sizeof(tgs->tgs_name),
3626 sizeof(tgs->tgs_name_cont));
3627 tgs->tgs_flags =
3628 ((flags & THREAD_GROUP_FLAGS_EFFICIENT) ? kThreadGroupEfficient : 0) |
3629 ((flags & THREAD_GROUP_FLAGS_APPLICATION) ? kThreadGroupApplication : 0) |
3630 ((flags & THREAD_GROUP_FLAGS_CRITICAL) ? kThreadGroupCritical : 0) |
3631 ((flags & THREAD_GROUP_FLAGS_BEST_EFFORT) ? kThreadGroupBestEffort : 0) |
3632 ((flags & THREAD_GROUP_FLAGS_UI_APP) ? kThreadGroupUIApplication : 0) |
3633 ((flags & THREAD_GROUP_FLAGS_MANAGED) ? kThreadGroupManaged : 0) |
3634 0;
3635 }
3636 #endif /* CONFIG_THREAD_GROUPS */
3637
3638 /* Determine if a thread has waitinfo that stackshot can provide */
3639 static int
stackshot_thread_has_valid_waitinfo(thread_t thread)3640 stackshot_thread_has_valid_waitinfo(thread_t thread)
3641 {
3642 if (!(thread->state & TH_WAIT)) {
3643 return 0;
3644 }
3645
3646 switch (thread->block_hint) {
3647 // If set to None or is a parked work queue, ignore it
3648 case kThreadWaitParkedWorkQueue:
3649 case kThreadWaitNone:
3650 return 0;
3651 // There is a short window where the pthread kext removes a thread
3652 // from its ksyn wait queue before waking the thread up
3653 case kThreadWaitPThreadMutex:
3654 case kThreadWaitPThreadRWLockRead:
3655 case kThreadWaitPThreadRWLockWrite:
3656 case kThreadWaitPThreadCondVar:
3657 return kdp_pthread_get_thread_kwq(thread) != NULL;
3658 // All other cases are valid block hints if in a wait state
3659 default:
3660 return 1;
3661 }
3662 }
3663
3664 /* Determine if a thread has turnstileinfo that stackshot can provide */
3665 static int
stackshot_thread_has_valid_turnstileinfo(thread_t thread)3666 stackshot_thread_has_valid_turnstileinfo(thread_t thread)
3667 {
3668 struct turnstile *ts = thread_get_waiting_turnstile(thread);
3669
3670 return stackshot_thread_has_valid_waitinfo(thread) &&
3671 ts != TURNSTILE_NULL;
3672 }
3673
3674 static void
stackshot_thread_turnstileinfo(thread_t thread,thread_turnstileinfo_v2_t * tsinfo)3675 stackshot_thread_turnstileinfo(thread_t thread, thread_turnstileinfo_v2_t *tsinfo)
3676 {
3677 struct turnstile *ts;
3678 struct ipc_service_port_label *ispl = NULL;
3679
3680 /* acquire turnstile information and store it in the stackshot */
3681 ts = thread_get_waiting_turnstile(thread);
3682 tsinfo->waiter = thread_tid(thread);
3683 kdp_turnstile_fill_tsinfo(ts, tsinfo, &ispl);
3684 tsinfo->portlabel_id = stackshot_plh_lookup(ispl,
3685 (tsinfo->turnstile_flags & STACKSHOT_TURNSTILE_STATUS_SENDPORT) ? STACKSHOT_PLH_LOOKUP_SEND :
3686 (tsinfo->turnstile_flags & STACKSHOT_TURNSTILE_STATUS_RECEIVEPORT) ? STACKSHOT_PLH_LOOKUP_RECEIVE :
3687 STACKSHOT_PLH_LOOKUP_UNKNOWN);
3688 }
3689
3690 static void
stackshot_thread_wait_owner_info(thread_t thread,thread_waitinfo_v2_t * waitinfo)3691 stackshot_thread_wait_owner_info(thread_t thread, thread_waitinfo_v2_t *waitinfo)
3692 {
3693 thread_waitinfo_t *waitinfo_v1 = (thread_waitinfo_t *)waitinfo;
3694 struct ipc_service_port_label *ispl = NULL;
3695
3696 waitinfo->waiter = thread_tid(thread);
3697 waitinfo->wait_type = thread->block_hint;
3698 waitinfo->wait_flags = 0;
3699
3700 switch (waitinfo->wait_type) {
3701 case kThreadWaitKernelMutex:
3702 kdp_lck_mtx_find_owner(thread->waitq.wq_q, thread->wait_event, waitinfo_v1);
3703 break;
3704 case kThreadWaitPortReceive:
3705 kdp_mqueue_recv_find_owner(thread->waitq.wq_q, thread->wait_event, waitinfo, &ispl);
3706 waitinfo->portlabel_id = stackshot_plh_lookup(ispl, STACKSHOT_PLH_LOOKUP_RECEIVE);
3707 break;
3708 case kThreadWaitPortSend:
3709 kdp_mqueue_send_find_owner(thread->waitq.wq_q, thread->wait_event, waitinfo, &ispl);
3710 waitinfo->portlabel_id = stackshot_plh_lookup(ispl, STACKSHOT_PLH_LOOKUP_SEND);
3711 break;
3712 case kThreadWaitSemaphore:
3713 kdp_sema_find_owner(thread->waitq.wq_q, thread->wait_event, waitinfo_v1);
3714 break;
3715 case kThreadWaitUserLock:
3716 kdp_ulock_find_owner(thread->waitq.wq_q, thread->wait_event, waitinfo_v1);
3717 break;
3718 case kThreadWaitKernelRWLockRead:
3719 case kThreadWaitKernelRWLockWrite:
3720 case kThreadWaitKernelRWLockUpgrade:
3721 kdp_rwlck_find_owner(thread->waitq.wq_q, thread->wait_event, waitinfo_v1);
3722 break;
3723 case kThreadWaitPThreadMutex:
3724 case kThreadWaitPThreadRWLockRead:
3725 case kThreadWaitPThreadRWLockWrite:
3726 case kThreadWaitPThreadCondVar:
3727 kdp_pthread_find_owner(thread, waitinfo_v1);
3728 break;
3729 case kThreadWaitWorkloopSyncWait:
3730 kdp_workloop_sync_wait_find_owner(thread, thread->wait_event, waitinfo_v1);
3731 break;
3732 case kThreadWaitOnProcess:
3733 kdp_wait4_find_process(thread, thread->wait_event, waitinfo_v1);
3734 break;
3735 case kThreadWaitSleepWithInheritor:
3736 kdp_sleep_with_inheritor_find_owner(thread->waitq.wq_q, thread->wait_event, waitinfo_v1);
3737 break;
3738 case kThreadWaitEventlink:
3739 kdp_eventlink_find_owner(thread->waitq.wq_q, thread->wait_event, waitinfo_v1);
3740 break;
3741 case kThreadWaitCompressor:
3742 kdp_compressor_busy_find_owner(thread->wait_event, waitinfo_v1);
3743 break;
3744 default:
3745 waitinfo->owner = 0;
3746 waitinfo->context = 0;
3747 break;
3748 }
3749 }
3750