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