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

#ifndef QEMU_H
#define QEMU_H

#include "thunk.h"

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

#include "cpu.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 {
	target_ulong	load_addr;
	target_ulong	start_code;
	target_ulong	end_code;
        target_ulong    start_data;
	target_ulong	end_data;
	target_ulong	start_brk;
	target_ulong	brk;
	target_ulong	start_mmap;
	target_ulong	mmap;
	target_ulong	rss;
	target_ulong	start_stack;
	target_ulong	entry;
        target_ulong    code_offset;
        target_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)
    target_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];
        target_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);
target_ulong loader_build_argptr(int envc, int argc, target_ulong sp,
                                 target_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);

void memcpy_to_target(target_ulong dest, const void *src,
                      unsigned long len);
void target_set_brk(target_ulong new_brk);
target_long do_brk(target_ulong new_brk);
void syscall_init(void);
target_long do_syscall(void *cpu_env, int num, target_long arg1,
                       target_long arg2, target_long arg3, target_long arg4,
                       target_long arg5, target_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);

extern int loglevel;
extern FILE *logfile;

/* 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);
int do_sigaltstack(const struct target_sigaltstack *uss,
                   struct target_sigaltstack *uoss,
                   target_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, target_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(target_ulong start, target_ulong len, int prot);
target_long target_mmap(target_ulong start, target_ulong len, int prot,
                 int flags, int fd, target_ulong offset);
int target_munmap(target_ulong start, target_ulong len);
target_long target_mremap(target_ulong old_addr, target_ulong old_size,
                   target_ulong new_size, unsigned long flags,
                   target_ulong new_addr);
int target_msync(target_ulong start, target_ulong len, int flags);

/* user access */

#define VERIFY_READ 0
#define VERIFY_WRITE 1

#define access_ok(type,addr,size) (1)

/* NOTE get_user and put_user use host addresses.  */
#define __put_user(x,ptr)\
({\
    int size = sizeof(*ptr);\
    switch(size) {\
    case 1:\
        *(uint8_t *)(ptr) = (typeof(*ptr))(x);\
        break;\
    case 2:\
        *(uint16_t *)(ptr) = tswap16((typeof(*ptr))(x));\
        break;\
    case 4:\
        *(uint32_t *)(ptr) = tswap32((typeof(*ptr))(x));\
        break;\
    case 8:\
        *(uint64_t *)(ptr) = tswap64((typeof(*ptr))(x));\
        break;\
    default:\
        abort();\
    }\
    0;\
})

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

#define put_user(x,ptr)\
({\
    int __ret;\
    if (access_ok(VERIFY_WRITE, ptr, sizeof(*ptr)))\
        __ret = __put_user(x, ptr);\
    else\
        __ret = -EFAULT;\
    __ret;\
})

#define get_user(x,ptr)\
({\
    int __ret;\
    if (access_ok(VERIFY_READ, ptr, sizeof(*ptr)))\
        __ret = __get_user(x, ptr);\
    else\
        __ret = -EFAULT;\
    __ret;\
})

/* 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(target_ulong guest_addr, long len, int copy)
{
#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.  */
static inline void unlock_user(void *host_addr, target_ulong guest_addr,
                                long len)
{
#ifdef DEBUG_REMAP
    if (host_addr == g2h(guest_addr))
        return;
    if (len > 0)
        memcpy(g2h(guest_addr), host_addr, len);
    free(host_addr);
#endif
}

/* Return the length of a string in target memory.  */
static inline int target_strlen(target_ulong ptr)
{
  return strlen(g2h(ptr));
}

/* Like lock_user but for null terminated strings.  */
static inline void *lock_user_string(target_ulong guest_addr)
{
    long len;
    len = target_strlen(guest_addr) + 1;
    return lock_user(guest_addr, len, 1);
}

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