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

#ifndef QEMU_H
#define QEMU_H

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

#include "cpu.h"

#ifdef TARGET_ABI32
typedef uint32_t abi_ulong;
typedef int32_t abi_long;
#define TARGET_ABI_FMT_lx "%08x"
#define TARGET_ABI_FMT_ld "%d"
#define TARGET_ABI_FMT_lu "%u"
#define TARGET_ABI_BITS 32
#else
typedef target_ulong abi_ulong;
typedef target_long abi_long;
#define TARGET_ABI_FMT_lx TARGET_FMT_lx
#define TARGET_ABI_FMT_ld TARGET_FMT_ld
#define TARGET_ABI_FMT_lu TARGET_FMT_lu
#define TARGET_ABI_BITS TARGET_LONG_BITS
/* for consistency, define ABI32 too */
#if TARGET_ABI_BITS == 32
#define TARGET_ABI32 1
#endif
#endif

#include "thunk.h"
#include "syscall_defs.h"
#include "syscall.h"
#include "target_signal.h"
#include "gdbstub.h"

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

#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

/* NOTE: we force a big alignment so that the stack stored after is
   aligned too */
typedef struct TaskState {
    struct TaskState *next;
#ifdef TARGET_ARM
    /* FPA state */
    FPA11 fpa;
    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 TARGET_M68K
    int sim_syscalls;
#endif
#if defined(TARGET_ARM) || defined(TARGET_M68K)
    /* 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;
    uint8_t stack[0];
} __attribute__((aligned(16))) TaskState;

extern TaskState *first_task_state;
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);
#ifdef TARGET_HAS_ELFLOAD32
int load_elf_binary_multi(struct linux_binprm *bprm,
                          struct target_pt_regs *regs,
                          struct image_info *info);
#endif

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, ...) __attribute__((format(printf,1,2)));
extern CPUState *global_env;
void cpu_loop(CPUState *env);
void init_paths(const char *prefix);
const char *path(const char *pathname);
char *target_strerror(int err);

extern int loglevel;
extern FILE *logfile;

/* 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(void *cpu_env);
void signal_init(void);
int queue_signal(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);

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

/* 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) = (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:\
        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								\
        __ret = -TARGET_EFAULT;						\
    __ret;								\
})

/* 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 explicitely
   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_ptr), 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)

#define tget8(addr) ldub(addr)
#define tput8(addr, val) stb(addr, val)
#define tget16(addr) lduw(addr)
#define tput16(addr, val) stw(addr, val)
#define tget32(addr) ldl(addr)
#define tput32(addr, val) stl(addr, val)
#define tget64(addr) ldq(addr)
#define tput64(addr, val) stq(addr, val)
#if TARGET_ABI_BITS == 64
#define tgetl(addr) ldq(addr)
#define tputl(addr, val) stq(addr, val)
#else
#define tgetl(addr) ldl(addr)
#define tputl(addr, val) stl(addr, val)
#endif

#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 BS	8
	9	#ifdef TARGET_ABI32
	10	typedef uint32_t abi_ulong;
	11	typedef int32_t abi_long;
f3e3285d TS	12	#define TARGET_ABI_FMT_lx "%08x"
	13	#define TARGET_ABI_FMT_ld "%d"
	14	#define TARGET_ABI_FMT_lu "%u"
992f48a0 BS	15	#define TARGET_ABI_BITS 32
	16	#else
	17	typedef target_ulong abi_ulong;
	18	typedef target_long abi_long;
f3e3285d TS	19	#define TARGET_ABI_FMT_lx TARGET_FMT_lx
	20	#define TARGET_ABI_FMT_ld TARGET_FMT_ld
	21	#define TARGET_ABI_FMT_lu TARGET_FMT_lu
992f48a0	22	#define TARGET_ABI_BITS TARGET_LONG_BITS
4683b130 FB	23	/* for consistency, define ABI32 too */
	24	#if TARGET_ABI_BITS == 32
	25	#define TARGET_ABI32 1
	26	#endif
992f48a0 BS	27	#endif
	28
	29	#include "thunk.h"
	30	#include "syscall_defs.h"
6180a181	31	#include "syscall.h"
a04e134a	32	#include "target_signal.h"
1fddef4b	33	#include "gdbstub.h"
66fb9763	34
31e31b8a FB	35	/* This struct is used to hold certain information about the image.
	36	* Basically, it replicates in user space what would be certain
	37	* task_struct fields in the kernel
	38	*/
	39	struct image_info {
992f48a0 BS	40	abi_ulong load_addr;
	41	abi_ulong start_code;
	42	abi_ulong end_code;
	43	abi_ulong start_data;
	44	abi_ulong end_data;
	45	abi_ulong start_brk;
	46	abi_ulong brk;
	47	abi_ulong start_mmap;
	48	abi_ulong mmap;
	49	abi_ulong rss;
	50	abi_ulong start_stack;
	51	abi_ulong entry;
	52	abi_ulong code_offset;
	53	abi_ulong data_offset;
38d0662a	54	char **host_argv;
31e31b8a FB	55	int personality;
	56	};
	57
b346ff46	58	#ifdef TARGET_I386
851e67a1 FB	59	/* Information about the current linux thread */
	60	struct vm86_saved_state {
	61	uint32_t eax; /* return code */
	62	uint32_t ebx;
	63	uint32_t ecx;
	64	uint32_t edx;
	65	uint32_t esi;
	66	uint32_t edi;
	67	uint32_t ebp;
	68	uint32_t esp;
	69	uint32_t eflags;
	70	uint32_t eip;
	71	uint16_t cs, ss, ds, es, fs, gs;
	72	};
b346ff46	73	#endif
851e67a1	74
28c4f361 FB	75	#ifdef TARGET_ARM
	76	/* FPU emulator */
	77	#include "nwfpe/fpa11.h"
28c4f361 FB	78	#endif
28c4f361 FB	79
851e67a1 FB	80	/* NOTE: we force a big alignment so that the stack stored after is
	81	aligned too */
	82	typedef struct TaskState {
	83	struct TaskState *next;
28c4f361 FB	84	#ifdef TARGET_ARM
	85	/* FPA state */
	86	FPA11 fpa;
a4f81979	87	int swi_errno;
28c4f361	88	#endif
84409ddb	89	#if defined(TARGET_I386) && !defined(TARGET_X86_64)
992f48a0	90	abi_ulong target_v86;
851e67a1	91	struct vm86_saved_state vm86_saved_regs;
b333af06	92	struct target_vm86plus_struct vm86plus;
631271d7 FB	93	uint32_t v86flags;
631271d7 FB	94	uint32_t v86mask;
e6e5906b PB	95	#endif
	96	#ifdef TARGET_M68K
	97	int sim_syscalls;
a87295e8 PB	98	#endif
	99	#if defined(TARGET_ARM) \|\| defined(TARGET_M68K)
	100	/* Extra fields for semihosted binaries. */
	101	uint32_t stack_base;
	102	uint32_t heap_base;
	103	uint32_t heap_limit;
b346ff46	104	#endif
851e67a1	105	int used; /* non zero if used */
978efd6a	106	struct image_info *info;
851e67a1 FB	107	uint8_t stack[0];
	108	} __attribute__((aligned(16))) TaskState;
	109
	110	extern TaskState *first_task_state;
c5937220	111	extern const char *qemu_uname_release;
851e67a1	112
e5fe0c52 PB	113	/* ??? See if we can avoid exposing so much of the loader internals. */
	114	/*
	115	* MAX_ARG_PAGES defines the number of pages allocated for arguments
	116	* and envelope for the new program. 32 should suffice, this gives
	117	* a maximum env+arg of 128kB w/4KB pages!
	118	*/
	119	#define MAX_ARG_PAGES 32
	120
	121	/*
5fafdf24	122	* This structure is used to hold the arguments that are
e5fe0c52 PB	123	* used when loading binaries.
	124	*/
	125	struct linux_binprm {
	126	char buf[128];
	127	void *page[MAX_ARG_PAGES];
992f48a0	128	abi_ulong p;
e5fe0c52 PB	129	int fd;
	130	int e_uid, e_gid;
	131	int argc, envc;
	132	char **argv;
	133	char **envp;
	134	char * filename; /* Name of binary */
	135	};
	136
	137	void do_init_thread(struct target_pt_regs regs, struct image_info infop);
992f48a0 BS	138	abi_ulong loader_build_argptr(int envc, int argc, abi_ulong sp,
992f48a0 BS	139	abi_ulong stringp, int push_ptr);
5fafdf24	140	int loader_exec(const char * filename, char argv, char envp,
01ffc75b	141	struct target_pt_regs * regs, struct image_info *infop);
31e31b8a	142
e5fe0c52 PB	143	int load_elf_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
	144	struct image_info * info);
	145	int load_flt_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
	146	struct image_info * info);
