1 #ifndef QEMU_H 2 #define QEMU_H 3 4 #include "cpu.h" 5 #include "exec/cpu_ldst.h" 6 7 #include "user/abitypes.h" 8 9 #include "syscall_defs.h" 10 #include "target_syscall.h" 11 #include "accel/tcg/vcpu-state.h" 12 13 /* 14 * This is the size of the host kernel's sigset_t, needed where we make 15 * direct system calls that take a sigset_t pointer and a size. 16 */ 17 #define SIGSET_T_SIZE (_NSIG / 8) 18 19 /* 20 * This struct is used to hold certain information about the image. 21 * Basically, it replicates in user space what would be certain 22 * task_struct fields in the kernel 23 */ 24 struct image_info { 25 abi_ulong load_bias; 26 abi_ulong load_addr; 27 abi_ulong start_code; 28 abi_ulong end_code; 29 abi_ulong start_data; 30 abi_ulong end_data; 31 abi_ulong brk; 32 abi_ulong start_stack; 33 abi_ulong stack_limit; 34 abi_ulong vdso; 35 abi_ulong entry; 36 abi_ulong code_offset; 37 abi_ulong data_offset; 38 abi_ulong saved_auxv; 39 abi_ulong auxv_len; 40 abi_ulong argc; 41 abi_ulong argv; 42 abi_ulong envc; 43 abi_ulong envp; 44 abi_ulong file_string; 45 uint32_t elf_flags; 46 int personality; 47 abi_ulong alignment; 48 bool exec_stack; 49 50 /* Generic semihosting knows about these pointers. */ 51 abi_ulong arg_strings; /* strings for argv */ 52 abi_ulong env_strings; /* strings for envp; ends arg_strings */ 53 54 /* The fields below are used in FDPIC mode. */ 55 abi_ulong loadmap_addr; 56 uint16_t nsegs; 57 void *loadsegs; 58 abi_ulong pt_dynamic_addr; 59 abi_ulong interpreter_loadmap_addr; 60 abi_ulong interpreter_pt_dynamic_addr; 61 struct image_info *other_info; 62 63 /* For target-specific processing of NT_GNU_PROPERTY_TYPE_0. */ 64 uint32_t note_flags; 65 66 #ifdef TARGET_MIPS 67 int fp_abi; 68 int interp_fp_abi; 69 #endif 70 }; 71 72 #ifdef TARGET_I386 73 /* Information about the current linux thread */ 74 struct vm86_saved_state { 75 uint32_t eax; /* return code */ 76 uint32_t ebx; 77 uint32_t ecx; 78 uint32_t edx; 79 uint32_t esi; 80 uint32_t edi; 81 uint32_t ebp; 82 uint32_t esp; 83 uint32_t eflags; 84 uint32_t eip; 85 uint16_t cs, ss, ds, es, fs, gs; 86 }; 87 #endif 88 89 #if defined(TARGET_ARM) && defined(TARGET_ABI32) 90 /* FPU emulator */ 91 #include "nwfpe/fpa11.h" 92 #endif 93 94 struct emulated_sigtable { 95 int pending; /* true if signal is pending */ 96 target_siginfo_t info; 97 }; 98 99 struct TaskState { 100 pid_t ts_tid; /* tid (or pid) of this task */ 101 #ifdef TARGET_ARM 102 # ifdef TARGET_ABI32 103 /* FPA state */ 104 FPA11 fpa; 105 # endif 106 #endif 107 #if defined(TARGET_ARM) || defined(TARGET_RISCV) 108 int swi_errno; 109 #endif 110 #if defined(TARGET_I386) && !defined(TARGET_X86_64) 111 abi_ulong target_v86; 112 struct vm86_saved_state vm86_saved_regs; 113 struct target_vm86plus_struct vm86plus; 114 uint32_t v86flags; 115 uint32_t v86mask; 116 #endif 117 #if defined(TARGET_I386) 118 /* Last syscall number. */ 119 target_ulong orig_ax; 120 #endif 121 abi_ulong child_tidptr; 122 #ifdef TARGET_M68K 123 abi_ulong tp_value; 124 #endif 125 #if defined(TARGET_ARM) || defined(TARGET_M68K) || defined(TARGET_RISCV) 126 /* Extra fields for semihosted binaries. */ 127 abi_ulong heap_base; 128 abi_ulong heap_limit; 129 #endif 130 abi_ulong stack_base; 131 int used; /* non zero if used */ 132 struct image_info *info; 133 struct linux_binprm *bprm; 134 135 struct emulated_sigtable sync_signal; 136 struct emulated_sigtable sigtab[TARGET_NSIG]; 137 /* 138 * This thread's signal mask, as requested by the guest program. 139 * The actual signal mask of this thread may differ: 140 * + we don't let SIGSEGV and SIGBUS be blocked while running guest code 141 * + sometimes we block all signals to avoid races 142 */ 143 sigset_t signal_mask; 144 /* 145 * The signal mask imposed by a guest sigsuspend syscall, if we are 146 * currently in the middle of such a syscall 147 */ 148 sigset_t sigsuspend_mask; 149 /* Nonzero if we're leaving a sigsuspend and sigsuspend_mask is valid. */ 150 int in_sigsuspend; 151 152 /* 153 * Nonzero if process_pending_signals() needs to do something (either 154 * handle a pending signal or unblock signals). 155 * This flag is written from a signal handler so should be accessed via 156 * the qatomic_read() and qatomic_set() functions. (It is not accessed 157 * from multiple threads.) 158 */ 159 int signal_pending; 160 161 /* This thread's sigaltstack, if it has one */ 162 struct target_sigaltstack sigaltstack_used; 163 164 /* Start time of task after system boot in clock ticks */ 165 uint64_t start_boottime; 166 }; 167 168 abi_long do_brk(abi_ulong new_brk); 169 int do_guest_openat(CPUArchState *cpu_env, int dirfd, const char *pathname, 170 int flags, mode_t mode, bool safe); 171 ssize_t do_guest_readlink(const char *pathname, char *buf, size_t bufsiz); 172 173 /* user access */ 174 175 #define VERIFY_NONE 0 176 #define VERIFY_READ PAGE_READ 177 #define VERIFY_WRITE (PAGE_READ | PAGE_WRITE) 178 179 static inline bool access_ok_untagged(int type, abi_ulong addr, abi_ulong size) 180 { 181 if (size == 0 182 ? !guest_addr_valid_untagged(addr) 183 : !guest_range_valid_untagged(addr, size)) { 184 return false; 185 } 186 return page_check_range((target_ulong)addr, size, type); 187 } 188 189 static inline bool access_ok(CPUState *cpu, int type, 190 abi_ulong addr, abi_ulong size) 191 { 192 return access_ok_untagged(type, cpu_untagged_addr(cpu, addr), size); 193 } 194 195 /* NOTE __get_user and __put_user use host pointers and don't check access. 196 These are usually used to access struct data members once the struct has 197 been locked - usually with lock_user_struct. */ 198 199 /* 200 * Tricky points: 201 * - Use __builtin_choose_expr to avoid type promotion from ?:, 202 * - Invalid sizes result in a compile time error stemming from 203 * the fact that abort has no parameters. 204 * - It's easier to use the endian-specific unaligned load/store 205 * functions than host-endian unaligned load/store plus tswapN. 206 * - The pragmas are necessary only to silence a clang false-positive 207 * warning: see https://bugs.llvm.org/show_bug.cgi?id=39113 . 208 * - gcc has bugs in its _Pragma() support in some versions, eg 209 * https://gcc.gnu.org/bugzilla/show_bug.cgi?id=83256 -- so we only 210 * include the warning-suppression pragmas for clang 211 */ 212 #if defined(__clang__) && __has_warning("-Waddress-of-packed-member") 213 #define PRAGMA_DISABLE_PACKED_WARNING \ 214 _Pragma("GCC diagnostic push"); \ 215 _Pragma("GCC diagnostic ignored \"-Waddress-of-packed-member\"") 216 217 #define PRAGMA_REENABLE_PACKED_WARNING \ 218 _Pragma("GCC diagnostic pop") 219 220 #else 221 #define PRAGMA_DISABLE_PACKED_WARNING 222 #define PRAGMA_REENABLE_PACKED_WARNING 223 #endif 224 225 #define __put_user_e(x, hptr, e) \ 226 do { \ 227 PRAGMA_DISABLE_PACKED_WARNING; \ 228 (__builtin_choose_expr(sizeof(*(hptr)) == 1, stb_p, \ 229 __builtin_choose_expr(sizeof(*(hptr)) == 2, stw_##e##_p, \ 230 __builtin_choose_expr(sizeof(*(hptr)) == 4, stl_##e##_p, \ 231 __builtin_choose_expr(sizeof(*(hptr)) == 8, stq_##e##_p, abort)))) \ 232 ((hptr), (x)), (void)0); \ 233 PRAGMA_REENABLE_PACKED_WARNING; \ 234 } while (0) 235 236 #define __get_user_e(x, hptr, e) \ 237 do { \ 238 PRAGMA_DISABLE_PACKED_WARNING; \ 239 ((x) = (typeof(*hptr))( \ 240 __builtin_choose_expr(sizeof(*(hptr)) == 1, ldub_p, \ 241 __builtin_choose_expr(sizeof(*(hptr)) == 2, lduw_##e##_p, \ 242 __builtin_choose_expr(sizeof(*(hptr)) == 4, ldl_##e##_p, \ 243 __builtin_choose_expr(sizeof(*(hptr)) == 8, ldq_##e##_p, abort)))) \ 244 (hptr)), (void)0); \ 245 PRAGMA_REENABLE_PACKED_WARNING; \ 246 } while (0) 247 248 249 #if TARGET_BIG_ENDIAN 250 # define __put_user(x, hptr) __put_user_e(x, hptr, be) 251 # define __get_user(x, hptr) __get_user_e(x, hptr, be) 252 #else 253 # define __put_user(x, hptr) __put_user_e(x, hptr, le) 254 # define __get_user(x, hptr) __get_user_e(x, hptr, le) 255 #endif 256 257 /* put_user()/get_user() take a guest address and check access */ 258 /* These are usually used to access an atomic data type, such as an int, 259 * that has been passed by address. These internally perform locking 260 * and unlocking on the data type. 261 */ 262 #define put_user(x, gaddr, target_type) \ 263 ({ \ 264 abi_ulong __gaddr = (gaddr); \ 265 target_type *__hptr; \ 266 abi_long __ret = 0; \ 267 if ((__hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0))) { \ 268 __put_user((x), __hptr); \ 269 unlock_user(__hptr, __gaddr, sizeof(target_type)); \ 270 } else \ 271 __ret = -TARGET_EFAULT; \ 272 __ret; \ 273 }) 274 275 #define get_user(x, gaddr, target_type) \ 276 ({ \ 277 abi_ulong __gaddr = (gaddr); \ 278 target_type *__hptr; \ 279 abi_long __ret = 0; \ 280 if ((__hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1))) { \ 281 __get_user((x), __hptr); \ 282 unlock_user(__hptr, __gaddr, 0); \ 283 } else { \ 284 /* avoid warning */ \ 285 (x) = 0; \ 286 __ret = -TARGET_EFAULT; \ 287 } \ 288 __ret; \ 289 }) 290 291 #define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong) 292 #define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long) 293 #define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t) 294 #define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t) 295 #define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t) 296 #define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t) 297 #define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t) 298 #define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t) 299 #define put_user_u8(x, gaddr) put_user((x), (gaddr), uint8_t) 300 #define put_user_s8(x, gaddr) put_user((x), (gaddr), int8_t) 301 302 #define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong) 303 #define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long) 304 #define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t) 305 #define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t) 306 #define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t) 307 #define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t) 308 #define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t) 309 #define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t) 310 #define get_user_u8(x, gaddr) get_user((x), (gaddr), uint8_t) 311 #define get_user_s8(x, gaddr) get_user((x), (gaddr), int8_t) 312 313 /* copy_from_user() and copy_to_user() are usually used to copy data 314 * buffers between the target and host. These internally perform 315 * locking/unlocking of the memory. 316 */ 317 int copy_from_user(void *hptr, abi_ulong gaddr, ssize_t len); 318 int copy_to_user(abi_ulong gaddr, void *hptr, ssize_t len); 319 320 /* 321 * copy_struct_from_user() copies a target struct to a host struct, in 322 * a way that guarantees backwards-compatibility for struct syscall 323 * arguments. 324 * 325 * Similar to kernels uaccess.h:copy_struct_from_user() 326 */ 327 int copy_struct_from_user(void *dst, size_t ksize, abi_ptr src, size_t usize); 328 329 /* Functions for accessing guest memory. The tget and tput functions 330 read/write single values, byteswapping as necessary. The lock_user function 331 gets a pointer to a contiguous area of guest memory, but does not perform 332 any byteswapping. lock_user may return either a pointer to the guest 333 memory, or a temporary buffer. */ 334 335 /* Lock an area of guest memory into the host. If copy is true then the 336 host area will have the same contents as the guest. */ 337 void *lock_user(int type, abi_ulong guest_addr, ssize_t len, bool copy); 338 339 /* Unlock an area of guest memory. The first LEN bytes must be 340 flushed back to guest memory. host_ptr = NULL is explicitly 341 allowed and does nothing. */ 342 #ifndef CONFIG_DEBUG_REMAP 343 static inline void unlock_user(void *host_ptr, abi_ulong guest_addr, 344 ssize_t len) 345 { 346 /* no-op */ 347 } 348 #else 349 void unlock_user(void *host_ptr, abi_ulong guest_addr, ssize_t len); 350 #endif 351 352 /* Return the length of a string in target memory or -TARGET_EFAULT if 353 access error. */ 354 ssize_t target_strlen(abi_ulong gaddr); 355 356 /* Like lock_user but for null terminated strings. */ 357 void *lock_user_string(abi_ulong guest_addr); 358 359 /* Helper macros for locking/unlocking a target struct. */ 360 #define lock_user_struct(type, host_ptr, guest_addr, copy) \ 361 (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy)) 362 #define unlock_user_struct(host_ptr, guest_addr, copy) \ 363 unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0) 364 365 #endif /* QEMU_H */ 366