[apple/xnu.git] / osfmk / i386 / db_machdep.h

/*
 * Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
 *
 * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
 * 
 * This file contains Original Code and/or Modifications of Original Code
 * as defined in and that are subject to the Apple Public Source License
 * Version 2.0 (the 'License'). You may not use this file except in
 * compliance with the License. The rights granted to you under the License
 * may not be used to create, or enable the creation or redistribution of,
 * unlawful or unlicensed copies of an Apple operating system, or to
 * circumvent, violate, or enable the circumvention or violation of, any
 * terms of an Apple operating system software license agreement.
 * 
 * Please obtain a copy of the License at
 * http://www.opensource.apple.com/apsl/ and read it before using this file.
 * 
 * The 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, QUIET ENJOYMENT OR NON-INFRINGEMENT.
 * Please see the License for the specific language governing rights and
 * limitations under the License.
 * 
 * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
 */
/*
 * @OSF_COPYRIGHT@
 */
/* 
 * Mach Operating System
 * Copyright (c) 1991,1990 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.
 */
/*
 */

#ifndef	_I386_DB_MACHDEP_H_
#define	_I386_DB_MACHDEP_H_

/*
 * Machine-dependent defines for new kernel debugger.
 */

#include <kern/kern_types.h>
#include <mach/i386/vm_types.h>
#include <mach/i386/vm_param.h>
#include <i386/thread.h>		/* for thread_status */
#include <i386/eflags.h>
#include <i386/trap.h>
#include <i386/pmCPU.h>
#include <i386/hpet.h>

typedef	addr64_t	db_addr_t;	/* address - unsigned */
typedef	uint64_t	db_expr_t;	/* expression */

typedef struct x86_saved_state32 db_regs_t;
db_regs_t	ddb_regs;	/* register state */
#define	DDB_REGS	(&ddb_regs)
extern int	db_active;	/* ddb is active */

#define	PC_REGS(regs)	((db_addr_t)(regs)->eip)

#define	BKPT_INST	0xcc		/* breakpoint instruction */
#define	BKPT_SIZE	(1)		/* size of breakpoint inst */
#define	BKPT_SET(inst)	(BKPT_INST)

#define	FIXUP_PC_AFTER_BREAK	ddb_regs.eip -= 1;

#define	db_clear_single_step(regs)	((regs)->efl &= ~EFL_TF)
#define	db_set_single_step(regs)	((regs)->efl |=  EFL_TF)

#define	IS_BREAKPOINT_TRAP(type, code)	((type) == T_INT3)
#define IS_WATCHPOINT_TRAP(type, code)	((type) == T_WATCHPOINT)

#define	I_CALL		0xe8
#define	I_CALLI		0xff
#define	I_RET		0xc3
#define	I_IRET		0xcf

#define	inst_trap_return(ins)	(((ins)&0xff) == I_IRET)
#define	inst_return(ins)	(((ins)&0xff) == I_RET)
#define	inst_call(ins)		(((ins)&0xff) == I_CALL || \
				 (((ins)&0xff) == I_CALLI && \
				  ((ins)&0x3800) == 0x1000))

int db_inst_load(unsigned long);
int db_inst_store(unsigned long);

/* access capability and access macros */

#define DB_ACCESS_LEVEL		2	/* access any space */
#define DB_CHECK_ACCESS(addr,size,task)				\
	db_check_access(addr,size,task)
#define DB_PHYS_EQ(task1,addr1,task2,addr2)			\
	db_phys_eq(task1,addr1,task2,addr2)
#define DB_VALID_KERN_ADDR(addr)		(1)
#define DB_VALID_ADDRESS(addr,user)				\
	((!(user) && DB_VALID_KERN_ADDR(addr)) ||		\
	 ((user) && (addr) < VM_MAX_ADDRESS))

/*
 * Given pointer to i386_saved_state, determine if it represents
 * a thread executing in user space.
 */
#define IS_USER_TRAP(regs, etext)	(((regs)->cs & 3) != 0)

extern boolean_t	db_check_access(
				vm_offset_t	addr,
				int		size,
				task_t		task);
extern boolean_t	db_phys_eq(
				task_t		task1,
				vm_offset_t	addr1,
				task_t		task2,
				vm_offset_t	addr2);
extern db_addr_t	db_disasm(
				db_addr_t	loc,
				boolean_t	altfmt,
				task_t		task);
extern void		db_read_bytes(
				vm_offset_t	addr,
				int		size,
				char		*data,
				task_t		task);
extern void		db_write_bytes(
				vm_offset_t	addr,
				int		size,
				char		*data,
				task_t		task);
extern void		db_stack_trace_cmd(
				db_expr_t	addr,
				boolean_t	have_addr,
				db_expr_t	count,
				char		*modif);
extern void		db_reboot(
				db_expr_t	addr,
				boolean_t	have_addr,
				db_expr_t	count,
				char		*modif);

extern void db_display_kmod(db_expr_t addr, boolean_t have_addr,
			    db_expr_t count, char *modif);
extern void db_display_real(db_expr_t addr, boolean_t have_addr,
			    db_expr_t count, char *modif);