cb33da57 BS	147	#ifdef TARGET_HAS_ELFLOAD32
	148	int load_elf_binary_multi(struct linux_binprm *bprm,
	149	struct target_pt_regs *regs,
	150	struct image_info *info);
	151	#endif
e5fe0c52	152
579a97f7 FB	153	abi_long memcpy_to_target(abi_ulong dest, const void *src,
579a97f7 FB	154	unsigned long len);
992f48a0 BS	155	void target_set_brk(abi_ulong new_brk);
992f48a0 BS	156	abi_long do_brk(abi_ulong new_brk);
31e31b8a	157	void syscall_init(void);
992f48a0 BS	158	abi_long do_syscall(void *cpu_env, int num, abi_long arg1,
	159	abi_long arg2, abi_long arg3, abi_long arg4,
	160	abi_long arg5, abi_long arg6);
31e31b8a	161	void gemu_log(const char *fmt, ...) __attribute__((format(printf,1,2)));
b346ff46 FB	162	extern CPUState *global_env;
b346ff46 FB	163	void cpu_loop(CPUState *env);
32ce6337 FB	164	void init_paths(const char *prefix);
32ce6337 FB	165	const char path(const char pathname);
b92c47c1	166	char *target_strerror(int err);
6977fbfd FB	167
6977fbfd FB	168	extern int loglevel;
631271d7 FB	169	extern FILE *logfile;
631271d7 FB	170
b92c47c1 TS	171	/* strace.c */
b92c47c1 TS	172	void print_syscall(int num,
c16f9ed3 FB	173	abi_long arg1, abi_long arg2, abi_long arg3,
	174	abi_long arg4, abi_long arg5, abi_long arg6);
	175	void print_syscall_ret(int num, abi_long arg1);
