2 * Copyright (c) 2000-2013 Apple Inc. All rights reserved.
4 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
6 * This file contains Original Code and/or Modifications of Original Code
7 * as defined in and that are subject to the Apple Public Source License
8 * Version 2.0 (the 'License'). You may not use this file except in
9 * compliance with the License. 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.
15 * Please obtain a copy of the License at
16 * http://www.opensource.apple.com/apsl/ and read it before using this file.
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.
26 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
32 * Mach Operating System
33 * Copyright (c) 1991,1990,1989 Carnegie Mellon University
34 * All Rights Reserved.
36 * Permission to use, copy, modify and distribute this software and its
37 * documentation is hereby granted, provided that both the copyright
38 * notice and this permission notice appear in all copies of the
39 * software, derivative works or modified versions, and any portions
40 * thereof, and that both notices appear in supporting documentation.
42 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
43 * CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
44 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
46 * Carnegie Mellon requests users of this software to return to
48 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
49 * School of Computer Science
50 * Carnegie Mellon University
51 * Pittsburgh PA 15213-3890
53 * any improvements or extensions that they make and grant Carnegie Mellon
54 * the rights to redistribute these changes.
57 #include <mach_assert.h>
60 #include <kern/cpu_number.h>
61 #include <kern/kalloc.h>
63 #include <kern/thread.h>
64 #include <kern/assert.h>
65 #include <kern/sched_prim.h>
66 #include <kern/misc_protos.h>
67 #include <kern/clock.h>
68 #include <kern/telemetry.h>
70 #include <vm/vm_kern.h>
73 #if !(MACH_KDP && CONFIG_KDP_INTERACTIVE_DEBUGGING)
74 #include <kdp/kdp_udp.h>
77 #if defined(__i386__) || defined(__x86_64__)
78 #include <i386/cpu_threads.h>
79 #include <i386/pmCPU.h>
82 #include <IOKit/IOPlatformExpert.h>
83 #include <machine/pal_routines.h>
85 #include <sys/kdebug.h>
86 #include <libkern/OSKextLibPrivate.h>
87 #include <libkern/OSAtomic.h>
88 #include <libkern/kernel_mach_header.h>
89 #include <uuid/uuid.h>
91 #if (defined(__arm64__) || defined(NAND_PANIC_DEVICE)) && !defined(LEGACY_PANIC_LOGS)
92 #include <pexpert/pexpert.h> /* For gPanicBase */
95 unsigned int halt_in_debugger
= 0;
96 unsigned int switch_debugger
= 0;
97 unsigned int current_debugger
= 0;
98 unsigned int active_debugger
= 0;
99 unsigned int debug_mode
=0;
100 unsigned int disable_debug_output
= TRUE
;
101 unsigned int systemLogDiags
= FALSE
;
102 unsigned int panicDebugging
= FALSE
;
103 unsigned int logPanicDataToScreen
= FALSE
;
107 const char *panicstr
= (char *) 0;
108 decl_simple_lock_data(,panic_lock
)
110 volatile int panicwait
;
111 volatile unsigned int nestedpanic
= 0;
112 unsigned int panic_is_inited
= 0;
113 unsigned int return_on_panic
= 0;
114 unsigned long panic_caller
;
116 #define DEBUG_BUF_SIZE (3 * PAGE_SIZE)
118 /* debug_buf is directly linked with iBoot panic region for ARM64 targets */
119 #if (defined(__arm64__) || defined(NAND_PANIC_DEVICE)) && !defined(LEGACY_PANIC_LOGS)
120 char *debug_buf_addr
= NULL
;
121 char *debug_buf_ptr
= NULL
;
122 unsigned int debug_buf_size
= 0;
124 char debug_buf
[DEBUG_BUF_SIZE
];
125 __used
char *debug_buf_addr
= debug_buf
;
126 char *debug_buf_ptr
= debug_buf
;
127 unsigned int debug_buf_size
= sizeof(debug_buf
);
130 static char model_name
[64];
131 unsigned char *kernel_uuid
;
132 /* uuid_string_t */ char kernel_uuid_string
[37];
134 static spl_t
panic_prologue(const char *str
);
135 static void panic_epilogue(spl_t s
);
146 } __attribute__((packed
));
148 typedef struct pasc pasc_t
;
150 /* Prevent CPP from breaking the definition below */
151 #if CONFIG_NO_PANIC_STRINGS
155 void __attribute__((noinline
))
159 const char *expression
162 int saved_return_on_panic
;
168 saved_return_on_panic
= return_on_panic
;
171 * If we don't have a debugger configured, returning from an
172 * assert is a bad, bad idea; there is no guarantee that we
173 * didn't simply assert before we were able to restart the
176 if (current_debugger
!= NO_CUR_DB
)
179 panic_plain("%s:%d Assertion failed: %s", file
, line
, expression
);
181 return_on_panic
= saved_return_on_panic
;
185 * Carefully use the panic_lock. There's always a chance that
186 * somehow we'll call panic before getting to initialize the
187 * panic_lock -- in this case, we'll assume that the world is
188 * in uniprocessor mode and just avoid using the panic lock.
190 #define PANIC_LOCK() \
192 if (panic_is_inited) \
193 simple_lock(&panic_lock); \
196 #define PANIC_UNLOCK() \
198 if (panic_is_inited) \
199 simple_unlock(&panic_lock); \
205 unsigned long uuidlen
= 0;
208 uuid
= getuuidfromheader(&_mh_execute_header
, &uuidlen
);
209 if ((uuid
!= NULL
) && (uuidlen
== sizeof(uuid_t
))) {
211 uuid_unparse_upper(*(uuid_t
*)uuid
, kernel_uuid_string
);
214 simple_lock_init(&panic_lock
, 0);
222 if (debug_buf_size
!= 0)
224 #if (defined(__arm64__) || defined(NAND_PANIC_DEVICE)) && !defined(LEGACY_PANIC_LOGS)
226 printf("debug_log_init: Error!! gPanicBase is still not initialized\n");
229 /* Shift debug buf start location and size by 8 bytes for magic header and crc value */
230 debug_buf_addr
= (char*)gPanicBase
+ 8;
231 debug_buf_ptr
= debug_buf_addr
;
232 debug_buf_size
= gPanicSize
- 8;
234 debug_buf_addr
= debug_buf
;
235 debug_buf_ptr
= debug_buf
;
236 debug_buf_size
= sizeof(debug_buf
);
240 #if defined(__i386__) || defined(__x86_64__)
241 #define panic_stop() pmCPUHalt(PM_HALT_PANIC)
242 #define panic_safe() pmSafeMode(x86_lcpu(), PM_SAFE_FL_SAFE)
243 #define panic_normal() pmSafeMode(x86_lcpu(), PM_SAFE_FL_NORMAL)
245 #define panic_stop() { while (1) ; }
247 #define panic_normal()
251 * Prevent CPP from breaking the definition below,
252 * since all clients get a #define to prepend line numbers
256 void _consume_panic_args(int a __unused
, ...)
261 extern unsigned int write_trace_on_panic
;
264 panic_prologue(const char *str
)
268 if (write_trace_on_panic
&& kdebug_enable
) {
269 if (get_preemption_level() == 0 && !ml_at_interrupt_context()) {
270 ml_set_interrupts_enabled(TRUE
);
271 kdbg_dump_trace_to_file("/var/tmp/panic.trace");
276 disable_preemption();
278 #if defined(__i386__) || defined(__x86_64__)
279 /* Attempt to display the unparsed panic string */
280 const char *tstr
= str
;
282 kprintf("Panic initiated, string: ");
283 while (tstr
&& *tstr
)
284 kprintf("%c", *tstr
++);
290 if( logPanicDataToScreen
)
291 disable_debug_output
= FALSE
;
299 if (cpu_number() != paniccpu
) {
302 * Wait until message has been printed to identify correct
303 * cpu that made the first panic.
311 Debugger("double panic");
312 printf("double panic: We are hanging here...\n");
318 paniccpu
= cpu_number();
327 panic_epilogue(spl_t s
)
330 * Release panicstr so that we can handle normally other panics.
333 panicstr
= (char *)0;
336 if (return_on_panic
) {
342 kdb_printf("panic: We are hanging here...\n");
348 panic(const char *str
, ...)
354 /* panic_caller is initialized to 0. If set, don't change it */
355 if ( ! panic_caller
)
356 panic_caller
= (unsigned long)(char *)__builtin_return_address(0);
358 s
= panic_prologue(str
);
359 kdb_printf("panic(cpu %d caller 0x%lx): ", (unsigned) paniccpu
, panic_caller
);
361 va_start(listp
, str
);
362 _doprnt(str
, &listp
, consdebug_putc
, 0);
368 * Release panicwait indicator so that other cpus may call Debugger().
376 panic_context(unsigned int reason
, void *ctx
, const char *str
, ...)
382 /* panic_caller is initialized to 0. If set, don't change it */
383 if ( ! panic_caller
)
384 panic_caller
= (unsigned long)(char *)__builtin_return_address(0);
386 s
= panic_prologue(str
);
387 kdb_printf("panic(cpu %d caller 0x%lx): ", (unsigned) paniccpu
, panic_caller
);
389 va_start(listp
, str
);
390 _doprnt(str
, &listp
, consdebug_putc
, 0);
396 * Release panicwait indicator so that other cpus may call Debugger().
399 DebuggerWithContext(reason
, ctx
, "panic");
404 log(__unused
int level
, char *fmt
, ...)
412 disable_preemption();
413 va_start(listp
, fmt
);
414 _doprnt(fmt
, &listp
, conslog_putc
, 0);
423 if ((debug_buf_size
!= 0) &&
424 ((debug_buf_ptr
-debug_buf_addr
) < (int)debug_buf_size
)) {
430 /* In-place packing routines -- inefficient, but they're called at most once.
431 * Assumes "buflen" is a multiple of 8.
434 int packA(char *inbuf
, uint32_t length
, uint32_t buflen
)
436 unsigned int i
, j
= 0;
439 length
= MIN(((length
+ 7) & ~7), buflen
);
441 for (i
= 0; i
< length
; i
+=8)
451 bcopy ((char *) &pack
, inbuf
+ j
, 7);
457 void unpackA(char *inbuf
, uint32_t length
)
461 length
= (length
* 8)/7;
464 packs
= *(pasc_t
*)&inbuf
[i
];
465 bcopy(&inbuf
[i
+7], &inbuf
[i
+8], MAX(0, (int) (length
- i
- 8)));
466 inbuf
[i
++] = packs
.a
;
467 inbuf
[i
++] = packs
.b
;
468 inbuf
[i
++] = packs
.c
;
469 inbuf
[i
++] = packs
.d
;
470 inbuf
[i
++] = packs
.e
;
471 inbuf
[i
++] = packs
.f
;
472 inbuf
[i
++] = packs
.g
;
473 inbuf
[i
++] = packs
.h
;
477 extern void *proc_name_address(void *p
);
480 panic_display_process_name(void) {
481 char proc_name
[32] = "Unknown";
485 if (ml_nofault_copy((vm_offset_t
)¤t_thread()->task
, (vm_offset_t
) &ctask
, sizeof(task_t
)) == sizeof(task_t
))
486 if(ml_nofault_copy((vm_offset_t
)&ctask
->bsd_info
, (vm_offset_t
)&cbsd_info
, sizeof(&ctask
->bsd_info
)) == sizeof(&ctask
->bsd_info
))
487 if (cbsd_info
&& (ml_nofault_copy((vm_offset_t
) proc_name_address(cbsd_info
), (vm_offset_t
) &proc_name
, sizeof(proc_name
)) > 0))
488 proc_name
[sizeof(proc_name
) - 1] = '\0';
489 kdb_printf("\nBSD process name corresponding to current thread: %s\n", proc_name
);
492 unsigned panic_active(void) {
493 return ((panicstr
!= (char *) 0));
496 void populate_model_name(char *model_string
) {
497 strlcpy(model_name
, model_string
, sizeof(model_name
));
500 static void panic_display_model_name(void) {
501 char tmp_model_name
[sizeof(model_name
)];
503 if (ml_nofault_copy((vm_offset_t
) &model_name
, (vm_offset_t
) &tmp_model_name
, sizeof(model_name
)) != sizeof(model_name
))
506 tmp_model_name
[sizeof(tmp_model_name
) - 1] = '\0';
508 if (tmp_model_name
[0] != 0)
509 kdb_printf("System model name: %s\n", tmp_model_name
);
512 static void panic_display_kernel_uuid(void) {
513 char tmp_kernel_uuid
[sizeof(kernel_uuid_string
)];
515 if (ml_nofault_copy((vm_offset_t
) &kernel_uuid_string
, (vm_offset_t
) &tmp_kernel_uuid
, sizeof(kernel_uuid_string
)) != sizeof(kernel_uuid_string
))
518 if (tmp_kernel_uuid
[0] != '\0')
519 kdb_printf("Kernel UUID: %s\n", tmp_kernel_uuid
);
522 void panic_display_kernel_aslr(void) {
523 if (vm_kernel_slide
) {
524 kdb_printf("Kernel slide: 0x%016lx\n", (unsigned long) vm_kernel_slide
);
525 kdb_printf("Kernel text base: %p\n", (void *) vm_kernel_stext
);
529 void panic_display_hibb(void) {
530 #if defined(__i386__) || defined (__x86_64__)
531 kdb_printf("__HIB text base: %p\n", (void *) vm_hib_base
);
535 static void panic_display_uptime(void) {
537 absolutetime_to_nanoseconds(mach_absolute_time(), &uptime
);
539 kdb_printf("\nSystem uptime in nanoseconds: %llu\n", uptime
);
542 extern const char version
[];
543 extern char osversion
[];
545 static volatile uint32_t config_displayed
= 0;
547 __private_extern__
void panic_display_system_configuration(void) {
549 panic_display_process_name();
550 if (OSCompareAndSwap(0, 1, &config_displayed
)) {
552 if (strlcpy(buf
, PE_boot_args(), sizeof(buf
)))
553 kdb_printf("Boot args: %s\n", buf
);
554 kdb_printf("\nMac OS version:\n%s\n",
555 (osversion
[0] != 0) ? osversion
: "Not yet set");
556 kdb_printf("\nKernel version:\n%s\n",version
);
557 panic_display_kernel_uuid();
558 panic_display_kernel_aslr();
559 panic_display_hibb();
560 panic_display_pal_info();
561 panic_display_model_name();
562 panic_display_uptime();
563 panic_display_zprint();
565 panic_display_ztrace();
566 #endif /* CONFIG_ZLEAKS */
567 kext_dump_panic_lists(&kdb_log
);
571 extern zone_t first_zone
;
572 extern unsigned int num_zones
, stack_total
;
573 extern unsigned long long stack_allocs
;
575 #if defined(__i386__) || defined (__x86_64__)
576 extern unsigned int inuse_ptepages_count
;
577 extern long long alloc_ptepages_count
;
580 extern boolean_t panic_include_zprint
;
582 __private_extern__
void panic_display_zprint()
584 if(panic_include_zprint
== TRUE
) {
587 struct zone zone_copy
;
589 if(first_zone
!=NULL
) {
590 if(ml_nofault_copy((vm_offset_t
)first_zone
, (vm_offset_t
)&zone_copy
, sizeof(struct zone
)) == sizeof(struct zone
)) {
591 for (i
= 0; i
< num_zones
; i
++) {
592 if(zone_copy
.cur_size
> (1024*1024)) {
593 kdb_printf("%.20s:%lu\n",zone_copy
.zone_name
,(uintptr_t)zone_copy
.cur_size
);
596 if(zone_copy
.next_zone
== NULL
) {
600 if(ml_nofault_copy((vm_offset_t
)zone_copy
.next_zone
, (vm_offset_t
)&zone_copy
, sizeof(struct zone
)) != sizeof(struct zone
)) {
607 kdb_printf("Kernel Stacks:%lu\n",(uintptr_t)(kernel_stack_size
* stack_total
));
609 #if defined(__i386__) || defined (__x86_64__)
610 kdb_printf("PageTables:%lu\n",(uintptr_t)(PAGE_SIZE
* inuse_ptepages_count
));
613 kdb_printf("Kalloc.Large:%lu\n",(uintptr_t)kalloc_large_total
);
617 #if CONFIG_ECC_LOGGING
618 __private_extern__
void panic_display_ecc_errors()
620 uint32_t count
= ecc_log_get_correction_count();
623 kdb_printf("ECC Corrections:%u\n", count
);
626 #endif /* CONFIG_ECC_LOGGING */
629 extern boolean_t panic_include_ztrace
;
630 extern struct ztrace
* top_ztrace
;
632 * Prints the backtrace most suspected of being a leaker, if we paniced in the zone allocator.
633 * top_ztrace and panic_include_ztrace comes from osfmk/kern/zalloc.c
635 __private_extern__
void panic_display_ztrace(void)
637 if(panic_include_ztrace
== TRUE
) {
639 struct ztrace top_ztrace_copy
;
641 /* Make sure not to trip another panic if there's something wrong with memory */
642 if(ml_nofault_copy((vm_offset_t
)top_ztrace
, (vm_offset_t
)&top_ztrace_copy
, sizeof(struct ztrace
)) == sizeof(struct ztrace
)) {
643 kdb_printf("\nBacktrace suspected of leaking: (outstanding bytes: %lu)\n", (uintptr_t)top_ztrace_copy
.zt_size
);
644 /* Print the backtrace addresses */
645 for (i
= 0; (i
< top_ztrace_copy
.zt_depth
&& i
< MAX_ZTRACE_DEPTH
) ; i
++) {
646 kdb_printf("%p\n", top_ztrace_copy
.zt_stack
[i
]);
648 /* Print any kexts in that backtrace, along with their link addresses so we can properly blame them */
649 kmod_panic_dump((vm_offset_t
*)&top_ztrace_copy
.zt_stack
[0], top_ztrace_copy
.zt_depth
);
652 kdb_printf("\nCan't access top_ztrace...\n");
657 #endif /* CONFIG_ZLEAKS */
659 #if ! (MACH_KDP && CONFIG_KDP_INTERACTIVE_DEBUGGING)
660 static struct kdp_ether_addr kdp_current_mac_address
= {{0, 0, 0, 0, 0, 0}};
662 /* XXX ugly forward declares to stop warnings */
663 void *kdp_get_interface(void);
664 void kdp_set_ip_and_mac_addresses(struct kdp_in_addr
*, struct kdp_ether_addr
*);
665 void kdp_set_gateway_mac(void *);
666 void kdp_set_interface(void *);
667 void kdp_register_send_receive(void *, void *);
668 void kdp_unregister_send_receive(void *, void *);
669 void kdp_snapshot_preflight(int, void *, uint32_t, uint32_t);
670 int kdp_stack_snapshot_geterror(void);
671 int kdp_stack_snapshot_bytes_traced(void);
674 kdp_get_interface( void)
680 kdp_get_ip_address(void )
683 struct kdp_ether_addr
684 kdp_get_mac_addr(void)
686 return kdp_current_mac_address
;
690 kdp_set_ip_and_mac_addresses(
691 __unused
struct kdp_in_addr
*ipaddr
,
692 __unused
struct kdp_ether_addr
*macaddr
)
696 kdp_set_gateway_mac(__unused
void *gatewaymac
)
700 kdp_set_interface(__unused
void *ifp
)
704 kdp_register_send_receive(__unused
void *send
, __unused
void *receive
)
708 kdp_unregister_send_receive(__unused
void *send
, __unused
void *receive
)
711 void kdp_register_link(__unused kdp_link_t link
, __unused kdp_mode_t mode
)
714 void kdp_unregister_link(__unused kdp_link_t link
, __unused kdp_mode_t mode
)
719 #if !CONFIG_TELEMETRY
720 int telemetry_gather(user_addr_t buffer __unused
, uint32_t *length __unused
, boolean_t mark __unused
)
722 return KERN_NOT_SUPPORTED
;