[mirror_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 "qemu-types.h"

#include "thunk.h"
#include "syscall_defs.h"
#include "syscall.h"
#include "target_signal.h"
#include "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       arg_start;
        abi_ulong       arg_end;
	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 stack_base;
    uint32_t heap_base;
    uint32_t heap_limit;
#endif
    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 CPUState *); /* 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);
void gemu_log(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
extern THREAD CPUState *thread_env;
void cpu_loop(CPUState *env);
char *target_strerror(int err);
int get_osversion(void);
void fork_start(void);
void fork_end(int child);

#include "qemu-log.h"

/* 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(CPUState *cpu_env);
void signal_init(void);
int queue_signal(CPUState *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(CPUState *env);
long do_rt_sigreturn(CPUState *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;
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().
 */
#define __put_user(x, hptr)\
({\
    switch(sizeof(*hptr)) {\
    case 1:\
        *(uint8_t *)(hptr) = (uint8_t)(typeof(*hptr))(x);\
        break;\
    case 2:\
        *(uint16_t *)(hptr) = tswap16((uint16_t)(typeof(*hptr))(x));\
        break;\
    case 4:\
        *(uint32_t *)(hptr) = tswap32((uint32_t)(typeof(*hptr))(x));\
        break;\
    case 8:\
        *(uint64_t *)(hptr) = tswap64((typeof(*hptr))(x));\
        break;\
    default:\
        abort();\
    }\
    0;\
})

#define __get_user(x, hptr) \
({\
    switch(sizeof(*hptr)) {\
    case 1:\
        x = (typeof(*hptr))*(uint8_t *)(hptr);\
        break;\
    case 2:\
        x = (typeof(*hptr))tswap16(*(uint16_t *)(hptr));\
        break;\
    case 4:\
        x = (typeof(*hptr))tswap32(*(uint32_t *)(hptr));\
        break;\
    case 8:\
        x = (typeof(*hptr))tswap64(*(uint64_t *)(hptr));\
        break;\
    default:\
        /* avoid warning */\
        x = 0;\
        abort();\
    }\
    0;\
})

/* 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 neccessary.  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

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