b92c47c1 TS	176	extern int do_strace;
b92c47c1 TS	177
b346ff46 FB	178	/* signal.c */
	179	void process_pending_signals(void *cpu_env);
	180	void signal_init(void);
	181	int queue_signal(int sig, target_siginfo_t *info);
	182	void host_to_target_siginfo(target_siginfo_t tinfo, const siginfo_t info);
	183	void target_to_host_siginfo(siginfo_t info, const target_siginfo_t tinfo);
	184	long do_sigreturn(CPUState *env);
	185	long do_rt_sigreturn(CPUState *env);
579a97f7	186	abi_long do_sigaltstack(abi_ulong uss_addr, abi_ulong uoss_addr, abi_ulong sp);
b346ff46 FB	187
b346ff46 FB	188	#ifdef TARGET_I386
631271d7 FB	189	/* vm86.c */
631271d7 FB	190	void save_v86_state(CPUX86State *env);
447db213	191	void handle_vm86_trap(CPUX86State *env, int trapno);
631271d7	192	void handle_vm86_fault(CPUX86State *env);
992f48a0	193	int do_vm86(CPUX86State *env, long subfunction, abi_ulong v86_addr);
5bfb56b2 BS	194	#elif defined(TARGET_SPARC64)
	195	void sparc64_set_context(CPUSPARCState *env);
	196	void sparc64_get_context(CPUSPARCState *env);
