2 * qemu bsd user mode definition
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.
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.
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/>.
21 #include "qemu/units.h"
22 #include "exec/cpu_ldst.h"
23 #include "exec/exec-all.h"
27 #include "exec/user/abitypes.h"
29 extern char **environ
;
31 #include "exec/user/thunk.h"
32 #include "target_arch.h"
33 #include "syscall_defs.h"
34 #include "target_syscall.h"
35 #include "target_os_vmparam.h"
36 #include "target_os_signal.h"
38 #include "exec/gdbstub.h"
39 #include "qemu/clang-tsa.h"
43 * This struct is used to hold certain information about the image. Basically,
44 * it replicates in user space what would be certain task_struct fields in the
56 abi_ulong start_stack
;
58 abi_ulong code_offset
;
59 abi_ulong data_offset
;
65 struct emulated_sigtable
{
66 int pending
; /* true if signal is pending */
67 target_siginfo_t info
;
71 * NOTE: we force a big alignment so that the stack stored after is aligned too
73 typedef struct TaskState
{
74 pid_t ts_tid
; /* tid (or pid) of this task */
76 struct TaskState
*next
;
77 struct bsd_binprm
*bprm
;
78 struct image_info
*info
;
80 struct emulated_sigtable sync_signal
;
82 * TODO: Since we block all signals while returning to the main CPU
83 * loop, this needn't be an array
85 struct emulated_sigtable sigtab
[TARGET_NSIG
];
87 * Nonzero if process_pending_signals() needs to do something (either
88 * handle a pending signal or unblock signals).
89 * This flag is written from a signal handler so should be accessed via
90 * the qatomic_read() and qatomic_set() functions. (It is not accessed
91 * from multiple threads.)
94 /* True if we're leaving a sigsuspend and sigsuspend_mask is valid. */
97 * This thread's signal mask, as requested by the guest program.
98 * The actual signal mask of this thread may differ:
99 * + we don't let SIGSEGV and SIGBUS be blocked while running guest code
100 * + sometimes we block all signals to avoid races
102 sigset_t signal_mask
;
104 * The signal mask imposed by a guest sigsuspend syscall, if we are
105 * currently in the middle of such a syscall
107 sigset_t sigsuspend_mask
;
109 /* This thread's sigaltstack, if it has one */
110 struct target_sigaltstack sigaltstack_used
;
111 } __attribute__((aligned(16))) TaskState
;
113 void stop_all_tasks(void);
114 extern const char *qemu_uname_release
;
117 * TARGET_ARG_MAX defines the number of bytes allocated for arguments
118 * and envelope for the new program. 256k should suffice for a reasonable
119 * maximum env+arg in 32-bit environments, bump it up to 512k for !ILP32
122 #if TARGET_ABI_BITS > 32
123 #define TARGET_ARG_MAX (512 * KiB)
125 #define TARGET_ARG_MAX (256 * KiB)
127 #define MAX_ARG_PAGES (TARGET_ARG_MAX / TARGET_PAGE_SIZE)
130 * This structure is used to hold the arguments that are
131 * used when loading binaries.
135 void *page
[MAX_ARG_PAGES
];
143 char *filename
; /* (Given) Name of binary */
144 char *fullpath
; /* Full path of binary */
145 int (*core_dump
)(int, CPUArchState
*);
148 void do_init_thread(struct target_pt_regs
*regs
, struct image_info
*infop
);
149 abi_ulong
loader_build_argptr(int envc
, int argc
, abi_ulong sp
,
151 int loader_exec(const char *filename
, char **argv
, char **envp
,
152 struct target_pt_regs
*regs
, struct image_info
*infop
,
153 struct bsd_binprm
*bprm
);
155 int load_elf_binary(struct bsd_binprm
*bprm
, struct target_pt_regs
*regs
,
156 struct image_info
*info
);
157 int load_flt_binary(struct bsd_binprm
*bprm
, struct target_pt_regs
*regs
,
158 struct image_info
*info
);
159 int is_target_elf_binary(int fd
);
161 abi_long
memcpy_to_target(abi_ulong dest
, const void *src
,
163 void target_set_brk(abi_ulong new_brk
);
164 abi_long
do_brk(abi_ulong new_brk
);
165 void syscall_init(void);
166 abi_long
do_freebsd_syscall(void *cpu_env
, int num
, abi_long arg1
,
167 abi_long arg2
, abi_long arg3
, abi_long arg4
,
168 abi_long arg5
, abi_long arg6
, abi_long arg7
,
170 abi_long
do_netbsd_syscall(void *cpu_env
, int num
, abi_long arg1
,
171 abi_long arg2
, abi_long arg3
, abi_long arg4
,
172 abi_long arg5
, abi_long arg6
);
173 abi_long
do_openbsd_syscall(void *cpu_env
, int num
, abi_long arg1
,
174 abi_long arg2
, abi_long arg3
, abi_long arg4
,
175 abi_long arg5
, abi_long arg6
);
176 void gemu_log(const char *fmt
, ...) G_GNUC_PRINTF(1, 2);
177 extern __thread CPUState
*thread_cpu
;
178 void cpu_loop(CPUArchState
*env
);
179 char *target_strerror(int err
);
180 int get_osversion(void);
181 void fork_start(void);
182 void fork_end(int child
);
184 #include "qemu/log.h"
191 void (*call
)(const struct syscallname
*,
192 abi_long
, abi_long
, abi_long
,
193 abi_long
, abi_long
, abi_long
);
194 void (*result
)(const struct syscallname
*, abi_long
);
198 print_freebsd_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_freebsd_syscall_ret(int num
, abi_long ret
);
203 print_netbsd_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_netbsd_syscall_ret(int num
, abi_long ret
);
208 print_openbsd_syscall(int num
,
209 abi_long arg1
, abi_long arg2
, abi_long arg3
,
210 abi_long arg4
, abi_long arg5
, abi_long arg6
);
211 void print_openbsd_syscall_ret(int num
, abi_long ret
);
213 * print_taken_signal:
214 * @target_signum: target signal being taken
215 * @tinfo: target_siginfo_t which will be passed to the guest for the signal
217 * Print strace output indicating that this signal is being taken by the guest,
218 * in a format similar to:
219 * --- SIGSEGV {si_signo=SIGSEGV, si_code=SI_KERNEL, si_addr=0} ---
221 void print_taken_signal(int target_signum
, const target_siginfo_t
*tinfo
);
222 extern int do_strace
;
225 int target_mprotect(abi_ulong start
, abi_ulong len
, int prot
);
226 abi_long
target_mmap(abi_ulong start
, abi_ulong len
, int prot
,
227 int flags
, int fd
, off_t offset
);
228 int target_munmap(abi_ulong start
, abi_ulong len
);
229 abi_long
target_mremap(abi_ulong old_addr
, abi_ulong old_size
,
230 abi_ulong new_size
, unsigned long flags
,
232 int target_msync(abi_ulong start
, abi_ulong len
, int flags
);
233 extern abi_ulong mmap_next_start
;
234 abi_ulong
mmap_find_vma(abi_ulong start
, abi_ulong size
);
235 void TSA_NO_TSA
mmap_fork_start(void);
236 void TSA_NO_TSA
mmap_fork_end(int child
);
239 extern char qemu_proc_pathname
[];
240 extern unsigned long target_maxtsiz
;
241 extern unsigned long target_dfldsiz
;
242 extern unsigned long target_maxdsiz
;
243 extern unsigned long target_dflssiz
;
244 extern unsigned long target_maxssiz
;
245 extern unsigned long target_sgrowsiz
;
248 abi_long
get_errno(abi_long ret
);
249 bool is_error(abi_long ret
);
250 int host_to_target_errno(int err
);
253 abi_long
freebsd_exec_common(abi_ulong path_or_fd
, abi_ulong guest_argp
,
254 abi_ulong guest_envp
, int do_fexec
);
255 abi_long
do_freebsd_procctl(void *cpu_env
, int idtype
, abi_ulong arg2
,
256 abi_ulong arg3
, abi_ulong arg4
, abi_ulong arg5
, abi_ulong arg6
);
259 abi_long
do_freebsd_sysctl(CPUArchState
*env
, abi_ulong namep
, int32_t namelen
,
260 abi_ulong oldp
, abi_ulong oldlenp
, abi_ulong newp
, abi_ulong newlen
);
261 abi_long
do_freebsd_sysctlbyname(CPUArchState
*env
, abi_ulong namep
,
262 int32_t namelen
, abi_ulong oldp
, abi_ulong oldlenp
, abi_ulong newp
,
264 abi_long
do_freebsd_sysarch(void *cpu_env
, abi_long arg1
, abi_long arg2
);
268 #define VERIFY_READ PAGE_READ
269 #define VERIFY_WRITE (PAGE_READ | PAGE_WRITE)
271 static inline bool access_ok(int type
, abi_ulong addr
, abi_ulong size
)
273 return page_check_range((target_ulong
)addr
, size
, type
);
277 * NOTE __get_user and __put_user use host pointers and don't check access.
279 * These are usually used to access struct data members once the struct has been
280 * locked - usually with lock_user_struct().
285 * - Use __builtin_choose_expr to avoid type promotion from ?:,
286 * - Invalid sizes result in a compile time error stemming from
287 * the fact that abort has no parameters.
288 * - It's easier to use the endian-specific unaligned load/store
289 * functions than host-endian unaligned load/store plus tswapN.
290 * - The pragmas are necessary only to silence a clang false-positive
291 * warning: see https://bugs.llvm.org/show_bug.cgi?id=39113 .
292 * - gcc has bugs in its _Pragma() support in some versions, eg
293 * https://gcc.gnu.org/bugzilla/show_bug.cgi?id=83256 -- so we only
294 * include the warning-suppression pragmas for clang
296 #if defined(__clang__) && __has_warning("-Waddress-of-packed-member")
297 #define PRAGMA_DISABLE_PACKED_WARNING \
298 _Pragma("GCC diagnostic push"); \
299 _Pragma("GCC diagnostic ignored \"-Waddress-of-packed-member\"")
301 #define PRAGMA_REENABLE_PACKED_WARNING \
302 _Pragma("GCC diagnostic pop")
305 #define PRAGMA_DISABLE_PACKED_WARNING
306 #define PRAGMA_REENABLE_PACKED_WARNING
309 #define __put_user_e(x, hptr, e) \
311 PRAGMA_DISABLE_PACKED_WARNING; \
312 (__builtin_choose_expr(sizeof(*(hptr)) == 1, stb_p, \
313 __builtin_choose_expr(sizeof(*(hptr)) == 2, stw_##e##_p, \
314 __builtin_choose_expr(sizeof(*(hptr)) == 4, stl_##e##_p, \
315 __builtin_choose_expr(sizeof(*(hptr)) == 8, stq_##e##_p, abort)))) \
316 ((hptr), (x)), (void)0); \
317 PRAGMA_REENABLE_PACKED_WARNING; \
320 #define __get_user_e(x, hptr, e) \
322 PRAGMA_DISABLE_PACKED_WARNING; \
323 ((x) = (typeof(*hptr))( \
324 __builtin_choose_expr(sizeof(*(hptr)) == 1, ldub_p, \
325 __builtin_choose_expr(sizeof(*(hptr)) == 2, lduw_##e##_p, \
326 __builtin_choose_expr(sizeof(*(hptr)) == 4, ldl_##e##_p, \
327 __builtin_choose_expr(sizeof(*(hptr)) == 8, ldq_##e##_p, abort)))) \
329 PRAGMA_REENABLE_PACKED_WARNING; \
333 #if TARGET_BIG_ENDIAN
334 # define __put_user(x, hptr) __put_user_e(x, hptr, be)
335 # define __get_user(x, hptr) __get_user_e(x, hptr, be)
337 # define __put_user(x, hptr) __put_user_e(x, hptr, le)
338 # define __get_user(x, hptr) __get_user_e(x, hptr, le)
342 * put_user()/get_user() take a guest address and check access
344 * These are usually used to access an atomic data type, such as an int, that
345 * has been passed by address. These internally perform locking and unlocking
348 #define put_user(x, gaddr, target_type) \
350 abi_ulong __gaddr = (gaddr); \
351 target_type *__hptr; \
352 abi_long __ret = 0; \
353 __hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0); \
355 __put_user((x), __hptr); \
356 unlock_user(__hptr, __gaddr, sizeof(target_type)); \
358 __ret = -TARGET_EFAULT; \
362 #define get_user(x, gaddr, target_type) \
364 abi_ulong __gaddr = (gaddr); \
365 target_type *__hptr; \
366 abi_long __ret = 0; \
367 __hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1); \
369 __get_user((x), __hptr); \
370 unlock_user(__hptr, __gaddr, 0); \
373 __ret = -TARGET_EFAULT; \
378 #define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong)
379 #define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long)
380 #define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t)
381 #define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t)
382 #define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t)
383 #define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t)
384 #define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t)
385 #define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t)
386 #define put_user_u8(x, gaddr) put_user((x), (gaddr), uint8_t)
387 #define put_user_s8(x, gaddr) put_user((x), (gaddr), int8_t)
389 #define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong)
390 #define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long)
391 #define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t)
392 #define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t)
393 #define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t)
394 #define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t)
395 #define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t)
396 #define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t)
397 #define get_user_u8(x, gaddr) get_user((x), (gaddr), uint8_t)
398 #define get_user_s8(x, gaddr) get_user((x), (gaddr), int8_t)
401 * copy_from_user() and copy_to_user() are usually used to copy data
402 * buffers between the target and host. These internally perform
403 * locking/unlocking of the memory.
405 abi_long
copy_from_user(void *hptr
, abi_ulong gaddr
, size_t len
);
406 abi_long
copy_to_user(abi_ulong gaddr
, void *hptr
, size_t len
);
409 * Functions for accessing guest memory. The tget and tput functions
410 * read/write single values, byteswapping as necessary. The lock_user function
411 * gets a pointer to a contiguous area of guest memory, but does not perform
412 * any byteswapping. lock_user may return either a pointer to the guest
413 * memory, or a temporary buffer.
417 * Lock an area of guest memory into the host. If copy is true then the
418 * host area will have the same contents as the guest.
420 static inline void *lock_user(int type
, abi_ulong guest_addr
, long len
,
423 if (!access_ok(type
, guest_addr
, len
)) {
429 addr
= g_malloc(len
);
431 memcpy(addr
, g2h_untagged(guest_addr
), len
);
433 memset(addr
, 0, len
);
438 return g2h_untagged(guest_addr
);
443 * Unlock an area of guest memory. The first LEN bytes must be flushed back to
444 * guest memory. host_ptr = NULL is explicitly allowed and does nothing.
446 static inline void unlock_user(void *host_ptr
, abi_ulong guest_addr
,
454 if (host_ptr
== g2h_untagged(guest_addr
)) {
458 memcpy(g2h_untagged(guest_addr
), host_ptr
, len
);
465 * Return the length of a string in target memory or -TARGET_EFAULT if access
468 abi_long
target_strlen(abi_ulong gaddr
);
470 /* Like lock_user but for null terminated strings. */
471 static inline void *lock_user_string(abi_ulong guest_addr
)
474 len
= target_strlen(guest_addr
);
478 return lock_user(VERIFY_READ
, guest_addr
, (long)(len
+ 1), 1);
481 /* Helper macros for locking/unlocking a target struct. */
482 #define lock_user_struct(type, host_ptr, guest_addr, copy) \
483 (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
484 #define unlock_user_struct(host_ptr, guest_addr, copy) \
485 unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
487 static inline uint64_t target_arg64(uint32_t word0
, uint32_t word1
)
489 #if TARGET_ABI_BITS == 32
490 #if TARGET_BIG_ENDIAN
491 return ((uint64_t)word0
<< 32) | word1
;
493 return ((uint64_t)word1
<< 32) | word0
;
495 #else /* TARGET_ABI_BITS != 32 */
497 #endif /* TARGET_ABI_BITS != 32 */
502 #include "user/safe-syscall.h"