[apple/xnu.git] / osfmk / kern / debug.c

/*
 * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_LICENSE_HEADER_START@
 * 
 * The contents of this file constitute Original Code as defined in and
 * are subject to the Apple Public Source License Version 1.1 (the
 * "License").  You may not use this file except in compliance with the
 * License.  Please obtain a copy of the License at
 * http://www.apple.com/publicsource and read it before using this file.
 * 
 * This Original Code and all software distributed under the License are
 * distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
 * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
 * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT.  Please see the
 * License for the specific language governing rights and limitations
 * under the License.
 * 
 * @APPLE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990,1989 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */

#include <mach_assert.h>
#include <mach_kdb.h>
#include <mach_kgdb.h>
#include <mach_kdp.h>
#include <cpus.h>

#include <kern/cpu_number.h>
#include <kern/lock.h>
#include <kern/spl.h>
#include <kern/thread.h>
#include <kern/assert.h>
#include <kern/sched_prim.h>
#include <kern/misc_protos.h>
#include <vm/vm_kern.h>
#include <stdarg.h>

#ifdef	__ppc__
#include <ppc/Firmware.h>
#include <ppc/low_trace.h>
#endif

unsigned int	halt_in_debugger = 0;
unsigned int	switch_debugger = 0;
unsigned int	current_debugger = 0;
unsigned int	active_debugger = 0;
unsigned int	debug_mode=0;
unsigned int 	disableDebugOuput = TRUE;
unsigned int 	systemLogDiags = FALSE;
unsigned int 	panicDebugging = FALSE;
#ifdef __ppc__
	unsigned int	logPanicDataToScreen = FALSE;
#else
	unsigned int	logPanicDataToScreen = TRUE;
#endif

int mach_assert = 1;

const char		*panicstr;
decl_simple_lock_data(,panic_lock)
int			paniccpu;
volatile int		panicwait;
volatile int		nestedpanic= 0;
unsigned int		panic_is_inited = 0;
unsigned int		return_on_panic = 0;
wait_queue_t		save_waits[NCPUS];

char *debug_buf;
char *debug_buf_ptr;
unsigned int debug_buf_size = 0;

void
Assert(
	const char	*file,
	int		line,
	const char	*expression)
{
	if (!mach_assert) {
		return;
	}
	panic("{%d} Assertion failed: file \"%s\", line %d: %s\n", 
	       cpu_number(), file, line, expression);
}

/*
 *	Carefully use the panic_lock.  There's always a chance that
 *	somehow we'll call panic before getting to initialize the
 *	panic_lock -- in this case, we'll assume that the world is
 *	in uniprocessor mode and just avoid using the panic lock.
 */
#define	PANIC_LOCK()							\
MACRO_BEGIN								\
	if (panic_is_inited)						\
		simple_lock(&panic_lock);				\
MACRO_END

#define	PANIC_UNLOCK()							\
MACRO_BEGIN								\
	if (panic_is_inited)						\
		simple_unlock(&panic_lock);				\
MACRO_END


void
panic_init(void)
{
	simple_lock_init(&panic_lock, ETAP_NO_TRACE);
	panic_is_inited = 1;
}

void
panic(const char *str, ...)
{
	va_list	listp;
	spl_t	s;
	thread_t thread;

	s = splhigh();

#ifdef	__ppc__
	lastTrace = LLTraceSet(0);		/* Disable low-level tracing */
#endif

	thread = current_thread();		/* Get failing thread */
	save_waits[cpu_number()] = thread->wait_queue;	/* Save the old value */
	thread->wait_queue = 0;			/* Clear the wait so we do not get double panics when we try locks */

	mp_disable_preemption();
	
	if( logPanicDataToScreen )
		disableDebugOuput = FALSE;
		
	debug_mode = TRUE;
restart:
	PANIC_LOCK();
	if (panicstr) {
		if (cpu_number() != paniccpu) {
			PANIC_UNLOCK();
			/*
			 * Wait until message has been printed to identify correct
			 * cpu that made the first panic.
			 */
			while (panicwait)
				continue;
			goto restart;
	    } else {
			nestedpanic +=1;
			PANIC_UNLOCK();
			Debugger("double panic");
			mp_enable_preemption();
			splx(s);
			printf("double panic:  We are hanging here...\n");
			while(1);
			/* NOTREACHED */
		}
	}
	panicstr = str;
	paniccpu = cpu_number();
	panicwait = 1;

	PANIC_UNLOCK();
	kdb_printf("panic(cpu %d): ", (unsigned) paniccpu);
	va_start(listp, str);
	_doprnt(str, &listp, consdebug_putc, 0);
	va_end(listp);
	kdb_printf("\n");

	/*
	 * Release panicwait indicator so that other cpus may call Debugger().
	 */
	panicwait = 0;
	Debugger("panic");
	/*
	 * Release panicstr so that we can handle normally other panics.
	 */
	PANIC_LOCK();
	panicstr = (char *)0;
	PANIC_UNLOCK();
	mp_enable_preemption();
	splx(s);
	thread->wait_queue = save_waits[cpu_number()]; 	/* Restore the wait queue */
	if (return_on_panic)
		return;
	kdb_printf("panic: We are hanging here...\n");
	while(1);
	/* NOTREACHED */
}

