[qemu.git] / linux-user / qemu.h

#ifndef QEMU_H
#define QEMU_H

#include <signal.h>
#include <string.h>

#include "cpu.h"

#undef DEBUG_REMAP
#ifdef DEBUG_REMAP
#include <stdlib.h>
#endif /* DEBUG_REMAP */

#include "exec/user/abitypes.h"

#include "exec/user/thunk.h"
#include "syscall_defs.h"
#include "syscall.h"
#include "exec/gdbstub.h"
#include "qemu/queue.h"

#if defined(CONFIG_USE_NPTL)
#define THREAD __thread
#else
#define THREAD
#endif

/* This struct is used to hold certain information about the image.
 * Basically, it replicates in user space what would be certain
 * task_struct fields in the kernel
 */
struct image_info {
        abi_ulong       load_bias;
        abi_ulong       load_addr;
        abi_ulong       start_code;
        abi_ulong       end_code;
        abi_ulong       start_data;
        abi_ulong       end_data;
        abi_ulong       start_brk;
        abi_ulong       brk;
        abi_ulong       start_mmap;
        abi_ulong       mmap;
        abi_ulong       rss;
        abi_ulong       start_stack;
        abi_ulong       stack_limit;
        abi_ulong       entry;
        abi_ulong       code_offset;
        abi_ulong       data_offset;
        abi_ulong       saved_auxv;
        abi_ulong       auxv_len;
        abi_ulong       arg_start;
        abi_ulong       arg_end;
        uint32_t        elf_flags;
	int		personality;
#ifdef CONFIG_USE_FDPIC
        abi_ulong       loadmap_addr;
        uint16_t        nsegs;
        void           *loadsegs;
        abi_ulong       pt_dynamic_addr;
        struct image_info *other_info;
#endif
};

#ifdef TARGET_I386
/* Information about the current linux thread */
struct vm86_saved_state {
    uint32_t eax; /* return code */
    uint32_t ebx;
    uint32_t ecx;
    uint32_t edx;
    uint32_t esi;
    uint32_t edi;
    uint32_t ebp;
    uint32_t esp;
    uint32_t eflags;
    uint32_t eip;
    uint16_t cs, ss, ds, es, fs, gs;
};
#endif

#ifdef TARGET_ARM
/* FPU emulator */
#include "nwfpe/fpa11.h"
#endif

#define MAX_SIGQUEUE_SIZE 1024

struct sigqueue {
    struct sigqueue *next;
    target_siginfo_t info;
};

struct emulated_sigtable {
    int pending; /* true if signal is pending */
    struct sigqueue *first;
    struct sigqueue info; /* in order to always have memory for the
                             first signal, we put it here */
};

/* NOTE: we force a big alignment so that the stack stored after is
   aligned too */
typedef struct TaskState {
    pid_t ts_tid;     /* tid (or pid) of this task */
#ifdef TARGET_ARM
    /* FPA state */
    FPA11 fpa;
    int swi_errno;
#endif
#ifdef TARGET_UNICORE32
    int swi_errno;
#endif
#if defined(TARGET_I386) && !defined(TARGET_X86_64)
    abi_ulong target_v86;
    struct vm86_saved_state vm86_saved_regs;
    struct target_vm86plus_struct vm86plus;
    uint32_t v86flags;
    uint32_t v86mask;
#endif
#ifdef CONFIG_USE_NPTL
    abi_ulong child_tidptr;
#endif
#ifdef TARGET_M68K
    int sim_syscalls;
#endif
#if defined(TARGET_ARM) || defined(TARGET_M68K) || defined(TARGET_UNICORE32)
    /* Extra fields for semihosted binaries.  */
    uint32_t heap_base;
    uint32_t heap_limit;
#endif
    uint32_t stack_base;
    int used; /* non zero if used */
    struct image_info *info;
    struct linux_binprm *bprm;

    struct emulated_sigtable sigtab[TARGET_NSIG];
    struct sigqueue sigqueue_table[MAX_SIGQUEUE_SIZE]; /* siginfo queue */
    struct sigqueue *first_free; /* first free siginfo queue entry */
    int signal_pending; /* non zero if a signal may be pending */
} __attribute__((aligned(16))) TaskState;

extern char *exec_path;
void init_task_state(TaskState *ts);
void task_settid(TaskState *);
void stop_all_tasks(void);
extern const char *qemu_uname_release;
extern unsigned long mmap_min_addr;

/* ??? See if we can avoid exposing so much of the loader internals.  */
/*
 * MAX_ARG_PAGES defines the number of pages allocated for arguments
 * and envelope for the new program. 32 should suffice, this gives
 * a maximum env+arg of 128kB w/4KB pages!
 */
#define MAX_ARG_PAGES 33

/* Read a good amount of data initially, to hopefully get all the
   program headers loaded.  */
