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
;
104 unsigned int kdebug_serial
= FALSE
;
108 const char *panicstr
= (char *) 0;
109 decl_simple_lock_data(,panic_lock
)
111 volatile int panicwait
;
112 volatile unsigned int nestedpanic
= 0;
113 unsigned int panic_is_inited
= 0;
114 unsigned int return_on_panic
= 0;
115 unsigned long panic_caller
;
117 #define DEBUG_BUF_SIZE (3 * PAGE_SIZE)
119 /* debug_buf is directly linked with iBoot panic region for ARM64 targets */
120 #if (defined(__arm64__) || defined(NAND_PANIC_DEVICE)) && !defined(LEGACY_PANIC_LOGS)
121 char *debug_buf_addr
= NULL
;
122 char *debug_buf_ptr
= NULL
;
123 unsigned int debug_buf_size
= 0;
125 char debug_buf
[DEBUG_BUF_SIZE
];
126 __used
char *debug_buf_addr
= debug_buf
;
127 char *debug_buf_ptr
= debug_buf
;
128 unsigned int debug_buf_size
= sizeof(debug_buf
);
131 static char model_name
[64];
132 unsigned char *kernel_uuid
;
133 /* uuid_string_t */ char kernel_uuid_string
[37];
135 static spl_t
panic_prologue(const char *str
);
136 static void panic_epilogue(spl_t s
);
147 } __attribute__((packed
));
149 typedef struct pasc pasc_t
;
151 /* Prevent CPP from breaking the definition below */
152 #if CONFIG_NO_PANIC_STRINGS
156 void __attribute__((noinline
))
160 const char *expression
163 int saved_return_on_panic
;
169 saved_return_on_panic
= return_on_panic
;
172 * If we don't have a debugger configured, returning from an
173 * assert is a bad, bad idea; there is no guarantee that we
174 * didn't simply assert before we were able to restart the
177 if (current_debugger
!= NO_CUR_DB
)
180 panic_plain("%s:%d Assertion failed: %s", file
, line
, expression
);
182 return_on_panic
= saved_return_on_panic
;
186 * Carefully use the panic_lock. There's always a chance that
187 * somehow we'll call panic before getting to initialize the
188 * panic_lock -- in this case, we'll assume that the world is
189 * in uniprocessor mode and just avoid using the panic lock.
191 #define PANIC_LOCK() \
193 if (panic_is_inited) \
194 simple_lock(&panic_lock); \
197 #define PANIC_UNLOCK() \
199 if (panic_is_inited) \
200 simple_unlock(&panic_lock); \
206 unsigned long uuidlen
= 0;
209 uuid
= getuuidfromheader(&_mh_execute_header
, &uuidlen
);
210 if ((uuid
!= NULL
) && (uuidlen
== sizeof(uuid_t
))) {
212 uuid_unparse_upper(*(uuid_t
*)uuid
, kernel_uuid_string
);
215 simple_lock_init(&panic_lock
, 0);
223 if (debug_buf_size
!= 0)
225 #if (defined(__arm64__) || defined(NAND_PANIC_DEVICE)) && !defined(LEGACY_PANIC_LOGS)
227 printf("debug_log_init: Error!! gPanicBase is still not initialized\n");
230 /* Shift debug buf start location and size by 8 bytes for magic header and crc value */
231 debug_buf_addr
= (char*)gPanicBase
+ 8;
232 debug_buf_ptr
= debug_buf_addr
;
233 debug_buf_size
= gPanicSize
- 8;
235 debug_buf_addr
= debug_buf
;
236 debug_buf_ptr
= debug_buf
;
237 debug_buf_size
= sizeof(debug_buf
);
241 #if defined(__i386__) || defined(__x86_64__)
242 #define panic_stop() pmCPUHalt(PM_HALT_PANIC)
243 #define panic_safe() pmSafeMode(x86_lcpu(), PM_SAFE_FL_SAFE)
244 #define panic_normal() pmSafeMode(x86_lcpu(), PM_SAFE_FL_NORMAL)
246 #define panic_stop() { while (1) ; }
248 #define panic_normal()
252 * Prevent CPP from breaking the definition below,
253 * since all clients get a #define to prepend line numbers
257 void _consume_panic_args(int a __unused
, ...)
262 extern unsigned int write_trace_on_panic
;
265 panic_prologue(const char *str
)
269 if (write_trace_on_panic
&& kdebug_enable
) {
270 if (get_preemption_level() == 0 && !ml_at_interrupt_context()) {
271 ml_set_interrupts_enabled(TRUE
);
272 kdbg_dump_trace_to_file("/var/tmp/panic.trace");
277 disable_preemption();
279 #if defined(__i386__) || defined(__x86_64__)
280 /* Attempt to display the unparsed panic string */
281 const char *tstr
= str
;
283 kprintf("Panic initiated, string: ");
284 while (tstr
&& *tstr
)
285 kprintf("%c", *tstr
++);
291 if( logPanicDataToScreen
)
292 disable_debug_output
= FALSE
;
300 if (cpu_number() != paniccpu
) {
303 * Wait until message has been printed to identify correct
304 * cpu that made the first panic.
312 Debugger("double panic");
313 printf("double panic: We are hanging here...\n");
319 paniccpu
= cpu_number();
328 panic_epilogue(spl_t s
)
331 * Release panicstr so that we can handle normally other panics.
334 panicstr
= (char *)0;
337 if (return_on_panic
) {
343 kdb_printf("panic: We are hanging here...\n");
349 panic(const char *str
, ...)
355 /* panic_caller is initialized to 0. If set, don't change it */
356 if ( ! panic_caller
)
357 panic_caller
= (unsigned long)(char *)__builtin_return_address(0);
359 s
= panic_prologue(str
);
360 kdb_printf("panic(cpu %d caller 0x%lx): ", (unsigned) paniccpu
, panic_caller
);
362 va_start(listp
, str
);
363 _doprnt(str
, &listp
, consdebug_putc
, 0);
369 * Release panicwait indicator so that other cpus may call Debugger().
377 panic_context(unsigned int reason
, void *ctx
, const char *str
, ...)
383 /* panic_caller is initialized to 0. If set, don't change it */
384 if ( ! panic_caller
)
385 panic_caller
= (unsigned long)(char *)__builtin_return_address(0);
387 s
= panic_prologue(str
);
388 kdb_printf("panic(cpu %d caller 0x%lx): ", (unsigned) paniccpu
, panic_caller
);
390 va_start(listp
, str
);
391 _doprnt(str
, &listp
, consdebug_putc
, 0);
397 * Release panicwait indicator so that other cpus may call Debugger().
400 DebuggerWithContext(reason
, ctx
, "panic");
405 log(__unused
int level
, char *fmt
, ...)
413 disable_preemption();
414 va_start(listp
, fmt
);
415 _doprnt(fmt
, &listp
, conslog_putc
, 0);
424 if ((debug_buf_size
!= 0) &&
425 ((debug_buf_ptr
-debug_buf_addr
) < (int)debug_buf_size
)) {
431 /* In-place packing routines -- inefficient, but they're called at most once.
432 * Assumes "buflen" is a multiple of 8.
435 int packA(char *inbuf
, uint32_t length
, uint32_t buflen
)
437 unsigned int i
, j
= 0;
440 length
= MIN(((length
+ 7) & ~7), buflen
);
442 for (i
= 0; i
< length
; i
+=8)
452 bcopy ((char *) &pack
, inbuf
+ j
, 7);
458 void unpackA(char *inbuf
, uint32_t length
)
462 length
= (length
* 8)/7;
465 packs
= *(pasc_t
*)&inbuf
[i
];
466 bcopy(&inbuf
[i
+7], &inbuf
[i
+8], MAX(0, (int) (length
- i
- 8)));
467 inbuf
[i
++] = packs
.a
;
468 inbuf
[i
++] = packs
.b
;
469 inbuf
[i
++] = packs
.c
;
470 inbuf
[i
++] = packs
.d
;
471 inbuf
[i
++] = packs
.e
;
472 inbuf
[i
++] = packs
.f
;
473 inbuf
[i
++] = packs
.g
;
474 inbuf
[i
++] = packs
.h
;
478 extern void *proc_name_address(void *p
);
481 panic_display_process_name(void) {
482 char proc_name
[32] = "Unknown";
486 if (ml_nofault_copy((vm_offset_t
)¤t_thread()->task
, (vm_offset_t
) &ctask
, sizeof(task_t
)) == sizeof(task_t
))
487 if(ml_nofault_copy((vm_offset_t
)&ctask
->bsd_info
, (vm_offset_t
)&cbsd_info
, sizeof(&ctask
->bsd_info
)) == sizeof(&ctask
->bsd_info
))
488 if (cbsd_info
&& (ml_nofault_copy((vm_offset_t
) proc_name_address(cbsd_info
), (vm_offset_t
) &proc_name
, sizeof(proc_name
)) > 0))
489 proc_name
[sizeof(proc_name
) - 1] = '\0';
490 kdb_printf("\nBSD process name corresponding to current thread: %s\n", proc_name
);
493 unsigned panic_active(void) {
494 return ((panicstr
!= (char *) 0));
497 void populate_model_name(char *model_string
) {
498 strlcpy(model_name
, model_string
, sizeof(model_name
));
501 void panic_display_model_name(void) {
502 char tmp_model_name
[sizeof(model_name
)];
504 if (ml_nofault_copy((vm_offset_t
) &model_name
, (vm_offset_t
) &tmp_model_name
, sizeof(model_name
)) != sizeof(model_name
))
507 tmp_model_name
[sizeof(tmp_model_name
) - 1] = '\0';
509 if (tmp_model_name
[0] != 0)
510 kdb_printf("System model name: %s\n", tmp_model_name
);
513 void panic_display_kernel_uuid(void) {
514 char tmp_kernel_uuid
[sizeof(kernel_uuid_string
)];
516 if (ml_nofault_copy((vm_offset_t
) &kernel_uuid_string
, (vm_offset_t
) &tmp_kernel_uuid
, sizeof(kernel_uuid_string
)) != sizeof(kernel_uuid_string
))
519 if (tmp_kernel_uuid
[0] != '\0')
520 kdb_printf("Kernel UUID: %s\n", tmp_kernel_uuid
);
523 void panic_display_kernel_aslr(void) {
524 if (vm_kernel_slide
) {
525 kdb_printf("Kernel slide: 0x%016lx\n", (unsigned long) vm_kernel_slide
);
526 kdb_printf("Kernel text base: %p\n", (void *) vm_kernel_stext
);
530 void panic_display_hibb(void) {
531 #if defined(__i386__) || defined (__x86_64__)
532 kdb_printf("__HIB text base: %p\n", (void *) vm_hib_base
);
536 static void panic_display_uptime(void) {
538 absolutetime_to_nanoseconds(mach_absolute_time(), &uptime
);
540 kdb_printf("\nSystem uptime in nanoseconds: %llu\n", uptime
);
543 extern const char version
[];
544 extern char osversion
[];
546 static volatile uint32_t config_displayed
= 0;
548 __private_extern__
void panic_display_system_configuration(void) {
550 panic_display_process_name();
551 if (OSCompareAndSwap(0, 1, &config_displayed
)) {
553 if (strlcpy(buf
, PE_boot_args(), sizeof(buf
)))
554 kdb_printf("Boot args: %s\n", buf
);
555 kdb_printf("\nMac OS version:\n%s\n",
556 (osversion
[0] != 0) ? osversion
: "Not yet set");
557 kdb_printf("\nKernel version:\n%s\n",version
);
558 panic_display_kernel_uuid();
559 panic_display_kernel_aslr();
560 panic_display_hibb();
561 panic_display_pal_info();
562 panic_display_model_name();
563 panic_display_uptime();
564 panic_display_zprint();
566 panic_display_ztrace();
567 #endif /* CONFIG_ZLEAKS */
568 kext_dump_panic_lists(&kdb_log
);
572 extern zone_t first_zone
;
573 extern unsigned int num_zones
, stack_total
;
574 extern unsigned long long stack_allocs
;
576 #if defined(__i386__) || defined (__x86_64__)
577 extern unsigned int inuse_ptepages_count
;
578 extern long long alloc_ptepages_count
;
581 extern boolean_t panic_include_zprint
;
583 __private_extern__
void panic_display_zprint()
585 if(panic_include_zprint
== TRUE
) {
588 struct zone zone_copy
;
590 if(first_zone
!=NULL
) {
591 if(ml_nofault_copy((vm_offset_t
)first_zone
, (vm_offset_t
)&zone_copy
, sizeof(struct zone
)) == sizeof(struct zone
)) {
592 for (i
= 0; i
< num_zones
; i
++) {
593 if(zone_copy
.cur_size
> (1024*1024)) {
594 kdb_printf("%.20s:%lu\n",zone_copy
.zone_name
,(uintptr_t)zone_copy
.cur_size
);
597 if(zone_copy
.next_zone
== NULL
) {
601 if(ml_nofault_copy((vm_offset_t
)zone_copy
.next_zone
, (vm_offset_t
)&zone_copy
, sizeof(struct zone
)) != sizeof(struct zone
)) {
608 kdb_printf("Kernel Stacks:%lu\n",(uintptr_t)(kernel_stack_size
* stack_total
));
610 #if defined(__i386__) || defined (__x86_64__)
611 kdb_printf("PageTables:%lu\n",(uintptr_t)(PAGE_SIZE
* inuse_ptepages_count
));
614 kdb_printf("Kalloc.Large:%lu\n",(uintptr_t)kalloc_large_total
);
618 #if CONFIG_ECC_LOGGING
619 __private_extern__
void panic_display_ecc_errors()
621 uint32_t count
= ecc_log_get_correction_count();
624 kdb_printf("ECC Corrections:%u\n", count
);
627 #endif /* CONFIG_ECC_LOGGING */
630 extern boolean_t panic_include_ztrace
;
631 extern struct ztrace
* top_ztrace
;
632 void panic_print_symbol_name(vm_address_t search
);
635 * Prints the backtrace most suspected of being a leaker, if we paniced in the zone allocator.
636 * top_ztrace and panic_include_ztrace comes from osfmk/kern/zalloc.c
638 __private_extern__
void panic_display_ztrace(void)
640 if(panic_include_ztrace
== TRUE
) {
642 boolean_t keepsyms
= FALSE
;
644 PE_parse_boot_argn("keepsyms", &keepsyms
, sizeof (keepsyms
));
645 struct ztrace top_ztrace_copy
;
647 /* Make sure not to trip another panic if there's something wrong with memory */
648 if(ml_nofault_copy((vm_offset_t
)top_ztrace
, (vm_offset_t
)&top_ztrace_copy
, sizeof(struct ztrace
)) == sizeof(struct ztrace
)) {
649 kdb_printf("\nBacktrace suspected of leaking: (outstanding bytes: %lu)\n", (uintptr_t)top_ztrace_copy
.zt_size
);
650 /* Print the backtrace addresses */
651 for (i
= 0; (i
< top_ztrace_copy
.zt_depth
&& i
< MAX_ZTRACE_DEPTH
) ; i
++) {
652 kdb_printf("%p ", top_ztrace_copy
.zt_stack
[i
]);
654 panic_print_symbol_name((vm_address_t
)top_ztrace_copy
.zt_stack
[i
]);
658 /* Print any kexts in that backtrace, along with their link addresses so we can properly blame them */
659 kmod_panic_dump((vm_offset_t
*)&top_ztrace_copy
.zt_stack
[0], top_ztrace_copy
.zt_depth
);
662 kdb_printf("\nCan't access top_ztrace...\n");
667 #endif /* CONFIG_ZLEAKS */
669 #if ! (MACH_KDP && CONFIG_KDP_INTERACTIVE_DEBUGGING)
670 static struct kdp_ether_addr kdp_current_mac_address
= {{0, 0, 0, 0, 0, 0}};
672 /* XXX ugly forward declares to stop warnings */
673 void *kdp_get_interface(void);
674 void kdp_set_ip_and_mac_addresses(struct kdp_in_addr
*, struct kdp_ether_addr
*);
675 void kdp_set_gateway_mac(void *);
676 void kdp_set_interface(void *);
677 void kdp_register_send_receive(void *, void *);
678 void kdp_unregister_send_receive(void *, void *);
679 void kdp_snapshot_preflight(int, void *, uint32_t, uint32_t);
680 int kdp_stack_snapshot_geterror(void);
681 int kdp_stack_snapshot_bytes_traced(void);
684 kdp_get_interface( void)
690 kdp_get_ip_address(void )
693 struct kdp_ether_addr
694 kdp_get_mac_addr(void)
696 return kdp_current_mac_address
;
700 kdp_set_ip_and_mac_addresses(
701 __unused
struct kdp_in_addr
*ipaddr
,
702 __unused
struct kdp_ether_addr
*macaddr
)
706 kdp_set_gateway_mac(__unused
void *gatewaymac
)
710 kdp_set_interface(__unused
void *ifp
)
714 kdp_register_send_receive(__unused
void *send
, __unused
void *receive
)
718 kdp_unregister_send_receive(__unused
void *send
, __unused
void *receive
)
721 void kdp_register_link(__unused kdp_link_t link
, __unused kdp_mode_t mode
)
724 void kdp_unregister_link(__unused kdp_link_t link
, __unused kdp_mode_t mode
)
729 #if !CONFIG_TELEMETRY
730 int telemetry_gather(user_addr_t buffer __unused
, uint32_t *length __unused
, boolean_t mark __unused
)
732 return KERN_NOT_SUPPORTED
;