b346ff46	197	#endif
631271d7	198
54936004	199	/* mmap.c */
992f48a0 BS	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);
54936004	208
edf779ff FB	209	/* user access */
	210
	211	#define VERIFY_READ 0
579a97f7	212	#define VERIFY_WRITE 1 /* implies read access */
edf779ff	213
dae3270c FB	214	static inline int access_ok(int type, abi_ulong addr, abi_ulong size)
	215	{
	216	return page_check_range((target_ulong)addr, size,
	217	(type == VERIFY_READ) ? PAGE_READ : (PAGE_READ \| PAGE_WRITE)) == 0;
	218	}
edf779ff	219
89343ecd	220	/* NOTE __get_user and __put_user use host pointers and don't check access. */
579a97f7 FB	221	/* These are usually used to access struct data members once the
	222	* struct has been locked - usually with lock_user_struct().
	223	*/
89343ecd	224	#define __put_user(x, hptr)\
edf779ff	225	({\
89343ecd	226	int size = sizeof(*hptr);\
edf779ff FB	227	switch(size) {\
edf779ff FB	228	case 1:\
89343ecd	229	(uint8_t )(hptr) = (typeof(*hptr))(x);\
edf779ff FB	230	break;\
edf779ff FB	231	case 2:\
89343ecd	232	(uint16_t )(hptr) = tswap16((typeof(*hptr))(x));\
edf779ff FB	233	break;\
edf779ff FB	234	case 4:\
89343ecd	235	(uint32_t )(hptr) = tswap32((typeof(*hptr))(x));\
edf779ff FB	236	break;\
edf779ff FB	237	case 8:\
89343ecd	238	(uint64_t )(hptr) = tswap64((typeof(*hptr))(x));\
edf779ff FB	239	break;\
	240	default:\
	241	abort();\
	242	}\
	243	0;\
	244	})
	245
89343ecd	246	#define __get_user(x, hptr) \
edf779ff	247	({\
89343ecd	248	int size = sizeof(*hptr);\
edf779ff FB	249	switch(size) {\
edf779ff FB	250	case 1:\
89343ecd	251	x = (typeof(hptr))(uint8_t *)(hptr);\
edf779ff FB	252	break;\
edf779ff FB	253	case 2:\
89343ecd	254	x = (typeof(hptr))tswap16((uint16_t *)(hptr));\
edf779ff FB	255	break;\
edf779ff FB	256	case 4:\
89343ecd	257	x = (typeof(hptr))tswap32((uint32_t *)(hptr));\
edf779ff FB	258	break;\
edf779ff FB	259	case 8:\
89343ecd	260	x = (typeof(hptr))tswap64((uint64_t *)(hptr));\
edf779ff FB	261	break;\
	262	default:\
	263	abort();\
	264	}\
	265	0;\
	266	})
	267
579a97f7 FB	268	/* put_user()/get_user() take a guest address and check access */
	269	/* These are usually used to access an atomic data type, such as an int,
	270	* that has been passed by address. These internally perform locking
	271	* and unlocking on the data type.
	272	*/
	273	#define put_user(x, gaddr, target_type) \
	274	({ \
	275	abi_ulong __gaddr = (gaddr); \
	276	target_type *__hptr; \
	277	abi_long __ret; \
	278	if ((__hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0))) { \
	279	__ret = __put_user((x), __hptr); \
	280	unlock_user(__hptr, __gaddr, sizeof(target_type)); \
	281	} else \
	282	__ret = -TARGET_EFAULT; \
	283	__ret; \
edf779ff FB	284	})
edf779ff FB	285
579a97f7 FB	286	#define get_user(x, gaddr, target_type) \
	287	({ \
	288	abi_ulong __gaddr = (gaddr); \
	289	target_type *__hptr; \
	290	abi_long __ret; \
	291	if ((__hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1))) { \
	292	__ret = __get_user((x), __hptr); \
	293	unlock_user(__hptr, __gaddr, 0); \
	294	} else \
	295	__ret = -TARGET_EFAULT; \
	296	__ret; \
edf779ff FB	297	})
edf779ff FB	298
579a97f7 FB	299	/* copy_from_user() and copy_to_user() are usually used to copy data
	300	* buffers between the target and host. These internally perform
	301	* locking/unlocking of the memory.
	302	*/
	303	abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
	304	abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
	305
