1 /*
2 * Copyright (c) 2015 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
30 /*
31 *
32 * THE KCDATA MANIFESTO
33 *
34 * Kcdata is a self-describing data serialization format. It is meant to get
35 * nested data structures out of xnu with minimum fuss, but also for that data
36 * to be easy to parse. It is also meant to allow us to add new fields and
37 * evolve the data format without breaking old parsers.
38 *
39 * Kcdata is a permanent data format suitable for long-term storage including
40 * in files. It is very important that we continue to be able to parse old
41 * versions of kcdata-based formats. To this end, there are several
42 * invariants you MUST MAINTAIN if you alter this file.
43 *
44 * * None of the magic numbers should ever be a byteswap of themselves or
45 * of any of the other magic numbers.
46 *
47 * * Never remove any type.
48 *
49 * * All kcdata structs must be packed, and must exclusively use fixed-size
50 * types.
51 *
52 * * Never change the definition of any type, except to add new fields to
53 * the end.
54 *
55 * * If you do add new fields to the end of a type, do not actually change
56 * the definition of the old structure. Instead, define a new structure
57 * with the new fields. See thread_snapshot_v3 as an example. This
58 * provides source compatibility for old readers, and also documents where
59 * the potential size cutoffs are.
60 *
61 * * If you change libkdd, or kcdata.py run the unit tests under libkdd.
62 *
63 * * If you add a type or extend an existing one, add a sample test to
64 * libkdd/tests so future changes to libkdd will always parse your struct
65 * correctly.
66 *
67 * For example to add a field to this:
68 *
69 * struct foobar {
70 * uint32_t baz;
71 * uint32_t quux;
72 * } __attribute__ ((packed));
73 *
74 * Make it look like this:
75 *
76 * struct foobar {
77 * uint32_t baz;
78 * uint32_t quux;
79 * ///////// end version 1 of foobar. sizeof(struct foobar) was 8 ////////
80 * uint32_t frozzle;
81 * } __attribute__ ((packed));
82 *
83 * If you are parsing kcdata formats, you MUST
84 *
85 * * Check the length field of each struct, including array elements. If the
86 * struct is longer than you expect, you must ignore the extra data.
87 *
88 * * Ignore any data types you do not understand.
89 *
90 * Additionally, we want to be as forward compatible as we can. Meaning old
91 * tools should still be able to use new data whenever possible. To this end,
92 * you should:
93 *
94 * * Try not to add new versions of types that supplant old ones. Instead
95 * extend the length of existing types or add supplemental types.
96 *
97 * * Try not to remove information from existing kcdata formats, unless
98 * removal was explicitly asked for. For example it is fine to add a
99 * stackshot flag to remove unwanted information, but you should not
100 * remove it from the default stackshot if the new flag is absent.
101 *
102 * * (TBD) If you do break old readers by removing information or
103 * supplanting old structs, then increase the major version number.
104 *
105 *
106 *
107 * The following is a description of the kcdata format.
108 *
109 *
110 * The format for data is setup in a generic format as follows
111 *
112 * Layout of data structure:
113 *
114 * | 8 - bytes |
115 * | type = MAGIC | LENGTH |
116 * | 0 |
117 * | type | size |
118 * | flags |
119 * | data |
120 * |___________data____________|
121 * | type | size |
122 * | flags |
123 * |___________data____________|
124 * | type = END | size=0 |
125 * | 0 |
126 *
127 *
128 * The type field describes what kind of data is passed. For example type = TASK_CRASHINFO_UUID means the following data is a uuid.
129 * These types need to be defined in task_corpses.h for easy consumption by userspace inspection tools.
130 *
131 * Some range of types is reserved for special types like ints, longs etc. A cool new functionality made possible with this
132 * extensible data format is that kernel can decide to put more information as required without requiring user space tools to
133 * re-compile to be compatible. The case of rusage struct versions could be introduced without breaking existing tools.
134 *
135 * Feature description: Generic data with description
136 * -------------------
137 * Further more generic data with description is very much possible now. For example
138 *
139 * - kcdata_add_uint64_with_description(cdatainfo, 0x700, "NUM MACH PORTS");
140 * - and more functions that allow adding description.
141 * The userspace tools can then look at the description and print the data even if they are not compiled with knowledge of the field apriori.
142 *
143 * Example data:
144 * 0000 57 f1 ad de 00 00 00 00 00 00 00 00 00 00 00 00 W...............
145 * 0010 01 00 00 00 00 00 00 00 30 00 00 00 00 00 00 00 ........0.......
146 * 0020 50 49 44 00 00 00 00 00 00 00 00 00 00 00 00 00 PID.............
147 * 0030 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
148 * 0040 9c 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
149 * 0050 01 00 00 00 00 00 00 00 30 00 00 00 00 00 00 00 ........0.......
150 * 0060 50 41 52 45 4e 54 20 50 49 44 00 00 00 00 00 00 PARENT PID......
151 * 0070 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
152 * 0080 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................
153 * 0090 ed 58 91 f1
154 *
155 * Feature description: Container markers for compound data
156 * ------------------
157 * If a given kernel data type is complex and requires adding multiple optional fields inside a container
158 * object for a consumer to understand arbitrary data, we package it using container markers.
159 *
160 * For example, the stackshot code gathers information and describes the state of a given task with respect
161 * to many subsystems. It includes data such as io stats, vm counters, process names/flags and syscall counts.
162 *
163 * kcdata_add_container_marker(kcdata_p, KCDATA_TYPE_CONTAINER_BEGIN, STACKSHOT_KCCONTAINER_TASK, task_uniqueid);
164 * // add multiple data, or add_<type>_with_description()s here
165 *
166 * kcdata_add_container_marker(kcdata_p, KCDATA_TYPE_CONTAINER_END, STACKSHOT_KCCONTAINER_TASK, task_uniqueid);
167 *
168 * Feature description: Custom Data formats on demand
169 * --------------------
170 * With the self describing nature of format, the kernel provider can describe a data type (uniquely identified by a number) and use
171 * it in the buffer for sending data. The consumer can parse the type information and have knowledge of describing incoming data.
172 * Following is an example of how we can describe a kernel specific struct sample_disk_io_stats in buffer.
173 *
174 * struct sample_disk_io_stats {
175 * uint64_t disk_reads_count;
176 * uint64_t disk_reads_size;
177 * uint64_t io_priority_count[4];
178 * uint64_t io_priority_size;
179 * } __attribute__ ((packed));
180 *
181 *
182 * struct kcdata_subtype_descriptor disk_io_stats_def[] = {
183 * {KCS_SUBTYPE_FLAGS_NONE, KC_ST_UINT64, 0 * sizeof(uint64_t), sizeof(uint64_t), "disk_reads_count"},
184 * {KCS_SUBTYPE_FLAGS_NONE, KC_ST_UINT64, 1 * sizeof(uint64_t), sizeof(uint64_t), "disk_reads_size"},
185 * {KCS_SUBTYPE_FLAGS_ARRAY, KC_ST_UINT64, 2 * sizeof(uint64_t), KCS_SUBTYPE_PACK_SIZE(4, sizeof(uint64_t)), "io_priority_count"},
186 * {KCS_SUBTYPE_FLAGS_ARRAY, KC_ST_UINT64, (2 + 4) * sizeof(uint64_t), sizeof(uint64_t), "io_priority_size"},
187 * };
188 *
189 * Now you can add this custom type definition into the buffer as
190 * kcdata_add_type_definition(kcdata_p, KCTYPE_SAMPLE_DISK_IO_STATS, "sample_disk_io_stats",
191 * &disk_io_stats_def[0], sizeof(disk_io_stats_def)/sizeof(struct kcdata_subtype_descriptor));
192 *
193 * Feature description: Compression
194 * --------------------
195 * In order to avoid keeping large amounts of memory reserved for a panic stackshot, kcdata has support
196 * for compressing the buffer in a streaming fashion. New data pushed to the kcdata buffer will be
197 * automatically compressed using an algorithm selected by the API user (currently, we only support
198 * pass-through and zlib, in the future we plan to add WKDM support, see: 57913859).
199 *
200 * To start using compression, call:
201 * kcdata_init_compress(kcdata_p, hdr_tag, memcpy_f, comp_type);
202 * where:
203 * `kcdata_p` is the kcdata buffer that will be used
204 * `hdr_tag` is the usual header tag denoting what type of kcdata buffer this will be
205 * `memcpy_f` a memcpy(3) function to use to copy into the buffer, optional.
206 * `compy_type` is the compression type, see KCDCT_ZLIB for an example.
207 *
208 * Once compression is initialized:
209 * (1) all self-describing APIs will automatically compress
210 * (2) you can now use the following APIs to compress data into the buffer:
211 * (None of the following will compress unless kcdata_init_compress() has been called)
212 *
213 * - kcdata_push_data(kcdata_descriptor_t data, uint32_t type, uint32_t size, const void *input_data)
214 * Pushes the buffer of kctype @type at[@input_data, @input_data + @size]
215 * into the kcdata buffer @data, compressing if needed.
216 *
217 * - kcdata_push_array(kcdata_descriptor_t data, uint32_t type_of_element,
218 * uint32_t size_of_element, uint32_t count, const void *input_data)
219 * Pushes the array found at @input_data, with element type @type_of_element, where
220 * each element is of size @size_of_element and there are @count elements into the kcdata buffer
221 * at @data.
222 *
223 * - kcdata_compression_window_open/close(kcdata_descriptor_t data)
224 * In case the data you are trying to push to the kcdata buffer @data is difficult to predict,
225 * you can open a "compression window". Between an open and a close, no compression will be done.
226 * Once you clsoe the window, the underlying compression algorithm will compress the data into the buffer
227 * and automatically rewind the current end marker of the kcdata buffer.
228 * There is an ASCII art in kern_cdata.c to aid the reader in understanding
229 * this.
230 *
231 * - kcdata_finish_compression(kcdata_descriptor_t data)
232 * Must be called at the end to flush any underlying buffers used by the compression algorithms.
233 * This function will also add some statistics about the compression to the buffer which helps with
234 * decompressing later.
235 *
236 * Once you are done with the kcdata buffer, call kcdata_deinit_compress to
237 * free any buffers that may have been allocated internal to the compression
238 * algorithm.
239 */
240
241
242 #ifndef _KCDATA_H_
243 #define _KCDATA_H_
244
245 #include <stdint.h>
246 #include <string.h>
247 #include <uuid/uuid.h>
248
249 #define KCDATA_DESC_MAXLEN 32 /* including NULL byte at end */
250
251 #define KCDATA_FLAGS_STRUCT_PADDING_MASK 0xf
252 #define KCDATA_FLAGS_STRUCT_HAS_PADDING 0x80
253
254 /*
255 * kcdata aligns elements to 16 byte boundaries.
256 */
257 #define KCDATA_ALIGNMENT_SIZE 0x10
258
259 struct kcdata_item {
260 uint32_t type;
261 uint32_t size; /* len(data) */
262 /* flags.
263 *
264 * For structures:
265 * padding = flags & 0xf
266 * has_padding = (flags & 0x80) >> 7
267 *
268 * has_padding is needed to disambiguate cases such as
269 * thread_snapshot_v2 and thread_snapshot_v3. Their
270 * respective sizes are 0x68 and 0x70, and thread_snapshot_v2
271 * was emitted by old kernels *before* we started recording
272 * padding. Since legacy thread_snapsht_v2 and modern
273 * thread_snapshot_v3 will both record 0 for the padding
274 * flags, we need some other bit which will be nonzero in the
275 * flags to disambiguate.
276 *
277 * This is why we hardcode a special case for
278 * STACKSHOT_KCTYPE_THREAD_SNAPSHOT into the iterator
279 * functions below. There is only a finite number of such
280 * hardcodings which will ever be needed. They can occur
281 * when:
282 *
283 * * We have a legacy structure that predates padding flags
284 *
285 * * which we want to extend without changing the kcdata type
286 *
287 * * by only so many bytes as would fit in the space that
288 * was previously unused padding.
289 *
290 * For containers:
291 * container_id = flags
292 *
293 * For arrays:
294 * element_count = flags & UINT32_MAX
295 * element_type = (flags >> 32) & UINT32_MAX
296 */
297 uint64_t flags;
298 char data[]; /* must be at the end */
299 };
300
301 typedef struct kcdata_item * kcdata_item_t;
302
303 enum KCDATA_SUBTYPE_TYPES { KC_ST_CHAR = 1, KC_ST_INT8, KC_ST_UINT8, KC_ST_INT16, KC_ST_UINT16, KC_ST_INT32, KC_ST_UINT32, KC_ST_INT64, KC_ST_UINT64 };
304 typedef enum KCDATA_SUBTYPE_TYPES kctype_subtype_t;
305
306 /*
307 * A subtype description structure that defines
308 * how a compound data is laid out in memory. This
309 * provides on the fly definition of types and consumption
310 * by the parser.
311 */
312 struct kcdata_subtype_descriptor {
313 uint8_t kcs_flags;
314 #define KCS_SUBTYPE_FLAGS_NONE 0x0
315 #define KCS_SUBTYPE_FLAGS_ARRAY 0x1
316 /* Force struct type even if only one element.
317 *
318 * Normally a kcdata_type_definition is treated as a structure if it has
319 * more than one subtype descriptor. Otherwise it is treated as a simple
320 * type. For example libkdd will represent a simple integer 42 as simply
321 * 42, but it will represent a structure containing an integer 42 as
322 * {"field_name": 42}..
323 *
324 * If a kcdata_type_definition has only single subtype, then it will be
325 * treated as a structure iff KCS_SUBTYPE_FLAGS_STRUCT is set. If it has
326 * multiple subtypes, it will always be treated as a structure.
327 *
328 * KCS_SUBTYPE_FLAGS_MERGE has the opposite effect. If this flag is used then
329 * even if there are multiple elements, they will all be treated as individual
330 * properties of the parent dictionary.
331 */
332 #define KCS_SUBTYPE_FLAGS_STRUCT 0x2 /* force struct type even if only one element */
333 #define KCS_SUBTYPE_FLAGS_MERGE 0x4 /* treat as multiple elements of parents instead of struct */
334 uint8_t kcs_elem_type; /* restricted to kctype_subtype_t */
335 uint16_t kcs_elem_offset; /* offset in struct where data is found */
336 uint32_t kcs_elem_size; /* size of element (or) packed state for array type */
337 char kcs_name[KCDATA_DESC_MAXLEN]; /* max 31 bytes for name of field */
338 };
339
340 typedef struct kcdata_subtype_descriptor * kcdata_subtype_descriptor_t;
341
342 /*
343 * In case of array of basic c types in kctype_subtype_t,
344 * size is packed in lower 16 bits and
345 * count is packed in upper 16 bits of kcs_elem_size field.
346 */
347 #define KCS_SUBTYPE_PACK_SIZE(e_count, e_size) (((e_count)&0xffffu) << 16 | ((e_size)&0xffffu))
348
349 static inline uint32_t
kcs_get_elem_size(kcdata_subtype_descriptor_t d)350 kcs_get_elem_size(kcdata_subtype_descriptor_t d)
351 {
352 if (d->kcs_flags & KCS_SUBTYPE_FLAGS_ARRAY) {
353 /* size is composed as ((count &0xffff)<<16 | (elem_size & 0xffff)) */
354 return (uint32_t)((d->kcs_elem_size & 0xffff) * ((d->kcs_elem_size & 0xffff0000) >> 16));
355 }
356 return d->kcs_elem_size;
357 }
358
359 static inline uint32_t
kcs_get_elem_count(kcdata_subtype_descriptor_t d)360 kcs_get_elem_count(kcdata_subtype_descriptor_t d)
361 {
362 if (d->kcs_flags & KCS_SUBTYPE_FLAGS_ARRAY) {
363 return (d->kcs_elem_size >> 16) & 0xffff;
364 }
365 return 1;
366 }
367
368 static inline int
kcs_set_elem_size(kcdata_subtype_descriptor_t d,uint32_t size,uint32_t count)369 kcs_set_elem_size(kcdata_subtype_descriptor_t d, uint32_t size, uint32_t count)
370 {
371 if (count > 1) {
372 /* means we are setting up an array */
373 if (size > 0xffff || count > 0xffff) {
374 return -1; //invalid argument
375 }
376 d->kcs_elem_size = ((count & 0xffff) << 16 | (size & 0xffff));
377 } else {
378 d->kcs_elem_size = size;
379 }
380 return 0;
381 }
382
383 struct kcdata_type_definition {
384 uint32_t kct_type_identifier;
385 uint32_t kct_num_elements;
386 char kct_name[KCDATA_DESC_MAXLEN];
387 struct kcdata_subtype_descriptor kct_elements[];
388 };
389
390
391 /* chunk type definitions. 0 - 0x7ff are reserved and defined here
392 * NOTE: Please update kcdata/libkdd/kcdtypes.c if you make any changes
393 * in STACKSHOT_KCTYPE_* types.
394 */
395
396 /*
397 * Types with description value.
398 * these will have KCDATA_DESC_MAXLEN-1 length string description
399 * and rest of kcdata_iter_size() - KCDATA_DESC_MAXLEN bytes as data
400 */
401 #define KCDATA_TYPE_INVALID 0x0u
402 #define KCDATA_TYPE_STRING_DESC 0x1u
403 #define KCDATA_TYPE_UINT32_DESC 0x2u
404 #define KCDATA_TYPE_UINT64_DESC 0x3u
405 #define KCDATA_TYPE_INT32_DESC 0x4u
406 #define KCDATA_TYPE_INT64_DESC 0x5u
407 #define KCDATA_TYPE_BINDATA_DESC 0x6u
408
409 /*
410 * Compound type definitions
411 */
412 #define KCDATA_TYPE_ARRAY 0x11u /* Array of data OBSOLETE DONT USE THIS*/
413 #define KCDATA_TYPE_TYPEDEFINTION 0x12u /* Meta type that describes a type on the fly. */
414 #define KCDATA_TYPE_CONTAINER_BEGIN \
415 0x13u /* Container type which has corresponding CONTAINER_END header. \
416 * KCDATA_TYPE_CONTAINER_BEGIN has type in the data segment. \
417 * Both headers have (uint64_t) ID for matching up nested data. \
418 */
419 #define KCDATA_TYPE_CONTAINER_END 0x14u
420
421 #define KCDATA_TYPE_ARRAY_PAD0 0x20u /* Array of data with 0 byte of padding*/
422 #define KCDATA_TYPE_ARRAY_PAD1 0x21u /* Array of data with 1 byte of padding*/
423 #define KCDATA_TYPE_ARRAY_PAD2 0x22u /* Array of data with 2 byte of padding*/
424 #define KCDATA_TYPE_ARRAY_PAD3 0x23u /* Array of data with 3 byte of padding*/
425 #define KCDATA_TYPE_ARRAY_PAD4 0x24u /* Array of data with 4 byte of padding*/
426 #define KCDATA_TYPE_ARRAY_PAD5 0x25u /* Array of data with 5 byte of padding*/
427 #define KCDATA_TYPE_ARRAY_PAD6 0x26u /* Array of data with 6 byte of padding*/
428 #define KCDATA_TYPE_ARRAY_PAD7 0x27u /* Array of data with 7 byte of padding*/
429 #define KCDATA_TYPE_ARRAY_PAD8 0x28u /* Array of data with 8 byte of padding*/
430 #define KCDATA_TYPE_ARRAY_PAD9 0x29u /* Array of data with 9 byte of padding*/
431 #define KCDATA_TYPE_ARRAY_PADa 0x2au /* Array of data with a byte of padding*/
432 #define KCDATA_TYPE_ARRAY_PADb 0x2bu /* Array of data with b byte of padding*/
433 #define KCDATA_TYPE_ARRAY_PADc 0x2cu /* Array of data with c byte of padding*/
434 #define KCDATA_TYPE_ARRAY_PADd 0x2du /* Array of data with d byte of padding*/
435 #define KCDATA_TYPE_ARRAY_PADe 0x2eu /* Array of data with e byte of padding*/
436 #define KCDATA_TYPE_ARRAY_PADf 0x2fu /* Array of data with f byte of padding*/
437
438 /*
439 * Generic data types that are most commonly used
440 */
441 #define KCDATA_TYPE_LIBRARY_LOADINFO 0x30u /* struct dyld_uuid_info_32 */
442 #define KCDATA_TYPE_LIBRARY_LOADINFO64 0x31u /* struct dyld_uuid_info_64 */
443 #define KCDATA_TYPE_TIMEBASE 0x32u /* struct mach_timebase_info */
444 #define KCDATA_TYPE_MACH_ABSOLUTE_TIME 0x33u /* uint64_t */
445 #define KCDATA_TYPE_TIMEVAL 0x34u /* struct timeval64 */
446 #define KCDATA_TYPE_USECS_SINCE_EPOCH 0x35u /* time in usecs uint64_t */
447 #define KCDATA_TYPE_PID 0x36u /* int32_t */
448 #define KCDATA_TYPE_PROCNAME 0x37u /* char * */
449 #define KCDATA_TYPE_NESTED_KCDATA 0x38u /* nested kcdata buffer */
450 #define KCDATA_TYPE_LIBRARY_AOTINFO 0x39u /* struct user64_dyld_aot_info */
451
452 #define KCDATA_TYPE_BUFFER_END 0xF19158EDu
453
454 /* MAGIC numbers defined for each class of chunked data
455 *
456 * To future-proof against big-endian arches, make sure none of these magic
457 * numbers are byteswaps of each other
458 */
459
460 #define KCDATA_BUFFER_BEGIN_CRASHINFO 0xDEADF157u /* owner: corpses/task_corpse.h */
461 /* type-range: 0x800 - 0x8ff */
462 #define KCDATA_BUFFER_BEGIN_STACKSHOT 0x59a25807u /* owner: sys/stackshot.h */
463 /* type-range: 0x900 - 0x93f */
464 #define KCDATA_BUFFER_BEGIN_COMPRESSED 0x434f4d50u /* owner: sys/stackshot.h */
465 /* type-range: 0x900 - 0x93f */
466 #define KCDATA_BUFFER_BEGIN_DELTA_STACKSHOT 0xDE17A59Au /* owner: sys/stackshot.h */
467 /* type-range: 0x940 - 0x9ff */
468 #define KCDATA_BUFFER_BEGIN_BTINFO 0x46414E47u /* owner: kern/kern_exit.c */
469 /* type-range: 0xa01 - 0xaff */
470 #define KCDATA_BUFFER_BEGIN_OS_REASON 0x53A20900u /* owner: sys/reason.h */
471 /* type-range: 0x1000-0x103f */
472 #define KCDATA_BUFFER_BEGIN_XNUPOST_CONFIG 0x1e21c09fu /* owner: osfmk/tests/kernel_tests.c */
473 /* type-range: 0x1040-0x105f */
474
475 /* next type range number available 0x1060 */
476 /**************** definitions for XNUPOST *********************/
477 #define XNUPOST_KCTYPE_TESTCONFIG 0x1040
478
479 /**************** definitions for stackshot *********************/
480
481 /* This value must always match IO_NUM_PRIORITIES defined in thread_info.h */
482 #define STACKSHOT_IO_NUM_PRIORITIES 4
483 /* This value must always match MAXTHREADNAMESIZE used in bsd */
484 #define STACKSHOT_MAX_THREAD_NAME_SIZE 64
485
486 /*
487 * NOTE: Please update kcdata/libkdd/kcdtypes.c if you make any changes
488 * in STACKSHOT_KCTYPE_* types.
489 */
490 #define STACKSHOT_KCTYPE_IOSTATS 0x901u /* io_stats_snapshot */
491 #define STACKSHOT_KCTYPE_GLOBAL_MEM_STATS 0x902u /* struct mem_and_io_snapshot */
492 #define STACKSHOT_KCCONTAINER_TASK 0x903u
493 #define STACKSHOT_KCCONTAINER_THREAD 0x904u
494 #define STACKSHOT_KCTYPE_TASK_SNAPSHOT 0x905u /* task_snapshot_v2 */
495 #define STACKSHOT_KCTYPE_THREAD_SNAPSHOT 0x906u /* thread_snapshot_v2, thread_snapshot_v3 */
496 #define STACKSHOT_KCTYPE_DONATING_PIDS 0x907u /* int[] */
497 #define STACKSHOT_KCTYPE_SHAREDCACHE_LOADINFO 0x908u /* dyld_shared_cache_loadinfo */
498 #define STACKSHOT_KCTYPE_THREAD_NAME 0x909u /* char[] */
499 #define STACKSHOT_KCTYPE_KERN_STACKFRAME 0x90Au /* struct stack_snapshot_frame32 */
500 #define STACKSHOT_KCTYPE_KERN_STACKFRAME64 0x90Bu /* struct stack_snapshot_frame64 */
501 #define STACKSHOT_KCTYPE_USER_STACKFRAME 0x90Cu /* struct stack_snapshot_frame32 */
502 #define STACKSHOT_KCTYPE_USER_STACKFRAME64 0x90Du /* struct stack_snapshot_frame64 */
503 #define STACKSHOT_KCTYPE_BOOTARGS 0x90Eu /* boot args string */
504 #define STACKSHOT_KCTYPE_OSVERSION 0x90Fu /* os version string */
505 #define STACKSHOT_KCTYPE_KERN_PAGE_SIZE 0x910u /* kernel page size in uint32_t */
506 #define STACKSHOT_KCTYPE_JETSAM_LEVEL 0x911u /* jetsam level in uint32_t */
507 #define STACKSHOT_KCTYPE_DELTA_SINCE_TIMESTAMP 0x912u /* timestamp used for the delta stackshot */
508 #define STACKSHOT_KCTYPE_KERN_STACKLR 0x913u /* uint32_t */
509 #define STACKSHOT_KCTYPE_KERN_STACKLR64 0x914u /* uint64_t */
510 #define STACKSHOT_KCTYPE_USER_STACKLR 0x915u /* uint32_t */
511 #define STACKSHOT_KCTYPE_USER_STACKLR64 0x916u /* uint64_t */
512 #define STACKSHOT_KCTYPE_NONRUNNABLE_TIDS 0x917u /* uint64_t */
513 #define STACKSHOT_KCTYPE_NONRUNNABLE_TASKS 0x918u /* uint64_t */
514 #define STACKSHOT_KCTYPE_CPU_TIMES 0x919u /* struct stackshot_cpu_times or stackshot_cpu_times_v2 */
515 #define STACKSHOT_KCTYPE_STACKSHOT_DURATION 0x91au /* struct stackshot_duration */
516 #define STACKSHOT_KCTYPE_STACKSHOT_FAULT_STATS 0x91bu /* struct stackshot_fault_stats */
517 #define STACKSHOT_KCTYPE_KERNELCACHE_LOADINFO 0x91cu /* kernelcache UUID -- same as KCDATA_TYPE_LIBRARY_LOADINFO64 */
518 #define STACKSHOT_KCTYPE_THREAD_WAITINFO 0x91du /* struct stackshot_thread_waitinfo */
519 #define STACKSHOT_KCTYPE_THREAD_GROUP_SNAPSHOT 0x91eu /* struct thread_group_snapshot{,_v2,_v3} */
520 #define STACKSHOT_KCTYPE_THREAD_GROUP 0x91fu /* uint64_t */
521 #define STACKSHOT_KCTYPE_JETSAM_COALITION_SNAPSHOT 0x920u /* struct jetsam_coalition_snapshot */
522 #define STACKSHOT_KCTYPE_JETSAM_COALITION 0x921u /* uint64_t */
523 #define STACKSHOT_KCTYPE_THREAD_POLICY_VERSION 0x922u /* THREAD_POLICY_INTERNAL_STRUCT_VERSION in uint32 */
524 #define STACKSHOT_KCTYPE_INSTRS_CYCLES 0x923u /* struct instrs_cycles_snapshot_v2 */
525 #define STACKSHOT_KCTYPE_USER_STACKTOP 0x924u /* struct stack_snapshot_stacktop */
526 #define STACKSHOT_KCTYPE_ASID 0x925u /* uint32_t */
527 #define STACKSHOT_KCTYPE_PAGE_TABLES 0x926u /* uint64_t */
528 #define STACKSHOT_KCTYPE_SYS_SHAREDCACHE_LAYOUT 0x927u /* same as KCDATA_TYPE_LIBRARY_LOADINFO64 */
529 #define STACKSHOT_KCTYPE_THREAD_DISPATCH_QUEUE_LABEL 0x928u /* dispatch queue label */
530 #define STACKSHOT_KCTYPE_THREAD_TURNSTILEINFO 0x929u /* struct stackshot_thread_turnstileinfo */
531 #define STACKSHOT_KCTYPE_TASK_CPU_ARCHITECTURE 0x92au /* struct stackshot_cpu_architecture */
532 #define STACKSHOT_KCTYPE_LATENCY_INFO 0x92bu /* struct stackshot_latency_collection */
533 #define STACKSHOT_KCTYPE_LATENCY_INFO_TASK 0x92cu /* struct stackshot_latency_task */
534 #define STACKSHOT_KCTYPE_LATENCY_INFO_THREAD 0x92du /* struct stackshot_latency_thread */
535 #define STACKSHOT_KCTYPE_LOADINFO64_TEXT_EXEC 0x92eu /* TEXT_EXEC load info -- same as KCDATA_TYPE_LIBRARY_LOADINFO64 */
536 #define STACKSHOT_KCTYPE_AOTCACHE_LOADINFO 0x92fu /* struct dyld_aot_cache_uuid_info */
537 #define STACKSHOT_KCTYPE_TRANSITIONING_TASK_SNAPSHOT 0x930u /* transitioning_task_snapshot */
538 #define STACKSHOT_KCCONTAINER_TRANSITIONING_TASK 0x931u
539 #define STACKSHOT_KCTYPE_USER_ASYNC_START_INDEX 0x932u /* uint32_t index in user_stack of beginning of async stack */
540 #define STACKSHOT_KCTYPE_USER_ASYNC_STACKLR64 0x933u /* uint64_t async stack pointers */
541 #define STACKSHOT_KCCONTAINER_PORTLABEL 0x934u /* container for port label info */
542 #define STACKSHOT_KCTYPE_PORTLABEL 0x935u /* struct stackshot_portlabel */
543 #define STACKSHOT_KCTYPE_PORTLABEL_NAME 0x936u /* string port name */
544 #define STACKSHOT_KCTYPE_DYLD_COMPACTINFO 0x937u /* binary blob of dyld info (variable size) */
545
546 #define STACKSHOT_KCTYPE_TASK_DELTA_SNAPSHOT 0x940u /* task_delta_snapshot_v2 */
547 #define STACKSHOT_KCTYPE_THREAD_DELTA_SNAPSHOT 0x941u /* thread_delta_snapshot_v* */
548 #define STACKSHOT_KCCONTAINER_SHAREDCACHE 0x942u /* container for shared cache info */
549 #define STACKSHOT_KCTYPE_SHAREDCACHE_INFO 0x943u /* dyld_shared_cache_loadinfo_v2 */
550 #define STACKSHOT_KCTYPE_SHAREDCACHE_AOTINFO 0x944u /* struct dyld_aot_cache_uuid_info */
551 #define STACKSHOT_KCTYPE_SHAREDCACHE_ID 0x945u /* uint32_t in task: if we aren't attached to Primary, which one */
552 #define STACKSHOT_KCTYPE_CODESIGNING_INFO 0x946u /* struct stackshot_task_codesigning_info */
553
554
555 struct stack_snapshot_frame32 {
556 uint32_t lr;
557 uint32_t sp;
558 };
559
560 struct stack_snapshot_frame64 {
561 uint64_t lr;
562 uint64_t sp;
563 };
564
565 struct dyld_uuid_info_32 {
566 uint32_t imageLoadAddress; /* base address image is mapped at */
567 uuid_t imageUUID;
568 };
569
570 struct dyld_uuid_info_64 {
571 uint64_t imageLoadAddress; /* XXX image slide */
572 uuid_t imageUUID;
573 };
574
575 /*
576 * N.B.: Newer kernels output dyld_shared_cache_loadinfo structures
577 * instead of this, since the field names match their contents better.
578 */
579 struct dyld_uuid_info_64_v2 {
580 uint64_t imageLoadAddress; /* XXX image slide */
581 uuid_t imageUUID;
582 /* end of version 1 of dyld_uuid_info_64. sizeof v1 was 24 */
583 uint64_t imageSlidBaseAddress; /* slid base address or slid first mapping of image */
584 };
585
586 enum dyld_shared_cache_flags {
587 kSharedCacheSystemPrimary = 0x1, /* primary shared cache on the system; attached tasks will have kTaskSharedRegionSystem set */
588 kSharedCacheDriverkit = 0x2, /* driverkit shared cache */
589 kSharedCacheAOT = 0x4, /* Rosetta shared cache */
590 };
591
592 /*
593 * This is the renamed version of dyld_uuid_info_64 with more accurate
594 * field names, for STACKSHOT_KCTYPE_SHAREDCACHE_LOADINFO. Any users
595 * must be aware of the dyld_uuid_info_64* version history and ensure
596 * the fields they are accessing are within the actual bounds.
597 *
598 * OLD_FIELD NEW_FIELD
599 * imageLoadAddress sharedCacheSlide
600 * imageUUID sharedCacheUUID
601 * imageSlidBaseAddress sharedCacheUnreliableSlidBaseAddress
602 * - sharedCacheSlidFirstMapping
603 * - sharedCacheID
604 * - sharedCacheFlags
605 */
606 struct dyld_shared_cache_loadinfo_v2 {
607 uint64_t sharedCacheSlide; /* image slide value */
608 uuid_t sharedCacheUUID;
609 /* end of version 1 of dyld_uuid_info_64. sizeof v1 was 24 */
610 uint64_t sharedCacheUnreliableSlidBaseAddress; /* for backwards-compatibility; use sharedCacheSlidFirstMapping if available */
611 /* end of version 2 of dyld_uuid_info_64. sizeof v2 was 32 */
612 uint64_t sharedCacheSlidFirstMapping; /* slid base address of first mapping */
613 /* end of version 1 of dyld_shared_cache_loadinfo. sizeof was 40 */
614 uint32_t sharedCacheID; /* ID of shared cache */
615 uint32_t sharedCacheFlags;
616 };
617
618 struct dyld_shared_cache_loadinfo {
619 uint64_t sharedCacheSlide; /* image slide value */
620 uuid_t sharedCacheUUID;
621 /* end of version 1 of dyld_uuid_info_64. sizeof v1 was 24 */
622 uint64_t sharedCacheUnreliableSlidBaseAddress; /* for backwards-compatibility; use sharedCacheSlidFirstMapping if available */
623 /* end of version 2 of dyld_uuid_info_64. sizeof v2 was 32 */
624 uint64_t sharedCacheSlidFirstMapping; /* slid base address of first mapping */
625 };
626
627 struct dyld_aot_cache_uuid_info {
628 uint64_t x86SlidBaseAddress; /* slid first mapping address of x86 shared cache */
629 uuid_t x86UUID; /* UUID of x86 shared cache */
630 uint64_t aotSlidBaseAddress; /* slide first mapping address of aot cache */
631 uuid_t aotUUID; /* UUID of aot shared cache */
632 };
633
634 struct user32_dyld_uuid_info {
635 uint32_t imageLoadAddress; /* base address image is mapped into */
636 uuid_t imageUUID; /* UUID of image */
637 };
638
639 struct user64_dyld_uuid_info {
640 uint64_t imageLoadAddress; /* base address image is mapped into */
641 uuid_t imageUUID; /* UUID of image */
642 };
643
644 #define DYLD_AOT_IMAGE_KEY_SIZE 32
645
646 struct user64_dyld_aot_info {
647 uint64_t x86LoadAddress;
648 uint64_t aotLoadAddress;
649 uint64_t aotImageSize;
650 uint8_t aotImageKey[DYLD_AOT_IMAGE_KEY_SIZE];
651 };
652
653 enum task_snapshot_flags {
654 /* k{User,Kernel}64_p (values 0x1 and 0x2) are defined in generic_snapshot_flags */
655 kTaskRsrcFlagged = 0x4, // In the EXC_RESOURCE danger zone?
656 kTerminatedSnapshot = 0x8,
657 kPidSuspended = 0x10, // true for suspended task
658 kFrozen = 0x20, // true for hibernated task (along with pidsuspended)
659 kTaskDarwinBG = 0x40,
660 kTaskExtDarwinBG = 0x80,
661 kTaskVisVisible = 0x100,
662 kTaskVisNonvisible = 0x200,
663 kTaskIsForeground = 0x400,
664 kTaskIsBoosted = 0x800,
665 kTaskIsSuppressed = 0x1000,
666 kTaskIsTimerThrottled = 0x2000, /* deprecated */
667 kTaskIsImpDonor = 0x4000,
668 kTaskIsLiveImpDonor = 0x8000,
669 kTaskIsDirty = 0x10000,
670 kTaskWqExceededConstrainedThreadLimit = 0x20000,
671 kTaskWqExceededTotalThreadLimit = 0x40000,
672 kTaskWqFlagsAvailable = 0x80000,
673 kTaskUUIDInfoFaultedIn = 0x100000, /* successfully faulted in some UUID info */
674 kTaskUUIDInfoMissing = 0x200000, /* some UUID info was paged out */
675 kTaskUUIDInfoTriedFault = 0x400000, /* tried to fault in UUID info */
676 kTaskSharedRegionInfoUnavailable = 0x800000, /* shared region info unavailable */
677 kTaskTALEngaged = 0x1000000,
678 /* 0x2000000 unused */
679 kTaskIsDirtyTracked = 0x4000000,
680 kTaskAllowIdleExit = 0x8000000,
681 kTaskIsTranslated = 0x10000000,
682 kTaskSharedRegionNone = 0x20000000, /* task doesn't have a shared region */
683 kTaskSharedRegionSystem = 0x40000000, /* task attached to region with kSharedCacheSystemPrimary set */
684 kTaskSharedRegionOther = 0x80000000, /* task is attached to a different shared region */
685 kTaskDyldCompactInfoNone = 0x100000000,
686 kTaskDyldCompactInfoTooBig = 0x200000000,
687 kTaskDyldCompactInfoFaultedIn = 0x400000000,
688 kTaskDyldCompactInfoMissing = 0x800000000,
689 kTaskDyldCompactInfoTriedFault = 0x1000000000,
690 }; // Note: Add any new flags to kcdata.py (ts_ss_flags)
691
692 enum task_transition_type {
693 kTaskIsTerminated = 0x1,// Past LPEXIT
694 };
695
696 enum thread_snapshot_flags {
697 /* k{User,Kernel}64_p (values 0x1 and 0x2) are defined in generic_snapshot_flags */
698 kHasDispatchSerial = 0x4,
699 kStacksPCOnly = 0x8, /* Stack traces have no frame pointers. */
700 kThreadDarwinBG = 0x10, /* Thread is darwinbg */
701 kThreadIOPassive = 0x20, /* Thread uses passive IO */
702 kThreadSuspended = 0x40, /* Thread is suspended */
703 kThreadTruncatedBT = 0x80, /* Unmapped pages caused truncated backtrace */
704 kGlobalForcedIdle = 0x100, /* Thread performs global forced idle */
705 kThreadFaultedBT = 0x200, /* Some thread stack pages were faulted in as part of BT */
706 kThreadTriedFaultBT = 0x400, /* We tried to fault in thread stack pages as part of BT */
707 kThreadOnCore = 0x800, /* Thread was on-core when we entered debugger context */
708 kThreadIdleWorker = 0x1000, /* Thread is an idle libpthread worker thread */
709 kThreadMain = 0x2000, /* Thread is the main thread */
710 kThreadTruncKernBT = 0x4000, /* Unmapped pages caused truncated kernel BT */
711 kThreadTruncUserBT = 0x8000, /* Unmapped pages caused truncated user BT */
712 kThreadTruncUserAsyncBT = 0x10000, /* Unmapped pages caused truncated user async BT */
713 }; // Note: Add any new flags to kcdata.py (ths_ss_flags)
714
715 struct mem_and_io_snapshot {
716 uint32_t snapshot_magic;
717 uint32_t free_pages;
718 uint32_t active_pages;
719 uint32_t inactive_pages;
720 uint32_t purgeable_pages;
721 uint32_t wired_pages;
722 uint32_t speculative_pages;
723 uint32_t throttled_pages;
724 uint32_t filebacked_pages;
725 uint32_t compressions;
726 uint32_t decompressions;
727 uint32_t compressor_size;
728 int32_t busy_buffer_count;
729 uint32_t pages_wanted;
730 uint32_t pages_reclaimed;
731 uint8_t pages_wanted_reclaimed_valid; // did mach_vm_pressure_monitor succeed?
732 } __attribute__((packed));
733
734 /* SS_TH_* macros are for ths_state */
735 #define SS_TH_WAIT 0x01 /* queued for waiting */
736 #define SS_TH_SUSP 0x02 /* stopped or requested to stop */
737 #define SS_TH_RUN 0x04 /* running or on runq */
738 #define SS_TH_UNINT 0x08 /* waiting uninteruptibly */
739 #define SS_TH_TERMINATE 0x10 /* halted at termination */
740 #define SS_TH_TERMINATE2 0x20 /* added to termination queue */
741 #define SS_TH_IDLE 0x80 /* idling processor */
742
743 struct thread_snapshot_v2 {
744 uint64_t ths_thread_id;
745 uint64_t ths_wait_event;
746 uint64_t ths_continuation;
747 uint64_t ths_total_syscalls;
748 uint64_t ths_voucher_identifier;
749 uint64_t ths_dqserialnum;
750 uint64_t ths_user_time;
751 uint64_t ths_sys_time;
752 uint64_t ths_ss_flags;
753 uint64_t ths_last_run_time;
754 uint64_t ths_last_made_runnable_time;
755 uint32_t ths_state;
756 uint32_t ths_sched_flags;
757 int16_t ths_base_priority;
758 int16_t ths_sched_priority;
759 uint8_t ths_eqos;
760 uint8_t ths_rqos;
761 uint8_t ths_rqos_override;
762 uint8_t ths_io_tier;
763 } __attribute__((packed));
764
765 struct thread_snapshot_v3 {
766 uint64_t ths_thread_id;
767 uint64_t ths_wait_event;
768 uint64_t ths_continuation;
769 uint64_t ths_total_syscalls;
770 uint64_t ths_voucher_identifier;
771 uint64_t ths_dqserialnum;
772 uint64_t ths_user_time;
773 uint64_t ths_sys_time;
774 uint64_t ths_ss_flags;
775 uint64_t ths_last_run_time;
776 uint64_t ths_last_made_runnable_time;
777 uint32_t ths_state;
778 uint32_t ths_sched_flags;
779 int16_t ths_base_priority;
780 int16_t ths_sched_priority;
781 uint8_t ths_eqos;
782 uint8_t ths_rqos;
783 uint8_t ths_rqos_override;
784 uint8_t ths_io_tier;
785 uint64_t ths_thread_t;
786 } __attribute__((packed));
787
788
789 struct thread_snapshot_v4 {
790 uint64_t ths_thread_id;
791 uint64_t ths_wait_event;
792 uint64_t ths_continuation;
793 uint64_t ths_total_syscalls;
794 uint64_t ths_voucher_identifier;
795 uint64_t ths_dqserialnum;
796 uint64_t ths_user_time;
797 uint64_t ths_sys_time;
798 uint64_t ths_ss_flags;
799 uint64_t ths_last_run_time;
800 uint64_t ths_last_made_runnable_time;
801 uint32_t ths_state;
802 uint32_t ths_sched_flags;
803 int16_t ths_base_priority;
804 int16_t ths_sched_priority;
805 uint8_t ths_eqos;
806 uint8_t ths_rqos;
807 uint8_t ths_rqos_override;
808 uint8_t ths_io_tier;
809 uint64_t ths_thread_t;
810 uint64_t ths_requested_policy;
811 uint64_t ths_effective_policy;
812 } __attribute__((packed));
813
814
815 struct thread_group_snapshot {
816 uint64_t tgs_id;
817 char tgs_name[16];
818 } __attribute__((packed));
819
820 /*
821 * In general these flags mirror their THREAD_GROUP_FLAGS_ counterparts.
822 * THREAD_GROUP_FLAGS_UI_APP was repurposed and THREAD_GROUP_FLAGS_APPLICATION
823 * introduced to take its place. To remain compatible, kThreadGroupUIApp is
824 * kept around and kThreadGroupUIApplication introduced.
825 */
826 enum thread_group_flags {
827 kThreadGroupEfficient = 0x1,
828 kThreadGroupApplication = 0x2,
829 kThreadGroupUIApp = 0x2,
830 kThreadGroupCritical = 0x4,
831 kThreadGroupBestEffort = 0x8,
832 kThreadGroupUIApplication = 0x100,
833 kThreadGroupManaged = 0x200,
834 kThreadGroupStrictTimers = 0x400,
835 }; // Note: Add any new flags to kcdata.py (tgs_flags)
836
837 struct thread_group_snapshot_v2 {
838 uint64_t tgs_id;
839 char tgs_name[16];
840 uint64_t tgs_flags;
841 } __attribute__((packed));
842
843 struct thread_group_snapshot_v3 {
844 uint64_t tgs_id;
845 char tgs_name[16];
846 uint64_t tgs_flags;
847 char tgs_name_cont[16];
848 } __attribute__((packed));
849
850 enum coalition_flags {
851 kCoalitionTermRequested = 0x1,
852 kCoalitionTerminated = 0x2,
853 kCoalitionReaped = 0x4,
854 kCoalitionPrivileged = 0x8,
855 }; // Note: Add any new flags to kcdata.py (jcs_flags)
856
857 struct jetsam_coalition_snapshot {
858 uint64_t jcs_id;
859 uint64_t jcs_flags;
860 uint64_t jcs_thread_group;
861 uint64_t jcs_leader_task_uniqueid;
862 } __attribute__((packed));
863
864 struct instrs_cycles_snapshot {
865 uint64_t ics_instructions;
866 uint64_t ics_cycles;
867 } __attribute__((packed));
868
869 struct instrs_cycles_snapshot_v2 {
870 uint64_t ics_instructions;
871 uint64_t ics_cycles;
872 uint64_t ics_p_instructions;
873 uint64_t ics_p_cycles;
874 } __attribute__((packed));
875
876 struct thread_delta_snapshot_v2 {
877 uint64_t tds_thread_id;
878 uint64_t tds_voucher_identifier;
879 uint64_t tds_ss_flags;
880 uint64_t tds_last_made_runnable_time;
881 uint32_t tds_state;
882 uint32_t tds_sched_flags;
883 int16_t tds_base_priority;
884 int16_t tds_sched_priority;
885 uint8_t tds_eqos;
886 uint8_t tds_rqos;
887 uint8_t tds_rqos_override;
888 uint8_t tds_io_tier;
889 } __attribute__ ((packed));
890
891 struct thread_delta_snapshot_v3 {
892 uint64_t tds_thread_id;
893 uint64_t tds_voucher_identifier;
894 uint64_t tds_ss_flags;
895 uint64_t tds_last_made_runnable_time;
896 uint32_t tds_state;
897 uint32_t tds_sched_flags;
898 int16_t tds_base_priority;
899 int16_t tds_sched_priority;
900 uint8_t tds_eqos;
901 uint8_t tds_rqos;
902 uint8_t tds_rqos_override;
903 uint8_t tds_io_tier;
904 uint64_t tds_requested_policy;
905 uint64_t tds_effective_policy;
906 } __attribute__ ((packed));
907
908 struct io_stats_snapshot {
909 /*
910 * I/O Statistics
911 * XXX: These fields must be together.
912 */
913 uint64_t ss_disk_reads_count;
914 uint64_t ss_disk_reads_size;
915 uint64_t ss_disk_writes_count;
916 uint64_t ss_disk_writes_size;
917 uint64_t ss_io_priority_count[STACKSHOT_IO_NUM_PRIORITIES];
918 uint64_t ss_io_priority_size[STACKSHOT_IO_NUM_PRIORITIES];
919 uint64_t ss_paging_count;
920 uint64_t ss_paging_size;
921 uint64_t ss_non_paging_count;
922 uint64_t ss_non_paging_size;
923 uint64_t ss_data_count;
924 uint64_t ss_data_size;
925 uint64_t ss_metadata_count;
926 uint64_t ss_metadata_size;
927 /* XXX: I/O Statistics end */
928 } __attribute__ ((packed));
929
930 struct task_snapshot_v2 {
931 uint64_t ts_unique_pid;
932 uint64_t ts_ss_flags;
933 uint64_t ts_user_time_in_terminated_threads;
934 uint64_t ts_system_time_in_terminated_threads;
935 uint64_t ts_p_start_sec;
936 uint64_t ts_task_size;
937 uint64_t ts_max_resident_size;
938 uint32_t ts_suspend_count;
939 uint32_t ts_faults;
940 uint32_t ts_pageins;
941 uint32_t ts_cow_faults;
942 uint32_t ts_was_throttled;
943 uint32_t ts_did_throttle;
944 uint32_t ts_latency_qos;
945 int32_t ts_pid;
946 char ts_p_comm[32];
947 } __attribute__ ((packed));
948
949 struct transitioning_task_snapshot {
950 uint64_t tts_unique_pid;
951 uint64_t tts_ss_flags;
952 uint64_t tts_transition_type;
953 int32_t tts_pid;
954 char tts_p_comm[32];
955 } __attribute__ ((packed));
956
957 struct task_delta_snapshot_v2 {
958 uint64_t tds_unique_pid;
959 uint64_t tds_ss_flags;
960 uint64_t tds_user_time_in_terminated_threads;
961 uint64_t tds_system_time_in_terminated_threads;
962 uint64_t tds_task_size;
963 uint64_t tds_max_resident_size;
964 uint32_t tds_suspend_count;
965 uint32_t tds_faults;
966 uint32_t tds_pageins;
967 uint32_t tds_cow_faults;
968 uint32_t tds_was_throttled;
969 uint32_t tds_did_throttle;
970 uint32_t tds_latency_qos;
971 } __attribute__ ((packed));
972
973 struct stackshot_task_codesigning_info {
974 uint64_t csflags;
975 uint32_t cs_trust_level;
976 } __attribute__ ((packed));
977
978 struct stackshot_cpu_times {
979 uint64_t user_usec;
980 uint64_t system_usec;
981 } __attribute__((packed));
982
983 struct stackshot_cpu_times_v2 {
984 uint64_t user_usec;
985 uint64_t system_usec;
986 uint64_t runnable_usec;
987 } __attribute__((packed));
988
989 struct stackshot_duration {
990 uint64_t stackshot_duration;
991 uint64_t stackshot_duration_outer;
992 } __attribute__((packed));
993
994 struct stackshot_duration_v2 {
995 uint64_t stackshot_duration;
996 uint64_t stackshot_duration_outer;
997 uint64_t stackshot_duration_prior;
998 } __attribute__((packed));
999
1000 struct stackshot_fault_stats {
1001 uint32_t sfs_pages_faulted_in; /* number of pages faulted in using KDP fault path */
1002 uint64_t sfs_time_spent_faulting; /* MATUs spent faulting */
1003 uint64_t sfs_system_max_fault_time; /* MATUs fault time limit per stackshot */
1004 uint8_t sfs_stopped_faulting; /* we stopped decompressing because we hit the limit */
1005 } __attribute__((packed));
1006
1007 typedef struct stackshot_thread_waitinfo {
1008 uint64_t owner; /* The thread that owns the object */
1009 uint64_t waiter; /* The thread that's waiting on the object */
1010 uint64_t context; /* A context uniquely identifying the object */
1011 uint8_t wait_type; /* The type of object that the thread is waiting on */
1012 } __attribute__((packed)) thread_waitinfo_t;
1013
1014 typedef struct stackshot_thread_waitinfo_v2 {
1015 uint64_t owner; /* The thread that owns the object */
1016 uint64_t waiter; /* The thread that's waiting on the object */
1017 uint64_t context; /* A context uniquely identifying the object */
1018 uint8_t wait_type; /* The type of object that the thread is waiting on */
1019 int16_t portlabel_id; /* matches to a stackshot_portlabel, or NONE or MISSING */
1020 uint32_t wait_flags; /* info about the wait */
1021 #define STACKSHOT_WAITINFO_FLAGS_SPECIALREPLY 0x1 /* We're waiting on a special reply port */
1022 } __attribute__((packed)) thread_waitinfo_v2_t;
1023
1024
1025 typedef struct stackshot_thread_turnstileinfo {
1026 uint64_t waiter; /* The thread that's waiting on the object */
1027 uint64_t turnstile_context; /* Associated data (either thread id, or workq addr) */
1028 uint8_t turnstile_priority;
1029 uint8_t number_of_hops;
1030 uint64_t turnstile_flags; /* see below */
1031 } __attribute__((packed)) thread_turnstileinfo_t;
1032
1033 typedef struct stackshot_thread_turnstileinfo_v2 {
1034 uint64_t waiter; /* The thread that's waiting on the object */
1035 uint64_t turnstile_context; /* Associated data (either thread id, or workq addr) */
1036 uint8_t turnstile_priority;
1037 uint8_t number_of_hops;
1038 #define STACKSHOT_TURNSTILE_STATUS_UNKNOWN 0x01 /* The final inheritor is unknown (bug?) */
1039 #define STACKSHOT_TURNSTILE_STATUS_LOCKED_WAITQ 0x02 /* A waitq was found to be locked */
1040 #define STACKSHOT_TURNSTILE_STATUS_WORKQUEUE 0x04 /* The final inheritor is a workqueue */
1041 #define STACKSHOT_TURNSTILE_STATUS_THREAD 0x08 /* The final inheritor is a thread */
1042 #define STACKSHOT_TURNSTILE_STATUS_BLOCKED_ON_TASK 0x10 /* blocked on task, dind't find thread */
1043 #define STACKSHOT_TURNSTILE_STATUS_HELD_IPLOCK 0x20 /* the ip_lock was held */
1044 #define STACKSHOT_TURNSTILE_STATUS_SENDPORT 0x40 /* port_labelid was from a send port */
1045 #define STACKSHOT_TURNSTILE_STATUS_RECEIVEPORT 0x80 /* port_labelid was from a receive port */
1046 uint64_t turnstile_flags; // Note: Add any new flags to kcdata.py (turnstile_flags)
1047 int16_t portlabel_id; /* matches to a stackshot_portlabel, or NONE or MISSING */
1048 } __attribute__((packed)) thread_turnstileinfo_v2_t;
1049
1050 #define STACKSHOT_TURNSTILE_STATUS_PORTFLAGS (STACKSHOT_TURNSTILE_STATUS_SENDPORT | STACKSHOT_TURNSTILE_STATUS_RECEIVEPORT)
1051
1052 #define STACKSHOT_PORTLABELID_NONE (0) /* No port label found */
1053 #define STACKSHOT_PORTLABELID_MISSING (-1) /* portlabel found, but stackshot ran out of space to track it */
1054
1055 #define STACKSHOT_WAITOWNER_KERNEL (UINT64_MAX - 1)
1056 #define STACKSHOT_WAITOWNER_PORT_LOCKED (UINT64_MAX - 2)
1057 #define STACKSHOT_WAITOWNER_PSET_LOCKED (UINT64_MAX - 3)
1058 #define STACKSHOT_WAITOWNER_INTRANSIT (UINT64_MAX - 4)
1059 #define STACKSHOT_WAITOWNER_MTXSPIN (UINT64_MAX - 5)
1060 #define STACKSHOT_WAITOWNER_THREQUESTED (UINT64_MAX - 6) /* workloop waiting for a new worker thread */
1061 #define STACKSHOT_WAITOWNER_SUSPENDED (UINT64_MAX - 7) /* workloop is suspended */
1062
1063 #define STACKSHOT_PORTLABEL_READFAILED 0x1 /* could not read port information */
1064
1065 struct portlabel_info {
1066 int16_t portlabel_id; /* kcdata-specific ID for this port label */
1067 uint16_t portlabel_flags; /* STACKSHOT_PORTLABEL_* */
1068 uint8_t portlabel_domain; /* launchd domain */
1069 } __attribute__((packed));
1070
1071 struct stackshot_cpu_architecture {
1072 int32_t cputype;
1073 int32_t cpusubtype;
1074 } __attribute__((packed));
1075
1076 struct stack_snapshot_stacktop {
1077 uint64_t sp;
1078 uint8_t stack_contents[8];
1079 };
1080
1081 /* only collected if STACKSHOT_COLLECTS_LATENCY_INFO is set to !0 */
1082 struct stackshot_latency_collection {
1083 uint64_t latency_version;
1084 uint64_t setup_latency;
1085 uint64_t total_task_iteration_latency;
1086 uint64_t total_terminated_task_iteration_latency;
1087 } __attribute__((packed));
1088
1089 /* only collected if STACKSHOT_COLLECTS_LATENCY_INFO is set to !0 */
1090 struct stackshot_latency_task {
1091 uint64_t task_uniqueid;
1092 uint64_t setup_latency;
1093 uint64_t task_thread_count_loop_latency;
1094 uint64_t task_thread_data_loop_latency;
1095 uint64_t cur_tsnap_latency;
1096 uint64_t pmap_latency;
1097 uint64_t bsd_proc_ids_latency;
1098 uint64_t misc_latency;
1099 uint64_t misc2_latency;
1100 uint64_t end_latency;
1101 } __attribute__((packed));
1102
1103 /* only collected if STACKSHOT_COLLECTS_LATENCY_INFO is set to !0 */
1104 struct stackshot_latency_thread {
1105 uint64_t thread_id;
1106 uint64_t cur_thsnap1_latency;
1107 uint64_t dispatch_serial_latency;
1108 uint64_t dispatch_label_latency;
1109 uint64_t cur_thsnap2_latency;
1110 uint64_t thread_name_latency;
1111 uint64_t sur_times_latency;
1112 uint64_t user_stack_latency;
1113 uint64_t kernel_stack_latency;
1114 uint64_t misc_latency;
1115 } __attribute__((packed));
1116
1117
1118 /**************** definitions for crashinfo *********************/
1119
1120 /*
1121 * NOTE: Please update kcdata/libkdd/kcdtypes.c if you make any changes
1122 * in TASK_CRASHINFO_* types.
1123 */
1124
1125 /* FIXME some of these types aren't clean (fixed width, packed, and defined *here*) */
1126
1127 struct crashinfo_proc_uniqidentifierinfo {
1128 uint8_t p_uuid[16]; /* UUID of the main executable */
1129 uint64_t p_uniqueid; /* 64 bit unique identifier for process */
1130 uint64_t p_puniqueid; /* unique identifier for process's parent */
1131 uint64_t p_reserve2; /* reserved for future use */
1132 uint64_t p_reserve3; /* reserved for future use */
1133 uint64_t p_reserve4; /* reserved for future use */
1134 } __attribute__((packed));
1135
1136 #define MAX_TRIAGE_STRING_LEN (128)
1137
1138 struct kernel_triage_info_v1 {
1139 char triage_string1[MAX_TRIAGE_STRING_LEN];
1140 char triage_string2[MAX_TRIAGE_STRING_LEN];
1141 char triage_string3[MAX_TRIAGE_STRING_LEN];
1142 char triage_string4[MAX_TRIAGE_STRING_LEN];
1143 char triage_string5[MAX_TRIAGE_STRING_LEN];
1144 } __attribute__((packed));
1145
1146 #define MAX_CRASHINFO_SIGNING_ID_LEN 64
1147 #define MAX_CRASHINFO_TEAM_ID_LEN 32
1148
1149 #define TASK_CRASHINFO_BEGIN KCDATA_BUFFER_BEGIN_CRASHINFO
1150 #define TASK_CRASHINFO_STRING_DESC KCDATA_TYPE_STRING_DESC
1151 #define TASK_CRASHINFO_UINT32_DESC KCDATA_TYPE_UINT32_DESC
1152 #define TASK_CRASHINFO_UINT64_DESC KCDATA_TYPE_UINT64_DESC
1153
1154 #define TASK_CRASHINFO_EXTMODINFO 0x801
1155 #define TASK_CRASHINFO_BSDINFOWITHUNIQID 0x802 /* struct crashinfo_proc_uniqidentifierinfo */
1156 #define TASK_CRASHINFO_TASKDYLD_INFO 0x803
1157 #define TASK_CRASHINFO_UUID 0x804
1158 #define TASK_CRASHINFO_PID 0x805
1159 #define TASK_CRASHINFO_PPID 0x806
1160 #define TASK_CRASHINFO_RUSAGE 0x807 /* struct rusage DEPRECATED do not use.
1161 * This struct has longs in it */
1162 #define TASK_CRASHINFO_RUSAGE_INFO 0x808 /* struct rusage_info_v3 from resource.h */
1163 #define TASK_CRASHINFO_PROC_NAME 0x809 /* char * */
1164 #define TASK_CRASHINFO_PROC_STARTTIME 0x80B /* struct timeval64 */
1165 #define TASK_CRASHINFO_USERSTACK 0x80C /* uint64_t */
1166 #define TASK_CRASHINFO_ARGSLEN 0x80D
1167 #define TASK_CRASHINFO_EXCEPTION_CODES 0x80E /* mach_exception_data_t */
1168 #define TASK_CRASHINFO_PROC_PATH 0x80F /* string of len MAXPATHLEN */
1169 #define TASK_CRASHINFO_PROC_CSFLAGS 0x810 /* uint32_t */
1170 #define TASK_CRASHINFO_PROC_STATUS 0x811 /* char */
1171 #define TASK_CRASHINFO_UID 0x812 /* uid_t */
1172 #define TASK_CRASHINFO_GID 0x813 /* gid_t */
1173 #define TASK_CRASHINFO_PROC_ARGC 0x814 /* int */
1174 #define TASK_CRASHINFO_PROC_FLAGS 0x815 /* unsigned int */
1175 #define TASK_CRASHINFO_CPUTYPE 0x816 /* cpu_type_t */
1176 #define TASK_CRASHINFO_WORKQUEUEINFO 0x817 /* struct proc_workqueueinfo */
1177 #define TASK_CRASHINFO_RESPONSIBLE_PID 0x818 /* pid_t */
1178 #define TASK_CRASHINFO_DIRTY_FLAGS 0x819 /* int */
1179 #define TASK_CRASHINFO_CRASHED_THREADID 0x81A /* uint64_t */
1180 #define TASK_CRASHINFO_COALITION_ID 0x81B /* uint64_t */
1181 #define TASK_CRASHINFO_UDATA_PTRS 0x81C /* uint64_t */
1182 #define TASK_CRASHINFO_MEMORY_LIMIT 0x81D /* uint64_t */
1183
1184 #define TASK_CRASHINFO_LEDGER_INTERNAL 0x81E /* uint64_t */
1185 #define TASK_CRASHINFO_LEDGER_INTERNAL_COMPRESSED 0x81F /* uint64_t */
1186 #define TASK_CRASHINFO_LEDGER_IOKIT_MAPPED 0x820 /* uint64_t */
1187 #define TASK_CRASHINFO_LEDGER_ALTERNATE_ACCOUNTING 0x821 /* uint64_t */
1188 #define TASK_CRASHINFO_LEDGER_ALTERNATE_ACCOUNTING_COMPRESSED 0x822 /* uint64_t */
1189 #define TASK_CRASHINFO_LEDGER_PURGEABLE_NONVOLATILE 0x823 /* uint64_t */
1190 #define TASK_CRASHINFO_LEDGER_PURGEABLE_NONVOLATILE_COMPRESSED 0x824 /* uint64_t */
1191 #define TASK_CRASHINFO_LEDGER_PAGE_TABLE 0x825 /* uint64_t */
1192 #define TASK_CRASHINFO_LEDGER_PHYS_FOOTPRINT 0x826 /* uint64_t */
1193 #define TASK_CRASHINFO_LEDGER_PHYS_FOOTPRINT_LIFETIME_MAX 0x827 /* uint64_t */
1194 #define TASK_CRASHINFO_LEDGER_NETWORK_NONVOLATILE 0x828 /* uint64_t */
1195 #define TASK_CRASHINFO_LEDGER_NETWORK_NONVOLATILE_COMPRESSED 0x829 /* uint64_t */
1196 #define TASK_CRASHINFO_LEDGER_WIRED_MEM 0x82A /* uint64_t */
1197 #define TASK_CRASHINFO_PROC_PERSONA_ID 0x82B /* uid_t */
1198 #define TASK_CRASHINFO_MEMORY_LIMIT_INCREASE 0x82C /* uint32_t */
1199 #define TASK_CRASHINFO_LEDGER_TAGGED_FOOTPRINT 0x82D /* uint64_t */
1200 #define TASK_CRASHINFO_LEDGER_TAGGED_FOOTPRINT_COMPRESSED 0x82E /* uint64_t */
1201 #define TASK_CRASHINFO_LEDGER_MEDIA_FOOTPRINT 0x82F /* uint64_t */
1202 #define TASK_CRASHINFO_LEDGER_MEDIA_FOOTPRINT_COMPRESSED 0x830 /* uint64_t */
1203 #define TASK_CRASHINFO_LEDGER_GRAPHICS_FOOTPRINT 0x831 /* uint64_t */
1204 #define TASK_CRASHINFO_LEDGER_GRAPHICS_FOOTPRINT_COMPRESSED 0x832 /* uint64_t */
1205 #define TASK_CRASHINFO_LEDGER_NEURAL_FOOTPRINT 0x833 /* uint64_t */
1206 #define TASK_CRASHINFO_LEDGER_NEURAL_FOOTPRINT_COMPRESSED 0x834 /* uint64_t */
1207 #define TASK_CRASHINFO_MEMORYSTATUS_EFFECTIVE_PRIORITY 0x835 /* int32_t */
1208 #define TASK_CRASHINFO_KERNEL_TRIAGE_INFO_V1 0x836 /* struct kernel_triage_info_v1 */
1209
1210 #define TASK_CRASHINFO_TASK_IS_CORPSE_FORK 0x837 /* boolean_t */
1211 #define TASK_CRASHINFO_EXCEPTION_TYPE 0x838 /* int */
1212
1213 #define TASK_CRASHINFO_CRASH_COUNT 0x839 /* int */
1214 #define TASK_CRASHINFO_THROTTLE_TIMEOUT 0x83A /* int */
1215
1216 #define TASK_CRASHINFO_CS_SIGNING_ID 0x83B /* string of len MAX_CRASHINFO_SIGNING_ID_LEN */
1217 #define TASK_CRASHINFO_CS_TEAM_ID 0x83C /* string of len MAX_CRASHINFO_TEAM_ID_LEN */
1218 #define TASK_CRASHINFO_CS_VALIDATION_CATEGORY 0x83D /* uint32_t */
1219 #define TASK_CRASHINFO_CS_TRUST_LEVEL 0x83E /* uint32_t */
1220
1221 #define TASK_CRASHINFO_END KCDATA_TYPE_BUFFER_END
1222
1223 /**************** definitions for backtrace info *********************/
1224
1225 /* tstate is variable length with count elements */
1226 struct btinfo_thread_state_data_t {
1227 uint32_t flavor;
1228 uint32_t count;
1229 int tstate[];
1230 };
1231
1232 struct btinfo_sc_load_info64 {
1233 uint64_t sharedCacheSlide;
1234 uuid_t sharedCacheUUID;
1235 uint64_t sharedCacheBaseAddress;
1236 };
1237
1238 struct btinfo_sc_load_info {
1239 uint32_t sharedCacheSlide;
1240 uuid_t sharedCacheUUID;
1241 uint32_t sharedCacheBaseAddress;
1242 };
1243
1244 #define TASK_BTINFO_BEGIN KCDATA_BUFFER_BEGIN_BTINFO
1245
1246 /* Shared keys with CRASHINFO */
1247 #define TASK_BTINFO_PID 0xA01
1248 #define TASK_BTINFO_PPID 0xA02
1249 #define TASK_BTINFO_PROC_NAME 0xA03
1250 #define TASK_BTINFO_PROC_PATH 0xA04
1251 #define TASK_BTINFO_UID 0xA05
1252 #define TASK_BTINFO_GID 0xA06
1253 #define TASK_BTINFO_PROC_FLAGS 0xA07
1254 #define TASK_BTINFO_CPUTYPE 0xA08
1255 #define TASK_BTINFO_EXCEPTION_CODES 0xA09
1256 #define TASK_BTINFO_EXCEPTION_TYPE 0xA0A
1257 #define TASK_BTINFO_RUSAGE_INFO 0xA0B
1258 #define TASK_BTINFO_COALITION_ID 0xA0C
1259 #define TASK_BTINFO_CRASH_COUNT 0xA0D
1260 #define TASK_BTINFO_THROTTLE_TIMEOUT 0xA0E
1261
1262 /* Only in BTINFO */
1263 #define TASK_BTINFO_THREAD_ID 0xA20 /* uint64_t */
1264 #define TASK_BTINFO_THREAD_NAME 0xA21 /* string of len MAXTHREADNAMESIZE */
1265 #define TASK_BTINFO_THREAD_STATE 0xA22 /* struct btinfo_thread_state_data_t */
1266 #define TASK_BTINFO_THREAD_EXCEPTION_STATE 0xA23 /* struct btinfo_thread_state_data_t */
1267 #define TASK_BTINFO_BACKTRACE 0xA24 /* array of uintptr_t */
1268 #define TASK_BTINFO_BACKTRACE64 0xA25 /* array of uintptr_t */
1269 #define TASK_BTINFO_ASYNC_BACKTRACE64 0xA26 /* array of uintptr_t */
1270 #define TASK_BTINFO_ASYNC_START_INDEX 0xA27 /* uint32_t */
1271 #define TASK_BTINFO_PLATFORM 0xA28 /* uint32_t */
1272 #define TASK_BTINFO_SC_LOADINFO 0xA29 /* struct btinfo_sc_load_info */
1273 #define TASK_BTINFO_SC_LOADINFO64 0xA2A /* struct btinfo_sc_load_info64 */
1274
1275 #define TASK_BTINFO_DYLD_LOADINFO KCDATA_TYPE_LIBRARY_LOADINFO
1276 #define TASK_BTINFO_DYLD_LOADINFO64 KCDATA_TYPE_LIBRARY_LOADINFO64
1277
1278 /* Last one */
1279 #define TASK_BTINFO_FLAGS 0xAFF /* uint32_t */
1280 #define TASK_BTINFO_FLAG_BT_TRUNCATED 0x1
1281 #define TASK_BTINFO_FLAG_ASYNC_BT_TRUNCATED 0x2
1282 #define TASK_BTINFO_FLAG_TASK_TERMINATED 0x4 /* task is terminated */
1283 #define TASK_BTINFO_FLAG_KCDATA_INCOMPLETE 0x8 /* lw corpse collection is incomplete */
1284
1285 #define TASK_BTINFO_END KCDATA_TYPE_BUFFER_END
1286
1287 /**************** definitions for os reasons *********************/
1288
1289 #define EXIT_REASON_SNAPSHOT 0x1001
1290 #define EXIT_REASON_USER_DESC 0x1002 /* string description of reason */
1291 #define EXIT_REASON_USER_PAYLOAD 0x1003 /* user payload data */
1292 #define EXIT_REASON_CODESIGNING_INFO 0x1004
1293 #define EXIT_REASON_WORKLOOP_ID 0x1005
1294 #define EXIT_REASON_DISPATCH_QUEUE_NO 0x1006
1295
1296 struct exit_reason_snapshot {
1297 uint32_t ers_namespace;
1298 uint64_t ers_code;
1299 /* end of version 1 of exit_reason_snapshot. sizeof v1 was 12 */
1300 uint64_t ers_flags;
1301 } __attribute__((packed));
1302
1303 #define EXIT_REASON_CODESIG_PATH_MAX 1024
1304
1305 struct codesigning_exit_reason_info {
1306 uint64_t ceri_virt_addr;
1307 uint64_t ceri_file_offset;
1308 char ceri_pathname[EXIT_REASON_CODESIG_PATH_MAX];
1309 char ceri_filename[EXIT_REASON_CODESIG_PATH_MAX];
1310 uint64_t ceri_codesig_modtime_secs;
1311 uint64_t ceri_codesig_modtime_nsecs;
1312 uint64_t ceri_page_modtime_secs;
1313 uint64_t ceri_page_modtime_nsecs;
1314 uint8_t ceri_path_truncated;
1315 uint8_t ceri_object_codesigned;
1316 uint8_t ceri_page_codesig_validated;
1317 uint8_t ceri_page_codesig_tainted;
1318 uint8_t ceri_page_codesig_nx;
1319 uint8_t ceri_page_wpmapped;
1320 uint8_t ceri_page_slid;
1321 uint8_t ceri_page_dirty;
1322 uint32_t ceri_page_shadow_depth;
1323 } __attribute__((packed));
1324
1325 #define EXIT_REASON_USER_DESC_MAX_LEN 1024
1326 #define EXIT_REASON_PAYLOAD_MAX_LEN 2048
1327 /**************** safe iterators *********************/
1328 #if !__has_ptrcheck
1329
1330 typedef struct kcdata_iter {
1331 kcdata_item_t item;
1332 void *end;
1333 } kcdata_iter_t;
1334
1335
1336 static inline
1337 kcdata_iter_t
kcdata_iter(void * buffer,unsigned long size)1338 kcdata_iter(void *buffer, unsigned long size)
1339 {
1340 kcdata_iter_t iter;
1341 iter.item = (kcdata_item_t) buffer;
1342 iter.end = (void*) (((uintptr_t)buffer) + size);
1343 return iter;
1344 }
1345
1346 static inline
1347 kcdata_iter_t kcdata_iter_unsafe(void *buffer) __attribute__((deprecated));
1348
1349 static inline
1350 kcdata_iter_t
kcdata_iter_unsafe(void * buffer)1351 kcdata_iter_unsafe(void *buffer)
1352 {
1353 kcdata_iter_t iter;
1354 iter.item = (kcdata_item_t) buffer;
1355 iter.end = (void*) (uintptr_t) ~0;
1356 return iter;
1357 }
1358
1359 static const kcdata_iter_t kcdata_invalid_iter = { .item = NULL, .end = NULL };
1360
1361 static inline
1362 int
kcdata_iter_valid(kcdata_iter_t iter)1363 kcdata_iter_valid(kcdata_iter_t iter)
1364 {
1365 return
1366 ((uintptr_t)iter.item + sizeof(struct kcdata_item) <= (uintptr_t)iter.end) &&
1367 ((uintptr_t)iter.item + sizeof(struct kcdata_item) + iter.item->size <= (uintptr_t)iter.end);
1368 }
1369
1370
1371 static inline
1372 kcdata_iter_t
kcdata_iter_next(kcdata_iter_t iter)1373 kcdata_iter_next(kcdata_iter_t iter)
1374 {
1375 iter.item = (kcdata_item_t) (((uintptr_t)iter.item) + sizeof(struct kcdata_item) + (iter.item->size));
1376 return iter;
1377 }
1378
1379 static inline uint32_t
kcdata_iter_type(kcdata_iter_t iter)1380 kcdata_iter_type(kcdata_iter_t iter)
1381 {
1382 if ((iter.item->type & ~0xfu) == KCDATA_TYPE_ARRAY_PAD0) {
1383 return KCDATA_TYPE_ARRAY;
1384 } else {
1385 return iter.item->type;
1386 }
1387 }
1388
1389 static inline uint32_t
kcdata_calc_padding(uint32_t size)1390 kcdata_calc_padding(uint32_t size)
1391 {
1392 /* calculate number of bytes to add to size to get something divisible by 16 */
1393 return (-size) & 0xf;
1394 }
1395
1396 static inline uint32_t
kcdata_flags_get_padding(uint64_t flags)1397 kcdata_flags_get_padding(uint64_t flags)
1398 {
1399 return flags & KCDATA_FLAGS_STRUCT_PADDING_MASK;
1400 }
1401
1402 /* see comment above about has_padding */
1403 static inline int
kcdata_iter_is_legacy_item(kcdata_iter_t iter,uint32_t legacy_size)1404 kcdata_iter_is_legacy_item(kcdata_iter_t iter, uint32_t legacy_size)
1405 {
1406 uint32_t legacy_size_padded = legacy_size + kcdata_calc_padding(legacy_size);
1407 return iter.item->size == legacy_size_padded &&
1408 (iter.item->flags & (KCDATA_FLAGS_STRUCT_PADDING_MASK | KCDATA_FLAGS_STRUCT_HAS_PADDING)) == 0;
1409 }
1410
1411 static inline uint32_t
kcdata_iter_size(kcdata_iter_t iter)1412 kcdata_iter_size(kcdata_iter_t iter)
1413 {
1414 uint32_t legacy_size = 0;
1415
1416 switch (kcdata_iter_type(iter)) {
1417 case KCDATA_TYPE_ARRAY:
1418 case KCDATA_TYPE_CONTAINER_BEGIN:
1419 return iter.item->size;
1420 case STACKSHOT_KCTYPE_THREAD_SNAPSHOT: {
1421 legacy_size = sizeof(struct thread_snapshot_v2);
1422 if (kcdata_iter_is_legacy_item(iter, legacy_size)) {
1423 return legacy_size;
1424 }
1425
1426 goto not_legacy;
1427 }
1428 case STACKSHOT_KCTYPE_SHAREDCACHE_LOADINFO: {
1429 legacy_size = sizeof(struct dyld_uuid_info_64);
1430 if (kcdata_iter_is_legacy_item(iter, legacy_size)) {
1431 return legacy_size;
1432 }
1433
1434 goto not_legacy;
1435 }
1436 not_legacy:
1437 default:
1438 if (iter.item->size < kcdata_flags_get_padding(iter.item->flags)) {
1439 return 0;
1440 } else {
1441 return iter.item->size - kcdata_flags_get_padding(iter.item->flags);
1442 }
1443 }
1444 }
1445
1446 static inline uint64_t
kcdata_iter_flags(kcdata_iter_t iter)1447 kcdata_iter_flags(kcdata_iter_t iter)
1448 {
1449 return iter.item->flags;
1450 }
1451
1452 static inline
1453 void *
kcdata_iter_payload(kcdata_iter_t iter)1454 kcdata_iter_payload(kcdata_iter_t iter)
1455 {
1456 return &iter.item->data;
1457 }
1458
1459
1460 static inline
1461 uint32_t
kcdata_iter_array_elem_type(kcdata_iter_t iter)1462 kcdata_iter_array_elem_type(kcdata_iter_t iter)
1463 {
1464 return (iter.item->flags >> 32) & UINT32_MAX;
1465 }
1466
1467 static inline
1468 uint32_t
kcdata_iter_array_elem_count(kcdata_iter_t iter)1469 kcdata_iter_array_elem_count(kcdata_iter_t iter)
1470 {
1471 return (iter.item->flags) & UINT32_MAX;
1472 }
1473
1474 /* KCDATA_TYPE_ARRAY is ambiguous about the size of the array elements. Size is
1475 * calculated as total_size / elements_count, but total size got padded out to a
1476 * 16 byte alignment. New kernels will generate KCDATA_TYPE_ARRAY_PAD* instead
1477 * to explicitly tell us how much padding was used. Here we have a fixed, never
1478 * to be altered list of the sizes of array elements that were used before I
1479 * discovered this issue. If you find a KCDATA_TYPE_ARRAY that is not one of
1480 * these types, treat it as invalid data. */
1481
1482 static inline
1483 uint32_t
kcdata_iter_array_size_switch(kcdata_iter_t iter)1484 kcdata_iter_array_size_switch(kcdata_iter_t iter)
1485 {
1486 switch (kcdata_iter_array_elem_type(iter)) {
1487 case KCDATA_TYPE_LIBRARY_LOADINFO:
1488 return sizeof(struct dyld_uuid_info_32);
1489 case KCDATA_TYPE_LIBRARY_LOADINFO64:
1490 return sizeof(struct dyld_uuid_info_64);
1491 case STACKSHOT_KCTYPE_KERN_STACKFRAME:
1492 case STACKSHOT_KCTYPE_USER_STACKFRAME:
1493 return sizeof(struct stack_snapshot_frame32);
1494 case STACKSHOT_KCTYPE_KERN_STACKFRAME64:
1495 case STACKSHOT_KCTYPE_USER_STACKFRAME64:
1496 return sizeof(struct stack_snapshot_frame64);
1497 case STACKSHOT_KCTYPE_DONATING_PIDS:
1498 return sizeof(int32_t);
1499 case STACKSHOT_KCTYPE_THREAD_DELTA_SNAPSHOT:
1500 return sizeof(struct thread_delta_snapshot_v2);
1501 // This one is only here to make some unit tests work. It should be OK to
1502 // remove.
1503 case TASK_CRASHINFO_CRASHED_THREADID:
1504 return sizeof(uint64_t);
1505 default:
1506 return 0;
1507 }
1508 }
1509
1510 static inline
1511 int
kcdata_iter_array_valid(kcdata_iter_t iter)1512 kcdata_iter_array_valid(kcdata_iter_t iter)
1513 {
1514 if (!kcdata_iter_valid(iter)) {
1515 return 0;
1516 }
1517 if (kcdata_iter_type(iter) != KCDATA_TYPE_ARRAY) {
1518 return 0;
1519 }
1520 if (kcdata_iter_array_elem_count(iter) == 0) {
1521 return iter.item->size == 0;
1522 }
1523 if (iter.item->type == KCDATA_TYPE_ARRAY) {
1524 uint32_t elem_size = kcdata_iter_array_size_switch(iter);
1525 if (elem_size == 0) {
1526 return 0;
1527 }
1528 /* sizes get aligned to the nearest 16. */
1529 return
1530 kcdata_iter_array_elem_count(iter) <= iter.item->size / elem_size &&
1531 iter.item->size % kcdata_iter_array_elem_count(iter) < 16;
1532 } else {
1533 return
1534 (iter.item->type & 0xf) <= iter.item->size &&
1535 kcdata_iter_array_elem_count(iter) <= iter.item->size - (iter.item->type & 0xf) &&
1536 (iter.item->size - (iter.item->type & 0xf)) % kcdata_iter_array_elem_count(iter) == 0;
1537 }
1538 }
1539
1540
1541 static inline
1542 uint32_t
kcdata_iter_array_elem_size(kcdata_iter_t iter)1543 kcdata_iter_array_elem_size(kcdata_iter_t iter)
1544 {
1545 if (iter.item->type == KCDATA_TYPE_ARRAY) {
1546 return kcdata_iter_array_size_switch(iter);
1547 }
1548 if (kcdata_iter_array_elem_count(iter) == 0) {
1549 return 0;
1550 }
1551 return (iter.item->size - (iter.item->type & 0xf)) / kcdata_iter_array_elem_count(iter);
1552 }
1553
1554 static inline
1555 int
kcdata_iter_container_valid(kcdata_iter_t iter)1556 kcdata_iter_container_valid(kcdata_iter_t iter)
1557 {
1558 return
1559 kcdata_iter_valid(iter) &&
1560 kcdata_iter_type(iter) == KCDATA_TYPE_CONTAINER_BEGIN &&
1561 iter.item->size >= sizeof(uint32_t);
1562 }
1563
1564 static inline
1565 uint32_t
kcdata_iter_container_type(kcdata_iter_t iter)1566 kcdata_iter_container_type(kcdata_iter_t iter)
1567 {
1568 return *(uint32_t *) kcdata_iter_payload(iter);
1569 }
1570
1571 static inline
1572 uint64_t
kcdata_iter_container_id(kcdata_iter_t iter)1573 kcdata_iter_container_id(kcdata_iter_t iter)
1574 {
1575 return iter.item->flags;
1576 }
1577
1578
1579 #define KCDATA_ITER_FOREACH(iter) for(; kcdata_iter_valid(iter) && iter.item->type != KCDATA_TYPE_BUFFER_END; iter = kcdata_iter_next(iter))
1580 #define KCDATA_ITER_FOREACH_FAILED(iter) (!kcdata_iter_valid(iter) || (iter).item->type != KCDATA_TYPE_BUFFER_END)
1581
1582 static inline
1583 kcdata_iter_t
kcdata_iter_find_type(kcdata_iter_t iter,uint32_t type)1584 kcdata_iter_find_type(kcdata_iter_t iter, uint32_t type)
1585 {
1586 KCDATA_ITER_FOREACH(iter)
1587 {
1588 if (kcdata_iter_type(iter) == type) {
1589 return iter;
1590 }
1591 }
1592 return kcdata_invalid_iter;
1593 }
1594
1595 static inline
1596 int
kcdata_iter_data_with_desc_valid(kcdata_iter_t iter,uint32_t minsize)1597 kcdata_iter_data_with_desc_valid(kcdata_iter_t iter, uint32_t minsize)
1598 {
1599 return
1600 kcdata_iter_valid(iter) &&
1601 kcdata_iter_size(iter) >= KCDATA_DESC_MAXLEN + minsize &&
1602 ((char*)kcdata_iter_payload(iter))[KCDATA_DESC_MAXLEN - 1] == 0;
1603 }
1604
1605 static inline
1606 char *
kcdata_iter_string(kcdata_iter_t iter,uint32_t offset)1607 kcdata_iter_string(kcdata_iter_t iter, uint32_t offset)
1608 {
1609 if (offset > kcdata_iter_size(iter)) {
1610 return NULL;
1611 }
1612 uint32_t maxlen = kcdata_iter_size(iter) - offset;
1613 char *s = ((char*)kcdata_iter_payload(iter)) + offset;
1614 if (strnlen(s, maxlen) < maxlen) {
1615 return s;
1616 } else {
1617 return NULL;
1618 }
1619 }
1620
1621 static inline void
kcdata_iter_get_data_with_desc(kcdata_iter_t iter,char ** desc_ptr,void ** data_ptr,uint32_t * size_ptr)1622 kcdata_iter_get_data_with_desc(kcdata_iter_t iter, char **desc_ptr, void **data_ptr, uint32_t *size_ptr)
1623 {
1624 if (desc_ptr) {
1625 *desc_ptr = (char *)kcdata_iter_payload(iter);
1626 }
1627 if (data_ptr) {
1628 *data_ptr = (void *)((uintptr_t)kcdata_iter_payload(iter) + KCDATA_DESC_MAXLEN);
1629 }
1630 if (size_ptr) {
1631 *size_ptr = kcdata_iter_size(iter) - KCDATA_DESC_MAXLEN;
1632 }
1633 }
1634
1635 #endif /* !__has_ptrcheck */
1636 #endif
1637