1 /*        $NetBSD: db_machdep.h,v 1.31 2017/11/06 03:47:46 christos 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 #if defined(_KERNEL_OPT)
37 #include "opt_multiprocessor.h"
38 #endif
39 #include <sys/param.h>
40 #include <uvm/uvm_extern.h>
41 #include <machine/trap.h>
42 
43 typedef   vaddr_t             db_addr_t;          /* address - unsigned */
44 #define   DDB_EXPR_FMT        "l"                 /* expression is long */
45 typedef   long                db_expr_t;          /* expression - signed */
46 
47 typedef struct trapframe db_regs_t;
48 
49 struct i386_frame {
50           struct i386_frame   *f_frame;
51           int                           f_retaddr;
52           int                           f_arg0;
53 };
54 
55 #ifndef MULTIPROCESSOR
56 extern db_regs_t ddb_regs;    /* register state */
57 #define   DDB_REGS  (&ddb_regs)
58 #else
59 extern db_regs_t *ddb_regp;
60 #define DDB_REGS    (ddb_regp)
61 #define ddb_regs    (*ddb_regp)
62 #endif
63 
64 #define   PC_REGS(regs)       ((regs)->tf_eip)
65 
66 #define   BKPT_ADDR(addr)     (addr)              /* breakpoint address */
67 #define   BKPT_INST 0xcc                /* breakpoint instruction */
68 #define   BKPT_SIZE (1)                 /* size of breakpoint inst */
69 #define   BKPT_SET(inst, addr)          (BKPT_INST)
70 
71 #define   FIXUP_PC_AFTER_BREAK(regs)    ((regs)->tf_eip -= BKPT_SIZE)
72 
73 #define   db_clear_single_step(regs)    ((regs)->tf_eflags &= ~PSL_T)
74 #define   db_set_single_step(regs)      ((regs)->tf_eflags |=  PSL_T)
75 
76 #define   IS_BREAKPOINT_TRAP(type, code)          ((type) == T_BPTFLT)
77 #define IS_WATCHPOINT_TRAP(type, code)  ((type) == T_TRCTRAP && (code) & 15)
78 
79 #define   I_CALL              0xe8
80 #define   I_CALLI             0xff
81 #define   I_RET               0xc3
82 #define   I_IRET              0xcf
83 
84 #define   inst_trap_return(ins)         (((ins)&0xff) == I_IRET)
85 #define   inst_return(ins)    (((ins)&0xff) == I_RET)
86 #define   inst_call(ins)                (((ins)&0xff) == I_CALL || \
87                                          (((ins)&0xff) == I_CALLI && \
88                                           ((ins)&0x3800) == 0x1000))
89 #define inst_load(ins)                  0
90 #define inst_store(ins)                 0
91 
92 /* access capability and access macros */
93 
94 #define DB_ACCESS_LEVEL                 2         /* access any space */
95 #define DB_CHECK_ACCESS(addr,size,task)                               \
96           db_check_access(addr,size,task)
97 #define DB_PHYS_EQ(task1,addr1,task2,addr2)                           \
98           db_phys_eq(task1,addr1,task2,addr2)
99 #define DB_VALID_KERN_ADDR(addr)                                      \
100           ((addr) >= VM_MIN_KERNEL_ADDRESS &&                         \
101            (addr) < VM_MAX_KERNEL_ADDRESS)
102 #define DB_VALID_ADDRESS(addr,user)                                   \
103           ((!(user) && DB_VALID_KERN_ADDR(addr)) ||                   \
104            ((user) && (addr) < VM_MAX_ADDRESS))
105 
106 #if 0
107 bool                db_check_access(vaddr_t, int, task_t);
108 bool                db_phys_eq(task_t, vaddr_t, task_t, vaddr_t);
109 #endif
110 
111 /* macros for printing OS server dependent task name */
112 
113 #define DB_TASK_NAME(task)    db_task_name(task)
114 #define DB_TASK_NAME_TITLE    "COMMAND                "
115 #define DB_TASK_NAME_LEN      23
116 #define DB_NULL_TASK_NAME     "?                      "
117 
118 /*
119  * Constants for KGDB.
120  */
121 typedef   long                kgdb_reg_t;
122 #define   KGDB_NUMREGS        16
123 #define   KGDB_BUFLEN         512
124 
125 #if 0
126 void                db_task_name(/* task_t */);
127 #endif
128 
129 /* macro for checking if a thread has used floating-point */
130 
131 #define db_thread_fp_used(thread)       ((thread)->pcb->ims.ifps != 0)
132 
133 int kdb_trap(int, int, db_regs_t *);
134 
135 /*
136  * We define some of our own commands
137  */
138 #ifdef _KERNEL
139 #define DB_MACHINE_COMMANDS
140 #endif
141 
142 /*
143  * We use Elf32 symbols in DDB.
144  */
145 #define   DB_ELF_SYMBOLS
146 
147 extern void db_machine_init(void);
148 
149 extern void cpu_debug_dump(void);
150 
151 /* i386/db_machdep.c */
152 bool db_intrstack_p(const void *);
153 
154 #endif    /* _I386_DB_MACHDEP_H_ */
155