[mirror_qemu.git] / bsd-user / qemu.h

/*
 *  qemu bsd user mode definition
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, see <http://www.gnu.org/licenses/>.
 */
#ifndef QEMU_H
#define QEMU_H


#include "cpu.h"
#include "exec/cpu_ldst.h"

#undef DEBUG_REMAP
#ifdef DEBUG_REMAP
#endif /* DEBUG_REMAP */

#include "exec/user/abitypes.h"

enum BSDType {
    target_freebsd,
    target_netbsd,
    target_openbsd,
};
extern enum BSDType bsd_type;

#include "syscall_defs.h"
#include "target_syscall.h"
#include "target_signal.h"
#include "exec/gdbstub.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_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 entry;
    abi_ulong code_offset;
    abi_ulong data_offset;
    int       personality;
};

#define MAX_SIGQUEUE_SIZE 1024

struct sigqueue {
    struct sigqueue *next;
};

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

    struct TaskState *next;
    int used; /* non zero if used */
    struct image_info *info;

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

    uint8_t stack[];
} __attribute__((aligned(16))) TaskState;

void init_task_state(TaskState *ts);
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 32

/*
 * This structure is used to hold the arguments that are
 * used when loading binaries.
 */
struct linux_binprm {
        char buf[128];
        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 */
};

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);

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_freebsd_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);
abi_long do_netbsd_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 do_openbsd_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_cpu;
void cpu_loop(CPUArchState *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 */
struct syscallname {
    int nr;
    const char *name;
    const char *format;
    void (*call)(const struct syscallname *,
                 abi_long, abi_long, abi_long,
                 abi_long, abi_long, abi_long);
    void (*result)(const struct syscallname *, abi_long);
};

void
print_freebsd_syscall(int num,
                      abi_long arg1, abi_long arg2, abi_long arg3,
                      abi_long arg4, abi_long arg5, abi_long arg6);
void print_freebsd_syscall_ret(int num, abi_long ret);
void
print_netbsd_syscall(int num,
                     abi_long arg1, abi_long arg2, abi_long arg3,
                     abi_long arg4, abi_long arg5, abi_long arg6);
void print_netbsd_syscall_ret(int num, abi_long ret);
void
print_openbsd_syscall(int num,
                      abi_long arg1, abi_long arg2, abi_long arg3,
                      abi_long arg4, abi_long arg5, abi_long arg6);
void print_openbsd_syscall_ret(int num, abi_long ret);
extern int do_strace;

/* signal.c */
void process_pending_signals(CPUArchState *cpu_env);
void signal_init(void);
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);

/* 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_fork_start(void);
void mmap_fork_end(int child);

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

/* user access */

#define VERIFY_READ  PAGE_READ
#define VERIFY_WRITE (PAGE_READ | PAGE_WRITE)

static inline bool access_ok(int type, abi_ulong addr, abi_ulong size)
{
    return page_check_range((target_ulong)addr, size, type) == 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)\
({\
    int size = sizeof(*hptr);\
    switch (size) {\
    case 1:\
        *(uint8_t *)(hptr) = (uint8_t)(typeof(*hptr))(x);\
        break;\
    case 2:\
        *(uint16_t *)(hptr) = tswap16((typeof(*hptr))(x));\
        break;\
    case 4:\
        *(uint32_t *)(hptr) = tswap32((typeof(*hptr))(x));\
        break;\
    case 8:\
        *(uint64_t *)(hptr) = tswap64((typeof(*hptr))(x));\
        break;\
    default:\
        abort();\
    }\
    0;\
})

