[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_BITS 32
#else
typedef target_ulong abi_ulong;
typedef target_long abi_long;
#define TARGET_ABI_BITS TARGET_LONG_BITS
#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

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

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,
                   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

#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(abi_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, abi_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(abi_ulong ptr)
{
  return strlen(g2h(ptr));
}

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