/*-
 * SPDX-License-Identifier: BSD-3-Clause
 *
 * Copyright (c) 1998-1999 Andrew Gallatin
 * 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 withough 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_FREEBSD32_FREEBSD32_UTIL_H_
#define _COMPAT_FREEBSD32_FREEBSD32_UTIL_H_

#include <sys/cdefs.h>
#include <sys/exec.h>
#include <sys/sysent.h>
#include <sys/uio.h>

#include <vm/vm.h>
#include <vm/vm_param.h>
#include <vm/pmap.h>

struct freebsd32_ps_strings {
        uint32_t ps_argvstr;    /* first of 0 or more argument strings */
        int     ps_nargvstr;    /* the number of argument strings */
        uint32_t ps_envstr;     /* first of 0 or more environment strings */
        int     ps_nenvstr;     /* the number of environment strings */
};

#if defined(__amd64__)
#include <compat/ia32/ia32_util.h>
#endif

#define FREEBSD32_PS_STRINGS    \
        (FREEBSD32_USRSTACK - sizeof(struct freebsd32_ps_strings))

extern struct sysent freebsd32_sysent[];

#define SYSCALL32_MODULE(name, offset, new_sysent, evh, arg)   \
static struct syscall_module_data name##_syscall32_mod = {     \
       evh, arg, offset, new_sysent, { 0, NULL }               \
};                                                             \
                                                               \
static moduledata_t name##32_mod = {                           \
       "sys32/" #name,                                         \
       syscall32_module_handler,                               \
       &name##_syscall32_mod                                   \
};                                                             \
DECLARE_MODULE(name##32, name##32_mod, SI_SUB_SYSCALLS, SI_ORDER_MIDDLE)

#define SYSCALL32_MODULE_HELPER(syscallname)            \
static int syscallname##_syscall32 = FREEBSD32_SYS_##syscallname; \
static struct sysent syscallname##_sysent32 = {         \
    (sizeof(struct syscallname ## _args )               \
     / sizeof(register_t)),                             \
    (sy_call_t *)& syscallname                          \
};                                                      \
SYSCALL32_MODULE(syscallname,                           \
    & syscallname##_syscall32, & syscallname##_sysent32,\
    NULL, NULL);

#define SYSCALL32_INIT_HELPER_F(syscallname, flags) {           \
    .new_sysent = {                                             \
        .sy_narg = (sizeof(struct syscallname ## _args )        \
            / sizeof(register_t)),                              \
        .sy_call = (sy_call_t *)& syscallname,                  \
        .sy_flags = (flags)                                     \
    },                                                          \
    .syscall_no = FREEBSD32_SYS_##syscallname                   \
}

#define SYSCALL32_INIT_HELPER_COMPAT_F(syscallname, flags) {    \
    .new_sysent = {                                             \
        .sy_narg = (sizeof(struct syscallname ## _args )        \
            / sizeof(register_t)),                              \
        .sy_call = (sy_call_t *)& sys_ ## syscallname,          \
        .sy_flags = (flags)                                     \
    },                                                          \
    .syscall_no = FREEBSD32_SYS_##syscallname                   \
}

#define SYSCALL32_INIT_HELPER(syscallname)                      \
    SYSCALL32_INIT_HELPER_F(syscallname, 0)
#define SYSCALL32_INIT_HELPER_COMPAT(syscallname)               \
    SYSCALL32_INIT_HELPER_COMPAT_F(syscallname, 0)

int    syscall32_module_handler(struct module *mod, int what, void *arg);
int    syscall32_helper_register(struct syscall_helper_data *sd, int flags);
int    syscall32_helper_unregister(struct syscall_helper_data *sd);

struct iovec32;
struct rusage32;
int     freebsd32_copyout_strings(struct image_params *imgp,
            uintptr_t *stack_base);
int     freebsd32_copyiniov(struct iovec32 *iovp, u_int iovcnt,
            struct iovec **iov, int error);
int     freebsd32_copyinuio(const struct iovec32 *iovp, u_int iovcnt,
            struct uio **uiop);
void    freebsd32_rusage_out(const struct rusage *s, struct rusage32 *s32);

struct image_args;
int freebsd32_exec_copyin_args(struct image_args *args, const char *fname,
            uint32_t *argv, uint32_t *envv);

struct kinfo_knote;
struct kinfo_knote32;
void    freebsd32_kinfo_knote_to_32(const struct kinfo_knote *kin,
            struct kinfo_knote32 *kin32);

extern int compat_freebsd_32bit;

#endif /* !_COMPAT_FREEBSD32_FREEBSD32_UTIL_H_ */