extern void db_display_iokit(db_expr_t addr, boolean_t have_addr,
			     db_expr_t count, char * modif);
extern void db_cpuid(db_expr_t addr, boolean_t have_addr, db_expr_t count,
		     char *modif);
extern void db_msr(db_expr_t addr, boolean_t have_addr, db_expr_t count,
		   char *modif);
extern void db_apic(db_expr_t addr, boolean_t have_addr, db_expr_t count,
		    char *modif);
extern void db_display_hpet(hpetReg_t *);
extern void db_hpet(db_expr_t addr, boolean_t have_addr, db_expr_t count,
		    char *modif);

/* macros for printing OS server dependent task name */

#define DB_TASK_NAME(task)	db_task_name(task)
#define DB_TASK_NAME_TITLE	"COMMAND                "
#define DB_TASK_NAME_LEN	23
#define DB_NULL_TASK_NAME	"?                      "

extern void		db_task_name(
				task_t			task);

/* macro for checking if a thread has used floating-point */

#define db_act_fp_used(act)	(act && act->machine.pcb->ifps)

extern void		db_tss_to_frame(
				int			tss_sel,
				x86_saved_state32_t	*regs);
extern int		kdb_trap(
				int			type,
				int			code,
				x86_saved_state32_t	*regs);
extern boolean_t	db_trap_from_asm(
				x86_saved_state32_t *regs);
extern void		kdb_on(
				int			cpu);

#if MACH_KDB
extern void db_getpmgr(pmData_t *pmj);
extern void db_chkpmgr(void);
#endif /* MACH_KDB */
extern void db_pmgr(db_expr_t addr, int have_addr, db_expr_t count, char * modif);
extern void db_nap(db_expr_t addr, int have_addr, db_expr_t count, char * modif);

#endif	/* _I386_DB_MACHDEP_H_ */
Commit	Line	Data
1c79356b	1	/*
2d21ac55	2	* Copyright (c) 2000-2006 Apple Computer, Inc. All rights reserved.
1c79356b	3	*
2d21ac55	4	* @APPLE_OSREFERENCE_LICENSE_HEADER_START@
1c79356b	5	*
2d21ac55 A	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.
8f6c56a5	14	*
2d21ac55 A	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
8f6c56a5 A	20	* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
8f6c56a5 A	21	* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
2d21ac55 A	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.
8f6c56a5	25	*
2d21ac55	26	* @APPLE_OSREFERENCE_LICENSE_HEADER_END@
1c79356b A	27	*/
	28	/*
	29	* @OSF_COPYRIGHT@
	30	*/
	31	/*
	32	* Mach Operating System
	33	* Copyright (c) 1991,1990 Carnegie Mellon University
	34	* All Rights Reserved.
	35	*
	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.
	41	*
	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.
	45	*
	46	* Carnegie Mellon requests users of this software to return to
	47	*
	48	* Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
	49	* School of Computer Science
	50	* Carnegie Mellon University
	51	* Pittsburgh PA 15213-3890
	52	*
	53	* any improvements or extensions that they make and grant Carnegie Mellon
	54	* the rights to redistribute these changes.
	55	*/
	56	/*
	57	*/
	58
	59	#ifndef _I386_DB_MACHDEP_H_
	60	#define _I386_DB_MACHDEP_H_
	61
	62	/*
	63	* Machine-dependent defines for new kernel debugger.
	64	*/
	65
	66	#include <kern/kern_types.h>
	67	#include <mach/i386/vm_types.h>
	68	#include <mach/i386/vm_param.h>
	69	#include <i386/thread.h> /* for thread_status */
	70	#include <i386/eflags.h>
	71	#include <i386/trap.h>
0c530ab8 A	72	#include <i386/pmCPU.h>
0c530ab8 A	73	#include <i386/hpet.h>
1c79356b	74
0c530ab8 A	75	typedef addr64_t db_addr_t; /* address - unsigned */
0c530ab8 A	76	typedef uint64_t db_expr_t; /* expression */
1c79356b	77
0c530ab8	78	typedef struct x86_saved_state32 db_regs_t;
1c79356b A	79	db_regs_t ddb_regs; /* register state */
	80	#define DDB_REGS (&ddb_regs)
	81	extern int db_active; /* ddb is active */
	82
	83	#define PC_REGS(regs) ((db_addr_t)(regs)->eip)
	84
	85	#define BKPT_INST 0xcc /* breakpoint instruction */
	86	#define BKPT_SIZE (1) /* size of breakpoint inst */
	87	#define BKPT_SET(inst) (BKPT_INST)
	88
	89	#define FIXUP_PC_AFTER_BREAK ddb_regs.eip -= 1;
	90
	91	#define db_clear_single_step(regs) ((regs)->efl &= ~EFL_TF)
	92	#define db_set_single_step(regs) ((regs)->efl \|= EFL_TF)
	93
	94	#define IS_BREAKPOINT_TRAP(type, code) ((type) == T_INT3)
	95	#define IS_WATCHPOINT_TRAP(type, code) ((type) == T_WATCHPOINT)
	96
	97	#define I_CALL 0xe8
	98	#define I_CALLI 0xff
	99	#define I_RET 0xc3
	100	#define I_IRET 0xcf
	101
	102	#define inst_trap_return(ins) (((ins)&0xff) == I_IRET)
	103	#define inst_return(ins) (((ins)&0xff) == I_RET)
	104	#define inst_call(ins) (((ins)&0xff) == I_CALL \|\| \
	105	(((ins)&0xff) == I_CALLI && \
	106	((ins)&0x3800) == 0x1000))
	107
	108	int db_inst_load(unsigned long);
	109	int db_inst_store(unsigned long);
	110
	111	/* access capability and access macros */
	112
	113	#define DB_ACCESS_LEVEL 2 /* access any space */
	114	#define DB_CHECK_ACCESS(addr,size,task) \
	115	db_check_access(addr,size,task)
	116	#define DB_PHYS_EQ(task1,addr1,task2,addr2) \
	117	db_phys_eq(task1,addr1,task2,addr2)