void
log(int level, char *fmt, ...)
{
	va_list	listp;

#ifdef lint
	level++;
#endif /* lint */
#ifdef	MACH_BSD
	disable_preemption();
	va_start(listp, fmt);
	_doprnt(fmt, &listp, conslog_putc, 0);
	va_end(listp);
	enable_preemption();
#endif
}

void
debug_log_init(void)
{
	if (debug_buf_size != 0)
		return;
	if (kmem_alloc(kernel_map, (vm_offset_t *) &debug_buf, PAGE_SIZE) != KERN_SUCCESS)
		panic("cannot allocate debug_buf \n");
	debug_buf_ptr = debug_buf;
	debug_buf_size = PAGE_SIZE;
}

void
debug_putc(char c)
{
	if ((debug_buf_size != 0) && ((debug_buf_ptr-debug_buf) < debug_buf_size)) {
		*debug_buf_ptr=c;
		debug_buf_ptr++;
	}
}
Commit	Line	Data
1c79356b A	1	/*
	2	* Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
	3	*
	4	* @APPLE_LICENSE_HEADER_START@
	5	*
	6	* The contents of this file constitute Original Code as defined in and
	7	* are subject to the Apple Public Source License Version 1.1 (the
	8	* "License"). You may not use this file except in compliance with the
	9	* License. Please obtain a copy of the License at
	10	* http://www.apple.com/publicsource and read it before using this file.
	11	*
	12	* This Original Code and all software distributed under the License are
	13	* distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, EITHER
	14	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
	15	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
	16	* FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT. Please see the
	17	* License for the specific language governing rights and limitations
	18	* under the License.
	19	*
	20	* @APPLE_LICENSE_HEADER_END@
	21	*/
	22	/*
	23	* @OSF_COPYRIGHT@
	24	*/
	25	/*
	26	* Mach Operating System
	27	* Copyright (c) 1991,1990,1989 Carnegie Mellon University
	28	* All Rights Reserved.
	29	*
	30	* Permission to use, copy, modify and distribute this software and its
	31	* documentation is hereby granted, provided that both the copyright
	32	* notice and this permission notice appear in all copies of the
	33	* software, derivative works or modified versions, and any portions
	34	* thereof, and that both notices appear in supporting documentation.
	35	*
	36	* CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
	37	* CONDITION. CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
	38	* ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
	39	*
	40	* Carnegie Mellon requests users of this software to return to
	41	*
	42	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	43	* School of Computer Science
	44	* Carnegie Mellon University
	45	* Pittsburgh PA 15213-3890
	46	*
	47	* any improvements or extensions that they make and grant Carnegie Mellon
	48	* the rights to redistribute these changes.
	49	*/
	50
	51	#include <mach_assert.h>
	52	#include <mach_kdb.h>
	53	#include <mach_kgdb.h>
	54	#include <mach_kdp.h>
	55	#include <cpus.h>
	56
	57	#include <kern/cpu_number.h>
	58	#include <kern/lock.h>
	59	#include <kern/spl.h>
	60	#include <kern/thread.h>
	61	#include <kern/assert.h>
	62	#include <kern/sched_prim.h>
	63	#include <kern/misc_protos.h>
9bccf70c	64	#include <vm/vm_kern.h>
1c79356b A	65	#include <stdarg.h>
1c79356b A	66
9bccf70c A	67	#ifdef __ppc__
	68	#include <ppc/Firmware.h>
	69	#include <ppc/low_trace.h>
	70	#endif
	71
1c79356b A	72	unsigned int halt_in_debugger = 0;
	73	unsigned int switch_debugger = 0;
	74	unsigned int current_debugger = 0;
	75	unsigned int active_debugger = 0;
	76	unsigned int debug_mode=0;
	77	unsigned int disableDebugOuput = TRUE;
	78	unsigned int systemLogDiags = FALSE;
9bccf70c A	79	unsigned int panicDebugging = FALSE;
	80	#ifdef __ppc__
	81	unsigned int logPanicDataToScreen = FALSE;
	82	#else
	83	unsigned int logPanicDataToScreen = TRUE;
	84	#endif
1c79356b A	85
	86	int mach_assert = 1;
	87
	88	const char *panicstr;
	89	decl_simple_lock_data(,panic_lock)
	90	int paniccpu;
	91	volatile int panicwait;
	92	volatile int nestedpanic= 0;
	93	unsigned int panic_is_inited = 0;
	94	unsigned int return_on_panic = 0;
	95	wait_queue_t save_waits[NCPUS];
	96
9bccf70c A	97	char *debug_buf;
	98	char *debug_buf_ptr;
	99	unsigned int debug_buf_size = 0;
	100