#define __get_user(x, hptr) \
({\
    int size = sizeof(*hptr);\
    switch (size) {\
    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 necessary.  The lock_user function
   gets a pointer to a contiguous area of guest memory, but does not perform
   any 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 = g_malloc(len);
        if (copy)
            memcpy(addr, g2h_untagged(guest_addr), len);
        else
            memset(addr, 0, len);
        return addr;
    }
#else
    return g2h_untagged(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_untagged(guest_addr))
        return;
    if (len > 0)
        memcpy(g2h_untagged(guest_addr), host_ptr, len);
    g_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/unlocking 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
88dae46d SB	1	/*
	2	* qemu bsd user mode definition
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License as published by
	6	* the Free Software Foundation; either version 2 of the License, or
	7	* (at your option) any later version.
	8	*
	9	* This program is distributed in the hope that it will be useful,
	10	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public License
	15	* along with this program; if not, see <http://www.gnu.org/licenses/>.
	16	*/
84778508 BS	17	#ifndef QEMU_H
	18	#define QEMU_H
	19
84778508 BS	20
84778508 BS	21	#include "cpu.h"
f08b6170	22	#include "exec/cpu_ldst.h"
84778508 BS	23
	24	#undef DEBUG_REMAP
	25	#ifdef DEBUG_REMAP
84778508 BS	26	#endif /* DEBUG_REMAP */
84778508 BS	27
022c62cb	28	#include "exec/user/abitypes.h"
84778508 BS	29
	30	enum BSDType {
	31	target_freebsd,
	32	target_netbsd,
	33	target_openbsd,
	34	};
78cfb07f	35	extern enum BSDType bsd_type;
84778508 BS	36
84778508 BS	37	#include "syscall_defs.h"
0c6940d0	38	#include "target_syscall.h"
84778508	39	#include "target_signal.h"
022c62cb	40	#include "exec/gdbstub.h"
84778508	41
2f7bb878	42	#if defined(CONFIG_USE_NPTL)
84778508 BS	43	#define THREAD __thread
	44	#else
	45	#define THREAD
	46	#endif
	47
	48	/* This struct is used to hold certain information about the image.
	49	* Basically, it replicates in user space what would be certain
	50	* task_struct fields in the kernel
	51	*/
	52	struct image_info {
	53	abi_ulong load_addr;
	54	abi_ulong start_code;
	55	abi_ulong end_code;
	56	abi_ulong start_data;
	57	abi_ulong end_data;
	58	abi_ulong start_brk;
	59	abi_ulong brk;
	60	abi_ulong start_mmap;
	61	abi_ulong mmap;
	62	abi_ulong rss;
	63	abi_ulong start_stack;
	64	abi_ulong entry;
	65	abi_ulong code_offset;
	66	abi_ulong data_offset;
84778508 BS	67	int personality;
	68	};
	69
	70	#define MAX_SIGQUEUE_SIZE 1024
	71
	72	struct sigqueue {
	73	struct sigqueue *next;
84778508 BS	74	};
	75
	76	struct emulated_sigtable {
	77	int pending; /* true if signal is pending */
	78	struct sigqueue *first;
	79	struct sigqueue info; /* in order to always have memory for the
	80	first signal, we put it here */
	81	};
	82
	83	/* NOTE: we force a big alignment so that the stack stored after is
	84	aligned too */
	85	typedef struct TaskState {
bd88c780 AB	86	pid_t ts_tid; /* tid (or pid) of this task */
bd88c780 AB	87
84778508 BS	88	struct TaskState *next;
	89	int used; /* non zero if used */
	90	struct image_info *info;
	91
	92	struct emulated_sigtable sigtab[TARGET_NSIG];
	93	struct sigqueue sigqueue_table[MAX_SIGQUEUE_SIZE]; /* siginfo queue */
	94	struct sigqueue first_free; / first free siginfo queue entry */
	95	int signal_pending; /* non zero if a signal may be pending */
	96
f7795e40	97	uint8_t stack[];
84778508 BS	98	} __attribute__((aligned(16))) TaskState;
	99
	100	void init_task_state(TaskState *ts);
	101	extern const char *qemu_uname_release;
2fa5d9ba	102	extern unsigned long mmap_min_addr;
84778508 BS	103
	104	/* ??? See if we can avoid exposing so much of the loader internals. */
	105	/*
	106	* MAX_ARG_PAGES defines the number of pages allocated for arguments
	107	* and envelope for the new program. 32 should suffice, this gives
	108	* a maximum env+arg of 128kB w/4KB pages!
	109	*/
	110	#define MAX_ARG_PAGES 32
	111
	112	/*
	113	* This structure is used to hold the arguments that are
	114	* used when loading binaries.
	115	*/
	116	struct linux_binprm {
	117	char buf[128];
	118	void *page[MAX_ARG_PAGES];
	119	abi_ulong p;
	120	int fd;
	121	int e_uid, e_gid;
	122	int argc, envc;
	123	char **argv;
	124	char **envp;
	125	char * filename; /* Name of binary */
	126	};
	127
	128	void do_init_thread(struct target_pt_regs regs, struct image_info infop);
	129	abi_ulong loader_build_argptr(int envc, int argc, abi_ulong sp,
	130	abi_ulong stringp, int push_ptr);
	131	int loader_exec(const char * filename, char argv, char envp,
	132	struct target_pt_regs * regs, struct image_info *infop);
	133
	134	int load_elf_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
	135	struct image_info * info);
	136	int load_flt_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
	137	struct image_info * info);
	138
	139	abi_long memcpy_to_target(abi_ulong dest, const void *src,
	140	unsigned long len);
	141	void target_set_brk(abi_ulong new_brk);
	142	abi_long do_brk(abi_ulong new_brk);
	143	void syscall_init(void);
	144	abi_long do_freebsd_syscall(void *cpu_env, int num, abi_long arg1,
	145	abi_long arg2, abi_long arg3, abi_long arg4,
78cfb07f JL	146	abi_long arg5, abi_long arg6, abi_long arg7,
78cfb07f JL	147	abi_long arg8);
84778508 BS	148	abi_long do_netbsd_syscall(void *cpu_env, int num, abi_long arg1,
	149	abi_long arg2, abi_long arg3, abi_long arg4,
	150	abi_long arg5, abi_long arg6);
	151	abi_long do_openbsd_syscall(void *cpu_env, int num, abi_long arg1,
	152	abi_long arg2, abi_long arg3, abi_long arg4,
	153	abi_long arg5, abi_long arg6);
