1/* $NetBSD: db_machdep.h,v 1.38 2021/05/18 06:38:24 skrll Exp $ */ 2 3/* 4 * Copyright (c) 1997 Jonathan Stone (hereinafter referred to as the author) 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 3. All advertising materials mentioning features or use of this software 16 * must display the following acknowledgement: 17 * This product includes software developed by Jonathan Stone for 18 * the NetBSD Project. 19 * 4. The name of the author may not be used to endorse or promote products 20 * derived from this software without specific prior written permission. 21 * 22 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 23 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 26 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32 * SUCH DAMAGE. 33 */ 34#ifndef _MIPS_DB_MACHDEP_H_ 35#define _MIPS_DB_MACHDEP_H_ 36 37#include <sys/types.h> 38#include <sys/stdbool.h> 39 40#include <uvm/uvm_param.h> /* XXX boolean_t */ 41 42#include <mips/trap.h> /* T_BREAK */ 43#include <mips/reg.h> /* register state */ 44#include <mips/regnum.h> /* symbolic register indices */ 45#include <mips/pcb.h> 46 47#define DB_ELF_SYMBOLS 48 49typedef vaddr_t db_addr_t; /* address - unsigned */ 50#ifdef __mips_n32 51#define DDB_EXPR_FMT "ll" /* expression is long long */ 52typedef int64_t db_expr_t; /* expression - signed */ 53#else 54#define DDB_EXPR_FMT "l" /* expression is long */ 55typedef long db_expr_t; /* expression - signed */ 56#endif 57 58typedef struct reg db_regs_t; 59 60extern db_regs_t ddb_regs; /* register state */ 61#define DDB_REGS (&ddb_regs) 62 63#define PC_REGS(regs) ((regs)->r_regs[_R_PC]) 64 65#define PC_ADVANCE(regs) do { \ 66 if ((db_get_value((regs)->r_regs[_R_PC], sizeof(int), false) &\ 67 0xfc00003f) == 0xd) \ 68 (regs)->r_regs[_R_PC] += BKPT_SIZE; \ 69} while(0) 70 71/* Similar to PC_ADVANCE(), except only advance on cpu_Debugger()'s bpt */ 72#define PC_BREAK_ADVANCE(regs) do { \ 73 if (db_get_value((regs)->r_regs[_R_PC], sizeof(int), false) == 0xd) \ 74 (regs)->r_regs[_R_PC] += BKPT_SIZE; \ 75} while(0) 76 77#define BKPT_ADDR(addr) (addr) /* breakpoint address */ 78#define BKPT_INST 0x0001000D 79#define BKPT_SIZE (4) /* size of breakpoint inst */ 80#define BKPT_SET(inst, addr) (BKPT_INST) 81 82#define IS_BREAKPOINT_TRAP(type, code) ((type) == T_BREAK) 83#define IS_WATCHPOINT_TRAP(type, code) (0) /* XXX mips3 watchpoint */ 84 85/* 86 * Interface to disassembly (shared with mdb) 87 */ 88db_addr_t db_disasm_insn(int insn, db_addr_t loc, bool altfmt); 89 90/* 91 * Entrypoints to DDB for kernel, keyboard drivers, init hook 92 */ 93void kdb_kbd_trap(db_regs_t *); 94int kdb_trap(int, struct reg *); 95 96static inline void 97db_set_ddb_regs(int type, struct reg *regs) 98{ 99 ddb_regs = *regs; 100} 101 102/* 103 * Helper functions for fetching 32-bit and 64-bit kernel memory. 104 */ 105bool kdbpeek(vaddr_t, unsigned *); 106mips_reg_t kdbrpeek(vaddr_t, size_t); 107 108 109/* 110 * Constants for KGDB. 111 */ 112typedef mips_reg_t kgdb_reg_t; 113#define KGDB_NUMREGS 90 114#define KGDB_BUFLEN 1024 115 116/* 117 * MIPS cpus have no hardware single-step. 118 */ 119#define SOFTWARE_SSTEP 120 121#define inst_trap_return(ins) ((ins)&0) 122 123bool inst_branch(int inst); 124bool inst_call(int inst); 125bool inst_return(int inst); 126bool inst_load(int inst); 127bool inst_store(int inst); 128bool inst_unconditional_flow_transfer(int inst); 129db_addr_t branch_taken(int inst, db_addr_t pc, db_regs_t *regs); 130db_addr_t next_instr_address(db_addr_t pc, bool bd); 131 132bool ddb_running_on_this_cpu_p(void); 133bool ddb_running_on_any_cpu_p(void); 134void db_resume_others(void); 135void db_mips_stack_trace(void *, void *, void (*pr)(const char *, ...)); 136 137 138#ifdef _KERNEL 139/* 140 * Optional function to perform machine- or cpu-specific reset. 141 * Called from ddb "machine reset". 142 */ 143extern void (*cpu_reset_address)(void); 144 145/* 146 * We have machine-dependent commands. 147 */ 148#define DB_MACHINE_COMMANDS 149#endif 150 151#define db_stacktrace_print(prfunc) \ 152 db_mips_stack_trace(__builtin_return_address(0), \ 153 __builtin_frame_address(0), prfunc) 154 155#endif /* _MIPS_DB_MACHDEP_H_ */ 156