master
h 490 lines 17.5 KB
Raw
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 <sys/param.h>
21
22 #include "qemu/int128.h"
23 #include "cpu.h"
24 #include "qemu/units.h"
25 #include "accel/tcg/cpu-ldst.h"
26
27 #include "user/abitypes.h"
28 #include "user/cpu_loop.h"
29 #include "user/page-protection.h"
30 #include "user/guest-host.h"
31
32 extern char **environ;
33
34 #include "user/thunk.h"
35 #include "user/mmap.h"
36 #include "target_arch.h"
37 #include "syscall_defs.h"
38 #include "target_syscall.h"
39 #include "target_os_vmparam.h"
40 #include "target_os_signal.h"
41 #include "target.h"
42 #include "exec/gdbstub.h"
43 #include "exec/page-protection.h"
44 #include "accel/tcg/vcpu-state.h"
45
46 #include "qemu-os.h"
47 /*
48 * TODO: Remove these and rely only on qemu_real_host_page_size().
49 */
50 extern uintptr_t qemu_host_page_size;
51 extern intptr_t qemu_host_page_mask;
52 #define HOST_PAGE_ALIGN(addr) ROUND_UP((addr), qemu_host_page_size)
53
54 /*
55 * This struct is used to hold certain information about the image. Basically,
56 * it replicates in user space what would be certain task_struct fields in the
57 * kernel
58 */
59 struct image_info {
60 abi_ulong load_bias;
61 abi_ulong load_addr;
62 abi_ulong start_code;
63 abi_ulong end_code;
64 abi_ulong start_data;
65 abi_ulong end_data;
66 abi_ulong brk;
67 abi_ulong rss;
68 abi_ulong start_stack;
69 abi_ulong entry;
70 abi_ulong code_offset;
71 abi_ulong data_offset;
72 abi_ulong arg_start;
73 abi_ulong arg_end;
74 uint32_t elf_flags;
75 };
76
77 struct emulated_sigtable {
78 int pending; /* true if signal is pending */
79 target_siginfo_t info;
80 };
81
82 /*
83 * NOTE: we force a big alignment so that the stack stored after is aligned too
84 */
85 struct TaskState {
86 pid_t ts_tid; /* tid (or pid) of this task */
87
88 struct TaskState *next;
89 struct bsd_binprm *bprm;
90 struct image_info *info;
91
92 struct emulated_sigtable sync_signal;
93 /*
94 * TODO: Since we block all signals while returning to the main CPU
95 * loop, this needn't be an array
96 */
97 struct emulated_sigtable sigtab[TARGET_NSIG];
98 /*
99 * Nonzero if process_pending_signals() needs to do something (either
100 * handle a pending signal or unblock signals).
101 * This flag is written from a signal handler so should be accessed via
102 * the qatomic_read() and qatomic_set() functions. (It is not accessed
103 * from multiple threads.)
104 */
105 int signal_pending;
106 /* True if we're leaving a sigsuspend and sigsuspend_mask is valid. */
107 bool in_sigsuspend;
108 /*
109 * This thread's signal mask, as requested by the guest program.
110 * The actual signal mask of this thread may differ:
111 * + we don't let SIGSEGV and SIGBUS be blocked while running guest code
112 * + sometimes we block all signals to avoid races
113 */
114 sigset_t signal_mask;
115 /*
116 * The signal mask imposed by a guest sigsuspend syscall, if we are
117 * currently in the middle of such a syscall
118 */
119 sigset_t sigsuspend_mask;
120
121 /* This thread's sigaltstack, if it has one */
122 struct target_sigaltstack sigaltstack_used;
123 } __attribute__((aligned(16)));
124
125 void stop_all_tasks(void);
126 extern const char *interp_prefix;
127 extern const char *qemu_uname_release;
128
129 /*
130 * TARGET_ARG_MAX defines the number of bytes allocated for arguments
131 * and envelope for the new program. 256k should suffice for a reasonable
132 * maximum env+arg in 32-bit environments, bump it up to 512k for !ILP32
133 * platforms.
134 */
135 #if TARGET_ABI_BITS > 32
136 #define TARGET_ARG_MAX (512 * KiB)
137 #else
138 #define TARGET_ARG_MAX (256 * KiB)
139 #endif
140 #define MAX_ARG_PAGES (TARGET_ARG_MAX / TARGET_PAGE_SIZE)
141
142 /*
143 * This structure is used to hold the arguments that are
144 * used when loading binaries.
145 */
146 struct bsd_binprm {
147 char buf[128];
148 void *page[MAX_ARG_PAGES];
149 abi_ulong p;
150 abi_ulong stringp;
151 int fd;
152 int e_uid, e_gid;
153 int argc, envc;
154 char **argv;
155 char **envp;
156 char *filename; /* (Given) Name of binary */
157 char *fullpath; /* Full path of binary */
158 int (*core_dump)(int, CPUArchState *);
159 };
160
161 void do_init_thread(struct target_pt_regs *regs, struct image_info *infop);
162 abi_ulong loader_build_argptr(int envc, int argc, abi_ulong sp,
163 abi_ulong stringp);
164 int loader_exec(const char *filename, char **argv, char **envp,
165 struct target_pt_regs *regs, struct image_info *infop,
166 struct bsd_binprm *bprm);
167
168 int load_elf_binary(struct bsd_binprm *bprm, struct target_pt_regs *regs,
169 struct image_info *info);
170 int load_flt_binary(struct bsd_binprm *bprm, struct target_pt_regs *regs,
171 struct image_info *info);
172 int is_target_elf_binary(int fd);
173
174 abi_long memcpy_to_target(abi_ulong dest, const void *src,
175 unsigned long len);
176 void target_set_brk(abi_ulong new_brk);
177 abi_long do_brk(abi_ulong new_brk);
178 void syscall_init(void);
179 abi_long do_freebsd_syscall(void *cpu_env, int num, abi_long arg1,
180 abi_long arg2, abi_long arg3, abi_long arg4,
181 abi_long arg5, abi_long arg6, abi_long arg7,
182 abi_long arg8);
183 void gemu_log(const char *fmt, ...) G_GNUC_PRINTF(1, 2);
184 extern __thread CPUState *thread_cpu;
185 char *target_strerror(int err);
186 int get_osversion(void);
187 void fork_start(void);
188 void fork_end(pid_t pid);
189
190 #include "qemu/log.h"
191
192 /* strace.c */
193 struct syscallname {
194 int nr;
195 const char *name;
196 const char *format;
197 void (*call)(const struct syscallname *,
198 abi_long, abi_long, abi_long,
199 abi_long, abi_long, abi_long);
200 void (*result)(const struct syscallname *, abi_long);
201 };
202
203 void
204 print_freebsd_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_freebsd_syscall_ret(int num, abi_long ret);
208 /**
209 * print_taken_signal:
210 * @target_signum: target signal being taken
211 * @tinfo: target_siginfo_t which will be passed to the guest for the signal
212 *
213 * Print strace output indicating that this signal is being taken by the guest,
214 * in a format similar to:
215 * --- SIGSEGV {si_signo=SIGSEGV, si_code=SI_KERNEL, si_addr=0} ---
216 */
217 void print_taken_signal(int target_signum, const target_siginfo_t *tinfo);
218 extern int do_strace;
219
220 /* mmap.c */
221 int target_msync(abi_ulong start, abi_ulong len, int flags);
222 void mmap_reserve(abi_ulong start, abi_ulong size);
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 /* os-syscall.c */
234 abi_long get_errno(abi_long ret);
235 bool is_error(abi_long ret);
236 int host_to_target_errno(int err);
237
238 /* os-proc.c */
239 abi_long freebsd_exec_common(abi_ulong path_or_fd, abi_ulong guest_argp,
240 abi_ulong guest_envp, int do_fexec);
241 abi_long do_freebsd_procctl(void *cpu_env, int idtype, abi_ulong arg2,
242 abi_ulong arg3, abi_ulong arg4, abi_ulong arg5, abi_ulong arg6);
243
244 /* os-sys.c */
245 abi_long do_freebsd_sysctl(CPUArchState *env, abi_ulong namep, int32_t namelen,
246 abi_ulong oldp, abi_ulong oldlenp, abi_ulong newp, abi_ulong newlen);
247 abi_long do_freebsd_sysctlbyname(CPUArchState *env, abi_ulong namep,
248 int32_t namelen, abi_ulong oldp, abi_ulong oldlenp, abi_ulong newp,
249 abi_ulong newlen);
250 abi_long do_freebsd_sysarch(void *cpu_env, abi_long arg1, abi_long arg2);
251
252 /* user access */
253
254 #define VERIFY_READ PAGE_READ
255 #define VERIFY_WRITE (PAGE_READ | PAGE_WRITE)
256
257 static inline bool access_ok(int type, abi_ulong addr, abi_ulong size)
258 {
259 return page_check_range((target_ulong)addr, size, type);
260 }
261
262 /*
263 * NOTE __get_user and __put_user use host pointers and don't check access.
264 *
265 * These are usually used to access struct data members once the struct has been
266 * locked - usually with lock_user_struct().
267 */
268
269 /*
270 * Tricky points:
271 * - Use __builtin_choose_expr to avoid type promotion from ?:,
272 * - Invalid sizes result in a compile time error stemming from
273 * the fact that abort has no parameters.
274 * - It's easier to use the endian-specific unaligned load/store
275 * functions than host-endian unaligned load/store plus tswapN.
276 * - The pragmas are necessary only to silence a clang false-positive
277 * warning: see https://bugs.llvm.org/show_bug.cgi?id=39113 .
278 * - gcc has bugs in its _Pragma() support in some versions, eg
279 * https://gcc.gnu.org/bugzilla/show_bug.cgi?id=83256 -- so we only
280 * include the warning-suppression pragmas for clang
281 */
282 #if defined(__clang__) && __has_warning("-Waddress-of-packed-member")
283 #define PRAGMA_DISABLE_PACKED_WARNING \
284 _Pragma("GCC diagnostic push"); \
285 _Pragma("GCC diagnostic ignored \"-Waddress-of-packed-member\"")
286
287 #define PRAGMA_REENABLE_PACKED_WARNING \
288 _Pragma("GCC diagnostic pop")
289
290 #else
291 #define PRAGMA_DISABLE_PACKED_WARNING
292 #define PRAGMA_REENABLE_PACKED_WARNING
293 #endif
294
295 #define __put_user_e(x, hptr, e) \
296 do { \
297 PRAGMA_DISABLE_PACKED_WARNING; \
298 (__builtin_choose_expr(sizeof(*(hptr)) == 1, stb_p, \
299 __builtin_choose_expr(sizeof(*(hptr)) == 2, stw_##e##_p, \
300 __builtin_choose_expr(sizeof(*(hptr)) == 4, stl_##e##_p, \
301 __builtin_choose_expr(sizeof(*(hptr)) == 8, stq_##e##_p, abort)))) \
302 ((hptr), (x)), (void)0); \
303 PRAGMA_REENABLE_PACKED_WARNING; \
304 } while (0)
305
306 #define __get_user_e(x, hptr, e) \
307 do { \
308 PRAGMA_DISABLE_PACKED_WARNING; \
309 ((x) = (typeof(*hptr))( \
310 __builtin_choose_expr(sizeof(*(hptr)) == 1, ldub_p, \
311 __builtin_choose_expr(sizeof(*(hptr)) == 2, lduw_##e##_p, \
312 __builtin_choose_expr(sizeof(*(hptr)) == 4, ldl_##e##_p, \
313 __builtin_choose_expr(sizeof(*(hptr)) == 8, ldq_##e##_p, abort)))) \
314 (hptr)), (void)0); \
315 PRAGMA_REENABLE_PACKED_WARNING; \
316 } while (0)
317
318
319 #if TARGET_BIG_ENDIAN
320 # define __put_user(x, hptr) __put_user_e(x, hptr, be)
321 # define __get_user(x, hptr) __get_user_e(x, hptr, be)
322 #else
323 # define __put_user(x, hptr) __put_user_e(x, hptr, le)
324 # define __get_user(x, hptr) __get_user_e(x, hptr, le)
325 #endif
326
327 /*
328 * put_user()/get_user() take a guest address and check access
329 *
330 * These are usually used to access an atomic data type, such as an int, that
331 * has been passed by address. These internally perform locking and unlocking
332 * on the data type.
333 */
334 #define put_user(x, gaddr, target_type) \
335 ({ \
336 abi_ulong __gaddr = (gaddr); \
337 target_type *__hptr; \
338 abi_long __ret = 0; \
339 __hptr = lock_user(VERIFY_WRITE, __gaddr, sizeof(target_type), 0); \
340 if (__hptr) { \
341 __put_user((x), __hptr); \
342 unlock_user(__hptr, __gaddr, sizeof(target_type)); \
343 } else \
344 __ret = -TARGET_EFAULT; \
345 __ret; \
346 })
347
348 #define get_user(x, gaddr, target_type) \
349 ({ \
350 abi_ulong __gaddr = (gaddr); \
351 target_type *__hptr; \
352 abi_long __ret = 0; \
353 __hptr = lock_user(VERIFY_READ, __gaddr, sizeof(target_type), 1); \
354 if (__hptr) { \
355 __get_user((x), __hptr); \
356 unlock_user(__hptr, __gaddr, 0); \
357 } else { \
358 (x) = 0; \
359 __ret = -TARGET_EFAULT; \
360 } \
361 __ret; \
362 })
363
364 #define put_user_ual(x, gaddr) put_user((x), (gaddr), abi_ulong)
365 #define put_user_sal(x, gaddr) put_user((x), (gaddr), abi_long)
366 #define put_user_u64(x, gaddr) put_user((x), (gaddr), uint64_t)
367 #define put_user_s64(x, gaddr) put_user((x), (gaddr), int64_t)
368 #define put_user_u32(x, gaddr) put_user((x), (gaddr), uint32_t)
369 #define put_user_s32(x, gaddr) put_user((x), (gaddr), int32_t)
370 #define put_user_u16(x, gaddr) put_user((x), (gaddr), uint16_t)
371 #define put_user_s16(x, gaddr) put_user((x), (gaddr), int16_t)
372 #define put_user_u8(x, gaddr) put_user((x), (gaddr), uint8_t)
373 #define put_user_s8(x, gaddr) put_user((x), (gaddr), int8_t)
374
375 #define get_user_ual(x, gaddr) get_user((x), (gaddr), abi_ulong)
376 #define get_user_sal(x, gaddr) get_user((x), (gaddr), abi_long)
377 #define get_user_u64(x, gaddr) get_user((x), (gaddr), uint64_t)
378 #define get_user_s64(x, gaddr) get_user((x), (gaddr), int64_t)
379 #define get_user_u32(x, gaddr) get_user((x), (gaddr), uint32_t)
380 #define get_user_s32(x, gaddr) get_user((x), (gaddr), int32_t)
381 #define get_user_u16(x, gaddr) get_user((x), (gaddr), uint16_t)
382 #define get_user_s16(x, gaddr) get_user((x), (gaddr), int16_t)
383 #define get_user_u8(x, gaddr) get_user((x), (gaddr), uint8_t)
384 #define get_user_s8(x, gaddr) get_user((x), (gaddr), int8_t)
385
386 /*
387 * copy_from_user() and copy_to_user() are usually used to copy data
388 * buffers between the target and host. These internally perform
389 * locking/unlocking of the memory.
390 */
391 abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
392 abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
393
394 /*
395 * Functions for accessing guest memory. The tget and tput functions
396 * read/write single values, byteswapping as necessary. The lock_user function
397 * gets a pointer to a contiguous area of guest memory, but does not perform
398 * any byteswapping. lock_user may return either a pointer to the guest
399 * memory, or a temporary buffer.
400 */
401
402 /*
403 * Lock an area of guest memory into the host. If copy is true then the
404 * host area will have the same contents as the guest.
405 */
406 static inline void *lock_user(int type, abi_ulong guest_addr, long len,
407 int copy)
408 {
409 if (!access_ok(type, guest_addr, len)) {
410 return NULL;
411 }
412 #ifdef CONFIG_DEBUG_REMAP
413 {
414 void *addr;
415 addr = g_malloc(len);
416 if (copy) {
417 memcpy(addr, g2h_untagged(guest_addr), len);
418 } else {
419 memset(addr, 0, len);
420 }
421 return addr;
422 }
423 #else
424 return g2h_untagged(guest_addr);
425 #endif
426 }
427
428 /*
429 * Unlock an area of guest memory. The first LEN bytes must be flushed back to
430 * guest memory. host_ptr = NULL is explicitly allowed and does nothing.
431 */
432 static inline void unlock_user(void *host_ptr, abi_ulong guest_addr,
433 long len)
434 {
435
436 #ifdef CONFIG_DEBUG_REMAP
437 if (!host_ptr) {
438 return;
439 }
440 if (host_ptr == g2h_untagged(guest_addr)) {
441 return;
442 }
443 if (len > 0) {
444 memcpy(g2h_untagged(guest_addr), host_ptr, len);
445 }
446 g_free(host_ptr);
447 #endif
448 }
449
450 /*
451 * Return the length of a string in target memory or -TARGET_EFAULT if access
452 * error.
453 */
454 abi_long target_strlen(abi_ulong gaddr);
455
456 /* Like lock_user but for null terminated strings. */
457 static inline void *lock_user_string(abi_ulong guest_addr)
458 {
459 abi_long len;
460 len = target_strlen(guest_addr);
461 if (len < 0) {
462 return NULL;
463 }
464 return lock_user(VERIFY_READ, guest_addr, (long)(len + 1), 1);
465 }
466
467 /* Helper macros for locking/unlocking a target struct. */
468 #define lock_user_struct(type, host_ptr, guest_addr, copy) \
469 (host_ptr = lock_user(type, guest_addr, sizeof(*host_ptr), copy))
470 #define unlock_user_struct(host_ptr, guest_addr, copy) \
471 unlock_user(host_ptr, guest_addr, (copy) ? sizeof(*host_ptr) : 0)
472
473 static inline uint64_t target_arg64(uint32_t word0, uint32_t word1)
474 {
475 #if TARGET_ABI_BITS == 32
476 #if TARGET_BIG_ENDIAN
477 return ((uint64_t)word0 << 32) | word1;
478 #else
479 return ((uint64_t)word1 << 32) | word0;
480 #endif
481 #else /* TARGET_ABI_BITS != 32 */
482 return word0;
483 #endif /* TARGET_ABI_BITS != 32 */
484 }
485
486 #include <pthread.h>
487
488 #include "user/safe-syscall.h"
489
490 #endif /* QEMU_H */