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 amunt 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 emmitted 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_OS_REASON 0x53A20900u /* owner: sys/reason.h */
469 /* type-range: 0x1000-0x103f */
470 #define KCDATA_BUFFER_BEGIN_XNUPOST_CONFIG 0x1e21c09fu /* owner: osfmk/tests/kernel_tests.c */
471 /* type-range: 0x1040-0x105f */
472
473 /* next type range number available 0x1060 */
474 /**************** definitions for XNUPOST *********************/
475 #define XNUPOST_KCTYPE_TESTCONFIG 0x1040
476
477 /**************** definitions for stackshot *********************/
478
479 /* This value must always match IO_NUM_PRIORITIES defined in thread_info.h */
480 #define STACKSHOT_IO_NUM_PRIORITIES 4
481 /* This value must always match MAXTHREADNAMESIZE used in bsd */
482 #define STACKSHOT_MAX_THREAD_NAME_SIZE 64
483
484 /*
485 * NOTE: Please update kcdata/libkdd/kcdtypes.c if you make any changes
486 * in STACKSHOT_KCTYPE_* types.
487 */
488 #define STACKSHOT_KCTYPE_IOSTATS 0x901u /* io_stats_snapshot */
489 #define STACKSHOT_KCTYPE_GLOBAL_MEM_STATS 0x902u /* struct mem_and_io_snapshot */
490 #define STACKSHOT_KCCONTAINER_TASK 0x903u
491 #define STACKSHOT_KCCONTAINER_THREAD 0x904u
492 #define STACKSHOT_KCTYPE_TASK_SNAPSHOT 0x905u /* task_snapshot_v2 */
493 #define STACKSHOT_KCTYPE_THREAD_SNAPSHOT 0x906u /* thread_snapshot_v2, thread_snapshot_v3 */
494 #define STACKSHOT_KCTYPE_DONATING_PIDS 0x907u /* int[] */
495 #define STACKSHOT_KCTYPE_SHAREDCACHE_LOADINFO 0x908u /* dyld_shared_cache_loadinfo */
496 #define STACKSHOT_KCTYPE_THREAD_NAME 0x909u /* char[] */
497 #define STACKSHOT_KCTYPE_KERN_STACKFRAME 0x90Au /* struct stack_snapshot_frame32 */
498 #define STACKSHOT_KCTYPE_KERN_STACKFRAME64 0x90Bu /* struct stack_snapshot_frame64 */
499 #define STACKSHOT_KCTYPE_USER_STACKFRAME 0x90Cu /* struct stack_snapshot_frame32 */
500 #define STACKSHOT_KCTYPE_USER_STACKFRAME64 0x90Du /* struct stack_snapshot_frame64 */
501 #define STACKSHOT_KCTYPE_BOOTARGS 0x90Eu /* boot args string */
502 #define STACKSHOT_KCTYPE_OSVERSION 0x90Fu /* os version string */
503 #define STACKSHOT_KCTYPE_KERN_PAGE_SIZE 0x910u /* kernel page size in uint32_t */
504 #define STACKSHOT_KCTYPE_JETSAM_LEVEL 0x911u /* jetsam level in uint32_t */
505 #define STACKSHOT_KCTYPE_DELTA_SINCE_TIMESTAMP 0x912u /* timestamp used for the delta stackshot */
506 #define STACKSHOT_KCTYPE_KERN_STACKLR 0x913u /* uint32_t */
507 #define STACKSHOT_KCTYPE_KERN_STACKLR64 0x914u /* uint64_t */
508 #define STACKSHOT_KCTYPE_USER_STACKLR 0x915u /* uint32_t */
509 #define STACKSHOT_KCTYPE_USER_STACKLR64 0x916u /* uint64_t */
510 #define STACKSHOT_KCTYPE_NONRUNNABLE_TIDS 0x917u /* uint64_t */
511 #define STACKSHOT_KCTYPE_NONRUNNABLE_TASKS 0x918u /* uint64_t */
512 #define STACKSHOT_KCTYPE_CPU_TIMES 0x919u /* struct stackshot_cpu_times or stackshot_cpu_times_v2 */
513 #define STACKSHOT_KCTYPE_STACKSHOT_DURATION 0x91au /* struct stackshot_duration */
514 #define STACKSHOT_KCTYPE_STACKSHOT_FAULT_STATS 0x91bu /* struct stackshot_fault_stats */
515 #define STACKSHOT_KCTYPE_KERNELCACHE_LOADINFO 0x91cu /* kernelcache UUID -- same as KCDATA_TYPE_LIBRARY_LOADINFO64 */
516 #define STACKSHOT_KCTYPE_THREAD_WAITINFO 0x91du /* struct stackshot_thread_waitinfo */
517 #define STACKSHOT_KCTYPE_THREAD_GROUP_SNAPSHOT 0x91eu /* struct thread_group_snapshot or thread_group_snapshot_v2 */
518 #define STACKSHOT_KCTYPE_THREAD_GROUP 0x91fu /* uint64_t */
519 #define STACKSHOT_KCTYPE_JETSAM_COALITION_SNAPSHOT 0x920u /* struct jetsam_coalition_snapshot */
520 #define STACKSHOT_KCTYPE_JETSAM_COALITION 0x921u /* uint64_t */
521 #define STACKSHOT_KCTYPE_THREAD_POLICY_VERSION 0x922u /* THREAD_POLICY_INTERNAL_STRUCT_VERSION in uint32 */
522 #define STACKSHOT_KCTYPE_INSTRS_CYCLES 0x923u /* struct instrs_cycles_snapshot */
523 #define STACKSHOT_KCTYPE_USER_STACKTOP 0x924u /* struct stack_snapshot_stacktop */
524 #define STACKSHOT_KCTYPE_ASID 0x925u /* uint32_t */
525 #define STACKSHOT_KCTYPE_PAGE_TABLES 0x926u /* uint64_t */
526 #define STACKSHOT_KCTYPE_SYS_SHAREDCACHE_LAYOUT 0x927u /* same as KCDATA_TYPE_LIBRARY_LOADINFO64 */
527 #define STACKSHOT_KCTYPE_THREAD_DISPATCH_QUEUE_LABEL 0x928u /* dispatch queue label */
528 #define STACKSHOT_KCTYPE_THREAD_TURNSTILEINFO 0x929u /* struct stackshot_thread_turnstileinfo */
529 #define STACKSHOT_KCTYPE_TASK_CPU_ARCHITECTURE 0x92au /* struct stackshot_cpu_architecture */
530 #define STACKSHOT_KCTYPE_LATENCY_INFO 0x92bu /* struct stackshot_latency_collection */
531 #define STACKSHOT_KCTYPE_LATENCY_INFO_TASK 0x92cu /* struct stackshot_latency_task */
532 #define STACKSHOT_KCTYPE_LATENCY_INFO_THREAD 0x92du /* struct stackshot_latency_thread */
533 #define STACKSHOT_KCTYPE_LOADINFO64_TEXT_EXEC 0x92eu /* TEXT_EXEC load info -- same as KCDATA_TYPE_LIBRARY_LOADINFO64 */
534 #define STACKSHOT_KCTYPE_AOTCACHE_LOADINFO 0x92fu /* struct dyld_aot_cache_uuid_info */
535 #define STACKSHOT_KCTYPE_TRANSITIONING_TASK_SNAPSHOT 0x930u /* transitioning_task_snapshot */
536 #define STACKSHOT_KCCONTAINER_TRANSITIONING_TASK 0x931u
537 #define STACKSHOT_KCTYPE_USER_ASYNC_START_INDEX 0x932u /* uint32_t index in user_stack of beginning of async stack */
538 #define STACKSHOT_KCTYPE_USER_ASYNC_STACKLR64 0x933u /* uint64_t async stack pointers */
539
540 #define STACKSHOT_KCTYPE_TASK_DELTA_SNAPSHOT 0x940u /* task_delta_snapshot_v2 */
541 #define STACKSHOT_KCTYPE_THREAD_DELTA_SNAPSHOT 0x941u /* thread_delta_snapshot_v* */
542
543 struct stack_snapshot_frame32 {
544 uint32_t lr;
545 uint32_t sp;
546 };
547
548 struct stack_snapshot_frame64 {
549 uint64_t lr;
550 uint64_t sp;
551 };
552
553 struct dyld_uuid_info_32 {
554 uint32_t imageLoadAddress; /* base address image is mapped at */
555 uuid_t imageUUID;
556 };
557
558 struct dyld_uuid_info_64 {
559 uint64_t imageLoadAddress; /* XXX image slide */
560 uuid_t imageUUID;
561 };
562
563 /*
564 * N.B.: Newer kernels output dyld_shared_cache_loadinfo structures
565 * instead of this, since the field names match their contents better.
566 */
567 struct dyld_uuid_info_64_v2 {
568 uint64_t imageLoadAddress; /* XXX image slide */
569 uuid_t imageUUID;
570 /* end of version 1 of dyld_uuid_info_64. sizeof v1 was 24 */
571 uint64_t imageSlidBaseAddress; /* slid base address or slid first mapping of image */
572 };
573
574 /*
575 * This is the renamed version of dyld_uuid_info_64 with more accurate
576 * field names, for STACKSHOT_KCTYPE_SHAREDCACHE_LOADINFO. Any users
577 * must be aware of the dyld_uuid_info_64* version history and ensure
578 * the fields they are accessing are within the actual bounds.
579 *
580 * OLD_FIELD NEW_FIELD
581 * imageLoadAddress sharedCacheSlide
582 * imageUUID sharedCacheUUID
583 * imageSlidBaseAddress sharedCacheUnreliableSlidBaseAddress
584 * - sharedCacheSlidFirstMapping
585 */
586 struct dyld_shared_cache_loadinfo {
587 uint64_t sharedCacheSlide; /* image slide value */
588 uuid_t sharedCacheUUID;
589 /* end of version 1 of dyld_uuid_info_64. sizeof v1 was 24 */
590 uint64_t sharedCacheUnreliableSlidBaseAddress; /* for backwards-compatibility; use sharedCacheSlidFirstMapping if available */
591 /* end of version 2 of dyld_uuid_info_64. sizeof v2 was 32 */
592 uint64_t sharedCacheSlidFirstMapping; /* slid base address of first mapping */
593 };
594
595 struct dyld_aot_cache_uuid_info {
596 uint64_t x86SlidBaseAddress; /* slid first mapping address of x86 shared cache */
597 uuid_t x86UUID; /* UUID of x86 shared cache */
598 uint64_t aotSlidBaseAddress; /* slide first mapping address of aot cache */
599 uuid_t aotUUID; /* UUID of aot shared cache */
600 };
601
602 struct user32_dyld_uuid_info {
603 uint32_t imageLoadAddress; /* base address image is mapped into */
604 uuid_t imageUUID; /* UUID of image */
605 };
606
607 struct user64_dyld_uuid_info {
608 uint64_t imageLoadAddress; /* base address image is mapped into */
609 uuid_t imageUUID; /* UUID of image */
610 };
611
612 #define DYLD_AOT_IMAGE_KEY_SIZE 32
613
614 struct user64_dyld_aot_info {
615 uint64_t x86LoadAddress;
616 uint64_t aotLoadAddress;
617 uint64_t aotImageSize;
618 uint8_t aotImageKey[DYLD_AOT_IMAGE_KEY_SIZE];
619 };
620
621 enum task_snapshot_flags {
622 /* k{User,Kernel}64_p (values 0x1 and 0x2) are defined in generic_snapshot_flags */
623 kTaskRsrcFlagged = 0x4, // In the EXC_RESOURCE danger zone?
624 kTerminatedSnapshot = 0x8,
625 kPidSuspended = 0x10, // true for suspended task
626 kFrozen = 0x20, // true for hibernated task (along with pidsuspended)
627 kTaskDarwinBG = 0x40,
628 kTaskExtDarwinBG = 0x80,
629 kTaskVisVisible = 0x100,
630 kTaskVisNonvisible = 0x200,
631 kTaskIsForeground = 0x400,
632 kTaskIsBoosted = 0x800,
633 kTaskIsSuppressed = 0x1000,
634 kTaskIsTimerThrottled = 0x2000, /* deprecated */
635 kTaskIsImpDonor = 0x4000,
636 kTaskIsLiveImpDonor = 0x8000,
637 kTaskIsDirty = 0x10000,
638 kTaskWqExceededConstrainedThreadLimit = 0x20000,
639 kTaskWqExceededTotalThreadLimit = 0x40000,
640 kTaskWqFlagsAvailable = 0x80000,
641 kTaskUUIDInfoFaultedIn = 0x100000, /* successfully faulted in some UUID info */
642 kTaskUUIDInfoMissing = 0x200000, /* some UUID info was paged out */
643 kTaskUUIDInfoTriedFault = 0x400000, /* tried to fault in UUID info */
644 kTaskSharedRegionInfoUnavailable = 0x800000, /* shared region info unavailable */
645 kTaskTALEngaged = 0x1000000,
646 /* 0x2000000 unused */
647 kTaskIsDirtyTracked = 0x4000000,
648 kTaskAllowIdleExit = 0x8000000,
649 kTaskIsTranslated = 0x10000000,
650 kTaskSharedRegionNone = 0x20000000, /* task doesn't have a shared region */
651 kTaskSharedRegionSystem = 0x40000000, /* task is attached to system shared region */
652 kTaskSharedRegionOther = 0x80000000, /* task is attached to a different shared region */
653 }; // Note: Add any new flags to kcdata.py (ts_ss_flags)
654
655 enum task_transition_type {
656 kTaskIsTerminated = 0x1,// Past LPEXIT
657 };
658
659 enum thread_snapshot_flags {
660 /* k{User,Kernel}64_p (values 0x1 and 0x2) are defined in generic_snapshot_flags */
661 kHasDispatchSerial = 0x4,
662 kStacksPCOnly = 0x8, /* Stack traces have no frame pointers. */
663 kThreadDarwinBG = 0x10, /* Thread is darwinbg */
664 kThreadIOPassive = 0x20, /* Thread uses passive IO */
665 kThreadSuspended = 0x40, /* Thread is suspended */
666 kThreadTruncatedBT = 0x80, /* Unmapped pages caused truncated backtrace */
667 kGlobalForcedIdle = 0x100, /* Thread performs global forced idle */
668 kThreadFaultedBT = 0x200, /* Some thread stack pages were faulted in as part of BT */
669 kThreadTriedFaultBT = 0x400, /* We tried to fault in thread stack pages as part of BT */
670 kThreadOnCore = 0x800, /* Thread was on-core when we entered debugger context */
671 kThreadIdleWorker = 0x1000, /* Thread is an idle libpthread worker thread */
672 kThreadMain = 0x2000, /* Thread is the main thread */
673 kThreadTruncKernBT = 0x4000, /* Unmapped pages caused truncated kernel BT */
674 kThreadTruncUserBT = 0x8000, /* Unmapped pages caused truncated user BT */
675 kThreadTruncUserAsyncBT = 0x10000, /* Unmapped pages caused truncated user async BT */
676 }; // Note: Add any new flags to kcdata.py (ths_ss_flags)
677
678 struct mem_and_io_snapshot {
679 uint32_t snapshot_magic;
680 uint32_t free_pages;
681 uint32_t active_pages;
682 uint32_t inactive_pages;
683 uint32_t purgeable_pages;
684 uint32_t wired_pages;
685 uint32_t speculative_pages;
686 uint32_t throttled_pages;
687 uint32_t filebacked_pages;
688 uint32_t compressions;
689 uint32_t decompressions;
690 uint32_t compressor_size;
691 int32_t busy_buffer_count;
692 uint32_t pages_wanted;
693 uint32_t pages_reclaimed;
694 uint8_t pages_wanted_reclaimed_valid; // did mach_vm_pressure_monitor succeed?
695 } __attribute__((packed));
696
697 /* SS_TH_* macros are for ths_state */
698 #define SS_TH_WAIT 0x01 /* queued for waiting */
699 #define SS_TH_SUSP 0x02 /* stopped or requested to stop */
700 #define SS_TH_RUN 0x04 /* running or on runq */
701 #define SS_TH_UNINT 0x08 /* waiting uninteruptibly */
702 #define SS_TH_TERMINATE 0x10 /* halted at termination */
703 #define SS_TH_TERMINATE2 0x20 /* added to termination queue */
704 #define SS_TH_IDLE 0x80 /* idling processor */
705
706 struct thread_snapshot_v2 {
707 uint64_t ths_thread_id;
708 uint64_t ths_wait_event;
709 uint64_t ths_continuation;
710 uint64_t ths_total_syscalls;
711 uint64_t ths_voucher_identifier;
712 uint64_t ths_dqserialnum;
713 uint64_t ths_user_time;
714 uint64_t ths_sys_time;
715 uint64_t ths_ss_flags;
716 uint64_t ths_last_run_time;
717 uint64_t ths_last_made_runnable_time;
718 uint32_t ths_state;
719 uint32_t ths_sched_flags;
720 int16_t ths_base_priority;
721 int16_t ths_sched_priority;
722 uint8_t ths_eqos;
723 uint8_t ths_rqos;
724 uint8_t ths_rqos_override;
725 uint8_t ths_io_tier;
726 } __attribute__((packed));
727
728 struct thread_snapshot_v3 {
729 uint64_t ths_thread_id;
730 uint64_t ths_wait_event;
731 uint64_t ths_continuation;
732 uint64_t ths_total_syscalls;
733 uint64_t ths_voucher_identifier;
734 uint64_t ths_dqserialnum;
735 uint64_t ths_user_time;
736 uint64_t ths_sys_time;
737 uint64_t ths_ss_flags;
738 uint64_t ths_last_run_time;
739 uint64_t ths_last_made_runnable_time;
740 uint32_t ths_state;
741 uint32_t ths_sched_flags;
742 int16_t ths_base_priority;
743 int16_t ths_sched_priority;
744 uint8_t ths_eqos;
745 uint8_t ths_rqos;
746 uint8_t ths_rqos_override;
747 uint8_t ths_io_tier;
748 uint64_t ths_thread_t;
749 } __attribute__((packed));
750
751
752 struct thread_snapshot_v4 {
753 uint64_t ths_thread_id;
754 uint64_t ths_wait_event;
755 uint64_t ths_continuation;
756 uint64_t ths_total_syscalls;
757 uint64_t ths_voucher_identifier;
758 uint64_t ths_dqserialnum;
759 uint64_t ths_user_time;
760 uint64_t ths_sys_time;
761 uint64_t ths_ss_flags;
762 uint64_t ths_last_run_time;
763 uint64_t ths_last_made_runnable_time;
764 uint32_t ths_state;
765 uint32_t ths_sched_flags;
766 int16_t ths_base_priority;
767 int16_t ths_sched_priority;
768 uint8_t ths_eqos;
769 uint8_t ths_rqos;
770 uint8_t ths_rqos_override;
771 uint8_t ths_io_tier;
772 uint64_t ths_thread_t;
773 uint64_t ths_requested_policy;
774 uint64_t ths_effective_policy;
775 } __attribute__((packed));
776
777
778 struct thread_group_snapshot {
779 uint64_t tgs_id;
780 char tgs_name[16];
781 } __attribute__((packed));
782
783 enum thread_group_flags {
784 kThreadGroupEfficient = 0x1,
785 kThreadGroupUIApp = 0x2
786 }; // Note: Add any new flags to kcdata.py (tgs_flags)
787
788 struct thread_group_snapshot_v2 {
789 uint64_t tgs_id;
790 char tgs_name[16];
791 uint64_t tgs_flags;
792 } __attribute__((packed));
793
794 enum coalition_flags {
795 kCoalitionTermRequested = 0x1,
796 kCoalitionTerminated = 0x2,
797 kCoalitionReaped = 0x4,
798 kCoalitionPrivileged = 0x8,
799 }; // Note: Add any new flags to kcdata.py (jcs_flags)
800
801 struct jetsam_coalition_snapshot {
802 uint64_t jcs_id;
803 uint64_t jcs_flags;
804 uint64_t jcs_thread_group;
805 uint64_t jcs_leader_task_uniqueid;
806 } __attribute__((packed));
807
808 struct instrs_cycles_snapshot {
809 uint64_t ics_instructions;
810 uint64_t ics_cycles;
811 } __attribute__((packed));
812
813 struct thread_delta_snapshot_v2 {
814 uint64_t tds_thread_id;
815 uint64_t tds_voucher_identifier;
816 uint64_t tds_ss_flags;
817 uint64_t tds_last_made_runnable_time;
818 uint32_t tds_state;
819 uint32_t tds_sched_flags;
820 int16_t tds_base_priority;
821 int16_t tds_sched_priority;
822 uint8_t tds_eqos;
823 uint8_t tds_rqos;
824 uint8_t tds_rqos_override;
825 uint8_t tds_io_tier;
826 } __attribute__ ((packed));
827
828 struct thread_delta_snapshot_v3 {
829 uint64_t tds_thread_id;
830 uint64_t tds_voucher_identifier;
831 uint64_t tds_ss_flags;
832 uint64_t tds_last_made_runnable_time;
833 uint32_t tds_state;
834 uint32_t tds_sched_flags;
835 int16_t tds_base_priority;
836 int16_t tds_sched_priority;
837 uint8_t tds_eqos;
838 uint8_t tds_rqos;
839 uint8_t tds_rqos_override;
840 uint8_t tds_io_tier;
841 uint64_t tds_requested_policy;
842 uint64_t tds_effective_policy;
843 } __attribute__ ((packed));
844
845 struct io_stats_snapshot {
846 /*
847 * I/O Statistics
848 * XXX: These fields must be together.
849 */
850 uint64_t ss_disk_reads_count;
851 uint64_t ss_disk_reads_size;
852 uint64_t ss_disk_writes_count;
853 uint64_t ss_disk_writes_size;
854 uint64_t ss_io_priority_count[STACKSHOT_IO_NUM_PRIORITIES];
855 uint64_t ss_io_priority_size[STACKSHOT_IO_NUM_PRIORITIES];
856 uint64_t ss_paging_count;
857 uint64_t ss_paging_size;
858 uint64_t ss_non_paging_count;
859 uint64_t ss_non_paging_size;
860 uint64_t ss_data_count;
861 uint64_t ss_data_size;
862 uint64_t ss_metadata_count;
863 uint64_t ss_metadata_size;
864 /* XXX: I/O Statistics end */
865 } __attribute__ ((packed));
866
867 struct task_snapshot_v2 {
868 uint64_t ts_unique_pid;
869 uint64_t ts_ss_flags;
870 uint64_t ts_user_time_in_terminated_threads;
871 uint64_t ts_system_time_in_terminated_threads;
872 uint64_t ts_p_start_sec;
873 uint64_t ts_task_size;
874 uint64_t ts_max_resident_size;
875 uint32_t ts_suspend_count;
876 uint32_t ts_faults;
877 uint32_t ts_pageins;
878 uint32_t ts_cow_faults;
879 uint32_t ts_was_throttled;
880 uint32_t ts_did_throttle;
881 uint32_t ts_latency_qos;
882 int32_t ts_pid;
883 char ts_p_comm[32];
884 } __attribute__ ((packed));
885
886 struct transitioning_task_snapshot {
887 uint64_t tts_unique_pid;
888 uint64_t tts_ss_flags;
889 uint64_t tts_transition_type;
890 int32_t tts_pid;
891 char tts_p_comm[32];
892 } __attribute__ ((packed));
893
894 struct task_delta_snapshot_v2 {
895 uint64_t tds_unique_pid;
896 uint64_t tds_ss_flags;
897 uint64_t tds_user_time_in_terminated_threads;
898 uint64_t tds_system_time_in_terminated_threads;
899 uint64_t tds_task_size;
900 uint64_t tds_max_resident_size;
901 uint32_t tds_suspend_count;
902 uint32_t tds_faults;
903 uint32_t tds_pageins;
904 uint32_t tds_cow_faults;
905 uint32_t tds_was_throttled;
906 uint32_t tds_did_throttle;
907 uint32_t tds_latency_qos;
908 } __attribute__ ((packed));
909
910 struct stackshot_cpu_times {
911 uint64_t user_usec;
912 uint64_t system_usec;
913 } __attribute__((packed));
914
915 struct stackshot_cpu_times_v2 {
916 uint64_t user_usec;
917 uint64_t system_usec;
918 uint64_t runnable_usec;
919 } __attribute__((packed));
920
921 struct stackshot_duration {
922 uint64_t stackshot_duration;
923 uint64_t stackshot_duration_outer;
924 } __attribute__((packed));
925
926 struct stackshot_duration_v2 {
927 uint64_t stackshot_duration;
928 uint64_t stackshot_duration_outer;
929 uint64_t stackshot_duration_prior;
930 } __attribute__((packed));
931
932 struct stackshot_fault_stats {
933 uint32_t sfs_pages_faulted_in; /* number of pages faulted in using KDP fault path */
934 uint64_t sfs_time_spent_faulting; /* MATUs spent faulting */
935 uint64_t sfs_system_max_fault_time; /* MATUs fault time limit per stackshot */
936 uint8_t sfs_stopped_faulting; /* we stopped decompressing because we hit the limit */
937 } __attribute__((packed));
938
939 typedef struct stackshot_thread_waitinfo {
940 uint64_t owner; /* The thread that owns the object */
941 uint64_t waiter; /* The thread that's waiting on the object */
942 uint64_t context; /* A context uniquely identifying the object */
943 uint8_t wait_type; /* The type of object that the thread is waiting on */
944 } __attribute__((packed)) thread_waitinfo_t;
945
946 typedef struct stackshot_thread_turnstileinfo {
947 uint64_t waiter; /* The thread that's waiting on the object */
948 uint64_t turnstile_context; /* Associated data (either thread id, or workq addr) */
949 uint8_t turnstile_priority;
950 uint8_t number_of_hops;
951 #define STACKSHOT_TURNSTILE_STATUS_UNKNOWN 0x01 /* The final inheritor is unknown (bug?) */
952 #define STACKSHOT_TURNSTILE_STATUS_LOCKED_WAITQ 0x02 /* A waitq was found to be locked */
953 #define STACKSHOT_TURNSTILE_STATUS_WORKQUEUE 0x04 /* The final inheritor is a workqueue */
954 #define STACKSHOT_TURNSTILE_STATUS_THREAD 0x08 /* The final inheritor is a thread */
955 #define STACKSHOT_TURNSTILE_STATUS_BLOCKED_ON_TASK 0x10 /* blocked on task, dind't find thread */
956 #define STACKSHOT_TURNSTILE_STATUS_HELD_IPLOCK 0x20 /* the ip_lock was held */
957 uint64_t turnstile_flags; // Note: Add any new flags to kcdata.py (turnstile_flags)
958 } __attribute__((packed)) thread_turnstileinfo_t;
959
960 #define STACKSHOT_WAITOWNER_KERNEL (UINT64_MAX - 1)
961 #define STACKSHOT_WAITOWNER_PORT_LOCKED (UINT64_MAX - 2)
962 #define STACKSHOT_WAITOWNER_PSET_LOCKED (UINT64_MAX - 3)
963 #define STACKSHOT_WAITOWNER_INTRANSIT (UINT64_MAX - 4)
964 #define STACKSHOT_WAITOWNER_MTXSPIN (UINT64_MAX - 5)
965 #define STACKSHOT_WAITOWNER_THREQUESTED (UINT64_MAX - 6) /* workloop waiting for a new worker thread */
966 #define STACKSHOT_WAITOWNER_SUSPENDED (UINT64_MAX - 7) /* workloop is suspended */
967
968 struct stackshot_cpu_architecture {
969 int32_t cputype;
970 int32_t cpusubtype;
971 } __attribute__((packed));
972
973 struct stack_snapshot_stacktop {
974 uint64_t sp;
975 uint8_t stack_contents[8];
976 };
977
978 /* only collected if STACKSHOT_COLLECTS_LATENCY_INFO is set to !0 */
979 struct stackshot_latency_collection {
980 uint64_t latency_version;
981 uint64_t setup_latency;
982 uint64_t total_task_iteration_latency;
983 uint64_t total_terminated_task_iteration_latency;
984 } __attribute__((packed));
985
986 /* only collected if STACKSHOT_COLLECTS_LATENCY_INFO is set to !0 */
987 struct stackshot_latency_task {
988 uint64_t task_uniqueid;
989 uint64_t setup_latency;
990 uint64_t task_thread_count_loop_latency;
991 uint64_t task_thread_data_loop_latency;
992 uint64_t cur_tsnap_latency;
993 uint64_t pmap_latency;
994 uint64_t bsd_proc_ids_latency;
995 uint64_t misc_latency;
996 uint64_t misc2_latency;
997 uint64_t end_latency;
998 } __attribute__((packed));
999
1000 /* only collected if STACKSHOT_COLLECTS_LATENCY_INFO is set to !0 */
1001 struct stackshot_latency_thread {
1002 uint64_t thread_id;
1003 uint64_t cur_thsnap1_latency;
1004 uint64_t dispatch_serial_latency;
1005 uint64_t dispatch_label_latency;
1006 uint64_t cur_thsnap2_latency;
1007 uint64_t thread_name_latency;
1008 uint64_t sur_times_latency;
1009 uint64_t user_stack_latency;
1010 uint64_t kernel_stack_latency;
1011 uint64_t misc_latency;
1012 } __attribute__((packed));
1013
1014
1015 /**************** definitions for crashinfo *********************/
1016
1017 /*
1018 * NOTE: Please update kcdata/libkdd/kcdtypes.c if you make any changes
1019 * in TASK_CRASHINFO_* types.
1020 */
1021
1022 /* FIXME some of these types aren't clean (fixed width, packed, and defined *here*) */
1023
1024 struct crashinfo_proc_uniqidentifierinfo {
1025 uint8_t p_uuid[16]; /* UUID of the main executable */
1026 uint64_t p_uniqueid; /* 64 bit unique identifier for process */
1027 uint64_t p_puniqueid; /* unique identifier for process's parent */
1028 uint64_t p_reserve2; /* reserved for future use */
1029 uint64_t p_reserve3; /* reserved for future use */
1030 uint64_t p_reserve4; /* reserved for future use */
1031 } __attribute__((packed));
1032
1033 #define MAX_TRIAGE_STRING_LEN (128)
1034
1035 struct kernel_triage_info_v1 {
1036 char triage_string1[MAX_TRIAGE_STRING_LEN];
1037 char triage_string2[MAX_TRIAGE_STRING_LEN];
1038 char triage_string3[MAX_TRIAGE_STRING_LEN];
1039 char triage_string4[MAX_TRIAGE_STRING_LEN];
1040 char triage_string5[MAX_TRIAGE_STRING_LEN];
1041 } __attribute__((packed));
1042
1043 #define TASK_CRASHINFO_BEGIN KCDATA_BUFFER_BEGIN_CRASHINFO
1044 #define TASK_CRASHINFO_STRING_DESC KCDATA_TYPE_STRING_DESC
1045 #define TASK_CRASHINFO_UINT32_DESC KCDATA_TYPE_UINT32_DESC
1046 #define TASK_CRASHINFO_UINT64_DESC KCDATA_TYPE_UINT64_DESC
1047
1048 #define TASK_CRASHINFO_EXTMODINFO 0x801
1049 #define TASK_CRASHINFO_BSDINFOWITHUNIQID 0x802 /* struct crashinfo_proc_uniqidentifierinfo */
1050 #define TASK_CRASHINFO_TASKDYLD_INFO 0x803
1051 #define TASK_CRASHINFO_UUID 0x804
1052 #define TASK_CRASHINFO_PID 0x805
1053 #define TASK_CRASHINFO_PPID 0x806
1054 #define TASK_CRASHINFO_RUSAGE 0x807 /* struct rusage DEPRECATED do not use.
1055 * This struct has longs in it */
1056 #define TASK_CRASHINFO_RUSAGE_INFO 0x808 /* struct rusage_info_v3 from resource.h */
1057 #define TASK_CRASHINFO_PROC_NAME 0x809 /* char * */
1058 #define TASK_CRASHINFO_PROC_STARTTIME 0x80B /* struct timeval64 */
1059 #define TASK_CRASHINFO_USERSTACK 0x80C /* uint64_t */
1060 #define TASK_CRASHINFO_ARGSLEN 0x80D
1061 #define TASK_CRASHINFO_EXCEPTION_CODES 0x80E /* mach_exception_data_t */
1062 #define TASK_CRASHINFO_PROC_PATH 0x80F /* string of len MAXPATHLEN */
1063 #define TASK_CRASHINFO_PROC_CSFLAGS 0x810 /* uint32_t */
1064 #define TASK_CRASHINFO_PROC_STATUS 0x811 /* char */
1065 #define TASK_CRASHINFO_UID 0x812 /* uid_t */
1066 #define TASK_CRASHINFO_GID 0x813 /* gid_t */
1067 #define TASK_CRASHINFO_PROC_ARGC 0x814 /* int */
1068 #define TASK_CRASHINFO_PROC_FLAGS 0x815 /* unsigned int */
1069 #define TASK_CRASHINFO_CPUTYPE 0x816 /* cpu_type_t */
1070 #define TASK_CRASHINFO_WORKQUEUEINFO 0x817 /* struct proc_workqueueinfo */
1071 #define TASK_CRASHINFO_RESPONSIBLE_PID 0x818 /* pid_t */
1072 #define TASK_CRASHINFO_DIRTY_FLAGS 0x819 /* int */
1073 #define TASK_CRASHINFO_CRASHED_THREADID 0x81A /* uint64_t */
1074 #define TASK_CRASHINFO_COALITION_ID 0x81B /* uint64_t */
1075 #define TASK_CRASHINFO_UDATA_PTRS 0x81C /* uint64_t */
1076 #define TASK_CRASHINFO_MEMORY_LIMIT 0x81D /* uint64_t */
1077
1078 #define TASK_CRASHINFO_LEDGER_INTERNAL 0x81E /* uint64_t */
1079 #define TASK_CRASHINFO_LEDGER_INTERNAL_COMPRESSED 0x81F /* uint64_t */
1080 #define TASK_CRASHINFO_LEDGER_IOKIT_MAPPED 0x820 /* uint64_t */
1081 #define TASK_CRASHINFO_LEDGER_ALTERNATE_ACCOUNTING 0x821 /* uint64_t */
1082 #define TASK_CRASHINFO_LEDGER_ALTERNATE_ACCOUNTING_COMPRESSED 0x822 /* uint64_t */
1083 #define TASK_CRASHINFO_LEDGER_PURGEABLE_NONVOLATILE 0x823 /* uint64_t */
1084 #define TASK_CRASHINFO_LEDGER_PURGEABLE_NONVOLATILE_COMPRESSED 0x824 /* uint64_t */
1085 #define TASK_CRASHINFO_LEDGER_PAGE_TABLE 0x825 /* uint64_t */
1086 #define TASK_CRASHINFO_LEDGER_PHYS_FOOTPRINT 0x826 /* uint64_t */
1087 #define TASK_CRASHINFO_LEDGER_PHYS_FOOTPRINT_LIFETIME_MAX 0x827 /* uint64_t */
1088 #define TASK_CRASHINFO_LEDGER_NETWORK_NONVOLATILE 0x828 /* uint64_t */
1089 #define TASK_CRASHINFO_LEDGER_NETWORK_NONVOLATILE_COMPRESSED 0x829 /* uint64_t */
1090 #define TASK_CRASHINFO_LEDGER_WIRED_MEM 0x82A /* uint64_t */
1091 #define TASK_CRASHINFO_PROC_PERSONA_ID 0x82B /* uid_t */
1092 #define TASK_CRASHINFO_MEMORY_LIMIT_INCREASE 0x82C /* uint32_t */
1093 #define TASK_CRASHINFO_LEDGER_TAGGED_FOOTPRINT 0x82D /* uint64_t */
1094 #define TASK_CRASHINFO_LEDGER_TAGGED_FOOTPRINT_COMPRESSED 0x82E /* uint64_t */
1095 #define TASK_CRASHINFO_LEDGER_MEDIA_FOOTPRINT 0x82F /* uint64_t */
1096 #define TASK_CRASHINFO_LEDGER_MEDIA_FOOTPRINT_COMPRESSED 0x830 /* uint64_t */
1097 #define TASK_CRASHINFO_LEDGER_GRAPHICS_FOOTPRINT 0x831 /* uint64_t */
1098 #define TASK_CRASHINFO_LEDGER_GRAPHICS_FOOTPRINT_COMPRESSED 0x832 /* uint64_t */
1099 #define TASK_CRASHINFO_LEDGER_NEURAL_FOOTPRINT 0x833 /* uint64_t */
1100 #define TASK_CRASHINFO_LEDGER_NEURAL_FOOTPRINT_COMPRESSED 0x834 /* uint64_t */
1101 #define TASK_CRASHINFO_MEMORYSTATUS_EFFECTIVE_PRIORITY 0x835 /* int32_t */
1102 #define TASK_CRASHINFO_KERNEL_TRIAGE_INFO_V1 0x836 /* struct kernel_triage_info_v1 */
1103
1104 #define TASK_CRASHINFO_TASK_IS_CORPSE_FORK 0x837 /* boolean_t */
1105 #define TASK_CRASHINFO_EXCEPTION_TYPE 0x838 /* int */
1106
1107 #define TASK_CRASHINFO_END KCDATA_TYPE_BUFFER_END
1108
1109 /**************** definitions for os reasons *********************/
1110
1111 #define EXIT_REASON_SNAPSHOT 0x1001
1112 #define EXIT_REASON_USER_DESC 0x1002 /* string description of reason */
1113 #define EXIT_REASON_USER_PAYLOAD 0x1003 /* user payload data */
1114 #define EXIT_REASON_CODESIGNING_INFO 0x1004
1115 #define EXIT_REASON_WORKLOOP_ID 0x1005
1116 #define EXIT_REASON_DISPATCH_QUEUE_NO 0x1006
1117
1118 struct exit_reason_snapshot {
1119 uint32_t ers_namespace;
1120 uint64_t ers_code;
1121 /* end of version 1 of exit_reason_snapshot. sizeof v1 was 12 */
1122 uint64_t ers_flags;
1123 } __attribute__((packed));
1124
1125 #define EXIT_REASON_CODESIG_PATH_MAX 1024
1126
1127 struct codesigning_exit_reason_info {
1128 uint64_t ceri_virt_addr;
1129 uint64_t ceri_file_offset;
1130 char ceri_pathname[EXIT_REASON_CODESIG_PATH_MAX];
1131 char ceri_filename[EXIT_REASON_CODESIG_PATH_MAX];
1132 uint64_t ceri_codesig_modtime_secs;
1133 uint64_t ceri_codesig_modtime_nsecs;
1134 uint64_t ceri_page_modtime_secs;
1135 uint64_t ceri_page_modtime_nsecs;
1136 uint8_t ceri_path_truncated;
1137 uint8_t ceri_object_codesigned;
1138 uint8_t ceri_page_codesig_validated;
1139 uint8_t ceri_page_codesig_tainted;
1140 uint8_t ceri_page_codesig_nx;
1141 uint8_t ceri_page_wpmapped;
1142 uint8_t ceri_page_slid;
1143 uint8_t ceri_page_dirty;
1144 uint32_t ceri_page_shadow_depth;
1145 } __attribute__((packed));
1146
1147 #define EXIT_REASON_USER_DESC_MAX_LEN 1024
1148 #define EXIT_REASON_PAYLOAD_MAX_LEN 2048
1149 /**************** safe iterators *********************/
1150 #if !XNU_BOUND_CHECKS
1151
1152 typedef struct kcdata_iter {
1153 kcdata_item_t item;
1154 void *end;
1155 } kcdata_iter_t;
1156
1157
1158 static inline
1159 kcdata_iter_t
kcdata_iter(void * buffer,unsigned long size)1160 kcdata_iter(void *buffer, unsigned long size)
1161 {
1162 kcdata_iter_t iter;
1163 iter.item = (kcdata_item_t) buffer;
1164 iter.end = (void*) (((uintptr_t)buffer) + size);
1165 return iter;
1166 }
1167
1168 static inline
1169 kcdata_iter_t kcdata_iter_unsafe(void *buffer) __attribute__((deprecated));
1170
1171 static inline
1172 kcdata_iter_t
kcdata_iter_unsafe(void * buffer)1173 kcdata_iter_unsafe(void *buffer)
1174 {
1175 kcdata_iter_t iter;
1176 iter.item = (kcdata_item_t) buffer;
1177 iter.end = (void*) (uintptr_t) ~0;
1178 return iter;
1179 }
1180
1181 static const kcdata_iter_t kcdata_invalid_iter = { .item = NULL, .end = NULL };
1182
1183 static inline
1184 int
kcdata_iter_valid(kcdata_iter_t iter)1185 kcdata_iter_valid(kcdata_iter_t iter)
1186 {
1187 return
1188 ((uintptr_t)iter.item + sizeof(struct kcdata_item) <= (uintptr_t)iter.end) &&
1189 ((uintptr_t)iter.item + sizeof(struct kcdata_item) + iter.item->size <= (uintptr_t)iter.end);
1190 }
1191
1192
1193 static inline
1194 kcdata_iter_t
kcdata_iter_next(kcdata_iter_t iter)1195 kcdata_iter_next(kcdata_iter_t iter)
1196 {
1197 iter.item = (kcdata_item_t) (((uintptr_t)iter.item) + sizeof(struct kcdata_item) + (iter.item->size));
1198 return iter;
1199 }
1200
1201 static inline uint32_t
kcdata_iter_type(kcdata_iter_t iter)1202 kcdata_iter_type(kcdata_iter_t iter)
1203 {
1204 if ((iter.item->type & ~0xfu) == KCDATA_TYPE_ARRAY_PAD0) {
1205 return KCDATA_TYPE_ARRAY;
1206 } else {
1207 return iter.item->type;
1208 }
1209 }
1210
1211 static inline uint32_t
kcdata_calc_padding(uint32_t size)1212 kcdata_calc_padding(uint32_t size)
1213 {
1214 /* calculate number of bytes to add to size to get something divisible by 16 */
1215 return (-size) & 0xf;
1216 }
1217
1218 static inline uint32_t
kcdata_flags_get_padding(uint64_t flags)1219 kcdata_flags_get_padding(uint64_t flags)
1220 {
1221 return flags & KCDATA_FLAGS_STRUCT_PADDING_MASK;
1222 }
1223
1224 /* see comment above about has_padding */
1225 static inline int
kcdata_iter_is_legacy_item(kcdata_iter_t iter,uint32_t legacy_size)1226 kcdata_iter_is_legacy_item(kcdata_iter_t iter, uint32_t legacy_size)
1227 {
1228 uint32_t legacy_size_padded = legacy_size + kcdata_calc_padding(legacy_size);
1229 return iter.item->size == legacy_size_padded &&
1230 (iter.item->flags & (KCDATA_FLAGS_STRUCT_PADDING_MASK | KCDATA_FLAGS_STRUCT_HAS_PADDING)) == 0;
1231 }
1232
1233 static inline uint32_t
kcdata_iter_size(kcdata_iter_t iter)1234 kcdata_iter_size(kcdata_iter_t iter)
1235 {
1236 uint32_t legacy_size = 0;
1237
1238 switch (kcdata_iter_type(iter)) {
1239 case KCDATA_TYPE_ARRAY:
1240 case KCDATA_TYPE_CONTAINER_BEGIN:
1241 return iter.item->size;
1242 case STACKSHOT_KCTYPE_THREAD_SNAPSHOT: {
1243 legacy_size = sizeof(struct thread_snapshot_v2);
1244 if (kcdata_iter_is_legacy_item(iter, legacy_size)) {
1245 return legacy_size;
1246 }
1247
1248 goto not_legacy;
1249 }
1250 case STACKSHOT_KCTYPE_SHAREDCACHE_LOADINFO: {
1251 legacy_size = sizeof(struct dyld_uuid_info_64);
1252 if (kcdata_iter_is_legacy_item(iter, legacy_size)) {
1253 return legacy_size;
1254 }
1255
1256 goto not_legacy;
1257 }
1258 not_legacy:
1259 default:
1260 if (iter.item->size < kcdata_flags_get_padding(iter.item->flags)) {
1261 return 0;
1262 } else {
1263 return iter.item->size - kcdata_flags_get_padding(iter.item->flags);
1264 }
1265 }
1266 }
1267
1268 static inline uint64_t
kcdata_iter_flags(kcdata_iter_t iter)1269 kcdata_iter_flags(kcdata_iter_t iter)
1270 {
1271 return iter.item->flags;
1272 }
1273
1274 static inline
1275 void *
kcdata_iter_payload(kcdata_iter_t iter)1276 kcdata_iter_payload(kcdata_iter_t iter)
1277 {
1278 return &iter.item->data;
1279 }
1280
1281
1282 static inline
1283 uint32_t
kcdata_iter_array_elem_type(kcdata_iter_t iter)1284 kcdata_iter_array_elem_type(kcdata_iter_t iter)
1285 {
1286 return (iter.item->flags >> 32) & UINT32_MAX;
1287 }
1288
1289 static inline
1290 uint32_t
kcdata_iter_array_elem_count(kcdata_iter_t iter)1291 kcdata_iter_array_elem_count(kcdata_iter_t iter)
1292 {
1293 return (iter.item->flags) & UINT32_MAX;
1294 }
1295
1296 /* KCDATA_TYPE_ARRAY is ambiguous about the size of the array elements. Size is
1297 * calculated as total_size / elements_count, but total size got padded out to a
1298 * 16 byte alignment. New kernels will generate KCDATA_TYPE_ARRAY_PAD* instead
1299 * to explicitly tell us how much padding was used. Here we have a fixed, never
1300 * to be altered list of the sizes of array elements that were used before I
1301 * discovered this issue. If you find a KCDATA_TYPE_ARRAY that is not one of
1302 * these types, treat it as invalid data. */
1303
1304 static inline
1305 uint32_t
kcdata_iter_array_size_switch(kcdata_iter_t iter)1306 kcdata_iter_array_size_switch(kcdata_iter_t iter)
1307 {
1308 switch (kcdata_iter_array_elem_type(iter)) {
1309 case KCDATA_TYPE_LIBRARY_LOADINFO:
1310 return sizeof(struct dyld_uuid_info_32);
1311 case KCDATA_TYPE_LIBRARY_LOADINFO64:
1312 return sizeof(struct dyld_uuid_info_64);
1313 case STACKSHOT_KCTYPE_KERN_STACKFRAME:
1314 case STACKSHOT_KCTYPE_USER_STACKFRAME:
1315 return sizeof(struct stack_snapshot_frame32);
1316 case STACKSHOT_KCTYPE_KERN_STACKFRAME64:
1317 case STACKSHOT_KCTYPE_USER_STACKFRAME64:
1318 return sizeof(struct stack_snapshot_frame64);
1319 case STACKSHOT_KCTYPE_DONATING_PIDS:
1320 return sizeof(int32_t);
1321 case STACKSHOT_KCTYPE_THREAD_DELTA_SNAPSHOT:
1322 return sizeof(struct thread_delta_snapshot_v2);
1323 // This one is only here to make some unit tests work. It should be OK to
1324 // remove.
1325 case TASK_CRASHINFO_CRASHED_THREADID:
1326 return sizeof(uint64_t);
1327 default:
1328 return 0;
1329 }
1330 }
1331
1332 static inline
1333 int
kcdata_iter_array_valid(kcdata_iter_t iter)1334 kcdata_iter_array_valid(kcdata_iter_t iter)
1335 {
1336 if (!kcdata_iter_valid(iter)) {
1337 return 0;
1338 }
1339 if (kcdata_iter_type(iter) != KCDATA_TYPE_ARRAY) {
1340 return 0;
1341 }
1342 if (kcdata_iter_array_elem_count(iter) == 0) {
1343 return iter.item->size == 0;
1344 }
1345 if (iter.item->type == KCDATA_TYPE_ARRAY) {
1346 uint32_t elem_size = kcdata_iter_array_size_switch(iter);
1347 if (elem_size == 0) {
1348 return 0;
1349 }
1350 /* sizes get aligned to the nearest 16. */
1351 return
1352 kcdata_iter_array_elem_count(iter) <= iter.item->size / elem_size &&
1353 iter.item->size % kcdata_iter_array_elem_count(iter) < 16;
1354 } else {
1355 return
1356 (iter.item->type & 0xf) <= iter.item->size &&
1357 kcdata_iter_array_elem_count(iter) <= iter.item->size - (iter.item->type & 0xf) &&
1358 (iter.item->size - (iter.item->type & 0xf)) % kcdata_iter_array_elem_count(iter) == 0;
1359 }
1360 }
1361
1362
1363 static inline
1364 uint32_t
kcdata_iter_array_elem_size(kcdata_iter_t iter)1365 kcdata_iter_array_elem_size(kcdata_iter_t iter)
1366 {
1367 if (iter.item->type == KCDATA_TYPE_ARRAY) {
1368 return kcdata_iter_array_size_switch(iter);
1369 }
1370 if (kcdata_iter_array_elem_count(iter) == 0) {
1371 return 0;
1372 }
1373 return (iter.item->size - (iter.item->type & 0xf)) / kcdata_iter_array_elem_count(iter);
1374 }
1375
1376 static inline
1377 int
kcdata_iter_container_valid(kcdata_iter_t iter)1378 kcdata_iter_container_valid(kcdata_iter_t iter)
1379 {
1380 return
1381 kcdata_iter_valid(iter) &&
1382 kcdata_iter_type(iter) == KCDATA_TYPE_CONTAINER_BEGIN &&
1383 iter.item->size >= sizeof(uint32_t);
1384 }
1385
1386 static inline
1387 uint32_t
kcdata_iter_container_type(kcdata_iter_t iter)1388 kcdata_iter_container_type(kcdata_iter_t iter)
1389 {
1390 return *(uint32_t *) kcdata_iter_payload(iter);
1391 }
1392
1393 static inline
1394 uint64_t
kcdata_iter_container_id(kcdata_iter_t iter)1395 kcdata_iter_container_id(kcdata_iter_t iter)
1396 {
1397 return iter.item->flags;
1398 }
1399
1400
1401 #define KCDATA_ITER_FOREACH(iter) for(; kcdata_iter_valid(iter) && iter.item->type != KCDATA_TYPE_BUFFER_END; iter = kcdata_iter_next(iter))
1402 #define KCDATA_ITER_FOREACH_FAILED(iter) (!kcdata_iter_valid(iter) || (iter).item->type != KCDATA_TYPE_BUFFER_END)
1403
1404 static inline
1405 kcdata_iter_t
kcdata_iter_find_type(kcdata_iter_t iter,uint32_t type)1406 kcdata_iter_find_type(kcdata_iter_t iter, uint32_t type)
1407 {
1408 KCDATA_ITER_FOREACH(iter)
1409 {
1410 if (kcdata_iter_type(iter) == type) {
1411 return iter;
1412 }
1413 }
1414 return kcdata_invalid_iter;
1415 }
1416
1417 static inline
1418 int
kcdata_iter_data_with_desc_valid(kcdata_iter_t iter,uint32_t minsize)1419 kcdata_iter_data_with_desc_valid(kcdata_iter_t iter, uint32_t minsize)
1420 {
1421 return
1422 kcdata_iter_valid(iter) &&
1423 kcdata_iter_size(iter) >= KCDATA_DESC_MAXLEN + minsize &&
1424 ((char*)kcdata_iter_payload(iter))[KCDATA_DESC_MAXLEN - 1] == 0;
1425 }
1426
1427 static inline
1428 char *
kcdata_iter_string(kcdata_iter_t iter,uint32_t offset)1429 kcdata_iter_string(kcdata_iter_t iter, uint32_t offset)
1430 {
1431 if (offset > kcdata_iter_size(iter)) {
1432 return NULL;
1433 }
1434 uint32_t maxlen = kcdata_iter_size(iter) - offset;
1435 char *s = ((char*)kcdata_iter_payload(iter)) + offset;
1436 if (strnlen(s, maxlen) < maxlen) {
1437 return s;
1438 } else {
1439 return NULL;
1440 }
1441 }
1442
1443 static inline void
kcdata_iter_get_data_with_desc(kcdata_iter_t iter,char ** desc_ptr,void ** data_ptr,uint32_t * size_ptr)1444 kcdata_iter_get_data_with_desc(kcdata_iter_t iter, char **desc_ptr, void **data_ptr, uint32_t *size_ptr)
1445 {
1446 if (desc_ptr) {
1447 *desc_ptr = (char *)kcdata_iter_payload(iter);
1448 }
1449 if (data_ptr) {
1450 *data_ptr = (void *)((uintptr_t)kcdata_iter_payload(iter) + KCDATA_DESC_MAXLEN);
1451 }
1452 if (size_ptr) {
1453 *size_ptr = kcdata_iter_size(iter) - KCDATA_DESC_MAXLEN;
1454 }
1455 }
1456
1457 #endif /* !XNU_BOUND_CHECKS */
1458 #endif
1459