1 | /* |
2 | * Copyright (c) 2000-2016 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 | #ifndef _KERN_DEBUG_H_ |
30 | #define _KERN_DEBUG_H_ |
31 | |
32 | #include <kern/kcdata.h> |
33 | |
34 | #include <sys/cdefs.h> |
35 | #include <stdint.h> |
36 | #include <stdarg.h> |
37 | #include <uuid/uuid.h> |
38 | #include <mach/boolean.h> |
39 | #include <mach/kern_return.h> |
40 | |
41 | #ifndef XNU_KERNEL_PRIVATE |
42 | #include <TargetConditionals.h> |
43 | #endif |
44 | |
45 | #ifdef __APPLE_API_PRIVATE |
46 | #ifdef __APPLE_API_UNSTABLE |
47 | |
48 | struct thread_snapshot { |
49 | uint32_t snapshot_magic; |
50 | uint32_t nkern_frames; |
51 | uint32_t nuser_frames; |
52 | uint64_t wait_event; |
53 | uint64_t continuation; |
54 | uint64_t thread_id; |
55 | uint64_t user_time; |
56 | uint64_t system_time; |
57 | int32_t state; |
58 | int32_t priority; /* static priority */ |
59 | int32_t sched_pri; /* scheduled (current) priority */ |
60 | int32_t sched_flags; /* scheduler flags */ |
61 | char ss_flags; |
62 | char ts_qos; /* effective qos */ |
63 | char ts_rqos; /* requested qos */ |
64 | char ts_rqos_override; /* requested qos override */ |
65 | char io_tier; |
66 | char _reserved[3]; /* pad for 4 byte alignement packing */ |
67 | |
68 | /* |
69 | * I/O Statistics |
70 | * XXX: These fields must be together |
71 | */ |
72 | uint64_t disk_reads_count; |
73 | uint64_t disk_reads_size; |
74 | uint64_t disk_writes_count; |
75 | uint64_t disk_writes_size; |
76 | uint64_t io_priority_count[STACKSHOT_IO_NUM_PRIORITIES]; |
77 | uint64_t io_priority_size[STACKSHOT_IO_NUM_PRIORITIES]; |
78 | uint64_t paging_count; |
79 | uint64_t paging_size; |
80 | uint64_t non_paging_count; |
81 | uint64_t non_paging_size; |
82 | uint64_t data_count; |
83 | uint64_t data_size; |
84 | uint64_t metadata_count; |
85 | uint64_t metadata_size; |
86 | /* XXX: I/O Statistics end */ |
87 | |
88 | uint64_t voucher_identifier; /* obfuscated voucher identifier */ |
89 | uint64_t total_syscalls; |
90 | char pth_name[STACKSHOT_MAX_THREAD_NAME_SIZE]; |
91 | |
92 | } __attribute__((packed)); |
93 | |
94 | /* old, non kcdata format */ |
95 | struct task_snapshot { |
96 | uint32_t snapshot_magic; |
97 | int32_t pid; |
98 | uint64_t uniqueid; |
99 | uint64_t user_time_in_terminated_threads; |
100 | uint64_t system_time_in_terminated_threads; |
101 | uint8_t shared_cache_identifier[16]; |
102 | uint64_t shared_cache_slide; |
103 | uint32_t nloadinfos; |
104 | int suspend_count; |
105 | int task_size; /* pages */ |
106 | int faults; /* number of page faults */ |
107 | int pageins; /* number of actual pageins */ |
108 | int cow_faults; /* number of copy-on-write faults */ |
109 | uint32_t ss_flags; |
110 | uint64_t p_start_sec; /* from the bsd proc struct */ |
111 | uint64_t p_start_usec; /* from the bsd proc struct */ |
112 | |
113 | /* |
114 | * We restrict ourselves to a statically defined |
115 | * (current as of 2009) length for the |
116 | * p_comm string, due to scoping issues (osfmk/bsd and user/kernel |
117 | * binary compatibility). |
118 | */ |
119 | char p_comm[17]; |
120 | uint32_t was_throttled; |
121 | uint32_t did_throttle; |
122 | uint32_t latency_qos; |
123 | /* |
124 | * I/O Statistics |
125 | * XXX: These fields must be together. |
126 | */ |
127 | uint64_t disk_reads_count; |
128 | uint64_t disk_reads_size; |
129 | uint64_t disk_writes_count; |
130 | uint64_t disk_writes_size; |
131 | uint64_t io_priority_count[STACKSHOT_IO_NUM_PRIORITIES]; |
132 | uint64_t io_priority_size[STACKSHOT_IO_NUM_PRIORITIES]; |
133 | uint64_t paging_count; |
134 | uint64_t paging_size; |
135 | uint64_t non_paging_count; |
136 | uint64_t non_paging_size; |
137 | uint64_t data_count; |
138 | uint64_t data_size; |
139 | uint64_t metadata_count; |
140 | uint64_t metadata_size; |
141 | /* XXX: I/O Statistics end */ |
142 | |
143 | uint32_t donating_pid_count; |
144 | |
145 | } __attribute__ ((packed)); |
146 | |
147 | |
148 | |
149 | struct micro_snapshot { |
150 | uint32_t snapshot_magic; |
151 | uint32_t ms_cpu; /* cpu number this snapshot was recorded on */ |
152 | uint64_t ms_time; /* time at sample (seconds) */ |
153 | uint64_t ms_time_microsecs; |
154 | uint8_t ms_flags; |
155 | uint16_t ms_opaque_flags; /* managed by external entity, e.g. fdrmicrod */ |
156 | } __attribute__ ((packed)); |
157 | |
158 | |
159 | /* |
160 | * mirrors the dyld_cache_header struct defined in dyld_cache_format.h from dyld source code |
161 | */ |
162 | struct |
163 | { |
164 | char [16]; // e.g. "dyld_v0 i386" |
165 | uint32_t ; // file offset to first dyld_cache_mapping_info |
166 | uint32_t ; // number of dyld_cache_mapping_info entries |
167 | uint32_t ; // file offset to first dyld_cache_image_info |
168 | uint32_t ; // number of dyld_cache_image_info entries |
169 | uint64_t ; // base address of dyld when cache was built |
170 | uint64_t ; // file offset of code signature blob |
171 | uint64_t ; // size of code signature blob (zero means to end of file) |
172 | uint64_t ; // file offset of kernel slid info |
173 | uint64_t ; // size of kernel slid info |
174 | uint64_t ; // file offset of where local symbols are stored |
175 | uint64_t ; // size of local symbols information |
176 | uint8_t [16]; // unique value for each shared cache file |
177 | uint64_t ; // 0 for development, 1 for production |
178 | uint32_t ; // file offset to table of uint64_t pool addresses |
179 | uint32_t ; // number of uint64_t entries |
180 | uint64_t ; // (unslid) address of optimization info |
181 | uint64_t ; // size of optimization info |
182 | uint64_t ; // file offset to first dyld_cache_image_text_info |
183 | uint64_t ; // number of dyld_cache_image_text_info entries |
184 | uint64_t ; // (unslid) address of ImageGroup for dylibs in this cache |
185 | uint64_t ; // size of ImageGroup for dylibs in this cache |
186 | uint64_t ; // (unslid) address of ImageGroup for other OS dylibs |
187 | uint64_t ; // size of oImageGroup for other OS dylibs |
188 | uint64_t ; // (unslid) address of list of program launch closures |
189 | uint64_t ; // size of list of program launch closures |
190 | uint64_t ; // (unslid) address of trie of indexes into program launch closures |
191 | uint64_t ; // size of trie of indexes into program launch closures |
192 | uint32_t ; // platform number (macOS=1, etc) |
193 | uint32_t : 8, // dyld3::closure::kFormatVersion |
194 | : 1, // dyld should expect the dylib exists on disk and to compare inode/mtime to see if cache is valid |
195 | : 1, // for simulator of specified platform |
196 | : 1, // 0 for B&I built cache, 1 for locally built cache |
197 | : 21; // TBD |
198 | }; |
199 | |
200 | /* |
201 | * mirrors the dyld_cache_image_text_info struct defined in dyld_cache_format.h from dyld source code |
202 | */ |
203 | struct _dyld_cache_image_text_info |
204 | { |
205 | uuid_t uuid; |
206 | uint64_t loadAddress; // unslid address of start of __TEXT |
207 | uint32_t textSegmentSize; |
208 | uint32_t pathOffset; // offset from start of cache file |
209 | }; |
210 | |
211 | |
212 | enum micro_snapshot_flags { |
213 | kInterruptRecord = 0x1, |
214 | kTimerArmingRecord = 0x2, |
215 | kUserMode = 0x4, /* interrupted usermode, or armed by usermode */ |
216 | kIORecord = 0x8, |
217 | kPMIRecord = 0x10, |
218 | }; |
219 | |
220 | /* |
221 | * Flags used in the following assortment of snapshots. |
222 | */ |
223 | enum generic_snapshot_flags { |
224 | kUser64_p = 0x1, |
225 | kKernel64_p = 0x2 |
226 | }; |
227 | |
228 | #define VM_PRESSURE_TIME_WINDOW 5 /* seconds */ |
229 | |
230 | enum { |
231 | STACKSHOT_GET_DQ = 0x01, |
232 | STACKSHOT_SAVE_LOADINFO = 0x02, |
233 | STACKSHOT_GET_GLOBAL_MEM_STATS = 0x04, |
234 | STACKSHOT_SAVE_KEXT_LOADINFO = 0x08, |
235 | STACKSHOT_GET_MICROSTACKSHOT = 0x10, |
236 | STACKSHOT_GLOBAL_MICROSTACKSHOT_ENABLE = 0x20, |
237 | STACKSHOT_GLOBAL_MICROSTACKSHOT_DISABLE = 0x40, |
238 | STACKSHOT_SET_MICROSTACKSHOT_MARK = 0x80, |
239 | STACKSHOT_ACTIVE_KERNEL_THREADS_ONLY = 0x100, |
240 | STACKSHOT_GET_BOOT_PROFILE = 0x200, |
241 | STACKSHOT_SAVE_IMP_DONATION_PIDS = 0x2000, |
242 | STACKSHOT_SAVE_IN_KERNEL_BUFFER = 0x4000, |
243 | STACKSHOT_RETRIEVE_EXISTING_BUFFER = 0x8000, |
244 | STACKSHOT_KCDATA_FORMAT = 0x10000, |
245 | STACKSHOT_ENABLE_BT_FAULTING = 0x20000, |
246 | STACKSHOT_COLLECT_DELTA_SNAPSHOT = 0x40000, |
247 | /* Include the layout of the system shared cache */ |
248 | STACKSHOT_COLLECT_SHAREDCACHE_LAYOUT = 0x80000, |
249 | /* |
250 | * Kernel consumers of stackshot (via stack_snapshot_from_kernel) can ask |
251 | * that we try to take the stackshot lock, and fail if we don't get it. |
252 | */ |
253 | STACKSHOT_TRYLOCK = 0x100000, |
254 | STACKSHOT_ENABLE_UUID_FAULTING = 0x200000, |
255 | STACKSHOT_FROM_PANIC = 0x400000, |
256 | STACKSHOT_NO_IO_STATS = 0x800000, |
257 | /* Report owners of and pointers to kernel objects that threads are blocked on */ |
258 | STACKSHOT_THREAD_WAITINFO = 0x1000000, |
259 | STACKSHOT_THREAD_GROUP = 0x2000000, |
260 | STACKSHOT_SAVE_JETSAM_COALITIONS = 0x4000000, |
261 | STACKSHOT_INSTRS_CYCLES = 0x8000000, |
262 | STACKSHOT_ASID = 0x10000000, |
263 | STACKSHOT_PAGE_TABLES = 0x20000000, |
264 | }; |
265 | |
266 | #define STACKSHOT_THREAD_SNAPSHOT_MAGIC 0xfeedface |
267 | #define STACKSHOT_TASK_SNAPSHOT_MAGIC 0xdecafbad |
268 | #define STACKSHOT_MEM_AND_IO_SNAPSHOT_MAGIC 0xbfcabcde |
269 | #define STACKSHOT_MICRO_SNAPSHOT_MAGIC 0x31c54011 |
270 | |
271 | #define KF_INITIALIZED (0x1) |
272 | #define KF_SERIAL_OVRD (0x2) |
273 | #define KF_PMAPV_OVRD (0x4) |
274 | #define KF_MATV_OVRD (0x8) |
275 | #define KF_STACKSHOT_OVRD (0x10) |
276 | #define KF_COMPRSV_OVRD (0x20) |
277 | |
278 | boolean_t kern_feature_override(uint32_t fmask); |
279 | |
280 | /* |
281 | * Any updates to this header should be also updated in astris as it can not |
282 | * grab this header from the SDK. |
283 | * |
284 | * NOTE: DO NOT REMOVE OR CHANGE THE MEANING OF ANY FIELDS FROM THIS STRUCTURE. |
285 | * Any modifications should add new fields at the end, bump the version number |
286 | * and be done alongside astris and DumpPanic changes. |
287 | */ |
288 | struct { |
289 | uint32_t ; /* EMBEDDED_PANIC_MAGIC if valid */ |
290 | uint32_t ; /* CRC of everything following the ph_crc in the header and the contents */ |
291 | uint32_t ; /* embedded_panic_header version */ |
292 | uint64_t ; /* Flags indicating any state or relevant details */ |
293 | uint32_t ; /* Offset of the beginning of the panic log from the beginning of the header */ |
294 | uint32_t ; /* length of the panic log */ |
295 | uint32_t ; /* Offset of the beginning of the panic stackshot from the beginning of the header */ |
296 | uint32_t ; /* length of the panic stackshot (0 if not valid ) */ |
297 | uint32_t ; /* Offset of the other log (any logging subsequent to the stackshot) from the beginning of the header */ |
298 | uint32_t ; /* length of the other log */ |
299 | union { |
300 | struct { |
301 | uint64_t :8, |
302 | :8, |
303 | :8, |
304 | :40; |
305 | }; // anonymous struct to group the bitfields together. |
306 | uint64_t ; /* Used for offsetof/sizeof when parsing header */ |
307 | }; |
308 | } __attribute__((packed)); |
309 | |
310 | #define 0x01 |
311 | #define 0x02 |
312 | #define 0x04 |
313 | #define 0x08 |
314 | #define 0x10 |
315 | #define 0x20 |
316 | #define 0x40 |
317 | #define 0x80 |
318 | #define 0x100 |
319 | #define 0x200 |
320 | |
321 | #define 2 |
322 | #define EMBEDDED_PANIC_MAGIC 0x46554E4B /* FUNK */ |
323 | |
324 | struct { |
325 | uint32_t ; /* MACOS_PANIC_MAGIC if valid */ |
326 | uint32_t ; /* CRC of everything following mph_crc in the header and the contents */ |
327 | uint32_t ; /* macos_panic_header version */ |
328 | uint32_t ; /* unused */ |
329 | uint64_t ; /* Flags indicating any state or relevant details */ |
330 | uint32_t ; /* Offset of the panic log from the beginning of the header */ |
331 | uint32_t ; /* length of the panic log */ |
332 | uint32_t ; /* Offset of the panic stackshot from the beginning of the header */ |
333 | uint32_t ; /* length of the panic stackshot */ |
334 | uint32_t ; /* Offset of the other log (any logging subsequent to the stackshot) from the beginning of the header */ |
335 | uint32_t ; /* length of the other log */ |
336 | char []; /* panic data -- DO NOT ACCESS THIS FIELD DIRECTLY. Use the offsets above relative to the beginning of the header */ |
337 | } __attribute__((packed)); |
338 | |
339 | #define 2 |
340 | #define MACOS_PANIC_MAGIC 0x44454544 /* DEED */ |
341 | |
342 | #define 0x01 |
343 | #define 0x02 |
344 | #define 0x04 |
345 | #define 0x08 |
346 | #define 0x10 |
347 | #define 0x20 |
348 | #define 0x40 |
349 | #define 0x80 |
350 | #define 0x100 |
351 | #define 0x200 |
352 | #define 0x400 |
353 | |
354 | #endif /* __APPLE_API_UNSTABLE */ |
355 | #endif /* __APPLE_API_PRIVATE */ |
356 | |
357 | #ifdef KERNEL |
358 | |
359 | __BEGIN_DECLS |
360 | |
361 | extern void panic(const char *string, ...) __printflike(1,2); |
362 | |
363 | __END_DECLS |
364 | |
365 | #endif /* KERNEL */ |
366 | |
367 | #ifdef KERNEL_PRIVATE |
368 | #if DEBUG |
369 | #ifndef DKPR |
370 | #define DKPR 1 |
371 | #endif |
372 | #endif |
373 | |
374 | #if DKPR |
375 | /* |
376 | * For the DEBUG kernel, support the following: |
377 | * sysctl -w debug.kprint_syscall=<syscall_mask> |
378 | * sysctl -w debug.kprint_syscall_process=<p_comm> |
379 | * <syscall_mask> should be an OR of the masks below |
380 | * for UNIX, MACH, MDEP, or IPC. This debugging aid |
381 | * assumes the task/process is locked/wired and will |
382 | * not go away during evaluation. If no process is |
383 | * specified, all processes will be traced |
384 | */ |
385 | extern int debug_kprint_syscall; |
386 | extern int debug_kprint_current_process(const char **namep); |
387 | #define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep) \ |
388 | ( (debug_kprint_syscall & (mask)) && debug_kprint_current_process(namep) ) |
389 | #define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { \ |
390 | const char *dks_name = NULL; \ |
391 | if (DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, &dks_name)) { \ |
392 | kprintf("[%s%s%p]" fmt, dks_name ? dks_name : "", \ |
393 | dks_name ? "@" : "", current_thread(), args); \ |
394 | } \ |
395 | } while (0) |
396 | #else /* !DEBUG */ |
397 | #define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep) (0) |
398 | #define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { } while (0) /* kprintf(fmt, args) */ |
399 | #endif /* !DEBUG */ |
400 | |
401 | enum { |
402 | DEBUG_KPRINT_SYSCALL_UNIX_MASK = 1 << 0, |
403 | DEBUG_KPRINT_SYSCALL_MACH_MASK = 1 << 1, |
404 | DEBUG_KPRINT_SYSCALL_MDEP_MASK = 1 << 2, |
405 | DEBUG_KPRINT_SYSCALL_IPC_MASK = 1 << 3 |
406 | }; |
407 | |
408 | #define DEBUG_KPRINT_SYSCALL_PREDICATE(mask) \ |
409 | DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, NULL) |
410 | #define DEBUG_KPRINT_SYSCALL_UNIX(fmt, args...) \ |
411 | DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_UNIX_MASK,fmt,args) |
412 | #define DEBUG_KPRINT_SYSCALL_MACH(fmt, args...) \ |
413 | DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_MACH_MASK,fmt,args) |
414 | #define DEBUG_KPRINT_SYSCALL_MDEP(fmt, args...) \ |
415 | DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_MDEP_MASK,fmt,args) |
416 | #define DEBUG_KPRINT_SYSCALL_IPC(fmt, args...) \ |
417 | DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_IPC_MASK,fmt,args) |
418 | |
419 | /* Debug boot-args */ |
420 | #define DB_HALT 0x1 |
421 | //#define DB_PRT 0x2 -- obsolete |
422 | #define DB_NMI 0x4 |
423 | #define DB_KPRT 0x8 |
424 | #define DB_KDB 0x10 |
425 | #define DB_ARP 0x40 |
426 | #define DB_KDP_BP_DIS 0x80 |
427 | //#define DB_LOG_PI_SCRN 0x100 -- obsolete |
428 | #define DB_KDP_GETC_ENA 0x200 |
429 | |
430 | #define DB_KERN_DUMP_ON_PANIC 0x400 /* Trigger core dump on panic*/ |
431 | #define DB_KERN_DUMP_ON_NMI 0x800 /* Trigger core dump on NMI */ |
432 | #define DB_DBG_POST_CORE 0x1000 /*Wait in debugger after NMI core */ |
433 | #define DB_PANICLOG_DUMP 0x2000 /* Send paniclog on panic,not core*/ |
434 | #define DB_REBOOT_POST_CORE 0x4000 /* Attempt to reboot after |
435 | * post-panic crashdump/paniclog |
436 | * dump. |
437 | */ |
438 | #define DB_NMI_BTN_ENA 0x8000 /* Enable button to directly trigger NMI */ |
439 | #define DB_PRT_KDEBUG 0x10000 /* kprintf KDEBUG traces */ |
440 | #define DB_DISABLE_LOCAL_CORE 0x20000 /* ignore local kernel core dump support */ |
441 | #define DB_DISABLE_GZIP_CORE 0x40000 /* don't gzip kernel core dumps */ |
442 | #define DB_DISABLE_CROSS_PANIC 0x80000 /* x86 only - don't trigger cross panics. Only |
443 | * necessary to enable x86 kernel debugging on |
444 | * configs with a dev-fused co-processor running |
445 | * release bridgeOS. |
446 | */ |
447 | #define DB_REBOOT_ALWAYS 0x100000 /* Don't wait for debugger connection */ |
448 | |
449 | /* |
450 | * Values for a 64-bit mask that's passed to the debugger. |
451 | */ |
452 | #define DEBUGGER_OPTION_NONE 0x0ULL |
453 | #define DEBUGGER_OPTION_PANICLOGANDREBOOT 0x1ULL /* capture a panic log and then reboot immediately */ |
454 | #define DEBUGGER_OPTION_RECURPANIC_ENTRY 0x2ULL |
455 | #define DEBUGGER_OPTION_RECURPANIC_PRELOG 0x4ULL |
456 | #define DEBUGGER_OPTION_RECURPANIC_POSTLOG 0x8ULL |
457 | #define DEBUGGER_OPTION_RECURPANIC_POSTCORE 0x10ULL |
458 | #define DEBUGGER_OPTION_INITPROC_PANIC 0x20ULL |
459 | #define DEBUGGER_OPTION_COPROC_INITIATED_PANIC 0x40ULL /* panic initiated by a co-processor */ |
460 | #define DEBUGGER_OPTION_SKIP_LOCAL_COREDUMP 0x80ULL /* don't try to save local coredumps for this panic */ |
461 | #define DEBUGGER_OPTION_ATTEMPTCOREDUMPANDREBOOT 0x100ULL /* attempt to save coredump. always reboot */ |
462 | #define DEBUGGER_INTERNAL_OPTION_THREAD_BACKTRACE 0x200ULL /* backtrace the specified thread in the paniclog (x86 only) */ |
463 | |
464 | #define DEBUGGER_INTERNAL_OPTIONS_MASK (DEBUGGER_INTERNAL_OPTION_THREAD_BACKTRACE) |
465 | |
466 | __BEGIN_DECLS |
467 | |
468 | #define panic_plain(ex, ...) (panic)(ex, ## __VA_ARGS__) |
469 | |
470 | #define __STRINGIFY(x) #x |
471 | #define LINE_NUMBER(x) __STRINGIFY(x) |
472 | #define PANIC_LOCATION __FILE__ ":" LINE_NUMBER(__LINE__) |
473 | |
474 | #if CONFIG_EMBEDDED |
475 | #define panic(ex, ...) (panic)(# ex, ## __VA_ARGS__) |
476 | #else |
477 | #define panic(ex, ...) (panic)(# ex "@" PANIC_LOCATION, ## __VA_ARGS__) |
478 | #endif |
479 | |
480 | void panic_with_options(unsigned int reason, void *ctx, uint64_t debugger_options_mask, const char *str, ...); |
481 | void Debugger(const char * message); |
482 | void populate_model_name(char *); |
483 | |
484 | unsigned panic_active(void); |
485 | |
486 | __END_DECLS |
487 | |
488 | #endif /* KERNEL_PRIVATE */ |
489 | |
490 | #if XNU_KERNEL_PRIVATE |
491 | |
492 | #if defined (__x86_64__) |
493 | struct thread; |
494 | |
495 | void panic_with_thread_context(unsigned int reason, void *ctx, uint64_t debugger_options_mask, struct thread* th, const char *str, ...); |
496 | #endif |
497 | |
498 | boolean_t oslog_is_safe(void); |
499 | boolean_t debug_mode_active(void); |
500 | boolean_t stackshot_active(void); |
501 | void panic_stackshot_reset_state(void); |
502 | |
503 | /* |
504 | * @function stack_snapshot_from_kernel |
505 | * |
506 | * @abstract Stackshot function for kernel consumers who have their own buffer. |
507 | * |
508 | * @param pid the PID to be traced or -1 for the whole system |
509 | * @param buf a pointer to the buffer where the stackshot should be written |
510 | * @param size the size of the buffer |
511 | * @param flags flags to be passed to the stackshot |
512 | * @param delta_since_timestamp start time for delta period |
513 | * @bytes_traced a pointer to be filled with the length of the stackshot |
514 | * |
515 | */ |
516 | #ifdef __cplusplus |
517 | extern "C" { |
518 | #endif |
519 | kern_return_t |
520 | stack_snapshot_from_kernel(int pid, void *buf, uint32_t size, uint32_t flags, |
521 | uint64_t delta_since_timestamp, unsigned *bytes_traced); |
522 | #ifdef __cplusplus |
523 | } |
524 | #endif |
525 | |
526 | #if !CONFIG_EMBEDDED |
527 | extern char debug_buf[]; |
528 | extern boolean_t coprocessor_paniclog_flush; |
529 | extern boolean_t extended_debug_log_enabled;; |
530 | #endif /* !CONFIG_EMBEDDED */ |
531 | |
532 | extern char *debug_buf_base; |
533 | |
534 | extern char kernel_uuid_string[]; |
535 | extern char panic_disk_error_description[]; |
536 | extern size_t panic_disk_error_description_size; |
537 | |
538 | extern unsigned char *kernel_uuid; |
539 | extern unsigned int debug_boot_arg; |
540 | #if DEVELOPMENT || DEBUG |
541 | extern boolean_t debug_boot_arg_inited; |
542 | #endif |
543 | |
544 | extern boolean_t kernelcache_uuid_valid; |
545 | extern uuid_t kernelcache_uuid; |
546 | extern uuid_string_t kernelcache_uuid_string; |
547 | |
548 | #ifdef __cplusplus |
549 | extern "C" { |
550 | #endif |
551 | |
552 | extern boolean_t doprnt_hide_pointers; |
553 | |
554 | #ifdef __cplusplus |
555 | } |
556 | #endif |
557 | |
558 | extern unsigned int halt_in_debugger; /* pending halt in debugger after boot */ |
559 | extern unsigned int current_debugger; |
560 | #define NO_CUR_DB 0x0 |
561 | #define KDP_CUR_DB 0x1 |
562 | |
563 | extern unsigned int active_debugger; |
564 | extern unsigned int kernel_debugger_entry_count; |
565 | |
566 | extern unsigned int panicDebugging; |
567 | extern unsigned int kdebug_serial; |
568 | |
569 | extern const char *debugger_panic_str; |
570 | |
571 | extern char *debug_buf_ptr; |
572 | extern unsigned int debug_buf_size; |
573 | |
574 | extern void debug_log_init(void); |
575 | extern void debug_putc(char); |
576 | |
577 | extern void panic_init(void); |
578 | |
579 | #if defined (__x86_64__) |
580 | extern void extended_debug_log_init(void); |
581 | |
582 | int packA(char *inbuf, uint32_t length, uint32_t buflen); |
583 | void unpackA(char *inbuf, uint32_t length); |
584 | |
585 | #if DEVELOPMENT || DEBUG |
586 | #define PANIC_STACKSHOT_BUFSIZE (1024 * 1024) |
587 | |
588 | extern uintptr_t panic_stackshot_buf; |
589 | extern size_t panic_stackshot_len; |
590 | #endif /* DEVELOPMENT || DEBUG */ |
591 | #endif /* defined (__x86_64__) */ |
592 | |
593 | void SavePanicInfo(const char *message, void *panic_data, uint64_t panic_options); |
594 | void paniclog_flush(void); |
595 | void panic_display_system_configuration(boolean_t launchd_exit); |
596 | void panic_display_zprint(void); |
597 | void panic_display_kernel_aslr(void); |
598 | void panic_display_hibb(void); |
599 | void panic_display_model_name(void); |
600 | void panic_display_kernel_uuid(void); |
601 | #if CONFIG_ZLEAKS |
602 | void panic_display_ztrace(void); |
603 | #endif /* CONFIG_ZLEAKS */ |
604 | #if CONFIG_ECC_LOGGING |
605 | void panic_display_ecc_errors(void); |
606 | #endif /* CONFIG_ECC_LOGGING */ |
607 | |
608 | /* |
609 | * @var not_in_kdp |
610 | * |
611 | * @abstract True if we're in normal kernel operation, False if we're in a |
612 | * single-core debugger context. |
613 | */ |
614 | extern unsigned int not_in_kdp; |
615 | |
616 | #define DEBUGGER_NO_CPU -1 |
617 | |
618 | typedef enum { |
619 | DBOP_NONE, |
620 | DBOP_STACKSHOT, |
621 | DBOP_RESET_PGO_COUNTERS, |
622 | DBOP_PANIC, |
623 | DBOP_DEBUGGER, |
624 | DBOP_BREAKPOINT, |
625 | } debugger_op; |
626 | |
627 | kern_return_t DebuggerTrapWithState(debugger_op db_op, const char *db_message, const char *db_panic_str, va_list *db_panic_args, |
628 | uint64_t db_panic_options, void *db_panic_data_ptr, boolean_t db_proceed_on_sync_failure, unsigned long db_panic_caller); |
629 | void handle_debugger_trap(unsigned int exception, unsigned int code, unsigned int subcode, void *state); |
630 | |
631 | void DebuggerWithContext(unsigned int reason, void *ctx, const char *message, uint64_t debugger_options_mask); |
632 | |
633 | #if DEBUG || DEVELOPMENT |
634 | /* leak pointer scan definitions */ |
635 | |
636 | enum |
637 | { |
638 | kInstanceFlagAddress = 0x01UL, |
639 | kInstanceFlagReferenced = 0x02UL, |
640 | kInstanceFlags = 0x03UL |
641 | }; |
642 | |
643 | #define INSTANCE_GET(x) ((x) & ~kInstanceFlags) |
644 | #define INSTANCE_PUT(x) ((x) ^ ~kInstanceFlags) |
645 | |
646 | typedef void (*leak_site_proc)(void * refCon, uint32_t siteCount, uint32_t zoneSize, |
647 | uintptr_t * backtrace, uint32_t btCount); |
648 | |
649 | #ifdef __cplusplus |
650 | extern "C" { |
651 | #endif |
652 | |
653 | extern kern_return_t |
654 | zone_leaks(const char * zoneName, uint32_t nameLen, leak_site_proc proc, void * refCon); |
655 | |
656 | extern void |
657 | zone_leaks_scan(uintptr_t * instances, uint32_t count, uint32_t zoneSize, uint32_t * found); |
658 | |
659 | #ifdef __cplusplus |
660 | } |
661 | #endif |
662 | |
663 | extern boolean_t |
664 | kdp_is_in_zone(void *addr, const char *zone_name); |
665 | |
666 | #endif /* DEBUG || DEVELOPMENT */ |
667 | #endif /* XNU_KERNEL_PRIVATE */ |
668 | |
669 | #endif /* _KERN_DEBUG_H_ */ |
670 | |