0c530ab8	118	#define DB_VALID_KERN_ADDR(addr) (1)
1c79356b A	119	#define DB_VALID_ADDRESS(addr,user) \
	120	((!(user) && DB_VALID_KERN_ADDR(addr)) \|\| \
	121	((user) && (addr) < VM_MAX_ADDRESS))
	122
	123	/*
	124	* Given pointer to i386_saved_state, determine if it represents
55e303ae	125	* a thread executing in user space.
1c79356b	126	*/
55e303ae	127	#define IS_USER_TRAP(regs, etext) (((regs)->cs & 3) != 0)
1c79356b A	128
	129	extern boolean_t db_check_access(
	130	vm_offset_t addr,
	131	int size,
	132	task_t task);
	133	extern boolean_t db_phys_eq(
	134	task_t task1,
	135	vm_offset_t addr1,
	136	task_t task2,
	137	vm_offset_t addr2);
	138	extern db_addr_t db_disasm(
	139	db_addr_t loc,
	140	boolean_t altfmt,
	141	task_t task);
	142	extern void db_read_bytes(
	143	vm_offset_t addr,
	144	int size,
	145	char *data,
	146	task_t task);
	147	extern void db_write_bytes(
	148	vm_offset_t addr,
	149	int size,
	150	char *data,
	151	task_t task);
	152	extern void db_stack_trace_cmd(
	153	db_expr_t addr,
	154	boolean_t have_addr,
	155	db_expr_t count,
	156	char *modif);
	157	extern void db_reboot(
	158	db_expr_t addr,
	159	boolean_t have_addr,
	160	db_expr_t count,
	161	char *modif);
	162
2d21ac55 A	163	extern void db_display_kmod(db_expr_t addr, boolean_t have_addr,
	164	db_expr_t count, char *modif);
	165	extern void db_display_real(db_expr_t addr, boolean_t have_addr,
	166	db_expr_t count, char *modif);
	167	extern void db_display_iokit(db_expr_t addr, boolean_t have_addr,
	168	db_expr_t count, char * modif);
	169	extern void db_cpuid(db_expr_t addr, boolean_t have_addr, db_expr_t count,
	170	char *modif);
	171	extern void db_msr(db_expr_t addr, boolean_t have_addr, db_expr_t count,
	172	char *modif);
	173	extern void db_apic(db_expr_t addr, boolean_t have_addr, db_expr_t count,
	174	char *modif);
	175	extern void db_display_hpet(hpetReg_t *);
	176	extern void db_hpet(db_expr_t addr, boolean_t have_addr, db_expr_t count,
	177	char *modif);
0c530ab8	178
1c79356b A	179	/* macros for printing OS server dependent task name */
	180
	181	#define DB_TASK_NAME(task) db_task_name(task)
	182	#define DB_TASK_NAME_TITLE "COMMAND "
	183	#define DB_TASK_NAME_LEN 23
	184	#define DB_NULL_TASK_NAME "? "
	185
	186	extern void db_task_name(
	187	task_t task);
	188
	189	/* macro for checking if a thread has used floating-point */
	190
0c530ab8	191	#define db_act_fp_used(act) (act && act->machine.pcb->ifps)
1c79356b A	192
	193	extern void db_tss_to_frame(
	194	int tss_sel,
0c530ab8	195	x86_saved_state32_t *regs);
1c79356b A	196	extern int kdb_trap(
	197	int type,
	198	int code,
0c530ab8	199	x86_saved_state32_t *regs);
1c79356b	200	extern boolean_t db_trap_from_asm(
0c530ab8	201	x86_saved_state32_t *regs);
1c79356b A	202	extern void kdb_on(
1c79356b A	203	int cpu);
0c530ab8 A	204
	205	#if MACH_KDB
	206	extern void db_getpmgr(pmData_t *pmj);
	207	extern void db_chkpmgr(void);
	208	#endif /* MACH_KDB */
	209	extern void db_pmgr(db_expr_t addr, int have_addr, db_expr_t count, char * modif);
	210	extern void db_nap(db_expr_t addr, int have_addr, db_expr_t count, char * modif);
1c79356b A	211
1c79356b A	212	#endif /* _I386_DB_MACHDEP_H_ */