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