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