/*      $NetBSD: ptrace.h,v 1.23 2023/11/20 03:05:48 simonb Exp $       */

/*
* Copyright (c) 1993 Christopher G. Demetriou
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
*    notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
*    notice, this list of conditions and the following disclaimer in the
*    documentation and/or other materials provided with the distribution.
* 3. All advertising materials mentioning features or use of this software
*    must display the following acknowledgement:
*      This product includes software developed by Christopher G. Demetriou.
* 4. The name of the author may not be used to endorse or promote products
*    derived from this software without specific prior written permission
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
* IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
* OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
* IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
* NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef _AMD64_PTRACE_H_
#define _AMD64_PTRACE_H_

#ifdef __x86_64__
/*
* amd64-dependent ptrace definitions
*/
#define PT_STEP                 (PT_FIRSTMACH + 0)
#define PT_GETREGS              (PT_FIRSTMACH + 1)
#define PT_SETREGS              (PT_FIRSTMACH + 2)
#define PT_GETFPREGS            (PT_FIRSTMACH + 3)
#define PT_SETFPREGS            (PT_FIRSTMACH + 4)
#define PT_GETDBREGS            (PT_FIRSTMACH + 5)
#define PT_SETDBREGS            (PT_FIRSTMACH + 6)
#define PT_SETSTEP              (PT_FIRSTMACH + 7)
#define PT_CLEARSTEP            (PT_FIRSTMACH + 8)
#define PT_GETXSTATE            (PT_FIRSTMACH + 9)
#define PT_SETXSTATE            (PT_FIRSTMACH + 10)
#ifdef _KERNEL
/*
* Only used internally for COMPAT_NETBSD32
*/
#define PT_GETXMMREGS           (PT_FIRSTMACH + 11)
#define PT_SETXMMREGS           (PT_FIRSTMACH + 12)
#endif

/* We have machine-dependent process tracing needs. */
#define __HAVE_PTRACE_MACHDEP

#define PT_MACHDEP_STRINGS \
       "PT_STEP", \
       "PT_GETREGS", \
       "PT_SETREGS", \
       "PT_GETFPREGS", \
       "PT_SETFPREGS", \
       "PT_GETDBREGS", \
       "PT_SETDBREGS", \
       "PT_SETSTEP", \
       "PT_CLEARSTEP", \
       "PT_GETXSTATE", \
       "PT_SETXSTATE", \
       "PT_GETXMMREGS", \
       "PT_SETXMMREGS"

#include <machine/reg.h>
#define PTRACE_REG_PC(r)        (r)->regs[_REG_RIP]
#define PTRACE_REG_FP(r)        (r)->regs[_REG_RBP]
#define PTRACE_REG_SET_PC(r, v) (r)->regs[_REG_RIP] = (v)
#define PTRACE_REG_SP(r)        (r)->regs[_REG_RSP]
#define PTRACE_REG_INTRV(r)     (r)->regs[_REG_RAX]

#define PTRACE_ILLEGAL_ASM      __asm __volatile ("ud2" : : : "memory")

#define PTRACE_BREAKPOINT       ((const uint8_t[]) { 0xcc })
#define PTRACE_BREAKPOINT_ASM   __asm __volatile ("int3" : : : "memory")
#define PTRACE_BREAKPOINT_SIZE  1
#define PTRACE_BREAKPOINT_ADJ   1

#ifdef _KERNEL

/*
* These are used in sys_ptrace() to find good ptrace(2) requests.
*/
#define PTRACE_MACHDEP_REQUEST_CASES                                    \
       case PT_GETXSTATE:                                              \
       case PT_SETXSTATE:                                              \
       case PT_GETXMMREGS:                                             \
       case PT_SETXMMREGS:

int process_machdep_doxstate(struct lwp *, struct lwp *, struct uio *);
int process_machdep_validfpu(struct proc *);

/*
* The fpregs structure contains an fxsave area, which must have 16-byte
* alignment.
*/
#define PTRACE_REGS_ALIGN __aligned(16)

#include <sys/module_hook.h>
MODULE_HOOK(netbsd32_process_doxmmregs_hook, int,
   (struct lwp *, struct lwp *, void *, bool));

#ifdef EXEC_ELF32
#include <machine/netbsd32_machdep.h>
#endif
#define PT64_GETXSTATE          PT_GETXSTATE
#define COREDUMP_MACHDEP_LWP_NOTES(l, ns, name)                         \
{                                                                       \
       struct xstate xstate;   /* XXX FIXME big stack object */        \
       memset(&xstate, 0, sizeof(xstate));                             \
       if (!process_read_xstate(l, &xstate))                           \
       {                                                               \
               ELFNAMEEND(coredump_savenote)(ns,                       \
                   CONCAT(CONCAT(PT, ELFSIZE), _GETXSTATE), name,      \
                   &xstate, sizeof(xstate));                           \
       }                                                               \
}

#endif /* _KERNEL */

#ifdef _KERNEL_OPT
#include "opt_compat_netbsd32.h"

#ifdef COMPAT_NETBSD32
#include <machine/netbsd32_machdep.h>

#define process_read_regs32     netbsd32_process_read_regs
#define process_read_fpregs32   netbsd32_process_read_fpregs
#define process_read_dbregs32   netbsd32_process_read_dbregs

#define process_write_regs32    netbsd32_process_write_regs
#define process_write_fpregs32  netbsd32_process_write_fpregs
#define process_write_dbregs32  netbsd32_process_write_dbregs

#define process_reg32           struct reg32
#define process_fpreg32         struct fpreg32
#define process_dbreg32         struct dbreg32

#define PTRACE_TRANSLATE_REQUEST32(x) netbsd32_ptrace_translate_request(x)
#endif  /* COMPAT_NETBSD32 */
#endif  /* _KERNEL_OPT */

#else   /* !__x86_64__ */

#include <i386/ptrace.h>

#endif  /* __x86_64__ */

#endif  /* _AMD64_PTRACE_H_ */