#define BPRM_BUF_SIZE  1024

/*
 * This structure is used to hold the arguments that are
 * used when loading binaries.
 */
struct linux_binprm {
        char buf[BPRM_BUF_SIZE] __attribute__((aligned));
        void *page[MAX_ARG_PAGES];
        abi_ulong p;
	int fd;
        int e_uid, e_gid;
        int argc, envc;
        char **argv;
        char **envp;
        char * filename;        /* Name of binary */
        int (*core_dump)(int, const CPUArchState *); /* coredump routine */
};

void do_init_thread(struct target_pt_regs *regs, struct image_info *infop);
abi_ulong loader_build_argptr(int envc, int argc, abi_ulong sp,
                              abi_ulong stringp, int push_ptr);
int loader_exec(const char * filename, char ** argv, char ** envp,
             struct target_pt_regs * regs, struct image_info *infop,
             struct linux_binprm *);

int load_elf_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
                    struct image_info * info);
int load_flt_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
                    struct image_info * info);

abi_long memcpy_to_target(abi_ulong dest, const void *src,
                          unsigned long len);
void target_set_brk(abi_ulong new_brk);
abi_long do_brk(abi_ulong new_brk);
void syscall_init(void);
abi_long do_syscall(void *cpu_env, int num, abi_long arg1,
                    abi_long arg2, abi_long arg3, abi_long arg4,
                    abi_long arg5, abi_long arg6, abi_long arg7,
                    abi_long arg8);
