2 * Copyright (c) 2015 Apple Inc. All rights reserved.
4 * @APPLE_LICENSE_HEADER_START@
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
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.
21 * @APPLE_LICENSE_HEADER_END@
31 #include <mach/mach_time.h>
32 #include <sys/proc_info.h>
35 * @function kcdata_get_typedescription
38 * Search the known type definitions for type with id type_id.
41 * A unsinged int type specified by the KCDATA.
44 * pointer to data area where type definition will be saved.
47 * size of the buffer provided.
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.
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.
61 struct kcdata_type_definition
* kcdata_get_typedescription(unsigned type_id
, uint8_t * buffer
, uint32_t buffer_size
);
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
);
70 struct kcdata_type_definition
*
71 kcdata_get_typedescription(unsigned type_id
, uint8_t * buffer
, uint32_t buffer_size
)
74 #define _STR_VALUE(x) #x
75 #define _SUBTYPE(t, s, f) setup_subtype_description(&subtypes[i++], (t), offsetof(s, f), _STR_VALUE(f))
76 #define _SUBTYPE_ARRAY(t, s, f, c) setup_subtype_array_description(&subtypes[i++], (t), offsetof(s, f), (c), _STR_VALUE(f))
77 #define _STRINGTYPE(f) setup_subtype_array_description(&subtypes[i++], KC_ST_CHAR, 0, UINT16_MAX, f)
79 if (buffer_size
< sizeof(struct kcdata_type_definition
) || buffer
== NULL
)
82 struct kcdata_type_definition
* retval
= (struct kcdata_type_definition
*)&buffer
[0];
83 kcdata_subtype_descriptor_t subtypes
= (kcdata_subtype_descriptor_t
)&buffer
[sizeof(struct kcdata_type_definition
)];
85 case KCDATA_TYPE_STRING_DESC
: {
87 setup_subtype_array_description(&subtypes
[i
++], KC_ST_CHAR
, 0, KCDATA_DESC_MAXLEN
, "desc");
88 setup_subtype_array_description(&subtypes
[i
++], KC_ST_CHAR
, KCDATA_DESC_MAXLEN
, UINT16_MAX
, "data");
89 setup_type_definition(retval
, type_id
, i
, "string_desc");
93 case KCDATA_TYPE_UINT32_DESC
: {
95 setup_subtype_array_description(&subtypes
[i
++], KC_ST_CHAR
, 0, KCDATA_DESC_MAXLEN
, "desc");
96 setup_subtype_description(&subtypes
[i
++], KC_ST_UINT32
, KCDATA_DESC_MAXLEN
, "data");
97 setup_type_definition(retval
, type_id
, i
, "uint32_desc");
101 case KCDATA_TYPE_UINT64_DESC
: {
103 setup_subtype_array_description(&subtypes
[i
++], KC_ST_CHAR
, 0, KCDATA_DESC_MAXLEN
, "desc");
104 setup_subtype_description(&subtypes
[i
++], KC_ST_UINT64
, KCDATA_DESC_MAXLEN
, "data");
105 setup_type_definition(retval
, type_id
, i
, "uint64_desc");
109 case KCDATA_TYPE_INT32_DESC
: {
111 setup_subtype_array_description(&subtypes
[i
++], KC_ST_CHAR
, 0, KCDATA_DESC_MAXLEN
, "desc");
112 setup_subtype_description(&subtypes
[i
++], KC_ST_INT32
, KCDATA_DESC_MAXLEN
, "data");
113 setup_type_definition(retval
, type_id
, i
, "int32_desc");
117 case KCDATA_TYPE_INT64_DESC
: {
119 setup_subtype_array_description(&subtypes
[i
++], KC_ST_CHAR
, 0, KCDATA_DESC_MAXLEN
, "desc");
120 setup_subtype_description(&subtypes
[i
++], KC_ST_INT64
, KCDATA_DESC_MAXLEN
, "data");
121 setup_type_definition(retval
, type_id
, i
, "int64_desc");
125 case KCDATA_TYPE_TYPEDEFINTION
: {
127 setup_subtype_description(&subtypes
[i
++], KC_ST_UINT32
, offsetof(struct kcdata_type_definition
, kct_type_identifier
), "typeID");
128 setup_subtype_description(&subtypes
[i
++], KC_ST_UINT32
, offsetof(struct kcdata_type_definition
, kct_num_elements
), "numOfFields");
129 setup_subtype_array_description(&subtypes
[i
++], KC_ST_CHAR
, offsetof(struct kcdata_type_definition
, kct_name
), KCDATA_DESC_MAXLEN
, "name");
130 // Note "fields" is an array of run time defined length. So we populate fields at parsing time.
131 setup_type_definition(retval
, type_id
, i
, "typedef");
135 case KCDATA_TYPE_CONTAINER_BEGIN
: {
137 setup_subtype_description(&subtypes
[i
++], KC_ST_UINT32
, 0, "kcContainerType");
138 setup_type_definition(retval
, type_id
, i
, "container_begin");
142 case KCDATA_TYPE_LIBRARY_LOADINFO
: {
144 _SUBTYPE(KC_ST_UINT32
, struct user32_dyld_uuid_info
, imageLoadAddress
);
145 _SUBTYPE_ARRAY(KC_ST_UINT8
, struct user32_dyld_uuid_info
, imageUUID
, 16);
146 setup_type_definition(retval
, type_id
, i
, "dyld_load_info");
150 case KCDATA_TYPE_LIBRARY_LOADINFO64
: {
152 _SUBTYPE(KC_ST_UINT64
, struct user64_dyld_uuid_info
, imageLoadAddress
);
153 _SUBTYPE_ARRAY(KC_ST_UINT8
, struct user64_dyld_uuid_info
, imageUUID
, 16);
154 setup_type_definition(retval
, type_id
, i
, "dyld_load_info");
158 case STACKSHOT_KCTYPE_SHAREDCACHE_LOADINFO
: {
160 _SUBTYPE(KC_ST_UINT64
, struct dyld_uuid_info_64_v2
, imageLoadAddress
);
161 _SUBTYPE_ARRAY(KC_ST_UINT8
, struct dyld_uuid_info_64_v2
, imageUUID
, 16);
162 _SUBTYPE(KC_ST_UINT64
, struct dyld_uuid_info_64_v2
, imageSlidBaseAddress
);
163 setup_type_definition(retval
, type_id
, i
, "shared_cache_dyld_load_info");
167 case STACKSHOT_KCTYPE_KERNELCACHE_LOADINFO
: {
169 _SUBTYPE(KC_ST_UINT64
, struct dyld_uuid_info_64
, imageLoadAddress
);
170 _SUBTYPE_ARRAY(KC_ST_UINT8
, struct dyld_uuid_info_64
, imageUUID
, 16);
171 setup_type_definition(retval
, type_id
, i
, "kernelcache_load_info");
175 case KCDATA_TYPE_TIMEBASE
: {
177 _SUBTYPE(KC_ST_UINT32
, struct mach_timebase_info
, numer
);
178 _SUBTYPE(KC_ST_UINT32
, struct mach_timebase_info
, denom
);
179 setup_type_definition(retval
, type_id
, i
, "mach_timebase_info");
183 case KCDATA_TYPE_MACH_ABSOLUTE_TIME
:
184 setup_type_definition(retval
, type_id
, 1, "mach_absolute_time");
185 setup_subtype_description(&subtypes
[0], KC_ST_UINT64
, 0, "mach_absolute_time");
188 case KCDATA_TYPE_TIMEVAL
: {
190 _SUBTYPE(KC_ST_INT64
, struct timeval64
, tv_sec
);
191 _SUBTYPE(KC_ST_INT64
, struct timeval64
, tv_usec
);
192 setup_type_definition(retval
, type_id
, i
, "timeval");
196 case KCDATA_TYPE_USECS_SINCE_EPOCH
:
197 setup_type_definition(retval
, type_id
, 1, "usecs_since_epoch");
198 setup_subtype_description(&subtypes
[0], KC_ST_UINT64
, 0, "usecs_since_epoch");
201 case KCDATA_TYPE_PID
:
202 setup_subtype_description(&subtypes
[0], KC_ST_INT32
, 0, "pid");
203 setup_type_definition(retval
, type_id
, 1, "pid");
206 case KCDATA_TYPE_PROCNAME
:
208 setup_subtype_array_description(&subtypes
[i
++], KC_ST_CHAR
, 0, 64, "proc_name");
209 setup_type_definition(retval
, type_id
, i
, "proc_name");
212 /* stackshot specific types */
213 case STACKSHOT_KCTYPE_IOSTATS
: {
215 _SUBTYPE(KC_ST_UINT64
, struct io_stats_snapshot
, ss_disk_reads_count
);
216 _SUBTYPE(KC_ST_UINT64
, struct io_stats_snapshot
, ss_disk_reads_size
);
217 _SUBTYPE(KC_ST_UINT64
, struct io_stats_snapshot
, ss_disk_writes_count
);
218 _SUBTYPE(KC_ST_UINT64
, struct io_stats_snapshot
, ss_disk_writes_size
);
219 _SUBTYPE_ARRAY(KC_ST_UINT64
, struct io_stats_snapshot
, ss_io_priority_count
, STACKSHOT_IO_NUM_PRIORITIES
);
220 _SUBTYPE_ARRAY(KC_ST_UINT64
, struct io_stats_snapshot
, ss_io_priority_size
, STACKSHOT_IO_NUM_PRIORITIES
);
221 _SUBTYPE(KC_ST_UINT64
, struct io_stats_snapshot
, ss_paging_count
);
222 _SUBTYPE(KC_ST_UINT64
, struct io_stats_snapshot
, ss_paging_size
);
223 _SUBTYPE(KC_ST_UINT64
, struct io_stats_snapshot
, ss_non_paging_count
);
224 _SUBTYPE(KC_ST_UINT64
, struct io_stats_snapshot
, ss_non_paging_size
);
225 _SUBTYPE(KC_ST_UINT64
, struct io_stats_snapshot
, ss_data_count
);
226 _SUBTYPE(KC_ST_UINT64
, struct io_stats_snapshot
, ss_data_size
);
227 _SUBTYPE(KC_ST_UINT64
, struct io_stats_snapshot
, ss_metadata_count
);
228 _SUBTYPE(KC_ST_UINT64
, struct io_stats_snapshot
, ss_metadata_size
);
230 setup_type_definition(retval
, type_id
, i
, "io_statistics");
234 case STACKSHOT_KCTYPE_GLOBAL_MEM_STATS
: {
236 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, snapshot_magic
);
237 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, free_pages
);
238 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, active_pages
);
239 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, inactive_pages
);
240 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, purgeable_pages
);
241 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, wired_pages
);
242 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, speculative_pages
);
243 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, throttled_pages
);
244 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, filebacked_pages
);
245 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, compressions
);
246 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, decompressions
);
247 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, compressor_size
);
248 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, busy_buffer_count
);
249 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, pages_wanted
);
250 _SUBTYPE(KC_ST_UINT32
, struct mem_and_io_snapshot
, pages_reclaimed
);
251 _SUBTYPE(KC_ST_UINT8
, struct mem_and_io_snapshot
, pages_wanted_reclaimed_valid
);
252 setup_type_definition(retval
, type_id
, i
, "mem_and_io_snapshot");
256 case STACKSHOT_KCCONTAINER_TASK
:
257 setup_type_definition(retval
, type_id
, 0, "task_snapshots");
260 case STACKSHOT_KCCONTAINER_THREAD
:
261 setup_type_definition(retval
, type_id
, 0, "thread_snapshots");
264 case STACKSHOT_KCTYPE_TASK_SNAPSHOT
: {
266 _SUBTYPE(KC_ST_UINT64
, struct task_snapshot_v2
, ts_unique_pid
);
267 _SUBTYPE(KC_ST_UINT64
, struct task_snapshot_v2
, ts_ss_flags
);
268 _SUBTYPE(KC_ST_UINT64
, struct task_snapshot_v2
, ts_user_time_in_terminated_threads
);
269 _SUBTYPE(KC_ST_UINT64
, struct task_snapshot_v2
, ts_system_time_in_terminated_threads
);
270 _SUBTYPE(KC_ST_UINT64
, struct task_snapshot_v2
, ts_p_start_sec
);
271 _SUBTYPE(KC_ST_UINT64
, struct task_snapshot_v2
, ts_task_size
);
272 _SUBTYPE(KC_ST_UINT64
, struct task_snapshot_v2
, ts_max_resident_size
);
273 _SUBTYPE(KC_ST_UINT32
, struct task_snapshot_v2
, ts_suspend_count
);
274 _SUBTYPE(KC_ST_UINT32
, struct task_snapshot_v2
, ts_faults
);
275 _SUBTYPE(KC_ST_UINT32
, struct task_snapshot_v2
, ts_pageins
);
276 _SUBTYPE(KC_ST_UINT32
, struct task_snapshot_v2
, ts_cow_faults
);
277 _SUBTYPE(KC_ST_UINT32
, struct task_snapshot_v2
, ts_was_throttled
);
278 _SUBTYPE(KC_ST_UINT32
, struct task_snapshot_v2
, ts_did_throttle
);
279 _SUBTYPE(KC_ST_UINT32
, struct task_snapshot_v2
, ts_latency_qos
);
280 _SUBTYPE(KC_ST_INT32
, struct task_snapshot_v2
, ts_pid
);
281 _SUBTYPE_ARRAY(KC_ST_CHAR
, struct task_snapshot_v2
, ts_p_comm
, 32);
282 setup_type_definition(retval
, type_id
, i
, "task_snapshot");
286 case STACKSHOT_KCTYPE_TASK_DELTA_SNAPSHOT
: {
288 _SUBTYPE(KC_ST_UINT64
, struct task_delta_snapshot_v2
, tds_unique_pid
);
289 _SUBTYPE(KC_ST_UINT64
, struct task_delta_snapshot_v2
, tds_ss_flags
);
290 _SUBTYPE(KC_ST_UINT64
, struct task_delta_snapshot_v2
, tds_user_time_in_terminated_threads
);
291 _SUBTYPE(KC_ST_UINT64
, struct task_delta_snapshot_v2
, tds_system_time_in_terminated_threads
);
292 _SUBTYPE(KC_ST_UINT64
, struct task_delta_snapshot_v2
, tds_task_size
);
293 _SUBTYPE(KC_ST_UINT64
, struct task_delta_snapshot_v2
, tds_max_resident_size
);
294 _SUBTYPE(KC_ST_UINT32
, struct task_delta_snapshot_v2
, tds_suspend_count
);
295 _SUBTYPE(KC_ST_UINT32
, struct task_delta_snapshot_v2
, tds_faults
);
296 _SUBTYPE(KC_ST_UINT32
, struct task_delta_snapshot_v2
, tds_pageins
);
297 _SUBTYPE(KC_ST_UINT32
, struct task_delta_snapshot_v2
, tds_cow_faults
);
298 _SUBTYPE(KC_ST_UINT32
, struct task_delta_snapshot_v2
, tds_was_throttled
);
299 _SUBTYPE(KC_ST_UINT32
, struct task_delta_snapshot_v2
, tds_did_throttle
);
300 _SUBTYPE(KC_ST_UINT32
, struct task_delta_snapshot_v2
, tds_latency_qos
);
301 setup_type_definition(retval
, type_id
, i
, "task_delta_snapshot");
305 case STACKSHOT_KCTYPE_THREAD_SNAPSHOT
: {
308 _SUBTYPE(KC_ST_UINT64
, struct thread_snapshot_v3
, ths_thread_id
);
309 _SUBTYPE(KC_ST_UINT64
, struct thread_snapshot_v3
, ths_wait_event
);
310 _SUBTYPE(KC_ST_UINT64
, struct thread_snapshot_v3
, ths_continuation
);
311 _SUBTYPE(KC_ST_UINT64
, struct thread_snapshot_v3
, ths_total_syscalls
);
312 _SUBTYPE(KC_ST_UINT64
, struct thread_snapshot_v3
, ths_voucher_identifier
);
313 _SUBTYPE(KC_ST_UINT64
, struct thread_snapshot_v3
, ths_dqserialnum
);
314 _SUBTYPE(KC_ST_UINT64
, struct thread_snapshot_v3
, ths_user_time
);
315 _SUBTYPE(KC_ST_UINT64
, struct thread_snapshot_v3
, ths_sys_time
);
316 _SUBTYPE(KC_ST_UINT64
, struct thread_snapshot_v3
, ths_ss_flags
);
317 _SUBTYPE(KC_ST_UINT64
, struct thread_snapshot_v3
, ths_last_run_time
);
318 _SUBTYPE(KC_ST_UINT64
, struct thread_snapshot_v3
, ths_last_made_runnable_time
);
319 _SUBTYPE(KC_ST_UINT32
, struct thread_snapshot_v3
, ths_state
);
320 _SUBTYPE(KC_ST_UINT32
, struct thread_snapshot_v3
, ths_sched_flags
);
321 _SUBTYPE(KC_ST_INT16
, struct thread_snapshot_v3
, ths_base_priority
);
322 _SUBTYPE(KC_ST_INT16
, struct thread_snapshot_v3
, ths_sched_priority
);
323 _SUBTYPE(KC_ST_UINT8
, struct thread_snapshot_v3
, ths_eqos
);
324 _SUBTYPE(KC_ST_UINT8
, struct thread_snapshot_v3
, ths_rqos
);
325 _SUBTYPE(KC_ST_UINT8
, struct thread_snapshot_v3
, ths_rqos_override
);
326 _SUBTYPE(KC_ST_UINT8
, struct thread_snapshot_v3
, ths_io_tier
);
327 _SUBTYPE(KC_ST_UINT64
, struct thread_snapshot_v3
, ths_thread_t
);
328 _SUBTYPE(KC_ST_UINT64
, struct thread_snapshot_v4
, ths_requested_policy
);
329 _SUBTYPE(KC_ST_UINT64
, struct thread_snapshot_v4
, ths_effective_policy
);
331 setup_type_definition(retval
, type_id
, i
, "thread_snapshot");
335 case STACKSHOT_KCTYPE_THREAD_DELTA_SNAPSHOT
: {
338 _SUBTYPE(KC_ST_UINT64
, struct thread_delta_snapshot_v2
, tds_thread_id
);
339 _SUBTYPE(KC_ST_UINT64
, struct thread_delta_snapshot_v2
, tds_voucher_identifier
);
340 _SUBTYPE(KC_ST_UINT64
, struct thread_delta_snapshot_v2
, tds_ss_flags
);
341 _SUBTYPE(KC_ST_UINT64
, struct thread_delta_snapshot_v2
, tds_last_made_runnable_time
);
342 _SUBTYPE(KC_ST_UINT32
, struct thread_delta_snapshot_v2
, tds_state
);
343 _SUBTYPE(KC_ST_UINT32
, struct thread_delta_snapshot_v2
, tds_sched_flags
);
344 _SUBTYPE(KC_ST_INT16
, struct thread_delta_snapshot_v2
, tds_base_priority
);
345 _SUBTYPE(KC_ST_INT16
, struct thread_delta_snapshot_v2
, tds_sched_priority
);
346 _SUBTYPE(KC_ST_UINT8
, struct thread_delta_snapshot_v2
, tds_eqos
);
347 _SUBTYPE(KC_ST_UINT8
, struct thread_delta_snapshot_v2
, tds_rqos
);
348 _SUBTYPE(KC_ST_UINT8
, struct thread_delta_snapshot_v2
, tds_rqos_override
);
349 _SUBTYPE(KC_ST_UINT8
, struct thread_delta_snapshot_v2
, tds_io_tier
);
351 setup_type_definition(retval
, type_id
, i
, "thread_delta_snapshot");
356 case STACKSHOT_KCTYPE_DONATING_PIDS
:
357 setup_type_definition(retval
, type_id
, 1, "donating_pids");
358 setup_subtype_description(&subtypes
[0], KC_ST_INT32
, 0, "donating_pids");
361 case STACKSHOT_KCTYPE_THREAD_NAME
: {
363 setup_subtype_array_description(&subtypes
[i
++], KC_ST_CHAR
, 0, 64, "pth_name");
364 setup_type_definition(retval
, type_id
, i
, "pth_name");
368 case STACKSHOT_KCTYPE_KERN_STACKFRAME
:
369 setup_type_definition(retval
, type_id
, 2, "kernel_stack_frames");
370 setup_subtype_description(&subtypes
[0], KC_ST_UINT32
, 0, "lr");
371 setup_subtype_description(&subtypes
[1], KC_ST_UINT32
, sizeof(uint32_t), "sp");
374 case STACKSHOT_KCTYPE_KERN_STACKFRAME64
:
375 setup_type_definition(retval
, type_id
, 2, "kernel_stack_frames");
376 setup_subtype_description(&subtypes
[0], KC_ST_UINT64
, 0, "lr");
377 setup_subtype_description(&subtypes
[1], KC_ST_UINT64
, sizeof(uint64_t), "sp");
380 case STACKSHOT_KCTYPE_USER_STACKFRAME
:
381 setup_type_definition(retval
, type_id
, 2, "user_stack_frames");
382 setup_subtype_description(&subtypes
[0], KC_ST_UINT32
, 0, "lr");
383 setup_subtype_description(&subtypes
[1], KC_ST_UINT32
, sizeof(uint32_t), "sp");
386 case STACKSHOT_KCTYPE_USER_STACKFRAME64
:
387 setup_type_definition(retval
, type_id
, 2, "user_stack_frames");
388 setup_subtype_description(&subtypes
[0], KC_ST_UINT64
, 0, "lr");
389 setup_subtype_description(&subtypes
[1], KC_ST_UINT64
, sizeof(uint64_t), "sp");
392 case STACKSHOT_KCTYPE_KERN_STACKLR
:
393 setup_type_definition(retval
, type_id
, 1, "kernel_stack_frames");
394 setup_subtype_description(&subtypes
[0], KC_ST_UINT32
, 0, "lr");
395 subtypes
[0].kcs_flags
|= KCS_SUBTYPE_FLAGS_STRUCT
;
398 case STACKSHOT_KCTYPE_KERN_STACKLR64
:
399 setup_type_definition(retval
, type_id
, 1, "kernel_stack_frames");
400 setup_subtype_description(&subtypes
[0], KC_ST_UINT64
, 0, "lr");
401 subtypes
[0].kcs_flags
|= KCS_SUBTYPE_FLAGS_STRUCT
;
404 case STACKSHOT_KCTYPE_USER_STACKLR
:
405 setup_type_definition(retval
, type_id
, 1, "user_stack_frames");
406 setup_subtype_description(&subtypes
[0], KC_ST_UINT32
, 0, "lr");
407 subtypes
[0].kcs_flags
|= KCS_SUBTYPE_FLAGS_STRUCT
;
410 case STACKSHOT_KCTYPE_USER_STACKLR64
:
411 setup_type_definition(retval
, type_id
, 1, "user_stack_frames");
412 setup_subtype_description(&subtypes
[0], KC_ST_UINT64
, 0, "lr");
413 subtypes
[0].kcs_flags
|= KCS_SUBTYPE_FLAGS_STRUCT
;
416 case STACKSHOT_KCTYPE_NONRUNNABLE_TIDS
:
417 setup_type_definition(retval
, type_id
, 1, "nonrunnable_threads");
418 setup_subtype_description(&subtypes
[0], KC_ST_INT64
, 0, "nonrunnable_threads");
421 case STACKSHOT_KCTYPE_NONRUNNABLE_TASKS
:
422 setup_type_definition(retval
, type_id
, 1, "nonrunnable_tasks");
423 setup_subtype_description(&subtypes
[0], KC_ST_INT64
, 0, "nonrunnable_tasks");
426 case STACKSHOT_KCTYPE_BOOTARGS
: {
428 _STRINGTYPE("boot_args");
429 setup_type_definition(retval
, type_id
, i
, "boot_args");
433 case STACKSHOT_KCTYPE_OSVERSION
: {
435 _STRINGTYPE("osversion");
436 setup_type_definition(retval
, type_id
, i
, "osversion");
440 case STACKSHOT_KCTYPE_KERN_PAGE_SIZE
: {
442 setup_subtype_description(&subtypes
[i
++], KC_ST_UINT32
, 0, "kernel_page_size");
443 setup_type_definition(retval
, type_id
, i
, "kernel_page_size");
447 case STACKSHOT_KCTYPE_THREAD_POLICY_VERSION
: {
449 setup_subtype_description(&subtypes
[i
++], KC_ST_UINT32
, 0, "thread_policy_version");
450 setup_type_definition(retval
, type_id
, i
, "thread_policy_version");
454 case STACKSHOT_KCTYPE_JETSAM_LEVEL
: {
456 setup_subtype_description(&subtypes
[i
++], KC_ST_UINT32
, 0, "jetsam_level");
457 setup_type_definition(retval
, type_id
, i
, "jetsam_level");
461 case STACKSHOT_KCTYPE_DELTA_SINCE_TIMESTAMP
: {
463 setup_subtype_description(&subtypes
[i
++], KC_ST_UINT64
, 0, "stackshot_delta_since_timestamp");
464 setup_type_definition(retval
, type_id
, i
, "stackshot_delta_since_timestamp");
468 /* crashinfo types */
469 case TASK_CRASHINFO_BSDINFOWITHUNIQID
: {
471 _SUBTYPE_ARRAY(KC_ST_UINT8
, struct proc_uniqidentifierinfo
, p_uuid
, 16);
472 _SUBTYPE(KC_ST_UINT64
, struct proc_uniqidentifierinfo
, p_uniqueid
);
473 _SUBTYPE(KC_ST_UINT64
, struct proc_uniqidentifierinfo
, p_puniqueid
);
474 /* Ignore the p_reserve fields */
475 setup_type_definition(retval
, type_id
, i
, "proc_uniqidentifierinfo");
479 case TASK_CRASHINFO_PID
: {
480 setup_subtype_description(&subtypes
[0], KC_ST_INT32
, 0, "pid");
481 setup_type_definition(retval
, type_id
, 1, "pid");
485 case TASK_CRASHINFO_PPID
: {
486 setup_subtype_description(&subtypes
[0], KC_ST_INT32
, 0, "ppid");
487 setup_type_definition(retval
, type_id
, 1, "ppid");
491 /* case TASK_CRASHINFO_RUSAGE: { */
493 /* * rusage is a complex structure and is only for legacy use for crashed processes rusage info. */
494 /* * So we just consider it as opaque data. */
497 /* setup_subtype_array_description(&subtypes[i++], KC_ST_UINT8, 0, sizeof(struct rusage), "rusage"); */
498 /* setup_type_definition(retval, type_id, i, "rusage"); */
502 case TASK_CRASHINFO_RUSAGE_INFO
: {
504 _SUBTYPE_ARRAY(KC_ST_UINT8
, struct rusage_info_v3
, ri_uuid
, 16);
505 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_user_time
);
506 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_system_time
);
507 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_pkg_idle_wkups
);
508 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_interrupt_wkups
);
509 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_pageins
);
510 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_wired_size
);
511 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_resident_size
);
512 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_phys_footprint
);
513 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_proc_start_abstime
);
514 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_proc_exit_abstime
);
515 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_child_user_time
);
516 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_child_system_time
);
517 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_child_pkg_idle_wkups
);
518 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_child_interrupt_wkups
);
519 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_child_pageins
);
520 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_child_elapsed_abstime
);
521 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_diskio_bytesread
);
522 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_diskio_byteswritten
);
523 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_cpu_time_qos_default
);
524 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_cpu_time_qos_maintenance
);
525 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_cpu_time_qos_background
);
526 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_cpu_time_qos_utility
);
527 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_cpu_time_qos_legacy
);
528 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_cpu_time_qos_user_initiated
);
529 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_cpu_time_qos_user_interactive
);
530 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_billed_system_time
);
531 _SUBTYPE(KC_ST_UINT64
, struct rusage_info_v3
, ri_serviced_system_time
);
532 setup_type_definition(retval
, type_id
, i
, "rusage_info");
536 case STACKSHOT_KCTYPE_CPU_TIMES
: {
538 _SUBTYPE(KC_ST_UINT64
, struct stackshot_cpu_times
, user_usec
);
539 _SUBTYPE(KC_ST_UINT64
, struct stackshot_cpu_times
, system_usec
);
540 setup_type_definition(retval
, type_id
, i
, "cpu_times");
544 case STACKSHOT_KCTYPE_STACKSHOT_DURATION
: {
546 _SUBTYPE(KC_ST_UINT64
, struct stackshot_duration
, stackshot_duration
);
547 _SUBTYPE(KC_ST_UINT64
, struct stackshot_duration
, stackshot_duration_outer
);
548 subtypes
[0].kcs_flags
|= KCS_SUBTYPE_FLAGS_MERGE
;
549 subtypes
[1].kcs_flags
|= KCS_SUBTYPE_FLAGS_MERGE
;
550 setup_type_definition(retval
, type_id
, i
, "stackshot_duration");
554 case STACKSHOT_KCTYPE_STACKSHOT_FAULT_STATS
: {
556 _SUBTYPE(KC_ST_UINT32
, struct stackshot_fault_stats
, sfs_pages_faulted_in
);
557 _SUBTYPE(KC_ST_UINT64
, struct stackshot_fault_stats
, sfs_time_spent_faulting
);
558 _SUBTYPE(KC_ST_UINT64
, struct stackshot_fault_stats
, sfs_system_max_fault_time
);
559 _SUBTYPE(KC_ST_UINT8
, struct stackshot_fault_stats
, sfs_stopped_faulting
);
561 setup_type_definition(retval
, type_id
, i
, "stackshot_fault_stats");
565 case STACKSHOT_KCTYPE_THREAD_WAITINFO
: {
567 _SUBTYPE(KC_ST_UINT64
, struct stackshot_thread_waitinfo
, owner
);
568 _SUBTYPE(KC_ST_UINT64
, struct stackshot_thread_waitinfo
, waiter
);
569 _SUBTYPE(KC_ST_UINT64
, struct stackshot_thread_waitinfo
, context
);
570 _SUBTYPE(KC_ST_UINT8
, struct stackshot_thread_waitinfo
, wait_type
);
571 setup_type_definition(retval
, type_id
, i
, "thread_waitinfo");
575 case STACKSHOT_KCTYPE_THREAD_GROUP_SNAPSHOT
: {
577 _SUBTYPE(KC_ST_UINT64
, struct thread_group_snapshot_v2
, tgs_id
);
578 _SUBTYPE_ARRAY(KC_ST_CHAR
, struct thread_group_snapshot_v2
, tgs_name
, 16);
579 _SUBTYPE(KC_ST_UINT64
, struct thread_group_snapshot_v2
, tgs_flags
);
580 setup_type_definition(retval
, type_id
, i
, "thread_group_snapshot");
584 case STACKSHOT_KCTYPE_THREAD_GROUP
: {
586 setup_subtype_description(&subtypes
[i
++], KC_ST_UINT64
, 0, "thread_group");
587 setup_type_definition(retval
, type_id
, i
, "thread_group");
591 case STACKSHOT_KCTYPE_JETSAM_COALITION_SNAPSHOT
: {
593 _SUBTYPE(KC_ST_UINT64
, struct jetsam_coalition_snapshot
, jcs_id
);
594 _SUBTYPE(KC_ST_UINT64
, struct jetsam_coalition_snapshot
, jcs_flags
);
595 _SUBTYPE(KC_ST_UINT64
, struct jetsam_coalition_snapshot
, jcs_thread_group
);
596 _SUBTYPE(KC_ST_UINT64
, struct jetsam_coalition_snapshot
, jcs_leader_task_uniqueid
);
597 setup_type_definition(retval
, type_id
, i
, "jetsam_coalition_snapshot");
601 case STACKSHOT_KCTYPE_JETSAM_COALITION
: {
603 setup_subtype_description(&subtypes
[i
++], KC_ST_UINT64
, 0, "jetsam_coalition");
604 setup_type_definition(retval
, type_id
, i
, "jetsam_coalition");
608 case STACKSHOT_KCTYPE_INSTRS_CYCLES
: {
610 _SUBTYPE(KC_ST_UINT64
, struct instrs_cycles_snapshot
, ics_instructions
);
611 _SUBTYPE(KC_ST_UINT64
, struct instrs_cycles_snapshot
, ics_cycles
);
612 setup_type_definition(retval
, type_id
, i
, "instrs_cycles_snapshot");
616 case TASK_CRASHINFO_PROC_STARTTIME
: {
618 _SUBTYPE(KC_ST_INT64
, struct timeval64
, tv_sec
);
619 _SUBTYPE(KC_ST_INT64
, struct timeval64
, tv_usec
);
620 setup_type_definition(retval
, type_id
, i
, "proc_starttime");
624 case TASK_CRASHINFO_EXCEPTION_CODES
: {
627 for (i
= 0; i
< EXCEPTION_CODE_MAX
; i
++) {
628 snprintf(codenum
, sizeof(codenum
), "code_%d", i
);
629 setup_subtype_description(&subtypes
[i
], KC_ST_UINT64
, i
* (sizeof(uint64_t)), codenum
);
631 setup_type_definition(retval
, type_id
, i
, "mach_exception_data_t");
635 case TASK_CRASHINFO_PROC_NAME
: {
637 _STRINGTYPE("p_comm");
638 setup_type_definition(retval
, type_id
, i
, "p_comm");
642 case TASK_CRASHINFO_USERSTACK
: {
644 setup_subtype_description(&subtypes
[0], KC_ST_UINT64
, 0, "userstack_ptr");
645 setup_type_definition(retval
, type_id
, 1, "userstack_ptr");
649 case TASK_CRASHINFO_ARGSLEN
: {
651 setup_subtype_description(&subtypes
[0], KC_ST_INT32
, 0, "p_argslen");
652 setup_type_definition(retval
, type_id
, 1, "p_argslen");
656 case TASK_CRASHINFO_PROC_PATH
: {
658 _STRINGTYPE("p_path");
659 setup_type_definition(retval
, type_id
, i
, "p_path");
663 case TASK_CRASHINFO_PROC_CSFLAGS
: {
664 setup_subtype_description(&subtypes
[0], KC_ST_UINT32
, 0, "p_csflags");
665 setup_type_definition(retval
, type_id
, 1, "p_csflags");
669 case TASK_CRASHINFO_PROC_STATUS
: {
670 setup_subtype_description(&subtypes
[0], KC_ST_UINT8
, 0, "p_status");
671 setup_type_definition(retval
, type_id
, 1, "p_status");
675 case TASK_CRASHINFO_UID
: {
676 setup_subtype_description(&subtypes
[0], KC_ST_INT32
, 0, "uid");
677 setup_type_definition(retval
, type_id
, 1, "uid");
681 case TASK_CRASHINFO_GID
: {
682 setup_subtype_description(&subtypes
[0], KC_ST_INT32
, 0, "gid");
683 setup_type_definition(retval
, type_id
, 1, "gid");
687 case TASK_CRASHINFO_PROC_ARGC
: {
688 setup_subtype_description(&subtypes
[0], KC_ST_INT32
, 0, "argc");
689 setup_type_definition(retval
, type_id
, 1, "argc");
693 case TASK_CRASHINFO_PROC_FLAGS
: {
694 setup_subtype_description(&subtypes
[0], KC_ST_UINT32
, 0, "p_flags");
695 setup_type_definition(retval
, type_id
, 1, "p_flags");
699 case TASK_CRASHINFO_CPUTYPE
: {
700 setup_subtype_description(&subtypes
[0], KC_ST_INT32
, 0, "cputype");
701 setup_type_definition(retval
, type_id
, 1, "cputype");
705 case TASK_CRASHINFO_RESPONSIBLE_PID
: {
706 setup_subtype_description(&subtypes
[0], KC_ST_INT32
, 0, "responsible_pid");
707 setup_type_definition(retval
, type_id
, 1, "responsible_pid");
711 case TASK_CRASHINFO_DIRTY_FLAGS
: {
712 setup_subtype_description(&subtypes
[0], KC_ST_UINT32
, 0, "dirty_flags");
713 setup_type_definition(retval
, type_id
, 1, "dirty_flags");
717 case TASK_CRASHINFO_CRASHED_THREADID
: {
718 setup_subtype_description(&subtypes
[0], KC_ST_UINT64
, 0, "crashed_threadid");
719 setup_type_definition(retval
, type_id
, 1, "crashed_threadid");
723 case TASK_CRASHINFO_COALITION_ID
: {
724 setup_subtype_description(&subtypes
[0], KC_ST_UINT64
, 0, "coalition_id");
725 setup_type_definition(retval
, type_id
, 1, "coalition_id");
729 case TASK_CRASHINFO_UDATA_PTRS
: {
730 setup_subtype_description(&subtypes
[0], KC_ST_UINT64
, 0, "udata_ptrs");
731 setup_type_definition(retval
, type_id
, 1, "udata_ptrs");
735 case TASK_CRASHINFO_MEMORY_LIMIT
: {
736 setup_subtype_description(&subtypes
[0], KC_ST_UINT64
, 0, "task_phys_mem_limit");
737 setup_type_definition(retval
, type_id
, 1, "task_phys_mem_limit");
741 case EXIT_REASON_SNAPSHOT
: {
742 _SUBTYPE(KC_ST_UINT32
, struct exit_reason_snapshot
, ers_namespace
);
743 _SUBTYPE(KC_ST_UINT64
, struct exit_reason_snapshot
, ers_code
);
744 _SUBTYPE(KC_ST_UINT64
, struct exit_reason_snapshot
, ers_flags
);
745 setup_type_definition(retval
, type_id
, i
, "exit_reason_basic_info");
751 case EXIT_REASON_USER_DESC
: {
754 _STRINGTYPE("exit_reason_user_description");
755 setup_type_definition(retval
, type_id
, i
, "exit_reason_user_description");
759 case EXIT_REASON_USER_PAYLOAD
: {
762 setup_subtype_array_description(&subtypes
[i
++], KC_ST_UINT8
, 0, EXIT_REASON_PAYLOAD_MAX_LEN
, "exit_reason_user_payload");
763 setup_type_definition(retval
, type_id
, i
, "exit_reason_user_payload");
767 case EXIT_REASON_CODESIGNING_INFO
: {
768 _SUBTYPE(KC_ST_UINT64
, struct codesigning_exit_reason_info
, ceri_virt_addr
);
769 _SUBTYPE(KC_ST_UINT64
, struct codesigning_exit_reason_info
, ceri_file_offset
);
770 _SUBTYPE_ARRAY(KC_ST_CHAR
, struct codesigning_exit_reason_info
, ceri_pathname
, EXIT_REASON_CODESIG_PATH_MAX
);
771 _SUBTYPE_ARRAY(KC_ST_CHAR
, struct codesigning_exit_reason_info
, ceri_filename
, EXIT_REASON_CODESIG_PATH_MAX
);
772 _SUBTYPE(KC_ST_UINT64
, struct codesigning_exit_reason_info
, ceri_codesig_modtime_secs
);
773 _SUBTYPE(KC_ST_UINT64
, struct codesigning_exit_reason_info
, ceri_codesig_modtime_nsecs
);
774 _SUBTYPE(KC_ST_UINT64
, struct codesigning_exit_reason_info
, ceri_page_modtime_secs
);
775 _SUBTYPE(KC_ST_UINT64
, struct codesigning_exit_reason_info
, ceri_page_modtime_nsecs
);
776 _SUBTYPE(KC_ST_UINT8
, struct codesigning_exit_reason_info
, ceri_path_truncated
);
777 _SUBTYPE(KC_ST_UINT8
, struct codesigning_exit_reason_info
, ceri_object_codesigned
);
778 _SUBTYPE(KC_ST_UINT8
, struct codesigning_exit_reason_info
, ceri_page_codesig_validated
);
779 _SUBTYPE(KC_ST_UINT8
, struct codesigning_exit_reason_info
, ceri_page_codesig_tainted
);
780 _SUBTYPE(KC_ST_UINT8
, struct codesigning_exit_reason_info
, ceri_page_codesig_nx
);
781 _SUBTYPE(KC_ST_UINT8
, struct codesigning_exit_reason_info
, ceri_page_wpmapped
);
782 _SUBTYPE(KC_ST_UINT8
, struct codesigning_exit_reason_info
, ceri_page_slid
);
783 _SUBTYPE(KC_ST_UINT8
, struct codesigning_exit_reason_info
, ceri_page_dirty
);
784 _SUBTYPE(KC_ST_UINT32
, struct codesigning_exit_reason_info
, ceri_page_shadow_depth
);
785 setup_type_definition(retval
, type_id
, i
, "exit_reason_codesigning_info");
789 case EXIT_REASON_WORKLOOP_ID
: {
791 setup_subtype_description(&subtypes
[i
++], KC_ST_UINT64
, 0, "exit_reason_workloop_id");
792 setup_type_definition(retval
, type_id
, i
, "exit_reason_workloop_id");
796 case EXIT_REASON_DISPATCH_QUEUE_NO
: {
798 setup_subtype_description(&subtypes
[i
++], KC_ST_UINT64
, 0, "exit_reason_dispatch_queue_no");
799 setup_type_definition(retval
, type_id
, i
, "exit_reason_dispatch_queue_no");
810 assert(retval
== NULL
|| (buffer_size
> sizeof(struct kcdata_type_definition
) +
811 (retval
->kct_num_elements
* sizeof(struct kcdata_subtype_descriptor
))));
816 setup_type_definition(struct kcdata_type_definition
* d
, uint32_t type
, uint32_t num_elems
, char * name
)
818 d
->kct_type_identifier
= type
;
819 d
->kct_num_elements
= num_elems
;
820 memcpy(d
->kct_name
, name
, sizeof(d
->kct_name
));
821 d
->kct_name
[sizeof(d
->kct_name
) - 1] = '\0';
825 get_kctype_subtype_size(kctype_subtype_t type
)
831 return sizeof(uint8_t);
835 return sizeof(uint16_t);
839 return sizeof(uint32_t);
843 return sizeof(uint64_t);
854 setup_subtype_array_description(
855 kcdata_subtype_descriptor_t desc
, kctype_subtype_t type
, uint32_t offset
, uint32_t count
, char * name
)
857 desc
->kcs_flags
= KCS_SUBTYPE_FLAGS_ARRAY
;
858 desc
->kcs_elem_type
= type
;
859 desc
->kcs_elem_offset
= offset
;
860 desc
->kcs_elem_size
= KCS_SUBTYPE_PACK_SIZE(count
, get_kctype_subtype_size(type
));
861 memcpy(desc
->kcs_name
, name
, sizeof(desc
->kcs_name
));
862 desc
->kcs_name
[sizeof(desc
->kcs_name
) - 1] = '\0';
866 setup_subtype_description(kcdata_subtype_descriptor_t desc
, kctype_subtype_t type
, uint32_t offset
, char * name
)
868 desc
->kcs_flags
= KCS_SUBTYPE_FLAGS_NONE
;
869 desc
->kcs_elem_type
= type
;
870 desc
->kcs_elem_offset
= offset
;
871 desc
->kcs_elem_size
= get_kctype_subtype_size(type
);
872 memcpy(desc
->kcs_name
, name
, sizeof(desc
->kcs_name
));
873 desc
->kcs_name
[sizeof(desc
->kcs_name
) - 1] = '\0';