Sync usage with man page.
[netbsd-mini2440.git] / sys / arch / i386 / include / db_machdep.h
blob23322323542341e7ce5fdc7cd14b985d288096e7
1 /* $NetBSD: db_machdep.h,v 1.26 2007/02/21 22:59:45 thorpej Exp $ */
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.
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.
18 * Carnegie Mellon requests users of this software to return to
20 * Software Distribution Coordinator or Software.Distribution@CS.CMU.EDU
21 * School of Computer Science
22 * Carnegie Mellon University
23 * Pittsburgh PA 15213-3890
25 * any improvements or extensions that they make and grant Carnegie Mellon
26 * the rights to redistribute these changes.
29 #ifndef _I386_DB_MACHDEP_H_
30 #define _I386_DB_MACHDEP_H_
33 * Machine-dependent defines for new kernel debugger.
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>
43 typedef vaddr_t db_addr_t; /* address - unsigned */
44 typedef long db_expr_t; /* expression - signed */
46 typedef struct trapframe db_regs_t;
47 #ifndef MULTIPROCESSOR
48 extern db_regs_t ddb_regs; /* register state */
49 #define DDB_REGS (&ddb_regs)
50 #else
51 extern db_regs_t *ddb_regp;
52 #define DDB_REGS (ddb_regp)
53 #define ddb_regs (*ddb_regp)
54 #endif
56 #define PC_REGS(regs) ((regs)->tf_eip)
58 #define BKPT_ADDR(addr) (addr) /* breakpoint address */
59 #define BKPT_INST 0xcc /* breakpoint instruction */
60 #define BKPT_SIZE (1) /* size of breakpoint inst */
61 #define BKPT_SET(inst, addr) (BKPT_INST)
63 #define FIXUP_PC_AFTER_BREAK(regs) ((regs)->tf_eip -= BKPT_SIZE)
65 #define db_clear_single_step(regs) ((regs)->tf_eflags &= ~PSL_T)
66 #define db_set_single_step(regs) ((regs)->tf_eflags |= PSL_T)
68 #define IS_BREAKPOINT_TRAP(type, code) ((type) == T_BPTFLT)
69 #define IS_WATCHPOINT_TRAP(type, code) ((type) == T_TRCTRAP && (code) & 15)
71 #define I_CALL 0xe8
72 #define I_CALLI 0xff
73 #define I_RET 0xc3
74 #define I_IRET 0xcf
76 #define inst_trap_return(ins) (((ins)&0xff) == I_IRET)
77 #define inst_return(ins) (((ins)&0xff) == I_RET)
78 #define inst_call(ins) (((ins)&0xff) == I_CALL || \
79 (((ins)&0xff) == I_CALLI && \
80 ((ins)&0x3800) == 0x1000))
81 #define inst_load(ins) 0
82 #define inst_store(ins) 0
84 /* access capability and access macros */
86 #define DB_ACCESS_LEVEL 2 /* access any space */
87 #define DB_CHECK_ACCESS(addr,size,task) \
88 db_check_access(addr,size,task)
89 #define DB_PHYS_EQ(task1,addr1,task2,addr2) \
90 db_phys_eq(task1,addr1,task2,addr2)
91 #define DB_VALID_KERN_ADDR(addr) \
92 ((addr) >= VM_MIN_KERNEL_ADDRESS && \
93 (addr) < VM_MAX_KERNEL_ADDRESS)
94 #define DB_VALID_ADDRESS(addr,user) \
95 ((!(user) && DB_VALID_KERN_ADDR(addr)) || \
96 ((user) && (addr) < VM_MAX_ADDRESS))
98 #if 0
99 bool db_check_access(vaddr_t, int, task_t);
100 bool db_phys_eq(task_t, vaddr_t, task_t, vaddr_t);
101 #endif
103 /* macros for printing OS server dependent task name */
105 #define DB_TASK_NAME(task) db_task_name(task)
106 #define DB_TASK_NAME_TITLE "COMMAND "
107 #define DB_TASK_NAME_LEN 23
108 #define DB_NULL_TASK_NAME "? "
111 * Constants for KGDB.
113 typedef long kgdb_reg_t;
114 #define KGDB_NUMREGS 16
115 #define KGDB_BUFLEN 512
117 #if 0
118 void db_task_name(/* task_t */);
119 #endif
121 /* macro for checking if a thread has used floating-point */
123 #define db_thread_fp_used(thread) ((thread)->pcb->ims.ifps != 0)
125 int kdb_trap(int, int, db_regs_t *);
128 * We define some of our own commands
130 #ifdef _KERNEL
131 #define DB_MACHINE_COMMANDS
132 #endif
135 * We use either a.out or Elf32 symbols in DDB.
137 #define DB_AOUT_SYMBOLS
138 #define DB_ELF_SYMBOLS
139 #define DB_ELFSIZE 32
141 extern void db_machine_init(void);
143 extern void cpu_debug_dump(void);
145 #endif /* _I386_DB_MACHDEP_H_ */