bsd-user/qemu.h

   1 /*
   2  *  qemu bsd user mode definition
   3  *
   4  *  This program is free software; you can redistribute it and/or modify
   5  *  it under the terms of the GNU General Public License as published by
   6  *  the Free Software Foundation; either version 2 of the License, or
   7  *  (at your option) any later version.
   8  *
   9  *  This program is distributed in the hope that it will be useful,
  10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  *  GNU General Public License for more details.
  13  *
  14  *  You should have received a copy of the GNU General Public License
  15  *  along with this program; if not, see <http://www.gnu.org/licenses/>.
  16  */
  17 #ifndef QEMU_H
  18 #define QEMU_H
  19
  20
  21 #include "qemu/osdep.h"
  22 #include "cpu.h"
  23 #include "qemu/units.h"
  24 #include "exec/cpu_ldst.h"
  25 #include "exec/exec-all.h"
  26
  27 #undef DEBUG_REMAP
  28
  29 #include "exec/user/abitypes.h"
  30
  31 extern char **environ;
  32
  33 enum BSDType {
  34     target_freebsd,
  35     target_netbsd,
  36     target_openbsd,
  37 };
  38 extern enum BSDType bsd_type;
  39
  40 #include "exec/user/thunk.h"
  41 #include "target_arch.h"
  42 #include "syscall_defs.h"
  43 #include "target_syscall.h"
  44 #include "target_os_vmparam.h"
  45 #include "target_os_signal.h"
  46 #include "exec/gdbstub.h"
  47
  48 /*
  49  * This struct is used to hold certain information about the image.  Basically,
  50  * it replicates in user space what would be certain task_struct fields in the
  51  * kernel
  52  */
  53 struct image_info {
  54     abi_ulong load_bias;
  55     abi_ulong load_addr;
  56     abi_ulong start_code;
  57     abi_ulong end_code;
  58     abi_ulong start_data;
  59     abi_ulong end_data;
  60     abi_ulong start_brk;
  61     abi_ulong brk;
  62     abi_ulong start_mmap;
  63     abi_ulong mmap;
  64     abi_ulong rss;
  65     abi_ulong start_stack;
  66     abi_ulong entry;
  67     abi_ulong code_offset;
  68     abi_ulong data_offset;
  69     abi_ulong arg_start;
  70     abi_ulong arg_end;
  71     uint32_t  elf_flags;
  72 };
  73
  74 #define MAX_SIGQUEUE_SIZE 1024
  75
  76 struct sigqueue {
  77     struct sigqueue *next;
  78 };
  79
  80 struct emulated_sigtable {
  81     int pending; /* true if signal is pending */
  82     struct sigqueue *first;
  83     /* in order to always have memory for the first signal, we put it here */
  84     struct sigqueue info;
  85 };
  86
  87 /*
  88  * NOTE: we force a big alignment so that the stack stored after is aligned too
  89  */
  90 typedef struct TaskState {
  91     pid_t ts_tid;     /* tid (or pid) of this task */
  92
  93     struct TaskState *next;
  94     struct bsd_binprm *bprm;
  95     struct image_info *info;
  96
  97     struct emulated_sigtable sigtab[TARGET_NSIG];
  98     struct sigqueue sigqueue_table[MAX_SIGQUEUE_SIZE]; /* siginfo queue */
  99     struct sigqueue *first_free; /* first free siginfo queue entry */
 100     int signal_pending; /* non zero if a signal may be pending */
 101
 102     uint8_t stack[];
 103 } __attribute__((aligned(16))) TaskState;
 104
 105 void init_task_state(TaskState *ts);
 106 extern const char *qemu_uname_release;
 107
 108 /*
 109  * TARGET_ARG_MAX defines the number of bytes allocated for arguments
 110  * and envelope for the new program. 256k should suffice for a reasonable
 111  * maxiumum env+arg in 32-bit environments, bump it up to 512k for !ILP32
 112  * platforms.
 113  */
 114 #if TARGET_ABI_BITS > 32
 115 #define TARGET_ARG_MAX (512 * KiB)
 116 #else
 117 #define TARGET_ARG_MAX (256 * KiB)
 118 #endif
 119 #define MAX_ARG_PAGES (TARGET_ARG_MAX / TARGET_PAGE_SIZE)
 120
 121 /*
 122  * This structure is used to hold the arguments that are
 123  * used when loading binaries.
 124  */
 125 struct bsd_binprm {
 126         char buf[128];
 127         void *page[MAX_ARG_PAGES];
 128         abi_ulong p;
 129         abi_ulong stringp;
 130         int fd;
 131         int e_uid, e_gid;
 132         int argc, envc;
 133         char **argv;
 134         char **envp;
 135         char *filename;         /* (Given) Name of binary */
 136         char *fullpath;         /* Full path of binary */
 137         int (*core_dump)(int, CPUArchState *);
 138 };
 139
 140 void do_init_thread(struct target_pt_regs *regs, struct image_info *infop);
 141 abi_ulong loader_build_argptr(int envc, int argc, abi_ulong sp,
 142                               abi_ulong stringp);
 143 int loader_exec(const char *filename, char **argv, char **envp,
 144                 struct target_pt_regs *regs, struct image_info *infop,
 145                 struct bsd_binprm *bprm);
 146
 147 int load_elf_binary(struct bsd_binprm *bprm, struct target_pt_regs *regs,
 148                     struct image_info *info);
 149 int load_flt_binary(struct bsd_binprm *bprm, struct target_pt_regs *regs,
 150                     struct image_info *info);
 151 int is_target_elf_binary(int fd);
 152
 153 abi_long memcpy_to_target(abi_ulong dest, const void *src,
 154                           unsigned long len);
 155 void target_set_brk(abi_ulong new_brk);
 156 abi_long do_brk(abi_ulong new_brk);
 157 void syscall_init(void);
 158 abi_long do_freebsd_syscall(void *cpu_env, int num, abi_long arg1,
 159                             abi_long arg2, abi_long arg3, abi_long arg4,
 160                             abi_long arg5, abi_long arg6, abi_long arg7,
 161                             abi_long arg8);
 162 abi_long do_netbsd_syscall(void *cpu_env, int num, abi_long arg1,
 163                            abi_long arg2, abi_long arg3, abi_long arg4,
 164                            abi_long arg5, abi_long arg6);
 165 abi_long do_openbsd_syscall(void *cpu_env, int num, abi_long arg1,
 166                             abi_long arg2, abi_long arg3, abi_long arg4,
 167                             abi_long arg5, abi_long arg6);
 168 void gemu_log(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
 169 extern __thread CPUState *thread_cpu;
 170 void cpu_loop(CPUArchState *env);
 171 char *target_strerror(int err);
 172 int get_osversion(void);
 173 void fork_start(void);
 174 void fork_end(int child);
 175
 176 #include "qemu/log.h"
 177
 178 /* strace.c */
 179 struct syscallname {
 180     int nr;
 181     const char *name;
 182     const char *format;
 183     void (*call)(const struct syscallname *,
 184                  abi_long, abi_long, abi_long,
 185                  abi_long, abi_long, abi_long);
 186     void (*result)(const struct syscallname *, abi_long);
 187 };
 188
 189 void
 190 print_freebsd_syscall(int num,
 191                       abi_long arg1, abi_long arg2, abi_long arg3,
 192                       abi_long arg4, abi_long arg5, abi_long arg6);
 193 void print_freebsd_syscall_ret(int num, abi_long ret);
 194 void
 195 print_netbsd_syscall(int num,
 196                      abi_long arg1, abi_long arg2, abi_long arg3,
 197                      abi_long arg4, abi_long arg5, abi_long arg6);
 198 void print_netbsd_syscall_ret(int num, abi_long ret);
 199 void
 200 print_openbsd_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_openbsd_syscall_ret(int num, abi_long ret);
 204 extern int do_strace;
 205
 206 /* signal.c */
 207 void process_pending_signals(CPUArchState *cpu_env);
 208 void signal_init(void);
 209 long do_sigreturn(CPUArchState *env);
 210 long do_rt_sigreturn(CPUArchState *env);
 211 abi_long do_sigaltstack(abi_ulong uss_addr, abi_ulong uoss_addr, abi_ulong sp);
 212
 213 /* mmap.c */
 214 int target_mprotect(abi_ulong start, abi_ulong len, int prot);
 215 abi_long target_mmap(abi_ulong start, abi_ulong len, int prot,
 216                      int flags, int fd, off_t offset);
 217 int target_munmap(abi_ulong start, abi_ulong len);
 218 abi_long target_mremap(abi_ulong old_addr, abi_ulong old_size,
 219                        abi_ulong new_size, unsigned long flags,
 220                        abi_ulong new_addr);
 221 int target_msync(abi_ulong start, abi_ulong len, int flags);
 222 extern unsigned long last_brk;
 223 extern abi_ulong mmap_next_start;
 224 abi_ulong mmap_find_vma(abi_ulong start, abi_ulong size);
 225 void mmap_fork_start(void);
 226 void mmap_fork_end(int child);
 227
 228 /* main.c */
 229 extern char qemu_proc_pathname[];
 230 extern unsigned long target_maxtsiz;
 231 extern unsigned long target_dfldsiz;
 232 extern unsigned long target_maxdsiz;
 233 extern unsigned long target_dflssiz;
 234 extern unsigned long target_maxssiz;
 235 extern unsigned long target_sgrowsiz;
 236
 237 /* syscall.c */
 238 abi_long get_errno(abi_long ret);
 239 bool is_error(abi_long ret);
 240
 241 /* user access */
 242
 243 #define VERIFY_READ  PAGE_READ
 244 #define VERIFY_WRITE (PAGE_READ | PAGE_WRITE)
 245
 246 static inline bool access_ok(int type, abi_ulong addr, abi_ulong size)
 247 {
 248     return page_check_range((target_ulong)addr, size, type) == 0;
 249 }
 250
 251 /*
 252  * NOTE __get_user and __put_user use host pointers and don't check access.
 253  *
 254  * These are usually used to access struct data members once the struct has been
 255  * locked - usually with lock_user_struct().
 256  */
 257 #define __put_user(x, hptr)\
 258 ({\
 259     int size = sizeof(*hptr);\
 260     switch (size) {\
 261     case 1:\
 262         *(uint8_t *)(hptr) = (uint8_t)(typeof(*hptr))(x);\
 263         break;\
 264     case 2:\
 265         *(uint16_t *)(hptr) = tswap16((typeof(*hptr))(x));\
 266         break;\
 267     case 4:\
 268         *(uint32_t *)(hptr) = tswap32((typeof(*hptr))(x));\
 269         break;\
 270     case 8:\
 271         *(uint64_t *)(hptr) = tswap64((typeof(*hptr))(x));\
 272         break;\
 273     default:\
 274         abort();\
 275     } \
 276     0;\
 277 })
 278
 279 #define __get_user(x, hptr) \
 280 ({\
 281     int size = sizeof(*hptr);\
 282     switch (size) {\
 283     case 1:\
 284         x = (typeof(*hptr))*(uint8_t *)(hptr);\
 285         break;\
 286     case 2:\
 287         x = (typeof(*hptr))tswap16(*(uint16_t *)(hptr));\
 288         break;\
 289     case 4:\
 290         x = (typeof(*hptr))tswap32(*(uint32_t *)(hptr));\
 291         break;\
 292     case 8:\
 293         x = (typeof(*hptr))tswap64(*(uint64_t *)(hptr));\
 294         break;\
 295     default:\
 296         x = 0;\
 297         abort();\
 298     } \
 299     0;\
 300 })
 301
 302 /*
 303  * put_user()/get_user() take a guest address and check access
 304  *
 305  * These are usually used to access an atomic data type, such as an int, that
 306  * has been passed by address.  These internally perform locking and unlocking
 307  * on the data type.
 308  */
 309 #define put_user(x, gaddr, target_type)                                 \
 310 ({                                                                      \
 311     abi_ulong __gaddr = (gaddr);                                        \
 312     target_type *__hptr;                                                \
 313     abi_long __ret;                                                     \
 314     __hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0);  \
 315     if (__hptr) {                                                       \
 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     __hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1);   \
 329     if (__hptr) {                                                       \
 330         __ret = __get_user((x), __hptr);                                \
 331         unlock_user(__hptr, __gaddr, 0);                                \
 332     } else {                                                            \
 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 /*
 362  * copy_from_user() and copy_to_user() are usually used to copy data
 363  * buffers between the target and host.  These internally perform
 364  * locking/unlocking of the memory.
 365  */
 366 abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
 367 abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
 368
 369 /*
 370  * Functions for accessing guest memory.  The tget and tput functions
 371  * read/write single values, byteswapping as necessary.  The lock_user function
 372  * gets a pointer to a contiguous area of guest memory, but does not perform
 373  * any byteswapping.  lock_user may return either a pointer to the guest
 374  * memory, or a temporary buffer.
 375  */
 376
 377 /*
 378  * Lock an area of guest memory into the host.  If copy is true then the
 379  * host area will have the same contents as the guest.
 380  */
 381 static inline void *lock_user(int type, abi_ulong guest_addr, long len,
 382                               int copy)
 383 {
 384     if (!access_ok(type, guest_addr, len)) {
 385         return NULL;
 386     }
 387 #ifdef DEBUG_REMAP
 388     {
 389         void *addr;
 390         addr = g_malloc(len);
 391         if (copy) {
 392             memcpy(addr, g2h_untagged(guest_addr), len);
 393         } else {
 394             memset(addr, 0, len);
 395         }
 396         return addr;
 397     }
 398 #else
 399     return g2h_untagged(guest_addr);
 400 #endif
 401 }
 402
 403 /*
 404  * Unlock an area of guest memory.  The first LEN bytes must be flushed back to
 405  * guest memory. host_ptr = NULL is explicitly allowed and does nothing.
 406  */
 407 static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
 408                                long len)
 409 {
 410
 411 #ifdef DEBUG_REMAP
 412     if (!host_ptr) {
 413         return;
 414     }
 415     if (host_ptr == g2h_untagged(guest_addr)) {
 416         return;
 417     }
 418     if (len > 0) {
 419         memcpy(g2h_untagged(guest_addr), host_ptr, len);
 420     }
 421     g_free(host_ptr);
 422 #endif
 423 }
 424
 425 /*
 426  * Return the length of a string in target memory or -TARGET_EFAULT if access
 427  * error.
 428  */
 429 abi_long target_strlen(abi_ulong gaddr);
 430
 431 /* Like lock_user but for null terminated strings.  */
 432 static inline void *lock_user_string(abi_ulong guest_addr)
 433 {
 434     abi_long len;
 435     len = target_strlen(guest_addr);
 436     if (len < 0) {
 437         return NULL;
 438     }
 439     return lock_user(VERIFY_READ, guest_addr, (long)(len + 1), 1);
 440 }
 441
 442 /* Helper macros for locking/unlocking a target struct.  */
 443 #define lock_user_struct(type, host_ptr, guest_addr, copy)      \
 444     (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
 445 #define unlock_user_struct(host_ptr, guest_addr, copy)          \
 446     unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
 447
 448 #include <pthread.h>
 449
 450 #endif /* QEMU_H */