/*      $NetBSD: linux_exec.h,v 1.55 2021/11/26 08:56:28 ryo Exp $      */

/*-
 * Copyright (c) 1995, 1998 The NetBSD Foundation, Inc.
 * All rights reserved.
 *
 * This code is derived from software contributed to The NetBSD Foundation
 * by Frank van der Linden and Eric Haszlakiewicz.
 *
 * 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 _LINUX_EXEC_H
#define _LINUX_EXEC_H

#if defined(EXEC_AOUT)
#include <sys/exec_aout.h>
#endif

#if defined(EXEC_ELF32) || defined(EXEC_ELF64)
#include <sys/exec_elf.h>
#endif

#if defined(__i386__)
#include <compat/linux/arch/i386/linux_exec.h>
#elif defined(__m68k__)
#include <compat/linux/arch/m68k/linux_exec.h>
#elif defined(__alpha__)
#include <compat/linux/arch/alpha/linux_exec.h>
#elif defined(__powerpc__)
#include <compat/linux/arch/powerpc/linux_exec.h>
#elif defined(__mips__)
#include <compat/linux/arch/mips/linux_exec.h>
#elif defined(__aarch64__)
#include <compat/linux/arch/aarch64/linux_exec.h>
#elif defined(__arm__)
#include <compat/linux/arch/arm/linux_exec.h>
#elif defined(__amd64__)
#include <compat/linux/arch/amd64/linux_exec.h>
#endif


/* Defines for a.out executables */
#define LINUX_AOUT_HDR_SIZE (sizeof (struct exec))
#define LINUX_AOUT_AUX_ARGSIZ   8

#define LINUX_N_MAGIC(ep)    ((ep)->a_midmag & 0xffff)
#define LINUX_N_MACHTYPE(ep) (((ep)->a_midmag >> 16) & 0xff)

#define LINUX_N_TXTOFF(x,m) \
 ((m) == ZMAGIC ? 1024 : ((m) == QMAGIC ? 0 : sizeof (struct exec)))

#define LINUX_N_DATOFF(x,m) (LINUX_N_TXTOFF(x,m) + (x).a_text)

#define LINUX_N_TXTADDR(x,m) ((m) == QMAGIC ? PAGE_SIZE : 0)

#define LINUX__N_SEGMENT_ROUND(x) (((x) + PAGE_SIZE - 1) & ~(PAGE_SIZE - 1))

#define LINUX__N_TXTENDADDR(x,m) (LINUX_N_TXTADDR(x,m)+(x).a_text)

#define LINUX_N_DATADDR(x,m) \
    ((m)==OMAGIC? (LINUX__N_TXTENDADDR(x,m)) \
     : (LINUX__N_SEGMENT_ROUND (LINUX__N_TXTENDADDR(x,m))))

#define LINUX_N_BSSADDR(x,m) (LINUX_N_DATADDR(x,m) + (x).a_data)

#ifndef LINUX_MACHDEP_ELF_COPYARGS
/* Counted from linux_exec_elf32.c */
#define LINUX_ELF_AUX_ENTRIES   14
#endif

/*
 * From Linux's include/linux/elf.h
 */
#define LINUX_AT_UID            11      /* real uid */
#define LINUX_AT_EUID           12      /* effective uid */
#define LINUX_AT_GID            13      /* real gid */
#define LINUX_AT_EGID           14      /* effective gid */
#define LINUX_AT_PLATFORM       15      /* CPU string for optimizations */
#define LINUX_AT_HWCAP          16      /* arch dependent CPU capabilities */
#define LINUX_AT_CLKTCK         17      /* frequency times() increments */
#define LINUX_AT_SECURE         23      /* secure mode boolean */
#define LINUX_AT_RANDOM         25      /* address of 16 random bytes */
#define LINUX_AT_SYSINFO        32      /* pointer to __kernel_vsyscall */
#define LINUX_AT_SYSINFO_EHDR   33      /* pointer to ELF header */