53a5960a PB	306	/* Functions for accessing guest memory. The tget and tput functions
	307	read/write single values, byteswapping as neccessary. The lock_user
	308	gets a pointer to a contiguous area of guest memory, but does not perform
	309	and byteswapping. lock_user may return either a pointer to the guest
	310	memory, or a temporary buffer. */
	311
	312	/* Lock an area of guest memory into the host. If copy is true then the
	313	host area will have the same contents as the guest. */
579a97f7	314	static inline void *lock_user(int type, abi_ulong guest_addr, long len, int copy)
edf779ff	315	{
579a97f7 FB	316	if (!access_ok(type, guest_addr, len))
579a97f7 FB	317	return NULL;
53a5960a	318	#ifdef DEBUG_REMAP
579a97f7 FB	319	{
	320	void *addr;
	321	addr = malloc(len);
	322	if (copy)
	323	memcpy(addr, g2h(guest_addr), len);
	324	else
	325	memset(addr, 0, len);
	326	return addr;
	327	}
53a5960a PB	328	#else
	329	return g2h(guest_addr);
	330	#endif
edf779ff FB	331	}
edf779ff FB	332
579a97f7 FB	333	/* Unlock an area of guest memory. The first LEN bytes must be
	334	flushed back to guest memory. host_ptr = NULL is explicitely
	335	allowed and does nothing. */
	336	static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
992f48a0	337	long len)
edf779ff	338	{
579a97f7	339
53a5960a	340	#ifdef DEBUG_REMAP
579a97f7 FB	341	if (!host_ptr)
	342	return;
	343	if (host_ptr == g2h(guest_addr))
53a5960a PB	344	return;
53a5960a PB	345	if (len > 0)
579a97f7 FB	346	memcpy(g2h(guest_ptr), host_ptr, len);
579a97f7 FB	347	free(host_ptr);
53a5960a	348	#endif
edf779ff FB	349	}
edf779ff FB	350
579a97f7 FB	351	/* Return the length of a string in target memory or -TARGET_EFAULT if
	352	access error. */
	353	abi_long target_strlen(abi_ulong gaddr);
53a5960a PB	354
53a5960a PB	355	/* Like lock_user but for null terminated strings. */
992f48a0	356	static inline void *lock_user_string(abi_ulong guest_addr)
53a5960a	357	{
579a97f7 FB	358	abi_long len;
	359	len = target_strlen(guest_addr);
	360	if (len < 0)
	361	return NULL;
	362	return lock_user(VERIFY_READ, guest_addr, (long)(len + 1), 1);
edf779ff FB	363	}
edf779ff FB	364
53a5960a	365	/* Helper macros for locking/ulocking a target struct. */
579a97f7 FB	366	#define lock_user_struct(type, host_ptr, guest_addr, copy) \
	367	(host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
	368	#define unlock_user_struct(host_ptr, guest_addr, copy) \
53a5960a PB	369	unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
	370
	371	#define tget8(addr) ldub(addr)
	372	#define tput8(addr, val) stb(addr, val)
	373	#define tget16(addr) lduw(addr)
	374	#define tput16(addr, val) stw(addr, val)
	375	#define tget32(addr) ldl(addr)
	376	#define tput32(addr, val) stl(addr, val)
	377	#define tget64(addr) ldq(addr)
	378	#define tput64(addr, val) stq(addr, val)
992f48a0	379	#if TARGET_ABI_BITS == 64
53a5960a PB	380	#define tgetl(addr) ldq(addr)
	381	#define tputl(addr, val) stq(addr, val)
	382	#else
	383	#define tgetl(addr) ldl(addr)
	384	#define tputl(addr, val) stl(addr, val)
	385	#endif
	386
e88de099	387	#endif /* QEMU_H */