[qemu.git] / bsd-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"

enum BSDType {
    target_freebsd,
    target_netbsd,
    target_openbsd,
};

#include "syscall_defs.h"
#include "syscall.h"
#include "target_signal.h"
#include "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;
    char      **host_argv;
    int       personality;
};

#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 {
    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[0];
} __attribute__((aligned(16))) TaskState;

void init_task_state(TaskState *ts);
extern const char *qemu_uname_release;

/* ??? 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 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, ...) __attribute__((format(printf,1,2)));
extern THREAD CPUState *thread_env;
void cpu_loop(CPUState *env, enum BSDType bsd_type);
void init_paths(const char *prefix);
const char *path(const char *pathname);
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_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(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);
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);

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

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