#define LINUX_RANDOM_BYTES      16      /* 16 bytes for AT_RANDOM */

/*
 * Emulation specific sysctls.
 */
#define EMUL_LINUX_KERN                 1

#define EMUL_LINUX_KERN_OSTYPE          1
#define EMUL_LINUX_KERN_OSRELEASE       2
#define EMUL_LINUX_KERN_VERSION         3

#ifdef _KERNEL
__BEGIN_DECLS
extern struct emul emul_linux;

int linux_sysctl(int *, u_int, void *, size_t *, void *, size_t,
    struct lwp *);
void linux_setregs(struct lwp *, struct exec_package *, vaddr_t);
#ifdef EXEC_AOUT
int exec_linux_aout_makecmds(struct lwp *, struct exec_package *);
int linux_aout_copyargs(struct lwp *, struct exec_package *,
    struct ps_strings *, char **, void *);
#endif
void linux_trapsignal(struct lwp *, ksiginfo_t *);
int linux_usertrap(struct lwp *, vaddr_t, void *);
int linux_lwp_setprivate(struct lwp *, void *);

void linux_e_proc_exec(struct proc *, struct exec_package *);
void linux_e_proc_fork(struct proc *, struct lwp *, int);
void linux_e_proc_exit(struct proc *);
void linux_e_lwp_fork(struct lwp *, struct lwp *);
void linux_e_lwp_exit(struct lwp *);

#ifdef EXEC_ELF32
int linux_elf32_probe(struct lwp *, struct exec_package *, void *,
    char *, vaddr_t *);
int linux_elf32_copyargs(struct lwp *, struct exec_package *,
    struct ps_strings *, char **, void *);
int linux_elf32_signature(struct lwp *, struct exec_package *,
        Elf32_Ehdr *, char *);
#ifdef LINUX_GCC_SIGNATURE
int linux_elf32_gcc_signature(struct lwp *l,
        struct exec_package *, Elf32_Ehdr *);
#endif
#ifdef LINUX_DEBUGLINK_SIGNATURE
int linux_elf32_debuglink_signature(struct lwp *l,
        struct exec_package *, Elf32_Ehdr *);
#endif
#ifdef LINUX_ATEXIT_SIGNATURE
int linux_elf32_atexit_signature(struct lwp *l,
        struct exec_package *, Elf32_Ehdr *);
#endif
#ifdef LINUX_GO_RT0_SIGNATURE
int linux_elf32_go_rt0_signature(struct lwp *l,
        struct exec_package *, Elf32_Ehdr *);
#endif
#endif
#ifdef EXEC_ELF64
int linux_elf64_probe(struct lwp *, struct exec_package *, void *,
    char *, vaddr_t *);
int linux_elf64_copyargs(struct lwp *, struct exec_package *,
    struct ps_strings *, char **, void *);
int linux_elf64_signature(struct lwp *, struct exec_package *,
        Elf64_Ehdr *, char *);
#ifdef LINUX_GCC_SIGNATURE
int linux_elf64_gcc_signature(struct lwp *l,
        struct exec_package *, Elf64_Ehdr *);
#endif
#ifdef LINUX_DEBUGLINK_SIGNATURE
int linux_elf64_debuglink_signature(struct lwp *l,
        struct exec_package *, Elf64_Ehdr *);
#endif
#ifdef LINUX_ATEXIT_SIGNATURE
int linux_elf64_atexit_signature(struct lwp *l,
        struct exec_package *, Elf64_Ehdr *);
#endif
#ifdef LINUX_GO_RT0_SIGNATURE
int linux_elf64_go_rt0_signature(struct lwp *l,
        struct exec_package *, Elf64_Ehdr *);
#endif
#endif
__END_DECLS
#endif /* !_KERNEL */

#endif /* !_LINUX_EXEC_H */