1c79356b A	101	void
	102	Assert(
	103	const char *file,
	104	int line,
	105	const char *expression)
	106	{
	107	if (!mach_assert) {
	108	return;
	109	}
	110	panic("{%d} Assertion failed: file \"%s\", line %d: %s\n",
	111	cpu_number(), file, line, expression);
	112	}
	113
	114	/*
	115	* Carefully use the panic_lock. There's always a chance that
	116	* somehow we'll call panic before getting to initialize the
	117	* panic_lock -- in this case, we'll assume that the world is
	118	* in uniprocessor mode and just avoid using the panic lock.
	119	*/
	120	#define PANIC_LOCK() \
	121	MACRO_BEGIN \
	122	if (panic_is_inited) \
	123	simple_lock(&panic_lock); \
	124	MACRO_END
	125
	126	#define PANIC_UNLOCK() \
	127	MACRO_BEGIN \
	128	if (panic_is_inited) \
	129	simple_unlock(&panic_lock); \
	130	MACRO_END
	131
	132
	133	void
	134	panic_init(void)
	135	{
	136	simple_lock_init(&panic_lock, ETAP_NO_TRACE);
	137	panic_is_inited = 1;
	138	}
	139
	140	void
	141	panic(const char *str, ...)
	142	{
	143	va_list listp;
	144	spl_t s;
	145	thread_t thread;
	146
	147	s = splhigh();
	148
9bccf70c A	149	#ifdef __ppc__
	150	lastTrace = LLTraceSet(0); /* Disable low-level tracing */
	151	#endif
	152
1c79356b A	153	thread = current_thread(); /* Get failing thread */
	154	save_waits[cpu_number()] = thread->wait_queue; /* Save the old value */
	155	thread->wait_queue = 0; /* Clear the wait so we do not get double panics when we try locks */
	156
	157	mp_disable_preemption();
9bccf70c A	158
	159	if( logPanicDataToScreen )
	160	disableDebugOuput = FALSE;
	161
1c79356b A	162	debug_mode = TRUE;
	163	restart:
	164	PANIC_LOCK();
	165	if (panicstr) {
	166	if (cpu_number() != paniccpu) {
	167	PANIC_UNLOCK();
	168	/*
	169	* Wait until message has been printed to identify correct
	170	* cpu that made the first panic.
	171	*/
	172	while (panicwait)
	173	continue;
	174	goto restart;
	175	} else {
	176	nestedpanic +=1;
	177	PANIC_UNLOCK();
	178	Debugger("double panic");
	179	mp_enable_preemption();
	180	splx(s);
	181	printf("double panic: We are hanging here...\n");
	182	while(1);
	183	/* NOTREACHED */
	184	}
	185	}
	186	panicstr = str;
	187	paniccpu = cpu_number();
	188	panicwait = 1;
	189
	190	PANIC_UNLOCK();
9bccf70c	191	kdb_printf("panic(cpu %d): ", (unsigned) paniccpu);
1c79356b	192	va_start(listp, str);
9bccf70c	193	_doprnt(str, &listp, consdebug_putc, 0);
1c79356b	194	va_end(listp);
9bccf70c	195	kdb_printf("\n");
1c79356b A	196
	197	/*
	198	* Release panicwait indicator so that other cpus may call Debugger().
	199	*/
	200	panicwait = 0;
	201	Debugger("panic");
	202	/*
	203	* Release panicstr so that we can handle normally other panics.
	204	*/
	205	PANIC_LOCK();
	206	panicstr = (char *)0;
	207	PANIC_UNLOCK();
	208	mp_enable_preemption();
	209	splx(s);
	210	thread->wait_queue = save_waits[cpu_number()]; /* Restore the wait queue */
	211	if (return_on_panic)
	212	return;
9bccf70c	213	kdb_printf("panic: We are hanging here...\n");
1c79356b A	214	while(1);
	215	/* NOTREACHED */
	216	}
	217
	218	void
	219	log(int level, char *fmt, ...)
	220	{
	221	va_list listp;
1c79356b A	222
	223	#ifdef lint
	224	level++;
	225	#endif /* lint */
	226	#ifdef MACH_BSD
	227	disable_preemption();
	228	va_start(listp, fmt);
	229	_doprnt(fmt, &listp, conslog_putc, 0);
	230	va_end(listp);
	231	enable_preemption();
	232	#endif
	233	}
9bccf70c A	234
	235	void
	236	debug_log_init(void)
	237	{
	238	if (debug_buf_size != 0)
	239	return;
	240	if (kmem_alloc(kernel_map, (vm_offset_t *) &debug_buf, PAGE_SIZE) != KERN_SUCCESS)
	241	panic("cannot allocate debug_buf \n");
	242	debug_buf_ptr = debug_buf;
	243	debug_buf_size = PAGE_SIZE;
	244	}
	245
	246	void
	247	debug_putc(char c)
	248	{
	249	if ((debug_buf_size != 0) && ((debug_buf_ptr-debug_buf) < debug_buf_size)) {
	250	*debug_buf_ptr=c;
	251	debug_buf_ptr++;
	252	}
	253	}