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