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