e5924d89	154	void gemu_log(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
dca1173c	155	extern THREAD CPUState *thread_cpu;
9349b4f9	156	void cpu_loop(CPUArchState *env);
84778508 BS	157	char *target_strerror(int err);
	158	int get_osversion(void);
	159	void fork_start(void);
	160	void fork_end(int child);
	161
1de7afc9	162	#include "qemu/log.h"
84778508 BS	163
84778508 BS	164	/* strace.c */
88dae46d SB	165	struct syscallname {
	166	int nr;
	167	const char *name;
	168	const char *format;
	169	void (call)(const struct syscallname ,
	170	abi_long, abi_long, abi_long,
	171	abi_long, abi_long, abi_long);
	172	void (result)(const struct syscallname , abi_long);
	173	};
	174
84778508 BS	175	void
	176	print_freebsd_syscall(int num,
	177	abi_long arg1, abi_long arg2, abi_long arg3,
	178	abi_long arg4, abi_long arg5, abi_long arg6);
	179	void print_freebsd_syscall_ret(int num, abi_long ret);
	180	void
	181	print_netbsd_syscall(int num,
	182	abi_long arg1, abi_long arg2, abi_long arg3,
	183	abi_long arg4, abi_long arg5, abi_long arg6);
	184	void print_netbsd_syscall_ret(int num, abi_long ret);
	185	void
	186	print_openbsd_syscall(int num,
	187	abi_long arg1, abi_long arg2, abi_long arg3,
	188	abi_long arg4, abi_long arg5, abi_long arg6);
	189	void print_openbsd_syscall_ret(int num, abi_long ret);
	190	extern int do_strace;
	191
	192	/* signal.c */
9349b4f9	193	void process_pending_signals(CPUArchState *cpu_env);
84778508	194	void signal_init(void);
9349b4f9 AF	195	long do_sigreturn(CPUArchState *env);
9349b4f9 AF	196	long do_rt_sigreturn(CPUArchState *env);
84778508 BS	197	abi_long do_sigaltstack(abi_ulong uss_addr, abi_ulong uoss_addr, abi_ulong sp);
	198
	199	/* mmap.c */
	200	int target_mprotect(abi_ulong start, abi_ulong len, int prot);
	201	abi_long target_mmap(abi_ulong start, abi_ulong len, int prot,
	202	int flags, int fd, abi_ulong offset);
	203	int target_munmap(abi_ulong start, abi_ulong len);
	204	abi_long target_mremap(abi_ulong old_addr, abi_ulong old_size,
	205	abi_ulong new_size, unsigned long flags,
	206	abi_ulong new_addr);
	207	int target_msync(abi_ulong start, abi_ulong len, int flags);
	208	extern unsigned long last_brk;
84778508 BS	209	void mmap_fork_start(void);
84778508 BS	210	void mmap_fork_end(int child);
84778508	211
28e738dc BS	212	/* main.c */
	213	extern unsigned long x86_stack_size;
	214
84778508 BS	215	/* user access */
84778508 BS	216
1720751f RH	217	#define VERIFY_READ PAGE_READ
1720751f RH	218	#define VERIFY_WRITE (PAGE_READ \| PAGE_WRITE)
84778508	219
1720751f	220	static inline bool access_ok(int type, abi_ulong addr, abi_ulong size)
84778508	221	{
1720751f	222	return page_check_range((target_ulong)addr, size, type) == 0;
84778508 BS	223	}
	224
	225	/* NOTE __get_user and __put_user use host pointers and don't check access. */
	226	/* These are usually used to access struct data members once the
	227	* struct has been locked - usually with lock_user_struct().
	228	*/
	229	#define __put_user(x, hptr)\
	230	({\
	231	int size = sizeof(*hptr);\
cefbade1	232	switch (size) {\
84778508 BS	233	case 1:\
	234	(uint8_t )(hptr) = (uint8_t)(typeof(*hptr))(x);\
	235	break;\
	236	case 2:\
	237	(uint16_t )(hptr) = tswap16((typeof(*hptr))(x));\
	238	break;\
	239	case 4:\
	240	(uint32_t )(hptr) = tswap32((typeof(*hptr))(x));\
	241	break;\
	242	case 8:\
	243	(uint64_t )(hptr) = tswap64((typeof(*hptr))(x));\
	244	break;\
	245	default:\
	246	abort();\
	247	}\
	248	0;\
	249	})
	250
	251	#define __get_user(x, hptr) \
	252	({\
	253	int size = sizeof(*hptr);\
cefbade1	254	switch (size) {\
84778508 BS	255	case 1:\
	256	x = (typeof(hptr))(uint8_t *)(hptr);\
	257	break;\
	258	case 2:\
	259	x = (typeof(hptr))tswap16((uint16_t *)(hptr));\
	260	break;\
	261	case 4:\
	262	x = (typeof(hptr))tswap32((uint32_t *)(hptr));\
	263	break;\
	264	case 8:\
	265	x = (typeof(hptr))tswap64((uint64_t *)(hptr));\
	266	break;\
	267	default:\
	268	/* avoid warning */\
	269	x = 0;\
	270	abort();\
	271	}\
	272	0;\
	273	})
	274
	275	/* put_user()/get_user() take a guest address and check access */
	276	/* These are usually used to access an atomic data type, such as an int,
	277	* that has been passed by address. These internally perform locking
	278	* and unlocking on the data type.
	279	*/
	280	#define put_user(x, gaddr, target_type) \
	281	({ \
	282	abi_ulong __gaddr = (gaddr); \
	283	target_type *__hptr; \
	284	abi_long __ret; \
	285	if ((__hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0))) { \
	286	__ret = __put_user((x), __hptr); \
	287	unlock_user(__hptr, __gaddr, sizeof(target_type)); \
	288	} else \
	289	__ret = -TARGET_EFAULT; \
	290	__ret; \
	291	})
	292
	293	#define get_user(x, gaddr, target_type) \
	294	({ \
	295	abi_ulong __gaddr = (gaddr); \
	296	target_type *__hptr; \
	297	abi_long __ret; \
	298	if ((__hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1))) { \
	299	__ret = __get_user((x), __hptr); \
	300	unlock_user(__hptr, __gaddr, 0); \
	301	} else { \
	302	/* avoid warning */ \
	303	(x) = 0; \
	304	__ret = -TARGET_EFAULT; \
	305	} \
	306	__ret; \
	307	})
	308
	309	#define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong)
	310	#define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long)
	311	#define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t)
	312	#define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t)
	313	#define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t)
	314	#define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t)
	315	#define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t)
	316	#define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t)
	317	#define put_user_u8(x, gaddr) put_user((x), (gaddr), uint8_t)
	318	#define put_user_s8(x, gaddr) put_user((x), (gaddr), int8_t)
