xref: /netbsd-src/sys/arch/i386/include/db_machdep.h (revision d710132b4b8ce7f7cccaaf660cb16aa16b4077a0)
1 /*	$NetBSD: db_machdep.h,v 1.22 2003/06/23 11:01:22 martin Exp $	*/
2 
3 /*
4  * Mach Operating System
5  * Copyright (c) 1991,1990 Carnegie Mellon University
6  * All Rights Reserved.
7  *
8  * Permission to use, copy, modify and distribute this software and its
9  * documentation is hereby granted, provided that both the copyright
10  * notice and this permission notice appear in all copies of the
11  * software, derivative works or modified versions, and any portions
12  * thereof, and that both notices appear in supporting documentation.
13  *
14  * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
15  * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
16  * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
17  *
18  * Carnegie Mellon requests users of this software to return to
19  *
20  *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
21  *  School of Computer Science
22  *  Carnegie Mellon University
23  *  Pittsburgh PA 15213-3890
24  *
25  * any improvements or extensions that they make and grant Carnegie Mellon
26  * the rights to redistribute these changes.
27  */
28 
29 #ifndef	_I386_DB_MACHDEP_H_
30 #define	_I386_DB_MACHDEP_H_
31 
32 /*
33  * Machine-dependent defines for new kernel debugger.
34  */
35 
36 #include "opt_multiprocessor.h"
37 #include <sys/param.h>
38 #include <uvm/uvm_extern.h>
39 #include <machine/trap.h>
40 
41 typedef	vaddr_t		db_addr_t;	/* address - unsigned */
42 typedef	long		db_expr_t;	/* expression - signed */
43 
44 typedef struct trapframe db_regs_t;
45 #ifndef MULTIPROCESSOR
46 extern db_regs_t ddb_regs;	/* register state */
47 #define	DDB_REGS	(&ddb_regs)
48 #else
49 extern db_regs_t *ddb_regp;
50 #define DDB_REGS	(ddb_regp)
51 #define ddb_regs	(*ddb_regp)
52 #endif
53 
54 #define	PC_REGS(regs)	((regs)->tf_eip)
55 
56 #define	BKPT_ADDR(addr)	(addr)		/* breakpoint address */
57 #define	BKPT_INST	0xcc		/* breakpoint instruction */
58 #define	BKPT_SIZE	(1)		/* size of breakpoint inst */
59 #define	BKPT_SET(inst)	(BKPT_INST)
60 
61 #define	FIXUP_PC_AFTER_BREAK(regs)	((regs)->tf_eip -= BKPT_SIZE)
62 
63 #define	db_clear_single_step(regs)	((regs)->tf_eflags &= ~PSL_T)
64 #define	db_set_single_step(regs)	((regs)->tf_eflags |=  PSL_T)
65 
66 #define	IS_BREAKPOINT_TRAP(type, code)	((type) == T_BPTFLT)
67 #define IS_WATCHPOINT_TRAP(type, code)	((type) == T_TRCTRAP && (code) & 15)
68 
69 #define	I_CALL		0xe8
70 #define	I_CALLI		0xff
71 #define	I_RET		0xc3
72 #define	I_IRET		0xcf
73 
74 #define	inst_trap_return(ins)	(((ins)&0xff) == I_IRET)
75 #define	inst_return(ins)	(((ins)&0xff) == I_RET)
76 #define	inst_call(ins)		(((ins)&0xff) == I_CALL || \
77 				 (((ins)&0xff) == I_CALLI && \
78 				  ((ins)&0x3800) == 0x1000))
79 #define inst_load(ins)		0
80 #define inst_store(ins)		0
81 
82 /* access capability and access macros */
83 
84 #define DB_ACCESS_LEVEL		2	/* access any space */
85 #define DB_CHECK_ACCESS(addr,size,task)				\
86 	db_check_access(addr,size,task)
87 #define DB_PHYS_EQ(task1,addr1,task2,addr2)			\
88 	db_phys_eq(task1,addr1,task2,addr2)
89 #define DB_VALID_KERN_ADDR(addr)				\
90 	((addr) >= VM_MIN_KERNEL_ADDRESS && 			\
91 	 (addr) < VM_MAX_KERNEL_ADDRESS)
92 #define DB_VALID_ADDRESS(addr,user)				\
93 	((!(user) && DB_VALID_KERN_ADDR(addr)) ||		\
94 	 ((user) && (addr) < VM_MAX_ADDRESS))
95 
96 #if 0
97 boolean_t 	db_check_access __P((vaddr_t, int, task_t));
98 boolean_t	db_phys_eq __P((task_t, vaddr_t, task_t, vaddr_t));
99 #endif
100 
101 /* macros for printing OS server dependent task name */
102 
103 #define DB_TASK_NAME(task)	db_task_name(task)
104 #define DB_TASK_NAME_TITLE	"COMMAND                "
105 #define DB_TASK_NAME_LEN	23
106 #define DB_NULL_TASK_NAME	"?                      "
107 
108 /*
109  * Constants for KGDB.
110  */
111 typedef	long		kgdb_reg_t;
112 #define	KGDB_NUMREGS	16
113 #define	KGDB_BUFLEN	512
114 
115 #if 0
116 void		db_task_name(/* task_t */);
117 #endif
118 
119 /* macro for checking if a thread has used floating-point */
120 
121 #define db_thread_fp_used(thread)	((thread)->pcb->ims.ifps != 0)
122 
123 int kdb_trap __P((int, int, db_regs_t *));
124 
125 /*
126  * We define some of our own commands
127  */
128 #define DB_MACHINE_COMMANDS
129 
130 /*
131  * We use either a.out or Elf32 symbols in DDB.
132  */
133 #define	DB_AOUT_SYMBOLS
134 #define	DB_ELF_SYMBOLS
135 #define	DB_ELFSIZE	32
136 
137 extern void db_machine_init __P((void));
138 
139 extern void cpu_debug_dump __P((void));
140 
141 #endif	/* _I386_DB_MACHDEP_H_ */
142