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 #include "qemu/osdep.h"
  21 #include "cpu.h"
  22 #include "qemu/units.h"
  23 #include "exec/cpu_ldst.h"
  24 #include "exec/exec-all.h"
  25
  26 #undef DEBUG_REMAP
  27
  28 #include "exec/user/abitypes.h"
  29
  30 extern char **environ;
  31
  32 enum BSDType {
  33     target_freebsd,
  34     target_netbsd,
  35     target_openbsd,
  36 };
  37 extern enum BSDType bsd_type;
  38
  39 #include "exec/user/thunk.h"
  40 #include "target_arch.h"
  41 #include "syscall_defs.h"
  42 #include "target_syscall.h"
  43 #include "target_os_vmparam.h"
  44 #include "target_os_signal.h"
  45 #include "exec/gdbstub.h"
  46
  47 /*
  48  * This struct is used to hold certain information about the image.  Basically,
  49  * it replicates in user space what would be certain task_struct fields in the
  50  * kernel
  51  */
  52 struct image_info {
  53     abi_ulong load_bias;
  54     abi_ulong load_addr;
  55     abi_ulong start_code;
  56     abi_ulong end_code;
  57     abi_ulong start_data;
  58     abi_ulong end_data;
  59     abi_ulong start_brk;
  60     abi_ulong brk;
  61     abi_ulong start_mmap;
  62     abi_ulong mmap;
  63     abi_ulong rss;
  64     abi_ulong start_stack;
  65     abi_ulong entry;
  66     abi_ulong code_offset;
  67     abi_ulong data_offset;
  68     abi_ulong arg_start;
  69     abi_ulong arg_end;
  70     uint32_t  elf_flags;
  71 };
  72
  73 struct emulated_sigtable {
  74     int pending; /* true if signal is pending */
  75     target_siginfo_t info;
  76 };
  77
  78 /*
  79  * NOTE: we force a big alignment so that the stack stored after is aligned too
  80  */
  81 typedef struct TaskState {
  82     pid_t ts_tid;     /* tid (or pid) of this task */
  83
  84     struct TaskState *next;
  85     struct bsd_binprm *bprm;
  86     struct image_info *info;
  87
  88     struct emulated_sigtable sigtab[TARGET_NSIG];
  89     /*
  90      * Nonzero if process_pending_signals() needs to do something (either
  91      * handle a pending signal or unblock signals).
  92      * This flag is written from a signal handler so should be accessed via
  93      * the qatomic_read() and qatomic_set() functions. (It is not accessed
  94      * from multiple threads.)
  95      */
  96     int signal_pending;
  97     /*
  98      * This thread's signal mask, as requested by the guest program.
  99      * The actual signal mask of this thread may differ:
 100      *  + we don't let SIGSEGV and SIGBUS be blocked while running guest code
 101      *  + sometimes we block all signals to avoid races
 102      */
 103     sigset_t signal_mask;
 104
 105     uint8_t stack[];
 106 } __attribute__((aligned(16))) TaskState;
 107
 108 void stop_all_tasks(void);
 109 extern const char *qemu_uname_release;
 110
 111 /*
 112  * TARGET_ARG_MAX defines the number of bytes allocated for arguments
 113  * and envelope for the new program. 256k should suffice for a reasonable
 114  * maxiumum env+arg in 32-bit environments, bump it up to 512k for !ILP32
 115  * platforms.
 116  */
 117 #if TARGET_ABI_BITS > 32
 118 #define TARGET_ARG_MAX (512 * KiB)
 119 #else
 120 #define TARGET_ARG_MAX (256 * KiB)
 121 #endif
 122 #define MAX_ARG_PAGES (TARGET_ARG_MAX / TARGET_PAGE_SIZE)
 123
 124 /*
 125  * This structure is used to hold the arguments that are
 126  * used when loading binaries.
 127  */
 128 struct bsd_binprm {
 129         char buf[128];
 130         void *page[MAX_ARG_PAGES];
 131         abi_ulong p;
 132         abi_ulong stringp;
 133         int fd;
 134         int e_uid, e_gid;
 135         int argc, envc;
 136         char **argv;
 137         char **envp;
 138         char *filename;         /* (Given) Name of binary */
 139         char *fullpath;         /* Full path of binary */
 140         int (*core_dump)(int, CPUArchState *);
 141 };
 142
 143 void do_init_thread(struct target_pt_regs *regs, struct image_info *infop);
 144 abi_ulong loader_build_argptr(int envc, int argc, abi_ulong sp,
 145                               abi_ulong stringp);
 146 int loader_exec(const char *filename, char **argv, char **envp,
 147                 struct target_pt_regs *regs, struct image_info *infop,
 148                 struct bsd_binprm *bprm);
 149
 150 int load_elf_binary(struct bsd_binprm *bprm, struct target_pt_regs *regs,
 151                     struct image_info *info);
 152 int load_flt_binary(struct bsd_binprm *bprm, struct target_pt_regs *regs,
 153                     struct image_info *info);
 154 int is_target_elf_binary(int fd);
 155
 156 abi_long memcpy_to_target(abi_ulong dest, const void *src,
 157                           unsigned long len);
 158 void target_set_brk(abi_ulong new_brk);
 159 abi_long do_brk(abi_ulong new_brk);
 160 void syscall_init(void);
 161 abi_long do_freebsd_syscall(void *cpu_env, int num, abi_long arg1,
 162                             abi_long arg2, abi_long arg3, abi_long arg4,
 163                             abi_long arg5, abi_long arg6, abi_long arg7,
 164                             abi_long arg8);
 165 abi_long do_netbsd_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 abi_long do_openbsd_syscall(void *cpu_env, int num, abi_long arg1,
 169                             abi_long arg2, abi_long arg3, abi_long arg4,
 170                             abi_long arg5, abi_long arg6);
 171 void gemu_log(const char *fmt, ...) GCC_FMT_ATTR(1, 2);
 172 extern __thread CPUState *thread_cpu;
 173 void cpu_loop(CPUArchState *env);
 174 char *target_strerror(int err);
 175 int get_osversion(void);
 176 void fork_start(void);
 177 void fork_end(int child);
 178
 179 #include "qemu/log.h"
 180
 181 /* strace.c */
 182 struct syscallname {
 183     int nr;
 184     const char *name;
 185     const char *format;
 186     void (*call)(const struct syscallname *,
 187                  abi_long, abi_long, abi_long,
 188                  abi_long, abi_long, abi_long);
 189     void (*result)(const struct syscallname *, abi_long);
 190 };
 191
 192 void
 193 print_freebsd_syscall(int num,
 194                       abi_long arg1, abi_long arg2, abi_long arg3,
 195                       abi_long arg4, abi_long arg5, abi_long arg6);
 196 void print_freebsd_syscall_ret(int num, abi_long ret);
 197 void
 198 print_netbsd_syscall(int num,
 199                      abi_long arg1, abi_long arg2, abi_long arg3,
 200                      abi_long arg4, abi_long arg5, abi_long arg6);
 201 void print_netbsd_syscall_ret(int num, abi_long ret);
 202 void
 203 print_openbsd_syscall(int num,
 204                       abi_long arg1, abi_long arg2, abi_long arg3,
 205                       abi_long arg4, abi_long arg5, abi_long arg6);
 206 void print_openbsd_syscall_ret(int num, abi_long ret);
 207 /**
 208  * print_taken_signal:
 209  * @target_signum: target signal being taken
 210  * @tinfo: target_siginfo_t which will be passed to the guest for the signal
 211  *
 212  * Print strace output indicating that this signal is being taken by the guest,
 213  * in a format similar to:
 214  * --- SIGSEGV {si_signo=SIGSEGV, si_code=SI_KERNEL, si_addr=0} ---
 215  */
 216 void print_taken_signal(int target_signum, const target_siginfo_t *tinfo);
 217 extern int do_strace;
 218
 219 /* mmap.c */
 220 int target_mprotect(abi_ulong start, abi_ulong len, int prot);
 221 abi_long target_mmap(abi_ulong start, abi_ulong len, int prot,
 222                      int flags, int fd, off_t offset);
 223 int target_munmap(abi_ulong start, abi_ulong len);
 224 abi_long target_mremap(abi_ulong old_addr, abi_ulong old_size,
 225                        abi_ulong new_size, unsigned long flags,
 226                        abi_ulong new_addr);
 227 int target_msync(abi_ulong start, abi_ulong len, int flags);
 228 extern unsigned long last_brk;
 229 extern abi_ulong mmap_next_start;
 230 abi_ulong mmap_find_vma(abi_ulong start, abi_ulong size);
 231 void mmap_fork_start(void);
 232 void mmap_fork_end(int child);
 233
 234 /* main.c */
 235 extern char qemu_proc_pathname[];
 236 extern unsigned long target_maxtsiz;
 237 extern unsigned long target_dfldsiz;
 238 extern unsigned long target_maxdsiz;
 239 extern unsigned long target_dflssiz;
 240 extern unsigned long target_maxssiz;
 241 extern unsigned long target_sgrowsiz;
 242
 243 /* syscall.c */
 244 abi_long get_errno(abi_long ret);
 245 bool is_error(abi_long ret);
 246
 247 /* os-sys.c */
 248 abi_long do_freebsd_sysarch(void *cpu_env, abi_long arg1, abi_long arg2);
 249
 250 /* user access */
 251
 252 #define VERIFY_READ  PAGE_READ
 253 #define VERIFY_WRITE (PAGE_READ | PAGE_WRITE)
 254
 255 static inline bool access_ok(int type, abi_ulong addr, abi_ulong size)
 256 {
 257     return page_check_range((target_ulong)addr, size, type) == 0;
 258 }
 259
 260 /*
 261  * NOTE __get_user and __put_user use host pointers and don't check access.
 262  *
 263  * These are usually used to access struct data members once the struct has been
 264  * 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         x = 0;\
 306         abort();\
 307     } \
 308     0;\
 309 })
 310
 311 /*
 312  * put_user()/get_user() take a guest address and check access
 313  *
 314  * These are usually used to access an atomic data type, such as an int, that
 315  * has been passed by address.  These internally perform locking and unlocking
 316  * on the data type.
 317  */
 318 #define put_user(x, gaddr, target_type)                                 \
 319 ({                                                                      \
 320     abi_ulong __gaddr = (gaddr);                                        \
 321     target_type *__hptr;                                                \
 322     abi_long __ret;                                                     \
 323     __hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0);  \
 324     if (__hptr) {                                                       \
 325         __ret = __put_user((x), __hptr);                                \
 326         unlock_user(__hptr, __gaddr, sizeof(target_type));              \
 327     } else                                                              \
 328         __ret = -TARGET_EFAULT;                                         \
 329     __ret;                                                              \
 330 })
 331
 332 #define get_user(x, gaddr, target_type)                                 \
 333 ({                                                                      \
 334     abi_ulong __gaddr = (gaddr);                                        \
 335     target_type *__hptr;                                                \
 336     abi_long __ret;                                                     \
 337     __hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1);   \
 338     if (__hptr) {                                                       \
 339         __ret = __get_user((x), __hptr);                                \
 340         unlock_user(__hptr, __gaddr, 0);                                \
 341     } else {                                                            \
 342         (x) = 0;                                                        \
 343         __ret = -TARGET_EFAULT;                                         \
 344     }                                                                   \
 345     __ret;                                                              \
 346 })
 347
 348 #define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong)
 349 #define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long)
 350 #define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t)
 351 #define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t)
 352 #define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t)
 353 #define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t)
 354 #define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t)
 355 #define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t)
 356 #define put_user_u8(x, gaddr)  put_user((x), (gaddr), uint8_t)
 357 #define put_user_s8(x, gaddr)  put_user((x), (gaddr), int8_t)
 358
 359 #define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong)
 360 #define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long)
 361 #define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t)
 362 #define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t)
 363 #define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t)
 364 #define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t)
 365 #define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t)
 366 #define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t)
 367 #define get_user_u8(x, gaddr)  get_user((x), (gaddr), uint8_t)
 368 #define get_user_s8(x, gaddr)  get_user((x), (gaddr), int8_t)
 369
 370 /*
 371  * copy_from_user() and copy_to_user() are usually used to copy data
 372  * buffers between the target and host.  These internally perform
 373  * locking/unlocking of the memory.
 374  */
 375 abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
 376 abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
 377
 378 /*
 379  * Functions for accessing guest memory.  The tget and tput functions
 380  * read/write single values, byteswapping as necessary.  The lock_user function
 381  * gets a pointer to a contiguous area of guest memory, but does not perform
 382  * any byteswapping.  lock_user may return either a pointer to the guest
 383  * memory, or a temporary buffer.
 384  */
 385
 386 /*
 387  * Lock an area of guest memory into the host.  If copy is true then the
 388  * host area will have the same contents as the guest.
 389  */
 390 static inline void *lock_user(int type, abi_ulong guest_addr, long len,
 391                               int copy)
 392 {
 393     if (!access_ok(type, guest_addr, len)) {
 394         return NULL;
 395     }
 396 #ifdef DEBUG_REMAP
 397     {
 398         void *addr;
 399         addr = g_malloc(len);
 400         if (copy) {
 401             memcpy(addr, g2h_untagged(guest_addr), len);
 402         } else {
 403             memset(addr, 0, len);
 404         }
 405         return addr;
 406     }
 407 #else
 408     return g2h_untagged(guest_addr);
 409 #endif
 410 }
 411
 412 /*
 413  * Unlock an area of guest memory.  The first LEN bytes must be flushed back to
 414  * guest memory. host_ptr = NULL is explicitly allowed and does nothing.
 415  */
 416 static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
 417                                long len)
 418 {
 419
 420 #ifdef DEBUG_REMAP
 421     if (!host_ptr) {
 422         return;
 423     }
 424     if (host_ptr == g2h_untagged(guest_addr)) {
 425         return;
 426     }
 427     if (len > 0) {
 428         memcpy(g2h_untagged(guest_addr), host_ptr, len);
 429     }
 430     g_free(host_ptr);
 431 #endif
 432 }
 433
 434 /*
 435  * Return the length of a string in target memory or -TARGET_EFAULT if access
 436  * error.
 437  */
 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     }
 448     return lock_user(VERIFY_READ, guest_addr, (long)(len + 1), 1);
 449 }
 450
 451 /* Helper macros for locking/unlocking a target struct.  */
 452 #define lock_user_struct(type, host_ptr, guest_addr, copy)      \
 453     (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
 454 #define unlock_user_struct(host_ptr, guest_addr, copy)          \
 455     unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
 456
 457 #include <pthread.h>
 458
 459 #include "user/safe-syscall.h"
 460
 461 #endif /* QEMU_H */