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 extern int do_strace; 208 209 /* mmap.c */ 210 int target_mprotect(abi_ulong start, abi_ulong len, int prot); 211 abi_long target_mmap(abi_ulong start, abi_ulong len, int prot, 212 int flags, int fd, off_t offset); 213 int target_munmap(abi_ulong start, abi_ulong len); 214 abi_long target_mremap(abi_ulong old_addr, abi_ulong old_size, 215 abi_ulong new_size, unsigned long flags, 216 abi_ulong new_addr); 217 int target_msync(abi_ulong start, abi_ulong len, int flags); 218 extern unsigned long last_brk; 219 extern abi_ulong mmap_next_start; 220 abi_ulong mmap_find_vma(abi_ulong start, abi_ulong size); 221 void mmap_fork_start(void); 222 void mmap_fork_end(int child); 223 224 /* main.c */ 225 extern char qemu_proc_pathname[]; 226 extern unsigned long target_maxtsiz; 227 extern unsigned long target_dfldsiz; 228 extern unsigned long target_maxdsiz; 229 extern unsigned long target_dflssiz; 230 extern unsigned long target_maxssiz; 231 extern unsigned long target_sgrowsiz; 232 233 /* syscall.c */ 234 abi_long get_errno(abi_long ret); 235 bool is_error(abi_long ret); 236 237 /* os-sys.c */ 238 abi_long do_freebsd_sysarch(void *cpu_env, abi_long arg1, abi_long arg2); 239 240 /* user access */ 241 242 #define VERIFY_READ PAGE_READ 243 #define VERIFY_WRITE (PAGE_READ | PAGE_WRITE) 244 245 static inline bool access_ok(int type, abi_ulong addr, abi_ulong size) 246 { 247 return page_check_range((target_ulong)addr, size, type) == 0; 248 } 249 250 /* 251 * NOTE __get_user and __put_user use host pointers and don't check access. 252 * 253 * These are usually used to access struct data members once the struct has been 254 * locked - usually with lock_user_struct(). 255 */ 256 #define __put_user(x, hptr)\ 257 ({\ 258 int size = sizeof(*hptr);\ 259 switch (size) {\ 260 case 1:\ 261 *(uint8_t *)(hptr) = (uint8_t)(typeof(*hptr))(x);\ 262 break;\ 263 case 2:\ 264 *(uint16_t *)(hptr) = tswap16((typeof(*hptr))(x));\ 265 break;\ 266 case 4:\ 267 *(uint32_t *)(hptr) = tswap32((typeof(*hptr))(x));\ 268 break;\ 269 case 8:\ 270 *(uint64_t *)(hptr) = tswap64((typeof(*hptr))(x));\ 271 break;\ 272 default:\ 273 abort();\ 274 } \ 275 0;\ 276 }) 277 278 #define __get_user(x, hptr) \ 279 ({\ 280 int size = sizeof(*hptr);\ 281 switch (size) {\ 282 case 1:\ 283 x = (typeof(*hptr))*(uint8_t *)(hptr);\ 284 break;\ 285 case 2:\ 286 x = (typeof(*hptr))tswap16(*(uint16_t *)(hptr));\ 287 break;\ 288 case 4:\ 289 x = (typeof(*hptr))tswap32(*(uint32_t *)(hptr));\ 290 break;\ 291 case 8:\ 292 x = (typeof(*hptr))tswap64(*(uint64_t *)(hptr));\ 293 break;\ 294 default:\ 295 x = 0;\ 296 abort();\ 297 } \ 298 0;\ 299 }) 300 301 /* 302 * put_user()/get_user() take a guest address and check access 303 * 304 * These are usually used to access an atomic data type, such as an int, that 305 * has been passed by address. These internally perform locking and unlocking 306 * on the data type. 307 */ 308 #define put_user(x, gaddr, target_type) \ 309 ({ \ 310 abi_ulong __gaddr = (gaddr); \ 311 target_type *__hptr; \ 312 abi_long __ret; \ 313 __hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0); \ 314 if (__hptr) { \ 315 __ret = __put_user((x), __hptr); \ 316 unlock_user(__hptr, __gaddr, sizeof(target_type)); \ 317 } else \ 318 __ret = -TARGET_EFAULT; \ 319 __ret; \ 320 }) 321 322 #define get_user(x, gaddr, target_type) \ 323 ({ \ 324 abi_ulong __gaddr = (gaddr); \ 325 target_type *__hptr; \ 326 abi_long __ret; \ 327 __hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1); \ 328 if (__hptr) { \ 329 __ret = __get_user((x), __hptr); \ 330 unlock_user(__hptr, __gaddr, 0); \ 331 } else { \ 332 (x) = 0; \ 333 __ret = -TARGET_EFAULT; \ 334 } \ 335 __ret; \ 336 }) 337 338 #define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong) 339 #define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long) 340 #define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t) 341 #define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t) 342 #define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t) 343 #define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t) 344 #define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t) 345 #define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t) 346 #define put_user_u8(x, gaddr) put_user((x), (gaddr), uint8_t) 347 #define put_user_s8(x, gaddr) put_user((x), (gaddr), int8_t) 348 349 #define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong) 350 #define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long) 351 #define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t) 352 #define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t) 353 #define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t) 354 #define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t) 355 #define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t) 356 #define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t) 357 #define get_user_u8(x, gaddr) get_user((x), (gaddr), uint8_t) 358 #define get_user_s8(x, gaddr) get_user((x), (gaddr), int8_t) 359 360 /* 361 * copy_from_user() and copy_to_user() are usually used to copy data 362 * buffers between the target and host. These internally perform 363 * locking/unlocking of the memory. 364 */ 365 abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len); 366 abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len); 367 368 /* 369 * Functions for accessing guest memory. The tget and tput functions 370 * read/write single values, byteswapping as necessary. The lock_user function 371 * gets a pointer to a contiguous area of guest memory, but does not perform 372 * any byteswapping. lock_user may return either a pointer to the guest 373 * memory, or a temporary buffer. 374 */ 375 376 /* 377 * Lock an area of guest memory into the host. If copy is true then the 378 * host area will have the same contents as the guest. 379 */ 380 static inline void *lock_user(int type, abi_ulong guest_addr, long len, 381 int copy) 382 { 383 if (!access_ok(type, guest_addr, len)) { 384 return NULL; 385 } 386 #ifdef DEBUG_REMAP 387 { 388 void *addr; 389 addr = g_malloc(len); 390 if (copy) { 391 memcpy(addr, g2h_untagged(guest_addr), len); 392 } else { 393 memset(addr, 0, len); 394 } 395 return addr; 396 } 397 #else 398 return g2h_untagged(guest_addr); 399 #endif 400 } 401 402 /* 403 * Unlock an area of guest memory. The first LEN bytes must be flushed back to 404 * guest memory. host_ptr = NULL is explicitly allowed and does nothing. 405 */ 406 static inline void unlock_user(void *host_ptr, abi_ulong guest_addr, 407 long len) 408 { 409 410 #ifdef DEBUG_REMAP 411 if (!host_ptr) { 412 return; 413 } 414 if (host_ptr == g2h_untagged(guest_addr)) { 415 return; 416 } 417 if (len > 0) { 418 memcpy(g2h_untagged(guest_addr), host_ptr, len); 419 } 420 g_free(host_ptr); 421 #endif 422 } 423 424 /* 425 * Return the length of a string in target memory or -TARGET_EFAULT if access 426 * error. 427 */ 428 abi_long target_strlen(abi_ulong gaddr); 429 430 /* Like lock_user but for null terminated strings. */ 431 static inline void *lock_user_string(abi_ulong guest_addr) 432 { 433 abi_long len; 434 len = target_strlen(guest_addr); 435 if (len < 0) { 436 return NULL; 437 } 438 return lock_user(VERIFY_READ, guest_addr, (long)(len + 1), 1); 439 } 440 441 /* Helper macros for locking/unlocking a target struct. */ 442 #define lock_user_struct(type, host_ptr, guest_addr, copy) \ 443 (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy)) 444 #define unlock_user_struct(host_ptr, guest_addr, copy) \ 445 unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0) 446 447 #include <pthread.h> 448 449 #endif /* QEMU_H */ 450