1 /*
2 * Copyright (c) 2015 Apple Inc. All rights reserved.
3 *
4 * @APPLE_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. Please obtain a copy of the License at
10 * http://www.opensource.apple.com/apsl/ and read it before using this
11 * file.
12 *
13 * The Original Code and all software distributed under the License are
14 * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
15 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
16 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
18 * Please see the License for the specific language governing rights and
19 * limitations under the License.
20 *
21 * @APPLE_LICENSE_HEADER_END@
22 */
23
24 #include <kcdata.h>
25 #include <sys/time.h>
26 #include <stdlib.h>
27 #include <stddef.h>
28 #include <string.h>
29 #include <assert.h>
30 #include <stdio.h>
31 #include <mach/mach_time.h>
32 #include <assert.h>
33
34 /*!
35 * @function kcdata_get_typedescription
36 *
37 * @abstract
38 * Search the known type definitions for type with id type_id.
39 *
40 * @param type_id
41 * A unsinged int type specified by the KCDATA.
42 *
43 * @param buffer
44 * pointer to data area where type definition will be saved.
45 *
46 * @param buffer_size
47 * size of the buffer provided.
48 *
49 * @return struct kcdata_type_definition *
50 * pointer to a malloc'ed buffer holding the type definition and each subtype defintion for its fields.
51 * It may return NULL if no type with id == type_id is found.
52 * Note: The caller is responsible to free() the memory when its no longer used.
53 *
54 * @discussion
55 * This function queries the known type definitions table. If found the defintion data is returned
56 * else NULL is returned. It is advised to cache the return value from this function since the data
57 * is always going to be the same for same type_id. The definition setup requires memory on heap.
58 * The caller should make sure to free() the data once its done with using it.
59 *
60 */
61 struct kcdata_type_definition * kcdata_get_typedescription(unsigned type_id, uint8_t * buffer, uint32_t buffer_size);
62
63 /* forward declarations for helper routines */
64 static uint32_t get_kctype_subtype_size(kctype_subtype_t type);
65 static void setup_subtype_description(kcdata_subtype_descriptor_t desc, kctype_subtype_t type, uint32_t offset, char * name);
66 static void setup_subtype_array_description(
67 kcdata_subtype_descriptor_t desc, kctype_subtype_t type, uint32_t offset, uint32_t count, char * name);
68 static void setup_type_definition(struct kcdata_type_definition * d, uint32_t type, uint32_t num_elems, char * name);
69
70 struct kcdata_type_definition *
kcdata_get_typedescription(unsigned type_id,uint8_t * buffer,uint32_t buffer_size)71 kcdata_get_typedescription(unsigned type_id, uint8_t * buffer, uint32_t buffer_size)
72 {
73 unsigned int i = 0;
74 #define _STR_VALUE(x) #x
75 #define _SUBTYPE_TRUNC(t, s, f, name) do { \
76 setup_subtype_description(&subtypes[i++], (t), offsetof(s, f), name); \
77 _Static_assert(sizeof(name) == sizeof ((struct kcdata_subtype_descriptor *)0)->kcs_name, "\"" name "\" should fit exactly in kcs_name"); \
78 } while (0)
79 #define _SUBTYPE(t, s, f) do { \
80 setup_subtype_description(&subtypes[i++], (t), offsetof(s, f), _STR_VALUE(f)); \
81 _Static_assert(sizeof(_STR_VALUE(f)) <= sizeof ((struct kcdata_subtype_descriptor *)0)->kcs_name, "\"" _STR_VALUE(f) "\" should fit in kcs_name"); \
82 } while (0)
83
84 #define _SUBTYPE_ARRAY(t, s, f, c) setup_subtype_array_description(&subtypes[i++], (t), offsetof(s, f), (c), _STR_VALUE(f))
85 #define _STRINGTYPE(f) setup_subtype_array_description(&subtypes[i++], KC_ST_CHAR, 0, UINT16_MAX, f)
86
87 if (buffer_size < sizeof(struct kcdata_type_definition) || buffer == NULL) {
88 return NULL;
89 }
90
91 struct kcdata_type_definition * retval = (struct kcdata_type_definition *)&buffer[0];
92 kcdata_subtype_descriptor_t subtypes = (kcdata_subtype_descriptor_t)&buffer[sizeof(struct kcdata_type_definition)];
93 switch (type_id) {
94 case KCDATA_TYPE_STRING_DESC: {
95 i = 0;
96 setup_subtype_array_description(&subtypes[i++], KC_ST_CHAR, 0, KCDATA_DESC_MAXLEN, "desc");
97 setup_subtype_array_description(&subtypes[i++], KC_ST_CHAR, KCDATA_DESC_MAXLEN, UINT16_MAX, "data");
98 setup_type_definition(retval, type_id, i, "string_desc");
99 break;
100 }
101
102 case KCDATA_TYPE_UINT32_DESC: {
103 i = 0;
104 setup_subtype_array_description(&subtypes[i++], KC_ST_CHAR, 0, KCDATA_DESC_MAXLEN, "desc");
105 setup_subtype_description(&subtypes[i++], KC_ST_UINT32, KCDATA_DESC_MAXLEN, "data");
106 setup_type_definition(retval, type_id, i, "uint32_desc");
107 break;
108 }
109
110 case KCDATA_TYPE_UINT64_DESC: {
111 i = 0;
112 setup_subtype_array_description(&subtypes[i++], KC_ST_CHAR, 0, KCDATA_DESC_MAXLEN, "desc");
113 setup_subtype_description(&subtypes[i++], KC_ST_UINT64, KCDATA_DESC_MAXLEN, "data");
114 setup_type_definition(retval, type_id, i, "uint64_desc");
115 break;
116 }
117
118 case KCDATA_TYPE_INT32_DESC: {
119 i = 0;
120 setup_subtype_array_description(&subtypes[i++], KC_ST_CHAR, 0, KCDATA_DESC_MAXLEN, "desc");
121 setup_subtype_description(&subtypes[i++], KC_ST_INT32, KCDATA_DESC_MAXLEN, "data");
122 setup_type_definition(retval, type_id, i, "int32_desc");
123 break;
124 }
125
126 case KCDATA_TYPE_INT64_DESC: {
127 i = 0;
128 setup_subtype_array_description(&subtypes[i++], KC_ST_CHAR, 0, KCDATA_DESC_MAXLEN, "desc");
129 setup_subtype_description(&subtypes[i++], KC_ST_INT64, KCDATA_DESC_MAXLEN, "data");
130 setup_type_definition(retval, type_id, i, "int64_desc");
131 break;
132 }
133
134 case KCDATA_TYPE_TYPEDEFINTION: {
135 i = 0;
136 setup_subtype_description(&subtypes[i++], KC_ST_UINT32, offsetof(struct kcdata_type_definition, kct_type_identifier), "typeID");
137 setup_subtype_description(&subtypes[i++], KC_ST_UINT32, offsetof(struct kcdata_type_definition, kct_num_elements), "numOfFields");
138 setup_subtype_array_description(&subtypes[i++], KC_ST_CHAR, offsetof(struct kcdata_type_definition, kct_name), KCDATA_DESC_MAXLEN, "name");
139 // Note "fields" is an array of run time defined length. So we populate fields at parsing time.
140 setup_type_definition(retval, type_id, i, "typedef");
141 break;
142 }
143
144 case KCDATA_TYPE_CONTAINER_BEGIN: {
145 i = 0;
146 setup_subtype_description(&subtypes[i++], KC_ST_UINT32, 0, "kcContainerType");
147 setup_type_definition(retval, type_id, i, "container_begin");
148 break;
149 }
150
151 case KCDATA_TYPE_LIBRARY_LOADINFO: {
152 i = 0;
153 _SUBTYPE(KC_ST_UINT32, struct user32_dyld_uuid_info, imageLoadAddress);
154 _SUBTYPE_ARRAY(KC_ST_UINT8, struct user32_dyld_uuid_info, imageUUID, 16);
155 setup_type_definition(retval, type_id, i, "dyld_load_info");
156 break;
157 }
158
159 case KCDATA_TYPE_LIBRARY_LOADINFO64: {
160 i = 0;
161 _SUBTYPE(KC_ST_UINT64, struct user64_dyld_uuid_info, imageLoadAddress);
162 _SUBTYPE_ARRAY(KC_ST_UINT8, struct user64_dyld_uuid_info, imageUUID, 16);
163 setup_type_definition(retval, type_id, i, "dyld_load_info");
164 break;
165 }
166 case STACKSHOT_KCTYPE_LOADINFO64_TEXT_EXEC: {
167 i = 0;
168 _SUBTYPE(KC_ST_UINT64, struct user64_dyld_uuid_info, imageLoadAddress);
169 _SUBTYPE_ARRAY(KC_ST_UINT8, struct user64_dyld_uuid_info, imageUUID, 16);
170 setup_type_definition(retval, type_id, i, "dyld_load_info_text_exec");
171 break;
172 }
173 case STACKSHOT_KCTYPE_SHAREDCACHE_LOADINFO: {
174 i = 0;
175 /*
176 * for backwards compatibility, we keep the old field names, but the
177 * new data is being put in dyld_shared_cache_loadinfo
178 */
179 _SUBTYPE(KC_ST_UINT64, struct dyld_uuid_info_64_v2, imageLoadAddress);
180 _SUBTYPE_ARRAY(KC_ST_UINT8, struct dyld_uuid_info_64_v2, imageUUID, 16);
181 _SUBTYPE(KC_ST_UINT64, struct dyld_uuid_info_64_v2, imageSlidBaseAddress);
182 _SUBTYPE(KC_ST_UINT64, struct dyld_shared_cache_loadinfo, sharedCacheSlidFirstMapping);
183 _SUBTYPE(KC_ST_UINT32, struct dyld_shared_cache_loadinfo_v2, sharedCacheID);
184 _SUBTYPE(KC_ST_UINT32, struct dyld_shared_cache_loadinfo_v2, sharedCacheFlags);
185 setup_type_definition(retval, type_id, i, "shared_cache_dyld_load_info");
186 break;
187 }
188 case STACKSHOT_KCTYPE_SHAREDCACHE_INFO: {
189 i = 0;
190 _SUBTYPE(KC_ST_UINT64, struct dyld_shared_cache_loadinfo_v2, sharedCacheSlide);
191 _SUBTYPE_ARRAY(KC_ST_UINT8, struct dyld_shared_cache_loadinfo_v2, sharedCacheUUID, 16);
192 _SUBTYPE_TRUNC(KC_ST_UINT64, struct dyld_shared_cache_loadinfo_v2, sharedCacheUnreliableSlidBaseAddress, "sharedCacheUnreliableSlidBaseAd");
193 _SUBTYPE(KC_ST_UINT64, struct dyld_shared_cache_loadinfo_v2, sharedCacheSlidFirstMapping);
194 _SUBTYPE(KC_ST_UINT32, struct dyld_shared_cache_loadinfo_v2, sharedCacheID);
195 _SUBTYPE(KC_ST_UINT32, struct dyld_shared_cache_loadinfo_v2, sharedCacheFlags);
196 setup_type_definition(retval, type_id, i, "shared_cache_dyld_load_info");
197 break;
198 }
199
200 case STACKSHOT_KCTYPE_KERNELCACHE_LOADINFO: {
201 i = 0;
202 _SUBTYPE(KC_ST_UINT64, struct dyld_uuid_info_64, imageLoadAddress);
203 _SUBTYPE_ARRAY(KC_ST_UINT8, struct dyld_uuid_info_64, imageUUID, 16);
204 setup_type_definition(retval, type_id, i, "kernelcache_load_info");
205 break;
206 }
207
208 case KCDATA_TYPE_TIMEBASE: {
209 i = 0;
210 _SUBTYPE(KC_ST_UINT32, struct mach_timebase_info, numer);
211 _SUBTYPE(KC_ST_UINT32, struct mach_timebase_info, denom);
212 setup_type_definition(retval, type_id, i, "mach_timebase_info");
213 break;
214 }
215
216 case KCDATA_TYPE_MACH_ABSOLUTE_TIME:
217 setup_type_definition(retval, type_id, 1, "mach_absolute_time");
218 setup_subtype_description(&subtypes[0], KC_ST_UINT64, 0, "mach_absolute_time");
219 break;
220
221 case KCDATA_TYPE_TIMEVAL: {
222 i = 0;
223 _SUBTYPE(KC_ST_INT64, struct timeval64, tv_sec);
224 _SUBTYPE(KC_ST_INT64, struct timeval64, tv_usec);
225 setup_type_definition(retval, type_id, i, "timeval");
226 break;
227 }
228
229 case KCDATA_TYPE_USECS_SINCE_EPOCH:
230 setup_type_definition(retval, type_id, 1, "usecs_since_epoch");
231 setup_subtype_description(&subtypes[0], KC_ST_UINT64, 0, "usecs_since_epoch");
232 break;
233
234 case KCDATA_TYPE_PID:
235 setup_subtype_description(&subtypes[0], KC_ST_INT32, 0, "pid");
236 setup_type_definition(retval, type_id, 1, "pid");
237 break;
238
239 case KCDATA_TYPE_PROCNAME:
240 i = 0;
241 setup_subtype_array_description(&subtypes[i++], KC_ST_CHAR, 0, 64, "proc_name");
242 setup_type_definition(retval, type_id, i, "proc_name");
243 break;
244
245 case KCDATA_TYPE_LIBRARY_AOTINFO: {
246 i = 0;
247 _SUBTYPE(KC_ST_UINT64, struct user64_dyld_aot_info, x86LoadAddress);
248 _SUBTYPE(KC_ST_UINT64, struct user64_dyld_aot_info, aotLoadAddress);
249 _SUBTYPE(KC_ST_UINT64, struct user64_dyld_aot_info, aotImageSize);
250 _SUBTYPE_ARRAY(KC_ST_UINT8, struct user64_dyld_aot_info, aotImageKey, DYLD_AOT_IMAGE_KEY_SIZE);
251 setup_type_definition(retval, type_id, i, "dyld_aot_info");
252 break;
253 }
254 case STACKSHOT_KCTYPE_AOTCACHE_LOADINFO: {
255 i = 0;
256 _SUBTYPE(KC_ST_UINT64, struct dyld_aot_cache_uuid_info, x86SlidBaseAddress);
257 _SUBTYPE_ARRAY(KC_ST_UINT8, struct dyld_aot_cache_uuid_info, x86UUID, 16);
258 _SUBTYPE(KC_ST_UINT64, struct dyld_aot_cache_uuid_info, aotSlidBaseAddress);
259 _SUBTYPE_ARRAY(KC_ST_UINT8, struct dyld_aot_cache_uuid_info, aotUUID, 16);
260 setup_type_definition(retval, type_id, i, "dyld_aot_cache_uuid_info");
261 break;
262 }
263 case STACKSHOT_KCTYPE_SHAREDCACHE_AOTINFO: {
264 i = 0;
265 _SUBTYPE(KC_ST_UINT64, struct dyld_aot_cache_uuid_info, x86SlidBaseAddress);
266 _SUBTYPE_ARRAY(KC_ST_UINT8, struct dyld_aot_cache_uuid_info, x86UUID, 16);
267 _SUBTYPE(KC_ST_UINT64, struct dyld_aot_cache_uuid_info, aotSlidBaseAddress);
268 _SUBTYPE_ARRAY(KC_ST_UINT8, struct dyld_aot_cache_uuid_info, aotUUID, 16);
269 setup_type_definition(retval, type_id, i, "dyld_aot_cache_uuid_info");
270 break;
271 }
272
273 /* stackshot specific types */
274 case STACKSHOT_KCTYPE_IOSTATS: {
275 i = 0;
276 _SUBTYPE(KC_ST_UINT64, struct io_stats_snapshot, ss_disk_reads_count);
277 _SUBTYPE(KC_ST_UINT64, struct io_stats_snapshot, ss_disk_reads_size);
278 _SUBTYPE(KC_ST_UINT64, struct io_stats_snapshot, ss_disk_writes_count);
279 _SUBTYPE(KC_ST_UINT64, struct io_stats_snapshot, ss_disk_writes_size);
280 _SUBTYPE_ARRAY(KC_ST_UINT64, struct io_stats_snapshot, ss_io_priority_count, STACKSHOT_IO_NUM_PRIORITIES);
281 _SUBTYPE_ARRAY(KC_ST_UINT64, struct io_stats_snapshot, ss_io_priority_size, STACKSHOT_IO_NUM_PRIORITIES);
282 _SUBTYPE(KC_ST_UINT64, struct io_stats_snapshot, ss_paging_count);
283 _SUBTYPE(KC_ST_UINT64, struct io_stats_snapshot, ss_paging_size);
284 _SUBTYPE(KC_ST_UINT64, struct io_stats_snapshot, ss_non_paging_count);
285 _SUBTYPE(KC_ST_UINT64, struct io_stats_snapshot, ss_non_paging_size);
286 _SUBTYPE(KC_ST_UINT64, struct io_stats_snapshot, ss_data_count);
287 _SUBTYPE(KC_ST_UINT64, struct io_stats_snapshot, ss_data_size);
288 _SUBTYPE(KC_ST_UINT64, struct io_stats_snapshot, ss_metadata_count);
289 _SUBTYPE(KC_ST_UINT64, struct io_stats_snapshot, ss_metadata_size);
290
291 setup_type_definition(retval, type_id, i, "io_statistics");
292 break;
293 }
294
295 case STACKSHOT_KCTYPE_GLOBAL_MEM_STATS: {
296 i = 0;
297 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, snapshot_magic);
298 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, free_pages);
299 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, active_pages);
300 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, inactive_pages);
301 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, purgeable_pages);
302 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, wired_pages);
303 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, speculative_pages);
304 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, throttled_pages);
305 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, filebacked_pages);
306 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, compressions);
307 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, decompressions);
308 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, compressor_size);
309 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, busy_buffer_count);
310 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, pages_wanted);
311 _SUBTYPE(KC_ST_UINT32, struct mem_and_io_snapshot, pages_reclaimed);
312 _SUBTYPE(KC_ST_UINT8, struct mem_and_io_snapshot, pages_wanted_reclaimed_valid);
313 setup_type_definition(retval, type_id, i, "mem_and_io_snapshot");
314 break;
315 }
316
317 case STACKSHOT_KCCONTAINER_SHAREDCACHE:
318 setup_type_definition(retval, type_id, 0, "shared_caches");
319 break;
320
321 case STACKSHOT_KCCONTAINER_TASK:
322 setup_type_definition(retval, type_id, 0, "task_snapshots");
323 break;
324
325 case STACKSHOT_KCCONTAINER_TRANSITIONING_TASK:
326 setup_type_definition(retval, type_id, 0, "transitioning_task_snapshots");
327 break;
328
329 case STACKSHOT_KCCONTAINER_THREAD:
330 setup_type_definition(retval, type_id, 0, "thread_snapshots");
331 break;
332
333 case STACKSHOT_KCCONTAINER_PORTLABEL:
334 setup_type_definition(retval, type_id, 0, "portlabels");
335 break;
336
337 case STACKSHOT_KCTYPE_TASK_SNAPSHOT: {
338 i = 0;
339 _SUBTYPE(KC_ST_UINT64, struct task_snapshot_v2, ts_unique_pid);
340 _SUBTYPE(KC_ST_UINT64, struct task_snapshot_v2, ts_ss_flags);
341 _SUBTYPE_TRUNC(KC_ST_UINT64, struct task_snapshot_v2, ts_user_time_in_terminated_threads, "ts_user_time_in_terminated_thre");
342 _SUBTYPE_TRUNC(KC_ST_UINT64, struct task_snapshot_v2, ts_system_time_in_terminated_threads, "ts_system_time_in_terminated_th");
343 _SUBTYPE(KC_ST_UINT64, struct task_snapshot_v2, ts_p_start_sec);
344 _SUBTYPE(KC_ST_UINT64, struct task_snapshot_v2, ts_task_size);
345 _SUBTYPE(KC_ST_UINT64, struct task_snapshot_v2, ts_max_resident_size);
346 _SUBTYPE(KC_ST_UINT32, struct task_snapshot_v2, ts_suspend_count);
347 _SUBTYPE(KC_ST_UINT32, struct task_snapshot_v2, ts_faults);
348 _SUBTYPE(KC_ST_UINT32, struct task_snapshot_v2, ts_pageins);
349 _SUBTYPE(KC_ST_UINT32, struct task_snapshot_v2, ts_cow_faults);
350 _SUBTYPE(KC_ST_UINT32, struct task_snapshot_v2, ts_was_throttled);
351 _SUBTYPE(KC_ST_UINT32, struct task_snapshot_v2, ts_did_throttle);
352 _SUBTYPE(KC_ST_UINT32, struct task_snapshot_v2, ts_latency_qos);
353 _SUBTYPE(KC_ST_INT32, struct task_snapshot_v2, ts_pid);
354 _SUBTYPE_ARRAY(KC_ST_CHAR, struct task_snapshot_v2, ts_p_comm, 32);
355 setup_type_definition(retval, type_id, i, "task_snapshot");
356 break;
357 }
358
359 case STACKSHOT_KCTYPE_TRANSITIONING_TASK_SNAPSHOT: {
360 i = 0;
361 _SUBTYPE(KC_ST_UINT64, struct transitioning_task_snapshot, tts_unique_pid);
362 _SUBTYPE(KC_ST_UINT64, struct transitioning_task_snapshot, tts_ss_flags);
363 _SUBTYPE(KC_ST_UINT64, struct transitioning_task_snapshot, tts_transition_type);
364 _SUBTYPE(KC_ST_INT32, struct transitioning_task_snapshot, tts_pid);
365 _SUBTYPE_ARRAY(KC_ST_CHAR, struct transitioning_task_snapshot, tts_p_comm, 32);
366 setup_type_definition(retval, type_id, i, "transitioning_task_snapshot");
367 break;
368 }
369
370 case STACKSHOT_KCTYPE_TASK_DELTA_SNAPSHOT: {
371 i = 0;
372 _SUBTYPE(KC_ST_UINT64, struct task_delta_snapshot_v2, tds_unique_pid);
373 _SUBTYPE(KC_ST_UINT64, struct task_delta_snapshot_v2, tds_ss_flags);
374 _SUBTYPE_TRUNC(KC_ST_UINT64, struct task_delta_snapshot_v2, tds_user_time_in_terminated_threads, "tds_user_time_in_terminated_thr");
375 _SUBTYPE_TRUNC(KC_ST_UINT64, struct task_delta_snapshot_v2, tds_system_time_in_terminated_threads, "tds_system_time_in_terminated_t");
376 _SUBTYPE(KC_ST_UINT64, struct task_delta_snapshot_v2, tds_task_size);
377 _SUBTYPE(KC_ST_UINT64, struct task_delta_snapshot_v2, tds_max_resident_size);
378 _SUBTYPE(KC_ST_UINT32, struct task_delta_snapshot_v2, tds_suspend_count);
379 _SUBTYPE(KC_ST_UINT32, struct task_delta_snapshot_v2, tds_faults);
380 _SUBTYPE(KC_ST_UINT32, struct task_delta_snapshot_v2, tds_pageins);
381 _SUBTYPE(KC_ST_UINT32, struct task_delta_snapshot_v2, tds_cow_faults);
382 _SUBTYPE(KC_ST_UINT32, struct task_delta_snapshot_v2, tds_was_throttled);
383 _SUBTYPE(KC_ST_UINT32, struct task_delta_snapshot_v2, tds_did_throttle);
384 _SUBTYPE(KC_ST_UINT32, struct task_delta_snapshot_v2, tds_latency_qos);
385 setup_type_definition(retval, type_id, i, "task_delta_snapshot");
386 break;
387 }
388
389 case STACKSHOT_KCTYPE_THREAD_SNAPSHOT: {
390 i = 0;
391
392 _SUBTYPE(KC_ST_UINT64, struct thread_snapshot_v3, ths_thread_id);
393 _SUBTYPE(KC_ST_UINT64, struct thread_snapshot_v3, ths_wait_event);
394 _SUBTYPE(KC_ST_UINT64, struct thread_snapshot_v3, ths_continuation);
395 _SUBTYPE(KC_ST_UINT64, struct thread_snapshot_v3, ths_total_syscalls);
396 _SUBTYPE(KC_ST_UINT64, struct thread_snapshot_v3, ths_voucher_identifier);
397 _SUBTYPE(KC_ST_UINT64, struct thread_snapshot_v3, ths_dqserialnum);
398 _SUBTYPE(KC_ST_UINT64, struct thread_snapshot_v3, ths_user_time);
399 _SUBTYPE(KC_ST_UINT64, struct thread_snapshot_v3, ths_sys_time);
400 _SUBTYPE(KC_ST_UINT64, struct thread_snapshot_v3, ths_ss_flags);
401 _SUBTYPE(KC_ST_UINT64, struct thread_snapshot_v3, ths_last_run_time);
402 _SUBTYPE(KC_ST_UINT64, struct thread_snapshot_v3, ths_last_made_runnable_time);
403 _SUBTYPE(KC_ST_UINT32, struct thread_snapshot_v3, ths_state);
404 _SUBTYPE(KC_ST_UINT32, struct thread_snapshot_v3, ths_sched_flags);
405 _SUBTYPE(KC_ST_INT16, struct thread_snapshot_v3, ths_base_priority);
406 _SUBTYPE(KC_ST_INT16, struct thread_snapshot_v3, ths_sched_priority);
407 _SUBTYPE(KC_ST_UINT8, struct thread_snapshot_v3, ths_eqos);
408 _SUBTYPE(KC_ST_UINT8, struct thread_snapshot_v3, ths_rqos);
409 _SUBTYPE(KC_ST_UINT8, struct thread_snapshot_v3, ths_rqos_override);
410 _SUBTYPE(KC_ST_UINT8, struct thread_snapshot_v3, ths_io_tier);
411 _SUBTYPE(KC_ST_UINT64, struct thread_snapshot_v3, ths_thread_t);
412 _SUBTYPE(KC_ST_UINT64, struct thread_snapshot_v4, ths_requested_policy);
413 _SUBTYPE(KC_ST_UINT64, struct thread_snapshot_v4, ths_effective_policy);
414
415 setup_type_definition(retval, type_id, i, "thread_snapshot");
416 break;
417 }
418
419 case STACKSHOT_KCTYPE_THREAD_DELTA_SNAPSHOT: {
420 i = 0;
421
422 _SUBTYPE(KC_ST_UINT64, struct thread_delta_snapshot_v2, tds_thread_id);
423 _SUBTYPE(KC_ST_UINT64, struct thread_delta_snapshot_v2, tds_voucher_identifier);
424 _SUBTYPE(KC_ST_UINT64, struct thread_delta_snapshot_v2, tds_ss_flags);
425 _SUBTYPE(KC_ST_UINT64, struct thread_delta_snapshot_v2, tds_last_made_runnable_time);
426 _SUBTYPE(KC_ST_UINT32, struct thread_delta_snapshot_v2, tds_state);
427 _SUBTYPE(KC_ST_UINT32, struct thread_delta_snapshot_v2, tds_sched_flags);
428 _SUBTYPE(KC_ST_INT16, struct thread_delta_snapshot_v2, tds_base_priority);
429 _SUBTYPE(KC_ST_INT16, struct thread_delta_snapshot_v2, tds_sched_priority);
430 _SUBTYPE(KC_ST_UINT8, struct thread_delta_snapshot_v2, tds_eqos);
431 _SUBTYPE(KC_ST_UINT8, struct thread_delta_snapshot_v2, tds_rqos);
432 _SUBTYPE(KC_ST_UINT8, struct thread_delta_snapshot_v2, tds_rqos_override);
433 _SUBTYPE(KC_ST_UINT8, struct thread_delta_snapshot_v2, tds_io_tier);
434 _SUBTYPE(KC_ST_UINT64, struct thread_delta_snapshot_v3, tds_requested_policy);
435 _SUBTYPE(KC_ST_UINT64, struct thread_delta_snapshot_v3, tds_effective_policy);
436
437 setup_type_definition(retval, type_id, i, "thread_delta_snapshot");
438
439 break;
440 }
441
442 case STACKSHOT_KCTYPE_DONATING_PIDS:
443 setup_type_definition(retval, type_id, 1, "donating_pids");
444 setup_subtype_description(&subtypes[0], KC_ST_INT32, 0, "donating_pids");
445 break;
446
447 case STACKSHOT_KCTYPE_THREAD_NAME: {
448 i = 0;
449 setup_subtype_array_description(&subtypes[i++], KC_ST_CHAR, 0, 64, "pth_name");
450 setup_type_definition(retval, type_id, i, "pth_name");
451 break;
452 }
453
454 case STACKSHOT_KCTYPE_KERN_STACKFRAME:
455 setup_type_definition(retval, type_id, 2, "kernel_stack_frames");
456 setup_subtype_description(&subtypes[0], KC_ST_UINT32, 0, "lr");
457 setup_subtype_description(&subtypes[1], KC_ST_UINT32, sizeof(uint32_t), "sp");
458 break;
459
460 case STACKSHOT_KCTYPE_KERN_STACKFRAME64:
461 setup_type_definition(retval, type_id, 2, "kernel_stack_frames");
462 setup_subtype_description(&subtypes[0], KC_ST_UINT64, 0, "lr");
463 setup_subtype_description(&subtypes[1], KC_ST_UINT64, sizeof(uint64_t), "sp");
464 break;
465
466 case STACKSHOT_KCTYPE_USER_STACKFRAME:
467 setup_type_definition(retval, type_id, 2, "user_stack_frames");
468 setup_subtype_description(&subtypes[0], KC_ST_UINT32, 0, "lr");
469 setup_subtype_description(&subtypes[1], KC_ST_UINT32, sizeof(uint32_t), "sp");
470 break;
471
472 case STACKSHOT_KCTYPE_USER_STACKFRAME64:
473 setup_type_definition(retval, type_id, 2, "user_stack_frames");
474 setup_subtype_description(&subtypes[0], KC_ST_UINT64, 0, "lr");
475 setup_subtype_description(&subtypes[1], KC_ST_UINT64, sizeof(uint64_t), "sp");
476 break;
477
478 case STACKSHOT_KCTYPE_KERN_STACKLR:
479 setup_type_definition(retval, type_id, 1, "kernel_stack_frames");
480 setup_subtype_description(&subtypes[0], KC_ST_UINT32, 0, "lr");
481 subtypes[0].kcs_flags |= KCS_SUBTYPE_FLAGS_STRUCT;
482 break;
483
484 case STACKSHOT_KCTYPE_KERN_STACKLR64:
485 setup_type_definition(retval, type_id, 1, "kernel_stack_frames");
486 setup_subtype_description(&subtypes[0], KC_ST_UINT64, 0, "lr");
487 subtypes[0].kcs_flags |= KCS_SUBTYPE_FLAGS_STRUCT;
488 break;
489
490 case STACKSHOT_KCTYPE_USER_STACKLR:
491 setup_type_definition(retval, type_id, 1, "user_stack_frames");
492 setup_subtype_description(&subtypes[0], KC_ST_UINT32, 0, "lr");
493 subtypes[0].kcs_flags |= KCS_SUBTYPE_FLAGS_STRUCT;
494 break;
495
496 case STACKSHOT_KCTYPE_USER_STACKLR64:
497 setup_type_definition(retval, type_id, 1, "user_stack_frames");
498 setup_subtype_description(&subtypes[0], KC_ST_UINT64, 0, "lr");
499 subtypes[0].kcs_flags |= KCS_SUBTYPE_FLAGS_STRUCT;
500 break;
501
502 case STACKSHOT_KCTYPE_USER_ASYNC_START_INDEX:
503 setup_type_definition(retval, type_id, 1, "user_async_start_index");
504 setup_subtype_description(&subtypes[0], KC_ST_UINT32, 0, "user_async_start_index");
505 break;
506
507 case STACKSHOT_KCTYPE_USER_ASYNC_STACKLR64:
508 setup_type_definition(retval, type_id, 1, "user_async_stack_frames");
509 setup_subtype_description(&subtypes[0], KC_ST_UINT64, 0, "lr");
510 subtypes[0].kcs_flags |= KCS_SUBTYPE_FLAGS_STRUCT;
511 break;
512
513 case STACKSHOT_KCTYPE_NONRUNNABLE_TIDS:
514 setup_type_definition(retval, type_id, 1, "nonrunnable_threads");
515 setup_subtype_description(&subtypes[0], KC_ST_INT64, 0, "nonrunnable_threads");
516 break;
517
518 case STACKSHOT_KCTYPE_NONRUNNABLE_TASKS:
519 setup_type_definition(retval, type_id, 1, "nonrunnable_tasks");
520 setup_subtype_description(&subtypes[0], KC_ST_INT64, 0, "nonrunnable_tasks");
521 break;
522
523 case STACKSHOT_KCTYPE_SHAREDCACHE_ID:
524 setup_type_definition(retval, type_id, 1, "sharedCacheID");
525 setup_subtype_description(&subtypes[0], KC_ST_INT32, 0, "sharedCacheID");
526 break;
527
528 case STACKSHOT_KCTYPE_CODESIGNING_INFO:
529 i = 0;
530 _SUBTYPE(KC_ST_UINT64, struct stackshot_task_codesigning_info, csflags);
531 _SUBTYPE(KC_ST_UINT32, struct stackshot_task_codesigning_info, cs_trust_level);
532 setup_type_definition(retval, type_id, i, "stackshot_task_codesigning_info");
533 break;
534
535 case STACKSHOT_KCTYPE_BOOTARGS: {
536 i = 0;
537 _STRINGTYPE("boot_args");
538 setup_type_definition(retval, type_id, i, "boot_args");
539 break;
540 }
541
542 case STACKSHOT_KCTYPE_OSVERSION: {
543 i = 0;
544 _STRINGTYPE("osversion");
545 setup_type_definition(retval, type_id, i, "osversion");
546 break;
547 }
548
549 case STACKSHOT_KCTYPE_KERN_PAGE_SIZE: {
550 i = 0;
551 setup_subtype_description(&subtypes[i++], KC_ST_UINT32, 0, "kernel_page_size");
552 setup_type_definition(retval, type_id, i, "kernel_page_size");
553 break;
554 }
555
556 case STACKSHOT_KCTYPE_THREAD_POLICY_VERSION: {
557 i = 0;
558 setup_subtype_description(&subtypes[i++], KC_ST_UINT32, 0, "thread_policy_version");
559 setup_type_definition(retval, type_id, i, "thread_policy_version");
560 break;
561 }
562
563 case STACKSHOT_KCTYPE_JETSAM_LEVEL: {
564 i = 0;
565 setup_subtype_description(&subtypes[i++], KC_ST_UINT32, 0, "jetsam_level");
566 setup_type_definition(retval, type_id, i, "jetsam_level");
567 break;
568 }
569
570 case STACKSHOT_KCTYPE_DELTA_SINCE_TIMESTAMP: {
571 i = 0;
572 setup_subtype_description(&subtypes[i++], KC_ST_UINT64, 0, "stackshot_delta_since_timestamp");
573 setup_type_definition(retval, type_id, i, "stackshot_delta_since_timestamp");
574 break;
575 }
576
577 /* crashinfo types */
578 case TASK_CRASHINFO_BSDINFOWITHUNIQID: {
579 i = 0;
580 _SUBTYPE_ARRAY(KC_ST_UINT8, struct crashinfo_proc_uniqidentifierinfo, p_uuid, 16);
581 _SUBTYPE(KC_ST_UINT64, struct crashinfo_proc_uniqidentifierinfo, p_uniqueid);
582 _SUBTYPE(KC_ST_UINT64, struct crashinfo_proc_uniqidentifierinfo, p_puniqueid);
583 /* Ignore the p_reserve fields */
584 setup_type_definition(retval, type_id, i, "proc_uniqidentifierinfo");
585 break;
586 }
587
588 case TASK_CRASHINFO_PID: {
589 setup_subtype_description(&subtypes[0], KC_ST_INT32, 0, "pid");
590 setup_type_definition(retval, type_id, 1, "pid");
591 break;
592 }
593
594 case TASK_CRASHINFO_PPID: {
595 setup_subtype_description(&subtypes[0], KC_ST_INT32, 0, "ppid");
596 setup_type_definition(retval, type_id, 1, "ppid");
597 break;
598 }
599
600 /* case TASK_CRASHINFO_RUSAGE: { */
601 /* /\* */
602 /* * rusage is a complex structure and is only for legacy use for crashed processes rusage info. */
603 /* * So we just consider it as opaque data. */
604 /* *\/ */
605 /* i = 0; */
606 /* setup_subtype_array_description(&subtypes[i++], KC_ST_UINT8, 0, sizeof(struct rusage), "rusage"); */
607 /* setup_type_definition(retval, type_id, i, "rusage"); */
608 /* break; */
609 /* } */
610
611 case TASK_CRASHINFO_RUSAGE_INFO: {
612 i = 0;
613 _SUBTYPE_ARRAY(KC_ST_UINT8, struct rusage_info_v3, ri_uuid, 16);
614 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_user_time);
615 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_system_time);
616 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_pkg_idle_wkups);
617 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_interrupt_wkups);
618 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_pageins);
619 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_wired_size);
620 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_resident_size);
621 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_phys_footprint);
622 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_proc_start_abstime);
623 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_proc_exit_abstime);
624 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_child_user_time);
625 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_child_system_time);
626 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_child_pkg_idle_wkups);
627 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_child_interrupt_wkups);
628 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_child_pageins);
629 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_child_elapsed_abstime);
630 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_diskio_bytesread);
631 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_diskio_byteswritten);
632 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_cpu_time_qos_default);
633 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_cpu_time_qos_maintenance);
634 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_cpu_time_qos_background);
635 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_cpu_time_qos_utility);
636 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_cpu_time_qos_legacy);
637 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_cpu_time_qos_user_initiated);
638 _SUBTYPE_TRUNC(KC_ST_UINT64, struct rusage_info_v3, ri_cpu_time_qos_user_interactive, "ri_cpu_time_qos_user_interactiv");
639 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_billed_system_time);
640 _SUBTYPE(KC_ST_UINT64, struct rusage_info_v3, ri_serviced_system_time);
641 setup_type_definition(retval, type_id, i, "rusage_info");
642 break;
643 }
644
645 case STACKSHOT_KCTYPE_CPU_TIMES: {
646 i = 0;
647 _SUBTYPE(KC_ST_UINT64, struct stackshot_cpu_times_v2, user_usec);
648 _SUBTYPE(KC_ST_UINT64, struct stackshot_cpu_times_v2, system_usec);
649 _SUBTYPE(KC_ST_UINT64, struct stackshot_cpu_times_v2, runnable_usec);
650 setup_type_definition(retval, type_id, i, "cpu_times");
651 break;
652 }
653
654 case STACKSHOT_KCTYPE_STACKSHOT_DURATION: {
655 i = 0;
656 _SUBTYPE(KC_ST_UINT64, struct stackshot_duration_v2, stackshot_duration);
657 _SUBTYPE(KC_ST_UINT64, struct stackshot_duration_v2, stackshot_duration_outer);
658 _SUBTYPE(KC_ST_UINT64, struct stackshot_duration_v2, stackshot_duration_prior);
659 subtypes[0].kcs_flags |= KCS_SUBTYPE_FLAGS_MERGE;
660 subtypes[1].kcs_flags |= KCS_SUBTYPE_FLAGS_MERGE;
661 subtypes[2].kcs_flags |= KCS_SUBTYPE_FLAGS_MERGE;
662 setup_type_definition(retval, type_id, i, "stackshot_duration");
663 break;
664 }
665
666 case STACKSHOT_KCTYPE_STACKSHOT_FAULT_STATS: {
667 i = 0;
668 _SUBTYPE(KC_ST_UINT32, struct stackshot_fault_stats, sfs_pages_faulted_in);
669 _SUBTYPE(KC_ST_UINT64, struct stackshot_fault_stats, sfs_time_spent_faulting);
670 _SUBTYPE(KC_ST_UINT64, struct stackshot_fault_stats, sfs_system_max_fault_time);
671 _SUBTYPE(KC_ST_UINT8, struct stackshot_fault_stats, sfs_stopped_faulting);
672
673 setup_type_definition(retval, type_id, i, "stackshot_fault_stats");
674 break;
675 }
676
677 case STACKSHOT_KCTYPE_THREAD_WAITINFO: {
678 i = 0;
679 _SUBTYPE(KC_ST_UINT64, struct stackshot_thread_waitinfo_v2, owner);
680 _SUBTYPE(KC_ST_UINT64, struct stackshot_thread_waitinfo_v2, waiter);
681 _SUBTYPE(KC_ST_UINT64, struct stackshot_thread_waitinfo_v2, context);
682 _SUBTYPE(KC_ST_UINT8, struct stackshot_thread_waitinfo_v2, wait_type);
683 _SUBTYPE(KC_ST_INT16, struct stackshot_thread_waitinfo_v2, portlabel_id);
684 _SUBTYPE(KC_ST_UINT32, struct stackshot_thread_waitinfo_v2, wait_flags);
685 setup_type_definition(retval, type_id, i, "thread_waitinfo");
686 break;
687 }
688
689 case STACKSHOT_KCTYPE_THREAD_GROUP_SNAPSHOT: {
690 i = 0;
691 _SUBTYPE(KC_ST_UINT64, struct thread_group_snapshot_v3, tgs_id);
692 _SUBTYPE_ARRAY(KC_ST_CHAR, struct thread_group_snapshot_v3, tgs_name, 16);
693 _SUBTYPE(KC_ST_UINT64, struct thread_group_snapshot_v3, tgs_flags);
694 _SUBTYPE_ARRAY(KC_ST_CHAR, struct thread_group_snapshot_v3, tgs_name_cont, 16);
695 setup_type_definition(retval, type_id, i, "thread_group_snapshot");
696 break;
697 }
698
699 case STACKSHOT_KCTYPE_THREAD_GROUP: {
700 i = 0;
701 setup_subtype_description(&subtypes[i++], KC_ST_UINT64, 0, "thread_group");
702 setup_type_definition(retval, type_id, i, "thread_group");
703 break;
704 };
705
706 case STACKSHOT_KCTYPE_JETSAM_COALITION_SNAPSHOT: {
707 i = 0;
708 _SUBTYPE(KC_ST_UINT64, struct jetsam_coalition_snapshot, jcs_id);
709 _SUBTYPE(KC_ST_UINT64, struct jetsam_coalition_snapshot, jcs_flags);
710 _SUBTYPE(KC_ST_UINT64, struct jetsam_coalition_snapshot, jcs_thread_group);
711 _SUBTYPE(KC_ST_UINT64, struct jetsam_coalition_snapshot, jcs_leader_task_uniqueid);
712 setup_type_definition(retval, type_id, i, "jetsam_coalition_snapshot");
713 break;
714 }
715
716 case STACKSHOT_KCTYPE_JETSAM_COALITION: {
717 i = 0;
718 setup_subtype_description(&subtypes[i++], KC_ST_UINT64, 0, "jetsam_coalition");
719 setup_type_definition(retval, type_id, i, "jetsam_coalition");
720 break;
721 };
722
723 case STACKSHOT_KCTYPE_INSTRS_CYCLES: {
724 i = 0;
725 _SUBTYPE(KC_ST_UINT64, struct instrs_cycles_snapshot_v2, ics_instructions);
726 _SUBTYPE(KC_ST_UINT64, struct instrs_cycles_snapshot_v2, ics_cycles);
727 _SUBTYPE(KC_ST_UINT64, struct instrs_cycles_snapshot_v2, ics_p_instructions);
728 _SUBTYPE(KC_ST_UINT64, struct instrs_cycles_snapshot_v2, ics_p_cycles);
729 setup_type_definition(retval, type_id, i, "instrs_cycles_snapshot");
730 break;
731 }
732
733 case STACKSHOT_KCTYPE_USER_STACKTOP: {
734 i = 0;
735 _SUBTYPE(KC_ST_UINT64, struct stack_snapshot_stacktop, sp);
736 _SUBTYPE_ARRAY(KC_ST_UINT8, struct stack_snapshot_stacktop, stack_contents, 8);
737 setup_type_definition(retval, type_id, i, "user_stacktop");
738 break;
739 }
740
741 case TASK_CRASHINFO_PROC_STARTTIME: {
742 i = 0;
743 _SUBTYPE(KC_ST_INT64, struct timeval64, tv_sec);
744 _SUBTYPE(KC_ST_INT64, struct timeval64, tv_usec);
745 setup_type_definition(retval, type_id, i, "proc_starttime");
746 break;
747 }
748
749 case TASK_CRASHINFO_EXCEPTION_CODES: {
750 i = 0;
751 char codenum[100];
752 for (i = 0; i < EXCEPTION_CODE_MAX; i++) {
753 snprintf(codenum, sizeof(codenum), "code_%d", i);
754 setup_subtype_description(&subtypes[i], KC_ST_UINT64, i * (sizeof(uint64_t)), codenum);
755 }
756 setup_type_definition(retval, type_id, i, "mach_exception_data_t");
757 break;
758 }
759
760 case TASK_CRASHINFO_PROC_NAME: {
761 i = 0;
762 _STRINGTYPE("p_comm");
763 setup_type_definition(retval, type_id, i, "p_comm");
764 break;
765 }
766
767 case TASK_CRASHINFO_USERSTACK: {
768 i = 0;
769 setup_subtype_description(&subtypes[0], KC_ST_UINT64, 0, "userstack_ptr");
770 setup_type_definition(retval, type_id, 1, "userstack_ptr");
771 break;
772 }
773
774 case TASK_CRASHINFO_ARGSLEN: {
775 i = 0;
776 setup_subtype_description(&subtypes[0], KC_ST_INT32, 0, "p_argslen");
777 setup_type_definition(retval, type_id, 1, "p_argslen");
778 break;
779 }
780
781 case TASK_CRASHINFO_PROC_PATH: {
782 i = 0;
783 _STRINGTYPE("p_path");
784 setup_type_definition(retval, type_id, i, "p_path");
785 break;
786 }
787
788 case TASK_CRASHINFO_PROC_CSFLAGS: {
789 setup_subtype_description(&subtypes[0], KC_ST_UINT32, 0, "p_csflags");
790 setup_type_definition(retval, type_id, 1, "p_csflags");
791 break;
792 }
793
794 case TASK_CRASHINFO_PROC_STATUS: {
795 setup_subtype_description(&subtypes[0], KC_ST_UINT8, 0, "p_status");
796 setup_type_definition(retval, type_id, 1, "p_status");
797 break;
798 }
799
800 case TASK_CRASHINFO_UID: {
801 setup_subtype_description(&subtypes[0], KC_ST_INT32, 0, "uid");
802 setup_type_definition(retval, type_id, 1, "uid");
803 break;
804 }
805
806 case TASK_CRASHINFO_GID: {
807 setup_subtype_description(&subtypes[0], KC_ST_INT32, 0, "gid");
808 setup_type_definition(retval, type_id, 1, "gid");
809 break;
810 }
811
812 case TASK_CRASHINFO_PROC_ARGC: {
813 setup_subtype_description(&subtypes[0], KC_ST_INT32, 0, "argc");
814 setup_type_definition(retval, type_id, 1, "argc");
815 break;
816 }
817
818 case TASK_CRASHINFO_PROC_FLAGS: {
819 setup_subtype_description(&subtypes[0], KC_ST_UINT32, 0, "p_flags");
820 setup_type_definition(retval, type_id, 1, "p_flags");
821 break;
822 }
823
824 case TASK_CRASHINFO_CPUTYPE: {
825 setup_subtype_description(&subtypes[0], KC_ST_INT32, 0, "cputype");
826 setup_type_definition(retval, type_id, 1, "cputype");
827 break;
828 }
829
830 case TASK_CRASHINFO_RESPONSIBLE_PID: {
831 setup_subtype_description(&subtypes[0], KC_ST_INT32, 0, "responsible_pid");
832 setup_type_definition(retval, type_id, 1, "responsible_pid");
833 break;
834 }
835
836 case TASK_CRASHINFO_DIRTY_FLAGS: {
837 setup_subtype_description(&subtypes[0], KC_ST_UINT32, 0, "dirty_flags");
838 setup_type_definition(retval, type_id, 1, "dirty_flags");
839 break;
840 }
841
842 case TASK_CRASHINFO_CRASHED_THREADID: {
843 setup_subtype_description(&subtypes[0], KC_ST_UINT64, 0, "crashed_threadid");
844 setup_type_definition(retval, type_id, 1, "crashed_threadid");
845 break;
846 }
847
848 case TASK_CRASHINFO_COALITION_ID: {
849 setup_subtype_description(&subtypes[0], KC_ST_UINT64, 0, "coalition_id");
850 setup_type_definition(retval, type_id, 1, "coalition_id");
851 break;
852 }
853
854 case TASK_CRASHINFO_UDATA_PTRS: {
855 setup_subtype_description(&subtypes[0], KC_ST_UINT64, 0, "udata_ptrs");
856 setup_type_definition(retval, type_id, 1, "udata_ptrs");
857 break;
858 }
859
860 case TASK_CRASHINFO_MEMORY_LIMIT: {
861 setup_subtype_description(&subtypes[0], KC_ST_UINT64, 0, "task_phys_mem_limit");
862 setup_type_definition(retval, type_id, 1, "task_phys_mem_limit");
863 break;
864 }
865
866 case TASK_CRASHINFO_TASK_IS_CORPSE_FORK: {
867 setup_subtype_description(&subtypes[0], KC_ST_UINT32, 0, "task_is_corpse_fork");
868 setup_type_definition(retval, type_id, 1, "task_is_corpse_fork");
869 break;
870 }
871
872 case TASK_CRASHINFO_EXCEPTION_TYPE: {
873 setup_subtype_description(&subtypes[0], KC_ST_UINT32, 0, "exception_type");
874 setup_type_definition(retval, type_id, 1, "exception_type");
875 break;
876 }
877
878 case TASK_CRASHINFO_CS_SIGNING_ID: {
879 i = 0;
880 _STRINGTYPE("cs_signing_id");
881 setup_type_definition(retval, type_id, i, "cs_signing_id");
882 break;
883 }
884
885 case TASK_CRASHINFO_CS_TEAM_ID: {
886 i = 0;
887 _STRINGTYPE("cs_team_id");
888 setup_type_definition(retval, type_id, i, "cs_team_id");
889 break;
890 }
891
892 case TASK_CRASHINFO_CS_VALIDATION_CATEGORY: {
893 setup_subtype_description(&subtypes[0], KC_ST_UINT32, 0, "cs_validation_category");
894 setup_type_definition(retval, type_id, 1, "cs_validation_category");
895 break;
896 }
897 case TASK_CRASHINFO_CS_TRUST_LEVEL: {
898 setup_subtype_description(&subtypes[0], KC_ST_UINT32, 0, "cs_trust_level");
899 setup_type_definition(retval, type_id, 1, "cs_trust_level");
900 break;
901 }
902
903 case EXIT_REASON_SNAPSHOT: {
904 _SUBTYPE(KC_ST_UINT32, struct exit_reason_snapshot, ers_namespace);
905 _SUBTYPE(KC_ST_UINT64, struct exit_reason_snapshot, ers_code);
906 _SUBTYPE(KC_ST_UINT64, struct exit_reason_snapshot, ers_flags);
907 setup_type_definition(retval, type_id, i, "exit_reason_basic_info");
908
909 break;
910 }
911
912 case EXIT_REASON_USER_DESC: {
913 i = 0;
914
915 _STRINGTYPE("exit_reason_user_description");
916 setup_type_definition(retval, type_id, i, "exit_reason_user_description");
917 break;
918 }
919
920 case EXIT_REASON_USER_PAYLOAD: {
921 i = 0;
922
923 setup_subtype_array_description(&subtypes[i++], KC_ST_UINT8, 0, EXIT_REASON_PAYLOAD_MAX_LEN, "exit_reason_user_payload");
924 setup_type_definition(retval, type_id, i, "exit_reason_user_payload");
925 break;
926 }
927
928 case EXIT_REASON_CODESIGNING_INFO: {
929 _SUBTYPE(KC_ST_UINT64, struct codesigning_exit_reason_info, ceri_virt_addr);
930 _SUBTYPE(KC_ST_UINT64, struct codesigning_exit_reason_info, ceri_file_offset);
931 _SUBTYPE_ARRAY(KC_ST_CHAR, struct codesigning_exit_reason_info, ceri_pathname, EXIT_REASON_CODESIG_PATH_MAX);
932 _SUBTYPE_ARRAY(KC_ST_CHAR, struct codesigning_exit_reason_info, ceri_filename, EXIT_REASON_CODESIG_PATH_MAX);
933 _SUBTYPE(KC_ST_UINT64, struct codesigning_exit_reason_info, ceri_codesig_modtime_secs);
934 _SUBTYPE(KC_ST_UINT64, struct codesigning_exit_reason_info, ceri_codesig_modtime_nsecs);
935 _SUBTYPE(KC_ST_UINT64, struct codesigning_exit_reason_info, ceri_page_modtime_secs);
936 _SUBTYPE(KC_ST_UINT64, struct codesigning_exit_reason_info, ceri_page_modtime_nsecs);
937 _SUBTYPE(KC_ST_UINT8, struct codesigning_exit_reason_info, ceri_path_truncated);
938 _SUBTYPE(KC_ST_UINT8, struct codesigning_exit_reason_info, ceri_object_codesigned);
939 _SUBTYPE(KC_ST_UINT8, struct codesigning_exit_reason_info, ceri_page_codesig_validated);
940 _SUBTYPE(KC_ST_UINT8, struct codesigning_exit_reason_info, ceri_page_codesig_tainted);
941 _SUBTYPE(KC_ST_UINT8, struct codesigning_exit_reason_info, ceri_page_codesig_nx);
942 _SUBTYPE(KC_ST_UINT8, struct codesigning_exit_reason_info, ceri_page_wpmapped);
943 _SUBTYPE(KC_ST_UINT8, struct codesigning_exit_reason_info, ceri_page_slid);
944 _SUBTYPE(KC_ST_UINT8, struct codesigning_exit_reason_info, ceri_page_dirty);
945 _SUBTYPE(KC_ST_UINT32, struct codesigning_exit_reason_info, ceri_page_shadow_depth);
946 setup_type_definition(retval, type_id, i, "exit_reason_codesigning_info");
947 break;
948 }
949
950 case EXIT_REASON_WORKLOOP_ID: {
951 i = 0;
952 setup_subtype_description(&subtypes[i++], KC_ST_UINT64, 0, "exit_reason_workloop_id");
953 setup_type_definition(retval, type_id, i, "exit_reason_workloop_id");
954 break;
955 }
956
957 case EXIT_REASON_DISPATCH_QUEUE_NO: {
958 i = 0;
959 setup_subtype_description(&subtypes[i++], KC_ST_UINT64, 0, "exit_reason_dispatch_queue_no");
960 setup_type_definition(retval, type_id, i, "exit_reason_dispatch_queue_no");
961 break;
962 }
963
964 case STACKSHOT_KCTYPE_ASID: {
965 i = 0;
966 setup_subtype_description(&subtypes[i++], KC_ST_UINT32, 0, "ts_asid");
967 setup_type_definition(retval, type_id, i, "ts_asid");
968 break;
969 }
970
971 case STACKSHOT_KCTYPE_PAGE_TABLES: {
972 i = 0;
973 setup_subtype_description(&subtypes[i++], KC_ST_UINT64, 0, "ts_pagetable");
974 setup_type_definition(retval, type_id, i, "ts_pagetable");
975 break;
976 }
977
978 case STACKSHOT_KCTYPE_SYS_SHAREDCACHE_LAYOUT: {
979 i = 0;
980 _SUBTYPE(KC_ST_UINT64, struct user64_dyld_uuid_info, imageLoadAddress);
981 _SUBTYPE_ARRAY(KC_ST_UINT8, struct user64_dyld_uuid_info, imageUUID, 16);
982 setup_type_definition(retval, type_id, i, "system_shared_cache_layout");
983 break;
984 }
985
986 case STACKSHOT_KCTYPE_THREAD_DISPATCH_QUEUE_LABEL: {
987 i = 0;
988 _STRINGTYPE("dispatch_queue_label");
989 setup_type_definition(retval, type_id, i, "dispatch_queue_label");
990 break;
991 }
992
993 case STACKSHOT_KCTYPE_THREAD_TURNSTILEINFO: {
994 i = 0;
995 _SUBTYPE(KC_ST_UINT64, struct stackshot_thread_turnstileinfo_v2, waiter);
996 _SUBTYPE(KC_ST_UINT64, struct stackshot_thread_turnstileinfo_v2, turnstile_context);
997 _SUBTYPE(KC_ST_UINT8, struct stackshot_thread_turnstileinfo_v2, turnstile_priority);
998 _SUBTYPE(KC_ST_UINT8, struct stackshot_thread_turnstileinfo_v2, number_of_hops);
999 _SUBTYPE(KC_ST_UINT64, struct stackshot_thread_turnstileinfo_v2, turnstile_flags);
1000 _SUBTYPE(KC_ST_INT16, struct stackshot_thread_turnstileinfo_v2, portlabel_id);
1001 setup_type_definition(retval, type_id, i, "thread_turnstileinfo");
1002 break;
1003 }
1004
1005 case STACKSHOT_KCTYPE_PORTLABEL: {
1006 i = 0;
1007 _SUBTYPE(KC_ST_INT16, struct portlabel_info, portlabel_id);
1008 _SUBTYPE(KC_ST_UINT16, struct portlabel_info, portlabel_flags);
1009 _SUBTYPE(KC_ST_INT8, struct portlabel_info, portlabel_domain);
1010 subtypes[0].kcs_flags |= KCS_SUBTYPE_FLAGS_MERGE;
1011 subtypes[1].kcs_flags |= KCS_SUBTYPE_FLAGS_MERGE;
1012 subtypes[2].kcs_flags |= KCS_SUBTYPE_FLAGS_MERGE;
1013 setup_type_definition(retval, type_id, i, "portlabel_info");
1014 break;
1015 }
1016
1017 case STACKSHOT_KCTYPE_PORTLABEL_NAME:
1018 i = 0;
1019 _STRINGTYPE("portlabel_name");
1020 setup_type_definition(retval, type_id, i, "portlabel_name");
1021 break;
1022
1023 case STACKSHOT_KCTYPE_TASK_CPU_ARCHITECTURE: {
1024 i = 0;
1025 _SUBTYPE(KC_ST_INT32, struct stackshot_cpu_architecture, cputype);
1026 _SUBTYPE(KC_ST_INT32, struct stackshot_cpu_architecture, cpusubtype);
1027 setup_type_definition(retval, type_id, i, "task_cpu_architecture");
1028 break;
1029 }
1030
1031 case STACKSHOT_KCTYPE_LATENCY_INFO: {
1032 i = 0;
1033 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_collection, latency_version);
1034 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_collection, setup_latency);
1035 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_collection, total_task_iteration_latency);
1036 _SUBTYPE_TRUNC(KC_ST_UINT64, struct stackshot_latency_collection, total_terminated_task_iteration_latency, "total_terminated_task_iteration");
1037 setup_type_definition(retval, type_id, i, "stackshot_latency_collection");
1038 break;
1039 }
1040 case STACKSHOT_KCTYPE_LATENCY_INFO_TASK: {
1041 i = 0;
1042 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_task, task_uniqueid);
1043 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_task, setup_latency);
1044 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_task, task_thread_count_loop_latency);
1045 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_task, task_thread_data_loop_latency);
1046 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_task, cur_tsnap_latency);
1047 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_task, pmap_latency);
1048 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_task, bsd_proc_ids_latency);
1049 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_task, misc_latency);
1050 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_task, misc2_latency);
1051 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_task, end_latency);
1052 setup_type_definition(retval, type_id, i, "stackshot_latency_task");
1053 break;
1054 }
1055 case STACKSHOT_KCTYPE_LATENCY_INFO_THREAD: {
1056 i = 0;
1057 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_thread, thread_id);
1058 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_thread, cur_thsnap1_latency);
1059 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_thread, dispatch_serial_latency);
1060 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_thread, dispatch_label_latency);
1061 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_thread, cur_thsnap2_latency);
1062 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_thread, thread_name_latency);
1063 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_thread, sur_times_latency);
1064 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_thread, user_stack_latency);
1065 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_thread, kernel_stack_latency);
1066 _SUBTYPE(KC_ST_UINT64, struct stackshot_latency_thread, misc_latency);
1067 setup_type_definition(retval, type_id, i, "stackshot_latency_thread");
1068 break;
1069 }
1070
1071 case TASK_CRASHINFO_KERNEL_TRIAGE_INFO_V1: {
1072 i = 0;
1073 _SUBTYPE_ARRAY(KC_ST_CHAR, struct kernel_triage_info_v1, triage_string1, MAX_TRIAGE_STRING_LEN);
1074 _SUBTYPE_ARRAY(KC_ST_CHAR, struct kernel_triage_info_v1, triage_string2, MAX_TRIAGE_STRING_LEN);
1075 _SUBTYPE_ARRAY(KC_ST_CHAR, struct kernel_triage_info_v1, triage_string3, MAX_TRIAGE_STRING_LEN);
1076 _SUBTYPE_ARRAY(KC_ST_CHAR, struct kernel_triage_info_v1, triage_string4, MAX_TRIAGE_STRING_LEN);
1077 _SUBTYPE_ARRAY(KC_ST_CHAR, struct kernel_triage_info_v1, triage_string5, MAX_TRIAGE_STRING_LEN);
1078 setup_type_definition(retval, type_id, i, "kernel_triage_info_v1");
1079 break;
1080 }
1081
1082 default:
1083 retval = NULL;
1084 break;
1085 }
1086
1087 assert(retval == NULL || (buffer_size > sizeof(struct kcdata_type_definition) +
1088 (retval->kct_num_elements * sizeof(struct kcdata_subtype_descriptor))));
1089 return retval;
1090 }
1091
1092 static void
setup_type_definition(struct kcdata_type_definition * d,uint32_t type,uint32_t num_elems,char * name)1093 setup_type_definition(struct kcdata_type_definition * d, uint32_t type, uint32_t num_elems, char * name)
1094 {
1095 d->kct_type_identifier = type;
1096 d->kct_num_elements = num_elems;
1097 memcpy(d->kct_name, name, sizeof(d->kct_name));
1098 d->kct_name[sizeof(d->kct_name) - 1] = '\0';
1099 }
1100
1101 static uint32_t
get_kctype_subtype_size(kctype_subtype_t type)1102 get_kctype_subtype_size(kctype_subtype_t type)
1103 {
1104 switch (type) {
1105 case KC_ST_CHAR:
1106 case KC_ST_INT8:
1107 case KC_ST_UINT8:
1108 return sizeof(uint8_t);
1109 break;
1110 case KC_ST_INT16:
1111 case KC_ST_UINT16:
1112 return sizeof(uint16_t);
1113 break;
1114 case KC_ST_INT32:
1115 case KC_ST_UINT32:
1116 return sizeof(uint32_t);
1117 break;
1118 case KC_ST_INT64:
1119 case KC_ST_UINT64:
1120 return sizeof(uint64_t);
1121 break;
1122
1123 default:
1124 assert(0);
1125 break;
1126 }
1127 return 0;
1128 }
1129
1130 static void
setup_subtype_array_description(kcdata_subtype_descriptor_t desc,kctype_subtype_t type,uint32_t offset,uint32_t count,char * name)1131 setup_subtype_array_description(
1132 kcdata_subtype_descriptor_t desc, kctype_subtype_t type, uint32_t offset, uint32_t count, char * name)
1133 {
1134 desc->kcs_flags = KCS_SUBTYPE_FLAGS_ARRAY;
1135 desc->kcs_elem_type = type;
1136 desc->kcs_elem_offset = offset;
1137 desc->kcs_elem_size = KCS_SUBTYPE_PACK_SIZE(count, get_kctype_subtype_size(type));
1138 memcpy(desc->kcs_name, name, sizeof(desc->kcs_name));
1139 desc->kcs_name[sizeof(desc->kcs_name) - 1] = '\0';
1140 }
1141
1142 static void
setup_subtype_description(kcdata_subtype_descriptor_t desc,kctype_subtype_t type,uint32_t offset,char * name)1143 setup_subtype_description(kcdata_subtype_descriptor_t desc, kctype_subtype_t type, uint32_t offset, char * name)
1144 {
1145 desc->kcs_flags = KCS_SUBTYPE_FLAGS_NONE;
1146 desc->kcs_elem_type = type;
1147 desc->kcs_elem_offset = offset;
1148 desc->kcs_elem_size = get_kctype_subtype_size(type);
1149 memcpy(desc->kcs_name, name, sizeof(desc->kcs_name));
1150 desc->kcs_name[sizeof(desc->kcs_name) - 1] = '\0';
1151 }
1152