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