/*      $NetBSD: mcontext.h,v 1.25 2026/07/10 15:11:25 riastradh Exp $  */

/*-
 * Copyright (c) 1999 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Klaus Klein.
 *
 * 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.
 *
 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
 * ``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 FOUNDATION OR CONTRIBUTORS
 * 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_MCONTEXT_H_
#define _AMD64_MCONTEXT_H_

#ifdef __x86_64__

#include <machine/frame_regs.h>

/*
 * General register state
 */
#define GREG_OFFSETS(reg, REG, idx) _REG_##REG = idx,
enum { _FRAME_GREG(GREG_OFFSETS) _NGREG = 26 };
#undef GREG_OFFSETS

typedef unsigned long   __greg_t;
typedef __greg_t        __gregset_t[_NGREG];

/* These names are for compatibility */
#define _REG_URSP       _REG_RSP
#define _REG_RFL        _REG_RFLAGS

/*
 * Floating point register state
 * The format of __fpregset_t is that of the fxsave instruction
 * which requires 16 byte alignment. However the mcontext version
 * is never directly accessed.
 */
typedef union {
        char    __fxsave[512] __aligned(8);
        struct {
                /*
                 * `The XSAVE feature set does not use bytes 511:416;
                 *  bytes 463:416 are reserved.'
                 *
                 * We take a part out of this to form a pointer to an
                 * external XSAVE area.  This way, we can replicate the
                 * FXSAVE parts for the benefit of userland programs
                 * that aren't aware of the XSAVE pointer, have used
                 * the extended CPU registers (ymmN/zmmN/&c.), and want
                 * to examine the x87/SSE register state in a signal
                 * handler.  The kernel does not use this part.
                 */
                char            __fxsave[416];
                char            __rsvd[48];
                __greg_t        __xsaveptr;
                __greg_t        __xsavelen;
                char            __pad[32];
        }       __xsave;
} __fpregset_t;

typedef struct {
        __gregset_t     __gregs;
        __greg_t        _mc_tlsbase;
        __fpregset_t    __fpregs;
} mcontext_t;

#define _UC_UCONTEXT_ALIGN      (~0xf)

/* AMD64 ABI 128-bytes "red zone". */
#define _UC_MACHINE_SP(uc)      ((uc)->uc_mcontext.__gregs[_REG_RSP] - 128)
#define _UC_MACHINE_FP(uc)      ((uc)->uc_mcontext.__gregs[_REG_RBP])
#define _UC_MACHINE_PC(uc)      ((uc)->uc_mcontext.__gregs[_REG_RIP])
#define _UC_MACHINE_INTRV(uc)   ((uc)->uc_mcontext.__gregs[_REG_RAX])

#define _UC_MACHINE_SET_PC(uc, pc)      _UC_MACHINE_PC(uc) = (pc)

#define _UC_TLSBASE     _UC_MD_BIT19
#define _UC_XSAVE       _UC_MD_BIT20

/*
 * mcontext extensions to handle signal delivery.
 */
#define _UC_SETSTACK    _UC_MD_BIT16
#define _UC_CLRSTACK    _UC_MD_BIT17

#define __UCONTEXT_SIZE 784

#ifdef _KERNEL

/*
 * 32bit context definitions.
 */

#define _NGREG32        19
typedef unsigned int    __greg32_t;
typedef __greg32_t      __gregset32_t[_NGREG32];

#define _REG32_GS       0
#define _REG32_FS       1
#define _REG32_ES       2
#define _REG32_DS       3
#define _REG32_EDI      4
#define _REG32_ESI      5
#define _REG32_EBP      6
#define _REG32_ESP      7
#define _REG32_EBX      8
#define _REG32_EDX      9
#define _REG32_ECX      10
#define _REG32_EAX      11
#define _REG32_TRAPNO   12
#define _REG32_ERR      13
#define _REG32_EIP      14
#define _REG32_CS       15
#define _REG32_EFL      16
#define _REG32_UESP     17
#define _REG32_SS       18

#define _UC_MACHINE32_SP(uc)    ((uc)->uc_mcontext.__gregs[_REG32_UESP])

/*
 * Floating point register state
 */
typedef struct {
        union {
                struct {
                        int     __fp_state[27]; /* Environment and registers */
                } __fpchip_state;
                struct {
                        char    __fp_xmm[512];
                } __fp_xmm_state;
                struct {
                        char            __fxsave[416];
                        char            __rsvd[48];
                        __greg32_t      __xsaveptr;
                        __greg32_t      __xsavelen;
                        char            __pad[40];
                } __xsave;
        } __fp_reg_set;
        int     __fp_pad[33];                   /* Historic padding */
} __fpregset32_t;

typedef struct {
        __gregset32_t   __gregs;
        __fpregset32_t  __fpregs;
        uint32_t        _mc_tlsbase;
} mcontext32_t;

#define _UC_FXSAVE       _UC_MD_BIT5    /* FP state is in FXSAVE format in XMM space */

#define _UC_MACHINE32_PAD       4
#define __UCONTEXT32_SIZE       776

#endif /* _KERNEL */

#else   /*      __x86_64__      */

#include <i386/mcontext.h>

#endif  /*      __x86_64__      */

#endif  /* !_AMD64_MCONTEXT_H_ */