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 #ifdef TARGET_ABI32
  15 typedef uint32_t abi_ulong;
  16 typedef int32_t abi_long;
  17 #define TARGET_ABI_FMT_lx "%08x"
  18 #define TARGET_ABI_FMT_ld "%d"
  19 #define TARGET_ABI_FMT_lu "%u"
  20 #define TARGET_ABI_BITS 32
  21 #else
  22 typedef target_ulong abi_ulong;
  23 typedef target_long abi_long;
  24 #define TARGET_ABI_FMT_lx TARGET_FMT_lx
  25 #define TARGET_ABI_FMT_ld TARGET_FMT_ld
  26 #define TARGET_ABI_FMT_lu TARGET_FMT_lu
  27 #define TARGET_ABI_BITS TARGET_LONG_BITS
  28 /* for consistency, define ABI32 too */
  29 #if TARGET_ABI_BITS == 32
  30 #define TARGET_ABI32 1
  31 #endif
  32 #endif
  33
  34 #include "thunk.h"
  35 #include "syscall_defs.h"
  36 #include "syscall.h"
  37 #include "target_signal.h"
  38 #include "gdbstub.h"
  39
  40 #if defined(USE_NPTL)
  41 #define THREAD __thread
  42 #else
  43 #define THREAD
  44 #endif
  45
  46 /* This struct is used to hold certain information about the image.
  47  * Basically, it replicates in user space what would be certain
  48  * task_struct fields in the kernel
  49  */
  50 struct image_info {
  51         abi_ulong       load_addr;
  52         abi_ulong       start_code;
  53         abi_ulong       end_code;
  54         abi_ulong       start_data;
  55         abi_ulong       end_data;
  56         abi_ulong       start_brk;
  57         abi_ulong       brk;
  58         abi_ulong       start_mmap;
  59         abi_ulong       mmap;
  60         abi_ulong       rss;
  61         abi_ulong       start_stack;
  62         abi_ulong       entry;
  63         abi_ulong       code_offset;
  64         abi_ulong       data_offset;
  65         char            **host_argv;
  66         int             personality;
  67 };
  68
  69 #ifdef TARGET_I386
  70 /* Information about the current linux thread */
  71 struct vm86_saved_state {
  72     uint32_t eax; /* return code */
  73     uint32_t ebx;
  74     uint32_t ecx;
  75     uint32_t edx;
  76     uint32_t esi;
  77     uint32_t edi;
  78     uint32_t ebp;
  79     uint32_t esp;
  80     uint32_t eflags;
  81     uint32_t eip;
  82     uint16_t cs, ss, ds, es, fs, gs;
  83 };
  84 #endif
  85
  86 #ifdef TARGET_ARM
  87 /* FPU emulator */
  88 #include "nwfpe/fpa11.h"
  89 #endif
  90
  91 #define MAX_SIGQUEUE_SIZE 1024
  92
  93 struct sigqueue {
  94     struct sigqueue *next;
  95     target_siginfo_t info;
  96 };
  97
  98 struct emulated_sigtable {
  99     int pending; /* true if signal is pending */
 100     struct sigqueue *first;
 101     struct sigqueue info; /* in order to always have memory for the
 102                              first signal, we put it here */
 103 };
 104
 105 /* NOTE: we force a big alignment so that the stack stored after is
 106    aligned too */
 107 typedef struct TaskState {
 108     struct TaskState *next;
 109 #ifdef TARGET_ARM
 110     /* FPA state */
 111     FPA11 fpa;
 112     int swi_errno;
 113 #endif
 114 #if defined(TARGET_I386) && !defined(TARGET_X86_64)
 115     abi_ulong target_v86;
 116     struct vm86_saved_state vm86_saved_regs;
 117     struct target_vm86plus_struct vm86plus;
 118     uint32_t v86flags;
 119     uint32_t v86mask;
 120 #endif
 121 #ifdef TARGET_M68K
 122     int sim_syscalls;
 123 #endif
 124 #if defined(TARGET_ARM) || defined(TARGET_M68K)
 125     /* Extra fields for semihosted binaries.  */
 126     uint32_t stack_base;
 127     uint32_t heap_base;
 128     uint32_t heap_limit;
 129 #endif
 130     int used; /* non zero if used */
 131     struct image_info *info;
 132
 133     struct emulated_sigtable sigtab[TARGET_NSIG];
 134     struct sigqueue sigqueue_table[MAX_SIGQUEUE_SIZE]; /* siginfo queue */
 135     struct sigqueue *first_free; /* first free siginfo queue entry */
 136     int signal_pending; /* non zero if a signal may be pending */
 137
 138     uint8_t stack[0];
 139 } __attribute__((aligned(16))) TaskState;
 140
 141 void init_task_state(TaskState *ts);
 142 extern const char *qemu_uname_release;
 143
 144 /* ??? See if we can avoid exposing so much of the loader internals.  */
 145 /*
 146  * MAX_ARG_PAGES defines the number of pages allocated for arguments
 147  * and envelope for the new program. 32 should suffice, this gives
 148  * a maximum env+arg of 128kB w/4KB pages!
 149  */
 150 #define MAX_ARG_PAGES 32
 151
 152 /*
 153  * This structure is used to hold the arguments that are
 154  * used when loading binaries.
 155  */
 156 struct linux_binprm {
 157         char buf[128];
 158         void *page[MAX_ARG_PAGES];
 159         abi_ulong p;
 160         int fd;
 161         int e_uid, e_gid;
 162         int argc, envc;
 163         char **argv;
 164         char **envp;
 165         char * filename;        /* Name of binary */
 166 };
 167
 168 void do_init_thread(struct target_pt_regs *regs, struct image_info *infop);
 169 abi_ulong loader_build_argptr(int envc, int argc, abi_ulong sp,
 170                               abi_ulong stringp, int push_ptr);
 171 int loader_exec(const char * filename, char ** argv, char ** envp,
 172              struct target_pt_regs * regs, struct image_info *infop);
 173
 174 int load_elf_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
 175                     struct image_info * info);
 176 int load_flt_binary(struct linux_binprm * bprm, struct target_pt_regs * regs,
 177                     struct image_info * info);
 178 #ifdef TARGET_HAS_ELFLOAD32
 179 int load_elf_binary_multi(struct linux_binprm *bprm,
 180                           struct target_pt_regs *regs,
 181                           struct image_info *info);
 182 #endif
 183
 184 abi_long memcpy_to_target(abi_ulong dest, const void *src,
 185                           unsigned long len);
 186 void target_set_brk(abi_ulong new_brk);
 187 abi_long do_brk(abi_ulong new_brk);
 188 void syscall_init(void);
 189 abi_long do_syscall(void *cpu_env, int num, abi_long arg1,
 190                     abi_long arg2, abi_long arg3, abi_long arg4,
 191                     abi_long arg5, abi_long arg6);
 192 void gemu_log(const char *fmt, ...) __attribute__((format(printf,1,2)));
 193 extern THREAD CPUState *thread_env;
 194 void cpu_loop(CPUState *env);
 195 void init_paths(const char *prefix);
 196 const char *path(const char *pathname);
 197 char *target_strerror(int err);
 198 int get_osversion(void);
 199 void fork_start(void);
 200 void fork_end(int child);
 201
 202 extern int loglevel;
 203 extern FILE *logfile;
 204
 205 /* strace.c */
 206 void print_syscall(int num,
 207                    abi_long arg1, abi_long arg2, abi_long arg3,
 208                    abi_long arg4, abi_long arg5, abi_long arg6);
 209 void print_syscall_ret(int num, abi_long arg1);
 210 extern int do_strace;
 211
 212 /* signal.c */
 213 void process_pending_signals(CPUState *cpu_env);
 214 void signal_init(void);
 215 int queue_signal(CPUState *env, int sig, target_siginfo_t *info);
 216 void host_to_target_siginfo(target_siginfo_t *tinfo, const siginfo_t *info);
 217 void target_to_host_siginfo(siginfo_t *info, const target_siginfo_t *tinfo);
 218 int target_to_host_signal(int sig);
 219 long do_sigreturn(CPUState *env);
 220 long do_rt_sigreturn(CPUState *env);
 221 abi_long do_sigaltstack(abi_ulong uss_addr, abi_ulong uoss_addr, abi_ulong sp);
 222
 223 #ifdef TARGET_I386
 224 /* vm86.c */
 225 void save_v86_state(CPUX86State *env);
 226 void handle_vm86_trap(CPUX86State *env, int trapno);
 227 void handle_vm86_fault(CPUX86State *env);
 228 int do_vm86(CPUX86State *env, long subfunction, abi_ulong v86_addr);
 229 #elif defined(TARGET_SPARC64)
 230 void sparc64_set_context(CPUSPARCState *env);
 231 void sparc64_get_context(CPUSPARCState *env);
 232 #endif
 233
 234 /* mmap.c */
 235 int target_mprotect(abi_ulong start, abi_ulong len, int prot);
 236 abi_long target_mmap(abi_ulong start, abi_ulong len, int prot,
 237                      int flags, int fd, abi_ulong offset);
 238 int target_munmap(abi_ulong start, abi_ulong len);
 239 abi_long target_mremap(abi_ulong old_addr, abi_ulong old_size,
 240                        abi_ulong new_size, unsigned long flags,
 241                        abi_ulong new_addr);
 242 int target_msync(abi_ulong start, abi_ulong len, int flags);
 243 extern unsigned long last_brk;
 244 void mmap_lock(void);
 245 void mmap_unlock(void);
 246 #if defined(USE_NPTL)
 247 void mmap_fork_start(void);
 248 void mmap_fork_end(int child);
 249 #endif
 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((typeof(*hptr))(x));\
 275         break;\
 276     case 4:\
 277         *(uint32_t *)(hptr) = tswap32((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(USE_NPTL)
 441 #include <pthread.h>
 442 #endif
 443
 444 #endif /* QEMU_H */