/*-
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 1999 Marcel Moolenaar
 * Copyright (c) 2003 Peter Wemm
 * 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 
 *    in this position and unchanged.
 * 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. 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 _COMPAT_IA32_IA32_SIGNAL_H
#define _COMPAT_IA32_IA32_SIGNAL_H

#include <compat/freebsd32/freebsd32_signal.h>

#define _MC_IA32_HASSEGS        0x1
#define _MC_IA32_HASBASES       0x2
#define _MC_IA32_HASFPXSTATE    0x4
#define _MC_IA32_FLAG_MASK      \
    (_MC_IA32_HASSEGS | _MC_IA32_HASBASES | _MC_IA32_HASFPXSTATE)

struct ia32_mcontext {
        uint32_t        mc_onstack;             /* XXX - sigcontext compat. */
        uint32_t        mc_gs;                  /* machine state (struct trapframe) */
        uint32_t        mc_fs;
        uint32_t        mc_es;
        uint32_t        mc_ds;
        uint32_t        mc_edi;
        uint32_t        mc_esi;
        uint32_t        mc_ebp;
        uint32_t        mc_isp;
        uint32_t        mc_ebx;
        uint32_t        mc_edx;
        uint32_t        mc_ecx;
        uint32_t        mc_eax;
        uint32_t        mc_trapno;
        uint32_t        mc_err;
        uint32_t        mc_eip;
        uint32_t        mc_cs;
        uint32_t        mc_eflags;
        uint32_t        mc_esp;
        uint32_t        mc_ss;
        uint32_t        mc_len;                 /* sizeof(struct ia32_mcontext) */
        /* We use the same values for fpformat and ownedfp */
        uint32_t        mc_fpformat;
        uint32_t        mc_ownedfp;
        uint32_t        mc_flags;
        /*
         * See <i386/include/npx.h> for the internals of mc_fpstate[].
         */
        uint32_t        mc_fpstate[128] __aligned(16);
        uint32_t        mc_fsbase;
        uint32_t        mc_gsbase;
        uint32_t        mc_xfpustate;
        uint32_t        mc_xfpustate_len;
        uint32_t        mc_spare2[4];
};

struct ia32_ucontext {
        sigset_t                uc_sigmask;
        struct ia32_mcontext    uc_mcontext;
        uint32_t                uc_link;
        struct sigaltstack32    uc_stack;
        uint32_t                uc_flags;
        uint32_t                __spare__[4];
};

struct ia32_freebsd4_mcontext {
        uint32_t        mc_onstack;             /* XXX - sigcontext compat. */
        uint32_t        mc_gs;                  /* machine state (struct trapframe) */
        uint32_t        mc_fs;
        uint32_t        mc_es;
        uint32_t        mc_ds;
        uint32_t        mc_edi;
        uint32_t        mc_esi;
        uint32_t        mc_ebp;
        uint32_t        mc_isp;
        uint32_t        mc_ebx;
        uint32_t        mc_edx;
        uint32_t        mc_ecx;
        uint32_t        mc_eax;
        uint32_t        mc_trapno;
        uint32_t        mc_err;
        uint32_t        mc_eip;
        uint32_t        mc_cs;
        uint32_t        mc_eflags;
        uint32_t        mc_esp; 
        uint32_t        mc_ss;
        uint32_t        mc_fpregs[28];
        uint32_t        __spare__[17];
};

struct ia32_freebsd4_ucontext {
        sigset_t                uc_sigmask;
        struct ia32_freebsd4_mcontext   uc_mcontext;
        uint32_t                uc_link;
        struct sigaltstack32    uc_stack;
        uint32_t                __spare__[8];
};

struct ia32_osigcontext {
        uint32_t        sc_onstack;
        uint32_t        sc_mask;
        uint32_t        sc_esp; 
        uint32_t        sc_ebp;
        uint32_t        sc_isp;
        uint32_t        sc_eip;
        uint32_t        sc_eflags;
        uint32_t        sc_es;
        uint32_t        sc_ds;
        uint32_t        sc_cs;
        uint32_t        sc_ss;
        uint32_t        sc_edi;
        uint32_t        sc_esi;
        uint32_t        sc_ebx;
        uint32_t        sc_edx;
        uint32_t        sc_ecx;
        uint32_t        sc_eax;
        uint32_t        sc_gs;
        uint32_t        sc_fs;
        uint32_t        sc_trapno;
        uint32_t        sc_err;
};

/*
 * Signal frames, arguments passed to application signal handlers.
 */

struct ia32_freebsd4_sigframe {
        uint32_t                sf_signum;
        uint32_t                sf_siginfo;     /* code or pointer to sf_si */
        uint32_t                sf_ucontext;    /* points to sf_uc */
        uint32_t                sf_addr;        /* undocumented 4th arg */
        uint32_t                sf_ah;          /* action/handler pointer */
        struct ia32_freebsd4_ucontext   sf_uc;          /* = *sf_ucontext */
        struct __siginfo32      sf_si;          /* = *sf_siginfo (SA_SIGINFO case) */
};

struct ia32_sigframe {
        uint32_t                sf_signum;
        uint32_t                sf_siginfo;     /* code or pointer to sf_si */
        uint32_t                sf_ucontext;    /* points to sf_uc */
        uint32_t                sf_addr;        /* undocumented 4th arg */
        uint32_t                sf_ah;          /* action/handler pointer */
        /* Beware, hole due to ucontext being 16 byte aligned! */
        struct ia32_ucontext    sf_uc;          /* = *sf_ucontext */
        struct __siginfo32      sf_si;          /* = *sf_siginfo (SA_SIGINFO case) */
};

struct ia32_osiginfo {
        struct ia32_osigcontext si_sc;
        int                     si_signo;
        int                     si_code;
        union sigval32          si_value;
};
struct ia32_osigframe {
        int                     sf_signum;
        uint32_t                sf_arg2;        /* int or siginfo_t */
        uint32_t                sf_scp;
        uint32_t                sf_addr;
        uint32_t                sf_ah;          /* action/handler pointer */
        struct ia32_osiginfo    sf_siginfo;
};

struct ksiginfo;
struct image_params;
void ia32_sendsig(sig_t, struct ksiginfo *, sigset_t *);
void ia32_setregs(struct thread *td, struct image_params *imgp,
    uintptr_t stack);
int setup_lcall_gate(void);

#endif