]> git.saurik.com Git - apple/xnu.git/blob - osfmk/kern/debug.h
b05e7a90a3d278aaf5d42f4b1f2fc1d0cd3f64f8
[apple/xnu.git] / osfmk / kern / debug.h
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 <uuid/uuid.h>
37 #include <mach/boolean.h>
38 #include <mach/kern_return.h>
39
40 #ifndef XNU_KERNEL_PRIVATE
41 #include <TargetConditionals.h>
42 #endif
43
44 #ifdef __APPLE_API_PRIVATE
45 #ifdef __APPLE_API_UNSTABLE
46
47 struct thread_snapshot {
48 uint32_t snapshot_magic;
49 uint32_t nkern_frames;
50 uint32_t nuser_frames;
51 uint64_t wait_event;
52 uint64_t continuation;
53 uint64_t thread_id;
54 uint64_t user_time;
55 uint64_t system_time;
56 int32_t state;
57 int32_t priority; /* static priority */
58 int32_t sched_pri; /* scheduled (current) priority */
59 int32_t sched_flags; /* scheduler flags */
60 char ss_flags;
61 char ts_qos; /* effective qos */
62 char ts_rqos; /* requested qos */
63 char ts_rqos_override; /* requested qos override */
64 char io_tier;
65 char _reserved[3]; /* pad for 4 byte alignement packing */
66
67 /*
68 * I/O Statistics
69 * XXX: These fields must be together
70 */
71 uint64_t disk_reads_count;
72 uint64_t disk_reads_size;
73 uint64_t disk_writes_count;
74 uint64_t disk_writes_size;
75 uint64_t io_priority_count[STACKSHOT_IO_NUM_PRIORITIES];
76 uint64_t io_priority_size[STACKSHOT_IO_NUM_PRIORITIES];
77 uint64_t paging_count;
78 uint64_t paging_size;
79 uint64_t non_paging_count;
80 uint64_t non_paging_size;
81 uint64_t data_count;
82 uint64_t data_size;
83 uint64_t metadata_count;
84 uint64_t metadata_size;
85 /* XXX: I/O Statistics end */
86
87 uint64_t voucher_identifier; /* obfuscated voucher identifier */
88 uint64_t total_syscalls;
89 char pth_name[STACKSHOT_MAX_THREAD_NAME_SIZE];
90
91 } __attribute__((packed));
92
93 /* old, non kcdata format */
94 struct task_snapshot {
95 uint32_t snapshot_magic;
96 int32_t pid;
97 uint64_t uniqueid;
98 uint64_t user_time_in_terminated_threads;
99 uint64_t system_time_in_terminated_threads;
100 uint8_t shared_cache_identifier[16];
101 uint64_t shared_cache_slide;
102 uint32_t nloadinfos;
103 int suspend_count;
104 int task_size; /* pages */
105 int faults; /* number of page faults */
106 int pageins; /* number of actual pageins */
107 int cow_faults; /* number of copy-on-write faults */
108 uint32_t ss_flags;
109 uint64_t p_start_sec; /* from the bsd proc struct */
110 uint64_t p_start_usec; /* from the bsd proc struct */
111
112 /*
113 * We restrict ourselves to a statically defined
114 * (current as of 2009) length for the
115 * p_comm string, due to scoping issues (osfmk/bsd and user/kernel
116 * binary compatibility).
117 */
118 char p_comm[17];
119 uint32_t was_throttled;
120 uint32_t did_throttle;
121 uint32_t latency_qos;
122 /*
123 * I/O Statistics
124 * XXX: These fields must be together.
125 */
126 uint64_t disk_reads_count;
127 uint64_t disk_reads_size;
128 uint64_t disk_writes_count;
129 uint64_t disk_writes_size;
130 uint64_t io_priority_count[STACKSHOT_IO_NUM_PRIORITIES];
131 uint64_t io_priority_size[STACKSHOT_IO_NUM_PRIORITIES];
132 uint64_t paging_count;
133 uint64_t paging_size;
134 uint64_t non_paging_count;
135 uint64_t non_paging_size;
136 uint64_t data_count;
137 uint64_t data_size;
138 uint64_t metadata_count;
139 uint64_t metadata_size;
140 /* XXX: I/O Statistics end */
141
142 uint32_t donating_pid_count;
143
144 } __attribute__ ((packed));
145
146
147
148 struct micro_snapshot {
149 uint32_t snapshot_magic;
150 uint32_t ms_cpu; /* cpu number this snapshot was recorded on */
151 uint64_t ms_time; /* time at sample (seconds) */
152 uint64_t ms_time_microsecs;
153 uint8_t ms_flags;
154 uint16_t ms_opaque_flags; /* managed by external entity, e.g. fdrmicrod */
155 } __attribute__ ((packed));
156
157
158
159 struct _dyld_cache_header
160 {
161 char magic[16]; // e.g. "dyld_v0 i386"
162 uint32_t mappingOffset; // file offset to first dyld_cache_mapping_info
163 uint32_t mappingCount; // number of dyld_cache_mapping_info entries
164 uint32_t imagesOffset; // file offset to first dyld_cache_image_info
165 uint32_t imagesCount; // number of dyld_cache_image_info entries
166 uint64_t dyldBaseAddress; // base address of dyld when cache was built
167 uint64_t codeSignatureOffset; // file offset of code signature blob
168 uint64_t codeSignatureSize; // size of code signature blob (zero means to end of file)
169 uint64_t slideInfoOffset; // file offset of kernel slid info
170 uint64_t slideInfoSize; // size of kernel slid info
171 uint64_t localSymbolsOffset; // file offset of where local symbols are stored
172 uint64_t localSymbolsSize; // size of local symbols information
173 uint8_t uuid[16]; // unique value for each shared cache file
174 };
175
176
177 enum micro_snapshot_flags {
178 kInterruptRecord = 0x1,
179 kTimerArmingRecord = 0x2,
180 kUserMode = 0x4, /* interrupted usermode, or armed by usermode */
181 kIORecord = 0x8,
182 };
183
184 /*
185 * Flags used in the following assortment of snapshots.
186 */
187 enum generic_snapshot_flags {
188 kUser64_p = 0x1,
189 kKernel64_p = 0x2
190 };
191
192
193 #define VM_PRESSURE_TIME_WINDOW 5 /* seconds */
194
195 enum {
196 STACKSHOT_GET_DQ = 0x01,
197 STACKSHOT_SAVE_LOADINFO = 0x02,
198 STACKSHOT_GET_GLOBAL_MEM_STATS = 0x04,
199 STACKSHOT_SAVE_KEXT_LOADINFO = 0x08,
200 STACKSHOT_GET_MICROSTACKSHOT = 0x10,
201 STACKSHOT_GLOBAL_MICROSTACKSHOT_ENABLE = 0x20,
202 STACKSHOT_GLOBAL_MICROSTACKSHOT_DISABLE = 0x40,
203 STACKSHOT_SET_MICROSTACKSHOT_MARK = 0x80,
204 STACKSHOT_ACTIVE_KERNEL_THREADS_ONLY = 0x100,
205 STACKSHOT_GET_BOOT_PROFILE = 0x200,
206 STACKSHOT_SAVE_IMP_DONATION_PIDS = 0x2000,
207 STACKSHOT_SAVE_IN_KERNEL_BUFFER = 0x4000,
208 STACKSHOT_RETRIEVE_EXISTING_BUFFER = 0x8000,
209 STACKSHOT_KCDATA_FORMAT = 0x10000,
210 STACKSHOT_ENABLE_BT_FAULTING = 0x20000,
211 STACKSHOT_COLLECT_DELTA_SNAPSHOT = 0x40000,
212 /*
213 * STACKSHOT_TAILSPIN flips on several features aimed at minimizing the size
214 * of stackshots. It is meant to be used only by the tailspin daemon. Its
215 * behavior may be changed at any time to suit the needs of the tailspin
216 * daemon. Seriously, if you are not the tailspin daemon, don't use this
217 * flag. If you need these features, ask us to add a stable SPI for what
218 * you need. That being said, the features it turns on are:
219 *
220 * minimize_uuids: If the set of loaded dylibs or kexts has not changed in
221 * the delta period, do then not report them.
222 *
223 * iostats: do not include io statistics.
224 *
225 * trace_fp: do not include the frame pointers in stack traces.
226 *
227 * minimize_nonrunnables: Do not report detailed information about threads
228 * which were not runnable in the delta period.
229 */
230 STACKSHOT_TAILSPIN = 0x80000,
231 /*
232 * Kernel consumers of stackshot (via stack_snapshot_from_kernel) can ask
233 * that we try to take the stackshot lock, and fail if we don't get it.
234 */
235 STACKSHOT_TRYLOCK = 0x100000,
236 STACKSHOT_ENABLE_UUID_FAULTING = 0x200000,
237 STACKSHOT_FROM_PANIC = 0x400000,
238 STACKSHOT_NO_IO_STATS = 0x800000,
239 /* Report owners of and pointers to kernel objects that threads are blocked on */
240 STACKSHOT_THREAD_WAITINFO = 0x1000000,
241 };
242
243 #define STACKSHOT_THREAD_SNAPSHOT_MAGIC 0xfeedface
244 #define STACKSHOT_TASK_SNAPSHOT_MAGIC 0xdecafbad
245 #define STACKSHOT_MEM_AND_IO_SNAPSHOT_MAGIC 0xbfcabcde
246 #define STACKSHOT_MICRO_SNAPSHOT_MAGIC 0x31c54011
247
248 #endif /* __APPLE_API_UNSTABLE */
249 #endif /* __APPLE_API_PRIVATE */
250
251 #ifdef KERNEL_PRIVATE
252
253 extern unsigned int systemLogDiags;
254 #if (!defined(__arm64__) && !defined(NAND_PANIC_DEVICE)) || defined(LEGACY_PANIC_LOGS)
255 extern char debug_buf[];
256 #endif
257 extern char *debug_buf_addr;
258 extern char *debug_buf_stackshot_start;
259 extern char *debug_buf_stackshot_end;
260
261 extern unsigned int debug_boot_arg;
262 extern unsigned char *kernel_uuid;
263 extern char kernel_uuid_string[];
264 extern char panic_disk_error_description[];
265 extern size_t panic_disk_error_description_size;
266
267 #ifdef MACH_KERNEL_PRIVATE
268
269 extern boolean_t doprnt_hide_pointers;
270
271 extern unsigned int halt_in_debugger;
272
273 extern unsigned int switch_debugger;
274
275 extern unsigned int current_debugger;
276 #define NO_CUR_DB 0x0
277 #define KDP_CUR_DB 0x1
278 //#define KDB_CUR_DB 0x2
279 #define HW_SHM_CUR_DB 0x3
280
281 extern unsigned int active_debugger;
282 extern unsigned int debug_mode;
283 extern unsigned int disable_debug_output;
284
285 extern unsigned int panicDebugging;
286 extern unsigned int logPanicDataToScreen;
287 extern unsigned int kdebug_serial;
288
289 extern int db_run_mode;
290
291 /* modes the system may be running in */
292
293 #define STEP_NONE 0
294 #define STEP_ONCE 1
295 #define STEP_RETURN 2
296 #define STEP_CALLT 3
297 #define STEP_CONTINUE 4
298 #define STEP_INVISIBLE 5
299 #define STEP_COUNT 6
300 #define STEP_TRACE 7 /* Show all calls to functions and returns */
301
302 extern const char *panicstr;
303 extern volatile unsigned int nestedpanic;
304 extern int unsigned long panic_caller;
305
306 extern char *debug_buf_ptr;
307 extern unsigned int debug_buf_size;
308
309 extern void debug_log_init(void);
310 extern void debug_putc(char);
311
312 extern void panic_init(void);
313
314 int packA(char *inbuf, uint32_t length, uint32_t buflen);
315 void unpackA(char *inbuf, uint32_t length);
316
317 void panic_display_system_configuration(boolean_t launchd_exit);
318 void panic_display_zprint(void);
319 void panic_display_kernel_aslr(void);
320 void panic_display_hibb(void);
321 void panic_display_model_name(void);
322 void panic_display_kernel_uuid(void);
323 #if CONFIG_ZLEAKS
324 void panic_display_ztrace(void);
325 #endif /* CONFIG_ZLEAKS */
326 #if CONFIG_ECC_LOGGING
327 void panic_display_ecc_errors(void);
328 #endif /* CONFIG_ECC_LOGGING */
329 #endif /* MACH_KERNEL_PRIVATE */
330
331 #define DB_HALT 0x1
332 #define DB_PRT 0x2
333 #define DB_NMI 0x4
334 #define DB_KPRT 0x8
335 #define DB_KDB 0x10
336 #define DB_SLOG 0x20
337 #define DB_ARP 0x40
338 #define DB_KDP_BP_DIS 0x80
339 #define DB_LOG_PI_SCRN 0x100
340 #define DB_KDP_GETC_ENA 0x200
341
342 #define DB_KERN_DUMP_ON_PANIC 0x400 /* Trigger core dump on panic*/
343 #define DB_KERN_DUMP_ON_NMI 0x800 /* Trigger core dump on NMI */
344 #define DB_DBG_POST_CORE 0x1000 /*Wait in debugger after NMI core */
345 #define DB_PANICLOG_DUMP 0x2000 /* Send paniclog on panic,not core*/
346 #define DB_REBOOT_POST_CORE 0x4000 /* Attempt to reboot after
347 * post-panic crashdump/paniclog
348 * dump.
349 */
350 #define DB_NMI_BTN_ENA 0x8000 /* Enable button to directly trigger NMI */
351 #define DB_PRT_KDEBUG 0x10000 /* kprintf KDEBUG traces */
352 #define DB_DISABLE_LOCAL_CORE 0x20000 /* ignore local kernel core dump support */
353 #define DB_DISABLE_GZIP_CORE 0x40000 /* don't gzip kernel core dumps */
354
355 #if DEBUG
356 /*
357 * For the DEBUG kernel, support the following:
358 * sysctl -w debug.kprint_syscall=<syscall_mask>
359 * sysctl -w debug.kprint_syscall_process=<p_comm>
360 * <syscall_mask> should be an OR of the masks below
361 * for UNIX, MACH, MDEP, or IPC. This debugging aid
362 * assumes the task/process is locked/wired and will
363 * not go away during evaluation. If no process is
364 * specified, all processes will be traced
365 */
366 extern int debug_kprint_syscall;
367 extern int debug_kprint_current_process(const char **namep);
368 #define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep) \
369 ( (debug_kprint_syscall & (mask)) && debug_kprint_current_process(namep) )
370 #define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { \
371 const char *dks_name = NULL; \
372 if (DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, &dks_name)) { \
373 kprintf("[%s%s%p]" fmt, dks_name ? dks_name : "", \
374 dks_name ? "@" : "", current_thread(), args); \
375 } \
376 } while (0)
377 #else /* !DEBUG */
378 #define DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, namep) (0)
379 #define DEBUG_KPRINT_SYSCALL_MASK(mask, fmt, args...) do { } while (0) /* kprintf(fmt, args) */
380 #endif /* !DEBUG */
381
382 enum {
383 DEBUG_KPRINT_SYSCALL_UNIX_MASK = 1 << 0,
384 DEBUG_KPRINT_SYSCALL_MACH_MASK = 1 << 1,
385 DEBUG_KPRINT_SYSCALL_MDEP_MASK = 1 << 2,
386 DEBUG_KPRINT_SYSCALL_IPC_MASK = 1 << 3
387 };
388
389 #define DEBUG_KPRINT_SYSCALL_PREDICATE(mask) \
390 DEBUG_KPRINT_SYSCALL_PREDICATE_INTERNAL(mask, NULL)
391 #define DEBUG_KPRINT_SYSCALL_UNIX(fmt, args...) \
392 DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_UNIX_MASK,fmt,args)
393 #define DEBUG_KPRINT_SYSCALL_MACH(fmt, args...) \
394 DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_MACH_MASK,fmt,args)
395 #define DEBUG_KPRINT_SYSCALL_MDEP(fmt, args...) \
396 DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_MDEP_MASK,fmt,args)
397 #define DEBUG_KPRINT_SYSCALL_IPC(fmt, args...) \
398 DEBUG_KPRINT_SYSCALL_MASK(DEBUG_KPRINT_SYSCALL_IPC_MASK,fmt,args)
399
400 #endif /* KERNEL_PRIVATE */
401
402
403 #ifdef XNU_KERNEL_PRIVATE
404
405 /*
406 * @var not_in_kdp
407 *
408 * @abstract True if we're in normal kernel operation, False if we're in a
409 * single-core debugger context.
410 */
411 extern unsigned int not_in_kdp;
412
413 /*
414 * @function DebuggerWithCallback
415 *
416 * @abstract Enter single-core debugger context and call a callback function.
417 *
418 * @param proceed_on_sync_failure If true, then go ahead and try to debug even
419 * if we can't synch with the other cores. This is inherently unsafe and should
420 * only be used if the kernel is going down in flames anyway.
421 *
422 * @result returns KERN_OPERATION_TIMED_OUT if synchronization times out and
423 * proceed_on_sync_failure is false. Otherwise return the return value of the
424 * callback.
425 */
426 kern_return_t
427 DebuggerWithCallback(kern_return_t (*callback) (void*),
428 void *callback_context,
429 boolean_t proceed_on_sync_failure);
430
431 boolean_t oslog_is_safe(void);
432
433 /*
434 * @function stack_snapshot_from_kernel
435 *
436 * @abstract Stackshot function for kernel consumers who have their own buffer.
437 *
438 * @param pid the PID to be traced or -1 for the whole system
439 * @param buf a pointer to the buffer where the stackshot should be written
440 * @param size the size of the buffer
441 * @param flags flags to be passed to the stackshot
442 * @param delta_since_timestamp start time for delta period
443 * @bytes_traced a pointer to be filled with the length of the stackshot
444 *
445 */
446 #ifdef __cplusplus
447 extern "C" {
448 #endif
449 kern_return_t
450 stack_snapshot_from_kernel(int pid, void *buf, uint32_t size, uint32_t flags,
451 uint64_t delta_since_timestamp, unsigned *bytes_traced);
452 #ifdef __cplusplus
453 }
454 #endif
455
456
457 #endif /* XNU_KERNEL_PRIVATE */
458
459 #ifdef KERNEL
460
461 __BEGIN_DECLS
462
463 extern void panic(const char *string, ...) __printflike(1,2);
464
465 #if KERNEL_PRIVATE
466 void _consume_panic_args(int, ...);
467 void panic_context(unsigned int reason, void *ctx, const char *string, ...);
468 void panic_with_options(unsigned int reason, void *ctx, uint64_t debugger_options_mask, const char *str, ...);
469
470 /* launchd crashed prefix in message to signal special panic handling */
471 #define LAUNCHD_CRASHED_PREFIX "initproc exited"
472
473 /*
474 * Values for a 64-bit mask that's passed to the debugger.
475 */
476 #define DEBUGGER_OPTION_NONE 0x0ULL
477 #define DEBUGGER_OPTION_PANICLOGANDREBOOT 0x1ULL /* capture a panic log and then reboot immediately */
478 #endif
479
480 #ifdef CONFIG_NO_PANIC_STRINGS
481 #if KERNEL_PRIVATE
482 #define panic_plain(x, ...) _consume_panic_args( 0, ## __VA_ARGS__ )
483 #define panic(x, ...) _consume_panic_args( 0, ## __VA_ARGS__ )
484 #else
485 #define panic_plain(...) (panic)((char *)0)
486 #define panic(...) (panic)((char *)0)
487 #endif
488 #else /* CONFIGS_NO_PANIC_STRINGS */
489 #define panic_plain(ex, ...) \
490 (panic)(ex, ## __VA_ARGS__)
491 #define __STRINGIFY(x) #x
492 #define LINE_NUMBER(x) __STRINGIFY(x)
493 #define PANIC_LOCATION __FILE__ ":" LINE_NUMBER(__LINE__)
494 #define panic(ex, ...) \
495 (panic)(# ex "@" PANIC_LOCATION, ## __VA_ARGS__)
496 #endif /* CONFIGS_NO_PANIC_STRINGS */
497
498 #ifdef KERNEL_PRIVATE
499 void populate_model_name(char *);
500 unsigned panic_active(void);
501 #endif
502
503
504 #if XNU_KERNEL_PRIVATE
505 #if DEBUG || DEVELOPMENT
506 /* leak pointer scan definitions */
507
508 enum
509 {
510 kInstanceFlagAddress = 0x01UL,
511 kInstanceFlagReferenced = 0x02UL,
512 kInstanceFlags = 0x03UL
513 };
514
515 #define INSTANCE_GET(x) ((x) & ~kInstanceFlags)
516 #define INSTANCE_PUT(x) ((x) ^ ~kInstanceFlags)
517
518 typedef void (*leak_site_proc)(void * refCon, uint32_t siteCount, uint32_t zoneSize,
519 uintptr_t * backtrace, uint32_t btCount);
520
521 extern kern_return_t
522 zone_leaks(const char * zoneName, uint32_t nameLen, leak_site_proc proc, void * refCon);
523
524 extern void
525 zone_leaks_scan(uintptr_t * instances, uint32_t count, uint32_t zoneSize, uint32_t * found);
526
527 extern boolean_t
528 kdp_is_in_zone(void *addr, const char *zone_name);
529
530 #endif /* DEBUG || DEVELOPMENT */
531 #endif /* XNU_KERNEL_PRIVATE */
532
533 __END_DECLS
534
535 #endif /* KERNEL */
536
537 #endif /* _KERN_DEBUG_H_ */