/*      $OpenBSD: db_machdep.h,v 1.19 2021/08/30 08:11:12 jasper Exp $  */
/*      $NetBSD: db_machdep.h,v 1.2 2003/04/29 17:06:04 scw Exp $       */

/* 
 * Mach Operating System
 * Copyright (c) 1991,1990 Carnegie Mellon University
 * All Rights Reserved.
 * 
 * Permission to use, copy, modify and distribute this software and its
 * documentation is hereby granted, provided that both the copyright
 * notice and this permission notice appear in all copies of the
 * software, derivative works or modified versions, and any portions
 * thereof, and that both notices appear in supporting documentation.
 * 
 * CARNEGIE MELLON ALLOWS FREE USE OF THIS SOFTWARE IN ITS "AS IS"
 * CONDITION.  CARNEGIE MELLON DISCLAIMS ANY LIABILITY OF ANY KIND FOR
 * ANY DAMAGES WHATSOEVER RESULTING FROM THE USE OF THIS SOFTWARE.
 * 
 * Carnegie Mellon requests users of this software to return to
 * 
 *  Software Distribution Coordinator  or  Software.Distribution@CS.CMU.EDU
 *  School of Computer Science
 *  Carnegie Mellon University
 *  Pittsburgh PA 15213-3890
 * 
 * any improvements or extensions that they make and grant Carnegie Mellon
 * the rights to redistribute these changes.
 */

#ifndef _MACHINE_DB_MACHDEP_H_
#define _MACHINE_DB_MACHDEP_H_

/*
 * Machine-dependent defines for new kernel debugger.
 */

#include <sys/param.h>
#include <uvm/uvm_extern.h>
#include <machine/trap.h>
#include <sys/mutex.h>

typedef long            db_expr_t;      /* expression - signed */

typedef struct trapframe db_regs_t;

extern db_regs_t ddb_regs;      /* register state */

#define PC_REGS(regs)   ((vaddr_t)(regs)->tf_rip)
#define SET_PC_REGS(regs, value) (regs)->tf_rip = (int64_t)(value)

#define BKPT_ADDR(addr) (addr)          /* breakpoint address */
#define BKPT_INST       0xcc            /* breakpoint instruction */
#define BKPT_SIZE       (1)             /* size of breakpoint inst */
#define BKPT_SET(inst)  (BKPT_INST)

#define SSF_INST        0x55
#define SSF_SIZE        (1)

#define FIXUP_PC_AFTER_BREAK(regs)      ((regs)->tf_rip -= BKPT_SIZE)

#define db_clear_single_step(regs)      ((regs)->tf_rflags &= ~PSL_T)
#define db_set_single_step(regs)        ((regs)->tf_rflags |=  PSL_T)

#define IS_BREAKPOINT_TRAP(type, code)  ((type) == T_BPTFLT)
#define IS_WATCHPOINT_TRAP(type, code)  ((type) == T_TRCTRAP && (code) & 15)

#define I_CALL          0xe8
#define I_CALLI         0xff
#define I_RET           0xc3
#define I_IRET          0xcf

#define inst_trap_return(ins)   (((ins)&0xff) == I_IRET)
#define inst_return(ins)        (((ins)&0xff) == I_RET)
#define inst_call(ins)          (((ins)&0xff) == I_CALL || \
                                 (((ins)&0xff) == I_CALLI && \
                                  ((ins)&0x3800) == 0x1000))

/* macro for checking if a thread has used floating-point */

int db_ktrap(int, int, db_regs_t *);

void db_machine_init(void);
int db_enter_ddb(void);
void db_startcpu(int);
void db_stopcpu(int);
void x86_ipi_db(struct cpu_info *);

#define DDB_STATE_NOT_RUNNING   0
#define DDB_STATE_RUNNING       1
#define DDB_STATE_EXITING       2

/*
 * We define some of our own commands
 */
#define DB_MACHINE_COMMANDS

extern void db_machine_init(void);

extern void cpu_debug_dump(void);

#endif  /* _MACHINE_DB_MACHDEP_H_ */