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 sync_signal; 89 /* 90 * TODO: Since we block all signals while returning to the main CPU 91 * loop, this needn't be an array 92 */ 93 struct emulated_sigtable sigtab[TARGET_NSIG]; 94 /* 95 * Nonzero if process_pending_signals() needs to do something (either 96 * handle a pending signal or unblock signals). 97 * This flag is written from a signal handler so should be accessed via 98 * the qatomic_read() and qatomic_set() functions. (It is not accessed 99 * from multiple threads.) 100 */ 101 int signal_pending; 102 /* True if we're leaving a sigsuspend and sigsuspend_mask is valid. */ 103 bool in_sigsuspend; 104 /* 105 * This thread's signal mask, as requested by the guest program. 106 * The actual signal mask of this thread may differ: 107 * + we don't let SIGSEGV and SIGBUS be blocked while running guest code 108 * + sometimes we block all signals to avoid races 109 */ 110 sigset_t signal_mask; 111 /* 112 * The signal mask imposed by a guest sigsuspend syscall, if we are 113 * currently in the middle of such a syscall 114 */ 115 sigset_t sigsuspend_mask; 116 117 /* This thread's sigaltstack, if it has one */ 118 struct target_sigaltstack sigaltstack_used; 119 } __attribute__((aligned(16))) TaskState; 120 121 void stop_all_tasks(void); 122 extern const char *qemu_uname_release; 123 124 /* 125 * TARGET_ARG_MAX defines the number of bytes allocated for arguments 126 * and envelope for the new program. 256k should suffice for a reasonable 127 * maxiumum env+arg in 32-bit environments, bump it up to 512k for !ILP32 128 * platforms. 129 */ 130 #if TARGET_ABI_BITS > 32 131 #define TARGET_ARG_MAX (512 * KiB) 132 #else 133 #define TARGET_ARG_MAX (256 * KiB) 134 #endif 135 #define MAX_ARG_PAGES (TARGET_ARG_MAX / TARGET_PAGE_SIZE) 136 137 /* 138 * This structure is used to hold the arguments that are 139 * used when loading binaries. 140 */ 141 struct bsd_binprm { 142 char buf[128]; 143 void *page[MAX_ARG_PAGES]; 144 abi_ulong p; 145 abi_ulong stringp; 146 int fd; 147 int e_uid, e_gid; 148 int argc, envc; 149 char **argv; 150 char **envp; 151 char *filename; /* (Given) Name of binary */ 152 char *fullpath; /* Full path of binary */ 153 int (*core_dump)(int, CPUArchState *); 154 }; 155 156 void do_init_thread(struct target_pt_regs *regs, struct image_info *infop); 157 abi_ulong loader_build_argptr(int envc, int argc, abi_ulong sp, 158 abi_ulong stringp); 159 int loader_exec(const char *filename, char **argv, char **envp, 160 struct target_pt_regs *regs, struct image_info *infop, 161 struct bsd_binprm *bprm); 162 163 int load_elf_binary(struct bsd_binprm *bprm, struct target_pt_regs *regs, 164 struct image_info *info); 165 int load_flt_binary(struct bsd_binprm *bprm, struct target_pt_regs *regs, 166 struct image_info *info); 167 int is_target_elf_binary(int fd); 168 169 abi_long memcpy_to_target(abi_ulong dest, const void *src, 170 unsigned long len); 171 void target_set_brk(abi_ulong new_brk); 172 abi_long do_brk(abi_ulong new_brk); 173 void syscall_init(void); 174 abi_long do_freebsd_syscall(void *cpu_env, int num, abi_long arg1, 175 abi_long arg2, abi_long arg3, abi_long arg4, 176 abi_long arg5, abi_long arg6, abi_long arg7, 177 abi_long arg8); 178 abi_long do_netbsd_syscall(void *cpu_env, int num, abi_long arg1, 179 abi_long arg2, abi_long arg3, abi_long arg4, 180 abi_long arg5, abi_long arg6); 181 abi_long do_openbsd_syscall(void *cpu_env, int num, abi_long arg1, 182 abi_long arg2, abi_long arg3, abi_long arg4, 183 abi_long arg5, abi_long arg6); 184 void gemu_log(const char *fmt, ...) GCC_FMT_ATTR(1, 2); 185 extern __thread CPUState *thread_cpu; 186 void cpu_loop(CPUArchState *env); 187 char *target_strerror(int err); 188 int get_osversion(void); 189 void fork_start(void); 190 void fork_end(int child); 191 192 #include "qemu/log.h" 193 194 /* strace.c */ 195 struct syscallname { 196 int nr; 197 const char *name; 198 const char *format; 199 void (*call)(const struct syscallname *, 200 abi_long, abi_long, abi_long, 201 abi_long, abi_long, abi_long); 202 void (*result)(const struct syscallname *, abi_long); 203 }; 204 205 void 206 print_freebsd_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_freebsd_syscall_ret(int num, abi_long ret); 210 void 211 print_netbsd_syscall(int num, 212 abi_long arg1, abi_long arg2, abi_long arg3, 213 abi_long arg4, abi_long arg5, abi_long arg6); 214 void print_netbsd_syscall_ret(int num, abi_long ret); 215 void 216 print_openbsd_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_openbsd_syscall_ret(int num, abi_long ret); 220 /** 221 * print_taken_signal: 222 * @target_signum: target signal being taken 223 * @tinfo: target_siginfo_t which will be passed to the guest for the signal 224 * 225 * Print strace output indicating that this signal is being taken by the guest, 226 * in a format similar to: 227 * --- SIGSEGV {si_signo=SIGSEGV, si_code=SI_KERNEL, si_addr=0} --- 228 */ 229 void print_taken_signal(int target_signum, const target_siginfo_t *tinfo); 230 extern int do_strace; 231 232 /* mmap.c */ 233 int target_mprotect(abi_ulong start, abi_ulong len, int prot); 234 abi_long target_mmap(abi_ulong start, abi_ulong len, int prot, 235 int flags, int fd, off_t offset); 236 int target_munmap(abi_ulong start, abi_ulong len); 237 abi_long target_mremap(abi_ulong old_addr, abi_ulong old_size, 238 abi_ulong new_size, unsigned long flags, 239 abi_ulong new_addr); 240 int target_msync(abi_ulong start, abi_ulong len, int flags); 241 extern unsigned long last_brk; 242 extern abi_ulong mmap_next_start; 243 abi_ulong mmap_find_vma(abi_ulong start, abi_ulong size); 244 void mmap_fork_start(void); 245 void mmap_fork_end(int child); 246 247 /* main.c */ 248 extern char qemu_proc_pathname[]; 249 extern unsigned long target_maxtsiz; 250 extern unsigned long target_dfldsiz; 251 extern unsigned long target_maxdsiz; 252 extern unsigned long target_dflssiz; 253 extern unsigned long target_maxssiz; 254 extern unsigned long target_sgrowsiz; 255 256 /* syscall.c */ 257 abi_long get_errno(abi_long ret); 258 bool is_error(abi_long ret); 259 260 /* os-sys.c */ 261 abi_long do_freebsd_sysarch(void *cpu_env, abi_long arg1, abi_long arg2); 262 263 /* user access */ 264 265 #define VERIFY_READ PAGE_READ 266 #define VERIFY_WRITE (PAGE_READ | PAGE_WRITE) 267 268 static inline bool access_ok(int type, abi_ulong addr, abi_ulong size) 269 { 270 return page_check_range((target_ulong)addr, size, type) == 0; 271 } 272 273 /* 274 * NOTE __get_user and __put_user use host pointers and don't check access. 275 * 276 * These are usually used to access struct data members once the struct has been 277 * locked - usually with lock_user_struct(). 278 */ 279 #define __put_user(x, hptr)\ 280 ({\ 281 int size = sizeof(*hptr);\ 282 switch (size) {\ 283 case 1:\ 284 *(uint8_t *)(hptr) = (uint8_t)(typeof(*hptr))(x);\ 285 break;\ 286 case 2:\ 287 *(uint16_t *)(hptr) = tswap16((typeof(*hptr))(x));\ 288 break;\ 289 case 4:\ 290 *(uint32_t *)(hptr) = tswap32((typeof(*hptr))(x));\ 291 break;\ 292 case 8:\ 293 *(uint64_t *)(hptr) = tswap64((typeof(*hptr))(x));\ 294 break;\ 295 default:\ 296 abort();\ 297 } \ 298 0;\ 299 }) 300 301 #define __get_user(x, hptr) \ 302 ({\ 303 int size = sizeof(*hptr);\ 304 switch (size) {\ 305 case 1:\ 306 x = (typeof(*hptr))*(uint8_t *)(hptr);\ 307 break;\ 308 case 2:\ 309 x = (typeof(*hptr))tswap16(*(uint16_t *)(hptr));\ 310 break;\ 311 case 4:\ 312 x = (typeof(*hptr))tswap32(*(uint32_t *)(hptr));\ 313 break;\ 314 case 8:\ 315 x = (typeof(*hptr))tswap64(*(uint64_t *)(hptr));\ 316 break;\ 317 default:\ 318 x = 0;\ 319 abort();\ 320 } \ 321 0;\ 322 }) 323 324 /* 325 * put_user()/get_user() take a guest address and check access 326 * 327 * These are usually used to access an atomic data type, such as an int, that 328 * has been passed by address. These internally perform locking and unlocking 329 * on the data type. 330 */ 331 #define put_user(x, gaddr, target_type) \ 332 ({ \ 333 abi_ulong __gaddr = (gaddr); \ 334 target_type *__hptr; \ 335 abi_long __ret; \ 336 __hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0); \ 337 if (__hptr) { \ 338 __ret = __put_user((x), __hptr); \ 339 unlock_user(__hptr, __gaddr, sizeof(target_type)); \ 340 } else \ 341 __ret = -TARGET_EFAULT; \ 342 __ret; \ 343 }) 344 345 #define get_user(x, gaddr, target_type) \ 346 ({ \ 347 abi_ulong __gaddr = (gaddr); \ 348 target_type *__hptr; \ 349 abi_long __ret; \ 350 __hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1); \ 351 if (__hptr) { \ 352 __ret = __get_user((x), __hptr); \ 353 unlock_user(__hptr, __gaddr, 0); \ 354 } else { \ 355 (x) = 0; \ 356 __ret = -TARGET_EFAULT; \ 357 } \ 358 __ret; \ 359 }) 360 361 #define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong) 362 #define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long) 363 #define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t) 364 #define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t) 365 #define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t) 366 #define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t) 367 #define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t) 368 #define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t) 369 #define put_user_u8(x, gaddr) put_user((x), (gaddr), uint8_t) 370 #define put_user_s8(x, gaddr) put_user((x), (gaddr), int8_t) 371 372 #define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong) 373 #define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long) 374 #define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t) 375 #define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t) 376 #define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t) 377 #define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t) 378 #define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t) 379 #define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t) 380 #define get_user_u8(x, gaddr) get_user((x), (gaddr), uint8_t) 381 #define get_user_s8(x, gaddr) get_user((x), (gaddr), int8_t) 382 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 /* 392 * Functions for accessing guest memory. The tget and tput functions 393 * read/write single values, byteswapping as necessary. The lock_user function 394 * gets a pointer to a contiguous area of guest memory, but does not perform 395 * any byteswapping. lock_user may return either a pointer to the guest 396 * memory, or a temporary buffer. 397 */ 398 399 /* 400 * Lock an area of guest memory into the host. If copy is true then the 401 * host area will have the same contents as the guest. 402 */ 403 static inline void *lock_user(int type, abi_ulong guest_addr, long len, 404 int copy) 405 { 406 if (!access_ok(type, guest_addr, len)) { 407 return NULL; 408 } 409 #ifdef DEBUG_REMAP 410 { 411 void *addr; 412 addr = g_malloc(len); 413 if (copy) { 414 memcpy(addr, g2h_untagged(guest_addr), len); 415 } else { 416 memset(addr, 0, len); 417 } 418 return addr; 419 } 420 #else 421 return g2h_untagged(guest_addr); 422 #endif 423 } 424 425 /* 426 * Unlock an area of guest memory. The first LEN bytes must be flushed back to 427 * guest memory. host_ptr = NULL is explicitly allowed and does nothing. 428 */ 429 static inline void unlock_user(void *host_ptr, abi_ulong guest_addr, 430 long len) 431 { 432 433 #ifdef DEBUG_REMAP 434 if (!host_ptr) { 435 return; 436 } 437 if (host_ptr == g2h_untagged(guest_addr)) { 438 return; 439 } 440 if (len > 0) { 441 memcpy(g2h_untagged(guest_addr), host_ptr, len); 442 } 443 g_free(host_ptr); 444 #endif 445 } 446 447 /* 448 * Return the length of a string in target memory or -TARGET_EFAULT if access 449 * error. 450 */ 451 abi_long target_strlen(abi_ulong gaddr); 452 453 /* Like lock_user but for null terminated strings. */ 454 static inline void *lock_user_string(abi_ulong guest_addr) 455 { 456 abi_long len; 457 len = target_strlen(guest_addr); 458 if (len < 0) { 459 return NULL; 460 } 461 return lock_user(VERIFY_READ, guest_addr, (long)(len + 1), 1); 462 } 463 464 /* Helper macros for locking/unlocking a target struct. */ 465 #define lock_user_struct(type, host_ptr, guest_addr, copy) \ 466 (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy)) 467 #define unlock_user_struct(host_ptr, guest_addr, copy) \ 468 unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0) 469 470 #include <pthread.h> 471 472 #include "user/safe-syscall.h" 473 474 #endif /* QEMU_H */ 475