void gemu_log(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
extern THREAD CPUState *thread_cpu;
void cpu_loop(CPUArchState *env);
char *target_strerror(int err);
int get_osversion(void);
void fork_start(void);
void fork_end(int child);

/* Creates the initial guest address space in the host memory space using
 * the given host start address hint and size.  The guest_start parameter
 * specifies the start address of the guest space.  guest_base will be the
 * difference between the host start address computed by this function and
 * guest_start.  If fixed is specified, then the mapped address space must
 * start at host_start.  The real start address of the mapped memory space is
 * returned or -1 if there was an error.
 */
unsigned long init_guest_space(unsigned long host_start,
                               unsigned long host_size,
                               unsigned long guest_start,
                               bool fixed);

#include "qemu/log.h"

/* syscall.c */
int host_to_target_waitstatus(int status);

/* strace.c */
void print_syscall(int num,
                   abi_long arg1, abi_long arg2, abi_long arg3,
                   abi_long arg4, abi_long arg5, abi_long arg6);
void print_syscall_ret(int num, abi_long arg1);
extern int do_strace;

/* signal.c */
void process_pending_signals(CPUArchState *cpu_env);
void signal_init(void);
int queue_signal(CPUArchState *env, int sig, target_siginfo_t *info);
void host_to_target_siginfo(target_siginfo_t *tinfo, const siginfo_t *info);
void target_to_host_siginfo(siginfo_t *info, const target_siginfo_t *tinfo);
int target_to_host_signal(int sig);
int host_to_target_signal(int sig);
long do_sigreturn(CPUArchState *env);
long do_rt_sigreturn(CPUArchState *env);
abi_long do_sigaltstack(abi_ulong uss_addr, abi_ulong uoss_addr, abi_ulong sp);

#ifdef TARGET_I386
/* vm86.c */
void save_v86_state(CPUX86State *env);
void handle_vm86_trap(CPUX86State *env, int trapno);
void handle_vm86_fault(CPUX86State *env);
int do_vm86(CPUX86State *env, long subfunction, abi_ulong v86_addr);
#elif defined(TARGET_SPARC64)
void sparc64_set_context(CPUSPARCState *env);
void sparc64_get_context(CPUSPARCState *env);
#endif

/* mmap.c */
int target_mprotect(abi_ulong start, abi_ulong len, int prot);
abi_long target_mmap(abi_ulong start, abi_ulong len, int prot,
                     int flags, int fd, abi_ulong offset);
int target_munmap(abi_ulong start, abi_ulong len);
abi_long target_mremap(abi_ulong old_addr, abi_ulong old_size,
                       abi_ulong new_size, unsigned long flags,
                       abi_ulong new_addr);
int target_msync(abi_ulong start, abi_ulong len, int flags);
extern unsigned long last_brk;
extern abi_ulong mmap_next_start;
void mmap_lock(void);
void mmap_unlock(void);
abi_ulong mmap_find_vma(abi_ulong, abi_ulong);
void cpu_list_lock(void);
void cpu_list_unlock(void);
#if defined(CONFIG_USE_NPTL)
void mmap_fork_start(void);
void mmap_fork_end(int child);
#endif

/* main.c */
extern unsigned long guest_stack_size;

/* user access */

#define VERIFY_READ 0
#define VERIFY_WRITE 1 /* implies read access */

static inline int access_ok(int type, abi_ulong addr, abi_ulong size)
{
    return page_check_range((target_ulong)addr, size,
                            (type == VERIFY_READ) ? PAGE_READ : (PAGE_READ | PAGE_WRITE)) == 0;
}

/* NOTE __get_user and __put_user use host pointers and don't check access.
   These are usually used to access struct data members once the struct has
   been locked - usually with lock_user_struct.  */

/* Tricky points:
   - Use __builtin_choose_expr to avoid type promotion from ?:,
   - Invalid sizes result in a compile time error stemming from
     the fact that abort has no parameters.
   - It's easier to use the endian-specific unaligned load/store
     functions than host-endian unaligned load/store plus tswapN.  */

#define __put_user_e(x, hptr, e)                                        \
  (__builtin_choose_expr(sizeof(*(hptr)) == 1, stb_p,                   \
   __builtin_choose_expr(sizeof(*(hptr)) == 2, stw_##e##_p,             \
   __builtin_choose_expr(sizeof(*(hptr)) == 4, stl_##e##_p,             \
   __builtin_choose_expr(sizeof(*(hptr)) == 8, stq_##e##_p, abort))))   \
     ((hptr), (x)), 0)

#define __get_user_e(x, hptr, e)                                        \
  ((x) = (typeof(*hptr))(                                               \
   __builtin_choose_expr(sizeof(*(hptr)) == 1, ldub_p,                  \
   __builtin_choose_expr(sizeof(*(hptr)) == 2, lduw_##e##_p,            \
   __builtin_choose_expr(sizeof(*(hptr)) == 4, ldl_##e##_p,             \
   __builtin_choose_expr(sizeof(*(hptr)) == 8, ldq_##e##_p, abort))))   \
     (hptr)), 0)

#ifdef TARGET_WORDS_BIGENDIAN
# define __put_user(x, hptr)  __put_user_e(x, hptr, be)
# define __get_user(x, hptr)  __get_user_e(x, hptr, be)
#else
# define __put_user(x, hptr)  __put_user_e(x, hptr, le)
# define __get_user(x, hptr)  __get_user_e(x, hptr, le)
#endif

/* put_user()/get_user() take a guest address and check access */
/* These are usually used to access an atomic data type, such as an int,
 * that has been passed by address.  These internally perform locking
 * and unlocking on the data type.
 */
#define put_user(x, gaddr, target_type)					\
({									\
    abi_ulong __gaddr = (gaddr);					\
    target_type *__hptr;						\
    abi_long __ret;							\
    if ((__hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0))) { \
        __ret = __put_user((x), __hptr);				\
        unlock_user(__hptr, __gaddr, sizeof(target_type));		\
    } else								\
        __ret = -TARGET_EFAULT;						\
    __ret;								\
})

#define get_user(x, gaddr, target_type)					\
({									\
    abi_ulong __gaddr = (gaddr);					\
    target_type *__hptr;						\
    abi_long __ret;							\
    if ((__hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1))) { \
        __ret = __get_user((x), __hptr);				\
        unlock_user(__hptr, __gaddr, 0);				\
    } else {								\
        /* avoid warning */						\
        (x) = 0;							\
        __ret = -TARGET_EFAULT;						\
    }									\
    __ret;								\
})

#define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong)
#define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long)
#define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t)
#define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t)
#define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t)
#define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t)
#define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t)
#define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t)
#define put_user_u8(x, gaddr)  put_user((x), (gaddr), uint8_t)
#define put_user_s8(x, gaddr)  put_user((x), (gaddr), int8_t)

#define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong)
#define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long)
#define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t)
#define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t)
#define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t)
#define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t)
#define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t)
#define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t)
#define get_user_u8(x, gaddr)  get_user((x), (gaddr), uint8_t)
#define get_user_s8(x, gaddr)  get_user((x), (gaddr), int8_t)

/* copy_from_user() and copy_to_user() are usually used to copy data
 * buffers between the target and host.  These internally perform
 * locking/unlocking of the memory.
 */
abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);

/* Functions for accessing guest memory.  The tget and tput functions
   read/write single values, byteswapping as necessary.  The lock_user
   gets a pointer to a contiguous area of guest memory, but does not perform
   and byteswapping.  lock_user may return either a pointer to the guest
   memory, or a temporary buffer.  */

/* Lock an area of guest memory into the host.  If copy is true then the
   host area will have the same contents as the guest.  */
static inline void *lock_user(int type, abi_ulong guest_addr, long len, int copy)
{
    if (!access_ok(type, guest_addr, len))
        return NULL;
#ifdef DEBUG_REMAP
    {
        void *addr;
        addr = malloc(len);
        if (copy)
            memcpy(addr, g2h(guest_addr), len);
        else
            memset(addr, 0, len);
        return addr;
    }
#else
    return g2h(guest_addr);
#endif
}

/* Unlock an area of guest memory.  The first LEN bytes must be
   flushed back to guest memory. host_ptr = NULL is explicitly
   allowed and does nothing. */
static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
                               long len)
{

#ifdef DEBUG_REMAP
    if (!host_ptr)
        return;
    if (host_ptr == g2h(guest_addr))
        return;
    if (len > 0)
        memcpy(g2h(guest_addr), host_ptr, len);
    free(host_ptr);
#endif
}

/* Return the length of a string in target memory or -TARGET_EFAULT if
   access error. */
abi_long target_strlen(abi_ulong gaddr);

/* Like lock_user but for null terminated strings.  */
static inline void *lock_user_string(abi_ulong guest_addr)
{
    abi_long len;
    len = target_strlen(guest_addr);
    if (len < 0)
        return NULL;
    return lock_user(VERIFY_READ, guest_addr, (long)(len + 1), 1);
}

/* Helper macros for locking/ulocking a target struct.  */
#define lock_user_struct(type, host_ptr, guest_addr, copy)	\
    (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
#define unlock_user_struct(host_ptr, guest_addr, copy)		\
    unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)

#if defined(CONFIG_USE_NPTL)
#include <pthread.h>
#endif

/* Include target-specific struct and function definitions;
 * they may need access to the target-independent structures
 * above, so include them last.
 */
#include "target_cpu.h"
#include "target_signal.h"

#endif /* QEMU_H */
Commit	Line	Data
e88de099 FB	1	#ifndef QEMU_H
e88de099 FB	2	#define QEMU_H
31e31b8a	3
9de5e440	4	#include <signal.h>
edf779ff	5	#include <string.h>
31e31b8a	6
6180a181	7	#include "cpu.h"
992f48a0	8
06177d36 AZ	9	#undef DEBUG_REMAP
	10	#ifdef DEBUG_REMAP
	11	#include <stdlib.h>
	12	#endif /* DEBUG_REMAP */
	13
022c62cb	14	#include "exec/user/abitypes.h"
992f48a0	15
022c62cb	16	#include "exec/user/thunk.h"
992f48a0	17	#include "syscall_defs.h"
6180a181	18	#include "syscall.h"
022c62cb	19	#include "exec/gdbstub.h"
1de7afc9	20	#include "qemu/queue.h"
66fb9763	21
2f7bb878	22	#if defined(CONFIG_USE_NPTL)
d5975363 PB	23	#define THREAD __thread
	24	#else
	25	#define THREAD
	26	#endif
	27
31e31b8a FB	28	/* This struct is used to hold certain information about the image.
	29	* Basically, it replicates in user space what would be certain
	30	* task_struct fields in the kernel
	31	*/
	32	struct image_info {
9955ffac	33	abi_ulong load_bias;
992f48a0 BS	34	abi_ulong load_addr;
	35	abi_ulong start_code;
	36	abi_ulong end_code;
	37	abi_ulong start_data;
	38	abi_ulong end_data;
	39	abi_ulong start_brk;
	40	abi_ulong brk;
	41	abi_ulong start_mmap;
	42	abi_ulong mmap;
	43	abi_ulong rss;
	44	abi_ulong start_stack;
97374d38	45	abi_ulong stack_limit;
992f48a0 BS	46	abi_ulong entry;
	47	abi_ulong code_offset;
	48	abi_ulong data_offset;
edf8e2af	49	abi_ulong saved_auxv;
125b0f55	50	abi_ulong auxv_len;
edf8e2af MW	51	abi_ulong arg_start;
edf8e2af MW	52	abi_ulong arg_end;
d8fd2954	53	uint32_t elf_flags;
31e31b8a	54	int personality;
1af02e83 MF	55	#ifdef CONFIG_USE_FDPIC
	56	abi_ulong loadmap_addr;
	57	uint16_t nsegs;
	58	void *loadsegs;
	59	abi_ulong pt_dynamic_addr;
	60	struct image_info *other_info;
	61	#endif
31e31b8a FB	62	};
31e31b8a FB	63
b346ff46	64	#ifdef TARGET_I386
851e67a1 FB	65	/* Information about the current linux thread */
	66	struct vm86_saved_state {
	67	uint32_t eax; /* return code */
	68	uint32_t ebx;
	69	uint32_t ecx;
	70	uint32_t edx;
	71	uint32_t esi;
	72	uint32_t edi;
	73	uint32_t ebp;
	74	uint32_t esp;
	75	uint32_t eflags;
	76	uint32_t eip;
	77	uint16_t cs, ss, ds, es, fs, gs;
	78	};
b346ff46	79	#endif
851e67a1	80
28c4f361 FB	81	#ifdef TARGET_ARM
	82	/* FPU emulator */
	83	#include "nwfpe/fpa11.h"
28c4f361 FB	84	#endif
28c4f361 FB	85
624f7979 PB	86	#define MAX_SIGQUEUE_SIZE 1024
	87
	88	struct sigqueue {
	89	struct sigqueue *next;
c227f099	90	target_siginfo_t info;
624f7979 PB	91	};
	92
	93	struct emulated_sigtable {
	94	int pending; /* true if signal is pending */
	95	struct sigqueue *first;
	96	struct sigqueue info; /* in order to always have memory for the
	97	first signal, we put it here */
	98	};
	99
851e67a1 FB	100	/* NOTE: we force a big alignment so that the stack stored after is
	101	aligned too */
	102	typedef struct TaskState {
edf8e2af	103	pid_t ts_tid; /* tid (or pid) of this task */
28c4f361 FB	104	#ifdef TARGET_ARM
	105	/* FPA state */
	106	FPA11 fpa;
a4f81979	107	int swi_errno;
28c4f361	108	#endif
d2fbca94 GX	109	#ifdef TARGET_UNICORE32
	110	int swi_errno;
	111	#endif
84409ddb	112	#if defined(TARGET_I386) && !defined(TARGET_X86_64)
992f48a0	113	abi_ulong target_v86;
851e67a1	114	struct vm86_saved_state vm86_saved_regs;
b333af06	115	struct target_vm86plus_struct vm86plus;
631271d7 FB	116	uint32_t v86flags;
631271d7 FB	117	uint32_t v86mask;
e6e5906b	118	#endif
2f7bb878	119	#ifdef CONFIG_USE_NPTL
c2764719 PB	120	abi_ulong child_tidptr;
c2764719 PB	121	#endif
e6e5906b PB	122	#ifdef TARGET_M68K
e6e5906b PB	123	int sim_syscalls;
a87295e8	124	#endif
d2fbca94	125	#if defined(TARGET_ARM) \|\| defined(TARGET_M68K) \|\| defined(TARGET_UNICORE32)
a87295e8	126	/* Extra fields for semihosted binaries. */
a87295e8 PB	127	uint32_t heap_base;
a87295e8 PB	128	uint32_t heap_limit;
b346ff46	129	#endif
d0fd11ff	130	uint32_t stack_base;
851e67a1	131	int used; /* non zero if used */
978efd6a	132	struct image_info *info;
edf8e2af	133	struct linux_binprm *bprm;
624f7979 PB	134
	135	struct emulated_sigtable sigtab[TARGET_NSIG];
	136	struct sigqueue sigqueue_table[MAX_SIGQUEUE_SIZE]; /* siginfo queue */
	137	struct sigqueue first_free; / first free siginfo queue entry */
	138	int signal_pending; /* non zero if a signal may be pending */
851e67a1 FB	139	} __attribute__((aligned(16))) TaskState;
851e67a1 FB	140
d088d664	141	extern char *exec_path;
624f7979	142	void init_task_state(TaskState *ts);
edf8e2af MW	143	void task_settid(TaskState *);
edf8e2af MW	144	void stop_all_tasks(void);
c5937220	145	extern const char *qemu_uname_release;
379f6698	146	extern unsigned long mmap_min_addr;
851e67a1	147
e5fe0c52 PB	148	/* ??? See if we can avoid exposing so much of the loader internals. */
	149	/*
	150	* MAX_ARG_PAGES defines the number of pages allocated for arguments
	151	* and envelope for the new program. 32 should suffice, this gives
	152	* a maximum env+arg of 128kB w/4KB pages!
	153	*/
fd4d81dd	154	#define MAX_ARG_PAGES 33
e5fe0c52	155
9955ffac RH	156	/* Read a good amount of data initially, to hopefully get all the
	157	program headers loaded. */
	158	#define BPRM_BUF_SIZE 1024
	159
e5fe0c52	160	/*
5fafdf24	161	* This structure is used to hold the arguments that are
e5fe0c52 PB	162	* used when loading binaries.
	163	*/
	164	struct linux_binprm {
9955ffac	165	char buf[BPRM_BUF_SIZE] __attribute__((aligned));
e5fe0c52	166	void *page[MAX_ARG_PAGES];
992f48a0	167	abi_ulong p;
e5fe0c52 PB	168	int fd;
	169	int e_uid, e_gid;
	170	int argc, envc;
	171	char **argv;
	172	char **envp;
	173	char * filename; /* Name of binary */
9349b4f9	174	int (core_dump)(int, const CPUArchState ); /* coredump routine */
e5fe0c52 PB	175	};
	176
	177	void do_init_thread(struct target_pt_regs regs, struct image_info infop);
992f48a0 BS	178	abi_ulong loader_build_argptr(int envc, int argc, abi_ulong sp,
992f48a0 BS	179	abi_ulong stringp, int push_ptr);
5fafdf24	180	int loader_exec(const char * filename, char argv, char envp,
edf8e2af MW	181	struct target_pt_regs * regs, struct image_info *infop,
edf8e2af MW	182	struct linux_binprm *);
31e31b8a	183
e5fe0c52 PB	184	int load_elf_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
	185	struct image_info * info);
	186	int load_flt_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
	187	struct image_info * info);
	188
579a97f7 FB	189	abi_long memcpy_to_target(abi_ulong dest, const void *src,
579a97f7 FB	190	unsigned long len);
992f48a0 BS	191	void target_set_brk(abi_ulong new_brk);
992f48a0 BS	192	abi_long do_brk(abi_ulong new_brk);
31e31b8a	193	void syscall_init(void);
992f48a0 BS	194	abi_long do_syscall(void *cpu_env, int num, abi_long arg1,
992f48a0 BS	195	abi_long arg2, abi_long arg3, abi_long arg4,
5945cfcb PM	196	abi_long arg5, abi_long arg6, abi_long arg7,
5945cfcb PM	197	abi_long arg8);
e5924d89	198	void gemu_log(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
a2247f8e	199	extern THREAD CPUState *thread_cpu;
9349b4f9	200	void cpu_loop(CPUArchState *env);
b92c47c1	201	char *target_strerror(int err);
a745ec6d	202	int get_osversion(void);
d5975363 PB	203	void fork_start(void);
d5975363 PB	204	void fork_end(int child);
6977fbfd	205
dce10401 MI	206	/* Creates the initial guest address space in the host memory space using
	207	* the given host start address hint and size. The guest_start parameter
	208	* specifies the start address of the guest space. guest_base will be the
	209	* difference between the host start address computed by this function and
	210	* guest_start. If fixed is specified, then the mapped address space must
	211	* start at host_start. The real start address of the mapped memory space is
	212	* returned or -1 if there was an error.
	213	*/
	214	unsigned long init_guest_space(unsigned long host_start,
	215	unsigned long host_size,
	216	unsigned long guest_start,
	217	bool fixed);
	218
1de7afc9	219	#include "qemu/log.h"
631271d7	220
a05c6409 RH	221	/* syscall.c */
	222	int host_to_target_waitstatus(int status);
	223
b92c47c1 TS	224	/* strace.c */
b92c47c1 TS	225	void print_syscall(int num,
c16f9ed3 FB	226	abi_long arg1, abi_long arg2, abi_long arg3,
	227	abi_long arg4, abi_long arg5, abi_long arg6);
	228	void print_syscall_ret(int num, abi_long arg1);
b92c47c1 TS	229	extern int do_strace;
b92c47c1 TS	230
b346ff46	231	/* signal.c */
9349b4f9	232	void process_pending_signals(CPUArchState *cpu_env);
b346ff46	233	void signal_init(void);
9349b4f9	234	int queue_signal(CPUArchState env, int sig, target_siginfo_t info);
c227f099 AL	235	void host_to_target_siginfo(target_siginfo_t tinfo, const siginfo_t info);
c227f099 AL	236	void target_to_host_siginfo(siginfo_t info, const target_siginfo_t tinfo);
4cb05961	237	int target_to_host_signal(int sig);
1d9d8b55	238	int host_to_target_signal(int sig);
9349b4f9 AF	239	long do_sigreturn(CPUArchState *env);
9349b4f9 AF	240	long do_rt_sigreturn(CPUArchState *env);
579a97f7	241	abi_long do_sigaltstack(abi_ulong uss_addr, abi_ulong uoss_addr, abi_ulong sp);
b346ff46 FB	242
b346ff46 FB	243	#ifdef TARGET_I386
631271d7 FB	244	/* vm86.c */
631271d7 FB	245	void save_v86_state(CPUX86State *env);
447db213	246	void handle_vm86_trap(CPUX86State *env, int trapno);
631271d7	247	void handle_vm86_fault(CPUX86State *env);
992f48a0	248	int do_vm86(CPUX86State *env, long subfunction, abi_ulong v86_addr);
5bfb56b2 BS	249	#elif defined(TARGET_SPARC64)
	250	void sparc64_set_context(CPUSPARCState *env);
	251	void sparc64_get_context(CPUSPARCState *env);
b346ff46	252	#endif
631271d7	253
54936004	254	/* mmap.c */
992f48a0 BS	255	int target_mprotect(abi_ulong start, abi_ulong len, int prot);
	256	abi_long target_mmap(abi_ulong start, abi_ulong len, int prot,
	257	int flags, int fd, abi_ulong offset);
	258	int target_munmap(abi_ulong start, abi_ulong len);
	259	abi_long target_mremap(abi_ulong old_addr, abi_ulong old_size,
	260	abi_ulong new_size, unsigned long flags,
	261	abi_ulong new_addr);
	262	int target_msync(abi_ulong start, abi_ulong len, int flags);
0776590d	263	extern unsigned long last_brk;
59e9d91c	264	extern abi_ulong mmap_next_start;
c8a706fe PB	265	void mmap_lock(void);
c8a706fe PB	266	void mmap_unlock(void);
9ad197d9	267	abi_ulong mmap_find_vma(abi_ulong, abi_ulong);
c2764719 PB	268	void cpu_list_lock(void);
c2764719 PB	269	void cpu_list_unlock(void);
2f7bb878	270	#if defined(CONFIG_USE_NPTL)
d5975363 PB	271	void mmap_fork_start(void);
	272	void mmap_fork_end(int child);
	273	#endif
54936004	274
440c7e85	275	/* main.c */
703e0e89	276	extern unsigned long guest_stack_size;
440c7e85	277
edf779ff FB	278	/* user access */
	279
	280	#define VERIFY_READ 0
579a97f7	281	#define VERIFY_WRITE 1 /* implies read access */
edf779ff	282
dae3270c FB	283	static inline int access_ok(int type, abi_ulong addr, abi_ulong size)
	284	{
	285	return page_check_range((target_ulong)addr, size,
	286	(type == VERIFY_READ) ? PAGE_READ : (PAGE_READ \| PAGE_WRITE)) == 0;
	287	}
edf779ff	288
658f2dc9 RH	289	/* NOTE __get_user and __put_user use host pointers and don't check access.
	290	These are usually used to access struct data members once the struct has
	291	been locked - usually with lock_user_struct. */
	292
	293	/* Tricky points:
	294	- Use __builtin_choose_expr to avoid type promotion from ?:,
	295	- Invalid sizes result in a compile time error stemming from
	296	the fact that abort has no parameters.
	297	- It's easier to use the endian-specific unaligned load/store
	298	functions than host-endian unaligned load/store plus tswapN. */
	299
	300	#define __put_user_e(x, hptr, e) \
	301	(__builtin_choose_expr(sizeof(*(hptr)) == 1, stb_p, \
	302	__builtin_choose_expr(sizeof(*(hptr)) == 2, stw_##e##_p, \
	303	__builtin_choose_expr(sizeof(*(hptr)) == 4, stl_##e##_p, \
	304	__builtin_choose_expr(sizeof(*(hptr)) == 8, stq_##e##_p, abort)))) \
	305	((hptr), (x)), 0)
	306
	307	#define __get_user_e(x, hptr, e) \
0bc8ce94	308	((x) = (typeof(*hptr))( \
658f2dc9 RH	309	__builtin_choose_expr(sizeof(*(hptr)) == 1, ldub_p, \
	310	__builtin_choose_expr(sizeof(*(hptr)) == 2, lduw_##e##_p, \
	311	__builtin_choose_expr(sizeof(*(hptr)) == 4, ldl_##e##_p, \
	312	__builtin_choose_expr(sizeof(*(hptr)) == 8, ldq_##e##_p, abort)))) \
0bc8ce94	313	(hptr)), 0)
658f2dc9 RH	314
	315	#ifdef TARGET_WORDS_BIGENDIAN
	316	# define __put_user(x, hptr) __put_user_e(x, hptr, be)
	317	# define __get_user(x, hptr) __get_user_e(x, hptr, be)
	318	#else
	319	# define __put_user(x, hptr) __put_user_e(x, hptr, le)
	320	# define __get_user(x, hptr) __get_user_e(x, hptr, le)
	321	#endif
edf779ff	322
579a97f7 FB	323	/* put_user()/get_user() take a guest address and check access */
	324	/* These are usually used to access an atomic data type, such as an int,
	325	* that has been passed by address. These internally perform locking
	326	* and unlocking on the data type.
	327	*/
	328	#define put_user(x, gaddr, target_type) \
	329	({ \
	330	abi_ulong __gaddr = (gaddr); \
	331	target_type *__hptr; \
	332	abi_long __ret; \
	333	if ((__hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0))) { \
	334	__ret = __put_user((x), __hptr); \
	335	unlock_user(__hptr, __gaddr, sizeof(target_type)); \
	336	} else \
	337	__ret = -TARGET_EFAULT; \
	338	__ret; \
edf779ff FB	339	})
edf779ff FB	340
579a97f7 FB	341	#define get_user(x, gaddr, target_type) \
	342	({ \
	343	abi_ulong __gaddr = (gaddr); \
	344	target_type *__hptr; \
	345	abi_long __ret; \
	346	if ((__hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1))) { \
	347	__ret = __get_user((x), __hptr); \
	348	unlock_user(__hptr, __gaddr, 0); \
2f619698 FB	349	} else { \
	350	/* avoid warning */ \
	351	(x) = 0; \
579a97f7	352	__ret = -TARGET_EFAULT; \
2f619698	353	} \
579a97f7	354	__ret; \
edf779ff FB	355	})
edf779ff FB	356
2f619698 FB	357	#define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong)
	358	#define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long)
	359	#define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t)
	360	#define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t)
	361	#define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t)
	362	#define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t)
	363	#define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t)
	364	#define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t)
	365	#define put_user_u8(x, gaddr) put_user((x), (gaddr), uint8_t)
	366	#define put_user_s8(x, gaddr) put_user((x), (gaddr), int8_t)
	367
	368	#define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong)
	369	#define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long)
	370	#define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t)
	371	#define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t)
	372	#define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t)
	373	#define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t)
	374	#define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t)
	375	#define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t)
	376	#define get_user_u8(x, gaddr) get_user((x), (gaddr), uint8_t)
	377	#define get_user_s8(x, gaddr) get_user((x), (gaddr), int8_t)
	378
579a97f7 FB	379	/* copy_from_user() and copy_to_user() are usually used to copy data
	380	* buffers between the target and host. These internally perform
	381	* locking/unlocking of the memory.
	382	*/
	383	abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
	384	abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
	385
53a5960a	386	/* Functions for accessing guest memory. The tget and tput functions
1301f322	387	read/write single values, byteswapping as necessary. The lock_user
53a5960a PB	388	gets a pointer to a contiguous area of guest memory, but does not perform
	389	and byteswapping. lock_user may return either a pointer to the guest
	390	memory, or a temporary buffer. */
	391
	392	/* Lock an area of guest memory into the host. If copy is true then the
	393	host area will have the same contents as the guest. */
579a97f7	394	static inline void *lock_user(int type, abi_ulong guest_addr, long len, int copy)
edf779ff	395	{
579a97f7 FB	396	if (!access_ok(type, guest_addr, len))
579a97f7 FB	397	return NULL;
53a5960a	398	#ifdef DEBUG_REMAP
579a97f7 FB	399	{
	400	void *addr;
	401	addr = malloc(len);
	402	if (copy)
	403	memcpy(addr, g2h(guest_addr), len);
	404	else
	405	memset(addr, 0, len);
	406	return addr;
	407	}
53a5960a PB	408	#else
	409	return g2h(guest_addr);
	410	#endif
edf779ff FB	411	}
edf779ff FB	412
579a97f7	413	/* Unlock an area of guest memory. The first LEN bytes must be
1235fc06	414	flushed back to guest memory. host_ptr = NULL is explicitly
579a97f7 FB	415	allowed and does nothing. */
579a97f7 FB	416	static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
992f48a0	417	long len)
edf779ff	418	{
579a97f7	419
53a5960a	420	#ifdef DEBUG_REMAP
579a97f7 FB	421	if (!host_ptr)
	422	return;
	423	if (host_ptr == g2h(guest_addr))
53a5960a PB	424	return;
53a5960a PB	425	if (len > 0)
06177d36	426	memcpy(g2h(guest_addr), host_ptr, len);
579a97f7	427	free(host_ptr);
53a5960a	428	#endif
edf779ff FB	429	}
edf779ff FB	430
579a97f7 FB	431	/* Return the length of a string in target memory or -TARGET_EFAULT if
	432	access error. */
	433	abi_long target_strlen(abi_ulong gaddr);
53a5960a PB	434
53a5960a PB	435	/* Like lock_user but for null terminated strings. */
992f48a0	436	static inline void *lock_user_string(abi_ulong guest_addr)
53a5960a	437	{
579a97f7 FB	438	abi_long len;
	439	len = target_strlen(guest_addr);
	440	if (len < 0)
	441	return NULL;
	442	return lock_user(VERIFY_READ, guest_addr, (long)(len + 1), 1);
edf779ff FB	443	}
edf779ff FB	444
53a5960a	445	/* Helper macros for locking/ulocking a target struct. */
579a97f7 FB	446	#define lock_user_struct(type, host_ptr, guest_addr, copy) \
	447	(host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
	448	#define unlock_user_struct(host_ptr, guest_addr, copy) \
53a5960a PB	449	unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
53a5960a PB	450
2f7bb878	451	#if defined(CONFIG_USE_NPTL)
c8a706fe PB	452	#include <pthread.h>
	453	#endif
	454
dfeab06c PM	455	/* Include target-specific struct and function definitions;
	456	* they may need access to the target-independent structures
	457	* above, so include them last.
	458	*/
	459	#include "target_cpu.h"
	460	#include "target_signal.h"
	461
e88de099	462	#endif /* QEMU_H */