[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 "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 {
	unsigned long	start_code;
	unsigned long	end_code;
        unsigned long   start_data;
	unsigned long	end_data;
	unsigned long	start_brk;
	unsigned long	brk;
	unsigned long	start_mmap;
	unsigned long	mmap;
	unsigned long	rss;
	unsigned long	start_stack;
	unsigned long	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];
        unsigned long 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);
long do_brk(target_ulong new_brk);
void syscall_init(void);
long do_syscall(void *cpu_env, int num, long arg1, long arg2, long arg3, 
                long arg4, long arg5, 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);

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

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