319
320	#define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong)
321	#define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long)
322	#define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t)
323	#define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t)
324	#define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t)
325	#define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t)
326	#define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t)
327	#define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t)
328	#define get_user_u8(x, gaddr) get_user((x), (gaddr), uint8_t)
329	#define get_user_s8(x, gaddr) get_user((x), (gaddr), int8_t)
330
331	/* copy_from_user() and copy_to_user() are usually used to copy data
332	* buffers between the target and host. These internally perform
333	* locking/unlocking of the memory.
334	*/
335	abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
336	abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
337
338	/* Functions for accessing guest memory. The tget and tput functions
6f20f55b	339	read/write single values, byteswapping as necessary. The lock_user function
84778508	340	gets a pointer to a contiguous area of guest memory, but does not perform
6f20f55b	341	any byteswapping. lock_user may return either a pointer to the guest
84778508 BS	342	memory, or a temporary buffer. */
	343
	344	/* Lock an area of guest memory into the host. If copy is true then the
	345	host area will have the same contents as the guest. */
	346	static inline void *lock_user(int type, abi_ulong guest_addr, long len, int copy)
	347	{
	348	if (!access_ok(type, guest_addr, len))
	349	return NULL;
	350	#ifdef DEBUG_REMAP
	351	{
	352	void *addr;
fd9a3048	353	addr = g_malloc(len);
84778508	354	if (copy)
3e8f1628	355	memcpy(addr, g2h_untagged(guest_addr), len);
84778508 BS	356	else
	357	memset(addr, 0, len);
	358	return addr;
	359	}
	360	#else
3e8f1628	361	return g2h_untagged(guest_addr);
84778508 BS	362	#endif
	363	}
	364
	365	/* Unlock an area of guest memory. The first LEN bytes must be
	366	flushed back to guest memory. host_ptr = NULL is explicitly
	367	allowed and does nothing. */
	368	static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
	369	long len)
	370	{
	371
	372	#ifdef DEBUG_REMAP
	373	if (!host_ptr)
	374	return;
3e8f1628	375	if (host_ptr == g2h_untagged(guest_addr))
84778508 BS	376	return;
84778508 BS	377	if (len > 0)
3e8f1628	378	memcpy(g2h_untagged(guest_addr), host_ptr, len);
fd9a3048	379	g_free(host_ptr);
84778508 BS	380	#endif
	381	}
	382
	383	/* Return the length of a string in target memory or -TARGET_EFAULT if
	384	access error. */
	385	abi_long target_strlen(abi_ulong gaddr);
	386
	387	/* Like lock_user but for null terminated strings. */
	388	static inline void *lock_user_string(abi_ulong guest_addr)
	389	{
	390	abi_long len;
	391	len = target_strlen(guest_addr);
	392	if (len < 0)
	393	return NULL;
	394	return lock_user(VERIFY_READ, guest_addr, (long)(len + 1), 1);
	395	}
	396
41d1af4d	397	/* Helper macros for locking/unlocking a target struct. */
84778508 BS	398	#define lock_user_struct(type, host_ptr, guest_addr, copy) \
	399	(host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
	400	#define unlock_user_struct(host_ptr, guest_addr, copy) \
	401	unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
	402
2f7bb878	403	#if defined(CONFIG_USE_NPTL)
84778508 BS	404	#include <pthread.h>
	405	#endif
	406
	407	#endif /* QEMU_H */